1 /**************************************************************************
2 * This file is property of and copyright by the ALICE HLT Project *
3 * All rights reserved. *
6 * Artur Szostak <artursz@iafrica.com> *
8 * Permission to use, copy, modify and distribute this software and its *
9 * documentation strictly for non-commercial purposes is hereby granted *
10 * without fee, provided that the above copyright notice appears in all *
11 * copies and that both the copyright notice and this permission notice *
12 * appear in the supporting documentation. The authors make no claims *
13 * about the suitability of this software for any purpose. It is *
14 * provided "as is" without express or implied warranty. *
15 **************************************************************************/
20 /// \file AliMUONRawStreamTrackerHP.cxx
21 /// \author Artur Szostak <artursz@iafrica.com>
23 /// \brief Implementation of the the high performance decoder AliMUONRawStreamTrackerHP.
26 //-----------------------------------------------------------------------------
28 /// \class AliMUONRawStreamTrackerHP
29 /// \brief A high performance stream decoder for muon tracking DDL streams.
31 /// This is the raw stream class which interfaces between the high performance
32 /// core decoder and the AliRawReader class.
33 /// To gain the most out of the decoder, the Next() method which returns batches
34 /// of decoded digit / channel information should be used. That is:
36 /// const AliBusPatch* Next();
39 /// This decoder tries to implement as similar an interface as possible to
40 /// AliMUONRawStreamTracker where possible. However certain constructs which
41 /// would slow us down too much are avoided.
43 /// \author Artur Szostak <artursz@iafrica.com>
44 //-----------------------------------------------------------------------------
46 #include "AliMUONRawStreamTrackerHP.h"
47 #include "AliMUONTrackerDDLDecoder.h"
48 #include "AliMUONDspHeader.h"
49 #include "AliMUONBlockHeader.h"
50 #include "AliMUONBusStruct.h"
51 #include "AliMUONDDLTracker.h"
52 #include "AliRawReader.h"
62 ClassImp(AliMUONRawStreamTrackerHP)
65 const Int_t AliMUONRawStreamTrackerHP::fgkMaxDDL = 20;
67 AliMUONRawStreamTrackerHP::AliMUONRawStreamTrackerHP() :
69 fEnableErrorLogger(kFALSE),
73 fBuffer(new UChar_t[8192]),
74 fkCurrentBusPatch(NULL),
80 fTotalNumberOfGlitchErrors(0),
81 fTotalNumberOfParityErrors(0),
82 fTotalNumberOfPaddingErrors(0)
85 /// Default constructor.
88 // Must set this flag to get all information about parity errors though
89 // the OnData method. OnError gets them either way.
90 fDecoder.ExitOnError(false);
91 fDecoder.SendDataOnParityError(true);
93 fDecoder.GetHandler().SetMaxStructs(
96 fDecoder.MaxBusPatches()
101 AliMUONRawStreamTrackerHP::AliMUONRawStreamTrackerHP(AliRawReader* rawReader) :
103 fEnableErrorLogger(kFALSE),
107 fBuffer(new UChar_t[8192]),
108 fkCurrentBusPatch(NULL),
114 fTotalNumberOfGlitchErrors(0),
115 fTotalNumberOfParityErrors(0),
116 fTotalNumberOfPaddingErrors(0)
119 /// Constructor with AliRawReader as argument.
122 // Must set this flag to get all information about parity errors though
123 // the OnData method. OnError gets them either way.
124 fDecoder.ExitOnError(false);
125 fDecoder.SendDataOnParityError(true);
127 fDecoder.GetHandler().SetMaxStructs(
128 fDecoder.MaxBlocks(),
130 fDecoder.MaxBusPatches()
133 fDecoder.GetHandler().SetReader(rawReader);
137 AliMUONRawStreamTrackerHP::~AliMUONRawStreamTrackerHP()
140 /// Default destructor.
147 if (fDDLObject != NULL)
154 void AliMUONRawStreamTrackerHP::First()
156 /// Initialise or reset the iterator.
157 /// The first DDL will be found and decoded.
159 assert( GetReader() != NULL );
164 fTotalNumberOfGlitchErrors = 0;
165 fTotalNumberOfPaddingErrors = 0;
166 fTotalNumberOfParityErrors = 0;
170 Bool_t AliMUONRawStreamTrackerHP::NextDDL()
172 /// Reading the next tracker DDL and decode the payload with the
173 /// high performance decoder.
174 /// \return kTRUE if the next DDL was successfully read and kFALSE otherwise.
176 assert( GetReader() != NULL );
178 // The temporary object if generated in GetDDLTracker, is now stale,
180 if (fDDLObject != NULL)
186 // Better to reset these pointers.
187 fkCurrentBusPatch = NULL;
188 fkCurrentData = NULL;
191 while (fDDL < GetMaxDDL())
193 GetReader()->Reset();
194 GetReader()->Select("MUONTRK", fDDL, fDDL); // Select the DDL file to be read.
195 if (GetReader()->ReadHeader()) break;
196 AliDebug(3, Form("Skipping DDL %d which does not seem to be there", fDDL+1));
200 // If we reach the end of the DDL list for this event then reset the
201 // DDL counter, mark the iteration as done and exit.
202 if (fDDL >= GetMaxDDL())
213 AliDebug(3, Form("DDL Number %d\n", fDDL));
215 Int_t dataSize = GetReader()->GetDataSize(); // in bytes
216 // Check if we have enough buffer space already in fBuffer. If we do then
217 // just continue reading otherwise we need to resize the buffer.
218 if (fBufferSize < dataSize)
228 fBuffer = new UChar_t[dataSize];
229 fBufferSize = dataSize;
231 catch (const std::bad_alloc&)
233 AliError("Could not allocate more buffer space. Cannot decode DDL.");
238 if (not GetReader()->ReadNext(fBuffer, dataSize))
244 Swap(reinterpret_cast<UInt_t*>(fBuffer), dataSize / sizeof(UInt_t)); // Swap needed for mac power pc.
250 // Since we might allocate memory inside OnNewBuffer in the event
251 // handler we need to trap any memory allocation exception to be robust.
252 result = fDecoder.Decode(fBuffer, dataSize);
253 fHadError = (result == true ? kFALSE : kTRUE);
254 fTotalNumberOfGlitchErrors += fDecoder.GetHandler().GlitchErrorCount();
255 fTotalNumberOfParityErrors += fDecoder.GetHandler().ParityErrorCount();
256 fTotalNumberOfPaddingErrors += fDecoder.GetHandler().PaddingErrorCount();
258 catch (const std::bad_alloc&)
260 AliError("Could not allocate more buffer space. Cannot decode DDL.");
264 // Update the current bus patch pointers.
265 fkCurrentBusPatch = fDecoder.GetHandler().FirstBusPatch();
266 if (fkCurrentBusPatch != fDecoder.GetHandler().EndOfBusPatch())
268 fkCurrentData = fkCurrentBusPatch->GetData();
269 fkEndOfData = fkCurrentData + fkCurrentBusPatch->GetDataCount();
273 // If the DDL did not have any bus patches then mark both fCurrentData
274 // and fEndOfData as NULL so that in Next() we are forced to find the
275 // first non empty DDL.
276 fkCurrentData = fkEndOfData = NULL;
279 fDDL++; // Remember to increment index to next DDL.
284 Bool_t AliMUONRawStreamTrackerHP::IsDone() const
286 /// Indicates whether the iteration is finished or not.
287 /// \return kTRUE if we already read all the digits and kFALSE if not.
293 Bool_t AliMUONRawStreamTrackerHP::Next(Int_t& busPatchId,
295 UChar_t& manuChannel,
297 Bool_t skipParityErrors)
299 /// Advance one step in the iteration. Returns false if finished.
300 /// [out] \param busPatchId This is filled with the bus patch ID of the digit.
301 /// [out] \param manuId This is filled with the MANU ID of the digit.
302 /// [out] \param manuChannel This is filled with the MANU channel ID of the digit.
303 /// [out] \param adc This is filled with the ADC signal value of the digit.
304 /// [in] \param skipParityErrors If this is kTRUE, we'll skip the buspatches that
305 /// have some parity errors
306 /// \return kTRUE if we read another digit and kFALSE if we have read all the
307 /// digits already, i.e. at the end of the iteration.
309 if (fkCurrentData == NULL) return kFALSE;
312 // Check if we still have data to be returned for the current bus patch.
313 if (fkCurrentData != fkEndOfData)
315 busPatchId = fkCurrentBusPatch->GetBusPatchId();
316 AliMUONTrackerDDLDecoderEventHandler::UnpackADC(*fkCurrentData, manuId, manuChannel, adc);
322 // We hit the end of the current bus patch so check if we have any more
323 // bus patches to process for the current DDL. If we do, then increment
324 // the current bus patch, make sure it is not the last one and then try
325 // reading the first element again.
326 if (fkCurrentBusPatch != fDecoder.GetHandler().EndOfBusPatch())
329 if (fkCurrentBusPatch != fDecoder.GetHandler().EndOfBusPatch())
331 fkCurrentData = fkCurrentBusPatch->GetData();
332 fkEndOfData = fkCurrentData + fkCurrentBusPatch->GetDataCount();
333 if ( skipParityErrors )
336 for ( Int_t i = 0; i < fkCurrentBusPatch->GetLength() && ok; ++ i )
338 ok = fkCurrentBusPatch->IsParityOk(i);
340 if (!ok) fkCurrentData = fkEndOfData;
346 // This was the last bus patch in the DDL so read in the next one and
347 // try reading the first data element again.
348 // Note: fCurrentBusPatch is set inside NextDDL().
349 if (NextDDL()) goto retry;
355 AliMUONDDLTracker* AliMUONRawStreamTrackerHP::GetDDLTracker() const
357 /// Construct and return a pointer to the DDL payload object.
358 /// \return Pointer to internally constructed AliMUONDDLTracker object.
359 /// The object is owned by this class and should not be deleted
362 /// \note This method should not be used just to gain access to the DDL
363 /// payload, unless there is a good reason to have the AliMUONDDLTracker
364 /// object. For example, if you want to modify the data and then save it
365 /// to another DDL stream. Otherwise it can be an order of magnitude
366 /// faster to access the DDL headers and data with the GetBlockHeader,
367 /// GetDspHeader and GetBusPatch methods for example.
368 /// Refer to the MUONRawStreamTracker.C macro to see how to use the fast
369 /// decoder interface optimally.
371 if (fDDLObject != NULL) return fDDLObject;
373 fDDLObject = new AliMUONDDLTracker;
374 for (Int_t iBlock = 0; iBlock < (Int_t)GetBlockCount(); iBlock++)
376 AliMUONBlockHeader blockHeader;
377 AliMUONDspHeader dspHeader;
378 AliMUONBusStruct busPatch;
380 const AliBlockHeader* bh = GetBlockHeader(iBlock);
381 // Copy block header and add it to the DDL object.
382 memcpy(blockHeader.GetHeader(), bh->GetHeader(), sizeof(AliMUONBlockHeaderStruct));
383 fDDLObject->AddBlkHeader(blockHeader);
385 for (Int_t iDsp = 0; iDsp < (Int_t)bh->GetDspCount(); iDsp++)
387 const AliDspHeader* dh = bh->GetDspHeader(iDsp);
388 // Copy DSP header and add it to the DDL object.
389 memcpy(dspHeader.GetHeader(), dh->GetHeader(), sizeof(AliMUONDSPHeaderStruct));
390 fDDLObject->AddDspHeader(dspHeader, iBlock);
392 const AliBusPatch* bp = dh->GetFirstBusPatch();
395 // Copy bus patch header, data and add everything into DDL object.
396 memcpy(busPatch.GetHeader(), bp->GetHeader(), sizeof(AliMUONBusPatchHeaderStruct));
397 busPatch.SetAlloc(bp->GetLength());
398 memcpy(busPatch.GetData(), bp->GetData(), bp->GetDataCount()*sizeof(UInt_t));
399 busPatch.SetBlockId(iBlock);
400 busPatch.SetDspId(iDsp);
401 fDDLObject->AddBusPatch(busPatch, iBlock, iDsp);
411 void AliMUONRawStreamTrackerHP::SetMaxBlock(Int_t blk)
413 /// Set maximum number of blocks per DDL allowed.
414 fDecoder.MaxBlocks( (UInt_t) blk );
416 fDecoder.GetHandler().SetMaxStructs(
417 fDecoder.MaxBlocks(),
419 fDecoder.MaxBusPatches()
424 void AliMUONRawStreamTrackerHP::SetMaxDsp(Int_t dsp)
426 /// Set maximum number of Dsp per block allowed.
427 fDecoder.MaxDSPs( (UInt_t) dsp );
429 fDecoder.GetHandler().SetMaxStructs(
430 fDecoder.MaxBlocks(),
432 fDecoder.MaxBusPatches()
437 void AliMUONRawStreamTrackerHP::SetMaxBus(Int_t bus)
439 /// Set maximum number of Buspatch per Dsp allowed.
440 fDecoder.MaxBusPatches( (UInt_t) bus );
442 fDecoder.GetHandler().SetMaxStructs(
443 fDecoder.MaxBlocks(),
445 fDecoder.MaxBusPatches()
449 AliRawReader* AliMUONRawStreamTrackerHP::GetReader()
451 return fDecoder.GetHandler().GetReader();
454 void AliMUONRawStreamTrackerHP::SetReader(AliRawReader* reader)
456 fDecoder.GetHandler().SetReader(reader);
459 ///////////////////////////////////////////////////////////////////////////////
461 void AliMUONRawStreamTrackerHP::AliBlockHeader::Print() const
463 /// Print header to screen.
465 cout << "CRT info" << endl;
468 cout << "Header is NULL" << endl;
471 cout << "DataKey: 0x" << hex << fHeader->fDataKey << dec << endl;
472 cout << "TotalLength: " << fHeader->fTotalLength << endl;
473 cout << "Length: " << fHeader->fLength << endl;
474 cout << "DspId: " << fHeader->fDSPId << endl;
475 cout << "L0Trigger: " << fHeader->fL0Trigger << endl;
476 cout << "MiniEventId: " << fHeader->fMiniEventId<< endl;
477 cout << "EventId1: " << fHeader->fEventId1 << endl;
478 cout << "EventId2: " << fHeader->fEventId2 << endl;
482 void AliMUONRawStreamTrackerHP::AliDspHeader::Print() const
484 /// Print header to screen.
486 cout << "FRT info" << endl;
489 cout << "Header is NULL" << endl;
492 cout << "DataKey: 0x" << hex << fHeader->fDataKey << dec << endl;
493 cout << "TotalLength: " << fHeader->fTotalLength << endl;
494 cout << "Length : " << fHeader->fLength << endl;
495 cout << "DspId: " << fHeader->fDSPId << endl;
496 cout << "BlkL1ATrigger: " << fHeader->fBlkL1ATrigger << endl;
497 cout << "MiniEventId: " << fHeader->fMiniEventId << endl;
498 cout << "L1ATrigger: " << fHeader->fL1ATrigger << endl;
499 cout << "L1RTrigger: " << fHeader->fL1RTrigger << endl;
500 cout << "PaddingWord: " << fHeader->fPaddingWord << endl;
501 cout << "ErrorWord: " << fHeader->fErrorWord << endl;
505 void AliMUONRawStreamTrackerHP::AliBusPatch::Print(const Option_t* opt) const
507 /// Print header to screen.
508 cout << "Bus patch info" << endl;
511 cout << "Header is NULL" << endl;
514 cout << "DataKey: 0x" << hex << fHeader->fDataKey << dec << endl;
515 cout << "fTotalLength: " << fHeader->fTotalLength << endl;
516 cout << "fLength: " << fHeader->fLength << endl;
517 cout << "fBusPatchId: " << fHeader->fBusPatchId << endl;
519 if (TString(opt).Contains("all"))
521 for (UInt_t i = 0; i < fHeader->fLength; ++i)
522 cout << "Data["<< i << "] = " << fData[i] << endl;
526 ///////////////////////////////////////////////////////////////////////////////
528 AliMUONRawStreamTrackerHP::AliDecoderEventHandler::AliDecoderEventHandler() :
535 fEndOfBusPatches(NULL),
537 fParityOk(new Bool_t[8192]),
540 fCurrentBusPatch(NULL),
541 fCurrentParityOkFlag(NULL),
550 /// Default constructor initialises the internal parity flags buffer to
551 /// store 8192 elements. This array will grow dynamically if needed.
555 AliMUONRawStreamTrackerHP::AliDecoderEventHandler::~AliDecoderEventHandler()
557 /// Default destructor cleans up the allocated memory.
559 if (fParityOk != NULL) delete [] fParityOk;
560 if (fBlocks != NULL) delete [] fBlocks;
561 if (fDSPs != NULL) delete [] fDSPs;
562 if (fBusPatches != NULL) delete [] fBusPatches;
566 void AliMUONRawStreamTrackerHP::AliDecoderEventHandler::SetMaxStructs(
567 UInt_t maxBlocks, UInt_t maxDsps, UInt_t maxBusPatches
570 /// Sets the maximum number of structures allowed.
572 // Start by clearing the current arrays.
583 if (fBusPatches != NULL)
585 delete [] fBusPatches;
588 fCurrentBlock = NULL;
590 fCurrentBusPatch = NULL;
592 // Allocate new memory.
593 fBlocks = new AliBlockHeader[maxBlocks];
594 fDSPs = new AliDspHeader[maxBlocks*maxDsps];
595 fBusPatches = new AliBusPatch[maxBlocks*maxDsps*maxBusPatches];
596 fEndOfBusPatches = fBusPatches;
598 fMaxBlocks = maxBlocks;
600 fMaxBusPatches = maxBusPatches;
604 void AliMUONRawStreamTrackerHP::AliDecoderEventHandler::OnNewBuffer(
605 const void* buffer, UInt_t bufferSize
608 /// This is called by the high performance decoder when a new DDL payload
609 /// is about to be decoded.
610 /// \param buffer The pointer to the buffer storing the DDL payload.
611 /// \param bufferSize The size of the buffer in bytes.
613 // remember the start of the buffer to be used in OnError.
614 fBufferStart = buffer;
616 // Reset error counters.
621 // Check if we will have enough space in the fParityOk array.
622 // If we do not then we need to resize the array.
623 // bufferSize / sizeof(UInt_t) will be a safe over estimate of the
624 // number of channels that we will find.
625 UInt_t maxChannelsPossible = bufferSize / sizeof(UInt_t);
626 if (maxChannelsPossible > fMaxChannels)
628 if (fParityOk != NULL)
634 fParityOk = new Bool_t[maxChannelsPossible];
635 fMaxChannels = maxChannelsPossible;
638 // Reset the current pointers which will be used to track where we need to
639 // fill fBlocks, fDSPs, fBusPatches and the parity flag. We have to subtract
640 // one space because we will increment the pointer the first time in the
642 fCurrentBlock = fBlocks-1;
643 fCurrentDSP = fDSPs-1;
644 fCurrentBusPatch = fBusPatches-1;
645 fCurrentParityOkFlag = fParityOk-1;
650 void AliMUONRawStreamTrackerHP::AliDecoderEventHandler::OnError(
651 ErrorCode error, const void* location
654 /// This is called by the high performance decoder when a error occurs
655 /// when trying to decode the DDL payload. This indicates corruption in
656 /// the data. This method converts the error code to a descriptive message
657 /// and logs this with the raw reader.
658 /// \param error The error code indicating the problem.
659 /// \param location A pointer to the location within the DDL payload buffer
660 /// being decoded where the problem with the data was found.
662 assert( fRawReader != NULL );
664 Char_t* message = NULL;
672 "Glitch error detected in DSP %d, skipping event ",
673 fCurrentBlock->GetDspId()
675 fRawReader->AddMajorErrorLog(error, message);
678 case kBadPaddingWord:
680 // We subtract 1 from the current numbers of blocks, DSPs
681 // and bus patches to get the indices.
683 "Padding word error for iBlock %d, iDsp %d, iBus %d\n",
685 fCurrentBlock->GetDspCount()-1,
686 fCurrentDSP->GetBusPatchCount()-1
688 fRawReader->AddMinorErrorLog(error, message);
693 // location points to the incorrect data word and
694 // fCurrentBusPatch->GetData() returns a pointer to the start of
695 // bus patches data, so the difference divided by 4 gives the 32
697 word = ((unsigned long)location - (unsigned long)fCurrentBusPatch->GetData())
700 "Parity error in word %d for manuId %d and channel %d in buspatch %d\n",
702 fCurrentBusPatch->GetManuId(word),
703 fCurrentBusPatch->GetChannelId(word),
704 fCurrentBusPatch->GetBusPatchId()
706 fRawReader->AddMinorErrorLog(error, message);
711 "%s (At byte %d in DDL.)",
712 ErrorCodeToMessage(error),
713 (unsigned long)location - (unsigned long)fBufferStart + sizeof(AliRawDataHeader)
715 fRawReader->AddMajorErrorLog(error, message);
722 "AliMUONRawStreamTrackerHP::AliDecoderEventHandler",