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