[deliverable/linux.git] / include / linux / kernel.h

#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>
#include <linux/log2.h>
#include <linux/typecheck.h>
#include <linux/ratelimit.h>
#include <asm/byteorder.h>
#include <asm/bug.h>

extern const char linux_banner[];
extern const char linux_proc_banner[];

#define USHORT_MAX	((u16)(~0U))
#define SHORT_MAX	((s16)(USHORT_MAX>>1))
#define SHORT_MIN	(-SHORT_MAX - 1)
#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)
#define LLONG_MAX	((long long)(~0ULL>>1))
#define LLONG_MIN	(-LLONG_MAX - 1)
#define ULLONG_MAX	(~0ULL)

#define STACK_MAGIC	0xdeadbeef

#define ALIGN(x,a)		__ALIGN_MASK(x,(typeof(x))(a)-1)
#define __ALIGN_MASK(x,mask)	(((x)+(mask))&~(mask))
#define PTR_ALIGN(p, a)		((typeof(p))ALIGN((unsigned long)(p), (a)))
#define IS_ALIGNED(x, a)		(((x) & ((typeof(x))(a) - 1)) == 0)

#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))

#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))

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

#ifdef CONFIG_LBD
# 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

/**
 * 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))

/**
 * lower_32_bits - return bits 0-31 of a number
 * @n: the number we're accessing
 */
#define lower_32_bits(n) ((u32)(n))

#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			*/

/*
 * 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).
 */
#define	KERN_CONT	""

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;
struct pt_regs;
struct user;

#ifdef CONFIG_PREEMPT_VOLUNTARY
extern int _cond_resched(void);
# define might_resched() _cond_resched()
#else
# define might_resched() do { } while (0)
#endif

/**
 * 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
 * be bitten later when the calling function happens to sleep when it is not
 * supposed to.
 */
#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
  void __might_sleep(char *file, int line);
# define might_sleep() \
	do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
#else
# define might_sleep() do { might_resched(); } while (0)
#endif

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

#define abs(x) ({				\
		int __x = (x);			\
		(__x < 0) ? -__x : __x;		\
	})

extern struct atomic_notifier_head panic_notifier_list;
extern long (*panic_blink)(long time);
NORET_TYPE void panic(const char * fmt, ...)
	__attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
extern void oops_enter(void);
extern void oops_exit(void);
extern int oops_may_print(void);
NORET_TYPE void do_exit(long error_code)
	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);
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 *);
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)));
extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
	__attribute__ ((format (printf, 2, 3)));
extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);

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);
extern unsigned long long memparse(char *ptr, char **retptr);

extern int core_kernel_text(unsigned long addr);
extern int __kernel_text_address(unsigned long addr);
extern int kernel_text_address(unsigned long addr);
struct pid;
extern struct pid *session_of_pgrp(struct pid *pgrp);

#ifdef CONFIG_PRINTK
asmlinkage int vprintk(const char *fmt, va_list args)
	__attribute__ ((format (printf, 1, 0)));
asmlinkage int printk(const char * fmt, ...)
	__attribute__ ((format (printf, 1, 2))) __cold;

extern struct ratelimit_state printk_ratelimit_state;
extern int printk_ratelimit(void);
extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
				   unsigned int interval_msec);
#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)));
static inline int __cold printk(const char *s, ...) { return 0; }
static inline int printk_ratelimit(void) { return 0; }
static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
					  unsigned int interval_msec)	\
		{ return false; }
#endif

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

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);
extern void wake_up_klogd(void);
extern int oops_in_progress;		/* If set, an oops, panic(), BUG() or die() is in progress */
extern int panic_timeout;
extern int panic_on_oops;
extern int panic_on_unrecovered_nmi;
extern int tainted;
extern const char *print_tainted(void);
extern void add_taint(unsigned);
extern int root_mountflags;

#ifdef CONFIG_X86_CHECK_BIOS_CORRUPTION
/*
 * This is obviously not a great place for this, but we want to be
 * able to scatter it around anywhere in the kernel.
 */
void check_for_bios_corruption(void);
#else
static inline void check_for_bios_corruption(void)
{
}
#endif

/* Values used for system_state */
extern enum system_states {
	SYSTEM_BOOTING,
	SYSTEM_RUNNING,
	SYSTEM_HALT,
	SYSTEM_POWER_OFF,
	SYSTEM_RESTART,
	SYSTEM_SUSPEND_DISK,
} system_state;

