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. | |
c462e188 MD |
19 | * |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
fc93b2bd MD |
27 | */ |
28 | ||
29 | #include <babeltrace/format.h> | |
837b0013 | 30 | #include <babeltrace/format-internal.h> |
fc93b2bd | 31 | #include <babeltrace/ctf/types.h> |
bbefb8dd | 32 | #include <babeltrace/ctf/metadata.h> |
70bd0a12 | 33 | #include <babeltrace/babeltrace-internal.h> |
e4195791 | 34 | #include <babeltrace/ctf/events-internal.h> |
98a04903 JD |
35 | #include <babeltrace/trace-handle-internal.h> |
36 | #include <babeltrace/context-internal.h> | |
4cb26dfb | 37 | #include <babeltrace/compat/uuid.h> |
43e34335 | 38 | #include <babeltrace/endian.h> |
7b563a77 | 39 | #include <babeltrace/error.h> |
eb75a494 | 40 | #include <babeltrace/trace-debug-info.h> |
0ace7505 | 41 | #include <babeltrace/ctf/ctf-index.h> |
0f980a35 | 42 | #include <inttypes.h> |
b4c19c1e | 43 | #include <stdio.h> |
0f980a35 | 44 | #include <sys/mman.h> |
bbefb8dd | 45 | #include <errno.h> |
bbefb8dd | 46 | #include <sys/types.h> |
65102a8c | 47 | #include <sys/stat.h> |
bbefb8dd | 48 | #include <fcntl.h> |
65102a8c | 49 | #include <dirent.h> |
bbefb8dd | 50 | #include <glib.h> |
65102a8c MD |
51 | #include <unistd.h> |
52 | #include <stdlib.h> | |
53 | ||
65102a8c MD |
54 | #include "metadata/ctf-scanner.h" |
55 | #include "metadata/ctf-parser.h" | |
56 | #include "metadata/ctf-ast.h" | |
c34ea0fa | 57 | #include "events-private.h" |
68ef7952 | 58 | #include <babeltrace/compat/memstream.h> |
edcad9c1 | 59 | #include <babeltrace/compat/fcntl.h> |
65102a8c | 60 | |
ec323464 MD |
61 | #define LOG2_CHAR_BIT 3 |
62 | ||
63 | /* | |
64 | * Length of first attempt at mapping a packet header, in bits. | |
65 | */ | |
66 | #define DEFAULT_HEADER_LEN (getpagesize() * CHAR_BIT) | |
67 | ||
0f980a35 | 68 | /* |
ec323464 | 69 | * Lenght of packet to write, in bits. |
0f980a35 | 70 | */ |
8c572eba | 71 | #define WRITE_PACKET_LEN (getpagesize() * 8 * CHAR_BIT) |
0f980a35 | 72 | |
7d97fad9 MD |
73 | #define NSEC_PER_SEC 1000000000ULL |
74 | ||
0ace7505 JD |
75 | #define INDEX_PATH "./index/%s.idx" |
76 | ||
03798a93 | 77 | int opt_clock_cycles, |
7d97fad9 MD |
78 | opt_clock_seconds, |
79 | opt_clock_date, | |
80 | opt_clock_gmt; | |
81 | ||
82 | uint64_t opt_clock_offset; | |
65923160 | 83 | uint64_t opt_clock_offset_ns; |
7d97fad9 | 84 | |
65102a8c | 85 | extern int yydebug; |
3be1e3c9 | 86 | char *opt_debug_info_dir; |
b7b61ced | 87 | char *opt_debug_info_target_prefix; |
bbefb8dd | 88 | |
2654fe9b MD |
89 | /* |
90 | * TODO: babeltrace_ctf_console_output ensures that we only print | |
91 | * discarded events when ctf-text plugin is used. Should be cleaned up | |
92 | * with the plugin system redesign. | |
93 | */ | |
94 | int babeltrace_ctf_console_output; | |
95 | ||
e9378815 | 96 | static |
1b8455b7 | 97 | struct bt_trace_descriptor *ctf_open_trace(const char *path, int flags, |
1cf393f6 | 98 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, |
20d0dcf9 MD |
99 | int whence), |
100 | FILE *metadata_fp); | |
e9378815 | 101 | static |
1b8455b7 | 102 | struct bt_trace_descriptor *ctf_open_mmap_trace( |
c150f912 | 103 | struct bt_mmap_stream_list *mmap_list, |
1cf393f6 | 104 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, |
20d0dcf9 | 105 | int whence), |
f571dfb1 | 106 | FILE *metadata_fp); |
98a04903 | 107 | static |
1b8455b7 | 108 | void ctf_set_context(struct bt_trace_descriptor *descriptor, |
98a04903 JD |
109 | struct bt_context *ctx); |
110 | static | |
1b8455b7 | 111 | void ctf_set_handle(struct bt_trace_descriptor *descriptor, |
98a04903 | 112 | struct bt_trace_handle *handle); |
f571dfb1 JD |
113 | |
114 | static | |
1b8455b7 | 115 | int ctf_close_trace(struct bt_trace_descriptor *descriptor); |
30c276af | 116 | static |
1b8455b7 | 117 | uint64_t ctf_timestamp_begin(struct bt_trace_descriptor *descriptor, |
03798a93 | 118 | struct bt_trace_handle *handle, enum bt_clock_type type); |
30c276af | 119 | static |
1b8455b7 | 120 | uint64_t ctf_timestamp_end(struct bt_trace_descriptor *descriptor, |
03798a93 JD |
121 | struct bt_trace_handle *handle, enum bt_clock_type type); |
122 | static | |
1b8455b7 | 123 | int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp); |
fc93b2bd | 124 | |
1ae19169 MD |
125 | static |
126 | rw_dispatch read_dispatch_table[] = { | |
d11e9c49 MD |
127 | [ CTF_TYPE_INTEGER ] = ctf_integer_read, |
128 | [ CTF_TYPE_FLOAT ] = ctf_float_read, | |
129 | [ CTF_TYPE_ENUM ] = ctf_enum_read, | |
130 | [ CTF_TYPE_STRING ] = ctf_string_read, | |
131 | [ CTF_TYPE_STRUCT ] = ctf_struct_rw, | |
132 | [ CTF_TYPE_VARIANT ] = ctf_variant_rw, | |
81dee1bb MD |
133 | [ CTF_TYPE_ARRAY ] = ctf_array_read, |
134 | [ CTF_TYPE_SEQUENCE ] = ctf_sequence_read, | |
d11e9c49 MD |
135 | }; |
136 | ||
1ae19169 MD |
137 | static |
138 | rw_dispatch write_dispatch_table[] = { | |
d11e9c49 MD |
139 | [ CTF_TYPE_INTEGER ] = ctf_integer_write, |
140 | [ CTF_TYPE_FLOAT ] = ctf_float_write, | |
141 | [ CTF_TYPE_ENUM ] = ctf_enum_write, | |
142 | [ CTF_TYPE_STRING ] = ctf_string_write, | |
143 | [ CTF_TYPE_STRUCT ] = ctf_struct_rw, | |
144 | [ CTF_TYPE_VARIANT ] = ctf_variant_rw, | |
81dee1bb MD |
145 | [ CTF_TYPE_ARRAY ] = ctf_array_write, |
146 | [ CTF_TYPE_SEQUENCE ] = ctf_sequence_write, | |
d11e9c49 MD |
147 | }; |
148 | ||
1ae19169 | 149 | static |
37b99bdb | 150 | struct bt_format ctf_format = { |
bbefb8dd | 151 | .open_trace = ctf_open_trace, |
f571dfb1 | 152 | .open_mmap_trace = ctf_open_mmap_trace, |
bbefb8dd | 153 | .close_trace = ctf_close_trace, |
98a04903 JD |
154 | .set_context = ctf_set_context, |
155 | .set_handle = ctf_set_handle, | |
30c276af JD |
156 | .timestamp_begin = ctf_timestamp_begin, |
157 | .timestamp_end = ctf_timestamp_end, | |
03798a93 | 158 | .convert_index_timestamp = ctf_convert_index_timestamp, |
fc93b2bd MD |
159 | }; |
160 | ||
c13e6f6d JG |
161 | void bt_ctf_hook(void) |
162 | { | |
163 | /* | |
164 | * Dummy function to prevent the linker from discarding this format as | |
165 | * "unused" in static builds. | |
166 | */ | |
167 | } | |
168 | ||
30c276af | 169 | static |
1b8455b7 | 170 | uint64_t ctf_timestamp_begin(struct bt_trace_descriptor *descriptor, |
03798a93 | 171 | struct bt_trace_handle *handle, enum bt_clock_type type) |
30c276af JD |
172 | { |
173 | struct ctf_trace *tin; | |
174 | uint64_t begin = ULLONG_MAX; | |
175 | int i, j; | |
176 | ||
177 | tin = container_of(descriptor, struct ctf_trace, parent); | |
178 | ||
179 | if (!tin) | |
180 | goto error; | |
181 | ||
182 | /* for each stream_class */ | |
183 | for (i = 0; i < tin->streams->len; i++) { | |
184 | struct ctf_stream_declaration *stream_class; | |
185 | ||
186 | stream_class = g_ptr_array_index(tin->streams, i); | |
1b01ffc2 MD |
187 | if (!stream_class) |
188 | continue; | |
30c276af JD |
189 | /* for each file_stream */ |
190 | for (j = 0; j < stream_class->streams->len; j++) { | |
191 | struct ctf_stream_definition *stream; | |
192 | struct ctf_file_stream *cfs; | |
193 | struct ctf_stream_pos *stream_pos; | |
194 | struct packet_index *index; | |
195 | ||
196 | stream = g_ptr_array_index(stream_class->streams, j); | |
197 | cfs = container_of(stream, struct ctf_file_stream, | |
198 | parent); | |
199 | stream_pos = &cfs->pos; | |
200 | ||
992e8cc0 | 201 | if (!stream_pos->packet_index) |
03798a93 JD |
202 | goto error; |
203 | ||
992e8cc0 | 204 | if (stream_pos->packet_index->len <= 0) |
afe9cd4a JD |
205 | continue; |
206 | ||
992e8cc0 MD |
207 | index = &g_array_index(stream_pos->packet_index, |
208 | struct packet_index, | |
209 | stream_pos->packet_index->len - 1); | |
03798a93 | 210 | if (type == BT_CLOCK_REAL) { |
992e8cc0 MD |
211 | if (index->ts_real.timestamp_begin < begin) |
212 | begin = index->ts_real.timestamp_begin; | |
03798a93 | 213 | } else if (type == BT_CLOCK_CYCLES) { |
992e8cc0 MD |
214 | if (index->ts_cycles.timestamp_begin < begin) |
215 | begin = index->ts_cycles.timestamp_begin; | |
03798a93 JD |
216 | } else { |
217 | goto error; | |
218 | } | |
30c276af JD |
219 | } |
220 | } | |
221 | ||
222 | return begin; | |
223 | ||
224 | error: | |
225 | return -1ULL; | |
226 | } | |
227 | ||
228 | static | |
1b8455b7 | 229 | uint64_t ctf_timestamp_end(struct bt_trace_descriptor *descriptor, |
03798a93 | 230 | struct bt_trace_handle *handle, enum bt_clock_type type) |
30c276af JD |
231 | { |
232 | struct ctf_trace *tin; | |
233 | uint64_t end = 0; | |
234 | int i, j; | |
235 | ||
236 | tin = container_of(descriptor, struct ctf_trace, parent); | |
237 | ||
238 | if (!tin) | |
239 | goto error; | |
240 | ||
241 | /* for each stream_class */ | |
242 | for (i = 0; i < tin->streams->len; i++) { | |
243 | struct ctf_stream_declaration *stream_class; | |
244 | ||
245 | stream_class = g_ptr_array_index(tin->streams, i); | |
1b01ffc2 MD |
246 | if (!stream_class) |
247 | continue; | |
30c276af JD |
248 | /* for each file_stream */ |
249 | for (j = 0; j < stream_class->streams->len; j++) { | |
250 | struct ctf_stream_definition *stream; | |
251 | struct ctf_file_stream *cfs; | |
252 | struct ctf_stream_pos *stream_pos; | |
253 | struct packet_index *index; | |
254 | ||
255 | stream = g_ptr_array_index(stream_class->streams, j); | |
256 | cfs = container_of(stream, struct ctf_file_stream, | |
257 | parent); | |
258 | stream_pos = &cfs->pos; | |
259 | ||
992e8cc0 | 260 | if (!stream_pos->packet_index) |
03798a93 JD |
261 | goto error; |
262 | ||
992e8cc0 | 263 | if (stream_pos->packet_index->len <= 0) |
afe9cd4a JD |
264 | continue; |
265 | ||
992e8cc0 MD |
266 | index = &g_array_index(stream_pos->packet_index, |
267 | struct packet_index, | |
268 | stream_pos->packet_index->len - 1); | |
03798a93 | 269 | if (type == BT_CLOCK_REAL) { |
992e8cc0 MD |
270 | if (index->ts_real.timestamp_end > end) |
271 | end = index->ts_real.timestamp_end; | |
03798a93 | 272 | } else if (type == BT_CLOCK_CYCLES) { |
992e8cc0 MD |
273 | if (index->ts_cycles.timestamp_end > end) |
274 | end = index->ts_cycles.timestamp_end; | |
03798a93 JD |
275 | } else { |
276 | goto error; | |
277 | } | |
30c276af JD |
278 | } |
279 | } | |
280 | ||
281 | return end; | |
282 | ||
283 | error: | |
284 | return -1ULL; | |
285 | } | |
286 | ||
25ccc85b | 287 | /* |
03798a93 | 288 | * Update stream current timestamp |
25ccc85b | 289 | */ |
2b9a764d | 290 | static |
9e88d150 | 291 | void ctf_update_timestamp(struct ctf_stream_definition *stream, |
2b9a764d MD |
292 | struct definition_integer *integer_definition) |
293 | { | |
294 | struct declaration_integer *integer_declaration = | |
295 | integer_definition->declaration; | |
296 | uint64_t oldval, newval, updateval; | |
297 | ||
7f3f572b | 298 | if (unlikely(integer_declaration->len == 64)) { |
03798a93 | 299 | stream->cycles_timestamp = integer_definition->value._unsigned; |
03798a93 JD |
300 | stream->real_timestamp = ctf_get_real_timestamp(stream, |
301 | stream->cycles_timestamp); | |
2b9a764d MD |
302 | return; |
303 | } | |
304 | /* keep low bits */ | |
03798a93 | 305 | oldval = stream->cycles_timestamp; |
2b9a764d MD |
306 | oldval &= (1ULL << integer_declaration->len) - 1; |
307 | newval = integer_definition->value._unsigned; | |
308 | /* Test for overflow by comparing low bits */ | |
309 | if (newval < oldval) | |
310 | newval += 1ULL << integer_declaration->len; | |
311 | /* updateval contains old high bits, and new low bits (sum) */ | |
03798a93 | 312 | updateval = stream->cycles_timestamp; |
2b9a764d MD |
313 | updateval &= ~((1ULL << integer_declaration->len) - 1); |
314 | updateval += newval; | |
03798a93 JD |
315 | stream->cycles_timestamp = updateval; |
316 | ||
317 | /* convert to real timestamp */ | |
03798a93 JD |
318 | stream->real_timestamp = ctf_get_real_timestamp(stream, |
319 | stream->cycles_timestamp); | |
2b9a764d MD |
320 | } |
321 | ||
25ccc85b MD |
322 | /* |
323 | * Print timestamp, rescaling clock frequency to nanoseconds and | |
324 | * applying offsets as needed (unix time). | |
325 | */ | |
2e937fb4 | 326 | static |
03798a93 | 327 | void ctf_print_timestamp_real(FILE *fp, |
9e88d150 | 328 | struct ctf_stream_definition *stream, |
7d97fad9 MD |
329 | uint64_t timestamp) |
330 | { | |
331 | uint64_t ts_sec = 0, ts_nsec; | |
7d97fad9 | 332 | |
03798a93 | 333 | ts_nsec = timestamp; |
7d97fad9 | 334 | |
65923160 IJ |
335 | /* Add command-line offset in ns*/ |
336 | ts_nsec += opt_clock_offset_ns; | |
337 | ||
c34ea0fa | 338 | /* Add command-line offset */ |
7d97fad9 MD |
339 | ts_sec += opt_clock_offset; |
340 | ||
341 | ts_sec += ts_nsec / NSEC_PER_SEC; | |
342 | ts_nsec = ts_nsec % NSEC_PER_SEC; | |
343 | ||
344 | if (!opt_clock_seconds) { | |
345 | struct tm tm; | |
346 | time_t time_s = (time_t) ts_sec; | |
347 | ||
348 | if (!opt_clock_gmt) { | |
349 | struct tm *res; | |
350 | ||
351 | res = localtime_r(&time_s, &tm); | |
352 | if (!res) { | |
353 | fprintf(stderr, "[warning] Unable to get localtime.\n"); | |
354 | goto seconds; | |
355 | } | |
356 | } else { | |
357 | struct tm *res; | |
358 | ||
359 | res = gmtime_r(&time_s, &tm); | |
360 | if (!res) { | |
361 | fprintf(stderr, "[warning] Unable to get gmtime.\n"); | |
362 | goto seconds; | |
363 | } | |
364 | } | |
365 | if (opt_clock_date) { | |
366 | char timestr[26]; | |
367 | size_t res; | |
368 | ||
369 | /* Print date and time */ | |
370 | res = strftime(timestr, sizeof(timestr), | |
371 | "%F ", &tm); | |
372 | if (!res) { | |
373 | fprintf(stderr, "[warning] Unable to print ascii time.\n"); | |
374 | goto seconds; | |
375 | } | |
376 | fprintf(fp, "%s", timestr); | |
377 | } | |
378 | /* Print time in HH:MM:SS.ns */ | |
379 | fprintf(fp, "%02d:%02d:%02d.%09" PRIu64, | |
380 | tm.tm_hour, tm.tm_min, tm.tm_sec, ts_nsec); | |
381 | goto end; | |
382 | } | |
383 | seconds: | |
384 | fprintf(fp, "%3" PRIu64 ".%09" PRIu64, | |
385 | ts_sec, ts_nsec); | |
386 | ||
387 | end: | |
388 | return; | |
389 | } | |
390 | ||
03798a93 JD |
391 | /* |
392 | * Print timestamp, in cycles | |
393 | */ | |
2e937fb4 | 394 | static |
03798a93 JD |
395 | void ctf_print_timestamp_cycles(FILE *fp, |
396 | struct ctf_stream_definition *stream, | |
397 | uint64_t timestamp) | |
398 | { | |
399 | fprintf(fp, "%020" PRIu64, timestamp); | |
400 | } | |
401 | ||
402 | void ctf_print_timestamp(FILE *fp, | |
403 | struct ctf_stream_definition *stream, | |
404 | uint64_t timestamp) | |
405 | { | |
406 | if (opt_clock_cycles) { | |
407 | ctf_print_timestamp_cycles(fp, stream, timestamp); | |
408 | } else { | |
409 | ctf_print_timestamp_real(fp, stream, timestamp); | |
410 | } | |
411 | } | |
412 | ||
87148dc7 MD |
413 | static |
414 | void print_uuid(FILE *fp, unsigned char *uuid) | |
415 | { | |
416 | int i; | |
417 | ||
418 | for (i = 0; i < BABELTRACE_UUID_LEN; i++) | |
419 | fprintf(fp, "%x", (unsigned int) uuid[i]); | |
420 | } | |
421 | ||
2654fe9b MD |
422 | /* |
423 | * Discarded events can be either: | |
424 | * - discarded after end of previous buffer due to buffer full: | |
425 | * happened within range: [ prev_timestamp_end, timestamp_begin ] | |
426 | * - discarded within current buffer due to either event too large or | |
427 | * nested wrap-around: | |
428 | * happened within range: [ timestamp_begin, timestamp_end ] | |
429 | * | |
430 | * Given we have discarded counters of those two types merged into the | |
431 | * events_discarded counter, we need to use the union of those ranges: | |
432 | * [ prev_timestamp_end, timestamp_end ] | |
2328c2cd JD |
433 | * |
434 | * Lost packets occur if the tracer overwrote some subbuffer(s) before the | |
435 | * consumer had time to extract them. We keep track of those gaps with the | |
436 | * packet sequence number in each packet. | |
2654fe9b | 437 | */ |
2328c2cd | 438 | void ctf_print_discarded_lost(FILE *fp, struct ctf_stream_definition *stream) |
87148dc7 | 439 | { |
2328c2cd JD |
440 | if ((!stream->events_discarded && !stream->packets_lost) || |
441 | !babeltrace_ctf_console_output) { | |
2654fe9b MD |
442 | return; |
443 | } | |
444 | fflush(stdout); | |
2328c2cd JD |
445 | if (stream->events_discarded) { |
446 | fprintf(fp, "[warning] Tracer discarded %" PRIu64 " events between [", | |
447 | stream->events_discarded); | |
448 | } else if (stream->packets_lost) { | |
449 | fprintf(fp, "[warning] Tracer lost %" PRIu64 " trace packets between [", | |
450 | stream->packets_lost); | |
451 | } | |
87148dc7 MD |
452 | if (opt_clock_cycles) { |
453 | ctf_print_timestamp(fp, stream, | |
2654fe9b | 454 | stream->prev.cycles.end); |
87148dc7 MD |
455 | fprintf(fp, "] and ["); |
456 | ctf_print_timestamp(fp, stream, | |
2654fe9b | 457 | stream->current.cycles.end); |
87148dc7 MD |
458 | } else { |
459 | ctf_print_timestamp(fp, stream, | |
2654fe9b | 460 | stream->prev.real.end); |
87148dc7 MD |
461 | fprintf(fp, "] and ["); |
462 | ctf_print_timestamp(fp, stream, | |
2654fe9b | 463 | stream->current.real.end); |
87148dc7 MD |
464 | } |
465 | fprintf(fp, "] in trace UUID "); | |
466 | print_uuid(fp, stream->stream_class->trace->uuid); | |
caf929fa | 467 | if (stream->stream_class->trace->parent.path[0]) |
87148dc7 | 468 | fprintf(fp, ", at path: \"%s\"", |
caf929fa | 469 | stream->stream_class->trace->parent.path); |
87148dc7 MD |
470 | |
471 | fprintf(fp, ", within stream id %" PRIu64, stream->stream_id); | |
472 | if (stream->path[0]) | |
473 | fprintf(fp, ", at relative path: \"%s\"", stream->path); | |
474 | fprintf(fp, ". "); | |
475 | fprintf(fp, "You should consider recording a new trace with larger " | |
476 | "buffers or with fewer events enabled.\n"); | |
477 | fflush(fp); | |
478 | } | |
479 | ||
31262354 | 480 | static |
1cf393f6 | 481 | int ctf_read_event(struct bt_stream_pos *ppos, struct ctf_stream_definition *stream) |
31262354 MD |
482 | { |
483 | struct ctf_stream_pos *pos = | |
484 | container_of(ppos, struct ctf_stream_pos, parent); | |
f380e105 | 485 | struct ctf_stream_declaration *stream_class = stream->stream_class; |
c716f83b | 486 | struct ctf_event_definition *event; |
31262354 | 487 | uint64_t id = 0; |
31262354 MD |
488 | int ret; |
489 | ||
3abe83c7 MD |
490 | /* We need to check for EOF here for empty files. */ |
491 | if (unlikely(pos->offset == EOF)) | |
492 | return EOF; | |
493 | ||
7b563a77 MD |
494 | if (ctf_pos_get_event(pos)) |
495 | return EOF; | |
5f643ed7 | 496 | |
90fcbacc JD |
497 | /* save the current position as a restore point */ |
498 | pos->last_offset = pos->offset; | |
90fcbacc | 499 | |
3abe83c7 MD |
500 | /* |
501 | * This is the EOF check after we've advanced the position in | |
502 | * ctf_pos_get_event. | |
503 | */ | |
7f3f572b | 504 | if (unlikely(pos->offset == EOF)) |
31262354 | 505 | return EOF; |
8793d9f8 | 506 | |
500634be JD |
507 | /* Stream is inactive for now (live reading). */ |
508 | if (unlikely(pos->content_size == 0)) | |
8793d9f8 | 509 | return EAGAIN; |
500634be JD |
510 | |
511 | /* | |
512 | * Packet seeked to by ctf_pos_get_event() only contains | |
513 | * headers, no event. Consider stream as inactive (live | |
514 | * reading). | |
515 | */ | |
516 | if (unlikely(pos->data_offset == pos->content_size)) | |
a5260047 JD |
517 | return EAGAIN; |
518 | ||
5f643ed7 | 519 | assert(pos->offset < pos->content_size); |
31262354 MD |
520 | |
521 | /* Read event header */ | |
7f3f572b | 522 | if (likely(stream->stream_event_header)) { |
a35173fe | 523 | struct definition_integer *integer_definition; |
0d69b916 | 524 | struct bt_definition *variant; |
a35173fe | 525 | |
e28d4618 | 526 | ret = generic_rw(ppos, &stream->stream_event_header->p); |
7f3f572b | 527 | if (unlikely(ret)) |
31262354 MD |
528 | goto error; |
529 | /* lookup event id */ | |
bf78e2cf | 530 | integer_definition = bt_lookup_integer(&stream->stream_event_header->p, "id", FALSE); |
a35173fe MD |
531 | if (integer_definition) { |
532 | id = integer_definition->value._unsigned; | |
533 | } else { | |
534 | struct definition_enum *enum_definition; | |
535 | ||
9e3274b0 | 536 | enum_definition = bt_lookup_enum(&stream->stream_event_header->p, "id", FALSE); |
a35173fe MD |
537 | if (enum_definition) { |
538 | id = enum_definition->integer->value._unsigned; | |
539 | } | |
31262354 | 540 | } |
764af3f4 | 541 | |
ebae302b | 542 | variant = bt_lookup_variant(&stream->stream_event_header->p, "v"); |
ccdb988e | 543 | if (variant) { |
bf78e2cf | 544 | integer_definition = bt_lookup_integer(variant, "id", FALSE); |
ccdb988e MD |
545 | if (integer_definition) { |
546 | id = integer_definition->value._unsigned; | |
547 | } | |
548 | } | |
c87a8eb2 | 549 | stream->event_id = id; |
ccdb988e | 550 | |
764af3f4 | 551 | /* lookup timestamp */ |
5e2eb0ae | 552 | stream->has_timestamp = 0; |
bf78e2cf | 553 | integer_definition = bt_lookup_integer(&stream->stream_event_header->p, "timestamp", FALSE); |
a35173fe | 554 | if (integer_definition) { |
2b9a764d | 555 | ctf_update_timestamp(stream, integer_definition); |
5e2eb0ae | 556 | stream->has_timestamp = 1; |
a35173fe | 557 | } else { |
ccdb988e | 558 | if (variant) { |
bf78e2cf | 559 | integer_definition = bt_lookup_integer(variant, "timestamp", FALSE); |
a35173fe | 560 | if (integer_definition) { |
2b9a764d | 561 | ctf_update_timestamp(stream, integer_definition); |
5e2eb0ae | 562 | stream->has_timestamp = 1; |
a35173fe MD |
563 | } |
564 | } | |
764af3f4 | 565 | } |
31262354 MD |
566 | } |
567 | ||
568 | /* Read stream-declared event context */ | |
e28d4618 MD |
569 | if (stream->stream_event_context) { |
570 | ret = generic_rw(ppos, &stream->stream_event_context->p); | |
31262354 MD |
571 | if (ret) |
572 | goto error; | |
573 | } | |
574 | ||
7f3f572b | 575 | if (unlikely(id >= stream_class->events_by_id->len)) { |
3394d22e | 576 | fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id); |
31262354 MD |
577 | return -EINVAL; |
578 | } | |
e28d4618 | 579 | event = g_ptr_array_index(stream->events_by_id, id); |
7f3f572b | 580 | if (unlikely(!event)) { |
3394d22e | 581 | fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id); |
31262354 MD |
582 | return -EINVAL; |
583 | } | |
584 | ||
585 | /* Read event-declared event context */ | |
e28d4618 MD |
586 | if (event->event_context) { |
587 | ret = generic_rw(ppos, &event->event_context->p); | |
31262354 MD |
588 | if (ret) |
589 | goto error; | |
590 | } | |
591 | ||
592 | /* Read event payload */ | |
7f3f572b | 593 | if (likely(event->event_fields)) { |
e28d4618 | 594 | ret = generic_rw(ppos, &event->event_fields->p); |
31262354 MD |
595 | if (ret) |
596 | goto error; | |
597 | } | |
598 | ||
28f35f0a MD |
599 | if (pos->last_offset == pos->offset) { |
600 | fprintf(stderr, "[error] Invalid 0 byte event encountered.\n"); | |
601 | return -EINVAL; | |
602 | } | |
603 | ||
31262354 MD |
604 | return 0; |
605 | ||
606 | error: | |
64f5abe1 | 607 | fprintf(stderr, "[error] Unexpected end of packet. Either the trace data stream is corrupted or metadata description does not match data layout.\n"); |
31262354 MD |
608 | return ret; |
609 | } | |
610 | ||
611 | static | |
1cf393f6 | 612 | int ctf_write_event(struct bt_stream_pos *pos, struct ctf_stream_definition *stream) |
31262354 | 613 | { |
f380e105 | 614 | struct ctf_stream_declaration *stream_class = stream->stream_class; |
c716f83b | 615 | struct ctf_event_definition *event; |
c87a8eb2 | 616 | uint64_t id; |
31262354 MD |
617 | int ret; |
618 | ||
c87a8eb2 MD |
619 | id = stream->event_id; |
620 | ||
31262354 | 621 | /* print event header */ |
7f3f572b | 622 | if (likely(stream->stream_event_header)) { |
e28d4618 | 623 | ret = generic_rw(pos, &stream->stream_event_header->p); |
31262354 MD |
624 | if (ret) |
625 | goto error; | |
626 | } | |
627 | ||
628 | /* print stream-declared event context */ | |
e28d4618 MD |
629 | if (stream->stream_event_context) { |
630 | ret = generic_rw(pos, &stream->stream_event_context->p); | |
31262354 MD |
631 | if (ret) |
632 | goto error; | |
633 | } | |
634 | ||
7f3f572b | 635 | if (unlikely(id >= stream_class->events_by_id->len)) { |
3394d22e | 636 | fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id); |
31262354 MD |
637 | return -EINVAL; |
638 | } | |
e28d4618 | 639 | event = g_ptr_array_index(stream->events_by_id, id); |
7f3f572b | 640 | if (unlikely(!event)) { |
3394d22e | 641 | fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id); |
31262354 MD |
642 | return -EINVAL; |
643 | } | |
644 | ||
645 | /* print event-declared event context */ | |
e28d4618 MD |
646 | if (event->event_context) { |
647 | ret = generic_rw(pos, &event->event_context->p); | |
31262354 MD |
648 | if (ret) |
649 | goto error; | |
650 | } | |
651 | ||
652 | /* Read and print event payload */ | |
7f3f572b | 653 | if (likely(event->event_fields)) { |
e28d4618 | 654 | ret = generic_rw(pos, &event->event_fields->p); |
31262354 MD |
655 | if (ret) |
656 | goto error; | |
657 | } | |
658 | ||
659 | return 0; | |
660 | ||
661 | error: | |
3394d22e | 662 | fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n"); |
31262354 MD |
663 | return ret; |
664 | } | |
665 | ||
e69dd258 JD |
666 | /* |
667 | * One side-effect of this function is to unmap pos mmap base if one is | |
668 | * mapped. | |
669 | */ | |
670 | static | |
671 | int find_data_offset(struct ctf_stream_pos *pos, | |
672 | struct ctf_file_stream *file_stream, | |
673 | struct packet_index *packet_index) | |
674 | { | |
675 | uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len; | |
676 | struct stat filestats; | |
677 | size_t filesize; | |
678 | int ret; | |
679 | ||
680 | pos = &file_stream->pos; | |
681 | ||
682 | ret = fstat(pos->fd, &filestats); | |
683 | if (ret < 0) | |
684 | return ret; | |
685 | filesize = filestats.st_size; | |
686 | ||
687 | /* Deal with empty files */ | |
688 | if (!filesize) { | |
689 | return 0; | |
690 | } | |
691 | ||
692 | begin: | |
693 | if (filesize - pos->mmap_offset < (packet_map_len >> LOG2_CHAR_BIT)) { | |
694 | packet_map_len = (filesize - pos->mmap_offset) << LOG2_CHAR_BIT; | |
695 | } | |
696 | ||
697 | if (pos->base_mma) { | |
698 | /* unmap old base */ | |
699 | ret = munmap_align(pos->base_mma); | |
700 | if (ret) { | |
701 | fprintf(stderr, "[error] Unable to unmap old base: %s.\n", | |
702 | strerror(errno)); | |
703 | return ret; | |
704 | } | |
705 | pos->base_mma = NULL; | |
706 | } | |
707 | /* map new base. Need mapping length from header. */ | |
708 | pos->base_mma = mmap_align(packet_map_len >> LOG2_CHAR_BIT, PROT_READ, | |
709 | MAP_PRIVATE, pos->fd, pos->mmap_offset); | |
710 | assert(pos->base_mma != MAP_FAILED); | |
711 | ||
712 | pos->content_size = packet_map_len; | |
713 | pos->packet_size = packet_map_len; | |
714 | pos->offset = 0; /* Position of the packet header */ | |
715 | ||
716 | /* update trace_packet_header and stream_packet_context */ | |
717 | if (pos->prot == PROT_READ && file_stream->parent.trace_packet_header) { | |
718 | /* Read packet header */ | |
719 | ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p); | |
720 | if (ret) { | |
721 | if (ret == -EFAULT) | |
722 | goto retry; | |
723 | } | |
724 | } | |
725 | if (pos->prot == PROT_READ && file_stream->parent.stream_packet_context) { | |
726 | /* Read packet context */ | |
727 | ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p); | |
728 | if (ret) { | |
729 | if (ret == -EFAULT) | |
730 | goto retry; | |
731 | } | |
732 | } | |
733 | packet_index->data_offset = pos->offset; | |
734 | ||
735 | /* unmap old base */ | |
736 | ret = munmap_align(pos->base_mma); | |
737 | if (ret) { | |
738 | fprintf(stderr, "[error] Unable to unmap old base: %s.\n", | |
739 | strerror(errno)); | |
740 | return ret; | |
741 | } | |
742 | pos->base_mma = NULL; | |
743 | ||
744 | return 0; | |
745 | ||
746 | /* Retry with larger mapping */ | |
747 | retry: | |
748 | if (packet_map_len == ((filesize - pos->mmap_offset) << LOG2_CHAR_BIT)) { | |
749 | /* | |
750 | * Reached EOF, but still expecting header/context data. | |
751 | */ | |
752 | fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n"); | |
753 | return -EFAULT; | |
754 | } | |
755 | /* Double the mapping len, and retry */ | |
756 | tmp_map_len = packet_map_len << 1; | |
757 | if (tmp_map_len >> 1 != packet_map_len) { | |
758 | /* Overflow */ | |
759 | fprintf(stderr, "[error] Packet mapping length overflow\n"); | |
760 | return -EFAULT; | |
761 | } | |
762 | packet_map_len = tmp_map_len; | |
763 | goto begin; | |
764 | } | |
765 | ||
766 | ||
ca334c72 MD |
767 | int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace, |
768 | int fd, int open_flags) | |
8c572eba MD |
769 | { |
770 | pos->fd = fd; | |
37fcdd19 | 771 | if (fd >= 0) { |
992e8cc0 | 772 | pos->packet_index = g_array_new(FALSE, TRUE, |
37fcdd19 JD |
773 | sizeof(struct packet_index)); |
774 | } else { | |
992e8cc0 | 775 | pos->packet_index = NULL; |
37fcdd19 | 776 | } |
8563e754 MD |
777 | switch (open_flags & O_ACCMODE) { |
778 | case O_RDONLY: | |
779 | pos->prot = PROT_READ; | |
780 | pos->flags = MAP_PRIVATE; | |
781 | pos->parent.rw_table = read_dispatch_table; | |
31262354 | 782 | pos->parent.event_cb = ctf_read_event; |
ca334c72 | 783 | pos->parent.trace = trace; |
8563e754 | 784 | break; |
8563e754 | 785 | case O_RDWR: |
fcf10417 | 786 | pos->prot = PROT_READ | PROT_WRITE; |
8563e754 MD |
787 | pos->flags = MAP_SHARED; |
788 | pos->parent.rw_table = write_dispatch_table; | |
31262354 | 789 | pos->parent.event_cb = ctf_write_event; |
ca334c72 | 790 | pos->parent.trace = trace; |
8563e754 MD |
791 | break; |
792 | default: | |
793 | assert(0); | |
8c572eba | 794 | } |
f824ae04 | 795 | return 0; |
8c572eba MD |
796 | } |
797 | ||
f824ae04 | 798 | int ctf_fini_pos(struct ctf_stream_pos *pos) |
8c572eba | 799 | { |
fcf10417 | 800 | if ((pos->prot & PROT_WRITE) && pos->content_size_loc) |
8c572eba | 801 | *pos->content_size_loc = pos->offset; |
aee35fcc | 802 | if (pos->base_mma) { |
08c82b90 MD |
803 | int ret; |
804 | ||
8c572eba | 805 | /* unmap old base */ |
aee35fcc | 806 | ret = munmap_align(pos->base_mma); |
8c572eba | 807 | if (ret) { |
3394d22e | 808 | fprintf(stderr, "[error] Unable to unmap old base: %s.\n", |
8c572eba | 809 | strerror(errno)); |
f824ae04 | 810 | return -1; |
8c572eba MD |
811 | } |
812 | } | |
992e8cc0 MD |
813 | if (pos->packet_index) |
814 | (void) g_array_free(pos->packet_index, TRUE); | |
f824ae04 | 815 | return 0; |
8c572eba MD |
816 | } |
817 | ||
f1f52630 MD |
818 | void ctf_update_current_packet_index(struct ctf_stream_definition *stream, |
819 | struct packet_index *prev_index, | |
820 | struct packet_index *cur_index) | |
821 | { | |
822 | uint64_t events_discarded_diff; | |
2328c2cd | 823 | uint64_t packets_lost_diff = 0; |
f1f52630 MD |
824 | |
825 | /* Update packet index time information */ | |
2654fe9b MD |
826 | |
827 | /* Current packet begin/end */ | |
828 | stream->current.real.begin = | |
829 | cur_index->ts_real.timestamp_begin; | |
830 | stream->current.cycles.begin = | |
f1f52630 | 831 | cur_index->ts_cycles.timestamp_begin; |
2654fe9b | 832 | stream->current.real.end = |
f1f52630 | 833 | cur_index->ts_real.timestamp_end; |
2654fe9b MD |
834 | stream->current.cycles.end = |
835 | cur_index->ts_cycles.timestamp_end; | |
f1f52630 MD |
836 | |
837 | /* Update packet index discarded event information */ | |
838 | events_discarded_diff = cur_index->events_discarded; | |
839 | if (prev_index) { | |
2654fe9b MD |
840 | /* Previous packet begin/end */ |
841 | stream->prev.cycles.begin = | |
842 | prev_index->ts_cycles.timestamp_begin; | |
843 | stream->prev.real.begin = | |
844 | prev_index->ts_real.timestamp_begin; | |
845 | stream->prev.cycles.end = | |
846 | prev_index->ts_cycles.timestamp_end; | |
847 | stream->prev.real.end = | |
848 | prev_index->ts_real.timestamp_end; | |
849 | ||
f1f52630 | 850 | events_discarded_diff -= prev_index->events_discarded; |
2328c2cd JD |
851 | /* packet_seq_num stays at 0 if not produced by the tracer */ |
852 | if (cur_index->packet_seq_num) { | |
853 | packets_lost_diff = cur_index->packet_seq_num - | |
854 | prev_index->packet_seq_num - 1; | |
855 | } | |
f1f52630 MD |
856 | /* |
857 | * Deal with 32-bit wrap-around if the tracer provided a | |
858 | * 32-bit field. | |
859 | */ | |
860 | if (prev_index->events_discarded_len == 32) { | |
861 | events_discarded_diff = (uint32_t) events_discarded_diff; | |
862 | } | |
2654fe9b MD |
863 | } else { |
864 | /* | |
865 | * First packet: use current packet info as limits for | |
866 | * previous packet. | |
867 | */ | |
868 | stream->prev.cycles.begin = | |
869 | stream->prev.cycles.end = | |
870 | stream->current.cycles.begin; | |
871 | stream->prev.real.begin = | |
872 | stream->prev.real.end = | |
873 | stream->current.real.begin; | |
f1f52630 MD |
874 | } |
875 | stream->events_discarded = events_discarded_diff; | |
2328c2cd | 876 | stream->packets_lost = packets_lost_diff; |
f1f52630 MD |
877 | } |
878 | ||
37ea109a JD |
879 | /* |
880 | * Find the timerange where all the streams in the trace are active | |
881 | * simultaneously. | |
882 | * | |
883 | * Return 0 and update begin/end if necessary on success, return 1 for | |
884 | * empty streams and return a negative value on error. | |
885 | */ | |
886 | static | |
837b0013 JG |
887 | int ctf_find_stream_intersection(struct bt_trace_descriptor *td_read, |
888 | struct packet_index_time *_real, | |
889 | struct packet_index_time *_cycles) | |
37ea109a | 890 | { |
37ea109a | 891 | int stream_id, ret = 0; |
837b0013 JG |
892 | struct packet_index_time real = { 0, UINT64_MAX }, |
893 | cycles = { 0, UINT64_MAX }; | |
894 | struct ctf_trace *tin = container_of(td_read, struct ctf_trace, parent); | |
37ea109a | 895 | |
837b0013 JG |
896 | /* At least one of the two return args must be provided. */ |
897 | if (!_real && !_cycles) { | |
898 | ret = -1; | |
899 | goto end; | |
900 | } | |
901 | ||
902 | if (tin->streams->len == 0) { | |
903 | ret = 1; | |
904 | goto end; | |
905 | } | |
37ea109a JD |
906 | |
907 | for (stream_id = 0; stream_id < tin->streams->len; | |
908 | stream_id++) { | |
909 | int filenr; | |
910 | struct ctf_stream_declaration *stream_class; | |
911 | ||
912 | stream_class = g_ptr_array_index(tin->streams, stream_id); | |
913 | if (!stream_class) { | |
914 | continue; | |
915 | } | |
916 | for (filenr = 0; filenr < stream_class->streams->len; filenr++) { | |
917 | struct ctf_file_stream *file_stream; | |
918 | struct ctf_stream_pos *stream_pos; | |
919 | struct packet_index *index; | |
920 | ||
921 | file_stream = g_ptr_array_index(stream_class->streams, | |
922 | filenr); | |
923 | if (!file_stream) { | |
924 | continue; | |
925 | } | |
926 | stream_pos = &file_stream->pos; | |
927 | if (!stream_pos->packet_index || | |
928 | stream_pos->packet_index->len <= 0) { | |
929 | ret = 1; | |
930 | goto end; | |
931 | } | |
932 | index = &g_array_index(stream_pos->packet_index, | |
933 | struct packet_index, 0); | |
837b0013 JG |
934 | real.timestamp_begin = max(real.timestamp_begin, |
935 | index->ts_real.timestamp_begin); | |
936 | cycles.timestamp_begin = max(cycles.timestamp_begin, | |
937 | index->ts_cycles.timestamp_begin); | |
938 | ||
37ea109a JD |
939 | index = &g_array_index(stream_pos->packet_index, |
940 | struct packet_index, | |
941 | stream_pos->packet_index->len - 1); | |
837b0013 JG |
942 | real.timestamp_end = min(real.timestamp_end, |
943 | index->ts_real.timestamp_end); | |
944 | cycles.timestamp_end = min(cycles.timestamp_end, | |
945 | index->ts_cycles.timestamp_end); | |
37ea109a JD |
946 | } |
947 | } | |
37ea109a | 948 | end: |
837b0013 JG |
949 | if (ret == 0) { |
950 | if (_real) { | |
951 | *_real = real; | |
952 | } | |
953 | if (_cycles) { | |
954 | *_cycles = cycles; | |
955 | } | |
956 | } | |
37ea109a JD |
957 | return ret; |
958 | } | |
959 | ||
960 | /* | |
837b0013 JG |
961 | * Find the union of all active regions in the trace collection's traces. |
962 | * Returns "real" timestamps. | |
37ea109a JD |
963 | * |
964 | * Return 0 on success. | |
965 | * Return 1 if no intersections are found. | |
966 | * Return a negative value on error. | |
967 | */ | |
837b0013 JG |
968 | int ctf_find_tc_stream_packet_intersection_union(struct bt_context *ctx, |
969 | uint64_t *_ts_begin, uint64_t *_ts_end) | |
37ea109a | 970 | { |
837b0013 JG |
971 | int ret = 0, i; |
972 | uint64_t ts_begin = UINT64_MAX, ts_end = 0; | |
37ea109a | 973 | |
837b0013 | 974 | if (!ctx || !ctx->tc || !ctx->tc->array || !_ts_begin || !_ts_end) { |
37ea109a JD |
975 | ret = -EINVAL; |
976 | goto end; | |
977 | } | |
978 | ||
979 | for (i = 0; i < ctx->tc->array->len; i++) { | |
980 | struct bt_trace_descriptor *td_read; | |
837b0013 | 981 | struct packet_index_time intersection_real; |
37ea109a JD |
982 | |
983 | td_read = g_ptr_array_index(ctx->tc->array, i); | |
984 | if (!td_read) { | |
985 | continue; | |
986 | } | |
837b0013 JG |
987 | ret = ctf_find_stream_intersection(td_read, &intersection_real, |
988 | NULL); | |
989 | if (ret == 1) { | |
990 | /* Empty trace or no stream intersection. */ | |
991 | continue; | |
992 | } else if (ret < 0) { | |
37ea109a JD |
993 | goto end; |
994 | } | |
837b0013 JG |
995 | |
996 | ts_begin = min(intersection_real.timestamp_begin, ts_begin); | |
997 | ts_end = max(intersection_real.timestamp_end, ts_end); | |
37ea109a | 998 | } |
837b0013 JG |
999 | |
1000 | if (ts_end < ts_begin) { | |
37ea109a | 1001 | ret = 1; |
837b0013 JG |
1002 | goto end; |
1003 | } | |
1004 | *_ts_begin = ts_begin; | |
1005 | *_ts_end = ts_end; | |
1006 | end: | |
1007 | return ret; | |
1008 | } | |
1009 | ||
1010 | int ctf_tc_set_stream_intersection_mode(struct bt_context *ctx) | |
1011 | { | |
1012 | int ret = 0, i; | |
1013 | ||
1014 | if (!ctx || !ctx->tc || !ctx->tc->array) { | |
1015 | ret = -EINVAL; | |
1016 | goto end; | |
1017 | } | |
1018 | ||
1019 | for (i = 0; i < ctx->tc->array->len; i++) { | |
1020 | struct bt_trace_descriptor *td_read; | |
1021 | struct packet_index_time intersection_real; | |
1022 | ||
1023 | td_read = g_ptr_array_index(ctx->tc->array, i); | |
1024 | if (!td_read) { | |
1025 | continue; | |
1026 | } | |
1027 | ||
1028 | ret = ctf_find_stream_intersection(td_read, &intersection_real, | |
1029 | NULL); | |
1030 | if (ret == 1) { | |
1031 | /* Empty trace or no stream intersection. */ | |
1032 | continue; | |
1033 | } else if (ret < 0) { | |
1034 | goto end; | |
1035 | } | |
1036 | ||
1037 | td_read->interval_real = intersection_real; | |
1038 | td_read->interval_set = true; | |
37ea109a JD |
1039 | } |
1040 | end: | |
1041 | return ret; | |
1042 | } | |
1043 | ||
20d0dcf9 MD |
1044 | /* |
1045 | * for SEEK_CUR: go to next packet. | |
34b8fff6 | 1046 | * for SEEK_SET: go to packet numer (index). |
20d0dcf9 | 1047 | */ |
1cf393f6 | 1048 | void ctf_packet_seek(struct bt_stream_pos *stream_pos, size_t index, int whence) |
0f980a35 | 1049 | { |
d6425aaf MD |
1050 | struct ctf_stream_pos *pos = |
1051 | container_of(stream_pos, struct ctf_stream_pos, parent); | |
75cc2c35 MD |
1052 | struct ctf_file_stream *file_stream = |
1053 | container_of(pos, struct ctf_file_stream, pos); | |
0f980a35 | 1054 | int ret; |
2654fe9b | 1055 | struct packet_index *packet_index, *prev_index; |
0f980a35 | 1056 | |
5bfcad93 MD |
1057 | switch (whence) { |
1058 | case SEEK_CUR: | |
1059 | case SEEK_SET: /* Fall-through */ | |
1060 | break; /* OK */ | |
1061 | default: | |
7b563a77 MD |
1062 | ret = -1; |
1063 | goto end; | |
5bfcad93 MD |
1064 | } |
1065 | ||
fcf10417 | 1066 | if ((pos->prot & PROT_WRITE) && pos->content_size_loc) |
8c572eba | 1067 | *pos->content_size_loc = pos->offset; |
0f980a35 | 1068 | |
aee35fcc | 1069 | if (pos->base_mma) { |
0f980a35 | 1070 | /* unmap old base */ |
aee35fcc | 1071 | ret = munmap_align(pos->base_mma); |
0f980a35 | 1072 | if (ret) { |
3394d22e | 1073 | fprintf(stderr, "[error] Unable to unmap old base: %s.\n", |
0f980a35 | 1074 | strerror(errno)); |
7b563a77 MD |
1075 | ret = -1; |
1076 | goto end; | |
0f980a35 | 1077 | } |
aee35fcc | 1078 | pos->base_mma = NULL; |
0f980a35 MD |
1079 | } |
1080 | ||
8c572eba | 1081 | /* |
46322b33 | 1082 | * The caller should never ask for ctf_move_pos across packets, |
8c572eba MD |
1083 | * except to get exactly at the beginning of the next packet. |
1084 | */ | |
fcf10417 | 1085 | if (pos->prot & PROT_WRITE) { |
989c73bc MD |
1086 | switch (whence) { |
1087 | case SEEK_CUR: | |
1088 | /* The writer will add padding */ | |
e0a5b455 | 1089 | pos->mmap_offset += pos->packet_size / CHAR_BIT; |
989c73bc MD |
1090 | break; |
1091 | case SEEK_SET: | |
20d0dcf9 | 1092 | assert(index == 0); /* only seek supported for now */ |
989c73bc MD |
1093 | pos->cur_index = 0; |
1094 | break; | |
1095 | default: | |
7b563a77 MD |
1096 | ret = -1; |
1097 | goto end; | |
989c73bc | 1098 | } |
8c572eba MD |
1099 | pos->content_size = -1U; /* Unknown at this point */ |
1100 | pos->packet_size = WRITE_PACKET_LEN; | |
118f5776 MD |
1101 | do { |
1102 | ret = bt_posix_fallocate(pos->fd, pos->mmap_offset, | |
1103 | pos->packet_size / CHAR_BIT); | |
1104 | } while (ret == EINTR); | |
1105 | assert(ret == 0); | |
847bf71a | 1106 | pos->offset = 0; |
8c572eba | 1107 | } else { |
5f643ed7 | 1108 | read_next_packet: |
847bf71a MD |
1109 | switch (whence) { |
1110 | case SEEK_CUR: | |
41e82e00 | 1111 | { |
7d97fad9 | 1112 | if (pos->offset == EOF) { |
7b563a77 MD |
1113 | ret = 0; |
1114 | goto end; | |
7d97fad9 | 1115 | } |
992e8cc0 | 1116 | assert(pos->cur_index < pos->packet_index->len); |
847bf71a | 1117 | /* The reader will expect us to skip padding */ |
8c572eba | 1118 | ++pos->cur_index; |
847bf71a | 1119 | break; |
41e82e00 | 1120 | } |
847bf71a | 1121 | case SEEK_SET: |
992e8cc0 | 1122 | if (index >= pos->packet_index->len) { |
c309df1c | 1123 | pos->offset = EOF; |
7b563a77 MD |
1124 | ret = 0; |
1125 | goto end; | |
c309df1c | 1126 | } |
20d0dcf9 | 1127 | pos->cur_index = index; |
847bf71a MD |
1128 | break; |
1129 | default: | |
7b563a77 MD |
1130 | ret = -1; |
1131 | goto end; | |
847bf71a | 1132 | } |
2654fe9b | 1133 | |
0e1b84aa MD |
1134 | if (pos->cur_index >= pos->packet_index->len) { |
1135 | pos->offset = EOF; | |
7b563a77 MD |
1136 | ret = 0; |
1137 | goto end; | |
0e1b84aa MD |
1138 | } |
1139 | ||
2654fe9b MD |
1140 | packet_index = &g_array_index(pos->packet_index, |
1141 | struct packet_index, pos->cur_index); | |
1142 | if (pos->cur_index > 0) { | |
1143 | prev_index = &g_array_index(pos->packet_index, | |
1144 | struct packet_index, | |
1145 | pos->cur_index - 1); | |
1146 | } else { | |
1147 | prev_index = NULL; | |
1148 | } | |
1149 | ctf_update_current_packet_index(&file_stream->parent, | |
1150 | prev_index, packet_index); | |
1151 | ||
7b563a77 MD |
1152 | if (pos->cur_index >= pos->packet_index->len) { |
1153 | pos->offset = EOF; | |
1154 | ret = 0; | |
1155 | goto end; | |
1156 | } | |
1157 | ||
2654fe9b MD |
1158 | /* |
1159 | * We need to check if we are in trace read or called | |
1160 | * from packet indexing. In this last case, the | |
1161 | * collection is not there, so we cannot print the | |
1162 | * timestamps. | |
1163 | */ | |
1164 | if ((&file_stream->parent)->stream_class->trace->parent.collection) { | |
2328c2cd | 1165 | ctf_print_discarded_lost(stderr, &file_stream->parent); |
2654fe9b MD |
1166 | } |
1167 | ||
992e8cc0 | 1168 | packet_index = &g_array_index(pos->packet_index, |
03798a93 JD |
1169 | struct packet_index, |
1170 | pos->cur_index); | |
992e8cc0 | 1171 | file_stream->parent.cycles_timestamp = packet_index->ts_cycles.timestamp_begin; |
03798a93 | 1172 | |
992e8cc0 | 1173 | file_stream->parent.real_timestamp = packet_index->ts_real.timestamp_begin; |
8c572eba MD |
1174 | |
1175 | /* Lookup context/packet size in index */ | |
e69dd258 JD |
1176 | if (packet_index->data_offset == -1) { |
1177 | ret = find_data_offset(pos, file_stream, packet_index); | |
1178 | if (ret < 0) { | |
7b563a77 MD |
1179 | ret = -1; |
1180 | goto end; | |
e69dd258 JD |
1181 | } |
1182 | } | |
7f965b97 MD |
1183 | |
1184 | if (packet_index->packet_size > ((uint64_t) pos->file_length - packet_index->offset) * CHAR_BIT) { | |
1185 | fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n", | |
1186 | packet_index->packet_size, ((uint64_t) pos->file_length - packet_index->offset) * CHAR_BIT); | |
1187 | ret = -1; | |
1188 | goto end; | |
1189 | } | |
1190 | ||
20d0dcf9 MD |
1191 | pos->content_size = packet_index->content_size; |
1192 | pos->packet_size = packet_index->packet_size; | |
e69dd258 | 1193 | pos->mmap_offset = packet_index->offset; |
500634be JD |
1194 | pos->data_offset = packet_index->data_offset; |
1195 | if (pos->data_offset < packet_index->content_size) { | |
75cc2c35 | 1196 | pos->offset = 0; /* will read headers */ |
500634be | 1197 | } else if (pos->data_offset == packet_index->content_size) { |
5f643ed7 | 1198 | /* empty packet */ |
20d0dcf9 | 1199 | pos->offset = packet_index->data_offset; |
3abe83c7 | 1200 | whence = SEEK_CUR; |
5f643ed7 | 1201 | goto read_next_packet; |
7eda6fc7 | 1202 | } else { |
2b9a764d | 1203 | pos->offset = EOF; |
7b563a77 MD |
1204 | ret = 0; |
1205 | goto end; | |
2b9a764d | 1206 | } |
8c572eba | 1207 | } |
0f980a35 | 1208 | /* map new base. Need mapping length from header. */ |
aee35fcc MD |
1209 | pos->base_mma = mmap_align(pos->packet_size / CHAR_BIT, pos->prot, |
1210 | pos->flags, pos->fd, pos->mmap_offset); | |
1211 | if (pos->base_mma == MAP_FAILED) { | |
3394d22e | 1212 | fprintf(stderr, "[error] mmap error %s.\n", |
847bf71a MD |
1213 | strerror(errno)); |
1214 | assert(0); | |
1215 | } | |
75cc2c35 MD |
1216 | |
1217 | /* update trace_packet_header and stream_packet_context */ | |
fcf10417 JG |
1218 | if (!(pos->prot & PROT_WRITE) && |
1219 | file_stream->parent.trace_packet_header) { | |
75cc2c35 | 1220 | /* Read packet header */ |
2d0bea29 | 1221 | ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p); |
75cc2c35 MD |
1222 | assert(!ret); |
1223 | } | |
fcf10417 JG |
1224 | if (!(pos->prot & PROT_WRITE) && |
1225 | file_stream->parent.stream_packet_context) { | |
75cc2c35 | 1226 | /* Read packet context */ |
2d0bea29 | 1227 | ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p); |
75cc2c35 MD |
1228 | assert(!ret); |
1229 | } | |
7b563a77 MD |
1230 | ret = 0; |
1231 | end: | |
1232 | bt_packet_seek_set_error(ret); | |
0f980a35 MD |
1233 | } |
1234 | ||
b4c19c1e MD |
1235 | static |
1236 | int packet_metadata(struct ctf_trace *td, FILE *fp) | |
1237 | { | |
1238 | uint32_t magic; | |
1239 | size_t len; | |
1240 | int ret = 0; | |
1241 | ||
1242 | len = fread(&magic, sizeof(magic), 1, fp); | |
a0fe7d97 | 1243 | if (len != 1) { |
b4c19c1e MD |
1244 | goto end; |
1245 | } | |
1246 | if (magic == TSDL_MAGIC) { | |
1247 | ret = 1; | |
1248 | td->byte_order = BYTE_ORDER; | |
0d336fdf | 1249 | CTF_TRACE_SET_FIELD(td, byte_order); |
b4c19c1e MD |
1250 | } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) { |
1251 | ret = 1; | |
1252 | td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ? | |
1253 | LITTLE_ENDIAN : BIG_ENDIAN; | |
0d336fdf | 1254 | CTF_TRACE_SET_FIELD(td, byte_order); |
b4c19c1e MD |
1255 | } |
1256 | end: | |
1257 | rewind(fp); | |
1258 | return ret; | |
1259 | } | |
1260 | ||
5c262147 MD |
1261 | /* |
1262 | * Returns 0 on success, -1 on error. | |
1263 | */ | |
1264 | static | |
1265 | int check_version(unsigned int major, unsigned int minor) | |
1266 | { | |
1267 | switch (major) { | |
1268 | case 1: | |
1269 | switch (minor) { | |
1270 | case 8: | |
1271 | return 0; | |
1272 | default: | |
1273 | goto warning; | |
1274 | } | |
1275 | default: | |
1276 | goto warning; | |
1277 | ||
1278 | } | |
1279 | ||
1280 | /* eventually return an error instead of warning */ | |
1281 | warning: | |
3394d22e | 1282 | fprintf(stderr, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n", |
5c262147 MD |
1283 | major, minor); |
1284 | return 0; | |
1285 | } | |
1286 | ||
b4c19c1e | 1287 | static |
0c880b0a | 1288 | int ctf_trace_metadata_packet_read(struct ctf_trace *td, FILE *in, |
b4c19c1e MD |
1289 | FILE *out) |
1290 | { | |
1291 | struct metadata_packet_header header; | |
a0fe7d97 | 1292 | size_t readlen, writelen, toread; |
f8254867 | 1293 | char buf[4096 + 1]; /* + 1 for debug-mode \0 */ |
b4c19c1e MD |
1294 | int ret = 0; |
1295 | ||
a91a962e | 1296 | readlen = fread(&header, header_sizeof(header), 1, in); |
a0fe7d97 | 1297 | if (readlen < 1) |
b4c19c1e MD |
1298 | return -EINVAL; |
1299 | ||
1300 | if (td->byte_order != BYTE_ORDER) { | |
1301 | header.magic = GUINT32_SWAP_LE_BE(header.magic); | |
1302 | header.checksum = GUINT32_SWAP_LE_BE(header.checksum); | |
1303 | header.content_size = GUINT32_SWAP_LE_BE(header.content_size); | |
1304 | header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size); | |
1305 | } | |
1306 | if (header.checksum) | |
3394d22e | 1307 | fprintf(stderr, "[warning] checksum verification not supported yet.\n"); |
b4c19c1e | 1308 | if (header.compression_scheme) { |
3394d22e | 1309 | fprintf(stderr, "[error] compression (%u) not supported yet.\n", |
b4c19c1e MD |
1310 | header.compression_scheme); |
1311 | return -EINVAL; | |
1312 | } | |
1313 | if (header.encryption_scheme) { | |
3394d22e | 1314 | fprintf(stderr, "[error] encryption (%u) not supported yet.\n", |
b4c19c1e MD |
1315 | header.encryption_scheme); |
1316 | return -EINVAL; | |
1317 | } | |
1318 | if (header.checksum_scheme) { | |
3394d22e | 1319 | fprintf(stderr, "[error] checksum (%u) not supported yet.\n", |
b4c19c1e MD |
1320 | header.checksum_scheme); |
1321 | return -EINVAL; | |
1322 | } | |
5c262147 MD |
1323 | if (check_version(header.major, header.minor) < 0) |
1324 | return -EINVAL; | |
b4c19c1e MD |
1325 | if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) { |
1326 | memcpy(td->uuid, header.uuid, sizeof(header.uuid)); | |
1327 | CTF_TRACE_SET_FIELD(td, uuid); | |
1328 | } else { | |
72a3bc16 | 1329 | if (bt_uuid_compare(header.uuid, td->uuid)) |
b4c19c1e MD |
1330 | return -EINVAL; |
1331 | } | |
1332 | ||
b1ccd079 MD |
1333 | if ((header.content_size / CHAR_BIT) < header_sizeof(header)) |
1334 | return -EINVAL; | |
1335 | ||
255b2138 | 1336 | toread = (header.content_size / CHAR_BIT) - header_sizeof(header); |
a0fe7d97 MD |
1337 | |
1338 | for (;;) { | |
f8254867 | 1339 | readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in); |
b4c19c1e MD |
1340 | if (ferror(in)) { |
1341 | ret = -EINVAL; | |
1342 | break; | |
1343 | } | |
4152822b | 1344 | if (babeltrace_debug) { |
f8254867 | 1345 | buf[readlen] = '\0'; |
3394d22e | 1346 | fprintf(stderr, "[debug] metadata packet read: %s\n", |
4152822b MD |
1347 | buf); |
1348 | } | |
1349 | ||
b4c19c1e MD |
1350 | writelen = fwrite(buf, sizeof(char), readlen, out); |
1351 | if (writelen < readlen) { | |
1352 | ret = -EIO; | |
1353 | break; | |
1354 | } | |
1355 | if (ferror(out)) { | |
1356 | ret = -EINVAL; | |
1357 | break; | |
1358 | } | |
a0fe7d97 MD |
1359 | toread -= readlen; |
1360 | if (!toread) { | |
7f4b5c4d | 1361 | ret = 0; /* continue reading next packet */ |
ddbc52af | 1362 | goto read_padding; |
a0fe7d97 | 1363 | } |
b4c19c1e MD |
1364 | } |
1365 | return ret; | |
ddbc52af MD |
1366 | |
1367 | read_padding: | |
1368 | toread = (header.packet_size - header.content_size) / CHAR_BIT; | |
1369 | ret = fseek(in, toread, SEEK_CUR); | |
1370 | if (ret < 0) { | |
3394d22e | 1371 | fprintf(stderr, "[warning] Missing padding at end of file\n"); |
ddbc52af MD |
1372 | ret = 0; |
1373 | } | |
1374 | return ret; | |
b4c19c1e MD |
1375 | } |
1376 | ||
1377 | static | |
0c880b0a | 1378 | int ctf_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp, |
b4c19c1e MD |
1379 | char **buf) |
1380 | { | |
1381 | FILE *in, *out; | |
abc40d24 | 1382 | size_t size, buflen; |
b4c19c1e MD |
1383 | int ret; |
1384 | ||
1385 | in = *fp; | |
c4f5487e MD |
1386 | /* |
1387 | * Using strlen on *buf instead of size of open_memstream | |
1388 | * because its size includes garbage at the end (after final | |
1389 | * \0). This is the allocated size, not the actual string size. | |
1390 | */ | |
f8370579 | 1391 | out = babeltrace_open_memstream(buf, &size); |
a569a564 MD |
1392 | if (out == NULL) { |
1393 | perror("Metadata open_memstream"); | |
b4c19c1e | 1394 | return -errno; |
a569a564 | 1395 | } |
b4c19c1e | 1396 | for (;;) { |
0c880b0a | 1397 | ret = ctf_trace_metadata_packet_read(td, in, out); |
7f4b5c4d | 1398 | if (ret) { |
b4c19c1e | 1399 | break; |
7f4b5c4d MD |
1400 | } |
1401 | if (feof(in)) { | |
1402 | ret = 0; | |
b4c19c1e MD |
1403 | break; |
1404 | } | |
1405 | } | |
f8370579 MD |
1406 | /* close to flush the buffer */ |
1407 | ret = babeltrace_close_memstream(buf, &size, out); | |
1408 | if (ret < 0) { | |
f824ae04 MD |
1409 | int closeret; |
1410 | ||
f8370579 | 1411 | perror("babeltrace_flush_memstream"); |
f824ae04 MD |
1412 | ret = -errno; |
1413 | closeret = fclose(in); | |
1414 | if (closeret) { | |
1415 | perror("Error in fclose"); | |
1416 | } | |
1417 | return ret; | |
1418 | } | |
1419 | ret = fclose(in); | |
1420 | if (ret) { | |
1421 | perror("Error in fclose"); | |
f8370579 | 1422 | } |
b4c19c1e | 1423 | /* open for reading */ |
abc40d24 MD |
1424 | buflen = strlen(*buf); |
1425 | if (!buflen) { | |
1426 | *fp = NULL; | |
493330cb | 1427 | return -ENOENT; |
abc40d24 MD |
1428 | } |
1429 | *fp = babeltrace_fmemopen(*buf, buflen, "rb"); | |
a569a564 MD |
1430 | if (!*fp) { |
1431 | perror("Metadata fmemopen"); | |
1432 | return -errno; | |
1433 | } | |
b4c19c1e MD |
1434 | return 0; |
1435 | } | |
1436 | ||
65102a8c | 1437 | static |
0c880b0a MD |
1438 | int ctf_trace_metadata_read(struct ctf_trace *td, FILE *metadata_fp, |
1439 | struct ctf_scanner *scanner, int append) | |
65102a8c | 1440 | { |
2d0bea29 | 1441 | struct ctf_file_stream *metadata_stream; |
65102a8c | 1442 | FILE *fp; |
b4c19c1e | 1443 | char *buf = NULL; |
f824ae04 | 1444 | int ret = 0, closeret; |
65102a8c | 1445 | |
2d0bea29 | 1446 | metadata_stream = g_new0(struct ctf_file_stream, 1); |
3a25e036 | 1447 | metadata_stream->pos.last_offset = LAST_OFFSET_POISON; |
b086c01a | 1448 | |
ae23d232 JD |
1449 | if (metadata_fp) { |
1450 | fp = metadata_fp; | |
bcbfb8bf | 1451 | metadata_stream->pos.fd = -1; |
ae23d232 JD |
1452 | } else { |
1453 | td->metadata = &metadata_stream->parent; | |
1454 | metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY); | |
1455 | if (metadata_stream->pos.fd < 0) { | |
3394d22e | 1456 | fprintf(stderr, "Unable to open metadata.\n"); |
f824ae04 MD |
1457 | ret = -1; |
1458 | goto end_free; | |
ae23d232 | 1459 | } |
65102a8c | 1460 | |
ae23d232 JD |
1461 | fp = fdopen(metadata_stream->pos.fd, "r"); |
1462 | if (!fp) { | |
3394d22e | 1463 | fprintf(stderr, "[error] Unable to open metadata stream.\n"); |
a569a564 | 1464 | perror("Metadata stream open"); |
ae23d232 JD |
1465 | ret = -errno; |
1466 | goto end_stream; | |
1467 | } | |
f824ae04 MD |
1468 | /* fd now belongs to fp */ |
1469 | metadata_stream->pos.fd = -1; | |
ae23d232 | 1470 | } |
65102a8c MD |
1471 | if (babeltrace_debug) |
1472 | yydebug = 1; | |
1473 | ||
b4c19c1e | 1474 | if (packet_metadata(td, fp)) { |
0c880b0a | 1475 | ret = ctf_trace_metadata_stream_read(td, &fp, &buf); |
abc40d24 | 1476 | if (ret) { |
6514b4af | 1477 | goto end; |
abc40d24 | 1478 | } |
7237592a MD |
1479 | td->metadata_string = buf; |
1480 | td->metadata_packetized = 1; | |
da75b0f7 | 1481 | } else { |
0c880b0a MD |
1482 | if (!append) { |
1483 | unsigned int major, minor; | |
1484 | ssize_t nr_items; | |
1485 | ||
1486 | td->byte_order = BYTE_ORDER; | |
1487 | ||
1488 | /* Check text-only metadata header and version */ | |
1489 | nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor); | |
1490 | if (nr_items < 2) | |
1491 | fprintf(stderr, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n"); | |
1492 | if (check_version(major, minor) < 0) { | |
1493 | ret = -EINVAL; | |
1494 | goto end; | |
1495 | } | |
1496 | rewind(fp); | |
5c262147 | 1497 | } |
b4c19c1e MD |
1498 | } |
1499 | ||
cb2f43ee | 1500 | ret = ctf_scanner_append_ast(scanner, fp); |
65102a8c | 1501 | if (ret) { |
3394d22e | 1502 | fprintf(stderr, "[error] Error creating AST\n"); |
65102a8c MD |
1503 | goto end; |
1504 | } | |
1505 | ||
1506 | if (babeltrace_debug) { | |
3394d22e | 1507 | ret = ctf_visitor_print_xml(stderr, 0, &scanner->ast->root); |
65102a8c | 1508 | if (ret) { |
3394d22e | 1509 | fprintf(stderr, "[error] Error visiting AST for XML output\n"); |
65102a8c MD |
1510 | goto end; |
1511 | } | |
1512 | } | |
1513 | ||
3394d22e | 1514 | ret = ctf_visitor_semantic_check(stderr, 0, &scanner->ast->root); |
65102a8c | 1515 | if (ret) { |
3394d22e | 1516 | fprintf(stderr, "[error] Error in CTF semantic validation %d\n", ret); |
65102a8c MD |
1517 | goto end; |
1518 | } | |
3394d22e | 1519 | ret = ctf_visitor_construct_metadata(stderr, 0, &scanner->ast->root, |
ac5c6ca0 | 1520 | td, td->byte_order); |
65102a8c | 1521 | if (ret) { |
3394d22e | 1522 | fprintf(stderr, "[error] Error in CTF metadata constructor %d\n", ret); |
65102a8c MD |
1523 | goto end; |
1524 | } | |
1525 | end: | |
f824ae04 MD |
1526 | if (fp) { |
1527 | closeret = fclose(fp); | |
1528 | if (closeret) { | |
1529 | perror("Error on fclose"); | |
1530 | } | |
1531 | } | |
65102a8c | 1532 | end_stream: |
f824ae04 MD |
1533 | if (metadata_stream->pos.fd >= 0) { |
1534 | closeret = close(metadata_stream->pos.fd); | |
1535 | if (closeret) { | |
1536 | perror("Error on metadata stream fd close"); | |
1537 | } | |
1538 | } | |
1539 | end_free: | |
2d0bea29 MD |
1540 | if (ret) |
1541 | g_free(metadata_stream); | |
0f980a35 MD |
1542 | return ret; |
1543 | } | |
1544 | ||
e28d4618 | 1545 | static |
c716f83b | 1546 | struct ctf_event_definition *create_event_definitions(struct ctf_trace *td, |
9e88d150 | 1547 | struct ctf_stream_definition *stream, |
4716614a | 1548 | struct ctf_event_declaration *event) |
e28d4618 | 1549 | { |
c716f83b | 1550 | struct ctf_event_definition *stream_event = g_new0(struct ctf_event_definition, 1); |
e28d4618 MD |
1551 | |
1552 | if (event->context_decl) { | |
0d69b916 | 1553 | struct bt_definition *definition = |
e28d4618 MD |
1554 | event->context_decl->p.definition_new(&event->context_decl->p, |
1555 | stream->parent_def_scope, 0, 0, "event.context"); | |
1556 | if (!definition) { | |
1557 | goto error; | |
1558 | } | |
42dc00b7 | 1559 | stream_event->event_context = container_of(definition, |
e28d4618 | 1560 | struct definition_struct, p); |
42dc00b7 | 1561 | stream->parent_def_scope = stream_event->event_context->p.scope; |
e28d4618 MD |
1562 | } |
1563 | if (event->fields_decl) { | |
0d69b916 | 1564 | struct bt_definition *definition = |
e28d4618 MD |
1565 | event->fields_decl->p.definition_new(&event->fields_decl->p, |
1566 | stream->parent_def_scope, 0, 0, "event.fields"); | |
1567 | if (!definition) { | |
1568 | goto error; | |
1569 | } | |
42dc00b7 | 1570 | stream_event->event_fields = container_of(definition, |
e28d4618 | 1571 | struct definition_struct, p); |
42dc00b7 | 1572 | stream->parent_def_scope = stream_event->event_fields->p.scope; |
e28d4618 | 1573 | } |
d3ded99d | 1574 | stream_event->stream = stream; |
42dc00b7 | 1575 | return stream_event; |
e28d4618 MD |
1576 | |
1577 | error: | |
42dc00b7 | 1578 | if (stream_event->event_fields) |
13fad8b6 | 1579 | bt_definition_unref(&stream_event->event_fields->p); |
42dc00b7 | 1580 | if (stream_event->event_context) |
13fad8b6 | 1581 | bt_definition_unref(&stream_event->event_context->p); |
888ec52a MD |
1582 | fprintf(stderr, "[error] Unable to create event definition for event \"%s\".\n", |
1583 | g_quark_to_string(event->name)); | |
e28d4618 MD |
1584 | return NULL; |
1585 | } | |
1586 | ||
0c880b0a MD |
1587 | static |
1588 | int copy_event_declarations_stream_class_to_stream(struct ctf_trace *td, | |
1589 | struct ctf_stream_declaration *stream_class, | |
1590 | struct ctf_stream_definition *stream) | |
1591 | { | |
1592 | size_t def_size, class_size, i; | |
1593 | int ret = 0; | |
1594 | ||
1595 | def_size = stream->events_by_id->len; | |
1596 | class_size = stream_class->events_by_id->len; | |
1597 | ||
1598 | g_ptr_array_set_size(stream->events_by_id, class_size); | |
1599 | for (i = def_size; i < class_size; i++) { | |
1600 | struct ctf_event_declaration *event = | |
1601 | g_ptr_array_index(stream_class->events_by_id, i); | |
1602 | struct ctf_event_definition *stream_event; | |
1603 | ||
1604 | if (!event) | |
1605 | continue; | |
1606 | stream_event = create_event_definitions(td, stream, event); | |
1607 | if (!stream_event) { | |
1608 | ret = -EINVAL; | |
1609 | goto error; | |
1610 | } | |
1611 | g_ptr_array_index(stream->events_by_id, i) = stream_event; | |
1612 | } | |
1613 | error: | |
1614 | return ret; | |
1615 | } | |
1616 | ||
e28d4618 | 1617 | static |
9e88d150 | 1618 | int create_stream_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream) |
e28d4618 | 1619 | { |
f380e105 | 1620 | struct ctf_stream_declaration *stream_class; |
e28d4618 MD |
1621 | int ret; |
1622 | int i; | |
1623 | ||
1624 | if (stream->stream_definitions_created) | |
1625 | return 0; | |
1626 | ||
1627 | stream_class = stream->stream_class; | |
1628 | ||
1629 | if (stream_class->packet_context_decl) { | |
0d69b916 | 1630 | struct bt_definition *definition = |
e28d4618 MD |
1631 | stream_class->packet_context_decl->p.definition_new(&stream_class->packet_context_decl->p, |
1632 | stream->parent_def_scope, 0, 0, "stream.packet.context"); | |
1633 | if (!definition) { | |
1634 | ret = -EINVAL; | |
1635 | goto error; | |
1636 | } | |
1637 | stream->stream_packet_context = container_of(definition, | |
1638 | struct definition_struct, p); | |
1639 | stream->parent_def_scope = stream->stream_packet_context->p.scope; | |
1640 | } | |
1641 | if (stream_class->event_header_decl) { | |
0d69b916 | 1642 | struct bt_definition *definition = |
e28d4618 MD |
1643 | stream_class->event_header_decl->p.definition_new(&stream_class->event_header_decl->p, |
1644 | stream->parent_def_scope, 0, 0, "stream.event.header"); | |
1645 | if (!definition) { | |
1646 | ret = -EINVAL; | |
1647 | goto error; | |
1648 | } | |
1649 | stream->stream_event_header = | |
1650 | container_of(definition, struct definition_struct, p); | |
1651 | stream->parent_def_scope = stream->stream_event_header->p.scope; | |
1652 | } | |
1653 | if (stream_class->event_context_decl) { | |
0d69b916 | 1654 | struct bt_definition *definition = |
e28d4618 MD |
1655 | stream_class->event_context_decl->p.definition_new(&stream_class->event_context_decl->p, |
1656 | stream->parent_def_scope, 0, 0, "stream.event.context"); | |
1657 | if (!definition) { | |
1658 | ret = -EINVAL; | |
1659 | goto error; | |
1660 | } | |
1661 | stream->stream_event_context = | |
1662 | container_of(definition, struct definition_struct, p); | |
1663 | stream->parent_def_scope = stream->stream_event_context->p.scope; | |
1664 | } | |
1665 | stream->events_by_id = g_ptr_array_new(); | |
0c880b0a MD |
1666 | ret = copy_event_declarations_stream_class_to_stream(td, |
1667 | stream_class, stream); | |
1668 | if (ret) | |
1669 | goto error_event; | |
e28d4618 MD |
1670 | return 0; |
1671 | ||
1672 | error_event: | |
1673 | for (i = 0; i < stream->events_by_id->len; i++) { | |
c716f83b | 1674 | struct ctf_event_definition *stream_event = g_ptr_array_index(stream->events_by_id, i); |
42dc00b7 MD |
1675 | if (stream_event) |
1676 | g_free(stream_event); | |
e28d4618 MD |
1677 | } |
1678 | g_ptr_array_free(stream->events_by_id, TRUE); | |
1679 | error: | |
1680 | if (stream->stream_event_context) | |
13fad8b6 | 1681 | bt_definition_unref(&stream->stream_event_context->p); |
e28d4618 | 1682 | if (stream->stream_event_header) |
13fad8b6 | 1683 | bt_definition_unref(&stream->stream_event_header->p); |
e28d4618 | 1684 | if (stream->stream_packet_context) |
13fad8b6 | 1685 | bt_definition_unref(&stream->stream_packet_context->p); |
888ec52a MD |
1686 | fprintf(stderr, "[error] Unable to create stream (%" PRIu64 ") definitions: %s\n", |
1687 | stream_class->stream_id, strerror(-ret)); | |
e28d4618 MD |
1688 | return ret; |
1689 | } | |
1690 | ||
5bfcad93 MD |
1691 | static |
1692 | int stream_assign_class(struct ctf_trace *td, | |
1693 | struct ctf_file_stream *file_stream, | |
1694 | uint64_t stream_id) | |
1695 | { | |
1696 | struct ctf_stream_declaration *stream; | |
1697 | int ret; | |
1698 | ||
1699 | file_stream->parent.stream_id = stream_id; | |
1700 | if (stream_id >= td->streams->len) { | |
1701 | fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); | |
1702 | return -EINVAL; | |
1703 | } | |
1704 | stream = g_ptr_array_index(td->streams, stream_id); | |
1705 | if (!stream) { | |
1706 | fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id); | |
1707 | return -EINVAL; | |
1708 | } | |
1709 | file_stream->parent.stream_class = stream; | |
1710 | ret = create_stream_definitions(td, &file_stream->parent); | |
1711 | if (ret) | |
1712 | return ret; | |
1713 | return 0; | |
1714 | } | |
1715 | ||
0f980a35 | 1716 | static |
ec323464 MD |
1717 | int create_stream_one_packet_index(struct ctf_stream_pos *pos, |
1718 | struct ctf_trace *td, | |
7f965b97 | 1719 | struct ctf_file_stream *file_stream) |
0f980a35 | 1720 | { |
ec323464 | 1721 | struct packet_index packet_index; |
ec323464 | 1722 | uint64_t stream_id = 0; |
653906a4 | 1723 | uint64_t packet_map_len = DEFAULT_HEADER_LEN, tmp_map_len; |
ec323464 | 1724 | int first_packet = 0; |
653906a4 | 1725 | int len_index; |
0f980a35 MD |
1726 | int ret; |
1727 | ||
ec323464 | 1728 | begin: |
5f75b32d | 1729 | memset(&packet_index, 0, sizeof(packet_index)); |
ec323464 MD |
1730 | if (!pos->mmap_offset) { |
1731 | first_packet = 1; | |
1732 | } | |
8895362d | 1733 | |
7f965b97 MD |
1734 | if (pos->file_length - pos->mmap_offset < (packet_map_len >> LOG2_CHAR_BIT)) { |
1735 | packet_map_len = (pos->file_length - pos->mmap_offset) << LOG2_CHAR_BIT; | |
ec323464 | 1736 | } |
0f980a35 | 1737 | |
ec323464 MD |
1738 | if (pos->base_mma) { |
1739 | /* unmap old base */ | |
1740 | ret = munmap_align(pos->base_mma); | |
1741 | if (ret) { | |
1742 | fprintf(stderr, "[error] Unable to unmap old base: %s.\n", | |
1743 | strerror(errno)); | |
1744 | return ret; | |
0f980a35 | 1745 | } |
ec323464 MD |
1746 | pos->base_mma = NULL; |
1747 | } | |
1748 | /* map new base. Need mapping length from header. */ | |
1749 | pos->base_mma = mmap_align(packet_map_len >> LOG2_CHAR_BIT, PROT_READ, | |
1750 | MAP_PRIVATE, pos->fd, pos->mmap_offset); | |
1751 | assert(pos->base_mma != MAP_FAILED); | |
1752 | /* | |
1753 | * Use current mapping size as temporary content and packet | |
1754 | * size. | |
1755 | */ | |
1756 | pos->content_size = packet_map_len; | |
1757 | pos->packet_size = packet_map_len; | |
1758 | pos->offset = 0; /* Position of the packet header */ | |
1759 | ||
1760 | packet_index.offset = pos->mmap_offset; | |
ec323464 MD |
1761 | |
1762 | /* read and check header, set stream id (and check) */ | |
1763 | if (file_stream->parent.trace_packet_header) { | |
1764 | /* Read packet header */ | |
1765 | ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p); | |
1766 | if (ret) { | |
1767 | if (ret == -EFAULT) | |
1768 | goto retry; | |
888ec52a | 1769 | fprintf(stderr, "[error] Unable to read packet header: %s\n", strerror(-ret)); |
ec323464 MD |
1770 | return ret; |
1771 | } | |
1772 | len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic")); | |
1773 | if (len_index >= 0) { | |
1774 | struct bt_definition *field; | |
1775 | uint64_t magic; | |
1776 | ||
1777 | field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); | |
1778 | magic = bt_get_unsigned_int(field); | |
1779 | if (magic != CTF_MAGIC) { | |
1780 | fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n", | |
1781 | magic, | |
992e8cc0 | 1782 | file_stream->pos.packet_index->len, |
ec323464 MD |
1783 | (ssize_t) pos->mmap_offset); |
1784 | return -EINVAL; | |
0f980a35 | 1785 | } |
ec323464 | 1786 | } |
0f980a35 | 1787 | |
ec323464 MD |
1788 | /* check uuid */ |
1789 | len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid")); | |
1790 | if (len_index >= 0) { | |
1791 | struct definition_array *defarray; | |
1792 | struct bt_definition *field; | |
1793 | uint64_t i; | |
1794 | uint8_t uuidval[BABELTRACE_UUID_LEN]; | |
0f980a35 | 1795 | |
ec323464 MD |
1796 | field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); |
1797 | assert(field->declaration->id == CTF_TYPE_ARRAY); | |
1798 | defarray = container_of(field, struct definition_array, p); | |
1799 | assert(bt_array_len(defarray) == BABELTRACE_UUID_LEN); | |
0f980a35 | 1800 | |
ec323464 MD |
1801 | for (i = 0; i < BABELTRACE_UUID_LEN; i++) { |
1802 | struct bt_definition *elem; | |
0f980a35 | 1803 | |
ec323464 MD |
1804 | elem = bt_array_index(defarray, i); |
1805 | uuidval[i] = bt_get_unsigned_int(elem); | |
0f980a35 | 1806 | } |
72a3bc16 | 1807 | ret = bt_uuid_compare(td->uuid, uuidval); |
ec323464 MD |
1808 | if (ret) { |
1809 | fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n"); | |
1810 | return -EINVAL; | |
1811 | } | |
1812 | } | |
0f980a35 | 1813 | |
ec323464 MD |
1814 | len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id")); |
1815 | if (len_index >= 0) { | |
1816 | struct bt_definition *field; | |
0f980a35 | 1817 | |
ec323464 MD |
1818 | field = bt_struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index); |
1819 | stream_id = bt_get_unsigned_int(field); | |
0f980a35 | 1820 | } |
ec323464 | 1821 | } |
0f980a35 | 1822 | |
ec323464 MD |
1823 | if (!first_packet && file_stream->parent.stream_id != stream_id) { |
1824 | fprintf(stderr, "[error] Stream ID is changing within a stream: expecting %" PRIu64 ", but packet has %" PRIu64 "\n", | |
1825 | stream_id, | |
1826 | file_stream->parent.stream_id); | |
1827 | return -EINVAL; | |
1828 | } | |
1829 | if (first_packet) { | |
5bfcad93 | 1830 | ret = stream_assign_class(td, file_stream, stream_id); |
ec323464 MD |
1831 | if (ret) |
1832 | return ret; | |
1833 | } | |
dc48ecad | 1834 | |
ec323464 MD |
1835 | if (file_stream->parent.stream_packet_context) { |
1836 | /* Read packet context */ | |
1837 | ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p); | |
1838 | if (ret) { | |
1839 | if (ret == -EFAULT) | |
1840 | goto retry; | |
888ec52a | 1841 | fprintf(stderr, "[error] Unable to read packet context: %s\n", strerror(-ret)); |
ec323464 MD |
1842 | return ret; |
1843 | } | |
95b34f38 MD |
1844 | /* read packet size from header */ |
1845 | len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size")); | |
ec323464 MD |
1846 | if (len_index >= 0) { |
1847 | struct bt_definition *field; | |
dc48ecad | 1848 | |
ec323464 | 1849 | field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); |
95b34f38 | 1850 | packet_index.packet_size = bt_get_unsigned_int(field); |
ec323464 MD |
1851 | } else { |
1852 | /* Use file size for packet size */ | |
7f965b97 | 1853 | packet_index.packet_size = pos->file_length * CHAR_BIT; |
ec323464 | 1854 | } |
75cc2c35 | 1855 | |
95b34f38 MD |
1856 | /* read content size from header */ |
1857 | len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size")); | |
ec323464 MD |
1858 | if (len_index >= 0) { |
1859 | struct bt_definition *field; | |
75cc2c35 | 1860 | |
ec323464 | 1861 | field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); |
95b34f38 | 1862 | packet_index.content_size = bt_get_unsigned_int(field); |
ec323464 | 1863 | } else { |
95b34f38 | 1864 | /* Use packet size if non-zero, else file size */ |
7f965b97 | 1865 | packet_index.content_size = packet_index.packet_size ? : pos->file_length * CHAR_BIT; |
ec323464 | 1866 | } |
41e82e00 | 1867 | |
ec323464 MD |
1868 | /* read timestamp begin from header */ |
1869 | len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin")); | |
1870 | if (len_index >= 0) { | |
1871 | struct bt_definition *field; | |
41e82e00 | 1872 | |
ec323464 | 1873 | field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); |
992e8cc0 | 1874 | packet_index.ts_cycles.timestamp_begin = bt_get_unsigned_int(field); |
4c62e2d8 | 1875 | if (file_stream->parent.stream_class->trace->parent.collection) { |
992e8cc0 | 1876 | packet_index.ts_real.timestamp_begin = |
ec323464 MD |
1877 | ctf_get_real_timestamp( |
1878 | &file_stream->parent, | |
992e8cc0 | 1879 | packet_index.ts_cycles.timestamp_begin); |
41e82e00 | 1880 | } |
0f980a35 | 1881 | } |
546293fa | 1882 | |
ec323464 MD |
1883 | /* read timestamp end from header */ |
1884 | len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end")); | |
1885 | if (len_index >= 0) { | |
1886 | struct bt_definition *field; | |
1887 | ||
1888 | field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); | |
992e8cc0 | 1889 | packet_index.ts_cycles.timestamp_end = bt_get_unsigned_int(field); |
4c62e2d8 | 1890 | if (file_stream->parent.stream_class->trace->parent.collection) { |
992e8cc0 | 1891 | packet_index.ts_real.timestamp_end = |
ec323464 MD |
1892 | ctf_get_real_timestamp( |
1893 | &file_stream->parent, | |
992e8cc0 | 1894 | packet_index.ts_cycles.timestamp_end); |
ec323464 | 1895 | } |
546293fa MD |
1896 | } |
1897 | ||
ec323464 MD |
1898 | /* read events discarded from header */ |
1899 | len_index = bt_struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded")); | |
1900 | if (len_index >= 0) { | |
1901 | struct bt_definition *field; | |
1902 | ||
1903 | field = bt_struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index); | |
1904 | packet_index.events_discarded = bt_get_unsigned_int(field); | |
1905 | packet_index.events_discarded_len = bt_get_int_len(field); | |
546293fa | 1906 | } |
2328c2cd JD |
1907 | |
1908 | /* read packet_seq_num from header */ | |
1909 | len_index = bt_struct_declaration_lookup_field_index( | |
1910 | file_stream->parent.stream_packet_context->declaration, | |
1911 | g_quark_from_static_string("packet_seq_num")); | |
1912 | if (len_index >= 0) { | |
1913 | struct bt_definition *field; | |
1914 | ||
1915 | field = bt_struct_definition_get_field_from_index( | |
1916 | file_stream->parent.stream_packet_context, | |
1917 | len_index); | |
1918 | packet_index.packet_seq_num = bt_get_unsigned_int(field); | |
1919 | } | |
ec323464 MD |
1920 | } else { |
1921 | /* Use file size for packet size */ | |
7f965b97 | 1922 | packet_index.packet_size = pos->file_length * CHAR_BIT; |
2d686891 | 1923 | /* Use packet size if non-zero, else file size */ |
7f965b97 | 1924 | packet_index.content_size = packet_index.packet_size ? : pos->file_length * CHAR_BIT; |
ec323464 MD |
1925 | } |
1926 | ||
1927 | /* Validate content size and packet size values */ | |
1928 | if (packet_index.content_size > packet_index.packet_size) { | |
1929 | fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n", | |
1930 | packet_index.content_size, packet_index.packet_size); | |
1931 | return -EINVAL; | |
1932 | } | |
1933 | ||
a7ac9efd MD |
1934 | if (packet_index.content_size < pos->offset) { |
1935 | fprintf(stderr, "[error] Invalid CTF stream: content size is smaller than packet headers.\n"); | |
1936 | return -EINVAL; | |
1937 | } | |
1938 | ||
2d686891 MD |
1939 | if ((packet_index.packet_size >> LOG2_CHAR_BIT) == 0) { |
1940 | fprintf(stderr, "[error] Invalid CTF stream: packet size needs to be at least one byte\n"); | |
1941 | return -EINVAL; | |
1942 | } | |
1943 | ||
ec323464 MD |
1944 | /* Save position after header and context */ |
1945 | packet_index.data_offset = pos->offset; | |
0f980a35 | 1946 | |
ec323464 | 1947 | /* add index to packet array */ |
992e8cc0 | 1948 | g_array_append_val(file_stream->pos.packet_index, packet_index); |
0f980a35 | 1949 | |
ec323464 MD |
1950 | pos->mmap_offset += packet_index.packet_size >> LOG2_CHAR_BIT; |
1951 | ||
1952 | return 0; | |
1953 | ||
1954 | /* Retry with larger mapping */ | |
1955 | retry: | |
7f965b97 | 1956 | if (packet_map_len == ((pos->file_length - pos->mmap_offset) << LOG2_CHAR_BIT)) { |
ec323464 MD |
1957 | /* |
1958 | * Reached EOF, but still expecting header/context data. | |
1959 | */ | |
1960 | fprintf(stderr, "[error] Reached end of file, but still expecting header or context fields.\n"); | |
1961 | return -EFAULT; | |
1962 | } | |
1963 | /* Double the mapping len, and retry */ | |
1964 | tmp_map_len = packet_map_len << 1; | |
1965 | if (tmp_map_len >> 1 != packet_map_len) { | |
1966 | /* Overflow */ | |
888ec52a | 1967 | fprintf(stderr, "[error] Packet mapping length overflow\n"); |
ec323464 | 1968 | return -EFAULT; |
0f980a35 | 1969 | } |
ec323464 MD |
1970 | packet_map_len = tmp_map_len; |
1971 | goto begin; | |
1972 | } | |
1973 | ||
1974 | static | |
1975 | int create_stream_packet_index(struct ctf_trace *td, | |
1976 | struct ctf_file_stream *file_stream) | |
1977 | { | |
1978 | struct ctf_stream_pos *pos; | |
ec323464 MD |
1979 | int ret; |
1980 | ||
1981 | pos = &file_stream->pos; | |
0f980a35 | 1982 | |
5bfcad93 | 1983 | /* Deal with empty files */ |
7f965b97 | 1984 | if (!pos->file_length) { |
5bfcad93 MD |
1985 | if (file_stream->parent.trace_packet_header |
1986 | || file_stream->parent.stream_packet_context) { | |
1987 | /* | |
1988 | * We expect a trace packet header and/or stream packet | |
1989 | * context. Since a trace needs to have at least one | |
1990 | * packet, empty files are therefore not accepted. | |
1991 | */ | |
1992 | fprintf(stderr, "[error] Encountered an empty file, but expecting a trace packet header.\n"); | |
1993 | return -EINVAL; | |
1994 | } else { | |
1995 | /* | |
1996 | * Without trace packet header nor stream packet | |
1997 | * context, a one-packet trace can indeed be empty. This | |
1998 | * is only valid if there is only one stream class: 0. | |
1999 | */ | |
2000 | ret = stream_assign_class(td, file_stream, 0); | |
2001 | if (ret) | |
2002 | return ret; | |
2003 | return 0; | |
2004 | } | |
2005 | } | |
2006 | ||
7f965b97 MD |
2007 | for (pos->mmap_offset = 0; pos->mmap_offset < pos->file_length; ) { |
2008 | ret = create_stream_one_packet_index(pos, td, file_stream); | |
ec323464 MD |
2009 | if (ret) |
2010 | return ret; | |
2011 | } | |
0f980a35 MD |
2012 | return 0; |
2013 | } | |
2014 | ||
e28d4618 | 2015 | static |
9e88d150 | 2016 | int create_trace_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream) |
e28d4618 MD |
2017 | { |
2018 | int ret; | |
2019 | ||
2020 | if (td->packet_header_decl) { | |
0d69b916 | 2021 | struct bt_definition *definition = |
e28d4618 MD |
2022 | td->packet_header_decl->p.definition_new(&td->packet_header_decl->p, |
2023 | stream->parent_def_scope, 0, 0, "trace.packet.header"); | |
2024 | if (!definition) { | |
2025 | ret = -EINVAL; | |
2026 | goto error; | |
2027 | } | |
2028 | stream->trace_packet_header = | |
2029 | container_of(definition, struct definition_struct, p); | |
2030 | stream->parent_def_scope = stream->trace_packet_header->p.scope; | |
2031 | } | |
2032 | ||
2033 | return 0; | |
2034 | ||
2035 | error: | |
888ec52a | 2036 | fprintf(stderr, "[error] Unable to create trace definitions: %s\n", strerror(-ret)); |
e28d4618 MD |
2037 | return ret; |
2038 | } | |
2039 | ||
0ace7505 JD |
2040 | static |
2041 | int import_stream_packet_index(struct ctf_trace *td, | |
2042 | struct ctf_file_stream *file_stream) | |
2043 | { | |
0ace7505 | 2044 | struct ctf_stream_pos *pos; |
3ecd366e | 2045 | struct ctf_packet_index *ctf_index = NULL; |
0ace7505 JD |
2046 | struct ctf_packet_index_file_hdr index_hdr; |
2047 | struct packet_index index; | |
138cb20b | 2048 | uint32_t packet_index_len, index_minor; |
0ace7505 JD |
2049 | int ret = 0; |
2050 | int first_packet = 1; | |
2051 | size_t len; | |
2052 | ||
2053 | pos = &file_stream->pos; | |
2054 | ||
2055 | len = fread(&index_hdr, sizeof(index_hdr), 1, pos->index_fp); | |
2056 | if (len != 1) { | |
2057 | perror("read index file header"); | |
2058 | goto error; | |
2059 | } | |
2060 | ||
2061 | /* Check the index header */ | |
2062 | if (be32toh(index_hdr.magic) != CTF_INDEX_MAGIC) { | |
2063 | fprintf(stderr, "[error] wrong index magic\n"); | |
2064 | ret = -1; | |
2065 | goto error; | |
2066 | } | |
2067 | if (be32toh(index_hdr.index_major) != CTF_INDEX_MAJOR) { | |
f84c13d9 MJ |
2068 | fprintf(stderr, "[error] Incompatible index file %" PRIu32 |
2069 | ".%" PRIu32 ", supported %d.%d\n", | |
2070 | be32toh(index_hdr.index_major), | |
2071 | be32toh(index_hdr.index_minor), CTF_INDEX_MAJOR, | |
0ace7505 JD |
2072 | CTF_INDEX_MINOR); |
2073 | ret = -1; | |
2074 | goto error; | |
2075 | } | |
138cb20b JD |
2076 | index_minor = be32toh(index_hdr.index_minor); |
2077 | ||
e83ce12a JD |
2078 | packet_index_len = be32toh(index_hdr.packet_index_len); |
2079 | if (packet_index_len == 0) { | |
a74d9cb2 MD |
2080 | fprintf(stderr, "[error] Packet index length cannot be 0.\n"); |
2081 | ret = -1; | |
2082 | goto error; | |
2083 | } | |
3ecd366e MD |
2084 | /* |
2085 | * Allocate the index length found in header, not internal | |
2086 | * representation. | |
2087 | */ | |
e83ce12a JD |
2088 | ctf_index = g_malloc0(packet_index_len); |
2089 | while (fread(ctf_index, packet_index_len, 1, | |
ad40ac1a | 2090 | pos->index_fp) == 1) { |
0ace7505 | 2091 | uint64_t stream_id; |
51e0087f | 2092 | struct ctf_stream_declaration *stream = NULL; |
0ace7505 JD |
2093 | |
2094 | memset(&index, 0, sizeof(index)); | |
3ecd366e MD |
2095 | index.offset = be64toh(ctf_index->offset); |
2096 | index.packet_size = be64toh(ctf_index->packet_size); | |
2097 | index.content_size = be64toh(ctf_index->content_size); | |
2098 | index.ts_cycles.timestamp_begin = be64toh(ctf_index->timestamp_begin); | |
2099 | index.ts_cycles.timestamp_end = be64toh(ctf_index->timestamp_end); | |
2100 | index.events_discarded = be64toh(ctf_index->events_discarded); | |
0ace7505 | 2101 | index.events_discarded_len = 64; |
e69dd258 | 2102 | index.data_offset = -1; |
3ecd366e | 2103 | stream_id = be64toh(ctf_index->stream_id); |
138cb20b JD |
2104 | if (index_minor >= 1) { |
2105 | index.stream_instance_id = be64toh(ctf_index->stream_instance_id); | |
2106 | index.packet_seq_num = be64toh(ctf_index->packet_seq_num); | |
2107 | } | |
0ace7505 JD |
2108 | |
2109 | if (!first_packet) { | |
2110 | /* add index to packet array */ | |
992e8cc0 | 2111 | g_array_append_val(file_stream->pos.packet_index, index); |
0ace7505 JD |
2112 | continue; |
2113 | } | |
2114 | ||
2115 | file_stream->parent.stream_id = stream_id; | |
51e0087f JG |
2116 | if (stream_id < td->streams->len) { |
2117 | stream = g_ptr_array_index(td->streams, stream_id); | |
2118 | } | |
0ace7505 JD |
2119 | if (!stream) { |
2120 | fprintf(stderr, "[error] Stream %" PRIu64 | |
2121 | " is not declared in metadata.\n", | |
2122 | stream_id); | |
2123 | ret = -EINVAL; | |
2124 | goto error; | |
2125 | } | |
2126 | file_stream->parent.stream_class = stream; | |
2127 | ret = create_stream_definitions(td, &file_stream->parent); | |
2128 | if (ret) | |
2129 | goto error; | |
2130 | first_packet = 0; | |
2131 | /* add index to packet array */ | |
992e8cc0 | 2132 | g_array_append_val(file_stream->pos.packet_index, index); |
0ace7505 JD |
2133 | } |
2134 | ||
dae407df JD |
2135 | /* Index containing only the header. */ |
2136 | if (!file_stream->parent.stream_class) { | |
2137 | ret = -1; | |
2138 | goto error; | |
2139 | } | |
2140 | ||
0ace7505 JD |
2141 | ret = 0; |
2142 | ||
2143 | error: | |
3ecd366e | 2144 | g_free(ctf_index); |
0ace7505 JD |
2145 | return ret; |
2146 | } | |
2147 | ||
0f980a35 MD |
2148 | /* |
2149 | * Note: many file streams can inherit from the same stream class | |
2150 | * description (metadata). | |
2151 | */ | |
2152 | static | |
b086c01a | 2153 | int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags, |
1cf393f6 | 2154 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, |
b086c01a | 2155 | int whence)) |
0f980a35 | 2156 | { |
f824ae04 | 2157 | int ret, fd, closeret; |
0f980a35 | 2158 | struct ctf_file_stream *file_stream; |
ff075710 | 2159 | struct stat statbuf; |
0ace7505 | 2160 | char *index_name; |
0f980a35 | 2161 | |
ff075710 MD |
2162 | fd = openat(td->dirfd, path, flags); |
2163 | if (fd < 0) { | |
a569a564 | 2164 | perror("File stream openat()"); |
ff075710 | 2165 | ret = fd; |
0f980a35 | 2166 | goto error; |
a569a564 | 2167 | } |
ff075710 MD |
2168 | |
2169 | /* Don't try to mmap subdirectories. Skip them, return success. */ | |
2170 | ret = fstat(fd, &statbuf); | |
2171 | if (ret) { | |
2172 | perror("File stream fstat()"); | |
2173 | goto fstat_error; | |
2174 | } | |
2175 | if (S_ISDIR(statbuf.st_mode)) { | |
0ace7505 JD |
2176 | if (strncmp(path, "index", 5) != 0) { |
2177 | fprintf(stderr, "[warning] Skipping directory '%s' " | |
2178 | "found in trace\n", path); | |
2179 | } | |
ff075710 MD |
2180 | ret = 0; |
2181 | goto fd_is_dir_ok; | |
2182 | } | |
f4f0fb70 MD |
2183 | if (!statbuf.st_size) { |
2184 | /** Skip empty files. */ | |
2185 | ret = 0; | |
2186 | goto fd_is_empty_file; | |
2187 | } | |
ff075710 | 2188 | |
0f980a35 | 2189 | file_stream = g_new0(struct ctf_file_stream, 1); |
3a25e036 | 2190 | file_stream->pos.last_offset = LAST_OFFSET_POISON; |
0ace7505 JD |
2191 | file_stream->pos.fd = -1; |
2192 | file_stream->pos.index_fp = NULL; | |
7f965b97 | 2193 | file_stream->pos.file_length = statbuf.st_size; |
b086c01a | 2194 | |
87148dc7 MD |
2195 | strncpy(file_stream->parent.path, path, PATH_MAX); |
2196 | file_stream->parent.path[PATH_MAX - 1] = '\0'; | |
2197 | ||
06789ffd MD |
2198 | if (packet_seek) { |
2199 | file_stream->pos.packet_seek = packet_seek; | |
b086c01a | 2200 | } else { |
06789ffd | 2201 | fprintf(stderr, "[error] packet_seek function undefined.\n"); |
b086c01a JD |
2202 | ret = -1; |
2203 | goto error_def; | |
2204 | } | |
2205 | ||
ca334c72 | 2206 | ret = ctf_init_pos(&file_stream->pos, &td->parent, fd, flags); |
f824ae04 MD |
2207 | if (ret) |
2208 | goto error_def; | |
2d0bea29 | 2209 | ret = create_trace_definitions(td, &file_stream->parent); |
e28d4618 MD |
2210 | if (ret) |
2211 | goto error_def; | |
25ccc85b | 2212 | /* |
50052405 | 2213 | * For now, only a single clock per trace is supported. |
25ccc85b | 2214 | */ |
7ec78969 | 2215 | file_stream->parent.current_clock = td->parent.single_clock; |
0ace7505 JD |
2216 | |
2217 | /* | |
2218 | * Allocate the index name for this stream and try to open it. | |
2219 | */ | |
2220 | index_name = malloc((strlen(path) + sizeof(INDEX_PATH)) * sizeof(char)); | |
2221 | if (!index_name) { | |
2222 | fprintf(stderr, "[error] Cannot allocate index filename\n"); | |
f4f0fb70 | 2223 | ret = -ENOMEM; |
0ace7505 | 2224 | goto error_def; |
888ec52a | 2225 | } |
0ace7505 JD |
2226 | snprintf(index_name, strlen(path) + sizeof(INDEX_PATH), |
2227 | INDEX_PATH, path); | |
2228 | ||
ff48c2b0 | 2229 | if (bt_faccessat(td->dirfd, td->parent.path, index_name, O_RDONLY, 0) < 0) { |
0ace7505 JD |
2230 | ret = create_stream_packet_index(td, file_stream); |
2231 | if (ret) { | |
2232 | fprintf(stderr, "[error] Stream index creation error.\n"); | |
2233 | goto error_index; | |
2234 | } | |
2235 | } else { | |
2236 | ret = openat(td->dirfd, index_name, flags); | |
2237 | if (ret < 0) { | |
2238 | perror("Index file openat()"); | |
2239 | ret = -1; | |
2240 | goto error_free; | |
2241 | } | |
2242 | file_stream->pos.index_fp = fdopen(ret, "r"); | |
2f0c6a52 MD |
2243 | if (!file_stream->pos.index_fp) { |
2244 | perror("fdopen() error"); | |
2245 | goto error_free; | |
2246 | } | |
0ace7505 JD |
2247 | ret = import_stream_packet_index(td, file_stream); |
2248 | if (ret) { | |
2249 | ret = -1; | |
2250 | goto error_index; | |
2251 | } | |
2252 | ret = fclose(file_stream->pos.index_fp); | |
2253 | if (ret < 0) { | |
2254 | perror("close index"); | |
2255 | goto error_free; | |
2256 | } | |
2257 | } | |
2258 | free(index_name); | |
2259 | ||
0f980a35 | 2260 | /* Add stream file to stream class */ |
2d0bea29 MD |
2261 | g_ptr_array_add(file_stream->parent.stream_class->streams, |
2262 | &file_stream->parent); | |
0f980a35 MD |
2263 | return 0; |
2264 | ||
2265 | error_index: | |
0ace7505 JD |
2266 | if (file_stream->pos.index_fp) { |
2267 | ret = fclose(file_stream->pos.index_fp); | |
2268 | if (ret < 0) { | |
2269 | perror("close index"); | |
2270 | } | |
2271 | } | |
2d0bea29 | 2272 | if (file_stream->parent.trace_packet_header) |
13fad8b6 | 2273 | bt_definition_unref(&file_stream->parent.trace_packet_header->p); |
0ace7505 JD |
2274 | error_free: |
2275 | free(index_name); | |
e28d4618 | 2276 | error_def: |
f824ae04 MD |
2277 | closeret = ctf_fini_pos(&file_stream->pos); |
2278 | if (closeret) { | |
2279 | fprintf(stderr, "Error on ctf_fini_pos\n"); | |
2280 | } | |
0f980a35 | 2281 | g_free(file_stream); |
f4f0fb70 | 2282 | fd_is_empty_file: |
ff075710 MD |
2283 | fd_is_dir_ok: |
2284 | fstat_error: | |
f824ae04 MD |
2285 | closeret = close(fd); |
2286 | if (closeret) { | |
2287 | perror("Error on fd close"); | |
2288 | } | |
0f980a35 | 2289 | error: |
65102a8c MD |
2290 | return ret; |
2291 | } | |
2292 | ||
bbefb8dd | 2293 | static |
5b80ddfb | 2294 | int ctf_open_trace_read(struct ctf_trace *td, |
8c250d87 | 2295 | const char *path, int flags, |
1cf393f6 | 2296 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, |
ae23d232 | 2297 | int whence), FILE *metadata_fp) |
bbefb8dd | 2298 | { |
6514b4af | 2299 | struct ctf_scanner *scanner; |
f824ae04 | 2300 | int ret, closeret; |
65102a8c MD |
2301 | struct dirent *dirent; |
2302 | struct dirent *diriter; | |
2303 | size_t dirent_len; | |
0ace7505 | 2304 | char *ext; |
bbefb8dd | 2305 | |
46322b33 | 2306 | td->flags = flags; |
bbefb8dd MD |
2307 | |
2308 | /* Open trace directory */ | |
46322b33 MD |
2309 | td->dir = opendir(path); |
2310 | if (!td->dir) { | |
6a6b384c | 2311 | fprintf(stderr, "[error] Unable to open trace directory \"%s\".\n", path); |
bbefb8dd MD |
2312 | ret = -ENOENT; |
2313 | goto error; | |
2314 | } | |
2315 | ||
46322b33 MD |
2316 | td->dirfd = open(path, 0); |
2317 | if (td->dirfd < 0) { | |
6a6b384c | 2318 | fprintf(stderr, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path); |
a569a564 MD |
2319 | perror("Trace directory open"); |
2320 | ret = -errno; | |
65102a8c MD |
2321 | goto error_dirfd; |
2322 | } | |
caf929fa MD |
2323 | strncpy(td->parent.path, path, sizeof(td->parent.path)); |
2324 | td->parent.path[sizeof(td->parent.path) - 1] = '\0'; | |
0f980a35 | 2325 | |
65102a8c MD |
2326 | /* |
2327 | * Keep the metadata file separate. | |
0c880b0a MD |
2328 | * Keep scanner object local to the open. We don't support |
2329 | * incremental metadata append for on-disk traces. | |
65102a8c | 2330 | */ |
6514b4af MD |
2331 | scanner = ctf_scanner_alloc(); |
2332 | if (!scanner) { | |
2333 | fprintf(stderr, "[error] Error allocating scanner\n"); | |
2334 | ret = -ENOMEM; | |
2335 | goto error_metadata; | |
2336 | } | |
0c880b0a | 2337 | ret = ctf_trace_metadata_read(td, metadata_fp, scanner, 0); |
6514b4af | 2338 | ctf_scanner_free(scanner); |
65102a8c | 2339 | if (ret) { |
251fc08c MD |
2340 | if (ret == -ENOENT) { |
2341 | fprintf(stderr, "[warning] Empty metadata.\n"); | |
2342 | } | |
6a6b384c | 2343 | fprintf(stderr, "[warning] Unable to open trace metadata for path \"%s\".\n", path); |
65102a8c MD |
2344 | goto error_metadata; |
2345 | } | |
bbefb8dd MD |
2346 | |
2347 | /* | |
2348 | * Open each stream: for each file, try to open, check magic | |
2349 | * number, and get the stream ID to add to the right location in | |
2350 | * the stream array. | |
bbefb8dd MD |
2351 | */ |
2352 | ||
65102a8c | 2353 | dirent_len = offsetof(struct dirent, d_name) + |
46322b33 | 2354 | fpathconf(td->dirfd, _PC_NAME_MAX) + 1; |
bbefb8dd | 2355 | |
65102a8c | 2356 | dirent = malloc(dirent_len); |
bbefb8dd | 2357 | |
65102a8c | 2358 | for (;;) { |
46322b33 | 2359 | ret = readdir_r(td->dir, dirent, &diriter); |
65102a8c | 2360 | if (ret) { |
3394d22e | 2361 | fprintf(stderr, "[error] Readdir error.\n"); |
65102a8c | 2362 | goto readdir_error; |
65102a8c MD |
2363 | } |
2364 | if (!diriter) | |
2365 | break; | |
d8ea2d29 MD |
2366 | /* Ignore hidden files, ., .. and metadata. */ |
2367 | if (!strncmp(diriter->d_name, ".", 1) | |
65102a8c MD |
2368 | || !strcmp(diriter->d_name, "..") |
2369 | || !strcmp(diriter->d_name, "metadata")) | |
2370 | continue; | |
0ace7505 JD |
2371 | |
2372 | /* Ignore index files : *.idx */ | |
2373 | ext = strrchr(diriter->d_name, '.'); | |
2374 | if (ext && (!strcmp(ext, ".idx"))) { | |
2375 | continue; | |
2376 | } | |
2377 | ||
06789ffd MD |
2378 | ret = ctf_open_file_stream_read(td, diriter->d_name, |
2379 | flags, packet_seek); | |
dc48ecad | 2380 | if (ret) { |
3394d22e | 2381 | fprintf(stderr, "[error] Open file stream error.\n"); |
dc48ecad MD |
2382 | goto readdir_error; |
2383 | } | |
65102a8c | 2384 | } |
bbefb8dd | 2385 | |
65102a8c | 2386 | free(dirent); |
bbefb8dd | 2387 | return 0; |
65102a8c MD |
2388 | |
2389 | readdir_error: | |
2390 | free(dirent); | |
2391 | error_metadata: | |
f824ae04 MD |
2392 | closeret = close(td->dirfd); |
2393 | if (closeret) { | |
2394 | perror("Error on fd close"); | |
2395 | } | |
65102a8c | 2396 | error_dirfd: |
f824ae04 MD |
2397 | closeret = closedir(td->dir); |
2398 | if (closeret) { | |
2399 | perror("Error on closedir"); | |
2400 | } | |
bbefb8dd MD |
2401 | error: |
2402 | return ret; | |
2403 | } | |
2404 | ||
03798a93 JD |
2405 | /* |
2406 | * ctf_open_trace: Open a CTF trace and index it. | |
2407 | * Note that the user must seek the trace after the open (using the iterator) | |
2408 | * since the index creation read it entirely. | |
2409 | */ | |
e9378815 | 2410 | static |
1b8455b7 | 2411 | struct bt_trace_descriptor *ctf_open_trace(const char *path, int flags, |
1cf393f6 | 2412 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, |
ae23d232 | 2413 | int whence), FILE *metadata_fp) |
bbefb8dd | 2414 | { |
46322b33 | 2415 | struct ctf_trace *td; |
bbefb8dd MD |
2416 | int ret; |
2417 | ||
2715de36 MD |
2418 | /* |
2419 | * If packet_seek is NULL, we provide our default version. | |
2420 | */ | |
2421 | if (!packet_seek) | |
2422 | packet_seek = ctf_packet_seek; | |
2423 | ||
46322b33 | 2424 | td = g_new0(struct ctf_trace, 1); |
837b0013 JG |
2425 | if (!td) { |
2426 | goto error; | |
2427 | } | |
2428 | init_trace_descriptor(&td->parent); | |
bbefb8dd | 2429 | |
8c572eba | 2430 | switch (flags & O_ACCMODE) { |
bbefb8dd | 2431 | case O_RDONLY: |
b61922b5 | 2432 | if (!path) { |
3394d22e | 2433 | fprintf(stderr, "[error] Path missing for input CTF trace.\n"); |
b61922b5 MD |
2434 | goto error; |
2435 | } | |
06789ffd | 2436 | ret = ctf_open_trace_read(td, path, flags, packet_seek, metadata_fp); |
bbefb8dd MD |
2437 | if (ret) |
2438 | goto error; | |
2439 | break; | |
989c73bc | 2440 | case O_RDWR: |
3394d22e | 2441 | fprintf(stderr, "[error] Opening CTF traces for output is not supported yet.\n"); |
46322b33 | 2442 | goto error; |
bbefb8dd | 2443 | default: |
3394d22e | 2444 | fprintf(stderr, "[error] Incorrect open flags.\n"); |
bbefb8dd MD |
2445 | goto error; |
2446 | } | |
2447 | ||
b5a8598f AB |
2448 | ret = trace_debug_info_create(td); |
2449 | if (ret) { | |
2450 | goto error; | |
2451 | } | |
2452 | ||
46322b33 | 2453 | return &td->parent; |
bbefb8dd | 2454 | error: |
80715793 MJ |
2455 | if (td) { |
2456 | trace_debug_info_destroy(td); | |
2457 | g_free(td); | |
2458 | } | |
bbefb8dd MD |
2459 | return NULL; |
2460 | } | |
2461 | ||
2e937fb4 | 2462 | static |
f571dfb1 | 2463 | void ctf_init_mmap_pos(struct ctf_stream_pos *pos, |
c150f912 | 2464 | struct bt_mmap_stream *mmap_info) |
f571dfb1 JD |
2465 | { |
2466 | pos->mmap_offset = 0; | |
2467 | pos->packet_size = 0; | |
2468 | pos->content_size = 0; | |
2469 | pos->content_size_loc = NULL; | |
2470 | pos->fd = mmap_info->fd; | |
aee35fcc | 2471 | pos->base_mma = NULL; |
f571dfb1 JD |
2472 | pos->offset = 0; |
2473 | pos->dummy = false; | |
2474 | pos->cur_index = 0; | |
f571dfb1 JD |
2475 | pos->prot = PROT_READ; |
2476 | pos->flags = MAP_PRIVATE; | |
2477 | pos->parent.rw_table = read_dispatch_table; | |
2478 | pos->parent.event_cb = ctf_read_event; | |
731087d8 | 2479 | pos->priv = mmap_info->priv; |
f1f52630 MD |
2480 | pos->packet_index = g_array_new(FALSE, TRUE, |
2481 | sizeof(struct packet_index)); | |
f571dfb1 JD |
2482 | } |
2483 | ||
2484 | static | |
2485 | int prepare_mmap_stream_definition(struct ctf_trace *td, | |
fb6b45aa JD |
2486 | struct ctf_file_stream *file_stream, |
2487 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, | |
2488 | int whence)) | |
f571dfb1 | 2489 | { |
f380e105 | 2490 | struct ctf_stream_declaration *stream; |
fb6b45aa | 2491 | uint64_t stream_id; |
f571dfb1 JD |
2492 | int ret; |
2493 | ||
fb6b45aa JD |
2494 | /* Ask for the first packet to get the stream_id. */ |
2495 | packet_seek(&file_stream->pos.parent, 0, SEEK_SET); | |
7b563a77 MD |
2496 | ret = bt_packet_seek_get_error(); |
2497 | if (ret) { | |
2498 | goto end; | |
2499 | } | |
fb6b45aa | 2500 | stream_id = file_stream->parent.stream_id; |
f571dfb1 | 2501 | if (stream_id >= td->streams->len) { |
3394d22e | 2502 | fprintf(stderr, "[error] Stream %" PRIu64 " is not declared " |
f571dfb1 JD |
2503 | "in metadata.\n", stream_id); |
2504 | ret = -EINVAL; | |
2505 | goto end; | |
2506 | } | |
2507 | stream = g_ptr_array_index(td->streams, stream_id); | |
2508 | if (!stream) { | |
3394d22e | 2509 | fprintf(stderr, "[error] Stream %" PRIu64 " is not declared " |
f571dfb1 JD |
2510 | "in metadata.\n", stream_id); |
2511 | ret = -EINVAL; | |
2512 | goto end; | |
2513 | } | |
2514 | file_stream->parent.stream_class = stream; | |
2515 | ret = create_stream_definitions(td, &file_stream->parent); | |
2516 | end: | |
2517 | return ret; | |
2518 | } | |
2519 | ||
2520 | static | |
2521 | int ctf_open_mmap_stream_read(struct ctf_trace *td, | |
c150f912 | 2522 | struct bt_mmap_stream *mmap_info, |
1cf393f6 | 2523 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, |
f571dfb1 JD |
2524 | int whence)) |
2525 | { | |
2526 | int ret; | |
2527 | struct ctf_file_stream *file_stream; | |
2528 | ||
2529 | file_stream = g_new0(struct ctf_file_stream, 1); | |
fb6b45aa | 2530 | file_stream->parent.stream_id = -1ULL; |
3a25e036 | 2531 | file_stream->pos.last_offset = LAST_OFFSET_POISON; |
f571dfb1 JD |
2532 | ctf_init_mmap_pos(&file_stream->pos, mmap_info); |
2533 | ||
06789ffd | 2534 | file_stream->pos.packet_seek = packet_seek; |
f571dfb1 JD |
2535 | |
2536 | ret = create_trace_definitions(td, &file_stream->parent); | |
2537 | if (ret) { | |
2538 | goto error_def; | |
2539 | } | |
2540 | ||
fb6b45aa | 2541 | ret = prepare_mmap_stream_definition(td, file_stream, packet_seek); |
f571dfb1 JD |
2542 | if (ret) |
2543 | goto error_index; | |
2544 | ||
f7bbd502 | 2545 | /* |
50052405 | 2546 | * For now, only a single clock per trace is supported. |
f7bbd502 | 2547 | */ |
7ec78969 | 2548 | file_stream->parent.current_clock = td->parent.single_clock; |
f7bbd502 | 2549 | |
f571dfb1 JD |
2550 | /* Add stream file to stream class */ |
2551 | g_ptr_array_add(file_stream->parent.stream_class->streams, | |
2552 | &file_stream->parent); | |
2553 | return 0; | |
2554 | ||
2555 | error_index: | |
2556 | if (file_stream->parent.trace_packet_header) | |
13fad8b6 | 2557 | bt_definition_unref(&file_stream->parent.trace_packet_header->p); |
f571dfb1 JD |
2558 | error_def: |
2559 | g_free(file_stream); | |
2560 | return ret; | |
2561 | } | |
2562 | ||
2e937fb4 | 2563 | static |
f571dfb1 | 2564 | int ctf_open_mmap_trace_read(struct ctf_trace *td, |
c150f912 | 2565 | struct bt_mmap_stream_list *mmap_list, |
1cf393f6 | 2566 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, |
f571dfb1 JD |
2567 | int whence), |
2568 | FILE *metadata_fp) | |
2569 | { | |
2570 | int ret; | |
c150f912 | 2571 | struct bt_mmap_stream *mmap_info; |
f571dfb1 | 2572 | |
0c880b0a MD |
2573 | td->scanner = ctf_scanner_alloc(); |
2574 | if (!td->scanner) { | |
6514b4af MD |
2575 | fprintf(stderr, "[error] Error allocating scanner\n"); |
2576 | ret = -ENOMEM; | |
0c880b0a | 2577 | goto error; |
6514b4af | 2578 | } |
0c880b0a | 2579 | ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 0); |
f571dfb1 | 2580 | if (ret) { |
251fc08c MD |
2581 | if (ret == -ENOENT) { |
2582 | fprintf(stderr, "[warning] Empty metadata.\n"); | |
2583 | } | |
f571dfb1 JD |
2584 | goto error; |
2585 | } | |
2586 | ||
2587 | /* | |
2588 | * for each stream, try to open, check magic number, and get the | |
2589 | * stream ID to add to the right location in the stream array. | |
2590 | */ | |
3122e6f0 | 2591 | bt_list_for_each_entry(mmap_info, &mmap_list->head, list) { |
06789ffd | 2592 | ret = ctf_open_mmap_stream_read(td, mmap_info, packet_seek); |
f571dfb1 | 2593 | if (ret) { |
3394d22e | 2594 | fprintf(stderr, "[error] Open file mmap stream error.\n"); |
f571dfb1 JD |
2595 | goto error; |
2596 | } | |
2597 | } | |
f571dfb1 JD |
2598 | return 0; |
2599 | ||
2600 | error: | |
0c880b0a | 2601 | ctf_scanner_free(td->scanner); |
f571dfb1 JD |
2602 | return ret; |
2603 | } | |
2604 | ||
2605 | static | |
1b8455b7 | 2606 | struct bt_trace_descriptor *ctf_open_mmap_trace( |
c150f912 | 2607 | struct bt_mmap_stream_list *mmap_list, |
1cf393f6 | 2608 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, |
20d0dcf9 | 2609 | int whence), |
f571dfb1 JD |
2610 | FILE *metadata_fp) |
2611 | { | |
2612 | struct ctf_trace *td; | |
2613 | int ret; | |
2614 | ||
2615 | if (!metadata_fp) { | |
2616 | fprintf(stderr, "[error] No metadata file pointer associated, " | |
2617 | "required for mmap parsing\n"); | |
2618 | goto error; | |
2619 | } | |
06789ffd MD |
2620 | if (!packet_seek) { |
2621 | fprintf(stderr, "[error] packet_seek function undefined.\n"); | |
f571dfb1 JD |
2622 | goto error; |
2623 | } | |
2624 | td = g_new0(struct ctf_trace, 1); | |
b5a1fa45 | 2625 | td->dirfd = -1; |
06789ffd | 2626 | ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp); |
f571dfb1 JD |
2627 | if (ret) |
2628 | goto error_free; | |
2629 | ||
b5a8598f AB |
2630 | ret = trace_debug_info_create(td); |
2631 | if (ret) { | |
2632 | goto error_free; | |
2633 | } | |
2634 | ||
f571dfb1 JD |
2635 | return &td->parent; |
2636 | ||
2637 | error_free: | |
2638 | g_free(td); | |
2639 | error: | |
2640 | return NULL; | |
2641 | } | |
2642 | ||
0c880b0a MD |
2643 | int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp, |
2644 | FILE *metadata_fp) | |
2645 | { | |
2646 | struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent); | |
2647 | int i, j; | |
2648 | int ret; | |
2649 | ||
2650 | if (!td->scanner) | |
2651 | return -EINVAL; | |
2652 | ret = ctf_trace_metadata_read(td, metadata_fp, td->scanner, 1); | |
2653 | if (ret) | |
2654 | return ret; | |
2655 | /* for each stream_class */ | |
2656 | for (i = 0; i < td->streams->len; i++) { | |
2657 | struct ctf_stream_declaration *stream_class; | |
2658 | ||
2659 | stream_class = g_ptr_array_index(td->streams, i); | |
2660 | if (!stream_class) | |
2661 | continue; | |
2662 | /* for each stream */ | |
2663 | for (j = 0; j < stream_class->streams->len; j++) { | |
2664 | struct ctf_stream_definition *stream; | |
2665 | ||
2666 | stream = g_ptr_array_index(stream_class->streams, j); | |
2667 | if (!stream) | |
2668 | continue; | |
2669 | ret = copy_event_declarations_stream_class_to_stream(td, | |
2670 | stream_class, stream); | |
2671 | if (ret) | |
2672 | return ret; | |
2673 | } | |
2674 | } | |
2675 | return 0; | |
2676 | } | |
2677 | ||
03798a93 | 2678 | static |
1b8455b7 | 2679 | int ctf_convert_index_timestamp(struct bt_trace_descriptor *tdp) |
03798a93 JD |
2680 | { |
2681 | int i, j, k; | |
2682 | struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent); | |
2683 | ||
2684 | /* for each stream_class */ | |
2685 | for (i = 0; i < td->streams->len; i++) { | |
2686 | struct ctf_stream_declaration *stream_class; | |
2687 | ||
2688 | stream_class = g_ptr_array_index(td->streams, i); | |
2689 | if (!stream_class) | |
2690 | continue; | |
2691 | /* for each file_stream */ | |
2692 | for (j = 0; j < stream_class->streams->len; j++) { | |
2693 | struct ctf_stream_definition *stream; | |
2694 | struct ctf_stream_pos *stream_pos; | |
2695 | struct ctf_file_stream *cfs; | |
2696 | ||
2697 | stream = g_ptr_array_index(stream_class->streams, j); | |
2698 | if (!stream) | |
2699 | continue; | |
2700 | cfs = container_of(stream, struct ctf_file_stream, | |
2701 | parent); | |
2702 | stream_pos = &cfs->pos; | |
992e8cc0 | 2703 | if (!stream_pos->packet_index) |
afe9cd4a JD |
2704 | continue; |
2705 | ||
992e8cc0 | 2706 | for (k = 0; k < stream_pos->packet_index->len; k++) { |
03798a93 | 2707 | struct packet_index *index; |
03798a93 | 2708 | |
992e8cc0 | 2709 | index = &g_array_index(stream_pos->packet_index, |
03798a93 | 2710 | struct packet_index, k); |
992e8cc0 | 2711 | index->ts_real.timestamp_begin = |
03798a93 | 2712 | ctf_get_real_timestamp(stream, |
992e8cc0 MD |
2713 | index->ts_cycles.timestamp_begin); |
2714 | index->ts_real.timestamp_end = | |
03798a93 | 2715 | ctf_get_real_timestamp(stream, |
992e8cc0 | 2716 | index->ts_cycles.timestamp_end); |
03798a93 JD |
2717 | } |
2718 | } | |
2719 | } | |
2720 | return 0; | |
2721 | } | |
2722 | ||
0f980a35 | 2723 | static |
f824ae04 | 2724 | int ctf_close_file_stream(struct ctf_file_stream *file_stream) |
0f980a35 | 2725 | { |
f824ae04 MD |
2726 | int ret; |
2727 | ||
2728 | ret = ctf_fini_pos(&file_stream->pos); | |
2729 | if (ret) { | |
2730 | fprintf(stderr, "Error on ctf_fini_pos\n"); | |
2731 | return -1; | |
2732 | } | |
500634be JD |
2733 | if (file_stream->pos.fd >= 0) { |
2734 | ret = close(file_stream->pos.fd); | |
2735 | if (ret) { | |
2736 | perror("Error closing file fd"); | |
2737 | return -1; | |
2738 | } | |
f824ae04 MD |
2739 | } |
2740 | return 0; | |
0f980a35 MD |
2741 | } |
2742 | ||
e9378815 | 2743 | static |
1b8455b7 | 2744 | int ctf_close_trace(struct bt_trace_descriptor *tdp) |
bbefb8dd | 2745 | { |
46322b33 | 2746 | struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent); |
08c82b90 | 2747 | int ret; |
0f980a35 | 2748 | |
46322b33 | 2749 | if (td->streams) { |
08c82b90 MD |
2750 | int i; |
2751 | ||
46322b33 | 2752 | for (i = 0; i < td->streams->len; i++) { |
f380e105 | 2753 | struct ctf_stream_declaration *stream; |
0f980a35 | 2754 | int j; |
e9378815 | 2755 | |
46322b33 | 2756 | stream = g_ptr_array_index(td->streams, i); |
e9378815 MD |
2757 | if (!stream) |
2758 | continue; | |
2d0bea29 | 2759 | for (j = 0; j < stream->streams->len; j++) { |
0f980a35 | 2760 | struct ctf_file_stream *file_stream; |
15d4fe3c JD |
2761 | file_stream = container_of(g_ptr_array_index(stream->streams, j), |
2762 | struct ctf_file_stream, parent); | |
f824ae04 MD |
2763 | ret = ctf_close_file_stream(file_stream); |
2764 | if (ret) | |
2765 | return ret; | |
0f980a35 | 2766 | } |
e003ab50 | 2767 | } |
e003ab50 | 2768 | } |
15d4fe3c | 2769 | ctf_destroy_metadata(td); |
0c880b0a | 2770 | ctf_scanner_free(td->scanner); |
500634be JD |
2771 | if (td->dirfd >= 0) { |
2772 | ret = close(td->dirfd); | |
2773 | if (ret) { | |
2774 | perror("Error closing dirfd"); | |
2775 | return ret; | |
2776 | } | |
f824ae04 | 2777 | } |
500634be JD |
2778 | if (td->dir) { |
2779 | ret = closedir(td->dir); | |
2780 | if (ret) { | |
2781 | perror("Error closedir"); | |
2782 | return ret; | |
2783 | } | |
f824ae04 | 2784 | } |
7237592a | 2785 | free(td->metadata_string); |
b5a8598f | 2786 | trace_debug_info_destroy(td); |
bbefb8dd | 2787 | g_free(td); |
f824ae04 | 2788 | return 0; |
bbefb8dd MD |
2789 | } |
2790 | ||
98a04903 | 2791 | static |
1b8455b7 | 2792 | void ctf_set_context(struct bt_trace_descriptor *descriptor, |
98a04903 JD |
2793 | struct bt_context *ctx) |
2794 | { | |
2795 | struct ctf_trace *td = container_of(descriptor, struct ctf_trace, | |
2796 | parent); | |
2797 | ||
45807148 | 2798 | td->parent.ctx = ctx; |
98a04903 JD |
2799 | } |
2800 | ||
2801 | static | |
1b8455b7 | 2802 | void ctf_set_handle(struct bt_trace_descriptor *descriptor, |
98a04903 JD |
2803 | struct bt_trace_handle *handle) |
2804 | { | |
2805 | struct ctf_trace *td = container_of(descriptor, struct ctf_trace, | |
2806 | parent); | |
2807 | ||
4d086981 | 2808 | td->parent.handle = handle; |
98a04903 JD |
2809 | } |
2810 | ||
95febab3 | 2811 | static |
7fb21036 | 2812 | void __attribute__((constructor)) ctf_init(void) |
fc93b2bd MD |
2813 | { |
2814 | int ret; | |
2815 | ||
4c8bfb7e | 2816 | ctf_format.name = g_quark_from_static_string("ctf"); |
fc93b2bd MD |
2817 | ret = bt_register_format(&ctf_format); |
2818 | assert(!ret); | |
2819 | } | |
698f0fe4 | 2820 | |
95febab3 MD |
2821 | static |
2822 | void __attribute__((destructor)) ctf_exit(void) | |
2823 | { | |
2824 | bt_unregister_format(&ctf_format); | |
2825 | } |