[apple/xnu.git] / osfmk / mach / vm_statistics.h

/*
 * Copyright (c) 2000-2009 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */
/*
 *	File:	mach/vm_statistics.h
 *	Author:	Avadis Tevanian, Jr., Michael Wayne Young, David Golub
 *
 *	Virtual memory statistics structure.
 *
 */

#ifndef	_MACH_VM_STATISTICS_H_
#define	_MACH_VM_STATISTICS_H_

#include <mach/machine/vm_types.h>


/*
 * vm_statistics
 *
 * History:
 *	rev0 - 	original structure.
 *	rev1 - 	added purgable info (purgable_count and purges).
 *	rev2 - 	added speculative_count.
 *
 * Note: you cannot add any new fields to this structure. Add them below in
 * 	 vm_statistics64.
 */

struct vm_statistics {
	natural_t	free_count;		/* # of pages free */
	natural_t	active_count;		/* # of pages active */
	natural_t	inactive_count;		/* # of pages inactive */
	natural_t	wire_count;		/* # of pages wired down */
	natural_t	zero_fill_count;	/* # of zero fill pages */
	natural_t	reactivations;		/* # of pages reactivated */
	natural_t	pageins;		/* # of pageins */
	natural_t	pageouts;		/* # of pageouts */
	natural_t	faults;			/* # of faults */
	natural_t	cow_faults;		/* # of copy-on-writes */
	natural_t	lookups;		/* object cache lookups */
	natural_t	hits;			/* object cache hits */

	/* added for rev1 */
	natural_t	purgeable_count;	/* # of pages purgeable */
	natural_t	purges;			/* # of pages purged */

	/* added for rev2 */
	/*
	 * NB: speculative pages are already accounted for in "free_count",
	 * so "speculative_count" is the number of "free" pages that are
	 * used to hold data that was read speculatively from disk but
	 * haven't actually been used by anyone so far.
	 */
	natural_t	speculative_count;	/* # of pages speculative */
};

/* Used by all architectures */
typedef struct vm_statistics	*vm_statistics_t;
typedef struct vm_statistics	vm_statistics_data_t;

/* 
 * vm_statistics64
 *
 * History:
 *	rev0 - 	original structure.
 *	rev1 - 	added purgable info (purgable_count and purges).
 *	rev2 - 	added speculative_count.
 *	   ----
 *	rev3 - 	changed name to vm_statistics64.
 *		changed some fields in structure to 64-bit on 
 *		arm, i386 and x86_64 architectures.
 *	rev4 -  require 64-bit alignment for efficient access
 *		in the kernel. No change to reported data.
 *
 */

struct vm_statistics64 {
	natural_t	free_count;		/* # of pages free */
	natural_t	active_count;		/* # of pages active */
	natural_t	inactive_count;		/* # of pages inactive */
	natural_t	wire_count;		/* # of pages wired down */
	uint64_t	zero_fill_count;	/* # of zero fill pages */
	uint64_t	reactivations;		/* # of pages reactivated */
	uint64_t	pageins;		/* # of pageins */
	uint64_t	pageouts;		/* # of pageouts */
	uint64_t	faults;			/* # of faults */
	uint64_t	cow_faults;		/* # of copy-on-writes */
	uint64_t	lookups;		/* object cache lookups */
	uint64_t	hits;			/* object cache hits */

	/* added for rev1 */
	uint64_t	purges;			/* # of pages purged */
	natural_t	purgeable_count;	/* # of pages purgeable */

	/* added for rev2 */
	/*
	 * NB: speculative pages are already accounted for in "free_count",
	 * so "speculative_count" is the number of "free" pages that are
	 * used to hold data that was read speculatively from disk but
	 * haven't actually been used by anyone so far.
	 */
	natural_t	speculative_count;	/* # of pages speculative */

} __attribute__((aligned(8)));

typedef struct vm_statistics64	*vm_statistics64_t;
typedef struct vm_statistics64	vm_statistics64_data_t;

/* 
 * VM_STATISTICS_TRUNCATE_TO_32_BIT
 *
 * This is used by host_statistics() to truncate and peg the 64-bit in-kernel values from
 * vm_statistics64 to the 32-bit values of the older structure above (vm_statistics).
 */
#define VM_STATISTICS_TRUNCATE_TO_32_BIT(value) ((uint32_t)(((value) > UINT32_MAX ) ? UINT32_MAX : (value)))

