HLT/BASE/AliHLTOUT.h

   1 //-*- Mode: C++ -*-
   2 // @(#) $Id$
   3
   4 #ifndef ALIHLTOUT_H
   5 #define ALIHLTOUT_H
   6 //* This file is property of and copyright by the ALICE HLT Project        *
   7 //* ALICE Experiment at CERN, All rights reserved.                         *
   8 //* See cxx source for full Copyright notice                               *
   9
  10 /** @file   AliHLTOUT.h
  11     @author Matthias Richter
  12     @date
  13     @brief  The control class for HLTOUT data.
  14 */
  15
  16 #include <vector>
  17 #include "AliHLTLogging.h"
  18 #include "AliHLTModuleAgent.h"
  19
  20 class AliHLTOUTHandler;
  21 class AliHLTOUTHandlerDesc; // AliHLTModuleAgent.h
  22
  23 #define AliHLTOUTInvalidIndex (~(AliHLTUInt32_t)0)
  24
  25 typedef vector<AliHLTUInt32_t> AliHLTOUTIndexList;
  26
  27 /**
  28  * @class AliHLTOUT
  29  * The control class for HLTOUT data.
  30  * The output of the HLT, either from the HLTOUT nodes or simulated output,
  31  * is transferred and stored in the HOMER format. The AliHLTOUT class
  32  * implements scanning of the HOMER data for all HLTOUT DDL links and
  33  * abstracts access to the complete HLTOUT data.
  34  *
  35  */
  36 class AliHLTOUT : public AliHLTLogging {
  37  public:
  38   /** standard constructor */
  39   AliHLTOUT();
  40   /** standard destructor */
  41   virtual ~AliHLTOUT();
  42
  43   /**
  44    * Init for processing.
  45    * The HLTOUT is scanned for all available data blocks and the
  46    * AliHLTOUTHandler objects for the data blocks are created according
  47    * to the module agents (see AliHLTModuleAgent).
  48    */
  49   int Init();
  50
  51   /**
  52    * Get number of data blocks in the HLTOUT data
  53    */
  54   int GetNofDataBlocks();
  55
  56   /**
  57    * Select the first data block of a certain data type and specification.
  58    * The selection criteria can be of kAliHLTAnyDataType and/or
  59    * kAliHLTVoidDataSpec in order to be ignored and just match any data block.
  60    *
  61    * The search criteria can be combined with a handler type (e.g. kRawReader)
  62    * @param dt    [in]  data type to match                                <br>
  63    * @param spec  [in]  data specification to match                       <br>
  64    * @param handlerType [in]  type of the handler
  65    * @return identifier >0 if success, 0 if no block found                <br>
  66    *         neg. error code if failed                                    <br>
  67    *                        -EPERM if access denied (object locked)
  68    */
  69   int SelectFirstDataBlock(AliHLTComponentDataType dt=kAliHLTAnyDataType,
  70                            AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
  71                            AliHLTModuleAgent::AliHLTOUTHandlerType handlerType=AliHLTModuleAgent::kUnknownOutput);
  72
  73   /**
  74    * Select the next data block of data type and specification of the previous
  75    * call to @ref SelectFirstDataBlock.
  76    * @return identifier >0 if success, 0 if no block found                <br>
  77    *         neg. error code if failed                                    <br>
  78    *                        -EPERM if access denied (object locked)
  79    */
  80   int SelectNextDataBlock();
  81
  82   /**
  83    * Get properties of the selected data block.
  84    * @param dt    [out] data type of the selected block
  85    * @param spec  [out] data specification of the selected block
  86    */
  87   int GetDataBlockDescription(AliHLTComponentDataType& dt, AliHLTUInt32_t& spec);
  88
  89   /**
  90    * Get the index of the current data block.
  91    * @return index, AliHLTOUTInvalidIndex if no block selected
  92    */
  93   AliHLTUInt32_t GetDataBlockIndex();
  94
  95   /**
  96    * Get buffer of the selected data block.
  97    * @param pBuffer [out] buffer of the selected data block
  98    * @param size    [out] size of the selected data block
  99    */
 100   int GetDataBuffer(const AliHLTUInt8_t* &pBuffer, AliHLTUInt32_t& size);
 101
 102   /**
 103    * Release buffer after use.
 104    * @param pBuffer [in]  buffer of the selected data block
 105    */
 106   int ReleaseDataBuffer(const AliHLTUInt8_t* pBuffer);
 107
 108   /**
 109    * Get handler for the selected data block.
 110    */
 111   AliHLTOUTHandler* GetHandler();
 112
 113   /**
 114    * Locking guard for the AliHLTOUT object.
 115    * If the object is locked, the selection of data blocks can not be changed.
 116    */
 117   class AliHLTOUTLockGuard {
 118   public:
 119     /** constructor */
 120     AliHLTOUTLockGuard(AliHLTOUT* pInstance) : fpInstance(pInstance)
 121     {if (fpInstance) fpInstance->SetStatusFlag(kLocked);}
 122     /** destructor */
 123     ~AliHLTOUTLockGuard()
 124     {if (fpInstance) fpInstance->ClearStatusFlag(kLocked);}
 125
 126   private:
 127     /** standard constructor prohibited */
 128     AliHLTOUTLockGuard();
 129     /** copy constructor prohibited */
 130     AliHLTOUTLockGuard(const AliHLTOUTLockGuard&);
 131     /** assignment operator prohibited */
 132     AliHLTOUTLockGuard& operator=(const AliHLTOUTLockGuard&);
 133
 134     /** the AliHLTOUT instance the guard is locking */
 135     AliHLTOUT* fpInstance; //!transient
 136   };
 137
 138   /**
 139    * The HLT OUT Event Header.
 140    * Defined between HLT and DAQ.
 141    */
 142   struct AliHLTOUTEventHeader {
 143     /**Total length of the data in bytes, including HLT event header, excluding CDH. */
 144     AliHLTUInt32_t fLength; //! see above
 145     /** version of the header */
 146     AliHLTUInt32_t fVersion; //! see above
 147     /** event id */
 148     AliHLTUInt64_t fEventID; //! see above
 149   };
 150
 151   // definitions from ALICE internal notes ALICE-INT-2002-010 and
 152   // ALICE-INT-2006-XXX
 153   /** the 32bit word in the CDH containing the status flags */
 154   static const unsigned char fgkCDHStatusWord; //! see above
 155   /** start of the flags in word fgkCDHStatusWord */
 156   static const unsigned char fgkCDHStatusFlagsOffset; //! see above
 157   /** bit indicating HLT decision in the HLTOUT*/
 158   static const unsigned char fgkCDHFlagsHLTDecision; //! see above
 159   /** bit indicating HLT payload in the HLTOUT*/
 160   static const unsigned char fgkCDHFlagsHLTPayload; //! see above
 161
 162   /**
 163    * Block descriptor.
 164    */
 165   class AliHLTOUTBlockDescriptor {
 166   public:
 167     AliHLTOUTBlockDescriptor(AliHLTComponentDataType dt, AliHLTUInt32_t spec, AliHLTUInt32_t index)
 168       : fDataType(dt), fSpecification(spec), fIndex(index) {};
 169     ~AliHLTOUTBlockDescriptor() {}
 170
 171     operator AliHLTComponentDataType() const {return fDataType;}
 172     operator AliHLTUInt32_t() const {return fSpecification;}
 173     int operator==(AliHLTComponentDataType dt) const {return dt==fDataType;}
 174     int operator==(AliHLTUInt32_t spec) const {return spec==fSpecification;}
 175
 176     AliHLTUInt32_t GetIndex() const {return fIndex;}
 177   private:
 178     /** data type of the block */
 179     AliHLTComponentDataType fDataType; //!transient
 180     /** data specification of the block */
 181     AliHLTUInt32_t          fSpecification; //!transient
 182     /** index in the data stream */
 183     AliHLTUInt32_t          fIndex; //!transient
 184   };
 185
 186   enum AliHLTOUTByteOrder_t {
 187     /** no data block selected */
 188     kInvalidByteOrder=-1,
 189     kUnknownByteOrder=0,
 190     kLittleEndian,
 191     kBigEndian
 192   };
 193
 194   enum AliHLTOUTDataType_t {
 195     kUint64 = 0,
 196     kUint32 = 1,
 197     kUint16 = 2,
 198     kUint8  = 3,
 199     kDouble = 4,
 200     kFloat  = 5
 201   };
 202
 203   /**
 204    * Check byte order of selected block
 205    */
 206   AliHLTOUTByteOrder_t CheckByteOrder();
 207
 208   /**
 209    * Check alignment of selected block
 210    */
 211   int CheckAlignment(AliHLTOUT::AliHLTOUTDataType_t type);
 212
 213  protected:
 214   /**
 215    * Add a block descriptor.
 216    * This is done by the child classes generating the index. The AliHLTOUT
 217    * object must be locked for index generation.
 218    * @param desc    the block descriptor
 219    * @return 0 if success, -EPERM if access denied
 220    */
 221   int AddBlockDescriptor(const AliHLTOUTBlockDescriptor desc);
 222
 223  private:
 224   /** copy constructor prohibited */
 225   AliHLTOUT(const AliHLTOUT&);
 226   /** assignment operator prohibited */
 227   AliHLTOUT& operator=(const AliHLTOUT&);
 228
 229   /**
 230    * Internal status flags
 231    */
 232   enum {
 233     /** the HLTOUT object is locked with the current data block */
 234     kLocked = 0x1,
 235     /** childs can add block descriptors */
 236     kCollecting = 0x2,
 237     /** user of the data block has checked the byte order */
 238     kByteOrderChecked = 0x4,
 239     /** warning on byte order missmatch has been printed */
 240     kByteOrderWarning = 0x8,
 241     /** user of the data block has checked the alignment */
 242     kAlignmentChecked = 0x10,
 243     /** warning on alignment missmatch has been printed */
 244     kAlignmentWarning = 0x20
 245   };
 246
 247   class AliHLTOUTHandlerListEntry {
 248   public:
 249     AliHLTOUTHandlerListEntry(AliHLTOUTHandler* pHandler,
 250                               AliHLTModuleAgent::AliHLTOUTHandlerDesc& handlerDesc,
 251                               AliHLTModuleAgent* pAgent,
 252                               AliHLTUInt32_t index);
 253
 254     /** copy constructor for vector handling */
 255     AliHLTOUTHandlerListEntry(const AliHLTOUTHandlerListEntry& src);
 256
 257     /** assignment operator for vector handling */
 258     AliHLTOUTHandlerListEntry& operator=(const AliHLTOUTHandlerListEntry& src);
 259
 260     ~AliHLTOUTHandlerListEntry();
 261
 262     static const AliHLTOUTHandlerListEntry fgkVoidHandlerListEntry;
 263
 264     operator AliHLTOUTHandler*() const {return fpHandler;}
 265     operator AliHLTModuleAgent::AliHLTOUTHandlerDesc&() {return *fpHandlerDesc;}
 266     operator AliHLTModuleAgent*() const {return fpAgent;}
 267
 268     /**
 269      * Two list entries are considered to be equal if the handlers
 270      * are equal.
 271      */
 272     bool operator==(const AliHLTOUTHandlerListEntry& entry) const;
 273
 274     AliHLTUInt32_t operator[](int i) const;
 275
 276     /**
 277      * Add a block index to this descriptor.
 278      * One descriptor can serve multiple blocks if the agent returns the
 279      * same handler for all of the blocks. Instead of creating a new entry
 280      * the block index ist just added
 281      */
 282     void AddIndex(AliHLTUInt32_t index);
 283
 284     /**
 285      * Add all indexes of the descriptor.
 286      */
 287     void AddIndex(AliHLTOUTHandlerListEntry &desc);
 288
 289     /**
 290      * Check if an index is served by this descriptor.
 291      * @return true if the index is in the table
 292      */
 293     bool HasIndex(AliHLTUInt32_t index);
 294
 295   private:
 296     /** standard constructor prohibited */
 297     AliHLTOUTHandlerListEntry();
 298
 299     /** pointer to the handler */
 300     AliHLTOUTHandler* fpHandler; //! transient
 301
 302     /** pointer to handler description */
 303     AliHLTModuleAgent::AliHLTOUTHandlerDesc* fpHandlerDesc; //! transient
 304
 305     /** pointer to module agent */
 306     AliHLTModuleAgent* fpAgent; //! transient
 307
 308     /** list of block indexes */
 309     AliHLTOUTIndexList fBlocks; //!transient
 310   };
 311
 312   /**
 313    * Generate the index of the HLTOUT data.
 314    * Must be implemented by the child classes.
 315    */
 316   virtual int GenerateIndex()=0;
 317
 318   /**
 319    * Find AliHLTOUTHandler objects for the data blocks.
 320    * The available AliHLTModuleAgents are probed whether they provide
 321    * handlers for data processing.
 322    */
 323   int InitHandlers();
 324
 325   /**
 326    * Get the data buffer
 327    * @param index   [in]  index of the block
 328    * @param pBuffer [out] buffer of the selected data block
 329    * @param size    [out] size of the selected data block
 330    */
 331   virtual int GetDataBuffer(AliHLTUInt32_t index, const AliHLTUInt8_t* &pBuffer,
 332                             AliHLTUInt32_t& size)=0;
 333
 334   /**
 335    * Check byte order of data block
 336    */
 337   virtual AliHLTOUTByteOrder_t CheckBlockByteOrder(AliHLTUInt32_t index)=0;
 338
 339   /**
 340    * Check alignment of data block
 341    */
 342   virtual int CheckBlockAlignment(AliHLTUInt32_t index, AliHLTOUT::AliHLTOUTDataType_t type)=0;
 343
 344   /**
 345    * Select the data block of data type and specification of the previous
 346    * call to @ref SelectFirstDataBlock. Core function of @ref SelectFirstDataBlock
 347    * and @ref SelectNextDataBlock, starts to find a block at the current list
 348    * position.
 349    * @return identifier >=0 if success, neg. error code if failed         <br>
 350    *                        -ENOENT if no block found                     <br>
 351    *                        -EPERM if access denied (object locked)
 352    */
 353   int FindAndSelectDataBlock();
 354
 355   /**
 356    * Set status flag.
 357    * @param flag     flag to set
 358    * @return current status flags
 359    */
 360   unsigned int SetStatusFlag(unsigned int flag) {return fFlags|=flag;}
 361
 362   /**
 363    * Clear status flag.
 364    * @param flag     flag to clear
 365    * @return current status flags
 366    */
 367   unsigned int ClearStatusFlag(unsigned int flag) {return fFlags&=~flag;}
 368
 369   /**
 370    * Check status flag.
 371    * @param flag     flag to check
 372    * @return 1 if flag is set
 373    */
 374   int CheckStatusFlag(unsigned int flag) const {return (fFlags&flag)==flag;}
 375
 376   /**
 377    * Insert a handler item.
 378    * The current list entries are checked if the handler is already in
 379    * the list. It is added if not in the list, otherwise the block index
 380    * is added to the existing entry.
 381    * @param entry    handler list entry
 382    * @return 0 if added, EEXIST (non negative!) if merged with existing entry <br>
 383    *         neg. error code if failed
 384    */
 385   int InsertHandler(const AliHLTOUTHandlerListEntry &entry);
 386
 387   /**
 388    * Find handler description for a certain block index.
 389    */
 390   AliHLTOUTHandlerListEntry FindHandlerDesc(AliHLTUInt32_t blockIndex);
 391
 392   /** data type for the current block search, set from @ref SelectFirstDataBlock */
 393   AliHLTComponentDataType fSearchDataType; //!transient
 394
 395   /** data specification for the current block search */
 396   AliHLTUInt32_t fSearchSpecification; //!transient
 397
 398   /** instance flags: locked, collecting, ... */
 399   unsigned int fFlags; //!transient
 400
 401   /** list of block descriptors */
 402   vector<AliHLTOUTBlockDescriptor> fBlockDescList; //!transient
 403
 404   /** current position in the list */
 405   vector<AliHLTOUTBlockDescriptor>::iterator fCurrent; //!transient
 406
 407   /** data buffer under processing */
 408   const AliHLTUInt8_t* fpBuffer; //!transient
 409
 410   /** list of AliHLTOUTHandlers */
 411   vector<AliHLTOUTHandlerListEntry> fDataHandlers; // !transient
 412
 413   ClassDef(AliHLTOUT, 1)
 414 };
 415 #endif