1 | /* |
2 | * Copyright (c) 2021 Apple Computer, 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 _CORE_EXCLUDE_H_ |
30 | #define _CORE_EXCLUDE_H_ |
31 | |
32 | #include <mach/kern_return.h> |
33 | #include <mach/vm_types.h> |
34 | #include <sys/cdefs.h> |
35 | |
36 | __BEGIN_DECLS |
37 | |
38 | #if KERNEL_PRIVATE |
39 | |
40 | /* |
41 | * Excludes a given memory region from the kernel coredump. This is recommended |
42 | * for any sensitive data or data which is not expected to be necessary for |
43 | * debugging. |
44 | * |
45 | * The address and size of the region must be page-aligned, the size must be |
46 | * non-zero, and the addition of the address and size must not overflow. |
47 | * |
48 | * Note that you may need to call this function multiple times if the |
49 | * underlying memory is shared. |
50 | */ |
51 | void |
52 | kdp_core_exclude_region(vm_offset_t addr, vm_size_t size); |
53 | |
54 | /* |
55 | * Unexcludes a given memory region from the kernel coredump. |
56 | * |
57 | * The address and size of the region must match a currently excluded region. |
58 | */ |
59 | void |
60 | kdp_core_unexclude_region(vm_offset_t addr, vm_size_t size); |
61 | |
62 | #endif /* KERNEL_PRIVATE */ |
63 | |
64 | __END_DECLS |
65 | |
66 | #endif /* _CORE_EXCLUDE_H_ */ |
67 | |