[mirror_ubuntu-zesty-kernel.git] / include / linux / mm_types.h

#ifndef _LINUX_MM_TYPES_H
#define _LINUX_MM_TYPES_H

#include <linux/auxvec.h>
#include <linux/types.h>
#include <linux/threads.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/prio_tree.h>
#include <linux/rbtree.h>
#include <linux/rwsem.h>
#include <linux/completion.h>
#include <linux/cpumask.h>
#include <asm/page.h>
#include <asm/mmu.h>

#ifndef AT_VECTOR_SIZE_ARCH
#define AT_VECTOR_SIZE_ARCH 0
#endif
#define AT_VECTOR_SIZE (2*(AT_VECTOR_SIZE_ARCH + AT_VECTOR_SIZE_BASE + 1))

struct address_space;

#if NR_CPUS >= CONFIG_SPLIT_PTLOCK_CPUS
typedef atomic_long_t mm_counter_t;
#else  /* NR_CPUS < CONFIG_SPLIT_PTLOCK_CPUS */
typedef unsigned long mm_counter_t;
#endif /* NR_CPUS < CONFIG_SPLIT_PTLOCK_CPUS */

/*
 * Each physical page in the system has a struct page associated with
 * it to keep track of whatever it is we are using the page for at the
 * moment. Note that we have no way to track which tasks are using
 * a page, though if it is a pagecache page, rmap structures can tell us
 * who is mapping it.
 */
struct page {
	unsigned long flags;		/* Atomic flags, some possibly
					 * updated asynchronously */
	atomic_t _count;		/* Usage count, see below. */
	union {
		atomic_t _mapcount;	/* Count of ptes mapped in mms,
					 * to show when page is mapped
					 * & limit reverse map searches.
					 */
		struct {		/* SLUB */
			u16 inuse;
			u16 objects;
		};
	};
	union {
	    struct {
		unsigned long private;		/* Mapping-private opaque data:
					 	 * usually used for buffer_heads
						 * if PagePrivate set; used for
						 * swp_entry_t if PageSwapCache;
						 * indicates order in the buddy
						 * system if PG_buddy is set.
						 */
		struct address_space *mapping;	/* If low bit clear, points to
						 * inode address_space, or NULL.
						 * If page mapped as anonymous
						 * memory, low bit is set, and
						 * it points to anon_vma object:
						 * see PAGE_MAPPING_ANON below.
						 */
	    };
#if NR_CPUS >= CONFIG_SPLIT_PTLOCK_CPUS
	    spinlock_t ptl;
#endif
	    struct kmem_cache *slab;	/* SLUB: Pointer to slab */
	    struct page *first_page;	/* Compound tail pages */
	};
	union {
		pgoff_t index;		/* Our offset within mapping. */
		void *freelist;		/* SLUB: freelist req. slab lock */
	};
	struct list_head lru;		/* Pageout list, eg. active_list
					 * protected by zone->lru_lock !
					 */
	/*
	 * On machines where all RAM is mapped into kernel address space,
	 * we can simply calculate the virtual address. On machines with
	 * highmem some memory is mapped into kernel virtual memory
	 * dynamically, so we need a place to store that address.
	 * Note that this field could be 16 bits on x86 ... ;)
	 *
	 * Architectures with slow multiplication can define
	 * WANT_PAGE_VIRTUAL in asm/page.h
	 */
#if defined(WANT_PAGE_VIRTUAL)
	void *virtual;			/* Kernel virtual address (NULL if
					   not kmapped, ie. highmem) */
#endif /* WANT_PAGE_VIRTUAL */
#ifdef CONFIG_CGROUP_MEM_RES_CTLR
	unsigned long page_cgroup;
#endif
};

/*
 * This struct defines a memory VMM memory area. There is one of these
 * per VM-area/task.  A VM area is any part of the process virtual memory
 * space that has a special rule for the page-fault handlers (ie a shared
 * library, the executable area etc).
 */
struct vm_area_struct {
	struct mm_struct * vm_mm;	/* The address space we belong to. */
	unsigned long vm_start;		/* Our start address within vm_mm. */
	unsigned long vm_end;		/* The first byte after our end address
					   within vm_mm. */

	/* linked list of VM areas per task, sorted by address */
	struct vm_area_struct *vm_next;

	pgprot_t vm_page_prot;		/* Access permissions of this VMA. */
	unsigned long vm_flags;		/* Flags, see mm.h. */

