--- /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 "EVENT-CLASS"
+#include "lib/lib-logging.h"
+
+#include "lib/assert-pre.h"
+#include <babeltrace2/trace-ir/field-class.h>
+#include <babeltrace2/trace-ir/event-class.h>
+#include <babeltrace2/trace-ir/event-class-const.h>
+#include <babeltrace2/trace-ir/stream-class.h>
+#include "compat/compiler.h"
+#include "compat/endian.h"
+#include <babeltrace2/types.h>
+#include "lib/value.h"
+#include "common/assert.h"
+#include <inttypes.h>
+#include <stdlib.h>
+
+#include "attributes.h"
+#include "clock-snapshot.h"
+#include "event-class.h"
+#include "event.h"
+#include "field-class.h"
+#include "field.h"
+#include "resolve-field-path.h"
+#include "stream-class.h"
+#include "trace.h"
+#include "utils.h"
+
+#define BT_ASSERT_PRE_EVENT_CLASS_HOT(_ec) \
+ BT_ASSERT_PRE_HOT(((const struct bt_event_class *) (_ec)), \
+ "Event class", ": %!+E", (_ec))
+
+static
+void destroy_event_class(struct bt_object *obj)
+{
+ struct bt_event_class *event_class = (void *) obj;
+
+ BT_LIB_LOGD("Destroying event class: %!+E", event_class);
+
+ if (event_class->name.str) {
+ g_string_free(event_class->name.str, TRUE);
+ event_class->name.str = NULL;
+ }
+
+ if (event_class->emf_uri.str) {
+ g_string_free(event_class->emf_uri.str, TRUE);
+ event_class->emf_uri.str = NULL;
+ }
+
+ BT_LOGD_STR("Putting context field class.");
+ BT_OBJECT_PUT_REF_AND_RESET(event_class->specific_context_fc);
+ BT_LOGD_STR("Putting payload field class.");
+ BT_OBJECT_PUT_REF_AND_RESET(event_class->payload_fc);
+ bt_object_pool_finalize(&event_class->event_pool);
+ g_free(obj);
+}
+
+static
+void free_event(struct bt_event *event,
+ struct bt_event_class *event_class)
+{
+ bt_event_destroy(event);
+}
+
+BT_ASSERT_PRE_FUNC
+static
+bool event_class_id_is_unique(const struct bt_stream_class *stream_class,
+ uint64_t id)
+{
+ uint64_t i;
+ bool is_unique = true;
+
+ for (i = 0; i < stream_class->event_classes->len; i++) {
+ const struct bt_event_class *ec =
+ stream_class->event_classes->pdata[i];
+
+ if (ec->id == id) {
+ is_unique = false;
+ goto end;
+ }
+ }
+
+end:
+ return is_unique;
+}
+
+static
+struct bt_event_class *create_event_class_with_id(
+ struct bt_stream_class *stream_class, uint64_t id)
+{
+ int ret;
+ struct bt_event_class *event_class;
+
+ BT_ASSERT(stream_class);
+ BT_ASSERT_PRE(event_class_id_is_unique(stream_class, id),
+ "Duplicate event class ID: %![sc-]+S, id=%" PRIu64,
+ stream_class, id);
+ BT_LIB_LOGD("Creating event class object: %![sc-]+S, id=%" PRIu64,
+ stream_class, id);
+ event_class = g_new0(struct bt_event_class, 1);
+ if (!event_class) {
+ BT_LOGE_STR("Failed to allocate one event class.");
+ goto error;
+ }
+
+ bt_object_init_shared_with_parent(&event_class->base,
+ destroy_event_class);
+ event_class->id = id;
+ bt_property_uint_init(&event_class->log_level,
+ BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE, 0);
+ event_class->name.str = g_string_new(NULL);
+ if (!event_class->name.str) {
+ BT_LOGE_STR("Failed to allocate a GString.");
+ ret = -1;
+ goto end;
+ }
+
+ event_class->emf_uri.str = g_string_new(NULL);
+ if (!event_class->emf_uri.str) {
+ BT_LOGE_STR("Failed to allocate a GString.");
+ ret = -1;
+ goto end;
+ }
+
+ ret = bt_object_pool_initialize(&event_class->event_pool,
+ (bt_object_pool_new_object_func) bt_event_new,
+ (bt_object_pool_destroy_object_func) free_event,
+ event_class);
+ if (ret) {
+ BT_LOGE("Failed to initialize event pool: ret=%d",
+ ret);
+ goto error;
+ }
+
+ bt_object_set_parent(&event_class->base, &stream_class->base);
+ g_ptr_array_add(stream_class->event_classes, event_class);
+ bt_stream_class_freeze(stream_class);
+ BT_LIB_LOGD("Created event class object: %!+E", event_class);
+ goto end;
+
+error:
+ BT_OBJECT_PUT_REF_AND_RESET(event_class);
+
+end:
+ return event_class;
+}
+
+struct bt_event_class *bt_event_class_create(
+ struct bt_stream_class *stream_class)
+{
+ BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
+ BT_ASSERT_PRE(stream_class->assigns_automatic_event_class_id,
+ "Stream class does not automatically assigns event class IDs: "
+ "%![sc-]+S", stream_class);
+ return create_event_class_with_id(stream_class,
+ (uint64_t) stream_class->event_classes->len);
+}
+
+struct bt_event_class *bt_event_class_create_with_id(
+ struct bt_stream_class *stream_class, uint64_t id)
+{
+ BT_ASSERT_PRE(!stream_class->assigns_automatic_event_class_id,
+ "Stream class automatically assigns event class IDs: "
+ "%![sc-]+S", stream_class);
+ return create_event_class_with_id(stream_class, id);
+}
+
+const char *bt_event_class_get_name(const struct bt_event_class *event_class)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ return event_class->name.value;
+}
+
+enum bt_event_class_status bt_event_class_set_name(
+ struct bt_event_class *event_class, const char *name)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ BT_ASSERT_PRE_NON_NULL(name, "Name");
+ BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
+ g_string_assign(event_class->name.str, name);
+ event_class->name.value = event_class->name.str->str;
+ BT_LIB_LOGV("Set event class's name: %!+E", event_class);
+ return BT_EVENT_CLASS_STATUS_OK;
+}
+
+uint64_t bt_event_class_get_id(const struct bt_event_class *event_class)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ return event_class->id;
+}
+
+enum bt_property_availability bt_event_class_get_log_level(
+ const struct bt_event_class *event_class,
+ enum bt_event_class_log_level *log_level)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ BT_ASSERT_PRE_NON_NULL(log_level, "Log level (output)");
+ *log_level = (enum bt_event_class_log_level)
+ event_class->log_level.value;
+ return event_class->log_level.base.avail;
+}
+
+void bt_event_class_set_log_level(
+ struct bt_event_class *event_class,
+ enum bt_event_class_log_level log_level)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
+ bt_property_uint_set(&event_class->log_level,
+ (uint64_t) log_level);
+ BT_LIB_LOGV("Set event class's log level: %!+E", event_class);
+}
+
+const char *bt_event_class_get_emf_uri(const struct bt_event_class *event_class)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ return event_class->emf_uri.value;
+}
+
+enum bt_event_class_status bt_event_class_set_emf_uri(
+ struct bt_event_class *event_class,
+ const char *emf_uri)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ BT_ASSERT_PRE_NON_NULL(emf_uri, "EMF URI");
+ BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
+ g_string_assign(event_class->emf_uri.str, emf_uri);
+ event_class->emf_uri.value = event_class->emf_uri.str->str;
+ BT_LIB_LOGV("Set event class's EMF URI: %!+E", event_class);
+ return BT_EVENT_CLASS_STATUS_OK;
+}
+
+struct bt_stream_class *bt_event_class_borrow_stream_class(
+ struct bt_event_class *event_class)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ return bt_event_class_borrow_stream_class_inline(event_class);
+}
+
+const struct bt_stream_class *
+bt_event_class_borrow_stream_class_const(
+ const struct bt_event_class *event_class)
+{
+ return bt_event_class_borrow_stream_class((void *) event_class);
+}
+
+const struct bt_field_class *
+bt_event_class_borrow_specific_context_field_class_const(
+ const struct bt_event_class *event_class)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ return event_class->specific_context_fc;
+}
+
+struct bt_field_class *
+bt_event_class_borrow_specific_context_field_class(
+ struct bt_event_class *event_class)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ return event_class->specific_context_fc;
+}
+
+enum bt_event_class_status bt_event_class_set_specific_context_field_class(
+ struct bt_event_class *event_class,
+ struct bt_field_class *field_class)
+{
+ int ret;
+ struct bt_stream_class *stream_class;
+ struct bt_resolve_field_path_context resolve_ctx = {
+ .packet_context = NULL,
+ .event_common_context = NULL,
+ .event_specific_context = field_class,
+ .event_payload = NULL,
+ };
+
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
+ BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
+ BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
+ BT_FIELD_CLASS_TYPE_STRUCTURE,
+ "Specific context field class is not a structure field class: "
+ "%!+F", field_class);
+ stream_class = bt_event_class_borrow_stream_class_inline(
+ event_class);
+ resolve_ctx.packet_context = stream_class->packet_context_fc;
+ resolve_ctx.event_common_context =
+ stream_class->event_common_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_EVENT_CLASS_STATUS_NOMEM;
+ goto end;
+ }
+
+ bt_field_class_make_part_of_trace_class(field_class);
+ bt_object_put_ref(event_class->specific_context_fc);
+ event_class->specific_context_fc = field_class;
+ bt_object_get_no_null_check(event_class->specific_context_fc);
+ bt_field_class_freeze(field_class);
+ BT_LIB_LOGV("Set event class's specific context field class: %!+E",
+ event_class);
+
+end:
+ return ret;
+}
+
+const struct bt_field_class *bt_event_class_borrow_payload_field_class_const(
+ const struct bt_event_class *event_class)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ return event_class->payload_fc;
+}
+
+struct bt_field_class *bt_event_class_borrow_payload_field_class(
+ struct bt_event_class *event_class)
+{
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ return event_class->payload_fc;
+}
+
+enum bt_event_class_status bt_event_class_set_payload_field_class(
+ struct bt_event_class *event_class,
+ struct bt_field_class *field_class)
+{
+ int ret;
+ struct bt_stream_class *stream_class;
+ struct bt_resolve_field_path_context resolve_ctx = {
+ .packet_context = NULL,
+ .event_common_context = NULL,
+ .event_specific_context = NULL,
+ .event_payload = field_class,
+ };
+
+ BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+ BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
+ BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
+ BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
+ BT_FIELD_CLASS_TYPE_STRUCTURE,
+ "Payload field class is not a structure field class: %!+F",
+ field_class);
+ stream_class = bt_event_class_borrow_stream_class_inline(
+ event_class);
+ resolve_ctx.packet_context = stream_class->packet_context_fc;
+ resolve_ctx.event_common_context =
+ stream_class->event_common_context_fc;
+ resolve_ctx.event_specific_context = event_class->specific_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_EVENT_CLASS_STATUS_NOMEM;
+ goto end;
+ }
+
+ bt_field_class_make_part_of_trace_class(field_class);
+ bt_object_put_ref(event_class->payload_fc);
+ event_class->payload_fc = field_class;
+ bt_object_get_no_null_check(event_class->payload_fc);
+ bt_field_class_freeze(field_class);
+ BT_LIB_LOGV("Set event class's payload field class: %!+E", event_class);
+
+end:
+ return ret;
+}
+
+BT_HIDDEN
+void _bt_event_class_freeze(const struct bt_event_class *event_class)
+{
+ /* The field classes are already frozen */
+ BT_ASSERT(event_class);
+ BT_LIB_LOGD("Freezing event class: %!+E", event_class);
+ ((struct bt_event_class *) event_class)->frozen = true;
+}
+
+void bt_event_class_get_ref(const struct bt_event_class *event_class)
+{
+ bt_object_get_ref(event_class);
+}
+
+void bt_event_class_put_ref(const struct bt_event_class *event_class)
+{
+ bt_object_put_ref(event_class);
+}
projects / babeltrace.git / blobdiff