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