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