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 "plugins/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
42 struct ctf_metadata_decoder
{
43 struct ctf_visitor_generate_ir
*visitor
;
47 struct ctf_metadata_decoder_config config
;
50 struct packet_header
{
54 uint32_t content_size
;
56 uint8_t compression_scheme
;
57 uint8_t encryption_scheme
;
58 uint8_t checksum_scheme
;
61 } __attribute__((__packed__
));
64 int decode_packet(FILE *in_fp
, FILE *out_fp
,
65 int byte_order
, bool *is_uuid_set
, uint8_t *uuid
,
66 bt_logging_level log_level
, bt_self_component
*self_comp
)
68 struct packet_header header
;
69 size_t readlen
, writelen
, toread
;
70 uint8_t buf
[512 + 1]; /* + 1 for debug-mode \0 */
72 const long offset
= ftell(in_fp
);
75 BT_COMP_LOGE_ERRNO("Failed to get current metadata file position",
79 BT_COMP_LOGD("Decoding metadata packet: offset=%ld", offset
);
80 readlen
= fread(&header
, sizeof(header
), 1, in_fp
);
81 if (feof(in_fp
) != 0) {
82 BT_COMP_LOGI("Reached end of file: offset=%ld", ftell(in_fp
));
86 BT_COMP_LOGE("Cannot decode metadata packet: offset=%ld", offset
);
90 if (byte_order
!= BYTE_ORDER
) {
91 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
92 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
93 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
94 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
97 if (header
.compression_scheme
) {
98 BT_COMP_LOGE("Metadata packet compression is not supported as of this version: "
99 "compression-scheme=%u, offset=%ld",
100 (unsigned int) header
.compression_scheme
, offset
);
104 if (header
.encryption_scheme
) {
105 BT_COMP_LOGE("Metadata packet encryption is not supported as of this version: "
106 "encryption-scheme=%u, offset=%ld",
107 (unsigned int) header
.encryption_scheme
, offset
);
111 if (header
.checksum
|| header
.checksum_scheme
) {
112 BT_COMP_LOGE("Metadata packet checksum verification is not supported as of this version: "
113 "checksum-scheme=%u, checksum=%x, offset=%ld",
114 (unsigned int) header
.checksum_scheme
, header
.checksum
,
119 if (!ctf_metadata_decoder_is_packet_version_valid(header
.major
,
121 BT_COMP_LOGE("Invalid metadata packet version: "
122 "version=%u.%u, offset=%ld",
123 header
.major
, header
.minor
, offset
);
127 /* Set expected trace UUID if not set; otherwise validate it */
130 bt_uuid_copy(uuid
, header
.uuid
);
132 } else if (bt_uuid_compare(header
.uuid
, uuid
)) {
133 BT_COMP_LOGE("Metadata UUID mismatch between packets of the same stream: "
134 "packet-uuid=\"" BT_UUID_FMT
"\", "
135 "expected-uuid=\"" BT_UUID_FMT
"\", "
137 BT_UUID_FMT_VALUES(header
.uuid
),
138 BT_UUID_FMT_VALUES(uuid
),
144 if ((header
.content_size
/ CHAR_BIT
) < sizeof(header
)) {
145 BT_COMP_LOGE("Bad metadata packet content size: content-size=%u, "
146 "offset=%ld", header
.content_size
, offset
);
150 toread
= header
.content_size
/ CHAR_BIT
- sizeof(header
);
155 loop_read
= MIN(sizeof(buf
) - 1, toread
);
156 readlen
= fread(buf
, sizeof(uint8_t), loop_read
, in_fp
);
158 BT_COMP_LOGE("Cannot read metadata packet buffer: "
159 "offset=%ld, read-size=%zu",
160 ftell(in_fp
), loop_read
);
163 if (readlen
> loop_read
) {
164 BT_COMP_LOGE("fread returned more byte than expected: "
165 "read-size-asked=%zu, read-size-returned=%zu",
170 writelen
= fwrite(buf
, sizeof(uint8_t), readlen
, out_fp
);
171 if (writelen
< readlen
|| ferror(out_fp
)) {
172 BT_COMP_LOGE("Cannot write decoded metadata text to buffer: "
173 "read-offset=%ld, write-size=%zu",
174 ftell(in_fp
), readlen
);
182 /* Read leftover padding */
183 toread
= (header
.packet_size
- header
.content_size
) /
185 fseek_ret
= fseek(in_fp
, toread
, SEEK_CUR
);
187 BT_COMP_LOGW_STR("Missing padding at the end of the metadata stream.");
203 int ctf_metadata_decoder_packetized_file_stream_to_buf(FILE *fp
,
204 char **buf
, int byte_order
, bool *is_uuid_set
,
205 uint8_t *uuid
, bt_logging_level log_level
,
206 bt_self_component
*self_comp
)
212 size_t packet_index
= 0;
214 out_fp
= bt_open_memstream(buf
, &size
);
216 BT_COMP_LOGE("Cannot open memory stream: %s.",
226 tret
= decode_packet(fp
, out_fp
, byte_order
, is_uuid_set
,
227 uuid
, log_level
, self_comp
);
229 BT_COMP_LOGE("Cannot decode packet: index=%zu",
237 /* Make sure the whole string ends with a null character */
238 tret
= fputc('\0', out_fp
);
241 "Cannot append '\\0' to the decoded metadata buffer.");
245 /* Close stream, which also flushes the buffer */
246 ret
= bt_close_memstream(buf
, &size
, out_fp
);
248 * See fclose(3). Further access to out_fp after both success
249 * and error, even through another bt_close_memstream(), results
250 * in undefined behavior. Nullify out_fp to ensure we don't
251 * fclose it twice on error.
255 BT_COMP_LOGE_ERRNO("Cannot close memory stream", ".");
265 if (bt_close_memstream(buf
, &size
, out_fp
)) {
266 BT_COMP_LOGE_ERRNO("Cannot close memory stream", ".");