xref: /xnu-10002.1.13/bsd/vm/dp_backing_file.c (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1 /*
2  * Copyright (c) 2000-2010 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  * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
30  * support for mandatory and extensible security protections.  This notice
31  * is included in support of clause 2.2 (b) of the Apple Public License,
32  * Version 2.0.
33  */
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/lock.h>
38 #include <sys/proc_internal.h>
39 #include <sys/kauth.h>
40 #include <sys/buf.h>
41 #include <sys/uio.h>
42 #include <sys/vnode_internal.h>
43 #include <sys/namei.h>
44 #include <sys/ubc_internal.h>
45 #include <sys/malloc.h>
46 #include <sys/user.h>
47 
48 #include <default_pager/default_pager_types.h>
49 
50 #include <security/audit/audit.h>
51 #include <bsm/audit_kevents.h>
52 
53 #include <mach/mach_types.h>
54 #include <mach/host_priv.h>
55 #include <mach/mach_traps.h>
56 #include <mach/boolean.h>
57 
58 #include <kern/kern_types.h>
59 #include <kern/locks.h>
60 #include <kern/host.h>
61 #include <kern/task.h>
62 #include <kern/zalloc.h>
63 #include <kern/policy_internal.h>
64 
65 #include <libkern/libkern.h>
66 
67 #include <vm/vm_pageout.h>
68 #include <vm/vm_map.h>
69 #include <vm/vm_kern.h>
70 #include <vm/vnode_pager.h>
71 #include <vm/vm_protos.h>
72 #if CONFIG_MACF
73 #include <security/mac_framework.h>
74 #endif
75 
76 #include <pexpert/pexpert.h>
77 
78 
79 /*
80  *	Routine:	macx_backing_store_recovery
81  *	Function:
82  *		Syscall interface to set a tasks privilege
83  *		level so that it is not subject to
84  *		macx_backing_store_suspend
85  */
86 int
macx_backing_store_recovery(__unused struct macx_backing_store_recovery_args * args)87 macx_backing_store_recovery(
88 	__unused struct macx_backing_store_recovery_args *args)
89 {
90 	return ENOTSUP;
91 }
92 
93 /*
94  *	Routine:	macx_backing_store_suspend
95  *	Function:
96  *		Syscall interface to stop new demand for
97  *		backing store when backing store is low
98  */
99 
100 int
macx_backing_store_suspend(__unused struct macx_backing_store_suspend_args * args)101 macx_backing_store_suspend(
102 	__unused struct macx_backing_store_suspend_args *args)
103 {
104 	return ENOTSUP;
105 }
106 
107 
108 extern boolean_t compressor_store_stop_compaction;
109 
110 /*
111  *	Routine:	macx_backing_store_compaction
112  *	Function:
113  *		Turn compaction of swap space on or off.  This is
114  *		used during shutdown/restart so	that the kernel
115  *		doesn't waste time compacting swap files that are
116  *		about to be deleted anyway.  Compaction	is always
117  *		on by default when the system comes up and is turned
118  *		off when a shutdown/restart is requested.  It is
119  *		re-enabled if the shutdown/restart is aborted for any reason.
120  *
121  *  This routine assumes macx_lock has been locked by macx_triggers ->
122  *      mach_macx_triggers -> macx_backing_store_compaction
123  */
124 extern int vm_swap_enabled;
125 int
macx_backing_store_compaction(int flags)126 macx_backing_store_compaction(int flags)
127 {
128 	int error;
129 
130 	if ((error = suser(kauth_cred_get(), 0))) {
131 		return error;
132 	}
133 
134 	if (flags & SWAP_COMPACT_DISABLE) {
135 #if (XNU_TARGET_OS_OSX && __arm64__)
136 		/*
137 		 * There's no synch. between the swap being turned
138 		 * OFF from user-space and all processes having exited.
139 		 * On fast SSD AS macs we can accumulate a lot of
140 		 * compressed memory between those 2 operations.
141 		 * So we allow swap till we are ready to shutdown the
142 		 * system. Even with a bunch of processes
143 		 * still running and creating a lot of compressed
144 		 * memory the system can shutdown normally.
145 		 */
146 #else /* (XNU_TARGET_OS_OSX && __arm64__) */
147 		compressor_store_stop_compaction = TRUE;
148 		vm_swap_enabled = 0;
149 		kprintf("compressor_store_stop_compaction = TRUE\n");
150 #endif /* (XNU_TARGET_OS_OSX && __arm64__) */
151 	} else if (flags & SWAP_COMPACT_ENABLE) {
152 		compressor_store_stop_compaction = FALSE;
153 		vm_swap_enabled = 1;
154 		kprintf("compressor_store_stop_compaction = FALSE\n");
155 	}
156 
157 	return 0;
158 }
159 
160 /*
161  *	Routine:	macx_triggers
162  *	Function:
163  *		Syscall interface to set the call backs for low and
164  *		high water marks.
165  */
166 int
macx_triggers(struct macx_triggers_args * args)167 macx_triggers(
168 	struct macx_triggers_args *args)
169 {
170 	int     flags = args->flags;
171 
172 	if (flags & (SWAP_COMPACT_DISABLE | SWAP_COMPACT_ENABLE)) {
173 		return macx_backing_store_compaction(flags);
174 	}
175 
176 	return ENOTSUP;
177 }
178 
179 
180 int
macx_swapon(__unused struct macx_swapon_args * args)181 macx_swapon(
182 	__unused struct macx_swapon_args *args)
183 {
184 	return ENOTSUP;
185 }
186 
187 
188 /*
189  *	Routine:	macx_swapoff
190  *	Function:
191  *		Syscall interface to remove a file from backing store
192  */
193 int
macx_swapoff(__unused struct macx_swapoff_args * args)194 macx_swapoff(
195 	__unused struct macx_swapoff_args *args)
196 {
197 	return ENOTSUP;
198 }
199 
200 /*
201  *	Routine:	macx_swapinfo
202  *	Function:
203  *		Syscall interface to get general swap statistics
204  */
205 extern uint64_t vm_swap_get_total_space(void);
206 extern uint64_t vm_swap_get_free_space(void);
207 extern boolean_t vm_swap_up;
208 
209 int
macx_swapinfo(memory_object_size_t * total_p,memory_object_size_t * avail_p,vm_size_t * pagesize_p,boolean_t * encrypted_p)210 macx_swapinfo(
211 	memory_object_size_t    *total_p,
212 	memory_object_size_t    *avail_p,
213 	vm_size_t               *pagesize_p,
214 	boolean_t               *encrypted_p)
215 {
216 	if (VM_CONFIG_SWAP_IS_PRESENT) {
217 		*total_p = vm_swap_get_total_space();
218 		*avail_p = vm_swap_get_free_space();
219 		*pagesize_p = (vm_size_t)PAGE_SIZE_64;
220 		*encrypted_p = TRUE;
221 	} else {
222 		*total_p = 0;
223 		*avail_p = 0;
224 		*pagesize_p = 0;
225 		*encrypted_p = FALSE;
226 	}
227 	return 0;
228 }
229