X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Ftrace-ir%2Ftrace-class.c;h=648a2af8095c3d1fcdbfe7162cc7597ff571551b;hb=5a3fec55322bf221441f86d5ffedeb049d08d200;hp=1201534c919d4fd0cb74291879a140519c1c8435;hpb=870631a2db01676b476dbee615aade0a22926bcd;p=babeltrace.git diff --git a/src/lib/trace-ir/trace-class.c b/src/lib/trace-ir/trace-class.c index 1201534c..648a2af8 100644 --- a/src/lib/trace-ir/trace-class.c +++ b/src/lib/trace-ir/trace-class.c @@ -1,59 +1,32 @@ /* + * SPDX-License-Identifier: MIT + * * Copyright 2017-2018 Philippe Proulx * Copyright 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/TRACE" +#define BT_LOG_TAG "LIB/TRACE-CLASS" #include "lib/logging.h" -#include "lib/assert-pre.h" +#include "lib/assert-cond.h" #include -#include #include -#include "ctf-writer/functor.h" -#include "ctf-writer/clock.h" #include "compat/compiler.h" #include -#include #include "lib/value.h" #include #include "compat/endian.h" #include "common/assert.h" -#include "compat/glib.h" #include #include #include +#include #include -#include "attributes.h" -#include "clock-class.h" -#include "event-class.h" -#include "event.h" -#include "field-class.h" -#include "field-wrapper.h" -#include "resolve-field-path.h" +#include "trace-class.h" #include "stream-class.h" #include "stream.h" -#include "trace.h" -#include "utils.h" +#include "lib/value.h" #include "lib/func-status.h" struct bt_trace_class_destruction_listener_elem { @@ -61,8 +34,11 @@ struct bt_trace_class_destruction_listener_elem { void *data; }; -#define BT_ASSERT_PRE_TRACE_CLASS_HOT(_tc) \ - BT_ASSERT_PRE_HOT((_tc), "Trace class", ": %!+T", (_tc)) +#define BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(_tc) \ + BT_ASSERT_PRE_DEV_HOT("trace-class", (_tc), "Trace class", \ + ": %!+T", (_tc)) + +#define DESTRUCTION_LISTENER_FUNC_NAME "bt_trace_destruction_listener_func" static void destroy_trace_class(struct bt_object *obj) @@ -70,12 +46,16 @@ void destroy_trace_class(struct bt_object *obj) struct bt_trace_class *tc = (void *) obj; BT_LIB_LOGD("Destroying trace class object: %!+T", tc); + BT_OBJECT_PUT_REF_AND_RESET(tc->user_attributes); + /* * Call destruction listener functions so that everything else * still exists in the trace class. */ if (tc->destruction_listeners) { uint64_t i; + const struct bt_error *saved_error; + BT_LIB_LOGD("Calling trace class destruction listener(s): %!+T", tc); /* @@ -90,36 +70,36 @@ void destroy_trace_class(struct bt_object *obj) */ tc->base.ref_count++; + saved_error = bt_current_thread_take_error(); + /* Call all the trace class destruction listeners */ for (i = 0; i < tc->destruction_listeners->len; i++) { struct bt_trace_class_destruction_listener_elem elem = - g_array_index(tc->destruction_listeners, + bt_g_array_index(tc->destruction_listeners, struct bt_trace_class_destruction_listener_elem, i); if (elem.func) { elem.func(tc, elem.data); + BT_ASSERT_POST_NO_ERROR( + DESTRUCTION_LISTENER_FUNC_NAME); } /* * The destruction listener should not have kept a * reference to the trace class. */ - BT_ASSERT_PRE(tc->base.ref_count == 1, "Destruction listener kept a reference to the trace class being destroyed: %![tc-]+T", tc); + BT_ASSERT_POST(DESTRUCTION_LISTENER_FUNC_NAME, + "trace-class-reference-count-not-changed", + tc->base.ref_count == 1, + "Destruction listener kept a reference to the trace class being destroyed: %![tc-]+T", + tc); } g_array_free(tc->destruction_listeners, TRUE); tc->destruction_listeners = NULL; - } - - if (tc->environment) { - BT_LOGD_STR("Destroying environment attributes."); - bt_attributes_destroy(tc->environment); - tc->environment = NULL; - } - if (tc->name.str) { - g_string_free(tc->name.str, TRUE); - tc->name.str = NULL; - tc->name.value = NULL; + if (saved_error) { + BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(saved_error); + } } if (tc->stream_classes) { @@ -131,11 +111,13 @@ void destroy_trace_class(struct bt_object *obj) g_free(tc); } +BT_EXPORT struct bt_trace_class *bt_trace_class_create(bt_self_component *self_comp) { struct bt_trace_class *tc = NULL; - BT_ASSERT_PRE_NON_NULL(self_comp, "Self component"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_COMP_NON_NULL(self_comp); BT_LOGD_STR("Creating default trace class object."); tc = g_new0(struct bt_trace_class, 1); if (!tc) { @@ -144,6 +126,12 @@ struct bt_trace_class *bt_trace_class_create(bt_self_component *self_comp) } bt_object_init_shared_with_parent(&tc->base, destroy_trace_class); + tc->user_attributes = bt_value_map_create(); + if (!tc->user_attributes) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to create a map value object."); + goto error; + } tc->stream_classes = g_ptr_array_new_with_free_func( (GDestroyNotify) bt_object_try_spec_release); @@ -152,18 +140,6 @@ struct bt_trace_class *bt_trace_class_create(bt_self_component *self_comp) goto error; } - tc->name.str = g_string_new(NULL); - if (!tc->name.str) { - BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString."); - goto error; - } - - tc->environment = bt_attributes_create(); - if (!tc->environment) { - BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty attributes object."); - goto error; - } - tc->destruction_listeners = g_array_new(FALSE, TRUE, sizeof(struct bt_trace_class_destruction_listener_elem)); if (!tc->destruction_listeners) { @@ -182,44 +158,11 @@ end: return tc; } -const char *bt_trace_class_get_name(const struct bt_trace_class *tc) -{ - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - return tc->name.value; -} - -enum bt_trace_class_set_name_status bt_trace_class_set_name( - struct bt_trace_class *tc, const char *name) -{ - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - BT_ASSERT_PRE_NON_NULL(name, "Name"); - BT_ASSERT_PRE_TRACE_CLASS_HOT(tc); - g_string_assign(tc->name.str, name); - tc->name.value = tc->name.str->str; - BT_LIB_LOGD("Set trace class's name: %!+T", tc); - return BT_FUNC_STATUS_OK; -} - -bt_uuid bt_trace_class_get_uuid(const struct bt_trace_class *tc) -{ - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - return tc->uuid.value; -} - -void bt_trace_class_set_uuid(struct bt_trace_class *tc, bt_uuid uuid) -{ - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - BT_ASSERT_PRE_NON_NULL(uuid, "UUID"); - BT_ASSERT_PRE_TRACE_CLASS_HOT(tc); - memcpy(tc->uuid.uuid, uuid, BABELTRACE_UUID_LEN); - tc->uuid.value = tc->uuid.uuid; - BT_LIB_LOGD("Set trace class's UUID: %!+T", tc); -} - +BT_EXPORT enum bt_trace_class_add_listener_status bt_trace_class_add_destruction_listener( const struct bt_trace_class *_tc, bt_trace_class_destruction_listener_func listener, - void *data, uint64_t *listener_id) + void *data, bt_listener_id *listener_id) { struct bt_trace_class *tc = (void *) _tc; uint64_t i; @@ -228,13 +171,14 @@ enum bt_trace_class_add_listener_status bt_trace_class_add_destruction_listener( .data = data, }; - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - BT_ASSERT_PRE_NON_NULL(listener, "Listener"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_TC_NON_NULL(tc); + BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(listener); /* Find the next available spot */ for (i = 0; i < tc->destruction_listeners->len; i++) { struct bt_trace_class_destruction_listener_elem elem = - g_array_index(tc->destruction_listeners, + bt_g_array_index(tc->destruction_listeners, struct bt_trace_class_destruction_listener_elem, i); if (!elem.func) { @@ -257,27 +201,29 @@ enum bt_trace_class_add_listener_status bt_trace_class_add_destruction_listener( return BT_FUNC_STATUS_OK; } -BT_ASSERT_PRE_FUNC static bool has_listener_id(const struct bt_trace_class *tc, uint64_t listener_id) { BT_ASSERT(listener_id < tc->destruction_listeners->len); - return (&g_array_index(tc->destruction_listeners, + return (&bt_g_array_index(tc->destruction_listeners, struct bt_trace_class_destruction_listener_elem, - listener_id))->func != NULL; + listener_id))->func; } +BT_EXPORT enum bt_trace_class_remove_listener_status bt_trace_class_remove_destruction_listener( - const struct bt_trace_class *_tc, uint64_t listener_id) + const struct bt_trace_class *_tc, bt_listener_id listener_id) { struct bt_trace_class *tc = (void *) _tc; struct bt_trace_class_destruction_listener_elem *elem; - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - BT_ASSERT_PRE(has_listener_id(tc, listener_id), + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_TC_NON_NULL(tc); + BT_ASSERT_PRE("listener-id-exists", + has_listener_id(tc, listener_id), "Trace class has no such trace class destruction listener ID: " "%![tc-]+T, %" PRIu64, tc, listener_id); - elem = &g_array_index(tc->destruction_listeners, + elem = &bt_g_array_index(tc->destruction_listeners, struct bt_trace_class_destruction_listener_elem, listener_id); BT_ASSERT(elem->func); @@ -290,143 +236,23 @@ enum bt_trace_class_remove_listener_status bt_trace_class_remove_destruction_lis return BT_FUNC_STATUS_OK; } -BT_ASSERT_FUNC -static -bool trace_has_environment_entry(const struct bt_trace_class *tc, const char *name) -{ - BT_ASSERT(tc); - - return bt_attributes_borrow_field_value_by_name( - tc->environment, name) != NULL; -} - -static -enum bt_trace_class_set_environment_entry_status set_environment_entry( - struct bt_trace_class *tc, - const char *name, struct bt_value *value) -{ - int ret; - - BT_ASSERT(tc); - BT_ASSERT(name); - BT_ASSERT(value); - BT_ASSERT_PRE(!tc->frozen || - !trace_has_environment_entry(tc, name), - "Trace class is frozen: cannot replace environment entry: " - "%![tc-]+T, entry-name=\"%s\"", tc, name); - ret = bt_attributes_set_field_value(tc->environment, name, - value); - if (ret) { - ret = BT_FUNC_STATUS_MEMORY_ERROR; - BT_LIB_LOGE_APPEND_CAUSE( - "Cannot set trace class's environment entry: " - "%![tc-]+T, entry-name=\"%s\"", tc, name); - } else { - bt_value_freeze(value); - BT_LIB_LOGD("Set trace class's environment entry: " - "%![tc-]+T, entry-name=\"%s\"", tc, name); - } - - return ret; -} - -enum bt_trace_class_set_environment_entry_status -bt_trace_class_set_environment_entry_string( - struct bt_trace_class *tc, const char *name, const char *value) -{ - int ret; - struct bt_value *value_obj; - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - BT_ASSERT_PRE_NON_NULL(name, "Name"); - BT_ASSERT_PRE_NON_NULL(value, "Value"); - value_obj = bt_value_string_create_init(value); - if (!value_obj) { - BT_LIB_LOGE_APPEND_CAUSE( - "Cannot create a string value object."); - ret = -1; - goto end; - } - - /* set_environment_entry() logs errors */ - ret = set_environment_entry(tc, name, value_obj); - -end: - bt_object_put_ref(value_obj); - return ret; -} - -enum bt_trace_class_set_environment_entry_status -bt_trace_class_set_environment_entry_integer( - struct bt_trace_class *tc, const char *name, int64_t value) -{ - int ret; - struct bt_value *value_obj; - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - BT_ASSERT_PRE_NON_NULL(name, "Name"); - value_obj = bt_value_signed_integer_create_init(value); - if (!value_obj) { - BT_LIB_LOGE_APPEND_CAUSE( - "Cannot create an integer value object."); - ret = BT_FUNC_STATUS_MEMORY_ERROR; - goto end; - } - - /* set_environment_entry() logs errors */ - ret = set_environment_entry(tc, name, value_obj); - -end: - bt_object_put_ref(value_obj); - return ret; -} - -uint64_t bt_trace_class_get_environment_entry_count(const struct bt_trace_class *tc) -{ - int64_t ret; - - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - ret = bt_attributes_get_count(tc->environment); - BT_ASSERT(ret >= 0); - return (uint64_t) ret; -} - -void bt_trace_class_borrow_environment_entry_by_index_const( - const struct bt_trace_class *tc, uint64_t index, - const char **name, const struct bt_value **value) -{ - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - BT_ASSERT_PRE_NON_NULL(name, "Name"); - BT_ASSERT_PRE_NON_NULL(value, "Value"); - BT_ASSERT_PRE_VALID_INDEX(index, - bt_attributes_get_count(tc->environment)); - *value = bt_attributes_borrow_field_value(tc->environment, index); - BT_ASSERT(*value); - *name = bt_attributes_get_field_name(tc->environment, index); - BT_ASSERT(*name); -} - -const struct bt_value *bt_trace_class_borrow_environment_entry_value_by_name_const( - const struct bt_trace_class *tc, const char *name) -{ - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - BT_ASSERT_PRE_NON_NULL(name, "Name"); - return bt_attributes_borrow_field_value_by_name(tc->environment, - name); -} - +BT_EXPORT uint64_t bt_trace_class_get_stream_class_count(const struct bt_trace_class *tc) { - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); + BT_ASSERT_PRE_DEV_TC_NON_NULL(tc); return (uint64_t) tc->stream_classes->len; } +BT_EXPORT struct bt_stream_class *bt_trace_class_borrow_stream_class_by_index( struct bt_trace_class *tc, uint64_t index) { - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - BT_ASSERT_PRE_VALID_INDEX(index, tc->stream_classes->len); + BT_ASSERT_PRE_DEV_TC_NON_NULL(tc); + BT_ASSERT_PRE_DEV_VALID_INDEX(index, tc->stream_classes->len); return g_ptr_array_index(tc->stream_classes, index); } +BT_EXPORT const struct bt_stream_class * bt_trace_class_borrow_stream_class_by_index_const( const struct bt_trace_class *tc, uint64_t index) @@ -435,13 +261,14 @@ bt_trace_class_borrow_stream_class_by_index_const( (void *) tc, index); } +BT_EXPORT struct bt_stream_class *bt_trace_class_borrow_stream_class_by_id( struct bt_trace_class *tc, uint64_t id) { struct bt_stream_class *stream_class = NULL; uint64_t i; - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); + BT_ASSERT_PRE_DEV_TC_NON_NULL(tc); for (i = 0; i < tc->stream_classes->len; i++) { struct bt_stream_class *stream_class_candidate = @@ -457,6 +284,7 @@ end: return stream_class; } +BT_EXPORT const struct bt_stream_class * bt_trace_class_borrow_stream_class_by_id_const( const struct bt_trace_class *tc, uint64_t id) @@ -464,7 +292,6 @@ bt_trace_class_borrow_stream_class_by_id_const( return bt_trace_class_borrow_stream_class_by_id((void *) tc, id); } -BT_HIDDEN void _bt_trace_class_freeze(const struct bt_trace_class *tc) { BT_ASSERT(tc); @@ -472,27 +299,60 @@ void _bt_trace_class_freeze(const struct bt_trace_class *tc) ((struct bt_trace_class *) tc)->frozen = true; } +BT_EXPORT bt_bool bt_trace_class_assigns_automatic_stream_class_id(const struct bt_trace_class *tc) { - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); + BT_ASSERT_PRE_DEV_TC_NON_NULL(tc); return (bt_bool) tc->assigns_automatic_stream_class_id; } +BT_EXPORT void bt_trace_class_set_assigns_automatic_stream_class_id(struct bt_trace_class *tc, bt_bool value) { - BT_ASSERT_PRE_NON_NULL(tc, "Trace class"); - BT_ASSERT_PRE_TRACE_CLASS_HOT(tc); + BT_ASSERT_PRE_TC_NON_NULL(tc); + BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(tc); tc->assigns_automatic_stream_class_id = (bool) value; BT_LIB_LOGD("Set trace class's automatic stream class ID " "assignment property: %!+T", tc); } +BT_EXPORT +const struct bt_value *bt_trace_class_borrow_user_attributes_const( + const struct bt_trace_class *trace_class) +{ + BT_ASSERT_PRE_DEV_TC_NON_NULL(trace_class); + return trace_class->user_attributes; +} + +BT_EXPORT +struct bt_value *bt_trace_class_borrow_user_attributes( + struct bt_trace_class *trace_class) +{ + return (void *) bt_trace_class_borrow_user_attributes_const( + (void *) trace_class); +} + +BT_EXPORT +void bt_trace_class_set_user_attributes(struct bt_trace_class *trace_class, + const struct bt_value *user_attributes) +{ + BT_ASSERT_PRE_TC_NON_NULL(trace_class); + BT_ASSERT_PRE_USER_ATTRS_NON_NULL(user_attributes); + BT_ASSERT_PRE_USER_ATTRS_IS_MAP(user_attributes); + BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(trace_class); + bt_object_put_ref_no_null_check(trace_class->user_attributes); + trace_class->user_attributes = (void *) user_attributes; + bt_object_get_ref_no_null_check(trace_class->user_attributes); +} + +BT_EXPORT void bt_trace_class_get_ref(const struct bt_trace_class *trace_class) { bt_object_get_ref(trace_class); } +BT_EXPORT void bt_trace_class_put_ref(const struct bt_trace_class *trace_class) { bt_object_put_ref(trace_class);