kernel.h 23.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
#ifndef _LINUX_KERNEL_H
#define _LINUX_KERNEL_H

/*
 * 'kernel.h' contains some often-used function prototypes etc
 */

#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>
16
#include <linux/log2.h>
17
#include <linux/typecheck.h>
18
#include <linux/dynamic_debug.h>
L
Linus Torvalds 已提交
19 20 21
#include <asm/byteorder.h>
#include <asm/bug.h>

22 23 24
extern const char linux_banner[];
extern const char linux_proc_banner[];

25 26 27
#define USHORT_MAX	((u16)(~0U))
#define SHORT_MAX	((s16)(USHORT_MAX>>1))
#define SHORT_MIN	(-SHORT_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

L
Linus Torvalds 已提交
40 41
#define ALIGN(x,a)		__ALIGN_MASK(x,(typeof(x))(a)-1)
#define __ALIGN_MASK(x,mask)	(((x)+(mask))&~(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))

47
#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
S
Steven Whitehouse 已提交
48
#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
49
#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
50 51 52 53 54 55
#define DIV_ROUND_CLOSEST(x, divisor)(			\
{							\
	typeof(divisor) __divisor = divisor;		\
	(((x) + ((__divisor) / 2)) / (__divisor));	\
}							\
)
L
Linus Torvalds 已提交
56

57 58 59
#define _RET_IP_		(unsigned long)__builtin_return_address(0)
#define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })

60
#ifdef CONFIG_LBDAF
61 62 63 64 65 66 67 68 69 70 71 72 73
# 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 已提交
74 75 76 77 78 79 80 81 82 83
/**
 * 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 已提交
84 85 86 87 88 89
/**
 * 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 已提交
90 91 92 93 94 95 96 97 98
#define	KERN_EMERG	"<0>"	/* system is unusable			*/
#define	KERN_ALERT	"<1>"	/* action must be taken immediately	*/
#define	KERN_CRIT	"<2>"	/* critical conditions			*/
#define	KERN_ERR	"<3>"	/* error conditions			*/
#define	KERN_WARNING	"<4>"	/* warning conditions			*/
#define	KERN_NOTICE	"<5>"	/* normal but significant condition	*/
#define	KERN_INFO	"<6>"	/* informational			*/
#define	KERN_DEBUG	"<7>"	/* debug-level messages			*/

99 100
/* Use the default kernel loglevel */
#define KERN_DEFAULT	"<d>"
I
Ingo Molnar 已提交
101 102 103 104 105
/*
 * Annotation for a "continued" line of log printout (only done after a
 * line that had no enclosing \n). Only to be used by core/arch code
 * during early bootup (a continued line is not SMP-safe otherwise).
 */
106
#define	KERN_CONT	"<c>"
I
Ingo Molnar 已提交
107

L
Linus Torvalds 已提交
108 109 110 111 112 113 114 115
extern int console_printk[];

#define console_loglevel (console_printk[0])
#define default_message_loglevel (console_printk[1])
#define minimum_console_loglevel (console_printk[2])
#define default_console_loglevel (console_printk[3])

struct completion;
A
akpm@osdl.org 已提交
116 117
struct pt_regs;
struct user;
L
Linus Torvalds 已提交
118

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

126
#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
127
  void __might_sleep(char *file, int line, int preempt_offset);
L
Linus Torvalds 已提交
128 129 130 131 132 133 134
/**
 * 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
135
 * be bitten later when the calling function happens to sleep when it is not
L
Linus Torvalds 已提交
136 137
 * supposed to.
 */
138
# define might_sleep() \
139
	do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
L
Linus Torvalds 已提交
140
#else
141
  static inline void __might_sleep(char *file, int line, int preempt_offset) { }
142
# define might_sleep() do { might_resched(); } while (0)
L
Linus Torvalds 已提交
143 144
#endif

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

L
Linus Torvalds 已提交
147
#define abs(x) ({				\
148
		long __x = (x);			\
L
Linus Torvalds 已提交
149 150 151
		(__x < 0) ? -__x : __x;		\
	})

152 153 154 155 156 157 158 159 160
#ifdef CONFIG_PROVE_LOCKING
void might_fault(void);
#else
static inline void might_fault(void)
{
	might_sleep();
}
#endif

161
extern struct atomic_notifier_head panic_notifier_list;
L
Linus Torvalds 已提交
162 163
extern long (*panic_blink)(long time);
NORET_TYPE void panic(const char * fmt, ...)
164
	__attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
165 166 167
extern void oops_enter(void);
extern void oops_exit(void);
extern int oops_may_print(void);
168
NORET_TYPE void do_exit(long error_code)
L
Linus Torvalds 已提交
169 170 171 172 173 174 175
	ATTRIB_NORET;
