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