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