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