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