include/babeltrace/ctf/metadata.h

   1 #ifndef _BABELTRACE_CTF_METADATA_H
   2 #define _BABELTRACE_CTF_METADATA_H
   3
   4 /*
   5  * BabelTrace
   6  *
   7  * CTF 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 <uuid/uuid.h>
  24 #include <assert.h>
  25 #include <glib.h>
  26
  27 struct ctf_trace;
  28 struct ctf_stream;
  29 struct ctf_event;
  30
  31 #define CTF_TRACE_SET_FIELD(ctf_trace, field, value)                    \
  32         do {                                                            \
  33                 (ctf_trace)->(field) = (value);                         \
  34                 (ctf_trace)->field_mask |= CTF_TRACE_ ## field;         \
  35         } while (0)
  36
  37 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field)                        \
  38                 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
  39
  40 #define CTF_TRACE_GET_FIELD(ctf_trace, field)                           \
  41         ({                                                              \
  42                 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field));       \
  43                 (ctf_trace)->(field);                                   \
  44         })
  45
  46
  47 struct ctf_trace {
  48         /* root scope */
  49         struct type_scope *root_type_scope;
  50         /* root scope */
  51         struct declaration_scope *root_declaration_scope;
  52
  53         struct type_scope *type_scope;
  54         struct declaration_scope *declaration_scope;
  55         GPtrArray *streams;                     /* Array of struct ctf_stream pointers*/
  56
  57         uint64_t major;
  58         uint64_t minor;
  59         uuid_t uuid;
  60         uint64_t word_size;
  61
  62         enum {                                  /* Fields populated mask */
  63                 CTF_TRACE_major =       (1U << 0),
  64                 CTF_TRACE_minor =       (1U << 1),
  65                 CTF_TRACE_uuid  =       (1U << 2),
  66                 CTF_TRACE_word_size =   (1U << 3),
  67         } field_mask;
  68 };
  69
  70 #define CTF_STREAM_SET_FIELD(ctf_stream, field, value)                  \
  71         do {                                                            \
  72                 (ctf_stream)->(field) = (value);                        \
  73                 (ctf_stream)->field_mask |= CTF_STREAM_ ## field;       \
  74         } while (0)
  75
  76 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field)                      \
  77                 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
  78
  79 #define CTF_STREAM_GET_FIELD(ctf_stream, field)                         \
  80         ({                                                              \
  81                 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field));     \
  82                 (ctf_stream)->(field);                                  \
  83         })
  84
  85 struct ctf_stream {
  86         struct ctf_trace *trace;
  87         /* parent is lexical scope conaining the stream scope */
  88         struct type_scope *type_scope;
  89         /* parent is trace scope */
  90         struct declaration_scope *declaration_scope;
  91         GPtrArray *events_by_id;                /* Array of struct ctf_event pointers indexed by id */
  92         GHashTable *event_quark_to_id;          /* GQuark to numeric id */
  93
  94         struct declaration_struct *event_header;
  95         struct declaration_struct *event_context;
  96         struct declaration_struct *packet_context;
  97
  98         uint64_t stream_id;
  99
 100         enum {                                  /* Fields populated mask */
 101                 CTF_STREAM_stream_id =  (1 << 0),
 102         } field_mask;
 103 };
 104
 105 #define CTF_EVENT_SET_FIELD(ctf_event, field)                           \
 106         do {                                                            \
 107                 (ctf_event)->field_mask |= CTF_EVENT_ ## field;         \
 108         } while (0)
 109
 110 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field)                        \
 111                 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
 112
 113 #define CTF_EVENT_GET_FIELD(ctf_event, field)                           \
 114         ({                                                              \
 115                 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field));       \
 116                 (ctf_event)->(field);                                   \
 117         })
 118
 119 struct ctf_event {
 120         /* stream mapped by stream_id */
 121         struct ctf_stream *stream;
 122         /* parent is lexical scope conaining the event scope */
 123         struct type_scope *type_scope;
 124         /* parent is stream scope */
 125         struct declaration_scope *declaration_scope;
 126         struct declaration_struct *context;
 127         struct declaration_struct *fields;
 128
 129         GQuark name;
 130         uint64_t id;            /* Numeric identifier within the stream */
 131         uint64_t stream_id;
 132
 133         enum {                                  /* Fields populated mask */
 134                 CTF_EVENT_name  =       (1 << 0),
 135                 CTF_EVENT_id    =       (1 << 1),
 136                 CTF_EVENT_stream_id =   (1 << 2),
 137         } field_mask;
 138 };
 139
 140 #endif /* _BABELTRACE_CTF_METADATA_H */