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