X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fplugins%2Flttng-utils%2Fdebug-info%2Fdebug-info.c;h=c98cf604175bd31fdce288f170ee614460ec24cd;hb=d9120ccba72cfe3173cf5987871e9667d4c4c547;hp=426f50c65bbeab30aed559e19eb1b4e30e050860;hpb=f4f11e84942d36fcc8a597d226928bce2ccac4b3;p=babeltrace.git diff --git a/src/plugins/lttng-utils/debug-info/debug-info.c b/src/plugins/lttng-utils/debug-info/debug-info.c index 426f50c6..c98cf604 100644 --- a/src/plugins/lttng-utils/debug-info/debug-info.c +++ b/src/plugins/lttng-utils/debug-info/debug-info.c @@ -31,6 +31,8 @@ #define BT_LOG_TAG "PLUGIN/FLT.LTTNG-UTILS.DEBUG-INFO" #include "logging/comp-logging.h" +#include + #include #include "common/assert.h" @@ -43,6 +45,7 @@ #include "trace-ir-mapping.h" #include "trace-ir-metadata-copy.h" #include "utils.h" +#include "plugins/common/param-validation/param-validation.h" #define DEFAULT_DEBUG_INFO_FIELD_NAME "debug_info" #define LTTNG_UST_STATEDUMP_PREFIX "lttng_ust" @@ -177,7 +180,11 @@ struct debug_info_source *debug_info_source_create_from_bin( int ret; struct debug_info_source *debug_info_src = NULL; struct source_location *src_loc = NULL; - bt_logging_level log_level = bin->log_level; + bt_logging_level log_level; + + BT_ASSERT(bin); + + log_level = bin->log_level; debug_info_src = g_new0(struct debug_info_source, 1); @@ -204,7 +211,8 @@ struct debug_info_source *debug_info_source_create_from_bin( debug_info_src->line_no = g_strdup_printf("%"PRId64, src_loc->line_no); if (!debug_info_src->line_no) { - BT_COMP_LOGE("Error occured when setting line_no field."); + BT_COMP_LOGE_APPEND_CAUSE(self_comp, + "Error occured when setting `line_no` field."); goto error; } @@ -334,7 +342,7 @@ const bt_field *event_borrow_payload_field(const bt_event *event, const bt_field *event_payload, *field; event_payload = bt_event_borrow_payload_field_const(event); - BT_ASSERT(event_payload); + BT_ASSERT_DBG(event_payload); field = bt_field_structure_borrow_member_field_by_name_const( event_payload, field_name); @@ -368,7 +376,7 @@ void event_get_common_context_signed_integer_field_value( } static inline -int event_get_payload_build_id_length(const bt_event *event, +void event_get_payload_build_id_length(const bt_event *event, const char *field_name, uint64_t *build_id_len) { const bt_field *build_id_field; @@ -378,33 +386,32 @@ int event_get_payload_build_id_length(const bt_event *event, build_id_field_class = bt_field_borrow_class_const(build_id_field); BT_ASSERT(bt_field_class_get_type(build_id_field_class) == - BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY); + BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD || + bt_field_class_get_type(build_id_field_class) == + BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD); BT_ASSERT(bt_field_class_get_type( bt_field_class_array_borrow_element_field_class_const( build_id_field_class)) == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER); *build_id_len = bt_field_array_get_length(build_id_field); - - return 0; } static inline -int event_get_payload_build_id_value(const bt_event *event, +void event_get_payload_build_id_value(const bt_event *event, const char *field_name, uint8_t *build_id) { const bt_field *curr_field, *build_id_field; const bt_field_class *build_id_field_class; uint64_t i, build_id_len; - int ret; - - ret = 0; build_id_field = event_borrow_payload_field(event, field_name); build_id_field_class = bt_field_borrow_class_const(build_id_field); BT_ASSERT(bt_field_class_get_type(build_id_field_class) == - BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY); + BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD || + bt_field_class_get_type(build_id_field_class) == + BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD); BT_ASSERT(bt_field_class_get_type( bt_field_class_array_borrow_element_field_class_const( build_id_field_class)) == @@ -414,12 +421,10 @@ int event_get_payload_build_id_value(const bt_event *event, for (i = 0; i < build_id_len; i++) { curr_field = bt_field_array_borrow_element_field_by_index_const( - build_id_field, i); + build_id_field, i); build_id[i] = bt_field_integer_unsigned_get_value(curr_field); } - - return ret; } static @@ -625,7 +630,8 @@ void handle_event_statedump_build_id(struct debug_info *debug_info, */ goto end; } - ret = event_get_payload_build_id_length(event, BUILD_ID_FIELD_NAME, + + event_get_payload_build_id_length(event, BUILD_ID_FIELD_NAME, &build_id_len); build_id = g_new0(uint8_t, build_id_len); @@ -633,11 +639,7 @@ void handle_event_statedump_build_id(struct debug_info *debug_info, goto end; } - ret = event_get_payload_build_id_value(event, BUILD_ID_FIELD_NAME, - build_id); - if (ret) { - goto end; - } + event_get_payload_build_id_value(event, BUILD_ID_FIELD_NAME, build_id); ret = bin_info_set_build_id(bin, build_id, build_id_len); if (ret) { @@ -856,6 +858,7 @@ end: return; } +static void trace_debug_info_remove_func(const bt_trace *in_trace, void *data) { struct debug_info_msg_iter *debug_it = data; @@ -955,7 +958,7 @@ void fill_debug_info_bin_field(struct debug_info_source *dbg_info_src, bt_field_string_set_value_status set_status; bt_field_string_append_status append_status; - BT_ASSERT(bt_field_get_class_type(curr_field) == + BT_ASSERT_DBG(bt_field_get_class_type(curr_field) == BT_FIELD_CLASS_TYPE_STRING); if (dbg_info_src) { @@ -967,7 +970,7 @@ void fill_debug_info_bin_field(struct debug_info_source *dbg_info_src, dbg_info_src->short_bin_path); } if (set_status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { - BT_COMP_LOGE("Cannot set path component of \"bin\" " + BT_COMP_LOGE("Cannot set path component of `bin` " "curr_field field's value: str-fc-addr=%p", curr_field); bt_current_thread_clear_error(); @@ -976,7 +979,7 @@ void fill_debug_info_bin_field(struct debug_info_source *dbg_info_src, append_status = bt_field_string_append(curr_field, dbg_info_src->bin_loc); if (append_status != BT_FIELD_STRING_APPEND_STATUS_OK) { - BT_COMP_LOGE("Cannot set bin location component of \"bin\" " + BT_COMP_LOGE("Cannot set bin location component of `bin` " "curr_field field's value: str-fc-addr=%p", curr_field); bt_current_thread_clear_error(); @@ -984,7 +987,7 @@ void fill_debug_info_bin_field(struct debug_info_source *dbg_info_src, } else { set_status = bt_field_string_set_value(curr_field, ""); if (set_status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { - BT_COMP_LOGE("Cannot set \"bin\" curr_field field's value: " + BT_COMP_LOGE("Cannot set `bin` curr_field field's value: " "str-fc-addr=%p", curr_field); bt_current_thread_clear_error(); } @@ -998,7 +1001,7 @@ void fill_debug_info_func_field(struct debug_info_source *dbg_info_src, { bt_field_string_set_value_status status; - BT_ASSERT(bt_field_get_class_type(curr_field) == + BT_ASSERT_DBG(bt_field_get_class_type(curr_field) == BT_FIELD_CLASS_TYPE_STRING); if (dbg_info_src && dbg_info_src->func) { status = bt_field_string_set_value(curr_field, @@ -1007,7 +1010,7 @@ void fill_debug_info_func_field(struct debug_info_source *dbg_info_src, status = bt_field_string_set_value(curr_field, ""); } if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { - BT_COMP_LOGE("Cannot set \"func\" curr_field field's value: " + BT_COMP_LOGE("Cannot set `func` curr_field field's value: " "str-fc-addr=%p", curr_field); bt_current_thread_clear_error(); } @@ -1022,7 +1025,7 @@ void fill_debug_info_src_field(struct debug_info_source *dbg_info_src, bt_field_string_set_value_status set_status; bt_field_string_append_status append_status; - BT_ASSERT(bt_field_get_class_type(curr_field) == + BT_ASSERT_DBG(bt_field_get_class_type(curr_field) == BT_FIELD_CLASS_TYPE_STRING); if (dbg_info_src && dbg_info_src->src_path) { @@ -1034,7 +1037,7 @@ void fill_debug_info_src_field(struct debug_info_source *dbg_info_src, dbg_info_src->short_src_path); } if (set_status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { - BT_COMP_LOGE("Cannot set path component of \"src\" " + BT_COMP_LOGE("Cannot set path component of `src` " "curr_field field's value: str-fc-addr=%p", curr_field); bt_current_thread_clear_error(); @@ -1042,7 +1045,7 @@ void fill_debug_info_src_field(struct debug_info_source *dbg_info_src, append_status = bt_field_string_append(curr_field, ":"); if (append_status != BT_FIELD_STRING_APPEND_STATUS_OK) { - BT_COMP_LOGE("Cannot set colon component of \"src\" " + BT_COMP_LOGE("Cannot set colon component of `src` " "curr_field field's value: str-fc-addr=%p", curr_field); bt_current_thread_clear_error(); @@ -1051,7 +1054,7 @@ void fill_debug_info_src_field(struct debug_info_source *dbg_info_src, append_status = bt_field_string_append(curr_field, dbg_info_src->line_no); if (append_status != BT_FIELD_STRING_APPEND_STATUS_OK) { - BT_COMP_LOGE("Cannot set line number component of \"src\" " + BT_COMP_LOGE("Cannot set line number component of `src` " "curr_field field's value: str-fc-addr=%p", curr_field); bt_current_thread_clear_error(); @@ -1059,7 +1062,7 @@ void fill_debug_info_src_field(struct debug_info_source *dbg_info_src, } else { set_status = bt_field_string_set_value(curr_field, ""); if (set_status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { - BT_COMP_LOGE("Cannot set \"src\" curr_field field's value: " + BT_COMP_LOGE("Cannot set `src` curr_field field's value: " "str-fc-addr=%p", curr_field); bt_current_thread_clear_error(); } @@ -1073,7 +1076,7 @@ void fill_debug_info_field_empty(bt_field *debug_info_field, bt_field_string_set_value_status status; bt_field *bin_field, *func_field, *src_field; - BT_ASSERT(bt_field_get_class_type(debug_info_field) == + BT_ASSERT_DBG(bt_field_get_class_type(debug_info_field) == BT_FIELD_CLASS_TYPE_STRUCTURE); bin_field = bt_field_structure_borrow_member_field_by_name( @@ -1083,30 +1086,30 @@ void fill_debug_info_field_empty(bt_field *debug_info_field, src_field = bt_field_structure_borrow_member_field_by_name( debug_info_field, "src"); - BT_ASSERT(bt_field_get_class_type(bin_field) == + BT_ASSERT_DBG(bt_field_get_class_type(bin_field) == BT_FIELD_CLASS_TYPE_STRING); - BT_ASSERT(bt_field_get_class_type(func_field) == + BT_ASSERT_DBG(bt_field_get_class_type(func_field) == BT_FIELD_CLASS_TYPE_STRING); - BT_ASSERT(bt_field_get_class_type(src_field) == + BT_ASSERT_DBG(bt_field_get_class_type(src_field) == BT_FIELD_CLASS_TYPE_STRING); status = bt_field_string_set_value(bin_field, ""); if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { - BT_COMP_LOGE("Cannot set \"bin\" bin_field field's value: " + BT_COMP_LOGE("Cannot set `bin` field's value: " "str-fc-addr=%p", bin_field); bt_current_thread_clear_error(); } status = bt_field_string_set_value(func_field, ""); if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { - BT_COMP_LOGE("Cannot set \"func\" func_field field's value: " + BT_COMP_LOGE("Cannot set `func` field's value: " "str-fc-addr=%p", func_field); bt_current_thread_clear_error(); } status = bt_field_string_set_value(src_field, ""); if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { - BT_COMP_LOGE("Cannot set \"src\" src_field field's value: " + BT_COMP_LOGE("Cannot set `src` field's value: " "str-fc-addr=%p", src_field); bt_current_thread_clear_error(); } @@ -1118,12 +1121,13 @@ void fill_debug_info_field(struct debug_info *debug_info, int64_t vpid, struct debug_info_source *dbg_info_src; const bt_field_class *debug_info_fc; - BT_ASSERT(bt_field_get_class_type(debug_info_field) == + BT_ASSERT_DBG(bt_field_get_class_type(debug_info_field) == BT_FIELD_CLASS_TYPE_STRUCTURE); debug_info_fc = bt_field_borrow_class_const(debug_info_field); - BT_ASSERT(bt_field_class_structure_get_member_count(debug_info_fc) == 3); + BT_ASSERT_DBG(bt_field_class_structure_get_member_count( + debug_info_fc) == 3); dbg_info_src = debug_info_query(debug_info, vpid, ip); @@ -1282,14 +1286,14 @@ bt_message *handle_event_message(struct debug_info_msg_iter *debug_it, out_event_class = trace_ir_mapping_create_new_mapped_event_class( debug_it->ir_maps, in_event_class); } - BT_ASSERT(out_event_class); + BT_ASSERT_DBG(out_event_class); /* Borrow the input stream. */ in_stream = bt_event_borrow_stream_const(in_event); - BT_ASSERT(in_stream); + BT_ASSERT_DBG(in_stream); out_stream = trace_ir_mapping_borrow_mapped_stream(debug_it->ir_maps, in_stream); - BT_ASSERT(in_stream); + BT_ASSERT_DBG(in_stream); /* Borrow the input and output packets. */ in_packet = bt_event_borrow_packet_const(in_event); @@ -1332,14 +1336,21 @@ bt_message *handle_event_message(struct debug_info_msg_iter *debug_it, } if (!out_message) { - BT_COMP_LOGE("Error creating output event message."); + BT_COMP_LOGE_APPEND_CAUSE(self_comp, + "Error creating output event message."); goto error; } out_event = bt_message_event_borrow_event(out_message); /* Copy the original fields to the output event. */ - copy_event_content(in_event, out_event, log_level, self_comp); + if (copy_event_content(in_event, out_event, log_level, self_comp) != + DEBUG_INFO_TRACE_IR_MAPPING_STATUS_OK) { + BT_COMP_LOGE_APPEND_CAUSE(self_comp, + "Error copying event message content output event message: " + "in-ev-addr=%p, out-ev-addr=%p", in_event, out_event); + goto error; + } /* * Try to set the debug-info fields based on debug information that is @@ -1347,7 +1358,11 @@ bt_message *handle_event_message(struct debug_info_msg_iter *debug_it, */ fill_debug_info_event_if_needed(debug_it, in_event, out_event); + goto end; + error: + BT_MESSAGE_PUT_REF_AND_RESET(out_message); +end: return out_message; } @@ -1376,7 +1391,8 @@ bt_message *handle_stream_begin_message(struct debug_info_msg_iter *debug_it, out_message = bt_message_stream_beginning_create( debug_it->input_iterator, out_stream); if (!out_message) { - BT_COMP_LOGE("Error creating output stream beginning message: " + BT_COMP_LOGE_APPEND_CAUSE(self_comp, + "Error creating output stream beginning message: " "out-s-addr=%p", out_stream); } error: @@ -1404,8 +1420,9 @@ bt_message *handle_stream_end_message(struct debug_info_msg_iter *debug_it, out_message = bt_message_stream_end_create(debug_it->input_iterator, out_stream); if (!out_message) { - BT_COMP_LOGE("Error creating output stream end message: out-s-addr=%p", - out_stream); + BT_COMP_LOGE_APPEND_CAUSE(self_comp, + "Error creating output stream end message: " + "out-s-addr=%p", out_stream); goto end; } @@ -1458,7 +1475,8 @@ bt_message *handle_packet_begin_message(struct debug_info_msg_iter *debug_it, debug_it->input_iterator, out_packet); } if (!out_message) { - BT_COMP_LOGE("Error creating output packet beginning message: " + BT_COMP_LOGE_APPEND_CAUSE(self_comp, + "Error creating output packet beginning message: " "out-p-addr=%p", out_packet); } @@ -1502,7 +1520,8 @@ bt_message *handle_packet_end_message(struct debug_info_msg_iter *debug_it, } if (!out_message) { - BT_COMP_LOGE("Error creating output packet end message: " + BT_COMP_LOGE_APPEND_CAUSE(self_comp, + "Error creating output packet end message: " "out-p-addr=%p", out_packet); goto end; } @@ -1568,7 +1587,8 @@ bt_message *handle_discarded_events_message(struct debug_info_msg_iter *debug_it debug_it->input_iterator, out_stream); } if (!out_message) { - BT_COMP_LOGE("Error creating output discarded events message: " + BT_COMP_LOGE_APPEND_CAUSE(self_comp, + "Error creating output discarded events message: " "out-s-addr=%p", out_stream); goto error; } @@ -1628,7 +1648,8 @@ bt_message *handle_discarded_packets_message(struct debug_info_msg_iter *debug_i debug_it->input_iterator, out_stream); } if (!out_message) { - BT_COMP_LOGE("Error creating output discarded packet message: " + BT_COMP_LOGE_APPEND_CAUSE(self_comp, + "Error creating output discarded packet message: " "out-s-addr=%p", out_stream); goto error; } @@ -1676,13 +1697,22 @@ const bt_message *handle_message(struct debug_info_msg_iter *debug_it, out_message = handle_discarded_packets_message(debug_it, in_message); break; default: - abort(); + bt_common_abort(); break; } return out_message; } +static +struct bt_param_validation_map_value_entry_descr debug_info_params[] = { + { "debug-info-field-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_STRING } }, + { "debug-info-dir", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_STRING } }, + { "target-prefix", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_STRING } }, + { "full-path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, + BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END +}; + static bt_component_class_initialize_method_status init_from_params( struct debug_info_component *debug_info_component, @@ -1690,6 +1720,21 @@ bt_component_class_initialize_method_status init_from_params( { const bt_value *value; bt_component_class_initialize_method_status status; + bt_logging_level log_level = debug_info_component->log_level; + enum bt_param_validation_status validation_status; + gchar *validate_error = NULL; + + validation_status = bt_param_validation_validate(params, + debug_info_params, &validate_error); + if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) { + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; + goto end; + } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) { + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; + BT_COMP_LOGE_APPEND_CAUSE(debug_info_component->self_comp, + "%s", validate_error); + goto end; + } BT_ASSERT(params); @@ -1729,6 +1774,9 @@ bt_component_class_initialize_method_status init_from_params( status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; +end: + g_free(validate_error); + return status; } @@ -1752,7 +1800,8 @@ bt_component_class_initialize_method_status debug_info_comp_init( debug_info_comp = g_new0(struct debug_info_component, 1); if (!debug_info_comp) { - BT_COMP_LOGE_STR("Failed to allocate one debug_info component."); + BT_COMP_LOGE_APPEND_CAUSE(self_comp, + "Failed to allocate one debug_info component."); goto error; } @@ -1776,7 +1825,8 @@ bt_component_class_initialize_method_status debug_info_comp_init( status = init_from_params(debug_info_comp, params); if (status != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) { - BT_COMP_LOGE("Cannot configure debug_info component: " + BT_COMP_LOGE_APPEND_CAUSE(self_comp, + "Cannot configure debug_info component: " "debug_info-comp-addr=%p, params-addr=%p", debug_info_comp, params); goto error; @@ -1830,16 +1880,16 @@ bt_component_class_message_iterator_next_method_status debug_info_msg_iter_next( status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; self_comp = bt_self_message_iterator_borrow_component(self_msg_iter); - BT_ASSERT(self_comp); + BT_ASSERT_DBG(self_comp); debug_info = bt_self_component_get_data(self_comp); - BT_ASSERT(debug_info); + BT_ASSERT_DBG(debug_info); debug_info_msg_iter = bt_self_message_iterator_get_data(self_msg_iter); - BT_ASSERT(debug_info_msg_iter); + BT_ASSERT_DBG(debug_info_msg_iter); upstream_iterator = debug_info_msg_iter->msg_iter; - BT_ASSERT(upstream_iterator); + BT_ASSERT_DBG(upstream_iterator); upstream_iterator_ret_status = bt_self_component_port_input_message_iterator_next( @@ -1859,7 +1909,7 @@ bt_component_class_message_iterator_next_method_status debug_info_msg_iter_next( * There should never be more received messages than the capacity we * provided. */ - BT_ASSERT(*count <= capacity); + BT_ASSERT_DBG(*count <= capacity); for (curr_msg_idx = 0; curr_msg_idx < *count; curr_msg_idx++) { out_message = handle_message(debug_info_msg_iter,