X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fplugins%2Fctf%2Fcommon%2Fmetadata%2Fdecoder.c;h=a62beebfcd99cce5dacafe88d96883c8492c14b4;hb=9103e903a89377e9cfad13905d4f4b650aecd061;hp=6215403ca1041dfa5945a09e6d64a75815055e6d;hpb=6162e6b7a6d907974d954419c2375f654f39eb72;p=babeltrace.git diff --git a/src/plugins/ctf/common/metadata/decoder.c b/src/plugins/ctf/common/metadata/decoder.c index 6215403c..a62beebf 100644 --- a/src/plugins/ctf/common/metadata/decoder.c +++ b/src/plugins/ctf/common/metadata/decoder.c @@ -15,7 +15,7 @@ #define BT_COMP_LOG_SELF_COMP (mdec->config.self_comp) #define BT_LOG_OUTPUT_LEVEL (mdec->config.log_level) #define BT_LOG_TAG "PLUGIN/CTF/META/DECODER" -#include "plugins/comp-logging.h" +#include "logging/comp-logging.h" #include #include @@ -33,18 +33,19 @@ #include "decoder.h" #include "scanner.h" #include "logging.h" +#include "parser-wrap.h" #define TSDL_MAGIC 0x75d11d57 -extern -int yydebug; - struct ctf_metadata_decoder { + struct ctf_scanner *scanner; + GString *text; struct ctf_visitor_generate_ir *visitor; bt_uuid_t uuid; bool is_uuid_set; int bo; struct ctf_metadata_decoder_config config; + struct meta_log_config log_cfg; }; struct packet_header { @@ -61,26 +62,35 @@ struct packet_header { } __attribute__((__packed__)); BT_HIDDEN -bool ctf_metadata_decoder_is_packetized(FILE *fp, int *byte_order, - bt_logging_level log_level, bt_self_component *self_comp) +int ctf_metadata_decoder_packetized_file_stream_to_buf(FILE *fp, + char **buf, int byte_order, bool *is_uuid_set, + uint8_t *uuid, bt_logging_level log_level, + bt_self_component *self_comp); + +BT_HIDDEN +int ctf_metadata_decoder_is_packetized(FILE *fp, bool *is_packetized, + int *byte_order, bt_logging_level log_level, + bt_self_component *self_comp) { uint32_t magic; size_t len; int ret = 0; + *is_packetized = false; len = fread(&magic, sizeof(magic), 1, fp); if (len != 1) { BT_COMP_LOG_CUR_LVL(BT_LOG_INFO, log_level, self_comp, "Cannot read first metadata packet header: assuming the stream is not packetized."); + ret = -1; goto end; } if (byte_order) { if (magic == TSDL_MAGIC) { - ret = 1; + *is_packetized = true; *byte_order = BYTE_ORDER; } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) { - ret = 1; + *is_packetized = true; *byte_order = BYTE_ORDER == BIG_ENDIAN ? LITTLE_ENDIAN : BIG_ENDIAN; } @@ -113,14 +123,29 @@ struct ctf_metadata_decoder *ctf_metadata_decoder_create( goto end; } + mdec->log_cfg.log_level = config->log_level; + mdec->log_cfg.self_comp = config->self_comp; + mdec->scanner = ctf_scanner_alloc(); + if (!mdec->scanner) { + BT_COMP_LOGE("Cannot allocate a metadata lexical scanner: " + "mdec-addr=%p", mdec); + goto error; + } + + mdec->text = g_string_new(NULL); + if (!mdec->text) { + BT_COMP_LOGE("Failed to allocate one GString: " + "mdec-addr=%p", mdec); + goto error; + } + + mdec->bo = -1; mdec->config = *config; mdec->visitor = ctf_visitor_generate_ir_create(config); if (!mdec->visitor) { BT_COMP_LOGE("Failed to create a CTF IR metadata AST visitor: " "mdec-addr=%p", mdec); - ctf_metadata_decoder_destroy(mdec); - mdec = NULL; - goto end; + goto error; } BT_COMP_LOGD("Creating CTF metadata decoder: " @@ -128,6 +153,11 @@ struct ctf_metadata_decoder *ctf_metadata_decoder_create( "clock-class-offset-ns=%" PRId64 ", addr=%p", config->clock_class_offset_s, config->clock_class_offset_ns, mdec); + goto end; + +error: + ctf_metadata_decoder_destroy(mdec); + mdec = NULL; end: return mdec; @@ -140,29 +170,40 @@ void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder *mdec) return; } + if (mdec->scanner) { + ctf_scanner_free(mdec->scanner); + } + + if (mdec->text) { + g_string_free(mdec->text, TRUE); + } + BT_COMP_LOGD("Destroying CTF metadata decoder: addr=%p", mdec); ctf_visitor_generate_ir_destroy(mdec->visitor); g_free(mdec); } BT_HIDDEN -enum ctf_metadata_decoder_status ctf_metadata_decoder_decode( +enum ctf_metadata_decoder_status ctf_metadata_decoder_append_content( struct ctf_metadata_decoder *mdec, FILE *fp) { enum ctf_metadata_decoder_status status = CTF_METADATA_DECODER_STATUS_OK; int ret; - struct ctf_scanner *scanner = NULL; char *buf = NULL; bool close_fp = false; - struct meta_log_config log_cfg; + long start_pos = -1; + bool is_packetized; BT_ASSERT(mdec); - log_cfg.log_level = mdec->config.log_level; - log_cfg.self_comp = mdec->config.self_comp; + ret = ctf_metadata_decoder_is_packetized(fp, &is_packetized, &mdec->bo, + mdec->config.log_level, mdec->config.self_comp); + if (ret) { + status = CTF_METADATA_DECODER_STATUS_ERROR; + goto end; + } - if (ctf_metadata_decoder_is_packetized(fp, &mdec->bo, - mdec->config.log_level, mdec->config.self_comp)) { + if (is_packetized) { BT_COMP_LOGI("Metadata stream is packetized: mdec-addr=%p", mdec); ret = ctf_metadata_decoder_packetized_file_stream_to_buf(fp, &buf, mdec->bo, &mdec->is_uuid_set, @@ -228,21 +269,21 @@ enum ctf_metadata_decoder_status ctf_metadata_decoder_decode( } } +#if YYDEBUG if (BT_LOG_ON_TRACE) { yydebug = 1; } +#endif - /* Allocate a scanner and append the metadata text content */ - scanner = ctf_scanner_alloc(); - if (!scanner) { - BT_COMP_LOGE("Cannot allocate a metadata lexical scanner: " - "mdec-addr=%p", mdec); - status = CTF_METADATA_DECODER_STATUS_ERROR; - goto end; + /* Save the file's position: we'll seek back to append the plain text */ + BT_ASSERT(fp); + + if (mdec->config.keep_plain_text) { + start_pos = ftell(fp); } - BT_ASSERT(fp); - ret = ctf_scanner_append_ast(scanner, fp); + /* Append the metadata text content */ + ret = ctf_scanner_append_ast(mdec->scanner, fp); if (ret) { BT_COMP_LOGE("Cannot create the metadata AST out of the metadata text: " "mdec-addr=%p", mdec); @@ -250,7 +291,28 @@ enum ctf_metadata_decoder_status ctf_metadata_decoder_decode( goto end; } - ret = ctf_visitor_semantic_check(0, &scanner->ast->root, &log_cfg); + /* We know it's complete: append plain text */ + if (mdec->config.keep_plain_text) { + BT_ASSERT(start_pos != -1); + ret = fseek(fp, start_pos, SEEK_SET); + if (ret) { + BT_COMP_LOGE("Failed to seek file: ret=%d, mdec-addr=%p", + ret, mdec); + status = CTF_METADATA_DECODER_STATUS_ERROR; + goto end; + } + + ret = bt_common_append_file_content_to_g_string(mdec->text, fp); + if (ret) { + BT_COMP_LOGE("Failed to append to current plain text: " + "ret=%d, mdec-addr=%p", ret, mdec); + status = CTF_METADATA_DECODER_STATUS_ERROR; + goto end; + } + } + + ret = ctf_visitor_semantic_check(0, &mdec->scanner->ast->root, + &mdec->log_cfg); if (ret) { BT_COMP_LOGE("Validation of the metadata semantics failed: " "mdec-addr=%p", mdec); @@ -258,30 +320,30 @@ enum ctf_metadata_decoder_status ctf_metadata_decoder_decode( goto end; } - ret = ctf_visitor_generate_ir_visit_node(mdec->visitor, - &scanner->ast->root); - switch (ret) { - case 0: - /* Success */ - break; - case -EINCOMPLETE: - BT_COMP_LOGD("While visiting metadata AST: incomplete data: " - "mdec-addr=%p", mdec); - status = CTF_METADATA_DECODER_STATUS_INCOMPLETE; - goto end; - default: - BT_COMP_LOGE("Failed to visit AST node to create CTF IR objects: " - "mdec-addr=%p, ret=%d", mdec, ret); - status = CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR; - goto end; + if (mdec->config.create_trace_class) { + ret = ctf_visitor_generate_ir_visit_node(mdec->visitor, + &mdec->scanner->ast->root); + switch (ret) { + case 0: + /* Success */ + break; + case -EINCOMPLETE: + BT_COMP_LOGD("While visiting metadata AST: incomplete data: " + "mdec-addr=%p", mdec); + status = CTF_METADATA_DECODER_STATUS_INCOMPLETE; + goto end; + default: + BT_COMP_LOGE("Failed to visit AST node to create CTF IR objects: " + "mdec-addr=%p, ret=%d", mdec, ret); + status = CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR; + goto end; + } } end: - if (scanner) { - ctf_scanner_free(scanner); - } - +#if YYDEBUG yydebug = 0; +#endif if (fp && close_fp) { if (fclose(fp)) { @@ -290,9 +352,7 @@ end: } } - if (buf) { - free(buf); - } + free(buf); return status; } @@ -301,6 +361,8 @@ BT_HIDDEN bt_trace_class *ctf_metadata_decoder_get_ir_trace_class( struct ctf_metadata_decoder *mdec) { + BT_ASSERT_DBG(mdec); + BT_ASSERT_DBG(mdec->config.create_trace_class); return ctf_visitor_generate_ir_get_ir_trace_class(mdec->visitor); } @@ -308,5 +370,118 @@ BT_HIDDEN struct ctf_trace_class *ctf_metadata_decoder_borrow_ctf_trace_class( struct ctf_metadata_decoder *mdec) { + BT_ASSERT_DBG(mdec); + BT_ASSERT_DBG(mdec->config.create_trace_class); return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec->visitor); } + +BT_HIDDEN +const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder *mdec) +{ + BT_ASSERT_DBG(mdec); + BT_ASSERT_DBG(mdec->config.keep_plain_text); + return mdec->text->str; +} + +BT_HIDDEN +int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder *mdec) +{ + BT_ASSERT_DBG(mdec); + return mdec->bo; +} + +BT_HIDDEN +int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder *mdec, + bt_uuid_t uuid) +{ + int ret = 0; + + BT_ASSERT_DBG(mdec); + + if (!mdec->is_uuid_set) { + ret = -1; + goto end; + } + + bt_uuid_copy(uuid, mdec->uuid); + +end: + return ret; +} + +static +enum ctf_metadata_decoder_status find_uuid_in_trace_decl( + struct ctf_metadata_decoder *mdec, struct ctf_node *trace_node, + bt_uuid_t uuid) +{ + enum ctf_metadata_decoder_status status = + CTF_METADATA_DECODER_STATUS_OK; + struct ctf_node *entry_node; + struct bt_list_head *decl_list = &trace_node->u.trace.declaration_list; + char *left = NULL; + + bt_list_for_each_entry(entry_node, decl_list, siblings) { + if (entry_node->type == NODE_CTF_EXPRESSION) { + int ret; + + left = ctf_ast_concatenate_unary_strings( + &entry_node->u.ctf_expression.left); + if (!left) { + BT_COMP_LOGE("Cannot concatenate unary strings."); + status = CTF_METADATA_DECODER_STATUS_ERROR; + goto end; + } + + if (strcmp(left, "uuid") == 0) { + ret = ctf_ast_get_unary_uuid( + &entry_node->u.ctf_expression.right, + uuid, mdec->config.log_level, + mdec->config.self_comp); + if (ret) { + BT_COMP_LOGE("Invalid trace's `uuid` attribute."); + status = CTF_METADATA_DECODER_STATUS_ERROR; + goto end; + } + + goto end; + } + + g_free(left); + left = NULL; + } + } + + status = CTF_METADATA_DECODER_STATUS_NONE; + +end: + g_free(left); + return status; +} + +BT_HIDDEN +enum ctf_metadata_decoder_status ctf_metadata_decoder_get_trace_class_uuid( + struct ctf_metadata_decoder *mdec, bt_uuid_t uuid) +{ + enum ctf_metadata_decoder_status status = + CTF_METADATA_DECODER_STATUS_INCOMPLETE; + struct ctf_node *root_node = &mdec->scanner->ast->root; + struct ctf_node *trace_node; + + if (!root_node) { + status = CTF_METADATA_DECODER_STATUS_INCOMPLETE; + goto end; + } + + trace_node = + bt_list_entry(root_node->u.root.trace.next, + struct ctf_node, siblings); + if (!trace_node) { + status = CTF_METADATA_DECODER_STATUS_INCOMPLETE; + goto end; + } + + status = find_uuid_in_trace_decl(mdec, trace_node, uuid); + +end: + return status; +}