1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright 2018-2020 Alex Richardson <arichardson@FreeBSD.org> 5 * 6 * This software was developed by SRI International and the University of 7 * Cambridge Computer Laboratory (Department of Computer Science and 8 * Technology) under DARPA contract HR0011-18-C-0016 ("ECATS"), as part of the 9 * DARPA SSITH research programme. 10 * 11 * This software was developed by SRI International and the University of 12 * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237) 13 * ("CTSRD"), as part of the DARPA CRASH research programme. 14 * 15 * Redistribution and use in source and binary forms, with or without 16 * modification, are permitted provided that the following conditions 17 * are met: 18 * 1. Redistributions of source code must retain the above copyright 19 * notice, this list of conditions and the following disclaimer. 20 * 2. Redistributions in binary form must reproduce the above copyright 21 * notice, this list of conditions and the following disclaimer in the 22 * documentation and/or other materials provided with the distribution. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 */ 36 #pragma once 37 /* musl libc does not provide a sys/cdefs.h header */ 38 #if __has_include_next(<sys/cdefs.h>) 39 #include_next <sys/cdefs.h> 40 #else 41 /* No sys/cdefs.h header exists so we have to provide some basic macros */ 42 #ifdef __cplusplus 43 #define __BEGIN_DECLS extern "C" { 44 #define __END_DECLS } 45 #else 46 #define __BEGIN_DECLS 47 #define __END_DECLS 48 #endif 49 50 #endif 51 52 #ifndef __FBSDID 53 #define __FBSDID(id) 54 #endif 55 56 #ifndef __IDSTRING 57 #define __IDSTRING(name, string) 58 #endif 59 60 #ifndef __pure 61 #define __pure __attribute__((__pure__)) 62 #endif 63 #ifndef __packed 64 #define __packed __attribute__((__packed__)) 65 #endif 66 #ifndef __dead2 67 #define __dead2 __attribute__((__noreturn__)) 68 #endif 69 #ifndef __pure2 70 #define __pure2 __attribute__((__const__)) 71 #endif 72 #ifndef __used 73 #define __used __attribute__((__used__)) 74 #endif 75 #ifndef __aligned 76 #define __aligned(x) __attribute__((__aligned__(x))) 77 #endif 78 #ifndef __section 79 #define __section(x) __attribute__((__section__(x))) 80 #endif 81 82 #ifndef __alloc_size 83 #define __alloc_size(...) __attribute__((__alloc_size__(__VA_ARGS__))) 84 #endif 85 #ifndef __alloc_size2 86 #define __alloc_size2(n, x) __attribute__((__alloc_size__(n, x))) 87 #endif 88 #ifndef __alloc_align 89 #define __alloc_align(x) __attribute__((__alloc_align__(x))) 90 #endif 91 #ifndef __result_use_check 92 #define __result_use_check __attribute__((__warn_unused_result__)) 93 #endif 94 #ifndef __printflike 95 #define __printflike(fmtarg, firstvararg) \ 96 __attribute__((__format__(__printf__, fmtarg, firstvararg))) 97 #endif 98 #ifndef __printf0like 99 #define __printf0like(fmtarg, firstvararg) \ 100 __attribute__((__format__(__printf0__, fmtarg, firstvararg))) 101 #endif 102 103 #ifndef __predict_true 104 #define __predict_true(exp) __builtin_expect((exp), 1) 105 #endif 106 #ifndef __predict_false 107 #define __predict_false(exp) __builtin_expect((exp), 0) 108 #endif 109 110 #ifndef __weak_symbol 111 #define __weak_symbol __attribute__((__weak__)) 112 #endif 113 #ifndef __weak_reference 114 #ifdef __ELF__ 115 #define __weak_reference(sym, alias) \ 116 __asm__(".weak " #alias); \ 117 __asm__(".equ " #alias ", " #sym) 118 #else 119 #define __weak_reference(sym, alias) \ 120 static int alias() __attribute__((weakref(#sym))); 121 #endif 122 #endif 123 124 /* Some files built as part of the bootstrap libegacy use these macros, but 125 * since we aren't actually building libc.so, we can defined them to be empty */ 126 #ifndef __sym_compat 127 #define __sym_compat(sym, impl, verid) /* not needed for bootstrapping */ 128 #endif 129 #ifndef __sym_default 130 #define __sym_default(sym, impl, verid) /* not needed for bootstrapping */ 131 #endif 132 #ifndef __sym_default 133 #define __warn_references(sym, msg) /* not needed for bootstrapping */ 134 #endif 135 136 #ifndef __malloc_like 137 #define __malloc_like __attribute__((__malloc__)) 138 #endif 139 140 #ifndef __min_size 141 #if !defined(__cplusplus) 142 #define __min_size(x) static(x) 143 #else 144 #define __min_size(x) (x) 145 #endif 146 #endif 147 148 #ifndef __unused 149 #define __unused __attribute__((unused)) 150 #endif 151 #define __format_arg(fmtarg) __attribute__((__format_arg__(fmtarg))) 152 153 #ifndef __exported 154 #define __exported __attribute__((__visibility__("default"))) 155 #endif 156 #ifndef __hidden 157 #define __hidden __attribute__((__visibility__("hidden"))) 158 #endif 159 160 #ifndef __unreachable 161 #define __unreachable() __builtin_unreachable() 162 #endif 163 164 #ifndef __clang__ 165 /* GCC doesn't like the printf0 format specifier. Clang treats it the same as 166 * printf so add the compatibility macro here. */ 167 #define __printf0__ __printf__ 168 #endif 169 170 /* On MacOS __CONCAT is defined as x ## y, which won't expand macros */ 171 #undef __CONCAT 172 #define __CONCAT1(x, y) x##y 173 #define __CONCAT(x, y) __CONCAT1(x, y) 174 175 #ifndef __STRING 176 #define __STRING(x) #x /* stringify without expanding x */ 177 #endif 178 #ifndef __XSTRING 179 #define __XSTRING(x) __STRING(x) /* expand x, then stringify */ 180 #endif 181 182 #ifndef __has_feature 183 #define __has_feature(...) 0 184 #endif 185 186 #ifndef __has_builtin 187 #define __has_builtin(...) 0 188 #endif 189 190 /* 191 * Nullability qualifiers: currently only supported by Clang. 192 */ 193 #if !(defined(__clang__) && __has_feature(nullability)) 194 #define _Nonnull 195 #define _Nullable 196 #define _Null_unspecified 197 #define __NULLABILITY_PRAGMA_PUSH 198 #define __NULLABILITY_PRAGMA_POP 199 #else 200 #define __NULLABILITY_PRAGMA_PUSH \ 201 _Pragma("clang diagnostic push") \ 202 _Pragma("clang diagnostic ignored \"-Wnullability-completeness\"") 203 #define __NULLABILITY_PRAGMA_POP _Pragma("clang diagnostic pop") 204 #endif 205 206 #ifndef __offsetof 207 #define __offsetof(type, field) __builtin_offsetof(type, field) 208 #endif 209 210 #define __rangeof(type, start, end) \ 211 (__offsetof(type, end) - __offsetof(type, start)) 212 213 #ifndef __containerof 214 #define __containerof(x, s, m) \ 215 ({ \ 216 const volatile __typeof(((s *)0)->m) *__x = (x); \ 217 __DEQUALIFY( \ 218 s *, (const volatile char *)__x - __offsetof(s, m)); \ 219 }) 220 #endif 221 222 #ifndef __RCSID 223 #define __RCSID(x) 224 #endif 225 #ifndef __FBSDID 226 #define __FBSDID(x) 227 #endif 228 #ifndef __RCSID 229 #define __RCSID(x) 230 #endif 231 #ifndef __RCSID_SOURCE 232 #define __RCSID_SOURCE(x) 233 #endif 234 #ifndef __SCCSID 235 #define __SCCSID(x) 236 #endif 237 #ifndef __COPYRIGHT 238 #define __COPYRIGHT(x) 239 #endif 240 #ifndef __DECONST 241 #define __DECONST(type, var) ((type)(__uintptr_t)(const void *)(var)) 242 #endif 243 244 #ifndef __DEVOLATILE 245 #define __DEVOLATILE(type, var) ((type)(__uintptr_t)(volatile void *)(var)) 246 #endif 247 248 #ifndef __DEQUALIFY 249 #define __DEQUALIFY(type, var) ((type)(__uintptr_t)(const volatile void *)(var)) 250 #endif 251 252 253 /* Expose all declarations when using FreeBSD headers */ 254 #define __POSIX_VISIBLE 200809 255 #define __XSI_VISIBLE 700 256 #define __BSD_VISIBLE 1 257 #define __ISO_C_VISIBLE 2011 258 #define __EXT1_VISIBLE 1 259 260 /* Alignment builtins for better type checking and improved code generation. */ 261 /* Provide fallback versions for other compilers (GCC/Clang < 10): */ 262 #if !__has_builtin(__builtin_is_aligned) 263 #define __builtin_is_aligned(x, align) \ 264 (((__uintptr_t)x & ((align) - 1)) == 0) 265 #endif 266 #if !__has_builtin(__builtin_align_up) 267 #define __builtin_align_up(x, align) \ 268 ((__typeof__(x))(((__uintptr_t)(x)+((align)-1))&(~((align)-1)))) 269 #endif 270 #if !__has_builtin(__builtin_align_down) 271 #define __builtin_align_down(x, align) \ 272 ((__typeof__(x))((x)&(~((align)-1)))) 273 #endif 274 275 #define __align_up(x, y) __builtin_align_up(x, y) 276 #define __align_down(x, y) __builtin_align_down(x, y) 277 #define __is_aligned(x, y) __builtin_is_aligned(x, y) 278