include/linux/mm_types.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_MM_TYPES_H
   3 #define _LINUX_MM_TYPES_H
   4
   5 #include <linux/mm_types_task.h>
   6
   7 #include <linux/auxvec.h>
   8 #include <linux/list.h>
   9 #include <linux/spinlock.h>
  10 #include <linux/rbtree.h>
  11 #include <linux/rwsem.h>
  12 #include <linux/completion.h>
  13 #include <linux/cpumask.h>
  14 #include <linux/uprobes.h>
  15 #include <linux/page-flags-layout.h>
  16 #include <linux/workqueue.h>
  17 #include <linux/seqlock.h>
  18
  19 #include <asm/mmu.h>
  20
  21 #ifndef AT_VECTOR_SIZE_ARCH
  22 #define AT_VECTOR_SIZE_ARCH 0
  23 #endif
  24 #define AT_VECTOR_SIZE (2*(AT_VECTOR_SIZE_ARCH + AT_VECTOR_SIZE_BASE + 1))
  25
  26 #define INIT_PASID      0
  27
  28 struct address_space;
  29 struct mem_cgroup;
  30
  31 /*
  32  * Each physical page in the system has a struct page associated with
  33  * it to keep track of whatever it is we are using the page for at the
  34  * moment. Note that we have no way to track which tasks are using
  35  * a page, though if it is a pagecache page, rmap structures can tell us
  36  * who is mapping it.
  37  *
  38  * If you allocate the page using alloc_pages(), you can use some of the
  39  * space in struct page for your own purposes.  The five words in the main
  40  * union are available, except for bit 0 of the first word which must be
  41  * kept clear.  Many users use this word to store a pointer to an object
  42  * which is guaranteed to be aligned.  If you use the same storage as
  43  * page->mapping, you must restore it to NULL before freeing the page.
  44  *
  45  * If your page will not be mapped to userspace, you can also use the four
  46  * bytes in the mapcount union, but you must call page_mapcount_reset()
  47  * before freeing it.
  48  *
  49  * If you want to use the refcount field, it must be used in such a way
  50  * that other CPUs temporarily incrementing and then decrementing the
  51  * refcount does not cause problems.  On receiving the page from
  52  * alloc_pages(), the refcount will be positive.
  53  *
  54  * If you allocate pages of order > 0, you can use some of the fields
  55  * in each subpage, but you may need to restore some of their values
  56  * afterwards.
  57  *
  58  * SLUB uses cmpxchg_double() to atomically update its freelist and
  59  * counters.  That requires that freelist & counters be adjacent and
  60  * double-word aligned.  We align all struct pages to double-word
  61  * boundaries, and ensure that 'freelist' is aligned within the
  62  * struct.
  63  */
  64 #ifdef CONFIG_HAVE_ALIGNED_STRUCT_PAGE
  65 #define _struct_page_alignment  __aligned(2 * sizeof(unsigned long))
  66 #else
  67 #define _struct_page_alignment
  68 #endif
  69
  70 struct page {
  71         unsigned long flags;            /* Atomic flags, some possibly
  72                                          * updated asynchronously */
  73         /*
  74          * Five words (20/40 bytes) are available in this union.
  75          * WARNING: bit 0 of the first word is used for PageTail(). That
  76          * means the other users of this union MUST NOT use the bit to
  77          * avoid collision and false-positive PageTail().
  78          */
  79         union {
  80                 struct {        /* Page cache and anonymous pages */
  81                         /**
  82                          * @lru: Pageout list, eg. active_list protected by
  83                          * lruvec->lru_lock.  Sometimes used as a generic list
  84                          * by the page owner.
  85                          */
  86                         struct list_head lru;
  87                         /* See page-flags.h for PAGE_MAPPING_FLAGS */
  88                         struct address_space *mapping;
  89                         pgoff_t index;          /* Our offset within mapping. */
  90                         /**
  91                          * @private: Mapping-private opaque data.
  92                          * Usually used for buffer_heads if PagePrivate.
  93                          * Used for swp_entry_t if PageSwapCache.
  94                          * Indicates order in the buddy system if PageBuddy.
  95                          */
  96                         unsigned long private;
  97                 };
  98                 struct {        /* page_pool used by netstack */
  99                         /**
 100                          * @dma_addr: might require a 64-bit value on
 101                          * 32-bit architectures.
 102                          */
 103                         unsigned long dma_addr[2];
 104                 };
 105                 struct {        /* slab, slob and slub */
 106                         union {
 107                                 struct list_head slab_list;
 108                                 struct {        /* Partial pages */
 109                                         struct page *next;
 110 #ifdef CONFIG_64BIT
 111                                         int pages;      /* Nr of pages left */
 112                                         int pobjects;   /* Approximate count */
 113 #else
 114                                         short int pages;
 115                                         short int pobjects;
 116 #endif
 117                                 };
 118                         };
 119                         struct kmem_cache *slab_cache; /* not slob */
 120                         /* Double-word boundary */
 121                         void *freelist;         /* first free object */
 122                         union {
 123                                 void *s_mem;    /* slab: first object */
 124                                 unsigned long counters;         /* SLUB */
 125                                 struct {                        /* SLUB */
 126                                         unsigned inuse:16;
 127                                         unsigned objects:15;
 128                                         unsigned frozen:1;
 129                                 };
 130                         };
 131                 };
 132                 struct {        /* Tail pages of compound page */
 133                         unsigned long compound_head;    /* Bit zero is set */
 134
 135                         /* First tail page only */
 136                         unsigned char compound_dtor;
 137                         unsigned char compound_order;
 138                         atomic_t compound_mapcount;
 139                         unsigned int compound_nr; /* 1 << compound_order */
 140                 };
 141                 struct {        /* Second tail page of compound page */
 142                         unsigned long _compound_pad_1;  /* compound_head */
 143                         atomic_t hpage_pinned_refcount;
 144                         /* For both global and memcg */
 145                         struct list_head deferred_list;
 146                 };
 147                 struct {        /* Page table pages */
 148                         unsigned long _pt_pad_1;        /* compound_head */
 149                         pgtable_t pmd_huge_pte; /* protected by page->ptl */
 150                         unsigned long _pt_pad_2;        /* mapping */
 151                         union {
 152                                 struct mm_struct *pt_mm; /* x86 pgds only */
 153                                 atomic_t pt_frag_refcount; /* powerpc */
 154                         };
 155 #if ALLOC_SPLIT_PTLOCKS
 156                         spinlock_t *ptl;
 157 #else
 158                         spinlock_t ptl;
 159 #endif
 160                 };
 161                 struct {        /* ZONE_DEVICE pages */
 162                         /** @pgmap: Points to the hosting device page map. */
 163                         struct dev_pagemap *pgmap;
 164                         void *zone_device_data;
 165                         /*
 166                          * ZONE_DEVICE private pages are counted as being
 167                          * mapped so the next 3 words hold the mapping, index,
 168                          * and private fields from the source anonymous or
 169                          * page cache page while the page is migrated to device
 170                          * private memory.
 171                          * ZONE_DEVICE MEMORY_DEVICE_FS_DAX pages also
 172                          * use the mapping, index, and private fields when
 173                          * pmem backed DAX files are mapped.
 174                          */
 175                 };
 176
 177                 /** @rcu_head: You can use this to free a page by RCU. */
 178                 struct rcu_head rcu_head;
 179         };
 180
 181         union {         /* This union is 4 bytes in size. */
 182                 /*
 183                  * If the page can be mapped to userspace, encodes the number
 184                  * of times this page is referenced by a page table.
 185                  */
 186                 atomic_t _mapcount;
 187
 188                 /*
 189                  * If the page is neither PageSlab nor mappable to userspace,
 190                  * the value stored here may help determine what this page
 191                  * is used for.  See page-flags.h for a list of page types
 192                  * which are currently stored here.
 193                  */
 194                 unsigned int page_type;
 195
 196                 unsigned int active;            /* SLAB */
 197                 int units;                      /* SLOB */
 198         };
 199
 200         /* Usage count. *DO NOT USE DIRECTLY*. See page_ref.h */
 201         atomic_t _refcount;
 202
 203 #ifdef CONFIG_MEMCG
 204         unsigned long memcg_data;
 205 #endif
 206
 207         /*
 208          * On machines where all RAM is mapped into kernel address space,
 209          * we can simply calculate the virtual address. On machines with
 210          * highmem some memory is mapped into kernel virtual memory
 211          * dynamically, so we need a place to store that address.
 212          * Note that this field could be 16 bits on x86 ... ;)
 213          *
 214          * Architectures with slow multiplication can define
 215          * WANT_PAGE_VIRTUAL in asm/page.h
 216          */
 217 #if defined(WANT_PAGE_VIRTUAL)
 218         void *virtual;                  /* Kernel virtual address (NULL if
 219                                            not kmapped, ie. highmem) */
 220 #endif /* WANT_PAGE_VIRTUAL */
 221
 222 #ifdef LAST_CPUPID_NOT_IN_PAGE_FLAGS
 223         int _last_cpupid;
 224 #endif
 225 } _struct_page_alignment;
 226
 227 static inline atomic_t *compound_mapcount_ptr(struct page *page)
 228 {
 229         return &page[1].compound_mapcount;
 230 }
 231
 232 static inline atomic_t *compound_pincount_ptr(struct page *page)
 233 {
 234         return &page[2].hpage_pinned_refcount;
 235 }
 236
 237 /*
 238  * Used for sizing the vmemmap region on some architectures
 239  */
 240 #define STRUCT_PAGE_MAX_SHIFT   (order_base_2(sizeof(struct page)))
 241
 242 #define PAGE_FRAG_CACHE_MAX_SIZE        __ALIGN_MASK(32768, ~PAGE_MASK)
 243 #define PAGE_FRAG_CACHE_MAX_ORDER       get_order(PAGE_FRAG_CACHE_MAX_SIZE)
 244
 245 #define page_private(page)              ((page)->private)
 246
 247 static inline void set_page_private(struct page *page, unsigned long private)
 248 {
 249         page->private = private;
 250 }
 251
 252 struct page_frag_cache {
 253         void * va;
 254 #if (PAGE_SIZE < PAGE_FRAG_CACHE_MAX_SIZE)
 255         __u16 offset;
 256         __u16 size;
 257 #else
 258         __u32 offset;
 259 #endif
 260         /* we maintain a pagecount bias, so that we dont dirty cache line
 261          * containing page->_refcount every time we allocate a fragment.
 262          */
 263         unsigned int            pagecnt_bias;
 264         bool pfmemalloc;
 265 };
 266
 267 typedef unsigned long vm_flags_t;
 268
 269 /*
 270  * A region containing a mapping of a non-memory backed file under NOMMU
 271  * conditions.  These are held in a global tree and are pinned by the VMAs that
 272  * map parts of them.
 273  */
 274 struct vm_region {
 275         struct rb_node  vm_rb;          /* link in global region tree */
 276         vm_flags_t      vm_flags;       /* VMA vm_flags */
 277         unsigned long   vm_start;       /* start address of region */
 278         unsigned long   vm_end;         /* region initialised to here */
 279         unsigned long   vm_top;         /* region allocated to here */
 280         unsigned long   vm_pgoff;       /* the offset in vm_file corresponding to vm_start */
 281         struct file     *vm_file;       /* the backing file or NULL */
 282
 283         int             vm_usage;       /* region usage count (access under nommu_region_sem) */
 284         bool            vm_icache_flushed : 1; /* true if the icache has been flushed for
 285                                                 * this region */
 286 };
 287
 288 #ifdef CONFIG_USERFAULTFD
 289 #define NULL_VM_UFFD_CTX ((struct vm_userfaultfd_ctx) { NULL, })
 290 struct vm_userfaultfd_ctx {
 291         struct userfaultfd_ctx *ctx;
 292 };
 293 #else /* CONFIG_USERFAULTFD */
 294 #define NULL_VM_UFFD_CTX ((struct vm_userfaultfd_ctx) {})
 295 struct vm_userfaultfd_ctx {};
 296 #endif /* CONFIG_USERFAULTFD */
 297
 298 /*
 299  * This struct describes a virtual memory area. There is one of these
 300  * per VM-area/task. A VM area is any part of the process virtual memory
 301  * space that has a special rule for the page-fault handlers (ie a shared
 302  * library, the executable area etc).
 303  */
 304 struct vm_area_struct {
 305         /* The first cache line has the info for VMA tree walking. */
 306
 307         unsigned long vm_start;         /* Our start address within vm_mm. */
 308         unsigned long vm_end;           /* The first byte after our end address
 309                                            within vm_mm. */
 310
 311         /* linked list of VM areas per task, sorted by address */
 312         struct vm_area_struct *vm_next, *vm_prev;
 313
 314         struct rb_node vm_rb;
 315
 316         /*
 317          * Largest free memory gap in bytes to the left of this VMA.
 318          * Either between this VMA and vma->vm_prev, or between one of the
 319          * VMAs below us in the VMA rbtree and its ->vm_prev. This helps
 320          * get_unmapped_area find a free area of the right size.
 321          */
 322         unsigned long rb_subtree_gap;
 323
 324         /* Second cache line starts here. */
 325
 326         struct mm_struct *vm_mm;        /* The address space we belong to. */
 327
 328         /*
 329          * Access permissions of this VMA.
 330          * See vmf_insert_mixed_prot() for discussion.
 331          */
 332         pgprot_t vm_page_prot;
 333         unsigned long vm_flags;         /* Flags, see mm.h. */
 334
 335         /*
 336          * For areas with an address space and backing store,
 337          * linkage into the address_space->i_mmap interval tree.
 338          */
 339         struct {
 340                 struct rb_node rb;
 341                 unsigned long rb_subtree_last;
 342         } shared;
 343
 344         /*
 345          * A file's MAP_PRIVATE vma can be in both i_mmap tree and anon_vma
 346          * list, after a COW of one of the file pages.  A MAP_SHARED vma
 347          * can only be in the i_mmap tree.  An anonymous MAP_PRIVATE, stack
 348          * or brk vma (with NULL file) can only be in an anon_vma list.
 349          */
 350         struct list_head anon_vma_chain; /* Serialized by mmap_lock &
 351                                           * page_table_lock */
 352         struct anon_vma *anon_vma;      /* Serialized by page_table_lock */
 353
 354         /* Function pointers to deal with this struct. */
 355         const struct vm_operations_struct *vm_ops;
 356
 357         /* Information about our backing store: */
 358         unsigned long vm_pgoff;         /* Offset (within vm_file) in PAGE_SIZE
 359                                            units */
 360         struct file * vm_file;          /* File we map to (can be NULL). */
 361         void * vm_private_data;         /* was vm_pte (shared mem) */
 362
 363 #ifdef CONFIG_SWAP
 364         atomic_long_t swap_readahead_info;
 365 #endif
 366 #ifndef CONFIG_MMU
 367         struct vm_region *vm_region;    /* NOMMU mapping region */
 368 #endif
 369 #ifdef CONFIG_NUMA
 370         struct mempolicy *vm_policy;    /* NUMA policy for the VMA */
 371 #endif
 372         struct vm_userfaultfd_ctx vm_userfaultfd_ctx;
 373 } __randomize_layout;
 374
 375 struct core_thread {
 376         struct task_struct *task;
 377         struct core_thread *next;
 378 };
 379
 380 struct core_state {
 381         atomic_t nr_threads;
 382         struct core_thread dumper;
 383         struct completion startup;
 384 };
 385
 386 struct kioctx_table;
 387 struct mm_struct {
 388         struct {
 389                 struct vm_area_struct *mmap;            /* list of VMAs */
 390                 struct rb_root mm_rb;
 391                 u64 vmacache_seqnum;                   /* per-thread vmacache */
 392 #ifdef CONFIG_MMU
 393                 unsigned long (*get_unmapped_area) (struct file *filp,
 394                                 unsigned long addr, unsigned long len,
 395                                 unsigned long pgoff, unsigned long flags);
 396 #endif
 397                 unsigned long mmap_base;        /* base of mmap area */
 398                 unsigned long mmap_legacy_base; /* base of mmap area in bottom-up allocations */
 399 #ifdef CONFIG_HAVE_ARCH_COMPAT_MMAP_BASES
 400                 /* Base addresses for compatible mmap() */
 401                 unsigned long mmap_compat_base;
 402                 unsigned long mmap_compat_legacy_base;
 403 #endif
 404                 unsigned long task_size;        /* size of task vm space */
 405                 unsigned long highest_vm_end;   /* highest vma end address */
 406                 pgd_t * pgd;
 407
 408 #ifdef CONFIG_MEMBARRIER
 409                 /**
 410                  * @membarrier_state: Flags controlling membarrier behavior.
 411                  *
 412                  * This field is close to @pgd to hopefully fit in the same
 413                  * cache-line, which needs to be touched by switch_mm().
 414                  */
 415                 atomic_t membarrier_state;
 416 #endif
 417
 418                 /**
 419                  * @mm_users: The number of users including userspace.
 420                  *
 421                  * Use mmget()/mmget_not_zero()/mmput() to modify. When this
 422                  * drops to 0 (i.e. when the task exits and there are no other
 423                  * temporary reference holders), we also release a reference on
 424                  * @mm_count (which may then free the &struct mm_struct if
 425                  * @mm_count also drops to 0).
 426                  */
 427                 atomic_t mm_users;
 428
 429                 /**
 430                  * @mm_count: The number of references to &struct mm_struct
 431                  * (@mm_users count as 1).
 432                  *
 433                  * Use mmgrab()/mmdrop() to modify. When this drops to 0, the
 434                  * &struct mm_struct is freed.
 435                  */
 436                 atomic_t mm_count;
 437
 438 #ifdef CONFIG_MMU
 439                 atomic_long_t pgtables_bytes;   /* PTE page table pages */
 440 #endif
 441                 int map_count;                  /* number of VMAs */
 442
 443                 spinlock_t page_table_lock; /* Protects page tables and some
 444                                              * counters
 445                                              */
 446                 /*
 447                  * With some kernel config, the current mmap_lock's offset
 448                  * inside 'mm_struct' is at 0x120, which is very optimal, as
 449                  * its two hot fields 'count' and 'owner' sit in 2 different
 450                  * cachelines,  and when mmap_lock is highly contended, both
 451                  * of the 2 fields will be accessed frequently, current layout
 452                  * will help to reduce cache bouncing.
 453                  *
 454                  * So please be careful with adding new fields before
 455                  * mmap_lock, which can easily push the 2 fields into one
 456                  * cacheline.
 457                  */
 458                 struct rw_semaphore mmap_lock;
 459
 460                 struct list_head mmlist; /* List of maybe swapped mm's. These
 461                                           * are globally strung together off
 462                                           * init_mm.mmlist, and are protected
 463                                           * by mmlist_lock
 464                                           */
 465
 466
 467                 unsigned long hiwater_rss; /* High-watermark of RSS usage */
 468                 unsigned long hiwater_vm;  /* High-water virtual memory usage */
 469
 470                 unsigned long total_vm;    /* Total pages mapped */
 471                 unsigned long locked_vm;   /* Pages that have PG_mlocked set */
 472                 atomic64_t    pinned_vm;   /* Refcount permanently increased */
 473                 unsigned long data_vm;     /* VM_WRITE & ~VM_SHARED & ~VM_STACK */
 474                 unsigned long exec_vm;     /* VM_EXEC & ~VM_WRITE & ~VM_STACK */
 475                 unsigned long stack_vm;    /* VM_STACK */
 476                 unsigned long def_flags;
 477
 478                 /**
 479                  * @write_protect_seq: Locked when any thread is write
 480                  * protecting pages mapped by this mm to enforce a later COW,
 481                  * for instance during page table copying for fork().
 482                  */
 483                 seqcount_t write_protect_seq;
 484
 485                 spinlock_t arg_lock; /* protect the below fields */
 486
 487                 unsigned long start_code, end_code, start_data, end_data;
 488                 unsigned long start_brk, brk, start_stack;
 489                 unsigned long arg_start, arg_end, env_start, env_end;
 490
 491                 unsigned long saved_auxv[AT_VECTOR_SIZE]; /* for /proc/PID/auxv */
 492
 493                 /*
 494                  * Special counters, in some configurations protected by the
 495                  * page_table_lock, in other configurations by being atomic.
 496                  */
 497                 struct mm_rss_stat rss_stat;
 498
 499                 struct linux_binfmt *binfmt;
 500
 501                 /* Architecture-specific MM context */
 502                 mm_context_t context;
 503
 504                 unsigned long flags; /* Must use atomic bitops to access */
 505
 506                 struct core_state *core_state; /* coredumping support */
 507
 508 #ifdef CONFIG_AIO
 509                 spinlock_t                      ioctx_lock;
 510                 struct kioctx_table __rcu       *ioctx_table;
 511 #endif
 512 #ifdef CONFIG_MEMCG
 513                 /*
 514                  * "owner" points to a task that is regarded as the canonical
 515                  * user/owner of this mm. All of the following must be true in
 516                  * order for it to be changed:
 517                  *
 518                  * current == mm->owner
 519                  * current->mm != mm
 520                  * new_owner->mm == mm
 521                  * new_owner->alloc_lock is held
 522                  */
 523                 struct task_struct __rcu *owner;
 524 #endif
 525                 struct user_namespace *user_ns;
 526
 527                 /* store ref to file /proc/<pid>/exe symlink points to */
 528                 struct file __rcu *exe_file;
 529 #ifdef CONFIG_MMU_NOTIFIER
 530                 struct mmu_notifier_subscriptions *notifier_subscriptions;
 531 #endif
 532 #if defined(CONFIG_TRANSPARENT_HUGEPAGE) && !USE_SPLIT_PMD_PTLOCKS
 533                 pgtable_t pmd_huge_pte; /* protected by page_table_lock */
 534 #endif
 535 #ifdef CONFIG_NUMA_BALANCING
 536                 /*
 537                  * numa_next_scan is the next time that the PTEs will be marked
 538                  * pte_numa. NUMA hinting faults will gather statistics and
 539                  * migrate pages to new nodes if necessary.
 540                  */
 541                 unsigned long numa_next_scan;
 542
 543                 /* Restart point for scanning and setting pte_numa */
 544                 unsigned long numa_scan_offset;
 545
 546                 /* numa_scan_seq prevents two threads setting pte_numa */
 547                 int numa_scan_seq;
 548 #endif
 549                 /*
 550                  * An operation with batched TLB flushing is going on. Anything
 551                  * that can move process memory needs to flush the TLB when
 552                  * moving a PROT_NONE or PROT_NUMA mapped page.
 553                  */
 554                 atomic_t tlb_flush_pending;
 555 #ifdef CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH
 556                 /* See flush_tlb_batched_pending() */
 557                 bool tlb_flush_batched;
 558 #endif
 559                 struct uprobes_state uprobes_state;
 560 #ifdef CONFIG_HUGETLB_PAGE
 561                 atomic_long_t hugetlb_usage;
 562 #endif
 563                 struct work_struct async_put_work;
 564
 565 #ifdef CONFIG_IOMMU_SUPPORT
 566                 u32 pasid;
 567 #endif
 568         } __randomize_layout;
 569
 570         /*
 571          * The mm_cpumask needs to be at the end of mm_struct, because it
 572          * is dynamically sized based on nr_cpu_ids.
 573          */
 574         unsigned long cpu_bitmap[];
 575 };
 576
 577 extern struct mm_struct init_mm;
 578
 579 /* Pointer magic because the dynamic array size confuses some compilers. */
 580 static inline void mm_init_cpumask(struct mm_struct *mm)
 581 {
 582         unsigned long cpu_bitmap = (unsigned long)mm;
 583
 584         cpu_bitmap += offsetof(struct mm_struct, cpu_bitmap);
 585         cpumask_clear((struct cpumask *)cpu_bitmap);
 586 }
 587
 588 /* Future-safe accessor for struct mm_struct's cpu_vm_mask. */
 589 static inline cpumask_t *mm_cpumask(struct mm_struct *mm)
 590 {
 591         return (struct cpumask *)&mm->cpu_bitmap;
 592 }
 593
 594 struct mmu_gather;
 595 extern void tlb_gather_mmu(struct mmu_gather *tlb, struct mm_struct *mm);
 596 extern void tlb_gather_mmu_fullmm(struct mmu_gather *tlb, struct mm_struct *mm);
 597 extern void tlb_finish_mmu(struct mmu_gather *tlb);
 598
 599 static inline void init_tlb_flush_pending(struct mm_struct *mm)
 600 {
 601         atomic_set(&mm->tlb_flush_pending, 0);
 602 }
 603
 604 static inline void inc_tlb_flush_pending(struct mm_struct *mm)
 605 {
 606         atomic_inc(&mm->tlb_flush_pending);
 607         /*
 608          * The only time this value is relevant is when there are indeed pages
 609          * to flush. And we'll only flush pages after changing them, which
 610          * requires the PTL.
 611          *
 612          * So the ordering here is:
 613          *
 614          *      atomic_inc(&mm->tlb_flush_pending);
 615          *      spin_lock(&ptl);
 616          *      ...
 617          *      set_pte_at();
 618          *      spin_unlock(&ptl);
 619          *
 620          *                              spin_lock(&ptl)
 621          *                              mm_tlb_flush_pending();
 622          *                              ....
 623          *                              spin_unlock(&ptl);
 624          *
 625          *      flush_tlb_range();
 626          *      atomic_dec(&mm->tlb_flush_pending);
 627          *
 628          * Where the increment if constrained by the PTL unlock, it thus
 629          * ensures that the increment is visible if the PTE modification is
 630          * visible. After all, if there is no PTE modification, nobody cares
 631          * about TLB flushes either.
 632          *
 633          * This very much relies on users (mm_tlb_flush_pending() and
 634          * mm_tlb_flush_nested()) only caring about _specific_ PTEs (and
 635          * therefore specific PTLs), because with SPLIT_PTE_PTLOCKS and RCpc
 636          * locks (PPC) the unlock of one doesn't order against the lock of
 637          * another PTL.
 638          *
 639          * The decrement is ordered by the flush_tlb_range(), such that
 640          * mm_tlb_flush_pending() will not return false unless all flushes have
 641          * completed.
 642          */
 643 }
 644
 645 static inline void dec_tlb_flush_pending(struct mm_struct *mm)
 646 {
 647         /*
 648          * See inc_tlb_flush_pending().
 649          *
 650          * This cannot be smp_mb__before_atomic() because smp_mb() simply does
 651          * not order against TLB invalidate completion, which is what we need.
 652          *
 653          * Therefore we must rely on tlb_flush_*() to guarantee order.
 654          */
 655         atomic_dec(&mm->tlb_flush_pending);
 656 }
 657
 658 static inline bool mm_tlb_flush_pending(struct mm_struct *mm)
 659 {
 660         /*
 661          * Must be called after having acquired the PTL; orders against that
 662          * PTLs release and therefore ensures that if we observe the modified
 663          * PTE we must also observe the increment from inc_tlb_flush_pending().
 664          *
 665          * That is, it only guarantees to return true if there is a flush
 666          * pending for _this_ PTL.
 667          */
 668         return atomic_read(&mm->tlb_flush_pending);
 669 }
 670
 671 static inline bool mm_tlb_flush_nested(struct mm_struct *mm)
 672 {
 673         /*
 674          * Similar to mm_tlb_flush_pending(), we must have acquired the PTL
 675          * for which there is a TLB flush pending in order to guarantee
 676          * we've seen both that PTE modification and the increment.
 677          *
 678          * (no requirement on actually still holding the PTL, that is irrelevant)
 679          */
 680         return atomic_read(&mm->tlb_flush_pending) > 1;
 681 }
 682
 683 struct vm_fault;
 684
 685 /**
 686  * typedef vm_fault_t - Return type for page fault handlers.
 687  *
 688  * Page fault handlers return a bitmask of %VM_FAULT values.
 689  */
 690 typedef __bitwise unsigned int vm_fault_t;
 691
 692 /**
 693  * enum vm_fault_reason - Page fault handlers return a bitmask of
 694  * these values to tell the core VM what happened when handling the
 695  * fault. Used to decide whether a process gets delivered SIGBUS or
 696  * just gets major/minor fault counters bumped up.
 697  *
 698  * @VM_FAULT_OOM:               Out Of Memory
 699  * @VM_FAULT_SIGBUS:            Bad access
 700  * @VM_FAULT_MAJOR:             Page read from storage
 701  * @VM_FAULT_WRITE:             Special case for get_user_pages
 702  * @VM_FAULT_HWPOISON:          Hit poisoned small page
 703  * @VM_FAULT_HWPOISON_LARGE:    Hit poisoned large page. Index encoded
 704  *                              in upper bits
 705  * @VM_FAULT_SIGSEGV:           segmentation fault
 706  * @VM_FAULT_NOPAGE:            ->fault installed the pte, not return page
 707  * @VM_FAULT_LOCKED:            ->fault locked the returned page
 708  * @VM_FAULT_RETRY:             ->fault blocked, must retry
 709  * @VM_FAULT_FALLBACK:          huge page fault failed, fall back to small
 710  * @VM_FAULT_DONE_COW:          ->fault has fully handled COW
 711  * @VM_FAULT_NEEDDSYNC:         ->fault did not modify page tables and needs
 712  *                              fsync() to complete (for synchronous page faults
 713  *                              in DAX)
 714  * @VM_FAULT_HINDEX_MASK:       mask HINDEX value
 715  *
 716  */
 717 enum vm_fault_reason {
 718         VM_FAULT_OOM            = (__force vm_fault_t)0x000001,
 719         VM_FAULT_SIGBUS         = (__force vm_fault_t)0x000002,
 720         VM_FAULT_MAJOR          = (__force vm_fault_t)0x000004,
 721         VM_FAULT_WRITE          = (__force vm_fault_t)0x000008,
 722         VM_FAULT_HWPOISON       = (__force vm_fault_t)0x000010,
 723         VM_FAULT_HWPOISON_LARGE = (__force vm_fault_t)0x000020,
 724         VM_FAULT_SIGSEGV        = (__force vm_fault_t)0x000040,
 725         VM_FAULT_NOPAGE         = (__force vm_fault_t)0x000100,
 726         VM_FAULT_LOCKED         = (__force vm_fault_t)0x000200,
 727         VM_FAULT_RETRY          = (__force vm_fault_t)0x000400,
 728         VM_FAULT_FALLBACK       = (__force vm_fault_t)0x000800,
 729         VM_FAULT_DONE_COW       = (__force vm_fault_t)0x001000,
 730         VM_FAULT_NEEDDSYNC      = (__force vm_fault_t)0x002000,
 731         VM_FAULT_HINDEX_MASK    = (__force vm_fault_t)0x0f0000,
 732 };
 733
 734 /* Encode hstate index for a hwpoisoned large page */
 735 #define VM_FAULT_SET_HINDEX(x) ((__force vm_fault_t)((x) << 16))
 736 #define VM_FAULT_GET_HINDEX(x) (((__force unsigned int)(x) >> 16) & 0xf)
 737
 738 #define VM_FAULT_ERROR (VM_FAULT_OOM | VM_FAULT_SIGBUS |        \
 739                         VM_FAULT_SIGSEGV | VM_FAULT_HWPOISON |  \
 740                         VM_FAULT_HWPOISON_LARGE | VM_FAULT_FALLBACK)
 741
 742 #define VM_FAULT_RESULT_TRACE \
 743         { VM_FAULT_OOM,                 "OOM" },        \
 744         { VM_FAULT_SIGBUS,              "SIGBUS" },     \
 745         { VM_FAULT_MAJOR,               "MAJOR" },      \
 746         { VM_FAULT_WRITE,               "WRITE" },      \
 747         { VM_FAULT_HWPOISON,            "HWPOISON" },   \
 748         { VM_FAULT_HWPOISON_LARGE,      "HWPOISON_LARGE" },     \
 749         { VM_FAULT_SIGSEGV,             "SIGSEGV" },    \
 750         { VM_FAULT_NOPAGE,              "NOPAGE" },     \
 751         { VM_FAULT_LOCKED,              "LOCKED" },     \
 752         { VM_FAULT_RETRY,               "RETRY" },      \
 753         { VM_FAULT_FALLBACK,            "FALLBACK" },   \
 754         { VM_FAULT_DONE_COW,            "DONE_COW" },   \
 755         { VM_FAULT_NEEDDSYNC,           "NEEDDSYNC" }
 756
 757 struct vm_special_mapping {
 758         const char *name;       /* The name, e.g. "[vdso]". */
 759
 760         /*
 761          * If .fault is not provided, this points to a
 762          * NULL-terminated array of pages that back the special mapping.
 763          *
 764          * This must not be NULL unless .fault is provided.
 765          */
 766         struct page **pages;
 767
 768         /*
 769          * If non-NULL, then this is called to resolve page faults
 770          * on the special mapping.  If used, .pages is not checked.
 771          */
 772         vm_fault_t (*fault)(const struct vm_special_mapping *sm,
 773                                 struct vm_area_struct *vma,
 774                                 struct vm_fault *vmf);
 775
 776         int (*mremap)(const struct vm_special_mapping *sm,
 777                      struct vm_area_struct *new_vma);
 778 };
 779
 780 enum tlb_flush_reason {
 781         TLB_FLUSH_ON_TASK_SWITCH,
 782         TLB_REMOTE_SHOOTDOWN,
 783         TLB_LOCAL_SHOOTDOWN,
 784         TLB_LOCAL_MM_SHOOTDOWN,
 785         TLB_REMOTE_SEND_IPI,
 786         NR_TLB_FLUSH_REASONS,
 787 };
 788
 789  /*
 790   * A swap entry has to fit into a "unsigned long", as the entry is hidden
 791   * in the "index" field of the swapper address space.
 792   */
 793 typedef struct {
 794         unsigned long val;
 795 } swp_entry_t;
 796
 797 #endif /* _LINUX_MM_TYPES_H */