2 * Copyright 2016-2017 - Philippe Proulx <pproulx@efficios.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
15 #define BT_LOG_TAG "PLUGIN-CTF-METADATA-DECODER"
23 #include <babeltrace/assert-internal.h>
24 #include <babeltrace/compat/uuid-internal.h>
25 #include <babeltrace/compat/memstream-internal.h>
26 #include <babeltrace/babeltrace.h>
34 #define TSDL_MAGIC 0x75d11d57
39 struct ctf_metadata_decoder
{
40 struct ctf_visitor_generate_ir
*visitor
;
44 struct ctf_metadata_decoder_config config
;
47 struct packet_header
{
51 uint32_t content_size
;
53 uint8_t compression_scheme
;
54 uint8_t encryption_scheme
;
55 uint8_t checksum_scheme
;
58 } __attribute__((__packed__
));
61 bool ctf_metadata_decoder_is_packetized(FILE *fp
, int *byte_order
)
67 len
= fread(&magic
, sizeof(magic
), 1, fp
);
69 BT_LOGD_STR("Cannot reade first metadata packet header: assuming the stream is not packetized.");
74 if (magic
== TSDL_MAGIC
) {
76 *byte_order
= BYTE_ORDER
;
77 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
79 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
?
80 LITTLE_ENDIAN
: BIG_ENDIAN
;
91 bool is_version_valid(unsigned int major
, unsigned int minor
)
93 return major
== 1 && minor
== 8;
97 int decode_packet(struct ctf_metadata_decoder
*mdec
, FILE *in_fp
, FILE *out_fp
,
100 struct packet_header header
;
101 size_t readlen
, writelen
, toread
;
102 uint8_t buf
[512 + 1]; /* + 1 for debug-mode \0 */
104 const long offset
= ftell(in_fp
);
107 BT_LOGE_ERRNO("Failed to get current metadata file position",
111 BT_LOGV("Decoding metadata packet: mdec-addr=%p, offset=%ld",
113 readlen
= fread(&header
, sizeof(header
), 1, in_fp
);
114 if (feof(in_fp
) != 0) {
115 BT_LOGV("Reached end of file: offset=%ld", ftell(in_fp
));
119 BT_LOGV("Cannot decode metadata packet: offset=%ld", offset
);
123 if (byte_order
!= BYTE_ORDER
) {
124 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
125 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
126 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
127 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
130 if (header
.compression_scheme
) {
131 BT_LOGE("Metadata packet compression is not supported as of this version: "
132 "compression-scheme=%u, offset=%ld",
133 (unsigned int) header
.compression_scheme
, offset
);
137 if (header
.encryption_scheme
) {
138 BT_LOGE("Metadata packet encryption is not supported as of this version: "
139 "encryption-scheme=%u, offset=%ld",
140 (unsigned int) header
.encryption_scheme
, offset
);
144 if (header
.checksum
|| header
.checksum_scheme
) {
145 BT_LOGE("Metadata packet checksum verification is not supported as of this version: "
146 "checksum-scheme=%u, checksum=%x, offset=%ld",
147 (unsigned int) header
.checksum_scheme
, header
.checksum
,
152 if (!is_version_valid(header
.major
, header
.minor
)) {
153 BT_LOGE("Invalid metadata packet version: "
154 "version=%u.%u, offset=%ld",
155 header
.major
, header
.minor
, offset
);
159 /* Set expected trace UUID if not set; otherwise validate it */
161 if (!mdec
->is_uuid_set
) {
162 memcpy(mdec
->uuid
, header
.uuid
, sizeof(header
.uuid
));
163 mdec
->is_uuid_set
= true;
164 } else if (bt_uuid_compare(header
.uuid
, mdec
->uuid
)) {
165 BT_LOGE("Metadata UUID mismatch between packets of the same stream: "
166 "packet-uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\", "
167 "expected-uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\", "
169 (unsigned int) header
.uuid
[0],
170 (unsigned int) header
.uuid
[1],
171 (unsigned int) header
.uuid
[2],
172 (unsigned int) header
.uuid
[3],
173 (unsigned int) header
.uuid
[4],
174 (unsigned int) header
.uuid
[5],
175 (unsigned int) header
.uuid
[6],
176 (unsigned int) header
.uuid
[7],
177 (unsigned int) header
.uuid
[8],
178 (unsigned int) header
.uuid
[9],
179 (unsigned int) header
.uuid
[10],
180 (unsigned int) header
.uuid
[11],
181 (unsigned int) header
.uuid
[12],
182 (unsigned int) header
.uuid
[13],
183 (unsigned int) header
.uuid
[14],
184 (unsigned int) header
.uuid
[15],
185 (unsigned int) mdec
->uuid
[0],
186 (unsigned int) mdec
->uuid
[1],
187 (unsigned int) mdec
->uuid
[2],
188 (unsigned int) mdec
->uuid
[3],
189 (unsigned int) mdec
->uuid
[4],
190 (unsigned int) mdec
->uuid
[5],
191 (unsigned int) mdec
->uuid
[6],
192 (unsigned int) mdec
->uuid
[7],
193 (unsigned int) mdec
->uuid
[8],
194 (unsigned int) mdec
->uuid
[9],
195 (unsigned int) mdec
->uuid
[10],
196 (unsigned int) mdec
->uuid
[11],
197 (unsigned int) mdec
->uuid
[12],
198 (unsigned int) mdec
->uuid
[13],
199 (unsigned int) mdec
->uuid
[14],
200 (unsigned int) mdec
->uuid
[15],
206 if ((header
.content_size
/ CHAR_BIT
) < sizeof(header
)) {
207 BT_LOGE("Bad metadata packet content size: content-size=%u, "
208 "offset=%ld", header
.content_size
, offset
);
212 toread
= header
.content_size
/ CHAR_BIT
- sizeof(header
);
217 loop_read
= MIN(sizeof(buf
) - 1, toread
);
218 readlen
= fread(buf
, sizeof(uint8_t), loop_read
, in_fp
);
220 BT_LOGE("Cannot read metadata packet buffer: "
221 "offset=%ld, read-size=%zu",
222 ftell(in_fp
), loop_read
);
225 if (readlen
> loop_read
) {
226 BT_LOGE("fread returned more byte than expected: "
227 "read-size-asked=%zu, read-size-returned=%zu",
232 writelen
= fwrite(buf
, sizeof(uint8_t), readlen
, out_fp
);
233 if (writelen
< readlen
|| ferror(out_fp
)) {
234 BT_LOGE("Cannot write decoded metadata text to buffer: "
235 "read-offset=%ld, write-size=%zu",
236 ftell(in_fp
), readlen
);
244 /* Read leftover padding */
245 toread
= (header
.packet_size
- header
.content_size
) /
247 fseek_ret
= fseek(in_fp
, toread
, SEEK_CUR
);
249 BT_LOGW_STR("Missing padding at the end of the metadata stream.");
265 int ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
266 struct ctf_metadata_decoder
*mdec
, FILE *fp
,
267 char **buf
, int byte_order
)
273 size_t packet_index
= 0;
275 out_fp
= bt_open_memstream(buf
, &size
);
276 if (out_fp
== NULL
) {
277 BT_LOGE("Cannot open memory stream: %s: mdec-addr=%p",
278 strerror(errno
), mdec
);
287 tret
= decode_packet(mdec
, fp
, out_fp
, byte_order
);
289 BT_LOGE("Cannot decode packet: index=%zu, mdec-addr=%p",
297 /* Make sure the whole string ends with a null character */
298 tret
= fputc('\0', out_fp
);
300 BT_LOGE("Cannot append '\\0' to the decoded metadata buffer: "
301 "mdec-addr=%p", mdec
);
305 /* Close stream, which also flushes the buffer */
306 ret
= bt_close_memstream(buf
, &size
, out_fp
);
308 * See fclose(3). Further access to out_fp after both success
309 * and error, even through another bt_close_memstream(), results
310 * in undefined behavior. Nullify out_fp to ensure we don't
311 * fclose it twice on error.
315 BT_LOGE("Cannot close memory stream: %s: mdec-addr=%p",
316 strerror(errno
), mdec
);
326 if (bt_close_memstream(buf
, &size
, out_fp
)) {
327 BT_LOGE("Cannot close memory stream: %s: mdec-addr=%p",
328 strerror(errno
), mdec
);
342 int ctf_metadata_decoder_packetized_file_stream_to_buf(
343 FILE *fp
, char **buf
, int byte_order
)
345 return ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
346 NULL
, fp
, buf
, byte_order
);
350 struct ctf_metadata_decoder
*ctf_metadata_decoder_create(
351 const struct ctf_metadata_decoder_config
*config
)
353 struct ctf_metadata_decoder
*mdec
=
354 g_new0(struct ctf_metadata_decoder
, 1);
355 struct ctf_metadata_decoder_config default_config
= {
356 .clock_class_offset_s
= 0,
357 .clock_class_offset_ns
= 0,
361 config
= &default_config
;
364 BT_LOGD("Creating CTF metadata decoder: "
365 "clock-class-offset-s=%" PRId64
", "
366 "clock-class-offset-ns=%" PRId64
,
367 config
->clock_class_offset_s
, config
->clock_class_offset_ns
);
370 BT_LOGE_STR("Failed to allocate one CTF metadata decoder.");
374 mdec
->config
= *config
;
375 mdec
->visitor
= ctf_visitor_generate_ir_create(config
);
376 if (!mdec
->visitor
) {
377 BT_LOGE("Failed to create a CTF IR metadata AST visitor: "
378 "mdec-addr=%p", mdec
);
379 ctf_metadata_decoder_destroy(mdec
);
384 BT_LOGD("Creating CTF metadata decoder: "
385 "clock-class-offset-s=%" PRId64
", "
386 "clock-class-offset-ns=%" PRId64
", addr=%p",
387 config
->clock_class_offset_s
, config
->clock_class_offset_ns
,
395 void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder
*mdec
)
401 BT_LOGD("Destroying CTF metadata decoder: addr=%p", mdec
);
402 ctf_visitor_generate_ir_destroy(mdec
->visitor
);
407 enum ctf_metadata_decoder_status
ctf_metadata_decoder_decode(
408 struct ctf_metadata_decoder
*mdec
, FILE *fp
)
410 enum ctf_metadata_decoder_status status
=
411 CTF_METADATA_DECODER_STATUS_OK
;
413 struct ctf_scanner
*scanner
= NULL
;
415 bool close_fp
= false;
419 if (ctf_metadata_decoder_is_packetized(fp
, &mdec
->bo
)) {
420 BT_LOGD("Metadata stream is packetized: mdec-addr=%p", mdec
);
421 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
422 mdec
, fp
, &buf
, mdec
->bo
);
424 BT_LOGE("Cannot decode packetized metadata packets to metadata text: "
425 "mdec-addr=%p, ret=%d", mdec
, ret
);
426 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
430 if (strlen(buf
) == 0) {
431 /* An empty metadata packet is OK. */
435 /* Convert the real file pointer to a memory file pointer */
436 fp
= bt_fmemopen(buf
, strlen(buf
), "rb");
439 BT_LOGE("Cannot memory-open metadata buffer: %s: "
440 "mdec-addr=%p", strerror(errno
), mdec
);
441 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
445 unsigned int major
, minor
;
447 const long init_pos
= ftell(fp
);
449 BT_LOGD("Metadata stream is plain text: mdec-addr=%p", mdec
);
452 BT_LOGE_ERRNO("Failed to get current file position", ".");
453 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
457 /* Check text-only metadata header and version */
458 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
460 BT_LOGW("Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
461 "mdec-addr=%p", mdec
);
464 BT_LOGD("Found metadata stream version in signature: version=%u.%u", major
, minor
);
466 if (!is_version_valid(major
, minor
)) {
467 BT_LOGE("Invalid metadata version found in plain text signature: "
468 "version=%u.%u, mdec-addr=%p", major
, minor
,
470 status
= CTF_METADATA_DECODER_STATUS_INVAL_VERSION
;
474 if (fseek(fp
, init_pos
, SEEK_SET
)) {
475 BT_LOGE("Cannot seek metadata file stream to initial position: %s: "
476 "mdec-addr=%p", strerror(errno
), mdec
);
477 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
482 if (BT_LOG_ON_VERBOSE
) {
486 /* Allocate a scanner and append the metadata text content */
487 scanner
= ctf_scanner_alloc();
489 BT_LOGE("Cannot allocate a metadata lexical scanner: "
490 "mdec-addr=%p", mdec
);
491 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
496 ret
= ctf_scanner_append_ast(scanner
, fp
);
498 BT_LOGE("Cannot create the metadata AST out of the metadata text: "
499 "mdec-addr=%p", mdec
);
500 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
504 ret
= ctf_visitor_semantic_check(0, &scanner
->ast
->root
);
506 BT_LOGE("Validation of the metadata semantics failed: "
507 "mdec-addr=%p", mdec
);
508 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
512 ret
= ctf_visitor_generate_ir_visit_node(mdec
->visitor
,
513 &scanner
->ast
->root
);
523 BT_LOGD("While visiting metadata AST: incomplete data: "
524 "mdec-addr=%p", mdec
);
525 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
528 BT_LOGE("Failed to visit AST node to create CTF IR objects: "
529 "mdec-addr=%p, ret=%d", mdec
, ret
);
530 status
= CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
;
536 ctf_scanner_free(scanner
);
541 if (fp
&& close_fp
) {
543 BT_LOGE("Cannot close metadata file stream: "
544 "mdec-addr=%p", mdec
);
556 struct bt_trace_class
*ctf_metadata_decoder_get_ir_trace_class(
557 struct ctf_metadata_decoder
*mdec
)
559 return ctf_visitor_generate_ir_get_ir_trace_class(mdec
->visitor
);
563 struct ctf_trace_class
*ctf_metadata_decoder_borrow_ctf_trace_class(
564 struct ctf_metadata_decoder
*mdec
)
566 return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec
->visitor
);