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