Merge branch 'x86-mce-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[pandora-kernel.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 #define __ALIGN_KERNEL(x, a)            __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
8 #define __ALIGN_KERNEL_MASK(x, mask)    (((x) + (mask)) & ~(mask))
9
10 #ifdef __KERNEL__
11
12 #include <stdarg.h>
13 #include <linux/linkage.h>
14 #include <linux/stddef.h>
15 #include <linux/types.h>
16 #include <linux/compiler.h>
17 #include <linux/bitops.h>
18 #include <linux/log2.h>
19 #include <linux/typecheck.h>
20 #include <linux/printk.h>
21 #include <linux/dynamic_debug.h>
22 #include <asm/byteorder.h>
23 #include <asm/bug.h>
24
25 #define USHRT_MAX       ((u16)(~0U))
26 #define SHRT_MAX        ((s16)(USHRT_MAX>>1))
27 #define SHRT_MIN        ((s16)(-SHRT_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_KERNEL((x), (a))
41 #define __ALIGN_MASK(x, mask)   __ALIGN_KERNEL_MASK((x), (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 /*
48  * This looks more complex than it should be. But we need to
49  * get the type for the ~ right in round_down (it needs to be
50  * as wide as the result!), and we want to evaluate the macro
51  * arguments just once each.
52  */
53 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
54 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
55 #define round_down(x, y) ((x) & ~__round_mask(x, y))
56
57 #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
58 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
59 #define roundup(x, y) (                                 \
60 {                                                       \
61         const typeof(y) __y = y;                        \
62         (((x) + (__y - 1)) / __y) * __y;                \
63 }                                                       \
64 )
65 #define rounddown(x, y) (                               \
66 {                                                       \
67         typeof(x) __x = (x);                            \
68         __x - (__x % (y));                              \
69 }                                                       \
70 )
71 #define DIV_ROUND_CLOSEST(x, divisor)(                  \
72 {                                                       \
73         typeof(divisor) __divisor = divisor;            \
74         (((x) + ((__divisor) / 2)) / (__divisor));      \
75 }                                                       \
76 )
77
78 #define _RET_IP_                (unsigned long)__builtin_return_address(0)
79 #define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })
80
81 #ifdef CONFIG_LBDAF
82 # include <asm/div64.h>
83 # define sector_div(a, b) do_div(a, b)
84 #else
85 # define sector_div(n, b)( \
86 { \
87         int _res; \
88         _res = (n) % (b); \
89         (n) /= (b); \
90         _res; \
91 } \
92 )
93 #endif
94
95 /**
96  * upper_32_bits - return bits 32-63 of a number
97  * @n: the number we're accessing
98  *
99  * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
100  * the "right shift count >= width of type" warning when that quantity is
101  * 32-bits.
102  */
103 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
104
105 /**
106  * lower_32_bits - return bits 0-31 of a number
107  * @n: the number we're accessing
108  */
109 #define lower_32_bits(n) ((u32)(n))
110
111 struct completion;
112 struct pt_regs;
113 struct user;
114
115 #ifdef CONFIG_PREEMPT_VOLUNTARY
116 extern int _cond_resched(void);
117 # define might_resched() _cond_resched()
118 #else
119 # define might_resched() do { } while (0)
120 #endif
121
122 #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
123   void __might_sleep(const char *file, int line, int preempt_offset);
124 /**
125  * might_sleep - annotation for functions that can sleep
126  *
127  * this macro will print a stack trace if it is executed in an atomic
128  * context (spinlock, irq-handler, ...).
129  *
130  * This is a useful debugging help to be able to catch problems early and not
131  * be bitten later when the calling function happens to sleep when it is not
132  * supposed to.
133  */
134 # define might_sleep() \
135         do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
136 #else
137   static inline void __might_sleep(const char *file, int line,
138                                    int preempt_offset) { }
139 # define might_sleep() do { might_resched(); } while (0)
140 #endif
141
142 #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
143
144 #define abs(x) ({                               \
145                 long __x = (x);                 \
146                 (__x < 0) ? -__x : __x;         \
147         })
148
149 #define abs64(x) ({                             \
150                 s64 __x = (x);                  \
151                 (__x < 0) ? -__x : __x;         \
152         })
153
154 #ifdef CONFIG_PROVE_LOCKING
155 void might_fault(void);
156 #else
157 static inline void might_fault(void)
158 {
159         might_sleep();
160 }
161 #endif
162
163 extern struct atomic_notifier_head panic_notifier_list;
164 extern long (*panic_blink)(int state);
165 NORET_TYPE void panic(const char * fmt, ...)
166         __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
167 extern void oops_enter(void);
168 extern void oops_exit(void);
169 void print_oops_end_marker(void);
170 extern int oops_may_print(void);
171 NORET_TYPE void do_exit(long error_code)
172         ATTRIB_NORET;
173 NORET_TYPE void complete_and_exit(struct completion *, long)
174         ATTRIB_NORET;
175 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
176 extern long simple_strtol(const char *,char **,unsigned int);
177 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
178 extern long long simple_strtoll(const char *,char **,unsigned int);
179 extern int __must_check strict_strtoul(const char *, unsigned int, unsigned long *);
180 extern int __must_check strict_strtol(const char *, unsigned int, long *);
181 extern int __must_check strict_strtoull(const char *, unsigned int, unsigned long long *);
182 extern int __must_check strict_strtoll(const char *, unsigned int, long long *);
183 extern int sprintf(char * buf, const char * fmt, ...)
184         __attribute__ ((format (printf, 2, 3)));
185 extern int vsprintf(char *buf, const char *, va_list)
186         __attribute__ ((format (printf, 2, 0)));
187 extern int snprintf(char * buf, size_t size, const char * fmt, ...)
188         __attribute__ ((format (printf, 3, 4)));
189 extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
190         __attribute__ ((format (printf, 3, 0)));
191 extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
192         __attribute__ ((format (printf, 3, 4)));
193 extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
194         __attribute__ ((format (printf, 3, 0)));
195 extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
196         __attribute__ ((format (printf, 2, 3)));
197 extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
198
199 extern int sscanf(const char *, const char *, ...)
200         __attribute__ ((format (scanf, 2, 3)));
201 extern int vsscanf(const char *, const char *, va_list)
202         __attribute__ ((format (scanf, 2, 0)));
203
204 extern int get_option(char **str, int *pint);
205 extern char *get_options(const char *str, int nints, int *ints);
206 extern unsigned long long memparse(const char *ptr, char **retptr);
207
208 extern int core_kernel_text(unsigned long addr);
209 extern int __kernel_text_address(unsigned long addr);
210 extern int kernel_text_address(unsigned long addr);
211 extern int func_ptr_is_kernel_text(void *ptr);
212
213 struct pid;
214 extern struct pid *session_of_pgrp(struct pid *pgrp);
215
216 unsigned long int_sqrt(unsigned long);
217
218 extern void bust_spinlocks(int yes);
219 extern void wake_up_klogd(void);
220 extern int oops_in_progress;            /* If set, an oops, panic(), BUG() or die() is in progress */
221 extern int panic_timeout;
222 extern int panic_on_oops;
223 extern int panic_on_unrecovered_nmi;
224 extern int panic_on_io_nmi;
225 extern const char *print_tainted(void);
226 extern void add_taint(unsigned flag);
227 extern int test_taint(unsigned flag);
228 extern unsigned long get_taint(void);
229 extern int root_mountflags;
230
231 /* Values used for system_state */
232 extern enum system_states {
233         SYSTEM_BOOTING,
234         SYSTEM_RUNNING,
235         SYSTEM_HALT,
236         SYSTEM_POWER_OFF,
237         SYSTEM_RESTART,
238         SYSTEM_SUSPEND_DISK,
239 } system_state;
240
241 #define TAINT_PROPRIETARY_MODULE        0
242 #define TAINT_FORCED_MODULE             1
243 #define TAINT_UNSAFE_SMP                2
244 #define TAINT_FORCED_RMMOD              3
245 #define TAINT_MACHINE_CHECK             4
246 #define TAINT_BAD_PAGE                  5
247 #define TAINT_USER                      6
248 #define TAINT_DIE                       7
249 #define TAINT_OVERRIDDEN_ACPI_TABLE     8
250 #define TAINT_WARN                      9
251 #define TAINT_CRAP                      10
252 #define TAINT_FIRMWARE_WORKAROUND       11
253
254 extern const char hex_asc[];
255 #define hex_asc_lo(x)   hex_asc[((x) & 0x0f)]
256 #define hex_asc_hi(x)   hex_asc[((x) & 0xf0) >> 4]
257
258 static inline char *pack_hex_byte(char *buf, u8 byte)
259 {
260         *buf++ = hex_asc_hi(byte);
261         *buf++ = hex_asc_lo(byte);
262         return buf;
263 }
264
265 extern int hex_to_bin(char ch);
266
267 /*
268  * General tracing related utility functions - trace_printk(),
269  * tracing_on/tracing_off and tracing_start()/tracing_stop
270  *
271  * Use tracing_on/tracing_off when you want to quickly turn on or off
272  * tracing. It simply enables or disables the recording of the trace events.
273  * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
274  * file, which gives a means for the kernel and userspace to interact.
275  * Place a tracing_off() in the kernel where you want tracing to end.
276  * From user space, examine the trace, and then echo 1 > tracing_on
277  * to continue tracing.
278  *
279  * tracing_stop/tracing_start has slightly more overhead. It is used
280  * by things like suspend to ram where disabling the recording of the
281  * trace is not enough, but tracing must actually stop because things
282  * like calling smp_processor_id() may crash the system.
283  *
284  * Most likely, you want to use tracing_on/tracing_off.
285  */
286 #ifdef CONFIG_RING_BUFFER
287 void tracing_on(void);
288 void tracing_off(void);
289 /* trace_off_permanent stops recording with no way to bring it back */
290 void tracing_off_permanent(void);
291 int tracing_is_on(void);
292 #else
293 static inline void tracing_on(void) { }
294 static inline void tracing_off(void) { }
295 static inline void tracing_off_permanent(void) { }
296 static inline int tracing_is_on(void) { return 0; }
297 #endif
298
299 enum ftrace_dump_mode {
300         DUMP_NONE,
301         DUMP_ALL,
302         DUMP_ORIG,
303 };
304
305 #ifdef CONFIG_TRACING
306 extern void tracing_start(void);
307 extern void tracing_stop(void);
308 extern void ftrace_off_permanent(void);
309
310 static inline void __attribute__ ((format (printf, 1, 2)))
311 ____trace_printk_check_format(const char *fmt, ...)
312 {
313 }
314 #define __trace_printk_check_format(fmt, args...)                       \
315 do {                                                                    \
316         if (0)                                                          \
317                 ____trace_printk_check_format(fmt, ##args);             \
318 } while (0)
319
320 /**
321  * trace_printk - printf formatting in the ftrace buffer
322  * @fmt: the printf format for printing
323  *
324  * Note: __trace_printk is an internal function for trace_printk and
325  *       the @ip is passed in via the trace_printk macro.
326  *
327  * This function allows a kernel developer to debug fast path sections
328  * that printk is not appropriate for. By scattering in various
329  * printk like tracing in the code, a developer can quickly see
330  * where problems are occurring.
331  *
332  * This is intended as a debugging tool for the developer only.
333  * Please refrain from leaving trace_printks scattered around in
334  * your code.
335  */
336
337 #define trace_printk(fmt, args...)                                      \
338 do {                                                                    \
339         __trace_printk_check_format(fmt, ##args);                       \
340         if (__builtin_constant_p(fmt)) {                                \
341                 static const char *trace_printk_fmt                     \
342                   __attribute__((section("__trace_printk_fmt"))) =      \
343                         __builtin_constant_p(fmt) ? fmt : NULL;         \
344                                                                         \
345                 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args);   \
346         } else                                                          \
347                 __trace_printk(_THIS_IP_, fmt, ##args);         \
348 } while (0)
349
350 extern int
351 __trace_bprintk(unsigned long ip, const char *fmt, ...)
352         __attribute__ ((format (printf, 2, 3)));
353
354 extern int
355 __trace_printk(unsigned long ip, const char *fmt, ...)
356         __attribute__ ((format (printf, 2, 3)));
357
358 extern void trace_dump_stack(void);
359
360 /*
361  * The double __builtin_constant_p is because gcc will give us an error
362  * if we try to allocate the static variable to fmt if it is not a
363  * constant. Even with the outer if statement.
364  */
365 #define ftrace_vprintk(fmt, vargs)                                      \
366 do {                                                                    \
367         if (__builtin_constant_p(fmt)) {                                \
368                 static const char *trace_printk_fmt                     \
369                   __attribute__((section("__trace_printk_fmt"))) =      \
370                         __builtin_constant_p(fmt) ? fmt : NULL;         \
371                                                                         \
372                 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs);  \
373         } else                                                          \
374                 __ftrace_vprintk(_THIS_IP_, fmt, vargs);                \
375 } while (0)
376
377 extern int
378 __ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
379
380 extern int
381 __ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
382
383 extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
384 #else
385 static inline int
386 trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
387
388 static inline void tracing_start(void) { }
389 static inline void tracing_stop(void) { }
390 static inline void ftrace_off_permanent(void) { }
391 static inline void trace_dump_stack(void) { }
392 static inline int
393 trace_printk(const char *fmt, ...)
394 {
395         return 0;
396 }
397 static inline int
398 ftrace_vprintk(const char *fmt, va_list ap)
399 {
400         return 0;
401 }
402 static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
403 #endif /* CONFIG_TRACING */
404
405 /*
406  * min()/max()/clamp() macros that also do
407  * strict type-checking.. See the
408  * "unnecessary" pointer comparison.
409  */
410 #define min(x, y) ({                            \
411         typeof(x) _min1 = (x);                  \
412         typeof(y) _min2 = (y);                  \
413         (void) (&_min1 == &_min2);              \
414         _min1 < _min2 ? _min1 : _min2; })
415
416 #define max(x, y) ({                            \
417         typeof(x) _max1 = (x);                  \
418         typeof(y) _max2 = (y);                  \
419         (void) (&_max1 == &_max2);              \
420         _max1 > _max2 ? _max1 : _max2; })
421
422 #define min3(x, y, z) ({                        \
423         typeof(x) _min1 = (x);                  \
424         typeof(y) _min2 = (y);                  \
425         typeof(z) _min3 = (z);                  \
426         (void) (&_min1 == &_min2);              \
427         (void) (&_min1 == &_min3);              \
428         _min1 < _min2 ? (_min1 < _min3 ? _min1 : _min3) : \
429                 (_min2 < _min3 ? _min2 : _min3); })
430
431 #define max3(x, y, z) ({                        \
432         typeof(x) _max1 = (x);                  \
433         typeof(y) _max2 = (y);                  \
434         typeof(z) _max3 = (z);                  \
435         (void) (&_max1 == &_max2);              \
436         (void) (&_max1 == &_max3);              \
437         _max1 > _max2 ? (_max1 > _max3 ? _max1 : _max3) : \
438                 (_max2 > _max3 ? _max2 : _max3); })
439
440 /**
441  * min_not_zero - return the minimum that is _not_ zero, unless both are zero
442  * @x: value1
443  * @y: value2
444  */
445 #define min_not_zero(x, y) ({                   \
446         typeof(x) __x = (x);                    \
447         typeof(y) __y = (y);                    \
448         __x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
449
450 /**
451  * clamp - return a value clamped to a given range with strict typechecking
452  * @val: current value
453  * @min: minimum allowable value
454  * @max: maximum allowable value
455  *
456  * This macro does strict typechecking of min/max to make sure they are of the
457  * same type as val.  See the unnecessary pointer comparisons.
458  */
459 #define clamp(val, min, max) ({                 \
460         typeof(val) __val = (val);              \
461         typeof(min) __min = (min);              \
462         typeof(max) __max = (max);              \
463         (void) (&__val == &__min);              \
464         (void) (&__val == &__max);              \
465         __val = __val < __min ? __min: __val;   \
466         __val > __max ? __max: __val; })
467
468 /*
469  * ..and if you can't take the strict
470  * types, you can specify one yourself.
471  *
472  * Or not use min/max/clamp at all, of course.
473  */
474 #define min_t(type, x, y) ({                    \
475         type __min1 = (x);                      \
476         type __min2 = (y);                      \
477         __min1 < __min2 ? __min1: __min2; })
478
479 #define max_t(type, x, y) ({                    \
480         type __max1 = (x);                      \
481         type __max2 = (y);                      \
482         __max1 > __max2 ? __max1: __max2; })
483
484 /**
485  * clamp_t - return a value clamped to a given range using a given type
486  * @type: the type of variable to use
487  * @val: current value
488  * @min: minimum allowable value
489  * @max: maximum allowable value
490  *
491  * This macro does no typechecking and uses temporary variables of type
492  * 'type' to make all the comparisons.
493  */
494 #define clamp_t(type, val, min, max) ({         \
495         type __val = (val);                     \
496         type __min = (min);                     \
497         type __max = (max);                     \
498         __val = __val < __min ? __min: __val;   \
499         __val > __max ? __max: __val; })
500
501 /**
502  * clamp_val - return a value clamped to a given range using val's type
503  * @val: current value
504  * @min: minimum allowable value
505  * @max: maximum allowable value
506  *
507  * This macro does no typechecking and uses temporary variables of whatever
508  * type the input argument 'val' is.  This is useful when val is an unsigned
509  * type and min and max are literals that will otherwise be assigned a signed
510  * integer type.
511  */
512 #define clamp_val(val, min, max) ({             \
513         typeof(val) __val = (val);              \
514         typeof(val) __min = (min);              \
515         typeof(val) __max = (max);              \
516         __val = __val < __min ? __min: __val;   \
517         __val > __max ? __max: __val; })
518
519
520 /*
521  * swap - swap value of @a and @b
522  */
523 #define swap(a, b) \
524         do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
525
526 /**
527  * container_of - cast a member of a structure out to the containing structure
528  * @ptr:        the pointer to the member.
529  * @type:       the type of the container struct this is embedded in.
530  * @member:     the name of the member within the struct.
531  *
532  */
533 #define container_of(ptr, type, member) ({                      \
534         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
535         (type *)( (char *)__mptr - offsetof(type,member) );})
536
537 struct sysinfo;
538 extern int do_sysinfo(struct sysinfo *info);
539
540 #endif /* __KERNEL__ */
541
542 #define SI_LOAD_SHIFT   16
543 struct sysinfo {
544         long uptime;                    /* Seconds since boot */
545         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
546         unsigned long totalram;         /* Total usable main memory size */
547         unsigned long freeram;          /* Available memory size */
548         unsigned long sharedram;        /* Amount of shared memory */
549         unsigned long bufferram;        /* Memory used by buffers */
550         unsigned long totalswap;        /* Total swap space size */
551         unsigned long freeswap;         /* swap space still available */
552         unsigned short procs;           /* Number of current processes */
553         unsigned short pad;             /* explicit padding for m68k */
554         unsigned long totalhigh;        /* Total high memory size */
555         unsigned long freehigh;         /* Available high memory size */
556         unsigned int mem_unit;          /* Memory unit size in bytes */
557         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
558 };
559
560 /* Force a compilation error if condition is true */
561 #define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))
562
563 /* Force a compilation error if condition is constant and true */
564 #define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
565
566 /* Force a compilation error if a constant expression is not a power of 2 */
567 #define BUILD_BUG_ON_NOT_POWER_OF_2(n)                  \
568         BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
569
570 /* Force a compilation error if condition is true, but also produce a
571    result (of value 0 and type size_t), so the expression can be used
572    e.g. in a structure initializer (or where-ever else comma expressions
573    aren't permitted). */
574 #define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
575 #define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
576
577 /* Trap pasters of __FUNCTION__ at compile-time */
578 #define __FUNCTION__ (__func__)
579
580 /* This helps us to avoid #ifdef CONFIG_NUMA */
581 #ifdef CONFIG_NUMA
582 #define NUMA_BUILD 1
583 #else
584 #define NUMA_BUILD 0
585 #endif
586
587 /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
588 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
589 # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
590 #endif
591
592 #endif