2 * Copyright (c) 2000-2009 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
34 * All Rights Reserved.
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.
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.
46 * Carnegie Mellon requests users of this software to return to
48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
59 * File: mach/vm_statistics.h
60 * Author: Avadis Tevanian, Jr., Michael Wayne Young, David Golub
62 * Virtual memory statistics structure.
66 #ifndef _MACH_VM_STATISTICS_H_
67 #define _MACH_VM_STATISTICS_H_
69 #include <mach/machine/vm_types.h>
76 * rev0 - original structure.
77 * rev1 - added purgable info (purgable_count and purges).
78 * rev2 - added speculative_count.
80 * Note: you cannot add any new fields to this structure. Add them below in
84 struct vm_statistics
{
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 */
99 natural_t purgeable_count
; /* # of pages purgeable */
100 natural_t purges
; /* # of pages purged */
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.
109 natural_t speculative_count
; /* # of pages speculative */
112 /* Used by all architectures */
113 typedef struct vm_statistics
*vm_statistics_t
;
114 typedef struct vm_statistics vm_statistics_data_t
;
120 * rev0 - original structure.
121 * rev1 - added purgable info (purgable_count and purges).
122 * rev2 - added speculative_count.
124 * rev3 - changed name to vm_statistics64.
125 * changed some fields in structure to 64-bit on
126 * arm, i386 and x86_64 architectures.
127 * rev4 - require 64-bit alignment for efficient access
128 * in the kernel. No change to reported data.
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 */
147 uint64_t purges
; /* # of pages purged */
148 natural_t purgeable_count
; /* # of pages purgeable */
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.
157 natural_t speculative_count
; /* # of pages speculative */
159 } __attribute__((aligned(8)));
161 typedef struct vm_statistics64
*vm_statistics64_t
;
162 typedef struct vm_statistics64 vm_statistics64_data_t
;
165 * VM_STATISTICS_TRUNCATE_TO_32_BIT
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).
170 #define VM_STATISTICS_TRUNCATE_TO_32_BIT(value) ((uint32_t)(((value) > UINT32_MAX ) ? UINT32_MAX : (value)))
173 * vm_extmod_statistics
175 * Structure to record modifications to a task by an
179 * rev0 - original structure.
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)));
191 typedef struct vm_extmod_statistics
*vm_extmod_statistics_t
;
192 typedef struct vm_extmod_statistics vm_extmod_statistics_data_t
;
195 /* included for the vm_map_page_query call */
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
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
204 #define VM_PAGE_QUERY_PAGE_EXTERNAL 0x80
205 #define VM_PAGE_QUERY_PAGE_CS_VALIDATED 0x100
206 #define VM_PAGE_QUERY_PAGE_CS_TAINTED 0x200
208 #ifdef MACH_KERNEL_PRIVATE
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.
217 struct pmap_statistics
{
218 integer_t resident_count
; /* # of pages mapped (total)*/
219 integer_t resident_max
; /* # of pages mapped (peak) */
220 integer_t wired_count
; /* # of pages wired */
223 typedef struct pmap_statistics
*pmap_statistics_t
;
225 #endif /* MACH_KERNEL_PRIVATE */
228 * VM allocation flags:
231 * (really the absence of VM_FLAGS_ANYWHERE)
232 * Allocate new VM region at the specified virtual address, if possible.
235 * Allocate new VM region anywhere it would fit in the address space.
238 * Create a purgable VM object for that new VM region.
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.
247 * The new VM region can replace existing VM regions if necessary
248 * (to be used in combination with VM_FLAGS_FIXED).
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.
255 #define VM_FLAGS_FIXED 0x0000
256 #define VM_FLAGS_ANYWHERE 0x0001
257 #define VM_FLAGS_PURGABLE 0x0002
258 #define VM_FLAGS_NO_CACHE 0x0010
259 #ifdef KERNEL_PRIVATE
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 */
263 #define VM_FLAGS_SUBMAP 0x0800 /* mapping a VM submap */
264 #define VM_FLAGS_ALREADY 0x1000 /* OK if same mapping already exists */
265 #define VM_FLAGS_BEYOND_MAX 0x2000 /* map beyond the map's max offset */
266 #endif /* KERNEL_PRIVATE */
267 #define VM_FLAGS_OVERWRITE 0x4000 /* delete any existing mappings first */
268 #ifdef KERNEL_PRIVATE
269 #define VM_FLAGS_NO_PMAP_CHECK 0x8000 /* do not check that pmap is empty */
270 #define VM_FLAGS_MAP_JIT 0x80000 /* Used to mark an entry as describing a JIT region */
271 #endif /* KERNEL_PRIVATE */
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.
278 #define VM_FLAGS_SUPERPAGE_MASK 0x70000 /* bits 0x10000, 0x20000, 0x40000 */
279 #define VM_FLAGS_SUPERPAGE_SHIFT 16
281 #define SUPERPAGE_NONE 0 /* no superpages, if all bits are 0 */
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)
285 #if defined(__x86_64__) || !defined(KERNEL)
286 #define SUPERPAGE_SIZE_2MB 2
287 #define VM_FLAGS_SUPERPAGE_SIZE_2MB (SUPERPAGE_SIZE_2MB<<VM_FLAGS_SUPERPAGE_SHIFT)
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))
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 | \
302 VM_FLAGS_OVERWRITE | \
303 VM_FLAGS_SUPERPAGE_MASK | \
305 #define VM_FLAGS_USER_MAP VM_FLAGS_USER_ALLOCATE
306 #define VM_FLAGS_USER_REMAP (VM_FLAGS_FIXED | \
307 VM_FLAGS_ANYWHERE | \
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
315 #define VM_MEMORY_REALLOC 6
316 #define VM_MEMORY_MALLOC_TINY 7
317 #define VM_MEMORY_MALLOC_LARGE_REUSABLE 8
318 #define VM_MEMORY_MALLOC_LARGE_REUSED 9
320 #define VM_MEMORY_ANALYSIS_TOOL 10
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
329 #define VM_MEMORY_OBJC_DISPATCHERS 34
331 /* Was a nested pmap (VM_MEMORY_SHARED_PMAP) which has now been unnested */
332 #define VM_MEMORY_UNSHARED_PMAP 35
335 // Placeholders for now -- as we analyze the libraries and find how they
336 // use memory, we can make these labels more specific.
337 #define VM_MEMORY_APPKIT 40
338 #define VM_MEMORY_FOUNDATION 41
339 #define VM_MEMORY_COREGRAPHICS 42
340 #define VM_MEMORY_CORESERVICES 43
341 #define VM_MEMORY_CARBON VM_MEMORY_CORESERVICES
342 #define VM_MEMORY_JAVA 44
343 #define VM_MEMORY_ATS 50
344 #define VM_MEMORY_LAYERKIT 51
345 #define VM_MEMORY_CGIMAGE 52
346 #define VM_MEMORY_TCMALLOC 53
348 /* private raster data (i.e. layers, some images, QGL allocator) */
349 #define VM_MEMORY_COREGRAPHICS_DATA 54
351 /* shared image and font caches */
352 #define VM_MEMORY_COREGRAPHICS_SHARED 55
354 /* Memory used for virtual framebuffers, shadowing buffers, etc... */
355 #define VM_MEMORY_COREGRAPHICS_FRAMEBUFFERS 56
357 /* Window backing stores, custom shadow data, and compressed backing stores */
358 #define VM_MEMORY_COREGRAPHICS_BACKINGSTORES 57
360 /* catch-all for other uses, such as the read-only shared data page */
361 #define VM_MEMORY_COREGRAPHICS_MISC VM_MEMORY_COREGRAPHICS
363 /* memory allocated by the dynamic loader for itself */
364 #define VM_MEMORY_DYLD 60
365 /* malloc'd memory created by dyld */
366 #define VM_MEMORY_DYLD_MALLOC 61
368 /* Used for sqlite page cache */
369 #define VM_MEMORY_SQLITE 62
371 /* JavaScriptCore heaps */
372 #define VM_MEMORY_JAVASCRIPT_CORE 63
373 /* memory allocated for the JIT */
374 #define VM_MEMORY_JAVASCRIPT_JIT_EXECUTABLE_ALLOCATOR 64
375 #define VM_MEMORY_JAVASCRIPT_JIT_REGISTER_FILE 65
377 /* memory allocated for GLSL */
378 #define VM_MEMORY_GLSL 66
380 /* memory allocated for OpenCL.framework */
381 #define VM_MEMORY_OPENCL 67
383 /* memory allocated for QuartzCore.framework */
384 #define VM_MEMORY_COREIMAGE 68
386 /* memory allocated for WebCore Purgeable Buffers */
387 #define VM_MEMORY_WEBCORE_PURGEABLE_BUFFERS 69
390 #define VM_MEMORY_IMAGEIO 70
392 /* CoreProfile memory */
393 #define VM_MEMORY_COREPROFILE 71
395 /* assetsd / MobileSlideShow memory */
396 #define VM_MEMORY_ASSETSD 72
398 /* Reserve 240-255 for application */
399 #define VM_MEMORY_APPLICATION_SPECIFIC_1 240
400 #define VM_MEMORY_APPLICATION_SPECIFIC_16 255
402 #define VM_MAKE_TAG(tag) ((tag) << 24)
404 #endif /* _MACH_VM_STATISTICS_H_ */