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