4 * Babeltrace Trace Trimmer Iterator
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #define BT_LOG_TAG "PLUGIN-UTILS-TRIMMER-FLT"
32 #include <babeltrace/compat/time-internal.h>
33 #include <babeltrace/compat/utc-internal.h>
34 #include <babeltrace/graph/notification-iterator.h>
35 #include <babeltrace/graph/private-notification-iterator.h>
36 #include <babeltrace/graph/notification.h>
37 #include <babeltrace/graph/notification-event.h>
38 #include <babeltrace/graph/notification-stream.h>
39 #include <babeltrace/graph/notification-packet.h>
40 #include <babeltrace/graph/component-filter.h>
41 #include <babeltrace/graph/private-component-filter.h>
42 #include <babeltrace/graph/private-port.h>
43 #include <babeltrace/graph/private-connection.h>
44 #include <babeltrace/graph/private-component.h>
45 #include <babeltrace/graph/connection.h>
46 #include <babeltrace/ctf-ir/event.h>
47 #include <babeltrace/ctf-ir/stream.h>
48 #include <babeltrace/ctf-ir/stream-class.h>
49 #include <babeltrace/ctf-ir/clock-class.h>
50 #include <babeltrace/ctf-ir/packet.h>
51 #include <babeltrace/ctf-ir/trace.h>
52 #include <babeltrace/ctf-ir/fields.h>
54 #include <plugins-common.h>
61 gboolean
close_packets(gpointer key
, gpointer value
, gpointer user_data
)
63 struct bt_ctf_packet
*writer_packet
= value
;
65 bt_put(writer_packet
);
70 void trimmer_iterator_finalize(struct bt_private_notification_iterator
*it
)
72 struct trimmer_iterator
*trim_it
;
74 trim_it
= bt_private_notification_iterator_get_user_data(it
);
77 bt_put(trim_it
->input_iterator
);
78 g_hash_table_foreach_remove(trim_it
->packet_map
,
80 g_hash_table_destroy(trim_it
->packet_map
);
85 enum bt_notification_iterator_status
trimmer_iterator_init(
86 struct bt_private_notification_iterator
*iterator
,
87 struct bt_private_port
*port
)
89 enum bt_notification_iterator_status ret
=
90 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
91 enum bt_notification_iterator_status it_ret
;
92 enum bt_connection_status conn_status
;
93 struct bt_private_port
*input_port
= NULL
;
94 struct bt_private_connection
*connection
= NULL
;
95 struct bt_private_component
*component
=
96 bt_private_notification_iterator_get_private_component(iterator
);
97 struct trimmer_iterator
*it_data
= g_new0(struct trimmer_iterator
, 1);
98 static const enum bt_notification_type notif_types
[] = {
99 BT_NOTIFICATION_TYPE_EVENT
,
100 BT_NOTIFICATION_TYPE_STREAM_END
,
101 BT_NOTIFICATION_TYPE_PACKET_BEGIN
,
102 BT_NOTIFICATION_TYPE_PACKET_END
,
103 BT_NOTIFICATION_TYPE_SENTINEL
,
107 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
111 /* Create a new iterator on the upstream component. */
112 input_port
= bt_private_component_filter_get_input_private_port_by_name(
115 connection
= bt_private_port_get_private_connection(input_port
);
118 conn_status
= bt_private_connection_create_notification_iterator(connection
,
119 notif_types
, &it_data
->input_iterator
);
120 if (conn_status
!= BT_CONNECTION_STATUS_OK
) {
121 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
125 it_data
->err
= stderr
;
126 it_data
->packet_map
= g_hash_table_new_full(g_direct_hash
,
127 g_direct_equal
, NULL
, NULL
);
129 it_ret
= bt_private_notification_iterator_set_user_data(iterator
,
142 int update_lazy_bound(struct trimmer_bound
*bound
, const char *name
,
143 int64_t ts
, bool *lazy_update
)
149 *lazy_update
= false;
155 timeval
= ts
/ NSEC_PER_SEC
;
157 if (bound
->lazy_values
.gmt
) {
158 /* Get day, month, year. */
159 if (!bt_gmtime_r(&timeval
, &tm
)) {
160 BT_LOGE_STR("Failure in bt_gmtime_r()");
163 tm
.tm_sec
= bound
->lazy_values
.ss
;
164 tm
.tm_min
= bound
->lazy_values
.mm
;
165 tm
.tm_hour
= bound
->lazy_values
.hh
;
166 timeval
= bt_timegm(&tm
);
168 BT_LOGE("Failure in bt_timegm(), incorrectly formatted %s timestamp",
173 /* Get day, month, year. */
174 if (!bt_localtime_r(&timeval
, &tm
)) {
175 BT_LOGE_STR("Failure in bt_localtime_r()");
178 tm
.tm_sec
= bound
->lazy_values
.ss
;
179 tm
.tm_min
= bound
->lazy_values
.mm
;
180 tm
.tm_hour
= bound
->lazy_values
.hh
;
181 timeval
= mktime(&tm
);
183 BT_LOGE("Failure in mktime(), incorrectly formatted %s timestamp",
188 value
= (int64_t) timeval
;
189 value
*= NSEC_PER_SEC
;
190 value
+= bound
->lazy_values
.ns
;
191 bound
->value
= value
;
202 struct bt_notification
*evaluate_event_notification(
203 struct bt_notification
*notification
,
204 struct trimmer_iterator
*trim_it
,
205 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
206 bool *_event_in_range
, bool *finished
)
210 struct bt_ctf_event
*event
= NULL
, *writer_event
;
211 bool in_range
= true;
212 struct bt_ctf_clock_class
*clock_class
= NULL
;
213 struct bt_ctf_trace
*trace
= NULL
;
214 struct bt_ctf_stream
*stream
= NULL
;
215 struct bt_ctf_stream_class
*stream_class
= NULL
;
216 struct bt_ctf_clock_value
*clock_value
= NULL
;
217 bool lazy_update
= false;
218 struct bt_notification
*new_notification
= NULL
;
219 struct bt_clock_class_priority_map
*cc_prio_map
;
221 event
= bt_notification_event_get_event(notification
);
223 cc_prio_map
= bt_notification_event_get_clock_class_priority_map(
226 writer_event
= trimmer_output_event(trim_it
, event
);
227 assert(writer_event
);
228 new_notification
= bt_notification_event_create(writer_event
, cc_prio_map
);
229 assert(new_notification
);
232 stream
= bt_ctf_event_get_stream(event
);
235 stream_class
= bt_ctf_stream_get_class(stream
);
236 assert(stream_class
);
238 trace
= bt_ctf_stream_class_get_trace(stream_class
);
241 /* FIXME multi-clock? */
242 clock_class
= bt_ctf_trace_get_clock_class_by_index(trace
, 0);
247 clock_value
= bt_ctf_event_get_clock_value(event
, clock_class
);
249 BT_LOGE_STR("Failed to retrieve clock value");
253 clock_ret
= bt_ctf_clock_value_get_value_ns_from_epoch(
256 BT_LOGE_STR("Failed to retrieve clock value timestamp");
259 if (update_lazy_bound(begin
, "begin", ts
, &lazy_update
)) {
262 if (update_lazy_bound(end
, "end", ts
, &lazy_update
)) {
265 if (lazy_update
&& begin
->set
&& end
->set
) {
266 if (begin
->value
> end
->value
) {
267 BT_LOGE_STR("Unexpected: time range begin value is above end value");
271 if (begin
->set
&& ts
< begin
->value
) {
274 if (end
->set
&& ts
> end
->value
) {
282 BT_PUT(new_notification
);
285 bt_put(writer_event
);
289 bt_put(stream_class
);
291 *_event_in_range
= in_range
;
292 return new_notification
;
296 int ns_from_integer_field(struct bt_ctf_field
*integer
, int64_t *ns
)
300 uint64_t raw_clock_value
;
301 struct bt_ctf_field_type
*integer_type
= NULL
;
302 struct bt_ctf_clock_class
*clock_class
= NULL
;
303 struct bt_ctf_clock_value
*clock_value
= NULL
;
305 integer_type
= bt_ctf_field_get_type(integer
);
306 assert(integer_type
);
307 clock_class
= bt_ctf_field_type_integer_get_mapped_clock_class(
314 is_signed
= bt_ctf_field_type_integer_get_signed(integer_type
);
316 ret
= bt_ctf_field_unsigned_integer_get_value(integer
,
322 /* Signed clock values are unsupported. */
327 clock_value
= bt_ctf_clock_value_create(clock_class
, raw_clock_value
);
332 ret
= bt_ctf_clock_value_get_value_ns_from_epoch(clock_value
, ns
);
334 bt_put(integer_type
);
340 static uint64_t ns_from_value(uint64_t frequency
, uint64_t value
)
344 if (frequency
== NSEC_PER_SEC
) {
347 ns
= (uint64_t) ((1e9
* (double) value
) / (double) frequency
);
354 * timestamp minus the offset.
357 int64_t get_raw_timestamp(struct bt_ctf_packet
*writer_packet
,
360 struct bt_ctf_clock_class
*writer_clock_class
;
361 int64_t sec_offset
, cycles_offset
, ns
;
362 struct bt_ctf_trace
*writer_trace
;
363 struct bt_ctf_stream
*writer_stream
;
364 struct bt_ctf_stream_class
*writer_stream_class
;
368 writer_stream
= bt_ctf_packet_get_stream(writer_packet
);
369 assert(writer_stream
);
371 writer_stream_class
= bt_ctf_stream_get_class(writer_stream
);
372 assert(writer_stream_class
);
374 writer_trace
= bt_ctf_stream_class_get_trace(writer_stream_class
);
375 assert(writer_trace
);
377 /* FIXME multi-clock? */
378 writer_clock_class
= bt_ctf_trace_get_clock_class_by_index(
380 assert(writer_clock_class
);
382 ret
= bt_ctf_clock_class_get_offset_s(writer_clock_class
, &sec_offset
);
384 ns
= sec_offset
* NSEC_PER_SEC
;
386 freq
= bt_ctf_clock_class_get_frequency(writer_clock_class
);
387 assert(freq
!= -1ULL);
389 ret
= bt_ctf_clock_class_get_offset_cycles(writer_clock_class
, &cycles_offset
);
392 ns
+= ns_from_value(freq
, cycles_offset
);
394 bt_put(writer_clock_class
);
395 bt_put(writer_trace
);
396 bt_put(writer_stream_class
);
397 bt_put(writer_stream
);
399 return timestamp
- ns
;
403 struct bt_notification
*evaluate_packet_notification(
404 struct bt_notification
*notification
,
405 struct trimmer_iterator
*trim_it
,
406 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
407 bool *_packet_in_range
, bool *finished
)
409 int64_t begin_ns
, pkt_begin_ns
, end_ns
, pkt_end_ns
;
410 bool in_range
= true;
411 struct bt_ctf_packet
*packet
= NULL
, *writer_packet
= NULL
;
412 struct bt_ctf_field
*packet_context
= NULL
,
413 *timestamp_begin
= NULL
,
414 *timestamp_end
= NULL
;
415 struct bt_notification
*new_notification
= NULL
;
416 enum bt_component_status ret
;
417 bool lazy_update
= false;
419 switch (bt_notification_get_type(notification
)) {
420 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
421 packet
= bt_notification_packet_begin_get_packet(notification
);
423 writer_packet
= trimmer_new_packet(trim_it
, packet
);
424 assert(writer_packet
);
426 case BT_NOTIFICATION_TYPE_PACKET_END
:
427 packet
= bt_notification_packet_end_get_packet(notification
);
429 writer_packet
= trimmer_close_packet(trim_it
, packet
);
430 assert(writer_packet
);
436 packet_context
= bt_ctf_packet_get_context(writer_packet
);
437 if (!packet_context
) {
441 if (!bt_ctf_field_is_structure(packet_context
)) {
445 timestamp_begin
= bt_ctf_field_structure_get_field(
446 packet_context
, "timestamp_begin");
447 if (!timestamp_begin
|| !bt_ctf_field_is_integer(timestamp_begin
)) {
450 timestamp_end
= bt_ctf_field_structure_get_field(
451 packet_context
, "timestamp_end");
452 if (!timestamp_end
|| !bt_ctf_field_is_integer(timestamp_end
)) {
456 if (ns_from_integer_field(timestamp_begin
, &pkt_begin_ns
)) {
459 if (ns_from_integer_field(timestamp_end
, &pkt_end_ns
)) {
463 if (update_lazy_bound(begin
, "begin", pkt_begin_ns
, &lazy_update
)) {
466 if (update_lazy_bound(end
, "end", pkt_end_ns
, &lazy_update
)) {
469 if (lazy_update
&& begin
->set
&& end
->set
) {
470 if (begin
->value
> end
->value
) {
471 BT_LOGE_STR("Unexpected: time range begin value is above end value");
476 begin_ns
= begin
->set
? begin
->value
: INT64_MIN
;
477 end_ns
= end
->set
? end
->value
: INT64_MAX
;
480 * Accept if there is any overlap between the selected region and the
483 in_range
= (pkt_end_ns
>= begin_ns
) && (pkt_begin_ns
<= end_ns
);
487 if (pkt_begin_ns
> end_ns
) {
491 if (begin_ns
> pkt_begin_ns
) {
492 ret
= update_packet_context_field(trim_it
->err
, writer_packet
,
494 get_raw_timestamp(writer_packet
, begin_ns
));
498 if (end_ns
< pkt_end_ns
) {
499 ret
= update_packet_context_field(trim_it
->err
, writer_packet
,
501 get_raw_timestamp(writer_packet
, end_ns
));
506 switch (bt_notification_get_type(notification
)) {
507 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
508 new_notification
= bt_notification_packet_begin_create(writer_packet
);
509 assert(new_notification
);
511 case BT_NOTIFICATION_TYPE_PACKET_END
:
512 new_notification
= bt_notification_packet_end_create(writer_packet
);
513 assert(new_notification
);
519 *_packet_in_range
= in_range
;
521 bt_put(writer_packet
);
522 bt_put(packet_context
);
523 bt_put(timestamp_begin
);
524 bt_put(timestamp_end
);
525 return new_notification
;
529 struct bt_notification
*evaluate_stream_notification(
530 struct bt_notification
*notification
,
531 struct trimmer_iterator
*trim_it
)
533 struct bt_ctf_stream
*stream
;
535 stream
= bt_notification_stream_end_get_stream(notification
);
538 /* FIXME: useless copy */
539 return bt_notification_stream_end_create(stream
);
542 /* Return true if the notification should be forwarded. */
544 enum bt_notification_iterator_status
evaluate_notification(
545 struct bt_notification
**notification
,
546 struct trimmer_iterator
*trim_it
,
547 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
550 enum bt_notification_type type
;
551 struct bt_notification
*new_notification
= NULL
;
552 bool finished
= false;
555 type
= bt_notification_get_type(*notification
);
557 case BT_NOTIFICATION_TYPE_EVENT
:
558 new_notification
= evaluate_event_notification(*notification
,
559 trim_it
, begin
, end
, in_range
, &finished
);
561 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
562 case BT_NOTIFICATION_TYPE_PACKET_END
:
563 new_notification
= evaluate_packet_notification(*notification
,
564 trim_it
, begin
, end
, in_range
, &finished
);
566 case BT_NOTIFICATION_TYPE_STREAM_END
:
567 new_notification
= evaluate_stream_notification(*notification
,
571 puts("Unhandled notification type");
574 BT_PUT(*notification
);
575 *notification
= new_notification
;
578 return BT_NOTIFICATION_ITERATOR_STATUS_END
;
581 return BT_NOTIFICATION_ITERATOR_STATUS_OK
;
585 struct bt_notification_iterator_next_return
trimmer_iterator_next(
586 struct bt_private_notification_iterator
*iterator
)
588 struct trimmer_iterator
*trim_it
= NULL
;
589 struct bt_private_component
*component
= NULL
;
590 struct trimmer
*trimmer
= NULL
;
591 struct bt_notification_iterator
*source_it
= NULL
;
592 struct bt_notification_iterator_next_return ret
= {
593 .status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
,
594 .notification
= NULL
,
596 bool notification_in_range
= false;
598 trim_it
= bt_private_notification_iterator_get_user_data(iterator
);
601 component
= bt_private_notification_iterator_get_private_component(
604 trimmer
= bt_private_component_get_user_data(component
);
607 source_it
= trim_it
->input_iterator
;
610 while (!notification_in_range
) {
611 ret
.status
= bt_notification_iterator_next(source_it
);
612 if (ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
616 ret
.notification
= bt_notification_iterator_get_notification(
618 if (!ret
.notification
) {
619 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
623 ret
.status
= evaluate_notification(&ret
.notification
, trim_it
,
624 &trimmer
->begin
, &trimmer
->end
,
625 ¬ification_in_range
);
626 if (!notification_in_range
) {
627 BT_PUT(ret
.notification
);
630 if (ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
640 enum bt_notification_iterator_status
trimmer_iterator_seek_time(
641 struct bt_private_notification_iterator
*iterator
,
644 return BT_NOTIFICATION_ITERATOR_STATUS_OK
;