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