Document libbabeltrace2's C API
[babeltrace.git] / src / lib / trace-ir / event-class.c
index 3f4f5d2db0ab5357b52361aa09226eb9c454f490..20b8850d0c2a77c7b746a4ab97e75e6e8e2fad32 100644 (file)
  */
 
 #define BT_LOG_TAG "LIB/EVENT-CLASS"
-#include "lib/lib-logging.h"
+#include "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"
@@ -35,6 +34,7 @@
 #include "lib/value.h"
 #include "common/assert.h"
 #include <inttypes.h>
+#include <stdbool.h>
 #include <stdlib.h>
 
 #include "attributes.h"
 #include "stream-class.h"
 #include "trace.h"
 #include "utils.h"
+#include "lib/func-status.h"
 
-#define BT_ASSERT_PRE_EVENT_CLASS_HOT(_ec) \
-       BT_ASSERT_PRE_HOT(((const struct bt_event_class *) (_ec)),      \
+#define BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(_ec) \
+       BT_ASSERT_PRE_DEV_HOT(((const struct bt_event_class *) (_ec)),  \
                "Event class", ": %!+E", (_ec))
 
 static
@@ -58,6 +59,7 @@ 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);
+       BT_OBJECT_PUT_REF_AND_RESET(event_class->user_attributes);
 
        if (event_class->name.str) {
                g_string_free(event_class->name.str, TRUE);
@@ -84,7 +86,6 @@ void free_event(struct bt_event *event,
        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)
@@ -121,27 +122,32 @@ struct bt_event_class *create_event_class_with_id(
                stream_class, id);
        event_class = g_new0(struct bt_event_class, 1);
        if (!event_class) {
-               BT_LOGE_STR("Failed to allocate one event class.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one event class.");
                goto error;
        }
 
        bt_object_init_shared_with_parent(&event_class->base,
                destroy_event_class);
+       event_class->user_attributes = bt_value_map_create();
+       if (!event_class->user_attributes) {
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Failed to create a map value object.");
+               goto error;
+       }
+
        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;
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
+               goto error;
        }
 
        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;
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
+               goto error;
        }
 
        ret = bt_object_pool_initialize(&event_class->event_pool,
@@ -149,7 +155,8 @@ struct bt_event_class *create_event_class_with_id(
                (bt_object_pool_destroy_object_func) free_event,
                event_class);
        if (ret) {
-               BT_LOGE("Failed to initialize event pool: ret=%d",
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Failed to initialize event pool: ret=%d",
                        ret);
                goto error;
        }
@@ -170,6 +177,7 @@ end:
 struct bt_event_class *bt_event_class_create(
                struct bt_stream_class *stream_class)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        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: "
@@ -181,6 +189,7 @@ struct bt_event_class *bt_event_class_create(
 struct bt_event_class *bt_event_class_create_with_id(
                struct bt_stream_class *stream_class, uint64_t id)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE(!stream_class->assigns_automatic_event_class_id,
                "Stream class automatically assigns event class IDs: "
                "%![sc-]+S", stream_class);
@@ -189,25 +198,26 @@ struct bt_event_class *bt_event_class_create_with_id(
 
 const char *bt_event_class_get_name(const struct bt_event_class *event_class)
 {
-       BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
        return event_class->name.value;
 }
 
-enum bt_event_class_status bt_event_class_set_name(
+enum bt_event_class_set_name_status bt_event_class_set_name(
                struct bt_event_class *event_class, const char *name)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
        BT_ASSERT_PRE_NON_NULL(name, "Name");
-       BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
+       BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
        g_string_assign(event_class->name.str, name);
        event_class->name.value = event_class->name.str->str;
        BT_LIB_LOGD("Set event class's name: %!+E", event_class);
-       return BT_EVENT_CLASS_STATUS_OK;
+       return BT_FUNC_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");
+       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
        return event_class->id;
 }
 
@@ -215,8 +225,8 @@ 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)");
+       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_DEV_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;
@@ -227,7 +237,7 @@ void bt_event_class_set_log_level(
                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_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
        bt_property_uint_set(&event_class->log_level,
                (uint64_t) log_level);
        BT_LIB_LOGD("Set event class's log level: %!+E", event_class);
@@ -235,27 +245,28 @@ void bt_event_class_set_log_level(
 
 const char *bt_event_class_get_emf_uri(const struct bt_event_class *event_class)
 {
-       BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
        return event_class->emf_uri.value;
 }
 
-enum bt_event_class_status bt_event_class_set_emf_uri(
+enum bt_event_class_set_emf_uri_status bt_event_class_set_emf_uri(
                struct bt_event_class *event_class,
                const char *emf_uri)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        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);
+       BT_ASSERT_PRE_DEV_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_LOGD("Set event class's EMF URI: %!+E", event_class);
-       return BT_EVENT_CLASS_STATUS_OK;
+       return BT_FUNC_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");
+       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
        return bt_event_class_borrow_stream_class_inline(event_class);
 }
 
@@ -270,7 +281,7 @@ 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");
+       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
        return event_class->specific_context_fc;
 }
 
@@ -278,11 +289,12 @@ 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");
+       BT_ASSERT_PRE_DEV_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(
+enum bt_event_class_set_field_class_status
+bt_event_class_set_specific_context_field_class(
                struct bt_event_class *event_class,
                struct bt_field_class *field_class)
 {
@@ -295,9 +307,10 @@ enum bt_event_class_status bt_event_class_set_specific_context_field_class(
                .event_payload = NULL,
        };
 
+       BT_ASSERT_PRE_NO_ERROR();
        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_DEV_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: "
@@ -315,14 +328,14 @@ enum bt_event_class_status bt_event_class_set_specific_context_field_class(
                 * bt_resolve_field_paths() can fail: anything else
                 * would be because a precondition is not satisfied.
                 */
-               ret = BT_EVENT_CLASS_STATUS_NOMEM;
+               ret = BT_FUNC_STATUS_MEMORY_ERROR;
                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_object_get_ref_no_null_check(event_class->specific_context_fc);
        bt_field_class_freeze(field_class);
        BT_LIB_LOGD("Set event class's specific context field class: %!+E",
                event_class);
@@ -334,18 +347,19 @@ end:
 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");
+       BT_ASSERT_PRE_DEV_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");
+       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
        return event_class->payload_fc;
 }
 
-enum bt_event_class_status bt_event_class_set_payload_field_class(
+enum bt_event_class_set_field_class_status
+bt_event_class_set_payload_field_class(
                struct bt_event_class *event_class,
                struct bt_field_class *field_class)
 {
@@ -358,9 +372,10 @@ enum bt_event_class_status bt_event_class_set_payload_field_class(
                .event_payload = field_class,
        };
 
+       BT_ASSERT_PRE_NO_ERROR();
        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_DEV_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",
@@ -379,14 +394,14 @@ enum bt_event_class_status bt_event_class_set_payload_field_class(
                 * bt_resolve_field_paths() can fail: anything else
                 * would be because a precondition is not satisfied.
                 */
-               ret = BT_EVENT_CLASS_STATUS_NOMEM;
+               ret = BT_FUNC_STATUS_MEMORY_ERROR;
                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_object_get_ref_no_null_check(event_class->payload_fc);
        bt_field_class_freeze(field_class);
        BT_LIB_LOGD("Set event class's payload field class: %!+E", event_class);
 
@@ -399,10 +414,41 @@ 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's user attributes: %!+v",
+               event_class->user_attributes);
+       bt_value_freeze(event_class->user_attributes);
        BT_LIB_LOGD("Freezing event class: %!+E", event_class);
        ((struct bt_event_class *) event_class)->frozen = true;
 }
 
+const struct bt_value *bt_event_class_borrow_user_attributes_const(
+               const struct bt_event_class *event_class)
+{
+       BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class");
+       return event_class->user_attributes;
+}
+
+struct bt_value *bt_event_class_borrow_user_attributes(
+               struct bt_event_class *event_class)
+{
+       return (void *) bt_event_class_borrow_user_attributes_const(
+               (void *) event_class);
+}
+
+void bt_event_class_set_user_attributes(
+               struct bt_event_class *event_class,
+               const struct bt_value *user_attributes)
+{
+       BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
+       BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
+       BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
+               "User attributes object is not a map value object.");
+       BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class);
+       bt_object_put_ref_no_null_check(event_class->user_attributes);
+       event_class->user_attributes = (void *) user_attributes;
+       bt_object_get_ref_no_null_check(event_class->user_attributes);
+}
+
 void bt_event_class_get_ref(const struct bt_event_class *event_class)
 {
        bt_object_get_ref(event_class);
This page took 0.029171 seconds and 4 git commands to generate.