include/linux/kernel.h

   1 #ifndef _LINUX_KERNEL_H
   2 #define _LINUX_KERNEL_H
   3
   4 /*
   5  * 'kernel.h' contains some often-used function prototypes etc
   6  */
   7 #define __ALIGN_KERNEL(x, a)            __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
   8 #define __ALIGN_KERNEL_MASK(x, mask)    (((x) + (mask)) & ~(mask))
   9
  10 #ifdef __KERNEL__
  11
  12 #include <stdarg.h>
  13 #include <linux/linkage.h>
  14 #include <linux/stddef.h>
  15 #include <linux/types.h>
  16 #include <linux/compiler.h>
  17 #include <linux/bitops.h>
  18 #include <linux/log2.h>
  19 #include <linux/typecheck.h>
  20 #include <linux/dynamic_debug.h>
  21 #include <asm/byteorder.h>
  22 #include <asm/bug.h>
  23
  24 extern const char linux_banner[];
  25 extern const char linux_proc_banner[];
  26
  27 #define USHRT_MAX       ((u16)(~0U))
  28 #define SHRT_MAX        ((s16)(USHRT_MAX>>1))
  29 #define SHRT_MIN        ((s16)(-SHRT_MAX - 1))
  30 #define INT_MAX         ((int)(~0U>>1))
  31 #define INT_MIN         (-INT_MAX - 1)
  32 #define UINT_MAX        (~0U)
  33 #define LONG_MAX        ((long)(~0UL>>1))
  34 #define LONG_MIN        (-LONG_MAX - 1)
  35 #define ULONG_MAX       (~0UL)
  36 #define LLONG_MAX       ((long long)(~0ULL>>1))
  37 #define LLONG_MIN       (-LLONG_MAX - 1)
  38 #define ULLONG_MAX      (~0ULL)
  39
  40 #define STACK_MAGIC     0xdeadbeef
  41
  42 #define ALIGN(x, a)             __ALIGN_KERNEL((x), (a))
  43 #define __ALIGN_MASK(x, mask)   __ALIGN_KERNEL_MASK((x), (mask))
  44 #define PTR_ALIGN(p, a)         ((typeof(p))ALIGN((unsigned long)(p), (a)))
  45 #define IS_ALIGNED(x, a)                (((x) & ((typeof(x))(a) - 1)) == 0)
  46
  47 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
  48
  49 /*
  50  * This looks more complex than it should be. But we need to
  51  * get the type for the ~ right in round_down (it needs to be
  52  * as wide as the result!), and we want to evaluate the macro
  53  * arguments just once each.
  54  */
  55 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
  56 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
  57 #define round_down(x, y) ((x) & ~__round_mask(x, y))
  58
  59 #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
  60 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  61 #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
  62 #define rounddown(x, y) (                               \
  63 {                                                       \
  64         typeof(x) __x = (x);                            \
  65         __x - (__x % (y));                              \
  66 }                                                       \
  67 )
  68 #define DIV_ROUND_CLOSEST(x, divisor)(                  \
  69 {                                                       \
  70         typeof(divisor) __divisor = divisor;            \
  71         (((x) + ((__divisor) / 2)) / (__divisor));      \
  72 }                                                       \
  73 )
  74
  75 #define _RET_IP_                (unsigned long)__builtin_return_address(0)
  76 #define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })
  77
  78 #ifdef CONFIG_LBDAF
  79 # include <asm/div64.h>
  80 # define sector_div(a, b) do_div(a, b)
  81 #else
  82 # define sector_div(n, b)( \
  83 { \
  84         int _res; \
  85         _res = (n) % (b); \
  86         (n) /= (b); \
  87         _res; \
  88 } \
  89 )
  90 #endif
  91
  92 /**
  93  * upper_32_bits - return bits 32-63 of a number
  94  * @n: the number we're accessing
  95  *
  96  * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
  97  * the "right shift count >= width of type" warning when that quantity is
  98  * 32-bits.
  99  */
 100 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
 101
 102 /**
 103  * lower_32_bits - return bits 0-31 of a number
 104  * @n: the number we're accessing
 105  */
 106 #define lower_32_bits(n) ((u32)(n))
 107
 108 #define KERN_EMERG      "<0>"   /* system is unusable                   */
 109 #define KERN_ALERT      "<1>"   /* action must be taken immediately     */
 110 #define KERN_CRIT       "<2>"   /* critical conditions                  */
 111 #define KERN_ERR        "<3>"   /* error conditions                     */
 112 #define KERN_WARNING    "<4>"   /* warning conditions                   */
 113 #define KERN_NOTICE     "<5>"   /* normal but significant condition     */
 114 #define KERN_INFO       "<6>"   /* informational                        */
 115 #define KERN_DEBUG      "<7>"   /* debug-level messages                 */
 116
 117 /* Use the default kernel loglevel */
 118 #define KERN_DEFAULT    "<d>"
 119 /*
 120  * Annotation for a "continued" line of log printout (only done after a
 121  * line that had no enclosing \n). Only to be used by core/arch code
 122  * during early bootup (a continued line is not SMP-safe otherwise).
 123  */
 124 #define KERN_CONT       "<c>"
 125
 126 extern int console_printk[];
 127
 128 #define console_loglevel (console_printk[0])
 129 #define default_message_loglevel (console_printk[1])
 130 #define minimum_console_loglevel (console_printk[2])
 131 #define default_console_loglevel (console_printk[3])
 132
 133 struct completion;
 134 struct pt_regs;
 135 struct user;
 136
 137 #ifdef CONFIG_PREEMPT_VOLUNTARY
 138 extern int _cond_resched(void);
 139 # define might_resched() _cond_resched()
 140 #else
 141 # define might_resched() do { } while (0)
 142 #endif
 143
 144 #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
 145   void __might_sleep(const char *file, int line, int preempt_offset);
 146 /**
 147  * might_sleep - annotation for functions that can sleep
 148  *
 149  * this macro will print a stack trace if it is executed in an atomic
 150  * context (spinlock, irq-handler, ...).
 151  *
 152  * This is a useful debugging help to be able to catch problems early and not
 153  * be bitten later when the calling function happens to sleep when it is not
 154  * supposed to.
 155  */
 156 # define might_sleep() \
 157         do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
 158 #else
 159   static inline void __might_sleep(const char *file, int line,
 160                                    int preempt_offset) { }
 161 # define might_sleep() do { might_resched(); } while (0)
 162 #endif
 163
 164 #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
 165
 166 #define abs(x) ({                               \
 167                 long __x = (x);                 \
 168                 (__x < 0) ? -__x : __x;         \
 169         })
 170
 171 #ifdef CONFIG_PROVE_LOCKING
 172 void might_fault(void);
 173 #else
 174 static inline void might_fault(void)
 175 {
 176         might_sleep();
 177 }
 178 #endif
 179
 180 struct va_format {
 181         const char *fmt;
 182         va_list *va;
 183 };
 184
 185 extern struct atomic_notifier_head panic_notifier_list;
 186 extern long (*panic_blink)(int state);
 187 NORET_TYPE void panic(const char * fmt, ...)
 188         __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
 189 extern void oops_enter(void);
 190 extern void oops_exit(void);
 191 void print_oops_end_marker(void);
 192 extern int oops_may_print(void);
 193 NORET_TYPE void do_exit(long error_code)
 194         ATTRIB_NORET;
 195 NORET_TYPE void complete_and_exit(struct completion *, long)
 196         ATTRIB_NORET;
 197 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
 198 extern long simple_strtol(const char *,char **,unsigned int);
 199 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
 200 extern long long simple_strtoll(const char *,char **,unsigned int);
 201 extern int strict_strtoul(const char *, unsigned int, unsigned long *);
 202 extern int strict_strtol(const char *, unsigned int, long *);
 203 extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
 204 extern int strict_strtoll(const char *, unsigned int, long long *);
 205 extern int sprintf(char * buf, const char * fmt, ...)
 206         __attribute__ ((format (printf, 2, 3)));
 207 extern int vsprintf(char *buf, const char *, va_list)
 208         __attribute__ ((format (printf, 2, 0)));
 209 extern int snprintf(char * buf, size_t size, const char * fmt, ...)
 210         __attribute__ ((format (printf, 3, 4)));
 211 extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
 212         __attribute__ ((format (printf, 3, 0)));
 213 extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
 214         __attribute__ ((format (printf, 3, 4)));
 215 extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
 216         __attribute__ ((format (printf, 3, 0)));
 217 extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
 218         __attribute__ ((format (printf, 2, 3)));
 219 extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
 220
 221 extern int sscanf(const char *, const char *, ...)
 222         __attribute__ ((format (scanf, 2, 3)));
 223 extern int vsscanf(const char *, const char *, va_list)
 224         __attribute__ ((format (scanf, 2, 0)));
 225
 226 extern int get_option(char **str, int *pint);
 227 extern char *get_options(const char *str, int nints, int *ints);
 228 extern unsigned long long memparse(const char *ptr, char **retptr);
 229
 230 extern int core_kernel_text(unsigned long addr);
 231 extern int __kernel_text_address(unsigned long addr);
 232 extern int kernel_text_address(unsigned long addr);
 233 extern int func_ptr_is_kernel_text(void *ptr);
 234
 235 struct pid;
 236 extern struct pid *session_of_pgrp(struct pid *pgrp);
 237
 238 /*
 239  * FW_BUG
 240  * Add this to a message where you are sure the firmware is buggy or behaves
 241  * really stupid or out of spec. Be aware that the responsible BIOS developer
 242  * should be able to fix this issue or at least get a concrete idea of the
 243  * problem by reading your message without the need of looking at the kernel
 244  * code.
 245  *
 246  * Use it for definite and high priority BIOS bugs.
 247  *
 248  * FW_WARN
 249  * Use it for not that clear (e.g. could the kernel messed up things already?)
 250  * and medium priority BIOS bugs.
 251  *
 252  * FW_INFO
 253  * Use this one if you want to tell the user or vendor about something
 254  * suspicious, but generally harmless related to the firmware.
 255  *
 256  * Use it for information or very low priority BIOS bugs.
 257  */
 258 #define FW_BUG          "[Firmware Bug]: "
 259 #define FW_WARN         "[Firmware Warn]: "
 260 #define FW_INFO         "[Firmware Info]: "
 261
 262 /*
 263  * HW_ERR
 264  * Add this to a message for hardware errors, so that user can report
 265  * it to hardware vendor instead of LKML or software vendor.
 266  */
 267 #define HW_ERR          "[Hardware Error]: "
 268
 269 #ifdef CONFIG_PRINTK
 270 asmlinkage int vprintk(const char *fmt, va_list args)
 271         __attribute__ ((format (printf, 1, 0)));
 272 asmlinkage int printk(const char * fmt, ...)
 273         __attribute__ ((format (printf, 1, 2))) __cold;
 274
 275 extern int __printk_ratelimit(const char *func);
 276 #define printk_ratelimit() __printk_ratelimit(__func__)
 277 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
 278                                    unsigned int interval_msec);
 279
 280 extern int printk_delay_msec;
 281
 282 /*
 283  * Print a one-time message (analogous to WARN_ONCE() et al):
 284  */
 285 #define printk_once(x...) ({                    \
 286         static bool __print_once;               \
 287                                                 \
 288         if (!__print_once) {                    \
 289                 __print_once = true;            \
 290                 printk(x);                      \
 291         }                                       \
 292 })
 293
 294 void log_buf_kexec_setup(void);
 295 #else
 296 static inline int vprintk(const char *s, va_list args)
 297         __attribute__ ((format (printf, 1, 0)));
 298 static inline int vprintk(const char *s, va_list args) { return 0; }
 299 static inline int printk(const char *s, ...)
 300         __attribute__ ((format (printf, 1, 2)));
 301 static inline int __cold printk(const char *s, ...) { return 0; }
 302 static inline int printk_ratelimit(void) { return 0; }
 303 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
 304                                           unsigned int interval_msec)   \
 305                 { return false; }
 306
 307 /* No effect, but we still get type checking even in the !PRINTK case: */
 308 #define printk_once(x...) printk(x)
 309
 310 static inline void log_buf_kexec_setup(void)
 311 {
 312 }
 313 #endif
 314
 315 /*
 316  * Dummy printk for disabled debugging statements to use whilst maintaining
 317  * gcc's format and side-effect checking.
 318  */
 319 static inline __attribute__ ((format (printf, 1, 2)))
 320 int no_printk(const char *s, ...) { return 0; }
 321
 322 extern int printk_needs_cpu(int cpu);
 323 extern void printk_tick(void);
 324
 325 extern void asmlinkage __attribute__((format(printf, 1, 2)))
 326         early_printk(const char *fmt, ...);
 327
 328 unsigned long int_sqrt(unsigned long);
 329
 330 static inline void console_silent(void)
 331 {
 332         console_loglevel = 0;
 333 }
 334
 335 static inline void console_verbose(void)
 336 {
 337         if (console_loglevel)
 338                 console_loglevel = 15;
 339 }
 340
 341 extern void bust_spinlocks(int yes);
 342 extern void wake_up_klogd(void);
 343 extern int oops_in_progress;            /* If set, an oops, panic(), BUG() or die() is in progress */
 344 extern int panic_timeout;
 345 extern int panic_on_oops;
 346 extern int panic_on_unrecovered_nmi;
 347 extern int panic_on_io_nmi;
 348 extern const char *print_tainted(void);
 349 extern void add_taint(unsigned flag);
 350 extern int test_taint(unsigned flag);
 351 extern unsigned long get_taint(void);
 352 extern int root_mountflags;
 353
 354 /* Values used for system_state */
 355 extern enum system_states {
 356         SYSTEM_BOOTING,
 357         SYSTEM_RUNNING,
 358         SYSTEM_HALT,
 359         SYSTEM_POWER_OFF,
 360         SYSTEM_RESTART,
 361         SYSTEM_SUSPEND_DISK,
 362 } system_state;
 363
 364 #define TAINT_PROPRIETARY_MODULE        0
 365 #define TAINT_FORCED_MODULE             1
 366 #define TAINT_UNSAFE_SMP                2
 367 #define TAINT_FORCED_RMMOD              3
 368 #define TAINT_MACHINE_CHECK             4
 369 #define TAINT_BAD_PAGE                  5
 370 #define TAINT_USER                      6
 371 #define TAINT_DIE                       7
 372 #define TAINT_OVERRIDDEN_ACPI_TABLE     8
 373 #define TAINT_WARN                      9
 374 #define TAINT_CRAP                      10
 375 #define TAINT_FIRMWARE_WORKAROUND       11
 376
 377 extern void dump_stack(void) __cold;
 378
 379 enum {
 380         DUMP_PREFIX_NONE,
 381         DUMP_PREFIX_ADDRESS,
 382         DUMP_PREFIX_OFFSET
 383 };
 384 extern void hex_dump_to_buffer(const void *buf, size_t len,
 385                                 int rowsize, int groupsize,
 386                                 char *linebuf, size_t linebuflen, bool ascii);
 387 extern void print_hex_dump(const char *level, const char *prefix_str,
 388                                 int prefix_type, int rowsize, int groupsize,
 389                                 const void *buf, size_t len, bool ascii);
 390 extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
 391                         const void *buf, size_t len);
 392
 393 extern const char hex_asc[];
 394 #define hex_asc_lo(x)   hex_asc[((x) & 0x0f)]
 395 #define hex_asc_hi(x)   hex_asc[((x) & 0xf0) >> 4]
 396
 397 static inline char *pack_hex_byte(char *buf, u8 byte)
 398 {
 399         *buf++ = hex_asc_hi(byte);
 400         *buf++ = hex_asc_lo(byte);
 401         return buf;
 402 }
 403
 404 extern int hex_to_bin(char ch);
 405
 406 #ifndef pr_fmt
 407 #define pr_fmt(fmt) fmt
 408 #endif
 409
 410 #define pr_emerg(fmt, ...) \
 411         printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 412 #define pr_alert(fmt, ...) \
 413         printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 414 #define pr_crit(fmt, ...) \
 415         printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 416 #define pr_err(fmt, ...) \
 417         printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 418 #define pr_warning(fmt, ...) \
 419         printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 420 #define pr_warn pr_warning
 421 #define pr_notice(fmt, ...) \
 422         printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 423 #define pr_info(fmt, ...) \
 424         printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 425 #define pr_cont(fmt, ...) \
 426         printk(KERN_CONT fmt, ##__VA_ARGS__)
 427
 428 /* pr_devel() should produce zero code unless DEBUG is defined */
 429 #ifdef DEBUG
 430 #define pr_devel(fmt, ...) \
 431         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 432 #else
 433 #define pr_devel(fmt, ...) \
 434         ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
 435 #endif
 436
 437 /* If you are writing a driver, please use dev_dbg instead */
 438 #if defined(DEBUG)
 439 #define pr_debug(fmt, ...) \
 440         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 441 #elif defined(CONFIG_DYNAMIC_DEBUG)
 442 /* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
 443 #define pr_debug(fmt, ...) \
 444         dynamic_pr_debug(fmt, ##__VA_ARGS__)
 445 #else
 446 #define pr_debug(fmt, ...) \
 447         ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
 448 #endif
 449
 450 /*
 451  * ratelimited messages with local ratelimit_state,
 452  * no local ratelimit_state used in the !PRINTK case
 453  */
 454 #ifdef CONFIG_PRINTK
 455 #define printk_ratelimited(fmt, ...)  ({                                \
 456         static DEFINE_RATELIMIT_STATE(_rs,                              \
 457                                       DEFAULT_RATELIMIT_INTERVAL,       \
 458                                       DEFAULT_RATELIMIT_BURST);         \
 459                                                                         \
 460         if (__ratelimit(&_rs))                                          \
 461                 printk(fmt, ##__VA_ARGS__);                             \
 462 })
 463 #else
 464 /* No effect, but we still get type checking even in the !PRINTK case: */
 465 #define printk_ratelimited printk
 466 #endif
 467
 468 #define pr_emerg_ratelimited(fmt, ...) \
 469         printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 470 #define pr_alert_ratelimited(fmt, ...) \
 471         printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 472 #define pr_crit_ratelimited(fmt, ...) \
 473         printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 474 #define pr_err_ratelimited(fmt, ...) \
 475         printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 476 #define pr_warning_ratelimited(fmt, ...) \
 477         printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 478 #define pr_warn_ratelimited pr_warning_ratelimited
 479 #define pr_notice_ratelimited(fmt, ...) \
 480         printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 481 #define pr_info_ratelimited(fmt, ...) \
 482         printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 483 /* no pr_cont_ratelimited, don't do that... */
 484 /* If you are writing a driver, please use dev_dbg instead */
 485 #if defined(DEBUG)
 486 #define pr_debug_ratelimited(fmt, ...) \
 487         printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 488 #else
 489 #define pr_debug_ratelimited(fmt, ...) \
 490         ({ if (0) printk_ratelimited(KERN_DEBUG pr_fmt(fmt), \
 491                                      ##__VA_ARGS__); 0; })
 492 #endif
 493
 494 /*
 495  * General tracing related utility functions - trace_printk(),
 496  * tracing_on/tracing_off and tracing_start()/tracing_stop
 497  *
 498  * Use tracing_on/tracing_off when you want to quickly turn on or off
 499  * tracing. It simply enables or disables the recording of the trace events.
 500  * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
 501  * file, which gives a means for the kernel and userspace to interact.
 502  * Place a tracing_off() in the kernel where you want tracing to end.
 503  * From user space, examine the trace, and then echo 1 > tracing_on
 504  * to continue tracing.
 505  *
 506  * tracing_stop/tracing_start has slightly more overhead. It is used
 507  * by things like suspend to ram where disabling the recording of the
 508  * trace is not enough, but tracing must actually stop because things
 509  * like calling smp_processor_id() may crash the system.
 510  *
 511  * Most likely, you want to use tracing_on/tracing_off.
 512  */
 513 #ifdef CONFIG_RING_BUFFER
 514 void tracing_on(void);
 515 void tracing_off(void);
 516 /* trace_off_permanent stops recording with no way to bring it back */
 517 void tracing_off_permanent(void);
 518 int tracing_is_on(void);
 519 #else
 520 static inline void tracing_on(void) { }
 521 static inline void tracing_off(void) { }
 522 static inline void tracing_off_permanent(void) { }
 523 static inline int tracing_is_on(void) { return 0; }
 524 #endif
 525
 526 enum ftrace_dump_mode {
 527         DUMP_NONE,
 528         DUMP_ALL,
 529         DUMP_ORIG,
 530 };
 531
 532 #ifdef CONFIG_TRACING
 533 extern void tracing_start(void);
 534 extern void tracing_stop(void);
 535 extern void ftrace_off_permanent(void);
 536
 537 static inline void __attribute__ ((format (printf, 1, 2)))
 538 ____trace_printk_check_format(const char *fmt, ...)
 539 {
 540 }
 541 #define __trace_printk_check_format(fmt, args...)                       \
 542 do {                                                                    \
 543         if (0)                                                          \
 544                 ____trace_printk_check_format(fmt, ##args);             \
 545 } while (0)
 546
 547 /**
 548  * trace_printk - printf formatting in the ftrace buffer
 549  * @fmt: the printf format for printing
 550  *
 551  * Note: __trace_printk is an internal function for trace_printk and
 552  *       the @ip is passed in via the trace_printk macro.
 553  *
 554  * This function allows a kernel developer to debug fast path sections
 555  * that printk is not appropriate for. By scattering in various
 556  * printk like tracing in the code, a developer can quickly see
 557  * where problems are occurring.
 558  *
 559  * This is intended as a debugging tool for the developer only.
 560  * Please refrain from leaving trace_printks scattered around in
 561  * your code.
 562  */
 563
 564 #define trace_printk(fmt, args...)                                      \
 565 do {                                                                    \
 566         __trace_printk_check_format(fmt, ##args);                       \
 567         if (__builtin_constant_p(fmt)) {                                \
 568                 static const char *trace_printk_fmt                     \
 569                   __attribute__((section("__trace_printk_fmt"))) =      \
 570                         __builtin_constant_p(fmt) ? fmt : NULL;         \
 571                                                                         \
 572                 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args);   \
 573         } else                                                          \
 574                 __trace_printk(_THIS_IP_, fmt, ##args);         \
 575 } while (0)
 576
 577 extern int
 578 __trace_bprintk(unsigned long ip, const char *fmt, ...)
 579         __attribute__ ((format (printf, 2, 3)));
 580
 581 extern int
 582 __trace_printk(unsigned long ip, const char *fmt, ...)
 583         __attribute__ ((format (printf, 2, 3)));
 584
 585 extern void trace_dump_stack(void);
 586
 587 /*
 588  * The double __builtin_constant_p is because gcc will give us an error
 589  * if we try to allocate the static variable to fmt if it is not a
 590  * constant. Even with the outer if statement.
 591  */
 592 #define ftrace_vprintk(fmt, vargs)                                      \
 593 do {                                                                    \
 594         if (__builtin_constant_p(fmt)) {                                \
 595                 static const char *trace_printk_fmt                     \
 596                   __attribute__((section("__trace_printk_fmt"))) =      \
 597                         __builtin_constant_p(fmt) ? fmt : NULL;         \
 598                                                                         \
 599                 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs);  \
 600         } else                                                          \
 601                 __ftrace_vprintk(_THIS_IP_, fmt, vargs);                \
 602 } while (0)
 603
 604 extern int
 605 __ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
 606
 607 extern int
 608 __ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
 609
 610 extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
 611 #else
 612 static inline int
 613 trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
 614
 615 static inline void tracing_start(void) { }
 616 static inline void tracing_stop(void) { }
 617 static inline void ftrace_off_permanent(void) { }
 618 static inline void trace_dump_stack(void) { }
 619 static inline int
 620 trace_printk(const char *fmt, ...)
 621 {
 622         return 0;
 623 }
 624 static inline int
 625 ftrace_vprintk(const char *fmt, va_list ap)
 626 {
 627         return 0;
 628 }
 629 static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
 630 #endif /* CONFIG_TRACING */
 631
 632 /*
 633  * min()/max()/clamp() macros that also do
 634  * strict type-checking.. See the
 635  * "unnecessary" pointer comparison.
 636  */
 637 #define min(x, y) ({                            \
 638         typeof(x) _min1 = (x);                  \
 639         typeof(y) _min2 = (y);                  \
 640         (void) (&_min1 == &_min2);              \
 641         _min1 < _min2 ? _min1 : _min2; })
 642
 643 #define max(x, y) ({                            \
 644         typeof(x) _max1 = (x);                  \
 645         typeof(y) _max2 = (y);                  \
 646         (void) (&_max1 == &_max2);              \
 647         _max1 > _max2 ? _max1 : _max2; })
 648
 649 /**
 650  * clamp - return a value clamped to a given range with strict typechecking
 651  * @val: current value
 652  * @min: minimum allowable value
 653  * @max: maximum allowable value
 654  *
 655  * This macro does strict typechecking of min/max to make sure they are of the
 656  * same type as val.  See the unnecessary pointer comparisons.
 657  */
 658 #define clamp(val, min, max) ({                 \
 659         typeof(val) __val = (val);              \
 660         typeof(min) __min = (min);              \
 661         typeof(max) __max = (max);              \
 662         (void) (&__val == &__min);              \
 663         (void) (&__val == &__max);              \
 664         __val = __val < __min ? __min: __val;   \
 665         __val > __max ? __max: __val; })
 666
 667 /*
 668  * ..and if you can't take the strict
 669  * types, you can specify one yourself.
 670  *
 671  * Or not use min/max/clamp at all, of course.
 672  */
 673 #define min_t(type, x, y) ({                    \
 674         type __min1 = (x);                      \
 675         type __min2 = (y);                      \
 676         __min1 < __min2 ? __min1: __min2; })
 677
 678 #define max_t(type, x, y) ({                    \
 679         type __max1 = (x);                      \
 680         type __max2 = (y);                      \
 681         __max1 > __max2 ? __max1: __max2; })
 682
 683 /**
 684  * clamp_t - return a value clamped to a given range using a given type
 685  * @type: the type of variable to use
 686  * @val: current value
 687  * @min: minimum allowable value
 688  * @max: maximum allowable value
 689  *
 690  * This macro does no typechecking and uses temporary variables of type
 691  * 'type' to make all the comparisons.
 692  */
 693 #define clamp_t(type, val, min, max) ({         \
 694         type __val = (val);                     \
 695         type __min = (min);                     \
 696         type __max = (max);                     \
 697         __val = __val < __min ? __min: __val;   \
 698         __val > __max ? __max: __val; })
 699
 700 /**
 701  * clamp_val - return a value clamped to a given range using val's type
 702  * @val: current value
 703  * @min: minimum allowable value
 704  * @max: maximum allowable value
 705  *
 706  * This macro does no typechecking and uses temporary variables of whatever
 707  * type the input argument 'val' is.  This is useful when val is an unsigned
 708  * type and min and max are literals that will otherwise be assigned a signed
 709  * integer type.
 710  */
 711 #define clamp_val(val, min, max) ({             \
 712         typeof(val) __val = (val);              \
 713         typeof(val) __min = (min);              \
 714         typeof(val) __max = (max);              \
 715         __val = __val < __min ? __min: __val;   \
 716         __val > __max ? __max: __val; })
 717
 718
 719 /*
 720  * swap - swap value of @a and @b
 721  */
 722 #define swap(a, b) \
 723         do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
 724
 725 /**
 726  * container_of - cast a member of a structure out to the containing structure
 727  * @ptr:        the pointer to the member.
 728  * @type:       the type of the container struct this is embedded in.
 729  * @member:     the name of the member within the struct.
 730  *
 731  */
 732 #define container_of(ptr, type, member) ({                      \
 733         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
 734         (type *)( (char *)__mptr - offsetof(type,member) );})
 735
 736 struct sysinfo;
 737 extern int do_sysinfo(struct sysinfo *info);
 738
 739 #endif /* __KERNEL__ */
 740
 741 #define SI_LOAD_SHIFT   16
 742 struct sysinfo {
 743         long uptime;                    /* Seconds since boot */
 744         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 745         unsigned long totalram;         /* Total usable main memory size */
 746         unsigned long freeram;          /* Available memory size */
 747         unsigned long sharedram;        /* Amount of shared memory */
 748         unsigned long bufferram;        /* Memory used by buffers */
 749         unsigned long totalswap;        /* Total swap space size */
 750         unsigned long freeswap;         /* swap space still available */
 751         unsigned short procs;           /* Number of current processes */
 752         unsigned short pad;             /* explicit padding for m68k */
 753         unsigned long totalhigh;        /* Total high memory size */
 754         unsigned long freehigh;         /* Available high memory size */
 755         unsigned int mem_unit;          /* Memory unit size in bytes */
 756         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
 757 };
 758
 759 /* Force a compilation error if condition is true */
 760 #define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))
 761
 762 /* Force a compilation error if condition is constant and true */
 763 #define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
 764
 765 /* Force a compilation error if a constant expression is not a power of 2 */
 766 #define BUILD_BUG_ON_NOT_POWER_OF_2(n)                  \
 767         BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
 768
 769 /* Force a compilation error if condition is true, but also produce a
 770    result (of value 0 and type size_t), so the expression can be used
 771    e.g. in a structure initializer (or where-ever else comma expressions
 772    aren't permitted). */
 773 #define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
 774 #define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
 775
 776 /* Trap pasters of __FUNCTION__ at compile-time */
 777 #define __FUNCTION__ (__func__)
 778
 779 /* This helps us to avoid #ifdef CONFIG_NUMA */
 780 #ifdef CONFIG_NUMA
 781 #define NUMA_BUILD 1
 782 #else
 783 #define NUMA_BUILD 0
 784 #endif
 785
 786 /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
 787 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
 788 # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
 789 #endif
 790
 791 #endif