X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fplugins%2Ftext%2Fdmesg%2Fdmesg.c;h=6031c9aea28d39b775350049f6673292e08e3225;hb=98b15851a941e7342b8bb19e265cdc3a40fabfb8;hp=12413b381ce0d30dbfa414ea4d21cafc6d6384c3;hpb=d24d56638469189904fb6ddbb3c725817b3e9417;p=babeltrace.git diff --git a/src/plugins/text/dmesg/dmesg.c b/src/plugins/text/dmesg/dmesg.c index 12413b38..6031c9ae 100644 --- a/src/plugins/text/dmesg/dmesg.c +++ b/src/plugins/text/dmesg/dmesg.c @@ -24,7 +24,7 @@ #define BT_COMP_LOG_SELF_COMP (dmesg_comp->self_comp) #define BT_LOG_OUTPUT_LEVEL (dmesg_comp->log_level) #define BT_LOG_TAG "PLUGIN/SRC.TEXT.DMESG" -#include "plugins/comp-logging.h" +#include "logging/comp-logging.h" #include #include @@ -36,6 +36,7 @@ #include "compat/utc.h" #include "compat/stdio.h" #include +#include "plugins/common/param-validation/param-validation.h" #define NSEC_PER_USEC 1000UL #define NSEC_PER_MSEC 1000000UL @@ -55,11 +56,7 @@ struct dmesg_msg_iter { enum { STATE_EMIT_STREAM_BEGINNING, - STATE_EMIT_STREAM_ACTIVITY_BEGINNING, - STATE_EMIT_PACKET_BEGINNING, STATE_EMIT_EVENT, - STATE_EMIT_PACKET_END, - STATE_EMIT_STREAM_ACTIVITY_END, STATE_EMIT_STREAM_END, STATE_DONE, } state; @@ -81,7 +78,6 @@ struct dmesg_component { bt_event_class *event_class; bt_trace *trace; bt_stream *stream; - bt_packet *packet; bt_clock_class *clock_class; }; @@ -163,11 +159,6 @@ int create_meta(struct dmesg_component *dmesg_comp, bool has_ts) BT_COMP_LOGE_STR("Cannot set stream class's default clock class."); goto error; } - - bt_stream_class_set_packets_have_beginning_default_clock_snapshot( - dmesg_comp->stream_class, BT_TRUE); - bt_stream_class_set_packets_have_end_default_clock_snapshot( - dmesg_comp->stream_class, BT_TRUE); } dmesg_comp->event_class = bt_event_class_create( @@ -205,62 +196,60 @@ end: return ret; } +struct bt_param_validation_map_value_entry_descr dmesg_params[] = { + { "no-extract-timestamp", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, + { "path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_STRING } }, + BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END +}; + static -int handle_params(struct dmesg_component *dmesg_comp, +bt_component_class_initialize_method_status handle_params( + struct dmesg_component *dmesg_comp, const bt_value *params) { const bt_value *no_timestamp = NULL; const bt_value *path = NULL; - const char *path_str; - int ret = 0; + bt_component_class_initialize_method_status status; + enum bt_param_validation_status validation_status; + gchar *validate_error = NULL; + + validation_status = bt_param_validation_validate(params, + dmesg_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(dmesg_comp->self_comp, + "%s", validate_error); + goto end; + } no_timestamp = bt_value_map_borrow_entry_value_const(params, "no-extract-timestamp"); if (no_timestamp) { - if (!bt_value_is_bool(no_timestamp)) { - BT_COMP_LOGE("Expecting a boolean value for the `no-extract-timestamp` parameter: " - "type=%s", - bt_common_value_type_string( - bt_value_get_type(no_timestamp))); - goto error; - } - dmesg_comp->params.no_timestamp = bt_value_bool_get(no_timestamp); } path = bt_value_map_borrow_entry_value_const(params, "path"); if (path) { - if (dmesg_comp->params.read_from_stdin) { - BT_COMP_LOGE_STR("Cannot specify both `read-from-stdin` and `path` parameters."); - goto error; - } + const char *path_str = bt_value_string_get(path); - if (!bt_value_is_string(path)) { - BT_COMP_LOGE("Expecting a string value for the `path` parameter: " - "type=%s", - bt_common_value_type_string( - bt_value_get_type(path))); - goto error; - } - - path_str = bt_value_string_get(path); g_string_assign(dmesg_comp->params.path, path_str); } else { dmesg_comp->params.read_from_stdin = true; } - goto end; - -error: - ret = -1; - + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; end: - return ret; + g_free(validate_error); + + return status; } static -int create_packet_and_stream_and_trace(struct dmesg_component *dmesg_comp) +int create_stream_and_trace(struct dmesg_component *dmesg_comp) { int ret = 0; const char *trace_name = NULL; @@ -300,28 +289,19 @@ int create_packet_and_stream_and_trace(struct dmesg_component *dmesg_comp) goto error; } - dmesg_comp->packet = bt_packet_create(dmesg_comp->stream); - if (!dmesg_comp->packet) { - BT_COMP_LOGE_STR("Cannot create packet object."); - goto error; - } - goto end; error: ret = -1; end: - if (basename) { - g_free(basename); - } + g_free(basename); return ret; } static -int try_create_meta_stream_packet(struct dmesg_component *dmesg_comp, - bool has_ts) +int try_create_meta_stream(struct dmesg_component *dmesg_comp, bool has_ts) { int ret = 0; @@ -337,9 +317,9 @@ int try_create_meta_stream_packet(struct dmesg_component *dmesg_comp, goto error; } - ret = create_packet_and_stream_and_trace(dmesg_comp); + ret = create_stream_and_trace(dmesg_comp); if (ret) { - BT_COMP_LOGE("Cannot create packet and stream objects: " + BT_COMP_LOGE("Cannot create stream object: " "dmesg-comp-addr=%p", dmesg_comp); goto error; } @@ -364,7 +344,6 @@ void destroy_dmesg_component(struct dmesg_component *dmesg_comp) g_string_free(dmesg_comp->params.path, TRUE); } - bt_packet_put_ref(dmesg_comp->packet); bt_trace_put_ref(dmesg_comp->trace); bt_stream_class_put_ref(dmesg_comp->stream_class); bt_event_class_put_ref(dmesg_comp->event_class); @@ -375,23 +354,23 @@ void destroy_dmesg_component(struct dmesg_component *dmesg_comp) } static -bt_component_class_init_method_status create_port( +bt_component_class_initialize_method_status create_port( bt_self_component_source *self_comp) { - bt_component_class_init_method_status status; + bt_component_class_initialize_method_status status; bt_self_component_add_port_status add_port_status; add_port_status = bt_self_component_source_add_output_port(self_comp, "out", NULL, NULL); switch (add_port_status) { case BT_SELF_COMPONENT_ADD_PORT_STATUS_OK: - status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK; + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; break; case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR: - status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR; + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; break; case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR: - status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR; + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; break; default: abort(); @@ -401,14 +380,13 @@ bt_component_class_init_method_status create_port( } BT_HIDDEN -bt_component_class_init_method_status dmesg_init( +bt_component_class_initialize_method_status dmesg_init( bt_self_component_source *self_comp_src, - bt_value *params, void *init_method_data) + bt_self_component_source_configuration *config, + const bt_value *params, void *init_method_data) { - int ret = 0; struct dmesg_component *dmesg_comp = g_new0(struct dmesg_component, 1); - bt_component_class_init_method_status status = - BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK; + bt_component_class_initialize_method_status status; bt_self_component *self_comp = bt_self_component_source_as_self_component(self_comp_src); const bt_component *comp = bt_self_component_as_component(self_comp); @@ -418,6 +396,7 @@ bt_component_class_init_method_status dmesg_init( /* Implicit log level is not available here */ BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp, "Failed to allocate one dmesg component structure."); + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; goto error; } @@ -427,12 +406,14 @@ bt_component_class_init_method_status dmesg_init( dmesg_comp->params.path = g_string_new(NULL); if (!dmesg_comp->params.path) { BT_COMP_LOGE_STR("Failed to allocate a GString."); + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; goto error; } - ret = handle_params(dmesg_comp, params); - if (ret) { + status = handle_params(dmesg_comp, params); + if (status != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) { BT_COMP_LOGE("Invalid parameters: comp-addr=%p", self_comp); + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; goto error; } @@ -442,26 +423,25 @@ bt_component_class_init_method_status dmesg_init( BT_COMP_LOGE("Input path is not a regular file: " "comp-addr=%p, path=\"%s\"", self_comp, dmesg_comp->params.path->str); + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; goto error; } status = create_port(self_comp_src); - if (status != BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK) { + if (status != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) { goto error; } bt_self_component_set_data(self_comp, dmesg_comp); BT_COMP_LOGI_STR("Component initialized."); + + status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; goto end; error: destroy_dmesg_component(dmesg_comp); bt_self_component_set_data(self_comp, NULL); - if (status >= 0) { - status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR; - } - end: return status; } @@ -529,7 +509,7 @@ bt_message *create_init_event_msg_from_line( if (has_timestamp) { /* Set new start for the message portion of the line */ *new_start = strchr(line, ']'); - BT_ASSERT(*new_start); + BT_ASSERT_DBG(*new_start); (*new_start)++; if ((*new_start)[0] == ' ') { @@ -541,22 +521,22 @@ skip_ts: /* * At this point, we know if the stream class's event header * field class should have a timestamp or not, so we can lazily - * create the metadata, stream, and packet objects. + * create the metadata and stream objects. */ - ret = try_create_meta_stream_packet(dmesg_comp, has_timestamp); + ret = try_create_meta_stream(dmesg_comp, has_timestamp); if (ret) { - /* try_create_meta_stream_packet() logs errors */ + /* try_create_meta_stream() logs errors */ goto error; } if (dmesg_comp->clock_class) { msg = bt_message_event_create_with_default_clock_snapshot( msg_iter->pc_msg_iter, - dmesg_comp->event_class, dmesg_comp->packet, ts); + dmesg_comp->event_class, dmesg_comp->stream, ts); msg_iter->last_clock_value = ts; } else { msg = bt_message_event_create(msg_iter->pc_msg_iter, - dmesg_comp->event_class, dmesg_comp->packet); + dmesg_comp->event_class, dmesg_comp->stream); } if (!msg) { @@ -565,7 +545,7 @@ skip_ts: } event = bt_message_event_borrow_event(msg); - BT_ASSERT(event); + BT_ASSERT_DBG(event); goto end; error: @@ -585,7 +565,7 @@ int fill_event_payload_from_line(struct dmesg_component *dmesg_comp, int ret; ep_field = bt_event_borrow_payload_field(event); - BT_ASSERT(ep_field); + BT_ASSERT_DBG(ep_field); str_field = bt_field_structure_borrow_member_field_by_index( ep_field, 0); if (!str_field) { @@ -634,7 +614,7 @@ bt_message *create_msg_from_line( } event = bt_message_event_borrow_event(msg); - BT_ASSERT(event); + BT_ASSERT_DBG(event); ret = fill_event_payload_from_line(dmesg_comp, new_start, event); if (ret) { BT_COMP_LOGE("Cannot fill event payload field from line: " @@ -654,12 +634,14 @@ end: static void destroy_dmesg_msg_iter(struct dmesg_msg_iter *dmesg_msg_iter) { - struct dmesg_component *dmesg_comp = dmesg_msg_iter->dmesg_comp; + struct dmesg_component *dmesg_comp; if (!dmesg_msg_iter) { return; } + dmesg_comp = dmesg_msg_iter->dmesg_comp; + if (dmesg_msg_iter->fp && dmesg_msg_iter->fp != stdin) { if (fclose(dmesg_msg_iter->fp)) { BT_COMP_LOGE_ERRNO("Cannot close input file", "."); @@ -674,8 +656,9 @@ void destroy_dmesg_msg_iter(struct dmesg_msg_iter *dmesg_msg_iter) BT_HIDDEN -bt_component_class_message_iterator_init_method_status dmesg_msg_iter_init( +bt_component_class_message_iterator_initialize_method_status dmesg_msg_iter_init( bt_self_message_iterator *self_msg_iter, + bt_self_message_iterator_configuration *config, bt_self_component_source *self_comp, bt_self_component_port_output *self_port) { @@ -683,8 +666,8 @@ bt_component_class_message_iterator_init_method_status dmesg_msg_iter_init( bt_self_component_source_as_self_component(self_comp)); struct dmesg_msg_iter *dmesg_msg_iter = g_new0(struct dmesg_msg_iter, 1); - bt_component_class_message_iterator_init_method_status status = - BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK; + bt_component_class_message_iterator_initialize_method_status status = + BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK; if (!dmesg_msg_iter) { BT_COMP_LOGE_STR("Failed to allocate on dmesg message iterator structure."); @@ -714,7 +697,7 @@ error: destroy_dmesg_msg_iter(dmesg_msg_iter); bt_self_message_iterator_set_data(self_msg_iter, NULL); if (status >= 0) { - status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR; } end: @@ -739,9 +722,9 @@ bt_component_class_message_iterator_next_method_status dmesg_msg_iter_next_one( bt_component_class_message_iterator_next_method_status status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; - BT_ASSERT(dmesg_msg_iter); + BT_ASSERT_DBG(dmesg_msg_iter); dmesg_comp = dmesg_msg_iter->dmesg_comp; - BT_ASSERT(dmesg_comp); + BT_ASSERT_DBG(dmesg_comp); if (dmesg_msg_iter->state == STATE_DONE) { status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END; @@ -749,8 +732,6 @@ bt_component_class_message_iterator_next_method_status dmesg_msg_iter_next_one( } if (dmesg_msg_iter->tmp_event_msg || - dmesg_msg_iter->state == STATE_EMIT_PACKET_END || - dmesg_msg_iter->state == STATE_EMIT_STREAM_ACTIVITY_END || dmesg_msg_iter->state == STATE_EMIT_STREAM_END) { goto handle_state; } @@ -772,9 +753,9 @@ bt_component_class_message_iterator_next_method_status dmesg_msg_iter_next_one( status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END; goto end; } else { - /* End current packet now */ + /* End stream now */ dmesg_msg_iter->state = - STATE_EMIT_PACKET_END; + STATE_EMIT_STREAM_END; goto handle_state; } } @@ -782,7 +763,7 @@ bt_component_class_message_iterator_next_method_status dmesg_msg_iter_next_one( goto end; } - BT_ASSERT(dmesg_msg_iter->linebuf); + BT_ASSERT_DBG(dmesg_msg_iter->linebuf); /* Ignore empty lines, once trimmed */ for (ch = dmesg_msg_iter->linebuf; *ch != '\0'; ch++) { @@ -807,57 +788,20 @@ bt_component_class_message_iterator_next_method_status dmesg_msg_iter_next_one( } handle_state: - BT_ASSERT(dmesg_comp->trace); + BT_ASSERT_DBG(dmesg_comp->trace); switch (dmesg_msg_iter->state) { case STATE_EMIT_STREAM_BEGINNING: - BT_ASSERT(dmesg_msg_iter->tmp_event_msg); + BT_ASSERT_DBG(dmesg_msg_iter->tmp_event_msg); *msg = bt_message_stream_beginning_create( dmesg_msg_iter->pc_msg_iter, dmesg_comp->stream); - dmesg_msg_iter->state = STATE_EMIT_STREAM_ACTIVITY_BEGINNING; - break; - case STATE_EMIT_STREAM_ACTIVITY_BEGINNING: - BT_ASSERT(dmesg_msg_iter->tmp_event_msg); - *msg = bt_message_stream_activity_beginning_create( - dmesg_msg_iter->pc_msg_iter, dmesg_comp->stream); - dmesg_msg_iter->state = STATE_EMIT_PACKET_BEGINNING; - break; - case STATE_EMIT_PACKET_BEGINNING: - BT_ASSERT(dmesg_msg_iter->tmp_event_msg); - - if (dmesg_comp->clock_class) { - *msg = bt_message_packet_beginning_create_with_default_clock_snapshot( - dmesg_msg_iter->pc_msg_iter, dmesg_comp->packet, - dmesg_msg_iter->last_clock_value); - } else { - *msg = bt_message_packet_beginning_create( - dmesg_msg_iter->pc_msg_iter, dmesg_comp->packet); - } - dmesg_msg_iter->state = STATE_EMIT_EVENT; break; case STATE_EMIT_EVENT: - BT_ASSERT(dmesg_msg_iter->tmp_event_msg); + BT_ASSERT_DBG(dmesg_msg_iter->tmp_event_msg); *msg = dmesg_msg_iter->tmp_event_msg; dmesg_msg_iter->tmp_event_msg = NULL; break; - case STATE_EMIT_PACKET_END: - if (dmesg_comp->clock_class) { - *msg = bt_message_packet_end_create_with_default_clock_snapshot( - dmesg_msg_iter->pc_msg_iter, dmesg_comp->packet, - dmesg_msg_iter->last_clock_value); - } else { - *msg = bt_message_packet_end_create( - dmesg_msg_iter->pc_msg_iter, dmesg_comp->packet); - } - - dmesg_msg_iter->state = STATE_EMIT_STREAM_ACTIVITY_END; - break; - case STATE_EMIT_STREAM_ACTIVITY_END: - *msg = bt_message_stream_activity_end_create( - dmesg_msg_iter->pc_msg_iter, dmesg_comp->stream); - dmesg_msg_iter->state = STATE_EMIT_STREAM_END; - break; case STATE_EMIT_STREAM_END: *msg = bt_message_stream_end_create( dmesg_msg_iter->pc_msg_iter, dmesg_comp->stream); @@ -923,14 +867,17 @@ bt_component_class_message_iterator_next_method_status dmesg_msg_iter_next( } BT_HIDDEN -bt_bool dmesg_msg_iter_can_seek_beginning( - bt_self_message_iterator *self_msg_iter) +bt_component_class_message_iterator_can_seek_beginning_method_status +dmesg_msg_iter_can_seek_beginning( + bt_self_message_iterator *self_msg_iter, bt_bool *can_seek) { struct dmesg_msg_iter *dmesg_msg_iter = bt_self_message_iterator_get_data(self_msg_iter); /* Can't seek the beginning of the standard input stream */ - return !dmesg_msg_iter->dmesg_comp->params.read_from_stdin; + *can_seek = !dmesg_msg_iter->dmesg_comp->params.read_from_stdin; + + return BT_COMPONENT_CLASS_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_METHOD_STATUS_OK; } BT_HIDDEN