Protect ast_filestream object when on a channel
[asterisk/asterisk.git] / main / channel.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Channel Management
22  *
23  * \author Mark Spencer <markster@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/_private.h"
35
36 #include <sys/time.h>
37 #include <signal.h>
38 #include <math.h>
39
40 #include "asterisk/paths.h"     /* use ast_config_AST_SYSTEM_NAME */
41
42 #include "asterisk/pbx.h"
43 #include "asterisk/frame.h"
44 #include "asterisk/mod_format.h"
45 #include "asterisk/sched.h"
46 #include "asterisk/channel.h"
47 #include "asterisk/musiconhold.h"
48 #include "asterisk/say.h"
49 #include "asterisk/file.h"
50 #include "asterisk/cli.h"
51 #include "asterisk/translate.h"
52 #include "asterisk/manager.h"
53 #include "asterisk/chanvars.h"
54 #include "asterisk/linkedlists.h"
55 #include "asterisk/indications.h"
56 #include "asterisk/monitor.h"
57 #include "asterisk/causes.h"
58 #include "asterisk/callerid.h"
59 #include "asterisk/utils.h"
60 #include "asterisk/lock.h"
61 #include "asterisk/app.h"
62 #include "asterisk/transcap.h"
63 #include "asterisk/devicestate.h"
64 #include "asterisk/threadstorage.h"
65 #include "asterisk/slinfactory.h"
66 #include "asterisk/audiohook.h"
67 #include "asterisk/framehook.h"
68 #include "asterisk/timing.h"
69 #include "asterisk/autochan.h"
70 #include "asterisk/stringfields.h"
71 #include "asterisk/global_datastores.h"
72 #include "asterisk/data.h"
73 #include "asterisk/channel_internal.h"
74 #include "asterisk/features.h"
75 #include "asterisk/bridge.h"
76 #include "asterisk/test.h"
77 #include "asterisk/stasis_channels.h"
78
79 /*** DOCUMENTATION
80  ***/
81
82 #ifdef HAVE_EPOLL
83 #include <sys/epoll.h>
84 #endif
85
86 #if defined(KEEP_TILL_CHANNEL_PARTY_NUMBER_INFO_NEEDED)
87 #if defined(HAVE_PRI)
88 #include "libpri.h"
89 #endif  /* defined(HAVE_PRI) */
90 #endif  /* defined(KEEP_TILL_CHANNEL_PARTY_NUMBER_INFO_NEEDED) */
91
92 struct ast_epoll_data {
93         struct ast_channel *chan;
94         int which;
95 };
96
97 /* uncomment if you have problems with 'monitoring' synchronized files */
98 #if 0
99 #define MONITOR_CONSTANT_DELAY
100 #define MONITOR_DELAY   150 * 8         /*!< 150 ms of MONITORING DELAY */
101 #endif
102
103 /*! \brief Prevent new channel allocation if shutting down. */
104 static int shutting_down;
105
106 static int chancount;
107
108 unsigned long global_fin, global_fout;
109
110 AST_THREADSTORAGE(state2str_threadbuf);
111 #define STATE2STR_BUFSIZE   32
112
113 /*! Default amount of time to use when emulating a digit as a begin and end
114  *  100ms */
115 #define AST_DEFAULT_EMULATE_DTMF_DURATION 100
116
117 #define DEFAULT_AMA_FLAGS AST_AMA_DOCUMENTATION
118
119 /*! Minimum amount of time between the end of the last digit and the beginning
120  *  of a new one - 45ms */
121 #define AST_MIN_DTMF_GAP 45
122
123 /*! \brief List of channel drivers */
124 struct chanlist {
125         const struct ast_channel_tech *tech;
126         AST_LIST_ENTRY(chanlist) list;
127 };
128
129 /*! \brief the list of registered channel types */
130 static AST_RWLIST_HEAD_STATIC(backends, chanlist);
131
132 #ifdef LOW_MEMORY
133 #define NUM_CHANNEL_BUCKETS 61
134 #else
135 #define NUM_CHANNEL_BUCKETS 1567
136 #endif
137
138 /*! \brief All active channels on the system */
139 static struct ao2_container *channels;
140
141 /*! \brief map AST_CAUSE's to readable string representations
142  *
143  * \ref causes.h
144 */
145 struct causes_map {
146         int cause;
147         const char *name;
148         const char *desc;
149 };
150
151 static const struct causes_map causes[] = {
152         { AST_CAUSE_UNALLOCATED, "UNALLOCATED", "Unallocated (unassigned) number" },
153         { AST_CAUSE_NO_ROUTE_TRANSIT_NET, "NO_ROUTE_TRANSIT_NET", "No route to specified transmit network" },
154         { AST_CAUSE_NO_ROUTE_DESTINATION, "NO_ROUTE_DESTINATION", "No route to destination" },
155         { AST_CAUSE_MISDIALLED_TRUNK_PREFIX, "MISDIALLED_TRUNK_PREFIX", "Misdialed trunk prefix" },
156         { AST_CAUSE_CHANNEL_UNACCEPTABLE, "CHANNEL_UNACCEPTABLE", "Channel unacceptable" },
157         { AST_CAUSE_CALL_AWARDED_DELIVERED, "CALL_AWARDED_DELIVERED", "Call awarded and being delivered in an established channel" },
158         { AST_CAUSE_PRE_EMPTED, "PRE_EMPTED", "Pre-empted" },
159         { AST_CAUSE_NUMBER_PORTED_NOT_HERE, "NUMBER_PORTED_NOT_HERE", "Number ported elsewhere" },
160         { AST_CAUSE_NORMAL_CLEARING, "NORMAL_CLEARING", "Normal Clearing" },
161         { AST_CAUSE_USER_BUSY, "USER_BUSY", "User busy" },
162         { AST_CAUSE_NO_USER_RESPONSE, "NO_USER_RESPONSE", "No user responding" },
163         { AST_CAUSE_NO_ANSWER, "NO_ANSWER", "User alerting, no answer" },
164         { AST_CAUSE_SUBSCRIBER_ABSENT, "SUBSCRIBER_ABSENT", "Subscriber absent" },
165         { AST_CAUSE_CALL_REJECTED, "CALL_REJECTED", "Call Rejected" },
166         { AST_CAUSE_NUMBER_CHANGED, "NUMBER_CHANGED", "Number changed" },
167         { AST_CAUSE_REDIRECTED_TO_NEW_DESTINATION, "REDIRECTED_TO_NEW_DESTINATION", "Redirected to new destination" },
168         { AST_CAUSE_ANSWERED_ELSEWHERE, "ANSWERED_ELSEWHERE", "Answered elsewhere" },
169         { AST_CAUSE_DESTINATION_OUT_OF_ORDER, "DESTINATION_OUT_OF_ORDER", "Destination out of order" },
170         { AST_CAUSE_INVALID_NUMBER_FORMAT, "INVALID_NUMBER_FORMAT", "Invalid number format" },
171         { AST_CAUSE_FACILITY_REJECTED, "FACILITY_REJECTED", "Facility rejected" },
172         { AST_CAUSE_RESPONSE_TO_STATUS_ENQUIRY, "RESPONSE_TO_STATUS_ENQUIRY", "Response to STATus ENQuiry" },
173         { AST_CAUSE_NORMAL_UNSPECIFIED, "NORMAL_UNSPECIFIED", "Normal, unspecified" },
174         { AST_CAUSE_NORMAL_CIRCUIT_CONGESTION, "NORMAL_CIRCUIT_CONGESTION", "Circuit/channel congestion" },
175         { AST_CAUSE_NETWORK_OUT_OF_ORDER, "NETWORK_OUT_OF_ORDER", "Network out of order" },
176         { AST_CAUSE_NORMAL_TEMPORARY_FAILURE, "NORMAL_TEMPORARY_FAILURE", "Temporary failure" },
177         { AST_CAUSE_SWITCH_CONGESTION, "SWITCH_CONGESTION", "Switching equipment congestion" },
178         { AST_CAUSE_ACCESS_INFO_DISCARDED, "ACCESS_INFO_DISCARDED", "Access information discarded" },
179         { AST_CAUSE_REQUESTED_CHAN_UNAVAIL, "REQUESTED_CHAN_UNAVAIL", "Requested channel not available" },
180         { AST_CAUSE_FACILITY_NOT_SUBSCRIBED, "FACILITY_NOT_SUBSCRIBED", "Facility not subscribed" },
181         { AST_CAUSE_OUTGOING_CALL_BARRED, "OUTGOING_CALL_BARRED", "Outgoing call barred" },
182         { AST_CAUSE_INCOMING_CALL_BARRED, "INCOMING_CALL_BARRED", "Incoming call barred" },
183         { AST_CAUSE_BEARERCAPABILITY_NOTAUTH, "BEARERCAPABILITY_NOTAUTH", "Bearer capability not authorized" },
184         { AST_CAUSE_BEARERCAPABILITY_NOTAVAIL, "BEARERCAPABILITY_NOTAVAIL", "Bearer capability not available" },
185         { AST_CAUSE_BEARERCAPABILITY_NOTIMPL, "BEARERCAPABILITY_NOTIMPL", "Bearer capability not implemented" },
186         { AST_CAUSE_CHAN_NOT_IMPLEMENTED, "CHAN_NOT_IMPLEMENTED", "Channel not implemented" },
187         { AST_CAUSE_FACILITY_NOT_IMPLEMENTED, "FACILITY_NOT_IMPLEMENTED", "Facility not implemented" },
188         { AST_CAUSE_INVALID_CALL_REFERENCE, "INVALID_CALL_REFERENCE", "Invalid call reference value" },
189         { AST_CAUSE_INCOMPATIBLE_DESTINATION, "INCOMPATIBLE_DESTINATION", "Incompatible destination" },
190         { AST_CAUSE_INVALID_MSG_UNSPECIFIED, "INVALID_MSG_UNSPECIFIED", "Invalid message unspecified" },
191         { AST_CAUSE_MANDATORY_IE_MISSING, "MANDATORY_IE_MISSING", "Mandatory information element is missing" },
192         { AST_CAUSE_MESSAGE_TYPE_NONEXIST, "MESSAGE_TYPE_NONEXIST", "Message type nonexist." },
193         { AST_CAUSE_WRONG_MESSAGE, "WRONG_MESSAGE", "Wrong message" },
194         { AST_CAUSE_IE_NONEXIST, "IE_NONEXIST", "Info. element nonexist or not implemented" },
195         { AST_CAUSE_INVALID_IE_CONTENTS, "INVALID_IE_CONTENTS", "Invalid information element contents" },
196         { AST_CAUSE_WRONG_CALL_STATE, "WRONG_CALL_STATE", "Message not compatible with call state" },
197         { AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE, "RECOVERY_ON_TIMER_EXPIRE", "Recover on timer expiry" },
198         { AST_CAUSE_MANDATORY_IE_LENGTH_ERROR, "MANDATORY_IE_LENGTH_ERROR", "Mandatory IE length error" },
199         { AST_CAUSE_PROTOCOL_ERROR, "PROTOCOL_ERROR", "Protocol error, unspecified" },
200         { AST_CAUSE_INTERWORKING, "INTERWORKING", "Interworking, unspecified" },
201 };
202
203 struct ast_variable *ast_channeltype_list(void)
204 {
205         struct chanlist *cl;
206         struct ast_variable *var = NULL, *prev = NULL;
207
208         AST_RWLIST_RDLOCK(&backends);
209         AST_RWLIST_TRAVERSE(&backends, cl, list) {
210                 if (prev)  {
211                         if ((prev->next = ast_variable_new(cl->tech->type, cl->tech->description, "")))
212                                 prev = prev->next;
213                 } else {
214                         var = ast_variable_new(cl->tech->type, cl->tech->description, "");
215                         prev = var;
216                 }
217         }
218         AST_RWLIST_UNLOCK(&backends);
219
220         return var;
221 }
222
223 #if defined(KEEP_TILL_CHANNEL_PARTY_NUMBER_INFO_NEEDED)
224 static const char *party_number_ton2str(int ton)
225 {
226 #if defined(HAVE_PRI)
227         switch ((ton >> 4) & 0x07) {
228         case PRI_TON_INTERNATIONAL:
229                 return "International";
230         case PRI_TON_NATIONAL:
231                 return "National";
232         case PRI_TON_NET_SPECIFIC:
233                 return "Network Specific";
234         case PRI_TON_SUBSCRIBER:
235                 return "Subscriber";
236         case PRI_TON_ABBREVIATED:
237                 return "Abbreviated";
238         case PRI_TON_RESERVED:
239                 return "Reserved";
240         case PRI_TON_UNKNOWN:
241         default:
242                 break;
243         }
244 #endif  /* defined(HAVE_PRI) */
245         return "Unknown";
246 }
247 #endif  /* defined(KEEP_TILL_CHANNEL_PARTY_NUMBER_INFO_NEEDED) */
248
249 #if defined(KEEP_TILL_CHANNEL_PARTY_NUMBER_INFO_NEEDED)
250 static const char *party_number_plan2str(int plan)
251 {
252 #if defined(HAVE_PRI)
253         switch (plan & 0x0F) {
254         default:
255         case PRI_NPI_UNKNOWN:
256                 break;
257         case PRI_NPI_E163_E164:
258                 return "Public (E.163/E.164)";
259         case PRI_NPI_X121:
260                 return "Data (X.121)";
261         case PRI_NPI_F69:
262                 return "Telex (F.69)";
263         case PRI_NPI_NATIONAL:
264                 return "National Standard";
265         case PRI_NPI_PRIVATE:
266                 return "Private";
267         case PRI_NPI_RESERVED:
268                 return "Reserved";
269         }
270 #endif  /* defined(HAVE_PRI) */
271         return "Unknown";
272 }
273 #endif  /* defined(KEEP_TILL_CHANNEL_PARTY_NUMBER_INFO_NEEDED) */
274
275 /*! \brief Show channel types - CLI command */
276 static char *handle_cli_core_show_channeltypes(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
277 {
278 #define FORMAT  "%-15.15s  %-40.40s %-12.12s %-12.12s %-12.12s\n"
279         struct chanlist *cl;
280         int count_chan = 0;
281
282         switch (cmd) {
283         case CLI_INIT:
284                 e->command = "core show channeltypes";
285                 e->usage =
286                         "Usage: core show channeltypes\n"
287                         "       Lists available channel types registered in your\n"
288                         "       Asterisk server.\n";
289                 return NULL;
290         case CLI_GENERATE:
291                 return NULL;
292         }
293
294         if (a->argc != 3)
295                 return CLI_SHOWUSAGE;
296
297         ast_cli(a->fd, FORMAT, "Type", "Description",       "Devicestate", "Indications", "Transfer");
298         ast_cli(a->fd, FORMAT, "-----------", "-----------", "-----------", "-----------", "-----------");
299
300         AST_RWLIST_RDLOCK(&backends);
301         AST_RWLIST_TRAVERSE(&backends, cl, list) {
302                 ast_cli(a->fd, FORMAT, cl->tech->type, cl->tech->description,
303                         (cl->tech->devicestate) ? "yes" : "no",
304                         (cl->tech->indicate) ? "yes" : "no",
305                         (cl->tech->transfer) ? "yes" : "no");
306                 count_chan++;
307         }
308         AST_RWLIST_UNLOCK(&backends);
309
310         ast_cli(a->fd, "----------\n%d channel drivers registered.\n", count_chan);
311
312         return CLI_SUCCESS;
313
314 #undef FORMAT
315 }
316
317 static char *complete_channeltypes(struct ast_cli_args *a)
318 {
319         struct chanlist *cl;
320         int which = 0;
321         int wordlen;
322         char *ret = NULL;
323
324         if (a->pos != 3)
325                 return NULL;
326
327         wordlen = strlen(a->word);
328
329         AST_RWLIST_RDLOCK(&backends);
330         AST_RWLIST_TRAVERSE(&backends, cl, list) {
331                 if (!strncasecmp(a->word, cl->tech->type, wordlen) && ++which > a->n) {
332                         ret = ast_strdup(cl->tech->type);
333                         break;
334                 }
335         }
336         AST_RWLIST_UNLOCK(&backends);
337
338         return ret;
339 }
340
341 /*! \brief Show details about a channel driver - CLI command */
342 static char *handle_cli_core_show_channeltype(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
343 {
344         struct chanlist *cl = NULL;
345         char buf[512];
346
347         switch (cmd) {
348         case CLI_INIT:
349                 e->command = "core show channeltype";
350                 e->usage =
351                         "Usage: core show channeltype <name>\n"
352                         "       Show details about the specified channel type, <name>.\n";
353                 return NULL;
354         case CLI_GENERATE:
355                 return complete_channeltypes(a);
356         }
357
358         if (a->argc != 4)
359                 return CLI_SHOWUSAGE;
360
361         AST_RWLIST_RDLOCK(&backends);
362
363         AST_RWLIST_TRAVERSE(&backends, cl, list) {
364                 if (!strncasecmp(cl->tech->type, a->argv[3], strlen(cl->tech->type)))
365                         break;
366         }
367
368
369         if (!cl) {
370                 ast_cli(a->fd, "\n%s is not a registered channel driver.\n", a->argv[3]);
371                 AST_RWLIST_UNLOCK(&backends);
372                 return CLI_FAILURE;
373         }
374
375         ast_cli(a->fd,
376                 "-- Info about channel driver: %s --\n"
377                 "  Device State: %s\n"
378                 "    Indication: %s\n"
379                 "     Transfer : %s\n"
380                 "  Capabilities: %s\n"
381                 "   Digit Begin: %s\n"
382                 "     Digit End: %s\n"
383                 "    Send HTML : %s\n"
384                 " Image Support: %s\n"
385                 "  Text Support: %s\n",
386                 cl->tech->type,
387                 (cl->tech->devicestate) ? "yes" : "no",
388                 (cl->tech->indicate) ? "yes" : "no",
389                 (cl->tech->transfer) ? "yes" : "no",
390                 ast_getformatname_multiple(buf, sizeof(buf), cl->tech->capabilities),
391                 (cl->tech->send_digit_begin) ? "yes" : "no",
392                 (cl->tech->send_digit_end) ? "yes" : "no",
393                 (cl->tech->send_html) ? "yes" : "no",
394                 (cl->tech->send_image) ? "yes" : "no",
395                 (cl->tech->send_text) ? "yes" : "no"
396
397         );
398
399         AST_RWLIST_UNLOCK(&backends);
400
401         return CLI_SUCCESS;
402 }
403
404 static struct ast_cli_entry cli_channel[] = {
405         AST_CLI_DEFINE(handle_cli_core_show_channeltypes, "List available channel types"),
406         AST_CLI_DEFINE(handle_cli_core_show_channeltype,  "Give more details on that channel type")
407 };
408
409 static struct ast_frame *kill_read(struct ast_channel *chan)
410 {
411         /* Hangup channel. */
412         return NULL;
413 }
414
415 static struct ast_frame *kill_exception(struct ast_channel *chan)
416 {
417         /* Hangup channel. */
418         return NULL;
419 }
420
421 static int kill_write(struct ast_channel *chan, struct ast_frame *frame)
422 {
423         /* Hangup channel. */
424         return -1;
425 }
426
427 static int kill_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
428 {
429         /* No problem fixing up the channel. */
430         return 0;
431 }
432
433 static int kill_hangup(struct ast_channel *chan)
434 {
435         ast_channel_tech_pvt_set(chan, NULL);
436         return 0;
437 }
438
439 /*!
440  * \brief Kill the channel channel driver technology descriptor.
441  *
442  * \details
443  * The purpose of this channel technology is to encourage the
444  * channel to hangup as quickly as possible.
445  *
446  * \note Used by DTMF atxfer and zombie channels.
447  */
448 const struct ast_channel_tech ast_kill_tech = {
449         .type = "Kill",
450         .description = "Kill channel (should not see this)",
451         .read = kill_read,
452         .exception = kill_exception,
453         .write = kill_write,
454         .fixup = kill_fixup,
455         .hangup = kill_hangup,
456 };
457
458 /*! \brief Checks to see if a channel is needing hang up */
459 int ast_check_hangup(struct ast_channel *chan)
460 {
461         if (ast_channel_softhangup_internal_flag(chan))         /* yes if soft hangup flag set */
462                 return 1;
463         if (ast_tvzero(*ast_channel_whentohangup(chan)))        /* no if no hangup scheduled */
464                 return 0;
465         if (ast_tvdiff_ms(*ast_channel_whentohangup(chan), ast_tvnow()) > 0)            /* no if hangup time has not come yet. */
466                 return 0;
467         ast_debug(4, "Hangup time has come: %" PRIi64 "\n", ast_tvdiff_ms(*ast_channel_whentohangup(chan), ast_tvnow()));
468         ast_test_suite_event_notify("HANGUP_TIME", "Channel: %s", ast_channel_name(chan));
469         ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_TIMEOUT); /* record event */
470         return 1;
471 }
472
473 int ast_check_hangup_locked(struct ast_channel *chan)
474 {
475         int res;
476         ast_channel_lock(chan);
477         res = ast_check_hangup(chan);
478         ast_channel_unlock(chan);
479         return res;
480 }
481
482 void ast_channel_softhangup_withcause_locked(struct ast_channel *chan, int causecode)
483 {
484         ast_channel_lock(chan);
485
486         if (causecode > 0) {
487                 ast_debug(1, "Setting hangupcause of channel %s to %d (is %d now)\n",
488                         ast_channel_name(chan), causecode, ast_channel_hangupcause(chan));
489
490                 ast_channel_hangupcause_set(chan, causecode);
491         }
492
493         ast_softhangup_nolock(chan, AST_SOFTHANGUP_EXPLICIT);
494
495         ast_channel_unlock(chan);
496 }
497
498 static int ast_channel_softhangup_cb(void *obj, void *arg, int flags)
499 {
500         struct ast_channel *chan = obj;
501
502         ast_softhangup(chan, AST_SOFTHANGUP_SHUTDOWN);
503
504         return 0;
505 }
506
507 void ast_begin_shutdown(int hangup)
508 {
509         shutting_down = 1;
510
511         if (hangup) {
512                 ao2_callback(channels, OBJ_NODATA | OBJ_MULTIPLE, ast_channel_softhangup_cb, NULL);
513         }
514 }
515
516 /*! \brief returns number of active/allocated channels */
517 int ast_active_channels(void)
518 {
519         return channels ? ao2_container_count(channels) : 0;
520 }
521
522 int ast_undestroyed_channels(void)
523 {
524         return ast_atomic_fetchadd_int(&chancount, 0);
525 }
526
527 /*! \brief Cancel a shutdown in progress */
528 void ast_cancel_shutdown(void)
529 {
530         shutting_down = 0;
531 }
532
533 /*! \brief Returns non-zero if Asterisk is being shut down */
534 int ast_shutting_down(void)
535 {
536         return shutting_down;
537 }
538
539 /*! \brief Set when to hangup channel */
540 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset)
541 {
542         if (ast_tvzero(offset)) {
543                 ast_channel_whentohangup_set(chan, &offset);
544         } else {
545                 struct timeval tv = ast_tvadd(offset, ast_tvnow());
546                 ast_channel_whentohangup_set(chan, &tv);
547         }
548         ast_queue_frame(chan, &ast_null_frame);
549         return;
550 }
551
552 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset)
553 {
554         struct timeval when = { offset, };
555         ast_channel_setwhentohangup_tv(chan, when);
556 }
557
558 /*! \brief Compare a offset with when to hangup channel */
559 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset)
560 {
561         struct timeval whentohangup;
562
563         if (ast_tvzero(*ast_channel_whentohangup(chan)))
564                 return ast_tvzero(offset) ? 0 : -1;
565
566         if (ast_tvzero(offset))
567                 return 1;
568
569         whentohangup = ast_tvadd(offset, ast_tvnow());
570
571         return ast_tvdiff_ms(whentohangup, *ast_channel_whentohangup(chan));
572 }
573
574 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset)
575 {
576         struct timeval when = { offset, };
577         return ast_channel_cmpwhentohangup_tv(chan, when);
578 }
579
580 /*! \brief Register a new telephony channel in Asterisk */
581 int ast_channel_register(const struct ast_channel_tech *tech)
582 {
583         struct chanlist *chan;
584
585         AST_RWLIST_WRLOCK(&backends);
586
587         AST_RWLIST_TRAVERSE(&backends, chan, list) {
588                 if (!strcasecmp(tech->type, chan->tech->type)) {
589                         ast_log(LOG_WARNING, "Already have a handler for type '%s'\n", tech->type);
590                         AST_RWLIST_UNLOCK(&backends);
591                         return -1;
592                 }
593         }
594
595         if (!(chan = ast_calloc(1, sizeof(*chan)))) {
596                 AST_RWLIST_UNLOCK(&backends);
597                 return -1;
598         }
599         chan->tech = tech;
600         AST_RWLIST_INSERT_HEAD(&backends, chan, list);
601
602         ast_debug(1, "Registered handler for '%s' (%s)\n", chan->tech->type, chan->tech->description);
603
604         ast_verb(2, "Registered channel type '%s' (%s)\n", chan->tech->type, chan->tech->description);
605
606         AST_RWLIST_UNLOCK(&backends);
607
608         return 0;
609 }
610
611 /*! \brief Unregister channel driver */
612 void ast_channel_unregister(const struct ast_channel_tech *tech)
613 {
614         struct chanlist *chan;
615
616         ast_debug(1, "Unregistering channel type '%s'\n", tech->type);
617
618         AST_RWLIST_WRLOCK(&backends);
619
620         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&backends, chan, list) {
621                 if (chan->tech == tech) {
622                         AST_LIST_REMOVE_CURRENT(list);
623                         ast_free(chan);
624                         ast_verb(2, "Unregistered channel type '%s'\n", tech->type);
625                         break;
626                 }
627         }
628         AST_LIST_TRAVERSE_SAFE_END;
629
630         AST_RWLIST_UNLOCK(&backends);
631 }
632
633 /*! \brief Get handle to channel driver based on name */
634 const struct ast_channel_tech *ast_get_channel_tech(const char *name)
635 {
636         struct chanlist *chanls;
637         const struct ast_channel_tech *ret = NULL;
638
639         AST_RWLIST_RDLOCK(&backends);
640
641         AST_RWLIST_TRAVERSE(&backends, chanls, list) {
642                 if (!strcasecmp(name, chanls->tech->type)) {
643                         ret = chanls->tech;
644                         break;
645                 }
646         }
647
648         AST_RWLIST_UNLOCK(&backends);
649
650         return ret;
651 }
652
653 /*! \brief Gives the string form of a given hangup cause */
654 const char *ast_cause2str(int cause)
655 {
656         int x;
657
658         for (x = 0; x < ARRAY_LEN(causes); x++) {
659                 if (causes[x].cause == cause)
660                         return causes[x].desc;
661         }
662
663         return "Unknown";
664 }
665
666 /*! \brief Convert a symbolic hangup cause to number */
667 int ast_str2cause(const char *name)
668 {
669         int x;
670
671         for (x = 0; x < ARRAY_LEN(causes); x++)
672                 if (!strncasecmp(causes[x].name, name, strlen(causes[x].name)))
673                         return causes[x].cause;
674
675         return -1;
676 }
677
678 static struct stasis_message *create_channel_snapshot_message(struct ast_channel *channel)
679 {
680         RAII_VAR(struct ast_channel_snapshot *, snapshot, NULL, ao2_cleanup);
681         ast_channel_lock(channel);
682         snapshot = ast_channel_snapshot_create(channel);
683         ast_channel_unlock(channel);
684         if (!snapshot) {
685                 return NULL;
686         }
687
688         return stasis_message_create(ast_channel_snapshot_type(), snapshot);
689 }
690
691 static void publish_cache_clear(struct ast_channel *chan)
692 {
693         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
694         RAII_VAR(struct stasis_message *, clear_msg, NULL, ao2_cleanup);
695
696         clear_msg = create_channel_snapshot_message(chan);
697         if (!clear_msg) {
698                 return;
699         }
700
701         message = stasis_cache_clear_create(clear_msg);
702         stasis_publish(ast_channel_topic(chan), message);
703 }
704
705 /*! \brief Gives the string form of a given channel state.
706  *
707  * \note This function is not reentrant.
708  *
709  * \param state
710  */
711 const char *ast_state2str(enum ast_channel_state state)
712 {
713         char *buf;
714
715         switch (state) {
716         case AST_STATE_DOWN:
717                 return "Down";
718         case AST_STATE_RESERVED:
719                 return "Rsrvd";
720         case AST_STATE_OFFHOOK:
721                 return "OffHook";
722         case AST_STATE_DIALING:
723                 return "Dialing";
724         case AST_STATE_RING:
725                 return "Ring";
726         case AST_STATE_RINGING:
727                 return "Ringing";
728         case AST_STATE_UP:
729                 return "Up";
730         case AST_STATE_BUSY:
731                 return "Busy";
732         case AST_STATE_DIALING_OFFHOOK:
733                 return "Dialing Offhook";
734         case AST_STATE_PRERING:
735                 return "Pre-ring";
736         case AST_STATE_MUTE:
737                 return "Mute";
738         default:
739                 if (!(buf = ast_threadstorage_get(&state2str_threadbuf, STATE2STR_BUFSIZE)))
740                         return "Unknown";
741                 snprintf(buf, STATE2STR_BUFSIZE, "Unknown (%d)", state);
742                 return buf;
743         }
744 }
745
746 /*! \brief Gives the string form of a given transfer capability */
747 char *ast_transfercapability2str(int transfercapability)
748 {
749         switch (transfercapability) {
750         case AST_TRANS_CAP_SPEECH:
751                 return "SPEECH";
752         case AST_TRANS_CAP_DIGITAL:
753                 return "DIGITAL";
754         case AST_TRANS_CAP_RESTRICTED_DIGITAL:
755                 return "RESTRICTED_DIGITAL";
756         case AST_TRANS_CAP_3_1K_AUDIO:
757                 return "3K1AUDIO";
758         case AST_TRANS_CAP_DIGITAL_W_TONES:
759                 return "DIGITAL_W_TONES";
760         case AST_TRANS_CAP_VIDEO:
761                 return "VIDEO";
762         default:
763                 return "UNKNOWN";
764         }
765 }
766
767 /*! \brief Pick the best audio codec */
768 struct ast_format *ast_best_codec(struct ast_format_cap *cap, struct ast_format *result)
769 {
770         /* This just our opinion, expressed in code.  We are asked to choose
771            the best codec to use, given no information */
772         static const enum ast_format_id prefs[] =
773         {
774                 /*! Okay, ulaw is used by all telephony equipment, so start with it */
775                 AST_FORMAT_ULAW,
776                 /*! Unless of course, you're a silly European, so then prefer ALAW */
777                 AST_FORMAT_ALAW,
778                 AST_FORMAT_G719,
779                 AST_FORMAT_SIREN14,
780                 AST_FORMAT_SIREN7,
781                 AST_FORMAT_TESTLAW,
782                 /*! G.722 is better then all below, but not as common as the above... so give ulaw and alaw priority */
783                 AST_FORMAT_G722,
784                 /*! Okay, well, signed linear is easy to translate into other stuff */
785                 AST_FORMAT_SLINEAR192,
786                 AST_FORMAT_SLINEAR96,
787                 AST_FORMAT_SLINEAR48,
788                 AST_FORMAT_SLINEAR44,
789                 AST_FORMAT_SLINEAR32,
790                 AST_FORMAT_SLINEAR24,
791                 AST_FORMAT_SLINEAR16,
792                 AST_FORMAT_SLINEAR12,
793                 AST_FORMAT_SLINEAR,
794                 /*! G.726 is standard ADPCM, in RFC3551 packing order */
795                 AST_FORMAT_G726,
796                 /*! G.726 is standard ADPCM, in AAL2 packing order */
797                 AST_FORMAT_G726_AAL2,
798                 /*! ADPCM has great sound quality and is still pretty easy to translate */
799                 AST_FORMAT_ADPCM,
800                 /*! Okay, we're down to vocoders now, so pick GSM because it's small and easier to
801                     translate and sounds pretty good */
802                 AST_FORMAT_GSM,
803                 /*! iLBC is not too bad */
804                 AST_FORMAT_ILBC,
805                 /*! Speex is free, but computationally more expensive than GSM */
806                 AST_FORMAT_SPEEX32,
807                 AST_FORMAT_SPEEX16,
808                 AST_FORMAT_SPEEX,
809                 /*! Opus */
810                 AST_FORMAT_OPUS,
811                 /*! SILK is pretty awesome. */
812                 AST_FORMAT_SILK,
813                 /*! CELT supports crazy high sample rates */
814                 AST_FORMAT_CELT,
815                 /*! Ick, LPC10 sounds terrible, but at least we have code for it, if you're tacky enough
816                     to use it */
817                 AST_FORMAT_LPC10,
818                 /*! G.729a is faster than 723 and slightly less expensive */
819                 AST_FORMAT_G729A,
820                 /*! Down to G.723.1 which is proprietary but at least designed for voice */
821                 AST_FORMAT_G723_1,
822         };
823         char buf[512];
824         int x;
825
826         /* Find the first preferred codec in the format given */
827         for (x = 0; x < ARRAY_LEN(prefs); x++) {
828                 if (ast_format_cap_best_byid(cap, prefs[x], result)) {
829                         return result;
830                 }
831         }
832
833         ast_format_clear(result);
834         ast_log(LOG_WARNING, "Don't know any of %s formats\n", ast_getformatname_multiple(buf, sizeof(buf), cap));
835
836         return NULL;
837 }
838
839 /*! \brief Channel technology used to extract a channel from a running application. The
840  * channel created with this technology will be immediately hung up - most external
841  * applications won't ever want to see this.
842  */
843 static const struct ast_channel_tech surrogate_tech = {
844         .type = "Surrogate",
845         .description = "Surrogate channel used to pull channel from an application",
846         .properties = AST_CHAN_TP_INTERNAL,
847 };
848
849 static const struct ast_channel_tech null_tech = {
850         .type = "NULL",
851         .description = "Null channel (should not see this)",
852 };
853
854 static void ast_channel_destructor(void *obj);
855 static void ast_dummy_channel_destructor(void *obj);
856
857 /*! \brief Create a new channel structure */
858 static struct ast_channel * attribute_malloc __attribute__((format(printf, 13, 0)))
859 __ast_channel_alloc_ap(int needqueue, int state, const char *cid_num, const char *cid_name,
860                        const char *acctcode, const char *exten, const char *context,
861                        const char *linkedid, enum ama_flags amaflag, const char *file, int line,
862                        const char *function, const char *name_fmt, va_list ap)
863 {
864         struct ast_channel *tmp;
865         struct varshead *headp;
866         char *tech = "", *tech2 = NULL;
867         struct ast_format_cap *nativeformats;
868         struct ast_sched_context *schedctx;
869         struct ast_timer *timer;
870         struct timeval now;
871         const struct ast_channel_tech *channel_tech;
872
873         /* If shutting down, don't allocate any new channels */
874         if (ast_shutting_down()) {
875                 ast_log(LOG_WARNING, "Channel allocation failed: Refusing due to active shutdown\n");
876                 return NULL;
877         }
878
879         if (!(tmp = ast_channel_internal_alloc(ast_channel_destructor, linkedid))) {
880                 /* Channel structure allocation failure. */
881                 return NULL;
882         }
883
884         ast_channel_stage_snapshot(tmp);
885
886         if (!(nativeformats = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_CACHE_STRINGS))) {
887                 ao2_ref(tmp, -1);
888                 /* format capabilities structure allocation failure */
889                 return NULL;
890         }
891         ast_channel_nativeformats_set(tmp, nativeformats);
892
893         /*
894          * Init file descriptors to unopened state so
895          * the destructor can know not to close them.
896          */
897         ast_channel_timingfd_set(tmp, -1);
898         ast_channel_internal_alertpipe_clear(tmp);
899         ast_channel_internal_fd_clear_all(tmp);
900
901 #ifdef HAVE_EPOLL
902         ast_channel_epfd_set(tmp, epoll_create(25));
903 #endif
904
905         if (!(schedctx = ast_sched_context_create())) {
906                 ast_log(LOG_WARNING, "Channel allocation failed: Unable to create schedule context\n");
907                 return ast_channel_unref(tmp);
908         }
909         ast_channel_sched_set(tmp, schedctx);
910
911         ast_party_dialed_init(ast_channel_dialed(tmp));
912         ast_party_caller_init(ast_channel_caller(tmp));
913         ast_party_connected_line_init(ast_channel_connected(tmp));
914         ast_party_connected_line_init(ast_channel_connected_indicated(tmp));
915         ast_party_redirecting_init(ast_channel_redirecting(tmp));
916
917         if (cid_name) {
918                 ast_channel_caller(tmp)->id.name.valid = 1;
919                 ast_channel_caller(tmp)->id.name.str = ast_strdup(cid_name);
920                 if (!ast_channel_caller(tmp)->id.name.str) {
921                         return ast_channel_unref(tmp);
922                 }
923         }
924         if (cid_num) {
925                 ast_channel_caller(tmp)->id.number.valid = 1;
926                 ast_channel_caller(tmp)->id.number.str = ast_strdup(cid_num);
927                 if (!ast_channel_caller(tmp)->id.number.str) {
928                         return ast_channel_unref(tmp);
929                 }
930         }
931
932         if ((timer = ast_timer_open())) {
933                 ast_channel_timer_set(tmp, timer);
934                 if (strcmp(ast_timer_get_name(ast_channel_timer(tmp)), "timerfd")) {
935                         needqueue = 0;
936                 }
937                 ast_channel_timingfd_set(tmp, ast_timer_fd(ast_channel_timer(tmp)));
938         }
939
940         if (needqueue && ast_channel_internal_alertpipe_init(tmp)) {
941                 return ast_channel_unref(tmp);
942         }
943
944         /* Always watch the alertpipe */
945         ast_channel_set_fd(tmp, AST_ALERT_FD, ast_channel_internal_alert_readfd(tmp));
946         /* And timing pipe */
947         ast_channel_set_fd(tmp, AST_TIMING_FD, ast_channel_timingfd(tmp));
948
949         /* Initial state */
950         ast_channel_state_set(tmp, state);
951         ast_channel_hold_state_set(tmp, AST_CONTROL_UNHOLD);
952
953         ast_channel_streamid_set(tmp, -1);
954
955         ast_channel_fin_set(tmp, global_fin);
956         ast_channel_fout_set(tmp, global_fout);
957
958         now = ast_tvnow();
959         ast_channel_creationtime_set(tmp, &now);
960
961         ast_channel_internal_setup_topics(tmp);
962
963         if (!ast_strlen_zero(name_fmt)) {
964                 char *slash, *slash2;
965                 /* Almost every channel is calling this function, and setting the name via the ast_string_field_build() call.
966                  * And they all use slightly different formats for their name string.
967                  * This means, to set the name here, we have to accept variable args, and call the string_field_build from here.
968                  * This means, that the stringfields must have a routine that takes the va_lists directly, and
969                  * uses them to build the string, instead of forming the va_lists internally from the vararg ... list.
970                  * This new function was written so this can be accomplished.
971                  */
972                 ast_channel_name_build_va(tmp, name_fmt, ap);
973                 tech = ast_strdupa(ast_channel_name(tmp));
974                 if ((slash = strchr(tech, '/'))) {
975                         if ((slash2 = strchr(slash + 1, '/'))) {
976                                 tech2 = slash + 1;
977                                 *slash2 = '\0';
978                         }
979                         *slash = '\0';
980                 }
981         } else {
982                 /*
983                  * Start the string with '-' so it becomes an empty string
984                  * in the destructor.
985                  */
986                 ast_channel_name_set(tmp, "-**Unknown**");
987         }
988
989         if (amaflag != AST_AMA_NONE) {
990                 ast_channel_amaflags_set(tmp, amaflag);
991         } else {
992                 ast_channel_amaflags_set(tmp, DEFAULT_AMA_FLAGS);
993         }
994
995         if (!ast_strlen_zero(acctcode)) {
996                 ast_channel_accountcode_set(tmp, acctcode);
997         }
998         ast_channel_language_set(tmp, ast_defaultlanguage);
999
1000         ast_channel_context_set(tmp, S_OR(context, "default"));
1001         ast_channel_exten_set(tmp, S_OR(exten, "s"));
1002         ast_channel_priority_set(tmp, 1);
1003
1004         headp = ast_channel_varshead(tmp);
1005         AST_LIST_HEAD_INIT_NOLOCK(headp);
1006
1007         ast_pbx_hangup_handler_init(tmp);
1008         AST_LIST_HEAD_INIT_NOLOCK(ast_channel_datastores(tmp));
1009         AST_LIST_HEAD_INIT_NOLOCK(ast_channel_autochans(tmp));
1010
1011         channel_tech = ast_get_channel_tech(tech);
1012         if (!channel_tech && !ast_strlen_zero(tech2)) {
1013                 channel_tech = ast_get_channel_tech(tech2);
1014         }
1015         if (channel_tech) {
1016                 ast_channel_tech_set(tmp, channel_tech);
1017         } else {
1018                 ast_channel_tech_set(tmp, &null_tech);
1019         }
1020
1021         ast_channel_internal_finalize(tmp);
1022
1023         ast_atomic_fetchadd_int(&chancount, +1);
1024
1025         /* You might scream "locking inversion" at seeing this but it is actually perfectly fine.
1026          * Since the channel was just created nothing can know about it yet or even acquire it.
1027          */
1028         ast_channel_lock(tmp);
1029
1030         ao2_link(channels, tmp);
1031
1032         /*
1033          * And now, since the channel structure is built, and has its name, let
1034          * the world know of its existance
1035          */
1036         ast_channel_stage_snapshot_done(tmp);
1037         return tmp;
1038 }
1039
1040 struct ast_channel *__ast_channel_alloc(int needqueue, int state, const char *cid_num,
1041                                         const char *cid_name, const char *acctcode,
1042                                         const char *exten, const char *context,
1043                                         const char *linkedid, enum ama_flags amaflag,
1044                                         const char *file, int line, const char *function,
1045                                         const char *name_fmt, ...)
1046 {
1047         va_list ap;
1048         struct ast_channel *result;
1049
1050         va_start(ap, name_fmt);
1051         result = __ast_channel_alloc_ap(needqueue, state, cid_num, cid_name, acctcode, exten, context,
1052                                         linkedid, amaflag, file, line, function, name_fmt, ap);
1053         va_end(ap);
1054
1055         return result;
1056 }
1057
1058 /* only do the minimum amount of work needed here to make a channel
1059  * structure that can be used to expand channel vars */
1060 #if defined(REF_DEBUG) || defined(__AST_DEBUG_MALLOC)
1061 struct ast_channel *__ast_dummy_channel_alloc(const char *file, int line, const char *function)
1062 #else
1063 struct ast_channel *ast_dummy_channel_alloc(void)
1064 #endif
1065 {
1066         struct ast_channel *tmp;
1067         struct varshead *headp;
1068
1069         if (!(tmp = ast_channel_internal_alloc(ast_dummy_channel_destructor, NULL))) {
1070                 /* Dummy channel structure allocation failure. */
1071                 return NULL;
1072         }
1073
1074         ast_pbx_hangup_handler_init(tmp);
1075         AST_LIST_HEAD_INIT_NOLOCK(ast_channel_datastores(tmp));
1076
1077         /*
1078          * Init file descriptors to unopened state just in case
1079          * autoservice is called on the channel or something tries to
1080          * read a frame from it.
1081          */
1082         ast_channel_timingfd_set(tmp, -1);
1083         ast_channel_internal_alertpipe_clear(tmp);
1084         ast_channel_internal_fd_clear_all(tmp);
1085 #ifdef HAVE_EPOLL
1086         ast_channel_epfd_set(tmp, -1);
1087 #endif
1088
1089         ast_channel_hold_state_set(tmp, AST_CONTROL_UNHOLD);
1090
1091         ast_channel_internal_setup_topics(tmp);
1092
1093         headp = ast_channel_varshead(tmp);
1094         AST_LIST_HEAD_INIT_NOLOCK(headp);
1095
1096         return tmp;
1097 }
1098
1099 static int __ast_queue_frame(struct ast_channel *chan, struct ast_frame *fin, int head, struct ast_frame *after)
1100 {
1101         struct ast_frame *f;
1102         struct ast_frame *cur;
1103         unsigned int new_frames = 0;
1104         unsigned int new_voice_frames = 0;
1105         unsigned int queued_frames = 0;
1106         unsigned int queued_voice_frames = 0;
1107         AST_LIST_HEAD_NOLOCK(,ast_frame) frames;
1108
1109         ast_channel_lock(chan);
1110
1111         /*
1112          * Check the last frame on the queue if we are queuing the new
1113          * frames after it.
1114          */
1115         cur = AST_LIST_LAST(ast_channel_readq(chan));
1116         if (cur && cur->frametype == AST_FRAME_CONTROL && !head && (!after || after == cur)) {
1117                 switch (cur->subclass.integer) {
1118                 case AST_CONTROL_END_OF_Q:
1119                         if (fin->frametype == AST_FRAME_CONTROL
1120                                 && fin->subclass.integer == AST_CONTROL_HANGUP) {
1121                                 /*
1122                                  * Destroy the end-of-Q marker frame so we can queue the hangup
1123                                  * frame in its place.
1124                                  */
1125                                 AST_LIST_REMOVE(ast_channel_readq(chan), cur, frame_list);
1126                                 ast_frfree(cur);
1127
1128                                 /*
1129                                  * This has degenerated to a normal queue append anyway.  Since
1130                                  * we just destroyed the last frame in the queue we must make
1131                                  * sure that "after" is NULL or bad things will happen.
1132                                  */
1133                                 after = NULL;
1134                                 break;
1135                         }
1136                         /* Fall through */
1137                 case AST_CONTROL_HANGUP:
1138                         /* Don't queue anything. */
1139                         ast_channel_unlock(chan);
1140                         return 0;
1141                 default:
1142                         break;
1143                 }
1144         }
1145
1146         /* Build copies of all the new frames and count them */
1147         AST_LIST_HEAD_INIT_NOLOCK(&frames);
1148         for (cur = fin; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
1149                 if (!(f = ast_frdup(cur))) {
1150                         if (AST_LIST_FIRST(&frames)) {
1151                                 ast_frfree(AST_LIST_FIRST(&frames));
1152                         }
1153                         ast_channel_unlock(chan);
1154                         return -1;
1155                 }
1156
1157                 AST_LIST_INSERT_TAIL(&frames, f, frame_list);
1158                 new_frames++;
1159                 if (f->frametype == AST_FRAME_VOICE) {
1160                         new_voice_frames++;
1161                 }
1162         }
1163
1164         /* Count how many frames exist on the queue */
1165         AST_LIST_TRAVERSE(ast_channel_readq(chan), cur, frame_list) {
1166                 queued_frames++;
1167                 if (cur->frametype == AST_FRAME_VOICE) {
1168                         queued_voice_frames++;
1169                 }
1170         }
1171
1172         if ((queued_frames + new_frames > 128 || queued_voice_frames + new_voice_frames > 96)) {
1173                 int count = 0;
1174                 ast_log(LOG_WARNING, "Exceptionally long %squeue length queuing to %s\n", queued_frames + new_frames > 128 ? "" : "voice ", ast_channel_name(chan));
1175                 AST_LIST_TRAVERSE_SAFE_BEGIN(ast_channel_readq(chan), cur, frame_list) {
1176                         /* Save the most recent frame */
1177                         if (!AST_LIST_NEXT(cur, frame_list)) {
1178                                 break;
1179                         } else if (cur->frametype == AST_FRAME_VOICE || cur->frametype == AST_FRAME_VIDEO || cur->frametype == AST_FRAME_NULL) {
1180                                 if (++count > 64) {
1181                                         break;
1182                                 }
1183                                 AST_LIST_REMOVE_CURRENT(frame_list);
1184                                 ast_frfree(cur);
1185                         }
1186                 }
1187                 AST_LIST_TRAVERSE_SAFE_END;
1188         }
1189
1190         if (after) {
1191                 AST_LIST_INSERT_LIST_AFTER(ast_channel_readq(chan), &frames, after, frame_list);
1192         } else {
1193                 if (head) {
1194                         AST_LIST_APPEND_LIST(&frames, ast_channel_readq(chan), frame_list);
1195                         AST_LIST_HEAD_INIT_NOLOCK(ast_channel_readq(chan));
1196                 }
1197                 AST_LIST_APPEND_LIST(ast_channel_readq(chan), &frames, frame_list);
1198         }
1199
1200         if (ast_channel_alert_writable(chan)) {
1201                 if (ast_channel_alert_write(chan)) {
1202                         ast_log(LOG_WARNING, "Unable to write to alert pipe on %s (qlen = %d): %s!\n",
1203                                 ast_channel_name(chan), queued_frames, strerror(errno));
1204                 }
1205         } else if (ast_channel_timingfd(chan) > -1) {
1206                 ast_timer_enable_continuous(ast_channel_timer(chan));
1207         } else if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING)) {
1208                 pthread_kill(ast_channel_blocker(chan), SIGURG);
1209         }
1210
1211         ast_channel_unlock(chan);
1212
1213         return 0;
1214 }
1215
1216 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *fin)
1217 {
1218         return __ast_queue_frame(chan, fin, 0, NULL);
1219 }
1220
1221 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *fin)
1222 {
1223         return __ast_queue_frame(chan, fin, 1, NULL);
1224 }
1225
1226 /*! \brief Queue a hangup frame for channel */
1227 int ast_queue_hangup(struct ast_channel *chan)
1228 {
1229         struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_HANGUP };
1230         int res;
1231
1232         /* Yeah, let's not change a lock-critical value without locking */
1233         ast_channel_lock(chan);
1234         ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_DEV);
1235         ast_channel_publish_blob(chan, ast_channel_hangup_request_type(), NULL);
1236
1237         res = ast_queue_frame(chan, &f);
1238         ast_channel_unlock(chan);
1239         return res;
1240 }
1241
1242 /*! \brief Queue a hangup frame for channel */
1243 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause)
1244 {
1245         RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
1246         struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_HANGUP };
1247         int res;
1248
1249         if (cause >= 0) {
1250                 f.data.uint32 = cause;
1251         }
1252
1253         /* Yeah, let's not change a lock-critical value without locking */
1254         ast_channel_lock(chan);
1255         ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_DEV);
1256         if (cause < 0) {
1257                 f.data.uint32 = ast_channel_hangupcause(chan);
1258         }
1259         blob = ast_json_pack("{s: i}",
1260                              "cause", cause);
1261         ast_channel_publish_blob(chan, ast_channel_hangup_request_type(), blob);
1262
1263         res = ast_queue_frame(chan, &f);
1264         ast_channel_unlock(chan);
1265         return res;
1266 }
1267
1268 int ast_queue_hold(struct ast_channel *chan, const char *musicclass)
1269 {
1270         RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
1271         struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_HOLD };
1272         int res;
1273
1274         ast_channel_lock(chan);
1275         if (!ast_strlen_zero(musicclass)) {
1276                 f.data.ptr = (void *) musicclass;
1277                 f.datalen = strlen(musicclass) + 1;
1278
1279                 blob = ast_json_pack("{s: s}",
1280                                      "musicclass", musicclass);
1281         }
1282
1283         ast_channel_publish_blob(chan, ast_channel_hold_type(), blob);
1284
1285         res = ast_queue_frame(chan, &f);
1286         ast_channel_unlock(chan);
1287         return res;
1288 }
1289
1290 int ast_queue_unhold(struct ast_channel *chan)
1291 {
1292         struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_UNHOLD };
1293         int res;
1294
1295         ast_channel_lock(chan);
1296         ast_channel_publish_blob(chan, ast_channel_unhold_type(), NULL);
1297
1298         res = ast_queue_frame(chan, &f);
1299         ast_channel_unlock(chan);
1300         return res;
1301 }
1302
1303 /*! \brief Queue a control frame */
1304 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control)
1305 {
1306         struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = control };
1307         return ast_queue_frame(chan, &f);
1308 }
1309
1310 /*! \brief Queue a control frame with payload */
1311 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
1312                            const void *data, size_t datalen)
1313 {
1314         struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = control, .data.ptr = (void *) data, .datalen = datalen };
1315         return ast_queue_frame(chan, &f);
1316 }
1317
1318 /*! \brief Set defer DTMF flag on channel */
1319 int ast_channel_defer_dtmf(struct ast_channel *chan)
1320 {
1321         int pre = 0;
1322
1323         if (chan) {
1324                 pre = ast_test_flag(ast_channel_flags(chan), AST_FLAG_DEFER_DTMF);
1325                 ast_set_flag(ast_channel_flags(chan), AST_FLAG_DEFER_DTMF);
1326         }
1327         return pre;
1328 }
1329
1330 /*! \brief Unset defer DTMF flag on channel */
1331 void ast_channel_undefer_dtmf(struct ast_channel *chan)
1332 {
1333         if (chan)
1334                 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_DEFER_DTMF);
1335 }
1336
1337 struct ast_channel *ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg,
1338                 void *data, int ao2_flags)
1339 {
1340         return ao2_callback_data(channels, ao2_flags, cb_fn, arg, data);
1341 }
1342
1343 static int ast_channel_by_name_cb(void *obj, void *arg, void *data, int flags)
1344 {
1345         struct ast_channel *chan = obj;
1346         const char *name = arg;
1347         size_t name_len = *(size_t *) data;
1348         int ret = CMP_MATCH;
1349
1350         if (ast_strlen_zero(name)) {
1351                 ast_log(LOG_ERROR, "BUG! Must supply a channel name or partial name to match!\n");
1352                 return CMP_STOP;
1353         }
1354
1355         ast_channel_lock(chan);
1356         if ((!name_len && strcasecmp(ast_channel_name(chan), name))
1357                 || (name_len && strncasecmp(ast_channel_name(chan), name, name_len))) {
1358                 ret = 0; /* name match failed, keep looking */
1359         }
1360         ast_channel_unlock(chan);
1361
1362         return ret;
1363 }
1364
1365 static int ast_channel_by_exten_cb(void *obj, void *arg, void *data, int flags)
1366 {
1367         struct ast_channel *chan = obj;
1368         char *context = arg;
1369         char *exten = data;
1370         int ret = CMP_MATCH;
1371
1372         if (ast_strlen_zero(exten) || ast_strlen_zero(context)) {
1373                 ast_log(LOG_ERROR, "BUG! Must have a context and extension to match!\n");
1374                 return CMP_STOP;
1375         }
1376
1377         ast_channel_lock(chan);
1378         if (strcasecmp(ast_channel_context(chan), context) && strcasecmp(ast_channel_macrocontext(chan), context)) {
1379                 ret = 0; /* Context match failed, continue */
1380         } else if (strcasecmp(ast_channel_exten(chan), exten) && strcasecmp(ast_channel_macroexten(chan), exten)) {
1381                 ret = 0; /* Extension match failed, continue */
1382         }
1383         ast_channel_unlock(chan);
1384
1385         return ret;
1386 }
1387
1388 static int ast_channel_by_uniqueid_cb(void *obj, void *arg, void *data, int flags)
1389 {
1390         struct ast_channel *chan = obj;
1391         char *uniqueid = arg;
1392         size_t id_len = *(size_t *) data;
1393         int ret = CMP_MATCH;
1394
1395         if (ast_strlen_zero(uniqueid)) {
1396                 ast_log(LOG_ERROR, "BUG! Must supply a uniqueid or partial uniqueid to match!\n");
1397                 return CMP_STOP;
1398         }
1399
1400         ast_channel_lock(chan);
1401         if ((!id_len && strcasecmp(ast_channel_uniqueid(chan), uniqueid))
1402                 || (id_len && strncasecmp(ast_channel_uniqueid(chan), uniqueid, id_len))) {
1403                 ret = 0; /* uniqueid match failed, keep looking */
1404         }
1405         ast_channel_unlock(chan);
1406
1407         return ret;
1408 }
1409
1410 struct ast_channel_iterator {
1411         /* storage for non-dynamically allocated iterator */
1412         struct ao2_iterator simple_iterator;
1413         /* pointer to the actual iterator (simple_iterator or a dynamically
1414          * allocated iterator)
1415          */
1416         struct ao2_iterator *active_iterator;
1417 };
1418
1419 struct ast_channel_iterator *ast_channel_iterator_destroy(struct ast_channel_iterator *i)
1420 {
1421         ao2_iterator_destroy(i->active_iterator);
1422         ast_free(i);
1423
1424         return NULL;
1425 }
1426
1427 struct ast_channel_iterator *ast_channel_iterator_by_exten_new(const char *exten, const char *context)
1428 {
1429         struct ast_channel_iterator *i;
1430         char *l_exten = (char *) exten;
1431         char *l_context = (char *) context;
1432
1433         if (!(i = ast_calloc(1, sizeof(*i)))) {
1434                 return NULL;
1435         }
1436
1437         i->active_iterator = (void *) ast_channel_callback(ast_channel_by_exten_cb,
1438                 l_context, l_exten, OBJ_MULTIPLE);
1439         if (!i->active_iterator) {
1440                 ast_free(i);
1441                 return NULL;
1442         }
1443
1444         return i;
1445 }
1446
1447 struct ast_channel_iterator *ast_channel_iterator_by_name_new(const char *name, size_t name_len)
1448 {
1449         struct ast_channel_iterator *i;
1450         char *l_name = (char *) name;
1451
1452         if (!(i = ast_calloc(1, sizeof(*i)))) {
1453                 return NULL;
1454         }
1455
1456         i->active_iterator = (void *) ast_channel_callback(ast_channel_by_name_cb,
1457                 l_name, &name_len,
1458                 OBJ_MULTIPLE | (name_len == 0 /* match the whole word, so optimize */ ? OBJ_KEY : 0));
1459         if (!i->active_iterator) {
1460                 ast_free(i);
1461                 return NULL;
1462         }
1463
1464         return i;
1465 }
1466
1467 struct ast_channel_iterator *ast_channel_iterator_all_new(void)
1468 {
1469         struct ast_channel_iterator *i;
1470
1471         if (!(i = ast_calloc(1, sizeof(*i)))) {
1472                 return NULL;
1473         }
1474
1475         i->simple_iterator = ao2_iterator_init(channels, 0);
1476         i->active_iterator = &i->simple_iterator;
1477
1478         return i;
1479 }
1480
1481 struct ast_channel *ast_channel_iterator_next(struct ast_channel_iterator *i)
1482 {
1483         return ao2_iterator_next(i->active_iterator);
1484 }
1485
1486 /* Legacy function, not currently used for lookups, but we need a cmp_fn */
1487 static int ast_channel_cmp_cb(void *obj, void *arg, int flags)
1488 {
1489         ast_log(LOG_ERROR, "BUG! Should never be called!\n");
1490         return CMP_STOP;
1491 }
1492
1493 struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len)
1494 {
1495         struct ast_channel *chan;
1496         char *l_name = (char *) name;
1497
1498         chan = ast_channel_callback(ast_channel_by_name_cb, l_name, &name_len,
1499                 (name_len == 0) /* optimize if it is a complete name match */ ? OBJ_KEY : 0);
1500         if (chan) {
1501                 return chan;
1502         }
1503
1504         if (ast_strlen_zero(l_name)) {
1505                 /* We didn't have a name to search for so quit. */
1506                 return NULL;
1507         }
1508
1509         /* Now try a search for uniqueid. */
1510         return ast_channel_callback(ast_channel_by_uniqueid_cb, l_name, &name_len, 0);
1511 }
1512
1513 struct ast_channel *ast_channel_get_by_name(const char *name)
1514 {
1515         return ast_channel_get_by_name_prefix(name, 0);
1516 }
1517
1518 struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context)
1519 {
1520         char *l_exten = (char *) exten;
1521         char *l_context = (char *) context;
1522
1523         return ast_channel_callback(ast_channel_by_exten_cb, l_context, l_exten, 0);
1524 }
1525
1526 int ast_is_deferrable_frame(const struct ast_frame *frame)
1527 {
1528         /* Do not add a default entry in this switch statement.  Each new
1529          * frame type should be addressed directly as to whether it should
1530          * be queued up or not.
1531          */
1532         switch (frame->frametype) {
1533         case AST_FRAME_BRIDGE_ACTION:
1534         case AST_FRAME_CONTROL:
1535         case AST_FRAME_TEXT:
1536         case AST_FRAME_IMAGE:
1537         case AST_FRAME_HTML:
1538                 return 1;
1539
1540         case AST_FRAME_DTMF_END:
1541         case AST_FRAME_DTMF_BEGIN:
1542         case AST_FRAME_VOICE:
1543         case AST_FRAME_VIDEO:
1544         case AST_FRAME_NULL:
1545         case AST_FRAME_IAX:
1546         case AST_FRAME_CNG:
1547         case AST_FRAME_MODEM:
1548                 return 0;
1549         }
1550         return 0;
1551 }
1552
1553 /*! \brief Wait, look for hangups and condition arg */
1554 int ast_safe_sleep_conditional(struct ast_channel *chan, int timeout_ms, int (*cond)(void*), void *data)
1555 {
1556         struct ast_frame *f;
1557         struct ast_silence_generator *silgen = NULL;
1558         int res = 0;
1559         struct timeval start;
1560         int ms;
1561         AST_LIST_HEAD_NOLOCK(, ast_frame) deferred_frames;
1562
1563         AST_LIST_HEAD_INIT_NOLOCK(&deferred_frames);
1564
1565         /* If no other generator is present, start silencegen while waiting */
1566         if (ast_opt_transmit_silence && !ast_channel_generatordata(chan)) {
1567                 silgen = ast_channel_start_silence_generator(chan);
1568         }
1569
1570         start = ast_tvnow();
1571         while ((ms = ast_remaining_ms(start, timeout_ms))) {
1572                 struct ast_frame *dup_f = NULL;
1573
1574                 if (cond && ((*cond)(data) == 0)) {
1575                         break;
1576                 }
1577                 ms = ast_waitfor(chan, ms);
1578                 if (ms < 0) {
1579                         res = -1;
1580                         break;
1581                 }
1582                 if (ms > 0) {
1583                         f = ast_read(chan);
1584                         if (!f) {
1585                                 res = -1;
1586                                 break;
1587                         }
1588
1589                         if (!ast_is_deferrable_frame(f)) {
1590                                 ast_frfree(f);
1591                                 continue;
1592                         }
1593
1594                         if ((dup_f = ast_frisolate(f))) {
1595                                 if (dup_f != f) {
1596                                         ast_frfree(f);
1597                                 }
1598                                 AST_LIST_INSERT_HEAD(&deferred_frames, dup_f, frame_list);
1599                         }
1600                 }
1601         }
1602
1603         /* stop silgen if present */
1604         if (silgen) {
1605                 ast_channel_stop_silence_generator(chan, silgen);
1606         }
1607
1608         /* We need to free all the deferred frames, but we only need to
1609          * queue the deferred frames if there was no error and no
1610          * hangup was received
1611          */
1612         ast_channel_lock(chan);
1613         while ((f = AST_LIST_REMOVE_HEAD(&deferred_frames, frame_list))) {
1614                 if (!res) {
1615                         ast_queue_frame_head(chan, f);
1616                 }
1617                 ast_frfree(f);
1618         }
1619         ast_channel_unlock(chan);
1620
1621         return res;
1622 }
1623
1624 /*! \brief Wait, look for hangups */
1625 int ast_safe_sleep(struct ast_channel *chan, int ms)
1626 {
1627         return ast_safe_sleep_conditional(chan, ms, NULL, NULL);
1628 }
1629
1630 struct ast_channel *ast_channel_release(struct ast_channel *chan)
1631 {
1632         /* Safe, even if already unlinked. */
1633         ao2_unlink(channels, chan);
1634         return ast_channel_unref(chan);
1635 }
1636
1637 void ast_party_name_init(struct ast_party_name *init)
1638 {
1639         init->str = NULL;
1640         init->char_set = AST_PARTY_CHAR_SET_ISO8859_1;
1641         init->presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
1642         init->valid = 0;
1643 }
1644
1645 void ast_party_name_copy(struct ast_party_name *dest, const struct ast_party_name *src)
1646 {
1647         if (dest == src) {
1648                 /* Don't copy to self */
1649                 return;
1650         }
1651
1652         ast_free(dest->str);
1653         dest->str = ast_strdup(src->str);
1654         dest->char_set = src->char_set;
1655         dest->presentation = src->presentation;
1656         dest->valid = src->valid;
1657 }
1658
1659 void ast_party_name_set_init(struct ast_party_name *init, const struct ast_party_name *guide)
1660 {
1661         init->str = NULL;
1662         init->char_set = guide->char_set;
1663         init->presentation = guide->presentation;
1664         init->valid = guide->valid;
1665 }
1666
1667 void ast_party_name_set(struct ast_party_name *dest, const struct ast_party_name *src)
1668 {
1669         if (dest == src) {
1670                 /* Don't set to self */
1671                 return;
1672         }
1673
1674         if (src->str && src->str != dest->str) {
1675                 ast_free(dest->str);
1676                 dest->str = ast_strdup(src->str);
1677         }
1678
1679         dest->char_set = src->char_set;
1680         dest->presentation = src->presentation;
1681         dest->valid = src->valid;
1682 }
1683
1684 void ast_party_name_free(struct ast_party_name *doomed)
1685 {
1686         ast_free(doomed->str);
1687         doomed->str = NULL;
1688 }
1689
1690 void ast_party_number_init(struct ast_party_number *init)
1691 {
1692         init->str = NULL;
1693         init->plan = 0;/* Unknown */
1694         init->presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
1695         init->valid = 0;
1696 }
1697
1698 void ast_party_number_copy(struct ast_party_number *dest, const struct ast_party_number *src)
1699 {
1700         if (dest == src) {
1701                 /* Don't copy to self */
1702                 return;
1703         }
1704
1705         ast_free(dest->str);
1706         dest->str = ast_strdup(src->str);
1707         dest->plan = src->plan;
1708         dest->presentation = src->presentation;
1709         dest->valid = src->valid;
1710 }
1711
1712 void ast_party_number_set_init(struct ast_party_number *init, const struct ast_party_number *guide)
1713 {
1714         init->str = NULL;
1715         init->plan = guide->plan;
1716         init->presentation = guide->presentation;
1717         init->valid = guide->valid;
1718 }
1719
1720 void ast_party_number_set(struct ast_party_number *dest, const struct ast_party_number *src)
1721 {
1722         if (dest == src) {
1723                 /* Don't set to self */
1724                 return;
1725         }
1726
1727         if (src->str && src->str != dest->str) {
1728                 ast_free(dest->str);
1729                 dest->str = ast_strdup(src->str);
1730         }
1731
1732         dest->plan = src->plan;
1733         dest->presentation = src->presentation;
1734         dest->valid = src->valid;
1735 }
1736
1737 void ast_party_number_free(struct ast_party_number *doomed)
1738 {
1739         ast_free(doomed->str);
1740         doomed->str = NULL;
1741 }
1742
1743 void ast_party_subaddress_init(struct ast_party_subaddress *init)
1744 {
1745         init->str = NULL;
1746         init->type = 0;
1747         init->odd_even_indicator = 0;
1748         init->valid = 0;
1749 }
1750
1751 void ast_party_subaddress_copy(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src)
1752 {
1753         if (dest == src) {
1754                 /* Don't copy to self */
1755                 return;
1756         }
1757
1758         ast_free(dest->str);
1759         dest->str = ast_strdup(src->str);
1760         dest->type = src->type;
1761         dest->odd_even_indicator = src->odd_even_indicator;
1762         dest->valid = src->valid;
1763 }
1764
1765 void ast_party_subaddress_set_init(struct ast_party_subaddress *init, const struct ast_party_subaddress *guide)
1766 {
1767         init->str = NULL;
1768         init->type = guide->type;
1769         init->odd_even_indicator = guide->odd_even_indicator;
1770         init->valid = guide->valid;
1771 }
1772
1773 void ast_party_subaddress_set(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src)
1774 {
1775         if (dest == src) {
1776                 /* Don't set to self */
1777                 return;
1778         }
1779
1780         if (src->str && src->str != dest->str) {
1781                 ast_free(dest->str);
1782                 dest->str = ast_strdup(src->str);
1783         }
1784
1785         dest->type = src->type;
1786         dest->odd_even_indicator = src->odd_even_indicator;
1787         dest->valid = src->valid;
1788 }
1789
1790 void ast_party_subaddress_free(struct ast_party_subaddress *doomed)
1791 {
1792         ast_free(doomed->str);
1793         doomed->str = NULL;
1794 }
1795
1796 void ast_set_party_id_all(struct ast_set_party_id *update_id)
1797 {
1798         update_id->name = 1;
1799         update_id->number = 1;
1800         update_id->subaddress = 1;
1801 }
1802
1803 void ast_party_id_init(struct ast_party_id *init)
1804 {
1805         ast_party_name_init(&init->name);
1806         ast_party_number_init(&init->number);
1807         ast_party_subaddress_init(&init->subaddress);
1808         init->tag = NULL;
1809 }
1810
1811 void ast_party_id_copy(struct ast_party_id *dest, const struct ast_party_id *src)
1812 {
1813         if (dest == src) {
1814                 /* Don't copy to self */
1815                 return;
1816         }
1817
1818         ast_party_name_copy(&dest->name, &src->name);
1819         ast_party_number_copy(&dest->number, &src->number);
1820         ast_party_subaddress_copy(&dest->subaddress, &src->subaddress);
1821
1822         ast_free(dest->tag);
1823         dest->tag = ast_strdup(src->tag);
1824 }
1825
1826 void ast_party_id_set_init(struct ast_party_id *init, const struct ast_party_id *guide)
1827 {
1828         ast_party_name_set_init(&init->name, &guide->name);
1829         ast_party_number_set_init(&init->number, &guide->number);
1830         ast_party_subaddress_set_init(&init->subaddress, &guide->subaddress);
1831         init->tag = NULL;
1832 }
1833
1834 void ast_party_id_set(struct ast_party_id *dest, const struct ast_party_id *src, const struct ast_set_party_id *update)
1835 {
1836         if (dest == src) {
1837                 /* Don't set to self */
1838                 return;
1839         }
1840
1841         if (!update || update->name) {
1842                 ast_party_name_set(&dest->name, &src->name);
1843         }
1844         if (!update || update->number) {
1845                 ast_party_number_set(&dest->number, &src->number);
1846         }
1847         if (!update || update->subaddress) {
1848                 ast_party_subaddress_set(&dest->subaddress, &src->subaddress);
1849         }
1850
1851         if (src->tag && src->tag != dest->tag) {
1852                 ast_free(dest->tag);
1853                 dest->tag = ast_strdup(src->tag);
1854         }
1855 }
1856
1857 void ast_party_id_free(struct ast_party_id *doomed)
1858 {
1859         ast_party_name_free(&doomed->name);
1860         ast_party_number_free(&doomed->number);
1861         ast_party_subaddress_free(&doomed->subaddress);
1862
1863         ast_free(doomed->tag);
1864         doomed->tag = NULL;
1865 }
1866
1867 int ast_party_id_presentation(const struct ast_party_id *id)
1868 {
1869         int number_priority;
1870         int number_value;
1871         int number_screening;
1872         int name_priority;
1873         int name_value;
1874
1875         /* Determine name presentation priority. */
1876         if (!id->name.valid) {
1877                 name_value = AST_PRES_UNAVAILABLE;
1878                 name_priority = 3;
1879         } else {
1880                 name_value = id->name.presentation & AST_PRES_RESTRICTION;
1881                 switch (name_value) {
1882                 case AST_PRES_RESTRICTED:
1883                         name_priority = 0;
1884                         break;
1885                 case AST_PRES_ALLOWED:
1886                         name_priority = 1;
1887                         break;
1888                 case AST_PRES_UNAVAILABLE:
1889                         name_priority = 2;
1890                         break;
1891                 default:
1892                         name_value = AST_PRES_UNAVAILABLE;
1893                         name_priority = 3;
1894                         break;
1895                 }
1896         }
1897
1898         /* Determine number presentation priority. */
1899         if (!id->number.valid) {
1900                 number_screening = AST_PRES_USER_NUMBER_UNSCREENED;
1901                 number_value = AST_PRES_UNAVAILABLE;
1902                 number_priority = 3;
1903         } else {
1904                 number_screening = id->number.presentation & AST_PRES_NUMBER_TYPE;
1905                 number_value = id->number.presentation & AST_PRES_RESTRICTION;
1906                 switch (number_value) {
1907                 case AST_PRES_RESTRICTED:
1908                         number_priority = 0;
1909                         break;
1910                 case AST_PRES_ALLOWED:
1911                         number_priority = 1;
1912                         break;
1913                 case AST_PRES_UNAVAILABLE:
1914                         number_priority = 2;
1915                         break;
1916                 default:
1917                         number_screening = AST_PRES_USER_NUMBER_UNSCREENED;
1918                         number_value = AST_PRES_UNAVAILABLE;
1919                         number_priority = 3;
1920                         break;
1921                 }
1922         }
1923
1924         /* Select the wining presentation value. */
1925         if (name_priority < number_priority) {
1926                 number_value = name_value;
1927         }
1928         if (number_value == AST_PRES_UNAVAILABLE) {
1929                 return AST_PRES_NUMBER_NOT_AVAILABLE;
1930         }
1931
1932         return number_value | number_screening;
1933 }
1934
1935 void ast_party_id_invalidate(struct ast_party_id *id)
1936 {
1937         id->name.valid = 0;
1938         id->number.valid = 0;
1939         id->subaddress.valid = 0;
1940 }
1941
1942 void ast_party_id_reset(struct ast_party_id *id)
1943 {
1944         ast_party_id_free(id);
1945         ast_party_id_init(id);
1946 }
1947
1948 struct ast_party_id ast_party_id_merge(struct ast_party_id *base, struct ast_party_id *overlay)
1949 {
1950         struct ast_party_id merged;
1951
1952         merged = *base;
1953         if (overlay->name.valid) {
1954                 merged.name = overlay->name;
1955         }
1956         if (overlay->number.valid) {
1957                 merged.number = overlay->number;
1958         }
1959         if (overlay->subaddress.valid) {
1960                 merged.subaddress = overlay->subaddress;
1961         }
1962         /* Note the actual structure is returned and not a pointer to it! */
1963         return merged;
1964 }
1965
1966 void ast_party_id_merge_copy(struct ast_party_id *dest, struct ast_party_id *base, struct ast_party_id *overlay)
1967 {
1968         struct ast_party_id merged;
1969
1970         merged = ast_party_id_merge(base, overlay);
1971         ast_party_id_copy(dest, &merged);
1972 }
1973
1974 void ast_party_dialed_init(struct ast_party_dialed *init)
1975 {
1976         init->number.str = NULL;
1977         init->number.plan = 0;/* Unknown */
1978         ast_party_subaddress_init(&init->subaddress);
1979         init->transit_network_select = 0;
1980 }
1981
1982 void ast_party_dialed_copy(struct ast_party_dialed *dest, const struct ast_party_dialed *src)
1983 {
1984         if (dest == src) {
1985                 /* Don't copy to self */
1986                 return;
1987         }
1988
1989         ast_free(dest->number.str);
1990         dest->number.str = ast_strdup(src->number.str);
1991         dest->number.plan = src->number.plan;
1992         ast_party_subaddress_copy(&dest->subaddress, &src->subaddress);
1993         dest->transit_network_select = src->transit_network_select;
1994 }
1995
1996 void ast_party_dialed_set_init(struct ast_party_dialed *init, const struct ast_party_dialed *guide)
1997 {
1998         init->number.str = NULL;
1999         init->number.plan = guide->number.plan;
2000         ast_party_subaddress_set_init(&init->subaddress, &guide->subaddress);
2001         init->transit_network_select = guide->transit_network_select;
2002 }
2003
2004 void ast_party_dialed_set(struct ast_party_dialed *dest, const struct ast_party_dialed *src)
2005 {
2006         if (src->number.str && src->number.str != dest->number.str) {
2007                 ast_free(dest->number.str);
2008                 dest->number.str = ast_strdup(src->number.str);
2009         }
2010         dest->number.plan = src->number.plan;
2011
2012         ast_party_subaddress_set(&dest->subaddress, &src->subaddress);
2013
2014         dest->transit_network_select = src->transit_network_select;
2015 }
2016
2017 void ast_party_dialed_free(struct ast_party_dialed *doomed)
2018 {
2019         ast_free(doomed->number.str);
2020         doomed->number.str = NULL;
2021         ast_party_subaddress_free(&doomed->subaddress);
2022 }
2023
2024 void ast_party_caller_init(struct ast_party_caller *init)
2025 {
2026         ast_party_id_init(&init->id);
2027         ast_party_id_init(&init->ani);
2028         ast_party_id_init(&init->priv);
2029         init->ani2 = 0;
2030 }
2031
2032 void ast_party_caller_copy(struct ast_party_caller *dest, const struct ast_party_caller *src)
2033 {
2034         if (dest == src) {
2035                 /* Don't copy to self */
2036                 return;
2037         }
2038
2039         ast_party_id_copy(&dest->id, &src->id);
2040         ast_party_id_copy(&dest->ani, &src->ani);
2041         ast_party_id_copy(&dest->priv, &src->priv);
2042         dest->ani2 = src->ani2;
2043 }
2044
2045 void ast_party_caller_set_init(struct ast_party_caller *init, const struct ast_party_caller *guide)
2046 {
2047         ast_party_id_set_init(&init->id, &guide->id);
2048         ast_party_id_set_init(&init->ani, &guide->ani);
2049         ast_party_id_set_init(&init->priv, &guide->priv);
2050         init->ani2 = guide->ani2;
2051 }
2052
2053 void ast_party_caller_set(struct ast_party_caller *dest, const struct ast_party_caller *src, const struct ast_set_party_caller *update)
2054 {
2055         ast_party_id_set(&dest->id, &src->id, update ? &update->id : NULL);
2056         ast_party_id_set(&dest->ani, &src->ani, update ? &update->ani : NULL);
2057         ast_party_id_set(&dest->priv, &src->priv, update ? &update->priv : NULL);
2058         dest->ani2 = src->ani2;
2059 }
2060
2061 void ast_party_caller_free(struct ast_party_caller *doomed)
2062 {
2063         ast_party_id_free(&doomed->id);
2064         ast_party_id_free(&doomed->ani);
2065         ast_party_id_free(&doomed->priv);
2066 }
2067
2068 void ast_party_connected_line_init(struct ast_party_connected_line *init)
2069 {
2070         ast_party_id_init(&init->id);
2071         ast_party_id_init(&init->ani);
2072         ast_party_id_init(&init->priv);
2073         init->ani2 = 0;
2074         init->source = AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN;
2075 }
2076
2077 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src)
2078 {
2079         if (dest == src) {
2080                 /* Don't copy to self */
2081                 return;
2082         }
2083
2084         ast_party_id_copy(&dest->id, &src->id);
2085         ast_party_id_copy(&dest->ani, &src->ani);
2086         ast_party_id_copy(&dest->priv, &src->priv);
2087         dest->ani2 = src->ani2;
2088         dest->source = src->source;
2089 }
2090
2091 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide)
2092 {
2093         ast_party_id_set_init(&init->id, &guide->id);
2094         ast_party_id_set_init(&init->ani, &guide->ani);
2095         ast_party_id_set_init(&init->priv, &guide->priv);
2096         init->ani2 = guide->ani2;
2097         init->source = guide->source;
2098 }
2099
2100 void ast_party_connected_line_set(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src, const struct ast_set_party_connected_line *update)
2101 {
2102         ast_party_id_set(&dest->id, &src->id, update ? &update->id : NULL);
2103         ast_party_id_set(&dest->ani, &src->ani, update ? &update->ani : NULL);
2104         ast_party_id_set(&dest->priv, &src->priv, update ? &update->priv : NULL);
2105         dest->ani2 = src->ani2;
2106         dest->source = src->source;
2107 }
2108
2109 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_party_caller *caller)
2110 {
2111         connected->id = caller->id;
2112         connected->ani = caller->ani;
2113         connected->priv = caller->priv;
2114         connected->ani2 = caller->ani2;
2115         connected->source = AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN;
2116 }
2117
2118 void ast_party_connected_line_free(struct ast_party_connected_line *doomed)
2119 {
2120         ast_party_id_free(&doomed->id);
2121         ast_party_id_free(&doomed->ani);
2122         ast_party_id_free(&doomed->priv);
2123 }
2124
2125 void ast_party_redirecting_reason_init(struct ast_party_redirecting_reason *init)
2126 {
2127         init->str = NULL;
2128         init->code = AST_REDIRECTING_REASON_UNKNOWN;
2129 }
2130
2131 void ast_party_redirecting_reason_copy(struct ast_party_redirecting_reason *dest, const struct ast_party_redirecting_reason *src)
2132 {
2133         if (dest == src) {
2134                 return;
2135         }
2136
2137         ast_free(dest->str);
2138         dest->str = ast_strdup(src->str);
2139         dest->code = src->code;
2140 }
2141
2142 void ast_party_redirecting_reason_set_init(struct ast_party_redirecting_reason *init, const struct ast_party_redirecting_reason *guide)
2143 {
2144         init->str = NULL;
2145         init->code = guide->code;
2146 }
2147
2148 void ast_party_redirecting_reason_set(struct ast_party_redirecting_reason *dest, const struct ast_party_redirecting_reason *src)
2149 {
2150         if (dest == src) {
2151                 return;
2152         }
2153
2154         if (src->str && src->str != dest->str) {
2155                 ast_free(dest->str);
2156                 dest->str = ast_strdup(src->str);
2157         }
2158
2159         dest->code = src->code;
2160 }
2161
2162 void ast_party_redirecting_reason_free(struct ast_party_redirecting_reason *doomed)
2163 {
2164         ast_free(doomed->str);
2165 }
2166
2167
2168 void ast_party_redirecting_init(struct ast_party_redirecting *init)
2169 {
2170         ast_party_id_init(&init->orig);
2171         ast_party_id_init(&init->from);
2172         ast_party_id_init(&init->to);
2173         ast_party_id_init(&init->priv_orig);
2174         ast_party_id_init(&init->priv_from);
2175         ast_party_id_init(&init->priv_to);
2176         ast_party_redirecting_reason_init(&init->reason);
2177         ast_party_redirecting_reason_init(&init->orig_reason);
2178         init->count = 0;
2179 }
2180
2181 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src)
2182 {
2183         if (dest == src) {
2184                 /* Don't copy to self */
2185                 return;
2186         }
2187
2188         ast_party_id_copy(&dest->orig, &src->orig);
2189         ast_party_id_copy(&dest->from, &src->from);
2190         ast_party_id_copy(&dest->to, &src->to);
2191         ast_party_id_copy(&dest->priv_orig, &src->priv_orig);
2192         ast_party_id_copy(&dest->priv_from, &src->priv_from);
2193         ast_party_id_copy(&dest->priv_to, &src->priv_to);
2194         ast_party_redirecting_reason_copy(&dest->reason, &src->reason);
2195         ast_party_redirecting_reason_copy(&dest->orig_reason, &src->orig_reason);
2196         dest->count = src->count;
2197 }
2198
2199 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide)
2200 {
2201         ast_party_id_set_init(&init->orig, &guide->orig);
2202         ast_party_id_set_init(&init->from, &guide->from);
2203         ast_party_id_set_init(&init->to, &guide->to);
2204         ast_party_id_set_init(&init->priv_orig, &guide->priv_orig);
2205         ast_party_id_set_init(&init->priv_from, &guide->priv_from);
2206         ast_party_id_set_init(&init->priv_to, &guide->priv_to);
2207         ast_party_redirecting_reason_set_init(&init->reason, &guide->reason);
2208         ast_party_redirecting_reason_set_init(&init->orig_reason, &guide->orig_reason);
2209         init->count = guide->count;
2210 }
2211
2212 void ast_party_redirecting_set(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src, const struct ast_set_party_redirecting *update)
2213 {
2214         ast_party_id_set(&dest->orig, &src->orig, update ? &update->orig : NULL);
2215         ast_party_id_set(&dest->from, &src->from, update ? &update->from : NULL);
2216         ast_party_id_set(&dest->to, &src->to, update ? &update->to : NULL);
2217         ast_party_id_set(&dest->priv_orig, &src->priv_orig, update ? &update->priv_orig : NULL);
2218         ast_party_id_set(&dest->priv_from, &src->priv_from, update ? &update->priv_from : NULL);
2219         ast_party_id_set(&dest->priv_to, &src->priv_to, update ? &update->priv_to : NULL);
2220         ast_party_redirecting_reason_set(&dest->reason, &src->reason);
2221         ast_party_redirecting_reason_set(&dest->orig_reason, &src->orig_reason);
2222         dest->count = src->count;
2223 }
2224
2225 void ast_party_redirecting_free(struct ast_party_redirecting *doomed)
2226 {
2227         ast_party_id_free(&doomed->orig);
2228         ast_party_id_free(&doomed->from);
2229         ast_party_id_free(&doomed->to);
2230         ast_party_id_free(&doomed->priv_orig);
2231         ast_party_id_free(&doomed->priv_from);
2232         ast_party_id_free(&doomed->priv_to);
2233         ast_party_redirecting_reason_free(&doomed->reason);
2234         ast_party_redirecting_reason_free(&doomed->orig_reason);
2235 }
2236
2237 /*! \brief Free a channel structure */
2238 static void ast_channel_destructor(void *obj)
2239 {
2240         struct ast_channel *chan = obj;
2241 #ifdef HAVE_EPOLL
2242         int i;
2243 #endif
2244         struct ast_var_t *vardata;
2245         struct ast_frame *f;
2246         struct varshead *headp;
2247         struct ast_datastore *datastore;
2248         char device_name[AST_CHANNEL_NAME];
2249         struct ast_callid *callid;
2250
2251         /* Stop monitoring */
2252         if (ast_channel_monitor(chan)) {
2253                 ast_channel_monitor(chan)->stop(chan, 0);
2254         }
2255
2256         /* If there is native format music-on-hold state, free it */
2257         if (ast_channel_music_state(chan)) {
2258                 ast_moh_cleanup(chan);
2259         }
2260
2261         ast_pbx_hangup_handler_destroy(chan);
2262
2263         /* Things that may possibly raise Stasis messages shouldn't occur after this point */
2264         ast_set_flag(ast_channel_flags(chan), AST_FLAG_DEAD);
2265         ast_channel_lock(chan);
2266         ast_channel_publish_snapshot(chan);
2267         ast_channel_unlock(chan);
2268         publish_cache_clear(chan);
2269
2270         ast_channel_lock(chan);
2271
2272         /* Get rid of each of the data stores on the channel */
2273         while ((datastore = AST_LIST_REMOVE_HEAD(ast_channel_datastores(chan), entry)))
2274                 /* Free the data store */
2275                 ast_datastore_free(datastore);
2276
2277         /* While the channel is locked, take the reference to its callid while we tear down the call. */
2278         callid = ast_channel_callid(chan);
2279         ast_channel_callid_cleanup(chan);
2280
2281         ast_channel_unlock(chan);
2282
2283         /* Lock and unlock the channel just to be sure nobody has it locked still
2284            due to a reference that was stored in a datastore. (i.e. app_chanspy) */
2285         ast_channel_lock(chan);
2286         ast_channel_unlock(chan);
2287
2288         if (ast_channel_tech_pvt(chan)) {
2289                 ast_log_callid(LOG_WARNING, callid, "Channel '%s' may not have been hung up properly\n", ast_channel_name(chan));
2290                 ast_free(ast_channel_tech_pvt(chan));
2291         }
2292
2293         if (ast_channel_sched(chan)) {
2294                 ast_sched_context_destroy(ast_channel_sched(chan));
2295         }
2296
2297         if (ast_channel_internal_is_finalized(chan)) {
2298                 char *dashptr;
2299
2300                 ast_copy_string(device_name, ast_channel_name(chan), sizeof(device_name));
2301                 if ((dashptr = strrchr(device_name, '-'))) {
2302                         *dashptr = '\0';
2303                 }
2304         } else {
2305                 device_name[0] = '\0';
2306         }
2307
2308         /* Free translators */
2309         if (ast_channel_readtrans(chan))
2310                 ast_translator_free_path(ast_channel_readtrans(chan));
2311         if (ast_channel_writetrans(chan))
2312                 ast_translator_free_path(ast_channel_writetrans(chan));
2313         if (ast_channel_pbx(chan))
2314                 ast_log_callid(LOG_WARNING, callid, "PBX may not have been terminated properly on '%s'\n", ast_channel_name(chan));
2315
2316         ast_party_dialed_free(ast_channel_dialed(chan));
2317         ast_party_caller_free(ast_channel_caller(chan));
2318         ast_party_connected_line_free(ast_channel_connected(chan));
2319         ast_party_connected_line_free(ast_channel_connected_indicated(chan));
2320         ast_party_redirecting_free(ast_channel_redirecting(chan));
2321
2322         /* Close pipes if appropriate */
2323         ast_channel_internal_alertpipe_close(chan);
2324         if (ast_channel_timer(chan)) {
2325                 ast_timer_close(ast_channel_timer(chan));
2326                 ast_channel_timer_set(chan, NULL);
2327         }
2328 #ifdef HAVE_EPOLL
2329         for (i = 0; i < AST_MAX_FDS; i++) {
2330                 if (ast_channel_internal_epfd_data(chan, i)) {
2331                         ast_free(ast_channel_internal_epfd_data(chan, i));
2332                 }
2333         }
2334         close(ast_channel_epfd(chan));
2335 #endif
2336         while ((f = AST_LIST_REMOVE_HEAD(ast_channel_readq(chan), frame_list)))
2337                 ast_frfree(f);
2338
2339         /* loop over the variables list, freeing all data and deleting list items */
2340         /* no need to lock the list, as the channel is already locked */
2341         headp = ast_channel_varshead(chan);
2342         while ((vardata = AST_LIST_REMOVE_HEAD(headp, entries)))
2343                 ast_var_delete(vardata);
2344
2345         ast_app_group_discard(chan);
2346
2347         /* Destroy the jitterbuffer */
2348         ast_jb_destroy(chan);
2349
2350         if (ast_channel_cdr(chan)) {
2351                 ast_cdr_free(ast_channel_cdr(chan));
2352                 ast_channel_cdr_set(chan, NULL);
2353         }
2354
2355         if (ast_channel_zone(chan)) {
2356                 ast_channel_zone_set(chan, ast_tone_zone_unref(ast_channel_zone(chan)));
2357         }
2358
2359         ast_channel_internal_cleanup(chan);
2360
2361         if (device_name[0]) {
2362                 /*
2363                  * We have a device name to notify of a new state.
2364                  *
2365                  * Queue an unknown state, because, while we know that this particular
2366                  * instance is dead, we don't know the state of all other possible
2367                  * instances.
2368                  */
2369                 ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, (ast_test_flag(ast_channel_flags(chan), AST_FLAG_DISABLE_DEVSTATE_CACHE) ? AST_DEVSTATE_NOT_CACHABLE : AST_DEVSTATE_CACHABLE), device_name);
2370         }
2371
2372         ast_channel_nativeformats_set(chan, ast_format_cap_destroy(ast_channel_nativeformats(chan)));
2373         if (callid) {
2374                 ast_callid_unref(callid);
2375         }
2376
2377         ast_channel_named_callgroups_set(chan, NULL);
2378         ast_channel_named_pickupgroups_set(chan, NULL);
2379
2380         ast_atomic_fetchadd_int(&chancount, -1);
2381 }
2382
2383 /*! \brief Free a dummy channel structure */
2384 static void ast_dummy_channel_destructor(void *obj)
2385 {
2386         struct ast_channel *chan = obj;
2387         struct ast_datastore *datastore;
2388         struct ast_var_t *vardata;
2389         struct varshead *headp;
2390
2391         ast_pbx_hangup_handler_destroy(chan);
2392
2393         /* Get rid of each of the data stores on the channel */
2394         while ((datastore = AST_LIST_REMOVE_HEAD(ast_channel_datastores(chan), entry))) {
2395                 /* Free the data store */
2396                 ast_datastore_free(datastore);
2397         }
2398
2399         ast_party_dialed_free(ast_channel_dialed(chan));
2400         ast_party_caller_free(ast_channel_caller(chan));
2401         ast_party_connected_line_free(ast_channel_connected(chan));
2402         ast_party_connected_line_free(ast_channel_connected_indicated(chan));
2403         ast_party_redirecting_free(ast_channel_redirecting(chan));
2404
2405         /* loop over the variables list, freeing all data and deleting list items */
2406         /* no need to lock the list, as the channel is already locked */
2407         headp = ast_channel_varshead(chan);
2408         while ((vardata = AST_LIST_REMOVE_HEAD(headp, entries)))
2409                 ast_var_delete(vardata);
2410
2411         if (ast_channel_cdr(chan)) {
2412                 ast_cdr_free(ast_channel_cdr(chan));
2413                 ast_channel_cdr_set(chan, NULL);
2414         }
2415
2416         ast_channel_internal_cleanup(chan);
2417 }
2418
2419 struct ast_datastore *ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
2420 {
2421         return ast_datastore_alloc(info, uid);
2422 }
2423
2424 int ast_channel_datastore_free(struct ast_datastore *datastore)
2425 {
2426         return ast_datastore_free(datastore);
2427 }
2428
2429 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to)
2430 {
2431         struct ast_datastore *datastore = NULL, *datastore2;
2432
2433         AST_LIST_TRAVERSE(ast_channel_datastores(from), datastore, entry) {
2434                 if (datastore->inheritance > 0) {
2435                         datastore2 = ast_datastore_alloc(datastore->info, datastore->uid);
2436                         if (datastore2) {
2437                                 datastore2->data = datastore->info->duplicate ? datastore->info->duplicate(datastore->data) : NULL;
2438                                 datastore2->inheritance = datastore->inheritance == DATASTORE_INHERIT_FOREVER ? DATASTORE_INHERIT_FOREVER : datastore->inheritance - 1;
2439                                 AST_LIST_INSERT_TAIL(ast_channel_datastores(to), datastore2, entry);
2440                         }
2441                 }
2442         }
2443         return 0;
2444 }
2445
2446 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore)
2447 {
2448         int res = 0;
2449
2450         AST_LIST_INSERT_HEAD(ast_channel_datastores(chan), datastore, entry);
2451
2452         return res;
2453 }
2454
2455 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore)
2456 {
2457         return AST_LIST_REMOVE(ast_channel_datastores(chan), datastore, entry) ? 0 : -1;
2458 }
2459
2460 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid)
2461 {
2462         struct ast_datastore *datastore = NULL;
2463
2464         if (info == NULL)
2465                 return NULL;
2466
2467         AST_LIST_TRAVERSE(ast_channel_datastores(chan), datastore, entry) {
2468                 if (datastore->info != info) {
2469                         continue;
2470                 }
2471
2472                 if (uid == NULL) {
2473                         /* matched by type only */
2474                         break;
2475                 }
2476
2477                 if ((datastore->uid != NULL) && !strcasecmp(uid, datastore->uid)) {
2478                         /* Matched by type AND uid */
2479                         break;
2480                 }
2481         }
2482
2483         return datastore;
2484 }
2485
2486 /*! Set the file descriptor on the channel */
2487 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd)
2488 {
2489 #ifdef HAVE_EPOLL
2490         struct epoll_event ev;
2491         struct ast_epoll_data *aed = NULL;
2492
2493         if (ast_channel_fd_isset(chan, which)) {
2494                 epoll_ctl(ast_channel_epfd(chan), EPOLL_CTL_DEL, ast_channel_fd(chan, which), &ev);
2495                 aed = ast_channel_internal_epfd_data(chan, which);
2496         }
2497
2498         /* If this new fd is valid, add it to the epoll */
2499         if (fd > -1) {
2500                 if (!aed && (!(aed = ast_calloc(1, sizeof(*aed)))))
2501                         return;
2502
2503                 ast_channel_internal_epfd_data_set(chan, which, aed);
2504                 aed->chan = chan;
2505                 aed->which = which;
2506
2507                 ev.events = EPOLLIN | EPOLLPRI | EPOLLERR | EPOLLHUP;
2508                 ev.data.ptr = aed;
2509                 epoll_ctl(ast_channel_epfd(chan), EPOLL_CTL_ADD, fd, &ev);
2510         } else if (aed) {
2511                 /* We don't have to keep around this epoll data structure now */
2512                 ast_free(aed);
2513                 ast_channel_epfd_data_set(chan, which, NULL);
2514         }
2515 #endif
2516         ast_channel_internal_fd_set(chan, which, fd);
2517         return;
2518 }
2519
2520 /*! Add a channel to an optimized waitfor */
2521 void ast_poll_channel_add(struct ast_channel *chan0, struct ast_channel *chan1)
2522 {
2523 #ifdef HAVE_EPOLL
2524         struct epoll_event ev;
2525         int i = 0;
2526
2527         if (ast_channel_epfd(chan0) == -1)
2528                 return;
2529
2530         /* Iterate through the file descriptors on chan1, adding them to chan0 */
2531         for (i = 0; i < AST_MAX_FDS; i++) {
2532                 if (!ast_channel_fd_isset(chan1, i)) {
2533                         continue;
2534                 }
2535                 ev.events = EPOLLIN | EPOLLPRI | EPOLLERR | EPOLLHUP;
2536                 ev.data.ptr = ast_channel_internal_epfd_data(chan1, i);
2537                 epoll_ctl(ast_channel_epfd(chan0), EPOLL_CTL_ADD, ast_channel_fd(chan1, i), &ev);
2538         }
2539
2540 #endif
2541         return;
2542 }
2543
2544 /*! Delete a channel from an optimized waitfor */
2545 void ast_poll_channel_del(struct ast_channel *chan0, struct ast_channel *chan1)
2546 {
2547 #ifdef HAVE_EPOLL
2548         struct epoll_event ev;
2549         int i = 0;
2550
2551         if (ast_channel_epfd(chan0) == -1)
2552                 return;
2553
2554         for (i = 0; i < AST_MAX_FDS; i++) {
2555                 if (!ast_channel_fd_isset(chan1, i)) {
2556                         continue;
2557                 }
2558                 epoll_ctl(ast_channel_epfd(chan0), EPOLL_CTL_DEL, ast_channel_fd(chan1, i), &ev);
2559         }
2560
2561 #endif
2562         return;
2563 }
2564
2565 void ast_channel_clear_softhangup(struct ast_channel *chan, int flag)
2566 {
2567         ast_channel_lock(chan);
2568
2569         ast_channel_softhangup_internal_flag_clear(chan, flag);
2570
2571         if (!ast_channel_softhangup_internal_flag(chan)) {
2572                 struct ast_frame *fr;
2573
2574                 /* If we have completely cleared the softhangup flag,
2575                  * then we need to fully abort the hangup process.  This requires
2576                  * pulling the END_OF_Q frame out of the channel frame queue if it
2577                  * still happens to be there. */
2578
2579                 fr = AST_LIST_LAST(ast_channel_readq(chan));
2580                 if (fr && fr->frametype == AST_FRAME_CONTROL &&
2581                                 fr->subclass.integer == AST_CONTROL_END_OF_Q) {
2582                         AST_LIST_REMOVE(ast_channel_readq(chan), fr, frame_list);
2583                         ast_frfree(fr);
2584                 }
2585         }
2586
2587         ast_channel_unlock(chan);
2588 }
2589
2590 /*! \brief Softly hangup a channel, don't lock */
2591 int ast_softhangup_nolock(struct ast_channel *chan, int cause)
2592 {
2593         ast_debug(1, "Soft-Hanging up channel '%s'\n", ast_channel_name(chan));
2594         /* Inform channel driver that we need to be hung up, if it cares */
2595         ast_channel_softhangup_internal_flag_add(chan, cause);
2596         ast_queue_frame(chan, &ast_null_frame);
2597         /* Interrupt any poll call or such */
2598         if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING))
2599                 pthread_kill(ast_channel_blocker(chan), SIGURG);
2600         return 0;
2601 }
2602
2603 /*! \brief Softly hangup a channel, lock */
2604 int ast_softhangup(struct ast_channel *chan, int cause)
2605 {
2606         RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
2607         int res;
2608
2609         ast_channel_lock(chan);
2610         res = ast_softhangup_nolock(chan, cause);
2611         blob = ast_json_pack("{s: i, s: b}",
2612                              "cause", cause,
2613                              "soft", 1);
2614         ast_channel_publish_blob(chan, ast_channel_hangup_request_type(), blob);
2615         ast_channel_unlock(chan);
2616
2617         return res;
2618 }
2619
2620 static void free_translation(struct ast_channel *clonechan)
2621 {
2622         if (ast_channel_writetrans(clonechan))
2623                 ast_translator_free_path(ast_channel_writetrans(clonechan));
2624         if (ast_channel_readtrans(clonechan))
2625                 ast_translator_free_path(ast_channel_readtrans(clonechan));
2626         ast_channel_writetrans_set(clonechan, NULL);
2627         ast_channel_readtrans_set(clonechan, NULL);
2628         if (ast_format_cap_is_empty(ast_channel_nativeformats(clonechan))) {
2629                 ast_format_clear(ast_channel_rawwriteformat(clonechan));
2630                 ast_format_clear(ast_channel_rawreadformat(clonechan));
2631         } else {
2632                 struct ast_format tmpfmt;
2633                 ast_best_codec(ast_channel_nativeformats(clonechan), &tmpfmt);
2634                 ast_format_copy(ast_channel_rawwriteformat(clonechan), &tmpfmt);
2635                 ast_format_copy(ast_channel_rawreadformat(clonechan), &tmpfmt);
2636         }
2637 }
2638
2639 void ast_set_hangupsource(struct ast_channel *chan, const char *source, int force)
2640 {
2641         RAII_VAR(struct ast_channel *, bridge, ast_channel_bridge_peer(chan), ast_channel_cleanup);
2642
2643         ast_channel_lock(chan);
2644         if (force || ast_strlen_zero(ast_channel_hangupsource(chan))) {
2645                 ast_channel_hangupsource_set(chan, source);
2646         }
2647         ast_channel_unlock(chan);
2648
2649         if (bridge) {
2650                 ast_channel_lock(bridge);
2651                 if (force || ast_strlen_zero(ast_channel_hangupsource(bridge))) {
2652                         ast_channel_hangupsource_set(bridge, source);
2653                 }
2654                 ast_channel_unlock(bridge);
2655         }
2656 }
2657
2658 int ast_channel_has_audio_frame_or_monitor(struct ast_channel *chan)
2659 {
2660         return ast_channel_monitor(chan)
2661                 || !ast_audiohook_write_list_empty(ast_channel_audiohooks(chan))
2662                 || !ast_framehook_list_contains_no_active(ast_channel_framehooks(chan));
2663 }
2664
2665 static void destroy_hooks(struct ast_channel *chan)
2666 {
2667         if (ast_channel_audiohooks(chan)) {
2668                 ast_audiohook_detach_list(ast_channel_audiohooks(chan));
2669                 ast_channel_audiohooks_set(chan, NULL);
2670         }
2671
2672         ast_framehook_list_destroy(chan);
2673 }
2674
2675 /*! \brief Hangup a channel */
2676 void ast_hangup(struct ast_channel *chan)
2677 {
2678         /* Be NULL safe for RAII_VAR() usage. */
2679         if (!chan) {
2680                 return;
2681         }
2682
2683         ast_autoservice_stop(chan);
2684
2685         ast_channel_lock(chan);
2686
2687         while (ast_channel_masq(chan) || ast_channel_masqr(chan))  {
2688                 CHANNEL_DEADLOCK_AVOIDANCE(chan);
2689         }
2690
2691         /* Mark as a zombie so a masquerade cannot be setup on this channel. */
2692         ast_set_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE);
2693
2694         ast_channel_unlock(chan);
2695
2696         /*
2697          * XXX if running the hangup handlers here causes problems
2698          * because the handlers take too long to execute, we could move
2699          * the meat of this function into another thread.  A thread
2700          * where channels go to die.
2701          *
2702          * If this is done, ast_autoservice_chan_hangup_peer() will no
2703          * longer be needed.
2704          */
2705         ast_pbx_hangup_handler_run(chan);
2706         ao2_unlink(channels, chan);
2707         ast_channel_lock(chan);
2708
2709         destroy_hooks(chan);
2710
2711         free_translation(chan);
2712         /* Close audio stream */
2713         if (ast_channel_stream(chan)) {
2714                 ast_closestream(ast_channel_stream(chan));
2715                 ast_channel_stream_set(chan, NULL);
2716         }
2717         /* Close video stream */
2718         if (ast_channel_vstream(chan)) {
2719                 ast_closestream(ast_channel_vstream(chan));
2720                 ast_channel_vstream_set(chan, NULL);
2721         }
2722         if (ast_channel_sched(chan)) {
2723                 ast_sched_context_destroy(ast_channel_sched(chan));
2724                 ast_channel_sched_set(chan, NULL);
2725         }
2726
2727         if (ast_channel_generatordata(chan)) {  /* Clear any tone stuff remaining */
2728                 if (ast_channel_generator(chan) && ast_channel_generator(chan)->release) {
2729                         ast_channel_generator(chan)->release(chan, ast_channel_generatordata(chan));
2730                 }
2731         }
2732         ast_channel_generatordata_set(chan, NULL);
2733         ast_channel_generator_set(chan, NULL);
2734
2735         if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING)) {
2736                 ast_log(LOG_WARNING, "Hard hangup called by thread %ld on %s, while fd "
2737                         "is blocked by thread %ld in procedure %s!  Expect a failure\n",
2738                         (long) pthread_self(), ast_channel_name(chan), (long)ast_channel_blocker(chan), ast_channel_blockproc(chan));
2739                 ast_assert(ast_test_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING) == 0);
2740         }
2741
2742         ast_debug(1, "Hanging up channel '%s'\n", ast_channel_name(chan));
2743         if (ast_channel_tech(chan)->hangup) {
2744                 ast_channel_tech(chan)->hangup(chan);
2745         }
2746
2747         ast_channel_unlock(chan);
2748
2749         ast_cc_offer(chan);
2750
2751         ast_channel_unref(chan);
2752 }
2753
2754 int ast_raw_answer(struct ast_channel *chan)
2755 {
2756         int res = 0;
2757         struct timeval answertime;
2758
2759         ast_channel_lock(chan);
2760
2761         /* You can't answer an outbound call */
2762         if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_OUTGOING)) {
2763                 ast_channel_unlock(chan);
2764                 return 0;
2765         }
2766
2767         /* Stop if we're a zombie or need a soft hangup */
2768         if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
2769                 ast_channel_unlock(chan);
2770                 return -1;
2771         }
2772
2773         answertime = ast_tvnow();
2774         ast_channel_answertime_set(chan, &answertime);
2775
2776         ast_channel_unlock(chan);
2777
2778         switch (ast_channel_state(chan)) {
2779         case AST_STATE_RINGING:
2780         case AST_STATE_RING:
2781                 ast_channel_lock(chan);
2782                 if (ast_channel_tech(chan)->answer) {
2783                         res = ast_channel_tech(chan)->answer(chan);
2784                 }
2785                 ast_setstate(chan, AST_STATE_UP);
2786                 ast_channel_unlock(chan);
2787                 break;
2788         case AST_STATE_UP:
2789                 break;
2790         default:
2791                 break;
2792         }
2793
2794         ast_indicate(chan, -1);
2795
2796         return res;
2797 }
2798
2799 int __ast_answer(struct ast_channel *chan, unsigned int delay)
2800 {
2801         int res = 0;
2802         enum ast_channel_state old_state;
2803
2804         old_state = ast_channel_state(chan);
2805         if ((res = ast_raw_answer(chan))) {
2806                 return res;
2807         }
2808
2809         switch (old_state) {
2810         case AST_STATE_RINGING:
2811         case AST_STATE_RING:
2812                 /* wait for media to start flowing, but don't wait any longer
2813                  * than 'delay' or 500 milliseconds, whichever is longer
2814                  */
2815                 do {
2816                         AST_LIST_HEAD_NOLOCK(, ast_frame) frames;
2817                         struct ast_frame *cur;
2818                         struct ast_frame *new_frame;
2819                         int timeout_ms = MAX(delay, 500);
2820                         unsigned int done = 0;
2821                         struct timeval start;
2822
2823                         AST_LIST_HEAD_INIT_NOLOCK(&frames);
2824
2825                         start = ast_tvnow();
2826                         for (;;) {
2827                                 int ms = ast_remaining_ms(start, timeout_ms);
2828                                 ms = ast_waitfor(chan, ms);
2829                                 if (ms < 0) {
2830                                         ast_log(LOG_WARNING, "Error condition occurred when polling channel %s for a voice frame: %s\n", ast_channel_name(chan), strerror(errno));
2831                                         res = -1;
2832                                         break;
2833                                 }
2834                                 if (ms == 0) {
2835                                         ast_debug(2, "Didn't receive a media frame from %s within %d ms of answering. Continuing anyway\n", ast_channel_name(chan), MAX(delay, 500));
2836                                         break;
2837                                 }
2838                                 cur = ast_read(chan);
2839                                 if (!cur || ((cur->frametype == AST_FRAME_CONTROL) &&
2840                                              (cur->subclass.integer == AST_CONTROL_HANGUP))) {
2841                                         if (cur) {
2842                                                 ast_frfree(cur);
2843                                         }
2844                                         res = -1;
2845                                         ast_debug(2, "Hangup of channel %s detected in answer routine\n", ast_channel_name(chan));
2846                                         break;
2847                                 }
2848
2849                                 if ((new_frame = ast_frisolate(cur)) != cur) {
2850                                         ast_frfree(cur);
2851                                 }
2852
2853                                 AST_LIST_INSERT_HEAD(&frames, new_frame, frame_list);
2854
2855                                 /* if a specific delay period was requested, continue
2856                                  * until that delay has passed. don't stop just because
2857                                  * incoming media has arrived.
2858                                  */
2859                                 if (delay) {
2860                                         continue;
2861                                 }
2862
2863                                 switch (new_frame->frametype) {
2864                                         /* all of these frametypes qualify as 'media' */
2865                                 case AST_FRAME_VOICE:
2866                                 case AST_FRAME_VIDEO:
2867                                 case AST_FRAME_TEXT:
2868                                 case AST_FRAME_DTMF_BEGIN:
2869                                 case AST_FRAME_DTMF_END:
2870                                 case AST_FRAME_IMAGE:
2871                                 case AST_FRAME_HTML:
2872                                 case AST_FRAME_MODEM:
2873                                         done = 1;
2874                                         break;
2875                                 case AST_FRAME_CONTROL:
2876                                 case AST_FRAME_IAX:
2877                                 case AST_FRAME_BRIDGE_ACTION:
2878                                 case AST_FRAME_NULL:
2879                                 case AST_FRAME_CNG:
2880                                         break;
2881                                 }
2882
2883                                 if (done) {
2884                                         break;
2885                                 }
2886                         }
2887
2888                         if (res == 0) {
2889                                 ast_channel_lock(chan);
2890                                 while ((cur = AST_LIST_REMOVE_HEAD(&frames, frame_list))) {
2891                                         ast_queue_frame_head(chan, cur);
2892                                         ast_frfree(cur);
2893                                 }
2894                                 ast_channel_unlock(chan);
2895                         }
2896                 } while (0);
2897                 break;
2898         default:
2899                 break;
2900         }
2901
2902         return res;
2903 }
2904
2905 int ast_answer(struct ast_channel *chan)
2906 {
2907         return __ast_answer(chan, 0);
2908 }
2909
2910 inline int ast_auto_answer(struct ast_channel *chan)
2911 {
2912         if (ast_channel_state(chan) == AST_STATE_UP) {
2913                 /* Already answered */
2914                 return 0;
2915         }
2916         return ast_answer(chan);
2917 }
2918
2919 int ast_channel_get_duration(struct ast_channel *chan)
2920 {
2921         ast_assert(NULL != chan);
2922
2923         if (ast_tvzero(ast_channel_creationtime(chan))) {
2924                 return 0;
2925         }
2926         return (ast_tvdiff_ms(ast_tvnow(), ast_channel_creationtime(chan)) / 1000);
2927 }
2928
2929 int ast_channel_get_up_time(struct ast_channel *chan)
2930 {
2931         ast_assert(NULL != chan);
2932
2933         if (ast_tvzero(ast_channel_answertime(chan))) {
2934                 return 0;
2935         }
2936         return (ast_tvdiff_ms(ast_tvnow(), ast_channel_answertime(chan)) / 1000);
2937 }
2938
2939 void ast_deactivate_generator(struct ast_channel *chan)
2940 {
2941         ast_channel_lock(chan);
2942         if (ast_channel_generatordata(chan)) {
2943                 if (ast_channel_generator(chan) && ast_channel_generator(chan)->release) {
2944                         ast_channel_generator(chan)->release(chan, ast_channel_generatordata(chan));
2945                 }
2946                 ast_channel_generatordata_set(chan, NULL);
2947                 ast_channel_generator_set(chan, NULL);
2948                 ast_channel_set_fd(chan, AST_GENERATOR_FD, -1);
2949                 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_WRITE_INT);
2950                 ast_settimeout(chan, 0, NULL, NULL);
2951         }
2952         ast_channel_unlock(chan);
2953 }
2954
2955 static void generator_write_format_change(struct ast_channel *chan)
2956 {
2957         ast_channel_lock(chan);
2958         if (ast_channel_generator(chan) && ast_channel_generator(chan)->write_format_change) {
2959                 ast_channel_generator(chan)->write_format_change(chan, ast_channel_generatordata(chan));
2960         }
2961         ast_channel_unlock(chan);
2962 }
2963
2964 static int generator_force(const void *data)
2965 {
2966         /* Called if generator doesn't have data */
2967         void *tmp;
2968         int res;
2969         int (*generate)(struct ast_channel *chan, void *tmp, int datalen, int samples) = NULL;
2970         struct ast_channel *chan = (struct ast_channel *)data;
2971
2972         ast_channel_lock(chan);
2973         tmp = ast_channel_generatordata(chan);
2974         ast_channel_generatordata_set(chan, NULL);
2975         if (ast_channel_generator(chan))
2976                 generate = ast_channel_generator(chan)->generate;
2977         ast_channel_unlock(chan);
2978
2979         if (!tmp || !generate)
2980                 return 0;
2981
2982         res = generate(chan, tmp, 0, ast_format_rate(ast_channel_writeformat(chan)) / 50);
2983
2984         ast_channel_lock(chan);
2985         if (ast_channel_generator(chan) && generate == ast_channel_generator(chan)->generate) {
2986                 ast_channel_generatordata_set(chan, tmp);
2987         }
2988         ast_channel_unlock(chan);
2989
2990         if (res) {
2991                 ast_debug(1, "Auto-deactivating generator\n");
2992                 ast_deactivate_generator(chan);
2993         }
2994
2995         return 0;
2996 }
2997
2998 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params)
2999 {
3000         int res = 0;
3001         void *generatordata = NULL;
3002
3003         ast_channel_lock(chan);
3004         if (ast_channel_generatordata(chan)) {
3005                 if (ast_channel_generator(chan) && ast_channel_generator(chan)->release) {
3006                         ast_channel_generator(chan)->release(chan, ast_channel_generatordata(chan));
3007                 }
3008         }
3009         if (gen->alloc && !(generatordata = gen->alloc(chan, params))) {
3010                 res = -1;
3011         }
3012         ast_channel_generatordata_set(chan, generatordata);
3013         if (!res) {
3014                 ast_settimeout(chan, 50, generator_force, chan);
3015                 ast_channel_generator_set(chan, gen);
3016         }
3017         ast_channel_unlock(chan);
3018
3019         ast_prod(chan);
3020
3021         return res;
3022 }
3023
3024 /*! \brief Wait for x amount of time on a file descriptor to have input.  */
3025 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception)
3026 {
3027         int winner = -1;
3028         ast_waitfor_nandfds(NULL, 0, fds, n, exception, &winner, ms);
3029         return winner;
3030 }
3031
3032 /*! \brief Wait for x amount of time on a file descriptor to have input.  */
3033 #ifdef HAVE_EPOLL
3034 static struct ast_channel *ast_waitfor_nandfds_classic(struct ast_channel **c, int n, int *fds, int nfds,
3035                                         int *exception, int *outfd, int *ms)
3036 #else
3037 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **c, int n, int *fds, int nfds,
3038                                         int *exception, int *outfd, int *ms)
3039 #endif
3040 {
3041         struct timeval start = { 0 , 0 };
3042         struct pollfd *pfds = NULL;
3043         int res;
3044         long rms;
3045         int x, y, max;
3046         int sz;
3047         struct timeval now = { 0, 0 };
3048         struct timeval whentohangup = { 0, 0 }, diff;
3049         struct ast_channel *winner = NULL;
3050         struct fdmap {
3051                 int chan;
3052                 int fdno;
3053         } *fdmap = NULL;
3054
3055         if (outfd) {
3056                 *outfd = -99999;
3057         }
3058         if (exception) {
3059                 *exception = 0;
3060         }
3061
3062         if ((sz = n * AST_MAX_FDS + nfds)) {
3063                 pfds = ast_alloca(sizeof(*pfds) * sz);
3064                 fdmap = ast_alloca(sizeof(*fdmap) * sz);
3065         } else {
3066                 /* nothing to allocate and no FDs to check */
3067                 return NULL;
3068         }
3069
3070         for (x = 0; x < n; x++) {
3071                 ast_channel_lock(c[x]);
3072                 if (!ast_tvzero(*ast_channel_whentohangup(c[x]))) {
3073                         if (ast_tvzero(whentohangup))
3074                                 now = ast_tvnow();
3075                         diff = ast_tvsub(*ast_channel_whentohangup(c[x]), now);
3076                         if (diff.tv_sec < 0 || ast_tvzero(diff)) {
3077                                 ast_test_suite_event_notify("HANGUP_TIME", "Channel: %s", ast_channel_name(c[x]));
3078                                 /* Should already be hungup */
3079                                 ast_channel_softhangup_internal_flag_add(c[x], AST_SOFTHANGUP_TIMEOUT);
3080                                 ast_channel_unlock(c[x]);
3081                                 return c[x];
3082                         }
3083                         if (ast_tvzero(whentohangup) || ast_tvcmp(diff, whentohangup) < 0)
3084                                 whentohangup = diff;
3085                 }
3086                 ast_channel_unlock(c[x]);
3087         }
3088         /* Wait full interval */
3089         rms = *ms;
3090         /* INT_MAX, not LONG_MAX, because it matters on 64-bit */
3091         if (!ast_tvzero(whentohangup) && whentohangup.tv_sec < INT_MAX / 1000) {
3092                 rms = whentohangup.tv_sec * 1000 + whentohangup.tv_usec / 1000;              /* timeout in milliseconds */
3093                 if (*ms >= 0 && *ms < rms) {                                                 /* original *ms still smaller */
3094                         rms =  *ms;
3095                 }
3096         } else if (!ast_tvzero(whentohangup) && rms < 0) {
3097                 /* Tiny corner case... call would need to last >24 days */
3098                 rms = INT_MAX;
3099         }
3100         /*
3101          * Build the pollfd array, putting the channels' fds first,
3102          * followed by individual fds. Order is important because
3103          * individual fd's must have priority over channel fds.
3104          */
3105         max = 0;
3106         for (x = 0; x < n; x++) {
3107                 for (y = 0; y < AST_MAX_FDS; y++) {
3108                         fdmap[max].fdno = y;  /* fd y is linked to this pfds */
3109                         fdmap[max].chan = x;  /* channel x is linked to this pfds */
3110                         max += ast_add_fd(&pfds[max], ast_channel_fd(c[x], y));
3111                 }
3112                 CHECK_BLOCKING(c[x]);
3113         }
3114         /* Add the individual fds */
3115         for (x = 0; x < nfds; x++) {
3116                 fdmap[max].chan = -1;
3117                 max += ast_add_fd(&pfds[max], fds[x]);
3118         }
3119
3120         if (*ms > 0) {
3121                 start = ast_tvnow();
3122         }
3123
3124         if (sizeof(int) == 4) { /* XXX fix timeout > 600000 on linux x86-32 */
3125                 do {
3126                         int kbrms = rms;
3127                         if (kbrms > 600000) {
3128                                 kbrms = 600000;
3129                         }
3130                         res = ast_poll(pfds, max, kbrms);
3131                         if (!res) {
3132                                 rms -= kbrms;
3133                         }
3134                 } while (!res && (rms > 0));
3135         } else {
3136                 res = ast_poll(pfds, max, rms);
3137         }
3138         for (x = 0; x < n; x++) {
3139                 ast_clear_flag(ast_channel_flags(c[x]), AST_FLAG_BLOCKING);
3140         }
3141         if (res < 0) { /* Simulate a timeout if we were interrupted */
3142                 if (errno != EINTR) {
3143                         *ms = -1;
3144                 }
3145                 return NULL;
3146         }
3147         if (!ast_tvzero(whentohangup)) {   /* if we have a timeout, check who expired */
3148                 now = ast_tvnow();
3149                 for (x = 0; x < n; x++) {
3150                         if (!ast_tvzero(*ast_channel_whentohangup(c[x])) && ast_tvcmp(*ast_channel_whentohangup(c[x]), now) <= 0) {
3151                                 ast_test_suite_event_notify("HANGUP_TIME", "Channel: %s", ast_channel_name(c[x]));
3152                                 ast_channel_softhangup_internal_flag_add(c[x], AST_SOFTHANGUP_TIMEOUT);
3153                                 if (winner == NULL) {
3154                                         winner = c[x];
3155                                 }
3156                         }
3157                 }
3158         }
3159         if (res == 0) { /* no fd ready, reset timeout and done */
3160                 *ms = 0;        /* XXX use 0 since we may not have an exact timeout. */
3161                 return winner;
3162         }
3163         /*
3164          * Then check if any channel or fd has a pending event.
3165          * Remember to check channels first and fds last, as they
3166          * must have priority on setting 'winner'
3167          */
3168         for (x = 0; x < max; x++) {
3169                 res = pfds[x].revents;
3170                 if (res == 0) {
3171                         continue;
3172                 }
3173                 if (fdmap[x].chan >= 0) {       /* this is a channel */
3174                         winner = c[fdmap[x].chan];      /* override previous winners */
3175                         if (res & POLLPRI) {
3176                                 ast_set_flag(ast_channel_flags(winner), AST_FLAG_EXCEPTION);
3177                         } else {
3178                                 ast_clear_flag(ast_channel_flags(winner), AST_FLAG_EXCEPTION);
3179                         }
3180                         ast_channel_fdno_set(winner, fdmap[x].fdno);
3181                 } else {                        /* this is an fd */
3182                         if (outfd) {
3183                                 *outfd = pfds[x].fd;
3184                         }
3185                         if (exception) {
3186                                 *exception = (res & POLLPRI) ? -1 : 0;
3187                         }
3188                         winner = NULL;
3189                 }
3190         }
3191         if (*ms > 0) {
3192                 *ms -= ast_tvdiff_ms(ast_tvnow(), start);
3193                 if (*ms < 0) {
3194                         *ms = 0;
3195                 }
3196         }
3197         return winner;
3198 }
3199
3200 #ifdef HAVE_EPOLL
3201 static struct ast_channel *ast_waitfor_nandfds_simple(struct ast_channel *chan, int *ms)
3202 {
3203         struct timeval start = { 0 , 0 };
3204         int res = 0;
3205         struct epoll_event ev[1];
3206         long diff, rms = *ms;
3207         struct ast_channel *winner = NULL;
3208         struct ast_epoll_data *aed = NULL;
3209
3210         ast_channel_lock(chan);
3211         /* Figure out their timeout */
3212         if (!ast_tvzero(*ast_channel_whentohangup(chan))) {
3213                 if ((diff = ast_tvdiff_ms(*ast_channel_whentohangup(chan), ast_tvnow())) < 0) {
3214                         /* They should already be hungup! */
3215                         ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_TIMEOUT);
3216                         ast_channel_unlock(chan);
3217                         return NULL;
3218                 }
3219                 /* If this value is smaller then the current one... make it priority */
3220                 if (rms > diff) {
3221                         rms = diff;
3222                 }
3223         }
3224
3225         ast_channel_unlock(chan);
3226
3227         /* Time to make this channel block... */
3228         CHECK_BLOCKING(chan);
3229
3230         if (*ms > 0) {
3231                 start = ast_tvnow();
3232         }
3233
3234         /* We don't have to add any file descriptors... they are already added, we just have to wait! */
3235         res = epoll_wait(ast_channel_epfd(chan), ev, 1, rms);
3236
3237         /* Stop blocking */
3238         ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
3239
3240         /* Simulate a timeout if we were interrupted */
3241         if (res < 0) {
3242                 if (errno != EINTR) {
3243                         *ms = -1;
3244                 }
3245                 return NULL;
3246         }
3247
3248         /* If this channel has a timeout see if it expired */
3249         if (!ast_tvzero(*ast_channel_whentohangup(chan))) {
3250                 if (ast_tvdiff_ms(ast_tvnow(), *ast_channel_whentohangup(chan)) >= 0) {
3251                         ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_TIMEOUT);
3252                         winner = chan;
3253                 }
3254         }
3255
3256         /* No fd ready, reset timeout and be done for now */
3257         if (!res) {
3258                 *ms = 0;
3259                 return winner;
3260         }
3261
3262         /* See what events are pending */
3263         aed = ev[0].data.ptr;
3264         ast_channel_fdno_set(chan, aed->which);
3265         if (ev[0].events & EPOLLPRI) {
3266                 ast_set_flag(ast_channel_flags(chan), AST_FLAG_EXCEPTION);
3267         } else {
3268                 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_EXCEPTION);
3269         }
3270
3271         if (*ms > 0) {
3272                 *ms -= ast_tvdiff_ms(ast_tvnow(), start);
3273                 if (*ms < 0) {
3274                         *ms = 0;
3275                 }
3276         }
3277
3278         return chan;
3279 }
3280
3281 static struct ast_channel *ast_waitfor_nandfds_complex(struct ast_channel **c, int n, int *ms)
3282 {
3283         struct timeval start = { 0 , 0 };
3284         int res = 0, i;
3285         struct epoll_event ev[25] = { { 0, } };
3286         struct timeval now = { 0, 0 };
3287         long whentohangup = 0, diff = 0, rms = *ms;
3288         struct ast_channel *winner = NULL;
3289
3290         for (i = 0; i < n; i++) {
3291                 ast_channel_lock(c[i]);
3292                 if (!ast_tvzero(*ast_channel_whentohangup(c[i]))) {
3293                         if (whentohangup == 0) {
3294                                 now = ast_tvnow();
3295                         }
3296                         if ((diff = ast_tvdiff_ms(*ast_channel_whentohangup(c[i]), now)) < 0) {
3297                                 ast_channel_softhangup_internal_flag_add(c[i], AST_SOFTHANGUP_TIMEOUT);
3298                                 ast_channel_unlock(c[i]);
3299                                 return c[i];
3300                         }
3301                         if (!whentohangup || whentohangup > diff) {
3302                                 whentohangup = diff;
3303                         }
3304                 }
3305                 ast_channel_unlock(c[i]);
3306                 CHECK_BLOCKING(c[i]);
3307         }
3308
3309         rms = *ms;
3310         if (whentohangup) {
3311                 rms = whentohangup;
3312                 if (*ms >= 0 && *ms < rms) {
3313                         rms = *ms;
3314                 }
3315         }
3316
3317         if (*ms > 0) {
3318                 start = ast_tvnow();
3319         }
3320
3321         res = epoll_wait(ast_channel_epfd(c[0]), ev, 25, rms);
3322
3323         for (i = 0; i < n; i++) {
3324                 ast_clear_flag(ast_channel_flags(c[i]), AST_FLAG_BLOCKING);
3325         }
3326
3327         if (res < 0) {
3328                 if (errno != EINTR) {
3329                         *ms = -1;
3330                 }
3331                 return NULL;
3332         }
3333
3334         if (whentohangup) {
3335                 now = ast_tvnow();
3336                 for (i = 0; i < n; i++) {
3337                         if (!ast_tvzero(*ast_channel_whentohangup(c[i])) && ast_tvdiff_ms(now, *ast_channel_whentohangup(c[i])) >= 0) {
3338                                 ast_channel_softhangup_internal_flag_add(c[i], AST_SOFTHANGUP_TIMEOUT);
3339                                 if (!winner) {
3340                                         winner = c[i];
3341                                 }
3342                         }
3343                 }
3344         }
3345
3346         if (!res) {
3347                 *ms = 0;
3348                 return winner;
3349         }
3350
3351         for (i = 0; i < res; i++) {
3352                 struct ast_epoll_data *aed = ev[i].data.ptr;
3353
3354                 if (!ev[i].events || !aed) {
3355                         continue;
3356                 }
3357
3358                 winner = aed->chan;
3359                 if (ev[i].events & EPOLLPRI) {
3360                         ast_set_flag(ast_channel_flags(winner), AST_FLAG_EXCEPTION);
3361                 } else {
3362                         ast_clear_flag(ast_channel_flags(winner), AST_FLAG_EXCEPTION);
3363                 }
3364                 ast_channel_fdno_set(winner, aed->which);
3365         }
3366
3367         if (*ms > 0) {
3368                 *ms -= ast_tvdiff_ms(ast_tvnow(), start);
3369                 if (*ms < 0) {
3370                         *ms = 0;
3371                 }
3372         }
3373
3374         return winner;
3375 }
3376
3377 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **c, int n, int *fds, int nfds,
3378                                         int *exception, int *outfd, int *ms)
3379 {
3380         /* Clear all provided values in one place. */
3381         if (outfd) {
3382                 *outfd = -99999;
3383         }
3384         if (exception) {
3385                 *exception = 0;
3386         }
3387
3388         /* If no epoll file descriptor is available resort to classic nandfds */
3389         if (!n || nfds || ast_channel_epfd(c[0]) == -1) {
3390                 return ast_waitfor_nandfds_classic(c, n, fds, nfds, exception, outfd, ms);
3391         } else if (!nfds && n == 1) {
3392                 return ast_waitfor_nandfds_simple(c[0], ms);
3393         } else {
3394                 return ast_waitfor_nandfds_complex(c, n, ms);
3395         }
3396 }
3397 #endif
3398
3399 struct ast_channel *ast_waitfor_n(struct ast_channel **c, int n, int *ms)
3400 {
3401         return ast_waitfor_nandfds(c, n, NULL, 0, NULL, NULL, ms);
3402 }
3403
3404 int ast_waitfor(struct ast_channel *c, int ms)
3405 {
3406         if (ms < 0) {
3407                 do {
3408                         ms = 100000;
3409                         ast_waitfor_nandfds(&c, 1, NULL, 0, NULL, NULL, &ms);
3410                 } while (!ms);
3411         } else {
3412                 ast_waitfor_nandfds(&c, 1, NULL, 0, NULL, NULL, &ms);
3413         }
3414         return ms;
3415 }
3416
3417 int ast_waitfordigit(struct ast_channel *c, int ms)
3418 {
3419         return ast_waitfordigit_full(c, ms, -1, -1);
3420 }
3421
3422 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data)
3423 {
3424         return ast_settimeout_full(c, rate, func, data, 0);
3425 }
3426
3427 int ast_settimeout_full(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data, unsigned int is_ao2_obj)
3428 {
3429         int res;
3430         unsigned int real_rate = rate, max_rate;
3431
3432         ast_channel_lock(c);
3433
3434         if (ast_channel_timingfd(c) == -1) {
3435                 ast_channel_unlock(c);
3436                 return -1;
3437         }
3438
3439         if (!func) {
3440                 rate = 0;
3441                 data = NULL;
3442         }
3443
3444         if (rate && rate > (max_rate = ast_timer_get_max_rate(ast_channel_timer(c)))) {
3445                 real_rate = max_rate;
3446         }
3447
3448         ast_debug(1, "Scheduling timer at (%u requested / %u actual) timer ticks per second\n", rate, real_rate);
3449
3450         res = ast_timer_set_rate(ast_channel_timer(c), real_rate);
3451
3452         if (ast_channel_timingdata(c) && ast_test_flag(ast_channel_flags(c), AST_FLAG_TIMINGDATA_IS_AO2_OBJ)) {
3453                 ao2_ref(ast_channel_timingdata(c), -1);
3454         }
3455
3456         ast_channel_timingfunc_set(c, func);
3457         ast_channel_timingdata_set(c, data);
3458
3459         if (data && is_ao2_obj) {
3460                 ao2_ref(data, 1);
3461                 ast_set_flag(ast_channel_flags(c), AST_FLAG_TIMINGDATA_IS_AO2_OBJ);
3462         } else {
3463                 ast_clear_flag(ast_channel_flags(c), AST_FLAG_TIMINGDATA_IS_AO2_OBJ);
3464         }
3465
3466         if (func == NULL && rate == 0 && ast_channel_fdno(c) == AST_TIMING_FD) {
3467                 /* Clearing the timing func and setting the rate to 0
3468                  * means that we don't want to be reading from the timingfd
3469                  * any more. Setting c->fdno to -1 means we won't have any
3470                  * errant reads from the timingfd, meaning we won't potentially
3471                  * miss any important frames.
3472                  */
3473                 ast_channel_fdno_set(c, -1);
3474         }
3475
3476         ast_channel_unlock(c);
3477
3478         return res;
3479 }
3480
3481 int ast_waitfordigit_full(struct ast_channel *c, int timeout_ms, int audiofd, int cmdfd)
3482 {
3483         struct timeval start = ast_tvnow();
3484         int ms;
3485
3486         /* Stop if we're a zombie or need a soft hangup */
3487         if (ast_test_flag(ast_channel_flags(c), AST_FLAG_ZOMBIE) || ast_check_hangup(c))
3488                 return -1;
3489
3490         /* Only look for the end of DTMF, don't bother with the beginning and don't emulate things */
3491         ast_set_flag(ast_channel_flags(c), AST_FLAG_END_DTMF_ONLY);
3492
3493         /* Wait for a digit, no more than timeout_ms milliseconds total.
3494          * Or, wait indefinitely if timeout_ms is <0.
3495          */
3496         while ((ms = ast_remaining_ms(start, timeout_ms))) {
3497                 struct ast_channel *rchan;
3498                 int outfd = -1;
3499
3500                 errno = 0;
3501                 /* While ast_waitfor_nandfds tries to help by reducing the timeout by how much was waited,
3502                  * it is unhelpful if it waited less than a millisecond.
3503                  */
3504                 rchan = ast_waitfor_nandfds(&c, 1, &cmdfd, (cmdfd > -1) ? 1 : 0, NULL, &outfd, &ms);
3505
3506                 if (!rchan && outfd < 0 && ms) {
3507                         if (errno == 0 || errno == EINTR)
3508                                 continue;
3509                         ast_log(LOG_WARNING, "Wait failed (%s)\n", strerror(errno));
3510                         ast_clear_flag(ast_channel_flags(c), AST_FLAG_END_DTMF_ONLY);
3511                         return -1;
3512                 } else if (outfd > -1) {
3513                         /* The FD we were watching has something waiting */
3514                         ast_log(LOG_WARNING, "The FD we were waiting for has something waiting. Waitfordigit returning numeric 1\n");
3515                         ast_clear_flag(ast_channel_flags(c), AST_FLAG_END_DTMF_ONLY);
3516                         return 1;
3517                 } else if (rchan) {
3518                         int res;
3519                         struct ast_frame *f = ast_read(c);
3520                         if (!f)
3521                                 return -1;
3522
3523                         switch (f->frametype) {
3524                         case AST_FRAME_DTMF_BEGIN:
3525                                 break;
3526                         case AST_FRAME_DTMF_END:
3527                                 res = f->subclass.integer;
3528                                 ast_frfree(f);
3529                                 ast_clear_flag(ast_channel_flags(c), AST_FLAG_END_DTMF_ONLY);
3530                                 return res;
3531                         case AST_FRAME_CONTROL:
3532                                 switch (f->subclass.integer) {
3533                                 case AST_CONTROL_HANGUP:
3534                                         ast_frfree(f);
3535                                         ast_clear_flag(ast_channel_flags(c), AST_FLAG_END_DTMF_ONLY);
3536                                         return -1;
3537                                 case AST_CONTROL_STREAM_STOP:
3538                                 case AST_CONTROL_STREAM_SUSPEND:
3539                                 case AST_CONTROL_STREAM_RESTART:
3540                                 case AST_CONTROL_STREAM_REVERSE:
3541                                 case AST_CONTROL_STREAM_FORWARD:
3542                                         /* Fall-through and treat as if it were a DTMF signal. Items
3543                                          * that perform stream control will handle this. */
3544                                         res = f->subclass.integer;
3545                                         ast_frfree(f);
3546                                         ast_clear_flag(ast_channel_flags(c), AST_FLAG_END_DTMF_ONLY);
3547                                         return res;
3548                                 case AST_CONTROL_PVT_CAUSE_CODE:
3549                                 case AST_CONTROL_RINGING:
3550                                 case AST_CONTROL_ANSWER:
3551                                 case AST_CONTROL_SRCUPDATE:
3552                                 case AST_CONTROL_SRCCHANGE:
3553                                 case AST_CONTROL_CONNECTED_LINE:
3554                                 case AST_CONTROL_REDIRECTING:
3555                                 case AST_CONTROL_UPDATE_RTP_PEER:
3556                                 case AST_CONTROL_HOLD:
3557                                 case AST_CONTROL_UNHOLD:
3558                                 case -1:
3559                                         /* Unimportant */
3560                                         break;
3561                                 default:
3562                                         ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", f->subclass.integer);
3563                                         break;
3564                                 }
3565                                 break;
3566                         case AST_FRAME_VOICE:
3567                                 /* Write audio if appropriate */
3568                                 if (audiofd > -1) {
3569                                         if (write(audiofd, f->data.ptr, f->datalen) < 0) {
3570                                                 ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
3571                                         }
3572                                 }
3573                         default:
3574                                 /* Ignore */
3575                                 break;
3576                         }
3577                         ast_frfree(f);
3578                 }
3579         }
3580
3581         ast_clear_flag(ast_channel_flags(c), AST_FLAG_END_DTMF_ONLY);
3582
3583         return 0; /* Time is up */
3584 }
3585
3586 enum DtmfDirection {
3587         DTMF_RECEIVED,
3588         DTMF_SENT
3589 };
3590
3591 static const char *dtmf_direction_to_string(enum DtmfDirection direction)
3592 {
3593         switch (direction) {
3594         case DTMF_RECEIVED:
3595                 return "Received";
3596         case DTMF_SENT:
3597                 return "Sent";
3598         }
3599
3600         return "?";
3601 }
3602
3603 static void send_dtmf_begin_event(struct ast_channel *chan,
3604         enum DtmfDirection direction, const char digit)
3605 {
3606         RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
3607         char digit_str[] = { digit, '\0' };
3608
3609         blob = ast_json_pack("{ s: s, s: s }",
3610                 "digit", digit_str,
3611                 "direction", dtmf_direction_to_string(direction));
3612         if (!blob) {
3613                 return;
3614         }
3615
3616         ast_channel_publish_blob(chan, ast_channel_dtmf_begin_type(), blob);
3617 }
3618
3619 static void send_dtmf_end_event(struct ast_channel *chan,
3620         enum DtmfDirection direction, const char digit, long duration_ms)
3621 {
3622         RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
3623         char digit_str[] = { digit, '\0' };
3624
3625         blob = ast_json_pack("{ s: s, s: s, s: i }",
3626                 "digit", digit_str,
3627                 "direction", dtmf_direction_to_string(direction),
3628                 "duration_ms", duration_ms);
3629         if (!blob) {
3630                 return;
3631         }
3632
3633         ast_channel_publish_blob(chan, ast_channel_dtmf_end_type(), blob);
3634 }
3635
3636 static void ast_read_generator_actions(struct ast_channel *chan, struct ast_frame *f)
3637 {
3638         if (ast_channel_generator(chan) && ast_channel_generator(chan)->generate && ast_channel_generatordata(chan) &&  !ast_internal_timing_enabled(chan)) {
3639                 void *tmp = ast_channel_generatordata(chan);
3640                 int (*generate)(struct ast_channel *chan, void *tmp, int datalen, int samples) = ast_channel_generator(chan)->generate;
3641                 int res;
3642                 int samples;
3643
3644                 if (ast_channel_timingfunc(chan)) {
3645                         ast_debug(1, "Generator got voice, switching to phase locked mode\n");
3646                         ast_settimeout(chan, 0, NULL, NULL);
3647                 }
3648
3649                 ast_channel_generatordata_set(chan, NULL);     /* reset, to let writes go through */
3650
3651                 if (ast_format_cmp(&f->subclass.format, ast_channel_writeformat(chan)) == AST_FORMAT_CMP_NOT_EQUAL) {
3652                         float factor;
3653                         factor = ((float) ast_format_rate(ast_channel_writeformat(chan))) / ((float) ast_format_rate(&f->subclass.format));
3654                         samples = (int) ( ((float) f->samples) * factor );
3655                 } else {
3656                         samples = f->samples;
3657                 }
3658
3659                 /* This unlock is here based on two assumptions that hold true at this point in the
3660                  * code. 1) this function is only called from within __ast_read() and 2) all generators
3661                  * call ast_write() in their generate callback.
3662                  *
3663                  * The reason this is added is so that when ast_write is called, the lock that occurs
3664                  * there will not recursively lock the channel. Doing this will cause intended deadlock
3665                  * avoidance not to work in deeper functions
3666                  */
3667                 ast_channel_unlock(chan);
3668                 res = generate(chan, tmp, f->datalen, samples);
3669                 ast_channel_lock(chan);
3670                 ast_channel_generatordata_set(chan, tmp);
3671                 if (res) {
3672                         ast_debug(1, "Auto-deactivating generator\n");
3673                         ast_deactivate_generator(chan);
3674                 }
3675
3676         } else if (f->frametype == AST_FRAME_CNG) {
3677                 if (ast_channel_generator(chan) && !ast_channel_timingfunc(chan) && (ast_channel_timingfd(chan) > -1)) {
3678                         ast_debug(1, "Generator got CNG, switching to timed mode\n");
3679                         ast_settimeout(chan, 50, generator_force, chan);
3680                 }
3681         }
3682 }
3683
3684 static inline void queue_dtmf_readq(struct ast_channel *chan, struct ast_frame *f)
3685 {
3686         struct ast_frame *fr = ast_channel_dtmff(chan);
3687
3688         fr->frametype = AST_FRAME_DTMF_END;
3689         fr->subclass.integer = f->subclass.integer;
3690         fr->len = f->len;
3691
3692         /* The only time this function will be called is for a frame that just came
3693          * out of the channel driver.  So, we want to stick it on the tail of the
3694          * readq. */
3695
3696         ast_queue_frame(chan, fr);
3697 }
3698
3699 /*!
3700  * \brief Determine whether or not we should ignore DTMF in the readq
3701  */
3702 static inline int should_skip_dtmf(struct ast_channel *chan)
3703 {
3704         if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_DEFER_DTMF | AST_FLAG_EMULATE_DTMF)) {
3705                 /* We're in the middle of emulating a digit, or DTMF has been
3706                  * explicitly deferred.  Skip this digit, then. */
3707                 return 1;
3708         }
3709
3710         if (!ast_tvzero(*ast_channel_dtmf_tv(chan)) &&
3711                         ast_tvdiff_ms(ast_tvnow(), *ast_channel_dtmf_tv(chan)) < AST_MIN_DTMF_GAP) {
3712                 /* We're not in the middle of a digit, but it hasn't been long enough
3713                  * since the last digit, so we'll have to skip DTMF for now. */
3714                 return 1;
3715         }
3716
3717         return 0;
3718 }
3719
3720 /*!
3721  * \brief calculates the number of samples to jump forward with in a monitor stream.
3722
3723  * \note When using ast_seekstream() with the read and write streams of a monitor,
3724  * the number of samples to seek forward must be of the same sample rate as the stream
3725  * or else the jump will not be calculated correctly.
3726  *
3727  * \retval number of samples to seek forward after rate conversion.
3728  */
3729 static inline int calc_monitor_jump(int samples, int sample_rate, int seek_rate)
3730 {
3731         int diff = sample_rate - seek_rate;
3732
3733         if (diff > 0) {
3734                 samples = samples / (float) (sample_rate / seek_rate);
3735         } else if (diff < 0) {
3736                 samples = samples * (float) (seek_rate / sample_rate);
3737         }
3738
3739         return samples;
3740 }
3741
3742 static struct ast_frame *__ast_read(struct ast_channel *chan, int dropaudio)
3743 {
3744         struct ast_frame *f = NULL;     /* the return value */
3745         int prestate;
3746         int cause = 0;
3747
3748         /* this function is very long so make sure there is only one return
3749          * point at the end (there are only two exceptions to this).
3750          */
3751         ast_channel_lock(chan);
3752
3753         /* Stop if we're a zombie or need a soft hangup */
3754         if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
3755                 if (ast_channel_generator(chan))
3756                         ast_deactivate_generator(chan);
3757
3758                 /*
3759                  * It is possible for chan->_softhangup to be set and there
3760                  * still be control frames that need to be read.  Instead of
3761                  * just going to 'done' in the case of ast_check_hangup(), we
3762                  * need to queue the end-of-Q frame so that it can mark the end
3763                  * of the read queue.  If there are frames to be read,
3764                  * ast_queue_control() will be called repeatedly, but will only
3765                  * queue the first end-of-Q frame.
3766                  */
3767                 if (ast_channel_softhangup_internal_flag(chan)) {
3768                         ast_queue_control(chan, AST_CONTROL_END_OF_Q);
3769                 } else {
3770                         goto done;
3771                 }
3772         } else {
3773 #ifdef AST_DEVMODE
3774                 /*
3775                  * The ast_waitfor() code records which of the channel's file
3776                  * descriptors reported that data is available.  In theory,
3777                  * ast_read() should only be called after ast_waitfor() reports
3778                  * that a channel has data available for reading.  However,
3779                  * there still may be some edge cases throughout the code where
3780                  * ast_read() is called improperly.  This can potentially cause
3781                  * problems, so if this is a developer build, make a lot of
3782                  * noise if this happens so that it can be addressed.
3783                  *
3784                  * One of the potential problems is blocking on a dead channel.
3785                  */
3786                 if (ast_channel_fdno(chan) == -1) {
3787                         ast_log(LOG_ERROR,
3788                                 "ast_read() on chan '%s' called with no recorded file descriptor.\n",
3789                                 ast_channel_name(chan));
3790                 }
3791 #endif
3792         }
3793
3794         prestate = ast_channel_state(chan);
3795
3796         if (ast_channel_timingfd(chan) > -1 && ast_channel_fdno(chan) == AST_TIMING_FD) {
3797                 enum ast_timer_event res;
3798
3799                 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_EXCEPTION);
3800
3801                 res = ast_timer_get_event(ast_channel_timer(chan));
3802
3803                 switch (res) {
3804                 case AST_TIMING_EVENT_EXPIRED:
3805                         if (ast_timer_ack(ast_channel_timer(chan), 1) < 0) {
3806                                 ast_log(LOG_ERROR, "Failed to acknoweldge timer in ast_read\n");
3807                                 goto done;
3808                         }
3809
3810                         if (ast_channel_timingfunc(chan)) {
3811                                 /* save a copy of func/data before unlocking the channel */
3812                                 ast_timing_func_t func = ast_channel_timingfunc(chan);
3813                                 void *data = ast_channel_timingdata(chan);
3814                                 int got_ref = 0;
3815                                 if (data && ast_test_flag(ast_channel_flags(chan), AST_FLAG_TIMINGDATA_IS_AO2_OBJ)) {
3816                                         ao2_ref(data, 1);
3817                                         got_ref = 1;
3818                                 }
3819                                 ast_channel_fdno_set(chan, -1);
3820                                 ast_channel_unlock(chan);
3821                                 func(data);
3822                                 if (got_ref) {
3823                                         ao2_ref(data, -1);
3824                                 }
3825                         } else {
3826                                 ast_timer_set_rate(ast_channel_timer(chan), 0);
3827                                 ast_channel_fdno_set(chan, -1);
3828                                 ast_channel_unlock(chan);
3829                         }
3830
3831                         /* cannot 'goto done' because the channel is already unlocked */
3832                         return &ast_null_frame;
3833
3834                 case AST_TIMING_EVENT_CONTINUOUS:
3835                         if (AST_LIST_EMPTY(ast_channel_readq(chan)) ||
3836                                 !AST_LIST_NEXT(AST_LIST_FIRST(ast_channel_readq(chan)), frame_list)) {
3837                                 ast_timer_disable_continuous(ast_channel_timer(chan));
3838                         }
3839                         break;
3840                 }
3841
3842         } else if (ast_channel_fd_isset(chan, AST_GENERATOR_FD) && ast_channel_fdno(chan) == AST_GENERATOR_FD) {
3843                 /* if the AST_GENERATOR_FD is set, call the generator with args
3844                  * set to -1 so it can do whatever it needs to.
3845                  */
3846                 void *tmp = ast_channel_generatordata(chan);
3847                 ast_channel_generatordata_set(chan, NULL);     /* reset to let ast_write get through */
3848                 ast_channel_generator(chan)->generate(chan, tmp, -1, -1);
3849                 ast_channel_generatordata_set(chan, tmp);
3850                 f = &ast_null_frame;
3851                 ast_channel_fdno_set(chan, -1);
3852                 goto done;
3853         } else if (ast_channel_fd_isset(chan, AST_JITTERBUFFER_FD) && ast_channel_fdno(chan) == AST_JITTERBUFFER_FD) {
3854                 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_EXCEPTION);
3855         }
3856
3857         /* Read and ignore anything on the alertpipe, but read only
3858            one sizeof(blah) per frame that we send from it */
3859         if (ast_channel_internal_alert_read(chan) == AST_ALERT_READ_FATAL) {
3860                 f = &ast_null_frame;
3861                 goto done;
3862         }
3863
3864         /* Check for pending read queue */
3865         if (!AST_LIST_EMPTY(ast_channel_readq(chan))) {
3866                 int skip_dtmf = should_skip_dtmf(chan);
3867
3868                 AST_LIST_TRAVERSE_SAFE_BEGIN(ast_channel_readq(chan), f, frame_list) {
3869                         /* We have to be picky about which frame we pull off of the readq because
3870                          * there are cases where we want to leave DTMF frames on the queue until
3871  &n