unused variables.
[vlc.git] / 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     add_bool ("file-mmap", false, NULL,
62               FILE_MMAP_TEXT, FILE_MMAP_LONGTEXT, true)
63 vlc_module_end ()
64
65 static block_t *Block (access_t *);
66 static int Seek (access_t *, int64_t);
67 static int Control (access_t *, int, va_list);
68
69 struct access_sys_t
70 {
71     size_t page_size;
72     size_t mtu;
73     int    fd;
74 };
75
76 #define MMAP_SIZE (1 << 20)
77
78 static int Open (vlc_object_t *p_this)
79 {
80     access_t *p_access = (access_t *)p_this;
81     access_sys_t *p_sys;
82     const char *path = p_access->psz_path;
83     int fd;
84
85     assert ((INT64_C(1) << 63) == ((off_t)(INT64_C(1) << 63)));
86
87     if (!var_CreateGetBool (p_this, "file-mmap"))
88         return VLC_EGENERIC; /* disabled */
89
90     STANDARD_BLOCK_ACCESS_INIT;
91
92     if (!strcmp (p_access->psz_path, "-"))
93         fd = dup (0);
94     else
95     {
96         msg_Dbg (p_access, "opening file %s", path);
97         fd = utf8_open (path, O_RDONLY | O_NOCTTY, 0666);
98     }
99
100     if (fd == -1)
101     {
102         msg_Warn (p_access, "cannot open %s: %m", path);
103         goto error;
104     }
105
106     /* mmap() is only safe for regular and block special files.
107      * For other types, it may be some idiosyncrasic interface (e.g. packet
108      * sockets are a good example), if it works at all. */
109     struct stat st;
110
111     if (fstat (fd, &st))
112     {
113         msg_Err (p_access, "cannot stat %s: %m", path);
114         goto error;
115     }
116
117     if (!S_ISREG (st.st_mode) && !S_ISBLK (st.st_mode))
118     {
119         msg_Dbg (p_access, "skipping non regular file %s", path);
120         goto error;
121     }
122
123 #if defined(HAVE_FCNTL_H)
124     /* We'd rather use any available memory for reading ahead
125      * than for caching what we've already mmap'ed */
126 # if defined(F_RDAHEAD)
127     fcntl (fd, F_RDAHEAD, 1);
128 # endif
129 # if defined(F_NOCACHE)
130     fcntl (fd, F_NOCACHE, 1);
131 # endif
132 #endif
133
134     /* Autodetect mmap() support */
135     if (st.st_size > 0)
136     {
137         void *addr = mmap (NULL, 1, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
138         if (addr != MAP_FAILED)
139             munmap (addr, 1);
140         else
141             goto error;
142     }
143
144     p_sys->page_size = sysconf (_SC_PAGE_SIZE);
145     p_sys->mtu = MMAP_SIZE;
146     if (p_sys->mtu < p_sys->page_size)
147         p_sys->mtu = p_sys->page_size;
148     p_sys->fd = fd;
149
150     p_access->info.i_size = st.st_size;
151 #ifdef HAVE_POSIX_FADVISE    
152     posix_fadvise (fd, 0, 0, POSIX_FADV_SEQUENTIAL);
153 #endif 
154
155     return VLC_SUCCESS;
156
157 error:
158     if (fd != -1)
159         close (fd);
160     free (p_sys);
161     return VLC_EGENERIC;
162 }
163
164
165 static void Close (vlc_object_t * p_this)
166 {
167     access_t *p_access = (access_t *)p_this;
168     access_sys_t *p_sys = p_access->p_sys;
169
170     close (p_sys->fd); /* don't care about error when only reading */
171     free (p_sys);
172 }
173
174 static block_t *Block (access_t *p_access)
175 {
176     access_sys_t *p_sys = p_access->p_sys;
177
178     /* Check if file size changed... */
179     struct stat st;
180
181     if ((fstat (p_sys->fd, &st) == 0)
182      && (st.st_size != p_access->info.i_size))
183     {
184         p_access->info.i_size = st.st_size;
185         p_access->info.i_update |= INPUT_UPDATE_SIZE;
186     }
187
188     if ((uint64_t)p_access->info.i_pos >= (uint64_t)p_access->info.i_size)
189     {
190         /* We are at end of file */
191         p_access->info.b_eof = true;
192         msg_Dbg (p_access, "at end of memory mapped file");
193         return NULL;
194     }
195
196 #ifdef MMAP_DEBUG
197     int64_t dbgpos = lseek (p_sys->fd, 0, SEEK_CUR);
198     if (dbgpos != p_access->info.i_pos)
199         msg_Err (p_access, "position: 0x%016"PRIx64" instead of 0x%016"PRIx64,
200                  p_access->info.i_pos, dbgpos);
201 #endif
202
203     const uintptr_t page_mask = p_sys->page_size - 1;
204     /* Start the mapping on a page boundary: */
205     off_t  outer_offset = p_access->info.i_pos & ~(off_t)page_mask;
206     /* Skip useless bytes at the beginning of the first page: */
207     size_t inner_offset = p_access->info.i_pos & page_mask;
208     /* Map no more bytes than remain: */
209     size_t length = p_sys->mtu;
210     if (outer_offset + length > p_access->info.i_size)
211         length = p_access->info.i_size - outer_offset;
212
213     assert (outer_offset <= p_access->info.i_pos);          /* and */
214     assert (p_access->info.i_pos < p_access->info.i_size); /* imply */
215     assert (outer_offset < p_access->info.i_size);         /* imply */
216     assert (length > 0);
217
218     /* NOTE: We use PROT_WRITE and MAP_PRIVATE so that the block can be
219      * modified down the chain, without messing up with the underlying
220      * original file. This does NOT need open write permission. */
221     void *addr = mmap (NULL, length, PROT_READ|PROT_WRITE, MAP_PRIVATE
222 #ifdef MAP_NO_CACHE
223                        | MAP_NOCACHE
224 #endif
225                        , p_sys->fd, outer_offset);
226     if (addr == MAP_FAILED)
227     {
228         msg_Err (p_access, "memory mapping failed (%m)");
229         intf_UserFatal (p_access, false, _("File reading failed"),
230                         _("VLC could not read the file."));
231         goto fatal;
232     }
233 #ifdef HAVE_POSIX_MADVISE    
234     posix_madvise (addr, length, POSIX_MADV_SEQUENTIAL);
235 #endif
236
237     block_t *block = block_mmap_Alloc (addr, length);
238     if (block == NULL)
239         goto fatal;
240
241     block->p_buffer += inner_offset;
242     block->i_buffer -= inner_offset;
243
244 #ifdef MMAP_DEBUG
245     msg_Dbg (p_access, "mapped 0x%zx bytes at %p from offset 0x%"PRIx64,
246              length, addr, (uint64_t)outer_offset);
247
248     /* Compare normal I/O with memory mapping */
249     char *buf = malloc (block->i_buffer);
250     ssize_t i_read = read (p_sys->fd, buf, block->i_buffer);
251
252     if (i_read != (ssize_t)block->i_buffer)
253         msg_Err (p_access, "read %zd instead of %zu bytes", i_read,
254                  block->i_buffer);
255     if (memcmp (buf, block->p_buffer, block->i_buffer))
256         msg_Err (p_access, "inconsistent data buffer");
257     free (buf);
258 #endif
259
260     p_access->info.i_pos = outer_offset + length;
261     return block;
262
263 fatal:
264     p_access->info.b_eof = true;
265     return NULL;
266 }
267
268
269 static int Seek (access_t *p_access, int64_t i_pos)
270 {
271 #ifdef MMAP_DEBUG
272     lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
273 #endif
274
275     p_access->info.i_pos = i_pos;
276     p_access->info.b_eof = false;
277     return VLC_SUCCESS;
278 }
279
280
281 static int Control (access_t *p_access, int query, va_list args)
282 {
283     switch (query)
284     {
285         case ACCESS_CAN_SEEK:
286         case ACCESS_CAN_FASTSEEK:
287         case ACCESS_CAN_PAUSE:
288         case ACCESS_CAN_CONTROL_PACE:
289             *((bool *)va_arg (args, bool *)) = true;
290             return VLC_SUCCESS;
291
292         case ACCESS_GET_PTS_DELAY:
293         {
294             int delay_ms = var_CreateGetInteger (p_access, "file-caching");
295             *((int64_t *)va_arg (args, int64_t *)) = delay_ms * INT64_C (1000);
296             return VLC_SUCCESS;
297         }
298
299         case ACCESS_GET_TITLE_INFO:
300         case ACCESS_GET_META:
301             break;
302
303         case ACCESS_SET_PAUSE_STATE:
304             return VLC_SUCCESS;
305
306         case ACCESS_SET_TITLE:
307         case ACCESS_SET_SEEKPOINT:
308         case ACCESS_SET_PRIVATE_ID_STATE:
309         case ACCESS_SET_PRIVATE_ID_CA:
310         case ACCESS_GET_PRIVATE_ID_STATE:
311         case ACCESS_GET_CONTENT_TYPE:
312             break;
313
314         default:
315             msg_Warn (p_access, "unimplemented query %d in control", query);
316     }
317
318     return VLC_EGENERIC;
319 }