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