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

#ifndef BABELTRACE_OBJECT_INTERNAL_H
#define BABELTRACE_OBJECT_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * 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.
 */

#include "common/macros.h"
#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 *);
typedef void (*bt_object_parent_is_owner_listener_func)(
		struct bt_object *);

static inline
void bt_object_get_ref_no_null_check(const void *obj);

static inline
void bt_object_put_ref_no_null_check(const void *obj);

/*
 * Babeltrace object base.
 *
 * All objects publicly exposed by Babeltrace APIs must contain this
 * object as their first member.
 */
struct bt_object {
	/*
	 * True if this object is shared, that is, it has a reference
	 * count.
	 */
	bool is_shared;

	/*
	 * Current reference count.
	 */
	unsigned long long ref_count;

	/*
	 * Release function called when the object's reference count
	 * falls to zero. For an object with a parent, this function is
	 * bt_object_with_parent_release_func(), which calls
	 * `spec_release_func` below if there's no current parent.
	 */
	bt_object_release_func release_func;

	/*
	 * Specific release function called by
	 * bt_object_with_parent_release_func() or directly by a
	 * parent object.
	 */
	bt_object_release_func spec_release_func;

	/*
	 * Optional callback for an object with a parent, called by
	 * bt_object_with_parent_release_func() to indicate to the
	 * object that its parent is its owner.
	 */
	bt_object_parent_is_owner_listener_func
		parent_is_owner_listener_func;

	/*
	 * Optional parent object.
	 */
	struct bt_object *parent;
};

static inline
unsigned long long bt_object_get_ref_count(const struct bt_object *c_obj)
{
	struct bt_object *obj = (void *) c_obj;

	BT_ASSERT_DBG(obj);
	BT_ASSERT_DBG(obj->is_shared);
	return obj->ref_count;
}

static inline
struct bt_object *bt_object_borrow_parent(const struct bt_object *c_obj)
{
	struct bt_object *obj = (void *) c_obj;

	BT_ASSERT_DBG(obj);
	BT_ASSERT_DBG(obj->is_shared);
	return obj->parent;
}

static inline
struct bt_object *bt_object_get_parent(const struct bt_object *c_obj)
{
	struct bt_object *obj = (void *) c_obj;
	struct bt_object *parent = bt_object_borrow_parent(obj);

	if (parent) {
		bt_object_get_ref_no_null_check(parent);
	}

	return parent;
}

static inline
void bt_object_set_parent(struct bt_object *child, struct bt_object *parent)
{
	BT_ASSERT_DBG(child);
	BT_ASSERT_DBG(child->is_shared);

#ifdef _BT_OBJECT_LOGGING_ENABLED
	BT_LOGT("Setting object's parent: addr=%p, parent-addr=%p",
		child, parent);
#endif

	/*
	 * It is assumed that a "child" having a parent is publicly
	 * reachable. Therefore, a reference to its parent must be
	 * taken. The reference to the parent will be released once the
	 * object's reference count falls to zero.
	 */
	if (parent) {
		BT_ASSERT_DBG(!child->parent);
		child->parent = parent;
		bt_object_get_ref_no_null_check(parent);
	} else {
		if (child->parent) {
			bt_object_put_ref_no_null_check(child->parent);
		}

		child->parent = NULL;
	}
}

static inline
void bt_object_try_spec_release(struct bt_object *obj)
{
	BT_ASSERT_DBG(obj);
	BT_ASSERT_DBG(obj->is_shared);
	BT_ASSERT_DBG(obj->spec_release_func);

	if (bt_object_get_ref_count(obj) == 0) {
		obj->spec_release_func(obj);
	}
}

static inline
void bt_object_with_parent_release_func(struct bt_object *obj)
{
	if (obj->parent) {
		/*
		 * Keep our own copy of the parent address because `obj`
		 * could be destroyed in
		 * obj->parent_is_owner_listener_func().
		 */
		struct bt_object *parent = obj->parent;

#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);
#endif

		if (obj->parent_is_owner_listener_func) {
			/*
			 * Object has a chance to destroy itself here
			 * under certain conditions and notify its
			 * parent. At this point the parent is
			 * guaranteed to exist because it's not put yet.
			 */
			obj->parent_is_owner_listener_func(obj);
		}

		/* The release function will be invoked by the parent. */
		bt_object_put_ref_no_null_check(parent);
	} else {
		bt_object_try_spec_release(obj);
	}
}

