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
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/ctf-ir/event.h>
43 #include <babeltrace/ctf-ir/stream.h>
44 #include <babeltrace/ctf-ir/stream-class.h>
45 #include <babeltrace/ctf-ir/clock-class.h>
46 #include <babeltrace/ctf-ir/packet.h>
47 #include <babeltrace/ctf-ir/trace.h>
48 #include <babeltrace/ctf-ir/fields.h>
50 #include <plugins-common.h>
53 void trimmer_iterator_finalize(struct bt_private_notification_iterator
*it
)
55 struct trimmer_iterator
*it_data
;
57 it_data
= bt_private_notification_iterator_get_user_data(it
);
60 bt_put(it_data
->input_iterator
);
65 enum bt_notification_iterator_status
trimmer_iterator_init(
66 struct bt_private_notification_iterator
*iterator
,
67 struct bt_private_port
*port
)
69 enum bt_notification_iterator_status ret
=
70 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
71 enum bt_notification_iterator_status it_ret
;
72 struct bt_private_port
*input_port
= NULL
;
73 struct bt_private_connection
*connection
= NULL
;
74 struct bt_private_component
*component
=
75 bt_private_notification_iterator_get_private_component(iterator
);
76 struct trimmer_iterator
*it_data
= g_new0(struct trimmer_iterator
, 1);
79 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
83 /* Create a new iterator on the upstream component. */
84 input_port
= bt_private_component_filter_get_default_input_private_port(
87 connection
= bt_private_port_get_private_connection(input_port
);
90 it_data
->input_iterator
=
91 bt_private_connection_create_notification_iterator(connection
);
92 if (!it_data
->input_iterator
) {
93 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
97 it_ret
= bt_private_notification_iterator_set_user_data(iterator
,
110 int update_lazy_bound(struct trimmer_bound
*bound
, const char *name
,
111 int64_t ts
, bool *lazy_update
)
117 *lazy_update
= false;
123 timeval
= ts
/ NSEC_PER_SEC
;
125 if (bound
->lazy_values
.gmt
) {
126 /* Get day, month, year. */
127 if (!gmtime_r(&timeval
, &tm
)) {
128 printf_error("Failure in gmtime_r()");
131 tm
.tm_sec
= bound
->lazy_values
.ss
;
132 tm
.tm_min
= bound
->lazy_values
.mm
;
133 tm
.tm_hour
= bound
->lazy_values
.hh
;
134 timeval
= timegm(&tm
);
136 printf_error("Failure in timegm(), incorrectly formatted %s timestamp",
141 /* Get day, month, year. */
142 if (!localtime_r(&timeval
, &tm
)) {
143 printf_error("Failure in localtime_r()");
146 tm
.tm_sec
= bound
->lazy_values
.ss
;
147 tm
.tm_min
= bound
->lazy_values
.mm
;
148 tm
.tm_hour
= bound
->lazy_values
.hh
;
149 timeval
= mktime(&tm
);
151 printf_error("Failure in mktime(), incorrectly formatted %s timestamp",
156 value
= (int64_t) timeval
;
157 value
*= NSEC_PER_SEC
;
158 value
+= bound
->lazy_values
.ns
;
159 bound
->value
= value
;
170 enum bt_notification_iterator_status
171 evaluate_event_notification(struct bt_notification
*notification
,
172 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
173 bool *_event_in_range
)
177 struct bt_ctf_event
*event
= NULL
;
178 bool in_range
= true;
179 struct bt_ctf_clock_class
*clock_class
= NULL
;
180 struct bt_ctf_trace
*trace
= NULL
;
181 struct bt_ctf_stream
*stream
= NULL
;
182 struct bt_ctf_stream_class
*stream_class
= NULL
;
183 struct bt_ctf_clock_value
*clock_value
= NULL
;
184 enum bt_notification_iterator_status ret
=
185 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
186 bool lazy_update
= false;
188 event
= bt_notification_event_get_event(notification
);
191 stream
= bt_ctf_event_get_stream(event
);
194 stream_class
= bt_ctf_stream_get_class(stream
);
195 assert(stream_class
);
197 trace
= bt_ctf_stream_class_get_trace(stream_class
);
200 /* FIXME multi-clock? */
201 clock_class
= bt_ctf_trace_get_clock_class(trace
, 0);
206 clock_value
= bt_ctf_event_get_clock_value(event
, clock_class
);
208 printf_error("Failed to retrieve clock value");
209 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
213 clock_ret
= bt_ctf_clock_value_get_value_ns_from_epoch(
216 printf_error("Failed to retrieve clock value timestamp");
217 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
220 if (update_lazy_bound(begin
, "begin", ts
, &lazy_update
)) {
221 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
224 if (update_lazy_bound(end
, "end", ts
, &lazy_update
)) {
225 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
228 if (lazy_update
&& begin
->set
&& end
->set
) {
229 if (begin
->value
> end
->value
) {
230 printf_error("Unexpected: time range begin value is above end value");
231 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
235 if (begin
->set
&& ts
< begin
->value
) {
238 if (end
->set
&& ts
> end
->value
) {
246 bt_put(stream_class
);
248 *_event_in_range
= in_range
;
253 int ns_from_integer_field(struct bt_ctf_field
*integer
, int64_t *ns
)
257 uint64_t raw_clock_value
;
258 struct bt_ctf_field_type
*integer_type
= NULL
;
259 struct bt_ctf_clock_class
*clock_class
= NULL
;
260 struct bt_ctf_clock_value
*clock_value
= NULL
;
262 integer_type
= bt_ctf_field_get_type(integer
);
263 assert(integer_type
);
264 clock_class
= bt_ctf_field_type_integer_get_mapped_clock_class(
271 is_signed
= bt_ctf_field_type_integer_get_signed(integer_type
);
273 ret
= bt_ctf_field_unsigned_integer_get_value(integer
,
279 /* Signed clock values are unsupported. */
283 clock_value
= bt_ctf_clock_value_create(clock_class
, raw_clock_value
);
288 ret
= bt_ctf_clock_value_get_value_ns_from_epoch(clock_value
, ns
);
290 bt_put(integer_type
);
297 enum bt_notification_iterator_status
evaluate_packet_notification(
298 struct bt_notification
*notification
,
299 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
300 bool *_packet_in_range
)
302 enum bt_notification_iterator_status ret
=
303 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
304 int64_t begin_ns
, pkt_begin_ns
, end_ns
, pkt_end_ns
;
305 bool in_range
= true;
306 struct bt_ctf_packet
*packet
= NULL
;
307 struct bt_ctf_field
*packet_context
= NULL
,
308 *timestamp_begin
= NULL
,
309 *timestamp_end
= NULL
;
311 switch (bt_notification_get_type(notification
)) {
312 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
313 packet
= bt_notification_packet_begin_get_packet(notification
);
315 case BT_NOTIFICATION_TYPE_PACKET_END
:
316 packet
= bt_notification_packet_end_get_packet(notification
);
323 packet_context
= bt_ctf_packet_get_context(packet
);
324 if (!packet_context
) {
328 if (!bt_ctf_field_is_structure(packet_context
)) {
332 timestamp_begin
= bt_ctf_field_structure_get_field(
333 packet_context
, "timestamp_begin");
334 if (!timestamp_begin
|| !bt_ctf_field_is_integer(timestamp_begin
)) {
337 timestamp_end
= bt_ctf_field_structure_get_field(
338 packet_context
, "timestamp_end");
339 if (!timestamp_end
|| !bt_ctf_field_is_integer(timestamp_end
)) {
343 if (ns_from_integer_field(timestamp_begin
, &pkt_begin_ns
)) {
346 if (ns_from_integer_field(timestamp_end
, &pkt_end_ns
)) {
350 begin_ns
= begin
->set
? begin
->value
: INT64_MIN
;
351 end_ns
= end
->set
? end
->value
: INT64_MAX
;
354 * Accept if there is any overlap between the selected region and the
357 in_range
= (pkt_end_ns
>= begin_ns
) && (pkt_begin_ns
<= end_ns
);
359 *_packet_in_range
= in_range
;
361 bt_put(packet_context
);
362 bt_put(timestamp_begin
);
363 bt_put(timestamp_end
);
367 /* Return true if the notification should be forwarded. */
369 enum bt_notification_iterator_status
evaluate_notification(
370 struct bt_notification
*notification
,
371 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
374 enum bt_notification_type type
;
375 enum bt_notification_iterator_status ret
=
376 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
379 type
= bt_notification_get_type(notification
);
381 case BT_NOTIFICATION_TYPE_EVENT
:
382 ret
= evaluate_event_notification(notification
, begin
,
385 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
386 case BT_NOTIFICATION_TYPE_PACKET_END
:
387 ret
= evaluate_packet_notification(notification
, begin
,
391 /* Accept all other notifications. */
398 struct bt_notification_iterator_next_return
trimmer_iterator_next(
399 struct bt_private_notification_iterator
*iterator
)
401 struct trimmer_iterator
*trim_it
= NULL
;
402 struct bt_private_component
*component
= NULL
;
403 struct trimmer
*trimmer
= NULL
;
404 struct bt_notification_iterator
*source_it
= NULL
;
405 struct bt_notification_iterator_next_return ret
= {
406 .status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
,
407 .notification
= NULL
,
409 bool notification_in_range
= false;
411 trim_it
= bt_private_notification_iterator_get_user_data(iterator
);
414 component
= bt_private_notification_iterator_get_private_component(
417 trimmer
= bt_private_component_get_user_data(component
);
420 source_it
= trim_it
->input_iterator
;
423 while (!notification_in_range
) {
424 ret
.status
= bt_notification_iterator_next(source_it
);
425 if (ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
429 ret
.notification
= bt_notification_iterator_get_notification(
431 if (!ret
.notification
) {
432 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
436 ret
.status
= evaluate_notification(ret
.notification
,
437 &trimmer
->begin
, &trimmer
->end
,
438 ¬ification_in_range
);
439 if (!notification_in_range
) {
440 bt_put(ret
.notification
);
443 if (ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
453 enum bt_notification_iterator_status
trimmer_iterator_seek_time(
454 struct bt_private_notification_iterator
*iterator
,
457 return BT_NOTIFICATION_ITERATOR_STATUS_OK
;