Namespace the struct trace_descriptor
[babeltrace.git] / include / babeltrace / ctf-ir / metadata.h
1 #ifndef _BABELTRACE_CTF_IR_METADATA_H
2 #define _BABELTRACE_CTF_IR_METADATA_H
3
4 /*
5 * BabelTrace
6 *
7 * CTF Intermediate Representation 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 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * SOFTWARE.
28 */
29
30 #include <babeltrace/types.h>
31 #include <babeltrace/format.h>
32 #include <babeltrace/ctf/types.h>
33 #include <sys/types.h>
34 #include <dirent.h>
35 #include <babeltrace/uuid.h>
36 #include <assert.h>
37 #include <glib.h>
38
39 struct ctf_trace;
40 struct ctf_stream_declaration;
41 struct ctf_event_declaration;
42 struct ctf_clock;
43 struct ctf_callsite;
44
45 struct ctf_stream_definition {
46 struct ctf_stream_declaration *stream_class;
47 uint64_t real_timestamp; /* Current timestamp, in ns */
48 uint64_t cycles_timestamp; /* Current timestamp, in cycles */
49 uint64_t event_id; /* Current event ID */
50 int has_timestamp;
51 uint64_t stream_id;
52
53 struct definition_struct *trace_packet_header;
54 struct definition_struct *stream_packet_context;
55 struct definition_struct *stream_event_header;
56 struct definition_struct *stream_event_context;
57 GPtrArray *events_by_id; /* Array of struct ctf_event_definition pointers indexed by id */
58 struct definition_scope *parent_def_scope; /* for initialization */
59 int stream_definitions_created;
60
61 struct ctf_clock *current_clock;
62
63 /* Event discarded information */
64 uint64_t events_discarded;
65 uint64_t prev_real_timestamp; /* Start-of-last-packet timestamp in ns */
66 uint64_t prev_real_timestamp_end; /* End-of-last-packet timestamp in ns */
67 uint64_t prev_cycles_timestamp; /* Start-of-last-packet timestamp in cycles */
68 uint64_t prev_cycles_timestamp_end; /* End-of-last-packet timestamp in cycles */
69 };
70
71 struct ctf_event_definition {
72 struct ctf_stream_definition *stream;
73 struct definition_struct *event_context;
74 struct definition_struct *event_fields;
75 };
76
77 #define CTF_CLOCK_SET_FIELD(ctf_clock, field) \
78 do { \
79 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field; \
80 } while (0)
81
82 #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field) \
83 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
84
85 #define CTF_CLOCK_GET_FIELD(ctf_clock, field) \
86 ({ \
87 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)); \
88 (ctf_clock)->(field); \
89 })
90
91 struct ctf_clock {
92 GQuark name;
93 GQuark uuid;
94 char *description;
95 uint64_t freq; /* frequency, in HZ */
96 /* precision in seconds is: precision * (1/freq) */
97 uint64_t precision;
98 /*
99 * The offset from Epoch is: offset_s + (offset * (1/freq))
100 * Coarse clock offset from Epoch (in seconds).
101 */
102 uint64_t offset_s;
103 /* Fine clock offset from Epoch, in (1/freq) units. */
104 uint64_t offset;
105 int absolute;
106
107 enum { /* Fields populated mask */
108 CTF_CLOCK_name = (1U << 0),
109 CTF_CLOCK_freq = (1U << 1),
110 } field_mask;
111 };
112
113 #define CTF_CALLSITE_SET_FIELD(ctf_callsite, field) \
114 do { \
115 (ctf_callsite)->field_mask |= CTF_CALLSITE_ ## field; \
116 } while (0)
117
118 #define CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field) \
119 ((ctf_callsite)->field_mask & CTF_CALLSITE_ ## field)
120
121 #define CTF_CALLSITE_GET_FIELD(ctf_callsite, field) \
122 ({ \
123 assert(CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field)); \
124 (ctf_callsite)->(field); \
125 })
126
127 struct ctf_callsite {
128 GQuark name; /* event name associated with callsite */
129 char *func;
130 char *file;
131 uint64_t line;
132 uint64_t ip;
133 struct bt_list_head node;
134 enum { /* Fields populated mask */
135 CTF_CALLSITE_name = (1U << 0),
136 CTF_CALLSITE_func = (1U << 1),
137 CTF_CALLSITE_file = (1U << 2),
138 CTF_CALLSITE_line = (1U << 3),
139 CTF_CALLSITE_ip = (1U << 4),
140 } field_mask;
141 };
142
143 struct ctf_callsite_dups {
144 struct bt_list_head head;
145 };
146
147 #define CTF_TRACE_SET_FIELD(ctf_trace, field) \
148 do { \
149 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
150 } while (0)
151
152 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
153 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
154
155 #define CTF_TRACE_GET_FIELD(ctf_trace, field) \
156 ({ \
157 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
158 (ctf_trace)->(field); \
159 })
160
161 #define TRACER_ENV_LEN 128
162
163 /* tracer-specific environment */
164 struct ctf_tracer_env {
165 int vpid; /* negative if unset */
166
167 /* All strings below: "" if unset. */
168 char procname[TRACER_ENV_LEN];
169 char hostname[TRACER_ENV_LEN];
170 char domain[TRACER_ENV_LEN];
171 char sysname[TRACER_ENV_LEN];
172 char release[TRACER_ENV_LEN];
173 char version[TRACER_ENV_LEN];
174 };
175
176 struct ctf_trace {
177 struct bt_trace_descriptor parent;
178 /* root scope */
179 struct declaration_scope *root_declaration_scope;
180
181 struct declaration_scope *declaration_scope;
182 /* innermost definition scope. to be used as parent of stream. */
183 struct definition_scope *definition_scope;
184 GPtrArray *streams; /* Array of struct ctf_stream_declaration pointers */
185 struct ctf_stream_definition *metadata;
186 GHashTable *clocks;
187 GHashTable *callsites;
188 struct ctf_clock *single_clock; /* currently supports only one clock */
189 struct trace_collection *collection; /* Container of this trace */
190 GPtrArray *event_declarations; /* Array of all the struct bt_ctf_event_decl */
191
192 struct declaration_struct *packet_header_decl;
193
194 uint64_t major;
195 uint64_t minor;
196 unsigned char uuid[BABELTRACE_UUID_LEN];
197 int byte_order; /* trace BYTE_ORDER. 0 if unset. */
198 struct ctf_tracer_env env;
199
200 enum { /* Fields populated mask */
201 CTF_TRACE_major = (1U << 0),
202 CTF_TRACE_minor = (1U << 1),
203 CTF_TRACE_uuid = (1U << 2),
204 CTF_TRACE_byte_order = (1U << 3),
205 CTF_TRACE_packet_header = (1U << 4),
206 } field_mask;
207
208 /* Information about trace backing directory and files */
209 DIR *dir;
210 int dirfd;
211 int flags; /* open flags */
212
213 /* Heap of streams, ordered to always get the lowest timestam */
214 struct ptr_heap *stream_heap;
215 char path[PATH_MAX];
216
217 struct bt_context *ctx;
218 struct bt_trace_handle *handle;
219 };
220
221 #define CTF_STREAM_SET_FIELD(ctf_stream, field) \
222 do { \
223 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
224 } while (0)
225
226 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
227 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
228
229 #define CTF_STREAM_GET_FIELD(ctf_stream, field) \
230 ({ \
231 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
232 (ctf_stream)->(field); \
233 })
234
235 struct ctf_stream_declaration {
236 struct ctf_trace *trace;
237 /* parent is lexical scope containing the stream scope */
238 struct declaration_scope *declaration_scope;
239 /* innermost definition scope. to be used as parent of event. */
240 struct definition_scope *definition_scope;
241 GPtrArray *events_by_id; /* Array of struct ctf_event_declaration pointers indexed by id */
242 GHashTable *event_quark_to_id; /* GQuark to numeric id */
243
244 struct declaration_struct *packet_context_decl;
245 struct declaration_struct *event_header_decl;
246 struct declaration_struct *event_context_decl;
247
248 uint64_t stream_id;
249
250 enum { /* Fields populated mask */
251 CTF_STREAM_stream_id = (1 << 0),
252 } field_mask;
253
254 GPtrArray *streams; /* Array of struct ctf_stream_definition pointers */
255 };
256
257 #define CTF_EVENT_SET_FIELD(ctf_event, field) \
258 do { \
259 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
260 } while (0)
261
262 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
263 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
264
265 #define CTF_EVENT_GET_FIELD(ctf_event, field) \
266 ({ \
267 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
268 (ctf_event)->(field); \
269 })
270
271 struct ctf_event_declaration {
272 /* stream mapped by stream_id */
273 struct ctf_stream_declaration *stream;
274 /* parent is lexical scope containing the event scope */
275 struct declaration_scope *declaration_scope;
276
277 struct declaration_struct *context_decl;
278 struct declaration_struct *fields_decl;
279
280 GQuark name;
281 uint64_t id; /* Numeric identifier within the stream */
282 uint64_t stream_id;
283 int loglevel;
284 GQuark model_emf_uri;
285
286 enum { /* Fields populated mask */
287 CTF_EVENT_name = (1 << 0),
288 CTF_EVENT_id = (1 << 1),
289 CTF_EVENT_stream_id = (1 << 2),
290 CTF_EVENT_loglevel = (1 << 4),
291 CTF_EVENT_model_emf_uri = (1 << 5),
292 } field_mask;
293 };
294
295 #endif /* _BABELTRACE_CTF_IR_METADATA_H */
This page took 0.034305 seconds and 4 git commands to generate.