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         int byte_order;
  57
  58         enum {                                  /* Fields populated mask */
  59                 CTF_TRACE_major =       (1U << 0),
  60                 CTF_TRACE_minor =       (1U << 1),
  61                 CTF_TRACE_uuid  =       (1U << 2),
  62         } field_mask;
  63 };
  64
  65 #define CTF_STREAM_SET_FIELD(ctf_stream, field)                         \
  66         do {                                                            \
  67                 (ctf_stream)->field_mask |= CTF_STREAM_ ## field;       \
  68         } while (0)
  69
  70 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field)                      \
  71                 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
  72
  73 #define CTF_STREAM_GET_FIELD(ctf_stream, field)                         \
  74         ({                                                              \
  75                 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field));     \
  76                 (ctf_stream)->(field);                                  \
  77         })
  78
  79 struct ctf_stream {
  80         struct ctf_trace *trace;
  81         /* parent is lexical scope conaining the stream scope */
  82         struct declaration_scope *declaration_scope;
  83         /* innermost definition scope. to be used as parent of event. */
  84         struct definition_scope *definition_scope;
  85         GPtrArray *events_by_id;                /* Array of struct ctf_event pointers indexed by id */
  86         GHashTable *event_quark_to_id;          /* GQuark to numeric id */
  87
  88         /* Declarations only used when parsing */
  89         struct declaration_struct *packet_context_decl;
  90         struct declaration_struct *event_header_decl;
  91         struct declaration_struct *event_context_decl;
  92
  93         /* Definitions used afterward */
  94         struct definition_struct *packet_context;
  95         struct definition_struct *event_header;
  96         struct definition_struct *event_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 declaration_scope *declaration_scope;
 124
 125         /* Declarations only used when parsing */
 126         struct declaration_struct *context_decl;
 127         struct declaration_struct *fields_decl;
 128
 129         /* Definitions used afterward */
 130         struct definition_struct *context;
 131         struct definition_struct *fields;
 132
 133         GQuark name;
 134         uint64_t id;            /* Numeric identifier within the stream */
 135         uint64_t stream_id;
 136
 137         enum {                                  /* Fields populated mask */
 138                 CTF_EVENT_name  =       (1 << 0),
 139                 CTF_EVENT_id    =       (1 << 1),
 140                 CTF_EVENT_stream_id =   (1 << 2),
 141         } field_mask;
 142 };
 143
 144 #endif /* _BABELTRACE_CTF_METADATA_H */