Specify that trace readers (and not parser) should remove leading field underscores
[ctf.git] / common-trace-format-specification.txt
CommitLineData
4dfca05b 1Common Trace Format (CTF) Specification (pre-v1.8)
5ba9f198
MD
2
3Mathieu Desnoyers, EfficiOS Inc.
4
339a7dde 5The goal of the present document is to specify a trace format that suits the
cc089c3a 6needs of the embedded, telecom, high-performance and kernel communities. It is
5ba9f198 7based on the Common Trace Format Requirements (v1.4) document. It is designed to
cc089c3a 8allow traces to be natively generated by the Linux kernel, Linux user-space
6c7226e9
MD
9applications written in C/C++, and hardware components. One major element of
10CTF is the Trace Stream Description Language (TSDL) which flexibility
11enables description of various binary trace stream layouts.
cc089c3a
MD
12
13The latest version of this document can be found at:
14
15 git tree: git://git.efficios.com/ctf.git
16 gitweb: http://git.efficios.com/?p=ctf.git
5ba9f198
MD
17
18A reference implementation of a library to read and write this trace format is
19being implemented within the BabelTrace project, a converter between trace
20formats. The development tree is available at:
21
22 git tree: git://git.efficios.com/babeltrace.git
23 gitweb: http://git.efficios.com/?p=babeltrace.git
24
339a7dde
MD
25The CE Workgroup of the Linux Foundation, Ericsson, and EfficiOS have
26sponsored this work.
27
5ba9f198 28
beabf088
MD
29Table of Contents
30
311. Preliminary definitions
322. High-level representation of a trace
333. Event stream
344. Types
35 4.1 Basic types
36 4.1.1 Type inheritance
37 4.1.2 Alignment
38 4.1.3 Byte order
39 4.1.4 Size
40 4.1.5 Integers
41 4.1.6 GNU/C bitfields
42 4.1.7 Floating point
43 4.1.8 Enumerations
444.2 Compound types
45 4.2.1 Structures
46 4.2.2 Variants (Discriminated/Tagged Unions)
47 4.2.3 Arrays
48 4.2.4 Sequences
49 4.2.5 Strings
505. Event Packet Header
51 5.1 Event Packet Header Description
52 5.2 Event Packet Context Description
536. Event Structure
54 6.1 Event Header
55 6.1.1 Type 1 - Few event IDs
56 6.1.2 Type 2 - Many event IDs
57 6.2 Event Context
58 6.3 Event Payload
59 6.3.1 Padding
60 6.3.2 Alignment
617. Trace Stream Description Language (TSDL)
62 7.1 Meta-data
63 7.2 Declaration vs Definition
64 7.3 TSDL Scopes
65 7.3.1 Lexical Scope
37ab95c3 66 7.3.2 Static and Dynamic Scopes
beabf088 67 7.4 TSDL Examples
2fa70eba 688. Clocks
beabf088
MD
69
70
5ba9f198
MD
711. Preliminary definitions
72
3bf79539
MD
73 - Event Trace: An ordered sequence of events.
74 - Event Stream: An ordered sequence of events, containing a subset of the
75 trace event types.
76 - Event Packet: A sequence of physically contiguous events within an event
77 stream.
5ba9f198
MD
78 - Event: This is the basic entry in a trace. (aka: a trace record).
79 - An event identifier (ID) relates to the class (a type) of event within
3bf79539
MD
80 an event stream.
81 e.g. event: irq_entry.
5ba9f198
MD
82 - An event (or event record) relates to a specific instance of an event
83 class.
3bf79539
MD
84 e.g. event: irq_entry, at time X, on CPU Y
85 - Source Architecture: Architecture writing the trace.
86 - Reader Architecture: Architecture reading the trace.
5ba9f198
MD
87
88
892. High-level representation of a trace
90
3bf79539
MD
91A trace is divided into multiple event streams. Each event stream contains a
92subset of the trace event types.
5ba9f198 93
3bf79539
MD
94The final output of the trace, after its generation and optional transport over
95the network, is expected to be either on permanent or temporary storage in a
96virtual file system. Because each event stream is appended to while a trace is
32254806
MD
97being recorded, each is associated with a distinct set of files for
98output. Therefore, a stored trace can be represented as a directory
99containing zero, one or more files per stream.
5ba9f198 100
6672e9e1
MD
101Meta-data description associated with the trace contains information on
102trace event types expressed in the Trace Stream Description Language
103(TSDL). This language describes:
5ba9f198
MD
104
105- Trace version.
106- Types available.
6672e9e1 107- Per-trace event header description.
3bf79539 108- Per-stream event header description.
6672e9e1 109- Per-stream event context description.
5ba9f198 110- Per-event
3bf79539 111 - Event type to stream mapping.
5ba9f198
MD
112 - Event type to name mapping.
113 - Event type to ID mapping.
6672e9e1 114 - Event context description.
5ba9f198
MD
115 - Event fields description.
116
117
3bf79539 1183. Event stream
5ba9f198 119
6672e9e1
MD
120An event stream can be divided into contiguous event packets of variable
121size. These subdivisions have a variable size. An event packet can
122contain a certain amount of padding at the end. The stream header is
123repeated at the beginning of each event packet. The rationale for the
124event stream design choices is explained in Appendix B. Stream Header
125Rationale.
5ba9f198 126
3bf79539
MD
127The event stream header will therefore be referred to as the "event packet
128header" throughout the rest of this document.
5ba9f198
MD
129
130
1314. Types
132
1fad7a85
MD
133Types are organized as type classes. Each type class belong to either of two
134kind of types: basic types or compound types.
135
5ba9f198
MD
1364.1 Basic types
137
1fad7a85
MD
138A basic type is a scalar type, as described in this section. It includes
139integers, GNU/C bitfields, enumerations, and floating point values.
5ba9f198
MD
140
1414.1.1 Type inheritance
142
80fd2569
MD
143Type specifications can be inherited to allow deriving types from a
144type class. For example, see the uint32_t named type derived from the "integer"
145type class below ("Integers" section). Types have a precise binary
146representation in the trace. A type class has methods to read and write these
147types, but must be derived into a type to be usable in an event field.
5ba9f198
MD
148
1494.1.2 Alignment
150
151We define "byte-packed" types as aligned on the byte size, namely 8-bit.
152We define "bit-packed" types as following on the next bit, as defined by the
370eae99 153"Integers" section.
5ba9f198 154
6672e9e1 155Each basic type must specify its alignment, in bits. Examples of
ec4404a7
MD
156possible alignments are: bit-packed (align = 1), byte-packed (align =
1578), or word-aligned (e.g. align = 32 or align = 64). The choice depends
158on the architecture preference and compactness vs performance trade-offs
159of the implementation. Architectures providing fast unaligned write
160byte-packed basic types to save space, aligning each type on byte
161boundaries (8-bit). Architectures with slow unaligned writes align types
162on specific alignment values. If no specific alignment is declared for a
163type, it is assumed to be bit-packed for integers with size not multiple
164of 8 bits and for gcc bitfields. All other basic types are byte-packed
165by default. It is however recommended to always specify the alignment
166explicitly. Alignment values must be power of two. Compound types are
167aligned as specified in their individual specification.
5ba9f198 168
6672e9e1 169TSDL meta-data attribute representation of a specific alignment:
5ba9f198
MD
170
171 align = value; /* value in bits */
172
1734.1.3 Byte order
174
3bf79539
MD
175By default, the native endianness of the source architecture the trace is used.
176Byte order can be overridden for a basic type by specifying a "byte_order"
177attribute. Typical use-case is to specify the network byte order (big endian:
178"be") to save data captured from the network into the trace without conversion.
179If not specified, the byte order is native.
5ba9f198 180
6672e9e1 181TSDL meta-data representation:
5ba9f198
MD
182
183 byte_order = native OR network OR be OR le; /* network and be are aliases */
184
1854.1.4 Size
186
187Type size, in bits, for integers and floats is that returned by "sizeof()" in C
188multiplied by CHAR_BIT.
189We require the size of "char" and "unsigned char" types (CHAR_BIT) to be fixed
190to 8 bits for cross-endianness compatibility.
191
6672e9e1 192TSDL meta-data representation:
5ba9f198
MD
193
194 size = value; (value is in bits)
195
1964.1.5 Integers
197
6672e9e1
MD
198Signed integers are represented in two-complement. Integer alignment,
199size, signedness and byte ordering are defined in the TSDL meta-data.
200Integers aligned on byte size (8-bit) and with length multiple of byte
201size (8-bit) correspond to the C99 standard integers. In addition,
202integers with alignment and/or size that are _not_ a multiple of the
203byte size are permitted; these correspond to the C99 standard bitfields,
204with the added specification that the CTF integer bitfields have a fixed
205binary representation. A MIT-licensed reference implementation of the
206CTF portable bitfields is available at:
5ba9f198
MD
207
208 http://git.efficios.com/?p=babeltrace.git;a=blob;f=include/babeltrace/bitfield.h
209
210Binary representation of integers:
211
212- On little and big endian:
213 - Within a byte, high bits correspond to an integer high bits, and low bits
214 correspond to low bits.
215- On little endian:
216 - Integer across multiple bytes are placed from the less significant to the
217 most significant.
218 - Consecutive integers are placed from lower bits to higher bits (even within
219 a byte).
220- On big endian:
221 - Integer across multiple bytes are placed from the most significant to the
222 less significant.
223 - Consecutive integers are placed from higher bits to lower bits (even within
224 a byte).
225
226This binary representation is derived from the bitfield implementation in GCC
227for little and big endian. However, contrary to what GCC does, integers can
6672e9e1 228cross units boundaries (no padding is required). Padding can be explicitly
5ba9f198
MD
229added (see 4.1.6 GNU/C bitfields) to follow the GCC layout if needed.
230
6672e9e1 231TSDL meta-data representation:
5ba9f198 232
80fd2569 233 integer {
5ba9f198
MD
234 signed = true OR false; /* default false */
235 byte_order = native OR network OR be OR le; /* default native */
236 size = value; /* value in bits, no default */
237 align = value; /* value in bits */
56b77c06
MD
238 /* based used for pretty-printing output, default: decimal. */
239 base = decimal OR dec OR OR d OR i OR u OR 10 OR hexadecimal OR hex OR x OR X OR p OR 16
240 OR octal OR oct OR o OR 8 OR binary OR b OR 2;
13441bf5
MD
241 /* character encoding, default: none */
242 encoding = none or UTF8 or ASCII;
2152348f 243 }
5ba9f198 244
80fd2569 245Example of type inheritance (creation of a uint32_t named type):
5ba9f198 246
359894ac 247typealias integer {
9e4e34e9 248 size = 32;
5ba9f198
MD
249 signed = false;
250 align = 32;
38b8da21 251} := uint32_t;
5ba9f198 252
80fd2569 253Definition of a named 5-bit signed bitfield:
5ba9f198 254
359894ac 255typealias integer {
5ba9f198
MD
256 size = 5;
257 signed = true;
258 align = 1;
38b8da21 259} := int5_t;
5ba9f198 260
13441bf5
MD
261The character encoding field can be used to specify that the integer
262must be printed as a text character when read. e.g.:
263
264typealias integer {
265 size = 8;
266 align = 8;
267 signed = false;
268 encoding = UTF8;
269} := utf_char;
270
271
5ba9f198
MD
2724.1.6 GNU/C bitfields
273
274The GNU/C bitfields follow closely the integer representation, with a
275particularity on alignment: if a bitfield cannot fit in the current unit, the
80fd2569
MD
276unit is padded and the bitfield starts at the following unit. The unit size is
277defined by the size of the type "unit_type".
5ba9f198 278
6672e9e1 279TSDL meta-data representation:
80fd2569 280
d674f4b8 281 unit_type name:size;
80fd2569 282
5ba9f198
MD
283As an example, the following structure declared in C compiled by GCC:
284
285struct example {
286 short a:12;
287 short b:5;
288};
289
2152348f
MD
290The example structure is aligned on the largest element (short). The second
291bitfield would be aligned on the next unit boundary, because it would not fit in
292the current unit.
5ba9f198
MD
293
2944.1.7 Floating point
295
6672e9e1 296The floating point values byte ordering is defined in the TSDL meta-data.
5ba9f198
MD
297
298Floating point values follow the IEEE 754-2008 standard interchange formats.
299Description of the floating point values include the exponent and mantissa size
300in bits. Some requirements are imposed on the floating point values:
301
302- FLT_RADIX must be 2.
303- mant_dig is the number of digits represented in the mantissa. It is specified
304 by the ISO C99 standard, section 5.2.4, as FLT_MANT_DIG, DBL_MANT_DIG and
305 LDBL_MANT_DIG as defined by <float.h>.
306- exp_dig is the number of digits represented in the exponent. Given that
307 mant_dig is one bit more than its actual size in bits (leading 1 is not
308 needed) and also given that the sign bit always takes one bit, exp_dig can be
309 specified as:
310
311 - sizeof(float) * CHAR_BIT - FLT_MANT_DIG
312 - sizeof(double) * CHAR_BIT - DBL_MANT_DIG
313 - sizeof(long double) * CHAR_BIT - LDBL_MANT_DIG
314
6672e9e1 315TSDL meta-data representation:
5ba9f198 316
80fd2569 317floating_point {
ec4404a7
MD
318 exp_dig = value;
319 mant_dig = value;
320 byte_order = native OR network OR be OR le;
321 align = value;
2152348f 322}
5ba9f198
MD
323
324Example of type inheritance:
325
359894ac 326typealias floating_point {
5ba9f198
MD
327 exp_dig = 8; /* sizeof(float) * CHAR_BIT - FLT_MANT_DIG */
328 mant_dig = 24; /* FLT_MANT_DIG */
329 byte_order = native;
ec4404a7 330 align = 32;
38b8da21 331} := float;
5ba9f198
MD
332
333TODO: define NaN, +inf, -inf behavior.
334
ec4404a7
MD
335Bit-packed, byte-packed or larger alignments can be used for floating
336point values, similarly to integers.
337
5ba9f198
MD
3384.1.8 Enumerations
339
340Enumerations are a mapping between an integer type and a table of strings. The
341numerical representation of the enumeration follows the integer type specified
6672e9e1
MD
342by the meta-data. The enumeration mapping table is detailed in the enumeration
343description within the meta-data. The mapping table maps inclusive value
344ranges (or single values) to strings. Instead of being limited to simple
3bf79539 345"value -> string" mappings, these enumerations map
80fd2569 346"[ start_value ... end_value ] -> string", which map inclusive ranges of
3bf79539
MD
347values to strings. An enumeration from the C language can be represented in
348this format by having the same start_value and end_value for each element, which
349is in fact a range of size 1. This single-value range is supported without
4767a9e7 350repeating the start and end values with the value = string declaration.
80fd2569 351
a9b83695 352enum name : integer_type {
359894ac 353 somestring = start_value1 ... end_value1,
80fd2569
MD
354 "other string" = start_value2 ... end_value2,
355 yet_another_string, /* will be assigned to end_value2 + 1 */
356 "some other string" = value,
357 ...
358};
359
360If the values are omitted, the enumeration starts at 0 and increment of 1 for
361each entry:
362
a9b83695 363enum name : unsigned int {
80fd2569
MD
364 ZERO,
365 ONE,
366 TWO,
367 TEN = 10,
368 ELEVEN,
3bf79539 369};
5ba9f198 370
80fd2569 371Overlapping ranges within a single enumeration are implementation defined.
5ba9f198 372
2152348f
MD
373A nameless enumeration can be declared as a field type or as part of a typedef:
374
a9b83695 375enum : integer_type {
2152348f
MD
376 ...
377}
378
c2742c56
MD
379Enumerations omitting the container type ": integer_type" use the "int"
380type (for compatibility with C99). The "int" type must be previously
381declared. E.g.:
382
383typealias integer { size = 32; align = 32; signed = true } := int;
384
385enum {
386 ...
387}
388
1fad7a85 389
5ba9f198
MD
3904.2 Compound types
391
1fad7a85
MD
392Compound are aggregation of type declarations. Compound types include
393structures, variant, arrays, sequences, and strings.
394
5ba9f198
MD
3954.2.1 Structures
396
397Structures are aligned on the largest alignment required by basic types
398contained within the structure. (This follows the ISO/C standard for structures)
399
6672e9e1 400TSDL meta-data representation of a named structure:
5ba9f198 401
80fd2569
MD
402struct name {
403 field_type field_name;
404 field_type field_name;
405 ...
406};
5ba9f198
MD
407
408Example:
409
80fd2569
MD
410struct example {
411 integer { /* Nameless type */
412 size = 16;
413 signed = true;
414 align = 16;
415 } first_field_name;
6672e9e1 416 uint64_t second_field_name; /* Named type declared in the meta-data */
3bf79539 417};
5ba9f198 418
4cac83ee
MD
419The fields are placed in a sequence next to each other. They each
420possess a field name, which is a unique identifier within the structure.
421The identifier is not allowed to use any reserved keyword
422(see Section C.1.2). Replacing reserved keywords with
70375f92 423underscore-prefixed field names is recommended. Fields starting with an
92250c71
MD
424underscore should have their leading underscore removed by the CTF trace
425readers.
5ba9f198 426
2152348f 427A nameless structure can be declared as a field type or as part of a typedef:
80fd2569
MD
428
429struct {
430 ...
2152348f 431}
80fd2569 432
ec4404a7
MD
433Alignment for a structure compound type can be forced to a minimum value
434by adding an "align" specifier after the declaration of a structure
435body. This attribute is read as: align(value). The value is specified in
436bits. The structure will be aligned on the maximum value between this
437attribute and the alignment required by the basic types contained within
438the structure. e.g.
439
440struct {
441 ...
442} align(32)
443
77a98c82 4444.2.2 Variants (Discriminated/Tagged Unions)
fcba70d4 445
fdf2bb05
MD
446A CTF variant is a selection between different types. A CTF variant must
447always be defined within the scope of a structure or within fields
448contained within a structure (defined recursively). A "tag" enumeration
37ab95c3
MD
449field must appear in either the same static scope, prior to the variant
450field (in field declaration order), in an upper static scope , or in an
451upper dynamic scope (see Section 7.3.2). The type selection is indicated
452by the mapping from the enumeration value to the string used as variant
453type selector. The field to use as tag is specified by the "tag_field",
454specified between "< >" after the "variant" keyword for unnamed
455variants, and after "variant name" for named variants.
fcba70d4
MD
456
457The alignment of the variant is the alignment of the type as selected by the tag
458value for the specific instance of the variant. The alignment of the type
459containing the variant is independent of the variant alignment. The size of the
460variant is the size as selected by the tag value for the specific instance of
461the variant.
462
4cac83ee
MD
463Each variant type selector possess a field name, which is a unique
464identifier within the variant. The identifier is not allowed to use any
465reserved keyword (see Section C.1.2). Replacing reserved keywords with
70375f92 466underscore-prefixed field names is recommended. Fields starting with an
92250c71
MD
467underscore should have their leading underscore removed by the CTF trace
468readers.
70375f92 469
4cac83ee 470
fcba70d4
MD
471A named variant declaration followed by its definition within a structure
472declaration:
473
474variant name {
475 field_type sel1;
476 field_type sel2;
477 field_type sel3;
478 ...
479};
480
481struct {
a9b83695 482 enum : integer_type { sel1, sel2, sel3, ... } tag_field;
fcba70d4
MD
483 ...
484 variant name <tag_field> v;
485}
486
487An unnamed variant definition within a structure is expressed by the following
6672e9e1 488TSDL meta-data:
fcba70d4
MD
489
490struct {
a9b83695 491 enum : integer_type { sel1, sel2, sel3, ... } tag_field;
fcba70d4
MD
492 ...
493 variant <tag_field> {
494 field_type sel1;
495 field_type sel2;
496 field_type sel3;
497 ...
498 } v;
499}
500
501Example of a named variant within a sequence that refers to a single tag field:
502
503variant example {
504 uint32_t a;
505 uint64_t b;
506 short c;
507};
508
509struct {
a9b83695 510 enum : uint2_t { a, b, c } choice;
1ab22b2a
MD
511 unsigned int seqlen;
512 variant example <choice> v[seqlen];
fcba70d4
MD
513}
514
515Example of an unnamed variant:
516
517struct {
a9b83695 518 enum : uint2_t { a, b, c, d } choice;
fcba70d4
MD
519 /* Unrelated fields can be added between the variant and its tag */
520 int32_t somevalue;
521 variant <choice> {
522 uint32_t a;
523 uint64_t b;
524 short c;
525 struct {
526 unsigned int field1;
527 uint64_t field2;
528 } d;
529 } s;
530}
531
532Example of an unnamed variant within an array:
533
534struct {
a9b83695 535 enum : uint2_t { a, b, c } choice;
fcba70d4
MD
536 variant <choice> {
537 uint32_t a;
538 uint64_t b;
539 short c;
15850440 540 } v[10];
fcba70d4
MD
541}
542
543Example of a variant type definition within a structure, where the defined type
544is then declared within an array of structures. This variant refers to a tag
37ab95c3 545located in an upper static scope. This example clearly shows that a variant
fcba70d4 546type definition referring to the tag "x" uses the closest preceding field from
37ab95c3 547the static scope of the type definition.
fcba70d4
MD
548
549struct {
a9b83695 550 enum : uint2_t { a, b, c, d } x;
fcba70d4
MD
551
552 typedef variant <x> { /*
553 * "x" refers to the preceding "x" enumeration in the
37ab95c3 554 * static scope of the type definition.
fcba70d4
MD
555 */
556 uint32_t a;
557 uint64_t b;
558 short c;
559 } example_variant;
560
561 struct {
a9b83695 562 enum : int { x, y, z } x; /* This enumeration is not used by "v". */
fcba70d4 563 example_variant v; /*
a9b83695 564 * "v" uses the "enum : uint2_t { a, b, c, d }"
fcba70d4
MD
565 * tag.
566 */
567 } a[10];
568}
569
5704.2.3 Arrays
5ba9f198 571
6672e9e1
MD
572Arrays are fixed-length. Their length is declared in the type
573declaration within the meta-data. They contain an array of "inner type"
574elements, which can refer to any type not containing the type of the
575array being declared (no circular dependency). The length is the number
576of elements in an array.
5ba9f198 577
6672e9e1 578TSDL meta-data representation of a named array:
80fd2569
MD
579
580typedef elem_type name[length];
5ba9f198 581
2152348f 582A nameless array can be declared as a field type within a structure, e.g.:
5ba9f198 583
2152348f 584 uint8_t field_name[10];
80fd2569 585
ec4404a7 586Arrays are always aligned on their element alignment requirement.
5ba9f198 587
fcba70d4 5884.2.4 Sequences
5ba9f198 589
1ab22b2a 590Sequences are dynamically-sized arrays. They refer to a a "length"
37ab95c3 591unsigned integer field, which must appear in either the same static scope,
1ab22b2a 592prior to the sequence field (in field declaration order), in an upper
37ab95c3
MD
593static scope, or in an upper dynamic scope (see Section 7.3.2). This
594length field represents the number of elements in the sequence. The
595sequence per se is an array of "inner type" elements.
5ba9f198 596
1ab22b2a 597TSDL meta-data representation for a sequence type definition:
80fd2569 598
1ab22b2a
MD
599struct {
600 unsigned int length_field;
601 typedef elem_type typename[length_field];
602 typename seq_field_name;
603}
604
605A sequence can also be declared as a field type, e.g.:
80fd2569 606
1ab22b2a
MD
607struct {
608 unsigned int length_field;
609 long seq_field_name[length_field];
610}
80fd2569 611
1ab22b2a
MD
612Multiple sequences can refer to the same length field, and these length
613fields can be in a different upper dynamic scope:
614
615e.g., assuming the stream.event.header defines:
616
617stream {
618 ...
619 id = 1;
620 event.header := struct {
621 uint16_t seq_len;
622 };
623};
624
625event {
626 ...
627 stream_id = 1;
628 fields := struct {
629 long seq_a[stream.event.header.seq_len];
630 char seq_b[stream.event.header.seq_len];
631 };
632};
80fd2569 633
1ab22b2a 634The sequence elements follow the "array" specifications.
5ba9f198 635
fcba70d4 6364.2.5 Strings
5ba9f198
MD
637
638Strings are an array of bytes of variable size and are terminated by a '\0'
6672e9e1
MD
639"NULL" character. Their encoding is described in the TSDL meta-data. In
640absence of encoding attribute information, the default encoding is
641UTF-8.
5ba9f198 642
6672e9e1 643TSDL meta-data representation of a named string type:
80fd2569 644
359894ac 645typealias string {
5ba9f198 646 encoding = UTF8 OR ASCII;
38b8da21 647} := name;
5ba9f198 648
80fd2569
MD
649A nameless string type can be declared as a field type:
650
651string field_name; /* Use default UTF8 encoding */
5ba9f198 652
ec4404a7
MD
653Strings are always aligned on byte size.
654
3bf79539
MD
6555. Event Packet Header
656
6672e9e1
MD
657The event packet header consists of two parts: the "event packet header"
658is the same for all streams of a trace. The second part, the "event
659packet context", is described on a per-stream basis. Both are described
660in the TSDL meta-data. The packets are aligned on architecture-page-sized
661addresses.
3bf79539 662
6672e9e1 663Event packet header (all fields are optional, specified by TSDL meta-data):
3bf79539 664
6672e9e1
MD
665- Magic number (CTF magic number: 0xC1FC1FC1) specifies that this is a
666 CTF packet. This magic number is optional, but when present, it should
667 come at the very beginning of the packet.
668- Trace UUID, used to ensure the event packet match the meta-data used.
669 (note: we cannot use a meta-data checksum in every cases instead of a
670 UUID because meta-data can be appended to while tracing is active)
671 This field is optional.
672- Stream ID, used as reference to stream description in meta-data.
673 This field is optional if there is only one stream description in the
674 meta-data, but becomes required if there are more than one stream in
675 the TSDL meta-data description.
3bf79539 676
6672e9e1 677Event packet context (all fields are optional, specified by TSDL meta-data):
3bf79539 678
4dfca05b
MD
679- Event packet content size (in bits).
680- Event packet size (in bits, includes padding).
cda89682 681- Event packet content checksum. Checksum excludes the event packet
3bf79539
MD
682 header.
683- Per-stream event packet sequence count (to deal with UDP packet loss). The
684 number of significant sequence counter bits should also be present, so
b11853af 685 wrap-arounds are dealt with correctly.
6672e9e1 686- Time-stamp at the beginning and time-stamp at the end of the event packet.
3bf79539
MD
687 Both timestamps are written in the packet header, but sampled respectively
688 while (or before) writing the first event and while (or after) writing the
689 last event in the packet. The inclusive range between these timestamps should
690 include all event timestamps assigned to events contained within the packet.
5ba9f198 691- Events discarded count
3bf79539
MD
692 - Snapshot of a per-stream free-running counter, counting the number of
693 events discarded that were supposed to be written in the stream prior to
694 the first event in the event packet.
5ba9f198 695 * Note: producer-consumer buffer full condition should fill the current
3bf79539 696 event packet with padding so we know exactly where events have been
5ba9f198 697 discarded.
3bf79539
MD
698- Lossless compression scheme used for the event packet content. Applied
699 directly to raw data. New types of compression can be added in following
700 versions of the format.
5ba9f198
MD
701 0: no compression scheme
702 1: bzip2
703 2: gzip
3bf79539
MD
704 3: xz
705- Cypher used for the event packet content. Applied after compression.
5ba9f198
MD
706 0: no encryption
707 1: AES
3bf79539 708- Checksum scheme used for the event packet content. Applied after encryption.
5ba9f198
MD
709 0: no checksum
710 1: md5
711 2: sha1
712 3: crc32
713
6672e9e1 7145.1 Event Packet Header Description
3bf79539 715
fc5425db 716The event packet header layout is indicated by the trace packet.header
6672e9e1
MD
717field. Here is a recommended structure type for the packet header with
718the fields typically expected (although these fields are each optional):
fc5425db 719
80fd2569
MD
720struct event_packet_header {
721 uint32_t magic;
3fde5da1 722 uint8_t uuid[16];
3bf79539 723 uint32_t stream_id;
80fd2569 724};
5ba9f198 725
fc5425db
MD
726trace {
727 ...
728 packet.header := struct event_packet_header;
729};
730
6672e9e1
MD
731If the magic number is not present, tools such as "file" will have no
732mean to discover the file type.
733
3fde5da1
MD
734If the uuid is not present, no validation that the meta-data actually
735corresponds to the stream is performed.
37b39e47
MD
736
737If the stream_id packet header field is missing, the trace can only
738contain a single stream. Its "id" field can be left out, and its events
739don't need to declare a "stream_id" field.
740
741
3bf79539
MD
7425.2 Event Packet Context Description
743
744Event packet context example. These are declared within the stream declaration
6672e9e1 745in the meta-data. All these fields are optional. If the packet size field is
6a7c61df 746missing, the whole stream only contains a single packet. If the content
f6b81726
MD
747size field is missing, the packet is filled (no padding). The content
748and packet sizes include all headers.
3bf79539
MD
749
750An example event packet context type:
751
80fd2569 752struct event_packet_context {
3bf79539
MD
753 uint64_t timestamp_begin;
754 uint64_t timestamp_end;
755 uint32_t checksum;
756 uint32_t stream_packet_count;
757 uint32_t events_discarded;
758 uint32_t cpu_id;
759 uint32_t/uint16_t content_size;
760 uint32_t/uint16_t packet_size;
3bf79539
MD
761 uint8_t compression_scheme;
762 uint8_t encryption_scheme;
3b0f8e4d 763 uint8_t checksum_scheme;
3bf79539 764};
5ba9f198 765
fcba70d4 766
5ba9f198
MD
7676. Event Structure
768
769The overall structure of an event is:
770
6672e9e1
MD
7711 - Stream Packet Context (as specified by the stream meta-data)
772 2 - Event Header (as specified by the stream meta-data)
773 3 - Stream Event Context (as specified by the stream meta-data)
774 4 - Event Context (as specified by the event meta-data)
775 5 - Event Payload (as specified by the event meta-data)
5ba9f198 776
fdf2bb05 777This structure defines an implicit dynamic scoping, where variants
7d9d7e92
MD
778located in inner structures (those with a higher number in the listing
779above) can refer to the fields of outer structures (with lower number in
6c7226e9 780the listing above). See Section 7.3 TSDL Scopes for more detail.
5ba9f198 781
fdf2bb05 7826.1 Event Header
fcba70d4 783
6672e9e1 784Event headers can be described within the meta-data. We hereby propose, as an
fcba70d4
MD
785example, two types of events headers. Type 1 accommodates streams with less than
78631 event IDs. Type 2 accommodates streams with 31 or more event IDs.
5ba9f198 787
3bf79539
MD
788One major factor can vary between streams: the number of event IDs assigned to
789a stream. Luckily, this information tends to stay relatively constant (modulo
5ba9f198 790event registration while trace is being recorded), so we can specify different
3bf79539 791representations for streams containing few event IDs and streams containing
6672e9e1
MD
792many event IDs, so we end up representing the event ID and time-stamp as
793densely as possible in each case.
5ba9f198 794
fcba70d4
MD
795The header is extended in the rare occasions where the information cannot be
796represented in the ranges available in the standard event header. They are also
3bf79539
MD
797used in the rare occasions where the data required for a field could not be
798collected: the flag corresponding to the missing field within the missing_fields
799array is then set to 1.
5ba9f198 800
6672e9e1
MD
801Types uintX_t represent an X-bit unsigned integer, as declared with
802either:
5ba9f198 803
6672e9e1
MD
804 typealias integer { size = X; align = X; signed = false } := uintX_t;
805
806 or
807
808 typealias integer { size = X; align = 1; signed = false } := uintX_t;
5ba9f198 809
fdf2bb05 8106.1.1 Type 1 - Few event IDs
5ba9f198
MD
811
812 - Aligned on 32-bit (or 8-bit if byte-packed, depending on the architecture
813 preference).
5ba9f198 814 - Native architecture byte ordering.
fcba70d4
MD
815 - For "compact" selection
816 - Fixed size: 32 bits.
817 - For "extended" selection
818 - Size depends on the architecture and variant alignment.
5ba9f198 819
80fd2569 820struct event_header_1 {
fcba70d4
MD
821 /*
822 * id: range: 0 - 30.
823 * id 31 is reserved to indicate an extended header.
824 */
a9b83695 825 enum : uint5_t { compact = 0 ... 30, extended = 31 } id;
fcba70d4
MD
826 variant <id> {
827 struct {
828 uint27_t timestamp;
829 } compact;
830 struct {
831 uint32_t id; /* 32-bit event IDs */
832 uint64_t timestamp; /* 64-bit timestamps */
833 } extended;
834 } v;
cb108fea 835} align(32); /* or align(8) */
5ba9f198 836
5ba9f198 837
fdf2bb05 8386.1.2 Type 2 - Many event IDs
5ba9f198 839
fcba70d4 840 - Aligned on 16-bit (or 8-bit if byte-packed, depending on the architecture
5ba9f198 841 preference).
5ba9f198 842 - Native architecture byte ordering.
fcba70d4
MD
843 - For "compact" selection
844 - Size depends on the architecture and variant alignment.
845 - For "extended" selection
846 - Size depends on the architecture and variant alignment.
5ba9f198 847
80fd2569 848struct event_header_2 {
fcba70d4
MD
849 /*
850 * id: range: 0 - 65534.
851 * id 65535 is reserved to indicate an extended header.
852 */
a9b83695 853 enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;
fcba70d4
MD
854 variant <id> {
855 struct {
856 uint32_t timestamp;
857 } compact;
858 struct {
859 uint32_t id; /* 32-bit event IDs */
860 uint64_t timestamp; /* 64-bit timestamps */
861 } extended;
862 } v;
cb108fea 863} align(16); /* or align(8) */
5ba9f198 864
5ba9f198
MD
865
8666.2 Event Context
867
6672e9e1
MD
868The event context contains information relative to the current event.
869The choice and meaning of this information is specified by the TSDL
870stream and event meta-data descriptions. The stream context is applied
871to all events within the stream. The stream context structure follows
872the event header. The event context is applied to specific events. Its
873structure follows the stream context structure.
5ba9f198 874
fcba70d4
MD
875An example of stream-level event context is to save the event payload size with
876each event, or to save the current PID with each event. These are declared
6672e9e1 877within the stream declaration within the meta-data:
5ba9f198 878
fcba70d4
MD
879 stream {
880 ...
6672e9e1 881 event.context := struct {
80fd2569
MD
882 uint pid;
883 uint16_t payload_size;
6672e9e1 884 };
fcba70d4
MD
885 };
886
887An example of event-specific event context is to declare a bitmap of missing
888fields, only appended after the stream event context if the extended event
889header is selected. NR_FIELDS is the number of fields within the event (a
890numeric value).
5ba9f198 891
fcba70d4
MD
892 event {
893 context = struct {
894 variant <id> {
895 struct { } compact;
896 struct {
897 uint1_t missing_fields[NR_FIELDS]; /* missing event fields bitmap */
898 } extended;
899 } v;
900 };
901 ...
902 }
5ba9f198
MD
903
9046.3 Event Payload
905
906An event payload contains fields specific to a given event type. The fields
6672e9e1 907belonging to an event type are described in the event-specific meta-data
5ba9f198
MD
908within a structure type.
909
9106.3.1 Padding
911
912No padding at the end of the event payload. This differs from the ISO/C standard
913for structures, but follows the CTF standard for structures. In a trace, even
914though it makes sense to align the beginning of a structure, it really makes no
915sense to add padding at the end of the structure, because structures are usually
916not followed by a structure of the same type.
917
918This trick can be done by adding a zero-length "end" field at the end of the C
919structures, and by using the offset of this field rather than using sizeof()
3bf79539 920when calculating the size of a structure (see Appendix "A. Helper macros").
5ba9f198
MD
921
9226.3.2 Alignment
923
924The event payload is aligned on the largest alignment required by types
925contained within the payload. (This follows the ISO/C standard for structures)
926
927
6c7226e9
MD
9287. Trace Stream Description Language (TSDL)
929
930The Trace Stream Description Language (TSDL) allows expression of the
931binary trace streams layout in a C99-like Domain Specific Language
932(DSL).
933
934
6672e9e1 9357.1 Meta-data
6c7226e9
MD
936
937The trace stream layout description is located in the trace meta-data.
938The meta-data is itself located in a stream identified by its name:
939"metadata".
5ba9f198 940
6672e9e1
MD
941The meta-data description can be expressed in two different formats:
942text-only and packet-based. The text-only description facilitates
943generation of meta-data and provides a convenient way to enter the
944meta-data information by hand. The packet-based meta-data provides the
945CTF stream packet facilities (checksumming, compression, encryption,
946network-readiness) for meta-data stream generated and transported by a
947tracer.
948
1b4d35eb
MD
949The text-only meta-data file is a plain-text TSDL description. This file
950must begin with the following characters to identify the file as a CTF
9486a18c 951TSDL text-based metadata file (without the double-quotes) :
1b4d35eb 952
ec2b4db8 953"/* CTF"
1b4d35eb 954
ec2b4db8
MD
955It must be followed by a space, and the version of the specification
956followed by the CTF trace, e.g.:
957
958" 1.8"
959
960These characters allow automated discovery of file type and CTF
961specification version. They are interpreted as a the beginning of a
962comment by the TSDL metadata parser. The comment can be continued to
963contain extra commented characters before it is closed.
6672e9e1
MD
964
965The packet-based meta-data is made of "meta-data packets", which each
966start with a meta-data packet header. The packet-based meta-data
967description is detected by reading the magic number "0x75D11D57" at the
968beginning of the file. This magic number is also used to detect the
969endianness of the architecture by trying to read the CTF magic number
970and its counterpart in reversed endianness. The events within the
971meta-data stream have no event header nor event context. Each event only
5ae2352d 972contains a "sequence" payload, which is a sequence of bits using the
ce2228da
MD
973"trace.packet.header.content_size" field as a placeholder for its length
974(the packet header size should be substracted). The formatting of this
975sequence of bits is a plain-text representation of the TSDL description.
976Each meta-data packet start with a special packet header, specific to
977the meta-data stream, which contains, exactly:
6672e9e1
MD
978
979struct metadata_packet_header {
2daeaa3a 980 uint32_t magic; /* 0x75D11D57 */
3fde5da1 981 uint8_t uuid[16]; /* Unique Universal Identifier */
6672e9e1
MD
982 uint32_t checksum; /* 0 if unused */
983 uint32_t content_size; /* in bits */
984 uint32_t packet_size; /* in bits */
985 uint8_t compression_scheme; /* 0 if unused */
986 uint8_t encryption_scheme; /* 0 if unused */
987 uint8_t checksum_scheme; /* 0 if unused */
ec2b4db8
MD
988 uint8_t major; /* CTF spec version major number */
989 uint8_t minor; /* CTF spec version minor number */
6672e9e1
MD
990};
991
992The packet-based meta-data can be converted to a text-only meta-data by
993concatenating all the strings in contains.
4fafe1ad 994
6672e9e1
MD
995In the textual representation of the meta-data, the text contained
996within "/*" and "*/", as well as within "//" and end of line, are
997treated as comments. Boolean values can be represented as true, TRUE,
998or 1 for true, and false, FALSE, or 0 for false. Within the string-based
999meta-data description, the trace UUID is represented as a string of
1000hexadecimal digits and dashes "-". In the event packet header, the trace
1001UUID is represented as an array of bytes.
fcba70d4 1002
fdf2bb05 1003
6c7226e9 10047.2 Declaration vs Definition
fdf2bb05
MD
1005
1006A declaration associates a layout to a type, without specifying where
1007this type is located in the event structure hierarchy (see Section 6).
1008This therefore includes typedef, typealias, as well as all type
1009specifiers. In certain circumstances (typedef, structure field and
1010variant field), a declaration is followed by a declarator, which specify
1011the newly defined type name (for typedef), or the field name (for
1012declarations located within structure and variants). Array and sequence,
1013declared with square brackets ("[" "]"), are part of the declarator,
a9b83695 1014similarly to C99. The enumeration base type is specified by
6c7226e9 1015": enum_base", which is part of the type specifier. The variant tag
a9b83695 1016name, specified between "<" ">", is also part of the type specifier.
fdf2bb05
MD
1017
1018A definition associates a type to a location in the event structure
b9606a77
MD
1019hierarchy (see Section 6). This association is denoted by ":=", as shown
1020in Section 7.3.
fdf2bb05
MD
1021
1022
6c7226e9 10237.3 TSDL Scopes
fdf2bb05 1024
37ab95c3
MD
1025TSDL uses three different types of scoping: a lexical scope is used for
1026declarations and type definitions, and static and dynamic scopes are
1027used for variants references to tag fields (with relative and absolute
1028path lookups) and for sequence references to length fields.
fdf2bb05 1029
6c7226e9 10307.3.1 Lexical Scope
fdf2bb05 1031
d285084f
MD
1032Each of "trace", "stream", "event", "struct" and "variant" have their own
1033nestable declaration scope, within which types can be declared using "typedef"
fdf2bb05 1034and "typealias". A root declaration scope also contains all declarations
7d9d7e92 1035located outside of any of the aforementioned declarations. An inner
fdf2bb05 1036declaration scope can refer to type declared within its container
7d9d7e92
MD
1037lexical scope prior to the inner declaration scope. Redefinition of a
1038typedef or typealias is not valid, although hiding an upper scope
fdf2bb05
MD
1039typedef or typealias is allowed within a sub-scope.
1040
37ab95c3 10417.3.2 Static and Dynamic Scopes
fdf2bb05 1042
37ab95c3
MD
1043A local static scope consists in the scope generated by the declaration
1044of fields within a compound type. A static scope is a local static scope
1045augmented with the nested sub-static-scopes it contains.
1046
1047A dynamic scope consists in the static scope augmented with the
7d9d7e92 1048implicit event structure definition hierarchy presented at Section 6.
fdf2bb05 1049
37ab95c3
MD
1050Multiple declarations of the same field name within a local static scope
1051is not valid. It is however valid to re-use the same field name in
1052different local scopes.
1053
1054Nested static and dynamic scopes form lookup paths. These are used for
1055variant tag and sequence length references. They are used at the variant
1056and sequence definition site to look up the location of the tag field
1057associated with a variant, and to lookup up the location of the length
1058field associated with a sequence.
1059
1060Variants and sequences can refer to a tag field either using a relative
4cac83ee
MD
1061path or an absolute path. The relative path is relative to the scope in
1062which the variant or sequence performing the lookup is located.
37ab95c3
MD
1063Relative paths are only allowed to lookup within the same static scope,
1064which includes its nested static scopes. Lookups targeting parent static
1065scopes need to be performed with an absolute path.
1066
1067Absolute path lookups use the full path including the dynamic scope
1068followed by a "." and then the static scope. Therefore, variants (or
1069sequences) in lower levels in the dynamic scope (e.g. event context) can
1070refer to a tag (or length) field located in upper levels (e.g. in the
1071event header) by specifying, in this case, the associated tag with
1072<stream.event.header.field_name>. This allows, for instance, the event
1073context to define a variant referring to the "id" field of the event
1074header as selector.
1075
284724ae 1076The dynamic scope prefixes are thus:
fdf2bb05 1077
e0d9e2c7 1078 - Trace Packet Header: <trace.packet.header. >,
7d9d7e92
MD
1079 - Stream Packet Context: <stream.packet.context. >,
1080 - Event Header: <stream.event.header. >,
1081 - Stream Event Context: <stream.event.context. >,
1082 - Event Context: <event.context. >,
1083 - Event Payload: <event.fields. >.
fdf2bb05 1084
37ab95c3
MD
1085
1086The target dynamic scope must be specified explicitly when referring to
4cac83ee
MD
1087a field outside of the static scope (absolute scope reference). No
1088conflict can occur between relative and dynamic paths, because the
1089keywords "trace", "stream", and "event" are reserved, and thus
1090not permitted as field names. It is recommended that field names
1091clashing with CTF and C99 reserved keywords use an underscore prefix to
1092eliminate the risk of generating a description containing an invalid
70375f92 1093field name. Consequently, fields starting with an underscore should have
92250c71 1094their leading underscore removed by the CTF trace readers.
70375f92 1095
fdf2bb05 1096
457d8b0a
MD
1097The information available in the dynamic scopes can be thought of as the
1098current tracing context. At trace production, information about the
1099current context is saved into the specified scope field levels. At trace
1100consumption, for each event, the current trace context is therefore
1101readable by accessing the upper dynamic scopes.
1102
fdf2bb05 1103
6c7226e9 11047.4 TSDL Examples
d285084f 1105
6672e9e1 1106The grammar representing the TSDL meta-data is presented in Appendix C.
7df6b93a 1107TSDL Grammar. This section presents a rather lighter reading that
6672e9e1 1108consists in examples of TSDL meta-data, with template values.
969f30c0 1109
350bb633
MD
1110The stream "id" can be left out if there is only one stream in the
1111trace. The event "id" field can be left out if there is only one event
1112in a stream.
1113
5ba9f198 1114trace {
fdf2bb05 1115 major = value; /* Trace format version */
5ba9f198 1116 minor = value;
fdf2bb05 1117 uuid = "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"; /* Trace UUID */
58997e9e 1118 byte_order = be OR le; /* Endianness (required) */
fc5425db
MD
1119 packet.header := struct {
1120 uint32_t magic;
3fde5da1 1121 uint8_t uuid[16];
fc5425db
MD
1122 uint32_t stream_id;
1123 };
3bf79539 1124};
5ba9f198 1125
3bf79539
MD
1126stream {
1127 id = stream_id;
fdf2bb05 1128 /* Type 1 - Few event IDs; Type 2 - Many event IDs. See section 6.1. */
4fa992a5
MD
1129 event.header := event_header_1 OR event_header_2;
1130 event.context := struct {
77a98c82 1131 ...
3bf79539 1132 };
4fa992a5 1133 packet.context := struct {
77a98c82 1134 ...
3bf79539
MD
1135 };
1136};
5ba9f198
MD
1137
1138event {
980015f9 1139 name = "event_name";
3bf79539 1140 id = value; /* Numeric identifier within the stream */
67f02e24 1141 stream_id = stream_id;
980015f9
MD
1142 loglevel.identifier = "loglevel_identifier";
1143 loglevel.value = value;
4fa992a5 1144 context := struct {
fcba70d4
MD
1145 ...
1146 };
4fa992a5 1147 fields := struct {
80fd2569
MD
1148 ...
1149 };
3bf79539 1150};
5ba9f198
MD
1151
1152/* More detail on types in section 4. Types */
1153
3d13ef1a
MD
1154/*
1155 * Named types:
1156 *
4fa992a5 1157 * Type declarations behave similarly to the C standard.
3d13ef1a
MD
1158 */
1159
80af8ac6 1160typedef aliased_type_specifiers new_type_declarators;
2152348f 1161
3d13ef1a 1162/* e.g.: typedef struct example new_type_name[10]; */
80fd2569 1163
4fa992a5
MD
1164/*
1165 * typealias
1166 *
1167 * The "typealias" declaration can be used to give a name (including
80af8ac6
MD
1168 * pointer declarator specifier) to a type. It should also be used to
1169 * map basic C types (float, int, unsigned long, ...) to a CTF type.
1170 * Typealias is a superset of "typedef": it also allows assignment of a
38b8da21 1171 * simple variable identifier to a type.
4fa992a5
MD
1172 */
1173
1174typealias type_class {
80fd2569 1175 ...
38b8da21 1176} := type_specifiers type_declarator;
2152348f 1177
3d13ef1a
MD
1178/*
1179 * e.g.:
4fa992a5 1180 * typealias integer {
3d13ef1a
MD
1181 * size = 32;
1182 * align = 32;
1183 * signed = false;
38b8da21 1184 * } := struct page *;
359894ac
MD
1185 *
1186 * typealias integer {
1187 * size = 32;
1188 * align = 32;
1189 * signed = true;
38b8da21 1190 * } := int;
3d13ef1a 1191 */
80fd2569
MD
1192
1193struct name {
3bf79539
MD
1194 ...
1195};
5ba9f198 1196
fcba70d4
MD
1197variant name {
1198 ...
1199};
1200
a9b83695 1201enum name : integer_type {
3bf79539
MD
1202 ...
1203};
1204
2152348f 1205
4fa992a5
MD
1206/*
1207 * Unnamed types, contained within compound type fields, typedef or typealias.
1208 */
2152348f 1209
80fd2569
MD
1210struct {
1211 ...
2152348f 1212}
5ba9f198 1213
ec4404a7
MD
1214struct {
1215 ...
1216} align(value)
1217
fcba70d4
MD
1218variant {
1219 ...
1220}
1221
a9b83695 1222enum : integer_type {
80fd2569 1223 ...
2152348f
MD
1224}
1225
1226typedef type new_type[length];
3bf79539 1227
2152348f
MD
1228struct {
1229 type field_name[length];
1230}
1231
1232typedef type new_type[length_type];
1233
1234struct {
1235 type field_name[length_type];
1236}
1237
1238integer {
80fd2569 1239 ...
2152348f 1240}
3bf79539 1241
2152348f 1242floating_point {
80fd2569 1243 ...
2152348f
MD
1244}
1245
1246struct {
1247 integer_type field_name:size; /* GNU/C bitfield */
1248}
1249
1250struct {
1251 string field_name;
1252}
3bf79539 1253
fcba70d4 1254
2fa70eba
MD
12558. Clocks
1256
1257Clock metadata allows to describe the clock topology of the system, as
1258well as to detail each clock parameter. In absence of clock description,
1259it is assumed that all fields named "timestamp" use the same clock
aed18b5e 1260source, which increments once per nanosecond.
2fa70eba
MD
1261
1262Describing a clock and how it is used by streams is threefold: first,
1263the clock and clock topology should be described in a "clock"
1264description block, e.g.:
1265
d803bfcb 1266clock {
58262d97 1267 name = cycle_counter_sync;
2fa70eba 1268 uuid = "62189bee-96dc-11e0-91a8-cfa3d89f3923";
58262d97 1269 description = "Cycle counter synchronized across CPUs";
2fa70eba
MD
1270 freq = 1000000000; /* frequency, in Hz */
1271 /* precision in seconds is: 1000 * (1/freq) */
1272 precision = 1000;
a40cccda
MD
1273 /*
1274 * clock value offset from Epoch is:
1275 * offset_s + (offset * (1/freq))
1276 */
1277 offset_s = 1326476837;
1278 offset = 897235420;
ce0fadbd 1279 absolute = FALSE;
2fa70eba
MD
1280};
1281
d803bfcb
MD
1282The mandatory "name" field specifies the name of the clock identifier,
1283which can later be used as a reference. The optional field "uuid" is the
1284unique identifier of the clock. It can be used to correlate different
1285traces that use the same clock. An optional textual description string
1286can be added with the "description" field. The "freq" field is the
1287initial frequency of the clock, in Hz. If the "freq" field is not
1288present, the frequency is assumed to be 1000000000 (providing clock
1289increment of 1 ns). The optional "precision" field details the
a40cccda
MD
1290uncertainty on the clock measurements, in (1/freq) units. The "offset_s"
1291and "offset" fields indicate the offset from POSIX.1 Epoch, 1970-01-01
129200:00:00 +0000 (UTC), to the zero of value of the clock. The "offset_s"
1293field is in seconds. The "offset" field is in (1/freq) units. If any of
1294the "offset_s" or "offset" field is not present, it is assigned the 0
ce0fadbd
MD
1295value. The field "absolute" is TRUE if the clock is a global reference
1296across different clock uuid (e.g. NTP time). Otherwise, "absolute" is
1297FALSE, and the clock can be considered as synchronized only with other
1298clocks that have the same uuid.
1299
2fa70eba
MD
1300
1301Secondly, a reference to this clock should be added within an integer
1302type:
1303
1304typealias integer {
1305 size = 64; align = 1; signed = false;
58262d97 1306 map = clock.cycle_counter_sync.value;
2fa70eba
MD
1307} := uint64_ccnt_t;
1308
1309Thirdly, stream declarations can reference the clock they use as a
1310time-stamp source:
1311
1312struct packet_context {
1313 uint64_ccnt_t ccnt_begin;
1314 uint64_ccnt_t ccnt_end;
1315 /* ... */
1316};
1317
1318stream {
1319 /* ... */
1320 event.header := struct {
1321 uint64_ccnt_t timestamp;
1322 /* ... */
1323 }
1324 packet.context := struct packet_context;
1325};
1326
1327For a N-bit integer type referring to a clock, if the integer overflows
1328compared to the N low order bits of the clock prior value, then it is
1329assumed that one, and only one, overflow occurred. It is therefore
1330important that events encoding time on a small number of bits happen
1331frequently enough to detect when more than one N-bit overflow occurs.
1332
1333In a packet context, clock field names ending with "_begin" and "_end"
1334have a special meaning: this refers to the time-stamps at, respectively,
1335the beginning and the end of each packet.
1336
1337
3bf79539 1338A. Helper macros
5ba9f198
MD
1339
1340The two following macros keep track of the size of a GNU/C structure without
1341padding at the end by placing HEADER_END as the last field. A one byte end field
1342is used for C90 compatibility (C99 flexible arrays could be used here). Note
1343that this does not affect the effective structure size, which should always be
1344calculated with the header_sizeof() helper.
1345
1346#define HEADER_END char end_field
1347#define header_sizeof(type) offsetof(typeof(type), end_field)
3bf79539
MD
1348
1349
1350B. Stream Header Rationale
1351
1352An event stream is divided in contiguous event packets of variable size. These
1353subdivisions allow the trace analyzer to perform a fast binary search by time
1354within the stream (typically requiring to index only the event packet headers)
1355without reading the whole stream. These subdivisions have a variable size to
1356eliminate the need to transfer the event packet padding when partially filled
1357event packets must be sent when streaming a trace for live viewing/analysis.
1358An event packet can contain a certain amount of padding at the end. Dividing
1359streams into event packets is also useful for network streaming over UDP and
1360flight recorder mode tracing (a whole event packet can be swapped out of the
1361buffer atomically for reading).
1362
1363The stream header is repeated at the beginning of each event packet to allow
1364flexibility in terms of:
1365
1366 - streaming support,
1367 - allowing arbitrary buffers to be discarded without making the trace
1368 unreadable,
1369 - allow UDP packet loss handling by either dealing with missing event packet
1370 or asking for re-transmission.
1371 - transparently support flight recorder mode,
1372 - transparently support crash dump.
1373
6c7226e9
MD
1374
1375C. TSDL Grammar
fcba70d4 1376
4fa992a5 1377/*
6c7226e9 1378 * Common Trace Format (CTF) Trace Stream Description Language (TSDL) Grammar.
4fa992a5
MD
1379 *
1380 * Inspired from the C99 grammar:
1381 * http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1124.pdf (Annex A)
6c7226e9
MD
1382 * and c++1x grammar (draft)
1383 * http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2011/n3291.pdf (Annex A)
4fa992a5
MD
1384 *
1385 * Specialized for CTF needs by including only constant and declarations from
1386 * C99 (excluding function declarations), and by adding support for variants,
6c7226e9
MD
1387 * sequences and CTF-specific specifiers. Enumeration container types
1388 * semantic is inspired from c++1x enum-base.
4fa992a5
MD
1389 */
1390
13911) Lexical grammar
1392
13931.1) Lexical elements
1394
1395token:
1396 keyword
1397 identifier
1398 constant
1399 string-literal
1400 punctuator
1401
14021.2) Keywords
1403
1404keyword: is one of
1405
ec4404a7 1406align
4fa992a5
MD
1407const
1408char
2fa70eba 1409clock
4fa992a5
MD
1410double
1411enum
1412event
1413floating_point
1414float
1415integer
1416int
1417long
1418short
1419signed
1420stream
1421string
1422struct
1423trace
3e1e1a78 1424typealias
4fa992a5
MD
1425typedef
1426unsigned
1427variant
1428void
1429_Bool
1430_Complex
1431_Imaginary
1432
1433
14341.3) Identifiers
1435
1436identifier:
1437 identifier-nondigit
1438 identifier identifier-nondigit
1439 identifier digit
1440
1441identifier-nondigit:
1442 nondigit
1443 universal-character-name
1444 any other implementation-defined characters
1445
1446nondigit:
1447 _
1448 [a-zA-Z] /* regular expression */
1449
1450digit:
1451 [0-9] /* regular expression */
1452
14531.4) Universal character names
1454
1455universal-character-name:
1456 \u hex-quad
1457 \U hex-quad hex-quad
1458
1459hex-quad:
1460 hexadecimal-digit hexadecimal-digit hexadecimal-digit hexadecimal-digit
1461
14621.5) Constants
1463
1464constant:
1465 integer-constant
1466 enumeration-constant
1467 character-constant
1468
1469integer-constant:
1470 decimal-constant integer-suffix-opt
1471 octal-constant integer-suffix-opt
1472 hexadecimal-constant integer-suffix-opt
1473
1474decimal-constant:
1475 nonzero-digit
1476 decimal-constant digit
1477
1478octal-constant:
1479 0
1480 octal-constant octal-digit
1481
1482hexadecimal-constant:
1483 hexadecimal-prefix hexadecimal-digit
1484 hexadecimal-constant hexadecimal-digit
1485
1486hexadecimal-prefix:
1487 0x
1488 0X
1489
1490nonzero-digit:
1491 [1-9]
1492
1493integer-suffix:
1494 unsigned-suffix long-suffix-opt
1495 unsigned-suffix long-long-suffix
1496 long-suffix unsigned-suffix-opt
1497 long-long-suffix unsigned-suffix-opt
1498
1499unsigned-suffix:
1500 u
1501 U
1502
1503long-suffix:
1504 l
1505 L
1506
1507long-long-suffix:
1508 ll
1509 LL
1510
4fa992a5
MD
1511enumeration-constant:
1512 identifier
1513 string-literal
1514
1515character-constant:
1516 ' c-char-sequence '
1517 L' c-char-sequence '
1518
1519c-char-sequence:
1520 c-char
1521 c-char-sequence c-char
1522
1523c-char:
1524 any member of source charset except single-quote ('), backslash
1525 (\), or new-line character.
1526 escape-sequence
1527
1528escape-sequence:
1529 simple-escape-sequence
1530 octal-escape-sequence
1531 hexadecimal-escape-sequence
1532 universal-character-name
1533
1534simple-escape-sequence: one of
1535 \' \" \? \\ \a \b \f \n \r \t \v
1536
1537octal-escape-sequence:
1538 \ octal-digit
1539 \ octal-digit octal-digit
1540 \ octal-digit octal-digit octal-digit
1541
1542hexadecimal-escape-sequence:
1543 \x hexadecimal-digit
1544 hexadecimal-escape-sequence hexadecimal-digit
1545
15461.6) String literals
1547
1548string-literal:
1549 " s-char-sequence-opt "
1550 L" s-char-sequence-opt "
1551
1552s-char-sequence:
1553 s-char
1554 s-char-sequence s-char
1555
1556s-char:
1557 any member of source charset except double-quote ("), backslash
1558 (\), or new-line character.
1559 escape-sequence
1560
15611.7) Punctuators
1562
1563punctuator: one of
1564 [ ] ( ) { } . -> * + - < > : ; ... = ,
1565
1566
15672) Phrase structure grammar
1568
1569primary-expression:
1570 identifier
1571 constant
1572 string-literal
1573 ( unary-expression )
1574
1575postfix-expression:
1576 primary-expression
1577 postfix-expression [ unary-expression ]
1578 postfix-expression . identifier
1579 postfix-expressoin -> identifier
1580
1581unary-expression:
1582 postfix-expression
1583 unary-operator postfix-expression
1584
1585unary-operator: one of
1586 + -
1587
4fa992a5
MD
1588assignment-operator:
1589 =
1590
b9606a77
MD
1591type-assignment-operator:
1592 :=
1593
4fa992a5 1594constant-expression-range:
73d61ac3 1595 unary-expression ... unary-expression
4fa992a5
MD
1596
15972.2) Declarations:
1598
1599declaration:
689e04b4 1600 declaration-specifiers declarator-list-opt ;
4fa992a5
MD
1601 ctf-specifier ;
1602
1603declaration-specifiers:
689e04b4 1604 storage-class-specifier declaration-specifiers-opt
4fa992a5
MD
1605 type-specifier declaration-specifiers-opt
1606 type-qualifier declaration-specifiers-opt
1607
1608declarator-list:
1609 declarator
1610 declarator-list , declarator
1611
d285084f
MD
1612abstract-declarator-list:
1613 abstract-declarator
1614 abstract-declarator-list , abstract-declarator
1615
4fa992a5
MD
1616storage-class-specifier:
1617 typedef
1618
1619type-specifier:
1620 void
1621 char
1622 short
1623 int
1624 long
1625 float
1626 double
1627 signed
1628 unsigned
1629 _Bool
1630 _Complex
cfdd51ec 1631 _Imaginary
9dfcfc0f
MD
1632 struct-specifier
1633 variant-specifier
4fa992a5
MD
1634 enum-specifier
1635 typedef-name
1636 ctf-type-specifier
1637
ec4404a7 1638align-attribute:
73d61ac3 1639 align ( unary-expression )
ec4404a7 1640
4fa992a5 1641struct-specifier:
ec4404a7
MD
1642 struct identifier-opt { struct-or-variant-declaration-list-opt } align-attribute-opt
1643 struct identifier align-attribute-opt
4fa992a5
MD
1644
1645struct-or-variant-declaration-list:
1646 struct-or-variant-declaration
1647 struct-or-variant-declaration-list struct-or-variant-declaration
1648
1649struct-or-variant-declaration:
1650 specifier-qualifier-list struct-or-variant-declarator-list ;
eacb16d1 1651 declaration-specifiers-opt storage-class-specifier declaration-specifiers-opt declarator-list ;
6143bab7
MD
1652 typealias declaration-specifiers abstract-declarator-list type-assignment-operator declaration-specifiers abstract-declarator-list ;
1653 typealias declaration-specifiers abstract-declarator-list type-assignment-operator declarator-list ;
4fa992a5
MD
1654
1655specifier-qualifier-list:
1656 type-specifier specifier-qualifier-list-opt
1657 type-qualifier specifier-qualifier-list-opt
1658
1659struct-or-variant-declarator-list:
1660 struct-or-variant-declarator
1661 struct-or-variant-declarator-list , struct-or-variant-declarator
1662
1663struct-or-variant-declarator:
1664 declarator
73d61ac3 1665 declarator-opt : unary-expression
4fa992a5
MD
1666
1667variant-specifier:
1668 variant identifier-opt variant-tag-opt { struct-or-variant-declaration-list }
1669 variant identifier variant-tag
1670
1671variant-tag:
37ab95c3 1672 < unary-expression >
4fa992a5
MD
1673
1674enum-specifier:
1675 enum identifier-opt { enumerator-list }
1676 enum identifier-opt { enumerator-list , }
1677 enum identifier
a9b83695
MD
1678 enum identifier-opt : declaration-specifiers { enumerator-list }
1679 enum identifier-opt : declaration-specifiers { enumerator-list , }
4fa992a5
MD
1680
1681enumerator-list:
1682 enumerator
1683 enumerator-list , enumerator
1684
1685enumerator:
1686 enumeration-constant
8d2d41f7
MD
1687 enumeration-constant assignment-operator unary-expression
1688 enumeration-constant assignment-operator constant-expression-range
4fa992a5
MD
1689
1690type-qualifier:
1691 const
1692
1693declarator:
1694 pointer-opt direct-declarator
1695
1696direct-declarator:
1697 identifier
1698 ( declarator )
1ab22b2a 1699 direct-declarator [ unary-expression ]
4fa992a5 1700
d285084f
MD
1701abstract-declarator:
1702 pointer-opt direct-abstract-declarator
1703
1704direct-abstract-declarator:
1705 identifier-opt
1706 ( abstract-declarator )
1ab22b2a 1707 direct-abstract-declarator [ unary-expression ]
d285084f
MD
1708 direct-abstract-declarator [ ]
1709
4fa992a5 1710pointer:
3b0f8e4d
MD
1711 * type-qualifier-list-opt
1712 * type-qualifier-list-opt pointer
4fa992a5
MD
1713
1714type-qualifier-list:
1715 type-qualifier
1716 type-qualifier-list type-qualifier
1717
4fa992a5
MD
1718typedef-name:
1719 identifier
1720
17212.3) CTF-specific declarations
1722
1723ctf-specifier:
1724 event { ctf-assignment-expression-list-opt }
1725 stream { ctf-assignment-expression-list-opt }
1726 trace { ctf-assignment-expression-list-opt }
b12919a5
MD
1727 typealias declaration-specifiers abstract-declarator-list type-assignment-operator declaration-specifiers abstract-declarator-list
1728 typealias declaration-specifiers abstract-declarator-list type-assignment-operator declarator-list
4fa992a5
MD
1729
1730ctf-type-specifier:
1731 floating_point { ctf-assignment-expression-list-opt }
1732 integer { ctf-assignment-expression-list-opt }
1733 string { ctf-assignment-expression-list-opt }
7609d3c7 1734 string
4fa992a5
MD
1735
1736ctf-assignment-expression-list:
13441bf5
MD
1737 ctf-assignment-expression ;
1738 ctf-assignment-expression-list ctf-assignment-expression ;
4fa992a5
MD
1739
1740ctf-assignment-expression:
1741 unary-expression assignment-operator unary-expression
1742 unary-expression type-assignment-operator type-specifier
eacb16d1 1743 declaration-specifiers-opt storage-class-specifier declaration-specifiers-opt declarator-list
6143bab7
MD
1744 typealias declaration-specifiers abstract-declarator-list type-assignment-operator declaration-specifiers abstract-declarator-list
1745 typealias declaration-specifiers abstract-declarator-list type-assignment-operator declarator-list
This page took 0.214533 seconds and 4 git commands to generate.