static inline
void bt_object_init(struct bt_object *obj, bool is_shared,
		bt_object_release_func release_func)
{
	BT_ASSERT_DBG(obj);
	BT_ASSERT_DBG(!is_shared || release_func);
	obj->is_shared = is_shared;
	obj->release_func = release_func;
	obj->parent_is_owner_listener_func = NULL;
	obj->spec_release_func = NULL;
	obj->parent = NULL;
	obj->ref_count = 1;
}

static inline
void bt_object_init_shared(struct bt_object *obj,
		bt_object_release_func release_func)
{
	bt_object_init(obj, true, release_func);
}

static inline
void bt_object_init_unique(struct bt_object *obj)
{
	bt_object_init(obj, false, NULL);
}

static inline
void bt_object_init_shared_with_parent(struct bt_object *obj,
		bt_object_release_func spec_release_func)
{
	BT_ASSERT_DBG(obj);
	BT_ASSERT_DBG(spec_release_func);
	bt_object_init_shared(obj, bt_object_with_parent_release_func);
	obj->spec_release_func = spec_release_func;
}

static inline
void bt_object_set_parent_is_owner_listener_func(struct bt_object *obj,
		bt_object_parent_is_owner_listener_func func)
{
	BT_ASSERT_DBG(obj);
	BT_ASSERT_DBG(obj->is_shared);
	BT_ASSERT_DBG(obj->spec_release_func);
	((struct bt_object *) obj)->parent_is_owner_listener_func = func;
}

static inline
void bt_object_inc_ref_count(const struct bt_object *c_obj)
{
	struct bt_object *obj = (void *) c_obj;

	BT_ASSERT_DBG(obj);
	BT_ASSERT_DBG(obj->is_shared);
	obj->ref_count++;
	BT_ASSERT_DBG(obj->ref_count != 0);
}

static inline
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_DBG(obj);
	BT_ASSERT_DBG(obj->is_shared);

#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);
#endif

	bt_object_inc_ref_count(obj);
}

static inline
void bt_object_get_ref_no_null_check(const void *c_obj)
{
	struct bt_object *obj = (void *) c_obj;

	BT_ASSERT_DBG(obj);
	BT_ASSERT_DBG(obj->is_shared);

	if (G_UNLIKELY(obj->parent && bt_object_get_ref_count(obj) == 0)) {
#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_ref_no_null_check(obj->parent);
	}

#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);
#endif

	bt_object_inc_ref_count(obj);
}

static inline
void bt_object_put_ref_no_null_check(const void *c_obj)
{
	struct bt_object *obj = (void *) c_obj;

	BT_ASSERT_DBG(obj);
	BT_ASSERT_DBG(obj->is_shared);
	BT_ASSERT_DBG(obj->ref_count > 0);

#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);
#endif

	obj->ref_count--;

	if (obj->ref_count == 0) {
		BT_ASSERT_DBG(obj->release_func);
		obj->release_func(obj);
	}
}

static inline
void bt_object_get_ref(const void *ptr)
{
	struct bt_object *obj = (void *) ptr;

	if (G_UNLIKELY(!obj)) {
		return;
	}

#ifdef BT_ASSERT_PRE_DEV
	BT_ASSERT_PRE_DEV(obj->is_shared, "Object is not shared: %!+O", obj);
#endif

	bt_object_get_ref_no_null_check(obj);
}

static inline
void bt_object_put_ref(const void *ptr)
{
	struct bt_object *obj = (void *) ptr;

	if (G_UNLIKELY(!obj)) {
		return;
	}

#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_ref_no_null_check(obj);
}

#define BT_OBJECT_PUT_REF_AND_RESET(_var)	\
	do {					\
		bt_object_put_ref(_var);	\
		(_var) = NULL;			\
	} while (0)

#define BT_OBJECT_MOVE_REF(_var_dst, _var_src)	\
	do {					\
		bt_object_put_ref(_var_dst);	\
		(_var_dst) = (_var_src);	\
		(_var_src) = NULL;		\
	} while (0)

