xref: /xnu-10063.121.3/san/memory/ubsan_minimal.h (revision 2c2f96dc2b9a4408a43d3150ae9c105355ca3daa)
1*2c2f96dcSApple OSS Distributions /*
2*2c2f96dcSApple OSS Distributions  * Copyright (c) 2021 Apple Inc. All rights reserved.
3*2c2f96dcSApple OSS Distributions  *
4*2c2f96dcSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*2c2f96dcSApple OSS Distributions  *
6*2c2f96dcSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*2c2f96dcSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*2c2f96dcSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*2c2f96dcSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*2c2f96dcSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*2c2f96dcSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*2c2f96dcSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*2c2f96dcSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*2c2f96dcSApple OSS Distributions  *
15*2c2f96dcSApple OSS Distributions  * Please obtain a copy of the License at
16*2c2f96dcSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*2c2f96dcSApple OSS Distributions  *
18*2c2f96dcSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*2c2f96dcSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*2c2f96dcSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*2c2f96dcSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*2c2f96dcSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*2c2f96dcSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*2c2f96dcSApple OSS Distributions  * limitations under the License.
25*2c2f96dcSApple OSS Distributions  *
26*2c2f96dcSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*2c2f96dcSApple OSS Distributions  */
28*2c2f96dcSApple OSS Distributions 
29*2c2f96dcSApple OSS Distributions #ifndef _UBSAN_MINIMAL_H_
30*2c2f96dcSApple OSS Distributions #define _UBSAN_MINIMAL_H_
31*2c2f96dcSApple OSS Distributions 
32*2c2f96dcSApple OSS Distributions #if CONFIG_UBSAN_MINIMAL
33*2c2f96dcSApple OSS Distributions /*
34*2c2f96dcSApple OSS Distributions  * This minimal runtime contains the handlers for checks that are suitable
35*2c2f96dcSApple OSS Distributions  * at runtime. To minimize codegen impact, the handlers simply act as a shim
36*2c2f96dcSApple OSS Distributions  * to a brk instruction, which gets then inlined by the compiler+LTO.
37*2c2f96dcSApple OSS Distributions  * This is similar to UBSAN trapping mode, but guarantees that we can fix
38*2c2f96dcSApple OSS Distributions  * and continue by simply stepping to the next instruction during the exception
39*2c2f96dcSApple OSS Distributions  * handler.
40*2c2f96dcSApple OSS Distributions  *
41*2c2f96dcSApple OSS Distributions  * UBSAN Minimal runtime is currently available only for iOS and only for
42*2c2f96dcSApple OSS Distributions  * signed overflow checks. It is only used on RELEASE and DEVELOPMENT kernels.
43*2c2f96dcSApple OSS Distributions  */
44*2c2f96dcSApple OSS Distributions 
45*2c2f96dcSApple OSS Distributions #pragma GCC visibility push(hidden)
46*2c2f96dcSApple OSS Distributions 
47*2c2f96dcSApple OSS Distributions /* Trap handler for telemetry */
48*2c2f96dcSApple OSS Distributions void ubsan_handle_brk_trap(void *, uint16_t);
49*2c2f96dcSApple OSS Distributions 
50*2c2f96dcSApple OSS Distributions /* Setup ubsan minimal runtime */
51*2c2f96dcSApple OSS Distributions void ubsan_minimal_init(void);
52*2c2f96dcSApple OSS Distributions 
53*2c2f96dcSApple OSS Distributions /*
54*2c2f96dcSApple OSS Distributions  * signed-integer-overflow ABI
55*2c2f96dcSApple OSS Distributions  */
56*2c2f96dcSApple OSS Distributions void __ubsan_handle_divrem_overflow_minimal(void);
57*2c2f96dcSApple OSS Distributions void __ubsan_handle_negate_overflow_minimal(void);
58*2c2f96dcSApple OSS Distributions void __ubsan_handle_mul_overflow_minimal(void);
59*2c2f96dcSApple OSS Distributions void __ubsan_handle_sub_overflow_minimal(void);
60*2c2f96dcSApple OSS Distributions void __ubsan_handle_add_overflow_minimal(void);
61*2c2f96dcSApple OSS Distributions 
62*2c2f96dcSApple OSS Distributions #pragma GCC visibility pop
63*2c2f96dcSApple OSS Distributions 
64*2c2f96dcSApple OSS Distributions #endif /* CONFIG_UBSAN_MINIMAL */
65*2c2f96dcSApple OSS Distributions #endif /* _UBSAN_MINIMAL_H_ */
66