[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 */
	uint64_t	purges;			/* # of pages purged */
	natural_t	purgeable_count;	/* # of pages purgeable */
	/*
	 * 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 */

	/* added for rev1 */
	uint64_t	decompressions;		/* # of pages decompressed */
	uint64_t	compressions;		/* # of pages compressed */
	uint64_t	swapins;		/* # of pages swapped in (via compression segments) */
	uint64_t	swapouts;		/* # of pages swapped out (via compression segments) */
	natural_t	compressor_page_count;	/* # of pages used by the compressed pager to hold all the compressed data */
	natural_t	throttled_count;	/* # of pages throttled */
	natural_t	external_page_count;	/* # of pages that are file-backed (non-swap) */
	natural_t	internal_page_count;	/* # of pages that are anonymous */
	uint64_t	total_uncompressed_pages_in_compressor; /* # of pages (uncompressed) held within the compressor. */
} __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;

typedef struct vm_purgeable_stat {
	uint64_t	count;
	uint64_t	size;
}vm_purgeable_stat_t;

struct vm_purgeable_info {
	vm_purgeable_stat_t fifo_data[8];
	vm_purgeable_stat_t obsolete_data;
	vm_purgeable_stat_t lifo_data[8];
};

typedef struct vm_purgeable_info	*vm_purgeable_info_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 */

	integer_t	device;
	integer_t	device_peak;
	integer_t	internal;
	integer_t	internal_peak;
	integer_t	external;
	integer_t	external_peak;
	integer_t	reusable;
	integer_t	reusable_peak;
	uint64_t	compressed;
	uint64_t	compressed_peak;
	uint64_t	compressed_lifetime;
};

typedef struct pmap_statistics	*pmap_statistics_t;

#define PMAP_STATS_PEAK(field)			\
	MACRO_BEGIN				\
	if (field > field##_peak) {		\
		field##_peak = field;		\
	}					\
	MACRO_END

#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 */
#define VM_FLAGS_RETURN_DATA_ADDR	0x100000 /* Return address of target data, rather than base of page */
/*
 * 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 | VM_FLAGS_RETURN_DATA_ADDR)
#define VM_FLAGS_USER_REMAP	(VM_FLAGS_FIXED |    \
				 VM_FLAGS_ANYWHERE | \
				 VM_FLAGS_OVERWRITE| \
				 VM_FLAGS_RETURN_DATA_ADDR)

#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_MALLOC_NANO 11

#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

/* Was a nested pmap (VM_MEMORY_SHARED_PMAP) which has now been unnested */
#define	VM_MEMORY_UNSHARED_PMAP	35


// 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_CORESERVICES 43
#define VM_MEMORY_CARBON VM_MEMORY_CORESERVICES
#define VM_MEMORY_JAVA 44
#define VM_MEMORY_COREDATA 45
#define VM_MEMORY_COREDATA_OBJECTIDS 46
#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

/* libsystem_kernel os_once_alloc */
#define VM_MEMORY_OS_ALLOC_ONCE 73

/* libdispatch internal allocator */
#define VM_MEMORY_LIBDISPATCH 74

/* Accelerate.framework image backing stores */
#define VM_MEMORY_ACCELERATE 75

/* CoreUI image block data */
#define VM_MEMORY_COREUI 76

/* 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 */
b0d623f7 A	145	uint64_t purges; /* # of pages purged */
b0d623f7 A	146	natural_t purgeable_count; /* # of pages purgeable */
b0d623f7 A	147	/*
	148	* NB: speculative pages are already accounted for in "free_count",
	149	* so "speculative_count" is the number of "free" pages that are
	150	* used to hold data that was read speculatively from disk but
	151	* haven't actually been used by anyone so far.
	152	*/
	153	natural_t speculative_count; /* # of pages speculative */
	154
39236c6e A	155	/* added for rev1 */
	156	uint64_t decompressions; /* # of pages decompressed */
	157	uint64_t compressions; /* # of pages compressed */
	158	uint64_t swapins; /* # of pages swapped in (via compression segments) */
	159	uint64_t swapouts; /* # of pages swapped out (via compression segments) */
	160	natural_t compressor_page_count; /* # of pages used by the compressed pager to hold all the compressed data */
	161	natural_t throttled_count; /* # of pages throttled */
	162	natural_t external_page_count; /* # of pages that are file-backed (non-swap) */
	163	natural_t internal_page_count; /* # of pages that are anonymous */
	164	uint64_t total_uncompressed_pages_in_compressor; /* # of pages (uncompressed) held within the compressor. */
