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