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(unsigned long addr, size_t count)
  80 {
  81         struct mm_struct *mm = current->mm;
  82         struct vm_area_struct *vma, *ret = NULL;
  83         ENTRY;
  84
  85         /* No MM (e.g. NFS)? No vmas too. */
  86         if (!mm)
  87                 RETURN(NULL);
  88
  89         spin_lock(&mm->page_table_lock);
  90         for(vma = find_vma(mm, addr);
  91             vma != NULL && vma->vm_start < (addr + count); vma = vma->vm_next) {
  92                 if (vma->vm_ops && vma->vm_ops == &ll_file_vm_ops &&
  93                     vma->vm_flags & VM_SHARED) {
  94                         ret = vma;
  95                         break;
  96                 }
  97         }
  98         spin_unlock(&mm->page_table_lock);
  99         RETURN(ret);
 100 }
 101
 102 /**
 103  * API independent part for page fault initialization.
 104  * \param vma - virtual memory area addressed to page fault
 105  * \param env - corespondent lu_env to processing
 106  * \param nest - nested level
 107  * \param index - page index corespondent to fault.
 108  * \parm ra_flags - vma readahead flags.
 109  *
 110  * \return allocated and initialized env for fault operation.
 111  * \retval EINVAL if env can't allocated
 112  * \return other error codes from cl_io_init.
 113  */
 114 struct cl_io *ll_fault_io_init(struct vm_area_struct *vma,
 115                                struct lu_env **env_ret,
 116                                struct cl_env_nest *nest,
 117                                pgoff_t index, unsigned long *ra_flags)
 118 {
 119         struct file       *file  = vma->vm_file;
 120         struct inode      *inode = file->f_dentry->d_inode;
 121         struct cl_io      *io;
 122         struct cl_fault_io *fio;
 123         struct lu_env     *env;
 124         ENTRY;
 125
 126         *env_ret = NULL;
 127         if (ll_file_nolock(file))
 128                 RETURN(ERR_PTR(-EOPNOTSUPP));
 129
 130         /*
 131          * page fault can be called when lustre IO is
 132          * already active for the current thread, e.g., when doing read/write
 133          * against user level buffer mapped from Lustre buffer. To avoid
 134          * stomping on existing context, optionally force an allocation of a new
 135          * one.
 136          */
 137         env = cl_env_nested_get(nest);
 138         if (IS_ERR(env))
 139                  RETURN(ERR_PTR(-EINVAL));
 140
 141         *env_ret = env;
 142
 143         io = ccc_env_thread_io(env);
 144         io->ci_obj = ll_i2info(inode)->lli_clob;
 145         LASSERT(io->ci_obj != NULL);
 146
 147         fio = &io->u.ci_fault;
 148         fio->ft_index      = index;
 149         fio->ft_executable = vma->vm_flags&VM_EXEC;
 150
 151         /*
 152          * disable VM_SEQ_READ and use VM_RAND_READ to make sure that
 153          * the kernel will not read other pages not covered by ldlm in
 154          * filemap_nopage. we do our readahead in ll_readpage.
 155          */
 156         if (ra_flags != NULL)
 157                 *ra_flags = vma->vm_flags & (VM_RAND_READ|VM_SEQ_READ);
 158         vma->vm_flags &= ~VM_SEQ_READ;
 159         vma->vm_flags |= VM_RAND_READ;
 160
 161         CDEBUG(D_MMAP, "vm_flags: %lx (%lu %d)\n", vma->vm_flags,
 162                fio->ft_index, fio->ft_executable);
 163
 164         if (cl_io_init(env, io, CIT_FAULT, io->ci_obj) == 0) {
 165                 struct ccc_io *cio = ccc_env_io(env);
 166                 struct ll_file_data *fd = LUSTRE_FPRIVATE(file);
 167
 168                 LASSERT(cio->cui_cl.cis_io == io);
 169
 170                 /* mmap lock must be MANDATORY
 171                  * it has to cache pages. */
 172                 io->ci_lockreq = CILR_MANDATORY;
 173
 174                 cio->cui_fd  = fd;
 175         }
 176
 177         return io;
 178 }
 179
 180 /* Sharing code of page_mkwrite method for rhel5 and rhel6 */
 181 static int ll_page_mkwrite0(struct vm_area_struct *vma, struct page *vmpage,
 182                             bool *retry)
 183 {
 184         struct lu_env           *env;
 185         struct cl_io            *io;
 186         struct vvp_io           *vio;
 187         struct cl_env_nest       nest;
 188         int                      result;
 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, result);
 200
 201         /* Don't enqueue new locks for page_mkwrite().
 202          * If the lock has been cancelled then page must have been
 203          * truncated, in that case, kernel will handle it.
 204          */
 205         io->ci_lockreq = CILR_PEEK;
 206         io->u.ci_fault.ft_mkwrite = 1;
 207         io->u.ci_fault.ft_writable = 1;
 208
 209         vio = vvp_env_io(env);
 210         vio->u.fault.ft_vma    = vma;
 211         vio->u.fault.ft_vmpage = vmpage;
 212
 213         result = cl_io_loop(env, io);
 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         ENTRY;
 299
 300         pg_offset = ((address - vma->vm_start) >> PAGE_SHIFT) + vma->vm_pgoff;
 301         io = ll_fault_io_init(vma, &env,  &nest, pg_offset, &ra_flags);
 302         if (IS_ERR(io))
 303                 return NOPAGE_SIGBUS;
 304
 305         result = io->ci_result;
 306         if (result < 0)
 307                 goto out_err;
 308
 309         io->u.ci_fault.ft_writable = (vma->vm_flags&writable) == writable;
 310
 311         vio = vvp_env_io(env);
 312         vio->u.fault.ft_vma            = vma;
 313         vio->u.fault.nopage.ft_address = address;
 314         vio->u.fault.nopage.ft_type    = type;
 315         vio->u.fault.ft_vmpage         = NULL;
 316
 317         result = cl_io_loop(env, io);
 318         page = vio->u.fault.ft_vmpage;
 319         if (result != 0 && page != NULL)
 320                 page_cache_release(page);
 321
 322 out_err:
 323         if (result == -ENOMEM)
 324                 page = NOPAGE_OOM;
 325
 326         vma->vm_flags &= ~VM_RAND_READ;
 327         vma->vm_flags |= ra_flags;
 328
 329         cl_io_fini(env, io);
 330         cl_env_nested_put(&nest, env);
 331
 332         RETURN(page);
 333 }
 334
 335 #else
 336 /**
 337  * Lustre implementation of a vm_operations_struct::fault() method, called by
 338  * VM to server page fault (both in kernel and user space).
 339  *
 340  * \param vma - is virtiual area struct related to page fault
 341  * \param vmf - structure which describe type and address where hit fault
 342  *
 343  * \return allocated and filled _locked_ page for address
 344  * \retval VM_FAULT_ERROR on general error
 345  * \retval NOPAGE_OOM not have memory for allocate new page
 346  */
 347 static int ll_fault0(struct vm_area_struct *vma, struct vm_fault *vmf)
 348 {
 349         struct lu_env           *env;
 350         struct cl_io            *io;
 351         struct vvp_io           *vio = NULL;
 352         struct page             *vmpage;
 353         unsigned long            ra_flags;
 354         struct cl_env_nest       nest;
 355         int                      result;
 356         int                      fault_ret = 0;
 357         ENTRY;
 358
 359         io = ll_fault_io_init(vma, &env,  &nest, vmf->pgoff, &ra_flags);
 360         if (IS_ERR(io))
 361                 RETURN(VM_FAULT_ERROR);
 362
 363         result = io->ci_result;
 364         if (result < 0)
 365                 goto out_err;
 366
 367         vio = vvp_env_io(env);
 368         vio->u.fault.ft_vma       = vma;
 369         vio->u.fault.ft_vmpage    = NULL;
 370         vio->u.fault.fault.ft_vmf = vmf;
 371
 372         result = cl_io_loop(env, io);
 373
 374         vmpage = vio->u.fault.ft_vmpage;
 375         if (result != 0 && vmpage != NULL) {
 376                 page_cache_release(vmpage);
 377                 vmf->page = NULL;
 378         }
 379
 380         fault_ret = vio->u.fault.fault.ft_flags;
 381
 382 out_err:
 383         if (result != 0 && fault_ret == 0)
 384                 fault_ret = VM_FAULT_ERROR;
 385
 386         vma->vm_flags |= ra_flags;
 387
 388         cl_io_fini(env, io);
 389         cl_env_nested_put(&nest, env);
 390
 391         CDEBUG(D_MMAP, "%s fault %d/%d\n",
 392                cfs_current()->comm, fault_ret, result);
 393         RETURN(fault_ret);
 394 }
 395
 396 static int ll_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
 397 {
 398         int count = 0;
 399         bool printed = false;
 400         int result;
 401
 402 restart:
 403         result = ll_fault0(vma, vmf);
 404         LASSERT(!(result & VM_FAULT_LOCKED));
 405         if (result == 0) {
 406                 struct page *vmpage = vmf->page;
 407
 408                 /* check if this page has been truncated */
 409                 lock_page(vmpage);
 410                 if (unlikely(vmpage->mapping == NULL)) { /* unlucky */
 411                         unlock_page(vmpage);
 412                         page_cache_release(vmpage);
 413                         vmf->page = NULL;
 414
 415                         if (!printed && ++count > 16) {
 416                                 CWARN("the page is under heavy contention,"
 417                                       "maybe your app(%s) needs revising :-)\n",
 418                                       current->comm);
 419                                 printed = true;
 420                         }
 421
 422                         goto restart;
 423                 }
 424
 425                 result |= VM_FAULT_LOCKED;
 426         }
 427         return result;
 428 }
 429 #endif
 430
 431 #ifndef HAVE_PGMKWRITE_USE_VMFAULT
 432 static int ll_page_mkwrite(struct vm_area_struct *vma, struct page *vmpage)
 433 {
 434         int count = 0;
 435         bool printed = false;
 436         bool retry;
 437         int result;
 438
 439         do {
 440                 retry = false;
 441                 result = ll_page_mkwrite0(vma, vmpage, &retry);
 442
 443                 if (!printed && ++count > 16) {
 444                         CWARN("app(%s): the page %lu of file %lu is under heavy"
 445                               " contention.\n",
 446                               current->comm, page_index(vmpage),
 447                               vma->vm_file->f_dentry->d_inode->i_ino);
 448                         printed = true;
 449                 }
 450         } while (retry);
 451
 452         if (result == 0)
 453                 unlock_page(vmpage);
 454         else if (result == -ENODATA)
 455                 result = 0; /* kernel will know truncate has happened and
 456                              * retry */
 457
 458         return result;
 459 }
 460 #else
 461 static int ll_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
 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, vmf->page, &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, vmf->pgoff,
 476                               vma->vm_file->f_dentry->d_inode->i_ino);
 477                         printed = true;
 478                 }
 479         } while (retry);
 480
 481         switch(result) {
 482         case 0:
 483                 LASSERT(PageLocked(vmf->page));
 484                 result = VM_FAULT_LOCKED;
 485                 break;
 486         case -ENODATA:
 487         case -EFAULT:
 488                 result = VM_FAULT_NOPAGE;
 489                 break;
 490         case -ENOMEM:
 491                 result = VM_FAULT_OOM;
 492                 break;
 493         case -EAGAIN:
 494                 result = VM_FAULT_RETRY;
 495                 break;
 496         default:
 497                 result = VM_FAULT_SIGBUS;
 498                 break;
 499         }
 500
 501         return result;
 502 }
 503 #endif
 504
 505 /**
 506  *  To avoid cancel the locks covering mmapped region for lock cache pressure,
 507  *  we track the mapped vma count in ccc_object::cob_mmap_cnt.
 508  */
 509 static void ll_vm_open(struct vm_area_struct * vma)
 510 {
 511         struct inode *inode    = vma->vm_file->f_dentry->d_inode;
 512         struct ccc_object *vob = cl_inode2ccc(inode);
 513
 514         ENTRY;
 515         LASSERT(vma->vm_file);
 516         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
 517         cfs_atomic_inc(&vob->cob_mmap_cnt);
 518         EXIT;
 519 }
 520
 521 /**
 522  * Dual to ll_vm_open().
 523  */
 524 static void ll_vm_close(struct vm_area_struct *vma)
 525 {
 526         struct inode      *inode = vma->vm_file->f_dentry->d_inode;
 527         struct ccc_object *vob   = cl_inode2ccc(inode);
 528
 529         ENTRY;
 530         LASSERT(vma->vm_file);
 531         cfs_atomic_dec(&vob->cob_mmap_cnt);
 532         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
 533         EXIT;
 534 }
 535
 536 #ifndef HAVE_VM_OP_FAULT
 537 #ifndef HAVE_FILEMAP_POPULATE
 538 static int (*filemap_populate)(struct vm_area_struct * area, unsigned long address, unsigned long len, pgprot_t prot, unsigned long pgoff, int nonblock);
 539 #endif
 540 static int ll_populate(struct vm_area_struct *area, unsigned long address,
 541                        unsigned long len, pgprot_t prot, unsigned long pgoff,
 542                        int nonblock)
 543 {
 544         int rc = 0;
 545         ENTRY;
 546
 547         /* always set nonblock as true to avoid page read ahead */
 548         rc = filemap_populate(area, address, len, prot, pgoff, 1);
 549         RETURN(rc);
 550 }
 551 #endif
 552
 553 /* return the user space pointer that maps to a file offset via a vma */
 554 static inline unsigned long file_to_user(struct vm_area_struct *vma, __u64 byte)
 555 {
 556         return vma->vm_start + (byte - ((__u64)vma->vm_pgoff << CFS_PAGE_SHIFT));
 557
 558 }
 559
 560 /* XXX put nice comment here.  talk about __free_pte -> dirty pages and
 561  * nopage's reference passing to the pte */
 562 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last)
 563 {
 564         int rc = -ENOENT;
 565         ENTRY;
 566
 567         LASSERTF(last > first, "last "LPU64" first "LPU64"\n", last, first);
 568         if (mapping_mapped(mapping)) {
 569                 rc = 0;
 570                 unmap_mapping_range(mapping, first + CFS_PAGE_SIZE - 1,
 571                                     last - first + 1, 0);
 572         }
 573
 574         RETURN(rc);
 575 }
 576
 577 static struct vm_operations_struct ll_file_vm_ops = {
 578 #ifndef HAVE_VM_OP_FAULT
 579         .nopage         = ll_nopage,
 580         .populate       = ll_populate,
 581
 582 #else
 583         .fault          = ll_fault,
 584 #endif
 585         .page_mkwrite   = ll_page_mkwrite,
 586         .open           = ll_vm_open,
 587         .close          = ll_vm_close,
 588 };
 589
 590 int ll_file_mmap(struct file *file, struct vm_area_struct * vma)
 591 {
 592         struct inode *inode = file->f_dentry->d_inode;
 593         int rc;
 594         ENTRY;
 595
 596         if (ll_file_nolock(file))
 597                 RETURN(-EOPNOTSUPP);
 598
 599         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MAP, 1);
 600         rc = generic_file_mmap(file, vma);
 601         if (rc == 0) {
 602 #if !defined(HAVE_FILEMAP_POPULATE) && !defined(HAVE_VM_OP_FAULT)
 603                 if (!filemap_populate)
 604                         filemap_populate = vma->vm_ops->populate;
 605 #endif
 606                 vma->vm_ops = &ll_file_vm_ops;
 607                 vma->vm_ops->open(vma);
 608                 /* update the inode's size and mtime */
 609                 rc = ll_glimpse_size(inode);
 610         }
 611
 612         RETURN(rc);
 613 }