Logger: Convert 'struct ast_callid' to unsigned int.
[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 static volatile int asexit = 0;
76
77 static int as_chan_list_state;
78
79 static void *autoservice_run(void *ign)
80 {
81         ast_callid callid = 0;
82         struct ast_frame hangup_frame = {
83                 .frametype = AST_FRAME_CONTROL,
84                 .subclass.integer = AST_CONTROL_HANGUP,
85         };
86
87         while (!asexit) {
88                 struct ast_channel *mons[MAX_AUTOMONS];
89                 struct asent *ents[MAX_AUTOMONS];
90                 struct ast_channel *chan;
91                 struct asent *as;
92                 int i, x = 0, ms = 50;
93                 struct ast_frame *f = NULL;
94                 struct ast_frame *defer_frame = NULL;
95
96                 AST_LIST_LOCK(&aslist);
97
98                 /* At this point, we know that no channels that have been removed are going
99                  * to get used again. */
100                 as_chan_list_state++;
101
102                 if (AST_LIST_EMPTY(&aslist)) {
103                         ast_cond_wait(&as_cond, &aslist.lock);
104                 }
105
106                 AST_LIST_TRAVERSE(&aslist, as, list) {
107                         if (!ast_check_hangup(as->chan)) {
108                                 if (x < MAX_AUTOMONS) {
109                                         ents[x] = as;
110                                         mons[x++] = as->chan;
111                                 } else {
112                                         ast_log(LOG_WARNING, "Exceeded maximum number of automatic monitoring events.  Fix autoservice.c\n");
113                                 }
114                         }
115                 }
116
117                 AST_LIST_UNLOCK(&aslist);
118
119                 if (!x) {
120                         /* If we don't sleep, this becomes a busy loop, which causes
121                          * problems when Asterisk runs at a different priority than other
122                          * user processes.  As long as we check for new channels at least
123                          * once every 10ms, we should be fine. */
124                         usleep(10000);
125                         continue;
126                 }
127
128                 chan = ast_waitfor_n(mons, x, &ms);
129                 if (!chan) {
130                         continue;
131                 }
132
133                 callid = ast_channel_callid(chan);
134                 ast_callid_threadassoc_change(callid);
135
136                 f = ast_read(chan);
137
138                 if (!f) {
139                         /* No frame means the channel has been hung up.
140                          * A hangup frame needs to be queued here as ast_waitfor() may
141                          * never return again for the condition to be detected outside
142                          * of autoservice.  So, we'll leave a HANGUP queued up so the
143                          * thread in charge of this channel will know. */
144
145                         defer_frame = &hangup_frame;
146                 } else if (ast_is_deferrable_frame(f)) {
147                         defer_frame = f;
148                 } else {
149                         /* Can't defer. Discard and continue with next. */
150                         ast_frfree(f);
151                         continue;
152                 }
153
154                 for (i = 0; i < x; i++) {
155                         struct ast_frame *dup_f;
156
157                         if (mons[i] != chan) {
158                                 continue;
159                         }
160
161                         if (!f) { /* defer_frame == &hangup_frame */
162                                 if ((dup_f = ast_frdup(defer_frame))) {
163                                         AST_LIST_INSERT_HEAD(&ents[i]->deferred_frames, dup_f, frame_list);
164                                 }
165                         } else {
166                                 if ((dup_f = ast_frisolate(defer_frame))) {
167                                         AST_LIST_INSERT_HEAD(&ents[i]->deferred_frames, dup_f, frame_list);
168                                 }
169                                 if (dup_f != defer_frame) {
170                                         ast_frfree(defer_frame);
171                                 }
172                         }
173
174                         break;
175                 }
176                 /* The ast_waitfor_n() call will only read frames from
177                  * the channels' file descriptors. If ast_waitfor_n()
178                  * returns non-NULL, then one of the channels in the
179                  * mons array must have triggered the return. It's
180                  * therefore impossible that we got here while (i >= x).
181                  * If we did, we'd need to ast_frfree(f) if (f). */
182         }
183
184         ast_callid_threadassoc_change(0);
185         asthread = AST_PTHREADT_NULL;
186
187         return NULL;
188 }
189
190 int ast_autoservice_start(struct ast_channel *chan)
191 {
192         int res = 0;
193         struct asent *as;
194
195         AST_LIST_LOCK(&aslist);
196         AST_LIST_TRAVERSE(&aslist, as, list) {
197                 if (as->chan == chan) {
198                         as->use_count++;
199                         break;
200                 }
201         }
202         AST_LIST_UNLOCK(&aslist);
203
204         if (as) {
205                 /* Entry exists, autoservice is already handling this channel */
206                 return 0;
207         }
208
209         if (!(as = ast_calloc(1, sizeof(*as))))
210                 return -1;
211
212         /* New entry created */
213         as->chan = chan;
214         as->use_count = 1;
215
216         ast_channel_lock(chan);
217         as->orig_end_dtmf_flag = ast_test_flag(ast_channel_flags(chan), AST_FLAG_END_DTMF_ONLY) ? 1 : 0;
218         if (!as->orig_end_dtmf_flag)
219                 ast_set_flag(ast_channel_flags(chan), AST_FLAG_END_DTMF_ONLY);
220         ast_channel_unlock(chan);
221
222         AST_LIST_LOCK(&aslist);
223
224         if (AST_LIST_EMPTY(&aslist) && asthread != AST_PTHREADT_NULL) {
225                 ast_cond_signal(&as_cond);
226         }
227
228         AST_LIST_INSERT_HEAD(&aslist, as, list);
229
230         if (asthread == AST_PTHREADT_NULL) { /* need start the thread */
231                 if (ast_pthread_create_background(&asthread, NULL, autoservice_run, NULL)) {
232                         ast_log(LOG_WARNING, "Unable to create autoservice thread :(\n");
233                         /* There will only be a single member in the list at this point,
234                            the one we just added. */
235                         AST_LIST_REMOVE(&aslist, as, list);
236                         ast_free(as);
237                         asthread = AST_PTHREADT_NULL;
238                         res = -1;
239                 } else {
240                         pthread_kill(asthread, SIGURG);
241                 }
242         }
243
244         AST_LIST_UNLOCK(&aslist);
245
246         return res;
247 }
248
249 int ast_autoservice_stop(struct ast_channel *chan)
250 {
251         int res = -1;
252         struct asent *as, *removed = NULL;
253         struct ast_frame *f;
254         int chan_list_state;
255
256         AST_LIST_LOCK(&aslist);
257
258         /* Save the autoservice channel list state.  We _must_ verify that the channel
259          * list has been rebuilt before we return.  Because, after we return, the channel
260          * could get destroyed and we don't want our poor autoservice thread to step on
261          * it after its gone! */
262         chan_list_state = as_chan_list_state;
263
264         /* Find the entry, but do not free it because it still can be in the
265            autoservice thread array */
266         AST_LIST_TRAVERSE_SAFE_BEGIN(&aslist, as, list) {
267                 if (as->chan == chan) {
268                         as->use_count--;
269                         if (as->use_count < 1) {
270                                 AST_LIST_REMOVE_CURRENT(list);
271                                 removed = as;
272                         }
273                         break;
274                 }
275         }
276         AST_LIST_TRAVERSE_SAFE_END;
277
278         if (removed && asthread != AST_PTHREADT_NULL) {
279                 pthread_kill(asthread, SIGURG);
280         }
281
282         AST_LIST_UNLOCK(&aslist);
283
284         if (!removed) {
285                 return 0;
286         }
287
288         /* Wait while autoservice thread rebuilds its list. */
289         while (chan_list_state == as_chan_list_state) {
290                 usleep(1000);
291         }
292
293         /* Now autoservice thread should have no references to our entry
294            and we can safely destroy it */
295
296         if (!ast_channel_softhangup_internal_flag(chan)) {
297                 res = 0;
298         }
299
300         if (!as->orig_end_dtmf_flag) {
301                 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_END_DTMF_ONLY);
302         }
303
304         ast_channel_lock(chan);
305         while ((f = AST_LIST_REMOVE_HEAD(&as->deferred_frames, frame_list))) {
306                 if (!((1 << f->frametype) & as->ignore_frame_types)) {
307                         ast_queue_frame_head(chan, f);
308                 }
309                 ast_frfree(f);
310         }
311         ast_channel_unlock(chan);
312
313         ast_free(as);
314
315         return res;
316 }
317
318 void ast_autoservice_chan_hangup_peer(struct ast_channel *chan, struct ast_channel *peer)
319 {
320         if (chan && !ast_autoservice_start(chan)) {
321                 ast_hangup(peer);
322                 ast_autoservice_stop(chan);
323         } else {
324                 ast_hangup(peer);
325         }
326 }
327
328 int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype)
329 {
330         struct asent *as;
331         int res = -1;
332
333         AST_LIST_LOCK(&aslist);
334         AST_LIST_TRAVERSE(&aslist, as, list) {
335                 if (as->chan == chan) {
336                         res = 0;
337                         as->ignore_frame_types |= (1 << ftype);
338                         break;
339                 }
340         }
341         AST_LIST_UNLOCK(&aslist);
342         return res;
343 }
344
345 static void autoservice_shutdown(void)
346 {
347         pthread_t th = asthread;
348         asexit = 1;
349         if (th != AST_PTHREADT_NULL) {
350                 ast_cond_signal(&as_cond);
351                 pthread_kill(th, SIGURG);
352                 pthread_join(th, NULL);
353         }
354 }
355
356 void ast_autoservice_init(void)
357 {
358         ast_register_cleanup(autoservice_shutdown);
359         ast_cond_init(&as_cond, NULL);
360 }