2 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 #define BT_LOG_TAG "PACKET"
24 #include <babeltrace/lib-logging-internal.h>
26 #include <babeltrace/assert-pre-internal.h>
27 #include <babeltrace/trace-ir/fields-internal.h>
28 #include <babeltrace/trace-ir/packet-const.h>
29 #include <babeltrace/trace-ir/packet.h>
30 #include <babeltrace/trace-ir/packet-internal.h>
31 #include <babeltrace/trace-ir/field-wrapper-internal.h>
32 #include <babeltrace/trace-ir/trace.h>
33 #include <babeltrace/trace-ir/stream-class-internal.h>
34 #include <babeltrace/trace-ir/stream-class.h>
35 #include <babeltrace/trace-ir/stream.h>
36 #include <babeltrace/trace-ir/stream-internal.h>
37 #include <babeltrace/trace-ir/clock-value-internal.h>
38 #include <babeltrace/trace-ir/trace-internal.h>
39 #include <babeltrace/object-internal.h>
40 #include <babeltrace/object.h>
41 #include <babeltrace/assert-internal.h>
44 #define BT_ASSERT_PRE_PACKET_HOT(_packet) \
45 BT_ASSERT_PRE_HOT((_packet), "Packet", ": %!+a", (_packet))
47 struct bt_stream
*bt_packet_borrow_stream(struct bt_packet
*packet
)
49 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
50 return packet
->stream
;
53 const struct bt_stream
*bt_packet_borrow_stream_const(
54 const struct bt_packet
*packet
)
56 return bt_packet_borrow_stream((void *) packet
);
59 struct bt_field
*bt_packet_borrow_header_field(struct bt_packet
*packet
)
61 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
62 return packet
->header_field
? packet
->header_field
->field
: NULL
;
65 const struct bt_field
*bt_packet_borrow_header_field_const(
66 const struct bt_packet
*packet
)
68 return bt_packet_borrow_header_field((void *) packet
);
71 struct bt_field
*bt_packet_borrow_context_field(struct bt_packet
*packet
)
73 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
74 return packet
->context_field
? packet
->context_field
->field
: NULL
;
77 const struct bt_field
*bt_packet_borrow_context_field_const(
78 const struct bt_packet
*packet
)
80 return bt_packet_borrow_context_field((void *) packet
);
84 void _bt_packet_set_is_frozen(const struct bt_packet
*packet
, bool is_frozen
)
90 BT_LIB_LOGD("Setting packet's frozen state: %![packet-]+a, "
91 "is-frozen=%d", packet
, is_frozen
);
93 if (packet
->header_field
) {
94 BT_LOGD_STR("Setting packet's header field's frozen state.");
95 bt_field_set_is_frozen(packet
->header_field
->field
,
99 if (packet
->context_field
) {
100 BT_LOGD_STR("Setting packet's context field's frozen state.");
101 bt_field_set_is_frozen(packet
->context_field
->field
,
105 ((struct bt_packet
*) packet
)->frozen
= is_frozen
;
109 void reset_counter_snapshots(struct bt_packet
*packet
)
111 packet
->discarded_event_counter_snapshot
.base
.avail
=
112 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
;
113 packet
->packet_counter_snapshot
.base
.avail
=
114 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
;
118 void reset_packet(struct bt_packet
*packet
)
121 BT_LIB_LOGD("Resetting packet: %!+a", packet
);
122 bt_packet_set_is_frozen(packet
, false);
124 if (packet
->header_field
) {
125 bt_field_set_is_frozen(packet
->header_field
->field
, false);
126 bt_field_reset(packet
->header_field
->field
);
129 if (packet
->context_field
) {
130 bt_field_set_is_frozen(packet
->context_field
->field
, false);
131 bt_field_reset(packet
->context_field
->field
);
134 if (packet
->default_beginning_cv
) {
135 bt_clock_value_reset(packet
->default_beginning_cv
);
138 if (packet
->default_end_cv
) {
139 bt_clock_value_reset(packet
->default_end_cv
);
142 reset_counter_snapshots(packet
);
146 void recycle_header_field(struct bt_field_wrapper
*header_field
,
147 struct bt_trace
*trace
)
149 BT_ASSERT(header_field
);
150 BT_LIB_LOGD("Recycling packet header field: "
151 "addr=%p, %![trace-]+t, %![field-]+f", header_field
,
152 trace
, header_field
->field
);
153 bt_object_pool_recycle_object(&trace
->packet_header_field_pool
,
158 void recycle_context_field(struct bt_field_wrapper
*context_field
,
159 struct bt_stream_class
*stream_class
)
161 BT_ASSERT(context_field
);
162 BT_LIB_LOGD("Recycling packet context field: "
163 "addr=%p, %![sc-]+S, %![field-]+f", context_field
,
164 stream_class
, context_field
->field
);
165 bt_object_pool_recycle_object(&stream_class
->packet_context_field_pool
,
170 void bt_packet_recycle(struct bt_packet
*packet
)
172 struct bt_stream
*stream
;
175 BT_LIB_LOGD("Recycling packet: %!+a", packet
);
178 * Those are the important ordered steps:
180 * 1. Reset the packet object (put any permanent reference it
181 * has, unfreeze it and its fields in developer mode, etc.),
182 * but do NOT put its stream's reference. This stream
183 * contains the pool to which we're about to recycle this
184 * packet object, so we must guarantee its existence thanks
185 * to this existing reference.
187 * 2. Move the stream reference to our `stream`
188 * variable so that we can set the packet's stream member
189 * to NULL before recycling it. We CANNOT do this after
190 * we put the stream reference because this bt_object_put_ref()
191 * could destroy the stream, also destroying its
192 * packet pool, thus also destroying our packet object (this
193 * would result in an invalid write access).
195 * 3. Recycle the packet object.
197 * 4. Put our stream reference.
199 reset_packet(packet
);
200 stream
= packet
->stream
;
202 packet
->stream
= NULL
;
203 bt_object_pool_recycle_object(&stream
->packet_pool
, packet
);
204 bt_object_put_no_null_check(&stream
->base
);
208 void bt_packet_destroy(struct bt_packet
*packet
)
210 BT_LIB_LOGD("Destroying packet: %!+a", packet
);
212 if (packet
->header_field
) {
213 if (packet
->stream
) {
214 BT_LOGD_STR("Recycling packet's header field.");
215 recycle_header_field(packet
->header_field
,
216 bt_stream_class_borrow_trace_inline(
217 packet
->stream
->class));
219 bt_field_wrapper_destroy(packet
->header_field
);
222 packet
->header_field
= NULL
;
225 if (packet
->context_field
) {
226 if (packet
->stream
) {
227 BT_LOGD_STR("Recycling packet's context field.");
228 recycle_context_field(packet
->context_field
,
229 packet
->stream
->class);
231 bt_field_wrapper_destroy(packet
->context_field
);
234 packet
->context_field
= NULL
;
237 if (packet
->default_beginning_cv
) {
238 BT_LOGD_STR("Recycling beginning clock value.");
239 bt_clock_value_recycle(packet
->default_beginning_cv
);
240 packet
->default_beginning_cv
= NULL
;
243 if (packet
->default_end_cv
) {
244 BT_LOGD_STR("Recycling end clock value.");
245 bt_clock_value_recycle(packet
->default_end_cv
);
246 packet
->default_end_cv
= NULL
;
249 BT_LOGD_STR("Putting packet's stream.");
250 BT_OBJECT_PUT_REF_AND_RESET(packet
->stream
);
255 struct bt_packet
*bt_packet_new(struct bt_stream
*stream
)
257 struct bt_packet
*packet
= NULL
;
258 struct bt_trace
*trace
= NULL
;
261 BT_LIB_LOGD("Creating packet object: %![stream-]+s", stream
);
262 packet
= g_new0(struct bt_packet
, 1);
264 BT_LOGE_STR("Failed to allocate one packet object.");
268 bt_object_init_shared(&packet
->base
,
269 (bt_object_release_func
) bt_packet_recycle
);
270 packet
->stream
= stream
;
271 bt_object_get_no_null_check(stream
);
272 trace
= bt_stream_class_borrow_trace_inline(stream
->class);
275 if (trace
->packet_header_fc
) {
276 BT_LOGD_STR("Creating initial packet header field.");
277 packet
->header_field
= bt_field_wrapper_create(
278 &trace
->packet_header_field_pool
,
279 trace
->packet_header_fc
);
280 if (!packet
->header_field
) {
281 BT_LOGE_STR("Cannot create packet header field wrapper.");
286 if (stream
->class->packet_context_fc
) {
287 BT_LOGD_STR("Creating initial packet context field.");
288 packet
->context_field
= bt_field_wrapper_create(
289 &stream
->class->packet_context_field_pool
,
290 stream
->class->packet_context_fc
);
291 if (!packet
->context_field
) {
292 BT_LOGE_STR("Cannot create packet context field wrapper.");
297 if (stream
->class->default_clock_class
) {
298 if (stream
->class->packets_have_default_beginning_cv
) {
299 packet
->default_beginning_cv
= bt_clock_value_create(
300 stream
->class->default_clock_class
);
301 if (!packet
->default_beginning_cv
) {
302 /* bt_clock_value_create() logs errors */
307 if (stream
->class->packets_have_default_end_cv
) {
308 packet
->default_end_cv
= bt_clock_value_create(
309 stream
->class->default_clock_class
);
310 if (!packet
->default_end_cv
) {
311 /* bt_clock_value_create() logs errors */
317 reset_counter_snapshots(packet
);
318 BT_LIB_LOGD("Created packet object: %!+a", packet
);
322 BT_OBJECT_PUT_REF_AND_RESET(packet
);
328 struct bt_packet
*bt_packet_create(struct bt_stream
*stream
)
330 struct bt_packet
*packet
= NULL
;
332 BT_ASSERT_PRE_NON_NULL(stream
, "Stream");
333 packet
= bt_object_pool_create_object(&stream
->packet_pool
);
334 if (unlikely(!packet
)) {
335 BT_LIB_LOGE("Cannot allocate one packet from stream's packet pool: "
336 "%![stream-]+s", stream
);
340 if (likely(!packet
->stream
)) {
341 packet
->stream
= stream
;
342 bt_object_get_no_null_check_no_parent_check(
343 &packet
->stream
->base
);
347 return (void *) packet
;
350 int bt_packet_move_header_field(struct bt_packet
*packet
,
351 struct bt_packet_header_field
*header_field
)
353 struct bt_trace
*trace
;
354 struct bt_field_wrapper
*field_wrapper
= (void *) header_field
;
356 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
357 BT_ASSERT_PRE_NON_NULL(field_wrapper
, "Header field");
358 BT_ASSERT_PRE_PACKET_HOT(packet
);
359 trace
= bt_stream_class_borrow_trace_inline(packet
->stream
->class);
360 BT_ASSERT_PRE(trace
->packet_header_fc
,
361 "Trace has no packet header field classe: %!+t",
363 BT_ASSERT_PRE(field_wrapper
->field
->class ==
364 trace
->packet_header_fc
,
365 "Unexpected packet header field's class: "
366 "%![fc-]+F, %![expected-fc-]+F", field_wrapper
->field
->class,
367 trace
->packet_header_fc
);
369 /* Recycle current header field: always exists */
370 BT_ASSERT(packet
->header_field
);
371 recycle_header_field(packet
->header_field
, trace
);
374 packet
->header_field
= field_wrapper
;
378 int bt_packet_move_context_field(struct bt_packet
*packet
,
379 struct bt_packet_context_field
*context_field
)
381 struct bt_stream_class
*stream_class
;
382 struct bt_field_wrapper
*field_wrapper
= (void *) context_field
;
384 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
385 BT_ASSERT_PRE_NON_NULL(field_wrapper
, "Context field");
386 BT_ASSERT_PRE_HOT(packet
, "Packet", ": %!+a", packet
);
387 stream_class
= packet
->stream
->class;
388 BT_ASSERT_PRE(stream_class
->packet_context_fc
,
389 "Stream class has no packet context field classe: %!+S",
391 BT_ASSERT_PRE(field_wrapper
->field
->class ==
392 stream_class
->packet_context_fc
,
393 "Unexpected packet header field's class: "
394 "%![fc-]+F, %![expected-fc-]+F", field_wrapper
->field
->class,
395 stream_class
->packet_context_fc
);
397 /* Recycle current context field: always exists */
398 BT_ASSERT(packet
->context_field
);
399 recycle_context_field(packet
->context_field
, stream_class
);
402 packet
->context_field
= field_wrapper
;
406 void bt_packet_set_default_beginning_clock_value(struct bt_packet
*packet
,
407 uint64_t value_cycles
)
409 struct bt_stream_class
*sc
;
411 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
412 BT_ASSERT_PRE_PACKET_HOT(packet
);
413 sc
= packet
->stream
->class;
415 BT_ASSERT_PRE(sc
->default_clock_class
,
416 "Packet's stream class has no default clock class: "
417 "%![packet-]+a, %![sc-]+S", packet
, sc
);
418 BT_ASSERT_PRE(sc
->packets_have_default_beginning_cv
,
419 "Packet's stream class indicates that its packets have "
420 "no default beginning clock value: %![packet-]+a, %![sc-]+S",
422 BT_ASSERT(packet
->default_beginning_cv
);
423 bt_clock_value_set_value_inline(packet
->default_beginning_cv
,
425 BT_LIB_LOGV("Set packet's default beginning clock value: "
426 "%![packet-]+a, value=%" PRIu64
, packet
, value_cycles
);
429 enum bt_clock_value_status
bt_packet_borrow_default_beginning_clock_value(
430 const struct bt_packet
*packet
,
431 const struct bt_clock_value
**clock_value
)
433 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
434 BT_ASSERT_PRE_NON_NULL(clock_value
, "Clock value (output)");
435 *clock_value
= packet
->default_beginning_cv
;
436 return BT_CLOCK_VALUE_STATUS_KNOWN
;
439 void bt_packet_set_default_end_clock_value(struct bt_packet
*packet
,
440 uint64_t value_cycles
)
442 struct bt_stream_class
*sc
;
444 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
445 BT_ASSERT_PRE_PACKET_HOT(packet
);
446 sc
= packet
->stream
->class;
448 BT_ASSERT_PRE(sc
->default_clock_class
,
449 "Packet's stream class has no default clock class: "
450 "%![packet-]+a, %![sc-]+S", packet
, sc
);
451 BT_ASSERT_PRE(sc
->packets_have_default_end_cv
,
452 "Packet's stream class indicates that its packets have "
453 "no default end clock value: %![packet-]+a, %![sc-]+S",
455 BT_ASSERT(packet
->default_end_cv
);
456 bt_clock_value_set_value_inline(packet
->default_end_cv
, value_cycles
);
457 BT_LIB_LOGV("Set packet's default end clock value: "
458 "%![packet-]+a, value=%" PRIu64
, packet
, value_cycles
);
461 enum bt_clock_value_status
bt_packet_borrow_default_end_clock_value(
462 const struct bt_packet
*packet
,
463 const struct bt_clock_value
**clock_value
)
465 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
466 BT_ASSERT_PRE_NON_NULL(clock_value
, "Clock value (output)");
467 *clock_value
= packet
->default_end_cv
;
468 return BT_CLOCK_VALUE_STATUS_KNOWN
;
471 enum bt_property_availability
bt_packet_get_discarded_event_counter_snapshot(
472 const struct bt_packet
*packet
, uint64_t *value
)
474 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
475 BT_ASSERT_PRE_NON_NULL(value
, "Value (output)");
476 *value
= packet
->discarded_event_counter_snapshot
.value
;
477 return packet
->discarded_event_counter_snapshot
.base
.avail
;
480 void bt_packet_set_discarded_event_counter_snapshot(struct bt_packet
*packet
,
483 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
484 BT_ASSERT_PRE_PACKET_HOT(packet
);
485 BT_ASSERT_PRE(packet
->stream
->class->packets_have_discarded_event_counter_snapshot
,
486 "Packet's stream's discarded event counter is not enabled: "
487 "%![packet-]+a", packet
);
488 bt_property_uint_set(&packet
->discarded_event_counter_snapshot
, value
);
491 enum bt_property_availability
bt_packet_get_packet_counter_snapshot(
492 const struct bt_packet
*packet
, uint64_t *value
)
494 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
495 BT_ASSERT_PRE_NON_NULL(value
, "Value (output)");
496 *value
= packet
->packet_counter_snapshot
.value
;
497 return packet
->packet_counter_snapshot
.base
.avail
;
500 void bt_packet_set_packet_counter_snapshot(struct bt_packet
*packet
,
503 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
504 BT_ASSERT_PRE_PACKET_HOT(packet
);
505 BT_ASSERT_PRE(packet
->stream
->class->packets_have_packet_counter_snapshot
,
506 "Packet's stream's packet counter is not enabled: "
507 "%![packet-]+a", packet
);
508 bt_property_uint_set(&packet
->packet_counter_snapshot
, value
);