2 * Copyright 2016-2018 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/field-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-snapshot-internal.h>
38 #include <babeltrace/trace-ir/trace-internal.h>
39 #include <babeltrace/object-internal.h>
40 #include <babeltrace/assert-internal.h>
43 #define BT_ASSERT_PRE_PACKET_HOT(_packet) \
44 BT_ASSERT_PRE_HOT((_packet), "Packet", ": %!+a", (_packet))
46 struct bt_stream
*bt_packet_borrow_stream(struct bt_packet
*packet
)
48 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
49 return packet
->stream
;
52 const struct bt_stream
*bt_packet_borrow_stream_const(
53 const struct bt_packet
*packet
)
55 return bt_packet_borrow_stream((void *) packet
);
58 struct bt_field
*bt_packet_borrow_header_field(struct bt_packet
*packet
)
60 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
61 return packet
->header_field
? packet
->header_field
->field
: NULL
;
64 const struct bt_field
*bt_packet_borrow_header_field_const(
65 const struct bt_packet
*packet
)
67 return bt_packet_borrow_header_field((void *) packet
);
70 struct bt_field
*bt_packet_borrow_context_field(struct bt_packet
*packet
)
72 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
73 return packet
->context_field
? packet
->context_field
->field
: NULL
;
76 const struct bt_field
*bt_packet_borrow_context_field_const(
77 const struct bt_packet
*packet
)
79 return bt_packet_borrow_context_field((void *) packet
);
83 void _bt_packet_set_is_frozen(const struct bt_packet
*packet
, bool is_frozen
)
89 BT_LIB_LOGD("Setting packet's frozen state: %![packet-]+a, "
90 "is-frozen=%d", packet
, is_frozen
);
92 if (packet
->header_field
) {
93 BT_LOGD_STR("Setting packet's header field's frozen state.");
94 bt_field_set_is_frozen(packet
->header_field
->field
,
98 if (packet
->context_field
) {
99 BT_LOGD_STR("Setting packet's context field's frozen state.");
100 bt_field_set_is_frozen(packet
->context_field
->field
,
104 ((struct bt_packet
*) packet
)->frozen
= is_frozen
;
108 void reset_counter_snapshots(struct bt_packet
*packet
)
110 packet
->discarded_event_counter_snapshot
.base
.avail
=
111 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
;
112 packet
->packet_counter_snapshot
.base
.avail
=
113 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
;
117 void reset_packet(struct bt_packet
*packet
)
120 BT_LIB_LOGD("Resetting packet: %!+a", packet
);
121 bt_packet_set_is_frozen(packet
, false);
123 if (packet
->header_field
) {
124 bt_field_set_is_frozen(packet
->header_field
->field
, false);
125 bt_field_reset(packet
->header_field
->field
);
128 if (packet
->context_field
) {
129 bt_field_set_is_frozen(packet
->context_field
->field
, false);
130 bt_field_reset(packet
->context_field
->field
);
133 if (packet
->default_beginning_cs
) {
134 bt_clock_snapshot_reset(packet
->default_beginning_cs
);
137 if (packet
->default_end_cs
) {
138 bt_clock_snapshot_reset(packet
->default_end_cs
);
141 reset_counter_snapshots(packet
);
145 void recycle_header_field(struct bt_field_wrapper
*header_field
,
146 struct bt_trace_class
*tc
)
148 BT_ASSERT(header_field
);
149 BT_LIB_LOGD("Recycling packet header field: "
150 "addr=%p, %![tc-]+T, %![field-]+f", header_field
,
151 tc
, header_field
->field
);
152 bt_object_pool_recycle_object(&tc
->packet_header_field_pool
,
157 void recycle_context_field(struct bt_field_wrapper
*context_field
,
158 struct bt_stream_class
*stream_class
)
160 BT_ASSERT(context_field
);
161 BT_LIB_LOGD("Recycling packet context field: "
162 "addr=%p, %![sc-]+S, %![field-]+f", context_field
,
163 stream_class
, context_field
->field
);
164 bt_object_pool_recycle_object(&stream_class
->packet_context_field_pool
,
169 void bt_packet_recycle(struct bt_packet
*packet
)
171 struct bt_stream
*stream
;
174 BT_LIB_LOGD("Recycling packet: %!+a", packet
);
177 * Those are the important ordered steps:
179 * 1. Reset the packet object (put any permanent reference it
180 * has, unfreeze it and its fields in developer mode, etc.),
181 * but do NOT put its stream's reference. This stream
182 * contains the pool to which we're about to recycle this
183 * packet object, so we must guarantee its existence thanks
184 * to this existing reference.
186 * 2. Move the stream reference to our `stream`
187 * variable so that we can set the packet's stream member
188 * to NULL before recycling it. We CANNOT do this after
189 * we put the stream reference because this bt_object_put_ref()
190 * could destroy the stream, also destroying its
191 * packet pool, thus also destroying our packet object (this
192 * would result in an invalid write access).
194 * 3. Recycle the packet object.
196 * 4. Put our stream reference.
198 reset_packet(packet
);
199 stream
= packet
->stream
;
201 packet
->stream
= NULL
;
202 bt_object_pool_recycle_object(&stream
->packet_pool
, packet
);
203 bt_object_put_no_null_check(&stream
->base
);
207 void bt_packet_destroy(struct bt_packet
*packet
)
209 BT_LIB_LOGD("Destroying packet: %!+a", packet
);
211 if (packet
->header_field
) {
212 if (packet
->stream
) {
213 BT_LOGD_STR("Recycling packet's header field.");
214 recycle_header_field(packet
->header_field
,
215 bt_stream_class_borrow_trace_class_inline(
216 packet
->stream
->class));
218 bt_field_wrapper_destroy(packet
->header_field
);
221 packet
->header_field
= NULL
;
224 if (packet
->context_field
) {
225 if (packet
->stream
) {
226 BT_LOGD_STR("Recycling packet's context field.");
227 recycle_context_field(packet
->context_field
,
228 packet
->stream
->class);
230 bt_field_wrapper_destroy(packet
->context_field
);
233 packet
->context_field
= NULL
;
236 if (packet
->default_beginning_cs
) {
237 BT_LOGD_STR("Recycling beginning clock snapshot.");
238 bt_clock_snapshot_recycle(packet
->default_beginning_cs
);
239 packet
->default_beginning_cs
= NULL
;
242 if (packet
->default_end_cs
) {
243 BT_LOGD_STR("Recycling end clock snapshot.");
244 bt_clock_snapshot_recycle(packet
->default_end_cs
);
245 packet
->default_end_cs
= NULL
;
248 BT_LOGD_STR("Putting packet's stream.");
249 BT_OBJECT_PUT_REF_AND_RESET(packet
->stream
);
254 struct bt_packet
*bt_packet_new(struct bt_stream
*stream
)
256 struct bt_packet
*packet
= NULL
;
257 struct bt_trace_class
*trace_class
= NULL
;
260 BT_LIB_LOGD("Creating packet object: %![stream-]+s", stream
);
261 packet
= g_new0(struct bt_packet
, 1);
263 BT_LOGE_STR("Failed to allocate one packet object.");
267 bt_object_init_shared(&packet
->base
,
268 (bt_object_release_func
) bt_packet_recycle
);
269 packet
->stream
= stream
;
270 bt_object_get_no_null_check(stream
);
271 trace_class
= bt_stream_class_borrow_trace_class_inline(stream
->class);
272 BT_ASSERT(trace_class
);
274 if (trace_class
->packet_header_fc
) {
275 BT_LOGD_STR("Creating initial packet header field.");
276 packet
->header_field
= bt_field_wrapper_create(
277 &trace_class
->packet_header_field_pool
,
278 trace_class
->packet_header_fc
);
279 if (!packet
->header_field
) {
280 BT_LOGE_STR("Cannot create packet header field wrapper.");
285 if (stream
->class->packet_context_fc
) {
286 BT_LOGD_STR("Creating initial packet context field.");
287 packet
->context_field
= bt_field_wrapper_create(
288 &stream
->class->packet_context_field_pool
,
289 stream
->class->packet_context_fc
);
290 if (!packet
->context_field
) {
291 BT_LOGE_STR("Cannot create packet context field wrapper.");
296 if (stream
->class->default_clock_class
) {
297 if (stream
->class->packets_have_default_beginning_cs
) {
298 packet
->default_beginning_cs
= bt_clock_snapshot_create(
299 stream
->class->default_clock_class
);
300 if (!packet
->default_beginning_cs
) {
301 /* bt_clock_snapshot_create() logs errors */
306 if (stream
->class->packets_have_default_end_cs
) {
307 packet
->default_end_cs
= bt_clock_snapshot_create(
308 stream
->class->default_clock_class
);
309 if (!packet
->default_end_cs
) {
310 /* bt_clock_snapshot_create() logs errors */
316 reset_counter_snapshots(packet
);
317 BT_LIB_LOGD("Created packet object: %!+a", packet
);
321 BT_OBJECT_PUT_REF_AND_RESET(packet
);
327 struct bt_packet
*bt_packet_create(struct bt_stream
*stream
)
329 struct bt_packet
*packet
= NULL
;
331 BT_ASSERT_PRE_NON_NULL(stream
, "Stream");
332 packet
= bt_object_pool_create_object(&stream
->packet_pool
);
333 if (unlikely(!packet
)) {
334 BT_LIB_LOGE("Cannot allocate one packet from stream's packet pool: "
335 "%![stream-]+s", stream
);
339 if (likely(!packet
->stream
)) {
340 packet
->stream
= stream
;
341 bt_object_get_no_null_check_no_parent_check(
342 &packet
->stream
->base
);
346 return (void *) packet
;
349 int bt_packet_move_header_field(struct bt_packet
*packet
,
350 struct bt_packet_header_field
*header_field
)
352 struct bt_trace_class
*tc
;
353 struct bt_field_wrapper
*field_wrapper
= (void *) header_field
;
355 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
356 BT_ASSERT_PRE_NON_NULL(field_wrapper
, "Header field");
357 BT_ASSERT_PRE_PACKET_HOT(packet
);
358 tc
= bt_stream_class_borrow_trace_class_inline(packet
->stream
->class);
359 BT_ASSERT_PRE(tc
->packet_header_fc
,
360 "Trace class has no packet header field class: %!+T", tc
);
361 BT_ASSERT_PRE(field_wrapper
->field
->class ==
362 tc
->packet_header_fc
,
363 "Unexpected packet header field's class: "
364 "%![fc-]+F, %![expected-fc-]+F", field_wrapper
->field
->class,
365 tc
->packet_header_fc
);
367 /* Recycle current header field: always exists */
368 BT_ASSERT(packet
->header_field
);
369 recycle_header_field(packet
->header_field
, tc
);
372 packet
->header_field
= field_wrapper
;
376 int bt_packet_move_context_field(struct bt_packet
*packet
,
377 struct bt_packet_context_field
*context_field
)
379 struct bt_stream_class
*stream_class
;
380 struct bt_field_wrapper
*field_wrapper
= (void *) context_field
;
382 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
383 BT_ASSERT_PRE_NON_NULL(field_wrapper
, "Context field");
384 BT_ASSERT_PRE_HOT(packet
, "Packet", ": %!+a", packet
);
385 stream_class
= packet
->stream
->class;
386 BT_ASSERT_PRE(stream_class
->packet_context_fc
,
387 "Stream class has no packet context field class: %!+S",
389 BT_ASSERT_PRE(field_wrapper
->field
->class ==
390 stream_class
->packet_context_fc
,
391 "Unexpected packet header field's class: "
392 "%![fc-]+F, %![expected-fc-]+F", field_wrapper
->field
->class,
393 stream_class
->packet_context_fc
);
395 /* Recycle current context field: always exists */
396 BT_ASSERT(packet
->context_field
);
397 recycle_context_field(packet
->context_field
, stream_class
);
400 packet
->context_field
= field_wrapper
;
404 void bt_packet_set_default_beginning_clock_snapshot(struct bt_packet
*packet
,
405 uint64_t value_cycles
)
407 struct bt_stream_class
*sc
;
409 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
410 BT_ASSERT_PRE_PACKET_HOT(packet
);
411 sc
= packet
->stream
->class;
413 BT_ASSERT_PRE(sc
->default_clock_class
,
414 "Packet's stream class has no default clock class: "
415 "%![packet-]+a, %![sc-]+S", packet
, sc
);
416 BT_ASSERT_PRE(sc
->packets_have_default_beginning_cs
,
417 "Packet's stream class indicates that its packets have "
418 "no default beginning clock snapshot: %![packet-]+a, %![sc-]+S",
420 BT_ASSERT(packet
->default_beginning_cs
);
421 bt_clock_snapshot_set_value_inline(packet
->default_beginning_cs
,
423 BT_LIB_LOGV("Set packet's default beginning clock snapshot: "
424 "%![packet-]+a, value=%" PRIu64
, packet
, value_cycles
);
427 enum bt_clock_snapshot_status
bt_packet_borrow_default_beginning_clock_snapshot(
428 const struct bt_packet
*packet
,
429 const struct bt_clock_snapshot
**clock_snapshot
)
431 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
432 BT_ASSERT_PRE_NON_NULL(clock_snapshot
, "Clock snapshot (output)");
433 *clock_snapshot
= packet
->default_beginning_cs
;
434 return BT_CLOCK_SNAPSHOT_STATUS_KNOWN
;
437 void bt_packet_set_default_end_clock_snapshot(struct bt_packet
*packet
,
438 uint64_t value_cycles
)
440 struct bt_stream_class
*sc
;
442 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
443 BT_ASSERT_PRE_PACKET_HOT(packet
);
444 sc
= packet
->stream
->class;
446 BT_ASSERT_PRE(sc
->default_clock_class
,
447 "Packet's stream class has no default clock class: "
448 "%![packet-]+a, %![sc-]+S", packet
, sc
);
449 BT_ASSERT_PRE(sc
->packets_have_default_end_cs
,
450 "Packet's stream class indicates that its packets have "
451 "no default end clock snapshot: %![packet-]+a, %![sc-]+S",
453 BT_ASSERT(packet
->default_end_cs
);
454 bt_clock_snapshot_set_value_inline(packet
->default_end_cs
, value_cycles
);
455 BT_LIB_LOGV("Set packet's default end clock snapshot: "
456 "%![packet-]+a, value=%" PRIu64
, packet
, value_cycles
);
459 enum bt_clock_snapshot_status
bt_packet_borrow_default_end_clock_snapshot(
460 const struct bt_packet
*packet
,
461 const struct bt_clock_snapshot
**clock_snapshot
)
463 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
464 BT_ASSERT_PRE_NON_NULL(clock_snapshot
, "Clock snapshot (output)");
465 *clock_snapshot
= packet
->default_end_cs
;
466 return BT_CLOCK_SNAPSHOT_STATUS_KNOWN
;
469 enum bt_property_availability
bt_packet_get_discarded_event_counter_snapshot(
470 const struct bt_packet
*packet
, uint64_t *value
)
472 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
473 BT_ASSERT_PRE_NON_NULL(value
, "Value (output)");
474 *value
= packet
->discarded_event_counter_snapshot
.value
;
475 return packet
->discarded_event_counter_snapshot
.base
.avail
;
478 void bt_packet_set_discarded_event_counter_snapshot(struct bt_packet
*packet
,
481 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
482 BT_ASSERT_PRE_PACKET_HOT(packet
);
483 BT_ASSERT_PRE(packet
->stream
->class->packets_have_discarded_event_counter_snapshot
,
484 "Packet's stream's discarded event counter is not enabled: "
485 "%![packet-]+a", packet
);
486 bt_property_uint_set(&packet
->discarded_event_counter_snapshot
, value
);
489 enum bt_property_availability
bt_packet_get_packet_counter_snapshot(
490 const struct bt_packet
*packet
, uint64_t *value
)
492 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
493 BT_ASSERT_PRE_NON_NULL(value
, "Value (output)");
494 *value
= packet
->packet_counter_snapshot
.value
;
495 return packet
->packet_counter_snapshot
.base
.avail
;
498 void bt_packet_set_packet_counter_snapshot(struct bt_packet
*packet
,
501 BT_ASSERT_PRE_NON_NULL(packet
, "Packet");
502 BT_ASSERT_PRE_PACKET_HOT(packet
);
503 BT_ASSERT_PRE(packet
->stream
->class->packets_have_packet_counter_snapshot
,
504 "Packet's stream's packet counter is not enabled: "
505 "%![packet-]+a", packet
);
506 bt_property_uint_set(&packet
->packet_counter_snapshot
, value
);
509 void bt_packet_get_ref(const struct bt_packet
*packet
)
511 bt_object_get_ref(packet
);
514 void bt_packet_put_ref(const struct bt_packet
*packet
)
516 bt_object_put_ref(packet
);