PJPROJECT logging: Made easier to get available logging levels.
[asterisk/asterisk.git] / main / named_locks.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2016, Fairview 5 Engineering, LLC
5  *
6  * George Joseph <george.joseph@fairview5.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Named Locks
22  *
23  * \author George Joseph <george.joseph@fairview5.com>
24  */
25
26 #include "asterisk.h"
27
28 #include "asterisk/_private.h"
29 #include "asterisk/astobj2.h"
30 #include "asterisk/named_locks.h"
31 #include "asterisk/utils.h"
32
33 struct ao2_container *named_locks;
34 #define NAMED_LOCKS_BUCKETS 101
35
36 struct named_lock_proxy {
37         AO2_WEAKPROXY();
38         char key[0];
39 };
40
41 struct ast_named_lock {
42 };
43
44 static int named_locks_hash(const void *obj, const int flags)
45 {
46         const struct named_lock_proxy *lock = obj;
47
48         switch (flags & OBJ_SEARCH_MASK) {
49         case OBJ_SEARCH_KEY:
50                 return ast_str_hash(obj);
51         case OBJ_SEARCH_OBJECT:
52                 return ast_str_hash(lock->key);
53         default:
54                 /* Hash can only work on something with a full key. */
55                 ast_assert(0);
56                 return 0;
57         }
58 }
59
60 static int named_locks_cmp(void *obj_left, void *obj_right, int flags)
61 {
62         const struct named_lock_proxy *object_left = obj_left;
63         const struct named_lock_proxy *object_right = obj_right;
64         const char *right_key = obj_right;
65         int cmp;
66
67         switch (flags & OBJ_SEARCH_MASK) {
68         case OBJ_SEARCH_OBJECT:
69                 right_key = object_right->key;
70                 /* Fall through */
71         case OBJ_SEARCH_KEY:
72                 cmp = strcmp(object_left->key, right_key);
73                 break;
74         case OBJ_SEARCH_PARTIAL_KEY:
75                 cmp = strncmp(object_left->key, right_key, strlen(right_key));
76                 break;
77         default:
78                 cmp = 0;
79                 break;
80         }
81
82         return cmp ? 0 : CMP_MATCH;
83 }
84
85 static void named_locks_shutdown(void)
86 {
87         ao2_cleanup(named_locks);
88 }
89
90 int ast_named_locks_init(void)
91 {
92         named_locks = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0,
93                 NAMED_LOCKS_BUCKETS, named_locks_hash, NULL, named_locks_cmp);
94         if (!named_locks) {
95                 return -1;
96         }
97
98         ast_register_cleanup(named_locks_shutdown);
99
100         return 0;
101 }
102
103 static void named_lock_proxy_cb(void *weakproxy, void *data)
104 {
105         ao2_unlink(named_locks, weakproxy);
106 }
107
108 struct ast_named_lock *__ast_named_lock_get(const char *filename, int lineno, const char *func,
109         enum ast_named_lock_type lock_type, const char *keyspace, const char *key)
110 {
111         struct named_lock_proxy *proxy = NULL;
112         struct ast_named_lock *lock = NULL;
113         int keylen = strlen(keyspace) + strlen(key) + 2;
114         char *concat_key = ast_alloca(keylen);
115
116         sprintf(concat_key, "%s-%s", keyspace, key); /* Safe */
117
118         ao2_lock(named_locks);
119         proxy = ao2_find(named_locks, concat_key, OBJ_SEARCH_KEY | OBJ_NOLOCK);
120         if (proxy) {
121                 ao2_unlock(named_locks);
122                 lock = __ao2_weakproxy_get_object(proxy, 0, __PRETTY_FUNCTION__, filename, lineno, func);
123
124                 if (lock) {
125                         /* We have an existing lock and it's not being destroyed. */
126                         ao2_ref(proxy, -1);
127                         ast_assert((ao2_options_get(lock) & AO2_ALLOC_OPT_LOCK_MASK) == lock_type);
128
129                         return lock;
130                 }
131
132                 /* the old proxy is being destroyed, clean list before creating/adding new one */
133                 ao2_lock(named_locks);
134                 ao2_unlink_flags(named_locks, proxy, OBJ_NOLOCK);
135                 ao2_ref(proxy, -1);
136         }
137
138         proxy = ao2_t_weakproxy_alloc(sizeof(*proxy) + keylen, NULL, concat_key);
139         if (!proxy) {
140                 goto failure_cleanup;
141         }
142
143         lock = __ao2_alloc(sizeof(*lock) + keylen, NULL, lock_type, concat_key, filename, lineno, func);
144         if (!lock) {
145                 goto failure_cleanup;
146         }
147
148         /* We have exclusive access to proxy and lock, no need for locking here. */
149         if (ao2_weakproxy_set_object(proxy, lock, OBJ_NOLOCK)) {
150                 goto failure_cleanup;
151         }
152
153         if (ao2_weakproxy_subscribe(proxy, named_lock_proxy_cb, NULL, OBJ_NOLOCK)) {
154                 goto failure_cleanup;
155         }
156
157         strcpy(proxy->key, concat_key); /* Safe */
158         ao2_link_flags(named_locks, proxy, OBJ_NOLOCK);
159         ao2_unlock(named_locks);
160         ao2_t_ref(proxy, -1, "Release allocation reference");
161
162         return lock;
163
164 failure_cleanup:
165         ao2_unlock(named_locks);
166
167         ao2_cleanup(proxy);
168         ao2_cleanup(lock);
169
170         return NULL;
171 }