	struct rb_node vm_rb;

	/*
	 * For areas with an address space and backing store,
	 * linkage into the address_space->i_mmap prio tree, or
	 * linkage to the list of like vmas hanging off its node, or
	 * linkage of vma in the address_space->i_mmap_nonlinear list.
	 */
	union {
		struct {
			struct list_head list;
			void *parent;	/* aligns with prio_tree_node parent */
			struct vm_area_struct *head;
		} vm_set;

		struct raw_prio_tree_node prio_tree_node;
	} shared;

	/*
	 * A file's MAP_PRIVATE vma can be in both i_mmap tree and anon_vma
	 * list, after a COW of one of the file pages.	A MAP_SHARED vma
	 * can only be in the i_mmap tree.  An anonymous MAP_PRIVATE, stack
	 * or brk vma (with NULL file) can only be in an anon_vma list.
	 */
	struct list_head anon_vma_node;	/* Serialized by anon_vma->lock */
	struct anon_vma *anon_vma;	/* Serialized by page_table_lock */

	/* Function pointers to deal with this struct. */
	struct vm_operations_struct * vm_ops;

	/* Information about our backing store: */
	unsigned long vm_pgoff;		/* Offset (within vm_file) in PAGE_SIZE
					   units, *not* PAGE_CACHE_SIZE */
	struct file * vm_file;		/* File we map to (can be NULL). */
	void * vm_private_data;		/* was vm_pte (shared mem) */
	unsigned long vm_truncate_count;/* truncate_count or restart_addr */

#ifndef CONFIG_MMU
	atomic_t vm_usage;		/* refcount (VMAs shared if !MMU) */
#endif
#ifdef CONFIG_NUMA
	struct mempolicy *vm_policy;	/* NUMA policy for the VMA */
#endif
};

struct core_thread {
	struct task_struct *task;
	struct core_thread *next;
};

struct core_state {
	atomic_t nr_threads;
	struct core_thread dumper;
	struct completion startup;
};

struct mm_struct {
	struct vm_area_struct * mmap;		/* list of VMAs */
	struct rb_root mm_rb;
	struct vm_area_struct * mmap_cache;	/* last find_vma result */
	unsigned long (*get_unmapped_area) (struct file *filp,
				unsigned long addr, unsigned long len,
				unsigned long pgoff, unsigned long flags);
	void (*unmap_area) (struct mm_struct *mm, unsigned long addr);
	unsigned long mmap_base;		/* base of mmap area */
	unsigned long task_size;		/* size of task vm space */
	unsigned long cached_hole_size; 	/* if non-zero, the largest hole below free_area_cache */
	unsigned long free_area_cache;		/* first hole of size cached_hole_size or larger */
	pgd_t * pgd;
	atomic_t mm_users;			/* How many users with user space? */
	atomic_t mm_count;			/* How many references to "struct mm_struct" (users count as 1) */
	int map_count;				/* number of VMAs */
	struct rw_semaphore mmap_sem;
	spinlock_t page_table_lock;		/* Protects page tables and some counters */

	struct list_head mmlist;		/* List of maybe swapped mm's.	These are globally strung
						 * together off init_mm.mmlist, and are protected
						 * by mmlist_lock
						 */

	/* Special counters, in some configurations protected by the
	 * page_table_lock, in other configurations by being atomic.
	 */
	mm_counter_t _file_rss;
	mm_counter_t _anon_rss;

	unsigned long hiwater_rss;	/* High-watermark of RSS usage */
	unsigned long hiwater_vm;	/* High-water virtual memory usage */

	unsigned long total_vm, locked_vm, shared_vm, exec_vm;
	unsigned long stack_vm, reserved_vm, def_flags, nr_ptes;
	unsigned long start_code, end_code, start_data, end_data;
	unsigned long start_brk, brk, start_stack;
	unsigned long arg_start, arg_end, env_start, env_end;

	unsigned long saved_auxv[AT_VECTOR_SIZE]; /* for /proc/PID/auxv */

	cpumask_t cpu_vm_mask;

	/* Architecture-specific MM context */
	mm_context_t context;

	/* Swap token stuff */
	/*
	 * Last value of global fault stamp as seen by this process.
	 * In other words, this value gives an indication of how long
	 * it has been since this task got the token.
	 * Look at mm/thrash.c
	 */
	unsigned int faultstamp;
	unsigned int token_priority;
	unsigned int last_interval;

