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 <linux/dynamic_debug.h>
  15 #include <asm/byteorder.h>
  16 #include <uapi/linux/kernel.h>
  17
  18 #define USHRT_MAX       ((u16)(~0U))
  19 #define SHRT_MAX        ((s16)(USHRT_MAX>>1))
  20 #define SHRT_MIN        ((s16)(-SHRT_MAX - 1))
  21 #define INT_MAX         ((int)(~0U>>1))
  22 #define INT_MIN         (-INT_MAX - 1)
  23 #define UINT_MAX        (~0U)
  24 #define LONG_MAX        ((long)(~0UL>>1))
  25 #define LONG_MIN        (-LONG_MAX - 1)
  26 #define ULONG_MAX       (~0UL)
  27 #define LLONG_MAX       ((long long)(~0ULL>>1))
  28 #define LLONG_MIN       (-LLONG_MAX - 1)
  29 #define ULLONG_MAX      (~0ULL)
  30 #define SIZE_MAX        (~(size_t)0)
  31
  32 #define U8_MAX          ((u8)~0U)
  33 #define S8_MAX          ((s8)(U8_MAX>>1))
  34 #define S8_MIN          ((s8)(-S8_MAX - 1))
  35 #define U16_MAX         ((u16)~0U)
  36 #define S16_MAX         ((s16)(U16_MAX>>1))
  37 #define S16_MIN         ((s16)(-S16_MAX - 1))
  38 #define U32_MAX         ((u32)~0U)
  39 #define S32_MAX         ((s32)(U32_MAX>>1))
  40 #define S32_MIN         ((s32)(-S32_MAX - 1))
  41 #define U64_MAX         ((u64)~0ULL)
  42 #define S64_MAX         ((s64)(U64_MAX>>1))
  43 #define S64_MIN         ((s64)(-S64_MAX - 1))
  44
  45 #define STACK_MAGIC     0xdeadbeef
  46
  47 #define REPEAT_BYTE(x)  ((~0ul / 0xff) * (x))
  48
  49 #define ALIGN(x, a)             __ALIGN_KERNEL((x), (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(n,d) (((n) + (d) - 1) / (d))
  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, ...)
 264         __noreturn __cold;
 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)
 270         __noreturn;
 271 void complete_and_exit(struct completion *, long)
 272         __noreturn;
 273
 274 /* Internal, do not use. */
 275 int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
 276 int __must_check _kstrtol(const char *s, unsigned int base, long *res);
 277
 278 int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
 279 int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
 280
 281 /**
 282  * kstrtoul - convert a string to an unsigned long
 283  * @s: The start of the string. The string must be null-terminated, and may also
 284  *  include a single newline before its terminating null. The first character
 285  *  may also be a plus sign, but not a minus sign.
 286  * @base: The number base to use. The maximum supported base is 16. If base is
 287  *  given as 0, then the base of the string is automatically detected with the
 288  *  conventional semantics - If it begins with 0x the number will be parsed as a
 289  *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be
 290  *  parsed as an octal number. Otherwise it will be parsed as a decimal.
 291  * @res: Where to write the result of the conversion on success.
 292  *
 293  * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
 294  * Used as a replacement for the obsolete simple_strtoull. Return code must
 295  * be checked.
 296 */
 297 static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
 298 {
 299         /*
 300          * We want to shortcut function call, but
 301          * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
 302          */
 303         if (sizeof(unsigned long) == sizeof(unsigned long long) &&
 304             __alignof__(unsigned long) == __alignof__(unsigned long long))
 305                 return kstrtoull(s, base, (unsigned long long *)res);
 306         else
 307                 return _kstrtoul(s, base, res);
 308 }
 309
 310 /**
 311  * kstrtol - convert a string to a long
 312  * @s: The start of the string. The string must be null-terminated, and may also
 313  *  include a single newline before its terminating null. The first character
 314  *  may also be a plus sign or a minus sign.
 315  * @base: The number base to use. The maximum supported base is 16. If base is
 316  *  given as 0, then the base of the string is automatically detected with the
 317  *  conventional semantics - If it begins with 0x the number will be parsed as a
 318  *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be
 319  *  parsed as an octal number. Otherwise it will be parsed as a decimal.
 320  * @res: Where to write the result of the conversion on success.
 321  *
 322  * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
 323  * Used as a replacement for the obsolete simple_strtoull. Return code must
 324  * be checked.
 325  */
 326 static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
 327 {
 328         /*
 329          * We want to shortcut function call, but
 330          * __builtin_types_compatible_p(long, long long) = 0.
 331          */
 332         if (sizeof(long) == sizeof(long long) &&
 333             __alignof__(long) == __alignof__(long long))
 334                 return kstrtoll(s, base, (long long *)res);
 335         else
 336                 return _kstrtol(s, base, res);
 337 }
 338
 339 int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
 340 int __must_check kstrtoint(const char *s, unsigned int base, int *res);
 341
 342 static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
 343 {
 344         return kstrtoull(s, base, res);
 345 }
 346
 347 static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
 348 {
 349         return kstrtoll(s, base, res);
 350 }
 351
 352 static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
 353 {
 354         return kstrtouint(s, base, res);
 355 }
 356
 357 static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
 358 {
 359         return kstrtoint(s, base, res);
 360 }
 361
 362 int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
 363 int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
 364 int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
 365 int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);
 366 int __must_check kstrtobool(const char *s, bool *res);
 367
 368 int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
 369 int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
 370 int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
 371 int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
 372 int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
 373 int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
 374 int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
 375 int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
 376 int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
 377 int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);
 378 int __must_check kstrtobool_from_user(const char __user *s, size_t count, bool *res);
 379
 380 static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
 381 {
 382         return kstrtoull_from_user(s, count, base, res);
 383 }
 384
 385 static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
 386 {
 387         return kstrtoll_from_user(s, count, base, res);
 388 }
 389
 390 static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
 391 {
 392         return kstrtouint_from_user(s, count, base, res);
 393 }
 394
 395 static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
 396 {
 397         return kstrtoint_from_user(s, count, base, res);
 398 }
 399
 400 /* Obsolete, do not use.  Use kstrto<foo> instead */
 401
 402 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
 403 extern long simple_strtol(const char *,char **,unsigned int);
 404 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
 405 extern long long simple_strtoll(const char *,char **,unsigned int);
 406
 407 extern int num_to_str(char *buf, int size, unsigned long long num);
 408
 409 /* lib/printf utilities */
 410
 411 extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
 412 extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
 413 extern __printf(3, 4)
 414 int snprintf(char *buf, size_t size, const char *fmt, ...);
 415 extern __printf(3, 0)
 416 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
 417 extern __printf(3, 4)
 418 int scnprintf(char *buf, size_t size, const char *fmt, ...);
 419 extern __printf(3, 0)
 420 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
 421 extern __printf(2, 3)
 422 char *kasprintf(gfp_t gfp, const char *fmt, ...);
 423 extern __printf(2, 0)
 424 char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
 425 extern __printf(2, 0)
 426 const char *kvasprintf_const(gfp_t gfp, const char *fmt, va_list args);
 427
 428 extern __scanf(2, 3)
 429 int sscanf(const char *, const char *, ...);
 430 extern __scanf(2, 0)
 431 int vsscanf(const char *, const char *, va_list);
 432
 433 extern int get_option(char **str, int *pint);
 434 extern char *get_options(const char *str, int nints, int *ints);
 435 extern unsigned long long memparse(const char *ptr, char **retptr);
 436 extern bool parse_option_str(const char *str, const char *option);
 437
 438 extern int core_kernel_text(unsigned long addr);
 439 extern int core_kernel_data(unsigned long addr);
 440 extern int __kernel_text_address(unsigned long addr);
 441 extern int kernel_text_address(unsigned long addr);
 442 extern int func_ptr_is_kernel_text(void *ptr);
 443
 444 unsigned long int_sqrt(unsigned long);
 445
 446 extern void bust_spinlocks(int yes);
 447 extern int oops_in_progress;            /* If set, an oops, panic(), BUG() or die() is in progress */
 448 extern int panic_timeout;
 449 extern int panic_on_oops;
 450 extern int panic_on_unrecovered_nmi;
 451 extern int panic_on_io_nmi;
 452 extern int panic_on_warn;
 453 extern int sysctl_panic_on_stackoverflow;
 454
 455 extern bool crash_kexec_post_notifiers;
 456
 457 /*
 458  * Only to be used by arch init code. If the user over-wrote the default
 459  * CONFIG_PANIC_TIMEOUT, honor it.
 460  */
 461 static inline void set_arch_panic_timeout(int timeout, int arch_default_timeout)
 462 {
 463         if (panic_timeout == arch_default_timeout)
 464                 panic_timeout = timeout;
 465 }
 466 extern const char *print_tainted(void);
 467 enum lockdep_ok {
 468         LOCKDEP_STILL_OK,
 469         LOCKDEP_NOW_UNRELIABLE
 470 };
 471 extern void add_taint(unsigned flag, enum lockdep_ok);
 472 extern int test_taint(unsigned flag);
 473 extern unsigned long get_taint(void);
 474 extern int root_mountflags;
 475
 476 extern bool early_boot_irqs_disabled;
 477
 478 /* Values used for system_state */
 479 extern enum system_states {
 480         SYSTEM_BOOTING,
 481         SYSTEM_RUNNING,
 482         SYSTEM_HALT,
 483         SYSTEM_POWER_OFF,
 484         SYSTEM_RESTART,
 485 } system_state;
 486
 487 #define TAINT_PROPRIETARY_MODULE        0
 488 #define TAINT_FORCED_MODULE             1
 489 #define TAINT_CPU_OUT_OF_SPEC           2
 490 #define TAINT_FORCED_RMMOD              3
 491 #define TAINT_MACHINE_CHECK             4
 492 #define TAINT_BAD_PAGE                  5
 493 #define TAINT_USER                      6
 494 #define TAINT_DIE                       7
 495 #define TAINT_OVERRIDDEN_ACPI_TABLE     8
 496 #define TAINT_WARN                      9
 497 #define TAINT_CRAP                      10
 498 #define TAINT_FIRMWARE_WORKAROUND       11
 499 #define TAINT_OOT_MODULE                12
 500 #define TAINT_UNSIGNED_MODULE           13
 501 #define TAINT_SOFTLOCKUP                14
 502 #define TAINT_LIVEPATCH                 15
 503
 504 extern const char hex_asc[];
 505 #define hex_asc_lo(x)   hex_asc[((x) & 0x0f)]
 506 #define hex_asc_hi(x)   hex_asc[((x) & 0xf0) >> 4]
 507
 508 static inline char *hex_byte_pack(char *buf, u8 byte)
 509 {
 510         *buf++ = hex_asc_hi(byte);
 511         *buf++ = hex_asc_lo(byte);
 512         return buf;
 513 }
 514
 515 extern const char hex_asc_upper[];
 516 #define hex_asc_upper_lo(x)     hex_asc_upper[((x) & 0x0f)]
 517 #define hex_asc_upper_hi(x)     hex_asc_upper[((x) & 0xf0) >> 4]
 518
 519 static inline char *hex_byte_pack_upper(char *buf, u8 byte)
 520 {
 521         *buf++ = hex_asc_upper_hi(byte);
 522         *buf++ = hex_asc_upper_lo(byte);
 523         return buf;
 524 }
 525
 526 extern int hex_to_bin(char ch);
 527 extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
 528 extern char *bin2hex(char *dst, const void *src, size_t count);
 529
 530 bool mac_pton(const char *s, u8 *mac);
 531
 532 /*
 533  * General tracing related utility functions - trace_printk(),
 534  * tracing_on/tracing_off and tracing_start()/tracing_stop
 535  *
 536  * Use tracing_on/tracing_off when you want to quickly turn on or off
 537  * tracing. It simply enables or disables the recording of the trace events.
 538  * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
 539  * file, which gives a means for the kernel and userspace to interact.
 540  * Place a tracing_off() in the kernel where you want tracing to end.
 541  * From user space, examine the trace, and then echo 1 > tracing_on
 542  * to continue tracing.
 543  *
 544  * tracing_stop/tracing_start has slightly more overhead. It is used
 545  * by things like suspend to ram where disabling the recording of the
 546  * trace is not enough, but tracing must actually stop because things
 547  * like calling smp_processor_id() may crash the system.
 548  *
 549  * Most likely, you want to use tracing_on/tracing_off.
 550  */
 551
 552 enum ftrace_dump_mode {
 553         DUMP_NONE,
 554         DUMP_ALL,
 555         DUMP_ORIG,
 556 };
 557
 558 #ifdef CONFIG_TRACING
 559 void tracing_on(void);
 560 void tracing_off(void);
 561 int tracing_is_on(void);
 562 void tracing_snapshot(void);
 563 void tracing_snapshot_alloc(void);
 564
 565 extern void tracing_start(void);
 566 extern void tracing_stop(void);
 567
 568 static inline __printf(1, 2)
 569 void ____trace_printk_check_format(const char *fmt, ...)
 570 {
 571 }
 572 #define __trace_printk_check_format(fmt, args...)                       \
 573 do {                                                                    \
 574         if (0)                                                          \
 575                 ____trace_printk_check_format(fmt, ##args);             \
 576 } while (0)
 577
 578 /**
 579  * trace_printk - printf formatting in the ftrace buffer
 580  * @fmt: the printf format for printing
 581  *
 582  * Note: __trace_printk is an internal function for trace_printk and
 583  *       the @ip is passed in via the trace_printk macro.
 584  *
 585  * This function allows a kernel developer to debug fast path sections
 586  * that printk is not appropriate for. By scattering in various
 587  * printk like tracing in the code, a developer can quickly see
 588  * where problems are occurring.
 589  *
 590  * This is intended as a debugging tool for the developer only.
 591  * Please refrain from leaving trace_printks scattered around in
 592  * your code. (Extra memory is used for special buffers that are
 593  * allocated when trace_printk() is used)
 594  *
 595  * A little optization trick is done here. If there's only one
 596  * argument, there's no need to scan the string for printf formats.
 597  * The trace_puts() will suffice. But how can we take advantage of
 598  * using trace_puts() when trace_printk() has only one argument?
 599  * By stringifying the args and checking the size we can tell
 600  * whether or not there are args. __stringify((__VA_ARGS__)) will
 601  * turn into "()\0" with a size of 3 when there are no args, anything
 602  * else will be bigger. All we need to do is define a string to this,
 603  * and then take its size and compare to 3. If it's bigger, use
 604  * do_trace_printk() otherwise, optimize it to trace_puts(). Then just
 605  * let gcc optimize the rest.
 606  */
 607
 608 #define trace_printk(fmt, ...)                          \
 609 do {                                                    \
 610         char _______STR[] = __stringify((__VA_ARGS__)); \
 611         if (sizeof(_______STR) > 3)                     \
 612                 do_trace_printk(fmt, ##__VA_ARGS__);    \
 613         else                                            \
 614                 trace_puts(fmt);                        \
 615 } while (0)
 616
 617 #define do_trace_printk(fmt, args...)                                   \
 618 do {                                                                    \
 619         static const char *trace_printk_fmt __used                      \
 620                 __attribute__((section("__trace_printk_fmt"))) =        \
 621                 __builtin_constant_p(fmt) ? fmt : NULL;                 \
 622                                                                         \
 623         __trace_printk_check_format(fmt, ##args);                       \
 624                                                                         \
 625         if (__builtin_constant_p(fmt))                                  \
 626                 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args);   \
 627         else                                                            \
 628                 __trace_printk(_THIS_IP_, fmt, ##args);                 \
 629 } while (0)
 630
 631 extern __printf(2, 3)
 632 int __trace_bprintk(unsigned long ip, const char *fmt, ...);
 633
 634 extern __printf(2, 3)
 635 int __trace_printk(unsigned long ip, const char *fmt, ...);
 636
 637 /**
 638  * trace_puts - write a string into the ftrace buffer
 639  * @str: the string to record
 640  *
 641  * Note: __trace_bputs is an internal function for trace_puts and
 642  *       the @ip is passed in via the trace_puts macro.
 643  *
 644  * This is similar to trace_printk() but is made for those really fast
 645  * paths that a developer wants the least amount of "Heisenbug" affects,
 646  * where the processing of the print format is still too much.
 647  *
 648  * This function allows a kernel developer to debug fast path sections
 649  * that printk is not appropriate for. By scattering in various
 650  * printk like tracing in the code, a developer can quickly see
 651  * where problems are occurring.
 652  *
 653  * This is intended as a debugging tool for the developer only.
 654  * Please refrain from leaving trace_puts scattered around in
 655  * your code. (Extra memory is used for special buffers that are
 656  * allocated when trace_puts() is used)
 657  *
 658  * Returns: 0 if nothing was written, positive # if string was.
 659  *  (1 when __trace_bputs is used, strlen(str) when __trace_puts is used)
 660  */
 661
 662 #define trace_puts(str) ({                                              \
 663         static const char *trace_printk_fmt __used                      \
 664                 __attribute__((section("__trace_printk_fmt"))) =        \
 665                 __builtin_constant_p(str) ? str : NULL;                 \
 666                                                                         \
 667         if (__builtin_constant_p(str))                                  \
 668                 __trace_bputs(_THIS_IP_, trace_printk_fmt);             \
 669         else                                                            \
 670                 __trace_puts(_THIS_IP_, str, strlen(str));              \
 671 })
 672 extern int __trace_bputs(unsigned long ip, const char *str);
 673 extern int __trace_puts(unsigned long ip, const char *str, int size);
 674
 675 extern void trace_dump_stack(int skip);
 676
 677 /*
 678  * The double __builtin_constant_p is because gcc will give us an error
 679  * if we try to allocate the static variable to fmt if it is not a
 680  * constant. Even with the outer if statement.
 681  */
 682 #define ftrace_vprintk(fmt, vargs)                                      \
 683 do {                                                                    \
 684         if (__builtin_constant_p(fmt)) {                                \
 685                 static const char *trace_printk_fmt __used              \
 686                   __attribute__((section("__trace_printk_fmt"))) =      \
 687                         __builtin_constant_p(fmt) ? fmt : NULL;         \
 688                                                                         \
 689                 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs);  \
 690         } else                                                          \
 691                 __ftrace_vprintk(_THIS_IP_, fmt, vargs);                \
 692 } while (0)
 693
 694 extern __printf(2, 0) int
 695 __ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
 696
 697 extern __printf(2, 0) int
 698 __ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
 699
 700 extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
 701 #else
 702 static inline void tracing_start(void) { }
 703 static inline void tracing_stop(void) { }
 704 static inline void trace_dump_stack(int skip) { }
 705
 706 static inline void tracing_on(void) { }
 707 static inline void tracing_off(void) { }
 708 static inline int tracing_is_on(void) { return 0; }
 709 static inline void tracing_snapshot(void) { }
 710 static inline void tracing_snapshot_alloc(void) { }
 711
 712 static inline __printf(1, 2)
 713 int trace_printk(const char *fmt, ...)
 714 {
 715         return 0;
 716 }
 717 static __printf(1, 0) inline int
 718 ftrace_vprintk(const char *fmt, va_list ap)
 719 {
 720         return 0;
 721 }
 722 static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
 723 #endif /* CONFIG_TRACING */
 724
 725 /*
 726  * min()/max()/clamp() macros that also do
 727  * strict type-checking.. See the
 728  * "unnecessary" pointer comparison.
 729  */
 730 #define min(x, y) ({                            \
 731         typeof(x) _min1 = (x);                  \
 732         typeof(y) _min2 = (y);                  \
 733         (void) (&_min1 == &_min2);              \
 734         _min1 < _min2 ? _min1 : _min2; })
 735
 736 #define max(x, y) ({                            \
 737         typeof(x) _max1 = (x);                  \
 738         typeof(y) _max2 = (y);                  \
 739         (void) (&_max1 == &_max2);              \
 740         _max1 > _max2 ? _max1 : _max2; })
 741
 742 #define min3(x, y, z) min((typeof(x))min(x, y), z)
 743 #define max3(x, y, z) max((typeof(x))max(x, y), z)
 744
 745 /**
 746  * min_not_zero - return the minimum that is _not_ zero, unless both are zero
 747  * @x: value1
 748  * @y: value2
 749  */
 750 #define min_not_zero(x, y) ({                   \
 751         typeof(x) __x = (x);                    \
 752         typeof(y) __y = (y);                    \
 753         __x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
 754
 755 /**
 756  * clamp - return a value clamped to a given range with strict typechecking
 757  * @val: current value
 758  * @lo: lowest allowable value
 759  * @hi: highest allowable value
 760  *
 761  * This macro does strict typechecking of lo/hi to make sure they are of the
 762  * same type as val.  See the unnecessary pointer comparisons.
 763  */
 764 #define clamp(val, lo, hi) min((typeof(val))max(val, lo), hi)
 765
 766 /*
 767  * ..and if you can't take the strict
 768  * types, you can specify one yourself.
 769  *
 770  * Or not use min/max/clamp at all, of course.
 771  */
 772 #define min_t(type, x, y) ({                    \
 773         type __min1 = (x);                      \
 774         type __min2 = (y);                      \
 775         __min1 < __min2 ? __min1: __min2; })
 776
 777 #define max_t(type, x, y) ({                    \
 778         type __max1 = (x);                      \
 779         type __max2 = (y);                      \
 780         __max1 > __max2 ? __max1: __max2; })
 781
 782 /**
 783  * clamp_t - return a value clamped to a given range using a given type
 784  * @type: the type of variable to use
 785  * @val: current value
 786  * @lo: minimum allowable value
 787  * @hi: maximum allowable value
 788  *
 789  * This macro does no typechecking and uses temporary variables of type
 790  * 'type' to make all the comparisons.
 791  */
 792 #define clamp_t(type, val, lo, hi) min_t(type, max_t(type, val, lo), hi)
 793
 794 /**
 795  * clamp_val - return a value clamped to a given range using val's type
 796  * @val: current value
 797  * @lo: minimum allowable value
 798  * @hi: maximum allowable value
 799  *
 800  * This macro does no typechecking and uses temporary variables of whatever
 801  * type the input argument 'val' is.  This is useful when val is an unsigned
 802  * type and min and max are literals that will otherwise be assigned a signed
 803  * integer type.
 804  */
 805 #define clamp_val(val, lo, hi) clamp_t(typeof(val), val, lo, hi)
 806
 807
 808 /*
 809  * swap - swap value of @a and @b
 810  */
 811 #define swap(a, b) \
 812         do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
 813
 814 /**
 815  * container_of - cast a member of a structure out to the containing structure
 816  * @ptr:        the pointer to the member.
 817  * @type:       the type of the container struct this is embedded in.
 818  * @member:     the name of the member within the struct.
 819  *
 820  */
 821 #define container_of(ptr, type, member) ({                      \
 822         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
 823         (type *)( (char *)__mptr - offsetof(type,member) );})
 824
 825 /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
 826 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
 827 # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
 828 #endif
 829
 830 /* Permissions on a sysfs file: you didn't miss the 0 prefix did you? */
 831 #define VERIFY_OCTAL_PERMISSIONS(perms)                                         \
 832         (BUILD_BUG_ON_ZERO((perms) < 0) +                                       \
 833          BUILD_BUG_ON_ZERO((perms) > 0777) +                                    \
 834          /* USER_READABLE >= GROUP_READABLE >= OTHER_READABLE */                \
 835          BUILD_BUG_ON_ZERO((((perms) >> 6) & 4) < (((perms) >> 3) & 4)) +       \
 836          BUILD_BUG_ON_ZERO((((perms) >> 3) & 4) < ((perms) & 4)) +              \
 837          /* USER_WRITABLE >= GROUP_WRITABLE */                                  \
 838          BUILD_BUG_ON_ZERO((((perms) >> 6) & 2) < (((perms) >> 3) & 2)) +       \
 839          /* OTHER_WRITABLE?  Generally considered a bad idea. */                \
 840          BUILD_BUG_ON_ZERO((perms) & 2) +                                       \
 841          (perms))
 842 #endif