lib: rename `bt_object_{get,put}_no` -> `bt_object_{get,put}_ref_no`

[babeltrace.git] / src / lib / object.h

diff --git a/src/lib/object.h b/src/lib/object.h
index 61a502f4254f1a98855c86e30cce553e161922b9..25240b2000b2510074eaee8fcae143d4abb234ac 100644 (file)
--- a/src/lib/object.h
+++ b/src/lib/object.h
@@ -28,6 +28,18 @@
 #include "common/assert.h"
 #include <stdbool.h>
 
+/*
+ * Some parts of the Babeltrace project use this internal library header
+ * for internal reference counting. Until we make this header generic
+ * for the whole project, make it possible to disable logging in this
+ * file by defining `BT_OBJECT_DONT_LOG` because it's possible that the
+ * BT_LOGT() statements here won't find the log level
+ * (`BT_LOG_OUTPUT_LEVEL`).
+ */
+#if defined(BT_LOGT) && !defined(BT_OBJECT_DONT_LOG)
+# define _BT_OBJECT_LOGGING_ENABLED
+#endif
+
 struct bt_object;
 
 typedef void (*bt_object_release_func)(struct bt_object *);
@@ -35,10 +47,10 @@ typedef void (*bt_object_parent_is_owner_listener_func)(
                struct bt_object *);
 
 static inline
-void bt_object_get_no_null_check(const void *obj);
+void bt_object_get_ref_no_null_check(const void *obj);
 
 static inline
-void bt_object_put_no_null_check(const void *obj);
+void bt_object_put_ref_no_null_check(const void *obj);
 
 /*
  * Babeltrace object base.
@@ -114,7 +126,7 @@ struct bt_object *bt_object_get_parent(const struct bt_object *c_obj)
        struct bt_object *parent = bt_object_borrow_parent(obj);
 
        if (parent) {
-               bt_object_get_no_null_check(parent);
+               bt_object_get_ref_no_null_check(parent);
        }
 
        return parent;
@@ -126,8 +138,8 @@ void bt_object_set_parent(struct bt_object *child, struct bt_object *parent)
        BT_ASSERT(child);
        BT_ASSERT(child->is_shared);
 
-#ifdef BT_LOGV
-       BT_LOGV("Setting object's parent: addr=%p, parent-addr=%p",
+#ifdef _BT_OBJECT_LOGGING_ENABLED
+       BT_LOGT("Setting object's parent: addr=%p, parent-addr=%p",
                child, parent);
 #endif
 
@@ -140,10 +152,10 @@ void bt_object_set_parent(struct bt_object *child, struct bt_object *parent)
        if (parent) {
                BT_ASSERT(!child->parent);
                child->parent = parent;
-               bt_object_get_no_null_check(parent);
+               bt_object_get_ref_no_null_check(parent);
        } else {
                if (child->parent) {
-                       bt_object_put_no_null_check(child->parent);
+                       bt_object_put_ref_no_null_check(child->parent);
                }
 
                child->parent = NULL;
@@ -173,8 +185,8 @@ void bt_object_with_parent_release_func(struct bt_object *obj)
                 */
                struct bt_object *parent = obj->parent;
 
-#ifdef BT_LOGV
-               BT_LOGV("Releasing parented object: addr=%p, ref-count=%llu, "
+#ifdef _BT_OBJECT_LOGGING_ENABLED
+               BT_LOGT("Releasing parented object: addr=%p, ref-count=%llu, "
                        "parent-addr=%p, parent-ref-count=%llu",
                        obj, obj->ref_count,
                        parent, parent->ref_count);
@@ -191,7 +203,7 @@ void bt_object_with_parent_release_func(struct bt_object *obj)
                }
 
                /* The release function will be invoked by the parent. */
-               bt_object_put_no_null_check(parent);
+               bt_object_put_ref_no_null_check(parent);
        } else {
                bt_object_try_spec_release(obj);
        }
@@ -256,15 +268,15 @@ void bt_object_inc_ref_count(const struct bt_object *c_obj)
 }
 
 static inline