#define TAINT_PROPRIETARY_MODULE	(1<<0)
#define TAINT_FORCED_MODULE		(1<<1)
#define TAINT_UNSAFE_SMP		(1<<2)
#define TAINT_FORCED_RMMOD		(1<<3)
#define TAINT_MACHINE_CHECK		(1<<4)
#define TAINT_BAD_PAGE			(1<<5)
#define TAINT_USER			(1<<6)
#define TAINT_DIE			(1<<7)
#define TAINT_OVERRIDDEN_ACPI_TABLE	(1<<8)
#define TAINT_WARN			(1<<9)

extern void dump_stack(void) __cold;

enum {
	DUMP_PREFIX_NONE,
	DUMP_PREFIX_ADDRESS,
	DUMP_PREFIX_OFFSET
};
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,
				const void *buf, size_t len, bool ascii);
extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
			const void *buf, size_t len);

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;
}

#define pr_emerg(fmt, arg...) \
	printk(KERN_EMERG fmt, ##arg)
#define pr_alert(fmt, arg...) \
	printk(KERN_ALERT fmt, ##arg)
#define pr_crit(fmt, arg...) \
	printk(KERN_CRIT fmt, ##arg)
#define pr_err(fmt, arg...) \
	printk(KERN_ERR fmt, ##arg)
#define pr_warning(fmt, arg...) \
	printk(KERN_WARNING fmt, ##arg)
#define pr_notice(fmt, arg...) \
	printk(KERN_NOTICE fmt, ##arg)
#define pr_info(fmt, arg...) \
	printk(KERN_INFO fmt, ##arg)

#ifdef DEBUG
/* If you are writing a driver, please use dev_dbg instead */
#define pr_debug(fmt, arg...) \
	printk(KERN_DEBUG fmt, ##arg)
#else
#define pr_debug(fmt, arg...) \
	({ if (0) printk(KERN_DEBUG fmt, ##arg); 0; })
#endif

/*
 *      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]
#define NIPQUAD_FMT "%u.%u.%u.%u"

#define NIP6(addr) \
	ntohs((addr).s6_addr16[0]), \
	ntohs((addr).s6_addr16[1]), \
	ntohs((addr).s6_addr16[2]), \
	ntohs((addr).s6_addr16[3]), \
	ntohs((addr).s6_addr16[4]), \
	ntohs((addr).s6_addr16[5]), \
	ntohs((addr).s6_addr16[6]), \
	ntohs((addr).s6_addr16[7])
#define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
#define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"

#if defined(__LITTLE_ENDIAN)
#define HIPQUAD(addr) \
	((unsigned char *)&addr)[3], \
	((unsigned char *)&addr)[2], \
	((unsigned char *)&addr)[1], \
	((unsigned char *)&addr)[0]
#elif defined(__BIG_ENDIAN)
#define HIPQUAD	NIPQUAD
#else
#error "Please fix asm/byteorder.h"
#endif /* __LITTLE_ENDIAN */

/*
 * min()/max()/clamp() macros that also do
 * strict type-checking.. See the
 * "unnecessary" pointer comparison.
 */
#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; })

/*
 * ..and if you can't take the strict
 * types, you can specify one yourself.
 *
 * 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.
 */
#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; })

/**
 * 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; })

/**
 * 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) ({			\
	const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
	(type *)( (char *)__mptr - offsetof(type,member) );})

struct sysinfo;
extern int do_sysinfo(struct sysinfo *info);

#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.. */
};

/* Force a compilation error if condition is true */
#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))

/* 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). */
#define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)

/* Trap pasters of __FUNCTION__ at compile-time */
#define __FUNCTION__ (__func__)

/* This helps us to avoid #ifdef CONFIG_NUMA */
#ifdef CONFIG_NUMA
#define NUMA_BUILD 1
#else
#define NUMA_BUILD 0
#endif

#endif
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_KERNEL_H
	2	#define _LINUX_KERNEL_H
	3
	4	/*
	5	* 'kernel.h' contains some often-used function prototypes etc
	6	*/
	7
	8	#ifdef __KERNEL__
	9
	10	#include <stdarg.h>
	11	#include <linux/linkage.h>
	12	#include <linux/stddef.h>
	13	#include <linux/types.h>
	14	#include <linux/compiler.h>
	15	#include <linux/bitops.h>
f0d1b0b3	16	#include <linux/log2.h>
e0deaff4	17	#include <linux/typecheck.h>
717115e1	18	#include <linux/ratelimit.h>
1da177e4 LT	19	#include <asm/byteorder.h>
	20	#include <asm/bug.h>
	21
3eb3c740 RZ	22	extern const char linux_banner[];
	23	extern const char linux_proc_banner[];
	24
44f564a4 ZY	25	#define USHORT_MAX ((u16)(~0U))
	26	#define SHORT_MAX ((s16)(USHORT_MAX>>1))
	27	#define SHORT_MIN (-SHORT_MAX - 1)
1da177e4 LT	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)
111ebb6e OH	34	#define LLONG_MAX ((long long)(~0ULL>>1))
	35	#define LLONG_MIN (-LLONG_MAX - 1)
	36	#define ULLONG_MAX (~0ULL)
1da177e4 LT	37
	38	#define STACK_MAGIC 0xdeadbeef
	39
2ea58144 LT	40	#define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
2ea58144 LT	41	#define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
a83308e6	42	#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
f10db627	43	#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
2ea58144	44
c5e631cf RR	45	#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
c5e631cf RR	46
4552d5dc	47	#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
930631ed	48	#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
b4cac1a0	49	#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
1da177e4	50
ca31e146 EGM	51	#define _RET_IP_ (unsigned long)__builtin_return_address(0)
	52	#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
	53
2da96acd JA	54	#ifdef CONFIG_LBD
	55	# include <asm/div64.h>
	56	# define sector_div(a, b) do_div(a, b)
	57	#else
	58	# define sector_div(n, b)( \
	59	{ \
	60	int _res; \
	61	_res = (n) % (b); \
	62	(n) /= (b); \
	63	_res; \
	64	} \
	65	)
	66	#endif
	67
218e180e AM	68	/**
	69	* upper_32_bits - return bits 32-63 of a number
	70	* @n: the number we're accessing
	71	*
	72	* A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
	73	* the "right shift count >= width of type" warning when that quantity is
	74	* 32-bits.
	75	*/
	76	#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
	77
204b885e JR	78	/**
	79	* lower_32_bits - return bits 0-31 of a number
	80	* @n: the number we're accessing
	81	*/
	82	#define lower_32_bits(n) ((u32)(n))
	83
1da177e4 LT	84	#define KERN_EMERG "<0>" /* system is unusable */
	85	#define KERN_ALERT "<1>" /* action must be taken immediately */
	86	#define KERN_CRIT "<2>" /* critical conditions */
	87	#define KERN_ERR "<3>" /* error conditions */
	88	#define KERN_WARNING "<4>" /* warning conditions */
	89	#define KERN_NOTICE "<5>" /* normal but significant condition */
	90	#define KERN_INFO "<6>" /* informational */
	91	#define KERN_DEBUG "<7>" /* debug-level messages */
	92
47492527 IM	93	/*
	94	* Annotation for a "continued" line of log printout (only done after a
	95	* line that had no enclosing \n). Only to be used by core/arch code
	96	* during early bootup (a continued line is not SMP-safe otherwise).
	97	*/
	98	#define KERN_CONT ""
	99
1da177e4 LT	100	extern int console_printk[];
	101
	102	#define console_loglevel (console_printk[0])
	103	#define default_message_loglevel (console_printk[1])
	104	#define minimum_console_loglevel (console_printk[2])
	105	#define default_console_loglevel (console_printk[3])
	106
	107	struct completion;
df2e71fb	108	struct pt_regs;
df2e71fb	109	struct user;
1da177e4	110
070cb065 UKK	111	#ifdef CONFIG_PREEMPT_VOLUNTARY
	112	extern int _cond_resched(void);
	113	# define might_resched() _cond_resched()
	114	#else
	115	# define might_resched() do { } while (0)
	116	#endif
	117
1da177e4 LT	118	/**
	119	* might_sleep - annotation for functions that can sleep
	120	*
	121	* this macro will print a stack trace if it is executed in an atomic
	122	* context (spinlock, irq-handler, ...).
	123	*
	124	* This is a useful debugging help to be able to catch problems early and not
e20ec991	125	* be bitten later when the calling function happens to sleep when it is not
1da177e4 LT	126	* supposed to.
	127	*/
	128	#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
f8cbd99b IM	129	void __might_sleep(char *file, int line);
	130	# define might_sleep() \
	131	do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
1da177e4	132	#else
f8cbd99b	133	# define might_sleep() do { might_resched(); } while (0)
1da177e4 LT	134	#endif
1da177e4 LT	135
368a5fa1	136	#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
f8cbd99b	137
1da177e4 LT	138	#define abs(x) ({ \
	139	int __x = (x); \
	140	(__x < 0) ? -__x : __x; \
	141	})
	142
e041c683	143	extern struct atomic_notifier_head panic_notifier_list;
1da177e4 LT	144	extern long (*panic_blink)(long time);
1da177e4 LT	145	NORET_TYPE void panic(const char * fmt, ...)
a586df06	146	__attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
dd287796 AM	147	extern void oops_enter(void);
	148	extern void oops_exit(void);
	149	extern int oops_may_print(void);
ec701584	150	NORET_TYPE void do_exit(long error_code)
1da177e4 LT	151	ATTRIB_NORET;
	152	NORET_TYPE void complete_and_exit(struct completion *, long)
	153	ATTRIB_NORET;
	154	extern unsigned long simple_strtoul(const char ,char *,unsigned int);
	155	extern long simple_strtol(const char ,char *,unsigned int);
	156	extern unsigned long long simple_strtoull(const char ,char *,unsigned int);
	157	extern long long simple_strtoll(const char ,char *,unsigned int);
06b2a76d YY	158	extern int strict_strtoul(const char , unsigned int, unsigned long );
	159	extern int strict_strtol(const char , unsigned int, long );
	160	extern int strict_strtoull(const char , unsigned int, unsigned long long );
	161	extern int strict_strtoll(const char , unsigned int, long long );
1da177e4 LT	162	extern int sprintf(char * buf, const char * fmt, ...)
	163	__attribute__ ((format (printf, 2, 3)));
	164	extern int vsprintf(char buf, const char , va_list)
	165	__attribute__ ((format (printf, 2, 0)));
	166	extern int snprintf(char * buf, size_t size, const char * fmt, ...)
	167	__attribute__ ((format (printf, 3, 4)));
	168	extern int vsnprintf(char buf, size_t size, const char fmt, va_list args)
	169	__attribute__ ((format (printf, 3, 0)));
	170	extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
	171	__attribute__ ((format (printf, 3, 4)));
	172	extern int vscnprintf(char buf, size_t size, const char fmt, va_list args)
	173	__attribute__ ((format (printf, 3, 0)));
e905914f JF	174	extern char kasprintf(gfp_t gfp, const char fmt, ...)
e905914f JF	175	__attribute__ ((format (printf, 2, 3)));
11443ec7	176	extern char kvasprintf(gfp_t gfp, const char fmt, va_list args);
1da177e4 LT	177
	178	extern int sscanf(const char , const char , ...)
	179	__attribute__ ((format (scanf, 2, 3)));
	180	extern int vsscanf(const char , const char , va_list)
	181	__attribute__ ((format (scanf, 2, 0)));
	182
	183	extern int get_option(char *str, int pint);
	184	extern char get_options(const char str, int nints, int *ints);
	185	extern unsigned long long memparse(char ptr, char *retptr);
	186
5e376613	187	extern int core_kernel_text(unsigned long addr);
1da177e4 LT	188	extern int __kernel_text_address(unsigned long addr);
1da177e4 LT	189	extern int kernel_text_address(unsigned long addr);
04a2e6a5 EB	190	struct pid;
04a2e6a5 EB	191	extern struct pid session_of_pgrp(struct pid pgrp);
1da177e4	192
d59745ce	193	#ifdef CONFIG_PRINTK
1da177e4 LT	194	asmlinkage int vprintk(const char *fmt, va_list args)
	195	__attribute__ ((format (printf, 1, 0)));
	196	asmlinkage int printk(const char * fmt, ...)
a586df06	197	__attribute__ ((format (printf, 1, 2))) __cold;
7ef3d2fd	198
717115e1	199	extern struct ratelimit_state printk_ratelimit_state;
7ef3d2fd	200	extern int printk_ratelimit(void);
7ef3d2fd JP	201	extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
7ef3d2fd JP	202	unsigned int interval_msec);
d59745ce MM	203	#else
	204	static inline int vprintk(const char *s, va_list args)
	205	__attribute__ ((format (printf, 1, 0)));
	206	static inline int vprintk(const char *s, va_list args) { return 0; }
	207	static inline int printk(const char *s, ...)
	208	__attribute__ ((format (printf, 1, 2)));
a586df06	209	static inline int __cold printk(const char *s, ...) { return 0; }
7ef3d2fd	210	static inline int printk_ratelimit(void) { return 0; }
7ef3d2fd JP	211	static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
	212	unsigned int interval_msec) \
	213	{ return false; }
d59745ce	214	#endif
1da177e4	215
e17ba73b	216	extern void asmlinkage __attribute__((format(printf, 1, 2)))
076f9776 IM	217	early_printk(const char *fmt, ...);
076f9776 IM	218
1da177e4 LT	219	unsigned long int_sqrt(unsigned long);
1da177e4 LT	220
1da177e4 LT	221	static inline void console_silent(void)
	222	{
	223	console_loglevel = 0;
	224	}
	225
	226	static inline void console_verbose(void)
	227	{
	228	if (console_loglevel)
	229	console_loglevel = 15;
	230	}
	231
	232	extern void bust_spinlocks(int yes);
e3e8a75d	233	extern void wake_up_klogd(void);
1da177e4	234	extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
aa727107	235	extern int panic_timeout;
1da177e4	236	extern int panic_on_oops;
8da5adda	237	extern int panic_on_unrecovered_nmi;
1da177e4 LT	238	extern int tainted;
	239	extern const char *print_tainted(void);
	240	extern void add_taint(unsigned);
b920de1b	241	extern int root_mountflags;
1da177e4	242
5394f80f JF	243	#ifdef CONFIG_X86_CHECK_BIOS_CORRUPTION
	244	/*
	245	* This is obviously not a great place for this, but we want to be
	246	* able to scatter it around anywhere in the kernel.
	247	*/
	248	void check_for_bios_corruption(void);
	249	#else
	250	static inline void check_for_bios_corruption(void)
	251	{
	252	}
	253	#endif
	254
1da177e4 LT	255	/* Values used for system_state */
	256	extern enum system_states {
	257	SYSTEM_BOOTING,
	258	SYSTEM_RUNNING,
	259	SYSTEM_HALT,
	260	SYSTEM_POWER_OFF,
	261	SYSTEM_RESTART,
729b4d4c	262	SYSTEM_SUSPEND_DISK,
1da177e4 LT	263	} system_state;
	264
	265	#define TAINT_PROPRIETARY_MODULE (1<<0)
	266	#define TAINT_FORCED_MODULE (1<<1)
	267	#define TAINT_UNSAFE_SMP (1<<2)
	268	#define TAINT_FORCED_RMMOD (1<<3)
	269	#define TAINT_MACHINE_CHECK (1<<4)
	270	#define TAINT_BAD_PAGE (1<<5)
34f5a398	271	#define TAINT_USER (1<<6)
bcdcd8e7	272	#define TAINT_DIE (1<<7)
6ed31e92	273	#define TAINT_OVERRIDDEN_ACPI_TABLE (1<<8)
95b570c9	274	#define TAINT_WARN (1<<9)
1da177e4	275
a586df06	276	extern void dump_stack(void) __cold;
1da177e4	277
99eaf3c4 RD	278	enum {
	279	DUMP_PREFIX_NONE,
	280	DUMP_PREFIX_ADDRESS,
	281	DUMP_PREFIX_OFFSET
	282	};
c7909234 RD	283	extern void hex_dump_to_buffer(const void *buf, size_t len,
	284	int rowsize, int groupsize,
	285	char *linebuf, size_t linebuflen, bool ascii);
	286	extern void print_hex_dump(const char level, const char prefix_str,
	287	int prefix_type, int rowsize, int groupsize,
6a0ed91e	288	const void *buf, size_t len, bool ascii);
c7909234	289	extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
eb9a9a56	290	const void *buf, size_t len);
3fc95772 HH	291
	292	extern const char hex_asc[];
	293	#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
	294	#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
	295
	296	static inline char pack_hex_byte(char buf, u8 byte)
	297	{
	298	*buf++ = hex_asc_hi(byte);
	299	*buf++ = hex_asc_lo(byte);
	300	return buf;
	301	}
99eaf3c4	302
1f7c8234 EM	303	#define pr_emerg(fmt, arg...) \
	304	printk(KERN_EMERG fmt, ##arg)
	305	#define pr_alert(fmt, arg...) \
	306	printk(KERN_ALERT fmt, ##arg)
	307	#define pr_crit(fmt, arg...) \
	308	printk(KERN_CRIT fmt, ##arg)
	309	#define pr_err(fmt, arg...) \
	310	printk(KERN_ERR fmt, ##arg)
	311	#define pr_warning(fmt, arg...) \
	312	printk(KERN_WARNING fmt, ##arg)
	313	#define pr_notice(fmt, arg...) \
	314	printk(KERN_NOTICE fmt, ##arg)
	315	#define pr_info(fmt, arg...) \
	316	printk(KERN_INFO fmt, ##arg)
	317
1da177e4	318	#ifdef DEBUG
1cc6daf2	319	/* If you are writing a driver, please use dev_dbg instead */
1f7c8234 EM	320	#define pr_debug(fmt, arg...) \
1f7c8234 EM	321	printk(KERN_DEBUG fmt, ##arg)
1da177e4	322	#else
1429db83 JP	323	#define pr_debug(fmt, arg...) \
1429db83 JP	324	({ if (0) printk(KERN_DEBUG fmt, ##arg); 0; })
1da177e4 LT	325	#endif
1da177e4 LT	326
1da177e4 LT	327	/*
	328	* Display an IP address in readable format.
	329	*/
	330
	331	#define NIPQUAD(addr) \
	332	((unsigned char *)&addr)[0], \
	333	((unsigned char *)&addr)[1], \
	334	((unsigned char *)&addr)[2], \
	335	((unsigned char *)&addr)[3]
46b86a2d	336	#define NIPQUAD_FMT "%u.%u.%u.%u"
1da177e4 LT	337
	338	#define NIP6(addr) \
	339	ntohs((addr).s6_addr16[0]), \
	340	ntohs((addr).s6_addr16[1]), \
	341	ntohs((addr).s6_addr16[2]), \
	342	ntohs((addr).s6_addr16[3]), \
	343	ntohs((addr).s6_addr16[4]), \
	344	ntohs((addr).s6_addr16[5]), \
	345	ntohs((addr).s6_addr16[6]), \
	346	ntohs((addr).s6_addr16[7])
46b86a2d	347	#define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
9343e79a	348	#define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
1da177e4 LT	349
	350	#if defined(__LITTLE_ENDIAN)
	351	#define HIPQUAD(addr) \
	352	((unsigned char *)&addr)[3], \
	353	((unsigned char *)&addr)[2], \
	354	((unsigned char *)&addr)[1], \
	355	((unsigned char *)&addr)[0]
	356	#elif defined(__BIG_ENDIAN)
	357	#define HIPQUAD NIPQUAD
	358	#else
	359	#error "Please fix asm/byteorder.h"
	360	#endif /* __LITTLE_ENDIAN */
	361
	362	/*
bdf4bbaa	363	* min()/max()/clamp() macros that also do
1da177e4 LT	364	* strict type-checking.. See the
	365	* "unnecessary" pointer comparison.
	366	*/
bdf4bbaa HH	367	#define min(x, y) ({ \
	368	typeof(x) _min1 = (x); \
	369	typeof(y) _min2 = (y); \
	370	(void) (&_min1 == &_min2); \
	371	_min1 < _min2 ? _min1 : _min2; })
	372
	373	#define max(x, y) ({ \
	374	typeof(x) _max1 = (x); \
	375	typeof(y) _max2 = (y); \
	376	(void) (&_max1 == &_max2); \
	377	_max1 > _max2 ? _max1 : _max2; })
	378
	379	/**
	380	* clamp - return a value clamped to a given range with strict typechecking
	381	* @val: current value
	382	* @min: minimum allowable value
	383	* @max: maximum allowable value
	384	*
	385	* This macro does strict typechecking of min/max to make sure they are of the
	386	* same type as val. See the unnecessary pointer comparisons.
	387	*/
	388	#define clamp(val, min, max) ({ \
	389	typeof(val) __val = (val); \
	390	typeof(min) __min = (min); \
	391	typeof(max) __max = (max); \
	392	(void) (&__val == &__min); \
	393	(void) (&__val == &__max); \
	394	__val = __val < __min ? __min: __val; \
	395	__val > __max ? __max: __val; })
1da177e4 LT	396
	397	/*
	398	* ..and if you can't take the strict
	399	* types, you can specify one yourself.
	400	*
bdf4bbaa HH	401	* Or not use min/max/clamp at all, of course.
	402	*/
	403	#define min_t(type, x, y) ({ \
	404	type __min1 = (x); \
	405	type __min2 = (y); \
	406	__min1 < __min2 ? __min1: __min2; })
	407
	408	#define max_t(type, x, y) ({ \
	409	type __max1 = (x); \
	410	type __max2 = (y); \
	411	__max1 > __max2 ? __max1: __max2; })
	412
	413	/**
	414	* clamp_t - return a value clamped to a given range using a given type
	415	* @type: the type of variable to use
	416	* @val: current value
	417	* @min: minimum allowable value
	418	* @max: maximum allowable value
	419	*
	420	* This macro does no typechecking and uses temporary variables of type
	421	* 'type' to make all the comparisons.
1da177e4	422	*/
bdf4bbaa HH	423	#define clamp_t(type, val, min, max) ({ \
	424	type __val = (val); \
	425	type __min = (min); \
	426	type __max = (max); \
	427	__val = __val < __min ? __min: __val; \
	428	__val > __max ? __max: __val; })
1da177e4	429
bdf4bbaa HH	430	/**
	431	* clamp_val - return a value clamped to a given range using val's type
	432	* @val: current value
	433	* @min: minimum allowable value
	434	* @max: maximum allowable value
	435	*
	436	* This macro does no typechecking and uses temporary variables of whatever
	437	* type the input argument 'val' is. This is useful when val is an unsigned
	438	* type and min and max are literals that will otherwise be assigned a signed
	439	* integer type.
	440	*/
	441	#define clamp_val(val, min, max) ({ \
	442	typeof(val) __val = (val); \
	443	typeof(val) __min = (min); \
	444	typeof(val) __max = (max); \
	445	__val = __val < __min ? __min: __val; \
	446	__val > __max ? __max: __val; })
