+++ /dev/null
-/*
- * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
- * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@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:
- *
- * 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.
- */
-
-#define BT_LOG_TAG "STREAM-CLASS"
-#include <babeltrace2/lib-logging-internal.h>
-
-#include <babeltrace2/assert-pre-internal.h>
-#include <babeltrace2/trace-ir/clock-class-internal.h>
-#include <babeltrace2/trace-ir/event-class-internal.h>
-#include <babeltrace2/trace-ir/field-class-internal.h>
-#include <babeltrace2/trace-ir/field-internal.h>
-#include <babeltrace2/trace-ir/stream-class-internal.h>
-#include <babeltrace2/trace-ir/trace-const.h>
-#include <babeltrace2/trace-ir/trace-internal.h>
-#include <babeltrace2/trace-ir/utils-internal.h>
-#include <babeltrace2/trace-ir/field-wrapper-internal.h>
-#include <babeltrace2/trace-ir/resolve-field-path-internal.h>
-#include <babeltrace2/compiler-internal.h>
-#include <babeltrace2/align-internal.h>
-#include <babeltrace2/endian-internal.h>
-#include <babeltrace2/assert-internal.h>
-#include <babeltrace2/property-internal.h>
-#include <inttypes.h>
-#include <stdint.h>
-#include <stdbool.h>
-
-#define BT_ASSERT_PRE_STREAM_CLASS_HOT(_sc) \
- BT_ASSERT_PRE_HOT((_sc), "Stream class", ": %!+S", (_sc))
-
-static
-void destroy_stream_class(struct bt_object *obj)
-{
- struct bt_stream_class *stream_class = (void *) obj;
-
- BT_LIB_LOGD("Destroying stream class: %!+S", stream_class);
- BT_LOGD_STR("Putting default clock class.");
- BT_OBJECT_PUT_REF_AND_RESET(stream_class->default_clock_class);
-
- if (stream_class->event_classes) {
- BT_LOGD_STR("Destroying event classes.");
- g_ptr_array_free(stream_class->event_classes, TRUE);
- stream_class->event_classes = NULL;
- }
-
- if (stream_class->name.str) {
- g_string_free(stream_class->name.str, TRUE);
- stream_class->name.str = NULL;
- stream_class->name.value = NULL;
- }
-
- BT_LOGD_STR("Putting packet context field class.");
- BT_OBJECT_PUT_REF_AND_RESET(stream_class->packet_context_fc);
- BT_LOGD_STR("Putting event common context field class.");
- BT_OBJECT_PUT_REF_AND_RESET(stream_class->event_common_context_fc);
- bt_object_pool_finalize(&stream_class->packet_context_field_pool);
- g_free(stream_class);
-}
-
-static
-void free_field_wrapper(struct bt_field_wrapper *field_wrapper,
- struct bt_stream_class *stream_class)
-{
- bt_field_wrapper_destroy((void *) field_wrapper);
-}
-
-BT_ASSERT_PRE_FUNC
-static
-bool stream_class_id_is_unique(const struct bt_trace_class *tc, uint64_t id)
-{
- uint64_t i;
- bool is_unique = true;
-
- for (i = 0; i < tc->stream_classes->len; i++) {
- const struct bt_stream_class *sc =
- tc->stream_classes->pdata[i];
-
- if (sc->id == id) {
- is_unique = false;
- goto end;
- }
- }
-
-end:
- return is_unique;
-}
-
-static
-struct bt_stream_class *create_stream_class_with_id(
- struct bt_trace_class *tc, uint64_t id)
-{
- struct bt_stream_class *stream_class = NULL;
- int ret;
-
- BT_ASSERT(tc);
- BT_ASSERT_PRE(stream_class_id_is_unique(tc, id),
- "Duplicate stream class ID: %![tc-]+T, id=%" PRIu64, tc, id);
- BT_LIB_LOGD("Creating stream class object: %![tc-]+T, id=%" PRIu64,
- tc, id);
- stream_class = g_new0(struct bt_stream_class, 1);
- if (!stream_class) {
- BT_LOGE_STR("Failed to allocate one stream class.");
- goto error;
- }
-
- bt_object_init_shared_with_parent(&stream_class->base,
- destroy_stream_class);
-
- stream_class->name.str = g_string_new(NULL);
- if (!stream_class->name.str) {
- BT_LOGE_STR("Failed to allocate a GString.");
- ret = -1;
- goto end;
- }
-
- stream_class->id = id;
- stream_class->assigns_automatic_event_class_id = true;
- stream_class->assigns_automatic_stream_id = true;
- stream_class->event_classes = g_ptr_array_new_with_free_func(
- (GDestroyNotify) bt_object_try_spec_release);
- if (!stream_class->event_classes) {
- BT_LOGE_STR("Failed to allocate a GPtrArray.");
- goto error;
- }
-
- ret = bt_object_pool_initialize(&stream_class->packet_context_field_pool,
- (bt_object_pool_new_object_func) bt_field_wrapper_new,
- (bt_object_pool_destroy_object_func) free_field_wrapper,
- stream_class);
- if (ret) {
- BT_LOGE("Failed to initialize packet context field pool: ret=%d",
- ret);
- goto error;
- }
-
- bt_object_set_parent(&stream_class->base, &tc->base);
- g_ptr_array_add(tc->stream_classes, stream_class);
- bt_trace_class_freeze(tc);
- BT_LIB_LOGD("Created stream class object: %!+S", stream_class);
- goto end;
-
-error:
- BT_OBJECT_PUT_REF_AND_RESET(stream_class);
-
-end:
- return stream_class;
-}
-
-struct bt_stream_class *bt_stream_class_create(struct bt_trace_class *tc)
-{
- BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
- BT_ASSERT_PRE(tc->assigns_automatic_stream_class_id,
- "Trace class does not automatically assigns stream class IDs: "
- "%![sc-]+T", tc);
- return create_stream_class_with_id(tc,
- (uint64_t) tc->stream_classes->len);
-}
-
-struct bt_stream_class *bt_stream_class_create_with_id(
- struct bt_trace_class *tc, uint64_t id)
-{
- BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
- BT_ASSERT_PRE(!tc->assigns_automatic_stream_class_id,
- "Trace class automatically assigns stream class IDs: "
- "%![sc-]+T", tc);
- return create_stream_class_with_id(tc, id);
-}
-
-struct bt_trace_class *bt_stream_class_borrow_trace_class(
- struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return bt_stream_class_borrow_trace_class_inline(stream_class);
-}
-
-const struct bt_trace_class *bt_stream_class_borrow_trace_class_const(
- const struct bt_stream_class *stream_class)
-{
- return bt_stream_class_borrow_trace_class((void *) stream_class);
-}
-
-const char *bt_stream_class_get_name(const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return stream_class->name.value;
-}
-
-enum bt_stream_class_status bt_stream_class_set_name(
- struct bt_stream_class *stream_class,
- const char *name)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- BT_ASSERT_PRE_NON_NULL(name, "Name");
- BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
- g_string_assign(stream_class->name.str, name);
- stream_class->name.value = stream_class->name.str->str;
- BT_LIB_LOGV("Set stream class's name: %!+S", stream_class);
- return BT_STREAM_CLASS_STATUS_OK;
-}
-
-uint64_t bt_stream_class_get_id(const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return stream_class->id;
-}
-
-uint64_t bt_stream_class_get_event_class_count(
- const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return (uint64_t) stream_class->event_classes->len;
-}
-
-struct bt_event_class *bt_stream_class_borrow_event_class_by_index(
- struct bt_stream_class *stream_class, uint64_t index)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- BT_ASSERT_PRE_VALID_INDEX(index, stream_class->event_classes->len);
- return g_ptr_array_index(stream_class->event_classes, index);
-}
-
-const struct bt_event_class *
-bt_stream_class_borrow_event_class_by_index_const(
- const struct bt_stream_class *stream_class, uint64_t index)
-{
- return bt_stream_class_borrow_event_class_by_index(
- (void *) stream_class, index);
-}
-
-struct bt_event_class *bt_stream_class_borrow_event_class_by_id(
- struct bt_stream_class *stream_class, uint64_t id)
-{
- struct bt_event_class *event_class = NULL;
- uint64_t i;
-
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
-
- for (i = 0; i < stream_class->event_classes->len; i++) {
- struct bt_event_class *event_class_candidate =
- g_ptr_array_index(stream_class->event_classes, i);
-
- if (event_class_candidate->id == id) {
- event_class = event_class_candidate;
- goto end;
- }
- }
-
-end:
- return event_class;
-}
-
-const struct bt_event_class *
-bt_stream_class_borrow_event_class_by_id_const(
- const struct bt_stream_class *stream_class, uint64_t id)
-{
- return bt_stream_class_borrow_event_class_by_id(
- (void *) stream_class, id);
-}
-
-const struct bt_field_class *
-bt_stream_class_borrow_packet_context_field_class_const(
- const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return stream_class->packet_context_fc;
-}
-
-struct bt_field_class *
-bt_stream_class_borrow_packet_context_field_class(
- struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return stream_class->packet_context_fc;
-}
-
-enum bt_stream_class_status bt_stream_class_set_packet_context_field_class(
- struct bt_stream_class *stream_class,
- struct bt_field_class *field_class)
-{
- int ret;
- struct bt_resolve_field_path_context resolve_ctx = {
- .packet_context = field_class,
- .event_common_context = NULL,
- .event_specific_context = NULL,
- .event_payload = NULL,
- };
-
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
- BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
- BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
- BT_FIELD_CLASS_TYPE_STRUCTURE,
- "Packet context field class is not a structure field class: %!+F",
- field_class);
- ret = bt_resolve_field_paths(field_class, &resolve_ctx);
- if (ret) {
- /*
- * This is the only reason for which
- * bt_resolve_field_paths() can fail: anything else
- * would be because a precondition is not satisfied.
- */
- ret = BT_STREAM_CLASS_STATUS_NOMEM;
- goto end;
- }
-
- bt_field_class_make_part_of_trace_class(field_class);
- bt_object_put_ref(stream_class->packet_context_fc);
- stream_class->packet_context_fc = field_class;
- bt_object_get_no_null_check(stream_class->packet_context_fc);
- bt_field_class_freeze(field_class);
- BT_LIB_LOGV("Set stream class's packet context field class: %!+S",
- stream_class);
-
-end:
- return ret;
-}
-
-const struct bt_field_class *
-bt_stream_class_borrow_event_common_context_field_class_const(
- const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return stream_class->event_common_context_fc;
-}
-
-struct bt_field_class *
-bt_stream_class_borrow_event_common_context_field_class(
- struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return stream_class->event_common_context_fc;
-}
-
-enum bt_stream_class_status
-bt_stream_class_set_event_common_context_field_class(
- struct bt_stream_class *stream_class,
- struct bt_field_class *field_class)
-{
- int ret;
- struct bt_resolve_field_path_context resolve_ctx = {
- .packet_context = NULL,
- .event_common_context = field_class,
- .event_specific_context = NULL,
- .event_payload = NULL,
- };
-
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
- BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
- BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
- BT_FIELD_CLASS_TYPE_STRUCTURE,
- "Event common context field class is not a structure field class: %!+F",
- field_class);
- resolve_ctx.packet_context = stream_class->packet_context_fc;
- ret = bt_resolve_field_paths(field_class, &resolve_ctx);
- if (ret) {
- /*
- * This is the only reason for which
- * bt_resolve_field_paths() can fail: anything else
- * would be because a precondition is not satisfied.
- */
- ret = BT_STREAM_CLASS_STATUS_NOMEM;
- goto end;
- }
-
- bt_field_class_make_part_of_trace_class(field_class);
- bt_object_put_ref(stream_class->event_common_context_fc);
- stream_class->event_common_context_fc = field_class;
- bt_object_get_no_null_check(stream_class->event_common_context_fc);
- bt_field_class_freeze(field_class);
- BT_LIB_LOGV("Set stream class's event common context field class: %!+S",
- stream_class);
-
-end:
- return ret;
-}
-
-BT_HIDDEN
-void _bt_stream_class_freeze(const struct bt_stream_class *stream_class)
-{
- /* The field classes and default clock class are already frozen */
- BT_ASSERT(stream_class);
- BT_LIB_LOGD("Freezing stream class: %!+S", stream_class);
- ((struct bt_stream_class *) stream_class)->frozen = true;
-}
-
-enum bt_stream_class_status bt_stream_class_set_default_clock_class(
- struct bt_stream_class *stream_class,
- struct bt_clock_class *clock_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class");
- BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
- bt_object_put_ref(stream_class->default_clock_class);
- stream_class->default_clock_class = clock_class;
- bt_object_get_no_null_check(stream_class->default_clock_class);
- bt_clock_class_freeze(clock_class);
- BT_LIB_LOGV("Set stream class's default clock class: %!+S",
- stream_class);
- return BT_STREAM_CLASS_STATUS_OK;
-}
-
-struct bt_clock_class *bt_stream_class_borrow_default_clock_class(
- struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return stream_class->default_clock_class;
-}
-
-const struct bt_clock_class *bt_stream_class_borrow_default_clock_class_const(
- const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return stream_class->default_clock_class;
-}
-
-bt_bool bt_stream_class_assigns_automatic_event_class_id(
- const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return (bt_bool) stream_class->assigns_automatic_event_class_id;
-}
-
-void bt_stream_class_set_assigns_automatic_event_class_id(
- struct bt_stream_class *stream_class,
- bt_bool value)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
- stream_class->assigns_automatic_event_class_id = (bool) value;
- BT_LIB_LOGV("Set stream class's automatic event class ID "
- "assignment property: %!+S", stream_class);
-}
-
-bt_bool bt_stream_class_packets_have_beginning_default_clock_snapshot(
- const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return (bt_bool) stream_class->packets_have_beginning_default_clock_snapshot;
-}
-
-void bt_stream_class_set_packets_have_beginning_default_clock_snapshot(
- struct bt_stream_class *stream_class, bt_bool value)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
- BT_ASSERT_PRE(!value || stream_class->default_clock_class,
- "Stream class has no default clock class: %!+S", stream_class);
- stream_class->packets_have_beginning_default_clock_snapshot =
- (bool) value;
- BT_LIB_LOGV("Set stream class's \"packets have default beginning "
- "clock snapshot\" property: %!+S", stream_class);
-}
-
-bt_bool bt_stream_class_packets_have_end_default_clock_snapshot(
- const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return (bt_bool) stream_class->packets_have_end_default_clock_snapshot;
-}
-
-void bt_stream_class_set_packets_have_end_default_clock_snapshot(
- struct bt_stream_class *stream_class, bt_bool value)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
- BT_ASSERT_PRE(!value || stream_class->default_clock_class,
- "Stream class has no default clock class: %!+S", stream_class);
- stream_class->packets_have_end_default_clock_snapshot =
- (bool) value;
- BT_LIB_LOGV("Set stream class's \"packets have default end "
- "clock snapshot\" property: %!+S", stream_class);
-}
-
-bt_bool bt_stream_class_assigns_automatic_stream_id(
- const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return (bt_bool) stream_class->assigns_automatic_stream_id;
-}
-
-void bt_stream_class_set_supports_discarded_events(
- struct bt_stream_class *stream_class,
- bt_bool supports_discarded_events,
- bt_bool with_default_clock_snapshots)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
- BT_ASSERT_PRE(supports_discarded_events ||
- !with_default_clock_snapshots,
- "Discarded events cannot have default clock snapshots when "
- "not supported: %!+S", stream_class);
- BT_ASSERT_PRE(!with_default_clock_snapshots ||
- stream_class->default_clock_class,
- "Stream class has no default clock class: %!+S", stream_class);
- stream_class->supports_discarded_events =
- (bool) supports_discarded_events;
- stream_class->discarded_events_have_default_clock_snapshots =
- (bool) with_default_clock_snapshots;
- BT_LIB_LOGV("Set stream class's discarded events support property: "
- "%!+S", stream_class);
-}
-
-bt_bool bt_stream_class_supports_discarded_events(
- const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return (bt_bool) stream_class->supports_discarded_events;
-}
-
-bt_bool bt_stream_class_discarded_events_have_default_clock_snapshots(
- const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return (bt_bool) stream_class->discarded_events_have_default_clock_snapshots;
-}
-
-void bt_stream_class_set_supports_discarded_packets(
- struct bt_stream_class *stream_class,
- bt_bool supports_discarded_packets,
- bt_bool with_default_clock_snapshots)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
- BT_ASSERT_PRE(supports_discarded_packets ||
- !with_default_clock_snapshots,
- "Discarded packets cannot have default clock snapshots when "
- "not supported: %!+S", stream_class);
- BT_ASSERT_PRE(!with_default_clock_snapshots ||
- stream_class->default_clock_class,
- "Stream class has no default clock class: %!+S", stream_class);
- stream_class->supports_discarded_packets =
- (bool) supports_discarded_packets;
- stream_class->discarded_packets_have_default_clock_snapshots =
- (bool) with_default_clock_snapshots;
- BT_LIB_LOGV("Set stream class's discarded packets support property: "
- "%!+S", stream_class);
-}
-
-bt_bool bt_stream_class_supports_discarded_packets(
- const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return (bt_bool) stream_class->supports_discarded_packets;
-}
-
-bt_bool bt_stream_class_discarded_packets_have_default_clock_snapshots(
- const struct bt_stream_class *stream_class)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- return (bt_bool) stream_class->discarded_packets_have_default_clock_snapshots;
-}
-
-void bt_stream_class_set_assigns_automatic_stream_id(
- struct bt_stream_class *stream_class,
- bt_bool value)
-{
- BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
- BT_ASSERT_PRE_STREAM_CLASS_HOT(stream_class);
- stream_class->assigns_automatic_stream_id = (bool) value;
- BT_LIB_LOGV("Set stream class's automatic stream ID "
- "assignment property: %!+S", stream_class);
-}
-
-void bt_stream_class_get_ref(const struct bt_stream_class *stream_class)
-{
- bt_object_get_ref(stream_class);
-}
-
-void bt_stream_class_put_ref(const struct bt_stream_class *stream_class)
-{
- bt_object_put_ref(stream_class);
-}
projects / babeltrace.git / blobdiff