#endif /* BABELTRACE_OBJECT_INTERNAL_H */
Commit	Line	Data
83509119 JG	1	#ifndef BABELTRACE_OBJECT_INTERNAL_H
83509119 JG	2	#define BABELTRACE_OBJECT_INTERNAL_H
273b65be JG	3
273b65be JG	4	/*
f2b0325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
83509119	6	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be JG	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*/
	26
85e7137b	27	#include "common/macros.h"
57952005	28	#include "common/assert.h"
a6918753	29	#include <stdbool.h>
273b65be	30
829b3694 PP	31	/*
	32	* Some parts of the Babeltrace project use this internal library header
	33	* for internal reference counting. Until we make this header generic
	34	* for the whole project, make it possible to disable logging in this
	35	* file by defining `BT_OBJECT_DONT_LOG` because it's possible that the
c9ecaa78	36	* BT_LOGT() statements here won't find the log level
829b3694 PP	37	* (`BT_LOG_OUTPUT_LEVEL`).
829b3694 PP	38	*/
c9ecaa78	39	#if defined(BT_LOGT) && !defined(BT_OBJECT_DONT_LOG)
829b3694 PP	40	# define _BT_OBJECT_LOGGING_ENABLED
	41	#endif
	42
1d7bf349 PP	43	struct bt_object;
	44
	45	typedef void (bt_object_release_func)(struct bt_object );
	46	typedef void (*bt_object_parent_is_owner_listener_func)(
	47	struct bt_object *);
	48
	49	static inline
864aa43f	50	void bt_object_get_ref_no_null_check(const void *obj);
1d7bf349 PP	51
1d7bf349 PP	52	static inline
864aa43f	53	void bt_object_put_ref_no_null_check(const void *obj);
1d7bf349 PP	54
	55	/*
	56	* Babeltrace object base.
	57	*
	58	* All objects publicly exposed by Babeltrace APIs must contain this
	59	* object as their first member.
de3dd40e	60	*/
83509119	61	struct bt_object {
a6918753	62	/*
1d7bf349 PP	63	* True if this object is shared, that is, it has a reference
1d7bf349 PP	64	* count.
a6918753 PP	65	*/
a6918753 PP	66	bool is_shared;
1d7bf349 PP	67
	68	/*
	69	* Current reference count.
	70	*/
	71	unsigned long long ref_count;
	72
	73	/*
	74	* Release function called when the object's reference count
	75	* falls to zero. For an object with a parent, this function is
	76	* bt_object_with_parent_release_func(), which calls
	77	* `spec_release_func` below if there's no current parent.
	78	*/
	79	bt_object_release_func release_func;
	80
	81	/*
	82	* Specific release function called by
	83	* bt_object_with_parent_release_func() or directly by a
	84	* parent object.
	85	*/
	86	bt_object_release_func spec_release_func;
	87
	88	/*
	89	* Optional callback for an object with a parent, called by
	90	* bt_object_with_parent_release_func() to indicate to the
	91	* object that its parent is its owner.
	92	*/
	93	bt_object_parent_is_owner_listener_func
	94	parent_is_owner_listener_func;
	95
	96	/*
	97	* Optional parent object.
	98	*/
	99	struct bt_object *parent;
273b65be JG	100	};
	101
	102	static inline
4b70020d	103	unsigned long long bt_object_get_ref_count(const struct bt_object *c_obj)
7c56f3cc	104	{
4b70020d PP	105	struct bt_object obj = (void ) c_obj;
4b70020d PP	106
ec4a3354 PP	107	BT_ASSERT_DBG(obj);
ec4a3354 PP	108	BT_ASSERT_DBG(obj->is_shared);
1d7bf349 PP	109	return obj->ref_count;
1d7bf349 PP	110	}
5d2d9981	111
1d7bf349	112	static inline
4b70020d	113	struct bt_object bt_object_borrow_parent(const struct bt_object c_obj)
1d7bf349	114	{
4b70020d PP	115	struct bt_object obj = (void ) c_obj;
4b70020d PP	116
ec4a3354 PP	117	BT_ASSERT_DBG(obj);
ec4a3354 PP	118	BT_ASSERT_DBG(obj->is_shared);
1d7bf349	119	return obj->parent;
7c56f3cc MD	120	}
	121
	122	static inline
