Fix DEBUG_THREADS when lock is acquired in __constructor__
[asterisk/asterisk.git] / main / devicestate.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2008, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * Russell Bryant <russell@digium.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  *
22  * \brief Device state management
23  *
24  * \author Mark Spencer <markster@digium.com>
25  * \author Russell Bryant <russell@digium.com>
26  *
27  *      \arg \ref AstExtState
28  */
29
30 /*! \page AstExtState Extension and device states in Asterisk
31  *
32  * (Note that these descriptions of device states and extension
33  * states have not been updated to the way things work
34  * in Asterisk 1.6.)
35  *
36  *      Asterisk has an internal system that reports states
37  *      for an extension. By using the dialplan priority -1,
38  *      also called a \b hint, a connection can be made from an
39  *      extension to one or many devices. The state of the extension
40  *      now depends on the combined state of the devices.
41  *
42  *      The device state is basically based on the current calls.
43  *      If the devicestate engine can find a call from or to the
44  *      device, it's in use.
45  *
46  *      Some channel drivers implement a callback function for
47  *      a better level of reporting device states. The SIP channel
48  *      has a complicated system for this, which is improved
49  *      by adding call limits to the configuration.
50  *
51  *      Functions that want to check the status of an extension
52  *      register themself as a \b watcher.
53  *      Watchers in this system can subscribe either to all extensions
54  *      or just a specific extensions.
55  *
56  *      For non-device related states, there's an API called
57  *      devicestate providers. This is an extendible system for
58  *      delivering state information from outside sources or
59  *      functions within Asterisk. Currently we have providers
60  *      for app_meetme.c - the conference bridge - and call
61  *      parking (metermaids).
62  *
63  *      There are manly three subscribers to extension states
64  *      within Asterisk:
65  *      - AMI, the manager interface
66  *      - app_queue.c - the Queue dialplan application
67  *      - SIP subscriptions, a.k.a. "blinking lamps" or
68  *        "buddy lists"
69  *
70  *      The CLI command "show hints" show last known state
71  *
72  *      \note None of these handle user states, like an IM presence
73  *      system. res_xmpp.c can subscribe and watch such states
74  *      in jabber/xmpp based systems.
75  *
76  *      \section AstDevStateArch Architecture for devicestates
77  *
78  *      When a channel driver or asterisk app changes state for
79  *      a watched object, it alerts the core. The core queues
80  *      a change. When the change is processed, there's a query
81  *      sent to the channel driver/provider if there's a function
82  *      to handle that, otherwise a channel walk is issued to find
83  *      a channel that involves the object.
84  *
85  *      The changes are queued and processed by a separate thread.
86  *      This thread calls the watchers subscribing to status
87  *      changes for the object. For manager, this results
88  *      in events. For SIP, NOTIFY requests.
89  *
90  *      - Device states
91  *              \arg \ref devicestate.c
92  *              \arg \ref devicestate.h
93  *
94  *      \section AstExtStateArch Architecture for extension states
95  *
96  *      Hints are connected to extension. If an extension changes state
97  *      it checks the hint devices. If there is a hint, the callbacks into
98  *      device states are checked. The aggregated state is set for the hint
99  *      and reported back.
100  *
101  *      - Extension states
102  *              \arg \ref AstENUM ast_extension_states
103  *              \arg \ref pbx.c
104  *              \arg \ref pbx.h
105  *      - Structures
106  *              - \ref ast_state_cb struct.  Callbacks for watchers
107  *              - Callback ast_state_cb_type
108  *              - \ref ast_hint struct.
109  *      - Functions
110  *              - ast_extension_state_add()
111  *              - ast_extension_state_del()
112  *              - ast_get_hint()
113  *
114  */
115
116 /*** MODULEINFO
117         <support_level>core</support_level>
118  ***/
119
120 #include "asterisk.h"
121
122 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
123
124 #include "asterisk/_private.h"
125 #include "asterisk/channel.h"
126 #include "asterisk/utils.h"
127 #include "asterisk/lock.h"
128 #include "asterisk/linkedlists.h"
129 #include "asterisk/devicestate.h"
130 #include "asterisk/pbx.h"
131 #include "asterisk/app.h"
132 #include "asterisk/astobj2.h"
133 #include "asterisk/stasis.h"
134 #include "asterisk/devicestate.h"
135
136 #define DEVSTATE_TOPIC_BUCKETS 57
137
138 /*! \brief Device state strings for printing */
139 static const char * const devstatestring[][2] = {
140         { /* 0 AST_DEVICE_UNKNOWN */     "Unknown",     "UNKNOWN"     }, /*!< Valid, but unknown state */
141         { /* 1 AST_DEVICE_NOT_INUSE */   "Not in use",  "NOT_INUSE"   }, /*!< Not used */
142         { /* 2 AST_DEVICE IN USE */      "In use",      "INUSE"       }, /*!< In use */
143         { /* 3 AST_DEVICE_BUSY */        "Busy",        "BUSY"        }, /*!< Busy */
144         { /* 4 AST_DEVICE_INVALID */     "Invalid",     "INVALID"     }, /*!< Invalid - not known to Asterisk */
145         { /* 5 AST_DEVICE_UNAVAILABLE */ "Unavailable", "UNAVAILABLE" }, /*!< Unavailable (not registered) */
146         { /* 6 AST_DEVICE_RINGING */     "Ringing",     "RINGING"     }, /*!< Ring, ring, ring */
147         { /* 7 AST_DEVICE_RINGINUSE */   "Ring+Inuse",  "RINGINUSE"   }, /*!< Ring and in use */
148         { /* 8 AST_DEVICE_ONHOLD */      "On Hold",      "ONHOLD"      }, /*!< On Hold */
149 };
150
151 /*!\brief Mapping for channel states to device states */
152 static const struct chan2dev {
153         enum ast_channel_state chan;
154         enum ast_device_state dev;
155 } chan2dev[] = {
156         { AST_STATE_DOWN,            AST_DEVICE_NOT_INUSE },
157         { AST_STATE_RESERVED,        AST_DEVICE_INUSE },
158         { AST_STATE_OFFHOOK,         AST_DEVICE_INUSE },
159         { AST_STATE_DIALING,         AST_DEVICE_INUSE },
160         { AST_STATE_RING,            AST_DEVICE_INUSE },
161         { AST_STATE_RINGING,         AST_DEVICE_RINGING },
162         { AST_STATE_UP,              AST_DEVICE_INUSE },
163         { AST_STATE_BUSY,            AST_DEVICE_BUSY },
164         { AST_STATE_DIALING_OFFHOOK, AST_DEVICE_INUSE },
165         { AST_STATE_PRERING,         AST_DEVICE_RINGING },
166         { -100,                      -100 },
167 };
168
169 /*! \brief  A device state provider (not a channel) */
170 struct devstate_prov {
171         char label[40];
172         ast_devstate_prov_cb_type callback;
173         AST_RWLIST_ENTRY(devstate_prov) list;
174 };
175
176 /*! \brief A list of providers */
177 static AST_RWLIST_HEAD_STATIC(devstate_provs, devstate_prov);
178
179 struct state_change {
180         AST_LIST_ENTRY(state_change) list;
181         enum ast_devstate_cache cachable;
182         char device[1];
183 };
184
185 /*! \brief The state change queue. State changes are queued
186         for processing by a separate thread */
187 static AST_LIST_HEAD_STATIC(state_changes, state_change);
188
189 /*! \brief The device state change notification thread */
190 static pthread_t change_thread = AST_PTHREADT_NULL;
191
192 /*! \brief Flag for the queue */
193 static ast_cond_t change_pending;
194
195 struct stasis_subscription *devstate_message_sub;
196
197 static struct stasis_topic *device_state_topic_all;
198 static struct stasis_cache *device_state_cache;
199 static struct stasis_caching_topic *device_state_topic_cached;
200 static struct stasis_topic_pool *device_state_topic_pool;
201
202 STASIS_MESSAGE_TYPE_DEFN(ast_device_state_message_type);
203
204 /* Forward declarations */
205 static int getproviderstate(const char *provider, const char *address);
206
207 /*! \brief Find devicestate as text message for output */
208 const char *ast_devstate2str(enum ast_device_state devstate)
209 {
210         return devstatestring[devstate][0];
211 }
212
213 /* Deprecated interface (not prefixed with ast_) */
214 const char *devstate2str(enum ast_device_state devstate)
215 {
216         return devstatestring[devstate][0];
217 }
218
219 enum ast_device_state ast_state_chan2dev(enum ast_channel_state chanstate)
220 {
221         int i;
222         chanstate &= 0xFFFF;
223         for (i = 0; chan2dev[i].chan != -100; i++) {
224                 if (chan2dev[i].chan == chanstate) {
225                         return chan2dev[i].dev;
226                 }
227         }
228         return AST_DEVICE_UNKNOWN;
229 }
230
231 /* Parseable */
232 const char *ast_devstate_str(enum ast_device_state state)
233 {
234         return devstatestring[state][1];
235 }
236
237 enum ast_device_state ast_devstate_val(const char *val)
238 {
239         if (!strcasecmp(val, "NOT_INUSE"))
240                 return AST_DEVICE_NOT_INUSE;
241         else if (!strcasecmp(val, "INUSE"))
242                 return AST_DEVICE_INUSE;
243         else if (!strcasecmp(val, "BUSY"))
244                 return AST_DEVICE_BUSY;
245         else if (!strcasecmp(val, "INVALID"))
246                 return AST_DEVICE_INVALID;
247         else if (!strcasecmp(val, "UNAVAILABLE"))
248                 return AST_DEVICE_UNAVAILABLE;
249         else if (!strcasecmp(val, "RINGING"))
250                 return AST_DEVICE_RINGING;
251         else if (!strcasecmp(val, "RINGINUSE"))
252                 return AST_DEVICE_RINGINUSE;
253         else if (!strcasecmp(val, "ONHOLD"))
254                 return AST_DEVICE_ONHOLD;
255
256         return AST_DEVICE_UNKNOWN;
257 }
258
259 /*! \brief Find out if device is active in a call or not
260         \note find channels with the device's name in it
261         This function is only used for channels that does not implement
262         devicestate natively
263 */
264 enum ast_device_state ast_parse_device_state(const char *device)
265 {
266         struct ast_channel *chan;
267         char match[AST_CHANNEL_NAME];
268         enum ast_device_state res;
269
270         snprintf(match, sizeof(match), "%s-", device);
271
272         if (!(chan = ast_channel_get_by_name_prefix(match, strlen(match)))) {
273                 return AST_DEVICE_UNKNOWN;
274         }
275
276         res = (ast_channel_state(chan) == AST_STATE_RINGING) ? AST_DEVICE_RINGING : AST_DEVICE_INUSE;
277
278         chan = ast_channel_unref(chan);
279
280         return res;
281 }
282
283 static enum ast_device_state devstate_cached(const char *device)
284 {
285         RAII_VAR(struct stasis_message *, cached_msg, NULL, ao2_cleanup);
286         struct ast_device_state_message *device_state;
287
288         cached_msg = stasis_cache_get(ast_device_state_cache(), ast_device_state_message_type(), device);
289         if (!cached_msg) {
290                 return AST_DEVICE_UNKNOWN;
291         }
292         device_state = stasis_message_data(cached_msg);
293
294         return device_state->state;
295 }
296
297 /*! \brief Check device state through channel specific function or generic function */
298 static enum ast_device_state _ast_device_state(const char *device, int check_cache)
299 {
300         char *buf;
301         char *number;
302         const struct ast_channel_tech *chan_tech;
303         enum ast_device_state res;
304         /*! \brief Channel driver that provides device state */
305         char *tech;
306         /*! \brief Another provider of device state */
307         char *provider = NULL;
308
309         /* If the last known state is cached, just return that */
310         if (check_cache) {
311                 res = devstate_cached(device);
312                 if (res != AST_DEVICE_UNKNOWN) {
313                         return res;
314                 }
315         }
316
317         buf = ast_strdupa(device);
318         tech = strsep(&buf, "/");
319         if (!(number = buf)) {
320                 provider = strsep(&tech, ":");
321                 if (!tech) {
322                         return AST_DEVICE_INVALID;
323                 }
324                 /* We have a provider */
325                 number = tech;
326                 tech = NULL;
327
328                 ast_debug(3, "Checking if I can find provider for \"%s\" - number: %s\n", provider, number);
329                 return getproviderstate(provider, number);
330         }
331
332         ast_debug(4, "No provider found, checking channel drivers for %s - %s\n", tech, number);
333
334         if (!(chan_tech = ast_get_channel_tech(tech)))
335                 return AST_DEVICE_INVALID;
336
337         if (!(chan_tech->devicestate)) /* Does the channel driver support device state notification? */
338                 return ast_parse_device_state(device); /* No, try the generic function */
339
340         res = chan_tech->devicestate(number);
341
342         if (res != AST_DEVICE_UNKNOWN)
343                 return res;
344
345         res = ast_parse_device_state(device);
346
347         return res;
348 }
349
350 enum ast_device_state ast_device_state(const char *device)
351 {
352         /* This function is called from elsewhere in the code to find out the
353          * current state of a device.  Check the cache, first. */
354
355         return _ast_device_state(device, 1);
356 }
357
358 /*! \brief Add device state provider */
359 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback)
360 {
361         struct devstate_prov *devprov;
362
363         if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
364                 return -1;
365
366         devprov->callback = callback;
367         ast_copy_string(devprov->label, label, sizeof(devprov->label));
368
369         AST_RWLIST_WRLOCK(&devstate_provs);
370         AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list);
371         AST_RWLIST_UNLOCK(&devstate_provs);
372
373         return 0;
374 }
375
376 /*! \brief Remove device state provider */
377 int ast_devstate_prov_del(const char *label)
378 {
379         struct devstate_prov *devcb;
380         int res = -1;
381
382         AST_RWLIST_WRLOCK(&devstate_provs);
383         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
384                 if (!strcasecmp(devcb->label, label)) {
385                         AST_RWLIST_REMOVE_CURRENT(list);
386                         ast_free(devcb);
387                         res = 0;
388                         break;
389                 }
390         }
391         AST_RWLIST_TRAVERSE_SAFE_END;
392         AST_RWLIST_UNLOCK(&devstate_provs);
393
394         return res;
395 }
396
397 /*! \brief Get provider device state */
398 static int getproviderstate(const char *provider, const char *address)
399 {
400         struct devstate_prov *devprov;
401         int res = AST_DEVICE_INVALID;
402
403         AST_RWLIST_RDLOCK(&devstate_provs);
404         AST_RWLIST_TRAVERSE(&devstate_provs, devprov, list) {
405                 ast_debug(5, "Checking provider %s with %s\n", devprov->label, provider);
406
407                 if (!strcasecmp(devprov->label, provider)) {
408                         res = devprov->callback(address);
409                         break;
410                 }
411         }
412         AST_RWLIST_UNLOCK(&devstate_provs);
413
414         return res;
415 }
416
417 /*! Called by the state change thread to find out what the state is, and then
418  *  to queue up the state change event */
419 static void do_state_change(const char *device, enum ast_devstate_cache cachable)
420 {
421         enum ast_device_state state;
422
423         state = _ast_device_state(device, 0);
424
425         ast_debug(3, "Changing state for %s - state %d (%s)\n", device, state, ast_devstate2str(state));
426
427         ast_publish_device_state(device, state, cachable);
428 }
429
430 int ast_devstate_changed_literal(enum ast_device_state state, enum ast_devstate_cache cachable, const char *device)
431 {
432         struct state_change *change;
433
434         /*
435          * If we know the state change (how nice of the caller of this function!)
436          * then we can just generate a device state event.
437          *
438          * Otherwise, we do the following:
439          *   - Queue an event up to another thread that the state has changed
440          *   - In the processing thread, it calls the callback provided by the
441          *     device state provider (which may or may not be a channel driver)
442          *     to determine the state.
443          *   - If the device state provider does not know the state, or this is
444          *     for a channel and the channel driver does not implement a device
445          *     state callback, then we will look through the channel list to
446          *     see if we can determine a state based on active calls.
447          *   - Once a state has been determined, a device state event is generated.
448          */
449
450         if (state != AST_DEVICE_UNKNOWN) {
451                 ast_publish_device_state(device, state, cachable);
452         } else if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
453                 /* we could not allocate a change struct, or */
454                 /* there is no background thread, so process the change now */
455                 do_state_change(device, cachable);
456         } else {
457                 /* queue the change */
458                 strcpy(change->device, device);
459                 change->cachable = cachable;
460                 AST_LIST_LOCK(&state_changes);
461                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
462                 ast_cond_signal(&change_pending);
463                 AST_LIST_UNLOCK(&state_changes);
464         }
465
466         return 1;
467 }
468
469 int ast_device_state_changed_literal(const char *dev)
470 {
471         return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, dev);
472 }
473
474 int ast_devstate_changed(enum ast_device_state state, enum ast_devstate_cache cachable, const char *fmt, ...)
475 {
476         char buf[AST_MAX_EXTENSION];
477         va_list ap;
478
479         va_start(ap, fmt);
480         vsnprintf(buf, sizeof(buf), fmt, ap);
481         va_end(ap);
482
483         return ast_devstate_changed_literal(state, cachable, buf);
484 }
485
486 int ast_device_state_changed(const char *fmt, ...)
487 {
488         char buf[AST_MAX_EXTENSION];
489         va_list ap;
490
491         va_start(ap, fmt);
492         vsnprintf(buf, sizeof(buf), fmt, ap);
493         va_end(ap);
494
495         return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, buf);
496 }
497
498 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
499 static void *do_devstate_changes(void *data)
500 {
501         struct state_change *next, *current;
502
503         for (;;) {
504                 /* This basically pops off any state change entries, resets the list back to NULL, unlocks, and processes each state change */
505                 AST_LIST_LOCK(&state_changes);
506                 if (AST_LIST_EMPTY(&state_changes))
507                         ast_cond_wait(&change_pending, &state_changes.lock);
508                 next = AST_LIST_FIRST(&state_changes);
509                 AST_LIST_HEAD_INIT_NOLOCK(&state_changes);
510                 AST_LIST_UNLOCK(&state_changes);
511
512                 /* Process each state change */
513                 while ((current = next)) {
514                         next = AST_LIST_NEXT(current, list);
515                         do_state_change(current->device, current->cachable);
516                         ast_free(current);
517                 }
518         }
519
520         return NULL;
521 }
522
523 #define MAX_SERVERS 64
524 static int devstate_change_aggregator_cb(void *obj, void *arg, void *data, int flags)
525 {
526         struct stasis_message *msg = obj;
527         struct ast_devstate_aggregate *aggregate = arg;
528         char *device = data;
529         struct ast_device_state_message *device_state = stasis_message_data(msg);
530
531         if (!device_state->eid || strcmp(device, device_state->device)) {
532                 /* ignore aggregate states and devices that don't match */
533                 return 0;
534         }
535         ast_debug(1, "Adding per-server state of '%s' for '%s'\n",
536                 ast_devstate2str(device_state->state), device);
537         ast_devstate_aggregate_add(aggregate, device_state->state);
538         return 0;
539 }
540
541 static void device_state_dtor(void *obj)
542 {
543         struct ast_device_state_message *device_state = obj;
544         ast_string_field_free_memory(device_state);
545         ast_free(device_state->eid);
546 }
547
548 static struct ast_device_state_message *device_state_alloc(const char *device, enum ast_device_state state, enum ast_devstate_cache cachable, const struct ast_eid *eid)
549 {
550         RAII_VAR(struct ast_device_state_message *, new_device_state, ao2_alloc(sizeof(*new_device_state), device_state_dtor), ao2_cleanup);
551
552         if (!new_device_state || ast_string_field_init(new_device_state, 256)) {
553                 return NULL;
554         }
555
556         ast_string_field_set(new_device_state, device, device);
557         new_device_state->state = state;
558         new_device_state->cachable = cachable;
559
560         if (eid) {
561                 char eid_str[20];
562                 struct ast_str *cache_id = ast_str_alloca(256);
563
564                 new_device_state->eid = ast_malloc(sizeof(*eid));
565                 if (!new_device_state->eid) {
566                         return NULL;
567                 }
568
569                 *new_device_state->eid = *eid;
570                 ast_eid_to_str(eid_str, sizeof(eid_str), new_device_state->eid);
571                 ast_str_set(&cache_id, 0, "%s%s", eid_str, device);
572                 ast_string_field_set(new_device_state, cache_id, ast_str_buffer(cache_id));
573         } else {
574                 /* no EID makes this an aggregate state */
575                 ast_string_field_set(new_device_state, cache_id, device);
576         }
577
578         ao2_ref(new_device_state, +1);
579         return new_device_state;
580 }
581
582 static enum ast_device_state get_aggregate_state(char *device)
583 {
584         RAII_VAR(struct ao2_container *, cached, NULL, ao2_cleanup);
585         struct ast_devstate_aggregate aggregate;
586
587         ast_devstate_aggregate_init(&aggregate);
588
589         cached = stasis_cache_dump(ast_device_state_cache(), NULL);
590
591         ao2_callback_data(cached, OBJ_NODATA, devstate_change_aggregator_cb, &aggregate, device);
592
593         return ast_devstate_aggregate_result(&aggregate);
594 }
595
596 static int aggregate_state_changed(char *device, enum ast_device_state new_aggregate_state)
597 {
598         RAII_VAR(struct stasis_message *, cached_aggregate_msg, NULL, ao2_cleanup);
599         struct ast_device_state_message *cached_aggregate_device_state;
600
601         cached_aggregate_msg = stasis_cache_get(ast_device_state_cache(), ast_device_state_message_type(), device);
602         if (!cached_aggregate_msg) {
603                 return 1;
604         }
605
606         cached_aggregate_device_state = stasis_message_data(cached_aggregate_msg);
607         if (cached_aggregate_device_state->state == new_aggregate_state) {
608                 return 0;
609         }
610         return 1;
611 }
612
613 static void devstate_change_collector_cb(void *data, struct stasis_subscription *sub, struct stasis_topic *topic, struct stasis_message *msg)
614 {
615         enum ast_device_state aggregate_state;
616         char *device;
617         struct ast_device_state_message *device_state;
618         RAII_VAR(struct stasis_message *, new_aggregate_msg, NULL, ao2_cleanup);
619         RAII_VAR(struct ast_device_state_message *, new_aggregate_state, NULL, ao2_cleanup);
620
621         if (stasis_cache_update_type() == stasis_message_type(msg)) {
622                 struct stasis_cache_update *update = stasis_message_data(msg);
623                 if (!update->new_snapshot) {
624                         return;
625                 }
626                 msg = update->new_snapshot;
627         }
628
629         if (ast_device_state_message_type() != stasis_message_type(msg)) {
630                 return;
631         }
632
633         device_state = stasis_message_data(msg);
634
635         if (!device_state->eid) {
636                 /* ignore aggregate messages */
637                 return;
638         }
639
640         device = ast_strdupa(device_state->device);
641         ast_debug(1, "Processing device state change for '%s'\n", device);
642
643         if (device_state->cachable == AST_DEVSTATE_NOT_CACHABLE) {
644                 /* if it's not cachable, there will be no aggregate state to get
645                  * and this should be passed through */
646                 aggregate_state = device_state->state;
647         } else {
648
649                 aggregate_state = get_aggregate_state(device);
650                 ast_debug(1, "Aggregate devstate result is '%s' for '%s'\n",
651                         ast_devstate2str(aggregate_state), device);
652
653                 if (!aggregate_state_changed(device, aggregate_state)) {
654                         /* No change since last reported device state */
655                         ast_debug(1, "Aggregate state for device '%s' has not changed from '%s'\n",
656                                 device, ast_devstate2str(aggregate_state));
657                         return;
658                 }
659         }
660
661         ast_debug(1, "Aggregate state for device '%s' has changed to '%s'\n",
662                 device, ast_devstate2str(aggregate_state));
663
664         ast_publish_device_state_full(device, aggregate_state, device_state->cachable, NULL);
665 }
666
667 /*! \brief Initialize the device state engine in separate thread */
668 int ast_device_state_engine_init(void)
669 {
670         ast_cond_init(&change_pending, NULL);
671         if (ast_pthread_create_background(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
672                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
673                 return -1;
674         }
675
676         return 0;
677 }
678
679 void ast_devstate_aggregate_init(struct ast_devstate_aggregate *agg)
680 {
681         memset(agg, 0, sizeof(*agg));
682         agg->state = AST_DEVICE_INVALID;
683 }
684
685 void ast_devstate_aggregate_add(struct ast_devstate_aggregate *agg, enum ast_device_state state)
686 {
687         static enum ast_device_state state_order[] = {
688                 1, /* AST_DEVICE_UNKNOWN */
689                 3, /* AST_DEVICE_NOT_INUSE */
690                 6, /* AST_DEVICE_INUSE */
691                 7, /* AST_DEVICE_BUSY */
692                 0, /* AST_DEVICE_INVALID */
693                 2, /* AST_DEVICE_UNAVAILABLE */
694                 5, /* AST_DEVICE_RINGING */
695                 8, /* AST_DEVICE_RINGINUSE */
696                 4, /* AST_DEVICE_ONHOLD */
697         };
698
699         if (state == AST_DEVICE_RINGING) {
700                 agg->ringing = 1;
701         } else if (state == AST_DEVICE_INUSE || state == AST_DEVICE_ONHOLD || state == AST_DEVICE_BUSY) {
702                 agg->inuse = 1;
703         }
704
705         if (agg->ringing && agg->inuse) {
706                 agg->state = AST_DEVICE_RINGINUSE;
707         } else if (state_order[state] > state_order[agg->state]) {
708                 agg->state = state;
709         }
710 }
711
712 enum ast_device_state ast_devstate_aggregate_result(struct ast_devstate_aggregate *agg)
713 {
714         return agg->state;
715 }
716
717 struct stasis_topic *ast_device_state_topic_all(void)
718 {
719         return device_state_topic_all;
720 }
721
722 struct stasis_cache *ast_device_state_cache(void)
723 {
724         return device_state_cache;
725 }
726
727 struct stasis_topic *ast_device_state_topic_cached(void)
728 {
729         return stasis_caching_get_topic(device_state_topic_cached);
730 }
731
732 struct stasis_topic *ast_device_state_topic(const char *device)
733 {
734         return stasis_topic_pool_get_topic(device_state_topic_pool, device);
735 }
736
737 int ast_publish_device_state_full(
738                         const char *device,
739                         enum ast_device_state state,
740                         enum ast_devstate_cache cachable,
741                         struct ast_eid *eid)
742 {
743         RAII_VAR(struct ast_device_state_message *, device_state, NULL, ao2_cleanup);
744         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
745         struct stasis_topic *device_specific_topic;
746
747         ast_assert(!ast_strlen_zero(device));
748
749         device_state = device_state_alloc(device, state, cachable, eid);
750         if (!device_state) {
751                 return -1;
752         }
753
754         message = stasis_message_create(ast_device_state_message_type(), device_state);
755
756         device_specific_topic = ast_device_state_topic(device);
757         if (!device_specific_topic) {
758                 return -1;
759         }
760
761         stasis_publish(device_specific_topic, message);
762         return 0;
763 }
764
765 static const char *device_state_get_id(struct stasis_message *message)
766 {
767         struct ast_device_state_message *device_state;
768         if (ast_device_state_message_type() != stasis_message_type(message)) {
769                 return NULL;
770         }
771
772         device_state = stasis_message_data(message);
773         if (device_state->cachable == AST_DEVSTATE_NOT_CACHABLE) {
774                 return NULL;
775         }
776
777         return device_state->cache_id;
778 }
779
780 static void devstate_cleanup(void)
781 {
782         devstate_message_sub = stasis_unsubscribe_and_join(devstate_message_sub);
783         ao2_cleanup(device_state_topic_all);
784         device_state_topic_all = NULL;
785         ao2_cleanup(device_state_cache);
786         device_state_cache = NULL;
787         device_state_topic_cached = stasis_caching_unsubscribe_and_join(device_state_topic_cached);
788         STASIS_MESSAGE_TYPE_CLEANUP(ast_device_state_message_type);
789         ao2_cleanup(device_state_topic_pool);
790         device_state_topic_pool = NULL;
791 }
792
793 int devstate_init(void)
794 {
795         ast_register_cleanup(devstate_cleanup);
796
797         if (STASIS_MESSAGE_TYPE_INIT(ast_device_state_message_type) != 0) {
798                 return -1;
799         }
800         device_state_topic_all = stasis_topic_create("ast_device_state_topic");
801         if (!device_state_topic_all) {
802                 return -1;
803         }
804         device_state_cache = stasis_cache_create(device_state_get_id);
805         if (!device_state_cache) {
806                 return -1;
807         }
808         device_state_topic_cached = stasis_caching_topic_create(device_state_topic_all, device_state_cache);
809         if (!device_state_topic_cached) {
810                 return -1;
811         }
812         device_state_topic_pool = stasis_topic_pool_create(ast_device_state_topic_all());
813         if (!device_state_topic_pool) {
814                 return -1;
815         }
816
817         devstate_message_sub = stasis_subscribe(ast_device_state_topic_cached(), devstate_change_collector_cb, NULL);
818
819         if (!devstate_message_sub) {
820                 ast_log(LOG_ERROR, "Failed to create subscription for the device state change collector\n");
821                 return -1;
822         }
823
824         return 0;
825 }