include/babeltrace/ctf/metadata.h

   1 #ifndef _BABELTRACE_CTF_METADATA_H
   2 #define _BABELTRACE_CTF_METADATA_H
   3
   4 /*
   5  * BabelTrace
   6  *
   7  * CTF Metadata Header
   8  *
   9  * Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  */
  21
  22 #include <babeltrace/types.h>
  23 #include <babeltrace/format.h>
  24 #include <babeltrace/ctf/types.h>
  25 #include <sys/types.h>
  26 #include <dirent.h>
  27 #include <uuid/uuid.h>
  28 #include <assert.h>
  29 #include <glib.h>
  30
  31 #define CTF_MAGIC       0xC1FC1FC1
  32
  33 struct ctf_trace;
  34 struct ctf_stream_class;
  35 struct ctf_stream;
  36 struct ctf_event;
  37
  38 struct ctf_stream {
  39         struct ctf_stream_class *stream_class;
  40         uint64_t timestamp;                     /* Current timestamp, in ns */
  41 };
  42
  43 struct ctf_file_stream {
  44         uint64_t stream_id;
  45         struct ctf_stream stream;
  46         struct ctf_stream_pos pos;      /* current stream position */
  47 };
  48
  49 #define CTF_TRACE_SET_FIELD(ctf_trace, field)                           \
  50         do {                                                            \
  51                 (ctf_trace)->field_mask |= CTF_TRACE_ ## field;         \
  52         } while (0)
  53
  54 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field)                        \
  55                 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
  56
  57 #define CTF_TRACE_GET_FIELD(ctf_trace, field)                           \
  58         ({                                                              \
  59                 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field));       \
  60                 (ctf_trace)->(field);                                   \
  61         })
  62
  63
  64 struct ctf_trace {
  65         struct trace_descriptor parent;
  66         /* root scope */
  67         struct declaration_scope *root_declaration_scope;
  68
  69         struct declaration_scope *declaration_scope;
  70         /* innermost definition scope. to be used as parent of stream. */
  71         struct definition_scope *definition_scope;
  72         GPtrArray *streams;                     /* Array of struct ctf_stream_class pointers */
  73         struct ctf_file_stream metadata;
  74
  75         /* Declarations only used when parsing */
  76         struct declaration_struct *packet_header_decl;
  77
  78         /* Definitions used afterward */
  79         struct definition_struct *packet_header;
  80
  81         uint64_t major;
  82         uint64_t minor;
  83         uuid_t uuid;
  84         int byte_order;         /* trace BYTE_ORDER. 0 if unset. */
  85
  86         enum {                                  /* Fields populated mask */
  87                 CTF_TRACE_major         =       (1U << 0),
  88                 CTF_TRACE_minor         =       (1U << 1),
  89                 CTF_TRACE_uuid          =       (1U << 2),
  90                 CTF_TRACE_byte_order    =       (1U << 3),
  91                 CTF_TRACE_packet_header =       (1U << 4),
  92         } field_mask;
  93
  94         /* Information about trace backing directory and files */
  95         DIR *dir;
  96         int dirfd;
  97         int flags;              /* open flags */
  98 };
  99
 100 #define CTF_STREAM_SET_FIELD(ctf_stream, field)                         \
 101         do {                                                            \
 102                 (ctf_stream)->field_mask |= CTF_STREAM_ ## field;       \
 103         } while (0)
 104
 105 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field)                      \
 106                 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
 107
 108 #define CTF_STREAM_GET_FIELD(ctf_stream, field)                         \
 109         ({                                                              \
 110                 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field));     \
 111                 (ctf_stream)->(field);                                  \
 112         })
 113
 114 struct ctf_stream_class {
 115         struct ctf_trace *trace;
 116         /* parent is lexical scope conaining the stream scope */
 117         struct declaration_scope *declaration_scope;
 118         /* innermost definition scope. to be used as parent of event. */
 119         struct definition_scope *definition_scope;
 120         GPtrArray *events_by_id;                /* Array of struct ctf_event pointers indexed by id */
 121         GHashTable *event_quark_to_id;          /* GQuark to numeric id */
 122
 123         /* Declarations only used when parsing */
 124         struct declaration_struct *packet_context_decl;
 125         struct declaration_struct *event_header_decl;
 126         struct declaration_struct *event_context_decl;
 127
 128         /* Definitions used afterward */
 129         struct definition_struct *packet_context;
 130         struct definition_struct *event_header;
 131         struct definition_struct *event_context;
 132
 133         uint64_t stream_id;
 134
 135         enum {                                  /* Fields populated mask */
 136                 CTF_STREAM_stream_id =  (1 << 0),
 137         } field_mask;
 138
 139         GPtrArray *files;                       /* Array of struct ctf_file_stream pointers */
 140 };
 141
 142 #define CTF_EVENT_SET_FIELD(ctf_event, field)                           \
 143         do {                                                            \
 144                 (ctf_event)->field_mask |= CTF_EVENT_ ## field;         \
 145         } while (0)
 146
 147 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field)                        \
 148                 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
 149
 150 #define CTF_EVENT_GET_FIELD(ctf_event, field)                           \
 151         ({                                                              \
 152                 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field));       \
 153                 (ctf_event)->(field);                                   \
 154         })
 155
 156 struct ctf_event {
 157         /* stream mapped by stream_id */
 158         struct ctf_stream_class *stream;
 159         /* parent is lexical scope conaining the event scope */
 160         struct declaration_scope *declaration_scope;
 161
 162         /* Declarations only used when parsing */
 163         struct declaration_struct *context_decl;
 164         struct declaration_struct *fields_decl;
 165
 166         /* Definitions used afterward */
 167         struct definition_struct *context;
 168         struct definition_struct *fields;
 169
 170         GQuark name;
 171         uint64_t id;            /* Numeric identifier within the stream */
 172         uint64_t stream_id;
 173
 174         enum {                                  /* Fields populated mask */
 175                 CTF_EVENT_name  =       (1 << 0),
 176                 CTF_EVENT_id    =       (1 << 1),
 177                 CTF_EVENT_stream_id =   (1 << 2),
 178         } field_mask;
 179 };
 180
 181 #endif /* _BABELTRACE_CTF_METADATA_H */