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