kernel.h 21.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6
#ifndef _LINUX_KERNEL_H
#define _LINUX_KERNEL_H

/*
 * 'kernel.h' contains some often-used function prototypes etc
 */
7 8
#define __ALIGN_KERNEL(x, a)		__ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
#define __ALIGN_KERNEL_MASK(x, mask)	(((x) + (mask)) & ~(mask))
L
Linus Torvalds 已提交
9 10 11 12 13 14 15 16 17

#ifdef __KERNEL__

#include <stdarg.h>
#include <linux/linkage.h>
#include <linux/stddef.h>
#include <linux/types.h>
#include <linux/compiler.h>
#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>
L
Linus Torvalds 已提交
22 23 24
#include <asm/byteorder.h>
#include <asm/bug.h>

25 26 27
#define USHRT_MAX	((u16)(~0U))
#define SHRT_MAX	((s16)(USHRT_MAX>>1))
#define SHRT_MIN	((s16)(-SHRT_MAX - 1))
L
Linus Torvalds 已提交
28 29 30 31 32 33
#define INT_MAX		((int)(~0U>>1))
#define INT_MIN		(-INT_MAX - 1)
#define UINT_MAX	(~0U)
#define LONG_MAX	((long)(~0UL>>1))
#define LONG_MIN	(-LONG_MAX - 1)
#define ULONG_MAX	(~0UL)
34 35 36
#define LLONG_MAX	((long long)(~0ULL>>1))
#define LLONG_MIN	(-LLONG_MAX - 1)
#define ULLONG_MAX	(~0ULL)
L
Linus Torvalds 已提交
37 38 39

#define STACK_MAGIC	0xdeadbeef

40
#define ALIGN(x, a)		__ALIGN_KERNEL((x), (a))
A
Alexey Dobriyan 已提交
41
#define __ALIGN_MASK(x, mask)	__ALIGN_KERNEL_MASK((x), (mask))
M
Matthew Wilcox 已提交
42
#define PTR_ALIGN(p, a)		((typeof(p))ALIGN((unsigned long)(p), (a)))
H
Herbert Xu 已提交
43
#define IS_ALIGNED(x, a)		(((x) & ((typeof(x))(a) - 1)) == 0)
L
Linus Torvalds 已提交
44

R
Rusty Russell 已提交
45 46
#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))

Y
Yinghai Lu 已提交
47 48 49 50 51 52 53 54 55 56
/*
 * This looks more complex than it should be. But we need to
 * get the type for the ~ right in round_down (it needs to be
 * as wide as the result!), and we want to evaluate the macro
 * arguments just once each.
 */
#define __round_mask(x, y) ((__typeof__(x))((y)-1))
#define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
#define round_down(x, y) ((x) & ~__round_mask(x, y))

57
#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
S
Steven Whitehouse 已提交
58
#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
59 60

/* The `const' in roundup() prevents gcc-3.3 from calling __divdi3 */
61 62
#define roundup(x, y) (					\
{							\
63
	const typeof(y) __y = y;			\
64 65 66
	(((x) + (__y - 1)) / __y) * __y;		\
}							\
)
E
Eric Paris 已提交
67 68 69 70 71 72
#define rounddown(x, y) (				\
{							\
	typeof(x) __x = (x);				\
	__x - (__x % (y));				\
}							\
)
73 74 75 76 77 78
#define DIV_ROUND_CLOSEST(x, divisor)(			\
{							\
	typeof(divisor) __divisor = divisor;		\
	(((x) + ((__divisor) / 2)) / (__divisor));	\
}							\
)
L
Linus Torvalds 已提交
79

80 81 82
#define _RET_IP_		(unsigned long)__builtin_return_address(0)
#define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })

83
#ifdef CONFIG_LBDAF
84 85 86 87 88 89 90 91 92 93 94 95 96
# include <asm/div64.h>
# define sector_div(a, b) do_div(a, b)
#else
# define sector_div(n, b)( \
{ \
	int _res; \
	_res = (n) % (b); \
	(n) /= (b); \
	_res; \
} \
)
#endif

A
Andrew Morton 已提交
97 98 99 100 101 102 103 104 105 106
/**
 * upper_32_bits - return bits 32-63 of a number
 * @n: the number we're accessing
 *
 * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
 * the "right shift count >= width of type" warning when that quantity is
 * 32-bits.
 */
#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))

J
Joerg Roedel 已提交
107 108 109 110 111 112
/**
 * lower_32_bits - return bits 0-31 of a number
 * @n: the number we're accessing
 */
