include/linux/pagemap.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_PAGEMAP_H
   3 #define _LINUX_PAGEMAP_H
   4
   5 /*
   6  * Copyright 1995 Linus Torvalds
   7  */
   8 #include <linux/mm.h>
   9 #include <linux/fs.h>
  10 #include <linux/list.h>
  11 #include <linux/highmem.h>
  12 #include <linux/compiler.h>
  13 #include <linux/uaccess.h>
  14 #include <linux/gfp.h>
  15 #include <linux/bitops.h>
  16 #include <linux/hardirq.h> /* for in_interrupt() */
  17 #include <linux/hugetlb_inline.h>
  18
  19 struct pagevec;
  20
  21 /*
  22  * Bits in mapping->flags.
  23  */
  24 enum mapping_flags {
  25         AS_EIO          = 0,    /* IO error on async write */
  26         AS_ENOSPC       = 1,    /* ENOSPC on async write */
  27         AS_MM_ALL_LOCKS = 2,    /* under mm_take_all_locks() */
  28         AS_UNEVICTABLE  = 3,    /* e.g., ramdisk, SHM_LOCK */
  29         AS_EXITING      = 4,    /* final truncate in progress */
  30         /* writeback related tags are not used */
  31         AS_NO_WRITEBACK_TAGS = 5,
  32 };
  33
  34 /**
  35  * mapping_set_error - record a writeback error in the address_space
  36  * @mapping - the mapping in which an error should be set
  37  * @error - the error to set in the mapping
  38  *
  39  * When writeback fails in some way, we must record that error so that
  40  * userspace can be informed when fsync and the like are called.  We endeavor
  41  * to report errors on any file that was open at the time of the error.  Some
  42  * internal callers also need to know when writeback errors have occurred.
  43  *
  44  * When a writeback error occurs, most filesystems will want to call
  45  * mapping_set_error to record the error in the mapping so that it can be
  46  * reported when the application calls fsync(2).
  47  */
  48 static inline void mapping_set_error(struct address_space *mapping, int error)
  49 {
  50         if (likely(!error))
  51                 return;
  52
  53         /* Record in wb_err for checkers using errseq_t based tracking */
  54         filemap_set_wb_err(mapping, error);
  55
  56         /* Record it in flags for now, for legacy callers */
  57         if (error == -ENOSPC)
  58                 set_bit(AS_ENOSPC, &mapping->flags);
  59         else
  60                 set_bit(AS_EIO, &mapping->flags);
  61 }
  62
  63 static inline void mapping_set_unevictable(struct address_space *mapping)
  64 {
  65         set_bit(AS_UNEVICTABLE, &mapping->flags);
  66 }
  67
  68 static inline void mapping_clear_unevictable(struct address_space *mapping)
  69 {
  70         clear_bit(AS_UNEVICTABLE, &mapping->flags);
  71 }
  72
  73 static inline int mapping_unevictable(struct address_space *mapping)
  74 {
  75         if (mapping)
  76                 return test_bit(AS_UNEVICTABLE, &mapping->flags);
  77         return !!mapping;
  78 }
  79
  80 static inline void mapping_set_exiting(struct address_space *mapping)
  81 {
  82         set_bit(AS_EXITING, &mapping->flags);
  83 }
  84
  85 static inline int mapping_exiting(struct address_space *mapping)
  86 {
  87         return test_bit(AS_EXITING, &mapping->flags);
  88 }
  89
  90 static inline void mapping_set_no_writeback_tags(struct address_space *mapping)
  91 {
  92         set_bit(AS_NO_WRITEBACK_TAGS, &mapping->flags);
  93 }
  94
  95 static inline int mapping_use_writeback_tags(struct address_space *mapping)
  96 {
  97         return !test_bit(AS_NO_WRITEBACK_TAGS, &mapping->flags);
  98 }
  99
 100 static inline gfp_t mapping_gfp_mask(struct address_space * mapping)
 101 {
 102         return mapping->gfp_mask;
 103 }
 104
 105 /* Restricts the given gfp_mask to what the mapping allows. */
 106 static inline gfp_t mapping_gfp_constraint(struct address_space *mapping,
 107                 gfp_t gfp_mask)
 108 {
 109         return mapping_gfp_mask(mapping) & gfp_mask;
 110 }
 111
 112 /*
 113  * This is non-atomic.  Only to be used before the mapping is activated.
 114  * Probably needs a barrier...
 115  */
 116 static inline void mapping_set_gfp_mask(struct address_space *m, gfp_t mask)
 117 {
 118         m->gfp_mask = mask;
 119 }
 120
 121 void release_pages(struct page **pages, int nr);
 122
 123 /*
 124  * speculatively take a reference to a page.
 125  * If the page is free (_refcount == 0), then _refcount is untouched, and 0
 126  * is returned. Otherwise, _refcount is incremented by 1 and 1 is returned.
 127  *
 128  * This function must be called inside the same rcu_read_lock() section as has
 129  * been used to lookup the page in the pagecache radix-tree (or page table):
 130  * this allows allocators to use a synchronize_rcu() to stabilize _refcount.
 131  *
 132  * Unless an RCU grace period has passed, the count of all pages coming out
 133  * of the allocator must be considered unstable. page_count may return higher
 134  * than expected, and put_page must be able to do the right thing when the
 135  * page has been finished with, no matter what it is subsequently allocated
 136  * for (because put_page is what is used here to drop an invalid speculative
 137  * reference).
 138  *
 139  * This is the interesting part of the lockless pagecache (and lockless
 140  * get_user_pages) locking protocol, where the lookup-side (eg. find_get_page)
 141  * has the following pattern:
 142  * 1. find page in radix tree
 143  * 2. conditionally increment refcount
 144  * 3. check the page is still in pagecache (if no, goto 1)
 145  *
 146  * Remove-side that cares about stability of _refcount (eg. reclaim) has the
 147  * following (with the i_pages lock held):
 148  * A. atomically check refcount is correct and set it to 0 (atomic_cmpxchg)
 149  * B. remove page from pagecache
 150  * C. free the page
 151  *
 152  * There are 2 critical interleavings that matter:
 153  * - 2 runs before A: in this case, A sees elevated refcount and bails out
 154  * - A runs before 2: in this case, 2 sees zero refcount and retries;
 155  *   subsequently, B will complete and 1 will find no page, causing the
 156  *   lookup to return NULL.
 157  *
 158  * It is possible that between 1 and 2, the page is removed then the exact same
 159  * page is inserted into the same position in pagecache. That's OK: the
 160  * old find_get_page using a lock could equally have run before or after
 161  * such a re-insertion, depending on order that locks are granted.
 162  *
 163  * Lookups racing against pagecache insertion isn't a big problem: either 1
 164  * will find the page or it will not. Likewise, the old find_get_page could run
 165  * either before the insertion or afterwards, depending on timing.
 166  */
 167 static inline int __page_cache_add_speculative(struct page *page, int count)
 168 {
 169 #ifdef CONFIG_TINY_RCU
 170 # ifdef CONFIG_PREEMPT_COUNT
 171         VM_BUG_ON(!in_atomic() && !irqs_disabled());
 172 # endif
 173         /*
 174          * Preempt must be disabled here - we rely on rcu_read_lock doing
 175          * this for us.
 176          *
 177          * Pagecache won't be truncated from interrupt context, so if we have
 178          * found a page in the radix tree here, we have pinned its refcount by
 179          * disabling preempt, and hence no need for the "speculative get" that
 180          * SMP requires.
 181          */
 182         VM_BUG_ON_PAGE(page_count(page) == 0, page);
 183         page_ref_add(page, count);
 184
 185 #else
 186         if (unlikely(!page_ref_add_unless(page, count, 0))) {
 187                 /*
 188                  * Either the page has been freed, or will be freed.
 189                  * In either case, retry here and the caller should
 190                  * do the right thing (see comments above).
 191                  */
 192                 return 0;
 193         }
 194 #endif
 195         VM_BUG_ON_PAGE(PageTail(page), page);
 196
 197         return 1;
 198 }
 199
 200 static inline int page_cache_get_speculative(struct page *page)
 201 {
 202         return __page_cache_add_speculative(page, 1);
 203 }
 204
 205 static inline int page_cache_add_speculative(struct page *page, int count)
 206 {
 207         return __page_cache_add_speculative(page, count);
 208 }
 209
 210 #ifdef CONFIG_NUMA
 211 extern struct page *__page_cache_alloc(gfp_t gfp);
 212 #else
 213 static inline struct page *__page_cache_alloc(gfp_t gfp)
 214 {
 215         return alloc_pages(gfp, 0);
 216 }
 217 #endif
 218
 219 static inline struct page *page_cache_alloc(struct address_space *x)
 220 {
 221         return __page_cache_alloc(mapping_gfp_mask(x));
 222 }
 223
 224 static inline gfp_t readahead_gfp_mask(struct address_space *x)
 225 {
 226         return mapping_gfp_mask(x) | __GFP_NORETRY | __GFP_NOWARN;
 227 }
 228
 229 typedef int filler_t(void *, struct page *);
 230
 231 pgoff_t page_cache_next_miss(struct address_space *mapping,
 232                              pgoff_t index, unsigned long max_scan);
 233 pgoff_t page_cache_prev_miss(struct address_space *mapping,
 234                              pgoff_t index, unsigned long max_scan);
 235
 236 #define FGP_ACCESSED            0x00000001
 237 #define FGP_LOCK                0x00000002
 238 #define FGP_CREAT               0x00000004
 239 #define FGP_WRITE               0x00000008
 240 #define FGP_NOFS                0x00000010
 241 #define FGP_NOWAIT              0x00000020
 242
 243 struct page *pagecache_get_page(struct address_space *mapping, pgoff_t offset,
 244                 int fgp_flags, gfp_t cache_gfp_mask);
 245
 246 /**
 247  * find_get_page - find and get a page reference
 248  * @mapping: the address_space to search
 249  * @offset: the page index
 250  *
 251  * Looks up the page cache slot at @mapping & @offset.  If there is a
 252  * page cache page, it is returned with an increased refcount.
 253  *
 254  * Otherwise, %NULL is returned.
 255  */
 256 static inline struct page *find_get_page(struct address_space *mapping,
 257                                         pgoff_t offset)
 258 {
 259         return pagecache_get_page(mapping, offset, 0, 0);
 260 }
 261
 262 static inline struct page *find_get_page_flags(struct address_space *mapping,
 263                                         pgoff_t offset, int fgp_flags)
 264 {
 265         return pagecache_get_page(mapping, offset, fgp_flags, 0);
 266 }
 267
 268 /**
 269  * find_lock_page - locate, pin and lock a pagecache page
 270  * @mapping: the address_space to search
 271  * @offset: the page index
 272  *
 273  * Looks up the page cache slot at @mapping & @offset.  If there is a
 274  * page cache page, it is returned locked and with an increased
 275  * refcount.
 276  *
 277  * Otherwise, %NULL is returned.
 278  *
 279  * find_lock_page() may sleep.
 280  */
 281 static inline struct page *find_lock_page(struct address_space *mapping,
 282                                         pgoff_t offset)
 283 {
 284         return pagecache_get_page(mapping, offset, FGP_LOCK, 0);
 285 }
 286
 287 /**
 288  * find_or_create_page - locate or add a pagecache page
 289  * @mapping: the page's address_space
 290  * @index: the page's index into the mapping
 291  * @gfp_mask: page allocation mode
 292  *
 293  * Looks up the page cache slot at @mapping & @offset.  If there is a
 294  * page cache page, it is returned locked and with an increased
 295  * refcount.
 296  *
 297  * If the page is not present, a new page is allocated using @gfp_mask
 298  * and added to the page cache and the VM's LRU list.  The page is
 299  * returned locked and with an increased refcount.
 300  *
 301  * On memory exhaustion, %NULL is returned.
 302  *
 303  * find_or_create_page() may sleep, even if @gfp_flags specifies an
 304  * atomic allocation!
 305  */
 306 static inline struct page *find_or_create_page(struct address_space *mapping,
 307                                         pgoff_t offset, gfp_t gfp_mask)
 308 {
 309         return pagecache_get_page(mapping, offset,
 310                                         FGP_LOCK|FGP_ACCESSED|FGP_CREAT,
 311                                         gfp_mask);
 312 }
 313
 314 /**
 315  * grab_cache_page_nowait - returns locked page at given index in given cache
 316  * @mapping: target address_space
 317  * @index: the page index
 318  *
 319  * Same as grab_cache_page(), but do not wait if the page is unavailable.
 320  * This is intended for speculative data generators, where the data can
 321  * be regenerated if the page couldn't be grabbed.  This routine should
 322  * be safe to call while holding the lock for another page.
 323  *
 324  * Clear __GFP_FS when allocating the page to avoid recursion into the fs
 325  * and deadlock against the caller's locked page.
 326  */
 327 static inline struct page *grab_cache_page_nowait(struct address_space *mapping,
 328                                 pgoff_t index)
 329 {
 330         return pagecache_get_page(mapping, index,
 331                         FGP_LOCK|FGP_CREAT|FGP_NOFS|FGP_NOWAIT,
 332                         mapping_gfp_mask(mapping));
 333 }
 334
 335 struct page *find_get_entry(struct address_space *mapping, pgoff_t offset);
 336 struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset);
 337 unsigned find_get_entries(struct address_space *mapping, pgoff_t start,
 338                           unsigned int nr_entries, struct page **entries,
 339                           pgoff_t *indices);
 340 unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
 341                         pgoff_t end, unsigned int nr_pages,
 342                         struct page **pages);
 343 static inline unsigned find_get_pages(struct address_space *mapping,
 344                         pgoff_t *start, unsigned int nr_pages,
 345                         struct page **pages)
 346 {
 347         return find_get_pages_range(mapping, start, (pgoff_t)-1, nr_pages,
 348                                     pages);
 349 }
 350 unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t start,
 351                                unsigned int nr_pages, struct page **pages);
 352 unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
 353                         pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
 354                         struct page **pages);
 355 static inline unsigned find_get_pages_tag(struct address_space *mapping,
 356                         pgoff_t *index, xa_mark_t tag, unsigned int nr_pages,
 357                         struct page **pages)
 358 {
 359         return find_get_pages_range_tag(mapping, index, (pgoff_t)-1, tag,
 360                                         nr_pages, pages);
 361 }
 362 unsigned find_get_entries_tag(struct address_space *mapping, pgoff_t start,
 363                         xa_mark_t tag, unsigned int nr_entries,
 364                         struct page **entries, pgoff_t *indices);
 365
 366 struct page *grab_cache_page_write_begin(struct address_space *mapping,
 367                         pgoff_t index, unsigned flags);
 368
 369 /*
 370  * Returns locked page at given index in given cache, creating it if needed.
 371  */
 372 static inline struct page *grab_cache_page(struct address_space *mapping,
 373                                                                 pgoff_t index)
 374 {
 375         return find_or_create_page(mapping, index, mapping_gfp_mask(mapping));
 376 }
 377
 378 extern struct page * read_cache_page(struct address_space *mapping,
 379                                 pgoff_t index, filler_t *filler, void *data);
 380 extern struct page * read_cache_page_gfp(struct address_space *mapping,
 381                                 pgoff_t index, gfp_t gfp_mask);
 382 extern int read_cache_pages(struct address_space *mapping,
 383                 struct list_head *pages, filler_t *filler, void *data);
 384
 385 static inline struct page *read_mapping_page(struct address_space *mapping,
 386                                 pgoff_t index, void *data)
 387 {
 388         filler_t *filler = (filler_t *)mapping->a_ops->readpage;
 389         return read_cache_page(mapping, index, filler, data);
 390 }
 391
 392 /*
 393  * Get index of the page with in radix-tree
 394  * (TODO: remove once hugetlb pages will have ->index in PAGE_SIZE)
 395  */
 396 static inline pgoff_t page_to_index(struct page *page)
 397 {
 398         pgoff_t pgoff;
 399
 400         if (likely(!PageTransTail(page)))
 401                 return page->index;
 402
 403         /*
 404          *  We don't initialize ->index for tail pages: calculate based on
 405          *  head page
 406          */
 407         pgoff = compound_head(page)->index;
 408         pgoff += page - compound_head(page);
 409         return pgoff;
 410 }
 411
 412 /*
 413  * Get the offset in PAGE_SIZE.
 414  * (TODO: hugepage should have ->index in PAGE_SIZE)
 415  */
 416 static inline pgoff_t page_to_pgoff(struct page *page)
 417 {
 418         if (unlikely(PageHeadHuge(page)))
 419                 return page->index << compound_order(page);
 420
 421         return page_to_index(page);
 422 }
 423
 424 /*
 425  * Return byte-offset into filesystem object for page.
 426  */
 427 static inline loff_t page_offset(struct page *page)
 428 {
 429         return ((loff_t)page->index) << PAGE_SHIFT;
 430 }
 431
 432 static inline loff_t page_file_offset(struct page *page)
 433 {
 434         return ((loff_t)page_index(page)) << PAGE_SHIFT;
 435 }
 436
 437 extern pgoff_t linear_hugepage_index(struct vm_area_struct *vma,
 438                                      unsigned long address);
 439
 440 static inline pgoff_t linear_page_index(struct vm_area_struct *vma,
 441                                         unsigned long address)
 442 {
 443         pgoff_t pgoff;
 444         if (unlikely(is_vm_hugetlb_page(vma)))
 445                 return linear_hugepage_index(vma, address);
 446         pgoff = (address - vma->vm_start) >> PAGE_SHIFT;
 447         pgoff += vma->vm_pgoff;
 448         return pgoff;
 449 }
 450
 451 extern void __lock_page(struct page *page);
 452 extern int __lock_page_killable(struct page *page);
 453 extern int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
 454                                 unsigned int flags);
 455 extern void unlock_page(struct page *page);
 456
 457 static inline int trylock_page(struct page *page)
 458 {
 459         page = compound_head(page);
 460         return (likely(!test_and_set_bit_lock(PG_locked, &page->flags)));
 461 }
 462
 463 /*
 464  * lock_page may only be called if we have the page's inode pinned.
 465  */
 466 static inline void lock_page(struct page *page)
 467 {
 468         might_sleep();
 469         if (!trylock_page(page))
 470                 __lock_page(page);
 471 }
 472
 473 /*
 474  * lock_page_killable is like lock_page but can be interrupted by fatal
 475  * signals.  It returns 0 if it locked the page and -EINTR if it was
 476  * killed while waiting.
 477  */
 478 static inline int lock_page_killable(struct page *page)
 479 {
 480         might_sleep();
 481         if (!trylock_page(page))
 482                 return __lock_page_killable(page);
 483         return 0;
 484 }
 485
 486 /*
 487  * lock_page_or_retry - Lock the page, unless this would block and the
 488  * caller indicated that it can handle a retry.
 489  *
 490  * Return value and mmap_sem implications depend on flags; see
 491  * __lock_page_or_retry().
 492  */
 493 static inline int lock_page_or_retry(struct page *page, struct mm_struct *mm,
 494                                      unsigned int flags)
 495 {
 496         might_sleep();
 497         return trylock_page(page) || __lock_page_or_retry(page, mm, flags);
 498 }
 499
 500 /*
 501  * This is exported only for wait_on_page_locked/wait_on_page_writeback, etc.,
 502  * and should not be used directly.
 503  */
 504 extern void wait_on_page_bit(struct page *page, int bit_nr);
 505 extern int wait_on_page_bit_killable(struct page *page, int bit_nr);
 506
 507 /*
 508  * Wait for a page to be unlocked.
 509  *
 510  * This must be called with the caller "holding" the page,
 511  * ie with increased "page->count" so that the page won't
 512  * go away during the wait..
 513  */
 514 static inline void wait_on_page_locked(struct page *page)
 515 {
 516         if (PageLocked(page))
 517                 wait_on_page_bit(compound_head(page), PG_locked);
 518 }
 519
 520 static inline int wait_on_page_locked_killable(struct page *page)
 521 {
 522         if (!PageLocked(page))
 523                 return 0;
 524         return wait_on_page_bit_killable(compound_head(page), PG_locked);
 525 }
 526
 527 extern void put_and_wait_on_page_locked(struct page *page);
 528
 529 /*
 530  * Wait for a page to complete writeback
 531  */
 532 static inline void wait_on_page_writeback(struct page *page)
 533 {
 534         if (PageWriteback(page))
 535                 wait_on_page_bit(page, PG_writeback);
 536 }
 537
 538 extern void end_page_writeback(struct page *page);
 539 void wait_for_stable_page(struct page *page);
 540
 541 void page_endio(struct page *page, bool is_write, int err);
 542
 543 /*
 544  * Add an arbitrary waiter to a page's wait queue
 545  */
 546 extern void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter);
 547
 548 /*
 549  * Fault everything in given userspace address range in.
 550  */
 551 static inline int fault_in_pages_writeable(char __user *uaddr, int size)
 552 {
 553         char __user *end = uaddr + size - 1;
 554
 555         if (unlikely(size == 0))
 556                 return 0;
 557
 558         if (unlikely(uaddr > end))
 559                 return -EFAULT;
 560         /*
 561          * Writing zeroes into userspace here is OK, because we know that if
 562          * the zero gets there, we'll be overwriting it.
 563          */
 564         do {
 565                 if (unlikely(__put_user(0, uaddr) != 0))
 566                         return -EFAULT;
 567                 uaddr += PAGE_SIZE;
 568         } while (uaddr <= end);
 569
 570         /* Check whether the range spilled into the next page. */
 571         if (((unsigned long)uaddr & PAGE_MASK) ==
 572                         ((unsigned long)end & PAGE_MASK))
 573                 return __put_user(0, end);
 574
 575         return 0;
 576 }
 577
 578 static inline int fault_in_pages_readable(const char __user *uaddr, int size)
 579 {
 580         volatile char c;
 581         const char __user *end = uaddr + size - 1;
 582
 583         if (unlikely(size == 0))
 584                 return 0;
 585
 586         if (unlikely(uaddr > end))
 587                 return -EFAULT;
 588
 589         do {
 590                 if (unlikely(__get_user(c, uaddr) != 0))
 591                         return -EFAULT;
 592                 uaddr += PAGE_SIZE;
 593         } while (uaddr <= end);
 594
 595         /* Check whether the range spilled into the next page. */
 596         if (((unsigned long)uaddr & PAGE_MASK) ==
 597                         ((unsigned long)end & PAGE_MASK)) {
 598                 return __get_user(c, end);
 599         }
 600
 601         (void)c;
 602         return 0;
 603 }
 604
 605 int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
 606                                 pgoff_t index, gfp_t gfp_mask);
 607 int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
 608                                 pgoff_t index, gfp_t gfp_mask);
 609 extern void delete_from_page_cache(struct page *page);
 610 extern void __delete_from_page_cache(struct page *page, void *shadow);
 611 int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask);
 612 void delete_from_page_cache_batch(struct address_space *mapping,
 613                                   struct pagevec *pvec);
 614
 615 /*
 616  * Like add_to_page_cache_locked, but used to add newly allocated pages:
 617  * the page is new, so we can just run __SetPageLocked() against it.
 618  */
 619 static inline int add_to_page_cache(struct page *page,
 620                 struct address_space *mapping, pgoff_t offset, gfp_t gfp_mask)
 621 {
 622         int error;
 623
 624         __SetPageLocked(page);
 625         error = add_to_page_cache_locked(page, mapping, offset, gfp_mask);
 626         if (unlikely(error))
 627                 __ClearPageLocked(page);
 628         return error;
 629 }
 630
 631 static inline unsigned long dir_pages(struct inode *inode)
 632 {
 633         return (unsigned long)(inode->i_size + PAGE_SIZE - 1) >>
 634                                PAGE_SHIFT;
 635 }
 636
 637 #endif /* _LINUX_PAGEMAP_H */