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         /* 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 = vvp_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 == 0) {
 223                 lock_page(vmpage);
 224                 if (vmpage->mapping == NULL) {
 225                         unlock_page(vmpage);
 226
 227                         /* page was truncated and lock was cancelled, return
 228                          * ENODATA so that VM_FAULT_NOPAGE will be returned
 229                          * to handle_mm_fault(). */
 230                         if (result == 0)
 231                                 result = -ENODATA;
 232                 } else if (!PageDirty(vmpage)) {
 233                         /* race, the page has been cleaned by ptlrpcd after
 234                          * it was unlocked, it has to be added into dirty
 235                          * cache again otherwise this soon-to-dirty page won't
 236                          * consume any grants, even worse if this page is being
 237                          * transferred because it will break RPC checksum.
 238                          */
 239                         unlock_page(vmpage);
 240
 241                         CDEBUG(D_MMAP, "Race on page_mkwrite %p/%lu, page has "
 242                                "been written out, retry.\n",
 243                                vmpage, vmpage->index);
 244
 245                         *retry = true;
 246                         result = -EAGAIN;
 247                 }
 248
 249                 if (result == 0)
 250                         ll_file_set_flag(lli, LLIF_DATA_MODIFIED);
 251         }
 252         EXIT;
 253
 254 out_io:
 255         cl_io_fini(env, io);
 256         cl_env_nested_put(&nest, env);
 257 out:
 258         CDEBUG(D_MMAP, "%s mkwrite with %d\n", current->comm, result);
 259         LASSERT(ergo(result == 0, PageLocked(vmpage)));
 260
 261         return result;
 262 }
 263
 264 static inline int to_fault_error(int result)
 265 {
 266         switch(result) {
 267         case 0:
 268                 result = VM_FAULT_LOCKED;
 269                 break;
 270         case -EFAULT:
 271                 result = VM_FAULT_NOPAGE;
 272                 break;
 273         case -ENOMEM:
 274                 result = VM_FAULT_OOM;
 275                 break;
 276         default:
 277                 result = VM_FAULT_SIGBUS;
 278                 break;
 279         }
 280         return result;
 281 }
 282
 283 /**
 284  * Lustre implementation of a vm_operations_struct::fault() method, called by
 285  * VM to server page fault (both in kernel and user space).
 286  *
 287  * \param vma - is virtiual area struct related to page fault
 288  * \param vmf - structure which describe type and address where hit fault
 289  *
 290  * \return allocated and filled _locked_ page for address
 291  * \retval VM_FAULT_ERROR on general error
 292  * \retval NOPAGE_OOM not have memory for allocate new page
 293  */
 294 static int ll_fault0(struct vm_area_struct *vma, struct vm_fault *vmf)
 295 {
 296         struct lu_env           *env;
 297         struct cl_io            *io;
 298         struct vvp_io           *vio = NULL;
 299         struct page             *vmpage;
 300         unsigned long            ra_flags;
 301         struct cl_env_nest       nest;
 302         int                      result;
 303         int                      fault_ret = 0;
 304         ENTRY;
 305
 306         io = ll_fault_io_init(vma, &env,  &nest, vmf->pgoff, &ra_flags);
 307         if (IS_ERR(io))
 308                 RETURN(to_fault_error(PTR_ERR(io)));
 309
 310         result = io->ci_result;
 311         if (result == 0) {
 312                 vio = vvp_env_io(env);
 313                 vio->u.fault.ft_vma       = vma;
 314                 vio->u.fault.ft_vmpage    = NULL;
 315                 vio->u.fault.ft_vmf = vmf;
 316                 vio->u.fault.ft_flags = 0;
 317                 vio->u.fault.ft_flags_valid = 0;
 318
 319                 /* May call ll_readpage() */
 320                 ll_cl_add(vma->vm_file, env, io);
 321
 322                 result = cl_io_loop(env, io);
 323
 324                 ll_cl_remove(vma->vm_file, env);
 325
 326                 /* ft_flags are only valid if we reached
 327                  * the call to filemap_fault */
 328                 if (vio->u.fault.ft_flags_valid)
 329                         fault_ret = vio->u.fault.ft_flags;
 330
 331                 vmpage = vio->u.fault.ft_vmpage;
 332                 if (result != 0 && vmpage != NULL) {
 333                         page_cache_release(vmpage);
 334                         vmf->page = NULL;
 335                 }
 336         }
 337         cl_io_fini(env, io);
 338         cl_env_nested_put(&nest, env);
 339
 340         vma->vm_flags |= ra_flags;
 341         if (result != 0 && !(fault_ret & VM_FAULT_RETRY))
 342                 fault_ret |= to_fault_error(result);
 343
 344         CDEBUG(D_MMAP, "%s fault %d/%d\n",
 345                current->comm, fault_ret, result);
 346         RETURN(fault_ret);
 347 }
 348
 349 static int ll_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
 350 {
 351         int count = 0;
 352         bool printed = false;
 353         int result;
 354         sigset_t set;
 355
 356         /* Only SIGKILL and SIGTERM is allowed for fault/nopage/mkwrite
 357          * so that it can be killed by admin but not cause segfault by
 358          * other signals. */
 359         set = cfs_block_sigsinv(sigmask(SIGKILL) | sigmask(SIGTERM));
 360
 361 restart:
 362         result = ll_fault0(vma, vmf);
 363         LASSERT(!(result & VM_FAULT_LOCKED));
 364         if (result == 0) {
 365                 struct page *vmpage = vmf->page;
 366
 367                 /* check if this page has been truncated */
 368                 lock_page(vmpage);
 369                 if (unlikely(vmpage->mapping == NULL)) { /* unlucky */
 370                         unlock_page(vmpage);
 371                         page_cache_release(vmpage);
 372                         vmf->page = NULL;
 373
 374                         if (!printed && ++count > 16) {
 375                                 CWARN("the page is under heavy contention,"
 376                                       "maybe your app(%s) needs revising :-)\n",
 377                                       current->comm);
 378                                 printed = true;
 379                         }
 380
 381                         goto restart;
 382                 }
 383
 384                 result |= VM_FAULT_LOCKED;
 385         }
 386         cfs_restore_sigs(set);
 387         return result;
 388 }
 389
 390 static int ll_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
 391 {
 392         int count = 0;
 393         bool printed = false;
 394         bool retry;
 395         int result;
 396
 397         do {
 398                 retry = false;
 399                 result = ll_page_mkwrite0(vma, vmf->page, &retry);
 400
 401                 if (!printed && ++count > 16) {
 402                         const struct dentry *de = vma->vm_file->f_path.dentry;
 403
 404                         CWARN("app(%s): the page %lu of file "DFID" is under"
 405                               " heavy contention\n",
 406                               current->comm, vmf->pgoff,
 407                               PFID(ll_inode2fid(de->d_inode)));
 408                         printed = true;
 409                 }
 410         } while (retry);
 411
 412         switch(result) {
 413         case 0:
 414                 LASSERT(PageLocked(vmf->page));
 415                 result = VM_FAULT_LOCKED;
 416                 break;
 417         case -ENODATA:
 418         case -EFAULT:
 419                 result = VM_FAULT_NOPAGE;
 420                 break;
 421         case -ENOMEM:
 422                 result = VM_FAULT_OOM;
 423                 break;
 424         case -EAGAIN:
 425                 result = VM_FAULT_RETRY;
 426                 break;
 427         default:
 428                 result = VM_FAULT_SIGBUS;
 429                 break;
 430         }
 431
 432         return result;
 433 }
 434
 435 /**
 436  *  To avoid cancel the locks covering mmapped region for lock cache pressure,
 437  *  we track the mapped vma count in vvp_object::vob_mmap_cnt.
 438  */
 439 static void ll_vm_open(struct vm_area_struct * vma)
 440 {
 441         struct inode *inode    = vma->vm_file->f_path.dentry->d_inode;
 442         struct vvp_object *vob = cl_inode2vvp(inode);
 443
 444         ENTRY;
 445         LASSERT(vma->vm_file);
 446         LASSERT(atomic_read(&vob->vob_mmap_cnt) >= 0);
 447         atomic_inc(&vob->vob_mmap_cnt);
 448         EXIT;
 449 }
 450
 451 /**
 452  * Dual to ll_vm_open().
 453  */
 454 static void ll_vm_close(struct vm_area_struct *vma)
 455 {
 456         struct inode      *inode = vma->vm_file->f_path.dentry->d_inode;
 457         struct vvp_object *vob   = cl_inode2vvp(inode);
 458
 459         ENTRY;
 460         LASSERT(vma->vm_file);
 461         atomic_dec(&vob->vob_mmap_cnt);
 462         LASSERT(atomic_read(&vob->vob_mmap_cnt) >= 0);
 463         EXIT;
 464 }
 465
 466 /* XXX put nice comment here.  talk about __free_pte -> dirty pages and
 467  * nopage's reference passing to the pte */
 468 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last)
 469 {
 470         int rc = -ENOENT;
 471         ENTRY;
 472
 473         LASSERTF(last > first, "last "LPU64" first "LPU64"\n", last, first);
 474         if (mapping_mapped(mapping)) {
 475                 rc = 0;
 476                 unmap_mapping_range(mapping, first + PAGE_CACHE_SIZE - 1,
 477                                     last - first + 1, 0);
 478         }
 479
 480         RETURN(rc);
 481 }
 482
 483 static const struct vm_operations_struct ll_file_vm_ops = {
 484         .fault                  = ll_fault,
 485         .page_mkwrite           = ll_page_mkwrite,
 486         .open                   = ll_vm_open,
 487         .close                  = ll_vm_close,
 488 };
 489
 490 int ll_file_mmap(struct file *file, struct vm_area_struct * vma)
 491 {
 492         struct inode *inode = file->f_path.dentry->d_inode;
 493         int rc;
 494         ENTRY;
 495
 496         if (ll_file_nolock(file))
 497                 RETURN(-EOPNOTSUPP);
 498
 499         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MAP, 1);
 500         rc = generic_file_mmap(file, vma);
 501         if (rc == 0) {
 502                 vma->vm_ops = &ll_file_vm_ops;
 503                 vma->vm_ops->open(vma);
 504                 /* update the inode's size and mtime */
 505                 rc = ll_glimpse_size(inode);
 506         }
 507
 508         RETURN(rc);
 509 }