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