Do not shrink allocated blocks.
[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[0];
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 #if 0
172     /* Shrinking the buffer seems to cause performance problems, on Windows,
173      * at least. Also with demand paging, oversizing buffers is not an issue,
174      * as long as we don't write to the extraneous allocated space. */
175     /* We have a very large reserved footer now? Release some of it. */
176     if ((p_sys->p_allocated_buffer + p_sys->i_allocated_buffer) -
177         (p_block->p_buffer + p_block->i_buffer) > BLOCK_WASTE_SIZE)
178     {
179         const size_t news = p_block->i_buffer + 2 * BLOCK_PADDING_SIZE + 16;
180         block_sys_t *newb = realloc (p_sys, sizeof (*p_sys) + news);
181
182         if (newb != NULL)
183         {
184             p_sys = newb;
185             p_sys->i_allocated_buffer = news;
186             p_block = &p_sys->self;
187             p_block->p_buffer = p_sys->p_allocated_buffer + BLOCK_PADDING_SIZE
188                 + BLOCK_ALIGN
189                 - ((uintptr_t)p_sys->p_allocated_buffer % BLOCK_ALIGN);
190         }
191     }
192 #endif
193     return p_block;
194 }
195
196 #ifdef HAVE_MMAP
197 # include <sys/mman.h>
198
199 typedef struct block_mmap_t
200 {
201     block_t     self;
202     void       *base_addr;
203     size_t      length;
204 } block_mmap_t;
205
206 static void block_mmap_Release (block_t *block)
207 {
208     block_mmap_t *p_sys = (block_mmap_t *)block;
209
210     munmap (p_sys->base_addr, p_sys->length);
211     free (p_sys);
212 }
213
214 /**
215  * Creates a block from a virtual address memory mapping (mmap).
216  * This is provided by LibVLC so that mmap blocks can safely be deallocated
217  * even after the allocating plugin has been unloaded from memory.
218  *
219  * @param addr base address of the mapping (as returned by mmap)
220  * @param length length (bytes) of the mapping (as passed to mmap)
221  * @return NULL if addr is MAP_FAILED, or an error occurred (in the later
222  * case, munmap(addr, length) is invoked before returning).
223  */
224 block_t *block_mmap_Alloc (void *addr, size_t length)
225 {
226     if (addr == MAP_FAILED)
227         return NULL;
228
229     block_mmap_t *block = malloc (sizeof (*block));
230     if (block == NULL)
231     {
232         munmap (addr, length);
233         return NULL;
234     }
235
236     block_Init (&block->self, (uint8_t *)addr, length);
237     block->self.pf_release = block_mmap_Release;
238     block->base_addr = addr;
239     block->length = length;
240     return &block->self;
241 }
242 #else
243 block_t *block_mmap_Alloc (void *addr, size_t length)
244 {
245     (void)addr; (void)length; return NULL;
246 }
247 #endif
248
249
250 #ifdef WIN32
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.
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
329     for (size_t i = 0; i < length;)
330     {
331         ssize_t len = pread (fd, block->p_buffer + i, length - i, i);
332         if (len == -1)
333         {
334             block_Release (block);
335             return NULL;
336         }
337         i += len;
338     }
339     return block;
340 }
341
342 /*****************************************************************************
343  * block_fifo_t management
344  *****************************************************************************/
345 struct block_fifo_t
346 {
347     vlc_mutex_t         lock;                         /* fifo data lock */
348     vlc_cond_t          wait;         /* fifo data conditional variable */
349
350     block_t             *p_first;
351     block_t             **pp_last;
352     size_t              i_depth;
353     size_t              i_size;
354     bool          b_force_wake;
355 };
356
357 block_fifo_t *block_FifoNew( void )
358 {
359     block_fifo_t *p_fifo = malloc( sizeof( block_fifo_t ) );
360     if( !p_fifo )
361         return NULL;
362
363     vlc_mutex_init( &p_fifo->lock );
364     vlc_cond_init( NULL, &p_fifo->wait );
365     p_fifo->p_first = NULL;
366     p_fifo->pp_last = &p_fifo->p_first;
367     p_fifo->i_depth = p_fifo->i_size = 0;
368     p_fifo->b_force_wake = false;
369
370     return p_fifo;
371 }
372
373 void block_FifoRelease( block_fifo_t *p_fifo )
374 {
375     block_FifoEmpty( p_fifo );
376     vlc_cond_destroy( &p_fifo->wait );
377     vlc_mutex_destroy( &p_fifo->lock );
378     free( p_fifo );
379 }
380
381 void block_FifoEmpty( block_fifo_t *p_fifo )
382 {
383     block_t *b;
384
385     vlc_mutex_lock( &p_fifo->lock );
386     for( b = p_fifo->p_first; b != NULL; )
387     {
388         block_t *p_next;
389
390         p_next = b->p_next;
391         block_Release( b );
392         b = p_next;
393     }
394
395     p_fifo->i_depth = p_fifo->i_size = 0;
396     p_fifo->p_first = NULL;
397     p_fifo->pp_last = &p_fifo->p_first;
398     vlc_mutex_unlock( &p_fifo->lock );
399 }
400
401 size_t block_FifoPut( block_fifo_t *p_fifo, block_t *p_block )
402 {
403     size_t i_size = 0;
404     vlc_mutex_lock( &p_fifo->lock );
405
406     do
407     {
408         i_size += p_block->i_buffer;
409
410         *p_fifo->pp_last = p_block;
411         p_fifo->pp_last = &p_block->p_next;
412         p_fifo->i_depth++;
413         p_fifo->i_size += p_block->i_buffer;
414
415         p_block = p_block->p_next;
416
417     } while( p_block );
418
419     /* warn there is data in this fifo */
420     vlc_cond_signal( &p_fifo->wait );
421     vlc_mutex_unlock( &p_fifo->lock );
422
423     return i_size;
424 }
425
426 void block_FifoWake( block_fifo_t *p_fifo )
427 {
428     vlc_mutex_lock( &p_fifo->lock );
429     if( p_fifo->p_first == NULL )
430         p_fifo->b_force_wake = true;
431     vlc_cond_signal( &p_fifo->wait );
432     vlc_mutex_unlock( &p_fifo->lock );
433 }
434
435 block_t *block_FifoGet( block_fifo_t *p_fifo )
436 {
437     block_t *b;
438
439     vlc_mutex_lock( &p_fifo->lock );
440
441     /* Remember vlc_cond_wait() may cause spurious wakeups
442      * (on both Win32 and POSIX) */
443     while( ( p_fifo->p_first == NULL ) && !p_fifo->b_force_wake )
444     {
445         vlc_cond_wait( &p_fifo->wait, &p_fifo->lock );
446     }
447
448     b = p_fifo->p_first;
449
450     p_fifo->b_force_wake = false;
451     if( b == NULL )
452     {
453         /* Forced wakeup */
454         vlc_mutex_unlock( &p_fifo->lock );
455         return NULL;
456     }
457
458     p_fifo->p_first = b->p_next;
459     p_fifo->i_depth--;
460     p_fifo->i_size -= b->i_buffer;
461
462     if( p_fifo->p_first == NULL )
463     {
464         p_fifo->pp_last = &p_fifo->p_first;
465     }
466
467     vlc_mutex_unlock( &p_fifo->lock );
468
469     b->p_next = NULL;
470     return b;
471 }
472
473 block_t *block_FifoShow( block_fifo_t *p_fifo )
474 {
475     block_t *b;
476
477     vlc_mutex_lock( &p_fifo->lock );
478
479     if( p_fifo->p_first == NULL )
480     {
481         vlc_cond_wait( &p_fifo->wait, &p_fifo->lock );
482     }
483
484     b = p_fifo->p_first;
485
486     vlc_mutex_unlock( &p_fifo->lock );
487
488     return( b );
489 }
490
491 size_t block_FifoSize( const block_fifo_t *p_fifo )
492 {
493     return p_fifo->i_size;
494 }
495
496 size_t block_FifoCount( const block_fifo_t *p_fifo )
497 {
498     return p_fifo->i_depth;
499 }