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