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 54 #include <asm/byteorder.h> 55 #include <asm/uaccess.h> 56 57 #include <machine/stdarg.h> 58 59 #define KERN_CONT "" 60 #define KERN_EMERG "<0>" 61 #define KERN_ALERT "<1>" 62 #define KERN_CRIT "<2>" 63 #define KERN_ERR "<3>" 64 #define KERN_WARNING "<4>" 65 #define KERN_NOTICE "<5>" 66 #define KERN_INFO "<6>" 67 #define KERN_DEBUG "<7>" 68 69 #define U8_MAX ((u8)~0U) 70 #define S8_MAX ((s8)(U8_MAX >> 1)) 71 #define S8_MIN ((s8)(-S8_MAX - 1)) 72 #define U16_MAX ((u16)~0U) 73 #define S16_MAX ((s16)(U16_MAX >> 1)) 74 #define S16_MIN ((s16)(-S16_MAX - 1)) 75 #define U32_MAX ((u32)~0U) 76 #define S32_MAX ((s32)(U32_MAX >> 1)) 77 #define S32_MIN ((s32)(-S32_MAX - 1)) 78 #define U64_MAX ((u64)~0ULL) 79 #define S64_MAX ((s64)(U64_MAX >> 1)) 80 #define S64_MIN ((s64)(-S64_MAX - 1)) 81 82 #define S8_C(x) x 83 #define U8_C(x) x ## U 84 #define S16_C(x) x 85 #define U16_C(x) x ## U 86 #define S32_C(x) x 87 #define U32_C(x) x ## U 88 #define S64_C(x) x ## LL 89 #define U64_C(x) x ## ULL 90 91 #define BUILD_BUG() do { CTASSERT(0); } while (0) 92 #define BUILD_BUG_ON(x) CTASSERT(!(x)) 93 #define BUILD_BUG_ON_MSG(x, msg) BUILD_BUG_ON(x) 94 #define BUILD_BUG_ON_NOT_POWER_OF_2(x) BUILD_BUG_ON(!powerof2(x)) 95 #define BUILD_BUG_ON_INVALID(expr) while (0) { (void)(expr); } 96 97 #define BUG() panic("BUG at %s:%d", __FILE__, __LINE__) 98 #define BUG_ON(cond) do { \ 99 if (cond) { \ 100 panic("BUG ON %s failed at %s:%d", \ 101 __stringify(cond), __FILE__, __LINE__); \ 102 } \ 103 } while (0) 104 105 #define WARN_ON(cond) ({ \ 106 bool __ret = (cond); \ 107 if (__ret) { \ 108 printf("WARNING %s failed at %s:%d\n", \ 109 __stringify(cond), __FILE__, __LINE__); \ 110 } \ 111 unlikely(__ret); \ 112 }) 113 114 #define WARN_ON_SMP(cond) WARN_ON(cond) 115 116 #define WARN_ON_ONCE(cond) ({ \ 117 static bool __warn_on_once; \ 118 bool __ret = (cond); \ 119 if (__ret && !__warn_on_once) { \ 120 __warn_on_once = 1; \ 121 printf("WARNING %s failed at %s:%d\n", \ 122 __stringify(cond), __FILE__, __LINE__); \ 123 } \ 124 unlikely(__ret); \ 125 }) 126 127 #define oops_in_progress SCHEDULER_STOPPED() 128 129 #undef ALIGN 130 #define ALIGN(x, y) roundup2((x), (y)) 131 #undef PTR_ALIGN 132 #define PTR_ALIGN(p, a) ((__typeof(p))ALIGN((uintptr_t)(p), (a))) 133 #define DIV_ROUND_UP(x, n) howmany(x, n) 134 #define __KERNEL_DIV_ROUND_UP(x, n) howmany(x, n) 135 #define DIV_ROUND_UP_ULL(x, n) DIV_ROUND_UP((unsigned long long)(x), (n)) 136 #define FIELD_SIZEOF(t, f) sizeof(((t *)0)->f) 137 138 #define printk(...) printf(__VA_ARGS__) 139 #define vprintk(f, a) vprintf(f, a) 140 141 #define asm __asm 142 143 extern void linux_dump_stack(void); 144 #define dump_stack() linux_dump_stack() 145 146 struct va_format { 147 const char *fmt; 148 va_list *va; 149 }; 150 151 static inline int 152 vscnprintf(char *buf, size_t size, const char *fmt, va_list args) 153 { 154 ssize_t ssize = size; 155 int i; 156 157 i = vsnprintf(buf, size, fmt, args); 158 159 return ((i >= ssize) ? (ssize - 1) : i); 160 } 161 162 static inline int 163 scnprintf(char *buf, size_t size, const char *fmt, ...) 164 { 165 va_list args; 166 int i; 167 168 va_start(args, fmt); 169 i = vscnprintf(buf, size, fmt, args); 170 va_end(args); 171 172 return (i); 173 } 174 175 /* 176 * The "pr_debug()" and "pr_devel()" macros should produce zero code 177 * unless DEBUG is defined: 178 */ 179 #ifdef DEBUG 180 extern int linuxkpi_debug; 181 #define pr_debug(fmt, ...) \ 182 do { \ 183 if (linuxkpi_debug) \ 184 log(LOG_DEBUG, fmt, ##__VA_ARGS__); \ 185 } while (0) 186 #define pr_devel(fmt, ...) \ 187 log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__) 188 #else 189 #define pr_debug(fmt, ...) \ 190 ({ if (0) log(LOG_DEBUG, fmt, ##__VA_ARGS__); 0; }) 191 #define pr_devel(fmt, ...) \ 192 ({ if (0) log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__); 0; }) 193 #endif 194 195 #ifndef pr_fmt 196 #define pr_fmt(fmt) fmt 197 #endif 198 199 /* 200 * Print a one-time message (analogous to WARN_ONCE() et al): 201 */ 202 #define printk_once(...) do { \ 203 static bool __print_once; \ 204 \ 205 if (!__print_once) { \ 206 __print_once = true; \ 207 printk(__VA_ARGS__); \ 208 } \ 209 } while (0) 210 211 /* 212 * Log a one-time message (analogous to WARN_ONCE() et al): 213 */ 214 #define log_once(level,...) do { \ 215 static bool __log_once; \ 216 \ 217 if (unlikely(!__log_once)) { \ 218 __log_once = true; \ 219 log(level, __VA_ARGS__); \ 220 } \ 221 } while (0) 222 223 #define pr_emerg(fmt, ...) \ 224 log(LOG_EMERG, pr_fmt(fmt), ##__VA_ARGS__) 225 #define pr_alert(fmt, ...) \ 226 log(LOG_ALERT, pr_fmt(fmt), ##__VA_ARGS__) 227 #define pr_crit(fmt, ...) \ 228 log(LOG_CRIT, pr_fmt(fmt), ##__VA_ARGS__) 229 #define pr_err(fmt, ...) \ 230 log(LOG_ERR, pr_fmt(fmt), ##__VA_ARGS__) 231 #define pr_warning(fmt, ...) \ 232 log(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__) 233 #define pr_warn(...) \ 234 pr_warning(__VA_ARGS__) 235 #define pr_warn_once(fmt, ...) \ 236 log_once(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__) 237 #define pr_notice(fmt, ...) \ 238 log(LOG_NOTICE, pr_fmt(fmt), ##__VA_ARGS__) 239 #define pr_info(fmt, ...) \ 240 log(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__) 241 #define pr_info_once(fmt, ...) \ 242 log_once(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__) 243 #define pr_cont(fmt, ...) \ 244 printk(KERN_CONT fmt, ##__VA_ARGS__) 245 #define pr_warn_ratelimited(...) do { \ 246 static linux_ratelimit_t __ratelimited; \ 247 if (linux_ratelimited(&__ratelimited)) \ 248 pr_warning(__VA_ARGS__); \ 249 } while (0) 250 251 #ifndef WARN 252 #define WARN(condition, ...) ({ \ 253 bool __ret_warn_on = (condition); \ 254 if (unlikely(__ret_warn_on)) \ 255 pr_warning(__VA_ARGS__); \ 256 unlikely(__ret_warn_on); \ 257 }) 258 #endif 259 260 #ifndef WARN_ONCE 261 #define WARN_ONCE(condition, ...) ({ \ 262 bool __ret_warn_on = (condition); \ 263 if (unlikely(__ret_warn_on)) \ 264 pr_warn_once(__VA_ARGS__); \ 265 unlikely(__ret_warn_on); \ 266 }) 267 #endif 268 269 #define container_of(ptr, type, member) \ 270 ({ \ 271 const __typeof(((type *)0)->member) *__p = (ptr); \ 272 (type *)((uintptr_t)__p - offsetof(type, member)); \ 273 }) 274 275 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) 276 277 #define u64_to_user_ptr(val) ((void *)(uintptr_t)(val)) 278 279 static inline unsigned long long 280 simple_strtoull(const char *cp, char **endp, unsigned int base) 281 { 282 return (strtouq(cp, endp, base)); 283 } 284 285 static inline long long 286 simple_strtoll(const char *cp, char **endp, unsigned int base) 287 { 288 return (strtoq(cp, endp, base)); 289 } 290 291 static inline unsigned long 292 simple_strtoul(const char *cp, char **endp, unsigned int base) 293 { 294 return (strtoul(cp, endp, base)); 295 } 296 297 static inline long 298 simple_strtol(const char *cp, char **endp, unsigned int base) 299 { 300 return (strtol(cp, endp, base)); 301 } 302 303 static inline int 304 kstrtoul(const char *cp, unsigned int base, unsigned long *res) 305 { 306 char *end; 307 308 *res = strtoul(cp, &end, base); 309 310 /* skip newline character, if any */ 311 if (*end == '\n') 312 end++; 313 if (*cp == 0 || *end != 0) 314 return (-EINVAL); 315 return (0); 316 } 317 318 static inline int 319 kstrtol(const char *cp, unsigned int base, long *res) 320 { 321 char *end; 322 323 *res = strtol(cp, &end, base); 324 325 /* skip newline character, if any */ 326 if (*end == '\n') 327 end++; 328 if (*cp == 0 || *end != 0) 329 return (-EINVAL); 330 return (0); 331 } 332 333 static inline int 334 kstrtoint(const char *cp, unsigned int base, int *res) 335 { 336 char *end; 337 long temp; 338 339 *res = temp = strtol(cp, &end, base); 340 341 /* skip newline character, if any */ 342 if (*end == '\n') 343 end++; 344 if (*cp == 0 || *end != 0) 345 return (-EINVAL); 346 if (temp != (int)temp) 347 return (-ERANGE); 348 return (0); 349 } 350 351 static inline int 352 kstrtouint(const char *cp, unsigned int base, unsigned int *res) 353 { 354 char *end; 355 unsigned long temp; 356 357 *res = temp = strtoul(cp, &end, base); 358 359 /* skip newline character, if any */ 360 if (*end == '\n') 361 end++; 362 if (*cp == 0 || *end != 0) 363 return (-EINVAL); 364 if (temp != (unsigned int)temp) 365 return (-ERANGE); 366 return (0); 367 } 368 369 static inline int 370 kstrtou32(const char *cp, unsigned int base, u32 *res) 371 { 372 char *end; 373 unsigned long temp; 374 375 *res = temp = strtoul(cp, &end, base); 376 377 /* skip newline character, if any */ 378 if (*end == '\n') 379 end++; 380 if (*cp == 0 || *end != 0) 381 return (-EINVAL); 382 if (temp != (u32)temp) 383 return (-ERANGE); 384 return (0); 385 } 386 387 static inline int 388 kstrtobool(const char *s, bool *res) 389 { 390 int len; 391 392 if (s == NULL || (len = strlen(s)) == 0 || res == NULL) 393 return (-EINVAL); 394 395 /* skip newline character, if any */ 396 if (s[len - 1] == '\n') 397 len--; 398 399 if (len == 1 && strchr("yY1", s[0]) != NULL) 400 *res = true; 401 else if (len == 1 && strchr("nN0", s[0]) != NULL) 402 *res = false; 403 else if (strncasecmp("on", s, len) == 0) 404 *res = true; 405 else if (strncasecmp("off", s, len) == 0) 406 *res = false; 407 else 408 return (-EINVAL); 409 410 return (0); 411 } 412 413 static inline int 414 kstrtobool_from_user(const char __user *s, size_t count, bool *res) 415 { 416 char buf[8] = {}; 417 418 if (count > (sizeof(buf) - 1)) 419 count = (sizeof(buf) - 1); 420 421 if (copy_from_user(buf, s, count)) 422 return (-EFAULT); 423 424 return (kstrtobool(buf, res)); 425 } 426 427 #define min(x, y) ((x) < (y) ? (x) : (y)) 428 #define max(x, y) ((x) > (y) ? (x) : (y)) 429 430 #define min3(a, b, c) min(a, min(b,c)) 431 #define max3(a, b, c) max(a, max(b,c)) 432 433 #define min_t(type, x, y) ({ \ 434 type __min1 = (x); \ 435 type __min2 = (y); \ 436 __min1 < __min2 ? __min1 : __min2; }) 437 438 #define max_t(type, x, y) ({ \ 439 type __max1 = (x); \ 440 type __max2 = (y); \ 441 __max1 > __max2 ? __max1 : __max2; }) 442 443 #define clamp_t(type, _x, min, max) min_t(type, max_t(type, _x, min), max) 444 #define clamp(x, lo, hi) min( max(x,lo), hi) 445 #define clamp_val(val, lo, hi) clamp_t(typeof(val), val, lo, hi) 446 447 /* 448 * This looks more complex than it should be. But we need to 449 * get the type for the ~ right in round_down (it needs to be 450 * as wide as the result!), and we want to evaluate the macro 451 * arguments just once each. 452 */ 453 #define __round_mask(x, y) ((__typeof__(x))((y)-1)) 454 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1) 455 #define round_down(x, y) ((x) & ~__round_mask(x, y)) 456 457 #define smp_processor_id() PCPU_GET(cpuid) 458 #define num_possible_cpus() mp_ncpus 459 #define num_online_cpus() mp_ncpus 460 461 #if defined(__i386__) || defined(__amd64__) 462 extern bool linux_cpu_has_clflush; 463 #define cpu_has_clflush linux_cpu_has_clflush 464 #endif 465 466 typedef struct pm_message { 467 int event; 468 } pm_message_t; 469 470 /* Swap values of a and b */ 471 #define swap(a, b) do { \ 472 typeof(a) _swap_tmp = a; \ 473 a = b; \ 474 b = _swap_tmp; \ 475 } while (0) 476 477 #define DIV_ROUND_CLOSEST(x, divisor) (((x) + ((divisor) / 2)) / (divisor)) 478 479 #define DIV_ROUND_CLOSEST_ULL(x, divisor) ({ \ 480 __typeof(divisor) __d = (divisor); \ 481 unsigned long long __ret = (x) + (__d) / 2; \ 482 __ret /= __d; \ 483 __ret; \ 484 }) 485 486 static inline uintmax_t 487 mult_frac(uintmax_t x, uintmax_t multiplier, uintmax_t divisor) 488 { 489 uintmax_t q = (x / divisor); 490 uintmax_t r = (x % divisor); 491 492 return ((q * multiplier) + ((r * multiplier) / divisor)); 493 } 494 495 static inline int64_t 496 abs64(int64_t x) 497 { 498 return (x < 0 ? -x : x); 499 } 500 501 typedef struct linux_ratelimit { 502 struct timeval lasttime; 503 int counter; 504 } linux_ratelimit_t; 505 506 static inline bool 507 linux_ratelimited(linux_ratelimit_t *rl) 508 { 509 return (ppsratecheck(&rl->lasttime, &rl->counter, 1)); 510 } 511 512 #endif /* _LINUX_KERNEL_H_ */ 513