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         int absolute;
  86
  87         enum {                                  /* Fields populated mask */
  88                 CTF_CLOCK_name          =       (1U << 0),
  89         } field_mask;
  90 };
  91
  92 #define CTF_TRACE_SET_FIELD(ctf_trace, field)                           \
  93         do {                                                            \
  94                 (ctf_trace)->field_mask |= CTF_TRACE_ ## field;         \
  95         } while (0)
  96
  97 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field)                        \
  98                 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
  99
 100 #define CTF_TRACE_GET_FIELD(ctf_trace, field)                           \
 101         ({                                                              \
 102                 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field));       \
 103                 (ctf_trace)->(field);                                   \
 104         })
 105
 106 struct ctf_trace {
 107         struct trace_descriptor parent;
 108         /* root scope */
 109         struct declaration_scope *root_declaration_scope;
 110
 111         struct declaration_scope *declaration_scope;
 112         /* innermost definition scope. to be used as parent of stream. */
 113         struct definition_scope *definition_scope;
 114         GPtrArray *streams;                     /* Array of struct ctf_stream_class pointers */
 115         struct ctf_stream *metadata;
 116         GHashTable *clocks;
 117
 118         struct declaration_struct *packet_header_decl;
 119
 120         uint64_t major;
 121         uint64_t minor;
 122         uuid_t uuid;
 123         int byte_order;         /* trace BYTE_ORDER. 0 if unset. */
 124
 125         enum {                                  /* Fields populated mask */
 126                 CTF_TRACE_major         =       (1U << 0),
 127                 CTF_TRACE_minor         =       (1U << 1),
 128                 CTF_TRACE_uuid          =       (1U << 2),
 129                 CTF_TRACE_byte_order    =       (1U << 3),
 130                 CTF_TRACE_packet_header =       (1U << 4),
 131         } field_mask;
 132
 133         /* Information about trace backing directory and files */
 134         DIR *dir;
 135         int dirfd;
 136         int flags;              /* open flags */
 137
 138         /* Heap of streams, ordered to always get the lowest timestam */
 139         struct ptr_heap *stream_heap;
 140         char collection_path[PATH_MAX];
 141         char path[PATH_MAX];
 142         char domain[PATH_MAX];
 143         char procname[PATH_MAX];
 144         char vpid[PATH_MAX];
 145 };
 146
 147 #define CTF_STREAM_SET_FIELD(ctf_stream, field)                         \
 148         do {                                                            \
 149                 (ctf_stream)->field_mask |= CTF_STREAM_ ## field;       \
 150         } while (0)
 151
 152 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field)                      \
 153                 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
 154
 155 #define CTF_STREAM_GET_FIELD(ctf_stream, field)                         \
 156         ({                                                              \
 157                 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field));     \
 158                 (ctf_stream)->(field);                                  \
 159         })
 160
 161 struct ctf_stream_class {
 162         struct ctf_trace *trace;
 163         /* parent is lexical scope conaining the stream scope */
 164         struct declaration_scope *declaration_scope;
 165         /* innermost definition scope. to be used as parent of event. */
 166         struct definition_scope *definition_scope;
 167         GPtrArray *events_by_id;                /* Array of struct ctf_event pointers indexed by id */
 168         GHashTable *event_quark_to_id;          /* GQuark to numeric id */
 169
 170         struct declaration_struct *packet_context_decl;
 171         struct declaration_struct *event_header_decl;
 172         struct declaration_struct *event_context_decl;
 173
 174         uint64_t stream_id;
 175
 176         enum {                                  /* Fields populated mask */
 177                 CTF_STREAM_stream_id =  (1 << 0),
 178         } field_mask;
 179
 180         GPtrArray *streams;     /* Array of struct ctf_stream pointers */
 181 };
 182
 183 #define CTF_EVENT_SET_FIELD(ctf_event, field)                           \
 184         do {                                                            \
 185                 (ctf_event)->field_mask |= CTF_EVENT_ ## field;         \
 186         } while (0)
 187
 188 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field)                        \
 189                 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
 190
 191 #define CTF_EVENT_GET_FIELD(ctf_event, field)                           \
 192         ({                                                              \
 193                 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field));       \
 194                 (ctf_event)->(field);                                   \
 195         })
 196
 197 struct ctf_event {
 198         /* stream mapped by stream_id */
 199         struct ctf_stream_class *stream;
 200         /* parent is lexical scope conaining the event scope */
 201         struct declaration_scope *declaration_scope;
 202
 203         struct declaration_struct *context_decl;
 204         struct declaration_struct *fields_decl;
 205
 206         GQuark name;
 207         uint64_t id;            /* Numeric identifier within the stream */
 208         uint64_t stream_id;
 209         GQuark loglevel_identifier;
 210         int64_t loglevel_value;
 211
 212         enum {                                  /* Fields populated mask */
 213                 CTF_EVENT_name  =               (1 << 0),
 214                 CTF_EVENT_id    =               (1 << 1),
 215                 CTF_EVENT_stream_id =           (1 << 2),
 216                 CTF_EVENT_loglevel_identifier = (1 << 3),
 217                 CTF_EVENT_loglevel_value =      (1 << 4),
 218         } field_mask;
 219 };
 220
 221 #endif /* _BABELTRACE_CTF_IR_METADATA_H */