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