issue #5558
[asterisk/asterisk.git] / devicestate.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, 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
25 #include <sys/types.h>
26 #include <unistd.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <stdio.h>
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/channel.h"
36 #include "asterisk/utils.h"
37 #include "asterisk/lock.h"
38 #include "asterisk/linkedlists.h"
39 #include "asterisk/logger.h"
40 #include "asterisk/devicestate.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/options.h"
43
44 static const char *devstatestring[] = {
45         /* 0 AST_DEVICE_UNKNOWN */      "Unknown",      /* Valid, but unknown state */
46         /* 1 AST_DEVICE_NOT_INUSE */    "Not in use",   /* Not used */
47         /* 2 AST_DEVICE IN USE */       "In use",       /* In use */
48         /* 3 AST_DEVICE_BUSY */         "Busy",         /* Busy */
49         /* 4 AST_DEVICE_INVALID */      "Invalid",      /* Invalid - not known to Asterisk */
50         /* 5 AST_DEVICE_UNAVAILABLE */  "Unavailable",  /* Unavailable (not registred) */
51         /* 6 AST_DEVICE_RINGING */      "Ringing"       /* Ring, ring, ring */
52 };
53
54 /* ast_devstate_cb: A device state watcher (callback) */
55 struct devstate_cb {
56         void *data;
57         ast_devstate_cb_type callback;
58         AST_LIST_ENTRY(devstate_cb) list;
59 };
60
61 static AST_LIST_HEAD_STATIC(devstate_cbs, devstate_cb);
62
63 struct state_change {
64         AST_LIST_ENTRY(state_change) list;
65         char device[1];
66 };
67
68 static AST_LIST_HEAD_STATIC(state_changes, state_change);
69
70 static pthread_t change_thread = AST_PTHREADT_NULL;
71 static ast_cond_t change_pending;
72
73 /*--- devstate2str: Find devicestate as text message for output */
74 const char *devstate2str(int devstate) 
75 {
76         return devstatestring[devstate];
77 }
78
79 /*--- ast_parse_device_state: Find out if device is active in a call or not */
80 int ast_parse_device_state(const char *device)
81 {
82         struct ast_channel *chan;
83         char match[AST_CHANNEL_NAME];
84         int res;
85
86         ast_copy_string(match, device, sizeof(match)-1);
87         strcat(match, "-");
88         chan = ast_get_channel_by_name_prefix_locked(match, strlen(match));
89
90         if (!chan)
91                 return AST_DEVICE_UNKNOWN;
92
93         if (chan->_state == AST_STATE_RINGING)
94                 res = AST_DEVICE_RINGING;
95         else
96                 res = AST_DEVICE_INUSE;
97         
98         ast_mutex_unlock(&chan->lock);
99
100         return res;
101 }
102
103 /*--- ast_device_state: Check device state through channel specific function or generic function */
104 int ast_device_state(const char *device)
105 {
106         char *buf;
107         char *tech;
108         char *number;
109         const struct ast_channel_tech *chan_tech;
110         int res = 0;
111         
112         buf = ast_strdupa(device);
113         tech = strsep(&buf, "/");
114         number = buf;
115         if (!number)
116                 return AST_DEVICE_INVALID;
117                 
118         chan_tech = ast_get_channel_tech(tech);
119         if (!chan_tech)
120                 return AST_DEVICE_INVALID;
121
122         if (!chan_tech->devicestate)    /* Does the channel driver support device state notification? */
123                 return ast_parse_device_state(device);  /* No, try the generic function */
124         else {
125                 res = chan_tech->devicestate(number);   /* Ask the channel driver for device state */
126                 if (res == AST_DEVICE_UNKNOWN) {
127                         res = ast_parse_device_state(device);
128                         /* at this point we know the device exists, but the channel driver
129                            could not give us a state; if there is no channel state available,
130                            it must be 'not in use'
131                         */
132                         if (res == AST_DEVICE_UNKNOWN)
133                                 res = AST_DEVICE_NOT_INUSE;
134                         return res;
135                 } else
136                         return res;
137         }
138 }
139
140 /*--- ast_devstate_add: Add device state watcher */
141 int ast_devstate_add(ast_devstate_cb_type callback, void *data)
142 {
143         struct devstate_cb *devcb;
144
145         if (!callback)
146                 return -1;
147
148         devcb = calloc(1, sizeof(*devcb));
149         if (!devcb)
150                 return -1;
151
152         devcb->data = data;
153         devcb->callback = callback;
154
155         AST_LIST_LOCK(&devstate_cbs);
156         AST_LIST_INSERT_HEAD(&devstate_cbs, devcb, list);
157         AST_LIST_UNLOCK(&devstate_cbs);
158
159         return 0;
160 }
161
162 /*--- ast_devstate_del: Remove device state watcher */
163 void ast_devstate_del(ast_devstate_cb_type callback, void *data)
164 {
165         struct devstate_cb *devcb;
166
167         AST_LIST_LOCK(&devstate_cbs);
168         AST_LIST_TRAVERSE_SAFE_BEGIN(&devstate_cbs, devcb, list) {
169                 if ((devcb->callback == callback) && (devcb->data == data)) {
170                         AST_LIST_REMOVE_CURRENT(&devstate_cbs, list);
171                         free(devcb);
172                         break;
173                 }
174         }
175         AST_LIST_TRAVERSE_SAFE_END;
176         AST_LIST_UNLOCK(&devstate_cbs);
177 }
178
179 /*--- do_state_change: Notify callback watchers of change, and notify PBX core for hint updates */
180 static void do_state_change(const char *device)
181 {
182         int state;
183         struct devstate_cb *devcb;
184
185         state = ast_device_state(device);
186         if (option_debug > 2)
187                 ast_log(LOG_DEBUG, "Changing state for %s - state %d (%s)\n", device, state, devstate2str(state));
188
189         AST_LIST_LOCK(&devstate_cbs);
190         AST_LIST_TRAVERSE(&devstate_cbs, devcb, list)
191                 devcb->callback(device, state, devcb->data);
192         AST_LIST_UNLOCK(&devstate_cbs);
193
194         ast_hint_state_changed(device);
195 }
196
197 static int __ast_device_state_changed_literal(char *buf)
198 {
199         char *device, *tmp;
200         struct state_change *change = NULL;
201
202         device = buf;
203         tmp = strrchr(device, '-');
204         if (tmp)
205                 *tmp = '\0';
206         if (change_thread != AST_PTHREADT_NULL)
207                 change = calloc(1, sizeof(*change) + strlen(device));
208
209         if (!change) {
210                 /* we could not allocate a change struct, or */
211                 /* there is no background thread, so process the change now */
212                 do_state_change(device);
213         } else {
214                 /* queue the change */
215                 strcpy(change->device, device);
216                 AST_LIST_LOCK(&state_changes);
217                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
218                 if (AST_LIST_FIRST(&state_changes) == change)
219                         /* the list was empty, signal the thread */
220                         ast_cond_signal(&change_pending);
221                 AST_LIST_UNLOCK(&state_changes);
222         }
223
224         return 1;
225 }
226
227 int ast_device_state_changed_literal(const char *dev)
228 {
229         char *buf;
230         buf = ast_strdupa(dev);
231         return __ast_device_state_changed_literal(buf);
232 }
233
234 /*--- ast_device_state_changed: Accept change notification, add it to change queue */
235 int ast_device_state_changed(const char *fmt, ...) 
236 {
237         char buf[AST_MAX_EXTENSION];
238         va_list ap;
239
240         va_start(ap, fmt);
241         vsnprintf(buf, sizeof(buf), fmt, ap);
242         va_end(ap);
243         return __ast_device_state_changed_literal(buf);
244 }
245
246 /*--- do_devstate_changes: Go through the dev state change queue and update changes in the dev state thread */
247 static void *do_devstate_changes(void *data)
248 {
249         struct state_change *cur;
250
251         AST_LIST_LOCK(&state_changes);
252         for(;;) {
253                 /* the list lock will _always_ be held at this point in the loop */
254                 cur = AST_LIST_REMOVE_HEAD(&state_changes, list);
255                 if (cur) {
256                         /* we got an entry, so unlock the list while we process it */
257                         AST_LIST_UNLOCK(&state_changes);
258                         do_state_change(cur->device);
259                         free(cur);
260                         AST_LIST_LOCK(&state_changes);
261                 } else {
262                         /* there was no entry, so atomically unlock the list and wait for
263                            the condition to be signalled (returns with the lock held) */
264                         ast_cond_wait(&change_pending, &state_changes.lock);
265                 }
266         }
267
268         return NULL;
269 }
270
271 /*--- ast_device_state_engine_init: Initialize the device state engine in separate thread */
272 int ast_device_state_engine_init(void)
273 {
274         pthread_attr_t attr;
275
276         ast_cond_init(&change_pending, NULL);
277         pthread_attr_init(&attr);
278         pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
279         if (ast_pthread_create(&change_thread, &attr, do_devstate_changes, NULL) < 0) {
280                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
281                 return -1;
282         }
283
284         return 0;
285 }