	unsigned long flags; /* Must use atomic bitops to access the bits */

	struct core_state *core_state; /* coredumping support */

	/* aio bits */
	rwlock_t		ioctx_list_lock;	/* aio lock */
	struct kioctx		*ioctx_list;
#ifdef CONFIG_MM_OWNER
	/*
	 * "owner" points to a task that is regarded as the canonical
	 * user/owner of this mm. All of the following must be true in
	 * order for it to be changed:
	 *
	 * current == mm->owner
	 * current->mm != mm
	 * new_owner->mm == mm
	 * new_owner->alloc_lock is held
	 */
	struct task_struct *owner;
#endif

#ifdef CONFIG_PROC_FS
	/* store ref to file /proc/<pid>/exe symlink points to */
	struct file *exe_file;
	unsigned long num_exe_file_vmas;
#endif
#ifdef CONFIG_MMU_NOTIFIER
	struct mmu_notifier_mm *mmu_notifier_mm;
#endif
};

#endif /* _LINUX_MM_TYPES_H */
Commit	Line	Data
5b99cd0e HC	1	#ifndef _LINUX_MM_TYPES_H
	2	#define _LINUX_MM_TYPES_H
	3
4f9a58d7	4	#include <linux/auxvec.h>
5b99cd0e HC	5	#include <linux/types.h>
	6	#include <linux/threads.h>
	7	#include <linux/list.h>
	8	#include <linux/spinlock.h>
c92ff1bd MS	9	#include <linux/prio_tree.h>
	10	#include <linux/rbtree.h>
	11	#include <linux/rwsem.h>
	12	#include <linux/completion.h>
cddb8a5c	13	#include <linux/cpumask.h>
c92ff1bd MS	14	#include <asm/page.h>
c92ff1bd MS	15	#include <asm/mmu.h>
5b99cd0e	16
4f9a58d7 OH	17	#ifndef AT_VECTOR_SIZE_ARCH
	18	#define AT_VECTOR_SIZE_ARCH 0
	19	#endif
	20	#define AT_VECTOR_SIZE (2*(AT_VECTOR_SIZE_ARCH + AT_VECTOR_SIZE_BASE + 1))
	21
5b99cd0e HC	22	struct address_space;
5b99cd0e HC	23
c92ff1bd MS	24	#if NR_CPUS >= CONFIG_SPLIT_PTLOCK_CPUS
	25	typedef atomic_long_t mm_counter_t;
	26	#else /* NR_CPUS < CONFIG_SPLIT_PTLOCK_CPUS */
	27	typedef unsigned long mm_counter_t;
	28	#endif /* NR_CPUS < CONFIG_SPLIT_PTLOCK_CPUS */
	29
