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