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 <uuid/uuid.h>
  28 #include <assert.h>
  29 #include <glib.h>
  30
  31 struct ctf_trace;
  32 struct ctf_stream_class;
  33 struct ctf_stream;
  34 struct ctf_event;
  35
  36 struct ctf_stream {
  37         struct ctf_stream_class *stream_class;
  38         uint64_t timestamp;                     /* Current timestamp, in ns */
  39         uint64_t event_id;                      /* Current event ID */
  40         int has_timestamp;
  41         uint64_t stream_id;
  42
  43         struct definition_struct *trace_packet_header;
  44         struct definition_struct *stream_packet_context;
  45         struct definition_struct *stream_event_header;
  46         struct definition_struct *stream_event_context;
  47         GPtrArray *events_by_id;                /* Array of struct ctf_stream_event pointers indexed by id */
  48         struct definition_scope *parent_def_scope;      /* for initialization */
  49         int stream_definitions_created;
  50 };
  51
  52 struct ctf_stream_event {
  53         struct definition_struct *event_context;
  54         struct definition_struct *event_fields;
  55 };
  56
  57 #define CTF_CLOCK_SET_FIELD(ctf_clock, field)                           \
  58         do {                                                            \
  59                 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field;         \
  60         } while (0)
  61
  62 #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)                        \
  63                 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
  64
  65 #define CTF_CLOCK_GET_FIELD(ctf_clock, field)                           \
  66         ({                                                              \
  67                 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field));       \
  68                 (ctf_clock)->(field);                                   \
  69         })
  70
  71 struct ctf_clock {
  72         GQuark name;
  73         GQuark uuid;
  74         char *description;
  75         uint64_t freq;  /* frequency, in HZ */
  76         /* precision in seconds is: precision * (1/freq) */
  77         uint64_t precision;
  78         /*
  79          * The offset from Epoch is: offset_s + (offset * (1/freq))
  80          * Coarse clock offset from Epoch (in seconds).
  81          */
  82         uint64_t offset_s;
  83         /* Fine clock offset from Epoch, in (1/freq) units. */
  84         uint64_t offset;
  85
  86         enum {                                  /* Fields populated mask */
  87                 CTF_CLOCK_name          =       (1U << 0),
  88         } field_mask;
  89 };
  90
  91 #define CTF_TRACE_SET_FIELD(ctf_trace, field)                           \
  92         do {                                                            \
  93                 (ctf_trace)->field_mask |= CTF_TRACE_ ## field;         \
  94         } while (0)
  95
  96 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field)                        \
  97                 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
  98
  99 #define CTF_TRACE_GET_FIELD(ctf_trace, field)                           \
 100         ({                                                              \
 101                 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field));       \
 102                 (ctf_trace)->(field);                                   \
 103         })
 104
 105 struct ctf_trace {
 106         struct trace_descriptor parent;
 107         /* root scope */
 108         struct declaration_scope *root_declaration_scope;
 109
 110         struct declaration_scope *declaration_scope;
 111         /* innermost definition scope. to be used as parent of stream. */
 112         struct definition_scope *definition_scope;
 113         GPtrArray *streams;                     /* Array of struct ctf_stream_class pointers */
 114         struct ctf_stream *metadata;
 115         GHashTable *clocks;
 116
 117         struct declaration_struct *packet_header_decl;
 118
 119         uint64_t major;
 120         uint64_t minor;
 121         uuid_t uuid;
 122         int byte_order;         /* trace BYTE_ORDER. 0 if unset. */
 123
 124         enum {                                  /* Fields populated mask */
 125                 CTF_TRACE_major         =       (1U << 0),
 126                 CTF_TRACE_minor         =       (1U << 1),
 127                 CTF_TRACE_uuid          =       (1U << 2),
 128                 CTF_TRACE_byte_order    =       (1U << 3),
 129                 CTF_TRACE_packet_header =       (1U << 4),
 130         } field_mask;
 131
 132         /* Information about trace backing directory and files */
 133         DIR *dir;
 134         int dirfd;
 135         int flags;              /* open flags */
 136
 137         /* Heap of streams, ordered to always get the lowest timestam */
 138         struct ptr_heap *stream_heap;
 139         char collection_path[PATH_MAX];
 140         char path[PATH_MAX];
 141         char domain[PATH_MAX];
 142         char procname[PATH_MAX];
 143         char vpid[PATH_MAX];
 144 };
 145
 146 #define CTF_STREAM_SET_FIELD(ctf_stream, field)                         \
 147         do {                                                            \
 148                 (ctf_stream)->field_mask |= CTF_STREAM_ ## field;       \
 149         } while (0)
 150
 151 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field)                      \
 152                 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
 153
 154 #define CTF_STREAM_GET_FIELD(ctf_stream, field)                         \
 155         ({                                                              \
 156                 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field));     \
 157                 (ctf_stream)->(field);                                  \
 158         })
 159
 160 struct ctf_stream_class {
 161         struct ctf_trace *trace;
 162         /* parent is lexical scope conaining the stream scope */
 163         struct declaration_scope *declaration_scope;
 164         /* innermost definition scope. to be used as parent of event. */
 165         struct definition_scope *definition_scope;
 166         GPtrArray *events_by_id;                /* Array of struct ctf_event pointers indexed by id */
 167         GHashTable *event_quark_to_id;          /* GQuark to numeric id */
 168
 169         struct declaration_struct *packet_context_decl;
 170         struct declaration_struct *event_header_decl;
 171         struct declaration_struct *event_context_decl;
 172
 173         uint64_t stream_id;
 174
 175         enum {                                  /* Fields populated mask */
 176                 CTF_STREAM_stream_id =  (1 << 0),
 177         } field_mask;
 178
 179         GPtrArray *streams;     /* Array of struct ctf_stream pointers */
 180 };
 181
 182 #define CTF_EVENT_SET_FIELD(ctf_event, field)                           \
 183         do {                                                            \
 184                 (ctf_event)->field_mask |= CTF_EVENT_ ## field;         \
 185         } while (0)
 186
 187 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field)                        \
 188                 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
 189
 190 #define CTF_EVENT_GET_FIELD(ctf_event, field)                           \
 191         ({                                                              \
 192                 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field));       \
 193                 (ctf_event)->(field);                                   \
 194         })
 195
 196 struct ctf_event {
 197         /* stream mapped by stream_id */
 198         struct ctf_stream_class *stream;
 199         /* parent is lexical scope conaining the event scope */
 200         struct declaration_scope *declaration_scope;
 201
 202         struct declaration_struct *context_decl;
 203         struct declaration_struct *fields_decl;
 204
 205         GQuark name;
 206         uint64_t id;            /* Numeric identifier within the stream */
 207         uint64_t stream_id;
 208         GQuark loglevel_identifier;
 209         int64_t loglevel_value;
 210
 211         enum {                                  /* Fields populated mask */
 212                 CTF_EVENT_name  =               (1 << 0),
 213                 CTF_EVENT_id    =               (1 << 1),
 214                 CTF_EVENT_stream_id =           (1 << 2),
 215                 CTF_EVENT_loglevel_identifier = (1 << 3),
 216                 CTF_EVENT_loglevel_value =      (1 << 4),
 217         } field_mask;
 218 };
 219
 220 #endif /* _BABELTRACE_CTF_IR_METADATA_H */