Commit | Line | Data |
---|---|---|
cab3f160 | 1 | /* |
cab3f160 | 2 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7de0e49a | 3 | * Copyright 2019 Philippe Proulx <pproulx@efficios.com> |
cab3f160 JG |
4 | * |
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: | |
11 | * | |
12 | * The above copyright notice and this permission notice shall be included in | |
13 | * all copies or substantial portions of the Software. | |
14 | * | |
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 | |
21 | * SOFTWARE. | |
22 | */ | |
23 | ||
0d9a3d3e | 24 | #define BT_LOG_OUTPUT_LEVEL (trimmer_comp->log_level) |
350ad6c1 | 25 | #define BT_LOG_TAG "PLUGIN/FLT.UTILS.TRIMMER" |
d9c39b0a | 26 | #include "logging/comp-logging.h" |
b4565e8b | 27 | |
578e048b MJ |
28 | #include "compat/utc.h" |
29 | #include "compat/time.h" | |
3fadfbc0 | 30 | #include <babeltrace2/babeltrace.h> |
578e048b | 31 | #include "common/common.h" |
578e048b | 32 | #include "common/assert.h" |
7de0e49a PP |
33 | #include <stdint.h> |
34 | #include <inttypes.h> | |
35 | #include <glib.h> | |
188edac1 | 36 | #include "compat/glib.h" |
90a55a4e | 37 | #include "plugins/common/param-validation/param-validation.h" |
7de0e49a PP |
38 | |
39 | #include "trimmer.h" | |
40 | ||
41 | #define NS_PER_S INT64_C(1000000000) | |
42 | ||
43 | static const char * const in_port_name = "in"; | |
44 | ||
45 | struct trimmer_time { | |
46 | unsigned int hour, minute, second, ns; | |
47 | }; | |
48 | ||
49 | struct trimmer_bound { | |
50 | /* | |
51 | * Nanoseconds from origin, valid if `is_set` is set and | |
52 | * `is_infinite` is false. | |
53 | */ | |
54 | int64_t ns_from_origin; | |
55 | ||
56 | /* True if this bound's full time (`ns_from_origin`) is set */ | |
57 | bool is_set; | |
58 | ||
59 | /* | |
60 | * True if this bound represents the infinity (negative or | |
61 | * positive depending on which bound it is). If this is true, | |
62 | * then we don't care about `ns_from_origin` above. | |
63 | */ | |
64 | bool is_infinite; | |
65 | ||
66 | /* | |
67 | * This bound's time without the date; this time is used to set | |
68 | * `ns_from_origin` once we know the date. | |
69 | */ | |
70 | struct trimmer_time time; | |
71 | }; | |
72 | ||
73 | struct trimmer_comp { | |
74 | struct trimmer_bound begin, end; | |
75 | bool is_gmt; | |
0d9a3d3e | 76 | bt_logging_level log_level; |
ec4ae660 | 77 | bt_self_component *self_comp; |
7de0e49a PP |
78 | }; |
79 | ||
80 | enum trimmer_iterator_state { | |
81 | /* | |
82 | * Find the first message's date and set the bounds's times | |
83 | * accordingly. | |
84 | */ | |
85 | TRIMMER_ITERATOR_STATE_SET_BOUNDS_NS_FROM_ORIGIN, | |
86 | ||
87 | /* | |
88 | * Initially seek to the trimming range's beginning time. | |
89 | */ | |
90 | TRIMMER_ITERATOR_STATE_SEEK_INITIALLY, | |
91 | ||
92 | /* | |
93 | * Fill the output message queue for as long as received input | |
94 | * messages are within the trimming time range. | |
95 | */ | |
96 | TRIMMER_ITERATOR_STATE_TRIM, | |
97 | ||
98 | /* Flush the remaining messages in the output message queue */ | |
99 | TRIMMER_ITERATOR_STATE_ENDING, | |
100 | ||
101 | /* Trimming operation and message iterator is ended */ | |
102 | TRIMMER_ITERATOR_STATE_ENDED, | |
103 | }; | |
104 | ||
105 | struct trimmer_iterator { | |
106 | /* Weak */ | |
107 | struct trimmer_comp *trimmer_comp; | |
108 | ||
109 | /* Weak */ | |
110 | bt_self_message_iterator *self_msg_iter; | |
111 | ||
112 | enum trimmer_iterator_state state; | |
113 | ||
114 | /* Owned by this */ | |
115 | bt_self_component_port_input_message_iterator *upstream_iter; | |
116 | struct trimmer_bound begin, end; | |
117 | ||
118 | /* | |
119 | * Queue of `const bt_message *` (owned by the queue). | |
120 | * | |
121 | * This is where the trimming operation pushes the messages to | |
122 | * output by this message iterator. | |
123 | */ | |
124 | GQueue *output_messages; | |
125 | ||
126 | /* | |
127 | * Hash table of `bt_stream *` (weak) to | |
128 | * `struct trimmer_iterator_stream_state *` (owned by the HT). | |
129 | */ | |
130 | GHashTable *stream_states; | |
131 | }; | |
132 | ||
133 | struct trimmer_iterator_stream_state { | |
7de0e49a PP |
134 | /* Weak */ |
135 | const bt_stream *stream; | |
136 | ||
188edac1 SM |
137 | /* Have we seen a message with clock_snapshot going through this stream? */ |
138 | bool seen_clock_snapshot; | |
139 | ||
7de0e49a PP |
140 | /* Owned by this (`NULL` initially and between packets) */ |
141 | const bt_packet *cur_packet; | |
7de0e49a | 142 | }; |
cab3f160 JG |
143 | |
144 | static | |
7de0e49a | 145 | void destroy_trimmer_comp(struct trimmer_comp *trimmer_comp) |
cab3f160 | 146 | { |
7de0e49a PP |
147 | BT_ASSERT(trimmer_comp); |
148 | g_free(trimmer_comp); | |
cab3f160 JG |
149 | } |
150 | ||
151 | static | |
7de0e49a PP |
152 | struct trimmer_comp *create_trimmer_comp(void) |
153 | { | |
154 | return g_new0(struct trimmer_comp, 1); | |
155 | } | |
156 | ||
157 | BT_HIDDEN | |
158 | void trimmer_finalize(bt_self_component_filter *self_comp) | |
cab3f160 | 159 | { |
7de0e49a PP |
160 | struct trimmer_comp *trimmer_comp = |
161 | bt_self_component_get_data( | |
162 | bt_self_component_filter_as_self_component(self_comp)); | |
163 | ||
164 | if (trimmer_comp) { | |
165 | destroy_trimmer_comp(trimmer_comp); | |
166 | } | |
cab3f160 JG |
167 | } |
168 | ||
d4d7ffc9 SM |
169 | /* |
170 | * Compile regex in `pattern`, and try to match `string`. If there's a match, | |
171 | * return true and set `*match_info` to the list of matches. The list of | |
172 | * matches must be freed by the caller. If there's no match, return false and | |
173 | * set `*match_info` to NULL; | |
174 | */ | |
175 | static | |
176 | bool compile_and_match(const char *pattern, const char *string, GMatchInfo **match_info) { | |
177 | bool matches = false; | |
178 | GError *regex_error = NULL; | |
179 | GRegex *regex; | |
180 | ||
181 | regex = g_regex_new(pattern, 0, 0, ®ex_error); | |
182 | if (!regex) { | |
183 | goto end; | |
184 | } | |
185 | ||
186 | matches = g_regex_match(regex, string, 0, match_info); | |
187 | if (!matches) { | |
188 | /* | |
189 | * g_regex_match allocates `*match_info` even if it returns | |
190 | * FALSE. If there's no match, we have no use for it, so free | |
191 | * it immediatly and don't return it to the caller. | |
192 | */ | |
a42eab88 | 193 | g_match_info_free(*match_info); |
d4d7ffc9 SM |
194 | *match_info = NULL; |
195 | } | |
196 | ||
197 | g_regex_unref(regex); | |
198 | ||
199 | end: | |
200 | ||
201 | if (regex_error) { | |
202 | g_error_free(regex_error); | |
203 | } | |
204 | ||
205 | return matches; | |
206 | } | |
207 | ||
208 | /* | |
209 | * Convert the captured text in match number `match_num` in `match_info` | |
210 | * to an unsigned integer. | |
211 | */ | |
212 | static | |
213 | guint64 match_to_uint(const GMatchInfo *match_info, gint match_num) { | |
214 | gchar *text, *endptr; | |
215 | guint64 result; | |
216 | ||
217 | text = g_match_info_fetch(match_info, match_num); | |
218 | BT_ASSERT(text); | |
219 | ||
220 | /* | |
221 | * Because the input is carefully sanitized with regexes by the caller, | |
222 | * we assume that g_ascii_strtoull cannot fail. | |
223 | */ | |
224 | errno = 0; | |
225 | result = g_ascii_strtoull(text, &endptr, 10); | |
226 | BT_ASSERT(endptr > text); | |
227 | BT_ASSERT(errno == 0); | |
228 | ||
229 | g_free(text); | |
230 | ||
231 | return result; | |
232 | } | |
233 | ||
234 | /* | |
235 | * When parsing the nanoseconds part, .512 means .512000000, not .000000512. | |
236 | * This function is like match_to_uint, but multiplies the parsed number to get | |
237 | * the expected result. | |
238 | */ | |
239 | static | |
240 | guint64 match_to_uint_ns(const GMatchInfo *match_info, gint match_num) { | |
241 | guint64 nanoseconds; | |
242 | gboolean ret; | |
243 | gint start_pos, end_pos, power; | |
244 | static int pow10[] = { | |
245 | 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000, 100000000, | |
246 | }; | |
247 | ||
248 | nanoseconds = match_to_uint(match_info, match_num); | |
249 | ||
250 | /* Multiply by 10 as many times as there are omitted digits. */ | |
251 | ret = g_match_info_fetch_pos(match_info, match_num, &start_pos, &end_pos); | |
252 | BT_ASSERT(ret); | |
253 | ||
254 | power = 9 - (end_pos - start_pos); | |
255 | BT_ASSERT(power >= 0 && power <= 8); | |
256 | ||
257 | nanoseconds *= pow10[power]; | |
258 | ||
259 | return nanoseconds; | |
260 | } | |
261 | ||
7de0e49a PP |
262 | /* |
263 | * Sets the time (in ns from origin) of a trimmer bound from date and | |
264 | * time components. | |
265 | * | |
266 | * Returns a negative value if anything goes wrong. | |
267 | */ | |
268 | static | |
269 | int set_bound_ns_from_origin(struct trimmer_bound *bound, | |
270 | unsigned int year, unsigned int month, unsigned int day, | |
271 | unsigned int hour, unsigned int minute, unsigned int second, | |
272 | unsigned int ns, bool is_gmt) | |
cab3f160 | 273 | { |
7de0e49a PP |
274 | int ret = 0; |
275 | time_t result; | |
276 | struct tm tm = { | |
277 | .tm_sec = second, | |
278 | .tm_min = minute, | |
279 | .tm_hour = hour, | |
280 | .tm_mday = day, | |
281 | .tm_mon = month - 1, | |
282 | .tm_year = year - 1900, | |
283 | .tm_isdst = -1, | |
284 | }; | |
285 | ||
286 | if (is_gmt) { | |
287 | result = bt_timegm(&tm); | |
288 | } else { | |
289 | result = mktime(&tm); | |
290 | } | |
291 | ||
292 | if (result < 0) { | |
293 | ret = -1; | |
294 | goto end; | |
295 | } | |
cab3f160 | 296 | |
7de0e49a PP |
297 | BT_ASSERT(bound); |
298 | bound->ns_from_origin = (int64_t) result; | |
299 | bound->ns_from_origin *= NS_PER_S; | |
300 | bound->ns_from_origin += ns; | |
301 | bound->is_set = true; | |
302 | ||
303 | end: | |
304 | return ret; | |
cab3f160 JG |
305 | } |
306 | ||
528debdf MD |
307 | /* |
308 | * Parses a timestamp, figuring out its format. | |
309 | * | |
310 | * Returns a negative value if anything goes wrong. | |
311 | * | |
312 | * Expected formats: | |
313 | * | |
7de0e49a PP |
314 | * YYYY-MM-DD hh:mm[:ss[.ns]] |
315 | * [hh:mm:]ss[.ns] | |
316 | * [-]s[.ns] | |
317 | * | |
318 | * TODO: Check overflows. | |
319 | */ | |
320 | static | |
0d9a3d3e PP |
321 | int set_bound_from_str(struct trimmer_comp *trimmer_comp, |
322 | const char *str, struct trimmer_bound *bound, bool is_gmt) | |
7de0e49a | 323 | { |
d4d7ffc9 SM |
324 | /* Matches YYYY-MM-DD */ |
325 | #define DATE_RE "([0-9]{4})-([0-9]{2})-([0-9]{2})" | |
326 | ||
327 | /* Matches HH:MM[:SS[.NS]] */ | |
328 | #define TIME_RE "([0-9]{2}):([0-9]{2})(?::([0-9]{2})(?:\\.([0-9]{1,9}))?)?" | |
329 | ||
330 | /* Matches [-]SS[.NS] */ | |
331 | #define S_NS_RE "^(-?)([0-9]+)(?:\\.([0-9]{1,9}))?$" | |
332 | ||
333 | GMatchInfo *match_info; | |
7de0e49a | 334 | int ret = 0; |
7de0e49a | 335 | |
d4d7ffc9 SM |
336 | /* Try `YYYY-MM-DD hh:mm[:ss[.ns]]` format */ |
337 | if (compile_and_match("^" DATE_RE " " TIME_RE "$", str, &match_info)) { | |
338 | unsigned int year = 0, month = 0, day = 0, hours = 0, minutes = 0, seconds = 0, nanoseconds = 0; | |
339 | gint match_count = g_match_info_get_match_count(match_info); | |
7de0e49a | 340 | |
d4d7ffc9 | 341 | BT_ASSERT(match_count >= 6 && match_count <= 8); |
7de0e49a | 342 | |
d4d7ffc9 SM |
343 | year = match_to_uint(match_info, 1); |
344 | month = match_to_uint(match_info, 2); | |
345 | day = match_to_uint(match_info, 3); | |
346 | hours = match_to_uint(match_info, 4); | |
347 | minutes = match_to_uint(match_info, 5); | |
7de0e49a | 348 | |
d4d7ffc9 SM |
349 | if (match_count >= 7) { |
350 | seconds = match_to_uint(match_info, 6); | |
351 | } | |
7de0e49a | 352 | |
d4d7ffc9 SM |
353 | if (match_count >= 8) { |
354 | nanoseconds = match_to_uint_ns(match_info, 7); | |
355 | } | |
356 | ||
357 | set_bound_ns_from_origin(bound, year, month, day, hours, minutes, seconds, nanoseconds, is_gmt); | |
7de0e49a | 358 | |
7de0e49a PP |
359 | goto end; |
360 | } | |
361 | ||
d4d7ffc9 SM |
362 | if (compile_and_match("^" DATE_RE "$", str, &match_info)) { |
363 | unsigned int year = 0, month = 0, day = 0; | |
364 | ||
365 | BT_ASSERT(g_match_info_get_match_count(match_info) == 4); | |
366 | ||
367 | year = match_to_uint(match_info, 1); | |
368 | month = match_to_uint(match_info, 2); | |
369 | day = match_to_uint(match_info, 3); | |
370 | ||
371 | set_bound_ns_from_origin(bound, year, month, day, 0, 0, 0, 0, is_gmt); | |
372 | ||
7de0e49a PP |
373 | goto end; |
374 | } | |
375 | ||
d4d7ffc9 SM |
376 | /* Try `hh:mm[:ss[.ns]]` format */ |
377 | if (compile_and_match("^" TIME_RE "$", str, &match_info)) { | |
378 | gint match_count = g_match_info_get_match_count(match_info); | |
379 | BT_ASSERT(match_count >= 3 && match_count <= 5); | |
380 | bound->time.hour = match_to_uint(match_info, 1); | |
381 | bound->time.minute = match_to_uint(match_info, 2); | |
382 | ||
383 | if (match_count >= 4) { | |
384 | bound->time.second = match_to_uint(match_info, 3); | |
385 | } | |
386 | ||
387 | if (match_count >= 5) { | |
388 | bound->time.ns = match_to_uint_ns(match_info, 4); | |
389 | } | |
390 | ||
7de0e49a PP |
391 | goto end; |
392 | } | |
393 | ||
d4d7ffc9 SM |
394 | /* Try `[-]s[.ns]` format */ |
395 | if (compile_and_match("^" S_NS_RE "$", str, &match_info)) { | |
396 | gboolean is_neg, fetch_pos_ret; | |
397 | gint start_pos, end_pos, match_count; | |
398 | guint64 seconds, nanoseconds = 0; | |
399 | ||
400 | match_count = g_match_info_get_match_count(match_info); | |
401 | BT_ASSERT(match_count >= 3 && match_count <= 4); | |
402 | ||
403 | /* Check for presence of negation sign. */ | |
404 | fetch_pos_ret = g_match_info_fetch_pos(match_info, 1, &start_pos, &end_pos); | |
405 | BT_ASSERT(fetch_pos_ret); | |
406 | is_neg = (end_pos - start_pos) > 0; | |
407 | ||
408 | seconds = match_to_uint(match_info, 2); | |
409 | ||
410 | if (match_count >= 4) { | |
411 | nanoseconds = match_to_uint_ns(match_info, 3); | |
412 | } | |
413 | ||
414 | bound->ns_from_origin = seconds * NS_PER_S + nanoseconds; | |
415 | ||
416 | if (is_neg) { | |
417 | bound->ns_from_origin = -bound->ns_from_origin; | |
418 | } | |
419 | ||
7de0e49a | 420 | bound->is_set = true; |
d4d7ffc9 | 421 | |
7de0e49a PP |
422 | goto end; |
423 | } | |
424 | ||
ab90ee94 SM |
425 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, |
426 | "Invalid date/time format: param=\"%s\"", str); | |
7de0e49a PP |
427 | ret = -1; |
428 | ||
429 | end: | |
430 | return ret; | |
431 | } | |
432 | ||
433 | /* | |
434 | * Sets a trimmer bound's properties from a parameter string/integer | |
435 | * value. | |
436 | * | |
437 | * Returns a negative value if anything goes wrong. | |
528debdf | 438 | */ |
44d3cbf0 | 439 | static |
0d9a3d3e PP |
440 | int set_bound_from_param(struct trimmer_comp *trimmer_comp, |
441 | const char *param_name, const bt_value *param, | |
7de0e49a | 442 | struct trimmer_bound *bound, bool is_gmt) |
528debdf MD |
443 | { |
444 | int ret; | |
268fae9a | 445 | const char *arg; |
7de0e49a | 446 | char tmp_arg[64]; |
268fae9a | 447 | |
fdd3a2da | 448 | if (bt_value_is_signed_integer(param)) { |
9c08c816 | 449 | int64_t value = bt_value_integer_signed_get(param); |
7de0e49a PP |
450 | |
451 | /* | |
452 | * Just convert it to a temporary string to handle | |
453 | * everything the same way. | |
454 | */ | |
455 | sprintf(tmp_arg, "%" PRId64, value); | |
456 | arg = tmp_arg; | |
7de0e49a | 457 | } else { |
90a55a4e SM |
458 | BT_ASSERT(bt_value_is_string(param)); |
459 | arg = bt_value_string_get(param); | |
268fae9a PP |
460 | } |
461 | ||
0d9a3d3e | 462 | ret = set_bound_from_str(trimmer_comp, arg, bound, is_gmt); |
7de0e49a | 463 | |
7de0e49a PP |
464 | return ret; |
465 | } | |
466 | ||
467 | static | |
0d9a3d3e PP |
468 | int validate_trimmer_bounds(struct trimmer_comp *trimmer_comp, |
469 | struct trimmer_bound *begin, struct trimmer_bound *end) | |
7de0e49a PP |
470 | { |
471 | int ret = 0; | |
472 | ||
473 | BT_ASSERT(begin->is_set); | |
474 | BT_ASSERT(end->is_set); | |
475 | ||
476 | if (!begin->is_infinite && !end->is_infinite && | |
477 | begin->ns_from_origin > end->ns_from_origin) { | |
ab90ee94 SM |
478 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, |
479 | "Trimming time range's beginning time is greater than end time: " | |
7de0e49a PP |
480 | "begin-ns-from-origin=%" PRId64 ", " |
481 | "end-ns-from-origin=%" PRId64, | |
482 | begin->ns_from_origin, | |
483 | end->ns_from_origin); | |
484 | ret = -1; | |
485 | goto end; | |
528debdf MD |
486 | } |
487 | ||
7de0e49a | 488 | if (!begin->is_infinite && begin->ns_from_origin == INT64_MIN) { |
ab90ee94 SM |
489 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, |
490 | "Invalid trimming time range's beginning time: " | |
7de0e49a PP |
491 | "ns-from-origin=%" PRId64, |
492 | begin->ns_from_origin); | |
493 | ret = -1; | |
494 | goto end; | |
495 | } | |
528debdf | 496 | |
7de0e49a | 497 | if (!end->is_infinite && end->ns_from_origin == INT64_MIN) { |
ab90ee94 SM |
498 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, |
499 | "Invalid trimming time range's end time: " | |
7de0e49a PP |
500 | "ns-from-origin=%" PRId64, |
501 | end->ns_from_origin); | |
502 | ret = -1; | |
503 | goto end; | |
504 | } | |
528debdf | 505 | |
7de0e49a PP |
506 | end: |
507 | return ret; | |
528debdf MD |
508 | } |
509 | ||
510 | static | |
90a55a4e SM |
511 | enum bt_param_validation_status validate_bound_type( |
512 | const bt_value *value, | |
513 | struct bt_param_validation_context *context) | |
514 | { | |
515 | enum bt_param_validation_status status = BT_PARAM_VALIDATION_STATUS_OK; | |
516 | ||
517 | if (!bt_value_is_signed_integer(value) && | |
518 | !bt_value_is_string(value)) { | |
519 | status = bt_param_validation_error(context, | |
520 | "unexpected type: expected-types=[%s, %s], actual-type=%s", | |
521 | bt_common_value_type_string(BT_VALUE_TYPE_SIGNED_INTEGER), | |
522 | bt_common_value_type_string(BT_VALUE_TYPE_STRING), | |
523 | bt_common_value_type_string(bt_value_get_type(value))); | |
524 | } | |
525 | ||
526 | return status; | |
527 | } | |
528 | ||
529 | struct bt_param_validation_map_value_entry_descr trimmer_params[] = { | |
530 | { "gmt", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
531 | { "begin", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .validation_func = validate_bound_type } }, | |
532 | { "end", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .validation_func = validate_bound_type } }, | |
533 | BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END | |
534 | }; | |
535 | ||
536 | static | |
537 | bt_component_class_initialize_method_status init_trimmer_comp_from_params( | |
538 | struct trimmer_comp *trimmer_comp, | |
7de0e49a | 539 | const bt_value *params) |
44d3cbf0 | 540 | { |
7de0e49a | 541 | const bt_value *value; |
90a55a4e SM |
542 | bt_component_class_initialize_method_status status; |
543 | enum bt_param_validation_status validation_status; | |
544 | gchar *validate_error = NULL; | |
545 | ||
546 | validation_status = bt_param_validation_validate(params, | |
547 | trimmer_params, &validate_error); | |
548 | if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) { | |
549 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; | |
550 | goto end; | |
551 | } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) { | |
552 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
553 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, "%s", | |
554 | validate_error); | |
555 | goto end; | |
556 | } | |
44d3cbf0 | 557 | |
f6ccaed9 | 558 | BT_ASSERT(params); |
7de0e49a | 559 | value = bt_value_map_borrow_entry_value_const(params, "gmt"); |
528debdf | 560 | if (value) { |
7de0e49a | 561 | trimmer_comp->is_gmt = (bool) bt_value_bool_get(value); |
528debdf MD |
562 | } |
563 | ||
7de0e49a | 564 | value = bt_value_map_borrow_entry_value_const(params, "begin"); |
528debdf | 565 | if (value) { |
0d9a3d3e | 566 | if (set_bound_from_param(trimmer_comp, "begin", value, |
7de0e49a PP |
567 | &trimmer_comp->begin, trimmer_comp->is_gmt)) { |
568 | /* set_bound_from_param() logs errors */ | |
90a55a4e | 569 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; |
268fae9a | 570 | goto end; |
44d3cbf0 | 571 | } |
7de0e49a PP |
572 | } else { |
573 | trimmer_comp->begin.is_infinite = true; | |
574 | trimmer_comp->begin.is_set = true; | |
44d3cbf0 | 575 | } |
528debdf | 576 | |
7de0e49a | 577 | value = bt_value_map_borrow_entry_value_const(params, "end"); |
528debdf | 578 | if (value) { |
0d9a3d3e | 579 | if (set_bound_from_param(trimmer_comp, "end", value, |
7de0e49a PP |
580 | &trimmer_comp->end, trimmer_comp->is_gmt)) { |
581 | /* set_bound_from_param() logs errors */ | |
90a55a4e | 582 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; |
268fae9a | 583 | goto end; |
528debdf | 584 | } |
7de0e49a PP |
585 | } else { |
586 | trimmer_comp->end.is_infinite = true; | |
587 | trimmer_comp->end.is_set = true; | |
528debdf | 588 | } |
268fae9a | 589 | |
7de0e49a PP |
590 | if (trimmer_comp->begin.is_set && trimmer_comp->end.is_set) { |
591 | /* validate_trimmer_bounds() logs errors */ | |
90a55a4e SM |
592 | if (validate_trimmer_bounds(trimmer_comp, |
593 | &trimmer_comp->begin, &trimmer_comp->end)) { | |
594 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
595 | goto end; | |
596 | } | |
55595636 | 597 | } |
7de0e49a | 598 | |
90a55a4e SM |
599 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; |
600 | ||
601 | end: | |
602 | g_free(validate_error); | |
603 | ||
604 | return status; | |
44d3cbf0 JG |
605 | } |
606 | ||
21a9f056 | 607 | bt_component_class_initialize_method_status trimmer_init( |
d24d5663 | 608 | bt_self_component_filter *self_comp_flt, |
59225a3e | 609 | bt_self_component_filter_configuration *config, |
7de0e49a | 610 | const bt_value *params, void *init_data) |
cab3f160 | 611 | { |
90a55a4e | 612 | bt_component_class_initialize_method_status status; |
d24d5663 | 613 | bt_self_component_add_port_status add_port_status; |
7de0e49a | 614 | struct trimmer_comp *trimmer_comp = create_trimmer_comp(); |
ec4ae660 PP |
615 | bt_self_component *self_comp = |
616 | bt_self_component_filter_as_self_component(self_comp_flt); | |
90a55a4e | 617 | |
7de0e49a | 618 | if (!trimmer_comp) { |
21a9f056 | 619 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
7de0e49a | 620 | goto error; |
cab3f160 JG |
621 | } |
622 | ||
0d9a3d3e | 623 | trimmer_comp->log_level = bt_component_get_logging_level( |
ec4ae660 PP |
624 | bt_self_component_as_component(self_comp)); |
625 | trimmer_comp->self_comp = self_comp; | |
90a55a4e | 626 | |
d24d5663 | 627 | add_port_status = bt_self_component_filter_add_input_port( |
ec4ae660 | 628 | self_comp_flt, in_port_name, NULL, NULL); |
90a55a4e SM |
629 | if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) { |
630 | status = (int) add_port_status; | |
d24d5663 | 631 | goto error; |
b9d103be PP |
632 | } |
633 | ||
d24d5663 | 634 | add_port_status = bt_self_component_filter_add_output_port( |
ec4ae660 | 635 | self_comp_flt, "out", NULL, NULL); |
90a55a4e SM |
636 | if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) { |
637 | status = (int) add_port_status; | |
d24d5663 | 638 | goto error; |
b9d103be PP |
639 | } |
640 | ||
90a55a4e SM |
641 | status = init_trimmer_comp_from_params(trimmer_comp, params); |
642 | if (status != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) { | |
cab3f160 JG |
643 | goto error; |
644 | } | |
645 | ||
ec4ae660 | 646 | bt_self_component_set_data(self_comp, trimmer_comp); |
90a55a4e SM |
647 | |
648 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; | |
7de0e49a PP |
649 | goto end; |
650 | ||
651 | error: | |
7de0e49a PP |
652 | if (trimmer_comp) { |
653 | destroy_trimmer_comp(trimmer_comp); | |
654 | } | |
655 | ||
cab3f160 | 656 | end: |
8dad9b32 | 657 | return status; |
7de0e49a PP |
658 | } |
659 | ||
660 | static | |
661 | void destroy_trimmer_iterator(struct trimmer_iterator *trimmer_it) | |
662 | { | |
e803df70 SM |
663 | if (!trimmer_it) { |
664 | goto end; | |
665 | } | |
666 | ||
7de0e49a PP |
667 | bt_self_component_port_input_message_iterator_put_ref( |
668 | trimmer_it->upstream_iter); | |
669 | ||
670 | if (trimmer_it->output_messages) { | |
671 | g_queue_free(trimmer_it->output_messages); | |
672 | } | |
673 | ||
674 | if (trimmer_it->stream_states) { | |
675 | g_hash_table_destroy(trimmer_it->stream_states); | |
676 | } | |
677 | ||
678 | g_free(trimmer_it); | |
e803df70 SM |
679 | end: |
680 | return; | |
7de0e49a PP |
681 | } |
682 | ||
683 | static | |
684 | void destroy_trimmer_iterator_stream_state( | |
685 | struct trimmer_iterator_stream_state *sstate) | |
686 | { | |
687 | BT_ASSERT(sstate); | |
688 | BT_PACKET_PUT_REF_AND_RESET(sstate->cur_packet); | |
7de0e49a PP |
689 | g_free(sstate); |
690 | } | |
691 | ||
692 | BT_HIDDEN | |
21a9f056 | 693 | bt_component_class_message_iterator_initialize_method_status trimmer_msg_iter_init( |
7de0e49a | 694 | bt_self_message_iterator *self_msg_iter, |
8d8b141d | 695 | bt_self_message_iterator_configuration *config, |
7de0e49a PP |
696 | bt_self_component_filter *self_comp, |
697 | bt_self_component_port_output *port) | |
698 | { | |
21a9f056 | 699 | bt_component_class_message_iterator_initialize_method_status status; |
e803df70 SM |
700 | bt_self_component_port_input_message_iterator_create_from_message_iterator_status |
701 | msg_iter_status; | |
7de0e49a PP |
702 | struct trimmer_iterator *trimmer_it; |
703 | ||
704 | trimmer_it = g_new0(struct trimmer_iterator, 1); | |
705 | if (!trimmer_it) { | |
21a9f056 | 706 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
e803df70 | 707 | goto error; |
7de0e49a PP |
708 | } |
709 | ||
710 | trimmer_it->trimmer_comp = bt_self_component_get_data( | |
711 | bt_self_component_filter_as_self_component(self_comp)); | |
712 | BT_ASSERT(trimmer_it->trimmer_comp); | |
713 | ||
714 | if (trimmer_it->trimmer_comp->begin.is_set && | |
715 | trimmer_it->trimmer_comp->end.is_set) { | |
716 | /* | |
717 | * Both trimming time range's bounds are set, so skip | |
718 | * the | |
719 | * `TRIMMER_ITERATOR_STATE_SET_BOUNDS_NS_FROM_ORIGIN` | |
720 | * phase. | |
721 | */ | |
722 | trimmer_it->state = TRIMMER_ITERATOR_STATE_SEEK_INITIALLY; | |
723 | } | |
724 | ||
725 | trimmer_it->begin = trimmer_it->trimmer_comp->begin; | |
726 | trimmer_it->end = trimmer_it->trimmer_comp->end; | |
e803df70 | 727 | msg_iter_status = |
ca02df0a PP |
728 | bt_self_component_port_input_message_iterator_create_from_message_iterator( |
729 | self_msg_iter, | |
7de0e49a | 730 | bt_self_component_filter_borrow_input_port_by_name( |
e803df70 SM |
731 | self_comp, in_port_name), &trimmer_it->upstream_iter); |
732 | if (msg_iter_status != BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK) { | |
733 | status = (int) msg_iter_status; | |
734 | goto error; | |
7de0e49a PP |
735 | } |
736 | ||
737 | trimmer_it->output_messages = g_queue_new(); | |
738 | if (!trimmer_it->output_messages) { | |
21a9f056 | 739 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
e803df70 | 740 | goto error; |
7de0e49a PP |
741 | } |
742 | ||
743 | trimmer_it->stream_states = g_hash_table_new_full(g_direct_hash, | |
744 | g_direct_equal, NULL, | |
745 | (GDestroyNotify) destroy_trimmer_iterator_stream_state); | |
746 | if (!trimmer_it->stream_states) { | |
21a9f056 | 747 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
e803df70 | 748 | goto error; |
7de0e49a PP |
749 | } |
750 | ||
c0e46a7c SM |
751 | /* |
752 | * The trimmer requires upstream messages to have times, so it can | |
753 | * always seek forward. | |
754 | */ | |
755 | bt_self_message_iterator_configuration_set_can_seek_forward( | |
756 | config, BT_TRUE); | |
757 | ||
7de0e49a PP |
758 | trimmer_it->self_msg_iter = self_msg_iter; |
759 | bt_self_message_iterator_set_data(self_msg_iter, trimmer_it); | |
760 | ||
21a9f056 | 761 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK; |
e803df70 SM |
762 | goto end; |
763 | ||
764 | error: | |
765 | destroy_trimmer_iterator(trimmer_it); | |
7de0e49a | 766 | |
e803df70 | 767 | end: |
7de0e49a PP |
768 | return status; |
769 | } | |
770 | ||
771 | static inline | |
772 | int get_msg_ns_from_origin(const bt_message *msg, int64_t *ns_from_origin, | |
188edac1 | 773 | bool *has_clock_snapshot) |
7de0e49a PP |
774 | { |
775 | const bt_clock_class *clock_class = NULL; | |
776 | const bt_clock_snapshot *clock_snapshot = NULL; | |
7de0e49a PP |
777 | int ret = 0; |
778 | ||
779 | BT_ASSERT(msg); | |
780 | BT_ASSERT(ns_from_origin); | |
188edac1 | 781 | BT_ASSERT(has_clock_snapshot); |
7de0e49a PP |
782 | |
783 | switch (bt_message_get_type(msg)) { | |
784 | case BT_MESSAGE_TYPE_EVENT: | |
785 | clock_class = | |
786 | bt_message_event_borrow_stream_class_default_clock_class_const( | |
787 | msg); | |
91d81473 | 788 | if (G_UNLIKELY(!clock_class)) { |
7de0e49a PP |
789 | goto error; |
790 | } | |
791 | ||
0cbc2c33 PP |
792 | clock_snapshot = bt_message_event_borrow_default_clock_snapshot_const( |
793 | msg); | |
7de0e49a PP |
794 | break; |
795 | case BT_MESSAGE_TYPE_PACKET_BEGINNING: | |
796 | clock_class = | |
797 | bt_message_packet_beginning_borrow_stream_class_default_clock_class_const( | |
798 | msg); | |
91d81473 | 799 | if (G_UNLIKELY(!clock_class)) { |
7de0e49a PP |
800 | goto error; |
801 | } | |
802 | ||
0cbc2c33 PP |
803 | clock_snapshot = bt_message_packet_beginning_borrow_default_clock_snapshot_const( |
804 | msg); | |
7de0e49a PP |
805 | break; |
806 | case BT_MESSAGE_TYPE_PACKET_END: | |
807 | clock_class = | |
808 | bt_message_packet_end_borrow_stream_class_default_clock_class_const( | |
809 | msg); | |
91d81473 | 810 | if (G_UNLIKELY(!clock_class)) { |
7de0e49a PP |
811 | goto error; |
812 | } | |
813 | ||
0cbc2c33 PP |
814 | clock_snapshot = bt_message_packet_end_borrow_default_clock_snapshot_const( |
815 | msg); | |
7de0e49a | 816 | break; |
188edac1 SM |
817 | case BT_MESSAGE_TYPE_STREAM_BEGINNING: |
818 | { | |
819 | enum bt_message_stream_clock_snapshot_state cs_state; | |
820 | ||
7de0e49a | 821 | clock_class = |
188edac1 | 822 | bt_message_stream_beginning_borrow_stream_class_default_clock_class_const(msg); |
91d81473 | 823 | if (G_UNLIKELY(!clock_class)) { |
7de0e49a PP |
824 | goto error; |
825 | } | |
826 | ||
188edac1 SM |
827 | cs_state = bt_message_stream_beginning_borrow_default_clock_snapshot_const(msg, &clock_snapshot); |
828 | if (cs_state != BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) { | |
829 | goto no_clock_snapshot; | |
7de0e49a PP |
830 | } |
831 | ||
7de0e49a | 832 | break; |
188edac1 SM |
833 | } |
834 | case BT_MESSAGE_TYPE_STREAM_END: | |
835 | { | |
836 | enum bt_message_stream_clock_snapshot_state cs_state; | |
837 | ||
7de0e49a | 838 | clock_class = |
188edac1 | 839 | bt_message_stream_end_borrow_stream_class_default_clock_class_const(msg); |
91d81473 | 840 | if (G_UNLIKELY(!clock_class)) { |
7de0e49a PP |
841 | goto error; |
842 | } | |
843 | ||
188edac1 SM |
844 | cs_state = bt_message_stream_end_borrow_default_clock_snapshot_const(msg, &clock_snapshot); |
845 | if (cs_state != BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) { | |
7de0e49a PP |
846 | goto no_clock_snapshot; |
847 | } | |
848 | ||
849 | break; | |
188edac1 SM |
850 | } |
851 | case BT_MESSAGE_TYPE_DISCARDED_EVENTS: | |
7de0e49a | 852 | clock_class = |
188edac1 | 853 | bt_message_discarded_events_borrow_stream_class_default_clock_class_const( |
7de0e49a | 854 | msg); |
91d81473 | 855 | if (G_UNLIKELY(!clock_class)) { |
7de0e49a PP |
856 | goto error; |
857 | } | |
858 | ||
188edac1 SM |
859 | clock_snapshot = bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const( |
860 | msg); | |
861 | break; | |
862 | case BT_MESSAGE_TYPE_DISCARDED_PACKETS: | |
863 | clock_class = | |
864 | bt_message_discarded_packets_borrow_stream_class_default_clock_class_const( | |
865 | msg); | |
866 | if (G_UNLIKELY(!clock_class)) { | |
867 | goto error; | |
7de0e49a PP |
868 | } |
869 | ||
188edac1 SM |
870 | clock_snapshot = bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const( |
871 | msg); | |
7de0e49a PP |
872 | break; |
873 | case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY: | |
0cbc2c33 | 874 | clock_snapshot = |
7de0e49a | 875 | bt_message_message_iterator_inactivity_borrow_default_clock_snapshot_const( |
0cbc2c33 | 876 | msg); |
7de0e49a PP |
877 | break; |
878 | default: | |
879 | goto no_clock_snapshot; | |
880 | } | |
881 | ||
7de0e49a PP |
882 | ret = bt_clock_snapshot_get_ns_from_origin(clock_snapshot, |
883 | ns_from_origin); | |
91d81473 | 884 | if (G_UNLIKELY(ret)) { |
7de0e49a PP |
885 | goto error; |
886 | } | |
887 | ||
188edac1 | 888 | *has_clock_snapshot = true; |
7de0e49a PP |
889 | goto end; |
890 | ||
891 | no_clock_snapshot: | |
188edac1 | 892 | *has_clock_snapshot = false; |
7de0e49a PP |
893 | goto end; |
894 | ||
cab3f160 | 895 | error: |
7de0e49a PP |
896 | ret = -1; |
897 | ||
898 | end: | |
899 | return ret; | |
900 | } | |
901 | ||
902 | static inline | |
903 | void put_messages(bt_message_array_const msgs, uint64_t count) | |
904 | { | |
905 | uint64_t i; | |
906 | ||
907 | for (i = 0; i < count; i++) { | |
908 | BT_MESSAGE_PUT_REF_AND_RESET(msgs[i]); | |
909 | } | |
910 | } | |
911 | ||
912 | static inline | |
0d9a3d3e PP |
913 | int set_trimmer_iterator_bound(struct trimmer_iterator *trimmer_it, |
914 | struct trimmer_bound *bound, int64_t ns_from_origin, | |
915 | bool is_gmt) | |
7de0e49a | 916 | { |
0d9a3d3e | 917 | struct trimmer_comp *trimmer_comp = trimmer_it->trimmer_comp; |
7de0e49a | 918 | struct tm tm; |
53a42a43 | 919 | struct tm *res; |
7de0e49a PP |
920 | time_t time_seconds = (time_t) (ns_from_origin / NS_PER_S); |
921 | int ret = 0; | |
922 | ||
923 | BT_ASSERT(!bound->is_set); | |
924 | errno = 0; | |
925 | ||
926 | /* We only need to extract the date from this time */ | |
927 | if (is_gmt) { | |
53a42a43 | 928 | res = bt_gmtime_r(&time_seconds, &tm); |
7de0e49a | 929 | } else { |
53a42a43 | 930 | res = bt_localtime_r(&time_seconds, &tm); |
7de0e49a PP |
931 | } |
932 | ||
53a42a43 | 933 | if (!res) { |
ab90ee94 SM |
934 | BT_COMP_LOGE_APPEND_CAUSE_ERRNO(trimmer_comp->self_comp, |
935 | "Cannot convert timestamp to date and time", | |
f42489db | 936 | ": ts=%" PRId64, (int64_t) time_seconds); |
7de0e49a PP |
937 | ret = -1; |
938 | goto end; | |
939 | } | |
940 | ||
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); | |
944 | ||
945 | end: | |
cab3f160 JG |
946 | return ret; |
947 | } | |
7de0e49a PP |
948 | |
949 | static | |
d24d5663 PP |
950 | bt_component_class_message_iterator_next_method_status |
951 | state_set_trimmer_iterator_bounds( | |
7de0e49a PP |
952 | struct trimmer_iterator *trimmer_it) |
953 | { | |
d24d5663 | 954 | bt_message_iterator_next_status upstream_iter_status = |
9275bef4 | 955 | BT_MESSAGE_ITERATOR_NEXT_STATUS_OK; |
7de0e49a PP |
956 | struct trimmer_comp *trimmer_comp = trimmer_it->trimmer_comp; |
957 | bt_message_array_const msgs; | |
958 | uint64_t count = 0; | |
959 | int64_t ns_from_origin = INT64_MIN; | |
960 | uint64_t i; | |
961 | int ret; | |
962 | ||
963 | BT_ASSERT(!trimmer_it->begin.is_set || | |
964 | !trimmer_it->end.is_set); | |
965 | ||
966 | while (true) { | |
967 | upstream_iter_status = | |
968 | bt_self_component_port_input_message_iterator_next( | |
969 | trimmer_it->upstream_iter, &msgs, &count); | |
d24d5663 | 970 | if (upstream_iter_status != BT_MESSAGE_ITERATOR_NEXT_STATUS_OK) { |
7de0e49a PP |
971 | goto end; |
972 | } | |
973 | ||
974 | for (i = 0; i < count; i++) { | |
975 | const bt_message *msg = msgs[i]; | |
188edac1 | 976 | bool has_ns_from_origin; |
7de0e49a PP |
977 | int ret; |
978 | ||
979 | ret = get_msg_ns_from_origin(msg, &ns_from_origin, | |
188edac1 | 980 | &has_ns_from_origin); |
7de0e49a PP |
981 | if (ret) { |
982 | goto error; | |
983 | } | |
984 | ||
188edac1 | 985 | if (!has_ns_from_origin) { |
7de0e49a PP |
986 | continue; |
987 | } | |
988 | ||
989 | BT_ASSERT(ns_from_origin != INT64_MIN && | |
990 | ns_from_origin != INT64_MAX); | |
991 | put_messages(msgs, count); | |
992 | goto found; | |
993 | } | |
994 | ||
995 | put_messages(msgs, count); | |
996 | } | |
997 | ||
998 | found: | |
999 | if (!trimmer_it->begin.is_set) { | |
1000 | BT_ASSERT(!trimmer_it->begin.is_infinite); | |
0d9a3d3e | 1001 | ret = set_trimmer_iterator_bound(trimmer_it, &trimmer_it->begin, |
7de0e49a PP |
1002 | ns_from_origin, trimmer_comp->is_gmt); |
1003 | if (ret) { | |
1004 | goto error; | |
1005 | } | |
1006 | } | |
1007 | ||
1008 | if (!trimmer_it->end.is_set) { | |
1009 | BT_ASSERT(!trimmer_it->end.is_infinite); | |
0d9a3d3e | 1010 | ret = set_trimmer_iterator_bound(trimmer_it, &trimmer_it->end, |
7de0e49a PP |
1011 | ns_from_origin, trimmer_comp->is_gmt); |
1012 | if (ret) { | |
1013 | goto error; | |
1014 | } | |
1015 | } | |
1016 | ||
0d9a3d3e PP |
1017 | ret = validate_trimmer_bounds(trimmer_it->trimmer_comp, |
1018 | &trimmer_it->begin, &trimmer_it->end); | |
7de0e49a PP |
1019 | if (ret) { |
1020 | goto error; | |
1021 | } | |
1022 | ||
1023 | goto end; | |
1024 | ||
1025 | error: | |
1026 | put_messages(msgs, count); | |
9275bef4 | 1027 | upstream_iter_status = BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR; |
7de0e49a PP |
1028 | |
1029 | end: | |
1030 | return (int) upstream_iter_status; | |
1031 | } | |
1032 | ||
1033 | static | |
d24d5663 | 1034 | bt_component_class_message_iterator_next_method_status state_seek_initially( |
7de0e49a PP |
1035 | struct trimmer_iterator *trimmer_it) |
1036 | { | |
0d9a3d3e | 1037 | struct trimmer_comp *trimmer_comp = trimmer_it->trimmer_comp; |
f2fb1b32 | 1038 | bt_component_class_message_iterator_next_method_status status; |
7de0e49a PP |
1039 | |
1040 | BT_ASSERT(trimmer_it->begin.is_set); | |
1041 | ||
1042 | if (trimmer_it->begin.is_infinite) { | |
f2fb1b32 SM |
1043 | bt_bool can_seek; |
1044 | ||
1045 | status = (int) bt_self_component_port_input_message_iterator_can_seek_beginning( | |
1046 | trimmer_it->upstream_iter, &can_seek); | |
1047 | if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { | |
1048 | if (status < 0) { | |
1049 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, | |
1050 | "Cannot make upstream message iterator initially seek its beginning."); | |
1051 | } | |
1052 | ||
1053 | goto end; | |
1054 | } | |
1055 | ||
1056 | if (!can_seek) { | |
ab90ee94 SM |
1057 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, |
1058 | "Cannot make upstream message iterator initially seek its beginning."); | |
d24d5663 | 1059 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; |
7de0e49a PP |
1060 | goto end; |
1061 | } | |
1062 | ||
1063 | status = (int) bt_self_component_port_input_message_iterator_seek_beginning( | |
1064 | trimmer_it->upstream_iter); | |
1065 | } else { | |
f2fb1b32 SM |
1066 | bt_bool can_seek; |
1067 | ||
1068 | status = (int) bt_self_component_port_input_message_iterator_can_seek_ns_from_origin( | |
1069 | trimmer_it->upstream_iter, trimmer_it->begin.ns_from_origin, | |
1070 | &can_seek); | |
1071 | ||
1072 | if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { | |
1073 | if (status < 0) { | |
1074 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, | |
1075 | "Cannot make upstream message iterator initially seek: seek-ns-from-origin=%" PRId64, | |
1076 | trimmer_it->begin.ns_from_origin); | |
1077 | } | |
1078 | ||
1079 | goto end; | |
1080 | } | |
1081 | ||
1082 | if (!can_seek) { | |
ab90ee94 SM |
1083 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, |
1084 | "Cannot make upstream message iterator initially seek: seek-ns-from-origin=%" PRId64, | |
7de0e49a | 1085 | trimmer_it->begin.ns_from_origin); |
d24d5663 | 1086 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; |
7de0e49a PP |
1087 | goto end; |
1088 | } | |
1089 | ||
1090 | status = (int) bt_self_component_port_input_message_iterator_seek_ns_from_origin( | |
1091 | trimmer_it->upstream_iter, trimmer_it->begin.ns_from_origin); | |
1092 | } | |
1093 | ||
d24d5663 | 1094 | if (status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
7de0e49a PP |
1095 | trimmer_it->state = TRIMMER_ITERATOR_STATE_TRIM; |
1096 | } | |
1097 | ||
1098 | end: | |
1099 | return status; | |
1100 | } | |
1101 | ||
1102 | static inline | |
1103 | void push_message(struct trimmer_iterator *trimmer_it, const bt_message *msg) | |
1104 | { | |
1105 | g_queue_push_head(trimmer_it->output_messages, (void *) msg); | |
1106 | } | |
1107 | ||
1108 | static inline | |
1109 | const bt_message *pop_message(struct trimmer_iterator *trimmer_it) | |
1110 | { | |
1111 | return g_queue_pop_tail(trimmer_it->output_messages); | |
1112 | } | |
1113 | ||
1114 | static inline | |
1115 | int clock_raw_value_from_ns_from_origin(const bt_clock_class *clock_class, | |
1116 | int64_t ns_from_origin, uint64_t *raw_value) | |
1117 | { | |
1118 | ||
1119 | int64_t cc_offset_s; | |
1120 | uint64_t cc_offset_cycles; | |
1121 | uint64_t cc_freq; | |
1122 | ||
1123 | bt_clock_class_get_offset(clock_class, &cc_offset_s, &cc_offset_cycles); | |
1124 | cc_freq = bt_clock_class_get_frequency(clock_class); | |
1125 | return bt_common_clock_value_from_ns_from_origin(cc_offset_s, | |
1126 | cc_offset_cycles, cc_freq, ns_from_origin, raw_value); | |
1127 | } | |
1128 | ||
1129 | static inline | |
d24d5663 PP |
1130 | bt_component_class_message_iterator_next_method_status |
1131 | end_stream(struct trimmer_iterator *trimmer_it, | |
7de0e49a PP |
1132 | struct trimmer_iterator_stream_state *sstate) |
1133 | { | |
d24d5663 PP |
1134 | bt_component_class_message_iterator_next_method_status status = |
1135 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; | |
188edac1 SM |
1136 | /* Initialize to silence maybe-uninitialized warning. */ |
1137 | uint64_t raw_value = 0; | |
7de0e49a PP |
1138 | bt_message *msg = NULL; |
1139 | ||
1140 | BT_ASSERT(!trimmer_it->end.is_infinite); | |
188edac1 | 1141 | BT_ASSERT(sstate->stream); |
7de0e49a | 1142 | |
188edac1 SM |
1143 | /* |
1144 | * If we haven't seen a message with a clock snapshot, we don't know if the trimmer's end bound is within | |
1145 | * the clock's range, so it wouldn't be safe to try to convert ns_from_origin to a clock value. | |
1146 | * | |
1147 | * Also, it would be a bit of a lie to generate a stream end message with the end bound as its | |
1148 | * clock snapshot, because we don't really know if the stream existed at that time. If we have | |
1149 | * seen a message with a clock snapshot and the stream is cut short by another message with a | |
1150 | * clock snapshot, then we are sure that the the end bound time is not below the clock range, | |
1151 | * and we know the stream was active at that time (and that we cut it short). | |
1152 | */ | |
1153 | if (sstate->seen_clock_snapshot) { | |
1154 | const bt_clock_class *clock_class; | |
1155 | int ret; | |
7de0e49a | 1156 | |
7de0e49a PP |
1157 | clock_class = bt_stream_class_borrow_default_clock_class_const( |
1158 | bt_stream_borrow_class_const(sstate->stream)); | |
1159 | BT_ASSERT(clock_class); | |
1160 | ret = clock_raw_value_from_ns_from_origin(clock_class, | |
1161 | trimmer_it->end.ns_from_origin, &raw_value); | |
1162 | if (ret) { | |
d24d5663 | 1163 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; |
7de0e49a PP |
1164 | goto end; |
1165 | } | |
188edac1 SM |
1166 | } |
1167 | ||
1168 | if (sstate->cur_packet) { | |
1169 | /* | |
1170 | * Create and push a packet end message, making its time | |
1171 | * the trimming range's end time. | |
1172 | * | |
1173 | * We know that we must have seen a clock snapshot, the one in | |
1174 | * the packet beginning message, since trimmer currently | |
1175 | * requires packet messages to have clock snapshots (see comment | |
1176 | * in create_stream_state_entry). | |
1177 | */ | |
1178 | BT_ASSERT(sstate->seen_clock_snapshot); | |
7de0e49a PP |
1179 | |
1180 | msg = bt_message_packet_end_create_with_default_clock_snapshot( | |
1181 | trimmer_it->self_msg_iter, sstate->cur_packet, | |
1182 | raw_value); | |
1183 | if (!msg) { | |
d24d5663 | 1184 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR; |
7de0e49a PP |
1185 | goto end; |
1186 | } | |
1187 | ||
1188 | push_message(trimmer_it, msg); | |
1189 | msg = NULL; | |
1190 | BT_PACKET_PUT_REF_AND_RESET(sstate->cur_packet); | |
7de0e49a PP |
1191 | } |
1192 | ||
188edac1 | 1193 | /* Create and push a stream end message. */ |
7de0e49a PP |
1194 | msg = bt_message_stream_end_create(trimmer_it->self_msg_iter, |
1195 | sstate->stream); | |
1196 | if (!msg) { | |
d24d5663 | 1197 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR; |
7de0e49a PP |
1198 | goto end; |
1199 | } | |
1200 | ||
188edac1 SM |
1201 | if (sstate->seen_clock_snapshot) { |
1202 | bt_message_stream_end_set_default_clock_snapshot(msg, raw_value); | |
1203 | } | |
1204 | ||
7de0e49a PP |
1205 | push_message(trimmer_it, msg); |
1206 | msg = NULL; | |
1207 | ||
1208 | /* | |
1209 | * Just to make sure that we don't use this stream state again | |
1210 | * in the future without an obvious error. | |
1211 | */ | |
1212 | sstate->stream = NULL; | |
1213 | ||
1214 | end: | |
1215 | bt_message_put_ref(msg); | |
1216 | return status; | |
1217 | } | |
1218 | ||
1219 | static inline | |
d24d5663 | 1220 | bt_component_class_message_iterator_next_method_status end_iterator_streams( |
7de0e49a PP |
1221 | struct trimmer_iterator *trimmer_it) |
1222 | { | |
d24d5663 PP |
1223 | bt_component_class_message_iterator_next_method_status status = |
1224 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; | |
7de0e49a PP |
1225 | GHashTableIter iter; |
1226 | gpointer key, sstate; | |
1227 | ||
1228 | if (trimmer_it->end.is_infinite) { | |
1229 | /* | |
1230 | * An infinite trimming range's end time guarantees that | |
1231 | * we received (and pushed) all the appropriate end | |
1232 | * messages. | |
1233 | */ | |
1234 | goto remove_all; | |
1235 | } | |
1236 | ||
1237 | /* | |
1238 | * End each stream and then remove them from the hash table of | |
1239 | * stream states to release unneeded references. | |
1240 | */ | |
1241 | g_hash_table_iter_init(&iter, trimmer_it->stream_states); | |
1242 | ||
1243 | while (g_hash_table_iter_next(&iter, &key, &sstate)) { | |
1244 | status = end_stream(trimmer_it, sstate); | |
1245 | if (status) { | |
1246 | goto end; | |
1247 | } | |
1248 | } | |
1249 | ||
1250 | remove_all: | |
1251 | g_hash_table_remove_all(trimmer_it->stream_states); | |
1252 | ||
1253 | end: | |
1254 | return status; | |
1255 | } | |
1256 | ||
188edac1 SM |
1257 | static |
1258 | bt_component_class_message_iterator_next_method_status | |
1259 | create_stream_state_entry( | |
1260 | struct trimmer_iterator *trimmer_it, | |
1261 | const struct bt_stream *stream, | |
1262 | struct trimmer_iterator_stream_state **stream_state) | |
1263 | { | |
1264 | struct trimmer_comp *trimmer_comp = trimmer_it->trimmer_comp; | |
1265 | bt_component_class_message_iterator_next_method_status status; | |
1266 | struct trimmer_iterator_stream_state *sstate; | |
1267 | const bt_stream_class *sc; | |
1268 | ||
1269 | BT_ASSERT(!bt_g_hash_table_contains(trimmer_it->stream_states, stream)); | |
1270 | ||
1271 | /* | |
1272 | * Validate right now that the stream's class | |
1273 | * has a registered default clock class so that | |
1274 | * an existing stream state guarantees existing | |
1275 | * default clock snapshots for its associated | |
1276 | * messages. | |
1277 | * | |
1278 | * Also check that clock snapshots are always | |
1279 | * known. | |
1280 | */ | |
1281 | sc = bt_stream_borrow_class_const(stream); | |
1282 | if (!bt_stream_class_borrow_default_clock_class_const(sc)) { | |
ab90ee94 SM |
1283 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, |
1284 | "Unsupported stream: stream class does " | |
188edac1 SM |
1285 | "not have a default clock class: " |
1286 | "stream-addr=%p, " | |
1287 | "stream-id=%" PRIu64 ", " | |
1288 | "stream-name=\"%s\"", | |
1289 | stream, bt_stream_get_id(stream), | |
1290 | bt_stream_get_name(stream)); | |
1291 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; | |
1292 | goto end; | |
1293 | } | |
1294 | ||
1295 | /* | |
1296 | * Temporary: make sure packet beginning, packet | |
1297 | * end, discarded events, and discarded packets | |
1298 | * messages have default clock snapshots until | |
1299 | * the support for not having them is | |
1300 | * implemented. | |
1301 | */ | |
1302 | if (!bt_stream_class_packets_have_beginning_default_clock_snapshot( | |
1303 | sc)) { | |
ab90ee94 SM |
1304 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, |
1305 | "Unsupported stream: packets have no beginning clock snapshot: " | |
188edac1 SM |
1306 | "stream-addr=%p, " |
1307 | "stream-id=%" PRIu64 ", " | |
1308 | "stream-name=\"%s\"", | |
1309 | stream, bt_stream_get_id(stream), | |
1310 | bt_stream_get_name(stream)); | |
1311 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; | |
1312 | goto end; | |
1313 | } | |
1314 | ||
1315 | if (!bt_stream_class_packets_have_end_default_clock_snapshot( | |
1316 | sc)) { | |
ab90ee94 SM |
1317 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, |
1318 | "Unsupported stream: packets have no end clock snapshot: " | |
188edac1 SM |
1319 | "stream-addr=%p, " |
1320 | "stream-id=%" PRIu64 ", " | |
1321 | "stream-name=\"%s\"", | |
1322 | stream, bt_stream_get_id(stream), | |
1323 | bt_stream_get_name(stream)); | |
1324 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; | |
1325 | goto end; | |
1326 | } | |
1327 | ||
1328 | if (bt_stream_class_supports_discarded_events(sc) && | |
1329 | !bt_stream_class_discarded_events_have_default_clock_snapshots(sc)) { | |
ab90ee94 SM |
1330 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, |
1331 | "Unsupported stream: discarded events have no clock snapshots: " | |
188edac1 SM |
1332 | "stream-addr=%p, " |
1333 | "stream-id=%" PRIu64 ", " | |
1334 | "stream-name=\"%s\"", | |
1335 | stream, bt_stream_get_id(stream), | |
1336 | bt_stream_get_name(stream)); | |
1337 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; | |
1338 | goto end; | |
1339 | } | |
1340 | ||
1341 | if (bt_stream_class_supports_discarded_packets(sc) && | |
1342 | !bt_stream_class_discarded_packets_have_default_clock_snapshots(sc)) { | |
ab90ee94 SM |
1343 | BT_COMP_LOGE_APPEND_CAUSE(trimmer_comp->self_comp, |
1344 | "Unsupported stream: discarded packets " | |
188edac1 SM |
1345 | "have no clock snapshots: " |
1346 | "stream-addr=%p, " | |
1347 | "stream-id=%" PRIu64 ", " | |
1348 | "stream-name=\"%s\"", | |
1349 | stream, bt_stream_get_id(stream), | |
1350 | bt_stream_get_name(stream)); | |
1351 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; | |
1352 | goto end; | |
1353 | } | |
1354 | ||
1355 | sstate = g_new0(struct trimmer_iterator_stream_state, 1); | |
1356 | if (!sstate) { | |
1357 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR; | |
1358 | goto end; | |
1359 | } | |
1360 | ||
1361 | sstate->stream = stream; | |
1362 | ||
1363 | g_hash_table_insert(trimmer_it->stream_states, (void *) stream, sstate); | |
1364 | ||
1365 | *stream_state = sstate; | |
1366 | ||
1367 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; | |
1368 | ||
1369 | end: | |
1370 | return status; | |
1371 | } | |
1372 | ||
1373 | static | |
1374 | struct trimmer_iterator_stream_state *get_stream_state_entry( | |
1375 | struct trimmer_iterator *trimmer_it, | |
1376 | const struct bt_stream *stream) | |
1377 | { | |
1378 | struct trimmer_iterator_stream_state *sstate; | |
1379 | ||
1380 | BT_ASSERT(stream); | |
1381 | sstate = g_hash_table_lookup(trimmer_it->stream_states, stream); | |
1382 | BT_ASSERT(sstate); | |
1383 | ||
1384 | return sstate; | |
1385 | } | |
1386 | ||
7de0e49a PP |
1387 | /* |
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. | |
1392 | * | |
1393 | * This function consumes the `msg` reference, _whatever the outcome_. | |
1394 | * | |
188edac1 SM |
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. | |
7de0e49a PP |
1397 | * |
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 | |
1401 | * `reached_end`. | |
1402 | */ | |
188edac1 | 1403 | static |
d24d5663 | 1404 | bt_component_class_message_iterator_next_method_status |
188edac1 | 1405 | handle_message_with_stream( |
7de0e49a | 1406 | struct trimmer_iterator *trimmer_it, const bt_message *msg, |
188edac1 SM |
1407 | const struct bt_stream *stream, const int64_t *ns_from_origin, |
1408 | bool *reached_end) | |
7de0e49a | 1409 | { |
d24d5663 PP |
1410 | bt_component_class_message_iterator_next_method_status status = |
1411 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; | |
7de0e49a PP |
1412 | bt_message_type msg_type = bt_message_get_type(msg); |
1413 | int ret; | |
188edac1 SM |
1414 | struct trimmer_iterator_stream_state *sstate = NULL; |
1415 | ||
1416 | /* | |
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. | |
1419 | */ | |
1420 | if (msg_type != BT_MESSAGE_TYPE_STREAM_BEGINNING) { | |
1421 | sstate = get_stream_state_entry(trimmer_it, stream); | |
1422 | } | |
7de0e49a PP |
1423 | |
1424 | switch (msg_type) { | |
1425 | case BT_MESSAGE_TYPE_EVENT: | |
188edac1 SM |
1426 | /* |
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. | |
1430 | */ | |
1431 | BT_ASSERT(ns_from_origin); | |
188edac1 | 1432 | |
91d81473 | 1433 | if (G_UNLIKELY(!trimmer_it->end.is_infinite && |
188edac1 | 1434 | *ns_from_origin > trimmer_it->end.ns_from_origin)) { |
7de0e49a PP |
1435 | status = end_iterator_streams(trimmer_it); |
1436 | *reached_end = true; | |
1437 | break; | |
1438 | } | |
1439 | ||
188edac1 SM |
1440 | sstate->seen_clock_snapshot = true; |
1441 | ||
7de0e49a PP |
1442 | push_message(trimmer_it, msg); |
1443 | msg = NULL; | |
1444 | break; | |
188edac1 | 1445 | |
7de0e49a | 1446 | case BT_MESSAGE_TYPE_PACKET_BEGINNING: |
188edac1 SM |
1447 | /* |
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. | |
1451 | */ | |
1452 | BT_ASSERT(ns_from_origin); | |
1453 | BT_ASSERT(!sstate->cur_packet); | |
1454 | ||
91d81473 | 1455 | if (G_UNLIKELY(!trimmer_it->end.is_infinite && |
188edac1 | 1456 | *ns_from_origin > trimmer_it->end.ns_from_origin)) { |
7de0e49a PP |
1457 | status = end_iterator_streams(trimmer_it); |
1458 | *reached_end = true; | |
1459 | break; | |
1460 | } | |
1461 | ||
7de0e49a PP |
1462 | sstate->cur_packet = |
1463 | bt_message_packet_beginning_borrow_packet_const(msg); | |
1464 | bt_packet_get_ref(sstate->cur_packet); | |
188edac1 SM |
1465 | |
1466 | sstate->seen_clock_snapshot = true; | |
1467 | ||
7de0e49a PP |
1468 | push_message(trimmer_it, msg); |
1469 | msg = NULL; | |
1470 | break; | |
188edac1 | 1471 | |
7de0e49a | 1472 | case BT_MESSAGE_TYPE_PACKET_END: |
188edac1 SM |
1473 | /* |
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. | |
1477 | */ | |
1478 | BT_ASSERT(ns_from_origin); | |
1479 | BT_ASSERT(sstate->cur_packet); | |
7de0e49a | 1480 | |
91d81473 | 1481 | if (G_UNLIKELY(!trimmer_it->end.is_infinite && |
188edac1 | 1482 | *ns_from_origin > trimmer_it->end.ns_from_origin)) { |
7de0e49a PP |
1483 | status = end_iterator_streams(trimmer_it); |
1484 | *reached_end = true; | |
1485 | break; | |
1486 | } | |
1487 | ||
7de0e49a | 1488 | BT_PACKET_PUT_REF_AND_RESET(sstate->cur_packet); |
188edac1 SM |
1489 | |
1490 | sstate->seen_clock_snapshot = true; | |
1491 | ||
7de0e49a PP |
1492 | push_message(trimmer_it, msg); |
1493 | msg = NULL; | |
1494 | break; | |
188edac1 | 1495 | |
7de0e49a PP |
1496 | case BT_MESSAGE_TYPE_DISCARDED_EVENTS: |
1497 | case BT_MESSAGE_TYPE_DISCARDED_PACKETS: | |
1498 | { | |
1499 | /* | |
1500 | * `ns_from_origin` is the message's time range's | |
1501 | * beginning time here. | |
1502 | */ | |
1503 | int64_t end_ns_from_origin; | |
1504 | const bt_clock_snapshot *end_cs; | |
1505 | ||
188edac1 SM |
1506 | BT_ASSERT(ns_from_origin); |
1507 | ||
1508 | sstate->seen_clock_snapshot = true; | |
1509 | ||
7de0e49a PP |
1510 | if (bt_message_get_type(msg) == |
1511 | BT_MESSAGE_TYPE_DISCARDED_EVENTS) { | |
1512 | /* | |
1513 | * Safe to ignore the return value because we | |
1514 | * know there's a default clock and it's always | |
1515 | * known. | |
1516 | */ | |
9b24b6aa | 1517 | end_cs = bt_message_discarded_events_borrow_end_default_clock_snapshot_const( |
0cbc2c33 | 1518 | msg); |
7de0e49a PP |
1519 | } else { |
1520 | /* | |
1521 | * Safe to ignore the return value because we | |
1522 | * know there's a default clock and it's always | |
1523 | * known. | |
1524 | */ | |
9b24b6aa | 1525 | end_cs = bt_message_discarded_packets_borrow_end_default_clock_snapshot_const( |
0cbc2c33 | 1526 | msg); |
7de0e49a PP |
1527 | } |
1528 | ||
1529 | if (bt_clock_snapshot_get_ns_from_origin(end_cs, | |
1530 | &end_ns_from_origin)) { | |
d24d5663 | 1531 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; |
7de0e49a PP |
1532 | goto end; |
1533 | } | |
1534 | ||
7de0e49a | 1535 | if (!trimmer_it->end.is_infinite && |
188edac1 | 1536 | *ns_from_origin > trimmer_it->end.ns_from_origin) { |
7de0e49a PP |
1537 | status = end_iterator_streams(trimmer_it); |
1538 | *reached_end = true; | |
1539 | break; | |
1540 | } | |
1541 | ||
1542 | if (!trimmer_it->end.is_infinite && | |
1543 | end_ns_from_origin > trimmer_it->end.ns_from_origin) { | |
1544 | /* | |
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 | |
1549 | * count. | |
1550 | */ | |
1551 | const bt_clock_class *clock_class = | |
1552 | bt_clock_snapshot_borrow_clock_class_const( | |
1553 | end_cs); | |
1554 | const bt_clock_snapshot *begin_cs; | |
1555 | bt_message *new_msg; | |
1556 | uint64_t end_raw_value; | |
1557 | ||
1558 | ret = clock_raw_value_from_ns_from_origin(clock_class, | |
1559 | trimmer_it->end.ns_from_origin, &end_raw_value); | |
1560 | if (ret) { | |
d24d5663 | 1561 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; |
7de0e49a PP |
1562 | goto end; |
1563 | } | |
1564 | ||
1565 | if (msg_type == BT_MESSAGE_TYPE_DISCARDED_EVENTS) { | |
9b24b6aa | 1566 | begin_cs = bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const( |
0cbc2c33 | 1567 | msg); |
7de0e49a PP |
1568 | new_msg = bt_message_discarded_events_create_with_default_clock_snapshots( |
1569 | trimmer_it->self_msg_iter, | |
1570 | sstate->stream, | |
1571 | bt_clock_snapshot_get_value(begin_cs), | |
1572 | end_raw_value); | |
1573 | } else { | |
9b24b6aa | 1574 | begin_cs = bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const( |
0cbc2c33 | 1575 | msg); |
7de0e49a PP |
1576 | new_msg = bt_message_discarded_packets_create_with_default_clock_snapshots( |
1577 | trimmer_it->self_msg_iter, | |
1578 | sstate->stream, | |
1579 | bt_clock_snapshot_get_value(begin_cs), | |
1580 | end_raw_value); | |
1581 | } | |
1582 | ||
1583 | if (!new_msg) { | |
d24d5663 | 1584 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR; |
7de0e49a PP |
1585 | goto end; |
1586 | } | |
1587 | ||
1588 | /* Replace the original message */ | |
1589 | BT_MESSAGE_MOVE_REF(msg, new_msg); | |
1590 | } | |
1591 | ||
7de0e49a PP |
1592 | push_message(trimmer_it, msg); |
1593 | msg = NULL; | |
1594 | break; | |
1595 | } | |
188edac1 SM |
1596 | |
1597 | case BT_MESSAGE_TYPE_STREAM_BEGINNING: | |
1598 | /* | |
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. | |
1601 | */ | |
1602 | if (G_UNLIKELY(ns_from_origin && !trimmer_it->end.is_infinite && | |
1603 | *ns_from_origin > trimmer_it->end.ns_from_origin)) { | |
7de0e49a PP |
1604 | status = end_iterator_streams(trimmer_it); |
1605 | *reached_end = true; | |
1606 | break; | |
1607 | } | |
1608 | ||
188edac1 SM |
1609 | /* Learn about this stream. */ |
1610 | status = create_stream_state_entry(trimmer_it, stream, &sstate); | |
1611 | if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { | |
1612 | goto end; | |
7de0e49a PP |
1613 | } |
1614 | ||
188edac1 SM |
1615 | if (ns_from_origin) { |
1616 | sstate->seen_clock_snapshot = true; | |
7de0e49a PP |
1617 | } |
1618 | ||
5b7b55be SM |
1619 | push_message(trimmer_it, msg); |
1620 | msg = NULL; | |
7de0e49a PP |
1621 | break; |
1622 | case BT_MESSAGE_TYPE_STREAM_END: | |
188edac1 SM |
1623 | { |
1624 | gboolean removed; | |
1625 | ||
5b7b55be | 1626 | /* |
188edac1 SM |
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. | |
5b7b55be | 1629 | */ |
188edac1 SM |
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; | |
1634 | break; | |
7de0e49a | 1635 | } |
188edac1 SM |
1636 | |
1637 | /* | |
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. | |
1641 | */ | |
1642 | push_message(trimmer_it, msg); | |
1643 | msg = NULL; | |
1644 | ||
1645 | /* Forget about this stream. */ | |
1646 | removed = g_hash_table_remove(trimmer_it->stream_states, sstate->stream); | |
1647 | BT_ASSERT(removed); | |
7de0e49a | 1648 | break; |
188edac1 | 1649 | } |
7de0e49a PP |
1650 | default: |
1651 | break; | |
1652 | } | |
1653 | ||
1654 | end: | |
1655 | /* We release the message's reference whatever the outcome */ | |
1656 | bt_message_put_ref(msg); | |
188edac1 | 1657 | return status; |
7de0e49a PP |
1658 | } |
1659 | ||
1660 | /* | |
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. | |
1664 | * | |
1665 | * This function consumes the `msg` reference, _whatever the outcome_. | |
1666 | * | |
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 | |
1670 | * `reached_end`. | |
1671 | */ | |
1672 | static inline | |
d24d5663 | 1673 | bt_component_class_message_iterator_next_method_status handle_message( |
7de0e49a PP |
1674 | struct trimmer_iterator *trimmer_it, const bt_message *msg, |
1675 | bool *reached_end) | |
1676 | { | |
d24d5663 | 1677 | bt_component_class_message_iterator_next_method_status status; |
7de0e49a PP |
1678 | const bt_stream *stream = NULL; |
1679 | int64_t ns_from_origin = INT64_MIN; | |
4af85094 | 1680 | bool has_ns_from_origin = false; |
7de0e49a | 1681 | int ret; |
7de0e49a PP |
1682 | |
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)); | |
1688 | break; | |
1689 | case BT_MESSAGE_TYPE_PACKET_BEGINNING: | |
1690 | stream = bt_packet_borrow_stream_const( | |
1691 | bt_message_packet_beginning_borrow_packet_const(msg)); | |
1692 | break; | |
1693 | case BT_MESSAGE_TYPE_PACKET_END: | |
1694 | stream = bt_packet_borrow_stream_const( | |
1695 | bt_message_packet_end_borrow_packet_const(msg)); | |
1696 | break; | |
1697 | case BT_MESSAGE_TYPE_DISCARDED_EVENTS: | |
1698 | stream = bt_message_discarded_events_borrow_stream_const(msg); | |
1699 | break; | |
1700 | case BT_MESSAGE_TYPE_DISCARDED_PACKETS: | |
1701 | stream = bt_message_discarded_packets_borrow_stream_const(msg); | |
1702 | break; | |
7de0e49a PP |
1703 | case BT_MESSAGE_TYPE_STREAM_BEGINNING: |
1704 | stream = bt_message_stream_beginning_borrow_stream_const(msg); | |
1705 | break; | |
1706 | case BT_MESSAGE_TYPE_STREAM_END: | |
1707 | stream = bt_message_stream_end_borrow_stream_const(msg); | |
1708 | break; | |
1709 | default: | |
1710 | break; | |
1711 | } | |
1712 | ||
7de0e49a | 1713 | /* Retrieve the message's time */ |
188edac1 | 1714 | ret = get_msg_ns_from_origin(msg, &ns_from_origin, &has_ns_from_origin); |
91d81473 | 1715 | if (G_UNLIKELY(ret)) { |
d24d5663 | 1716 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; |
7de0e49a PP |
1717 | goto end; |
1718 | } | |
1719 | ||
188edac1 | 1720 | if (G_LIKELY(stream)) { |
7de0e49a | 1721 | /* Message associated to a stream */ |
188edac1 SM |
1722 | status = handle_message_with_stream(trimmer_it, msg, |
1723 | stream, has_ns_from_origin ? &ns_from_origin : NULL, reached_end); | |
7de0e49a PP |
1724 | |
1725 | /* | |
1726 | * handle_message_with_stream_state() unconditionally | |
1727 | * consumes `msg`. | |
1728 | */ | |
1729 | msg = NULL; | |
1730 | } else { | |
1731 | /* | |
1732 | * Message not associated to a stream (message iterator | |
1733 | * inactivity). | |
1734 | */ | |
91d81473 | 1735 | if (G_UNLIKELY(ns_from_origin > trimmer_it->end.ns_from_origin)) { |
7de0e49a PP |
1736 | BT_MESSAGE_PUT_REF_AND_RESET(msg); |
1737 | status = end_iterator_streams(trimmer_it); | |
1738 | *reached_end = true; | |
1739 | } else { | |
1740 | push_message(trimmer_it, msg); | |
d24d5663 | 1741 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; |
7de0e49a PP |
1742 | msg = NULL; |
1743 | } | |
1744 | } | |
1745 | ||
1746 | end: | |
1747 | /* We release the message's reference whatever the outcome */ | |
1748 | bt_message_put_ref(msg); | |
1749 | return status; | |
1750 | } | |
1751 | ||
1752 | static inline | |
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) | |
1756 | { | |
1757 | *count = 0; | |
1758 | ||
1759 | /* | |
1760 | * Move auto-seek messages to the output array (which is this | |
1761 | * iterator's base message array). | |
1762 | */ | |
1763 | while (capacity > 0 && !g_queue_is_empty(trimmer_it->output_messages)) { | |
1764 | msgs[*count] = pop_message(trimmer_it); | |
1765 | capacity--; | |
1766 | (*count)++; | |
1767 | } | |
1768 | ||
1769 | BT_ASSERT(*count > 0); | |
1770 | } | |
1771 | ||
1772 | static inline | |
d24d5663 | 1773 | bt_component_class_message_iterator_next_method_status state_ending( |
7de0e49a PP |
1774 | struct trimmer_iterator *trimmer_it, |
1775 | bt_message_array_const msgs, uint64_t capacity, | |
1776 | uint64_t *count) | |
1777 | { | |
d24d5663 PP |
1778 | bt_component_class_message_iterator_next_method_status status = |
1779 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; | |
7de0e49a PP |
1780 | |
1781 | if (g_queue_is_empty(trimmer_it->output_messages)) { | |
1782 | trimmer_it->state = TRIMMER_ITERATOR_STATE_ENDED; | |
d24d5663 | 1783 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END; |
7de0e49a PP |
1784 | goto end; |
1785 | } | |
1786 | ||
1787 | fill_message_array_from_output_messages(trimmer_it, msgs, | |
1788 | capacity, count); | |
1789 | ||
1790 | end: | |
1791 | return status; | |
1792 | } | |
1793 | ||
1794 | static inline | |
d24d5663 PP |
1795 | bt_component_class_message_iterator_next_method_status |
1796 | state_trim(struct trimmer_iterator *trimmer_it, | |
7de0e49a PP |
1797 | bt_message_array_const msgs, uint64_t capacity, |
1798 | uint64_t *count) | |
1799 | { | |
d24d5663 PP |
1800 | bt_component_class_message_iterator_next_method_status status = |
1801 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; | |
7de0e49a PP |
1802 | bt_message_array_const my_msgs; |
1803 | uint64_t my_count; | |
1804 | uint64_t i; | |
1805 | bool reached_end = false; | |
1806 | ||
1807 | while (g_queue_is_empty(trimmer_it->output_messages)) { | |
1808 | status = (int) bt_self_component_port_input_message_iterator_next( | |
1809 | trimmer_it->upstream_iter, &my_msgs, &my_count); | |
d24d5663 PP |
1810 | if (G_UNLIKELY(status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK)) { |
1811 | if (status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END) { | |
7de0e49a | 1812 | status = end_iterator_streams(trimmer_it); |
d24d5663 | 1813 | if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
7de0e49a PP |
1814 | goto end; |
1815 | } | |
1816 | ||
1817 | trimmer_it->state = | |
1818 | TRIMMER_ITERATOR_STATE_ENDING; | |
1819 | status = state_ending(trimmer_it, msgs, | |
1820 | capacity, count); | |
1821 | } | |
1822 | ||
1823 | goto end; | |
1824 | } | |
1825 | ||
1826 | BT_ASSERT(my_count > 0); | |
1827 | ||
1828 | for (i = 0; i < my_count; i++) { | |
1829 | status = handle_message(trimmer_it, my_msgs[i], | |
1830 | &reached_end); | |
1831 | ||
1832 | /* | |
1833 | * handle_message() unconditionally consumes the | |
1834 | * message reference. | |
1835 | */ | |
1836 | my_msgs[i] = NULL; | |
1837 | ||
91d81473 | 1838 | if (G_UNLIKELY(status != |
d24d5663 | 1839 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK)) { |
7de0e49a PP |
1840 | put_messages(my_msgs, my_count); |
1841 | goto end; | |
1842 | } | |
1843 | ||
91d81473 | 1844 | if (G_UNLIKELY(reached_end)) { |
7de0e49a PP |
1845 | /* |
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 | |
1853 | * "next" method. | |
1854 | */ | |
1855 | put_messages(my_msgs, my_count); | |
1856 | trimmer_it->state = | |
1857 | TRIMMER_ITERATOR_STATE_ENDING; | |
1858 | status = state_ending(trimmer_it, msgs, | |
1859 | capacity, count); | |
1860 | goto end; | |
1861 | } | |
1862 | } | |
1863 | } | |
1864 | ||
1865 | /* | |
1866 | * There's at least one message in the output message queue: | |
1867 | * move the messages to the output message array. | |
1868 | */ | |
1869 | BT_ASSERT(!g_queue_is_empty(trimmer_it->output_messages)); | |
1870 | fill_message_array_from_output_messages(trimmer_it, msgs, | |
1871 | capacity, count); | |
1872 | ||
1873 | end: | |
1874 | return status; | |
1875 | } | |
1876 | ||
1877 | BT_HIDDEN | |
d24d5663 | 1878 | bt_component_class_message_iterator_next_method_status trimmer_msg_iter_next( |
7de0e49a PP |
1879 | bt_self_message_iterator *self_msg_iter, |
1880 | bt_message_array_const msgs, uint64_t capacity, | |
1881 | uint64_t *count) | |
1882 | { | |
1883 | struct trimmer_iterator *trimmer_it = | |
1884 | bt_self_message_iterator_get_data(self_msg_iter); | |
d24d5663 PP |
1885 | bt_component_class_message_iterator_next_method_status status = |
1886 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; | |
7de0e49a PP |
1887 | |
1888 | BT_ASSERT(trimmer_it); | |
1889 | ||
91d81473 | 1890 | if (G_LIKELY(trimmer_it->state == TRIMMER_ITERATOR_STATE_TRIM)) { |
7de0e49a | 1891 | status = state_trim(trimmer_it, msgs, capacity, count); |
d24d5663 | 1892 | if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
7de0e49a PP |
1893 | goto end; |
1894 | } | |
1895 | } else { | |
1896 | switch (trimmer_it->state) { | |
1897 | case TRIMMER_ITERATOR_STATE_SET_BOUNDS_NS_FROM_ORIGIN: | |
1898 | status = state_set_trimmer_iterator_bounds(trimmer_it); | |
d24d5663 | 1899 | if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
7de0e49a PP |
1900 | goto end; |
1901 | } | |
1902 | ||
1903 | status = state_seek_initially(trimmer_it); | |
d24d5663 | 1904 | if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
7de0e49a PP |
1905 | goto end; |
1906 | } | |
1907 | ||
1908 | status = state_trim(trimmer_it, msgs, capacity, count); | |
d24d5663 | 1909 | if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
7de0e49a PP |
1910 | goto end; |
1911 | } | |
1912 | ||
1913 | break; | |
1914 | case TRIMMER_ITERATOR_STATE_SEEK_INITIALLY: | |
1915 | status = state_seek_initially(trimmer_it); | |
d24d5663 | 1916 | if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
7de0e49a PP |
1917 | goto end; |
1918 | } | |
1919 | ||
1920 | status = state_trim(trimmer_it, msgs, capacity, count); | |
d24d5663 | 1921 | if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
7de0e49a PP |
1922 | goto end; |
1923 | } | |
1924 | ||
1925 | break; | |
1926 | case TRIMMER_ITERATOR_STATE_ENDING: | |
1927 | status = state_ending(trimmer_it, msgs, capacity, | |
1928 | count); | |
d24d5663 | 1929 | if (status != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
7de0e49a PP |
1930 | goto end; |
1931 | } | |
1932 | ||
1933 | break; | |
1934 | case TRIMMER_ITERATOR_STATE_ENDED: | |
d24d5663 | 1935 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END; |
7de0e49a PP |
1936 | break; |
1937 | default: | |
1938 | abort(); | |
1939 | } | |
1940 | } | |
1941 | ||
1942 | end: | |
1943 | return status; | |
1944 | } | |
1945 | ||
1946 | BT_HIDDEN | |
1947 | void trimmer_msg_iter_finalize(bt_self_message_iterator *self_msg_iter) | |
1948 | { | |
1949 | struct trimmer_iterator *trimmer_it = | |
1950 | bt_self_message_iterator_get_data(self_msg_iter); | |
1951 | ||
1952 | BT_ASSERT(trimmer_it); | |
1953 | destroy_trimmer_iterator(trimmer_it); | |
1954 | } |