2 * SPDX-License-Identifier: MIT
4 * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
7 #define BT_COMP_LOG_SELF_COMP self_comp
8 #define BT_COMP_LOG_SELF_COMP_CLASS self_comp_class
9 #define BT_LOG_OUTPUT_LEVEL log_level
10 #define BT_LOG_TAG "PLUGIN/CTF/META/DECODER-DECODE-PACKET"
11 #include "logging/comp-logging.h"
13 #include "decoder-packetized-file-stream-to-buf.h"
20 #include "common/assert.h"
21 #include "common/uuid.h"
22 #include "compat/memstream.h"
23 #include <babeltrace2/babeltrace.h>
32 #define TSDL_MAGIC 0x75d11d57
34 struct ctf_metadata_decoder
{
35 struct ctf_visitor_generate_ir
*visitor
;
39 struct ctf_metadata_decoder_config config
;
42 struct packet_header
{
46 uint32_t content_size
;
48 uint8_t compression_scheme
;
49 uint8_t encryption_scheme
;
50 uint8_t checksum_scheme
;
53 } __attribute__((__packed__
));
56 int decode_packet(FILE *in_fp
, FILE *out_fp
,
57 int byte_order
, bool *is_uuid_set
, uint8_t *uuid
,
58 bt_logging_level log_level
, bt_self_component
*self_comp
,
59 bt_self_component_class
*self_comp_class
)
61 struct packet_header header
;
62 size_t readlen
, writelen
, toread
;
63 uint8_t buf
[512 + 1]; /* + 1 for debug-mode \0 */
65 const long offset
= ftell(in_fp
);
68 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(BT_COMP_LOG_SELF_COMP
,
69 "Failed to get current metadata file position",
73 BT_COMP_LOGD("Decoding metadata packet: offset=%ld", offset
);
74 readlen
= fread(&header
, sizeof(header
), 1, in_fp
);
75 if (feof(in_fp
) != 0) {
76 BT_COMP_LOGI("Reached end of file: offset=%ld", ftell(in_fp
));
80 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot decode metadata packet: offset=%ld", offset
);
84 if (byte_order
!= BYTE_ORDER
) {
85 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
86 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
87 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
88 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
91 if (header
.compression_scheme
) {
92 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Metadata packet compression is not supported as of this version: "
93 "compression-scheme=%u, offset=%ld",
94 (unsigned int) header
.compression_scheme
, offset
);
98 if (header
.encryption_scheme
) {
99 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Metadata packet encryption is not supported as of this version: "
100 "encryption-scheme=%u, offset=%ld",
101 (unsigned int) header
.encryption_scheme
, offset
);
105 if (header
.checksum
|| header
.checksum_scheme
) {
106 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Metadata packet checksum verification is not supported as of this version: "
107 "checksum-scheme=%u, checksum=%x, offset=%ld",
108 (unsigned int) header
.checksum_scheme
, header
.checksum
,
113 if (!ctf_metadata_decoder_is_packet_version_valid(header
.major
,
115 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Invalid metadata packet version: "
116 "version=%u.%u, offset=%ld",
117 header
.major
, header
.minor
, offset
);
121 /* Set expected trace UUID if not set; otherwise validate it */
124 bt_uuid_copy(uuid
, header
.uuid
);
126 } else if (bt_uuid_compare(header
.uuid
, uuid
)) {
127 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Metadata UUID mismatch between packets of the same stream: "
128 "packet-uuid=\"" BT_UUID_FMT
"\", "
129 "expected-uuid=\"" BT_UUID_FMT
"\", "
131 BT_UUID_FMT_VALUES(header
.uuid
),
132 BT_UUID_FMT_VALUES(uuid
),
138 if ((header
.content_size
/ CHAR_BIT
) < sizeof(header
)) {
139 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Bad metadata packet content size: content-size=%u, "
140 "offset=%ld", header
.content_size
, offset
);
144 toread
= header
.content_size
/ CHAR_BIT
- sizeof(header
);
149 loop_read
= MIN(sizeof(buf
) - 1, toread
);
150 readlen
= fread(buf
, sizeof(uint8_t), loop_read
, in_fp
);
152 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot read metadata packet buffer: "
153 "offset=%ld, read-size=%zu",
154 ftell(in_fp
), loop_read
);
157 if (readlen
> loop_read
) {
158 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("fread returned more byte than expected: "
159 "read-size-asked=%zu, read-size-returned=%zu",
164 writelen
= fwrite(buf
, sizeof(uint8_t), readlen
, out_fp
);
165 if (writelen
< readlen
|| ferror(out_fp
)) {
166 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot write decoded metadata text to buffer: "
167 "read-offset=%ld, write-size=%zu",
168 ftell(in_fp
), readlen
);
176 /* Read leftover padding */
177 toread
= (header
.packet_size
- header
.content_size
) /
179 fseek_ret
= fseek(in_fp
, toread
, SEEK_CUR
);
181 BT_COMP_LOGW_STR("Missing padding at the end of the metadata stream.");
197 int ctf_metadata_decoder_packetized_file_stream_to_buf(FILE *fp
,
198 char **buf
, int byte_order
, bool *is_uuid_set
,
199 uint8_t *uuid
, bt_logging_level log_level
,
200 bt_self_component
*self_comp
,
201 bt_self_component_class
*self_comp_class
)
207 size_t packet_index
= 0;
209 out_fp
= bt_open_memstream(buf
, &size
);
211 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot open memory stream: %s.",
221 tret
= decode_packet(fp
, out_fp
, byte_order
, is_uuid_set
,
222 uuid
, log_level
, self_comp
, self_comp_class
);
224 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot decode packet: index=%zu",
232 /* Make sure the whole string ends with a null character */
233 tret
= fputc('\0', out_fp
);
235 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
236 "Cannot append '\\0' to the decoded metadata buffer.");
240 /* Close stream, which also flushes the buffer */
241 ret
= bt_close_memstream(buf
, &size
, out_fp
);
243 * See fclose(3). Further access to out_fp after both success
244 * and error, even through another bt_close_memstream(), results
245 * in undefined behavior. Nullify out_fp to ensure we don't
246 * fclose it twice on error.
250 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(BT_COMP_LOG_SELF_COMP
, "Cannot close memory stream", ".");
260 if (bt_close_memstream(buf
, &size
, out_fp
)) {
261 BT_COMP_LOGE_ERRNO("Cannot close memory stream", ".");