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