4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2016, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
32 #include <linux/errno.h>
33 #include <linux/delay.h>
34 #include <linux/kernel.h>
36 #include <linux/file.h>
38 #define DEBUG_SUBSYSTEM S_LLITE
40 #include "llite_internal.h"
41 #include <lustre_compat.h>
43 static const struct vm_operations_struct ll_file_vm_ops;
45 void policy_from_vma(union ldlm_policy_data *policy, struct vm_area_struct *vma,
46 unsigned long addr, size_t bytes)
48 policy->l_extent.start = ((addr - vma->vm_start) & PAGE_MASK) +
49 (vma->vm_pgoff << PAGE_SHIFT);
50 policy->l_extent.end = (policy->l_extent.start + bytes - 1) |
55 * Linux commit v6.0-rc3-225-gf39af05949a4
56 * mm: add VMA iterator
59 #define vma_iterator vm_area_struct *
60 #define vma_iter_init(vmip, mm, addr) *(vmip) = find_vma(mm, addr)
61 #define for_each_vma(vmi, vma) \
62 for (vma = vmi; vma != NULL; vma = vma->vm_next)
65 struct vm_area_struct *our_vma(struct mm_struct *mm, unsigned long addr,
68 struct vm_area_struct *vma, *ret = NULL;
69 struct vma_iterator vmi;
73 /* mmap_lock must have been held by caller. */
74 LASSERT(!mmap_write_trylock(mm));
76 vma_iter_init(&vmi, mm, addr);
77 for_each_vma(vmi, vma) {
78 if (vma->vm_start < (addr + bytes))
80 if (vma->vm_ops && vma->vm_ops == &ll_file_vm_ops &&
81 vma->vm_flags & VM_SHARED) {
90 * API independent part for page fault initialization.
91 * \param env - corespondent lu_env to processing
92 * \param vma - virtual memory area addressed to page fault
93 * \param index - page index corespondent to fault.
94 * \param mkwrite - whether it is mmap write.
96 * \return error codes from cl_io_init.
99 ll_fault_io_init(struct lu_env *env, struct vm_area_struct *vma,
100 pgoff_t index, bool mkwrite)
102 struct file *file = vma->vm_file;
103 struct inode *inode = file_inode(file);
105 struct cl_fault_io *fio;
109 if (ll_file_nolock(file))
110 RETURN(ERR_PTR(-EOPNOTSUPP));
113 io = vvp_env_thread_io(env);
114 io->ci_obj = ll_i2info(inode)->lli_clob;
115 LASSERT(io->ci_obj != NULL);
117 fio = &io->u.ci_fault;
118 fio->ft_index = index;
119 fio->ft_executable = vma->vm_flags & VM_EXEC;
123 fio->ft_writable = 1;
126 if (vma->vm_flags & VM_SEQ_READ)
128 else if (vma->vm_flags & VM_RAND_READ)
129 io->ci_rand_read = 1;
131 rc = cl_io_init(env, io, CIT_FAULT, io->ci_obj);
133 struct vvp_io *vio = vvp_env_io(env);
134 struct ll_file_data *fd = file->private_data;
136 LASSERT(vio->vui_cl.cis_io == io);
138 /* mmap lock must be MANDATORY it has to cache
140 io->ci_lockreq = CILR_MANDATORY;
144 if (io->ci_need_restart)
153 /* Sharing code of page_mkwrite method for rhel5 and rhel6 */
154 static int ll_page_mkwrite0(struct vm_area_struct *vma, struct page *vmpage,
163 struct inode *inode = NULL;
164 struct ll_inode_info *lli;
167 LASSERT(vmpage != NULL);
168 env = cl_env_get(&refcheck);
170 RETURN(PTR_ERR(env));
172 io = ll_fault_io_init(env, vma, vmpage->index, true);
174 GOTO(out, result = PTR_ERR(io));
176 result = io->ci_result;
178 GOTO(out_io, result);
180 vio = vvp_env_io(env);
181 vio->u.fault.ft_vma = vma;
182 vio->u.fault.ft_vmpage = vmpage;
184 siginitsetinv(&new, sigmask(SIGKILL) | sigmask(SIGTERM));
185 sigprocmask(SIG_BLOCK, &new, &old);
187 inode = vvp_object_inode(io->ci_obj);
188 lli = ll_i2info(inode);
190 result = cl_io_loop(env, io);
192 sigprocmask(SIG_SETMASK, &old, NULL);
196 if (vmpage->mapping == NULL) {
199 /* page was truncated and lock was cancelled, return
200 * ENODATA so that VM_FAULT_NOPAGE will be returned
201 * to handle_mm_fault(). */
204 } else if (!PageDirty(vmpage)) {
205 /* race, the page has been cleaned by ptlrpcd after
206 * it was unlocked, it has to be added into dirty
207 * cache again otherwise this soon-to-dirty page won't
208 * consume any grants, even worse if this page is being
209 * transferred because it will break RPC checksum.
213 CDEBUG(D_MMAP, "Race on page_mkwrite %p/%lu, page has "
214 "been written out, retry.\n",
215 vmpage, vmpage->index);
222 set_bit(LLIF_DATA_MODIFIED, &lli->lli_flags);
229 cl_env_put(env, &refcheck);
230 CDEBUG(D_MMAP, "%s mkwrite with %d\n", current->comm, result);
231 LASSERT(ergo(result == 0, PageLocked(vmpage)));
233 /* if page has been unmapped, presumably due to lock reclaim for
234 * concurrent usage, add some delay before retrying to prevent
235 * entering live-lock situation with competitors
237 if (result == -ENODATA && inode != NULL) {
238 CDEBUG(D_MMAP, "delaying new page-fault for inode %p to "
239 "prevent live-lock\n", inode);
246 static inline int to_fault_error(int result)
250 result = VM_FAULT_LOCKED;
253 result = VM_FAULT_OOM;
256 result = VM_FAULT_SIGBUS;
262 int ll_filemap_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
264 struct inode *inode = file_inode(vma->vm_file);
268 /* this seqlock lets us notice if a page has been deleted on this inode
269 * during the fault process, allowing us to catch an erroneous SIGBUS
273 seq = read_seqbegin(&ll_i2info(inode)->lli_page_inv_lock);
274 ret = __ll_filemap_fault(vma, vmf);
275 } while (read_seqretry(&ll_i2info(inode)->lli_page_inv_lock, seq) &&
276 (ret & VM_FAULT_SIGBUS));
282 * Lustre implementation of a vm_operations_struct::fault() method, called by
283 * VM to server page fault (both in kernel and user space).
285 * \param vma - is virtiual area struct related to page fault
286 * \param vmf - structure which describe type and address where hit fault
288 * \return allocated and filled _locked_ page for address
289 * \retval VM_FAULT_ERROR on general error
290 * \retval NOPAGE_OOM not have memory for allocate new page
292 static vm_fault_t ll_fault0(struct vm_area_struct *vma, struct vm_fault *vmf)
294 struct inode *inode = file_inode(vma->vm_file);
297 struct vvp_io *vio = NULL;
304 env = cl_env_get(&refcheck);
306 RETURN(PTR_ERR(env));
308 if (ll_sbi_has_fast_read(ll_i2sbi(inode))) {
310 bool allow_retry = vmf->flags & FAULT_FLAG_ALLOW_RETRY;
311 bool has_retry = vmf->flags & FAULT_FLAG_RETRY_NOWAIT;
313 /* To avoid loops, instruct downstream to not drop mmap_sem */
315 * only need FAULT_FLAG_ALLOW_RETRY prior to Linux 5.1
316 * (6b4c9f4469819), where FAULT_FLAG_RETRY_NOWAIT is enough
317 * to not drop mmap_sem when failed to lock the page.
319 vmf->flags |= FAULT_FLAG_ALLOW_RETRY | FAULT_FLAG_RETRY_NOWAIT;
320 ll_cl_add(inode, env, NULL, LCC_MMAP);
321 fault_ret = ll_filemap_fault(vma, vmf);
322 ll_cl_remove(inode, env);
324 vmf->flags &= ~FAULT_FLAG_RETRY_NOWAIT;
326 vmf->flags &= ~FAULT_FLAG_ALLOW_RETRY;
328 /* - If there is no error, then the page was found in cache and
330 * - If VM_FAULT_RETRY is set, the page existed but failed to
331 * lock. We will try slow path to avoid loops.
332 * - Otherwise, it should try normal fault under DLM lock. */
333 if (!(fault_ret & VM_FAULT_RETRY) &&
334 !(fault_ret & VM_FAULT_ERROR))
335 GOTO(out, result = 0);
340 io = ll_fault_io_init(env, vma, vmf->pgoff, false);
342 GOTO(out, result = PTR_ERR(io));
344 result = io->ci_result;
346 vio = vvp_env_io(env);
347 vio->u.fault.ft_vma = vma;
348 vio->u.fault.ft_vmpage = NULL;
349 vio->u.fault.ft_vmf = vmf;
350 vio->u.fault.ft_flags = 0;
351 vio->u.fault.ft_flags_valid = 0;
353 /* May call ll_readpage() */
354 ll_cl_add(inode, env, io, LCC_MMAP);
356 result = cl_io_loop(env, io);
358 ll_cl_remove(inode, env);
360 /* ft_flags are only valid if we reached
361 * the call to filemap_fault */
362 if (vio->u.fault.ft_flags_valid)
363 fault_ret = vio->u.fault.ft_flags;
365 vmpage = vio->u.fault.ft_vmpage;
366 if (result != 0 && vmpage != NULL) {
374 cl_env_put(env, &refcheck);
375 if (result != 0 && !(fault_ret & VM_FAULT_RETRY))
376 fault_ret |= to_fault_error(result);
378 CDEBUG(D_MMAP, "%s fault %d/%d\n", current->comm, fault_ret, result);
382 #ifdef HAVE_VM_OPS_USE_VM_FAULT_ONLY
383 static vm_fault_t ll_fault(struct vm_fault *vmf)
385 struct vm_area_struct *vma = vmf->vma;
387 static vm_fault_t ll_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
391 bool printed = false;
394 ktime_t kstart = ktime_get();
397 result = pcc_fault(vma, vmf, &cached);
401 CDEBUG(D_MMAP|D_IOTRACE,
402 "START file %s:"DFID", vma=%p start=%#lx end=%#lx vm_flags=%#lx idx=%lu\n",
403 file_dentry(vma->vm_file)->d_name.name,
404 PFID(&ll_i2info(file_inode(vma->vm_file))->lli_fid),
405 vma, vma->vm_start, vma->vm_end, vma->vm_flags, vmf->pgoff);
407 /* Only SIGKILL and SIGTERM is allowed for fault/nopage/mkwrite
408 * so that it can be killed by admin but not cause segfault by
411 siginitsetinv(&new, sigmask(SIGKILL) | sigmask(SIGTERM));
412 sigprocmask(SIG_BLOCK, &new, &old);
414 /* make sure offset is not a negative number */
415 if (vmf->pgoff > (MAX_LFS_FILESIZE >> PAGE_SHIFT))
416 return VM_FAULT_SIGBUS;
419 result = ll_fault0(vma, vmf);
421 !(result & (VM_FAULT_RETRY | VM_FAULT_ERROR | VM_FAULT_LOCKED))) {
422 struct page *vmpage = vmf->page;
424 /* lock the page, then check if this page has been truncated
425 * or deleted from Lustre and retry if so
428 if (unlikely(vmpage->mapping == NULL) ||
429 vmpage->private == 0) { /* unlucky */
434 if (!printed && ++count > 16) {
435 struct inode *inode = file_inode(vma->vm_file);
437 CWARN("%s: FID "DFID" under heavy mmap contention by '%s', consider revising IO pattern\n",
438 ll_i2sbi(inode)->ll_fsname,
439 PFID(&ll_i2info(inode)->lli_fid),
447 result |= VM_FAULT_LOCKED;
449 sigprocmask(SIG_SETMASK, &old, NULL);
452 if (vmf->page && result == VM_FAULT_LOCKED) {
453 ll_rw_stats_tally(ll_i2sbi(file_inode(vma->vm_file)),
454 current->pid, vma->vm_file->private_data,
455 vmf->page->index << PAGE_SHIFT, PAGE_SIZE,
457 ll_stats_ops_tally(ll_i2sbi(file_inode(vma->vm_file)),
459 ktime_us_delta(ktime_get(), kstart));
463 "COMPLETED: "DFID": vma=%p start=%#lx end=%#lx vm_flags=%#lx idx=%lu\n",
464 PFID(&ll_i2info(file_inode(vma->vm_file))->lli_fid),
465 vma, vma->vm_start, vma->vm_end, vma->vm_flags, vmf->pgoff);
470 #ifdef HAVE_VM_OPS_USE_VM_FAULT_ONLY
471 static vm_fault_t ll_page_mkwrite(struct vm_fault *vmf)
473 struct vm_area_struct *vma = vmf->vma;
475 static vm_fault_t ll_page_mkwrite(struct vm_area_struct *vma,
476 struct vm_fault *vmf)
480 bool printed = false;
483 ktime_t kstart = ktime_get();
486 CDEBUG(D_MMAP|D_IOTRACE,
487 "START file %s:"DFID", vma=%p start=%#lx end=%#lx vm_flags=%#lx idx=%lu\n",
488 file_dentry(vma->vm_file)->d_name.name,
489 PFID(&ll_i2info(file_inode(vma->vm_file))->lli_fid),
490 vma, vma->vm_start, vma->vm_end, vma->vm_flags, vmf->page->index);
492 result = pcc_page_mkwrite(vma, vmf, &cached);
496 file_update_time(vma->vm_file);
499 result = ll_page_mkwrite0(vma, vmf->page, &retry);
501 if (!printed && ++count > 16) {
502 const struct dentry *de = file_dentry(vma->vm_file);
504 CWARN("app(%s): the page %lu of file "DFID" is under heavy contention\n",
505 current->comm, vmf->pgoff,
506 PFID(ll_inode2fid(de->d_inode)));
513 LASSERT(PageLocked(vmf->page));
514 result = VM_FAULT_LOCKED;
518 result = VM_FAULT_NOPAGE;
521 result = VM_FAULT_OOM;
524 result = VM_FAULT_RETRY;
527 result = VM_FAULT_SIGBUS;
532 if (result == VM_FAULT_LOCKED) {
533 ll_rw_stats_tally(ll_i2sbi(file_inode(vma->vm_file)),
534 current->pid, vma->vm_file->private_data,
535 vmf->page->index << PAGE_SHIFT, PAGE_SIZE,
537 ll_stats_ops_tally(ll_i2sbi(file_inode(vma->vm_file)),
539 ktime_us_delta(ktime_get(), kstart));
543 "COMPLETED: "DFID": vma=%p start=%#lx end=%#lx vm_flags=%#lx idx=%lu\n",
544 PFID(&ll_i2info(file_inode(vma->vm_file))->lli_fid),
545 vma, vma->vm_start, vma->vm_end, vma->vm_flags,
551 * To avoid cancel the locks covering mmapped region for lock cache pressure,
552 * we track the mapped vma count in vvp_object::vob_mmap_cnt.
554 static void ll_vm_open(struct vm_area_struct * vma)
556 struct inode *inode = file_inode(vma->vm_file);
557 struct vvp_object *vob = cl_inode2vvp(inode);
560 LASSERT(atomic_read(&vob->vob_mmap_cnt) >= 0);
561 atomic_inc(&vob->vob_mmap_cnt);
567 * Dual to ll_vm_open().
569 static void ll_vm_close(struct vm_area_struct *vma)
571 struct inode *inode = file_inode(vma->vm_file);
572 struct vvp_object *vob = cl_inode2vvp(inode);
575 atomic_dec(&vob->vob_mmap_cnt);
576 LASSERT(atomic_read(&vob->vob_mmap_cnt) >= 0);
581 static const struct vm_operations_struct ll_file_vm_ops = {
583 .page_mkwrite = ll_page_mkwrite,
585 .close = ll_vm_close,
588 int ll_file_mmap(struct file *file, struct vm_area_struct * vma)
590 struct inode *inode = file_inode(file);
591 ktime_t kstart = ktime_get();
596 CDEBUG(D_VFSTRACE | D_MMAP,
597 "VFS_Op: fid="DFID" vma=%p start=%#lx end=%#lx vm_flags=%#lx\n",
598 PFID(&ll_i2info(inode)->lli_fid),
599 vma, vma->vm_start, vma->vm_end, vma->vm_flags);
601 if (ll_file_nolock(file))
604 rc = pcc_file_mmap(file, vma, &cached);
605 if (cached && rc != 0)
608 rc = generic_file_mmap(file, vma);
610 vma->vm_ops = &ll_file_vm_ops;
611 vma->vm_ops->open(vma);
612 /* update the inode's size and mtime */
614 rc = ll_glimpse_size(inode);
618 ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MMAP,
619 ktime_us_delta(ktime_get(), kstart));