Add trace.packet.header definition scope
[ctf.git] / common-trace-format-proposal.txt
CommitLineData
5ba9f198 1
4767a9e7 2RFC: Common Trace Format (CTF) Proposal (pre-v1.7)
5ba9f198
MD
3
4Mathieu Desnoyers, EfficiOS Inc.
5
6The goal of the present document is to propose a trace format that suits the
cc089c3a 7needs of the embedded, telecom, high-performance and kernel communities. It is
5ba9f198 8based on the Common Trace Format Requirements (v1.4) document. It is designed to
cc089c3a 9allow traces to be natively generated by the Linux kernel, Linux user-space
6c7226e9
MD
10applications written in C/C++, and hardware components. One major element of
11CTF is the Trace Stream Description Language (TSDL) which flexibility
12enables description of various binary trace stream layouts.
cc089c3a
MD
13
14The latest version of this document can be found at:
15
16 git tree: git://git.efficios.com/ctf.git
17 gitweb: http://git.efficios.com/?p=ctf.git
5ba9f198
MD
18
19A reference implementation of a library to read and write this trace format is
20being implemented within the BabelTrace project, a converter between trace
21formats. The development tree is available at:
22
23 git tree: git://git.efficios.com/babeltrace.git
24 gitweb: http://git.efficios.com/?p=babeltrace.git
25
26
271. Preliminary definitions
28
3bf79539
MD
29 - Event Trace: An ordered sequence of events.
30 - Event Stream: An ordered sequence of events, containing a subset of the
31 trace event types.
32 - Event Packet: A sequence of physically contiguous events within an event
33 stream.
5ba9f198
MD
34 - Event: This is the basic entry in a trace. (aka: a trace record).
35 - An event identifier (ID) relates to the class (a type) of event within
3bf79539
MD
36 an event stream.
37 e.g. event: irq_entry.
5ba9f198
MD
38 - An event (or event record) relates to a specific instance of an event
39 class.
3bf79539
MD
40 e.g. event: irq_entry, at time X, on CPU Y
41 - Source Architecture: Architecture writing the trace.
42 - Reader Architecture: Architecture reading the trace.
5ba9f198
MD
43
44
452. High-level representation of a trace
46
3bf79539
MD
47A trace is divided into multiple event streams. Each event stream contains a
48subset of the trace event types.
5ba9f198 49
3bf79539
MD
50The final output of the trace, after its generation and optional transport over
51the network, is expected to be either on permanent or temporary storage in a
52virtual file system. Because each event stream is appended to while a trace is
53being recorded, each is associated with a separate file for output. Therefore,
54a stored trace can be represented as a directory containing one file per stream.
5ba9f198 55
6c7226e9
MD
56A metadata event stream contains information on trace event types
57expressed in the Trace Stream Description Language (TSDL). It describes:
5ba9f198
MD
58
59- Trace version.
60- Types available.
3bf79539
MD
61- Per-stream event header description.
62- Per-stream event header selection.
63- Per-stream event context fields.
5ba9f198 64- Per-event
3bf79539 65 - Event type to stream mapping.
5ba9f198
MD
66 - Event type to name mapping.
67 - Event type to ID mapping.
68 - Event fields description.
69
70
3bf79539 713. Event stream
5ba9f198 72
3bf79539 73An event stream is divided in contiguous event packets of variable size. These
ae8c075a
MD
74subdivisions have a variable size. An event packet can contain a certain
75amount of padding at the end. The stream header is repeated at the
76beginning of each event packet. The rationale for the event stream
77design choices is explained in Appendix B. Stream Header Rationale.
5ba9f198 78
3bf79539
MD
79The event stream header will therefore be referred to as the "event packet
80header" throughout the rest of this document.
5ba9f198
MD
81
82
834. Types
84
1fad7a85
MD
85Types are organized as type classes. Each type class belong to either of two
86kind of types: basic types or compound types.
87
5ba9f198
MD
884.1 Basic types
89
1fad7a85
MD
90A basic type is a scalar type, as described in this section. It includes
91integers, GNU/C bitfields, enumerations, and floating point values.
5ba9f198
MD
92
934.1.1 Type inheritance
94
80fd2569
MD
95Type specifications can be inherited to allow deriving types from a
96type class. For example, see the uint32_t named type derived from the "integer"
97type class below ("Integers" section). Types have a precise binary
98representation in the trace. A type class has methods to read and write these
99types, but must be derived into a type to be usable in an event field.
5ba9f198
MD
100
1014.1.2 Alignment
102
103We define "byte-packed" types as aligned on the byte size, namely 8-bit.
104We define "bit-packed" types as following on the next bit, as defined by the
370eae99 105"Integers" section.
5ba9f198 106
3bf79539
MD
107All basic types, except bitfields, are either aligned on an architecture-defined
108specific alignment or byte-packed, depending on the architecture preference.
109Architectures providing fast unaligned write byte-packed basic types to save
5ba9f198 110space, aligning each type on byte boundaries (8-bit). Architectures with slow
3bf79539 111unaligned writes align types on specific alignment values. If no specific
370eae99
MD
112alignment is declared for a type, it is assumed to be bit-packed for
113integers with size not multiple of 8 bits and for gcc bitfields. All
114other types are byte-packed.
5ba9f198 115
3bf79539 116Metadata attribute representation of a specific alignment:
5ba9f198
MD
117
118 align = value; /* value in bits */
119
1204.1.3 Byte order
121
3bf79539
MD
122By default, the native endianness of the source architecture the trace is used.
123Byte order can be overridden for a basic type by specifying a "byte_order"
124attribute. Typical use-case is to specify the network byte order (big endian:
125"be") to save data captured from the network into the trace without conversion.
126If not specified, the byte order is native.
5ba9f198
MD
127
128Metadata representation:
129
130 byte_order = native OR network OR be OR le; /* network and be are aliases */
131
1324.1.4 Size
133
134Type size, in bits, for integers and floats is that returned by "sizeof()" in C
135multiplied by CHAR_BIT.
136We require the size of "char" and "unsigned char" types (CHAR_BIT) to be fixed
137to 8 bits for cross-endianness compatibility.
138
139Metadata representation:
140
141 size = value; (value is in bits)
142
1434.1.5 Integers
144
145Signed integers are represented in two-complement. Integer alignment, size,
146signedness and byte ordering are defined in the metadata. Integers aligned on
147byte size (8-bit) and with length multiple of byte size (8-bit) correspond to
148the C99 standard integers. In addition, integers with alignment and/or size that
149are _not_ a multiple of the byte size are permitted; these correspond to the C99
150standard bitfields, with the added specification that the CTF integer bitfields
151have a fixed binary representation. A MIT-licensed reference implementation of
152the CTF portable bitfields is available at:
153
154 http://git.efficios.com/?p=babeltrace.git;a=blob;f=include/babeltrace/bitfield.h
155
156Binary representation of integers:
157
158- On little and big endian:
159 - Within a byte, high bits correspond to an integer high bits, and low bits
160 correspond to low bits.
161- On little endian:
162 - Integer across multiple bytes are placed from the less significant to the
163 most significant.
164 - Consecutive integers are placed from lower bits to higher bits (even within
165 a byte).
166- On big endian:
167 - Integer across multiple bytes are placed from the most significant to the
168 less significant.
169 - Consecutive integers are placed from higher bits to lower bits (even within
170 a byte).
171
172This binary representation is derived from the bitfield implementation in GCC
173for little and big endian. However, contrary to what GCC does, integers can
174cross units boundaries (no padding is required). Padding can be explicitely
175added (see 4.1.6 GNU/C bitfields) to follow the GCC layout if needed.
176
177Metadata representation:
178
80fd2569 179 integer {
5ba9f198
MD
180 signed = true OR false; /* default false */
181 byte_order = native OR network OR be OR le; /* default native */
182 size = value; /* value in bits, no default */
183 align = value; /* value in bits */
2152348f 184 }
5ba9f198 185
80fd2569 186Example of type inheritance (creation of a uint32_t named type):
5ba9f198 187
359894ac 188typealias integer {
9e4e34e9 189 size = 32;
5ba9f198
MD
190 signed = false;
191 align = 32;
38b8da21 192} := uint32_t;
5ba9f198 193
80fd2569 194Definition of a named 5-bit signed bitfield:
5ba9f198 195
359894ac 196typealias integer {
5ba9f198
MD
197 size = 5;
198 signed = true;
199 align = 1;
38b8da21 200} := int5_t;
5ba9f198
MD
201
2024.1.6 GNU/C bitfields
203
204The GNU/C bitfields follow closely the integer representation, with a
205particularity on alignment: if a bitfield cannot fit in the current unit, the
80fd2569
MD
206unit is padded and the bitfield starts at the following unit. The unit size is
207defined by the size of the type "unit_type".
5ba9f198 208
2152348f 209Metadata representation:
80fd2569
MD
210
211 unit_type name:size:
212
5ba9f198
MD
213As an example, the following structure declared in C compiled by GCC:
214
215struct example {
216 short a:12;
217 short b:5;
218};
219
2152348f
MD
220The example structure is aligned on the largest element (short). The second
221bitfield would be aligned on the next unit boundary, because it would not fit in
222the current unit.
5ba9f198
MD
223
2244.1.7 Floating point
225
226The floating point values byte ordering is defined in the metadata.
227
228Floating point values follow the IEEE 754-2008 standard interchange formats.
229Description of the floating point values include the exponent and mantissa size
230in bits. Some requirements are imposed on the floating point values:
231
232- FLT_RADIX must be 2.
233- mant_dig is the number of digits represented in the mantissa. It is specified
234 by the ISO C99 standard, section 5.2.4, as FLT_MANT_DIG, DBL_MANT_DIG and
235 LDBL_MANT_DIG as defined by <float.h>.
236- exp_dig is the number of digits represented in the exponent. Given that
237 mant_dig is one bit more than its actual size in bits (leading 1 is not
238 needed) and also given that the sign bit always takes one bit, exp_dig can be
239 specified as:
240
241 - sizeof(float) * CHAR_BIT - FLT_MANT_DIG
242 - sizeof(double) * CHAR_BIT - DBL_MANT_DIG
243 - sizeof(long double) * CHAR_BIT - LDBL_MANT_DIG
244
245Metadata representation:
246
80fd2569 247floating_point {
5ba9f198
MD
248 exp_dig = value;
249 mant_dig = value;
250 byte_order = native OR network OR be OR le;
2152348f 251}
5ba9f198
MD
252
253Example of type inheritance:
254
359894ac 255typealias floating_point {
5ba9f198
MD
256 exp_dig = 8; /* sizeof(float) * CHAR_BIT - FLT_MANT_DIG */
257 mant_dig = 24; /* FLT_MANT_DIG */
258 byte_order = native;
38b8da21 259} := float;
5ba9f198
MD
260
261TODO: define NaN, +inf, -inf behavior.
262
2634.1.8 Enumerations
264
265Enumerations are a mapping between an integer type and a table of strings. The
266numerical representation of the enumeration follows the integer type specified
267by the metadata. The enumeration mapping table is detailed in the enumeration
3bf79539
MD
268description within the metadata. The mapping table maps inclusive value ranges
269(or single values) to strings. Instead of being limited to simple
270"value -> string" mappings, these enumerations map
80fd2569 271"[ start_value ... end_value ] -> string", which map inclusive ranges of
3bf79539
MD
272values to strings. An enumeration from the C language can be represented in
273this format by having the same start_value and end_value for each element, which
274is in fact a range of size 1. This single-value range is supported without
4767a9e7 275repeating the start and end values with the value = string declaration.
80fd2569 276
a9b83695 277enum name : integer_type {
359894ac 278 somestring = start_value1 ... end_value1,
80fd2569
MD
279 "other string" = start_value2 ... end_value2,
280 yet_another_string, /* will be assigned to end_value2 + 1 */
281 "some other string" = value,
282 ...
283};
284
285If the values are omitted, the enumeration starts at 0 and increment of 1 for
286each entry:
287
a9b83695 288enum name : unsigned int {
80fd2569
MD
289 ZERO,
290 ONE,
291 TWO,
292 TEN = 10,
293 ELEVEN,
3bf79539 294};
5ba9f198 295
80fd2569 296Overlapping ranges within a single enumeration are implementation defined.
5ba9f198 297
2152348f
MD
298A nameless enumeration can be declared as a field type or as part of a typedef:
299
a9b83695 300enum : integer_type {
2152348f
MD
301 ...
302}
303
c2742c56
MD
304Enumerations omitting the container type ": integer_type" use the "int"
305type (for compatibility with C99). The "int" type must be previously
306declared. E.g.:
307
308typealias integer { size = 32; align = 32; signed = true } := int;
309
310enum {
311 ...
312}
313
1fad7a85 314
5ba9f198
MD
3154.2 Compound types
316
1fad7a85
MD
317Compound are aggregation of type declarations. Compound types include
318structures, variant, arrays, sequences, and strings.
319
5ba9f198
MD
3204.2.1 Structures
321
322Structures are aligned on the largest alignment required by basic types
323contained within the structure. (This follows the ISO/C standard for structures)
324
80fd2569 325Metadata representation of a named structure:
5ba9f198 326
80fd2569
MD
327struct name {
328 field_type field_name;
329 field_type field_name;
330 ...
331};
5ba9f198
MD
332
333Example:
334
80fd2569
MD
335struct example {
336 integer { /* Nameless type */
337 size = 16;
338 signed = true;
339 align = 16;
340 } first_field_name;
341 uint64_t second_field_name; /* Named type declared in the metadata */
3bf79539 342};
5ba9f198
MD
343
344The fields are placed in a sequence next to each other. They each possess a
345field name, which is a unique identifier within the structure.
346
2152348f 347A nameless structure can be declared as a field type or as part of a typedef:
80fd2569
MD
348
349struct {
350 ...
2152348f 351}
80fd2569 352
77a98c82 3534.2.2 Variants (Discriminated/Tagged Unions)
fcba70d4 354
fdf2bb05
MD
355A CTF variant is a selection between different types. A CTF variant must
356always be defined within the scope of a structure or within fields
357contained within a structure (defined recursively). A "tag" enumeration
358field must appear in either the same lexical scope, prior to the variant
359field (in field declaration order), in an uppermost lexical scope (see
6c7226e9 360Section 7.3.1), or in an uppermost dynamic scope (see Section 7.3.2).
fdf2bb05
MD
361The type selection is indicated by the mapping from the enumeration
362value to the string used as variant type selector. The field to use as
363tag is specified by the "tag_field", specified between "< >" after the
364"variant" keyword for unnamed variants, and after "variant name" for
365named variants.
fcba70d4
MD
366
367The alignment of the variant is the alignment of the type as selected by the tag
368value for the specific instance of the variant. The alignment of the type
369containing the variant is independent of the variant alignment. The size of the
370variant is the size as selected by the tag value for the specific instance of
371the variant.
372
373A named variant declaration followed by its definition within a structure
374declaration:
375
376variant name {
377 field_type sel1;
378 field_type sel2;
379 field_type sel3;
380 ...
381};
382
383struct {
a9b83695 384 enum : integer_type { sel1, sel2, sel3, ... } tag_field;
fcba70d4
MD
385 ...
386 variant name <tag_field> v;
387}
388
389An unnamed variant definition within a structure is expressed by the following
390metadata:
391
392struct {
a9b83695 393 enum : integer_type { sel1, sel2, sel3, ... } tag_field;
fcba70d4
MD
394 ...
395 variant <tag_field> {
396 field_type sel1;
397 field_type sel2;
398 field_type sel3;
399 ...
400 } v;
401}
402
403Example of a named variant within a sequence that refers to a single tag field:
404
405variant example {
406 uint32_t a;
407 uint64_t b;
408 short c;
409};
410
411struct {
a9b83695 412 enum : uint2_t { a, b, c } choice;
15850440 413 variant example <choice> v[unsigned int];
fcba70d4
MD
414}
415
416Example of an unnamed variant:
417
418struct {
a9b83695 419 enum : uint2_t { a, b, c, d } choice;
fcba70d4
MD
420 /* Unrelated fields can be added between the variant and its tag */
421 int32_t somevalue;
422 variant <choice> {
423 uint32_t a;
424 uint64_t b;
425 short c;
426 struct {
427 unsigned int field1;
428 uint64_t field2;
429 } d;
430 } s;
431}
432
433Example of an unnamed variant within an array:
434
435struct {
a9b83695 436 enum : uint2_t { a, b, c } choice;
fcba70d4
MD
437 variant <choice> {
438 uint32_t a;
439 uint64_t b;
440 short c;
15850440 441 } v[10];
fcba70d4
MD
442}
443
444Example of a variant type definition within a structure, where the defined type
445is then declared within an array of structures. This variant refers to a tag
446located in an upper lexical scope. This example clearly shows that a variant
447type definition referring to the tag "x" uses the closest preceding field from
448the lexical scope of the type definition.
449
450struct {
a9b83695 451 enum : uint2_t { a, b, c, d } x;
fcba70d4
MD
452
453 typedef variant <x> { /*
454 * "x" refers to the preceding "x" enumeration in the
455 * lexical scope of the type definition.
456 */
457 uint32_t a;
458 uint64_t b;
459 short c;
460 } example_variant;
461
462 struct {
a9b83695 463 enum : int { x, y, z } x; /* This enumeration is not used by "v". */
fcba70d4 464 example_variant v; /*
a9b83695 465 * "v" uses the "enum : uint2_t { a, b, c, d }"
fcba70d4
MD
466 * tag.
467 */
468 } a[10];
469}
470
4714.2.3 Arrays
5ba9f198
MD
472
473Arrays are fixed-length. Their length is declared in the type declaration within
474the metadata. They contain an array of "inner type" elements, which can refer to
475any type not containing the type of the array being declared (no circular
3bf79539 476dependency). The length is the number of elements in an array.
5ba9f198 477
2152348f 478Metadata representation of a named array:
80fd2569
MD
479
480typedef elem_type name[length];
5ba9f198 481
2152348f 482A nameless array can be declared as a field type within a structure, e.g.:
5ba9f198 483
2152348f 484 uint8_t field_name[10];
80fd2569 485
5ba9f198 486
fcba70d4 4874.2.4 Sequences
5ba9f198
MD
488
489Sequences are dynamically-sized arrays. They start with an integer that specify
490the length of the sequence, followed by an array of "inner type" elements.
3bf79539 491The length is the number of elements in the sequence.
5ba9f198 492
2152348f 493Metadata representation for a named sequence:
80fd2569
MD
494
495typedef elem_type name[length_type];
496
497A nameless sequence can be declared as a field type, e.g.:
498
80fd2569
MD
499long field_name[int];
500
501The length type follows the integer types specifications, and the sequence
5ba9f198
MD
502elements follow the "array" specifications.
503
fcba70d4 5044.2.5 Strings
5ba9f198
MD
505
506Strings are an array of bytes of variable size and are terminated by a '\0'
507"NULL" character. Their encoding is described in the metadata. In absence of
508encoding attribute information, the default encoding is UTF-8.
509
80fd2569
MD
510Metadata representation of a named string type:
511
359894ac 512typealias string {
5ba9f198 513 encoding = UTF8 OR ASCII;
38b8da21 514} := name;
5ba9f198 515
80fd2569
MD
516A nameless string type can be declared as a field type:
517
518string field_name; /* Use default UTF8 encoding */
5ba9f198 519
3bf79539
MD
5205. Event Packet Header
521
522The event packet header consists of two part: one is mandatory and have a fixed
523layout. The second part, the "event packet context", has its layout described in
524the metadata.
5ba9f198 525
3bf79539
MD
526- Aligned on page size. Fixed size. Fields either aligned or packed (depending
527 on the architecture preference).
528 No padding at the end of the event packet header. Native architecture byte
5ba9f198 529 ordering.
3bf79539
MD
530
531Fixed layout (event packet header):
532
5ba9f198
MD
533- Magic number (CTF magic numbers: 0xC1FC1FC1 and its reverse endianness
534 representation: 0xC11FFCC1) It needs to have a non-symmetric bytewise
535 representation. Used to distinguish between big and little endian traces (this
536 information is determined by knowing the endianness of the architecture
537 reading the trace and comparing the magic number against its value and the
538 reverse, 0xC11FFCC1). This magic number specifies that we use the CTF metadata
539 description language described in this document. Different magic numbers
540 should be used for other metadata description languages.
3bf79539 541- Trace UUID, used to ensure the event packet match the metadata used.
5ba9f198
MD
542 (note: we cannot use a metadata checksum because metadata can be appended to
543 while tracing is active)
3bf79539
MD
544- Stream ID, used as reference to stream description in metadata.
545
546Metadata-defined layout (event packet context):
547
548- Event packet content size (in bytes).
549- Event packet size (in bytes, includes padding).
550- Event packet content checksum (optional). Checksum excludes the event packet
551 header.
552- Per-stream event packet sequence count (to deal with UDP packet loss). The
553 number of significant sequence counter bits should also be present, so
554 wrap-arounds are deal with correctly.
555- Timestamp at the beginning and timestamp at the end of the event packet.
556 Both timestamps are written in the packet header, but sampled respectively
557 while (or before) writing the first event and while (or after) writing the
558 last event in the packet. The inclusive range between these timestamps should
559 include all event timestamps assigned to events contained within the packet.
5ba9f198 560- Events discarded count
3bf79539
MD
561 - Snapshot of a per-stream free-running counter, counting the number of
562 events discarded that were supposed to be written in the stream prior to
563 the first event in the event packet.
5ba9f198 564 * Note: producer-consumer buffer full condition should fill the current
3bf79539 565 event packet with padding so we know exactly where events have been
5ba9f198 566 discarded.
3bf79539
MD
567- Lossless compression scheme used for the event packet content. Applied
568 directly to raw data. New types of compression can be added in following
569 versions of the format.
5ba9f198
MD
570 0: no compression scheme
571 1: bzip2
572 2: gzip
3bf79539
MD
573 3: xz
574- Cypher used for the event packet content. Applied after compression.
5ba9f198
MD
575 0: no encryption
576 1: AES
3bf79539 577- Checksum scheme used for the event packet content. Applied after encryption.
5ba9f198
MD
578 0: no checksum
579 1: md5
580 2: sha1
581 3: crc32
582
3bf79539
MD
5835.1 Event Packet Header Fixed Layout Description
584
fc5425db
MD
585The event packet header layout is indicated by the trace packet.header
586field. Here is an example structure type for the packet header with the
587fields typically expected:
588
80fd2569
MD
589struct event_packet_header {
590 uint32_t magic;
591 uint8_t trace_uuid[16];
3bf79539 592 uint32_t stream_id;
80fd2569 593};
5ba9f198 594
fc5425db
MD
595trace {
596 ...
597 packet.header := struct event_packet_header;
598};
599
37b39e47
MD
600If a packet header lacks the "magic" number field, the trace endianness
601needs to be specified in the trace "endian" metadata attribute.
602
603If the trace_uuid is not present, no validation that the metadata
604actually corresponds to the stream is performed.
605
606If the stream_id packet header field is missing, the trace can only
607contain a single stream. Its "id" field can be left out, and its events
608don't need to declare a "stream_id" field.
609
610
3bf79539
MD
6115.2 Event Packet Context Description
612
613Event packet context example. These are declared within the stream declaration
614in the metadata. All these fields are optional except for "content_size" and
615"packet_size", which must be present in the context.
616
617An example event packet context type:
618
80fd2569 619struct event_packet_context {
3bf79539
MD
620 uint64_t timestamp_begin;
621 uint64_t timestamp_end;
622 uint32_t checksum;
623 uint32_t stream_packet_count;
624 uint32_t events_discarded;
625 uint32_t cpu_id;
626 uint32_t/uint16_t content_size;
627 uint32_t/uint16_t packet_size;
628 uint8_t stream_packet_count_bits; /* Significant counter bits */
629 uint8_t compression_scheme;
630 uint8_t encryption_scheme;
3b0f8e4d 631 uint8_t checksum_scheme;
3bf79539 632};
5ba9f198 633
fcba70d4 634
5ba9f198
MD
6356. Event Structure
636
637The overall structure of an event is:
638
fcba70d4 6391 - Stream Packet Context (as specified by the stream metadata)
fdf2bb05
MD
640 2 - Event Header (as specified by the stream metadata)
641 3 - Stream Event Context (as specified by the stream metadata)
642 4 - Event Context (as specified by the event metadata)
643 5 - Event Payload (as specified by the event metadata)
5ba9f198 644
fdf2bb05 645This structure defines an implicit dynamic scoping, where variants
7d9d7e92
MD
646located in inner structures (those with a higher number in the listing
647above) can refer to the fields of outer structures (with lower number in
6c7226e9 648the listing above). See Section 7.3 TSDL Scopes for more detail.
5ba9f198 649
fdf2bb05 6506.1 Event Header
fcba70d4
MD
651
652Event headers can be described within the metadata. We hereby propose, as an
653example, two types of events headers. Type 1 accommodates streams with less than
65431 event IDs. Type 2 accommodates streams with 31 or more event IDs.
5ba9f198 655
3bf79539
MD
656One major factor can vary between streams: the number of event IDs assigned to
657a stream. Luckily, this information tends to stay relatively constant (modulo
5ba9f198 658event registration while trace is being recorded), so we can specify different
3bf79539 659representations for streams containing few event IDs and streams containing
5ba9f198
MD
660many event IDs, so we end up representing the event ID and timestamp as densely
661as possible in each case.
662
fcba70d4
MD
663The header is extended in the rare occasions where the information cannot be
664represented in the ranges available in the standard event header. They are also
3bf79539
MD
665used in the rare occasions where the data required for a field could not be
666collected: the flag corresponding to the missing field within the missing_fields
667array is then set to 1.
5ba9f198
MD
668
669Types uintX_t represent an X-bit unsigned integer.
670
671
fdf2bb05 6726.1.1 Type 1 - Few event IDs
5ba9f198
MD
673
674 - Aligned on 32-bit (or 8-bit if byte-packed, depending on the architecture
675 preference).
5ba9f198 676 - Native architecture byte ordering.
fcba70d4
MD
677 - For "compact" selection
678 - Fixed size: 32 bits.
679 - For "extended" selection
680 - Size depends on the architecture and variant alignment.
5ba9f198 681
80fd2569 682struct event_header_1 {
fcba70d4
MD
683 /*
684 * id: range: 0 - 30.
685 * id 31 is reserved to indicate an extended header.
686 */
a9b83695 687 enum : uint5_t { compact = 0 ... 30, extended = 31 } id;
fcba70d4
MD
688 variant <id> {
689 struct {
690 uint27_t timestamp;
691 } compact;
692 struct {
693 uint32_t id; /* 32-bit event IDs */
694 uint64_t timestamp; /* 64-bit timestamps */
695 } extended;
696 } v;
5ba9f198
MD
697};
698
5ba9f198 699
fdf2bb05 7006.1.2 Type 2 - Many event IDs
5ba9f198 701
fcba70d4 702 - Aligned on 16-bit (or 8-bit if byte-packed, depending on the architecture
5ba9f198 703 preference).
5ba9f198 704 - Native architecture byte ordering.
fcba70d4
MD
705 - For "compact" selection
706 - Size depends on the architecture and variant alignment.
707 - For "extended" selection
708 - Size depends on the architecture and variant alignment.
5ba9f198 709
80fd2569 710struct event_header_2 {
fcba70d4
MD
711 /*
712 * id: range: 0 - 65534.
713 * id 65535 is reserved to indicate an extended header.
714 */
a9b83695 715 enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;
fcba70d4
MD
716 variant <id> {
717 struct {
718 uint32_t timestamp;
719 } compact;
720 struct {
721 uint32_t id; /* 32-bit event IDs */
722 uint64_t timestamp; /* 64-bit timestamps */
723 } extended;
724 } v;
5ba9f198
MD
725};
726
5ba9f198
MD
727
7286.2 Event Context
729
730The event context contains information relative to the current event. The choice
fcba70d4
MD
731and meaning of this information is specified by the metadata "stream" and
732"event" information. The "stream" context is applied to all events within the
733stream. The "stream" context structure follows the event header. The "event"
734context is applied to specific events. Its structure follows the "stream"
735context stucture.
5ba9f198 736
fcba70d4
MD
737An example of stream-level event context is to save the event payload size with
738each event, or to save the current PID with each event. These are declared
739within the stream declaration within the metadata:
5ba9f198 740
fcba70d4
MD
741 stream {
742 ...
743 event {
744 ...
4fa992a5 745 context := struct {
80fd2569
MD
746 uint pid;
747 uint16_t payload_size;
3bf79539 748 };
fcba70d4
MD
749 }
750 };
751
752An example of event-specific event context is to declare a bitmap of missing
753fields, only appended after the stream event context if the extended event
754header is selected. NR_FIELDS is the number of fields within the event (a
755numeric value).
5ba9f198 756
fcba70d4
MD
757 event {
758 context = struct {
759 variant <id> {
760 struct { } compact;
761 struct {
762 uint1_t missing_fields[NR_FIELDS]; /* missing event fields bitmap */
763 } extended;
764 } v;
765 };
766 ...
767 }
5ba9f198
MD
768
7696.3 Event Payload
770
771An event payload contains fields specific to a given event type. The fields
772belonging to an event type are described in the event-specific metadata
773within a structure type.
774
7756.3.1 Padding
776
777No padding at the end of the event payload. This differs from the ISO/C standard
778for structures, but follows the CTF standard for structures. In a trace, even
779though it makes sense to align the beginning of a structure, it really makes no
780sense to add padding at the end of the structure, because structures are usually
781not followed by a structure of the same type.
782
783This trick can be done by adding a zero-length "end" field at the end of the C
784structures, and by using the offset of this field rather than using sizeof()
3bf79539 785when calculating the size of a structure (see Appendix "A. Helper macros").
5ba9f198
MD
786
7876.3.2 Alignment
788
789The event payload is aligned on the largest alignment required by types
790contained within the payload. (This follows the ISO/C standard for structures)
791
792
6c7226e9
MD
7937. Trace Stream Description Language (TSDL)
794
795The Trace Stream Description Language (TSDL) allows expression of the
796binary trace streams layout in a C99-like Domain Specific Language
797(DSL).
798
799
8007.1 Metadata
801
802The trace stream layout description is located in the trace meta-data.
803The meta-data is itself located in a stream identified by its name:
804"metadata".
5ba9f198 805
4fafe1ad
MD
806It is made of "event packets", which each start with an event packet
807header. The event type within the metadata stream have no event header
6c7226e9
MD
808nor event context. Each event only contains a "string" payload without
809any null-character. The events are packed one next to another. Each
810event packet start with an event packet header, which contains, amongst
811other fields, the magic number, trace UUID and packet length. In the
812event packet header, the trace UUID is represented as an array of bytes.
813Within the string-based metadata description, the trace UUID is
814represented as a string of hexadecimal digits and dashes "-".
4fafe1ad 815
6c7226e9
MD
816The metadata can be parsed by reading characters within the metadata
817stream, for each packet starting after the packet header, for the length
818of the packet payload specified in the header. Text contained within
819"/*" and "*/", as well as within "//" and end of line, are treated as
820comments. Boolean values can be represented as true, TRUE, or 1 for
821true, and false, FALSE, or 0 for false.
fcba70d4 822
fdf2bb05 823
6c7226e9 8247.2 Declaration vs Definition
fdf2bb05
MD
825
826A declaration associates a layout to a type, without specifying where
827this type is located in the event structure hierarchy (see Section 6).
828This therefore includes typedef, typealias, as well as all type
829specifiers. In certain circumstances (typedef, structure field and
830variant field), a declaration is followed by a declarator, which specify
831the newly defined type name (for typedef), or the field name (for
832declarations located within structure and variants). Array and sequence,
833declared with square brackets ("[" "]"), are part of the declarator,
a9b83695 834similarly to C99. The enumeration base type is specified by
6c7226e9 835": enum_base", which is part of the type specifier. The variant tag
a9b83695 836name, specified between "<" ">", is also part of the type specifier.
fdf2bb05
MD
837
838A definition associates a type to a location in the event structure
b9606a77
MD
839hierarchy (see Section 6). This association is denoted by ":=", as shown
840in Section 7.3.
fdf2bb05
MD
841
842
6c7226e9 8437.3 TSDL Scopes
fdf2bb05 844
6c7226e9
MD
845TSDL uses two different types of scoping: a lexical scope is used for
846declarations and type definitions, and a dynamic scope is used for
847variants references to tag fields.
fdf2bb05 848
6c7226e9 8497.3.1 Lexical Scope
fdf2bb05 850
d285084f
MD
851Each of "trace", "stream", "event", "struct" and "variant" have their own
852nestable declaration scope, within which types can be declared using "typedef"
fdf2bb05 853and "typealias". A root declaration scope also contains all declarations
7d9d7e92 854located outside of any of the aforementioned declarations. An inner
fdf2bb05 855declaration scope can refer to type declared within its container
7d9d7e92
MD
856lexical scope prior to the inner declaration scope. Redefinition of a
857typedef or typealias is not valid, although hiding an upper scope
fdf2bb05
MD
858typedef or typealias is allowed within a sub-scope.
859
6c7226e9 8607.3.2 Dynamic Scope
fdf2bb05 861
7d9d7e92
MD
862A dynamic scope consists in the lexical scope augmented with the
863implicit event structure definition hierarchy presented at Section 6.
864The dynamic scope is only used for variant tag definitions. It is used
865at definition time to look up the location of the tag field associated
866with a variant.
867
868Therefore, variants in lower levels in the dynamic scope (e.g. event
869context) can refer to a tag field located in upper levels (e.g. in the
870event header) by specifying, in this case, the associated tag with
871<header.field_name>. This allows, for instance, the event context to
872define a variant referring to the "id" field of the event header as
873selector.
fdf2bb05
MD
874
875The target dynamic scope must be specified explicitly when referring to
876a field outside of the local static scope. The dynamic scope prefixes
877are thus:
878
e0d9e2c7 879 - Trace Packet Header: <trace.packet.header. >,
7d9d7e92
MD
880 - Stream Packet Context: <stream.packet.context. >,
881 - Event Header: <stream.event.header. >,
882 - Stream Event Context: <stream.event.context. >,
883 - Event Context: <event.context. >,
884 - Event Payload: <event.fields. >.
fdf2bb05
MD
885
886Multiple declarations of the same field name within a single scope is
887not valid. It is however valid to re-use the same field name in
888different scopes. There is no possible conflict, because the dynamic
889scope must be specified when a variant refers to a tag field located in
890a different dynamic scope.
891
457d8b0a
MD
892The information available in the dynamic scopes can be thought of as the
893current tracing context. At trace production, information about the
894current context is saved into the specified scope field levels. At trace
895consumption, for each event, the current trace context is therefore
896readable by accessing the upper dynamic scopes.
897
fdf2bb05 898
6c7226e9 8997.4 TSDL Examples
d285084f 900
6c7226e9
MD
901The grammar representing the TSDL metadata is presented in Appendix C.
902TSDL Grammar. This section presents a rather ligher reading that
969f30c0
MD
903consists in examples of TSDL metadata, with template values.
904
905Note that the trace endianness is usually extracted from the packet
906header magic number. The "endian" field is only needed when the magic
907number packet header field is not present.
5ba9f198 908
350bb633
MD
909The stream "id" can be left out if there is only one stream in the
910trace. The event "id" field can be left out if there is only one event
911in a stream.
912
5ba9f198 913trace {
fdf2bb05 914 major = value; /* Trace format version */
5ba9f198 915 minor = value;
fdf2bb05 916 uuid = "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"; /* Trace UUID */
969f30c0 917 endian = big OR little; /* Endianness (optional) */
fc5425db
MD
918 packet.header := struct {
919 uint32_t magic;
920 uint8_t trace_uuid[16];
921 uint32_t stream_id;
922 };
3bf79539 923};
5ba9f198 924
3bf79539
MD
925stream {
926 id = stream_id;
fdf2bb05 927 /* Type 1 - Few event IDs; Type 2 - Many event IDs. See section 6.1. */
4fa992a5
MD
928 event.header := event_header_1 OR event_header_2;
929 event.context := struct {
77a98c82 930 ...
3bf79539 931 };
4fa992a5 932 packet.context := struct {
77a98c82 933 ...
3bf79539
MD
934 };
935};
5ba9f198
MD
936
937event {
3d13ef1a 938 name = event_name;
3bf79539
MD
939 id = value; /* Numeric identifier within the stream */
940 stream = stream_id;
4fa992a5 941 context := struct {
fcba70d4
MD
942 ...
943 };
4fa992a5 944 fields := struct {
80fd2569
MD
945 ...
946 };
3bf79539 947};
5ba9f198
MD
948
949/* More detail on types in section 4. Types */
950
3d13ef1a
MD
951/*
952 * Named types:
953 *
4fa992a5 954 * Type declarations behave similarly to the C standard.
3d13ef1a
MD
955 */
956
80af8ac6 957typedef aliased_type_specifiers new_type_declarators;
2152348f 958
3d13ef1a 959/* e.g.: typedef struct example new_type_name[10]; */
80fd2569 960
4fa992a5
MD
961/*
962 * typealias
963 *
964 * The "typealias" declaration can be used to give a name (including
80af8ac6
MD
965 * pointer declarator specifier) to a type. It should also be used to
966 * map basic C types (float, int, unsigned long, ...) to a CTF type.
967 * Typealias is a superset of "typedef": it also allows assignment of a
38b8da21 968 * simple variable identifier to a type.
4fa992a5
MD
969 */
970
971typealias type_class {
80fd2569 972 ...
38b8da21 973} := type_specifiers type_declarator;
2152348f 974
3d13ef1a
MD
975/*
976 * e.g.:
4fa992a5 977 * typealias integer {
3d13ef1a
MD
978 * size = 32;
979 * align = 32;
980 * signed = false;
38b8da21 981 * } := struct page *;
359894ac
MD
982 *
983 * typealias integer {
984 * size = 32;
985 * align = 32;
986 * signed = true;
38b8da21 987 * } := int;
3d13ef1a 988 */
80fd2569
MD
989
990struct name {
3bf79539
MD
991 ...
992};
5ba9f198 993
fcba70d4
MD
994variant name {
995 ...
996};
997
a9b83695 998enum name : integer_type {
3bf79539
MD
999 ...
1000};
1001
2152348f 1002
4fa992a5
MD
1003/*
1004 * Unnamed types, contained within compound type fields, typedef or typealias.
1005 */
2152348f 1006
80fd2569
MD
1007struct {
1008 ...
2152348f 1009}
5ba9f198 1010
fcba70d4
MD
1011variant {
1012 ...
1013}
1014
a9b83695 1015enum : integer_type {
80fd2569 1016 ...
2152348f
MD
1017}
1018
1019typedef type new_type[length];
3bf79539 1020
2152348f
MD
1021struct {
1022 type field_name[length];
1023}
1024
1025typedef type new_type[length_type];
1026
1027struct {
1028 type field_name[length_type];
1029}
1030
1031integer {
80fd2569 1032 ...
2152348f 1033}
3bf79539 1034
2152348f 1035floating_point {
80fd2569 1036 ...
2152348f
MD
1037}
1038
1039struct {
1040 integer_type field_name:size; /* GNU/C bitfield */
1041}
1042
1043struct {
1044 string field_name;
1045}
3bf79539 1046
fcba70d4 1047
3bf79539 1048A. Helper macros
5ba9f198
MD
1049
1050The two following macros keep track of the size of a GNU/C structure without
1051padding at the end by placing HEADER_END as the last field. A one byte end field
1052is used for C90 compatibility (C99 flexible arrays could be used here). Note
1053that this does not affect the effective structure size, which should always be
1054calculated with the header_sizeof() helper.
1055
1056#define HEADER_END char end_field
1057#define header_sizeof(type) offsetof(typeof(type), end_field)
3bf79539
MD
1058
1059
1060B. Stream Header Rationale
1061
1062An event stream is divided in contiguous event packets of variable size. These
1063subdivisions allow the trace analyzer to perform a fast binary search by time
1064within the stream (typically requiring to index only the event packet headers)
1065without reading the whole stream. These subdivisions have a variable size to
1066eliminate the need to transfer the event packet padding when partially filled
1067event packets must be sent when streaming a trace for live viewing/analysis.
1068An event packet can contain a certain amount of padding at the end. Dividing
1069streams into event packets is also useful for network streaming over UDP and
1070flight recorder mode tracing (a whole event packet can be swapped out of the
1071buffer atomically for reading).
1072
1073The stream header is repeated at the beginning of each event packet to allow
1074flexibility in terms of:
1075
1076 - streaming support,
1077 - allowing arbitrary buffers to be discarded without making the trace
1078 unreadable,
1079 - allow UDP packet loss handling by either dealing with missing event packet
1080 or asking for re-transmission.
1081 - transparently support flight recorder mode,
1082 - transparently support crash dump.
1083
1084The event stream header will therefore be referred to as the "event packet
1085header" throughout the rest of this document.
fcba70d4 1086
6c7226e9
MD
1087
1088C. TSDL Grammar
fcba70d4 1089
4fa992a5 1090/*
6c7226e9 1091 * Common Trace Format (CTF) Trace Stream Description Language (TSDL) Grammar.
4fa992a5
MD
1092 *
1093 * Inspired from the C99 grammar:
1094 * http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1124.pdf (Annex A)
6c7226e9
MD
1095 * and c++1x grammar (draft)
1096 * http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2011/n3291.pdf (Annex A)
4fa992a5
MD
1097 *
1098 * Specialized for CTF needs by including only constant and declarations from
1099 * C99 (excluding function declarations), and by adding support for variants,
6c7226e9
MD
1100 * sequences and CTF-specific specifiers. Enumeration container types
1101 * semantic is inspired from c++1x enum-base.
4fa992a5
MD
1102 */
1103
11041) Lexical grammar
1105
11061.1) Lexical elements
1107
1108token:
1109 keyword
1110 identifier
1111 constant
1112 string-literal
1113 punctuator
1114
11151.2) Keywords
1116
1117keyword: is one of
1118
1119const
1120char
1121double
1122enum
1123event
1124floating_point
1125float
1126integer
1127int
1128long
1129short
1130signed
1131stream
1132string
1133struct
1134trace
3e1e1a78 1135typealias
4fa992a5
MD
1136typedef
1137unsigned
1138variant
1139void
1140_Bool
1141_Complex
1142_Imaginary
1143
1144
11451.3) Identifiers
1146
1147identifier:
1148 identifier-nondigit
1149 identifier identifier-nondigit
1150 identifier digit
1151
1152identifier-nondigit:
1153 nondigit
1154 universal-character-name
1155 any other implementation-defined characters
1156
1157nondigit:
1158 _
1159 [a-zA-Z] /* regular expression */
1160
1161digit:
1162 [0-9] /* regular expression */
1163
11641.4) Universal character names
1165
1166universal-character-name:
1167 \u hex-quad
1168 \U hex-quad hex-quad
1169
1170hex-quad:
1171 hexadecimal-digit hexadecimal-digit hexadecimal-digit hexadecimal-digit
1172
11731.5) Constants
1174
1175constant:
1176 integer-constant
1177 enumeration-constant
1178 character-constant
1179
1180integer-constant:
1181 decimal-constant integer-suffix-opt
1182 octal-constant integer-suffix-opt
1183 hexadecimal-constant integer-suffix-opt
1184
1185decimal-constant:
1186 nonzero-digit
1187 decimal-constant digit
1188
1189octal-constant:
1190 0
1191 octal-constant octal-digit
1192
1193hexadecimal-constant:
1194 hexadecimal-prefix hexadecimal-digit
1195 hexadecimal-constant hexadecimal-digit
1196
1197hexadecimal-prefix:
1198 0x
1199 0X
1200
1201nonzero-digit:
1202 [1-9]
1203
1204integer-suffix:
1205 unsigned-suffix long-suffix-opt
1206 unsigned-suffix long-long-suffix
1207 long-suffix unsigned-suffix-opt
1208 long-long-suffix unsigned-suffix-opt
1209
1210unsigned-suffix:
1211 u
1212 U
1213
1214long-suffix:
1215 l
1216 L
1217
1218long-long-suffix:
1219 ll
1220 LL
1221
1222digit-sequence:
1223 digit
1224 digit-sequence digit
1225
1226hexadecimal-digit-sequence:
1227 hexadecimal-digit
1228 hexadecimal-digit-sequence hexadecimal-digit
1229
1230enumeration-constant:
1231 identifier
1232 string-literal
1233
1234character-constant:
1235 ' c-char-sequence '
1236 L' c-char-sequence '
1237
1238c-char-sequence:
1239 c-char
1240 c-char-sequence c-char
1241
1242c-char:
1243 any member of source charset except single-quote ('), backslash
1244 (\), or new-line character.
1245 escape-sequence
1246
1247escape-sequence:
1248 simple-escape-sequence
1249 octal-escape-sequence
1250 hexadecimal-escape-sequence
1251 universal-character-name
1252
1253simple-escape-sequence: one of
1254 \' \" \? \\ \a \b \f \n \r \t \v
1255
1256octal-escape-sequence:
1257 \ octal-digit
1258 \ octal-digit octal-digit
1259 \ octal-digit octal-digit octal-digit
1260
1261hexadecimal-escape-sequence:
1262 \x hexadecimal-digit
1263 hexadecimal-escape-sequence hexadecimal-digit
1264
12651.6) String literals
1266
1267string-literal:
1268 " s-char-sequence-opt "
1269 L" s-char-sequence-opt "
1270
1271s-char-sequence:
1272 s-char
1273 s-char-sequence s-char
1274
1275s-char:
1276 any member of source charset except double-quote ("), backslash
1277 (\), or new-line character.
1278 escape-sequence
1279
12801.7) Punctuators
1281
1282punctuator: one of
1283 [ ] ( ) { } . -> * + - < > : ; ... = ,
1284
1285
12862) Phrase structure grammar
1287
1288primary-expression:
1289 identifier
1290 constant
1291 string-literal
1292 ( unary-expression )
1293
1294postfix-expression:
1295 primary-expression
1296 postfix-expression [ unary-expression ]
1297 postfix-expression . identifier
1298 postfix-expressoin -> identifier
1299
1300unary-expression:
1301 postfix-expression
1302 unary-operator postfix-expression
1303
1304unary-operator: one of
1305 + -
1306
4fa992a5
MD
1307assignment-operator:
1308 =
1309
b9606a77
MD
1310type-assignment-operator:
1311 :=
1312
4fa992a5
MD
1313constant-expression:
1314 unary-expression
1315
1316constant-expression-range:
1317 constant-expression ... constant-expression
1318
13192.2) Declarations:
1320
1321declaration:
689e04b4 1322 declaration-specifiers declarator-list-opt ;
4fa992a5
MD
1323 ctf-specifier ;
1324
1325declaration-specifiers:
689e04b4 1326 storage-class-specifier declaration-specifiers-opt
4fa992a5
MD
1327 type-specifier declaration-specifiers-opt
1328 type-qualifier declaration-specifiers-opt
1329
1330declarator-list:
1331 declarator
1332 declarator-list , declarator
1333
d285084f
MD
1334abstract-declarator-list:
1335 abstract-declarator
1336 abstract-declarator-list , abstract-declarator
1337
4fa992a5
MD
1338storage-class-specifier:
1339 typedef
1340
1341type-specifier:
1342 void
1343 char
1344 short
1345 int
1346 long
1347 float
1348 double
1349 signed
1350 unsigned
1351 _Bool
1352 _Complex
cfdd51ec 1353 _Imaginary
9dfcfc0f
MD
1354 struct-specifier
1355 variant-specifier
4fa992a5
MD
1356 enum-specifier
1357 typedef-name
1358 ctf-type-specifier
1359
1360struct-specifier:
3b0f8e4d 1361 struct identifier-opt { struct-or-variant-declaration-list-opt }
4fa992a5
MD
1362 struct identifier
1363
1364struct-or-variant-declaration-list:
1365 struct-or-variant-declaration
1366 struct-or-variant-declaration-list struct-or-variant-declaration
1367
1368struct-or-variant-declaration:
1369 specifier-qualifier-list struct-or-variant-declarator-list ;
550aca33 1370 declaration-specifiers storage-class-specifier declaration-specifiers declarator-list ;
38b8da21
MD
1371 typealias declaration-specifiers abstract-declarator-list := declaration-specifiers abstract-declarator-list ;
1372 typealias declaration-specifiers abstract-declarator-list := declarator-list ;
4fa992a5
MD
1373
1374specifier-qualifier-list:
1375 type-specifier specifier-qualifier-list-opt
1376 type-qualifier specifier-qualifier-list-opt
1377
1378struct-or-variant-declarator-list:
1379 struct-or-variant-declarator
1380 struct-or-variant-declarator-list , struct-or-variant-declarator
1381
1382struct-or-variant-declarator:
1383 declarator
1384 declarator-opt : constant-expression
1385
1386variant-specifier:
1387 variant identifier-opt variant-tag-opt { struct-or-variant-declaration-list }
1388 variant identifier variant-tag
1389
1390variant-tag:
1391 < identifier >
1392
1393enum-specifier:
1394 enum identifier-opt { enumerator-list }
1395 enum identifier-opt { enumerator-list , }
1396 enum identifier
a9b83695
MD
1397 enum identifier-opt : declaration-specifiers { enumerator-list }
1398 enum identifier-opt : declaration-specifiers { enumerator-list , }
4fa992a5
MD
1399
1400enumerator-list:
1401 enumerator
1402 enumerator-list , enumerator
1403
1404enumerator:
1405 enumeration-constant
1406 enumeration-constant = constant-expression
1407 enumeration-constant = constant-expression-range
1408
1409type-qualifier:
1410 const
1411
1412declarator:
1413 pointer-opt direct-declarator
1414
1415direct-declarator:
1416 identifier
1417 ( declarator )
1418 direct-declarator [ type-specifier ]
1419 direct-declarator [ constant-expression ]
1420
d285084f
MD
1421abstract-declarator:
1422 pointer-opt direct-abstract-declarator
1423
1424direct-abstract-declarator:
1425 identifier-opt
1426 ( abstract-declarator )
1427 direct-abstract-declarator [ type-specifier ]
1428 direct-abstract-declarator [ constant-expression ]
1429 direct-abstract-declarator [ ]
1430
4fa992a5 1431pointer:
3b0f8e4d
MD
1432 * type-qualifier-list-opt
1433 * type-qualifier-list-opt pointer
4fa992a5
MD
1434
1435type-qualifier-list:
1436 type-qualifier
1437 type-qualifier-list type-qualifier
1438
4fa992a5
MD
1439typedef-name:
1440 identifier
1441
14422.3) CTF-specific declarations
1443
1444ctf-specifier:
1445 event { ctf-assignment-expression-list-opt }
1446 stream { ctf-assignment-expression-list-opt }
1447 trace { ctf-assignment-expression-list-opt }
38b8da21
MD
1448 typealias declaration-specifiers abstract-declarator-list := declaration-specifiers abstract-declarator-list ;
1449 typealias declaration-specifiers abstract-declarator-list := declarator-list ;
4fa992a5
MD
1450
1451ctf-type-specifier:
1452 floating_point { ctf-assignment-expression-list-opt }
1453 integer { ctf-assignment-expression-list-opt }
1454 string { ctf-assignment-expression-list-opt }
1455
1456ctf-assignment-expression-list:
1457 ctf-assignment-expression
1458 ctf-assignment-expression-list ; ctf-assignment-expression
1459
1460ctf-assignment-expression:
1461 unary-expression assignment-operator unary-expression
1462 unary-expression type-assignment-operator type-specifier
550aca33 1463 declaration-specifiers storage-class-specifier declaration-specifiers declarator-list
38b8da21
MD
1464 typealias declaration-specifiers abstract-declarator-list := declaration-specifiers abstract-declarator-list
1465 typealias declaration-specifiers abstract-declarator-list := declarator-list
This page took 0.153767 seconds and 4 git commands to generate.