#include <babeltrace/ctf-ir/fields-internal.h>
#include <babeltrace/ctf-ir/packet.h>
#include <babeltrace/ctf-ir/packet-internal.h>
+#include <babeltrace/ctf-ir/field-wrapper-internal.h>
#include <babeltrace/ctf-ir/trace.h>
#include <babeltrace/ctf-ir/stream-class-internal.h>
#include <babeltrace/ctf-ir/stream-class.h>
#include <babeltrace/ctf-ir/stream.h>
#include <babeltrace/ctf-ir/stream-internal.h>
+#include <babeltrace/ctf-ir/clock-value-internal.h>
#include <babeltrace/ctf-ir/trace-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/ref.h>
#include <babeltrace/assert-internal.h>
#include <inttypes.h>
+#define BT_ASSERT_PRE_PACKET_HOT(_packet) \
+ BT_ASSERT_PRE_HOT((_packet), "Packet", ": %!+a", (_packet))
+
struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet)
{
BT_ASSERT_PRE_NON_NULL(packet, "Packet");
return packet->stream;
}
-struct bt_field *bt_packet_borrow_header(
- struct bt_packet *packet)
+struct bt_field *bt_packet_borrow_header_field(struct bt_packet *packet)
{
BT_ASSERT_PRE_NON_NULL(packet, "Packet");
- return packet->header;
+ return packet->header_field ? packet->header_field->field : NULL;
}
-BT_ASSERT_PRE_FUNC
-static inline bool validate_field_to_set(struct bt_field *field,
- struct bt_field_type_common *expected_ft)
+struct bt_field *bt_packet_borrow_context_field(struct bt_packet *packet)
{
- bool ret = true;
+ BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ return packet->context_field ? packet->context_field->field : NULL;
+}
- if (!field) {
- if (expected_ft) {
- BT_ASSERT_PRE_MSG("Setting no field, but expected "
- "field type is not NULL: "
- "%![field-]+f, %![expected-ft-]+F",
- field, expected_ft);
- ret = false;
- goto end;
- }
+BT_HIDDEN
+void _bt_packet_set_is_frozen(struct bt_packet *packet, bool is_frozen)
+{
+ if (!packet) {
+ return;
+ }
- goto end;
+ BT_LIB_LOGD("Setting packet's frozen state: %![packet-]+a, "
+ "is-frozen=%d", packet, is_frozen);
+
+ if (packet->header_field) {
+ BT_LOGD_STR("Setting packet's header field's frozen state.");
+ bt_field_set_is_frozen(packet->header_field->field,
+ is_frozen);
}
- if (bt_field_type_compare(bt_field_borrow_type(field),
- BT_FROM_COMMON(expected_ft)) != 0) {
- BT_ASSERT_PRE_MSG("Field type is different from expected "
- " field type: %![field-ft-]+F, %![expected-ft-]+F",
- bt_field_borrow_type(field), expected_ft);
- ret = false;
- goto end;
+ if (packet->context_field) {
+ BT_LOGD_STR("Setting packet's context field's frozen state.");
+ bt_field_set_is_frozen(packet->context_field->field,
+ is_frozen);
}
-end:
- return ret;
+ packet->frozen = is_frozen;
}
-int bt_packet_set_header(struct bt_packet *packet,
- struct bt_field *header)
+static inline
+void reset_counter_snapshots(struct bt_packet *packet)
{
- BT_ASSERT_PRE_NON_NULL(packet, "Packet");
- BT_ASSERT_PRE_HOT(packet, "Packet", ": +%!+a", packet);
- BT_ASSERT_PRE(validate_field_to_set(header,
- bt_stream_class_borrow_trace(
- BT_FROM_COMMON(packet->stream->common.stream_class))->common.packet_header_field_type),
- "Invalid packet header field: "
- "%![packet-]+a, %![field-]+f", packet, header);
- bt_put(packet->header);
- packet->header = bt_get(header);
- BT_LOGV("Set packet's header field: packet-addr=%p, packet-header-addr=%p",
- packet, header);
- return 0;
+ packet->discarded_event_counter_snapshot.base.avail =
+ BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
+ packet->packet_counter_snapshot.base.avail =
+ BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
}
-struct bt_field *bt_packet_borrow_context(struct bt_packet *packet)
+static inline
+void reset_packet(struct bt_packet *packet)
{
- BT_ASSERT_PRE_NON_NULL(packet, "Packet");
- return packet->context;
+ BT_ASSERT(packet);
+ BT_LIB_LOGD("Resetting packet: %!+a", packet);
+ bt_packet_set_is_frozen(packet, false);
+
+ if (packet->header_field) {
+ bt_field_set_is_frozen(packet->header_field->field, false);
+ bt_field_reset(packet->header_field->field);
+ }
+
+ if (packet->context_field) {
+ bt_field_set_is_frozen(packet->context_field->field, false);
+ bt_field_reset(packet->context_field->field);
+ }
+
+ if (packet->default_beginning_cv) {
+ bt_clock_value_reset(packet->default_beginning_cv);
+ }
+
+ if (packet->default_end_cv) {
+ bt_clock_value_reset(packet->default_end_cv);
+ }
+
+ reset_counter_snapshots(packet);
}
-int bt_packet_set_context(struct bt_packet *packet,
- struct bt_field *context)
+static
+void recycle_header_field(struct bt_field_wrapper *header_field,
+ struct bt_trace *trace)
{
- BT_ASSERT_PRE_NON_NULL(packet, "Packet");
- BT_ASSERT_PRE_HOT(packet, "Packet", ": +%!+a", packet);
- BT_ASSERT_PRE(validate_field_to_set(context,
- BT_FROM_COMMON(packet->stream->common.stream_class->packet_context_field_type)),
- "Invalid packet context field: "
- "%![packet-]+a, %![field-]+f", packet, context);
- bt_put(packet->context);
- packet->context = bt_get(context);
- BT_LOGV("Set packet's context field: packet-addr=%p, packet-context-addr=%p",
- packet, context);
- return 0;
+ BT_ASSERT(header_field);
+ BT_LIB_LOGD("Recycling packet header field: "
+ "addr=%p, %![trace-]+t, %![field-]+f", header_field,
+ trace, header_field->field);
+ bt_object_pool_recycle_object(&trace->packet_header_field_pool,
+ header_field);
+}
+
+static
+void recycle_context_field(struct bt_field_wrapper *context_field,
+ struct bt_stream_class *stream_class)
+{
+ BT_ASSERT(context_field);
+ BT_LIB_LOGD("Recycling packet context field: "
+ "addr=%p, %![sc-]+S, %![field-]+f", context_field,
+ stream_class, context_field->field);
+ bt_object_pool_recycle_object(&stream_class->packet_context_field_pool,
+ context_field);
}
BT_HIDDEN
-void _bt_packet_freeze(struct bt_packet *packet)
+void bt_packet_recycle(struct bt_packet *packet)
{
- if (!packet || packet->frozen) {
- return;
- }
+ struct bt_stream *stream;
- BT_LOGD("Freezing packet: addr=%p", packet);
- BT_LOGD_STR("Freezing packet's header field.");
- bt_field_freeze_recursive(packet->header);
- BT_LOGD_STR("Freezing packet's context field.");
- bt_field_freeze_recursive(packet->context);
- packet->frozen = 1;
+ BT_ASSERT(packet);
+ BT_LIB_LOGD("Recycling packet: %!+a", packet);
+
+ /*
+ * Those are the important ordered steps:
+ *
+ * 1. Reset the packet object (put any permanent reference it
+ * has, unfreeze it and its fields in developer mode, etc.),
+ * but do NOT put its stream's reference. This stream
+ * contains the pool to which we're about to recycle this
+ * packet object, so we must guarantee its existence thanks
+ * to this existing reference.
+ *
+ * 2. Move the stream reference to our `stream`
+ * variable so that we can set the packet's stream member
+ * to NULL before recycling it. We CANNOT do this after
+ * we put the stream reference because this bt_put()
+ * could destroy the stream, also destroying its
+ * packet pool, thus also destroying our packet object (this
+ * would result in an invalid write access).
+ *
+ * 3. Recycle the packet object.
+ *
+ * 4. Put our stream reference.
+ */
+ reset_packet(packet);
+ stream = packet->stream;
+ BT_ASSERT(stream);
+ packet->stream = NULL;
+ bt_object_pool_recycle_object(&stream->packet_pool, packet);
+ bt_object_put_no_null_check(&stream->base);
}
-static
-void bt_packet_destroy(struct bt_object *obj)
+BT_HIDDEN
+void bt_packet_destroy(struct bt_packet *packet)
{
- struct bt_packet *packet = (void *) obj;
+ BT_LIB_LOGD("Destroying packet: %!+a", packet);
+
+ if (packet->header_field) {
+ if (packet->stream) {
+ BT_LOGD_STR("Recycling packet's header field.");
+ recycle_header_field(packet->header_field,
+ bt_stream_class_borrow_trace_inline(
+ packet->stream->class));
+ } else {
+ bt_field_wrapper_destroy(packet->header_field);
+ }
+ }
+
+ if (packet->context_field) {
+ if (packet->stream) {
+ BT_LOGD_STR("Recycling packet's context field.");
+ recycle_context_field(packet->context_field,
+ packet->stream->class);
+ } else {
+ bt_field_wrapper_destroy(packet->context_field);
+ }
+ }
+
+ if (packet->default_beginning_cv) {
+ BT_LOGD_STR("Recycling beginning clock value.");
+ bt_clock_value_recycle(packet->default_beginning_cv);
+ }
+
+ if (packet->default_end_cv) {
+ BT_LOGD_STR("Recycling end clock value.");
+ bt_clock_value_recycle(packet->default_end_cv);
+ }
- BT_LOGD("Destroying packet: addr=%p", packet);
- BT_LOGD_STR("Putting packet's header field.");
- bt_put(packet->header);
- BT_LOGD_STR("Putting packet's context field.");
- bt_put(packet->context);
BT_LOGD_STR("Putting packet's stream.");
bt_put(packet->stream);
g_free(packet);
}
-struct bt_packet *bt_packet_create(
- struct bt_stream *stream)
+BT_HIDDEN
+struct bt_packet *bt_packet_new(struct bt_stream *stream)
{
struct bt_packet *packet = NULL;
- struct bt_stream_class *stream_class = NULL;
struct bt_trace *trace = NULL;
- BT_ASSERT_PRE_NON_NULL(stream, "Stream");
- BT_LOGD("Creating packet object: stream-addr=%p, "
- "stream-name=\"%s\", stream-class-addr=%p, "
- "stream-class-name=\"%s\", stream-class-id=%" PRId64,
- stream, bt_stream_get_name(stream),
- stream->common.stream_class,
- bt_stream_class_common_get_name(stream->common.stream_class),
- bt_stream_class_common_get_id(stream->common.stream_class));
- stream_class = bt_stream_borrow_class(stream);
- BT_ASSERT(stream_class);
- trace = bt_stream_class_borrow_trace(stream_class);
- BT_ASSERT(trace);
+ BT_ASSERT(stream);
+ BT_LIB_LOGD("Creating packet object: %![stream-]+s", stream);
packet = g_new0(struct bt_packet, 1);
if (!packet) {
BT_LOGE_STR("Failed to allocate one packet object.");
- goto end;
+ goto error;
}
- bt_object_init(packet, bt_packet_destroy);
+ bt_object_init_shared(&packet->base,
+ (bt_object_release_func) bt_packet_recycle);
packet->stream = bt_get(stream);
+ trace = bt_stream_class_borrow_trace_inline(stream->class);
+ BT_ASSERT(trace);
- if (trace->common.packet_header_field_type) {
- BT_LOGD("Creating initial packet header field: ft-addr=%p",
- trace->common.packet_header_field_type);
- packet->header = bt_field_create(
- BT_FROM_COMMON(trace->common.packet_header_field_type));
- if (!packet->header) {
- BT_LOGE_STR("Cannot create initial packet header field object.");
- BT_PUT(packet);
- goto end;
+ if (trace->packet_header_ft) {
+ BT_LOGD_STR("Creating initial packet header field.");
+ packet->header_field = bt_field_wrapper_create(
+ &trace->packet_header_field_pool,
+ trace->packet_header_ft);
+ if (!packet->header_field) {
+ BT_LOGE_STR("Cannot create packet header field wrapper.");
+ goto error;
}
}
- if (stream->common.stream_class->packet_context_field_type) {
- BT_LOGD("Creating initial packet context field: ft-addr=%p",
- stream->common.stream_class->packet_context_field_type);
- packet->context = bt_field_create(
- BT_FROM_COMMON(stream->common.stream_class->packet_context_field_type));
- if (!packet->context) {
- BT_LOGE_STR("Cannot create initial packet header field object.");
- BT_PUT(packet);
- goto end;
+ if (stream->class->packet_context_ft) {
+ BT_LOGD_STR("Creating initial packet context field.");
+ packet->context_field = bt_field_wrapper_create(
+ &stream->class->packet_context_field_pool,
+ stream->class->packet_context_ft);
+ if (!packet->context_field) {
+ BT_LOGE_STR("Cannot create packet context field wrapper.");
+ goto error;
}
}
- BT_LOGD("Created packet object: addr=%p", packet);
+ if (stream->class->default_clock_class) {
+ if (stream->class->packets_have_default_beginning_cv) {
+ packet->default_beginning_cv = bt_clock_value_create(
+ stream->class->default_clock_class);
+ if (!packet->default_beginning_cv) {
+ /* bt_clock_value_create() logs errors */
+ goto error;
+ }
+ }
+
+ if (stream->class->packets_have_default_end_cv) {
+ packet->default_end_cv = bt_clock_value_create(
+ stream->class->default_clock_class);
+ if (!packet->default_end_cv) {
+ /* bt_clock_value_create() logs errors */
+ goto error;
+ }
+ }
+ }
+
+ reset_counter_snapshots(packet);
+ BT_LIB_LOGD("Created packet object: %!+a", packet);
+ goto end;
+
+error:
+ BT_PUT(packet);
end:
return packet;
}
+
+struct bt_packet *bt_packet_create(struct bt_stream *stream)
+{
+ struct bt_packet *packet = NULL;
+
+ BT_ASSERT_PRE_NON_NULL(stream, "Stream");
+ packet = bt_object_pool_create_object(&stream->packet_pool);
+ if (unlikely(!packet)) {
+ BT_LIB_LOGE("Cannot allocate one packet from stream's packet pool: "
+ "%![stream-]+s", stream);
+ goto end;
+ }
+
+ if (likely(!packet->stream)) {
+ packet->stream = stream;
+ bt_object_get_no_null_check_no_parent_check(
+ &packet->stream->base);
+ }
+
+end:
+ return packet;
+}
+
+int bt_packet_move_header_field(struct bt_packet *packet,
+ struct bt_packet_header_field *header_field)
+{
+ struct bt_trace *trace;
+ struct bt_field_wrapper *field_wrapper = (void *) header_field;
+
+ BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
+ BT_ASSERT_PRE_PACKET_HOT(packet);
+ trace = bt_stream_class_borrow_trace_inline(packet->stream->class);
+ BT_ASSERT_PRE(trace->packet_header_ft,
+ "Trace has no packet header field type: %!+t",
+ trace);
+ BT_ASSERT_PRE(field_wrapper->field->type ==
+ trace->packet_header_ft,
+ "Unexpected packet header field's type: "
+ "%![ft-]+F, %![expected-ft-]+F", field_wrapper->field->type,
+ trace->packet_header_ft);
+
+ /* Recycle current header field: always exists */
+ BT_ASSERT(packet->header_field);
+ recycle_header_field(packet->header_field, trace);
+
+ /* Move new field */
+ packet->header_field = field_wrapper;
+ return 0;
+}
+
+int bt_packet_move_context_field(struct bt_packet *packet,
+ struct bt_packet_context_field *context_field)
+{
+ struct bt_stream_class *stream_class;
+ struct bt_field_wrapper *field_wrapper = (void *) context_field;
+
+ BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ BT_ASSERT_PRE_NON_NULL(field_wrapper, "Context field");
+ BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
+ stream_class = packet->stream->class;
+ BT_ASSERT_PRE(stream_class->packet_context_ft,
+ "Stream class has no packet context field type: %!+S",
+ stream_class);
+ BT_ASSERT_PRE(field_wrapper->field->type ==
+ stream_class->packet_context_ft,
+ "Unexpected packet header field's type: "
+ "%![ft-]+F, %![expected-ft-]+F", field_wrapper->field->type,
+ stream_class->packet_context_ft);
+
+ /* Recycle current context field: always exists */
+ BT_ASSERT(packet->context_field);
+ recycle_context_field(packet->context_field, stream_class);
+
+ /* Move new field */
+ packet->context_field = field_wrapper;
+ return 0;
+}
+
+int bt_packet_set_default_beginning_clock_value(struct bt_packet *packet,
+ uint64_t value_cycles)
+{
+ struct bt_stream_class *sc;
+
+ BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ BT_ASSERT_PRE_PACKET_HOT(packet);
+ sc = packet->stream->class;
+ BT_ASSERT(sc);
+ BT_ASSERT_PRE(sc->default_clock_class,
+ "Packet's stream class has no default clock class: "
+ "%![packet-]+a, %![sc-]+S", packet, sc);
+ BT_ASSERT_PRE(sc->packets_have_default_beginning_cv,
+ "Packet's stream class indicates that its packets have "
+ "no default beginning clock value: %![packet-]+a, %![sc-]+S",
+ packet, sc);
+ BT_ASSERT(packet->default_beginning_cv);
+ bt_clock_value_set_value_inline(packet->default_beginning_cv, value_cycles);
+ BT_LIB_LOGV("Set packet's default beginning clock value: "
+ "%![packet-]+a, value=%" PRIu64, value_cycles);
+ return 0;
+}
+
+enum bt_clock_value_status bt_packet_borrow_default_beginning_clock_value(
+ struct bt_packet *packet, struct bt_clock_value **clock_value)
+{
+ BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value (output)");
+ *clock_value = packet->default_beginning_cv;
+ return BT_CLOCK_VALUE_STATUS_KNOWN;
+}
+
+int bt_packet_set_default_end_clock_value(struct bt_packet *packet,
+ uint64_t value_cycles)
+{
+ struct bt_stream_class *sc;
+
+ BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ BT_ASSERT_PRE_PACKET_HOT(packet);
+ sc = packet->stream->class;
+ BT_ASSERT(sc);
+ BT_ASSERT_PRE(sc->default_clock_class,
+ "Packet's stream class has no default clock class: "
+ "%![packet-]+a, %![sc-]+S", packet, sc);
+ BT_ASSERT_PRE(sc->packets_have_default_end_cv,
+ "Packet's stream class indicates that its packets have "
+ "no default end clock value: %![packet-]+a, %![sc-]+S",
+ packet, sc);
+ BT_ASSERT(packet->default_end_cv);
+ bt_clock_value_set_value_inline(packet->default_end_cv, value_cycles);
+ BT_LIB_LOGV("Set packet's default end clock value: "
+ "%![packet-]+a, value=%" PRIu64, value_cycles);
+ return 0;
+}
+
+enum bt_clock_value_status bt_packet_borrow_default_end_clock_value(
+ struct bt_packet *packet, struct bt_clock_value **clock_value)
+{
+ BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value (output)");
+ *clock_value = packet->default_end_cv;
+ return BT_CLOCK_VALUE_STATUS_KNOWN;
+}
+
+enum bt_property_availability bt_packet_get_discarded_event_counter_snapshot(
+ struct bt_packet *packet, uint64_t *value)
+{
+ BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ BT_ASSERT_PRE_NON_NULL(value, "Value (output)");
+ *value = packet->discarded_event_counter_snapshot.value;
+ return packet->discarded_event_counter_snapshot.base.avail;
+}
+
+int bt_packet_set_discarded_event_counter_snapshot(struct bt_packet *packet,
+ uint64_t value)
+{
+ BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ BT_ASSERT_PRE_PACKET_HOT(packet);
+ BT_ASSERT_PRE(packet->stream->class->packets_have_discarded_event_counter_snapshot,
+ "Packet's stream's discarded event counter is not enabled: "
+ "%![packet-]+a", packet);
+ bt_property_uint_set(&packet->discarded_event_counter_snapshot, value);
+ return 0;
+}
+
+enum bt_property_availability bt_packet_get_packet_counter_snapshot(
+ struct bt_packet *packet, uint64_t *value)
+{
+ BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ BT_ASSERT_PRE_NON_NULL(value, "Value (output)");
+ *value = packet->packet_counter_snapshot.value;
+ return packet->packet_counter_snapshot.base.avail;
+}
+
+int bt_packet_set_packet_counter_snapshot(struct bt_packet *packet,
+ uint64_t value)
+{
+ BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ BT_ASSERT_PRE_PACKET_HOT(packet);
+ BT_ASSERT_PRE(packet->stream->class->packets_have_packet_counter_snapshot,
+ "Packet's stream's packet counter is not enabled: "
+ "%![packet-]+a", packet);
+ bt_property_uint_set(&packet->packet_counter_snapshot, value);
+ return 0;
+}
projects / babeltrace.git / blobdiff