Merge branch 'master'
[linux-2.6.git] / include / linux / kernel.h
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
19 extern 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))
32 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
33
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
43 extern 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
50 struct completion;
51 struct pt_regs;
52 struct user;
53
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  */
64 #ifdef CONFIG_PREEMPT_VOLUNTARY
65 extern int cond_resched(void);
66 # define might_resched() cond_resched()
67 #else
68 # define might_resched() do { } while (0)
69 #endif
70
71 #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
81 #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
91 extern struct atomic_notifier_head panic_notifier_list;
92 extern long (*panic_blink)(long time);
93 NORET_TYPE void panic(const char * fmt, ...)
94         __attribute__ ((NORET_AND format (printf, 1, 2)));
95 extern void oops_enter(void);
96 extern void oops_exit(void);
97 extern int oops_may_print(void);
98 fastcall NORET_TYPE void do_exit(long error_code)
99         ATTRIB_NORET;
100 NORET_TYPE void complete_and_exit(struct completion *, long)
101         ATTRIB_NORET;
102 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
103 extern long simple_strtol(const char *,char **,unsigned int);
104 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
105 extern long long simple_strtoll(const char *,char **,unsigned int);
106 extern int sprintf(char * buf, const char * fmt, ...)
107         __attribute__ ((format (printf, 2, 3)));
108 extern int vsprintf(char *buf, const char *, va_list)
109         __attribute__ ((format (printf, 2, 0)));
110 extern int snprintf(char * buf, size_t size, const char * fmt, ...)
111         __attribute__ ((format (printf, 3, 4)));
112 extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
113         __attribute__ ((format (printf, 3, 0)));
114 extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
115         __attribute__ ((format (printf, 3, 4)));
116 extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
117         __attribute__ ((format (printf, 3, 0)));
118
119 extern int sscanf(const char *, const char *, ...)
120         __attribute__ ((format (scanf, 2, 3)));
121 extern int vsscanf(const char *, const char *, va_list)
122         __attribute__ ((format (scanf, 2, 0)));
123
124 extern int get_option(char **str, int *pint);
125 extern char *get_options(const char *str, int nints, int *ints);
126 extern unsigned long long memparse(char *ptr, char **retptr);
127
128 extern int __kernel_text_address(unsigned long addr);
129 extern int kernel_text_address(unsigned long addr);
130 extern int session_of_pgrp(int pgrp);
131
132 extern void dump_thread(struct pt_regs *regs, struct user *dump);
133
134 #ifdef CONFIG_PRINTK
135 asmlinkage int vprintk(const char *fmt, va_list args)
136         __attribute__ ((format (printf, 1, 0)));
137 asmlinkage int printk(const char * fmt, ...)
138         __attribute__ ((format (printf, 1, 2)));
139 #else
140 static inline int vprintk(const char *s, va_list args)
141         __attribute__ ((format (printf, 1, 0)));
142 static inline int vprintk(const char *s, va_list args) { return 0; }
143 static inline int printk(const char *s, ...)
144         __attribute__ ((format (printf, 1, 2)));
145 static inline int printk(const char *s, ...) { return 0; }
146 #endif
147
148 unsigned long int_sqrt(unsigned long);
149
150 static inline int __attribute_pure__ long_log2(unsigned long x)
151 {
152         int r = 0;
153         for (x >>= 1; x > 0; x >>= 1)
154                 r++;
155         return r;
156 }
157
158 static inline unsigned long
159 __attribute_const__ roundup_pow_of_two(unsigned long x)
160 {
161         return 1UL << fls_long(x - 1);
162 }
163
164 extern int printk_ratelimit(void);
165 extern int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst);
166
167 static inline void console_silent(void)
168 {
169         console_loglevel = 0;
170 }
171
172 static inline void console_verbose(void)
173 {
174         if (console_loglevel)
175                 console_loglevel = 15;
176 }
177
178 extern void bust_spinlocks(int yes);
179 extern int oops_in_progress;            /* If set, an oops, panic(), BUG() or die() is in progress */
180 extern __deprecated_for_modules int panic_timeout;
181 extern int panic_on_oops;
182 extern int tainted;
183 extern const char *print_tainted(void);
184 extern void add_taint(unsigned);
185
186 /* Values used for system_state */
187 extern enum system_states {
188         SYSTEM_BOOTING,
189         SYSTEM_RUNNING,
190         SYSTEM_HALT,
191         SYSTEM_POWER_OFF,
192         SYSTEM_RESTART,
193         SYSTEM_SUSPEND_DISK,
194 } system_state;
195
196 #define TAINT_PROPRIETARY_MODULE        (1<<0)
197 #define TAINT_FORCED_MODULE             (1<<1)
198 #define TAINT_UNSAFE_SMP                (1<<2)
199 #define TAINT_FORCED_RMMOD              (1<<3)
200 #define TAINT_MACHINE_CHECK             (1<<4)
201 #define TAINT_BAD_PAGE                  (1<<5)
202
203 extern void dump_stack(void);
204
205 #ifdef DEBUG
206 #define pr_debug(fmt,arg...) \
207         printk(KERN_DEBUG fmt,##arg)
208 #else
209 #define pr_debug(fmt,arg...) \
210         do { } while (0)
211 #endif
212
213 #define pr_info(fmt,arg...) \
214         printk(KERN_INFO fmt,##arg)
215
216 /*
217  *      Display an IP address in readable format.
218  */
219
220 #define NIPQUAD(addr) \
221         ((unsigned char *)&addr)[0], \
222         ((unsigned char *)&addr)[1], \
223         ((unsigned char *)&addr)[2], \
224         ((unsigned char *)&addr)[3]
225 #define NIPQUAD_FMT "%u.%u.%u.%u"
226
227 #define NIP6(addr) \
228         ntohs((addr).s6_addr16[0]), \
229         ntohs((addr).s6_addr16[1]), \
230         ntohs((addr).s6_addr16[2]), \
231         ntohs((addr).s6_addr16[3]), \
232         ntohs((addr).s6_addr16[4]), \
233         ntohs((addr).s6_addr16[5]), \
234         ntohs((addr).s6_addr16[6]), \
235         ntohs((addr).s6_addr16[7])
236 #define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
237 #define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
238
239 #if defined(__LITTLE_ENDIAN)
240 #define HIPQUAD(addr) \
241         ((unsigned char *)&addr)[3], \
242         ((unsigned char *)&addr)[2], \
243         ((unsigned char *)&addr)[1], \
244         ((unsigned char *)&addr)[0]
245 #elif defined(__BIG_ENDIAN)
246 #define HIPQUAD NIPQUAD
247 #else
248 #error "Please fix asm/byteorder.h"
249 #endif /* __LITTLE_ENDIAN */
250
251 /*
252  * min()/max() macros that also do
253  * strict type-checking.. See the
254  * "unnecessary" pointer comparison.
255  */
256 #define min(x,y) ({ \
257         typeof(x) _x = (x);     \
258         typeof(y) _y = (y);     \
259         (void) (&_x == &_y);            \
260         _x < _y ? _x : _y; })
261
262 #define max(x,y) ({ \
263         typeof(x) _x = (x);     \
264         typeof(y) _y = (y);     \
265         (void) (&_x == &_y);            \
266         _x > _y ? _x : _y; })
267
268 /*
269  * ..and if you can't take the strict
270  * types, you can specify one yourself.
271  *
272  * Or not use min/max at all, of course.
273  */
274 #define min_t(type,x,y) \
275         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
276 #define max_t(type,x,y) \
277         ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
278
279
280 /**
281  * container_of - cast a member of a structure out to the containing structure
282  * @ptr:        the pointer to the member.
283  * @type:       the type of the container struct this is embedded in.
284  * @member:     the name of the member within the struct.
285  *
286  */
287 #define container_of(ptr, type, member) ({                      \
288         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
289         (type *)( (char *)__mptr - offsetof(type,member) );})
290
291 /*
292  * Check at compile time that something is of a particular type.
293  * Always evaluates to 1 so you may use it easily in comparisons.
294  */
295 #define typecheck(type,x) \
296 ({      type __dummy; \
297         typeof(x) __dummy2; \
298         (void)(&__dummy == &__dummy2); \
299         1; \
300 })
301
302 /*
303  * Check at compile time that 'function' is a certain type, or is a pointer
304  * to that type (needs to use typedef for the function type.)
305  */
306 #define typecheck_fn(type,function) \
307 ({      typeof(type) __tmp = function; \
308         (void)__tmp; \
309 })
310
311 #endif /* __KERNEL__ */
312
313 #define SI_LOAD_SHIFT   16
314 struct sysinfo {
315         long uptime;                    /* Seconds since boot */
316         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
317         unsigned long totalram;         /* Total usable main memory size */
318         unsigned long freeram;          /* Available memory size */
319         unsigned long sharedram;        /* Amount of shared memory */
320         unsigned long bufferram;        /* Memory used by buffers */
321         unsigned long totalswap;        /* Total swap space size */
322         unsigned long freeswap;         /* swap space still available */
323         unsigned short procs;           /* Number of current processes */
324         unsigned short pad;             /* explicit padding for m68k */
325         unsigned long totalhigh;        /* Total high memory size */
326         unsigned long freehigh;         /* Available high memory size */
327         unsigned int mem_unit;          /* Memory unit size in bytes */
328         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
329 };
330
331 /* Force a compilation error if condition is true */
332 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
333
334 /* Trap pasters of __FUNCTION__ at compile-time */
335 #define __FUNCTION__ (__func__)
336
337 #endif