kernel.h revision 1.37
1 /* $NetBSD: kernel.h,v 1.37 2021/12/19 01:40:20 riastradh Exp $ */ 2 3 /*- 4 * Copyright (c) 2013 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Taylor R. Campbell. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 #ifndef _LINUX_KERNEL_H_ 33 #define _LINUX_KERNEL_H_ 34 35 #include <sys/cdefs.h> 36 #include <sys/types.h> 37 #include <sys/param.h> 38 #include <sys/systm.h> 39 #include <sys/endian.h> 40 41 #include <lib/libkern/libkern.h> 42 43 #include <asm/byteorder.h> 44 #include <asm/div64.h> 45 46 #include <linux/bitops.h> 47 #include <linux/compiler.h> 48 #include <linux/log2.h> 49 #include <linux/printk.h> 50 #include <linux/slab.h> 51 52 #define U16_MAX UINT16_MAX 53 #define U32_MAX UINT32_MAX 54 #define U64_MAX UINT64_MAX 55 56 #define oops_in_progress (panicstr != NULL) 57 58 #if BYTE_ORDER == BIG_ENDIAN 59 #define __BIG_ENDIAN _BIG_ENDIAN 60 #else 61 #define __LITTLE_ENDIAN _LITTLE_ENDIAN 62 #endif 63 64 #define IS_BUILTIN(option) (1) /* Probably... */ 65 #define IS_ENABLED(option) (option) 66 #define IS_REACHABLE(option) (option) 67 68 #define __printf __printflike 69 #define __user 70 #if __GNUC_PREREQ__(4,0) /* not sure when but this will work */ 71 #define __must_check __attribute__((warn_unused_result)) 72 #else 73 #define __must_check /* nothing */ 74 #endif 75 #define __always_unused __unused 76 #define __maybe_unused __unused 77 #define noinline __noinline 78 #define __deprecated /* nothing */ 79 80 #define barrier() __insn_barrier() 81 #define likely(X) __predict_true(X) 82 #define unlikely(X) __predict_false(X) 83 84 #define might_sleep ASSERT_SLEEPABLE 85 86 #define DEFINE_STATIC_KEY_FALSE(N) bool N __unused = false 87 88 /* 89 * XXX Linux kludge to work around GCC uninitialized variable warning. 90 * Linux does `x = x', which is bollocks. 91 */ 92 #define uninitialized_var(x) x = 0 93 94 #define typecheck(T, X) ({(1 + 0*sizeof((T *)0 - &(X)));}) 95 96 /* XXX These will multiply evaluate their arguments. */ 97 #define min(X, Y) MIN(X, Y) 98 #define max(X, Y) MAX(X, Y) 99 100 #define max_t(T, X, Y) MAX((T)(X), (T)(Y)) 101 #define min_t(T, X, Y) MIN((T)(X), (T)(Y)) 102 103 #define clamp_t(T, X, MIN, MAX) min_t(T, max_t(T, X, MIN), MAX) 104 #define clamp(X, MN, MX) MIN(MAX(X, MN), MX) 105 #define clamp_val(X, MIN, MAX) clamp_t(typeof(X), X, MIN, MAX) 106 107 #define min3(X, Y, Z) MIN(X, MIN(Y, Z)) 108 #define max3(X, Y, Z) MAX(X, MAX(Y, Z)) 109 110 /* 111 * Rounding to nearest. 112 */ 113 #define DIV_ROUND_CLOSEST(N, D) \ 114 ((0 < (N)) ? (((N) + ((D) / 2)) / (D)) \ 115 : (((N) - ((D) / 2)) / (D))) 116 117 #define DIV_ROUND_CLOSEST_ULL(N, D) (((N) + (D)/2)/(D)) 118 119 /* 120 * Rounding to what may or may not be powers of two. 121 */ 122 #define DIV_ROUND_UP(X, N) (((X) + (N) - 1) / (N)) 123 #define DIV_ROUND_UP_ULL(X, N) DIV_ROUND_UP((unsigned long long)(X), (N)) 124 125 #define DIV_ROUND_DOWN_ULL(X,N) ((unsigned long long)(X) / (N)) 126 127 /* 128 * Rounding to powers of two -- carefully avoiding multiple evaluation 129 * of arguments and pitfalls with C integer arithmetic rules. 130 */ 131 #define round_up(X, N) ((((X) - 1) | ((N) - 1)) + 1) 132 #define round_down(X, N) ((X) & ~(uintmax_t)((N) - 1)) 133 134 #define IS_ALIGNED(X, N) (((X) & ((N) - 1)) == 0) 135 136 /* 137 * These select 32-bit halves of what may be 32- or 64-bit quantities, 138 * for which straight 32-bit shifts may be undefined behaviour (and do 139 * the wrong thing on most machines: return the input unshifted by 140 * ignoring the upper bits of the shift count). 141 */ 142 #define upper_32_bits(X) ((uint32_t) (((X) >> 16) >> 16)) 143 #define lower_32_bits(X) ((uint32_t) ((X) & 0xffffffffUL)) 144 145 #define ARRAY_SIZE(ARRAY) __arraycount(ARRAY) 146 147 #define swap(X, Y) do \ 148 { \ 149 /* XXX Kludge for type-safety. */ \ 150 if (&(X) != &(Y)) { \ 151 CTASSERT(sizeof(X) == sizeof(Y)); \ 152 /* XXX Can't do this much better without typeof. */ \ 153 char __swap_tmp[sizeof(X)]; \ 154 (void)memcpy(__swap_tmp, &(X), sizeof(X)); \ 155 (void)memcpy(&(X), &(Y), sizeof(X)); \ 156 (void)memcpy(&(Y), __swap_tmp, sizeof(X)); \ 157 } \ 158 } while (0) 159 160 static __inline int64_t 161 abs64(int64_t x) 162 { 163 return (x < 0? (-x) : x); 164 } 165 166 static __inline uintmax_t 167 mult_frac(uintmax_t x, uintmax_t multiplier, uintmax_t divisor) 168 { 169 uintmax_t q = (x / divisor); 170 uintmax_t r = (x % divisor); 171 172 return ((q * multiplier) + ((r * multiplier) / divisor)); 173 } 174 175 static int panic_timeout __unused = 0; 176 177 static __inline int __printflike(3, 0) 178 vscnprintf(char *buf, size_t size, const char *fmt, va_list va) 179 { 180 int ret; 181 182 ret = vsnprintf(buf, size, fmt, va); 183 if (__predict_false(ret < 0)) 184 return ret; 185 if (__predict_false(size == 0)) 186 return 0; 187 if (__predict_false(size <= (size_t)ret)) 188 return (size - 1); 189 190 return ret; 191 } 192 193 static __inline int __printflike(3, 4) 194 scnprintf(char *buf, size_t size, const char *fmt, ...) 195 { 196 va_list va; 197 int ret; 198 199 va_start(va, fmt); 200 ret = vscnprintf(buf, size, fmt, va); 201 va_end(va); 202 203 return ret; 204 } 205 206 static __inline int 207 kstrtol(const char *s, unsigned base, long *vp) 208 { 209 long long v; 210 211 v = strtoll(s, NULL, base); 212 if (v < LONG_MIN || LONG_MAX < v) 213 return -ERANGE; 214 *vp = v; 215 return 0; 216 } 217 218 static inline long 219 simple_strtol(const char *s, char **endp, unsigned base) 220 { 221 long v; 222 223 *endp = NULL; /* paranoia */ 224 v = strtoll(s, endp, base); 225 if (v < LONG_MIN || LONG_MAX < v) 226 return 0; 227 return v; 228 } 229 230 static __inline char * __printflike(2, 0) 231 kvasprintf(gfp_t gfp, const char *fmt, va_list va) 232 { 233 va_list tva; 234 char *str; 235 int len, len1 __diagused; 236 237 va_copy(tva, va); 238 len = vsnprintf(NULL, 0, fmt, tva); 239 va_end(tva); 240 str = kmalloc(len + 1, gfp); 241 if (str == NULL) 242 return NULL; 243 len1 = vsnprintf(str, len + 1, fmt, va); 244 KASSERT(len1 == len); 245 246 return str; 247 } 248 249 static __inline char * __printflike(2, 3) 250 kasprintf(gfp_t gfp, const char *fmt, ...) 251 { 252 va_list va; 253 char *str; 254 255 va_start(va, fmt); 256 str = kvasprintf(gfp, fmt, va); 257 va_end(va); 258 259 return str; 260 } 261 262 static inline void __user * 263 u64_to_user_ptr(uint64_t addr) 264 { 265 266 return (void __user *)(uintptr_t)addr; 267 } 268 269 #define TAINT_MACHINE_CHECK 0 270 #define TAINT_WARN 1 271 272 #define LOCKDEP_STILL_OK 0 273 274 static inline void 275 add_taint(unsigned taint, int lockdep) 276 { 277 } 278 279 #endif /* _LINUX_KERNEL_H_ */ 280
Indexes created Mon Sep 22 10:09:38 GMT 2025