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