/*
- * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
+ * SPDX-License-Identifier: MIT
*
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
*/
-#define BT_LOG_TAG "PACKET"
-#include "lib/lib-logging.h"
+#define BT_LOG_TAG "LIB/PACKET"
+#include "lib/logging.h"
-#include "lib/assert-pre.h"
-#include <babeltrace2/trace-ir/packet-const.h>
+#include "lib/assert-cond.h"
#include <babeltrace2/trace-ir/packet.h>
#include <babeltrace2/trace-ir/trace.h>
#include <babeltrace2/trace-ir/stream-class.h>
#include "lib/object.h"
#include "common/assert.h"
#include <inttypes.h>
+#include <stdbool.h>
#include "field.h"
#include "field-wrapper.h"
#include "stream-class.h"
#include "stream.h"
#include "trace.h"
+#include "lib/func-status.h"
-#define BT_ASSERT_PRE_PACKET_HOT(_packet) \
- BT_ASSERT_PRE_HOT((_packet), "Packet", ": %!+a", (_packet))
-
+BT_EXPORT
struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet)
{
- BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ BT_ASSERT_PRE_DEV_PACKET_NON_NULL(packet);
return packet->stream;
}
+BT_EXPORT
const struct bt_stream *bt_packet_borrow_stream_const(
const struct bt_packet *packet)
{
return bt_packet_borrow_stream((void *) packet);
}
+BT_EXPORT
struct bt_field *bt_packet_borrow_context_field(struct bt_packet *packet)
{
- BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+ BT_ASSERT_PRE_DEV_PACKET_NON_NULL(packet);
return packet->context_field ? packet->context_field->field : NULL;
}
+BT_EXPORT
const struct bt_field *bt_packet_borrow_context_field_const(
const struct bt_packet *packet)
{
return bt_packet_borrow_context_field((void *) packet);
}
-BT_HIDDEN
void _bt_packet_set_is_frozen(const struct bt_packet *packet, bool is_frozen)
{
if (!packet) {
context_field);
}
-BT_HIDDEN
void bt_packet_recycle(struct bt_packet *packet)
{
struct bt_stream *stream;
BT_ASSERT(stream);
packet->stream = NULL;
bt_object_pool_recycle_object(&stream->packet_pool, packet);
- bt_object_put_no_null_check(&stream->base);
+ bt_object_put_ref_no_null_check(&stream->base);
}
-BT_HIDDEN
void bt_packet_destroy(struct bt_packet *packet)
{
BT_LIB_LOGD("Destroying packet: %!+a", packet);
g_free(packet);
}
-BT_HIDDEN
struct bt_packet *bt_packet_new(struct bt_stream *stream)
{
struct bt_packet *packet = NULL;
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.");
+ BT_LIB_LOGE_APPEND_CAUSE(
+ "Failed to allocate one packet object.");
goto error;
}
bt_object_init_shared(&packet->base,
(bt_object_release_func) bt_packet_recycle);
packet->stream = stream;
- bt_object_get_no_null_check(stream);
+ bt_object_get_ref_no_null_check(stream);
trace_class = bt_stream_class_borrow_trace_class_inline(stream->class);
BT_ASSERT(trace_class);
&stream->class->packet_context_field_pool,
stream->class->packet_context_fc);
if (!packet->context_field) {
- BT_LOGE_STR("Cannot create packet context field wrapper.");
+ BT_LIB_LOGE_APPEND_CAUSE(
+ "Cannot create packet context field wrapper.");
goto error;
}
}
return packet;
}
+BT_EXPORT
struct bt_packet *bt_packet_create(const struct bt_stream *c_stream)
{
struct bt_packet *packet = NULL;
struct bt_stream *stream = (void *) c_stream;
- BT_ASSERT_PRE_NON_NULL(stream, "Stream");
+ BT_ASSERT_PRE_NO_ERROR();
+ BT_ASSERT_PRE_STREAM_NON_NULL(stream);
+ BT_ASSERT_PRE("stream-class-supports-packets",
+ stream->class->supports_packets,
+ "Stream class does not support packets: %![sc-]+S",
+ stream->class);
packet = bt_object_pool_create_object(&stream->packet_pool);
if (G_UNLIKELY(!packet)) {
- BT_LIB_LOGE("Cannot allocate one packet from stream's packet pool: "
+ BT_LIB_LOGE_APPEND_CAUSE(
+ "Cannot allocate one packet from stream's packet pool: "
"%![stream-]+s", stream);
goto end;
}
if (G_LIKELY(!packet->stream)) {
packet->stream = stream;
- bt_object_get_no_null_check_no_parent_check(
+ bt_object_get_ref_no_null_check_no_parent_check(
&packet->stream->base);
}
return (void *) packet;
}
-enum bt_packet_status 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_fc,
- "Stream class has no packet context field class: %!+S",
- stream_class);
- BT_ASSERT_PRE(field_wrapper->field->class ==
- stream_class->packet_context_fc,
- "Unexpected packet context field's class: "
- "%![fc-]+F, %![expected-fc-]+F", field_wrapper->field->class,
- stream_class->packet_context_fc);
-
- /* 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 BT_PACKET_STATUS_OK;
-}
-
+BT_EXPORT
void bt_packet_get_ref(const struct bt_packet *packet)
{
bt_object_get_ref(packet);
}
+BT_EXPORT
void bt_packet_put_ref(const struct bt_packet *packet)
{
bt_object_put_ref(packet);