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>
16#include <asm/byteorder.h>
17#include <asm/bug.h>
18
19extern const char linux_banner[];
20
21#define INT_MAX		((int)(~0U>>1))
22#define INT_MIN		(-INT_MAX - 1)
23#define UINT_MAX	(~0U)
24#define LONG_MAX	((long)(~0UL>>1))
25#define LONG_MIN	(-LONG_MAX - 1)
26#define ULONG_MAX	(~0UL)
27#define LLONG_MAX	((long long)(~0ULL>>1))
28#define LLONG_MIN	(-LLONG_MAX - 1)
29#define ULLONG_MAX	(~0ULL)
30
31#define STACK_MAGIC	0xdeadbeef
32
33#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
34#define ALIGN(x,a) (((x)+(a)-1)&~((a)-1))
35#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
36#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
37
38#define	KERN_EMERG	"<0>"	/* system is unusable			*/
39#define	KERN_ALERT	"<1>"	/* action must be taken immediately	*/
40#define	KERN_CRIT	"<2>"	/* critical conditions			*/
41#define	KERN_ERR	"<3>"	/* error conditions			*/
42#define	KERN_WARNING	"<4>"	/* warning conditions			*/
43#define	KERN_NOTICE	"<5>"	/* normal but significant condition	*/
44#define	KERN_INFO	"<6>"	/* informational			*/
45#define	KERN_DEBUG	"<7>"	/* debug-level messages			*/
46
47extern int console_printk[];
48
49#define console_loglevel (console_printk[0])
50#define default_message_loglevel (console_printk[1])
51#define minimum_console_loglevel (console_printk[2])
52#define default_console_loglevel (console_printk[3])
53
54struct completion;
55struct pt_regs;
56struct user;
57
58/**
59 * might_sleep - annotation for functions that can sleep
60 *
61 * this macro will print a stack trace if it is executed in an atomic
62 * context (spinlock, irq-handler, ...).
63 *
64 * This is a useful debugging help to be able to catch problems early and not
65 * be biten later when the calling function happens to sleep when it is not
66 * supposed to.
67 */
68#ifdef CONFIG_PREEMPT_VOLUNTARY
69extern int cond_resched(void);
70# define might_resched() cond_resched()
71#else
72# define might_resched() do { } while (0)
73#endif
74
75#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
76  void __might_sleep(char *file, int line);
77# define might_sleep() \
78	do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
79#else
80# define might_sleep() do { might_resched(); } while (0)
81#endif
82
83#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
84
85#define abs(x) ({				\
86		int __x = (x);			\
87		(__x < 0) ? -__x : __x;		\
88	})
89
90#define labs(x) ({				\
91		long __x = (x);			\
92		(__x < 0) ? -__x : __x;		\
93	})
94
95extern struct atomic_notifier_head panic_notifier_list;
96extern long (*panic_blink)(long time);
97NORET_TYPE void panic(const char * fmt, ...)
98	__attribute__ ((NORET_AND format (printf, 1, 2)));
99extern void oops_enter(void);
100extern void oops_exit(void);
101extern int oops_may_print(void);
102fastcall NORET_TYPE void do_exit(long error_code)
103	ATTRIB_NORET;
104NORET_TYPE void complete_and_exit(struct completion *, long)
105	ATTRIB_NORET;
106extern unsigned long simple_strtoul(const char *,char **,unsigned int);
107extern long simple_strtol(const char *,char **,unsigned int);
108extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
109extern long long simple_strtoll(const char *,char **,unsigned int);
110extern int sprintf(char * buf, const char * fmt, ...)
111	__attribute__ ((format (printf, 2, 3)));
112extern int vsprintf(char *buf, const char *, va_list)
113	__attribute__ ((format (printf, 2, 0)));
114extern int snprintf(char * buf, size_t size, const char * fmt, ...)
115	__attribute__ ((format (printf, 3, 4)));
116extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
117	__attribute__ ((format (printf, 3, 0)));
118extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
119	__attribute__ ((format (printf, 3, 4)));
120extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
121	__attribute__ ((format (printf, 3, 0)));
122extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
123	__attribute__ ((format (printf, 2, 3)));
124
125extern int sscanf(const char *, const char *, ...)
126	__attribute__ ((format (scanf, 2, 3)));
127extern int vsscanf(const char *, const char *, va_list)
128	__attribute__ ((format (scanf, 2, 0)));
129
130extern int get_option(char **str, int *pint);
131extern char *get_options(const char *str, int nints, int *ints);
132extern unsigned long long memparse(char *ptr, char **retptr);
133
134extern int core_kernel_text(unsigned long addr);
135extern int __kernel_text_address(unsigned long addr);
136extern int kernel_text_address(unsigned long addr);
137extern int session_of_pgrp(int pgrp);
138
139extern void dump_thread(struct pt_regs *regs, struct user *dump);
140
141#ifdef CONFIG_PRINTK
142asmlinkage int vprintk(const char *fmt, va_list args)
143	__attribute__ ((format (printf, 1, 0)));
144asmlinkage int printk(const char * fmt, ...)
145	__attribute__ ((format (printf, 1, 2)));
146#else
147static inline int vprintk(const char *s, va_list args)
148	__attribute__ ((format (printf, 1, 0)));
149static inline int vprintk(const char *s, va_list args) { return 0; }
150static inline int printk(const char *s, ...)
151	__attribute__ ((format (printf, 1, 2)));
152static inline int printk(const char *s, ...) { return 0; }
153#endif
154
155unsigned long int_sqrt(unsigned long);
156
157static inline int __attribute_pure__ long_log2(unsigned long x)
158{
159	int r = 0;
160	for (x >>= 1; x > 0; x >>= 1)
161		r++;
162	return r;
163}
164
165static inline unsigned long
166__attribute_const__ roundup_pow_of_two(unsigned long x)
167{
168	return 1UL << fls_long(x - 1);
169}
170
171extern int printk_ratelimit(void);
172extern int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst);
173
174static inline void console_silent(void)
175{
176	console_loglevel = 0;
177}
178
179static inline void console_verbose(void)
180{
181	if (console_loglevel)
182		console_loglevel = 15;
183}
184
185extern void bust_spinlocks(int yes);
186extern int oops_in_progress;		/* If set, an oops, panic(), BUG() or die() is in progress */
187extern int panic_timeout;
188extern int panic_on_oops;
189extern int tainted;
190extern const char *print_tainted(void);
191extern void add_taint(unsigned);
192
193/* Values used for system_state */
194extern enum system_states {
195	SYSTEM_BOOTING,
196	SYSTEM_RUNNING,
197	SYSTEM_HALT,
198	SYSTEM_POWER_OFF,
199	SYSTEM_RESTART,
200	SYSTEM_SUSPEND_DISK,
201} system_state;
202
203#define TAINT_PROPRIETARY_MODULE	(1<<0)
204#define TAINT_FORCED_MODULE		(1<<1)
205#define TAINT_UNSAFE_SMP		(1<<2)
206#define TAINT_FORCED_RMMOD		(1<<3)
207#define TAINT_MACHINE_CHECK		(1<<4)
208#define TAINT_BAD_PAGE			(1<<5)
209
210extern void dump_stack(void);
211
212#ifdef DEBUG
213/* If you are writing a driver, please use dev_dbg instead */
214#define pr_debug(fmt,arg...) \
215	printk(KERN_DEBUG fmt,##arg)
216#else
217#define pr_debug(fmt,arg...) \
218	do { } while (0)
219#endif
220
221#define pr_info(fmt,arg...) \
222	printk(KERN_INFO fmt,##arg)
223
224/*
225 *      Display an IP address in readable format.
226 */
227
228#define NIPQUAD(addr) \
229	((unsigned char *)&addr)[0], \
230	((unsigned char *)&addr)[1], \
231	((unsigned char *)&addr)[2], \
232	((unsigned char *)&addr)[3]
233#define NIPQUAD_FMT "%u.%u.%u.%u"
234
235#define NIP6(addr) \
236	ntohs((addr).s6_addr16[0]), \
237	ntohs((addr).s6_addr16[1]), \
238	ntohs((addr).s6_addr16[2]), \
239	ntohs((addr).s6_addr16[3]), \
240	ntohs((addr).s6_addr16[4]), \
241	ntohs((addr).s6_addr16[5]), \
242	ntohs((addr).s6_addr16[6]), \
243	ntohs((addr).s6_addr16[7])
244#define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
245#define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
246
247#if defined(__LITTLE_ENDIAN)
248#define HIPQUAD(addr) \
249	((unsigned char *)&addr)[3], \
250	((unsigned char *)&addr)[2], \
251	((unsigned char *)&addr)[1], \
252	((unsigned char *)&addr)[0]
253#elif defined(__BIG_ENDIAN)
254#define HIPQUAD	NIPQUAD
255#else
256#error "Please fix asm/byteorder.h"
257#endif /* __LITTLE_ENDIAN */
258
259/*
260 * min()/max() macros that also do
261 * strict type-checking.. See the
262 * "unnecessary" pointer comparison.
263 */
264#define min(x,y) ({ \
265	typeof(x) _x = (x);	\
266	typeof(y) _y = (y);	\
267	(void) (&_x == &_y);		\
268	_x < _y ? _x : _y; })
269
270#define max(x,y) ({ \
271	typeof(x) _x = (x);	\
272	typeof(y) _y = (y);	\
273	(void) (&_x == &_y);		\
274	_x > _y ? _x : _y; })
275
276/*
277 * ..and if you can't take the strict
278 * types, you can specify one yourself.
279 *
280 * Or not use min/max at all, of course.
281 */
282#define min_t(type,x,y) \
283	({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
284#define max_t(type,x,y) \
285	({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
286
287
288/**
289 * container_of - cast a member of a structure out to the containing structure
290 * @ptr:	the pointer to the member.
291 * @type:	the type of the container struct this is embedded in.
292 * @member:	the name of the member within the struct.
293 *
294 */
295#define container_of(ptr, type, member) ({			\
296        const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
297        (type *)( (char *)__mptr - offsetof(type,member) );})
298
299/*
300 * Check at compile time that something is of a particular type.
301 * Always evaluates to 1 so you may use it easily in comparisons.
302 */
303#define typecheck(type,x) \
304({	type __dummy; \
305	typeof(x) __dummy2; \
306	(void)(&__dummy == &__dummy2); \
307	1; \
308})
309
310/*
311 * Check at compile time that 'function' is a certain type, or is a pointer
312 * to that type (needs to use typedef for the function type.)
313 */
314#define typecheck_fn(type,function) \
315({	typeof(type) __tmp = function; \
316	(void)__tmp; \
317})
318
319#endif /* __KERNEL__ */
320
321#define SI_LOAD_SHIFT	16
322struct sysinfo {
323	long uptime;			/* Seconds since boot */
324	unsigned long loads[3];		/* 1, 5, and 15 minute load averages */
325	unsigned long totalram;		/* Total usable main memory size */
326	unsigned long freeram;		/* Available memory size */
327	unsigned long sharedram;	/* Amount of shared memory */
328	unsigned long bufferram;	/* Memory used by buffers */
329	unsigned long totalswap;	/* Total swap space size */
330	unsigned long freeswap;		/* swap space still available */
331	unsigned short procs;		/* Number of current processes */
332	unsigned short pad;		/* explicit padding for m68k */
333	unsigned long totalhigh;	/* Total high memory size */
334	unsigned long freehigh;		/* Available high memory size */
335	unsigned int mem_unit;		/* Memory unit size in bytes */
336	char _f[20-2*sizeof(long)-sizeof(int)];	/* Padding: libc5 uses this.. */
337};
338
339/* Force a compilation error if condition is true */
340#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
341
342/* Force a compilation error if condition is true, but also produce a
343   result (of value 0 and type size_t), so the expression can be used
344   e.g. in a structure initializer (or where-ever else comma expressions
345   aren't permitted). */
346#define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
347
348/* Trap pasters of __FUNCTION__ at compile-time */
349#define __FUNCTION__ (__func__)
350
351#endif
352