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/prio_tree.h>
  10 #include <linux/rbtree.h>
  11 #include <linux/rwsem.h>
  12 #include <linux/completion.h>
  13 #include <linux/cpumask.h>
  14 #include <linux/page-debug-flags.h>
  15 #include <linux/uprobes.h>
  16 #include <asm/page.h>
  17 #include <asm/mmu.h>
  18
  19 #ifndef AT_VECTOR_SIZE_ARCH
  20 #define AT_VECTOR_SIZE_ARCH 0
  21 #endif
  22 #define AT_VECTOR_SIZE (2*(AT_VECTOR_SIZE_ARCH + AT_VECTOR_SIZE_BASE + 1))
  23
  24 struct address_space;
  25
  26 #define USE_SPLIT_PTLOCKS       (NR_CPUS >= CONFIG_SPLIT_PTLOCK_CPUS)
  27
  28 /*
  29  * Each physical page in the system has a struct page associated with
  30  * it to keep track of whatever it is we are using the page for at the
  31  * moment. Note that we have no way to track which tasks are using
  32  * a page, though if it is a pagecache page, rmap structures can tell us
  33  * who is mapping it.
  34  *
  35  * The objects in struct page are organized in double word blocks in
  36  * order to allows us to use atomic double word operations on portions
  37  * of struct page. That is currently only used by slub but the arrangement
  38  * allows the use of atomic double word operations on the flags/mapping
  39  * and lru list pointers also.
  40  */
  41 struct page {
  42         /* First double word block */
  43         unsigned long flags;            /* Atomic flags, some possibly
  44                                          * updated asynchronously */
  45         struct address_space *mapping;  /* If low bit clear, points to
  46                                          * inode address_space, or NULL.
  47                                          * If page mapped as anonymous
  48                                          * memory, low bit is set, and
  49                                          * it points to anon_vma object:
  50                                          * see PAGE_MAPPING_ANON below.
  51                                          */
  52         /* Second double word */
  53         struct {
  54                 union {
  55                         pgoff_t index;          /* Our offset within mapping. */
  56                         void *freelist;         /* slub/slob first free object */
  57                 };
  58
  59                 union {
  60                         /* Used for cmpxchg_double in slub */
  61                         unsigned long counters;
  62
  63                         struct {
  64
  65                                 union {
  66                                         /*
  67                                          * Count of ptes mapped in
  68                                          * mms, to show when page is
  69                                          * mapped & limit reverse map
  70                                          * searches.
  71                                          *
  72                                          * Used also for tail pages
  73                                          * refcounting instead of
  74                                          * _count. Tail pages cannot
  75                                          * be mapped and keeping the
  76                                          * tail page _count zero at
  77                                          * all times guarantees
  78                                          * get_page_unless_zero() will
  79                                          * never succeed on tail
  80                                          * pages.
  81                                          */
  82                                         atomic_t _mapcount;
  83
  84                                         struct { /* SLUB */
  85                                                 unsigned inuse:16;
  86                                                 unsigned objects:15;
  87                                                 unsigned frozen:1;
  88                                         };
  89                                         int units;      /* SLOB */
  90                                 };
  91                                 atomic_t _count;                /* Usage count, see below. */
  92                         };
  93                 };
  94         };
  95
  96         /* Third double word block */
  97         union {
  98                 struct list_head lru;   /* Pageout list, eg. active_list
  99                                          * protected by zone->lru_lock !
 100                                          */
 101                 struct {                /* slub per cpu partial pages */
 102                         struct page *next;      /* Next partial slab */
 103 #ifdef CONFIG_64BIT
 104                         int pages;      /* Nr of partial slabs left */
 105                         int pobjects;   /* Approximate # of objects */
 106 #else
 107                         short int pages;
 108                         short int pobjects;
 109 #endif
 110                 };
 111
 112                 struct list_head list;  /* slobs list of pages */
 113                 struct {                /* slab fields */
 114                         struct kmem_cache *slab_cache;
 115                         struct slab *slab_page;
 116                 };
 117         };
 118
 119         /* Remainder is not double word aligned */
 120         union {
 121                 unsigned long private;          /* Mapping-private opaque data:
 122                                                  * usually used for buffer_heads
 123                                                  * if PagePrivate set; used for
 124                                                  * swp_entry_t if PageSwapCache;
 125                                                  * indicates order in the buddy
 126                                                  * system if PG_buddy is set.
 127                                                  */
 128 #if USE_SPLIT_PTLOCKS
 129                 spinlock_t ptl;
 130 #endif
 131                 struct kmem_cache *slab;        /* SLUB: Pointer to slab */
 132                 struct page *first_page;        /* Compound tail pages */
 133         };
 134
 135         /*
 136          * On machines where all RAM is mapped into kernel address space,
 137          * we can simply calculate the virtual address. On machines with
 138          * highmem some memory is mapped into kernel virtual memory
 139          * dynamically, so we need a place to store that address.
 140          * Note that this field could be 16 bits on x86 ... ;)
 141          *
 142          * Architectures with slow multiplication can define
 143          * WANT_PAGE_VIRTUAL in asm/page.h
 144          */
 145 #if defined(WANT_PAGE_VIRTUAL)
 146         void *virtual;                  /* Kernel virtual address (NULL if
 147                                            not kmapped, ie. highmem) */
 148 #endif /* WANT_PAGE_VIRTUAL */
 149 #ifdef CONFIG_WANT_PAGE_DEBUG_FLAGS
 150         unsigned long debug_flags;      /* Use atomic bitops on this */
 151 #endif
 152
 153 #ifdef CONFIG_KMEMCHECK
 154         /*
 155          * kmemcheck wants to track the status of each byte in a page; this
 156          * is a pointer to such a status block. NULL if not tracked.
 157          */
 158         void *shadow;
 159 #endif
 160 }
 161 /*
 162  * The struct page can be forced to be double word aligned so that atomic ops
 163  * on double words work. The SLUB allocator can make use of such a feature.
 164  */
 165 #ifdef CONFIG_HAVE_ALIGNED_STRUCT_PAGE
 166         __aligned(2 * sizeof(unsigned long))
 167 #endif
 168 ;
 169
 170 struct page_frag {
 171         struct page *page;
 172 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
 173         __u32 offset;
 174         __u32 size;
 175 #else
 176         __u16 offset;
 177         __u16 size;
 178 #endif
 179 };
 180
 181 typedef unsigned long __nocast vm_flags_t;
 182
 183 /*
 184  * A region containing a mapping of a non-memory backed file under NOMMU
 185  * conditions.  These are held in a global tree and are pinned by the VMAs that
 186  * map parts of them.
 187  */
 188 struct vm_region {
 189         struct rb_node  vm_rb;          /* link in global region tree */
 190         vm_flags_t      vm_flags;       /* VMA vm_flags */
 191         unsigned long   vm_start;       /* start address of region */
 192         unsigned long   vm_end;         /* region initialised to here */
 193         unsigned long   vm_top;         /* region allocated to here */
 194         unsigned long   vm_pgoff;       /* the offset in vm_file corresponding to vm_start */
 195         struct file     *vm_file;       /* the backing file or NULL */
 196
 197         int             vm_usage;       /* region usage count (access under nommu_region_sem) */
 198         bool            vm_icache_flushed : 1; /* true if the icache has been flushed for
 199                                                 * this region */
 200 };
 201
 202 /*
 203  * This struct defines a memory VMM memory area. There is one of these
 204  * per VM-area/task.  A VM area is any part of the process virtual memory
 205  * space that has a special rule for the page-fault handlers (ie a shared
 206  * library, the executable area etc).
 207  */
 208 struct vm_area_struct {
 209         struct mm_struct * vm_mm;       /* The address space we belong to. */
 210         unsigned long vm_start;         /* Our start address within vm_mm. */
 211         unsigned long vm_end;           /* The first byte after our end address
 212                                            within vm_mm. */
 213
 214         /* linked list of VM areas per task, sorted by address */
 215         struct vm_area_struct *vm_next, *vm_prev;
 216
 217         pgprot_t vm_page_prot;          /* Access permissions of this VMA. */
 218         unsigned long vm_flags;         /* Flags, see mm.h. */
 219
 220         struct rb_node vm_rb;
 221
 222         /*
 223          * For areas with an address space and backing store,
 224          * linkage into the address_space->i_mmap prio tree, or
 225          * linkage to the list of like vmas hanging off its node, or
 226          * linkage of vma in the address_space->i_mmap_nonlinear list.
 227          */
 228         union {
 229                 struct {
 230                         struct list_head list;
 231                         void *parent;   /* aligns with prio_tree_node parent */
 232                         struct vm_area_struct *head;
 233                 } vm_set;
 234
 235                 struct raw_prio_tree_node prio_tree_node;
 236         } shared;
 237
 238         /*
 239          * A file's MAP_PRIVATE vma can be in both i_mmap tree and anon_vma
 240          * list, after a COW of one of the file pages.  A MAP_SHARED vma
 241          * can only be in the i_mmap tree.  An anonymous MAP_PRIVATE, stack
 242          * or brk vma (with NULL file) can only be in an anon_vma list.
 243          */
 244         struct list_head anon_vma_chain; /* Serialized by mmap_sem &
 245                                           * page_table_lock */
 246         struct anon_vma *anon_vma;      /* Serialized by page_table_lock */
 247
 248         /* Function pointers to deal with this struct. */
 249         const struct vm_operations_struct *vm_ops;
 250
 251         /* Information about our backing store: */
 252         unsigned long vm_pgoff;         /* Offset (within vm_file) in PAGE_SIZE
 253                                            units, *not* PAGE_CACHE_SIZE */
 254         struct file * vm_file;          /* File we map to (can be NULL). */
 255         void * vm_private_data;         /* was vm_pte (shared mem) */
 256
 257 #ifndef CONFIG_MMU
 258         struct vm_region *vm_region;    /* NOMMU mapping region */
 259 #endif
 260 #ifdef CONFIG_NUMA
 261         struct mempolicy *vm_policy;    /* NUMA policy for the VMA */
 262 #endif
 263 };
 264
 265 struct core_thread {
 266         struct task_struct *task;
 267         struct core_thread *next;
 268 };
 269
 270 struct core_state {
 271         atomic_t nr_threads;
 272         struct core_thread dumper;
 273         struct completion startup;
 274 };
 275
 276 enum {
 277         MM_FILEPAGES,
 278         MM_ANONPAGES,
 279         MM_SWAPENTS,
 280         NR_MM_COUNTERS
 281 };
 282
 283 #if USE_SPLIT_PTLOCKS && defined(CONFIG_MMU)
 284 #define SPLIT_RSS_COUNTING
 285 /* per-thread cached information, */
 286 struct task_rss_stat {
 287         int events;     /* for synchronization threshold */
 288         int count[NR_MM_COUNTERS];
 289 };
 290 #endif /* USE_SPLIT_PTLOCKS */
 291
 292 struct mm_rss_stat {
 293         atomic_long_t count[NR_MM_COUNTERS];
 294 };
 295
 296 struct mm_struct {
 297         struct vm_area_struct * mmap;           /* list of VMAs */
 298         struct rb_root mm_rb;
 299         struct vm_area_struct * mmap_cache;     /* last find_vma result */
 300 #ifdef CONFIG_MMU
 301         unsigned long (*get_unmapped_area) (struct file *filp,
 302                                 unsigned long addr, unsigned long len,
 303                                 unsigned long pgoff, unsigned long flags);
 304         void (*unmap_area) (struct mm_struct *mm, unsigned long addr);
 305 #endif
 306         unsigned long mmap_base;                /* base of mmap area */
 307         unsigned long task_size;                /* size of task vm space */
 308         unsigned long cached_hole_size;         /* if non-zero, the largest hole below free_area_cache */
 309         unsigned long free_area_cache;          /* first hole of size cached_hole_size or larger */
 310         pgd_t * pgd;
 311         atomic_t mm_users;                      /* How many users with user space? */
 312         atomic_t mm_count;                      /* How many references to "struct mm_struct" (users count as 1) */
 313         int map_count;                          /* number of VMAs */
 314
 315         spinlock_t page_table_lock;             /* Protects page tables and some counters */
 316         struct rw_semaphore mmap_sem;
 317
 318         struct list_head mmlist;                /* List of maybe swapped mm's.  These are globally strung
 319                                                  * together off init_mm.mmlist, and are protected
 320                                                  * by mmlist_lock
 321                                                  */
 322
 323
 324         unsigned long hiwater_rss;      /* High-watermark of RSS usage */
 325         unsigned long hiwater_vm;       /* High-water virtual memory usage */
 326
 327         unsigned long total_vm;         /* Total pages mapped */
 328         unsigned long locked_vm;        /* Pages that have PG_mlocked set */
 329         unsigned long pinned_vm;        /* Refcount permanently increased */
 330         unsigned long shared_vm;        /* Shared pages (files) */
 331         unsigned long exec_vm;          /* VM_EXEC & ~VM_WRITE */
 332         unsigned long stack_vm;         /* VM_GROWSUP/DOWN */
 333         unsigned long reserved_vm;      /* VM_RESERVED|VM_IO pages */
 334         unsigned long def_flags;
 335         unsigned long nr_ptes;          /* Page table pages */
 336         unsigned long start_code, end_code, start_data, end_data;
 337         unsigned long start_brk, brk, start_stack;
 338         unsigned long arg_start, arg_end, env_start, env_end;
 339
 340         unsigned long saved_auxv[AT_VECTOR_SIZE]; /* for /proc/PID/auxv */
 341
 342         /*
 343          * Special counters, in some configurations protected by the
 344          * page_table_lock, in other configurations by being atomic.
 345          */
 346         struct mm_rss_stat rss_stat;
 347
 348         struct linux_binfmt *binfmt;
 349
 350         cpumask_var_t cpu_vm_mask_var;
 351
 352         /* Architecture-specific MM context */
 353         mm_context_t context;
 354
 355         unsigned long flags; /* Must use atomic bitops to access the bits */
 356
 357         struct core_state *core_state; /* coredumping support */
 358 #ifdef CONFIG_AIO
 359         spinlock_t              ioctx_lock;
 360         struct hlist_head       ioctx_list;
 361 #endif
 362 #ifdef CONFIG_MM_OWNER
 363         /*
 364          * "owner" points to a task that is regarded as the canonical
 365          * user/owner of this mm. All of the following must be true in
 366          * order for it to be changed:
 367          *
 368          * current == mm->owner
 369          * current->mm != mm
 370          * new_owner->mm == mm
 371          * new_owner->alloc_lock is held
 372          */
 373         struct task_struct __rcu *owner;
 374 #endif
 375
 376         /* store ref to file /proc/<pid>/exe symlink points to */
 377         struct file *exe_file;
 378         unsigned long num_exe_file_vmas;
 379 #ifdef CONFIG_MMU_NOTIFIER
 380         struct mmu_notifier_mm *mmu_notifier_mm;
 381 #endif
 382 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 383         pgtable_t pmd_huge_pte; /* protected by page_table_lock */
 384 #endif
 385 #ifdef CONFIG_CPUMASK_OFFSTACK
 386         struct cpumask cpumask_allocation;
 387 #endif
 388         struct uprobes_state uprobes_state;
 389 };
 390
 391 static inline void mm_init_cpumask(struct mm_struct *mm)
 392 {
 393 #ifdef CONFIG_CPUMASK_OFFSTACK
 394         mm->cpu_vm_mask_var = &mm->cpumask_allocation;
 395 #endif
 396 }
 397
 398 /* Future-safe accessor for struct mm_struct's cpu_vm_mask. */
 399 static inline cpumask_t *mm_cpumask(struct mm_struct *mm)
 400 {
 401         return mm->cpu_vm_mask_var;
 402 }
 403
 404 #endif /* _LINUX_MM_TYPES_H */