channel_internal_api: Publish a snapshot change when linkedids change
[asterisk/asterisk.git] / main / channel_internal_api.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012, 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 Accessor API
22  *
23  * This file is intended to be the only file that ever accesses the
24  * internals of an ast_channel. All other files should use the
25  * accessor functions defined here.
26  *
27  * \author Terry Wilson
28  */
29
30 /*** MODULEINFO
31         <support_level>core</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include <unistd.h>
39 #include <fcntl.h>
40
41 #include "asterisk/paths.h"
42 #include "asterisk/channel.h"
43 #include "asterisk/channel_internal.h"
44 #include "asterisk/data.h"
45 #include "asterisk/endpoints.h"
46 #include "asterisk/indications.h"
47 #include "asterisk/stasis_cache_pattern.h"
48 #include "asterisk/stasis_channels.h"
49 #include "asterisk/stasis_endpoints.h"
50 #include "asterisk/stringfields.h"
51 #include "asterisk/test.h"
52
53 /*!
54  * \brief Channel UniqueId structure
55  * \note channel creation time used for determining LinkedId Propagation
56  */
57 struct ast_channel_id {
58         time_t creation_time;                           /*!< Creation time */
59         int creation_unique;                            /*!< sub-second unique value */
60         char unique_id[AST_MAX_UNIQUEID];       /*!< Unique Identifier */
61 };
62
63 /*!
64  * \brief Main Channel structure associated with a channel.
65  *
66  * \note When adding fields to this structure, it is important to add the field
67  *       'in position' with like-aligned fields, so as to keep the compiler from
68  *       having to add padding to align fields. The structure's fields are sorted
69  *       in this order: pointers, structures, long, int/enum, short, char. This
70  *       is especially important on 64-bit architectures, where mixing 4-byte
71  *       and 8-byte fields causes 4 bytes of padding to be added before many
72  *       8-byte fields.
73  */
74 struct ast_channel {
75         const struct ast_channel_tech *tech;            /*!< Technology (point to channel driver) */
76         void *tech_pvt;                                 /*!< Private data used by the technology driver */
77         void *music_state;                              /*!< Music State*/
78         void *generatordata;                            /*!< Current generator data if there is any */
79         struct ast_generator *generator;                /*!< Current active data generator */
80         struct ast_channel *masq;                       /*!< Channel that will masquerade as us */
81         struct ast_channel *masqr;                      /*!< Who we are masquerading as */
82         const char *blockproc;                          /*!< Procedure causing blocking */
83         const char *appl;                               /*!< Current application */
84         const char *data;                               /*!< Data passed to current application */
85         struct ast_sched_context *sched;                /*!< Schedule context */
86         struct ast_filestream *stream;                  /*!< Stream itself. */
87         struct ast_filestream *vstream;                 /*!< Video Stream itself. */
88         ast_timing_func_t timingfunc;
89         void *timingdata;
90         struct ast_pbx *pbx;                            /*!< PBX private structure for this channel */
91         struct ast_trans_pvt *writetrans;               /*!< Write translation path */
92         struct ast_trans_pvt *readtrans;                /*!< Read translation path */
93         struct ast_audiohook_list *audiohooks;
94         struct ast_framehook_list *framehooks;
95         struct ast_cdr *cdr;                            /*!< Call Detail Record */
96         struct ast_tone_zone *zone;                     /*!< Tone zone as set in indications.conf or
97                                                          *   in the CHANNEL dialplan function */
98         struct ast_channel_monitor *monitor;            /*!< Channel monitoring */
99         struct ast_callid *callid;                      /*!< Bound call identifier pointer */
100 #ifdef HAVE_EPOLL
101         struct ast_epoll_data *epfd_data[AST_MAX_FDS];
102 #endif
103         struct ao2_container *dialed_causes;            /*!< Contains tech-specific and Asterisk cause data from dialed channels */
104
105         AST_DECLARE_STRING_FIELDS(
106                 AST_STRING_FIELD(name);         /*!< ASCII unique channel name */
107                 AST_STRING_FIELD(language);     /*!< Language requested for voice prompts */
108                 AST_STRING_FIELD(musicclass);   /*!< Default music class */
109                 AST_STRING_FIELD(latest_musicclass);   /*!< Latest active music class */
110                 AST_STRING_FIELD(accountcode);  /*!< Account code for billing */
111                 AST_STRING_FIELD(peeraccount);  /*!< Peer account code for billing */
112                 AST_STRING_FIELD(userfield);    /*!< Userfield for CEL billing */
113                 AST_STRING_FIELD(call_forward); /*!< Where to forward to if asked to dial on this interface */
114                 AST_STRING_FIELD(parkinglot);   /*! Default parking lot, if empty, default parking lot  */
115                 AST_STRING_FIELD(hangupsource); /*! Who is responsible for hanging up this channel */
116                 AST_STRING_FIELD(dialcontext);  /*!< Dial: Extension context that we were called from */
117         );
118
119         struct ast_channel_id uniqueid;         /*!< Unique Channel Identifier - can be specified on creation */
120         struct ast_channel_id linkedid;         /*!< Linked Channel Identifier - oldest propagated when bridged */
121
122         struct timeval whentohangup; /*!< Non-zero, set to actual time when channel is to be hung up */
123         pthread_t blocker;           /*!< If anyone is blocking, this is them */
124
125         /*!
126          * \brief Dialed/Called information.
127          * \note Set on incoming channels to indicate the originally dialed party.
128          * \note Dialed Number Identifier (DNID)
129          */
130         struct ast_party_dialed dialed;
131
132         /*!
133          * \brief Channel Caller ID information.
134          * \note The caller id information is the caller id of this
135          * channel when it is used to initiate a call.
136          */
137         struct ast_party_caller caller;
138
139         /*!
140          * \brief Channel Connected Line ID information.
141          * \note The connected line information identifies the channel
142          * connected/bridged to this channel.
143          */
144         struct ast_party_connected_line connected;
145
146         /*!
147          * \brief Channel Connected Line ID information that was last indicated.
148          */
149         struct ast_party_connected_line connected_indicated;
150
151         /*! \brief Redirecting/Diversion information */
152         struct ast_party_redirecting redirecting;
153
154         struct ast_frame dtmff;                         /*!< DTMF frame */
155         struct varshead varshead;                       /*!< A linked list for channel variables. See \ref AstChanVar */
156         ast_group_t callgroup;                          /*!< Call group for call pickups */
157         ast_group_t pickupgroup;                        /*!< Pickup group - which calls groups can be picked up? */
158         struct ast_namedgroups *named_callgroups;       /*!< Named call group for call pickups */
159         struct ast_namedgroups *named_pickupgroups;     /*!< Named pickup group - which call groups can be picked up? */
160         struct timeval creationtime;                    /*!< The time of channel creation */
161         struct timeval answertime;                              /*!< The time the channel was answered */
162         struct ast_readq_list readq;
163         struct ast_jb jb;                               /*!< The jitterbuffer state */
164         struct timeval dtmf_tv;                         /*!< The time that an in process digit began, or the last digit ended */
165         struct ast_hangup_handler_list hangup_handlers;/*!< Hangup handlers on the channel. */
166         struct ast_datastore_list datastores; /*!< Data stores on the channel */
167         struct ast_autochan_list autochans; /*!< Autochans on the channel */
168         unsigned long insmpl;                           /*!< Track the read/written samples for monitor use */
169         unsigned long outsmpl;                          /*!< Track the read/written samples for monitor use */
170
171         int fds[AST_MAX_FDS];                           /*!< File descriptors for channel -- Drivers will poll on
172                                                          *   these file descriptors, so at least one must be non -1.
173                                                          *   See \arg \ref AstFileDesc */
174         int softhangup;                         /*!< Whether or not we have been hung up...  Do not set this value
175                                                          *   directly, use ast_softhangup() */
176         int fdno;                                       /*!< Which fd had an event detected on */
177         int streamid;                                   /*!< For streaming playback, the schedule ID */
178         int vstreamid;                                  /*!< For streaming video playback, the schedule ID */
179         struct ast_format oldwriteformat;  /*!< Original writer format */
180         int timingfd;                                   /*!< Timing fd */
181         enum ast_channel_state state;                   /*!< State of line -- Don't write directly, use ast_setstate() */
182         int rings;                                      /*!< Number of rings so far */
183         int priority;                                   /*!< Dialplan: Current extension priority */
184         int macropriority;                              /*!< Macro: Current non-macro priority. See app_macro.c */
185         int amaflags;                                   /*!< Set BEFORE PBX is started to determine AMA flags */
186         enum ast_channel_adsicpe adsicpe;               /*!< Whether or not ADSI is detected on CPE */
187         unsigned int fin;                               /*!< Frames in counters. The high bit is a debug mask, so
188                                                          *   the counter is only in the remaining bits */
189         unsigned int fout;                              /*!< Frames out counters. The high bit is a debug mask, so
190                                                          *   the counter is only in the remaining bits */
191         int hangupcause;                                /*!< Why is the channel hanged up. See causes.h */
192         unsigned int finalized:1;       /*!< Whether or not the channel has been successfully allocated */
193         struct ast_flags flags;                         /*!< channel flags of AST_FLAG_ type */
194         int alertpipe[2];
195         struct ast_format_cap *nativeformats;         /*!< Kinds of data this channel can natively handle */
196         struct ast_format readformat;            /*!< Requested read format (after translation) */
197         struct ast_format writeformat;           /*!< Requested write format (after translation) */
198         struct ast_format rawreadformat;         /*!< Raw read format (before translation) */
199         struct ast_format rawwriteformat;        /*!< Raw write format (before translation) */
200         unsigned int emulate_dtmf_duration;             /*!< Number of ms left to emulate DTMF for */
201 #ifdef HAVE_EPOLL
202         int epfd;
203 #endif
204         int visible_indication;                         /*!< Indication currently playing on the channel */
205         int hold_state;                                                 /*!< Current Hold/Unhold state */
206
207         unsigned short transfercapability;              /*!< ISDN Transfer Capability - AST_FLAG_DIGITAL is not enough */
208
209         struct ast_bridge *bridge;                      /*!< Bridge this channel is participating in */
210         struct ast_bridge_channel *bridge_channel;/*!< The bridge_channel this channel is linked with. */
211         struct ast_timer *timer;                        /*!< timer object that provided timingfd */
212
213         char context[AST_MAX_CONTEXT];                  /*!< Dialplan: Current extension context */
214         char exten[AST_MAX_EXTENSION];                  /*!< Dialplan: Current extension number */
215         char macrocontext[AST_MAX_CONTEXT];             /*!< Macro: Current non-macro context. See app_macro.c */
216         char macroexten[AST_MAX_EXTENSION];             /*!< Macro: Current non-macro extension. See app_macro.c */
217         char dtmf_digit_to_emulate;                     /*!< Digit being emulated */
218         char sending_dtmf_digit;                        /*!< Digit this channel is currently sending out. (zero if not sending) */
219         struct timeval sending_dtmf_tv;         /*!< The time this channel started sending the current digit. (Invalid if sending_dtmf_digit is zero.) */
220         struct stasis_cp_single *topics;                /*!< Topic for all channel's events */
221         struct stasis_forward *endpoint_forward;        /*!< Subscription for event forwarding to endpoint's topic */
222 };
223
224 /*! \brief The monotonically increasing integer counter for channel uniqueids */
225 static int uniqueint;
226
227 /* AST_DATA definitions, which will probably have to be re-thought since the channel will be opaque */
228
229 #if 0   /* XXX AstData: ast_callerid no longer exists. (Equivalent code not readily apparent.) */
230 #define DATA_EXPORT_CALLERID(MEMBER)                            \
231         MEMBER(ast_callerid, cid_dnid, AST_DATA_STRING)         \
232         MEMBER(ast_callerid, cid_num, AST_DATA_STRING)          \
233         MEMBER(ast_callerid, cid_name, AST_DATA_STRING)         \
234         MEMBER(ast_callerid, cid_ani, AST_DATA_STRING)          \
235         MEMBER(ast_callerid, cid_pres, AST_DATA_INTEGER)        \
236         MEMBER(ast_callerid, cid_ani2, AST_DATA_INTEGER)        \
237         MEMBER(ast_callerid, cid_tag, AST_DATA_STRING)
238
239 AST_DATA_STRUCTURE(ast_callerid, DATA_EXPORT_CALLERID);
240 #endif
241
242 #define DATA_EXPORT_CHANNEL(MEMBER)                                             \
243         MEMBER(ast_channel, blockproc, AST_DATA_STRING)                         \
244         MEMBER(ast_channel, appl, AST_DATA_STRING)                              \
245         MEMBER(ast_channel, data, AST_DATA_STRING)                              \
246         MEMBER(ast_channel, name, AST_DATA_STRING) \
247         MEMBER(ast_channel, language, AST_DATA_STRING)                          \
248         MEMBER(ast_channel, musicclass, AST_DATA_STRING)                        \
249         MEMBER(ast_channel, accountcode, AST_DATA_STRING)                       \
250         MEMBER(ast_channel, peeraccount, AST_DATA_STRING)                       \
251         MEMBER(ast_channel, userfield, AST_DATA_STRING)                         \
252         MEMBER(ast_channel, call_forward, AST_DATA_STRING)                      \
253         MEMBER(ast_channel, parkinglot, AST_DATA_STRING)                        \
254         MEMBER(ast_channel, hangupsource, AST_DATA_STRING)                      \
255         MEMBER(ast_channel, dialcontext, AST_DATA_STRING)                       \
256         MEMBER(ast_channel, rings, AST_DATA_INTEGER)                            \
257         MEMBER(ast_channel, priority, AST_DATA_INTEGER)                         \
258         MEMBER(ast_channel, macropriority, AST_DATA_INTEGER)                    \
259         MEMBER(ast_channel, adsicpe, AST_DATA_INTEGER)                          \
260         MEMBER(ast_channel, fin, AST_DATA_UNSIGNED_INTEGER)                     \
261         MEMBER(ast_channel, fout, AST_DATA_UNSIGNED_INTEGER)                    \
262         MEMBER(ast_channel, emulate_dtmf_duration, AST_DATA_UNSIGNED_INTEGER)   \
263         MEMBER(ast_channel, visible_indication, AST_DATA_INTEGER)               \
264         MEMBER(ast_channel, context, AST_DATA_STRING)                           \
265         MEMBER(ast_channel, exten, AST_DATA_STRING)                             \
266         MEMBER(ast_channel, macrocontext, AST_DATA_STRING)                      \
267         MEMBER(ast_channel, macroexten, AST_DATA_STRING)
268
269 AST_DATA_STRUCTURE(ast_channel, DATA_EXPORT_CHANNEL);
270
271 static void channel_data_add_flags(struct ast_data *tree,
272         struct ast_channel *chan)
273 {
274         ast_data_add_bool(tree, "DEFER_DTMF", ast_test_flag(ast_channel_flags(chan), AST_FLAG_DEFER_DTMF));
275         ast_data_add_bool(tree, "WRITE_INT", ast_test_flag(ast_channel_flags(chan), AST_FLAG_WRITE_INT));
276         ast_data_add_bool(tree, "BLOCKING", ast_test_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING));
277         ast_data_add_bool(tree, "ZOMBIE", ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE));
278         ast_data_add_bool(tree, "EXCEPTION", ast_test_flag(ast_channel_flags(chan), AST_FLAG_EXCEPTION));
279         ast_data_add_bool(tree, "MOH", ast_test_flag(ast_channel_flags(chan), AST_FLAG_MOH));
280         ast_data_add_bool(tree, "SPYING", ast_test_flag(ast_channel_flags(chan), AST_FLAG_SPYING));
281         ast_data_add_bool(tree, "IN_AUTOLOOP", ast_test_flag(ast_channel_flags(chan), AST_FLAG_IN_AUTOLOOP));
282         ast_data_add_bool(tree, "OUTGOING", ast_test_flag(ast_channel_flags(chan), AST_FLAG_OUTGOING));
283         ast_data_add_bool(tree, "IN_DTMF", ast_test_flag(ast_channel_flags(chan), AST_FLAG_IN_DTMF));
284         ast_data_add_bool(tree, "EMULATE_DTMF", ast_test_flag(ast_channel_flags(chan), AST_FLAG_EMULATE_DTMF));
285         ast_data_add_bool(tree, "END_DTMF_ONLY", ast_test_flag(ast_channel_flags(chan), AST_FLAG_END_DTMF_ONLY));
286         ast_data_add_bool(tree, "MASQ_NOSTREAM", ast_test_flag(ast_channel_flags(chan), AST_FLAG_MASQ_NOSTREAM));
287         ast_data_add_bool(tree, "BRIDGE_HANGUP_RUN", ast_test_flag(ast_channel_flags(chan), AST_FLAG_BRIDGE_HANGUP_RUN));
288         ast_data_add_bool(tree, "DISABLE_WORKAROUNDS", ast_test_flag(ast_channel_flags(chan), AST_FLAG_DISABLE_WORKAROUNDS));
289         ast_data_add_bool(tree, "DISABLE_DEVSTATE_CACHE", ast_test_flag(ast_channel_flags(chan), AST_FLAG_DISABLE_DEVSTATE_CACHE));
290         ast_data_add_bool(tree, "BRIDGE_DUAL_REDIRECT_WAIT", ast_test_flag(ast_channel_flags(chan), AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT));
291         ast_data_add_bool(tree, "ORIGINATED", ast_test_flag(ast_channel_flags(chan), AST_FLAG_ORIGINATED));
292         ast_data_add_bool(tree, "DEAD", ast_test_flag(ast_channel_flags(chan), AST_FLAG_DEAD));
293 }
294
295 int ast_channel_data_add_structure(struct ast_data *tree,
296         struct ast_channel *chan, int add_bridged)
297 {
298         struct ast_data *data_bridged;
299         struct ast_data *data_cdr;
300         struct ast_data *data_flags;
301         struct ast_data *data_zones;
302         struct ast_data *enum_node;
303         struct ast_data *data_softhangup;
304 #if 0   /* XXX AstData: ast_callerid no longer exists. (Equivalent code not readily apparent.) */
305         struct ast_data *data_callerid;
306         char value_str[100];
307 #endif
308
309         if (!tree) {
310                 return -1;
311         }
312
313         ast_data_add_structure(ast_channel, tree, chan);
314
315         if (add_bridged) {
316                 RAII_VAR(struct ast_channel *, bc, ast_channel_bridge_peer(chan), ast_channel_cleanup);
317                 if (bc) {
318                         data_bridged = ast_data_add_node(tree, "bridged");
319                         if (!data_bridged) {
320                                 return -1;
321                         }
322                         ast_channel_data_add_structure(data_bridged, bc, 0);
323                 }
324         }
325
326         ast_data_add_str(tree, "uniqueid", ast_channel_uniqueid(chan));
327         ast_data_add_str(tree, "linkedid", ast_channel_linkedid(chan));
328
329         ast_data_add_codec(tree, "oldwriteformat", ast_channel_oldwriteformat(chan));
330         ast_data_add_codec(tree, "readformat", ast_channel_readformat(chan));
331         ast_data_add_codec(tree, "writeformat", ast_channel_writeformat(chan));
332         ast_data_add_codec(tree, "rawreadformat", ast_channel_rawreadformat(chan));
333         ast_data_add_codec(tree, "rawwriteformat", ast_channel_rawwriteformat(chan));
334         ast_data_add_codecs(tree, "nativeformats", ast_channel_nativeformats(chan));
335
336         /* state */
337         enum_node = ast_data_add_node(tree, "state");
338         if (!enum_node) {
339                 return -1;
340         }
341         ast_data_add_str(enum_node, "text", ast_state2str(ast_channel_state(chan)));
342         ast_data_add_int(enum_node, "value", ast_channel_state(chan));
343
344         /* hangupcause */
345         enum_node = ast_data_add_node(tree, "hangupcause");
346         if (!enum_node) {
347                 return -1;
348         }
349         ast_data_add_str(enum_node, "text", ast_cause2str(ast_channel_hangupcause(chan)));
350         ast_data_add_int(enum_node, "value", ast_channel_hangupcause(chan));
351
352         /* amaflags */
353         enum_node = ast_data_add_node(tree, "amaflags");
354         if (!enum_node) {
355                 return -1;
356         }
357         ast_data_add_str(enum_node, "text", ast_channel_amaflags2string(ast_channel_amaflags(chan)));
358         ast_data_add_int(enum_node, "value", ast_channel_amaflags(chan));
359
360         /* transfercapability */
361         enum_node = ast_data_add_node(tree, "transfercapability");
362         if (!enum_node) {
363                 return -1;
364         }
365         ast_data_add_str(enum_node, "text", ast_transfercapability2str(ast_channel_transfercapability(chan)));
366         ast_data_add_int(enum_node, "value", ast_channel_transfercapability(chan));
367
368         /* _softphangup */
369         data_softhangup = ast_data_add_node(tree, "softhangup");
370         if (!data_softhangup) {
371                 return -1;
372         }
373         ast_data_add_bool(data_softhangup, "dev", ast_channel_softhangup_internal_flag(chan) & AST_SOFTHANGUP_DEV);
374         ast_data_add_bool(data_softhangup, "asyncgoto", ast_channel_softhangup_internal_flag(chan) & AST_SOFTHANGUP_ASYNCGOTO);
375         ast_data_add_bool(data_softhangup, "shutdown", ast_channel_softhangup_internal_flag(chan) & AST_SOFTHANGUP_SHUTDOWN);
376         ast_data_add_bool(data_softhangup, "timeout", ast_channel_softhangup_internal_flag(chan) & AST_SOFTHANGUP_TIMEOUT);
377         ast_data_add_bool(data_softhangup, "appunload", ast_channel_softhangup_internal_flag(chan) & AST_SOFTHANGUP_APPUNLOAD);
378         ast_data_add_bool(data_softhangup, "explicit", ast_channel_softhangup_internal_flag(chan) & AST_SOFTHANGUP_EXPLICIT);
379         ast_data_add_bool(data_softhangup, "unbridge", ast_channel_softhangup_internal_flag(chan) & AST_SOFTHANGUP_UNBRIDGE);
380
381         /* channel flags */
382         data_flags = ast_data_add_node(tree, "flags");
383         if (!data_flags) {
384                 return -1;
385         }
386         channel_data_add_flags(data_flags, chan);
387
388         ast_data_add_uint(tree, "timetohangup", ast_channel_whentohangup(chan)->tv_sec);
389
390 #if 0   /* XXX AstData: ast_callerid no longer exists. (Equivalent code not readily apparent.) */
391         /* callerid */
392         data_callerid = ast_data_add_node(tree, "callerid");
393         if (!data_callerid) {
394                 return -1;
395         }
396         ast_data_add_structure(ast_callerid, data_callerid, &(chan->cid));
397         /* insert the callerid ton */
398         enum_node = ast_data_add_node(data_callerid, "cid_ton");
399         if (!enum_node) {
400                 return -1;
401         }
402         ast_data_add_int(enum_node, "value", chan->cid.cid_ton);
403         snprintf(value_str, sizeof(value_str), "TON: %s/Plan: %s",
404                 party_number_ton2str(chan->cid.cid_ton),
405                 party_number_plan2str(chan->cid.cid_ton));
406         ast_data_add_str(enum_node, "text", value_str);
407 #endif
408
409         /* tone zone */
410         if (ast_channel_zone(chan)) {
411                 data_zones = ast_data_add_node(tree, "zone");
412                 if (!data_zones) {
413                         return -1;
414                 }
415                 ast_tone_zone_data_add_structure(data_zones, ast_channel_zone(chan));
416         }
417
418         /* insert cdr */
419         data_cdr = ast_data_add_node(tree, "cdr");
420         if (!data_cdr) {
421                 return -1;
422         }
423
424         return 0;
425 }
426
427 int ast_channel_data_cmp_structure(const struct ast_data_search *tree,
428         struct ast_channel *chan, const char *structure_name)
429 {
430         return ast_data_search_cmp_structure(tree, ast_channel, chan, structure_name);
431 }
432
433 /* ACCESSORS */
434
435 #define DEFINE_STRINGFIELD_SETTERS_FOR(field, publish, assert_on_null) \
436 void ast_channel_##field##_set(struct ast_channel *chan, const char *value) \
437 { \
438         if ((assert_on_null)) ast_assert(!ast_strlen_zero(value)); \
439         if (!strcmp(value, chan->field)) return; \
440         ast_string_field_set(chan, field, value); \
441         if (publish && ast_channel_internal_is_finalized(chan)) ast_channel_publish_snapshot(chan); \
442 } \
443   \
444 void ast_channel_##field##_build_va(struct ast_channel *chan, const char *fmt, va_list ap) \
445 { \
446         ast_string_field_build_va(chan, field, fmt, ap); \
447         if (publish && ast_channel_internal_is_finalized(chan)) ast_channel_publish_snapshot(chan); \
448 } \
449 void ast_channel_##field##_build(struct ast_channel *chan, const char *fmt, ...) \
450 { \
451         va_list ap; \
452         va_start(ap, fmt); \
453         ast_channel_##field##_build_va(chan, fmt, ap); \
454         va_end(ap); \
455 }
456
457 DEFINE_STRINGFIELD_SETTERS_FOR(name, 0, 1);
458 DEFINE_STRINGFIELD_SETTERS_FOR(language, 1, 0);
459 DEFINE_STRINGFIELD_SETTERS_FOR(musicclass, 0, 0);
460 DEFINE_STRINGFIELD_SETTERS_FOR(latest_musicclass, 0, 0);
461 DEFINE_STRINGFIELD_SETTERS_FOR(accountcode, 1, 0);
462 DEFINE_STRINGFIELD_SETTERS_FOR(peeraccount, 1, 0);
463 DEFINE_STRINGFIELD_SETTERS_FOR(userfield, 0, 0);
464 DEFINE_STRINGFIELD_SETTERS_FOR(call_forward, 0, 0);
465 DEFINE_STRINGFIELD_SETTERS_FOR(parkinglot, 0, 0);
466 DEFINE_STRINGFIELD_SETTERS_FOR(hangupsource, 0, 0);
467 DEFINE_STRINGFIELD_SETTERS_FOR(dialcontext, 0, 0);
468
469 #define DEFINE_STRINGFIELD_GETTER_FOR(field) const char *ast_channel_##field(const struct ast_channel *chan) \
470 { \
471         return chan->field; \
472 }
473
474 DEFINE_STRINGFIELD_GETTER_FOR(name);
475 DEFINE_STRINGFIELD_GETTER_FOR(language);
476 DEFINE_STRINGFIELD_GETTER_FOR(musicclass);
477 DEFINE_STRINGFIELD_GETTER_FOR(latest_musicclass);
478 DEFINE_STRINGFIELD_GETTER_FOR(accountcode);
479 DEFINE_STRINGFIELD_GETTER_FOR(peeraccount);
480 DEFINE_STRINGFIELD_GETTER_FOR(userfield);
481 DEFINE_STRINGFIELD_GETTER_FOR(call_forward);
482 DEFINE_STRINGFIELD_GETTER_FOR(parkinglot);
483 DEFINE_STRINGFIELD_GETTER_FOR(hangupsource);
484 DEFINE_STRINGFIELD_GETTER_FOR(dialcontext);
485
486 const char *ast_channel_uniqueid(const struct ast_channel *chan)
487 {
488         ast_assert(chan->uniqueid.unique_id[0] != '\0');
489         return chan->uniqueid.unique_id;
490 }
491
492 const char *ast_channel_linkedid(const struct ast_channel *chan)
493 {
494         ast_assert(chan->linkedid.unique_id[0] != '\0');
495         return chan->linkedid.unique_id;
496 }
497
498 const char *ast_channel_appl(const struct ast_channel *chan)
499 {
500         return chan->appl;
501 }
502 void ast_channel_appl_set(struct ast_channel *chan, const char *value)
503 {
504         chan->appl = value;
505 }
506 const char *ast_channel_blockproc(const struct ast_channel *chan)
507 {
508         return chan->blockproc;
509 }
510 void ast_channel_blockproc_set(struct ast_channel *chan, const char *value)
511 {
512         chan->blockproc = value;
513 }
514 const char *ast_channel_data(const struct ast_channel *chan)
515 {
516         return chan->data;
517 }
518 void ast_channel_data_set(struct ast_channel *chan, const char *value)
519 {
520         chan->data = value;
521 }
522
523 const char *ast_channel_context(const struct ast_channel *chan)
524 {
525         return chan->context;
526 }
527 void ast_channel_context_set(struct ast_channel *chan, const char *value)
528 {
529         ast_copy_string(chan->context, value, sizeof(chan->context));
530 }
531 const char *ast_channel_exten(const struct ast_channel *chan)
532 {
533         return chan->exten;
534 }
535 void ast_channel_exten_set(struct ast_channel *chan, const char *value)
536 {
537         ast_copy_string(chan->exten, value, sizeof(chan->exten));
538 }
539 const char *ast_channel_macrocontext(const struct ast_channel *chan)
540 {
541         return chan->macrocontext;
542 }
543 void ast_channel_macrocontext_set(struct ast_channel *chan, const char *value)
544 {
545         ast_copy_string(chan->macrocontext, value, sizeof(chan->macrocontext));
546 }
547 const char *ast_channel_macroexten(const struct ast_channel *chan)
548 {
549         return chan->macroexten;
550 }
551 void ast_channel_macroexten_set(struct ast_channel *chan, const char *value)
552 {
553         ast_copy_string(chan->macroexten, value, sizeof(chan->macroexten));
554 }
555
556 char ast_channel_dtmf_digit_to_emulate(const struct ast_channel *chan)
557 {
558         return chan->dtmf_digit_to_emulate;
559 }
560 void ast_channel_dtmf_digit_to_emulate_set(struct ast_channel *chan, char value)
561 {
562         chan->dtmf_digit_to_emulate = value;
563 }
564
565 char ast_channel_sending_dtmf_digit(const struct ast_channel *chan)
566 {
567         return chan->sending_dtmf_digit;
568 }
569 void ast_channel_sending_dtmf_digit_set(struct ast_channel *chan, char value)
570 {
571         chan->sending_dtmf_digit = value;
572 }
573
574 struct timeval ast_channel_sending_dtmf_tv(const struct ast_channel *chan)
575 {
576         return chan->sending_dtmf_tv;
577 }
578 void ast_channel_sending_dtmf_tv_set(struct ast_channel *chan, struct timeval value)
579 {
580         chan->sending_dtmf_tv = value;
581 }
582
583 enum ama_flags ast_channel_amaflags(const struct ast_channel *chan)
584 {
585         return chan->amaflags;
586 }
587
588 void ast_channel_amaflags_set(struct ast_channel *chan, enum ama_flags value)
589 {
590         if (chan->amaflags == value) {
591                 return;
592         }
593         chan->amaflags = value;
594         ast_channel_publish_snapshot(chan);
595 }
596
597 #ifdef HAVE_EPOLL
598 int ast_channel_epfd(const struct ast_channel *chan)
599 {
600         return chan->epfd;
601 }
602 void ast_channel_epfd_set(struct ast_channel *chan, int value)
603 {
604         chan->epfd = value;
605 }
606 #endif
607 int ast_channel_fdno(const struct ast_channel *chan)
608 {
609         return chan->fdno;
610 }
611 void ast_channel_fdno_set(struct ast_channel *chan, int value)
612 {
613         chan->fdno = value;
614 }
615 int ast_channel_hangupcause(const struct ast_channel *chan)
616 {
617         return chan->hangupcause;
618 }
619 void ast_channel_hangupcause_set(struct ast_channel *chan, int value)
620 {
621         chan->hangupcause = value;
622 }
623 int ast_channel_macropriority(const struct ast_channel *chan)
624 {
625         return chan->macropriority;
626 }
627 void ast_channel_macropriority_set(struct ast_channel *chan, int value)
628 {
629         chan->macropriority = value;
630 }
631 int ast_channel_priority(const struct ast_channel *chan)
632 {
633         return chan->priority;
634 }
635 void ast_channel_priority_set(struct ast_channel *chan, int value)
636 {
637         chan->priority = value;
638 }
639 int ast_channel_rings(const struct ast_channel *chan)
640 {
641         return chan->rings;
642 }
643 void ast_channel_rings_set(struct ast_channel *chan, int value)
644 {
645         chan->rings = value;
646 }
647 int ast_channel_streamid(const struct ast_channel *chan)
648 {
649         return chan->streamid;
650 }
651 void ast_channel_streamid_set(struct ast_channel *chan, int value)
652 {
653         chan->streamid = value;
654 }
655 int ast_channel_timingfd(const struct ast_channel *chan)
656 {
657         return chan->timingfd;
658 }
659 void ast_channel_timingfd_set(struct ast_channel *chan, int value)
660 {
661         chan->timingfd = value;
662 }
663 int ast_channel_visible_indication(const struct ast_channel *chan)
664 {
665         return chan->visible_indication;
666 }
667 void ast_channel_visible_indication_set(struct ast_channel *chan, int value)
668 {
669         chan->visible_indication = value;
670 }
671 int ast_channel_hold_state(const struct ast_channel *chan)
672 {
673         return chan->hold_state;
674 }
675 void ast_channel_hold_state_set(struct ast_channel *chan, int value)
676 {
677         chan->hold_state = value;
678 }
679 int ast_channel_vstreamid(const struct ast_channel *chan)
680 {
681         return chan->vstreamid;
682 }
683 void ast_channel_vstreamid_set(struct ast_channel *chan, int value)
684 {
685         chan->vstreamid = value;
686 }
687 unsigned short ast_channel_transfercapability(const struct ast_channel *chan)
688 {
689         return chan->transfercapability;
690 }
691 void ast_channel_transfercapability_set(struct ast_channel *chan, unsigned short value)
692 {
693         chan->transfercapability = value;
694 }
695 unsigned int ast_channel_emulate_dtmf_duration(const struct ast_channel *chan)
696 {
697         return chan->emulate_dtmf_duration;
698 }
699 void ast_channel_emulate_dtmf_duration_set(struct ast_channel *chan, unsigned int value)
700 {
701         chan->emulate_dtmf_duration = value;
702 }
703 unsigned int ast_channel_fin(const struct ast_channel *chan)
704 {
705         return chan->fin;
706 }
707 void ast_channel_fin_set(struct ast_channel *chan, unsigned int value)
708 {
709         chan->fin = value;
710 }
711 unsigned int ast_channel_fout(const struct ast_channel *chan)
712 {
713         return chan->fout;
714 }
715 void ast_channel_fout_set(struct ast_channel *chan, unsigned int value)
716 {
717         chan->fout = value;
718 }
719 unsigned long ast_channel_insmpl(const struct ast_channel *chan)
720 {
721         return chan->insmpl;
722 }
723 void ast_channel_insmpl_set(struct ast_channel *chan, unsigned long value)
724 {
725         chan->insmpl = value;
726 }
727 unsigned long ast_channel_outsmpl(const struct ast_channel *chan)
728 {
729         return chan->outsmpl;
730 }
731 void ast_channel_outsmpl_set(struct ast_channel *chan, unsigned long value)
732 {
733         chan->outsmpl = value;
734 }
735 void *ast_channel_generatordata(const struct ast_channel *chan)
736 {
737         return chan->generatordata;
738 }
739 void ast_channel_generatordata_set(struct ast_channel *chan, void *value)
740 {
741         chan->generatordata = value;
742 }
743 void *ast_channel_music_state(const struct ast_channel *chan)
744 {
745         return chan->music_state;
746 }
747 void ast_channel_music_state_set(struct ast_channel *chan, void *value)
748 {
749         chan->music_state = value;
750 }
751 void *ast_channel_tech_pvt(const struct ast_channel *chan)
752 {
753         return chan->tech_pvt;
754 }
755 void ast_channel_tech_pvt_set(struct ast_channel *chan, void *value)
756 {
757         chan->tech_pvt = value;
758 }
759 void *ast_channel_timingdata(const struct ast_channel *chan)
760 {
761         return chan->timingdata;
762 }
763 void ast_channel_timingdata_set(struct ast_channel *chan, void *value)
764 {
765         chan->timingdata = value;
766 }
767 struct ast_audiohook_list *ast_channel_audiohooks(const struct ast_channel *chan)
768 {
769         return chan->audiohooks;
770 }
771 void ast_channel_audiohooks_set(struct ast_channel *chan, struct ast_audiohook_list *value)
772 {
773         chan->audiohooks = value;
774 }
775 struct ast_cdr *ast_channel_cdr(const struct ast_channel *chan)
776 {
777         return chan->cdr;
778 }
779 void ast_channel_cdr_set(struct ast_channel *chan, struct ast_cdr *value)
780 {
781         chan->cdr = value;
782 }
783 struct ast_channel *ast_channel_masq(const struct ast_channel *chan)
784 {
785         return chan->masq;
786 }
787 void ast_channel_masq_set(struct ast_channel *chan, struct ast_channel *value)
788 {
789         chan->masq = value;
790 }
791 struct ast_channel *ast_channel_masqr(const struct ast_channel *chan)
792 {
793         return chan->masqr;
794 }
795 void ast_channel_masqr_set(struct ast_channel *chan, struct ast_channel *value)
796 {
797         chan->masqr = value;
798 }
799 struct ast_channel_monitor *ast_channel_monitor(const struct ast_channel *chan)
800 {
801         return chan->monitor;
802 }
803 void ast_channel_monitor_set(struct ast_channel *chan, struct ast_channel_monitor *value)
804 {
805         chan->monitor = value;
806 }
807 struct ast_filestream *ast_channel_stream(const struct ast_channel *chan)
808 {
809         return chan->stream;
810 }
811 void ast_channel_stream_set(struct ast_channel *chan, struct ast_filestream *value)
812 {
813         chan->stream = value;
814 }
815 struct ast_filestream *ast_channel_vstream(const struct ast_channel *chan)
816 {
817         return chan->vstream;
818 }
819 void ast_channel_vstream_set(struct ast_channel *chan, struct ast_filestream *value)
820 {
821         chan->vstream = value;
822 }
823 struct ast_format_cap *ast_channel_nativeformats(const struct ast_channel *chan)
824 {
825         return chan->nativeformats;
826 }
827 void ast_channel_nativeformats_set(struct ast_channel *chan, struct ast_format_cap *value)
828 {
829         chan->nativeformats = value;
830 }
831 struct ast_framehook_list *ast_channel_framehooks(const struct ast_channel *chan)
832 {
833         return chan->framehooks;
834 }
835 void ast_channel_framehooks_set(struct ast_channel *chan, struct ast_framehook_list *value)
836 {
837         chan->framehooks = value;
838 }
839 struct ast_generator *ast_channel_generator(const struct ast_channel *chan)
840 {
841         return chan->generator;
842 }
843 void ast_channel_generator_set(struct ast_channel *chan, struct ast_generator *value)
844 {
845         chan->generator = value;
846 }
847 struct ast_pbx *ast_channel_pbx(const struct ast_channel *chan)
848 {
849         return chan->pbx;
850 }
851 void ast_channel_pbx_set(struct ast_channel *chan, struct ast_pbx *value)
852 {
853         chan->pbx = value;
854 }
855 struct ast_sched_context *ast_channel_sched(const struct ast_channel *chan)
856 {
857         return chan->sched;
858 }
859 void ast_channel_sched_set(struct ast_channel *chan, struct ast_sched_context *value)
860 {
861         chan->sched = value;
862 }
863 struct ast_timer *ast_channel_timer(const struct ast_channel *chan)
864 {
865         return chan->timer;
866 }
867 void ast_channel_timer_set(struct ast_channel *chan, struct ast_timer *value)
868 {
869         chan->timer = value;
870 }
871 struct ast_tone_zone *ast_channel_zone(const struct ast_channel *chan)
872 {
873         return chan->zone;
874 }
875 void ast_channel_zone_set(struct ast_channel *chan, struct ast_tone_zone *value)
876 {
877         chan->zone = value;
878 }
879 struct ast_trans_pvt *ast_channel_readtrans(const struct ast_channel *chan)
880 {
881         return chan->readtrans;
882 }
883 void ast_channel_readtrans_set(struct ast_channel *chan, struct ast_trans_pvt *value)
884 {
885         chan->readtrans = value;
886 }
887 struct ast_trans_pvt *ast_channel_writetrans(const struct ast_channel *chan)
888 {
889         return chan->writetrans;
890 }
891 void ast_channel_writetrans_set(struct ast_channel *chan, struct ast_trans_pvt *value)
892 {
893         chan->writetrans = value;
894 }
895 const struct ast_channel_tech *ast_channel_tech(const struct ast_channel *chan)
896 {
897         return chan->tech;
898 }
899 void ast_channel_tech_set(struct ast_channel *chan, const struct ast_channel_tech *value)
900 {
901         chan->tech = value;
902 }
903 enum ast_channel_adsicpe ast_channel_adsicpe(const struct ast_channel *chan)
904 {
905         return chan->adsicpe;
906 }
907 void ast_channel_adsicpe_set(struct ast_channel *chan, enum ast_channel_adsicpe value)
908 {
909         chan->adsicpe = value;
910 }
911 enum ast_channel_state ast_channel_state(const struct ast_channel *chan)
912 {
913         return chan->state;
914 }
915 struct ast_callid *ast_channel_callid(const struct ast_channel *chan)
916 {
917         if (chan->callid) {
918                 ast_callid_ref(chan->callid);
919                 return chan->callid;
920         }
921         return NULL;
922 }
923 void ast_channel_callid_set(struct ast_channel *chan, struct ast_callid *callid)
924 {
925         char call_identifier_from[AST_CALLID_BUFFER_LENGTH];
926         char call_identifier_to[AST_CALLID_BUFFER_LENGTH];
927         call_identifier_from[0] = '\0';
928         ast_callid_strnprint(call_identifier_to, sizeof(call_identifier_to), callid);
929         if (chan->callid) {
930                 ast_callid_strnprint(call_identifier_from, sizeof(call_identifier_from), chan->callid);
931                 ast_debug(3, "Channel Call ID changing from %s to %s\n", call_identifier_from, call_identifier_to);
932                 /* unbind if already set */
933                 ast_callid_unref(chan->callid);
934         }
935
936         chan->callid = ast_callid_ref(callid);
937
938         ast_test_suite_event_notify("CallIDChange",
939                 "State: CallIDChange\r\n"
940                 "Channel: %s\r\n"
941                 "CallID: %s\r\n"
942                 "PriorCallID: %s",
943                 ast_channel_name(chan),
944                 call_identifier_to,
945                 call_identifier_from);
946 }
947
948 void ast_channel_state_set(struct ast_channel *chan, enum ast_channel_state value)
949 {
950         chan->state = value;
951 }
952 struct ast_format *ast_channel_oldwriteformat(struct ast_channel *chan)
953 {
954         return &chan->oldwriteformat;
955 }
956 struct ast_format *ast_channel_rawreadformat(struct ast_channel *chan)
957 {
958         return &chan->rawreadformat;
959 }
960 struct ast_format *ast_channel_rawwriteformat(struct ast_channel *chan)
961 {
962         return &chan->rawwriteformat;
963 }
964 struct ast_format *ast_channel_readformat(struct ast_channel *chan)
965 {
966         return &chan->readformat;
967 }
968 struct ast_format *ast_channel_writeformat(struct ast_channel *chan)
969 {
970         return &chan->writeformat;
971 }
972 struct ast_hangup_handler_list *ast_channel_hangup_handlers(struct ast_channel *chan)
973 {
974         return &chan->hangup_handlers;
975 }
976 struct ast_datastore_list *ast_channel_datastores(struct ast_channel *chan)
977 {
978         return &chan->datastores;
979 }
980 struct ast_autochan_list *ast_channel_autochans(struct ast_channel *chan)
981 {
982         return &chan->autochans;
983 }
984 struct ast_readq_list *ast_channel_readq(struct ast_channel *chan)
985 {
986         return &chan->readq;
987 }
988 struct ast_frame *ast_channel_dtmff(struct ast_channel *chan)
989 {
990         return &chan->dtmff;
991 }
992 struct ast_jb *ast_channel_jb(struct ast_channel *chan)
993 {
994         return &chan->jb;
995 }
996 struct ast_party_caller *ast_channel_caller(struct ast_channel *chan)
997 {
998         return &chan->caller;
999 }
1000 struct ast_party_connected_line *ast_channel_connected(struct ast_channel *chan)
1001 {
1002         return &chan->connected;
1003 }
1004 struct ast_party_connected_line *ast_channel_connected_indicated(struct ast_channel *chan)
1005 {
1006         return &chan->connected_indicated;
1007 }
1008 struct ast_party_id ast_channel_connected_effective_id(struct ast_channel *chan)
1009 {
1010         return ast_party_id_merge(&chan->connected.id, &chan->connected.priv);
1011 }
1012 struct ast_party_dialed *ast_channel_dialed(struct ast_channel *chan)
1013 {
1014         return &chan->dialed;
1015 }
1016 struct ast_party_redirecting *ast_channel_redirecting(struct ast_channel *chan)
1017 {
1018         return &chan->redirecting;
1019 }
1020 struct ast_party_id ast_channel_redirecting_effective_orig(struct ast_channel *chan)
1021 {
1022         return ast_party_id_merge(&chan->redirecting.orig, &chan->redirecting.priv_orig);
1023 }
1024 struct ast_party_id ast_channel_redirecting_effective_from(struct ast_channel *chan)
1025 {
1026         return ast_party_id_merge(&chan->redirecting.from, &chan->redirecting.priv_from);
1027 }
1028 struct ast_party_id ast_channel_redirecting_effective_to(struct ast_channel *chan)
1029 {
1030         return ast_party_id_merge(&chan->redirecting.to, &chan->redirecting.priv_to);
1031 }
1032 struct timeval *ast_channel_dtmf_tv(struct ast_channel *chan)
1033 {
1034         return &chan->dtmf_tv;
1035 }
1036 struct timeval *ast_channel_whentohangup(struct ast_channel *chan)
1037 {
1038         return &chan->whentohangup;
1039 }
1040 struct varshead *ast_channel_varshead(struct ast_channel *chan)
1041 {
1042         return &chan->varshead;
1043 }
1044 void ast_channel_dtmff_set(struct ast_channel *chan, struct ast_frame *value)
1045 {
1046         chan->dtmff = *value;
1047 }
1048 void ast_channel_jb_set(struct ast_channel *chan, struct ast_jb *value)
1049 {
1050         chan->jb = *value;
1051 }
1052 void ast_channel_caller_set(struct ast_channel *chan, struct ast_party_caller *value)
1053 {
1054         chan->caller = *value;
1055 }
1056 void ast_channel_connected_set(struct ast_channel *chan, struct ast_party_connected_line *value)
1057 {
1058         chan->connected = *value;
1059 }
1060 void ast_channel_dialed_set(struct ast_channel *chan, struct ast_party_dialed *value)
1061 {
1062         chan->dialed = *value;
1063 }
1064 void ast_channel_redirecting_set(struct ast_channel *chan, struct ast_party_redirecting *value)
1065 {
1066         chan->redirecting = *value;
1067 }
1068 void ast_channel_dtmf_tv_set(struct ast_channel *chan, struct timeval *value)
1069 {
1070         chan->dtmf_tv = *value;
1071 }
1072 void ast_channel_whentohangup_set(struct ast_channel *chan, struct timeval *value)
1073 {
1074         chan->whentohangup = *value;
1075 }
1076 void ast_channel_varshead_set(struct ast_channel *chan, struct varshead *value)
1077 {
1078         chan->varshead = *value;
1079 }
1080 struct timeval ast_channel_creationtime(struct ast_channel *chan)
1081 {
1082         return chan->creationtime;
1083 }
1084 void ast_channel_creationtime_set(struct ast_channel *chan, struct timeval *value)
1085 {
1086         chan->creationtime = *value;
1087 }
1088
1089 struct timeval ast_channel_answertime(struct ast_channel *chan)
1090 {
1091         return chan->answertime;
1092 }
1093
1094 void ast_channel_answertime_set(struct ast_channel *chan, struct timeval *value)
1095 {
1096         chan->answertime = *value;
1097 }
1098
1099 /* Evil softhangup accessors */
1100 int ast_channel_softhangup_internal_flag(struct ast_channel *chan)
1101 {
1102         return chan->softhangup;
1103 }
1104 void ast_channel_softhangup_internal_flag_set(struct ast_channel *chan, int value)
1105 {
1106         chan->softhangup = value;
1107 }
1108 void ast_channel_softhangup_internal_flag_add(struct ast_channel *chan, int value)
1109 {
1110         chan->softhangup |= value;
1111 }
1112 void ast_channel_softhangup_internal_flag_clear(struct ast_channel *chan, int value)
1113 {
1114         chan ->softhangup &= ~value;
1115 }
1116
1117 void ast_channel_callid_cleanup(struct ast_channel *chan)
1118 {
1119         if (chan->callid) {
1120                 chan->callid = ast_callid_unref(chan->callid);
1121         }
1122 }
1123
1124 /* Typedef accessors */
1125 ast_group_t ast_channel_callgroup(const struct ast_channel *chan)
1126 {
1127         return chan->callgroup;
1128 }
1129 void ast_channel_callgroup_set(struct ast_channel *chan, ast_group_t value)
1130 {
1131         chan->callgroup = value;
1132 }
1133 ast_group_t ast_channel_pickupgroup(const struct ast_channel *chan)
1134 {
1135         return chan->pickupgroup;
1136 }
1137 void ast_channel_pickupgroup_set(struct ast_channel *chan, ast_group_t value)
1138 {
1139         chan->pickupgroup = value;
1140 }
1141 struct ast_namedgroups *ast_channel_named_callgroups(const struct ast_channel *chan)
1142 {
1143         return chan->named_callgroups;
1144 }
1145 void ast_channel_named_callgroups_set(struct ast_channel *chan, struct ast_namedgroups *value)
1146 {
1147         ast_unref_namedgroups(chan->named_callgroups);
1148         chan->named_callgroups = ast_ref_namedgroups(value);
1149 }
1150 struct ast_namedgroups *ast_channel_named_pickupgroups(const struct ast_channel *chan)
1151 {
1152         return chan->named_pickupgroups;
1153 }
1154 void ast_channel_named_pickupgroups_set(struct ast_channel *chan, struct ast_namedgroups *value)
1155 {
1156         ast_unref_namedgroups(chan->named_pickupgroups);
1157         chan->named_pickupgroups = ast_ref_namedgroups(value);
1158 }
1159
1160 /* Alertpipe functions */
1161 int ast_channel_alert_write(struct ast_channel *chan)
1162 {
1163         char blah = 0x7F;
1164         return ast_channel_alert_writable(chan) && write(chan->alertpipe[1], &blah, sizeof(blah)) != sizeof(blah);
1165 }
1166
1167 ast_alert_status_t ast_channel_internal_alert_read(struct ast_channel *chan)
1168 {
1169         int flags;
1170         char blah;
1171
1172         if (!ast_channel_internal_alert_readable(chan)) {
1173                 return AST_ALERT_NOT_READABLE;
1174         }
1175
1176         flags = fcntl(chan->alertpipe[0], F_GETFL);
1177         /* For some odd reason, the alertpipe occasionally loses nonblocking status,
1178          * which immediately causes a deadlock scenario.  Detect and prevent this. */
1179         if ((flags & O_NONBLOCK) == 0) {
1180                 ast_log(LOG_ERROR, "Alertpipe on channel %s lost O_NONBLOCK?!!\n", ast_channel_name(chan));
1181                 if (fcntl(chan->alertpipe[0], F_SETFL, flags | O_NONBLOCK) < 0) {
1182                         ast_log(LOG_WARNING, "Unable to set alertpipe nonblocking! (%d: %s)\n", errno, strerror(errno));
1183                         return AST_ALERT_READ_FATAL;
1184                 }
1185         }
1186         if (read(chan->alertpipe[0], &blah, sizeof(blah)) < 0) {
1187                 if (errno != EINTR && errno != EAGAIN) {
1188                         ast_log(LOG_WARNING, "read() failed: %s\n", strerror(errno));
1189                         return AST_ALERT_READ_FAIL;
1190                 }
1191         }
1192
1193         return AST_ALERT_READ_SUCCESS;
1194 }
1195
1196 int ast_channel_alert_writable(struct ast_channel *chan)
1197 {
1198         return chan->alertpipe[1] > -1;
1199 }
1200
1201 int ast_channel_internal_alert_readable(struct ast_channel *chan)
1202 {
1203         return chan->alertpipe[0] > -1;
1204 }
1205
1206 void ast_channel_internal_alertpipe_clear(struct ast_channel *chan)
1207 {
1208         chan->alertpipe[0] = chan->alertpipe[1] = -1;
1209 }
1210
1211 void ast_channel_internal_alertpipe_close(struct ast_channel *chan)
1212 {
1213         if (ast_channel_internal_alert_readable(chan)) {
1214                 close(chan->alertpipe[0]);
1215         }
1216         if (ast_channel_alert_writable(chan)) {
1217                 close(chan->alertpipe[1]);
1218         }
1219 }
1220
1221 int ast_channel_internal_alertpipe_init(struct ast_channel *chan)
1222 {
1223         if (pipe(chan->alertpipe)) {
1224                 ast_log(LOG_WARNING, "Channel allocation failed: Can't create alert pipe! Try increasing max file descriptors with ulimit -n\n");
1225                 return -1;
1226         } else {
1227                 int flags = fcntl(chan->alertpipe[0], F_GETFL);
1228                 if (fcntl(chan->alertpipe[0], F_SETFL, flags | O_NONBLOCK) < 0) {
1229                         ast_log(LOG_WARNING, "Channel allocation failed: Unable to set alertpipe nonblocking! (%d: %s)\n", errno, strerror(errno));
1230                         return -1;
1231                 }
1232                 flags = fcntl(chan->alertpipe[1], F_GETFL);
1233                 if (fcntl(chan->alertpipe[1], F_SETFL, flags | O_NONBLOCK) < 0) {
1234                         ast_log(LOG_WARNING, "Channel allocation failed: Unable to set alertpipe nonblocking! (%d: %s)\n", errno, strerror(errno));
1235                         return -1;
1236                 }
1237         }
1238         return 0;
1239 }
1240
1241 int ast_channel_internal_alert_readfd(struct ast_channel *chan)
1242 {
1243         return chan->alertpipe[0];
1244 }
1245
1246 void ast_channel_internal_alertpipe_swap(struct ast_channel *chan1, struct ast_channel *chan2)
1247 {
1248         int i;
1249         for (i = 0; i < ARRAY_LEN(chan1->alertpipe); i++) {
1250                 SWAP(chan1->alertpipe[i], chan2->alertpipe[i]);
1251         }
1252 }
1253
1254 /* file descriptor array accessors */
1255 void ast_channel_internal_fd_set(struct ast_channel *chan, int which, int value)
1256 {
1257         chan->fds[which] = value;
1258 }
1259 void ast_channel_internal_fd_clear(struct ast_channel *chan, int which)
1260 {
1261         ast_channel_internal_fd_set(chan, which, -1);
1262 }
1263 void ast_channel_internal_fd_clear_all(struct ast_channel *chan)
1264 {
1265         int i;
1266         for (i = 0; i < AST_MAX_FDS; i++) {
1267                 ast_channel_internal_fd_clear(chan, i);
1268         }
1269 }
1270 int ast_channel_fd(const struct ast_channel *chan, int which)
1271 {
1272         return chan->fds[which];
1273 }
1274 int ast_channel_fd_isset(const struct ast_channel *chan, int which)
1275 {
1276         return ast_channel_fd(chan, which) > -1;
1277 }
1278
1279 #ifdef HAVE_EPOLL
1280 struct ast_epoll_data *ast_channel_internal_epfd_data(const struct ast_channel *chan, int which)
1281 {
1282         return chan->epfd_data[which];
1283 }
1284 void ast_channel_internal_epfd_data_set(struct ast_channel *chan, int which , struct ast_epoll_data *value)
1285 {
1286         chan->epfd_data[which] = value;
1287 }
1288 #endif
1289
1290 pthread_t ast_channel_blocker(const struct ast_channel *chan)
1291 {
1292         return chan->blocker;
1293 }
1294 void ast_channel_blocker_set(struct ast_channel *chan, pthread_t value)
1295 {
1296         chan->blocker = value;
1297 }
1298
1299 ast_timing_func_t ast_channel_timingfunc(const struct ast_channel *chan)
1300 {
1301         return chan->timingfunc;
1302 }
1303 void ast_channel_timingfunc_set(struct ast_channel *chan, ast_timing_func_t value)
1304 {
1305         chan->timingfunc = value;
1306 }
1307
1308 struct ast_bridge *ast_channel_internal_bridge(const struct ast_channel *chan)
1309 {
1310         return chan->bridge;
1311 }
1312 void ast_channel_internal_bridge_set(struct ast_channel *chan, struct ast_bridge *value)
1313 {
1314         chan->bridge = value;
1315         ast_channel_publish_snapshot(chan);
1316 }
1317
1318 struct ast_bridge_channel *ast_channel_internal_bridge_channel(const struct ast_channel *chan)
1319 {
1320         return chan->bridge_channel;
1321 }
1322 void ast_channel_internal_bridge_channel_set(struct ast_channel *chan, struct ast_bridge_channel *value)
1323 {
1324         chan->bridge_channel = value;
1325 }
1326
1327 struct ast_flags *ast_channel_flags(struct ast_channel *chan)
1328 {
1329         return &chan->flags;
1330 }
1331
1332 static int collect_names_cb(void *obj, void *arg, int flags) {
1333         struct ast_control_pvt_cause_code *cause_code = obj;
1334         struct ast_str **str = arg;
1335
1336         ast_str_append(str, 0, "%s%s", (ast_str_strlen(*str) ? "," : ""), cause_code->chan_name);
1337
1338         return 0;
1339 }
1340
1341 struct ast_str *ast_channel_dialed_causes_channels(const struct ast_channel *chan)
1342 {
1343         struct ast_str *chanlist = ast_str_create(128);
1344
1345         if (!chanlist) {
1346                 return NULL;
1347         }
1348
1349         ao2_callback(chan->dialed_causes, 0, collect_names_cb, &chanlist);
1350
1351         return chanlist;
1352 }
1353
1354 struct ast_control_pvt_cause_code *ast_channel_dialed_causes_find(const struct ast_channel *chan, const char *chan_name)
1355 {
1356         return ao2_find(chan->dialed_causes, chan_name, OBJ_KEY);
1357 }
1358
1359 int ast_channel_dialed_causes_add(const struct ast_channel *chan, const struct ast_control_pvt_cause_code *cause_code, int datalen)
1360 {
1361         struct ast_control_pvt_cause_code *ao2_cause_code;
1362         ao2_find(chan->dialed_causes, cause_code->chan_name, OBJ_KEY | OBJ_UNLINK | OBJ_NODATA);
1363         ao2_cause_code = ao2_alloc(datalen, NULL);
1364
1365         if (ao2_cause_code) {
1366                 memcpy(ao2_cause_code, cause_code, datalen);
1367                 ao2_link(chan->dialed_causes, ao2_cause_code);
1368                 ao2_ref(ao2_cause_code, -1);
1369                 return 0;
1370         } else {
1371                 return -1;
1372         }
1373 }
1374
1375 void ast_channel_dialed_causes_clear(const struct ast_channel *chan)
1376 {
1377         ao2_callback(chan->dialed_causes, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL);
1378 }
1379
1380 /* \brief Hash function for pvt cause code frames */
1381 static int pvt_cause_hash_fn(const void *vpc, const int flags)
1382 {
1383         const struct ast_control_pvt_cause_code *pc = vpc;
1384         return ast_str_hash(ast_tech_to_upper(ast_strdupa(pc->chan_name)));
1385 }
1386
1387 /* \brief Comparison function for pvt cause code frames */
1388 static int pvt_cause_cmp_fn(void *obj, void *vstr, int flags)
1389 {
1390         struct ast_control_pvt_cause_code *pc = obj;
1391         char *str = ast_tech_to_upper(ast_strdupa(vstr));
1392         char *pc_str = ast_tech_to_upper(ast_strdupa(pc->chan_name));
1393         return !strcmp(pc_str, str) ? CMP_MATCH | CMP_STOP : 0;
1394 }
1395
1396 #define DIALED_CAUSES_BUCKETS 37
1397
1398 struct ast_channel *__ast_channel_internal_alloc(void (*destructor)(void *obj), const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *file, int line, const char *function)
1399 {
1400         struct ast_channel *tmp;
1401 #if defined(REF_DEBUG)
1402         tmp = __ao2_alloc_debug(sizeof(*tmp), destructor,
1403                 AO2_ALLOC_OPT_LOCK_MUTEX, "", file, line, function, 1);
1404 #elif defined(__AST_DEBUG_MALLOC)
1405         tmp = __ao2_alloc_debug(sizeof(*tmp), destructor,
1406                 AO2_ALLOC_OPT_LOCK_MUTEX, "", file, line, function, 0);
1407 #else
1408         tmp = ao2_alloc(sizeof(*tmp), destructor);
1409 #endif
1410
1411         if ((ast_string_field_init(tmp, 128))) {
1412                 return ast_channel_unref(tmp);
1413         }
1414
1415         if (!(tmp->dialed_causes = ao2_container_alloc(DIALED_CAUSES_BUCKETS, pvt_cause_hash_fn, pvt_cause_cmp_fn))) {
1416                 return ast_channel_unref(tmp);
1417         }
1418
1419         /* set the creation time in the uniqueid */
1420         tmp->uniqueid.creation_time = time(NULL);
1421         tmp->uniqueid.creation_unique = ast_atomic_fetchadd_int(&uniqueint, 1);
1422
1423         /* use provided id or default to historical {system-}time.# format */
1424         if (assignedids && !ast_strlen_zero(assignedids->uniqueid)) {
1425                 ast_copy_string(tmp->uniqueid.unique_id, assignedids->uniqueid, sizeof(tmp->uniqueid.unique_id));
1426         } else if (ast_strlen_zero(ast_config_AST_SYSTEM_NAME)) {
1427                 snprintf(tmp->uniqueid.unique_id, sizeof(tmp->uniqueid.unique_id), "%li.%d",
1428                         (long)(tmp->uniqueid.creation_time),
1429                         tmp->uniqueid.creation_unique);
1430         } else {
1431                 snprintf(tmp->uniqueid.unique_id, sizeof(tmp->uniqueid.unique_id), "%s-%li.%d",
1432                         ast_config_AST_SYSTEM_NAME,
1433                         (long)(tmp->uniqueid.creation_time),
1434                         tmp->uniqueid.creation_unique);
1435         }
1436
1437         /* copy linked id from parent channel if known */
1438         if (requestor) {
1439                 tmp->linkedid = requestor->linkedid;
1440         } else {
1441                 tmp->linkedid = tmp->uniqueid;
1442         }
1443
1444         return tmp;
1445 }
1446
1447 struct ast_channel *ast_channel_internal_oldest_linkedid(struct ast_channel *a, struct ast_channel *b)
1448 {
1449         ast_assert(a->linkedid.creation_time != 0);
1450         ast_assert(b->linkedid.creation_time != 0);
1451
1452         if (a->linkedid.creation_time < b->linkedid.creation_time) {
1453                 return a;
1454         }
1455         if (b->linkedid.creation_time < a->linkedid.creation_time) {
1456                 return b;
1457         }
1458         if (a->linkedid.creation_unique < b->linkedid.creation_unique) {
1459                 return a;
1460         }
1461         return b;
1462 }
1463
1464 void ast_channel_internal_copy_linkedid(struct ast_channel *dest, struct ast_channel *source)
1465 {
1466         if (dest->linkedid.creation_time == source->linkedid.creation_time
1467                 && dest->linkedid.creation_unique == source->linkedid.creation_unique
1468                 && !strcmp(dest->linkedid.unique_id, source->linkedid.unique_id)) {
1469                 return;
1470         }
1471         dest->linkedid = source->linkedid;
1472         ast_channel_publish_snapshot(dest);
1473 }
1474
1475 void ast_channel_internal_swap_uniqueid_and_linkedid(struct ast_channel *a, struct ast_channel *b)
1476 {
1477         struct ast_channel_id temp;
1478
1479         temp = a->uniqueid;
1480         a->uniqueid = b->uniqueid;
1481         b->uniqueid = temp;
1482
1483         temp = a->linkedid;
1484         a->linkedid = b->linkedid;
1485         b->linkedid = temp;
1486 }
1487
1488 void ast_channel_internal_set_fake_ids(struct ast_channel *chan, const char *uniqueid, const char *linkedid)
1489 {
1490         ast_copy_string(chan->uniqueid.unique_id, uniqueid, sizeof(chan->uniqueid.unique_id));
1491         ast_copy_string(chan->linkedid.unique_id, linkedid, sizeof(chan->linkedid.unique_id));
1492 }
1493
1494 void ast_channel_internal_cleanup(struct ast_channel *chan)
1495 {
1496         if (chan->dialed_causes) {
1497                 ao2_t_ref(chan->dialed_causes, -1,
1498                         "done with dialed causes since the channel is going away");
1499                 chan->dialed_causes = NULL;
1500         }
1501
1502         ast_string_field_free_memory(chan);
1503
1504         chan->endpoint_forward = stasis_forward_cancel(chan->endpoint_forward);
1505
1506         stasis_cp_single_unsubscribe(chan->topics);
1507         chan->topics = NULL;
1508 }
1509
1510 void ast_channel_internal_finalize(struct ast_channel *chan)
1511 {
1512         chan->finalized = 1;
1513 }
1514
1515 int ast_channel_internal_is_finalized(struct ast_channel *chan)
1516 {
1517         return chan->finalized;
1518 }
1519
1520 struct stasis_topic *ast_channel_topic(struct ast_channel *chan)
1521 {
1522         if (!chan) {
1523                 return ast_channel_topic_all();
1524         }
1525
1526         return stasis_cp_single_topic(chan->topics);
1527 }
1528
1529 struct stasis_topic *ast_channel_topic_cached(struct ast_channel *chan)
1530 {
1531         if (!chan) {
1532                 return ast_channel_topic_all_cached();
1533         }
1534
1535         return stasis_cp_single_topic_cached(chan->topics);
1536 }
1537
1538 int ast_channel_forward_endpoint(struct ast_channel *chan,
1539         struct ast_endpoint *endpoint)
1540 {
1541         ast_assert(chan != NULL);
1542         ast_assert(endpoint != NULL);
1543
1544         chan->endpoint_forward =
1545                 stasis_forward_all(ast_channel_topic(chan),
1546                         ast_endpoint_topic(endpoint));
1547
1548         if (chan->endpoint_forward == NULL) {
1549                 return -1;
1550         }
1551
1552         return 0;
1553 }
1554
1555 int ast_channel_internal_setup_topics(struct ast_channel *chan)
1556 {
1557         const char *topic_name = chan->uniqueid.unique_id;
1558         ast_assert(chan->topics == NULL);
1559
1560         if (ast_strlen_zero(topic_name)) {
1561                 topic_name = "<dummy-channel>";
1562         }
1563
1564         chan->topics = stasis_cp_single_create(
1565                 ast_channel_cache_all(), topic_name);
1566         if (!chan->topics) {
1567                 return -1;
1568         }
1569
1570         return 0;
1571 }