xref: /xnu-12377.81.4/iokit/DriverKit/OSBoundedPtr.h (revision 043036a2b3718f7f0be807e2870f8f47d3fa0796)
1*043036a2SApple OSS Distributions /*
2*043036a2SApple OSS Distributions  * Copyright (c) 2019 Apple Inc. All rights reserved.
3*043036a2SApple OSS Distributions  *
4*043036a2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*043036a2SApple OSS Distributions  *
6*043036a2SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*043036a2SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*043036a2SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*043036a2SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*043036a2SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*043036a2SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*043036a2SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*043036a2SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*043036a2SApple OSS Distributions  *
15*043036a2SApple OSS Distributions  * Please obtain a copy of the License at
16*043036a2SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*043036a2SApple OSS Distributions  *
18*043036a2SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*043036a2SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*043036a2SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*043036a2SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*043036a2SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*043036a2SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*043036a2SApple OSS Distributions  * limitations under the License.
25*043036a2SApple OSS Distributions  *
26*043036a2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*043036a2SApple OSS Distributions  */
28*043036a2SApple OSS Distributions 
29*043036a2SApple OSS Distributions #ifndef XNU_LIBKERN_LIBKERN_CXX_OS_BOUNDED_PTR_H
30*043036a2SApple OSS Distributions #define XNU_LIBKERN_LIBKERN_CXX_OS_BOUNDED_PTR_H
31*043036a2SApple OSS Distributions 
32*043036a2SApple OSS Distributions #if !TAPI
33*043036a2SApple OSS Distributions 
34*043036a2SApple OSS Distributions #if DRIVERKIT_FRAMEWORK_INCLUDE
35*043036a2SApple OSS Distributions #include <DriverKit/IOLib.h>
36*043036a2SApple OSS Distributions #include <DriverKit/OSBoundedPtrFwd.h>
37*043036a2SApple OSS Distributions #if __cplusplus >= 201703L
38*043036a2SApple OSS Distributions #include <DriverKit/bounded_ptr.h>
39*043036a2SApple OSS Distributions #endif /* __cplusplus >= 201703L */
40*043036a2SApple OSS Distributions #else
41*043036a2SApple OSS Distributions #include <kern/debug.h>
42*043036a2SApple OSS Distributions #include <libkern/c++/OSBoundedPtrFwd.h>
43*043036a2SApple OSS Distributions #if __cplusplus >= 201703L
44*043036a2SApple OSS Distributions #include <libkern/c++/bounded_ptr.h>
45*043036a2SApple OSS Distributions #endif /* __cplusplus >= 201703L */
46*043036a2SApple OSS Distributions #endif /* DRIVERKIT_FRAMEWORK_INCLUDE */
47*043036a2SApple OSS Distributions 
48*043036a2SApple OSS Distributions namespace os_detail {
49*043036a2SApple OSS Distributions struct panic_trapping_policy {
50*043036a2SApple OSS Distributions 	[[noreturn]] static void
trappanic_trapping_policy51*043036a2SApple OSS Distributions 	trap(char const* message)
52*043036a2SApple OSS Distributions 	{
53*043036a2SApple OSS Distributions 		panic("%s", message);
54*043036a2SApple OSS Distributions 	}
55*043036a2SApple OSS Distributions };
56*043036a2SApple OSS Distributions }
57*043036a2SApple OSS Distributions 
58*043036a2SApple OSS Distributions // OSBoundedPtr alias is defined in the fwd decl header
59*043036a2SApple OSS Distributions 
60*043036a2SApple OSS Distributions #endif /* !TAPI */
61*043036a2SApple OSS Distributions 
62*043036a2SApple OSS Distributions #endif /* !XNU_LIBKERN_LIBKERN_CXX_OS_BOUNDED_PTR_H */
63