xref: /xnu-10002.41.9/bsd/sys/memory_maintenance.h (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions /*
2*699cd480SApple OSS Distributions  * Copyright (c) 2015 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 #ifndef _SYS_MEMORY_MAINTENANCE_H_
30*699cd480SApple OSS Distributions #define _SYS_MEMORY_MAINTENANCE_H_
31*699cd480SApple OSS Distributions 
32*699cd480SApple OSS Distributions /*
33*699cd480SApple OSS Distributions  * File:	sys/memory_maintenance.h
34*699cd480SApple OSS Distributions  * Author:	Samuel Gosselin [[email protected]]
35*699cd480SApple OSS Distributions  *
36*699cd480SApple OSS Distributions  * Header file for Memory Maintenance support.
37*699cd480SApple OSS Distributions  */
38*699cd480SApple OSS Distributions 
39*699cd480SApple OSS Distributions /*
40*699cd480SApple OSS Distributions  * The kern.darkboot sysctl can be controlled from kexts or userspace. If
41*699cd480SApple OSS Distributions  * processes want to change the sysctl value, they require the
42*699cd480SApple OSS Distributions  * 'com.apple.private.kernel.darkboot' entitlement.
43*699cd480SApple OSS Distributions  *
44*699cd480SApple OSS Distributions  * Operating the kern.darkboot sysctl is done via using the commands below:
45*699cd480SApple OSS Distributions  *
46*699cd480SApple OSS Distributions  *      - MEMORY_MAINTENANCE_DARK_BOOT_UNSET
47*699cd480SApple OSS Distributions  *              Unset the kern.darkboot sysctl (kern.sysctl=0).
48*699cd480SApple OSS Distributions  *      - MEMORY_MAINTENANCE_DARK_BOOT_SET
49*699cd480SApple OSS Distributions  *              Set the kern.darkboot sysctl (kern.sysctl=1).
50*699cd480SApple OSS Distributions  *      - MEMORY_MAINTENANCE_DARK_BOOT_SET_PERSISTENT
51*699cd480SApple OSS Distributions  *              Set the kern.darkboot sysctl (kern.sysctl=1) and save its
52*699cd480SApple OSS Distributions  *              value into the 'darkboot' NVRAM variable.
53*699cd480SApple OSS Distributions  *
54*699cd480SApple OSS Distributions  * Example:
55*699cd480SApple OSS Distributions  *      sysctl kern.darkboot=2
56*699cd480SApple OSS Distributions  */
57*699cd480SApple OSS Distributions #define MEMORY_MAINTENANCE_DARK_BOOT_UNSET              (0)
58*699cd480SApple OSS Distributions #define MEMORY_MAINTENANCE_DARK_BOOT_SET                (1)
59*699cd480SApple OSS Distributions #define MEMORY_MAINTENANCE_DARK_BOOT_SET_PERSISTENT     (2)
60*699cd480SApple OSS Distributions 
61*699cd480SApple OSS Distributions #define MEMORY_MAINTENANCE_DARK_BOOT_NVRAM_NAME         "darkboot"
62*699cd480SApple OSS Distributions 
63*699cd480SApple OSS Distributions #endif /* _SYS_MEMORY_MAINTENANCE_H_ */
64