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