6d2010ae	165	} __attribute__((aligned(8)));
b0d623f7 A	166
	167	typedef struct vm_statistics64 *vm_statistics64_t;
	168	typedef struct vm_statistics64 vm_statistics64_data_t;
	169
	170	/*
	171	* VM_STATISTICS_TRUNCATE_TO_32_BIT
	172	*
	173	* This is used by host_statistics() to truncate and peg the 64-bit in-kernel values from
	174	* vm_statistics64 to the 32-bit values of the older structure above (vm_statistics).
	175	*/
	176	#define VM_STATISTICS_TRUNCATE_TO_32_BIT(value) ((uint32_t)(((value) > UINT32_MAX ) ? UINT32_MAX : (value)))
	177
6d2010ae A	178	/*
	179	* vm_extmod_statistics
	180	*
	181	* Structure to record modifications to a task by an
	182	* external agent.
	183	*
	184	* History:
	185	* rev0 - original structure.
	186	*/
	187
	188	struct vm_extmod_statistics {
	189	int64_t task_for_pid_count; /* # of times task port was looked up */
	190	int64_t task_for_pid_caller_count; /* # of times this task called task_for_pid */
	191	int64_t thread_creation_count; /* # of threads created in task */
	192	int64_t thread_creation_caller_count; /* # of threads created by task */
	193	int64_t thread_set_state_count; /* # of register state sets in task */
	194	int64_t thread_set_state_caller_count; /* # of register state sets by task */
	195	} __attribute__((aligned(8)));
	196
	197	typedef struct vm_extmod_statistics *vm_extmod_statistics_t;
	198	typedef struct vm_extmod_statistics vm_extmod_statistics_data_t;
b0d623f7	199
39236c6e A	200	typedef struct vm_purgeable_stat {
	201	uint64_t count;
	202	uint64_t size;
	203	}vm_purgeable_stat_t;
	204
	205	struct vm_purgeable_info {
	206	vm_purgeable_stat_t fifo_data[8];
	207	vm_purgeable_stat_t obsolete_data;
	208	vm_purgeable_stat_t lifo_data[8];
	209	};
	210
	211	typedef struct vm_purgeable_info *vm_purgeable_info_t;
1c79356b A	212
	213	/* included for the vm_map_page_query call */
	214
	215	#define VM_PAGE_QUERY_PAGE_PRESENT 0x1
	216	#define VM_PAGE_QUERY_PAGE_FICTITIOUS 0x2
	217	#define VM_PAGE_QUERY_PAGE_REF 0x4
	218	#define VM_PAGE_QUERY_PAGE_DIRTY 0x8
2d21ac55 A	219	#define VM_PAGE_QUERY_PAGE_PAGED_OUT 0x10
	220	#define VM_PAGE_QUERY_PAGE_COPIED 0x20
	221	#define VM_PAGE_QUERY_PAGE_SPECULATIVE 0x40
b0d623f7	222	#define VM_PAGE_QUERY_PAGE_EXTERNAL 0x80
593a1d5f A	223	#define VM_PAGE_QUERY_PAGE_CS_VALIDATED 0x100
593a1d5f A	224	#define VM_PAGE_QUERY_PAGE_CS_TAINTED 0x200
1c79356b	225
91447636	226	#ifdef MACH_KERNEL_PRIVATE
1c79356b A	227
	228	/*
	229	* Each machine dependent implementation is expected to
	230	* keep certain statistics. They may do this anyway they
	231	* so choose, but are expected to return the statistics
	232	* in the following structure.
	233	*/
	234
	235	struct pmap_statistics {
	236	integer_t resident_count; /* # of pages mapped (total)*/
2d21ac55	237	integer_t resident_max; /* # of pages mapped (peak) */
1c79356b	238	integer_t wired_count; /* # of pages wired */
39236c6e A	239
	240	integer_t device;
	241	integer_t device_peak;
	242	integer_t internal;
	243	integer_t internal_peak;
	244	integer_t external;
	245	integer_t external_peak;
	246	integer_t reusable;
	247	integer_t reusable_peak;
	248	uint64_t compressed;
	249	uint64_t compressed_peak;
	250	uint64_t compressed_lifetime;
1c79356b A	251	};
	252
	253	typedef struct pmap_statistics *pmap_statistics_t;
	254
