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         int has_timestamp;
  40         uint64_t stream_id;
  41
  42         struct definition_struct *trace_packet_header;
  43         struct definition_struct *stream_packet_context;
  44         struct definition_struct *stream_event_header;
  45         struct definition_struct *stream_event_context;
  46         GPtrArray *events_by_id;                /* Array of struct ctf_stream_event pointers indexed by id */
  47         struct definition_scope *parent_def_scope;      /* for initialization */
  48         int stream_definitions_created;
  49 };
  50
  51 struct ctf_stream_event {
  52         struct definition_struct *event_context;
  53         struct definition_struct *event_fields;
  54 };
  55
  56 #define CTF_TRACE_SET_FIELD(ctf_trace, field)                           \
  57         do {                                                            \
  58                 (ctf_trace)->field_mask |= CTF_TRACE_ ## field;         \
  59         } while (0)
  60
  61 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field)                        \
  62                 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
  63
  64 #define CTF_TRACE_GET_FIELD(ctf_trace, field)                           \
  65         ({                                                              \
  66                 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field));       \
  67                 (ctf_trace)->(field);                                   \
  68         })
  69
  70
  71 struct ctf_trace {
  72         struct trace_descriptor parent;
  73         /* root scope */
  74         struct declaration_scope *root_declaration_scope;
  75
  76         struct declaration_scope *declaration_scope;
  77         /* innermost definition scope. to be used as parent of stream. */
  78         struct definition_scope *definition_scope;
  79         GPtrArray *streams;                     /* Array of struct ctf_stream_class pointers */
  80         struct ctf_stream *metadata;
  81
  82         /* Declarations only used when parsing */
  83         struct declaration_struct *packet_header_decl;
  84
  85         uint64_t major;
  86         uint64_t minor;
  87         uuid_t uuid;
  88         int byte_order;         /* trace BYTE_ORDER. 0 if unset. */
  89
  90         enum {                                  /* Fields populated mask */
  91                 CTF_TRACE_major         =       (1U << 0),
  92                 CTF_TRACE_minor         =       (1U << 1),
  93                 CTF_TRACE_uuid          =       (1U << 2),
  94                 CTF_TRACE_byte_order    =       (1U << 3),
  95                 CTF_TRACE_packet_header =       (1U << 4),
  96         } field_mask;
  97
  98         /* Information about trace backing directory and files */
  99         DIR *dir;
 100         int dirfd;
 101         int flags;              /* open flags */
 102
 103         /* Heap of streams, ordered to always get the lowest timestam */
 104         struct ptr_heap *stream_heap;
 105 };
 106
 107 #define CTF_STREAM_SET_FIELD(ctf_stream, field)                         \
 108         do {                                                            \
 109                 (ctf_stream)->field_mask |= CTF_STREAM_ ## field;       \
 110         } while (0)
 111
 112 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field)                      \
 113                 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
 114
 115 #define CTF_STREAM_GET_FIELD(ctf_stream, field)                         \
 116         ({                                                              \
 117                 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field));     \
 118                 (ctf_stream)->(field);                                  \
 119         })
 120
 121 struct ctf_stream_class {
 122         struct ctf_trace *trace;
 123         /* parent is lexical scope conaining the stream scope */
 124         struct declaration_scope *declaration_scope;
 125         /* innermost definition scope. to be used as parent of event. */
 126         struct definition_scope *definition_scope;
 127         GPtrArray *events_by_id;                /* Array of struct ctf_event pointers indexed by id */
 128         GHashTable *event_quark_to_id;          /* GQuark to numeric id */
 129
 130         /* Declarations only used when parsing */
 131         struct declaration_struct *packet_context_decl;
 132         struct declaration_struct *event_header_decl;
 133         struct declaration_struct *event_context_decl;
 134
 135         uint64_t stream_id;
 136
 137         enum {                                  /* Fields populated mask */
 138                 CTF_STREAM_stream_id =  (1 << 0),
 139         } field_mask;
 140
 141         GPtrArray *streams;     /* Array of struct ctf_stream pointers */
 142 };
 143
 144 #define CTF_EVENT_SET_FIELD(ctf_event, field)                           \
 145         do {                                                            \
 146                 (ctf_event)->field_mask |= CTF_EVENT_ ## field;         \
 147         } while (0)
 148
 149 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field)                        \
 150                 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
 151
 152 #define CTF_EVENT_GET_FIELD(ctf_event, field)                           \
 153         ({                                                              \
 154                 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field));       \
 155                 (ctf_event)->(field);                                   \
 156         })
 157
 158 struct ctf_event {
 159         /* stream mapped by stream_id */
 160         struct ctf_stream_class *stream;
 161         /* parent is lexical scope conaining the event scope */
 162         struct declaration_scope *declaration_scope;
 163
 164         /* Declarations only used when parsing */
 165         struct declaration_struct *context_decl;
 166         struct declaration_struct *fields_decl;
 167
 168         GQuark name;
 169         uint64_t id;            /* Numeric identifier within the stream */
 170         uint64_t stream_id;
 171
 172         enum {                                  /* Fields populated mask */
 173                 CTF_EVENT_name  =       (1 << 0),
 174                 CTF_EVENT_id    =       (1 << 1),
 175                 CTF_EVENT_stream_id =   (1 << 2),
 176         } field_mask;
 177 };
 178
 179 #endif /* _BABELTRACE_CTF_IR_METADATA_H */