/* 
 * vm_extmod_statistics
 *
 * Structure to record modifications to a task by an
 * external agent.
 *
 * History:
 *	rev0 - 	original structure.
 */

struct vm_extmod_statistics {
	int64_t	task_for_pid_count;			/* # of times task port was looked up */
	int64_t task_for_pid_caller_count;	/* # of times this task called task_for_pid */
	int64_t	thread_creation_count;		/* # of threads created in task */
	int64_t	thread_creation_caller_count;	/* # of threads created by task */
	int64_t	thread_set_state_count;		/* # of register state sets in task */
	int64_t	thread_set_state_caller_count;	/* # of register state sets by task */
} __attribute__((aligned(8)));

typedef struct vm_extmod_statistics *vm_extmod_statistics_t;
typedef struct vm_extmod_statistics vm_extmod_statistics_data_t;


/* included for the vm_map_page_query call */

#define VM_PAGE_QUERY_PAGE_PRESENT      0x1
#define VM_PAGE_QUERY_PAGE_FICTITIOUS   0x2
#define VM_PAGE_QUERY_PAGE_REF          0x4
#define VM_PAGE_QUERY_PAGE_DIRTY        0x8
#define VM_PAGE_QUERY_PAGE_PAGED_OUT    0x10
#define VM_PAGE_QUERY_PAGE_COPIED       0x20
#define VM_PAGE_QUERY_PAGE_SPECULATIVE	0x40
#define VM_PAGE_QUERY_PAGE_EXTERNAL	0x80
#define VM_PAGE_QUERY_PAGE_CS_VALIDATED	0x100
#define VM_PAGE_QUERY_PAGE_CS_TAINTED	0x200

#ifdef	MACH_KERNEL_PRIVATE

/*
 *	Each machine dependent implementation is expected to
 *	keep certain statistics.  They may do this anyway they
 *	so choose, but are expected to return the statistics
 *	in the following structure.
 */

struct pmap_statistics {
	integer_t	resident_count;	/* # of pages mapped (total)*/
	integer_t	resident_max;	/* # of pages mapped (peak) */
	integer_t	wired_count;	/* # of pages wired */
};

typedef struct pmap_statistics	*pmap_statistics_t;

#endif	/* MACH_KERNEL_PRIVATE */

/*
 * VM allocation flags:
 * 
 * VM_FLAGS_FIXED
 * 	(really the absence of VM_FLAGS_ANYWHERE)
 *	Allocate new VM region at the specified virtual address, if possible.
 * 
 * VM_FLAGS_ANYWHERE
 *	Allocate new VM region anywhere it would fit in the address space.
 *
 * VM_FLAGS_PURGABLE
 *	Create a purgable VM object for that new VM region.
 *
 * VM_FLAGS_NO_PMAP_CHECK
 *	(for DEBUG kernel config only, ignored for other configs)
 *	Do not check that there is no stale pmap mapping for the new VM region.
 *	This is useful for kernel memory allocations at bootstrap when building
 *	the initial kernel address space while some memory is already in use.
 *
 * VM_FLAGS_OVERWRITE
 *	The new VM region can replace existing VM regions if necessary
 *	(to be used in combination with VM_FLAGS_FIXED).
 *
 * VM_FLAGS_NO_CACHE
 *	Pages brought in to this VM region are placed on the speculative
 *	queue instead of the active queue.  In other words, they are not
 *	cached so that they will be stolen first if memory runs low.
 */
#define VM_FLAGS_FIXED		0x0000
#define VM_FLAGS_ANYWHERE	0x0001
#define VM_FLAGS_PURGABLE	0x0002
#define VM_FLAGS_NO_CACHE	0x0010
#ifdef KERNEL_PRIVATE
#define VM_FLAGS_PERMANENT	0x0100	/* mapping can NEVER be unmapped */
#define VM_FLAGS_GUARD_AFTER	0x0200	/* guard page after the mapping */
#define VM_FLAGS_GUARD_BEFORE	0x0400	/* guard page before the mapping */
#define VM_FLAGS_SUBMAP		0x0800	/* mapping a VM submap */
#define VM_FLAGS_ALREADY	0x1000	/* OK if same mapping already exists */
#define VM_FLAGS_BEYOND_MAX	0x2000	/* map beyond the map's max offset */
#endif /* KERNEL_PRIVATE */
#define VM_FLAGS_OVERWRITE	0x4000	/* delete any existing mappings first */
#ifdef KERNEL_PRIVATE
#define VM_FLAGS_NO_PMAP_CHECK	0x8000	/* do not check that pmap is empty */
#define	VM_FLAGS_MAP_JIT	0x80000	/* Used to mark an entry as describing a JIT region */
#endif /* KERNEL_PRIVATE */

