Commit | Line | Data |
---|---|---|
fc93b2bd MD |
1 | /* |
2 | * BabelTrace - Common Trace Format (CTF) | |
3 | * | |
4 | * Format registration. | |
5 | * | |
c054553d | 6 | * Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
fc93b2bd | 7 | * |
ccd7e1c8 MD |
8 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
9 | * of this software and associated documentation files (the "Software"), to deal | |
10 | * in the Software without restriction, including without limitation the rights | |
11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | * copies of the Software, and to permit persons to whom the Software is | |
13 | * furnished to do so, subject to the following conditions: | |
fc93b2bd | 14 | * |
ccd7e1c8 MD |
15 | * The above copyright notice and this permission notice shall be included in |
16 | * all copies or substantial portions of the Software. | |
fc93b2bd MD |
17 | */ |
18 | ||
19 | #include <babeltrace/format.h> | |
20 | #include <babeltrace/ctf/types.h> | |
bbefb8dd | 21 | #include <babeltrace/ctf/metadata.h> |
65102a8c | 22 | #include <babeltrace/babeltrace.h> |
0f980a35 | 23 | #include <inttypes.h> |
b4c19c1e | 24 | #include <stdio.h> |
0f980a35 MD |
25 | #include <uuid/uuid.h> |
26 | #include <sys/mman.h> | |
bbefb8dd | 27 | #include <errno.h> |
b4c19c1e | 28 | #include <endian.h> |
bbefb8dd | 29 | #include <sys/types.h> |
65102a8c | 30 | #include <sys/stat.h> |
bbefb8dd | 31 | #include <fcntl.h> |
65102a8c | 32 | #include <dirent.h> |
bbefb8dd | 33 | #include <glib.h> |
65102a8c MD |
34 | #include <unistd.h> |
35 | #include <stdlib.h> | |
36 | ||
65102a8c MD |
37 | #include "metadata/ctf-scanner.h" |
38 | #include "metadata/ctf-parser.h" | |
39 | #include "metadata/ctf-ast.h" | |
40 | ||
0f980a35 MD |
41 | /* |
42 | * We currently simply map a page to read the packet header and packet | |
8c572eba | 43 | * context to get the packet length and content length. (in bits) |
0f980a35 | 44 | */ |
8c572eba MD |
45 | #define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT) |
46 | #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT) | |
0f980a35 MD |
47 | #define UUID_LEN 16 /* uuid by value len */ |
48 | ||
a0fe7d97 MD |
49 | #ifndef min |
50 | #define min(a, b) (((a) < (b)) ? (a) : (b)) | |
51 | #endif | |
52 | ||
65102a8c | 53 | extern int yydebug; |
bbefb8dd | 54 | |
e9378815 | 55 | static |
bbefb8dd | 56 | struct trace_descriptor *ctf_open_trace(const char *path, int flags); |
e9378815 | 57 | static |
bbefb8dd | 58 | void ctf_close_trace(struct trace_descriptor *descriptor); |
fc93b2bd | 59 | |
1ae19169 MD |
60 | static |
61 | rw_dispatch read_dispatch_table[] = { | |
d11e9c49 MD |
62 | [ CTF_TYPE_INTEGER ] = ctf_integer_read, |
63 | [ CTF_TYPE_FLOAT ] = ctf_float_read, | |
64 | [ CTF_TYPE_ENUM ] = ctf_enum_read, | |
65 | [ CTF_TYPE_STRING ] = ctf_string_read, | |
66 | [ CTF_TYPE_STRUCT ] = ctf_struct_rw, | |
67 | [ CTF_TYPE_VARIANT ] = ctf_variant_rw, | |
81dee1bb MD |
68 | [ CTF_TYPE_ARRAY ] = ctf_array_read, |
69 | [ CTF_TYPE_SEQUENCE ] = ctf_sequence_read, | |
d11e9c49 MD |
70 | }; |
71 | ||
1ae19169 MD |
72 | static |
73 | rw_dispatch write_dispatch_table[] = { | |
d11e9c49 MD |
74 | [ CTF_TYPE_INTEGER ] = ctf_integer_write, |
75 | [ CTF_TYPE_FLOAT ] = ctf_float_write, | |
76 | [ CTF_TYPE_ENUM ] = ctf_enum_write, | |
77 | [ CTF_TYPE_STRING ] = ctf_string_write, | |
78 | [ CTF_TYPE_STRUCT ] = ctf_struct_rw, | |
79 | [ CTF_TYPE_VARIANT ] = ctf_variant_rw, | |
81dee1bb MD |
80 | [ CTF_TYPE_ARRAY ] = ctf_array_write, |
81 | [ CTF_TYPE_SEQUENCE ] = ctf_sequence_write, | |
d11e9c49 MD |
82 | }; |
83 | ||
1ae19169 | 84 | static |
d11e9c49 | 85 | struct format ctf_format = { |
bbefb8dd MD |
86 | .open_trace = ctf_open_trace, |
87 | .close_trace = ctf_close_trace, | |
fc93b2bd MD |
88 | }; |
89 | ||
2b9a764d MD |
90 | static |
91 | void ctf_update_timestamp(struct ctf_stream *stream, | |
92 | struct definition_integer *integer_definition) | |
93 | { | |
94 | struct declaration_integer *integer_declaration = | |
95 | integer_definition->declaration; | |
96 | uint64_t oldval, newval, updateval; | |
97 | ||
98 | if (integer_declaration->len == 64) { | |
99 | stream->timestamp = integer_definition->value._unsigned; | |
100 | return; | |
101 | } | |
102 | /* keep low bits */ | |
103 | oldval = stream->timestamp; | |
104 | oldval &= (1ULL << integer_declaration->len) - 1; | |
105 | newval = integer_definition->value._unsigned; | |
106 | /* Test for overflow by comparing low bits */ | |
107 | if (newval < oldval) | |
108 | newval += 1ULL << integer_declaration->len; | |
109 | /* updateval contains old high bits, and new low bits (sum) */ | |
110 | updateval = stream->timestamp; | |
111 | updateval &= ~((1ULL << integer_declaration->len) - 1); | |
112 | updateval += newval; | |
113 | stream->timestamp = updateval; | |
114 | } | |
115 | ||
31262354 | 116 | static |
764af3f4 | 117 | int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream) |
31262354 MD |
118 | { |
119 | struct ctf_stream_pos *pos = | |
120 | container_of(ppos, struct ctf_stream_pos, parent); | |
764af3f4 | 121 | struct ctf_stream_class *stream_class = stream->stream_class; |
31262354 MD |
122 | struct ctf_event *event_class; |
123 | uint64_t id = 0; | |
31262354 MD |
124 | int ret; |
125 | ||
126 | if (pos->offset == EOF) | |
127 | return EOF; | |
128 | ||
129 | /* Read event header */ | |
130 | if (stream_class->event_header) { | |
a35173fe | 131 | struct definition_integer *integer_definition; |
ccdb988e | 132 | struct definition *variant; |
a35173fe | 133 | |
31262354 MD |
134 | ret = generic_rw(ppos, &stream_class->event_header->p); |
135 | if (ret) | |
136 | goto error; | |
137 | /* lookup event id */ | |
a35173fe MD |
138 | integer_definition = lookup_integer(&stream_class->event_header->p, "id", FALSE); |
139 | if (integer_definition) { | |
140 | id = integer_definition->value._unsigned; | |
141 | } else { | |
142 | struct definition_enum *enum_definition; | |
143 | ||
144 | enum_definition = lookup_enum(&stream_class->event_header->p, "id", FALSE); | |
145 | if (enum_definition) { | |
146 | id = enum_definition->integer->value._unsigned; | |
147 | } | |
31262354 | 148 | } |
764af3f4 | 149 | |
ccdb988e MD |
150 | variant = lookup_variant(&stream_class->event_header->p, "v"); |
151 | if (variant) { | |
152 | integer_definition = lookup_integer(variant, "id", FALSE); | |
153 | if (integer_definition) { | |
154 | id = integer_definition->value._unsigned; | |
155 | } | |
156 | } | |
157 | ||
764af3f4 | 158 | /* lookup timestamp */ |
a35173fe MD |
159 | integer_definition = lookup_integer(&stream_class->event_header->p, "timestamp", FALSE); |
160 | if (integer_definition) { | |
2b9a764d | 161 | ctf_update_timestamp(stream, integer_definition); |
a35173fe | 162 | } else { |
ccdb988e MD |
163 | if (variant) { |
164 | integer_definition = lookup_integer(variant, "timestamp", FALSE); | |
a35173fe | 165 | if (integer_definition) { |
2b9a764d | 166 | ctf_update_timestamp(stream, integer_definition); |
a35173fe MD |
167 | } |
168 | } | |
764af3f4 | 169 | } |
31262354 MD |
170 | } |
171 | ||
172 | /* Read stream-declared event context */ | |
173 | if (stream_class->event_context) { | |
174 | ret = generic_rw(ppos, &stream_class->event_context->p); | |
175 | if (ret) | |
176 | goto error; | |
177 | } | |
178 | ||
179 | if (id >= stream_class->events_by_id->len) { | |
180 | fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id); | |
181 | return -EINVAL; | |
182 | } | |
183 | event_class = g_ptr_array_index(stream_class->events_by_id, id); | |
184 | if (!event_class) { | |
185 | fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id); | |
186 | return -EINVAL; | |
187 | } | |
188 | ||
189 | /* Read event-declared event context */ | |
190 | if (event_class->context) { | |
191 | ret = generic_rw(ppos, &event_class->context->p); | |
192 | if (ret) | |
193 | goto error; | |
194 | } | |
195 | ||
196 | /* Read event payload */ | |
197 | if (event_class->fields) { | |
198 | ret = generic_rw(ppos, &event_class->fields->p); | |
199 | if (ret) | |
200 | goto error; | |
201 | } | |
202 | ||
203 | return 0; | |
204 | ||
205 | error: | |
206 | fprintf(stdout, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n"); | |
207 | return ret; | |
208 | } | |
209 | ||
210 | static | |
764af3f4 | 211 | int ctf_write_event(struct stream_pos *pos, struct ctf_stream *stream) |
31262354 | 212 | { |
764af3f4 | 213 | struct ctf_stream_class *stream_class = stream->stream_class; |
31262354 MD |
214 | struct ctf_event *event_class; |
215 | uint64_t id = 0; | |
31262354 MD |
216 | int ret; |
217 | ||
218 | /* print event header */ | |
219 | if (stream_class->event_header) { | |
ccdb988e MD |
220 | struct definition_integer *integer_definition; |
221 | struct definition *variant; | |
222 | ||
31262354 | 223 | /* lookup event id */ |
ccdb988e MD |
224 | integer_definition = lookup_integer(&stream_class->event_header->p, "id", FALSE); |
225 | if (integer_definition) { | |
226 | id = integer_definition->value._unsigned; | |
227 | } else { | |
228 | struct definition_enum *enum_definition; | |
229 | ||
230 | enum_definition = lookup_enum(&stream_class->event_header->p, "id", FALSE); | |
231 | if (enum_definition) { | |
232 | id = enum_definition->integer->value._unsigned; | |
233 | } | |
234 | } | |
235 | ||
236 | variant = lookup_variant(&stream_class->event_header->p, "v"); | |
237 | if (variant) { | |
238 | integer_definition = lookup_integer(variant, "id", FALSE); | |
239 | if (integer_definition) { | |
240 | id = integer_definition->value._unsigned; | |
241 | } | |
31262354 MD |
242 | } |
243 | ||
244 | ret = generic_rw(pos, &stream_class->event_header->p); | |
245 | if (ret) | |
246 | goto error; | |
247 | } | |
248 | ||
249 | /* print stream-declared event context */ | |
250 | if (stream_class->event_context) { | |
251 | ret = generic_rw(pos, &stream_class->event_context->p); | |
252 | if (ret) | |
253 | goto error; | |
254 | } | |
255 | ||
256 | if (id >= stream_class->events_by_id->len) { | |
257 | fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id); | |
258 | return -EINVAL; | |
259 | } | |
260 | event_class = g_ptr_array_index(stream_class->events_by_id, id); | |
261 | if (!event_class) { | |
262 | fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id); | |
263 | return -EINVAL; | |
264 | } | |
265 | ||
266 | /* print event-declared event context */ | |
267 | if (event_class->context) { | |
268 | ret = generic_rw(pos, &event_class->context->p); | |
269 | if (ret) | |
270 | goto error; | |
271 | } | |
272 | ||
273 | /* Read and print event payload */ | |
274 | if (event_class->fields) { | |
275 | ret = generic_rw(pos, &event_class->fields->p); | |
276 | if (ret) | |
277 | goto error; | |
278 | } | |
279 | ||
280 | return 0; | |
281 | ||
282 | error: | |
283 | fprintf(stdout, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n"); | |
284 | return ret; | |
285 | } | |
286 | ||
8563e754 | 287 | void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags) |
8c572eba MD |
288 | { |
289 | pos->fd = fd; | |
290 | pos->mmap_offset = 0; | |
291 | pos->packet_size = 0; | |
292 | pos->content_size = 0; | |
293 | pos->content_size_loc = NULL; | |
294 | pos->base = NULL; | |
295 | pos->offset = 0; | |
296 | pos->dummy = false; | |
8c572eba | 297 | pos->cur_index = 0; |
8563e754 MD |
298 | if (fd >= 0) |
299 | pos->packet_index = g_array_new(FALSE, TRUE, | |
300 | sizeof(struct packet_index)); | |
301 | else | |
302 | pos->packet_index = NULL; | |
8563e754 MD |
303 | switch (open_flags & O_ACCMODE) { |
304 | case O_RDONLY: | |
305 | pos->prot = PROT_READ; | |
306 | pos->flags = MAP_PRIVATE; | |
307 | pos->parent.rw_table = read_dispatch_table; | |
31262354 | 308 | pos->parent.event_cb = ctf_read_event; |
8563e754 | 309 | break; |
8563e754 MD |
310 | case O_RDWR: |
311 | pos->prot = PROT_WRITE; /* Write has priority */ | |
312 | pos->flags = MAP_SHARED; | |
313 | pos->parent.rw_table = write_dispatch_table; | |
31262354 | 314 | pos->parent.event_cb = ctf_write_event; |
8563e754 | 315 | if (fd >= 0) |
847bf71a | 316 | ctf_move_pos_slow(pos, 0, SEEK_SET); /* position for write */ |
8563e754 MD |
317 | break; |
318 | default: | |
319 | assert(0); | |
8c572eba MD |
320 | } |
321 | } | |
322 | ||
46322b33 | 323 | void ctf_fini_pos(struct ctf_stream_pos *pos) |
8c572eba MD |
324 | { |
325 | int ret; | |
326 | ||
327 | if (pos->prot == PROT_WRITE && pos->content_size_loc) | |
328 | *pos->content_size_loc = pos->offset; | |
329 | if (pos->base) { | |
330 | /* unmap old base */ | |
331 | ret = munmap(pos->base, pos->packet_size / CHAR_BIT); | |
332 | if (ret) { | |
46322b33 | 333 | fprintf(stdout, "[error] Unable to unmap old base: %s.\n", |
8c572eba MD |
334 | strerror(errno)); |
335 | assert(0); | |
336 | } | |
337 | } | |
338 | (void) g_array_free(pos->packet_index, TRUE); | |
339 | } | |
340 | ||
847bf71a | 341 | void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence) |
0f980a35 MD |
342 | { |
343 | int ret; | |
8c572eba MD |
344 | off_t off; |
345 | struct packet_index *index; | |
0f980a35 | 346 | |
8c572eba MD |
347 | if (pos->prot == PROT_WRITE && pos->content_size_loc) |
348 | *pos->content_size_loc = pos->offset; | |
0f980a35 MD |
349 | |
350 | if (pos->base) { | |
351 | /* unmap old base */ | |
8c572eba | 352 | ret = munmap(pos->base, pos->packet_size / CHAR_BIT); |
0f980a35 | 353 | if (ret) { |
46322b33 | 354 | fprintf(stdout, "[error] Unable to unmap old base: %s.\n", |
0f980a35 MD |
355 | strerror(errno)); |
356 | assert(0); | |
357 | } | |
847bf71a | 358 | pos->base = NULL; |
0f980a35 MD |
359 | } |
360 | ||
8c572eba | 361 | /* |
46322b33 | 362 | * The caller should never ask for ctf_move_pos across packets, |
8c572eba MD |
363 | * except to get exactly at the beginning of the next packet. |
364 | */ | |
365 | if (pos->prot == PROT_WRITE) { | |
989c73bc MD |
366 | switch (whence) { |
367 | case SEEK_CUR: | |
368 | /* The writer will add padding */ | |
369 | assert(pos->offset + offset == pos->packet_size); | |
8c572eba | 370 | pos->mmap_offset += WRITE_PACKET_LEN / CHAR_BIT; |
989c73bc MD |
371 | break; |
372 | case SEEK_SET: | |
373 | assert(offset == 0); /* only seek supported for now */ | |
374 | pos->cur_index = 0; | |
375 | break; | |
376 | default: | |
377 | assert(0); | |
378 | } | |
8c572eba MD |
379 | pos->content_size = -1U; /* Unknown at this point */ |
380 | pos->packet_size = WRITE_PACKET_LEN; | |
989c73bc MD |
381 | off = posix_fallocate(pos->fd, pos->mmap_offset, |
382 | pos->packet_size / CHAR_BIT); | |
8c572eba | 383 | assert(off >= 0); |
847bf71a | 384 | pos->offset = 0; |
8c572eba | 385 | } else { |
847bf71a MD |
386 | switch (whence) { |
387 | case SEEK_CUR: | |
388 | /* The reader will expect us to skip padding */ | |
389 | assert(pos->offset + offset == pos->content_size); | |
8c572eba | 390 | ++pos->cur_index; |
847bf71a MD |
391 | break; |
392 | case SEEK_SET: | |
393 | assert(offset == 0); /* only seek supported for now */ | |
394 | pos->cur_index = 0; | |
395 | break; | |
396 | default: | |
397 | assert(0); | |
398 | } | |
399 | if (pos->cur_index >= pos->packet_index->len) { | |
670977d3 | 400 | pos->offset = EOF; |
847bf71a MD |
401 | return; |
402 | } | |
8c572eba MD |
403 | index = &g_array_index(pos->packet_index, struct packet_index, |
404 | pos->cur_index); | |
405 | pos->mmap_offset = index->offset; | |
406 | ||
407 | /* Lookup context/packet size in index */ | |
408 | pos->content_size = index->content_size; | |
409 | pos->packet_size = index->packet_size; | |
2b9a764d MD |
410 | if (index->data_offset < index->content_size) |
411 | pos->offset = index->data_offset; | |
412 | else { | |
413 | pos->offset = EOF; | |
414 | return; | |
415 | } | |
8c572eba | 416 | } |
0f980a35 | 417 | /* map new base. Need mapping length from header. */ |
8c572eba MD |
418 | pos->base = mmap(NULL, pos->packet_size / CHAR_BIT, pos->prot, |
419 | pos->flags, pos->fd, pos->mmap_offset); | |
847bf71a MD |
420 | if (pos->base == MAP_FAILED) { |
421 | fprintf(stdout, "[error] mmap error %s.\n", | |
422 | strerror(errno)); | |
423 | assert(0); | |
424 | } | |
0f980a35 MD |
425 | } |
426 | ||
b4c19c1e MD |
427 | static |
428 | int packet_metadata(struct ctf_trace *td, FILE *fp) | |
429 | { | |
430 | uint32_t magic; | |
431 | size_t len; | |
432 | int ret = 0; | |
433 | ||
434 | len = fread(&magic, sizeof(magic), 1, fp); | |
a0fe7d97 | 435 | if (len != 1) { |
b4c19c1e MD |
436 | goto end; |
437 | } | |
438 | if (magic == TSDL_MAGIC) { | |
439 | ret = 1; | |
440 | td->byte_order = BYTE_ORDER; | |
441 | } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) { | |
442 | ret = 1; | |
443 | td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ? | |
444 | LITTLE_ENDIAN : BIG_ENDIAN; | |
445 | } | |
a0fe7d97 | 446 | CTF_TRACE_SET_FIELD(td, byte_order); |
b4c19c1e MD |
447 | end: |
448 | rewind(fp); | |
449 | return ret; | |
450 | } | |
451 | ||
452 | static | |
453 | int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in, | |
454 | FILE *out) | |
455 | { | |
456 | struct metadata_packet_header header; | |
a0fe7d97 | 457 | size_t readlen, writelen, toread; |
b4c19c1e MD |
458 | char buf[4096]; |
459 | int ret = 0; | |
460 | ||
a91a962e | 461 | readlen = fread(&header, header_sizeof(header), 1, in); |
a0fe7d97 | 462 | if (readlen < 1) |
b4c19c1e MD |
463 | return -EINVAL; |
464 | ||
465 | if (td->byte_order != BYTE_ORDER) { | |
466 | header.magic = GUINT32_SWAP_LE_BE(header.magic); | |
467 | header.checksum = GUINT32_SWAP_LE_BE(header.checksum); | |
468 | header.content_size = GUINT32_SWAP_LE_BE(header.content_size); | |
469 | header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size); | |
470 | } | |
471 | if (header.checksum) | |
472 | fprintf(stdout, "[warning] checksum verification not supported yet.\n"); | |
473 | if (header.compression_scheme) { | |
474 | fprintf(stdout, "[error] compression (%u) not supported yet.\n", | |
475 | header.compression_scheme); | |
476 | return -EINVAL; | |
477 | } | |
478 | if (header.encryption_scheme) { | |
479 | fprintf(stdout, "[error] encryption (%u) not supported yet.\n", | |
480 | header.encryption_scheme); | |
481 | return -EINVAL; | |
482 | } | |
483 | if (header.checksum_scheme) { | |
484 | fprintf(stdout, "[error] checksum (%u) not supported yet.\n", | |
485 | header.checksum_scheme); | |
486 | return -EINVAL; | |
487 | } | |
488 | if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) { | |
489 | memcpy(td->uuid, header.uuid, sizeof(header.uuid)); | |
490 | CTF_TRACE_SET_FIELD(td, uuid); | |
491 | } else { | |
492 | if (uuid_compare(header.uuid, td->uuid)) | |
493 | return -EINVAL; | |
494 | } | |
495 | ||
a0fe7d97 MD |
496 | toread = header.content_size / CHAR_BIT; |
497 | ||
498 | for (;;) { | |
499 | readlen = fread(buf, sizeof(char), min(sizeof(buf), toread), in); | |
b4c19c1e MD |
500 | if (ferror(in)) { |
501 | ret = -EINVAL; | |
502 | break; | |
503 | } | |
4152822b MD |
504 | if (babeltrace_debug) { |
505 | fprintf(stdout, "[debug] metadata packet read: %s\n", | |
506 | buf); | |
507 | } | |
508 | ||
b4c19c1e MD |
509 | writelen = fwrite(buf, sizeof(char), readlen, out); |
510 | if (writelen < readlen) { | |
511 | ret = -EIO; | |
512 | break; | |
513 | } | |
514 | if (ferror(out)) { | |
515 | ret = -EINVAL; | |
516 | break; | |
517 | } | |
a0fe7d97 MD |
518 | toread -= readlen; |
519 | if (!toread) { | |
7f4b5c4d | 520 | ret = 0; /* continue reading next packet */ |
a0fe7d97 MD |
521 | break; |
522 | } | |
b4c19c1e MD |
523 | } |
524 | return ret; | |
525 | } | |
526 | ||
527 | static | |
528 | int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp, | |
529 | char **buf) | |
530 | { | |
531 | FILE *in, *out; | |
532 | size_t size; | |
533 | int ret; | |
534 | ||
535 | in = *fp; | |
c4f5487e MD |
536 | /* |
537 | * Using strlen on *buf instead of size of open_memstream | |
538 | * because its size includes garbage at the end (after final | |
539 | * \0). This is the allocated size, not the actual string size. | |
540 | */ | |
b4c19c1e MD |
541 | out = open_memstream(buf, &size); |
542 | if (out == NULL) | |
543 | return -errno; | |
544 | ||
545 | for (;;) { | |
546 | ret = ctf_open_trace_metadata_packet_read(td, in, out); | |
7f4b5c4d | 547 | if (ret) { |
b4c19c1e | 548 | break; |
7f4b5c4d MD |
549 | } |
550 | if (feof(in)) { | |
551 | ret = 0; | |
b4c19c1e MD |
552 | break; |
553 | } | |
554 | } | |
555 | fclose(out); /* flush the buffer */ | |
556 | fclose(in); | |
557 | /* open for reading */ | |
c4f5487e | 558 | *fp = fmemopen(*buf, strlen(*buf), "rb"); |
b4c19c1e MD |
559 | return 0; |
560 | } | |
561 | ||
65102a8c | 562 | static |
46322b33 | 563 | int ctf_open_trace_metadata_read(struct ctf_trace *td) |
65102a8c MD |
564 | { |
565 | struct ctf_scanner *scanner; | |
566 | FILE *fp; | |
b4c19c1e | 567 | char *buf = NULL; |
65102a8c MD |
568 | int ret = 0; |
569 | ||
46322b33 MD |
570 | td->metadata.pos.fd = openat(td->dirfd, "metadata", O_RDONLY); |
571 | if (td->metadata.pos.fd < 0) { | |
65102a8c | 572 | fprintf(stdout, "Unable to open metadata.\n"); |
46322b33 | 573 | return td->metadata.pos.fd; |
65102a8c MD |
574 | } |
575 | ||
576 | if (babeltrace_debug) | |
577 | yydebug = 1; | |
578 | ||
46322b33 | 579 | fp = fdopen(td->metadata.pos.fd, "r"); |
65102a8c | 580 | if (!fp) { |
46322b33 | 581 | fprintf(stdout, "[error] Unable to open metadata stream.\n"); |
65102a8c MD |
582 | ret = -errno; |
583 | goto end_stream; | |
584 | } | |
585 | ||
b4c19c1e MD |
586 | if (packet_metadata(td, fp)) { |
587 | ret = ctf_open_trace_metadata_stream_read(td, &fp, &buf); | |
588 | if (ret) | |
589 | goto end_packet_read; | |
590 | } | |
591 | ||
65102a8c MD |
592 | scanner = ctf_scanner_alloc(fp); |
593 | if (!scanner) { | |
46322b33 | 594 | fprintf(stdout, "[error] Error allocating scanner\n"); |
65102a8c MD |
595 | ret = -ENOMEM; |
596 | goto end_scanner_alloc; | |
597 | } | |
598 | ret = ctf_scanner_append_ast(scanner); | |
599 | if (ret) { | |
46322b33 | 600 | fprintf(stdout, "[error] Error creating AST\n"); |
65102a8c MD |
601 | goto end; |
602 | } | |
603 | ||
604 | if (babeltrace_debug) { | |
605 | ret = ctf_visitor_print_xml(stdout, 0, &scanner->ast->root); | |
606 | if (ret) { | |
46322b33 | 607 | fprintf(stdout, "[error] Error visiting AST for XML output\n"); |
65102a8c MD |
608 | goto end; |
609 | } | |
610 | } | |
611 | ||
612 | ret = ctf_visitor_semantic_check(stdout, 0, &scanner->ast->root); | |
613 | if (ret) { | |
46322b33 | 614 | fprintf(stdout, "[error] Error in CTF semantic validation %d\n", ret); |
65102a8c MD |
615 | goto end; |
616 | } | |
617 | ret = ctf_visitor_construct_metadata(stdout, 0, &scanner->ast->root, | |
46322b33 | 618 | td, BYTE_ORDER); |
65102a8c | 619 | if (ret) { |
46322b33 | 620 | fprintf(stdout, "[error] Error in CTF metadata constructor %d\n", ret); |
65102a8c MD |
621 | goto end; |
622 | } | |
623 | end: | |
624 | ctf_scanner_free(scanner); | |
625 | end_scanner_alloc: | |
b4c19c1e | 626 | end_packet_read: |
65102a8c | 627 | fclose(fp); |
b4c19c1e | 628 | free(buf); |
65102a8c | 629 | end_stream: |
46322b33 | 630 | close(td->metadata.pos.fd); |
0f980a35 MD |
631 | return ret; |
632 | } | |
633 | ||
634 | ||
635 | static | |
46322b33 | 636 | int create_stream_packet_index(struct ctf_trace *td, |
0f980a35 MD |
637 | struct ctf_file_stream *file_stream) |
638 | { | |
aa6bffae | 639 | struct ctf_stream_class *stream; |
0f980a35 | 640 | int len_index; |
46322b33 | 641 | struct ctf_stream_pos *pos; |
0f980a35 MD |
642 | struct stat filestats; |
643 | struct packet_index packet_index; | |
644 | int first_packet = 1; | |
645 | int ret; | |
646 | ||
647 | pos = &file_stream->pos; | |
648 | ||
649 | ret = fstat(pos->fd, &filestats); | |
650 | if (ret < 0) | |
651 | return ret; | |
652 | ||
653 | for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) { | |
654 | uint64_t stream_id = 0; | |
655 | ||
656 | if (pos->base) { | |
657 | /* unmap old base */ | |
8c572eba | 658 | ret = munmap(pos->base, pos->packet_size / CHAR_BIT); |
0f980a35 | 659 | if (ret) { |
46322b33 | 660 | fprintf(stdout, "[error] Unable to unmap old base: %s.\n", |
0f980a35 MD |
661 | strerror(errno)); |
662 | return ret; | |
663 | } | |
8c572eba | 664 | pos->base = NULL; |
0f980a35 MD |
665 | } |
666 | /* map new base. Need mapping length from header. */ | |
8c572eba | 667 | pos->base = mmap(NULL, MAX_PACKET_HEADER_LEN / CHAR_BIT, PROT_READ, |
0f980a35 | 668 | MAP_PRIVATE, pos->fd, pos->mmap_offset); |
dc48ecad MD |
669 | pos->content_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */ |
670 | pos->packet_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */ | |
0f980a35 MD |
671 | pos->offset = 0; /* Position of the packet header */ |
672 | ||
8c572eba MD |
673 | packet_index.offset = pos->mmap_offset; |
674 | packet_index.content_size = 0; | |
675 | packet_index.packet_size = 0; | |
676 | ||
0f980a35 | 677 | /* read and check header, set stream id (and check) */ |
46322b33 | 678 | if (td->packet_header) { |
0f980a35 | 679 | /* Read packet header */ |
c5e74408 MD |
680 | ret = generic_rw(&pos->parent, &td->packet_header->p); |
681 | if (ret) | |
682 | return ret; | |
46322b33 | 683 | len_index = struct_declaration_lookup_field_index(td->packet_header->declaration, g_quark_from_static_string("magic")); |
0f980a35 MD |
684 | if (len_index >= 0) { |
685 | struct definition_integer *defint; | |
b1a2f580 | 686 | struct definition *field; |
0f980a35 | 687 | |
46322b33 | 688 | field = struct_definition_get_field_from_index(td->packet_header, len_index); |
b1a2f580 MD |
689 | assert(field->declaration->id == CTF_TYPE_INTEGER); |
690 | defint = container_of(field, struct definition_integer, p); | |
0f980a35 MD |
691 | assert(defint->declaration->signedness == FALSE); |
692 | if (defint->value._unsigned != CTF_MAGIC) { | |
d8ea2d29 | 693 | fprintf(stdout, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n", |
8c572eba MD |
694 | defint->value._unsigned, |
695 | file_stream->pos.packet_index->len, | |
696 | (ssize_t) pos->mmap_offset); | |
0f980a35 MD |
697 | return -EINVAL; |
698 | } | |
699 | } | |
700 | ||
701 | /* check uuid */ | |
b4c19c1e | 702 | len_index = struct_declaration_lookup_field_index(td->packet_header->declaration, g_quark_from_static_string("uuid")); |
0f980a35 MD |
703 | if (len_index >= 0) { |
704 | struct definition_array *defarray; | |
b1a2f580 | 705 | struct definition *field; |
0f980a35 MD |
706 | uint64_t i; |
707 | uint8_t uuidval[UUID_LEN]; | |
708 | ||
46322b33 | 709 | field = struct_definition_get_field_from_index(td->packet_header, len_index); |
b1a2f580 MD |
710 | assert(field->declaration->id == CTF_TYPE_ARRAY); |
711 | defarray = container_of(field, struct definition_array, p); | |
3838df27 | 712 | assert(array_len(defarray) == UUID_LEN); |
0f980a35 MD |
713 | assert(defarray->declaration->elem->id == CTF_TYPE_INTEGER); |
714 | ||
715 | for (i = 0; i < UUID_LEN; i++) { | |
716 | struct definition *elem; | |
717 | struct definition_integer *defint; | |
718 | ||
719 | elem = array_index(defarray, i); | |
720 | assert(elem); | |
721 | defint = container_of(elem, struct definition_integer, p); | |
722 | uuidval[i] = defint->value._unsigned; | |
723 | } | |
46322b33 | 724 | ret = uuid_compare(td->uuid, uuidval); |
0f980a35 MD |
725 | if (ret) { |
726 | fprintf(stdout, "[error] Unique Universal Identifiers do not match.\n"); | |
727 | return -EINVAL; | |
728 | } | |
729 | } | |
730 | ||
731 | ||
46322b33 | 732 | len_index = struct_declaration_lookup_field_index(td->packet_header->declaration, g_quark_from_static_string("stream_id")); |
0f980a35 MD |
733 | if (len_index >= 0) { |
734 | struct definition_integer *defint; | |
b1a2f580 | 735 | struct definition *field; |
0f980a35 | 736 | |
46322b33 | 737 | field = struct_definition_get_field_from_index(td->packet_header, len_index); |
b1a2f580 MD |
738 | assert(field->declaration->id == CTF_TYPE_INTEGER); |
739 | defint = container_of(field, struct definition_integer, p); | |
0f980a35 MD |
740 | assert(defint->declaration->signedness == FALSE); |
741 | stream_id = defint->value._unsigned; | |
742 | } | |
743 | } | |
744 | ||
745 | if (!first_packet && file_stream->stream_id != stream_id) { | |
746 | fprintf(stdout, "[error] Stream ID is changing within a stream.\n"); | |
747 | return -EINVAL; | |
748 | } | |
749 | if (first_packet) { | |
750 | file_stream->stream_id = stream_id; | |
46322b33 | 751 | if (stream_id >= td->streams->len) { |
0f980a35 MD |
752 | fprintf(stdout, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); |
753 | return -EINVAL; | |
754 | } | |
46322b33 | 755 | stream = g_ptr_array_index(td->streams, stream_id); |
0f980a35 MD |
756 | if (!stream) { |
757 | fprintf(stdout, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); | |
758 | return -EINVAL; | |
759 | } | |
764af3f4 | 760 | file_stream->stream.stream_class = stream; |
0f980a35 MD |
761 | } |
762 | first_packet = 0; | |
763 | ||
dc48ecad MD |
764 | if (stream->packet_context) { |
765 | /* Read packet context */ | |
c5e74408 MD |
766 | ret = generic_rw(&pos->parent, &stream->packet_context->p); |
767 | if (ret) | |
768 | return ret; | |
dc48ecad MD |
769 | /* read content size from header */ |
770 | len_index = struct_declaration_lookup_field_index(stream->packet_context->declaration, g_quark_from_static_string("content_size")); | |
771 | if (len_index >= 0) { | |
772 | struct definition_integer *defint; | |
b1a2f580 | 773 | struct definition *field; |
dc48ecad MD |
774 | |
775 | field = struct_definition_get_field_from_index(stream->packet_context, len_index); | |
b1a2f580 MD |
776 | assert(field->declaration->id == CTF_TYPE_INTEGER); |
777 | defint = container_of(field, struct definition_integer, p); | |
dc48ecad | 778 | assert(defint->declaration->signedness == FALSE); |
8c572eba | 779 | packet_index.content_size = defint->value._unsigned; |
dc48ecad MD |
780 | } else { |
781 | /* Use file size for packet size */ | |
8c572eba | 782 | packet_index.content_size = filestats.st_size * CHAR_BIT; |
dc48ecad MD |
783 | } |
784 | ||
785 | /* read packet size from header */ | |
786 | len_index = struct_declaration_lookup_field_index(stream->packet_context->declaration, g_quark_from_static_string("packet_size")); | |
787 | if (len_index >= 0) { | |
788 | struct definition_integer *defint; | |
b1a2f580 | 789 | struct definition *field; |
dc48ecad MD |
790 | |
791 | field = struct_definition_get_field_from_index(stream->packet_context, len_index); | |
b1a2f580 MD |
792 | assert(field->declaration->id == CTF_TYPE_INTEGER); |
793 | defint = container_of(field, struct definition_integer, p); | |
dc48ecad | 794 | assert(defint->declaration->signedness == FALSE); |
8c572eba | 795 | packet_index.packet_size = defint->value._unsigned; |
dc48ecad MD |
796 | } else { |
797 | /* Use content size if non-zero, else file size */ | |
8c572eba | 798 | packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT; |
dc48ecad | 799 | } |
0f980a35 MD |
800 | } else { |
801 | /* Use file size for packet size */ | |
8c572eba | 802 | packet_index.content_size = filestats.st_size * CHAR_BIT; |
0f980a35 | 803 | /* Use content size if non-zero, else file size */ |
8c572eba | 804 | packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT; |
0f980a35 | 805 | } |
546293fa MD |
806 | |
807 | /* Validate content size and packet size values */ | |
808 | if (packet_index.content_size > packet_index.packet_size) { | |
809 | fprintf(stdout, "[error] Content size (%zu bits) is larger than packet size (%zu bits).\n", | |
810 | packet_index.content_size, packet_index.packet_size); | |
811 | return -EINVAL; | |
812 | } | |
813 | ||
58b0b883 MD |
814 | if (packet_index.packet_size > (filestats.st_size - packet_index.offset) * CHAR_BIT) { |
815 | fprintf(stdout, "[error] Packet size (%zu bits) is larger than remaining file size (%zu bits).\n", | |
816 | packet_index.content_size, (filestats.st_size - packet_index.offset) * CHAR_BIT); | |
546293fa MD |
817 | return -EINVAL; |
818 | } | |
819 | ||
847bf71a MD |
820 | /* Save position after header and context */ |
821 | packet_index.data_offset = pos->offset; | |
0f980a35 | 822 | |
0f980a35 MD |
823 | /* add index to packet array */ |
824 | g_array_append_val(file_stream->pos.packet_index, packet_index); | |
825 | ||
8c572eba | 826 | pos->mmap_offset += packet_index.packet_size / CHAR_BIT; |
0f980a35 MD |
827 | } |
828 | ||
847bf71a MD |
829 | /* Move pos back to beginning of file */ |
830 | ctf_move_pos_slow(pos, 0, SEEK_SET); /* position for write */ | |
831 | ||
0f980a35 MD |
832 | return 0; |
833 | } | |
834 | ||
835 | /* | |
836 | * Note: many file streams can inherit from the same stream class | |
837 | * description (metadata). | |
838 | */ | |
839 | static | |
46322b33 | 840 | int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags) |
0f980a35 MD |
841 | { |
842 | int ret; | |
843 | struct ctf_file_stream *file_stream; | |
844 | ||
46322b33 | 845 | ret = openat(td->dirfd, path, flags); |
0f980a35 MD |
846 | if (ret < 0) |
847 | goto error; | |
848 | file_stream = g_new0(struct ctf_file_stream, 1); | |
8563e754 | 849 | ctf_init_pos(&file_stream->pos, ret, flags); |
0f980a35 MD |
850 | ret = create_stream_packet_index(td, file_stream); |
851 | if (ret) | |
852 | goto error_index; | |
853 | /* Add stream file to stream class */ | |
764af3f4 | 854 | g_ptr_array_add(file_stream->stream.stream_class->files, file_stream); |
0f980a35 MD |
855 | return 0; |
856 | ||
857 | error_index: | |
46322b33 | 858 | ctf_fini_pos(&file_stream->pos); |
0f980a35 MD |
859 | close(file_stream->pos.fd); |
860 | g_free(file_stream); | |
861 | error: | |
65102a8c MD |
862 | return ret; |
863 | } | |
864 | ||
bbefb8dd | 865 | static |
46322b33 | 866 | int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags) |
bbefb8dd MD |
867 | { |
868 | int ret; | |
65102a8c MD |
869 | struct dirent *dirent; |
870 | struct dirent *diriter; | |
871 | size_t dirent_len; | |
bbefb8dd | 872 | |
46322b33 | 873 | td->flags = flags; |
bbefb8dd MD |
874 | |
875 | /* Open trace directory */ | |
46322b33 MD |
876 | td->dir = opendir(path); |
877 | if (!td->dir) { | |
dc48ecad | 878 | fprintf(stdout, "[error] Unable to open trace directory.\n"); |
bbefb8dd MD |
879 | ret = -ENOENT; |
880 | goto error; | |
881 | } | |
882 | ||
46322b33 MD |
883 | td->dirfd = open(path, 0); |
884 | if (td->dirfd < 0) { | |
dc48ecad | 885 | fprintf(stdout, "[error] Unable to open trace directory file descriptor.\n"); |
65102a8c MD |
886 | ret = -ENOENT; |
887 | goto error_dirfd; | |
888 | } | |
0f980a35 | 889 | |
65102a8c MD |
890 | /* |
891 | * Keep the metadata file separate. | |
892 | */ | |
bbefb8dd | 893 | |
65102a8c MD |
894 | ret = ctf_open_trace_metadata_read(td); |
895 | if (ret) { | |
896 | goto error_metadata; | |
897 | } | |
bbefb8dd MD |
898 | |
899 | /* | |
900 | * Open each stream: for each file, try to open, check magic | |
901 | * number, and get the stream ID to add to the right location in | |
902 | * the stream array. | |
bbefb8dd MD |
903 | */ |
904 | ||
65102a8c | 905 | dirent_len = offsetof(struct dirent, d_name) + |
46322b33 | 906 | fpathconf(td->dirfd, _PC_NAME_MAX) + 1; |
bbefb8dd | 907 | |
65102a8c | 908 | dirent = malloc(dirent_len); |
bbefb8dd | 909 | |
65102a8c | 910 | for (;;) { |
46322b33 | 911 | ret = readdir_r(td->dir, dirent, &diriter); |
65102a8c | 912 | if (ret) { |
dc48ecad | 913 | fprintf(stdout, "[error] Readdir error.\n"); |
65102a8c | 914 | goto readdir_error; |
65102a8c MD |
915 | } |
916 | if (!diriter) | |
917 | break; | |
d8ea2d29 MD |
918 | /* Ignore hidden files, ., .. and metadata. */ |
919 | if (!strncmp(diriter->d_name, ".", 1) | |
65102a8c MD |
920 | || !strcmp(diriter->d_name, "..") |
921 | || !strcmp(diriter->d_name, "metadata")) | |
922 | continue; | |
dc48ecad MD |
923 | ret = ctf_open_file_stream_read(td, diriter->d_name, flags); |
924 | if (ret) { | |
925 | fprintf(stdout, "[error] Open file stream error.\n"); | |
926 | goto readdir_error; | |
927 | } | |
65102a8c | 928 | } |
bbefb8dd | 929 | |
65102a8c | 930 | free(dirent); |
bbefb8dd | 931 | return 0; |
65102a8c MD |
932 | |
933 | readdir_error: | |
934 | free(dirent); | |
935 | error_metadata: | |
46322b33 | 936 | close(td->dirfd); |
65102a8c | 937 | error_dirfd: |
46322b33 | 938 | closedir(td->dir); |
bbefb8dd MD |
939 | error: |
940 | return ret; | |
941 | } | |
942 | ||
e9378815 | 943 | static |
bbefb8dd MD |
944 | struct trace_descriptor *ctf_open_trace(const char *path, int flags) |
945 | { | |
46322b33 | 946 | struct ctf_trace *td; |
bbefb8dd MD |
947 | int ret; |
948 | ||
46322b33 | 949 | td = g_new0(struct ctf_trace, 1); |
bbefb8dd | 950 | |
8c572eba | 951 | switch (flags & O_ACCMODE) { |
bbefb8dd | 952 | case O_RDONLY: |
b61922b5 MD |
953 | if (!path) { |
954 | fprintf(stdout, "[error] Path missing for input CTF trace.\n"); | |
955 | goto error; | |
956 | } | |
bbefb8dd MD |
957 | ret = ctf_open_trace_read(td, path, flags); |
958 | if (ret) | |
959 | goto error; | |
960 | break; | |
989c73bc | 961 | case O_RDWR: |
46322b33 MD |
962 | fprintf(stdout, "[error] Opening CTF traces for output is not supported yet.\n"); |
963 | goto error; | |
bbefb8dd | 964 | default: |
46322b33 | 965 | fprintf(stdout, "[error] Incorrect open flags.\n"); |
bbefb8dd MD |
966 | goto error; |
967 | } | |
968 | ||
46322b33 | 969 | return &td->parent; |
bbefb8dd MD |
970 | error: |
971 | g_free(td); | |
972 | return NULL; | |
973 | } | |
974 | ||
0f980a35 MD |
975 | static |
976 | void ctf_close_file_stream(struct ctf_file_stream *file_stream) | |
977 | { | |
46322b33 | 978 | ctf_fini_pos(&file_stream->pos); |
0f980a35 MD |
979 | close(file_stream->pos.fd); |
980 | } | |
981 | ||
e9378815 | 982 | static |
46322b33 | 983 | void ctf_close_trace(struct trace_descriptor *tdp) |
bbefb8dd | 984 | { |
46322b33 | 985 | struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent); |
0f980a35 MD |
986 | int i; |
987 | ||
46322b33 MD |
988 | if (td->streams) { |
989 | for (i = 0; i < td->streams->len; i++) { | |
aa6bffae | 990 | struct ctf_stream_class *stream; |
0f980a35 | 991 | int j; |
e9378815 | 992 | |
46322b33 | 993 | stream = g_ptr_array_index(td->streams, i); |
e9378815 MD |
994 | if (!stream) |
995 | continue; | |
0f980a35 MD |
996 | for (j = 0; j < stream->files->len; j++) { |
997 | struct ctf_file_stream *file_stream; | |
2c117823 | 998 | file_stream = g_ptr_array_index(stream->files, j); |
0f980a35 MD |
999 | ctf_close_file_stream(file_stream); |
1000 | } | |
1001 | ||
1002 | } | |
46322b33 | 1003 | g_ptr_array_free(td->streams, TRUE); |
0f980a35 | 1004 | } |
46322b33 | 1005 | closedir(td->dir); |
bbefb8dd MD |
1006 | g_free(td); |
1007 | } | |
1008 | ||
7fb21036 | 1009 | void __attribute__((constructor)) ctf_init(void) |
fc93b2bd MD |
1010 | { |
1011 | int ret; | |
1012 | ||
4c8bfb7e | 1013 | ctf_format.name = g_quark_from_static_string("ctf"); |
fc93b2bd MD |
1014 | ret = bt_register_format(&ctf_format); |
1015 | assert(!ret); | |
1016 | } | |
698f0fe4 MD |
1017 | |
1018 | /* TODO: finalize */ |