lib: rename functions to clearly indicate API inheritance
[babeltrace.git] / src / lib / trace-ir / trace.c
index 0776a7b2d874180046b3ac4c60a99df1eee56342..e884c72a29ed0887bfe1da7880b02863684457dd 100644 (file)
@@ -21,8 +21,8 @@
  * SOFTWARE.
  */
 
-#define BT_LOG_TAG "TRACE"
-#include "lib/lib-logging.h"
+#define BT_LOG_TAG "LIB/TRACE"
+#include "lib/logging.h"
 
 #include "lib/assert-pre.h"
 #include <babeltrace2/trace-ir/trace.h>
 #include "trace-class.h"
 #include "trace.h"
 #include "utils.h"
+#include "lib/func-status.h"
 
 struct bt_trace_destruction_listener_elem {
        bt_trace_destruction_listener_func func;
        void *data;
 };
 
-#define BT_ASSERT_PRE_TRACE_HOT(_trace) \
-       BT_ASSERT_PRE_HOT((_trace), "Trace", ": %!+t", (_trace))
+#define BT_ASSERT_PRE_DEV_TRACE_HOT(_trace) \
+       BT_ASSERT_PRE_DEV_HOT((_trace), "Trace", ": %!+t", (_trace))
 
 static
 void destroy_trace(struct bt_object *obj)
@@ -117,6 +118,12 @@ void destroy_trace(struct bt_object *obj)
                trace->name.value = NULL;
        }
 
