3 #ifndef ALIHLTDATATYPES_H
4 #define ALIHLTDATATYPES_H
5 /* This file is property of and copyright by the ALICE HLT Project *
6 * ALICE Experiment at CERN, All rights reserved. *
7 * See cxx source for full Copyright notice */
9 /** @file AliHLTDataTypes.h
10 @author Matthias Richter, Timm Steinbeck, Jochen Thaeder
12 @brief Data type declaration for the HLT module.
15 //////////////////////////////////////////////////////////////////////////
17 // version no of HLT data types
19 //////////////////////////////////////////////////////////////////////////
21 /* Version Description
22 * 1 first version until June 07; implicite, not tagged
23 * 2 introduced June 07, enhanced/cleaned/arranged structure
25 #define ALIHLT_DATA_TYPES_VERSION 2
27 //////////////////////////////////////////////////////////////////////////
29 // HLT data origin defines
31 //////////////////////////////////////////////////////////////////////////
33 /** field size of datat type origin */
34 const int kAliHLTComponentDataTypefOriginSize=4;
37 /** invalid data origin */
38 # define kAliHLTVoidDataOrigin "\0\0\0"
40 /** special id for any data type origin */
41 # define kAliHLTAnyDataOrigin "***"
44 # define kAliHLTDataOriginOut {'H','L','T',' '}
46 /** HLT/PubSub private internal */
47 # define kAliHLTDataOriginPrivate {'P','R','I','V'}
50 # define kAliHLTDataOriginTPC {'T','P','C',' '}
53 # define kAliHLTDataOriginPHOS {'P','H','O','S'}
56 # define kAliHLTDataOriginMUON {'M','U','O','N'}
59 # define kAliHLTDataOriginTRD {'T','R','D',' '}
62 # define kAliHLTDataOriginITS {'I','T','S',' '}
64 //////////////////////////////////////////////////////////////////////////
66 // HLT common data type defines
68 //////////////////////////////////////////////////////////////////////////
70 /** field size of data type id */
71 const int kAliHLTComponentDataTypefIDsize=8;
74 /** invalid data type id */
75 # define kAliHLTVoidDataTypeID "\0\0\0\0\0\0\0"
77 /** special id for any data type id */
78 # define kAliHLTAnyDataTypeID "*******"
80 /** calibration data for file exchange subscriber */
81 # define kAliHLTFXSCalibDataTypeID {'F','X','S','_','C','A','L',' '}
83 /** start of run (SOR) event
86 # define kAliHLTSORDataTypeID {'S','T','A','R','T','O','F','R'}
88 /** end of run (EOR) event
91 # define kAliHLTEORDataTypeID {'E','N','D','O','F','R','U','N'}
96 # define kAliHLTDDLDataTypeID {'D','D','L','L','I','S','T',' '}
99 * - empty payload, specification gives eventType
101 # define kAliHLTEventDataTypeID {'E','V','E','N','T','T','Y','P'}
106 //////////////////////////////////////////////////////////////////////////
108 // Basic HLT data types
110 //////////////////////////////////////////////////////////////////////////
112 typedef unsigned char AliHLTUInt8_t;
114 typedef unsigned short AliHLTUInt16_t;
116 typedef unsigned int AliHLTUInt32_t;
118 typedef unsigned long long AliHLTUInt64_t;
120 typedef AliHLTUInt64_t AliHLTEventID_t;
122 //////////////////////////////////////////////////////////////////////////
124 // HLT logging levels
126 //////////////////////////////////////////////////////////////////////////
128 enum AliHLTComponentLogSeverity {
130 kHLTLogBenchmark = 0x1,
133 kHLTLogWarning = 0x8,
137 kHLTLogDefault = 0x3d
140 //////////////////////////////////////////////////////////////////////////
142 // HLT data structures for data exchange and external interface
144 //////////////////////////////////////////////////////////////////////////
147 * @struct AliHLTComponentEventData
150 struct AliHLTComponentEventData
152 AliHLTUInt32_t fStructSize;
153 AliHLTEventID_t fEventID;
154 AliHLTUInt32_t fEventCreation_s;
155 AliHLTUInt32_t fEventCreation_us;
156 AliHLTUInt32_t fBlockCnt;
160 * @struct AliHLTComponentShmData
161 * Shared memory descriptor.
162 * Irrelevant for analysis components.
164 struct AliHLTComponentShmData
166 AliHLTUInt32_t fStructSize;
167 AliHLTUInt32_t fShmType;
168 AliHLTUInt64_t fShmID;
172 * @struct AliHLTComponentDataType
173 * Data type descriptor for data blocks transferred through the processing
176 struct AliHLTComponentDataType
178 AliHLTUInt32_t fStructSize;
179 char fID[kAliHLTComponentDataTypefIDsize]; //!
180 char fOrigin[kAliHLTComponentDataTypefOriginSize]; //!
184 * @struct AliHLTComponentBlockData
185 * Descriptor for data blocks.
187 struct AliHLTComponentBlockData
189 AliHLTUInt32_t fStructSize;
190 AliHLTComponentShmData fShmKey;
191 AliHLTUInt32_t fOffset;
193 AliHLTUInt32_t fSize;
194 AliHLTComponentDataType fDataType;
195 AliHLTUInt32_t fSpecification;
199 * @struct AliHLTComponentTriggerData
200 * Trigger data, not yet defined
202 struct AliHLTComponentTriggerData
204 AliHLTUInt32_t fStructSize;
205 AliHLTUInt32_t fDataSize;
210 * @struct AliHLTComponentEventDoneData
213 struct AliHLTComponentEventDoneData
215 AliHLTUInt32_t fStructSize;
216 AliHLTUInt32_t fDataSize;
221 * @struct AliHLTRunDesc
223 * The struct is send with the SOR and EOR events.
227 AliHLTUInt32_t fStructSize;
228 AliHLTUInt32_t fRunNo;
229 AliHLTUInt32_t fRunType;
232 /** size of the DDL list */
233 static const int gkAliHLTDDLListSize = 29;
236 * @struct AliHLTEventDDL
238 * The struct is send with the DDLLIST event.
240 struct AliHLTEventDDL
242 AliHLTUInt32_t fCount;
243 AliHLTUInt32_t fList[gkAliHLTDDLListSize];
246 //////////////////////////////////////////////////////////////////////////
248 // HLT Event Type Specification
250 //////////////////////////////////////////////////////////////////////////
252 /** Unknown eventType specification */
253 static const AliHLTUInt32_t gkAliEventTypeUnknown = ~(AliHLTUInt32_t)0;
254 /** SOR eventType specification */
255 static const AliHLTUInt32_t gkAliEventTypeStartOfRun=1;
256 /** Data eventType specification */
257 static const AliHLTUInt32_t gkAliEventTypeData=2;
258 /** EOR eventType specification */
259 static const AliHLTUInt32_t gkAliEventTypeEndOfRun=4;
260 /** Corrupt eventType specification */
261 static const AliHLTUInt32_t gkAliEventTypeCorruptID=8;
262 /** Calibration eventType specification */
263 static const AliHLTUInt32_t gkAliEventTypeCalibration=16;
264 /** DataReplay eventType specification */
265 static const AliHLTUInt32_t gkAliEventTypeDataReplay=32;
266 /** Tick eventType specification */
267 static const AliHLTUInt32_t gkAliEventTypeTick=64;
268 /** Max eventType specification */
269 static const AliHLTUInt32_t gkAliEventTypeMax=64;
271 //////////////////////////////////////////////////////////////////////////
273 // HLT defines and defaults
275 //////////////////////////////////////////////////////////////////////////
277 /** invalid event id */
278 const AliHLTEventID_t kAliHLTVoidEventID=~(AliHLTEventID_t)0;
280 /** invalid data specification */
281 const AliHLTUInt32_t kAliHLTVoidDataSpec = ~(AliHLTUInt32_t)0;
283 /** invalid shared memory type */
284 const AliHLTUInt32_t gkAliHLTComponentInvalidShmType = 0;
286 /** invalid shared memory id */
287 const AliHLTUInt64_t gkAliHLTComponentInvalidShmID = ~(AliHLTUInt64_t)0;
289 /** invalid data type */
290 const AliHLTComponentDataType kAliHLTVoidDataType = {
291 sizeof(AliHLTComponentDataType),
292 kAliHLTVoidDataTypeID,
293 kAliHLTVoidDataOrigin
296 // there is currently a problem with rootcint if the predefined ids
297 // (commented below) are used. rootcint does not find the id if they
298 // are char arrays defined with {} and individual chars. If strings
299 // are used it works fine
301 const AliHLTComponentDataType kAliHLTAnyDataType = {
302 sizeof(AliHLTComponentDataType),
303 kAliHLTAnyDataTypeID,
307 /** multiple output data types */
308 extern const AliHLTComponentDataType kAliHLTMultipleDataType;
310 /** data to file exchange subscriber */
311 extern const AliHLTComponentDataType kAliHLTDataTypeFXSCalib;
313 /** DDL list data type */
314 extern const AliHLTComponentDataType kAliHLTDataTypeDDL;
317 extern const AliHLTComponentDataType kAliHLTDataTypeSOR;
320 extern const AliHLTComponentDataType kAliHLTDataTypeEOR;
322 /** Event type specification */
323 extern const AliHLTComponentDataType kAliHLTDataTypeEvent;
325 //////////////////////////////////////////////////////////////////////////
327 // FXS subscriber meta information
329 //////////////////////////////////////////////////////////////////////////
331 static const int gkAliHLTFXSHeaderfOriginSize = 4;
332 static const int gkAliHLTFXSHeaderfFileIDSize = 128;
333 static const int gkAliHLTFXSHeaderfDDLNumberSize = 64;
335 /** Header in front of the data payload, in order to sent data to the FXS. */
336 struct AliHLTFXSHeader
338 AliHLTUInt32_t fHeaderVersion;
339 AliHLTUInt32_t fRunNumber;
340 char fOrigin[gkAliHLTFXSHeaderfOriginSize];
341 char fFileID[gkAliHLTFXSHeaderfFileIDSize];
342 char fDDLNumber[gkAliHLTFXSHeaderfDDLNumberSize];
345 //////////////////////////////////////////////////////////////////////////
347 // Component running environment
349 //////////////////////////////////////////////////////////////////////////
351 /** logging function */
352 typedef int (*AliHLTfctLogging)( void* param,
353 AliHLTComponentLogSeverity severity,
356 const char* message);
359 * @struct AliHLTComponentEnvironment
360 * Running environment for analysis components.
361 * The struct describes function callbacks for
363 struct AliHLTComponentEnvironment
365 AliHLTUInt32_t fStructSize;
367 void* (*fAllocMemoryFunc)( void* param, unsigned long size );
369 // future addition already foreseen/envisioned
370 // IMPORTANT: don not just remove the defines as this breaks the binary
372 int (*fAllocShmMemoryFunc)( void* param, unsigned long size, AliHLTComponentBlockData* blockLocation );
374 int (*fGetEventDoneDataFunc)( void* param, AliHLTEventID_t eventID, unsigned long size, AliHLTComponentEventDoneData** edd );
375 AliHLTfctLogging fLoggingFunc;
379 //////////////////////////////////////////////////////////////////////////
381 // Data type helper functions
383 //////////////////////////////////////////////////////////////////////////
385 inline bool operator==( const AliHLTComponentDataType& dt1, const AliHLTComponentDataType& dt2 )
387 for ( int i = 0; i < kAliHLTComponentDataTypefIDsize; i++ )
388 if ( dt1.fID[i] != dt2.fID[i] )
390 for ( int i = 0; i < kAliHLTComponentDataTypefOriginSize; i++ )
391 if ( dt1.fOrigin[i] != dt2.fOrigin[i] )
396 inline bool operator!=( const AliHLTComponentDataType& dt1, const AliHLTComponentDataType& dt2 )
398 for ( int i = 0; i < kAliHLTComponentDataTypefIDsize; i++ )
399 if ( dt1.fID[i] != dt2.fID[i] )
401 for ( int i = 0; i < kAliHLTComponentDataTypefOriginSize; i++ )
402 if ( dt1.fOrigin[i] != dt2.fOrigin[i] )