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 extern void linux_dump_stack(void); 142 #define dump_stack() linux_dump_stack() 143 144 struct va_format { 145 const char *fmt; 146 va_list *va; 147 }; 148 149 static inline int 150 vscnprintf(char *buf, size_t size, const char *fmt, va_list args) 151 { 152 ssize_t ssize = size; 153 int i; 154 155 i = vsnprintf(buf, size, fmt, args); 156 157 return ((i >= ssize) ? (ssize - 1) : i); 158 } 159 160 static inline int 161 scnprintf(char *buf, size_t size, const char *fmt, ...) 162 { 163 va_list args; 164 int i; 165 166 va_start(args, fmt); 167 i = vscnprintf(buf, size, fmt, args); 168 va_end(args); 169 170 return (i); 171 } 172 173 /* 174 * The "pr_debug()" and "pr_devel()" macros should produce zero code 175 * unless DEBUG is defined: 176 */ 177 #ifdef DEBUG 178 #define pr_debug(fmt, ...) \ 179 log(LOG_DEBUG, fmt, ##__VA_ARGS__) 180 #define pr_devel(fmt, ...) \ 181 log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__) 182 #else 183 #define pr_debug(fmt, ...) \ 184 ({ if (0) log(LOG_DEBUG, fmt, ##__VA_ARGS__); 0; }) 185 #define pr_devel(fmt, ...) \ 186 ({ if (0) log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__); 0; }) 187 #endif 188 189 #ifndef pr_fmt 190 #define pr_fmt(fmt) fmt 191 #endif 192 193 /* 194 * Print a one-time message (analogous to WARN_ONCE() et al): 195 */ 196 #define printk_once(...) do { \ 197 static bool __print_once; \ 198 \ 199 if (!__print_once) { \ 200 __print_once = true; \ 201 printk(__VA_ARGS__); \ 202 } \ 203 } while (0) 204 205 /* 206 * Log a one-time message (analogous to WARN_ONCE() et al): 207 */ 208 #define log_once(level,...) do { \ 209 static bool __log_once; \ 210 \ 211 if (unlikely(!__log_once)) { \ 212 __log_once = true; \ 213 log(level, __VA_ARGS__); \ 214 } \ 215 } while (0) 216 217 #define pr_emerg(fmt, ...) \ 218 log(LOG_EMERG, pr_fmt(fmt), ##__VA_ARGS__) 219 #define pr_alert(fmt, ...) \ 220 log(LOG_ALERT, pr_fmt(fmt), ##__VA_ARGS__) 221 #define pr_crit(fmt, ...) \ 222 log(LOG_CRIT, pr_fmt(fmt), ##__VA_ARGS__) 223 #define pr_err(fmt, ...) \ 224 log(LOG_ERR, pr_fmt(fmt), ##__VA_ARGS__) 225 #define pr_warning(fmt, ...) \ 226 log(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__) 227 #define pr_warn(...) \ 228 pr_warning(__VA_ARGS__) 229 #define pr_warn_once(fmt, ...) \ 230 log_once(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__) 231 #define pr_notice(fmt, ...) \ 232 log(LOG_NOTICE, pr_fmt(fmt), ##__VA_ARGS__) 233 #define pr_info(fmt, ...) \ 234 log(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__) 235 #define pr_info_once(fmt, ...) \ 236 log_once(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__) 237 #define pr_cont(fmt, ...) \ 238 printk(KERN_CONT fmt, ##__VA_ARGS__) 239 #define pr_warn_ratelimited(...) do { \ 240 static linux_ratelimit_t __ratelimited; \ 241 if (linux_ratelimited(&__ratelimited)) \ 242 pr_warning(__VA_ARGS__); \ 243 } while (0) 244 245 #ifndef WARN 246 #define WARN(condition, ...) ({ \ 247 bool __ret_warn_on = (condition); \ 248 if (unlikely(__ret_warn_on)) \ 249 pr_warning(__VA_ARGS__); \ 250 unlikely(__ret_warn_on); \ 251 }) 252 #endif 253 254 #ifndef WARN_ONCE 255 #define WARN_ONCE(condition, ...) ({ \ 256 bool __ret_warn_on = (condition); \ 257 if (unlikely(__ret_warn_on)) \ 258 pr_warn_once(__VA_ARGS__); \ 259 unlikely(__ret_warn_on); \ 260 }) 261 #endif 262 263 #define container_of(ptr, type, member) \ 264 ({ \ 265 const __typeof(((type *)0)->member) *__p = (ptr); \ 266 (type *)((uintptr_t)__p - offsetof(type, member)); \ 267 }) 268 269 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) 270 271 #define u64_to_user_ptr(val) ((void *)(uintptr_t)(val)) 272 273 static inline unsigned long long 274 simple_strtoull(const char *cp, char **endp, unsigned int base) 275 { 276 return (strtouq(cp, endp, base)); 277 } 278 279 static inline long long 280 simple_strtoll(const char *cp, char **endp, unsigned int base) 281 { 282 return (strtoq(cp, endp, base)); 283 } 284 285 static inline unsigned long 286 simple_strtoul(const char *cp, char **endp, unsigned int base) 287 { 288 return (strtoul(cp, endp, base)); 289 } 290 291 static inline long 292 simple_strtol(const char *cp, char **endp, unsigned int base) 293 { 294 return (strtol(cp, endp, base)); 295 } 296 297 static inline int 298 kstrtoul(const char *cp, unsigned int base, unsigned long *res) 299 { 300 char *end; 301 302 *res = strtoul(cp, &end, base); 303 304 /* skip newline character, if any */ 305 if (*end == '\n') 306 end++; 307 if (*cp == 0 || *end != 0) 308 return (-EINVAL); 309 return (0); 310 } 311 312 static inline int 313 kstrtol(const char *cp, unsigned int base, long *res) 314 { 315 char *end; 316 317 *res = strtol(cp, &end, base); 318 319 /* skip newline character, if any */ 320 if (*end == '\n') 321 end++; 322 if (*cp == 0 || *end != 0) 323 return (-EINVAL); 324 return (0); 325 } 326 327 static inline int 328 kstrtoint(const char *cp, unsigned int base, int *res) 329 { 330 char *end; 331 long temp; 332 333 *res = temp = strtol(cp, &end, base); 334 335 /* skip newline character, if any */ 336 if (*end == '\n') 337 end++; 338 if (*cp == 0 || *end != 0) 339 return (-EINVAL); 340 if (temp != (int)temp) 341 return (-ERANGE); 342 return (0); 343 } 344 345 static inline int 346 kstrtouint(const char *cp, unsigned int base, unsigned int *res) 347 { 348 char *end; 349 unsigned long temp; 350 351 *res = temp = strtoul(cp, &end, base); 352 353 /* skip newline character, if any */ 354 if (*end == '\n') 355 end++; 356 if (*cp == 0 || *end != 0) 357 return (-EINVAL); 358 if (temp != (unsigned int)temp) 359 return (-ERANGE); 360 return (0); 361 } 362 363 static inline int 364 kstrtou32(const char *cp, unsigned int base, u32 *res) 365 { 366 char *end; 367 unsigned long temp; 368 369 *res = temp = strtoul(cp, &end, base); 370 371 /* skip newline character, if any */ 372 if (*end == '\n') 373 end++; 374 if (*cp == 0 || *end != 0) 375 return (-EINVAL); 376 if (temp != (u32)temp) 377 return (-ERANGE); 378 return (0); 379 } 380 381 static inline int 382 kstrtobool(const char *s, bool *res) 383 { 384 int len; 385 386 if (s == NULL || (len = strlen(s)) == 0 || res == NULL) 387 return (-EINVAL); 388 389 /* skip newline character, if any */ 390 if (s[len - 1] == '\n') 391 len--; 392 393 if (len == 1 && strchr("yY1", s[0]) != NULL) 394 *res = true; 395 else if (len == 1 && strchr("nN0", s[0]) != NULL) 396 *res = false; 397 else if (strncasecmp("on", s, len) == 0) 398 *res = true; 399 else if (strncasecmp("off", s, len) == 0) 400 *res = false; 401 else 402 return (-EINVAL); 403 404 return (0); 405 } 406 407 static inline int 408 kstrtobool_from_user(const char __user *s, size_t count, bool *res) 409 { 410 char buf[8] = {}; 411 412 if (count > (sizeof(buf) - 1)) 413 count = (sizeof(buf) - 1); 414 415 if (copy_from_user(buf, s, count)) 416 return (-EFAULT); 417 418 return (kstrtobool(buf, res)); 419 } 420 421 #define min(x, y) ((x) < (y) ? (x) : (y)) 422 #define max(x, y) ((x) > (y) ? (x) : (y)) 423 424 #define min3(a, b, c) min(a, min(b,c)) 425 #define max3(a, b, c) max(a, max(b,c)) 426 427 #define min_t(type, x, y) ({ \ 428 type __min1 = (x); \ 429 type __min2 = (y); \ 430 __min1 < __min2 ? __min1 : __min2; }) 431 432 #define max_t(type, x, y) ({ \ 433 type __max1 = (x); \ 434 type __max2 = (y); \ 435 __max1 > __max2 ? __max1 : __max2; }) 436 437 #define clamp_t(type, _x, min, max) min_t(type, max_t(type, _x, min), max) 438 #define clamp(x, lo, hi) min( max(x,lo), hi) 439 #define clamp_val(val, lo, hi) clamp_t(typeof(val), val, lo, hi) 440 441 /* 442 * This looks more complex than it should be. But we need to 443 * get the type for the ~ right in round_down (it needs to be 444 * as wide as the result!), and we want to evaluate the macro 445 * arguments just once each. 446 */ 447 #define __round_mask(x, y) ((__typeof__(x))((y)-1)) 448 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1) 449 #define round_down(x, y) ((x) & ~__round_mask(x, y)) 450 451 #define smp_processor_id() PCPU_GET(cpuid) 452 #define num_possible_cpus() mp_ncpus 453 #define num_online_cpus() mp_ncpus 454 455 #if defined(__i386__) || defined(__amd64__) 456 extern bool linux_cpu_has_clflush; 457 #define cpu_has_clflush linux_cpu_has_clflush 458 #endif 459 460 typedef struct pm_message { 461 int event; 462 } pm_message_t; 463 464 /* Swap values of a and b */ 465 #define swap(a, b) do { \ 466 typeof(a) _swap_tmp = a; \ 467 a = b; \ 468 b = _swap_tmp; \ 469 } while (0) 470 471 #define DIV_ROUND_CLOSEST(x, divisor) (((x) + ((divisor) / 2)) / (divisor)) 472 473 #define DIV_ROUND_CLOSEST_ULL(x, divisor) ({ \ 474 __typeof(divisor) __d = (divisor); \ 475 unsigned long long __ret = (x) + (__d) / 2; \ 476 __ret /= __d; \ 477 __ret; \ 478 }) 479 480 static inline uintmax_t 481 mult_frac(uintmax_t x, uintmax_t multiplier, uintmax_t divisor) 482 { 483 uintmax_t q = (x / divisor); 484 uintmax_t r = (x % divisor); 485 486 return ((q * multiplier) + ((r * multiplier) / divisor)); 487 } 488 489 static inline int64_t 490 abs64(int64_t x) 491 { 492 return (x < 0 ? -x : x); 493 } 494 495 typedef struct linux_ratelimit { 496 struct timeval lasttime; 497 int counter; 498 } linux_ratelimit_t; 499 500 static inline bool 501 linux_ratelimited(linux_ratelimit_t *rl) 502 { 503 return (ppsratecheck(&rl->lasttime, &rl->counter, 1)); 504 } 505 506 #endif /* _LINUX_KERNEL_H_ */ 507