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