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