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