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
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice unmodified, this list of conditions, and the following
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.
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.
32 #ifndef _LINUX_KERNEL_H_
33 #define _LINUX_KERNEL_H_
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>
42 #include <sys/stddef.h>
43 #include <sys/syslog.h>
46 #include <linux/bitops.h>
47 #include <linux/compiler.h>
48 #include <linux/stringify.h>
49 #include <linux/errno.h>
50 #include <linux/sched.h>
51 #include <linux/types.h>
52 #include <linux/jiffies.h>
53 #include <linux/log2.h>
55 #include <asm/byteorder.h>
56 #include <asm/uaccess.h>
58 #include <machine/stdarg.h>
61 #define KERN_EMERG "<0>"
62 #define KERN_ALERT "<1>"
63 #define KERN_CRIT "<2>"
64 #define KERN_ERR "<3>"
65 #define KERN_WARNING "<4>"
66 #define KERN_NOTICE "<5>"
67 #define KERN_INFO "<6>"
68 #define KERN_DEBUG "<7>"
70 #define U8_MAX ((u8)~0U)
71 #define S8_MAX ((s8)(U8_MAX >> 1))
72 #define S8_MIN ((s8)(-S8_MAX - 1))
73 #define U16_MAX ((u16)~0U)
74 #define S16_MAX ((s16)(U16_MAX >> 1))
75 #define S16_MIN ((s16)(-S16_MAX - 1))
76 #define U32_MAX ((u32)~0U)
77 #define S32_MAX ((s32)(U32_MAX >> 1))
78 #define S32_MIN ((s32)(-S32_MAX - 1))
79 #define U64_MAX ((u64)~0ULL)
80 #define S64_MAX ((s64)(U64_MAX >> 1))
81 #define S64_MIN ((s64)(-S64_MAX - 1))
84 #define U8_C(x) x ## U
86 #define U16_C(x) x ## U
88 #define U32_C(x) x ## U
89 #define S64_C(x) x ## LL
90 #define U64_C(x) x ## ULL
93 * BUILD_BUG_ON() can happen inside functions where _Static_assert() does not
94 * seem to work. Use old-schoold-ish CTASSERT from before commit
95 * a3085588a88fa58eb5b1eaae471999e1995a29cf but also make sure we do not
96 * end up with an unused typedef or variable. The compiler should optimise
99 #define _O_CTASSERT(x) _O__CTASSERT(x, __LINE__)
100 #define _O__CTASSERT(x, y) _O___CTASSERT(x, y)
101 #define _O___CTASSERT(x, y) while (0) { \
102 typedef char __assert_line_ ## y[(x) ? 1 : -1]; \
103 __assert_line_ ## y _x; \
107 #define BUILD_BUG() do { CTASSERT(0); } while (0)
108 #define BUILD_BUG_ON(x) do { _O_CTASSERT(!(x)) } while (0)
109 #define BUILD_BUG_ON_MSG(x, msg) BUILD_BUG_ON(x)
110 #define BUILD_BUG_ON_NOT_POWER_OF_2(x) BUILD_BUG_ON(!powerof2(x))
111 #define BUILD_BUG_ON_INVALID(expr) while (0) { (void)(expr); }
113 extern const volatile int lkpi_build_bug_on_zero;
114 #define BUILD_BUG_ON_ZERO(x) ((x) ? lkpi_build_bug_on_zero : 0)
116 #define BUG() panic("BUG at %s:%d", __FILE__, __LINE__)
117 #define BUG_ON(cond) do { \
119 panic("BUG ON %s failed at %s:%d", \
120 __stringify(cond), __FILE__, __LINE__); \
124 #define WARN_ON(cond) ({ \
125 bool __ret = (cond); \
127 printf("WARNING %s failed at %s:%d\n", \
128 __stringify(cond), __FILE__, __LINE__); \
129 linux_dump_stack(); \
134 #define WARN_ON_SMP(cond) WARN_ON(cond)
136 #define WARN_ON_ONCE(cond) ({ \
137 static bool __warn_on_once; \
138 bool __ret = (cond); \
139 if (__ret && !__warn_on_once) { \
140 __warn_on_once = 1; \
141 printf("WARNING %s failed at %s:%d\n", \
142 __stringify(cond), __FILE__, __LINE__); \
143 linux_dump_stack(); \
148 #define oops_in_progress SCHEDULER_STOPPED()
151 #define ALIGN(x, y) roundup2((x), (y))
153 #define PTR_ALIGN(p, a) ((__typeof(p))ALIGN((uintptr_t)(p), (a)))
154 #define IS_ALIGNED(x, a) (((x) & ((__typeof(x))(a) - 1)) == 0)
155 #define DIV_ROUND_UP(x, n) howmany(x, n)
156 #define __KERNEL_DIV_ROUND_UP(x, n) howmany(x, n)
157 #define DIV_ROUND_UP_ULL(x, n) DIV_ROUND_UP((unsigned long long)(x), (n))
158 #define DIV_ROUND_DOWN_ULL(x, n) (((unsigned long long)(x) / (n)) * (n))
159 #define FIELD_SIZEOF(t, f) sizeof(((t *)0)->f)
161 #define printk(...) printf(__VA_ARGS__)
162 #define vprintk(f, a) vprintf(f, a)
166 extern void linux_dump_stack(void);
167 #define dump_stack() linux_dump_stack()
175 vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
177 ssize_t ssize = size;
180 i = vsnprintf(buf, size, fmt, args);
182 return ((i >= ssize) ? (ssize - 1) : i);
186 scnprintf(char *buf, size_t size, const char *fmt, ...)
192 i = vscnprintf(buf, size, fmt, args);
199 * The "pr_debug()" and "pr_devel()" macros should produce zero code
200 * unless DEBUG is defined:
203 extern int linuxkpi_debug;
204 #define pr_debug(fmt, ...) \
206 if (linuxkpi_debug) \
207 log(LOG_DEBUG, fmt, ##__VA_ARGS__); \
209 #define pr_devel(fmt, ...) \
210 log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__)
212 #define pr_debug(fmt, ...) \
213 ({ if (0) log(LOG_DEBUG, fmt, ##__VA_ARGS__); 0; })
214 #define pr_devel(fmt, ...) \
215 ({ if (0) log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__); 0; })
219 #define pr_fmt(fmt) fmt
223 * Print a one-time message (analogous to WARN_ONCE() et al):
225 #define printk_once(...) do { \
226 static bool __print_once; \
228 if (!__print_once) { \
229 __print_once = true; \
230 printk(__VA_ARGS__); \
235 * Log a one-time message (analogous to WARN_ONCE() et al):
237 #define log_once(level,...) do { \
238 static bool __log_once; \
240 if (unlikely(!__log_once)) { \
242 log(level, __VA_ARGS__); \
246 #define pr_emerg(fmt, ...) \
247 log(LOG_EMERG, pr_fmt(fmt), ##__VA_ARGS__)
248 #define pr_alert(fmt, ...) \
249 log(LOG_ALERT, pr_fmt(fmt), ##__VA_ARGS__)
250 #define pr_crit(fmt, ...) \
251 log(LOG_CRIT, pr_fmt(fmt), ##__VA_ARGS__)
252 #define pr_err(fmt, ...) \
253 log(LOG_ERR, pr_fmt(fmt), ##__VA_ARGS__)
254 #define pr_err_once(fmt, ...) \
255 log_once(LOG_ERR, pr_fmt(fmt), ##__VA_ARGS__)
256 #define pr_warning(fmt, ...) \
257 log(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__)
258 #define pr_warn(...) \
259 pr_warning(__VA_ARGS__)
260 #define pr_warn_once(fmt, ...) \
261 log_once(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__)
262 #define pr_notice(fmt, ...) \
263 log(LOG_NOTICE, pr_fmt(fmt), ##__VA_ARGS__)
264 #define pr_info(fmt, ...) \
265 log(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__)
266 #define pr_info_once(fmt, ...) \
267 log_once(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__)
268 #define pr_cont(fmt, ...) \
269 printk(KERN_CONT fmt, ##__VA_ARGS__)
270 #define pr_warn_ratelimited(...) do { \
271 static linux_ratelimit_t __ratelimited; \
272 if (linux_ratelimited(&__ratelimited)) \
273 pr_warning(__VA_ARGS__); \
277 #define WARN(condition, ...) ({ \
278 bool __ret_warn_on = (condition); \
279 if (unlikely(__ret_warn_on)) \
280 pr_warning(__VA_ARGS__); \
281 unlikely(__ret_warn_on); \
286 #define WARN_ONCE(condition, ...) ({ \
287 bool __ret_warn_on = (condition); \
288 if (unlikely(__ret_warn_on)) \
289 pr_warn_once(__VA_ARGS__); \
290 unlikely(__ret_warn_on); \
294 #define container_of(ptr, type, member) \
296 const __typeof(((type *)0)->member) *__p = (ptr); \
297 (type *)((uintptr_t)__p - offsetof(type, member)); \
300 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
302 #define u64_to_user_ptr(val) ((void *)(uintptr_t)(val))
304 #define _RET_IP_ __builtin_return_address(0)
306 static inline unsigned long long
307 simple_strtoull(const char *cp, char **endp, unsigned int base)
309 return (strtouq(cp, endp, base));
312 static inline long long
313 simple_strtoll(const char *cp, char **endp, unsigned int base)
315 return (strtoq(cp, endp, base));
318 static inline unsigned long
319 simple_strtoul(const char *cp, char **endp, unsigned int base)
321 return (strtoul(cp, endp, base));
325 simple_strtol(const char *cp, char **endp, unsigned int base)
327 return (strtol(cp, endp, base));
331 kstrtoul(const char *cp, unsigned int base, unsigned long *res)
335 *res = strtoul(cp, &end, base);
337 /* skip newline character, if any */
340 if (*cp == 0 || *end != 0)
346 kstrtol(const char *cp, unsigned int base, long *res)
350 *res = strtol(cp, &end, base);
352 /* skip newline character, if any */
355 if (*cp == 0 || *end != 0)
361 kstrtoint(const char *cp, unsigned int base, int *res)
366 *res = temp = strtol(cp, &end, base);
368 /* skip newline character, if any */
371 if (*cp == 0 || *end != 0)
373 if (temp != (int)temp)
379 kstrtouint(const char *cp, unsigned int base, unsigned int *res)
384 *res = temp = strtoul(cp, &end, base);
386 /* skip newline character, if any */
389 if (*cp == 0 || *end != 0)
391 if (temp != (unsigned int)temp)
397 kstrtou16(const char *cp, unsigned int base, u16 *res)
402 *res = temp = strtoul(cp, &end, base);
404 /* skip newline character, if any */
407 if (*cp == 0 || *end != 0)
409 if (temp != (u16)temp)
415 kstrtou32(const char *cp, unsigned int base, u32 *res)
420 *res = temp = strtoul(cp, &end, base);
422 /* skip newline character, if any */
425 if (*cp == 0 || *end != 0)
427 if (temp != (u32)temp)
433 kstrtou64(const char *cp, unsigned int base, u64 *res)
437 *res = strtouq(cp, &end, base);
439 /* skip newline character, if any */
442 if (*cp == 0 || *end != 0)
448 kstrtobool(const char *s, bool *res)
452 if (s == NULL || (len = strlen(s)) == 0 || res == NULL)
455 /* skip newline character, if any */
456 if (s[len - 1] == '\n')
459 if (len == 1 && strchr("yY1", s[0]) != NULL)
461 else if (len == 1 && strchr("nN0", s[0]) != NULL)
463 else if (strncasecmp("on", s, len) == 0)
465 else if (strncasecmp("off", s, len) == 0)
474 kstrtobool_from_user(const char __user *s, size_t count, bool *res)
478 if (count > (sizeof(buf) - 1))
479 count = (sizeof(buf) - 1);
481 if (copy_from_user(buf, s, count))
484 return (kstrtobool(buf, res));
487 #define min(x, y) ((x) < (y) ? (x) : (y))
488 #define max(x, y) ((x) > (y) ? (x) : (y))
490 #define min3(a, b, c) min(a, min(b,c))
491 #define max3(a, b, c) max(a, max(b,c))
493 #define min_t(type, x, y) ({ \
496 __min1 < __min2 ? __min1 : __min2; })
498 #define max_t(type, x, y) ({ \
501 __max1 > __max2 ? __max1 : __max2; })
503 #define offsetofend(t, m) \
504 (offsetof(t, m) + sizeof((((t *)0)->m)))
506 #define clamp_t(type, _x, min, max) min_t(type, max_t(type, _x, min), max)
507 #define clamp(x, lo, hi) min( max(x,lo), hi)
508 #define clamp_val(val, lo, hi) clamp_t(typeof(val), val, lo, hi)
511 * This looks more complex than it should be. But we need to
512 * get the type for the ~ right in round_down (it needs to be
513 * as wide as the result!), and we want to evaluate the macro
514 * arguments just once each.
516 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
517 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
518 #define round_down(x, y) ((x) & ~__round_mask(x, y))
520 #define smp_processor_id() PCPU_GET(cpuid)
521 #define num_possible_cpus() mp_ncpus
522 #define num_online_cpus() mp_ncpus
524 #if defined(__i386__) || defined(__amd64__)
525 extern bool linux_cpu_has_clflush;
526 #define cpu_has_clflush linux_cpu_has_clflush
529 typedef struct pm_message {
533 /* Swap values of a and b */
534 #define swap(a, b) do { \
535 typeof(a) _swap_tmp = a; \
540 #define DIV_ROUND_CLOSEST(x, divisor) (((x) + ((divisor) / 2)) / (divisor))
542 #define DIV_ROUND_CLOSEST_ULL(x, divisor) ({ \
543 __typeof(divisor) __d = (divisor); \
544 unsigned long long __ret = (x) + (__d) / 2; \
549 static inline uintmax_t
550 mult_frac(uintmax_t x, uintmax_t multiplier, uintmax_t divisor)
552 uintmax_t q = (x / divisor);
553 uintmax_t r = (x % divisor);
555 return ((q * multiplier) + ((r * multiplier) / divisor));
558 static inline int64_t
561 return (x < 0 ? -x : x);
564 typedef struct linux_ratelimit {
565 struct timeval lasttime;
570 linux_ratelimited(linux_ratelimit_t *rl)
572 return (ppsratecheck(&rl->lasttime, &rl->counter, 1));
575 #define struct_size(ptr, field, num) ({ \
576 const size_t __size = offsetof(__typeof(*(ptr)), field); \
577 const size_t __max = (SIZE_MAX - __size) / sizeof((ptr)->field[0]); \
578 ((num) > __max) ? SIZE_MAX : (__size + sizeof((ptr)->field[0]) * (num)); \
581 #define __is_constexpr(x) \
582 __builtin_constant_p(x)
585 * The is_signed() macro below returns true if the passed data type is
586 * signed. Else false is returned.
588 #define is_signed(datatype) (((datatype)-1 / (datatype)2) == (datatype)0)
591 * The type_max() macro below returns the maxium positive value the
592 * passed data type can hold.
594 #define type_max(datatype) ( \
595 (sizeof(datatype) >= 8) ? (is_signed(datatype) ? INT64_MAX : UINT64_MAX) : \
596 (sizeof(datatype) >= 4) ? (is_signed(datatype) ? INT32_MAX : UINT32_MAX) : \
597 (sizeof(datatype) >= 2) ? (is_signed(datatype) ? INT16_MAX : UINT16_MAX) : \
598 (is_signed(datatype) ? INT8_MAX : UINT8_MAX) \
602 * The type_min() macro below returns the minimum value the passed
603 * data type can hold. For unsigned types the minimum value is always
604 * zero. For signed types it may vary.
606 #define type_min(datatype) ( \
607 (sizeof(datatype) >= 8) ? (is_signed(datatype) ? INT64_MIN : 0) : \
608 (sizeof(datatype) >= 4) ? (is_signed(datatype) ? INT32_MIN : 0) : \
609 (sizeof(datatype) >= 2) ? (is_signed(datatype) ? INT16_MIN : 0) : \
610 (is_signed(datatype) ? INT8_MIN : 0) \
614 #define test_taint(x) (0)
617 * Checking if an option is defined would be easy if we could do CPP inside CPP.
618 * The defined case whether -Dxxx or -Dxxx=1 are easy to deal with. In either
619 * case the defined value is "1". A more general -Dxxx=<c> case will require
620 * more effort to deal with all possible "true" values. Hope we do not have
621 * to do this as well.
622 * The real problem is the undefined case. To avoid this problem we do the
623 * concat/varargs trick: "yyy" ## xxx can make two arguments if xxx is "1"
624 * by having a #define for yyy_1 which is "ignore,".
625 * Otherwise we will just get "yyy".
626 * Need to be careful about variable substitutions in macros though.
627 * This way we make a (true, false) problem a (don't care, true, false) or a
628 * (don't care true, false). Then we can use a variadic macro to only select
629 * the always well known and defined argument #2. And that seems to be
630 * exactly what we need. Use 1 for true and 0 for false to also allow
631 * #if IS_*() checks pre-compiler checks which do not like #if true.
633 #define ___XAB_1 dontcare,
634 #define ___IS_XAB(_ignore, _x, ...) (_x)
635 #define __IS_XAB(_x) ___IS_XAB(_x 1, 0)
636 #define _IS_XAB(_x) __IS_XAB(__CONCAT(___XAB_, _x))
638 /* This is if CONFIG_ccc=y. */
639 #define IS_BUILTIN(_x) _IS_XAB(_x)
640 /* This is if CONFIG_ccc=m. */
641 #define IS_MODULE(_x) _IS_XAB(_x ## _MODULE)
642 /* This is if CONFIG_ccc is compiled in(=y) or a module(=m). */
643 #define IS_ENABLED(_x) (IS_BUILTIN(_x) || IS_MODULE(_x))
645 * This is weird case. If the CONFIG_ccc is builtin (=y) this returns true;
646 * or if the CONFIG_ccc is a module (=m) and the caller is built as a module
647 * (-DMODULE defined) this returns true, but if the callers is not a module
648 * (-DMODULE not defined, which means caller is BUILTIN) then it returns
649 * false. In other words, a module can reach the kernel, a module can reach
650 * a module, but the kernel cannot reach a module, and code never compiled
651 * cannot be reached either.
652 * XXX -- I'd hope the module-to-module case would be handled by a proper
653 * module dependency definition (MODULE_DEPEND() in FreeBSD).
655 #define IS_REACHABLE(_x) (IS_BUILTIN(_x) || \
656 (IS_MODULE(_x) && IS_BUILTIN(MODULE)))
658 #endif /* _LINUX_KERNEL_H_ */