2 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 #define BT_LOG_OUTPUT_LEVEL (trimmer_comp->log_level)
25 #define BT_LOG_TAG "PLUGIN/FLT.UTILS.TRIMMER"
26 #include "logging/comp-logging.h"
28 #include "compat/utc.h"
29 #include "compat/time.h"
30 #include <babeltrace2/babeltrace.h>
31 #include "common/common.h"
32 #include "common/assert.h"
36 #include "compat/glib.h"
40 #define NS_PER_S INT64_C(1000000000)
42 static const char * const in_port_name
= "in";
45 unsigned int hour
, minute
, second
, ns
;
48 struct trimmer_bound
{
50 * Nanoseconds from origin, valid if `is_set` is set and
51 * `is_infinite` is false.
53 int64_t ns_from_origin
;
55 /* True if this bound's full time (`ns_from_origin`) is set */
59 * True if this bound represents the infinity (negative or
60 * positive depending on which bound it is). If this is true,
61 * then we don't care about `ns_from_origin` above.
66 * This bound's time without the date; this time is used to set
67 * `ns_from_origin` once we know the date.
69 struct trimmer_time time
;
73 struct trimmer_bound begin
, end
;
75 bt_logging_level log_level
;
76 bt_self_component
*self_comp
;
79 enum trimmer_iterator_state
{
81 * Find the first message's date and set the bounds's times
84 TRIMMER_ITERATOR_STATE_SET_BOUNDS_NS_FROM_ORIGIN
,
87 * Initially seek to the trimming range's beginning time.
89 TRIMMER_ITERATOR_STATE_SEEK_INITIALLY
,
92 * Fill the output message queue for as long as received input
93 * messages are within the trimming time range.
95 TRIMMER_ITERATOR_STATE_TRIM
,
97 /* Flush the remaining messages in the output message queue */
98 TRIMMER_ITERATOR_STATE_ENDING
,
100 /* Trimming operation and message iterator is ended */
101 TRIMMER_ITERATOR_STATE_ENDED
,
104 struct trimmer_iterator
{
106 struct trimmer_comp
*trimmer_comp
;
109 bt_self_message_iterator
*self_msg_iter
;
111 enum trimmer_iterator_state state
;
114 bt_self_component_port_input_message_iterator
*upstream_iter
;
115 struct trimmer_bound begin
, end
;
118 * Queue of `const bt_message *` (owned by the queue).
120 * This is where the trimming operation pushes the messages to
121 * output by this message iterator.
123 GQueue
*output_messages
;
126 * Hash table of `bt_stream *` (weak) to
127 * `struct trimmer_iterator_stream_state *` (owned by the HT).
129 GHashTable
*stream_states
;
132 struct trimmer_iterator_stream_state
{
134 const bt_stream
*stream
;
136 /* Have we seen a message with clock_snapshot going through this stream? */
137 bool seen_clock_snapshot
;
139 /* Owned by this (`NULL` initially and between packets) */
140 const bt_packet
*cur_packet
;
144 void destroy_trimmer_comp(struct trimmer_comp
*trimmer_comp
)
146 BT_ASSERT(trimmer_comp
);
147 g_free(trimmer_comp
);
151 struct trimmer_comp
*create_trimmer_comp(void)
153 return g_new0(struct trimmer_comp
, 1);
157 void trimmer_finalize(bt_self_component_filter
*self_comp
)
159 struct trimmer_comp
*trimmer_comp
=
160 bt_self_component_get_data(
161 bt_self_component_filter_as_self_component(self_comp
));
164 destroy_trimmer_comp(trimmer_comp
);
169 * Compile regex in `pattern`, and try to match `string`. If there's a match,
170 * return true and set `*match_info` to the list of matches. The list of
171 * matches must be freed by the caller. If there's no match, return false and
172 * set `*match_info` to NULL;
175 bool compile_and_match(const char *pattern
, const char *string
, GMatchInfo
**match_info
) {
176 bool matches
= false;
177 GError
*regex_error
= NULL
;
180 regex
= g_regex_new(pattern
, 0, 0, ®ex_error
);
185 matches
= g_regex_match(regex
, string
, 0, match_info
);
188 * g_regex_match allocates `*match_info` even if it returns
189 * FALSE. If there's no match, we have no use for it, so free
190 * it immediatly and don't return it to the caller.
192 g_match_info_free(*match_info
);
196 g_regex_unref(regex
);
201 g_error_free(regex_error
);
208 * Convert the captured text in match number `match_num` in `match_info`
209 * to an unsigned integer.
212 guint64
match_to_uint(const GMatchInfo
*match_info
, gint match_num
) {
213 gchar
*text
, *endptr
;
216 text
= g_match_info_fetch(match_info
, match_num
);
220 * Because the input is carefully sanitized with regexes by the caller,
221 * we assume that g_ascii_strtoull cannot fail.
224 result
= g_ascii_strtoull(text
, &endptr
, 10);
225 BT_ASSERT(endptr
> text
);
226 BT_ASSERT(errno
== 0);
234 * When parsing the nanoseconds part, .512 means .512000000, not .000000512.
235 * This function is like match_to_uint, but multiplies the parsed number to get
236 * the expected result.
239 guint64
match_to_uint_ns(const GMatchInfo
*match_info
, gint match_num
) {
242 gint start_pos
, end_pos
, power
;
243 static int pow10
[] = {
244 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000, 100000000,
247 nanoseconds
= match_to_uint(match_info
, match_num
);
249 /* Multiply by 10 as many times as there are omitted digits. */
250 ret
= g_match_info_fetch_pos(match_info
, match_num
, &start_pos
, &end_pos
);
253 power
= 9 - (end_pos
- start_pos
);
254 BT_ASSERT(power
>= 0 && power
<= 8);
256 nanoseconds
*= pow10
[power
];
262 * Sets the time (in ns from origin) of a trimmer bound from date and
265 * Returns a negative value if anything goes wrong.
268 int set_bound_ns_from_origin(struct trimmer_bound
*bound
,
269 unsigned int year
, unsigned int month
, unsigned int day
,
270 unsigned int hour
, unsigned int minute
, unsigned int second
,
271 unsigned int ns
, bool is_gmt
)
281 .tm_year
= year
- 1900,
286 result
= bt_timegm(&tm
);
288 result
= mktime(&tm
);
297 bound
->ns_from_origin
= (int64_t) result
;
298 bound
->ns_from_origin
*= NS_PER_S
;
299 bound
->ns_from_origin
+= ns
;
300 bound
->is_set
= true;
307 * Parses a timestamp, figuring out its format.
309 * Returns a negative value if anything goes wrong.
313 * YYYY-MM-DD hh:mm[:ss[.ns]]
317 * TODO: Check overflows.
320 int set_bound_from_str(struct trimmer_comp
*trimmer_comp
,
321 const char *str
, struct trimmer_bound
*bound
, bool is_gmt
)
323 /* Matches YYYY-MM-DD */
324 #define DATE_RE "([0-9]{4})-([0-9]{2})-([0-9]{2})"
326 /* Matches HH:MM[:SS[.NS]] */
327 #define TIME_RE "([0-9]{2}):([0-9]{2})(?::([0-9]{2})(?:\\.([0-9]{1,9}))?)?"
329 /* Matches [-]SS[.NS] */
330 #define S_NS_RE "^(-?)([0-9]+)(?:\\.([0-9]{1,9}))?$"
332 GMatchInfo
*match_info
;
335 /* Try `YYYY-MM-DD hh:mm[:ss[.ns]]` format */
336 if (compile_and_match("^" DATE_RE
" " TIME_RE
"$", str
, &match_info
)) {
337 unsigned int year
= 0, month
= 0, day
= 0, hours
= 0, minutes
= 0, seconds
= 0, nanoseconds
= 0;
338 gint match_count
= g_match_info_get_match_count(match_info
);
340 BT_ASSERT(match_count
>= 6 && match_count
<= 8);
342 year
= match_to_uint(match_info
, 1);
343 month
= match_to_uint(match_info
, 2);
344 day
= match_to_uint(match_info
, 3);
345 hours
= match_to_uint(match_info
, 4);
346 minutes
= match_to_uint(match_info
, 5);
348 if (match_count
>= 7) {
349 seconds
= match_to_uint(match_info
, 6);
352 if (match_count
>= 8) {
353 nanoseconds
= match_to_uint_ns(match_info
, 7);
356 set_bound_ns_from_origin(bound
, year
, month
, day
, hours
, minutes
, seconds
, nanoseconds
, is_gmt
);
361 if (compile_and_match("^" DATE_RE
"$", str
, &match_info
)) {
362 unsigned int year
= 0, month
= 0, day
= 0;
364 BT_ASSERT(g_match_info_get_match_count(match_info
) == 4);
366 year
= match_to_uint(match_info
, 1);
367 month
= match_to_uint(match_info
, 2);
368 day
= match_to_uint(match_info
, 3);
370 set_bound_ns_from_origin(bound
, year
, month
, day
, 0, 0, 0, 0, is_gmt
);
375 /* Try `hh:mm[:ss[.ns]]` format */
376 if (compile_and_match("^" TIME_RE
"$", str
, &match_info
)) {
377 gint match_count
= g_match_info_get_match_count(match_info
);
378 BT_ASSERT(match_count
>= 3 && match_count
<= 5);
379 bound
->time
.hour
= match_to_uint(match_info
, 1);
380 bound
->time
.minute
= match_to_uint(match_info
, 2);
382 if (match_count
>= 4) {
383 bound
->time
.second
= match_to_uint(match_info
, 3);
386 if (match_count
>= 5) {
387 bound
->time
.ns
= match_to_uint_ns(match_info
, 4);
393 /* Try `[-]s[.ns]` format */
394 if (compile_and_match("^" S_NS_RE
"$", str
, &match_info
)) {
395 gboolean is_neg
, fetch_pos_ret
;
396 gint start_pos
, end_pos
, match_count
;
397 guint64 seconds
, nanoseconds
= 0;
399 match_count
= g_match_info_get_match_count(match_info
);
400 BT_ASSERT(match_count
>= 3 && match_count
<= 4);
402 /* Check for presence of negation sign. */
403 fetch_pos_ret
= g_match_info_fetch_pos(match_info
, 1, &start_pos
, &end_pos
);
404 BT_ASSERT(fetch_pos_ret
);
405 is_neg
= (end_pos
- start_pos
) > 0;
407 seconds
= match_to_uint(match_info
, 2);
409 if (match_count
>= 4) {
410 nanoseconds
= match_to_uint_ns(match_info
, 3);
413 bound
->ns_from_origin
= seconds
* NS_PER_S
+ nanoseconds
;
416 bound
->ns_from_origin
= -bound
->ns_from_origin
;
419 bound
->is_set
= true;
424 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
425 "Invalid date/time format: param=\"%s\"", str
);
433 * Sets a trimmer bound's properties from a parameter string/integer
436 * Returns a negative value if anything goes wrong.
439 int set_bound_from_param(struct trimmer_comp
*trimmer_comp
,
440 const char *param_name
, const bt_value
*param
,
441 struct trimmer_bound
*bound
, bool is_gmt
)
447 if (bt_value_is_signed_integer(param
)) {
448 int64_t value
= bt_value_integer_signed_get(param
);
451 * Just convert it to a temporary string to handle
452 * everything the same way.
454 sprintf(tmp_arg
, "%" PRId64
, value
);
456 } else if (bt_value_is_string(param
)) {
457 arg
= bt_value_string_get(param
);
459 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
460 "`%s` parameter must be an integer or a string value.",
466 ret
= set_bound_from_str(trimmer_comp
, arg
, bound
, is_gmt
);
473 int validate_trimmer_bounds(struct trimmer_comp
*trimmer_comp
,
474 struct trimmer_bound
*begin
, struct trimmer_bound
*end
)
478 BT_ASSERT(begin
->is_set
);
479 BT_ASSERT(end
->is_set
);
481 if (!begin
->is_infinite
&& !end
->is_infinite
&&
482 begin
->ns_from_origin
> end
->ns_from_origin
) {
483 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
484 "Trimming time range's beginning time is greater than end time: "
485 "begin-ns-from-origin=%" PRId64
", "
486 "end-ns-from-origin=%" PRId64
,
487 begin
->ns_from_origin
,
488 end
->ns_from_origin
);
493 if (!begin
->is_infinite
&& begin
->ns_from_origin
== INT64_MIN
) {
494 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
495 "Invalid trimming time range's beginning time: "
496 "ns-from-origin=%" PRId64
,
497 begin
->ns_from_origin
);
502 if (!end
->is_infinite
&& end
->ns_from_origin
== INT64_MIN
) {
503 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
504 "Invalid trimming time range's end time: "
505 "ns-from-origin=%" PRId64
,
506 end
->ns_from_origin
);
516 int init_trimmer_comp_from_params(struct trimmer_comp
*trimmer_comp
,
517 const bt_value
*params
)
519 const bt_value
*value
;
523 value
= bt_value_map_borrow_entry_value_const(params
, "gmt");
525 trimmer_comp
->is_gmt
= (bool) bt_value_bool_get(value
);
528 value
= bt_value_map_borrow_entry_value_const(params
, "begin");
530 if (set_bound_from_param(trimmer_comp
, "begin", value
,
531 &trimmer_comp
->begin
, trimmer_comp
->is_gmt
)) {
532 /* set_bound_from_param() logs errors */
537 trimmer_comp
->begin
.is_infinite
= true;
538 trimmer_comp
->begin
.is_set
= true;
541 value
= bt_value_map_borrow_entry_value_const(params
, "end");
543 if (set_bound_from_param(trimmer_comp
, "end", value
,
544 &trimmer_comp
->end
, trimmer_comp
->is_gmt
)) {
545 /* set_bound_from_param() logs errors */
550 trimmer_comp
->end
.is_infinite
= true;
551 trimmer_comp
->end
.is_set
= true;
555 if (trimmer_comp
->begin
.is_set
&& trimmer_comp
->end
.is_set
) {
556 /* validate_trimmer_bounds() logs errors */
557 ret
= validate_trimmer_bounds(trimmer_comp
,
558 &trimmer_comp
->begin
, &trimmer_comp
->end
);
564 bt_component_class_init_method_status
trimmer_init(
565 bt_self_component_filter
*self_comp_flt
,
566 const bt_value
*params
, void *init_data
)
569 bt_component_class_init_method_status status
=
570 BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK
;
571 bt_self_component_add_port_status add_port_status
;
572 struct trimmer_comp
*trimmer_comp
= create_trimmer_comp();
573 bt_self_component
*self_comp
=
574 bt_self_component_filter_as_self_component(self_comp_flt
);
576 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR
;
580 trimmer_comp
->log_level
= bt_component_get_logging_level(
581 bt_self_component_as_component(self_comp
));
582 trimmer_comp
->self_comp
= self_comp
;
583 add_port_status
= bt_self_component_filter_add_input_port(
584 self_comp_flt
, in_port_name
, NULL
, NULL
);
585 switch (add_port_status
) {
586 case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR
:
587 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR
;
589 case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR
:
590 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR
;
596 add_port_status
= bt_self_component_filter_add_output_port(
597 self_comp_flt
, "out", NULL
, NULL
);
598 switch (add_port_status
) {
599 case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR
:
600 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR
;
602 case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR
:
603 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR
;
609 ret
= init_trimmer_comp_from_params(trimmer_comp
, params
);
611 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR
;
615 bt_self_component_set_data(self_comp
, trimmer_comp
);
619 if (status
== BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK
) {
620 status
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR
;
624 destroy_trimmer_comp(trimmer_comp
);
632 void destroy_trimmer_iterator(struct trimmer_iterator
*trimmer_it
)
638 bt_self_component_port_input_message_iterator_put_ref(
639 trimmer_it
->upstream_iter
);
641 if (trimmer_it
->output_messages
) {
642 g_queue_free(trimmer_it
->output_messages
);
645 if (trimmer_it
->stream_states
) {
646 g_hash_table_destroy(trimmer_it
->stream_states
);
655 void destroy_trimmer_iterator_stream_state(
656 struct trimmer_iterator_stream_state
*sstate
)
659 BT_PACKET_PUT_REF_AND_RESET(sstate
->cur_packet
);
664 bt_component_class_message_iterator_init_method_status
trimmer_msg_iter_init(
665 bt_self_message_iterator
*self_msg_iter
,
666 bt_self_component_filter
*self_comp
,
667 bt_self_component_port_output
*port
)
669 bt_component_class_message_iterator_init_method_status status
;
670 bt_self_component_port_input_message_iterator_create_from_message_iterator_status
672 struct trimmer_iterator
*trimmer_it
;
674 trimmer_it
= g_new0(struct trimmer_iterator
, 1);
676 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR
;
680 trimmer_it
->trimmer_comp
= bt_self_component_get_data(
681 bt_self_component_filter_as_self_component(self_comp
));
682 BT_ASSERT(trimmer_it
->trimmer_comp
);
684 if (trimmer_it
->trimmer_comp
->begin
.is_set
&&
685 trimmer_it
->trimmer_comp
->end
.is_set
) {
687 * Both trimming time range's bounds are set, so skip
689 * `TRIMMER_ITERATOR_STATE_SET_BOUNDS_NS_FROM_ORIGIN`
692 trimmer_it
->state
= TRIMMER_ITERATOR_STATE_SEEK_INITIALLY
;
695 trimmer_it
->begin
= trimmer_it
->trimmer_comp
->begin
;
696 trimmer_it
->end
= trimmer_it
->trimmer_comp
->end
;
698 bt_self_component_port_input_message_iterator_create_from_message_iterator(
700 bt_self_component_filter_borrow_input_port_by_name(
701 self_comp
, in_port_name
), &trimmer_it
->upstream_iter
);
702 if (msg_iter_status
!= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK
) {
703 status
= (int) msg_iter_status
;
707 trimmer_it
->output_messages
= g_queue_new();
708 if (!trimmer_it
->output_messages
) {
709 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR
;
713 trimmer_it
->stream_states
= g_hash_table_new_full(g_direct_hash
,
714 g_direct_equal
, NULL
,
715 (GDestroyNotify
) destroy_trimmer_iterator_stream_state
);
716 if (!trimmer_it
->stream_states
) {
717 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR
;
721 trimmer_it
->self_msg_iter
= self_msg_iter
;
722 bt_self_message_iterator_set_data(self_msg_iter
, trimmer_it
);
724 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK
;
728 destroy_trimmer_iterator(trimmer_it
);
735 int get_msg_ns_from_origin(const bt_message
*msg
, int64_t *ns_from_origin
,
736 bool *has_clock_snapshot
)
738 const bt_clock_class
*clock_class
= NULL
;
739 const bt_clock_snapshot
*clock_snapshot
= NULL
;
743 BT_ASSERT(ns_from_origin
);
744 BT_ASSERT(has_clock_snapshot
);
746 switch (bt_message_get_type(msg
)) {
747 case BT_MESSAGE_TYPE_EVENT
:
749 bt_message_event_borrow_stream_class_default_clock_class_const(
751 if (G_UNLIKELY(!clock_class
)) {
755 clock_snapshot
= bt_message_event_borrow_default_clock_snapshot_const(
758 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
760 bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
762 if (G_UNLIKELY(!clock_class
)) {
766 clock_snapshot
= bt_message_packet_beginning_borrow_default_clock_snapshot_const(
769 case BT_MESSAGE_TYPE_PACKET_END
:
771 bt_message_packet_end_borrow_stream_class_default_clock_class_const(
773 if (G_UNLIKELY(!clock_class
)) {
777 clock_snapshot
= bt_message_packet_end_borrow_default_clock_snapshot_const(
780 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
782 enum bt_message_stream_clock_snapshot_state cs_state
;
785 bt_message_stream_beginning_borrow_stream_class_default_clock_class_const(msg
);
786 if (G_UNLIKELY(!clock_class
)) {
790 cs_state
= bt_message_stream_beginning_borrow_default_clock_snapshot_const(msg
, &clock_snapshot
);
791 if (cs_state
!= BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
) {
792 goto no_clock_snapshot
;
797 case BT_MESSAGE_TYPE_STREAM_END
:
799 enum bt_message_stream_clock_snapshot_state cs_state
;
802 bt_message_stream_end_borrow_stream_class_default_clock_class_const(msg
);
803 if (G_UNLIKELY(!clock_class
)) {
807 cs_state
= bt_message_stream_end_borrow_default_clock_snapshot_const(msg
, &clock_snapshot
);
808 if (cs_state
!= BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
) {
809 goto no_clock_snapshot
;
814 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
816 bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
818 if (G_UNLIKELY(!clock_class
)) {
822 clock_snapshot
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
825 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
827 bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
829 if (G_UNLIKELY(!clock_class
)) {
833 clock_snapshot
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
836 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
838 bt_message_message_iterator_inactivity_borrow_default_clock_snapshot_const(
842 goto no_clock_snapshot
;
845 ret
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
,
847 if (G_UNLIKELY(ret
)) {
851 *has_clock_snapshot
= true;
855 *has_clock_snapshot
= false;
866 void put_messages(bt_message_array_const msgs
, uint64_t count
)
870 for (i
= 0; i
< count
; i
++) {
871 BT_MESSAGE_PUT_REF_AND_RESET(msgs
[i
]);
876 int set_trimmer_iterator_bound(struct trimmer_iterator
*trimmer_it
,
877 struct trimmer_bound
*bound
, int64_t ns_from_origin
,
880 struct trimmer_comp
*trimmer_comp
= trimmer_it
->trimmer_comp
;
883 time_t time_seconds
= (time_t) (ns_from_origin
/ NS_PER_S
);
886 BT_ASSERT(!bound
->is_set
);
889 /* We only need to extract the date from this time */
891 res
= bt_gmtime_r(&time_seconds
, &tm
);
893 res
= bt_localtime_r(&time_seconds
, &tm
);
897 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(trimmer_comp
->self_comp
,
898 "Cannot convert timestamp to date and time",
899 ": ts=%" PRId64
, (int64_t) time_seconds
);
904 ret
= set_bound_ns_from_origin(bound
, tm
.tm_year
+ 1900, tm
.tm_mon
+ 1,
905 tm
.tm_mday
, bound
->time
.hour
, bound
->time
.minute
,
906 bound
->time
.second
, bound
->time
.ns
, is_gmt
);
913 bt_component_class_message_iterator_next_method_status
914 state_set_trimmer_iterator_bounds(
915 struct trimmer_iterator
*trimmer_it
)
917 bt_message_iterator_next_status upstream_iter_status
=
918 BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
;
919 struct trimmer_comp
*trimmer_comp
= trimmer_it
->trimmer_comp
;
920 bt_message_array_const msgs
;
922 int64_t ns_from_origin
= INT64_MIN
;
926 BT_ASSERT(!trimmer_it
->begin
.is_set
||
927 !trimmer_it
->end
.is_set
);
930 upstream_iter_status
=
931 bt_self_component_port_input_message_iterator_next(
932 trimmer_it
->upstream_iter
, &msgs
, &count
);
933 if (upstream_iter_status
!= BT_MESSAGE_ITERATOR_NEXT_STATUS_OK
) {
937 for (i
= 0; i
< count
; i
++) {
938 const bt_message
*msg
= msgs
[i
];
939 bool has_ns_from_origin
;
942 ret
= get_msg_ns_from_origin(msg
, &ns_from_origin
,
943 &has_ns_from_origin
);
948 if (!has_ns_from_origin
) {
952 BT_ASSERT(ns_from_origin
!= INT64_MIN
&&
953 ns_from_origin
!= INT64_MAX
);
954 put_messages(msgs
, count
);
958 put_messages(msgs
, count
);
962 if (!trimmer_it
->begin
.is_set
) {
963 BT_ASSERT(!trimmer_it
->begin
.is_infinite
);
964 ret
= set_trimmer_iterator_bound(trimmer_it
, &trimmer_it
->begin
,
965 ns_from_origin
, trimmer_comp
->is_gmt
);
971 if (!trimmer_it
->end
.is_set
) {
972 BT_ASSERT(!trimmer_it
->end
.is_infinite
);
973 ret
= set_trimmer_iterator_bound(trimmer_it
, &trimmer_it
->end
,
974 ns_from_origin
, trimmer_comp
->is_gmt
);
980 ret
= validate_trimmer_bounds(trimmer_it
->trimmer_comp
,
981 &trimmer_it
->begin
, &trimmer_it
->end
);
989 put_messages(msgs
, count
);
990 upstream_iter_status
= BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR
;
993 return (int) upstream_iter_status
;
997 bt_component_class_message_iterator_next_method_status
state_seek_initially(
998 struct trimmer_iterator
*trimmer_it
)
1000 struct trimmer_comp
*trimmer_comp
= trimmer_it
->trimmer_comp
;
1001 bt_component_class_message_iterator_next_method_status status
;
1003 BT_ASSERT(trimmer_it
->begin
.is_set
);
1005 if (trimmer_it
->begin
.is_infinite
) {
1008 status
= (int) bt_self_component_port_input_message_iterator_can_seek_beginning(
1009 trimmer_it
->upstream_iter
, &can_seek
);
1010 if (status
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
1012 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1013 "Cannot make upstream message iterator initially seek its beginning.");
1020 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1021 "Cannot make upstream message iterator initially seek its beginning.");
1022 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1026 status
= (int) bt_self_component_port_input_message_iterator_seek_beginning(
1027 trimmer_it
->upstream_iter
);
1031 status
= (int) bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1032 trimmer_it
->upstream_iter
, trimmer_it
->begin
.ns_from_origin
,
1035 if (status
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
1037 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1038 "Cannot make upstream message iterator initially seek: seek-ns-from-origin=%" PRId64
,
1039 trimmer_it
->begin
.ns_from_origin
);
1046 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1047 "Cannot make upstream message iterator initially seek: seek-ns-from-origin=%" PRId64
,
1048 trimmer_it
->begin
.ns_from_origin
);
1049 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1053 status
= (int) bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1054 trimmer_it
->upstream_iter
, trimmer_it
->begin
.ns_from_origin
);
1057 if (status
== BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
1058 trimmer_it
->state
= TRIMMER_ITERATOR_STATE_TRIM
;
1066 void push_message(struct trimmer_iterator
*trimmer_it
, const bt_message
*msg
)
1068 g_queue_push_head(trimmer_it
->output_messages
, (void *) msg
);
1072 const bt_message
*pop_message(struct trimmer_iterator
*trimmer_it
)
1074 return g_queue_pop_tail(trimmer_it
->output_messages
);
1078 int clock_raw_value_from_ns_from_origin(const bt_clock_class
*clock_class
,
1079 int64_t ns_from_origin
, uint64_t *raw_value
)
1082 int64_t cc_offset_s
;
1083 uint64_t cc_offset_cycles
;
1086 bt_clock_class_get_offset(clock_class
, &cc_offset_s
, &cc_offset_cycles
);
1087 cc_freq
= bt_clock_class_get_frequency(clock_class
);
1088 return bt_common_clock_value_from_ns_from_origin(cc_offset_s
,
1089 cc_offset_cycles
, cc_freq
, ns_from_origin
, raw_value
);
1093 bt_component_class_message_iterator_next_method_status
1094 end_stream(struct trimmer_iterator
*trimmer_it
,
1095 struct trimmer_iterator_stream_state
*sstate
)
1097 bt_component_class_message_iterator_next_method_status status
=
1098 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1099 /* Initialize to silence maybe-uninitialized warning. */
1100 uint64_t raw_value
= 0;
1101 bt_message
*msg
= NULL
;
1103 BT_ASSERT(!trimmer_it
->end
.is_infinite
);
1104 BT_ASSERT(sstate
->stream
);
1107 * If we haven't seen a message with a clock snapshot, we don't know if the trimmer's end bound is within
1108 * the clock's range, so it wouldn't be safe to try to convert ns_from_origin to a clock value.
1110 * Also, it would be a bit of a lie to generate a stream end message with the end bound as its
1111 * clock snapshot, because we don't really know if the stream existed at that time. If we have
1112 * seen a message with a clock snapshot and the stream is cut short by another message with a
1113 * clock snapshot, then we are sure that the the end bound time is not below the clock range,
1114 * and we know the stream was active at that time (and that we cut it short).
1116 if (sstate
->seen_clock_snapshot
) {
1117 const bt_clock_class
*clock_class
;
1120 clock_class
= bt_stream_class_borrow_default_clock_class_const(
1121 bt_stream_borrow_class_const(sstate
->stream
));
1122 BT_ASSERT(clock_class
);
1123 ret
= clock_raw_value_from_ns_from_origin(clock_class
,
1124 trimmer_it
->end
.ns_from_origin
, &raw_value
);
1126 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1131 if (sstate
->cur_packet
) {
1133 * Create and push a packet end message, making its time
1134 * the trimming range's end time.
1136 * We know that we must have seen a clock snapshot, the one in
1137 * the packet beginning message, since trimmer currently
1138 * requires packet messages to have clock snapshots (see comment
1139 * in create_stream_state_entry).
1141 BT_ASSERT(sstate
->seen_clock_snapshot
);
1143 msg
= bt_message_packet_end_create_with_default_clock_snapshot(
1144 trimmer_it
->self_msg_iter
, sstate
->cur_packet
,
1147 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1151 push_message(trimmer_it
, msg
);
1153 BT_PACKET_PUT_REF_AND_RESET(sstate
->cur_packet
);
1156 /* Create and push a stream end message. */
1157 msg
= bt_message_stream_end_create(trimmer_it
->self_msg_iter
,
1160 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1164 if (sstate
->seen_clock_snapshot
) {
1165 bt_message_stream_end_set_default_clock_snapshot(msg
, raw_value
);
1168 push_message(trimmer_it
, msg
);
1172 * Just to make sure that we don't use this stream state again
1173 * in the future without an obvious error.
1175 sstate
->stream
= NULL
;
1178 bt_message_put_ref(msg
);
1183 bt_component_class_message_iterator_next_method_status
end_iterator_streams(
1184 struct trimmer_iterator
*trimmer_it
)
1186 bt_component_class_message_iterator_next_method_status status
=
1187 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1188 GHashTableIter iter
;
1189 gpointer key
, sstate
;
1191 if (trimmer_it
->end
.is_infinite
) {
1193 * An infinite trimming range's end time guarantees that
1194 * we received (and pushed) all the appropriate end
1201 * End each stream and then remove them from the hash table of
1202 * stream states to release unneeded references.
1204 g_hash_table_iter_init(&iter
, trimmer_it
->stream_states
);
1206 while (g_hash_table_iter_next(&iter
, &key
, &sstate
)) {
1207 status
= end_stream(trimmer_it
, sstate
);
1214 g_hash_table_remove_all(trimmer_it
->stream_states
);
1221 bt_component_class_message_iterator_next_method_status
1222 create_stream_state_entry(
1223 struct trimmer_iterator
*trimmer_it
,
1224 const struct bt_stream
*stream
,
1225 struct trimmer_iterator_stream_state
**stream_state
)
1227 struct trimmer_comp
*trimmer_comp
= trimmer_it
->trimmer_comp
;
1228 bt_component_class_message_iterator_next_method_status status
;
1229 struct trimmer_iterator_stream_state
*sstate
;
1230 const bt_stream_class
*sc
;
1232 BT_ASSERT(!bt_g_hash_table_contains(trimmer_it
->stream_states
, stream
));
1235 * Validate right now that the stream's class
1236 * has a registered default clock class so that
1237 * an existing stream state guarantees existing
1238 * default clock snapshots for its associated
1241 * Also check that clock snapshots are always
1244 sc
= bt_stream_borrow_class_const(stream
);
1245 if (!bt_stream_class_borrow_default_clock_class_const(sc
)) {
1246 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1247 "Unsupported stream: stream class does "
1248 "not have a default clock class: "
1250 "stream-id=%" PRIu64
", "
1251 "stream-name=\"%s\"",
1252 stream
, bt_stream_get_id(stream
),
1253 bt_stream_get_name(stream
));
1254 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1259 * Temporary: make sure packet beginning, packet
1260 * end, discarded events, and discarded packets
1261 * messages have default clock snapshots until
1262 * the support for not having them is
1265 if (!bt_stream_class_packets_have_beginning_default_clock_snapshot(
1267 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1268 "Unsupported stream: packets have no beginning clock snapshot: "
1270 "stream-id=%" PRIu64
", "
1271 "stream-name=\"%s\"",
1272 stream
, bt_stream_get_id(stream
),
1273 bt_stream_get_name(stream
));
1274 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1278 if (!bt_stream_class_packets_have_end_default_clock_snapshot(
1280 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1281 "Unsupported stream: packets have no end clock snapshot: "
1283 "stream-id=%" PRIu64
", "
1284 "stream-name=\"%s\"",
1285 stream
, bt_stream_get_id(stream
),
1286 bt_stream_get_name(stream
));
1287 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1291 if (bt_stream_class_supports_discarded_events(sc
) &&
1292 !bt_stream_class_discarded_events_have_default_clock_snapshots(sc
)) {
1293 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1294 "Unsupported stream: discarded events have no clock snapshots: "
1296 "stream-id=%" PRIu64
", "
1297 "stream-name=\"%s\"",
1298 stream
, bt_stream_get_id(stream
),
1299 bt_stream_get_name(stream
));
1300 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1304 if (bt_stream_class_supports_discarded_packets(sc
) &&
1305 !bt_stream_class_discarded_packets_have_default_clock_snapshots(sc
)) {
1306 BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp
->self_comp
,
1307 "Unsupported stream: discarded packets "
1308 "have no clock snapshots: "
1310 "stream-id=%" PRIu64
", "
1311 "stream-name=\"%s\"",
1312 stream
, bt_stream_get_id(stream
),
1313 bt_stream_get_name(stream
));
1314 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1318 sstate
= g_new0(struct trimmer_iterator_stream_state
, 1);
1320 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1324 sstate
->stream
= stream
;
1326 g_hash_table_insert(trimmer_it
->stream_states
, (void *) stream
, sstate
);
1328 *stream_state
= sstate
;
1330 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1337 struct trimmer_iterator_stream_state
*get_stream_state_entry(
1338 struct trimmer_iterator
*trimmer_it
,
1339 const struct bt_stream
*stream
)
1341 struct trimmer_iterator_stream_state
*sstate
;
1344 sstate
= g_hash_table_lookup(trimmer_it
->stream_states
, stream
);
1351 * Handles a message which is associated to a given stream state. This
1352 * _could_ make the iterator's output message queue grow; this could
1353 * also consume the message without pushing anything to this queue, only
1354 * modifying the stream state.
1356 * This function consumes the `msg` reference, _whatever the outcome_.
1358 * If non-NULL, `ns_from_origin` is the message's time, as given by
1359 * get_msg_ns_from_origin(). If NULL, the message doesn't have a time.
1361 * This function sets `reached_end` if handling this message made the
1362 * iterator reach the end of the trimming range. Note that the output
1363 * message queue could contain messages even if this function sets
1367 bt_component_class_message_iterator_next_method_status
1368 handle_message_with_stream(
1369 struct trimmer_iterator
*trimmer_it
, const bt_message
*msg
,
1370 const struct bt_stream
*stream
, const int64_t *ns_from_origin
,
1373 bt_component_class_message_iterator_next_method_status status
=
1374 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1375 bt_message_type msg_type
= bt_message_get_type(msg
);
1377 struct trimmer_iterator_stream_state
*sstate
= NULL
;
1380 * Retrieve the stream's state - except if the message is stream
1381 * beginning, in which case we don't know about about this stream yet.
1383 if (msg_type
!= BT_MESSAGE_TYPE_STREAM_BEGINNING
) {
1384 sstate
= get_stream_state_entry(trimmer_it
, stream
);
1388 case BT_MESSAGE_TYPE_EVENT
:
1390 * Event messages always have a clock snapshot if the stream
1391 * class has a clock class. And we know it has, otherwise we
1392 * couldn't be using the trimmer component.
1394 BT_ASSERT(ns_from_origin
);
1396 if (G_UNLIKELY(!trimmer_it
->end
.is_infinite
&&
1397 *ns_from_origin
> trimmer_it
->end
.ns_from_origin
)) {
1398 status
= end_iterator_streams(trimmer_it
);
1399 *reached_end
= true;
1403 sstate
->seen_clock_snapshot
= true;
1405 push_message(trimmer_it
, msg
);
1409 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1411 * Packet beginning messages won't have a clock snapshot if
1412 * stream_class->packets_have_beginning_default_clock_snapshot
1413 * is false. But for now, assume they always do.
1415 BT_ASSERT(ns_from_origin
);
1416 BT_ASSERT(!sstate
->cur_packet
);
1418 if (G_UNLIKELY(!trimmer_it
->end
.is_infinite
&&
1419 *ns_from_origin
> trimmer_it
->end
.ns_from_origin
)) {
1420 status
= end_iterator_streams(trimmer_it
);
1421 *reached_end
= true;
1425 sstate
->cur_packet
=
1426 bt_message_packet_beginning_borrow_packet_const(msg
);
1427 bt_packet_get_ref(sstate
->cur_packet
);
1429 sstate
->seen_clock_snapshot
= true;
1431 push_message(trimmer_it
, msg
);
1435 case BT_MESSAGE_TYPE_PACKET_END
:
1437 * Packet end messages won't have a clock snapshot if
1438 * stream_class->packets_have_end_default_clock_snapshot
1439 * is false. But for now, assume they always do.
1441 BT_ASSERT(ns_from_origin
);
1442 BT_ASSERT(sstate
->cur_packet
);
1444 if (G_UNLIKELY(!trimmer_it
->end
.is_infinite
&&
1445 *ns_from_origin
> trimmer_it
->end
.ns_from_origin
)) {
1446 status
= end_iterator_streams(trimmer_it
);
1447 *reached_end
= true;
1451 BT_PACKET_PUT_REF_AND_RESET(sstate
->cur_packet
);
1453 sstate
->seen_clock_snapshot
= true;
1455 push_message(trimmer_it
, msg
);
1459 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1460 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1463 * `ns_from_origin` is the message's time range's
1464 * beginning time here.
1466 int64_t end_ns_from_origin
;
1467 const bt_clock_snapshot
*end_cs
;
1469 BT_ASSERT(ns_from_origin
);
1471 sstate
->seen_clock_snapshot
= true;
1473 if (bt_message_get_type(msg
) ==
1474 BT_MESSAGE_TYPE_DISCARDED_EVENTS
) {
1476 * Safe to ignore the return value because we
1477 * know there's a default clock and it's always
1480 end_cs
= bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
1484 * Safe to ignore the return value because we
1485 * know there's a default clock and it's always
1488 end_cs
= bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
1492 if (bt_clock_snapshot_get_ns_from_origin(end_cs
,
1493 &end_ns_from_origin
)) {
1494 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1498 if (!trimmer_it
->end
.is_infinite
&&
1499 *ns_from_origin
> trimmer_it
->end
.ns_from_origin
) {
1500 status
= end_iterator_streams(trimmer_it
);
1501 *reached_end
= true;
1505 if (!trimmer_it
->end
.is_infinite
&&
1506 end_ns_from_origin
> trimmer_it
->end
.ns_from_origin
) {
1508 * This message's end time is outside the
1509 * trimming time range: replace it with a new
1510 * message having an end time equal to the
1511 * trimming time range's end and without a
1514 const bt_clock_class
*clock_class
=
1515 bt_clock_snapshot_borrow_clock_class_const(
1517 const bt_clock_snapshot
*begin_cs
;
1518 bt_message
*new_msg
;
1519 uint64_t end_raw_value
;
1521 ret
= clock_raw_value_from_ns_from_origin(clock_class
,
1522 trimmer_it
->end
.ns_from_origin
, &end_raw_value
);
1524 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1528 if (msg_type
== BT_MESSAGE_TYPE_DISCARDED_EVENTS
) {
1529 begin_cs
= bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
1531 new_msg
= bt_message_discarded_events_create_with_default_clock_snapshots(
1532 trimmer_it
->self_msg_iter
,
1534 bt_clock_snapshot_get_value(begin_cs
),
1537 begin_cs
= bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
1539 new_msg
= bt_message_discarded_packets_create_with_default_clock_snapshots(
1540 trimmer_it
->self_msg_iter
,
1542 bt_clock_snapshot_get_value(begin_cs
),
1547 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
;
1551 /* Replace the original message */
1552 BT_MESSAGE_MOVE_REF(msg
, new_msg
);
1555 push_message(trimmer_it
, msg
);
1560 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1562 * If this message has a time and this time is greater than the
1563 * trimmer's end bound, it triggers the end of the trim window.
1565 if (G_UNLIKELY(ns_from_origin
&& !trimmer_it
->end
.is_infinite
&&
1566 *ns_from_origin
> trimmer_it
->end
.ns_from_origin
)) {
1567 status
= end_iterator_streams(trimmer_it
);
1568 *reached_end
= true;
1572 /* Learn about this stream. */
1573 status
= create_stream_state_entry(trimmer_it
, stream
, &sstate
);
1574 if (status
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
1578 if (ns_from_origin
) {
1579 sstate
->seen_clock_snapshot
= true;
1582 push_message(trimmer_it
, msg
);
1585 case BT_MESSAGE_TYPE_STREAM_END
:
1590 * If this message has a time and this time is greater than the
1591 * trimmer's end bound, it triggers the end of the trim window.
1593 if (G_UNLIKELY(ns_from_origin
&& !trimmer_it
->end
.is_infinite
&&
1594 *ns_from_origin
> trimmer_it
->end
.ns_from_origin
)) {
1595 status
= end_iterator_streams(trimmer_it
);
1596 *reached_end
= true;
1601 * Either the stream end message's time is within the trimmer's
1602 * bounds, or it doesn't have a time. In both cases, pass
1603 * the message unmodified.
1605 push_message(trimmer_it
, msg
);
1608 /* Forget about this stream. */
1609 removed
= g_hash_table_remove(trimmer_it
->stream_states
, sstate
->stream
);
1618 /* We release the message's reference whatever the outcome */
1619 bt_message_put_ref(msg
);
1624 * Handles an input message. This _could_ make the iterator's output
1625 * message queue grow; this could also consume the message without
1626 * pushing anything to this queue, only modifying the stream state.
1628 * This function consumes the `msg` reference, _whatever the outcome_.
1630 * This function sets `reached_end` if handling this message made the
1631 * iterator reach the end of the trimming range. Note that the output
1632 * message queue could contain messages even if this function sets
1636 bt_component_class_message_iterator_next_method_status
handle_message(
1637 struct trimmer_iterator
*trimmer_it
, const bt_message
*msg
,
1640 bt_component_class_message_iterator_next_method_status status
;
1641 const bt_stream
*stream
= NULL
;
1642 int64_t ns_from_origin
= INT64_MIN
;
1643 bool has_ns_from_origin
= false;
1646 /* Find message's associated stream */
1647 switch (bt_message_get_type(msg
)) {
1648 case BT_MESSAGE_TYPE_EVENT
:
1649 stream
= bt_event_borrow_stream_const(
1650 bt_message_event_borrow_event_const(msg
));
1652 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1653 stream
= bt_packet_borrow_stream_const(
1654 bt_message_packet_beginning_borrow_packet_const(msg
));
1656 case BT_MESSAGE_TYPE_PACKET_END
:
1657 stream
= bt_packet_borrow_stream_const(
1658 bt_message_packet_end_borrow_packet_const(msg
));
1660 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1661 stream
= bt_message_discarded_events_borrow_stream_const(msg
);
1663 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1664 stream
= bt_message_discarded_packets_borrow_stream_const(msg
);
1666 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1667 stream
= bt_message_stream_beginning_borrow_stream_const(msg
);
1669 case BT_MESSAGE_TYPE_STREAM_END
:
1670 stream
= bt_message_stream_end_borrow_stream_const(msg
);
1676 /* Retrieve the message's time */
1677 ret
= get_msg_ns_from_origin(msg
, &ns_from_origin
, &has_ns_from_origin
);
1678 if (G_UNLIKELY(ret
)) {
1679 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
1683 if (G_LIKELY(stream
)) {
1684 /* Message associated to a stream */
1685 status
= handle_message_with_stream(trimmer_it
, msg
,
1686 stream
, has_ns_from_origin
? &ns_from_origin
: NULL
, reached_end
);
1689 * handle_message_with_stream_state() unconditionally
1695 * Message not associated to a stream (message iterator
1698 if (G_UNLIKELY(ns_from_origin
> trimmer_it
->end
.ns_from_origin
)) {
1699 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
1700 status
= end_iterator_streams(trimmer_it
);
1701 *reached_end
= true;
1703 push_message(trimmer_it
, msg
);
1704 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1710 /* We release the message's reference whatever the outcome */
1711 bt_message_put_ref(msg
);
1716 void fill_message_array_from_output_messages(
1717 struct trimmer_iterator
*trimmer_it
,
1718 bt_message_array_const msgs
, uint64_t capacity
, uint64_t *count
)
1723 * Move auto-seek messages to the output array (which is this
1724 * iterator's base message array).
1726 while (capacity
> 0 && !g_queue_is_empty(trimmer_it
->output_messages
)) {
1727 msgs
[*count
] = pop_message(trimmer_it
);
1732 BT_ASSERT(*count
> 0);
1736 bt_component_class_message_iterator_next_method_status
state_ending(
1737 struct trimmer_iterator
*trimmer_it
,
1738 bt_message_array_const msgs
, uint64_t capacity
,
1741 bt_component_class_message_iterator_next_method_status status
=
1742 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1744 if (g_queue_is_empty(trimmer_it
->output_messages
)) {
1745 trimmer_it
->state
= TRIMMER_ITERATOR_STATE_ENDED
;
1746 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
;
1750 fill_message_array_from_output_messages(trimmer_it
, msgs
,
1758 bt_component_class_message_iterator_next_method_status
1759 state_trim(struct trimmer_iterator
*trimmer_it
,
1760 bt_message_array_const msgs
, uint64_t capacity
,
1763 bt_component_class_message_iterator_next_method_status status
=
1764 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1765 bt_message_array_const my_msgs
;
1768 bool reached_end
= false;
1770 while (g_queue_is_empty(trimmer_it
->output_messages
)) {
1771 status
= (int) bt_self_component_port_input_message_iterator_next(
1772 trimmer_it
->upstream_iter
, &my_msgs
, &my_count
);
1773 if (G_UNLIKELY(status
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
)) {
1774 if (status
== BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
) {
1775 status
= end_iterator_streams(trimmer_it
);
1776 if (status
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
1781 TRIMMER_ITERATOR_STATE_ENDING
;
1782 status
= state_ending(trimmer_it
, msgs
,
1789 BT_ASSERT(my_count
> 0);
1791 for (i
= 0; i
< my_count
; i
++) {
1792 status
= handle_message(trimmer_it
, my_msgs
[i
],
1796 * handle_message() unconditionally consumes the
1797 * message reference.
1801 if (G_UNLIKELY(status
!=
1802 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
)) {
1803 put_messages(my_msgs
, my_count
);
1807 if (G_UNLIKELY(reached_end
)) {
1809 * This message's time was passed the
1810 * trimming time range's end time: we
1811 * are done. Their might still be
1812 * messages in the output message queue,
1813 * so move to the "ending" state and
1814 * apply it immediately since
1815 * state_trim() is called within the
1818 put_messages(my_msgs
, my_count
);
1820 TRIMMER_ITERATOR_STATE_ENDING
;
1821 status
= state_ending(trimmer_it
, msgs
,
1829 * There's at least one message in the output message queue:
1830 * move the messages to the output message array.
1832 BT_ASSERT(!g_queue_is_empty(trimmer_it
->output_messages
));
1833 fill_message_array_from_output_messages(trimmer_it
, msgs
,
1841 bt_component_class_message_iterator_next_method_status
trimmer_msg_iter_next(
1842 bt_self_message_iterator
*self_msg_iter
,
1843 bt_message_array_const msgs
, uint64_t capacity
,
1846 struct trimmer_iterator
*trimmer_it
=
1847 bt_self_message_iterator_get_data(self_msg_iter
);
1848 bt_component_class_message_iterator_next_method_status status
=
1849 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
1851 BT_ASSERT(trimmer_it
);
1853 if (G_LIKELY(trimmer_it
->state
== TRIMMER_ITERATOR_STATE_TRIM
)) {
1854 status
= state_trim(trimmer_it
, msgs
, capacity
, count
);
1855 if (status
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
1859 switch (trimmer_it
->state
) {
1860 case TRIMMER_ITERATOR_STATE_SET_BOUNDS_NS_FROM_ORIGIN
:
1861 status
= state_set_trimmer_iterator_bounds(trimmer_it
);
1862 if (status
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
1866 status
= state_seek_initially(trimmer_it
);
1867 if (status
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
1871 status
= state_trim(trimmer_it
, msgs
, capacity
, count
);
1872 if (status
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
1877 case TRIMMER_ITERATOR_STATE_SEEK_INITIALLY
:
1878 status
= state_seek_initially(trimmer_it
);
1879 if (status
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
1883 status
= state_trim(trimmer_it
, msgs
, capacity
, count
);
1884 if (status
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
1889 case TRIMMER_ITERATOR_STATE_ENDING
:
1890 status
= state_ending(trimmer_it
, msgs
, capacity
,
1892 if (status
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
1897 case TRIMMER_ITERATOR_STATE_ENDED
:
1898 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
;
1910 void trimmer_msg_iter_finalize(bt_self_message_iterator
*self_msg_iter
)
1912 struct trimmer_iterator
*trimmer_it
=
1913 bt_self_message_iterator_get_data(self_msg_iter
);
1915 BT_ASSERT(trimmer_it
);
1916 destroy_trimmer_iterator(trimmer_it
);