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