Make struct event_packet_header explicitly declared
[ctf.git] / common-trace-format-proposal.txt
index 361c2ec39c21f35ceb06363b218b0c683113d284..35c1e71b4c662abdfb509149c2a7ca73ade1ef27 100644 (file)
@@ -7,7 +7,9 @@ The goal of the present document is to propose a trace format that suits the
 needs of the embedded, telecom, high-performance and kernel communities. It is
 based on the Common Trace Format Requirements (v1.4) document. It is designed to
 allow traces to be natively generated by the Linux kernel, Linux user-space
-applications written in C/C++, and hardware components.
+applications written in C/C++, and hardware components. One major element of
+CTF is the Trace Stream Description Language (TSDL) which flexibility
+enables description of various binary trace stream layouts.
 
 The latest version of this document can be found at:
 
@@ -51,7 +53,8 @@ virtual file system. Because each event stream is appended to while a trace is
 being recorded, each is associated with a separate file for output.  Therefore,
 a stored trace can be represented as a directory containing one file per stream.
 
-A metadata event stream contains information on trace event types. It describes:
+A metadata event stream contains information on trace event types
+expressed in the Trace Stream Description Language (TSDL). It describes:
 
 - Trace version.
 - Types available.
@@ -68,14 +71,10 @@ A metadata event stream contains information on trace event types. It describes:
 3. Event stream
 
 An event stream is divided in contiguous event packets of variable size. These
-subdivisions have a variable size. An event packet can contain a certain amount
-of padding at the end. The rationale for the event stream design choices is
-explained in Appendix B. Stream Header Rationale.
-
-An event stream is divided in contiguous event packets of variable size. These
-subdivisions have a variable size. An event packet can contain a certain amount
-of padding at the end.  The stream header is repeated at the beginning of each
-event packet.
+subdivisions have a variable size. An event packet can contain a certain
+amount of padding at the end. The stream header is repeated at the
+beginning of each event packet. The rationale for the event stream
+design choices is explained in Appendix B. Stream Header Rationale.
 
 The event stream header will therefore be referred to as the "event packet
 header" throughout the rest of this document.
@@ -103,15 +102,16 @@ types, but must be derived into a type to be usable in an event field.
 
 We define "byte-packed" types as aligned on the byte size, namely 8-bit.
 We define "bit-packed" types as following on the next bit, as defined by the
-"bitfields" section.
+"Integers" section.
 
 All basic types, except bitfields, are either aligned on an architecture-defined
 specific alignment or byte-packed, depending on the architecture preference.
 Architectures providing fast unaligned write byte-packed basic types to save
 space, aligning each type on byte boundaries (8-bit). Architectures with slow
 unaligned writes align types on specific alignment values. If no specific
-alignment is declared for a type nor its parents, it is assumed to be bit-packed
-for bitfields and byte-packed for other types.
+alignment is declared for a type, it is assumed to be bit-packed for
+integers with size not multiple of 8 bits and for gcc bitfields. All
+other types are byte-packed.
 
 Metadata attribute representation of a specific alignment:
 
@@ -189,7 +189,7 @@ typealias integer {
   size = 32;
   signed = false;
   align = 32;
-} : uint32_t;
+} := uint32_t;
 
 Definition of a named 5-bit signed bitfield:
 
@@ -197,7 +197,7 @@ typealias integer {
   size = 5;
   signed = true;
   align = 1;
-} : int5_t;
+} := int5_t;
 
 4.1.6 GNU/C bitfields
 
@@ -256,7 +256,7 @@ typealias floating_point {
   exp_dig = 8;         /* sizeof(float) * CHAR_BIT - FLT_MANT_DIG */
   mant_dig = 24;       /* FLT_MANT_DIG */
   byte_order = native;
-} : float;
+} := float;
 
 TODO: define NaN, +inf, -inf behavior.
 
@@ -274,10 +274,7 @@ this format by having the same start_value and end_value for each element, which
 is in fact a range of size 1. This single-value range is supported without
 repeating the start and end values with the value = string declaration.
 
