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/graph/notification-iterator.h>
31 #include <babeltrace/graph/private-notification-iterator.h>
32 #include <babeltrace/graph/notification.h>
33 #include <babeltrace/graph/notification-event.h>
34 #include <babeltrace/graph/notification-stream.h>
35 #include <babeltrace/graph/notification-packet.h>
36 #include <babeltrace/graph/component-filter.h>
37 #include <babeltrace/graph/private-component-filter.h>
38 #include <babeltrace/graph/private-port.h>
39 #include <babeltrace/graph/private-connection.h>
40 #include <babeltrace/graph/private-component.h>
41 #include <babeltrace/ctf-ir/event.h>
42 #include <babeltrace/ctf-ir/stream.h>
43 #include <babeltrace/ctf-ir/stream-class.h>
44 #include <babeltrace/ctf-ir/clock-class.h>
45 #include <babeltrace/ctf-ir/packet.h>
46 #include <babeltrace/ctf-ir/trace.h>
47 #include <babeltrace/ctf-ir/fields.h>
49 #include <plugins-common.h>
56 gboolean
close_packets(gpointer key
, gpointer value
, gpointer user_data
)
58 struct bt_ctf_packet
*writer_packet
= value
;
60 bt_put(writer_packet
);
65 void trimmer_iterator_finalize(struct bt_private_notification_iterator
*it
)
67 struct trimmer_iterator
*trim_it
;
69 trim_it
= bt_private_notification_iterator_get_user_data(it
);
72 bt_put(trim_it
->input_iterator
);
73 g_hash_table_foreach_remove(trim_it
->packet_map
,
75 g_hash_table_destroy(trim_it
->packet_map
);
80 enum bt_notification_iterator_status
trimmer_iterator_init(
81 struct bt_private_notification_iterator
*iterator
,
82 struct bt_private_port
*port
)
84 enum bt_notification_iterator_status ret
=
85 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
86 enum bt_notification_iterator_status it_ret
;
87 struct bt_private_port
*input_port
= NULL
;
88 struct bt_private_connection
*connection
= NULL
;
89 struct bt_private_component
*component
=
90 bt_private_notification_iterator_get_private_component(iterator
);
91 struct trimmer_iterator
*it_data
= g_new0(struct trimmer_iterator
, 1);
92 static const enum bt_notification_type notif_types
[] = {
93 BT_NOTIFICATION_TYPE_EVENT
,
94 BT_NOTIFICATION_TYPE_STREAM_END
,
95 BT_NOTIFICATION_TYPE_PACKET_BEGIN
,
96 BT_NOTIFICATION_TYPE_PACKET_END
,
97 BT_NOTIFICATION_TYPE_SENTINEL
,
101 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
105 /* Create a new iterator on the upstream component. */
106 input_port
= bt_private_component_filter_get_input_private_port_by_name(
109 connection
= bt_private_port_get_private_connection(input_port
);
112 it_data
->input_iterator
=
113 bt_private_connection_create_notification_iterator(connection
,
115 if (!it_data
->input_iterator
) {
116 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
120 it_data
->err
= stderr
;
121 it_data
->packet_map
= g_hash_table_new_full(g_direct_hash
,
122 g_direct_equal
, NULL
, NULL
);
124 it_ret
= bt_private_notification_iterator_set_user_data(iterator
,
137 int update_lazy_bound(struct trimmer_bound
*bound
, const char *name
,
138 int64_t ts
, bool *lazy_update
)
144 *lazy_update
= false;
150 timeval
= ts
/ NSEC_PER_SEC
;
152 if (bound
->lazy_values
.gmt
) {
153 /* Get day, month, year. */
154 if (!bt_gmtime_r(&timeval
, &tm
)) {
155 printf_error("Failure in bt_gmtime_r()");
158 tm
.tm_sec
= bound
->lazy_values
.ss
;
159 tm
.tm_min
= bound
->lazy_values
.mm
;
160 tm
.tm_hour
= bound
->lazy_values
.hh
;
161 timeval
= timegm(&tm
);
163 printf_error("Failure in timegm(), incorrectly formatted %s timestamp",
168 /* Get day, month, year. */
169 if (!bt_localtime_r(&timeval
, &tm
)) {
170 printf_error("Failure in bt_localtime_r()");
173 tm
.tm_sec
= bound
->lazy_values
.ss
;
174 tm
.tm_min
= bound
->lazy_values
.mm
;
175 tm
.tm_hour
= bound
->lazy_values
.hh
;
176 timeval
= mktime(&tm
);
178 printf_error("Failure in mktime(), incorrectly formatted %s timestamp",
183 value
= (int64_t) timeval
;
184 value
*= NSEC_PER_SEC
;
185 value
+= bound
->lazy_values
.ns
;
186 bound
->value
= value
;
197 struct bt_notification
*evaluate_event_notification(
198 struct bt_notification
*notification
,
199 struct trimmer_iterator
*trim_it
,
200 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
201 bool *_event_in_range
, bool *finished
)
205 struct bt_ctf_event
*event
= NULL
, *writer_event
;
206 bool in_range
= true;
207 struct bt_ctf_clock_class
*clock_class
= NULL
;
208 struct bt_ctf_trace
*trace
= NULL
;
209 struct bt_ctf_stream
*stream
= NULL
;
210 struct bt_ctf_stream_class
*stream_class
= NULL
;
211 struct bt_ctf_clock_value
*clock_value
= NULL
;
212 bool lazy_update
= false;
213 struct bt_notification
*new_notification
= NULL
;
214 struct bt_clock_class_priority_map
*cc_prio_map
;
216 event
= bt_notification_event_get_event(notification
);
218 cc_prio_map
= bt_notification_event_get_clock_class_priority_map(
221 writer_event
= trimmer_output_event(trim_it
, event
);
222 assert(writer_event
);
223 new_notification
= bt_notification_event_create(writer_event
, cc_prio_map
);
224 assert(new_notification
);
227 stream
= bt_ctf_event_get_stream(event
);
230 stream_class
= bt_ctf_stream_get_class(stream
);
231 assert(stream_class
);
233 trace
= bt_ctf_stream_class_get_trace(stream_class
);
236 /* FIXME multi-clock? */
237 clock_class
= bt_ctf_trace_get_clock_class_by_index(trace
, 0);
242 clock_value
= bt_ctf_event_get_clock_value(event
, clock_class
);
244 printf_error("Failed to retrieve clock value");
248 clock_ret
= bt_ctf_clock_value_get_value_ns_from_epoch(
251 printf_error("Failed to retrieve clock value timestamp");
254 if (update_lazy_bound(begin
, "begin", ts
, &lazy_update
)) {
257 if (update_lazy_bound(end
, "end", ts
, &lazy_update
)) {
260 if (lazy_update
&& begin
->set
&& end
->set
) {
261 if (begin
->value
> end
->value
) {
262 printf_error("Unexpected: time range begin value is above end value");
266 if (begin
->set
&& ts
< begin
->value
) {
269 if (end
->set
&& ts
> end
->value
) {
277 BT_PUT(new_notification
);
280 bt_put(writer_event
);
284 bt_put(stream_class
);
286 *_event_in_range
= in_range
;
287 return new_notification
;
291 int ns_from_integer_field(struct bt_ctf_field
*integer
, int64_t *ns
)
295 uint64_t raw_clock_value
;
296 struct bt_ctf_field_type
*integer_type
= NULL
;
297 struct bt_ctf_clock_class
*clock_class
= NULL
;
298 struct bt_ctf_clock_value
*clock_value
= NULL
;
300 integer_type
= bt_ctf_field_get_type(integer
);
301 assert(integer_type
);
302 clock_class
= bt_ctf_field_type_integer_get_mapped_clock_class(
309 is_signed
= bt_ctf_field_type_integer_get_signed(integer_type
);
311 ret
= bt_ctf_field_unsigned_integer_get_value(integer
,
317 /* Signed clock values are unsupported. */
322 clock_value
= bt_ctf_clock_value_create(clock_class
, raw_clock_value
);
327 ret
= bt_ctf_clock_value_get_value_ns_from_epoch(clock_value
, ns
);
329 bt_put(integer_type
);
335 static uint64_t ns_from_value(uint64_t frequency
, uint64_t value
)
339 if (frequency
== NSEC_PER_SEC
) {
342 ns
= (uint64_t) ((1e9
* (double) value
) / (double) frequency
);
349 * timestamp minus the offset.
352 int64_t get_raw_timestamp(struct bt_ctf_packet
*writer_packet
,
355 struct bt_ctf_clock_class
*writer_clock_class
;
356 int64_t sec_offset
, cycles_offset
, ns
;
357 struct bt_ctf_trace
*writer_trace
;
358 struct bt_ctf_stream
*writer_stream
;
359 struct bt_ctf_stream_class
*writer_stream_class
;
363 writer_stream
= bt_ctf_packet_get_stream(writer_packet
);
364 assert(writer_stream
);
366 writer_stream_class
= bt_ctf_stream_get_class(writer_stream
);
367 assert(writer_stream_class
);
369 writer_trace
= bt_ctf_stream_class_get_trace(writer_stream_class
);
370 assert(writer_trace
);
372 /* FIXME multi-clock? */
373 writer_clock_class
= bt_ctf_trace_get_clock_class_by_index(
375 assert(writer_clock_class
);
377 ret
= bt_ctf_clock_class_get_offset_s(writer_clock_class
, &sec_offset
);
379 ns
= sec_offset
* NSEC_PER_SEC
;
381 freq
= bt_ctf_clock_class_get_frequency(writer_clock_class
);
382 assert(freq
!= -1ULL);
384 ret
= bt_ctf_clock_class_get_offset_cycles(writer_clock_class
, &cycles_offset
);
387 ns
+= ns_from_value(freq
, cycles_offset
);
389 bt_put(writer_clock_class
);
390 bt_put(writer_trace
);
391 bt_put(writer_stream_class
);
392 bt_put(writer_stream
);
394 return timestamp
- ns
;
398 struct bt_notification
*evaluate_packet_notification(
399 struct bt_notification
*notification
,
400 struct trimmer_iterator
*trim_it
,
401 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
402 bool *_packet_in_range
, bool *finished
)
404 int64_t begin_ns
, pkt_begin_ns
, end_ns
, pkt_end_ns
;
405 bool in_range
= true;
406 struct bt_ctf_packet
*packet
= NULL
, *writer_packet
= NULL
;
407 struct bt_ctf_field
*packet_context
= NULL
,
408 *timestamp_begin
= NULL
,
409 *timestamp_end
= NULL
;
410 struct bt_notification
*new_notification
= NULL
;
411 enum bt_component_status ret
;
412 bool lazy_update
= false;
414 switch (bt_notification_get_type(notification
)) {
415 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
416 packet
= bt_notification_packet_begin_get_packet(notification
);
418 writer_packet
= trimmer_new_packet(trim_it
, packet
);
419 assert(writer_packet
);
421 case BT_NOTIFICATION_TYPE_PACKET_END
:
422 packet
= bt_notification_packet_end_get_packet(notification
);
424 writer_packet
= trimmer_close_packet(trim_it
, packet
);
425 assert(writer_packet
);
431 packet_context
= bt_ctf_packet_get_context(writer_packet
);
432 if (!packet_context
) {
436 if (!bt_ctf_field_is_structure(packet_context
)) {
440 timestamp_begin
= bt_ctf_field_structure_get_field(
441 packet_context
, "timestamp_begin");
442 if (!timestamp_begin
|| !bt_ctf_field_is_integer(timestamp_begin
)) {
445 timestamp_end
= bt_ctf_field_structure_get_field(
446 packet_context
, "timestamp_end");
447 if (!timestamp_end
|| !bt_ctf_field_is_integer(timestamp_end
)) {
451 if (ns_from_integer_field(timestamp_begin
, &pkt_begin_ns
)) {
454 if (ns_from_integer_field(timestamp_end
, &pkt_end_ns
)) {
458 if (update_lazy_bound(begin
, "begin", pkt_begin_ns
, &lazy_update
)) {
461 if (update_lazy_bound(end
, "end", pkt_end_ns
, &lazy_update
)) {
464 if (lazy_update
&& begin
->set
&& end
->set
) {
465 if (begin
->value
> end
->value
) {
466 printf_error("Unexpected: time range begin value is above end value");
471 begin_ns
= begin
->set
? begin
->value
: INT64_MIN
;
472 end_ns
= end
->set
? end
->value
: INT64_MAX
;
475 * Accept if there is any overlap between the selected region and the
478 in_range
= (pkt_end_ns
>= begin_ns
) && (pkt_begin_ns
<= end_ns
);
482 if (pkt_begin_ns
> end_ns
) {
486 if (begin_ns
> pkt_begin_ns
) {
487 ret
= update_packet_context_field(trim_it
->err
, writer_packet
,
489 get_raw_timestamp(writer_packet
, begin_ns
));
493 if (end_ns
< pkt_end_ns
) {
494 ret
= update_packet_context_field(trim_it
->err
, writer_packet
,
496 get_raw_timestamp(writer_packet
, end_ns
));
501 switch (bt_notification_get_type(notification
)) {
502 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
503 new_notification
= bt_notification_packet_begin_create(writer_packet
);
504 assert(new_notification
);
506 case BT_NOTIFICATION_TYPE_PACKET_END
:
507 new_notification
= bt_notification_packet_end_create(writer_packet
);
508 assert(new_notification
);
514 *_packet_in_range
= in_range
;
516 bt_put(writer_packet
);
517 bt_put(packet_context
);
518 bt_put(timestamp_begin
);
519 bt_put(timestamp_end
);
520 return new_notification
;
524 struct bt_notification
*evaluate_stream_notification(
525 struct bt_notification
*notification
,
526 struct trimmer_iterator
*trim_it
)
528 struct bt_ctf_stream
*stream
;
530 stream
= bt_notification_stream_end_get_stream(notification
);
533 /* FIXME: useless copy */
534 return bt_notification_stream_end_create(stream
);
537 /* Return true if the notification should be forwarded. */
539 enum bt_notification_iterator_status
evaluate_notification(
540 struct bt_notification
**notification
,
541 struct trimmer_iterator
*trim_it
,
542 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
545 enum bt_notification_type type
;
546 struct bt_notification
*new_notification
= NULL
;
547 bool finished
= false;
550 type
= bt_notification_get_type(*notification
);
552 case BT_NOTIFICATION_TYPE_EVENT
:
553 new_notification
= evaluate_event_notification(*notification
,
554 trim_it
, begin
, end
, in_range
, &finished
);
556 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
557 case BT_NOTIFICATION_TYPE_PACKET_END
:
558 new_notification
= evaluate_packet_notification(*notification
,
559 trim_it
, begin
, end
, in_range
, &finished
);
561 case BT_NOTIFICATION_TYPE_STREAM_END
:
562 new_notification
= evaluate_stream_notification(*notification
,
566 puts("Unhandled notification type");
569 BT_PUT(*notification
);
570 *notification
= new_notification
;
573 return BT_NOTIFICATION_ITERATOR_STATUS_END
;
576 return BT_NOTIFICATION_ITERATOR_STATUS_OK
;
580 struct bt_notification_iterator_next_return
trimmer_iterator_next(
581 struct bt_private_notification_iterator
*iterator
)
583 struct trimmer_iterator
*trim_it
= NULL
;
584 struct bt_private_component
*component
= NULL
;
585 struct trimmer
*trimmer
= NULL
;
586 struct bt_notification_iterator
*source_it
= NULL
;
587 struct bt_notification_iterator_next_return ret
= {
588 .status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
,
589 .notification
= NULL
,
591 bool notification_in_range
= false;
593 trim_it
= bt_private_notification_iterator_get_user_data(iterator
);
596 component
= bt_private_notification_iterator_get_private_component(
599 trimmer
= bt_private_component_get_user_data(component
);
602 source_it
= trim_it
->input_iterator
;
605 while (!notification_in_range
) {
606 ret
.status
= bt_notification_iterator_next(source_it
);
607 if (ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
611 ret
.notification
= bt_notification_iterator_get_notification(
613 if (!ret
.notification
) {
614 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
618 ret
.status
= evaluate_notification(&ret
.notification
, trim_it
,
619 &trimmer
->begin
, &trimmer
->end
,
620 ¬ification_in_range
);
621 if (!notification_in_range
) {
622 BT_PUT(ret
.notification
);
625 if (ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
635 enum bt_notification_iterator_status
trimmer_iterator_seek_time(
636 struct bt_private_notification_iterator
*iterator
,
639 return BT_NOTIFICATION_ITERATOR_STATUS_OK
;