2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2006, Digium, Inc.
6 * Mark Spencer <markster@digium.com>
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.
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.
21 * \brief Implementation of Inter-Asterisk eXchange Version 2
22 * as specified in RFC 5456
24 * \author Mark Spencer <markster@digium.com>
27 * \arg \ref Config_iax
29 * \ingroup channel_drivers
31 * \todo Implement musicclass settings for IAX2 devices
34 /*! \li \ref chan_iax2.c uses the configuration file \ref iax.conf
35 * \addtogroup configuration_file
38 /*! \page iax.conf iax.conf
39 * \verbinclude iax.conf.sample
43 * \todo XXX The IAX2 channel driver needs its native bridge
44 * code converted to the new bridge technology scheme.
46 * \note The chan_dahdi native bridge code can be used as an
47 * example. It also appears that chan_iax2 also has a native
48 * transfer check like chan_dahdi to eliminate tromboned calls.
50 * \note The existing native bridge code is marked with the
51 * IAX2_NATIVE_BRIDGING conditional.
55 <use type="external">crypto</use>
56 <support_level>core</support_level>
61 ASTERISK_REGISTER_FILE()
65 #include <sys/socket.h>
66 #include <netinet/in.h>
67 #include <arpa/inet.h>
68 #include <netinet/in_systm.h>
69 #include <netinet/ip.h>
71 #include <sys/signal.h>
79 #include "asterisk/paths.h"
81 #include "asterisk/lock.h"
82 #include "asterisk/frame.h"
83 #include "asterisk/channel.h"
84 #include "asterisk/module.h"
85 #include "asterisk/pbx.h"
86 #include "asterisk/sched.h"
87 #include "asterisk/io.h"
88 #include "asterisk/config.h"
89 #include "asterisk/cli.h"
90 #include "asterisk/translate.h"
91 #include "asterisk/md5.h"
92 #include "asterisk/crypto.h"
93 #include "asterisk/acl.h"
94 #include "asterisk/manager.h"
95 #include "asterisk/callerid.h"
96 #include "asterisk/app.h"
97 #include "asterisk/astdb.h"
98 #include "asterisk/musiconhold.h"
99 #include "asterisk/features.h"
100 #include "asterisk/utils.h"
101 #include "asterisk/causes.h"
102 #include "asterisk/localtime.h"
103 #include "asterisk/dnsmgr.h"
104 #include "asterisk/devicestate.h"
105 #include "asterisk/netsock.h"
106 #include "asterisk/stringfields.h"
107 #include "asterisk/linkedlists.h"
108 #include "asterisk/astobj2.h"
109 #include "asterisk/timing.h"
110 #include "asterisk/taskprocessor.h"
111 #include "asterisk/test.h"
112 #include "asterisk/data.h"
113 #include "asterisk/security_events.h"
114 #include "asterisk/stasis_endpoints.h"
115 #include "asterisk/bridge.h"
116 #include "asterisk/stasis.h"
117 #include "asterisk/stasis_system.h"
118 #include "asterisk/stasis_channels.h"
119 #include "asterisk/format_cache.h"
120 #include "asterisk/format_compatibility.h"
121 #include "asterisk/format_cap.h"
123 #include "iax2/include/iax2.h"
124 #include "iax2/include/firmware.h"
125 #include "iax2/include/parser.h"
126 #include "iax2/include/provision.h"
127 #include "iax2/include/codec_pref.h"
128 #include "iax2/include/format_compatibility.h"
130 #include "jitterbuf.h"
133 <application name="IAX2Provision" language="en_US">
135 Provision a calling IAXy with a given template.
138 <parameter name="template">
139 <para>If not specified, defaults to <literal>default</literal>.</para>
143 <para>Provisions the calling IAXy (assuming the calling entity is in fact an IAXy) with the
144 given <replaceable>template</replaceable>. Returns <literal>-1</literal> on error
145 or <literal>0</literal> on success.</para>
148 <function name="IAXPEER" language="en_US">
150 Gets IAX peer information.
153 <parameter name="peername" required="true">
155 <enum name="CURRENTCHANNEL">
156 <para>If <replaceable>peername</replaceable> is specified to this value, return the IP address of the
157 endpoint of the current channel</para>
161 <parameter name="item">
162 <para>If <replaceable>peername</replaceable> is specified, valid items are:</para>
165 <para>(default) The IP address.</para>
168 <para>The peer's status (if <literal>qualify=yes</literal>)</para>
170 <enum name="mailbox">
171 <para>The configured mailbox.</para>
173 <enum name="context">
174 <para>The configured context.</para>
177 <para>The epoch time of the next expire.</para>
179 <enum name="dynamic">
180 <para>Is it dynamic? (yes/no).</para>
182 <enum name="callerid_name">
183 <para>The configured Caller ID name.</para>
185 <enum name="callerid_num">
186 <para>The configured Caller ID number.</para>
189 <para>The configured codecs.</para>
191 <enum name="codec[x]">
192 <para>Preferred codec index number <replaceable>x</replaceable> (beginning
193 with <literal>0</literal>)</para>
199 <para>Gets information associated with the specified IAX2 peer.</para>
202 <ref type="function">SIPPEER</ref>
205 <function name="IAXVAR" language="en_US">
207 Sets or retrieves a remote variable.
210 <parameter name="varname" required="true" />
213 <para>Gets or sets a variable that is sent to a remote IAX2 peer during call setup.</para>
216 <manager name="IAXpeers" language="en_US">
221 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
226 <manager name="IAXpeerlist" language="en_US">
231 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
234 <para>List all the IAX peers.</para>
237 <manager name="IAXnetstats" language="en_US">
243 <para>Show IAX channels network statistics.</para>
246 <manager name="IAXregistry" language="en_US">
248 Show IAX registrations.
251 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
254 <para>Show IAX registrations.</para>
259 /* Define SCHED_MULTITHREADED to run the scheduler in a special
260 multithreaded mode. */
261 #define SCHED_MULTITHREADED
263 /* Define DEBUG_SCHED_MULTITHREADED to keep track of where each
264 thread is actually doing. */
265 #define DEBUG_SCHED_MULTITHREAD
269 static int nochecksums = 0;
272 #define PTR_TO_CALLNO(a) ((unsigned short)(unsigned long)(a))
273 #define CALLNO_TO_PTR(a) ((void *)(unsigned long)(a))
275 #define DEFAULT_THREAD_COUNT 10
276 #define DEFAULT_MAX_THREAD_COUNT 100
277 #define DEFAULT_RETRY_TIME 1000
278 #define MEMORY_SIZE 100
279 #define DEFAULT_DROP 3
281 #define DEBUG_SUPPORT
283 #define MIN_REUSE_TIME 60 /* Don't reuse a call number within 60 seconds */
285 /* Sample over last 100 units to determine historic jitter */
288 static struct iax2_codec_pref prefs_global;
290 static const char tdesc[] = "Inter Asterisk eXchange Driver (Ver 2)";
293 /*! \brief Maximum transmission unit for the UDP packet in the trunk not to be
294 fragmented. This is based on 1516 - ethernet - ip - udp - iax minus one g711 frame = 1240 */
295 #define MAX_TRUNK_MTU 1240
297 static int global_max_trunk_mtu; /*!< Maximum MTU, 0 if not used */
298 static int trunk_timed, trunk_untimed, trunk_maxmtu, trunk_nmaxmtu ; /*!< Trunk MTU statistics */
300 #define DEFAULT_CONTEXT "default"
302 static char default_parkinglot[AST_MAX_CONTEXT];
304 static char language[MAX_LANGUAGE] = "";
305 static char regcontext[AST_MAX_CONTEXT] = "";
307 static struct stasis_subscription *network_change_sub; /*!< subscription id for network change events */
308 static struct stasis_subscription *acl_change_sub; /*!< subscription id for ACL change events */
309 static int network_change_sched_id = -1;
311 static int maxauthreq = 3;
312 static int max_retries = 4;
313 static int ping_time = 21;
314 static int lagrq_time = 10;
315 static int maxjitterbuffer=1000;
316 static int resyncthreshold=1000;
317 static int maxjitterinterps=10;
318 static int jittertargetextra = 40; /* number of milliseconds the new jitter buffer adds on to its size */
320 #define MAX_TRUNKDATA 640 * 200 /*!< 40ms, uncompressed linear * 200 channels */
322 static int trunkfreq = 20;
323 static int trunkmaxsize = MAX_TRUNKDATA;
325 static int authdebug = 0;
326 static int autokill = 0;
327 static int iaxcompat = 0;
328 static int last_authmethod = 0;
330 static int iaxdefaultdpcache=10 * 60; /* Cache dialplan entries for 10 minutes by default */
332 static int iaxdefaulttimeout = 5; /* Default to wait no more than 5 seconds for a reply to come back */
339 static int min_reg_expire;
340 static int max_reg_expire;
342 static int srvlookup = 0;
344 static struct ast_timer *timer; /* Timer for trunking */
346 static struct ast_netsock_list *netsock;
347 static struct ast_netsock_list *outsock; /*!< used if sourceaddress specified and bindaddr == INADDR_ANY */
348 static int defaultsockfd = -1;
350 static int (*iax2_regfunk)(const char *username, int onoff) = NULL;
353 #define IAX_CAPABILITY_FULLBANDWIDTH 0xFFFF
355 #define IAX_CAPABILITY_MEDBANDWIDTH (IAX_CAPABILITY_FULLBANDWIDTH & \
357 ~AST_FORMAT_SLIN16 & \
358 ~AST_FORMAT_SIREN7 & \
359 ~AST_FORMAT_SIREN14 & \
365 #define IAX_CAPABILITY_LOWBANDWIDTH (IAX_CAPABILITY_MEDBANDWIDTH & \
367 ~AST_FORMAT_G726_AAL2 & \
370 #define IAX_CAPABILITY_LOWFREE (IAX_CAPABILITY_LOWBANDWIDTH & \
374 #define DEFAULT_MAXMS 2000 /* Must be faster than 2 seconds by default */
375 #define DEFAULT_FREQ_OK 60 * 1000 /* How often to check for the host to be up */
376 #define DEFAULT_FREQ_NOTOK 10 * 1000 /* How often to check, if the host is down... */
378 /* if a pvt has encryption setup done and is running on the call */
379 #define IAX_CALLENCRYPTED(pvt) \
380 (ast_test_flag64(pvt, IAX_ENCRYPTED) && ast_test_flag64(pvt, IAX_KEYPOPULATED))
382 #define IAX_DEBUGDIGEST(msg, key) do { \
384 char digest[33] = ""; \
389 for (idx = 0; idx < 16; idx++) \
390 sprintf(digest + (idx << 1), "%02hhx", (unsigned char) key[idx]); \
392 ast_log(LOG_NOTICE, msg " IAX_COMMAND_RTKEY to rotate key to '%s'\n", digest); \
395 static struct io_context *io;
396 static struct ast_sched_context *sched;
398 #define DONT_RESCHEDULE -2
400 static iax2_format iax2_capability = IAX_CAPABILITY_FULLBANDWIDTH;
402 static int iaxdebug = 0;
404 static int iaxtrunkdebug = 0;
406 static int test_losspct = 0;
408 static int test_late = 0;
409 static int test_resync = 0;
410 static int test_jit = 0;
411 static int test_jitpct = 0;
412 #endif /* IAXTESTS */
414 static char accountcode[AST_MAX_ACCOUNT_CODE];
415 static char mohinterpret[MAX_MUSICCLASS];
416 static char mohsuggest[MAX_MUSICCLASS];
417 static int amaflags = 0;
419 static int delayreject = 0;
420 static int iax2_encryption = 0;
422 static struct ast_flags64 globalflags = { 0 };
424 static pthread_t netthreadid = AST_PTHREADT_NULL;
427 IAX_STATE_STARTED = (1 << 0),
428 IAX_STATE_AUTHENTICATED = (1 << 1),
429 IAX_STATE_TBD = (1 << 2),
432 struct iax2_context {
433 char context[AST_MAX_CONTEXT];
434 struct iax2_context *next;
438 #define IAX_HASCALLERID (uint64_t)(1LLU << 0) /*!< CallerID has been specified */
439 #define IAX_DELME (uint64_t)(1LLU << 1) /*!< Needs to be deleted */
440 #define IAX_TEMPONLY (uint64_t)(1LLU << 2) /*!< Temporary (realtime) */
441 #define IAX_TRUNK (uint64_t)(1LLU << 3) /*!< Treat as a trunk */
442 #define IAX_NOTRANSFER (uint64_t)(1LLU << 4) /*!< Don't native bridge */
443 #define IAX_USEJITTERBUF (uint64_t)(1LLU << 5) /*!< Use jitter buffer */
444 #define IAX_DYNAMIC (uint64_t)(1LLU << 6) /*!< dynamic peer */
445 #define IAX_SENDANI (uint64_t)(1LLU << 7) /*!< Send ANI along with CallerID */
446 #define IAX_RTSAVE_SYSNAME (uint64_t)(1LLU << 8) /*!< Save Systname on Realtime Updates */
447 #define IAX_ALREADYGONE (uint64_t)(1LLU << 9) /*!< Already disconnected */
448 #define IAX_PROVISION (uint64_t)(1LLU << 10) /*!< This is a provisioning request */
449 #define IAX_QUELCH (uint64_t)(1LLU << 11) /*!< Whether or not we quelch audio */
450 #define IAX_ENCRYPTED (uint64_t)(1LLU << 12) /*!< Whether we should assume encrypted tx/rx */
451 #define IAX_KEYPOPULATED (uint64_t)(1LLU << 13) /*!< Whether we have a key populated */
452 #define IAX_CODEC_USER_FIRST (uint64_t)(1LLU << 14) /*!< are we willing to let the other guy choose the codec? */
453 #define IAX_CODEC_NOPREFS (uint64_t)(1LLU << 15) /*!< Force old behaviour by turning off prefs */
454 #define IAX_CODEC_NOCAP (uint64_t)(1LLU << 16) /*!< only consider requested format and ignore capabilities*/
455 #define IAX_RTCACHEFRIENDS (uint64_t)(1LLU << 17) /*!< let realtime stay till your reload */
456 #define IAX_RTUPDATE (uint64_t)(1LLU << 18) /*!< Send a realtime update */
457 #define IAX_RTAUTOCLEAR (uint64_t)(1LLU << 19) /*!< erase me on expire */
458 #define IAX_RTIGNOREREGEXPIRE (uint64_t)(1LLU << 21) /*!< When using realtime, ignore registration expiration */
459 #define IAX_TRUNKTIMESTAMPS (uint64_t)(1LLU << 22) /*!< Send trunk timestamps */
460 #define IAX_TRANSFERMEDIA (uint64_t)(1LLU << 23) /*!< When doing IAX2 transfers, transfer media only */
461 #define IAX_MAXAUTHREQ (uint64_t)(1LLU << 24) /*!< Maximum outstanding AUTHREQ restriction is in place */
462 #define IAX_DELAYPBXSTART (uint64_t)(1LLU << 25) /*!< Don't start a PBX on the channel until the peer sends us a response, so that we've achieved a three-way handshake with them before sending voice or anything else */
463 #define IAX_ALLOWFWDOWNLOAD (uint64_t)(1LLU << 26) /*!< Allow the FWDOWNL command? */
464 #define IAX_IMMEDIATE (uint64_t)(1LLU << 27) /*!< Allow immediate off-hook to extension s */
465 #define IAX_SENDCONNECTEDLINE (uint64_t)(1LLU << 28) /*!< Allow sending of connected line updates */
466 #define IAX_RECVCONNECTEDLINE (uint64_t)(1LLU << 29) /*!< Allow receiving of connected line updates */
467 #define IAX_FORCE_ENCRYPT (uint64_t)(1LLU << 30) /*!< Forces call encryption, if encryption not possible hangup */
468 #define IAX_SHRINKCALLERID (uint64_t)(1LLU << 31) /*!< Turn on and off caller id shrinking */
469 static int global_rtautoclear = 120;
471 static int reload_config(int forced_reload);
474 * \brief Call token validation settings.
476 enum calltoken_peer_enum {
477 /*! \brief Default calltoken required unless the ip is in the ignorelist */
478 CALLTOKEN_DEFAULT = 0,
479 /*! \brief Require call token validation. */
481 /*! \brief Require call token validation after a successful registration
482 * using call token validation occurs. */
484 /*! \brief Do not require call token validation. */
489 AST_DECLARE_STRING_FIELDS(
490 AST_STRING_FIELD(name);
491 AST_STRING_FIELD(secret);
492 AST_STRING_FIELD(dbsecret);
493 AST_STRING_FIELD(accountcode);
494 AST_STRING_FIELD(mohinterpret);
495 AST_STRING_FIELD(mohsuggest);
496 AST_STRING_FIELD(inkeys); /*!< Key(s) this user can use to authenticate to us */
497 AST_STRING_FIELD(language);
498 AST_STRING_FIELD(cid_num);
499 AST_STRING_FIELD(cid_name);
500 AST_STRING_FIELD(parkinglot); /*!< Default parkinglot for device */
508 iax2_format capability;
509 int maxauthreq; /*!< Maximum allowed outstanding AUTHREQs */
510 int curauthreq; /*!< Current number of outstanding AUTHREQs */
511 struct iax2_codec_pref prefs;
512 struct ast_acl_list *acl;
513 struct iax2_context *contexts;
514 struct ast_variable *vars;
515 enum calltoken_peer_enum calltoken_required; /*!< Is calltoken validation required or not, can be YES, NO, or AUTO */
519 AST_DECLARE_STRING_FIELDS(
520 AST_STRING_FIELD(name);
521 AST_STRING_FIELD(username);
522 AST_STRING_FIELD(description); /*!< Description of the peer */
523 AST_STRING_FIELD(secret);
524 AST_STRING_FIELD(dbsecret);
525 AST_STRING_FIELD(outkey); /*!< What key we use to talk to this peer */
527 AST_STRING_FIELD(regexten); /*!< Extension to register (if regcontext is used) */
528 AST_STRING_FIELD(context); /*!< For transfers only */
529 AST_STRING_FIELD(peercontext); /*!< Context to pass to peer */
530 AST_STRING_FIELD(mailbox); /*!< Mailbox */
531 AST_STRING_FIELD(mohinterpret);
532 AST_STRING_FIELD(mohsuggest);
533 AST_STRING_FIELD(inkeys); /*!< Key(s) this peer can use to authenticate to us */
534 /* Suggested caller id if registering */
535 AST_STRING_FIELD(cid_num); /*!< Default context (for transfer really) */
536 AST_STRING_FIELD(cid_name); /*!< Default context (for transfer really) */
537 AST_STRING_FIELD(zonetag); /*!< Time Zone */
538 AST_STRING_FIELD(parkinglot); /*!< Default parkinglot for device */
540 struct iax2_codec_pref prefs;
541 struct ast_dnsmgr_entry *dnsmgr; /*!< DNS refresh manager */
542 struct ast_sockaddr addr;
544 int sockfd; /*!< Socket to use for transmission */
545 struct ast_sockaddr mask;
549 /* Dynamic Registration fields */
550 struct ast_sockaddr defaddr; /*!< Default address if there is one */
551 int authmethods; /*!< Authentication methods (IAX_AUTH_*) */
552 int encmethods; /*!< Encryption methods (IAX_ENCRYPT_*) */
554 int expire; /*!< Schedule entry for expiry */
555 int expiry; /*!< How soon to expire */
556 iax2_format capability; /*!< Capability */
559 int callno; /*!< Call number of POKE request */
560 int pokeexpire; /*!< Scheduled qualification-related task (ie iax2_poke_peer_s or iax2_poke_noanswer) */
561 int lastms; /*!< How long last response took (in ms), or -1 for no response */
562 int maxms; /*!< Max ms we will accept for the host to be up, 0 to not monitor */
564 int pokefreqok; /*!< How often to check if the host is up */
565 int pokefreqnotok; /*!< How often to check when the host has been determined to be down */
566 int historicms; /*!< How long recent average responses took */
567 int smoothing; /*!< Sample over how many units to determine historic ms */
568 uint16_t maxcallno; /*!< Max call number limit for this peer. Set on registration */
570 struct stasis_subscription *mwi_event_sub; /*!< This subscription lets pollmailboxes know which mailboxes need to be polled */
572 struct ast_acl_list *acl;
573 enum calltoken_peer_enum calltoken_required; /*!< Is calltoken validation required or not, can be YES, NO, or AUTO */
575 struct ast_endpoint *endpoint; /*!< Endpoint structure for this peer */
578 #define IAX2_TRUNK_PREFACE (sizeof(struct iax_frame) + sizeof(struct ast_iax2_meta_hdr) + sizeof(struct ast_iax2_meta_trunk_hdr))
580 struct iax2_trunk_peer {
583 struct ast_sockaddr addr;
584 struct timeval txtrunktime; /*!< Transmit trunktime */
585 struct timeval rxtrunktime; /*!< Receive trunktime */
586 struct timeval lasttxtime; /*!< Last transmitted trunktime */
587 struct timeval trunkact; /*!< Last trunk activity */
588 unsigned int lastsent; /*!< Last sent time */
589 /* Trunk data and length */
590 unsigned char *trunkdata;
591 unsigned int trunkdatalen;
592 unsigned int trunkdataalloc;
596 AST_LIST_ENTRY(iax2_trunk_peer) list;
599 static AST_LIST_HEAD_STATIC(tpeers, iax2_trunk_peer);
602 REG_STATE_UNREGISTERED = 0,
605 REG_STATE_REGISTERED,
611 enum iax_transfer_state {
616 TRANSFER_PASSTHROUGH,
620 TRANSFER_MPASSTHROUGH,
625 struct iax2_registry {
626 struct ast_sockaddr addr; /*!< Who we connect to for registration purposes */
628 char secret[80]; /*!< Password or key name in []'s */
629 int expire; /*!< Sched ID of expiration */
630 int refresh; /*!< How often to refresh */
631 enum iax_reg_state regstate;
632 int messages; /*!< Message count, low 8 bits = new, high 8 bits = old */
633 int callno; /*!< Associated call number if applicable */
634 struct ast_sockaddr us; /*!< Who the server thinks we are */
635 struct ast_dnsmgr_entry *dnsmgr; /*!< DNS refresh manager */
636 AST_LIST_ENTRY(iax2_registry) entry;
641 static AST_LIST_HEAD_STATIC(registrations, iax2_registry);
643 /* Don't retry more frequently than every 10 ms, or less frequently than every 5 seconds */
644 #define MIN_RETRY_TIME 100
645 #define MAX_RETRY_TIME 10000
647 #define MAX_JITTER_BUFFER 50
648 #define MIN_JITTER_BUFFER 10
650 #define DEFAULT_TRUNKDATA 640 * 10 /*!< 40ms, uncompressed linear * 10 channels */
652 #define MAX_TIMESTAMP_SKEW 160 /*!< maximum difference between actual and predicted ts for sending */
654 /* If consecutive voice frame timestamps jump by more than this many milliseconds, then jitter buffer will resync */
655 #define TS_GAP_FOR_JB_RESYNC 5000
657 /* used for first_iax_message and last_iax_message. If this bit is set it was TX, else RX */
658 #define MARK_IAX_SUBCLASS_TX 0x8000
660 static int iaxthreadcount = DEFAULT_THREAD_COUNT;
661 static int iaxmaxthreadcount = DEFAULT_MAX_THREAD_COUNT;
662 static int iaxdynamicthreadcount = 0;
663 static int iaxdynamicthreadnum = 0;
664 static int iaxactivethreadcount = 0;
678 /* We use the high order bit as the validated flag, and the lower 15 as the
679 * actual call number */
680 typedef uint16_t callno_entry;
682 struct chan_iax2_pvt {
683 /*! Socket to send/receive on for this call */
685 /*! ast_callid bound to dialog */
687 /*! Last received voice format */
688 iax2_format voiceformat;
689 /*! Last received video format */
690 iax2_format videoformat;
691 /*! Last sent voice format */
692 iax2_format svoiceformat;
693 /*! Last sent video format */
694 iax2_format svideoformat;
695 /*! What we are capable of sending */
696 iax2_format capability;
697 /*! Last received timestamp */
699 /*! Last sent timestamp - never send the same timestamp twice in a single call */
700 unsigned int lastsent;
701 /*! Timestamp of the last video frame sent */
702 unsigned int lastvsent;
703 /*! Next outgoing timestamp if everything is good */
704 unsigned int nextpred;
705 /*! iax frame subclass that began iax2_pvt entry. 0x8000 bit is set on TX */
706 int first_iax_message;
707 /*! Last iax frame subclass sent or received for a iax2_pvt. 0x8000 bit is set on TX */
708 int last_iax_message;
709 /*! True if the last voice we transmitted was not silence/CNG */
710 unsigned int notsilenttx:1;
712 unsigned int pingtime;
713 /*! Max time for initial response */
716 struct ast_sockaddr addr;
717 /*! Actual used codec preferences */
718 struct iax2_codec_pref prefs;
719 /*! Requested codec preferences */
720 struct iax2_codec_pref rprefs;
721 /*! Our call number */
722 unsigned short callno;
723 /*! Our callno_entry entry */
724 callno_entry callno_entry;
726 unsigned short peercallno;
727 /*! Negotiated format, this is only used to remember what format was
728 chosen for an unauthenticated call so that the channel can get
729 created later using the right format */
730 iax2_format chosenformat;
731 /*! Peer selected format */
732 iax2_format peerformat;
733 /*! Peer capability */
734 iax2_format peercapability;
735 /*! timeval that we base our transmission on */
736 struct timeval offset;
737 /*! timeval that we base our delivery on */
738 struct timeval rxcore;
739 /*! The jitterbuffer */
741 /*! active jb read scheduler id */
745 /*! Error, as discovered by the manager */
747 /*! Owner if we have one */
748 struct ast_channel *owner;
749 /*! What's our state? */
750 struct ast_flags state;
751 /*! Expiry (optional) */
753 /*! Next outgoing sequence number */
754 unsigned char oseqno;
755 /*! Next sequence number they have not yet acknowledged */
756 unsigned char rseqno;
757 /*! Next incoming sequence number */
758 unsigned char iseqno;
759 /*! Last incoming sequence number we have acknowledged */
760 unsigned char aseqno;
762 AST_DECLARE_STRING_FIELDS(
764 AST_STRING_FIELD(peer);
765 /*! Default Context */
766 AST_STRING_FIELD(context);
767 /*! Caller ID if available */
768 AST_STRING_FIELD(cid_num);
769 AST_STRING_FIELD(cid_name);
770 /*! Hidden Caller ID (i.e. ANI) if appropriate */
771 AST_STRING_FIELD(ani);
773 AST_STRING_FIELD(dnid);
775 AST_STRING_FIELD(rdnis);
776 /*! Requested Extension */
777 AST_STRING_FIELD(exten);
778 /*! Expected Username */
779 AST_STRING_FIELD(username);
780 /*! Expected Secret */
781 AST_STRING_FIELD(secret);
783 AST_STRING_FIELD(challenge);
784 /*! Public keys permitted keys for incoming authentication */
785 AST_STRING_FIELD(inkeys);
786 /*! Private key for outgoing authentication */
787 AST_STRING_FIELD(outkey);
788 /*! Preferred language */
789 AST_STRING_FIELD(language);
790 /*! Hostname/peername for naming purposes */
791 AST_STRING_FIELD(host);
793 AST_STRING_FIELD(dproot);
794 AST_STRING_FIELD(accountcode);
795 AST_STRING_FIELD(mohinterpret);
796 AST_STRING_FIELD(mohsuggest);
797 /*! received OSP token */
798 AST_STRING_FIELD(osptoken);
799 /*! Default parkinglot */
800 AST_STRING_FIELD(parkinglot);
802 /*! AUTHREJ all AUTHREP frames */
804 /*! permitted authentication methods */
806 /*! permitted encryption methods */
808 /*! Encryption AES-128 Key */
809 ast_aes_encrypt_key ecx;
810 /*! Decryption AES-128 Key corresponding to ecx */
811 ast_aes_decrypt_key mydcx;
812 /*! Decryption AES-128 Key used to decrypt peer frames */
813 ast_aes_decrypt_key dcx;
814 /*! scheduler id associated with iax_key_rotate
815 * for encrypted calls*/
817 /*! 32 bytes of semi-random data */
818 unsigned char semirand[32];
819 /*! Associated registry */
820 struct iax2_registry *reg;
821 /*! Associated peer for poking */
822 struct iax2_peer *peerpoke;
827 /*! Transferring status */
828 enum iax_transfer_state transferring;
829 /*! Transfer identifier */
831 /*! Who we are IAX transferring to */
832 struct ast_sockaddr transfer;
833 /*! What's the new call number for the transfer */
834 unsigned short transfercallno;
835 /*! Transfer encrypt AES-128 Key */
836 ast_aes_encrypt_key tdcx;
838 /*! Status of knowledge of peer ADSI capability */
841 /*! Callno of native bridge peer. (Valid if nonzero) */
842 unsigned short bridgecallno;
844 int pingid; /*!< Transmit PING request */
845 int lagid; /*!< Retransmit lag request */
846 int autoid; /*!< Auto hangup for Dialplan requestor */
847 int authid; /*!< Authentication rejection ID */
848 int authfail; /*!< Reason to report failure */
849 int initid; /*!< Initial peer auto-congest ID (based on qualified peers) */
854 AST_LIST_HEAD_NOLOCK(, iax2_dpcache) dpentries;
855 /*! variables inherited from the user definition */
856 struct ast_variable *vars;
857 /*! variables transmitted in a NEW packet */
858 struct ast_variable *iaxvars;
859 /*! last received remote rr */
860 struct iax_rr remote_rr;
861 /*! Current base time: (just for stats) */
863 /*! Dropped frame count: (just for stats) */
865 /*! received frame count: (just for stats) */
867 /*! num bytes used for calltoken ie, even an empty ie should contain 2 */
868 unsigned char calltoken_ie_len;
869 /*! hold all signaling frames from the pbx thread until we have a destination callno */
871 /*! frame queue for signaling frames from pbx thread waiting for destination callno */
872 AST_LIST_HEAD_NOLOCK(signaling_queue, signaling_queue_entry) signaling_queue;
875 struct signaling_queue_entry {
877 AST_LIST_ENTRY(signaling_queue_entry) next;
885 #define PTR_TO_CALLNO_ENTRY(a) ((uint16_t)(unsigned long)(a))
886 #define CALLNO_ENTRY_TO_PTR(a) ((void *)(unsigned long)(a))
888 #define CALLNO_ENTRY_SET_VALIDATED(a) ((a) |= 0x8000)
889 #define CALLNO_ENTRY_IS_VALIDATED(a) ((a) & 0x8000)
890 #define CALLNO_ENTRY_GET_CALLNO(a) ((a) & 0x7FFF)
892 struct call_number_pool {
895 callno_entry numbers[IAX_MAX_CALLS / 2 + 1];
898 AST_MUTEX_DEFINE_STATIC(callno_pool_lock);
900 /*! table of available call numbers */
901 static struct call_number_pool callno_pool;
903 /*! table of available trunk call numbers */
904 static struct call_number_pool callno_pool_trunk;
907 * \brief a list of frames that may need to be retransmitted
909 * \note The contents of this list do not need to be explicitly destroyed
910 * on module unload. This is because all active calls are destroyed, and
911 * all frames in this queue will get destroyed as a part of that process.
913 * \note Contents protected by the iaxsl[] locks
915 static AST_LIST_HEAD_NOLOCK(, iax_frame) frame_queue[IAX_MAX_CALLS];
917 static struct ast_taskprocessor *transmit_processor;
919 static int randomcalltokendata;
921 static time_t max_calltoken_delay = 10;
924 * This module will get much higher performance when doing a lot of
925 * user and peer lookups if the number of buckets is increased from 1.
926 * However, to maintain old behavior for Asterisk 1.4, these are set to
927 * 1 by default. When using multiple buckets, search order through these
928 * containers is considered random, so you will not be able to depend on
929 * the order the entires are specified in iax.conf for matching order. */
931 #define MAX_PEER_BUCKETS 17
933 #define MAX_PEER_BUCKETS 563
935 static struct ao2_container *peers;
937 #define MAX_USER_BUCKETS MAX_PEER_BUCKETS
938 static struct ao2_container *users;
940 /*! Table containing peercnt objects for every ip address consuming a callno */
941 static struct ao2_container *peercnts;
943 /*! Table containing custom callno limit rules for a range of ip addresses. */
944 static struct ao2_container *callno_limits;
946 /*! Table containing ip addresses not requiring calltoken validation */
947 static struct ao2_container *calltoken_ignores;
949 static uint16_t DEFAULT_MAXCALLNO_LIMIT = 2048;
951 static uint16_t DEFAULT_MAXCALLNO_LIMIT_NONVAL = 8192;
953 static uint16_t global_maxcallno;
955 /*! Total num of call numbers allowed to be allocated without calltoken validation */
956 static uint16_t global_maxcallno_nonval;
958 static uint16_t total_nonval_callno_used = 0;
960 /*! peer connection private, keeps track of all the call numbers
961 * consumed by a single ip address */
963 /*! ip address consuming call numbers */
964 struct ast_sockaddr addr;
965 /*! Number of call numbers currently used by this ip address */
967 /*! Max call numbers allowed for this ip address */
969 /*! Specifies whether limit is set by a registration or not, if so normal
970 * limit setting rules do not apply to this address. */
974 /*! used by both callno_limits and calltoken_ignores containers */
976 /*! ip address range for custom callno limit rule */
978 /*! callno limit for this ip address range, only used in callno_limits container */
980 /*! delete me marker for reloads */
985 /*! Extension exists */
986 CACHE_FLAG_EXISTS = (1 << 0),
987 /*! Extension is nonexistent */
988 CACHE_FLAG_NONEXISTENT = (1 << 1),
989 /*! Extension can exist */
990 CACHE_FLAG_CANEXIST = (1 << 2),
991 /*! Waiting to hear back response */
992 CACHE_FLAG_PENDING = (1 << 3),
994 CACHE_FLAG_TIMEOUT = (1 << 4),
995 /*! Request transmitted */
996 CACHE_FLAG_TRANSMITTED = (1 << 5),
998 CACHE_FLAG_UNKNOWN = (1 << 6),
1000 CACHE_FLAG_MATCHMORE = (1 << 7),
1003 struct iax2_dpcache {
1004 char peercontext[AST_MAX_CONTEXT];
1005 char exten[AST_MAX_EXTENSION];
1006 struct timeval orig;
1007 struct timeval expiry;
1009 unsigned short callno;
1011 AST_LIST_ENTRY(iax2_dpcache) cache_list;
1012 AST_LIST_ENTRY(iax2_dpcache) peer_list;
1015 static AST_LIST_HEAD_STATIC(dpcache, iax2_dpcache);
1017 static void reg_source_db(struct iax2_peer *p);
1018 static struct iax2_peer *realtime_peer(const char *peername, struct ast_sockaddr *addr);
1019 static struct iax2_user *realtime_user(const char *username, struct ast_sockaddr *addr);
1021 static int ast_cli_netstats(struct mansession *s, int fd, int limit_fmt);
1022 static char *complete_iax2_peers(const char *line, const char *word, int pos, int state, uint64_t flags);
1023 static char *complete_iax2_unregister(const char *line, const char *word, int pos, int state);
1025 enum iax2_thread_iostate {
1028 IAX_IOSTATE_PROCESSING,
1029 IAX_IOSTATE_SCHEDREADY,
1032 enum iax2_thread_type {
1033 IAX_THREAD_TYPE_POOL,
1034 IAX_THREAD_TYPE_DYNAMIC,
1037 struct iax2_pkt_buf {
1038 AST_LIST_ENTRY(iax2_pkt_buf) entry;
1040 unsigned char buf[1];
1043 struct iax2_thread {
1044 AST_LIST_ENTRY(iax2_thread) list;
1045 enum iax2_thread_type type;
1046 enum iax2_thread_iostate iostate;
1047 #ifdef SCHED_MULTITHREADED
1048 void (*schedfunc)(const void *);
1049 const void *scheddata;
1051 #ifdef DEBUG_SCHED_MULTITHREAD
1057 struct ast_sockaddr ioaddr;
1058 unsigned char readbuf[4096];
1066 ast_mutex_t init_lock;
1067 ast_cond_t init_cond;
1068 /*! if this thread is processing a full frame,
1069 some information about that frame will be stored
1070 here, so we can avoid dispatching any more full
1071 frames for that callno to other threads */
1073 unsigned short callno;
1074 struct ast_sockaddr addr;
1078 /*! Queued up full frames for processing. If more full frames arrive for
1079 * a call which this thread is already processing a full frame for, they
1080 * are queued up here. */
1081 AST_LIST_HEAD_NOLOCK(, iax2_pkt_buf) full_frames;
1086 static AST_LIST_HEAD_STATIC(idle_list, iax2_thread);
1087 static AST_LIST_HEAD_STATIC(active_list, iax2_thread);
1088 static AST_LIST_HEAD_STATIC(dynamic_list, iax2_thread);
1090 static void *iax2_process_thread(void *data);
1091 static void iax2_destroy(int callno);
1093 static void signal_condition(ast_mutex_t *lock, ast_cond_t *cond)
1095 ast_mutex_lock(lock);
1096 ast_cond_signal(cond);
1097 ast_mutex_unlock(lock);
1101 * \brief an array of iax2 pvt structures
1103 * The container for active chan_iax2_pvt structures is implemented as an
1104 * array for extremely quick direct access to the correct pvt structure
1105 * based on the local call number. The local call number is used as the
1106 * index into the array where the associated pvt structure is stored.
1108 static struct chan_iax2_pvt *iaxs[IAX_MAX_CALLS];
1110 static ast_callid iax_pvt_callid_get(int callno)
1112 return iaxs[callno]->callid;
1115 static void iax_pvt_callid_set(int callno, ast_callid callid)
1117 iaxs[callno]->callid = callid;
1120 static void iax_pvt_callid_new(int callno)
1122 ast_callid callid = ast_create_callid();
1123 char buffer[AST_CALLID_BUFFER_LENGTH];
1124 ast_callid_strnprint(buffer, sizeof(buffer), callid);
1125 iax_pvt_callid_set(callno, callid);
1129 * \brief Another container of iax2_pvt structures
1131 * Active IAX2 pvt structs are also stored in this container, if they are a part
1132 * of an active call where we know the remote side's call number. The reason
1133 * for this is that incoming media frames do not contain our call number. So,
1134 * instead of having to iterate the entire iaxs array, we use this container to
1135 * look up calls where the remote side is using a given call number.
1137 static struct ao2_container *iax_peercallno_pvts;
1140 * \brief chan_iax2_pvt structure locks
1142 * These locks are used when accessing a pvt structure in the iaxs array.
1143 * The index used here is the same as used in the iaxs array. It is the
1144 * local call number for the associated pvt struct.
1146 static ast_mutex_t iaxsl[ARRAY_LEN(iaxs)];
1149 * * \brief Another container of iax2_pvt structures
1151 * Active IAX2 pvt stucts used during transfering a call are stored here.
1153 static struct ao2_container *iax_transfercallno_pvts;
1155 /* Flag to use with trunk calls, keeping these calls high up. It halves our effective use
1156 but keeps the division between trunked and non-trunked better. */
1157 #define TRUNK_CALL_START (IAX_MAX_CALLS / 2)
1159 /* Debug routines... */
1160 static struct ast_sockaddr debugaddr;
1162 static void iax_outputframe(struct iax_frame *f, struct ast_iax2_full_hdr *fhi, int rx, struct ast_sockaddr *addr, int datalen)
1165 (addr && !ast_sockaddr_isnull(&debugaddr) &&
1166 (!ast_sockaddr_port(&debugaddr) ||
1167 ast_sockaddr_port(&debugaddr) == ast_sockaddr_port(addr)) &&
1168 !ast_sockaddr_cmp_addr(&debugaddr, addr))) {
1171 iax_showframe(f, fhi, rx, addr, datalen);
1174 iax_showframe(f, fhi, rx, addr, datalen);
1180 static void iax_debug_output(const char *data)
1183 ast_verbose("%s", data);
1186 static void iax_error_output(const char *data)
1188 ast_log(LOG_WARNING, "%s", data);
1191 static void __attribute__((format(printf, 1, 2))) jb_error_output(const char *fmt, ...)
1196 va_start(args, fmt);
1197 vsnprintf(buf, sizeof(buf), fmt, args);
1200 ast_log(LOG_ERROR, "%s", buf);
1203 static void __attribute__((format(printf, 1, 2))) jb_warning_output(const char *fmt, ...)
1208 va_start(args, fmt);
1209 vsnprintf(buf, sizeof(buf), fmt, args);
1212 ast_log(LOG_WARNING, "%s", buf);
1215 static void __attribute__((format(printf, 1, 2))) jb_debug_output(const char *fmt, ...)
1220 va_start(args, fmt);
1221 vsnprintf(buf, sizeof(buf), fmt, args);
1224 ast_verbose("%s", buf);
1227 static int expire_registry(const void *data);
1228 static int iax2_answer(struct ast_channel *c);
1229 static int iax2_call(struct ast_channel *c, const char *dest, int timeout);
1230 static int iax2_devicestate(const char *data);
1231 static int iax2_digit_begin(struct ast_channel *c, char digit);
1232 static int iax2_digit_end(struct ast_channel *c, char digit, unsigned int duration);
1233 static int iax2_do_register(struct iax2_registry *reg);
1234 static int iax2_fixup(struct ast_channel *oldchannel, struct ast_channel *newchan);
1235 static int iax2_hangup(struct ast_channel *c);
1236 static int iax2_indicate(struct ast_channel *c, int condition, const void *data, size_t datalen);
1237 static int iax2_poke_peer(struct iax2_peer *peer, int heldcall);
1238 static int iax2_provision(struct ast_sockaddr *end, int sockfd, const char *dest, const char *template, int force);
1239 static int iax2_send(struct chan_iax2_pvt *pvt, struct ast_frame *f, unsigned int ts, int seqno, int now, int transfer, int final);
1240 static int iax2_sendhtml(struct ast_channel *c, int subclass, const char *data, int datalen);
1241 static int iax2_sendimage(struct ast_channel *c, struct ast_frame *img);
1242 static int iax2_sendtext(struct ast_channel *c, const char *text);
1243 static int iax2_setoption(struct ast_channel *c, int option, void *data, int datalen);
1244 static int iax2_queryoption(struct ast_channel *c, int option, void *data, int *datalen);
1245 static int iax2_transfer(struct ast_channel *c, const char *dest);
1246 static int iax2_write(struct ast_channel *c, struct ast_frame *f);
1247 static int iax2_sched_add(struct ast_sched_context *sched, int when, ast_sched_cb callback, const void *data);
1249 static int send_trunk(struct iax2_trunk_peer *tpeer, struct timeval *now);
1250 static int send_command(struct chan_iax2_pvt *, char, int, unsigned int, const unsigned char *, int, int);
1251 static int send_command_final(struct chan_iax2_pvt *, char, int, unsigned int, const unsigned char *, int, int);
1252 static int send_command_immediate(struct chan_iax2_pvt *, char, int, unsigned int, const unsigned char *, int, int);
1253 static int send_command_locked(unsigned short callno, char, int, unsigned int, const unsigned char *, int, int);
1254 static int send_command_transfer(struct chan_iax2_pvt *, char, int, unsigned int, const unsigned char *, int);
1255 static struct ast_channel *iax2_request(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *data, int *cause);
1256 static struct ast_frame *iax2_read(struct ast_channel *c);
1257 static struct iax2_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int temponly);
1258 static struct iax2_user *build_user(const char *name, struct ast_variable *v, struct ast_variable *alt, int temponly);
1259 static void realtime_update_peer(const char *peername, struct ast_sockaddr *sockaddr, time_t regtime);
1260 static void *iax2_dup_variable_datastore(void *);
1261 static void prune_peers(void);
1262 static void prune_users(void);
1263 static void iax2_free_variable_datastore(void *);
1265 static int acf_channel_read(struct ast_channel *chan, const char *funcname, char *preparse, char *buf, size_t buflen);
1266 static int decode_frame(ast_aes_decrypt_key *dcx, struct ast_iax2_full_hdr *fh, struct ast_frame *f, int *datalen);
1267 static int encrypt_frame(ast_aes_encrypt_key *ecx, struct ast_iax2_full_hdr *fh, unsigned char *poo, int *datalen);
1268 static void build_ecx_key(const unsigned char *digest, struct chan_iax2_pvt *pvt);
1269 static void build_rand_pad(unsigned char *buf, ssize_t len);
1270 static int get_unused_callno(enum callno_type type, int validated, callno_entry *entry);
1271 static int replace_callno(const void *obj);
1272 static void sched_delay_remove(struct ast_sockaddr *addr, callno_entry entry);
1273 static void network_change_stasis_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message);
1274 static void acl_change_stasis_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message);
1276 static struct ast_channel_tech iax2_tech = {
1278 .description = tdesc,
1279 .properties = AST_CHAN_TP_WANTSJITTER,
1280 .requester = iax2_request,
1281 .devicestate = iax2_devicestate,
1282 .send_digit_begin = iax2_digit_begin,
1283 .send_digit_end = iax2_digit_end,
1284 .send_text = iax2_sendtext,
1285 .send_image = iax2_sendimage,
1286 .send_html = iax2_sendhtml,
1288 .hangup = iax2_hangup,
1289 .answer = iax2_answer,
1291 .write = iax2_write,
1292 .write_video = iax2_write,
1293 .indicate = iax2_indicate,
1294 .setoption = iax2_setoption,
1295 .queryoption = iax2_queryoption,
1296 .transfer = iax2_transfer,
1297 .fixup = iax2_fixup,
1298 .func_channel_read = acf_channel_read,
1303 * \brief Obtain the owner channel lock if the owner exists.
1305 * \param callno IAX2 call id.
1307 * \note Assumes the iaxsl[callno] lock is already obtained.
1310 * IMPORTANT NOTE!!! Any time this function is used, even if
1311 * iaxs[callno] was valid before calling it, it may no longer be
1312 * valid after calling it. This function may unlock and lock
1313 * the mutex associated with this callno, meaning that another
1314 * thread may grab it and destroy the call.
1318 static void iax2_lock_owner(int callno)
1321 if (!iaxs[callno] || !iaxs[callno]->owner) {
1322 /* There is no owner lock to get. */
1325 if (!ast_channel_trylock(iaxs[callno]->owner)) {
1326 /* We got the lock */
1329 /* Avoid deadlock by pausing and trying again */
1330 DEADLOCK_AVOIDANCE(&iaxsl[callno]);
1336 * \brief Check if a control subtype is allowed on the wire.
1338 * \param subtype Control frame subtype to check if allowed to/from the wire.
1340 * \retval non-zero if allowed.
1342 static int iax2_is_control_frame_allowed(int subtype)
1344 enum ast_control_frame_type control = subtype;
1348 * Note: If we compare the enumeration type, which does not have any
1349 * negative constants, the compiler may optimize this code away.
1350 * Therefore, we must perform an integer comparison here.
1352 if (subtype == -1) {
1356 /* Default to not allowing control frames to pass. */
1360 * The switch default is not present in order to take advantage
1361 * of the compiler complaining of a missing enum case.
1365 * These control frames make sense to send/receive across the link.
1367 case AST_CONTROL_HANGUP:
1368 case AST_CONTROL_RING:
1369 case AST_CONTROL_RINGING:
1370 case AST_CONTROL_ANSWER:
1371 case AST_CONTROL_BUSY:
1372 case AST_CONTROL_TAKEOFFHOOK:
1373 case AST_CONTROL_OFFHOOK:
1374 case AST_CONTROL_CONGESTION:
1375 case AST_CONTROL_FLASH:
1376 case AST_CONTROL_WINK:
1377 case AST_CONTROL_OPTION:
1378 case AST_CONTROL_RADIO_KEY:
1379 case AST_CONTROL_RADIO_UNKEY:
1380 case AST_CONTROL_PROGRESS:
1381 case AST_CONTROL_PROCEEDING:
1382 case AST_CONTROL_HOLD:
1383 case AST_CONTROL_UNHOLD:
1384 case AST_CONTROL_VIDUPDATE:
1385 case AST_CONTROL_CONNECTED_LINE:
1386 case AST_CONTROL_REDIRECTING:
1387 case AST_CONTROL_T38_PARAMETERS:
1388 case AST_CONTROL_AOC:
1389 case AST_CONTROL_INCOMPLETE:
1390 case AST_CONTROL_MCID:
1395 * These control frames do not make sense to send/receive across the link.
1397 case _XXX_AST_CONTROL_T38:
1398 /* The control value is deprecated in favor of AST_CONTROL_T38_PARAMETERS. */
1399 case AST_CONTROL_SRCUPDATE:
1400 /* Across an IAX link the source is still the same. */
1401 case AST_CONTROL_TRANSFER:
1402 /* A success/fail status report from calling ast_transfer() on this machine. */
1403 case AST_CONTROL_CC:
1404 /* The payload contains pointers that are valid for the sending machine only. */
1405 case AST_CONTROL_SRCCHANGE:
1406 /* Across an IAX link the source is still the same. */
1407 case AST_CONTROL_READ_ACTION:
1408 /* The action can only be done by the sending machine. */
1409 case AST_CONTROL_END_OF_Q:
1410 /* This frame would cause the call to unexpectedly hangup. */
1411 case AST_CONTROL_UPDATE_RTP_PEER:
1412 /* Only meaningful across a bridge on this machine for direct-media exchange. */
1413 case AST_CONTROL_PVT_CAUSE_CODE:
1414 /* Intended only for the sending machine's local channel structure. */
1415 case AST_CONTROL_MASQUERADE_NOTIFY:
1416 /* Intended only for masquerades when calling ast_indicate_data(). */
1417 case AST_CONTROL_STREAM_STOP:
1418 case AST_CONTROL_STREAM_SUSPEND:
1419 case AST_CONTROL_STREAM_RESTART:
1420 case AST_CONTROL_STREAM_REVERSE:
1421 case AST_CONTROL_STREAM_FORWARD:
1422 /* None of these playback stream control frames should go across the link. */
1423 case AST_CONTROL_RECORD_CANCEL:
1424 case AST_CONTROL_RECORD_STOP:
1425 case AST_CONTROL_RECORD_SUSPEND:
1426 case AST_CONTROL_RECORD_MUTE:
1427 /* None of these media recording control frames should go across the link. */
1433 static void mwi_event_cb(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg)
1435 /* The MWI subscriptions exist just so the core knows we care about those
1436 * mailboxes. However, we just grab the events out of the cache when it
1437 * is time to send MWI, since it is only sent with a REGACK. */
1440 static void network_change_stasis_subscribe(void)
1442 if (!network_change_sub) {
1443 network_change_sub = stasis_subscribe(ast_system_topic(),
1444 network_change_stasis_cb, NULL);
1448 static void network_change_stasis_unsubscribe(void)
1450 network_change_sub = stasis_unsubscribe_and_join(network_change_sub);
1453 static void acl_change_stasis_subscribe(void)
1455 if (!acl_change_sub) {
1456 acl_change_sub = stasis_subscribe(ast_security_topic(),
1457 acl_change_stasis_cb, NULL);
1461 static void acl_change_stasis_unsubscribe(void)
1463 acl_change_sub = stasis_unsubscribe_and_join(acl_change_sub);
1466 static int network_change_sched_cb(const void *data)
1468 struct iax2_registry *reg;
1469 network_change_sched_id = -1;
1470 AST_LIST_LOCK(®istrations);
1471 AST_LIST_TRAVERSE(®istrations, reg, entry) {
1472 iax2_do_register(reg);
1474 AST_LIST_UNLOCK(®istrations);
1479 static void network_change_stasis_cb(void *data, struct stasis_subscription *sub,
1480 struct stasis_message *message)
1482 /* This callback is only concerned with network change messages from the system topic. */
1483 if (stasis_message_type(message) != ast_network_change_type()) {
1487 ast_verb(1, "IAX, got a network change message, renewing all IAX registrations.\n");
1488 if (network_change_sched_id == -1) {
1489 network_change_sched_id = iax2_sched_add(sched, 1000, network_change_sched_cb, NULL);
1493 static void acl_change_stasis_cb(void *data, struct stasis_subscription *sub,
1494 struct stasis_message *message)
1496 if (stasis_message_type(message) != ast_named_acl_change_type()) {
1500 ast_log(LOG_NOTICE, "Reloading chan_iax2 in response to ACL change event.\n");
1504 static const struct ast_datastore_info iax2_variable_datastore_info = {
1505 .type = "IAX2_VARIABLE",
1506 .duplicate = iax2_dup_variable_datastore,
1507 .destroy = iax2_free_variable_datastore,
1510 static void *iax2_dup_variable_datastore(void *old)
1512 AST_LIST_HEAD(, ast_var_t) *oldlist = old, *newlist;
1513 struct ast_var_t *oldvar, *newvar;
1515 newlist = ast_calloc(sizeof(*newlist), 1);
1517 ast_log(LOG_ERROR, "Unable to duplicate iax2 variables\n");
1521 AST_LIST_HEAD_INIT(newlist);
1522 AST_LIST_LOCK(oldlist);
1523 AST_LIST_TRAVERSE(oldlist, oldvar, entries) {
1524 newvar = ast_var_assign(ast_var_name(oldvar), ast_var_value(oldvar));
1526 AST_LIST_INSERT_TAIL(newlist, newvar, entries);
1528 ast_log(LOG_ERROR, "Unable to duplicate iax2 variable '%s'\n", ast_var_name(oldvar));
1530 AST_LIST_UNLOCK(oldlist);
1534 static void iax2_free_variable_datastore(void *old)
1536 AST_LIST_HEAD(, ast_var_t) *oldlist = old;
1537 struct ast_var_t *oldvar;
1539 AST_LIST_LOCK(oldlist);
1540 while ((oldvar = AST_LIST_REMOVE_HEAD(oldlist, entries))) {
1543 AST_LIST_UNLOCK(oldlist);
1544 AST_LIST_HEAD_DESTROY(oldlist);
1549 /* WARNING: insert_idle_thread should only ever be called within the
1550 * context of an iax2_process_thread() thread.
1552 static void insert_idle_thread(struct iax2_thread *thread)
1554 if (thread->type == IAX_THREAD_TYPE_DYNAMIC) {
1555 AST_LIST_LOCK(&dynamic_list);
1556 AST_LIST_INSERT_TAIL(&dynamic_list, thread, list);
1557 AST_LIST_UNLOCK(&dynamic_list);
1559 AST_LIST_LOCK(&idle_list);
1560 AST_LIST_INSERT_TAIL(&idle_list, thread, list);
1561 AST_LIST_UNLOCK(&idle_list);
1567 static struct iax2_thread *find_idle_thread(void)
1569 struct iax2_thread *thread = NULL;
1571 /* Pop the head of the idle list off */
1572 AST_LIST_LOCK(&idle_list);
1573 thread = AST_LIST_REMOVE_HEAD(&idle_list, list);
1574 AST_LIST_UNLOCK(&idle_list);
1576 /* If we popped a thread off the idle list, just return it */
1578 memset(&thread->ffinfo, 0, sizeof(thread->ffinfo));
1582 /* Pop the head of the dynamic list off */
1583 AST_LIST_LOCK(&dynamic_list);
1584 thread = AST_LIST_REMOVE_HEAD(&dynamic_list, list);
1585 AST_LIST_UNLOCK(&dynamic_list);
1587 /* If we popped a thread off the dynamic list, just return it */
1589 memset(&thread->ffinfo, 0, sizeof(thread->ffinfo));
1593 /* If we can't create a new dynamic thread for any reason, return no thread at all */
1594 if (iaxdynamicthreadcount >= iaxmaxthreadcount || !(thread = ast_calloc(1, sizeof(*thread))))
1597 /* Set default values */
1598 ast_atomic_fetchadd_int(&iaxdynamicthreadcount, 1);
1599 thread->threadnum = ast_atomic_fetchadd_int(&iaxdynamicthreadnum, 1);
1600 thread->type = IAX_THREAD_TYPE_DYNAMIC;
1602 /* Initialize lock and condition */
1603 ast_mutex_init(&thread->lock);
1604 ast_cond_init(&thread->cond, NULL);
1605 ast_mutex_init(&thread->init_lock);
1606 ast_cond_init(&thread->init_cond, NULL);
1607 ast_mutex_lock(&thread->init_lock);
1609 /* Create thread and send it on it's way */
1610 if (ast_pthread_create_background(&thread->threadid, NULL, iax2_process_thread, thread)) {
1611 ast_cond_destroy(&thread->cond);
1612 ast_mutex_destroy(&thread->lock);
1613 ast_mutex_unlock(&thread->init_lock);
1614 ast_cond_destroy(&thread->init_cond);
1615 ast_mutex_destroy(&thread->init_lock);
1620 /* this thread is not processing a full frame (since it is idle),
1621 so ensure that the field for the full frame call number is empty */
1622 memset(&thread->ffinfo, 0, sizeof(thread->ffinfo));
1624 /* Wait for the thread to be ready before returning it to the caller */
1625 ast_cond_wait(&thread->init_cond, &thread->init_lock);
1627 /* Done with init_lock */
1628 ast_mutex_unlock(&thread->init_lock);
1633 #ifdef SCHED_MULTITHREADED
1634 static int __schedule_action(void (*func)(const void *data), const void *data, const char *funcname)
1636 struct iax2_thread *thread;
1637 static time_t lasterror;
1640 thread = find_idle_thread();
1641 if (thread != NULL) {
1642 thread->schedfunc = func;
1643 thread->scheddata = data;
1644 thread->iostate = IAX_IOSTATE_SCHEDREADY;
1645 #ifdef DEBUG_SCHED_MULTITHREAD
1646 ast_copy_string(thread->curfunc, funcname, sizeof(thread->curfunc));
1648 signal_condition(&thread->lock, &thread->cond);
1652 if (t != lasterror) {
1654 ast_debug(1, "Out of idle IAX2 threads for scheduling! (%s)\n", funcname);
1659 #define schedule_action(func, data) __schedule_action(func, data, __PRETTY_FUNCTION__)
1662 static int iax2_sched_replace(int id, struct ast_sched_context *con, int when,
1663 ast_sched_cb callback, const void *data)
1665 return ast_sched_replace(id, con, when, callback, data);
1668 static int iax2_sched_add(struct ast_sched_context *con, int when,
1669 ast_sched_cb callback, const void *data)
1671 return ast_sched_add(con, when, callback, data);
1674 static int send_ping(const void *data);
1676 static void __send_ping(const void *data)
1678 int callno = (long) data;
1680 ast_mutex_lock(&iaxsl[callno]);
1683 if (iaxs[callno]->peercallno) {
1684 send_command(iaxs[callno], AST_FRAME_IAX, IAX_COMMAND_PING, 0, NULL, 0, -1);
1685 if (iaxs[callno]->pingid != DONT_RESCHEDULE) {
1686 iaxs[callno]->pingid = iax2_sched_add(sched, ping_time * 1000, send_ping, data);
1690 ast_debug(1, "I was supposed to send a PING with callno %d, but no such call exists.\n", callno);
1693 ast_mutex_unlock(&iaxsl[callno]);
1696 static int send_ping(const void *data)
1698 int callno = (long) data;
1699 ast_mutex_lock(&iaxsl[callno]);
1700 if (iaxs[callno] && iaxs[callno]->pingid != DONT_RESCHEDULE) {
1701 iaxs[callno]->pingid = -1;
1703 ast_mutex_unlock(&iaxsl[callno]);
1705 #ifdef SCHED_MULTITHREADED
1706 if (schedule_action(__send_ping, data))
1713 static void encmethods_to_str(int e, struct ast_str **buf)
1715 ast_str_set(buf, 0, "(");
1716 if (e & IAX_ENCRYPT_AES128) {
1717 ast_str_append(buf, 0, "aes128");
1719 if (e & IAX_ENCRYPT_KEYROTATE) {
1720 ast_str_append(buf, 0, ",keyrotate");
1722 if (ast_str_strlen(*buf) > 1) {
1723 ast_str_append(buf, 0, ")");
1725 ast_str_set(buf, 0, "No");
1729 static int get_encrypt_methods(const char *s)
1732 if (!strcasecmp(s, "aes128"))
1733 e = IAX_ENCRYPT_AES128 | IAX_ENCRYPT_KEYROTATE;
1734 else if (ast_true(s))
1735 e = IAX_ENCRYPT_AES128 | IAX_ENCRYPT_KEYROTATE;
1741 static int send_lagrq(const void *data);
1743 static void __send_lagrq(const void *data)
1745 int callno = (long) data;
1747 ast_mutex_lock(&iaxsl[callno]);
1750 if (iaxs[callno]->peercallno) {
1751 send_command(iaxs[callno], AST_FRAME_IAX, IAX_COMMAND_LAGRQ, 0, NULL, 0, -1);
1752 if (iaxs[callno]->lagid != DONT_RESCHEDULE) {
1753 iaxs[callno]->lagid = iax2_sched_add(sched, lagrq_time * 1000, send_lagrq, data);
1757 ast_debug(1, "I was supposed to send a LAGRQ with callno %d, but no such call exists.\n", callno);
1760 ast_mutex_unlock(&iaxsl[callno]);
1763 static int send_lagrq(const void *data)
1765 int callno = (long) data;
1766 ast_mutex_lock(&iaxsl[callno]);
1767 if (iaxs[callno] && iaxs[callno]->lagid != DONT_RESCHEDULE) {
1768 iaxs[callno]->lagid = -1;
1770 ast_mutex_unlock(&iaxsl[callno]);
1772 #ifdef SCHED_MULTITHREADED
1773 if (schedule_action(__send_lagrq, data))
1779 static unsigned char compress_subclass(iax2_format subclass)
1783 /* If it's 64 or smaller, just return it */
1784 if (subclass < IAX_FLAG_SC_LOG)
1786 /* Otherwise find its power */
1787 for (x = 0; x < IAX_MAX_SHIFT; x++) {
1788 if (subclass & (1LL << x)) {
1790 ast_log(LOG_WARNING, "Can't compress subclass %lld\n", (long long) subclass);
1796 return power | IAX_FLAG_SC_LOG;
1799 static iax2_format uncompress_subclass(unsigned char csub)
1801 /* If the SC_LOG flag is set, return 2^csub otherwise csub */
1802 if (csub & IAX_FLAG_SC_LOG) {
1803 /* special case for 'compressed' -1 */
1807 return 1LL << (csub & ~IAX_FLAG_SC_LOG & IAX_MAX_SHIFT);
1813 static struct ast_format *codec_choose_from_prefs(struct iax2_codec_pref *pref, struct ast_format_cap *cap)
1816 struct ast_format *found_format = NULL;
1818 for (x = 0; x < ARRAY_LEN(pref->order); ++x) {
1819 struct ast_format *pref_format;
1820 uint64_t pref_bitfield;
1822 pref_bitfield = iax2_codec_pref_order_value_to_format_bitfield(pref->order[x]);
1823 if (!pref_bitfield) {
1827 pref_format = ast_format_compatibility_bitfield2format(pref_bitfield);
1829 /* The bitfield is not associated with any format. */
1832 found_format = ast_format_cap_get_compatible_format(cap, pref_format);
1838 if (found_format && (ast_format_get_type(found_format) == AST_MEDIA_TYPE_AUDIO)) {
1839 return found_format;
1842 ast_debug(4, "Could not find preferred codec - Returning zero codec.\n");
1843 ao2_cleanup(found_format);
1847 static iax2_format iax2_codec_choose(struct iax2_codec_pref *pref, iax2_format formats)
1849 struct ast_format_cap *cap;
1850 struct ast_format *tmpfmt;
1851 iax2_format format = 0;
1853 if ((cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
1854 iax2_format_compatibility_bitfield2cap(formats, cap);
1855 tmpfmt = codec_choose_from_prefs(pref, cap);
1861 format = ast_format_compatibility_format2bitfield(tmpfmt);
1862 ao2_ref(tmpfmt, -1);
1869 const char *iax2_getformatname(iax2_format format)
1871 struct ast_format *tmpfmt;
1873 tmpfmt = ast_format_compatibility_bitfield2format(format);
1878 return ast_format_get_name(tmpfmt);
1881 static const char *iax2_getformatname_multiple(iax2_format format, struct ast_str **codec_buf)
1883 struct ast_format_cap *cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1888 iax2_format_compatibility_bitfield2cap(format, cap);
1889 ast_format_cap_get_names(cap, codec_buf);
1892 return ast_str_buffer(*codec_buf);
1895 static int iax2_parse_allow_disallow(struct iax2_codec_pref *pref, iax2_format *formats, const char *list, int allowing)
1898 struct ast_format_cap *cap;
1900 /* We want to add the formats to the cap in the preferred order */
1901 cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1902 if (!cap || iax2_codec_pref_to_cap(pref, cap)) {
1907 res = ast_format_cap_update_by_allow_disallow(cap, list, allowing);
1909 /* Adjust formats bitfield and pref list to match. */
1910 *formats = iax2_format_compatibility_cap2bitfield(cap);
1911 iax2_codec_pref_remove_missing(pref, *formats);
1913 for (i = 0; i < ast_format_cap_count(cap); i++) {
1914 struct ast_format *fmt = ast_format_cap_get_format(cap, i);
1916 iax2_codec_pref_append(pref, fmt, ast_format_cap_get_format_framing(cap, fmt));
1925 static int iax2_data_add_codecs(struct ast_data *root, const char *node_name, iax2_format formats)
1928 struct ast_format_cap *cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1932 iax2_format_compatibility_bitfield2cap(formats, cap);
1933 res = ast_data_add_codecs(root, node_name, cap);
1939 * \note The only member of the peer passed here guaranteed to be set is the name field
1941 static int peer_hash_cb(const void *obj, const int flags)
1943 const struct iax2_peer *peer = obj;
1944 const char *name = obj;
1946 return ast_str_hash(flags & OBJ_KEY ? name : peer->name);
1950 * \note The only member of the peer passed here guaranteed to be set is the name field
1952 static int peer_cmp_cb(void *obj, void *arg, int flags)
1954 struct iax2_peer *peer = obj, *peer2 = arg;
1955 const char *name = arg;
1957 return !strcmp(peer->name, flags & OBJ_KEY ? name : peer2->name) ?
1958 CMP_MATCH | CMP_STOP : 0;
1962 * \note The only member of the user passed here guaranteed to be set is the name field
1964 static int user_hash_cb(const void *obj, const int flags)
1966 const struct iax2_user *user = obj;
1967 const char *name = obj;
1969 return ast_str_hash(flags & OBJ_KEY ? name : user->name);
1973 * \note The only member of the user passed here guaranteed to be set is the name field
1975 static int user_cmp_cb(void *obj, void *arg, int flags)
1977 struct iax2_user *user = obj, *user2 = arg;
1978 const char *name = arg;
1980 return !strcmp(user->name, flags & OBJ_KEY ? name : user2->name) ?
1981 CMP_MATCH | CMP_STOP : 0;
1985 * \note This funtion calls realtime_peer -> reg_source_db -> iax2_poke_peer -> find_callno,
1986 * so do not call it with a pvt lock held.
1988 static struct iax2_peer *find_peer(const char *name, int realtime)
1990 struct iax2_peer *peer = NULL;
1992 peer = ao2_find(peers, name, OBJ_KEY);
1994 /* Now go for realtime if applicable */
1995 if (!peer && realtime) {
1996 peer = realtime_peer(name, NULL);
2001 static struct iax2_peer *peer_ref(struct iax2_peer *peer)
2007 static inline struct iax2_peer *peer_unref(struct iax2_peer *peer)
2013 static struct iax2_user *find_user(const char *name)
2015 return ao2_find(users, name, OBJ_KEY);
2018 static inline struct iax2_user *user_unref(struct iax2_user *user)
2024 static int iax2_getpeername(struct ast_sockaddr addr, char *host, int len)
2026 struct iax2_peer *peer = NULL;
2028 struct ao2_iterator i;
2030 i = ao2_iterator_init(peers, 0);
2031 while ((peer = ao2_iterator_next(&i))) {
2033 if (!ast_sockaddr_cmp(&peer->addr, &addr)) {
2034 ast_copy_string(host, peer->name, len);
2041 ao2_iterator_destroy(&i);
2044 peer = realtime_peer(NULL, &addr);
2046 ast_copy_string(host, peer->name, len);
2055 /*!\note Assumes the lock on the pvt is already held, when
2056 * iax2_destroy_helper() is called. */
2057 static void iax2_destroy_helper(struct chan_iax2_pvt *pvt)
2059 /* Decrement AUTHREQ count if needed */
2060 if (ast_test_flag64(pvt, IAX_MAXAUTHREQ)) {
2061 struct iax2_user *user;
2063 user = ao2_find(users, pvt->username, OBJ_KEY);
2065 ast_atomic_fetchadd_int(&user->curauthreq, -1);
2069 ast_clear_flag64(pvt, IAX_MAXAUTHREQ);
2071 /* No more pings or lagrq's */
2072 AST_SCHED_DEL_SPINLOCK(sched, pvt->pingid, &iaxsl[pvt->callno]);
2073 pvt->pingid = DONT_RESCHEDULE;
2074 AST_SCHED_DEL_SPINLOCK(sched, pvt->lagid, &iaxsl[pvt->callno]);
2075 pvt->lagid = DONT_RESCHEDULE;
2076 AST_SCHED_DEL(sched, pvt->autoid);
2077 AST_SCHED_DEL(sched, pvt->authid);
2078 AST_SCHED_DEL(sched, pvt->initid);
2079 AST_SCHED_DEL(sched, pvt->jbid);
2080 AST_SCHED_DEL(sched, pvt->keyrotateid);
2083 static void iax2_frame_free(struct iax_frame *fr)
2085 AST_SCHED_DEL(sched, fr->retrans);
2089 static int scheduled_destroy(const void *vid)
2091 unsigned short callno = PTR_TO_CALLNO(vid);
2092 ast_mutex_lock(&iaxsl[callno]);
2094 ast_debug(1, "Really destroying %d now...\n", callno);
2095 iax2_destroy(callno);
2097 ast_mutex_unlock(&iaxsl[callno]);
2101 static void free_signaling_queue_entry(struct signaling_queue_entry *s)
2104 ast_free(s->f.data.ptr);
2109 /*! \brief This function must be called once we are sure the other side has
2110 * given us a call number. All signaling is held here until that point. */
2111 static void send_signaling(struct chan_iax2_pvt *pvt)
2113 struct signaling_queue_entry *s = NULL;
2115 while ((s = AST_LIST_REMOVE_HEAD(&pvt->signaling_queue, next))) {
2116 iax2_send(pvt, &s->f, 0, -1, 0, 0, 0);
2117 free_signaling_queue_entry(s);
2119 pvt->hold_signaling = 0;
2122 /*! \brief All frames other than that of type AST_FRAME_IAX must be held until
2123 * we have received a destination call number. */
2124 static int queue_signalling(struct chan_iax2_pvt *pvt, struct ast_frame *f)
2126 struct signaling_queue_entry *qe;
2128 if (f->frametype == AST_FRAME_IAX || !pvt->hold_signaling) {
2129 return 1; /* do not queue this frame */
2130 } else if (!(qe = ast_calloc(1, sizeof(struct signaling_queue_entry)))) {
2131 return -1; /* out of memory */
2134 /* copy ast_frame into our queue entry */
2136 if (qe->f.datalen) {
2137 /* if there is data in this frame copy it over as well */
2138 if (!(qe->f.data.ptr = ast_malloc(qe->f.datalen))) {
2139 free_signaling_queue_entry(qe);
2142 memcpy(qe->f.data.ptr, f->data.ptr, qe->f.datalen);
2144 AST_LIST_INSERT_TAIL(&pvt->signaling_queue, qe, next);
2149 static void pvt_destructor(void *obj)
2151 struct chan_iax2_pvt *pvt = obj;
2152 struct iax_frame *cur = NULL;
2153 struct signaling_queue_entry *s = NULL;
2155 ast_mutex_lock(&iaxsl[pvt->callno]);
2157 iax2_destroy_helper(pvt);
2159 sched_delay_remove(&pvt->addr, pvt->callno_entry);
2160 pvt->callno_entry = 0;
2163 ast_set_flag64(pvt, IAX_ALREADYGONE);
2165 AST_LIST_TRAVERSE(&frame_queue[pvt->callno], cur, list) {
2166 /* Cancel any pending transmissions */
2170 ast_mutex_unlock(&iaxsl[pvt->callno]);
2172 while ((s = AST_LIST_REMOVE_HEAD(&pvt->signaling_queue, next))) {
2173 free_signaling_queue_entry(s);
2177 pvt->reg->callno = 0;
2183 ast_variables_destroy(pvt->vars);
2187 while (jb_getall(pvt->jb, &frame) == JB_OK) {
2188 iax2_frame_free(frame.data);
2191 jb_destroy(pvt->jb);
2192 ast_string_field_free_memory(pvt);
2196 static struct chan_iax2_pvt *new_iax(struct ast_sockaddr *addr, const char *host)
2198 struct chan_iax2_pvt *tmp;
2201 if (!(tmp = ao2_alloc(sizeof(*tmp), pvt_destructor))) {
2205 if (ast_string_field_init(tmp, 32)) {
2211 tmp->prefs = prefs_global;
2217 tmp->keyrotateid = -1;
2219 ast_string_field_set(tmp,exten, "s");
2220 ast_string_field_set(tmp,host, host);
2224 jbconf.max_jitterbuf = maxjitterbuffer;
2225 jbconf.resync_threshold = resyncthreshold;
2226 jbconf.max_contig_interp = maxjitterinterps;
2227 jbconf.target_extra = jittertargetextra;
2228 jb_setconf(tmp->jb,&jbconf);
2230 AST_LIST_HEAD_INIT_NOLOCK(&tmp->dpentries);
2232 tmp->hold_signaling = 1;
2233 AST_LIST_HEAD_INIT_NOLOCK(&tmp->signaling_queue);
2238 static struct iax_frame *iaxfrdup2(struct iax_frame *fr)
2240 struct iax_frame *new = iax_frame_new(DIRECTION_INGRESS, fr->af.datalen, fr->cacheable);
2242 size_t afdatalen = new->afdatalen;
2243 memcpy(new, fr, sizeof(*new));
2244 iax_frame_wrap(new, &fr->af);
2245 new->afdatalen = afdatalen;
2248 new->direction = DIRECTION_INGRESS;
2253 /* keep these defined in this order. They are used in find_callno to
2254 * determine whether or not a new call number should be allowed. */
2256 /* do not allow a new call number, only search ones in use for match */
2258 /* search for match first, then allow a new one to be allocated */
2260 /* do not search for match, force a new call number */
2262 /* do not search for match, force a new call number. Signifies call number
2263 * has been calltoken validated */
2264 NEW_ALLOW_CALLTOKEN_VALIDATED = 3,
2267 static int match(struct ast_sockaddr *addr, unsigned short callno, unsigned short dcallno, const struct chan_iax2_pvt *cur, int check_dcallno)
2269 if (!ast_sockaddr_cmp(&cur->addr, addr)) {
2270 /* This is the main host */
2271 if ( (cur->peercallno == 0 || cur->peercallno == callno) &&
2272 (check_dcallno ? dcallno == cur->callno : 1) ) {
2273 /* That's us. Be sure we keep track of the peer call number */
2277 if (!ast_sockaddr_cmp(&cur->transfer, addr) && cur->transferring) {
2278 /* We're transferring */
2279 if ((dcallno == cur->callno) || (cur->transferring == TRANSFER_MEDIAPASS && cur->transfercallno == callno))
2285 static int make_trunk(unsigned short callno, int locked)
2290 if (iaxs[callno]->oseqno) {
2291 ast_log(LOG_WARNING, "Can't make trunk once a call has started!\n");
2294 if (callno >= TRUNK_CALL_START) {
2295 ast_log(LOG_WARNING, "Call %d is already a trunk\n", callno);
2299 if (get_unused_callno(
2301 CALLNO_ENTRY_IS_VALIDATED(iaxs[callno]->callno_entry),
2303 ast_log(LOG_WARNING, "Unable to trunk call: Insufficient space\n");
2307 x = CALLNO_ENTRY_GET_CALLNO(entry);
2308 ast_mutex_lock(&iaxsl[x]);
2311 * \note We delete these before switching the slot, because if
2312 * they fire in the meantime, they will generate a warning.
2314 AST_SCHED_DEL(sched, iaxs[callno]->pingid);
2315 AST_SCHED_DEL(sched, iaxs[callno]->lagid);
2316 iaxs[callno]->lagid = iaxs[callno]->pingid = -1;
2317 iaxs[x] = iaxs[callno];
2318 iaxs[x]->callno = x;
2320 /* since we copied over the pvt from a different callno, make sure the old entry is replaced
2321 * before assigning the new one */
2322 if (iaxs[x]->callno_entry) {
2325 MIN_REUSE_TIME * 1000,
2327 CALLNO_ENTRY_TO_PTR(iaxs[x]->callno_entry));
2330 iaxs[x]->callno_entry = entry;
2332 iaxs[callno] = NULL;
2333 /* Update the two timers that should have been started */
2334 iaxs[x]->pingid = iax2_sched_add(sched,
2335 ping_time * 1000, send_ping, (void *)(long)x);
2336 iaxs[x]->lagid = iax2_sched_add(sched,
2337 lagrq_time * 1000, send_lagrq, (void *)(long)x);
2340 ast_mutex_unlock(&iaxsl[callno]);
2343 ast_mutex_unlock(&iaxsl[x]);
2345 /* We moved this call from a non-trunked to a trunked call */
2346 ast_debug(1, "Made call %d into trunk call %d\n", callno, x);
2351 static void store_by_transfercallno(struct chan_iax2_pvt *pvt)
2353 if (!pvt->transfercallno) {
2354 ast_log(LOG_ERROR, "This should not be called without a transfer call number.\n");
2358 ao2_link(iax_transfercallno_pvts, pvt);
2361 static void remove_by_transfercallno(struct chan_iax2_pvt *pvt)
2363 if (!pvt->transfercallno) {
2364 ast_log(LOG_ERROR, "This should not be called without a transfer call number.\n");
2368 ao2_unlink(iax_transfercallno_pvts, pvt);
2370 static void store_by_peercallno(struct chan_iax2_pvt *pvt)
2372 if (!pvt->peercallno) {
2373 ast_log(LOG_ERROR, "This should not be called without a peer call number.\n");
2377 ao2_link(iax_peercallno_pvts, pvt);
2380 static void remove_by_peercallno(struct chan_iax2_pvt *pvt)
2382 if (!pvt->peercallno) {
2383 ast_log(LOG_ERROR, "This should not be called without a peer call number.\n");
2387 ao2_unlink(iax_peercallno_pvts, pvt);
2390 static int addr_range_delme_cb(void *obj, void *arg, int flags)
2392 struct addr_range *lim = obj;
2397 static int addr_range_hash_cb(const void *obj, const int flags)
2399 const struct addr_range *lim = obj;
2400 return abs(ast_sockaddr_hash(&lim->ha.addr));
2403 static int addr_range_cmp_cb(void *obj, void *arg, int flags)
2405 struct addr_range *lim1 = obj, *lim2 = arg;
2406 return (!(ast_sockaddr_cmp_addr(&lim1->ha.addr, &lim2->ha.addr)) &&
2407 !(ast_sockaddr_cmp_addr(&lim1->ha.netmask, &lim2->ha.netmask))) ?
2408 CMP_MATCH | CMP_STOP : 0;
2411 static int peercnt_hash_cb(const void *obj, const int flags)
2413 const struct peercnt *peercnt = obj;
2415 if (ast_sockaddr_isnull(&peercnt->addr)) {
2418 return ast_sockaddr_hash(&peercnt->addr);
2421 static int peercnt_cmp_cb(void *obj, void *arg, int flags)
2423 struct peercnt *peercnt1 = obj, *peercnt2 = arg;
2424 return !ast_sockaddr_cmp_addr(&peercnt1->addr, &peercnt2->addr) ? CMP_MATCH | CMP_STOP : 0;
2427 static int addr_range_match_address_cb(void *obj, void *arg, int flags)
2429 struct addr_range *addr_range = obj;
2430 struct ast_sockaddr *addr = arg;
2431 struct ast_sockaddr tmp_addr;
2433 ast_sockaddr_apply_netmask(addr, &addr_range->ha.netmask, &tmp_addr);
2435 if (!ast_sockaddr_cmp_addr(&tmp_addr, &addr_range->ha.addr)) {
2436 return CMP_MATCH | CMP_STOP;
2444 * \brief compares addr to calltoken_ignores table to determine if validation is required.
2446 static int calltoken_required(struct ast_sockaddr *addr, const char *name, int subclass)
2448 struct addr_range *addr_range;
2449 struct iax2_peer *peer = NULL;
2450 struct iax2_user *user = NULL;
2451 /* if no username is given, check for guest accounts */
2452 const char *find = S_OR(name, "guest");
2453 int res = 1; /* required by default */
2455 enum calltoken_peer_enum calltoken_required = CALLTOKEN_DEFAULT;
2456 /* There are only two cases in which calltoken validation is not required.
2457 * Case 1. sin falls within the list of address ranges specified in the calltoken optional table and
2458 * the peer definition has not set the requirecalltoken option.
2459 * Case 2. Username is a valid peer/user, and that peer has requirecalltoken set either auto or no.
2462 /* ----- Case 1 ----- */
2463 if ((addr_range = ao2_callback(calltoken_ignores, 0, addr_range_match_address_cb, addr))) {
2464 ao2_ref(addr_range, -1);
2468 /* ----- Case 2 ----- */
2469 if ((subclass == IAX_COMMAND_NEW) && (user = find_user(find))) {
2470 calltoken_required = user->calltoken_required;
2471 } else if ((subclass == IAX_COMMAND_NEW) && (user = realtime_user(find, addr))) {
2472 calltoken_required = user->calltoken_required;
2473 } else if ((subclass != IAX_COMMAND_NEW) && (peer = find_peer(find, 0))) {
2474 calltoken_required = peer->calltoken_required;
2475 } else if ((subclass != IAX_COMMAND_NEW) && (peer = realtime_peer(find, addr))) {
2476 calltoken_required = peer->calltoken_required;
2486 ast_debug(1, "Determining if address %s with username %s requires calltoken validation. Optional = %d calltoken_required = %u \n", ast_sockaddr_stringify_addr(addr), name, optional, calltoken_required);
2487 if (((calltoken_required == CALLTOKEN_NO) || (calltoken_required == CALLTOKEN_AUTO)) ||
2488 (optional && (calltoken_required == CALLTOKEN_DEFAULT))) {
2498 * \brief set peercnt callno limit.
2501 * First looks in custom definitions. If not found, global limit
2502 * is used. Entries marked as reg already have
2503 * a custom limit set by a registration and are not modified.
2505 static void set_peercnt_limit(struct peercnt *peercnt)
2507 uint16_t limit = global_maxcallno;
2508 struct addr_range *addr_range;
2509 struct ast_sockaddr addr;
2511 ast_sockaddr_copy(&addr, &peercnt->addr);
2513 if (peercnt->reg && peercnt->limit) {
2514 return; /* this peercnt has a custom limit set by a registration */
2517 if ((addr_range = ao2_callback(callno_limits, 0, addr_range_match_address_cb, &addr))) {
2518 limit = addr_range->limit;
2519 ast_debug(1, "custom addr_range %d found for %s\n", limit, ast_sockaddr_stringify(&addr));
2520 ao2_ref(addr_range, -1);
2523 peercnt->limit = limit;
2528 * \brief sets limits for all peercnts in table. done on reload to reflect changes in conf.
2530 static int set_peercnt_limit_all_cb(void *obj, void *arg, int flags)
2532 struct peercnt *peercnt = obj;
2534 set_peercnt_limit(peercnt);
2535 ast_debug(1, "Reset limits for peercnts table\n");
2542 * \brief returns match if delme is set.
2544 static int prune_addr_range_cb(void *obj, void *arg, int flags)
2546 struct addr_range *addr_range = obj;
2548 return addr_range->delme ? CMP_MATCH : 0;
2553 * \brief modifies peercnt entry in peercnts table. Used to set custom limit or mark a registered ip
2555 static void peercnt_modify(unsigned char reg, uint16_t limit, struct ast_sockaddr *sockaddr)
2557 /* this function turns off and on custom callno limits set by peer registration */
2558 struct peercnt *peercnt;
2561 ast_sockaddr_copy(&tmp.addr, sockaddr);
2563 if ((peercnt = ao2_find(peercnts, &tmp, OBJ_POINTER))) {
2566 peercnt->limit = limit;
2568 set_peercnt_limit(peercnt);
2570 ast_debug(1, "peercnt entry %s modified limit:%d registered:%d", ast_sockaddr_stringify_addr(sockaddr), peercnt->limit, peercnt->reg);
2571 ao2_ref(peercnt, -1); /* decrement ref from find */
2577 * \brief adds an ip to the peercnts table, increments connection count if it already exists
2579 * \details First searches for the address in the peercnts table. If found
2580 * the current count is incremented. If not found a new peercnt is allocated
2581 * and linked into the peercnts table with a call number count of 1.
2583 static int peercnt_add(struct ast_sockaddr *addr)
2585 struct peercnt *peercnt;
2589 ast_sockaddr_copy(&tmp.addr, addr);
2591 /* Reasoning for peercnts container lock: Two identical ip addresses
2592 * could be added by different threads at the "same time". Without the container
2593 * lock, both threads could alloc space for the same object and attempt
2594 * to link to table. With the lock, one would create the object and link
2595 * to table while the other would find the already created peercnt object
2596 * rather than creating a new one. */
2598 if ((peercnt = ao2_find(peercnts, &tmp, OBJ_POINTER))) {
2600 } else if ((peercnt = ao2_alloc(sizeof(*peercnt), NULL))) {
2602 /* create and set defaults */
2603 ast_sockaddr_copy(&peercnt->addr, addr);
2604 set_peercnt_limit(peercnt);
2605 /* guarantees it does not go away after unlocking table
2606 * ao2_find automatically adds this */
2607 ao2_link(peercnts, peercnt);
2609 ao2_unlock(peercnts);
2613 /* check to see if the address has hit its callno limit. If not increment cur. */
2614 if (peercnt->limit > peercnt->cur) {
2616 ast_debug(1, "ip callno count incremented to %d for %s\n", peercnt->cur, ast_sockaddr_stringify_addr(addr));
2617 } else { /* max num call numbers for this peer has been reached! */
2618 ast_log(LOG_ERROR, "maxcallnumber limit of %d for %s has been reached!\n", peercnt->limit, ast_sockaddr_stringify_addr(addr));
2622 /* clean up locks and ref count */
2623 ao2_unlock(peercnt);
2624 ao2_unlock(peercnts);
2625 ao2_ref(peercnt, -1); /* decrement ref from find/alloc, only the container ref remains. */
2632 * \brief decrements a peercnts table entry
2634 static void peercnt_remove(struct peercnt *peercnt)
2636 struct ast_sockaddr addr;
2638 ast_sockaddr_copy(&addr, &peercnt->addr);
2641 * Container locked here since peercnt may be unlinked from
2642 * list. If left unlocked, peercnt_add could try and grab this
2643 * entry from the table and modify it at the "same time" this
2644 * thread attemps to unlink it.
2648 ast_debug(1, "ip callno count decremented to %d for %s\n", peercnt->cur, ast_sockaddr_stringify_addr(&addr));
2649 /* if this was the last connection from the peer remove it from table */
2650 if (peercnt->cur == 0) {
2651 ao2_unlink(peercnts, peercnt);/* decrements ref from table, last ref is left to scheduler */
2653 ao2_unlock(peercnts);
2658 * \brief called by scheduler to decrement object
2660 static int peercnt_remove_cb(const void *obj)
2662 struct peercnt *peercnt = (struct peercnt *) obj;
2664 peercnt_remove(peercnt);
2665 ao2_ref(peercnt, -1); /* decrement ref from scheduler */
2672 * \brief decrements peercnts connection count, finds by addr
2674 static int peercnt_remove_by_addr(struct ast_sockaddr *addr)
2676 struct peercnt *peercnt;
2679 ast_sockaddr_copy(&tmp.addr, addr);
2681 if ((peercnt = ao2_find(peercnts, &tmp, OBJ_POINTER))) {
2682 peercnt_remove(peercnt);
2683 ao2_ref(peercnt, -1); /* decrement ref from find */
2690 * \brief Create callno_limit entry based on configuration
2692 static void build_callno_limits(struct ast_variable *v)
2694 struct addr_range *addr_range = NULL;
2695 struct addr_range tmp;
2701 for (; v; v = v->next) {
2705 ha = ast_append_ha("permit", v->name, NULL, &error);
2707 /* check for valid config information */
2709 ast_log(LOG_ERROR, "Call number limit for %s could not be added, Invalid address range\n.", v->name);
2711 } else if ((sscanf(v->value, "%d", &limit) != 1) || (limit < 0)) {
2712 ast_log(LOG_ERROR, "Call number limit for %s could not be added. Invalid limit %s\n.", v->name, v->value);
2717 ast_copy_ha(ha, &tmp.ha);
2718 /* find or create the addr_range */
2719 if ((addr_range = ao2_find(callno_limits, &tmp, OBJ_POINTER))) {
2720 ao2_lock(addr_range);
2722 } else if (!(addr_range = ao2_alloc(sizeof(*addr_range), NULL))) {
2724 return; /* out of memory */
2727 /* copy over config data into addr_range object */
2728 ast_copy_ha(ha, &addr_range->ha); /* this is safe because only one ha is possible for each limit */
2729 ast_free_ha(ha); /* cleanup the tmp ha */
2730 addr_range->limit = limit;
2731 addr_range->delme = 0;
2735 ao2_unlock(addr_range);
2737 ao2_link(callno_limits, addr_range);
2739 ao2_ref(addr_range, -1); /* decrement ref from ao2_find and ao2_alloc, only container ref remains */
2745 * \brief Create calltoken_ignores entry based on configuration
2747 static int add_calltoken_ignore(const char *addr)
2749 struct addr_range tmp;
2750 struct addr_range *addr_range = NULL;
2751 struct ast_ha *ha = NULL;
2754 if (ast_strlen_zero(addr)) {
2755 ast_log(LOG_WARNING, "invalid calltokenoptional %s\n", addr);
2759 ha = ast_append_ha("permit", addr, NULL, &error);
2761 /* check for valid config information */
2763 ast_log(LOG_WARNING, "Error %d creating calltokenoptional entry %s\n", error, addr);
2767 ast_copy_ha(ha, &tmp.ha);
2768 /* find or create the addr_range */
2769 if ((addr_range = ao2_find(calltoken_ignores, &tmp, OBJ_POINTER))) {
2770 ao2_lock(addr_range);
2771 addr_range->delme = 0;
2772 ao2_unlock(addr_range);
2773 } else if ((addr_range = ao2_alloc(sizeof(*addr_range), NULL))) {
2774 /* copy over config data into addr_range object */
2775 ast_copy_ha(ha, &addr_range->ha); /* this is safe because only one ha is possible */
2776 ao2_link(calltoken_ignores, addr_range);
2783 ao2_ref(addr_range, -1); /* decrement ref from ao2_find and ao2_alloc, only container ref remains */
2788 static char *handle_cli_iax2_show_callno_limits(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2790 struct ao2_iterator i;
2791 struct peercnt *peercnt;
2792 struct ast_sockaddr addr;
2797 e->command = "iax2 show callnumber usage";
2799 "Usage: iax2 show callnumber usage [IP address]\n"
2800 " Shows current IP addresses which are consuming iax2 call numbers\n";
2805 if (a->argc < 4 || a->argc > 5)
2806 return CLI_SHOWUSAGE;
2809 ast_cli(a->fd, "%-45s %-12s %-12s\n", "Address", "Callno Usage", "Callno Limit");
2812 i = ao2_iterator_init(peercnts, 0);
2813 while ((peercnt = ao2_iterator_next(&i))) {
2814 ast_sockaddr_copy(&addr, &peercnt->addr);
2817 if (!strcasecmp(a->argv[4], ast_sockaddr_stringify(&addr))) {
2818 ast_cli(a->fd, "%-45s %-12s %-12s\n", "Address", "Callno Usage", "Callno Limit");
2819 ast_cli(a->fd, "%-45s %-12d %-12d\n", ast_sockaddr_stringify(&addr), peercnt->cur, peercnt->limit);
2820 ao2_ref(peercnt, -1);
2825 ast_cli(a->fd, "%-45s %-12d %-12d\n", ast_sockaddr_stringify(&addr), peercnt->cur, peercnt->limit);
2827 ao2_ref(peercnt, -1);
2829 ao2_iterator_destroy(&i);
2832 size_t pool_avail = callno_pool.available;
2833 size_t trunk_pool_avail = callno_pool_trunk.available;
2835 ast_cli(a->fd, "\nNon-CallToken Validation Callno Limit: %d\n"
2836 "Non-CallToken Validated Callno Used: %d\n",
2837 global_maxcallno_nonval,
2838 total_nonval_callno_used);
2840 ast_cli(a->fd, "Total Available Callno: %zu\n"
2841 "Regular Callno Available: %zu\n"
2842 "Trunk Callno Available: %zu\n",
2843 pool_avail + trunk_pool_avail,
2846 } else if (a->argc == 5 && !found) {
2847 ast_cli(a->fd, "No call number table entries for %s found\n", a->argv[4] );
2857 static int get_unused_callno(enum callno_type type, int validated, callno_entry *entry)
2859 struct call_number_pool *pool = NULL;
2864 case CALLNO_TYPE_NORMAL:
2865 pool = &callno_pool;
2867 case CALLNO_TYPE_TRUNK:
2868 pool = &callno_pool_trunk;
2875 /* If we fail, make sure this has a defined value */
2878 /* We lock here primarily to ensure thread safety of the
2879 * total_nonval_callno_used check and increment */
2880 ast_mutex_lock(&callno_pool_lock);
2882 /* Bail out if we don't have any available call numbers */
2883 if (!pool->available) {
2884 ast_log(LOG_WARNING, "Out of call numbers\n");
2885 ast_mutex_unlock(&callno_pool_lock);
2889 /* Only a certain number of non-validated call numbers should be allocated.
2890 * If there ever is an attack, this separates the calltoken validating users
2891 * from the non-calltoken validating users. */
2892 if (!validated && total_nonval_callno_used >= global_maxcallno_nonval) {
2893 ast_log(LOG_WARNING,
2894 "NON-CallToken callnumber limit is reached. Current: %d Max: %d\n",
2895 total_nonval_callno_used,
2896 global_maxcallno_nonval);
2897 ast_mutex_unlock(&callno_pool_lock);
2901 /* We use a modified Fisher-Yates-Durstenfeld Shuffle to maintain a list of
2902 * available call numbers. The array of call numbers begins as an ordered
2903 * list from 1 -> n, and we keep a running tally of how many remain unclaimed
2904 * - let's call that x. When a call number is needed we pick a random index
2905 * into the array between 0 and x and use that as our call number. In a
2906 * typical FYD shuffle, we would swap the value that we are extracting with
2907 * the number at x, but in our case we swap and don't touch the value at x
2908 * because it is effectively invisible. We rely on the rest of the IAX2 core
2909 * to return the number to us at some point. Finally, we decrement x by 1
2910 * which establishes our new unused range.
2912 * When numbers are returned to the pool, we put them just past x and bump x
2913 * by 1 so that this number is now available for re-use. */
2915 choice = ast_random() % pool->available;
2917 *entry = pool->numbers[choice];
2918 swap = pool->numbers[pool->available - 1];
2920 pool->numbers[choice] = swap;
2924 CALLNO_ENTRY_SET_VALIDATED(*entry);
2926 total_nonval_callno_used++;
2929 ast_mutex_unlock(&callno_pool_lock);
2934 static int replace_callno(const void *obj)
2936 callno_entry entry = PTR_TO_CALLNO_ENTRY(obj);
2937 struct call_number_pool *pool;
2939 /* We lock here primarily to ensure thread safety of the
2940 * total_nonval_callno_used check and decrement */
2941 ast_mutex_lock(&callno_pool_lock);
2943 if (!CALLNO_ENTRY_IS_VALIDATED(entry)) {
2944 if (total_nonval_callno_used) {
2945 total_nonval_callno_used--;
2948 "Attempted to decrement total non calltoken validated "
2949 "callnumbers below zero. Callno is: %d\n",
2950 CALLNO_ENTRY_GET_CALLNO(entry));
2954 if (CALLNO_ENTRY_GET_CALLNO(entry) < TRUNK_CALL_START) {
2955 pool = &callno_pool;
2957 pool = &callno_pool_trunk;
2960 ast_assert(pool->capacity > pool->available);
2962 /* This clears the validated flag */
2963 entry = CALLNO_ENTRY_GET_CALLNO(entry);
2965 pool->numbers[pool->available] = entry;
2968 ast_mutex_unlock(&callno_pool_lock);
2973 static int create_callno_pools(void)
2977 callno_pool.available = callno_pool_trunk.available = 0;
2979 /* We start at 2. 0 and 1 are reserved. */
2980 for (i = 2; i < TRUNK_CALL_START; i++) {
2981 callno_pool.numbers[callno_pool.available] = i;
2982 callno_pool.available++;
2985 for (i = TRUNK_CALL_START; i < IAX_MAX_CALLS; i++) {
2986 callno_pool_trunk.numbers[callno_pool_trunk.available] = i;
2987 callno_pool_trunk.available++;
2990 callno_pool.capacity = callno_pool.available;
2991 callno_pool_trunk.capacity = callno_pool_trunk.available;
2993 ast_assert(callno_pool.capacity && callno_pool_trunk.capacity);
3000 * \brief Schedules delayed removal of iax2_pvt call number data
3002 * \note After MIN_REUSE_TIME has passed for a destroyed iax2_pvt, the callno is
3003 * available again, and the address from the previous connection must be decremented
3004 * from the peercnts table. This function schedules these operations to take place.
3006 static void sched_delay_remove(struct ast_sockaddr *addr, callno_entry entry)
3009 struct peercnt *peercnt;
3012 ast_sockaddr_copy(&tmp.addr, addr);
3014 if ((peercnt = ao2_find(peercnts, &tmp, OBJ_POINTER))) {
3015 /* refcount is incremented with ao2_find. keep that ref for the scheduler */
3016 ast_debug(1, "schedule decrement of callno used for %s in %d seconds\n", ast_sockaddr_stringify_addr(addr), MIN_REUSE_TIME);
3017 i = iax2_sched_add(sched, MIN_REUSE_TIME * 1000, peercnt_remove_cb, peercnt);
3019 ao2_ref(peercnt, -1);
3025 MIN_REUSE_TIME * 1000,
3027 CALLNO_ENTRY_TO_PTR(entry));
3032 * \brief returns whether or not a frame is capable of starting a new IAX2 dialog.
3034 * \note For this implementation, inbound pokes should _NOT_ be capable of allocating
3037 static inline int attribute_pure iax2_allow_new(int frametype, int subclass, int inbound)
3039 if (frametype != AST_FRAME_IAX) {
3043 case IAX_COMMAND_NEW:
3044 case IAX_COMMAND_REGREQ:
3045 case IAX_COMMAND_FWDOWNL:
3046 case IAX_COMMAND_REGREL:
3048 case IAX_COMMAND_POKE:
3058 * \note Calling this function while holding another pvt lock can cause a deadlock.
3060 static int __find_callno(unsigned short callno, unsigned short dcallno, struct ast_sockaddr *addr, int new, int sockfd, int return_locked, int check_dcallno)
3064 /* this call is calltoken validated as long as it is either NEW_FORCE
3065 * or NEW_ALLOW_CALLTOKEN_VALIDATED */
3066 int validated = (new > NEW_ALLOW) ? 1 : 0;
3069 if (new <= NEW_ALLOW) {
3071 struct chan_iax2_pvt *pvt;
3072 struct chan_iax2_pvt tmp_pvt = {
3074 .peercallno = callno,
3075 .transfercallno = callno,
3077 .frames_received = check_dcallno,
3080 ast_sockaddr_copy(&tmp_pvt.addr, addr);
3081 /* this works for finding normal call numbers not involving transfering */
3082 if ((pvt = ao2_find(iax_peercallno_pvts, &tmp_pvt, OBJ_POINTER))) {
3083 if (return_locked) {
3084 ast_mutex_lock(&iaxsl[pvt->callno]);
3091 /* this searches for transfer call numbers that might not get caught otherwise */
3092 memset(&tmp_pvt.addr, 0, sizeof(tmp_pvt.addr));
3093 ast_sockaddr_copy(&tmp_pvt.transfer, addr);
3094 if ((pvt = ao2_find(iax_transfercallno_pvts, &tmp_pvt, OBJ_POINTER))) {
3095 if (return_locked) {
3096 ast_mutex_lock(&iaxsl[pvt->callno]);
3104 /* This will occur on the first response to a message that we initiated,
3105 * such as a PING. */
3107 ast_mutex_lock(&iaxsl[dcallno]);
3109 if (callno && dcallno && iaxs[dcallno] && !iaxs[dcallno]->peercallno && match(addr, callno, dcallno, iaxs[dcallno], check_dcallno)) {
3110 iaxs[dcallno]->peercallno = callno;
3112 store_by_peercallno(iaxs[dcallno]);
3113 if (!res || !return_locked) {
3114 ast_mutex_unlock(&iaxsl[dcallno]);
3119 ast_mutex_unlock(&iaxsl[dcallno]);
3122 if (!res && (new >= NEW_ALLOW)) {
3125 /* It may seem odd that we look through the peer list for a name for
3126 * this *incoming* call. Well, it is weird. However, users don't
3127 * have an IP address/port number that we can match against. So,
3128 * this is just checking for a peer that has that IP/port and
3129 * assuming that we have a user of the same name. This isn't always
3130 * correct, but it will be changed if needed after authentication. */
3131 if (!iax2_getpeername(*addr, host, sizeof(host)))
3132 snprintf(host, sizeof(host), "%s", ast_sockaddr_stringify(addr));
3134 if (peercnt_add(addr)) {
3135 /* This address has hit its callnumber limit. When the limit
3136 * is reached, the connection is not added to the peercnts table.*/
3140 if (get_unused_callno(CALLNO_TYPE_NORMAL, validated, &entry)) {
3141 /* since we ran out of space, remove the peercnt
3142 * entry we added earlier */
3143 peercnt_remove_by_addr(addr);
3144 ast_log(LOG_WARNING, "No more space\n");
3147 x = CALLNO_ENTRY_GET_CALLNO(entry);
3148 ast_mutex_lock(&iaxsl[x]);
3150 iaxs[x] = new_iax(addr, host);
3153 ast_debug(1, "Creating new call structure %d\n", x);
3154 iaxs[x]->callno_entry = entry;
3155 iaxs[x]->sockfd = sockfd;
3156 ast_sockaddr_copy(&iaxs[x]->addr, addr);
3157 iaxs[x]->peercallno = callno;
3158 iaxs[x]->callno = x;
3159 iaxs[x]->pingtime = DEFAULT_RETRY_TIME;
3160 iaxs[x]->expiry = min_reg_expire;
3161 iaxs[x]->pingid = iax2_sched_add(sched, ping_time * 1000, send_ping, (void *)(long)x);
3162 iaxs[x]->lagid = iax2_sched_add(sched, lagrq_time * 1000, send_lagrq, (void *)(long)x);
3163 iaxs[x]->amaflags = amaflags;
3164 ast_copy_flags64(iaxs[x], &globalflags, IAX_NOTRANSFER | IAX_TRANSFERMEDIA | IAX_USEJITTERBUF | IAX_SENDCONNECTEDLINE | IAX_RECVCONNECTEDLINE | IAX_FORCE_ENCRYPT);
3165 ast_string_field_set(iaxs[x], accountcode, accountcode);
3166 ast_string_field_set(iaxs[x], mohinterpret, mohinterpret);
3167 ast_string_field_set(iaxs[x], mohsuggest, mohsuggest);
3168 ast_string_field_set(iaxs[x], parkinglot, default_parkinglot);
3170 if (iaxs[x]->peercallno) {
3171 store_by_peercallno(iaxs[x]);
3174 ast_log(LOG_WARNING, "Out of resources\n");
3175 ast_mutex_unlock(&iaxsl[x]);
3176 replace_callno(CALLNO_ENTRY_TO_PTR(entry));
3180 ast_mutex_unlock(&iaxsl[x]);
3186 static int find_callno(unsigned short callno, unsigned short dcallno, struct ast_sockaddr *addr, int new, int sockfd, int full_frame) {
3187 return __find_callno(callno, dcallno, addr, new, sockfd, 0, full_frame);
3190 static int find_callno_locked(unsigned short callno, unsigned short dcallno, struct ast_sockaddr *addr, int new, int sockfd, int full_frame) {
3192 return __find_callno(callno, dcallno, addr, new, sockfd, 1, full_frame);
3196 * \brief Queue a frame to a call's owning asterisk channel
3198 * \pre This function assumes that iaxsl[callno] is locked when called.
3200 * \note IMPORTANT NOTE!!! Any time this function is used, even if iaxs[callno]
3201 * was valid before calling it, it may no longer be valid after calling it.
3202 * This function may unlock and lock the mutex associated with this callno,
3203 * meaning that another thread may grab it and destroy the call.
3205 static int iax2_queue_frame(int callno, struct ast_frame *f)
3207 iax2_lock_owner(callno);
3208 if (iaxs[callno] && iaxs[callno]->owner) {
3209 ast_queue_frame(iaxs[callno]->owner, f);
3210 ast_channel_unlock(iaxs[callno]->owner);
3216 * \brief Queue a hold frame on the ast_channel owner
3218 * This function queues a hold frame on the owner of the IAX2 pvt struct that
3219 * is active for the given call number.
3221 * \pre Assumes lock for callno is already held.
3223 * \note IMPORTANT NOTE!!! Any time this function is used, even if iaxs[callno]
3224 * was valid before calling it, it may no longer be valid after calling it.
3225 * This function may unlock and lock the mutex associated with this callno,
3226 * meaning that another thread may grab it and destroy the call.
3228 static int iax2_queue_hold(int callno, const char *musicclass)
3230 iax2_lock_owner(callno);
3231 if (iaxs[callno] && iaxs[callno]->owner) {
3232 ast_queue_hold(iaxs[callno]->owner, musicclass);
3233 ast_channel_unlock(iaxs[callno]->owner);
3239 * \brief Queue an unhold frame on the ast_channel owner
3241 * This function queues an unhold frame on the owner of the IAX2 pvt struct that
3242 * is active for the given call number.
3244 * \pre Assumes lock for callno is already held.
3246 * \note IMPORTANT NOTE!!! Any time this function is used, even if iaxs[callno]
3247 * was valid before calling it, it may no longer be valid after calling it.
3248 * This function may unlock and lock the mutex associated with this callno,
3249 * meaning that another thread may grab it and destroy the call.
3251 static int iax2_queue_unhold(int callno)
3253 iax2_lock_owner(callno);
3254 if (iaxs[callno] && iaxs[callno]->owner) {
3255 ast_queue_unhold(iaxs[callno]->owner);
3256 ast_channel_unlock(iaxs[callno]->owner);
3262 * \brief Queue a hangup frame on the ast_channel owner
3264 * This function queues a hangup frame on the owner of the IAX2 pvt struct that
3265 * is active for the given call number.
3267 * \pre Assumes lock for callno is already held.
3269 * \note IMPORTANT NOTE!!! Any time this function is used, even if iaxs[callno]
3270 * was valid before calling it, it may no longer be valid after calling it.
3271 * This function may unlock and lock the mutex associated with this callno,
3272 * meaning that another thread may grab it and destroy the call.
3274 static int iax2_queue_hangup(int callno)
3276 iax2_lock_owner(callno);
3277 if (iaxs[callno] && iaxs[callno]->owner) {
3278 ast_queue_hangup(iaxs[callno]->owner);
3279 ast_channel_unlock(iaxs[callno]->owner);
3285 * \note This function assumes that iaxsl[callno] is locked when called.
3287 * \note IMPORTANT NOTE!!! Any time this function is used, even if iaxs[callno]
3288 * was valid before calling it, it may no longer be valid after calling it.
3289 * This function calls iax2_queue_frame(), which may unlock and lock the mutex
3290 * associated with this callno, meaning that another thread may grab it and destroy the call.
3292 static int __do_deliver(void *data)