NORET_TYPE void complete_and_exit(struct completion *, long)
	ATTRIB_NORET;
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);
176 177 178 179
extern int strict_strtoul(const char *, unsigned int, unsigned long *);
extern int strict_strtol(const char *, unsigned int, long *);
extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
extern int strict_strtoll(const char *, unsigned int, long long *);
L
Linus Torvalds 已提交
180 181 182 183 184 185 186 187 188 189 190 191
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)));
192 193
extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
J
Jeremy Fitzhardinge 已提交
194
extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
L
Linus Torvalds 已提交
195 196 197 198 199 200 201 202

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);
203
extern unsigned long long memparse(const char *ptr, char **retptr);
L
Linus Torvalds 已提交
204

205
extern int core_kernel_text(unsigned long addr);
L
Linus Torvalds 已提交
206 207
extern int __kernel_text_address(unsigned long addr);
extern int kernel_text_address(unsigned long addr);
208 209
extern int func_ptr_is_kernel_text(void *ptr);

210 211
struct pid;
extern struct pid *session_of_pgrp(struct pid *pgrp);
L
Linus Torvalds 已提交
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
/*
 * FW_BUG
 * Add this to a message where you are sure the firmware is buggy or behaves
 * really stupid or out of spec. Be aware that the responsible BIOS developer
 * should be able to fix this issue or at least get a concrete idea of the
 * problem by reading your message without the need of looking at the kernel
 * code.
 * 
 * Use it for definite and high priority BIOS bugs.
 *
 * FW_WARN
 * Use it for not that clear (e.g. could the kernel messed up things already?)
 * and medium priority BIOS bugs.
 *
 * FW_INFO
 * Use this one if you want to tell the user or vendor about something
 * suspicious, but generally harmless related to the firmware.
 *
 * Use it for information or very low priority BIOS bugs.
 */
#define FW_BUG		"[Firmware Bug]: "
#define FW_WARN		"[Firmware Warn]: "
#define FW_INFO		"[Firmware Info]: "

M
Matt Mackall 已提交
237
#ifdef CONFIG_PRINTK
L
Linus Torvalds 已提交
238 239 240
asmlinkage int vprintk(const char *fmt, va_list args)
	__attribute__ ((format (printf, 1, 0)));
asmlinkage int printk(const char * fmt, ...)
241
	__attribute__ ((format (printf, 1, 2))) __cold;
242

243 244
extern int __printk_ratelimit(const char *func);
#define printk_ratelimit() __printk_ratelimit(__func__)
245 246
extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
				   unsigned int interval_msec);
I
Ingo Molnar 已提交
247

248 249
extern int printk_delay_msec;

I
Ingo Molnar 已提交
250 251 252 253
/*
 * Print a one-time message (analogous to WARN_ONCE() et al):
 */
#define printk_once(x...) ({			\
254
	static bool __print_once;		\
I
Ingo Molnar 已提交
255
						\
256 257
	if (!__print_once) {			\
		__print_once = true;		\
I
Ingo Molnar 已提交
258 259 260 261
		printk(x);			\
	}					\
})

262
void log_buf_kexec_setup(void);
M
Matt Mackall 已提交
263 264 265 266 267 268
#else
static inline int vprintk(const char *s, va_list args)
	__attribute__ ((format (printf, 1, 0)));
static inline int vprintk(const char *s, va_list args) { return 0; }
static inline int printk(const char *s, ...)
	__attribute__ ((format (printf, 1, 2)));
269
static inline int __cold printk(const char *s, ...) { return 0; }
270 271 272 273
static inline int printk_ratelimit(void) { return 0; }
static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
					  unsigned int interval_msec)	\
		{ return false; }
I
Ingo Molnar 已提交
274 275 276 277

/* No effect, but we still get type checking even in the !PRINTK case: */
#define printk_once(x...) printk(x)

278 279 280
static inline void log_buf_kexec_setup(void)
{
}
M
Matt Mackall 已提交
281
#endif
L
Linus Torvalds 已提交
282

I
Ingo Molnar 已提交
283 284 285
extern int printk_needs_cpu(int cpu);
extern void printk_tick(void);

286
extern void asmlinkage __attribute__((format(printf, 1, 2)))
287 288
	early_printk(const char *fmt, ...);

L
Linus Torvalds 已提交
289 290 291 292 293 294 295 296 297 298 299 300 301 302
unsigned long int_sqrt(unsigned long);

static inline void console_silent(void)
{
	console_loglevel = 0;
}

static inline void console_verbose(void)
{
	if (console_loglevel)
		console_loglevel = 15;
}

