blob: 5c1ec1f84eab93eea32a8d173486ff2cbcd5036b [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)
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -070027#define LLONG_MAX ((long long)(~0ULL>>1))
28#define LLONG_MIN (-LLONG_MAX - 1)
29#define ULLONG_MAX (~0ULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
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))
Jan Beulich4552d5d2006-06-26 13:57:28 +020035#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37#define KERN_EMERG "<0>" /* system is unusable */
38#define KERN_ALERT "<1>" /* action must be taken immediately */
39#define KERN_CRIT "<2>" /* critical conditions */
40#define KERN_ERR "<3>" /* error conditions */
41#define KERN_WARNING "<4>" /* warning conditions */
42#define KERN_NOTICE "<5>" /* normal but significant condition */
43#define KERN_INFO "<6>" /* informational */
44#define KERN_DEBUG "<7>" /* debug-level messages */
45
46extern int console_printk[];
47
48#define console_loglevel (console_printk[0])
49#define default_message_loglevel (console_printk[1])
50#define minimum_console_loglevel (console_printk[2])
51#define default_console_loglevel (console_printk[3])
52
53struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -080054struct pt_regs;
55struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57/**
58 * might_sleep - annotation for functions that can sleep
59 *
60 * this macro will print a stack trace if it is executed in an atomic
61 * context (spinlock, irq-handler, ...).
62 *
63 * This is a useful debugging help to be able to catch problems early and not
64 * be biten later when the calling function happens to sleep when it is not
65 * supposed to.
66 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -070067#ifdef CONFIG_PREEMPT_VOLUNTARY
68extern int cond_resched(void);
69# define might_resched() cond_resched()
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#else
Ingo Molnarf8cbd992005-06-25 14:57:39 -070071# define might_resched() do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070072#endif
73
Ingo Molnarf8cbd992005-06-25 14:57:39 -070074#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
75 void __might_sleep(char *file, int line);
76# define might_sleep() \
77 do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
78#else
79# define might_sleep() do { might_resched(); } while (0)
80#endif
81
Hua Zhong368a5fa2006-06-23 02:05:42 -070082#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -070083
Linus Torvalds1da177e2005-04-16 15:20:36 -070084#define abs(x) ({ \
85 int __x = (x); \
86 (__x < 0) ? -__x : __x; \
87 })
88
89#define labs(x) ({ \
90 long __x = (x); \
91 (__x < 0) ? -__x : __x; \
92 })
93
Alan Sterne041c682006-03-27 01:16:30 -080094extern struct atomic_notifier_head panic_notifier_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095extern long (*panic_blink)(long time);
96NORET_TYPE void panic(const char * fmt, ...)
97 __attribute__ ((NORET_AND format (printf, 1, 2)));
Andrew Mortondd287792006-03-23 03:00:57 -080098extern void oops_enter(void);
99extern void oops_exit(void);
100extern int oops_may_print(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101fastcall NORET_TYPE void do_exit(long error_code)
102 ATTRIB_NORET;
103NORET_TYPE void complete_and_exit(struct completion *, long)
104 ATTRIB_NORET;
105extern unsigned long simple_strtoul(const char *,char **,unsigned int);
106extern long simple_strtol(const char *,char **,unsigned int);
107extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
108extern long long simple_strtoll(const char *,char **,unsigned int);
109extern int sprintf(char * buf, const char * fmt, ...)
110 __attribute__ ((format (printf, 2, 3)));
111extern int vsprintf(char *buf, const char *, va_list)
112 __attribute__ ((format (printf, 2, 0)));
113extern int snprintf(char * buf, size_t size, const char * fmt, ...)
114 __attribute__ ((format (printf, 3, 4)));
115extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
116 __attribute__ ((format (printf, 3, 0)));
117extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
118 __attribute__ ((format (printf, 3, 4)));
119extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
120 __attribute__ ((format (printf, 3, 0)));
Jeremy Fitzhardingee9059142006-06-25 05:49:17 -0700121extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
122 __attribute__ ((format (printf, 2, 3)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
124extern int sscanf(const char *, const char *, ...)
125 __attribute__ ((format (scanf, 2, 3)));
126extern int vsscanf(const char *, const char *, va_list)
127 __attribute__ ((format (scanf, 2, 0)));
128
129extern int get_option(char **str, int *pint);
130extern char *get_options(const char *str, int nints, int *ints);
131extern unsigned long long memparse(char *ptr, char **retptr);
132
Trent Piepho5e376612006-05-15 09:44:06 -0700133extern int core_kernel_text(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134extern int __kernel_text_address(unsigned long addr);
135extern int kernel_text_address(unsigned long addr);
136extern int session_of_pgrp(int pgrp);
137
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800138extern void dump_thread(struct pt_regs *regs, struct user *dump);
139
Matt Mackalld59745c2005-05-01 08:59:02 -0700140#ifdef CONFIG_PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141asmlinkage int vprintk(const char *fmt, va_list args)
142 __attribute__ ((format (printf, 1, 0)));
143asmlinkage int printk(const char * fmt, ...)
144 __attribute__ ((format (printf, 1, 2)));
Matt Mackalld59745c2005-05-01 08:59:02 -0700145#else
146static inline int vprintk(const char *s, va_list args)
147 __attribute__ ((format (printf, 1, 0)));
148static inline int vprintk(const char *s, va_list args) { return 0; }
149static inline int printk(const char *s, ...)
150 __attribute__ ((format (printf, 1, 2)));
151static inline int printk(const char *s, ...) { return 0; }
152#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
154unsigned long int_sqrt(unsigned long);
155
156static inline int __attribute_pure__ long_log2(unsigned long x)
157{
158 int r = 0;
159 for (x >>= 1; x > 0; x >>= 1)
160 r++;
161 return r;
162}
163
Andrew Morton962749a2006-03-25 03:08:01 -0800164static inline unsigned long
165__attribute_const__ roundup_pow_of_two(unsigned long x)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166{
Andrew Morton962749a2006-03-25 03:08:01 -0800167 return 1UL << fls_long(x - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168}
169
170extern int printk_ratelimit(void);
171extern int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst);
172
173static inline void console_silent(void)
174{
175 console_loglevel = 0;
176}
177
178static inline void console_verbose(void)
179{
180 if (console_loglevel)
181 console_loglevel = 15;
182}
183
184extern void bust_spinlocks(int yes);
185extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700186extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187extern int panic_on_oops;
188extern int tainted;
189extern const char *print_tainted(void);
190extern void add_taint(unsigned);
191
192/* Values used for system_state */
193extern enum system_states {
194 SYSTEM_BOOTING,
195 SYSTEM_RUNNING,
196 SYSTEM_HALT,
197 SYSTEM_POWER_OFF,
198 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500199 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200} system_state;
201
202#define TAINT_PROPRIETARY_MODULE (1<<0)
203#define TAINT_FORCED_MODULE (1<<1)
204#define TAINT_UNSAFE_SMP (1<<2)
205#define TAINT_FORCED_RMMOD (1<<3)
206#define TAINT_MACHINE_CHECK (1<<4)
207#define TAINT_BAD_PAGE (1<<5)
208
209extern void dump_stack(void);
210
211#ifdef DEBUG
212#define pr_debug(fmt,arg...) \
213 printk(KERN_DEBUG fmt,##arg)
214#else
215#define pr_debug(fmt,arg...) \
216 do { } while (0)
217#endif
218
219#define pr_info(fmt,arg...) \
220 printk(KERN_INFO fmt,##arg)
221
222/*
223 * Display an IP address in readable format.
224 */
225
226#define NIPQUAD(addr) \
227 ((unsigned char *)&addr)[0], \
228 ((unsigned char *)&addr)[1], \
229 ((unsigned char *)&addr)[2], \
230 ((unsigned char *)&addr)[3]
Joe Perches46b86a22006-01-13 14:29:07 -0800231#define NIPQUAD_FMT "%u.%u.%u.%u"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
233#define NIP6(addr) \
234 ntohs((addr).s6_addr16[0]), \
235 ntohs((addr).s6_addr16[1]), \
236 ntohs((addr).s6_addr16[2]), \
237 ntohs((addr).s6_addr16[3]), \
238 ntohs((addr).s6_addr16[4]), \
239 ntohs((addr).s6_addr16[5]), \
240 ntohs((addr).s6_addr16[6]), \
241 ntohs((addr).s6_addr16[7])
Joe Perches46b86a22006-01-13 14:29:07 -0800242#define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
YOSHIFUJI Hideaki9343e792006-01-17 02:10:53 -0800243#define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
245#if defined(__LITTLE_ENDIAN)
246#define HIPQUAD(addr) \
247 ((unsigned char *)&addr)[3], \
248 ((unsigned char *)&addr)[2], \
249 ((unsigned char *)&addr)[1], \
250 ((unsigned char *)&addr)[0]
251#elif defined(__BIG_ENDIAN)
252#define HIPQUAD NIPQUAD
253#else
254#error "Please fix asm/byteorder.h"
255#endif /* __LITTLE_ENDIAN */
256
257/*
258 * min()/max() macros that also do
259 * strict type-checking.. See the
260 * "unnecessary" pointer comparison.
261 */
262#define min(x,y) ({ \
263 typeof(x) _x = (x); \
264 typeof(y) _y = (y); \
265 (void) (&_x == &_y); \
266 _x < _y ? _x : _y; })
267
268#define max(x,y) ({ \
269 typeof(x) _x = (x); \
270 typeof(y) _y = (y); \
271 (void) (&_x == &_y); \
272 _x > _y ? _x : _y; })
273
274/*
275 * ..and if you can't take the strict
276 * types, you can specify one yourself.
277 *
278 * Or not use min/max at all, of course.
279 */
280#define min_t(type,x,y) \
281 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
282#define max_t(type,x,y) \
283 ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
284
285
286/**
287 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 * @ptr: the pointer to the member.
289 * @type: the type of the container struct this is embedded in.
290 * @member: the name of the member within the struct.
291 *
292 */
293#define container_of(ptr, type, member) ({ \
294 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
295 (type *)( (char *)__mptr - offsetof(type,member) );})
296
297/*
298 * Check at compile time that something is of a particular type.
299 * Always evaluates to 1 so you may use it easily in comparisons.
300 */
301#define typecheck(type,x) \
302({ type __dummy; \
303 typeof(x) __dummy2; \
304 (void)(&__dummy == &__dummy2); \
305 1; \
306})
307
Chuck Ebbert711a6602006-01-09 15:59:17 -0800308/*
309 * Check at compile time that 'function' is a certain type, or is a pointer
310 * to that type (needs to use typedef for the function type.)
311 */
312#define typecheck_fn(type,function) \
313({ typeof(type) __tmp = function; \
314 (void)__tmp; \
315})
316
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317#endif /* __KERNEL__ */
318
319#define SI_LOAD_SHIFT 16
320struct sysinfo {
321 long uptime; /* Seconds since boot */
322 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
323 unsigned long totalram; /* Total usable main memory size */
324 unsigned long freeram; /* Available memory size */
325 unsigned long sharedram; /* Amount of shared memory */
326 unsigned long bufferram; /* Memory used by buffers */
327 unsigned long totalswap; /* Total swap space size */
328 unsigned long freeswap; /* swap space still available */
329 unsigned short procs; /* Number of current processes */
330 unsigned short pad; /* explicit padding for m68k */
331 unsigned long totalhigh; /* Total high memory size */
332 unsigned long freehigh; /* Available high memory size */
333 unsigned int mem_unit; /* Memory unit size in bytes */
334 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
335};
336
Nikita Danilovc0398ee2005-10-30 15:03:10 -0800337/* Force a compilation error if condition is true */
Andi Kleen921717a2005-09-13 01:25:13 -0700338#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Jan Beulich4552d5d2006-06-26 13:57:28 +0200340/* Force a compilation error if condition is true, but also produce a
341 result (of value 0 and type size_t), so the expression can be used
342 e.g. in a structure initializer (or where-ever else comma expressions
343 aren't permitted). */
344#define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
345
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346/* Trap pasters of __FUNCTION__ at compile-time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347#define __FUNCTION__ (__func__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349#endif