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         };
 114
 115         /* Remainder is not double word aligned */
 116         union {
 117                 unsigned long private;          /* Mapping-private opaque data:
 118                                                  * usually used for buffer_heads
 119                                                  * if PagePrivate set; used for
 120                                                  * swp_entry_t if PageSwapCache;
 121                                                  * indicates order in the buddy
 122                                                  * system if PG_buddy is set.
 123                                                  */
 124 #if USE_SPLIT_PTLOCKS
 125                 spinlock_t ptl;
 126 #endif
 127                 struct kmem_cache *slab;        /* SLUB: Pointer to slab */
 128                 struct page *first_page;        /* Compound tail pages */
 129         };
 130
 131         /*
 132          * On machines where all RAM is mapped into kernel address space,
 133          * we can simply calculate the virtual address. On machines with
 134          * highmem some memory is mapped into kernel virtual memory
 135          * dynamically, so we need a place to store that address.
 136          * Note that this field could be 16 bits on x86 ... ;)
 137          *
 138          * Architectures with slow multiplication can define
 139          * WANT_PAGE_VIRTUAL in asm/page.h
 140          */
 141 #if defined(WANT_PAGE_VIRTUAL)
 142         void *virtual;                  /* Kernel virtual address (NULL if
 143                                            not kmapped, ie. highmem) */
 144 #endif /* WANT_PAGE_VIRTUAL */
 145 #ifdef CONFIG_WANT_PAGE_DEBUG_FLAGS
 146         unsigned long debug_flags;      /* Use atomic bitops on this */
 147 #endif
 148
 149 #ifdef CONFIG_KMEMCHECK
 150         /*
 151          * kmemcheck wants to track the status of each byte in a page; this
 152          * is a pointer to such a status block. NULL if not tracked.
 153          */
 154         void *shadow;
 155 #endif
 156 }
 157 /*
 158  * The struct page can be forced to be double word aligned so that atomic ops
 159  * on double words work. The SLUB allocator can make use of such a feature.
 160  */
 161 #ifdef CONFIG_HAVE_ALIGNED_STRUCT_PAGE
 162         __aligned(2 * sizeof(unsigned long))
 163 #endif
 164 ;
 165
 166 struct page_frag {
 167         struct page *page;
 168 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
 169         __u32 offset;
 170         __u32 size;
 171 #else
 172         __u16 offset;
 173         __u16 size;
 174 #endif
 175 };
 176
 177 typedef unsigned long __nocast vm_flags_t;
 178
 179 /*
 180  * A region containing a mapping of a non-memory backed file under NOMMU
 181  * conditions.  These are held in a global tree and are pinned by the VMAs that
 182  * map parts of them.
 183  */
 184 struct vm_region {
 185         struct rb_node  vm_rb;          /* link in global region tree */
 186         vm_flags_t      vm_flags;       /* VMA vm_flags */
 187         unsigned long   vm_start;       /* start address of region */
 188         unsigned long   vm_end;         /* region initialised to here */
 189         unsigned long   vm_top;         /* region allocated to here */
 190         unsigned long   vm_pgoff;       /* the offset in vm_file corresponding to vm_start */
 191         struct file     *vm_file;       /* the backing file or NULL */
 192
 193         int             vm_usage;       /* region usage count (access under nommu_region_sem) */
 194         bool            vm_icache_flushed : 1; /* true if the icache has been flushed for
 195                                                 * this region */
 196 };
 197
 198 /*
 199  * This struct defines a memory VMM memory area. There is one of these
 200  * per VM-area/task.  A VM area is any part of the process virtual memory
 201  * space that has a special rule for the page-fault handlers (ie a shared
 202  * library, the executable area etc).
 203  */
 204 struct vm_area_struct {
 205         struct mm_struct * vm_mm;       /* The address space we belong to. */
 206         unsigned long vm_start;         /* Our start address within vm_mm. */
 207         unsigned long vm_end;           /* The first byte after our end address
 208                                            within vm_mm. */
 209
 210         /* linked list of VM areas per task, sorted by address */
 211         struct vm_area_struct *vm_next, *vm_prev;
 212
 213         pgprot_t vm_page_prot;          /* Access permissions of this VMA. */
 214         unsigned long vm_flags;         /* Flags, see mm.h. */
 215
 216         struct rb_node vm_rb;
 217
 218         /*
 219          * For areas with an address space and backing store,
 220          * linkage into the address_space->i_mmap prio tree, or
 221          * linkage to the list of like vmas hanging off its node, or
 222          * linkage of vma in the address_space->i_mmap_nonlinear list.
 223          */
 224         union {
 225                 struct {
 226                         struct list_head list;
 227                         void *parent;   /* aligns with prio_tree_node parent */
 228                         struct vm_area_struct *head;
 229                 } vm_set;
 230
 231                 struct raw_prio_tree_node prio_tree_node;
 232         } shared;
 233
 234         /*
 235          * A file's MAP_PRIVATE vma can be in both i_mmap tree and anon_vma
 236          * list, after a COW of one of the file pages.  A MAP_SHARED vma
 237          * can only be in the i_mmap tree.  An anonymous MAP_PRIVATE, stack
 238          * or brk vma (with NULL file) can only be in an anon_vma list.
 239          */
 240         struct list_head anon_vma_chain; /* Serialized by mmap_sem &
 241                                           * page_table_lock */
 242         struct anon_vma *anon_vma;      /* Serialized by page_table_lock */
 243
 244         /* Function pointers to deal with this struct. */
 245         const struct vm_operations_struct *vm_ops;
 246
 247         /* Information about our backing store: */
 248         unsigned long vm_pgoff;         /* Offset (within vm_file) in PAGE_SIZE
 249                                            units, *not* PAGE_CACHE_SIZE */
 250         struct file * vm_file;          /* File we map to (can be NULL). */
 251         void * vm_private_data;         /* was vm_pte (shared mem) */
 252
 253 #ifndef CONFIG_MMU
 254         struct vm_region *vm_region;    /* NOMMU mapping region */
 255 #endif
 256 #ifdef CONFIG_NUMA
 257         struct mempolicy *vm_policy;    /* NUMA policy for the VMA */
 258 #endif
 259 };
 260
 261 struct core_thread {
 262         struct task_struct *task;
 263         struct core_thread *next;
 264 };
 265
 266 struct core_state {
 267         atomic_t nr_threads;
 268         struct core_thread dumper;
 269         struct completion startup;
 270 };
 271
 272 enum {
 273         MM_FILEPAGES,
 274         MM_ANONPAGES,
 275         MM_SWAPENTS,
 276         NR_MM_COUNTERS
 277 };
 278
 279 #if USE_SPLIT_PTLOCKS && defined(CONFIG_MMU)
 280 #define SPLIT_RSS_COUNTING
 281 /* per-thread cached information, */
 282 struct task_rss_stat {
 283         int events;     /* for synchronization threshold */
 284         int count[NR_MM_COUNTERS];
 285 };
 286 #endif /* USE_SPLIT_PTLOCKS */
 287
 288 struct mm_rss_stat {
 289         atomic_long_t count[NR_MM_COUNTERS];
 290 };
 291
 292 struct mm_struct {
 293         struct vm_area_struct * mmap;           /* list of VMAs */
 294         struct rb_root mm_rb;
 295         struct vm_area_struct * mmap_cache;     /* last find_vma result */
 296 #ifdef CONFIG_MMU
 297         unsigned long (*get_unmapped_area) (struct file *filp,
 298                                 unsigned long addr, unsigned long len,
 299                                 unsigned long pgoff, unsigned long flags);
 300         void (*unmap_area) (struct mm_struct *mm, unsigned long addr);
 301 #endif
 302         unsigned long mmap_base;                /* base of mmap area */
 303         unsigned long task_size;                /* size of task vm space */
 304         unsigned long cached_hole_size;         /* if non-zero, the largest hole below free_area_cache */
 305         unsigned long free_area_cache;          /* first hole of size cached_hole_size or larger */
 306         pgd_t * pgd;
 307         atomic_t mm_users;                      /* How many users with user space? */
 308         atomic_t mm_count;                      /* How many references to "struct mm_struct" (users count as 1) */
 309         int map_count;                          /* number of VMAs */
 310
 311         spinlock_t page_table_lock;             /* Protects page tables and some counters */
 312         struct rw_semaphore mmap_sem;
 313
 314         struct list_head mmlist;                /* List of maybe swapped mm's.  These are globally strung
 315                                                  * together off init_mm.mmlist, and are protected
 316                                                  * by mmlist_lock
 317                                                  */
 318
 319
 320         unsigned long hiwater_rss;      /* High-watermark of RSS usage */
 321         unsigned long hiwater_vm;       /* High-water virtual memory usage */
 322
 323         unsigned long total_vm;         /* Total pages mapped */
 324         unsigned long locked_vm;        /* Pages that have PG_mlocked set */
 325         unsigned long pinned_vm;        /* Refcount permanently increased */
 326         unsigned long shared_vm;        /* Shared pages (files) */
 327         unsigned long exec_vm;          /* VM_EXEC & ~VM_WRITE */
 328         unsigned long stack_vm;         /* VM_GROWSUP/DOWN */
 329         unsigned long reserved_vm;      /* VM_RESERVED|VM_IO pages */
 330         unsigned long def_flags;
 331         unsigned long nr_ptes;          /* Page table pages */
 332         unsigned long start_code, end_code, start_data, end_data;
 333         unsigned long start_brk, brk, start_stack;
 334         unsigned long arg_start, arg_end, env_start, env_end;
 335
 336         unsigned long saved_auxv[AT_VECTOR_SIZE]; /* for /proc/PID/auxv */
 337
 338         /*
 339          * Special counters, in some configurations protected by the
 340          * page_table_lock, in other configurations by being atomic.
 341          */
 342         struct mm_rss_stat rss_stat;
 343
 344         struct linux_binfmt *binfmt;
 345
 346         cpumask_var_t cpu_vm_mask_var;
 347
 348         /* Architecture-specific MM context */
 349         mm_context_t context;
 350
 351         unsigned long flags; /* Must use atomic bitops to access the bits */
 352
 353         struct core_state *core_state; /* coredumping support */
 354 #ifdef CONFIG_AIO
 355         spinlock_t              ioctx_lock;
 356         struct hlist_head       ioctx_list;
 357 #endif
 358 #ifdef CONFIG_MM_OWNER
 359         /*
 360          * "owner" points to a task that is regarded as the canonical
 361          * user/owner of this mm. All of the following must be true in
 362          * order for it to be changed:
 363          *
 364          * current == mm->owner
 365          * current->mm != mm
 366          * new_owner->mm == mm
 367          * new_owner->alloc_lock is held
 368          */
 369         struct task_struct __rcu *owner;
 370 #endif
 371
 372         /* store ref to file /proc/<pid>/exe symlink points to */
 373         struct file *exe_file;
 374         unsigned long num_exe_file_vmas;
 375 #ifdef CONFIG_MMU_NOTIFIER
 376         struct mmu_notifier_mm *mmu_notifier_mm;
 377 #endif
 378 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 379         pgtable_t pmd_huge_pte; /* protected by page_table_lock */
 380 #endif
 381 #ifdef CONFIG_CPUMASK_OFFSTACK
 382         struct cpumask cpumask_allocation;
 383 #endif
 384         struct uprobes_state uprobes_state;
 385 };
 386
 387 static inline void mm_init_cpumask(struct mm_struct *mm)
 388 {
 389 #ifdef CONFIG_CPUMASK_OFFSTACK
 390         mm->cpu_vm_mask_var = &mm->cpumask_allocation;
 391 #endif
 392 }
 393
 394 /* Future-safe accessor for struct mm_struct's cpu_vm_mask. */
 395 static inline cpumask_t *mm_cpumask(struct mm_struct *mm)
 396 {
 397         return mm->cpu_vm_mask_var;
 398 }
 399
 400 #endif /* _LINUX_MM_TYPES_H */