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