lib: make trace IR API const-correct
[babeltrace.git] / lib / trace-ir / trace.c
index e5ae51325ddd5932177ba8a11996ff42652fd5ca..5fe179d71a5bad616f5e21040de2f4038d69b205 100644 (file)
@@ -1,8 +1,4 @@
 /*
- * trace.c
- *
- * Babeltrace trace IR - Trace
- *
  * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
@@ -30,6 +26,7 @@
 #include <babeltrace/lib-logging-internal.h>
 
 #include <babeltrace/assert-pre-internal.h>
+#include <babeltrace/trace-ir/trace-const.h>
 #include <babeltrace/trace-ir/trace-internal.h>
 #include <babeltrace/trace-ir/clock-class-internal.h>
 #include <babeltrace/trace-ir/stream-internal.h>
 #include <babeltrace/ctf-writer/functor-internal.h>
 #include <babeltrace/ctf-writer/clock-internal.h>
 #include <babeltrace/trace-ir/field-wrapper-internal.h>
-#include <babeltrace/trace-ir/field-types-internal.h>
+#include <babeltrace/trace-ir/field-classes-internal.h>
 #include <babeltrace/trace-ir/attributes-internal.h>
 #include <babeltrace/trace-ir/utils-internal.h>
 #include <babeltrace/trace-ir/resolve-field-path-internal.h>
 #include <babeltrace/compiler-internal.h>
 #include <babeltrace/values.h>
+#include <babeltrace/values-const.h>
 #include <babeltrace/values-internal.h>
-#include <babeltrace/ref.h>
+#include <babeltrace/object.h>
 #include <babeltrace/types.h>
 #include <babeltrace/endian-internal.h>
 #include <babeltrace/assert-internal.h>
@@ -58,8 +56,8 @@
 #include <stdlib.h>
 
 struct bt_trace_is_static_listener_elem {
-       bt_trace_is_static_listener func;
-       bt_trace_listener_removed removed;
+       bt_trace_is_static_listener_func func;
+       bt_trace_listener_removed_func removed;
        void *data;
 };
 
@@ -86,11 +84,12 @@ void destroy_trace(struct bt_object *obj)
                                        struct bt_trace_is_static_listener_elem, i);
 
                        if (elem.removed) {
-                               elem.removed(trace, elem.data);
+                               elem.removed((void *) trace, elem.data);
                        }
                }
 
                g_array_free(trace->is_static_listeners, TRUE);
+               trace->is_static_listeners = NULL;
        }
 
        bt_object_pool_finalize(&trace->packet_header_field_pool);
@@ -98,28 +97,35 @@ void destroy_trace(struct bt_object *obj)
        if (trace->environment) {
                BT_LOGD_STR("Destroying environment attributes.");
                bt_attributes_destroy(trace->environment);
+               trace->environment = NULL;
        }
 
        if (trace->name.str) {
                g_string_free(trace->name.str, TRUE);
+               trace->name.str = NULL;
+               trace->name.value = NULL;
        }
 
        if (trace->streams) {
                BT_LOGD_STR("Destroying streams.");
                g_ptr_array_free(trace->streams, TRUE);
+               trace->streams = NULL;
        }
 
        if (trace->stream_classes) {
                BT_LOGD_STR("Destroying stream classes.");
                g_ptr_array_free(trace->stream_classes, TRUE);
+               trace->stream_classes = NULL;
        }
 
        if (trace->stream_classes_stream_count) {
                g_hash_table_destroy(trace->stream_classes_stream_count);
+               trace->stream_classes_stream_count = NULL;
        }
 
-       BT_LOGD_STR("Putting packet header field type.");
-       bt_put(trace->packet_header_ft);
+       BT_LOGD_STR("Putting packet header field classe.");
+       bt_object_put_ref(trace->packet_header_fc);
+       trace->packet_header_fc = NULL;
        g_free(trace);
 }
 
@@ -198,13 +204,13 @@ struct bt_trace *bt_trace_create(void)
        goto end;
 
 error:
-       BT_PUT(trace);
+       BT_OBJECT_PUT_REF_AND_RESET(trace);
 
 end:
-       return trace;
+       return (void *) trace;
 }
 
-const char *bt_trace_get_name(struct bt_trace *trace)
+const char *bt_trace_get_name(const struct bt_trace *trace)
 {
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
        return trace->name.value;
@@ -221,13 +227,13 @@ int bt_trace_set_name(struct bt_trace *trace, const char *name)
        return 0;
 }
 
-bt_uuid bt_trace_get_uuid(struct bt_trace *trace)
+bt_uuid bt_trace_get_uuid(const struct bt_trace *trace)
 {
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
        return trace->uuid.value;
 }
 
-int bt_trace_set_uuid(struct bt_trace *trace, bt_uuid uuid)
+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");
@@ -235,20 +241,16 @@ int bt_trace_set_uuid(struct bt_trace *trace, bt_uuid uuid)
        memcpy(trace->uuid.uuid, uuid, BABELTRACE_UUID_LEN);
        trace->uuid.value = trace->uuid.uuid;
        BT_LIB_LOGV("Set trace's UUID: %!+t", trace);
-       return 0;
 }
 
 BT_ASSERT_FUNC
 static
-bool trace_has_environment_entry(struct bt_trace *trace, const char *name)
+bool trace_has_environment_entry(const struct bt_trace *trace, const char *name)
 {
-       struct bt_value *attribute;
-
        BT_ASSERT(trace);
 
-       attribute = bt_attributes_borrow_field_value_by_name(
-               trace->environment, name);
-       return attribute != NULL;
+       return bt_attributes_borrow_field_value_by_name(
+               trace->environment, name) != NULL;
 }
 
 static
@@ -278,12 +280,12 @@ int set_environment_entry(struct bt_trace *trace, const char *name,
        return ret;
 }
 
-int bt_trace_set_environment_entry_string(struct bt_trace *trace,
+int 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");
@@ -298,16 +300,15 @@ int bt_trace_set_environment_entry_string(struct bt_trace *trace,
        ret = set_environment_entry(trace, name, value_obj);
 
 end:
-       bt_put(value_obj);
+       bt_object_put_ref(value_obj);
        return ret;
 }
 
-int bt_trace_set_environment_entry_integer(
-               struct bt_trace *trace, const char *name, int64_t value)
+int 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_create_init(value);
@@ -321,11 +322,11 @@ int bt_trace_set_environment_entry_integer(
        ret = set_environment_entry(trace, name, value_obj);
 
 end:
-       bt_put(value_obj);
+       bt_object_put_ref(value_obj);
        return ret;
 }
 
-uint64_t bt_trace_get_environment_entry_count(struct bt_trace *trace)
+uint64_t bt_trace_get_environment_entry_count(const struct bt_trace *trace)
 {
        int64_t ret;
 
@@ -335,9 +336,9 @@ uint64_t bt_trace_get_environment_entry_count(struct bt_trace *trace)
        return (uint64_t) ret;
 }
 
-void bt_trace_borrow_environment_entry_by_index(
-               struct bt_trace *trace, uint64_t index,
-               const char **name, struct bt_value **value)
+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_NON_NULL(trace, "Trace");
        BT_ASSERT_PRE_NON_NULL(name, "Name");
@@ -350,8 +351,8 @@ void bt_trace_borrow_environment_entry_by_index(
        BT_ASSERT(*name);
 }
 
-struct bt_value *bt_trace_borrow_environment_entry_value_by_name(
-               struct bt_trace *trace, const char *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_NON_NULL(trace, "Trace");
        BT_ASSERT_PRE_NON_NULL(name, "Name");
@@ -359,7 +360,7 @@ struct bt_value *bt_trace_borrow_environment_entry_value_by_name(
                name);
 }
 
-uint64_t bt_trace_get_stream_count(struct bt_trace *trace)
+uint64_t bt_trace_get_stream_count(const struct bt_trace *trace)
 {
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
        return (uint64_t) trace->streams->len;
@@ -373,8 +374,14 @@ struct bt_stream *bt_trace_borrow_stream_by_index(
        return g_ptr_array_index(trace->streams, index);
 }
 
-struct bt_stream *bt_trace_borrow_stream_by_id(
-               struct bt_trace *trace, uint64_t id)
+const struct bt_stream *bt_trace_borrow_stream_by_index_const(
+               const struct bt_trace *trace, uint64_t index)
+{
+       return bt_trace_borrow_stream_by_index((void *) trace, index);
+}
+
+struct bt_stream *bt_trace_borrow_stream_by_id(struct bt_trace *trace,
+               uint64_t id)
 {
        struct bt_stream *stream = NULL;
        uint64_t i;
@@ -395,7 +402,13 @@ end:
        return stream;
 }
 
-uint64_t bt_trace_get_stream_class_count(struct bt_trace *trace)
+const struct bt_stream *bt_trace_borrow_stream_by_id_const(
+               const struct bt_trace *trace, uint64_t id)
+{
+       return bt_trace_borrow_stream_by_id((void *) trace, id);
+}
+
+uint64_t bt_trace_get_stream_class_count(const struct bt_trace *trace)
 {
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
        return (uint64_t) trace->stream_classes->len;
@@ -409,6 +422,14 @@ struct bt_stream_class *bt_trace_borrow_stream_class_by_index(
        return g_ptr_array_index(trace->stream_classes, index);
 }
 
+const struct bt_stream_class *
+bt_trace_borrow_stream_class_by_index_const(
+               const struct bt_trace *trace, uint64_t index)
+{
+       return bt_trace_borrow_stream_class_by_index(
+               (void *) trace, index);
+}
+
 struct bt_stream_class *bt_trace_borrow_stream_class_by_id(
                struct bt_trace *trace, uint64_t id)
 {
@@ -431,19 +452,27 @@ end:
        return stream_class;
 }
 
-struct bt_field_type *bt_trace_borrow_packet_header_field_type(
-               struct bt_trace *trace)
+const struct bt_stream_class *
+bt_trace_borrow_stream_class_by_id_const(
+               const struct bt_trace *trace, uint64_t id)
+{
+       return bt_trace_borrow_stream_class_by_id((void *) trace, id);
+}
+
+const struct bt_field_class *bt_trace_borrow_packet_header_field_class_const(
+               const struct bt_trace *trace)
 {
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
-       return trace->packet_header_ft;
+       return trace->packet_header_fc;
 }
 
-int bt_trace_set_packet_header_field_type(struct bt_trace *trace,
-               struct bt_field_type *field_type)
+int bt_trace_set_packet_header_field_class(
+               struct bt_trace *trace,
+               struct bt_field_class *field_class)
 {
        int ret;
        struct bt_resolve_field_path_context resolve_ctx = {
-               .packet_header = field_type,
+               .packet_header = field_class,
                .packet_context = NULL,
                .event_header = NULL,
                .event_common_context = NULL,
@@ -452,36 +481,36 @@ int bt_trace_set_packet_header_field_type(struct bt_trace *trace,
        };
 
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
-       BT_ASSERT_PRE_NON_NULL(field_type, "Field type");
+       BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
        BT_ASSERT_PRE_TRACE_HOT(trace);
-       BT_ASSERT_PRE(bt_field_type_get_type_id(field_type) ==
-               BT_FIELD_TYPE_ID_STRUCTURE,
-               "Packet header field type is not a structure field type: %!+F",
-               field_type);
-       ret = bt_resolve_field_paths(field_type, &resolve_ctx);
+       BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
+               BT_FIELD_CLASS_TYPE_STRUCTURE,
+               "Packet header field classe is not a structure field classe: %!+F",
+               field_class);
+       ret = bt_resolve_field_paths(field_class, &resolve_ctx);
        if (ret) {
                goto end;
        }
 
-       bt_field_type_make_part_of_trace(field_type);
-       bt_put(trace->packet_header_ft);
-       trace->packet_header_ft = bt_get(field_type);
-       bt_field_type_freeze(field_type);
-       BT_LIB_LOGV("Set trace's packet header field type: %!+t", trace);
+       bt_field_class_make_part_of_trace(field_class);
+       bt_object_put_ref(trace->packet_header_fc);
+       trace->packet_header_fc = field_class;
+       bt_object_get_no_null_check(trace->packet_header_fc);
+       bt_field_class_freeze(field_class);
+       BT_LIB_LOGV("Set trace's packet header field classe: %!+t", trace);
 
 end:
        return ret;
 }
 
-bt_bool bt_trace_is_static(struct bt_trace *trace)
+bt_bool bt_trace_is_static(const struct bt_trace *trace)
 {
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
        return (bt_bool) trace->is_static;
 }
 
 int bt_trace_make_static(struct bt_trace *trace)
-{
-       uint64_t i;
+{      uint64_t i;
 
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
        trace->is_static = true;
@@ -495,18 +524,20 @@ int bt_trace_make_static(struct bt_trace *trace)
                                struct bt_trace_is_static_listener_elem, i);
 
                if (elem.func) {
-                       elem.func(trace, elem.data);
+                       elem.func((void *) trace, elem.data);
                }
        }
 
        return 0;
 }
 
-int bt_trace_add_is_static_listener(struct bt_trace *trace,
-               bt_trace_is_static_listener listener,
-               bt_trace_listener_removed listener_removed, void *data,
+int bt_trace_add_is_static_listener(
+               const struct bt_trace *c_trace,
+               bt_trace_is_static_listener_func listener,
+               bt_trace_listener_removed_func listener_removed, void *data,
                uint64_t *listener_id)
 {
+       struct bt_trace *trace = (void *) c_trace;
        uint64_t i;
        struct bt_trace_is_static_listener_elem new_elem = {
                .func = listener,
@@ -550,7 +581,7 @@ int bt_trace_add_is_static_listener(struct bt_trace *trace,
 
 BT_ASSERT_PRE_FUNC
 static
-bool has_listener_id(struct bt_trace *trace, uint64_t listener_id)
+bool has_listener_id(const struct bt_trace *trace, uint64_t listener_id)
 {
        BT_ASSERT(listener_id < trace->is_static_listeners->len);
        return (&g_array_index(trace->is_static_listeners,
@@ -558,9 +589,10 @@ bool has_listener_id(struct bt_trace *trace, uint64_t listener_id)
                        listener_id))->func != NULL;
 }
 
-int bt_trace_remove_is_static_listener(
-               struct bt_trace *trace, uint64_t listener_id)
+int bt_trace_remove_is_static_listener(const struct bt_trace *c_trace,
+               uint64_t listener_id)
 {
+       struct bt_trace *trace = (void *) c_trace;
        struct bt_trace_is_static_listener_elem *elem;
 
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
@@ -583,7 +615,7 @@ int bt_trace_remove_is_static_listener(
                        "%![trace-]+t, listener-id=%" PRIu64,
                        trace, listener_id);
                trace->in_remove_listener = true;
-               elem->removed(trace, elem->data);
+               elem->removed((void *) trace, elem->data);
                trace->in_remove_listener = false;
        }
 
@@ -597,29 +629,28 @@ int bt_trace_remove_is_static_listener(
 }
 
 BT_HIDDEN
-void _bt_trace_freeze(struct bt_trace *trace)
+void _bt_trace_freeze(const struct bt_trace *trace)
 {
-       /* The packet header field type is already frozen */
+       /* The packet header field classe is already frozen */
        BT_ASSERT(trace);
        BT_LIB_LOGD("Freezing trace: %!+t", trace);
