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         void *addr = mmap (NULL, 1, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
 140         if (addr != MAP_FAILED)
 141             munmap (addr, 1);
 142         else
 143             goto error;
 144     }
 145
 146     p_sys->page_size = sysconf (_SC_PAGE_SIZE);
 147     p_sys->mtu = MMAP_SIZE;
 148     if (p_sys->mtu < p_sys->page_size)
 149         p_sys->mtu = p_sys->page_size;
 150     p_sys->fd = fd;
 151
 152     p_access->info.i_size = st.st_size;
 153 #ifdef HAVE_POSIX_FADVISE
 154     posix_fadvise (fd, 0, 0, POSIX_FADV_SEQUENTIAL);
 155 #endif
 156
 157     return VLC_SUCCESS;
 158
 159 error:
 160     if (fd != -1)
 161         close (fd);
 162     free (p_sys);
 163     return VLC_EGENERIC;
 164 }
 165
 166
 167 static void Close (vlc_object_t * p_this)
 168 {
 169     access_t *p_access = (access_t *)p_this;
 170     access_sys_t *p_sys = p_access->p_sys;
 171
 172     close (p_sys->fd); /* don't care about error when only reading */
 173     free (p_sys);
 174 }
 175
 176 static block_t *Block (access_t *p_access)
 177 {
 178     access_sys_t *p_sys = p_access->p_sys;
 179
 180     /* Check if file size changed... */
 181     struct stat st;
 182
 183     if ((fstat (p_sys->fd, &st) == 0)
 184      && (st.st_size != p_access->info.i_size))
 185     {
 186         p_access->info.i_size = st.st_size;
 187         p_access->info.i_update |= INPUT_UPDATE_SIZE;
 188     }
 189
 190     if ((uint64_t)p_access->info.i_pos >= (uint64_t)p_access->info.i_size)
 191     {
 192         /* We are at end of file */
 193         p_access->info.b_eof = true;
 194         msg_Dbg (p_access, "at end of memory mapped file");
 195         return NULL;
 196     }
 197
 198 #ifdef MMAP_DEBUG
 199     int64_t dbgpos = lseek (p_sys->fd, 0, SEEK_CUR);
 200     if (dbgpos != p_access->info.i_pos)
 201         msg_Err (p_access, "position: 0x%08llx instead of 0x%08llx",
 202                  p_access->info.i_pos, dbgpos);
 203 #endif
 204
 205     const uintptr_t page_mask = p_sys->page_size - 1;
 206     /* Start the mapping on a page boundary: */
 207     off_t  outer_offset = p_access->info.i_pos & ~page_mask;
 208     /* Skip useless bytes at the beginning of the first page: */
 209     size_t inner_offset = p_access->info.i_pos & page_mask;
 210     /* Map no more bytes than remain: */
 211     size_t length = p_sys->mtu;
 212     if (outer_offset + length > p_access->info.i_size)
 213         length = p_access->info.i_size - outer_offset;
 214
 215     assert (outer_offset <= p_access->info.i_pos);          /* and */
 216     assert (p_access->info.i_pos < p_access->info.i_size); /* imply */
 217     assert (outer_offset < p_access->info.i_size);         /* imply */
 218     assert (length > 0);
 219
 220     /* NOTE: We use PROT_WRITE and MAP_PRIVATE so that the block can be
 221      * modified down the chain, without messing up with the underlying
 222      * original file. This does NOT need open write permission. */
 223     void *addr = mmap (NULL, length, PROT_READ|PROT_WRITE, MAP_PRIVATE
 224 #ifdef MAP_NO_CACHE
 225                        | MAP_NOCACHE
 226 #endif
 227                        , p_sys->fd, outer_offset);
 228     if (addr == MAP_FAILED)
 229     {
 230         msg_Err (p_access, "memory mapping failed (%m)");
 231         intf_UserFatal (p_access, false, _("File reading failed"),
 232                         _("VLC could not read the file."));
 233         goto fatal;
 234     }
 235 #ifdef HAVE_POSIX_MADVISE
 236     posix_madvise (addr, length, POSIX_MADV_SEQUENTIAL);
 237 #endif
 238
 239     block_t *block = block_mmap_Alloc (addr, length);
 240     if (block == NULL)
 241         goto fatal;
 242
 243     block->p_buffer += inner_offset;
 244     block->i_buffer -= inner_offset;
 245
 246 #ifdef MMAP_DEBUG
 247     msg_Dbg (p_access, "mapped 0x%lx bytes at %p from offset 0x%lx",
 248              (unsigned long)length, addr, (unsigned long)outer_offset);
 249
 250     /* Compare normal I/O with memory mapping */
 251     char *buf = malloc (block->i_buffer);
 252     ssize_t i_read = read (p_sys->fd, buf, block->i_buffer);
 253
 254     if (i_read != (ssize_t)block->i_buffer)
 255         msg_Err (p_access, "read %u instead of %u bytes", (unsigned)i_read,
 256                  (unsigned)block->i_buffer);
 257     if (memcmp (buf, block->p_buffer, block->i_buffer))
 258         msg_Err (p_access, "inconsistent data buffer");
 259     free (buf);
 260 #endif
 261
 262     p_access->info.i_pos = outer_offset + length;
 263     return block;
 264
 265 fatal:
 266     p_access->info.b_eof = true;
 267     return NULL;
 268 }
 269
 270
 271 static int Seek (access_t *p_access, int64_t i_pos)
 272 {
 273 #ifdef MMAP_DEBUG
 274     lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
 275 #endif
 276
 277     p_access->info.i_pos = i_pos;
 278     p_access->info.b_eof = false;
 279     return VLC_SUCCESS;
 280 }
 281
 282
 283 static int Control (access_t *p_access, int query, va_list args)
 284 {
 285     access_sys_t *p_sys = p_access->p_sys;
 286
 287     switch (query)
 288     {
 289         case ACCESS_CAN_SEEK:
 290         case ACCESS_CAN_FASTSEEK:
 291         case ACCESS_CAN_PAUSE:
 292         case ACCESS_CAN_CONTROL_PACE:
 293             *((bool *)va_arg (args, bool *)) = true;
 294             return VLC_SUCCESS;
 295
 296         case ACCESS_GET_MTU:
 297             *((int *)va_arg (args, int *)) = p_sys->mtu;
 298             return VLC_SUCCESS;
 299
 300         case ACCESS_GET_PTS_DELAY:
 301         {
 302             int delay_ms = var_CreateGetInteger (p_access, "file-caching");
 303             *((int64_t *)va_arg (args, int64_t *)) = delay_ms * INT64_C (1000);
 304             return VLC_SUCCESS;
 305         }
 306
 307         case ACCESS_GET_TITLE_INFO:
 308         case ACCESS_GET_META:
 309             break;
 310
 311         case ACCESS_SET_PAUSE_STATE:
 312             return VLC_SUCCESS;
 313
 314         case ACCESS_SET_TITLE:
 315         case ACCESS_SET_SEEKPOINT:
 316         case ACCESS_SET_PRIVATE_ID_STATE:
 317         case ACCESS_SET_PRIVATE_ID_CA:
 318         case ACCESS_GET_PRIVATE_ID_STATE:
 319         case ACCESS_GET_CONTENT_TYPE:
 320             break;
 321
 322         default:
 323             msg_Warn (p_access, "unimplemented query %d in control", query);
 324     }
 325
 326     return VLC_EGENERIC;
 327 }