Read/write lockify the devicestate stuff a bit.
[asterisk/asterisk.git] / main / devicestate.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Device state management
22  *
23  *
24  * \author Mark Spencer <markster@digium.com> 
25  *
26  *      \arg \ref AstExtState
27  */
28 /*! \page AstExtState Extension and device states in Asterisk
29  *
30  *      Asterisk has an internal system that reports states
31  *      for an extension. By using the dialplan priority -1,
32  *      also called a \b hint, a connection can be made from an
33  *      extension to one or many devices. The state of the extension
34  *      now depends on the combined state of the devices.
35  *
36  *      The device state is basically based on the current calls.
37  *      If the devicestate engine can find a call from or to the
38  *      device, it's in use.
39  *      
40  *      Some channel drivers implement a callback function for 
41  *      a better level of reporting device states. The SIP channel
42  *      has a complicated system for this, which is improved 
43  *      by adding call limits to the configuration.
44  * 
45  *      Functions that want to check the status of an extension
46  *      register themself as a \b watcher.
47  *      Watchers in this system can subscribe either to all extensions
48  *      or just a specific extensions.
49  *
50  *      For non-device related states, there's an API called
51  *      devicestateproviders. This is an extendable system for
52  *      delivering state information from outside sources or
53  *      functions within Asterisk. Currently we have providers
54  *      for app_meetme.c - the conference bridge - and call
55  *      parking (metermaids).
56  *
57  *      There are manly three subscribers to extension states 
58  *      within Asterisk:
59  *      - AMI, the manager interface
60  *      - app_queue.c - the Queue dialplan application
61  *      - SIP subscriptions, a.k.a. "blinking lamps" or 
62  *        "buddy lists"
63  *
64  *      The CLI command "show hints" show last known state
65  *
66  *      \note None of these handle user states, like an IM presense
67  *      system. res_jabber.c can subscribe and watch such states
68  *      in jabber/xmpp based systems.
69  *
70  *      \section AstDevStateArch Architecture for devicestates
71  *
72  *      When a channel driver or asterisk app changes state for 
73  *      a watched object, it alerts the core. The core queues
74  *      a change. When the change is processed, there's a query
75  *      sent to the channel driver/provider if there's a function
76  *      to handle that, otherwise a channel walk is issued to find
77  *      a channel that involves the object.
78  *      
79  *      The changes are queued and processed by a separate thread.
80  *      This thread calls the watchers subscribing to status 
81  *      changes for the object. For manager, this results 
82  *      in events. For SIP, NOTIFY requests.
83  *
84  *      - Device states
85  *              \arg \ref devicestate.c 
86  *              \arg \ref devicestate.h 
87  *
88  *      \section AstExtStateArch Architecture for extension states
89  *      
90  *      Hints are connected to extension. If an extension changes state
91  *      it checks the hint devices. If there is a hint, the callbacks into
92  *      device states are checked. The aggregated state is set for the hint
93  *      and reported back.
94  *
95  *      - Extension states
96  *              \arg \ref enum ast_extension_states
97  *              \arg \ref pbx.c 
98  *              \arg \ref pbx.h 
99  *      - Structures
100  *              - \ref struct ast_state_cb  Callbacks for watchers
101  *              - Callback ast_state_cb_type
102  *              - \ref struct ast_hint
103  *      - Functions
104  *              - ast_extension_state_add()
105  *              - ast_extension_state_del()
106  *              - ast_get_hint()
107  *      
108  */
109
110 #include "asterisk.h"
111
112 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
113
114 #include <sys/types.h>
115 #include <unistd.h>
116 #include <stdlib.h>
117 #include <string.h>
118 #include <stdio.h>
119
120 #include "asterisk/channel.h"
121 #include "asterisk/utils.h"
122 #include "asterisk/lock.h"
123 #include "asterisk/linkedlists.h"
124 #include "asterisk/logger.h"
125 #include "asterisk/devicestate.h"
126 #include "asterisk/pbx.h"
127 #include "asterisk/app.h"
128 #include "asterisk/options.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  A device state provider (not a channel) */
144 struct devstate_prov {
145         char label[40];
146         ast_devstate_prov_cb_type callback;
147         AST_RWLIST_ENTRY(devstate_prov) list;
148 };
149
150 /*! \brief A list of providers */
151 static AST_RWLIST_HEAD_STATIC(devstate_provs, devstate_prov);
152
153 /*! \brief  A device state watcher (callback) */
154 struct devstate_cb {
155         void *data;
156         ast_devstate_cb_type callback;  /*!< Where to report when state changes */
157         AST_RWLIST_ENTRY(devstate_cb) list;
158 };
159
160 /*! \brief A device state watcher list */
161 static AST_RWLIST_HEAD_STATIC(devstate_cbs, devstate_cb);
162
163 struct state_change {
164         AST_LIST_ENTRY(state_change) list;
165         char device[1];
166 };
167
168 /*! \brief The state change queue. State changes are queued
169         for processing by a separate thread */
170 static AST_LIST_HEAD_STATIC(state_changes, state_change);
171
172 /*! \brief The device state change notification thread */
173 static pthread_t change_thread = AST_PTHREADT_NULL;
174
175 /*! \brief Flag for the queue */
176 static ast_cond_t change_pending;
177
178 /* Forward declarations */
179 static int getproviderstate(const char *provider, const char *address);
180
181 /*! \brief Find devicestate as text message for output */
182 const char *devstate2str(int devstate) 
183 {
184         return devstatestring[devstate];
185 }
186
187 /*! \brief Find out if device is active in a call or not 
188         \note find channels with the device's name in it
189         This function is only used for channels that does not implement 
190         devicestate natively
191 */
192 int ast_parse_device_state(const char *device)
193 {
194         struct ast_channel *chan;
195         char match[AST_CHANNEL_NAME];
196         int res;
197
198         ast_copy_string(match, device, sizeof(match)-1);
199         strcat(match, "-");
200         chan = ast_get_channel_by_name_prefix_locked(match, strlen(match));
201
202         if (!chan)
203                 return AST_DEVICE_UNKNOWN;
204
205         if (chan->_state == AST_STATE_RINGING)
206                 res = AST_DEVICE_RINGING;
207         else
208                 res = AST_DEVICE_INUSE;
209         
210         ast_channel_unlock(chan);
211
212         return res;
213 }
214
215 /*! \brief Check device state through channel specific function or generic function */
216 int ast_device_state(const char *device)
217 {
218         char *buf;
219         char *number;
220         const struct ast_channel_tech *chan_tech;
221         int res = 0;
222         /*! \brief Channel driver that provides device state */
223         char *tech;
224         /*! \brief Another provider of device state */
225         char *provider = NULL;
226         
227         buf = ast_strdupa(device);
228         tech = strsep(&buf, "/");
229         number = buf;
230         if (!number) {
231                 provider = strsep(&tech, ":");
232                 if (!provider)
233                         return AST_DEVICE_INVALID;
234                 /* We have a provider */
235                 number = tech;
236                 tech = NULL;
237         }
238
239         if (provider)  {
240                 if (option_debug > 2)
241                         ast_log(LOG_DEBUG, "Checking if I can find provider for \"%s\" - number: %s\n", provider, number);
242                 return getproviderstate(provider, number);
243         }
244         if (option_debug > 3)
245                 ast_log(LOG_DEBUG, "No provider found, checking channel drivers for %s - %s\n", tech, number);
246
247         chan_tech = ast_get_channel_tech(tech);
248         if (!chan_tech)
249                 return AST_DEVICE_INVALID;
250
251         if (!chan_tech->devicestate)    /* Does the channel driver support device state notification? */
252                 return ast_parse_device_state(device);  /* No, try the generic function */
253         else {
254                 res = chan_tech->devicestate(number);   /* Ask the channel driver for device state */
255                 if (res == AST_DEVICE_UNKNOWN) {
256                         res = ast_parse_device_state(device);
257                         /* at this point we know the device exists, but the channel driver
258                            could not give us a state; if there is no channel state available,
259                            it must be 'not in use'
260                         */
261                         if (res == AST_DEVICE_UNKNOWN)
262                                 res = AST_DEVICE_NOT_INUSE;
263                         return res;
264                 } else
265                         return res;
266         }
267 }
268
269 /*! \brief Add device state provider */
270 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback)
271 {
272         struct devstate_prov *devprov;
273
274         if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
275                 return -1;
276
277         devprov->callback = callback;
278         ast_copy_string(devprov->label, label, sizeof(devprov->label));
279
280         AST_RWLIST_WRLOCK(&devstate_provs);
281         AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list);
282         AST_RWLIST_UNLOCK(&devstate_provs);
283
284         return 0;
285 }
286
287 /*! \brief Remove device state provider */
288 void ast_devstate_prov_del(const char *label)
289 {
290         struct devstate_prov *devcb;
291
292         AST_RWLIST_WRLOCK(&devstate_provs);
293         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
294                 if (!strcasecmp(devcb->label, label)) {
295                         AST_RWLIST_REMOVE_CURRENT(&devstate_provs, list);
296                         free(devcb);
297                         break;
298                 }
299         }
300         AST_RWLIST_TRAVERSE_SAFE_END;
301         AST_RWLIST_UNLOCK(&devstate_provs);
302 }
303
304 /*! \brief Get provider device state */
305 static int getproviderstate(const char *provider, const char *address)
306 {
307         struct devstate_prov *devprov;
308         int res = AST_DEVICE_INVALID;
309
310
311         AST_RWLIST_RDLOCK(&devstate_provs);
312         AST_RWLIST_TRAVERSE(&devstate_provs, devprov, list) {
313                 if (option_debug > 4)
314                         ast_log(LOG_DEBUG, "Checking provider %s with %s\n", devprov->label, provider);
315
316                 if (!strcasecmp(devprov->label, provider)) {
317                         res = devprov->callback(address);
318                         break;
319                 }
320         }
321         AST_RWLIST_UNLOCK(&devstate_provs);
322         return res;
323 }
324
325 /*! \brief Add device state watcher */
326 int ast_devstate_add(ast_devstate_cb_type callback, void *data)
327 {
328         struct devstate_cb *devcb;
329
330         if (!callback || !(devcb = ast_calloc(1, sizeof(*devcb))))
331                 return -1;
332
333         devcb->data = data;
334         devcb->callback = callback;
335
336         AST_RWLIST_WRLOCK(&devstate_cbs);
337         AST_RWLIST_INSERT_HEAD(&devstate_cbs, devcb, list);
338         AST_RWLIST_UNLOCK(&devstate_cbs);
339
340         return 0;
341 }
342
343 /*! \brief Remove device state watcher */
344 void ast_devstate_del(ast_devstate_cb_type callback, void *data)
345 {
346         struct devstate_cb *devcb;
347
348         AST_RWLIST_WRLOCK(&devstate_cbs);
349         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_cbs, devcb, list) {
350                 if ((devcb->callback == callback) && (devcb->data == data)) {
351                         AST_RWLIST_REMOVE_CURRENT(&devstate_cbs, list);
352                         free(devcb);
353                         break;
354                 }
355         }
356         AST_RWLIST_TRAVERSE_SAFE_END;
357         AST_RWLIST_UNLOCK(&devstate_cbs);
358 }
359
360 /*! \brief Notify callback watchers of change, and notify PBX core for hint updates
361         Normally executed within a separate thread
362 */
363 static void do_state_change(const char *device)
364 {
365         int state;
366         struct devstate_cb *devcb;
367
368         state = ast_device_state(device);
369         if (option_debug > 2)
370                 ast_log(LOG_DEBUG, "Changing state for %s - state %d (%s)\n", device, state, devstate2str(state));
371
372         AST_RWLIST_RDLOCK(&devstate_cbs);
373         AST_RWLIST_TRAVERSE(&devstate_cbs, devcb, list)
374                 devcb->callback(device, state, devcb->data);
375         AST_RWLIST_UNLOCK(&devstate_cbs);
376
377         ast_hint_state_changed(device);
378 }
379
380 static int __ast_device_state_changed_literal(char *buf)
381 {
382         char *device, *tmp;
383         struct state_change *change;
384
385         if (option_debug > 2)
386                 ast_log(LOG_DEBUG, "Notification of state change to be queued on device/channel %s\n", buf);
387
388         device = buf;
389         if ((tmp = strrchr(device, '-')))
390                 *tmp = '\0';
391
392         
393
394         if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
395                 /* we could not allocate a change struct, or */
396                 /* there is no background thread, so process the change now */
397                 do_state_change(device);
398         } else {
399                 /* queue the change */
400                 strcpy(change->device, device);
401                 AST_LIST_LOCK(&state_changes);
402                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
403                 if (AST_LIST_FIRST(&state_changes) == change)
404                         /* the list was empty, signal the thread */
405                         ast_cond_signal(&change_pending);
406                 AST_LIST_UNLOCK(&state_changes);
407         }
408
409         return 1;
410 }
411
412 int ast_device_state_changed_literal(const char *dev)
413 {
414         char *buf;
415         buf = ast_strdupa(dev);
416         return __ast_device_state_changed_literal(buf);
417 }
418
419 /*! \brief Accept change notification, add it to change queue */
420 int ast_device_state_changed(const char *fmt, ...) 
421 {
422         char buf[AST_MAX_EXTENSION];
423         va_list ap;
424
425         va_start(ap, fmt);
426         vsnprintf(buf, sizeof(buf), fmt, ap);
427         va_end(ap);
428         return __ast_device_state_changed_literal(buf);
429 }
430
431 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
432 static void *do_devstate_changes(void *data)
433 {
434         struct state_change *cur;
435
436         AST_LIST_LOCK(&state_changes);
437         for (;;) {
438                 /* the list lock will _always_ be held at this point in the loop */
439                 cur = AST_LIST_REMOVE_HEAD(&state_changes, list);
440                 if (cur) {
441                         /* we got an entry, so unlock the list while we process it */
442                         AST_LIST_UNLOCK(&state_changes);
443                         do_state_change(cur->device);
444                         free(cur);
445                         AST_LIST_LOCK(&state_changes);
446                 } else {
447                         /* there was no entry, so atomically unlock the list and wait for
448                            the condition to be signalled (returns with the lock held) */
449                         ast_cond_wait(&change_pending, &state_changes.lock);
450                 }
451         }
452
453         return NULL;
454 }
455
456 /*! \brief Initialize the device state engine in separate thread */
457 int ast_device_state_engine_init(void)
458 {
459         ast_cond_init(&change_pending, NULL);
460         if (ast_pthread_create_background(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
461                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
462                 return -1;
463         }
464
465         return 0;
466 }