-       trace->frozen = true;
+       ((struct bt_trace *) trace)->frozen = true;
 }
 
-bt_bool bt_trace_assigns_automatic_stream_class_id(struct bt_trace *trace)
+bt_bool bt_trace_assigns_automatic_stream_class_id(const struct bt_trace *trace)
 {
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
        return (bt_bool) trace->assigns_automatic_stream_class_id;
 }
 
-int bt_trace_set_assigns_automatic_stream_class_id(
-               struct bt_trace *trace, bt_bool value)
+void bt_trace_set_assigns_automatic_stream_class_id(struct bt_trace *trace,
+               bt_bool value)
 {
        BT_ASSERT_PRE_NON_NULL(trace, "Trace");
        BT_ASSERT_PRE_TRACE_HOT(trace);
        trace->assigns_automatic_stream_class_id = (bool) value;
        BT_LIB_LOGV("Set trace's automatic stream class ID "
                "assignment property: %!+t", trace);
-       return 0;
 }
 
 BT_HIDDEN
@@ -642,8 +673,8 @@ void bt_trace_add_stream(struct bt_trace *trace, struct bt_stream *stream)
 }
 
 BT_HIDDEN
-uint64_t bt_trace_get_automatic_stream_id(struct bt_trace *trace,
-               struct bt_stream_class *stream_class)
+uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace *trace,
+               const struct bt_stream_class *stream_class)
 {
        gpointer orig_key;
        gpointer value;
This page took 0.031199 seconds and 4 git commands to generate.