#define lower_32_bits(n) ((u32)(n))

L
Linus Torvalds 已提交
113
struct completion;
A
akpm@osdl.org 已提交
114 115
struct pt_regs;
struct user;
L
Linus Torvalds 已提交
116

117 118 119 120 121 122 123
#ifdef CONFIG_PREEMPT_VOLUNTARY
extern int _cond_resched(void);
# define might_resched() _cond_resched()
#else
# define might_resched() do { } while (0)
#endif

124
#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
125
  void __might_sleep(const char *file, int line, int preempt_offset);
L
Linus Torvalds 已提交
126 127 128 129 130 131 132
/**
 * might_sleep - annotation for functions that can sleep
 *
 * this macro will print a stack trace if it is executed in an atomic
 * context (spinlock, irq-handler, ...).
 *
 * This is a useful debugging help to be able to catch problems early and not
133
 * be bitten later when the calling function happens to sleep when it is not
L
Linus Torvalds 已提交
134 135
 * supposed to.
 */
136
# define might_sleep() \
137
	do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
L
Linus Torvalds 已提交
138
#else
139 140
  static inline void __might_sleep(const char *file, int line,
				   int preempt_offset) { }
141
# define might_sleep() do { might_resched(); } while (0)
L
Linus Torvalds 已提交
142 143
#endif

144
#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
145

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
/*
 * abs() handles unsigned and signed longs, ints, shorts and chars.  For all
 * input types abs() returns a signed long.
 * abs() should not be used for 64-bit types (s64, u64, long long) - use abs64()
 * for those.
 */
#define abs(x) ({						\
		long ret;					\
		if (sizeof(x) == sizeof(long)) {		\
			long __x = (x);				\
			ret = (__x < 0) ? -__x : __x;		\
		} else {					\
			int __x = (x);				\
			ret = (__x < 0) ? -__x : __x;		\
		}						\
		ret;						\
L
Linus Torvalds 已提交
162 163
	})

164 165 166 167 168
#define abs64(x) ({				\
		s64 __x = (x);			\
		(__x < 0) ? -__x : __x;		\
	})

169 170 171 172 173 174 175 176 177
#ifdef CONFIG_PROVE_LOCKING
void might_fault(void);
#else
static inline void might_fault(void)
{
	might_sleep();
}
#endif

178
extern struct atomic_notifier_head panic_notifier_list;
179
extern long (*panic_blink)(int state);
L
Linus Torvalds 已提交
180
NORET_TYPE void panic(const char * fmt, ...)
181
	__attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
182 183
extern void oops_enter(void);
extern void oops_exit(void);
184
void print_oops_end_marker(void);
185
extern int oops_may_print(void);
186
NORET_TYPE void do_exit(long error_code)
L
Linus Torvalds 已提交
187 188 189
	ATTRIB_NORET;
NORET_TYPE void complete_and_exit(struct completion *, long)
	ATTRIB_NORET;
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250

/* Internal, do not use. */
int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
int __must_check _kstrtol(const char *s, unsigned int base, long *res);

int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
{
	/*
	 * We want to shortcut function call, but
	 * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
	 */
	if (sizeof(unsigned long) == sizeof(unsigned long long) &&
	    __alignof__(unsigned long) == __alignof__(unsigned long long))
		return kstrtoull(s, base, (unsigned long long *)res);
	else
		return _kstrtoul(s, base, res);
}

static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
{
	/*
	 * We want to shortcut function call, but
	 * __builtin_types_compatible_p(long, long long) = 0.
	 */
	if (sizeof(long) == sizeof(long long) &&
	    __alignof__(long) == __alignof__(long long))
		return kstrtoll(s, base, (long long *)res);
	else
		return _kstrtol(s, base, res);
}

int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
int __must_check kstrtoint(const char *s, unsigned int base, int *res);

static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
{
	return kstrtoull(s, base, res);
}

static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
{
	return kstrtoll(s, base, res);
}

static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
{
	return kstrtouint(s, base, res);
}

static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
{
	return kstrtoint(s, base, res);
}

int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);

L
Linus Torvalds 已提交
251 252 253 254
extern unsigned long simple_strtoul(const char *,char **,unsigned int);
extern long simple_strtol(const char *,char **,unsigned int);
extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
extern long long simple_strtoll(const char *,char **,unsigned int);
255 256 257 258 259
#define strict_strtoul	kstrtoul
#define strict_strtol	kstrtol
#define strict_strtoull	kstrtoull
#define strict_strtoll	kstrtoll

