include/linux/mm_types.h

   1 #ifndef _LINUX_MM_TYPES_H
   2 #define _LINUX_MM_TYPES_H
   3
   4 #include <linux/auxvec.h>
   5 #include <linux/types.h>
   6 #include <linux/threads.h>
   7 #include <linux/list.h>
   8 #include <linux/spinlock.h>
   9 #include <linux/rbtree.h>
  10 #include <linux/rwsem.h>
  11 #include <linux/completion.h>
  12 #include <linux/cpumask.h>
  13 #include <linux/uprobes.h>
  14 #include <linux/page-flags-layout.h>
  15 #include <asm/page.h>
  16 #include <asm/mmu.h>
  17
  18 #ifndef AT_VECTOR_SIZE_ARCH
  19 #define AT_VECTOR_SIZE_ARCH 0
  20 #endif
  21 #define AT_VECTOR_SIZE (2*(AT_VECTOR_SIZE_ARCH + AT_VECTOR_SIZE_BASE + 1))
  22
  23 struct address_space;
  24 struct mem_cgroup;
  25
  26 #define USE_SPLIT_PTE_PTLOCKS   (NR_CPUS >= CONFIG_SPLIT_PTLOCK_CPUS)
  27 #define USE_SPLIT_PMD_PTLOCKS   (USE_SPLIT_PTE_PTLOCKS && \
  28                 IS_ENABLED(CONFIG_ARCH_ENABLE_SPLIT_PMD_PTLOCK))
  29 #define ALLOC_SPLIT_PTLOCKS     (SPINLOCK_SIZE > BITS_PER_LONG/8)
  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  * The objects in struct page are organized in double word blocks in
  39  * order to allows us to use atomic double word operations on portions
  40  * of struct page. That is currently only used by slub but the arrangement
  41  * allows the use of atomic double word operations on the flags/mapping
  42  * and lru list pointers also.
  43  */
  44 struct page {
  45         /* First double word block */
  46         unsigned long flags;            /* Atomic flags, some possibly
  47                                          * updated asynchronously */
  48         union {
  49                 struct address_space *mapping;  /* If low bit clear, points to
  50                                                  * inode address_space, or NULL.
  51                                                  * If page mapped as anonymous
  52                                                  * memory, low bit is set, and
  53                                                  * it points to anon_vma object:
  54                                                  * see PAGE_MAPPING_ANON below.
  55                                                  */
  56                 void *s_mem;                    /* slab first object */
  57                 atomic_t compound_mapcount;     /* first tail page */
  58                 /* page_deferred_list().next     -- second tail page */
  59         };
  60
  61         /* Second double word */
  62         struct {
  63                 union {
  64                         pgoff_t index;          /* Our offset within mapping. */
  65                         void *freelist;         /* sl[aou]b first free object */
  66                         /* page_deferred_list().prev    -- second tail page */
  67                 };
  68
  69                 union {
  70 #if defined(CONFIG_HAVE_CMPXCHG_DOUBLE) && \
  71         defined(CONFIG_HAVE_ALIGNED_STRUCT_PAGE)
  72                         /* Used for cmpxchg_double in slub */
  73                         unsigned long counters;
  74 #else
  75                         /*
  76                          * Keep _count separate from slub cmpxchg_double data.
  77                          * As the rest of the double word is protected by
  78                          * slab_lock but _count is not.
  79                          */
  80                         unsigned counters;
  81 #endif
  82
  83                         struct {
  84
  85                                 union {
  86                                         /*
  87                                          * Count of ptes mapped in mms, to show
  88                                          * when page is mapped & limit reverse
  89                                          * map searches.
  90                                          */
  91                                         atomic_t _mapcount;
  92
  93                                         struct { /* SLUB */
  94                                                 unsigned inuse:16;
  95                                                 unsigned objects:15;
  96                                                 unsigned frozen:1;
  97                                         };
  98                                         int units;      /* SLOB */
  99                                 };
 100                                 atomic_t _count;                /* Usage count, see below. */
 101                         };
 102                         unsigned int active;    /* SLAB */
 103                 };
 104         };
 105
 106         /*
 107          * Third double word block
 108          *
 109          * WARNING: bit 0 of the first word encode PageTail(). That means
 110          * the rest users of the storage space MUST NOT use the bit to
 111          * avoid collision and false-positive PageTail().
 112          */
 113         union {
 114                 struct list_head lru;   /* Pageout list, eg. active_list
 115                                          * protected by zone->lru_lock !
 116                                          * Can be used as a generic list
 117                                          * by the page owner.
 118                                          */
 119                 struct {                /* slub per cpu partial pages */
 120                         struct page *next;      /* Next partial slab */
 121 #ifdef CONFIG_64BIT
 122                         int pages;      /* Nr of partial slabs left */
 123                         int pobjects;   /* Approximate # of objects */
 124 #else
 125                         short int pages;
 126                         short int pobjects;
 127 #endif
 128                 };
 129
 130                 struct rcu_head rcu_head;       /* Used by SLAB
 131                                                  * when destroying via RCU
 132                                                  */
 133                 /* Tail pages of compound page */
 134                 struct {
 135                         unsigned long compound_head; /* If bit zero is set */
 136
 137                         /* First tail page only */
 138 #ifdef CONFIG_64BIT
 139                         /*
 140                          * On 64 bit system we have enough space in struct page
 141                          * to encode compound_dtor and compound_order with
 142                          * unsigned int. It can help compiler generate better or
 143                          * smaller code on some archtectures.
 144                          */
 145                         unsigned int compound_dtor;
 146                         unsigned int compound_order;
 147 #else
 148                         unsigned short int compound_dtor;
 149                         unsigned short int compound_order;
 150 #endif
 151                 };
 152
 153 #if defined(CONFIG_TRANSPARENT_HUGEPAGE) && USE_SPLIT_PMD_PTLOCKS
 154                 struct {
 155                         unsigned long __pad;    /* do not overlay pmd_huge_pte
 156                                                  * with compound_head to avoid
 157                                                  * possible bit 0 collision.
 158                                                  */
 159                         pgtable_t pmd_huge_pte; /* protected by page->ptl */
 160                 };
 161 #endif
 162         };
 163
 164         /* Remainder is not double word aligned */
 165         union {
 166                 unsigned long private;          /* Mapping-private opaque data:
 167                                                  * usually used for buffer_heads
 168                                                  * if PagePrivate set; used for
 169                                                  * swp_entry_t if PageSwapCache;
 170                                                  * indicates order in the buddy
 171                                                  * system if PG_buddy is set.
 172                                                  */
 173 #if USE_SPLIT_PTE_PTLOCKS
 174 #if ALLOC_SPLIT_PTLOCKS
 175                 spinlock_t *ptl;
 176 #else
 177                 spinlock_t ptl;
 178 #endif
 179 #endif
 180                 struct kmem_cache *slab_cache;  /* SL[AU]B: Pointer to slab */
 181         };
 182
 183 #ifdef CONFIG_MEMCG
 184         struct mem_cgroup *mem_cgroup;
 185 #endif
 186
 187         /*
 188          * On machines where all RAM is mapped into kernel address space,
 189          * we can simply calculate the virtual address. On machines with
 190          * highmem some memory is mapped into kernel virtual memory
 191          * dynamically, so we need a place to store that address.
 192          * Note that this field could be 16 bits on x86 ... ;)
 193          *
 194          * Architectures with slow multiplication can define
 195          * WANT_PAGE_VIRTUAL in asm/page.h
 196          */
 197 #if defined(WANT_PAGE_VIRTUAL)
 198         void *virtual;                  /* Kernel virtual address (NULL if
 199                                            not kmapped, ie. highmem) */
 200 #endif /* WANT_PAGE_VIRTUAL */
 201
 202 #ifdef CONFIG_KMEMCHECK
 203         /*
 204          * kmemcheck wants to track the status of each byte in a page; this
 205          * is a pointer to such a status block. NULL if not tracked.
 206          */
 207         void *shadow;
 208 #endif
 209
 210 #ifdef LAST_CPUPID_NOT_IN_PAGE_FLAGS
 211         int _last_cpupid;
 212 #endif
 213 }
 214 /*
 215  * The struct page can be forced to be double word aligned so that atomic ops
 216  * on double words work. The SLUB allocator can make use of such a feature.
 217  */
 218 #ifdef CONFIG_HAVE_ALIGNED_STRUCT_PAGE
 219         __aligned(2 * sizeof(unsigned long))
 220 #endif
 221 ;
 222
 223 struct page_frag {
 224         struct page *page;
 225 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
 226         __u32 offset;
 227         __u32 size;
 228 #else
 229         __u16 offset;
 230         __u16 size;
 231 #endif
 232 };
 233
 234 #define PAGE_FRAG_CACHE_MAX_SIZE        __ALIGN_MASK(32768, ~PAGE_MASK)
 235 #define PAGE_FRAG_CACHE_MAX_ORDER       get_order(PAGE_FRAG_CACHE_MAX_SIZE)
 236
 237 struct page_frag_cache {
 238         void * va;
 239 #if (PAGE_SIZE < PAGE_FRAG_CACHE_MAX_SIZE)
 240         __u16 offset;
 241         __u16 size;
 242 #else
 243         __u32 offset;
 244 #endif
 245         /* we maintain a pagecount bias, so that we dont dirty cache line
 246          * containing page->_count every time we allocate a fragment.
 247          */
 248         unsigned int            pagecnt_bias;
 249         bool pfmemalloc;
 250 };
 251
 252 typedef unsigned long vm_flags_t;
 253
 254 /*
 255  * A region containing a mapping of a non-memory backed file under NOMMU
 256  * conditions.  These are held in a global tree and are pinned by the VMAs that
 257  * map parts of them.
 258  */
 259 struct vm_region {
 260         struct rb_node  vm_rb;          /* link in global region tree */
 261         vm_flags_t      vm_flags;       /* VMA vm_flags */
 262         unsigned long   vm_start;       /* start address of region */
 263         unsigned long   vm_end;         /* region initialised to here */
 264         unsigned long   vm_top;         /* region allocated to here */
 265         unsigned long   vm_pgoff;       /* the offset in vm_file corresponding to vm_start */
 266         struct file     *vm_file;       /* the backing file or NULL */
 267
 268         int             vm_usage;       /* region usage count (access under nommu_region_sem) */
 269         bool            vm_icache_flushed : 1; /* true if the icache has been flushed for
 270                                                 * this region */
 271 };
 272
 273 #ifdef CONFIG_USERFAULTFD
 274 #define NULL_VM_UFFD_CTX ((struct vm_userfaultfd_ctx) { NULL, })
 275 struct vm_userfaultfd_ctx {
 276         struct userfaultfd_ctx *ctx;
 277 };
 278 #else /* CONFIG_USERFAULTFD */
 279 #define NULL_VM_UFFD_CTX ((struct vm_userfaultfd_ctx) {})
 280 struct vm_userfaultfd_ctx {};
 281 #endif /* CONFIG_USERFAULTFD */
 282
 283 /*
 284  * This struct defines a memory VMM memory area. There is one of these
 285  * per VM-area/task.  A VM area is any part of the process virtual memory
 286  * space that has a special rule for the page-fault handlers (ie a shared
 287  * library, the executable area etc).
 288  */
 289 struct vm_area_struct {
 290         /* The first cache line has the info for VMA tree walking. */
 291
 292         unsigned long vm_start;         /* Our start address within vm_mm. */
 293         unsigned long vm_end;           /* The first byte after our end address
 294                                            within vm_mm. */
 295
 296         /* linked list of VM areas per task, sorted by address */
 297         struct vm_area_struct *vm_next, *vm_prev;
 298
 299         struct rb_node vm_rb;
 300
 301         /*
 302          * Largest free memory gap in bytes to the left of this VMA.
 303          * Either between this VMA and vma->vm_prev, or between one of the
 304          * VMAs below us in the VMA rbtree and its ->vm_prev. This helps
 305          * get_unmapped_area find a free area of the right size.
 306          */
 307         unsigned long rb_subtree_gap;
 308
 309         /* Second cache line starts here. */
 310
 311         struct mm_struct *vm_mm;        /* The address space we belong to. */
 312         pgprot_t vm_page_prot;          /* Access permissions of this VMA. */
 313         unsigned long vm_flags;         /* Flags, see mm.h. */
 314
 315         /*
 316          * For areas with an address space and backing store,
 317          * linkage into the address_space->i_mmap interval tree.
 318          */
 319         struct {
 320                 struct rb_node rb;
 321                 unsigned long rb_subtree_last;
 322         } shared;
 323
 324         /*
 325          * A file's MAP_PRIVATE vma can be in both i_mmap tree and anon_vma
 326          * list, after a COW of one of the file pages.  A MAP_SHARED vma
 327          * can only be in the i_mmap tree.  An anonymous MAP_PRIVATE, stack
 328          * or brk vma (with NULL file) can only be in an anon_vma list.
 329          */
 330         struct list_head anon_vma_chain; /* Serialized by mmap_sem &
 331                                           * page_table_lock */
 332         struct anon_vma *anon_vma;      /* Serialized by page_table_lock */
 333
 334         /* Function pointers to deal with this struct. */
 335         const struct vm_operations_struct *vm_ops;
 336
 337         /* Information about our backing store: */
 338         unsigned long vm_pgoff;         /* Offset (within vm_file) in PAGE_SIZE
 339                                            units, *not* PAGE_CACHE_SIZE */
 340         struct file * vm_file;          /* File we map to (can be NULL). */
 341         void * vm_private_data;         /* was vm_pte (shared mem) */
 342
 343 #ifndef CONFIG_MMU
 344         struct vm_region *vm_region;    /* NOMMU mapping region */
 345 #endif
 346 #ifdef CONFIG_NUMA
 347         struct mempolicy *vm_policy;    /* NUMA policy for the VMA */
 348 #endif
 349         struct vm_userfaultfd_ctx vm_userfaultfd_ctx;
 350 };
 351
 352 struct core_thread {
 353         struct task_struct *task;
 354         struct core_thread *next;
 355 };
 356
 357 struct core_state {
 358         atomic_t nr_threads;
 359         struct core_thread dumper;
 360         struct completion startup;
 361 };
 362
 363 enum {
 364         MM_FILEPAGES,
 365         MM_ANONPAGES,
 366         MM_SWAPENTS,
 367         NR_MM_COUNTERS
 368 };
 369
 370 #if USE_SPLIT_PTE_PTLOCKS && defined(CONFIG_MMU)
 371 #define SPLIT_RSS_COUNTING
 372 /* per-thread cached information, */
 373 struct task_rss_stat {
 374         int events;     /* for synchronization threshold */
 375         int count[NR_MM_COUNTERS];
 376 };
 377 #endif /* USE_SPLIT_PTE_PTLOCKS */
 378
 379 struct mm_rss_stat {
 380         atomic_long_t count[NR_MM_COUNTERS];
 381 };
 382
 383 struct kioctx_table;
 384 struct mm_struct {
 385         struct vm_area_struct *mmap;            /* list of VMAs */
 386         struct rb_root mm_rb;
 387         u32 vmacache_seqnum;                   /* per-thread vmacache */
 388 #ifdef CONFIG_MMU
 389         unsigned long (*get_unmapped_area) (struct file *filp,
 390                                 unsigned long addr, unsigned long len,
 391                                 unsigned long pgoff, unsigned long flags);
 392 #endif
 393         unsigned long mmap_base;                /* base of mmap area */
 394         unsigned long mmap_legacy_base;         /* base of mmap area in bottom-up allocations */
 395         unsigned long task_size;                /* size of task vm space */
 396         unsigned long highest_vm_end;           /* highest vma end address */
 397         pgd_t * pgd;
 398         atomic_t mm_users;                      /* How many users with user space? */
 399         atomic_t mm_count;                      /* How many references to "struct mm_struct" (users count as 1) */
 400         atomic_long_t nr_ptes;                  /* PTE page table pages */
 401 #if CONFIG_PGTABLE_LEVELS > 2
 402         atomic_long_t nr_pmds;                  /* PMD page table pages */
 403 #endif
 404         int map_count;                          /* number of VMAs */
 405
 406         spinlock_t page_table_lock;             /* Protects page tables and some counters */
 407         struct rw_semaphore mmap_sem;
 408
 409         struct list_head mmlist;                /* List of maybe swapped mm's.  These are globally strung
 410                                                  * together off init_mm.mmlist, and are protected
 411                                                  * by mmlist_lock
 412                                                  */
 413
 414
 415         unsigned long hiwater_rss;      /* High-watermark of RSS usage */
 416         unsigned long hiwater_vm;       /* High-water virtual memory usage */
 417
 418         unsigned long total_vm;         /* Total pages mapped */
 419         unsigned long locked_vm;        /* Pages that have PG_mlocked set */
 420         unsigned long pinned_vm;        /* Refcount permanently increased */
 421         unsigned long shared_vm;        /* Shared pages (files) */
 422         unsigned long exec_vm;          /* VM_EXEC & ~VM_WRITE */
 423         unsigned long stack_vm;         /* VM_GROWSUP/DOWN */
 424         unsigned long def_flags;
 425         unsigned long start_code, end_code, start_data, end_data;
 426         unsigned long start_brk, brk, start_stack;
 427         unsigned long arg_start, arg_end, env_start, env_end;
 428
 429         unsigned long saved_auxv[AT_VECTOR_SIZE]; /* for /proc/PID/auxv */
 430
 431         /*
 432          * Special counters, in some configurations protected by the
 433          * page_table_lock, in other configurations by being atomic.
 434          */
 435         struct mm_rss_stat rss_stat;
 436
 437         struct linux_binfmt *binfmt;
 438
 439         cpumask_var_t cpu_vm_mask_var;
 440
 441         /* Architecture-specific MM context */
 442         mm_context_t context;
 443
 444         unsigned long flags; /* Must use atomic bitops to access the bits */
 445
 446         struct core_state *core_state; /* coredumping support */
 447 #ifdef CONFIG_AIO
 448         spinlock_t                      ioctx_lock;
 449         struct kioctx_table __rcu       *ioctx_table;
 450 #endif
 451 #ifdef CONFIG_MEMCG
 452         /*
 453          * "owner" points to a task that is regarded as the canonical
 454          * user/owner of this mm. All of the following must be true in
 455          * order for it to be changed:
 456          *
 457          * current == mm->owner
 458          * current->mm != mm
 459          * new_owner->mm == mm
 460          * new_owner->alloc_lock is held
 461          */
 462         struct task_struct __rcu *owner;
 463 #endif
 464
 465         /* store ref to file /proc/<pid>/exe symlink points to */
 466         struct file __rcu *exe_file;
 467 #ifdef CONFIG_MMU_NOTIFIER
 468         struct mmu_notifier_mm *mmu_notifier_mm;
 469 #endif
 470 #if defined(CONFIG_TRANSPARENT_HUGEPAGE) && !USE_SPLIT_PMD_PTLOCKS
 471         pgtable_t pmd_huge_pte; /* protected by page_table_lock */
 472 #endif
 473 #ifdef CONFIG_CPUMASK_OFFSTACK
 474         struct cpumask cpumask_allocation;
 475 #endif
 476 #ifdef CONFIG_NUMA_BALANCING
 477         /*
 478          * numa_next_scan is the next time that the PTEs will be marked
 479          * pte_numa. NUMA hinting faults will gather statistics and migrate
 480          * pages to new nodes if necessary.
 481          */
 482         unsigned long numa_next_scan;
 483
 484         /* Restart point for scanning and setting pte_numa */
 485         unsigned long numa_scan_offset;
 486
 487         /* numa_scan_seq prevents two threads setting pte_numa */
 488         int numa_scan_seq;
 489 #endif
 490 #if defined(CONFIG_NUMA_BALANCING) || defined(CONFIG_COMPACTION)
 491         /*
 492          * An operation with batched TLB flushing is going on. Anything that
 493          * can move process memory needs to flush the TLB when moving a
 494          * PROT_NONE or PROT_NUMA mapped page.
 495          */
 496         bool tlb_flush_pending;
 497 #endif
 498         struct uprobes_state uprobes_state;
 499 #ifdef CONFIG_X86_INTEL_MPX
 500         /* address of the bounds directory */
 501         void __user *bd_addr;
 502 #endif
 503 #ifdef CONFIG_HUGETLB_PAGE
 504         atomic_long_t hugetlb_usage;
 505 #endif
 506 };
 507
 508 static inline void mm_init_cpumask(struct mm_struct *mm)
 509 {
 510 #ifdef CONFIG_CPUMASK_OFFSTACK
 511         mm->cpu_vm_mask_var = &mm->cpumask_allocation;
 512 #endif
 513         cpumask_clear(mm->cpu_vm_mask_var);
 514 }
 515
 516 /* Future-safe accessor for struct mm_struct's cpu_vm_mask. */
 517 static inline cpumask_t *mm_cpumask(struct mm_struct *mm)
 518 {
 519         return mm->cpu_vm_mask_var;
 520 }
 521
 522 #if defined(CONFIG_NUMA_BALANCING) || defined(CONFIG_COMPACTION)
 523 /*
 524  * Memory barriers to keep this state in sync are graciously provided by
 525  * the page table locks, outside of which no page table modifications happen.
 526  * The barriers below prevent the compiler from re-ordering the instructions
 527  * around the memory barriers that are already present in the code.
 528  */
 529 static inline bool mm_tlb_flush_pending(struct mm_struct *mm)
 530 {
 531         barrier();
 532         return mm->tlb_flush_pending;
 533 }
 534 static inline void set_tlb_flush_pending(struct mm_struct *mm)
 535 {
 536         mm->tlb_flush_pending = true;
 537
 538         /*
 539          * Guarantee that the tlb_flush_pending store does not leak into the
 540          * critical section updating the page tables
 541          */
 542         smp_mb__before_spinlock();
 543 }
 544 /* Clearing is done after a TLB flush, which also provides a barrier. */
 545 static inline void clear_tlb_flush_pending(struct mm_struct *mm)
 546 {
 547         barrier();
 548         mm->tlb_flush_pending = false;
 549 }
 550 #else
 551 static inline bool mm_tlb_flush_pending(struct mm_struct *mm)
 552 {
 553         return false;
 554 }
 555 static inline void set_tlb_flush_pending(struct mm_struct *mm)
 556 {
 557 }
 558 static inline void clear_tlb_flush_pending(struct mm_struct *mm)
 559 {
 560 }
 561 #endif
 562
 563 struct vm_special_mapping
 564 {
 565         const char *name;
 566         struct page **pages;
 567 };
 568
 569 enum tlb_flush_reason {
 570         TLB_FLUSH_ON_TASK_SWITCH,
 571         TLB_REMOTE_SHOOTDOWN,
 572         TLB_LOCAL_SHOOTDOWN,
 573         TLB_LOCAL_MM_SHOOTDOWN,
 574         TLB_REMOTE_SEND_IPI,
 575         NR_TLB_FLUSH_REASONS,
 576 };
 577
 578  /*
 579   * A swap entry has to fit into a "unsigned long", as the entry is hidden
 580   * in the "index" field of the swapper address space.
 581   */
 582 typedef struct {
 583         unsigned long val;
 584 } swp_entry_t;
 585
 586 #endif /* _LINUX_MM_TYPES_H */