2 * SPDX-License-Identifier: MIT
4 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
8 #define BT_LOG_OUTPUT_LEVEL (trimmer_comp->log_level)
9 #define BT_LOG_TAG "PLUGIN/FLT.UTILS.TRIMMER"
10 #include "logging/comp-logging.h"
12 #include "compat/utc.h"
13 #include "compat/time.h"
14 #include <babeltrace2/babeltrace.h>
15 #include "common/common.h"
16 #include "common/assert.h"
21 #include "compat/glib.h"
22 #include "plugins/common/param-validation/param-validation.h"
26 #define NS_PER_S INT64_C(1000000000)
28 static const char * const in_port_name
= "in";
31 unsigned int hour
, minute
, second
, ns
;
34 struct trimmer_bound
{
36 * Nanoseconds from origin, valid if `is_set` is set and
37 * `is_infinite` is false.
39 int64_t ns_from_origin
;
41 /* True if this bound's full time (`ns_from_origin`) is set */
45 * True if this bound represents the infinity (negative or
46 * positive depending on which bound it is). If this is true,
47 * then we don't care about `ns_from_origin` above.
52 * This bound's time without the date; this time is used to set
53 * `ns_from_origin` once we know the date.
55 struct trimmer_time time
;
59 struct trimmer_bound begin
, end
;
61 bt_logging_level log_level
;
62 bt_self_component
*self_comp
;
63 bt_self_component_filter
*self_comp_filter
;
66 enum trimmer_iterator_state
{
68 * Find the first message's date and set the bounds's times
71 TRIMMER_ITERATOR_STATE_SET_BOUNDS_NS_FROM_ORIGIN
,
74 * Initially seek to the trimming range's beginning time.
76 TRIMMER_ITERATOR_STATE_SEEK_INITIALLY
,
79 * Fill the output message queue for as long as received input
80 * messages are within the trimming time range.
82 TRIMMER_ITERATOR_STATE_TRIM
,
84 /* Flush the remaining messages in the output message queue */
85 TRIMMER_ITERATOR_STATE_ENDING
,
87 /* Trimming operation and message iterator is ended */
88 TRIMMER_ITERATOR_STATE_ENDED
,
91 struct trimmer_iterator
{
93 struct trimmer_comp
*trimmer_comp
;
96 bt_self_message_iterator
*self_msg_iter
;
98 enum trimmer_iterator_state state
;
101 bt_message_iterator
*upstream_iter
;
102 struct trimmer_bound begin
, end
;
105 * Queue of `const bt_message *` (owned by the queue).
107 * This is where the trimming operation pushes the messages to
108 * output by this message iterator.
110 GQueue
*output_messages
;
113 * Hash table of `bt_stream *` (weak) to
114 * `struct trimmer_iterator_stream_state *` (owned by the HT).
116 GHashTable
*stream_states
;
119 struct trimmer_iterator_stream_state
{
121 const bt_stream
*stream
;
123 /* Have we seen a message with clock_snapshot going through this stream? */
124 bool seen_clock_snapshot
;
126 /* Owned by this (`NULL` initially and between packets) */
127 const bt_packet
*cur_packet
;
131 void destroy_trimmer_comp(struct trimmer_comp
*trimmer_comp
)
133 BT_ASSERT(trimmer_comp
);
134 g_free(trimmer_comp
);
138 struct trimmer_comp
*create_trimmer_comp(void)
140 return g_new0(struct trimmer_comp
, 1);
143 void trimmer_finalize(bt_self_component_filter
*self_comp
)
145 struct trimmer_comp
*trimmer_comp
=
146 bt_self_component_get_data(
147 bt_self_component_filter_as_self_component(self_comp
));
150 destroy_trimmer_comp(trimmer_comp
);
155 * Compile regex in `pattern`, and try to match `string`. If there's a match,
156 * return true and set `*match_info` to the list of matches. The list of
157 * matches must be freed by the caller. If there's no match, return false and
158 * set `*match_info` to NULL;
161 bool compile_and_match(const char *pattern
, const char *string
, GMatchInfo
**match_info
) {
162 bool matches
= false;
163 GError
*regex_error
= NULL
;
166 regex
= g_regex_new(pattern
, 0, 0, ®ex_error
);
171 matches
= g_regex_match(regex
, string
, 0, match_info
);
174 * g_regex_match allocates `*match_info` even if it returns
175 * FALSE. If there's no match, we have no use for it, so free
176 * it immediatly and don't return it to the caller.
178 g_match_info_free(*match_info
);
182 g_regex_unref(regex
);
187 g_error_free(regex_error
);
194 * Convert the captured text in match number `match_num` in `match_info`
195 * to an unsigned integer.
198 guint64
match_to_uint(const GMatchInfo
*match_info
, gint match_num
) {
199 gchar
*text
, *endptr
;
202 text
= g_match_info_fetch(match_info
, match_num
);
206 * Because the input is carefully sanitized with regexes by the caller,
207 * we assume that g_ascii_strtoull cannot fail.
210 result
= g_ascii_strtoull(text
, &endptr
, 10);
211 BT_ASSERT(endptr
> text
);
212 BT_ASSERT(errno
== 0);
220 * When parsing the nanoseconds part, .512 means .512000000, not .000000512.
221 * This function is like match_to_uint, but multiplies the parsed number to get
222 * the expected result.
225 guint64
match_to_uint_ns(const GMatchInfo
*match_info
, gint match_num
) {
228 gint start_pos
, end_pos
, power
;
229 static int pow10
[] = {
230 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000, 100000000,
233 nanoseconds
= match_to_uint(match_info
, match_num
);
235 /* Multiply by 10 as many times as there are omitted digits. */
236 ret
= g_match_info_fetch_pos(match_info
, match_num
, &start_pos
, &end_pos
);
239 power
= 9 - (end_pos
- start_pos
);
240 BT_ASSERT(power
>= 0 && power
<= 8);
242 nanoseconds
*= pow10
[power
];
248 * Sets the time (in ns from origin) of a trimmer bound from date and
251 * Returns a negative value if anything goes wrong.
254 int set_bound_ns_from_origin(struct trimmer_bound
*bound
,
255 unsigned int year
, unsigned int month
, unsigned int day
,
256 unsigned int hour
, unsigned int minute
, unsigned int second
,
257 unsigned int ns
, bool is_gmt
)
267 .tm_year
= year
- 1900,
272 result
= bt_timegm(&tm
);
274 result
= mktime(&tm
);
283 bound
->ns_from_origin
= (int64_t) result
;
284 bound
->ns_from_origin
*= NS_PER_S
;
285 bound
->ns_from_origin
+= ns
;
286 bound
->is_set
= true;
293 * Parses a timestamp, figuring out its format.
295 * Returns a negative value if anything goes wrong.
299 * YYYY-MM-DD hh:mm[:ss[.ns]]
303 * TODO: Check overflows.
306 int set_bound_from_str(struct trimmer_comp
*trimmer_comp
,
307 const char *str
, struct trimmer_bound
*bound
, bool is_gmt
)
309 /* Matches YYYY-MM-DD */
310 #define DATE_RE "([0-9]{4})-([0-9]{2})-([0-9]{2})"
312 /* Matches HH:MM[:SS[.NS]] */
313 #define TIME_RE "([0-9]{2}):([0-9]{2})(?::([0-9]{2})(?:\\.([0-9]{1,9}))?)?"
315 /* Matches [-]SS[.NS] */
316 #define S_NS_RE "^(-?)([0-9]+)(?:\\.([0-9]{1,9}))?$"
318 GMatchInfo
*match_info
;
321 /* Try `YYYY-MM-DD hh:mm[:ss[.ns]]` format */
322 if (compile_and_match("^" DATE_RE
" " TIME_RE
"$", str
, &match_info
)) {
323 unsigned int year
= 0, month
= 0, day
= 0, hours
= 0, minutes
= 0, seconds
= 0, nanoseconds
= 0;
324 gint match_count
= g_match_info_get_match_count(match_info
);
326 BT_ASSERT(match_count
>= 6 && match_count
<= 8);
328 year
= match_to_uint(match_info
, 1);
329 month
= match_to_uint(match_info
, 2);
330 day
= match_to_uint(match_info
, 3);
331 hours
= match_to_uint(match_info
, 4);
332 minutes
= match_to_uint(match_info
, 5);
334 if (match_count
>= 7) {
335 seconds
= match_to_uint(match_info
, 6);
338 if (match_count
>= 8) {
339 nanoseconds
= match_to_uint_ns(match_info
, 7);
342 set_bound_ns_from_origin(bound
, year
, month
, day
, hours
, minutes
, seconds
, nanoseconds
, is_gmt
);
347 if (compile_and_match("^" DATE_RE
"$", str
, &match_info
)) {
348 unsigned int year
= 0, month
= 0, day
= 0;
350 BT_ASSERT(g_match_info_get_match_count(match_info
) == 4);
352 year
= match_to_uint(match_info
, 1);
353 month
= match_to_uint(match_info
, 2);
354 day
= match_to_uint(match_info
, 3);
356 set_bound_ns_from_origin(bound
, year
, month
, day
, 0, 0, 0, 0, is_gmt
);
361 /* Try `hh:mm[:ss[.ns]]` format */
362 if (compile_and_match("^" TIME_RE
"$", str
, &match_info
)) {
363 gint match_count
= g_match_info_get_match_count(match_info
);
364 BT_ASSERT(match_count
>= 3 && match_count
<= 5);
365 bound
->time
.hour
= match_to_uint(match_info
, 1);
366 bound
->time
.minute
= match_to_uint(match_info
, 2);
368 if (match_count
>= 4) {
369 bound
->time
.second
= match_to_uint(match_info
, 3);
372 if (match_count
>= 5) {
373 bound
->time
.ns
= match_to_uint_ns(match_info
, 4);
379 /* Try `[-]s[.ns]` format */
380 if (compile_and_match("^" S_NS_RE
"$", str
, &match_info
)) {
381 gboolean is_neg
, fetch_pos_ret
;
382 gint start_pos
, end_pos
, match_count
;
383 guint64 seconds
, nanoseconds
= 0;
385 match_count
= g_match_info_get_match_count(match_info
);
386 BT_ASSERT(match_count
>= 3 && match_count
<= 4);
388 /* Check for presence of negation sign. */
389 fetch_pos_ret
= g_match_info_fetch_pos(match_info
, 1, &start_pos
, &end_pos
);
390 BT_ASSERT(fetch_pos_ret
);
391 is_neg
= (end_pos
- start_pos
) > 0;
393 seconds
= match_to_uint(match_info
, 2);
395 if (match_count
>= 4) {
396 nanoseconds
= match_to_uint_ns(match_info
, 3);
399 bound
->ns_from_origin
= seconds
* NS_PER_S
+ nanoseconds
;
402 bound
->ns_from_origin
= -bound
->ns_from_origin
;
405 bound
->is_set
= true;
410 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
411 "Invalid date/time format: param=\"%s\"", str
);
415 g_match_info_free(match_info
);
421 * Sets a trimmer bound's properties from a parameter string/integer
424 * Returns a negative value if anything goes wrong.
427 int set_bound_from_param(struct trimmer_comp
*trimmer_comp
,
428 const bt_value
*param
,
429 struct trimmer_bound
*bound
, bool is_gmt
)
435 if (bt_value_is_signed_integer(param
)) {
436 int64_t value
= bt_value_integer_signed_get(param
);
439 * Just convert it to a temporary string to handle
440 * everything the same way.
442 snprintf(tmp_arg
, sizeof(tmp_arg
), "%" PRId64
, value
);
445 BT_ASSERT(bt_value_is_string(param
));
446 arg
= bt_value_string_get(param
);
449 ret
= set_bound_from_str(trimmer_comp
, arg
, bound
, is_gmt
);
455 int validate_trimmer_bounds(struct trimmer_comp
*trimmer_comp
,
456 struct trimmer_bound
*begin
, struct trimmer_bound
*end
)
460 BT_ASSERT(begin
->is_set
);
461 BT_ASSERT(end
->is_set
);
463 if (!begin
->is_infinite
&& !end
->is_infinite
&&
464 begin
->ns_from_origin
> end
->ns_from_origin
) {
465 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
466 "Trimming time range's beginning time is greater than end time: "
467 "begin-ns-from-origin=%" PRId64
", "
468 "end-ns-from-origin=%" PRId64
,
469 begin
->ns_from_origin
,
470 end
->ns_from_origin
);
475 if (!begin
->is_infinite
&& begin
->ns_from_origin
== INT64_MIN
) {
476 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
477 "Invalid trimming time range's beginning time: "
478 "ns-from-origin=%" PRId64
,
479 begin
->ns_from_origin
);
484 if (!end
->is_infinite
&& end
->ns_from_origin
== INT64_MIN
) {
485 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
486 "Invalid trimming time range's end time: "
487 "ns-from-origin=%" PRId64
,
488 end
->ns_from_origin
);
498 enum bt_param_validation_status
validate_bound_type(
499 const bt_value
*value
,
500 struct bt_param_validation_context
*context
)
502 enum bt_param_validation_status status
= BT_PARAM_VALIDATION_STATUS_OK
;
504 if (!bt_value_is_signed_integer(value
) &&
505 !bt_value_is_string(value
)) {
506 status
= bt_param_validation_error(context
,
507 "unexpected type: expected-types=[%s, %s], actual-type=%s",
508 bt_common_value_type_string(BT_VALUE_TYPE_SIGNED_INTEGER
),
509 bt_common_value_type_string(BT_VALUE_TYPE_STRING
),
510 bt_common_value_type_string(bt_value_get_type(value
)));
517 struct bt_param_validation_map_value_entry_descr trimmer_params
[] = {
518 { "gmt", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
519 { "begin", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .validation_func
= validate_bound_type
} },
520 { "end", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .validation_func
= validate_bound_type
} },
521 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
525 bt_component_class_initialize_method_status
init_trimmer_comp_from_params(
526 struct trimmer_comp
*trimmer_comp
,
527 const bt_value
*params
)
529 const bt_value
*value
;
530 bt_component_class_initialize_method_status status
;
531 enum bt_param_validation_status validation_status
;
532 gchar
*validate_error
= NULL
;
534 validation_status
= bt_param_validation_validate(params
,
535 trimmer_params
, &validate_error
);
536 if (validation_status
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
537 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
539 } else if (validation_status
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
540 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
541 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
, "%s",
547 value
= bt_value_map_borrow_entry_value_const(params
, "gmt");
549 trimmer_comp
->is_gmt
= (bool) bt_value_bool_get(value
);
552 value
= bt_value_map_borrow_entry_value_const(params
, "begin");
554 if (set_bound_from_param(trimmer_comp
, value
,
555 &trimmer_comp
->begin
, trimmer_comp
->is_gmt
)) {
556 /* set_bound_from_param() logs errors */
557 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
561 trimmer_comp
->begin
.is_infinite
= true;
562 trimmer_comp
->begin
.is_set
= true;
565 value
= bt_value_map_borrow_entry_value_const(params
, "end");
567 if (set_bound_from_param(trimmer_comp
, value
,
568 &trimmer_comp
->end
, trimmer_comp
->is_gmt
)) {
569 /* set_bound_from_param() logs errors */
570 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
574 trimmer_comp
->end
.is_infinite
= true;
575 trimmer_comp
->end
.is_set
= true;
578 if (trimmer_comp
->begin
.is_set
&& trimmer_comp
->end
.is_set
) {
579 /* validate_trimmer_bounds() logs errors */
580 if (validate_trimmer_bounds(trimmer_comp
,
581 &trimmer_comp
->begin
, &trimmer_comp
->end
)) {
582 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
587 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
590 g_free(validate_error
);
595 bt_component_class_initialize_method_status
trimmer_init(
596 bt_self_component_filter
*self_comp_flt
,
597 bt_self_component_filter_configuration
*config
__attribute__((unused
)),
598 const bt_value
*params
,
599 void *init_data
__attribute__((unused
)))
601 bt_component_class_initialize_method_status status
;
602 bt_self_component_add_port_status add_port_status
;
603 struct trimmer_comp
*trimmer_comp
= create_trimmer_comp();
604 bt_self_component
*self_comp
=
605 bt_self_component_filter_as_self_component(self_comp_flt
);
608 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
612 trimmer_comp
->log_level
= bt_component_get_logging_level(
613 bt_self_component_as_component(self_comp
));
614 trimmer_comp
->self_comp
= self_comp
;
615 trimmer_comp
->self_comp_filter
= self_comp_flt
;
617 add_port_status
= bt_self_component_filter_add_input_port(
618 self_comp_flt
, in_port_name
, NULL
, NULL
);
619 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
620 status
= (int) add_port_status
;
624 add_port_status
= bt_self_component_filter_add_output_port(
625 self_comp_flt
, "out", NULL
, NULL
);
626 if (add_port_status
!= BT_SELF_COMPONENT_ADD_PORT_STATUS_OK
) {
627 status
= (int) add_port_status
;
631 status
= init_trimmer_comp_from_params(trimmer_comp
, params
);
632 if (status
!= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
) {
636 bt_self_component_set_data(self_comp
, trimmer_comp
);
638 status
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
643 destroy_trimmer_comp(trimmer_comp
);
651 void destroy_trimmer_iterator(struct trimmer_iterator
*trimmer_it
)
657 bt_message_iterator_put_ref(
658 trimmer_it
->upstream_iter
);
660 if (trimmer_it
->output_messages
) {
661 g_queue_free(trimmer_it
->output_messages
);
664 if (trimmer_it
->stream_states
) {
665 g_hash_table_destroy(trimmer_it
->stream_states
);
674 void destroy_trimmer_iterator_stream_state(
675 struct trimmer_iterator_stream_state
*sstate
)
678 BT_PACKET_PUT_REF_AND_RESET(sstate
->cur_packet
);
682 bt_message_iterator_class_initialize_method_status
trimmer_msg_iter_init(
683 bt_self_message_iterator
*self_msg_iter
,
684 bt_self_message_iterator_configuration
*config
,
685 bt_self_component_port_output
*port
__attribute__((unused
)))
687 bt_message_iterator_class_initialize_method_status status
;
688 bt_message_iterator_create_from_message_iterator_status
690 struct trimmer_iterator
*trimmer_it
;
691 bt_self_component
*self_comp
=
692 bt_self_message_iterator_borrow_component(self_msg_iter
);
694 trimmer_it
= g_new0(struct trimmer_iterator
, 1);
696 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
700 trimmer_it
->trimmer_comp
= bt_self_component_get_data(self_comp
);
701 BT_ASSERT(trimmer_it
->trimmer_comp
);
703 if (trimmer_it
->trimmer_comp
->begin
.is_set
&&
704 trimmer_it
->trimmer_comp
->end
.is_set
) {
706 * Both trimming time range's bounds are set, so skip
708 * `TRIMMER_ITERATOR_STATE_SET_BOUNDS_NS_FROM_ORIGIN`
711 trimmer_it
->state
= TRIMMER_ITERATOR_STATE_SEEK_INITIALLY
;
714 trimmer_it
->begin
= trimmer_it
->trimmer_comp
->begin
;
715 trimmer_it
->end
= trimmer_it
->trimmer_comp
->end
;
717 bt_message_iterator_create_from_message_iterator(
719 bt_self_component_filter_borrow_input_port_by_name(
720 trimmer_it
->trimmer_comp
->self_comp_filter
, in_port_name
),
721 &trimmer_it
->upstream_iter
);
722 if (msg_iter_status
!= BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK
) {
723 status
= (int) msg_iter_status
;
727 trimmer_it
->output_messages
= g_queue_new();
728 if (!trimmer_it
->output_messages
) {
729 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
733 trimmer_it
->stream_states
= g_hash_table_new_full(g_direct_hash
,
734 g_direct_equal
, NULL
,
735 (GDestroyNotify
) destroy_trimmer_iterator_stream_state
);
736 if (!trimmer_it
->stream_states
) {
737 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
742 * The trimmer requires upstream messages to have times, so it can
743 * always seek forward.
745 bt_self_message_iterator_configuration_set_can_seek_forward(
748 trimmer_it
->self_msg_iter
= self_msg_iter
;
749 bt_self_message_iterator_set_data(self_msg_iter
, trimmer_it
);
751 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
755 destroy_trimmer_iterator(trimmer_it
);
762 int get_msg_ns_from_origin(const bt_message
*msg
, int64_t *ns_from_origin
,
763 bool *has_clock_snapshot
)
765 const bt_clock_class
*clock_class
= NULL
;
766 const bt_clock_snapshot
*clock_snapshot
= NULL
;
770 BT_ASSERT_DBG(ns_from_origin
);
771 BT_ASSERT_DBG(has_clock_snapshot
);
773 switch (bt_message_get_type(msg
)) {
774 case BT_MESSAGE_TYPE_EVENT
:
776 bt_message_event_borrow_stream_class_default_clock_class_const(
778 if (G_UNLIKELY(!clock_class
)) {
782 clock_snapshot
= bt_message_event_borrow_default_clock_snapshot_const(
785 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
787 const bt_packet
*packet
= bt_message_packet_beginning_borrow_packet_const(msg
);
788 const bt_stream
*stream
= bt_packet_borrow_stream_const(packet
);
789 const bt_stream_class
*stream_class
= bt_stream_borrow_class_const(stream
);
791 if (!bt_stream_class_packets_have_beginning_default_clock_snapshot(stream_class
)) {
792 goto no_clock_snapshot
;
795 clock_snapshot
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(
799 case BT_MESSAGE_TYPE_PACKET_END
:
801 const bt_packet
*packet
= bt_message_packet_end_borrow_packet_const(msg
);
802 const bt_stream
*stream
= bt_packet_borrow_stream_const(packet
);
803 const bt_stream_class
*stream_class
= bt_stream_borrow_class_const(stream
);
805 if (!bt_stream_class_packets_have_end_default_clock_snapshot(stream_class
)) {
806 goto no_clock_snapshot
;
809 clock_snapshot
= bt_message_packet_end_borrow_default_clock_snapshot_const(
813 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
815 enum bt_message_stream_clock_snapshot_state cs_state
;
818 bt_message_stream_beginning_borrow_stream_class_default_clock_class_const(msg
);
819 if (G_UNLIKELY(!clock_class
)) {
823 cs_state
= bt_message_stream_beginning_borrow_default_clock_snapshot_const(msg
, &clock_snapshot
);
824 if (cs_state
!= BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
) {
825 goto no_clock_snapshot
;
830 case BT_MESSAGE_TYPE_STREAM_END
:
832 enum bt_message_stream_clock_snapshot_state cs_state
;
835 bt_message_stream_end_borrow_stream_class_default_clock_class_const(msg
);
836 if (G_UNLIKELY(!clock_class
)) {
840 cs_state
= bt_message_stream_end_borrow_default_clock_snapshot_const(msg
, &clock_snapshot
);
841 if (cs_state
!= BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
) {
842 goto no_clock_snapshot
;
847 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
849 const bt_stream
*stream
= bt_message_discarded_events_borrow_stream_const(msg
);
850 const bt_stream_class
*stream_class
= bt_stream_borrow_class_const(stream
);
852 if (!bt_stream_class_discarded_events_have_default_clock_snapshots(stream_class
)) {
853 goto no_clock_snapshot
;
856 clock_snapshot
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
860 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
862 const bt_stream
*stream
= bt_message_discarded_packets_borrow_stream_const(msg
);
863 const bt_stream_class
*stream_class
= bt_stream_borrow_class_const(stream
);
865 if (!bt_stream_class_discarded_packets_have_default_clock_snapshots(stream_class
)) {
866 goto no_clock_snapshot
;
869 clock_snapshot
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
873 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
875 bt_message_message_iterator_inactivity_borrow_clock_snapshot_const(
879 goto no_clock_snapshot
;
882 ret
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
,
884 if (G_UNLIKELY(ret
)) {
888 *has_clock_snapshot
= true;
892 *has_clock_snapshot
= false;
903 void put_messages(bt_message_array_const msgs
, uint64_t count
)
907 for (i
= 0; i
< count
; i
++) {
908 BT_MESSAGE_PUT_REF_AND_RESET(msgs
[i
]);
913 int set_trimmer_iterator_bound(struct trimmer_iterator
*trimmer_it
,
914 struct trimmer_bound
*bound
, int64_t ns_from_origin
,
917 struct trimmer_comp
*trimmer_comp
= trimmer_it
->trimmer_comp
;
920 time_t time_seconds
= (time_t) (ns_from_origin
/ NS_PER_S
);
923 BT_ASSERT(!bound
->is_set
);
926 /* We only need to extract the date from this time */
928 res
= bt_gmtime_r(&time_seconds
, &tm
);
930 res
= bt_localtime_r(&time_seconds
, &tm
);
934 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(trimmer_comp
->self_comp
,
935 "Cannot convert timestamp to date and time",
936 ": ts=%" PRId64
, (int64_t) time_seconds
);
941 ret
= set_bound_ns_from_origin(bound
, tm
.tm_year
+ 1900, tm
.tm_mon
+ 1,
942 tm
.tm_mday
, bound
->time
.hour
, bound
->time
.minute
,
943 bound
->time
.second
, bound
->time
.ns
, is_gmt
);
950 bt_message_iterator_class_next_method_status
951 state_set_trimmer_iterator_bounds(
952 struct trimmer_iterator
*trimmer_it
)
954 bt_message_iterator_next_status upstream_iter_status
=
955 BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
;
956 struct trimmer_comp
*trimmer_comp
= trimmer_it
->trimmer_comp
;
957 bt_message_array_const msgs
;
959 int64_t ns_from_origin
= INT64_MIN
;
963 BT_ASSERT(!trimmer_it
->begin
.is_set
||
964 !trimmer_it
->end
.is_set
);
967 upstream_iter_status
=
968 bt_message_iterator_next(
969 trimmer_it
->upstream_iter
, &msgs
, &count
);
970 if (upstream_iter_status
!= BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
) {
974 for (i
= 0; i
< count
; i
++) {
975 const bt_message
*msg
= msgs
[i
];
976 bool has_ns_from_origin
;
977 ret
= get_msg_ns_from_origin(msg
, &ns_from_origin
,
978 &has_ns_from_origin
);
983 if (!has_ns_from_origin
) {
987 BT_ASSERT_DBG(ns_from_origin
!= INT64_MIN
&&
988 ns_from_origin
!= INT64_MAX
);
989 put_messages(msgs
, count
);
993 put_messages(msgs
, count
);
997 if (!trimmer_it
->begin
.is_set
) {
998 BT_ASSERT(!trimmer_it
->begin
.is_infinite
);
999 ret
= set_trimmer_iterator_bound(trimmer_it
, &trimmer_it
->begin
,
1000 ns_from_origin
, trimmer_comp
->is_gmt
);
1006 if (!trimmer_it
->end
.is_set
) {
1007 BT_ASSERT(!trimmer_it
->end
.is_infinite
);
1008 ret
= set_trimmer_iterator_bound(trimmer_it
, &trimmer_it
->end
,
1009 ns_from_origin
, trimmer_comp
->is_gmt
);
1015 ret
= validate_trimmer_bounds(trimmer_it
->trimmer_comp
,
1016 &trimmer_it
->begin
, &trimmer_it
->end
);
1024 put_messages(msgs
, count
);
1025 upstream_iter_status
= BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR
;
1028 return (int) upstream_iter_status
;
1032 bt_message_iterator_class_next_method_status
state_seek_initially(
1033 struct trimmer_iterator
*trimmer_it
)
1035 struct trimmer_comp
*trimmer_comp
= trimmer_it
->trimmer_comp
;
1036 bt_message_iterator_class_next_method_status status
;
1038 BT_ASSERT(trimmer_it
->begin
.is_set
);
1040 if (trimmer_it
->begin
.is_infinite
) {
1043 status
= (int) bt_message_iterator_can_seek_beginning(
1044 trimmer_it
->upstream_iter
, &can_seek
);
1045 if (status
!= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
1047 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1048 "Cannot make upstream message iterator initially seek its beginning.");
1055 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1056 "Cannot make upstream message iterator initially seek its beginning.");
1057 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1061 status
= (int) bt_message_iterator_seek_beginning(
1062 trimmer_it
->upstream_iter
);
1066 status
= (int) bt_message_iterator_can_seek_ns_from_origin(
1067 trimmer_it
->upstream_iter
, trimmer_it
->begin
.ns_from_origin
,
1070 if (status
!= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
1072 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1073 "Cannot make upstream message iterator initially seek: seek-ns-from-origin=%" PRId64
,
1074 trimmer_it
->begin
.ns_from_origin
);
1081 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1082 "Cannot make upstream message iterator initially seek: seek-ns-from-origin=%" PRId64
,
1083 trimmer_it
->begin
.ns_from_origin
);
1084 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1088 status
= (int) bt_message_iterator_seek_ns_from_origin(
1089 trimmer_it
->upstream_iter
, trimmer_it
->begin
.ns_from_origin
);
1092 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
1093 trimmer_it
->state
= TRIMMER_ITERATOR_STATE_TRIM
;
1101 void push_message(struct trimmer_iterator
*trimmer_it
, const bt_message
*msg
)
1103 g_queue_push_head(trimmer_it
->output_messages
, (void *) msg
);
1107 const bt_message
*pop_message(struct trimmer_iterator
*trimmer_it
)
1109 return g_queue_pop_tail(trimmer_it
->output_messages
);
1113 int clock_raw_value_from_ns_from_origin(const bt_clock_class
*clock_class
,
1114 int64_t ns_from_origin
, uint64_t *raw_value
)
1117 int64_t cc_offset_s
;
1118 uint64_t cc_offset_cycles
;
1121 bt_clock_class_get_offset(clock_class
, &cc_offset_s
, &cc_offset_cycles
);
1122 cc_freq
= bt_clock_class_get_frequency(clock_class
);
1123 return bt_common_clock_value_from_ns_from_origin(cc_offset_s
,
1124 cc_offset_cycles
, cc_freq
, ns_from_origin
, raw_value
);
1128 bt_message_iterator_class_next_method_status
1129 end_stream(struct trimmer_iterator
*trimmer_it
,
1130 struct trimmer_iterator_stream_state
*sstate
)
1132 bt_message_iterator_class_next_method_status status
=
1133 BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1134 /* Initialize to silence maybe-uninitialized warning. */
1135 uint64_t raw_value
= 0;
1136 bt_message
*msg
= NULL
;
1138 BT_ASSERT(!trimmer_it
->end
.is_infinite
);
1139 BT_ASSERT(sstate
->stream
);
1142 * If we haven't seen a message with a clock snapshot, we don't know if the trimmer's end bound is within
1143 * the clock's range, so it wouldn't be safe to try to convert ns_from_origin to a clock value.
1145 * Also, it would be a bit of a lie to generate a stream end message with the end bound as its
1146 * clock snapshot, because we don't really know if the stream existed at that time. If we have
1147 * seen a message with a clock snapshot and the stream is cut short by another message with a
1148 * clock snapshot, then we are sure that the the end bound time is not below the clock range,
1149 * and we know the stream was active at that time (and that we cut it short).
1151 if (sstate
->seen_clock_snapshot
) {
1152 const bt_clock_class
*clock_class
;
1155 clock_class
= bt_stream_class_borrow_default_clock_class_const(
1156 bt_stream_borrow_class_const(sstate
->stream
));
1157 BT_ASSERT(clock_class
);
1158 ret
= clock_raw_value_from_ns_from_origin(clock_class
,
1159 trimmer_it
->end
.ns_from_origin
, &raw_value
);
1161 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1166 if (sstate
->cur_packet
) {
1168 * Create and push a packet end message, making its time
1169 * the trimming range's end time.
1171 * We know that we must have seen a clock snapshot, the one in
1172 * the packet beginning message, since trimmer currently
1173 * requires packet messages to have clock snapshots (see comment
1174 * in create_stream_state_entry).
1176 BT_ASSERT(sstate
->seen_clock_snapshot
);
1178 msg
= bt_message_packet_end_create_with_default_clock_snapshot(
1179 trimmer_it
->self_msg_iter
, sstate
->cur_packet
,
1182 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1186 push_message(trimmer_it
, msg
);
1188 BT_PACKET_PUT_REF_AND_RESET(sstate
->cur_packet
);
1191 /* Create and push a stream end message. */
1192 msg
= bt_message_stream_end_create(trimmer_it
->self_msg_iter
,
1195 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1199 if (sstate
->seen_clock_snapshot
) {
1200 bt_message_stream_end_set_default_clock_snapshot(msg
, raw_value
);
1203 push_message(trimmer_it
, msg
);
1207 * Just to make sure that we don't use this stream state again
1208 * in the future without an obvious error.
1210 sstate
->stream
= NULL
;
1213 bt_message_put_ref(msg
);
1218 bt_message_iterator_class_next_method_status
end_iterator_streams(
1219 struct trimmer_iterator
*trimmer_it
)
1221 bt_message_iterator_class_next_method_status status
=
1222 BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1223 GHashTableIter iter
;
1224 gpointer key
, sstate
;
1226 if (trimmer_it
->end
.is_infinite
) {
1228 * An infinite trimming range's end time guarantees that
1229 * we received (and pushed) all the appropriate end
1236 * End each stream and then remove them from the hash table of
1237 * stream states to release unneeded references.
1239 g_hash_table_iter_init(&iter
, trimmer_it
->stream_states
);
1241 while (g_hash_table_iter_next(&iter
, &key
, &sstate
)) {
1242 status
= end_stream(trimmer_it
, sstate
);
1249 g_hash_table_remove_all(trimmer_it
->stream_states
);
1256 bt_message_iterator_class_next_method_status
1257 create_stream_state_entry(
1258 struct trimmer_iterator
*trimmer_it
,
1259 const struct bt_stream
*stream
,
1260 struct trimmer_iterator_stream_state
**stream_state
)
1262 struct trimmer_comp
*trimmer_comp
= trimmer_it
->trimmer_comp
;
1263 bt_message_iterator_class_next_method_status status
;
1264 struct trimmer_iterator_stream_state
*sstate
;
1265 const bt_stream_class
*sc
;
1267 BT_ASSERT(!bt_g_hash_table_contains(trimmer_it
->stream_states
, stream
));
1270 * Validate right now that the stream's class
1271 * has a registered default clock class so that
1272 * an existing stream state guarantees existing
1273 * default clock snapshots for its associated
1276 * Also check that clock snapshots are always
1279 sc
= bt_stream_borrow_class_const(stream
);
1280 if (!bt_stream_class_borrow_default_clock_class_const(sc
)) {
1281 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1282 "Unsupported stream: stream class does "
1283 "not have a default clock class: "
1285 "stream-id=%" PRIu64
", "
1286 "stream-name=\"%s\"",
1287 stream
, bt_stream_get_id(stream
),
1288 bt_stream_get_name(stream
));
1289 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1294 * Temporary: make sure packet beginning, packet
1295 * end, discarded events, and discarded packets
1296 * messages have default clock snapshots until
1297 * the support for not having them is
1300 if (bt_stream_class_supports_packets(sc
)) {
1301 if (!bt_stream_class_packets_have_beginning_default_clock_snapshot(
1303 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1304 "Unsupported stream: packets have no beginning clock snapshot: "
1306 "stream-id=%" PRIu64
", "
1307 "stream-name=\"%s\"",
1308 stream
, bt_stream_get_id(stream
),
1309 bt_stream_get_name(stream
));
1310 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1314 if (!bt_stream_class_packets_have_end_default_clock_snapshot(
1316 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1317 "Unsupported stream: packets have no end clock snapshot: "
1319 "stream-id=%" PRIu64
", "
1320 "stream-name=\"%s\"",
1321 stream
, bt_stream_get_id(stream
),
1322 bt_stream_get_name(stream
));
1323 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1327 if (bt_stream_class_supports_discarded_packets(sc
) &&
1328 !bt_stream_class_discarded_packets_have_default_clock_snapshots(sc
)) {
1329 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1330 "Unsupported stream: discarded packets "
1331 "have no clock snapshots: "
1333 "stream-id=%" PRIu64
", "
1334 "stream-name=\"%s\"",
1335 stream
, bt_stream_get_id(stream
),
1336 bt_stream_get_name(stream
));
1337 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1342 if (bt_stream_class_supports_discarded_events(sc
) &&
1343 !bt_stream_class_discarded_events_have_default_clock_snapshots(sc
)) {
1344 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1345 "Unsupported stream: discarded events have no clock snapshots: "
1347 "stream-id=%" PRIu64
", "
1348 "stream-name=\"%s\"",
1349 stream
, bt_stream_get_id(stream
),
1350 bt_stream_get_name(stream
));
1351 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1355 sstate
= g_new0(struct trimmer_iterator_stream_state
, 1);
1357 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1361 sstate
->stream
= stream
;
1363 g_hash_table_insert(trimmer_it
->stream_states
, (void *) stream
, sstate
);
1365 *stream_state
= sstate
;
1367 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1374 struct trimmer_iterator_stream_state
*get_stream_state_entry(
1375 struct trimmer_iterator
*trimmer_it
,
1376 const struct bt_stream
*stream
)
1378 struct trimmer_iterator_stream_state
*sstate
;
1380 BT_ASSERT_DBG(stream
);
1381 sstate
= g_hash_table_lookup(trimmer_it
->stream_states
, stream
);
1382 BT_ASSERT_DBG(sstate
);
1388 * Handles a message which is associated to a given stream state. This
1389 * _could_ make the iterator's output message queue grow; this could
1390 * also consume the message without pushing anything to this queue, only
1391 * modifying the stream state.
1393 * This function consumes the `msg` reference, _whatever the outcome_.
1395 * If non-NULL, `ns_from_origin` is the message's time, as given by
1396 * get_msg_ns_from_origin(). If NULL, the message doesn't have a time.
1398 * This function sets `reached_end` if handling this message made the
1399 * iterator reach the end of the trimming range. Note that the output
1400 * message queue could contain messages even if this function sets
1404 bt_message_iterator_class_next_method_status
1405 handle_message_with_stream(
1406 struct trimmer_iterator
*trimmer_it
, const bt_message
*msg
,
1407 const struct bt_stream
*stream
, const int64_t *ns_from_origin
,
1410 bt_message_iterator_class_next_method_status status
=
1411 BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1412 bt_message_type msg_type
= bt_message_get_type(msg
);
1414 struct trimmer_iterator_stream_state
*sstate
= NULL
;
1417 * Retrieve the stream's state - except if the message is stream
1418 * beginning, in which case we don't know about about this stream yet.
1420 if (msg_type
!= BT_MESSAGE_TYPE_STREAM_BEGINNING
) {
1421 sstate
= get_stream_state_entry(trimmer_it
, stream
);
1425 case BT_MESSAGE_TYPE_EVENT
:
1427 * Event messages always have a clock snapshot if the stream
1428 * class has a clock class. And we know it has, otherwise we
1429 * couldn't be using the trimmer component.
1431 BT_ASSERT_DBG(ns_from_origin
);
1433 if (G_UNLIKELY(!trimmer_it
->end
.is_infinite
&&
1434 *ns_from_origin
> trimmer_it
->end
.ns_from_origin
)) {
1435 status
= end_iterator_streams(trimmer_it
);
1436 *reached_end
= true;
1440 sstate
->seen_clock_snapshot
= true;
1442 push_message(trimmer_it
, msg
);
1446 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1448 * Packet beginning messages won't have a clock snapshot if
1449 * stream_class->packets_have_beginning_default_clock_snapshot
1450 * is false. But for now, assume they always do.
1452 BT_ASSERT(ns_from_origin
);
1453 BT_ASSERT(!sstate
->cur_packet
);
1455 if (G_UNLIKELY(!trimmer_it
->end
.is_infinite
&&
1456 *ns_from_origin
> trimmer_it
->end
.ns_from_origin
)) {
1457 status
= end_iterator_streams(trimmer_it
);
1458 *reached_end
= true;
1462 sstate
->cur_packet
=
1463 bt_message_packet_beginning_borrow_packet_const(msg
);
1464 bt_packet_get_ref(sstate
->cur_packet
);
1466 sstate
->seen_clock_snapshot
= true;
1468 push_message(trimmer_it
, msg
);
1472 case BT_MESSAGE_TYPE_PACKET_END
:
1474 * Packet end messages won't have a clock snapshot if
1475 * stream_class->packets_have_end_default_clock_snapshot
1476 * is false. But for now, assume they always do.
1478 BT_ASSERT(ns_from_origin
);
1479 BT_ASSERT(sstate
->cur_packet
);
1481 if (G_UNLIKELY(!trimmer_it
->end
.is_infinite
&&
1482 *ns_from_origin
> trimmer_it
->end
.ns_from_origin
)) {
1483 status
= end_iterator_streams(trimmer_it
);
1484 *reached_end
= true;
1488 BT_PACKET_PUT_REF_AND_RESET(sstate
->cur_packet
);
1490 sstate
->seen_clock_snapshot
= true;
1492 push_message(trimmer_it
, msg
);
1496 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1497 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1500 * `ns_from_origin` is the message's time range's
1501 * beginning time here.
1503 int64_t end_ns_from_origin
;
1504 const bt_clock_snapshot
*end_cs
;
1506 BT_ASSERT(ns_from_origin
);
1508 sstate
->seen_clock_snapshot
= true;
1510 if (bt_message_get_type(msg
) ==
1511 BT_MESSAGE_TYPE_DISCARDED_EVENTS
) {
1513 * Safe to ignore the return value because we
1514 * know there's a default clock and it's always
1517 end_cs
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
1521 * Safe to ignore the return value because we
1522 * know there's a default clock and it's always
1525 end_cs
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
1529 if (bt_clock_snapshot_get_ns_from_origin(end_cs
,
1530 &end_ns_from_origin
)) {
1531 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1535 if (!trimmer_it
->end
.is_infinite
&&
1536 *ns_from_origin
> trimmer_it
->end
.ns_from_origin
) {
1537 status
= end_iterator_streams(trimmer_it
);
1538 *reached_end
= true;
1542 if (!trimmer_it
->end
.is_infinite
&&
1543 end_ns_from_origin
> trimmer_it
->end
.ns_from_origin
) {
1545 * This message's end time is outside the
1546 * trimming time range: replace it with a new
1547 * message having an end time equal to the
1548 * trimming time range's end and without a
1551 const bt_clock_class
*clock_class
=
1552 bt_clock_snapshot_borrow_clock_class_const(
1554 const bt_clock_snapshot
*begin_cs
;
1555 bt_message
*new_msg
;
1556 uint64_t end_raw_value
;
1558 ret
= clock_raw_value_from_ns_from_origin(clock_class
,
1559 trimmer_it
->end
.ns_from_origin
, &end_raw_value
);
1561 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1565 if (msg_type
== BT_MESSAGE_TYPE_DISCARDED_EVENTS
) {
1566 begin_cs
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
1568 new_msg
= bt_message_discarded_events_create_with_default_clock_snapshots(
1569 trimmer_it
->self_msg_iter
,
1571 bt_clock_snapshot_get_value(begin_cs
),
1574 begin_cs
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
1576 new_msg
= bt_message_discarded_packets_create_with_default_clock_snapshots(
1577 trimmer_it
->self_msg_iter
,
1579 bt_clock_snapshot_get_value(begin_cs
),
1584 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1588 /* Replace the original message */
1589 BT_MESSAGE_MOVE_REF(msg
, new_msg
);
1592 push_message(trimmer_it
, msg
);
1597 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1599 * If this message has a time and this time is greater than the
1600 * trimmer's end bound, it triggers the end of the trim window.
1602 if (G_UNLIKELY(ns_from_origin
&& !trimmer_it
->end
.is_infinite
&&
1603 *ns_from_origin
> trimmer_it
->end
.ns_from_origin
)) {
1604 status
= end_iterator_streams(trimmer_it
);
1605 *reached_end
= true;
1609 /* Learn about this stream. */
1610 status
= create_stream_state_entry(trimmer_it
, stream
, &sstate
);
1611 if (status
!= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
1615 if (ns_from_origin
) {
1616 sstate
->seen_clock_snapshot
= true;
1619 push_message(trimmer_it
, msg
);
1622 case BT_MESSAGE_TYPE_STREAM_END
:
1627 * If this message has a time and this time is greater than the
1628 * trimmer's end bound, it triggers the end of the trim window.
1630 if (G_UNLIKELY(ns_from_origin
&& !trimmer_it
->end
.is_infinite
&&
1631 *ns_from_origin
> trimmer_it
->end
.ns_from_origin
)) {
1632 status
= end_iterator_streams(trimmer_it
);
1633 *reached_end
= true;
1638 * Either the stream end message's time is within the trimmer's
1639 * bounds, or it doesn't have a time. In both cases, pass
1640 * the message unmodified.
1642 push_message(trimmer_it
, msg
);
1645 /* Forget about this stream. */
1646 removed
= g_hash_table_remove(trimmer_it
->stream_states
, sstate
->stream
);
1655 /* We release the message's reference whatever the outcome */
1656 bt_message_put_ref(msg
);
1661 * Handles an input message. This _could_ make the iterator's output
1662 * message queue grow; this could also consume the message without
1663 * pushing anything to this queue, only modifying the stream state.
1665 * This function consumes the `msg` reference, _whatever the outcome_.
1667 * This function sets `reached_end` if handling this message made the
1668 * iterator reach the end of the trimming range. Note that the output
1669 * message queue could contain messages even if this function sets
1673 bt_message_iterator_class_next_method_status
handle_message(
1674 struct trimmer_iterator
*trimmer_it
, const bt_message
*msg
,
1677 bt_message_iterator_class_next_method_status status
;
1678 const bt_stream
*stream
= NULL
;
1679 int64_t ns_from_origin
= INT64_MIN
;
1680 bool has_ns_from_origin
= false;
1683 /* Find message's associated stream */
1684 switch (bt_message_get_type(msg
)) {
1685 case BT_MESSAGE_TYPE_EVENT
:
1686 stream
= bt_event_borrow_stream_const(
1687 bt_message_event_borrow_event_const(msg
));
1689 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1690 stream
= bt_packet_borrow_stream_const(
1691 bt_message_packet_beginning_borrow_packet_const(msg
));
1693 case BT_MESSAGE_TYPE_PACKET_END
:
1694 stream
= bt_packet_borrow_stream_const(
1695 bt_message_packet_end_borrow_packet_const(msg
));
1697 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1698 stream
= bt_message_discarded_events_borrow_stream_const(msg
);
1700 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1701 stream
= bt_message_discarded_packets_borrow_stream_const(msg
);
1703 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1704 stream
= bt_message_stream_beginning_borrow_stream_const(msg
);
1706 case BT_MESSAGE_TYPE_STREAM_END
:
1707 stream
= bt_message_stream_end_borrow_stream_const(msg
);
1713 /* Retrieve the message's time */
1714 ret
= get_msg_ns_from_origin(msg
, &ns_from_origin
, &has_ns_from_origin
);
1715 if (G_UNLIKELY(ret
)) {
1716 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
1720 if (G_LIKELY(stream
)) {
1721 /* Message associated to a stream */
1722 status
= handle_message_with_stream(trimmer_it
, msg
,
1723 stream
, has_ns_from_origin
? &ns_from_origin
: NULL
, reached_end
);
1726 * handle_message_with_stream_state() unconditionally
1732 * Message not associated to a stream (message iterator
1735 if (G_UNLIKELY(ns_from_origin
> trimmer_it
->end
.ns_from_origin
)) {
1736 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
1737 status
= end_iterator_streams(trimmer_it
);
1738 *reached_end
= true;
1740 push_message(trimmer_it
, msg
);
1741 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1747 /* We release the message's reference whatever the outcome */
1748 bt_message_put_ref(msg
);
1753 void fill_message_array_from_output_messages(
1754 struct trimmer_iterator
*trimmer_it
,
1755 bt_message_array_const msgs
, uint64_t capacity
, uint64_t *count
)
1760 * Move auto-seek messages to the output array (which is this
1761 * iterator's base message array).
1763 while (capacity
> 0 && !g_queue_is_empty(trimmer_it
->output_messages
)) {
1764 msgs
[*count
] = pop_message(trimmer_it
);
1769 BT_ASSERT_DBG(*count
> 0);
1773 bt_message_iterator_class_next_method_status
state_ending(
1774 struct trimmer_iterator
*trimmer_it
,
1775 bt_message_array_const msgs
, uint64_t capacity
,
1778 bt_message_iterator_class_next_method_status status
=
1779 BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1781 if (g_queue_is_empty(trimmer_it
->output_messages
)) {
1782 trimmer_it
->state
= TRIMMER_ITERATOR_STATE_ENDED
;
1783 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1787 fill_message_array_from_output_messages(trimmer_it
, msgs
,
1795 bt_message_iterator_class_next_method_status
1796 state_trim(struct trimmer_iterator
*trimmer_it
,
1797 bt_message_array_const msgs
, uint64_t capacity
,
1800 bt_message_iterator_class_next_method_status status
=
1801 BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1802 bt_message_array_const my_msgs
;
1805 bool reached_end
= false;
1807 while (g_queue_is_empty(trimmer_it
->output_messages
)) {
1808 status
= (int) bt_message_iterator_next(
1809 trimmer_it
->upstream_iter
, &my_msgs
, &my_count
);
1810 if (G_UNLIKELY(status
!= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
)) {
1811 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
) {
1812 status
= end_iterator_streams(trimmer_it
);
1813 if (status
!= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
1818 TRIMMER_ITERATOR_STATE_ENDING
;
1819 status
= state_ending(trimmer_it
, msgs
,
1826 BT_ASSERT_DBG(my_count
> 0);
1828 for (i
= 0; i
< my_count
; i
++) {
1829 status
= handle_message(trimmer_it
, my_msgs
[i
],
1833 * handle_message() unconditionally consumes the
1834 * message reference.
1838 if (G_UNLIKELY(status
!=
1839 BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
)) {
1840 put_messages(my_msgs
, my_count
);
1844 if (G_UNLIKELY(reached_end
)) {
1846 * This message's time was passed the
1847 * trimming time range's end time: we
1848 * are done. Their might still be
1849 * messages in the output message queue,
1850 * so move to the "ending" state and
1851 * apply it immediately since
1852 * state_trim() is called within the
1855 put_messages(my_msgs
, my_count
);
1857 TRIMMER_ITERATOR_STATE_ENDING
;
1858 status
= state_ending(trimmer_it
, msgs
,
1866 * There's at least one message in the output message queue:
1867 * move the messages to the output message array.
1869 BT_ASSERT_DBG(!g_queue_is_empty(trimmer_it
->output_messages
));
1870 fill_message_array_from_output_messages(trimmer_it
, msgs
,
1877 bt_message_iterator_class_next_method_status
trimmer_msg_iter_next(
1878 bt_self_message_iterator
*self_msg_iter
,
1879 bt_message_array_const msgs
, uint64_t capacity
,
1882 struct trimmer_iterator
*trimmer_it
=
1883 bt_self_message_iterator_get_data(self_msg_iter
);
1884 bt_message_iterator_class_next_method_status status
=
1885 BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
1887 BT_ASSERT_DBG(trimmer_it
);
1889 if (G_LIKELY(trimmer_it
->state
== TRIMMER_ITERATOR_STATE_TRIM
)) {
1890 status
= state_trim(trimmer_it
, msgs
, capacity
, count
);
1891 if (status
!= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
1895 switch (trimmer_it
->state
) {
1896 case TRIMMER_ITERATOR_STATE_SET_BOUNDS_NS_FROM_ORIGIN
:
1897 status
= state_set_trimmer_iterator_bounds(trimmer_it
);
1898 if (status
!= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
1902 status
= state_seek_initially(trimmer_it
);
1903 if (status
!= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
1907 status
= state_trim(trimmer_it
, msgs
, capacity
, count
);
1908 if (status
!= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
1913 case TRIMMER_ITERATOR_STATE_SEEK_INITIALLY
:
1914 status
= state_seek_initially(trimmer_it
);
1915 if (status
!= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
1919 status
= state_trim(trimmer_it
, msgs
, capacity
, count
);
1920 if (status
!= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
1925 case TRIMMER_ITERATOR_STATE_ENDING
:
1926 status
= state_ending(trimmer_it
, msgs
, capacity
,
1928 if (status
!= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
1933 case TRIMMER_ITERATOR_STATE_ENDED
:
1934 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
1945 void trimmer_msg_iter_finalize(bt_self_message_iterator
*self_msg_iter
)
1947 struct trimmer_iterator
*trimmer_it
=
1948 bt_self_message_iterator_get_data(self_msg_iter
);
1950 BT_ASSERT(trimmer_it
);
1951 destroy_trimmer_iterator(trimmer_it
);