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/private-iterator.h>
33 #include <babeltrace/component/notification/notification.h>
34 #include <babeltrace/component/notification/event.h>
35 #include <babeltrace/component/notification/stream.h>
36 #include <babeltrace/component/notification/packet.h>
37 #include <babeltrace/component/component-filter.h>
38 #include <babeltrace/component/private-component-filter.h>
39 #include <babeltrace/component/private-port.h>
40 #include <babeltrace/component/private-connection.h>
41 #include <babeltrace/component/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_component
*component
,
67 struct bt_private_port
*port
,
68 struct bt_private_notification_iterator
*iterator
)
70 enum bt_notification_iterator_status ret
=
71 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
72 enum bt_notification_iterator_status it_ret
;
73 struct bt_private_port
*input_port
= NULL
;
74 struct bt_private_connection
*connection
= NULL
;
75 struct trimmer_iterator
*it_data
= g_new0(struct trimmer_iterator
, 1);
78 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
82 /* Create a new iterator on the upstream component. */
83 input_port
= bt_private_component_filter_get_default_input_private_port(
86 connection
= bt_private_port_get_private_connection(input_port
);
89 it_data
->input_iterator
=
90 bt_private_connection_create_notification_iterator(connection
);
91 if (!it_data
->input_iterator
) {
92 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
96 it_ret
= bt_private_notification_iterator_set_user_data(iterator
,
108 int update_lazy_bound(struct trimmer_bound
*bound
, const char *name
,
109 int64_t ts
, bool *lazy_update
)
115 *lazy_update
= false;
121 timeval
= ts
/ NSEC_PER_SEC
;
123 if (bound
->lazy_values
.gmt
) {
124 /* Get day, month, year. */
125 if (!gmtime_r(&timeval
, &tm
)) {
126 printf_error("Failure in gmtime_r()");
129 tm
.tm_sec
= bound
->lazy_values
.ss
;
130 tm
.tm_min
= bound
->lazy_values
.mm
;
131 tm
.tm_hour
= bound
->lazy_values
.hh
;
132 timeval
= timegm(&tm
);
134 printf_error("Failure in timegm(), incorrectly formatted %s timestamp",
139 /* Get day, month, year. */
140 if (!localtime_r(&timeval
, &tm
)) {
141 printf_error("Failure in localtime_r()");
144 tm
.tm_sec
= bound
->lazy_values
.ss
;
145 tm
.tm_min
= bound
->lazy_values
.mm
;
146 tm
.tm_hour
= bound
->lazy_values
.hh
;
147 timeval
= mktime(&tm
);
149 printf_error("Failure in mktime(), incorrectly formatted %s timestamp",
154 value
= (int64_t) timeval
;
155 value
*= NSEC_PER_SEC
;
156 value
+= bound
->lazy_values
.ns
;
157 bound
->value
= value
;
168 enum bt_notification_iterator_status
169 evaluate_event_notification(struct bt_notification
*notification
,
170 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
171 bool *_event_in_range
)
175 struct bt_ctf_event
*event
= NULL
;
176 bool in_range
= true;
177 struct bt_ctf_clock_class
*clock_class
= NULL
;
178 struct bt_ctf_trace
*trace
= NULL
;
179 struct bt_ctf_stream
*stream
= NULL
;
180 struct bt_ctf_stream_class
*stream_class
= NULL
;
181 struct bt_ctf_clock_value
*clock_value
= NULL
;
182 enum bt_notification_iterator_status ret
=
183 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
184 bool lazy_update
= false;
186 event
= bt_notification_event_get_event(notification
);
189 stream
= bt_ctf_event_get_stream(event
);
192 stream_class
= bt_ctf_stream_get_class(stream
);
193 assert(stream_class
);
195 trace
= bt_ctf_stream_class_get_trace(stream_class
);
198 /* FIXME multi-clock? */
199 clock_class
= bt_ctf_trace_get_clock_class(trace
, 0);
204 clock_value
= bt_ctf_event_get_clock_value(event
, clock_class
);
206 printf_error("Failed to retrieve clock value");
207 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
211 clock_ret
= bt_ctf_clock_value_get_value_ns_from_epoch(
214 printf_error("Failed to retrieve clock value timestamp");
215 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
218 if (update_lazy_bound(begin
, "begin", ts
, &lazy_update
)) {
219 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
222 if (update_lazy_bound(end
, "end", ts
, &lazy_update
)) {
223 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
226 if (lazy_update
&& begin
->set
&& end
->set
) {
227 if (begin
->value
> end
->value
) {
228 printf_error("Unexpected: time range begin value is above end value");
229 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
233 if (begin
->set
&& ts
< begin
->value
) {
236 if (end
->set
&& ts
> end
->value
) {
244 bt_put(stream_class
);
246 *_event_in_range
= in_range
;
251 int ns_from_integer_field(struct bt_ctf_field
*integer
, int64_t *ns
)
255 uint64_t raw_clock_value
;
256 struct bt_ctf_field_type
*integer_type
= NULL
;
257 struct bt_ctf_clock_class
*clock_class
= NULL
;
258 struct bt_ctf_clock_value
*clock_value
= NULL
;
260 integer_type
= bt_ctf_field_get_type(integer
);
261 assert(integer_type
);
262 clock_class
= bt_ctf_field_type_integer_get_mapped_clock_class(
269 is_signed
= bt_ctf_field_type_integer_get_signed(integer_type
);
271 ret
= bt_ctf_field_unsigned_integer_get_value(integer
,
277 /* Signed clock values are unsupported. */
281 clock_value
= bt_ctf_clock_value_create(clock_class
, raw_clock_value
);
286 ret
= bt_ctf_clock_value_get_value_ns_from_epoch(clock_value
, ns
);
288 bt_put(integer_type
);
295 enum bt_notification_iterator_status
evaluate_packet_notification(
296 struct bt_notification
*notification
,
297 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
298 bool *_packet_in_range
)
300 enum bt_notification_iterator_status ret
=
301 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
302 int64_t begin_ns
, pkt_begin_ns
, end_ns
, pkt_end_ns
;
303 bool in_range
= true;
304 struct bt_ctf_packet
*packet
= NULL
;
305 struct bt_ctf_field
*packet_context
= NULL
,
306 *timestamp_begin
= NULL
,
307 *timestamp_end
= NULL
;
309 switch (bt_notification_get_type(notification
)) {
310 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
311 packet
= bt_notification_packet_begin_get_packet(notification
);
313 case BT_NOTIFICATION_TYPE_PACKET_END
:
314 packet
= bt_notification_packet_end_get_packet(notification
);
321 packet_context
= bt_ctf_packet_get_context(packet
);
322 if (!packet_context
) {
326 if (!bt_ctf_field_is_structure(packet_context
)) {
330 timestamp_begin
= bt_ctf_field_structure_get_field(
331 packet_context
, "timestamp_begin");
332 if (!timestamp_begin
|| !bt_ctf_field_is_integer(timestamp_begin
)) {
335 timestamp_end
= bt_ctf_field_structure_get_field(
336 packet_context
, "timestamp_end");
337 if (!timestamp_end
|| !bt_ctf_field_is_integer(timestamp_end
)) {
341 if (ns_from_integer_field(timestamp_begin
, &pkt_begin_ns
)) {
344 if (ns_from_integer_field(timestamp_end
, &pkt_end_ns
)) {
348 begin_ns
= begin
->set
? begin
->value
: INT64_MIN
;
349 end_ns
= end
->set
? end
->value
: INT64_MAX
;
352 * Accept if there is any overlap between the selected region and the
355 in_range
= (pkt_end_ns
>= begin_ns
) && (pkt_begin_ns
<= end_ns
);
357 *_packet_in_range
= in_range
;
359 bt_put(packet_context
);
360 bt_put(timestamp_begin
);
361 bt_put(timestamp_end
);
365 /* Return true if the notification should be forwarded. */
367 enum bt_notification_iterator_status
evaluate_notification(
368 struct bt_notification
*notification
,
369 struct trimmer_bound
*begin
, struct trimmer_bound
*end
,
372 enum bt_notification_type type
;
373 enum bt_notification_iterator_status ret
=
374 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
377 type
= bt_notification_get_type(notification
);
379 case BT_NOTIFICATION_TYPE_EVENT
:
380 ret
= evaluate_event_notification(notification
, begin
,
383 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
384 case BT_NOTIFICATION_TYPE_PACKET_END
:
385 ret
= evaluate_packet_notification(notification
, begin
,
389 /* Accept all other notifications. */
396 struct bt_notification_iterator_next_return
trimmer_iterator_next(
397 struct bt_private_notification_iterator
*iterator
)
399 struct trimmer_iterator
*trim_it
= NULL
;
400 struct bt_private_component
*component
= NULL
;
401 struct trimmer
*trimmer
= NULL
;
402 struct bt_notification_iterator
*source_it
= NULL
;
403 struct bt_notification_iterator_next_return ret
= {
404 .status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
,
405 .notification
= NULL
,
407 bool notification_in_range
= false;
409 trim_it
= bt_private_notification_iterator_get_user_data(iterator
);
412 component
= bt_private_notification_iterator_get_private_component(
415 trimmer
= bt_private_component_get_user_data(component
);
418 source_it
= trim_it
->input_iterator
;
421 while (!notification_in_range
) {
422 ret
.status
= bt_notification_iterator_next(source_it
);
423 if (ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
427 ret
.notification
= bt_notification_iterator_get_notification(
429 if (!ret
.notification
) {
430 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
434 ret
.status
= evaluate_notification(ret
.notification
,
435 &trimmer
->begin
, &trimmer
->end
,
436 ¬ification_in_range
);
437 if (!notification_in_range
) {
438 bt_put(ret
.notification
);
441 if (ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
451 enum bt_notification_iterator_status
trimmer_iterator_seek_time(
452 struct bt_private_notification_iterator
*iterator
,
455 return BT_NOTIFICATION_ITERATOR_STATUS_OK
;