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