39236c6e A	255	#define PMAP_STATS_PEAK(field) \
	256	MACRO_BEGIN \
	257	if (field > field##_peak) { \
	258	field##_peak = field; \
	259	} \
	260	MACRO_END
	261
91447636 A	262	#endif /* MACH_KERNEL_PRIVATE */
	263
	264	/*
	265	* VM allocation flags:
	266	*
	267	* VM_FLAGS_FIXED
	268	* (really the absence of VM_FLAGS_ANYWHERE)
	269	* Allocate new VM region at the specified virtual address, if possible.
	270	*
	271	* VM_FLAGS_ANYWHERE
	272	* Allocate new VM region anywhere it would fit in the address space.
	273	*
	274	* VM_FLAGS_PURGABLE
	275	* Create a purgable VM object for that new VM region.
	276	*
	277	* VM_FLAGS_NO_PMAP_CHECK
	278	* (for DEBUG kernel config only, ignored for other configs)
	279	* Do not check that there is no stale pmap mapping for the new VM region.
	280	* This is useful for kernel memory allocations at bootstrap when building
	281	* the initial kernel address space while some memory is already in use.
	282	*
	283	* VM_FLAGS_OVERWRITE
	284	* The new VM region can replace existing VM regions if necessary
	285	* (to be used in combination with VM_FLAGS_FIXED).
2d21ac55 A	286	*
	287	* VM_FLAGS_NO_CACHE
	288	* Pages brought in to this VM region are placed on the speculative
	289	* queue instead of the active queue. In other words, they are not
	290	* cached so that they will be stolen first if memory runs low.
91447636 A	291	*/
	292	#define VM_FLAGS_FIXED 0x0000
	293	#define VM_FLAGS_ANYWHERE 0x0001
	294	#define VM_FLAGS_PURGABLE 0x0002
2d21ac55	295	#define VM_FLAGS_NO_CACHE 0x0010
91447636	296	#ifdef KERNEL_PRIVATE
b0d623f7 A	297	#define VM_FLAGS_PERMANENT 0x0100 /* mapping can NEVER be unmapped */
	298	#define VM_FLAGS_GUARD_AFTER 0x0200 /* guard page after the mapping */
	299	#define VM_FLAGS_GUARD_BEFORE 0x0400 /* guard page before the mapping */
2d21ac55	300	#define VM_FLAGS_SUBMAP 0x0800 /* mapping a VM submap */
b0d623f7 A	301	#define VM_FLAGS_ALREADY 0x1000 /* OK if same mapping already exists */
b0d623f7 A	302	#define VM_FLAGS_BEYOND_MAX 0x2000 /* map beyond the map's max offset */
060df5ea	303	#endif /* KERNEL_PRIVATE */
b0d623f7	304	#define VM_FLAGS_OVERWRITE 0x4000 /* delete any existing mappings first */
060df5ea	305	#ifdef KERNEL_PRIVATE
b0d623f7	306	#define VM_FLAGS_NO_PMAP_CHECK 0x8000 /* do not check that pmap is empty */
6d2010ae	307	#define VM_FLAGS_MAP_JIT 0x80000 /* Used to mark an entry as describing a JIT region */
91447636	308	#endif /* KERNEL_PRIVATE */
39236c6e	309	#define VM_FLAGS_RETURN_DATA_ADDR 0x100000 /* Return address of target data, rather than base of page */
b0d623f7 A	310	/*
	311	* VM_FLAGS_SUPERPAGE_MASK
	312	* 3 bits that specify whether large pages should be used instead of
	313	* base pages (!=0), as well as the requested page size.
	314	*/
	315	#define VM_FLAGS_SUPERPAGE_MASK 0x70000 /* bits 0x10000, 0x20000, 0x40000 */
	316	#define VM_FLAGS_SUPERPAGE_SHIFT 16
	317
	318	#define SUPERPAGE_NONE 0 /* no superpages, if all bits are 0 */
