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> |
65102a8c | 24 | #include <babeltrace/babeltrace.h> |
0f980a35 | 25 | #include <inttypes.h> |
b4c19c1e | 26 | #include <stdio.h> |
0f980a35 MD |
27 | #include <uuid/uuid.h> |
28 | #include <sys/mman.h> | |
bbefb8dd | 29 | #include <errno.h> |
b4c19c1e | 30 | #include <endian.h> |
bbefb8dd | 31 | #include <sys/types.h> |
65102a8c | 32 | #include <sys/stat.h> |
bbefb8dd | 33 | #include <fcntl.h> |
65102a8c | 34 | #include <dirent.h> |
bbefb8dd | 35 | #include <glib.h> |
65102a8c MD |
36 | #include <unistd.h> |
37 | #include <stdlib.h> | |
38 | ||
65102a8c MD |
39 | #include "metadata/ctf-scanner.h" |
40 | #include "metadata/ctf-parser.h" | |
41 | #include "metadata/ctf-ast.h" | |
42 | ||
0f980a35 MD |
43 | /* |
44 | * We currently simply map a page to read the packet header and packet | |
8c572eba | 45 | * context to get the packet length and content length. (in bits) |
0f980a35 | 46 | */ |
8c572eba MD |
47 | #define MAX_PACKET_HEADER_LEN (getpagesize() * CHAR_BIT) |
48 | #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT) | |
0f980a35 MD |
49 | #define UUID_LEN 16 /* uuid by value len */ |
50 | ||
a0fe7d97 MD |
51 | #ifndef min |
52 | #define min(a, b) (((a) < (b)) ? (a) : (b)) | |
53 | #endif | |
54 | ||
65102a8c | 55 | extern int yydebug; |
bbefb8dd | 56 | |
e9378815 | 57 | static |
bbefb8dd | 58 | struct trace_descriptor *ctf_open_trace(const char *path, int flags); |
e9378815 | 59 | static |
bbefb8dd | 60 | void ctf_close_trace(struct trace_descriptor *descriptor); |
fc93b2bd | 61 | |
1ae19169 MD |
62 | static |
63 | rw_dispatch read_dispatch_table[] = { | |
d11e9c49 MD |
64 | [ CTF_TYPE_INTEGER ] = ctf_integer_read, |
65 | [ CTF_TYPE_FLOAT ] = ctf_float_read, | |
66 | [ CTF_TYPE_ENUM ] = ctf_enum_read, | |
67 | [ CTF_TYPE_STRING ] = ctf_string_read, | |
68 | [ CTF_TYPE_STRUCT ] = ctf_struct_rw, | |
69 | [ CTF_TYPE_VARIANT ] = ctf_variant_rw, | |
81dee1bb MD |
70 | [ CTF_TYPE_ARRAY ] = ctf_array_read, |
71 | [ CTF_TYPE_SEQUENCE ] = ctf_sequence_read, | |
d11e9c49 MD |
72 | }; |
73 | ||
1ae19169 MD |
74 | static |
75 | rw_dispatch write_dispatch_table[] = { | |
d11e9c49 MD |
76 | [ CTF_TYPE_INTEGER ] = ctf_integer_write, |
77 | [ CTF_TYPE_FLOAT ] = ctf_float_write, | |
78 | [ CTF_TYPE_ENUM ] = ctf_enum_write, | |
79 | [ CTF_TYPE_STRING ] = ctf_string_write, | |
80 | [ CTF_TYPE_STRUCT ] = ctf_struct_rw, | |
81 | [ CTF_TYPE_VARIANT ] = ctf_variant_rw, | |
81dee1bb MD |
82 | [ CTF_TYPE_ARRAY ] = ctf_array_write, |
83 | [ CTF_TYPE_SEQUENCE ] = ctf_sequence_write, | |
d11e9c49 MD |
84 | }; |
85 | ||
1ae19169 | 86 | static |
d11e9c49 | 87 | struct format ctf_format = { |
bbefb8dd MD |
88 | .open_trace = ctf_open_trace, |
89 | .close_trace = ctf_close_trace, | |
fc93b2bd MD |
90 | }; |
91 | ||
2b9a764d MD |
92 | static |
93 | void ctf_update_timestamp(struct ctf_stream *stream, | |
94 | struct definition_integer *integer_definition) | |
95 | { | |
96 | struct declaration_integer *integer_declaration = | |
97 | integer_definition->declaration; | |
98 | uint64_t oldval, newval, updateval; | |
99 | ||
100 | if (integer_declaration->len == 64) { | |
101 | stream->timestamp = integer_definition->value._unsigned; | |
102 | return; | |
103 | } | |
104 | /* keep low bits */ | |
105 | oldval = stream->timestamp; | |
106 | oldval &= (1ULL << integer_declaration->len) - 1; | |
107 | newval = integer_definition->value._unsigned; | |
108 | /* Test for overflow by comparing low bits */ | |
109 | if (newval < oldval) | |
110 | newval += 1ULL << integer_declaration->len; | |
111 | /* updateval contains old high bits, and new low bits (sum) */ | |
112 | updateval = stream->timestamp; | |
113 | updateval &= ~((1ULL << integer_declaration->len) - 1); | |
114 | updateval += newval; | |
115 | stream->timestamp = updateval; | |
116 | } | |
117 | ||
31262354 | 118 | static |
764af3f4 | 119 | int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream) |
31262354 MD |
120 | { |
121 | struct ctf_stream_pos *pos = | |
122 | container_of(ppos, struct ctf_stream_pos, parent); | |
764af3f4 | 123 | struct ctf_stream_class *stream_class = stream->stream_class; |
42dc00b7 | 124 | struct ctf_stream_event *event; |
31262354 | 125 | uint64_t id = 0; |
31262354 MD |
126 | int ret; |
127 | ||
5f643ed7 MD |
128 | ctf_pos_get_event(pos); |
129 | ||
31262354 MD |
130 | if (pos->offset == EOF) |
131 | return EOF; | |
5f643ed7 | 132 | assert(pos->offset < pos->content_size); |
31262354 MD |
133 | |
134 | /* Read event header */ | |
e28d4618 | 135 | if (stream->stream_event_header) { |
a35173fe | 136 | struct definition_integer *integer_definition; |
ccdb988e | 137 | struct definition *variant; |
a35173fe | 138 | |
e28d4618 | 139 | ret = generic_rw(ppos, &stream->stream_event_header->p); |
31262354 MD |
140 | if (ret) |
141 | goto error; | |
142 | /* lookup event id */ | |
e28d4618 | 143 | integer_definition = lookup_integer(&stream->stream_event_header->p, "id", FALSE); |
a35173fe MD |
144 | if (integer_definition) { |
145 | id = integer_definition->value._unsigned; | |
146 | } else { | |
147 | struct definition_enum *enum_definition; | |
148 | ||
e28d4618 | 149 | enum_definition = lookup_enum(&stream->stream_event_header->p, "id", FALSE); |
a35173fe MD |
150 | if (enum_definition) { |
151 | id = enum_definition->integer->value._unsigned; | |
152 | } | |
31262354 | 153 | } |
764af3f4 | 154 | |
e28d4618 | 155 | variant = lookup_variant(&stream->stream_event_header->p, "v"); |
ccdb988e MD |
156 | if (variant) { |
157 | integer_definition = lookup_integer(variant, "id", FALSE); | |
158 | if (integer_definition) { | |
159 | id = integer_definition->value._unsigned; | |
160 | } | |
161 | } | |
162 | ||
764af3f4 | 163 | /* lookup timestamp */ |
5e2eb0ae | 164 | stream->has_timestamp = 0; |
e28d4618 | 165 | integer_definition = lookup_integer(&stream->stream_event_header->p, "timestamp", FALSE); |
a35173fe | 166 | if (integer_definition) { |
2b9a764d | 167 | ctf_update_timestamp(stream, integer_definition); |
5e2eb0ae | 168 | stream->has_timestamp = 1; |
a35173fe | 169 | } else { |
ccdb988e MD |
170 | if (variant) { |
171 | integer_definition = lookup_integer(variant, "timestamp", FALSE); | |
a35173fe | 172 | if (integer_definition) { |
2b9a764d | 173 | ctf_update_timestamp(stream, integer_definition); |
5e2eb0ae | 174 | stream->has_timestamp = 1; |
a35173fe MD |
175 | } |
176 | } | |
764af3f4 | 177 | } |
31262354 MD |
178 | } |
179 | ||
180 | /* Read stream-declared event context */ | |
e28d4618 MD |
181 | if (stream->stream_event_context) { |
182 | ret = generic_rw(ppos, &stream->stream_event_context->p); | |
31262354 MD |
183 | if (ret) |
184 | goto error; | |
185 | } | |
186 | ||
187 | if (id >= stream_class->events_by_id->len) { | |
188 | fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id); | |
189 | return -EINVAL; | |
190 | } | |
e28d4618 MD |
191 | event = g_ptr_array_index(stream->events_by_id, id); |
192 | if (!event) { | |
31262354 MD |
193 | fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id); |
194 | return -EINVAL; | |
195 | } | |
196 | ||
197 | /* Read event-declared event context */ | |
e28d4618 MD |
198 | if (event->event_context) { |
199 | ret = generic_rw(ppos, &event->event_context->p); | |
31262354 MD |
200 | if (ret) |
201 | goto error; | |
202 | } | |
203 | ||
204 | /* Read event payload */ | |
e28d4618 MD |
205 | if (event->event_fields) { |
206 | ret = generic_rw(ppos, &event->event_fields->p); | |
31262354 MD |
207 | if (ret) |
208 | goto error; | |
209 | } | |
210 | ||
211 | return 0; | |
212 | ||
213 | error: | |
214 | fprintf(stdout, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n"); | |
215 | return ret; | |
216 | } | |
217 | ||
218 | static | |
764af3f4 | 219 | int ctf_write_event(struct stream_pos *pos, struct ctf_stream *stream) |
31262354 | 220 | { |
764af3f4 | 221 | struct ctf_stream_class *stream_class = stream->stream_class; |
42dc00b7 | 222 | struct ctf_stream_event *event; |
31262354 | 223 | uint64_t id = 0; |
31262354 MD |
224 | int ret; |
225 | ||
226 | /* print event header */ | |
e28d4618 | 227 | if (stream->stream_event_header) { |
ccdb988e MD |
228 | struct definition_integer *integer_definition; |
229 | struct definition *variant; | |
230 | ||
31262354 | 231 | /* lookup event id */ |
e28d4618 | 232 | integer_definition = lookup_integer(&stream->stream_event_header->p, "id", FALSE); |
ccdb988e MD |
233 | if (integer_definition) { |
234 | id = integer_definition->value._unsigned; | |
235 | } else { | |
236 | struct definition_enum *enum_definition; | |
237 | ||
e28d4618 | 238 | enum_definition = lookup_enum(&stream->stream_event_header->p, "id", FALSE); |
ccdb988e MD |
239 | if (enum_definition) { |
240 | id = enum_definition->integer->value._unsigned; | |
241 | } | |
242 | } | |
243 | ||
e28d4618 | 244 | variant = lookup_variant(&stream->stream_event_header->p, "v"); |
ccdb988e MD |
245 | if (variant) { |
246 | integer_definition = lookup_integer(variant, "id", FALSE); | |
247 | if (integer_definition) { | |
248 | id = integer_definition->value._unsigned; | |
249 | } | |
31262354 MD |
250 | } |
251 | ||
e28d4618 | 252 | ret = generic_rw(pos, &stream->stream_event_header->p); |
31262354 MD |
253 | if (ret) |
254 | goto error; | |
255 | } | |
256 | ||
257 | /* print stream-declared event context */ | |
e28d4618 MD |
258 | if (stream->stream_event_context) { |
259 | ret = generic_rw(pos, &stream->stream_event_context->p); | |
31262354 MD |
260 | if (ret) |
261 | goto error; | |
262 | } | |
263 | ||
264 | if (id >= stream_class->events_by_id->len) { | |
265 | fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id); | |
266 | return -EINVAL; | |
267 | } | |
e28d4618 MD |
268 | event = g_ptr_array_index(stream->events_by_id, id); |
269 | if (!event) { | |
31262354 MD |
270 | fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id); |
271 | return -EINVAL; | |
272 | } | |
273 | ||
274 | /* print event-declared event context */ | |
e28d4618 MD |
275 | if (event->event_context) { |
276 | ret = generic_rw(pos, &event->event_context->p); | |
31262354 MD |
277 | if (ret) |
278 | goto error; | |
279 | } | |
280 | ||
281 | /* Read and print event payload */ | |
e28d4618 MD |
282 | if (event->event_fields) { |
283 | ret = generic_rw(pos, &event->event_fields->p); | |
31262354 MD |
284 | if (ret) |
285 | goto error; | |
286 | } | |
287 | ||
288 | return 0; | |
289 | ||
290 | error: | |
291 | fprintf(stdout, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n"); | |
292 | return ret; | |
293 | } | |
294 | ||
8563e754 | 295 | void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags) |
8c572eba MD |
296 | { |
297 | pos->fd = fd; | |
298 | pos->mmap_offset = 0; | |
299 | pos->packet_size = 0; | |
300 | pos->content_size = 0; | |
301 | pos->content_size_loc = NULL; | |
302 | pos->base = NULL; | |
303 | pos->offset = 0; | |
304 | pos->dummy = false; | |
8c572eba | 305 | pos->cur_index = 0; |
8563e754 MD |
306 | if (fd >= 0) |
307 | pos->packet_index = g_array_new(FALSE, TRUE, | |
308 | sizeof(struct packet_index)); | |
309 | else | |
310 | pos->packet_index = NULL; | |
8563e754 MD |
311 | switch (open_flags & O_ACCMODE) { |
312 | case O_RDONLY: | |
313 | pos->prot = PROT_READ; | |
314 | pos->flags = MAP_PRIVATE; | |
315 | pos->parent.rw_table = read_dispatch_table; | |
31262354 | 316 | pos->parent.event_cb = ctf_read_event; |
8563e754 | 317 | break; |
8563e754 MD |
318 | case O_RDWR: |
319 | pos->prot = PROT_WRITE; /* Write has priority */ | |
320 | pos->flags = MAP_SHARED; | |
321 | pos->parent.rw_table = write_dispatch_table; | |
31262354 | 322 | pos->parent.event_cb = ctf_write_event; |
8563e754 | 323 | if (fd >= 0) |
847bf71a | 324 | ctf_move_pos_slow(pos, 0, SEEK_SET); /* position for write */ |
8563e754 MD |
325 | break; |
326 | default: | |
327 | assert(0); | |
8c572eba MD |
328 | } |
329 | } | |
330 | ||
46322b33 | 331 | void ctf_fini_pos(struct ctf_stream_pos *pos) |
8c572eba MD |
332 | { |
333 | int ret; | |
334 | ||
335 | if (pos->prot == PROT_WRITE && pos->content_size_loc) | |
336 | *pos->content_size_loc = pos->offset; | |
337 | if (pos->base) { | |
338 | /* unmap old base */ | |
339 | ret = munmap(pos->base, pos->packet_size / CHAR_BIT); | |
340 | if (ret) { | |
46322b33 | 341 | fprintf(stdout, "[error] Unable to unmap old base: %s.\n", |
8c572eba MD |
342 | strerror(errno)); |
343 | assert(0); | |
344 | } | |
345 | } | |
346 | (void) g_array_free(pos->packet_index, TRUE); | |
347 | } | |
348 | ||
847bf71a | 349 | void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence) |
0f980a35 | 350 | { |
75cc2c35 MD |
351 | struct ctf_file_stream *file_stream = |
352 | container_of(pos, struct ctf_file_stream, pos); | |
0f980a35 | 353 | int ret; |
8c572eba MD |
354 | off_t off; |
355 | struct packet_index *index; | |
0f980a35 | 356 | |
8c572eba MD |
357 | if (pos->prot == PROT_WRITE && pos->content_size_loc) |
358 | *pos->content_size_loc = pos->offset; | |
0f980a35 MD |
359 | |
360 | if (pos->base) { | |
361 | /* unmap old base */ | |
8c572eba | 362 | ret = munmap(pos->base, pos->packet_size / CHAR_BIT); |
0f980a35 | 363 | if (ret) { |
46322b33 | 364 | fprintf(stdout, "[error] Unable to unmap old base: %s.\n", |
0f980a35 MD |
365 | strerror(errno)); |
366 | assert(0); | |
367 | } | |
847bf71a | 368 | pos->base = NULL; |
0f980a35 MD |
369 | } |
370 | ||
8c572eba | 371 | /* |
46322b33 | 372 | * The caller should never ask for ctf_move_pos across packets, |
8c572eba MD |
373 | * except to get exactly at the beginning of the next packet. |
374 | */ | |
375 | if (pos->prot == PROT_WRITE) { | |
989c73bc MD |
376 | switch (whence) { |
377 | case SEEK_CUR: | |
378 | /* The writer will add padding */ | |
379 | assert(pos->offset + offset == pos->packet_size); | |
8c572eba | 380 | pos->mmap_offset += WRITE_PACKET_LEN / CHAR_BIT; |
989c73bc MD |
381 | break; |
382 | case SEEK_SET: | |
383 | assert(offset == 0); /* only seek supported for now */ | |
384 | pos->cur_index = 0; | |
385 | break; | |
386 | default: | |
387 | assert(0); | |
388 | } | |
8c572eba MD |
389 | pos->content_size = -1U; /* Unknown at this point */ |
390 | pos->packet_size = WRITE_PACKET_LEN; | |
989c73bc MD |
391 | off = posix_fallocate(pos->fd, pos->mmap_offset, |
392 | pos->packet_size / CHAR_BIT); | |
8c572eba | 393 | assert(off >= 0); |
847bf71a | 394 | pos->offset = 0; |
8c572eba | 395 | } else { |
5f643ed7 | 396 | read_next_packet: |
847bf71a MD |
397 | switch (whence) { |
398 | case SEEK_CUR: | |
5f643ed7 MD |
399 | if (pos->offset == EOF) |
400 | return; | |
847bf71a MD |
401 | /* The reader will expect us to skip padding */ |
402 | assert(pos->offset + offset == pos->content_size); | |
8c572eba | 403 | ++pos->cur_index; |
847bf71a MD |
404 | break; |
405 | case SEEK_SET: | |
406 | assert(offset == 0); /* only seek supported for now */ | |
407 | pos->cur_index = 0; | |
408 | break; | |
409 | default: | |
410 | assert(0); | |
411 | } | |
412 | if (pos->cur_index >= pos->packet_index->len) { | |
670977d3 | 413 | pos->offset = EOF; |
847bf71a MD |
414 | return; |
415 | } | |
8c572eba MD |
416 | index = &g_array_index(pos->packet_index, struct packet_index, |
417 | pos->cur_index); | |
418 | pos->mmap_offset = index->offset; | |
419 | ||
420 | /* Lookup context/packet size in index */ | |
2d0bea29 | 421 | file_stream->parent.timestamp = index->timestamp_begin; |
8c572eba MD |
422 | pos->content_size = index->content_size; |
423 | pos->packet_size = index->packet_size; | |
5f643ed7 | 424 | if (index->data_offset < index->content_size) { |
75cc2c35 | 425 | pos->offset = 0; /* will read headers */ |
5f643ed7 MD |
426 | } else if (index->data_offset == index->content_size) { |
427 | /* empty packet */ | |
428 | pos->offset = index->data_offset; | |
429 | offset = 0; | |
430 | goto read_next_packet; | |
7eda6fc7 | 431 | } else { |
2b9a764d MD |
432 | pos->offset = EOF; |
433 | return; | |
434 | } | |
8c572eba | 435 | } |
0f980a35 | 436 | /* map new base. Need mapping length from header. */ |
8c572eba MD |
437 | pos->base = mmap(NULL, pos->packet_size / CHAR_BIT, pos->prot, |
438 | pos->flags, pos->fd, pos->mmap_offset); | |
847bf71a MD |
439 | if (pos->base == MAP_FAILED) { |
440 | fprintf(stdout, "[error] mmap error %s.\n", | |
441 | strerror(errno)); | |
442 | assert(0); | |
443 | } | |
75cc2c35 MD |
444 | |
445 | /* update trace_packet_header and stream_packet_context */ | |
2d0bea29 | 446 | if (pos->prot != PROT_WRITE && file_stream->parent.trace_packet_header) { |
75cc2c35 | 447 | /* Read packet header */ |
2d0bea29 | 448 | ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p); |
75cc2c35 MD |
449 | assert(!ret); |
450 | } | |
2d0bea29 | 451 | if (pos->prot != PROT_WRITE && file_stream->parent.stream_packet_context) { |
75cc2c35 | 452 | /* Read packet context */ |
2d0bea29 | 453 | ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p); |
75cc2c35 MD |
454 | assert(!ret); |
455 | } | |
0f980a35 MD |
456 | } |
457 | ||
b4c19c1e MD |
458 | static |
459 | int packet_metadata(struct ctf_trace *td, FILE *fp) | |
460 | { | |
461 | uint32_t magic; | |
462 | size_t len; | |
463 | int ret = 0; | |
464 | ||
465 | len = fread(&magic, sizeof(magic), 1, fp); | |
a0fe7d97 | 466 | if (len != 1) { |
b4c19c1e MD |
467 | goto end; |
468 | } | |
469 | if (magic == TSDL_MAGIC) { | |
470 | ret = 1; | |
471 | td->byte_order = BYTE_ORDER; | |
0d336fdf | 472 | CTF_TRACE_SET_FIELD(td, byte_order); |
b4c19c1e MD |
473 | } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) { |
474 | ret = 1; | |
475 | td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ? | |
476 | LITTLE_ENDIAN : BIG_ENDIAN; | |
0d336fdf | 477 | CTF_TRACE_SET_FIELD(td, byte_order); |
b4c19c1e MD |
478 | } |
479 | end: | |
480 | rewind(fp); | |
481 | return ret; | |
482 | } | |
483 | ||
5c262147 MD |
484 | /* |
485 | * Returns 0 on success, -1 on error. | |
486 | */ | |
487 | static | |
488 | int check_version(unsigned int major, unsigned int minor) | |
489 | { | |
490 | switch (major) { | |
491 | case 1: | |
492 | switch (minor) { | |
493 | case 8: | |
494 | return 0; | |
495 | default: | |
496 | goto warning; | |
497 | } | |
498 | default: | |
499 | goto warning; | |
500 | ||
501 | } | |
502 | ||
503 | /* eventually return an error instead of warning */ | |
504 | warning: | |
505 | fprintf(stdout, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n", | |
506 | major, minor); | |
507 | return 0; | |
508 | } | |
509 | ||
b4c19c1e MD |
510 | static |
511 | int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in, | |
512 | FILE *out) | |
513 | { | |
514 | struct metadata_packet_header header; | |
a0fe7d97 | 515 | size_t readlen, writelen, toread; |
f8254867 | 516 | char buf[4096 + 1]; /* + 1 for debug-mode \0 */ |
b4c19c1e MD |
517 | int ret = 0; |
518 | ||
a91a962e | 519 | readlen = fread(&header, header_sizeof(header), 1, in); |
a0fe7d97 | 520 | if (readlen < 1) |
b4c19c1e MD |
521 | return -EINVAL; |
522 | ||
523 | if (td->byte_order != BYTE_ORDER) { | |
524 | header.magic = GUINT32_SWAP_LE_BE(header.magic); | |
525 | header.checksum = GUINT32_SWAP_LE_BE(header.checksum); | |
526 | header.content_size = GUINT32_SWAP_LE_BE(header.content_size); | |
527 | header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size); | |
528 | } | |
529 | if (header.checksum) | |
530 | fprintf(stdout, "[warning] checksum verification not supported yet.\n"); | |
531 | if (header.compression_scheme) { | |
532 | fprintf(stdout, "[error] compression (%u) not supported yet.\n", | |
533 | header.compression_scheme); | |
534 | return -EINVAL; | |
535 | } | |
536 | if (header.encryption_scheme) { | |
537 | fprintf(stdout, "[error] encryption (%u) not supported yet.\n", | |
538 | header.encryption_scheme); | |
539 | return -EINVAL; | |
540 | } | |
541 | if (header.checksum_scheme) { | |
542 | fprintf(stdout, "[error] checksum (%u) not supported yet.\n", | |
543 | header.checksum_scheme); | |
544 | return -EINVAL; | |
545 | } | |
5c262147 MD |
546 | if (check_version(header.major, header.minor) < 0) |
547 | return -EINVAL; | |
b4c19c1e MD |
548 | if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) { |
549 | memcpy(td->uuid, header.uuid, sizeof(header.uuid)); | |
550 | CTF_TRACE_SET_FIELD(td, uuid); | |
551 | } else { | |
552 | if (uuid_compare(header.uuid, td->uuid)) | |
553 | return -EINVAL; | |
554 | } | |
555 | ||
255b2138 | 556 | toread = (header.content_size / CHAR_BIT) - header_sizeof(header); |
a0fe7d97 MD |
557 | |
558 | for (;;) { | |
f8254867 | 559 | readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in); |
b4c19c1e MD |
560 | if (ferror(in)) { |
561 | ret = -EINVAL; | |
562 | break; | |
563 | } | |
4152822b | 564 | if (babeltrace_debug) { |
f8254867 | 565 | buf[readlen] = '\0'; |
4152822b MD |
566 | fprintf(stdout, "[debug] metadata packet read: %s\n", |
567 | buf); | |
568 | } | |
569 | ||
b4c19c1e MD |
570 | writelen = fwrite(buf, sizeof(char), readlen, out); |
571 | if (writelen < readlen) { | |
572 | ret = -EIO; | |
573 | break; | |
574 | } | |
575 | if (ferror(out)) { | |
576 | ret = -EINVAL; | |
577 | break; | |
578 | } | |
a0fe7d97 MD |
579 | toread -= readlen; |
580 | if (!toread) { | |
7f4b5c4d | 581 | ret = 0; /* continue reading next packet */ |
ddbc52af | 582 | goto read_padding; |
a0fe7d97 | 583 | } |
b4c19c1e MD |
584 | } |
585 | return ret; | |
ddbc52af MD |
586 | |
587 | read_padding: | |
588 | toread = (header.packet_size - header.content_size) / CHAR_BIT; | |
589 | ret = fseek(in, toread, SEEK_CUR); | |
590 | if (ret < 0) { | |
591 | fprintf(stdout, "[warning] Missing padding at end of file\n"); | |
592 | ret = 0; | |
593 | } | |
594 | return ret; | |
b4c19c1e MD |
595 | } |
596 | ||
597 | static | |
598 | int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp, | |
599 | char **buf) | |
600 | { | |
601 | FILE *in, *out; | |
602 | size_t size; | |
603 | int ret; | |
604 | ||
605 | in = *fp; | |
c4f5487e MD |
606 | /* |
607 | * Using strlen on *buf instead of size of open_memstream | |
608 | * because its size includes garbage at the end (after final | |
609 | * \0). This is the allocated size, not the actual string size. | |
610 | */ | |
b4c19c1e MD |
611 | out = open_memstream(buf, &size); |
612 | if (out == NULL) | |
613 | return -errno; | |
614 | ||
615 | for (;;) { | |
616 | ret = ctf_open_trace_metadata_packet_read(td, in, out); | |
7f4b5c4d | 617 | if (ret) { |
b4c19c1e | 618 | break; |
7f4b5c4d MD |
619 | } |
620 | if (feof(in)) { | |
621 | ret = 0; | |
b4c19c1e MD |
622 | break; |
623 | } | |
624 | } | |
625 | fclose(out); /* flush the buffer */ | |
626 | fclose(in); | |
627 | /* open for reading */ | |
c4f5487e | 628 | *fp = fmemopen(*buf, strlen(*buf), "rb"); |
b4c19c1e MD |
629 | return 0; |
630 | } | |
631 | ||
65102a8c | 632 | static |
46322b33 | 633 | int ctf_open_trace_metadata_read(struct ctf_trace *td) |
65102a8c MD |
634 | { |
635 | struct ctf_scanner *scanner; | |
2d0bea29 | 636 | struct ctf_file_stream *metadata_stream; |
65102a8c | 637 | FILE *fp; |
b4c19c1e | 638 | char *buf = NULL; |
65102a8c MD |
639 | int ret = 0; |
640 | ||
2d0bea29 MD |
641 | metadata_stream = g_new0(struct ctf_file_stream, 1); |
642 | td->metadata = &metadata_stream->parent; | |
643 | metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY); | |
644 | if (metadata_stream->pos.fd < 0) { | |
65102a8c | 645 | fprintf(stdout, "Unable to open metadata.\n"); |
2d0bea29 | 646 | return metadata_stream->pos.fd; |
65102a8c MD |
647 | } |
648 | ||
649 | if (babeltrace_debug) | |
650 | yydebug = 1; | |
651 | ||
2d0bea29 | 652 | fp = fdopen(metadata_stream->pos.fd, "r"); |
65102a8c | 653 | if (!fp) { |
46322b33 | 654 | fprintf(stdout, "[error] Unable to open metadata stream.\n"); |
65102a8c MD |
655 | ret = -errno; |
656 | goto end_stream; | |
657 | } | |
658 | ||
b4c19c1e MD |
659 | if (packet_metadata(td, fp)) { |
660 | ret = ctf_open_trace_metadata_stream_read(td, &fp, &buf); | |
661 | if (ret) | |
662 | goto end_packet_read; | |
da75b0f7 | 663 | } else { |
5c262147 MD |
664 | unsigned int major, minor; |
665 | ssize_t nr_items; | |
8c2df3f5 | 666 | |
da75b0f7 | 667 | td->byte_order = BYTE_ORDER; |
8c2df3f5 | 668 | |
5c262147 MD |
669 | /* Check text-only metadata header and version */ |
670 | nr_items = fscanf(fp, "/* CTF %u.%u", &major, &minor); | |
671 | if (nr_items < 2) | |
672 | fprintf(stdout, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n"); | |
673 | if (check_version(major, minor) < 0) { | |
674 | ret = -EINVAL; | |
675 | goto end_packet_read; | |
676 | } | |
8c2df3f5 | 677 | rewind(fp); |
b4c19c1e MD |
678 | } |
679 | ||
65102a8c MD |
680 | scanner = ctf_scanner_alloc(fp); |
681 | if (!scanner) { | |
46322b33 | 682 | fprintf(stdout, "[error] Error allocating scanner\n"); |
65102a8c MD |
683 | ret = -ENOMEM; |
684 | goto end_scanner_alloc; | |
685 | } | |
686 | ret = ctf_scanner_append_ast(scanner); | |
687 | if (ret) { | |
46322b33 | 688 | fprintf(stdout, "[error] Error creating AST\n"); |
65102a8c MD |
689 | goto end; |
690 | } | |
691 | ||
692 | if (babeltrace_debug) { | |
693 | ret = ctf_visitor_print_xml(stdout, 0, &scanner->ast->root); | |
694 | if (ret) { | |
46322b33 | 695 | fprintf(stdout, "[error] Error visiting AST for XML output\n"); |
65102a8c MD |
696 | goto end; |
697 | } | |
698 | } | |
699 | ||
700 | ret = ctf_visitor_semantic_check(stdout, 0, &scanner->ast->root); | |
701 | if (ret) { | |
46322b33 | 702 | fprintf(stdout, "[error] Error in CTF semantic validation %d\n", ret); |
65102a8c MD |
703 | goto end; |
704 | } | |
705 | ret = ctf_visitor_construct_metadata(stdout, 0, &scanner->ast->root, | |
ac5c6ca0 | 706 | td, td->byte_order); |
65102a8c | 707 | if (ret) { |
46322b33 | 708 | fprintf(stdout, "[error] Error in CTF metadata constructor %d\n", ret); |
65102a8c MD |
709 | goto end; |
710 | } | |
711 | end: | |
712 | ctf_scanner_free(scanner); | |
713 | end_scanner_alloc: | |
b4c19c1e | 714 | end_packet_read: |
65102a8c | 715 | fclose(fp); |
b4c19c1e | 716 | free(buf); |
65102a8c | 717 | end_stream: |
2d0bea29 MD |
718 | close(metadata_stream->pos.fd); |
719 | if (ret) | |
720 | g_free(metadata_stream); | |
0f980a35 MD |
721 | return ret; |
722 | } | |
723 | ||
e28d4618 | 724 | static |
42dc00b7 MD |
725 | struct ctf_stream_event *create_event_definitions(struct ctf_trace *td, |
726 | struct ctf_stream *stream, | |
727 | struct ctf_event *event) | |
e28d4618 | 728 | { |
42dc00b7 | 729 | struct ctf_stream_event *stream_event = g_new0(struct ctf_stream_event, 1); |
e28d4618 MD |
730 | |
731 | if (event->context_decl) { | |
732 | struct definition *definition = | |
733 | event->context_decl->p.definition_new(&event->context_decl->p, | |
734 | stream->parent_def_scope, 0, 0, "event.context"); | |
735 | if (!definition) { | |
736 | goto error; | |
737 | } | |
42dc00b7 | 738 | stream_event->event_context = container_of(definition, |
e28d4618 | 739 | struct definition_struct, p); |
42dc00b7 | 740 | stream->parent_def_scope = stream_event->event_context->p.scope; |
e28d4618 MD |
741 | } |
742 | if (event->fields_decl) { | |
743 | struct definition *definition = | |
744 | event->fields_decl->p.definition_new(&event->fields_decl->p, | |
745 | stream->parent_def_scope, 0, 0, "event.fields"); | |
746 | if (!definition) { | |
747 | goto error; | |
748 | } | |
42dc00b7 | 749 | stream_event->event_fields = container_of(definition, |
e28d4618 | 750 | struct definition_struct, p); |
42dc00b7 | 751 | stream->parent_def_scope = stream_event->event_fields->p.scope; |
e28d4618 | 752 | } |
42dc00b7 | 753 | return stream_event; |
e28d4618 MD |
754 | |
755 | error: | |
42dc00b7 MD |
756 | if (stream_event->event_fields) |
757 | definition_unref(&stream_event->event_fields->p); | |
758 | if (stream_event->event_context) | |
759 | definition_unref(&stream_event->event_context->p); | |
e28d4618 MD |
760 | return NULL; |
761 | } | |
762 | ||
763 | static | |
764 | int create_stream_definitions(struct ctf_trace *td, struct ctf_stream *stream) | |
765 | { | |
766 | struct ctf_stream_class *stream_class; | |
767 | int ret; | |
768 | int i; | |
769 | ||
770 | if (stream->stream_definitions_created) | |
771 | return 0; | |
772 | ||
773 | stream_class = stream->stream_class; | |
774 | ||
775 | if (stream_class->packet_context_decl) { | |
776 | struct definition *definition = | |
777 | stream_class->packet_context_decl->p.definition_new(&stream_class->packet_context_decl->p, | |
778 | stream->parent_def_scope, 0, 0, "stream.packet.context"); | |
779 | if (!definition) { | |
780 | ret = -EINVAL; | |
781 | goto error; | |
782 | } | |
783 | stream->stream_packet_context = container_of(definition, | |
784 | struct definition_struct, p); | |
785 | stream->parent_def_scope = stream->stream_packet_context->p.scope; | |
786 | } | |
787 | if (stream_class->event_header_decl) { | |
788 | struct definition *definition = | |
789 | stream_class->event_header_decl->p.definition_new(&stream_class->event_header_decl->p, | |
790 | stream->parent_def_scope, 0, 0, "stream.event.header"); | |
791 | if (!definition) { | |
792 | ret = -EINVAL; | |
793 | goto error; | |
794 | } | |
795 | stream->stream_event_header = | |
796 | container_of(definition, struct definition_struct, p); | |
797 | stream->parent_def_scope = stream->stream_event_header->p.scope; | |
798 | } | |
799 | if (stream_class->event_context_decl) { | |
800 | struct definition *definition = | |
801 | stream_class->event_context_decl->p.definition_new(&stream_class->event_context_decl->p, | |
802 | stream->parent_def_scope, 0, 0, "stream.event.context"); | |
803 | if (!definition) { | |
804 | ret = -EINVAL; | |
805 | goto error; | |
806 | } | |
807 | stream->stream_event_context = | |
808 | container_of(definition, struct definition_struct, p); | |
809 | stream->parent_def_scope = stream->stream_event_context->p.scope; | |
810 | } | |
811 | stream->events_by_id = g_ptr_array_new(); | |
812 | g_ptr_array_set_size(stream->events_by_id, stream_class->events_by_id->len); | |
813 | for (i = 0; i < stream->events_by_id->len; i++) { | |
814 | struct ctf_event *event = g_ptr_array_index(stream_class->events_by_id, i); | |
42dc00b7 | 815 | struct ctf_stream_event *stream_event; |
e28d4618 MD |
816 | |
817 | if (!event) | |
818 | continue; | |
42dc00b7 MD |
819 | stream_event = create_event_definitions(td, stream, event); |
820 | if (!stream_event) | |
e28d4618 | 821 | goto error_event; |
42dc00b7 | 822 | g_ptr_array_index(stream->events_by_id, i) = stream_event; |
e28d4618 MD |
823 | } |
824 | return 0; | |
825 | ||
826 | error_event: | |
827 | for (i = 0; i < stream->events_by_id->len; i++) { | |
42dc00b7 MD |
828 | struct ctf_stream_event *stream_event = g_ptr_array_index(stream->events_by_id, i); |
829 | if (stream_event) | |
830 | g_free(stream_event); | |
e28d4618 MD |
831 | } |
832 | g_ptr_array_free(stream->events_by_id, TRUE); | |
833 | error: | |
834 | if (stream->stream_event_context) | |
835 | definition_unref(&stream->stream_event_context->p); | |
836 | if (stream->stream_event_header) | |
837 | definition_unref(&stream->stream_event_header->p); | |
838 | if (stream->stream_packet_context) | |
839 | definition_unref(&stream->stream_packet_context->p); | |
840 | return ret; | |
841 | } | |
842 | ||
0f980a35 MD |
843 | |
844 | static | |
46322b33 | 845 | int create_stream_packet_index(struct ctf_trace *td, |
0f980a35 MD |
846 | struct ctf_file_stream *file_stream) |
847 | { | |
aa6bffae | 848 | struct ctf_stream_class *stream; |
0f980a35 | 849 | int len_index; |
46322b33 | 850 | struct ctf_stream_pos *pos; |
0f980a35 MD |
851 | struct stat filestats; |
852 | struct packet_index packet_index; | |
853 | int first_packet = 1; | |
854 | int ret; | |
855 | ||
856 | pos = &file_stream->pos; | |
857 | ||
858 | ret = fstat(pos->fd, &filestats); | |
859 | if (ret < 0) | |
860 | return ret; | |
861 | ||
8895362d MD |
862 | if (filestats.st_size < MAX_PACKET_HEADER_LEN / CHAR_BIT) |
863 | return -EINVAL; | |
864 | ||
0f980a35 MD |
865 | for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) { |
866 | uint64_t stream_id = 0; | |
867 | ||
868 | if (pos->base) { | |
869 | /* unmap old base */ | |
8c572eba | 870 | ret = munmap(pos->base, pos->packet_size / CHAR_BIT); |
0f980a35 | 871 | if (ret) { |
46322b33 | 872 | fprintf(stdout, "[error] Unable to unmap old base: %s.\n", |
0f980a35 MD |
873 | strerror(errno)); |
874 | return ret; | |
875 | } | |
8c572eba | 876 | pos->base = NULL; |
0f980a35 MD |
877 | } |
878 | /* map new base. Need mapping length from header. */ | |
8c572eba | 879 | pos->base = mmap(NULL, MAX_PACKET_HEADER_LEN / CHAR_BIT, PROT_READ, |
0f980a35 | 880 | MAP_PRIVATE, pos->fd, pos->mmap_offset); |
dc48ecad MD |
881 | pos->content_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */ |
882 | pos->packet_size = MAX_PACKET_HEADER_LEN; /* Unknown at this point */ | |
0f980a35 MD |
883 | pos->offset = 0; /* Position of the packet header */ |
884 | ||
8c572eba MD |
885 | packet_index.offset = pos->mmap_offset; |
886 | packet_index.content_size = 0; | |
887 | packet_index.packet_size = 0; | |
75cc2c35 MD |
888 | packet_index.timestamp_begin = 0; |
889 | packet_index.timestamp_end = 0; | |
8c572eba | 890 | |
0f980a35 | 891 | /* read and check header, set stream id (and check) */ |
2d0bea29 | 892 | if (file_stream->parent.trace_packet_header) { |
0f980a35 | 893 | /* Read packet header */ |
2d0bea29 | 894 | ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p); |
c5e74408 MD |
895 | if (ret) |
896 | return ret; | |
2d0bea29 | 897 | len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic")); |
0f980a35 MD |
898 | if (len_index >= 0) { |
899 | struct definition_integer *defint; | |
b1a2f580 | 900 | struct definition *field; |
0f980a35 | 901 | |
2d0bea29 | 902 | field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); |
b1a2f580 MD |
903 | assert(field->declaration->id == CTF_TYPE_INTEGER); |
904 | defint = container_of(field, struct definition_integer, p); | |
0f980a35 MD |
905 | assert(defint->declaration->signedness == FALSE); |
906 | if (defint->value._unsigned != CTF_MAGIC) { | |
d8ea2d29 | 907 | fprintf(stdout, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n", |
8c572eba MD |
908 | defint->value._unsigned, |
909 | file_stream->pos.packet_index->len, | |
910 | (ssize_t) pos->mmap_offset); | |
0f980a35 MD |
911 | return -EINVAL; |
912 | } | |
913 | } | |
914 | ||
915 | /* check uuid */ | |
2d0bea29 | 916 | len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid")); |
0f980a35 MD |
917 | if (len_index >= 0) { |
918 | struct definition_array *defarray; | |
b1a2f580 | 919 | struct definition *field; |
0f980a35 MD |
920 | uint64_t i; |
921 | uint8_t uuidval[UUID_LEN]; | |
922 | ||
2d0bea29 | 923 | field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); |
b1a2f580 MD |
924 | assert(field->declaration->id == CTF_TYPE_ARRAY); |
925 | defarray = container_of(field, struct definition_array, p); | |
3838df27 | 926 | assert(array_len(defarray) == UUID_LEN); |
0f980a35 MD |
927 | assert(defarray->declaration->elem->id == CTF_TYPE_INTEGER); |
928 | ||
929 | for (i = 0; i < UUID_LEN; i++) { | |
930 | struct definition *elem; | |
931 | struct definition_integer *defint; | |
932 | ||
933 | elem = array_index(defarray, i); | |
934 | assert(elem); | |
935 | defint = container_of(elem, struct definition_integer, p); | |
936 | uuidval[i] = defint->value._unsigned; | |
937 | } | |
46322b33 | 938 | ret = uuid_compare(td->uuid, uuidval); |
0f980a35 MD |
939 | if (ret) { |
940 | fprintf(stdout, "[error] Unique Universal Identifiers do not match.\n"); | |
941 | return -EINVAL; | |
942 | } | |
943 | } | |
944 | ||
945 | ||
2d0bea29 | 946 | len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id")); |
0f980a35 MD |
947 | if (len_index >= 0) { |
948 | struct definition_integer *defint; | |
b1a2f580 | 949 | struct definition *field; |
0f980a35 | 950 | |
2d0bea29 | 951 | field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); |
b1a2f580 MD |
952 | assert(field->declaration->id == CTF_TYPE_INTEGER); |
953 | defint = container_of(field, struct definition_integer, p); | |
0f980a35 MD |
954 | assert(defint->declaration->signedness == FALSE); |
955 | stream_id = defint->value._unsigned; | |
956 | } | |
957 | } | |
958 | ||
2d0bea29 | 959 | if (!first_packet && file_stream->parent.stream_id != stream_id) { |
0f980a35 MD |
960 | fprintf(stdout, "[error] Stream ID is changing within a stream.\n"); |
961 | return -EINVAL; | |
962 | } | |
963 | if (first_packet) { | |
2d0bea29 | 964 | file_stream->parent.stream_id = stream_id; |
46322b33 | 965 | if (stream_id >= td->streams->len) { |
0f980a35 MD |
966 | fprintf(stdout, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); |
967 | return -EINVAL; | |
968 | } | |
46322b33 | 969 | stream = g_ptr_array_index(td->streams, stream_id); |
0f980a35 MD |
970 | if (!stream) { |
971 | fprintf(stdout, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); | |
972 | return -EINVAL; | |
973 | } | |
2d0bea29 | 974 | file_stream->parent.stream_class = stream; |
01c76b24 | 975 | ret = create_stream_definitions(td, &file_stream->parent); |
862434ec MD |
976 | if (ret) |
977 | return ret; | |
0f980a35 MD |
978 | } |
979 | first_packet = 0; | |
980 | ||
2d0bea29 | 981 | if (file_stream->parent.stream_packet_context) { |
dc48ecad | 982 | /* Read packet context */ |
2d0bea29 | 983 | ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p); |
c5e74408 MD |
984 | if (ret) |
985 | return ret; | |
dc48ecad | 986 | /* read content size from header */ |
2d0bea29 | 987 | len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size")); |
dc48ecad MD |
988 | if (len_index >= 0) { |
989 | struct definition_integer *defint; | |
b1a2f580 | 990 | struct definition *field; |
dc48ecad | 991 | |
2d0bea29 | 992 | field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); |
b1a2f580 MD |
993 | assert(field->declaration->id == CTF_TYPE_INTEGER); |
994 | defint = container_of(field, struct definition_integer, p); | |
dc48ecad | 995 | assert(defint->declaration->signedness == FALSE); |
8c572eba | 996 | packet_index.content_size = defint->value._unsigned; |
dc48ecad MD |
997 | } else { |
998 | /* Use file size for packet size */ | |
8c572eba | 999 | packet_index.content_size = filestats.st_size * CHAR_BIT; |
dc48ecad MD |
1000 | } |
1001 | ||
1002 | /* read packet size from header */ | |
2d0bea29 | 1003 | len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size")); |
dc48ecad MD |
1004 | if (len_index >= 0) { |
1005 | struct definition_integer *defint; | |
b1a2f580 | 1006 | struct definition *field; |
dc48ecad | 1007 | |
2d0bea29 | 1008 | field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); |
b1a2f580 MD |
1009 | assert(field->declaration->id == CTF_TYPE_INTEGER); |
1010 | defint = container_of(field, struct definition_integer, p); | |
dc48ecad | 1011 | assert(defint->declaration->signedness == FALSE); |
8c572eba | 1012 | packet_index.packet_size = defint->value._unsigned; |
dc48ecad MD |
1013 | } else { |
1014 | /* Use content size if non-zero, else file size */ | |
8c572eba | 1015 | packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT; |
dc48ecad | 1016 | } |
75cc2c35 MD |
1017 | |
1018 | /* read timestamp begin from header */ | |
2d0bea29 | 1019 | len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin")); |
75cc2c35 MD |
1020 | if (len_index >= 0) { |
1021 | struct definition_integer *defint; | |
1022 | struct definition *field; | |
1023 | ||
2d0bea29 | 1024 | field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); |
75cc2c35 MD |
1025 | assert(field->declaration->id == CTF_TYPE_INTEGER); |
1026 | defint = container_of(field, struct definition_integer, p); | |
1027 | assert(defint->declaration->signedness == FALSE); | |
1028 | packet_index.timestamp_begin = defint->value._unsigned; | |
1029 | } | |
1030 | ||
1031 | /* read timestamp end from header */ | |
2d0bea29 | 1032 | len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end")); |
75cc2c35 MD |
1033 | if (len_index >= 0) { |
1034 | struct definition_integer *defint; | |
1035 | struct definition *field; | |
1036 | ||
2d0bea29 | 1037 | field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); |
75cc2c35 MD |
1038 | assert(field->declaration->id == CTF_TYPE_INTEGER); |
1039 | defint = container_of(field, struct definition_integer, p); | |
1040 | assert(defint->declaration->signedness == FALSE); | |
1041 | packet_index.timestamp_end = defint->value._unsigned; | |
1042 | } | |
0f980a35 MD |
1043 | } else { |
1044 | /* Use file size for packet size */ | |
8c572eba | 1045 | packet_index.content_size = filestats.st_size * CHAR_BIT; |
0f980a35 | 1046 | /* Use content size if non-zero, else file size */ |
8c572eba | 1047 | packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT; |
0f980a35 | 1048 | } |
546293fa MD |
1049 | |
1050 | /* Validate content size and packet size values */ | |
1051 | if (packet_index.content_size > packet_index.packet_size) { | |
1052 | fprintf(stdout, "[error] Content size (%zu bits) is larger than packet size (%zu bits).\n", | |
1053 | packet_index.content_size, packet_index.packet_size); | |
1054 | return -EINVAL; | |
1055 | } | |
1056 | ||
58b0b883 MD |
1057 | if (packet_index.packet_size > (filestats.st_size - packet_index.offset) * CHAR_BIT) { |
1058 | fprintf(stdout, "[error] Packet size (%zu bits) is larger than remaining file size (%zu bits).\n", | |
5aebb2ee | 1059 | packet_index.content_size, (size_t) (filestats.st_size - packet_index.offset) * CHAR_BIT); |
546293fa MD |
1060 | return -EINVAL; |
1061 | } | |
1062 | ||
847bf71a MD |
1063 | /* Save position after header and context */ |
1064 | packet_index.data_offset = pos->offset; | |
0f980a35 | 1065 | |
0f980a35 MD |
1066 | /* add index to packet array */ |
1067 | g_array_append_val(file_stream->pos.packet_index, packet_index); | |
1068 | ||
8c572eba | 1069 | pos->mmap_offset += packet_index.packet_size / CHAR_BIT; |
0f980a35 MD |
1070 | } |
1071 | ||
847bf71a MD |
1072 | /* Move pos back to beginning of file */ |
1073 | ctf_move_pos_slow(pos, 0, SEEK_SET); /* position for write */ | |
1074 | ||
0f980a35 MD |
1075 | return 0; |
1076 | } | |
1077 | ||
e28d4618 MD |
1078 | static |
1079 | int create_trace_definitions(struct ctf_trace *td, struct ctf_stream *stream) | |
1080 | { | |
1081 | int ret; | |
1082 | ||
1083 | if (td->packet_header_decl) { | |
1084 | struct definition *definition = | |
1085 | td->packet_header_decl->p.definition_new(&td->packet_header_decl->p, | |
1086 | stream->parent_def_scope, 0, 0, "trace.packet.header"); | |
1087 | if (!definition) { | |
1088 | ret = -EINVAL; | |
1089 | goto error; | |
1090 | } | |
1091 | stream->trace_packet_header = | |
1092 | container_of(definition, struct definition_struct, p); | |
1093 | stream->parent_def_scope = stream->trace_packet_header->p.scope; | |
1094 | } | |
1095 | ||
1096 | return 0; | |
1097 | ||
1098 | error: | |
1099 | return ret; | |
1100 | } | |
1101 | ||
0f980a35 MD |
1102 | /* |
1103 | * Note: many file streams can inherit from the same stream class | |
1104 | * description (metadata). | |
1105 | */ | |
1106 | static | |
46322b33 | 1107 | int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags) |
0f980a35 MD |
1108 | { |
1109 | int ret; | |
1110 | struct ctf_file_stream *file_stream; | |
1111 | ||
46322b33 | 1112 | ret = openat(td->dirfd, path, flags); |
0f980a35 MD |
1113 | if (ret < 0) |
1114 | goto error; | |
1115 | file_stream = g_new0(struct ctf_file_stream, 1); | |
8563e754 | 1116 | ctf_init_pos(&file_stream->pos, ret, flags); |
2d0bea29 | 1117 | ret = create_trace_definitions(td, &file_stream->parent); |
e28d4618 MD |
1118 | if (ret) |
1119 | goto error_def; | |
0f980a35 MD |
1120 | ret = create_stream_packet_index(td, file_stream); |
1121 | if (ret) | |
1122 | goto error_index; | |
1123 | /* Add stream file to stream class */ | |
2d0bea29 MD |
1124 | g_ptr_array_add(file_stream->parent.stream_class->streams, |
1125 | &file_stream->parent); | |
0f980a35 MD |
1126 | return 0; |
1127 | ||
1128 | error_index: | |
2d0bea29 MD |
1129 | if (file_stream->parent.trace_packet_header) |
1130 | definition_unref(&file_stream->parent.trace_packet_header->p); | |
e28d4618 | 1131 | error_def: |
46322b33 | 1132 | ctf_fini_pos(&file_stream->pos); |
0f980a35 MD |
1133 | close(file_stream->pos.fd); |
1134 | g_free(file_stream); | |
1135 | error: | |
65102a8c MD |
1136 | return ret; |
1137 | } | |
1138 | ||
bbefb8dd | 1139 | static |
46322b33 | 1140 | int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags) |
bbefb8dd MD |
1141 | { |
1142 | int ret; | |
65102a8c MD |
1143 | struct dirent *dirent; |
1144 | struct dirent *diriter; | |
1145 | size_t dirent_len; | |
bbefb8dd | 1146 | |
46322b33 | 1147 | td->flags = flags; |
bbefb8dd MD |
1148 | |
1149 | /* Open trace directory */ | |
46322b33 MD |
1150 | td->dir = opendir(path); |
1151 | if (!td->dir) { | |
dc48ecad | 1152 | fprintf(stdout, "[error] Unable to open trace directory.\n"); |
bbefb8dd MD |
1153 | ret = -ENOENT; |
1154 | goto error; | |
1155 | } | |
1156 | ||
46322b33 MD |
1157 | td->dirfd = open(path, 0); |
1158 | if (td->dirfd < 0) { | |
dc48ecad | 1159 | fprintf(stdout, "[error] Unable to open trace directory file descriptor.\n"); |
65102a8c MD |
1160 | ret = -ENOENT; |
1161 | goto error_dirfd; | |
1162 | } | |
0f980a35 | 1163 | |
65102a8c MD |
1164 | /* |
1165 | * Keep the metadata file separate. | |
1166 | */ | |
bbefb8dd | 1167 | |
65102a8c MD |
1168 | ret = ctf_open_trace_metadata_read(td); |
1169 | if (ret) { | |
1170 | goto error_metadata; | |
1171 | } | |
bbefb8dd MD |
1172 | |
1173 | /* | |
1174 | * Open each stream: for each file, try to open, check magic | |
1175 | * number, and get the stream ID to add to the right location in | |
1176 | * the stream array. | |
bbefb8dd MD |
1177 | */ |
1178 | ||
65102a8c | 1179 | dirent_len = offsetof(struct dirent, d_name) + |
46322b33 | 1180 | fpathconf(td->dirfd, _PC_NAME_MAX) + 1; |
bbefb8dd | 1181 | |
65102a8c | 1182 | dirent = malloc(dirent_len); |
bbefb8dd | 1183 | |
65102a8c | 1184 | for (;;) { |
46322b33 | 1185 | ret = readdir_r(td->dir, dirent, &diriter); |
65102a8c | 1186 | if (ret) { |
dc48ecad | 1187 | fprintf(stdout, "[error] Readdir error.\n"); |
65102a8c | 1188 | goto readdir_error; |
65102a8c MD |
1189 | } |
1190 | if (!diriter) | |
1191 | break; | |
d8ea2d29 MD |
1192 | /* Ignore hidden files, ., .. and metadata. */ |
1193 | if (!strncmp(diriter->d_name, ".", 1) | |
65102a8c MD |
1194 | || !strcmp(diriter->d_name, "..") |
1195 | || !strcmp(diriter->d_name, "metadata")) | |
1196 | continue; | |
dc48ecad MD |
1197 | ret = ctf_open_file_stream_read(td, diriter->d_name, flags); |
1198 | if (ret) { | |
1199 | fprintf(stdout, "[error] Open file stream error.\n"); | |
1200 | goto readdir_error; | |
1201 | } | |
65102a8c | 1202 | } |
bbefb8dd | 1203 | |
65102a8c | 1204 | free(dirent); |
bbefb8dd | 1205 | return 0; |
65102a8c MD |
1206 | |
1207 | readdir_error: | |
1208 | free(dirent); | |
1209 | error_metadata: | |
46322b33 | 1210 | close(td->dirfd); |
65102a8c | 1211 | error_dirfd: |
46322b33 | 1212 | closedir(td->dir); |
bbefb8dd MD |
1213 | error: |
1214 | return ret; | |
1215 | } | |
1216 | ||
e9378815 | 1217 | static |
bbefb8dd MD |
1218 | struct trace_descriptor *ctf_open_trace(const char *path, int flags) |
1219 | { | |
46322b33 | 1220 | struct ctf_trace *td; |
bbefb8dd MD |
1221 | int ret; |
1222 | ||
46322b33 | 1223 | td = g_new0(struct ctf_trace, 1); |
bbefb8dd | 1224 | |
8c572eba | 1225 | switch (flags & O_ACCMODE) { |
bbefb8dd | 1226 | case O_RDONLY: |
b61922b5 MD |
1227 | if (!path) { |
1228 | fprintf(stdout, "[error] Path missing for input CTF trace.\n"); | |
1229 | goto error; | |
1230 | } | |
bbefb8dd MD |
1231 | ret = ctf_open_trace_read(td, path, flags); |
1232 | if (ret) | |
1233 | goto error; | |
1234 | break; | |
989c73bc | 1235 | case O_RDWR: |
46322b33 MD |
1236 | fprintf(stdout, "[error] Opening CTF traces for output is not supported yet.\n"); |
1237 | goto error; | |
bbefb8dd | 1238 | default: |
46322b33 | 1239 | fprintf(stdout, "[error] Incorrect open flags.\n"); |
bbefb8dd MD |
1240 | goto error; |
1241 | } | |
1242 | ||
46322b33 | 1243 | return &td->parent; |
bbefb8dd MD |
1244 | error: |
1245 | g_free(td); | |
1246 | return NULL; | |
1247 | } | |
1248 | ||
0f980a35 MD |
1249 | static |
1250 | void ctf_close_file_stream(struct ctf_file_stream *file_stream) | |
1251 | { | |
46322b33 | 1252 | ctf_fini_pos(&file_stream->pos); |
0f980a35 MD |
1253 | close(file_stream->pos.fd); |
1254 | } | |
1255 | ||
e9378815 | 1256 | static |
46322b33 | 1257 | void ctf_close_trace(struct trace_descriptor *tdp) |
bbefb8dd | 1258 | { |
46322b33 | 1259 | struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent); |
0f980a35 MD |
1260 | int i; |
1261 | ||
46322b33 MD |
1262 | if (td->streams) { |
1263 | for (i = 0; i < td->streams->len; i++) { | |
aa6bffae | 1264 | struct ctf_stream_class *stream; |
0f980a35 | 1265 | int j; |
e9378815 | 1266 | |
46322b33 | 1267 | stream = g_ptr_array_index(td->streams, i); |
e9378815 MD |
1268 | if (!stream) |
1269 | continue; | |
2d0bea29 | 1270 | for (j = 0; j < stream->streams->len; j++) { |
0f980a35 | 1271 | struct ctf_file_stream *file_stream; |
2d0bea29 | 1272 | file_stream = container_of(g_ptr_array_index(stream->streams, j), struct ctf_file_stream, parent); |
0f980a35 MD |
1273 | ctf_close_file_stream(file_stream); |
1274 | } | |
1275 | ||
1276 | } | |
46322b33 | 1277 | g_ptr_array_free(td->streams, TRUE); |
0f980a35 | 1278 | } |
46322b33 | 1279 | closedir(td->dir); |
bbefb8dd MD |
1280 | g_free(td); |
1281 | } | |
1282 | ||
7fb21036 | 1283 | void __attribute__((constructor)) ctf_init(void) |
fc93b2bd MD |
1284 | { |
1285 | int ret; | |
1286 | ||
4c8bfb7e | 1287 | ctf_format.name = g_quark_from_static_string("ctf"); |
fc93b2bd MD |
1288 | ret = bt_register_format(&ctf_format); |
1289 | assert(!ret); | |
1290 | } | |
698f0fe4 MD |
1291 | |
1292 | /* TODO: finalize */ |