/*
 * VM_FLAGS_SUPERPAGE_MASK
 *	3 bits that specify whether large pages should be used instead of
 *	base pages (!=0), as well as the requested page size.
 */
#define VM_FLAGS_SUPERPAGE_MASK	0x70000	/* bits 0x10000, 0x20000, 0x40000 */
#define VM_FLAGS_SUPERPAGE_SHIFT 16

#define SUPERPAGE_NONE			0	/* no superpages, if all bits are 0 */
#define SUPERPAGE_SIZE_ANY		1
#define VM_FLAGS_SUPERPAGE_NONE     (SUPERPAGE_NONE     << VM_FLAGS_SUPERPAGE_SHIFT)
#define VM_FLAGS_SUPERPAGE_SIZE_ANY (SUPERPAGE_SIZE_ANY << VM_FLAGS_SUPERPAGE_SHIFT)
#if defined(__x86_64__) || !defined(KERNEL)
#define SUPERPAGE_SIZE_2MB		2
#define VM_FLAGS_SUPERPAGE_SIZE_2MB (SUPERPAGE_SIZE_2MB<<VM_FLAGS_SUPERPAGE_SHIFT)
#endif

#define VM_FLAGS_ALIAS_MASK	0xFF000000
#define VM_GET_FLAGS_ALIAS(flags, alias)			\
		(alias) = ((flags) & VM_FLAGS_ALIAS_MASK) >> 24	
#define VM_SET_FLAGS_ALIAS(flags, alias)			\
		(flags) = (((flags) & ~VM_FLAGS_ALIAS_MASK) |	\
		(((alias) & ~VM_FLAGS_ALIAS_MASK) << 24))

/* These are the flags that we accept from user-space */
#define VM_FLAGS_USER_ALLOCATE	(VM_FLAGS_FIXED |		\
				 VM_FLAGS_ANYWHERE |		\
				 VM_FLAGS_PURGABLE |		\
				 VM_FLAGS_NO_CACHE |		\
				 VM_FLAGS_OVERWRITE |		\
				 VM_FLAGS_SUPERPAGE_MASK |	\
				 VM_FLAGS_ALIAS_MASK)
#define VM_FLAGS_USER_MAP	VM_FLAGS_USER_ALLOCATE
#define VM_FLAGS_USER_REMAP	(VM_FLAGS_FIXED |    \
				 VM_FLAGS_ANYWHERE | \
				 VM_FLAGS_OVERWRITE)

#define VM_MEMORY_MALLOC 1
#define VM_MEMORY_MALLOC_SMALL 2
#define VM_MEMORY_MALLOC_LARGE 3
#define VM_MEMORY_MALLOC_HUGE 4
#define VM_MEMORY_SBRK 5// uninteresting -- no one should call
#define VM_MEMORY_REALLOC 6
#define VM_MEMORY_MALLOC_TINY 7
#define VM_MEMORY_MALLOC_LARGE_REUSABLE 8
#define VM_MEMORY_MALLOC_LARGE_REUSED 9

#define VM_MEMORY_ANALYSIS_TOOL 10

#define VM_MEMORY_MACH_MSG 20
#define VM_MEMORY_IOKIT	21
#define VM_MEMORY_STACK  30
#define VM_MEMORY_GUARD  31
#define	VM_MEMORY_SHARED_PMAP 32
/* memory containing a dylib */
#define VM_MEMORY_DYLIB	33
#define VM_MEMORY_OBJC_DISPATCHERS 34

// Placeholders for now -- as we analyze the libraries and find how they
// use memory, we can make these labels more specific.
#define VM_MEMORY_APPKIT 40
#define VM_MEMORY_FOUNDATION 41
#define VM_MEMORY_COREGRAPHICS 42
#define VM_MEMORY_CARBON 43
#define VM_MEMORY_JAVA 44
#define VM_MEMORY_ATS 50
#define VM_MEMORY_LAYERKIT 51
#define VM_MEMORY_CGIMAGE 52
#define VM_MEMORY_TCMALLOC 53

