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