main/udptl.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * UDPTL support for T.38
   5  *
   6  * Copyright (C) 2005, Steve Underwood, partly based on RTP code which is
   7  * Copyright (C) 1999-2009, Digium, Inc.
   8  *
   9  * Steve Underwood <steveu@coppice.org>
  10  * Kevin P. Fleming <kpfleming@digium.com>
  11  *
  12  * See http://www.asterisk.org for more information about
  13  * the Asterisk project. Please do not directly contact
  14  * any of the maintainers of this project for assistance;
  15  * the project provides a web site, mailing lists and IRC
  16  * channels for your use.
  17  *
  18  * This program is free software, distributed under the terms of
  19  * the GNU General Public License Version 2. See the LICENSE file
  20  * at the top of the source tree.
  21  *
  22  * A license has been granted to Digium (via disclaimer) for the use of
  23  * this code.
  24  */
  25
  26 /*!
  27  * \file
  28  *
  29  * \brief UDPTL support for T.38 faxing
  30  *
  31  *
  32  * \author Mark Spencer <markster@digium.com>
  33  * \author Steve Underwood <steveu@coppice.org>
  34  * \author Kevin P. Fleming <kpfleming@digium.com>
  35  *
  36  * \page T38fax_udptl T.38 support :: UDPTL
  37  *
  38  * Asterisk supports T.38 fax passthrough, origination and termination. It does
  39  * not support gateway operation. The only channel driver that supports T.38 at
  40  * this time is chan_sip.
  41  *
  42  * UDPTL is handled very much like RTP. It can be reinvited to go directly between
  43  * the endpoints, without involving Asterisk in the media stream.
  44  *
  45  * \b References:
  46  * - chan_sip.c
  47  * - udptl.c
  48  * - app_fax.c
  49  */
  50
  51 /*! \li \ref udptl.c uses the configuration file \ref udptl.conf
  52  * \addtogroup configuration_file Configuration Files
  53  */
  54
  55 /*!
  56  * \page udptl.conf udptl.conf
  57  * \verbinclude udptl.conf.sample
  58  */
  59
  60 /*** MODULEINFO
  61         <support_level>core</support_level>
  62  ***/
  63
  64 #include "asterisk.h"
  65
  66 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  67
  68 #include <sys/time.h>
  69 #include <signal.h>
  70 #include <fcntl.h>
  71
  72 #include "asterisk/udptl.h"
  73 #include "asterisk/frame.h"
  74 #include "asterisk/channel.h"
  75 #include "asterisk/acl.h"
  76 #include "asterisk/config_options.h"
  77 #include "asterisk/lock.h"
  78 #include "asterisk/utils.h"
  79 #include "asterisk/netsock2.h"
  80 #include "asterisk/cli.h"
  81 #include "asterisk/unaligned.h"
  82
  83 /*** DOCUMENTATION
  84         <configInfo name="udptl" language="en_US">
  85                 <configFile name="udptl.conf">
  86                         <configObject name="global">
  87                                 <synopsis>Global options for configuring UDPTL</synopsis>
  88                                 <configOption name="udptlstart">
  89                                         <synopsis>The start of the UDPTL port range</synopsis>
  90                                 </configOption>
  91                                 <configOption name="udptlend">
  92                                         <synopsis>The end of the UDPTL port range</synopsis>
  93                                 </configOption>
  94                                 <configOption name="udptlchecksums">
  95                                         <synopsis>Whether to enable or disable UDP checksums on UDPTL traffic</synopsis>
  96                                 </configOption>
  97                                 <configOption name="udptlfecentries">
  98                                         <synopsis>The number of error correction entries in a UDPTL packet</synopsis>
  99                                 </configOption>
 100                                 <configOption name="udptlfecspan">
 101                                         <synopsis>The span over which parity is calculated for FEC in a UDPTL packet</synopsis>
 102                                 </configOption>
 103                                 <configOption name="use_even_ports">
 104                                         <synopsis>Whether to only use even-numbered UDPTL ports</synopsis>
 105                                 </configOption>
 106                                 <configOption name="t38faxudpec">
 107                                         <synopsis>Removed</synopsis>
 108                                 </configOption>
 109                                 <configOption name="t38faxmaxdatagram">
 110                                         <synopsis>Removed</synopsis>
 111                                 </configOption>
 112                         </configObject>
 113                 </configFile>
 114         </configInfo>
 115 ***/
 116
 117 #define UDPTL_MTU               1200
 118
 119 #if !defined(FALSE)
 120 #define FALSE 0
 121 #endif
 122 #if !defined(TRUE)
 123 #define TRUE (!FALSE)
 124 #endif
 125
 126 #define LOG_TAG(u) S_OR(u->tag, "no tag")
 127
 128 #define DEFAULT_UDPTLSTART 4000
 129 #define DEFAULT_UDPTLEND 4999
 130
 131 static int udptldebug;                      /*!< Are we debugging? */
 132 static struct ast_sockaddr udptldebugaddr;   /*!< Debug packets to/from this host */
 133
 134 #define LOCAL_FAX_MAX_DATAGRAM      1400
 135 #define DEFAULT_FAX_MAX_DATAGRAM    400
 136 #define FAX_MAX_DATAGRAM_LIMIT      1400
 137 #define MAX_FEC_ENTRIES             5
 138 #define MAX_FEC_SPAN                5
 139
 140 #define UDPTL_BUF_MASK              15
 141
 142 typedef struct {
 143         int buf_len;
 144         uint8_t buf[LOCAL_FAX_MAX_DATAGRAM];
 145 } udptl_fec_tx_buffer_t;
 146
 147 typedef struct {
 148         int buf_len;
 149         uint8_t buf[LOCAL_FAX_MAX_DATAGRAM];
 150         unsigned int fec_len[MAX_FEC_ENTRIES];
 151         uint8_t fec[MAX_FEC_ENTRIES][LOCAL_FAX_MAX_DATAGRAM];
 152         unsigned int fec_span;
 153         unsigned int fec_entries;
 154 } udptl_fec_rx_buffer_t;
 155
 156 /*! \brief Structure for an UDPTL session */
 157 struct ast_udptl {
 158         int fd;
 159         char resp;
 160         struct ast_frame f[16];
 161         unsigned char rawdata[8192 + AST_FRIENDLY_OFFSET];
 162         unsigned int lasteventseqn;
 163         int nat;
 164         int flags;
 165         struct ast_sockaddr us;
 166         struct ast_sockaddr them;
 167         int *ioid;
 168         struct ast_sched_context *sched;
 169         struct io_context *io;
 170         void *data;
 171         char *tag;
 172         ast_udptl_callback callback;
 173
 174         /*! This option indicates the error correction scheme used in transmitted UDPTL
 175          * packets and expected in received UDPTL packets.
 176          */
 177         enum ast_t38_ec_modes error_correction_scheme;
 178
 179         /*! This option indicates the number of error correction entries transmitted in
 180          * UDPTL packets and expected in received UDPTL packets.
 181          */
 182         unsigned int error_correction_entries;
 183
 184         /*! This option indicates the span of the error correction entries in transmitted
 185          * UDPTL packets (FEC only).
 186          */
 187         unsigned int error_correction_span;
 188
 189         /*! The maximum size UDPTL packet that can be accepted by
 190          * the remote device.
 191          */
 192         int far_max_datagram;
 193
 194         /*! The maximum size UDPTL packet that we are prepared to
 195          * accept, or -1 if it hasn't been calculated since the last
 196          * changes were applied to the UDPTL structure.
 197          */
 198         int local_max_datagram;
 199
 200         /*! The maximum IFP that can be submitted for sending
 201          * to the remote device. Calculated from far_max_datagram,
 202          * error_correction_scheme and error_correction_entries,
 203          * or -1 if it hasn't been calculated since the last
 204          * changes were applied to the UDPTL structure.
 205          */
 206         int far_max_ifp;
 207
 208         /*! The maximum IFP that the local endpoint is prepared
 209          * to accept. Along with error_correction_scheme and
 210          * error_correction_entries, used to calculate local_max_datagram.
 211          */
 212         int local_max_ifp;
 213
 214         unsigned int tx_seq_no;
 215         unsigned int rx_seq_no;
 216
 217         udptl_fec_tx_buffer_t tx[UDPTL_BUF_MASK + 1];
 218         udptl_fec_rx_buffer_t rx[UDPTL_BUF_MASK + 1];
 219 };
 220
 221 static AST_RWLIST_HEAD_STATIC(protos, ast_udptl_protocol);
 222
 223 struct udptl_global_options {
 224         unsigned int start; /*< The UDPTL start port */
 225         unsigned int end;   /*< The UDPTL end port */
 226         unsigned int fecentries;
 227         unsigned int fecspan;
 228         unsigned int nochecksums;
 229         unsigned int use_even_ports;
 230 };
 231
 232 static AO2_GLOBAL_OBJ_STATIC(globals);
 233
 234 struct udptl_config {
 235         struct udptl_global_options *general;
 236 };
 237
 238 static void *udptl_snapshot_alloc(void);
 239 static int udptl_pre_apply_config(void);
 240
 241 static struct aco_type general_option = {
 242         .type = ACO_GLOBAL,
 243         .name = "global",
 244         .category_match = ACO_WHITELIST,
 245         .item_offset = offsetof(struct udptl_config, general),
 246         .category = "^general$",
 247 };
 248
 249 static struct aco_type *general_options[] = ACO_TYPES(&general_option);
 250
 251 static struct aco_file udptl_conf = {
 252         .filename = "udptl.conf",
 253         .types = ACO_TYPES(&general_option),
 254 };
 255
 256 CONFIG_INFO_CORE("udptl", cfg_info, globals, udptl_snapshot_alloc,
 257         .files = ACO_FILES(&udptl_conf),
 258         .pre_apply_config = udptl_pre_apply_config,
 259 );
 260
 261 static inline int udptl_debug_test_addr(const struct ast_sockaddr *addr)
 262 {
 263         if (udptldebug == 0)
 264                 return 0;
 265
 266         if (ast_sockaddr_isnull(&udptldebugaddr)) {
 267                 return 1;
 268         }
 269
 270         if (ast_sockaddr_port(&udptldebugaddr)) {
 271                 return !ast_sockaddr_cmp(&udptldebugaddr, addr);
 272         } else {
 273                 return !ast_sockaddr_cmp_addr(&udptldebugaddr, addr);
 274         }
 275 }
 276
 277 static int decode_length(uint8_t *buf, unsigned int limit, unsigned int *len, unsigned int *pvalue)
 278 {
 279         if (*len >= limit)
 280                 return -1;
 281         if ((buf[*len] & 0x80) == 0) {
 282                 *pvalue = buf[*len];
 283                 (*len)++;
 284                 return 0;
 285         }
 286         if ((buf[*len] & 0x40) == 0) {
 287                 if (*len == limit - 1)
 288                         return -1;
 289                 *pvalue = (buf[*len] & 0x3F) << 8;
 290                 (*len)++;
 291                 *pvalue |= buf[*len];
 292                 (*len)++;
 293                 return 0;
 294         }
 295         *pvalue = (buf[*len] & 0x3F) << 14;
 296         (*len)++;
 297         /* We have a fragment.  Currently we don't process fragments. */
 298         ast_debug(1, "UDPTL packet with length greater than 16K received, decoding will fail\n");
 299         return 1;
 300 }
 301 /*- End of function --------------------------------------------------------*/
 302
 303 static int decode_open_type(uint8_t *buf, unsigned int limit, unsigned int *len, const uint8_t **p_object, unsigned int *p_num_octets)
 304 {
 305         unsigned int octet_cnt = 0;
 306
 307         if (decode_length(buf, limit, len, &octet_cnt) != 0)
 308                 return -1;
 309
 310         if (octet_cnt > 0) {
 311                 /* Make sure the buffer contains at least the number of bits requested */
 312                 if ((*len + octet_cnt) > limit)
 313                         return -1;
 314
 315                 *p_num_octets = octet_cnt;
 316                 *p_object = &buf[*len];
 317                 *len += octet_cnt;
 318         }
 319
 320         return 0;
 321 }
 322 /*- End of function --------------------------------------------------------*/
 323
 324 static unsigned int encode_length(uint8_t *buf, unsigned int *len, unsigned int value)
 325 {
 326         unsigned int multiplier;
 327
 328         if (value < 0x80) {
 329                 /* 1 octet */
 330                 buf[*len] = value;
 331                 (*len)++;
 332                 return value;
 333         }
 334         if (value < 0x4000) {
 335                 /* 2 octets */
 336                 /* Set the first bit of the first octet */
 337                 buf[*len] = ((0x8000 | value) >> 8) & 0xFF;
 338                 (*len)++;
 339                 buf[*len] = value & 0xFF;
 340                 (*len)++;
 341                 return value;
 342         }
 343         /* Fragmentation */
 344         multiplier = (value < 0x10000) ? (value >> 14) : 4;
 345         /* Set the first 2 bits of the octet */
 346         buf[*len] = 0xC0 | multiplier;
 347         (*len)++;
 348         return multiplier << 14;
 349 }
 350 /*- End of function --------------------------------------------------------*/
 351
 352 static int encode_open_type(const struct ast_udptl *udptl, uint8_t *buf, unsigned int buflen,
 353                             unsigned int *len, const uint8_t *data, unsigned int num_octets)
 354 {
 355         unsigned int enclen;
 356         unsigned int octet_idx;
 357         uint8_t zero_byte;
 358
 359         /* If open type is of zero length, add a single zero byte (10.1) */
 360         if (num_octets == 0) {
 361                 zero_byte = 0;
 362                 data = &zero_byte;
 363                 num_octets = 1;
 364         }
 365         /* Encode the open type */
 366         for (octet_idx = 0; ; num_octets -= enclen, octet_idx += enclen) {
 367                 if ((enclen = encode_length(buf, len, num_octets)) < 0)
 368                         return -1;
 369                 if (enclen + *len > buflen) {
 370                         ast_log(LOG_ERROR, "UDPTL (%s): Buffer overflow detected (%d + %d > %d)\n",
 371                                 LOG_TAG(udptl), enclen, *len, buflen);
 372                         return -1;
 373                 }
 374                 if (enclen > 0) {
 375                         memcpy(&buf[*len], &data[octet_idx], enclen);
 376                         *len += enclen;
 377                 }
 378                 if (enclen >= num_octets)
 379                         break;
 380         }
 381
 382         return 0;
 383 }
 384 /*- End of function --------------------------------------------------------*/
 385
 386 static int udptl_rx_packet(struct ast_udptl *s, uint8_t *buf, unsigned int len)
 387 {
 388         int stat1;
 389         int stat2;
 390         int i;
 391         unsigned int ptr;       /* an index that keeps track of how much of the UDPTL packet has been processed */
 392         int seq_no;
 393         const uint8_t *ifp = NULL;
 394         const uint8_t *data = NULL;
 395         unsigned int ifp_len = 0;
 396         int repaired[16];
 397         const uint8_t *bufs[ARRAY_LEN(s->f) - 1];
 398         unsigned int lengths[ARRAY_LEN(s->f) - 1];
 399         int span;
 400         int entries;
 401         int ifp_no;
 402
 403         ptr = 0;
 404         ifp_no = 0;
 405         memset(&s->f[0], 0, sizeof(s->f[0]));
 406
 407         /* Decode seq_number */
 408         if (ptr + 2 > len)
 409                 return -1;
 410         seq_no = (buf[0] << 8) | buf[1];
 411         ptr += 2;
 412
 413         /* Break out the primary packet */
 414         if ((stat1 = decode_open_type(buf, len, &ptr, &ifp, &ifp_len)) != 0)
 415                 return -1;
 416         /* Decode error_recovery */
 417         if (ptr + 1 > len)
 418                 return -1;
 419         if ((buf[ptr++] & 0x80) == 0) {
 420                 /* Secondary packet mode for error recovery */
 421                 if (seq_no > s->rx_seq_no) {
 422                         /* We received a later packet than we expected, so we need to check if we can fill in the gap from the
 423                            secondary packets. */
 424                         int total_count = 0;
 425                         do {
 426                                 unsigned int count;
 427                                 if ((stat2 = decode_length(buf, len, &ptr, &count)) < 0)
 428                                         return -1;
 429                                 for (i = 0; i < count && total_count + i < ARRAY_LEN(bufs); i++) {
 430                                         if ((stat1 = decode_open_type(buf, len, &ptr, &bufs[total_count + i], &lengths[total_count + i])) != 0) {
 431                                                 return -1;
 432                                         }
 433                                         /* valid secondaries can contain zero-length packets that should be ignored */
 434                                         if (!bufs[total_count + i] || !lengths[total_count + i]) {
 435                                                 /* drop the count of items to process and reuse the buffers that were just set */
 436                                                 i--;
 437                                                 count--;
 438                                         }
 439                                 }
 440                                 total_count += i;
 441                         }
 442                         while (stat2 > 0 && total_count < ARRAY_LEN(bufs));
 443                         /* Step through in reverse order, so we go oldest to newest */
 444                         for (i = total_count; i > 0; i--) {
 445                                 if (seq_no - i >= s->rx_seq_no) {
 446                                         /* This one wasn't seen before */
 447                                         /* Decode the secondary IFP packet */
 448                                         ast_debug(3, "Recovering lost packet via secondary %d, len %d\n", seq_no - i, lengths[i - 1]);
 449                                         s->f[ifp_no].frametype = AST_FRAME_MODEM;
 450                                         s->f[ifp_no].subclass.integer = AST_MODEM_T38;
 451
 452                                         s->f[ifp_no].mallocd = 0;
 453                                         s->f[ifp_no].seqno = seq_no - i;
 454                                         s->f[ifp_no].datalen = lengths[i - 1];
 455                                         s->f[ifp_no].data.ptr = (uint8_t *) bufs[i - 1];
 456                                         s->f[ifp_no].offset = 0;
 457                                         s->f[ifp_no].src = "UDPTL";
 458                                         if (ifp_no > 0)
 459                                                 AST_LIST_NEXT(&s->f[ifp_no - 1], frame_list) = &s->f[ifp_no];
 460                                         AST_LIST_NEXT(&s->f[ifp_no], frame_list) = NULL;
 461                                         ifp_no++;
 462                                 }
 463                         }
 464                 }
 465         }
 466         else
 467         {
 468                 int j;
 469                 int l;
 470                 int x;
 471                 /* FEC mode for error recovery */
 472                 /* Our buffers cannot tolerate overlength IFP packets in FEC mode */
 473                 if (ifp_len > LOCAL_FAX_MAX_DATAGRAM)
 474                         return -1;
 475                 /* Update any missed slots in the buffer */
 476                 for ( ; seq_no > s->rx_seq_no; s->rx_seq_no++) {
 477                         x = s->rx_seq_no & UDPTL_BUF_MASK;
 478                         s->rx[x].buf_len = -1;
 479                         s->rx[x].fec_len[0] = 0;
 480                         s->rx[x].fec_span = 0;
 481                         s->rx[x].fec_entries = 0;
 482                 }
 483
 484                 x = seq_no & UDPTL_BUF_MASK;
 485
 486                 memset(repaired, 0, sizeof(repaired));
 487
 488                 /* Save the new IFP packet */
 489                 memcpy(s->rx[x].buf, ifp, ifp_len);
 490                 s->rx[x].buf_len = ifp_len;
 491                 repaired[x] = TRUE;
 492
 493                 /* Decode the FEC packets */
 494                 /* The span is defined as an unconstrained integer, but will never be more
 495                    than a small value. */
 496                 if (ptr + 2 > len)
 497                         return -1;
 498                 if (buf[ptr++] != 1)
 499                         return -1;
 500                 span = buf[ptr++];
 501                 s->rx[x].fec_span = span;
 502
 503                 /* The number of entries is defined as a length, but will only ever be a small
 504                    value. Treat it as such. */
 505                 if (ptr + 1 > len)
 506                         return -1;
 507                 entries = buf[ptr++];
 508                 if (entries > MAX_FEC_ENTRIES) {
 509                         return -1;
 510                 }
 511                 s->rx[x].fec_entries = entries;
 512
 513                 /* Decode the elements */
 514                 for (i = 0; i < entries; i++) {
 515                         if ((stat1 = decode_open_type(buf, len, &ptr, &data, &s->rx[x].fec_len[i])) != 0)
 516                                 return -1;
 517                         if (s->rx[x].fec_len[i] > LOCAL_FAX_MAX_DATAGRAM)
 518                                 return -1;
 519
 520                         /* Save the new FEC data */
 521                         memcpy(s->rx[x].fec[i], data, s->rx[x].fec_len[i]);
 522 #if 0
 523                         fprintf(stderr, "FEC: ");
 524                         for (j = 0; j < s->rx[x].fec_len[i]; j++)
 525                                 fprintf(stderr, "%02X ", data[j]);
 526                         fprintf(stderr, "\n");
 527 #endif
 528                 }
 529
 530                 /* See if we can reconstruct anything which is missing */
 531                 /* TODO: this does not comprehensively hunt back and repair everything that is possible */
 532                 for (l = x; l != ((x - (16 - span*entries)) & UDPTL_BUF_MASK); l = (l - 1) & UDPTL_BUF_MASK) {
 533                         int m;
 534                         if (s->rx[l].fec_len[0] <= 0)
 535                                 continue;
 536                         for (m = 0; m < s->rx[l].fec_entries; m++) {
 537                                 int k;
 538                                 int which;
 539                                 int limit = (l + m) & UDPTL_BUF_MASK;
 540                                 for (which = -1, k = (limit - s->rx[l].fec_span * s->rx[l].fec_entries) & UDPTL_BUF_MASK; k != limit; k = (k + s->rx[l].fec_entries) & UDPTL_BUF_MASK) {
 541                                         if (s->rx[k].buf_len <= 0)
 542                                                 which = (which == -1) ? k : -2;
 543                                 }
 544                                 if (which >= 0) {
 545                                         /* Repairable */
 546                                         for (j = 0; j < s->rx[l].fec_len[m]; j++) {
 547                                                 s->rx[which].buf[j] = s->rx[l].fec[m][j];
 548                                                 for (k = (limit - s->rx[l].fec_span * s->rx[l].fec_entries) & UDPTL_BUF_MASK; k != limit; k = (k + s->rx[l].fec_entries) & UDPTL_BUF_MASK)
 549                                                         s->rx[which].buf[j] ^= (s->rx[k].buf_len > j) ? s->rx[k].buf[j] : 0;
 550                                         }
 551                                         s->rx[which].buf_len = s->rx[l].fec_len[m];
 552                                         repaired[which] = TRUE;
 553                                 }
 554                         }
 555                 }
 556                 /* Now play any new packets forwards in time */
 557                 for (l = (x + 1) & UDPTL_BUF_MASK, j = seq_no - UDPTL_BUF_MASK; l != x; l = (l + 1) & UDPTL_BUF_MASK, j++) {
 558                         if (repaired[l]) {
 559                                 //fprintf(stderr, "Fixed packet %d, len %d\n", j, l);
 560                                 s->f[ifp_no].frametype = AST_FRAME_MODEM;
 561                                 s->f[ifp_no].subclass.integer = AST_MODEM_T38;
 562
 563                                 s->f[ifp_no].mallocd = 0;
 564                                 s->f[ifp_no].seqno = j;
 565                                 s->f[ifp_no].datalen = s->rx[l].buf_len;
 566                                 s->f[ifp_no].data.ptr = s->rx[l].buf;
 567                                 s->f[ifp_no].offset = 0;
 568                                 s->f[ifp_no].src = "UDPTL";
 569                                 if (ifp_no > 0)
 570                                         AST_LIST_NEXT(&s->f[ifp_no - 1], frame_list) = &s->f[ifp_no];
 571                                 AST_LIST_NEXT(&s->f[ifp_no], frame_list) = NULL;
 572                                 ifp_no++;
 573                         }
 574                 }
 575         }
 576
 577         /* If packets are received out of sequence, we may have already processed this packet from the error
 578            recovery information in a packet already received. */
 579         if (seq_no >= s->rx_seq_no) {
 580                 /* Decode the primary IFP packet */
 581                 s->f[ifp_no].frametype = AST_FRAME_MODEM;
 582                 s->f[ifp_no].subclass.integer = AST_MODEM_T38;
 583
 584                 s->f[ifp_no].mallocd = 0;
 585                 s->f[ifp_no].seqno = seq_no;
 586                 s->f[ifp_no].datalen = ifp_len;
 587                 s->f[ifp_no].data.ptr = (uint8_t *) ifp;
 588                 s->f[ifp_no].offset = 0;
 589                 s->f[ifp_no].src = "UDPTL";
 590                 if (ifp_no > 0)
 591                         AST_LIST_NEXT(&s->f[ifp_no - 1], frame_list) = &s->f[ifp_no];
 592                 AST_LIST_NEXT(&s->f[ifp_no], frame_list) = NULL;
 593
 594                 ifp_no++;
 595         }
 596
 597         s->rx_seq_no = seq_no + 1;
 598         return ifp_no;
 599 }
 600 /*- End of function --------------------------------------------------------*/
 601
 602 static int udptl_build_packet(struct ast_udptl *s, uint8_t *buf, unsigned int buflen, uint8_t *ifp, unsigned int ifp_len)
 603 {
 604         uint8_t fec[LOCAL_FAX_MAX_DATAGRAM * 2] = { 0, };
 605         int i;
 606         int j;
 607         int seq;
 608         int entry;
 609         int entries;
 610         int span;
 611         int m;
 612         unsigned int len;
 613         int limit;
 614         int high_tide;
 615
 616         seq = s->tx_seq_no & 0xFFFF;
 617
 618         /* Map the sequence number to an entry in the circular buffer */
 619         entry = seq & UDPTL_BUF_MASK;
 620
 621         /* We save the message in a circular buffer, for generating FEC or
 622            redundancy sets later on. */
 623         s->tx[entry].buf_len = ifp_len;
 624         memcpy(s->tx[entry].buf, ifp, ifp_len);
 625
 626         /* Build the UDPTLPacket */
 627
 628         len = 0;
 629         /* Encode the sequence number */
 630         buf[len++] = (seq >> 8) & 0xFF;
 631         buf[len++] = seq & 0xFF;
 632
 633         /* Encode the primary IFP packet */
 634         if (encode_open_type(s, buf, buflen, &len, ifp, ifp_len) < 0)
 635                 return -1;
 636
 637         /* Encode the appropriate type of error recovery information */
 638         switch (s->error_correction_scheme)
 639         {
 640         case UDPTL_ERROR_CORRECTION_NONE:
 641                 /* Encode the error recovery type */
 642                 buf[len++] = 0x00;
 643                 /* The number of entries will always be zero, so it is pointless allowing
 644                    for the fragmented case here. */
 645                 if (encode_length(buf, &len, 0) < 0)
 646                         return -1;
 647                 break;
 648         case UDPTL_ERROR_CORRECTION_REDUNDANCY:
 649                 /* Encode the error recovery type */
 650                 buf[len++] = 0x00;
 651                 if (s->tx_seq_no > s->error_correction_entries)
 652                         entries = s->error_correction_entries;
 653                 else
 654                         entries = s->tx_seq_no;
 655                 /* The number of entries will always be small, so it is pointless allowing
 656                    for the fragmented case here. */
 657                 if (encode_length(buf, &len, entries) < 0)
 658                         return -1;
 659                 /* Encode the elements */
 660                 for (i = 0; i < entries; i++) {
 661                         j = (entry - i - 1) & UDPTL_BUF_MASK;
 662                         if (encode_open_type(s, buf, buflen, &len, s->tx[j].buf, s->tx[j].buf_len) < 0) {
 663                                 ast_debug(1, "UDPTL (%s): Encoding failed at i=%d, j=%d\n",
 664                                           LOG_TAG(s), i, j);
 665                                 return -1;
 666                         }
 667                 }
 668                 break;
 669         case UDPTL_ERROR_CORRECTION_FEC:
 670                 span = s->error_correction_span;
 671                 entries = s->error_correction_entries;
 672                 if (seq < s->error_correction_span*s->error_correction_entries) {
 673                         /* In the initial stages, wind up the FEC smoothly */
 674                         entries = seq/s->error_correction_span;
 675                         if (seq < s->error_correction_span)
 676                                 span = 0;
 677                 }
 678                 /* Encode the error recovery type */
 679                 buf[len++] = 0x80;
 680                 /* Span is defined as an inconstrained integer, which it dumb. It will only
 681                    ever be a small value. Treat it as such. */
 682                 buf[len++] = 1;
 683                 buf[len++] = span;
 684                 /* The number of entries is defined as a length, but will only ever be a small
 685                    value. Treat it as such. */
 686                 buf[len++] = entries;
 687                 for (m = 0; m < entries; m++) {
 688                         /* Make an XOR'ed entry the maximum length */
 689                         limit = (entry + m) & UDPTL_BUF_MASK;
 690                         high_tide = 0;
 691                         for (i = (limit - span*entries) & UDPTL_BUF_MASK; i != limit; i = (i + entries) & UDPTL_BUF_MASK) {
 692                                 if (high_tide < s->tx[i].buf_len) {
 693                                         for (j = 0; j < high_tide; j++)
 694                                                 fec[j] ^= s->tx[i].buf[j];
 695                                         for ( ; j < s->tx[i].buf_len; j++)
 696                                                 fec[j] = s->tx[i].buf[j];
 697                                         high_tide = s->tx[i].buf_len;
 698                                 } else {
 699                                         for (j = 0; j < s->tx[i].buf_len; j++)
 700                                                 fec[j] ^= s->tx[i].buf[j];
 701                                 }
 702                         }
 703                         if (encode_open_type(s, buf, buflen, &len, fec, high_tide) < 0)
 704                                 return -1;
 705                 }
 706                 break;
 707         }
 708
 709         s->tx_seq_no++;
 710         return len;
 711 }
 712
 713 int ast_udptl_fd(const struct ast_udptl *udptl)
 714 {
 715         return udptl->fd;
 716 }
 717
 718 void ast_udptl_set_data(struct ast_udptl *udptl, void *data)
 719 {
 720         udptl->data = data;
 721 }
 722
 723 void ast_udptl_set_callback(struct ast_udptl *udptl, ast_udptl_callback callback)
 724 {
 725         udptl->callback = callback;
 726 }
 727
 728 void ast_udptl_setnat(struct ast_udptl *udptl, int nat)
 729 {
 730         udptl->nat = nat;
 731 }
 732
 733 static int udptlread(int *id, int fd, short events, void *cbdata)
 734 {
 735         struct ast_udptl *udptl = cbdata;
 736         struct ast_frame *f;
 737
 738         if ((f = ast_udptl_read(udptl))) {
 739                 if (udptl->callback)
 740                         udptl->callback(udptl, f, udptl->data);
 741         }
 742         return 1;
 743 }
 744
 745 struct ast_frame *ast_udptl_read(struct ast_udptl *udptl)
 746 {
 747         int res;
 748         struct ast_sockaddr addr;
 749         uint8_t *buf;
 750
 751         buf = udptl->rawdata + AST_FRIENDLY_OFFSET;
 752
 753         /* Cache where the header will go */
 754         res = ast_recvfrom(udptl->fd,
 755                         buf,
 756                         sizeof(udptl->rawdata) - AST_FRIENDLY_OFFSET,
 757                         0,
 758                         &addr);
 759         if (res < 0) {
 760                 if (errno != EAGAIN)
 761                         ast_log(LOG_WARNING, "UDPTL (%s): read error: %s\n",
 762                                 LOG_TAG(udptl), strerror(errno));
 763                 ast_assert(errno != EBADF);
 764                 return &ast_null_frame;
 765         }
 766
 767         /* Ignore if the other side hasn't been given an address yet. */
 768         if (ast_sockaddr_isnull(&udptl->them)) {
 769                 return &ast_null_frame;
 770         }
 771
 772         if (udptl->nat) {
 773                 /* Send to whoever sent to us */
 774                 if (ast_sockaddr_cmp(&udptl->them, &addr)) {
 775                         ast_sockaddr_copy(&udptl->them, &addr);
 776                         ast_debug(1, "UDPTL (%s): NAT, Using address %s\n",
 777                                   LOG_TAG(udptl), ast_sockaddr_stringify(&udptl->them));
 778                 }
 779         }
 780
 781         if (udptl_debug_test_addr(&addr)) {
 782                 int seq_no;
 783
 784                 /* Decode sequence number just for verbose message. */
 785                 if (res < 2) {
 786                         /* Short packet. */
 787                         seq_no = -1;
 788                 } else {
 789                         seq_no = (buf[0] << 8) | buf[1];
 790                 }
 791
 792                 ast_verb(1, "UDPTL (%s): packet from %s (seq %d, len %d)\n",
 793                         LOG_TAG(udptl), ast_sockaddr_stringify(&addr), seq_no, res);
 794         }
 795         if (udptl_rx_packet(udptl, buf, res) < 1) {
 796                 return &ast_null_frame;
 797         }
 798
 799         return &udptl->f[0];
 800 }
 801
 802 static void calculate_local_max_datagram(struct ast_udptl *udptl)
 803 {
 804         unsigned int new_max = 0;
 805
 806         if (udptl->local_max_ifp == -1) {
 807                 ast_log(LOG_WARNING, "UDPTL (%s): Cannot calculate local_max_datagram before local_max_ifp has been set.\n",
 808                         LOG_TAG(udptl));
 809                 udptl->local_max_datagram = -1;
 810                 return;
 811         }
 812
 813         /* calculate the amount of space required to receive an IFP
 814          * of the maximum size supported by the application/endpoint
 815          * that we are delivering them to (local endpoint), and add
 816          * the amount of space required to support the selected
 817          * error correction mode
 818          */
 819         switch (udptl->error_correction_scheme) {
 820         case UDPTL_ERROR_CORRECTION_NONE:
 821                 /* need room for sequence number, length indicator, redundancy
 822                  * indicator and following length indicator
 823                  */
 824                 new_max = 5 + udptl->local_max_ifp;
 825                 break;
 826         case UDPTL_ERROR_CORRECTION_REDUNDANCY:
 827                 /* need room for sequence number, length indicators, plus
 828                  * room for up to 3 redundancy packets
 829                  */
 830                 new_max = 5 + udptl->local_max_ifp + 2 + (3 * udptl->local_max_ifp);
 831                 break;
 832         case UDPTL_ERROR_CORRECTION_FEC:
 833                 /* need room for sequence number, length indicators and a
 834                  * a single IFP of the maximum size expected
 835                  */
 836                 new_max = 5 + udptl->local_max_ifp + 4 + udptl->local_max_ifp;
 837                 break;
 838         }
 839         /* add 5% extra space for insurance, but no larger than LOCAL_FAX_MAX_DATAGRAM */
 840         udptl->local_max_datagram = MIN(new_max * 1.05, LOCAL_FAX_MAX_DATAGRAM);
 841 }
 842
 843 static void calculate_far_max_ifp(struct ast_udptl *udptl)
 844 {
 845         unsigned new_max = 0;
 846
 847         if (udptl->far_max_datagram == -1) {
 848                 ast_log(LOG_WARNING, "UDPTL (%s): Cannot calculate far_max_ifp before far_max_datagram has been set.\n",
 849                         LOG_TAG(udptl));
 850                 udptl->far_max_ifp = -1;
 851                 return;
 852         }
 853
 854         /* the goal here is to supply the local endpoint (application
 855          * or bridged channel) a maximum IFP value that will allow it
 856          * to effectively and efficiently transfer image data at its
 857          * selected bit rate, taking into account the selected error
 858          * correction mode, but without overrunning the far endpoint's
 859          * datagram buffer. this is complicated by the fact that some
 860          * far endpoints send us bogus (small) max datagram values,
 861          * which would result in either buffer overrun or no error
 862          * correction. we try to accomodate those, but if the supplied
 863          * value is too small to do so, we'll emit warning messages and
 864          * the user will have to use configuration options to override
 865          * the max datagram value supplied by the far endpoint.
 866          */
 867         switch (udptl->error_correction_scheme) {
 868         case UDPTL_ERROR_CORRECTION_NONE:
 869                 /* need room for sequence number, length indicator, redundancy
 870                  * indicator and following length indicator
 871                  */
 872                 new_max = udptl->far_max_datagram - 5;
 873                 break;
 874         case UDPTL_ERROR_CORRECTION_REDUNDANCY:
 875                 /* for this case, we'd like to send as many error correction entries
 876                  * as possible (up to the number we're configured for), but we'll settle
 877                  * for sending fewer if the configured number would cause the
 878                  * calculated max IFP to be too small for effective operation
 879                  *
 880                  * need room for sequence number, length indicators and the
 881                  * configured number of redundant packets
 882                  *
 883                  * note: we purposely don't allow error_correction_entries to drop to
 884                  * zero in this loop; we'd rather send smaller IFPs (and thus reduce
 885                  * the image data transfer rate) than sacrifice redundancy completely
 886                  */
 887                 for (;;) {
 888                         new_max = (udptl->far_max_datagram - 8) / (udptl->error_correction_entries + 1);
 889
 890                         if ((new_max < 80) && (udptl->error_correction_entries > 1)) {
 891                                 /* the max ifp is not large enough, subtract an
 892                                  * error correction entry and calculate again
 893                                  * */
 894                                 --udptl->error_correction_entries;
 895                         } else {
 896                                 break;
 897                         }
 898                 }
 899                 break;
 900         case UDPTL_ERROR_CORRECTION_FEC:
 901                 /* need room for sequence number, length indicators and a
 902                  * a single IFP of the maximum size expected
 903                  */
 904                 new_max = (udptl->far_max_datagram - 10) / 2;
 905                 break;
 906         }
 907         /* subtract 5% of space for insurance */
 908         udptl->far_max_ifp = new_max * 0.95;
 909 }
 910
 911 enum ast_t38_ec_modes ast_udptl_get_error_correction_scheme(const struct ast_udptl *udptl)
 912 {
 913         return udptl->error_correction_scheme;
 914 }
 915
 916 void ast_udptl_set_error_correction_scheme(struct ast_udptl *udptl, enum ast_t38_ec_modes ec)
 917 {
 918         udptl->error_correction_scheme = ec;
 919         switch (ec) {
 920         case UDPTL_ERROR_CORRECTION_FEC:
 921                 udptl->error_correction_scheme = UDPTL_ERROR_CORRECTION_FEC;
 922                 if (udptl->error_correction_entries == 0) {
 923                         udptl->error_correction_entries = 3;
 924                 }
 925                 if (udptl->error_correction_span == 0) {
 926                         udptl->error_correction_span = 3;
 927                 }
 928                 break;
 929         case UDPTL_ERROR_CORRECTION_REDUNDANCY:
 930                 udptl->error_correction_scheme = UDPTL_ERROR_CORRECTION_REDUNDANCY;
 931                 if (udptl->error_correction_entries == 0) {
 932                         udptl->error_correction_entries = 3;
 933                 }
 934                 break;
 935         default:
 936                 /* nothing to do */
 937                 break;
 938         };
 939         /* reset calculated values so they'll be computed again */
 940         udptl->local_max_datagram = -1;
 941         udptl->far_max_ifp = -1;
 942 }
 943
 944 void ast_udptl_set_local_max_ifp(struct ast_udptl *udptl, unsigned int max_ifp)
 945 {
 946         /* make sure max_ifp is a positive value since a cast will take place when
 947          * when setting local_max_ifp */
 948         if ((signed int) max_ifp > 0) {
 949                 udptl->local_max_ifp = max_ifp;
 950                 /* reset calculated values so they'll be computed again */
 951                 udptl->local_max_datagram = -1;
 952         }
 953 }
 954
 955 unsigned int ast_udptl_get_local_max_datagram(struct ast_udptl *udptl)
 956 {
 957         if (udptl->local_max_datagram == -1) {
 958                 calculate_local_max_datagram(udptl);
 959         }
 960
 961         /* this function expects a unsigned value in return. */
 962         if (udptl->local_max_datagram < 0) {
 963                 return 0;
 964         }
 965         return udptl->local_max_datagram;
 966 }
 967
 968 void ast_udptl_set_far_max_datagram(struct ast_udptl *udptl, unsigned int max_datagram)
 969 {
 970         if (!max_datagram || (max_datagram > FAX_MAX_DATAGRAM_LIMIT)) {
 971                 udptl->far_max_datagram = DEFAULT_FAX_MAX_DATAGRAM;
 972         } else {
 973                 udptl->far_max_datagram = max_datagram;
 974         }
 975         /* reset calculated values so they'll be computed again */
 976         udptl->far_max_ifp = -1;
 977 }
 978
 979 unsigned int ast_udptl_get_far_max_datagram(const struct ast_udptl *udptl)
 980 {
 981         if (udptl->far_max_datagram < 0) {
 982                 return 0;
 983         }
 984         return udptl->far_max_datagram;
 985 }
 986
 987 unsigned int ast_udptl_get_far_max_ifp(struct ast_udptl *udptl)
 988 {
 989         if (udptl->far_max_ifp == -1) {
 990                 calculate_far_max_ifp(udptl);
 991         }
 992
 993         if (udptl->far_max_ifp < 0) {
 994                 return 0;
 995         }
 996         return udptl->far_max_ifp;
 997 }
 998
 999 struct ast_udptl *ast_udptl_new_with_bindaddr(struct ast_sched_context *sched, struct io_context *io, int callbackmode, struct ast_sockaddr *addr)
