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