6d2010ae A	319	#define SUPERPAGE_SIZE_ANY 1
	320	#define VM_FLAGS_SUPERPAGE_NONE (SUPERPAGE_NONE << VM_FLAGS_SUPERPAGE_SHIFT)
	321	#define VM_FLAGS_SUPERPAGE_SIZE_ANY (SUPERPAGE_SIZE_ANY << VM_FLAGS_SUPERPAGE_SHIFT)
b0d623f7	322	#if defined(__x86_64__) \|\| !defined(KERNEL)
6d2010ae A	323	#define SUPERPAGE_SIZE_2MB 2
6d2010ae A	324	#define VM_FLAGS_SUPERPAGE_SIZE_2MB (SUPERPAGE_SIZE_2MB<<VM_FLAGS_SUPERPAGE_SHIFT)
b0d623f7	325	#endif
91447636	326
1c79356b A	327	#define VM_FLAGS_ALIAS_MASK 0xFF000000
	328	#define VM_GET_FLAGS_ALIAS(flags, alias) \
	329	(alias) = ((flags) & VM_FLAGS_ALIAS_MASK) >> 24
	330	#define VM_SET_FLAGS_ALIAS(flags, alias) \
	331	(flags) = (((flags) & ~VM_FLAGS_ALIAS_MASK) \| \
	332	(((alias) & ~VM_FLAGS_ALIAS_MASK) << 24))
	333
2d21ac55 A	334	/* These are the flags that we accept from user-space */
	335	#define VM_FLAGS_USER_ALLOCATE (VM_FLAGS_FIXED \| \
	336	VM_FLAGS_ANYWHERE \| \
	337	VM_FLAGS_PURGABLE \| \
	338	VM_FLAGS_NO_CACHE \| \
060df5ea	339	VM_FLAGS_OVERWRITE \| \
b0d623f7	340	VM_FLAGS_SUPERPAGE_MASK \| \
2d21ac55	341	VM_FLAGS_ALIAS_MASK)
39236c6e	342	#define VM_FLAGS_USER_MAP (VM_FLAGS_USER_ALLOCATE \| VM_FLAGS_RETURN_DATA_ADDR)
060df5ea A	343	#define VM_FLAGS_USER_REMAP (VM_FLAGS_FIXED \| \
060df5ea A	344	VM_FLAGS_ANYWHERE \| \
39236c6e A	345	VM_FLAGS_OVERWRITE\| \
39236c6e A	346	VM_FLAGS_RETURN_DATA_ADDR)
2d21ac55	347
1c79356b A	348	#define VM_MEMORY_MALLOC 1
	349	#define VM_MEMORY_MALLOC_SMALL 2
	350	#define VM_MEMORY_MALLOC_LARGE 3
	351	#define VM_MEMORY_MALLOC_HUGE 4
	352	#define VM_MEMORY_SBRK 5// uninteresting -- no one should call
55e303ae A	353	#define VM_MEMORY_REALLOC 6
55e303ae A	354	#define VM_MEMORY_MALLOC_TINY 7
b0d623f7 A	355	#define VM_MEMORY_MALLOC_LARGE_REUSABLE 8
b0d623f7 A	356	#define VM_MEMORY_MALLOC_LARGE_REUSED 9
1c79356b A	357
	358	#define VM_MEMORY_ANALYSIS_TOOL 10
	359
39236c6e A	360	#define VM_MEMORY_MALLOC_NANO 11
39236c6e A	361
1c79356b A	362	#define VM_MEMORY_MACH_MSG 20
	363	#define VM_MEMORY_IOKIT 21
	364	#define VM_MEMORY_STACK 30
	365	#define VM_MEMORY_GUARD 31
	366	#define VM_MEMORY_SHARED_PMAP 32
	367	/* memory containing a dylib */
	368	#define VM_MEMORY_DYLIB 33
b0d623f7	369	#define VM_MEMORY_OBJC_DISPATCHERS 34
1c79356b	370
316670eb A	371	/* Was a nested pmap (VM_MEMORY_SHARED_PMAP) which has now been unnested */
	372	#define VM_MEMORY_UNSHARED_PMAP 35
	373
	374
