Whamcloud - gitweb
LU-3409 llite: silence lockdep warning in ll_md_blocking_ast
[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         io->u.ci_fault.ft_mkwrite = 1;
196         io->u.ci_fault.ft_writable = 1;
197
198         vio = vvp_env_io(env);
199         vio->u.fault.ft_vma    = vma;
200         vio->u.fault.ft_vmpage = vmpage;
201
202         set = cfs_block_sigsinv(sigmask(SIGKILL) | sigmask(SIGTERM));
203
204         /* we grab lli_trunc_sem to exclude truncate case.
205          * Otherwise, we could add dirty pages into osc cache
206          * while truncate is on-going. */
207         inode = ccc_object_inode(io->ci_obj);
208         lli = ll_i2info(inode);
209         down_read(&lli->lli_trunc_sem);
210
211         result = cl_io_loop(env, io);
212
213         up_read(&lli->lli_trunc_sem);
214
215         cfs_restore_sigs(set);
216
217         if (result == 0) {
218                 struct inode *inode = vma->vm_file->f_dentry->d_inode;
219                 struct ll_inode_info *lli = ll_i2info(inode);
220
221                 lock_page(vmpage);
222                 if (vmpage->mapping == NULL) {
223                         unlock_page(vmpage);
224
225                         /* page was truncated and lock was cancelled, return
226                          * ENODATA so that VM_FAULT_NOPAGE will be returned
227                          * to handle_mm_fault(). */
228                         if (result == 0)
229                                 result = -ENODATA;
230                 } else if (!PageDirty(vmpage)) {
231                         /* race, the page has been cleaned by ptlrpcd after
232                          * it was unlocked, it has to be added into dirty
233                          * cache again otherwise this soon-to-dirty page won't
234                          * consume any grants, even worse if this page is being
235                          * transferred because it will break RPC checksum.
236                          */
237                         unlock_page(vmpage);
238
239                         CDEBUG(D_MMAP, "Race on page_mkwrite %p/%lu, page has "
240                                "been written out, retry.\n",
241                                vmpage, vmpage->index);
242
243                         *retry = true;
244                         result = -EAGAIN;
245                 }
246
247                 if (result == 0) {
248                         spin_lock(&lli->lli_lock);
249                         lli->lli_flags |= LLIF_DATA_MODIFIED;
250                         spin_unlock(&lli->lli_lock);
251                 }
252         }
253         EXIT;
254
255 out:
256         cl_io_fini(env, io);
257         cl_env_nested_put(&nest, env);
258
259         CDEBUG(D_MMAP, "%s mkwrite with %d\n", cfs_current()->comm, result);
260
261         LASSERT(ergo(result == 0, PageLocked(vmpage)));
262         return(result);
263 }
264
265
266 #ifndef HAVE_VM_OP_FAULT
267 /**
268  * Lustre implementation of a vm_operations_struct::nopage() method, called by
269  * VM to server page fault (both in kernel and user space).
270  *
271  * This function sets up CIT_FAULT cl_io that does the job.
272  *
273  * \param vma - is virtiual area struct related to page fault
274  * \param address - address when hit fault
275  * \param type - of fault
276  *
277  * \return allocated and filled _unlocked_ page for address
278  * \retval NOPAGE_SIGBUS if page not exist on this address
279  * \retval NOPAGE_OOM not have memory for allocate new page
280  */
281 struct page *ll_nopage(struct vm_area_struct *vma, unsigned long address,
282                        int *type)
283 {
284         struct lu_env           *env;
285         struct cl_env_nest      nest;
286         struct cl_io            *io;
287         struct page             *page  = NOPAGE_SIGBUS;
288         struct vvp_io           *vio = NULL;
289         unsigned long           ra_flags;
290         pgoff_t                 pg_offset;
291         int                     result;
292         const unsigned long     writable = VM_SHARED|VM_WRITE;
293         cfs_sigset_t            set;
294         ENTRY;
295
296         pg_offset = ((address - vma->vm_start) >> PAGE_SHIFT) + vma->vm_pgoff;
297         io = ll_fault_io_init(vma, &env,  &nest, pg_offset, &ra_flags);
298         if (IS_ERR(io))
299                 return NOPAGE_SIGBUS;
300
301         result = io->ci_result;
302         if (result < 0)
303                 goto out_err;
304
305         io->u.ci_fault.ft_writable = (vma->vm_flags&writable) == writable;
306
307         vio = vvp_env_io(env);
308         vio->u.fault.ft_vma            = vma;
309         vio->u.fault.nopage.ft_address = address;
310         vio->u.fault.nopage.ft_type    = type;
311         vio->u.fault.ft_vmpage         = NULL;
312
313         set = cfs_block_sigsinv(sigmask(SIGKILL)|sigmask(SIGTERM));
314         result = cl_io_loop(env, io);
315         cfs_restore_sigs(set);
316
317         page = vio->u.fault.ft_vmpage;
318         if (result != 0 && page != NULL) {
319                 page_cache_release(page);
320                 page = NOPAGE_SIGBUS;
321         }
322
323 out_err:
324         if (result == -ENOMEM)
325                 page = NOPAGE_OOM;
326
327         vma->vm_flags &= ~VM_RAND_READ;
328         vma->vm_flags |= ra_flags;
329
330         cl_io_fini(env, io);
331         cl_env_nested_put(&nest, env);
332
333         RETURN(page);
334 }
335
336 #else
337
338 static inline int to_fault_error(int result)
339 {
340         switch(result) {
341         case 0:
342                 result = VM_FAULT_LOCKED;
343                 break;
344         case -EFAULT:
345                 result = VM_FAULT_NOPAGE;
346                 break;
347         case -ENOMEM:
348                 result = VM_FAULT_OOM;
349                 break;
350         default:
351                 result = VM_FAULT_SIGBUS;
352                 break;
353         }
354         return result;
355 }
356
357 /**
358  * Lustre implementation of a vm_operations_struct::fault() method, called by
359  * VM to server page fault (both in kernel and user space).
360  *
361  * \param vma - is virtiual area struct related to page fault
362  * \param vmf - structure which describe type and address where hit fault
363  *
364  * \return allocated and filled _locked_ page for address
365  * \retval VM_FAULT_ERROR on general error
366  * \retval NOPAGE_OOM not have memory for allocate new page
367  */
368 static int ll_fault0(struct vm_area_struct *vma, struct vm_fault *vmf)
369 {
370         struct lu_env           *env;
371         struct cl_io            *io;
372         struct vvp_io           *vio = NULL;
373         struct page             *vmpage;
374         unsigned long            ra_flags;
375         struct cl_env_nest       nest;
376         int                      result;
377         int                      fault_ret = 0;
378         ENTRY;
379
380         io = ll_fault_io_init(vma, &env,  &nest, vmf->pgoff, &ra_flags);
381         if (IS_ERR(io))
382                 RETURN(to_fault_error(PTR_ERR(io)));
383
384         result = io->ci_result;
385         if (result == 0) {
386                 vio = vvp_env_io(env);
387                 vio->u.fault.ft_vma       = vma;
388                 vio->u.fault.ft_vmpage    = NULL;
389                 vio->u.fault.fault.ft_vmf = vmf;
390
391                 result = cl_io_loop(env, io);
392
393                 fault_ret = vio->u.fault.fault.ft_flags;
394                 vmpage = vio->u.fault.ft_vmpage;
395                 if (result != 0 && vmpage != NULL) {
396                         page_cache_release(vmpage);
397                         vmf->page = NULL;
398                 }
399         }
400         cl_io_fini(env, io);
401         cl_env_nested_put(&nest, env);
402
403         vma->vm_flags |= ra_flags;
404         if (result != 0 && !(fault_ret & VM_FAULT_RETRY))
405                 fault_ret |= to_fault_error(result);
406
407         CDEBUG(D_MMAP, "%s fault %d/%d\n",
408                cfs_current()->comm, fault_ret, result);
409         RETURN(fault_ret);
410 }
411
412 static int ll_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
413 {
414         int count = 0;
415         bool printed = false;
416         int result;
417         cfs_sigset_t set;
418
419         /* Only SIGKILL and SIGTERM is allowed for fault/nopage/mkwrite
420          * so that it can be killed by admin but not cause segfault by
421          * other signals. */
422         set = cfs_block_sigsinv(sigmask(SIGKILL) | sigmask(SIGTERM));
423
424 restart:
425         result = ll_fault0(vma, vmf);
426         LASSERT(!(result & VM_FAULT_LOCKED));
427         if (result == 0) {
428                 struct page *vmpage = vmf->page;
429
430                 /* check if this page has been truncated */
431                 lock_page(vmpage);
432                 if (unlikely(vmpage->mapping == NULL)) { /* unlucky */
433                         unlock_page(vmpage);
434                         page_cache_release(vmpage);
435                         vmf->page = NULL;
436
437                         if (!printed && ++count > 16) {
438                                 CWARN("the page is under heavy contention,"
439                                       "maybe your app(%s) needs revising :-)\n",
440                                       current->comm);
441                                 printed = true;
442                         }
443
444                         goto restart;
445                 }
446
447                 result |= VM_FAULT_LOCKED;
448         }
449         cfs_restore_sigs(set);
450         return result;
451 }
452 #endif
453
454 #ifndef HAVE_PGMKWRITE_USE_VMFAULT
455 static int ll_page_mkwrite(struct vm_area_struct *vma, struct page *vmpage)
456 {
457         int count = 0;
458         bool printed = false;
459         bool retry;
460         int result;
461
462         do {
463                 retry = false;
464                 result = ll_page_mkwrite0(vma, vmpage, &retry);
465
466                 if (!printed && ++count > 16) {
467                         CWARN("app(%s): the page %lu of file %lu is under heavy"
468                               " contention.\n",
469                               current->comm, page_index(vmpage),
470                               vma->vm_file->f_dentry->d_inode->i_ino);
471                         printed = true;
472                 }
473         } while (retry);
474
475         if (result == 0)
476                 unlock_page(vmpage);
477         else if (result == -ENODATA)
478                 result = 0; /* kernel will know truncate has happened and
479                              * retry */
480
481         return result;
482 }
483 #else
484 static int ll_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
485 {
486         int count = 0;
487         bool printed = false;
488         bool retry;
489         int result;
490
491         do {
492                 retry = false;
493                 result = ll_page_mkwrite0(vma, vmf->page, &retry);
494
495                 if (!printed && ++count > 16) {
496                         CWARN("app(%s): the page %lu of file %lu is under heavy"
497                               " contention.\n",
498                               current->comm, vmf->pgoff,
499                               vma->vm_file->f_dentry->d_inode->i_ino);
500                         printed = true;
501                 }
502         } while (retry);
503
504         switch(result) {
505         case 0:
506                 LASSERT(PageLocked(vmf->page));
507                 result = VM_FAULT_LOCKED;
508                 break;
509         case -ENODATA:
510         case -EFAULT:
511                 result = VM_FAULT_NOPAGE;
512                 break;
513         case -ENOMEM:
514                 result = VM_FAULT_OOM;
515                 break;
516         case -EAGAIN:
517                 result = VM_FAULT_RETRY;
518                 break;
519         default:
520                 result = VM_FAULT_SIGBUS;
521                 break;
522         }
523
524         return result;
525 }
526 #endif
527
528 /**
529  *  To avoid cancel the locks covering mmapped region for lock cache pressure,
530  *  we track the mapped vma count in ccc_object::cob_mmap_cnt.
531  */
532 static void ll_vm_open(struct vm_area_struct * vma)
533 {
534         struct inode *inode    = vma->vm_file->f_dentry->d_inode;
535         struct ccc_object *vob = cl_inode2ccc(inode);
536
537         ENTRY;
538         LASSERT(vma->vm_file);
539         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
540         cfs_atomic_inc(&vob->cob_mmap_cnt);
541         EXIT;
542 }
543
544 /**
545  * Dual to ll_vm_open().
546  */
547 static void ll_vm_close(struct vm_area_struct *vma)
548 {
549         struct inode      *inode = vma->vm_file->f_dentry->d_inode;
550         struct ccc_object *vob   = cl_inode2ccc(inode);
551
552         ENTRY;
553         LASSERT(vma->vm_file);
554         cfs_atomic_dec(&vob->cob_mmap_cnt);
555         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
556         EXIT;
557 }
558
559 #ifndef HAVE_VM_OP_FAULT
560 #ifndef HAVE_FILEMAP_POPULATE
561 static int (*filemap_populate)(struct vm_area_struct * area, unsigned long address, unsigned long len, pgprot_t prot, unsigned long pgoff, int nonblock);
562 #endif
563 static int ll_populate(struct vm_area_struct *area, unsigned long address,
564                        unsigned long len, pgprot_t prot, unsigned long pgoff,
565                        int nonblock)
566 {
567         int rc = 0;
568         ENTRY;
569
570         /* always set nonblock as true to avoid page read ahead */
571         rc = filemap_populate(area, address, len, prot, pgoff, 1);
572         RETURN(rc);
573 }
574 #endif
575
576 /* return the user space pointer that maps to a file offset via a vma */
577 static inline unsigned long file_to_user(struct vm_area_struct *vma, __u64 byte)
578 {
579         return vma->vm_start + (byte - ((__u64)vma->vm_pgoff << CFS_PAGE_SHIFT));
580
581 }
582
583 /* XXX put nice comment here.  talk about __free_pte -> dirty pages and
584  * nopage's reference passing to the pte */
585 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last)
586 {
587         int rc = -ENOENT;
588         ENTRY;
589
590         LASSERTF(last > first, "last "LPU64" first "LPU64"\n", last, first);
591         if (mapping_mapped(mapping)) {
592                 rc = 0;
593                 unmap_mapping_range(mapping, first + CFS_PAGE_SIZE - 1,
594                                     last - first + 1, 0);
595         }
596
597         RETURN(rc);
598 }
599
600 static struct vm_operations_struct ll_file_vm_ops = {
601 #ifndef HAVE_VM_OP_FAULT
602         .nopage                 = ll_nopage,
603         .populate               = ll_populate,
604 #else
605         .fault                  = ll_fault,
606 #endif
607 #ifndef HAVE_PGMKWRITE_COMPACT
608         .page_mkwrite           = ll_page_mkwrite,
609 #else
610         ._pmkw.page_mkwrite     = ll_page_mkwrite,
611 #endif
612         .open                   = ll_vm_open,
613         .close                  = ll_vm_close,
614 };
615
616 int ll_file_mmap(struct file *file, struct vm_area_struct * vma)
617 {
618         struct inode *inode = file->f_dentry->d_inode;
619         int rc;
620         ENTRY;
621
622         if (ll_file_nolock(file))
623                 RETURN(-EOPNOTSUPP);
624
625         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MAP, 1);
626         rc = generic_file_mmap(file, vma);
627         if (rc == 0) {
628 #if !defined(HAVE_FILEMAP_POPULATE) && !defined(HAVE_VM_OP_FAULT)
629                 if (!filemap_populate)
630                         filemap_populate = vma->vm_ops->populate;
631 #endif
632                 vma->vm_ops = &ll_file_vm_ops;
633                 vma->vm_ops->open(vma);
634                 /* update the inode's size and mtime */
635                 rc = ll_glimpse_size(inode);
636         }
637
638         RETURN(rc);
639 }