/* private raster data (i.e. layers, some images, QGL allocator) */
#define	VM_MEMORY_COREGRAPHICS_DATA	54

/* shared image and font caches */
#define VM_MEMORY_COREGRAPHICS_SHARED	55

/* Memory used for virtual framebuffers, shadowing buffers, etc... */
#define	VM_MEMORY_COREGRAPHICS_FRAMEBUFFERS	56

/* Window backing stores, custom shadow data, and compressed backing stores */
#define VM_MEMORY_COREGRAPHICS_BACKINGSTORES	57

/* catch-all for other uses, such as the read-only shared data page */
#define VM_MEMORY_COREGRAPHICS_MISC VM_MEMORY_COREGRAPHICS

/* memory allocated by the dynamic loader for itself */
#define VM_MEMORY_DYLD 60
/* malloc'd memory created by dyld */
#define VM_MEMORY_DYLD_MALLOC 61

/* Used for sqlite page cache */
#define VM_MEMORY_SQLITE 62

/* JavaScriptCore heaps */
#define VM_MEMORY_JAVASCRIPT_CORE 63
/* memory allocated for the JIT */
#define VM_MEMORY_JAVASCRIPT_JIT_EXECUTABLE_ALLOCATOR 64
#define VM_MEMORY_JAVASCRIPT_JIT_REGISTER_FILE 65

/* memory allocated for GLSL */
#define VM_MEMORY_GLSL  66

/* memory allocated for OpenCL.framework */
#define VM_MEMORY_OPENCL    67

/* memory allocated for QuartzCore.framework */
#define VM_MEMORY_COREIMAGE 68

/* memory allocated for WebCore Purgeable Buffers */
#define VM_MEMORY_WEBCORE_PURGEABLE_BUFFERS 69

/* ImageIO memory */
#define VM_MEMORY_IMAGEIO	70

/* CoreProfile memory */
#define VM_MEMORY_COREPROFILE	71

/* assetsd / MobileSlideShow memory */
#define VM_MEMORY_ASSETSD    72

/* Reserve 240-255 for application */
#define VM_MEMORY_APPLICATION_SPECIFIC_1 240
#define VM_MEMORY_APPLICATION_SPECIFIC_16 255

#define VM_MAKE_TAG(tag) ((tag) << 24)

#endif	/* _MACH_VM_STATISTICS_H_ */
Commit	Line	Data
1c79356b	1	/*
b0d623f7	2	* Copyright (c) 2000-2009 Apple Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
8f6c56a5	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* @OSF_COPYRIGHT@
	30	*/
1c79356b A	31	/*
	32	* Mach Operating System
	33	* Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
	34	* All Rights Reserved.
	35	*
	36	* Permission to use, copy, modify and distribute this software and its
	37	* documentation is hereby granted, provided that both the copyright
	38	* notice and this permission notice appear in all copies of the
	39	* software, derivative works or modified versions, and any portions
	40	* thereof, and that both notices appear in supporting documentation.
	41	*
	42	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	43	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	44	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	45	*
	46	* Carnegie Mellon requests users of this software to return to
	47	*
	48	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	49	* School of Computer Science
	50	* Carnegie Mellon University
	51	* Pittsburgh PA 15213-3890
	52	*
	53	* any improvements or extensions that they make and grant Carnegie Mellon
	54	* the rights to redistribute these changes.
	55	*/
	56	/*
	57	*/
	58	/*
	59	* File: mach/vm_statistics.h
	60	* Author: Avadis Tevanian, Jr., Michael Wayne Young, David Golub
	61	*
	62	* Virtual memory statistics structure.
	63	*
	64	*/
	65
91447636 A	66	#ifndef _MACH_VM_STATISTICS_H_
91447636 A	67	#define _MACH_VM_STATISTICS_H_
1c79356b A	68
	69	#include <mach/machine/vm_types.h>
	70
b0d623f7 A	71
	72	/*
	73	* vm_statistics
	74	*
	75	* History:
	76	* rev0 - original structure.
	77	* rev1 - added purgable info (purgable_count and purges).
	78	* rev2 - added speculative_count.
	79	*
	80	* Note: you cannot add any new fields to this structure. Add them below in
	81	* vm_statistics64.
	82	*/
	83
