Commit | Line | Data |
---|---|---|
3c8252a5 | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
3c8252a5 | 3 | * |
0235b0db | 4 | * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com> |
3c8252a5 PP |
5 | */ |
6 | ||
c802cacb | 7 | #include <glib.h> |
c802cacb | 8 | #include <stdint.h> |
c802cacb SM |
9 | #include <stdlib.h> |
10 | #include <string.h> | |
11 | ||
12 | #include <babeltrace2/babeltrace.h> | |
13 | ||
4164020e | 14 | #define BT_COMP_LOG_SELF_COMP self_comp |
50f6fce8 | 15 | #define BT_COMP_LOG_SELF_COMP_CLASS self_comp_class |
4164020e SM |
16 | #define BT_LOG_OUTPUT_LEVEL log_level |
17 | #define BT_LOG_TAG "PLUGIN/CTF/META/DECODER-DECODE-PACKET" | |
c802cacb | 18 | #include "logging.hpp" |
d9c39b0a | 19 | #include "logging/comp-logging.h" |
3c8252a5 | 20 | |
6162e6b7 | 21 | #include "common/uuid.h" |
3c8252a5 | 22 | #include "compat/memstream.h" |
3c8252a5 | 23 | |
c802cacb | 24 | #include "decoder-packetized-file-stream-to-buf.hpp" |
087cd0f5 | 25 | #include "decoder.hpp" |
3c8252a5 | 26 | |
4164020e | 27 | #define TSDL_MAGIC 0x75d11d57 |
3c8252a5 | 28 | |
4164020e SM |
29 | struct ctf_metadata_decoder |
30 | { | |
31 | struct ctf_visitor_generate_ir *visitor; | |
32 | bt_uuid_t uuid; | |
33 | bool is_uuid_set; | |
34 | int bo; | |
35 | struct ctf_metadata_decoder_config config; | |
3c8252a5 PP |
36 | }; |
37 | ||
4164020e SM |
38 | struct packet_header |
39 | { | |
40 | uint32_t magic; | |
41 | bt_uuid_t uuid; | |
42 | uint32_t checksum; | |
43 | uint32_t content_size; | |
44 | uint32_t packet_size; | |
45 | uint8_t compression_scheme; | |
46 | uint8_t encryption_scheme; | |
47 | uint8_t checksum_scheme; | |
48 | uint8_t major; | |
49 | uint8_t minor; | |
3c8252a5 PP |
50 | } __attribute__((__packed__)); |
51 | ||
4164020e SM |
52 | static int decode_packet(FILE *in_fp, FILE *out_fp, int byte_order, bool *is_uuid_set, |
53 | uint8_t *uuid, bt_logging_level log_level, bt_self_component *self_comp, | |
54 | bt_self_component_class *self_comp_class) | |
3c8252a5 | 55 | { |
4164020e SM |
56 | struct packet_header header; |
57 | size_t readlen, writelen, toread; | |
58 | uint8_t buf[512 + 1]; /* + 1 for debug-mode \0 */ | |
59 | int ret = 0; | |
60 | const long offset = ftell(in_fp); | |
61 | ||
62 | if (offset < 0) { | |
63 | BT_COMP_LOGE_APPEND_CAUSE_ERRNO(BT_COMP_LOG_SELF_COMP, | |
64 | "Failed to get current metadata file position", "."); | |
65 | goto error; | |
66 | } | |
67 | BT_COMP_LOGD("Decoding metadata packet: offset=%ld", offset); | |
68 | readlen = fread(&header, sizeof(header), 1, in_fp); | |
69 | if (feof(in_fp) != 0) { | |
70 | BT_COMP_LOGI("Reached end of file: offset=%ld", ftell(in_fp)); | |
71 | goto end; | |
72 | } | |
73 | if (readlen < 1) { | |
74 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot decode metadata packet: offset=%ld", | |
75 | offset); | |
76 | goto error; | |
77 | } | |
78 | ||
79 | if (byte_order != BYTE_ORDER) { | |
80 | header.magic = GUINT32_SWAP_LE_BE(header.magic); | |
81 | header.checksum = GUINT32_SWAP_LE_BE(header.checksum); | |
82 | header.content_size = GUINT32_SWAP_LE_BE(header.content_size); | |
83 | header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size); | |
84 | } | |
85 | ||
86 | if (header.compression_scheme) { | |
87 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE( | |
88 | "Metadata packet compression is not supported as of this version: " | |
89 | "compression-scheme=%u, offset=%ld", | |
90 | (unsigned int) header.compression_scheme, offset); | |
91 | goto error; | |
92 | } | |
93 | ||
94 | if (header.encryption_scheme) { | |
95 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE( | |
96 | "Metadata packet encryption is not supported as of this version: " | |
97 | "encryption-scheme=%u, offset=%ld", | |
98 | (unsigned int) header.encryption_scheme, offset); | |
99 | goto error; | |
100 | } | |
101 | ||
102 | if (header.checksum || header.checksum_scheme) { | |
103 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE( | |
104 | "Metadata packet checksum verification is not supported as of this version: " | |
105 | "checksum-scheme=%u, checksum=%x, offset=%ld", | |
106 | (unsigned int) header.checksum_scheme, header.checksum, offset); | |
107 | goto error; | |
108 | } | |
109 | ||
110 | if (!ctf_metadata_decoder_is_packet_version_valid(header.major, header.minor)) { | |
111 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Invalid metadata packet version: " | |
112 | "version=%u.%u, offset=%ld", | |
113 | header.major, header.minor, offset); | |
114 | goto error; | |
115 | } | |
116 | ||
117 | /* Set expected trace UUID if not set; otherwise validate it */ | |
118 | if (is_uuid_set) { | |
119 | if (!*is_uuid_set) { | |
120 | bt_uuid_copy(uuid, header.uuid); | |
121 | *is_uuid_set = true; | |
122 | } else if (bt_uuid_compare(header.uuid, uuid)) { | |
123 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE( | |
124 | "Metadata UUID mismatch between packets of the same stream: " | |
125 | "packet-uuid=\"" BT_UUID_FMT "\", " | |
126 | "expected-uuid=\"" BT_UUID_FMT "\", " | |
127 | "offset=%ld", | |
128 | BT_UUID_FMT_VALUES(header.uuid), BT_UUID_FMT_VALUES(uuid), offset); | |
129 | goto error; | |
130 | } | |
131 | } | |
132 | ||
133 | if ((header.content_size / CHAR_BIT) < sizeof(header)) { | |
134 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE( | |
135 | "Bad metadata packet content size: content-size=%u, " | |
136 | "offset=%ld", | |
137 | header.content_size, offset); | |
138 | goto error; | |
139 | } | |
140 | ||
141 | toread = header.content_size / CHAR_BIT - sizeof(header); | |
142 | ||
143 | for (;;) { | |
144 | size_t loop_read; | |
145 | ||
146 | loop_read = MIN(sizeof(buf) - 1, toread); | |
147 | readlen = fread(buf, sizeof(uint8_t), loop_read, in_fp); | |
148 | if (ferror(in_fp)) { | |
149 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot read metadata packet buffer: " | |
150 | "offset=%ld, read-size=%zu", | |
151 | ftell(in_fp), loop_read); | |
152 | goto error; | |
153 | } | |
154 | if (readlen > loop_read) { | |
155 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("fread returned more byte than expected: " | |
156 | "read-size-asked=%zu, read-size-returned=%zu", | |
157 | loop_read, readlen); | |
158 | goto error; | |
159 | } | |
160 | ||
161 | writelen = fwrite(buf, sizeof(uint8_t), readlen, out_fp); | |
162 | if (writelen < readlen || ferror(out_fp)) { | |
163 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE( | |
164 | "Cannot write decoded metadata text to buffer: " | |
165 | "read-offset=%ld, write-size=%zu", | |
166 | ftell(in_fp), readlen); | |
167 | goto error; | |
168 | } | |
169 | ||
170 | toread -= readlen; | |
171 | if (toread == 0) { | |
172 | int fseek_ret; | |
173 | ||
174 | /* Read leftover padding */ | |
175 | toread = (header.packet_size - header.content_size) / CHAR_BIT; | |
176 | fseek_ret = fseek(in_fp, toread, SEEK_CUR); | |
177 | if (fseek_ret < 0) { | |
178 | BT_COMP_LOGW_STR("Missing padding at the end of the metadata stream."); | |
179 | } | |
180 | break; | |
181 | } | |
182 | } | |
183 | ||
184 | goto end; | |
3c8252a5 PP |
185 | |
186 | error: | |
4164020e | 187 | ret = -1; |
3c8252a5 PP |
188 | |
189 | end: | |
4164020e | 190 | return ret; |
3c8252a5 PP |
191 | } |
192 | ||
4164020e SM |
193 | int ctf_metadata_decoder_packetized_file_stream_to_buf(FILE *fp, char **buf, int byte_order, |
194 | bool *is_uuid_set, uint8_t *uuid, | |
195 | bt_logging_level log_level, | |
196 | bt_self_component *self_comp, | |
197 | bt_self_component_class *self_comp_class) | |
3c8252a5 | 198 | { |
4164020e SM |
199 | FILE *out_fp; |
200 | size_t size; | |
201 | int ret = 0; | |
202 | int tret; | |
203 | size_t packet_index = 0; | |
204 | ||
205 | out_fp = bt_open_memstream(buf, &size); | |
206 | if (!out_fp) { | |
207 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot open memory stream: %s.", strerror(errno)); | |
208 | goto error; | |
209 | } | |
210 | ||
211 | for (;;) { | |
212 | if (feof(fp) != 0) { | |
213 | break; | |
214 | } | |
215 | ||
216 | tret = decode_packet(fp, out_fp, byte_order, is_uuid_set, uuid, log_level, self_comp, | |
217 | self_comp_class); | |
218 | if (tret) { | |
219 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot decode packet: index=%zu", | |
220 | packet_index); | |
221 | goto error; | |
222 | } | |
223 | ||
224 | packet_index++; | |
225 | } | |
226 | ||
227 | /* Make sure the whole string ends with a null character */ | |
228 | tret = fputc('\0', out_fp); | |
229 | if (tret == EOF) { | |
230 | _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE( | |
231 | "Cannot append '\\0' to the decoded metadata buffer."); | |
232 | goto error; | |
233 | } | |
234 | ||
235 | /* Close stream, which also flushes the buffer */ | |
236 | ret = bt_close_memstream(buf, &size, out_fp); | |
237 | /* | |
238 | * See fclose(3). Further access to out_fp after both success | |
239 | * and error, even through another bt_close_memstream(), results | |
240 | * in undefined behavior. Nullify out_fp to ensure we don't | |
241 | * fclose it twice on error. | |
242 | */ | |
243 | out_fp = NULL; | |
244 | if (ret < 0) { | |
245 | BT_COMP_LOGE_APPEND_CAUSE_ERRNO(BT_COMP_LOG_SELF_COMP, "Cannot close memory stream", "."); | |
246 | goto error; | |
247 | } | |
248 | ||
249 | goto end; | |
3c8252a5 PP |
250 | |
251 | error: | |
4164020e | 252 | ret = -1; |
3c8252a5 | 253 | |
4164020e SM |
254 | if (out_fp) { |
255 | if (bt_close_memstream(buf, &size, out_fp)) { | |
256 | BT_COMP_LOGE_ERRNO("Cannot close memory stream", "."); | |
257 | } | |
258 | } | |
3c8252a5 | 259 | |
4164020e SM |
260 | if (*buf) { |
261 | free(*buf); | |
262 | *buf = NULL; | |
263 | } | |
3c8252a5 PP |
264 | |
265 | end: | |
4164020e | 266 | return ret; |
3c8252a5 | 267 | } |