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