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