extern void bust_spinlocks(int yes);
303
extern void wake_up_klogd(void);
L
Linus Torvalds 已提交
304
extern int oops_in_progress;		/* If set, an oops, panic(), BUG() or die() is in progress */
305
extern int panic_timeout;
L
Linus Torvalds 已提交
306
extern int panic_on_oops;
307
extern int panic_on_unrecovered_nmi;
308
extern int panic_on_io_nmi;
L
Linus Torvalds 已提交
309
extern const char *print_tainted(void);
A
Andi Kleen 已提交
310 311 312
extern void add_taint(unsigned flag);
extern int test_taint(unsigned flag);
extern unsigned long get_taint(void);
313
extern int root_mountflags;
L
Linus Torvalds 已提交
314 315 316 317 318 319 320 321

/* Values used for system_state */
extern enum system_states {
	SYSTEM_BOOTING,
	SYSTEM_RUNNING,
	SYSTEM_HALT,
	SYSTEM_POWER_OFF,
	SYSTEM_RESTART,
322
	SYSTEM_SUSPEND_DISK,
L
Linus Torvalds 已提交
323 324
} system_state;

A
Andi Kleen 已提交
325 326 327 328 329 330 331 332 333 334
#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
335
#define TAINT_CRAP			10
L
Linus Torvalds 已提交
336

337
extern void dump_stack(void) __cold;
L
Linus Torvalds 已提交
338

R
Randy Dunlap 已提交
339 340 341 342 343
enum {
	DUMP_PREFIX_NONE,
	DUMP_PREFIX_ADDRESS,
	DUMP_PREFIX_OFFSET
};
R
Randy Dunlap 已提交
344 345 346 347 348
extern void hex_dump_to_buffer(const void *buf, size_t len,
				int rowsize, int groupsize,
				char *linebuf, size_t linebuflen, bool ascii);
extern void print_hex_dump(const char *level, const char *prefix_str,
				int prefix_type, int rowsize, int groupsize,
A
Artem Bityutskiy 已提交
349
				const void *buf, size_t len, bool ascii);
R
Randy Dunlap 已提交
350
extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
351
			const void *buf, size_t len);
352 353 354 355 356 357 358 359 360 361 362

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 已提交
363

364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
#ifndef pr_fmt
#define pr_fmt(fmt) fmt
#endif

#define pr_emerg(fmt, ...) \
        printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
#define pr_alert(fmt, ...) \
        printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_crit(fmt, ...) \
        printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_err(fmt, ...) \
        printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
#define pr_warning(fmt, ...) \
        printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
#define pr_notice(fmt, ...) \
        printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
#define pr_info(fmt, ...) \
        printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
