include/linux/kernel.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_KERNEL_H
   3 #define _LINUX_KERNEL_H
   4
   5
   6 #include <stdarg.h>
   7 #include <linux/limits.h>
   8 #include <linux/linkage.h>
   9 #include <linux/stddef.h>
  10 #include <linux/types.h>
  11 #include <linux/compiler.h>
  12 #include <linux/bitops.h>
  13 #include <linux/log2.h>
  14 #include <linux/minmax.h>
  15 #include <linux/typecheck.h>
  16 #include <linux/printk.h>
  17 #include <linux/build_bug.h>
  18 #include <asm/byteorder.h>
  19 #include <asm/div64.h>
  20 #include <uapi/linux/kernel.h>
  21
  22 #define STACK_MAGIC     0xdeadbeef
  23
  24 /**
  25  * REPEAT_BYTE - repeat the value @x multiple times as an unsigned long value
  26  * @x: value to repeat
  27  *
  28  * NOTE: @x is not checked for > 0xff; larger values produce odd results.
  29  */
  30 #define REPEAT_BYTE(x)  ((~0ul / 0xff) * (x))
  31
  32 /* @a is a power of 2 value */
  33 #define ALIGN(x, a)             __ALIGN_KERNEL((x), (a))
  34 #define ALIGN_DOWN(x, a)        __ALIGN_KERNEL((x) - ((a) - 1), (a))
  35 #define __ALIGN_MASK(x, mask)   __ALIGN_KERNEL_MASK((x), (mask))
  36 #define PTR_ALIGN(p, a)         ((typeof(p))ALIGN((unsigned long)(p), (a)))
  37 #define PTR_ALIGN_DOWN(p, a)    ((typeof(p))ALIGN_DOWN((unsigned long)(p), (a)))
  38 #define IS_ALIGNED(x, a)                (((x) & ((typeof(x))(a) - 1)) == 0)
  39
  40 /* generic data direction definitions */
  41 #define READ                    0
  42 #define WRITE                   1
  43
  44 /**
  45  * ARRAY_SIZE - get the number of elements in array @arr
  46  * @arr: array to be sized
  47  */
  48 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
  49
  50 #define u64_to_user_ptr(x) (            \
  51 {                                       \
  52         typecheck(u64, (x));            \
  53         (void __user *)(uintptr_t)(x);  \
  54 }                                       \
  55 )
  56
  57 /*
  58  * This looks more complex than it should be. But we need to
  59  * get the type for the ~ right in round_down (it needs to be
  60  * as wide as the result!), and we want to evaluate the macro
  61  * arguments just once each.
  62  */
  63 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
  64 /**
  65  * round_up - round up to next specified power of 2
  66  * @x: the value to round
  67  * @y: multiple to round up to (must be a power of 2)
  68  *
  69  * Rounds @x up to next multiple of @y (which must be a power of 2).
  70  * To perform arbitrary rounding up, use roundup() below.
  71  */
  72 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
  73 /**
  74  * round_down - round down to next specified power of 2
  75  * @x: the value to round
  76  * @y: multiple to round down to (must be a power of 2)
  77  *
  78  * Rounds @x down to next multiple of @y (which must be a power of 2).
  79  * To perform arbitrary rounding down, use rounddown() below.
  80  */
  81 #define round_down(x, y) ((x) & ~__round_mask(x, y))
  82
  83 #define typeof_member(T, m)     typeof(((T*)0)->m)
  84
  85 #define DIV_ROUND_UP __KERNEL_DIV_ROUND_UP
  86
  87 #define DIV_ROUND_DOWN_ULL(ll, d) \
  88         ({ unsigned long long _tmp = (ll); do_div(_tmp, d); _tmp; })
  89
  90 #define DIV_ROUND_UP_ULL(ll, d) \
  91         DIV_ROUND_DOWN_ULL((unsigned long long)(ll) + (d) - 1, (d))
  92
  93 #if BITS_PER_LONG == 32
  94 # define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP_ULL(ll, d)
  95 #else
  96 # define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP(ll,d)
  97 #endif
  98
  99 /**
 100  * roundup - round up to the next specified multiple
 101  * @x: the value to up
 102  * @y: multiple to round up to
 103  *
 104  * Rounds @x up to next multiple of @y. If @y will always be a power
 105  * of 2, consider using the faster round_up().
 106  */
 107 #define roundup(x, y) (                                 \
 108 {                                                       \
 109         typeof(y) __y = y;                              \
 110         (((x) + (__y - 1)) / __y) * __y;                \
 111 }                                                       \
 112 )
 113 /**
 114  * rounddown - round down to next specified multiple
 115  * @x: the value to round
 116  * @y: multiple to round down to
 117  *
 118  * Rounds @x down to next multiple of @y. If @y will always be a power
 119  * of 2, consider using the faster round_down().
 120  */
 121 #define rounddown(x, y) (                               \
 122 {                                                       \
 123         typeof(x) __x = (x);                            \
 124         __x - (__x % (y));                              \
 125 }                                                       \
 126 )
 127
 128 /*
 129  * Divide positive or negative dividend by positive or negative divisor
 130  * and round to closest integer. Result is undefined for negative
 131  * divisors if the dividend variable type is unsigned and for negative
 132  * dividends if the divisor variable type is unsigned.
 133  */
 134 #define DIV_ROUND_CLOSEST(x, divisor)(                  \
 135 {                                                       \
 136         typeof(x) __x = x;                              \
 137         typeof(divisor) __d = divisor;                  \
 138         (((typeof(x))-1) > 0 ||                         \
 139          ((typeof(divisor))-1) > 0 ||                   \
 140          (((__x) > 0) == ((__d) > 0))) ?                \
 141                 (((__x) + ((__d) / 2)) / (__d)) :       \
 142                 (((__x) - ((__d) / 2)) / (__d));        \
 143 }                                                       \
 144 )
 145 /*
 146  * Same as above but for u64 dividends. divisor must be a 32-bit
 147  * number.
 148  */
 149 #define DIV_ROUND_CLOSEST_ULL(x, divisor)(              \
 150 {                                                       \
 151         typeof(divisor) __d = divisor;                  \
 152         unsigned long long _tmp = (x) + (__d) / 2;      \
 153         do_div(_tmp, __d);                              \
 154         _tmp;                                           \
 155 }                                                       \
 156 )
 157
 158 /*
 159  * Multiplies an integer by a fraction, while avoiding unnecessary
 160  * overflow or loss of precision.
 161  */
 162 #define mult_frac(x, numer, denom)(                     \
 163 {                                                       \
 164         typeof(x) quot = (x) / (denom);                 \
 165         typeof(x) rem  = (x) % (denom);                 \
 166         (quot * (numer)) + ((rem * (numer)) / (denom)); \
 167 }                                                       \
 168 )
 169
 170
 171 #define _RET_IP_                (unsigned long)__builtin_return_address(0)
 172 #define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })
 173
 174 #define sector_div(a, b) do_div(a, b)
 175
 176 /**
 177  * upper_32_bits - return bits 32-63 of a number
 178  * @n: the number we're accessing
 179  *
 180  * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
 181  * the "right shift count >= width of type" warning when that quantity is
 182  * 32-bits.
 183  */
 184 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
 185
 186 /**
 187  * lower_32_bits - return bits 0-31 of a number
 188  * @n: the number we're accessing
 189  */
 190 #define lower_32_bits(n) ((u32)((n) & 0xffffffff))
 191
 192 struct completion;
 193 struct pt_regs;
 194 struct user;
 195
 196 #ifdef CONFIG_PREEMPT_VOLUNTARY
 197 extern int _cond_resched(void);
 198 # define might_resched() _cond_resched()
 199 #else
 200 # define might_resched() do { } while (0)
 201 #endif
 202
 203 #ifdef CONFIG_DEBUG_ATOMIC_SLEEP
 204 extern void ___might_sleep(const char *file, int line, int preempt_offset);
 205 extern void __might_sleep(const char *file, int line, int preempt_offset);
 206 extern void __cant_sleep(const char *file, int line, int preempt_offset);
 207 extern void __cant_migrate(const char *file, int line);
 208
 209 /**
 210  * might_sleep - annotation for functions that can sleep
 211  *
 212  * this macro will print a stack trace if it is executed in an atomic
 213  * context (spinlock, irq-handler, ...). Additional sections where blocking is
 214  * not allowed can be annotated with non_block_start() and non_block_end()
 215  * pairs.
 216  *
 217  * This is a useful debugging help to be able to catch problems early and not
 218  * be bitten later when the calling function happens to sleep when it is not
 219  * supposed to.
 220  */
 221 # define might_sleep() \
 222         do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
 223 /**
 224  * cant_sleep - annotation for functions that cannot sleep
 225  *
 226  * this macro will print a stack trace if it is executed with preemption enabled
 227  */
 228 # define cant_sleep() \
 229         do { __cant_sleep(__FILE__, __LINE__, 0); } while (0)
 230 # define sched_annotate_sleep() (current->task_state_change = 0)
 231
 232 /**
 233  * cant_migrate - annotation for functions that cannot migrate
 234  *
 235  * Will print a stack trace if executed in code which is migratable
 236  */
 237 # define cant_migrate()                                                 \
 238         do {                                                            \
 239                 if (IS_ENABLED(CONFIG_SMP))                             \
 240                         __cant_migrate(__FILE__, __LINE__);             \
 241         } while (0)
 242
 243 /**
 244  * non_block_start - annotate the start of section where sleeping is prohibited
 245  *
 246  * This is on behalf of the oom reaper, specifically when it is calling the mmu
 247  * notifiers. The problem is that if the notifier were to block on, for example,
 248  * mutex_lock() and if the process which holds that mutex were to perform a
 249  * sleeping memory allocation, the oom reaper is now blocked on completion of
 250  * that memory allocation. Other blocking calls like wait_event() pose similar
 251  * issues.
 252  */
 253 # define non_block_start() (current->non_block_count++)
 254 /**
 255  * non_block_end - annotate the end of section where sleeping is prohibited
 256  *
 257  * Closes a section opened by non_block_start().
 258  */
 259 # define non_block_end() WARN_ON(current->non_block_count-- == 0)
 260 #else
 261   static inline void ___might_sleep(const char *file, int line,
 262                                    int preempt_offset) { }
 263   static inline void __might_sleep(const char *file, int line,
 264                                    int preempt_offset) { }
 265 # define might_sleep() do { might_resched(); } while (0)
 266 # define cant_sleep() do { } while (0)
 267 # define cant_migrate()         do { } while (0)
 268 # define sched_annotate_sleep() do { } while (0)
 269 # define non_block_start() do { } while (0)
 270 # define non_block_end() do { } while (0)
 271 #endif
 272
 273 #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
 274
 275 /**
 276  * abs - return absolute value of an argument
 277  * @x: the value.  If it is unsigned type, it is converted to signed type first.
 278  *     char is treated as if it was signed (regardless of whether it really is)
 279  *     but the macro's return type is preserved as char.
 280  *
 281  * Return: an absolute value of x.
 282  */
 283 #define abs(x)  __abs_choose_expr(x, long long,                         \
 284                 __abs_choose_expr(x, long,                              \
 285                 __abs_choose_expr(x, int,                               \
 286                 __abs_choose_expr(x, short,                             \
 287                 __abs_choose_expr(x, char,                              \
 288                 __builtin_choose_expr(                                  \
 289                         __builtin_types_compatible_p(typeof(x), char),  \
 290                         (char)({ signed char __x = (x); __x<0?-__x:__x; }), \
 291                         ((void)0)))))))
 292
 293 #define __abs_choose_expr(x, type, other) __builtin_choose_expr(        \
 294         __builtin_types_compatible_p(typeof(x),   signed type) ||       \
 295         __builtin_types_compatible_p(typeof(x), unsigned type),         \
 296         ({ signed type __x = (x); __x < 0 ? -__x : __x; }), other)
 297
 298 /**
 299  * reciprocal_scale - "scale" a value into range [0, ep_ro)
 300  * @val: value
 301  * @ep_ro: right open interval endpoint
 302  *
 303  * Perform a "reciprocal multiplication" in order to "scale" a value into
 304  * range [0, @ep_ro), where the upper interval endpoint is right-open.
 305  * This is useful, e.g. for accessing a index of an array containing
 306  * @ep_ro elements, for example. Think of it as sort of modulus, only that
 307  * the result isn't that of modulo. ;) Note that if initial input is a
 308  * small value, then result will return 0.
 309  *
 310  * Return: a result based on @val in interval [0, @ep_ro).
 311  */
 312 static inline u32 reciprocal_scale(u32 val, u32 ep_ro)
 313 {
 314         return (u32)(((u64) val * ep_ro) >> 32);
 315 }
 316
 317 #if defined(CONFIG_MMU) && \
 318         (defined(CONFIG_PROVE_LOCKING) || defined(CONFIG_DEBUG_ATOMIC_SLEEP))
 319 #define might_fault() __might_fault(__FILE__, __LINE__)
 320 void __might_fault(const char *file, int line);
 321 #else
 322 static inline void might_fault(void) { }
 323 #endif
 324
 325 extern struct atomic_notifier_head panic_notifier_list;
 326 extern long (*panic_blink)(int state);
 327 __printf(1, 2)
 328 void panic(const char *fmt, ...) __noreturn __cold;
 329 void nmi_panic(struct pt_regs *regs, const char *msg);
 330 extern void oops_enter(void);
 331 extern void oops_exit(void);
 332 extern bool oops_may_print(void);
 333 void do_exit(long error_code) __noreturn;
 334 void complete_and_exit(struct completion *, long) __noreturn;
 335
 336 /* Internal, do not use. */
 337 int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
 338 int __must_check _kstrtol(const char *s, unsigned int base, long *res);
 339
 340 int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
 341 int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
 342
 343 /**
 344  * kstrtoul - convert a string to an unsigned long
 345  * @s: The start of the string. The string must be null-terminated, and may also
 346  *  include a single newline before its terminating null. The first character
 347  *  may also be a plus sign, but not a minus sign.
 348  * @base: The number base to use. The maximum supported base is 16. If base is
 349  *  given as 0, then the base of the string is automatically detected with the
 350  *  conventional semantics - If it begins with 0x the number will be parsed as a
 351  *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be
 352  *  parsed as an octal number. Otherwise it will be parsed as a decimal.
 353  * @res: Where to write the result of the conversion on success.
 354  *
 355  * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
 356  * Preferred over simple_strtoul(). Return code must be checked.
 357 */
 358 static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
 359 {
 360         /*
 361          * We want to shortcut function call, but
 362          * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
 363          */
 364         if (sizeof(unsigned long) == sizeof(unsigned long long) &&
 365             __alignof__(unsigned long) == __alignof__(unsigned long long))
 366                 return kstrtoull(s, base, (unsigned long long *)res);
 367         else
 368                 return _kstrtoul(s, base, res);
 369 }
 370
 371 /**
 372  * kstrtol - convert a string to a long
 373  * @s: The start of the string. The string must be null-terminated, and may also
 374  *  include a single newline before its terminating null. The first character
 375  *  may also be a plus sign or a minus sign.
 376  * @base: The number base to use. The maximum supported base is 16. If base is
 377  *  given as 0, then the base of the string is automatically detected with the
 378  *  conventional semantics - If it begins with 0x the number will be parsed as a
 379  *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be
 380  *  parsed as an octal number. Otherwise it will be parsed as a decimal.
 381  * @res: Where to write the result of the conversion on success.
 382  *
 383  * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
 384  * Preferred over simple_strtol(). Return code must be checked.
 385  */
 386 static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
 387 {
 388         /*
 389          * We want to shortcut function call, but
 390          * __builtin_types_compatible_p(long, long long) = 0.
 391          */
 392         if (sizeof(long) == sizeof(long long) &&
 393             __alignof__(long) == __alignof__(long long))
 394                 return kstrtoll(s, base, (long long *)res);
 395         else
 396                 return _kstrtol(s, base, res);
 397 }
 398
 399 int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
 400 int __must_check kstrtoint(const char *s, unsigned int base, int *res);
 401
 402 static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
 403 {
 404         return kstrtoull(s, base, res);
 405 }
 406
 407 static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
 408 {
 409         return kstrtoll(s, base, res);
 410 }
 411
 412 static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
 413 {
 414         return kstrtouint(s, base, res);
 415 }
 416
 417 static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
 418 {
 419         return kstrtoint(s, base, res);
 420 }
 421
 422 int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
 423 int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
 424 int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
 425 int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);
 426 int __must_check kstrtobool(const char *s, bool *res);
 427
 428 int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
 429 int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
 430 int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
 431 int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
 432 int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
 433 int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
 434 int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
 435 int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
 436 int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
 437 int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);
 438 int __must_check kstrtobool_from_user(const char __user *s, size_t count, bool *res);
 439
 440 static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
 441 {
 442         return kstrtoull_from_user(s, count, base, res);
 443 }
 444
 445 static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
 446 {
 447         return kstrtoll_from_user(s, count, base, res);
 448 }
 449
 450 static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
 451 {
 452         return kstrtouint_from_user(s, count, base, res);
 453 }
 454
 455 static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
 456 {
 457         return kstrtoint_from_user(s, count, base, res);
 458 }
 459
 460 /*
 461  * Use kstrto<foo> instead.
 462  *
 463  * NOTE: simple_strto<foo> does not check for the range overflow and,
 464  *       depending on the input, may give interesting results.
 465  *
 466  * Use these functions if and only if you cannot use kstrto<foo>, because
 467  * the conversion ends on the first non-digit character, which may be far
 468  * beyond the supported range. It might be useful to parse the strings like
 469  * 10x50 or 12:21 without altering original string or temporary buffer in use.
 470  * Keep in mind above caveat.
 471  */
 472
 473 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
 474 extern long simple_strtol(const char *,char **,unsigned int);
 475 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
 476 extern long long simple_strtoll(const char *,char **,unsigned int);
 477
 478 extern int num_to_str(char *buf, int size,
 479                       unsigned long long num, unsigned int width);
 480
 481 /* lib/printf utilities */
 482
 483 extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
 484 extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
 485 extern __printf(3, 4)
 486 int snprintf(char *buf, size_t size, const char *fmt, ...);
 487 extern __printf(3, 0)
 488 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
 489 extern __printf(3, 4)
 490 int scnprintf(char *buf, size_t size, const char *fmt, ...);
 491 extern __printf(3, 0)
 492 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
 493 extern __printf(2, 3) __malloc
 494 char *kasprintf(gfp_t gfp, const char *fmt, ...);
 495 extern __printf(2, 0) __malloc
 496 char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
 497 extern __printf(2, 0)
 498 const char *kvasprintf_const(gfp_t gfp, const char *fmt, va_list args);
 499
 500 extern __scanf(2, 3)
 501 int sscanf(const char *, const char *, ...);
 502 extern __scanf(2, 0)
 503 int vsscanf(const char *, const char *, va_list);
 504
 505 extern int get_option(char **str, int *pint);
 506 extern char *get_options(const char *str, int nints, int *ints);
 507 extern unsigned long long memparse(const char *ptr, char **retptr);
 508 extern bool parse_option_str(const char *str, const char *option);
 509 extern char *next_arg(char *args, char **param, char **val);
 510
 511 extern int core_kernel_text(unsigned long addr);
 512 extern int init_kernel_text(unsigned long addr);
 513 extern int core_kernel_data(unsigned long addr);
 514 extern int __kernel_text_address(unsigned long addr);
 515 extern int kernel_text_address(unsigned long addr);
 516 extern int func_ptr_is_kernel_text(void *ptr);
 517
 518 u64 int_pow(u64 base, unsigned int exp);
 519 unsigned long int_sqrt(unsigned long);
 520
 521 #if BITS_PER_LONG < 64
 522 u32 int_sqrt64(u64 x);
 523 #else
 524 static inline u32 int_sqrt64(u64 x)
 525 {
 526         return (u32)int_sqrt(x);
 527 }
 528 #endif
 529
 530 #ifdef CONFIG_SMP
 531 extern unsigned int sysctl_oops_all_cpu_backtrace;
 532 #else
 533 #define sysctl_oops_all_cpu_backtrace 0
 534 #endif /* CONFIG_SMP */
 535
 536 extern void bust_spinlocks(int yes);
 537 extern int panic_timeout;
 538 extern unsigned long panic_print;
 539 extern int panic_on_oops;
 540 extern int panic_on_unrecovered_nmi;
 541 extern int panic_on_io_nmi;
 542 extern int panic_on_warn;
 543 extern unsigned long panic_on_taint;
 544 extern bool panic_on_taint_nousertaint;
 545 extern int sysctl_panic_on_rcu_stall;
 546 extern int sysctl_max_rcu_stall_to_panic;
 547 extern int sysctl_panic_on_stackoverflow;
 548
 549 extern bool crash_kexec_post_notifiers;
 550
 551 /*
 552  * panic_cpu is used for synchronizing panic() and crash_kexec() execution. It
 553  * holds a CPU number which is executing panic() currently. A value of
 554  * PANIC_CPU_INVALID means no CPU has entered panic() or crash_kexec().
 555  */
 556 extern atomic_t panic_cpu;
 557 #define PANIC_CPU_INVALID       -1
 558
 559 /*
 560  * Only to be used by arch init code. If the user over-wrote the default
 561  * CONFIG_PANIC_TIMEOUT, honor it.
 562  */
 563 static inline void set_arch_panic_timeout(int timeout, int arch_default_timeout)
 564 {
 565         if (panic_timeout == arch_default_timeout)
 566                 panic_timeout = timeout;
 567 }
 568 extern const char *print_tainted(void);
 569 enum lockdep_ok {
 570         LOCKDEP_STILL_OK,
 571         LOCKDEP_NOW_UNRELIABLE
 572 };
 573 extern void add_taint(unsigned flag, enum lockdep_ok);
 574 extern int test_taint(unsigned flag);
 575 extern unsigned long get_taint(void);
 576 extern int root_mountflags;
 577
 578 extern bool early_boot_irqs_disabled;
 579
 580 /*
 581  * Values used for system_state. Ordering of the states must not be changed
 582  * as code checks for <, <=, >, >= STATE.
 583  */
 584 extern enum system_states {
 585         SYSTEM_BOOTING,
 586         SYSTEM_SCHEDULING,
 587         SYSTEM_RUNNING,
 588         SYSTEM_HALT,
 589         SYSTEM_POWER_OFF,
 590         SYSTEM_RESTART,
 591         SYSTEM_SUSPEND,
 592 } system_state;
 593
 594 /* This cannot be an enum because some may be used in assembly source. */
 595 #define TAINT_PROPRIETARY_MODULE        0
 596 #define TAINT_FORCED_MODULE             1
 597 #define TAINT_CPU_OUT_OF_SPEC           2
 598 #define TAINT_FORCED_RMMOD              3
 599 #define TAINT_MACHINE_CHECK             4
 600 #define TAINT_BAD_PAGE                  5
 601 #define TAINT_USER                      6
 602 #define TAINT_DIE                       7
 603 #define TAINT_OVERRIDDEN_ACPI_TABLE     8
 604 #define TAINT_WARN                      9
 605 #define TAINT_CRAP                      10
 606 #define TAINT_FIRMWARE_WORKAROUND       11
 607 #define TAINT_OOT_MODULE                12
 608 #define TAINT_UNSIGNED_MODULE           13
 609 #define TAINT_SOFTLOCKUP                14
 610 #define TAINT_LIVEPATCH                 15
 611 #define TAINT_AUX                       16
 612 #define TAINT_RANDSTRUCT                17
 613 #define TAINT_FLAGS_COUNT               18
 614 #define TAINT_FLAGS_MAX                 ((1UL << TAINT_FLAGS_COUNT) - 1)
 615
 616 struct taint_flag {
 617         char c_true;    /* character printed when tainted */
 618         char c_false;   /* character printed when not tainted */
 619         bool module;    /* also show as a per-module taint flag */
 620 };
 621
 622 extern const struct taint_flag taint_flags[TAINT_FLAGS_COUNT];
 623
 624 extern const char hex_asc[];
 625 #define hex_asc_lo(x)   hex_asc[((x) & 0x0f)]
 626 #define hex_asc_hi(x)   hex_asc[((x) & 0xf0) >> 4]
 627
 628 static inline char *hex_byte_pack(char *buf, u8 byte)
 629 {
 630         *buf++ = hex_asc_hi(byte);
 631         *buf++ = hex_asc_lo(byte);
 632         return buf;
 633 }
 634
 635 extern const char hex_asc_upper[];
 636 #define hex_asc_upper_lo(x)     hex_asc_upper[((x) & 0x0f)]
 637 #define hex_asc_upper_hi(x)     hex_asc_upper[((x) & 0xf0) >> 4]
 638
 639 static inline char *hex_byte_pack_upper(char *buf, u8 byte)
 640 {
 641         *buf++ = hex_asc_upper_hi(byte);
 642         *buf++ = hex_asc_upper_lo(byte);
 643         return buf;
 644 }
 645
 646 extern int hex_to_bin(char ch);
 647 extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
 648 extern char *bin2hex(char *dst, const void *src, size_t count);
 649
 650 bool mac_pton(const char *s, u8 *mac);
 651
 652 /*
 653  * General tracing related utility functions - trace_printk(),
 654  * tracing_on/tracing_off and tracing_start()/tracing_stop
 655  *
 656  * Use tracing_on/tracing_off when you want to quickly turn on or off
 657  * tracing. It simply enables or disables the recording of the trace events.
 658  * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
 659  * file, which gives a means for the kernel and userspace to interact.
 660  * Place a tracing_off() in the kernel where you want tracing to end.
 661  * From user space, examine the trace, and then echo 1 > tracing_on
 662  * to continue tracing.
 663  *
 664  * tracing_stop/tracing_start has slightly more overhead. It is used
 665  * by things like suspend to ram where disabling the recording of the
 666  * trace is not enough, but tracing must actually stop because things
 667  * like calling smp_processor_id() may crash the system.
 668  *
 669  * Most likely, you want to use tracing_on/tracing_off.
 670  */
 671
 672 enum ftrace_dump_mode {
 673         DUMP_NONE,
 674         DUMP_ALL,
 675         DUMP_ORIG,
 676 };
 677
 678 #ifdef CONFIG_TRACING
 679 void tracing_on(void);
 680 void tracing_off(void);
 681 int tracing_is_on(void);
 682 void tracing_snapshot(void);
 683 void tracing_snapshot_alloc(void);
 684
 685 extern void tracing_start(void);
 686 extern void tracing_stop(void);
 687
 688 static inline __printf(1, 2)
 689 void ____trace_printk_check_format(const char *fmt, ...)
 690 {
 691 }
 692 #define __trace_printk_check_format(fmt, args...)                       \
 693 do {                                                                    \
 694         if (0)                                                          \
 695                 ____trace_printk_check_format(fmt, ##args);             \
 696 } while (0)
 697
 698 /**
 699  * trace_printk - printf formatting in the ftrace buffer
 700  * @fmt: the printf format for printing
 701  *
 702  * Note: __trace_printk is an internal function for trace_printk() and
 703  *       the @ip is passed in via the trace_printk() macro.
 704  *
 705  * This function allows a kernel developer to debug fast path sections
 706  * that printk is not appropriate for. By scattering in various
 707  * printk like tracing in the code, a developer can quickly see
 708  * where problems are occurring.
 709  *
 710  * This is intended as a debugging tool for the developer only.
 711  * Please refrain from leaving trace_printks scattered around in
 712  * your code. (Extra memory is used for special buffers that are
 713  * allocated when trace_printk() is used.)
 714  *
 715  * A little optimization trick is done here. If there's only one
 716  * argument, there's no need to scan the string for printf formats.
 717  * The trace_puts() will suffice. But how can we take advantage of
 718  * using trace_puts() when trace_printk() has only one argument?
 719  * By stringifying the args and checking the size we can tell
 720  * whether or not there are args. __stringify((__VA_ARGS__)) will
 721  * turn into "()\0" with a size of 3 when there are no args, anything
 722  * else will be bigger. All we need to do is define a string to this,
 723  * and then take its size and compare to 3. If it's bigger, use
 724  * do_trace_printk() otherwise, optimize it to trace_puts(). Then just
 725  * let gcc optimize the rest.
 726  */
 727
 728 #define trace_printk(fmt, ...)                          \
 729 do {                                                    \
 730         char _______STR[] = __stringify((__VA_ARGS__)); \
 731         if (sizeof(_______STR) > 3)                     \
 732                 do_trace_printk(fmt, ##__VA_ARGS__);    \
 733         else                                            \
 734                 trace_puts(fmt);                        \
 735 } while (0)
 736
 737 #define do_trace_printk(fmt, args...)                                   \
 738 do {                                                                    \
 739         static const char *trace_printk_fmt __used                      \
 740                 __section("__trace_printk_fmt") =                       \
 741                 __builtin_constant_p(fmt) ? fmt : NULL;                 \
 742                                                                         \
 743         __trace_printk_check_format(fmt, ##args);                       \
 744                                                                         \
 745         if (__builtin_constant_p(fmt))                                  \
 746                 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args);   \
 747         else                                                            \
 748                 __trace_printk(_THIS_IP_, fmt, ##args);                 \
 749 } while (0)
 750
 751 extern __printf(2, 3)
 752 int __trace_bprintk(unsigned long ip, const char *fmt, ...);
 753
 754 extern __printf(2, 3)
 755 int __trace_printk(unsigned long ip, const char *fmt, ...);
 756
 757 /**
 758  * trace_puts - write a string into the ftrace buffer
 759  * @str: the string to record
 760  *
 761  * Note: __trace_bputs is an internal function for trace_puts and
 762  *       the @ip is passed in via the trace_puts macro.
 763  *
 764  * This is similar to trace_printk() but is made for those really fast
 765  * paths that a developer wants the least amount of "Heisenbug" effects,
 766  * where the processing of the print format is still too much.
 767  *
 768  * This function allows a kernel developer to debug fast path sections
 769  * that printk is not appropriate for. By scattering in various
 770  * printk like tracing in the code, a developer can quickly see
 771  * where problems are occurring.
 772  *
 773  * This is intended as a debugging tool for the developer only.
 774  * Please refrain from leaving trace_puts scattered around in
 775  * your code. (Extra memory is used for special buffers that are
 776  * allocated when trace_puts() is used.)
 777  *
 778  * Returns: 0 if nothing was written, positive # if string was.
 779  *  (1 when __trace_bputs is used, strlen(str) when __trace_puts is used)
 780  */
 781
 782 #define trace_puts(str) ({                                              \
 783         static const char *trace_printk_fmt __used                      \
 784                 __section("__trace_printk_fmt") =                       \
 785                 __builtin_constant_p(str) ? str : NULL;                 \
 786                                                                         \
 787         if (__builtin_constant_p(str))                                  \
 788                 __trace_bputs(_THIS_IP_, trace_printk_fmt);             \
 789         else                                                            \
 790                 __trace_puts(_THIS_IP_, str, strlen(str));              \
 791 })
 792 extern int __trace_bputs(unsigned long ip, const char *str);
 793 extern int __trace_puts(unsigned long ip, const char *str, int size);
 794
 795 extern void trace_dump_stack(int skip);
 796
 797 /*
 798  * The double __builtin_constant_p is because gcc will give us an error
 799  * if we try to allocate the static variable to fmt if it is not a
 800  * constant. Even with the outer if statement.
 801  */
 802 #define ftrace_vprintk(fmt, vargs)                                      \
 803 do {                                                                    \
 804         if (__builtin_constant_p(fmt)) {                                \
 805                 static const char *trace_printk_fmt __used              \
 806                   __section("__trace_printk_fmt") =                     \
 807                         __builtin_constant_p(fmt) ? fmt : NULL;         \
 808                                                                         \
 809                 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs);  \
 810         } else                                                          \
 811                 __ftrace_vprintk(_THIS_IP_, fmt, vargs);                \
 812 } while (0)
 813
 814 extern __printf(2, 0) int
 815 __ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
 816
 817 extern __printf(2, 0) int
 818 __ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
 819
 820 extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
 821 #else
 822 static inline void tracing_start(void) { }
 823 static inline void tracing_stop(void) { }
 824 static inline void trace_dump_stack(int skip) { }
 825
 826 static inline void tracing_on(void) { }
 827 static inline void tracing_off(void) { }
 828 static inline int tracing_is_on(void) { return 0; }
 829 static inline void tracing_snapshot(void) { }
 830 static inline void tracing_snapshot_alloc(void) { }
 831
 832 static inline __printf(1, 2)
 833 int trace_printk(const char *fmt, ...)
 834 {
 835         return 0;
 836 }
 837 static __printf(1, 0) inline int
 838 ftrace_vprintk(const char *fmt, va_list ap)
 839 {
 840         return 0;
 841 }
 842 static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
 843 #endif /* CONFIG_TRACING */
 844
 845 /* This counts to 12. Any more, it will return 13th argument. */
 846 #define __COUNT_ARGS(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _n, X...) _n
 847 #define COUNT_ARGS(X...) __COUNT_ARGS(, ##X, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0)
 848
 849 #define __CONCAT(a, b) a ## b
 850 #define CONCATENATE(a, b) __CONCAT(a, b)
 851
 852 /**
 853  * container_of - cast a member of a structure out to the containing structure
 854  * @ptr:        the pointer to the member.
 855  * @type:       the type of the container struct this is embedded in.
 856  * @member:     the name of the member within the struct.
 857  *
 858  */
 859 #define container_of(ptr, type, member) ({                              \
 860         void *__mptr = (void *)(ptr);                                   \
 861         BUILD_BUG_ON_MSG(!__same_type(*(ptr), ((type *)0)->member) &&   \
 862                          !__same_type(*(ptr), void),                    \
 863                          "pointer type mismatch in container_of()");    \
 864         ((type *)(__mptr - offsetof(type, member))); })
 865
 866 /**
 867  * container_of_safe - cast a member of a structure out to the containing structure
 868  * @ptr:        the pointer to the member.
 869  * @type:       the type of the container struct this is embedded in.
 870  * @member:     the name of the member within the struct.
 871  *
 872  * If IS_ERR_OR_NULL(ptr), ptr is returned unchanged.
 873  */
 874 #define container_of_safe(ptr, type, member) ({                         \
 875         void *__mptr = (void *)(ptr);                                   \
 876         BUILD_BUG_ON_MSG(!__same_type(*(ptr), ((type *)0)->member) &&   \
 877                          !__same_type(*(ptr), void),                    \
 878                          "pointer type mismatch in container_of()");    \
 879         IS_ERR_OR_NULL(__mptr) ? ERR_CAST(__mptr) :                     \
 880                 ((type *)(__mptr - offsetof(type, member))); })
 881
 882 /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
 883 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
 884 # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
 885 #endif
 886
 887 /* Permissions on a sysfs file: you didn't miss the 0 prefix did you? */
 888 #define VERIFY_OCTAL_PERMISSIONS(perms)                                         \
 889         (BUILD_BUG_ON_ZERO((perms) < 0) +                                       \
 890          BUILD_BUG_ON_ZERO((perms) > 0777) +                                    \
 891          /* USER_READABLE >= GROUP_READABLE >= OTHER_READABLE */                \
 892          BUILD_BUG_ON_ZERO((((perms) >> 6) & 4) < (((perms) >> 3) & 4)) +       \
 893          BUILD_BUG_ON_ZERO((((perms) >> 3) & 4) < ((perms) & 4)) +              \
 894          /* USER_WRITABLE >= GROUP_WRITABLE */                                  \
 895          BUILD_BUG_ON_ZERO((((perms) >> 6) & 2) < (((perms) >> 3) & 2)) +       \
 896          /* OTHER_WRITABLE?  Generally considered a bad idea. */                \
 897          BUILD_BUG_ON_ZERO((perms) & 2) +                                       \
 898          (perms))
 899 #endif