Commit | Line | Data |
---|---|---|
fc93b2bd MD |
1 | /* |
2 | * BabelTrace - Common Trace Format (CTF) | |
3 | * | |
4 | * Format registration. | |
5 | * | |
64fa3fec MD |
6 | * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation |
7 | * | |
8 | * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
fc93b2bd | 9 | * |
ccd7e1c8 MD |
10 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
11 | * of this software and associated documentation files (the "Software"), to deal | |
12 | * in the Software without restriction, including without limitation the rights | |
13 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
14 | * copies of the Software, and to permit persons to whom the Software is | |
15 | * furnished to do so, subject to the following conditions: | |
fc93b2bd | 16 | * |
ccd7e1c8 MD |
17 | * The above copyright notice and this permission notice shall be included in |
18 | * all copies or substantial portions of the Software. | |
fc93b2bd MD |
19 | */ |
20 | ||
21 | #include <babeltrace/format.h> | |
22 | #include <babeltrace/ctf/types.h> | |
bbefb8dd | 23 | #include <babeltrace/ctf/metadata.h> |
70bd0a12 | 24 | #include <babeltrace/babeltrace-internal.h> |
e4195791 | 25 | #include <babeltrace/ctf/events-internal.h> |
98a04903 JD |
26 | #include <babeltrace/trace-handle-internal.h> |
27 | #include <babeltrace/context-internal.h> | |
43e34335 MD |
28 | #include <babeltrace/uuid.h> |
29 | #include <babeltrace/endian.h> | |
0f980a35 | 30 | #include <inttypes.h> |
b4c19c1e | 31 | #include <stdio.h> |
0f980a35 | 32 | #include <sys/mman.h> |
bbefb8dd | 33 | #include <errno.h> |
bbefb8dd | 34 | #include <sys/types.h> |
65102a8c | 35 | #include <sys/stat.h> |
bbefb8dd | 36 | #include <fcntl.h> |
65102a8c | 37 | #include <dirent.h> |
bbefb8dd | 38 | #include <glib.h> |
65102a8c MD |
39 | #include <unistd.h> |
40 | #include <stdlib.h> | |
41 | ||
65102a8c MD |
42 | #include "metadata/ctf-scanner.h" |
43 | #include "metadata/ctf-parser.h" | |
44 | #include "metadata/ctf-ast.h" | |
c34ea0fa | 45 | #include "events-private.h" |
f8370579 | 46 | #include "memstream.h" |
65102a8c | 47 | |
0f980a35 MD |
48 | /* |
49 | * We currently simply map a page to read the packet header and packet | |
8c572eba | 50 | * context to get the packet length and content length. (in bits) |
0f980a35 | 51 | */ |
8c572eba MD |
52 | #define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT) |
53 | #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT) | |
0f980a35 | 54 | |
a0fe7d97 MD |
55 | #ifndef min |
56 | #define min(a, b) (((a) < (b)) ? (a) : (b)) | |
57 | #endif | |
58 | ||
7d97fad9 MD |
59 | #define NSEC_PER_SEC 1000000000ULL |
60 | ||
61 | int opt_clock_raw, | |
62 | opt_clock_seconds, | |
63 | opt_clock_date, | |
64 | opt_clock_gmt; | |
65 | ||
66 | uint64_t opt_clock_offset; | |
67 | ||
65102a8c | 68 | extern int yydebug; |
bbefb8dd | 69 | |
e9378815 | 70 | static |
5b80ddfb | 71 | struct trace_descriptor *ctf_open_trace(const char *path, int flags, |
20d0dcf9 MD |
72 | void (*packet_seek)(struct stream_pos *pos, size_t index, |
73 | int whence), | |
74 | FILE *metadata_fp); | |
e9378815 | 75 | static |
f571dfb1 JD |
76 | struct trace_descriptor *ctf_open_mmap_trace( |
77 | struct mmap_stream_list *mmap_list, | |
20d0dcf9 MD |
78 | void (*packet_seek)(struct stream_pos *pos, size_t index, |
79 | int whence), | |
f571dfb1 | 80 | FILE *metadata_fp); |
98a04903 JD |
81 | static |
82 | void ctf_set_context(struct trace_descriptor *descriptor, | |
83 | struct bt_context *ctx); | |
84 | static | |
85 | void ctf_set_handle(struct trace_descriptor *descriptor, | |
86 | struct bt_trace_handle *handle); | |
f571dfb1 JD |
87 | |
88 | static | |
bbefb8dd | 89 | void ctf_close_trace(struct trace_descriptor *descriptor); |
30c276af JD |
90 | static |
91 | uint64_t ctf_timestamp_begin(struct trace_descriptor *descriptor, | |
92 | struct bt_trace_handle *handle); | |
93 | static | |
94 | uint64_t ctf_timestamp_end(struct trace_descriptor *descriptor, | |
95 | struct bt_trace_handle *handle); | |
fc93b2bd | 96 | |
1ae19169 MD |
97 | static |
98 | rw_dispatch read_dispatch_table[] = { | |
d11e9c49 MD |
99 | [ CTF_TYPE_INTEGER ] = ctf_integer_read, |
100 | [ CTF_TYPE_FLOAT ] = ctf_float_read, | |
101 | [ CTF_TYPE_ENUM ] = ctf_enum_read, | |
102 | [ CTF_TYPE_STRING ] = ctf_string_read, | |
103 | [ CTF_TYPE_STRUCT ] = ctf_struct_rw, | |
104 | [ CTF_TYPE_VARIANT ] = ctf_variant_rw, | |
81dee1bb MD |
105 | [ CTF_TYPE_ARRAY ] = ctf_array_read, |
106 | [ CTF_TYPE_SEQUENCE ] = ctf_sequence_read, | |
d11e9c49 MD |
107 | }; |
108 | ||
1ae19169 MD |
109 | static |
110 | rw_dispatch write_dispatch_table[] = { | |
d11e9c49 MD |
111 | [ CTF_TYPE_INTEGER ] = ctf_integer_write, |
112 | [ CTF_TYPE_FLOAT ] = ctf_float_write, | |
113 | [ CTF_TYPE_ENUM ] = ctf_enum_write, | |
114 | [ CTF_TYPE_STRING ] = ctf_string_write, | |
115 | [ CTF_TYPE_STRUCT ] = ctf_struct_rw, | |
116 | [ CTF_TYPE_VARIANT ] = ctf_variant_rw, | |
81dee1bb MD |
117 | [ CTF_TYPE_ARRAY ] = ctf_array_write, |
118 | [ CTF_TYPE_SEQUENCE ] = ctf_sequence_write, | |
d11e9c49 MD |
119 | }; |
120 | ||
1ae19169 | 121 | static |
d11e9c49 | 122 | struct format ctf_format = { |
bbefb8dd | 123 | .open_trace = ctf_open_trace, |
f571dfb1 | 124 | .open_mmap_trace = ctf_open_mmap_trace, |
bbefb8dd | 125 | .close_trace = ctf_close_trace, |
98a04903 JD |
126 | .set_context = ctf_set_context, |
127 | .set_handle = ctf_set_handle, | |
30c276af JD |
128 | .timestamp_begin = ctf_timestamp_begin, |
129 | .timestamp_end = ctf_timestamp_end, | |
fc93b2bd MD |
130 | }; |
131 | ||
30c276af JD |
132 | static |
133 | uint64_t ctf_timestamp_begin(struct trace_descriptor *descriptor, | |
134 | struct bt_trace_handle *handle) | |
135 | { | |
136 | struct ctf_trace *tin; | |
137 | uint64_t begin = ULLONG_MAX; | |
138 | int i, j; | |
139 | ||
140 | tin = container_of(descriptor, struct ctf_trace, parent); | |
141 | ||
142 | if (!tin) | |
143 | goto error; | |
144 | ||
145 | /* for each stream_class */ | |
146 | for (i = 0; i < tin->streams->len; i++) { | |
147 | struct ctf_stream_declaration *stream_class; | |
148 | ||
149 | stream_class = g_ptr_array_index(tin->streams, i); | |
150 | /* for each file_stream */ | |
151 | for (j = 0; j < stream_class->streams->len; j++) { | |
152 | struct ctf_stream_definition *stream; | |
153 | struct ctf_file_stream *cfs; | |
154 | struct ctf_stream_pos *stream_pos; | |
155 | struct packet_index *index; | |
156 | ||
157 | stream = g_ptr_array_index(stream_class->streams, j); | |
158 | cfs = container_of(stream, struct ctf_file_stream, | |
159 | parent); | |
160 | stream_pos = &cfs->pos; | |
161 | ||
162 | index = &g_array_index(stream_pos->packet_index, | |
163 | struct packet_index, 0); | |
164 | if (index->timestamp_begin < begin) | |
165 | begin = index->timestamp_begin; | |
166 | } | |
167 | } | |
168 | ||
169 | return begin; | |
170 | ||
171 | error: | |
172 | return -1ULL; | |
173 | } | |
174 | ||
175 | static | |
176 | uint64_t ctf_timestamp_end(struct trace_descriptor *descriptor, | |
177 | struct bt_trace_handle *handle) | |
178 | { | |
179 | struct ctf_trace *tin; | |
180 | uint64_t end = 0; | |
181 | int i, j; | |
182 | ||
183 | tin = container_of(descriptor, struct ctf_trace, parent); | |
184 | ||
185 | if (!tin) | |
186 | goto error; | |
187 | ||
188 | /* for each stream_class */ | |
189 | for (i = 0; i < tin->streams->len; i++) { | |
190 | struct ctf_stream_declaration *stream_class; | |
191 | ||
192 | stream_class = g_ptr_array_index(tin->streams, i); | |
193 | /* for each file_stream */ | |
194 | for (j = 0; j < stream_class->streams->len; j++) { | |
195 | struct ctf_stream_definition *stream; | |
196 | struct ctf_file_stream *cfs; | |
197 | struct ctf_stream_pos *stream_pos; | |
198 | struct packet_index *index; | |
199 | ||
200 | stream = g_ptr_array_index(stream_class->streams, j); | |
201 | cfs = container_of(stream, struct ctf_file_stream, | |
202 | parent); | |
203 | stream_pos = &cfs->pos; | |
204 | ||
205 | index = &g_array_index(stream_pos->packet_index, | |
206 | struct packet_index, | |
207 | stream_pos->packet_index->len - 1); | |
208 | if (index->timestamp_end > end) | |
209 | end = index->timestamp_end; | |
210 | } | |
211 | } | |
212 | ||
213 | return end; | |
214 | ||
215 | error: | |
216 | return -1ULL; | |
217 | } | |
218 | ||
25ccc85b MD |
219 | /* |
220 | * Update stream current timestamp, keep at clock frequency. | |
221 | */ | |
2b9a764d | 222 | static |
9e88d150 | 223 | void ctf_update_timestamp(struct ctf_stream_definition *stream, |
2b9a764d MD |
224 | struct definition_integer *integer_definition) |
225 | { | |
226 | struct declaration_integer *integer_declaration = | |
227 | integer_definition->declaration; | |
228 | uint64_t oldval, newval, updateval; | |
229 | ||
7f3f572b | 230 | if (unlikely(integer_declaration->len == 64)) { |
2b9a764d MD |
231 | stream->timestamp = integer_definition->value._unsigned; |
232 | return; | |
233 | } | |
234 | /* keep low bits */ | |
235 | oldval = stream->timestamp; | |
236 | oldval &= (1ULL << integer_declaration->len) - 1; | |
237 | newval = integer_definition->value._unsigned; | |
238 | /* Test for overflow by comparing low bits */ | |
239 | if (newval < oldval) | |
240 | newval += 1ULL << integer_declaration->len; | |
241 | /* updateval contains old high bits, and new low bits (sum) */ | |
242 | updateval = stream->timestamp; | |
243 | updateval &= ~((1ULL << integer_declaration->len) - 1); | |
244 | updateval += newval; | |
fca04958 | 245 | stream->prev_timestamp = stream->timestamp; |
2b9a764d MD |
246 | stream->timestamp = updateval; |
247 | } | |
248 | ||
25ccc85b MD |
249 | /* |
250 | * Print timestamp, rescaling clock frequency to nanoseconds and | |
251 | * applying offsets as needed (unix time). | |
252 | */ | |
7d97fad9 | 253 | void ctf_print_timestamp(FILE *fp, |
9e88d150 | 254 | struct ctf_stream_definition *stream, |
7d97fad9 MD |
255 | uint64_t timestamp) |
256 | { | |
257 | uint64_t ts_sec = 0, ts_nsec; | |
7d97fad9 | 258 | |
c34ea0fa MD |
259 | if (opt_clock_raw) { |
260 | ts_nsec = ctf_get_timestamp_raw(stream, timestamp); | |
25ccc85b | 261 | } else { |
c34ea0fa | 262 | ts_nsec = ctf_get_timestamp(stream, timestamp); |
25ccc85b | 263 | } |
7d97fad9 | 264 | |
c34ea0fa | 265 | /* Add command-line offset */ |
7d97fad9 MD |
266 | ts_sec += opt_clock_offset; |
267 | ||
268 | ts_sec += ts_nsec / NSEC_PER_SEC; | |
269 | ts_nsec = ts_nsec % NSEC_PER_SEC; | |
270 | ||
271 | if (!opt_clock_seconds) { | |
272 | struct tm tm; | |
273 | time_t time_s = (time_t) ts_sec; | |
274 | ||
275 | if (!opt_clock_gmt) { | |
276 | struct tm *res; | |
277 | ||
278 | res = localtime_r(&time_s, &tm); | |
279 | if (!res) { | |
280 | fprintf(stderr, "[warning] Unable to get localtime.\n"); | |
281 | goto seconds; | |
282 | } | |
283 | } else { | |
284 | struct tm *res; | |
285 | ||
286 | res = gmtime_r(&time_s, &tm); | |
287 | if (!res) { | |
288 | fprintf(stderr, "[warning] Unable to get gmtime.\n"); | |
289 | goto seconds; | |
290 | } | |
291 | } | |
292 | if (opt_clock_date) { | |
293 | char timestr[26]; | |
294 | size_t res; | |
295 | ||
296 | /* Print date and time */ | |
297 | res = strftime(timestr, sizeof(timestr), | |
298 | "%F ", &tm); | |
299 | if (!res) { | |
300 | fprintf(stderr, "[warning] Unable to print ascii time.\n"); | |
301 | goto seconds; | |
302 | } | |
303 | fprintf(fp, "%s", timestr); | |
304 | } | |
305 | /* Print time in HH:MM:SS.ns */ | |
306 | fprintf(fp, "%02d:%02d:%02d.%09" PRIu64, | |
307 | tm.tm_hour, tm.tm_min, tm.tm_sec, ts_nsec); | |
308 | goto end; | |
309 | } | |
310 | seconds: | |
311 | fprintf(fp, "%3" PRIu64 ".%09" PRIu64, | |
312 | ts_sec, ts_nsec); | |
313 | ||
314 | end: | |
315 | return; | |
316 | } | |
317 | ||
31262354 | 318 | static |
9e88d150 | 319 | int ctf_read_event(struct stream_pos *ppos, struct ctf_stream_definition *stream) |
31262354 MD |
320 | { |
321 | struct ctf_stream_pos *pos = | |
322 | container_of(ppos, struct ctf_stream_pos, parent); | |
f380e105 | 323 | struct ctf_stream_declaration *stream_class = stream->stream_class; |
c716f83b | 324 | struct ctf_event_definition *event; |
31262354 | 325 | uint64_t id = 0; |
31262354 MD |
326 | int ret; |
327 | ||
3abe83c7 MD |
328 | /* We need to check for EOF here for empty files. */ |
329 | if (unlikely(pos->offset == EOF)) | |
330 | return EOF; | |
331 | ||
5f643ed7 MD |
332 | ctf_pos_get_event(pos); |
333 | ||
90fcbacc JD |
334 | /* save the current position as a restore point */ |
335 | pos->last_offset = pos->offset; | |
336 | /* we just read the event, it is consumed when used by the caller */ | |
337 | stream->consumed = 0; | |
338 | ||
3abe83c7 MD |
339 | /* |
340 | * This is the EOF check after we've advanced the position in | |
341 | * ctf_pos_get_event. | |
342 | */ | |
7f3f572b | 343 | if (unlikely(pos->offset == EOF)) |
31262354 | 344 | return EOF; |
5f643ed7 | 345 | assert(pos->offset < pos->content_size); |
31262354 MD |
346 | |
347 | /* Read event header */ | |
7f3f572b | 348 | if (likely(stream->stream_event_header)) { |
a35173fe | 349 | struct definition_integer *integer_definition; |
ccdb988e | 350 | struct definition *variant; |
a35173fe | 351 | |
e28d4618 | 352 | ret = generic_rw(ppos, &stream->stream_event_header->p); |
7f3f572b | 353 | if (unlikely(ret)) |
31262354 MD |
354 | goto error; |
355 | /* lookup event id */ | |
e28d4618 | 356 | integer_definition = lookup_integer(&stream->stream_event_header->p, "id", FALSE); |
a35173fe MD |
357 | if (integer_definition) { |
358 | id = integer_definition->value._unsigned; | |
359 | } else { | |
360 | struct definition_enum *enum_definition; | |
361 | ||
e28d4618 | 362 | enum_definition = lookup_enum(&stream->stream_event_header->p, "id", FALSE); |
a35173fe MD |
363 | if (enum_definition) { |
364 | id = enum_definition->integer->value._unsigned; | |
365 | } | |
31262354 | 366 | } |
764af3f4 | 367 | |
e28d4618 | 368 | variant = lookup_variant(&stream->stream_event_header->p, "v"); |
ccdb988e MD |
369 | if (variant) { |
370 | integer_definition = lookup_integer(variant, "id", FALSE); | |
371 | if (integer_definition) { | |
372 | id = integer_definition->value._unsigned; | |
373 | } | |
374 | } | |
c87a8eb2 | 375 | stream->event_id = id; |
ccdb988e | 376 | |
764af3f4 | 377 | /* lookup timestamp */ |
5e2eb0ae | 378 | stream->has_timestamp = 0; |
e28d4618 | 379 | integer_definition = lookup_integer(&stream->stream_event_header->p, "timestamp", FALSE); |
a35173fe | 380 | if (integer_definition) { |
2b9a764d | 381 | ctf_update_timestamp(stream, integer_definition); |
5e2eb0ae | 382 | stream->has_timestamp = 1; |
a35173fe | 383 | } else { |
ccdb988e MD |
384 | if (variant) { |
385 | integer_definition = lookup_integer(variant, "timestamp", FALSE); | |
a35173fe | 386 | if (integer_definition) { |
2b9a764d | 387 | ctf_update_timestamp(stream, integer_definition); |
5e2eb0ae | 388 | stream->has_timestamp = 1; |
a35173fe MD |
389 | } |
390 | } | |
764af3f4 | 391 | } |
31262354 MD |
392 | } |
393 | ||
394 | /* Read stream-declared event context */ | |
e28d4618 MD |
395 | if (stream->stream_event_context) { |
396 | ret = generic_rw(ppos, &stream->stream_event_context->p); | |
31262354 MD |
397 | if (ret) |
398 | goto error; | |
399 | } | |
400 | ||
7f3f572b | 401 | if (unlikely(id >= stream_class->events_by_id->len)) { |
3394d22e | 402 | fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id); |
31262354 MD |
403 | return -EINVAL; |
404 | } | |
e28d4618 | 405 | event = g_ptr_array_index(stream->events_by_id, id); |
7f3f572b | 406 | if (unlikely(!event)) { |
3394d22e | 407 | fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id); |
31262354 MD |
408 | return -EINVAL; |
409 | } | |
410 | ||
411 | /* Read event-declared event context */ | |
e28d4618 MD |
412 | if (event->event_context) { |
413 | ret = generic_rw(ppos, &event->event_context->p); | |
31262354 MD |
414 | if (ret) |
415 | goto error; | |
416 | } | |
417 | ||
418 | /* Read event payload */ | |
7f3f572b | 419 | if (likely(event->event_fields)) { |
e28d4618 | 420 | ret = generic_rw(ppos, &event->event_fields->p); |
31262354 MD |
421 | if (ret) |
422 | goto error; | |
423 | } | |
424 | ||
425 | return 0; | |
426 | ||
427 | error: | |
3394d22e | 428 | fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n"); |
31262354 MD |
429 | return ret; |
430 | } | |
431 | ||
432 | static | |
9e88d150 | 433 | int ctf_write_event(struct stream_pos *pos, struct ctf_stream_definition *stream) |
31262354 | 434 | { |
f380e105 | 435 | struct ctf_stream_declaration *stream_class = stream->stream_class; |
c716f83b | 436 | struct ctf_event_definition *event; |
c87a8eb2 | 437 | uint64_t id; |
31262354 MD |
438 | int ret; |
439 | ||
c87a8eb2 MD |
440 | id = stream->event_id; |
441 | ||
31262354 | 442 | /* print event header */ |
7f3f572b | 443 | if (likely(stream->stream_event_header)) { |
e28d4618 | 444 | ret = generic_rw(pos, &stream->stream_event_header->p); |
31262354 MD |
445 | if (ret) |
446 | goto error; | |
447 | } | |
448 | ||
449 | /* print stream-declared event context */ | |
e28d4618 MD |
450 | if (stream->stream_event_context) { |
451 | ret = generic_rw(pos, &stream->stream_event_context->p); | |
31262354 MD |
452 | if (ret) |
453 | goto error; | |
454 | } | |
455 | ||
7f3f572b | 456 | if (unlikely(id >= stream_class->events_by_id->len)) { |
3394d22e | 457 | fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id); |
31262354 MD |
458 | return -EINVAL; |
459 | } | |
e28d4618 | 460 | event = g_ptr_array_index(stream->events_by_id, id); |
7f3f572b | 461 | if (unlikely(!event)) { |
3394d22e | 462 | fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id); |
31262354 MD |
463 | return -EINVAL; |
464 | } | |
465 | ||
466 | /* print event-declared event context */ | |
e28d4618 MD |
467 | if (event->event_context) { |
468 | ret = generic_rw(pos, &event->event_context->p); | |
31262354 MD |
469 | if (ret) |
470 | goto error; | |
471 | } | |
472 | ||
473 | /* Read and print event payload */ | |
7f3f572b | 474 | if (likely(event->event_fields)) { |
e28d4618 | 475 | ret = generic_rw(pos, &event->event_fields->p); |
31262354 MD |
476 | if (ret) |
477 | goto error; | |
478 | } | |
479 | ||
480 | return 0; | |
481 | ||
482 | error: | |
3394d22e | 483 | fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n"); |
31262354 MD |
484 | return ret; |
485 | } | |
486 | ||
8563e754 | 487 | void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags) |
8c572eba MD |
488 | { |
489 | pos->fd = fd; | |
490 | pos->mmap_offset = 0; | |
491 | pos->packet_size = 0; | |
492 | pos->content_size = 0; | |
493 | pos->content_size_loc = NULL; | |
494 | pos->base = NULL; | |
495 | pos->offset = 0; | |
496 | pos->dummy = false; | |
8c572eba | 497 | pos->cur_index = 0; |
8563e754 MD |
498 | if (fd >= 0) |
499 | pos->packet_index = g_array_new(FALSE, TRUE, | |
500 | sizeof(struct packet_index)); | |
501 | else | |
502 | pos->packet_index = NULL; | |
8563e754 MD |
503 | switch (open_flags & O_ACCMODE) { |
504 | case O_RDONLY: | |
505 | pos->prot = PROT_READ; | |
506 | pos->flags = MAP_PRIVATE; | |
507 | pos->parent.rw_table = read_dispatch_table; | |
31262354 | 508 | pos->parent.event_cb = ctf_read_event; |
8563e754 | 509 | break; |
8563e754 MD |
510 | case O_RDWR: |
511 | pos->prot = PROT_WRITE; /* Write has priority */ | |
512 | pos->flags = MAP_SHARED; | |
513 | pos->parent.rw_table = write_dispatch_table; | |
31262354 | 514 | pos->parent.event_cb = ctf_write_event; |
8563e754 | 515 | if (fd >= 0) |
06789ffd | 516 | ctf_packet_seek(&pos->parent, 0, SEEK_SET); /* position for write */ |
8563e754 MD |
517 | break; |
518 | default: | |
519 | assert(0); | |
8c572eba MD |
520 | } |
521 | } | |
522 | ||
46322b33 | 523 | void ctf_fini_pos(struct ctf_stream_pos *pos) |
8c572eba MD |
524 | { |
525 | int ret; | |
526 | ||
527 | if (pos->prot == PROT_WRITE && pos->content_size_loc) | |
528 | *pos->content_size_loc = pos->offset; | |
529 | if (pos->base) { | |
530 | /* unmap old base */ | |
531 | ret = munmap(pos->base, pos->packet_size / CHAR_BIT); | |
532 | if (ret) { | |
3394d22e | 533 | fprintf(stderr, "[error] Unable to unmap old base: %s.\n", |
8c572eba MD |
534 | strerror(errno)); |
535 | assert(0); | |
536 | } | |
537 | } | |
538 | (void) g_array_free(pos->packet_index, TRUE); | |
539 | } | |
540 | ||
20d0dcf9 MD |
541 | /* |
542 | * for SEEK_CUR: go to next packet. | |
543 | * for SEEK_POS: go to packet numer (index). | |
544 | */ | |
545 | void ctf_packet_seek(struct stream_pos *stream_pos, size_t index, int whence) | |
0f980a35 | 546 | { |
d6425aaf MD |
547 | struct ctf_stream_pos *pos = |
548 | container_of(stream_pos, struct ctf_stream_pos, parent); | |
75cc2c35 MD |
549 | struct ctf_file_stream *file_stream = |
550 | container_of(pos, struct ctf_file_stream, pos); | |
0f980a35 | 551 | int ret; |
8c572eba | 552 | off_t off; |
20d0dcf9 | 553 | struct packet_index *packet_index; |
0f980a35 | 554 | |
8c572eba MD |
555 | if (pos->prot == PROT_WRITE && pos->content_size_loc) |
556 | *pos->content_size_loc = pos->offset; | |
0f980a35 MD |
557 | |
558 | if (pos->base) { | |
559 | /* unmap old base */ | |
8c572eba | 560 | ret = munmap(pos->base, pos->packet_size / CHAR_BIT); |
0f980a35 | 561 | if (ret) { |
3394d22e | 562 | fprintf(stderr, "[error] Unable to unmap old base: %s.\n", |
0f980a35 MD |
563 | strerror(errno)); |
564 | assert(0); | |
565 | } | |
847bf71a | 566 | pos->base = NULL; |
0f980a35 MD |
567 | } |
568 | ||
8c572eba | 569 | /* |
46322b33 | 570 | * The caller should never ask for ctf_move_pos across packets, |
8c572eba MD |
571 | * except to get exactly at the beginning of the next packet. |
572 | */ | |
573 | if (pos->prot == PROT_WRITE) { | |
989c73bc MD |
574 | switch (whence) { |
575 | case SEEK_CUR: | |
576 | /* The writer will add padding */ | |
8c572eba | 577 | pos->mmap_offset += WRITE_PACKET_LEN / CHAR_BIT; |
989c73bc MD |
578 | break; |
579 | case SEEK_SET: | |
20d0dcf9 | 580 | assert(index == 0); /* only seek supported for now */ |
989c73bc MD |
581 | pos->cur_index = 0; |
582 | break; | |
583 | default: | |
584 | assert(0); | |
585 | } | |
8c572eba MD |
586 | pos->content_size = -1U; /* Unknown at this point */ |
587 | pos->packet_size = WRITE_PACKET_LEN; | |
989c73bc MD |
588 | off = posix_fallocate(pos->fd, pos->mmap_offset, |
589 | pos->packet_size / CHAR_BIT); | |
8c572eba | 590 | assert(off >= 0); |
847bf71a | 591 | pos->offset = 0; |
8c572eba | 592 | } else { |
5f643ed7 | 593 | read_next_packet: |
847bf71a MD |
594 | switch (whence) { |
595 | case SEEK_CUR: | |
41e82e00 | 596 | { |
4c4ba021 | 597 | uint64_t events_discarded_diff; |
41e82e00 | 598 | |
7d97fad9 MD |
599 | if (pos->offset == EOF) { |
600 | return; | |
601 | } | |
3217ac37 | 602 | /* For printing discarded event count */ |
20d0dcf9 | 603 | packet_index = &g_array_index(pos->packet_index, |
41e82e00 | 604 | struct packet_index, pos->cur_index); |
20d0dcf9 | 605 | events_discarded_diff = packet_index->events_discarded; |
3217ac37 | 606 | file_stream->parent.prev_timestamp_end = |
20d0dcf9 | 607 | packet_index->timestamp_end; |
41e82e00 | 608 | if (pos->cur_index > 0) { |
20d0dcf9 | 609 | packet_index = &g_array_index(pos->packet_index, |
41e82e00 MD |
610 | struct packet_index, |
611 | pos->cur_index - 1); | |
20d0dcf9 | 612 | events_discarded_diff -= packet_index->events_discarded; |
4c4ba021 MD |
613 | /* |
614 | * Deal with 32-bit wrap-around if the | |
615 | * tracer provided a 32-bit field. | |
616 | */ | |
617 | if (packet_index->events_discarded_len == 32) { | |
618 | events_discarded_diff = (uint32_t) events_discarded_diff; | |
619 | } | |
41e82e00 | 620 | } |
fca04958 | 621 | file_stream->parent.events_discarded = events_discarded_diff; |
7d97fad9 | 622 | file_stream->parent.prev_timestamp = file_stream->parent.timestamp; |
847bf71a | 623 | /* The reader will expect us to skip padding */ |
8c572eba | 624 | ++pos->cur_index; |
847bf71a | 625 | break; |
41e82e00 | 626 | } |
847bf71a | 627 | case SEEK_SET: |
20d0dcf9 | 628 | pos->cur_index = index; |
fca04958 | 629 | file_stream->parent.prev_timestamp = 0; |
3217ac37 | 630 | file_stream->parent.prev_timestamp_end = 0; |
847bf71a MD |
631 | break; |
632 | default: | |
633 | assert(0); | |
634 | } | |
635 | if (pos->cur_index >= pos->packet_index->len) { | |
7d97fad9 MD |
636 | /* |
637 | * When a stream reaches the end of the | |
638 | * file, we need to show the number of | |
639 | * events discarded ourselves, because | |
640 | * there is no next event scheduled to | |
641 | * be printed in the output. | |
642 | */ | |
643 | if (file_stream->parent.events_discarded) { | |
badea1a2 JD |
644 | /* |
645 | * We need to check if we are in trace | |
646 | * read or called from packet indexing. | |
647 | * In this last case, the collection is | |
648 | * not there, so we cannot print the | |
649 | * timestamps. | |
650 | */ | |
651 | if ((&file_stream->parent)->stream_class->trace->collection) { | |
652 | fflush(stdout); | |
4c4ba021 | 653 | fprintf(stderr, "[warning] Tracer discarded %" PRIu64 " events at end of stream between [", |
badea1a2 JD |
654 | file_stream->parent.events_discarded); |
655 | ctf_print_timestamp(stderr, &file_stream->parent, | |
656 | file_stream->parent.prev_timestamp); | |
657 | fprintf(stderr, "] and ["); | |
658 | ctf_print_timestamp(stderr, &file_stream->parent, | |
659 | file_stream->parent.prev_timestamp_end); | |
a0b34fbb | 660 | fprintf(stderr, "]. You should consider recording a new trace with larger buffers or with fewer events enabled.\n"); |
badea1a2 JD |
661 | fflush(stderr); |
662 | } | |
7d97fad9 MD |
663 | file_stream->parent.events_discarded = 0; |
664 | } | |
670977d3 | 665 | pos->offset = EOF; |
847bf71a MD |
666 | return; |
667 | } | |
20d0dcf9 | 668 | packet_index = &g_array_index(pos->packet_index, struct packet_index, |
8c572eba | 669 | pos->cur_index); |
20d0dcf9 | 670 | pos->mmap_offset = packet_index->offset; |
8c572eba MD |
671 | |
672 | /* Lookup context/packet size in index */ | |
20d0dcf9 MD |
673 | file_stream->parent.timestamp = packet_index->timestamp_begin; |
674 | pos->content_size = packet_index->content_size; | |
675 | pos->packet_size = packet_index->packet_size; | |
676 | if (packet_index->data_offset < packet_index->content_size) { | |
75cc2c35 | 677 | pos->offset = 0; /* will read headers */ |
20d0dcf9 | 678 | } else if (packet_index->data_offset == packet_index->content_size) { |
5f643ed7 | 679 | /* empty packet */ |
20d0dcf9 | 680 | pos->offset = packet_index->data_offset; |
3abe83c7 | 681 | whence = SEEK_CUR; |
5f643ed7 | 682 | goto read_next_packet; |
7eda6fc7 | 683 | } else { |
2b9a764d MD |
684 | pos->offset = EOF; |
685 | return; | |
686 | } | |
8c572eba | 687 | } |
0f980a35 | 688 | /* map new base. Need mapping length from header. */ |
8c572eba MD |
689 | pos->base = mmap(NULL, pos->packet_size / CHAR_BIT, pos->prot, |
690 | pos->flags, pos->fd, pos->mmap_offset); | |
847bf71a | 691 | if (pos->base == MAP_FAILED) { |
3394d22e | 692 | fprintf(stderr, "[error] mmap error %s.\n", |
847bf71a MD |
693 | strerror(errno)); |
694 | assert(0); | |
695 | } | |
75cc2c35 MD |
696 | |
697 | /* update trace_packet_header and stream_packet_context */ | |
2d0bea29 | 698 | if (pos->prot != PROT_WRITE && file_stream->parent.trace_packet_header) { |
75cc2c35 | 699 | /* Read packet header */ |
2d0bea29 | 700 | ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p); |
75cc2c35 MD |
701 | assert(!ret); |
702 | } | |
2d0bea29 | 703 | if (pos->prot != PROT_WRITE && file_stream->parent.stream_packet_context) { |
75cc2c35 | 704 | /* Read packet context */ |
2d0bea29 | 705 | ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p); |
75cc2c35 MD |
706 | assert(!ret); |
707 | } | |
0f980a35 MD |
708 | } |
709 | ||
b4c19c1e MD |
710 | static |
711 | int packet_metadata(struct ctf_trace *td, FILE *fp) | |
712 | { | |
713 | uint32_t magic; | |
714 | size_t len; | |
715 | int ret = 0; | |
716 | ||
717 | len = fread(&magic, sizeof(magic), 1, fp); | |
a0fe7d97 | 718 | if (len != 1) { |
b4c19c1e MD |
719 | goto end; |
720 | } | |
721 | if (magic == TSDL_MAGIC) { | |
722 | ret = 1; | |
723 | td->byte_order = BYTE_ORDER; | |
0d336fdf | 724 | CTF_TRACE_SET_FIELD(td, byte_order); |
b4c19c1e MD |
725 | } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) { |
726 | ret = 1; | |
727 | td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ? | |
728 | LITTLE_ENDIAN : BIG_ENDIAN; | |
0d336fdf | 729 | CTF_TRACE_SET_FIELD(td, byte_order); |
b4c19c1e MD |
730 | } |
731 | end: | |
732 | rewind(fp); | |
733 | return ret; | |
734 | } | |
735 | ||
5c262147 MD |
736 | /* |
737 | * Returns 0 on success, -1 on error. | |
738 | */ | |
739 | static | |
740 | int check_version(unsigned int major, unsigned int minor) | |
741 | { | |
742 | switch (major) { | |
743 | case 1: | |
744 | switch (minor) { | |
745 | case 8: | |
746 | return 0; | |
747 | default: | |
748 | goto warning; | |
749 | } | |
750 | default: | |
751 | goto warning; | |
752 | ||
753 | } | |
754 | ||
755 | /* eventually return an error instead of warning */ | |
756 | warning: | |
3394d22e | 757 | fprintf(stderr, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n", |
5c262147 MD |
758 | major, minor); |
759 | return 0; | |
760 | } | |
761 | ||
b4c19c1e MD |
762 | static |
763 | int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in, | |
764 | FILE *out) | |
765 | { | |
766 | struct metadata_packet_header header; | |
a0fe7d97 | 767 | size_t readlen, writelen, toread; |
f8254867 | 768 | char buf[4096 + 1]; /* + 1 for debug-mode \0 */ |
b4c19c1e MD |
769 | int ret = 0; |
770 | ||
a91a962e | 771 | readlen = fread(&header, header_sizeof(header), 1, in); |
a0fe7d97 | 772 | if (readlen < 1) |
b4c19c1e MD |
773 | return -EINVAL; |
774 | ||
775 | if (td->byte_order != BYTE_ORDER) { | |
776 | header.magic = GUINT32_SWAP_LE_BE(header.magic); | |
777 | header.checksum = GUINT32_SWAP_LE_BE(header.checksum); | |
778 | header.content_size = GUINT32_SWAP_LE_BE(header.content_size); | |
779 | header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size); | |
780 | } | |
781 | if (header.checksum) | |
3394d22e | 782 | fprintf(stderr, "[warning] checksum verification not supported yet.\n"); |
b4c19c1e | 783 | if (header.compression_scheme) { |
3394d22e | 784 | fprintf(stderr, "[error] compression (%u) not supported yet.\n", |
b4c19c1e MD |
785 | header.compression_scheme); |
786 | return -EINVAL; | |
787 | } | |
788 | if (header.encryption_scheme) { | |
3394d22e | 789 | fprintf(stderr, "[error] encryption (%u) not supported yet.\n", |
b4c19c1e MD |
790 | header.encryption_scheme); |
791 | return -EINVAL; | |
792 | } | |
793 | if (header.checksum_scheme) { | |
3394d22e | 794 | fprintf(stderr, "[error] checksum (%u) not supported yet.\n", |
b4c19c1e MD |
795 | header.checksum_scheme); |
796 | return -EINVAL; | |
797 | } | |
5c262147 MD |
798 | if (check_version(header.major, header.minor) < 0) |
799 | return -EINVAL; | |
b4c19c1e MD |
800 | if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) { |
801 | memcpy(td->uuid, header.uuid, sizeof(header.uuid)); | |
802 | CTF_TRACE_SET_FIELD(td, uuid); | |
803 | } else { | |
43e34335 | 804 | if (babeltrace_uuid_compare(header.uuid, td->uuid)) |
b4c19c1e MD |
805 | return -EINVAL; |
806 | } | |
807 | ||
255b2138 | 808 | toread = (header.content_size / CHAR_BIT) - header_sizeof(header); |
a0fe7d97 MD |
809 | |
810 | for (;;) { | |
f8254867 | 811 | readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in); |
b4c19c1e MD |
812 | if (ferror(in)) { |
813 | ret = -EINVAL; | |
814 | break; | |
815 | } | |
4152822b | 816 | if (babeltrace_debug) { |
f8254867 | 817 | buf[readlen] = '\0'; |
3394d22e | 818 | fprintf(stderr, "[debug] metadata packet read: %s\n", |
4152822b MD |
819 | buf); |
820 | } | |
821 | ||
b4c19c1e MD |
822 | writelen = fwrite(buf, sizeof(char), readlen, out); |
823 | if (writelen < readlen) { | |
824 | ret = -EIO; | |
825 | break; | |
826 | } | |
827 | if (ferror(out)) { | |
828 | ret = -EINVAL; | |
829 | break; | |
830 | } | |
a0fe7d97 MD |
831 | toread -= readlen; |
832 | if (!toread) { | |
7f4b5c4d | 833 | ret = 0; /* continue reading next packet */ |
ddbc52af | 834 | goto read_padding; |
a0fe7d97 | 835 | } |
b4c19c1e MD |
836 | } |
837 | return ret; | |
ddbc52af MD |
838 | |
839 | read_padding: | |
840 | toread = (header.packet_size - header.content_size) / CHAR_BIT; | |
841 | ret = fseek(in, toread, SEEK_CUR); | |
842 | if (ret < 0) { | |
3394d22e | 843 | fprintf(stderr, "[warning] Missing padding at end of file\n"); |
ddbc52af MD |
844 | ret = 0; |
845 | } | |
846 | return ret; | |
b4c19c1e MD |
847 | } |
848 | ||
849 | static | |
850 | int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp, | |
851 | char **buf) | |
852 | { | |
853 | FILE *in, *out; | |
854 | size_t size; | |
855 | int ret; | |
856 | ||
857 | in = *fp; | |
c4f5487e MD |
858 | /* |
859 | * Using strlen on *buf instead of size of open_memstream | |
860 | * because its size includes garbage at the end (after final | |
861 | * \0). This is the allocated size, not the actual string size. | |
862 | */ | |
f8370579 | 863 | out = babeltrace_open_memstream(buf, &size); |
a569a564 MD |
864 | if (out == NULL) { |
865 | perror("Metadata open_memstream"); | |
b4c19c1e | 866 | return -errno; |
a569a564 | 867 | } |
b4c19c1e MD |
868 | for (;;) { |
869 | ret = ctf_open_trace_metadata_packet_read(td, in, out); | |
7f4b5c4d | 870 | if (ret) { |
b4c19c1e | 871 | break; |
7f4b5c4d MD |
872 | } |
873 | if (feof(in)) { | |
874 | ret = 0; | |
b4c19c1e MD |
875 | break; |
876 | } | |
877 | } | |
f8370579 MD |
878 | /* close to flush the buffer */ |
879 | ret = babeltrace_close_memstream(buf, &size, out); | |
880 | if (ret < 0) { | |
881 | perror("babeltrace_flush_memstream"); | |
882 | fclose(in); | |
883 | return -errno; | |
884 | } | |
b4c19c1e MD |
885 | fclose(in); |
886 | /* open for reading */ | |
f8370579 | 887 | *fp = babeltrace_fmemopen(*buf, strlen(*buf), "rb"); |
a569a564 MD |
888 | if (!*fp) { |
889 | perror("Metadata fmemopen"); | |
890 | return -errno; | |
891 | } | |
b4c19c1e MD |
892 | return 0; |
893 | } | |
894 | ||
65102a8c | 895 | static |
b086c01a | 896 | int ctf_open_trace_metadata_read(struct ctf_trace *td, |
20d0dcf9 | 897 | void (*packet_seek)(struct stream_pos *pos, size_t index, |
ae23d232 | 898 | int whence), FILE *metadata_fp) |
65102a8c MD |
899 | { |
900 | struct ctf_scanner *scanner; | |
2d0bea29 | 901 | struct ctf_file_stream *metadata_stream; |
65102a8c | 902 | FILE *fp; |
b4c19c1e | 903 | char *buf = NULL; |
65102a8c MD |
904 | int ret = 0; |
905 | ||
2d0bea29 | 906 | metadata_stream = g_new0(struct ctf_file_stream, 1); |
b086c01a | 907 | |
06789ffd MD |
908 | if (packet_seek) { |
909 | metadata_stream->pos.packet_seek = packet_seek; | |
b086c01a | 910 | } else { |
06789ffd | 911 | fprintf(stderr, "[error] packet_seek function undefined.\n"); |
b086c01a JD |
912 | ret = -1; |
913 | goto end_stream; | |
914 | } | |
915 | ||
ae23d232 JD |
916 | if (metadata_fp) { |
917 | fp = metadata_fp; | |
918 | } else { | |
919 | td->metadata = &metadata_stream->parent; | |
920 | metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY); | |
921 | if (metadata_stream->pos.fd < 0) { | |
3394d22e | 922 | fprintf(stderr, "Unable to open metadata.\n"); |
ae23d232 JD |
923 | return metadata_stream->pos.fd; |
924 | } | |
65102a8c | 925 | |
ae23d232 JD |
926 | fp = fdopen(metadata_stream->pos.fd, "r"); |
927 | if (!fp) { | |
3394d22e | 928 | fprintf(stderr, "[error] Unable to open metadata stream.\n"); |
a569a564 | 929 | perror("Metadata stream open"); |
ae23d232 JD |
930 | ret = -errno; |
931 | goto end_stream; | |
932 | } | |
933 | } | |
65102a8c MD |
934 | if (babeltrace_debug) |
935 | yydebug = 1; | |
936 | ||
b4c19c1e MD |
937 | if (packet_metadata(td, fp)) { |
938 | ret = ctf_open_trace_metadata_stream_read(td, &fp, &buf); | |
939 | if (ret) | |
940 | goto end_packet_read; | |
da75b0f7 | 941 | } else { |
5c262147 MD |
942 | unsigned int major, minor; |
943 | ssize_t nr_items; | |
8c2df3f5 | 944 | |
da75b0f7 | 945 | td->byte_order = BYTE_ORDER; |
8c2df3f5 | 946 | |
5c262147 MD |
947 | /* Check text-only metadata header and version */ |
948 | nr_items = fscanf(fp, "/* CTF %u.%u", &major, &minor); | |
949 | if (nr_items < 2) | |
3394d22e | 950 | fprintf(stderr, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n"); |
5c262147 MD |
951 | if (check_version(major, minor) < 0) { |
952 | ret = -EINVAL; | |
953 | goto end_packet_read; | |
954 | } | |
8c2df3f5 | 955 | rewind(fp); |
b4c19c1e MD |
956 | } |
957 | ||
65102a8c MD |
958 | scanner = ctf_scanner_alloc(fp); |
959 | if (!scanner) { | |
3394d22e | 960 | fprintf(stderr, "[error] Error allocating scanner\n"); |
65102a8c MD |
961 | ret = -ENOMEM; |
962 | goto end_scanner_alloc; | |
963 | } | |
964 | ret = ctf_scanner_append_ast(scanner); | |
965 | if (ret) { | |
3394d22e | 966 | fprintf(stderr, "[error] Error creating AST\n"); |
65102a8c MD |
967 | goto end; |
968 | } | |
969 | ||
970 | if (babeltrace_debug) { | |
3394d22e | 971 | ret = ctf_visitor_print_xml(stderr, 0, &scanner->ast->root); |
65102a8c | 972 | if (ret) { |
3394d22e | 973 | fprintf(stderr, "[error] Error visiting AST for XML output\n"); |
65102a8c MD |
974 | goto end; |
975 | } | |
976 | } | |
977 | ||
3394d22e | 978 | ret = ctf_visitor_semantic_check(stderr, 0, &scanner->ast->root); |
65102a8c | 979 | if (ret) { |
3394d22e | 980 | fprintf(stderr, "[error] Error in CTF semantic validation %d\n", ret); |
65102a8c MD |
981 | goto end; |
982 | } | |
3394d22e | 983 | ret = ctf_visitor_construct_metadata(stderr, 0, &scanner->ast->root, |
ac5c6ca0 | 984 | td, td->byte_order); |
65102a8c | 985 | if (ret) { |
3394d22e | 986 | fprintf(stderr, "[error] Error in CTF metadata constructor %d\n", ret); |
65102a8c MD |
987 | goto end; |
988 | } | |
989 | end: | |
990 | ctf_scanner_free(scanner); | |
991 | end_scanner_alloc: | |
b4c19c1e | 992 | end_packet_read: |
8210f9da MD |
993 | if (fp) |
994 | fclose(fp); | |
b4c19c1e | 995 | free(buf); |
65102a8c | 996 | end_stream: |
2d0bea29 MD |
997 | close(metadata_stream->pos.fd); |
998 | if (ret) | |
999 | g_free(metadata_stream); | |
0f980a35 MD |
1000 | return ret; |
1001 | } | |
1002 | ||
e28d4618 | 1003 | static |
c716f83b | 1004 | struct ctf_event_definition *create_event_definitions(struct ctf_trace *td, |
9e88d150 | 1005 | struct ctf_stream_definition *stream, |
4716614a | 1006 | struct ctf_event_declaration *event) |
e28d4618 | 1007 | { |
c716f83b | 1008 | struct ctf_event_definition *stream_event = g_new0(struct ctf_event_definition, 1); |
e28d4618 MD |
1009 | |
1010 | if (event->context_decl) { | |
1011 | struct definition *definition = | |
1012 | event->context_decl->p.definition_new(&event->context_decl->p, | |
1013 | stream->parent_def_scope, 0, 0, "event.context"); | |
1014 | if (!definition) { | |
1015 | goto error; | |
1016 | } | |
42dc00b7 | 1017 | stream_event->event_context = container_of(definition, |
e28d4618 | 1018 | struct definition_struct, p); |
42dc00b7 | 1019 | stream->parent_def_scope = stream_event->event_context->p.scope; |
e28d4618 MD |
1020 | } |
1021 | if (event->fields_decl) { | |
1022 | struct definition *definition = | |
1023 | event->fields_decl->p.definition_new(&event->fields_decl->p, | |
1024 | stream->parent_def_scope, 0, 0, "event.fields"); | |
1025 | if (!definition) { | |
1026 | goto error; | |
1027 | } | |
42dc00b7 | 1028 | stream_event->event_fields = container_of(definition, |
e28d4618 | 1029 | struct definition_struct, p); |
42dc00b7 | 1030 | stream->parent_def_scope = stream_event->event_fields->p.scope; |
e28d4618 | 1031 | } |
d3ded99d | 1032 | stream_event->stream = stream; |
42dc00b7 | 1033 | return stream_event; |
e28d4618 MD |
1034 | |
1035 | error: | |
42dc00b7 MD |
1036 | if (stream_event->event_fields) |
1037 | definition_unref(&stream_event->event_fields->p); | |
1038 | if (stream_event->event_context) | |
1039 | definition_unref(&stream_event->event_context->p); | |
e28d4618 MD |
1040 | return NULL; |
1041 | } | |
1042 | ||
1043 | static | |
9e88d150 | 1044 | int create_stream_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream) |
e28d4618 | 1045 | { |
f380e105 | 1046 | struct ctf_stream_declaration *stream_class; |
e28d4618 MD |
1047 | int ret; |
1048 | int i; | |
1049 | ||
1050 | if (stream->stream_definitions_created) | |
1051 | return 0; | |
1052 | ||
1053 | stream_class = stream->stream_class; | |
1054 | ||
1055 | if (stream_class->packet_context_decl) { | |
1056 | struct definition *definition = | |
1057 | stream_class->packet_context_decl->p.definition_new(&stream_class->packet_context_decl->p, | |
1058 | stream->parent_def_scope, 0, 0, "stream.packet.context"); | |
1059 | if (!definition) { | |
1060 | ret = -EINVAL; | |
1061 | goto error; | |
1062 | } | |
1063 | stream->stream_packet_context = container_of(definition, | |
1064 | struct definition_struct, p); | |
1065 | stream->parent_def_scope = stream->stream_packet_context->p.scope; | |
1066 | } | |
1067 | if (stream_class->event_header_decl) { | |
1068 | struct definition *definition = | |
1069 | stream_class->event_header_decl->p.definition_new(&stream_class->event_header_decl->p, | |
1070 | stream->parent_def_scope, 0, 0, "stream.event.header"); | |
1071 | if (!definition) { | |
1072 | ret = -EINVAL; | |
1073 | goto error; | |
1074 | } | |
1075 | stream->stream_event_header = | |
1076 | container_of(definition, struct definition_struct, p); | |
1077 | stream->parent_def_scope = stream->stream_event_header->p.scope; | |
1078 | } | |
1079 | if (stream_class->event_context_decl) { | |
1080 | struct definition *definition = | |
1081 | stream_class->event_context_decl->p.definition_new(&stream_class->event_context_decl->p, | |
1082 | stream->parent_def_scope, 0, 0, "stream.event.context"); | |
1083 | if (!definition) { | |
1084 | ret = -EINVAL; | |
1085 | goto error; | |
1086 | } | |
1087 | stream->stream_event_context = | |
1088 | container_of(definition, struct definition_struct, p); | |
1089 | stream->parent_def_scope = stream->stream_event_context->p.scope; | |
1090 | } | |
1091 | stream->events_by_id = g_ptr_array_new(); | |
1092 | g_ptr_array_set_size(stream->events_by_id, stream_class->events_by_id->len); | |
1093 | for (i = 0; i < stream->events_by_id->len; i++) { | |
4716614a | 1094 | struct ctf_event_declaration *event = g_ptr_array_index(stream_class->events_by_id, i); |
c716f83b | 1095 | struct ctf_event_definition *stream_event; |
e28d4618 MD |
1096 | |
1097 | if (!event) | |
1098 | continue; | |
42dc00b7 MD |
1099 | stream_event = create_event_definitions(td, stream, event); |
1100 | if (!stream_event) | |
e28d4618 | 1101 | goto error_event; |
42dc00b7 | 1102 | g_ptr_array_index(stream->events_by_id, i) = stream_event; |
e28d4618 MD |
1103 | } |
1104 | return 0; | |
1105 | ||
1106 | error_event: | |
1107 | for (i = 0; i < stream->events_by_id->len; i++) { | |
c716f83b | 1108 | struct ctf_event_definition *stream_event = g_ptr_array_index(stream->events_by_id, i); |
42dc00b7 MD |
1109 | if (stream_event) |
1110 | g_free(stream_event); | |
e28d4618 MD |
1111 | } |
1112 | g_ptr_array_free(stream->events_by_id, TRUE); | |
1113 | error: | |
1114 | if (stream->stream_event_context) | |
1115 | definition_unref(&stream->stream_event_context->p); | |
1116 | if (stream->stream_event_header) | |
1117 | definition_unref(&stream->stream_event_header->p); | |
1118 | if (stream->stream_packet_context) | |
1119 | definition_unref(&stream->stream_packet_context->p); | |
1120 | return ret; | |
1121 | } | |
1122 | ||
0f980a35 MD |
1123 | |
1124 | static | |
46322b33 | 1125 | int create_stream_packet_index(struct ctf_trace *td, |
0f980a35 MD |
1126 | struct ctf_file_stream *file_stream) |
1127 | { | |
f380e105 | 1128 | struct ctf_stream_declaration *stream; |
0f980a35 | 1129 | int len_index; |
46322b33 | 1130 | struct ctf_stream_pos *pos; |
0f980a35 MD |
1131 | struct stat filestats; |
1132 | struct packet_index packet_index; | |
1133 | int first_packet = 1; | |
1134 | int ret; | |
1135 | ||
1136 | pos = &file_stream->pos; | |
1137 | ||
1138 | ret = fstat(pos->fd, &filestats); | |
1139 | if (ret < 0) | |
1140 | return ret; | |
1141 | ||
8895362d MD |
1142 | if (filestats.st_size < MAX_PACKET_HEADER_LEN / CHAR_BIT) |
1143 | return -EINVAL; | |
1144 | ||
0f980a35 MD |
1145 | for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) { |
1146 | uint64_t stream_id = 0; | |
1147 | ||
1148 | if (pos->base) { | |
1149 | /* unmap old base */ | |
8c572eba | 1150 | ret = munmap(pos->base, pos->packet_size / CHAR_BIT); |
0f980a35 | 1151 | if (ret) { |
3394d22e | 1152 | fprintf(stderr, "[error] Unable to unmap old base: %s.\n", |
0f980a35 MD |
1153 | strerror(errno)); |
1154 | return ret; | |
1155 | } | |
8c572eba | 1156 | pos->base = NULL; |
0f980a35 MD |
1157 | } |
1158 | /* map new base. Need mapping length from header. */ | |
8c572eba | 1159 | pos->base = mmap(NULL, MAX_PACKET_HEADER_LEN / CHAR_BIT, PROT_READ, |
0f980a35 | 1160 | MAP_PRIVATE, pos->fd, pos->mmap_offset); |
dc48ecad MD |
1161 | pos->content_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */ |
1162 | pos->packet_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */ | |
0f980a35 MD |
1163 | pos->offset = 0; /* Position of the packet header */ |
1164 | ||
8c572eba MD |
1165 | packet_index.offset = pos->mmap_offset; |
1166 | packet_index.content_size = 0; | |
1167 | packet_index.packet_size = 0; | |
75cc2c35 MD |
1168 | packet_index.timestamp_begin = 0; |
1169 | packet_index.timestamp_end = 0; | |
41e82e00 | 1170 | packet_index.events_discarded = 0; |
8c572eba | 1171 | |
0f980a35 | 1172 | /* read and check header, set stream id (and check) */ |
2d0bea29 | 1173 | if (file_stream->parent.trace_packet_header) { |
0f980a35 | 1174 | /* Read packet header */ |
2d0bea29 | 1175 | ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p); |
c5e74408 MD |
1176 | if (ret) |
1177 | return ret; | |
2d0bea29 | 1178 | len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic")); |
0f980a35 | 1179 | if (len_index >= 0) { |
b1a2f580 | 1180 | struct definition *field; |
f4c56ac2 | 1181 | uint64_t magic; |
0f980a35 | 1182 | |
2d0bea29 | 1183 | field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); |
f4c56ac2 MD |
1184 | magic = get_unsigned_int(field); |
1185 | if (magic != CTF_MAGIC) { | |
3394d22e | 1186 | fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n", |
f4c56ac2 | 1187 | magic, |
8c572eba MD |
1188 | file_stream->pos.packet_index->len, |
1189 | (ssize_t) pos->mmap_offset); | |
0f980a35 MD |
1190 | return -EINVAL; |
1191 | } | |
1192 | } | |
1193 | ||
1194 | /* check uuid */ | |
2d0bea29 | 1195 | len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid")); |
0f980a35 MD |
1196 | if (len_index >= 0) { |
1197 | struct definition_array *defarray; | |
b1a2f580 | 1198 | struct definition *field; |
0f980a35 | 1199 | uint64_t i; |
43e34335 | 1200 | uint8_t uuidval[BABELTRACE_UUID_LEN]; |
0f980a35 | 1201 | |
2d0bea29 | 1202 | field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); |
b1a2f580 MD |
1203 | assert(field->declaration->id == CTF_TYPE_ARRAY); |
1204 | defarray = container_of(field, struct definition_array, p); | |
43e34335 | 1205 | assert(array_len(defarray) == BABELTRACE_UUID_LEN); |
0f980a35 | 1206 | |
43e34335 | 1207 | for (i = 0; i < BABELTRACE_UUID_LEN; i++) { |
0f980a35 | 1208 | struct definition *elem; |
0f980a35 MD |
1209 | |
1210 | elem = array_index(defarray, i); | |
f4c56ac2 | 1211 | uuidval[i] = get_unsigned_int(elem); |
0f980a35 | 1212 | } |
43e34335 | 1213 | ret = babeltrace_uuid_compare(td->uuid, uuidval); |
0f980a35 | 1214 | if (ret) { |
3394d22e | 1215 | fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n"); |
0f980a35 MD |
1216 | return -EINVAL; |
1217 | } | |
1218 | } | |
1219 | ||
1220 | ||
2d0bea29 | 1221 | len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id")); |
0f980a35 | 1222 | if (len_index >= 0) { |
b1a2f580 | 1223 | struct definition *field; |
0f980a35 | 1224 | |
2d0bea29 | 1225 | field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); |
f4c56ac2 | 1226 | stream_id = get_unsigned_int(field); |
0f980a35 MD |
1227 | } |
1228 | } | |
1229 | ||
2d0bea29 | 1230 | if (!first_packet && file_stream->parent.stream_id != stream_id) { |
3394d22e | 1231 | fprintf(stderr, "[error] Stream ID is changing within a stream.\n"); |
0f980a35 MD |
1232 | return -EINVAL; |
1233 | } | |
1234 | if (first_packet) { | |
2d0bea29 | 1235 | file_stream->parent.stream_id = stream_id; |
46322b33 | 1236 | if (stream_id >= td->streams->len) { |
3394d22e | 1237 | fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); |
0f980a35 MD |
1238 | return -EINVAL; |
1239 | } | |
46322b33 | 1240 | stream = g_ptr_array_index(td->streams, stream_id); |
0f980a35 | 1241 | if (!stream) { |
3394d22e | 1242 | fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); |
0f980a35 MD |
1243 | return -EINVAL; |
1244 | } | |
2d0bea29 | 1245 | file_stream->parent.stream_class = stream; |
01c76b24 | 1246 | ret = create_stream_definitions(td, &file_stream->parent); |
862434ec MD |
1247 | if (ret) |
1248 | return ret; | |
0f980a35 MD |
1249 | } |
1250 | first_packet = 0; | |
1251 | ||
2d0bea29 | 1252 | if (file_stream->parent.stream_packet_context) { |
dc48ecad | 1253 | /* Read packet context */ |
2d0bea29 | 1254 | ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p); |
c5e74408 MD |
1255 | if (ret) |
1256 | return ret; | |
dc48ecad | 1257 | /* read content size from header */ |
2d0bea29 | 1258 | len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size")); |
dc48ecad | 1259 | if (len_index >= 0) { |
b1a2f580 | 1260 | struct definition *field; |
dc48ecad | 1261 | |
2d0bea29 | 1262 | field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); |
f4c56ac2 | 1263 | packet_index.content_size = get_unsigned_int(field); |
dc48ecad MD |
1264 | } else { |
1265 | /* Use file size for packet size */ | |
8c572eba | 1266 | packet_index.content_size = filestats.st_size * CHAR_BIT; |
dc48ecad MD |
1267 | } |
1268 | ||
1269 | /* read packet size from header */ | |
2d0bea29 | 1270 | len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size")); |
dc48ecad | 1271 | if (len_index >= 0) { |
b1a2f580 | 1272 | struct definition *field; |
dc48ecad | 1273 | |
2d0bea29 | 1274 | field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); |
f4c56ac2 | 1275 | packet_index.packet_size = get_unsigned_int(field); |
dc48ecad MD |
1276 | } else { |
1277 | /* Use content size if non-zero, else file size */ | |
8c572eba | 1278 | packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT; |
dc48ecad | 1279 | } |
75cc2c35 MD |
1280 | |
1281 | /* read timestamp begin from header */ | |
2d0bea29 | 1282 | len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin")); |
75cc2c35 | 1283 | if (len_index >= 0) { |
75cc2c35 MD |
1284 | struct definition *field; |
1285 | ||
2d0bea29 | 1286 | field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); |
f4c56ac2 | 1287 | packet_index.timestamp_begin = get_unsigned_int(field); |
75cc2c35 MD |
1288 | } |
1289 | ||
1290 | /* read timestamp end from header */ | |
2d0bea29 | 1291 | len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end")); |
75cc2c35 | 1292 | if (len_index >= 0) { |
75cc2c35 MD |
1293 | struct definition *field; |
1294 | ||
2d0bea29 | 1295 | field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); |
f4c56ac2 | 1296 | packet_index.timestamp_end = get_unsigned_int(field); |
75cc2c35 | 1297 | } |
41e82e00 MD |
1298 | |
1299 | /* read events discarded from header */ | |
1300 | len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded")); | |
1301 | if (len_index >= 0) { | |
1302 | struct definition *field; | |
1303 | ||
1304 | field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); | |
1305 | packet_index.events_discarded = get_unsigned_int(field); | |
4c4ba021 | 1306 | packet_index.events_discarded_len = get_int_len(field); |
41e82e00 | 1307 | } |
0f980a35 MD |
1308 | } else { |
1309 | /* Use file size for packet size */ | |
8c572eba | 1310 | packet_index.content_size = filestats.st_size * CHAR_BIT; |
0f980a35 | 1311 | /* Use content size if non-zero, else file size */ |
8c572eba | 1312 | packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT; |
0f980a35 | 1313 | } |
546293fa MD |
1314 | |
1315 | /* Validate content size and packet size values */ | |
1316 | if (packet_index.content_size > packet_index.packet_size) { | |
7e18eedf | 1317 | fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n", |
546293fa MD |
1318 | packet_index.content_size, packet_index.packet_size); |
1319 | return -EINVAL; | |
1320 | } | |
1321 | ||
7e18eedf JN |
1322 | if (packet_index.packet_size > ((uint64_t)filestats.st_size - packet_index.offset) * CHAR_BIT) { |
1323 | fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n", | |
1324 | packet_index.content_size, ((uint64_t)filestats.st_size - packet_index.offset) * CHAR_BIT); | |
546293fa MD |
1325 | return -EINVAL; |
1326 | } | |
1327 | ||
847bf71a MD |
1328 | /* Save position after header and context */ |
1329 | packet_index.data_offset = pos->offset; | |
0f980a35 | 1330 | |
0f980a35 MD |
1331 | /* add index to packet array */ |
1332 | g_array_append_val(file_stream->pos.packet_index, packet_index); | |
1333 | ||
8c572eba | 1334 | pos->mmap_offset += packet_index.packet_size / CHAR_BIT; |
0f980a35 MD |
1335 | } |
1336 | ||
847bf71a | 1337 | /* Move pos back to beginning of file */ |
06789ffd | 1338 | ctf_packet_seek(&pos->parent, 0, SEEK_SET); /* position for write */ |
847bf71a | 1339 | |
0f980a35 MD |
1340 | return 0; |
1341 | } | |
1342 | ||
e28d4618 | 1343 | static |
9e88d150 | 1344 | int create_trace_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream) |
e28d4618 MD |
1345 | { |
1346 | int ret; | |
1347 | ||
1348 | if (td->packet_header_decl) { | |
1349 | struct definition *definition = | |
1350 | td->packet_header_decl->p.definition_new(&td->packet_header_decl->p, | |
1351 | stream->parent_def_scope, 0, 0, "trace.packet.header"); | |
1352 | if (!definition) { | |
1353 | ret = -EINVAL; | |
1354 | goto error; | |
1355 | } | |
1356 | stream->trace_packet_header = | |
1357 | container_of(definition, struct definition_struct, p); | |
1358 | stream->parent_def_scope = stream->trace_packet_header->p.scope; | |
1359 | } | |
1360 | ||
1361 | return 0; | |
1362 | ||
1363 | error: | |
1364 | return ret; | |
1365 | } | |
1366 | ||
0f980a35 MD |
1367 | /* |
1368 | * Note: many file streams can inherit from the same stream class | |
1369 | * description (metadata). | |
1370 | */ | |
1371 | static | |
b086c01a | 1372 | int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags, |
20d0dcf9 | 1373 | void (*packet_seek)(struct stream_pos *pos, size_t index, |
b086c01a | 1374 | int whence)) |
0f980a35 MD |
1375 | { |
1376 | int ret; | |
1377 | struct ctf_file_stream *file_stream; | |
1378 | ||
46322b33 | 1379 | ret = openat(td->dirfd, path, flags); |
a569a564 MD |
1380 | if (ret < 0) { |
1381 | perror("File stream openat()"); | |
0f980a35 | 1382 | goto error; |
a569a564 | 1383 | } |
0f980a35 | 1384 | file_stream = g_new0(struct ctf_file_stream, 1); |
b086c01a | 1385 | |
06789ffd MD |
1386 | if (packet_seek) { |
1387 | file_stream->pos.packet_seek = packet_seek; | |
b086c01a | 1388 | } else { |
06789ffd | 1389 | fprintf(stderr, "[error] packet_seek function undefined.\n"); |
b086c01a JD |
1390 | ret = -1; |
1391 | goto error_def; | |
1392 | } | |
1393 | ||
8563e754 | 1394 | ctf_init_pos(&file_stream->pos, ret, flags); |
2d0bea29 | 1395 | ret = create_trace_definitions(td, &file_stream->parent); |
e28d4618 MD |
1396 | if (ret) |
1397 | goto error_def; | |
25ccc85b MD |
1398 | /* |
1399 | * For now, only a single slock is supported. | |
1400 | */ | |
1401 | file_stream->parent.current_clock = td->single_clock; | |
0f980a35 MD |
1402 | ret = create_stream_packet_index(td, file_stream); |
1403 | if (ret) | |
1404 | goto error_index; | |
1405 | /* Add stream file to stream class */ | |
2d0bea29 MD |
1406 | g_ptr_array_add(file_stream->parent.stream_class->streams, |
1407 | &file_stream->parent); | |
0f980a35 MD |
1408 | return 0; |
1409 | ||
1410 | error_index: | |
2d0bea29 MD |
1411 | if (file_stream->parent.trace_packet_header) |
1412 | definition_unref(&file_stream->parent.trace_packet_header->p); | |
e28d4618 | 1413 | error_def: |
46322b33 | 1414 | ctf_fini_pos(&file_stream->pos); |
0f980a35 MD |
1415 | close(file_stream->pos.fd); |
1416 | g_free(file_stream); | |
1417 | error: | |
65102a8c MD |
1418 | return ret; |
1419 | } | |
1420 | ||
bbefb8dd | 1421 | static |
5b80ddfb | 1422 | int ctf_open_trace_read(struct ctf_trace *td, |
8c250d87 | 1423 | const char *path, int flags, |
20d0dcf9 | 1424 | void (*packet_seek)(struct stream_pos *pos, size_t index, |
ae23d232 | 1425 | int whence), FILE *metadata_fp) |
bbefb8dd MD |
1426 | { |
1427 | int ret; | |
65102a8c MD |
1428 | struct dirent *dirent; |
1429 | struct dirent *diriter; | |
1430 | size_t dirent_len; | |
bbefb8dd | 1431 | |
46322b33 | 1432 | td->flags = flags; |
bbefb8dd MD |
1433 | |
1434 | /* Open trace directory */ | |
46322b33 MD |
1435 | td->dir = opendir(path); |
1436 | if (!td->dir) { | |
6a6b384c | 1437 | fprintf(stderr, "[error] Unable to open trace directory \"%s\".\n", path); |
bbefb8dd MD |
1438 | ret = -ENOENT; |
1439 | goto error; | |
1440 | } | |
1441 | ||
46322b33 MD |
1442 | td->dirfd = open(path, 0); |
1443 | if (td->dirfd < 0) { | |
6a6b384c | 1444 | fprintf(stderr, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path); |
a569a564 MD |
1445 | perror("Trace directory open"); |
1446 | ret = -errno; | |
65102a8c MD |
1447 | goto error_dirfd; |
1448 | } | |
5b80ddfb MD |
1449 | strncpy(td->path, path, sizeof(td->path)); |
1450 | td->path[sizeof(td->path) - 1] = '\0'; | |
0f980a35 | 1451 | |
65102a8c MD |
1452 | /* |
1453 | * Keep the metadata file separate. | |
1454 | */ | |
bbefb8dd | 1455 | |
06789ffd | 1456 | ret = ctf_open_trace_metadata_read(td, packet_seek, metadata_fp); |
65102a8c | 1457 | if (ret) { |
6a6b384c | 1458 | fprintf(stderr, "[warning] Unable to open trace metadata for path \"%s\".\n", path); |
65102a8c MD |
1459 | goto error_metadata; |
1460 | } | |
bbefb8dd MD |
1461 | |
1462 | /* | |
1463 | * Open each stream: for each file, try to open, check magic | |
1464 | * number, and get the stream ID to add to the right location in | |
1465 | * the stream array. | |
bbefb8dd MD |
1466 | */ |
1467 | ||
65102a8c | 1468 | dirent_len = offsetof(struct dirent, d_name) + |
46322b33 | 1469 | fpathconf(td->dirfd, _PC_NAME_MAX) + 1; |
bbefb8dd | 1470 | |
65102a8c | 1471 | dirent = malloc(dirent_len); |
bbefb8dd | 1472 | |
65102a8c | 1473 | for (;;) { |
46322b33 | 1474 | ret = readdir_r(td->dir, dirent, &diriter); |
65102a8c | 1475 | if (ret) { |
3394d22e | 1476 | fprintf(stderr, "[error] Readdir error.\n"); |
65102a8c | 1477 | goto readdir_error; |
65102a8c MD |
1478 | } |
1479 | if (!diriter) | |
1480 | break; | |
d8ea2d29 MD |
1481 | /* Ignore hidden files, ., .. and metadata. */ |
1482 | if (!strncmp(diriter->d_name, ".", 1) | |
65102a8c MD |
1483 | || !strcmp(diriter->d_name, "..") |
1484 | || !strcmp(diriter->d_name, "metadata")) | |
1485 | continue; | |
06789ffd MD |
1486 | ret = ctf_open_file_stream_read(td, diriter->d_name, |
1487 | flags, packet_seek); | |
dc48ecad | 1488 | if (ret) { |
3394d22e | 1489 | fprintf(stderr, "[error] Open file stream error.\n"); |
dc48ecad MD |
1490 | goto readdir_error; |
1491 | } | |
65102a8c | 1492 | } |
bbefb8dd | 1493 | |
65102a8c | 1494 | free(dirent); |
bbefb8dd | 1495 | return 0; |
65102a8c MD |
1496 | |
1497 | readdir_error: | |
1498 | free(dirent); | |
1499 | error_metadata: | |
46322b33 | 1500 | close(td->dirfd); |
65102a8c | 1501 | error_dirfd: |
46322b33 | 1502 | closedir(td->dir); |
bbefb8dd MD |
1503 | error: |
1504 | return ret; | |
1505 | } | |
1506 | ||
e9378815 | 1507 | static |
5b80ddfb | 1508 | struct trace_descriptor *ctf_open_trace(const char *path, int flags, |
20d0dcf9 | 1509 | void (*packet_seek)(struct stream_pos *pos, size_t index, |
ae23d232 | 1510 | int whence), FILE *metadata_fp) |
bbefb8dd | 1511 | { |
46322b33 | 1512 | struct ctf_trace *td; |
bbefb8dd MD |
1513 | int ret; |
1514 | ||
2715de36 MD |
1515 | /* |
1516 | * If packet_seek is NULL, we provide our default version. | |
1517 | */ | |
1518 | if (!packet_seek) | |
1519 | packet_seek = ctf_packet_seek; | |
1520 | ||
46322b33 | 1521 | td = g_new0(struct ctf_trace, 1); |
bbefb8dd | 1522 | |
8c572eba | 1523 | switch (flags & O_ACCMODE) { |
bbefb8dd | 1524 | case O_RDONLY: |
b61922b5 | 1525 | if (!path) { |
3394d22e | 1526 | fprintf(stderr, "[error] Path missing for input CTF trace.\n"); |
b61922b5 MD |
1527 | goto error; |
1528 | } | |
06789ffd | 1529 | ret = ctf_open_trace_read(td, path, flags, packet_seek, metadata_fp); |
bbefb8dd MD |
1530 | if (ret) |
1531 | goto error; | |
1532 | break; | |
989c73bc | 1533 | case O_RDWR: |
3394d22e | 1534 | fprintf(stderr, "[error] Opening CTF traces for output is not supported yet.\n"); |
46322b33 | 1535 | goto error; |
bbefb8dd | 1536 | default: |
3394d22e | 1537 | fprintf(stderr, "[error] Incorrect open flags.\n"); |
bbefb8dd MD |
1538 | goto error; |
1539 | } | |
1540 | ||
46322b33 | 1541 | return &td->parent; |
bbefb8dd MD |
1542 | error: |
1543 | g_free(td); | |
1544 | return NULL; | |
1545 | } | |
1546 | ||
f571dfb1 JD |
1547 | |
1548 | void ctf_init_mmap_pos(struct ctf_stream_pos *pos, | |
1549 | struct mmap_stream *mmap_info) | |
1550 | { | |
1551 | pos->mmap_offset = 0; | |
1552 | pos->packet_size = 0; | |
1553 | pos->content_size = 0; | |
1554 | pos->content_size_loc = NULL; | |
1555 | pos->fd = mmap_info->fd; | |
1556 | pos->base = 0; | |
1557 | pos->offset = 0; | |
1558 | pos->dummy = false; | |
1559 | pos->cur_index = 0; | |
1560 | pos->packet_index = NULL; | |
1561 | pos->prot = PROT_READ; | |
1562 | pos->flags = MAP_PRIVATE; | |
1563 | pos->parent.rw_table = read_dispatch_table; | |
1564 | pos->parent.event_cb = ctf_read_event; | |
1565 | } | |
1566 | ||
1567 | static | |
1568 | int prepare_mmap_stream_definition(struct ctf_trace *td, | |
1569 | struct ctf_file_stream *file_stream) | |
1570 | { | |
f380e105 | 1571 | struct ctf_stream_declaration *stream; |
f571dfb1 JD |
1572 | uint64_t stream_id = 0; |
1573 | int ret; | |
1574 | ||
1575 | file_stream->parent.stream_id = stream_id; | |
1576 | if (stream_id >= td->streams->len) { | |
3394d22e | 1577 | fprintf(stderr, "[error] Stream %" PRIu64 " is not declared " |
f571dfb1 JD |
1578 | "in metadata.\n", stream_id); |
1579 | ret = -EINVAL; | |
1580 | goto end; | |
1581 | } | |
1582 | stream = g_ptr_array_index(td->streams, stream_id); | |
1583 | if (!stream) { | |
3394d22e | 1584 | fprintf(stderr, "[error] Stream %" PRIu64 " is not declared " |
f571dfb1 JD |
1585 | "in metadata.\n", stream_id); |
1586 | ret = -EINVAL; | |
1587 | goto end; | |
1588 | } | |
1589 | file_stream->parent.stream_class = stream; | |
1590 | ret = create_stream_definitions(td, &file_stream->parent); | |
1591 | end: | |
1592 | return ret; | |
1593 | } | |
1594 | ||
1595 | static | |
1596 | int ctf_open_mmap_stream_read(struct ctf_trace *td, | |
1597 | struct mmap_stream *mmap_info, | |
20d0dcf9 | 1598 | void (*packet_seek)(struct stream_pos *pos, size_t index, |
f571dfb1 JD |
1599 | int whence)) |
1600 | { | |
1601 | int ret; | |
1602 | struct ctf_file_stream *file_stream; | |
1603 | ||
1604 | file_stream = g_new0(struct ctf_file_stream, 1); | |
1605 | ctf_init_mmap_pos(&file_stream->pos, mmap_info); | |
1606 | ||
06789ffd | 1607 | file_stream->pos.packet_seek = packet_seek; |
f571dfb1 JD |
1608 | |
1609 | ret = create_trace_definitions(td, &file_stream->parent); | |
1610 | if (ret) { | |
1611 | goto error_def; | |
1612 | } | |
1613 | ||
1614 | ret = prepare_mmap_stream_definition(td, file_stream); | |
1615 | if (ret) | |
1616 | goto error_index; | |
1617 | ||
1618 | /* Add stream file to stream class */ | |
1619 | g_ptr_array_add(file_stream->parent.stream_class->streams, | |
1620 | &file_stream->parent); | |
1621 | return 0; | |
1622 | ||
1623 | error_index: | |
1624 | if (file_stream->parent.trace_packet_header) | |
1625 | definition_unref(&file_stream->parent.trace_packet_header->p); | |
1626 | error_def: | |
1627 | g_free(file_stream); | |
1628 | return ret; | |
1629 | } | |
1630 | ||
1631 | int ctf_open_mmap_trace_read(struct ctf_trace *td, | |
1632 | struct mmap_stream_list *mmap_list, | |
20d0dcf9 | 1633 | void (*packet_seek)(struct stream_pos *pos, size_t index, |
f571dfb1 JD |
1634 | int whence), |
1635 | FILE *metadata_fp) | |
1636 | { | |
1637 | int ret; | |
1638 | struct mmap_stream *mmap_info; | |
1639 | ||
06789ffd | 1640 | ret = ctf_open_trace_metadata_read(td, ctf_packet_seek, metadata_fp); |
f571dfb1 JD |
1641 | if (ret) { |
1642 | goto error; | |
1643 | } | |
1644 | ||
1645 | /* | |
1646 | * for each stream, try to open, check magic number, and get the | |
1647 | * stream ID to add to the right location in the stream array. | |
1648 | */ | |
3122e6f0 | 1649 | bt_list_for_each_entry(mmap_info, &mmap_list->head, list) { |
06789ffd | 1650 | ret = ctf_open_mmap_stream_read(td, mmap_info, packet_seek); |
f571dfb1 | 1651 | if (ret) { |
3394d22e | 1652 | fprintf(stderr, "[error] Open file mmap stream error.\n"); |
f571dfb1 JD |
1653 | goto error; |
1654 | } | |
1655 | } | |
1656 | ||
1657 | return 0; | |
1658 | ||
1659 | error: | |
1660 | return ret; | |
1661 | } | |
1662 | ||
1663 | static | |
1664 | struct trace_descriptor *ctf_open_mmap_trace( | |
1665 | struct mmap_stream_list *mmap_list, | |
20d0dcf9 MD |
1666 | void (*packet_seek)(struct stream_pos *pos, size_t index, |
1667 | int whence), | |
f571dfb1 JD |
1668 | FILE *metadata_fp) |
1669 | { | |
1670 | struct ctf_trace *td; | |
1671 | int ret; | |
1672 | ||
1673 | if (!metadata_fp) { | |
1674 | fprintf(stderr, "[error] No metadata file pointer associated, " | |
1675 | "required for mmap parsing\n"); | |
1676 | goto error; | |
1677 | } | |
06789ffd MD |
1678 | if (!packet_seek) { |
1679 | fprintf(stderr, "[error] packet_seek function undefined.\n"); | |
f571dfb1 JD |
1680 | goto error; |
1681 | } | |
1682 | td = g_new0(struct ctf_trace, 1); | |
06789ffd | 1683 | ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp); |
f571dfb1 JD |
1684 | if (ret) |
1685 | goto error_free; | |
1686 | ||
1687 | return &td->parent; | |
1688 | ||
1689 | error_free: | |
1690 | g_free(td); | |
1691 | error: | |
1692 | return NULL; | |
1693 | } | |
1694 | ||
0f980a35 MD |
1695 | static |
1696 | void ctf_close_file_stream(struct ctf_file_stream *file_stream) | |
1697 | { | |
46322b33 | 1698 | ctf_fini_pos(&file_stream->pos); |
0f980a35 MD |
1699 | close(file_stream->pos.fd); |
1700 | } | |
1701 | ||
e9378815 | 1702 | static |
46322b33 | 1703 | void ctf_close_trace(struct trace_descriptor *tdp) |
bbefb8dd | 1704 | { |
46322b33 | 1705 | struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent); |
0f980a35 MD |
1706 | int i; |
1707 | ||
46322b33 MD |
1708 | if (td->streams) { |
1709 | for (i = 0; i < td->streams->len; i++) { | |
f380e105 | 1710 | struct ctf_stream_declaration *stream; |
0f980a35 | 1711 | int j; |
e9378815 | 1712 | |
46322b33 | 1713 | stream = g_ptr_array_index(td->streams, i); |
e9378815 MD |
1714 | if (!stream) |
1715 | continue; | |
2d0bea29 | 1716 | for (j = 0; j < stream->streams->len; j++) { |
0f980a35 | 1717 | struct ctf_file_stream *file_stream; |
2d0bea29 | 1718 | file_stream = container_of(g_ptr_array_index(stream->streams, j), struct ctf_file_stream, parent); |
0f980a35 MD |
1719 | ctf_close_file_stream(file_stream); |
1720 | } | |
1721 | ||
1722 | } | |
46322b33 | 1723 | g_ptr_array_free(td->streams, TRUE); |
0f980a35 | 1724 | } |
e003ab50 JD |
1725 | |
1726 | if (td->event_declarations) { | |
1727 | for (i = 0; i < td->event_declarations->len; i++) { | |
1728 | struct bt_ctf_event_decl *event; | |
1729 | ||
1730 | event = g_ptr_array_index(td->event_declarations, i); | |
64c2c249 JD |
1731 | if (event->context_decl) |
1732 | g_ptr_array_free(event->context_decl, TRUE); | |
1733 | if (event->fields_decl) | |
1734 | g_ptr_array_free(event->fields_decl, TRUE); | |
1735 | if (event->packet_header_decl) | |
1736 | g_ptr_array_free(event->packet_header_decl, TRUE); | |
1737 | if (event->event_context_decl) | |
1738 | g_ptr_array_free(event->event_context_decl, TRUE); | |
1739 | if (event->event_header_decl) | |
1740 | g_ptr_array_free(event->event_header_decl, TRUE); | |
1741 | if (event->packet_context_decl) | |
1742 | g_ptr_array_free(event->packet_context_decl, TRUE); | |
e003ab50 JD |
1743 | g_free(event); |
1744 | } | |
1745 | g_ptr_array_free(td->event_declarations, TRUE); | |
1746 | } | |
46322b33 | 1747 | closedir(td->dir); |
bbefb8dd MD |
1748 | g_free(td); |
1749 | } | |
1750 | ||
98a04903 JD |
1751 | static |
1752 | void ctf_set_context(struct trace_descriptor *descriptor, | |
1753 | struct bt_context *ctx) | |
1754 | { | |
1755 | struct ctf_trace *td = container_of(descriptor, struct ctf_trace, | |
1756 | parent); | |
1757 | ||
1758 | td->ctx = ctx; | |
1759 | } | |
1760 | ||
1761 | static | |
1762 | void ctf_set_handle(struct trace_descriptor *descriptor, | |
1763 | struct bt_trace_handle *handle) | |
1764 | { | |
1765 | struct ctf_trace *td = container_of(descriptor, struct ctf_trace, | |
1766 | parent); | |
1767 | ||
1768 | td->handle = handle; | |
1769 | } | |
1770 | ||
7fb21036 | 1771 | void __attribute__((constructor)) ctf_init(void) |
fc93b2bd MD |
1772 | { |
1773 | int ret; | |
1774 | ||
4c8bfb7e | 1775 | ctf_format.name = g_quark_from_static_string("ctf"); |
fc93b2bd MD |
1776 | ret = bt_register_format(&ctf_format); |
1777 | assert(!ret); | |
1778 | } | |
698f0fe4 MD |
1779 | |
1780 | /* TODO: finalize */ |