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