-void bt_object_get_no_null_check_no_parent_check(const struct bt_object *c_obj)
+void bt_object_get_ref_no_null_check_no_parent_check(const struct bt_object *c_obj)
 {
        struct bt_object *obj = (void *) c_obj;
 
        BT_ASSERT(obj);
        BT_ASSERT(obj->is_shared);
 
-#ifdef BT_LOGV
-       BT_LOGV("Incrementing object's reference count: %llu -> %llu: "
+#ifdef _BT_OBJECT_LOGGING_ENABLED
+       BT_LOGT("Incrementing object's reference count: %llu -> %llu: "
                "addr=%p, cur-count=%llu, new-count=%llu",
                obj->ref_count, obj->ref_count + 1,
                obj, obj->ref_count, obj->ref_count + 1);
@@ -274,7 +286,7 @@ void bt_object_get_no_null_check_no_parent_check(const struct bt_object *c_obj)
 }
 
 static inline
-void bt_object_get_no_null_check(const void *c_obj)
+void bt_object_get_ref_no_null_check(const void *c_obj)
 {
        struct bt_object *obj = (void *) c_obj;
 
@@ -282,16 +294,16 @@ void bt_object_get_no_null_check(const void *c_obj)
        BT_ASSERT(obj->is_shared);
 
        if (G_UNLIKELY(obj->parent && bt_object_get_ref_count(obj) == 0)) {
-#ifdef BT_LOGV
-               BT_LOGV("Incrementing object's parent's reference count: "
+#ifdef _BT_OBJECT_LOGGING_ENABLED
+               BT_LOGT("Incrementing object's parent's reference count: "
                        "addr=%p, parent-addr=%p", obj, obj->parent);
 #endif
 
-               bt_object_get_no_null_check(obj->parent);
+               bt_object_get_ref_no_null_check(obj->parent);
        }
 
-#ifdef BT_LOGV
-       BT_LOGV("Incrementing object's reference count: %llu -> %llu: "
+#ifdef _BT_OBJECT_LOGGING_ENABLED
+       BT_LOGT("Incrementing object's reference count: %llu -> %llu: "
                "addr=%p, cur-count=%llu, new-count=%llu",
                obj->ref_count, obj->ref_count + 1,
                obj, obj->ref_count, obj->ref_count + 1);
@@ -301,7 +313,7 @@ void bt_object_get_no_null_check(const void *c_obj)
 }
 
 static inline
-void bt_object_put_no_null_check(const void *c_obj)
+void bt_object_put_ref_no_null_check(const void *c_obj)
 {
        struct bt_object *obj = (void *) c_obj;
 
@@ -309,8 +321,8 @@ void bt_object_put_no_null_check(const void *c_obj)
        BT_ASSERT(obj->is_shared);
        BT_ASSERT(obj->ref_count > 0);
 
-#ifdef BT_LOGV
-       BT_LOGV("Decrementing object's reference count: %llu -> %llu: "
+#ifdef _BT_OBJECT_LOGGING_ENABLED
+       BT_LOGT("Decrementing object's reference count: %llu -> %llu: "
                "addr=%p, cur-count=%llu, new-count=%llu",
                obj->ref_count, obj->ref_count - 1,
                obj, obj->ref_count, obj->ref_count - 1);
@@ -333,11 +345,11 @@ void bt_object_get_ref(const void *ptr)
                return;
        }
 
-#ifdef BT_ASSERT_PRE
-       BT_ASSERT_PRE(obj->is_shared, "Object is not shared: %!+O", obj);
+#ifdef BT_ASSERT_PRE_DEV
+       BT_ASSERT_PRE_DEV(obj->is_shared, "Object is not shared: %!+O", obj);
 #endif
 
-       bt_object_get_no_null_check(obj);
+       bt_object_get_ref_no_null_check(obj);
 }
 
 static inline
@@ -349,13 +361,13 @@ void bt_object_put_ref(const void *ptr)
                return;
        }
 
-#ifdef BT_ASSERT_PRE
-       BT_ASSERT_PRE(obj->is_shared, "Object is not shared: %!+O", obj);
-       BT_ASSERT_PRE(bt_object_get_ref_count(obj) > 0,
+#ifdef BT_ASSERT_PRE_DEV
+       BT_ASSERT_PRE_DEV(obj->is_shared, "Object is not shared: %!+O", obj);
+       BT_ASSERT_PRE_DEV(bt_object_get_ref_count(obj) > 0,
                "Decrementing a reference count set to 0: %!+O", ptr);
 #endif
 
-       bt_object_put_no_null_check(obj);
+       bt_object_put_ref_no_null_check(obj);
 }
 
 #define BT_OBJECT_PUT_REF_AND_RESET(_var)      \