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