stasis cache: Enhance to keep track of an item from different entities.
[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_internal.h"
37 #include "asterisk/stasis.h"
38 #include "asterisk/utils.h"
39 #include "asterisk/vector.h"
40
41 #ifdef LOW_MEMORY
42 #define NUM_CACHE_BUCKETS 17
43 #else
44 #define NUM_CACHE_BUCKETS 563
45 #endif
46
47 /*! \internal */
48 struct stasis_cache {
49         struct ao2_container *entries;
50         snapshot_get_id id_fn;
51         cache_aggregate_calc_fn aggregate_calc_fn;
52         cache_aggregate_publish_fn aggregate_publish_fn;
53 };
54
55 /*! \internal */
56 struct stasis_caching_topic {
57         struct stasis_cache *cache;
58         struct stasis_topic *topic;
59         struct stasis_topic *original_topic;
60         struct stasis_subscription *sub;
61 };
62
63 static void stasis_caching_topic_dtor(void *obj)
64 {
65         struct stasis_caching_topic *caching_topic = obj;
66
67         /* Caching topics contain subscriptions, and must be manually
68          * unsubscribed. */
69         ast_assert(!stasis_subscription_is_subscribed(caching_topic->sub));
70         /* If there are any messages in flight to this subscription; that would
71          * be bad. */
72         ast_assert(stasis_subscription_is_done(caching_topic->sub));
73
74         ao2_cleanup(caching_topic->sub);
75         caching_topic->sub = NULL;
76         ao2_cleanup(caching_topic->cache);
77         caching_topic->cache = NULL;
78         ao2_cleanup(caching_topic->topic);
79         caching_topic->topic = NULL;
80         ao2_cleanup(caching_topic->original_topic);
81         caching_topic->original_topic = NULL;
82 }
83
84 struct stasis_topic *stasis_caching_get_topic(struct stasis_caching_topic *caching_topic)
85 {
86         return caching_topic->topic;
87 }
88
89 struct stasis_caching_topic *stasis_caching_unsubscribe(struct stasis_caching_topic *caching_topic)
90 {
91         if (!caching_topic) {
92                 return NULL;
93         }
94
95         /*
96          * The subscription may hold the last reference to this caching
97          * topic, but we want to make sure the unsubscribe finishes
98          * before kicking of the caching topic's dtor.
99          */
100         ao2_ref(caching_topic, +1);
101
102         if (stasis_subscription_is_subscribed(caching_topic->sub)) {
103                 /*
104                  * Increment the reference to hold on to it past the
105                  * unsubscribe. Will be cleaned up in dtor.
106                  */
107                 ao2_ref(caching_topic->sub, +1);
108                 stasis_unsubscribe(caching_topic->sub);
109         } else {
110                 ast_log(LOG_ERROR, "stasis_caching_topic unsubscribed multiple times\n");
111         }
112         ao2_cleanup(caching_topic);
113         return NULL;
114 }
115
116 struct stasis_caching_topic *stasis_caching_unsubscribe_and_join(struct stasis_caching_topic *caching_topic)
117 {
118         if (!caching_topic) {
119                 return NULL;
120         }
121
122         /* Hold a ref past the unsubscribe */
123         ao2_ref(caching_topic, +1);
124         stasis_caching_unsubscribe(caching_topic);
125         stasis_subscription_join(caching_topic->sub);
126         ao2_cleanup(caching_topic);
127         return NULL;
128 }
129
130 struct cache_entry_key {
131         struct stasis_message_type *type;
132         const char *id;
133 };
134
135 struct stasis_cache_entry {
136         struct cache_entry_key key;
137         /*! Aggregate snapshot of the stasis cache. */
138         struct stasis_message *aggregate;
139         /*! Local entity snapshot of the stasis event. */
140         struct stasis_message *local;
141         /*! Remote entity snapshots of the stasis event. */
142         AST_VECTOR(, struct stasis_message *) remote;
143 };
144
145 static void cache_entry_dtor(void *obj)
146 {
147         struct stasis_cache_entry *entry = obj;
148         size_t idx;
149
150         ao2_cleanup(entry->key.type);
151         entry->key.type = NULL;
152         ast_free((char *) entry->key.id);
153         entry->key.id = NULL;
154
155         ao2_cleanup(entry->aggregate);
156         entry->aggregate = NULL;
157         ao2_cleanup(entry->local);
158         entry->local = NULL;
159
160         for (idx = 0; idx < AST_VECTOR_SIZE(&entry->remote); ++idx) {
161                 struct stasis_message *remote;
162
163                 remote = AST_VECTOR_GET(&entry->remote, idx);
164                 ao2_cleanup(remote);
165         }
166         AST_VECTOR_FREE(&entry->remote);
167 }
168
169 static struct stasis_cache_entry *cache_entry_create(struct stasis_message_type *type, const char *id, struct stasis_message *snapshot)
170 {
171         struct stasis_cache_entry *entry;
172         int is_remote;
173
174         ast_assert(type != NULL);
175         ast_assert(id != NULL);
176         ast_assert(snapshot != NULL);
177
178         entry = ao2_alloc_options(sizeof(*entry), cache_entry_dtor,
179                 AO2_ALLOC_OPT_LOCK_NOLOCK);
180         if (!entry) {
181                 return NULL;
182         }
183
184         entry->key.id = ast_strdup(id);
185         if (!entry->key.id) {
186                 ao2_cleanup(entry);
187                 return NULL;
188         }
189         entry->key.type = ao2_bump(type);
190
191         is_remote = ast_eid_cmp(&ast_eid_default, stasis_message_eid(snapshot)) ? 1 : 0;
192         if (AST_VECTOR_INIT(&entry->remote, is_remote)) {
193                 ao2_cleanup(entry);
194                 return NULL;
195         }
196
197         if (is_remote) {
198                 if (AST_VECTOR_APPEND(&entry->remote, snapshot)) {
199                         ao2_cleanup(entry);
200                         return NULL;
201                 }
202         } else {
203                 entry->local = snapshot;
204         }
205         ao2_bump(snapshot);
206
207         return entry;
208 }
209
210 static int cache_entry_hash(const void *obj, int flags)
211 {
212         const struct stasis_cache_entry *object;
213         const struct cache_entry_key *key;
214         int hash = 0;
215
216         switch (flags & OBJ_SEARCH_MASK) {
217         case OBJ_SEARCH_KEY:
218                 key = obj;
219                 break;
220         case OBJ_SEARCH_OBJECT:
221                 object = obj;
222                 key = &object->key;
223                 break;
224         default:
225                 /* Hash can only work on something with a full key. */
226                 ast_assert(0);
227                 return 0;
228         }
229
230         hash += ast_hashtab_hash_string(stasis_message_type_name(key->type));
231         hash += ast_hashtab_hash_string(key->id);
232         return hash;
233 }
234
235 static int cache_entry_cmp(void *obj, void *arg, int flags)
236 {
237         const struct stasis_cache_entry *object_left = obj;
238         const struct stasis_cache_entry *object_right = arg;
239         const struct cache_entry_key *right_key = obj;
240         int cmp;
241
242         switch (flags & OBJ_SEARCH_MASK) {
243         case OBJ_SEARCH_OBJECT:
244                 right_key = &object_right->key;
245                 /* Fall through */
246         case OBJ_SEARCH_KEY:
247                 cmp = object_left->key.type != right_key->type
248                         || strcmp(object_left->key.id, right_key->id);
249                 break;
250         case OBJ_SEARCH_PARTIAL_KEY:
251                 /* Not supported by container */
252                 ast_assert(0);
253                 cmp = -1;
254                 break;
255         default:
256                 /*
257                  * What arg points to is specific to this traversal callback
258                  * and has no special meaning to astobj2.
259                  */
260                 cmp = 0;
261                 break;
262         }
263         if (cmp) {
264                 return 0;
265         }
266         /*
267          * At this point the traversal callback is identical to a sorted
268          * container.
269          */
270         return CMP_MATCH;
271 }
272
273 static void cache_dtor(void *obj)
274 {
275         struct stasis_cache *cache = obj;
276
277         ao2_cleanup(cache->entries);
278         cache->entries = NULL;
279 }
280
281 struct stasis_cache *stasis_cache_create_full(snapshot_get_id id_fn,
282         cache_aggregate_calc_fn aggregate_calc_fn,
283         cache_aggregate_publish_fn aggregate_publish_fn)
284 {
285         struct stasis_cache *cache;
286
287         cache = ao2_alloc_options(sizeof(*cache), cache_dtor,
288                 AO2_ALLOC_OPT_LOCK_NOLOCK);
289         if (!cache) {
290                 return NULL;
291         }
292
293         cache->entries = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_RWLOCK, 0,
294                 NUM_CACHE_BUCKETS, cache_entry_hash, NULL, cache_entry_cmp);
295         if (!cache->entries) {
296                 ao2_cleanup(cache);
297                 return NULL;
298         }
299
300         cache->id_fn = id_fn;
301         cache->aggregate_calc_fn = aggregate_calc_fn;
302         cache->aggregate_publish_fn = aggregate_publish_fn;
303
304         return cache;
305 }
306
307 struct stasis_cache *stasis_cache_create(snapshot_get_id id_fn)
308 {
309         return stasis_cache_create_full(id_fn, NULL, NULL);
310 }
311
312 struct stasis_message *stasis_cache_entry_get_aggregate(struct stasis_cache_entry *entry)
313 {
314         return entry->aggregate;
315 }
316
317 struct stasis_message *stasis_cache_entry_get_local(struct stasis_cache_entry *entry)
318 {
319         return entry->local;
320 }
321
322 struct stasis_message *stasis_cache_entry_get_remote(struct stasis_cache_entry *entry, int idx)
323 {
324         if (idx < AST_VECTOR_SIZE(&entry->remote)) {
325                 return AST_VECTOR_GET(&entry->remote, idx);
326         }
327         return NULL;
328 }
329
330 /*!
331  * \internal
332  * \brief Find the cache entry in the cache entries container.
333  *
334  * \param entries Container of cached entries.
335  * \param type Type of message to retrieve the cache entry.
336  * \param id Identity of the snapshot to retrieve the cache entry.
337  *
338  * \note The entries container is already locked.
339  *
340  * \retval Cache-entry on success.
341  * \retval NULL Not in cache.
342  */
343 static struct stasis_cache_entry *cache_find(struct ao2_container *entries, struct stasis_message_type *type, const char *id)
344 {
345         struct cache_entry_key search_key;
346
347         search_key.type = type;
348         search_key.id = id;
349         return ao2_find(entries, &search_key, OBJ_SEARCH_KEY | OBJ_NOLOCK);
350 }
351
352 /*!
353  * \internal
354  * \brief Remove the stasis snapshot in the cache entry determined by eid.
355  *
356  * \param entries Container of cached entries.
357  * \param cached_entry The entry to remove the snapshot from.
358  * \param eid Which snapshot in the cached entry.
359  *
360  * \note The entries container is already locked.
361  *
362  * \return Previous stasis entry snapshot.
363  */
364 static struct stasis_message *cache_remove(struct ao2_container *entries, struct stasis_cache_entry *cached_entry, const struct ast_eid *eid)
365 {
366         struct stasis_message *old_snapshot;
367         int is_remote;
368
369         is_remote = ast_eid_cmp(eid, &ast_eid_default);
370         if (!is_remote) {
371                 old_snapshot = cached_entry->local;
372                 cached_entry->local = NULL;
373         } else {
374                 int idx;
375
376                 old_snapshot = NULL;
377                 for (idx = 0; idx < AST_VECTOR_SIZE(&cached_entry->remote); ++idx) {
378                         struct stasis_message *cur;
379
380                         cur = AST_VECTOR_GET(&cached_entry->remote, idx);
381                         if (!ast_eid_cmp(eid, stasis_message_eid(cur))) {
382                                 old_snapshot = AST_VECTOR_REMOVE_UNORDERED(&cached_entry->remote, idx);
383                                 break;
384                         }
385                 }
386         }
387
388         if (!cached_entry->local && !AST_VECTOR_SIZE(&cached_entry->remote)) {
389                 ao2_unlink_flags(entries, cached_entry, OBJ_NOLOCK);
390         }
391
392         return old_snapshot;
393 }
394
395 /*!
396  * \internal
397  * \brief Update the stasis snapshot in the cache entry determined by eid.
398  *
399  * \param cached_entry The entry to remove the snapshot from.
400  * \param eid Which snapshot in the cached entry.
401  * \param new_snapshot Snapshot to replace the old snapshot.
402  *
403  * \return Previous stasis entry snapshot.
404  */
405 static struct stasis_message *cache_udpate(struct stasis_cache_entry *cached_entry, const struct ast_eid *eid, struct stasis_message *new_snapshot)
406 {
407         struct stasis_message *old_snapshot;
408         int is_remote;
409         int idx;
410
411         is_remote = ast_eid_cmp(eid, &ast_eid_default);
412         if (!is_remote) {
413                 old_snapshot = cached_entry->local;
414                 cached_entry->local = ao2_bump(new_snapshot);
415                 return old_snapshot;
416         }
417
418         old_snapshot = NULL;
419         for (idx = 0; idx < AST_VECTOR_SIZE(&cached_entry->remote); ++idx) {
420                 struct stasis_message *cur;
421
422                 cur = AST_VECTOR_GET(&cached_entry->remote, idx);
423                 if (!ast_eid_cmp(eid, stasis_message_eid(cur))) {
424                         old_snapshot = AST_VECTOR_REMOVE_UNORDERED(&cached_entry->remote, idx);
425                         break;
426                 }
427         }
428         if (!AST_VECTOR_APPEND(&cached_entry->remote, new_snapshot)) {
429                 ao2_bump(new_snapshot);
430         }
431
432         return old_snapshot;
433 }
434
435 struct cache_put_snapshots {
436         /*! Old cache eid snapshot. */
437         struct stasis_message *old;
438         /*! Old cache aggregate snapshot. */
439         struct stasis_message *aggregate_old;
440         /*! New cache aggregate snapshot. */
441         struct stasis_message *aggregate_new;
442 };
443
444 static struct cache_put_snapshots cache_put(struct stasis_cache *cache,
445         struct stasis_message_type *type, const char *id, const struct ast_eid *eid,
446         struct stasis_message *new_snapshot)
447 {
448         struct stasis_cache_entry *cached_entry;
449         struct cache_put_snapshots snapshots;
450
451         ast_assert(cache->entries != NULL);
452         ast_assert(eid != NULL);/* Aggregate snapshots not allowed to be put directly. */
453         ast_assert(new_snapshot == NULL ||
454                 type == stasis_message_type(new_snapshot));
455
456         memset(&snapshots, 0, sizeof(snapshots));
457
458         ao2_wrlock(cache->entries);
459
460         cached_entry = cache_find(cache->entries, type, id);
461
462         /* Update the eid snapshot. */
463         if (!new_snapshot) {
464                 /* Remove snapshot from cache */
465                 if (cached_entry) {
466                         snapshots.old = cache_remove(cache->entries, cached_entry, eid);
467                 }
468         } else if (cached_entry) {
469                 /* Update snapshot in cache */
470                 snapshots.old = cache_udpate(cached_entry, eid, new_snapshot);
471         } else {
472                 /* Insert into the cache */
473                 cached_entry = cache_entry_create(type, id, new_snapshot);
474                 if (cached_entry) {
475                         ao2_link_flags(cache->entries, cached_entry, OBJ_NOLOCK);
476                 }
477         }
478
479         /* Update the aggregate snapshot. */
480         if (cache->aggregate_calc_fn && cached_entry) {
481                 snapshots.aggregate_new = cache->aggregate_calc_fn(cached_entry, new_snapshot);
482                 snapshots.aggregate_old = cached_entry->aggregate;
483                 cached_entry->aggregate = ao2_bump(snapshots.aggregate_new);
484         }
485
486         ao2_unlock(cache->entries);
487
488         ao2_cleanup(cached_entry);
489         return snapshots;
490 }
491
492 /*!
493  * \internal
494  * \brief Dump all entity snapshots in the cache entry into the given container.
495  *
496  * \param snapshots Container to put all snapshots in the cache entry.
497  * \param entry Cache entry to use.
498  *
499  * \retval 0 on success.
500  * \retval non-zero on error.
501  */
502 static int cache_entry_dump(struct ao2_container *snapshots, const struct stasis_cache_entry *entry)
503 {
504         int idx;
505         int err = 0;
506
507         ast_assert(snapshots != NULL);
508         ast_assert(entry != NULL);
509
510         /* The aggregate snapshot is not a snapshot from an entity. */
511
512         if (entry->local) {
513                 err |= !ao2_link(snapshots, entry->local);
514         }
515
516         for (idx = 0; !err && idx < AST_VECTOR_SIZE(&entry->remote); ++idx) {
517                 struct stasis_message *snapshot;
518
519                 snapshot = AST_VECTOR_GET(&entry->remote, idx);
520                 err |= !ao2_link(snapshots, snapshot);
521         }
522
523         return err;
524 }
525
526 struct ao2_container *stasis_cache_get_all(struct stasis_cache *cache, struct stasis_message_type *type, const char *id)
527 {
528         struct stasis_cache_entry *cached_entry;
529         struct ao2_container *found;
530
531         ast_assert(cache != NULL);
532         ast_assert(cache->entries != NULL);
533         ast_assert(type != NULL);
534         ast_assert(id != NULL);
535
536         found = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, NULL, NULL);
537         if (!found) {
538                 return NULL;
539         }
540
541         ao2_rdlock(cache->entries);
542
543         cached_entry = cache_find(cache->entries, type, id);
544         if (cached_entry && cache_entry_dump(found, cached_entry)) {
545                 ao2_cleanup(found);
546                 found = NULL;
547         }
548
549         ao2_unlock(cache->entries);
550
551         ao2_cleanup(cached_entry);
552         return found;
553 }
554
555 /*!
556  * \internal
557  * \brief Retrieve an item from the cache entry for a specific eid.
558  *
559  * \param entry Cache entry to use.
560  * \param eid Specific entity id to retrieve.  NULL for aggregate.
561  *
562  * \note The returned snapshot has not had its reference bumped.
563  *
564  * \retval Snapshot from the cache.
565  * \retval \c NULL if snapshot is not found.
566  */
567 static struct stasis_message *cache_entry_by_eid(const struct stasis_cache_entry *entry, const struct ast_eid *eid)
568 {
569         int is_remote;
570         int idx;
571
572         if (!eid) {
573                 /* Get aggregate. */
574                 return entry->aggregate;
575         }
576
577         /* Get snapshot with specific eid. */
578         is_remote = ast_eid_cmp(eid, &ast_eid_default);
579         if (!is_remote) {
580                 return entry->local;
581         }
582
583         for (idx = 0; idx < AST_VECTOR_SIZE(&entry->remote); ++idx) {
584                 struct stasis_message *cur;
585
586                 cur = AST_VECTOR_GET(&entry->remote, idx);
587                 if (!ast_eid_cmp(eid, stasis_message_eid(cur))) {
588                         return cur;
589                 }
590         }
591
592         return NULL;
593 }
594
595 struct stasis_message *stasis_cache_get_by_eid(struct stasis_cache *cache, struct stasis_message_type *type, const char *id, const struct ast_eid *eid)
596 {
597         struct stasis_cache_entry *cached_entry;
598         struct stasis_message *snapshot = NULL;
599
600         ast_assert(cache != NULL);
601         ast_assert(cache->entries != NULL);
602         ast_assert(type != NULL);
603         ast_assert(id != NULL);
604
605         ao2_rdlock(cache->entries);
606
607         cached_entry = cache_find(cache->entries, type, id);
608         if (cached_entry) {
609                 snapshot = cache_entry_by_eid(cached_entry, eid);
610                 ao2_bump(snapshot);
611         }
612
613         ao2_unlock(cache->entries);
614
615         ao2_cleanup(cached_entry);
616         return snapshot;
617 }
618
619 struct stasis_message *stasis_cache_get(struct stasis_cache *cache, struct stasis_message_type *type, const char *id)
620 {
621         return stasis_cache_get_by_eid(cache, type, id, &ast_eid_default);
622 }
623
624 struct cache_dump_data {
625         struct ao2_container *container;
626         struct stasis_message_type *type;
627         const struct ast_eid *eid;
628 };
629
630 static int cache_dump_by_eid_cb(void *obj, void *arg, int flags)
631 {
632         struct cache_dump_data *cache_dump = arg;
633         struct stasis_cache_entry *entry = obj;
634
635         if (!cache_dump->type || entry->key.type == cache_dump->type) {
636                 struct stasis_message *snapshot;
637
638                 snapshot = cache_entry_by_eid(entry, cache_dump->eid);
639                 if (snapshot) {
640                         if (!ao2_link(cache_dump->container, snapshot)) {
641                                 ao2_cleanup(cache_dump->container);
642                                 cache_dump->container = NULL;
643                                 return CMP_STOP;
644                         }
645                 }
646         }
647
648         return 0;
649 }
650
651 struct ao2_container *stasis_cache_dump_by_eid(struct stasis_cache *cache, struct stasis_message_type *type, const struct ast_eid *eid)
652 {
653         struct cache_dump_data cache_dump;
654
655         ast_assert(cache != NULL);
656         ast_assert(cache->entries != NULL);
657
658         cache_dump.eid = eid;
659         cache_dump.type = type;
660         cache_dump.container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, NULL, NULL);
661         if (!cache_dump.container) {
662                 return NULL;
663         }
664
665         ao2_callback(cache->entries, OBJ_MULTIPLE | OBJ_NODATA, cache_dump_by_eid_cb, &cache_dump);
666         return cache_dump.container;
667 }
668
669 struct ao2_container *stasis_cache_dump(struct stasis_cache *cache, struct stasis_message_type *type)
670 {
671         return stasis_cache_dump_by_eid(cache, type, &ast_eid_default);
672 }
673
674 static int cache_dump_all_cb(void *obj, void *arg, int flags)
675 {
676         struct cache_dump_data *cache_dump = arg;
677         struct stasis_cache_entry *entry = obj;
678
679         if (!cache_dump->type || entry->key.type == cache_dump->type) {
680                 if (cache_entry_dump(cache_dump->container, entry)) {
681                         ao2_cleanup(cache_dump->container);
682                         cache_dump->container = NULL;
683                         return CMP_STOP;
684                 }
685         }
686
687         return 0;
688 }
689
690 struct ao2_container *stasis_cache_dump_all(struct stasis_cache *cache, struct stasis_message_type *type)
691 {
692         struct cache_dump_data cache_dump;
693
694         ast_assert(cache != NULL);
695         ast_assert(cache->entries != NULL);
696
697         cache_dump.eid = NULL;
698         cache_dump.type = type;
699         cache_dump.container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, NULL, NULL);
700         if (!cache_dump.container) {
701                 return NULL;
702         }
703
704         ao2_callback(cache->entries, OBJ_MULTIPLE | OBJ_NODATA, cache_dump_all_cb, &cache_dump);
705         return cache_dump.container;
706 }
707
708 STASIS_MESSAGE_TYPE_DEFN(stasis_cache_clear_type);
709 STASIS_MESSAGE_TYPE_DEFN(stasis_cache_update_type);
710
711 struct stasis_message *stasis_cache_clear_create(struct stasis_message *id_message)
712 {
713         return stasis_message_create(stasis_cache_clear_type(), id_message);
714 }
715
716 static void stasis_cache_update_dtor(void *obj)
717 {
718         struct stasis_cache_update *update = obj;
719
720         ao2_cleanup(update->old_snapshot);
721         update->old_snapshot = NULL;
722         ao2_cleanup(update->new_snapshot);
723         update->new_snapshot = NULL;
724         ao2_cleanup(update->type);
725         update->type = NULL;
726 }
727
728 static struct stasis_message *update_create(struct stasis_message *old_snapshot, struct stasis_message *new_snapshot)
729 {
730         struct stasis_cache_update *update;
731         struct stasis_message *msg;
732
733         ast_assert(old_snapshot != NULL || new_snapshot != NULL);
734
735         update = ao2_alloc_options(sizeof(*update), stasis_cache_update_dtor,
736                 AO2_ALLOC_OPT_LOCK_NOLOCK);
737         if (!update) {
738                 return NULL;
739         }
740
741         if (old_snapshot) {
742                 ao2_ref(old_snapshot, +1);
743                 update->old_snapshot = old_snapshot;
744                 if (!new_snapshot) {
745                         ao2_ref(stasis_message_type(old_snapshot), +1);
746                         update->type = stasis_message_type(old_snapshot);
747                 }
748         }
749         if (new_snapshot) {
750                 ao2_ref(new_snapshot, +1);
751                 update->new_snapshot = new_snapshot;
752                 ao2_ref(stasis_message_type(new_snapshot), +1);
753                 update->type = stasis_message_type(new_snapshot);
754         }
755
756         msg = stasis_message_create(stasis_cache_update_type(), update);
757
758         ao2_cleanup(update);
759         return msg;
760 }
761
762 static void caching_topic_exec(void *data, struct stasis_subscription *sub,
763         struct stasis_message *message)
764 {
765         struct stasis_caching_topic *caching_topic_needs_unref;
766         struct stasis_caching_topic *caching_topic = data;
767         struct stasis_message *msg;
768         struct stasis_message *msg_put;
769         struct stasis_message_type *msg_type;
770         const struct ast_eid *msg_eid;
771         const char *msg_id;
772
773         ast_assert(caching_topic != NULL);
774         ast_assert(caching_topic->topic != NULL);
775         ast_assert(caching_topic->cache != NULL);
776         ast_assert(caching_topic->cache->id_fn != NULL);
777
778         if (stasis_subscription_final_message(sub, message)) {
779                 caching_topic_needs_unref = caching_topic;
780         } else {
781                 caching_topic_needs_unref = NULL;
782         }
783
784         msg_type = stasis_message_type(message);
785         if (stasis_cache_clear_type() == msg_type) {
786                 /* Cache clear event. */
787                 msg_put = NULL;
788                 msg = stasis_message_data(message);
789                 msg_type = stasis_message_type(msg);
790         } else {
791                 /* Normal cache update event. */
792                 msg_put = message;
793                 msg = message;
794         }
795         ast_assert(msg_type != NULL);
796
797         msg_eid = stasis_message_eid(msg);/* msg_eid is NULL for aggregate message. */
798         msg_id = caching_topic->cache->id_fn(msg);
799         if (msg_id && msg_eid) {
800                 struct stasis_message *update;
801                 struct cache_put_snapshots snapshots;
802
803                 /* Update the cache */
804                 snapshots = cache_put(caching_topic->cache, msg_type, msg_id, msg_eid, msg_put);
805                 if (snapshots.old || msg_put) {
806                         update = update_create(snapshots.old, msg_put);
807                         if (update) {
808                                 stasis_publish(caching_topic->topic, update);
809                         }
810                         ao2_cleanup(update);
811                 } else {
812                         ast_log(LOG_ERROR,
813                                 "Attempting to remove an item from the %s cache that isn't there: %s %s\n",
814                                 stasis_topic_name(caching_topic->topic),
815                                 stasis_message_type_name(msg_type), msg_id);
816                 }
817
818                 if (snapshots.aggregate_old != snapshots.aggregate_new) {
819                         if (snapshots.aggregate_new && caching_topic->cache->aggregate_publish_fn) {
820                                 caching_topic->cache->aggregate_publish_fn(caching_topic->original_topic,
821                                         snapshots.aggregate_new);
822                         }
823                         update = update_create(snapshots.aggregate_old, snapshots.aggregate_new);
824                         if (update) {
825                                 stasis_publish(caching_topic->topic, update);
826                         }
827                         ao2_cleanup(update);
828                 }
829
830                 ao2_cleanup(snapshots.old);
831                 ao2_cleanup(snapshots.aggregate_old);
832                 ao2_cleanup(snapshots.aggregate_new);
833         }
834
835         ao2_cleanup(caching_topic_needs_unref);
836 }
837
838 struct stasis_caching_topic *stasis_caching_topic_create(struct stasis_topic *original_topic, struct stasis_cache *cache)
839 {
840         RAII_VAR(struct stasis_caching_topic *, caching_topic, NULL, ao2_cleanup);
841         struct stasis_subscription *sub;
842         RAII_VAR(char *, new_name, NULL, ast_free);
843         int ret;
844
845         ret = ast_asprintf(&new_name, "%s-cached", stasis_topic_name(original_topic));
846         if (ret < 0) {
847                 return NULL;
848         }
849
850         caching_topic = ao2_alloc_options(sizeof(*caching_topic),
851                 stasis_caching_topic_dtor, AO2_ALLOC_OPT_LOCK_NOLOCK);
852         if (caching_topic == NULL) {
853                 return NULL;
854         }
855
856         caching_topic->topic = stasis_topic_create(new_name);
857         if (caching_topic->topic == NULL) {
858                 return NULL;
859         }
860
861         ao2_ref(cache, +1);
862         caching_topic->cache = cache;
863
864         sub = internal_stasis_subscribe(original_topic, caching_topic_exec, caching_topic, 0);
865         if (sub == NULL) {
866                 return NULL;
867         }
868
869         ao2_ref(original_topic, +1);
870         caching_topic->original_topic = original_topic;
871
872         /* This is for the reference contained in the subscription above */
873         ao2_ref(caching_topic, +1);
874         caching_topic->sub = sub;
875
876         /* The subscription holds the reference, so no additional ref bump. */
877         return caching_topic;
878 }
879
880 static void stasis_cache_cleanup(void)
881 {
882         STASIS_MESSAGE_TYPE_CLEANUP(stasis_cache_clear_type);
883         STASIS_MESSAGE_TYPE_CLEANUP(stasis_cache_update_type);
884 }
885
886 int stasis_cache_init(void)
887 {
888         ast_register_cleanup(stasis_cache_cleanup);
889
890         if (STASIS_MESSAGE_TYPE_INIT(stasis_cache_clear_type) != 0) {
891                 return -1;
892         }
893
894         if (STASIS_MESSAGE_TYPE_INIT(stasis_cache_update_type) != 0) {
895                 return -1;
896         }
897
898         return 0;
899 }
900