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