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