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