Whamcloud - gitweb
LU-687 clio: retry if fault page was truncated
[fs/lustre-release.git] / lustre / llite / llite_mmap.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
30  * Use is subject to license terms.
31  *
32  * Copyright (c) 2011 Whamcloud, Inc.
33  *
34  */
35 /*
36  * This file is part of Lustre, http://www.lustre.org/
37  * Lustre is a trademark of Sun Microsystems, Inc.
38  */
39
40 #ifndef AUTOCONF_INCLUDED
41 #include <linux/config.h>
42 #endif
43 #include <linux/kernel.h>
44 #include <linux/mm.h>
45 #include <linux/string.h>
46 #include <linux/stat.h>
47 #include <linux/errno.h>
48 #include <linux/smp_lock.h>
49 #include <linux/unistd.h>
50 #include <linux/version.h>
51 #include <asm/system.h>
52 #include <asm/uaccess.h>
53
54 #include <linux/fs.h>
55 #include <linux/stat.h>
56 #include <asm/uaccess.h>
57 #include <linux/mm.h>
58 #include <linux/pagemap.h>
59 #include <linux/smp_lock.h>
60
61 #define DEBUG_SUBSYSTEM S_LLITE
62
63 //#include <lustre_mdc.h>
64 #include <lustre_lite.h>
65 #include "llite_internal.h"
66 #include <linux/lustre_compat25.h>
67
68 #define VMA_DEBUG(vma, fmt, arg...)                                     \
69         CDEBUG(D_MMAP, "vma(%p) start(%ld) end(%ld) pgoff(%ld) inode(%p) "   \
70                "ino(%lu) iname(%s): " fmt, vma, vma->vm_start, vma->vm_end,  \
71                vma->vm_pgoff, vma->vm_file->f_dentry->d_inode,               \
72                vma->vm_file->f_dentry->d_inode->i_ino,                       \
73                vma->vm_file->f_dentry->d_iname, ## arg);                     \
74
75 struct page *ll_nopage(struct vm_area_struct *vma, unsigned long address,
76                        int *type);
77
78 static struct vm_operations_struct ll_file_vm_ops;
79
80 void policy_from_vma(ldlm_policy_data_t *policy,
81                             struct vm_area_struct *vma, unsigned long addr,
82                             size_t count)
83 {
84         policy->l_extent.start = ((addr - vma->vm_start) & CFS_PAGE_MASK) +
85                                  (vma->vm_pgoff << CFS_PAGE_SHIFT);
86         policy->l_extent.end = (policy->l_extent.start + count - 1) |
87                                ~CFS_PAGE_MASK;
88 }
89
90 struct vm_area_struct * our_vma(unsigned long addr, size_t count)
91 {
92         struct mm_struct *mm = current->mm;
93         struct vm_area_struct *vma, *ret = NULL;
94         ENTRY;
95
96         /* No MM (e.g. NFS)? No vmas too. */
97         if (!mm)
98                 RETURN(NULL);
99
100         spin_lock(&mm->page_table_lock);
101         for(vma = find_vma(mm, addr);
102             vma != NULL && vma->vm_start < (addr + count); vma = vma->vm_next) {
103                 if (vma->vm_ops && vma->vm_ops == &ll_file_vm_ops &&
104                     vma->vm_flags & VM_SHARED) {
105                         ret = vma;
106                         break;
107                 }
108         }
109         spin_unlock(&mm->page_table_lock);
110         RETURN(ret);
111 }
112
113 /**
114  * API independent part for page fault initialization.
115  * \param vma - virtual memory area addressed to page fault
116  * \param env - corespondent lu_env to processing
117  * \param nest - nested level
118  * \param index - page index corespondent to fault.
119  * \parm ra_flags - vma readahead flags.
120  *
121  * \return allocated and initialized env for fault operation.
122  * \retval EINVAL if env can't allocated
123  * \return other error codes from cl_io_init.
124  */
125 struct cl_io *ll_fault_io_init(struct vm_area_struct *vma,
126                                struct lu_env **env_ret,
127                                struct cl_env_nest *nest,
128                                pgoff_t index, unsigned long *ra_flags)
129 {
130         struct file       *file  = vma->vm_file;
131         struct inode      *inode = file->f_dentry->d_inode;
132         const unsigned long writable = VM_SHARED|VM_WRITE;
133         struct cl_io      *io;
134         struct cl_fault_io *fio;
135         struct lu_env     *env;
136         ENTRY;
137
138         *env_ret = NULL;
139         if (ll_file_nolock(file))
140                 RETURN(ERR_PTR(-EOPNOTSUPP));
141
142         /*
143          * page fault can be called when lustre IO is
144          * already active for the current thread, e.g., when doing read/write
145          * against user level buffer mapped from Lustre buffer. To avoid
146          * stomping on existing context, optionally force an allocation of a new
147          * one.
148          */
149         env = cl_env_nested_get(nest);
150         if (IS_ERR(env))
151                  RETURN(ERR_PTR(-EINVAL));
152
153         *env_ret = env;
154
155         io = ccc_env_thread_io(env);
156         io->ci_obj = ll_i2info(inode)->lli_clob;
157         LASSERT(io->ci_obj != NULL);
158
159         fio = &io->u.ci_fault;
160         fio->ft_index      = index;
161         fio->ft_writable   = (vma->vm_flags&writable) == writable;
162         fio->ft_executable = vma->vm_flags&VM_EXEC;
163
164         /*
165          * disable VM_SEQ_READ and use VM_RAND_READ to make sure that
166          * the kernel will not read other pages not covered by ldlm in
167          * filemap_nopage. we do our readahead in ll_readpage.
168          */
169         *ra_flags = vma->vm_flags & (VM_RAND_READ|VM_SEQ_READ);
170         vma->vm_flags &= ~VM_SEQ_READ;
171         vma->vm_flags |= VM_RAND_READ;
172
173         CDEBUG(D_INFO, "vm_flags: %lx (%lu %d %d)\n", vma->vm_flags,
174                fio->ft_index, fio->ft_writable, fio->ft_executable);
175
176         if (cl_io_init(env, io, CIT_FAULT, io->ci_obj) == 0) {
177                 struct ccc_io *cio = ccc_env_io(env);
178                 struct ll_file_data *fd = LUSTRE_FPRIVATE(file);
179
180                 LASSERT(cio->cui_cl.cis_io == io);
181
182                 /* mmap lock must be MANDATORY
183                  * it has to cache pages. */
184                 io->ci_lockreq = CILR_MANDATORY;
185
186                 cio->cui_fd  = fd;
187         }
188
189         return io;
190 }
191
192 #ifndef HAVE_VM_OP_FAULT
193 /**
194  * Lustre implementation of a vm_operations_struct::nopage() method, called by
195  * VM to server page fault (both in kernel and user space).
196  *
197  * This function sets up CIT_FAULT cl_io that does the job.
198  *
199  * \param vma - is virtiual area struct related to page fault
200  * \param address - address when hit fault
201  * \param type - of fault
202  *
203  * \return allocated and filled _unlocked_ page for address
204  * \retval NOPAGE_SIGBUS if page not exist on this address
205  * \retval NOPAGE_OOM not have memory for allocate new page
206  */
207 struct page *ll_nopage(struct vm_area_struct *vma, unsigned long address,
208                        int *type)
209 {
210         struct lu_env           *env;
211         struct cl_env_nest      nest;
212         struct cl_io            *io;
213         struct page             *page  = NOPAGE_SIGBUS;
214         struct vvp_io           *vio = NULL;
215         unsigned long           ra_flags;
216         pgoff_t                 pg_offset;
217         int                     result;
218         ENTRY;
219
220         pg_offset = ((address - vma->vm_start) >> PAGE_SHIFT) + vma->vm_pgoff;
221         io = ll_fault_io_init(vma, &env,  &nest, pg_offset, &ra_flags);
222         if (IS_ERR(io))
223                 return NOPAGE_SIGBUS;
224
225         result = io->ci_result;
226         if (result < 0)
227                 goto out_err;
228
229         vio = vvp_env_io(env);
230         vio->u.fault.ft_vma            = vma;
231         vio->u.fault.nopage.ft_address = address;
232         vio->u.fault.nopage.ft_type    = type;
233
234         result = cl_io_loop(env, io);
235
236 out_err:
237         if (result == 0)
238                 page = vio->u.fault.ft_vmpage;
239         else if (result == -ENOMEM)
240                 page = NOPAGE_OOM;
241
242         vma->vm_flags &= ~VM_RAND_READ;
243         vma->vm_flags |= ra_flags;
244
245         cl_io_fini(env, io);
246         cl_env_nested_put(&nest, env);
247
248         RETURN(page);
249 }
250 #else
251 /**
252  * Lustre implementation of a vm_operations_struct::fault() method, called by
253  * VM to server page fault (both in kernel and user space).
254  *
255  * \param vma - is virtiual area struct related to page fault
256  * \param vmf - structure which describe type and address where hit fault
257  *
258  * \return allocated and filled _locked_ page for address
259  * \retval VM_FAULT_ERROR on general error
260  * \retval NOPAGE_OOM not have memory for allocate new page
261  */
262 int ll_fault0(struct vm_area_struct *vma, struct vm_fault *vmf)
263 {
264         struct lu_env           *env;
265         struct cl_io            *io;
266         struct vvp_io           *vio = NULL;
267         unsigned long            ra_flags;
268         struct cl_env_nest       nest;
269         int                      result;
270         int                      fault_ret = 0;
271         ENTRY;
272
273         io = ll_fault_io_init(vma, &env,  &nest, vmf->pgoff, &ra_flags);
274         if (IS_ERR(io))
275                 RETURN(VM_FAULT_ERROR);
276
277         result = io->ci_result;
278         if (result < 0)
279                 goto out_err;
280
281         vio = vvp_env_io(env);
282         vio->u.fault.ft_vma       = vma;
283         vio->u.fault.ft_vmpage    = NULL;
284         vio->u.fault.fault.ft_vmf = vmf;
285
286         result = cl_io_loop(env, io);
287         fault_ret = vio->u.fault.fault.ft_flags;
288
289 out_err:
290         if ((result != 0) && !(fault_ret & VM_FAULT_RETRY))
291                 fault_ret |= VM_FAULT_ERROR;
292
293         vma->vm_flags |= ra_flags;
294
295         cl_io_fini(env, io);
296         cl_env_nested_put(&nest, env);
297
298         RETURN(fault_ret);
299 }
300
301 int ll_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
302 {
303         int count = 0;
304         bool printed = false;
305         int result;
306
307 restart:
308         result = ll_fault0(vma, vmf);
309         LASSERT(!(result & VM_FAULT_LOCKED));
310         if (result == 0) {
311                 struct page *vmpage = vmf->page;
312
313                 /* check if this page has been truncated */
314                 lock_page(vmpage);
315                 if (unlikely(vmpage->mapping == NULL)) { /* unlucky */
316                         unlock_page(vmpage);
317                         page_cache_release(vmpage);
318                         vmf->page = NULL;
319
320                         if (!printed && ++count > 16) {
321                                 CWARN("the page is under heavy contention,"
322                                       "maybe your app(%s) needs revising :-)\n",
323                                       current->comm);
324                                 printed = true;
325                         }
326
327                         goto restart;
328                 }
329
330                 result |= VM_FAULT_LOCKED;
331         }
332         return result;
333 }
334 #endif
335
336 /**
337  *  To avoid cancel the locks covering mmapped region for lock cache pressure,
338  *  we track the mapped vma count in ccc_object::cob_mmap_cnt.
339  */
340 static void ll_vm_open(struct vm_area_struct * vma)
341 {
342         struct inode *inode    = vma->vm_file->f_dentry->d_inode;
343         struct ccc_object *vob = cl_inode2ccc(inode);
344
345         ENTRY;
346         LASSERT(vma->vm_file);
347         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
348         cfs_atomic_inc(&vob->cob_mmap_cnt);
349         EXIT;
350 }
351
352 /**
353  * Dual to ll_vm_open().
354  */
355 static void ll_vm_close(struct vm_area_struct *vma)
356 {
357         struct inode      *inode = vma->vm_file->f_dentry->d_inode;
358         struct ccc_object *vob   = cl_inode2ccc(inode);
359
360         ENTRY;
361         LASSERT(vma->vm_file);
362         cfs_atomic_dec(&vob->cob_mmap_cnt);
363         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
364         EXIT;
365 }
366
367 #ifndef HAVE_VM_OP_FAULT
368 #ifndef HAVE_FILEMAP_POPULATE
369 static int (*filemap_populate)(struct vm_area_struct * area, unsigned long address, unsigned long len, pgprot_t prot, unsigned long pgoff, int nonblock);
370 #endif
371 static int ll_populate(struct vm_area_struct *area, unsigned long address,
372                        unsigned long len, pgprot_t prot, unsigned long pgoff,
373                        int nonblock)
374 {
375         int rc = 0;
376         ENTRY;
377
378         /* always set nonblock as true to avoid page read ahead */
379         rc = filemap_populate(area, address, len, prot, pgoff, 1);
380         RETURN(rc);
381 }
382 #endif
383
384 /* return the user space pointer that maps to a file offset via a vma */
385 static inline unsigned long file_to_user(struct vm_area_struct *vma, __u64 byte)
386 {
387         return vma->vm_start + (byte - ((__u64)vma->vm_pgoff << CFS_PAGE_SHIFT));
388
389 }
390
391 /* XXX put nice comment here.  talk about __free_pte -> dirty pages and
392  * nopage's reference passing to the pte */
393 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last)
394 {
395         int rc = -ENOENT;
396         ENTRY;
397
398         LASSERTF(last > first, "last "LPU64" first "LPU64"\n", last, first);
399         if (mapping_mapped(mapping)) {
400                 rc = 0;
401                 unmap_mapping_range(mapping, first + CFS_PAGE_SIZE - 1,
402                                     last - first + 1, 0);
403         }
404
405         RETURN(rc);
406 }
407
408 static struct vm_operations_struct ll_file_vm_ops = {
409 #ifndef HAVE_VM_OP_FAULT
410         .nopage         = ll_nopage,
411         .populate       = ll_populate,
412
413 #else
414         .fault          = ll_fault,
415 #endif
416         .open           = ll_vm_open,
417         .close          = ll_vm_close,
418 };
419
420 int ll_file_mmap(struct file *file, struct vm_area_struct * vma)
421 {
422         struct inode *inode = file->f_dentry->d_inode;
423         int rc;
424         ENTRY;
425
426         if (ll_file_nolock(file))
427                 RETURN(-EOPNOTSUPP);
428
429         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MAP, 1);
430         rc = generic_file_mmap(file, vma);
431         if (rc == 0) {
432 #if !defined(HAVE_FILEMAP_POPULATE) && !defined(HAVE_VM_OP_FAULT)
433                 if (!filemap_populate)
434                         filemap_populate = vma->vm_ops->populate;
435 #endif
436                 vma->vm_ops = &ll_file_vm_ops;
437                 vma->vm_ops->open(vma);
438                 /* update the inode's size and mtime */
439                 rc = cl_glimpse_size(inode);
440         }
441
442         RETURN(rc);
443 }