1c79356b	84	struct vm_statistics {
91447636 A	85	natural_t free_count; /* # of pages free */
	86	natural_t active_count; /* # of pages active */
	87	natural_t inactive_count; /* # of pages inactive */
	88	natural_t wire_count; /* # of pages wired down */
	89	natural_t zero_fill_count; /* # of zero fill pages */
	90	natural_t reactivations; /* # of pages reactivated */
	91	natural_t pageins; /* # of pageins */
	92	natural_t pageouts; /* # of pageouts */
	93	natural_t faults; /* # of faults */
	94	natural_t cow_faults; /* # of copy-on-writes */
	95	natural_t lookups; /* object cache lookups */
	96	natural_t hits; /* object cache hits */
	97
2d21ac55	98	/* added for rev1 */
91447636 A	99	natural_t purgeable_count; /* # of pages purgeable */
91447636 A	100	natural_t purges; /* # of pages purged */
2d21ac55 A	101
	102	/* added for rev2 */
	103	/*
	104	* NB: speculative pages are already accounted for in "free_count",
	105	* so "speculative_count" is the number of "free" pages that are
	106	* used to hold data that was read speculatively from disk but
	107	* haven't actually been used by anyone so far.
	108	*/
	109	natural_t speculative_count; /* # of pages speculative */
1c79356b A	110	};
1c79356b A	111
b0d623f7	112	/* Used by all architectures */
1c79356b A	113	typedef struct vm_statistics *vm_statistics_t;
	114	typedef struct vm_statistics vm_statistics_data_t;
	115
b0d623f7 A	116	/*
	117	* vm_statistics64
	118	*
	119	* History:
	120	* rev0 - original structure.
	121	* rev1 - added purgable info (purgable_count and purges).
	122	* rev2 - added speculative_count.
	123	* ----
	124	* rev3 - changed name to vm_statistics64.
	125	* changed some fields in structure to 64-bit on
	126	* arm, i386 and x86_64 architectures.
6d2010ae A	127	* rev4 - require 64-bit alignment for efficient access
6d2010ae A	128	* in the kernel. No change to reported data.
b0d623f7 A	129	*
	130	*/
	131
	132	struct vm_statistics64 {
	133	natural_t free_count; /* # of pages free */
	134	natural_t active_count; /* # of pages active */
	135	natural_t inactive_count; /* # of pages inactive */
	136	natural_t wire_count; /* # of pages wired down */
	137	uint64_t zero_fill_count; /* # of zero fill pages */
	138	uint64_t reactivations; /* # of pages reactivated */
	139	uint64_t pageins; /* # of pageins */
	140	uint64_t pageouts; /* # of pageouts */
	141	uint64_t faults; /* # of faults */
	142	uint64_t cow_faults; /* # of copy-on-writes */
	143	uint64_t lookups; /* object cache lookups */
	144	uint64_t hits; /* object cache hits */
	145
	146	/* added for rev1 */
	147	uint64_t purges; /* # of pages purged */
	148	natural_t purgeable_count; /* # of pages purgeable */
	149
	150	/* added for rev2 */
	151	/*
	152	* NB: speculative pages are already accounted for in "free_count",
	153	* so "speculative_count" is the number of "free" pages that are
	154	* used to hold data that was read speculatively from disk but
	155	* haven't actually been used by anyone so far.
	156	*/
	157	natural_t speculative_count; /* # of pages speculative */
	158
6d2010ae	159	} __attribute__((aligned(8)));
b0d623f7 A	160
	161	typedef struct vm_statistics64 *vm_statistics64_t;
	162	typedef struct vm_statistics64 vm_statistics64_data_t;
	163
	164	/*
	165	* VM_STATISTICS_TRUNCATE_TO_32_BIT
	166	*
	167	* This is used by host_statistics() to truncate and peg the 64-bit in-kernel values from
	168	* vm_statistics64 to the 32-bit values of the older structure above (vm_statistics).
	169	*/
	170	#define VM_STATISTICS_TRUNCATE_TO_32_BIT(value) ((uint32_t)(((value) > UINT32_MAX ) ? UINT32_MAX : (value)))
	171
