lustre/llite/llite_mmap.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  *
  32  * Copyright (c) 2011 Whamcloud, Inc.
  33  *
  34  */
  35 /*
  36  * This file is part of Lustre, http://www.lustre.org/
  37  * Lustre is a trademark of Sun Microsystems, Inc.
  38  */
  39
  40 #ifndef AUTOCONF_INCLUDED
  41 #include <linux/config.h>
  42 #endif
  43 #include <linux/kernel.h>
  44 #include <linux/mm.h>
  45 #include <linux/string.h>
  46 #include <linux/stat.h>
  47 #include <linux/errno.h>
  48 #include <linux/smp_lock.h>
  49 #include <linux/unistd.h>
  50 #include <linux/version.h>
  51 #include <asm/system.h>
  52 #include <asm/uaccess.h>
  53
  54 #include <linux/fs.h>
  55 #include <linux/stat.h>
  56 #include <asm/uaccess.h>
  57 #include <linux/mm.h>
  58 #include <linux/pagemap.h>
  59 #include <linux/smp_lock.h>
  60
  61 #define DEBUG_SUBSYSTEM S_LLITE
  62
  63 #include <lustre_lite.h>
  64 #include "llite_internal.h"
  65 #include <linux/lustre_compat25.h>
  66
  67 #define VMA_DEBUG(vma, fmt, arg...)                                     \
  68         CDEBUG(D_MMAP, "vma(%p) start(%ld) end(%ld) pgoff(%ld) inode(%p) "   \
  69                "ino(%lu) iname(%s): " fmt, vma, vma->vm_start, vma->vm_end,  \
  70                vma->vm_pgoff, vma->vm_file->f_dentry->d_inode,               \
  71                vma->vm_file->f_dentry->d_inode->i_ino,                       \
  72                vma->vm_file->f_dentry->d_iname, ## arg);                     \
  73
  74 struct page *ll_nopage(struct vm_area_struct *vma, unsigned long address,
  75                        int *type);
  76
  77 static struct vm_operations_struct ll_file_vm_ops;
  78
  79 void policy_from_vma(ldlm_policy_data_t *policy,
  80                             struct vm_area_struct *vma, unsigned long addr,
  81                             size_t count)
  82 {
  83         policy->l_extent.start = ((addr - vma->vm_start) & CFS_PAGE_MASK) +
  84                                  (vma->vm_pgoff << CFS_PAGE_SHIFT);
  85         policy->l_extent.end = (policy->l_extent.start + count - 1) |
  86                                ~CFS_PAGE_MASK;
  87 }
  88
  89 struct vm_area_struct * our_vma(unsigned long addr, size_t count)
  90 {
  91         struct mm_struct *mm = current->mm;
  92         struct vm_area_struct *vma, *ret = NULL;
  93         ENTRY;
  94
  95         /* No MM (e.g. NFS)? No vmas too. */
  96         if (!mm)
  97                 RETURN(NULL);
  98
  99         spin_lock(&mm->page_table_lock);
 100         for(vma = find_vma(mm, addr);
 101             vma != NULL && vma->vm_start < (addr + count); vma = vma->vm_next) {
 102                 if (vma->vm_ops && vma->vm_ops == &ll_file_vm_ops &&
 103                     vma->vm_flags & VM_SHARED) {
 104                         ret = vma;
 105                         break;
 106                 }
 107         }
 108         spin_unlock(&mm->page_table_lock);
 109         RETURN(ret);
 110 }
 111
 112 /**
 113  * API independent part for page fault initialization.
 114  * \param vma - virtual memory area addressed to page fault
 115  * \param env - corespondent lu_env to processing
 116  * \param nest - nested level
 117  * \param index - page index corespondent to fault.
 118  * \parm ra_flags - vma readahead flags.
 119  *
 120  * \return allocated and initialized env for fault operation.
 121  * \retval EINVAL if env can't allocated
 122  * \return other error codes from cl_io_init.
 123  */
 124 struct cl_io *ll_fault_io_init(struct vm_area_struct *vma,
 125                                struct lu_env **env_ret,
 126                                struct cl_env_nest *nest,
 127                                pgoff_t index, unsigned long *ra_flags)
 128 {
 129         struct file       *file  = vma->vm_file;
 130         struct inode      *inode = file->f_dentry->d_inode;
 131         const unsigned long writable = VM_SHARED|VM_WRITE;
 132         struct cl_io      *io;
 133         struct cl_fault_io *fio;
 134         struct lu_env     *env;
 135         ENTRY;
 136
 137         *env_ret = NULL;
 138         if (ll_file_nolock(file))
 139                 RETURN(ERR_PTR(-EOPNOTSUPP));
 140
 141         /*
 142          * page fault can be called when lustre IO is
 143          * already active for the current thread, e.g., when doing read/write
 144          * against user level buffer mapped from Lustre buffer. To avoid
 145          * stomping on existing context, optionally force an allocation of a new
 146          * one.
 147          */
 148         env = cl_env_nested_get(nest);
 149         if (IS_ERR(env))
 150                  RETURN(ERR_PTR(-EINVAL));
 151
 152         *env_ret = env;
 153
 154         io = ccc_env_thread_io(env);
 155         io->ci_obj = ll_i2info(inode)->lli_clob;
 156         LASSERT(io->ci_obj != NULL);
 157
 158         fio = &io->u.ci_fault;
 159         fio->ft_index      = index;
 160         fio->ft_writable   = (vma->vm_flags&writable) == writable;
 161         fio->ft_executable = vma->vm_flags&VM_EXEC;
 162
 163         /*
 164          * disable VM_SEQ_READ and use VM_RAND_READ to make sure that
 165          * the kernel will not read other pages not covered by ldlm in
 166          * filemap_nopage. we do our readahead in ll_readpage.
 167          */
 168         *ra_flags = vma->vm_flags & (VM_RAND_READ|VM_SEQ_READ);
 169         vma->vm_flags &= ~VM_SEQ_READ;
 170         vma->vm_flags |= VM_RAND_READ;
 171
 172         CDEBUG(D_INFO, "vm_flags: %lx (%lu %d %d)\n", vma->vm_flags,
 173                fio->ft_index, fio->ft_writable, fio->ft_executable);
 174
 175         if (cl_io_init(env, io, CIT_FAULT, io->ci_obj) == 0) {
 176                 struct ccc_io *cio = ccc_env_io(env);
 177                 struct ll_file_data *fd = LUSTRE_FPRIVATE(file);
 178
 179                 LASSERT(cio->cui_cl.cis_io == io);
 180
 181                 /* mmap lock must be MANDATORY
 182                  * it has to cache pages. */
 183                 io->ci_lockreq = CILR_MANDATORY;
 184
 185                 cio->cui_fd  = fd;
 186         }
 187
 188         return io;
 189 }
 190
 191 #ifndef HAVE_VM_OP_FAULT
 192 /**
 193  * Lustre implementation of a vm_operations_struct::nopage() method, called by
 194  * VM to server page fault (both in kernel and user space).
 195  *
 196  * This function sets up CIT_FAULT cl_io that does the job.
 197  *
 198  * \param vma - is virtiual area struct related to page fault
 199  * \param address - address when hit fault
 200  * \param type - of fault
 201  *
 202  * \return allocated and filled _unlocked_ page for address
 203  * \retval NOPAGE_SIGBUS if page not exist on this address
 204  * \retval NOPAGE_OOM not have memory for allocate new page
 205  */
 206 struct page *ll_nopage(struct vm_area_struct *vma, unsigned long address,
 207                        int *type)
 208 {
 209         struct lu_env           *env;
 210         struct cl_env_nest      nest;
 211         struct cl_io            *io;
 212         struct page             *page  = NOPAGE_SIGBUS;
 213         struct vvp_io           *vio = NULL;
 214         unsigned long           ra_flags;
 215         pgoff_t                 pg_offset;
 216         int                     result;
 217         ENTRY;
 218
 219         pg_offset = ((address - vma->vm_start) >> PAGE_SHIFT) + vma->vm_pgoff;
 220         io = ll_fault_io_init(vma, &env,  &nest, pg_offset, &ra_flags);
 221         if (IS_ERR(io))
 222                 return NOPAGE_SIGBUS;
 223
 224         result = io->ci_result;
 225         if (result < 0)
 226                 goto out_err;
 227
 228         vio = vvp_env_io(env);
 229         vio->u.fault.ft_vma            = vma;
 230         vio->u.fault.nopage.ft_address = address;
 231         vio->u.fault.nopage.ft_type    = type;
 232
 233         result = cl_io_loop(env, io);
 234
 235 out_err:
 236         if (result == 0)
 237                 page = vio->u.fault.ft_vmpage;
 238         else if (result == -ENOMEM)
 239                 page = NOPAGE_OOM;
 240
 241         vma->vm_flags &= ~VM_RAND_READ;
 242         vma->vm_flags |= ra_flags;
 243
 244         cl_io_fini(env, io);
 245         cl_env_nested_put(&nest, env);
 246
 247         RETURN(page);
 248 }
 249 #else
 250 /**
 251  * Lustre implementation of a vm_operations_struct::fault() method, called by
 252  * VM to server page fault (both in kernel and user space).
 253  *
 254  * \param vma - is virtiual area struct related to page fault
 255  * \param vmf - structure which describe type and address where hit fault
 256  *
 257  * \return allocated and filled _locked_ page for address
 258  * \retval VM_FAULT_ERROR on general error
 259  * \retval NOPAGE_OOM not have memory for allocate new page
 260  */
 261 int ll_fault0(struct vm_area_struct *vma, struct vm_fault *vmf)
 262 {
 263         struct lu_env           *env;
 264         struct cl_io            *io;
 265         struct vvp_io           *vio = NULL;
 266         unsigned long            ra_flags;
 267         struct cl_env_nest       nest;
 268         int                      result;
 269         int                      fault_ret = 0;
 270         ENTRY;
 271
 272         io = ll_fault_io_init(vma, &env,  &nest, vmf->pgoff, &ra_flags);
 273         if (IS_ERR(io))
 274                 RETURN(VM_FAULT_ERROR);
 275
 276         result = io->ci_result;
 277         if (result < 0)
 278                 goto out_err;
 279
 280         vio = vvp_env_io(env);
 281         vio->u.fault.ft_vma       = vma;
 282         vio->u.fault.ft_vmpage    = NULL;
 283         vio->u.fault.fault.ft_vmf = vmf;
 284
 285         result = cl_io_loop(env, io);
 286         fault_ret = vio->u.fault.fault.ft_flags;
 287
 288 out_err:
 289         if ((result != 0) && !(fault_ret & VM_FAULT_RETRY))
 290                 fault_ret |= VM_FAULT_ERROR;
 291
 292         vma->vm_flags |= ra_flags;
 293
 294         cl_io_fini(env, io);
 295         cl_env_nested_put(&nest, env);
 296
 297         RETURN(fault_ret);
 298 }
 299
 300 int ll_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
 301 {
 302         int count = 0;
 303         bool printed = false;
 304         int result;
 305
 306 restart:
 307         result = ll_fault0(vma, vmf);
 308         LASSERT(!(result & VM_FAULT_LOCKED));
 309         if (result == 0) {
 310                 struct page *vmpage = vmf->page;
 311
 312                 /* check if this page has been truncated */
 313                 lock_page(vmpage);
 314                 if (unlikely(vmpage->mapping == NULL)) { /* unlucky */
 315                         unlock_page(vmpage);
 316                         page_cache_release(vmpage);
 317                         vmf->page = NULL;
 318
 319                         if (!printed && ++count > 16) {
 320                                 CWARN("the page is under heavy contention,"
 321                                       "maybe your app(%s) needs revising :-)\n",
 322                                       current->comm);
 323                                 printed = true;
 324                         }
 325
 326                         goto restart;
 327                 }
 328
 329                 result |= VM_FAULT_LOCKED;
 330         }
 331         return result;
 332 }
 333 #endif
 334
 335 /**
 336  *  To avoid cancel the locks covering mmapped region for lock cache pressure,
 337  *  we track the mapped vma count in ccc_object::cob_mmap_cnt.
 338  */
 339 static void ll_vm_open(struct vm_area_struct * vma)
 340 {
 341         struct inode *inode    = vma->vm_file->f_dentry->d_inode;
 342         struct ccc_object *vob = cl_inode2ccc(inode);
 343
 344         ENTRY;
 345         LASSERT(vma->vm_file);
 346         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
 347         cfs_atomic_inc(&vob->cob_mmap_cnt);
 348         EXIT;
 349 }
 350
 351 /**
 352  * Dual to ll_vm_open().
 353  */
 354 static void ll_vm_close(struct vm_area_struct *vma)
 355 {
 356         struct inode      *inode = vma->vm_file->f_dentry->d_inode;
 357         struct ccc_object *vob   = cl_inode2ccc(inode);
 358
 359         ENTRY;
 360         LASSERT(vma->vm_file);
 361         cfs_atomic_dec(&vob->cob_mmap_cnt);
 362         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
 363         EXIT;
 364 }
 365
 366 #ifndef HAVE_VM_OP_FAULT
 367 #ifndef HAVE_FILEMAP_POPULATE
 368 static int (*filemap_populate)(struct vm_area_struct * area, unsigned long address, unsigned long len, pgprot_t prot, unsigned long pgoff, int nonblock);
 369 #endif
 370 static int ll_populate(struct vm_area_struct *area, unsigned long address,
 371                        unsigned long len, pgprot_t prot, unsigned long pgoff,
 372                        int nonblock)
 373 {
 374         int rc = 0;
 375         ENTRY;
 376
 377         /* always set nonblock as true to avoid page read ahead */
 378         rc = filemap_populate(area, address, len, prot, pgoff, 1);
 379         RETURN(rc);
 380 }
 381 #endif
 382
 383 /* return the user space pointer that maps to a file offset via a vma */
 384 static inline unsigned long file_to_user(struct vm_area_struct *vma, __u64 byte)
 385 {
 386         return vma->vm_start + (byte - ((__u64)vma->vm_pgoff << CFS_PAGE_SHIFT));
 387
 388 }
 389
 390 /* XXX put nice comment here.  talk about __free_pte -> dirty pages and
 391  * nopage's reference passing to the pte */
 392 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last)
 393 {
 394         int rc = -ENOENT;
 395         ENTRY;
 396
 397         LASSERTF(last > first, "last "LPU64" first "LPU64"\n", last, first);
 398         if (mapping_mapped(mapping)) {
 399                 rc = 0;
 400                 unmap_mapping_range(mapping, first + CFS_PAGE_SIZE - 1,
 401                                     last - first + 1, 0);
 402         }
 403
 404         RETURN(rc);
 405 }
 406
 407 static struct vm_operations_struct ll_file_vm_ops = {
 408 #ifndef HAVE_VM_OP_FAULT
 409         .nopage         = ll_nopage,
 410         .populate       = ll_populate,
 411
 412 #else
 413         .fault          = ll_fault,
 414 #endif
 415         .open           = ll_vm_open,
 416         .close          = ll_vm_close,
 417 };
 418
 419 int ll_file_mmap(struct file *file, struct vm_area_struct * vma)
 420 {
 421         struct inode *inode = file->f_dentry->d_inode;
 422         int rc;
 423         ENTRY;
 424
 425         if (ll_file_nolock(file))
 426                 RETURN(-EOPNOTSUPP);
 427
 428         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MAP, 1);
 429         rc = generic_file_mmap(file, vma);
 430         if (rc == 0) {
 431 #if !defined(HAVE_FILEMAP_POPULATE) && !defined(HAVE_VM_OP_FAULT)
 432                 if (!filemap_populate)
 433                         filemap_populate = vma->vm_ops->populate;
 434 #endif
 435                 vma->vm_ops = &ll_file_vm_ops;
 436                 vma->vm_ops->open(vma);
 437                 /* update the inode's size and mtime */
 438                 rc = cl_glimpse_size(inode);
 439         }
 440
 441         RETURN(rc);
 442 }