Merge git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/driver-core-2.6
[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 <linux/log2.h>
17 #include <linux/typecheck.h>
18 #include <linux/ratelimit.h>
19 #include <linux/dynamic_printk.h>
20 #include <asm/byteorder.h>
21 #include <asm/bug.h>
22
23 extern const char linux_banner[];
24 extern const char linux_proc_banner[];
25
26 #define USHORT_MAX      ((u16)(~0U))
27 #define SHORT_MAX       ((s16)(USHORT_MAX>>1))
28 #define SHORT_MIN       (-SHORT_MAX - 1)
29 #define INT_MAX         ((int)(~0U>>1))
30 #define INT_MIN         (-INT_MAX - 1)
31 #define UINT_MAX        (~0U)
32 #define LONG_MAX        ((long)(~0UL>>1))
33 #define LONG_MIN        (-LONG_MAX - 1)
34 #define ULONG_MAX       (~0UL)
35 #define LLONG_MAX       ((long long)(~0ULL>>1))
36 #define LLONG_MIN       (-LLONG_MAX - 1)
37 #define ULLONG_MAX      (~0ULL)
38
39 #define STACK_MAGIC     0xdeadbeef
40
41 #define ALIGN(x,a)              __ALIGN_MASK(x,(typeof(x))(a)-1)
42 #define __ALIGN_MASK(x,mask)    (((x)+(mask))&~(mask))
43 #define PTR_ALIGN(p, a)         ((typeof(p))ALIGN((unsigned long)(p), (a)))
44 #define IS_ALIGNED(x, a)                (((x) & ((typeof(x))(a) - 1)) == 0)
45
46 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
47
48 #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
49 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
50 #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
51
52 #define _RET_IP_                (unsigned long)__builtin_return_address(0)
53 #define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })
54
55 #ifdef CONFIG_LBD
56 # include <asm/div64.h>
57 # define sector_div(a, b) do_div(a, b)
58 #else
59 # define sector_div(n, b)( \
60 { \
61         int _res; \
62         _res = (n) % (b); \
63         (n) /= (b); \
64         _res; \
65 } \
66 )
67 #endif
68
69 /**
70  * upper_32_bits - return bits 32-63 of a number
71  * @n: the number we're accessing
72  *
73  * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
74  * the "right shift count >= width of type" warning when that quantity is
75  * 32-bits.
76  */
77 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
78
79 /**
80  * lower_32_bits - return bits 0-31 of a number
81  * @n: the number we're accessing
82  */
83 #define lower_32_bits(n) ((u32)(n))
84
85 #define KERN_EMERG      "<0>"   /* system is unusable                   */
86 #define KERN_ALERT      "<1>"   /* action must be taken immediately     */
87 #define KERN_CRIT       "<2>"   /* critical conditions                  */
88 #define KERN_ERR        "<3>"   /* error conditions                     */
89 #define KERN_WARNING    "<4>"   /* warning conditions                   */
90 #define KERN_NOTICE     "<5>"   /* normal but significant condition     */
91 #define KERN_INFO       "<6>"   /* informational                        */
92 #define KERN_DEBUG      "<7>"   /* debug-level messages                 */
93
94 /*
95  * Annotation for a "continued" line of log printout (only done after a
96  * line that had no enclosing \n). Only to be used by core/arch code
97  * during early bootup (a continued line is not SMP-safe otherwise).
98  */
99 #define KERN_CONT       ""
100
101 extern int console_printk[];
102
103 #define console_loglevel (console_printk[0])
104 #define default_message_loglevel (console_printk[1])
105 #define minimum_console_loglevel (console_printk[2])
106 #define default_console_loglevel (console_printk[3])
107
108 struct completion;
109 struct pt_regs;
110 struct user;
111
112 #ifdef CONFIG_PREEMPT_VOLUNTARY
113 extern int _cond_resched(void);
114 # define might_resched() _cond_resched()
115 #else
116 # define might_resched() do { } while (0)
117 #endif
118
119 /**
120  * might_sleep - annotation for functions that can sleep
121  *
122  * this macro will print a stack trace if it is executed in an atomic
123  * context (spinlock, irq-handler, ...).
124  *
125  * This is a useful debugging help to be able to catch problems early and not
126  * be bitten later when the calling function happens to sleep when it is not
127  * supposed to.
128  */
129 #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
130   void __might_sleep(char *file, int line);
131 # define might_sleep() \
132         do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
133 #else
134 # define might_sleep() do { might_resched(); } while (0)
135 #endif
136
137 #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
138
139 #define abs(x) ({                               \
140                 int __x = (x);                  \
141                 (__x < 0) ? -__x : __x;         \
142         })
143
144 extern struct atomic_notifier_head panic_notifier_list;
145 extern long (*panic_blink)(long time);
146 NORET_TYPE void panic(const char * fmt, ...)
147         __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
148 extern void oops_enter(void);
149 extern void oops_exit(void);
150 extern int oops_may_print(void);
151 NORET_TYPE void do_exit(long error_code)
152         ATTRIB_NORET;
153 NORET_TYPE void complete_and_exit(struct completion *, long)
154         ATTRIB_NORET;
155 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
156 extern long simple_strtol(const char *,char **,unsigned int);
157 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
158 extern long long simple_strtoll(const char *,char **,unsigned int);
159 extern int strict_strtoul(const char *, unsigned int, unsigned long *);
160 extern int strict_strtol(const char *, unsigned int, long *);
161 extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
162 extern int strict_strtoll(const char *, unsigned int, long long *);
163 extern int sprintf(char * buf, const char * fmt, ...)
164         __attribute__ ((format (printf, 2, 3)));
165 extern int vsprintf(char *buf, const char *, va_list)
166         __attribute__ ((format (printf, 2, 0)));
167 extern int snprintf(char * buf, size_t size, const char * fmt, ...)
168         __attribute__ ((format (printf, 3, 4)));
169 extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
170         __attribute__ ((format (printf, 3, 0)));
171 extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
172         __attribute__ ((format (printf, 3, 4)));
173 extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
174         __attribute__ ((format (printf, 3, 0)));
175 extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
176         __attribute__ ((format (printf, 2, 3)));
177 extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
178
179 extern int sscanf(const char *, const char *, ...)
180         __attribute__ ((format (scanf, 2, 3)));
181 extern int vsscanf(const char *, const char *, va_list)
182         __attribute__ ((format (scanf, 2, 0)));
183
184 extern int get_option(char **str, int *pint);
185 extern char *get_options(const char *str, int nints, int *ints);
186 extern unsigned long long memparse(const char *ptr, char **retptr);
187
188 extern int core_kernel_text(unsigned long addr);
189 extern int __kernel_text_address(unsigned long addr);
190 extern int kernel_text_address(unsigned long addr);
191 struct pid;
192 extern struct pid *session_of_pgrp(struct pid *pgrp);
193
194 #ifdef CONFIG_PRINTK
195 asmlinkage int vprintk(const char *fmt, va_list args)
196         __attribute__ ((format (printf, 1, 0)));
197 asmlinkage int printk(const char * fmt, ...)
198         __attribute__ ((format (printf, 1, 2))) __cold;
199
200 extern struct ratelimit_state printk_ratelimit_state;
201 extern int printk_ratelimit(void);
202 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
203                                    unsigned int interval_msec);
204 #else
205 static inline int vprintk(const char *s, va_list args)
206         __attribute__ ((format (printf, 1, 0)));
207 static inline int vprintk(const char *s, va_list args) { return 0; }
208 static inline int printk(const char *s, ...)
209         __attribute__ ((format (printf, 1, 2)));
210 static inline int __cold printk(const char *s, ...) { return 0; }
211 static inline int printk_ratelimit(void) { return 0; }
212 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
213                                           unsigned int interval_msec)   \
214                 { return false; }
215 #endif
216
217 extern void asmlinkage __attribute__((format(printf, 1, 2)))
218         early_printk(const char *fmt, ...);
219
220 unsigned long int_sqrt(unsigned long);
221
222 static inline void console_silent(void)
223 {
224         console_loglevel = 0;
225 }
226
227 static inline void console_verbose(void)
228 {
229         if (console_loglevel)
230                 console_loglevel = 15;
231 }
232
233 extern void bust_spinlocks(int yes);
234 extern void wake_up_klogd(void);
235 extern int oops_in_progress;            /* If set, an oops, panic(), BUG() or die() is in progress */
236 extern int panic_timeout;
237 extern int panic_on_oops;
238 extern int panic_on_unrecovered_nmi;
239 extern const char *print_tainted(void);
240 extern void add_taint(unsigned flag);
241 extern int test_taint(unsigned flag);
242 extern unsigned long get_taint(void);
243 extern int root_mountflags;
244
245 /* Values used for system_state */
246 extern enum system_states {
247         SYSTEM_BOOTING,
248         SYSTEM_RUNNING,
249         SYSTEM_HALT,
250         SYSTEM_POWER_OFF,
251         SYSTEM_RESTART,
252         SYSTEM_SUSPEND_DISK,
253 } system_state;
254
255 #define TAINT_PROPRIETARY_MODULE        0
256 #define TAINT_FORCED_MODULE             1
257 #define TAINT_UNSAFE_SMP                2
258 #define TAINT_FORCED_RMMOD              3
259 #define TAINT_MACHINE_CHECK             4
260 #define TAINT_BAD_PAGE                  5
261 #define TAINT_USER                      6
262 #define TAINT_DIE                       7
263 #define TAINT_OVERRIDDEN_ACPI_TABLE     8
264 #define TAINT_WARN                      9
265
266 extern void dump_stack(void) __cold;
267
268 enum {
269         DUMP_PREFIX_NONE,
270         DUMP_PREFIX_ADDRESS,
271         DUMP_PREFIX_OFFSET
272 };
273 extern void hex_dump_to_buffer(const void *buf, size_t len,
274                                 int rowsize, int groupsize,
275                                 char *linebuf, size_t linebuflen, bool ascii);
276 extern void print_hex_dump(const char *level, const char *prefix_str,
277                                 int prefix_type, int rowsize, int groupsize,
278                                 const void *buf, size_t len, bool ascii);
279 extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
280                         const void *buf, size_t len);
281
282 extern const char hex_asc[];
283 #define hex_asc_lo(x)   hex_asc[((x) & 0x0f)]
284 #define hex_asc_hi(x)   hex_asc[((x) & 0xf0) >> 4]
285
286 static inline char *pack_hex_byte(char *buf, u8 byte)
287 {
288         *buf++ = hex_asc_hi(byte);
289         *buf++ = hex_asc_lo(byte);
290         return buf;
291 }
292
293 #define pr_emerg(fmt, arg...) \
294         printk(KERN_EMERG fmt, ##arg)
295 #define pr_alert(fmt, arg...) \
296         printk(KERN_ALERT fmt, ##arg)
297 #define pr_crit(fmt, arg...) \
298         printk(KERN_CRIT fmt, ##arg)
299 #define pr_err(fmt, arg...) \
300         printk(KERN_ERR fmt, ##arg)
301 #define pr_warning(fmt, arg...) \
302         printk(KERN_WARNING fmt, ##arg)
303 #define pr_notice(fmt, arg...) \
304         printk(KERN_NOTICE fmt, ##arg)
305 #define pr_info(fmt, arg...) \
306         printk(KERN_INFO fmt, ##arg)
307
308 /* If you are writing a driver, please use dev_dbg instead */
309 #if defined(CONFIG_DYNAMIC_PRINTK_DEBUG)
310 #define pr_debug(fmt, ...) do { \
311         dynamic_pr_debug(fmt, ##__VA_ARGS__); \
312         } while (0)
313 #elif defined(DEBUG)
314 #define pr_debug(fmt, arg...) \
315         printk(KERN_DEBUG fmt, ##arg)
316 #else
317 #define pr_debug(fmt, arg...) \
318         ({ if (0) printk(KERN_DEBUG fmt, ##arg); 0; })
319 #endif
320
321 /*
322  *      Display an IP address in readable format.
323  */
324
325 #define NIPQUAD(addr) \
326         ((unsigned char *)&addr)[0], \
327         ((unsigned char *)&addr)[1], \
328         ((unsigned char *)&addr)[2], \
329         ((unsigned char *)&addr)[3]
330 #define NIPQUAD_FMT "%u.%u.%u.%u"
331
332 #define NIP6(addr) \
333         ntohs((addr).s6_addr16[0]), \
334         ntohs((addr).s6_addr16[1]), \
335         ntohs((addr).s6_addr16[2]), \
336         ntohs((addr).s6_addr16[3]), \
337         ntohs((addr).s6_addr16[4]), \
338         ntohs((addr).s6_addr16[5]), \
339         ntohs((addr).s6_addr16[6]), \
340         ntohs((addr).s6_addr16[7])
341 #define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
342 #define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
343
344 #if defined(__LITTLE_ENDIAN)
345 #define HIPQUAD(addr) \
346         ((unsigned char *)&addr)[3], \
347         ((unsigned char *)&addr)[2], \
348         ((unsigned char *)&addr)[1], \
349         ((unsigned char *)&addr)[0]
350 #elif defined(__BIG_ENDIAN)
351 #define HIPQUAD NIPQUAD
352 #else
353 #error "Please fix asm/byteorder.h"
354 #endif /* __LITTLE_ENDIAN */
355
356 /*
357  * min()/max()/clamp() macros that also do
358  * strict type-checking.. See the
359  * "unnecessary" pointer comparison.
360  */
361 #define min(x, y) ({                            \
362         typeof(x) _min1 = (x);                  \
363         typeof(y) _min2 = (y);                  \
364         (void) (&_min1 == &_min2);              \
365         _min1 < _min2 ? _min1 : _min2; })
366
367 #define max(x, y) ({                            \
368         typeof(x) _max1 = (x);                  \
369         typeof(y) _max2 = (y);                  \
370         (void) (&_max1 == &_max2);              \
371         _max1 > _max2 ? _max1 : _max2; })
372
373 /**
374  * clamp - return a value clamped to a given range with strict typechecking
375  * @val: current value
376  * @min: minimum allowable value
377  * @max: maximum allowable value
378  *
379  * This macro does strict typechecking of min/max to make sure they are of the
380  * same type as val.  See the unnecessary pointer comparisons.
381  */
382 #define clamp(val, min, max) ({                 \
383         typeof(val) __val = (val);              \
384         typeof(min) __min = (min);              \
385         typeof(max) __max = (max);              \
386         (void) (&__val == &__min);              \
387         (void) (&__val == &__max);              \
388         __val = __val < __min ? __min: __val;   \
389         __val > __max ? __max: __val; })
390
391 /*
392  * ..and if you can't take the strict
393  * types, you can specify one yourself.
394  *
395  * Or not use min/max/clamp at all, of course.
396  */
397 #define min_t(type, x, y) ({                    \
398         type __min1 = (x);                      \
399         type __min2 = (y);                      \
400         __min1 < __min2 ? __min1: __min2; })
401
402 #define max_t(type, x, y) ({                    \
403         type __max1 = (x);                      \
404         type __max2 = (y);                      \
405         __max1 > __max2 ? __max1: __max2; })
406
407 /**
408  * clamp_t - return a value clamped to a given range using a given type
409  * @type: the type of variable to use
410  * @val: current value
411  * @min: minimum allowable value
412  * @max: maximum allowable value
413  *
414  * This macro does no typechecking and uses temporary variables of type
415  * 'type' to make all the comparisons.
416  */
417 #define clamp_t(type, val, min, max) ({         \
418         type __val = (val);                     \
419         type __min = (min);                     \
420         type __max = (max);                     \
421         __val = __val < __min ? __min: __val;   \
422         __val > __max ? __max: __val; })
423
424 /**
425  * clamp_val - return a value clamped to a given range using val's type
426  * @val: current value
427  * @min: minimum allowable value
428  * @max: maximum allowable value
429  *
430  * This macro does no typechecking and uses temporary variables of whatever
431  * type the input argument 'val' is.  This is useful when val is an unsigned
432  * type and min and max are literals that will otherwise be assigned a signed
433  * integer type.
434  */
435 #define clamp_val(val, min, max) ({             \
436         typeof(val) __val = (val);              \
437         typeof(val) __min = (min);              \
438         typeof(val) __max = (max);              \
439         __val = __val < __min ? __min: __val;   \
440         __val > __max ? __max: __val; })
441
442 /**
443  * container_of - cast a member of a structure out to the containing structure
444  * @ptr:        the pointer to the member.
445  * @type:       the type of the container struct this is embedded in.
446  * @member:     the name of the member within the struct.
447  *
448  */
449 #define container_of(ptr, type, member) ({                      \
450         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
451         (type *)( (char *)__mptr - offsetof(type,member) );})
452
453 struct sysinfo;
454 extern int do_sysinfo(struct sysinfo *info);
455
456 #endif /* __KERNEL__ */
457
458 #define SI_LOAD_SHIFT   16
459 struct sysinfo {
460         long uptime;                    /* Seconds since boot */
461         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
462         unsigned long totalram;         /* Total usable main memory size */
463         unsigned long freeram;          /* Available memory size */
464         unsigned long sharedram;        /* Amount of shared memory */
465         unsigned long bufferram;        /* Memory used by buffers */
466         unsigned long totalswap;        /* Total swap space size */
467         unsigned long freeswap;         /* swap space still available */
468         unsigned short procs;           /* Number of current processes */
469         unsigned short pad;             /* explicit padding for m68k */
470         unsigned long totalhigh;        /* Total high memory size */
471         unsigned long freehigh;         /* Available high memory size */
472         unsigned int mem_unit;          /* Memory unit size in bytes */
473         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
474 };
475
476 /* Force a compilation error if condition is true */
477 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
478
479 /* Force a compilation error if condition is true, but also produce a
480    result (of value 0 and type size_t), so the expression can be used
481    e.g. in a structure initializer (or where-ever else comma expressions
482    aren't permitted). */
483 #define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
484
485 /* Trap pasters of __FUNCTION__ at compile-time */
486 #define __FUNCTION__ (__func__)
487
488 /* This helps us to avoid #ifdef CONFIG_NUMA */
489 #ifdef CONFIG_NUMA
490 #define NUMA_BUILD 1
491 #else
492 #define NUMA_BUILD 0
493 #endif
494
495 #endif