L
Linus Torvalds 已提交
260 261 262 263 264 265 266 267 268 269 270 271
extern int sprintf(char * buf, const char * fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
extern int vsprintf(char *buf, const char *, va_list)
	__attribute__ ((format (printf, 2, 0)));
extern int snprintf(char * buf, size_t size, const char * fmt, ...)
	__attribute__ ((format (printf, 3, 4)));
extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
	__attribute__ ((format (printf, 3, 0)));
extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
	__attribute__ ((format (printf, 3, 4)));
extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
	__attribute__ ((format (printf, 3, 0)));
272 273
extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
J
Jeremy Fitzhardinge 已提交
274
extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
L
Linus Torvalds 已提交
275 276 277 278 279 280 281 282

extern int sscanf(const char *, const char *, ...)
	__attribute__ ((format (scanf, 2, 3)));
extern int vsscanf(const char *, const char *, va_list)
	__attribute__ ((format (scanf, 2, 0)));

extern int get_option(char **str, int *pint);
extern char *get_options(const char *str, int nints, int *ints);
283
extern unsigned long long memparse(const char *ptr, char **retptr);
L
Linus Torvalds 已提交
284

285
extern int core_kernel_text(unsigned long addr);
286
extern int core_kernel_data(unsigned long addr);
L
Linus Torvalds 已提交
287 288
extern int __kernel_text_address(unsigned long addr);
extern int kernel_text_address(unsigned long addr);
289 290
extern int func_ptr_is_kernel_text(void *ptr);

291 292
struct pid;
extern struct pid *session_of_pgrp(struct pid *pgrp);
L
Linus Torvalds 已提交
293 294 295 296

unsigned long int_sqrt(unsigned long);

extern void bust_spinlocks(int yes);
297
extern void wake_up_klogd(void);
L
Linus Torvalds 已提交
298
extern int oops_in_progress;		/* If set, an oops, panic(), BUG() or die() is in progress */
299
extern int panic_timeout;
L
Linus Torvalds 已提交
300
extern int panic_on_oops;
301
extern int panic_on_unrecovered_nmi;
302
extern int panic_on_io_nmi;
L
Linus Torvalds 已提交
303
extern const char *print_tainted(void);
A
Andi Kleen 已提交
304 305 306
extern void add_taint(unsigned flag);
extern int test_taint(unsigned flag);
extern unsigned long get_taint(void);
307
extern int root_mountflags;
L
Linus Torvalds 已提交
308

309 310
extern bool early_boot_irqs_disabled;

L
Linus Torvalds 已提交
311 312 313 314 315 316 317
/* Values used for system_state */
extern enum system_states {
	SYSTEM_BOOTING,
	SYSTEM_RUNNING,
	SYSTEM_HALT,
	SYSTEM_POWER_OFF,
	SYSTEM_RESTART,
318
	SYSTEM_SUSPEND_DISK,
L
Linus Torvalds 已提交
319 320
} system_state;

A
Andi Kleen 已提交
321 322 323 324 325 326 327 328 329 330
#define TAINT_PROPRIETARY_MODULE	0
#define TAINT_FORCED_MODULE		1
#define TAINT_UNSAFE_SMP		2
#define TAINT_FORCED_RMMOD		3
#define TAINT_MACHINE_CHECK		4
#define TAINT_BAD_PAGE			5
#define TAINT_USER			6
#define TAINT_DIE			7
#define TAINT_OVERRIDDEN_ACPI_TABLE	8
#define TAINT_WARN			9
331
#define TAINT_CRAP			10
332
#define TAINT_FIRMWARE_WORKAROUND	11
L
Linus Torvalds 已提交
333

334 335 336 337 338 339 340 341 342 343
extern const char hex_asc[];
#define hex_asc_lo(x)	hex_asc[((x) & 0x0f)]
#define hex_asc_hi(x)	hex_asc[((x) & 0xf0) >> 4]

static inline char *pack_hex_byte(char *buf, u8 byte)
{
	*buf++ = hex_asc_hi(byte);
	*buf++ = hex_asc_lo(byte);
	return buf;
}
R
Randy Dunlap 已提交
344

345
extern int hex_to_bin(char ch);
346
extern void hex2bin(u8 *dst, const char *src, size_t count);
347

348 349
/*
 * General tracing related utility functions - trace_printk(),
350 351 352 353
 * tracing_on/tracing_off and tracing_start()/tracing_stop
 *
 * Use tracing_on/tracing_off when you want to quickly turn on or off
 * tracing. It simply enables or disables the recording of the trace events.
354
 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
355 356 357 358 359 360 361 362 363 364 365
 * file, which gives a means for the kernel and userspace to interact.
 * Place a tracing_off() in the kernel where you want tracing to end.
 * From user space, examine the trace, and then echo 1 > tracing_on
 * to continue tracing.
 *
 * tracing_stop/tracing_start has slightly more overhead. It is used
 * by things like suspend to ram where disabling the recording of the
 * trace is not enough, but tracing must actually stop because things
 * like calling smp_processor_id() may crash the system.
 *
 * Most likely, you want to use tracing_on/tracing_off.
366
 */
367 368 369 370 371 372 373 374 375 376 377 378
#ifdef CONFIG_RING_BUFFER
void tracing_on(void);
void tracing_off(void);
/* trace_off_permanent stops recording with no way to bring it back */
void tracing_off_permanent(void);
int tracing_is_on(void);
#else
static inline void tracing_on(void) { }
static inline void tracing_off(void) { }
static inline void tracing_off_permanent(void) { }
static inline int tracing_is_on(void) { return 0; }
#endif
379 380 381 382 383 384 385

enum ftrace_dump_mode {
	DUMP_NONE,
	DUMP_ALL,
	DUMP_ORIG,
};

386 387 388 389 390
#ifdef CONFIG_TRACING
extern void tracing_start(void);
extern void tracing_stop(void);
extern void ftrace_off_permanent(void);

391 392 393 394 395 396 397 398 399 400
static inline void __attribute__ ((format (printf, 1, 2)))
____trace_printk_check_format(const char *fmt, ...)
{
}
#define __trace_printk_check_format(fmt, args...)			\
do {									\
	if (0)								\
		____trace_printk_check_format(fmt, ##args);		\
} while (0)

401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
/**
 * trace_printk - printf formatting in the ftrace buffer
 * @fmt: the printf format for printing
 *
 * Note: __trace_printk is an internal function for trace_printk and
 *       the @ip is passed in via the trace_printk macro.
 *
 * This function allows a kernel developer to debug fast path sections
 * that printk is not appropriate for. By scattering in various
 * printk like tracing in the code, a developer can quickly see
 * where problems are occurring.
 *
 * This is intended as a debugging tool for the developer only.
 * Please refrain from leaving trace_printks scattered around in
 * your code.
 */
417 418 419 420

#define trace_printk(fmt, args...)					\
do {									\
	__trace_printk_check_format(fmt, ##args);			\
421 422 423 424 425 426 427 428
	if (__builtin_constant_p(fmt)) {				\
		static const char *trace_printk_fmt			\
		  __attribute__((section("__trace_printk_fmt"))) =	\
			__builtin_constant_p(fmt) ? fmt : NULL;		\
									\
		__trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args);	\
	} else								\
		__trace_printk(_THIS_IP_, fmt, ##args);		\
429 430
} while (0)

431 432 433 434
extern int
__trace_bprintk(unsigned long ip, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));

435 436 437
extern int
__trace_printk(unsigned long ip, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
438

S
Steven Rostedt 已提交
439 440
extern void trace_dump_stack(void);

441 442 443 444 445
/*
 * The double __builtin_constant_p is because gcc will give us an error
 * if we try to allocate the static variable to fmt if it is not a
 * constant. Even with the outer if statement.
 */
446 447
#define ftrace_vprintk(fmt, vargs)					\
do {									\
448 449 450 451
	if (__builtin_constant_p(fmt)) {				\
		static const char *trace_printk_fmt			\
		  __attribute__((section("__trace_printk_fmt"))) =	\
			__builtin_constant_p(fmt) ? fmt : NULL;		\
I
Ingo Molnar 已提交
452
									\
453 454 455
		__ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs);	\
	} else								\
		__ftrace_vprintk(_THIS_IP_, fmt, vargs);		\
456 457
} while (0)

458 459 460
extern int
__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);

461 462
extern int
__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
463

464
extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
465 466 467 468 469 470 471
#else
static inline int
trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));