4b70020d	123	struct bt_object bt_object_get_parent(const struct bt_object c_obj)
5d2d9981	124	{
4b70020d	125	struct bt_object obj = (void ) c_obj;
1d7bf349 PP	126	struct bt_object *parent = bt_object_borrow_parent(obj);
	127
	128	if (parent) {
864aa43f	129	bt_object_get_ref_no_null_check(parent);
1d7bf349 PP	130	}
	131
	132	return parent;
	133	}
	134
	135	static inline
	136	void bt_object_set_parent(struct bt_object child, struct bt_object parent)
	137	{
ec4a3354 PP	138	BT_ASSERT_DBG(child);
ec4a3354 PP	139	BT_ASSERT_DBG(child->is_shared);
5d2d9981	140
829b3694	141	#ifdef _BT_OBJECT_LOGGING_ENABLED
c9ecaa78	142	BT_LOGT("Setting object's parent: addr=%p, parent-addr=%p",
1d7bf349	143	child, parent);
0f5e83e5 PP	144	#endif
0f5e83e5 PP	145
1d7bf349 PP	146	/*
	147	* It is assumed that a "child" having a parent is publicly
	148	* reachable. Therefore, a reference to its parent must be
	149	* taken. The reference to the parent will be released once the
	150	* object's reference count falls to zero.
	151	*/
	152	if (parent) {
ec4a3354	153	BT_ASSERT_DBG(!child->parent);
1d7bf349	154	child->parent = parent;
864aa43f	155	bt_object_get_ref_no_null_check(parent);
1d7bf349 PP	156	} else {
1d7bf349 PP	157	if (child->parent) {
864aa43f	158	bt_object_put_ref_no_null_check(child->parent);
1d7bf349 PP	159	}
	160
	161	child->parent = NULL;
5d2d9981 JG	162	}
	163	}
	164
7c56f3cc	165	static inline
1d7bf349 PP	166	void bt_object_try_spec_release(struct bt_object *obj)
1d7bf349 PP	167	{
ec4a3354 PP	168	BT_ASSERT_DBG(obj);
	169	BT_ASSERT_DBG(obj->is_shared);
	170	BT_ASSERT_DBG(obj->spec_release_func);
1d7bf349 PP	171
	172	if (bt_object_get_ref_count(obj) == 0) {
	173	obj->spec_release_func(obj);
	174	}
	175	}
	176
	177	static inline
	178	void bt_object_with_parent_release_func(struct bt_object *obj)
5d2d9981 JG	179	{
5d2d9981 JG	180	if (obj->parent) {
1d7bf349 PP	181	/*
	182	* Keep our own copy of the parent address because `obj`
	183	* could be destroyed in
	184	* obj->parent_is_owner_listener_func().
	185	*/
0f5e83e5 PP	186	struct bt_object *parent = obj->parent;
0f5e83e5 PP	187
829b3694	188	#ifdef _BT_OBJECT_LOGGING_ENABLED
c9ecaa78	189	BT_LOGT("Releasing parented object: addr=%p, ref-count=%llu, "
1d7bf349 PP	190	"parent-addr=%p, parent-ref-count=%llu",
	191	obj, obj->ref_count,
	192	parent, parent->ref_count);
0f5e83e5	193	#endif
f167d3c0	194
1d7bf349	195	if (obj->parent_is_owner_listener_func) {
f167d3c0 PP	196	/*
	197	* Object has a chance to destroy itself here
	198	* under certain conditions and notify its
	199	* parent. At this point the parent is
	200	* guaranteed to exist because it's not put yet.
	201	*/
1d7bf349	202	obj->parent_is_owner_listener_func(obj);
f167d3c0 PP	203	}
f167d3c0 PP	204
5d2d9981	205	/* The release function will be invoked by the parent. */
864aa43f	206	bt_object_put_ref_no_null_check(parent);
5d2d9981	207	} else {
1d7bf349	208	bt_object_try_spec_release(obj);
5d2d9981 JG	209	}
	210	}
	211
	212	static inline
