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