5b99cd0e HC	30	/*
	31	* Each physical page in the system has a struct page associated with
	32	* it to keep track of whatever it is we are using the page for at the
	33	* moment. Note that we have no way to track which tasks are using
	34	* a page, though if it is a pagecache page, rmap structures can tell us
	35	* who is mapping it.
	36	*/
	37	struct page {
	38	unsigned long flags; /* Atomic flags, some possibly
	39	* updated asynchronously */
	40	atomic_t _count; /* Usage count, see below. */
81819f0f CL	41	union {
81819f0f CL	42	atomic_t _mapcount; /* Count of ptes mapped in mms,
5b99cd0e HC	43	* to show when page is mapped
	44	* & limit reverse map searches.
	45	*/
39b26464 CL	46	struct { /* SLUB */
	47	u16 inuse;
	48	u16 objects;
	49	};
81819f0f	50	};
5b99cd0e HC	51	union {
	52	struct {
	53	unsigned long private; /* Mapping-private opaque data:
	54	* usually used for buffer_heads
	55	* if PagePrivate set; used for
	56	* swp_entry_t if PageSwapCache;
	57	* indicates order in the buddy
	58	* system if PG_buddy is set.
	59	*/
	60	struct address_space mapping; / If low bit clear, points to
	61	* inode address_space, or NULL.
	62	* If page mapped as anonymous
	63	* memory, low bit is set, and
	64	* it points to anon_vma object:
	65	* see PAGE_MAPPING_ANON below.
	66	*/
	67	};
	68	#if NR_CPUS >= CONFIG_SPLIT_PTLOCK_CPUS
	69	spinlock_t ptl;
	70	#endif
a973e9dd	71	struct kmem_cache slab; / SLUB: Pointer to slab */
8e65d24c	72	struct page first_page; / Compound tail pages */
81819f0f CL	73	};
	74	union {
	75	pgoff_t index; /* Our offset within mapping. */
894b8788	76	void freelist; / SLUB: freelist req. slab lock */
5b99cd0e	77	};
5b99cd0e HC	78	struct list_head lru; /* Pageout list, eg. active_list
	79	* protected by zone->lru_lock !
	80	*/
	81	/*
	82	* On machines where all RAM is mapped into kernel address space,
	83	* we can simply calculate the virtual address. On machines with
	84	* highmem some memory is mapped into kernel virtual memory
	85	* dynamically, so we need a place to store that address.
	86	* Note that this field could be 16 bits on x86 ... ;)
	87	*
	88	* Architectures with slow multiplication can define
	89	* WANT_PAGE_VIRTUAL in asm/page.h
	90	*/
	91	#if defined(WANT_PAGE_VIRTUAL)
	92	void virtual; / Kernel virtual address (NULL if
	93	not kmapped, ie. highmem) */
	94	#endif /* WANT_PAGE_VIRTUAL */
00f0b825	95	#ifdef CONFIG_CGROUP_MEM_RES_CTLR
78fb7466 PE	96	unsigned long page_cgroup;
78fb7466 PE	97	#endif
5b99cd0e HC	98	};
5b99cd0e HC	99
c92ff1bd MS	100	/*
	101	* This struct defines a memory VMM memory area. There is one of these
	102	* per VM-area/task. A VM area is any part of the process virtual memory
	103	* space that has a special rule for the page-fault handlers (ie a shared
	104	* library, the executable area etc).
	105	*/
	106	struct vm_area_struct {
	107	struct mm_struct * vm_mm; /* The address space we belong to. */
	108	unsigned long vm_start; /* Our start address within vm_mm. */
	109	unsigned long vm_end; /* The first byte after our end address
	110	within vm_mm. */
	111
	112	/* linked list of VM areas per task, sorted by address */
	113	struct vm_area_struct *vm_next;
	114
	115	pgprot_t vm_page_prot; /* Access permissions of this VMA. */
605d9288	116	unsigned long vm_flags; /* Flags, see mm.h. */
c92ff1bd MS	117
	118	struct rb_node vm_rb;
	119
	120	/*
	121	* For areas with an address space and backing store,
	122	* linkage into the address_space->i_mmap prio tree, or
	123	* linkage to the list of like vmas hanging off its node, or
	124	* linkage of vma in the address_space->i_mmap_nonlinear list.
	125	*/
	126	union {
	127	struct {
	128	struct list_head list;
	129	void parent; / aligns with prio_tree_node parent */
	130	struct vm_area_struct *head;
	131	} vm_set;
	132
	133	struct raw_prio_tree_node prio_tree_node;
	134	} shared;
	135
	136	/*
	137	* A file's MAP_PRIVATE vma can be in both i_mmap tree and anon_vma
	138	* list, after a COW of one of the file pages. A MAP_SHARED vma
	139	* can only be in the i_mmap tree. An anonymous MAP_PRIVATE, stack
	140	* or brk vma (with NULL file) can only be in an anon_vma list.
	141	*/
	142	struct list_head anon_vma_node; /* Serialized by anon_vma->lock */
	143	struct anon_vma anon_vma; / Serialized by page_table_lock */
	144
	145	/* Function pointers to deal with this struct. */
	146	struct vm_operations_struct * vm_ops;
	147
	148	/* Information about our backing store: */
	149	unsigned long vm_pgoff; /* Offset (within vm_file) in PAGE_SIZE
	150	units, not PAGE_CACHE_SIZE */
	151	struct file * vm_file; /* File we map to (can be NULL). */
	152	void * vm_private_data; /* was vm_pte (shared mem) */
	153	unsigned long vm_truncate_count;/* truncate_count or restart_addr */
	154
	155	#ifndef CONFIG_MMU
	156	atomic_t vm_usage; /* refcount (VMAs shared if !MMU) */
	157	#endif
	158	#ifdef CONFIG_NUMA
	159	struct mempolicy vm_policy; / NUMA policy for the VMA */
	160	#endif
	161	};
	162
b564daf8 ON	163	struct core_thread {
	164	struct task_struct *task;
	165	struct core_thread *next;
	166	};
	167
