2 * SPDX-License-Identifier: MIT
4 * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
15 #include <babeltrace2/babeltrace.h>
17 #define BT_COMP_LOG_SELF_COMP self_comp
18 #define BT_COMP_LOG_SELF_COMP_CLASS self_comp_class
19 #define BT_LOG_OUTPUT_LEVEL log_level
20 #define BT_LOG_TAG "PLUGIN/CTF/META/DECODER-DECODE-PACKET"
21 #include "logging.hpp"
22 #include "logging/comp-logging.h"
24 #include "common/assert.h"
25 #include "common/uuid.h"
26 #include "compat/memstream.h"
29 #include "decoder-packetized-file-stream-to-buf.hpp"
30 #include "decoder.hpp"
31 #include "scanner.hpp"
33 #define TSDL_MAGIC 0x75d11d57
35 struct ctf_metadata_decoder
37 struct ctf_visitor_generate_ir
*visitor
;
41 struct ctf_metadata_decoder_config config
;
49 uint32_t content_size
;
51 uint8_t compression_scheme
;
52 uint8_t encryption_scheme
;
53 uint8_t checksum_scheme
;
56 } __attribute__((__packed__
));
58 static int decode_packet(FILE *in_fp
, FILE *out_fp
, int byte_order
, bool *is_uuid_set
,
59 uint8_t *uuid
, bt_logging_level log_level
, bt_self_component
*self_comp
,
60 bt_self_component_class
*self_comp_class
)
62 struct packet_header header
;
63 size_t readlen
, writelen
, toread
;
64 uint8_t buf
[512 + 1]; /* + 1 for debug-mode \0 */
66 const long offset
= ftell(in_fp
);
69 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(BT_COMP_LOG_SELF_COMP
,
70 "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",
85 if (byte_order
!= BYTE_ORDER
) {
86 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
87 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
88 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
89 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
92 if (header
.compression_scheme
) {
93 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
94 "Metadata packet compression is not supported as of this version: "
95 "compression-scheme=%u, offset=%ld",
96 (unsigned int) header
.compression_scheme
, offset
);
100 if (header
.encryption_scheme
) {
101 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
102 "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_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
110 "Metadata packet checksum verification is not supported as of this version: "
111 "checksum-scheme=%u, checksum=%x, offset=%ld",
112 (unsigned int) header
.checksum_scheme
, header
.checksum
, offset
);
116 if (!ctf_metadata_decoder_is_packet_version_valid(header
.major
, header
.minor
)) {
117 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Invalid metadata packet version: "
118 "version=%u.%u, offset=%ld",
119 header
.major
, header
.minor
, offset
);
123 /* Set expected trace UUID if not set; otherwise validate it */
126 bt_uuid_copy(uuid
, header
.uuid
);
128 } else if (bt_uuid_compare(header
.uuid
, uuid
)) {
129 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
130 "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
), BT_UUID_FMT_VALUES(uuid
), offset
);
139 if ((header
.content_size
/ CHAR_BIT
) < sizeof(header
)) {
140 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
141 "Bad metadata packet content size: content-size=%u, "
143 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_OR_COMP_CLASS_LOGE_APPEND_CAUSE("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_OR_COMP_CLASS_LOGE_APPEND_CAUSE("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_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
170 "Cannot write decoded metadata text to buffer: "
171 "read-offset=%ld, write-size=%zu",
172 ftell(in_fp
), readlen
);
180 /* Read leftover padding */
181 toread
= (header
.packet_size
- header
.content_size
) / CHAR_BIT
;
182 fseek_ret
= fseek(in_fp
, toread
, SEEK_CUR
);
184 BT_COMP_LOGW_STR("Missing padding at the end of the metadata stream.");
199 int ctf_metadata_decoder_packetized_file_stream_to_buf(FILE *fp
, char **buf
, int byte_order
,
200 bool *is_uuid_set
, uint8_t *uuid
,
201 bt_logging_level log_level
,
202 bt_self_component
*self_comp
,
203 bt_self_component_class
*self_comp_class
)
209 size_t packet_index
= 0;
211 out_fp
= bt_open_memstream(buf
, &size
);
213 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot open memory stream: %s.", strerror(errno
));
222 tret
= decode_packet(fp
, out_fp
, byte_order
, is_uuid_set
, uuid
, log_level
, self_comp
,
225 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot decode packet: index=%zu",
233 /* Make sure the whole string ends with a null character */
234 tret
= fputc('\0', out_fp
);
236 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
237 "Cannot append '\\0' to the decoded metadata buffer.");
241 /* Close stream, which also flushes the buffer */
242 ret
= bt_close_memstream(buf
, &size
, out_fp
);
244 * See fclose(3). Further access to out_fp after both success
245 * and error, even through another bt_close_memstream(), results
246 * in undefined behavior. Nullify out_fp to ensure we don't
247 * fclose it twice on error.
251 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(BT_COMP_LOG_SELF_COMP
, "Cannot close memory stream", ".");
261 if (bt_close_memstream(buf
, &size
, out_fp
)) {
262 BT_COMP_LOGE_ERRNO("Cannot close memory stream", ".");