Fix flexible array usage gcc-ism
[vlc.git] / src / misc / block.c
1 /*****************************************************************************
2  * block.c: Data blocks management functions
3  *****************************************************************************
4  * Copyright (C) 2003-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include <sys/stat.h>
33 #include "vlc_block.h"
34
35 /*****************************************************************************
36  * Block functions.
37  *****************************************************************************/
38 /* private */
39 struct block_sys_t
40 {
41     block_t     self;
42     size_t      i_allocated_buffer;
43     uint8_t     p_allocated_buffer[];
44 };
45
46 #ifndef NDEBUG
47 static void BlockNoRelease( block_t *b )
48 {
49     fprintf( stderr, "block %p has no release callback! This is a bug!\n", b );
50     abort();
51 }
52 #endif
53
54 void block_Init( block_t *restrict b, void *buf, size_t size )
55 {
56     /* Fill all fields to their default */
57     b->p_next = b->p_prev = NULL;
58     b->i_flags = 0;
59     b->i_pts = b->i_dts = b->i_length = 0;
60     b->i_rate = 0;
61     b->p_buffer = buf;
62     b->i_buffer = size;
63 #ifndef NDEBUG
64     b->pf_release = BlockNoRelease;
65 #endif
66 }
67
68 static void BlockRelease( block_t *p_block )
69 {
70     free( p_block );
71 }
72
73 /* Memory alignment */
74 #define BLOCK_ALIGN        16
75 /* Initial size of reserved header and footer */
76 #define BLOCK_PADDING_SIZE 32
77 /* Maximum size of reserved footer before we release with realloc() */
78 #define BLOCK_WASTE_SIZE   2048
79
80 block_t *block_Alloc( size_t i_size )
81 {
82     /* We do only one malloc
83      * TODO: bench if doing 2 malloc but keeping a pool of buffer is better
84      * TODO: use memalign
85      * 16 -> align on 16
86      * 2 * BLOCK_PADDING_SIZE -> pre + post padding
87      */
88     const size_t i_alloc = i_size + 2 * BLOCK_PADDING_SIZE + BLOCK_ALIGN;
89     block_sys_t *p_sys = malloc( sizeof( *p_sys ) + i_alloc );
90
91     if( p_sys == NULL )
92         return NULL;
93
94     /* Fill opaque data */
95     p_sys->i_allocated_buffer = i_alloc;
96
97     block_Init( &p_sys->self, p_sys->p_allocated_buffer + BLOCK_PADDING_SIZE
98                 + BLOCK_ALIGN
99                 - ((uintptr_t)p_sys->p_allocated_buffer % BLOCK_ALIGN),
100                 i_size );
101     p_sys->self.pf_release    = BlockRelease;
102
103     return &p_sys->self;
104 }
105
106 block_t *block_Realloc( block_t *p_block, ssize_t i_prebody, size_t i_body )
107 {
108     block_sys_t *p_sys = (block_sys_t *)p_block;
109     ssize_t i_buffer_size = i_prebody + i_body;
110
111     if( i_buffer_size <= 0 )
112     {
113         block_Release( p_block );
114         return NULL;
115     }
116
117     if( p_block->pf_release != BlockRelease )
118     {
119         /* Special case when pf_release if overloaded
120          * TODO if used one day, then implement it in a smarter way */
121         block_t *p_dup = block_Duplicate( p_block );
122         block_Release( p_block );
123         if( !p_dup )
124             return NULL;
125
126         p_block = p_dup;
127     }
128
129     /* Adjust reserved header if there is enough room */
130     if( p_block->p_buffer - i_prebody > p_sys->p_allocated_buffer &&
131         p_block->p_buffer - i_prebody < p_sys->p_allocated_buffer +
132         p_sys->i_allocated_buffer )
133     {
134         p_block->p_buffer -= i_prebody;
135         p_block->i_buffer += i_prebody;
136         i_prebody = 0;
137     }
138
139     /* Adjust payload size if there is enough room */
140     if( p_block->p_buffer + i_body < p_sys->p_allocated_buffer +
141         p_sys->i_allocated_buffer )
142     {
143         p_block->i_buffer = i_buffer_size;
144         i_body = 0;
145     }
146
147     /* Not enough room, reallocate the buffer */
148     if( i_body > 0 || i_prebody > 0 )
149     {
150         /* FIXME: this is really dumb, we should use realloc() */
151         block_t *p_rea = block_New( NULL, i_buffer_size );
152
153         if( p_rea )
154         {
155             p_rea->i_dts     = p_block->i_dts;
156             p_rea->i_pts     = p_block->i_pts;
157             p_rea->i_flags   = p_block->i_flags;
158             p_rea->i_length  = p_block->i_length;
159             p_rea->i_rate    = p_block->i_rate;
160             p_rea->i_samples = p_block->i_samples;
161
162             memcpy( p_rea->p_buffer + i_prebody, p_block->p_buffer,
163                     __MIN( p_block->i_buffer, p_rea->i_buffer - i_prebody ) );
164         }
165
166         block_Release( p_block );
167
168         return p_rea;
169     }
170
171     /* We have a very large reserved footer now? Release some of it. */
172     if ((p_sys->p_allocated_buffer + p_sys->i_allocated_buffer) -
173         (p_block->p_buffer + p_block->i_buffer) > BLOCK_WASTE_SIZE)
174     {
175         const size_t news = p_block->i_buffer + 2 * BLOCK_PADDING_SIZE + 16;
176         block_sys_t *newb = realloc (p_sys, sizeof (*p_sys) + news);
177
178         if (newb != NULL)
179         {
180             p_sys = newb;
181             p_sys->i_allocated_buffer = news;
182             p_block = &p_sys->self;
183             p_block->p_buffer = p_sys->p_allocated_buffer + BLOCK_PADDING_SIZE
184                 + BLOCK_ALIGN
185                 - ((uintptr_t)p_sys->p_allocated_buffer % BLOCK_ALIGN);
186         }
187     }
188     return p_block;
189 }
190
191 #ifdef HAVE_MMAP
192 # include <sys/mman.h>
193
194 typedef struct block_mmap_t
195 {
196     block_t     self;
197     void       *base_addr;
198     size_t      length;
199 } block_mmap_t;
200
201 static void block_mmap_Release (block_t *block)
202 {
203     block_mmap_t *p_sys = (block_mmap_t *)block;
204
205     munmap (p_sys->base_addr, p_sys->length);
206     free (p_sys);
207 }
208
209 /**
210  * Creates a block from a virtual address memory mapping (mmap).
211  * This is provided by LibVLC so that mmap blocks can safely be deallocated
212  * even after the allocating plugin has been unloaded from memory.
213  *
214  * @param addr base address of the mapping (as returned by mmap)
215  * @param length length (bytes) of the mapping (as passed to mmap)
216  * @return NULL if addr is MAP_FAILED, or an error occurred (in the later
217  * case, munmap(addr, length) is invoked before returning).
218  */
219 block_t *block_mmap_Alloc (void *addr, size_t length)
220 {
221     if (addr == MAP_FAILED)
222         return NULL;
223
224     block_mmap_t *block = malloc (sizeof (*block));
225     if (block == NULL)
226     {
227         munmap (addr, length);
228         return NULL;
229     }
230
231     block_Init (&block->self, (uint8_t *)addr, length);
232     block->self.pf_release = block_mmap_Release;
233     block->base_addr = addr;
234     block->length = length;
235     return &block->self;
236 }
237 #else
238 block_t *block_mmap_Alloc (void *addr, size_t length)
239 {
240     (void)addr; (void)length; return NULL;
241 }
242 #endif
243
244
245 #ifdef WIN32
246 static
247 ssize_t pread (int fd, void *buf, size_t count, off_t offset)
248 {
249     HANDLE handle = (HANDLE)(intptr_t)_get_osfhandle (fd);
250     if (handle == INVALID_HANDLE_VALUE)
251         return -1;
252
253     OVERLAPPED olap = { .Offset = offset, .OffsetHigh = (offset >> 32), };
254     DWORD written;
255     /* This braindead API will override the file pointer even if we specify
256      * an explicit read offset... So do not expect this to mix well with
257      * regular read() calls. */
258     if (ReadFile (handle, buf, count, &written, &olap))
259         return written;
260     return -1;
261 }
262 #endif
263
264 /**
265  * Loads a file into a block of memory. If possible a private file mapping is
266  * created. Otherwise, the file is read normally. On 32-bits platforms, this
267  * function will not work for very large files, due to memory space
268  * constraints. Cancellation point.
269  *
270  * @param fd file descriptor to load from
271  * @return a new block with the file content at p_buffer, and file length at
272  * i_buffer (release it with block_Release()), or NULL upon error (see errno).
273  */
274 block_t *block_File (int fd)
275 {
276     size_t length;
277     struct stat st;
278
279     /* First, get the file size */
280     if (fstat (fd, &st))
281         return NULL;
282
283     /* st_size is meaningful for regular files, shared memory and typed memory.
284      * It's also meaning for symlinks, but that's not possible with fstat().
285      * In other cases, it's undefined, and we should really not go further. */
286 #ifndef S_TYPEISSHM
287 # define S_TYPEISSHM( buf ) (0)
288 #endif
289     if (S_ISDIR (st.st_mode))
290     {
291         errno = EISDIR;
292         return NULL;
293     }
294     if (!S_ISREG (st.st_mode) && !S_TYPEISSHM (&st))
295     {
296         errno = ESPIPE;
297         return NULL;
298     }
299
300     /* Prevent an integer overflow in mmap() and malloc() */
301     if (st.st_size >= SIZE_MAX)
302     {
303         errno = ENOMEM;
304         return NULL;
305     }
306     length = (size_t)st.st_size;
307
308 #ifdef HAVE_MMAP
309     if (length > 0)
310     {
311         void *addr;
312
313         addr = mmap (NULL, length, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
314         if (addr != MAP_FAILED)
315             return block_mmap_Alloc (addr, length);
316     }
317 #endif
318
319     /* If mmap() is not implemented by the OS _or_ the filesystem... */
320     block_t *block = block_Alloc (length);
321     if (block == NULL)
322         return NULL;
323     block_cleanup_push (block);
324
325     for (size_t i = 0; i < length;)
326     {
327         ssize_t len = pread (fd, block->p_buffer + i, length - i, i);
328         if (len == -1)
329         {
330             block_Release (block);
331             block = NULL;
332             break;
333         }
334         i += len;
335     }
336     vlc_cleanup_pop ();
337     return block;
338 }
339
340 /*****************************************************************************
341  * block_fifo_t management
342  *****************************************************************************/
343 struct block_fifo_t
344 {
345     vlc_mutex_t         lock;                         /* fifo data lock */
346     vlc_cond_t          wait;         /* fifo data conditional variable */
347
348     block_t             *p_first;
349     block_t             **pp_last;
350     size_t              i_depth;
351     size_t              i_size;
352     bool          b_force_wake;
353 };
354
355 block_fifo_t *block_FifoNew( void )
356 {
357     block_fifo_t *p_fifo = malloc( sizeof( block_fifo_t ) );
358     if( !p_fifo )
359         return NULL;
360
361     vlc_mutex_init( &p_fifo->lock );
362     vlc_cond_init( &p_fifo->wait );
363     p_fifo->p_first = NULL;
364     p_fifo->pp_last = &p_fifo->p_first;
365     p_fifo->i_depth = p_fifo->i_size = 0;
366     p_fifo->b_force_wake = false;
367
368     return p_fifo;
369 }
370
371 void block_FifoRelease( block_fifo_t *p_fifo )
372 {
373     block_FifoEmpty( p_fifo );
374     vlc_cond_destroy( &p_fifo->wait );
375     vlc_mutex_destroy( &p_fifo->lock );
376     free( p_fifo );
377 }
378
379 void block_FifoEmpty( block_fifo_t *p_fifo )
380 {
381     block_t *b;
382
383     vlc_mutex_lock( &p_fifo->lock );
384     for( b = p_fifo->p_first; b != NULL; )
385     {
386         block_t *p_next;
387
388         p_next = b->p_next;
389         block_Release( b );
390         b = p_next;
391     }
392
393     p_fifo->i_depth = p_fifo->i_size = 0;
394     p_fifo->p_first = NULL;
395     p_fifo->pp_last = &p_fifo->p_first;
396     vlc_mutex_unlock( &p_fifo->lock );
397 }
398
399 size_t block_FifoPut( block_fifo_t *p_fifo, block_t *p_block )
400 {
401     size_t i_size = 0;
402     vlc_mutex_lock( &p_fifo->lock );
403
404     do
405     {
406         i_size += p_block->i_buffer;
407
408         *p_fifo->pp_last = p_block;
409         p_fifo->pp_last = &p_block->p_next;
410         p_fifo->i_depth++;
411         p_fifo->i_size += p_block->i_buffer;
412
413         p_block = p_block->p_next;
414
415     } while( p_block );
416
417     /* warn there is data in this fifo */
418     vlc_cond_signal( &p_fifo->wait );
419     vlc_mutex_unlock( &p_fifo->lock );
420
421     return i_size;
422 }
423
424 void block_FifoWake( block_fifo_t *p_fifo )
425 {
426     vlc_mutex_lock( &p_fifo->lock );
427     if( p_fifo->p_first == NULL )
428         p_fifo->b_force_wake = true;
429     vlc_cond_signal( &p_fifo->wait );
430     vlc_mutex_unlock( &p_fifo->lock );
431 }
432
433 block_t *block_FifoGet( block_fifo_t *p_fifo )
434 {
435     block_t *b;
436
437     vlc_mutex_lock( &p_fifo->lock );
438     mutex_cleanup_push( &p_fifo->lock );
439
440     /* Remember vlc_cond_wait() may cause spurious wakeups
441      * (on both Win32 and POSIX) */
442     while( ( p_fifo->p_first == NULL ) && !p_fifo->b_force_wake )
443         vlc_cond_wait( &p_fifo->wait, &p_fifo->lock );
444
445     vlc_cleanup_pop();
446     b = p_fifo->p_first;
447
448     p_fifo->b_force_wake = false;
449     if( b == NULL )
450     {
451         /* Forced wakeup */
452         vlc_mutex_unlock( &p_fifo->lock );
453         return NULL;
454     }
455
456     p_fifo->p_first = b->p_next;
457     p_fifo->i_depth--;
458     p_fifo->i_size -= b->i_buffer;
459
460     if( p_fifo->p_first == NULL )
461     {
462         p_fifo->pp_last = &p_fifo->p_first;
463     }
464
465     vlc_mutex_unlock( &p_fifo->lock );
466
467     b->p_next = NULL;
468     return b;
469 }
470
471 block_t *block_FifoShow( block_fifo_t *p_fifo )
472 {
473     block_t *b;
474
475     vlc_mutex_lock( &p_fifo->lock );
476     mutex_cleanup_push( &p_fifo->lock );
477
478     if( p_fifo->p_first == NULL )
479         vlc_cond_wait( &p_fifo->wait, &p_fifo->lock );
480
481     b = p_fifo->p_first;
482
483     vlc_cleanup_run ();
484     return b;
485 }
486
487 /* FIXME: not thread-safe */
488 size_t block_FifoSize( const block_fifo_t *p_fifo )
489 {
490     return p_fifo->i_size;
491 }
492
493 /* FIXME: not thread-safe */
494 size_t block_FifoCount( const block_fifo_t *p_fifo )
495 {
496     return p_fifo->i_depth;
497 }