Always evaluate BT_ASSERT(); add BT_ASSERT_DBG() for debug mode only
[babeltrace.git] / src / plugins / lttng-utils / debug-info / debug-info.c
index 2eebc19b2e32196d11038d0f945e7794bf4a2b56..71bb4c1a1158da434b95d96fbf6cb9ea47a2e755 100644 (file)
@@ -43,6 +43,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"
@@ -334,7 +335,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 +369,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 +379,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 +414,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 +623,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 +632,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) {
@@ -955,7 +950,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) {
@@ -998,7 +993,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,
@@ -1022,7 +1017,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) {
@@ -1073,7 +1068,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,11 +1078,11 @@ 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, "");
@@ -1118,12 +1113,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 +1278,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);
@@ -1683,12 +1679,36 @@ const bt_message *handle_message(struct debug_info_msg_iter *debug_it,
        return out_message;
 }
 
+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
-int init_from_params(struct debug_info_component *debug_info_component,
+bt_component_class_initialize_method_status init_from_params(
+               struct debug_info_component *debug_info_component,
                const bt_value *params)
 {
-       const bt_value *value = NULL;
-       int ret = 0;
+       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);
 
@@ -1726,7 +1746,12 @@ int init_from_params(struct debug_info_component *debug_info_component,
                debug_info_component->arg_full_path = BT_FALSE;
        }
 
-       return ret;
+       status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
+
+end:
+       g_free(validate_error);
+
+       return status;
 }
 
 BT_HIDDEN
@@ -1735,7 +1760,6 @@ bt_component_class_initialize_method_status debug_info_comp_init(
                bt_self_component_filter_configuration *config,
                const bt_value *params, __attribute__((unused)) void *init_method_data)
 {
-       int ret;
        struct debug_info_component *debug_info_comp;
        bt_component_class_initialize_method_status status =
                BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
@@ -1745,7 +1769,6 @@ bt_component_class_initialize_method_status debug_info_comp_init(
        bt_logging_level log_level = bt_component_get_logging_level(
                bt_self_component_as_component(self_comp));
 
-
        BT_COMP_LOGI("Initializing debug_info component: "
                "comp-addr=%p, params-addr=%p", self_comp, params);
 
@@ -1761,32 +1784,20 @@ bt_component_class_initialize_method_status debug_info_comp_init(
 
        add_port_status = bt_self_component_filter_add_input_port(
                self_comp_flt, "in", NULL, NULL);
-       switch (add_port_status) {
-       case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR:
-               status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
-               goto error;
-       case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR:
-               status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
+       if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
+               status = (int) add_port_status;
                goto error;
-       default:
-               break;
        }
 
        add_port_status = bt_self_component_filter_add_output_port(
-               self_comp_flt, "out", NULL, NULL);
-       switch (add_port_status) {
-       case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR:
-               status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
-               goto error;
-       case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR:
-               status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
+                       self_comp_flt, "out", NULL, NULL);
+       if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
+               status = (int) add_port_status;
                goto error;
-       default:
-               break;
        }
 
-       ret = init_from_params(debug_info_comp, params);
-       if (ret) {
+       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: "
                        "debug_info-comp-addr=%p, params-addr=%p",
                        debug_info_comp, params);
@@ -1841,16 +1852,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(
@@ -1870,7 +1881,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,
This page took 0.027298 seconds and 4 git commands to generate.