This patch adds a new message bus API to Asterisk.
[asterisk/asterisk.git] / main / stasis_cache.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.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 Stasis Message API.
22  *
23  * \author David M. Lee, II <dlee@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/astobj2.h"
35 #include "asterisk/hashtab.h"
36 #include "asterisk/stasis.h"
37 #include "asterisk/utils.h"
38
39 #ifdef LOW_MEMORY
40 #define NUM_CACHE_BUCKETS 17
41 #else
42 #define NUM_CACHE_BUCKETS 563
43 #endif
44
45 struct stasis_caching_topic {
46         struct ao2_container *cache;
47         struct stasis_topic *topic;
48         struct stasis_subscription *sub;
49         snapshot_get_id id_fn;
50 };
51
52 static void stasis_caching_topic_dtor(void *obj) {
53         struct stasis_caching_topic *caching_topic = obj;
54         ast_assert(!stasis_subscription_is_subscribed(caching_topic->sub));
55         caching_topic->sub = NULL;
56         ao2_cleanup(caching_topic->cache);
57         caching_topic->cache = NULL;
58         ao2_cleanup(caching_topic->topic);
59         caching_topic->topic = NULL;
60 }
61
62 struct stasis_topic *stasis_caching_get_topic(struct stasis_caching_topic *caching_topic)
63 {
64         return caching_topic->topic;
65 }
66
67 void stasis_caching_unsubscribe(struct stasis_caching_topic *caching_topic)
68 {
69         if (caching_topic) {
70                 if (stasis_subscription_is_subscribed(caching_topic->sub)) {
71                         stasis_unsubscribe(caching_topic->sub);
72                 } else {
73                         ast_log(LOG_ERROR, "stasis_caching_topic unsubscribed multiple times\n");
74                 }
75         }
76 }
77
78 struct cache_entry {
79         struct stasis_message_type *type;
80         char *id;
81         struct stasis_message *snapshot;
82 };
83
84 static void cache_entry_dtor(void *obj)
85 {
86         struct cache_entry *entry = obj;
87         ao2_cleanup(entry->type);
88         entry->type = NULL;
89         ast_free(entry->id);
90         entry->id = NULL;
91         ao2_cleanup(entry->snapshot);
92         entry->snapshot = NULL;
93 }
94
95 static struct cache_entry *cache_entry_create(struct stasis_message_type *type, const char *id, struct stasis_message *snapshot)
96 {
97         RAII_VAR(struct cache_entry *, entry, NULL, ao2_cleanup);
98
99         ast_assert(type != NULL);
100         ast_assert(id != NULL);
101
102         entry = ao2_alloc(sizeof(*entry), cache_entry_dtor);
103         if (!entry) {
104                 return NULL;
105         }
106
107         entry->id = ast_strdup(id);
108         if (!entry->id) {
109                 return NULL;
110         }
111
112         ao2_ref(type, +1);
113         entry->type = type;
114         if (snapshot != NULL) {
115                 ao2_ref(snapshot, +1);
116                 entry->snapshot = snapshot;
117         }
118
119         ao2_ref(entry, +1);
120         return entry;
121 }
122
123 static int cache_entry_hash(const void *obj, int flags)
124 {
125         const struct cache_entry *entry = obj;
126         int hash = 0;
127
128         ast_assert(!(flags & OBJ_KEY));
129
130         hash += ast_hashtab_hash_string(stasis_message_type_name(entry->type));
131         hash += ast_hashtab_hash_string(entry->id);
132         return hash;
133 }
134
135 static int cache_entry_cmp(void *obj, void *arg, int flags)
136 {
137         const struct cache_entry *left = obj;
138         const struct cache_entry *right = arg;
139
140         ast_assert(!(flags & OBJ_KEY));
141
142         if (left->type == right->type && strcmp(left->id, right->id) == 0) {
143                 return CMP_MATCH | CMP_STOP;
144         }
145
146         return 0;
147 }
148
149 static struct stasis_message *cache_put(struct stasis_caching_topic *caching_topic, struct stasis_message_type *type, const char *id, struct stasis_message *new_snapshot)
150 {
151         RAII_VAR(struct cache_entry *, new_entry, NULL, ao2_cleanup);
152         RAII_VAR(struct cache_entry *, cached_entry, NULL, ao2_cleanup);
153         struct stasis_message *old_snapshot = NULL;
154
155         ast_assert(caching_topic->cache != NULL);
156
157         new_entry = cache_entry_create(type, id, new_snapshot);
158
159         if (new_snapshot == NULL) {
160                 /* Remove entry from cache */
161                 cached_entry = ao2_find(caching_topic->cache, new_entry, OBJ_POINTER | OBJ_UNLINK);
162                 if (cached_entry) {
163                         old_snapshot = cached_entry->snapshot;
164                         cached_entry->snapshot = NULL;
165                 }
166         } else {
167                 /* Insert/update cache */
168                 SCOPED_AO2LOCK(lock, caching_topic->cache);
169
170                 cached_entry = ao2_find(caching_topic->cache, new_entry, OBJ_POINTER | OBJ_NOLOCK);
171                 if (cached_entry) {
172                         /* Update cache. Because objects are moving, no need to update refcounts. */
173                         old_snapshot = cached_entry->snapshot;
174                         cached_entry->snapshot = new_entry->snapshot;
175                         new_entry->snapshot = NULL;
176                 } else {
177                         /* Insert into the cache */
178                         ao2_link_flags(caching_topic->cache, new_entry, OBJ_NOLOCK);
179                 }
180
181         }
182
183         return old_snapshot;
184 }
185
186 struct stasis_message *stasis_cache_get(struct stasis_caching_topic *caching_topic, struct stasis_message_type *type, const char *id)
187 {
188         RAII_VAR(struct cache_entry *, search_entry, NULL, ao2_cleanup);
189         RAII_VAR(struct cache_entry *, cached_entry, NULL, ao2_cleanup);
190
191         ast_assert(caching_topic->cache != NULL);
192
193         search_entry = cache_entry_create(type, id, NULL);
194         if (search_entry == NULL) {
195                 return NULL;
196         }
197
198         cached_entry = ao2_find(caching_topic->cache, search_entry, OBJ_POINTER);
199         if (cached_entry == NULL) {
200                 return NULL;
201         }
202
203         ast_assert(cached_entry->snapshot != NULL);
204         ao2_ref(cached_entry->snapshot, +1);
205         return cached_entry->snapshot;
206 }
207
208 static struct stasis_message_type *__cache_clear_data;
209
210 static struct stasis_message_type *cache_clear_data(void)
211 {
212         ast_assert(__cache_clear_data != NULL);
213         return __cache_clear_data;
214 }
215
216 static struct stasis_message_type *__cache_update;
217
218 struct stasis_message_type *stasis_cache_update(void)
219 {
220         ast_assert(__cache_update != NULL);
221         return __cache_update;
222 }
223
224 struct cache_clear_data {
225         struct stasis_message_type *type;
226         char *id;
227 };
228
229 static void cache_clear_data_dtor(void *obj)
230 {
231         struct cache_clear_data *ev = obj;
232         ast_free(ev->id);
233         ev->id = NULL;
234         ao2_cleanup(ev->type);
235         ev->type = NULL;
236 }
237
238 struct stasis_message *stasis_cache_clear_create(struct stasis_message_type *type, const char *id)
239 {
240         RAII_VAR(struct cache_clear_data *, ev, NULL, ao2_cleanup);
241         RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
242
243         ev = ao2_alloc(sizeof(*ev), cache_clear_data_dtor);
244         if (!ev) {
245                 return NULL;
246         }
247
248         ev->id = ast_strdup(id);
249         if (!ev->id) {
250                 return NULL;
251         }
252         ao2_ref(type, +1);
253         ev->type = type;
254
255         msg = stasis_message_create(cache_clear_data(), ev);
256
257         if (!msg) {
258                 return NULL;
259         }
260
261         ao2_ref(msg, +1);
262         return msg;
263 }
264
265 static void stasis_cache_update_dtor(void *obj)
266 {
267         struct stasis_cache_update *update = obj;
268         ao2_cleanup(update->topic);
269         update->topic = NULL;
270         ao2_cleanup(update->old_snapshot);
271         update->old_snapshot = NULL;
272         ao2_cleanup(update->new_snapshot);
273         update->new_snapshot = NULL;
274         ao2_cleanup(update->type);
275         update->type = NULL;
276 }
277
278 static struct stasis_message *update_create(struct stasis_topic *topic, struct stasis_message *old_snapshot, struct stasis_message *new_snapshot)
279 {
280         RAII_VAR(struct stasis_cache_update *, update, NULL, ao2_cleanup);
281         RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
282
283         ast_assert(topic != NULL);
284         ast_assert(old_snapshot != NULL || new_snapshot != NULL);
285
286         update = ao2_alloc(sizeof(*update), stasis_cache_update_dtor);
287         if (!update) {
288                 return NULL;
289         }
290
291         ao2_ref(topic, +1);
292         update->topic = topic;
293         if (old_snapshot) {
294                 ao2_ref(old_snapshot, +1);
295                 update->old_snapshot = old_snapshot;
296                 if (!new_snapshot) {
297                         ao2_ref(stasis_message_type(old_snapshot), +1);
298                         update->type = stasis_message_type(old_snapshot);
299                 }
300         }
301         if (new_snapshot) {
302                 ao2_ref(new_snapshot, +1);
303                 update->new_snapshot = new_snapshot;
304                 ao2_ref(stasis_message_type(new_snapshot), +1);
305                 update->type = stasis_message_type(new_snapshot);
306         }
307
308         msg = stasis_message_create(stasis_cache_update(), update);
309         if (!msg) {
310                 return NULL;
311         }
312
313         ao2_ref(msg, +1);
314         return msg;
315 }
316
317 static void caching_topic_exec(void *data, struct stasis_subscription *sub, struct stasis_topic *topic, struct stasis_message *message)
318 {
319         RAII_VAR(struct stasis_caching_topic *, caching_topic_needs_unref, NULL, ao2_cleanup);
320         struct stasis_caching_topic *caching_topic = data;
321         const char *id = NULL;
322
323         ast_assert(caching_topic->topic != NULL);
324         ast_assert(caching_topic->id_fn != NULL);
325
326         if (stasis_subscription_final_message(sub, message)) {
327                 caching_topic_needs_unref = caching_topic;
328         }
329
330         /* Handle cache clear event */
331         if (cache_clear_data() == stasis_message_type(message)) {
332                 RAII_VAR(struct stasis_message *, old_snapshot, NULL, ao2_cleanup);
333                 RAII_VAR(struct stasis_message *, update, NULL, ao2_cleanup);
334                 struct cache_clear_data *clear = stasis_message_data(message);
335                 ast_assert(clear->type != NULL);
336                 ast_assert(clear->id != NULL);
337                 old_snapshot = cache_put(caching_topic, clear->type, clear->id, NULL);
338                 if (old_snapshot) {
339                         update = update_create(topic, old_snapshot, NULL);
340                         stasis_publish(caching_topic->topic, update);
341                 } else {
342                         ast_log(LOG_ERROR,
343                                 "Attempting to remove an item from the cache that isn't there: %s %s\n",
344                                 stasis_message_type_name(clear->type), clear->id);
345                 }
346                 return;
347         }
348
349         id = caching_topic->id_fn(message);
350         if (id == NULL) {
351                 /* Object isn't cached; forward */
352                 stasis_forward_message(caching_topic->topic, topic, message);
353         } else {
354                 /* Update the cache */
355                 RAII_VAR(struct stasis_message *, old_snapshot, NULL, ao2_cleanup);
356                 RAII_VAR(struct stasis_message *, update, NULL, ao2_cleanup);
357
358                 old_snapshot = cache_put(caching_topic, stasis_message_type(message), id, message);
359
360                 update = update_create(topic, old_snapshot, message);
361                 if (update == NULL) {
362                         return;
363                 }
364
365                 stasis_publish(caching_topic->topic, update);
366         }
367
368         if (stasis_subscription_final_message(sub, message)) {
369                 ao2_cleanup(caching_topic);
370         }
371 }
372
373 struct stasis_caching_topic *stasis_caching_topic_create(struct stasis_topic *original_topic, snapshot_get_id id_fn)
374 {
375         RAII_VAR(struct stasis_caching_topic *, caching_topic, NULL, ao2_cleanup);
376         struct stasis_subscription *sub;
377         RAII_VAR(char *, new_name, NULL, free);
378         int ret;
379
380         ret = asprintf(&new_name, "%s-cached", stasis_topic_name(original_topic));
381         if (ret < 0) {
382                 return NULL;
383         }
384
385         caching_topic = ao2_alloc(sizeof(*caching_topic), stasis_caching_topic_dtor);
386         if (caching_topic == NULL) {
387                 return NULL;
388         }
389
390         caching_topic->cache = ao2_container_alloc(NUM_CACHE_BUCKETS, cache_entry_hash, cache_entry_cmp);
391         if (!caching_topic->cache) {
392                 ast_log(LOG_ERROR, "Stasis cache allocation failed\n");
393                 return NULL;
394         }
395
396         caching_topic->topic = stasis_topic_create(new_name);
397         if (caching_topic->topic == NULL) {
398                 return NULL;
399         }
400
401         caching_topic->id_fn = id_fn;
402
403         sub = stasis_subscribe(original_topic, caching_topic_exec, caching_topic);
404         if (sub == NULL) {
405                 return NULL;
406         }
407         /* This is for the reference contained in the subscription above */
408         ao2_ref(caching_topic, +1);
409         caching_topic->sub = sub;
410
411         ao2_ref(caching_topic, +1);
412         return caching_topic;
413 }
414
415 static void stasis_cache_exit(void)
416 {
417         ao2_cleanup(__cache_clear_data);
418         __cache_clear_data = NULL;
419         ao2_cleanup(__cache_update);
420         __cache_update = NULL;
421 }
422
423 int stasis_cache_init(void)
424 {
425         ast_register_atexit(stasis_cache_exit);
426
427         if (__cache_clear_data || __cache_update) {
428                 ast_log(LOG_ERROR, "Stasis cache double initialized\n");
429                 return -1;
430         }
431
432         __cache_update = stasis_message_type_create("stasis_cache_update");
433         if (!__cache_update) {
434                 return -1;
435         }
436
437         __cache_clear_data = stasis_message_type_create("StasisCacheClear");
438         if (!__cache_clear_data) {
439                 return -1;
440         }
441         return 0;
442 }
443