6d2010ae A	172	/*
	173	* vm_extmod_statistics
	174	*
	175	* Structure to record modifications to a task by an
	176	* external agent.
	177	*
	178	* History:
	179	* rev0 - original structure.
	180	*/
	181
	182	struct vm_extmod_statistics {
	183	int64_t task_for_pid_count; /* # of times task port was looked up */
	184	int64_t task_for_pid_caller_count; /* # of times this task called task_for_pid */
	185	int64_t thread_creation_count; /* # of threads created in task */
	186	int64_t thread_creation_caller_count; /* # of threads created by task */
	187	int64_t thread_set_state_count; /* # of register state sets in task */
	188	int64_t thread_set_state_caller_count; /* # of register state sets by task */
	189	} __attribute__((aligned(8)));
	190
	191	typedef struct vm_extmod_statistics *vm_extmod_statistics_t;
	192	typedef struct vm_extmod_statistics vm_extmod_statistics_data_t;
b0d623f7	193
1c79356b A	194
	195	/* included for the vm_map_page_query call */
	196
	197	#define VM_PAGE_QUERY_PAGE_PRESENT 0x1
	198	#define VM_PAGE_QUERY_PAGE_FICTITIOUS 0x2
	199	#define VM_PAGE_QUERY_PAGE_REF 0x4
	200	#define VM_PAGE_QUERY_PAGE_DIRTY 0x8
2d21ac55 A	201	#define VM_PAGE_QUERY_PAGE_PAGED_OUT 0x10
	202	#define VM_PAGE_QUERY_PAGE_COPIED 0x20
	203	#define VM_PAGE_QUERY_PAGE_SPECULATIVE 0x40
b0d623f7	204	#define VM_PAGE_QUERY_PAGE_EXTERNAL 0x80
593a1d5f A	205	#define VM_PAGE_QUERY_PAGE_CS_VALIDATED 0x100
593a1d5f A	206	#define VM_PAGE_QUERY_PAGE_CS_TAINTED 0x200
1c79356b	207
91447636	208	#ifdef MACH_KERNEL_PRIVATE
1c79356b A	209
	210	/*
	211	* Each machine dependent implementation is expected to
	212	* keep certain statistics. They may do this anyway they
	213	* so choose, but are expected to return the statistics
	214	* in the following structure.
	215	*/
	216
	217	struct pmap_statistics {
	218	integer_t resident_count; /* # of pages mapped (total)*/
2d21ac55	219	integer_t resident_max; /* # of pages mapped (peak) */
1c79356b A	220	integer_t wired_count; /* # of pages wired */
	221	};
	222
	223	typedef struct pmap_statistics *pmap_statistics_t;
	224
91447636 A	225	#endif /* MACH_KERNEL_PRIVATE */
	226
	227	/*
	228	* VM allocation flags:
	229	*
	230	* VM_FLAGS_FIXED
	231	* (really the absence of VM_FLAGS_ANYWHERE)
	232	* Allocate new VM region at the specified virtual address, if possible.
	233	*
	234	* VM_FLAGS_ANYWHERE
	235	* Allocate new VM region anywhere it would fit in the address space.
	236	*
	237	* VM_FLAGS_PURGABLE
	238	* Create a purgable VM object for that new VM region.
	239	*
	240	* VM_FLAGS_NO_PMAP_CHECK
	241	* (for DEBUG kernel config only, ignored for other configs)
	242	* Do not check that there is no stale pmap mapping for the new VM region.
	243	* This is useful for kernel memory allocations at bootstrap when building
	244	* the initial kernel address space while some memory is already in use.
	245	*
	246	* VM_FLAGS_OVERWRITE
	247	* The new VM region can replace existing VM regions if necessary
	248	* (to be used in combination with VM_FLAGS_FIXED).
2d21ac55 A	249	*
	250	* VM_FLAGS_NO_CACHE
	251	* Pages brought in to this VM region are placed on the speculative
	252	* queue instead of the active queue. In other words, they are not
	253	* cached so that they will be stolen first if memory runs low.
91447636 A	254	*/
	255	#define VM_FLAGS_FIXED 0x0000
	256	#define VM_FLAGS_ANYWHERE 0x0001
	257	#define VM_FLAGS_PURGABLE 0x0002
2d21ac55	258	#define VM_FLAGS_NO_CACHE 0x0010
91447636	259	#ifdef KERNEL_PRIVATE
b0d623f7 A	260	#define VM_FLAGS_PERMANENT 0x0100 /* mapping can NEVER be unmapped */
	261	#define VM_FLAGS_GUARD_AFTER 0x0200 /* guard page after the mapping */
	262	#define VM_FLAGS_GUARD_BEFORE 0x0400 /* guard page before the mapping */
