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