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