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 #include <babeltrace/compat/time-internal.h>
30 #include <babeltrace/compat/utc-internal.h>
31 #include <babeltrace/graph/notification-iterator.h>
32 #include <babeltrace/graph/private-notification-iterator.h>
33 #include <babeltrace/graph/notification.h>
34 #include <babeltrace/graph/notification-event.h>
35 #include <babeltrace/graph/notification-stream.h>
36 #include <babeltrace/graph/notification-packet.h>
37 #include <babeltrace/graph/component-filter.h>
38 #include <babeltrace/graph/private-component-filter.h>
39 #include <babeltrace/graph/private-port.h>
40 #include <babeltrace/graph/private-connection.h>
41 #include <babeltrace/graph/private-component.h>
42 #include <babeltrace/graph/connection.h>
43 #include <babeltrace/ctf-ir/event.h>
44 #include <babeltrace/ctf-ir/stream.h>
45 #include <babeltrace/ctf-ir/stream-class.h>
46 #include <babeltrace/ctf-ir/clock-class.h>
47 #include <babeltrace/ctf-ir/packet.h>
48 #include <babeltrace/ctf-ir/trace.h>
49 #include <babeltrace/ctf-ir/fields.h>
51 #include <plugins-common.h>
58 gboolean
close_packets(gpointer key
, gpointer value
, gpointer user_data
)
60 struct bt_ctf_packet
*writer_packet
= value
;
62 bt_put(writer_packet
);
67 void trimmer_iterator_finalize(struct bt_private_notification_iterator
*it
)
69 struct trimmer_iterator
*trim_it
;
71 trim_it
= bt_private_notification_iterator_get_user_data(it
);
74 bt_put(trim_it
->input_iterator
);
75 g_hash_table_foreach_remove(trim_it
->packet_map
,
77 g_hash_table_destroy(trim_it
->packet_map
);
82 enum bt_notification_iterator_status
trimmer_iterator_init(
83 struct bt_private_notification_iterator
*iterator
,
84 struct bt_private_port
*port
)
86 enum bt_notification_iterator_status ret
=
87 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
88 enum bt_notification_iterator_status it_ret
;
89 enum bt_connection_status conn_status
;
90 struct bt_private_port
*input_port
= NULL
;
91 struct bt_private_connection
*connection
= NULL
;
92 struct bt_private_component
*component
=
93 bt_private_notification_iterator_get_private_component(iterator
);
94 struct trimmer_iterator
*it_data
= g_new0(struct trimmer_iterator
, 1);
95 static const enum bt_notification_type notif_types
[] = {
96 BT_NOTIFICATION_TYPE_EVENT
,
97 BT_NOTIFICATION_TYPE_STREAM_END
,
98 BT_NOTIFICATION_TYPE_PACKET_BEGIN
,
99 BT_NOTIFICATION_TYPE_PACKET_END
,
100 BT_NOTIFICATION_TYPE_SENTINEL
,
104 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
108 /* Create a new iterator on the upstream component. */
109 input_port
= bt_private_component_filter_get_input_private_port_by_name(
112 connection
= bt_private_port_get_private_connection(input_port
);
115 conn_status
= bt_private_connection_create_notification_iterator(connection
,
116 notif_types
, &it_data
->input_iterator
);
117 if (conn_status
!= BT_CONNECTION_STATUS_OK
) {
118 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
122 it_data
->err
= stderr
;
123 it_data
->packet_map
= g_hash_table_new_full(g_direct_hash
,
124 g_direct_equal
, NULL
, NULL
);
126 it_ret
= bt_private_notification_iterator_set_user_data(iterator
,
139 int update_lazy_bound(struct trimmer_bound
*bound
, const char *name
,
140 int64_t ts
, bool *lazy_update
)
146 *lazy_update
= false;
152 timeval
= ts
/ NSEC_PER_SEC
;
154 if (bound
->lazy_values
.gmt
) {
155 /* Get day, month, year. */
156 if (!bt_gmtime_r(&timeval
, &tm
)) {
157 printf_error("Failure in bt_gmtime_r()");
160 tm
.tm_sec
= bound
->lazy_values
.ss
;
161 tm
.tm_min
= bound
->lazy_values
.mm
;
162 tm
.tm_hour
= bound
->lazy_values
.hh
;
163 timeval
= bt_timegm(&tm
);
165 printf_error("Failure in bt_timegm(), incorrectly formatted %s timestamp",
170 /* Get day, month, year. */
171 if (!bt_localtime_r(&timeval
, &tm
)) {
172 printf_error("Failure in bt_localtime_r()");
175 tm
.tm_sec
= bound
->lazy_values
.ss
;
176 tm
.tm_min
= bound
->lazy_values
.mm
;
177 tm
.tm_hour
= bound
->lazy_values
.hh
;
178 timeval
= mktime(&tm
);
180 printf_error("Failure in mktime(), incorrectly formatted %s timestamp",
185 value
= (int64_t) timeval
;
186 value
*= NSEC_PER_SEC
;
187 value
+= bound
->lazy_values
.ns
;
188 bound
->value
= value
;
199 struct bt_notification
*evaluate_event_notification(
200 struct bt_notification
*notification
,
201 struct trimmer_iterator
*trim_it
,
202 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
203 bool *_event_in_range
, bool *finished
)
207 struct bt_ctf_event
*event
= NULL
, *writer_event
;
208 bool in_range
= true;
209 struct bt_ctf_clock_class
*clock_class
= NULL
;
210 struct bt_ctf_trace
*trace
= NULL
;
211 struct bt_ctf_stream
*stream
= NULL
;
212 struct bt_ctf_stream_class
*stream_class
= NULL
;
213 struct bt_ctf_clock_value
*clock_value
= NULL
;
214 bool lazy_update
= false;
215 struct bt_notification
*new_notification
= NULL
;
216 struct bt_clock_class_priority_map
*cc_prio_map
;
218 event
= bt_notification_event_get_event(notification
);
220 cc_prio_map
= bt_notification_event_get_clock_class_priority_map(
223 writer_event
= trimmer_output_event(trim_it
, event
);
224 assert(writer_event
);
225 new_notification
= bt_notification_event_create(writer_event
, cc_prio_map
);
226 assert(new_notification
);
229 stream
= bt_ctf_event_get_stream(event
);
232 stream_class
= bt_ctf_stream_get_class(stream
);
233 assert(stream_class
);
235 trace
= bt_ctf_stream_class_get_trace(stream_class
);
238 /* FIXME multi-clock? */
239 clock_class
= bt_ctf_trace_get_clock_class_by_index(trace
, 0);
244 clock_value
= bt_ctf_event_get_clock_value(event
, clock_class
);
246 printf_error("Failed to retrieve clock value");
250 clock_ret
= bt_ctf_clock_value_get_value_ns_from_epoch(
253 printf_error("Failed to retrieve clock value timestamp");
256 if (update_lazy_bound(begin
, "begin", ts
, &lazy_update
)) {
259 if (update_lazy_bound(end
, "end", ts
, &lazy_update
)) {
262 if (lazy_update
&& begin
->set
&& end
->set
) {
263 if (begin
->value
> end
->value
) {
264 printf_error("Unexpected: time range begin value is above end value");
268 if (begin
->set
&& ts
< begin
->value
) {
271 if (end
->set
&& ts
> end
->value
) {
279 BT_PUT(new_notification
);
282 bt_put(writer_event
);
286 bt_put(stream_class
);
288 *_event_in_range
= in_range
;
289 return new_notification
;
293 int ns_from_integer_field(struct bt_ctf_field
*integer
, int64_t *ns
)
297 uint64_t raw_clock_value
;
298 struct bt_ctf_field_type
*integer_type
= NULL
;
299 struct bt_ctf_clock_class
*clock_class
= NULL
;
300 struct bt_ctf_clock_value
*clock_value
= NULL
;
302 integer_type
= bt_ctf_field_get_type(integer
);
303 assert(integer_type
);
304 clock_class
= bt_ctf_field_type_integer_get_mapped_clock_class(
311 is_signed
= bt_ctf_field_type_integer_get_signed(integer_type
);
313 ret
= bt_ctf_field_unsigned_integer_get_value(integer
,
319 /* Signed clock values are unsupported. */
324 clock_value
= bt_ctf_clock_value_create(clock_class
, raw_clock_value
);
329 ret
= bt_ctf_clock_value_get_value_ns_from_epoch(clock_value
, ns
);
331 bt_put(integer_type
);
337 static uint64_t ns_from_value(uint64_t frequency
, uint64_t value
)
341 if (frequency
== NSEC_PER_SEC
) {
344 ns
= (uint64_t) ((1e9
* (double) value
) / (double) frequency
);
351 * timestamp minus the offset.
354 int64_t get_raw_timestamp(struct bt_ctf_packet
*writer_packet
,
357 struct bt_ctf_clock_class
*writer_clock_class
;
358 int64_t sec_offset
, cycles_offset
, ns
;
359 struct bt_ctf_trace
*writer_trace
;
360 struct bt_ctf_stream
*writer_stream
;
361 struct bt_ctf_stream_class
*writer_stream_class
;
365 writer_stream
= bt_ctf_packet_get_stream(writer_packet
);
366 assert(writer_stream
);
368 writer_stream_class
= bt_ctf_stream_get_class(writer_stream
);
369 assert(writer_stream_class
);
371 writer_trace
= bt_ctf_stream_class_get_trace(writer_stream_class
);
372 assert(writer_trace
);
374 /* FIXME multi-clock? */
375 writer_clock_class
= bt_ctf_trace_get_clock_class_by_index(
377 assert(writer_clock_class
);
379 ret
= bt_ctf_clock_class_get_offset_s(writer_clock_class
, &sec_offset
);
381 ns
= sec_offset
* NSEC_PER_SEC
;
383 freq
= bt_ctf_clock_class_get_frequency(writer_clock_class
);
384 assert(freq
!= -1ULL);
386 ret
= bt_ctf_clock_class_get_offset_cycles(writer_clock_class
, &cycles_offset
);
389 ns
+= ns_from_value(freq
, cycles_offset
);
391 bt_put(writer_clock_class
);
392 bt_put(writer_trace
);
393 bt_put(writer_stream_class
);
394 bt_put(writer_stream
);
396 return timestamp
- ns
;
400 struct bt_notification
*evaluate_packet_notification(
401 struct bt_notification
*notification
,
402 struct trimmer_iterator
*trim_it
,
403 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
404 bool *_packet_in_range
, bool *finished
)
406 int64_t begin_ns
, pkt_begin_ns
, end_ns
, pkt_end_ns
;
407 bool in_range
= true;
408 struct bt_ctf_packet
*packet
= NULL
, *writer_packet
= NULL
;
409 struct bt_ctf_field
*packet_context
= NULL
,
410 *timestamp_begin
= NULL
,
411 *timestamp_end
= NULL
;
412 struct bt_notification
*new_notification
= NULL
;
413 enum bt_component_status ret
;
414 bool lazy_update
= false;
416 switch (bt_notification_get_type(notification
)) {
417 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
418 packet
= bt_notification_packet_begin_get_packet(notification
);
420 writer_packet
= trimmer_new_packet(trim_it
, packet
);
421 assert(writer_packet
);
423 case BT_NOTIFICATION_TYPE_PACKET_END
:
424 packet
= bt_notification_packet_end_get_packet(notification
);
426 writer_packet
= trimmer_close_packet(trim_it
, packet
);
427 assert(writer_packet
);
433 packet_context
= bt_ctf_packet_get_context(writer_packet
);
434 if (!packet_context
) {
438 if (!bt_ctf_field_is_structure(packet_context
)) {
442 timestamp_begin
= bt_ctf_field_structure_get_field(
443 packet_context
, "timestamp_begin");
444 if (!timestamp_begin
|| !bt_ctf_field_is_integer(timestamp_begin
)) {
447 timestamp_end
= bt_ctf_field_structure_get_field(
448 packet_context
, "timestamp_end");
449 if (!timestamp_end
|| !bt_ctf_field_is_integer(timestamp_end
)) {
453 if (ns_from_integer_field(timestamp_begin
, &pkt_begin_ns
)) {
456 if (ns_from_integer_field(timestamp_end
, &pkt_end_ns
)) {
460 if (update_lazy_bound(begin
, "begin", pkt_begin_ns
, &lazy_update
)) {
463 if (update_lazy_bound(end
, "end", pkt_end_ns
, &lazy_update
)) {
466 if (lazy_update
&& begin
->set
&& end
->set
) {
467 if (begin
->value
> end
->value
) {
468 printf_error("Unexpected: time range begin value is above end value");
473 begin_ns
= begin
->set
? begin
->value
: INT64_MIN
;
474 end_ns
= end
->set
? end
->value
: INT64_MAX
;
477 * Accept if there is any overlap between the selected region and the
480 in_range
= (pkt_end_ns
>= begin_ns
) && (pkt_begin_ns
<= end_ns
);
484 if (pkt_begin_ns
> end_ns
) {
488 if (begin_ns
> pkt_begin_ns
) {
489 ret
= update_packet_context_field(trim_it
->err
, writer_packet
,
491 get_raw_timestamp(writer_packet
, begin_ns
));
495 if (end_ns
< pkt_end_ns
) {
496 ret
= update_packet_context_field(trim_it
->err
, writer_packet
,
498 get_raw_timestamp(writer_packet
, end_ns
));
503 switch (bt_notification_get_type(notification
)) {
504 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
505 new_notification
= bt_notification_packet_begin_create(writer_packet
);
506 assert(new_notification
);
508 case BT_NOTIFICATION_TYPE_PACKET_END
:
509 new_notification
= bt_notification_packet_end_create(writer_packet
);
510 assert(new_notification
);
516 *_packet_in_range
= in_range
;
518 bt_put(writer_packet
);
519 bt_put(packet_context
);
520 bt_put(timestamp_begin
);
521 bt_put(timestamp_end
);
522 return new_notification
;
526 struct bt_notification
*evaluate_stream_notification(
527 struct bt_notification
*notification
,
528 struct trimmer_iterator
*trim_it
)
530 struct bt_ctf_stream
*stream
;
532 stream
= bt_notification_stream_end_get_stream(notification
);
535 /* FIXME: useless copy */
536 return bt_notification_stream_end_create(stream
);
539 /* Return true if the notification should be forwarded. */
541 enum bt_notification_iterator_status
evaluate_notification(
542 struct bt_notification
**notification
,
543 struct trimmer_iterator
*trim_it
,
544 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
547 enum bt_notification_type type
;
548 struct bt_notification
*new_notification
= NULL
;
549 bool finished
= false;
552 type
= bt_notification_get_type(*notification
);
554 case BT_NOTIFICATION_TYPE_EVENT
:
555 new_notification
= evaluate_event_notification(*notification
,
556 trim_it
, begin
, end
, in_range
, &finished
);
558 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
559 case BT_NOTIFICATION_TYPE_PACKET_END
:
560 new_notification
= evaluate_packet_notification(*notification
,
561 trim_it
, begin
, end
, in_range
, &finished
);
563 case BT_NOTIFICATION_TYPE_STREAM_END
:
564 new_notification
= evaluate_stream_notification(*notification
,
568 puts("Unhandled notification type");
571 BT_PUT(*notification
);
572 *notification
= new_notification
;
575 return BT_NOTIFICATION_ITERATOR_STATUS_END
;
578 return BT_NOTIFICATION_ITERATOR_STATUS_OK
;
582 struct bt_notification_iterator_next_return
trimmer_iterator_next(
583 struct bt_private_notification_iterator
*iterator
)
585 struct trimmer_iterator
*trim_it
= NULL
;
586 struct bt_private_component
*component
= NULL
;
587 struct trimmer
*trimmer
= NULL
;
588 struct bt_notification_iterator
*source_it
= NULL
;
589 struct bt_notification_iterator_next_return ret
= {
590 .status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
,
591 .notification
= NULL
,
593 bool notification_in_range
= false;
595 trim_it
= bt_private_notification_iterator_get_user_data(iterator
);
598 component
= bt_private_notification_iterator_get_private_component(
601 trimmer
= bt_private_component_get_user_data(component
);
604 source_it
= trim_it
->input_iterator
;
607 while (!notification_in_range
) {
608 ret
.status
= bt_notification_iterator_next(source_it
);
609 if (ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
613 ret
.notification
= bt_notification_iterator_get_notification(
615 if (!ret
.notification
) {
616 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
620 ret
.status
= evaluate_notification(&ret
.notification
, trim_it
,
621 &trimmer
->begin
, &trimmer
->end
,
622 ¬ification_in_range
);
623 if (!notification_in_range
) {
624 BT_PUT(ret
.notification
);
627 if (ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
637 enum bt_notification_iterator_status
trimmer_iterator_seek_time(
638 struct bt_private_notification_iterator
*iterator
,
641 return BT_NOTIFICATION_ITERATOR_STATUS_OK
;