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