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/component/notification/iterator.h>
32 #include <babeltrace/component/notification/notification.h>
33 #include <babeltrace/component/notification/event.h>
34 #include <babeltrace/component/notification/stream.h>
35 #include <babeltrace/component/notification/packet.h>
36 #include <babeltrace/component/component-filter.h>
37 #include <babeltrace/component/port.h>
38 #include <babeltrace/component/connection.h>
39 #include <babeltrace/ctf-ir/event.h>
40 #include <babeltrace/ctf-ir/stream.h>
41 #include <babeltrace/ctf-ir/stream-class.h>
42 #include <babeltrace/ctf-ir/clock-class.h>
43 #include <babeltrace/ctf-ir/packet.h>
44 #include <babeltrace/ctf-ir/trace.h>
45 #include <babeltrace/ctf-ir/fields.h>
47 #include <plugins-common.h>
50 void trimmer_iterator_destroy(struct bt_notification_iterator
*it
)
52 struct trimmer_iterator
*it_data
;
54 it_data
= bt_notification_iterator_get_private_data(it
);
57 bt_put(it_data
->current_notification
);
58 bt_put(it_data
->input_iterator
);
63 enum bt_notification_iterator_status
trimmer_iterator_init(
64 struct bt_component
*component
,
65 struct bt_notification_iterator
*iterator
,
66 UNUSED_VAR
void *init_method_data
)
68 enum bt_notification_iterator_status ret
=
69 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
70 enum bt_notification_iterator_status it_ret
;
71 struct bt_port
*input_port
= NULL
;
72 struct bt_connection
*connection
= NULL
;
73 struct trimmer_iterator
*it_data
= g_new0(struct trimmer_iterator
, 1);
76 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
80 /* Create a new iterator on the upstream component. */
81 input_port
= bt_component_filter_get_default_input_port(component
);
83 connection
= bt_port_get_connection(input_port
, 0);
86 it_data
->input_iterator
= bt_connection_create_notification_iterator(
88 if (!it_data
->input_iterator
) {
89 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
93 it_ret
= bt_notification_iterator_set_private_data(iterator
, it_data
);
104 struct bt_notification
*trimmer_iterator_get(
105 struct bt_notification_iterator
*iterator
)
107 struct trimmer_iterator
*trim_it
;
109 trim_it
= bt_notification_iterator_get_private_data(iterator
);
112 if (!trim_it
->current_notification
) {
113 enum bt_notification_iterator_status it_ret
;
115 it_ret
= trimmer_iterator_next(iterator
);
121 return bt_get(trim_it
->current_notification
);
125 int update_lazy_bound(struct trimmer_bound
*bound
, const char *name
,
126 int64_t ts
, bool *lazy_update
)
132 *lazy_update
= false;
138 timeval
= ts
/ NSEC_PER_SEC
;
140 if (bound
->lazy_values
.gmt
) {
141 /* Get day, month, year. */
142 if (!gmtime_r(&timeval
, &tm
)) {
143 printf_error("Failure in gmtime_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
= timegm(&tm
);
151 printf_error("Failure in timegm(), incorrectly formatted %s timestamp",
156 /* Get day, month, year. */
157 if (!localtime_r(&timeval
, &tm
)) {
158 printf_error("Failure in localtime_r()");
161 tm
.tm_sec
= bound
->lazy_values
.ss
;
162 tm
.tm_min
= bound
->lazy_values
.mm
;
163 tm
.tm_hour
= bound
->lazy_values
.hh
;
164 timeval
= mktime(&tm
);
166 printf_error("Failure in mktime(), incorrectly formatted %s timestamp",
171 value
= (int64_t) timeval
;
172 value
*= NSEC_PER_SEC
;
173 value
+= bound
->lazy_values
.ns
;
174 bound
->value
= value
;
185 enum bt_notification_iterator_status
186 evaluate_event_notification(struct bt_notification
*notification
,
187 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
188 bool *_event_in_range
)
192 struct bt_ctf_event
*event
= NULL
;
193 bool in_range
= true;
194 struct bt_ctf_clock_class
*clock_class
= NULL
;
195 struct bt_ctf_trace
*trace
= NULL
;
196 struct bt_ctf_stream
*stream
= NULL
;
197 struct bt_ctf_stream_class
*stream_class
= NULL
;
198 struct bt_ctf_clock_value
*clock_value
= NULL
;
199 enum bt_notification_iterator_status ret
=
200 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
201 bool lazy_update
= false;
203 event
= bt_notification_event_get_event(notification
);
206 stream
= bt_ctf_event_get_stream(event
);
209 stream_class
= bt_ctf_stream_get_class(stream
);
210 assert(stream_class
);
212 trace
= bt_ctf_stream_class_get_trace(stream_class
);
215 /* FIXME multi-clock? */
216 clock_class
= bt_ctf_trace_get_clock_class(trace
, 0);
221 clock_value
= bt_ctf_event_get_clock_value(event
, clock_class
);
223 printf_error("Failed to retrieve clock value");
224 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
228 clock_ret
= bt_ctf_clock_value_get_value_ns_from_epoch(
231 printf_error("Failed to retrieve clock value timestamp");
232 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
235 if (update_lazy_bound(begin
, "begin", ts
, &lazy_update
)) {
236 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
239 if (update_lazy_bound(end
, "end", ts
, &lazy_update
)) {
240 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
243 if (lazy_update
&& begin
->set
&& end
->set
) {
244 if (begin
->value
> end
->value
) {
245 printf_error("Unexpected: time range begin value is above end value");
246 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
250 if (begin
->set
&& ts
< begin
->value
) {
253 if (end
->set
&& ts
> end
->value
) {
261 bt_put(stream_class
);
263 *_event_in_range
= in_range
;
268 int ns_from_integer_field(struct bt_ctf_field
*integer
, int64_t *ns
)
272 uint64_t raw_clock_value
;
273 struct bt_ctf_field_type
*integer_type
= NULL
;
274 struct bt_ctf_clock_class
*clock_class
= NULL
;
275 struct bt_ctf_clock_value
*clock_value
= NULL
;
277 integer_type
= bt_ctf_field_get_type(integer
);
278 assert(integer_type
);
279 clock_class
= bt_ctf_field_type_integer_get_mapped_clock_class(
286 is_signed
= bt_ctf_field_type_integer_get_signed(integer_type
);
288 ret
= bt_ctf_field_unsigned_integer_get_value(integer
,
294 /* Signed clock values are unsupported. */
298 clock_value
= bt_ctf_clock_value_create(clock_class
, raw_clock_value
);
303 ret
= bt_ctf_clock_value_get_value_ns_from_epoch(clock_value
, ns
);
305 bt_put(integer_type
);
312 enum bt_notification_iterator_status
evaluate_packet_notification(
313 struct bt_notification
*notification
,
314 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
315 bool *_packet_in_range
)
317 enum bt_notification_iterator_status ret
=
318 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
319 int64_t begin_ns
, pkt_begin_ns
, end_ns
, pkt_end_ns
;
320 bool in_range
= true;
321 struct bt_ctf_packet
*packet
= NULL
;
322 struct bt_ctf_field
*packet_context
= NULL
,
323 *timestamp_begin
= NULL
,
324 *timestamp_end
= NULL
;
326 switch (bt_notification_get_type(notification
)) {
327 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
328 packet
= bt_notification_packet_begin_get_packet(notification
);
330 case BT_NOTIFICATION_TYPE_PACKET_END
:
331 packet
= bt_notification_packet_end_get_packet(notification
);
338 packet_context
= bt_ctf_packet_get_context(packet
);
339 if (!packet_context
) {
343 if (!bt_ctf_field_is_structure(packet_context
)) {
347 timestamp_begin
= bt_ctf_field_structure_get_field(
348 packet_context
, "timestamp_begin");
349 if (!timestamp_begin
|| !bt_ctf_field_is_integer(timestamp_begin
)) {
352 timestamp_end
= bt_ctf_field_structure_get_field(
353 packet_context
, "timestamp_end");
354 if (!timestamp_end
|| !bt_ctf_field_is_integer(timestamp_end
)) {
358 if (ns_from_integer_field(timestamp_begin
, &pkt_begin_ns
)) {
361 if (ns_from_integer_field(timestamp_end
, &pkt_end_ns
)) {
365 begin_ns
= begin
->set
? begin
->value
: INT64_MIN
;
366 end_ns
= end
->set
? end
->value
: INT64_MAX
;
369 * Accept if there is any overlap between the selected region and the
372 in_range
= (pkt_end_ns
>= begin_ns
) && (pkt_begin_ns
<= end_ns
);
374 *_packet_in_range
= in_range
;
376 bt_put(packet_context
);
377 bt_put(timestamp_begin
);
378 bt_put(timestamp_end
);
382 /* Return true if the notification should be forwarded. */
384 enum bt_notification_iterator_status
evaluate_notification(
385 struct bt_notification
*notification
,
386 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
389 enum bt_notification_type type
;
390 enum bt_notification_iterator_status ret
=
391 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
394 type
= bt_notification_get_type(notification
);
396 case BT_NOTIFICATION_TYPE_EVENT
:
397 ret
= evaluate_event_notification(notification
, begin
,
400 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
401 case BT_NOTIFICATION_TYPE_PACKET_END
:
402 ret
= evaluate_packet_notification(notification
, begin
,
406 /* Accept all other notifications. */
413 enum bt_notification_iterator_status
trimmer_iterator_next(
414 struct bt_notification_iterator
*iterator
)
416 struct trimmer_iterator
*trim_it
= NULL
;
417 struct bt_component
*component
= NULL
;
418 struct trimmer
*trimmer
= NULL
;
419 struct bt_notification_iterator
*source_it
= NULL
;
420 enum bt_notification_iterator_status ret
=
421 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
422 bool notification_in_range
= false;
424 trim_it
= bt_notification_iterator_get_private_data(iterator
);
427 component
= bt_notification_iterator_get_component(iterator
);
429 trimmer
= bt_component_get_private_data(component
);
432 source_it
= trim_it
->input_iterator
;
435 while (!notification_in_range
) {
436 struct bt_notification
*notification
;
438 ret
= bt_notification_iterator_next(source_it
);
439 if (ret
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
443 notification
= bt_notification_iterator_get_notification(
446 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
450 ret
= evaluate_notification(notification
,
451 &trimmer
->begin
, &trimmer
->end
,
452 ¬ification_in_range
);
453 if (notification_in_range
) {
454 BT_MOVE(trim_it
->current_notification
, notification
);
456 bt_put(notification
);
459 if (ret
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
469 enum bt_notification_iterator_status
trimmer_iterator_seek_time(
470 struct bt_notification_iterator
*iterator
, int64_t time
)
472 enum bt_notification_iterator_status ret
;
474 ret
= BT_NOTIFICATION_ITERATOR_STATUS_OK
;