include/linux/kernel.h

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