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 <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 <lustre_lite.h>
  55 #include "llite_internal.h"
  56 #include <linux/lustre_compat25.h>
  57
  58 struct page *ll_nopage(struct vm_area_struct *vma, unsigned long address,
  59                        int *type);
  60
  61 static struct vm_operations_struct ll_file_vm_ops;
  62
  63 void policy_from_vma(ldlm_policy_data_t *policy,
  64                             struct vm_area_struct *vma, unsigned long addr,
  65                             size_t count)
  66 {
  67         policy->l_extent.start = ((addr - vma->vm_start) & CFS_PAGE_MASK) +
  68                                  (vma->vm_pgoff << PAGE_CACHE_SHIFT);
  69         policy->l_extent.end = (policy->l_extent.start + count - 1) |
  70                                ~CFS_PAGE_MASK;
  71 }
  72
  73 struct vm_area_struct *our_vma(struct mm_struct *mm, unsigned long addr,
  74                                size_t count)
  75 {
  76         struct vm_area_struct *vma, *ret = NULL;
  77         ENTRY;
  78
  79         /* mmap_sem must have been held by caller. */
  80         LASSERT(!down_write_trylock(&mm->mmap_sem));
  81
  82         for(vma = find_vma(mm, addr);
  83             vma != NULL && vma->vm_start < (addr + count); vma = vma->vm_next) {
  84                 if (vma->vm_ops && vma->vm_ops == &ll_file_vm_ops &&
  85                     vma->vm_flags & VM_SHARED) {
  86                         ret = vma;
  87                         break;
  88                 }
  89         }
  90         RETURN(ret);
  91 }
  92
  93 /**
  94  * API independent part for page fault initialization.
  95  * \param vma - virtual memory area addressed to page fault
  96  * \param env - corespondent lu_env to processing
  97  * \param nest - nested level
  98  * \param index - page index corespondent to fault.
  99  * \parm ra_flags - vma readahead flags.
 100  *
 101  * \return allocated and initialized env for fault operation.
 102  * \retval EINVAL if env can't allocated
 103  * \return other error codes from cl_io_init.
 104  */
 105 struct cl_io *ll_fault_io_init(struct vm_area_struct *vma,
 106                                struct lu_env **env_ret,
 107                                struct cl_env_nest *nest,
 108                                pgoff_t index, unsigned long *ra_flags)
 109 {
 110         struct file            *file = vma->vm_file;
 111         struct inode           *inode = file->f_dentry->d_inode;
 112         struct cl_io           *io;
 113         struct cl_fault_io     *fio;
 114         struct lu_env          *env;
 115         int                     rc;
 116         ENTRY;
 117
 118         *env_ret = NULL;
 119         if (ll_file_nolock(file))
 120                 RETURN(ERR_PTR(-EOPNOTSUPP));
 121
 122         /*
 123          * page fault can be called when lustre IO is
 124          * already active for the current thread, e.g., when doing read/write
 125          * against user level buffer mapped from Lustre buffer. To avoid
 126          * stomping on existing context, optionally force an allocation of a new
 127          * one.
 128          */
 129         env = cl_env_nested_get(nest);
 130         if (IS_ERR(env))
 131                  RETURN(ERR_PTR(-EINVAL));
 132
 133         *env_ret = env;
 134
 135         io = ccc_env_thread_io(env);
 136         io->ci_obj = ll_i2info(inode)->lli_clob;
 137         LASSERT(io->ci_obj != NULL);
 138
 139         fio = &io->u.ci_fault;
 140         fio->ft_index      = index;
 141         fio->ft_executable = vma->vm_flags&VM_EXEC;
 142
 143         /*
 144          * disable VM_SEQ_READ and use VM_RAND_READ to make sure that
 145          * the kernel will not read other pages not covered by ldlm in
 146          * filemap_nopage. we do our readahead in ll_readpage.
 147          */
 148         if (ra_flags != NULL)
 149                 *ra_flags = vma->vm_flags & (VM_RAND_READ|VM_SEQ_READ);
 150         vma->vm_flags &= ~VM_SEQ_READ;
 151         vma->vm_flags |= VM_RAND_READ;
 152
 153         CDEBUG(D_MMAP, "vm_flags: %lx (%lu %d)\n", vma->vm_flags,
 154                fio->ft_index, fio->ft_executable);
 155
 156         rc = cl_io_init(env, io, CIT_FAULT, io->ci_obj);
 157         if (rc == 0) {
 158                 struct ccc_io *cio = ccc_env_io(env);
 159                 struct ll_file_data *fd = LUSTRE_FPRIVATE(file);
 160
 161                 LASSERT(cio->cui_cl.cis_io == io);
 162
 163                 /* mmap lock must be MANDATORY it has to cache
 164                  * pages. */
 165                 io->ci_lockreq = CILR_MANDATORY;
 166                 cio->cui_fd = fd;
 167         } else {
 168                 LASSERT(rc < 0);
 169                 cl_io_fini(env, io);
 170                 cl_env_nested_put(nest, env);
 171                 io = ERR_PTR(rc);
 172         }
 173
 174         return io;
 175 }
 176
 177 /* Sharing code of page_mkwrite method for rhel5 and rhel6 */
 178 static int ll_page_mkwrite0(struct vm_area_struct *vma, struct page *vmpage,
 179                             bool *retry)
 180 {
 181         struct lu_env           *env;
 182         struct cl_io            *io;
 183         struct vvp_io           *vio;
 184         struct cl_env_nest       nest;
 185         int                      result;
 186         cfs_sigset_t             set;
 187         struct inode             *inode;
 188         struct ll_inode_info     *lli;
 189         ENTRY;
 190
 191         LASSERT(vmpage != NULL);
 192
 193         io = ll_fault_io_init(vma, &env,  &nest, vmpage->index, NULL);
 194         if (IS_ERR(io))
 195                 GOTO(out, result = PTR_ERR(io));
 196
 197         result = io->ci_result;
 198         if (result < 0)
 199                 GOTO(out_io, result);
 200
 201         io->u.ci_fault.ft_mkwrite = 1;
 202         io->u.ci_fault.ft_writable = 1;
 203
 204         vio = vvp_env_io(env);
 205         vio->u.fault.ft_vma    = vma;
 206         vio->u.fault.ft_vmpage = vmpage;
 207
 208         set = cfs_block_sigsinv(sigmask(SIGKILL) | sigmask(SIGTERM));
 209
 210         /* we grab lli_trunc_sem to exclude truncate case.
 211          * Otherwise, we could add dirty pages into osc cache
 212          * while truncate is on-going. */
 213         inode = ccc_object_inode(io->ci_obj);
 214         lli = ll_i2info(inode);
 215         down_read(&lli->lli_trunc_sem);
 216
 217         result = cl_io_loop(env, io);
 218
 219         up_read(&lli->lli_trunc_sem);
 220
 221         cfs_restore_sigs(set);
 222
 223         if (result == 0) {
 224                 struct inode *inode = vma->vm_file->f_dentry->d_inode;
 225                 struct ll_inode_info *lli = ll_i2info(inode);
 226
 227                 lock_page(vmpage);
 228                 if (vmpage->mapping == NULL) {
 229                         unlock_page(vmpage);
 230
 231                         /* page was truncated and lock was cancelled, return
 232                          * ENODATA so that VM_FAULT_NOPAGE will be returned
 233                          * to handle_mm_fault(). */
 234                         if (result == 0)
 235                                 result = -ENODATA;
 236                 } else if (!PageDirty(vmpage)) {
 237                         /* race, the page has been cleaned by ptlrpcd after
 238                          * it was unlocked, it has to be added into dirty
 239                          * cache again otherwise this soon-to-dirty page won't
 240                          * consume any grants, even worse if this page is being
 241                          * transferred because it will break RPC checksum.
 242                          */
 243                         unlock_page(vmpage);
 244
 245                         CDEBUG(D_MMAP, "Race on page_mkwrite %p/%lu, page has "
 246                                "been written out, retry.\n",
 247                                vmpage, vmpage->index);
 248
 249                         *retry = true;
 250                         result = -EAGAIN;
 251                 }
 252
 253                 if (result == 0) {
 254                         spin_lock(&lli->lli_lock);
 255                         lli->lli_flags |= LLIF_DATA_MODIFIED;
 256                         spin_unlock(&lli->lli_lock);
 257                 }
 258         }
 259         EXIT;
 260
 261 out_io:
 262         cl_io_fini(env, io);
 263         cl_env_nested_put(&nest, env);
 264 out:
 265         CDEBUG(D_MMAP, "%s mkwrite with %d\n", cfs_current()->comm, result);
 266         LASSERT(ergo(result == 0, PageLocked(vmpage)));
 267
 268         return result;
 269 }
 270
 271
 272 #ifndef HAVE_VM_OP_FAULT
 273 /**
 274  * Lustre implementation of a vm_operations_struct::nopage() method, called by
 275  * VM to server page fault (both in kernel and user space).
 276  *
 277  * This function sets up CIT_FAULT cl_io that does the job.
 278  *
 279  * \param vma - is virtiual area struct related to page fault
 280  * \param address - address when hit fault
 281  * \param type - of fault
 282  *
 283  * \return allocated and filled _unlocked_ page for address
 284  * \retval NOPAGE_SIGBUS if page not exist on this address
 285  * \retval NOPAGE_OOM not have memory for allocate new page
 286  */
 287 struct page *ll_nopage(struct vm_area_struct *vma, unsigned long address,
 288                        int *type)
 289 {
 290         struct lu_env           *env;
 291         struct cl_env_nest      nest;
 292         struct cl_io            *io;
 293         struct page             *page  = NOPAGE_SIGBUS;
 294         struct vvp_io           *vio = NULL;
 295         unsigned long           ra_flags;
 296         pgoff_t                 pg_offset;
 297         int                     result;
 298         const unsigned long     writable = VM_SHARED|VM_WRITE;
 299         cfs_sigset_t            set;
 300         ENTRY;
 301
 302         pg_offset = ((address - vma->vm_start) >> PAGE_SHIFT) + vma->vm_pgoff;
 303         io = ll_fault_io_init(vma, &env,  &nest, pg_offset, &ra_flags);
 304         if (IS_ERR(io))
 305                 return NOPAGE_SIGBUS;
 306
 307         result = io->ci_result;
 308         if (result < 0)
 309                 goto out_err;
 310
 311         io->u.ci_fault.ft_writable = (vma->vm_flags&writable) == writable;
 312
 313         vio = vvp_env_io(env);
 314         vio->u.fault.ft_vma            = vma;
 315         vio->u.fault.nopage.ft_address = address;
 316         vio->u.fault.nopage.ft_type    = type;
 317         vio->u.fault.ft_vmpage         = NULL;
 318
 319         set = cfs_block_sigsinv(sigmask(SIGKILL)|sigmask(SIGTERM));
 320         result = cl_io_loop(env, io);
 321         cfs_restore_sigs(set);
 322
 323         page = vio->u.fault.ft_vmpage;
 324         if (result != 0 && page != NULL) {
 325                 page_cache_release(page);
 326                 page = NOPAGE_SIGBUS;
 327         }
 328
 329 out_err:
 330         if (result == -ENOMEM)
 331                 page = NOPAGE_OOM;
 332
 333         vma->vm_flags &= ~VM_RAND_READ;
 334         vma->vm_flags |= ra_flags;
 335
 336         cl_io_fini(env, io);
 337         cl_env_nested_put(&nest, env);
 338
 339         RETURN(page);
 340 }
 341
 342 #else
 343
 344 static inline int to_fault_error(int result)
 345 {
 346         switch(result) {
 347         case 0:
 348                 result = VM_FAULT_LOCKED;
 349                 break;
 350         case -EFAULT:
 351                 result = VM_FAULT_NOPAGE;
 352                 break;
 353         case -ENOMEM:
 354                 result = VM_FAULT_OOM;
 355                 break;
 356         default:
 357                 result = VM_FAULT_SIGBUS;
 358                 break;
 359         }
 360         return result;
 361 }
 362
 363 /**
 364  * Lustre implementation of a vm_operations_struct::fault() method, called by
 365  * VM to server page fault (both in kernel and user space).
 366  *
 367  * \param vma - is virtiual area struct related to page fault
 368  * \param vmf - structure which describe type and address where hit fault
 369  *
 370  * \return allocated and filled _locked_ page for address
 371  * \retval VM_FAULT_ERROR on general error
 372  * \retval NOPAGE_OOM not have memory for allocate new page
 373  */
 374 static int ll_fault0(struct vm_area_struct *vma, struct vm_fault *vmf)
 375 {
 376         struct lu_env           *env;
 377         struct cl_io            *io;
 378         struct vvp_io           *vio = NULL;
 379         struct page             *vmpage;
 380         unsigned long            ra_flags;
 381         struct cl_env_nest       nest;
 382         int                      result;
 383         int                      fault_ret = 0;
 384         ENTRY;
 385
 386         io = ll_fault_io_init(vma, &env,  &nest, vmf->pgoff, &ra_flags);
 387         if (IS_ERR(io))
 388                 RETURN(to_fault_error(PTR_ERR(io)));
 389
 390         result = io->ci_result;
 391         if (result == 0) {
 392                 vio = vvp_env_io(env);
 393                 vio->u.fault.ft_vma       = vma;
 394                 vio->u.fault.ft_vmpage    = NULL;
 395                 vio->u.fault.fault.ft_vmf = vmf;
 396
 397                 result = cl_io_loop(env, io);
 398
 399                 fault_ret = vio->u.fault.fault.ft_flags;
 400                 vmpage = vio->u.fault.ft_vmpage;
 401                 if (result != 0 && vmpage != NULL) {
 402                         page_cache_release(vmpage);
 403                         vmf->page = NULL;
 404                 }
 405         }
 406         cl_io_fini(env, io);
 407         cl_env_nested_put(&nest, env);
 408
 409         vma->vm_flags |= ra_flags;
 410         if (result != 0 && !(fault_ret & VM_FAULT_RETRY))
 411                 fault_ret |= to_fault_error(result);
 412
 413         CDEBUG(D_MMAP, "%s fault %d/%d\n",
 414                cfs_current()->comm, fault_ret, result);
 415         RETURN(fault_ret);
 416 }
 417
 418 static int ll_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
 419 {
 420         int count = 0;
 421         bool printed = false;
 422         int result;
 423         cfs_sigset_t set;
 424
 425         /* Only SIGKILL and SIGTERM is allowed for fault/nopage/mkwrite
 426          * so that it can be killed by admin but not cause segfault by
 427          * other signals. */
 428         set = cfs_block_sigsinv(sigmask(SIGKILL) | sigmask(SIGTERM));
 429
 430 restart:
 431         result = ll_fault0(vma, vmf);
 432         LASSERT(!(result & VM_FAULT_LOCKED));
 433         if (result == 0) {
 434                 struct page *vmpage = vmf->page;
 435
 436                 /* check if this page has been truncated */
 437                 lock_page(vmpage);
 438                 if (unlikely(vmpage->mapping == NULL)) { /* unlucky */
 439                         unlock_page(vmpage);
 440                         page_cache_release(vmpage);
 441                         vmf->page = NULL;
 442
 443                         if (!printed && ++count > 16) {
 444                                 CWARN("the page is under heavy contention,"
 445                                       "maybe your app(%s) needs revising :-)\n",
 446                                       current->comm);
 447                                 printed = true;
 448                         }
 449
 450                         goto restart;
 451                 }
 452
 453                 result |= VM_FAULT_LOCKED;
 454         }
 455         cfs_restore_sigs(set);
 456         return result;
 457 }
 458 #endif
 459
 460 #ifndef HAVE_PGMKWRITE_USE_VMFAULT
 461 static int ll_page_mkwrite(struct vm_area_struct *vma, struct page *vmpage)
 462 {
 463         int count = 0;
 464         bool printed = false;
 465         bool retry;
 466         int result;
 467
 468         do {
 469                 retry = false;
 470                 result = ll_page_mkwrite0(vma, vmpage, &retry);
 471
 472                 if (!printed && ++count > 16) {
 473                         CWARN("app(%s): the page %lu of file %lu is under heavy"
 474                               " contention.\n",
 475                               current->comm, page_index(vmpage),
 476                               vma->vm_file->f_dentry->d_inode->i_ino);
 477                         printed = true;
 478                 }
 479         } while (retry);
 480
 481         if (result == 0)
 482                 unlock_page(vmpage);
 483         else if (result == -ENODATA)
 484                 result = 0; /* kernel will know truncate has happened and
 485                              * retry */
 486
 487         return result;
 488 }
 489 #else
 490 static int ll_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
 491 {
 492         int count = 0;
 493         bool printed = false;
 494         bool retry;
 495         int result;
 496
 497         do {
 498                 retry = false;
 499                 result = ll_page_mkwrite0(vma, vmf->page, &retry);
 500
 501                 if (!printed && ++count > 16) {
 502                         CWARN("app(%s): the page %lu of file %lu is under heavy"
 503                               " contention.\n",
 504                               current->comm, vmf->pgoff,
 505                               vma->vm_file->f_dentry->d_inode->i_ino);
 506                         printed = true;
 507                 }
 508         } while (retry);
 509
 510         switch(result) {
 511         case 0:
 512                 LASSERT(PageLocked(vmf->page));
 513                 result = VM_FAULT_LOCKED;
 514                 break;
 515         case -ENODATA:
 516         case -EFAULT:
 517                 result = VM_FAULT_NOPAGE;
 518                 break;
 519         case -ENOMEM:
 520                 result = VM_FAULT_OOM;
 521                 break;
 522         case -EAGAIN:
 523                 result = VM_FAULT_RETRY;
 524                 break;
 525         default:
 526                 result = VM_FAULT_SIGBUS;
 527                 break;
 528         }
 529
 530         return result;
 531 }
 532 #endif
 533
 534 /**
 535  *  To avoid cancel the locks covering mmapped region for lock cache pressure,
 536  *  we track the mapped vma count in ccc_object::cob_mmap_cnt.
 537  */
 538 static void ll_vm_open(struct vm_area_struct * vma)
 539 {
 540         struct inode *inode    = vma->vm_file->f_dentry->d_inode;
 541         struct ccc_object *vob = cl_inode2ccc(inode);
 542
 543         ENTRY;
 544         LASSERT(vma->vm_file);
 545         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
 546         cfs_atomic_inc(&vob->cob_mmap_cnt);
 547         EXIT;
 548 }
 549
 550 /**
 551  * Dual to ll_vm_open().
 552  */
 553 static void ll_vm_close(struct vm_area_struct *vma)
 554 {
 555         struct inode      *inode = vma->vm_file->f_dentry->d_inode;
 556         struct ccc_object *vob   = cl_inode2ccc(inode);
 557
 558         ENTRY;
 559         LASSERT(vma->vm_file);
 560         cfs_atomic_dec(&vob->cob_mmap_cnt);
 561         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
 562         EXIT;
 563 }
 564
 565 #ifndef HAVE_VM_OP_FAULT
 566 #ifndef HAVE_FILEMAP_POPULATE
 567 static int (*filemap_populate)(struct vm_area_struct * area, unsigned long address, unsigned long len, pgprot_t prot, unsigned long pgoff, int nonblock);
 568 #endif
 569 static int ll_populate(struct vm_area_struct *area, unsigned long address,
 570                        unsigned long len, pgprot_t prot, unsigned long pgoff,
 571                        int nonblock)
 572 {
 573         int rc = 0;
 574         ENTRY;
 575
 576         /* always set nonblock as true to avoid page read ahead */
 577         rc = filemap_populate(area, address, len, prot, pgoff, 1);
 578         RETURN(rc);
 579 }
 580 #endif
 581
 582 /* return the user space pointer that maps to a file offset via a vma */
 583 static inline unsigned long file_to_user(struct vm_area_struct *vma, __u64 byte)
 584 {
 585         return vma->vm_start +
 586                (byte - ((__u64)vma->vm_pgoff << PAGE_CACHE_SHIFT));
 587
 588 }
 589
 590 /* XXX put nice comment here.  talk about __free_pte -> dirty pages and
 591  * nopage's reference passing to the pte */
 592 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last)
 593 {
 594         int rc = -ENOENT;
 595         ENTRY;
 596
 597         LASSERTF(last > first, "last "LPU64" first "LPU64"\n", last, first);
 598         if (mapping_mapped(mapping)) {
 599                 rc = 0;
 600                 unmap_mapping_range(mapping, first + PAGE_CACHE_SIZE - 1,
 601                                     last - first + 1, 0);
 602         }
 603
 604         RETURN(rc);
 605 }
 606
 607 static struct vm_operations_struct ll_file_vm_ops = {
 608 #ifndef HAVE_VM_OP_FAULT
 609         .nopage                 = ll_nopage,
 610         .populate               = ll_populate,
 611 #else
 612         .fault                  = ll_fault,
 613 #endif
 614 #ifndef HAVE_PGMKWRITE_COMPACT
 615         .page_mkwrite           = ll_page_mkwrite,
 616 #else
 617         ._pmkw.page_mkwrite     = ll_page_mkwrite,
 618 #endif
 619         .open                   = ll_vm_open,
 620         .close                  = ll_vm_close,
 621 };
 622
 623 int ll_file_mmap(struct file *file, struct vm_area_struct * vma)
 624 {
 625         struct inode *inode = file->f_dentry->d_inode;
 626         int rc;
 627         ENTRY;
 628
 629         if (ll_file_nolock(file))
 630                 RETURN(-EOPNOTSUPP);
 631
 632         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MAP, 1);
 633         rc = generic_file_mmap(file, vma);
 634         if (rc == 0) {
 635 #if !defined(HAVE_FILEMAP_POPULATE) && !defined(HAVE_VM_OP_FAULT)
 636                 if (!filemap_populate)
 637                         filemap_populate = vma->vm_ops->populate;
 638 #endif
 639                 vma->vm_ops = &ll_file_vm_ops;
 640                 vma->vm_ops->open(vma);
 641                 /* update the inode's size and mtime */
 642                 rc = ll_glimpse_size(inode);
 643         }
 644
 645         RETURN(rc);
 646 }