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