aboutsummaryrefslogtreecommitdiffstats
path: root/src/libutil/ref.h
blob: 2a3fd8db2aa5b60202eb2165536cab0ad38923ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*-
 * Copyright 2016 Vsevolod Stakhov
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef REF_H_
#define REF_H_

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif


/**
 * @file ref.h
 * A set of macros to handle refcounts
 */

typedef void (*ref_dtor_cb_t)(void *data);

typedef struct ref_entry_s {
	unsigned int refcount;
	ref_dtor_cb_t dtor;
} ref_entry_t;

#define REF_INIT(obj, dtor_cb)                           \
	do {                                                 \
		if ((obj) != NULL) {                             \
			(obj)->ref.refcount = 0;                     \
			(obj)->ref.dtor = (ref_dtor_cb_t) (dtor_cb); \
		}                                                \
	} while (0)

#define REF_INIT_RETAIN(obj, dtor_cb)                    \
	do {                                                 \
		if ((obj) != NULL) {                             \
			(obj)->ref.refcount = 1;                     \
			(obj)->ref.dtor = (ref_dtor_cb_t) (dtor_cb); \
		}                                                \
	} while (0)

#ifdef HAVE_ATOMIC_BUILTINS
#define REF_RETAIN_ATOMIC(obj)                                             \
	do {                                                                   \
		if ((obj) != NULL) {                                               \
			__atomic_add_fetch(&(obj)->ref.refcount, 1, __ATOMIC_RELEASE); \
		}                                                                  \
	} while (0)

#define REF_RELEASE_ATOMIC(obj)                                                                    \
	do {                                                                                           \
		if ((obj) != NULL) {                                                                       \
			unsigned int _rc_priv = __atomic_sub_fetch(&(obj)->ref.refcount, 1, __ATOMIC_ACQ_REL); \
			if (_rc_priv == 0 && (obj)->ref.dtor) {                                                \
				(obj)->ref.dtor(obj);                                                              \
			}                                                                                      \
		}                                                                                          \
	} while (0)

#else
#define REF_RETAIN_ATOMIC REF_RETAIN
#define REF_RELEASE_ATOMIC REF_RELEASE_ATOMIC
#endif

#define REF_RETAIN(obj)            \
	do {                           \
		if ((obj) != NULL) {       \
			(obj)->ref.refcount++; \
		}                          \
	} while (0)

#define REF_RELEASE(obj)                                         \
	do {                                                         \
		if ((obj) != NULL) {                                     \
			if (--(obj)->ref.refcount == 0 && (obj)->ref.dtor) { \
				(obj)->ref.dtor(obj);                            \
			}                                                    \
		}                                                        \
	} while (0)

#endif /* REF_H_ */