Commit | Line | Data |
---|---|---|
1e649dff | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
1e649dff | 3 | * |
0235b0db | 4 | * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com> |
1e649dff PP |
5 | */ |
6 | ||
c802cacb SM |
7 | #include <stdint.h> |
8 | #include <stdio.h> | |
9 | #include <stdlib.h> | |
d6e20753 | 10 | |
578e048b | 11 | #include "common/assert.h" |
6162e6b7 | 12 | #include "common/uuid.h" |
578e048b | 13 | #include "compat/memstream.h" |
0f5c5d5c | 14 | #include "cpp-common/vendor/fmt/format.h" |
1e649dff | 15 | |
087cd0f5 | 16 | #include "ast.hpp" |
c802cacb | 17 | #include "decoder-packetized-file-stream-to-buf.hpp" |
087cd0f5 | 18 | #include "decoder.hpp" |
087cd0f5 | 19 | #include "parser-wrap.hpp" |
c802cacb | 20 | #include "scanner.hpp" |
1e649dff | 21 | |
4164020e SM |
22 | #define TSDL_MAGIC 0x75d11d57 |
23 | ||
24 | struct ctf_metadata_decoder | |
25 | { | |
0f5c5d5c SM |
26 | explicit ctf_metadata_decoder(const bt2c::Logger& parentLogger) : |
27 | logger {parentLogger, "PLUGIN/CTF/META/DECODER"}, config {logger} | |
28 | { | |
29 | } | |
30 | ||
31 | bt2c::Logger logger; | |
afb0f12b SM |
32 | struct ctf_scanner *scanner = nullptr; |
33 | GString *text = nullptr; | |
708dab6b | 34 | ctf_visitor_generate_ir::UP visitor; |
afb0f12b SM |
35 | bt_uuid_t uuid {}; |
36 | bool is_uuid_set = false; | |
37 | int bo = 0; | |
4164020e | 38 | struct ctf_metadata_decoder_config config; |
afb0f12b | 39 | bool has_checked_plaintext_signature = false; |
1e649dff PP |
40 | }; |
41 | ||
4164020e SM |
42 | struct packet_header |
43 | { | |
44 | uint32_t magic; | |
45 | bt_uuid_t uuid; | |
46 | uint32_t checksum; | |
47 | uint32_t content_size; | |
48 | uint32_t packet_size; | |
49 | uint8_t compression_scheme; | |
50 | uint8_t encryption_scheme; | |
51 | uint8_t checksum_scheme; | |
52 | uint8_t major; | |
53 | uint8_t minor; | |
1e649dff PP |
54 | } __attribute__((__packed__)); |
55 | ||
4164020e | 56 | int ctf_metadata_decoder_is_packetized(FILE *fp, bool *is_packetized, int *byte_order, |
0f5c5d5c | 57 | const bt2c::Logger& logger) |
1e649dff | 58 | { |
4164020e SM |
59 | uint32_t magic; |
60 | size_t len; | |
61 | int ret = 0; | |
62 | ||
63 | *is_packetized = false; | |
64 | len = fread(&magic, sizeof(magic), 1, fp); | |
65 | if (len != 1) { | |
0f5c5d5c SM |
66 | BT_CPPLOGI_SPEC( |
67 | logger, | |
4164020e SM |
68 | "Cannot read first metadata packet header: assuming the stream is not packetized."); |
69 | ret = -1; | |
70 | goto end; | |
71 | } | |
72 | ||
73 | if (byte_order) { | |
74 | if (magic == TSDL_MAGIC) { | |
75 | *is_packetized = true; | |
76 | *byte_order = BYTE_ORDER; | |
77 | } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) { | |
78 | *is_packetized = true; | |
79 | *byte_order = BYTE_ORDER == BIG_ENDIAN ? LITTLE_ENDIAN : BIG_ENDIAN; | |
80 | } | |
81 | } | |
1e649dff PP |
82 | |
83 | end: | |
4164020e | 84 | rewind(fp); |
1e649dff | 85 | |
4164020e | 86 | return ret; |
1e649dff PP |
87 | } |
88 | ||
1fa280c9 | 89 | ctf_metadata_decoder_up |
4164020e | 90 | ctf_metadata_decoder_create(const struct ctf_metadata_decoder_config *config) |
1e649dff | 91 | { |
4164020e | 92 | BT_ASSERT(config); |
0f5c5d5c SM |
93 | BT_CPPLOGD_SPEC(config->logger, |
94 | "Creating CTF metadata decoder: " | |
95 | "clock-class-offset-s={}, " | |
96 | "clock-class-offset-ns={}", | |
c942e7a2 | 97 | config->clkClsCfg.offsetSec, config->clkClsCfg.offsetNanoSec); |
0f5c5d5c SM |
98 | |
99 | ctf_metadata_decoder *mdec = new ctf_metadata_decoder {config->logger}; | |
100 | mdec->scanner = ctf_scanner_alloc(mdec->logger); | |
4164020e | 101 | if (!mdec->scanner) { |
0f5c5d5c SM |
102 | BT_CPPLOGE_APPEND_CAUSE_SPEC(mdec->logger, |
103 | "Cannot allocate a metadata lexical scanner: " | |
104 | "mdec-addr={}", | |
105 | fmt::ptr(mdec)); | |
4164020e SM |
106 | goto error; |
107 | } | |
108 | ||
109 | mdec->text = g_string_new(NULL); | |
110 | if (!mdec->text) { | |
0f5c5d5c SM |
111 | BT_CPPLOGE_APPEND_CAUSE_SPEC(mdec->logger, |
112 | "Failed to allocate one GString: " | |
113 | "mdec-addr={}", | |
114 | fmt::ptr(mdec)); | |
4164020e SM |
115 | goto error; |
116 | } | |
117 | ||
118 | mdec->bo = -1; | |
119 | mdec->config = *config; | |
120 | mdec->visitor = ctf_visitor_generate_ir_create(config); | |
121 | if (!mdec->visitor) { | |
0f5c5d5c SM |
122 | BT_CPPLOGE_APPEND_CAUSE_SPEC(mdec->logger, |
123 | "Failed to create a CTF IR metadata AST visitor: " | |
124 | "mdec-addr={}", | |
125 | fmt::ptr(mdec)); | |
4164020e SM |
126 | goto error; |
127 | } | |
128 | ||
0f5c5d5c SM |
129 | BT_CPPLOGD_SPEC(mdec->logger, |
130 | "Creating CTF metadata decoder: " | |
131 | "clock-class-offset-s={}, " | |
132 | "clock-class-offset-ns={}, addr={}", | |
c942e7a2 | 133 | config->clkClsCfg.offsetSec, config->clkClsCfg.offsetNanoSec, fmt::ptr(mdec)); |
4164020e | 134 | goto end; |
06be9946 PP |
135 | |
136 | error: | |
4164020e SM |
137 | ctf_metadata_decoder_destroy(mdec); |
138 | mdec = NULL; | |
d6e20753 | 139 | |
1e649dff | 140 | end: |
1fa280c9 | 141 | return ctf_metadata_decoder_up {mdec}; |
1e649dff PP |
142 | } |
143 | ||
1e649dff PP |
144 | void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder *mdec) |
145 | { | |
4164020e SM |
146 | if (!mdec) { |
147 | return; | |
148 | } | |
1e649dff | 149 | |
4164020e SM |
150 | if (mdec->scanner) { |
151 | ctf_scanner_free(mdec->scanner); | |
152 | } | |
06be9946 | 153 | |
4164020e SM |
154 | if (mdec->text) { |
155 | g_string_free(mdec->text, TRUE); | |
156 | } | |
06be9946 | 157 | |
0f5c5d5c | 158 | BT_CPPLOGD_SPEC(mdec->logger, "Destroying CTF metadata decoder: addr={}", fmt::ptr(mdec)); |
708dab6b | 159 | |
afb0f12b | 160 | delete mdec; |
1e649dff PP |
161 | } |
162 | ||
1fa280c9 SM |
163 | void ctf_metadata_decoder_deleter::operator()(ctf_metadata_decoder *decoder) |
164 | { | |
165 | ctf_metadata_decoder_destroy(decoder); | |
166 | } | |
167 | ||
4164020e SM |
168 | enum ctf_metadata_decoder_status |
169 | ctf_metadata_decoder_append_content(struct ctf_metadata_decoder *mdec, FILE *fp) | |
1e649dff | 170 | { |
4164020e SM |
171 | enum ctf_metadata_decoder_status status = CTF_METADATA_DECODER_STATUS_OK; |
172 | int ret; | |
173 | char *buf = NULL; | |
174 | bool close_fp = false; | |
175 | long start_pos = -1; | |
176 | bool is_packetized; | |
177 | ||
178 | BT_ASSERT(mdec); | |
0f5c5d5c | 179 | ret = ctf_metadata_decoder_is_packetized(fp, &is_packetized, &mdec->bo, mdec->logger); |
4164020e SM |
180 | if (ret) { |
181 | status = CTF_METADATA_DECODER_STATUS_ERROR; | |
182 | goto end; | |
183 | } | |
184 | ||
185 | if (is_packetized) { | |
0f5c5d5c SM |
186 | BT_CPPLOGI_SPEC(mdec->logger, "Metadata stream is packetized: mdec-addr={}", |
187 | fmt::ptr(mdec)); | |
4164020e | 188 | ret = ctf_metadata_decoder_packetized_file_stream_to_buf( |
0f5c5d5c | 189 | fp, &buf, mdec->bo, &mdec->is_uuid_set, mdec->uuid, mdec->logger); |
4164020e | 190 | if (ret) { |
0f5c5d5c SM |
191 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
192 | mdec->logger, | |
4164020e | 193 | "Cannot decode packetized metadata packets to metadata text: " |
0f5c5d5c SM |
194 | "mdec-addr={}, ret={}", |
195 | fmt::ptr(mdec), ret); | |
4164020e SM |
196 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
197 | goto end; | |
198 | } | |
199 | ||
200 | if (strlen(buf) == 0) { | |
201 | /* An empty metadata packet is OK. */ | |
202 | goto end; | |
203 | } | |
204 | ||
205 | /* Convert the real file pointer to a memory file pointer */ | |
206 | fp = bt_fmemopen(buf, strlen(buf), "rb"); | |
207 | close_fp = true; | |
208 | if (!fp) { | |
0f5c5d5c SM |
209 | BT_CPPLOGE_APPEND_CAUSE_SPEC(mdec->logger, |
210 | "Cannot memory-open metadata buffer: {}: " | |
211 | "mdec-addr={}", | |
212 | strerror(errno), fmt::ptr(mdec)); | |
4164020e SM |
213 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
214 | goto end; | |
215 | } | |
a4613497 | 216 | } else if (!mdec->has_checked_plaintext_signature) { |
4164020e SM |
217 | unsigned int major, minor; |
218 | ssize_t nr_items; | |
219 | const long init_pos = ftell(fp); | |
220 | ||
0f5c5d5c SM |
221 | BT_CPPLOGI_SPEC(mdec->logger, "Metadata stream is plain text: mdec-addr={}", |
222 | fmt::ptr(mdec)); | |
4164020e SM |
223 | |
224 | if (init_pos < 0) { | |
0f5c5d5c SM |
225 | BT_CPPLOGE_ERRNO_APPEND_CAUSE_SPEC(mdec->logger, "Failed to get current file position", |
226 | "."); | |
4164020e SM |
227 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
228 | goto end; | |
229 | } | |
230 | ||
231 | /* Check text-only metadata header and version */ | |
232 | nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor); | |
233 | if (nr_items < 2) { | |
0f5c5d5c SM |
234 | BT_CPPLOGW_SPEC( |
235 | mdec->logger, | |
4164020e | 236 | "Missing \"/* CTF major.minor\" signature in plain text metadata file stream: " |
0f5c5d5c SM |
237 | "mdec-addr={}", |
238 | fmt::ptr(mdec)); | |
4164020e SM |
239 | } |
240 | ||
0f5c5d5c SM |
241 | BT_CPPLOGI_SPEC(mdec->logger, "Found metadata stream version in signature: version={}.{}", |
242 | major, minor); | |
4164020e SM |
243 | |
244 | if (!ctf_metadata_decoder_is_packet_version_valid(major, minor)) { | |
0f5c5d5c SM |
245 | BT_CPPLOGE_APPEND_CAUSE_SPEC(mdec->logger, |
246 | "Invalid metadata version found in plain text signature: " | |
247 | "version={}.{}, mdec-addr={}", | |
248 | major, minor, fmt::ptr(mdec)); | |
4164020e SM |
249 | status = CTF_METADATA_DECODER_STATUS_INVAL_VERSION; |
250 | goto end; | |
251 | } | |
252 | ||
253 | if (fseek(fp, init_pos, SEEK_SET)) { | |
0f5c5d5c SM |
254 | BT_CPPLOGE_APPEND_CAUSE_SPEC( |
255 | mdec->logger, | |
256 | "Cannot seek metadata file stream to initial position: {}: " | |
257 | "mdec-addr={}", | |
258 | strerror(errno), fmt::ptr(mdec)); | |
4164020e SM |
259 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
260 | goto end; | |
261 | } | |
a4613497 FD |
262 | |
263 | mdec->has_checked_plaintext_signature = true; | |
4164020e | 264 | } |
1e649dff | 265 | |
9103e903 | 266 | #if YYDEBUG |
0f5c5d5c | 267 | if (mdec->logger.wouldLogT()) { |
4164020e SM |
268 | yydebug = 1; |
269 | } | |
9103e903 | 270 | #endif |
f73367f8 | 271 | |
4164020e SM |
272 | /* Save the file's position: we'll seek back to append the plain text */ |
273 | BT_ASSERT(fp); | |
274 | ||
275 | if (mdec->config.keep_plain_text) { | |
276 | start_pos = ftell(fp); | |
277 | } | |
278 | ||
279 | /* Append the metadata text content */ | |
280 | ret = ctf_scanner_append_ast(mdec->scanner, fp); | |
281 | if (ret) { | |
0f5c5d5c SM |
282 | BT_CPPLOGE_APPEND_CAUSE_SPEC(mdec->logger, |
283 | "Cannot create the metadata AST out of the metadata text: " | |
284 | "mdec-addr={}", | |
285 | fmt::ptr(mdec)); | |
4164020e SM |
286 | status = CTF_METADATA_DECODER_STATUS_INCOMPLETE; |
287 | goto end; | |
288 | } | |
289 | ||
290 | /* We know it's complete: append plain text */ | |
291 | if (mdec->config.keep_plain_text) { | |
292 | BT_ASSERT(start_pos != -1); | |
293 | ret = fseek(fp, start_pos, SEEK_SET); | |
294 | if (ret) { | |
0f5c5d5c SM |
295 | BT_CPPLOGE_APPEND_CAUSE_SPEC(mdec->logger, "Failed to seek file: ret={}, mdec-addr={}", |
296 | ret, fmt::ptr(mdec)); | |
4164020e SM |
297 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
298 | goto end; | |
299 | } | |
300 | ||
301 | ret = bt_common_append_file_content_to_g_string(mdec->text, fp); | |
302 | if (ret) { | |
0f5c5d5c SM |
303 | BT_CPPLOGE_APPEND_CAUSE_SPEC(mdec->logger, |
304 | "Failed to append to current plain text: " | |
305 | "ret={}, mdec-addr={}", | |
306 | ret, fmt::ptr(mdec)); | |
4164020e SM |
307 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
308 | goto end; | |
309 | } | |
310 | } | |
311 | ||
0f5c5d5c | 312 | ret = ctf_visitor_semantic_check(0, &mdec->scanner->ast->root, mdec->logger); |
4164020e | 313 | if (ret) { |
0f5c5d5c SM |
314 | BT_CPPLOGE_APPEND_CAUSE_SPEC(mdec->logger, |
315 | "Validation of the metadata semantics failed: " | |
316 | "mdec-addr={}", | |
317 | fmt::ptr(mdec)); | |
4164020e SM |
318 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
319 | goto end; | |
320 | } | |
321 | ||
322 | if (mdec->config.create_trace_class) { | |
708dab6b | 323 | ret = ctf_visitor_generate_ir_visit_node(mdec->visitor.get(), &mdec->scanner->ast->root); |
4164020e SM |
324 | switch (ret) { |
325 | case 0: | |
326 | /* Success */ | |
327 | break; | |
328 | case -EINCOMPLETE: | |
0f5c5d5c SM |
329 | BT_CPPLOGD_SPEC(mdec->logger, |
330 | "While visiting metadata AST: incomplete data: " | |
331 | "mdec-addr={}", | |
332 | fmt::ptr(mdec)); | |
4164020e SM |
333 | status = CTF_METADATA_DECODER_STATUS_INCOMPLETE; |
334 | goto end; | |
335 | default: | |
0f5c5d5c SM |
336 | BT_CPPLOGE_APPEND_CAUSE_SPEC(mdec->logger, |
337 | "Failed to visit AST node to create CTF IR objects: " | |
338 | "mdec-addr={}, ret={}", | |
339 | fmt::ptr(mdec), ret); | |
4164020e SM |
340 | status = CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR; |
341 | goto end; | |
342 | } | |
343 | } | |
1e649dff PP |
344 | |
345 | end: | |
9103e903 | 346 | #if YYDEBUG |
4164020e | 347 | yydebug = 0; |
9103e903 | 348 | #endif |
f73367f8 | 349 | |
4164020e SM |
350 | if (fp && close_fp) { |
351 | if (fclose(fp)) { | |
0f5c5d5c SM |
352 | BT_CPPLOGE_SPEC(mdec->logger, |
353 | "Cannot close metadata file stream: " | |
354 | "mdec-addr={}", | |
355 | fmt::ptr(mdec)); | |
4164020e SM |
356 | } |
357 | } | |
1e649dff | 358 | |
4164020e | 359 | free(buf); |
1e649dff | 360 | |
4164020e | 361 | return status; |
1e649dff PP |
362 | } |
363 | ||
4164020e | 364 | bt_trace_class *ctf_metadata_decoder_get_ir_trace_class(struct ctf_metadata_decoder *mdec) |
44c440bc | 365 | { |
4164020e SM |
366 | BT_ASSERT_DBG(mdec); |
367 | BT_ASSERT_DBG(mdec->config.create_trace_class); | |
708dab6b | 368 | return ctf_visitor_generate_ir_get_ir_trace_class(mdec->visitor.get()); |
44c440bc PP |
369 | } |
370 | ||
4164020e SM |
371 | struct ctf_trace_class * |
372 | ctf_metadata_decoder_borrow_ctf_trace_class(struct ctf_metadata_decoder *mdec) | |
1e649dff | 373 | { |
4164020e SM |
374 | BT_ASSERT_DBG(mdec); |
375 | BT_ASSERT_DBG(mdec->config.create_trace_class); | |
708dab6b | 376 | return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec->visitor.get()); |
1e649dff | 377 | } |
06be9946 | 378 | |
06be9946 PP |
379 | const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder *mdec) |
380 | { | |
4164020e SM |
381 | BT_ASSERT_DBG(mdec); |
382 | BT_ASSERT_DBG(mdec->config.keep_plain_text); | |
383 | return mdec->text->str; | |
06be9946 PP |
384 | } |
385 | ||
06be9946 PP |
386 | int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder *mdec) |
387 | { | |
4164020e SM |
388 | BT_ASSERT_DBG(mdec); |
389 | return mdec->bo; | |
06be9946 PP |
390 | } |
391 | ||
4164020e | 392 | int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder *mdec, bt_uuid_t uuid) |
06be9946 | 393 | { |
4164020e | 394 | int ret = 0; |
06be9946 | 395 | |
4164020e | 396 | BT_ASSERT_DBG(mdec); |
06be9946 | 397 | |
4164020e SM |
398 | if (!mdec->is_uuid_set) { |
399 | ret = -1; | |
400 | goto end; | |
401 | } | |
06be9946 | 402 | |
4164020e | 403 | bt_uuid_copy(uuid, mdec->uuid); |
06be9946 PP |
404 | |
405 | end: | |
4164020e | 406 | return ret; |
06be9946 | 407 | } |
1a6da3f9 | 408 | |
4164020e SM |
409 | static enum ctf_metadata_decoder_status find_uuid_in_trace_decl(struct ctf_metadata_decoder *mdec, |
410 | struct ctf_node *trace_node, | |
411 | bt_uuid_t uuid) | |
1a6da3f9 | 412 | { |
4164020e SM |
413 | enum ctf_metadata_decoder_status status = CTF_METADATA_DECODER_STATUS_OK; |
414 | struct ctf_node *entry_node; | |
415 | struct bt_list_head *decl_list = &trace_node->u.trace.declaration_list; | |
416 | char *left = NULL; | |
417 | ||
418 | bt_list_for_each_entry (entry_node, decl_list, siblings) { | |
419 | if (entry_node->type == NODE_CTF_EXPRESSION) { | |
420 | int ret; | |
421 | ||
422 | left = ctf_ast_concatenate_unary_strings(&entry_node->u.ctf_expression.left); | |
423 | if (!left) { | |
0f5c5d5c | 424 | BT_CPPLOGE_APPEND_CAUSE_SPEC(mdec->logger, "Cannot concatenate unary strings."); |
4164020e SM |
425 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
426 | goto end; | |
427 | } | |
428 | ||
429 | if (strcmp(left, "uuid") == 0) { | |
0f5c5d5c SM |
430 | ret = |
431 | ctf_ast_get_unary_uuid(&entry_node->u.ctf_expression.right, uuid, mdec->logger); | |
4164020e | 432 | if (ret) { |
0f5c5d5c | 433 | BT_CPPLOGE_APPEND_CAUSE_SPEC(mdec->logger, "Invalid trace's `uuid` attribute."); |
4164020e SM |
434 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
435 | goto end; | |
436 | } | |
437 | ||
438 | goto end; | |
439 | } | |
440 | ||
441 | g_free(left); | |
442 | left = NULL; | |
443 | } | |
444 | } | |
445 | ||
446 | status = CTF_METADATA_DECODER_STATUS_NONE; | |
1a6da3f9 PP |
447 | |
448 | end: | |
4164020e SM |
449 | g_free(left); |
450 | return status; | |
1a6da3f9 PP |
451 | } |
452 | ||
4164020e SM |
453 | enum ctf_metadata_decoder_status |
454 | ctf_metadata_decoder_get_trace_class_uuid(struct ctf_metadata_decoder *mdec, bt_uuid_t uuid) | |
1a6da3f9 | 455 | { |
4164020e SM |
456 | enum ctf_metadata_decoder_status status = CTF_METADATA_DECODER_STATUS_INCOMPLETE; |
457 | struct ctf_node *root_node = &mdec->scanner->ast->root; | |
458 | struct ctf_node *trace_node; | |
459 | ||
460 | if (!root_node) { | |
461 | status = CTF_METADATA_DECODER_STATUS_INCOMPLETE; | |
462 | goto end; | |
463 | } | |
464 | ||
465 | trace_node = bt_list_entry(root_node->u.root.trace.next, struct ctf_node, siblings); | |
466 | if (!trace_node) { | |
467 | status = CTF_METADATA_DECODER_STATUS_INCOMPLETE; | |
468 | goto end; | |
469 | } | |
470 | ||
471 | status = find_uuid_in_trace_decl(mdec, trace_node, uuid); | |
1a6da3f9 PP |
472 | |
473 | end: | |
4164020e | 474 | return status; |
1a6da3f9 | 475 | } |