sys/compat/linuxkpi/common/include/linux/kernel.h

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