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