-If a numeric value is encountered between < >, it represents the integer type
-size used to hold the enumeration, in bits.
-
-enum name <integer_type OR size> {
+enum name : integer_type {
   somestring          = start_value1 ... end_value1,
   "other string"      = start_value2 ... end_value2,
   yet_another_string,  /* will be assigned to end_value2 + 1 */
@@ -288,7 +285,7 @@ enum name <integer_type OR size> {
 If the values are omitted, the enumeration starts at 0 and increment of 1 for
 each entry:
 
-enum name <32> {
+enum name : unsigned int {
   ZERO,
   ONE,
   TWO,
@@ -300,7 +297,17 @@ Overlapping ranges within a single enumeration are implementation defined.
 
 A nameless enumeration can be declared as a field type or as part of a typedef:
 
-enum <integer_type> {
+enum : integer_type {
+  ...
+}
+
+Enumerations omitting the container type ": integer_type" use the "int"
+type (for compatibility with C99). The "int" type must be previously
+declared. E.g.:
+
+typealias integer { size = 32; align = 32; signed = true } := int;
+
+enum {
   ...
 }
 
@@ -350,7 +357,7 @@ always be defined within the scope of a structure or within fields
 contained within a structure (defined recursively). A "tag" enumeration
 field must appear in either the same lexical scope, prior to the variant
 field (in field declaration order), in an uppermost lexical scope (see
-Section 7.2.1), or in an uppermost dynamic scope (see Section 7.2.2).
+Section 7.3.1), or in an uppermost dynamic scope (see Section 7.3.2).
 The type selection is indicated by the mapping from the enumeration
 value to the string used as variant type selector. The field to use as
 tag is specified by the "tag_field", specified between "< >" after the
@@ -374,7 +381,7 @@ variant name {
 };
 
 struct {
-  enum <integer_type or size> { sel1, sel2, sel3, ... } tag_field;
+  enum : integer_type { sel1, sel2, sel3, ... } tag_field;
   ...
   variant name <tag_field> v;
 }
@@ -383,7 +390,7 @@ An unnamed variant definition within a structure is expressed by the following
 metadata:
 
 struct {
-  enum <integer_type or size> { sel1, sel2, sel3, ... } tag_field;
+  enum : integer_type { sel1, sel2, sel3, ... } tag_field;
   ...
   variant <tag_field> {
     field_type sel1;
@@ -402,14 +409,14 @@ variant example {
 };
 
 struct {
-  enum <uint2_t> { a, b, c } choice;
+  enum : uint2_t { a, b, c } choice;
   variant example <choice> v[unsigned int];
 }
 
 Example of an unnamed variant:
 
 struct {
-  enum <uint2_t> { a, b, c, d } choice;
+  enum : uint2_t { a, b, c, d } choice;
   /* Unrelated fields can be added between the variant and its tag */
   int32_t somevalue;
   variant <choice> {
@@ -426,7 +433,7 @@ struct {
 Example of an unnamed variant within an array:
 
 struct {
-  enum <uint2_t> { a, b, c } choice;
+  enum : uint2_t { a, b, c } choice;
   variant <choice> {
     uint32_t a;
     uint64_t b;
@@ -441,7 +448,7 @@ type definition referring to the tag "x" uses the closest preceding field from
 the lexical scope of the type definition.
 
 struct {
-  enum <uint2_t> { a, b, c, d } x;
+  enum : uint2_t { a, b, c, d } x;
 
   typedef variant <x> {        /*
                         * "x" refers to the preceding "x" enumeration in the
@@ -453,9 +460,9 @@ struct {
   } example_variant;
 
   struct {
-    enum <int> { x, y, z } x;  /* This enumeration is not used by "v". */
+    enum : int { x, y, z } x;  /* This enumeration is not used by "v". */
     example_variant v;                 /*
-                                * "v" uses the "enum <uint2_t> { a, b, c, d }"
+                                * "v" uses the "enum : uint2_t { a, b, c, d }"
                                 * tag.
                                 */
   } a[10];
@@ -504,7 +511,7 @@ Metadata representation of a named string type:
 
 typealias string {
   encoding = UTF8 OR ASCII;
-} : name;
+} := name;
 
 A nameless string type can be declared as a field type:
 
@@ -575,12 +582,21 @@ Metadata-defined layout (event packet context):
 
 5.1 Event Packet Header Fixed Layout Description
 
+The event packet header layout is indicated by the trace packet.header
+field. Here is an example structure type for the packet header with the
+fields typically expected:
+
 struct event_packet_header {
   uint32_t magic;
   uint8_t  trace_uuid[16];
   uint32_t stream_id;
 };
 
+trace {
+  ...
+  packet.header := struct event_packet_header;
+};
+
 5.2 Event Packet Context Description
 
 Event packet context example. These are declared within the stream declaration
@@ -618,7 +634,7 @@ The overall structure of an event is:
 This structure defines an implicit dynamic scoping, where variants
 located in inner structures (those with a higher number in the listing
 above) can refer to the fields of outer structures (with lower number in
-the listing above). See Section 7.2 Metadata Scopes for more detail.
+the listing above). See Section 7.3 TSDL Scopes for more detail.
 
 6.1 Event Header
 
@@ -657,7 +673,7 @@ struct event_header_1 {
    * id: range: 0 - 30.
    * id 31 is reserved to indicate an extended header.
    */
-  enum <uint5_t> { compact = 0 ... 30, extended = 31 } id;
+  enum : uint5_t { compact = 0 ... 30, extended = 31 } id;
   variant <id> {
     struct {
       uint27_t timestamp;
@@ -685,7 +701,7 @@ struct event_header_2 {
    * id: range: 0 - 65534.
    * id 65535 is reserved to indicate an extended header.
    */
-  enum <uint16_t> { compact = 0 ... 65534, extended = 65535 } id;
+  enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;
   variant <id> {
     struct {
       uint32_t timestamp;
@@ -763,25 +779,38 @@ The event payload is aligned on the largest alignment required by types
 contained within the payload. (This follows the ISO/C standard for structures)
 
 
-7. Metadata
+7. Trace Stream Description Language (TSDL)
+
+The Trace Stream Description Language (TSDL) allows expression of the
+binary trace streams layout in a C99-like Domain Specific Language
+(DSL).
+
+
+7.1 Metadata
+
+The trace stream layout description is located in the trace meta-data.
+The meta-data is itself located in a stream identified by its name:
+"metadata".
 
-The meta-data is located in a stream named "metadata". It is made of "event
-packets", which each start with an event packet header. The event type within
-the metadata stream have no event header nor event context. Each event only
-contains a null-terminated "string" payload, which is a metadata description
-entry. The events are packed one next to another. Each event packet start with
-an event packet header, which contains, amongst other fields, the magic number
-and trace UUID. The trace UUID is represented as a string of hexadecimal digits
-and dashes "-".
+It is made of "event packets", which each start with an event packet
+header. The event type within the metadata stream have no event header
+nor event context. Each event only contains a "string" payload without
+any null-character. The events are packed one next to another. Each
+event packet start with an event packet header, which contains, amongst
+other fields, the magic number, trace UUID and packet length. In the
+event packet header, the trace UUID is represented as an array of bytes.
+Within the string-based metadata description, the trace UUID is
+represented as a string of hexadecimal digits and dashes "-".
 
-The metadata can be parsed by reading through the metadata strings, skipping
-newlines and null-characters. Type names are made of a single identifier, and
-can be surrounded by prefix/postfix. Text contained within "/*" and "*/", as
-well as within "//" and end of line, are treated as comments. Boolean values can
-be represented as true, TRUE, or 1 for true, and false, FALSE, or 0 for false.
+The metadata can be parsed by reading characters within the metadata
+stream, for each packet starting after the packet header, for the length
+of the packet payload specified in the header.  Text contained within
+"/*" and "*/", as well as within "//" and end of line, are treated as
+comments.  Boolean values can be represented as true, TRUE, or 1 for
+true, and false, FALSE, or 0 for false.
 
 
-7.1 Declaration vs Definition
+7.2 Declaration vs Definition
 
 A declaration associates a layout to a type, without specifying where
 this type is located in the event structure hierarchy (see Section 6).
@@ -791,19 +820,22 @@ variant field), a declaration is followed by a declarator, which specify
 the newly defined type name (for typedef), or the field name (for
 declarations located within structure and variants). Array and sequence,
 declared with square brackets ("[" "]"), are part of the declarator,
-similarly to C99.
+similarly to C99. The enumeration base type is specified by
+": enum_base", which is part of the type specifier. The variant tag
+name, specified between "<" ">", is also part of the type specifier.
 
 A definition associates a type to a location in the event structure
-hierarchy (see Section 6).
+hierarchy (see Section 6). This association is denoted by ":=", as shown
+in Section 7.3.
 
 
-7.2 Metadata Scopes
+7.3 TSDL Scopes
 
-CTF metadata uses two different types of scoping: a lexical scope is
-used for declarations and type definitions, and a dynamic scope is used
-for variants references to tag fields.
+TSDL uses two different types of scoping: a lexical scope is used for
+declarations and type definitions, and a dynamic scope is used for
+variants references to tag fields.
 
-7.2.1 Lexical Scope
+7.3.1 Lexical Scope
 
 Each of "trace", "stream", "event", "struct" and "variant" have their own
 nestable declaration scope, within which types can be declared using "typedef"
@@ -814,7 +846,7 @@ lexical scope prior to the inner declaration scope. Redefinition of a
 typedef or typealias is not valid, although hiding an upper scope
 typedef or typealias is allowed within a sub-scope.
 
-7.2.2 Dynamic Scope
+7.3.2 Dynamic Scope
 
 A dynamic scope consists in the lexical scope augmented with the
 implicit event structure definition hierarchy presented at Section 6.
@@ -845,18 +877,28 @@ different scopes. There is no possible conflict, because the dynamic
 scope must be specified when a variant refers to a tag field located in
 a different dynamic scope.
 
+The information available in the dynamic scopes can be thought of as the
+current tracing context. At trace production, information about the
+current context is saved into the specified scope field levels. At trace
+consumption, for each event, the current trace context is therefore
+readable by accessing the upper dynamic scopes.
 
-7.2 Metadata Examples
 
-The grammar representing the CTF metadata is presented in
-Appendix C. CTF Metadata Grammar. This section presents a rather ligher
-reading that consists in examples of CTF metadata, with template values:
+7.4 TSDL Examples
+
+The grammar representing the TSDL metadata is presented in Appendix C.
+TSDL Grammar. This section presents a rather ligher reading that
+consists in examples of TSDL metadata, with template values:
 
 trace {
   major = value;                               /* Trace format version */
   minor = value;
   uuid = "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa";       /* Trace UUID */
-  word_size = value;
+  packet.header := struct {
+    uint32_t magic;
+    uint8_t  trace_uuid[16];
+    uint32_t stream_id;
+  };
 };
 
 stream {
@@ -891,7 +933,7 @@ event {
  * Type declarations behave similarly to the C standard.
  */
 
-typedef aliased_type_prefix aliased_type new_type aliased_type_postfix;
+typedef aliased_type_specifiers new_type_declarators;
 
 /* e.g.: typedef struct example new_type_name[10]; */
 
@@ -899,15 +941,15 @@ typedef aliased_type_prefix aliased_type new_type aliased_type_postfix;
  * typealias
  *
  * The "typealias" declaration can be used to give a name (including
- * prefix/postfix) to a type. It should also be used to map basic C types
- * (float, int, unsigned long, ...) to a CTF type. Typealias is a superset of
- * "typedef": it also allows assignment of a simple variable identifier to a
- * type.
+ * pointer declarator specifier) to a type. It should also be used to
+ * map basic C types (float, int, unsigned long, ...) to a CTF type.
+ * Typealias is a superset of "typedef": it also allows assignment of a
+ * simple variable identifier to a type.
  */
 
 typealias type_class {
   ...
-} : new_type_prefix new_type new_type_postfix;
+} := type_specifiers type_declarator;
 
 /*
  * e.g.: 
@@ -915,13 +957,13 @@ typealias type_class {
  *   size = 32;
  *   align = 32;
  *   signed = false;
- * } : struct page *;
+ * } := struct page *;
  *
  * typealias integer {
  *  size = 32;
  *  align = 32;
  *  signed = true;
- * } : int;
+ * } := int;
  */
 
 struct name {
@@ -932,7 +974,7 @@ variant name {
   ...
 };
 
-enum name <integer_type or size> {
+enum name : integer_type {
   ...
 };
 
@@ -949,7 +991,7 @@ variant {
   ...
 }
 
-enum <integer_type or size> {
+enum : integer_type {
   ...
 }
 
@@ -1021,17 +1063,21 @@ flexibility in terms of:
 The event stream header will therefore be referred to as the "event packet
 header" throughout the rest of this document.
 
-C. CTF Metadata Grammar
+
+C. TSDL Grammar
 
 /*
- * Common Trace Format (CTF) Metadata Grammar.
+ * Common Trace Format (CTF) Trace Stream Description Language (TSDL) Grammar.
  *
  * Inspired from the C99 grammar:
  * http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1124.pdf (Annex A)
+ * and c++1x grammar (draft)
+ * http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2011/n3291.pdf (Annex A)
  *
  * Specialized for CTF needs by including only constant and declarations from
  * C99 (excluding function declarations), and by adding support for variants,
- * sequences and CTF-specific specifiers.
+ * sequences and CTF-specific specifiers. Enumeration container types
+ * semantic is inspired from c++1x enum-base.
  */
 
 1) Lexical grammar
@@ -1240,6 +1286,9 @@ unary-operator: one of
 assignment-operator:
        =
 
+type-assignment-operator:
+       :=
+
 constant-expression:
        unary-expression
 
@@ -1249,11 +1298,11 @@ constant-expression-range:
 2.2) Declarations:
 
 declaration:
-       declaration-specifiers ;
-       declaration-specifiers storage-class-specifier declaration-specifiers declarator-list ;
+       declaration-specifiers declarator-list-opt ;
        ctf-specifier ;
 
 declaration-specifiers:
+       storage-class-specifier declaration-specifiers-opt
        type-specifier declaration-specifiers-opt
        type-qualifier declaration-specifiers-opt
 
@@ -1280,6 +1329,7 @@ type-specifier:
        unsigned
        _Bool
        _Complex
+       _Imaginary
        struct-specifier
        variant-specifier
        enum-specifier
@@ -1297,8 +1347,8 @@ struct-or-variant-declaration-list:
 struct-or-variant-declaration:
        specifier-qualifier-list struct-or-variant-declarator-list ;
        declaration-specifiers storage-class-specifier declaration-specifiers declarator-list ;
-       typealias declaration-specifiers abstract-declarator-list : declaration-specifiers abstract-declarator-list ;
-       typealias declaration-specifiers abstract-declarator-list : declarator-list ;
+       typealias declaration-specifiers abstract-declarator-list := declaration-specifiers abstract-declarator-list ;
+       typealias declaration-specifiers abstract-declarator-list := declarator-list ;
 
 specifier-qualifier-list:
        type-specifier specifier-qualifier-list-opt
@@ -1323,12 +1373,8 @@ enum-specifier:
        enum identifier-opt { enumerator-list }
        enum identifier-opt { enumerator-list , }
        enum identifier
-       enum identifier-opt < declaration-specifiers > { enumerator-list }
-       enum identifier-opt < declaration-specifiers > { enumerator-list , }
-       enum identifier < declaration-specifiers >
-       enum identifier-opt < integer-constant > { enumerator-list }
-       enum identifier-opt < integer-constant > { enumerator-list , }
-       enum identifier < integer-constant >
+       enum identifier-opt : declaration-specifiers { enumerator-list }
+       enum identifier-opt : declaration-specifiers { enumerator-list , }
 
 enumerator-list:
        enumerator
@@ -1378,8 +1424,8 @@ ctf-specifier:
        event { ctf-assignment-expression-list-opt }
        stream { ctf-assignment-expression-list-opt }
        trace { ctf-assignment-expression-list-opt }
-       typealias declaration-specifiers abstract-declarator-list : declaration-specifiers abstract-declarator-list ;
-       typealias declaration-specifiers abstract-declarator-list : declarator-list ;
+       typealias declaration-specifiers abstract-declarator-list := declaration-specifiers abstract-declarator-list ;
+       typealias declaration-specifiers abstract-declarator-list := declarator-list ;
 
 ctf-type-specifier:
        floating_point { ctf-assignment-expression-list-opt }
@@ -1394,5 +1440,5 @@ ctf-assignment-expression:
        unary-expression assignment-operator unary-expression
        unary-expression type-assignment-operator type-specifier
        declaration-specifiers storage-class-specifier declaration-specifiers declarator-list
-       typealias declaration-specifiers abstract-declarator-list : declaration-specifiers abstract-declarator-list
-       typealias declaration-specifiers abstract-declarator-list : declarator-list
+       typealias declaration-specifiers abstract-declarator-list := declaration-specifiers abstract-declarator-list
+       typealias declaration-specifiers abstract-declarator-list := declarator-list
This page took 0.044749 seconds and 4 git commands to generate.