X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fplugins%2Futils%2Ftrimmer%2Ftrimmer.c;h=c1c0f6921458cf963f814e41a80f31c4f9e94284;hb=26fc5aedf;hp=87cdb3e104f220e120fae0189ca9af47766a7c87;hpb=ec4ae6605f694c4d97624eba810a08665d53343a;p=babeltrace.git diff --git a/src/plugins/utils/trimmer/trimmer.c b/src/plugins/utils/trimmer/trimmer.c index 87cdb3e1..c1c0f692 100644 --- a/src/plugins/utils/trimmer/trimmer.c +++ b/src/plugins/utils/trimmer/trimmer.c @@ -34,6 +34,7 @@ #include #include #include +#include "compat/glib.h" #include "trimmer.h" @@ -130,32 +131,14 @@ struct trimmer_iterator { }; struct trimmer_iterator_stream_state { - /* - * True if both stream beginning and initial stream activity - * beginning messages were pushed for this stream. - */ - bool inited; - - /* - * True if the last pushed message for this stream was a stream - * activity end message. - */ - bool last_msg_is_stream_activity_end; - - /* - * Time to use for a generated stream end activity message when - * ending the stream. - */ - int64_t stream_act_end_ns_from_origin; - /* Weak */ const bt_stream *stream; + /* Have we seen a message with clock_snapshot going through this stream? */ + bool seen_clock_snapshot; + /* Owned by this (`NULL` initially and between packets) */ const bt_packet *cur_packet; - - /* Owned by this */ - const bt_message *stream_beginning_msg; }; static @@ -183,6 +166,99 @@ void trimmer_finalize(bt_self_component_filter *self_comp) } } +/* + * Compile regex in `pattern`, and try to match `string`. If there's a match, + * return true and set `*match_info` to the list of matches. The list of + * matches must be freed by the caller. If there's no match, return false and + * set `*match_info` to NULL; + */ +static +bool compile_and_match(const char *pattern, const char *string, GMatchInfo **match_info) { + bool matches = false; + GError *regex_error = NULL; + GRegex *regex; + + regex = g_regex_new(pattern, 0, 0, ®ex_error); + if (!regex) { + goto end; + } + + matches = g_regex_match(regex, string, 0, match_info); + if (!matches) { + /* + * g_regex_match allocates `*match_info` even if it returns + * FALSE. If there's no match, we have no use for it, so free + * it immediatly and don't return it to the caller. + */ + g_match_info_free(*match_info); + *match_info = NULL; + } + + g_regex_unref(regex); + +end: + + if (regex_error) { + g_error_free(regex_error); + } + + return matches; +} + +/* + * Convert the captured text in match number `match_num` in `match_info` + * to an unsigned integer. + */ +static +guint64 match_to_uint(const GMatchInfo *match_info, gint match_num) { + gchar *text, *endptr; + guint64 result; + + text = g_match_info_fetch(match_info, match_num); + BT_ASSERT(text); + + /* + * Because the input is carefully sanitized with regexes by the caller, + * we assume that g_ascii_strtoull cannot fail. + */ + errno = 0; + result = g_ascii_strtoull(text, &endptr, 10); + BT_ASSERT(endptr > text); + BT_ASSERT(errno == 0); + + g_free(text); + + return result; +} + +/* + * When parsing the nanoseconds part, .512 means .512000000, not .000000512. + * This function is like match_to_uint, but multiplies the parsed number to get + * the expected result. + */ +static +guint64 match_to_uint_ns(const GMatchInfo *match_info, gint match_num) { + guint64 nanoseconds; + gboolean ret; + gint start_pos, end_pos, power; + static int pow10[] = { + 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000, 100000000, + }; + + nanoseconds = match_to_uint(match_info, match_num); + + /* Multiply by 10 as many times as there are omitted digits. */ + ret = g_match_info_fetch_pos(match_info, match_num, &start_pos, &end_pos); + BT_ASSERT(ret); + + power = 9 - (end_pos - start_pos); + BT_ASSERT(power >= 0 && power <= 8); + + nanoseconds *= pow10[power]; + + return nanoseconds; +} + /* * Sets the time (in ns from origin) of a trimmer bound from date and * time components. @@ -245,98 +321,104 @@ static int set_bound_from_str(struct trimmer_comp *trimmer_comp, const char *str, struct trimmer_bound *bound, bool is_gmt) { +/* Matches YYYY-MM-DD */ +#define DATE_RE "([0-9]{4})-([0-9]{2})-([0-9]{2})" + +/* Matches HH:MM[:SS[.NS]] */ +#define TIME_RE "([0-9]{2}):([0-9]{2})(?::([0-9]{2})(?:\\.([0-9]{1,9}))?)?" + +/* Matches [-]SS[.NS] */ +#define S_NS_RE "^(-?)([0-9]+)(?:\\.([0-9]{1,9}))?$" + + GMatchInfo *match_info; int ret = 0; - int s_ret; - unsigned int year, month, day, hour, minute, second, ns; - char dummy; - - /* Try `YYYY-MM-DD hh:mm:ss.ns` format */ - s_ret = sscanf(str, "%u-%u-%u %u:%u:%u.%u%c", &year, &month, &day, - &hour, &minute, &second, &ns, &dummy); - if (s_ret == 7) { - ret = set_bound_ns_from_origin(bound, year, month, day, - hour, minute, second, ns, is_gmt); - goto end; - } - /* Try `YYYY-MM-DD hh:mm:ss` format */ - s_ret = sscanf(str, "%u-%u-%u %u:%u:%u%c", &year, &month, &day, - &hour, &minute, &second, &dummy); - if (s_ret == 6) { - ret = set_bound_ns_from_origin(bound, year, month, day, - hour, minute, second, 0, is_gmt); - goto end; - } + /* Try `YYYY-MM-DD hh:mm[:ss[.ns]]` format */ + if (compile_and_match("^" DATE_RE " " TIME_RE "$", str, &match_info)) { + unsigned int year = 0, month = 0, day = 0, hours = 0, minutes = 0, seconds = 0, nanoseconds = 0; + gint match_count = g_match_info_get_match_count(match_info); - /* Try `YYYY-MM-DD hh:mm` format */ - s_ret = sscanf(str, "%u-%u-%u %u:%u%c", &year, &month, &day, - &hour, &minute, &dummy); - if (s_ret == 5) { - ret = set_bound_ns_from_origin(bound, year, month, day, - hour, minute, 0, 0, is_gmt); - goto end; - } + BT_ASSERT(match_count >= 6 && match_count <= 8); - /* Try `YYYY-MM-DD` format */ - s_ret = sscanf(str, "%u-%u-%u%c", &year, &month, &day, &dummy); - if (s_ret == 3) { - ret = set_bound_ns_from_origin(bound, year, month, day, - 0, 0, 0, 0, is_gmt); - goto end; - } + year = match_to_uint(match_info, 1); + month = match_to_uint(match_info, 2); + day = match_to_uint(match_info, 3); + hours = match_to_uint(match_info, 4); + minutes = match_to_uint(match_info, 5); - /* Try `hh:mm:ss.ns` format */ - s_ret = sscanf(str, "%u:%u:%u.%u%c", &hour, &minute, &second, &ns, - &dummy); - if (s_ret == 4) { - bound->time.hour = hour; - bound->time.minute = minute; - bound->time.second = second; - bound->time.ns = ns; - goto end; - } + if (match_count >= 7) { + seconds = match_to_uint(match_info, 6); + } - /* Try `hh:mm:ss` format */ - s_ret = sscanf(str, "%u:%u:%u%c", &hour, &minute, &second, &dummy); - if (s_ret == 3) { - bound->time.hour = hour; - bound->time.minute = minute; - bound->time.second = second; - bound->time.ns = 0; - goto end; - } + if (match_count >= 8) { + nanoseconds = match_to_uint_ns(match_info, 7); + } + + set_bound_ns_from_origin(bound, year, month, day, hours, minutes, seconds, nanoseconds, is_gmt); - /* Try `-s.ns` format */ - s_ret = sscanf(str, "-%u.%u%c", &second, &ns, &dummy); - if (s_ret == 2) { - bound->ns_from_origin = -((int64_t) second) * NS_PER_S; - bound->ns_from_origin -= (int64_t) ns; - bound->is_set = true; goto end; } - /* Try `s.ns` format */ - s_ret = sscanf(str, "%u.%u%c", &second, &ns, &dummy); - if (s_ret == 2) { - bound->ns_from_origin = ((int64_t) second) * NS_PER_S; - bound->ns_from_origin += (int64_t) ns; - bound->is_set = true; + if (compile_and_match("^" DATE_RE "$", str, &match_info)) { + unsigned int year = 0, month = 0, day = 0; + + BT_ASSERT(g_match_info_get_match_count(match_info) == 4); + + year = match_to_uint(match_info, 1); + month = match_to_uint(match_info, 2); + day = match_to_uint(match_info, 3); + + set_bound_ns_from_origin(bound, year, month, day, 0, 0, 0, 0, is_gmt); + goto end; } - /* Try `-s` format */ - s_ret = sscanf(str, "-%u%c", &second, &dummy); - if (s_ret == 1) { - bound->ns_from_origin = -((int64_t) second) * NS_PER_S; - bound->is_set = true; + /* Try `hh:mm[:ss[.ns]]` format */ + if (compile_and_match("^" TIME_RE "$", str, &match_info)) { + gint match_count = g_match_info_get_match_count(match_info); + BT_ASSERT(match_count >= 3 && match_count <= 5); + bound->time.hour = match_to_uint(match_info, 1); + bound->time.minute = match_to_uint(match_info, 2); + + if (match_count >= 4) { + bound->time.second = match_to_uint(match_info, 3); + } + + if (match_count >= 5) { + bound->time.ns = match_to_uint_ns(match_info, 4); + } + goto end; } - /* Try `s` format */ - s_ret = sscanf(str, "%u%c", &second, &dummy); - if (s_ret == 1) { - bound->ns_from_origin = (int64_t) second * NS_PER_S; + /* Try `[-]s[.ns]` format */ + if (compile_and_match("^" S_NS_RE "$", str, &match_info)) { + gboolean is_neg, fetch_pos_ret; + gint start_pos, end_pos, match_count; + guint64 seconds, nanoseconds = 0; + + match_count = g_match_info_get_match_count(match_info); + BT_ASSERT(match_count >= 3 && match_count <= 4); + + /* Check for presence of negation sign. */ + fetch_pos_ret = g_match_info_fetch_pos(match_info, 1, &start_pos, &end_pos); + BT_ASSERT(fetch_pos_ret); + is_neg = (end_pos - start_pos) > 0; + + seconds = match_to_uint(match_info, 2); + + if (match_count >= 4) { + nanoseconds = match_to_uint_ns(match_info, 3); + } + + bound->ns_from_origin = seconds * NS_PER_S + nanoseconds; + + if (is_neg) { + bound->ns_from_origin = -bound->ns_from_origin; + } + bound->is_set = true; + goto end; } @@ -444,7 +526,7 @@ int init_trimmer_comp_from_params(struct trimmer_comp *trimmer_comp, if (set_bound_from_param(trimmer_comp, "begin", value, &trimmer_comp->begin, trimmer_comp->is_gmt)) { /* set_bound_from_param() logs errors */ - ret = BT_SELF_COMPONENT_STATUS_ERROR; + ret = -1; goto end; } } else { @@ -457,7 +539,7 @@ int init_trimmer_comp_from_params(struct trimmer_comp *trimmer_comp, if (set_bound_from_param(trimmer_comp, "end", value, &trimmer_comp->end, trimmer_comp->is_gmt)) { /* set_bound_from_param() logs errors */ - ret = BT_SELF_COMPONENT_STATUS_ERROR; + ret = -1; goto end; } } else { @@ -475,37 +557,54 @@ end: return ret; } -bt_self_component_status trimmer_init(bt_self_component_filter *self_comp_flt, +bt_component_class_init_method_status trimmer_init( + bt_self_component_filter *self_comp_flt, const bt_value *params, void *init_data) { int ret; - bt_self_component_status status; + bt_component_class_init_method_status status = + BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK; + bt_self_component_add_port_status add_port_status; struct trimmer_comp *trimmer_comp = create_trimmer_comp(); bt_self_component *self_comp = bt_self_component_filter_as_self_component(self_comp_flt); if (!trimmer_comp) { - status = BT_SELF_COMPONENT_STATUS_NOMEM; + status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR; goto error; } trimmer_comp->log_level = bt_component_get_logging_level( bt_self_component_as_component(self_comp)); trimmer_comp->self_comp = self_comp; - status = bt_self_component_filter_add_input_port( + add_port_status = bt_self_component_filter_add_input_port( self_comp_flt, in_port_name, NULL, NULL); - if (status != BT_SELF_COMPONENT_STATUS_OK) { + switch (add_port_status) { + case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR: + status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR; + goto error; + case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR: + status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR; goto error; + default: + break; } - status = bt_self_component_filter_add_output_port( + add_port_status = bt_self_component_filter_add_output_port( self_comp_flt, "out", NULL, NULL); - if (status != BT_SELF_COMPONENT_STATUS_OK) { + switch (add_port_status) { + case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR: + status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR; + goto error; + case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR: + status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR; goto error; + default: + break; } ret = init_trimmer_comp_from_params(trimmer_comp, params); if (ret) { - status = BT_SELF_COMPONENT_STATUS_ERROR; + status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR; goto error; } @@ -513,8 +612,8 @@ bt_self_component_status trimmer_init(bt_self_component_filter *self_comp_flt, goto end; error: - if (status == BT_SELF_COMPONENT_STATUS_OK) { - status = BT_SELF_COMPONENT_STATUS_ERROR; + if (status == BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK) { + status = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR; } if (trimmer_comp) { @@ -549,23 +648,22 @@ void destroy_trimmer_iterator_stream_state( { BT_ASSERT(sstate); BT_PACKET_PUT_REF_AND_RESET(sstate->cur_packet); - BT_MESSAGE_PUT_REF_AND_RESET(sstate->stream_beginning_msg); g_free(sstate); } BT_HIDDEN -bt_self_message_iterator_status trimmer_msg_iter_init( +bt_component_class_message_iterator_init_method_status trimmer_msg_iter_init( bt_self_message_iterator *self_msg_iter, bt_self_component_filter *self_comp, bt_self_component_port_output *port) { - bt_self_message_iterator_status status = - BT_SELF_MESSAGE_ITERATOR_STATUS_OK; + bt_component_class_message_iterator_init_method_status status = + BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK; struct trimmer_iterator *trimmer_it; trimmer_it = g_new0(struct trimmer_iterator, 1); if (!trimmer_it) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR; goto end; } @@ -591,13 +689,13 @@ bt_self_message_iterator_status trimmer_msg_iter_init( bt_self_component_filter_borrow_input_port_by_name( self_comp, in_port_name)); if (!trimmer_it->upstream_iter) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR; goto end; } trimmer_it->output_messages = g_queue_new(); if (!trimmer_it->output_messages) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR; goto end; } @@ -605,7 +703,7 @@ bt_self_message_iterator_status trimmer_msg_iter_init( g_direct_equal, NULL, (GDestroyNotify) destroy_trimmer_iterator_stream_state); if (!trimmer_it->stream_states) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR; goto end; } @@ -613,7 +711,7 @@ bt_self_message_iterator_status trimmer_msg_iter_init( bt_self_message_iterator_set_data(self_msg_iter, trimmer_it); end: - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK && trimmer_it) { + if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK && trimmer_it) { destroy_trimmer_iterator(trimmer_it); } @@ -622,16 +720,15 @@ end: static inline int get_msg_ns_from_origin(const bt_message *msg, int64_t *ns_from_origin, - bool *skip) + bool *has_clock_snapshot) { const bt_clock_class *clock_class = NULL; const bt_clock_snapshot *clock_snapshot = NULL; - bt_message_stream_activity_clock_snapshot_state sa_cs_state; int ret = 0; BT_ASSERT(msg); BT_ASSERT(ns_from_origin); - BT_ASSERT(skip); + BT_ASSERT(has_clock_snapshot); switch (bt_message_get_type(msg)) { case BT_MESSAGE_TYPE_EVENT: @@ -667,66 +764,61 @@ int get_msg_ns_from_origin(const bt_message *msg, int64_t *ns_from_origin, clock_snapshot = bt_message_packet_end_borrow_default_clock_snapshot_const( msg); break; - case BT_MESSAGE_TYPE_DISCARDED_EVENTS: + case BT_MESSAGE_TYPE_STREAM_BEGINNING: + { + enum bt_message_stream_clock_snapshot_state cs_state; + clock_class = - bt_message_discarded_events_borrow_stream_class_default_clock_class_const( - msg); + bt_message_stream_beginning_borrow_stream_class_default_clock_class_const(msg); if (G_UNLIKELY(!clock_class)) { goto error; } - clock_snapshot = bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const( - msg); - break; - case BT_MESSAGE_TYPE_DISCARDED_PACKETS: - clock_class = - bt_message_discarded_packets_borrow_stream_class_default_clock_class_const( - msg); - if (G_UNLIKELY(!clock_class)) { - goto error; + cs_state = bt_message_stream_beginning_borrow_default_clock_snapshot_const(msg, &clock_snapshot); + if (cs_state != BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) { + goto no_clock_snapshot; } - clock_snapshot = bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const( - msg); break; - case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING: + } + case BT_MESSAGE_TYPE_STREAM_END: + { + enum bt_message_stream_clock_snapshot_state cs_state; + clock_class = - bt_message_stream_activity_beginning_borrow_stream_class_default_clock_class_const( - msg); + bt_message_stream_end_borrow_stream_class_default_clock_class_const(msg); if (G_UNLIKELY(!clock_class)) { goto error; } - sa_cs_state = bt_message_stream_activity_beginning_borrow_default_clock_snapshot_const( - msg, &clock_snapshot); - if (sa_cs_state == BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN || - sa_cs_state == BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE) { - /* Lowest possible time to always include them */ - *ns_from_origin = INT64_MIN; + cs_state = bt_message_stream_end_borrow_default_clock_snapshot_const(msg, &clock_snapshot); + if (cs_state != BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) { goto no_clock_snapshot; } break; - case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END: + } + case BT_MESSAGE_TYPE_DISCARDED_EVENTS: clock_class = - bt_message_stream_activity_end_borrow_stream_class_default_clock_class_const( + bt_message_discarded_events_borrow_stream_class_default_clock_class_const( msg); if (G_UNLIKELY(!clock_class)) { goto error; } - sa_cs_state = bt_message_stream_activity_end_borrow_default_clock_snapshot_const( - msg, &clock_snapshot); - if (sa_cs_state == BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN) { - /* Lowest time to always include it */ - *ns_from_origin = INT64_MIN; - goto no_clock_snapshot; - } else if (sa_cs_state == BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE) { - /* Greatest time to always exclude it */ - *ns_from_origin = INT64_MAX; - goto no_clock_snapshot; + clock_snapshot = bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const( + msg); + break; + case BT_MESSAGE_TYPE_DISCARDED_PACKETS: + clock_class = + bt_message_discarded_packets_borrow_stream_class_default_clock_class_const( + msg); + if (G_UNLIKELY(!clock_class)) { + goto error; } + clock_snapshot = bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const( + msg); break; case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY: clock_snapshot = @@ -743,10 +835,11 @@ int get_msg_ns_from_origin(const bt_message *msg, int64_t *ns_from_origin, goto error; } + *has_clock_snapshot = true; goto end; no_clock_snapshot: - *skip = true; + *has_clock_snapshot = false; goto end; error: @@ -802,11 +895,12 @@ end: } static -bt_self_message_iterator_status state_set_trimmer_iterator_bounds( +bt_component_class_message_iterator_next_method_status +state_set_trimmer_iterator_bounds( struct trimmer_iterator *trimmer_it) { - bt_message_iterator_status upstream_iter_status = - BT_MESSAGE_ITERATOR_STATUS_OK; + bt_message_iterator_next_status upstream_iter_status = + BT_MESSAGE_ITERATOR_NEXT_STATUS_OK; struct trimmer_comp *trimmer_comp = trimmer_it->trimmer_comp; bt_message_array_const msgs; uint64_t count = 0; @@ -821,22 +915,22 @@ bt_self_message_iterator_status state_set_trimmer_iterator_bounds( upstream_iter_status = bt_self_component_port_input_message_iterator_next( trimmer_it->upstream_iter, &msgs, &count); - if (upstream_iter_status != BT_MESSAGE_ITERATOR_STATUS_OK) { + if (upstream_iter_status != BT_MESSAGE_ITERATOR_NEXT_STATUS_OK) { goto end; } for (i = 0; i < count; i++) { const bt_message *msg = msgs[i]; - bool skip = false; + bool has_ns_from_origin; int ret; ret = get_msg_ns_from_origin(msg, &ns_from_origin, - &skip); + &has_ns_from_origin); if (ret) { goto error; } - if (skip) { + if (!has_ns_from_origin) { continue; } @@ -878,19 +972,19 @@ found: error: put_messages(msgs, count); - upstream_iter_status = BT_MESSAGE_ITERATOR_STATUS_ERROR; + upstream_iter_status = BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR; end: return (int) upstream_iter_status; } static -bt_self_message_iterator_status state_seek_initially( +bt_component_class_message_iterator_next_method_status state_seek_initially( struct trimmer_iterator *trimmer_it) { struct trimmer_comp *trimmer_comp = trimmer_it->trimmer_comp; - bt_self_message_iterator_status status = - BT_SELF_MESSAGE_ITERATOR_STATUS_OK; + bt_component_class_message_iterator_next_method_status status = + BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; BT_ASSERT(trimmer_it->begin.is_set); @@ -898,7 +992,7 @@ bt_self_message_iterator_status state_seek_initially( if (!bt_self_component_port_input_message_iterator_can_seek_beginning( trimmer_it->upstream_iter)) { BT_COMP_LOGE_STR("Cannot make upstream message iterator initially seek its beginning."); - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; goto end; } @@ -911,7 +1005,7 @@ bt_self_message_iterator_status state_seek_initially( BT_COMP_LOGE("Cannot make upstream message iterator initially seek: " "seek-ns-from-origin=%" PRId64, trimmer_it->begin.ns_from_origin); - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; goto end; } @@ -919,7 +1013,7 @@ bt_self_message_iterator_status state_seek_initially( trimmer_it->upstream_iter, trimmer_it->begin.ns_from_origin); } - if (status == BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { + if (status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { trimmer_it->state = TRIMMER_ITERATOR_STATE_TRIM; } @@ -955,111 +1049,81 @@ int clock_raw_value_from_ns_from_origin(const bt_clock_class *clock_class, } static inline -bt_self_message_iterator_status end_stream(struct trimmer_iterator *trimmer_it, +bt_component_class_message_iterator_next_method_status +end_stream(struct trimmer_iterator *trimmer_it, struct trimmer_iterator_stream_state *sstate) { - bt_self_message_iterator_status status = - BT_SELF_MESSAGE_ITERATOR_STATUS_OK; - uint64_t raw_value; - const bt_clock_class *clock_class; - int ret; + bt_component_class_message_iterator_next_method_status status = + BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; + /* Initialize to silence maybe-uninitialized warning. */ + uint64_t raw_value = 0; bt_message *msg = NULL; BT_ASSERT(!trimmer_it->end.is_infinite); + BT_ASSERT(sstate->stream); - if (!sstate->stream) { - goto end; - } - - if (sstate->cur_packet) { - /* - * The last message could not have been a stream - * activity end message if we have a current packet. - */ - BT_ASSERT(!sstate->last_msg_is_stream_activity_end); + /* + * If we haven't seen a message with a clock snapshot, we don't know if the trimmer's end bound is within + * the clock's range, so it wouldn't be safe to try to convert ns_from_origin to a clock value. + * + * Also, it would be a bit of a lie to generate a stream end message with the end bound as its + * clock snapshot, because we don't really know if the stream existed at that time. If we have + * seen a message with a clock snapshot and the stream is cut short by another message with a + * clock snapshot, then we are sure that the the end bound time is not below the clock range, + * and we know the stream was active at that time (and that we cut it short). + */ + if (sstate->seen_clock_snapshot) { + const bt_clock_class *clock_class; + int ret; - /* - * Create and push a packet end message, making its time - * the trimming range's end time. - */ clock_class = bt_stream_class_borrow_default_clock_class_const( bt_stream_borrow_class_const(sstate->stream)); BT_ASSERT(clock_class); ret = clock_raw_value_from_ns_from_origin(clock_class, trimmer_it->end.ns_from_origin, &raw_value); if (ret) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; goto end; } + } + + if (sstate->cur_packet) { + /* + * Create and push a packet end message, making its time + * the trimming range's end time. + * + * We know that we must have seen a clock snapshot, the one in + * the packet beginning message, since trimmer currently + * requires packet messages to have clock snapshots (see comment + * in create_stream_state_entry). + */ + BT_ASSERT(sstate->seen_clock_snapshot); msg = bt_message_packet_end_create_with_default_clock_snapshot( trimmer_it->self_msg_iter, sstate->cur_packet, raw_value); if (!msg) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR; goto end; } push_message(trimmer_it, msg); msg = NULL; BT_PACKET_PUT_REF_AND_RESET(sstate->cur_packet); - - /* - * Because we generated a packet end message, set the - * stream activity end message's time to use to the - * trimming range's end time (this packet end message's - * time). - */ - sstate->stream_act_end_ns_from_origin = - trimmer_it->end.ns_from_origin; - } - - if (!sstate->last_msg_is_stream_activity_end) { - /* Create and push a stream activity end message */ - msg = bt_message_stream_activity_end_create( - trimmer_it->self_msg_iter, sstate->stream); - if (!msg) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM; - goto end; - } - - clock_class = bt_stream_class_borrow_default_clock_class_const( - bt_stream_borrow_class_const(sstate->stream)); - BT_ASSERT(clock_class); - - if (sstate->stream_act_end_ns_from_origin == INT64_MIN) { - /* - * We received at least what is necessary to - * have a stream state (stream beginning and - * stream activity beginning messages), but - * nothing else: use the trimmer range's end - * time. - */ - sstate->stream_act_end_ns_from_origin = - trimmer_it->end.ns_from_origin; - } - - ret = clock_raw_value_from_ns_from_origin(clock_class, - sstate->stream_act_end_ns_from_origin, &raw_value); - if (ret) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; - goto end; - } - - bt_message_stream_activity_end_set_default_clock_snapshot( - msg, raw_value); - push_message(trimmer_it, msg); - msg = NULL; } - /* Create and push a stream end message */ + /* Create and push a stream end message. */ msg = bt_message_stream_end_create(trimmer_it->self_msg_iter, sstate->stream); if (!msg) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR; goto end; } + if (sstate->seen_clock_snapshot) { + bt_message_stream_end_set_default_clock_snapshot(msg, raw_value); + } + push_message(trimmer_it, msg); msg = NULL; @@ -1075,11 +1139,11 @@ end: } static inline -bt_self_message_iterator_status end_iterator_streams( +bt_component_class_message_iterator_next_method_status end_iterator_streams( struct trimmer_iterator *trimmer_it) { - bt_self_message_iterator_status status = - BT_SELF_MESSAGE_ITERATOR_STATUS_OK; + bt_component_class_message_iterator_next_method_status status = + BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; GHashTableIter iter; gpointer key, sstate; @@ -1112,190 +1176,132 @@ end: return status; } -static inline -bt_self_message_iterator_status create_stream_beginning_activity_message( +static +bt_component_class_message_iterator_next_method_status +create_stream_state_entry( struct trimmer_iterator *trimmer_it, - const bt_stream *stream, - const bt_clock_class *clock_class, bt_message **msg) + const struct bt_stream *stream, + struct trimmer_iterator_stream_state **stream_state) { - bt_message *local_msg; - bt_self_message_iterator_status status = - BT_SELF_MESSAGE_ITERATOR_STATUS_OK; + struct trimmer_comp *trimmer_comp = trimmer_it->trimmer_comp; + bt_component_class_message_iterator_next_method_status status; + struct trimmer_iterator_stream_state *sstate; + const bt_stream_class *sc; - BT_ASSERT(msg); - BT_ASSERT(!trimmer_it->begin.is_infinite); + BT_ASSERT(!bt_g_hash_table_contains(trimmer_it->stream_states, stream)); - local_msg = bt_message_stream_activity_beginning_create( - trimmer_it->self_msg_iter, stream); - if (!local_msg) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM; + /* + * Validate right now that the stream's class + * has a registered default clock class so that + * an existing stream state guarantees existing + * default clock snapshots for its associated + * messages. + * + * Also check that clock snapshots are always + * known. + */ + sc = bt_stream_borrow_class_const(stream); + if (!bt_stream_class_borrow_default_clock_class_const(sc)) { + BT_COMP_LOGE("Unsupported stream: stream class does " + "not have a default clock class: " + "stream-addr=%p, " + "stream-id=%" PRIu64 ", " + "stream-name=\"%s\"", + stream, bt_stream_get_id(stream), + bt_stream_get_name(stream)); + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; goto end; } - if (clock_class) { - int ret; - uint64_t raw_value; - - ret = clock_raw_value_from_ns_from_origin(clock_class, - trimmer_it->begin.ns_from_origin, &raw_value); - if (ret) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; - bt_message_put_ref(local_msg); - goto end; - } - - bt_message_stream_activity_beginning_set_default_clock_snapshot( - local_msg, raw_value); + /* + * Temporary: make sure packet beginning, packet + * end, discarded events, and discarded packets + * messages have default clock snapshots until + * the support for not having them is + * implemented. + */ + if (!bt_stream_class_packets_have_beginning_default_clock_snapshot( + sc)) { + BT_COMP_LOGE("Unsupported stream: packets have " + "no beginning clock snapshot: " + "stream-addr=%p, " + "stream-id=%" PRIu64 ", " + "stream-name=\"%s\"", + stream, bt_stream_get_id(stream), + bt_stream_get_name(stream)); + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; + goto end; } - BT_MESSAGE_MOVE_REF(*msg, local_msg); - -end: - return status; -} - -/* - * Makes sure to initialize a stream state, pushing the appropriate - * initial messages. - * - * `stream_act_beginning_msg` is an initial stream activity beginning - * message to potentially use, depending on its clock snapshot state. - * This function consumes `stream_act_beginning_msg` unconditionally. - */ -static inline -bt_self_message_iterator_status ensure_stream_state_is_inited( - struct trimmer_iterator *trimmer_it, - struct trimmer_iterator_stream_state *sstate, - const bt_message *stream_act_beginning_msg) -{ - bt_self_message_iterator_status status = - BT_SELF_MESSAGE_ITERATOR_STATUS_OK; - bt_message *new_msg = NULL; - const bt_clock_class *clock_class = - bt_stream_class_borrow_default_clock_class_const( - bt_stream_borrow_class_const(sstate->stream)); - - BT_ASSERT(!sstate->inited); - - if (!sstate->stream_beginning_msg) { - /* No initial stream beginning message: create one */ - sstate->stream_beginning_msg = - bt_message_stream_beginning_create( - trimmer_it->self_msg_iter, sstate->stream); - if (!sstate->stream_beginning_msg) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM; - goto end; - } + if (!bt_stream_class_packets_have_end_default_clock_snapshot( + sc)) { + BT_COMP_LOGE("Unsupported stream: packets have " + "no end clock snapshot: " + "stream-addr=%p, " + "stream-id=%" PRIu64 ", " + "stream-name=\"%s\"", + stream, bt_stream_get_id(stream), + bt_stream_get_name(stream)); + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; + goto end; } - /* Push initial stream beginning message */ - BT_ASSERT(sstate->stream_beginning_msg); - push_message(trimmer_it, sstate->stream_beginning_msg); - sstate->stream_beginning_msg = NULL; + if (bt_stream_class_supports_discarded_events(sc) && + !bt_stream_class_discarded_events_have_default_clock_snapshots(sc)) { + BT_COMP_LOGE("Unsupported stream: discarded events " + "have no clock snapshots: " + "stream-addr=%p, " + "stream-id=%" PRIu64 ", " + "stream-name=\"%s\"", + stream, bt_stream_get_id(stream), + bt_stream_get_name(stream)); + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; + goto end; + } - if (stream_act_beginning_msg) { - /* - * Initial stream activity beginning message exists: if - * its time is -inf, then create and push a new one - * having the trimming range's beginning time. Otherwise - * push it as is (known and unknown). - */ - const bt_clock_snapshot *cs; - bt_message_stream_activity_clock_snapshot_state sa_cs_state; + if (bt_stream_class_supports_discarded_packets(sc) && + !bt_stream_class_discarded_packets_have_default_clock_snapshots(sc)) { + BT_COMP_LOGE("Unsupported stream: discarded packets " + "have no clock snapshots: " + "stream-addr=%p, " + "stream-id=%" PRIu64 ", " + "stream-name=\"%s\"", + stream, bt_stream_get_id(stream), + bt_stream_get_name(stream)); + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; + goto end; + } - sa_cs_state = bt_message_stream_activity_beginning_borrow_default_clock_snapshot_const( - stream_act_beginning_msg, &cs); - if (sa_cs_state == BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE && - !trimmer_it->begin.is_infinite) { - /* - * -inf time: use trimming range's beginning - * time (which is not -inf). - */ - status = create_stream_beginning_activity_message( - trimmer_it, sstate->stream, clock_class, - &new_msg); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { - goto end; - } + sstate = g_new0(struct trimmer_iterator_stream_state, 1); + if (!sstate) { + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR; + goto end; + } - push_message(trimmer_it, new_msg); - new_msg = NULL; - } else { - /* Known/unknown: push as is */ - push_message(trimmer_it, stream_act_beginning_msg); - stream_act_beginning_msg = NULL; - } - } else { - BT_ASSERT(!trimmer_it->begin.is_infinite); + sstate->stream = stream; - /* - * No stream beginning activity message: create and push - * a new message. - */ - status = create_stream_beginning_activity_message( - trimmer_it, sstate->stream, clock_class, &new_msg); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { - goto end; - } + g_hash_table_insert(trimmer_it->stream_states, (void *) stream, sstate); - push_message(trimmer_it, new_msg); - new_msg = NULL; - } + *stream_state = sstate; - sstate->inited = true; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; end: - bt_message_put_ref(new_msg); - bt_message_put_ref(stream_act_beginning_msg); return status; } -static inline -bt_self_message_iterator_status ensure_cur_packet_exists( - struct trimmer_iterator *trimmer_it, - struct trimmer_iterator_stream_state *sstate, - const bt_packet *packet) +static +struct trimmer_iterator_stream_state *get_stream_state_entry( + struct trimmer_iterator *trimmer_it, + const struct bt_stream *stream) { - bt_self_message_iterator_status status = - BT_SELF_MESSAGE_ITERATOR_STATUS_OK; - int ret; - const bt_clock_class *clock_class = - bt_stream_class_borrow_default_clock_class_const( - bt_stream_borrow_class_const(sstate->stream)); - bt_message *msg = NULL; - uint64_t raw_value; - - BT_ASSERT(!trimmer_it->begin.is_infinite); - BT_ASSERT(!sstate->cur_packet); - - /* - * Create and push an initial packet beginning message, - * making its time the trimming range's beginning time. - */ - ret = clock_raw_value_from_ns_from_origin(clock_class, - trimmer_it->begin.ns_from_origin, &raw_value); - if (ret) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; - goto end; - } + struct trimmer_iterator_stream_state *sstate; - msg = bt_message_packet_beginning_create_with_default_clock_snapshot( - trimmer_it->self_msg_iter, packet, raw_value); - if (!msg) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM; - goto end; - } - - push_message(trimmer_it, msg); - msg = NULL; - - /* Set packet as this stream's current packet */ - sstate->cur_packet = packet; - bt_packet_get_ref(sstate->cur_packet); + BT_ASSERT(stream); + sstate = g_hash_table_lookup(trimmer_it->stream_states, stream); + BT_ASSERT(sstate); -end: - bt_message_put_ref(msg); - return status; + return sstate; } /* @@ -1306,116 +1312,107 @@ end: * * This function consumes the `msg` reference, _whatever the outcome_. * - * `ns_from_origin` is the message's time, as given by - * get_msg_ns_from_origin(). + * If non-NULL, `ns_from_origin` is the message's time, as given by + * get_msg_ns_from_origin(). If NULL, the message doesn't have a time. * * This function sets `reached_end` if handling this message made the * iterator reach the end of the trimming range. Note that the output * message queue could contain messages even if this function sets * `reached_end`. */ -static inline -bt_self_message_iterator_status handle_message_with_stream_state( +static +bt_component_class_message_iterator_next_method_status +handle_message_with_stream( struct trimmer_iterator *trimmer_it, const bt_message *msg, - struct trimmer_iterator_stream_state *sstate, - int64_t ns_from_origin, bool *reached_end) + const struct bt_stream *stream, const int64_t *ns_from_origin, + bool *reached_end) { - bt_self_message_iterator_status status = - BT_SELF_MESSAGE_ITERATOR_STATUS_OK; + bt_component_class_message_iterator_next_method_status status = + BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; bt_message_type msg_type = bt_message_get_type(msg); int ret; + struct trimmer_iterator_stream_state *sstate = NULL; + + /* + * Retrieve the stream's state - except if the message is stream + * beginning, in which case we don't know about about this stream yet. + */ + if (msg_type != BT_MESSAGE_TYPE_STREAM_BEGINNING) { + sstate = get_stream_state_entry(trimmer_it, stream); + } switch (msg_type) { case BT_MESSAGE_TYPE_EVENT: + /* + * Event messages always have a clock snapshot if the stream + * class has a clock class. And we know it has, otherwise we + * couldn't be using the trimmer component. + */ + BT_ASSERT(ns_from_origin); + if (G_UNLIKELY(!trimmer_it->end.is_infinite && - ns_from_origin > trimmer_it->end.ns_from_origin)) { + *ns_from_origin > trimmer_it->end.ns_from_origin)) { status = end_iterator_streams(trimmer_it); *reached_end = true; break; } - if (G_UNLIKELY(!sstate->inited)) { - status = ensure_stream_state_is_inited(trimmer_it, - sstate, NULL); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { - goto end; - } - } - - if (G_UNLIKELY(!sstate->cur_packet)) { - const bt_event *event = - bt_message_event_borrow_event_const(msg); - const bt_packet *packet = bt_event_borrow_packet_const( - event); + sstate->seen_clock_snapshot = true; - status = ensure_cur_packet_exists(trimmer_it, sstate, - packet); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { - goto end; - } - } - - BT_ASSERT(sstate->cur_packet); push_message(trimmer_it, msg); msg = NULL; break; + case BT_MESSAGE_TYPE_PACKET_BEGINNING: + /* + * Packet beginning messages won't have a clock snapshot if + * stream_class->packets_have_beginning_default_clock_snapshot + * is false. But for now, assume they always do. + */ + BT_ASSERT(ns_from_origin); + BT_ASSERT(!sstate->cur_packet); + if (G_UNLIKELY(!trimmer_it->end.is_infinite && - ns_from_origin > trimmer_it->end.ns_from_origin)) { + *ns_from_origin > trimmer_it->end.ns_from_origin)) { status = end_iterator_streams(trimmer_it); *reached_end = true; break; } - if (G_UNLIKELY(!sstate->inited)) { - status = ensure_stream_state_is_inited(trimmer_it, - sstate, NULL); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { - goto end; - } - } - - BT_ASSERT(!sstate->cur_packet); sstate->cur_packet = bt_message_packet_beginning_borrow_packet_const(msg); bt_packet_get_ref(sstate->cur_packet); + + sstate->seen_clock_snapshot = true; + push_message(trimmer_it, msg); msg = NULL; break; + case BT_MESSAGE_TYPE_PACKET_END: - sstate->stream_act_end_ns_from_origin = ns_from_origin; + /* + * Packet end messages won't have a clock snapshot if + * stream_class->packets_have_end_default_clock_snapshot + * is false. But for now, assume they always do. + */ + BT_ASSERT(ns_from_origin); + BT_ASSERT(sstate->cur_packet); if (G_UNLIKELY(!trimmer_it->end.is_infinite && - ns_from_origin > trimmer_it->end.ns_from_origin)) { + *ns_from_origin > trimmer_it->end.ns_from_origin)) { status = end_iterator_streams(trimmer_it); *reached_end = true; break; } - if (G_UNLIKELY(!sstate->inited)) { - status = ensure_stream_state_is_inited(trimmer_it, - sstate, NULL); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { - goto end; - } - } - - if (G_UNLIKELY(!sstate->cur_packet)) { - const bt_packet *packet = - bt_message_packet_end_borrow_packet_const(msg); + BT_PACKET_PUT_REF_AND_RESET(sstate->cur_packet); - status = ensure_cur_packet_exists(trimmer_it, sstate, - packet); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { - goto end; - } - } + sstate->seen_clock_snapshot = true; - BT_ASSERT(sstate->cur_packet); - BT_PACKET_PUT_REF_AND_RESET(sstate->cur_packet); push_message(trimmer_it, msg); msg = NULL; break; + case BT_MESSAGE_TYPE_DISCARDED_EVENTS: case BT_MESSAGE_TYPE_DISCARDED_PACKETS: { @@ -1426,6 +1423,10 @@ bt_self_message_iterator_status handle_message_with_stream_state( int64_t end_ns_from_origin; const bt_clock_snapshot *end_cs; + BT_ASSERT(ns_from_origin); + + sstate->seen_clock_snapshot = true; + if (bt_message_get_type(msg) == BT_MESSAGE_TYPE_DISCARDED_EVENTS) { /* @@ -1447,14 +1448,12 @@ bt_self_message_iterator_status handle_message_with_stream_state( if (bt_clock_snapshot_get_ns_from_origin(end_cs, &end_ns_from_origin)) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; goto end; } - sstate->stream_act_end_ns_from_origin = end_ns_from_origin; - if (!trimmer_it->end.is_infinite && - ns_from_origin > trimmer_it->end.ns_from_origin) { + *ns_from_origin > trimmer_it->end.ns_from_origin) { status = end_iterator_streams(trimmer_it); *reached_end = true; break; @@ -1479,7 +1478,7 @@ bt_self_message_iterator_status handle_message_with_stream_state( ret = clock_raw_value_from_ns_from_origin(clock_class, trimmer_it->end.ns_from_origin, &end_raw_value); if (ret) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; goto end; } @@ -1502,7 +1501,7 @@ bt_self_message_iterator_status handle_message_with_stream_state( } if (!new_msg) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR; goto end; } @@ -1510,137 +1509,64 @@ bt_self_message_iterator_status handle_message_with_stream_state( BT_MESSAGE_MOVE_REF(msg, new_msg); } - if (G_UNLIKELY(!sstate->inited)) { - status = ensure_stream_state_is_inited(trimmer_it, - sstate, NULL); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { - goto end; - } - } - push_message(trimmer_it, msg); msg = NULL; break; } - case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING: - if (!trimmer_it->end.is_infinite && - ns_from_origin > trimmer_it->end.ns_from_origin) { - /* - * This only happens when the message's time is - * known and is greater than the trimming - * range's end time. Unknown and -inf times are - * always less than - * `trimmer_it->end.ns_from_origin`. - */ + + case BT_MESSAGE_TYPE_STREAM_BEGINNING: + /* + * If this message has a time and this time is greater than the + * trimmer's end bound, it triggers the end of the trim window. + */ + if (G_UNLIKELY(ns_from_origin && !trimmer_it->end.is_infinite && + *ns_from_origin > trimmer_it->end.ns_from_origin)) { status = end_iterator_streams(trimmer_it); *reached_end = true; break; } - if (!sstate->inited) { - status = ensure_stream_state_is_inited(trimmer_it, - sstate, msg); - msg = NULL; - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { - goto end; - } - } else { - push_message(trimmer_it, msg); - msg = NULL; + /* Learn about this stream. */ + status = create_stream_state_entry(trimmer_it, stream, &sstate); + if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { + goto end; } - break; - case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END: - if (trimmer_it->end.is_infinite) { - push_message(trimmer_it, msg); - msg = NULL; - break; + if (ns_from_origin) { + sstate->seen_clock_snapshot = true; } - if (ns_from_origin == INT64_MIN) { - /* Unknown: push as is if stream state is inited */ - if (sstate->inited) { - push_message(trimmer_it, msg); - msg = NULL; - sstate->last_msg_is_stream_activity_end = true; - } - } else if (ns_from_origin == INT64_MAX) { - /* Infinite: use trimming range's end time */ - sstate->stream_act_end_ns_from_origin = - trimmer_it->end.ns_from_origin; - } else { - /* Known: check if outside of trimming range */ - if (ns_from_origin > trimmer_it->end.ns_from_origin) { - sstate->stream_act_end_ns_from_origin = - trimmer_it->end.ns_from_origin; - status = end_iterator_streams(trimmer_it); - *reached_end = true; - break; - } - - if (!sstate->inited) { - /* - * First message for this stream is a - * stream activity end: we can't deduce - * anything about the stream activity - * beginning's time, and using this - * message's time would make a useless - * pair of stream activity beginning/end - * with the same time. Just skip this - * message and wait for something - * useful. - */ - break; - } + push_message(trimmer_it, msg); + msg = NULL; + break; + case BT_MESSAGE_TYPE_STREAM_END: + { + gboolean removed; - push_message(trimmer_it, msg); - msg = NULL; - sstate->last_msg_is_stream_activity_end = true; - sstate->stream_act_end_ns_from_origin = ns_from_origin; + /* + * If this message has a time and this time is greater than the + * trimmer's end bound, it triggers the end of the trim window. + */ + if (G_UNLIKELY(ns_from_origin && !trimmer_it->end.is_infinite && + *ns_from_origin > trimmer_it->end.ns_from_origin)) { + status = end_iterator_streams(trimmer_it); + *reached_end = true; + break; } - break; - case BT_MESSAGE_TYPE_STREAM_BEGINNING: /* - * We don't know what follows at this point, so just - * keep this message until we know what to do with it - * (it will be used in ensure_stream_state_is_inited()). + * Either the stream end message's time is within the trimmer's + * bounds, or it doesn't have a time. In both cases, pass + * the message unmodified. */ - BT_ASSERT(!sstate->inited); - BT_MESSAGE_MOVE_REF(sstate->stream_beginning_msg, msg); - break; - case BT_MESSAGE_TYPE_STREAM_END: - if (sstate->inited) { - /* - * This is the end of an inited stream: end this - * stream if its stream activity end message - * time is not the trimming range's end time - * (which means the final stream activity end - * message had an infinite time). end_stream() - * will generate its own stream end message. - */ - if (trimmer_it->end.is_infinite) { - push_message(trimmer_it, msg); - msg = NULL; - g_hash_table_remove(trimmer_it->stream_states, - sstate->stream); - } else if (sstate->stream_act_end_ns_from_origin < - trimmer_it->end.ns_from_origin) { - status = end_stream(trimmer_it, sstate); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { - goto end; - } - - /* We won't need this stream state again */ - g_hash_table_remove(trimmer_it->stream_states, - sstate->stream); - } - } else { - /* We dont't need this stream state anymore */ - g_hash_table_remove(trimmer_it->stream_states, sstate->stream); - } + push_message(trimmer_it, msg); + msg = NULL; + /* Forget about this stream. */ + removed = g_hash_table_remove(trimmer_it->stream_states, sstate->stream); + BT_ASSERT(removed); break; + } default: break; } @@ -1648,7 +1574,7 @@ bt_self_message_iterator_status handle_message_with_stream_state( end: /* We release the message's reference whatever the outcome */ bt_message_put_ref(msg); - return BT_SELF_MESSAGE_ITERATOR_STATUS_OK; + return status; } /* @@ -1664,17 +1590,15 @@ end: * `reached_end`. */ static inline -bt_self_message_iterator_status handle_message( +bt_component_class_message_iterator_next_method_status handle_message( struct trimmer_iterator *trimmer_it, const bt_message *msg, bool *reached_end) { - bt_self_message_iterator_status status; + bt_component_class_message_iterator_next_method_status status; const bt_stream *stream = NULL; int64_t ns_from_origin = INT64_MIN; - bool skip; + bool has_ns_from_origin; int ret; - struct trimmer_iterator_stream_state *sstate = NULL; - struct trimmer_comp *trimmer_comp = trimmer_it->trimmer_comp; /* Find message's associated stream */ switch (bt_message_get_type(msg)) { @@ -1696,12 +1620,6 @@ bt_self_message_iterator_status handle_message( case BT_MESSAGE_TYPE_DISCARDED_PACKETS: stream = bt_message_discarded_packets_borrow_stream_const(msg); break; - case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING: - stream = bt_message_stream_activity_beginning_borrow_stream_const(msg); - break; - case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END: - stream = bt_message_stream_activity_end_borrow_stream_const(msg); - break; case BT_MESSAGE_TYPE_STREAM_BEGINNING: stream = bt_message_stream_beginning_borrow_stream_const(msg); break; @@ -1712,121 +1630,17 @@ bt_self_message_iterator_status handle_message( break; } - if (G_LIKELY(stream)) { - /* Find stream state */ - sstate = g_hash_table_lookup(trimmer_it->stream_states, - stream); - if (G_UNLIKELY(!sstate)) { - /* No stream state yet: create one now */ - const bt_stream_class *sc; - - /* - * Validate right now that the stream's class - * has a registered default clock class so that - * an existing stream state guarantees existing - * default clock snapshots for its associated - * messages. - * - * Also check that clock snapshots are always - * known. - */ - sc = bt_stream_borrow_class_const(stream); - if (!bt_stream_class_borrow_default_clock_class_const(sc)) { - BT_COMP_LOGE("Unsupported stream: stream class does " - "not have a default clock class: " - "stream-addr=%p, " - "stream-id=%" PRIu64 ", " - "stream-name=\"%s\"", - stream, bt_stream_get_id(stream), - bt_stream_get_name(stream)); - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; - goto end; - } - - /* - * Temporary: make sure packet beginning, packet - * end, discarded events, and discarded packets - * messages have default clock snapshots until - * the support for not having them is - * implemented. - */ - if (!bt_stream_class_packets_have_beginning_default_clock_snapshot( - sc)) { - BT_COMP_LOGE("Unsupported stream: packets have " - "no beginning clock snapshot: " - "stream-addr=%p, " - "stream-id=%" PRIu64 ", " - "stream-name=\"%s\"", - stream, bt_stream_get_id(stream), - bt_stream_get_name(stream)); - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; - goto end; - } - - if (!bt_stream_class_packets_have_end_default_clock_snapshot( - sc)) { - BT_COMP_LOGE("Unsupported stream: packets have " - "no end clock snapshot: " - "stream-addr=%p, " - "stream-id=%" PRIu64 ", " - "stream-name=\"%s\"", - stream, bt_stream_get_id(stream), - bt_stream_get_name(stream)); - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; - goto end; - } - - if (bt_stream_class_supports_discarded_events(sc) && - !bt_stream_class_discarded_events_have_default_clock_snapshots(sc)) { - BT_COMP_LOGE("Unsupported stream: discarded events " - "have no clock snapshots: " - "stream-addr=%p, " - "stream-id=%" PRIu64 ", " - "stream-name=\"%s\"", - stream, bt_stream_get_id(stream), - bt_stream_get_name(stream)); - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; - goto end; - } - - if (bt_stream_class_supports_discarded_packets(sc) && - !bt_stream_class_discarded_packets_have_default_clock_snapshots(sc)) { - BT_COMP_LOGE("Unsupported stream: discarded packets " - "have no clock snapshots: " - "stream-addr=%p, " - "stream-id=%" PRIu64 ", " - "stream-name=\"%s\"", - stream, bt_stream_get_id(stream), - bt_stream_get_name(stream)); - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; - goto end; - } - - sstate = g_new0(struct trimmer_iterator_stream_state, - 1); - if (!sstate) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM; - goto end; - } - - sstate->stream = stream; - sstate->stream_act_end_ns_from_origin = INT64_MIN; - g_hash_table_insert(trimmer_it->stream_states, - (void *) stream, sstate); - } - } - /* Retrieve the message's time */ - ret = get_msg_ns_from_origin(msg, &ns_from_origin, &skip); + ret = get_msg_ns_from_origin(msg, &ns_from_origin, &has_ns_from_origin); if (G_UNLIKELY(ret)) { - status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; goto end; } - if (G_LIKELY(sstate)) { + if (G_LIKELY(stream)) { /* Message associated to a stream */ - status = handle_message_with_stream_state(trimmer_it, msg, - sstate, ns_from_origin, reached_end); + status = handle_message_with_stream(trimmer_it, msg, + stream, has_ns_from_origin ? &ns_from_origin : NULL, reached_end); /* * handle_message_with_stream_state() unconditionally @@ -1844,7 +1658,7 @@ bt_self_message_iterator_status handle_message( *reached_end = true; } else { push_message(trimmer_it, msg); - status = BT_SELF_MESSAGE_ITERATOR_STATUS_OK; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; msg = NULL; } } @@ -1876,17 +1690,17 @@ void fill_message_array_from_output_messages( } static inline -bt_self_message_iterator_status state_ending( +bt_component_class_message_iterator_next_method_status state_ending( struct trimmer_iterator *trimmer_it, bt_message_array_const msgs, uint64_t capacity, uint64_t *count) { - bt_self_message_iterator_status status = - BT_SELF_MESSAGE_ITERATOR_STATUS_OK; + bt_component_class_message_iterator_next_method_status status = + BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; if (g_queue_is_empty(trimmer_it->output_messages)) { trimmer_it->state = TRIMMER_ITERATOR_STATE_ENDED; - status = BT_SELF_MESSAGE_ITERATOR_STATUS_END; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END; goto end; } @@ -1898,12 +1712,13 @@ end: } static inline -bt_self_message_iterator_status state_trim(struct trimmer_iterator *trimmer_it, +bt_component_class_message_iterator_next_method_status +state_trim(struct trimmer_iterator *trimmer_it, bt_message_array_const msgs, uint64_t capacity, uint64_t *count) { - bt_self_message_iterator_status status = - BT_SELF_MESSAGE_ITERATOR_STATUS_OK; + bt_component_class_message_iterator_next_method_status status = + BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; bt_message_array_const my_msgs; uint64_t my_count; uint64_t i; @@ -1912,10 +1727,10 @@ bt_self_message_iterator_status state_trim(struct trimmer_iterator *trimmer_it, while (g_queue_is_empty(trimmer_it->output_messages)) { status = (int) bt_self_component_port_input_message_iterator_next( trimmer_it->upstream_iter, &my_msgs, &my_count); - if (G_UNLIKELY(status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK)) { - if (status == BT_SELF_MESSAGE_ITERATOR_STATUS_END) { + if (G_UNLIKELY(status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK)) { + if (status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END) { status = end_iterator_streams(trimmer_it); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { + if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { goto end; } @@ -1941,7 +1756,7 @@ bt_self_message_iterator_status state_trim(struct trimmer_iterator *trimmer_it, my_msgs[i] = NULL; if (G_UNLIKELY(status != - BT_SELF_MESSAGE_ITERATOR_STATUS_OK)) { + BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK)) { put_messages(my_msgs, my_count); goto end; } @@ -1980,50 +1795,50 @@ end: } BT_HIDDEN -bt_self_message_iterator_status trimmer_msg_iter_next( +bt_component_class_message_iterator_next_method_status trimmer_msg_iter_next( bt_self_message_iterator *self_msg_iter, bt_message_array_const msgs, uint64_t capacity, uint64_t *count) { struct trimmer_iterator *trimmer_it = bt_self_message_iterator_get_data(self_msg_iter); - bt_self_message_iterator_status status = - BT_SELF_MESSAGE_ITERATOR_STATUS_OK; + bt_component_class_message_iterator_next_method_status status = + BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; BT_ASSERT(trimmer_it); if (G_LIKELY(trimmer_it->state == TRIMMER_ITERATOR_STATE_TRIM)) { status = state_trim(trimmer_it, msgs, capacity, count); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { + if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { goto end; } } else { switch (trimmer_it->state) { case TRIMMER_ITERATOR_STATE_SET_BOUNDS_NS_FROM_ORIGIN: status = state_set_trimmer_iterator_bounds(trimmer_it); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { + if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { goto end; } status = state_seek_initially(trimmer_it); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { + if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { goto end; } status = state_trim(trimmer_it, msgs, capacity, count); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { + if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { goto end; } break; case TRIMMER_ITERATOR_STATE_SEEK_INITIALLY: status = state_seek_initially(trimmer_it); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { + if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { goto end; } status = state_trim(trimmer_it, msgs, capacity, count); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { + if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { goto end; } @@ -2031,13 +1846,13 @@ bt_self_message_iterator_status trimmer_msg_iter_next( case TRIMMER_ITERATOR_STATE_ENDING: status = state_ending(trimmer_it, msgs, capacity, count); - if (status != BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { + if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { goto end; } break; case TRIMMER_ITERATOR_STATE_ENDED: - status = BT_SELF_MESSAGE_ITERATOR_STATUS_END; + status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END; break; default: abort();