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, 2012, 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 <asm/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) & CFS_PAGE_MASK) +
  61                                  (vma->vm_pgoff << PAGE_CACHE_SHIFT);
  62         policy->l_extent.end = (policy->l_extent.start + count - 1) |
  63                                ~CFS_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 != NULL && 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->f_dentry->d_inode;
 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         io = ccc_env_thread_io(env);
 127         io->ci_obj = ll_i2info(inode)->lli_clob;
 128         LASSERT(io->ci_obj != NULL);
 129
 130         fio = &io->u.ci_fault;
 131         fio->ft_index      = index;
 132         fio->ft_executable = vma->vm_flags&VM_EXEC;
 133
 134         /*
 135          * disable VM_SEQ_READ and use VM_RAND_READ to make sure that
 136          * the kernel will not read other pages not covered by ldlm in
 137          * filemap_nopage. we do our readahead in ll_readpage.
 138          */
 139         if (ra_flags != NULL)
 140                 *ra_flags = vma->vm_flags & (VM_RAND_READ|VM_SEQ_READ);
 141         vma->vm_flags &= ~VM_SEQ_READ;
 142         vma->vm_flags |= VM_RAND_READ;
 143
 144         CDEBUG(D_MMAP, "vm_flags: %lx (%lu %d)\n", vma->vm_flags,
 145                fio->ft_index, fio->ft_executable);
 146
 147         rc = cl_io_init(env, io, CIT_FAULT, io->ci_obj);
 148         if (rc == 0) {
 149                 struct ccc_io *cio = ccc_env_io(env);
 150                 struct ll_file_data *fd = LUSTRE_FPRIVATE(file);
 151
 152                 LASSERT(cio->cui_cl.cis_io == io);
 153
 154                 /* mmap lock must be MANDATORY it has to cache
 155                  * pages. */
 156                 io->ci_lockreq = CILR_MANDATORY;
 157                 cio->cui_fd = fd;
 158         } else {
 159                 LASSERT(rc < 0);
 160                 cl_io_fini(env, io);
 161                 cl_env_nested_put(nest, env);
 162                 io = ERR_PTR(rc);
 163         }
 164
 165         return io;
 166 }
 167
 168 /* Sharing code of page_mkwrite method for rhel5 and rhel6 */
 169 static int ll_page_mkwrite0(struct vm_area_struct *vma, struct page *vmpage,
 170                             bool *retry)
 171 {
 172         struct lu_env      *env;
 173         struct cl_io        *io;
 174         struct vvp_io      *vio;
 175         struct cl_env_nest       nest;
 176         int                   result;
 177         sigset_t             set;
 178         struct inode         *inode;
 179         struct ll_inode_info     *lli;
 180
 181         LASSERT(vmpage != NULL);
 182
 183         io = ll_fault_io_init(vma, &env,  &nest, vmpage->index, NULL);
 184         if (IS_ERR(io))
 185                 GOTO(out, result = PTR_ERR(io));
 186
 187         result = io->ci_result;
 188         if (result < 0)
 189                 GOTO(out_io, result);
 190
 191         io->u.ci_fault.ft_mkwrite = 1;
 192         io->u.ci_fault.ft_writable = 1;
 193
 194         vio = vvp_env_io(env);
 195         vio->u.fault.ft_vma    = vma;
 196         vio->u.fault.ft_vmpage = vmpage;
 197
 198         set = cfs_block_sigsinv(sigmask(SIGKILL) | sigmask(SIGTERM));
 199
 200         /* we grab lli_trunc_sem to exclude truncate case.
 201          * Otherwise, we could add dirty pages into osc cache
 202          * while truncate is on-going. */
 203         inode = ccc_object_inode(io->ci_obj);
 204         lli = ll_i2info(inode);
 205         down_read(&lli->lli_trunc_sem);
 206
 207         result = cl_io_loop(env, io);
 208
 209         up_read(&lli->lli_trunc_sem);
 210
 211         cfs_restore_sigs(set);
 212
 213         if (result == 0) {
 214                 struct inode *inode = vma->vm_file->f_dentry->d_inode;
 215                 struct ll_inode_info *lli = ll_i2info(inode);
 216
 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                         spin_lock(&lli->lli_lock);
 245                         lli->lli_flags |= LLIF_DATA_MODIFIED;
 246                         spin_unlock(&lli->lli_lock);
 247                 }
 248         }
 249
 250 out_io:
 251         cl_io_fini(env, io);
 252         cl_env_nested_put(&nest, env);
 253 out:
 254         CDEBUG(D_MMAP, "%s mkwrite with %d\n", current->comm, result);
 255         LASSERT(ergo(result == 0, PageLocked(vmpage)));
 256
 257         return result;
 258 }
 259
 260
 261
 262 static inline int to_fault_error(int result)
 263 {
 264         switch(result) {
 265         case 0:
 266                 result = VM_FAULT_LOCKED;
 267                 break;
 268         case -EFAULT:
 269                 result = VM_FAULT_NOPAGE;
 270                 break;
 271         case -ENOMEM:
 272                 result = VM_FAULT_OOM;
 273                 break;
 274         default:
 275                 result = VM_FAULT_SIGBUS;
 276                 break;
 277         }
 278         return result;
 279 }
 280
 281 /**
 282  * Lustre implementation of a vm_operations_struct::fault() method, called by
 283  * VM to server page fault (both in kernel and user space).
 284  *
 285  * \param vma - is virtual area struct related to page fault
 286  * \param vmf - structure which describe type and address where hit fault
 287  *
 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
 291  */
 292 static int ll_fault0(struct vm_area_struct *vma, struct vm_fault *vmf)
 293 {
 294         struct lu_env      *env;
 295         struct cl_io        *io;
 296         struct vvp_io      *vio = NULL;
 297         struct page          *vmpage;
 298         unsigned long       ra_flags;
 299         struct cl_env_nest       nest;
 300         int                   result;
 301         int                   fault_ret = 0;
 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.fault.ft_vmf = vmf;
 313                 vio->u.fault.fault.ft_flags = 0;
 314                 vio->u.fault.fault.ft_flags_valid = 0;
 315
 316                 result = cl_io_loop(env, io);
 317
 318                 /* ft_flags are only valid if we reached
 319                  * the call to filemap_fault */
 320                 if (vio->u.fault.fault.ft_flags_valid)
 321                         fault_ret = vio->u.fault.fault.ft_flags;
 322
 323                 vmpage = vio->u.fault.ft_vmpage;
 324                 if (result != 0 && vmpage != NULL) {
 325                         page_cache_release(vmpage);
 326                         vmf->page = NULL;
 327                 }
 328         }
 329         cl_io_fini(env, io);
 330         cl_env_nested_put(&nest, env);
 331
 332         vma->vm_flags |= ra_flags;
 333         if (result != 0 && !(fault_ret & VM_FAULT_RETRY))
 334                 fault_ret |= to_fault_error(result);
 335
 336         CDEBUG(D_MMAP, "%s fault %d/%d\n",
 337                current->comm, fault_ret, result);
 338         return fault_ret;
 339 }
 340
 341 static int ll_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
 342 {
 343         int count = 0;
 344         bool printed = false;
 345         int result;
 346         sigset_t set;
 347
 348         /* Only SIGKILL and SIGTERM is allowed for fault/nopage/mkwrite
 349          * so that it can be killed by admin but not cause segfault by
 350          * other signals. */
 351         set = cfs_block_sigsinv(sigmask(SIGKILL) | sigmask(SIGTERM));
 352
 353 restart:
 354         result = ll_fault0(vma, vmf);
 355         LASSERT(!(result & VM_FAULT_LOCKED));
 356         if (result == 0) {
 357                 struct page *vmpage = vmf->page;
 358
 359                 /* check if this page has been truncated */
 360                 lock_page(vmpage);
 361                 if (unlikely(vmpage->mapping == NULL)) { /* unlucky */
 362                         unlock_page(vmpage);
 363                         page_cache_release(vmpage);
 364                         vmf->page = NULL;
 365
 366                         if (!printed && ++count > 16) {
 367                                 CWARN("the page is under heavy contention,"
 368                                       "maybe your app(%s) needs revising :-)\n",
 369                                       current->comm);
 370                                 printed = true;
 371                         }
 372
 373                         goto restart;
 374                 }
 375
 376                 result = VM_FAULT_LOCKED;
 377         }
 378         cfs_restore_sigs(set);
 379         return result;
 380 }
 381
 382 static int ll_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
 383 {
 384         int count = 0;
 385         bool printed = false;
 386         bool retry;
 387         int result;
 388
 389         do {
 390                 retry = false;
 391                 result = ll_page_mkwrite0(vma, vmf->page, &retry);
 392
 393                 if (!printed && ++count > 16) {
 394                         CWARN("app(%s): the page %lu of file %lu is under heavy"
 395                               " contention.\n",
 396                               current->comm, vmf->pgoff,
 397                               vma->vm_file->f_dentry->d_inode->i_ino);
 398                         printed = true;
 399                 }
 400         } while (retry);
 401
 402         switch(result) {
 403         case 0:
 404                 LASSERT(PageLocked(vmf->page));
 405                 result = VM_FAULT_LOCKED;
 406                 break;
 407         case -ENODATA:
 408         case -EFAULT:
 409                 result = VM_FAULT_NOPAGE;
 410                 break;
 411         case -ENOMEM:
 412                 result = VM_FAULT_OOM;
 413                 break;
 414         case -EAGAIN:
 415                 result = VM_FAULT_RETRY;
 416                 break;
 417         default:
 418                 result = VM_FAULT_SIGBUS;
 419                 break;
 420         }
 421
 422         return result;
 423 }
 424
 425 /**
 426  *  To avoid cancel the locks covering mmapped region for lock cache pressure,
 427  *  we track the mapped vma count in ccc_object::cob_mmap_cnt.
 428  */
 429 static void ll_vm_open(struct vm_area_struct * vma)
 430 {
 431         struct inode *inode    = vma->vm_file->f_dentry->d_inode;
 432         struct ccc_object *vob = cl_inode2ccc(inode);
 433
 434         LASSERT(vma->vm_file);
 435         LASSERT(atomic_read(&vob->cob_mmap_cnt) >= 0);
 436         atomic_inc(&vob->cob_mmap_cnt);
 437 }
 438
 439 /**
 440  * Dual to ll_vm_open().
 441  */
 442 static void ll_vm_close(struct vm_area_struct *vma)
 443 {
 444         struct inode      *inode = vma->vm_file->f_dentry->d_inode;
 445         struct ccc_object *vob   = cl_inode2ccc(inode);
 446
 447         LASSERT(vma->vm_file);
 448         atomic_dec(&vob->cob_mmap_cnt);
 449         LASSERT(atomic_read(&vob->cob_mmap_cnt) >= 0);
 450 }
 451
 452 /* XXX put nice comment here.  talk about __free_pte -> dirty pages and
 453  * nopage's reference passing to the pte */
 454 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last)
 455 {
 456         int rc = -ENOENT;
 457
 458         LASSERTF(last > first, "last %llu first %llu\n", last, first);
 459         if (mapping_mapped(mapping)) {
 460                 rc = 0;
 461                 unmap_mapping_range(mapping, first + PAGE_CACHE_SIZE - 1,
 462                                     last - first + 1, 0);
 463         }
 464
 465         return rc;
 466 }
 467
 468 static const struct vm_operations_struct ll_file_vm_ops = {
 469         .fault                  = ll_fault,
 470         .page_mkwrite           = ll_page_mkwrite,
 471         .open                   = ll_vm_open,
 472         .close                  = ll_vm_close,
 473 };
 474
 475 int ll_file_mmap(struct file *file, struct vm_area_struct * vma)
 476 {
 477         struct inode *inode = file->f_dentry->d_inode;
 478         int rc;
 479
 480         if (ll_file_nolock(file))
 481                 return -EOPNOTSUPP;
 482
 483         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MAP, 1);
 484         rc = generic_file_mmap(file, vma);
 485         if (rc == 0) {
 486                 vma->vm_ops = &ll_file_vm_ops;
 487                 vma->vm_ops->open(vma);
 488                 /* update the inode's size and mtime */
 489                 rc = ll_glimpse_size(inode);
 490         }
 491
 492         return rc;
 493 }