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"
57 ClassImp(AliMUONRawStreamTriggerHP)
60 const Int_t AliMUONRawStreamTriggerHP::fgkMaxDDL = 2;
63 AliMUONRawStreamTriggerHP::AliMUONRawStreamTriggerHP() :
64 AliMUONVRawStreamTrigger(),
68 fBuffer(new UChar_t[8192]),
69 fCurrentLocalStruct(NULL),
75 /// Default constructor.
78 fDecoder.ExitOnError(false);
80 fDecoder.GetHandler().SetMaxStructs(
81 fDecoder.MaxRegionals(),
85 fDecoder.GetHandler().SetRawStream(this);
89 AliMUONRawStreamTriggerHP::AliMUONRawStreamTriggerHP(AliRawReader* rawReader) :
90 AliMUONVRawStreamTrigger(rawReader),
94 fBuffer(new UChar_t[8192]),
95 fCurrentLocalStruct(NULL),
101 /// Constructor with AliRawReader as argument.
104 fDecoder.ExitOnError(false);
106 fDecoder.GetHandler().SetMaxStructs(
107 fDecoder.MaxRegionals(),
111 fDecoder.GetHandler().SetRawStream(this);
115 AliMUONRawStreamTriggerHP::~AliMUONRawStreamTriggerHP()
118 /// Default destructor which cleans up the memory allocated.
125 if (fDDLObject != NULL)
132 void AliMUONRawStreamTriggerHP::First()
134 /// Initialise or reset the iterator.
135 /// The first DDL will be found and decoded.
137 assert( GetReader() != NULL );
145 Bool_t AliMUONRawStreamTriggerHP::NextDDL()
147 /// Read in the next trigger DDL and decode the payload with the
148 /// high performance decoder.
149 /// \return kTRUE if the next DDL was successfully read and kFALSE
152 assert( GetReader() != NULL );
154 // The temporary object if generated in GetDDLTracker, is now stale,
156 if (fDDLObject != NULL)
162 fCurrentLocalStruct = NULL;
164 while (fDDL < GetMaxDDL())
166 GetReader()->Reset();
167 GetReader()->Select("MUONTRG", fDDL, fDDL); // Select the DDL file to be read.
168 if (GetReader()->ReadHeader()) break;
169 AliDebug(3, Form("Skipping DDL %d which does not seem to be there", fDDL+1));
173 // If we reach the end of the DDL list for this event then reset the
174 // DDL counter, mark the iteration as done and exit.
175 if (fDDL >= GetMaxDDL())
186 AliDebug(3, Form("DDL Number %d\n", fDDL));
188 Int_t dataSize = GetReader()->GetDataSize(); // in bytes
189 // Check if we have enough buffer space already in fBuffer. If we do then
190 // just continue reading otherwise we need to resize the buffer.
191 if (fBufferSize < dataSize)
201 fBuffer = new UChar_t[dataSize];
202 fBufferSize = dataSize;
204 catch (const std::bad_alloc&)
206 AliError("Could not allocate more buffer space. Cannot decode DDL.");
211 if (not GetReader()->ReadNext(fBuffer, dataSize))
217 Swap(reinterpret_cast<UInt_t*>(fBuffer), dataSize / sizeof(UInt_t)); // Swap needed for mac power pc.
223 // Since we might allocate memory inside OnNewBuffer in the event
224 // handler we need to trap any memory allocation exception to be robust.
225 result = fDecoder.Decode(fBuffer, dataSize);
226 fHadError = (result == true ? kFALSE : kTRUE);
228 catch (const std::bad_alloc&)
230 AliError("Could not allocate more buffer space. Cannot decode DDL.");
234 // Update the current local structure pointer.
235 fCurrentLocalStruct = fDecoder.GetHandler().FirstLocalStruct();
237 fDDL++; // Remember to increment index to next DDL.
242 Bool_t AliMUONRawStreamTriggerHP::IsDone() const
244 /// Indicates whether the iteration is finished or not.
245 /// \return kTRUE if we already read all the digits and kFALSE if not.
251 Bool_t AliMUONRawStreamTriggerHP::Next(
252 UChar_t& id, UChar_t& dec, Bool_t& trigY,
253 UChar_t& yPos, UChar_t& sXDev, UChar_t& xDev,
254 UChar_t& xPos, Bool_t& triggerY, Bool_t& triggerX,
255 TArrayS& xPattern, TArrayS& yPattern
258 const AliLocalStruct* localStruct = Next();
259 if (localStruct == NULL) return kFALSE;
261 id = localStruct->GetId();
262 dec = localStruct->GetDec();
263 trigY = localStruct->GetTrigY();
264 yPos = localStruct->GetYPos();
265 sXDev = localStruct->GetSXDev();
266 xDev = localStruct->GetXDev();
267 xPos = localStruct->GetXPos();
269 triggerX = localStruct->GetTriggerX();
270 triggerY = localStruct->GetTriggerY();
272 localStruct->GetXPattern(xPattern);
273 localStruct->GetYPattern(yPattern);
279 AliMUONDDLTrigger* AliMUONRawStreamTriggerHP::GetDDLTrigger() const
281 /// Construct and return a pointer to the DDL payload object.
282 /// \return Pointer to internally constructed AliMUONDDLTrigger object.
283 /// The object is owned by this class and should not be deleted
286 /// \note This method should not be used just to gain access to the DDL
287 /// payload, unless there is a good reason to have the AliMUONDDLTrigger
288 /// object. For example, if you want to modify the data and then save it
289 /// to another DDL stream. Otherwise it can be an order of magnitude
290 /// faster to access the DDL headers and data with the GetHeaders,
291 /// GetRegionalHeader and GetLocalStruct methods for example.
292 /// Refer to the MUONRawStreamTrigger.C macro to see how to use the fast
293 /// decoder interface optimally.
295 if (fDDLObject != NULL) return fDDLObject;
297 fDDLObject = new AliMUONDDLTrigger;
299 // Copy over all DARC, global headers and scalars.
300 AliMUONDarcHeader* darcHeader = fDDLObject->GetDarcHeader();
301 const AliHeader* hdr = GetHeaders();
302 UInt_t word = hdr->GetDarcHeader();
303 memcpy(darcHeader->GetHeader(), &word, sizeof(word));
304 if (hdr->GetDarcScalars() != NULL)
306 memcpy(darcHeader->GetDarcScalers(), hdr->GetDarcScalars(), sizeof(AliMUONDarcScalarsStruct));
308 memcpy(darcHeader->GetGlobalInput(), hdr->GetGlobalHeader(), sizeof(AliMUONGlobalHeaderStruct));
309 if (hdr->GetGlobalScalars() != NULL)
311 memcpy(darcHeader->GetGlobalScalers(), hdr->GetGlobalScalars(), sizeof(AliMUONGlobalScalarsStruct));
314 for (Int_t iReg = 0; iReg < (Int_t)GetRegionalHeaderCount(); iReg++)
316 AliMUONRegHeader regHeader;
317 AliMUONLocalStruct localStruct;
319 const AliRegionalHeader* rh = GetRegionalHeader(iReg);
320 // Copy local structure and scalars and add everything into DDL object.
321 memcpy(regHeader.GetHeader(), rh->GetHeader(), sizeof(AliMUONRegionalHeaderStruct));
322 if (rh->GetScalars() != NULL)
324 memcpy(regHeader.GetScalers(), rh->GetScalars(), sizeof(AliMUONRegionalScalarsStruct));
326 fDDLObject->AddRegHeader(regHeader);
328 const AliLocalStruct* ls = rh->GetFirstLocalStruct();
331 // Copy local structure and scalars and add everything into DDL object.
332 memcpy(localStruct.GetData(), ls->GetData(), sizeof(AliMUONLocalInfoStruct));
333 if (ls->GetScalars() != NULL)
335 memcpy(localStruct.GetScalers(), ls->GetScalars(), sizeof(AliMUONLocalScalarsStruct));
337 fDDLObject->AddLocStruct(localStruct, iReg);
346 void AliMUONRawStreamTriggerHP::SetMaxRegAllowed(Int_t reg)
348 /// Set the maximum allowed number of regional cards in the DDL.
350 fDecoder.MaxRegionals( (UInt_t) reg );
352 fDecoder.GetHandler().SetMaxStructs(
353 fDecoder.MaxRegionals(),
359 void AliMUONRawStreamTriggerHP::SetMaxLoc(Int_t loc)
361 /// Sets the maximum number of local cards in the DDL.
363 fDecoder.MaxLocals( (UInt_t) loc );
365 fDecoder.GetHandler().SetMaxStructs(
366 fDecoder.MaxRegionals(),
371 ///////////////////////////////////////////////////////////////////////////////
373 void AliMUONRawStreamTriggerHP::AliHeader::Print() const
375 /// Print DARC header, global header and global scalars to screen.
377 cout << "===== DARC info =====" << endl;
378 cout << "Header bits : 0x" << hex << fDarcHeader << dec << endl;
379 if (fDarcScalars != NULL)
381 cout << "L0R : " << fDarcScalars->fL0R << " (0x"
382 << hex << fDarcScalars->fL0R << dec << ")" << endl;
383 cout << "L1P : " << fDarcScalars->fL1P << " (0x"
384 << hex << fDarcScalars->fL1P << dec << ")" << endl;
385 cout << "L1S : " << fDarcScalars->fL1S << " (0x"
386 << hex << fDarcScalars->fL1S << dec << ")" << endl;
387 cout << "L2A : " << fDarcScalars->fL2A << " (0x"
388 << hex << fDarcScalars->fL2A << dec << ")" << endl;
389 cout << "L2R : " << fDarcScalars->fL2R << " (0x"
390 << hex << fDarcScalars->fL2R << dec << ")" << endl;
391 cout << "Clock : " << fDarcScalars->fClk << " (0x"
392 << hex << fDarcScalars->fClk << dec << ")" << endl;
393 cout << "Hold : " << fDarcScalars->fHold << " (0x"
394 << hex << fDarcScalars->fHold << dec << ")" << endl;
395 cout << "Spare : " << fDarcScalars->fSpare << " (0x"
396 << hex << fDarcScalars->fSpare << dec << ")" << endl;
400 cout << "Scalars == NULL" << endl;
403 cout << "===== Global info =====" << endl;
404 for (int i = 0; i < 4; i++)
406 cout << "Input[" << i << "] : " << fGlobalHeader->fInput[i] << " (0x"
407 << hex << fGlobalHeader->fInput[i] << dec << ")" << endl;
409 cout << "Output : " << fGlobalHeader->fOutput << " (0x"
410 << hex << fGlobalHeader->fOutput << dec << ")" << endl;
411 if (fGlobalScalars != NULL)
413 cout << "L0 : " << fGlobalScalars->fL0 << " (0x"
414 << hex << fGlobalScalars->fL0 << dec << ")" << endl;
415 cout << "Clock : " << fGlobalScalars->fClk << " (0x"
416 << hex << fGlobalScalars->fClk << dec << ")" << endl;
417 for (int j = 0; j < 4; j++)
419 cout << "Scaler[" << j << "] : " << fGlobalScalars->fScaler[j] << " (0x"
420 << hex << fGlobalScalars->fScaler[j] << dec << ")" << endl;
422 cout << "Hold : " << fGlobalScalars->fHold << " (0x"
423 << hex << fGlobalScalars->fHold << dec << ")" << endl;
424 cout << "Spare : " << fGlobalScalars->fSpare << " (0x"
425 << hex << fGlobalScalars->fSpare << dec << ")" << endl;
429 cout << "Scalars == NULL" << endl;
433 void AliMUONRawStreamTriggerHP::AliRegionalHeader::Print() const
435 /// Print the regional header and scalars to screen.
437 cout << "===== Regional card info =====" << endl;
438 cout << "DarcWord : " << fHeader->fDarcWord << " (0x"
439 << hex << fHeader->fDarcWord << dec << ")" << endl;
440 cout << "Word : " << fHeader->fWord << " (0x"
441 << hex << fHeader->fWord << dec << ")" << endl;
442 cout << "Input[0] : " << fHeader->fInput[0] << " (0x"
443 << hex << fHeader->fInput[0] << dec << ")" << endl;
444 cout << "Input[1] : " << fHeader->fInput[1] << " (0x"
445 << hex << fHeader->fInput[1] << dec << ")" << endl;
446 cout << "L0/Mask : " << fHeader->fL0CountAndMask << " (0x"
447 << hex << fHeader->fL0CountAndMask << dec << ")" << endl;
448 if (fScalars != NULL)
450 cout << "Clock : " << fScalars->fClk << " (0x"
451 << hex << fScalars->fClk << dec << ")" << endl;
452 for (int i = 0; i < 8; i++)
454 cout << "Scaler[" << i << "] : " << fScalars->fScaler[i] << " (0x"
455 << hex << fScalars->fScaler[i] << dec << ")" << endl;
457 cout << "Hold : " << fScalars->fHold << " (0x"
458 << hex << fScalars->fHold << dec << ")" << endl;
462 cout << "Scalars == NULL" << endl;
466 void AliMUONRawStreamTriggerHP::AliLocalStruct::Print() const
468 /// Print local trigger structure and scalars to screen.
470 cout << "===== Local card info =====" << endl;
471 cout << "X2X1 : " << fLocalStruct->fX2X1 << " (0x"
472 << hex << fLocalStruct->fX2X1 << dec << ")" << endl;
473 cout << "X4X3 : " << fLocalStruct->fX4X3 << " (0x"
474 << hex << fLocalStruct->fX4X3 << dec << ")" << endl;
475 cout << "Y2Y1 : " << fLocalStruct->fY2Y1 << " (0x"
476 << hex << fLocalStruct->fY2Y1 << dec << ")" << endl;
477 cout << "Y4Y3 : " << fLocalStruct->fY4Y3 << " (0x"
478 << hex << fLocalStruct->fY4Y3 << dec << ")" << endl;
479 cout << "Trigger bits : " << fLocalStruct->fTriggerBits << " (0x"
480 << hex << fLocalStruct->fTriggerBits << dec << ")" << endl;
481 if (fScalars != NULL)
483 cout << "L0 : " << fScalars->fL0 << " (0x"
484 << hex << fScalars->fL0 << dec << ")" << endl;
485 cout << "Hold : " << fScalars->fHold << " (0x"
486 << hex << fScalars->fHold << dec << ")" << endl;
487 cout << "Clock : " << fScalars->fClk << " (0x"
488 << hex << fScalars->fClk << dec << ")" << endl;
489 cout << "LPtNTrig : " << fScalars->fLPtNTrig << " (0x"
490 << hex << fScalars->fLPtNTrig << dec << ")" << endl;
491 cout << "HPtNTrig : " << fScalars->fHPtNTrig << " (0x"
492 << hex << fScalars->fHPtNTrig << dec << ")" << endl;
493 cout << "LPtRTrig : " << fScalars->fLPtRTrig << " (0x"
494 << hex << fScalars->fLPtRTrig << dec << ")" << endl;
495 cout << "HPtRTrig : " << fScalars->fHPtRTrig << " (0x"
496 << hex << fScalars->fHPtRTrig << dec << ")" << endl;
497 cout << "LPtLTrig : " << fScalars->fLPtLTrig << " (0x"
498 << hex << fScalars->fLPtLTrig << dec << ")" << endl;
499 cout << "HPtLTrig : " << fScalars->fHPtLTrig << " (0x"
500 << hex << fScalars->fHPtLTrig << dec << ")" << endl;
501 cout << "LPtSTrig : " << fScalars->fLPtSTrig << " (0x"
502 << hex << fScalars->fLPtSTrig << dec << ")" << endl;
503 cout << "HPtSTrig : " << fScalars->fHPtSTrig << " (0x"
504 << hex << fScalars->fHPtSTrig << dec << ")" << endl;
505 for (int i = 0; i < 8*4; i++)
507 cout << "Scaler[" << i << "] : " << fScalars->fScaler[i] << " (0x"
508 << hex << fScalars->fScaler[i] << dec << ")" << endl;
510 cout << "EOS : " << fScalars->fEOS << " (0x"
511 << hex << fScalars->fEOS << dec << ")" << endl;
512 cout << "Reset : " << fScalars->fReset << " (0x"
513 << hex << fScalars->fReset << dec << ")" << endl;
517 cout << "Scalars == NULL" << endl;
521 ///////////////////////////////////////////////////////////////////////////////
523 AliMUONRawStreamTriggerHP::AliDecoderEventHandler::AliDecoderEventHandler() :
533 fCurrentRegional(NULL),
541 /// Default constructor
545 AliMUONRawStreamTriggerHP::AliDecoderEventHandler::~AliDecoderEventHandler()
547 /// Default destructor cleans up the allocated memory.
549 if (fRegionals != NULL) delete [] fRegionals;
550 if (fLocals != NULL) delete [] fLocals;
554 void AliMUONRawStreamTriggerHP::AliDecoderEventHandler::SetMaxStructs(
555 UInt_t maxRegionals, UInt_t maxLocals
558 /// Sets the maximum number of structures allowed.
560 // Start by clearing the current arrays.
561 if (fRegionals != NULL)
563 delete [] fRegionals;
572 fCurrentRegional = NULL;
573 fCurrentLocal = NULL;
575 // Allocate new memory.
576 fRegionals = new AliRegionalHeader[maxRegionals];
577 fLocals = new AliLocalStruct[maxRegionals*maxLocals];
578 fEndOfLocals = fLocals;
582 void AliMUONRawStreamTriggerHP::AliDecoderEventHandler::OnNewBuffer(
583 const void* buffer, UInt_t /*bufferSize*/
586 /// This is called by the high performance decoder when a new DDL payload
587 /// is about to be decoded.
589 assert( fRawStream != NULL );
591 // remember the start of the buffer to be used in OnError.
592 fBufferStart = buffer;
594 // Reset error counters.
596 fGlobalEoWErrors = 0;
600 // Reset the current pointers which will be used to track where we need to
601 // fill fRegionals and fLocals. We have to subtract one space because we
602 // will increment the pointer the first time in the OnNewRegionalStruct
603 // and OnLocalStruct methods.
604 fCurrentRegional = fRegionals-1;
605 fCurrentLocal = fLocals-1;
610 void AliMUONRawStreamTriggerHP::AliDecoderEventHandler::OnError(
611 ErrorCode error, const void* location
614 /// This is called by the high performance decoder when a error occurs
615 /// when trying to decode the DDL payload. This indicates corruption in
616 /// the data. This method converts the error code to a descriptive message
617 /// and logs this with the raw reader.
618 /// \param error The error code indicating the problem.
619 /// \param location A pointer to the location within the DDL payload buffer
620 /// being decoded where the problem with the data was found.
622 assert( fRawStream != NULL );
623 assert( fRawStream->GetReader() != NULL );
625 Char_t* message = NULL;
630 case kWrongEventType:
631 message = Form("Wrong event type obtained from the Darc header, take the one of CDH");
637 "Wrong end of Darc word %x instead of %x\n",
638 *reinterpret_cast<const UInt_t*>(location),
639 AliMUONTriggerDDLDecoder<AliMUONTriggerDDLDecoderEventHandler>::EndOfDarcWord()
641 fRawStream->GetReader()->AddMajorErrorLog(kDarcEoWErr, message);
644 case kBadEndOfGlobal:
647 "Wrong end of Global word %x instead of %x\n",
648 *reinterpret_cast<const UInt_t*>(location),
649 AliMUONTriggerDDLDecoder<AliMUONTriggerDDLDecoderEventHandler>::EndOfGlobalWord()
651 fRawStream->GetReader()->AddMajorErrorLog(kGlobalEoWErr, message);
654 case kBadEndOfRegional:
657 "Wrong end of Regional word %x instead of %x\n",
658 *reinterpret_cast<const UInt_t*>(location),
659 AliMUONTriggerDDLDecoder<AliMUONTriggerDDLDecoderEventHandler>::EndOfRegionalWord()
661 fRawStream->GetReader()->AddMajorErrorLog(kRegEoWErr, message);
667 "Wrong end of Local word %x instead of %x\n",
668 *reinterpret_cast<const UInt_t*>(location),
669 AliMUONTriggerDDLDecoder<AliMUONTriggerDDLDecoderEventHandler>::EndOfLocalWord()
671 fRawStream->GetReader()->AddMajorErrorLog(kLocalEoWErr, message);
676 "%s (At byte %d in DDL.)",
677 ErrorCodeToMessage(error),
678 (unsigned long)location - (unsigned long)fBufferStart + sizeof(AliRawDataHeader)
680 fRawStream->GetReader()->AddMajorErrorLog(error, message);
687 "AliMUONRawStreamTriggerHP::AliDecoderEventHandler",