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, 2015, 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 "llite_internal.h"
  55 #include <lustre_compat.h>
  56
  57 static const struct vm_operations_struct ll_file_vm_ops;
  58
  59 void policy_from_vma(union ldlm_policy_data *policy, struct vm_area_struct *vma,
  60                      unsigned long addr, size_t count)
  61 {
  62         policy->l_extent.start = ((addr - vma->vm_start) & PAGE_MASK) +
  63                                  (vma->vm_pgoff << PAGE_CACHE_SHIFT);
  64         policy->l_extent.end = (policy->l_extent.start + count - 1) |
  65                                ~PAGE_MASK;
  66 }
  67
  68 struct vm_area_struct *our_vma(struct mm_struct *mm, unsigned long addr,
  69                                size_t count)
  70 {
  71         struct vm_area_struct *vma, *ret = NULL;
  72         ENTRY;
  73
  74         /* mmap_sem must have been held by caller. */
  75         LASSERT(!down_write_trylock(&mm->mmap_sem));
  76
  77         for(vma = find_vma(mm, addr);
  78             vma != NULL && vma->vm_start < (addr + count); vma = vma->vm_next) {
  79                 if (vma->vm_ops && vma->vm_ops == &ll_file_vm_ops &&
  80                     vma->vm_flags & VM_SHARED) {
  81                         ret = vma;
  82                         break;
  83                 }
  84         }
  85         RETURN(ret);
  86 }
  87
  88 /**
  89  * API independent part for page fault initialization.
  90  * \param vma - virtual memory area addressed to page fault
  91  * \param env - corespondent lu_env to processing
  92  * \param nest - nested level
  93  * \param index - page index corespondent to fault.
  94  * \parm ra_flags - vma readahead flags.
  95  *
  96  * \return allocated and initialized env for fault operation.
  97  * \retval EINVAL if env can't allocated
  98  * \return other error codes from cl_io_init.
  99  */
 100 static struct cl_io *
 101 ll_fault_io_init(struct vm_area_struct *vma, struct lu_env **env_ret,
 102                  struct cl_env_nest *nest, pgoff_t index,
 103                  unsigned long *ra_flags)
 104 {
 105         struct file            *file = vma->vm_file;
 106         struct inode           *inode = file->f_path.dentry->d_inode;
 107         struct cl_io           *io;
 108         struct cl_fault_io     *fio;
 109         struct lu_env          *env;
 110         int                     rc;
 111         ENTRY;
 112
 113         *env_ret = NULL;
 114         if (ll_file_nolock(file))
 115                 RETURN(ERR_PTR(-EOPNOTSUPP));
 116
 117         /*
 118          * page fault can be called when lustre IO is
 119          * already active for the current thread, e.g., when doing read/write
 120          * against user level buffer mapped from Lustre buffer. To avoid
 121          * stomping on existing context, optionally force an allocation of a new
 122          * one.
 123          */
 124         env = cl_env_nested_get(nest);
 125         if (IS_ERR(env))
 126                  RETURN(ERR_PTR(-EINVAL));
 127
 128         *env_ret = env;
 129
 130 restart:
 131         io = vvp_env_thread_io(env);
 132         io->ci_obj = ll_i2info(inode)->lli_clob;
 133         LASSERT(io->ci_obj != NULL);
 134
 135         fio = &io->u.ci_fault;
 136         fio->ft_index      = index;
 137         fio->ft_executable = vma->vm_flags&VM_EXEC;
 138
 139         /*
 140          * disable VM_SEQ_READ and use VM_RAND_READ to make sure that
 141          * the kernel will not read other pages not covered by ldlm in
 142          * filemap_nopage. we do our readahead in ll_readpage.
 143          */
 144         if (ra_flags != NULL)
 145                 *ra_flags = vma->vm_flags & (VM_RAND_READ|VM_SEQ_READ);
 146         vma->vm_flags &= ~VM_SEQ_READ;
 147         vma->vm_flags |= VM_RAND_READ;
 148
 149         CDEBUG(D_MMAP, "vm_flags: %lx (%lu %d)\n", vma->vm_flags,
 150                fio->ft_index, fio->ft_executable);
 151
 152         rc = cl_io_init(env, io, CIT_FAULT, io->ci_obj);
 153         if (rc == 0) {
 154                 struct vvp_io *vio = vvp_env_io(env);
 155                 struct ll_file_data *fd = LUSTRE_FPRIVATE(file);
 156
 157                 LASSERT(vio->vui_cl.cis_io == io);
 158
 159                 /* mmap lock must be MANDATORY it has to cache
 160                  * pages. */
 161                 io->ci_lockreq = CILR_MANDATORY;
 162                 vio->vui_fd = fd;
 163         } else {
 164                 LASSERT(rc < 0);
 165                 cl_io_fini(env, io);
 166                 if (io->ci_need_restart)
 167                         goto restart;
 168
 169                 cl_env_nested_put(nest, env);
 170                 io = ERR_PTR(rc);
 171         }
 172
 173         RETURN(io);
 174 }
 175
 176 /* Sharing code of page_mkwrite method for rhel5 and rhel6 */
 177 static int ll_page_mkwrite0(struct vm_area_struct *vma, struct page *vmpage,
 178                             bool *retry)
 179 {
 180         struct lu_env           *env;
 181         struct cl_io            *io;
 182         struct vvp_io           *vio;
 183         struct cl_env_nest       nest;
 184         int                      result;
 185         sigset_t                 set;
 186         struct inode             *inode;
 187         struct ll_inode_info     *lli;
 188         ENTRY;
 189
 190         LASSERT(vmpage != NULL);
 191
 192         io = ll_fault_io_init(vma, &env,  &nest, vmpage->index, NULL);
 193         if (IS_ERR(io))
 194                 GOTO(out, result = PTR_ERR(io));
 195
 196         result = io->ci_result;
 197         if (result < 0)
 198                 GOTO(out_io, result);
 199
 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         inode = vvp_object_inode(io->ci_obj);
 210         lli = ll_i2info(inode);
 211
 212         result = cl_io_loop(env, io);
 213
 214         cfs_restore_sigs(set);
 215
 216         if (result == 0) {
 217                 lock_page(vmpage);
 218                 if (vmpage->mapping == NULL) {
 219                         unlock_page(vmpage);
 220
 221                         /* page was truncated and lock was cancelled, return
 222                          * ENODATA so that VM_FAULT_NOPAGE will be returned
 223                          * to handle_mm_fault(). */
 224                         if (result == 0)
 225                                 result = -ENODATA;
 226                 } else if (!PageDirty(vmpage)) {
 227                         /* race, the page has been cleaned by ptlrpcd after
 228                          * it was unlocked, it has to be added into dirty
 229                          * cache again otherwise this soon-to-dirty page won't
 230                          * consume any grants, even worse if this page is being
 231                          * transferred because it will break RPC checksum.
 232                          */
 233                         unlock_page(vmpage);
 234
 235                         CDEBUG(D_MMAP, "Race on page_mkwrite %p/%lu, page has "
 236                                "been written out, retry.\n",
 237                                vmpage, vmpage->index);
 238
 239                         *retry = true;
 240                         result = -EAGAIN;
 241                 }
 242
 243                 if (result == 0)
 244                         ll_file_set_flag(lli, LLIF_DATA_MODIFIED);
 245         }
 246         EXIT;
 247
 248 out_io:
 249         cl_io_fini(env, io);
 250         cl_env_nested_put(&nest, env);
 251 out:
 252         CDEBUG(D_MMAP, "%s mkwrite with %d\n", current->comm, result);
 253         LASSERT(ergo(result == 0, PageLocked(vmpage)));
 254
 255         return result;
 256 }
 257
 258 static inline int to_fault_error(int result)
 259 {
 260         switch(result) {
 261         case 0:
 262                 result = VM_FAULT_LOCKED;
 263                 break;
 264         case -EFAULT:
 265                 result = VM_FAULT_NOPAGE;
 266                 break;
 267         case -ENOMEM:
 268                 result = VM_FAULT_OOM;
 269                 break;
 270         default:
 271                 result = VM_FAULT_SIGBUS;
 272                 break;
 273         }
 274         return result;
 275 }
 276
 277 /**
 278  * Lustre implementation of a vm_operations_struct::fault() method, called by
 279  * VM to server page fault (both in kernel and user space).
 280  *
 281  * \param vma - is virtiual area struct related to page fault
 282  * \param vmf - structure which describe type and address where hit fault
 283  *
 284  * \return allocated and filled _locked_ page for address
 285  * \retval VM_FAULT_ERROR on general error
 286  * \retval NOPAGE_OOM not have memory for allocate new page
 287  */
 288 static int ll_fault0(struct vm_area_struct *vma, struct vm_fault *vmf)
 289 {
 290         struct lu_env           *env;
 291         struct cl_io            *io;
 292         struct vvp_io           *vio = NULL;
 293         struct page             *vmpage;
 294         unsigned long            ra_flags;
 295         struct cl_env_nest       nest;
 296         int                      result;
 297         int                      fault_ret = 0;
 298         ENTRY;
 299
 300         io = ll_fault_io_init(vma, &env,  &nest, vmf->pgoff, &ra_flags);
 301         if (IS_ERR(io))
 302                 RETURN(to_fault_error(PTR_ERR(io)));
 303
 304         result = io->ci_result;
 305         if (result == 0) {
 306                 vio = vvp_env_io(env);
 307                 vio->u.fault.ft_vma       = vma;
 308                 vio->u.fault.ft_vmpage    = NULL;
 309                 vio->u.fault.ft_vmf = vmf;
 310                 vio->u.fault.ft_flags = 0;
 311                 vio->u.fault.ft_flags_valid = 0;
 312
 313                 /* May call ll_readpage() */
 314                 ll_cl_add(vma->vm_file, env, io);
 315
 316                 result = cl_io_loop(env, io);
 317
 318                 ll_cl_remove(vma->vm_file, env);
 319
 320                 /* ft_flags are only valid if we reached
 321                  * the call to filemap_fault */
 322                 if (vio->u.fault.ft_flags_valid)
 323                         fault_ret = vio->u.fault.ft_flags;
 324
 325                 vmpage = vio->u.fault.ft_vmpage;
 326                 if (result != 0 && vmpage != NULL) {
 327                         page_cache_release(vmpage);
 328                         vmf->page = NULL;
 329                 }
 330         }
 331         cl_io_fini(env, io);
 332         cl_env_nested_put(&nest, env);
 333
 334         vma->vm_flags |= ra_flags;
 335         if (result != 0 && !(fault_ret & VM_FAULT_RETRY))
 336                 fault_ret |= to_fault_error(result);
 337
 338         CDEBUG(D_MMAP, "%s fault %d/%d\n",
 339                current->comm, fault_ret, result);
 340         RETURN(fault_ret);
 341 }
 342
 343 static int ll_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
 344 {
 345         int count = 0;
 346         bool printed = false;
 347         int result;
 348         sigset_t set;
 349
 350         /* Only SIGKILL and SIGTERM is allowed for fault/nopage/mkwrite
 351          * so that it can be killed by admin but not cause segfault by
 352          * other signals. */
 353         set = cfs_block_sigsinv(sigmask(SIGKILL) | sigmask(SIGTERM));
 354
 355 restart:
 356         result = ll_fault0(vma, vmf);
 357         LASSERT(!(result & VM_FAULT_LOCKED));
 358         if (result == 0) {
 359                 struct page *vmpage = vmf->page;
 360
 361                 /* check if this page has been truncated */
 362                 lock_page(vmpage);
 363                 if (unlikely(vmpage->mapping == NULL)) { /* unlucky */
 364                         unlock_page(vmpage);
 365                         page_cache_release(vmpage);
 366                         vmf->page = NULL;
 367
 368                         if (!printed && ++count > 16) {
 369                                 CWARN("the page is under heavy contention,"
 370                                       "maybe your app(%s) needs revising :-)\n",
 371                                       current->comm);
 372                                 printed = true;
 373                         }
 374
 375                         goto restart;
 376                 }
 377
 378                 result |= VM_FAULT_LOCKED;
 379         }
 380         cfs_restore_sigs(set);
 381         return result;
 382 }
 383
 384 static int ll_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
 385 {
 386         int count = 0;
 387         bool printed = false;
 388         bool retry;
 389         int result;
 390
 391         file_update_time(vma->vm_file);
 392         do {
 393                 retry = false;
 394                 result = ll_page_mkwrite0(vma, vmf->page, &retry);
 395
 396                 if (!printed && ++count > 16) {
 397                         const struct dentry *de = vma->vm_file->f_path.dentry;
 398
 399                         CWARN("app(%s): the page %lu of file "DFID" is under"
 400                               " heavy contention\n",
 401                               current->comm, vmf->pgoff,
 402                               PFID(ll_inode2fid(de->d_inode)));
 403                         printed = true;
 404                 }
 405         } while (retry);
 406
 407         switch(result) {
 408         case 0:
 409                 LASSERT(PageLocked(vmf->page));
 410                 result = VM_FAULT_LOCKED;
 411                 break;
 412         case -ENODATA:
 413         case -EFAULT:
 414                 result = VM_FAULT_NOPAGE;
 415                 break;
 416         case -ENOMEM:
 417                 result = VM_FAULT_OOM;
 418                 break;
 419         case -EAGAIN:
 420                 result = VM_FAULT_RETRY;
 421                 break;
 422         default:
 423                 result = VM_FAULT_SIGBUS;
 424                 break;
 425         }
 426
 427         return result;
 428 }
 429
 430 /**
 431  *  To avoid cancel the locks covering mmapped region for lock cache pressure,
 432  *  we track the mapped vma count in vvp_object::vob_mmap_cnt.
 433  */
 434 static void ll_vm_open(struct vm_area_struct * vma)
 435 {
 436         struct inode *inode    = vma->vm_file->f_path.dentry->d_inode;
 437         struct vvp_object *vob = cl_inode2vvp(inode);
 438
 439         ENTRY;
 440         LASSERT(vma->vm_file);
 441         LASSERT(atomic_read(&vob->vob_mmap_cnt) >= 0);
 442         atomic_inc(&vob->vob_mmap_cnt);
 443         EXIT;
 444 }
 445
 446 /**
 447  * Dual to ll_vm_open().
 448  */
 449 static void ll_vm_close(struct vm_area_struct *vma)
 450 {
 451         struct inode      *inode = vma->vm_file->f_path.dentry->d_inode;
 452         struct vvp_object *vob   = cl_inode2vvp(inode);
 453
 454         ENTRY;
 455         LASSERT(vma->vm_file);
 456         atomic_dec(&vob->vob_mmap_cnt);
 457         LASSERT(atomic_read(&vob->vob_mmap_cnt) >= 0);
 458         EXIT;
 459 }
 460
 461 /* XXX put nice comment here.  talk about __free_pte -> dirty pages and
 462  * nopage's reference passing to the pte */
 463 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last)
 464 {
 465         int rc = -ENOENT;
 466         ENTRY;
 467
 468         LASSERTF(last > first, "last "LPU64" first "LPU64"\n", last, first);
 469         if (mapping_mapped(mapping)) {
 470                 rc = 0;
 471                 unmap_mapping_range(mapping, first + PAGE_CACHE_SIZE - 1,
 472                                     last - first + 1, 0);
 473         }
 474
 475         RETURN(rc);
 476 }
 477
 478 static const struct vm_operations_struct ll_file_vm_ops = {
 479         .fault                  = ll_fault,
 480         .page_mkwrite           = ll_page_mkwrite,
 481         .open                   = ll_vm_open,
 482         .close                  = ll_vm_close,
 483 };
 484
 485 int ll_file_mmap(struct file *file, struct vm_area_struct * vma)
 486 {
 487         struct inode *inode = file->f_path.dentry->d_inode;
 488         int rc;
 489         ENTRY;
 490
 491         if (ll_file_nolock(file))
 492                 RETURN(-EOPNOTSUPP);
 493
 494         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MAP, 1);
 495         rc = generic_file_mmap(file, vma);
 496         if (rc == 0) {
 497                 vma->vm_ops = &ll_file_vm_ops;
 498                 vma->vm_ops->open(vma);
 499                 /* update the inode's size and mtime */
 500                 rc = ll_glimpse_size(inode);
 501         }
 502
 503         RETURN(rc);
 504 }