1da177e4 LT	447
	448	/**
	449	* container_of - cast a member of a structure out to the containing structure
1da177e4 LT	450	* @ptr: the pointer to the member.
	451	* @type: the type of the container struct this is embedded in.
	452	* @member: the name of the member within the struct.
	453	*
	454	*/
	455	#define container_of(ptr, type, member) ({ \
78db2ad6 DW	456	const typeof( ((type )0)->member ) __mptr = (ptr); \
78db2ad6 DW	457	(type )( (char )__mptr - offsetof(type,member) );})
1da177e4	458
d4d23add KM	459	struct sysinfo;
	460	extern int do_sysinfo(struct sysinfo *info);
	461
1da177e4 LT	462	#endif /* __KERNEL__ */
	463
	464	#define SI_LOAD_SHIFT 16
	465	struct sysinfo {
	466	long uptime; /* Seconds since boot */
	467	unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
	468	unsigned long totalram; /* Total usable main memory size */
	469	unsigned long freeram; /* Available memory size */
	470	unsigned long sharedram; /* Amount of shared memory */
	471	unsigned long bufferram; /* Memory used by buffers */
	472	unsigned long totalswap; /* Total swap space size */
	473	unsigned long freeswap; /* swap space still available */
	474	unsigned short procs; /* Number of current processes */
	475	unsigned short pad; /* explicit padding for m68k */
	476	unsigned long totalhigh; /* Total high memory size */
	477	unsigned long freehigh; /* Available high memory size */
	478	unsigned int mem_unit; /* Memory unit size in bytes */
	479	char _f[20-2sizeof(long)-sizeof(int)]; / Padding: libc5 uses this.. */
	480	};
	481
c0398ee6	482	/* Force a compilation error if condition is true */
921717a2	483	#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
1da177e4	484
4552d5dc JB	485	/* Force a compilation error if condition is true, but also produce a
	486	result (of value 0 and type size_t), so the expression can be used
	487	e.g. in a structure initializer (or where-ever else comma expressions
	488	aren't permitted). */
	489	#define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
	490
1da177e4	491	/* Trap pasters of __FUNCTION__ at compile-time */
1da177e4	492	#define __FUNCTION__ (__func__)
1da177e4	493
08e0f6a9 CL	494	/* This helps us to avoid #ifdef CONFIG_NUMA */
	495	#ifdef CONFIG_NUMA
	496	#define NUMA_BUILD 1
	497	#else
	498	#define NUMA_BUILD 0
	499	#endif
	500
1da177e4	501	#endif