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_mdc.h>
  64 #include <lustre_lite.h>
  65 #include "llite_internal.h"
  66 #include <linux/lustre_compat25.h>
  67
  68 #define VMA_DEBUG(vma, fmt, arg...)                                     \
  69         CDEBUG(D_MMAP, "vma(%p) start(%ld) end(%ld) pgoff(%ld) inode(%p) "   \
  70                "ino(%lu) iname(%s): " fmt, vma, vma->vm_start, vma->vm_end,  \
  71                vma->vm_pgoff, vma->vm_file->f_dentry->d_inode,               \
  72                vma->vm_file->f_dentry->d_inode->i_ino,                       \
  73                vma->vm_file->f_dentry->d_iname, ## arg);                     \
  74
  75 struct page *ll_nopage(struct vm_area_struct *vma, unsigned long address,
  76                        int *type);
  77
  78 static struct vm_operations_struct ll_file_vm_ops;
  79
  80 void policy_from_vma(ldlm_policy_data_t *policy,
  81                             struct vm_area_struct *vma, unsigned long addr,
  82                             size_t count)
  83 {
  84         policy->l_extent.start = ((addr - vma->vm_start) & CFS_PAGE_MASK) +
  85                                  (vma->vm_pgoff << CFS_PAGE_SHIFT);
  86         policy->l_extent.end = (policy->l_extent.start + count - 1) |
  87                                ~CFS_PAGE_MASK;
  88 }
  89
  90 struct vm_area_struct * our_vma(unsigned long addr, size_t count)
  91 {
  92         struct mm_struct *mm = current->mm;
  93         struct vm_area_struct *vma, *ret = NULL;
  94         ENTRY;
  95
  96         /* No MM (e.g. NFS)? No vmas too. */
  97         if (!mm)
  98                 RETURN(NULL);
  99
 100         spin_lock(&mm->page_table_lock);
 101         for(vma = find_vma(mm, addr);
 102             vma != NULL && vma->vm_start < (addr + count); vma = vma->vm_next) {
 103                 if (vma->vm_ops && vma->vm_ops == &ll_file_vm_ops &&
 104                     vma->vm_flags & VM_SHARED) {
 105                         ret = vma;
 106                         break;
 107                 }
 108         }
 109         spin_unlock(&mm->page_table_lock);
 110         RETURN(ret);
 111 }
 112
 113 /**
 114  * API independent part for page fault initialization.
 115  * \param vma - virtual memory area addressed to page fault
 116  * \param env - corespondent lu_env to processing
 117  * \param nest - nested level
 118  * \param index - page index corespondent to fault.
 119  * \parm ra_flags - vma readahead flags.
 120  *
 121  * \return allocated and initialized env for fault operation.
 122  * \retval EINVAL if env can't allocated
 123  * \return other error codes from cl_io_init.
 124  */
 125 struct cl_io *ll_fault_io_init(struct vm_area_struct *vma,
 126                                struct lu_env **env_ret,
 127                                struct cl_env_nest *nest,
 128                                pgoff_t index, unsigned long *ra_flags)
 129 {
 130         struct file       *file  = vma->vm_file;
 131         struct inode      *inode = file->f_dentry->d_inode;
 132         const unsigned long writable = VM_SHARED|VM_WRITE;
 133         struct cl_io      *io;
 134         struct cl_fault_io *fio;
 135         struct lu_env     *env;
 136         ENTRY;
 137
 138         *env_ret = NULL;
 139         if (ll_file_nolock(file))
 140                 RETURN(ERR_PTR(-EOPNOTSUPP));
 141
 142         /*
 143          * page fault can be called when lustre IO is
 144          * already active for the current thread, e.g., when doing read/write
 145          * against user level buffer mapped from Lustre buffer. To avoid
 146          * stomping on existing context, optionally force an allocation of a new
 147          * one.
 148          */
 149         env = cl_env_nested_get(nest);
 150         if (IS_ERR(env))
 151                  RETURN(ERR_PTR(-EINVAL));
 152
 153         *env_ret = env;
 154
 155         io = ccc_env_thread_io(env);
 156         io->ci_obj = ll_i2info(inode)->lli_clob;
 157         LASSERT(io->ci_obj != NULL);
 158
 159         fio = &io->u.ci_fault;
 160         fio->ft_index      = index;
 161         fio->ft_writable   = (vma->vm_flags&writable) == writable;
 162         fio->ft_executable = vma->vm_flags&VM_EXEC;
 163
 164         /*
 165          * disable VM_SEQ_READ and use VM_RAND_READ to make sure that
 166          * the kernel will not read other pages not covered by ldlm in
 167          * filemap_nopage. we do our readahead in ll_readpage.
 168          */
 169         *ra_flags = vma->vm_flags & (VM_RAND_READ|VM_SEQ_READ);
 170         vma->vm_flags &= ~VM_SEQ_READ;
 171         vma->vm_flags |= VM_RAND_READ;
 172
 173         CDEBUG(D_INFO, "vm_flags: %lx (%lu %d %d)\n", vma->vm_flags,
 174                fio->ft_index, fio->ft_writable, fio->ft_executable);
 175
 176         if (cl_io_init(env, io, CIT_FAULT, io->ci_obj) == 0) {
 177                 struct ccc_io *cio = ccc_env_io(env);
 178                 struct ll_file_data *fd = LUSTRE_FPRIVATE(file);
 179
 180                 LASSERT(cio->cui_cl.cis_io == io);
 181
 182                 /* mmap lock must be MANDATORY
 183                  * it has to cache pages. */
 184                 io->ci_lockreq = CILR_MANDATORY;
 185
 186                 cio->cui_fd  = fd;
 187         }
 188
 189         return io;
 190 }
 191
 192 #ifndef HAVE_VM_OP_FAULT
 193 /**
 194  * Lustre implementation of a vm_operations_struct::nopage() method, called by
 195  * VM to server page fault (both in kernel and user space).
 196  *
 197  * This function sets up CIT_FAULT cl_io that does the job.
 198  *
 199  * \param vma - is virtiual area struct related to page fault
 200  * \param address - address when hit fault
 201  * \param type - of fault
 202  *
 203  * \return allocated and filled _unlocked_ page for address
 204  * \retval NOPAGE_SIGBUS if page not exist on this address
 205  * \retval NOPAGE_OOM not have memory for allocate new page
 206  */
 207 struct page *ll_nopage(struct vm_area_struct *vma, unsigned long address,
 208                        int *type)
 209 {
 210         struct lu_env           *env;
 211         struct cl_env_nest      nest;
 212         struct cl_io            *io;
 213         struct page             *page  = NOPAGE_SIGBUS;
 214         struct vvp_io           *vio = NULL;
 215         unsigned long           ra_flags;
 216         pgoff_t                 pg_offset;
 217         int                     result;
 218         cfs_sigset_t            set;
 219         ENTRY;
 220
 221         pg_offset = ((address - vma->vm_start) >> PAGE_SHIFT) + vma->vm_pgoff;
 222         io = ll_fault_io_init(vma, &env,  &nest, pg_offset, &ra_flags);
 223         if (IS_ERR(io))
 224                 return NOPAGE_SIGBUS;
 225
 226         result = io->ci_result;
 227         if (result < 0)
 228                 goto out_err;
 229
 230         vio = vvp_env_io(env);
 231         vio->u.fault.ft_vma            = vma;
 232         vio->u.fault.nopage.ft_address = address;
 233         vio->u.fault.nopage.ft_type    = type;
 234         vio->u.fault.ft_vmpage         = NULL;
 235
 236         set = cfs_block_sigsinv(sigmask(SIGKILL) | sigmask(SIGTERM));
 237         result = cl_io_loop(env, io);
 238         cfs_restore_sigs(set);
 239
 240         page = vio->u.fault.ft_vmpage;
 241         if (result != 0 && page != NULL) {
 242                 page_cache_release(page);
 243                 page = NOPAGE_SIGBUS;
 244         }
 245
 246 out_err:
 247         if (result == -ENOMEM)
 248                 page = NOPAGE_OOM;
 249
 250         vma->vm_flags &= ~VM_RAND_READ;
 251         vma->vm_flags |= ra_flags;
 252
 253         cl_io_fini(env, io);
 254         cl_env_nested_put(&nest, env);
 255
 256         RETURN(page);
 257 }
 258 #else
 259
 260 static inline int to_fault_error(int result)
 261 {
 262         switch(result) {
 263         case 0:
 264                 result = VM_FAULT_LOCKED;
 265                 break;
 266         case -EFAULT:
 267                 result = VM_FAULT_NOPAGE;
 268                 break;
 269         case -ENOMEM:
 270                 result = VM_FAULT_OOM;
 271                 break;
 272         default:
 273                 result = VM_FAULT_SIGBUS;
 274                 break;
 275         }
 276         return result;
 277 }
 278
 279 /**
 280  * Lustre implementation of a vm_operations_struct::fault() method, called by
 281  * VM to server page fault (both in kernel and user space).
 282  *
 283  * \param vma - is virtiual area struct related to page fault
 284  * \param vmf - structure which describe type and address where hit fault
 285  *
 286  * \return allocated and filled _locked_ page for address
 287  * \retval VM_FAULT_ERROR on general error
 288  * \retval NOPAGE_OOM not have memory for allocate new page
 289  */
 290 int ll_fault0(struct vm_area_struct *vma, struct vm_fault *vmf)
 291 {
 292         struct lu_env           *env;
 293         struct cl_io            *io;
 294         struct vvp_io           *vio = NULL;
 295         struct page             *vmpage;
 296         unsigned long            ra_flags;
 297         struct cl_env_nest       nest;
 298         int                      result;
 299         int                      fault_ret = 0;
 300         ENTRY;
 301
 302         io = ll_fault_io_init(vma, &env,  &nest, vmf->pgoff, &ra_flags);
 303         if (IS_ERR(io))
 304                 RETURN(to_fault_error(PTR_ERR(io)));
 305
 306         result = io->ci_result;
 307         if (result == 0) {
 308                 vio = vvp_env_io(env);
 309                 vio->u.fault.ft_vma       = vma;
 310                 vio->u.fault.ft_vmpage    = NULL;
 311                 vio->u.fault.fault.ft_vmf = vmf;
 312
 313                 result = cl_io_loop(env, io);
 314
 315                 fault_ret = vio->u.fault.fault.ft_flags;
 316                 vmpage = vio->u.fault.ft_vmpage;
 317                 if (result != 0 && vmpage != NULL) {
 318                         page_cache_release(vmpage);
 319                         vmf->page = NULL;
 320                 }
 321         }
 322         cl_io_fini(env, io);
 323         cl_env_nested_put(&nest, env);
 324
 325         vma->vm_flags |= ra_flags;
 326         if (result != 0 && !(fault_ret & VM_FAULT_RETRY))
 327                 fault_ret |= to_fault_error(result);
 328         RETURN(fault_ret);
 329 }
 330
 331 int ll_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
 332 {
 333         int count = 0;
 334         bool printed = false;
 335         int result;
 336         cfs_sigset_t set;
 337
 338         /* Only SIGKILL and SIGTERM is allowed for fault/nopage
 339          * so that it can be killed by admin but not cause segfault by
 340          * other signals. */
 341         set = cfs_block_sigsinv(sigmask(SIGKILL) | sigmask(SIGTERM));
 342
 343 restart:
 344         result = ll_fault0(vma, vmf);
 345         LASSERT(!(result & VM_FAULT_LOCKED));
 346         if (result == 0) {
 347                 struct page *vmpage = vmf->page;
 348
 349                 /* check if this page has been truncated */
 350                 lock_page(vmpage);
 351                 if (unlikely(vmpage->mapping == NULL)) { /* unlucky */
 352                         unlock_page(vmpage);
 353                         page_cache_release(vmpage);
 354                         vmf->page = NULL;
 355
 356                         if (!printed && ++count > 16) {
 357                                 CWARN("the page is under heavy contention,"
 358                                       "maybe your app(%s) needs revising :-)\n",
 359                                       current->comm);
 360                                 printed = true;
 361                         }
 362
 363                         goto restart;
 364                 }
 365
 366                 result |= VM_FAULT_LOCKED;
 367         }
 368         cfs_restore_sigs(set);
 369         return result;
 370 }
 371 #endif
 372
 373 /**
 374  *  To avoid cancel the locks covering mmapped region for lock cache pressure,
 375  *  we track the mapped vma count in ccc_object::cob_mmap_cnt.
 376  */
 377 static void ll_vm_open(struct vm_area_struct * vma)
 378 {
 379         struct inode *inode    = vma->vm_file->f_dentry->d_inode;
 380         struct ccc_object *vob = cl_inode2ccc(inode);
 381
 382         ENTRY;
 383         LASSERT(vma->vm_file);
 384         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
 385         cfs_atomic_inc(&vob->cob_mmap_cnt);
 386         EXIT;
 387 }
 388
 389 /**
 390  * Dual to ll_vm_open().
 391  */
 392 static void ll_vm_close(struct vm_area_struct *vma)
 393 {
 394         struct inode      *inode = vma->vm_file->f_dentry->d_inode;
 395         struct ccc_object *vob   = cl_inode2ccc(inode);
 396
 397         ENTRY;
 398         LASSERT(vma->vm_file);
 399         cfs_atomic_dec(&vob->cob_mmap_cnt);
 400         LASSERT(cfs_atomic_read(&vob->cob_mmap_cnt) >= 0);
 401         EXIT;
 402 }
 403
 404 #ifndef HAVE_VM_OP_FAULT
 405 #ifndef HAVE_FILEMAP_POPULATE
 406 static int (*filemap_populate)(struct vm_area_struct * area, unsigned long address, unsigned long len, pgprot_t prot, unsigned long pgoff, int nonblock);
 407 #endif
 408 static int ll_populate(struct vm_area_struct *area, unsigned long address,
 409                        unsigned long len, pgprot_t prot, unsigned long pgoff,
 410                        int nonblock)
 411 {
 412         int rc = 0;
 413         ENTRY;
 414
 415         /* always set nonblock as true to avoid page read ahead */
 416         rc = filemap_populate(area, address, len, prot, pgoff, 1);
 417         RETURN(rc);
 418 }
 419 #endif
 420
 421 /* return the user space pointer that maps to a file offset via a vma */
 422 static inline unsigned long file_to_user(struct vm_area_struct *vma, __u64 byte)
 423 {
 424         return vma->vm_start + (byte - ((__u64)vma->vm_pgoff << CFS_PAGE_SHIFT));
 425
 426 }
 427
 428 /* XXX put nice comment here.  talk about __free_pte -> dirty pages and
 429  * nopage's reference passing to the pte */
 430 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last)
 431 {
 432         int rc = -ENOENT;
 433         ENTRY;
 434
 435         LASSERTF(last > first, "last "LPU64" first "LPU64"\n", last, first);
 436         if (mapping_mapped(mapping)) {
 437                 rc = 0;
 438                 unmap_mapping_range(mapping, first + CFS_PAGE_SIZE - 1,
 439                                     last - first + 1, 0);
 440         }
 441
 442         RETURN(rc);
 443 }
 444
 445 static struct vm_operations_struct ll_file_vm_ops = {
 446 #ifndef HAVE_VM_OP_FAULT
 447         .nopage         = ll_nopage,
 448         .populate       = ll_populate,
 449
 450 #else
 451         .fault          = ll_fault,
 452 #endif
 453         .open           = ll_vm_open,
 454         .close          = ll_vm_close,
 455 };
 456
 457 int ll_file_mmap(struct file *file, struct vm_area_struct * vma)
 458 {
 459         struct inode *inode = file->f_dentry->d_inode;
 460         int rc;
 461         ENTRY;
 462
 463         if (ll_file_nolock(file))
 464                 RETURN(-EOPNOTSUPP);
 465
 466         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MAP, 1);
 467         rc = generic_file_mmap(file, vma);
 468         if (rc == 0) {
 469 #if !defined(HAVE_FILEMAP_POPULATE) && !defined(HAVE_VM_OP_FAULT)
 470                 if (!filemap_populate)
 471                         filemap_populate = vma->vm_ops->populate;
 472 #endif
 473                 vma->vm_ops = &ll_file_vm_ops;
 474                 vma->vm_ops->open(vma);
 475                 /* update the inode's size and mtime */
 476                 rc = cl_glimpse_size(inode);
 477         }
 478
 479         RETURN(rc);
 480 }