1c79356b A	375	// Placeholders for now -- as we analyze the libraries and find how they
	376	// use memory, we can make these labels more specific.
	377	#define VM_MEMORY_APPKIT 40
	378	#define VM_MEMORY_FOUNDATION 41
	379	#define VM_MEMORY_COREGRAPHICS 42
316670eb A	380	#define VM_MEMORY_CORESERVICES 43
316670eb A	381	#define VM_MEMORY_CARBON VM_MEMORY_CORESERVICES
9bccf70c	382	#define VM_MEMORY_JAVA 44
39236c6e A	383	#define VM_MEMORY_COREDATA 45
39236c6e A	384	#define VM_MEMORY_COREDATA_OBJECTIDS 46
1c79356b	385	#define VM_MEMORY_ATS 50
2d21ac55 A	386	#define VM_MEMORY_LAYERKIT 51
	387	#define VM_MEMORY_CGIMAGE 52
	388	#define VM_MEMORY_TCMALLOC 53
	389
	390	/* private raster data (i.e. layers, some images, QGL allocator) */
	391	#define VM_MEMORY_COREGRAPHICS_DATA 54
	392
	393	/* shared image and font caches */
	394	#define VM_MEMORY_COREGRAPHICS_SHARED 55
	395
	396	/* Memory used for virtual framebuffers, shadowing buffers, etc... */
	397	#define VM_MEMORY_COREGRAPHICS_FRAMEBUFFERS 56
	398
	399	/* Window backing stores, custom shadow data, and compressed backing stores */
	400	#define VM_MEMORY_COREGRAPHICS_BACKINGSTORES 57
	401
	402	/* catch-all for other uses, such as the read-only shared data page */
	403	#define VM_MEMORY_COREGRAPHICS_MISC VM_MEMORY_COREGRAPHICS
1c79356b	404
1c79356b A	405	/* memory allocated by the dynamic loader for itself */
	406	#define VM_MEMORY_DYLD 60
	407	/* malloc'd memory created by dyld */
	408	#define VM_MEMORY_DYLD_MALLOC 61
	409
b0d623f7 A	410	/* Used for sqlite page cache */
	411	#define VM_MEMORY_SQLITE 62
	412
	413	/* JavaScriptCore heaps */
	414	#define VM_MEMORY_JAVASCRIPT_CORE 63
	415	/* memory allocated for the JIT */
	416	#define VM_MEMORY_JAVASCRIPT_JIT_EXECUTABLE_ALLOCATOR 64
	417	#define VM_MEMORY_JAVASCRIPT_JIT_REGISTER_FILE 65
	418
	419	/* memory allocated for GLSL */
	420	#define VM_MEMORY_GLSL 66
	421
6d2010ae A	422	/* memory allocated for OpenCL.framework */
	423	#define VM_MEMORY_OPENCL 67
	424
	425	/* memory allocated for QuartzCore.framework */
	426	#define VM_MEMORY_COREIMAGE 68
	427
	428	/* memory allocated for WebCore Purgeable Buffers */
	429	#define VM_MEMORY_WEBCORE_PURGEABLE_BUFFERS 69
	430
	431	/* ImageIO memory */
	432	#define VM_MEMORY_IMAGEIO 70
	433
	434	/* CoreProfile memory */
	435	#define VM_MEMORY_COREPROFILE 71
	436
	437	/* assetsd / MobileSlideShow memory */
316670eb	438	#define VM_MEMORY_ASSETSD 72
6d2010ae	439
39236c6e A	440	/* libsystem_kernel os_once_alloc */
	441	#define VM_MEMORY_OS_ALLOC_ONCE 73
	442
	443	/* libdispatch internal allocator */
	444	#define VM_MEMORY_LIBDISPATCH 74
	445
	446	/* Accelerate.framework image backing stores */
	447	#define VM_MEMORY_ACCELERATE 75
	448
	449	/* CoreUI image block data */
	450	#define VM_MEMORY_COREUI 76
	451
1c79356b A	452	/* Reserve 240-255 for application */
	453	#define VM_MEMORY_APPLICATION_SPECIFIC_1 240
	454	#define VM_MEMORY_APPLICATION_SPECIFIC_16 255
	455
2d21ac55	456	#define VM_MAKE_TAG(tag) ((tag) << 24)
91447636 A	457
91447636 A	458	#endif /* _MACH_VM_STATISTICS_H_ */