C
Cyrill Gorcunov 已提交
382 383
#define pr_cont(fmt, ...) \
	printk(KERN_CONT fmt, ##__VA_ARGS__)
384

385 386 387 388 389 390 391 392 393
/* pr_devel() should produce zero code unless DEBUG is defined */
#ifdef DEBUG
#define pr_devel(fmt, ...) \
	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_devel(fmt, ...) \
	({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
#endif

394
/* If you are writing a driver, please use dev_dbg instead */
395 396 397
#if defined(DEBUG)
#define pr_debug(fmt, ...) \
	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
398
#elif defined(CONFIG_DYNAMIC_DEBUG)
399
/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
400 401
#define pr_debug(fmt, ...) \
	dynamic_pr_debug(fmt, ##__VA_ARGS__)
L
Linus Torvalds 已提交
402
#else
403 404
#define pr_debug(fmt, ...) \
	({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
L
Linus Torvalds 已提交
405 406
#endif

407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
/*
 * ratelimited messages with local ratelimit_state,
 * no local ratelimit_state used in the !PRINTK case
 */
#ifdef CONFIG_PRINTK
#define printk_ratelimited(fmt, ...)  ({		\
	static struct ratelimit_state _rs = {		\
		.interval = DEFAULT_RATELIMIT_INTERVAL, \
		.burst = DEFAULT_RATELIMIT_BURST,       \
	};                                              \
							\
	if (!__ratelimit(&_rs))                         \
		printk(fmt, ##__VA_ARGS__);		\
})
#else
/* No effect, but we still get type checking even in the !PRINTK case: */
#define printk_ratelimited printk
#endif

#define pr_emerg_ratelimited(fmt, ...) \
	printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
#define pr_alert_ratelimited(fmt, ...) \
	printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_crit_ratelimited(fmt, ...) \
	printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_err_ratelimited(fmt, ...) \
	printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
#define pr_warning_ratelimited(fmt, ...) \
	printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
#define pr_notice_ratelimited(fmt, ...) \
	printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
#define pr_info_ratelimited(fmt, ...) \
	printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
/* no pr_cont_ratelimited, don't do that... */
/* If you are writing a driver, please use dev_dbg instead */
#if defined(DEBUG)
#define pr_debug_ratelimited(fmt, ...) \
	printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_debug_ratelimited(fmt, ...) \
	({ if (0) printk_ratelimited(KERN_DEBUG pr_fmt(fmt), \
				     ##__VA_ARGS__); 0; })
#endif

451 452
/*
 * General tracing related utility functions - trace_printk(),
453 454 455 456
 * 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.
457
 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
458 459 460 461 462 463 464 465 466 467 468
 * 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.
469
 */
470 471 472 473 474 475 476 477 478 479 480 481
#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
482 483 484 485 486 487 488 489
#ifdef CONFIG_TRACING
extern void tracing_start(void);
extern void tracing_stop(void);
extern void ftrace_off_permanent(void);

extern void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);

490 491 492 493 494 495 496 497 498 499
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)

500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
/**
 * 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.
 */
516 517 518 519

#define trace_printk(fmt, args...)					\
do {									\
	__trace_printk_check_format(fmt, ##args);			\
520 521 522 523 524 525 526 527
	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);		\
528 529
} while (0)

530 531 532 533
extern int
__trace_bprintk(unsigned long ip, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));

534 535 536
extern int
__trace_printk(unsigned long ip, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
537

538 539 540 541 542
/*
 * 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.
 */
543 544
#define ftrace_vprintk(fmt, vargs)					\
do {									\
545 546 547 548
	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 已提交
549
									\
550 551 552
		__ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs);	\
	} else								\
		__ftrace_vprintk(_THIS_IP_, fmt, vargs);		\
553 554
} while (0)

555 556 557
extern int
__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);

558 559
extern int
__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
560

561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
extern void ftrace_dump(void);
#else
static inline void
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
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) { }
static inline int
trace_printk(const char *fmt, ...)
{
	return 0;
}
static inline int
ftrace_vprintk(const char *fmt, va_list ap)
{
	return 0;
}
static inline void ftrace_dump(void) { }
582
#endif /* CONFIG_TRACING */
583

L
Linus Torvalds 已提交
584 585 586 587 588 589 590 591 592
/*
 *      Display an IP address in readable format.
 */

#define NIPQUAD(addr) \
	((unsigned char *)&addr)[0], \
	((unsigned char *)&addr)[1], \
	((unsigned char *)&addr)[2], \
	((unsigned char *)&addr)[3]
J
Joe Perches 已提交
593
#define NIPQUAD_FMT "%u.%u.%u.%u"
L
Linus Torvalds 已提交
594 595

/*
596
 * min()/max()/clamp() macros that also do
L
Linus Torvalds 已提交
597 598 599
 * strict type-checking.. See the
 * "unnecessary" pointer comparison.
 */
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
#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; })

/**
 * 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 已提交
629 630 631 632 633

/*
 * ..and if you can't take the strict
 * types, you can specify one yourself.
 *
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
 * 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 已提交
655
 */
656 657 658 659 660 661
#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 已提交
662

663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
/**
 * 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 已提交
680

681 682 683 684

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

L
Linus Torvalds 已提交
688 689 690 691 692 693 694 695
/**
 * 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) ({			\
696 697
	const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
	(type *)( (char *)__mptr - offsetof(type,member) );})
L
Linus Torvalds 已提交
698

699 700 701
struct sysinfo;
extern int do_sysinfo(struct sysinfo *info);

L
Linus Torvalds 已提交
702 703
#endif /* __KERNEL__ */

704 705 706 707 708 709
#ifndef __EXPORTED_HEADERS__
#ifndef __KERNEL__
#warning Attempt to use kernel headers from user space, see http://kernelnewbies.org/KernelHeaders
#endif /* __KERNEL__ */
#endif /* __EXPORTED_HEADERS__ */

L
Linus Torvalds 已提交
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
#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.. */
};

728
/* Force a compilation error if condition is true */
729 730 731 732
#define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))

/* Force a compilation error if condition is constant and true */
#define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
L
Linus Torvalds 已提交
733

734 735 736 737
/* 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). */
738 739
#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
740

L
Linus Torvalds 已提交
741 742 743
/* Trap pasters of __FUNCTION__ at compile-time */
#define __FUNCTION__ (__func__)

744 745 746 747 748 749 750
/* This helps us to avoid #ifdef CONFIG_NUMA */
#ifdef CONFIG_NUMA
#define NUMA_BUILD 1
#else
#define NUMA_BUILD 0
#endif

751 752 753 754 755
/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
#endif

L
Linus Torvalds 已提交
756
#endif