1 /*- 2 * Copyright (c) 2010 Isilon Systems, Inc. 3 * Copyright (c) 2010 iX Systems, Inc. 4 * Copyright (c) 2010 Panasas, Inc. 5 * Copyright (c) 2013-2016 Mellanox Technologies, Ltd. 6 * Copyright (c) 2014-2015 François Tigeot 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice unmodified, this list of conditions, and the following 14 * 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 AUTHOR ``AS IS'' AND ANY EXPRESS OR 20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 * 30 * $FreeBSD$ 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/systm.h> 38 #include <sys/param.h> 39 #include <sys/libkern.h> 40 #include <sys/stat.h> 41 #include <sys/smp.h> 42 #include <sys/stddef.h> 43 #include <sys/syslog.h> 44 #include <sys/time.h> 45 46 #include <linux/bitops.h> 47 #include <linux/compiler.h> 48 #include <linux/errno.h> 49 #include <linux/sched.h> 50 #include <linux/types.h> 51 #include <linux/jiffies.h> 52 #include <linux/log2.h> 53 #include <asm/byteorder.h> 54 55 #include <machine/stdarg.h> 56 57 #define KERN_CONT "" 58 #define KERN_EMERG "<0>" 59 #define KERN_ALERT "<1>" 60 #define KERN_CRIT "<2>" 61 #define KERN_ERR "<3>" 62 #define KERN_WARNING "<4>" 63 #define KERN_NOTICE "<5>" 64 #define KERN_INFO "<6>" 65 #define KERN_DEBUG "<7>" 66 67 #define U8_MAX ((u8)~0U) 68 #define S8_MAX ((s8)(U8_MAX >> 1)) 69 #define S8_MIN ((s8)(-S8_MAX - 1)) 70 #define U16_MAX ((u16)~0U) 71 #define S16_MAX ((s16)(U16_MAX >> 1)) 72 #define S16_MIN ((s16)(-S16_MAX - 1)) 73 #define U32_MAX ((u32)~0U) 74 #define S32_MAX ((s32)(U32_MAX >> 1)) 75 #define S32_MIN ((s32)(-S32_MAX - 1)) 76 #define U64_MAX ((u64)~0ULL) 77 #define S64_MAX ((s64)(U64_MAX >> 1)) 78 #define S64_MIN ((s64)(-S64_MAX - 1)) 79 80 #define S8_C(x) x 81 #define U8_C(x) x ## U 82 #define S16_C(x) x 83 #define U16_C(x) x ## U 84 #define S32_C(x) x 85 #define U32_C(x) x ## U 86 #define S64_C(x) x ## LL 87 #define U64_C(x) x ## ULL 88 89 #define BUILD_BUG_ON(x) CTASSERT(!(x)) 90 #define BUILD_BUG_ON_MSG(x, msg) BUILD_BUG_ON(x) 91 #define BUILD_BUG_ON_NOT_POWER_OF_2(x) BUILD_BUG_ON(!powerof2(x)) 92 93 #define BUG() panic("BUG at %s:%d", __FILE__, __LINE__) 94 #define BUG_ON(cond) do { \ 95 if (cond) { \ 96 panic("BUG ON %s failed at %s:%d", \ 97 __stringify(cond), __FILE__, __LINE__); \ 98 } \ 99 } while (0) 100 101 #define WARN_ON(cond) ({ \ 102 bool __ret = (cond); \ 103 if (__ret) { \ 104 printf("WARNING %s failed at %s:%d\n", \ 105 __stringify(cond), __FILE__, __LINE__); \ 106 } \ 107 unlikely(__ret); \ 108 }) 109 110 #define WARN_ON_SMP(cond) WARN_ON(cond) 111 112 #define WARN_ON_ONCE(cond) ({ \ 113 static bool __warn_on_once; \ 114 bool __ret = (cond); \ 115 if (__ret && !__warn_on_once) { \ 116 __warn_on_once = 1; \ 117 printf("WARNING %s failed at %s:%d\n", \ 118 __stringify(cond), __FILE__, __LINE__); \ 119 } \ 120 unlikely(__ret); \ 121 }) 122 123 #define oops_in_progress SCHEDULER_STOPPED() 124 125 #undef ALIGN 126 #define ALIGN(x, y) roundup2((x), (y)) 127 #undef PTR_ALIGN 128 #define PTR_ALIGN(p, a) ((__typeof(p))ALIGN((uintptr_t)(p), (a))) 129 #define DIV_ROUND_UP(x, n) howmany(x, n) 130 #define DIV_ROUND_UP_ULL(x, n) DIV_ROUND_UP((unsigned long long)(x), (n)) 131 #define FIELD_SIZEOF(t, f) sizeof(((t *)0)->f) 132 133 #define printk(...) printf(__VA_ARGS__) 134 #define vprintk(f, a) vprintf(f, a) 135 136 struct va_format { 137 const char *fmt; 138 va_list *va; 139 }; 140 141 static inline int 142 vscnprintf(char *buf, size_t size, const char *fmt, va_list args) 143 { 144 ssize_t ssize = size; 145 int i; 146 147 i = vsnprintf(buf, size, fmt, args); 148 149 return ((i >= ssize) ? (ssize - 1) : i); 150 } 151 152 static inline int 153 scnprintf(char *buf, size_t size, const char *fmt, ...) 154 { 155 va_list args; 156 int i; 157 158 va_start(args, fmt); 159 i = vscnprintf(buf, size, fmt, args); 160 va_end(args); 161 162 return (i); 163 } 164 165 /* 166 * The "pr_debug()" and "pr_devel()" macros should produce zero code 167 * unless DEBUG is defined: 168 */ 169 #ifdef DEBUG 170 #define pr_debug(fmt, ...) \ 171 log(LOG_DEBUG, fmt, ##__VA_ARGS__) 172 #define pr_devel(fmt, ...) \ 173 log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__) 174 #else 175 #define pr_debug(fmt, ...) \ 176 ({ if (0) log(LOG_DEBUG, fmt, ##__VA_ARGS__); 0; }) 177 #define pr_devel(fmt, ...) \ 178 ({ if (0) log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__); 0; }) 179 #endif 180 181 #ifndef pr_fmt 182 #define pr_fmt(fmt) fmt 183 #endif 184 185 /* 186 * Print a one-time message (analogous to WARN_ONCE() et al): 187 */ 188 #define printk_once(...) do { \ 189 static bool __print_once; \ 190 \ 191 if (!__print_once) { \ 192 __print_once = true; \ 193 printk(__VA_ARGS__); \ 194 } \ 195 } while (0) 196 197 /* 198 * Log a one-time message (analogous to WARN_ONCE() et al): 199 */ 200 #define log_once(level,...) do { \ 201 static bool __log_once; \ 202 \ 203 if (unlikely(!__log_once)) { \ 204 __log_once = true; \ 205 log(level, __VA_ARGS__); \ 206 } \ 207 } while (0) 208 209 #define pr_emerg(fmt, ...) \ 210 log(LOG_EMERG, pr_fmt(fmt), ##__VA_ARGS__) 211 #define pr_alert(fmt, ...) \ 212 log(LOG_ALERT, pr_fmt(fmt), ##__VA_ARGS__) 213 #define pr_crit(fmt, ...) \ 214 log(LOG_CRIT, pr_fmt(fmt), ##__VA_ARGS__) 215 #define pr_err(fmt, ...) \ 216 log(LOG_ERR, pr_fmt(fmt), ##__VA_ARGS__) 217 #define pr_warning(fmt, ...) \ 218 log(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__) 219 #define pr_warn(...) \ 220 pr_warning(__VA_ARGS__) 221 #define pr_warn_once(fmt, ...) \ 222 log_once(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__) 223 #define pr_notice(fmt, ...) \ 224 log(LOG_NOTICE, pr_fmt(fmt), ##__VA_ARGS__) 225 #define pr_info(fmt, ...) \ 226 log(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__) 227 #define pr_info_once(fmt, ...) \ 228 log_once(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__) 229 #define pr_cont(fmt, ...) \ 230 printk(KERN_CONT fmt, ##__VA_ARGS__) 231 #define pr_warn_ratelimited(...) do { \ 232 static linux_ratelimit_t __ratelimited; \ 233 if (linux_ratelimited(&__ratelimited)) \ 234 pr_warning(__VA_ARGS__); \ 235 } while (0) 236 237 #ifndef WARN 238 #define WARN(condition, ...) ({ \ 239 bool __ret_warn_on = (condition); \ 240 if (unlikely(__ret_warn_on)) \ 241 pr_warning(__VA_ARGS__); \ 242 unlikely(__ret_warn_on); \ 243 }) 244 #endif 245 246 #ifndef WARN_ONCE 247 #define WARN_ONCE(condition, ...) ({ \ 248 bool __ret_warn_on = (condition); \ 249 if (unlikely(__ret_warn_on)) \ 250 pr_warn_once(__VA_ARGS__); \ 251 unlikely(__ret_warn_on); \ 252 }) 253 #endif 254 255 #define container_of(ptr, type, member) \ 256 ({ \ 257 const __typeof(((type *)0)->member) *__p = (ptr); \ 258 (type *)((uintptr_t)__p - offsetof(type, member)); \ 259 }) 260 261 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) 262 263 static inline unsigned long long 264 simple_strtoull(const char *cp, char **endp, unsigned int base) 265 { 266 return (strtouq(cp, endp, base)); 267 } 268 269 static inline long long 270 simple_strtoll(const char *cp, char **endp, unsigned int base) 271 { 272 return (strtoq(cp, endp, base)); 273 } 274 275 static inline unsigned long 276 simple_strtoul(const char *cp, char **endp, unsigned int base) 277 { 278 return (strtoul(cp, endp, base)); 279 } 280 281 static inline long 282 simple_strtol(const char *cp, char **endp, unsigned int base) 283 { 284 return (strtol(cp, endp, base)); 285 } 286 287 static inline int 288 kstrtoul(const char *cp, unsigned int base, unsigned long *res) 289 { 290 char *end; 291 292 *res = strtoul(cp, &end, base); 293 294 if (*cp == 0 || *end != 0) 295 return (-EINVAL); 296 return (0); 297 } 298 299 static inline int 300 kstrtol(const char *cp, unsigned int base, long *res) 301 { 302 char *end; 303 304 *res = strtol(cp, &end, base); 305 306 if (*cp == 0 || *end != 0) 307 return (-EINVAL); 308 return (0); 309 } 310 311 static inline int 312 kstrtoint(const char *cp, unsigned int base, int *res) 313 { 314 char *end; 315 long temp; 316 317 *res = temp = strtol(cp, &end, base); 318 319 if (*cp == 0 || *end != 0) 320 return (-EINVAL); 321 if (temp != (int)temp) 322 return (-ERANGE); 323 return (0); 324 } 325 326 static inline int 327 kstrtouint(const char *cp, unsigned int base, unsigned int *res) 328 { 329 char *end; 330 unsigned long temp; 331 332 *res = temp = strtoul(cp, &end, base); 333 334 if (*cp == 0 || *end != 0) 335 return (-EINVAL); 336 if (temp != (unsigned int)temp) 337 return (-ERANGE); 338 return (0); 339 } 340 341 static inline int 342 kstrtou32(const char *cp, unsigned int base, u32 *res) 343 { 344 char *end; 345 unsigned long temp; 346 347 *res = temp = strtoul(cp, &end, base); 348 349 if (*cp == 0 || *end != 0) 350 return (-EINVAL); 351 if (temp != (u32)temp) 352 return (-ERANGE); 353 return (0); 354 } 355 356 #define min(x, y) ((x) < (y) ? (x) : (y)) 357 #define max(x, y) ((x) > (y) ? (x) : (y)) 358 359 #define min3(a, b, c) min(a, min(b,c)) 360 #define max3(a, b, c) max(a, max(b,c)) 361 362 #define min_t(type, x, y) ({ \ 363 type __min1 = (x); \ 364 type __min2 = (y); \ 365 __min1 < __min2 ? __min1 : __min2; }) 366 367 #define max_t(type, x, y) ({ \ 368 type __max1 = (x); \ 369 type __max2 = (y); \ 370 __max1 > __max2 ? __max1 : __max2; }) 371 372 #define clamp_t(type, _x, min, max) min_t(type, max_t(type, _x, min), max) 373 #define clamp(x, lo, hi) min( max(x,lo), hi) 374 #define clamp_val(val, lo, hi) clamp_t(typeof(val), val, lo, hi) 375 376 /* 377 * This looks more complex than it should be. But we need to 378 * get the type for the ~ right in round_down (it needs to be 379 * as wide as the result!), and we want to evaluate the macro 380 * arguments just once each. 381 */ 382 #define __round_mask(x, y) ((__typeof__(x))((y)-1)) 383 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1) 384 #define round_down(x, y) ((x) & ~__round_mask(x, y)) 385 386 #define smp_processor_id() PCPU_GET(cpuid) 387 #define num_possible_cpus() mp_ncpus 388 #define num_online_cpus() mp_ncpus 389 390 #if defined(__i386__) || defined(__amd64__) 391 extern bool linux_cpu_has_clflush; 392 #define cpu_has_clflush linux_cpu_has_clflush 393 #endif 394 395 typedef struct pm_message { 396 int event; 397 } pm_message_t; 398 399 /* Swap values of a and b */ 400 #define swap(a, b) do { \ 401 typeof(a) _swap_tmp = a; \ 402 a = b; \ 403 b = _swap_tmp; \ 404 } while (0) 405 406 #define DIV_ROUND_CLOSEST(x, divisor) (((x) + ((divisor) / 2)) / (divisor)) 407 408 #define DIV_ROUND_CLOSEST_ULL(x, divisor) ({ \ 409 __typeof(divisor) __d = (divisor); \ 410 unsigned long long __ret = (x) + (__d) / 2; \ 411 __ret /= __d; \ 412 __ret; \ 413 }) 414 415 static inline uintmax_t 416 mult_frac(uintmax_t x, uintmax_t multiplier, uintmax_t divisor) 417 { 418 uintmax_t q = (x / divisor); 419 uintmax_t r = (x % divisor); 420 421 return ((q * multiplier) + ((r * multiplier) / divisor)); 422 } 423 424 static inline int64_t 425 abs64(int64_t x) 426 { 427 return (x < 0 ? -x : x); 428 } 429 430 typedef struct linux_ratelimit { 431 struct timeval lasttime; 432 int counter; 433 } linux_ratelimit_t; 434 435 static inline bool 436 linux_ratelimited(linux_ratelimit_t *rl) 437 { 438 return (ppsratecheck(&rl->lasttime, &rl->counter, 1)); 439 } 440 441 #endif /* _LINUX_KERNEL_H_ */ 442