5293cbab4addf5bfa2b1884d3c19a42c695d3e02
[asterisk/asterisk.git] / main / autoservice.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 Automatic channel service routines
23  *
24  * \author Mark Spencer <markster@digium.com>
25  * \author Russell Bryant <russell@digium.com>
26  */
27
28 /*** MODULEINFO
29         <support_level>core</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include <sys/time.h>
37 #include <signal.h>
38
39 #include "asterisk/_private.h" /* prototype for ast_autoservice_init() */
40
41 #include "asterisk/pbx.h"
42 #include "asterisk/frame.h"
43 #include "asterisk/sched.h"
44 #include "asterisk/channel.h"
45 #include "asterisk/file.h"
46 #include "asterisk/translate.h"
47 #include "asterisk/manager.h"
48 #include "asterisk/chanvars.h"
49 #include "asterisk/linkedlists.h"
50 #include "asterisk/indications.h"
51 #include "asterisk/lock.h"
52 #include "asterisk/utils.h"
53
54 #define MAX_AUTOMONS 1500
55
56 struct asent {
57         struct ast_channel *chan;
58         /*! This gets incremented each time autoservice gets started on the same
59          *  channel.  It will ensure that it doesn't actually get stopped until
60          *  it gets stopped for the last time. */
61         unsigned int use_count;
62         unsigned int orig_end_dtmf_flag:1;
63         unsigned int ignore_frame_types;
64         /*! Frames go on at the head of deferred_frames, so we have the frames
65          *  from newest to oldest.  As we put them at the head of the readq, we'll
66          *  end up with them in the right order for the channel's readq. */
67         AST_LIST_HEAD_NOLOCK(, ast_frame) deferred_frames;
68         AST_LIST_ENTRY(asent) list;
69 };
70
71 static AST_LIST_HEAD_STATIC(aslist, asent);
72 static ast_cond_t as_cond;
73
74 static pthread_t asthread = AST_PTHREADT_NULL;
75
76 static int as_chan_list_state;
77
78 static void *autoservice_run(void *ign)
79 {
80         struct ast_callid *callid = NULL;
81         struct ast_frame hangup_frame = {
82                 .frametype = AST_FRAME_CONTROL,
83                 .subclass.integer = AST_CONTROL_HANGUP,
84         };
85
86         for (;;) {
87                 struct ast_channel *mons[MAX_AUTOMONS];
88                 struct asent *ents[MAX_AUTOMONS];
89                 struct ast_channel *chan;
90                 struct asent *as;
91                 int i, x = 0, ms = 50;
92                 struct ast_frame *f = NULL;
93                 struct ast_frame *defer_frame = NULL;
94
95                 AST_LIST_LOCK(&aslist);
96
97                 /* At this point, we know that no channels that have been removed are going
98                  * to get used again. */
99                 as_chan_list_state++;
100
101                 if (AST_LIST_EMPTY(&aslist)) {
102                         ast_cond_wait(&as_cond, &aslist.lock);
103                 }
104
105                 AST_LIST_TRAVERSE(&aslist, as, list) {
106                         if (!ast_check_hangup(as->chan)) {
107                                 if (x < MAX_AUTOMONS) {
108                                         ents[x] = as;
109                                         mons[x++] = as->chan;
110                                 } else {
111                                         ast_log(LOG_WARNING, "Exceeded maximum number of automatic monitoring events.  Fix autoservice.c\n");
112                                 }
113                         }
114                 }
115
116                 AST_LIST_UNLOCK(&aslist);
117
118                 if (!x) {
119                         /* If we don't sleep, this becomes a busy loop, which causes
120                          * problems when Asterisk runs at a different priority than other
121                          * user processes.  As long as we check for new channels at least
122                          * once every 10ms, we should be fine. */
123                         usleep(10000);
124                         continue;
125                 }
126
127                 chan = ast_waitfor_n(mons, x, &ms);
128                 if (!chan) {
129                         continue;
130                 }
131
132                 callid = ast_channel_callid(chan);
133                 ast_callid_threadassoc_change(callid);
134                 if (callid) {
135                         callid = ast_callid_unref(callid);
136                 }
137
138                 f = ast_read(chan);
139
140                 if (!f) {
141                         /* No frame means the channel has been hung up.
142                          * A hangup frame needs to be queued here as ast_waitfor() may
143                          * never return again for the condition to be detected outside
144                          * of autoservice.  So, we'll leave a HANGUP queued up so the
145                          * thread in charge of this channel will know. */
146
147                         defer_frame = &hangup_frame;
148                 } else if (ast_is_deferrable_frame(f)) {
149                         defer_frame = f;
150                 } else {
151                         /* Can't defer. Discard and continue with next. */
152                         ast_frfree(f);
153                         continue;
154                 }
155
156                 for (i = 0; i < x; i++) {
157                         struct ast_frame *dup_f;
158
159                         if (mons[i] != chan) {
160                                 continue;
161                         }
162
163                         if (!f) { /* defer_frame == &hangup_frame */
164                                 if ((dup_f = ast_frdup(defer_frame))) {
165                                         AST_LIST_INSERT_HEAD(&ents[i]->deferred_frames, dup_f, frame_list);
166                                 }
167                         } else {
168                                 if ((dup_f = ast_frisolate(defer_frame))) {
169                                         AST_LIST_INSERT_HEAD(&ents[i]->deferred_frames, dup_f, frame_list);
170                                 }
171                                 if (dup_f != defer_frame) {
172                                         ast_frfree(defer_frame);
173                                 }
174                         }
175
176                         break;
177                 }
178                 /* The ast_waitfor_n() call will only read frames from
179                  * the channels' file descriptors. If ast_waitfor_n()
180                  * returns non-NULL, then one of the channels in the
181                  * mons array must have triggered the return. It's
182                  * therefore impossible that we got here while (i >= x).
183                  * If we did, we'd need to ast_frfree(f) if (f). */
184         }
185
186         asthread = AST_PTHREADT_NULL;
187
188         return NULL;
189 }
190
191 int ast_autoservice_start(struct ast_channel *chan)
192 {
193         int res = 0;
194         struct asent *as;
195
196         AST_LIST_LOCK(&aslist);
197         AST_LIST_TRAVERSE(&aslist, as, list) {
198                 if (as->chan == chan) {
199                         as->use_count++;
200                         break;
201                 }
202         }
203         AST_LIST_UNLOCK(&aslist);
204
205         if (as) {
206                 /* Entry exists, autoservice is already handling this channel */
207                 return 0;
208         }
209
210         if (!(as = ast_calloc(1, sizeof(*as))))
211                 return -1;
212
213         /* New entry created */
214         as->chan = chan;
215         as->use_count = 1;
216
217         ast_channel_lock(chan);
218         as->orig_end_dtmf_flag = ast_test_flag(ast_channel_flags(chan), AST_FLAG_END_DTMF_ONLY) ? 1 : 0;
219         if (!as->orig_end_dtmf_flag)
220                 ast_set_flag(ast_channel_flags(chan), AST_FLAG_END_DTMF_ONLY);
221         ast_channel_unlock(chan);
222
223         AST_LIST_LOCK(&aslist);
224
225         if (AST_LIST_EMPTY(&aslist) && asthread != AST_PTHREADT_NULL) {
226                 ast_cond_signal(&as_cond);
227         }
228
229         AST_LIST_INSERT_HEAD(&aslist, as, list);
230
231         if (asthread == AST_PTHREADT_NULL) { /* need start the thread */
232                 if (ast_pthread_create_background(&asthread, NULL, autoservice_run, NULL)) {
233                         ast_log(LOG_WARNING, "Unable to create autoservice thread :(\n");
234                         /* There will only be a single member in the list at this point,
235                            the one we just added. */
236                         AST_LIST_REMOVE(&aslist, as, list);
237                         free(as);
238                         asthread = AST_PTHREADT_NULL;
239                         res = -1;
240                 } else {
241                         pthread_kill(asthread, SIGURG);
242                 }
243         }
244
245         AST_LIST_UNLOCK(&aslist);
246
247         return res;
248 }
249
250 int ast_autoservice_stop(struct ast_channel *chan)
251 {
252         int res = -1;
253         struct asent *as, *removed = NULL;
254         struct ast_frame *f;
255         int chan_list_state;
256
257         AST_LIST_LOCK(&aslist);
258
259         /* Save the autoservice channel list state.  We _must_ verify that the channel
260          * list has been rebuilt before we return.  Because, after we return, the channel
261          * could get destroyed and we don't want our poor autoservice thread to step on
262          * it after its gone! */
263         chan_list_state = as_chan_list_state;
264
265         /* Find the entry, but do not free it because it still can be in the
266            autoservice thread array */
267         AST_LIST_TRAVERSE_SAFE_BEGIN(&aslist, as, list) {
268                 if (as->chan == chan) {
269                         as->use_count--;
270                         if (as->use_count < 1) {
271                                 AST_LIST_REMOVE_CURRENT(list);
272                                 removed = as;
273                         }
274                         break;
275                 }
276         }
277         AST_LIST_TRAVERSE_SAFE_END;
278
279         if (removed && asthread != AST_PTHREADT_NULL) {
280                 pthread_kill(asthread, SIGURG);
281         }
282
283         AST_LIST_UNLOCK(&aslist);
284
285         if (!removed) {
286                 return 0;
287         }
288
289         /* Wait while autoservice thread rebuilds its list. */
290         while (chan_list_state == as_chan_list_state) {
291                 usleep(1000);
292         }
293
294         /* Now autoservice thread should have no references to our entry
295            and we can safely destroy it */
296
297         if (!ast_channel_softhangup_internal_flag(chan)) {
298                 res = 0;
299         }
300
301         if (!as->orig_end_dtmf_flag) {
302                 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_END_DTMF_ONLY);
303         }
304
305         ast_channel_lock(chan);
306         while ((f = AST_LIST_REMOVE_HEAD(&as->deferred_frames, frame_list))) {
307                 if (!((1 << f->frametype) & as->ignore_frame_types)) {
308                         ast_queue_frame_head(chan, f);
309                 }
310                 ast_frfree(f);
311         }
312         ast_channel_unlock(chan);
313
314         free(as);
315
316         return res;
317 }
318
319 void ast_autoservice_chan_hangup_peer(struct ast_channel *chan, struct ast_channel *peer)
320 {
321         if (chan && !ast_autoservice_start(chan)) {
322                 ast_hangup(peer);
323                 ast_autoservice_stop(chan);
324         } else {
325                 ast_hangup(peer);
326         }
327 }
328
329 int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype)
330 {
331         struct asent *as;
332         int res = -1;
333
334         AST_LIST_LOCK(&aslist);
335         AST_LIST_TRAVERSE(&aslist, as, list) {
336                 if (as->chan == chan) {
337                         res = 0;
338                         as->ignore_frame_types |= (1 << ftype);
339                         break;
340                 }
341         }
342         AST_LIST_UNLOCK(&aslist);
343         return res;
344 }
345
346 void ast_autoservice_init(void)
347 {
348         ast_cond_init(&as_cond, NULL);
349 }