1d7bf349 PP	213	void bt_object_init(struct bt_object *obj, bool is_shared,
1d7bf349 PP	214	bt_object_release_func release_func)
5d2d9981	215	{
ec4a3354 PP	216	BT_ASSERT_DBG(obj);
ec4a3354 PP	217	BT_ASSERT_DBG(!is_shared \|\| release_func);
1d7bf349 PP	218	obj->is_shared = is_shared;
	219	obj->release_func = release_func;
	220	obj->parent_is_owner_listener_func = NULL;
	221	obj->spec_release_func = NULL;
	222	obj->parent = NULL;
	223	obj->ref_count = 1;
dc3fffef PP	224	}
	225
	226	static inline
1d7bf349 PP	227	void bt_object_init_shared(struct bt_object *obj,
1d7bf349 PP	228	bt_object_release_func release_func)
dc3fffef	229	{
1d7bf349	230	bt_object_init(obj, true, release_func);
5d2d9981 JG	231	}
	232
	233	static inline
1d7bf349	234	void bt_object_init_unique(struct bt_object *obj)
273b65be	235	{
1d7bf349 PP	236	bt_object_init(obj, false, NULL);
1d7bf349 PP	237	}
5d2d9981	238
1d7bf349 PP	239	static inline
	240	void bt_object_init_shared_with_parent(struct bt_object *obj,
	241	bt_object_release_func spec_release_func)
	242	{
ec4a3354 PP	243	BT_ASSERT_DBG(obj);
ec4a3354 PP	244	BT_ASSERT_DBG(spec_release_func);
1d7bf349 PP	245	bt_object_init_shared(obj, bt_object_with_parent_release_func);
	246	obj->spec_release_func = spec_release_func;
	247	}
0f5e83e5	248
1d7bf349 PP	249	static inline
	250	void bt_object_set_parent_is_owner_listener_func(struct bt_object *obj,
	251	bt_object_parent_is_owner_listener_func func)
	252	{
ec4a3354 PP	253	BT_ASSERT_DBG(obj);
	254	BT_ASSERT_DBG(obj->is_shared);
	255	BT_ASSERT_DBG(obj->spec_release_func);
1d7bf349	256	((struct bt_object *) obj)->parent_is_owner_listener_func = func;
5d2d9981 JG	257	}
5d2d9981 JG	258
a6918753	259	static inline
4b70020d	260	void bt_object_inc_ref_count(const struct bt_object *c_obj)
a6918753	261	{
4b70020d PP	262	struct bt_object obj = (void ) c_obj;
4b70020d PP	263
ec4a3354 PP	264	BT_ASSERT_DBG(obj);
ec4a3354 PP	265	BT_ASSERT_DBG(obj->is_shared);
1d7bf349	266	obj->ref_count++;
ec4a3354	267	BT_ASSERT_DBG(obj->ref_count != 0);
a6918753 PP	268	}
a6918753 PP	269
c5a24b0a	270	static inline
864aa43f	271	void bt_object_get_ref_no_null_check_no_parent_check(const struct bt_object *c_obj)
c5a24b0a	272	{
4b70020d PP	273	struct bt_object obj = (void ) c_obj;
4b70020d PP	274
ec4a3354 PP	275	BT_ASSERT_DBG(obj);
ec4a3354 PP	276	BT_ASSERT_DBG(obj->is_shared);
c5a24b0a	277
829b3694	278	#ifdef _BT_OBJECT_LOGGING_ENABLED
c9ecaa78	279	BT_LOGT("Incrementing object's reference count: %llu -> %llu: "
c5a24b0a PP	280	"addr=%p, cur-count=%llu, new-count=%llu",
	281	obj->ref_count, obj->ref_count + 1,
	282	obj, obj->ref_count, obj->ref_count + 1);
	283	#endif
	284
	285	bt_object_inc_ref_count(obj);
	286	}
	287
