xref: /xnu-11417.101.15/osfmk/vm/vm_reclaim_internal.h (revision e3723e1f17661b24996789d8afc084c0c3303b26)
1 /*
2  * Copyright (c) 2021 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
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.
14  *
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
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.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 #ifndef __VM_RECLAIM_INTERNAL__
30 #define __VM_RECLAIM_INTERNAL__
31 
32 #if CONFIG_DEFERRED_RECLAIM
33 
34 #include <mach/mach_types.h>
35 #include <mach/vm_reclaim.h>
36 #include <sys/cdefs.h>
37 #include <vm/vm_reclaim_xnu.h>
38 
39 #if MACH_KERNEL_PRIVATE
40 
41 mach_error_t vm_deferred_reclamation_buffer_allocate_internal(
42 	task_t            task,
43 	mach_vm_address_ut *address,
44 	mach_vm_reclaim_count_t len,
45 	mach_vm_reclaim_count_t max_len);
46 
47 kern_return_t vm_deferred_reclamation_buffer_flush_internal(
48 	task_t                  task,
49 	mach_vm_reclaim_count_t max_entries_to_reclaim);
50 
51 kern_return_t vm_deferred_reclamation_buffer_update_reclaimable_bytes_internal(
52 	task_t task, uint64_t reclaimable_bytes);
53 
54 /*
55  * Resize the reclaim buffer for a given task
56  */
57 kern_return_t vm_deferred_reclamation_buffer_resize_internal(
58 	task_t            task,
59 	mach_vm_reclaim_count_t len);
60 
61 
62 void vm_deferred_reclamation_buffer_lock(vm_deferred_reclamation_metadata_t metadata);
63 void vm_deferred_reclamation_buffer_unlock(vm_deferred_reclamation_metadata_t metadata);
64 
65 #if DEVELOPMENT || DEBUG
66 /*
67  * Testing helpers
68  */
69 bool vm_deferred_reclamation_block_until_task_has_been_reclaimed(task_t task);
70 #endif /* DEVELOPMENT || DEBUG */
71 
72 #endif /* MACH_KERNEL_PRIVATE */
73 #endif /* CONFIG_DEFERRED_RECLAIM */
74 #endif /*__VM_RECLAIM_INTERNAL__ */
75