2d21ac55	263	#define VM_FLAGS_SUBMAP 0x0800 /* mapping a VM submap */
b0d623f7 A	264	#define VM_FLAGS_ALREADY 0x1000 /* OK if same mapping already exists */
b0d623f7 A	265	#define VM_FLAGS_BEYOND_MAX 0x2000 /* map beyond the map's max offset */
060df5ea	266	#endif /* KERNEL_PRIVATE */
b0d623f7	267	#define VM_FLAGS_OVERWRITE 0x4000 /* delete any existing mappings first */
060df5ea	268	#ifdef KERNEL_PRIVATE
b0d623f7	269	#define VM_FLAGS_NO_PMAP_CHECK 0x8000 /* do not check that pmap is empty */
6d2010ae	270	#define VM_FLAGS_MAP_JIT 0x80000 /* Used to mark an entry as describing a JIT region */
91447636	271	#endif /* KERNEL_PRIVATE */
b0d623f7 A	272
	273	/*
	274	* VM_FLAGS_SUPERPAGE_MASK
	275	* 3 bits that specify whether large pages should be used instead of
	276	* base pages (!=0), as well as the requested page size.
	277	*/
	278	#define VM_FLAGS_SUPERPAGE_MASK 0x70000 /* bits 0x10000, 0x20000, 0x40000 */
	279	#define VM_FLAGS_SUPERPAGE_SHIFT 16
	280
	281	#define SUPERPAGE_NONE 0 /* no superpages, if all bits are 0 */
6d2010ae A	282	#define SUPERPAGE_SIZE_ANY 1
	283	#define VM_FLAGS_SUPERPAGE_NONE (SUPERPAGE_NONE << VM_FLAGS_SUPERPAGE_SHIFT)
	284	#define VM_FLAGS_SUPERPAGE_SIZE_ANY (SUPERPAGE_SIZE_ANY << VM_FLAGS_SUPERPAGE_SHIFT)
b0d623f7	285	#if defined(__x86_64__) \|\| !defined(KERNEL)
6d2010ae A	286	#define SUPERPAGE_SIZE_2MB 2
6d2010ae A	287	#define VM_FLAGS_SUPERPAGE_SIZE_2MB (SUPERPAGE_SIZE_2MB<<VM_FLAGS_SUPERPAGE_SHIFT)
b0d623f7	288	#endif
91447636	289
1c79356b A	290	#define VM_FLAGS_ALIAS_MASK 0xFF000000
	291	#define VM_GET_FLAGS_ALIAS(flags, alias) \
	292	(alias) = ((flags) & VM_FLAGS_ALIAS_MASK) >> 24
	293	#define VM_SET_FLAGS_ALIAS(flags, alias) \
	294	(flags) = (((flags) & ~VM_FLAGS_ALIAS_MASK) \| \
	295	(((alias) & ~VM_FLAGS_ALIAS_MASK) << 24))
	296
2d21ac55 A	297	/* These are the flags that we accept from user-space */
	298	#define VM_FLAGS_USER_ALLOCATE (VM_FLAGS_FIXED \| \
	299	VM_FLAGS_ANYWHERE \| \
	300	VM_FLAGS_PURGABLE \| \
	301	VM_FLAGS_NO_CACHE \| \
060df5ea	302	VM_FLAGS_OVERWRITE \| \
b0d623f7	303	VM_FLAGS_SUPERPAGE_MASK \| \
2d21ac55 A	304	VM_FLAGS_ALIAS_MASK)
2d21ac55 A	305	#define VM_FLAGS_USER_MAP VM_FLAGS_USER_ALLOCATE
060df5ea A	306	#define VM_FLAGS_USER_REMAP (VM_FLAGS_FIXED \| \
	307	VM_FLAGS_ANYWHERE \| \
	308	VM_FLAGS_OVERWRITE)
2d21ac55	309
1c79356b A	310	#define VM_MEMORY_MALLOC 1
	311	#define VM_MEMORY_MALLOC_SMALL 2
	312	#define VM_MEMORY_MALLOC_LARGE 3
	313	#define VM_MEMORY_MALLOC_HUGE 4
	314	#define VM_MEMORY_SBRK 5// uninteresting -- no one should call