5d2d9981	288	static inline
864aa43f	289	void bt_object_get_ref_no_null_check(const void *c_obj)
5d2d9981	290	{
4b70020d PP	291	struct bt_object obj = (void ) c_obj;
4b70020d PP	292
ec4a3354 PP	293	BT_ASSERT_DBG(obj);
ec4a3354 PP	294	BT_ASSERT_DBG(obj->is_shared);
5d2d9981	295
85e7137b	296	if (G_UNLIKELY(obj->parent && bt_object_get_ref_count(obj) == 0)) {
829b3694	297	#ifdef _BT_OBJECT_LOGGING_ENABLED
c9ecaa78	298	BT_LOGT("Incrementing object's parent's reference count: "
1d7bf349 PP	299	"addr=%p, parent-addr=%p", obj, obj->parent);
	300	#endif
	301
864aa43f	302	bt_object_get_ref_no_null_check(obj->parent);
1d7bf349 PP	303	}
1d7bf349 PP	304
829b3694	305	#ifdef _BT_OBJECT_LOGGING_ENABLED
c9ecaa78	306	BT_LOGT("Incrementing object's reference count: %llu -> %llu: "
1d7bf349 PP	307	"addr=%p, cur-count=%llu, new-count=%llu",
	308	obj->ref_count, obj->ref_count + 1,
	309	obj, obj->ref_count, obj->ref_count + 1);
	310	#endif
	311
	312	bt_object_inc_ref_count(obj);
273b65be JG	313	}
273b65be JG	314
f167d3c0	315	static inline
864aa43f	316	void bt_object_put_ref_no_null_check(const void *c_obj)
f167d3c0	317	{
4b70020d PP	318	struct bt_object obj = (void ) c_obj;
4b70020d PP	319
ec4a3354 PP	320	BT_ASSERT_DBG(obj);
	321	BT_ASSERT_DBG(obj->is_shared);
	322	BT_ASSERT_DBG(obj->ref_count > 0);
1d7bf349	323
829b3694	324	#ifdef _BT_OBJECT_LOGGING_ENABLED
c9ecaa78	325	BT_LOGT("Decrementing object's reference count: %llu -> %llu: "
1d7bf349 PP	326	"addr=%p, cur-count=%llu, new-count=%llu",
	327	obj->ref_count, obj->ref_count - 1,
	328	obj, obj->ref_count, obj->ref_count - 1);
	329	#endif
	330
	331	obj->ref_count--;
	332
	333	if (obj->ref_count == 0) {
ec4a3354	334	BT_ASSERT_DBG(obj->release_func);
1d7bf349 PP	335	obj->release_func(obj);
1d7bf349 PP	336	}
f167d3c0 PP	337	}
f167d3c0 PP	338
8c6884d9 PP	339	static inline
	340	void bt_object_get_ref(const void *ptr)
	341	{
	342	struct bt_object obj = (void ) ptr;
	343
85e7137b	344	if (G_UNLIKELY(!obj)) {
8c6884d9 PP	345	return;
	346	}
	347
fa6cfec3 PP	348	#ifdef BT_ASSERT_PRE_DEV
fa6cfec3 PP	349	BT_ASSERT_PRE_DEV(obj->is_shared, "Object is not shared: %!+O", obj);
8c6884d9 PP	350	#endif
8c6884d9 PP	351
864aa43f	352	bt_object_get_ref_no_null_check(obj);
8c6884d9 PP	353	}
	354
	355	static inline
	356	void bt_object_put_ref(const void *ptr)
	357	{
	358	struct bt_object obj = (void ) ptr;
	359
85e7137b	360	if (G_UNLIKELY(!obj)) {
8c6884d9 PP	361	return;
	362	}
	363
fa6cfec3 PP	364	#ifdef BT_ASSERT_PRE_DEV
	365	BT_ASSERT_PRE_DEV(obj->is_shared, "Object is not shared: %!+O", obj);
	366	BT_ASSERT_PRE_DEV(bt_object_get_ref_count(obj) > 0,
8c6884d9 PP	367	"Decrementing a reference count set to 0: %!+O", ptr);
	368	#endif
	369
864aa43f	370	bt_object_put_ref_no_null_check(obj);
8c6884d9 PP	371	}
	372
	373	#define BT_OBJECT_PUT_REF_AND_RESET(_var) \
	374	do { \
	375	bt_object_put_ref(_var); \
	376	(_var) = NULL; \
	377	} while (0)
	378
	379	#define BT_OBJECT_MOVE_REF(_var_dst, _var_src) \
	380	do { \
	381	bt_object_put_ref(_var_dst); \
	382	(_var_dst) = (_var_src); \
	383	(_var_src) = NULL; \
	384	} while (0)
	385
83509119	386	#endif /* BABELTRACE_OBJECT_INTERNAL_H */