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_COMP_LOG_SELF_COMP self_comp
16 #define BT_LOG_OUTPUT_LEVEL log_level
17 #define BT_LOG_TAG "PLUGIN/CTF/META/DECODER-DECODE-PACKET"
18 #include "logging/comp-logging.h"
25 #include "common/assert.h"
26 #include "common/uuid.h"
27 #include "compat/memstream.h"
28 #include <babeltrace2/babeltrace.h>
37 #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 int decode_packet(FILE *in_fp
, FILE *out_fp
,
62 int byte_order
, bool *is_uuid_set
, uint8_t *uuid
,
63 bt_logging_level log_level
, bt_self_component
*self_comp
)
65 struct packet_header header
;
66 size_t readlen
, writelen
, toread
;
67 uint8_t buf
[512 + 1]; /* + 1 for debug-mode \0 */
69 const long offset
= ftell(in_fp
);
72 BT_COMP_LOGE_ERRNO("Failed to get current metadata file position",
76 BT_COMP_LOGD("Decoding metadata packet: offset=%ld", offset
);
77 readlen
= fread(&header
, sizeof(header
), 1, in_fp
);
78 if (feof(in_fp
) != 0) {
79 BT_COMP_LOGI("Reached end of file: offset=%ld", ftell(in_fp
));
83 BT_COMP_LOGE("Cannot decode metadata packet: offset=%ld", offset
);
87 if (byte_order
!= BYTE_ORDER
) {
88 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
89 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
90 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
91 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
94 if (header
.compression_scheme
) {
95 BT_COMP_LOGE("Metadata packet compression is not supported as of this version: "
96 "compression-scheme=%u, offset=%ld",
97 (unsigned int) header
.compression_scheme
, offset
);
101 if (header
.encryption_scheme
) {
102 BT_COMP_LOGE("Metadata packet encryption is not supported as of this version: "
103 "encryption-scheme=%u, offset=%ld",
104 (unsigned int) header
.encryption_scheme
, offset
);
108 if (header
.checksum
|| header
.checksum_scheme
) {
109 BT_COMP_LOGE("Metadata packet checksum verification is not supported as of this version: "
110 "checksum-scheme=%u, checksum=%x, offset=%ld",
111 (unsigned int) header
.checksum_scheme
, header
.checksum
,
116 if (!ctf_metadata_decoder_is_packet_version_valid(header
.major
,
118 BT_COMP_LOGE("Invalid metadata packet version: "
119 "version=%u.%u, offset=%ld",
120 header
.major
, header
.minor
, offset
);
124 /* Set expected trace UUID if not set; otherwise validate it */
127 bt_uuid_copy(uuid
, header
.uuid
);
129 } else if (bt_uuid_compare(header
.uuid
, uuid
)) {
130 BT_COMP_LOGE("Metadata UUID mismatch between packets of the same stream: "
131 "packet-uuid=\"" BT_UUID_FMT
"\", "
132 "expected-uuid=\"" BT_UUID_FMT
"\", "
134 BT_UUID_FMT_VALUES(header
.uuid
),
135 BT_UUID_FMT_VALUES(uuid
),
141 if ((header
.content_size
/ CHAR_BIT
) < sizeof(header
)) {
142 BT_COMP_LOGE("Bad metadata packet content size: content-size=%u, "
143 "offset=%ld", header
.content_size
, offset
);
147 toread
= header
.content_size
/ CHAR_BIT
- sizeof(header
);
152 loop_read
= MIN(sizeof(buf
) - 1, toread
);
153 readlen
= fread(buf
, sizeof(uint8_t), loop_read
, in_fp
);
155 BT_COMP_LOGE("Cannot read metadata packet buffer: "
156 "offset=%ld, read-size=%zu",
157 ftell(in_fp
), loop_read
);
160 if (readlen
> loop_read
) {
161 BT_COMP_LOGE("fread returned more byte than expected: "
162 "read-size-asked=%zu, read-size-returned=%zu",
167 writelen
= fwrite(buf
, sizeof(uint8_t), readlen
, out_fp
);
168 if (writelen
< readlen
|| ferror(out_fp
)) {
169 BT_COMP_LOGE("Cannot write decoded metadata text to buffer: "
170 "read-offset=%ld, write-size=%zu",
171 ftell(in_fp
), readlen
);
179 /* Read leftover padding */
180 toread
= (header
.packet_size
- header
.content_size
) /
182 fseek_ret
= fseek(in_fp
, toread
, SEEK_CUR
);
184 BT_COMP_LOGW_STR("Missing padding at the end of the metadata stream.");
200 int ctf_metadata_decoder_packetized_file_stream_to_buf(FILE *fp
,
201 char **buf
, int byte_order
, bool *is_uuid_set
,
202 uint8_t *uuid
, bt_logging_level log_level
,
203 bt_self_component
*self_comp
)
209 size_t packet_index
= 0;
211 out_fp
= bt_open_memstream(buf
, &size
);
213 BT_COMP_LOGE("Cannot open memory stream: %s.",
223 tret
= decode_packet(fp
, out_fp
, byte_order
, is_uuid_set
,
224 uuid
, log_level
, self_comp
);
226 BT_COMP_LOGE("Cannot decode packet: index=%zu",
234 /* Make sure the whole string ends with a null character */
235 tret
= fputc('\0', out_fp
);
238 "Cannot append '\\0' to the decoded metadata buffer.");
242 /* Close stream, which also flushes the buffer */
243 ret
= bt_close_memstream(buf
, &size
, out_fp
);
245 * See fclose(3). Further access to out_fp after both success
246 * and error, even through another bt_close_memstream(), results
247 * in undefined behavior. Nullify out_fp to ensure we don't
248 * fclose it twice on error.
252 BT_COMP_LOGE_ERRNO("Cannot close memory stream", ".");
262 if (bt_close_memstream(buf
, &size
, out_fp
)) {
263 BT_COMP_LOGE_ERRNO("Cannot close memory stream", ".");