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 **************************************************************************/
19 /// \class AliMUONRawStreamTriggerHP
21 /// Implementation of a streamer interface to the high performance trigger decoder.
22 /// This is the raw stream class which interfaces between the high performance
23 /// core decoder for MUON trigger chambers and the AliRawReader class.
24 /// To gain the most out of the decoder, the Next() method should be used,
27 /// AliMUONRawStreamTriggerHP* rawStream; // assume initialised
28 /// const AliMUONRawStreamTriggerHP::AliLocalStruct* localStruct;
29 /// while ((localStruct = rawStream->Next()) != NULL)
31 /// // Do something with localStruct here.
35 /// This decoder tries to implement as similar an interface as possible to
36 /// AliMUONRawStreamTrigger where possible. However certain constructs which
37 /// would slow us down too much are avoided.
39 /// \author Artur Szostak <artursz@iafrica.com>
41 #include "AliMUONRawStreamTriggerHP.h"
42 #include "AliMUONDarcHeader.h"
43 #include "AliMUONRegHeader.h"
44 #include "AliMUONLocalStruct.h"
45 #include "AliMUONDDLTrigger.h"
46 #include "AliRawReader.h"
56 ClassImp(AliMUONRawStreamTriggerHP)
59 const Int_t AliMUONRawStreamTriggerHP::fgkMaxDDL = 2;
60 bool AliMUONRawStreamTriggerHP::AliLocalStruct::fgOverrideId = true;
62 const AliMUONRegionalHeaderStruct
63 AliMUONRawStreamTriggerHP::AliDecoderEventHandler::fgkEmptyHeader = {
64 AliMUONTriggerDDLDecoder<AliDecoderEventHandler>::RegionalErrorWord(),
71 AliMUONRawStreamTriggerHP::AliMUONRawStreamTriggerHP() :
72 AliMUONVRawStreamTrigger(),
76 fBuffer(new UChar_t[8192]),
77 fkCurrentLocalStruct(NULL),
83 /// Default constructor.
86 fDecoder.ExitOnError(false);
88 fDecoder.GetHandler().SetMaxStructs(
89 fDecoder.MaxRegionals(),
93 fDecoder.GetHandler().SetRawStream(this);
97 AliMUONRawStreamTriggerHP::AliMUONRawStreamTriggerHP(AliRawReader* rawReader) :
98 AliMUONVRawStreamTrigger(rawReader),
102 fBuffer(new UChar_t[8192]),
103 fkCurrentLocalStruct(NULL),
109 /// Constructor with AliRawReader as argument.
112 fDecoder.ExitOnError(false);
114 fDecoder.GetHandler().SetMaxStructs(
115 fDecoder.MaxRegionals(),
119 fDecoder.GetHandler().SetRawStream(this);
123 AliMUONRawStreamTriggerHP::~AliMUONRawStreamTriggerHP()
126 /// Default destructor which cleans up the memory allocated.
133 if (fDDLObject != NULL)
140 void AliMUONRawStreamTriggerHP::First()
142 /// Initialise or reset the iterator.
143 /// The first DDL will be found and decoded.
145 assert( GetReader() != NULL );
153 Bool_t AliMUONRawStreamTriggerHP::NextDDL()
155 /// Read in the next trigger DDL and decode the payload with the
156 /// high performance decoder.
157 /// \return kTRUE if the next DDL was successfully read and kFALSE
160 assert( GetReader() != NULL );
162 // The temporary object if generated in GetDDLTracker, is now stale,
164 if (fDDLObject != NULL)
170 fkCurrentLocalStruct = NULL;
172 while (fDDL < GetMaxDDL())
174 GetReader()->Reset();
175 GetReader()->Select("MUONTRG", fDDL, fDDL); // Select the DDL file to be read.
176 if (GetReader()->ReadHeader()) break;
177 AliDebug(3, Form("Skipping DDL %d which does not seem to be there", fDDL+1));
181 // If we reach the end of the DDL list for this event then reset the
182 // DDL counter, mark the iteration as done and exit.
183 if (fDDL >= GetMaxDDL())
194 AliDebug(3, Form("DDL Number %d\n", fDDL));
196 Int_t dataSize = GetReader()->GetDataSize(); // in bytes
197 // Check if we have enough buffer space already in fBuffer. If we do then
198 // just continue reading otherwise we need to resize the buffer.
199 if (fBufferSize < dataSize)
209 fBuffer = new UChar_t[dataSize];
210 fBufferSize = dataSize;
212 catch (const std::bad_alloc&)
214 AliError("Could not allocate more buffer space. Cannot decode DDL.");
219 if (not GetReader()->ReadNext(fBuffer, dataSize))
225 Swap(reinterpret_cast<UInt_t*>(fBuffer), dataSize / sizeof(UInt_t)); // Swap needed for mac power pc.
228 // Check if this is a scalar event.
229 bool scalerEvent = (GetReader()->GetDataHeader()->GetL1TriggerMessage() & 0x1) == 0x1;
234 // Since we might allocate memory inside OnNewBuffer in the event
235 // handler we need to trap any memory allocation exception to be robust.
236 result = fDecoder.Decode(fBuffer, dataSize, scalerEvent);
237 fHadError = (result == true ? kFALSE : kTRUE);
239 catch (const std::bad_alloc&)
241 AliError("Could not allocate more buffer space. Cannot decode DDL.");
245 // Update the current local structure pointer.
246 fkCurrentLocalStruct = fDecoder.GetHandler().FirstLocalStruct();
248 fDDL++; // Remember to increment index to next DDL.
253 Bool_t AliMUONRawStreamTriggerHP::IsDone() const
255 /// Indicates whether the iteration is finished or not.
256 /// \return kTRUE if we already read all the digits and kFALSE if not.
262 Bool_t AliMUONRawStreamTriggerHP::Next(
263 UChar_t& id, UChar_t& dec, Bool_t& trigY,
264 UChar_t& yPos, UChar_t& sXDev, UChar_t& xDev,
265 UChar_t& xPos, Bool_t& triggerY, Bool_t& triggerX,
266 TArrayS& xPattern, TArrayS& yPattern
269 /// Advance one step in the iteration. Returns kFALSE if finished.
270 /// If kTRUE is returned then the output parameters are filled with
271 /// the values found in the next local trigger circuit structure.
273 const AliLocalStruct* localStruct = Next();
274 if (localStruct == NULL) return kFALSE;
276 id = localStruct->GetId();
277 dec = localStruct->GetDec();
278 trigY = localStruct->GetTrigY();
279 yPos = localStruct->GetYPos();
280 sXDev = localStruct->GetSXDev();
281 xDev = localStruct->GetXDev();
282 xPos = localStruct->GetXPos();
284 triggerX = localStruct->GetTriggerX();
285 triggerY = localStruct->GetTriggerY();
287 localStruct->GetXPattern(xPattern);
288 localStruct->GetYPattern(yPattern);
294 AliMUONDDLTrigger* AliMUONRawStreamTriggerHP::GetDDLTrigger() const
296 /// Construct and return a pointer to the DDL payload object.
297 /// \return Pointer to internally constructed AliMUONDDLTrigger object.
298 /// The object is owned by this class and should not be deleted
301 /// \note This method should not be used just to gain access to the DDL
302 /// payload, unless there is a good reason to have the AliMUONDDLTrigger
303 /// object. For example, if you want to modify the data and then save it
304 /// to another DDL stream. Otherwise it can be an order of magnitude
305 /// faster to access the DDL headers and data with the GetHeaders,
306 /// GetRegionalHeader and GetLocalStruct methods for example.
307 /// Refer to the MUONRawStreamTrigger.C macro to see how to use the fast
308 /// decoder interface optimally.
310 if (fDDLObject != NULL) return fDDLObject;
312 fDDLObject = new AliMUONDDLTrigger;
314 // Copy over all DARC, global headers and scalars.
315 AliMUONDarcHeader* darcHeader = fDDLObject->GetDarcHeader();
316 const AliHeader* hdr = GetHeaders();
317 UInt_t word = hdr->GetDarcHeader();
318 memcpy(darcHeader->GetHeader(), &word, sizeof(word));
319 if (hdr->GetDarcScalars() != NULL)
321 memcpy(darcHeader->GetDarcScalers(), hdr->GetDarcScalars(), sizeof(AliMUONDarcScalarsStruct));
323 memcpy(darcHeader->GetGlobalInput(), hdr->GetGlobalHeader(), sizeof(AliMUONGlobalHeaderStruct));
324 if (hdr->GetGlobalScalars() != NULL)
326 memcpy(darcHeader->GetGlobalScalers(), hdr->GetGlobalScalars(), sizeof(AliMUONGlobalScalarsStruct));
329 for (Int_t iReg = 0; iReg < (Int_t)GetRegionalHeaderCount(); iReg++)
331 AliMUONRegHeader regHeader;
332 AliMUONLocalStruct localStruct;
334 const AliRegionalHeader* rh = GetRegionalHeader(iReg);
335 // Copy local structure and scalars and add everything into DDL object.
336 memcpy(regHeader.GetHeader(), rh->GetHeader(), sizeof(AliMUONRegionalHeaderStruct));
337 if (rh->GetScalars() != NULL)
339 memcpy(regHeader.GetScalers(), rh->GetScalars(), sizeof(AliMUONRegionalScalarsStruct));
341 fDDLObject->AddRegHeader(regHeader);
343 const AliLocalStruct* lstruct = rh->GetFirstLocalStruct();
344 while (lstruct != NULL)
346 // Copy local structure and scalars and add everything into DDL object.
347 memcpy(localStruct.GetData(), lstruct->GetData(), sizeof(AliMUONLocalInfoStruct));
348 if (lstruct->GetScalars() != NULL)
350 memcpy(localStruct.GetScalers(), lstruct->GetScalars(), sizeof(AliMUONLocalScalarsStruct));
352 if (AliMUONRawStreamTriggerHP::AliLocalStruct::GetOverrideIdFlag() == true)
354 // Since the override ID flag is set, we need to replace the
355 // ID in the structure with the calculated one returned by GetId().
356 AliMUONLocalInfoStruct* strptr = reinterpret_cast<AliMUONLocalInfoStruct*>( localStruct.GetData() );
357 UInt_t triggerBits = strptr->fTriggerBits;
358 triggerBits &= (0xF << 19);
359 strptr->fTriggerBits = triggerBits | (lstruct->GetId() << 19);
361 fDDLObject->AddLocStruct(localStruct, iReg);
362 lstruct = lstruct->Next();
370 void AliMUONRawStreamTriggerHP::SetMaxReg(Int_t reg)
372 /// Set the maximum allowed number of regional cards in the DDL.
374 fDecoder.MaxRegionals( (UInt_t) reg );
376 fDecoder.GetHandler().SetMaxStructs(
377 fDecoder.MaxRegionals(),
383 void AliMUONRawStreamTriggerHP::SetMaxLoc(Int_t loc)
385 /// Sets the maximum number of local cards in the DDL.
387 fDecoder.MaxLocals( (UInt_t) loc );
389 fDecoder.GetHandler().SetMaxStructs(
390 fDecoder.MaxRegionals(),
395 ///////////////////////////////////////////////////////////////////////////////
397 void AliMUONRawStreamTriggerHP::AliHeader::Print() const
399 /// Print DARC header, global header and global scalars to screen.
401 cout << "===== DARC info =====" << endl;
402 cout << "Header bits : 0x" << hex << fDarcHeader << dec << endl;
403 if (fDarcScalars != NULL)
405 cout << "L0R : " << fDarcScalars->fL0R << " (0x"
406 << hex << fDarcScalars->fL0R << dec << ")" << endl;
407 cout << "L1P : " << fDarcScalars->fL1P << " (0x"
408 << hex << fDarcScalars->fL1P << dec << ")" << endl;
409 cout << "L1S : " << fDarcScalars->fL1S << " (0x"
410 << hex << fDarcScalars->fL1S << dec << ")" << endl;
411 cout << "L2A : " << fDarcScalars->fL2A << " (0x"
412 << hex << fDarcScalars->fL2A << dec << ")" << endl;
413 cout << "L2R : " << fDarcScalars->fL2R << " (0x"
414 << hex << fDarcScalars->fL2R << dec << ")" << endl;
415 cout << "Clock : " << fDarcScalars->fClk << " (0x"
416 << hex << fDarcScalars->fClk << dec << ")" << endl;
417 cout << "Hold : " << fDarcScalars->fHold << " (0x"
418 << hex << fDarcScalars->fHold << dec << ")" << endl;
419 cout << "Spare : " << fDarcScalars->fSpare << " (0x"
420 << hex << fDarcScalars->fSpare << dec << ")" << endl;
424 cout << "Scalars == NULL" << endl;
427 cout << "===== Global info =====" << endl;
428 for (int i = 0; i < 4; i++)
430 cout << "Input[" << i << "] : " << fGlobalHeader->fInput[i] << " (0x"
431 << hex << fGlobalHeader->fInput[i] << dec << ")" << endl;
433 cout << "Output : " << fGlobalHeader->fOutput << " (0x"
434 << hex << fGlobalHeader->fOutput << dec << ")" << endl;
435 if (fGlobalScalars != NULL)
437 cout << "L0 : " << fGlobalScalars->fL0 << " (0x"
438 << hex << fGlobalScalars->fL0 << dec << ")" << endl;
439 cout << "Clock : " << fGlobalScalars->fClk << " (0x"
440 << hex << fGlobalScalars->fClk << dec << ")" << endl;
441 for (int j = 0; j < 4; j++)
443 cout << "Scaler[" << j << "] : " << fGlobalScalars->fScaler[j] << " (0x"
444 << hex << fGlobalScalars->fScaler[j] << dec << ")" << endl;
446 cout << "Hold : " << fGlobalScalars->fHold << " (0x"
447 << hex << fGlobalScalars->fHold << dec << ")" << endl;
448 cout << "Spare : " << fGlobalScalars->fSpare << " (0x"
449 << hex << fGlobalScalars->fSpare << dec << ")" << endl;
453 cout << "Scalars == NULL" << endl;
457 void AliMUONRawStreamTriggerHP::AliRegionalHeader::Print() const
459 /// Print the regional header and scalars to screen.
461 cout << "===== Regional card info =====" << endl;
462 cout << "DarcWord : " << fHeader->fDarcWord << " (0x"
463 << hex << fHeader->fDarcWord << dec << ")" << endl;
464 cout << "Word : " << fHeader->fWord << " (0x"
465 << hex << fHeader->fWord << dec << ")" << endl;
466 cout << "Input[0] : " << fHeader->fInput[0] << " (0x"
467 << hex << fHeader->fInput[0] << dec << ")" << endl;
468 cout << "Input[1] : " << fHeader->fInput[1] << " (0x"
469 << hex << fHeader->fInput[1] << dec << ")" << endl;
470 cout << "L0/Mask : " << fHeader->fL0CountAndMask << " (0x"
471 << hex << fHeader->fL0CountAndMask << dec << ")" << endl;
472 if (fScalars != NULL)
474 cout << "Clock : " << fScalars->fClk << " (0x"
475 << hex << fScalars->fClk << dec << ")" << endl;
476 for (int i = 0; i < 8; i++)
478 cout << "Scaler[" << i << "] : " << fScalars->fScaler[i] << " (0x"
479 << hex << fScalars->fScaler[i] << dec << ")" << endl;
481 cout << "Hold : " << fScalars->fHold << " (0x"
482 << hex << fScalars->fHold << dec << ")" << endl;
486 cout << "Scalars == NULL" << endl;
490 void AliMUONRawStreamTriggerHP::AliLocalStruct::Print() const
492 /// Print local trigger structure and scalars to screen.
494 cout << "===== Local card info =====" << endl;
495 cout << "X2X1 : " << fLocalStruct->fX2X1 << " (0x"
496 << hex << fLocalStruct->fX2X1 << dec << ")" << endl;
497 cout << "X4X3 : " << fLocalStruct->fX4X3 << " (0x"
498 << hex << fLocalStruct->fX4X3 << dec << ")" << endl;
499 cout << "Y2Y1 : " << fLocalStruct->fY2Y1 << " (0x"
500 << hex << fLocalStruct->fY2Y1 << dec << ")" << endl;
501 cout << "Y4Y3 : " << fLocalStruct->fY4Y3 << " (0x"
502 << hex << fLocalStruct->fY4Y3 << dec << ")" << endl;
503 cout << "Trigger bits : " << fLocalStruct->fTriggerBits << " (0x"
504 << hex << fLocalStruct->fTriggerBits << dec << ")" << endl;
505 if (fScalars != NULL)
507 cout << "L0 : " << fScalars->fL0 << " (0x"
508 << hex << fScalars->fL0 << dec << ")" << endl;
509 cout << "Hold : " << fScalars->fHold << " (0x"
510 << hex << fScalars->fHold << dec << ")" << endl;
511 cout << "Clock : " << fScalars->fClk << " (0x"
512 << hex << fScalars->fClk << dec << ")" << endl;
513 cout << "LPtNTrig : " << fScalars->fLPtNTrig << " (0x"
514 << hex << fScalars->fLPtNTrig << dec << ")" << endl;
515 cout << "HPtNTrig : " << fScalars->fHPtNTrig << " (0x"
516 << hex << fScalars->fHPtNTrig << dec << ")" << endl;
517 cout << "LPtRTrig : " << fScalars->fLPtRTrig << " (0x"
518 << hex << fScalars->fLPtRTrig << dec << ")" << endl;
519 cout << "HPtRTrig : " << fScalars->fHPtRTrig << " (0x"
520 << hex << fScalars->fHPtRTrig << dec << ")" << endl;
521 cout << "LPtLTrig : " << fScalars->fLPtLTrig << " (0x"
522 << hex << fScalars->fLPtLTrig << dec << ")" << endl;
523 cout << "HPtLTrig : " << fScalars->fHPtLTrig << " (0x"
524 << hex << fScalars->fHPtLTrig << dec << ")" << endl;
525 cout << "LPtSTrig : " << fScalars->fLPtSTrig << " (0x"
526 << hex << fScalars->fLPtSTrig << dec << ")" << endl;
527 cout << "HPtSTrig : " << fScalars->fHPtSTrig << " (0x"
528 << hex << fScalars->fHPtSTrig << dec << ")" << endl;
529 for (int i = 0; i < 8*4; i++)
531 cout << "Scaler[" << i << "] : " << fScalars->fScaler[i] << " (0x"
532 << hex << fScalars->fScaler[i] << dec << ")" << endl;
534 cout << "EOS : " << fScalars->fEOS << " (0x"
535 << hex << fScalars->fEOS << dec << ")" << endl;
536 cout << "Reset : " << fScalars->fReset << " (0x"
537 << hex << fScalars->fReset << dec << ")" << endl;
541 cout << "Scalars == NULL" << endl;
545 ///////////////////////////////////////////////////////////////////////////////
547 AliMUONRawStreamTriggerHP::AliDecoderEventHandler::AliDecoderEventHandler() :
557 fCurrentRegional(NULL),
565 /// Default constructor
569 AliMUONRawStreamTriggerHP::AliDecoderEventHandler::~AliDecoderEventHandler()
571 /// Default destructor cleans up the allocated memory.
573 if (fRegionals != NULL) delete [] fRegionals;
574 if (fLocals != NULL) delete [] fLocals;
578 void AliMUONRawStreamTriggerHP::AliDecoderEventHandler::SetMaxStructs(
579 UInt_t maxRegionals, UInt_t maxLocals
582 /// Sets the maximum number of structures allowed.
584 // Start by clearing the current arrays.
585 if (fRegionals != NULL)
587 delete [] fRegionals;
596 fCurrentRegional = NULL;
597 fCurrentLocal = NULL;
599 // Allocate new memory.
600 fRegionals = new AliRegionalHeader[maxRegionals];
601 fLocals = new AliLocalStruct[maxRegionals*maxLocals];
602 fEndOfLocals = fLocals;
604 fRegionalsCount = maxRegionals;
608 void AliMUONRawStreamTriggerHP::AliDecoderEventHandler::OnNewBuffer(
609 const void* buffer, UInt_t /*bufferSize*/
612 /// This is called by the high performance decoder when a new DDL payload
613 /// is about to be decoded.
615 assert( fRawStream != NULL );
617 // remember the start of the buffer to be used in OnError.
618 fBufferStart = buffer;
620 // Reset error counters.
622 fGlobalEoWErrors = 0;
626 // Reset the current local structure pointer which will be used to track
627 // where we need to fill fLocals. We have to subtract one space because we
628 // will increment the pointer the first time in the OnLocalStruct method.
629 fCurrentLocal = fLocals-1;
631 fCurrentRegional = NULL;
633 // Reset and link up all the regional structures together.
634 for (UInt_t i = 0; i+1 < fRegionalsCount; i++)
636 fRegionals[i] = AliRegionalHeader(fLocals, &fgkEmptyHeader, NULL);
637 fRegionals[i].SetNext(&fRegionals[i+1]);
639 // Reset the last structure.
640 fRegionals[fRegionalsCount-1] = AliRegionalHeader(fLocals, &fgkEmptyHeader, NULL);
644 void AliMUONRawStreamTriggerHP::AliDecoderEventHandler::OnError(
645 ErrorCode error, const void* location
648 /// This is called by the high performance decoder when a error occurs
649 /// when trying to decode the DDL payload. This indicates corruption in
650 /// the data. This method converts the error code to a descriptive message
651 /// and logs this with the raw reader.
652 /// \param error The error code indicating the problem.
653 /// \param location A pointer to the location within the DDL payload buffer
654 /// being decoded where the problem with the data was found.
656 assert( fRawStream != NULL );
657 assert( fRawStream->GetReader() != NULL );
659 Char_t* message = NULL;
664 case kWrongEventType:
665 message = Form("Wrong event type obtained from the Darc header, take the one of CDH");
671 "Wrong end of Darc word %x instead of %x\n",
672 *reinterpret_cast<const UInt_t*>(location),
673 AliMUONTriggerDDLDecoder<AliMUONTriggerDDLDecoderEventHandler>::EndOfDarcWord()
675 fRawStream->GetReader()->AddMajorErrorLog(kDarcEoWErr, message);
678 case kBadEndOfGlobal:
681 "Wrong end of Global word %x instead of %x\n",
682 *reinterpret_cast<const UInt_t*>(location),
683 AliMUONTriggerDDLDecoder<AliMUONTriggerDDLDecoderEventHandler>::EndOfGlobalWord()
685 fRawStream->GetReader()->AddMajorErrorLog(kGlobalEoWErr, message);
688 case kBadEndOfRegional:
691 "Wrong end of Regional word %x instead of %x\n",
692 *reinterpret_cast<const UInt_t*>(location),
693 AliMUONTriggerDDLDecoder<AliMUONTriggerDDLDecoderEventHandler>::EndOfRegionalWord()
695 fRawStream->GetReader()->AddMajorErrorLog(kRegEoWErr, message);
701 "Wrong end of Local word %x instead of %x\n",
702 *reinterpret_cast<const UInt_t*>(location),
703 AliMUONTriggerDDLDecoder<AliMUONTriggerDDLDecoderEventHandler>::EndOfLocalWord()
705 fRawStream->GetReader()->AddMajorErrorLog(kLocalEoWErr, message);
710 "%s (At byte %d in DDL.)",
711 ErrorCodeToMessage(error),
712 (unsigned long)location - (unsigned long)fBufferStart + sizeof(AliRawDataHeader)
714 fRawStream->GetReader()->AddMajorErrorLog(error, message);
721 "AliMUONRawStreamTriggerHP::AliDecoderEventHandler",