1000 {
1001         struct ast_udptl *udptl;
1002         int x;
1003         int startplace;
1004         int i;
1005         long int flags;
1006         RAII_VAR(struct udptl_config *, cfg, ao2_global_obj_ref(globals), ao2_cleanup);
1007
1008         if (!cfg || !cfg->general) {
1009                 ast_log(LOG_ERROR, "Could not access global udptl options!\n");
1010                 return NULL;
1011         }
1012
1013         if (!(udptl = ast_calloc(1, sizeof(*udptl)))) {
1014                 return NULL;
1015         }
1016
1017         udptl->error_correction_span = cfg->general->fecspan;
1018         udptl->error_correction_entries = cfg->general->fecentries;
1019
1020         udptl->far_max_datagram = -1;
1021         udptl->far_max_ifp = -1;
1022         udptl->local_max_ifp = -1;
1023         udptl->local_max_datagram = -1;
1024
1025         for (i = 0; i <= UDPTL_BUF_MASK; i++) {
1026                 udptl->rx[i].buf_len = -1;
1027                 udptl->tx[i].buf_len = -1;
1028         }
1029
1030         if ((udptl->fd = socket(ast_sockaddr_is_ipv6(addr) ?
1031                                         AF_INET6 : AF_INET, SOCK_DGRAM, 0)) < 0) {
1032                 ast_free(udptl);
1033                 ast_log(LOG_WARNING, "Unable to allocate socket: %s\n", strerror(errno));
1034                 return NULL;
1035         }
1036         flags = fcntl(udptl->fd, F_GETFL);
1037         fcntl(udptl->fd, F_SETFL, flags | O_NONBLOCK);
1038
1039 #ifdef SO_NO_CHECK
1040         if (cfg->general->nochecksums)
1041                 setsockopt(udptl->fd, SOL_SOCKET, SO_NO_CHECK, &cfg->general->nochecksums, sizeof(cfg->general->nochecksums));
1042 #endif
1043
1044         /* Find us a place */
1045         x = (cfg->general->start == cfg->general->end) ? cfg->general->start : (ast_random() % (cfg->general->end - cfg->general->start)) + cfg->general->start;
1046         if (cfg->general->use_even_ports && (x & 1)) {
1047                 ++x;
1048         }
1049         startplace = x;
1050         for (;;) {
1051                 ast_sockaddr_copy(&udptl->us, addr);
1052                 ast_sockaddr_set_port(&udptl->us, x);
1053                 if (ast_bind(udptl->fd, &udptl->us) == 0) {
1054                         break;
1055                 }
1056                 if (errno != EADDRINUSE) {
1057                         ast_log(LOG_WARNING, "Unexpected bind error: %s\n", strerror(errno));
1058                         close(udptl->fd);
1059                         ast_free(udptl);
1060                         return NULL;
1061                 }
1062                 if (cfg->general->use_even_ports) {
1063                         x += 2;
1064                 } else {
1065                         ++x;
1066                 }
1067                 if (x > cfg->general->end)
1068                         x = cfg->general->start;
1069                 if (x == startplace) {
1070                         ast_log(LOG_WARNING, "No UDPTL ports remaining\n");
1071                         close(udptl->fd);
1072                         ast_free(udptl);
1073                         return NULL;
1074                 }
1075         }
1076         if (io && sched && callbackmode) {
1077                 /* Operate this one in a callback mode */
1078                 udptl->sched = sched;
1079                 udptl->io = io;
1080                 udptl->ioid = ast_io_add(udptl->io, udptl->fd, udptlread, AST_IO_IN, udptl);
1081         }
1082
1083         return udptl;
1084 }
1085
1086 void ast_udptl_set_tag(struct ast_udptl *udptl, const char *format, ...)
1087 {
1088         va_list ap;
1089
1090         ast_free(udptl->tag);
1091         udptl->tag = NULL;
1092         va_start(ap, format);
1093         if (ast_vasprintf(&udptl->tag, format, ap) == -1) {
1094                 udptl->tag = NULL;
1095         }
1096         va_end(ap);
1097 }
1098
1099 int ast_udptl_setqos(struct ast_udptl *udptl, unsigned int tos, unsigned int cos)
1100 {
1101         return ast_set_qos(udptl->fd, tos, cos, "UDPTL");
1102 }
1103
1104 void ast_udptl_set_peer(struct ast_udptl *udptl, const struct ast_sockaddr *them)
1105 {
1106         ast_sockaddr_copy(&udptl->them, them);
1107 }
1108
1109 void ast_udptl_get_peer(const struct ast_udptl *udptl, struct ast_sockaddr *them)
1110 {
1111         ast_sockaddr_copy(them, &udptl->them);
1112 }
1113
1114 void ast_udptl_get_us(const struct ast_udptl *udptl, struct ast_sockaddr *us)
1115 {
1116         ast_sockaddr_copy(us, &udptl->us);
1117 }
1118
1119 void ast_udptl_stop(struct ast_udptl *udptl)
1120 {
1121         ast_sockaddr_setnull(&udptl->them);
1122 }
1123
1124 void ast_udptl_destroy(struct ast_udptl *udptl)
1125 {
1126         if (udptl->ioid)
1127                 ast_io_remove(udptl->io, udptl->ioid);
1128         if (udptl->fd > -1)
1129                 close(udptl->fd);
1130         if (udptl->tag)
1131                 ast_free(udptl->tag);
1132         ast_free(udptl);
1133 }
1134
1135 int ast_udptl_write(struct ast_udptl *s, struct ast_frame *f)
1136 {
1137         unsigned int seq;
1138         unsigned int len = f->datalen;
1139         /* if no max datagram size is provided, use default value */
1140         const int bufsize = (s->far_max_datagram > 0) ? s->far_max_datagram : DEFAULT_FAX_MAX_DATAGRAM;
1141         uint8_t buf[bufsize];
1142
1143         memset(buf, 0, sizeof(buf));
1144
1145         /* If we have no peer, return immediately */
1146         if (ast_sockaddr_isnull(&s->them)) {
1147                 return 0;
1148         }
1149
1150         /* If there is no data length, return immediately */
1151         if (f->datalen == 0)
1152                 return 0;
1153
1154         if ((f->frametype != AST_FRAME_MODEM) ||
1155             (f->subclass.integer != AST_MODEM_T38)) {
1156                 ast_log(LOG_WARNING, "UDPTL (%s): UDPTL can only send T.38 data.\n",
1157                         LOG_TAG(s));
1158                 return -1;
1159         }
1160
1161         if (len > s->far_max_ifp) {
1162                 ast_log(LOG_WARNING,
1163                         "UDPTL (%s): UDPTL asked to send %d bytes of IFP when far end only prepared to accept %d bytes; data loss will occur."
1164                         "You may need to override the T38FaxMaxDatagram value for this endpoint in the channel driver configuration.\n",
1165                         LOG_TAG(s), len, s->far_max_ifp);
1166                 len = s->far_max_ifp;
1167         }
1168
1169         /* Save seq_no for debug output because udptl_build_packet increments it */
1170         seq = s->tx_seq_no & 0xFFFF;
1171
1172         /* Cook up the UDPTL packet, with the relevant EC info. */
1173         len = udptl_build_packet(s, buf, sizeof(buf), f->data.ptr, len);
1174
1175         if ((signed int) len > 0 && !ast_sockaddr_isnull(&s->them)) {
1176                 if (ast_sendto(s->fd, buf, len, 0, &s->them) < 0) {
1177                         ast_log(LOG_NOTICE, "UDPTL (%s): Transmission error to %s: %s\n",
1178                                 LOG_TAG(s), ast_sockaddr_stringify(&s->them), strerror(errno));
1179                 }
1180                 if (udptl_debug_test_addr(&s->them)) {
1181                         ast_verb(1, "UDPTL (%s): packet to %s (seq %d, len %d)\n",
1182                                 LOG_TAG(s), ast_sockaddr_stringify(&s->them), seq, len);
1183                 }
1184         }
1185
1186         return 0;
1187 }
1188
1189 void ast_udptl_proto_unregister(struct ast_udptl_protocol *proto)
1190 {
1191         AST_RWLIST_WRLOCK(&protos);
1192         AST_RWLIST_REMOVE(&protos, proto, list);
1193         AST_RWLIST_UNLOCK(&protos);
1194 }
1195
1196 int ast_udptl_proto_register(struct ast_udptl_protocol *proto)
1197 {
1198         struct ast_udptl_protocol *cur;
1199
1200         AST_RWLIST_WRLOCK(&protos);
1201         AST_RWLIST_TRAVERSE(&protos, cur, list) {
1202                 if (cur->type == proto->type) {
1203                         ast_log(LOG_WARNING, "Tried to register same protocol '%s' twice\n", cur->type);
1204                         AST_RWLIST_UNLOCK(&protos);
1205                         return -1;
1206                 }
1207         }
1208         AST_RWLIST_INSERT_TAIL(&protos, proto, list);
1209         AST_RWLIST_UNLOCK(&protos);
1210         return 0;
1211 }
1212
1213 static struct ast_udptl_protocol *get_proto(struct ast_channel *chan)
1214 {
1215         struct ast_udptl_protocol *cur = NULL;
1216
1217         AST_RWLIST_RDLOCK(&protos);
1218         AST_RWLIST_TRAVERSE(&protos, cur, list) {
1219                 if (cur->type == ast_channel_tech(chan)->type)
1220                         break;
1221         }
1222         AST_RWLIST_UNLOCK(&protos);
1223
1224         return cur;
1225 }
1226
1227 int ast_udptl_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc)
1228 {
1229         struct ast_frame *f;
1230         struct ast_channel *who;
1231         struct ast_channel *cs[3];
1232         struct ast_udptl *p0;
1233         struct ast_udptl *p1;
1234         struct ast_udptl_protocol *pr0;
1235         struct ast_udptl_protocol *pr1;
1236         struct ast_sockaddr ac0;
1237         struct ast_sockaddr ac1;
1238         struct ast_sockaddr t0;
1239         struct ast_sockaddr t1;
1240         void *pvt0;
1241         void *pvt1;
1242         int to;
1243
1244         ast_channel_lock_both(c0, c1);
1245         pr0 = get_proto(c0);
1246         pr1 = get_proto(c1);
1247         if (!pr0) {
1248                 ast_log(LOG_WARNING, "Can't find native functions for channel '%s'\n", ast_channel_name(c0));
1249                 ast_channel_unlock(c0);
1250                 ast_channel_unlock(c1);
1251                 return -1;
1252         }
1253         if (!pr1) {
1254                 ast_log(LOG_WARNING, "Can't find native functions for channel '%s'\n", ast_channel_name(c1));
1255                 ast_channel_unlock(c0);
1256                 ast_channel_unlock(c1);
1257                 return -1;
1258         }
1259         pvt0 = ast_channel_tech_pvt(c0);
1260         pvt1 = ast_channel_tech_pvt(c1);
1261         p0 = pr0->get_udptl_info(c0);
1262         p1 = pr1->get_udptl_info(c1);
1263         if (!p0 || !p1) {
1264                 /* Somebody doesn't want to play... */
1265                 ast_channel_unlock(c0);
1266                 ast_channel_unlock(c1);
1267                 return -2;
1268         }
1269         if (pr0->set_udptl_peer(c0, p1)) {
1270                 ast_log(LOG_WARNING, "Channel '%s' failed to talk to '%s'\n", ast_channel_name(c0), ast_channel_name(c1));
1271                 memset(&ac1, 0, sizeof(ac1));
1272         } else {
1273                 /* Store UDPTL peer */
1274                 ast_udptl_get_peer(p1, &ac1);
1275         }
1276         if (pr1->set_udptl_peer(c1, p0)) {
1277                 ast_log(LOG_WARNING, "Channel '%s' failed to talk back to '%s'\n", ast_channel_name(c1), ast_channel_name(c0));
1278                 memset(&ac0, 0, sizeof(ac0));
1279         } else {
1280                 /* Store UDPTL peer */
1281                 ast_udptl_get_peer(p0, &ac0);
1282         }
1283         ast_channel_unlock(c0);
1284         ast_channel_unlock(c1);
1285         cs[0] = c0;
1286         cs[1] = c1;
1287         cs[2] = NULL;
1288         for (;;) {
1289                 if ((ast_channel_tech_pvt(c0) != pvt0) ||
1290                         (ast_channel_tech_pvt(c1) != pvt1) ||
1291                         (ast_channel_masq(c0) || ast_channel_masqr(c0) || ast_channel_masq(c1) || ast_channel_masqr(c1))) {
1292                                 ast_debug(1, "Oooh, something is weird, backing out\n");
1293                                 /* Tell it to try again later */
1294                                 return -3;
1295                 }
1296                 to = -1;
1297                 ast_udptl_get_peer(p1, &t1);
1298                 ast_udptl_get_peer(p0, &t0);
1299                 if (ast_sockaddr_cmp(&t1, &ac1)) {
1300                         ast_debug(1, "Oooh, '%s' changed end address to %s\n",
1301                                 ast_channel_name(c1), ast_sockaddr_stringify(&t1));
1302                         ast_debug(1, "Oooh, '%s' was %s\n",
1303                                 ast_channel_name(c1), ast_sockaddr_stringify(&ac1));
1304                         ast_sockaddr_copy(&ac1, &t1);
1305                 }
1306                 if (ast_sockaddr_cmp(&t0, &ac0)) {
1307                         ast_debug(1, "Oooh, '%s' changed end address to %s\n",
1308                                 ast_channel_name(c0), ast_sockaddr_stringify(&t0));
1309                         ast_debug(1, "Oooh, '%s' was %s\n",
1310                                 ast_channel_name(c0), ast_sockaddr_stringify(&ac0));
1311                         ast_sockaddr_copy(&ac0, &t0);
1312                 }
1313                 who = ast_waitfor_n(cs, 2, &to);
1314                 if (!who) {
1315                         ast_debug(1, "Ooh, empty read...\n");
1316                         /* check for hangup / whentohangup */
1317                         if (ast_check_hangup(c0) || ast_check_hangup(c1))
1318                                 break;
1319                         continue;
1320                 }
1321                 f = ast_read(who);
1322                 if (!f) {
1323                         *fo = f;
1324                         *rc = who;
1325                         ast_debug(1, "Oooh, got a %s\n", f ? "digit" : "hangup");
1326                         /* That's all we needed */
1327                         return 0;
1328                 } else {
1329                         if (f->frametype == AST_FRAME_MODEM) {
1330                                 /* Forward T.38 frames if they happen upon us */
1331                                 if (who == c0) {
1332                                         ast_write(c1, f);
1333                                 } else if (who == c1) {
1334                                         ast_write(c0, f);
1335                                 }
1336                         }
1337                         ast_frfree(f);
1338                 }
1339                 /* Swap priority. Not that it's a big deal at this point */
1340                 cs[2] = cs[0];
1341                 cs[0] = cs[1];
1342                 cs[1] = cs[2];
1343         }
1344         return -1;
1345 }
1346
1347 static char *handle_cli_udptl_set_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1348 {
1349         switch (cmd) {
1350         case CLI_INIT:
1351                 e->command = "udptl set debug {on|off|ip}";
1352                 e->usage =
1353                         "Usage: udptl set debug {on|off|ip host[:port]}\n"
1354                         "       Enable or disable dumping of UDPTL packets.\n"
1355                         "       If ip is specified, limit the dumped packets to those to and from\n"
1356                         "       the specified 'host' with optional port.\n";
1357                 return NULL;
1358         case CLI_GENERATE:
1359                 return NULL;
1360         }
1361
1362         if (a->argc < 4 || a->argc > 5)
1363                 return CLI_SHOWUSAGE;
1364
1365         if (a->argc == 4) {
1366                 if (!strncasecmp(a->argv[3], "on", 2)) {
1367                         udptldebug = 1;
1368                         memset(&udptldebugaddr, 0, sizeof(udptldebugaddr));
1369                         ast_cli(a->fd, "UDPTL Debugging Enabled\n");
1370                 } else if (!strncasecmp(a->argv[3], "off", 3)) {
1371                         udptldebug = 0;
1372                         ast_cli(a->fd, "UDPTL Debugging Disabled\n");
1373                 } else {
1374                         return CLI_SHOWUSAGE;
1375                 }
1376         } else {
1377                 struct ast_sockaddr *addrs;
1378                 if (strncasecmp(a->argv[3], "ip", 2))
1379                         return CLI_SHOWUSAGE;
1380                 if (!ast_sockaddr_resolve(&addrs, a->argv[4], 0, 0)) {
1381                         return CLI_SHOWUSAGE;
1382                 }
1383                 ast_sockaddr_copy(&udptldebugaddr, &addrs[0]);
1384                         ast_cli(a->fd, "UDPTL Debugging Enabled for IP: %s\n", ast_sockaddr_stringify(&udptldebugaddr));
1385                 udptldebug = 1;
1386                 ast_free(addrs);
1387         }
1388
1389         return CLI_SUCCESS;
1390 }
1391
1392 static char *handle_cli_show_config(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1393 {
1394         RAII_VAR(struct udptl_config *, cfg, NULL, ao2_cleanup);
1395
1396         switch (cmd) {
1397         case CLI_INIT:
1398                 e->command = "udptl show config";
1399                 e->usage =
1400                         "Usage: udptl show config\n"
1401                         "       Display UDPTL configuration options\n";
1402                 return NULL;
1403         case CLI_GENERATE:
1404                 return NULL;
1405         }
1406
1407         if (!(cfg = ao2_global_obj_ref(globals))) {
1408                 return CLI_FAILURE;
1409         }
1410
1411         ast_cli(a->fd, "UDPTL Global options\n");
1412         ast_cli(a->fd, "--------------------\n");
1413         ast_cli(a->fd, "udptlstart:      %u\n", cfg->general->start);
1414         ast_cli(a->fd, "udptlend:        %u\n", cfg->general->end);
1415         ast_cli(a->fd, "udptlfecentries: %u\n", cfg->general->fecentries);
1416         ast_cli(a->fd, "udptlfecspan:    %u\n", cfg->general->fecspan);
1417         ast_cli(a->fd, "use_even_ports:  %s\n", AST_CLI_YESNO(cfg->general->use_even_ports));
1418         ast_cli(a->fd, "udptlchecksums: %s\n", AST_CLI_YESNO(!cfg->general->nochecksums));
1419
1420         return CLI_SUCCESS;
1421 }
1422
1423 static struct ast_cli_entry cli_udptl[] = {
1424         AST_CLI_DEFINE(handle_cli_udptl_set_debug, "Enable/Disable UDPTL debugging"),
1425         AST_CLI_DEFINE(handle_cli_show_config, "Show UDPTL config options"),
1426 };
1427
1428 static void udptl_config_destructor(void *obj)
1429 {
1430         struct udptl_config *cfg = obj;
1431         ao2_cleanup(cfg->general);
1432 }
1433
1434 static void *udptl_snapshot_alloc(void)
1435 {
1436         struct udptl_config *cfg;
1437
1438         if (!(cfg = ao2_alloc(sizeof(*cfg), udptl_config_destructor))) {
1439                 return NULL;
1440         }
1441         if (!(cfg->general = ao2_alloc(sizeof(*cfg->general), NULL))) {
1442                 ao2_ref(cfg, -1);
1443                 return NULL;
1444         }
1445
1446         return cfg;
1447 }
1448
1449 static int removed_options_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
1450 {
1451         if (!strcasecmp(var->name, "t38faxudpec")) {
1452                 ast_log(LOG_WARNING, "t38faxudpec in udptl.conf is no longer supported; use the t38pt_udptl configuration option in sip.conf instead.\n");
1453         } else if (!strcasecmp(var->name, "t38faxmaxdatagram")) {
1454                 ast_log(LOG_WARNING, "t38faxmaxdatagram in udptl.conf is no longer supported; value is now supplied by T.38 applications.\n");
1455         }
1456         return 0;
1457 }
1458
1459 static void __ast_udptl_reload(int reload)
1460 {
1461         if (aco_process_config(&cfg_info, reload) == ACO_PROCESS_ERROR) {
1462                 if (!reload) {
1463                         RAII_VAR(struct udptl_config *, udptl_cfg, udptl_snapshot_alloc(), ao2_cleanup);
1464
1465                         if (aco_set_defaults(&general_option, "general", udptl_cfg->general)) {
1466                                 ast_log(LOG_ERROR, "Failed to load udptl.conf and failed to initialize defaults.\n");
1467                                 return;
1468                         }
1469
1470                         ast_log(LOG_NOTICE, "Could not load udptl config; using defaults\n");
1471                         ao2_global_obj_replace_unref(globals, udptl_cfg);
1472                 }
1473         }
1474 }
1475
1476 static int udptl_pre_apply_config(void) {
1477         struct udptl_config *cfg = aco_pending_config(&cfg_info);
1478
1479         if (!cfg->general) {
1480                 return -1;
1481         }
1482
1483 #ifndef SO_NO_CHECK
1484         if (cfg->general->nochecksums) {
1485                 ast_log(LOG_WARNING, "Disabling UDPTL checksums is not supported on this operating system!\n");
1486                 cfg->general->nochecksums = 0;
1487         }
1488 #endif
1489
1490         /* Fix up any global config values that we can handle before replacing the config */
1491         if (cfg->general->use_even_ports && (cfg->general->start & 1)) {
1492                 ++cfg->general->start;
1493                 ast_log(LOG_NOTICE, "Odd numbered udptlstart specified but use_even_ports enabled. udptlstart is now %d\n", cfg->general->start);
1494         }
1495         if (cfg->general->start > cfg->general->end) {
1496                 ast_log(LOG_WARNING, "Unreasonable values for UDPTL start/end ports; defaulting to %s-%s.\n", __stringify(DEFAULT_UDPTLSTART), __stringify(DEFAULT_UDPTLEND));
1497                 cfg->general->start = DEFAULT_UDPTLSTART;
1498                 cfg->general->end = DEFAULT_UDPTLEND;
1499         }
1500         if (cfg->general->use_even_ports && (cfg->general->end & 1)) {
1501                 --cfg->general->end;
1502                 ast_log(LOG_NOTICE, "Odd numbered udptlend specified but use_even_ports enabled. udptlend is now %d\n", cfg->general->end);
1503         }
1504
1505         return 0;
1506 }
1507
1508 int ast_udptl_reload(void)
1509 {
1510         __ast_udptl_reload(1);
1511         return 0;
1512 }
1513
1514 /*!
1515  * \internal
1516  * \brief Clean up resources on Asterisk shutdown
1517  */
1518 static void udptl_shutdown(void)
1519 {
1520         ast_cli_unregister_multiple(cli_udptl, ARRAY_LEN(cli_udptl));
1521         ao2_t_global_obj_release(globals, "Unref udptl global container in shutdown");
1522         aco_info_destroy(&cfg_info);
1523 }
1524
1525 void ast_udptl_init(void)
1526 {
1527         if (aco_info_init(&cfg_info)) {
1528                 return;
1529         }
1530
1531         aco_option_register(&cfg_info, "udptlstart", ACO_EXACT, general_options, __stringify(DEFAULT_UDPTLSTART),
1532                 OPT_UINT_T, PARSE_IN_RANGE | PARSE_DEFAULT,
1533                 FLDSET(struct udptl_global_options, start), DEFAULT_UDPTLSTART, 1024, 65535);
1534
1535         aco_option_register(&cfg_info, "udptlend", ACO_EXACT, general_options, __stringify(DEFAULT_UDPTLEND),
1536                 OPT_UINT_T, PARSE_IN_RANGE | PARSE_DEFAULT,
1537                 FLDSET(struct udptl_global_options, end), DEFAULT_UDPTLEND, 1024, 65535);
1538
1539         aco_option_register(&cfg_info, "udptlfecentries", ACO_EXACT, general_options, NULL,
1540                 OPT_UINT_T, PARSE_IN_RANGE | PARSE_RANGE_DEFAULTS,
1541                 FLDSET(struct udptl_global_options, fecentries), 1, MAX_FEC_ENTRIES);
1542
1543         aco_option_register(&cfg_info, "udptlfecspan", ACO_EXACT, general_options, NULL,
1544                 OPT_UINT_T, PARSE_IN_RANGE | PARSE_RANGE_DEFAULTS,
1545                 FLDSET(struct udptl_global_options, fecspan), 1, MAX_FEC_SPAN);
1546
1547         aco_option_register(&cfg_info, "udptlchecksums", ACO_EXACT, general_options, "yes",
1548                 OPT_BOOL_T, 0, FLDSET(struct udptl_global_options, nochecksums));
1549
1550         aco_option_register(&cfg_info, "use_even_ports", ACO_EXACT, general_options, "no",
1551                 OPT_BOOL_T, 1, FLDSET(struct udptl_global_options, use_even_ports));
1552
1553         aco_option_register_custom(&cfg_info, "t38faxudpec", ACO_EXACT, general_options, NULL, removed_options_handler, 0);
1554         aco_option_register_custom(&cfg_info, "t38faxmaxdatagram", ACO_EXACT, general_options, NULL, removed_options_handler, 0);
1555
1556         __ast_udptl_reload(0);
1557
1558         ast_cli_register_multiple(cli_udptl, ARRAY_LEN(cli_udptl));
1559
1560         ast_register_atexit(udptl_shutdown);
1561 }