9a2881a3ffb5f9ed28b51120f06ce391d9e98dc4
[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 enum ast_device_state ast_device_state(const char *device)
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         res = devstate_cached(device);
343         if (res != AST_DEVICE_UNKNOWN)
344                 return res;
345
346         buf = ast_strdupa(device);
347         tech = strsep(&buf, "/");
348         if (!(number = buf)) {
349                 if (!(provider = strsep(&tech, ":")))
350                         return AST_DEVICE_INVALID;
351                 /* We have a provider */
352                 number = tech;
353                 tech = NULL;
354         }
355
356         if (provider)  {
357                 ast_debug(3, "Checking if I can find provider for \"%s\" - number: %s\n", provider, number);
358                 return getproviderstate(provider, number);
359         }
360
361         ast_debug(4, "No provider found, checking channel drivers for %s - %s\n", tech, number);
362
363         if (!(chan_tech = ast_get_channel_tech(tech)))
364                 return AST_DEVICE_INVALID;
365
366         if (!(chan_tech->devicestate)) /* Does the channel driver support device state notification? */
367                 return ast_parse_device_state(device); /* No, try the generic function */
368
369         res = chan_tech->devicestate(number);
370
371         if (res != AST_DEVICE_UNKNOWN)
372                 return res;
373
374         res = ast_parse_device_state(device);
375
376         if (res == AST_DEVICE_UNKNOWN)
377                 return AST_DEVICE_NOT_INUSE;
378
379         return res;
380 }
381
382 /*! \brief Add device state provider */
383 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback)
384 {
385         struct devstate_prov *devprov;
386
387         if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
388                 return -1;
389
390         devprov->callback = callback;
391         ast_copy_string(devprov->label, label, sizeof(devprov->label));
392
393         AST_RWLIST_WRLOCK(&devstate_provs);
394         AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list);
395         AST_RWLIST_UNLOCK(&devstate_provs);
396
397         return 0;
398 }
399
400 /*! \brief Remove device state provider */
401 int ast_devstate_prov_del(const char *label)
402 {
403         struct devstate_prov *devcb;
404         int res = -1;
405
406         AST_RWLIST_WRLOCK(&devstate_provs);
407         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
408                 if (!strcasecmp(devcb->label, label)) {
409                         AST_RWLIST_REMOVE_CURRENT(list);
410                         ast_free(devcb);
411                         res = 0;
412                         break;
413                 }
414         }
415         AST_RWLIST_TRAVERSE_SAFE_END;
416         AST_RWLIST_UNLOCK(&devstate_provs);
417
418         return res;
419 }
420
421 /*! \brief Get provider device state */
422 static int getproviderstate(const char *provider, const char *address)
423 {
424         struct devstate_prov *devprov;
425         int res = AST_DEVICE_INVALID;
426
427         AST_RWLIST_RDLOCK(&devstate_provs);
428         AST_RWLIST_TRAVERSE(&devstate_provs, devprov, list) {
429                 ast_debug(5, "Checking provider %s with %s\n", devprov->label, provider);
430
431                 if (!strcasecmp(devprov->label, provider)) {
432                         res = devprov->callback(address);
433                         break;
434                 }
435         }
436         AST_RWLIST_UNLOCK(&devstate_provs);
437
438         return res;
439 }
440
441 static void devstate_event(const char *device, enum ast_device_state state)
442 {
443         struct ast_event *event;
444
445         ast_debug(3, "device '%s' state '%d'\n", device, state);
446
447         if (!(event = ast_event_new(AST_EVENT_DEVICE_STATE_CHANGE,
448                         AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device,
449                         AST_EVENT_IE_STATE, AST_EVENT_IE_PLTYPE_UINT, state,
450                         AST_EVENT_IE_END))) {
451                 return;
452         }
453
454         /* Cache this event, replacing an event in the cache with the same
455          * device name if it exists. */
456         ast_event_queue_and_cache(event,
457                 AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR,
458                 AST_EVENT_IE_EID, AST_EVENT_IE_PLTYPE_RAW, sizeof(struct ast_eid),
459                 AST_EVENT_IE_END);
460 }
461
462 /*! Called by the state change thread to find out what the state is, and then
463  *  to queue up the state change event */
464 static void do_state_change(const char *device)
465 {
466         enum ast_device_state state;
467
468         state = ast_device_state(device);
469
470         ast_debug(3, "Changing state for %s - state %d (%s)\n", device, state, devstate2str(state));
471
472         devstate_event(device, state);
473 }
474
475 int ast_devstate_changed_literal(enum ast_device_state state, const char *device)
476 {
477         struct state_change *change;
478
479         /* If we know the state change (how nice of the caller of this function!)
480          * then we can just generate the event.  Otherwise, we have to go through
481          * a crap ton of extra work to go figure out what the state change is.
482          * We queue the fact that the state has changed up for another thread to
483          * go figure out, which it does by calling into the channel driver if it
484          * can, or by walking through the active channel list. */
485
486         if (state != AST_DEVICE_UNKNOWN) {
487                 devstate_event(device, state);
488         } else if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
489                 /* we could not allocate a change struct, or */
490                 /* there is no background thread, so process the change now */
491                 do_state_change(device);
492         } else {
493                 /* queue the change */
494                 strcpy(change->device, device);
495                 AST_LIST_LOCK(&state_changes);
496                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
497                 ast_cond_signal(&change_pending);
498                 AST_LIST_UNLOCK(&state_changes);
499         }
500
501         return 1;
502 }
503
504 int ast_device_state_changed_literal(const char *dev)
505 {
506         return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, dev);
507 }
508
509 int ast_devstate_changed(enum ast_device_state state, const char *fmt, ...) 
510 {
511         char buf[AST_MAX_EXTENSION];
512         va_list ap;
513
514         va_start(ap, fmt);
515         vsnprintf(buf, sizeof(buf), fmt, ap);
516         va_end(ap);
517
518         return ast_devstate_changed_literal(state, buf);
519 }
520
521 /*! \brief Accept change notification, add it to change queue */
522 int ast_device_state_changed(const char *fmt, ...) 
523 {
524         char buf[AST_MAX_EXTENSION];
525         va_list ap;
526
527         va_start(ap, fmt);
528         vsnprintf(buf, sizeof(buf), fmt, ap);
529         va_end(ap);
530
531         return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, buf);
532 }
533
534 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
535 static void *do_devstate_changes(void *data)
536 {
537         struct state_change *next, *current;
538
539         for (;;) {
540                 /* This basically pops off any state change entries, resets the list back to NULL, unlocks, and processes each state change */
541                 AST_LIST_LOCK(&state_changes);
542                 if (AST_LIST_EMPTY(&state_changes))
543                         ast_cond_wait(&change_pending, &state_changes.lock);
544                 next = AST_LIST_FIRST(&state_changes);
545                 AST_LIST_HEAD_INIT_NOLOCK(&state_changes);
546                 AST_LIST_UNLOCK(&state_changes);
547
548                 /* Process each state change */
549                 while ((current = next)) {
550                         next = AST_LIST_NEXT(current, list);
551                         do_state_change(current->device);
552                         ast_free(current);
553                 }
554         }
555
556         return NULL;
557 }
558
559 static void destroy_devstate_change(struct devstate_change *sc)
560 {
561         ast_free(sc);
562 }
563
564 #define MAX_SERVERS 64
565 struct change_collection {
566         struct devstate_change states[MAX_SERVERS];
567         size_t num_states;
568 };
569
570 static void devstate_cache_cb(const struct ast_event *event, void *data)
571 {
572         struct change_collection *collection = data;
573         int i;
574         const struct ast_eid *eid;
575
576         if (collection->num_states == ARRAY_LEN(collection->states)) {
577                 ast_log(LOG_ERROR, "More per-server state values than we have room for (MAX_SERVERS is %d)\n",
578                         MAX_SERVERS);
579                 return;
580         }
581
582         if (!(eid = ast_event_get_ie_raw(event, AST_EVENT_IE_EID))) {
583                 ast_log(LOG_ERROR, "Device state change event with no EID\n");
584                 return;
585         }
586
587         i = collection->num_states;
588
589         collection->states[i].state = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
590         collection->states[i].eid = *eid;
591
592         collection->num_states++;
593 }
594
595 static void process_collection(const char *device, struct change_collection *collection)
596 {
597         int i;
598         struct ast_devstate_aggregate agg;
599         enum ast_device_state state;
600         struct ast_event *event;
601
602         ast_devstate_aggregate_init(&agg);
603
604         for (i = 0; i < collection->num_states; i++) {
605                 ast_debug(1, "Adding per-server state of '%s' for '%s'\n", 
606                         devstate2str(collection->states[i].state), device);
607                 ast_devstate_aggregate_add(&agg, collection->states[i].state);
608         }
609
610         state = ast_devstate_aggregate_result(&agg);
611
612         ast_debug(1, "Aggregate devstate result is %d\n", state);
613
614         event = ast_event_get_cached(AST_EVENT_DEVICE_STATE,
615                 AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device,
616                 AST_EVENT_IE_END);
617         
618         if (event) {
619                 enum ast_device_state old_state;
620
621                 old_state = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
622                 
623                 ast_event_destroy(event);
624
625                 if (state == old_state) {
626                         /* No change since last reported device state */
627                         ast_debug(1, "Aggregate state for device '%s' has not changed from '%s'\n",
628                                 device, devstate2str(state));
629                         return;
630                 }
631         }
632
633         ast_debug(1, "Aggregate state for device '%s' has changed to '%s'\n",
634                 device, devstate2str(state));
635
636         event = ast_event_new(AST_EVENT_DEVICE_STATE,
637                 AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device,
638                 AST_EVENT_IE_STATE, AST_EVENT_IE_PLTYPE_UINT, state,
639                 AST_EVENT_IE_END);
640         
641         if (!event)
642                 return;
643
644         ast_event_queue_and_cache(event,
645                 AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR,
646                 AST_EVENT_IE_END);
647 }
648
649 static void handle_devstate_change(struct devstate_change *sc)
650 {
651         struct ast_event_sub *tmp_sub;
652         struct change_collection collection = {
653                 .num_states = 0,
654         };
655
656         ast_debug(1, "Processing device state change for '%s'\n", sc->device);
657
658         if (!(tmp_sub = ast_event_subscribe_new(AST_EVENT_DEVICE_STATE_CHANGE, devstate_cache_cb, &collection))) {
659                 ast_log(LOG_ERROR, "Failed to create subscription\n");
660                 return;
661         }
662
663         if (ast_event_sub_append_ie_str(tmp_sub, AST_EVENT_IE_DEVICE, sc->device)) {
664                 ast_log(LOG_ERROR, "Failed to append device IE\n");
665                 ast_event_sub_destroy(tmp_sub);
666                 return;
667         }
668
669         /* Populate the collection of device states from the cache */
670         ast_event_dump_cache(tmp_sub);
671
672         process_collection(sc->device, &collection);
673
674         ast_event_sub_destroy(tmp_sub);
675 }
676
677 static void *run_devstate_collector(void *data)
678 {
679         for (;;) {
680                 struct devstate_change *sc;
681
682                 ast_mutex_lock(&devstate_collector.lock);
683                 while (!(sc = AST_LIST_REMOVE_HEAD(&devstate_collector.devstate_change_q, entry)))
684                         ast_cond_wait(&devstate_collector.cond, &devstate_collector.lock);
685                 ast_mutex_unlock(&devstate_collector.lock);
686
687                 handle_devstate_change(sc);
688
689                 destroy_devstate_change(sc);
690         }
691
692         return NULL;
693 }
694
695 static void devstate_change_collector_cb(const struct ast_event *event, void *data)
696 {
697         struct devstate_change *sc;
698         const char *device;
699         const struct ast_eid *eid;
700         uint32_t state;
701
702         device = ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE);
703         eid = ast_event_get_ie_raw(event, AST_EVENT_IE_EID);
704         state = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
705
706         if (ast_strlen_zero(device) || !eid) {
707                 ast_log(LOG_ERROR, "Invalid device state change event received\n");
708                 return;
709         }
710
711         if (!(sc = ast_calloc(1, sizeof(*sc) + strlen(device))))
712                 return;
713
714         strcpy(sc->device, device);
715         sc->eid = *eid;
716         sc->state = state;
717
718         ast_mutex_lock(&devstate_collector.lock);
719         AST_LIST_INSERT_TAIL(&devstate_collector.devstate_change_q, sc, entry);
720         ast_cond_signal(&devstate_collector.cond);
721         ast_mutex_unlock(&devstate_collector.lock);
722 }
723
724 /*! \brief Initialize the device state engine in separate thread */
725 int ast_device_state_engine_init(void)
726 {
727         devstate_collector.event_sub = ast_event_subscribe(AST_EVENT_DEVICE_STATE_CHANGE,
728                 devstate_change_collector_cb, NULL, AST_EVENT_IE_END);
729
730         if (!devstate_collector.event_sub) {
731                 ast_log(LOG_ERROR, "Failed to create subscription for the device state change collector\n");
732                 return -1;
733         }
734
735         ast_mutex_init(&devstate_collector.lock);
736         ast_cond_init(&devstate_collector.cond, NULL);
737         if (ast_pthread_create_background(&devstate_collector.thread, NULL, run_devstate_collector, NULL) < 0) {
738                 ast_log(LOG_ERROR, "Unable to start device state collector thread.\n");
739                 return -1;
740         }
741
742         ast_cond_init(&change_pending, NULL);
743         if (ast_pthread_create_background(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
744                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
745                 return -1;
746         }
747
748         return 0;
749 }
750
751 void ast_devstate_aggregate_init(struct ast_devstate_aggregate *agg)
752 {
753         memset(agg, 0, sizeof(*agg));
754
755         agg->all_unavail = 1;
756         agg->all_busy = 1;
757         agg->all_free = 1;
758         agg->all_on_hold = 1;
759 }
760
761 void ast_devstate_aggregate_add(struct ast_devstate_aggregate *agg, enum ast_device_state state)
762 {
763         switch (state) {
764         case AST_DEVICE_NOT_INUSE:
765                 agg->all_unavail = 0;
766                 agg->all_busy = 0;
767                 agg->all_on_hold = 0;
768                 break;
769         case AST_DEVICE_INUSE:
770                 agg->in_use = 1;
771                 agg->all_busy = 0;
772                 agg->all_unavail = 0;
773                 agg->all_free = 0;
774                 agg->all_on_hold = 0;
775                 break;
776         case AST_DEVICE_RINGING:
777                 agg->ring = 1;
778                 agg->all_busy = 0;
779                 agg->all_unavail = 0;
780                 agg->all_free = 0;
781                 agg->all_on_hold = 0;
782                 break;
783         case AST_DEVICE_RINGINUSE:
784                 agg->in_use = 1;
785                 agg->ring = 1;
786                 agg->all_busy = 0;
787                 agg->all_unavail = 0;
788                 agg->all_free = 0;
789                 agg->all_on_hold = 0;
790                 break;
791         case AST_DEVICE_ONHOLD:
792                 agg->all_unavail = 0;
793                 agg->all_free = 0;
794                 break;
795         case AST_DEVICE_BUSY:
796                 agg->all_unavail = 0;
797                 agg->all_free = 0;
798                 agg->all_on_hold = 0;
799                 agg->busy = 1;
800                 break;
801         case AST_DEVICE_UNAVAILABLE:
802         case AST_DEVICE_INVALID:
803                 agg->all_busy = 0;
804                 agg->all_free = 0;
805                 agg->all_on_hold = 0;
806                 break;
807         case AST_DEVICE_UNKNOWN:
808                 break;
809         }
810 }
811
812 enum ast_device_state ast_devstate_aggregate_result(struct ast_devstate_aggregate *agg)
813 {
814         if (agg->all_free)
815                 return AST_DEVICE_NOT_INUSE;
816         
817         if (agg->all_on_hold)
818                 return AST_DEVICE_ONHOLD;
819         
820         if (agg->all_busy)
821                 return AST_DEVICE_BUSY;
822
823         if (agg->all_unavail)
824                 return AST_DEVICE_UNAVAILABLE;
825         
826         if (agg->ring)
827                 return agg->in_use ? AST_DEVICE_RINGINUSE : AST_DEVICE_RINGING;
828
829         if (agg->in_use)
830                 return AST_DEVICE_INUSE;
831
832         if (agg->busy)
833                 return AST_DEVICE_BUSY;
834         
835         return AST_DEVICE_NOT_INUSE;
836 }
837