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