actually use the cache_cache argument
[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_jabber.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 #include "asterisk.h"
117
118 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
119
120 #include "asterisk/_private.h"
121 #include "asterisk/channel.h"
122 #include "asterisk/utils.h"
123 #include "asterisk/lock.h"
124 #include "asterisk/linkedlists.h"
125 #include "asterisk/devicestate.h"
126 #include "asterisk/pbx.h"
127 #include "asterisk/app.h"
128 #include "asterisk/event.h"
129
130 /*! \brief Device state strings for printing */
131 static const char *devstatestring[] = {
132         /* 0 AST_DEVICE_UNKNOWN */      "Unknown",      /*!< Valid, but unknown state */
133         /* 1 AST_DEVICE_NOT_INUSE */    "Not in use",   /*!< Not used */
134         /* 2 AST_DEVICE IN USE */       "In use",       /*!< In use */
135         /* 3 AST_DEVICE_BUSY */         "Busy",         /*!< Busy */
136         /* 4 AST_DEVICE_INVALID */      "Invalid",      /*!< Invalid - not known to Asterisk */
137         /* 5 AST_DEVICE_UNAVAILABLE */  "Unavailable",  /*!< Unavailable (not registred) */
138         /* 6 AST_DEVICE_RINGING */      "Ringing",      /*!< Ring, ring, ring */
139         /* 7 AST_DEVICE_RINGINUSE */    "Ring+Inuse",   /*!< Ring and in use */
140         /* 8 AST_DEVICE_ONHOLD */       "On Hold"       /*!< On Hold */
141 };
142
143 /*!\brief Mapping for channel states to device states */
144 static const struct chan2dev {
145         enum ast_channel_state chan;
146         enum ast_device_state dev;
147 } chan2dev[] = {
148         { AST_STATE_DOWN,            AST_DEVICE_NOT_INUSE },
149         { AST_STATE_RESERVED,        AST_DEVICE_INUSE },
150         { AST_STATE_OFFHOOK,         AST_DEVICE_INUSE },
151         { AST_STATE_DIALING,         AST_DEVICE_INUSE },
152         { AST_STATE_RING,            AST_DEVICE_INUSE },
153         { AST_STATE_RINGING,         AST_DEVICE_RINGING },
154         { AST_STATE_UP,              AST_DEVICE_INUSE },
155         { AST_STATE_BUSY,            AST_DEVICE_BUSY },
156         { AST_STATE_DIALING_OFFHOOK, AST_DEVICE_INUSE },
157         { AST_STATE_PRERING,         AST_DEVICE_RINGING },
158         { -100,                      -100 },
159 };
160
161 /*! \brief  A device state provider (not a channel) */
162 struct devstate_prov {
163         char label[40];
164         ast_devstate_prov_cb_type callback;
165         AST_RWLIST_ENTRY(devstate_prov) list;
166 };
167
168 /*! \brief A list of providers */
169 static AST_RWLIST_HEAD_STATIC(devstate_provs, devstate_prov);
170
171 struct state_change {
172         AST_LIST_ENTRY(state_change) list;
173         char device[1];
174 };
175
176 /*! \brief The state change queue. State changes are queued
177         for processing by a separate thread */
178 static AST_LIST_HEAD_STATIC(state_changes, state_change);
179
180 /*! \brief The device state change notification thread */
181 static pthread_t change_thread = AST_PTHREADT_NULL;
182
183 /*! \brief Flag for the queue */
184 static ast_cond_t change_pending;
185
186 struct devstate_change {
187         AST_LIST_ENTRY(devstate_change) entry;
188         uint32_t state;
189         struct ast_eid eid;
190         char device[1];
191 };
192
193 struct {
194         pthread_t thread;
195         struct ast_event_sub *event_sub;
196         ast_cond_t cond;
197         ast_mutex_t lock;
198         AST_LIST_HEAD_NOLOCK(, devstate_change) devstate_change_q;
199 } devstate_collector = {
200         .thread = AST_PTHREADT_NULL,
201 };
202
203 /* Forward declarations */
204 static int getproviderstate(const char *provider, const char *address);
205
206 /*! \brief Find devicestate as text message for output */
207 const char *devstate2str(enum ast_device_state devstate) 
208 {
209         return devstatestring[devstate];
210 }
211
212 enum ast_device_state ast_state_chan2dev(enum ast_channel_state chanstate)
213 {
214         int i;
215         chanstate &= 0xFFFF;
216         for (i = 0; chan2dev[i].chan != -100; i++) {
217                 if (chan2dev[i].chan == chanstate) {
218                         return chan2dev[i].dev;
219                 }
220         }
221         return AST_DEVICE_UNKNOWN;
222 }
223
224 const char *ast_devstate_str(enum ast_device_state state)
225 {
226         const char *res = "UNKNOWN";
227
228         switch (state) {
229         case AST_DEVICE_UNKNOWN:
230                 break;
231         case AST_DEVICE_NOT_INUSE:
232                 res = "NOT_INUSE";
233                 break;
234         case AST_DEVICE_INUSE:
235                 res = "INUSE";
236                 break;
237         case AST_DEVICE_BUSY:
238                 res = "BUSY";
239                 break;
240         case AST_DEVICE_INVALID:
241                 res = "INVALID";
242                 break;
243         case AST_DEVICE_UNAVAILABLE:
244                 res = "UNAVAILABLE";
245                 break;
246         case AST_DEVICE_RINGING:
247                 res = "RINGING";
248                 break;
249         case AST_DEVICE_RINGINUSE:
250                 res = "RINGINUSE";
251                 break;
252         case AST_DEVICE_ONHOLD:
253                 res = "ONHOLD";
254                 break;
255         }
256
257         return res;
258 }
259
260 enum ast_device_state ast_devstate_val(const char *val)
261 {
262         if (!strcasecmp(val, "NOT_INUSE"))
263                 return AST_DEVICE_NOT_INUSE;
264         else if (!strcasecmp(val, "INUSE"))
265                 return AST_DEVICE_INUSE;
266         else if (!strcasecmp(val, "BUSY"))
267                 return AST_DEVICE_BUSY;
268         else if (!strcasecmp(val, "INVALID"))
269                 return AST_DEVICE_INVALID;
270         else if (!strcasecmp(val, "UNAVAILABLE"))
271                 return AST_DEVICE_UNAVAILABLE;
272         else if (!strcasecmp(val, "RINGING"))
273                 return AST_DEVICE_RINGING;
274         else if (!strcasecmp(val, "RINGINUSE"))
275                 return AST_DEVICE_RINGINUSE;
276         else if (!strcasecmp(val, "ONHOLD"))
277                 return AST_DEVICE_ONHOLD;
278
279         return AST_DEVICE_UNKNOWN;
280 }
281
282 /*! \brief Find out if device is active in a call or not 
283         \note find channels with the device's name in it
284         This function is only used for channels that does not implement 
285         devicestate natively
286 */
287 enum ast_device_state ast_parse_device_state(const char *device)
288 {
289         struct ast_channel *chan;
290         char match[AST_CHANNEL_NAME];
291         enum ast_device_state res;
292
293         ast_copy_string(match, device, sizeof(match)-1);
294         strcat(match, "-");
295         chan = ast_get_channel_by_name_prefix_locked(match, strlen(match));
296
297         if (!chan)
298                 return AST_DEVICE_UNKNOWN;
299
300         if (chan->_state == AST_STATE_RINGING)
301                 res = AST_DEVICE_RINGING;
302         else
303                 res = AST_DEVICE_INUSE;
304         
305         ast_channel_unlock(chan);
306
307         return res;
308 }
309
310 static enum ast_device_state devstate_cached(const char *device)
311 {
312         enum ast_device_state res = AST_DEVICE_UNKNOWN;
313         struct ast_event *event;
314
315         event = ast_event_get_cached(AST_EVENT_DEVICE_STATE,
316                 AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device,
317                 AST_EVENT_IE_END);
318
319         if (!event)
320                 return res;
321
322         res = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
323
324         ast_event_destroy(event);
325
326         return res;
327 }
328
329 /*! \brief Check device state through channel specific function or generic function */
330 static enum ast_device_state _ast_device_state(const char *device, int check_cache)
331 {
332         char *buf;
333         char *number;
334         const struct ast_channel_tech *chan_tech;
335         enum ast_device_state res;
336         /*! \brief Channel driver that provides device state */
337         char *tech;
338         /*! \brief Another provider of device state */
339         char *provider = NULL;
340
341         /* If the last known state is cached, just return that */
342         if (check_cache) {
343                 res = devstate_cached(device);
344                 if (res != AST_DEVICE_UNKNOWN) {
345                         return res;
346                 }
347         }
348
349         buf = ast_strdupa(device);
350         tech = strsep(&buf, "/");
351         if (!(number = buf)) {
352                 if (!(provider = strsep(&tech, ":")))
353                         return AST_DEVICE_INVALID;
354                 /* We have a provider */
355                 number = tech;
356                 tech = NULL;
357         }
358
359         if (provider)  {
360                 ast_debug(3, "Checking if I can find provider for \"%s\" - number: %s\n", provider, number);
361                 return getproviderstate(provider, number);
362         }
363
364         ast_debug(4, "No provider found, checking channel drivers for %s - %s\n", tech, number);
365
366         if (!(chan_tech = ast_get_channel_tech(tech)))
367                 return AST_DEVICE_INVALID;
368
369         if (!(chan_tech->devicestate)) /* Does the channel driver support device state notification? */
370                 return ast_parse_device_state(device); /* No, try the generic function */
371
372         res = chan_tech->devicestate(number);
373
374         if (res != AST_DEVICE_UNKNOWN)
375                 return res;
376
377         res = ast_parse_device_state(device);
378
379         if (res == AST_DEVICE_UNKNOWN)
380                 return AST_DEVICE_NOT_INUSE;
381
382         return res;
383 }
384
385 enum ast_device_state ast_device_state(const char *device)
386 {
387         /* This function is called from elsewhere in the code to find out the
388          * current state of a device.  Check the cache, first. */
389
390         return _ast_device_state(device, 1);
391 }
392
393 /*! \brief Add device state provider */
394 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback)
395 {
396         struct devstate_prov *devprov;
397
398         if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
399                 return -1;
400
401         devprov->callback = callback;
402         ast_copy_string(devprov->label, label, sizeof(devprov->label));
403
404         AST_RWLIST_WRLOCK(&devstate_provs);
405         AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list);
406         AST_RWLIST_UNLOCK(&devstate_provs);
407
408         return 0;
409 }
410
411 /*! \brief Remove device state provider */
412 int ast_devstate_prov_del(const char *label)
413 {
414         struct devstate_prov *devcb;
415         int res = -1;
416
417         AST_RWLIST_WRLOCK(&devstate_provs);
418         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
419                 if (!strcasecmp(devcb->label, label)) {
420                         AST_RWLIST_REMOVE_CURRENT(list);
421                         ast_free(devcb);
422                         res = 0;
423                         break;
424                 }
425         }
426         AST_RWLIST_TRAVERSE_SAFE_END;
427         AST_RWLIST_UNLOCK(&devstate_provs);
428
429         return res;
430 }
431
432 /*! \brief Get provider device state */
433 static int getproviderstate(const char *provider, const char *address)
434 {
435         struct devstate_prov *devprov;
436         int res = AST_DEVICE_INVALID;
437
438         AST_RWLIST_RDLOCK(&devstate_provs);
439         AST_RWLIST_TRAVERSE(&devstate_provs, devprov, list) {
440                 ast_debug(5, "Checking provider %s with %s\n", devprov->label, provider);
441
442                 if (!strcasecmp(devprov->label, provider)) {
443                         res = devprov->callback(address);
444                         break;
445                 }
446         }
447         AST_RWLIST_UNLOCK(&devstate_provs);
448
449         return res;
450 }
451
452 static void devstate_event(const char *device, enum ast_device_state state)
453 {
454         struct ast_event *event;
455
456         ast_debug(3, "device '%s' state '%d'\n", device, state);
457
458         if (!(event = ast_event_new(AST_EVENT_DEVICE_STATE_CHANGE,
459                         AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device,
460                         AST_EVENT_IE_STATE, AST_EVENT_IE_PLTYPE_UINT, state,
461                         AST_EVENT_IE_END))) {
462                 return;
463         }
464
465         /* Cache this event, replacing an event in the cache with the same
466          * device name if it exists. */
467         ast_event_queue_and_cache(event,
468                 AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR,
469                 AST_EVENT_IE_EID, AST_EVENT_IE_PLTYPE_RAW, sizeof(struct ast_eid),
470                 AST_EVENT_IE_END);
471 }
472
473 /*! Called by the state change thread to find out what the state is, and then
474  *  to queue up the state change event */
475 static void do_state_change(const char *device)
476 {
477         enum ast_device_state state;
478
479         state = _ast_device_state(device, 0);
480
481         ast_debug(3, "Changing state for %s - state %d (%s)\n", device, state, devstate2str(state));
482
483         devstate_event(device, state);
484 }
485
486 int ast_devstate_changed_literal(enum ast_device_state state, const char *device)
487 {
488         struct state_change *change;
489
490         /* 
491          * If we know the state change (how nice of the caller of this function!)
492          * then we can just generate a device state event. 
493          *
494          * Otherwise, we do the following:
495          *   - Queue an event up to another thread that the state has changed
496          *   - In the processing thread, it calls the callback provided by the
497          *     device state provider (which may or may not be a channel driver)
498          *     to determine the state.
499          *   - If the device state provider does not know the state, or this is
500          *     for a channel and the channel driver does not implement a device
501          *     state callback, then we will look through the channel list to
502          *     see if we can determine a state based on active calls.
503          *   - Once a state has been determined, a device state event is generated.
504          */
505
506         if (state != AST_DEVICE_UNKNOWN) {
507                 devstate_event(device, state);
508         } else if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
509                 /* we could not allocate a change struct, or */
510                 /* there is no background thread, so process the change now */
511                 do_state_change(device);
512         } else {
513                 /* queue the change */
514                 strcpy(change->device, device);
515                 AST_LIST_LOCK(&state_changes);
516                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
517                 ast_cond_signal(&change_pending);
518                 AST_LIST_UNLOCK(&state_changes);
519         }
520
521         return 1;
522 }
523
524 int ast_device_state_changed_literal(const char *dev)
525 {
526         return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, dev);
527 }
528
529 int ast_devstate_changed(enum ast_device_state state, const char *fmt, ...) 
530 {
531         char buf[AST_MAX_EXTENSION];
532         va_list ap;
533
534         va_start(ap, fmt);
535         vsnprintf(buf, sizeof(buf), fmt, ap);
536         va_end(ap);
537
538         return ast_devstate_changed_literal(state, buf);
539 }
540
541 /*! \brief Accept change notification, add it to change queue */
542 int ast_device_state_changed(const char *fmt, ...) 
543 {
544         char buf[AST_MAX_EXTENSION];
545         va_list ap;
546
547         va_start(ap, fmt);
548         vsnprintf(buf, sizeof(buf), fmt, ap);
549         va_end(ap);
550
551         return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, buf);
552 }
553
554 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
555 static void *do_devstate_changes(void *data)
556 {
557         struct state_change *next, *current;
558
559         for (;;) {
560                 /* This basically pops off any state change entries, resets the list back to NULL, unlocks, and processes each state change */
561                 AST_LIST_LOCK(&state_changes);
562                 if (AST_LIST_EMPTY(&state_changes))
563                         ast_cond_wait(&change_pending, &state_changes.lock);
564                 next = AST_LIST_FIRST(&state_changes);
565                 AST_LIST_HEAD_INIT_NOLOCK(&state_changes);
566                 AST_LIST_UNLOCK(&state_changes);
567
568                 /* Process each state change */
569                 while ((current = next)) {
570                         next = AST_LIST_NEXT(current, list);
571                         do_state_change(current->device);
572                         ast_free(current);
573                 }
574         }
575
576         return NULL;
577 }
578
579 static void destroy_devstate_change(struct devstate_change *sc)
580 {
581         ast_free(sc);
582 }
583
584 #define MAX_SERVERS 64
585 struct change_collection {
586         struct devstate_change states[MAX_SERVERS];
587         size_t num_states;
588 };
589
590 static void devstate_cache_cb(const struct ast_event *event, void *data)
591 {
592         struct change_collection *collection = data;
593         int i;
594         const struct ast_eid *eid;
595
596         if (collection->num_states == ARRAY_LEN(collection->states)) {
597                 ast_log(LOG_ERROR, "More per-server state values than we have room for (MAX_SERVERS is %d)\n",
598                         MAX_SERVERS);
599                 return;
600         }
601
602         if (!(eid = ast_event_get_ie_raw(event, AST_EVENT_IE_EID))) {
603                 ast_log(LOG_ERROR, "Device state change event with no EID\n");
604                 return;
605         }
606
607         i = collection->num_states;
608
609         collection->states[i].state = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
610         collection->states[i].eid = *eid;
611
612         collection->num_states++;
613 }
614
615 static void process_collection(const char *device, struct change_collection *collection)
616 {
617         int i;
618         struct ast_devstate_aggregate agg;
619         enum ast_device_state state;
620         struct ast_event *event;
621
622         ast_devstate_aggregate_init(&agg);
623
624         for (i = 0; i < collection->num_states; i++) {
625                 ast_debug(1, "Adding per-server state of '%s' for '%s'\n", 
626                         devstate2str(collection->states[i].state), device);
627                 ast_devstate_aggregate_add(&agg, collection->states[i].state);
628         }
629
630         state = ast_devstate_aggregate_result(&agg);
631
632         ast_debug(1, "Aggregate devstate result is %d\n", state);
633
634         event = ast_event_get_cached(AST_EVENT_DEVICE_STATE,
635                 AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device,
636                 AST_EVENT_IE_END);
637         
638         if (event) {
639                 enum ast_device_state old_state;
640
641                 old_state = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
642                 
643                 ast_event_destroy(event);
644
645                 if (state == old_state) {
646                         /* No change since last reported device state */
647                         ast_debug(1, "Aggregate state for device '%s' has not changed from '%s'\n",
648                                 device, devstate2str(state));
649                         return;
650                 }
651         }
652
653         ast_debug(1, "Aggregate state for device '%s' has changed to '%s'\n",
654                 device, devstate2str(state));
655
656         event = ast_event_new(AST_EVENT_DEVICE_STATE,
657                 AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device,
658                 AST_EVENT_IE_STATE, AST_EVENT_IE_PLTYPE_UINT, state,
659                 AST_EVENT_IE_END);
660         
661         if (!event)
662                 return;
663
664         ast_event_queue_and_cache(event,
665                 AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR,
666                 AST_EVENT_IE_END);
667 }
668
669 static void handle_devstate_change(struct devstate_change *sc)
670 {
671         struct ast_event_sub *tmp_sub;
672         struct change_collection collection = {
673                 .num_states = 0,
674         };
675
676         ast_debug(1, "Processing device state change for '%s'\n", sc->device);
677
678         if (!(tmp_sub = ast_event_subscribe_new(AST_EVENT_DEVICE_STATE_CHANGE, devstate_cache_cb, &collection))) {
679                 ast_log(LOG_ERROR, "Failed to create subscription\n");
680                 return;
681         }
682
683         if (ast_event_sub_append_ie_str(tmp_sub, AST_EVENT_IE_DEVICE, sc->device)) {
684                 ast_log(LOG_ERROR, "Failed to append device IE\n");
685                 ast_event_sub_destroy(tmp_sub);
686                 return;
687         }
688
689         /* Populate the collection of device states from the cache */
690         ast_event_dump_cache(tmp_sub);
691
692         process_collection(sc->device, &collection);
693
694         ast_event_sub_destroy(tmp_sub);
695 }
696
697 static void *run_devstate_collector(void *data)
698 {
699         for (;;) {
700                 struct devstate_change *sc;
701
702                 ast_mutex_lock(&devstate_collector.lock);
703                 while (!(sc = AST_LIST_REMOVE_HEAD(&devstate_collector.devstate_change_q, entry)))
704                         ast_cond_wait(&devstate_collector.cond, &devstate_collector.lock);
705                 ast_mutex_unlock(&devstate_collector.lock);
706
707                 handle_devstate_change(sc);
708
709                 destroy_devstate_change(sc);
710         }
711
712         return NULL;
713 }
714
715 static void devstate_change_collector_cb(const struct ast_event *event, void *data)
716 {
717         struct devstate_change *sc;
718         const char *device;
719         const struct ast_eid *eid;
720         uint32_t state;
721
722         device = ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE);
723         eid = ast_event_get_ie_raw(event, AST_EVENT_IE_EID);
724         state = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
725
726         if (ast_strlen_zero(device) || !eid) {
727                 ast_log(LOG_ERROR, "Invalid device state change event received\n");
728                 return;
729         }
730
731         if (!(sc = ast_calloc(1, sizeof(*sc) + strlen(device))))
732                 return;
733
734         strcpy(sc->device, device);
735         sc->eid = *eid;
736         sc->state = state;
737
738         ast_mutex_lock(&devstate_collector.lock);
739         AST_LIST_INSERT_TAIL(&devstate_collector.devstate_change_q, sc, entry);
740         ast_cond_signal(&devstate_collector.cond);
741         ast_mutex_unlock(&devstate_collector.lock);
742 }
743
744 /*! \brief Initialize the device state engine in separate thread */
745 int ast_device_state_engine_init(void)
746 {
747         devstate_collector.event_sub = ast_event_subscribe(AST_EVENT_DEVICE_STATE_CHANGE,
748                 devstate_change_collector_cb, NULL, AST_EVENT_IE_END);
749
750         if (!devstate_collector.event_sub) {
751                 ast_log(LOG_ERROR, "Failed to create subscription for the device state change collector\n");
752                 return -1;
753         }
754
755         ast_mutex_init(&devstate_collector.lock);
756         ast_cond_init(&devstate_collector.cond, NULL);
757         if (ast_pthread_create_background(&devstate_collector.thread, NULL, run_devstate_collector, NULL) < 0) {
758                 ast_log(LOG_ERROR, "Unable to start device state collector thread.\n");
759                 return -1;
760         }
761
762         ast_cond_init(&change_pending, NULL);
763         if (ast_pthread_create_background(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
764                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
765                 return -1;
766         }
767
768         return 0;
769 }
770
771 void ast_devstate_aggregate_init(struct ast_devstate_aggregate *agg)
772 {
773         memset(agg, 0, sizeof(*agg));
774
775         agg->all_unavail = 1;
776         agg->all_busy = 1;
777         agg->all_free = 1;
778         agg->all_on_hold = 1;
779 }
780
781 void ast_devstate_aggregate_add(struct ast_devstate_aggregate *agg, enum ast_device_state state)
782 {
783         switch (state) {
784         case AST_DEVICE_NOT_INUSE:
785                 agg->all_unavail = 0;
786                 agg->all_busy = 0;
787                 agg->all_on_hold = 0;
788                 break;
789         case AST_DEVICE_INUSE:
790                 agg->in_use = 1;
791                 agg->all_busy = 0;
792                 agg->all_unavail = 0;
793                 agg->all_free = 0;
794                 agg->all_on_hold = 0;
795                 break;
796         case AST_DEVICE_RINGING:
797                 agg->ring = 1;
798                 agg->all_busy = 0;
799                 agg->all_unavail = 0;
800                 agg->all_free = 0;
801                 agg->all_on_hold = 0;
802                 break;
803         case AST_DEVICE_RINGINUSE:
804                 agg->in_use = 1;
805                 agg->ring = 1;
806                 agg->all_busy = 0;
807                 agg->all_unavail = 0;
808                 agg->all_free = 0;
809                 agg->all_on_hold = 0;
810                 break;
811         case AST_DEVICE_ONHOLD:
812                 agg->all_unavail = 0;
813                 agg->all_free = 0;
814                 break;
815         case AST_DEVICE_BUSY:
816                 agg->all_unavail = 0;
817                 agg->all_free = 0;
818                 agg->all_on_hold = 0;
819                 agg->busy = 1;
820                 break;
821         case AST_DEVICE_UNAVAILABLE:
822         case AST_DEVICE_INVALID:
823                 agg->all_busy = 0;
824                 agg->all_free = 0;
825                 agg->all_on_hold = 0;
826                 break;
827         case AST_DEVICE_UNKNOWN:
828                 break;
829         }
830 }
831
832 enum ast_device_state ast_devstate_aggregate_result(struct ast_devstate_aggregate *agg)
833 {
834         if (agg->all_free)
835                 return AST_DEVICE_NOT_INUSE;
836         
837         if (agg->all_on_hold)
838                 return AST_DEVICE_ONHOLD;
839         
840         if (agg->all_busy)
841                 return AST_DEVICE_BUSY;
842
843         if (agg->all_unavail)
844                 return AST_DEVICE_UNAVAILABLE;
845         
846         if (agg->ring)
847                 return agg->in_use ? AST_DEVICE_RINGINUSE : AST_DEVICE_RINGING;
848
849         if (agg->in_use)
850                 return AST_DEVICE_INUSE;
851
852         if (agg->busy)
853                 return AST_DEVICE_BUSY;
854         
855         return AST_DEVICE_NOT_INUSE;
856 }
857