blob: f789278a625aebe881ecc37bcdf6d34889541445 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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
28#define STACK_MAGIC 0xdeadbeef
29
30#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
31#define ALIGN(x,a) (((x)+(a)-1)&~((a)-1))
Steven Whitehouse5c676f62006-02-27 17:23:27 -050032#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34#define KERN_EMERG "<0>" /* system is unusable */
35#define KERN_ALERT "<1>" /* action must be taken immediately */
36#define KERN_CRIT "<2>" /* critical conditions */
37#define KERN_ERR "<3>" /* error conditions */
38#define KERN_WARNING "<4>" /* warning conditions */
39#define KERN_NOTICE "<5>" /* normal but significant condition */
40#define KERN_INFO "<6>" /* informational */
41#define KERN_DEBUG "<7>" /* debug-level messages */
42
43extern int console_printk[];
44
45#define console_loglevel (console_printk[0])
46#define default_message_loglevel (console_printk[1])
47#define minimum_console_loglevel (console_printk[2])
48#define default_console_loglevel (console_printk[3])
49
50struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -080051struct pt_regs;
52struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54/**
55 * might_sleep - annotation for functions that can sleep
56 *
57 * this macro will print a stack trace if it is executed in an atomic
58 * context (spinlock, irq-handler, ...).
59 *
60 * This is a useful debugging help to be able to catch problems early and not
61 * be biten later when the calling function happens to sleep when it is not
62 * supposed to.
63 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -070064#ifdef CONFIG_PREEMPT_VOLUNTARY
65extern int cond_resched(void);
66# define might_resched() cond_resched()
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#else
Ingo Molnarf8cbd992005-06-25 14:57:39 -070068# define might_resched() do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#endif
70
Ingo Molnarf8cbd992005-06-25 14:57:39 -070071#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
72 void __might_sleep(char *file, int line);
73# define might_sleep() \
74 do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
75#else
76# define might_sleep() do { might_resched(); } while (0)
77#endif
78
79#define might_sleep_if(cond) do { if (unlikely(cond)) might_sleep(); } while (0)
80
Linus Torvalds1da177e2005-04-16 15:20:36 -070081#define abs(x) ({ \
82 int __x = (x); \
83 (__x < 0) ? -__x : __x; \
84 })
85
86#define labs(x) ({ \
87 long __x = (x); \
88 (__x < 0) ? -__x : __x; \
89 })
90
91extern struct notifier_block *panic_notifier_list;
92extern long (*panic_blink)(long time);
93NORET_TYPE void panic(const char * fmt, ...)
94 __attribute__ ((NORET_AND format (printf, 1, 2)));
95fastcall NORET_TYPE void do_exit(long error_code)
96 ATTRIB_NORET;
97NORET_TYPE void complete_and_exit(struct completion *, long)
98 ATTRIB_NORET;
99extern unsigned long simple_strtoul(const char *,char **,unsigned int);
100extern long simple_strtol(const char *,char **,unsigned int);
101extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
102extern long long simple_strtoll(const char *,char **,unsigned int);
103extern int sprintf(char * buf, const char * fmt, ...)
104 __attribute__ ((format (printf, 2, 3)));
105extern int vsprintf(char *buf, const char *, va_list)
106 __attribute__ ((format (printf, 2, 0)));
107extern int snprintf(char * buf, size_t size, const char * fmt, ...)
108 __attribute__ ((format (printf, 3, 4)));
109extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
110 __attribute__ ((format (printf, 3, 0)));
111extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
112 __attribute__ ((format (printf, 3, 4)));
113extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
114 __attribute__ ((format (printf, 3, 0)));
115
116extern int sscanf(const char *, const char *, ...)
117 __attribute__ ((format (scanf, 2, 3)));
118extern int vsscanf(const char *, const char *, va_list)
119 __attribute__ ((format (scanf, 2, 0)));
120
121extern int get_option(char **str, int *pint);
122extern char *get_options(const char *str, int nints, int *ints);
123extern unsigned long long memparse(char *ptr, char **retptr);
124
125extern int __kernel_text_address(unsigned long addr);
126extern int kernel_text_address(unsigned long addr);
127extern int session_of_pgrp(int pgrp);
128
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800129extern void dump_thread(struct pt_regs *regs, struct user *dump);
130
Matt Mackalld59745c2005-05-01 08:59:02 -0700131#ifdef CONFIG_PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132asmlinkage int vprintk(const char *fmt, va_list args)
133 __attribute__ ((format (printf, 1, 0)));
134asmlinkage int printk(const char * fmt, ...)
135 __attribute__ ((format (printf, 1, 2)));
Matt Mackalld59745c2005-05-01 08:59:02 -0700136#else
137static inline int vprintk(const char *s, va_list args)
138 __attribute__ ((format (printf, 1, 0)));
139static inline int vprintk(const char *s, va_list args) { return 0; }
140static inline int printk(const char *s, ...)
141 __attribute__ ((format (printf, 1, 2)));
142static inline int printk(const char *s, ...) { return 0; }
143#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145unsigned long int_sqrt(unsigned long);
146
147static inline int __attribute_pure__ long_log2(unsigned long x)
148{
149 int r = 0;
150 for (x >>= 1; x > 0; x >>= 1)
151 r++;
152 return r;
153}
154
155static inline unsigned long __attribute_const__ roundup_pow_of_two(unsigned long x)
156{
157 return (1UL << fls(x - 1));
158}
159
160extern int printk_ratelimit(void);
161extern int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst);
162
163static inline void console_silent(void)
164{
165 console_loglevel = 0;
166}
167
168static inline void console_verbose(void)
169{
170 if (console_loglevel)
171 console_loglevel = 15;
172}
173
174extern void bust_spinlocks(int yes);
175extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkdfed0442005-11-07 01:01:44 -0800176extern __deprecated_for_modules int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177extern int panic_on_oops;
178extern int tainted;
179extern const char *print_tainted(void);
180extern void add_taint(unsigned);
181
182/* Values used for system_state */
183extern enum system_states {
184 SYSTEM_BOOTING,
185 SYSTEM_RUNNING,
186 SYSTEM_HALT,
187 SYSTEM_POWER_OFF,
188 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500189 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190} system_state;
191
192#define TAINT_PROPRIETARY_MODULE (1<<0)
193#define TAINT_FORCED_MODULE (1<<1)
194#define TAINT_UNSAFE_SMP (1<<2)
195#define TAINT_FORCED_RMMOD (1<<3)
196#define TAINT_MACHINE_CHECK (1<<4)
197#define TAINT_BAD_PAGE (1<<5)
198
199extern void dump_stack(void);
200
201#ifdef DEBUG
202#define pr_debug(fmt,arg...) \
203 printk(KERN_DEBUG fmt,##arg)
204#else
205#define pr_debug(fmt,arg...) \
206 do { } while (0)
207#endif
208
209#define pr_info(fmt,arg...) \
210 printk(KERN_INFO fmt,##arg)
211
212/*
213 * Display an IP address in readable format.
214 */
215
216#define NIPQUAD(addr) \
217 ((unsigned char *)&addr)[0], \
218 ((unsigned char *)&addr)[1], \
219 ((unsigned char *)&addr)[2], \
220 ((unsigned char *)&addr)[3]
Joe Perches46b86a22006-01-13 14:29:07 -0800221#define NIPQUAD_FMT "%u.%u.%u.%u"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223#define NIP6(addr) \
224 ntohs((addr).s6_addr16[0]), \
225 ntohs((addr).s6_addr16[1]), \
226 ntohs((addr).s6_addr16[2]), \
227 ntohs((addr).s6_addr16[3]), \
228 ntohs((addr).s6_addr16[4]), \
229 ntohs((addr).s6_addr16[5]), \
230 ntohs((addr).s6_addr16[6]), \
231 ntohs((addr).s6_addr16[7])
Joe Perches46b86a22006-01-13 14:29:07 -0800232#define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
YOSHIFUJI Hideaki9343e792006-01-17 02:10:53 -0800233#define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235#if defined(__LITTLE_ENDIAN)
236#define HIPQUAD(addr) \
237 ((unsigned char *)&addr)[3], \
238 ((unsigned char *)&addr)[2], \
239 ((unsigned char *)&addr)[1], \
240 ((unsigned char *)&addr)[0]
241#elif defined(__BIG_ENDIAN)
242#define HIPQUAD NIPQUAD
243#else
244#error "Please fix asm/byteorder.h"
245#endif /* __LITTLE_ENDIAN */
246
247/*
248 * min()/max() macros that also do
249 * strict type-checking.. See the
250 * "unnecessary" pointer comparison.
251 */
252#define min(x,y) ({ \
253 typeof(x) _x = (x); \
254 typeof(y) _y = (y); \
255 (void) (&_x == &_y); \
256 _x < _y ? _x : _y; })
257
258#define max(x,y) ({ \
259 typeof(x) _x = (x); \
260 typeof(y) _y = (y); \
261 (void) (&_x == &_y); \
262 _x > _y ? _x : _y; })
263
264/*
265 * ..and if you can't take the strict
266 * types, you can specify one yourself.
267 *
268 * Or not use min/max at all, of course.
269 */
270#define min_t(type,x,y) \
271 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
272#define max_t(type,x,y) \
273 ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
274
275
276/**
277 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 * @ptr: the pointer to the member.
279 * @type: the type of the container struct this is embedded in.
280 * @member: the name of the member within the struct.
281 *
282 */
283#define container_of(ptr, type, member) ({ \
284 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
285 (type *)( (char *)__mptr - offsetof(type,member) );})
286
287/*
288 * Check at compile time that something is of a particular type.
289 * Always evaluates to 1 so you may use it easily in comparisons.
290 */
291#define typecheck(type,x) \
292({ type __dummy; \
293 typeof(x) __dummy2; \
294 (void)(&__dummy == &__dummy2); \
295 1; \
296})
297
Chuck Ebbert711a6602006-01-09 15:59:17 -0800298/*
299 * Check at compile time that 'function' is a certain type, or is a pointer
300 * to that type (needs to use typedef for the function type.)
301 */
302#define typecheck_fn(type,function) \
303({ typeof(type) __tmp = function; \
304 (void)__tmp; \
305})
306
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307#endif /* __KERNEL__ */
308
309#define SI_LOAD_SHIFT 16
310struct sysinfo {
311 long uptime; /* Seconds since boot */
312 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
313 unsigned long totalram; /* Total usable main memory size */
314 unsigned long freeram; /* Available memory size */
315 unsigned long sharedram; /* Amount of shared memory */
316 unsigned long bufferram; /* Memory used by buffers */
317 unsigned long totalswap; /* Total swap space size */
318 unsigned long freeswap; /* swap space still available */
319 unsigned short procs; /* Number of current processes */
320 unsigned short pad; /* explicit padding for m68k */
321 unsigned long totalhigh; /* Total high memory size */
322 unsigned long freehigh; /* Available high memory size */
323 unsigned int mem_unit; /* Memory unit size in bytes */
324 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
325};
326
Nikita Danilovc0398ee2005-10-30 15:03:10 -0800327/* Force a compilation error if condition is true */
Andi Kleen921717a2005-09-13 01:25:13 -0700328#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330/* Trap pasters of __FUNCTION__ at compile-time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331#define __FUNCTION__ (__func__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332
333#endif