xref: /xnu-8792.41.9/osfmk/vm/vm_phantom_cache.h (revision 5c2921b07a2480ab43ec66f5b9e41cb872bc554f)
1*5c2921b0SApple OSS Distributions /*
2*5c2921b0SApple OSS Distributions  * Copyright (c) 2000-2013 Apple Inc. All rights reserved.
3*5c2921b0SApple OSS Distributions  *
4*5c2921b0SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*5c2921b0SApple OSS Distributions  *
6*5c2921b0SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*5c2921b0SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*5c2921b0SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*5c2921b0SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*5c2921b0SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*5c2921b0SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*5c2921b0SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*5c2921b0SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*5c2921b0SApple OSS Distributions  *
15*5c2921b0SApple OSS Distributions  * Please obtain a copy of the License at
16*5c2921b0SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*5c2921b0SApple OSS Distributions  *
18*5c2921b0SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*5c2921b0SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*5c2921b0SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*5c2921b0SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*5c2921b0SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*5c2921b0SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*5c2921b0SApple OSS Distributions  * limitations under the License.
25*5c2921b0SApple OSS Distributions  *
26*5c2921b0SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*5c2921b0SApple OSS Distributions  */
28*5c2921b0SApple OSS Distributions 
29*5c2921b0SApple OSS Distributions #include <vm/vm_page.h>
30*5c2921b0SApple OSS Distributions 
31*5c2921b0SApple OSS Distributions #define         VM_GHOST_OFFSET_BITS    39
32*5c2921b0SApple OSS Distributions #define         VM_GHOST_OFFSET_MASK    0x7FFFFFFFFF
33*5c2921b0SApple OSS Distributions #define         VM_GHOST_PAGES_PER_ENTRY 4
34*5c2921b0SApple OSS Distributions #define         VM_GHOST_PAGE_MASK      0x3
35*5c2921b0SApple OSS Distributions #define         VM_GHOST_PAGE_SHIFT     2
36*5c2921b0SApple OSS Distributions #define         VM_GHOST_INDEX_BITS     (64 - VM_GHOST_OFFSET_BITS - VM_GHOST_PAGES_PER_ENTRY)
37*5c2921b0SApple OSS Distributions 
38*5c2921b0SApple OSS Distributions struct  vm_ghost {
39*5c2921b0SApple OSS Distributions 	uint64_t        g_next_index:VM_GHOST_INDEX_BITS,
40*5c2921b0SApple OSS Distributions 	    g_pages_held:VM_GHOST_PAGES_PER_ENTRY,
41*5c2921b0SApple OSS Distributions 	    g_obj_offset:VM_GHOST_OFFSET_BITS;
42*5c2921b0SApple OSS Distributions 	uint32_t        g_obj_id;
43*5c2921b0SApple OSS Distributions } __attribute__((packed));
44*5c2921b0SApple OSS Distributions 
45*5c2921b0SApple OSS Distributions typedef struct vm_ghost *vm_ghost_t;
46*5c2921b0SApple OSS Distributions 
47*5c2921b0SApple OSS Distributions 
48*5c2921b0SApple OSS Distributions extern  void            vm_phantom_cache_init(void);
49*5c2921b0SApple OSS Distributions extern  void            vm_phantom_cache_add_ghost(vm_page_t);
50*5c2921b0SApple OSS Distributions extern  vm_ghost_t      vm_phantom_cache_lookup_ghost(vm_page_t, uint32_t);
51*5c2921b0SApple OSS Distributions extern  void            vm_phantom_cache_update(vm_page_t);
52*5c2921b0SApple OSS Distributions extern  boolean_t       vm_phantom_cache_check_pressure(void);
53*5c2921b0SApple OSS Distributions extern  void            vm_phantom_cache_restart_sample(void);
54