static inline void tracing_start(void) { }
static inline void tracing_stop(void) { }
static inline void ftrace_off_permanent(void) { }
472
static inline void trace_dump_stack(void) { }
473 474 475 476 477 478 479 480 481 482
static inline int
trace_printk(const char *fmt, ...)
{
	return 0;
}
static inline int
ftrace_vprintk(const char *fmt, va_list ap)
{
	return 0;
}
483
static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
484
#endif /* CONFIG_TRACING */
485

L
Linus Torvalds 已提交
486
/*
487
 * min()/max()/clamp() macros that also do
L
Linus Torvalds 已提交
488 489 490
 * strict type-checking.. See the
 * "unnecessary" pointer comparison.
 */
491 492 493 494 495 496 497 498 499 500 501 502
#define min(x, y) ({				\
	typeof(x) _min1 = (x);			\
	typeof(y) _min2 = (y);			\
	(void) (&_min1 == &_min2);		\
	_min1 < _min2 ? _min1 : _min2; })

#define max(x, y) ({				\
	typeof(x) _max1 = (x);			\
	typeof(y) _max2 = (y);			\
	(void) (&_max1 == &_max2);		\
	_max1 > _max2 ? _max1 : _max2; })

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
#define min3(x, y, z) ({			\
	typeof(x) _min1 = (x);			\
	typeof(y) _min2 = (y);			\
	typeof(z) _min3 = (z);			\
	(void) (&_min1 == &_min2);		\
	(void) (&_min1 == &_min3);		\
	_min1 < _min2 ? (_min1 < _min3 ? _min1 : _min3) : \
		(_min2 < _min3 ? _min2 : _min3); })

