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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2016, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #include <linux/errno.h>
  34 #include <linux/delay.h>
  35 #include <linux/kernel.h>
  36 #include <linux/mm.h>
  37
  38 #define DEBUG_SUBSYSTEM S_LLITE
  39
  40 #include "llite_internal.h"
  41 #include <lustre_compat.h>
  42
  43 static const struct vm_operations_struct ll_file_vm_ops;
  44
  45 void policy_from_vma(union ldlm_policy_data *policy, struct vm_area_struct *vma,
  46                      unsigned long addr, size_t count)
  47 {
  48         policy->l_extent.start = ((addr - vma->vm_start) & PAGE_MASK) +
  49                                  (vma->vm_pgoff << PAGE_SHIFT);
  50         policy->l_extent.end = (policy->l_extent.start + count - 1) |
  51                                ~PAGE_MASK;
  52 }
  53
  54 struct vm_area_struct *our_vma(struct mm_struct *mm, unsigned long addr,
  55                                size_t count)
  56 {
  57         struct vm_area_struct *vma, *ret = NULL;
  58         ENTRY;
  59
  60         /* mmap_sem must have been held by caller. */
  61         LASSERT(!down_write_trylock(&mm->mmap_sem));
  62
  63         for(vma = find_vma(mm, addr);
  64             vma != NULL && vma->vm_start < (addr + count); vma = vma->vm_next) {
  65                 if (vma->vm_ops && vma->vm_ops == &ll_file_vm_ops &&
  66                     vma->vm_flags & VM_SHARED) {
  67                         ret = vma;
  68                         break;
  69                 }
  70         }
  71         RETURN(ret);
  72 }
  73
  74 /**
  75  * API independent part for page fault initialization.
  76  * \param env - corespondent lu_env to processing
  77  * \param vma - virtual memory area addressed to page fault
  78  * \param index - page index corespondent to fault.
  79  * \parm ra_flags - vma readahead flags.
  80  *
  81  * \return error codes from cl_io_init.
  82  */
  83 static struct cl_io *
  84 ll_fault_io_init(struct lu_env *env, struct vm_area_struct *vma,
  85                  pgoff_t index, unsigned long *ra_flags)
  86 {
  87         struct file            *file = vma->vm_file;
  88         struct inode           *inode = file_inode(file);
  89         struct cl_io           *io;
  90         struct cl_fault_io     *fio;
  91         int                     rc;
  92         ENTRY;
  93
  94         if (ll_file_nolock(file))
  95                 RETURN(ERR_PTR(-EOPNOTSUPP));
  96
  97 restart:
  98         io = vvp_env_thread_io(env);
  99         io->ci_obj = ll_i2info(inode)->lli_clob;
 100         LASSERT(io->ci_obj != NULL);
 101
 102         fio = &io->u.ci_fault;
 103         fio->ft_index      = index;
 104         fio->ft_executable = vma->vm_flags&VM_EXEC;
 105
 106         /*
 107          * disable VM_SEQ_READ and use VM_RAND_READ to make sure that
 108          * the kernel will not read other pages not covered by ldlm in
 109          * filemap_nopage. we do our readahead in ll_readpage.
 110          */
 111         if (ra_flags != NULL)
 112                 *ra_flags = vma->vm_flags & (VM_RAND_READ|VM_SEQ_READ);
 113         vma->vm_flags &= ~VM_SEQ_READ;
 114         vma->vm_flags |= VM_RAND_READ;
 115
 116         CDEBUG(D_MMAP, "vm_flags: %lx (%lu %d)\n", vma->vm_flags,
 117                fio->ft_index, fio->ft_executable);
 118
 119         rc = cl_io_init(env, io, CIT_FAULT, io->ci_obj);
 120         if (rc == 0) {
 121                 struct vvp_io *vio = vvp_env_io(env);
 122                 struct ll_file_data *fd = file->private_data;
 123
 124                 LASSERT(vio->vui_cl.cis_io == io);
 125
 126                 /* mmap lock must be MANDATORY it has to cache
 127                  * pages. */
 128                 io->ci_lockreq = CILR_MANDATORY;
 129                 vio->vui_fd = fd;
 130         } else {
 131                 LASSERT(rc < 0);
 132                 cl_io_fini(env, io);
 133                 if (io->ci_need_restart)
 134                         goto restart;
 135
 136                 io = ERR_PTR(rc);
 137         }
 138
 139         RETURN(io);
 140 }
 141
 142 /* Sharing code of page_mkwrite method for rhel5 and rhel6 */
 143 static int ll_page_mkwrite0(struct vm_area_struct *vma, struct page *vmpage,
 144                             bool *retry)
 145 {
 146         struct lu_env           *env;
 147         struct cl_io            *io;
 148         struct vvp_io           *vio;
 149         int                      result;
 150         __u16                    refcheck;
 151         sigset_t old, new;
 152         struct inode             *inode = NULL;
 153         struct ll_inode_info     *lli;
 154         ENTRY;
 155
 156         LASSERT(vmpage != NULL);
 157         env = cl_env_get(&refcheck);
 158         if (IS_ERR(env))
 159                 RETURN(PTR_ERR(env));
 160
 161         io = ll_fault_io_init(env, vma, vmpage->index, NULL);
 162         if (IS_ERR(io))
 163                 GOTO(out, result = PTR_ERR(io));
 164
 165         result = io->ci_result;
 166         if (result < 0)
 167                 GOTO(out_io, result);
 168
 169         io->u.ci_fault.ft_mkwrite = 1;
 170         io->u.ci_fault.ft_writable = 1;
 171
 172         vio = vvp_env_io(env);
 173         vio->u.fault.ft_vma    = vma;
 174         vio->u.fault.ft_vmpage = vmpage;
 175
 176         siginitsetinv(&new, sigmask(SIGKILL) | sigmask(SIGTERM));
 177         sigprocmask(SIG_BLOCK, &new, &old);
 178
 179         inode = vvp_object_inode(io->ci_obj);
 180         lli = ll_i2info(inode);
 181
 182         result = cl_io_loop(env, io);
 183
 184         sigprocmask(SIG_SETMASK, &old, NULL);
 185
 186         if (result == 0) {
 187                 lock_page(vmpage);
 188                 if (vmpage->mapping == NULL) {
 189                         unlock_page(vmpage);
 190
 191                         /* page was truncated and lock was cancelled, return
 192                          * ENODATA so that VM_FAULT_NOPAGE will be returned
 193                          * to handle_mm_fault(). */
 194                         if (result == 0)
 195                                 result = -ENODATA;
 196                 } else if (!PageDirty(vmpage)) {
 197                         /* race, the page has been cleaned by ptlrpcd after
 198                          * it was unlocked, it has to be added into dirty
 199                          * cache again otherwise this soon-to-dirty page won't
 200                          * consume any grants, even worse if this page is being
 201                          * transferred because it will break RPC checksum.
 202                          */
 203                         unlock_page(vmpage);
 204
 205                         CDEBUG(D_MMAP, "Race on page_mkwrite %p/%lu, page has "
 206                                "been written out, retry.\n",
 207                                vmpage, vmpage->index);
 208
 209                         *retry = true;
 210                         result = -EAGAIN;
 211                 }
 212
 213                 if (result == 0)
 214                         ll_file_set_flag(lli, LLIF_DATA_MODIFIED);
 215         }
 216         EXIT;
 217
 218 out_io:
 219         cl_io_fini(env, io);
 220 out:
 221         cl_env_put(env, &refcheck);
 222         CDEBUG(D_MMAP, "%s mkwrite with %d\n", current->comm, result);
 223         LASSERT(ergo(result == 0, PageLocked(vmpage)));
 224
 225         /* if page has been unmapped, presumably due to lock reclaim for
 226          * concurrent usage, add some delay before retrying to prevent
 227          * entering live-lock situation with competitors
 228          */
 229         if (result == -ENODATA && inode != NULL) {
 230                 CDEBUG(D_MMAP, "delaying new page-fault for inode %p to "
 231                                "prevent live-lock\n", inode);
 232                 msleep(10);
 233         }
 234
 235         return result;
 236 }
 237
 238 static inline int to_fault_error(int result)
 239 {
 240         switch(result) {
 241         case 0:
 242                 result = VM_FAULT_LOCKED;
 243                 break;
 244         case -ENOMEM:
 245                 result = VM_FAULT_OOM;
 246                 break;
 247         default:
 248                 result = VM_FAULT_SIGBUS;
 249                 break;
 250         }
 251         return result;
 252 }
 253
 254 /**
 255  * Lustre implementation of a vm_operations_struct::fault() method, called by
 256  * VM to server page fault (both in kernel and user space).
 257  *
 258  * \param vma - is virtiual area struct related to page fault
 259  * \param vmf - structure which describe type and address where hit fault
 260  *
 261  * \return allocated and filled _locked_ page for address
 262  * \retval VM_FAULT_ERROR on general error
 263  * \retval NOPAGE_OOM not have memory for allocate new page
 264  */
 265 static vm_fault_t ll_fault0(struct vm_area_struct *vma, struct vm_fault *vmf)
 266 {
 267         struct lu_env           *env;
 268         struct cl_io            *io;
 269         struct vvp_io           *vio = NULL;
 270         struct page             *vmpage;
 271         unsigned long            ra_flags;
 272         int                      result = 0;
 273         int                      fault_ret = 0;
 274         __u16                    refcheck;
 275         ENTRY;
 276
 277         env = cl_env_get(&refcheck);
 278         if (IS_ERR(env))
 279                 RETURN(PTR_ERR(env));
 280
 281         if (ll_sbi_has_fast_read(ll_i2sbi(file_inode(vma->vm_file)))) {
 282                 /* do fast fault */
 283                 ll_cl_add(vma->vm_file, env, NULL, LCC_MMAP);
 284                 fault_ret = ll_filemap_fault(vma, vmf);
 285                 ll_cl_remove(vma->vm_file, env);
 286
 287                 /* - If there is no error, then the page was found in cache and
 288                  *   uptodate;
 289                  * - If VM_FAULT_RETRY is set, the page existed but failed to
 290                  *   lock. It will return to kernel and retry;
 291                  * - Otherwise, it should try normal fault under DLM lock. */
 292                 if ((fault_ret & VM_FAULT_RETRY) ||
 293                     !(fault_ret & VM_FAULT_ERROR))
 294                         GOTO(out, result = 0);
 295
 296                 fault_ret = 0;
 297         }
 298
 299         io = ll_fault_io_init(env, vma, vmf->pgoff, &ra_flags);
 300         if (IS_ERR(io))
 301                 GOTO(out, result = PTR_ERR(io));
 302
 303         result = io->ci_result;
 304         if (result == 0) {
 305                 vio = vvp_env_io(env);
 306                 vio->u.fault.ft_vma       = vma;
 307                 vio->u.fault.ft_vmpage    = NULL;
 308                 vio->u.fault.ft_vmf = vmf;
 309                 vio->u.fault.ft_flags = 0;
 310                 vio->u.fault.ft_flags_valid = 0;
 311
 312                 /* May call ll_readpage() */
 313                 ll_cl_add(vma->vm_file, env, io, LCC_MMAP);
 314
 315                 result = cl_io_loop(env, io);
 316
 317                 ll_cl_remove(vma->vm_file, env);
 318
 319                 /* ft_flags are only valid if we reached
 320                  * the call to filemap_fault */
 321                 if (vio->u.fault.ft_flags_valid)
 322                         fault_ret = vio->u.fault.ft_flags;
 323
 324                 vmpage = vio->u.fault.ft_vmpage;
 325                 if (result != 0 && vmpage != NULL) {
 326                         put_page(vmpage);
 327                         vmf->page = NULL;
 328                 }
 329         }
 330         cl_io_fini(env, io);
 331
 332         vma->vm_flags |= ra_flags;
 333
 334 out:
 335         cl_env_put(env, &refcheck);
 336         if (result != 0 && !(fault_ret & VM_FAULT_RETRY))
 337                 fault_ret |= to_fault_error(result);
 338
 339         CDEBUG(D_MMAP, "%s fault %d/%d\n", current->comm, fault_ret, result);
 340         RETURN(fault_ret);
 341 }
 342
 343 #ifdef HAVE_VM_OPS_USE_VM_FAULT_ONLY
 344 static vm_fault_t ll_fault(struct vm_fault *vmf)
 345 {
 346         struct vm_area_struct *vma = vmf->vma;
 347 #else
 348 static vm_fault_t ll_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
 349 {
 350 #endif
 351         int count = 0;
 352         bool printed = false;
 353         bool cached;
 354         vm_fault_t result;
 355         ktime_t kstart = ktime_get();
 356         sigset_t old, new;
 357
 358         result = pcc_fault(vma, vmf, &cached);
 359         if (cached)
 360                 goto out;
 361
 362         /* Only SIGKILL and SIGTERM is allowed for fault/nopage/mkwrite
 363          * so that it can be killed by admin but not cause segfault by
 364          * other signals.
 365          */
 366         siginitsetinv(&new, sigmask(SIGKILL) | sigmask(SIGTERM));
 367         sigprocmask(SIG_BLOCK, &new, &old);
 368
 369         /* make sure offset is not a negative number */
 370         if (vmf->pgoff > (MAX_LFS_FILESIZE >> PAGE_SHIFT))
 371                 return VM_FAULT_SIGBUS;
 372 restart:
 373         result = ll_fault0(vma, vmf);
 374         if (vmf->page &&
 375             !(result & (VM_FAULT_RETRY | VM_FAULT_ERROR | VM_FAULT_LOCKED))) {
 376                 struct page *vmpage = vmf->page;
 377
 378                 /* check if this page has been truncated */
 379                 lock_page(vmpage);
 380                 if (unlikely(vmpage->mapping == NULL)) { /* unlucky */
 381                         unlock_page(vmpage);
 382                         put_page(vmpage);
 383                         vmf->page = NULL;
 384
 385                         if (!printed && ++count > 16) {
 386                                 CWARN("the page is under heavy contention, maybe your app(%s) needs revising :-)\n",
 387                                       current->comm);
 388                                 printed = true;
 389                         }
 390
 391                         goto restart;
 392                 }
 393
 394                 result |= VM_FAULT_LOCKED;
 395         }
 396         sigprocmask(SIG_SETMASK, &old, NULL);
 397
 398 out:
 399         if (vmf->page && result == VM_FAULT_LOCKED) {
 400                 ll_rw_stats_tally(ll_i2sbi(file_inode(vma->vm_file)),
 401                                   current->pid, vma->vm_file->private_data,
 402                                   cl_offset(NULL, vmf->page->index), PAGE_SIZE,
 403                                   READ);
 404                 ll_stats_ops_tally(ll_i2sbi(file_inode(vma->vm_file)),
 405                                    LPROC_LL_FAULT,
 406                                    ktime_us_delta(ktime_get(), kstart));
 407         }
 408
 409         return result;
 410 }
 411
 412 #ifdef HAVE_VM_OPS_USE_VM_FAULT_ONLY
 413 static vm_fault_t ll_page_mkwrite(struct vm_fault *vmf)
 414 {
 415         struct vm_area_struct *vma = vmf->vma;
 416 #else
 417 static vm_fault_t ll_page_mkwrite(struct vm_area_struct *vma,
 418                                   struct vm_fault *vmf)
 419 {
 420 #endif
 421         int count = 0;
 422         bool printed = false;
 423         bool retry;
 424         bool cached;
 425         ktime_t kstart = ktime_get();
 426         vm_fault_t result;
 427
 428         result = pcc_page_mkwrite(vma, vmf, &cached);
 429         if (cached)
 430                 goto out;
 431
 432         file_update_time(vma->vm_file);
 433         do {
 434                 retry = false;
 435                 result = ll_page_mkwrite0(vma, vmf->page, &retry);
 436
 437                 if (!printed && ++count > 16) {
 438                         const struct dentry *de = file_dentry(vma->vm_file);
 439
 440                         CWARN("app(%s): the page %lu of file "DFID" is under heavy contention\n",
 441                               current->comm, vmf->pgoff,
 442                               PFID(ll_inode2fid(de->d_inode)));
 443                         printed = true;
 444                 }
 445         } while (retry);
 446
 447         switch (result) {
 448         case 0:
 449                 LASSERT(PageLocked(vmf->page));
 450                 result = VM_FAULT_LOCKED;
 451                 break;
 452         case -ENODATA:
 453         case -EFAULT:
 454                 result = VM_FAULT_NOPAGE;
 455                 break;
 456         case -ENOMEM:
 457                 result = VM_FAULT_OOM;
 458                 break;
 459         case -EAGAIN:
 460                 result = VM_FAULT_RETRY;
 461                 break;
 462         default:
 463                 result = VM_FAULT_SIGBUS;
 464                 break;
 465         }
 466
 467 out:
 468         if (result == VM_FAULT_LOCKED) {
 469                 ll_rw_stats_tally(ll_i2sbi(file_inode(vma->vm_file)),
 470                                   current->pid, vma->vm_file->private_data,
 471                                   cl_offset(NULL, vmf->page->index), PAGE_SIZE,
 472                                   WRITE);
 473                 ll_stats_ops_tally(ll_i2sbi(file_inode(vma->vm_file)),
 474                                    LPROC_LL_MKWRITE,
 475                                    ktime_us_delta(ktime_get(), kstart));
 476         }
 477
 478         return result;
 479 }
 480
 481 /**
 482  *  To avoid cancel the locks covering mmapped region for lock cache pressure,
 483  *  we track the mapped vma count in vvp_object::vob_mmap_cnt.
 484  */
 485 static void ll_vm_open(struct vm_area_struct * vma)
 486 {
 487         struct inode *inode    = file_inode(vma->vm_file);
 488         struct vvp_object *vob = cl_inode2vvp(inode);
 489
 490         ENTRY;
 491         LASSERT(atomic_read(&vob->vob_mmap_cnt) >= 0);
 492         atomic_inc(&vob->vob_mmap_cnt);
 493         pcc_vm_open(vma);
 494         EXIT;
 495 }
 496
 497 /**
 498  * Dual to ll_vm_open().
 499  */
 500 static void ll_vm_close(struct vm_area_struct *vma)
 501 {
 502         struct inode      *inode = file_inode(vma->vm_file);
 503         struct vvp_object *vob   = cl_inode2vvp(inode);
 504
 505         ENTRY;
 506         atomic_dec(&vob->vob_mmap_cnt);
 507         LASSERT(atomic_read(&vob->vob_mmap_cnt) >= 0);
 508         pcc_vm_close(vma);
 509         EXIT;
 510 }
 511
 512 /* XXX put nice comment here.  talk about __free_pte -> dirty pages and
 513  * nopage's reference passing to the pte */
 514 int ll_teardown_mmaps(struct address_space *mapping, __u64 first, __u64 last)
 515 {
 516         int rc = -ENOENT;
 517         ENTRY;
 518
 519         LASSERTF(last > first, "last %llu first %llu\n", last, first);
 520         if (mapping_mapped(mapping)) {
 521                 rc = 0;
 522                 unmap_mapping_range(mapping, first + PAGE_SIZE - 1,
 523                                     last - first + 1, 0);
 524         }
 525
 526         RETURN(rc);
 527 }
 528
 529 static const struct vm_operations_struct ll_file_vm_ops = {
 530         .fault                  = ll_fault,
 531         .page_mkwrite           = ll_page_mkwrite,
 532         .open                   = ll_vm_open,
 533         .close                  = ll_vm_close,
 534 };
 535
 536 int ll_file_mmap(struct file *file, struct vm_area_struct * vma)
 537 {
 538         struct inode *inode = file_inode(file);
 539         ktime_t kstart = ktime_get();
 540         bool cached;
 541         int rc;
 542
 543         ENTRY;
 544
 545         if (ll_file_nolock(file))
 546                 RETURN(-EOPNOTSUPP);
 547
 548         rc = pcc_file_mmap(file, vma, &cached);
 549         if (cached && rc != 0)
 550                 RETURN(rc);
 551
 552         rc = generic_file_mmap(file, vma);
 553         if (rc == 0) {
 554                 vma->vm_ops = &ll_file_vm_ops;
 555                 vma->vm_ops->open(vma);
 556                 /* update the inode's size and mtime */
 557                 if (!cached)
 558                         rc = ll_glimpse_size(inode);
 559         }
 560
 561         if (!rc)
 562                 ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_MMAP,
 563                                    ktime_us_delta(ktime_get(), kstart));
 564
 565         RETURN(rc);
 566 }