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