[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 <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, listed below. */

	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_state {
	int nr_threads;
	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 */

	/* coredumping support */
	struct core_state *core_state;
	struct completion core_done;

	/* 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
};

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