+       if (trace->environment) {
+               BT_LOGD_STR("Destroying environment attributes.");
+               bt_attributes_destroy(trace->environment);
+               trace->environment = NULL;
+       }
+
        if (trace->streams) {
                BT_LOGD_STR("Destroying streams.");
                g_ptr_array_free(trace->streams, TRUE);
@@ -141,7 +148,7 @@ struct bt_trace *bt_trace_create(struct bt_trace_class *tc)
        BT_LIB_LOGD("Creating trace object: %![tc-]+T", tc);
        trace = g_new0(struct bt_trace, 1);
        if (!trace) {
-               BT_LOGE_STR("Failed to allocate one trace.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one trace.");
                goto error;
        }
 
@@ -149,27 +156,33 @@ struct bt_trace *bt_trace_create(struct bt_trace_class *tc)
        trace->streams = g_ptr_array_new_with_free_func(
                (GDestroyNotify) bt_object_try_spec_release);
        if (!trace->streams) {
-               BT_LOGE_STR("Failed to allocate one GPtrArray.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
                goto error;
        }
 
        trace->stream_classes_stream_count = g_hash_table_new(g_direct_hash,
                g_direct_equal);
        if (!trace->stream_classes_stream_count) {
-               BT_LOGE_STR("Failed to allocate one GHashTable.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GHashTable.");
                goto error;
        }
 
        trace->name.str = g_string_new(NULL);
        if (!trace->name.str) {
-               BT_LOGE_STR("Failed to allocate one GString.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString.");
+               goto error;
+       }
+
+       trace->environment = bt_attributes_create();
+       if (!trace->environment) {
+               BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty attributes object.");
                goto error;
        }
 
        trace->destruction_listeners = g_array_new(FALSE, TRUE,
                sizeof(struct bt_trace_destruction_listener_elem));
        if (!trace->destruction_listeners) {
-               BT_LOGE_STR("Failed to allocate one GArray.");
+               BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
                goto error;
        }
 
@@ -187,32 +200,172 @@ end:
 
 const char *bt_trace_get_name(const struct bt_trace *trace)
 {
-       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
        return trace->name.value;
 }
 
-enum bt_trace_status bt_trace_set_name(struct bt_trace *trace, const char *name)
+enum bt_trace_set_name_status bt_trace_set_name(struct bt_trace *trace,
+               const char *name)
 {
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
        BT_ASSERT_PRE_NON_NULL(name, "Name");
-       BT_ASSERT_PRE_TRACE_HOT(trace);
+       BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
        g_string_assign(trace->name.str, name);
        trace->name.value = trace->name.str->str;
        BT_LIB_LOGD("Set trace's name: %!+t", trace);
-       return BT_TRACE_STATUS_OK;
+       return BT_FUNC_STATUS_OK;
 }
 
-uint64_t bt_trace_get_stream_count(const struct bt_trace *trace)
+bt_uuid bt_trace_get_uuid(const struct bt_trace *trace)
+{
+       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       return trace->uuid.value;
+}
+
+void bt_trace_set_uuid(struct bt_trace *trace, bt_uuid uuid)
+{
+       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_NON_NULL(uuid, "UUID");
+       BT_ASSERT_PRE_DEV_TRACE_HOT(trace);
+       bt_uuid_copy(trace->uuid.uuid, uuid);
+       trace->uuid.value = trace->uuid.uuid;
+       BT_LIB_LOGD("Set trace's UUID: %!+t", trace);
+}
+
+BT_ASSERT_FUNC
+static
+bool trace_has_environment_entry(const struct bt_trace *trace, const char *name)
+{
+       BT_ASSERT(trace);
+
+       return bt_attributes_borrow_field_value_by_name(
+               trace->environment, name) != NULL;
+}
+
+static
+enum bt_trace_set_environment_entry_status set_environment_entry(
+               struct bt_trace *trace,
+               const char *name, struct bt_value *value)
+{
+       int ret;
+
+       BT_ASSERT(trace);
+       BT_ASSERT(name);
+       BT_ASSERT(value);
+       BT_ASSERT_PRE(!trace->frozen ||
+               !trace_has_environment_entry(trace, name),
+               "Trace is frozen: cannot replace environment entry: "
+               "%![trace-]+t, entry-name=\"%s\"", trace, name);
+       ret = bt_attributes_set_field_value(trace->environment, name,
+               value);
+       if (ret) {
+               ret = BT_FUNC_STATUS_MEMORY_ERROR;
+               BT_LIB_LOGE_APPEND_CAUSE(
+                       "Cannot set trace's environment entry: "
+                       "%![trace-]+t, entry-name=\"%s\"", trace, name);
+       } else {
+               bt_value_freeze(value);
+               BT_LIB_LOGD("Set trace's environment entry: "
+                       "%![trace-]+t, entry-name=\"%s\"", trace, name);
+       }
+
+       return ret;
+}
+
+enum bt_trace_set_environment_entry_status
+bt_trace_set_environment_entry_string(
+               struct bt_trace *trace, const char *name, const char *value)
+{
+       int ret;
+       struct bt_value *value_obj;
+       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+       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(trace, name, value_obj);
+
+end:
+       bt_object_put_ref(value_obj);
+       return ret;
+}
+
+enum bt_trace_set_environment_entry_status
+bt_trace_set_environment_entry_integer(
+               struct bt_trace *trace, const char *name, int64_t value)
 {
+       int ret;
+       struct bt_value *value_obj;
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_NON_NULL(name, "Name");
+       value_obj = bt_value_integer_signed_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(trace, name, value_obj);
+
+end:
+       bt_object_put_ref(value_obj);
+       return ret;
+}
+
+uint64_t bt_trace_get_environment_entry_count(const struct bt_trace *trace)
+{
+       int64_t ret;
+
+       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       ret = bt_attributes_get_count(trace->environment);
+       BT_ASSERT(ret >= 0);
+       return (uint64_t) ret;
+}
+
+void bt_trace_borrow_environment_entry_by_index_const(
+               const struct bt_trace *trace, uint64_t index,
+               const char **name, const struct bt_value **value)
+{
+       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
+       BT_ASSERT_PRE_DEV_NON_NULL(value, "Value");
+       BT_ASSERT_PRE_DEV_VALID_INDEX(index,
+               bt_attributes_get_count(trace->environment));
+       *value = bt_attributes_borrow_field_value(trace->environment, index);
+       BT_ASSERT(*value);
+       *name = bt_attributes_get_field_name(trace->environment, index);
+       BT_ASSERT(*name);
+}
+
+const struct bt_value *bt_trace_borrow_environment_entry_value_by_name_const(
+               const struct bt_trace *trace, const char *name)
+{
+       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
+       return bt_attributes_borrow_field_value_by_name(trace->environment,
+               name);
+}
+
+uint64_t bt_trace_get_stream_count(const struct bt_trace *trace)
+{
+       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
        return (uint64_t) trace->streams->len;
 }
 
 struct bt_stream *bt_trace_borrow_stream_by_index(
                struct bt_trace *trace, uint64_t index)
 {
-       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
-       BT_ASSERT_PRE_VALID_INDEX(index, trace->streams->len);
+       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_VALID_INDEX(index, trace->streams->len);
        return g_ptr_array_index(trace->streams, index);
 }
 
@@ -228,7 +381,7 @@ struct bt_stream *bt_trace_borrow_stream_by_id(struct bt_trace *trace,
        struct bt_stream *stream = NULL;
        uint64_t i;
 
-       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
 
        for (i = 0; i < trace->streams->len; i++) {
                struct bt_stream *stream_candidate =
@@ -250,7 +403,7 @@ const struct bt_stream *bt_trace_borrow_stream_by_id_const(
        return bt_trace_borrow_stream_by_id((void *) trace, id);
 }
 
-enum bt_trace_status bt_trace_add_destruction_listener(
+enum bt_trace_add_listener_status bt_trace_add_destruction_listener(
                const struct bt_trace *c_trace,
                bt_trace_destruction_listener_func listener,
                void *data, uint64_t *listener_id)
@@ -288,10 +441,9 @@ enum bt_trace_status bt_trace_add_destruction_listener(
 
        BT_LIB_LOGD("Added destruction listener: " "%![trace-]+t, "
                        "listener-id=%" PRIu64, trace, i);
-       return BT_TRACE_STATUS_OK;
+       return BT_FUNC_STATUS_OK;
 }
 
-BT_ASSERT_PRE_FUNC
 static
 bool has_listener_id(const struct bt_trace *trace, uint64_t listener_id)
 {
@@ -301,7 +453,7 @@ bool has_listener_id(const struct bt_trace *trace, uint64_t listener_id)
                        listener_id))->func != NULL;
 }
 
-enum bt_trace_status bt_trace_remove_destruction_listener(
+enum bt_trace_remove_listener_status bt_trace_remove_destruction_listener(
                const struct bt_trace *c_trace, uint64_t listener_id)
 {
        struct bt_trace *trace = (void *) c_trace;
@@ -321,7 +473,7 @@ enum bt_trace_status bt_trace_remove_destruction_listener(
        BT_LIB_LOGD("Removed \"trace destruction listener: "
                "%![trace-]+t, listener-id=%" PRIu64,
                trace, listener_id);
-       return BT_TRACE_STATUS_OK;
+       return BT_FUNC_STATUS_OK;
 }
 
 BT_HIDDEN
@@ -373,7 +525,7 @@ uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace *trace,
 
 struct bt_trace_class *bt_trace_borrow_class(struct bt_trace *trace)
 {
-       BT_ASSERT_PRE_NON_NULL(trace, "Trace");
+       BT_ASSERT_PRE_DEV_NON_NULL(trace, "Trace");
        return trace->class;
 }
 
This page took 0.026702 seconds and 4 git commands to generate.