drivers/staging/lustre/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/uaccess.h>
  44
  45 #include <linux/fs.h>
  46 #include <linux/pagemap.h>
  47
  48 #define DEBUG_SUBSYSTEM S_LLITE
  49
  50 #include "../include/lustre_lite.h"
  51 #include "llite_internal.h"
  52 #include "../include/linux/lustre_compat25.h"
  53
  54 static const struct vm_operations_struct ll_file_vm_ops;
  55
  56 void policy_from_vma(ldlm_policy_data_t *policy,
  57                      struct vm_area_struct *vma, unsigned long addr,
  58                      size_t count)
  59 {
  60         policy->l_extent.start = ((addr - vma->vm_start) & PAGE_MASK) +
  61                                  (vma->vm_pgoff << PAGE_SHIFT);
  62         policy->l_extent.end = (policy->l_extent.start + count - 1) |
  63                                ~PAGE_MASK;
  64 }
  65
  66 struct vm_area_struct *our_vma(struct mm_struct *mm, unsigned long addr,
  67                                size_t count)
  68 {
  69         struct vm_area_struct *vma, *ret = NULL;
  70
  71         /* mmap_sem must have been held by caller. */
  72         LASSERT(!down_write_trylock(&mm->mmap_sem));
  73
  74         for (vma = find_vma(mm, addr);
  75             vma && vma->vm_start < (addr + count); vma = vma->vm_next) {
  76                 if (vma->vm_ops && vma->vm_ops == &ll_file_vm_ops &&
  77                     vma->vm_flags & VM_SHARED) {
  78                         ret = vma;
  79                         break;
  80                 }
  81         }
  82         return ret;
  83 }
  84
  85 /**
  86  * API independent part for page fault initialization.
  87  * \param vma - virtual memory area addressed to page fault
  88  * \param env - corespondent lu_env to processing
  89  * \param nest - nested level
  90  * \param index - page index corespondent to fault.
  91  * \parm ra_flags - vma readahead flags.
  92  *
  93  * \return allocated and initialized env for fault operation.
  94  * \retval EINVAL if env can't allocated
  95  * \return other error codes from cl_io_init.
  96  */
  97 static struct cl_io *
  98 ll_fault_io_init(struct vm_area_struct *vma, struct lu_env **env_ret,
  99                  struct cl_env_nest *nest, pgoff_t index,
 100                  unsigned long *ra_flags)
 101 {
 102         struct file            *file = vma->vm_file;
 103         struct inode           *inode = file_inode(file);
 104         struct cl_io           *io;
 105         struct cl_fault_io     *fio;
 106         struct lu_env          *env;
 107         int                     rc;
 108
 109         *env_ret = NULL;
 110         if (ll_file_nolock(file))
 111                 return ERR_PTR(-EOPNOTSUPP);
 112
 113         /*
 114          * page fault can be called when lustre IO is
 115          * already active for the current thread, e.g., when doing read/write
 116          * against user level buffer mapped from Lustre buffer. To avoid
 117          * stomping on existing context, optionally force an allocation of a new
 118          * one.
 119          */
 120         env = cl_env_nested_get(nest);
 121         if (IS_ERR(env))
 122                 return ERR_PTR(-EINVAL);
 123
 124         *env_ret = env;
 125
 126 restart:
 127         io = vvp_env_thread_io(env);
 128         io->ci_obj = ll_i2info(inode)->lli_clob;
 129         LASSERT(io->ci_obj);
 130
 131         fio = &io->u.ci_fault;
 132         fio->ft_index      = index;
 133         fio->ft_executable = vma->vm_flags&VM_EXEC;
 134
 135         /*
 136          * disable VM_SEQ_READ and use VM_RAND_READ to make sure that
 137          * the kernel will not read other pages not covered by ldlm in
 138          * filemap_nopage. we do our readahead in ll_readpage.
 139          */
 140         if (ra_flags)
 141                 *ra_flags = vma->vm_flags & (VM_RAND_READ|VM_SEQ_READ);
 142         vma->vm_flags &= ~VM_SEQ_READ;
 143         vma->vm_flags |= VM_RAND_READ;
 144
 145         CDEBUG(D_MMAP, "vm_flags: %lx (%lu %d)\n", vma->vm_flags,
 146                fio->ft_index, fio->ft_executable);
 147
 148         rc = cl_io_init(env, io, CIT_FAULT, io->ci_obj);
 149         if (rc == 0) {
 150                 struct vvp_io *vio = vvp_env_io(env);
 151                 struct ll_file_data *fd = LUSTRE_FPRIVATE(file);
 152
 153                 LASSERT(vio->vui_cl.cis_io == io);
 154
 155                 /* mmap lock must be MANDATORY it has to cache pages. */
 156                 io->ci_lockreq = CILR_MANDATORY;
 157                 vio->vui_fd = fd;
 158         } else {
 159                 LASSERT(rc < 0);
 160                 cl_io_fini(env, io);
 161                 if (io->ci_need_restart)
 162                         goto restart;
 163
 164                 cl_env_nested_put(nest, env);
 165                 io = ERR_PTR(rc);
 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         sigset_t             set;
 181         struct inode         *inode;
 182         struct ll_inode_info     *lli;
 183
 184         io = ll_fault_io_init(vma, &env,  &nest, vmpage->index, NULL);
 185         if (IS_ERR(io)) {
 186                 result = PTR_ERR(io);
 187                 goto out;
 188         }
 189
 190         result = io->ci_result;
 191         if (result < 0)
 192                 goto out_io;
 193
 194         io->u.ci_fault.ft_mkwrite = 1;
 195         io->u.ci_fault.ft_writable = 1;
 196
 197         vio = vvp_env_io(env);
 198         vio->u.fault.ft_vma    = vma;
 199         vio->u.fault.ft_vmpage = vmpage;
 200
 201         set = cfs_block_sigsinv(sigmask(SIGKILL) | sigmask(SIGTERM));
 202
 203         /* we grab lli_trunc_sem to exclude truncate case.
 204          * Otherwise, we could add dirty pages into osc cache
 205          * while truncate is on-going.
 206          */
 207         inode = vvp_object_inode(io->ci_obj);
 208         lli = ll_i2info(inode);
 209         down_read(&lli->lli_trunc_sem);
 210
 211         result = cl_io_loop(env, io);
 212
 213         up_read(&lli->lli_trunc_sem);
 214
 215         cfs_restore_sigs(set);
 216
 217         if (result == 0) {
 218                 struct inode *inode = file_inode(vma->vm_file);
 219                 struct ll_inode_info *lli = ll_i2info(inode);
 220
 221                 lock_page(vmpage);
 222                 if (!vmpage->mapping) {
 223                         unlock_page(vmpage);
 224
 225                         /* page was truncated and lock was cancelled, return
 226                          * ENODATA so that VM_FAULT_NOPAGE will be returned
 227                          * to handle_mm_fault().
 228                          */
 229                         if (result == 0)
 230                                 result = -ENODATA;
 231                 } else if (!PageDirty(vmpage)) {
 232                         /* race, the page has been cleaned by ptlrpcd after
 233                          * it was unlocked, it has to be added into dirty
 234                          * cache again otherwise this soon-to-dirty page won't
 235                          * consume any grants, even worse if this page is being
 236                          * transferred because it will break RPC checksum.
 237                          */
 238                         unlock_page(vmpage);
 239
 240                         CDEBUG(D_MMAP, "Race on page_mkwrite %p/%lu, page has been written out, retry.\n",
 241                                vmpage, vmpage->index);
 242
 243                         *retry = true;
 244                         result = -EAGAIN;
 245                 }
 246
 247                 if (result == 0) {
 248                         spin_lock(&lli->lli_lock);
 249                         lli->lli_flags |= LLIF_DATA_MODIFIED;
 250                         spin_unlock(&lli->lli_lock);
 251                 }
 252         }
 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 virtual 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
 305         io = ll_fault_io_init(vma, &env,  &nest, vmf->pgoff, &ra_flags);
 306         if (IS_ERR(io))
 307                 return to_fault_error(PTR_ERR(io));
 308
 309         result = io->ci_result;
 310         if (result == 0) {
 311                 vio = vvp_env_io(env);
 312                 vio->u.fault.ft_vma       = vma;
 313                 vio->u.fault.ft_vmpage    = NULL;
 314                 vio->u.fault.ft_vmf = vmf;
 315                 vio->u.fault.ft_flags = 0;
 316                 vio->u.fault.ft_flags_valid = false;
 317
 318                 /* May call ll_readpage() */
 319                 ll_cl_add(vma->vm_file, env, io);
 320
 321                 result = cl_io_loop(env, io);
 322
 323                 ll_cl_remove(vma->vm_file, env);
 324
 325                 /* ft_flags are only valid if we reached
 326                  * the call to filemap_fault
 327                  */
 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) {
 333                         put_page(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 are allowed for fault/nopage/mkwrite
 357          * so that it can be killed by admin but not cause segfault by
 358          * other signals.
 359          */
 360         set = cfs_block_sigsinv(sigmask(SIGKILL) | sigmask(SIGTERM));
 361
 362 restart:
 363         result = ll_fault0(vma, vmf);
 364         LASSERT(!(result & VM_FAULT_LOCKED));
 365         if (result == 0) {
 366                 struct page *vmpage = vmf->page;
 367
 368                 /* check if this page has been truncated */
 369                 lock_page(vmpage);
 370                 if (unlikely(!vmpage->mapping)) { /* unlucky */
 371                         unlock_page(vmpage);
 372                         put_page(vmpage);
 373                         vmf->page = NULL;
 374
 375                         if (!printed && ++count > 16) {
 376                                 CWARN("the page is under heavy contention, 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 heavy contention\n",
 405                               current->comm, vmf->pgoff,
 406                               PFID(ll_inode2fid(de->d_inode)));
 407                         printed = true;
 408                 }
 409         } while (retry);
 410
 411         switch (result) {
 412         case 0:
 413                 LASSERT(PageLocked(vmf->page));
 414                 result = VM_FAULT_LOCKED;
 415                 break;
 416         case -ENODATA:
 417         case -EFAULT:
 418                 result = VM_FAULT_NOPAGE;
 419                 break;
 420         case -ENOMEM:
 421                 result = VM_FAULT_OOM;
 422                 break;
 423         case -EAGAIN:
 424                 result = VM_FAULT_RETRY;
 425                 break;
 426         default:
 427                 result = VM_FAULT_SIGBUS;
 428                 break;
 429         }
 430
 431         return result;
 432 }
 433
 434 /**
 435  *  To avoid cancel the locks covering mmapped region for lock cache pressure,
 436  *  we track the mapped vma count in vvp_object::vob_mmap_cnt.
 437  */
 438 static void ll_vm_open(struct vm_area_struct *vma)
 439 {
 440         struct inode *inode    = file_inode(vma->vm_file);
 441         struct vvp_object *vob = cl_inode2vvp(inode);
 442
 443         LASSERT(vma->vm_file);
 444         LASSERT(atomic_read(&vob->vob_mmap_cnt) >= 0);
 445         atomic_inc(&vob->vob_mmap_cnt);
 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 = file_inode(vma->vm_file);
 454         struct vvp_object *vob   = cl_inode2vvp(inode);
 455
 456         LASSERT(vma->vm_file);
 457         atomic_dec(&vob->vob_mmap_cnt);
 458         LASSERT(atomic_read(&vob->vob_mmap_cnt) >= 0);
 459 }
 460
 461 /* XXX put nice comment here.  talk about __free_pte -> dirty pages and
 462  * nopage's reference passing to the pte
 463  */
 464 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last)
 465 {
 466         int rc = -ENOENT;
 467
 468         LASSERTF(last > first, "last %llu first %llu\n", last, first);
 469         if (mapping_mapped(mapping)) {
 470                 rc = 0;
 471                 unmap_mapping_range(mapping, first + PAGE_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_inode(file);
 488         int rc;
 489
 490         if (ll_file_nolock(file))
 491                 return -EOPNOTSUPP;
 492
 493         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MAP, 1);
 494         rc = generic_file_mmap(file, vma);
 495         if (rc == 0) {
 496                 vma->vm_ops = &ll_file_vm_ops;
 497                 vma->vm_ops->open(vma);
 498                 /* update the inode's size and mtime */
 499                 rc = ll_glimpse_size(inode);
 500         }
 501
 502         return rc;
 503 }