include/babeltrace/ctf-ir/metadata.h

   1 #ifndef _BABELTRACE_CTF_IR_METADATA_H
   2 #define _BABELTRACE_CTF_IR_METADATA_H
   3
   4 /*
   5  * BabelTrace
   6  *
   7  * CTF Intermediate Representation 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  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <babeltrace/types.h>
  31 #include <babeltrace/format.h>
  32 #include <babeltrace/format-internal.h>
  33 #include <babeltrace/ctf/types.h>
  34 #include <sys/types.h>
  35 #include <dirent.h>
  36 #include <babeltrace/compat/uuid.h>
  37 #include <assert.h>
  38 #include <glib.h>
  39
  40 struct ctf_trace;
  41 struct ctf_stream_declaration;
  42 struct ctf_event_declaration;
  43 struct ctf_clock;
  44 struct ctf_callsite;
  45 struct ctf_scanner;
  46
  47 struct ctf_stream_definition {
  48         struct ctf_stream_declaration *stream_class;
  49         uint64_t real_timestamp;                /* Current timestamp, in ns */
  50         uint64_t cycles_timestamp;              /* Current timestamp, in cycles */
  51         uint64_t event_id;                      /* Current event ID */
  52         int has_timestamp;
  53         uint64_t stream_id;
  54
  55         struct definition_struct *trace_packet_header;
  56         struct definition_struct *stream_packet_context;
  57         struct definition_struct *stream_event_header;
  58         struct definition_struct *stream_event_context;
  59         GPtrArray *events_by_id;                /* Array of struct ctf_event_definition pointers indexed by id */
  60         struct definition_scope *parent_def_scope;      /* for initialization */
  61         int stream_definitions_created;
  62
  63         struct ctf_clock *current_clock;
  64
  65         /* Event discarded information */
  66         uint64_t events_discarded;
  67         uint64_t prev_real_timestamp;           /* Start-of-last-packet timestamp in ns */
  68         uint64_t prev_real_timestamp_end;       /* End-of-last-packet timestamp in ns */
  69         uint64_t prev_cycles_timestamp;         /* Start-of-last-packet timestamp in cycles */
  70         uint64_t prev_cycles_timestamp_end;     /* End-of-last-packet timestamp in cycles */
  71         char path[PATH_MAX];                    /* Path to stream. '\0' for mmap traces */
  72 };
  73
  74 struct ctf_event_definition {
  75         struct ctf_stream_definition *stream;
  76         struct definition_struct *event_context;
  77         struct definition_struct *event_fields;
  78 };
  79
  80 #define CTF_CLOCK_SET_FIELD(ctf_clock, field)                           \
  81         do {                                                            \
  82                 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field;         \
  83         } while (0)
  84
  85 #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)                        \
  86                 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
  87
  88 #define CTF_CLOCK_GET_FIELD(ctf_clock, field)                           \
  89         ({                                                              \
  90                 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field));       \
  91                 (ctf_clock)->(field);                                   \
  92         })
  93
  94 struct ctf_clock {
  95         GQuark name;
  96         GQuark uuid;
  97         char *description;
  98         uint64_t freq;  /* frequency, in HZ */
  99         /* precision in seconds is: precision * (1/freq) */
 100         uint64_t precision;
 101         /*
 102          * The offset from Epoch is: offset_s + (offset * (1/freq))
 103          * Coarse clock offset from Epoch (in seconds).
 104          */
 105         uint64_t offset_s;
 106         /* Fine clock offset from Epoch, in (1/freq) units. */
 107         uint64_t offset;
 108         int absolute;
 109
 110         enum {                                  /* Fields populated mask */
 111                 CTF_CLOCK_name          =       (1U << 0),
 112                 CTF_CLOCK_freq          =       (1U << 1),
 113         } field_mask;
 114 };
 115
 116 #define CTF_CALLSITE_SET_FIELD(ctf_callsite, field)                     \
 117         do {                                                            \
 118                 (ctf_callsite)->field_mask |= CTF_CALLSITE_ ## field;   \
 119         } while (0)
 120
 121 #define CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field)                  \
 122                 ((ctf_callsite)->field_mask & CTF_CALLSITE_ ## field)
 123
 124 #define CTF_CALLSITE_GET_FIELD(ctf_callsite, field)                     \
 125         ({                                                              \
 126                 assert(CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field)); \
 127                 (ctf_callsite)->(field);                                \
 128         })
 129
 130 struct ctf_callsite {
 131         GQuark name;            /* event name associated with callsite */
 132         char *func;
 133         char *file;
 134         uint64_t line;
 135         uint64_t ip;
 136         struct bt_list_head node;
 137         enum {                                  /* Fields populated mask */
 138                 CTF_CALLSITE_name       =       (1U << 0),
 139                 CTF_CALLSITE_func       =       (1U << 1),
 140                 CTF_CALLSITE_file       =       (1U << 2),
 141                 CTF_CALLSITE_line       =       (1U << 3),
 142                 CTF_CALLSITE_ip         =       (1U << 4),
 143         } field_mask;
 144 };
 145
 146 struct ctf_callsite_dups {
 147         struct bt_list_head head;
 148 };
 149
 150 #define CTF_TRACE_SET_FIELD(ctf_trace, field)                           \
 151         do {                                                            \
 152                 (ctf_trace)->field_mask |= CTF_TRACE_ ## field;         \
 153         } while (0)
 154
 155 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field)                        \
 156                 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
 157
 158 #define CTF_TRACE_GET_FIELD(ctf_trace, field)                           \
 159         ({                                                              \
 160                 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field));       \
 161                 (ctf_trace)->(field);                                   \
 162         })
 163
 164 #define TRACER_ENV_LEN  128
 165
 166 /* tracer-specific environment */
 167 struct ctf_tracer_env {
 168         int vpid;               /* negative if unset */
 169
 170         /* All strings below: "" if unset. */
 171         char procname[TRACER_ENV_LEN];
 172         char hostname[TRACER_ENV_LEN];
 173         char domain[TRACER_ENV_LEN];
 174         char sysname[TRACER_ENV_LEN];
 175         char release[TRACER_ENV_LEN];
 176         char version[TRACER_ENV_LEN];
 177 };
 178
 179 struct ctf_trace {
 180         struct bt_trace_descriptor parent;
 181
 182         /* root scope */
 183         struct declaration_scope *root_declaration_scope;
 184
 185         struct declaration_scope *declaration_scope;
 186         /* innermost definition scope. to be used as parent of stream. */
 187         struct definition_scope *definition_scope;
 188         GPtrArray *streams;                     /* Array of struct ctf_stream_declaration pointers */
 189         struct ctf_stream_definition *metadata;
 190         char *metadata_string;
 191         int metadata_packetized;
 192         GHashTable *callsites;
 193         GPtrArray *event_declarations;          /* Array of all the struct bt_ctf_event_decl */
 194
 195         struct declaration_struct *packet_header_decl;
 196         struct ctf_scanner *scanner;
 197         int restart_root_decl;
 198
 199         uint64_t major;
 200         uint64_t minor;
 201         unsigned char uuid[BABELTRACE_UUID_LEN];
 202         int byte_order;         /* trace BYTE_ORDER. 0 if unset. */
 203         struct ctf_tracer_env env;
 204
 205         enum {                                  /* Fields populated mask */
 206                 CTF_TRACE_major         =       (1U << 0),
 207                 CTF_TRACE_minor         =       (1U << 1),
 208                 CTF_TRACE_uuid          =       (1U << 2),
 209                 CTF_TRACE_byte_order    =       (1U << 3),
 210                 CTF_TRACE_packet_header =       (1U << 4),
 211         } field_mask;
 212
 213         /* Information about trace backing directory and files */
 214         DIR *dir;
 215         int dirfd;
 216         int flags;              /* open flags */
 217 };
 218
 219 #define CTF_STREAM_SET_FIELD(ctf_stream, field)                         \
 220         do {                                                            \
 221                 (ctf_stream)->field_mask |= CTF_STREAM_ ## field;       \
 222         } while (0)
 223
 224 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field)                      \
 225                 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
 226
 227 #define CTF_STREAM_GET_FIELD(ctf_stream, field)                         \
 228         ({                                                              \
 229                 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field));     \
 230                 (ctf_stream)->(field);                                  \
 231         })
 232
 233 struct ctf_stream_declaration {
 234         struct ctf_trace *trace;
 235         /* parent is lexical scope containing the stream scope */
 236         struct declaration_scope *declaration_scope;
 237         /* innermost definition scope. to be used as parent of event. */
 238         struct definition_scope *definition_scope;
 239         GPtrArray *events_by_id;                /* Array of struct ctf_event_declaration pointers indexed by id */
 240         GHashTable *event_quark_to_id;          /* GQuark to numeric id */
 241
 242         struct declaration_struct *packet_context_decl;
 243         struct declaration_struct *event_header_decl;
 244         struct declaration_struct *event_context_decl;
 245
 246         uint64_t stream_id;
 247
 248         enum {                                  /* Fields populated mask */
 249                 CTF_STREAM_stream_id =  (1 << 0),
 250         } field_mask;
 251
 252         GPtrArray *streams;     /* Array of struct ctf_stream_definition pointers */
 253 };
 254
 255 #define CTF_EVENT_SET_FIELD(ctf_event, field)                           \
 256         do {                                                            \
 257                 (ctf_event)->field_mask |= CTF_EVENT_ ## field;         \
 258         } while (0)
 259
 260 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field)                        \
 261                 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
 262
 263 #define CTF_EVENT_GET_FIELD(ctf_event, field)                           \
 264         ({                                                              \
 265                 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field));       \
 266                 (ctf_event)->(field);                                   \
 267         })
 268
 269 struct ctf_event_declaration {
 270         /* stream mapped by stream_id */
 271         struct ctf_stream_declaration *stream;
 272         /* parent is lexical scope containing the event scope */
 273         struct declaration_scope *declaration_scope;
 274
 275         struct declaration_struct *context_decl;
 276         struct declaration_struct *fields_decl;
 277
 278         GQuark name;
 279         uint64_t id;            /* Numeric identifier within the stream */
 280         uint64_t stream_id;
 281         int loglevel;
 282         GQuark model_emf_uri;
 283
 284         enum {                                  /* Fields populated mask */
 285                 CTF_EVENT_name  =               (1 << 0),
 286                 CTF_EVENT_id    =               (1 << 1),
 287                 CTF_EVENT_stream_id =           (1 << 2),
 288                 CTF_EVENT_loglevel =            (1 << 4),
 289                 CTF_EVENT_model_emf_uri =       (1 << 5),
 290         } field_mask;
 291 };
 292
 293 #endif /* _BABELTRACE_CTF_IR_METADATA_H */