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