xref: /xnu-8796.101.5/libkern/os/alloc_util.h (revision aca3beaa3dfbd42498b42c5e5ce20a938e6554e5)
1*aca3beaaSApple OSS Distributions /*
2*aca3beaaSApple OSS Distributions  * Copyright (c) 2021 Apple Inc. All rights reserved.
3*aca3beaaSApple OSS Distributions  *
4*aca3beaaSApple OSS Distributions  * @APPLE_LICENSE_HEADER_START@
5*aca3beaaSApple OSS Distributions  *
6*aca3beaaSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*aca3beaaSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*aca3beaaSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*aca3beaaSApple OSS Distributions  * compliance with the License. Please obtain a copy of the License at
10*aca3beaaSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this
11*aca3beaaSApple OSS Distributions  * file.
12*aca3beaaSApple OSS Distributions  *
13*aca3beaaSApple OSS Distributions  * The Original Code and all software distributed under the License are
14*aca3beaaSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15*aca3beaaSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16*aca3beaaSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17*aca3beaaSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18*aca3beaaSApple OSS Distributions  * Please see the License for the specific language governing rights and
19*aca3beaaSApple OSS Distributions  * limitations under the License.
20*aca3beaaSApple OSS Distributions  *
21*aca3beaaSApple OSS Distributions  * @APPLE_LICENSE_HEADER_END@
22*aca3beaaSApple OSS Distributions  */
23*aca3beaaSApple OSS Distributions 
24*aca3beaaSApple OSS Distributions #ifndef _OS_ALLOC_UTIL_H
25*aca3beaaSApple OSS Distributions #define _OS_ALLOC_UTIL_H
26*aca3beaaSApple OSS Distributions 
27*aca3beaaSApple OSS Distributions #include <sys/cdefs.h>
28*aca3beaaSApple OSS Distributions #if defined(__cplusplus) && __cplusplus >= 201103L
29*aca3beaaSApple OSS Distributions extern "C++" {
30*aca3beaaSApple OSS Distributions #include <os/cpp_util.h>
31*aca3beaaSApple OSS Distributions }
32*aca3beaaSApple OSS Distributions #endif
33*aca3beaaSApple OSS Distributions 
34*aca3beaaSApple OSS Distributions /*!
35*aca3beaaSApple OSS Distributions  * @macro os_is_ptr_like
36*aca3beaaSApple OSS Distributions  *
37*aca3beaaSApple OSS Distributions  * @abstract
38*aca3beaaSApple OSS Distributions  * Tell whether the given expression resembles a pointer.
39*aca3beaaSApple OSS Distributions  *
40*aca3beaaSApple OSS Distributions  * @discussion
41*aca3beaaSApple OSS Distributions  * When pointer bounds are enabled, only types that are actually classified
42*aca3beaaSApple OSS Distributions  * as pointers will be considered pointer-like. Otherwise, any pointer-sized
43*aca3beaaSApple OSS Distributions  * type will be considered pointer-like.
44*aca3beaaSApple OSS Distributions  *
45*aca3beaaSApple OSS Distributions  * @param P             the expression to be checked
46*aca3beaaSApple OSS Distributions  */
47*aca3beaaSApple OSS Distributions #if __has_ptrcheck
48*aca3beaaSApple OSS Distributions #define os_is_ptr_like(P) (__builtin_classify_type(P) == 5)
49*aca3beaaSApple OSS Distributions #else  /* __has_ptrcheck */
50*aca3beaaSApple OSS Distributions #define os_is_ptr_like(P) (sizeof(P) == sizeof(void *))
51*aca3beaaSApple OSS Distributions #endif /* __has_ptrcheck */
52*aca3beaaSApple OSS Distributions 
53*aca3beaaSApple OSS Distributions /*!
54*aca3beaaSApple OSS Distributions  * @macro os_ptr_load_and_erase
55*aca3beaaSApple OSS Distributions  *
56*aca3beaaSApple OSS Distributions  * @abstract
57*aca3beaaSApple OSS Distributions  * Load the value of @c elem into a temporary, set @c elem to NULL, and
58*aca3beaaSApple OSS Distributions  * return the value.
59*aca3beaaSApple OSS Distributions  *
60*aca3beaaSApple OSS Distributions  * @param elem          the pointer whose value will be taken, and which will
61*aca3beaaSApple OSS Distributions  *                      be set to NULL.
62*aca3beaaSApple OSS Distributions  */
63*aca3beaaSApple OSS Distributions #define os_ptr_load_and_erase(elem) ({                        \
64*aca3beaaSApple OSS Distributions 	_Static_assert(os_is_ptr_like(elem),                      \
65*aca3beaaSApple OSS Distributions 	    "elem isn't pointer sized");                          \
66*aca3beaaSApple OSS Distributions 	__auto_type *__single __eptr = &(elem);                   \
67*aca3beaaSApple OSS Distributions 	__auto_type __elem = *__eptr;                             \
68*aca3beaaSApple OSS Distributions 	_Pragma("clang diagnostic push")                          \
69*aca3beaaSApple OSS Distributions 	_Pragma("clang diagnostic ignored \"-Wold-style-cast\"")  \
70*aca3beaaSApple OSS Distributions 	*__eptr = (__typeof__(__elem))NULL;                       \
71*aca3beaaSApple OSS Distributions 	_Pragma("clang diagnostic pop")                           \
72*aca3beaaSApple OSS Distributions 	__elem;                                                   \
73*aca3beaaSApple OSS Distributions })
74*aca3beaaSApple OSS Distributions 
75*aca3beaaSApple OSS Distributions #endif /* _OS_ALLOC_UTIL_H */
76