]> git.sesse.net Git - vlc/blob - modules/access/udp.c
Fix out-of-bound read in RTP access
[vlc] / modules / access / udp.c
1 /*****************************************************************************
2  * udp.c: raw UDP & RTP input module
3  *****************************************************************************
4  * Copyright (C) 2001-2005 the VideoLAN team
5  * Copyright (C) 2007 Remi Denis-Courmont
6  * $Id$
7  *
8  * Authors: Christophe Massiot <massiot@via.ecp.fr>
9  *          Tristan Leteurtre <tooney@via.ecp.fr>
10  *          Laurent Aimar <fenrir@via.ecp.fr>
11  *          Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
12  *          Remi Denis-Courmont
13  *
14  * Reviewed: 23 October 2003, Jean-Paul Saman <jpsaman _at_ videolan _dot_ org>
15  *
16  * This program is free software; you can redistribute it and/or modify
17  * it under the terms of the GNU General Public License as published by
18  * the Free Software Foundation; either version 2 of the License, or
19  * (at your option) any later version.
20  *
21  * This program is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
29  *****************************************************************************/
30
31 /*****************************************************************************
32  * Preamble
33  *****************************************************************************/
34 #include <stdlib.h>
35
36 #include <vlc/vlc.h>
37 #include <vlc_access.h>
38 #include <vlc_network.h>
39
40 #if defined (HAVE_NETINET_UDPLITE_H)
41 # include <netinet/udplite.h>
42 #elif defined (__linux__)
43 # define UDPLITE_SEND_CSCOV     10
44 # define UDPLITE_RECV_CSCOV     11
45 #endif
46
47 #ifndef IPPROTO_UDPLITE
48 # define IPPROTO_UDPLITE 136 /* from IANA */
49 #endif
50 #ifndef SOL_UDPLITE
51 # define SOL_UDPLITE IPPROTO_UDPLITE
52 #endif
53
54
55 /*****************************************************************************
56  * Module descriptor
57  *****************************************************************************/
58 #define CACHING_TEXT N_("Caching value in ms")
59 #define CACHING_LONGTEXT N_( \
60     "Caching value for UDP streams. This " \
61     "value should be set in milliseconds." )
62
63 #define AUTO_MTU_TEXT N_("Autodetection of MTU")
64 #define AUTO_MTU_LONGTEXT N_( \
65     "Automatically detect the line's MTU. This will increase the size if" \
66     " truncated packets are found" )
67
68 #define RTP_LATE_TEXT N_("RTP reordering timeout in ms")
69 #define RTP_LATE_LONGTEXT N_( \
70     "VLC reorders RTP packets. The input will wait for late packets at most "\
71     "the time specified here (in milliseconds)." )
72
73 static int  Open ( vlc_object_t * );
74 static void Close( vlc_object_t * );
75
76 vlc_module_begin();
77     set_shortname( _("UDP/RTP" ) );
78     set_description( _("UDP/RTP input") );
79     set_category( CAT_INPUT );
80     set_subcategory( SUBCAT_INPUT_ACCESS );
81
82     add_integer( "udp-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
83                  CACHING_LONGTEXT, VLC_TRUE );
84     add_integer( "rtp-late", 100, NULL, RTP_LATE_TEXT, RTP_LATE_LONGTEXT, VLC_TRUE );
85
86     add_bool( "udp-auto-mtu", 1, NULL,
87               AUTO_MTU_TEXT, AUTO_MTU_LONGTEXT, VLC_TRUE );
88
89     set_capability( "access2", 0 );
90     add_shortcut( "udp" );
91     add_shortcut( "udpstream" );
92     add_shortcut( "udp4" );
93     add_shortcut( "udp6" );
94     add_shortcut( "rtp" );
95     add_shortcut( "rtp4" );
96     add_shortcut( "rtp6" );
97     add_shortcut( "udplite" );
98
99     set_callbacks( Open, Close );
100 vlc_module_end();
101
102 /*****************************************************************************
103  * Local prototypes
104  *****************************************************************************/
105 #define RTP_HEADER_LEN 12
106
107 static block_t *BlockUDP( access_t * );
108 static block_t *BlockRTP( access_t * );
109 static block_t *BlockChoose( access_t * );
110 static int Control( access_t *, int, va_list );
111
112 struct access_sys_t
113 {
114     int fd;
115
116     int i_mtu;
117     vlc_bool_t b_auto_mtu;
118
119     /* reorder rtp packets when out-of-sequence */
120     mtime_t i_rtp_late;
121     uint16_t i_last_seqno;
122     block_t *p_list;
123     block_t *p_end;
124 };
125
126 /*****************************************************************************
127  * Open: open the socket
128  *****************************************************************************/
129 static int Open( vlc_object_t *p_this )
130 {
131     access_t     *p_access = (access_t*)p_this;
132     access_sys_t *p_sys;
133
134     char *psz_name = strdup( p_access->psz_path );
135     char *psz_parser;
136     const char *psz_server_addr, *psz_bind_addr = "";
137     int  i_bind_port, i_server_port = 0;
138     int fam = AF_UNSPEC, proto = IPPROTO_UDP;
139
140     if (strlen (p_access->psz_access) >= 3)
141     {
142         switch (p_access->psz_access[3])
143         {
144             case '4':
145                 fam = AF_INET;
146                 break;
147
148             case '6':
149                 fam = AF_INET6;
150                 break;
151         }
152         if (strcmp (p_access->psz_access + 3, "lite") == 0)
153             proto = IPPROTO_UDPLITE;
154     }
155
156     i_bind_port = var_CreateGetInteger( p_access, "server-port" );
157
158     /* Parse psz_name syntax :
159      * [serveraddr[:serverport]][@[bindaddr]:[bindport]] */
160     psz_parser = strchr( psz_name, '@' );
161     if( psz_parser != NULL )
162     {
163         /* Found bind address and/or bind port */
164         *psz_parser++ = '\0';
165         psz_bind_addr = psz_parser;
166
167         if( *psz_parser == '[' )
168             /* skips bracket'd IPv6 address */
169             psz_parser = strchr( psz_parser, ']' );
170
171         if( psz_parser != NULL )
172         {
173             psz_parser = strchr( psz_parser, ':' );
174             if( psz_parser != NULL )
175             {
176                 *psz_parser++ = '\0';
177                 i_bind_port = atoi( psz_parser );
178             }
179         }
180     }
181
182     psz_server_addr = psz_name;
183     if( *psz_server_addr == '[' )
184         /* skips bracket'd IPv6 address */
185         psz_parser = strchr( psz_name, ']' );
186
187     if( psz_parser != NULL )
188     {
189         psz_parser = strchr( psz_parser, ':' );
190         if( psz_parser != NULL )
191         {
192             *psz_parser++ = '\0';
193             i_server_port = atoi( psz_parser );
194         }
195     }
196
197     msg_Dbg( p_access, "opening server=%s:%d local=%s:%d",
198              psz_server_addr, i_server_port, psz_bind_addr, i_bind_port );
199
200     /* Set up p_access */
201     access_InitFields( p_access );
202     ACCESS_SET_CALLBACKS( NULL, BlockChoose, Control, NULL );
203     p_access->info.b_prebuffered = VLC_FALSE;
204     MALLOC_ERR( p_access->p_sys, access_sys_t ); p_sys = p_access->p_sys;
205
206     p_sys->fd = net_OpenDgram( p_access, psz_bind_addr, i_bind_port,
207                                psz_server_addr, i_server_port, fam, proto );
208     free (psz_name);
209     if( p_sys->fd == -1 )
210     {
211         msg_Err( p_access, "cannot open socket" );
212         free( p_sys );
213         return VLC_EGENERIC;
214     }
215
216     net_StopSend( p_sys->fd );
217
218 #ifdef UDPLITE_RECV_CSCOV
219     if (proto == IPPROTO_UDPLITE)
220         /* UDP header: 8 bytes + RTP header: 12 bytes (or more) */
221         setsockopt (p_sys->fd, SOL_UDPLITE, UDPLITE_RECV_CSCOV,
222                     &(int){ 20 }, sizeof (int));
223 #endif
224
225     /* FIXME */
226     p_sys->i_mtu = var_CreateGetInteger( p_access, "mtu" );
227     if( p_sys->i_mtu <= 1 )
228         p_sys->i_mtu  = 1500;   /* Avoid problem */
229
230     p_sys->b_auto_mtu = var_CreateGetBool( p_access, "udp-auto-mtu" );;
231
232     /* Update default_pts to a suitable value for udp access */
233     var_Create( p_access, "udp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
234
235     /* RTP reordering for out-of-sequence packets */
236     p_sys->i_rtp_late = var_CreateGetInteger( p_access, "rtp-late" ) * 1000;
237     p_sys->i_last_seqno = 0;
238     p_sys->p_list = NULL;
239     p_sys->p_end = NULL;
240     return VLC_SUCCESS;
241 }
242
243 /*****************************************************************************
244  * Close: free unused data structures
245  *****************************************************************************/
246 static void Close( vlc_object_t *p_this )
247 {
248     access_t     *p_access = (access_t*)p_this;
249     access_sys_t *p_sys = p_access->p_sys;
250
251     block_ChainRelease( p_sys->p_list );
252     net_Close( p_sys->fd );
253     free( p_sys );
254 }
255
256 /*****************************************************************************
257  * Control:
258  *****************************************************************************/
259 static int Control( access_t *p_access, int i_query, va_list args )
260 {
261     access_sys_t *p_sys = p_access->p_sys;
262     vlc_bool_t   *pb_bool;
263     int          *pi_int;
264     int64_t      *pi_64;
265
266     switch( i_query )
267     {
268         /* */
269         case ACCESS_CAN_SEEK:
270         case ACCESS_CAN_FASTSEEK:
271         case ACCESS_CAN_PAUSE:
272         case ACCESS_CAN_CONTROL_PACE:
273             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
274             *pb_bool = VLC_FALSE;
275             break;
276         /* */
277         case ACCESS_GET_MTU:
278             pi_int = (int*)va_arg( args, int * );
279             *pi_int = p_sys->i_mtu;
280             break;
281
282         case ACCESS_GET_PTS_DELAY:
283             pi_64 = (int64_t*)va_arg( args, int64_t * );
284             *pi_64 = var_GetInteger( p_access, "udp-caching" ) * 1000;
285             break;
286
287         /* */
288         case ACCESS_SET_PAUSE_STATE:
289         case ACCESS_GET_TITLE_INFO:
290         case ACCESS_SET_TITLE:
291         case ACCESS_SET_SEEKPOINT:
292         case ACCESS_SET_PRIVATE_ID_STATE:
293             return VLC_EGENERIC;
294
295         default:
296             msg_Warn( p_access, "unimplemented query in control" );
297             return VLC_EGENERIC;
298
299     }
300     return VLC_SUCCESS;
301 }
302
303 /*****************************************************************************
304  * BlockUDP:
305  *****************************************************************************/
306 static block_t *BlockUDP( access_t *p_access )
307 {
308     access_sys_t *p_sys = p_access->p_sys;
309     block_t      *p_block;
310
311     /* Read data */
312     p_block = block_New( p_access, p_sys->i_mtu );
313     p_block->i_buffer = net_Read( p_access, p_sys->fd, NULL,
314                                   p_block->p_buffer, p_sys->i_mtu,
315                                   VLC_FALSE );
316     if( p_block->i_buffer <= 0 )
317     {
318         block_Release( p_block );
319         return NULL;
320     }
321
322     if( (p_block->i_buffer >= p_sys->i_mtu) && p_sys->b_auto_mtu &&
323         p_sys->i_mtu < 32767 )
324     {
325         /* Increase by 100% */
326         p_sys->i_mtu *= 2;
327         msg_Dbg( p_access, "increasing MTU to %d", p_sys->i_mtu );
328     }
329
330     return p_block;
331 }
332
333 /*
334  * rtp_ChainInsert - insert a p_block in the chain and
335  * look at the sequence numbers.
336  */
337 static inline vlc_bool_t rtp_ChainInsert( access_t *p_access, block_t *p_block )
338 {
339     access_sys_t *p_sys = (access_sys_t *) p_access->p_sys;
340     block_t *p_prev = NULL;
341     block_t *p = p_sys->p_end;
342     uint16_t i_new = (uint16_t) p_block->i_dts;
343     uint16_t i_tmp = 0;
344
345     if( !p_sys->p_list )
346     {
347         p_sys->p_list = p_block;
348         p_sys->p_end = p_block;
349         return VLC_TRUE;
350     }
351     /* walk through the queue from top down since the new packet is in 
352     most cases just appended to the end */
353
354     for( ;; )
355     {
356         i_tmp = i_new - (uint16_t) p->i_dts;
357
358         if( !i_tmp )   /* trash duplicate */
359             break; 
360
361         if ( i_tmp < 32768 )
362         {   /* insert after this block ( i_new > p->i_dts ) */
363             p_block->p_next = p->p_next;
364             p->p_next = p_block;
365             p_block->p_prev = p;
366             if (p_prev)
367             {
368                 p_prev->p_prev = p_block;
369                 msg_Dbg(p_access, "RTP reordering: insert after %d, new %d", 
370                     (uint16_t) p->i_dts, i_new );
371             }
372             else 
373             {
374                 p_sys->p_end = p_block;
375             }
376             return VLC_TRUE;
377         }
378         if( p == p_sys->p_list )
379         {   /* we've reached bottom of chain */
380             i_tmp = p_sys->i_last_seqno - i_new;
381             if( !p_access->info.b_prebuffered || (i_tmp > 32767) )
382             {
383                 msg_Dbg(p_access, "RTP reordering: prepend %d before %d", 
384                         i_new, (uint16_t) p->i_dts );
385                 p_block->p_next = p;
386                 p->p_prev = p_block;
387                 p_sys->p_list = p_block;
388                 return VLC_TRUE;
389             }
390
391             if( !i_tmp )   /* trash duplicate */
392                 break;    
393
394             /* reordering failed - append the packet to the end of queue */
395             msg_Dbg(p_access, "RTP: sequence changed (or buffer too small) "
396                 "new: %d, buffer %d...%d", i_new, (uint16_t) p->i_dts, 
397                 (uint16_t) p_sys->p_end->i_dts);
398             p_sys->p_end->p_next = p_block;
399             p_block->p_prev = p_sys->p_end;
400             p_sys->p_end = p_block;
401             return VLC_TRUE;
402         }
403         p_prev = p;
404         p = p->p_prev;
405     }
406     block_Release( p_block );
407     return VLC_FALSE;
408 }
409
410 /*****************************************************************************
411  * BlockParseRTP/BlockRTP:
412  *****************************************************************************/
413 static block_t *BlockParseRTP( access_t *p_access, block_t *p_block )
414 {
415     int      i_rtp_version;
416     int      i_CSRC_count;
417     int      i_payload_type;
418     int      i_skip = 0;
419     int      i_extension_flag = 0;
420     int      i_extension_length = 0;
421     uint16_t i_sequence_number = 0;
422
423     if( p_block == NULL )
424         return NULL;
425
426     if( p_block->i_buffer < RTP_HEADER_LEN )
427         goto trash;
428
429     /* Parse the header and make some verifications.
430      * See RFC 3550. */
431     i_rtp_version     = ( p_block->p_buffer[0] & 0xC0 ) >> 6;
432     i_CSRC_count      = p_block->p_buffer[0] & 0x0F;
433     i_extension_flag  = p_block->p_buffer[0] & 0x10;
434     i_payload_type    = p_block->p_buffer[1] & 0x7F;
435     i_sequence_number = (p_block->p_buffer[2] << 8 ) + p_block->p_buffer[3];
436
437     if( i_rtp_version != 2 )
438         msg_Dbg( p_access, "RTP version is %u, should be 2", i_rtp_version );
439
440     if( i_payload_type == 14 || i_payload_type == 32)
441         i_skip = 4;
442     else if( i_payload_type !=  33 )
443         msg_Dbg( p_access, "unsupported RTP payload type (%u)", i_payload_type );
444     if( i_extension_flag )
445     {
446         if( p_block->i_buffer < 16 )
447             goto trash;
448         i_extension_length = 4 +
449             4 * ( (p_block->p_buffer[14] << 8) + p_block->p_buffer[15] );
450     }
451
452     /* Skip header + CSRC extension field n*(32 bits) + extension */
453     i_skip += RTP_HEADER_LEN + 4*i_CSRC_count + i_extension_length;
454
455     if( i_skip >= p_block->i_buffer )
456         goto trash;
457
458     /* Return the packet without the RTP header, remember seqno in i_dts */
459     p_block->i_buffer -= i_skip;
460     p_block->p_buffer += i_skip;
461     p_block->i_pts = mdate();
462     p_block->i_dts = (mtime_t) i_sequence_number;
463
464 #if 0
465     /* Emulate packet loss */
466     if ( (i_sequence_number % 4000) == 0)
467     {
468         msg_Warn( p_access, "Emulating packet drop" );
469         block_Release( p_block );
470         return NULL;
471     }
472 #endif
473
474     return p_block;
475
476 trash:
477     msg_Warn( p_access, "received a too short packet for RTP" );
478     block_Release( p_block );
479     return NULL;
480 }
481
482 static block_t *BlockPrebufferRTP( access_t *p_access, block_t *p_block )
483 {
484     access_sys_t *p_sys = p_access->p_sys;
485     mtime_t   i_first = mdate();
486     int       i_count = 0;
487     block_t   *p = p_block;
488
489     for( ;; )
490     {
491         mtime_t i_date = mdate();
492
493         if( p && rtp_ChainInsert( p_access, p ))
494             i_count++;
495
496         /* Require at least 2 packets in the buffer */
497         if( i_count > 2 && (i_date - i_first) > p_sys->i_rtp_late )
498             break;
499
500         p = BlockParseRTP( p_access, BlockUDP( p_access ));
501         if( !p && (i_date - i_first) > p_sys->i_rtp_late ) 
502         {
503             msg_Err( p_access, "error in RTP prebuffering!" );
504             break;
505         }
506     }
507
508     msg_Dbg( p_access, "RTP: prebuffered %d packets", i_count - 1 );
509     p_access->info.b_prebuffered = VLC_TRUE;
510     p = p_sys->p_list;
511     p_sys->p_list = p_sys->p_list->p_next;
512     p_sys->i_last_seqno = (uint16_t) p->i_dts;
513     p->p_next = NULL;
514     return p;
515 }
516
517 static block_t *BlockRTP( access_t *p_access )
518 {
519     access_sys_t *p_sys = p_access->p_sys;
520     block_t *p;
521
522     while ( !p_sys->p_list || 
523              ( mdate() - p_sys->p_list->i_pts ) < p_sys->i_rtp_late )
524     {
525         p = BlockParseRTP( p_access, BlockUDP( p_access ));
526
527         if ( !p ) 
528             return NULL;
529
530         rtp_ChainInsert( p_access, p );
531     }
532
533     p = p_sys->p_list;
534     p_sys->p_list = p_sys->p_list->p_next;
535     p_sys->i_last_seqno++;
536     if( p_sys->i_last_seqno != (uint16_t) p->i_dts )
537     {
538         msg_Dbg( p_access, "RTP: packet(s) lost, expected %d, got %d",
539                  p_sys->i_last_seqno, (uint16_t) p->i_dts );
540         p_sys->i_last_seqno = (uint16_t) p->i_dts;
541     }
542     p->p_next = NULL;
543     return p;
544 }
545
546 /*****************************************************************************
547  * BlockChoose: decide between RTP and UDP
548  *****************************************************************************/
549 static block_t *BlockChoose( access_t *p_access )
550 {
551     block_t *p_block;
552     int     i_rtp_version;
553     int     i_CSRC_count;
554     int     i_payload_type;
555
556     if( ( p_block = BlockUDP( p_access ) ) == NULL )
557         return NULL;
558
559     if( p_block->p_buffer[0] == 0x47 )
560     {
561         msg_Dbg( p_access, "detected TS over raw UDP" );
562         p_access->pf_block = BlockUDP;
563         p_access->info.b_prebuffered = VLC_TRUE;
564         return p_block;
565     }
566
567     if( p_block->i_buffer < RTP_HEADER_LEN )
568         return p_block;
569
570     /* Parse the header and make some verifications.
571      * See RFC 3550. */
572
573     i_rtp_version  = ( p_block->p_buffer[0] & 0xC0 ) >> 6;
574     i_CSRC_count   = ( p_block->p_buffer[0] & 0x0F );
575     i_payload_type = ( p_block->p_buffer[1] & 0x7F );
576
577     if( i_rtp_version != 2 )
578     {
579         msg_Dbg( p_access, "no supported RTP header detected" );
580         p_access->pf_block = BlockUDP;
581         p_access->info.b_prebuffered = VLC_TRUE;
582         return p_block;
583     }
584
585     switch( i_payload_type )
586     {
587         case 33:
588             msg_Dbg( p_access, "detected TS over RTP" );
589             p_access->psz_demux = strdup( "ts" );
590             break;
591
592         case 14:
593             msg_Dbg( p_access, "detected MPEG audio over RTP" );
594             p_access->psz_demux = strdup( "mpga" );
595             break;
596
597         case 32:
598             msg_Dbg( p_access, "detected MPEG video over RTP" );
599             p_access->psz_demux = strdup( "mpgv" );
600             break;
601
602         default:
603             msg_Dbg( p_access, "no RTP header detected" );
604             p_access->pf_block = BlockUDP;
605             p_access->info.b_prebuffered = VLC_TRUE;
606             return p_block;
607     }
608
609     if( !BlockParseRTP( p_access, p_block )) return NULL;
610
611     p_access->pf_block = BlockRTP;
612
613     return BlockPrebufferRTP( p_access, p_block );
614 }