#define max3(x, y, z) ({			\
	typeof(x) _max1 = (x);			\
	typeof(y) _max2 = (y);			\
	typeof(z) _max3 = (z);			\
	(void) (&_max1 == &_max2);		\
	(void) (&_max1 == &_max3);		\
	_max1 > _max2 ? (_max1 > _max3 ? _max1 : _max3) : \
		(_max2 > _max3 ? _max2 : _max3); })

M
Martin K. Petersen 已提交
521 522 523 524 525 526 527 528 529 530
/**
 * min_not_zero - return the minimum that is _not_ zero, unless both are zero
 * @x: value1
 * @y: value2
 */
#define min_not_zero(x, y) ({			\
	typeof(x) __x = (x);			\
	typeof(y) __y = (y);			\
	__x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })

531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
/**
 * clamp - return a value clamped to a given range with strict typechecking
 * @val: current value
 * @min: minimum allowable value
 * @max: maximum allowable value
 *
 * This macro does strict typechecking of min/max to make sure they are of the
 * same type as val.  See the unnecessary pointer comparisons.
 */
#define clamp(val, min, max) ({			\
	typeof(val) __val = (val);		\
	typeof(min) __min = (min);		\
	typeof(max) __max = (max);		\
	(void) (&__val == &__min);		\
	(void) (&__val == &__max);		\
	__val = __val < __min ? __min: __val;	\
	__val > __max ? __max: __val; })
L
Linus Torvalds 已提交
548 549 550 551 552

/*
 * ..and if you can't take the strict
 * types, you can specify one yourself.
 *
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
 * Or not use min/max/clamp at all, of course.
 */
#define min_t(type, x, y) ({			\
	type __min1 = (x);			\
	type __min2 = (y);			\
	__min1 < __min2 ? __min1: __min2; })

#define max_t(type, x, y) ({			\
	type __max1 = (x);			\
	type __max2 = (y);			\
	__max1 > __max2 ? __max1: __max2; })

/**
 * clamp_t - return a value clamped to a given range using a given type
 * @type: the type of variable to use
 * @val: current value
 * @min: minimum allowable value
 * @max: maximum allowable value
 *
 * This macro does no typechecking and uses temporary variables of type
 * 'type' to make all the comparisons.
L
Linus Torvalds 已提交
574
 */
575 576 577 578 579 580
#define clamp_t(type, val, min, max) ({		\
	type __val = (val);			\
	type __min = (min);			\
	type __max = (max);			\
	__val = __val < __min ? __min: __val;	\
	__val > __max ? __max: __val; })
L
Linus Torvalds 已提交
581

582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
/**
 * clamp_val - return a value clamped to a given range using val's type
 * @val: current value
 * @min: minimum allowable value
 * @max: maximum allowable value
 *
 * This macro does no typechecking and uses temporary variables of whatever
 * type the input argument 'val' is.  This is useful when val is an unsigned
 * type and min and max are literals that will otherwise be assigned a signed
 * integer type.
 */
