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