55e303ae A	315	#define VM_MEMORY_REALLOC 6
55e303ae A	316	#define VM_MEMORY_MALLOC_TINY 7
b0d623f7 A	317	#define VM_MEMORY_MALLOC_LARGE_REUSABLE 8
b0d623f7 A	318	#define VM_MEMORY_MALLOC_LARGE_REUSED 9
1c79356b A	319
	320	#define VM_MEMORY_ANALYSIS_TOOL 10
	321
	322	#define VM_MEMORY_MACH_MSG 20
	323	#define VM_MEMORY_IOKIT 21
	324	#define VM_MEMORY_STACK 30
	325	#define VM_MEMORY_GUARD 31
	326	#define VM_MEMORY_SHARED_PMAP 32
	327	/* memory containing a dylib */
	328	#define VM_MEMORY_DYLIB 33
b0d623f7	329	#define VM_MEMORY_OBJC_DISPATCHERS 34
1c79356b A	330
	331	// Placeholders for now -- as we analyze the libraries and find how they
	332	// use memory, we can make these labels more specific.
	333	#define VM_MEMORY_APPKIT 40
	334	#define VM_MEMORY_FOUNDATION 41
	335	#define VM_MEMORY_COREGRAPHICS 42
	336	#define VM_MEMORY_CARBON 43
9bccf70c	337	#define VM_MEMORY_JAVA 44
1c79356b	338	#define VM_MEMORY_ATS 50
2d21ac55 A	339	#define VM_MEMORY_LAYERKIT 51
	340	#define VM_MEMORY_CGIMAGE 52
	341	#define VM_MEMORY_TCMALLOC 53
	342
	343	/* private raster data (i.e. layers, some images, QGL allocator) */
	344	#define VM_MEMORY_COREGRAPHICS_DATA 54
	345
	346	/* shared image and font caches */
	347	#define VM_MEMORY_COREGRAPHICS_SHARED 55
	348
	349	/* Memory used for virtual framebuffers, shadowing buffers, etc... */
	350	#define VM_MEMORY_COREGRAPHICS_FRAMEBUFFERS 56
	351
	352	/* Window backing stores, custom shadow data, and compressed backing stores */
	353	#define VM_MEMORY_COREGRAPHICS_BACKINGSTORES 57
	354
	355	/* catch-all for other uses, such as the read-only shared data page */
	356	#define VM_MEMORY_COREGRAPHICS_MISC VM_MEMORY_COREGRAPHICS
1c79356b	357
1c79356b A	358	/* memory allocated by the dynamic loader for itself */
	359	#define VM_MEMORY_DYLD 60
	360	/* malloc'd memory created by dyld */
	361	#define VM_MEMORY_DYLD_MALLOC 61
	362
b0d623f7 A	363	/* Used for sqlite page cache */
	364	#define VM_MEMORY_SQLITE 62
	365
	366	/* JavaScriptCore heaps */
	367	#define VM_MEMORY_JAVASCRIPT_CORE 63
	368	/* memory allocated for the JIT */
	369	#define VM_MEMORY_JAVASCRIPT_JIT_EXECUTABLE_ALLOCATOR 64
	370	#define VM_MEMORY_JAVASCRIPT_JIT_REGISTER_FILE 65
	371
	372	/* memory allocated for GLSL */
	373	#define VM_MEMORY_GLSL 66
	374
6d2010ae A	375	/* memory allocated for OpenCL.framework */
	376	#define VM_MEMORY_OPENCL 67
	377
	378	/* memory allocated for QuartzCore.framework */
	379	#define VM_MEMORY_COREIMAGE 68
	380
	381	/* memory allocated for WebCore Purgeable Buffers */
	382	#define VM_MEMORY_WEBCORE_PURGEABLE_BUFFERS 69
	383
	384	/* ImageIO memory */
	385	#define VM_MEMORY_IMAGEIO 70
	386
	387	/* CoreProfile memory */
	388	#define VM_MEMORY_COREPROFILE 71
	389
	390	/* assetsd / MobileSlideShow memory */
	391	#define VM_MEMORY_ASSETSD 72
	392
1c79356b A	393	/* Reserve 240-255 for application */
	394	#define VM_MEMORY_APPLICATION_SPECIFIC_1 240
	395	#define VM_MEMORY_APPLICATION_SPECIFIC_16 255
	396
2d21ac55	397	#define VM_MAKE_TAG(tag) ((tag) << 24)
91447636 A	398
91447636 A	399	#endif /* _MACH_VM_STATISTICS_H_ */