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