#define clamp_val(val, min, max) ({		\
	typeof(val) __val = (val);		\
	typeof(val) __min = (min);		\
	typeof(val) __max = (max);		\
	__val = __val < __min ? __min: __val;	\
	__val > __max ? __max: __val; })
L
Linus Torvalds 已提交
599

600 601 602 603

/*
 * swap - swap value of @a and @b
 */
604 605
#define swap(a, b) \
	do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
606

L
Linus Torvalds 已提交
607 608 609 610 611 612 613 614
/**
 * container_of - cast a member of a structure out to the containing structure
 * @ptr:	the pointer to the member.
 * @type:	the type of the container struct this is embedded in.
 * @member:	the name of the member within the struct.
 *
 */
#define container_of(ptr, type, member) ({			\
615 616
	const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
	(type *)( (char *)__mptr - offsetof(type,member) );})
L
Linus Torvalds 已提交
617

618 619 620
struct sysinfo;
extern int do_sysinfo(struct sysinfo *info);

L
Linus Torvalds 已提交
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
#endif /* __KERNEL__ */

#define SI_LOAD_SHIFT	16
struct sysinfo {
	long uptime;			/* Seconds since boot */
	unsigned long loads[3];		/* 1, 5, and 15 minute load averages */
	unsigned long totalram;		/* Total usable main memory size */
	unsigned long freeram;		/* Available memory size */
	unsigned long sharedram;	/* Amount of shared memory */
	unsigned long bufferram;	/* Memory used by buffers */
	unsigned long totalswap;	/* Total swap space size */
	unsigned long freeswap;		/* swap space still available */
	unsigned short procs;		/* Number of current processes */
	unsigned short pad;		/* explicit padding for m68k */
	unsigned long totalhigh;	/* Total high memory size */
	unsigned long freehigh;		/* Available high memory size */
	unsigned int mem_unit;		/* Memory unit size in bytes */
	char _f[20-2*sizeof(long)-sizeof(int)];	/* Padding: libc5 uses this.. */
};

641 642 643 644 645 646 647
#ifdef __CHECKER__
#define BUILD_BUG_ON_NOT_POWER_OF_2(n)
#define BUILD_BUG_ON_ZERO(e)
#define BUILD_BUG_ON_NULL(e)
#define BUILD_BUG_ON(condition)
#else /* __CHECKER__ */

648 649 650 651
/* Force a compilation error if a constant expression is not a power of 2 */
#define BUILD_BUG_ON_NOT_POWER_OF_2(n)			\
	BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))

652 653 654 655
/* Force a compilation error if condition is true, but also produce a
   result (of value 0 and type size_t), so the expression can be used
   e.g. in a structure initializer (or where-ever else comma expressions
   aren't permitted). */
656 657
#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
658

659 660
/**
 * BUILD_BUG_ON - break compile if a condition is true.
R
Randy Dunlap 已提交
661
 * @condition: the condition which the compiler should know is false.
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
 *
 * If you have some code which relies on certain constants being equal, or
 * other compile-time-evaluated condition, you should use BUILD_BUG_ON to
 * detect if someone changes it.
 *
 * The implementation uses gcc's reluctance to create a negative array, but
 * gcc (as of 4.4) only emits that error for obvious cases (eg. not arguments
 * to inline functions).  So as a fallback we use the optimizer; if it can't
 * prove the condition is false, it will cause a link error on the undefined
 * "__build_bug_on_failed".  This error message can be harder to track down
 * though, hence the two different methods.
 */
#ifndef __OPTIMIZE__
#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
#else
extern int __build_bug_on_failed;
#define BUILD_BUG_ON(condition)					\
	do {							\
		((void)sizeof(char[1 - 2*!!(condition)]));	\
		if (condition) __build_bug_on_failed = 1;	\
	} while(0)
#endif
684
#endif	/* __CHECKER__ */
685

L
Linus Torvalds 已提交
686 687 688
/* Trap pasters of __FUNCTION__ at compile-time */
#define __FUNCTION__ (__func__)

689 690 691 692 693 694 695
/* This helps us to avoid #ifdef CONFIG_NUMA */
#ifdef CONFIG_NUMA
#define NUMA_BUILD 1
#else
#define NUMA_BUILD 0
#endif

696 697 698 699 700 701 702
/* This helps us avoid #ifdef CONFIG_COMPACTION */
#ifdef CONFIG_COMPACTION
#define COMPACTION_BUILD 1
#else
#define COMPACTION_BUILD 0
#endif

703 704 705 706 707
/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
#endif

L
Linus Torvalds 已提交
708
#endif