]> git.uio.no Git - u/mrichter/AliRoot.git/blame - RAW/event.h
git://git.uio.no / u / mrichter / AliRoot.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Refactoring of the EMCAL jet package:
[u/mrichter/AliRoot.git] / RAW / event.h
CommitLineData
f3a800f8 1/****************************************************************************
2 *
3 * event.h: DATE event data format
4 *
5 * Revision History:
6 * V01.00 RD PVV 09-Jan-97 Initial version
7 * V01.01 AV 24-Feb-97 Added START_OF_RUN_FILES and triggerNb
8 * V02.02 RD 13-Mar-97 Detector ID mask type added
9 * V02.03 PVV 20-Mar-97 Detector ID on 128 bits
10 * V02.03 RD PVV 20-Mar-97 Added EVENT_DATA_TRUNCATED
11 * V02.04 PVV 06-May-97 Added EVENT_TYPE_MASK
12 * V02.05 RD PVV 09-May-97 Increase EVENT_DATA_MAX_SIZE to 50 K
13 * V02.06 WB MG 22-May-97 Added END_OF_RUN_FILES
14 * V02.07 WB 23-May-97 Added errorCode, deadTime, deadTimeusec
15 * EVENT_DATA_MAX_SIZE set to 100 * 1024
16 * MAX_DETECTORS set to 126
17 * V02.08 PVV 02-Jun-97 Modify the encoding of types
18 * V02.09 WB RD PVV 28-Jul-98 Add fileSeqNb in the header.
19 * Reduce detector mask to 3 long
20 * V02.10 RD 31-Jul-98 (start|end)OfRunFiles added to eventType
21 * V02.11 PVV RD 02-Sep-98 Event type re-numbered
22 * Equipment bit added to event type
23 * V02.12 AV PVV RD 03-Sep-98 FileSeqNo moved before detectorId
24 * V02.13 RD 08-Oct-98 32 bits fields defined as long32
25 * V02.13 RD 19-Feb-99 Endianness/swap definitions added
26 * V02.14 WB PVV RD 21-Jun-99 typeAttribute added
27 * V02.15 RD 27-Jul-99 Macros for typeAttribute handling added
28 * V02.16 RD 19-Nov-99 Bug in Attributes test/set fixed
29 * V02.17 WB PVV RD 08-May-00 System attributes for SOR and EOR added
30 * V02.18 RD 18-May-00 EVENT_H_ID added
31 * V02.19 RD 10-Aug-00 Macros for detectorId handling added
32 * V03.00 RD 23-Nov-00 Version for DATE V4
33 * V03.01 AV KS 05-Apr-02 Introduction of eventLocationDescriptorStruct
34 * V03.02 KS 10-May-02 Added ATTR_KEEP_PAGES for COLE
35 * RD 30-Apr-04 Added definitions for the Common Data Header
36 * RD 24-Jun-04 Added definitions for HLT DECISION
37 * RD 13-Jul-04 Added macros to OR attributes
38 * V03.03 RD 25-May-05 Added eventTimestamp
39 * V03.04 RD 17-Aug-05 Added VANGUARD and REARGUARD events
40 * V03.05 RD 05-Sep-05 Added SYSTEM and DETECTOR software tri evts
41 * V03.06 RD 14-Sep-05 VANGUARD/REARGUARD changed into START_OF_DATA
42 * and END_OF_DATA
07afbf5b 43 * V03.07 RD 26-Jul-06 Modifications for CDH version 2
44 * KS 20-Dec-06 Corrected CDH layout for MBZ[22-23] and
45 * L1 trigger message [14-21]
46 * V03.08 RD 17-Jan-07 Added "BY DETECTOR" event system attribute
47 * V03.09 RD 08-Feb-07 Moved trigger and detector masks down 1 bit
480f0332 48 * KS 14-May-08 Define trigger error bits 13+14 for the CDH
49 * V03.10 RD 10-Nov-09 Define ATTR_EMPTY_EVENT attribute (removed)
50 * V03.11 RD 01-Dec-10 Timestamp sec + usec
51 * V03.12 RD 13-Sep-11 Added ATTR_ORIGINAL_EVENT and CDH_ORIGINAL_EVENT
52 * V03.13 RD 15-Feb-12 Added SYNC event
53 * RD 15-Jan-14 Added FLUSHED_EVENT and INCOMPLETE_EVENT
54 * V03.14 RD 12-Feb-14 Changes for increased number of trigger classes
55 * (old:50, new:100) and for CDH V3
b2e69add 56 * Added the possibility to compile with extra symbols
f3a800f8 57 *
58 * Preprocessor definitions:
59 * NDEBUG Define BEFORE including this file to disable run-time checks on
480f0332 60 * various parameters made via assert()
f3a800f8 61 *
62 * Related facilities:
63 * validateEvent.c Validation program, should be run after EACH change to
64 * the definitions given here below
65 ***************************************************************************/
66#ifndef __event_h__
67#define __event_h__
68
480f0332 69#define EVENT_MAJOR_VERSION_NUMBER 3
70#define EVENT_MINOR_VERSION_NUMBER 14
f3a800f8 71
72/* ========== System includes ========= */
73#include <string.h> /* Needed by: memset, memcpy */
74#include <assert.h> /* Needed by: assert */
75
b2e69add 76/* ========== Data types ========= */
77/* These data types can be overridden via compile-time symbols */
78#ifndef long32
79# define long32 int
80#endif
81#ifndef long64
82# define long64 long long
83#endif
84#ifndef datePointer
85# define datePointer long
86#endif
87
f3a800f8 88/* ========== Definitions for the event header ========== */
89
480f0332 90/* ------------------------- Header base size ------------------------- */
91/* This value must be updated for each change in the eventHeaderStruct */
92/* This has not been made automatic as we want to keep this value under */
93/* strict control... */
94#define EVENT_HEAD_BASE_SIZE 80
f3a800f8 95
96/* ---------- Event size ---------- */
97typedef unsigned long32 eventSizeType;
98
480f0332 99/* ----------- Magic signature and its byte-swapped version ----------- */
f3a800f8 100typedef unsigned long32 eventMagicType;
101#define EVENT_MAGIC_NUMBER ((eventMagicType)0xDA1E5AFE)
102#define EVENT_MAGIC_NUMBER_SWAPPED ((eventMagicType)0xFE5A1EDA)
103
104/* ---------- Header size ---------- */
105typedef unsigned long32 eventHeadSizeType;
106
107/* ---------- Unique version identifier ---------- */
108#define EVENT_CURRENT_VERSION \
109 (((EVENT_MAJOR_VERSION_NUMBER<<16)&0xffff0000)|\
110 (EVENT_MINOR_VERSION_NUMBER&0x0000ffff))
111typedef unsigned long32 eventVersionType;
112
113/* ---------- Event type ---------- */
114typedef unsigned long32 eventTypeType;
115#define START_OF_RUN ((eventTypeType) 1)
116#define END_OF_RUN ((eventTypeType) 2)
117#define START_OF_RUN_FILES ((eventTypeType) 3)
118#define END_OF_RUN_FILES ((eventTypeType) 4)
119#define START_OF_BURST ((eventTypeType) 5)
120#define END_OF_BURST ((eventTypeType) 6)
121#define PHYSICS_EVENT ((eventTypeType) 7)
122#define CALIBRATION_EVENT ((eventTypeType) 8)
123#define EVENT_FORMAT_ERROR ((eventTypeType) 9)
124#define START_OF_DATA ((eventTypeType)10)
125#define END_OF_DATA ((eventTypeType)11)
126#define SYSTEM_SOFTWARE_TRIGGER_EVENT ((eventTypeType)12)
127#define DETECTOR_SOFTWARE_TRIGGER_EVENT ((eventTypeType)13)
480f0332 128#define SYNC_EVENT ((eventTypeType)14)
f3a800f8 129#define EVENT_TYPE_MIN 1
480f0332 130#define EVENT_TYPE_MAX 14
f3a800f8 131enum eventTypeEnum {
132 startOfRun = START_OF_RUN,
133 endOfRun = END_OF_RUN,
134 startOfRunFiles = START_OF_RUN_FILES,
135 endOfRunFiles = END_OF_RUN_FILES,
136 startOfBurst = START_OF_BURST,
137 endOfBurst = END_OF_BURST,
138 physicsEvent = PHYSICS_EVENT,
139 calibrationEvent = CALIBRATION_EVENT,
140 formatError = EVENT_FORMAT_ERROR,
141 startOfData = START_OF_DATA,
142 endOfData = END_OF_DATA,
143 systemSoftwareTriggerEvent = SYSTEM_SOFTWARE_TRIGGER_EVENT,
480f0332 144 detectorSoftwareTriggerEvent = DETECTOR_SOFTWARE_TRIGGER_EVENT,
145 syncEvent = SYNC_EVENT
f3a800f8 146};
147#define EVENT_TYPE_OK(t) (((t) >= EVENT_TYPE_MIN) && (((t) <= EVENT_TYPE_MAX)))
148
149/* ---------- Run number ---------- */
150typedef unsigned long32 eventRunNbType;
151
152/* ---------- The eventId field ---------- */
153#define EVENT_ID_BYTES 8
154#define EVENT_ID_WORDS ((EVENT_ID_BYTES) >> 2)
155typedef unsigned long32 eventIdType[EVENT_ID_WORDS];
156
157 /* PERIOD - ORBIT - BUNCH crossing type events */
158#define EVENT_ID_MAX_PERIOD 0x0fffffff
159#define EVENT_ID_MAX_ORBIT 0x00ffffff
160#define EVENT_ID_MAX_BUNCH_CROSSING 0x00000fff
161#define LOAD_EVENT_ID(id,s,o,bc) \
162 (EVENT_ID_SET_PERIOD(id,s), \
163 EVENT_ID_SET_ORBIT(id,o), \
164 EVENT_ID_SET_BUNCH_CROSSING(id,bc))
165#define EVENT_ID_GET_BUNCH_CROSSING(id) ((id)[1]&0x00000fff)
166#define EVENT_ID_GET_ORBIT(id) \
167 ((((id)[0]<<20)&0xf00000)|(((id)[1]>>12)&0xfffff))
168#define EVENT_ID_GET_PERIOD(id) (((id)[0]>>4)&0x0fffffff)
169
170#define EVENT_ID_SET_BUNCH_CROSSING(id,v) \
171 (assert(((v)>=0)&&((v)<=EVENT_ID_MAX_BUNCH_CROSSING)), \
172 (id)[1]=((id)[1]&0xfffff000)|((v)&0xfff))
173#define EVENT_ID_SET_ORBIT(id,v) \
174 (assert(((v)>=0)&&((v)<=EVENT_ID_MAX_ORBIT)), \
175 (id)[0]=(((id)[0])&0xfffffff0)|(((v)&0x00f00000)>>20), \
176 (id)[1]=(((id)[1])&0x00000fff)|(((v)&0x000fffff)<<12))
177#define EVENT_ID_SET_PERIOD(id,v) \
178 (assert(((v)>=0)&&((v)<=EVENT_ID_MAX_PERIOD)), \
179 (id)[0]=(((id)[0])&0x0000000f)|(((v)&0x0fffffff)<<4))
180
181 /* RAW type event */
182#define EVENT_ID_MAX_NB_IN_RUN 0xffffffff
183#define EVENT_ID_MAX_BURST_NB 0x00000fff
184#define EVENT_ID_MAX_NB_IN_BURST 0x000fffff
185#define LOAD_RAW_EVENT_ID(id,nir,bn,nib) \
186 (assert(((bn)>=0) && ((bn)<=EVENT_ID_MAX_BURST_NB) && \
187 ((nib)>=0) && ((nib)<=EVENT_ID_MAX_NB_IN_BURST)), \
188 (id)[0]=nir, \
189 (id)[1]=((bn<<20)&0xfff00000)|(nib&0x000fffff))
190#define EVENT_ID_SET_NB_IN_RUN(id,nir) \
191 (assert(((nir)>=0)&&((nir)<=EVENT_ID_MAX_NB_IN_RUN)), \
192 (id)[0]=(nir))
193#define EVENT_ID_SET_BURST_NB(id,bn) \
194 (assert(((bn)>=0)&&((bn)<=EVENT_ID_MAX_BURST_NB)), \
195 (id)[1]=((id)[1]&0x000fffff)|(((bn)<<20)&0xfff00000))
196#define EVENT_ID_SET_NB_IN_BURST(id,nib) \
197 (assert(((nib)>=0)&&((nib)<=EVENT_ID_MAX_NB_IN_BURST)), \
198 (id)[1]=((id)[1]&0xfff00000)|((nib)&0x000fffff))
199#define EVENT_ID_GET_NB_IN_RUN(id) ((id)[0])
200#define EVENT_ID_GET_BURST_NB(id) (((id)[1]>>20)&0x00000fff)
201#define EVENT_ID_GET_NB_IN_BURST(id) ((id)[1]&0x000fffff)
202
203 /* All events */
204#define EQ_EVENT_ID(a,b) ((((a)[0])==((b)[0]))&&(((a)[1])==((b)[1])))
205#define GT_EVENT_ID(a,b) \
206 (((((a)[0])>((b)[0])))||((((a)[0])==((b)[0]))&&(((a)[1])>((b)[1]))))
207#define LT_EVENT_ID(a,b) \
208 ((((a)[0])<((b)[0])) || ((((a)[0])==((b)[0]))&&(((a)[1])<((b)[1]))))
209#define GE_EVENT_ID(a,b) (!LT_EVENT_ID(a,b))
210#define LE_EVENT_ID(a,b) (!GT_EVENT_ID(a,b))
211#define COPY_EVENT_ID(from,to) \
212 memcpy((void*)to,(const void*)from,EVENT_ID_BYTES)
213#define ADD_EVENT_ID(a,b) ((a)[1]+=(b)[1],(a)[0]+=(b)[0])
214#define SUB_EVENT_ID(a,b) ((a)[1]-=(b)[1],(a)[0]-=(b)[0])
480f0332 215#define ZERO_EVENT_ID(id) memset((void *)(id),0,EVENT_ID_BYTES)
f3a800f8 216
217/* ---------- Trigger pattern (and relative masks) ---------- */
480f0332 218// The top bit of the trigger pattern is reserved for the validity flag
219#define EVENT_TRIGGER_PATTERN_BYTES 16
f3a800f8 220#define EVENT_TRIGGER_PATTERN_WORDS ((EVENT_TRIGGER_PATTERN_BYTES)>>2)
221typedef unsigned long32 eventTriggerPatternType[EVENT_TRIGGER_PATTERN_WORDS];
07afbf5b 222#define EVENT_TRIGGER_ID_MIN 0
480f0332 223#define EVENT_TRIGGER_ID_MAX 99
f3a800f8 224#define CHECK_TRIGGER(t) (assert(((t)>=EVENT_TRIGGER_ID_MIN) && \
225 ((t)<=EVENT_TRIGGER_ID_MAX)))
226#define TRIGGER_TO_BIT(t) (1<<((t)&0x1f))
227#define TRIGGER_TO_WORD(t) (CHECK_TRIGGER(t), (t)>>5)
480f0332 228#define ZERO_TRIGGER_PATTERN(p) memset( (void *)(p), 0, EVENT_TRIGGER_PATTERN_BYTES )
f3a800f8 229#define SET_TRIGGER_IN_PATTERN(p,id) (p)[TRIGGER_TO_WORD(id)] |= \
230 TRIGGER_TO_BIT(id)
231#define CLEAR_TRIGGER_IN_PATTERN(p,id) (p)[TRIGGER_TO_WORD(id)] &= \
232 ~(TRIGGER_TO_BIT(id))
233#define FLIP_TRIGGER_IN_PATTERN(p,id) (p)[TRIGGER_TO_WORD(id)] ^= \
234 TRIGGER_TO_BIT(id)
235#define TEST_TRIGGER_IN_PATTERN(p,id) (((p)[TRIGGER_TO_WORD(id)] & \
236 TRIGGER_TO_BIT(id)) != 0)
480f0332 237#define TRIGGER_PATTERN_INVALID(p) (((p)[EVENT_TRIGGER_PATTERN_WORDS-1] & 0x80000000) == 0)
238#define TRIGGER_PATTERN_VALID(p) (((p)[EVENT_TRIGGER_PATTERN_WORDS-1] & 0x80000000) != 0)
239#define VALIDATE_TRIGGER_PATTERN(p) ((p)[EVENT_TRIGGER_PATTERN_WORDS-1] |= 0x80000000)
240#define INVALIDATE_TRIGGER_PATTERN(p) ((p)[EVENT_TRIGGER_PATTERN_WORDS-1] &= 0x7fffffff)
241#define COPY_TRIGGER_PATTERN(f,t) memcpy( (void *)(t), (void *)(f), EVENT_TRIGGER_PATTERN_BYTES )
242#define TRIGGER_PATTERN_OK(p) (((p)[EVENT_TRIGGER_PATTERN_WORDS-1] & 0x7ffffff0) == 0)
f3a800f8 243
244/* ---------- Detectors cluster (and relative masks) ---------- */
245#define EVENT_DETECTOR_PATTERN_BYTES 4
246#define EVENT_DETECTOR_PATTERN_WORDS (EVENT_DETECTOR_PATTERN_BYTES>>2)
247typedef unsigned long32 eventDetectorPatternType[EVENT_DETECTOR_PATTERN_WORDS];
07afbf5b 248#define EVENT_DETECTOR_ID_MIN 0
07afbf5b 249#define EVENT_DETECTOR_ID_MAX 30
f3a800f8 250#define CHECK_DETECTOR(d) (assert(((d) >= EVENT_DETECTOR_ID_MIN) &&\
251 ((d) <= EVENT_DETECTOR_ID_MAX)))
252#define DETECTOR_TO_BIT(d) (CHECK_DETECTOR(d), 1<<(d))
253#define ZERO_DETECTOR_PATTERN(p) ((p)[0] = 0)
254#define SET_DETECTOR_IN_PATTERN(p,d) ((p)[0] |= DETECTOR_TO_BIT(d))
255#define CLEAR_DETECTOR_IN_PATTERN(p,d) ((p)[0] &= ~(DETECTOR_TO_BIT(d)))
256#define FLIP_DETECTOR_IN_PATTERN(p,d) ((p)[0] ^= DETECTOR_TO_BIT(d))
257#define TEST_DETECTOR_IN_PATTERN(p,d) (((p)[0] & DETECTOR_TO_BIT(d))!=0)
07afbf5b 258#define DETECTOR_PATTERN_INVALID(p) (((p)[0] & 0x80000000) == 0)
259#define DETECTOR_PATTERN_VALID(p) (((p)[0] & 0x80000000) != 0)
260#define VALIDATE_DETECTOR_PATTERN(p) ((p)[0] |= 0x80000000)
261#define INVALIDATE_DETECTOR_PATTERN(p) ((p)[0] &= 0x7fffffff)
f3a800f8 262#define COPY_DETECTOR_PATTERN(f,t) ((t)[0] = (f)[0])
480f0332 263#define DETECTOR_PATTERN_OK(p) (((p)[0] & 0x1f000000) == 0)
264
f3a800f8 265
266/* ---------- The sizes and positions of the typeAttribute field ---------- */
267#define ALL_ATTRIBUTE_WORDS 3
268#define ALL_ATTRIBUTE_BYTES (ALL_ATTRIBUTE_WORDS * 4)
269#define ALL_ATTRIBUTE_BITS (ALL_ATTRIBUTE_BYTES * 8)
270#define USER_ATTRIBUTE_WORDS 2
271#define USER_ATTRIBUTE_BYTES (USER_ATTRIBUTE_WORDS * 4)
272#define USER_ATTRIBUTE_BITS (USER_ATTRIBUTE_BYTES * 8)
273#define FIRST_USER_ATTRIBUTE 0
274#define LAST_USER_ATTRIBUTE (USER_ATTRIBUTE_BITS - 1)
275#define SYSTEM_ATTRIBUTE_WORDS 1
276#define SYSTEM_ATTRIBUTE_BYTES (SYSTEM_ATTRIBUTE_WORDS * 4)
277#define SYSTEM_ATTRIBUTE_BITS (SYSTEM_ATTRIBUTE_BYTES * 8)
278#define FIRST_SYSTEM_ATTRIBUTE USER_ATTRIBUTE_BITS
279#define LAST_SYSTEM_ATTRIBUTE (USER_ATTRIBUTE_BITS + \
280 SYSTEM_ATTRIBUTE_BITS - 1)
281typedef unsigned long32 eventTypeAttributeType[ALL_ATTRIBUTE_WORDS];
282
283 /* Word and bit definitions */
284#define SYS_ATTR_2_W(b) (assert(((b)>=64)&&((b)<=95)),2)
285#define USR_ATTR_2_W(b) (assert(((b)>= 0)&&((b)<=63)),(b)>>5)
286#define ATTR_2_W(b) (assert(((b)>= 0)&&((b)<=95)),(b)>>5)
287#define ATTR_2_B(b) (1<<((b)&0x1f))
288
289 /* Macros to handle all attributes without distinction */
290#define RESET_ATTRIBUTES(m) ((m)[2] = (m)[1] = (m)[0] = 0)
291#define SET_ANY_ATTRIBUTE(m,b) (m)[ATTR_2_W(b)] |= ATTR_2_B(b)
292#define CLEAR_ANY_ATTRIBUTE(m,b) (m)[ATTR_2_W(b)] &= ~(ATTR_2_B(b))
293#define FLIP_ANY_ATTRIBUTE(m,b) (m)[ATTR_2_W(b)] ^= ATTR_2_B(b)
294#define TEST_ANY_ATTRIBUTE(m,b) (((m)[ATTR_2_W(b)] & ATTR_2_B(b))!= 0)
295#define COPY_ALL_ATTRIBUTES( from, to ) \
296 memcpy((void *)&to[0], (const void *)&from[0], ALL_ATTRIBUTE_BYTES)
297#define OR_ALL_ATTRIBUTES( from, to ) \
298 ((to)[2] |= (from)[2], (to)[1] |= (from)[1], (to)[0] |= (from)[0])
299
300 /* Macros to handle SYSTEM attributes */
301#define RESET_SYSTEM_ATTRIBUTES(m) ((m)[2] = 0)
302#define SET_SYSTEM_ATTRIBUTE(m,b) (m)[SYS_ATTR_2_W(b)] |= ATTR_2_B(b)
303#define CLEAR_SYSTEM_ATTRIBUTE(m,b) (m)[SYS_ATTR_2_W(b)] &= ~(ATTR_2_B(b))
304#define FLIP_SYSTEM_ATTRIBUTE(m,b) (m)[SYS_ATTR_2_W(b)] ^= ATTR_2_B(b)
305#define TEST_SYSTEM_ATTRIBUTE(m,b) (((m)[SYS_ATTR_2_W(b)] & ATTR_2_B(b)) != 0)
306#define COPY_SYSTEM_ATTRIBUTES( from, to ) \
307 memcpy((void *)&to[2], (const void *)&from[2], SYSTEM_ATTRIBUTE_BYTES)
308#define OR_SYSTEM_ATTRIBUTES( from, to ) ((to)[2] |= (from)[2])
309
310 /* Macros to handle USER attributes */
311#define RESET_USER_ATTRIBUTES(m) ((m)[0] = (m)[1] = 0)
312#define SET_USER_ATTRIBUTE(m,b) (m)[USR_ATTR_2_W(b)] |= ATTR_2_B(b)
313#define CLEAR_USER_ATTRIBUTE(m,b) (m)[USR_ATTR_2_W(b)] &= ~(ATTR_2_B(b))
314#define FLIP_USER_ATTRIBUTE(m,b) (m)[USR_ATTR_2_W(b)] ^= ATTR_2_B(b)
315#define TEST_USER_ATTRIBUTE(m,b) (((m)[USR_ATTR_2_W(b)] & ATTR_2_B(b)) != 0)
316#define COPY_USER_ATTRIBUTES( from, to ) \
317 memcpy((void *)&to[0], (const void *)&from[0], USER_ATTRIBUTE_BYTES)
318#define OR_USER_ATTRIBUTES( from, to ) \
319 ((to)[1] |= (from)[1], (to)[0] |= (from)[0])
320
321 /* System attributes assignment */
322#define ATTR_P_START 64 /* Start of a phase */
323#define ATTR_P_END 65 /* End of a phase */
324#define ATTR_START_OF_RUN_START ATTR_P_START/* Start of SOR phase */
325#define ATTR_START_OF_RUN_END ATTR_P_END /* End of SOR phase */
326#define ATTR_END_OF_RUN_START ATTR_P_START/* Start of EOR phase */
327#define ATTR_END_OF_RUN_END ATTR_P_END /* End of SOR phase */
328#define ATTR_EVENT_SWAPPED 66 /* Swapped event header */
329#define ATTR_EVENT_PAGED 67 /* Paged event */
330#define ATTR_SUPER_EVENT 68 /* Super event */
331#define ATTR_ORBIT_BC 69 /* Orbit/bunch crossing in ID*/
332#define ATTR_KEEP_PAGES 70 /* Do not deallocate pages */
333#define ATTR_HLT_DECISION 71 /* Event contains HLT decis. */
07afbf5b 334#define ATTR_BY_DETECTOR_EVENT 72 /* Event created by "by det."*/
480f0332 335#define ATTR_ORIGINAL_EVENT 73 /* All original payloads */
f3a800f8 336
480f0332 337#define ATTR_FLUSHED_EVENT 92 /* Flushed event */
338#define ATTR_INCOMPLETE_EVENT 93 /* Incomplete event */
f3a800f8 339#define ATTR_EVENT_DATA_TRUNCATED 94 /* Truncated payload */
340#define ATTR_EVENT_ERROR 95 /* Invalid event content */
341
342#define SYSTEM_ATTRIBUTES_OK(m) \
343 ((((m)[2]) & ~(ATTR_2_B(ATTR_P_START) | \
344 ATTR_2_B(ATTR_P_END) | \
345 ATTR_2_B(ATTR_EVENT_SWAPPED) | \
346 ATTR_2_B(ATTR_EVENT_PAGED) | \
347 ATTR_2_B(ATTR_SUPER_EVENT) | \
348 ATTR_2_B(ATTR_ORBIT_BC) | \
349 ATTR_2_B(ATTR_KEEP_PAGES) | \
350 ATTR_2_B(ATTR_HLT_DECISION) | \
07afbf5b 351 ATTR_2_B(ATTR_BY_DETECTOR_EVENT) | \
480f0332 352 ATTR_2_B(ATTR_ORIGINAL_EVENT) | \
353 ATTR_2_B(ATTR_INCOMPLETE_EVENT) | \
354 ATTR_2_B(ATTR_FLUSHED_EVENT) | \
f3a800f8 355 ATTR_2_B(ATTR_EVENT_DATA_TRUNCATED) | \
356 ATTR_2_B(ATTR_EVENT_ERROR))) == 0)
357
358/* ---------- LDC and GDC identifier ---------- */
359typedef unsigned long32 eventHostIdType;
360typedef eventHostIdType eventLdcIdType;
361typedef eventHostIdType eventGdcIdType;
362#define HOST_ID_MIN ((eventHostIdType)0) /* The minimum allowed ID */
363#define HOST_ID_MAX ((eventHostIdType)511) /* The maximum allowed ID */
364#define VOID_ID ((eventHostIdType)-1) /* Unloaded ID */
365
480f0332 366/* ---------- Timestamps ----------
367
368 The timestamp of the event is associated to:
369
370 - Trigger arrived on the LDC
371 - First sub-event arrived on the GDC
372 - Event ready when monitoring by detector
373
374 The timestamp is split into seconds and microseconds.
375
376 Please note that the typical accuracy of the Unix clock is on
377 the order of the millisecond.
378
379 For more details on the subject, see the man page for gettimeofday
380 and the description of the Unix standard type struct timeval
381*/
382
383/* ---------- Seconds timestamp ----------
384
385 The following definition is in common for 32 and 64 bit machines.
f3a800f8 386 In both architectures, the field must be loaded into a time_t
387 variable before being used. Failure to do so may cause undefined
388 results up to the early termination of the process.
389
390 The recommended procedure to use this field is the following:
391
392 #include <time.h>
393
394 time_t t;
395
480f0332 396 t = eventHeaderStruct.eventTimestampSec;
f3a800f8 397 cTime( &t ); (or whatever else can be done with a time_t)
398
399 Please note that the available timestamp will wrap sometime
400 around Jan 18, 19:14:07, 2038...
401*/
480f0332 402typedef unsigned long32 eventTimestampSecType;
403
404/* Microseconds: range [0..999999]
405 */
406typedef unsigned long32 eventTimestampUsecType;
f3a800f8 407
408/* ---------- The event header structure (with + without data) ---------- */
409struct eventHeaderStruct {
410 eventSizeType eventSize;
411 eventMagicType eventMagic;
412 eventHeadSizeType eventHeadSize;
413 eventVersionType eventVersion;
414 eventTypeType eventType;
415 eventRunNbType eventRunNb;
416 eventIdType eventId;
417 eventTriggerPatternType eventTriggerPattern;
418 eventDetectorPatternType eventDetectorPattern;
419 eventTypeAttributeType eventTypeAttribute;
420 eventLdcIdType eventLdcId;
421 eventGdcIdType eventGdcId;
480f0332 422 union {
423 eventTimestampSecType eventTimestampSec;
424 /* This definition is only for backward compatibility with event.h < 3.11 */
425 eventTimestampSecType eventTimestamp;
426 };
427 eventTimestampUsecType eventTimestampUsec;
f3a800f8 428};
429
430struct eventStruct {
431 struct eventHeaderStruct eventHeader;
432 unsigned short eventRawData[1];
433};
434
435/* ========== Definitions for the Vector ========== */
480f0332 436typedef short eventVectorBankIdType;
437typedef datePointer eventVectorSizeType;
438typedef datePointer eventVectorOffsetType;
f3a800f8 439
440struct eventVectorStruct {
441 eventVectorBankIdType eventVectorBankId;
442 unsigned eventVectorPointsToVector : 1;
443 eventVectorSizeType eventVectorSize;
444 eventVectorOffsetType eventVectorStartOffset;
445};
446
447/* ========== Definitions for the payload descriptor ========== */
448typedef unsigned long32 eventNumEquipmentsType;
449typedef struct eventVectorStruct eventExtensionVectorType;
450
451struct vectorPayloadDescriptorStruct {
452 eventNumEquipmentsType eventNumEquipments;
453 eventExtensionVectorType eventExtensionVector;
454};
455
456/* ========== Definitions for the equipment header ========== */
457typedef long32 equipmentSizeType;
458typedef long32 equipmentTypeType;
459typedef long32 equipmentIdType;
460typedef eventTypeAttributeType equipmentTypeAttributeType;
461typedef long32 equipmentBasicElementSizeType;
462
463struct equipmentHeaderStruct {
464 equipmentSizeType equipmentSize;
465 equipmentTypeType equipmentType;
466 equipmentIdType equipmentId;
467 equipmentTypeAttributeType equipmentTypeAttribute;
468 equipmentBasicElementSizeType equipmentBasicElementSize;
469};
470
471struct equipmentDescriptorStruct {
472 struct equipmentHeaderStruct equipmentHeader;
473 struct eventVectorStruct equipmentVector;
480f0332 474}
475#ifdef __GNUC__
476 __attribute__((__packed__));
477#else
478 // Find whatever method for your compiler to pack the above structure without paddings
479 ;
480#endif
f3a800f8 481
482struct equipmentStruct {
483 struct equipmentHeaderStruct equipmentHeader;
484 unsigned short equipmentRawData[1];
485};
486
487/* ========== Definition of the event location for the simpleFifo ========== */
488struct eventLocationDescriptorStruct {
489 eventVectorBankIdType eventBankId;
490 eventVectorOffsetType eventOffset;
491};
492
493/* ========== Global macros ========== */
494
495/* The macro PAGED_EVENT_SIZE receives in input the ADDRESS of a paged
496 event and returns the size (in bytes) of the first page of the
497 event */
498#define PAGED_EVENT_SIZE( event ) \
499 (EVENT_HEAD_BASE_SIZE +sizeof( struct vectorPayloadDescriptorStruct ) + \
500 ((*(eventNumEquipmentsType *)((void*)event+EVENT_HEAD_BASE_SIZE))* \
501 (sizeof( struct equipmentDescriptorStruct ))))
502
503/* ========== Common data header ========== */
480f0332 504#define CDH_SIZE (4* 10)
505#define CDH_VERSION 3
506
507#define CDH_TRIGGER_OVERLAP_ERROR_BIT 0
508#define CDH_TRIGGER_MISSING_ERROR_BIT 1
509#define CDH_DATA_PARITY_ERROR_BIT 2
510#define CDH_CONTROL_PARITY_ERROR_BIT 3
511#define CDH_TRIGGER_INFORMATION_UNAVAILABLE_BIT 4
512#define CDH_FEE_ERROR_BIT 5
513#define CDH_HLT_DECISION_BIT 6
514#define CDH_HLT_PAYLOAD_BIT 7
515#define CDH_DDG_PAYLOAD_BIT 8
516#define CDH_TRIGGER_L1_TIME_VIOLATION_ERROR_BIT 9
517#define CDH_TRIGGER_L2_TIME_VIOLATION_ERROR_BIT 10
518#define CDH_TRIGGER_PREPULSE_ERROR_BIT 11
519#define CDH_TRIGGER_ERROR_BIT 12
520#define CDH_TRIGGER_L1_MISSING_L2_RECEIVED_BIT 13
521#define CDH_TRIGGER_MULTI_EVENT_BUFFER_ERROR_BIT 14
522#define CDH_ORIGINAL_EVENT_BIT 15
523
524/* Macro to load the trigger classes of an event header
525 using the cdhTriggerClasses* fields */
526#define CDH_LOAD_EVENT_TRIGGER_PATTERN( etp, l, ml, mh, h ) \
b2e69add 527 ( etp[0] = ((unsigned long32)(l)), \
528 etp[1] = ((unsigned long32)(ml)), \
529 etp[2] = ((unsigned long32)(mh)), \
530 etp[3] = ((unsigned long32)(h) & 0xf) )
f3a800f8 531
532/* Please note how the above data structure has been
533 defined for LE systems. Code running on BE systems
534 must have all fields reverted to work correctly! */
535struct commonDataHeaderStruct {
536 unsigned cdhBlockLength : 32;
537 /* ------------------------------------- */
538 unsigned cdhEventId1 : 12;
480f0332 539 unsigned cdhMBZ1 : 2;
540 unsigned cdhL1TriggerMessage : 8;
541 unsigned cdhMBZ0 : 2;
542 unsigned cdhVersion : 8;
543 /* ------------------------------------- */
544 unsigned cdhEventId2 : 24;
545 unsigned cdhParRequests : 8;
546 /* ------------------------------------- */
547 unsigned cdhParticipatingSubDetectors : 24;
548 unsigned cdhBlockAttributes : 8;
549 /* ------------------------------------- */
550 unsigned cdhMiniEventId : 12;
551 unsigned cdhStatusErrorBits : 20;
552 /* ------------------------------------- */
553 unsigned cdhTriggerClassesLow : 32; // Goes into eventTriggerPattern[0]
554 /* ------------------------------------- */
b2e69add 555 unsigned cdhTriggerClassesMiddleLow : 32; // Goes into eventTriggerPattern[1]
480f0332 556 /* ------------------------------------- */
b2e69add 557 unsigned cdhTriggerClassesMiddleHigh : 32; // Goes into eventTriggerPattern[2]
480f0332 558 /* ------------------------------------- */
b2e69add 559 unsigned cdhTriggerClassesHigh : 4; // Goes into eventTriggerPattern[3] (zero-filled)
560 unsigned cdhMBZ4 : 24;
480f0332 561 unsigned cdhRoiLow : 4;
562 /* ------------------------------------- */
563 unsigned cdhRoiHigh : 32;
564};
565
566/* Old (V2) structure, defined for backward
567 compatibility.
568
569 MAY DISAPPEAR IN FUTURE VERSIONS OF DATE!
570*/
571struct commonDataHeaderV2Struct {
572 unsigned cdhBlockLength : 32;
573 /* ------------------------------------- */
574 unsigned cdhEventId1 : 12;
07afbf5b 575 unsigned cdhMBZ1 : 2;
576 unsigned cdhL1TriggerMessage : 8;
f3a800f8 577 unsigned cdhMBZ0 : 2;
f3a800f8 578 unsigned cdhVersion : 8;
579 /* ------------------------------------- */
580 unsigned cdhEventId2 : 24;
07afbf5b 581 unsigned cdhMBZ2 : 8;
f3a800f8 582 /* ------------------------------------- */
583 unsigned cdhParticipatingSubDetectors : 24;
584 unsigned cdhBlockAttributes : 8;
585 /* ------------------------------------- */
586 unsigned cdhMiniEventId : 12;
587 unsigned cdhStatusErrorBits : 16;
07afbf5b 588 unsigned cdhMBZ3 : 4;
f3a800f8 589 /* ------------------------------------- */
590 unsigned cdhTriggerClassesLow : 32;
591 /* ------------------------------------- */
592 unsigned cdhTriggerClassesHigh : 18;
07afbf5b 593 unsigned cdhMBZ4 : 10;
f3a800f8 594 unsigned cdhRoiLow : 4;
595 /* ------------------------------------- */
596 unsigned cdhRoiHigh : 32;
597};
598
599#endif