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