Merged revisions 119156 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         AST_LIST_HEAD_NOLOCK(, ast_frame) deferred_frames;
60         AST_LIST_ENTRY(asent) list;
61 };
62
63 static AST_LIST_HEAD_STATIC(aslist, asent);
64 static ast_cond_t as_cond;
65
66 static pthread_t asthread = AST_PTHREADT_NULL;
67
68 static int as_chan_list_state;
69
70 static void *autoservice_run(void *ign)
71 {
72         for (;;) {
73                 struct ast_channel *mons[MAX_AUTOMONS];
74                 struct asent *ents[MAX_AUTOMONS];
75                 struct ast_channel *chan;
76                 struct asent *as;
77                 int i, x = 0, ms = 50;
78                 struct ast_frame *f = NULL;
79                 struct ast_frame *defer_frame = NULL;
80
81                 AST_LIST_LOCK(&aslist);
82
83                 /* At this point, we know that no channels that have been removed are going
84                  * to get used again. */
85                 as_chan_list_state++;
86
87                 if (AST_LIST_EMPTY(&aslist)) {
88                         ast_cond_wait(&as_cond, &aslist.lock);
89                 }
90
91                 AST_LIST_TRAVERSE(&aslist, as, list) {
92                         if (!ast_check_hangup(as->chan)) {
93                                 if (x < MAX_AUTOMONS) {
94                                         ents[x] = as;
95                                         mons[x++] = as->chan;
96                                 } else {
97                                         ast_log(LOG_WARNING, "Exceeded maximum number of automatic monitoring events.  Fix autoservice.c\n");
98                                 }
99                         }
100                 }
101
102                 AST_LIST_UNLOCK(&aslist);
103
104                 chan = ast_waitfor_n(mons, x, &ms);
105                 if (!chan) {
106                         continue;
107                 }
108
109                 f = ast_read(chan);
110         
111                 if (!f) {
112                         struct ast_frame hangup_frame = { 0, };
113                         /* No frame means the channel has been hung up.
114                          * A hangup frame needs to be queued here as ast_waitfor() may
115                          * never return again for the condition to be detected outside
116                          * of autoservice.  So, we'll leave a HANGUP queued up so the
117                          * thread in charge of this channel will know. */
118
119                         hangup_frame.frametype = AST_FRAME_CONTROL;
120                         hangup_frame.subclass = AST_CONTROL_HANGUP;
121
122                         defer_frame = &hangup_frame;
123                 } else {
124
125                         /* Do not add a default entry in this switch statement.  Each new
126                          * frame type should be addressed directly as to whether it should
127                          * be queued up or not. */
128
129                         switch (f->frametype) {
130                         /* Save these frames */
131                         case AST_FRAME_DTMF_END:
132                         case AST_FRAME_CONTROL:
133                         case AST_FRAME_TEXT:
134                         case AST_FRAME_IMAGE:
135                         case AST_FRAME_HTML:
136                                 defer_frame = f;
137                                 break;
138
139                         /* Throw these frames away */
140                         case AST_FRAME_DTMF_BEGIN:
141                         case AST_FRAME_VOICE:
142                         case AST_FRAME_VIDEO:
143                         case AST_FRAME_NULL:
144                         case AST_FRAME_IAX:
145                         case AST_FRAME_CNG:
146                         case AST_FRAME_MODEM:
147                                 break;
148                         }
149                 }
150
151                 if (!defer_frame) {
152                         if (f) {
153                                 ast_frfree(f);
154                         }
155                         continue;
156                 }
157
158                 for (i = 0; i < x; i++) {
159                         struct ast_frame *dup_f;
160
161                         if (mons[i] != chan) {
162                                 continue;
163                         }
164
165                         if ((dup_f = ast_frdup(f))) {
166                                 AST_LIST_INSERT_TAIL(&ents[i]->deferred_frames, dup_f, frame_list);
167                         }
168                         
169                         break;
170                 }
171
172                 if (f) {
173                         ast_frfree(f);
174                 }
175         }
176
177         asthread = AST_PTHREADT_NULL;
178
179         return NULL;
180 }
181
182 int ast_autoservice_start(struct ast_channel *chan)
183 {
184         int res = 0;
185         struct asent *as;
186
187         AST_LIST_LOCK(&aslist);
188         AST_LIST_TRAVERSE(&aslist, as, list) {
189                 if (as->chan == chan) {
190                         as->use_count++;
191                         break;
192                 }
193         }
194         AST_LIST_UNLOCK(&aslist);
195
196         if (as) {
197                 /* Entry exists, autoservice is already handling this channel */
198                 return 0;
199         }
200
201         if (!(as = ast_calloc(1, sizeof(*as))))
202                 return -1;
203         
204         /* New entry created */
205         as->chan = chan;
206         as->use_count = 1;
207
208         ast_channel_lock(chan);
209         as->orig_end_dtmf_flag = ast_test_flag(chan, AST_FLAG_END_DTMF_ONLY) ? 1 : 0;
210         if (!as->orig_end_dtmf_flag)
211                 ast_set_flag(chan, AST_FLAG_END_DTMF_ONLY);
212         ast_channel_unlock(chan);
213
214         AST_LIST_LOCK(&aslist);
215
216         if (AST_LIST_EMPTY(&aslist) && asthread != AST_PTHREADT_NULL) {
217                 ast_cond_signal(&as_cond);
218         }
219
220         AST_LIST_INSERT_HEAD(&aslist, as, list);
221
222         if (asthread == AST_PTHREADT_NULL) { /* need start the thread */
223                 if (ast_pthread_create_background(&asthread, NULL, autoservice_run, NULL)) {
224                         ast_log(LOG_WARNING, "Unable to create autoservice thread :(\n");
225                         /* There will only be a single member in the list at this point,
226                            the one we just added. */
227                         AST_LIST_REMOVE(&aslist, as, list);
228                         free(as);
229                         asthread = AST_PTHREADT_NULL;
230                         res = -1;
231                 } else {
232                         pthread_kill(asthread, SIGURG);
233                 }
234         }
235
236         AST_LIST_UNLOCK(&aslist);
237
238         return res;
239 }
240
241 int ast_autoservice_stop(struct ast_channel *chan)
242 {
243         int res = -1;
244         struct asent *as, *removed = NULL;
245         struct ast_frame *f;
246         int chan_list_state;
247
248         AST_LIST_LOCK(&aslist);
249
250         /* Save the autoservice channel list state.  We _must_ verify that the channel
251          * list has been rebuilt before we return.  Because, after we return, the channel
252          * could get destroyed and we don't want our poor autoservice thread to step on
253          * it after its gone! */
254         chan_list_state = as_chan_list_state;
255
256         /* Find the entry, but do not free it because it still can be in the
257            autoservice thread array */
258         AST_LIST_TRAVERSE_SAFE_BEGIN(&aslist, as, list) {       
259                 if (as->chan == chan) {
260                         as->use_count--;
261                         if (as->use_count < 1) {
262                                 AST_LIST_REMOVE_CURRENT(list);
263                                 removed = as;
264                         }
265                         break;
266                 }
267         }
268         AST_LIST_TRAVERSE_SAFE_END;
269
270         if (removed && asthread != AST_PTHREADT_NULL) {
271                 pthread_kill(asthread, SIGURG);
272         }
273
274         AST_LIST_UNLOCK(&aslist);
275
276         if (!removed) {
277                 return 0;
278         }
279
280         /* Wait while autoservice thread rebuilds its list. */
281         while (chan_list_state == as_chan_list_state) {
282                 usleep(1000);
283         }
284
285         /* Now autoservice thread should have no references to our entry
286            and we can safely destroy it */
287
288         if (!chan->_softhangup) {
289                 res = 0;
290         }
291
292         if (!as->orig_end_dtmf_flag) {
293                 ast_clear_flag(chan, AST_FLAG_END_DTMF_ONLY);
294         }
295
296         while ((f = AST_LIST_REMOVE_HEAD(&as->deferred_frames, frame_list))) {
297                 ast_queue_frame(chan, f);
298                 ast_frfree(f);
299         }
300
301         free(as);
302
303         return res;
304 }
305
306 void ast_autoservice_init(void)
307 {
308         ast_cond_init(&as_cond, NULL);
309 }