X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Ftrace-ir%2Fevent-class.c;h=871f40cbb13eeaa15fdc00183954142870c52d14;hb=1778c2a4134647150b199b2b57130817144446b0;hp=3f4f5d2db0ab5357b52361aa09226eb9c454f490;hpb=350ad6c1c5f45a4e90c33e3c1354125c209bbf02;p=babeltrace.git diff --git a/src/lib/trace-ir/event-class.c b/src/lib/trace-ir/event-class.c index 3f4f5d2d..871f40cb 100644 --- a/src/lib/trace-ir/event-class.c +++ b/src/lib/trace-ir/event-class.c @@ -1,33 +1,16 @@ /* + * SPDX-License-Identifier: MIT + * * Copyright 2017-2018 Philippe Proulx * Copyright 2013, 2014 Jérémie Galarneau - * - * 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 "LIB/EVENT-CLASS" -#include "lib/lib-logging.h" +#include "lib/logging.h" -#include "lib/assert-pre.h" +#include "lib/assert-cond.h" #include #include -#include #include #include "compat/compiler.h" #include "compat/endian.h" @@ -35,6 +18,7 @@ #include "lib/value.h" #include "common/assert.h" #include +#include #include #include "attributes.h" @@ -47,9 +31,11 @@ #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("event-class", \ + ((const struct bt_event_class *) (_ec)), \ "Event class", ": %!+E", (_ec)) static @@ -58,6 +44,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 +71,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) @@ -114,34 +100,40 @@ struct bt_event_class *create_event_class_with_id( struct bt_event_class *event_class; BT_ASSERT(stream_class); - BT_ASSERT_PRE(event_class_id_is_unique(stream_class, id), + BT_ASSERT_PRE("event-class-id-is-unique", + 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."); + 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 +141,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,8 +163,11 @@ end: 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, + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_SC_NON_NULL(stream_class); + BT_ASSERT_PRE( + "stream-class-automatically-assigns-event-class-ids", + 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, @@ -181,7 +177,10 @@ 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(!stream_class->assigns_automatic_event_class_id, + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE( + "stream-class-does-not-automatically-assigns-event-class-ids", + !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); @@ -189,25 +188,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_EC_NON_NULL(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_NON_NULL(event_class, "Event class"); - BT_ASSERT_PRE_NON_NULL(name, "Name"); - BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_EC_NON_NULL(event_class); + BT_ASSERT_PRE_NAME_NON_NULL(name); + 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_EC_NON_NULL(event_class); return event_class->id; } @@ -215,8 +215,9 @@ 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_EC_NON_NULL(event_class); + BT_ASSERT_PRE_DEV_NON_NULL("log-level-output", 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; @@ -226,8 +227,8 @@ 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_ASSERT_PRE_EC_NON_NULL(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 +236,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_EC_NON_NULL(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_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_NO_ERROR(); + BT_ASSERT_PRE_EC_NON_NULL(event_class); + BT_ASSERT_PRE_NON_NULL("emf-uri", emf_uri, "EMF URI"); + 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_EC_NON_NULL(event_class); return bt_event_class_borrow_stream_class_inline(event_class); } @@ -270,7 +272,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_EC_NON_NULL(event_class); return event_class->specific_context_fc; } @@ -278,11 +280,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_EC_NON_NULL(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,34 +298,33 @@ enum bt_event_class_status bt_event_class_set_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); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_EC_NON_NULL(event_class); + BT_ASSERT_PRE_FC_NON_NULL(field_class); + BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class); + BT_ASSERT_PRE_FC_IS_STRUCT("specific-context", field_class, + "Specific context 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); + ret = bt_resolve_field_paths(field_class, &resolve_ctx, __func__); 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; + 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 +336,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_EC_NON_NULL(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_EC_NON_NULL(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,13 +361,11 @@ enum bt_event_class_status bt_event_class_set_payload_field_class( .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); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_EC_NON_NULL(event_class); + BT_ASSERT_PRE_FC_NON_NULL(field_class); + BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class); + BT_ASSERT_PRE_FC_IS_STRUCT("payload", field_class, "Payload field class"); stream_class = bt_event_class_borrow_stream_class_inline( event_class); resolve_ctx.packet_context = stream_class->packet_context_fc; @@ -372,21 +373,21 @@ enum bt_event_class_status bt_event_class_set_payload_field_class( 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); + ret = bt_resolve_field_paths(field_class, &resolve_ctx, __func__); 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; + 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 +400,40 @@ 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_EC_NON_NULL(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_EC_NON_NULL(event_class); + BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class); + BT_ASSERT_PRE_USER_ATTRS_NON_NULL(user_attributes); + BT_ASSERT_PRE_USER_ATTRS_IS_MAP(user_attributes); + 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);