32ecb1f2	168	struct core_state {
c5f1cc8c	169	atomic_t nr_threads;
b564daf8	170	struct core_thread dumper;
32ecb1f2 ON	171	struct completion startup;
	172	};
	173
c92ff1bd MS	174	struct mm_struct {
	175	struct vm_area_struct * mmap; /* list of VMAs */
	176	struct rb_root mm_rb;
	177	struct vm_area_struct * mmap_cache; /* last find_vma result */
	178	unsigned long (get_unmapped_area) (struct file filp,
	179	unsigned long addr, unsigned long len,
	180	unsigned long pgoff, unsigned long flags);
	181	void (unmap_area) (struct mm_struct mm, unsigned long addr);
	182	unsigned long mmap_base; /* base of mmap area */
	183	unsigned long task_size; /* size of task vm space */
	184	unsigned long cached_hole_size; /* if non-zero, the largest hole below free_area_cache */
	185	unsigned long free_area_cache; /* first hole of size cached_hole_size or larger */
	186	pgd_t * pgd;
	187	atomic_t mm_users; /* How many users with user space? */
	188	atomic_t mm_count; /* How many references to "struct mm_struct" (users count as 1) */
	189	int map_count; /* number of VMAs */
	190	struct rw_semaphore mmap_sem;
	191	spinlock_t page_table_lock; /* Protects page tables and some counters */
	192
	193	struct list_head mmlist; /* List of maybe swapped mm's. These are globally strung
	194	* together off init_mm.mmlist, and are protected
	195	* by mmlist_lock
	196	*/
	197
	198	/* Special counters, in some configurations protected by the
	199	* page_table_lock, in other configurations by being atomic.
	200	*/
	201	mm_counter_t _file_rss;
	202	mm_counter_t _anon_rss;
	203
	204	unsigned long hiwater_rss; /* High-watermark of RSS usage */
	205	unsigned long hiwater_vm; /* High-water virtual memory usage */
	206
	207	unsigned long total_vm, locked_vm, shared_vm, exec_vm;
	208	unsigned long stack_vm, reserved_vm, def_flags, nr_ptes;
	209	unsigned long start_code, end_code, start_data, end_data;
	210	unsigned long start_brk, brk, start_stack;
	211	unsigned long arg_start, arg_end, env_start, env_end;
	212
	213	unsigned long saved_auxv[AT_VECTOR_SIZE]; /* for /proc/PID/auxv */
	214
	215	cpumask_t cpu_vm_mask;
	216
	217	/* Architecture-specific MM context */
	218	mm_context_t context;
	219
	220	/* Swap token stuff */
	221	/*
	222	* Last value of global fault stamp as seen by this process.
	223	* In other words, this value gives an indication of how long
	224	* it has been since this task got the token.
	225	* Look at mm/thrash.c
	226	*/
	227	unsigned int faultstamp;
	228	unsigned int token_priority;
	229	unsigned int last_interval;
	230
	231	unsigned long flags; /* Must use atomic bitops to access the bits */
	232
a94e2d40	233	struct core_state core_state; / coredumping support */
c92ff1bd MS	234
c92ff1bd MS	235	/* aio bits */
7edf85aa	236	rwlock_t ioctx_list_lock; /* aio lock */
c92ff1bd	237	struct kioctx *ioctx_list;
cf475ad2	238	#ifdef CONFIG_MM_OWNER
4cd1a8fc KM	239	/*
	240	* "owner" points to a task that is regarded as the canonical
	241	* user/owner of this mm. All of the following must be true in
	242	* order for it to be changed:
	243	*
	244	* current == mm->owner
	245	* current->mm != mm
	246	* new_owner->mm == mm
	247	* new_owner->alloc_lock is held
	248	*/
	249	struct task_struct *owner;
78fb7466	250	#endif
925d1c40 MH	251
	252	#ifdef CONFIG_PROC_FS
	253	/* store ref to file /proc/<pid>/exe symlink points to */
	254	struct file *exe_file;
	255	unsigned long num_exe_file_vmas;
	256	#endif
cddb8a5c AA	257	#ifdef CONFIG_MMU_NOTIFIER
	258	struct mmu_notifier_mm *mmu_notifier_mm;
	259	#endif
c92ff1bd MS	260	};
c92ff1bd MS	261
5b99cd0e	262	#endif /* _LINUX_MM_TYPES_H */