xref: /xnu-12377.41.6/osfmk/kdp/core_exclude.h (revision bbb1b6f9e71b8cdde6e5cd6f4841f207dee3d828)
1*bbb1b6f9SApple OSS Distributions /*
2*bbb1b6f9SApple OSS Distributions  * Copyright (c) 2021 Apple Computer, Inc. All rights reserved.
3*bbb1b6f9SApple OSS Distributions  *
4*bbb1b6f9SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*bbb1b6f9SApple OSS Distributions  *
6*bbb1b6f9SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*bbb1b6f9SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*bbb1b6f9SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*bbb1b6f9SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*bbb1b6f9SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*bbb1b6f9SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*bbb1b6f9SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*bbb1b6f9SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*bbb1b6f9SApple OSS Distributions  *
15*bbb1b6f9SApple OSS Distributions  * Please obtain a copy of the License at
16*bbb1b6f9SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*bbb1b6f9SApple OSS Distributions  *
18*bbb1b6f9SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*bbb1b6f9SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*bbb1b6f9SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*bbb1b6f9SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*bbb1b6f9SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*bbb1b6f9SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*bbb1b6f9SApple OSS Distributions  * limitations under the License.
25*bbb1b6f9SApple OSS Distributions  *
26*bbb1b6f9SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*bbb1b6f9SApple OSS Distributions  */
28*bbb1b6f9SApple OSS Distributions 
29*bbb1b6f9SApple OSS Distributions #ifndef _CORE_EXCLUDE_H_
30*bbb1b6f9SApple OSS Distributions #define _CORE_EXCLUDE_H_
31*bbb1b6f9SApple OSS Distributions 
32*bbb1b6f9SApple OSS Distributions #include <mach/kern_return.h>
33*bbb1b6f9SApple OSS Distributions #include <mach/vm_types.h>
34*bbb1b6f9SApple OSS Distributions #include <sys/cdefs.h>
35*bbb1b6f9SApple OSS Distributions 
36*bbb1b6f9SApple OSS Distributions __BEGIN_DECLS
37*bbb1b6f9SApple OSS Distributions 
38*bbb1b6f9SApple OSS Distributions #if KERNEL_PRIVATE
39*bbb1b6f9SApple OSS Distributions 
40*bbb1b6f9SApple OSS Distributions /*
41*bbb1b6f9SApple OSS Distributions  * Excludes a given memory region from the kernel coredump. This is recommended
42*bbb1b6f9SApple OSS Distributions  * for any sensitive data or data which is not expected to be necessary for
43*bbb1b6f9SApple OSS Distributions  * debugging.
44*bbb1b6f9SApple OSS Distributions  *
45*bbb1b6f9SApple OSS Distributions  * The address and size of the region must be page-aligned, the size must be
46*bbb1b6f9SApple OSS Distributions  * non-zero, and the addition of the address and size must not overflow.
47*bbb1b6f9SApple OSS Distributions  *
48*bbb1b6f9SApple OSS Distributions  * Note that you may need to call this function multiple times if the
49*bbb1b6f9SApple OSS Distributions  * underlying memory is shared.
50*bbb1b6f9SApple OSS Distributions  */
51*bbb1b6f9SApple OSS Distributions void
52*bbb1b6f9SApple OSS Distributions kdp_core_exclude_region(vm_offset_t addr, vm_size_t size);
53*bbb1b6f9SApple OSS Distributions 
54*bbb1b6f9SApple OSS Distributions /*
55*bbb1b6f9SApple OSS Distributions  * Unexcludes a given memory region from the kernel coredump.
56*bbb1b6f9SApple OSS Distributions  *
57*bbb1b6f9SApple OSS Distributions  * The address and size of the region must match a currently excluded region.
58*bbb1b6f9SApple OSS Distributions  */
59*bbb1b6f9SApple OSS Distributions void
60*bbb1b6f9SApple OSS Distributions kdp_core_unexclude_region(vm_offset_t addr, vm_size_t size);
61*bbb1b6f9SApple OSS Distributions 
62*bbb1b6f9SApple OSS Distributions #endif /* KERNEL_PRIVATE */
63*bbb1b6f9SApple OSS Distributions 
64*bbb1b6f9SApple OSS Distributions __END_DECLS
65*bbb1b6f9SApple OSS Distributions 
66*bbb1b6f9SApple OSS Distributions #endif /* _CORE_EXCLUDE_H_ */
67