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