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