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
  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 <babeltrace/uuid.h>
  28 #include <assert.h>
  29 #include <glib.h>
  30
  31 struct ctf_trace;
  32 struct ctf_stream_declaration;
  33 struct ctf_event_declaration;
  34 struct ctf_clock;
  35 struct ctf_callsite;
  36
  37 struct ctf_stream_definition {
  38         struct ctf_stream_declaration *stream_class;
  39         uint64_t real_timestamp;                /* Current timestamp, in ns */
  40         uint64_t cycles_timestamp;              /* Current timestamp, in cycles */
  41         uint64_t event_id;                      /* Current event ID */
  42         int has_timestamp;
  43         uint64_t stream_id;
  44
  45         struct definition_struct *trace_packet_header;
  46         struct definition_struct *stream_packet_context;
  47         struct definition_struct *stream_event_header;
  48         struct definition_struct *stream_event_context;
  49         GPtrArray *events_by_id;                /* Array of struct ctf_event_definition pointers indexed by id */
  50         struct definition_scope *parent_def_scope;      /* for initialization */
  51         int stream_definitions_created;
  52
  53         struct ctf_clock *current_clock;
  54
  55         /* Event discarded information */
  56         uint64_t events_discarded;
  57         uint64_t prev_real_timestamp;           /* Start-of-last-packet timestamp in ns */
  58         uint64_t prev_real_timestamp_end;       /* End-of-last-packet timestamp in ns */
  59         uint64_t prev_cycles_timestamp;         /* Start-of-last-packet timestamp in cycles */
  60         uint64_t prev_cycles_timestamp_end;     /* End-of-last-packet timestamp in cycles */
  61 };
  62
  63 struct ctf_event_definition {
  64         struct ctf_stream_definition *stream;
  65         struct definition_struct *event_context;
  66         struct definition_struct *event_fields;
  67 };
  68
  69 #define CTF_CLOCK_SET_FIELD(ctf_clock, field)                           \
  70         do {                                                            \
  71                 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field;         \
  72         } while (0)
  73
  74 #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)                        \
  75                 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
  76
  77 #define CTF_CLOCK_GET_FIELD(ctf_clock, field)                           \
  78         ({                                                              \
  79                 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field));       \
  80                 (ctf_clock)->(field);                                   \
  81         })
  82
  83 struct ctf_clock {
  84         GQuark name;
  85         GQuark uuid;
  86         char *description;
  87         uint64_t freq;  /* frequency, in HZ */
  88         /* precision in seconds is: precision * (1/freq) */
  89         uint64_t precision;
  90         /*
  91          * The offset from Epoch is: offset_s + (offset * (1/freq))
  92          * Coarse clock offset from Epoch (in seconds).
  93          */
  94         uint64_t offset_s;
  95         /* Fine clock offset from Epoch, in (1/freq) units. */
  96         uint64_t offset;
  97         int absolute;
  98
  99         enum {                                  /* Fields populated mask */
 100                 CTF_CLOCK_name          =       (1U << 0),
 101                 CTF_CLOCK_freq          =       (1U << 1),
 102         } field_mask;
 103 };
 104
 105 #define CTF_CALLSITE_SET_FIELD(ctf_callsite, field)                     \
 106         do {                                                            \
 107                 (ctf_callsite)->field_mask |= CTF_CALLSITE_ ## field;   \
 108         } while (0)
 109
 110 #define CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field)                  \
 111                 ((ctf_callsite)->field_mask & CTF_CALLSITE_ ## field)
 112
 113 #define CTF_CALLSITE_GET_FIELD(ctf_callsite, field)                     \
 114         ({                                                              \
 115                 assert(CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field)); \
 116                 (ctf_callsite)->(field);                                \
 117         })
 118
 119 struct ctf_callsite {
 120         GQuark name;            /* event name associated with callsite */
 121         char *func;
 122         char *file;
 123         uint64_t line;
 124         enum {                                  /* Fields populated mask */
 125                 CTF_CALLSITE_name       =       (1U << 0),
 126                 CTF_CALLSITE_func       =       (1U << 1),
 127                 CTF_CALLSITE_file       =       (1U << 2),
 128                 CTF_CALLSITE_line       =       (1U << 3),
 129         } field_mask;
 130 };
 131
 132 #define CTF_TRACE_SET_FIELD(ctf_trace, field)                           \
 133         do {                                                            \
 134                 (ctf_trace)->field_mask |= CTF_TRACE_ ## field;         \
 135         } while (0)
 136
 137 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field)                        \
 138                 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
 139
 140 #define CTF_TRACE_GET_FIELD(ctf_trace, field)                           \
 141         ({                                                              \
 142                 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field));       \
 143                 (ctf_trace)->(field);                                   \
 144         })
 145
 146 #define TRACER_ENV_LEN  128
 147
 148 /* tracer-specific environment */
 149 struct ctf_tracer_env {
 150         int vpid;               /* negative if unset */
 151
 152         /* All strings below: "" if unset. */
 153         char procname[TRACER_ENV_LEN];
 154         char hostname[TRACER_ENV_LEN];
 155         char domain[TRACER_ENV_LEN];
 156         char sysname[TRACER_ENV_LEN];
 157         char release[TRACER_ENV_LEN];
 158         char version[TRACER_ENV_LEN];
 159 };
 160
 161 struct ctf_trace {
 162         struct trace_descriptor parent;
 163         /* root scope */
 164         struct declaration_scope *root_declaration_scope;
 165
 166         struct declaration_scope *declaration_scope;
 167         /* innermost definition scope. to be used as parent of stream. */
 168         struct definition_scope *definition_scope;
 169         GPtrArray *streams;                     /* Array of struct ctf_stream_declaration pointers */
 170         struct ctf_stream_definition *metadata;
 171         GHashTable *clocks;
 172         GHashTable *callsites;
 173         struct ctf_clock *single_clock;         /* currently supports only one clock */
 174         struct trace_collection *collection;    /* Container of this trace */
 175         GPtrArray *event_declarations;          /* Array of all the struct bt_ctf_event_decl */
 176
 177         struct declaration_struct *packet_header_decl;
 178
 179         uint64_t major;
 180         uint64_t minor;
 181         unsigned char uuid[BABELTRACE_UUID_LEN];
 182         int byte_order;         /* trace BYTE_ORDER. 0 if unset. */
 183         struct ctf_tracer_env env;
 184
 185         enum {                                  /* Fields populated mask */
 186                 CTF_TRACE_major         =       (1U << 0),
 187                 CTF_TRACE_minor         =       (1U << 1),
 188                 CTF_TRACE_uuid          =       (1U << 2),
 189                 CTF_TRACE_byte_order    =       (1U << 3),
 190                 CTF_TRACE_packet_header =       (1U << 4),
 191         } field_mask;
 192
 193         /* Information about trace backing directory and files */
 194         DIR *dir;
 195         int dirfd;
 196         int flags;              /* open flags */
 197
 198         /* Heap of streams, ordered to always get the lowest timestam */
 199         struct ptr_heap *stream_heap;
 200         char path[PATH_MAX];
 201
 202         struct bt_context *ctx;
 203         struct bt_trace_handle *handle;
 204 };
 205
 206 #define CTF_STREAM_SET_FIELD(ctf_stream, field)                         \
 207         do {                                                            \
 208                 (ctf_stream)->field_mask |= CTF_STREAM_ ## field;       \
 209         } while (0)
 210
 211 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field)                      \
 212                 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
 213
 214 #define CTF_STREAM_GET_FIELD(ctf_stream, field)                         \
 215         ({                                                              \
 216                 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field));     \
 217                 (ctf_stream)->(field);                                  \
 218         })
 219
 220 struct ctf_stream_declaration {
 221         struct ctf_trace *trace;
 222         /* parent is lexical scope conaining the stream scope */
 223         struct declaration_scope *declaration_scope;
 224         /* innermost definition scope. to be used as parent of event. */
 225         struct definition_scope *definition_scope;
 226         GPtrArray *events_by_id;                /* Array of struct ctf_event_declaration pointers indexed by id */
 227         GHashTable *event_quark_to_id;          /* GQuark to numeric id */
 228
 229         struct declaration_struct *packet_context_decl;
 230         struct declaration_struct *event_header_decl;
 231         struct declaration_struct *event_context_decl;
 232
 233         uint64_t stream_id;
 234
 235         enum {                                  /* Fields populated mask */
 236                 CTF_STREAM_stream_id =  (1 << 0),
 237         } field_mask;
 238
 239         GPtrArray *streams;     /* Array of struct ctf_stream_definition pointers */
 240 };
 241
 242 #define CTF_EVENT_SET_FIELD(ctf_event, field)                           \
 243         do {                                                            \
 244                 (ctf_event)->field_mask |= CTF_EVENT_ ## field;         \
 245         } while (0)
 246
 247 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field)                        \
 248                 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
 249
 250 #define CTF_EVENT_GET_FIELD(ctf_event, field)                           \
 251         ({                                                              \
 252                 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field));       \
 253                 (ctf_event)->(field);                                   \
 254         })
 255
 256 struct ctf_event_declaration {
 257         /* stream mapped by stream_id */
 258         struct ctf_stream_declaration *stream;
 259         /* parent is lexical scope conaining the event scope */
 260         struct declaration_scope *declaration_scope;
 261
 262         struct declaration_struct *context_decl;
 263         struct declaration_struct *fields_decl;
 264
 265         GQuark name;
 266         uint64_t id;            /* Numeric identifier within the stream */
 267         uint64_t stream_id;
 268         int loglevel;
 269         GQuark model_emf_uri;
 270
 271         enum {                                  /* Fields populated mask */
 272                 CTF_EVENT_name  =               (1 << 0),
 273                 CTF_EVENT_id    =               (1 << 1),
 274                 CTF_EVENT_stream_id =           (1 << 2),
 275                 CTF_EVENT_loglevel =            (1 << 4),
 276                 CTF_EVENT_model_emf_uri =       (1 << 5),
 277         } field_mask;
 278 };
 279
 280 #endif /* _BABELTRACE_CTF_IR_METADATA_H */