Allow block_FifoPut(fifo,NULL)
[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         p_sys = (block_sys_t *)p_block;
128     }
129
130     /* Adjust reserved header if there is enough room */
131     if( p_block->p_buffer - i_prebody > p_sys->p_allocated_buffer &&
132         p_block->p_buffer - i_prebody < p_sys->p_allocated_buffer +
133         p_sys->i_allocated_buffer )
134     {
135         p_block->p_buffer -= i_prebody;
136         p_block->i_buffer += i_prebody;
137         i_prebody = 0;
138     }
139
140     /* Adjust payload size if there is enough room */
141     if( p_block->p_buffer + i_body < p_sys->p_allocated_buffer +
142         p_sys->i_allocated_buffer )
143     {
144         p_block->i_buffer = i_buffer_size;
145         i_body = 0;
146     }
147
148     /* Not enough room, reallocate the buffer */
149     if( i_body > 0 || i_prebody > 0 )
150     {
151         /* FIXME: this is really dumb, we should use realloc() */
152         block_t *p_rea = block_New( NULL, i_buffer_size );
153
154         if( p_rea )
155         {
156             p_rea->i_dts     = p_block->i_dts;
157             p_rea->i_pts     = p_block->i_pts;
158             p_rea->i_flags   = p_block->i_flags;
159             p_rea->i_length  = p_block->i_length;
160             p_rea->i_rate    = p_block->i_rate;
161             p_rea->i_samples = p_block->i_samples;
162
163             memcpy( p_rea->p_buffer + i_prebody, p_block->p_buffer,
164                     __MIN( p_block->i_buffer, p_rea->i_buffer - i_prebody ) );
165         }
166
167         block_Release( p_block );
168
169         return p_rea;
170     }
171
172     /* We have a very large reserved footer now? Release some of it. */
173     if ((p_sys->p_allocated_buffer + p_sys->i_allocated_buffer) -
174         (p_block->p_buffer + p_block->i_buffer) > BLOCK_WASTE_SIZE)
175     {
176         const size_t news = p_block->i_buffer + 2 * BLOCK_PADDING_SIZE + 16;
177         block_sys_t *newb = realloc (p_sys, sizeof (*p_sys) + news);
178
179         if (newb != NULL)
180         {
181             p_sys = newb;
182             p_sys->i_allocated_buffer = news;
183             p_block = &p_sys->self;
184             p_block->p_buffer = p_sys->p_allocated_buffer + BLOCK_PADDING_SIZE
185                 + BLOCK_ALIGN
186                 - ((uintptr_t)p_sys->p_allocated_buffer % BLOCK_ALIGN);
187         }
188     }
189     return p_block;
190 }
191
192 #ifdef HAVE_MMAP
193 # include <sys/mman.h>
194
195 typedef struct block_mmap_t
196 {
197     block_t     self;
198     void       *base_addr;
199     size_t      length;
200 } block_mmap_t;
201
202 static void block_mmap_Release (block_t *block)
203 {
204     block_mmap_t *p_sys = (block_mmap_t *)block;
205
206     munmap (p_sys->base_addr, p_sys->length);
207     free (p_sys);
208 }
209
210 /**
211  * Creates a block from a virtual address memory mapping (mmap).
212  * This is provided by LibVLC so that mmap blocks can safely be deallocated
213  * even after the allocating plugin has been unloaded from memory.
214  *
215  * @param addr base address of the mapping (as returned by mmap)
216  * @param length length (bytes) of the mapping (as passed to mmap)
217  * @return NULL if addr is MAP_FAILED, or an error occurred (in the later
218  * case, munmap(addr, length) is invoked before returning).
219  */
220 block_t *block_mmap_Alloc (void *addr, size_t length)
221 {
222     if (addr == MAP_FAILED)
223         return NULL;
224
225     block_mmap_t *block = malloc (sizeof (*block));
226     if (block == NULL)
227     {
228         munmap (addr, length);
229         return NULL;
230     }
231
232     block_Init (&block->self, (uint8_t *)addr, length);
233     block->self.pf_release = block_mmap_Release;
234     block->base_addr = addr;
235     block->length = length;
236     return &block->self;
237 }
238 #else
239 block_t *block_mmap_Alloc (void *addr, size_t length)
240 {
241     (void)addr; (void)length; return NULL;
242 }
243 #endif
244
245
246 #ifdef WIN32
247 #ifdef UNDER_CE
248 #define _get_osfhandle(a) ((long) (a))
249 #endif
250
251 static
252 ssize_t pread (int fd, void *buf, size_t count, off_t offset)
253 {
254     HANDLE handle = (HANDLE)(intptr_t)_get_osfhandle (fd);
255     if (handle == INVALID_HANDLE_VALUE)
256         return -1;
257
258     OVERLAPPED olap = { .Offset = offset, .OffsetHigh = (offset >> 32), };
259     DWORD written;
260     /* This braindead API will override the file pointer even if we specify
261      * an explicit read offset... So do not expect this to mix well with
262      * regular read() calls. */
263     if (ReadFile (handle, buf, count, &written, &olap))
264         return written;
265     return -1;
266 }
267 #endif
268
269 /**
270  * Loads a file into a block of memory. If possible a private file mapping is
271  * created. Otherwise, the file is read normally. On 32-bits platforms, this
272  * function will not work for very large files, due to memory space
273  * constraints. Cancellation point.
274  *
275  * @param fd file descriptor to load from
276  * @return a new block with the file content at p_buffer, and file length at
277  * i_buffer (release it with block_Release()), or NULL upon error (see errno).
278  */
279 block_t *block_File (int fd)
280 {
281     size_t length;
282     struct stat st;
283
284     /* First, get the file size */
285     if (fstat (fd, &st))
286         return NULL;
287
288     /* st_size is meaningful for regular files, shared memory and typed memory.
289      * It's also meaning for symlinks, but that's not possible with fstat().
290      * In other cases, it's undefined, and we should really not go further. */
291 #ifndef S_TYPEISSHM
292 # define S_TYPEISSHM( buf ) (0)
293 #endif
294     if (S_ISDIR (st.st_mode))
295     {
296         errno = EISDIR;
297         return NULL;
298     }
299     if (!S_ISREG (st.st_mode) && !S_TYPEISSHM (&st))
300     {
301         errno = ESPIPE;
302         return NULL;
303     }
304
305     /* Prevent an integer overflow in mmap() and malloc() */
306     if (st.st_size >= SIZE_MAX)
307     {
308         errno = ENOMEM;
309         return NULL;
310     }
311     length = (size_t)st.st_size;
312
313 #ifdef HAVE_MMAP
314     if (length > 0)
315     {
316         void *addr;
317
318         addr = mmap (NULL, length, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
319         if (addr != MAP_FAILED)
320             return block_mmap_Alloc (addr, length);
321     }
322 #endif
323
324     /* If mmap() is not implemented by the OS _or_ the filesystem... */
325     block_t *block = block_Alloc (length);
326     if (block == NULL)
327         return NULL;
328     block_cleanup_push (block);
329
330     for (size_t i = 0; i < length;)
331     {
332         ssize_t len = pread (fd, block->p_buffer + i, length - i, i);
333         if (len == -1)
334         {
335             block_Release (block);
336             block = NULL;
337             break;
338         }
339         i += len;
340     }
341     vlc_cleanup_pop ();
342     return block;
343 }
344
345 /*****************************************************************************
346  * block_fifo_t management
347  *****************************************************************************/
348 struct block_fifo_t
349 {
350     vlc_mutex_t         lock;                         /* fifo data lock */
351     vlc_cond_t          wait;         /* fifo data conditional variable */
352
353     block_t             *p_first;
354     block_t             **pp_last;
355     size_t              i_depth;
356     size_t              i_size;
357     bool          b_force_wake;
358 };
359
360 block_fifo_t *block_FifoNew( void )
361 {
362     block_fifo_t *p_fifo = malloc( sizeof( block_fifo_t ) );
363     if( !p_fifo )
364         return NULL;
365
366     vlc_mutex_init( &p_fifo->lock );
367     vlc_cond_init( &p_fifo->wait );
368     p_fifo->p_first = NULL;
369     p_fifo->pp_last = &p_fifo->p_first;
370     p_fifo->i_depth = p_fifo->i_size = 0;
371     p_fifo->b_force_wake = false;
372
373     return p_fifo;
374 }
375
376 void block_FifoRelease( block_fifo_t *p_fifo )
377 {
378     block_FifoEmpty( p_fifo );
379     vlc_cond_destroy( &p_fifo->wait );
380     vlc_mutex_destroy( &p_fifo->lock );
381     free( p_fifo );
382 }
383
384 void block_FifoEmpty( block_fifo_t *p_fifo )
385 {
386     block_t *b;
387
388     vlc_mutex_lock( &p_fifo->lock );
389     for( b = p_fifo->p_first; b != NULL; )
390     {
391         block_t *p_next;
392
393         p_next = b->p_next;
394         block_Release( b );
395         b = p_next;
396     }
397
398     p_fifo->i_depth = p_fifo->i_size = 0;
399     p_fifo->p_first = NULL;
400     p_fifo->pp_last = &p_fifo->p_first;
401     vlc_mutex_unlock( &p_fifo->lock );
402 }
403
404 /**
405  * Immediately queue one block at the end of a FIFO.
406  * @param fifo queue
407  * @param block head of a block list to queue (may be NULL)
408  */
409 size_t block_FifoPut( block_fifo_t *p_fifo, block_t *p_block )
410 {
411     size_t i_size = 0;
412     vlc_mutex_lock( &p_fifo->lock );
413
414     while (p_block != NULL)
415     {
416         i_size += p_block->i_buffer;
417
418         *p_fifo->pp_last = p_block;
419         p_fifo->pp_last = &p_block->p_next;
420         p_fifo->i_depth++;
421         p_fifo->i_size += p_block->i_buffer;
422
423         p_block = p_block->p_next;
424     }
425
426     /* We queued one block: wake up one read-waiting thread */
427     vlc_cond_signal( &p_fifo->wait );
428     vlc_mutex_unlock( &p_fifo->lock );
429
430     return i_size;
431 }
432
433 void block_FifoWake( block_fifo_t *p_fifo )
434 {
435     vlc_mutex_lock( &p_fifo->lock );
436     if( p_fifo->p_first == NULL )
437         p_fifo->b_force_wake = true;
438     vlc_cond_broadcast( &p_fifo->wait );
439     vlc_mutex_unlock( &p_fifo->lock );
440 }
441
442 block_t *block_FifoGet( block_fifo_t *p_fifo )
443 {
444     block_t *b;
445
446     vlc_mutex_lock( &p_fifo->lock );
447     mutex_cleanup_push( &p_fifo->lock );
448
449     /* Remember vlc_cond_wait() may cause spurious wakeups
450      * (on both Win32 and POSIX) */
451     while( ( p_fifo->p_first == NULL ) && !p_fifo->b_force_wake )
452         vlc_cond_wait( &p_fifo->wait, &p_fifo->lock );
453
454     vlc_cleanup_pop();
455     b = p_fifo->p_first;
456
457     p_fifo->b_force_wake = false;
458     if( b == NULL )
459     {
460         /* Forced wakeup */
461         vlc_mutex_unlock( &p_fifo->lock );
462         return NULL;
463     }
464
465     p_fifo->p_first = b->p_next;
466     p_fifo->i_depth--;
467     p_fifo->i_size -= b->i_buffer;
468
469     if( p_fifo->p_first == NULL )
470     {
471         p_fifo->pp_last = &p_fifo->p_first;
472     }
473
474     vlc_mutex_unlock( &p_fifo->lock );
475
476     b->p_next = NULL;
477     return b;
478 }
479
480 block_t *block_FifoShow( block_fifo_t *p_fifo )
481 {
482     block_t *b;
483
484     vlc_mutex_lock( &p_fifo->lock );
485     mutex_cleanup_push( &p_fifo->lock );
486
487     if( p_fifo->p_first == NULL )
488         vlc_cond_wait( &p_fifo->wait, &p_fifo->lock );
489
490     b = p_fifo->p_first;
491
492     vlc_cleanup_run ();
493     return b;
494 }
495
496 /* FIXME: not thread-safe */
497 size_t block_FifoSize( const block_fifo_t *p_fifo )
498 {
499     return p_fifo->i_size;
500 }
501
502 /* FIXME: not thread-safe */
503 size_t block_FifoCount( const block_fifo_t *p_fifo )
504 {
505     return p_fifo->i_depth;
506 }