Whamcloud - gitweb
LU-1200 build: check page_mkwrite parameter
[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, 2012, Whamcloud, Inc.
33  */
34 /*
35  * This file is part of Lustre, http://www.lustre.org/
36  * Lustre is a trademark of Sun Microsystems, Inc.
37  */
38
39 #ifndef AUTOCONF_INCLUDED
40 #include <linux/config.h>
41 #endif
42 #include <linux/kernel.h>
43 #include <linux/mm.h>
44 #include <linux/string.h>
45 #include <linux/stat.h>
46 #include <linux/errno.h>
47 #include <linux/smp_lock.h>
48 #include <linux/unistd.h>
49 #include <linux/version.h>
50 #include <asm/system.h>
51 #include <asm/uaccess.h>
52
53 #include <linux/fs.h>
54 #include <linux/stat.h>
55 #include <asm/uaccess.h>
56 #include <linux/mm.h>
57 #include <linux/pagemap.h>
58 #include <linux/smp_lock.h>
59
60 #define DEBUG_SUBSYSTEM S_LLITE
61
62 #include <lustre_lite.h>
63 #include "llite_internal.h"
64 #include <linux/lustre_compat25.h>
65
66 struct page *ll_nopage(struct vm_area_struct *vma, unsigned long address,
67                        int *type);
68
69 static struct vm_operations_struct ll_file_vm_ops;
70
71 void policy_from_vma(ldlm_policy_data_t *policy,
72                             struct vm_area_struct *vma, unsigned long addr,
73                             size_t count)
74 {
75         policy->l_extent.start = ((addr - vma->vm_start) & CFS_PAGE_MASK) +
76                                  (vma->vm_pgoff << CFS_PAGE_SHIFT);
77         policy->l_extent.end = (policy->l_extent.start + count - 1) |
78                                ~CFS_PAGE_MASK;
79 }
80
81 struct vm_area_struct * our_vma(unsigned long addr, size_t count)
82 {
83         struct mm_struct *mm = current->mm;
84         struct vm_area_struct *vma, *ret = NULL;
85         ENTRY;
86
87         /* No MM (e.g. NFS)? No vmas too. */
88         if (!mm)
89                 RETURN(NULL);
90
91         spin_lock(&mm->page_table_lock);
92         for(vma = find_vma(mm, addr);
93             vma != NULL && vma->vm_start < (addr + count); vma = vma->vm_next) {
94                 if (vma->vm_ops && vma->vm_ops == &ll_file_vm_ops &&
95                     vma->vm_flags & VM_SHARED) {
96                         ret = vma;
97                         break;
98                 }
99         }
100         spin_unlock(&mm->page_table_lock);
101         RETURN(ret);
102 }
103
104 /**
105  * API independent part for page fault initialization.
106  * \param vma - virtual memory area addressed to page fault
107  * \param env - corespondent lu_env to processing
108  * \param nest - nested level
109  * \param index - page index corespondent to fault.
110  * \parm ra_flags - vma readahead flags.
111  *
112  * \return allocated and initialized env for fault operation.
113  * \retval EINVAL if env can't allocated
114  * \return other error codes from cl_io_init.
115  */
116 struct cl_io *ll_fault_io_init(struct vm_area_struct *vma,
117                                struct lu_env **env_ret,
118                                struct cl_env_nest *nest,
119                                pgoff_t index, unsigned long *ra_flags)
120 {
121         struct file       *file  = vma->vm_file;
122         struct inode      *inode = file->f_dentry->d_inode;
123         struct cl_io      *io;
124         struct cl_fault_io *fio;
125         struct lu_env     *env;
126         ENTRY;
127
128         *env_ret = NULL;
129         if (ll_file_nolock(file))
130                 RETURN(ERR_PTR(-EOPNOTSUPP));
131
132         /*
133          * page fault can be called when lustre IO is
134          * already active for the current thread, e.g., when doing read/write
135          * against user level buffer mapped from Lustre buffer. To avoid
136          * stomping on existing context, optionally force an allocation of a new
137          * one.
138          */
139         env = cl_env_nested_get(nest);
140         if (IS_ERR(env))
141                  RETURN(ERR_PTR(-EINVAL));
142
143         *env_ret = env;
144
145         io = ccc_env_thread_io(env);
146         io->ci_obj = ll_i2info(inode)->lli_clob;
147         LASSERT(io->ci_obj != NULL);
148
149         fio = &io->u.ci_fault;
150         fio->ft_index      = index;
151         fio->ft_executable = vma->vm_flags&VM_EXEC;
152
153         /*
154          * disable VM_SEQ_READ and use VM_RAND_READ to make sure that
155          * the kernel will not read other pages not covered by ldlm in
156          * filemap_nopage. we do our readahead in ll_readpage.
157          */
158         if (ra_flags != NULL)
159                 *ra_flags = vma->vm_flags & (VM_RAND_READ|VM_SEQ_READ);
160         vma->vm_flags &= ~VM_SEQ_READ;
161         vma->vm_flags |= VM_RAND_READ;
162
163         CDEBUG(D_MMAP, "vm_flags: %lx (%lu %d)\n", vma->vm_flags,
164                fio->ft_index, fio->ft_executable);
165
166         if (cl_io_init(env, io, CIT_FAULT, io->ci_obj) == 0) {
167                 struct ccc_io *cio = ccc_env_io(env);
168                 struct ll_file_data *fd = LUSTRE_FPRIVATE(file);
169
170                 LASSERT(cio->cui_cl.cis_io == io);
171
172                 /* mmap lock must be MANDATORY
173                  * it has to cache pages. */
174                 io->ci_lockreq = CILR_MANDATORY;
175
176                 cio->cui_fd  = fd;
177         }
178
179         return io;
180 }
181
182 /* Sharing code of page_mkwrite method for rhel5 and rhel6 */
183 static int ll_page_mkwrite0(struct vm_area_struct *vma, struct page *vmpage,
184                             bool *retry)
185 {
186         struct lu_env           *env;
187         struct cl_io            *io;
188         struct vvp_io           *vio;
189         struct cl_env_nest       nest;
190         int                      result;
191         ENTRY;
192
193         LASSERT(vmpage != NULL);
194
195         io = ll_fault_io_init(vma, &env,  &nest, vmpage->index, NULL);
196         if (IS_ERR(io))
197                 GOTO(out, result = PTR_ERR(io));
198
199         result = io->ci_result;
200         if (result < 0)
201                 GOTO(out, result);
202
203         /* Don't enqueue new locks for page_mkwrite().
204          * If the lock has been cancelled then page must have been
205          * truncated, in that case, kernel will handle it.
206          */
207         io->ci_lockreq = CILR_PEEK;
208         io->u.ci_fault.ft_mkwrite = 1;
209         io->u.ci_fault.ft_writable = 1;
210
211         vio = vvp_env_io(env);
212         vio->u.fault.ft_vma    = vma;
213         vio->u.fault.ft_vmpage = vmpage;
214
215         result = cl_io_loop(env, io);
216
217         if (result == -ENODATA) /* peek failed, no lock caching. */
218                 CDEBUG(D_MMAP, "race on page_mkwrite: %lx (%lu %p)\n",
219                        vma->vm_flags, io->u.ci_fault.ft_index, vmpage);
220
221         if (result == 0 || result == -ENODATA) {
222                 lock_page(vmpage);
223                 if (vmpage->mapping == NULL) {
224                         unlock_page(vmpage);
225
226                         /* page was truncated and lock was cancelled, return
227                          * ENODATA so that VM_FAULT_NOPAGE will be returned
228                          * to handle_mm_fault(). */
229                         if (result == 0)
230                                 result = -ENODATA;
231                 } else if (result == -ENODATA) {
232                         /* Invalidate it if the cl_lock is being revoked.
233                          * This piece of code is definitely needed for RHEL5,
234                          * otherwise, SIGBUS will be wrongly returned to
235                          * applications. */
236                         write_one_page(vmpage, 1);
237                         lock_page(vmpage);
238                         if (vmpage->mapping != NULL) {
239                                 ll_invalidate_page(vmpage);
240                                 LASSERT(vmpage->mapping == NULL);
241                         }
242                         unlock_page(vmpage);
243                 } else if (!PageDirty(vmpage)) {
244                         /* race, the page has been cleaned by ptlrpcd after
245                          * it was unlocked, it has to be added into dirty
246                          * cache again otherwise this soon-to-dirty page won't
247                          * consume any grants, even worse if this page is being
248                          * transferred because it will break RPC checksum.
249                          */
250                         unlock_page(vmpage);
251
252                         CDEBUG(D_MMAP, "Race on page_mkwrite %p/%lu, page has "
253                                "been written out, retry.\n",
254                                vmpage, vmpage->index);
255
256                         *retry = true;
257                         result = -EAGAIN;
258                 }
259         }
260         EXIT;
261
262 out:
263         cl_io_fini(env, io);
264         cl_env_nested_put(&nest, env);
265
266         CDEBUG(D_MMAP, "%s mkwrite with %d\n", cfs_current()->comm, result);
267
268         LASSERT(ergo(result == 0, PageLocked(vmpage)));
269         return(result);
270 }
271
272
273 #ifndef HAVE_VM_OP_FAULT
274 /**
275  * Lustre implementation of a vm_operations_struct::nopage() method, called by
276  * VM to server page fault (both in kernel and user space).
277  *
278  * This function sets up CIT_FAULT cl_io that does the job.
279  *
280  * \param vma - is virtiual area struct related to page fault
281  * \param address - address when hit fault
282  * \param type - of fault
283  *
284  * \return allocated and filled _unlocked_ page for address
285  * \retval NOPAGE_SIGBUS if page not exist on this address
286  * \retval NOPAGE_OOM not have memory for allocate new page
287  */
288 struct page *ll_nopage(struct vm_area_struct *vma, unsigned long address,
289                        int *type)
290 {
291         struct lu_env           *env;
292         struct cl_env_nest      nest;
293         struct cl_io            *io;
294         struct page             *page  = NOPAGE_SIGBUS;
295         struct vvp_io           *vio = NULL;
296         unsigned long           ra_flags;
297         pgoff_t                 pg_offset;
298         int                     result;
299         const unsigned long     writable = VM_SHARED|VM_WRITE;
300         ENTRY;
301
302         pg_offset = ((address - vma->vm_start) >> PAGE_SHIFT) + vma->vm_pgoff;
303         io = ll_fault_io_init(vma, &env,  &nest, pg_offset, &ra_flags);
304         if (IS_ERR(io))
305                 return NOPAGE_SIGBUS;
306
307         result = io->ci_result;
308         if (result < 0)
309                 goto out_err;
310
311         io->u.ci_fault.ft_writable = (vma->vm_flags&writable) == writable;
312
313         vio = vvp_env_io(env);
314         vio->u.fault.ft_vma            = vma;
315         vio->u.fault.nopage.ft_address = address;
316         vio->u.fault.nopage.ft_type    = type;
317         vio->u.fault.ft_vmpage         = NULL;
318
319         result = cl_io_loop(env, io);
320         page = vio->u.fault.ft_vmpage;
321         if (result != 0 && page != NULL)
322                 page_cache_release(page);
323
324 out_err:
325         if (result == -ENOMEM)
326                 page = NOPAGE_OOM;
327
328         vma->vm_flags &= ~VM_RAND_READ;
329         vma->vm_flags |= ra_flags;
330
331         cl_io_fini(env, io);
332         cl_env_nested_put(&nest, env);
333
334         RETURN(page);
335 }
336
337 #else
338 /**
339  * Lustre implementation of a vm_operations_struct::fault() method, called by
340  * VM to server page fault (both in kernel and user space).
341  *
342  * \param vma - is virtiual area struct related to page fault
343  * \param vmf - structure which describe type and address where hit fault
344  *
345  * \return allocated and filled _locked_ page for address
346  * \retval VM_FAULT_ERROR on general error
347  * \retval NOPAGE_OOM not have memory for allocate new page
348  */
349 static int ll_fault0(struct vm_area_struct *vma, struct vm_fault *vmf)
350 {
351         struct lu_env           *env;
352         struct cl_io            *io;
353         struct vvp_io           *vio = NULL;
354         struct page             *vmpage;
355         unsigned long            ra_flags;
356         struct cl_env_nest       nest;
357         int                      result;
358         int                      fault_ret = 0;
359         ENTRY;
360
361         io = ll_fault_io_init(vma, &env,  &nest, vmf->pgoff, &ra_flags);
362         if (IS_ERR(io))
363                 RETURN(VM_FAULT_ERROR);
364
365         result = io->ci_result;
366         if (result < 0)
367                 goto out_err;
368
369         vio = vvp_env_io(env);
370         vio->u.fault.ft_vma       = vma;
371         vio->u.fault.ft_vmpage    = NULL;
372         vio->u.fault.fault.ft_vmf = vmf;
373
374         result = cl_io_loop(env, io);
375
376         vmpage = vio->u.fault.ft_vmpage;
377         if (result != 0 && vmpage != NULL) {
378                 page_cache_release(vmpage);
379                 vmf->page = NULL;
380         }
381
382         fault_ret = vio->u.fault.fault.ft_flags;
383
384 out_err:
385         if (result != 0 && fault_ret == 0)
386                 fault_ret = VM_FAULT_ERROR;
387
388         vma->vm_flags |= ra_flags;
389
390         cl_io_fini(env, io);
391         cl_env_nested_put(&nest, env);
392
393         CDEBUG(D_MMAP, "%s fault %d/%d\n",
394                cfs_current()->comm, fault_ret, result);
395         RETURN(fault_ret);
396 }
397
398 static int ll_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
399 {
400         int count = 0;
401         bool printed = false;
402         int result;
403
404 restart:
405         result = ll_fault0(vma, vmf);
406         LASSERT(!(result & VM_FAULT_LOCKED));
407         if (result == 0) {
408                 struct page *vmpage = vmf->page;
409
410                 /* check if this page has been truncated */
411                 lock_page(vmpage);
412                 if (unlikely(vmpage->mapping == NULL)) { /* unlucky */
413                         unlock_page(vmpage);
414                         page_cache_release(vmpage);
415                         vmf->page = NULL;
416
417                         if (!printed && ++count > 16) {
418                                 CWARN("the page is under heavy contention,"
419                                       "maybe your app(%s) needs revising :-)\n",
420                                       current->comm);
421                                 printed = true;
422                         }
423
424                         goto restart;
425                 }
426
427                 result |= VM_FAULT_LOCKED;
428         }
429         return result;
430 }
431 #endif
432
433 #ifndef HAVE_PGMKWRITE_USE_VMFAULT
434 static int ll_page_mkwrite(struct vm_area_struct *vma, struct page *vmpage)
435 {
436         int count = 0;
437         bool printed = false;
438         bool retry;
439         int result;
440
441         do {
442                 retry = false;
443                 result = ll_page_mkwrite0(vma, vmpage, &retry);
444
445                 if (!printed && ++count > 16) {
446                         CWARN("app(%s): the page %lu of file %lu is under heavy"
447                               " contention.\n",
448                               current->comm, page_index(vmpage),
449                               vma->vm_file->f_dentry->d_inode->i_ino);
450                         printed = true;
451                 }
452         } while (retry);
453
454         if (result == 0)
455                 unlock_page(vmpage);
456         else if (result == -ENODATA)
457                 result = 0; /* kernel will know truncate has happened and
458                              * retry */
459
460         return result;
461 }
462 #else
463 static int ll_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
464 {
465         int count = 0;
466         bool printed = false;
467         bool retry;
468         int result;
469
470         do {
471                 retry = false;
472                 result = ll_page_mkwrite0(vma, vmf->page, &retry);
473
474                 if (!printed && ++count > 16) {
475                         CWARN("app(%s): the page %lu of file %lu is under heavy"
476                               " contention.\n",
477                               current->comm, vmf->pgoff,
478                               vma->vm_file->f_dentry->d_inode->i_ino);
479                         printed = true;
480                 }
481         } while (retry);
482
483         switch(result) {
484         case 0:
485                 LASSERT(PageLocked(vmf->page));
486                 result = VM_FAULT_LOCKED;
487                 break;
488         case -ENODATA:
489         case -EFAULT:
490                 result = VM_FAULT_NOPAGE;
491                 break;
492         case -ENOMEM:
493                 result = VM_FAULT_OOM;
494                 break;
495         case -EAGAIN:
496                 result = VM_FAULT_RETRY;
497                 break;
498         default:
499                 result = VM_FAULT_SIGBUS;
500                 break;
501         }
502
503         return result;
504 }
505 #endif
506
507 /**
508  *  To avoid cancel the locks covering mmapped region for lock cache pressure,
509  *  we track the mapped vma count in ccc_object::cob_mmap_cnt.
510  */
511 static void ll_vm_open(struct vm_area_struct * vma)
512 {
513         struct inode *inode    = vma->vm_file->f_dentry->d_inode;
514         struct ccc_object *vob = cl_inode2ccc(inode);
515
516         ENTRY;
517         LASSERT(vma->vm_file);
518         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
519         cfs_atomic_inc(&vob->cob_mmap_cnt);
520         EXIT;
521 }
522
523 /**
524  * Dual to ll_vm_open().
525  */
526 static void ll_vm_close(struct vm_area_struct *vma)
527 {
528         struct inode      *inode = vma->vm_file->f_dentry->d_inode;
529         struct ccc_object *vob   = cl_inode2ccc(inode);
530
531         ENTRY;
532         LASSERT(vma->vm_file);
533         cfs_atomic_dec(&vob->cob_mmap_cnt);
534         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
535         EXIT;
536 }
537
538 #ifndef HAVE_VM_OP_FAULT
539 #ifndef HAVE_FILEMAP_POPULATE
540 static int (*filemap_populate)(struct vm_area_struct * area, unsigned long address, unsigned long len, pgprot_t prot, unsigned long pgoff, int nonblock);
541 #endif
542 static int ll_populate(struct vm_area_struct *area, unsigned long address,
543                        unsigned long len, pgprot_t prot, unsigned long pgoff,
544                        int nonblock)
545 {
546         int rc = 0;
547         ENTRY;
548
549         /* always set nonblock as true to avoid page read ahead */
550         rc = filemap_populate(area, address, len, prot, pgoff, 1);
551         RETURN(rc);
552 }
553 #endif
554
555 /* return the user space pointer that maps to a file offset via a vma */
556 static inline unsigned long file_to_user(struct vm_area_struct *vma, __u64 byte)
557 {
558         return vma->vm_start + (byte - ((__u64)vma->vm_pgoff << CFS_PAGE_SHIFT));
559
560 }
561
562 /* XXX put nice comment here.  talk about __free_pte -> dirty pages and
563  * nopage's reference passing to the pte */
564 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last)
565 {
566         int rc = -ENOENT;
567         ENTRY;
568
569         LASSERTF(last > first, "last "LPU64" first "LPU64"\n", last, first);
570         if (mapping_mapped(mapping)) {
571                 rc = 0;
572                 unmap_mapping_range(mapping, first + CFS_PAGE_SIZE - 1,
573                                     last - first + 1, 0);
574         }
575
576         RETURN(rc);
577 }
578
579 static struct vm_operations_struct ll_file_vm_ops = {
580 #ifndef HAVE_VM_OP_FAULT
581         .nopage         = ll_nopage,
582         .populate       = ll_populate,
583
584 #else
585         .fault          = ll_fault,
586 #endif
587         .page_mkwrite   = ll_page_mkwrite,
588         .open           = ll_vm_open,
589         .close          = ll_vm_close,
590 };
591
592 int ll_file_mmap(struct file *file, struct vm_area_struct * vma)
593 {
594         struct inode *inode = file->f_dentry->d_inode;
595         int rc;
596         ENTRY;
597
598         if (ll_file_nolock(file))
599                 RETURN(-EOPNOTSUPP);
600
601         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MAP, 1);
602         rc = generic_file_mmap(file, vma);
603         if (rc == 0) {
604 #if !defined(HAVE_FILEMAP_POPULATE) && !defined(HAVE_VM_OP_FAULT)
605                 if (!filemap_populate)
606                         filemap_populate = vma->vm_ops->populate;
607 #endif
608                 vma->vm_ops = &ll_file_vm_ops;
609                 vma->vm_ops->open(vma);
610                 /* update the inode's size and mtime */
611                 rc = ll_glimpse_size(inode);
612         }
613
614         RETURN(rc);
615 }