git.sesse.net Git - vlc/blob - modules/access/mmap.c

   1 /*****************************************************************************
   2  * mmap.c: memory-mapped file input
   3  *****************************************************************************
   4  * Copyright © 2007-2008 Rémi Denis-Courmont
   5  * $Id$
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  20  *****************************************************************************/
  21
  22 #ifdef HAVE_CONFIG_H
  23 # include <config.h>
  24 #endif
  25
  26 #include <vlc_common.h>
  27 #include <vlc_plugin.h>
  28 #include <vlc_access.h>
  29 #include <vlc_input.h>
  30 #include <vlc_charset.h>
  31 #include <vlc_interface.h>
  32
  33 #include <assert.h>
  34
  35 #include <errno.h>
  36 #include <sys/types.h>
  37 #include <unistd.h>
  38 #include <fcntl.h>
  39 #include <sys/stat.h>
  40 #include <sys/mman.h>
  41
  42 #define FILE_MMAP_TEXT N_("Use file memory mapping")
  43 #define FILE_MMAP_LONGTEXT N_( \
  44     "Try to use memory mapping to read files and block devices." )
  45
  46 #ifndef NDEBUG
  47 /*# define MMAP_DEBUG 1*/
  48 #endif
  49
  50 static int Open (vlc_object_t *);
  51 static void Close (vlc_object_t *);
  52
  53 vlc_module_begin();
  54     set_shortname (N_("MMap"));
  55     set_description (N_("Memory-mapped file input"));
  56     set_category (CAT_INPUT);
  57     set_subcategory (SUBCAT_INPUT_ACCESS);
  58     set_capability ("access", 52);
  59     add_shortcut ("file");
  60     set_callbacks (Open, Close);
  61 #ifdef __APPLE__
  62     add_bool ("file-mmap", false, NULL,
  63 #else
  64     add_bool ("file-mmap", true, NULL,
  65 #endif
  66               FILE_MMAP_TEXT, FILE_MMAP_LONGTEXT, true);
  67 vlc_module_end();
  68
  69 static block_t *Block (access_t *);
  70 static int Seek (access_t *, int64_t);
  71 static int Control (access_t *, int, va_list);
  72
  73 struct access_sys_t
  74 {
  75     size_t page_size;
  76     size_t mtu;
  77     int    fd;
  78 };
  79
  80 #define MMAP_SIZE (1 << 20)
  81
  82 static int Open (vlc_object_t *p_this)
  83 {
  84     access_t *p_access = (access_t *)p_this;
  85     access_sys_t *p_sys;
  86     const char *path = p_access->psz_path;
  87     int fd;
  88
  89     if (!var_CreateGetBool (p_this, "file-mmap"))
  90         return VLC_EGENERIC; /* disabled */
  91
  92     STANDARD_BLOCK_ACCESS_INIT;
  93
  94     if (!strcmp (p_access->psz_path, "-"))
  95         fd = dup (0);
  96     else
  97     {
  98         msg_Dbg (p_access, "opening file %s", path);
  99         fd = utf8_open (path, O_RDONLY | O_NOCTTY, 0666);
 100     }
 101
 102     if (fd == -1)
 103     {
 104         msg_Warn (p_access, "cannot open %s: %m", path);
 105         goto error;
 106     }
 107
 108     /* mmap() is only safe for regular and block special files.
 109      * For other types, it may be some idiosyncrasic interface (e.g. packet
 110      * sockets are a good example), if it works at all. */
 111     struct stat st;
 112
 113     if (fstat (fd, &st))
 114     {
 115         msg_Err (p_access, "cannot stat %s: %m", path);
 116         goto error;
 117     }
 118
 119     if (!S_ISREG (st.st_mode) && !S_ISBLK (st.st_mode))
 120     {
 121         msg_Dbg (p_access, "skipping non regular file %s", path);
 122         goto error;
 123     }
 124
 125 #if defined(HAVE_FCNTL_H)
 126     /* We'd rather use any available memory for reading ahead
 127      * than for caching what we've already mmap'ed */
 128 # if defined(F_RDAHEAD)
 129     fcntl (fd, F_RDAHEAD, 1);
 130 # endif
 131 # if defined(F_NOCACHE)
 132     fcntl (fd, F_NOCACHE, 1);
 133 # endif
 134 #endif
 135
 136     /* Autodetect mmap() support */
 137     if (st.st_size > 0)
 138     {
 139         int flags = MAP_PRIVATE;
 140 #if defined(MAP_NOCACHE)
 141         flags |= MAP_NOCACHE;
 142 #endif
 143
 144         void *addr = mmap (NULL, 1, PROT_READ|PROT_WRITE, flags, fd, 0);
 145         if (addr != MAP_FAILED)
 146             munmap (addr, 1);
 147         else
 148             goto error;
 149     }
 150
 151     p_sys->page_size = sysconf (_SC_PAGE_SIZE);
 152     p_sys->mtu = MMAP_SIZE;
 153     if (p_sys->mtu < p_sys->page_size)
 154         p_sys->mtu = p_sys->page_size;
 155     p_sys->fd = fd;
 156
 157     p_access->info.i_size = st.st_size;
 158 #ifdef HAVE_POSIX_FADVISE
 159     posix_fadvise (fd, 0, 0, POSIX_FADV_SEQUENTIAL);
 160 #endif
 161
 162     return VLC_SUCCESS;
 163
 164 error:
 165     if (fd != -1)
 166         close (fd);
 167     free (p_sys);
 168     return VLC_EGENERIC;
 169 }
 170
 171
 172 static void Close (vlc_object_t * p_this)
 173 {
 174     access_t *p_access = (access_t *)p_this;
 175     access_sys_t *p_sys = p_access->p_sys;
 176
 177     close (p_sys->fd); /* don't care about error when only reading */
 178     free (p_sys);
 179 }
 180
 181 static block_t *Block (access_t *p_access)
 182 {
 183     access_sys_t *p_sys = p_access->p_sys;
 184
 185     /* Check if file size changed... */
 186     struct stat st;
 187
 188     if ((fstat (p_sys->fd, &st) == 0)
 189      && (st.st_size != p_access->info.i_size))
 190     {
 191         p_access->info.i_size = st.st_size;
 192         p_access->info.i_update |= INPUT_UPDATE_SIZE;
 193     }
 194
 195     if ((uint64_t)p_access->info.i_pos >= (uint64_t)p_access->info.i_size)
 196     {
 197         /* We are at end of file */
 198         p_access->info.b_eof = true;
 199         msg_Dbg (p_access, "at end of memory mapped file");
 200         return NULL;
 201     }
 202
 203 #ifdef MMAP_DEBUG
 204     int64_t dbgpos = lseek (p_sys->fd, 0, SEEK_CUR);
 205     if (dbgpos != p_access->info.i_pos)
 206         msg_Err (p_access, "position: 0x%08llx instead of 0x%08llx",
 207                  p_access->info.i_pos, dbgpos);
 208 #endif
 209
 210     const uintptr_t page_mask = p_sys->page_size - 1;
 211     /* Start the mapping on a page boundary: */
 212     off_t  outer_offset = p_access->info.i_pos & ~page_mask;
 213     /* Skip useless bytes at the beginning of the first page: */
 214     size_t inner_offset = p_access->info.i_pos & page_mask;
 215     /* Map no more bytes than remain: */
 216     size_t length = p_sys->mtu;
 217     if (outer_offset + length > p_access->info.i_size)
 218         length = p_access->info.i_size - outer_offset;
 219
 220     assert (outer_offset <= p_access->info.i_pos);          /* and */
 221     assert (p_access->info.i_pos < p_access->info.i_size); /* imply */
 222     assert (outer_offset < p_access->info.i_size);         /* imply */
 223     assert (length > 0);
 224
 225     /* NOTE: We use PROT_WRITE and MAP_PRIVATE so that the block can be
 226      * modified down the chain, without messing up with the underlying
 227      * original file. This does NOT need open write permission. */
 228     void *addr = mmap (NULL, length, PROT_READ|PROT_WRITE, MAP_PRIVATE,
 229                        p_sys->fd, outer_offset);
 230     if (addr == MAP_FAILED)
 231     {
 232         msg_Err (p_access, "memory mapping failed (%m)");
 233         intf_UserFatal (p_access, false, _("File reading failed"),
 234                         _("VLC could not read the file."));
 235         goto fatal;
 236     }
 237 #ifdef HAVE_POSIX_MADVISE
 238     posix_madvise (addr, length, POSIX_MADV_SEQUENTIAL);
 239 #endif
 240
 241     block_t *block = block_mmap_Alloc (addr, length);
 242     if (block == NULL)
 243         goto fatal;
 244
 245     block->p_buffer += inner_offset;
 246     block->i_buffer -= inner_offset;
 247
 248 #ifdef MMAP_DEBUG
 249     msg_Dbg (p_access, "mapped 0x%lx bytes at %p from offset 0x%lx",
 250              (unsigned long)length, addr, (unsigned long)outer_offset);
 251
 252     /* Compare normal I/O with memory mapping */
 253     char *buf = malloc (block->i_buffer);
 254     ssize_t i_read = read (p_sys->fd, buf, block->i_buffer);
 255
 256     if (i_read != (ssize_t)block->i_buffer)
 257         msg_Err (p_access, "read %u instead of %u bytes", (unsigned)i_read,
 258                  (unsigned)block->i_buffer);
 259     if (memcmp (buf, block->p_buffer, block->i_buffer))
 260         msg_Err (p_access, "inconsistent data buffer");
 261     free (buf);
 262 #endif
 263
 264     p_access->info.i_pos = outer_offset + length;
 265     return block;
 266
 267 fatal:
 268     p_access->info.b_eof = true;
 269     return NULL;
 270 }
 271
 272
 273 static int Seek (access_t *p_access, int64_t i_pos)
 274 {
 275 #ifdef MMAP_DEBUG
 276     lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
 277 #endif
 278
 279     p_access->info.i_pos = i_pos;
 280     p_access->info.b_eof = false;
 281     return VLC_SUCCESS;
 282 }
 283
 284
 285 static int Control (access_t *p_access, int query, va_list args)
 286 {
 287     access_sys_t *p_sys = p_access->p_sys;
 288
 289     switch (query)
 290     {
 291         case ACCESS_CAN_SEEK:
 292         case ACCESS_CAN_FASTSEEK:
 293         case ACCESS_CAN_PAUSE:
 294         case ACCESS_CAN_CONTROL_PACE:
 295             *((bool *)va_arg (args, bool *)) = true;
 296             return VLC_SUCCESS;
 297
 298         case ACCESS_GET_MTU:
 299             *((int *)va_arg (args, int *)) = p_sys->mtu;
 300             return VLC_SUCCESS;
 301
 302         case ACCESS_GET_PTS_DELAY:
 303         {
 304             int delay_ms = var_CreateGetInteger (p_access, "file-caching");
 305             *((int64_t *)va_arg (args, int64_t *)) = delay_ms * INT64_C (1000);
 306             return VLC_SUCCESS;
 307         }
 308
 309         case ACCESS_GET_TITLE_INFO:
 310         case ACCESS_GET_META:
 311             break;
 312
 313         case ACCESS_SET_PAUSE_STATE:
 314             return VLC_SUCCESS;
 315
 316         case ACCESS_SET_TITLE:
 317         case ACCESS_SET_SEEKPOINT:
 318         case ACCESS_SET_PRIVATE_ID_STATE:
 319         case ACCESS_SET_PRIVATE_ID_CA:
 320         case ACCESS_GET_PRIVATE_ID_STATE:
 321         case ACCESS_GET_CONTENT_TYPE:
 322             break;
 323
 324         default:
 325             msg_Warn (p_access, "unimplemented query %d in control", query);
 326     }
 327
 328     return VLC_EGENERIC;
 329 }