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"
24 #include <babeltrace/compat/uuid-internal.h>
25 #include <babeltrace/compat/memstream-internal.h>
26 #include <babeltrace/ctf-ir/trace.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
);
106 BT_LOGV("Decoding metadata packet: mdec-addr=%p, offset=%ld",
108 readlen
= fread(&header
, sizeof(header
), 1, in_fp
);
109 if (feof(in_fp
) != 0) {
110 BT_LOGV("Reached end of file: offset=%ld", ftell(in_fp
));
114 BT_LOGV("Cannot decode metadata packet: offset=%ld", offset
);
118 if (byte_order
!= BYTE_ORDER
) {
119 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
120 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
121 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
122 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
125 if (header
.compression_scheme
) {
126 BT_LOGE("Metadata packet compression is not supported as of this version: "
127 "compression-scheme=%u, offset=%ld",
128 (unsigned int) header
.compression_scheme
, offset
);
132 if (header
.encryption_scheme
) {
133 BT_LOGE("Metadata packet encryption is not supported as of this version: "
134 "encryption-scheme=%u, offset=%ld",
135 (unsigned int) header
.encryption_scheme
, offset
);
139 if (header
.checksum
|| header
.checksum_scheme
) {
140 BT_LOGE("Metadata packet checksum verification is not supported as of this version: "
141 "checksum-scheme=%u, checksum=%x, offset=%ld",
142 (unsigned int) header
.checksum_scheme
, header
.checksum
,
147 if (!is_version_valid(header
.major
, header
.minor
)) {
148 BT_LOGE("Invalid metadata packet version: "
149 "version=%u.%u, offset=%ld",
150 header
.major
, header
.minor
, offset
);
154 /* Set expected trace UUID if not set; otherwise validate it */
156 if (!mdec
->is_uuid_set
) {
157 memcpy(mdec
->uuid
, header
.uuid
, sizeof(header
.uuid
));
158 mdec
->is_uuid_set
= true;
159 } else if (bt_uuid_compare(header
.uuid
, mdec
->uuid
)) {
160 BT_LOGE("Metadata UUID mismatch between packets of the same stream: "
161 "packet-uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\", "
162 "expected-uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\", "
164 (unsigned int) header
.uuid
[0],
165 (unsigned int) header
.uuid
[1],
166 (unsigned int) header
.uuid
[2],
167 (unsigned int) header
.uuid
[3],
168 (unsigned int) header
.uuid
[4],
169 (unsigned int) header
.uuid
[5],
170 (unsigned int) header
.uuid
[6],
171 (unsigned int) header
.uuid
[7],
172 (unsigned int) header
.uuid
[8],
173 (unsigned int) header
.uuid
[9],
174 (unsigned int) header
.uuid
[10],
175 (unsigned int) header
.uuid
[11],
176 (unsigned int) header
.uuid
[12],
177 (unsigned int) header
.uuid
[13],
178 (unsigned int) header
.uuid
[14],
179 (unsigned int) header
.uuid
[15],
180 (unsigned int) mdec
->uuid
[0],
181 (unsigned int) mdec
->uuid
[1],
182 (unsigned int) mdec
->uuid
[2],
183 (unsigned int) mdec
->uuid
[3],
184 (unsigned int) mdec
->uuid
[4],
185 (unsigned int) mdec
->uuid
[5],
186 (unsigned int) mdec
->uuid
[6],
187 (unsigned int) mdec
->uuid
[7],
188 (unsigned int) mdec
->uuid
[8],
189 (unsigned int) mdec
->uuid
[9],
190 (unsigned int) mdec
->uuid
[10],
191 (unsigned int) mdec
->uuid
[11],
192 (unsigned int) mdec
->uuid
[12],
193 (unsigned int) mdec
->uuid
[13],
194 (unsigned int) mdec
->uuid
[14],
195 (unsigned int) mdec
->uuid
[15],
201 if ((header
.content_size
/ CHAR_BIT
) < sizeof(header
)) {
202 BT_LOGE("Bad metadata packet content size: content-size=%u, "
203 "offset=%ld", header
.content_size
, offset
);
207 toread
= header
.content_size
/ CHAR_BIT
- sizeof(header
);
210 readlen
= fread(buf
, sizeof(uint8_t),
211 MIN(sizeof(buf
) - 1, toread
), in_fp
);
213 BT_LOGE("Cannot read metadata packet buffer: "
214 "offset=%ld, read-size=%u",
215 ftell(in_fp
), (unsigned int) readlen
);
219 writelen
= fwrite(buf
, sizeof(uint8_t), readlen
, out_fp
);
220 if (writelen
< readlen
|| ferror(out_fp
)) {
221 BT_LOGE("Cannot write decoded metadata text to buffer: "
222 "read-offset=%ld, write-size=%u",
223 ftell(in_fp
), (unsigned int) readlen
);
231 /* Read leftover padding */
232 toread
= (header
.packet_size
- header
.content_size
) /
234 fseek_ret
= fseek(in_fp
, toread
, SEEK_CUR
);
236 BT_LOGW_STR("Missing padding at the end of the metadata stream.");
252 int ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
253 struct ctf_metadata_decoder
*mdec
, FILE *fp
,
254 char **buf
, int byte_order
)
260 size_t packet_index
= 0;
262 out_fp
= bt_open_memstream(buf
, &size
);
263 if (out_fp
== NULL
) {
264 BT_LOGE("Cannot open memory stream: %s: mdec-addr=%p",
265 strerror(errno
), mdec
);
274 tret
= decode_packet(mdec
, fp
, out_fp
, byte_order
);
276 BT_LOGE("Cannot decode packet: index=%zu, mdec-addr=%p",
284 /* Make sure the whole string ends with a null character */
285 tret
= fputc('\0', out_fp
);
287 BT_LOGE("Cannot append '\\0' to the decoded metadata buffer: "
288 "mdec-addr=%p", mdec
);
292 /* Close stream, which also flushes the buffer */
293 ret
= bt_close_memstream(buf
, &size
, out_fp
);
295 BT_LOGE("Cannot close memory stream: %s: mdec-addr=%p",
296 strerror(errno
), mdec
);
306 if (bt_close_memstream(buf
, &size
, out_fp
)) {
307 BT_LOGE("Cannot close memory stream: %s: mdec-addr=%p",
308 strerror(errno
), mdec
);
322 int ctf_metadata_decoder_packetized_file_stream_to_buf(
323 FILE *fp
, char **buf
, int byte_order
)
325 return ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
326 NULL
, fp
, buf
, byte_order
);
330 struct ctf_metadata_decoder
*ctf_metadata_decoder_create(
331 const struct ctf_metadata_decoder_config
*config
,
334 struct ctf_metadata_decoder
*mdec
=
335 g_new0(struct ctf_metadata_decoder
, 1);
336 struct ctf_metadata_decoder_config default_config
= {
337 .clock_class_offset_s
= 0,
338 .clock_class_offset_ns
= 0,
342 config
= &default_config
;
345 BT_LOGD("Creating CTF metadata decoder: "
346 "clock-class-offset-s=%" PRId64
", "
347 "clock-class-offset-ns=%" PRId64
", name=\"%s\"",
348 config
->clock_class_offset_s
, config
->clock_class_offset_ns
,
352 BT_LOGE_STR("Failed to allocate one CTF metadata decoder.");
356 mdec
->config
= *config
;
357 mdec
->visitor
= ctf_visitor_generate_ir_create(config
, name
);
358 if (!mdec
->visitor
) {
359 BT_LOGE("Failed to create a CTF IR metadata AST visitor: "
360 "mdec-addr=%p", mdec
);
361 ctf_metadata_decoder_destroy(mdec
);
366 BT_LOGD("Creating CTF metadata decoder: "
367 "clock-class-offset-s=%" PRId64
", "
368 "clock-class-offset-ns=%" PRId64
", "
369 "name=\"%s\", addr=%p",
370 config
->clock_class_offset_s
, config
->clock_class_offset_ns
,
378 void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder
*mdec
)
384 BT_LOGD("Destroying CTF metadata decoder: addr=%p", mdec
);
385 ctf_visitor_generate_ir_destroy(mdec
->visitor
);
390 enum ctf_metadata_decoder_status
ctf_metadata_decoder_decode(
391 struct ctf_metadata_decoder
*mdec
, FILE *fp
)
393 enum ctf_metadata_decoder_status status
=
394 CTF_METADATA_DECODER_STATUS_OK
;
396 struct ctf_scanner
*scanner
= NULL
;
398 bool close_fp
= false;
402 if (ctf_metadata_decoder_is_packetized(fp
, &mdec
->bo
)) {
403 BT_LOGD("Metadata stream is packetized: mdec-addr=%p", mdec
);
404 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
405 mdec
, fp
, &buf
, mdec
->bo
);
407 BT_LOGE("Cannot decode packetized metadata packets to metadata text: "
408 "mdec-addr=%p, ret=%d", mdec
, ret
);
409 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
413 if (strlen(buf
) == 0) {
414 /* An empty metadata packet is OK. */
418 /* Convert the real file pointer to a memory file pointer */
419 fp
= bt_fmemopen(buf
, strlen(buf
), "rb");
422 BT_LOGE("Cannot memory-open metadata buffer: %s: "
423 "mdec-addr=%p", strerror(errno
), mdec
);
424 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
428 unsigned int major
, minor
;
430 const long init_pos
= ftell(fp
);
432 BT_LOGD("Metadata stream is plain text: mdec-addr=%p", mdec
);
434 /* Check text-only metadata header and version */
435 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
437 BT_LOGW("Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
438 "mdec-addr=%p", mdec
);
441 BT_LOGD("Found metadata stream version in signature: version=%u.%u", major
, minor
);
443 if (!is_version_valid(major
, minor
)) {
444 BT_LOGE("Invalid metadata version found in plain text signature: "
445 "version=%u.%u, mdec-addr=%p", major
, minor
,
447 status
= CTF_METADATA_DECODER_STATUS_INVAL_VERSION
;
451 if (fseek(fp
, init_pos
, SEEK_SET
)) {
452 BT_LOGE("Cannot seek metadata file stream to initial position: %s: "
453 "mdec-addr=%p", strerror(errno
), mdec
);
454 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
459 if (BT_LOG_ON_VERBOSE
) {
463 /* Allocate a scanner and append the metadata text content */
464 scanner
= ctf_scanner_alloc();
466 BT_LOGE("Cannot allocate a metadata lexical scanner: "
467 "mdec-addr=%p", mdec
);
468 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
473 ret
= ctf_scanner_append_ast(scanner
, fp
);
475 BT_LOGE("Cannot create the metadata AST out of the metadata text: "
476 "mdec-addr=%p", mdec
);
477 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
481 ret
= ctf_visitor_semantic_check(0, &scanner
->ast
->root
);
483 BT_LOGE("Validation of the metadata semantics failed: "
484 "mdec-addr=%p", mdec
);
485 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
489 ret
= ctf_visitor_generate_ir_visit_node(mdec
->visitor
,
490 &scanner
->ast
->root
);
496 BT_LOGD("While visiting metadata AST: incomplete data: "
497 "mdec-addr=%p", mdec
);
498 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
501 BT_LOGE("Failed to visit AST node to create CTF IR objects: "
502 "mdec-addr=%p, ret=%d", mdec
, ret
);
503 status
= CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
;
509 ctf_scanner_free(scanner
);
514 if (fp
&& close_fp
) {
516 BT_LOGE("Cannot close metadata file stream: "
517 "mdec-addr=%p", mdec
);
529 struct bt_ctf_trace
*ctf_metadata_decoder_get_trace(
530 struct ctf_metadata_decoder
*mdec
)
532 return ctf_visitor_generate_ir_get_trace(mdec
->visitor
);