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/printk.h>
  21 #include <linux/dynamic_debug.h>
  22 #include <asm/byteorder.h>
  23 #include <asm/bug.h>
  24
  25 #define USHRT_MAX       ((u16)(~0U))
  26 #define SHRT_MAX        ((s16)(USHRT_MAX>>1))
  27 #define SHRT_MIN        ((s16)(-SHRT_MAX - 1))
  28 #define INT_MAX         ((int)(~0U>>1))
  29 #define INT_MIN         (-INT_MAX - 1)
  30 #define UINT_MAX        (~0U)
  31 #define LONG_MAX        ((long)(~0UL>>1))
  32 #define LONG_MIN        (-LONG_MAX - 1)
  33 #define ULONG_MAX       (~0UL)
  34 #define LLONG_MAX       ((long long)(~0ULL>>1))
  35 #define LLONG_MIN       (-LLONG_MAX - 1)
  36 #define ULLONG_MAX      (~0ULL)
  37 #define SIZE_MAX        (~(size_t)0)
  38
  39 #define STACK_MAGIC     0xdeadbeef
  40
  41 #define ALIGN(x, a)             __ALIGN_KERNEL((x), (a))
  42 #define __ALIGN_MASK(x, mask)   __ALIGN_KERNEL_MASK((x), (mask))
  43 #define PTR_ALIGN(p, a)         ((typeof(p))ALIGN((unsigned long)(p), (a)))
  44 #define IS_ALIGNED(x, a)                (((x) & ((typeof(x))(a) - 1)) == 0)
  45
  46 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
  47
  48 /*
  49  * This looks more complex than it should be. But we need to
  50  * get the type for the ~ right in round_down (it needs to be
  51  * as wide as the result!), and we want to evaluate the macro
  52  * arguments just once each.
  53  */
  54 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
  55 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
  56 #define round_down(x, y) ((x) & ~__round_mask(x, y))
  57
  58 #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
  59 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  60 #define DIV_ROUND_UP_ULL(ll,d) \
  61         ({ unsigned long long _tmp = (ll)+(d)-1; do_div(_tmp, d); _tmp; })
  62
  63 #if BITS_PER_LONG == 32
  64 # define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP_ULL(ll, d)
  65 #else
  66 # define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP(ll,d)
  67 #endif
  68
  69 /* The `const' in roundup() prevents gcc-3.3 from calling __divdi3 */
  70 #define roundup(x, y) (                                 \
  71 {                                                       \
  72         const typeof(y) __y = y;                        \
  73         (((x) + (__y - 1)) / __y) * __y;                \
  74 }                                                       \
  75 )
  76 #define rounddown(x, y) (                               \
  77 {                                                       \
  78         typeof(x) __x = (x);                            \
  79         __x - (__x % (y));                              \
  80 }                                                       \
  81 )
  82 #define DIV_ROUND_CLOSEST(x, divisor)(                  \
  83 {                                                       \
  84         typeof(divisor) __divisor = divisor;            \
  85         (((x) + ((__divisor) / 2)) / (__divisor));      \
  86 }                                                       \
  87 )
  88
  89 /*
  90  * Multiplies an integer by a fraction, while avoiding unnecessary
  91  * overflow or loss of precision.
  92  */
  93 #define mult_frac(x, numer, denom)(                     \
  94 {                                                       \
  95         typeof(x) quot = (x) / (denom);                 \
  96         typeof(x) rem  = (x) % (denom);                 \
  97         (quot * (numer)) + ((rem * (numer)) / (denom)); \
  98 }                                                       \
  99 )
 100
 101
 102 #define _RET_IP_                (unsigned long)__builtin_return_address(0)
 103 #define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })
 104
 105 #ifdef CONFIG_LBDAF
 106 # include <asm/div64.h>
 107 # define sector_div(a, b) do_div(a, b)
 108 #else
 109 # define sector_div(n, b)( \
 110 { \
 111         int _res; \
 112         _res = (n) % (b); \
 113         (n) /= (b); \
 114         _res; \
 115 } \
 116 )
 117 #endif
 118
 119 /**
 120  * upper_32_bits - return bits 32-63 of a number
 121  * @n: the number we're accessing
 122  *
 123  * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
 124  * the "right shift count >= width of type" warning when that quantity is
 125  * 32-bits.
 126  */
 127 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
 128
 129 /**
 130  * lower_32_bits - return bits 0-31 of a number
 131  * @n: the number we're accessing
 132  */
 133 #define lower_32_bits(n) ((u32)(n))
 134
 135 struct completion;
 136 struct pt_regs;
 137 struct user;
 138
 139 #ifdef CONFIG_PREEMPT_VOLUNTARY
 140 extern int _cond_resched(void);
 141 # define might_resched() _cond_resched()
 142 #else
 143 # define might_resched() do { } while (0)
 144 #endif
 145
 146 #ifdef CONFIG_DEBUG_ATOMIC_SLEEP
 147   void __might_sleep(const char *file, int line, int preempt_offset);
 148 /**
 149  * might_sleep - annotation for functions that can sleep
 150  *
 151  * this macro will print a stack trace if it is executed in an atomic
 152  * context (spinlock, irq-handler, ...).
 153  *
 154  * This is a useful debugging help to be able to catch problems early and not
 155  * be bitten later when the calling function happens to sleep when it is not
 156  * supposed to.
 157  */
 158 # define might_sleep() \
 159         do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
 160 #else
 161   static inline void __might_sleep(const char *file, int line,
 162                                    int preempt_offset) { }
 163 # define might_sleep() do { might_resched(); } while (0)
 164 #endif
 165
 166 #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
 167
 168 /*
 169  * abs() handles unsigned and signed longs, ints, shorts and chars.  For all
 170  * input types abs() returns a signed long.
 171  * abs() should not be used for 64-bit types (s64, u64, long long) - use abs64()
 172  * for those.
 173  */
 174 #define abs(x) ({                                               \
 175                 long ret;                                       \
 176                 if (sizeof(x) == sizeof(long)) {                \
 177                         long __x = (x);                         \
 178                         ret = (__x < 0) ? -__x : __x;           \
 179                 } else {                                        \
 180                         int __x = (x);                          \
 181                         ret = (__x < 0) ? -__x : __x;           \
 182                 }                                               \
 183                 ret;                                            \
 184         })
 185
 186 #define abs64(x) ({                             \
 187                 s64 __x = (x);                  \
 188                 (__x < 0) ? -__x : __x;         \
 189         })
 190
 191 #ifdef CONFIG_PROVE_LOCKING
 192 void might_fault(void);
 193 #else
 194 static inline void might_fault(void)
 195 {
 196         might_sleep();
 197 }
 198 #endif
 199
 200 extern struct atomic_notifier_head panic_notifier_list;
 201 extern long (*panic_blink)(int state);
 202 NORET_TYPE void panic(const char * fmt, ...)
 203         __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
 204 extern void oops_enter(void);
 205 extern void oops_exit(void);
 206 void print_oops_end_marker(void);
 207 extern int oops_may_print(void);
 208 NORET_TYPE void do_exit(long error_code)
 209         ATTRIB_NORET;
 210 NORET_TYPE void complete_and_exit(struct completion *, long)
 211         ATTRIB_NORET;
 212
 213 /* Internal, do not use. */
 214 int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
 215 int __must_check _kstrtol(const char *s, unsigned int base, long *res);
 216
 217 int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
 218 int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
 219 static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
 220 {
 221         /*
 222          * We want to shortcut function call, but
 223          * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
 224          */
 225         if (sizeof(unsigned long) == sizeof(unsigned long long) &&
 226             __alignof__(unsigned long) == __alignof__(unsigned long long))
 227                 return kstrtoull(s, base, (unsigned long long *)res);
 228         else
 229                 return _kstrtoul(s, base, res);
 230 }
 231
 232 static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
 233 {
 234         /*
 235          * We want to shortcut function call, but
 236          * __builtin_types_compatible_p(long, long long) = 0.
 237          */
 238         if (sizeof(long) == sizeof(long long) &&
 239             __alignof__(long) == __alignof__(long long))
 240                 return kstrtoll(s, base, (long long *)res);
 241         else
 242                 return _kstrtol(s, base, res);
 243 }
 244
 245 int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
 246 int __must_check kstrtoint(const char *s, unsigned int base, int *res);
 247
 248 static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
 249 {
 250         return kstrtoull(s, base, res);
 251 }
 252
 253 static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
 254 {
 255         return kstrtoll(s, base, res);
 256 }
 257
 258 static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
 259 {
 260         return kstrtouint(s, base, res);
 261 }
 262
 263 static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
 264 {
 265         return kstrtoint(s, base, res);
 266 }
 267
 268 int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
 269 int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
 270 int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
 271 int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);
 272
 273 int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
 274 int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
 275 int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
 276 int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
 277 int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
 278 int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
 279 int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
 280 int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
 281 int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
 282 int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);
 283
 284 static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
 285 {
 286         return kstrtoull_from_user(s, count, base, res);
 287 }
 288
 289 static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
 290 {
 291         return kstrtoll_from_user(s, count, base, res);
 292 }
 293
 294 static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
 295 {
 296         return kstrtouint_from_user(s, count, base, res);
 297 }
 298
 299 static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
 300 {
 301         return kstrtoint_from_user(s, count, base, res);
 302 }
 303
 304 /* Obsolete, do not use.  Use kstrto<foo> instead */
 305
 306 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
 307 extern long simple_strtol(const char *,char **,unsigned int);
 308 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
 309 extern long long simple_strtoll(const char *,char **,unsigned int);
 310 #define strict_strtoul  kstrtoul
 311 #define strict_strtol   kstrtol
 312 #define strict_strtoull kstrtoull
 313 #define strict_strtoll  kstrtoll
 314
 315 /* lib/printf utilities */
 316
 317 extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
 318 extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
 319 extern __printf(3, 4)
 320 int snprintf(char *buf, size_t size, const char *fmt, ...);
 321 extern __printf(3, 0)
 322 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
 323 extern __printf(3, 4)
 324 int scnprintf(char *buf, size_t size, const char *fmt, ...);
 325 extern __printf(3, 0)
 326 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
 327 extern __printf(2, 3)
 328 char *kasprintf(gfp_t gfp, const char *fmt, ...);
 329 extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
 330
 331 extern int sscanf(const char *, const char *, ...)
 332         __attribute__ ((format (scanf, 2, 3)));
 333 extern int vsscanf(const char *, const char *, va_list)
 334         __attribute__ ((format (scanf, 2, 0)));
 335
 336 extern int get_option(char **str, int *pint);
 337 extern char *get_options(const char *str, int nints, int *ints);
 338 extern unsigned long long memparse(const char *ptr, char **retptr);
 339
 340 extern int core_kernel_text(unsigned long addr);
 341 extern int core_kernel_data(unsigned long addr);
 342 extern int __kernel_text_address(unsigned long addr);
 343 extern int kernel_text_address(unsigned long addr);
 344 extern int func_ptr_is_kernel_text(void *ptr);
 345
 346 struct pid;
 347 extern struct pid *session_of_pgrp(struct pid *pgrp);
 348
 349 unsigned long int_sqrt(unsigned long);
 350
 351 extern void bust_spinlocks(int yes);
 352 extern void wake_up_klogd(void);
 353 extern int oops_in_progress;            /* If set, an oops, panic(), BUG() or die() is in progress */
 354 extern int panic_timeout;
 355 extern int panic_on_oops;
 356 extern int panic_on_unrecovered_nmi;
 357 extern int panic_on_io_nmi;
 358 extern const char *print_tainted(void);
 359 extern void add_taint(unsigned flag);
 360 extern int test_taint(unsigned flag);
 361 extern unsigned long get_taint(void);
 362 extern int root_mountflags;
 363
 364 extern bool early_boot_irqs_disabled;
 365
 366 /* Values used for system_state */
 367 extern enum system_states {
 368         SYSTEM_BOOTING,
 369         SYSTEM_RUNNING,
 370         SYSTEM_HALT,
 371         SYSTEM_POWER_OFF,
 372         SYSTEM_RESTART,
 373         SYSTEM_SUSPEND_DISK,
 374 } system_state;
 375
 376 #define TAINT_PROPRIETARY_MODULE        0
 377 #define TAINT_FORCED_MODULE             1
 378 #define TAINT_UNSAFE_SMP                2
 379 #define TAINT_FORCED_RMMOD              3
 380 #define TAINT_MACHINE_CHECK             4
 381 #define TAINT_BAD_PAGE                  5
 382 #define TAINT_USER                      6
 383 #define TAINT_DIE                       7
 384 #define TAINT_OVERRIDDEN_ACPI_TABLE     8
 385 #define TAINT_WARN                      9
 386 #define TAINT_CRAP                      10
 387 #define TAINT_FIRMWARE_WORKAROUND       11
 388 #define TAINT_OOT_MODULE                12
 389
 390 extern const char hex_asc[];
 391 #define hex_asc_lo(x)   hex_asc[((x) & 0x0f)]
 392 #define hex_asc_hi(x)   hex_asc[((x) & 0xf0) >> 4]
 393
 394 static inline char *hex_byte_pack(char *buf, u8 byte)
 395 {
 396         *buf++ = hex_asc_hi(byte);
 397         *buf++ = hex_asc_lo(byte);
 398         return buf;
 399 }
 400
 401 static inline char * __deprecated pack_hex_byte(char *buf, u8 byte)
 402 {
 403         return hex_byte_pack(buf, byte);
 404 }
 405
 406 extern int hex_to_bin(char ch);
 407 extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
 408
 409 /*
 410  * General tracing related utility functions - trace_printk(),
 411  * tracing_on/tracing_off and tracing_start()/tracing_stop
 412  *
 413  * Use tracing_on/tracing_off when you want to quickly turn on or off
 414  * tracing. It simply enables or disables the recording of the trace events.
 415  * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
 416  * file, which gives a means for the kernel and userspace to interact.
 417  * Place a tracing_off() in the kernel where you want tracing to end.
 418  * From user space, examine the trace, and then echo 1 > tracing_on
 419  * to continue tracing.
 420  *
 421  * tracing_stop/tracing_start has slightly more overhead. It is used
 422  * by things like suspend to ram where disabling the recording of the
 423  * trace is not enough, but tracing must actually stop because things
 424  * like calling smp_processor_id() may crash the system.
 425  *
 426  * Most likely, you want to use tracing_on/tracing_off.
 427  */
 428 #ifdef CONFIG_RING_BUFFER
 429 void tracing_on(void);
 430 void tracing_off(void);
 431 /* trace_off_permanent stops recording with no way to bring it back */
 432 void tracing_off_permanent(void);
 433 int tracing_is_on(void);
 434 #else
 435 static inline void tracing_on(void) { }
 436 static inline void tracing_off(void) { }
 437 static inline void tracing_off_permanent(void) { }
 438 static inline int tracing_is_on(void) { return 0; }
 439 #endif
 440
 441 enum ftrace_dump_mode {
 442         DUMP_NONE,
 443         DUMP_ALL,
 444         DUMP_ORIG,
 445 };
 446
 447 #ifdef CONFIG_TRACING
 448 extern void tracing_start(void);
 449 extern void tracing_stop(void);
 450 extern void ftrace_off_permanent(void);
 451
 452 static inline __printf(1, 2)
 453 void ____trace_printk_check_format(const char *fmt, ...)
 454 {
 455 }
 456 #define __trace_printk_check_format(fmt, args...)                       \
 457 do {                                                                    \
 458         if (0)                                                          \
 459                 ____trace_printk_check_format(fmt, ##args);             \
 460 } while (0)
 461
 462 /**
 463  * trace_printk - printf formatting in the ftrace buffer
 464  * @fmt: the printf format for printing
 465  *
 466  * Note: __trace_printk is an internal function for trace_printk and
 467  *       the @ip is passed in via the trace_printk macro.
 468  *
 469  * This function allows a kernel developer to debug fast path sections
 470  * that printk is not appropriate for. By scattering in various
 471  * printk like tracing in the code, a developer can quickly see
 472  * where problems are occurring.
 473  *
 474  * This is intended as a debugging tool for the developer only.
 475  * Please refrain from leaving trace_printks scattered around in
 476  * your code.
 477  */
 478
 479 #define trace_printk(fmt, args...)                                      \
 480 do {                                                                    \
 481         __trace_printk_check_format(fmt, ##args);                       \
 482         if (__builtin_constant_p(fmt)) {                                \
 483                 static const char *trace_printk_fmt                     \
 484                   __attribute__((section("__trace_printk_fmt"))) =      \
 485                         __builtin_constant_p(fmt) ? fmt : NULL;         \
 486                                                                         \
 487                 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args);   \
 488         } else                                                          \
 489                 __trace_printk(_THIS_IP_, fmt, ##args);         \
 490 } while (0)
 491
 492 extern __printf(2, 3)
 493 int __trace_bprintk(unsigned long ip, const char *fmt, ...);
 494
 495 extern __printf(2, 3)
 496 int __trace_printk(unsigned long ip, const char *fmt, ...);
 497
 498 extern void trace_dump_stack(void);
 499
 500 /*
 501  * The double __builtin_constant_p is because gcc will give us an error
 502  * if we try to allocate the static variable to fmt if it is not a
 503  * constant. Even with the outer if statement.
 504  */
 505 #define ftrace_vprintk(fmt, vargs)                                      \
 506 do {                                                                    \
 507         if (__builtin_constant_p(fmt)) {                                \
 508                 static const char *trace_printk_fmt                     \
 509                   __attribute__((section("__trace_printk_fmt"))) =      \
 510                         __builtin_constant_p(fmt) ? fmt : NULL;         \
 511                                                                         \
 512                 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs);  \
 513         } else                                                          \
 514                 __ftrace_vprintk(_THIS_IP_, fmt, vargs);                \
 515 } while (0)
 516
 517 extern int
 518 __ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
 519
 520 extern int
 521 __ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
 522
 523 extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
 524 #else
 525 static inline __printf(1, 2)
 526 int trace_printk(const char *fmt, ...);
 527
 528 static inline void tracing_start(void) { }
 529 static inline void tracing_stop(void) { }
 530 static inline void ftrace_off_permanent(void) { }
 531 static inline void trace_dump_stack(void) { }
 532 static inline int
 533 trace_printk(const char *fmt, ...)
 534 {
 535         return 0;
 536 }
 537 static inline int
 538 ftrace_vprintk(const char *fmt, va_list ap)
 539 {
 540         return 0;
 541 }
 542 static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
 543 #endif /* CONFIG_TRACING */
 544
 545 /*
 546  * min()/max()/clamp() macros that also do
 547  * strict type-checking.. See the
 548  * "unnecessary" pointer comparison.
 549  */
 550 #define min(x, y) ({                            \
 551         typeof(x) _min1 = (x);                  \
 552         typeof(y) _min2 = (y);                  \
 553         (void) (&_min1 == &_min2);              \
 554         _min1 < _min2 ? _min1 : _min2; })
 555
 556 #define max(x, y) ({                            \
 557         typeof(x) _max1 = (x);                  \
 558         typeof(y) _max2 = (y);                  \
 559         (void) (&_max1 == &_max2);              \
 560         _max1 > _max2 ? _max1 : _max2; })
 561
 562 #define min3(x, y, z) ({                        \
 563         typeof(x) _min1 = (x);                  \
 564         typeof(y) _min2 = (y);                  \
 565         typeof(z) _min3 = (z);                  \
 566         (void) (&_min1 == &_min2);              \
 567         (void) (&_min1 == &_min3);              \
 568         _min1 < _min2 ? (_min1 < _min3 ? _min1 : _min3) : \
 569                 (_min2 < _min3 ? _min2 : _min3); })
 570
 571 #define max3(x, y, z) ({                        \
 572         typeof(x) _max1 = (x);                  \
 573         typeof(y) _max2 = (y);                  \
 574         typeof(z) _max3 = (z);                  \
 575         (void) (&_max1 == &_max2);              \
 576         (void) (&_max1 == &_max3);              \
 577         _max1 > _max2 ? (_max1 > _max3 ? _max1 : _max3) : \
 578                 (_max2 > _max3 ? _max2 : _max3); })
 579
 580 /**
 581  * min_not_zero - return the minimum that is _not_ zero, unless both are zero
 582  * @x: value1
 583  * @y: value2
 584  */
 585 #define min_not_zero(x, y) ({                   \
 586         typeof(x) __x = (x);                    \
 587         typeof(y) __y = (y);                    \
 588         __x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
 589
 590 /**
 591  * clamp - return a value clamped to a given range with strict typechecking
 592  * @val: current value
 593  * @min: minimum allowable value
 594  * @max: maximum allowable value
 595  *
 596  * This macro does strict typechecking of min/max to make sure they are of the
 597  * same type as val.  See the unnecessary pointer comparisons.
 598  */
 599 #define clamp(val, min, max) ({                 \
 600         typeof(val) __val = (val);              \
 601         typeof(min) __min = (min);              \
 602         typeof(max) __max = (max);              \
 603         (void) (&__val == &__min);              \
 604         (void) (&__val == &__max);              \
 605         __val = __val < __min ? __min: __val;   \
 606         __val > __max ? __max: __val; })
 607
 608 /*
 609  * ..and if you can't take the strict
 610  * types, you can specify one yourself.
 611  *
 612  * Or not use min/max/clamp at all, of course.
 613  */
 614 #define min_t(type, x, y) ({                    \
 615         type __min1 = (x);                      \
 616         type __min2 = (y);                      \
 617         __min1 < __min2 ? __min1: __min2; })
 618
 619 #define max_t(type, x, y) ({                    \
 620         type __max1 = (x);                      \
 621         type __max2 = (y);                      \
 622         __max1 > __max2 ? __max1: __max2; })
 623
 624 /**
 625  * clamp_t - return a value clamped to a given range using a given type
 626  * @type: the type of variable to use
 627  * @val: current value
 628  * @min: minimum allowable value
 629  * @max: maximum allowable value
 630  *
 631  * This macro does no typechecking and uses temporary variables of type
 632  * 'type' to make all the comparisons.
 633  */
 634 #define clamp_t(type, val, min, max) ({         \
 635         type __val = (val);                     \
 636         type __min = (min);                     \
 637         type __max = (max);                     \
 638         __val = __val < __min ? __min: __val;   \
 639         __val > __max ? __max: __val; })
 640
 641 /**
 642  * clamp_val - return a value clamped to a given range using val's type
 643  * @val: current value
 644  * @min: minimum allowable value
 645  * @max: maximum allowable value
 646  *
 647  * This macro does no typechecking and uses temporary variables of whatever
 648  * type the input argument 'val' is.  This is useful when val is an unsigned
 649  * type and min and max are literals that will otherwise be assigned a signed
 650  * integer type.
 651  */
 652 #define clamp_val(val, min, max) ({             \
 653         typeof(val) __val = (val);              \
 654         typeof(val) __min = (min);              \
 655         typeof(val) __max = (max);              \
 656         __val = __val < __min ? __min: __val;   \
 657         __val > __max ? __max: __val; })
 658
 659
 660 /*
 661  * swap - swap value of @a and @b
 662  */
 663 #define swap(a, b) \
 664         do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
 665
 666 /**
 667  * container_of - cast a member of a structure out to the containing structure
 668  * @ptr:        the pointer to the member.
 669  * @type:       the type of the container struct this is embedded in.
 670  * @member:     the name of the member within the struct.
 671  *
 672  */
 673 #define container_of(ptr, type, member) ({                      \
 674         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
 675         (type *)( (char *)__mptr - offsetof(type,member) );})
 676
 677 #ifdef __CHECKER__
 678 #define BUILD_BUG_ON_NOT_POWER_OF_2(n)
 679 #define BUILD_BUG_ON_ZERO(e) (0)
 680 #define BUILD_BUG_ON_NULL(e) ((void*)0)
 681 #define BUILD_BUG_ON(condition)
 682 #define BUILD_BUG() (0)
 683 #else /* __CHECKER__ */
 684
 685 /* Force a compilation error if a constant expression is not a power of 2 */
 686 #define BUILD_BUG_ON_NOT_POWER_OF_2(n)                  \
 687         BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
 688
 689 /* Force a compilation error if condition is true, but also produce a
 690    result (of value 0 and type size_t), so the expression can be used
 691    e.g. in a structure initializer (or where-ever else comma expressions
 692    aren't permitted). */
 693 #define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
 694 #define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
 695
 696 /**
 697  * BUILD_BUG_ON - break compile if a condition is true.
 698  * @condition: the condition which the compiler should know is false.
 699  *
 700  * If you have some code which relies on certain constants being equal, or
 701  * other compile-time-evaluated condition, you should use BUILD_BUG_ON to
 702  * detect if someone changes it.
 703  *
 704  * The implementation uses gcc's reluctance to create a negative array, but
 705  * gcc (as of 4.4) only emits that error for obvious cases (eg. not arguments
 706  * to inline functions).  So as a fallback we use the optimizer; if it can't
 707  * prove the condition is false, it will cause a link error on the undefined
 708  * "__build_bug_on_failed".  This error message can be harder to track down
 709  * though, hence the two different methods.
 710  */
 711 #ifndef __OPTIMIZE__
 712 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
 713 #else
 714 extern int __build_bug_on_failed;
 715 #define BUILD_BUG_ON(condition)                                 \
 716         do {                                                    \
 717                 ((void)sizeof(char[1 - 2*!!(condition)]));      \
 718                 if (condition) __build_bug_on_failed = 1;       \
 719         } while(0)
 720 #endif
 721
 722 /**
 723  * BUILD_BUG - break compile if used.
 724  *
 725  * If you have some code that you expect the compiler to eliminate at
 726  * build time, you should use BUILD_BUG to detect if it is
 727  * unexpectedly used.
 728  */
 729 #define BUILD_BUG()                                             \
 730         do {                                                    \
 731                 extern void __build_bug_failed(void)            \
 732                         __linktime_error("BUILD_BUG failed");   \
 733                 __build_bug_failed();                           \
 734         } while (0)
 735
 736 #endif  /* __CHECKER__ */
 737
 738 /* Trap pasters of __FUNCTION__ at compile-time */
 739 #define __FUNCTION__ (__func__)
 740
 741 /* This helps us to avoid #ifdef CONFIG_NUMA */
 742 #ifdef CONFIG_NUMA
 743 #define NUMA_BUILD 1
 744 #else
 745 #define NUMA_BUILD 0
 746 #endif
 747
 748 /* This helps us avoid #ifdef CONFIG_COMPACTION */
 749 #ifdef CONFIG_COMPACTION
 750 #define COMPACTION_BUILD 1
 751 #else
 752 #define COMPACTION_BUILD 0
 753 #endif
 754
 755 /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
 756 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
 757 # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
 758 #endif
 759
 760 struct sysinfo;
 761 extern int do_sysinfo(struct sysinfo *info);
 762
 763 #endif /* __KERNEL__ */
 764
 765 #define SI_LOAD_SHIFT   16
 766 struct sysinfo {
 767         long uptime;                    /* Seconds since boot */
 768         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 769         unsigned long totalram;         /* Total usable main memory size */
 770         unsigned long freeram;          /* Available memory size */
 771         unsigned long sharedram;        /* Amount of shared memory */
 772         unsigned long bufferram;        /* Memory used by buffers */
 773         unsigned long totalswap;        /* Total swap space size */
 774         unsigned long freeswap;         /* swap space still available */
 775         unsigned short procs;           /* Number of current processes */
 776         unsigned short pad;             /* explicit padding for m68k */
 777         unsigned long totalhigh;        /* Total high memory size */
 778         unsigned long freehigh;         /* Available high memory size */
 779         unsigned int mem_unit;          /* Memory unit size in bytes */
 780         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
 781 };
 782
 783 #endif