blob: d140e8fb075f7dca2dba8ed0dd91fb5cb51938c1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_KERNEL_H
2#define _LINUX_KERNEL_H
3
Linus Torvalds1da177e2005-04-16 15:20:36 -07004
5#include <stdarg.h>
6#include <linux/linkage.h>
7#include <linux/stddef.h>
8#include <linux/types.h>
9#include <linux/compiler.h>
10#include <linux/bitops.h>
David Howellsf0d1b0b2006-12-08 02:37:49 -080011#include <linux/log2.h>
Andrew Mortone0deaff42008-07-25 01:45:24 -070012#include <linux/typecheck.h>
Linus Torvalds968ab182010-11-15 13:37:37 -080013#include <linux/printk.h>
Jason Barone9d376f2009-02-05 11:51:38 -050014#include <linux/dynamic_debug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <asm/byteorder.h>
David Howells607ca462012-10-13 10:46:48 +010016#include <uapi/linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
Alexey Dobriyan4be929b2010-05-24 14:33:03 -070018#define USHRT_MAX ((u16)(~0U))
19#define SHRT_MAX ((s16)(USHRT_MAX>>1))
20#define SHRT_MIN ((s16)(-SHRT_MAX - 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#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)
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -070027#define LLONG_MAX ((long long)(~0ULL>>1))
28#define LLONG_MIN (-LLONG_MAX - 1)
29#define ULLONG_MAX (~0ULL)
Xi Wanga3860c12012-05-31 16:26:04 -070030#define SIZE_MAX (~(size_t)0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
32#define STACK_MAGIC 0xdeadbeef
33
David S. Miller44696902012-05-23 20:12:50 -070034#define REPEAT_BYTE(x) ((~0ul / 0xff) * (x))
35
Alexey Dobriyana79ff732010-04-13 11:21:46 +020036#define ALIGN(x, a) __ALIGN_KERNEL((x), (a))
Alexey Dobriyan9f93ff52010-04-13 14:09:15 +020037#define __ALIGN_MASK(x, mask) __ALIGN_KERNEL_MASK((x), (mask))
Matthew Wilcoxa83308e2007-09-11 15:23:47 -070038#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
Herbert Xuf10db622008-02-06 01:37:05 -080039#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
Linus Torvalds2ea58142006-11-26 19:05:22 -080040
Rusty Russellc5e631cf2007-05-06 14:51:05 -070041#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
42
Yinghai Lu9b3be9f2010-02-10 01:20:29 -080043/*
44 * This looks more complex than it should be. But we need to
45 * get the type for the ~ right in round_down (it needs to be
46 * as wide as the result!), and we want to evaluate the macro
47 * arguments just once each.
48 */
49#define __round_mask(x, y) ((__typeof__(x))((y)-1))
50#define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
51#define round_down(x, y) ((x) & ~__round_mask(x, y))
52
Jan Beulich4552d5d2006-06-26 13:57:28 +020053#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
Steven Whitehouse930631e2006-09-25 23:32:40 -070054#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
Nicholas Bellinger36a26c62011-07-26 00:35:26 -070055#define DIV_ROUND_UP_ULL(ll,d) \
56 ({ unsigned long long _tmp = (ll)+(d)-1; do_div(_tmp, d); _tmp; })
57
58#if BITS_PER_LONG == 32
59# define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP_ULL(ll, d)
60#else
61# define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP(ll,d)
62#endif
James Morris074e61e2010-11-10 09:01:31 +110063
64/* The `const' in roundup() prevents gcc-3.3 from calling __divdi3 */
Eric Parisb28efd52010-10-13 17:50:08 -040065#define roundup(x, y) ( \
66{ \
Tetsuo Handa6070bf32010-11-08 11:20:49 +090067 const typeof(y) __y = y; \
Eric Parisb28efd52010-10-13 17:50:08 -040068 (((x) + (__y - 1)) / __y) * __y; \
69} \
70)
Eric Paris686a0f32010-10-13 17:50:02 -040071#define rounddown(x, y) ( \
72{ \
73 typeof(x) __x = (x); \
74 __x - (__x % (y)); \
75} \
76)
Guenter Roeckb6d86d32012-08-24 17:25:01 -070077
78/*
79 * Divide positive or negative dividend by positive divisor and round
80 * to closest integer. Result is undefined for negative divisors.
81 */
Darrick J. Wong9fe06082009-01-06 14:40:51 -080082#define DIV_ROUND_CLOSEST(x, divisor)( \
83{ \
Guenter Roeckb6d86d32012-08-24 17:25:01 -070084 typeof(x) __x = x; \
85 typeof(divisor) __d = divisor; \
Guenter Roeck263a5232012-09-18 20:42:31 -070086 (((typeof(x))-1) > 0 || (__x) > 0) ? \
Guenter Roeckb6d86d32012-08-24 17:25:01 -070087 (((__x) + ((__d) / 2)) / (__d)) : \
88 (((__x) - ((__d) / 2)) / (__d)); \
Darrick J. Wong9fe06082009-01-06 14:40:51 -080089} \
90)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Salman Qazi9993bc632012-03-09 16:41:01 -080092/*
93 * Multiplies an integer by a fraction, while avoiding unnecessary
94 * overflow or loss of precision.
95 */
96#define mult_frac(x, numer, denom)( \
97{ \
98 typeof(x) quot = (x) / (denom); \
99 typeof(x) rem = (x) % (denom); \
100 (quot * (numer)) + ((rem * (numer)) / (denom)); \
101} \
102)
103
104
Eduard - Gabriel Munteanuca31e142008-07-05 12:14:23 +0300105#define _RET_IP_ (unsigned long)__builtin_return_address(0)
106#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
107
Bartlomiej Zolnierkiewicz90c699a2009-06-19 08:08:50 +0200108#ifdef CONFIG_LBDAF
Jens Axboe2da96ac2007-10-12 12:40:38 +0200109# include <asm/div64.h>
110# define sector_div(a, b) do_div(a, b)
111#else
112# define sector_div(n, b)( \
113{ \
114 int _res; \
115 _res = (n) % (b); \
116 (n) /= (b); \
117 _res; \
118} \
119)
120#endif
121
Andrew Morton218e1802007-05-10 03:15:18 -0700122/**
123 * upper_32_bits - return bits 32-63 of a number
124 * @n: the number we're accessing
125 *
126 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
127 * the "right shift count >= width of type" warning when that quantity is
128 * 32-bits.
129 */
130#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
131
Joerg Roedel204b8852008-07-29 22:33:42 -0700132/**
133 * lower_32_bits - return bits 0-31 of a number
134 * @n: the number we're accessing
135 */
136#define lower_32_bits(n) ((u32)(n))
137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800139struct pt_regs;
140struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700142#ifdef CONFIG_PREEMPT_VOLUNTARY
143extern int _cond_resched(void);
144# define might_resched() _cond_resched()
145#else
146# define might_resched() do { } while (0)
147#endif
148
Frederic Weisbeckerd902db12011-06-08 19:31:56 +0200149#ifdef CONFIG_DEBUG_ATOMIC_SLEEP
Simon Kagstromd8948372009-12-23 11:08:18 +0100150 void __might_sleep(const char *file, int line, int preempt_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151/**
152 * might_sleep - annotation for functions that can sleep
153 *
154 * this macro will print a stack trace if it is executed in an atomic
155 * context (spinlock, irq-handler, ...).
156 *
157 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100158 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 * supposed to.
160 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700161# define might_sleep() \
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200162 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700163#else
Simon Kagstromd8948372009-12-23 11:08:18 +0100164 static inline void __might_sleep(const char *file, int line,
165 int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700166# define might_sleep() do { might_resched(); } while (0)
167#endif
168
Hua Zhong368a5fa2006-06-23 02:05:42 -0700169#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700170
Andrew Morton71a90482011-01-12 16:59:35 -0800171/*
172 * abs() handles unsigned and signed longs, ints, shorts and chars. For all
173 * input types abs() returns a signed long.
174 * abs() should not be used for 64-bit types (s64, u64, long long) - use abs64()
175 * for those.
176 */
177#define abs(x) ({ \
178 long ret; \
179 if (sizeof(x) == sizeof(long)) { \
180 long __x = (x); \
181 ret = (__x < 0) ? -__x : __x; \
182 } else { \
183 int __x = (x); \
184 ret = (__x < 0) ? -__x : __x; \
185 } \
186 ret; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 })
188
Brian Behlendorf658716d2010-10-26 14:23:10 -0700189#define abs64(x) ({ \
190 s64 __x = (x); \
191 (__x < 0) ? -__x : __x; \
192 })
193
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200194#ifdef CONFIG_PROVE_LOCKING
195void might_fault(void);
196#else
197static inline void might_fault(void)
198{
199 might_sleep();
200}
201#endif
202
Alan Sterne041c682006-03-27 01:16:30 -0800203extern struct atomic_notifier_head panic_notifier_list;
TAMUKI Shoichic7ff0d92010-08-10 18:03:28 -0700204extern long (*panic_blink)(int state);
Joe Perches9402c952012-01-12 17:17:17 -0800205__printf(1, 2)
Joe Perches4da47852012-01-12 17:17:13 -0800206void panic(const char *fmt, ...)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800207 __noreturn __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800208extern void oops_enter(void);
209extern void oops_exit(void);
Anton Blanchard863a6042010-08-10 18:03:30 -0700210void print_oops_end_marker(void);
Andrew Mortondd287792006-03-23 03:00:57 -0800211extern int oops_may_print(void);
Joe Perches9402c952012-01-12 17:17:17 -0800212void do_exit(long error_code)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800213 __noreturn;
Joe Perches9402c952012-01-12 17:17:17 -0800214void complete_and_exit(struct completion *, long)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800215 __noreturn;
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700216
217/* Internal, do not use. */
218int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
219int __must_check _kstrtol(const char *s, unsigned int base, long *res);
220
221int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
222int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
Eldad Zack4c925d62012-12-17 16:03:04 -0800223
224/**
225 * kstrtoul - convert a string to an unsigned long
226 * @s: The start of the string. The string must be null-terminated, and may also
227 * include a single newline before its terminating null. The first character
228 * may also be a plus sign, but not a minus sign.
229 * @base: The number base to use. The maximum supported base is 16. If base is
230 * given as 0, then the base of the string is automatically detected with the
231 * conventional semantics - If it begins with 0x the number will be parsed as a
232 * hexadecimal (case insensitive), if it otherwise begins with 0, it will be
233 * parsed as an octal number. Otherwise it will be parsed as a decimal.
234 * @res: Where to write the result of the conversion on success.
235 *
236 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
237 * Used as a replacement for the obsolete simple_strtoull. Return code must
238 * be checked.
239*/
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700240static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
241{
242 /*
243 * We want to shortcut function call, but
244 * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
245 */
246 if (sizeof(unsigned long) == sizeof(unsigned long long) &&
247 __alignof__(unsigned long) == __alignof__(unsigned long long))
248 return kstrtoull(s, base, (unsigned long long *)res);
249 else
250 return _kstrtoul(s, base, res);
251}
252
Eldad Zack4c925d62012-12-17 16:03:04 -0800253/**
254 * kstrtol - convert a string to a long
255 * @s: The start of the string. The string must be null-terminated, and may also
256 * include a single newline before its terminating null. The first character
257 * may also be a plus sign or a minus sign.
258 * @base: The number base to use. The maximum supported base is 16. If base is
259 * given as 0, then the base of the string is automatically detected with the
260 * conventional semantics - If it begins with 0x the number will be parsed as a
261 * hexadecimal (case insensitive), if it otherwise begins with 0, it will be
262 * parsed as an octal number. Otherwise it will be parsed as a decimal.
263 * @res: Where to write the result of the conversion on success.
264 *
265 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
266 * Used as a replacement for the obsolete simple_strtoull. Return code must
267 * be checked.
268 */
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700269static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
270{
271 /*
272 * We want to shortcut function call, but
273 * __builtin_types_compatible_p(long, long long) = 0.
274 */
275 if (sizeof(long) == sizeof(long long) &&
276 __alignof__(long) == __alignof__(long long))
277 return kstrtoll(s, base, (long long *)res);
278 else
279 return _kstrtol(s, base, res);
280}
281
282int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
283int __must_check kstrtoint(const char *s, unsigned int base, int *res);
284
285static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
286{
287 return kstrtoull(s, base, res);
288}
289
290static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
291{
292 return kstrtoll(s, base, res);
293}
294
295static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
296{
297 return kstrtouint(s, base, res);
298}
299
300static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
301{
302 return kstrtoint(s, base, res);
303}
304
305int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
306int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
307int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
308int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);
309
Alexey Dobriyanc196e322011-05-24 17:13:31 -0700310int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
311int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
312int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
313int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
314int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
315int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
316int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
317int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
318int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
319int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);
320
321static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
322{
323 return kstrtoull_from_user(s, count, base, res);
324}
325
326static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
327{
328 return kstrtoll_from_user(s, count, base, res);
329}
330
331static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
332{
333 return kstrtouint_from_user(s, count, base, res);
334}
335
336static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
337{
338 return kstrtoint_from_user(s, count, base, res);
339}
340
Joe Perches67d0a072011-10-31 17:13:10 -0700341/* Obsolete, do not use. Use kstrto<foo> instead */
342
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343extern unsigned long simple_strtoul(const char *,char **,unsigned int);
344extern long simple_strtol(const char *,char **,unsigned int);
345extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
346extern long long simple_strtoll(const char *,char **,unsigned int);
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700347#define strict_strtoul kstrtoul
348#define strict_strtol kstrtol
349#define strict_strtoull kstrtoull
350#define strict_strtoll kstrtoll
351
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700352extern int num_to_str(char *buf, int size, unsigned long long num);
353
Joe Perches67d0a072011-10-31 17:13:10 -0700354/* lib/printf utilities */
355
Joe Perchesb9075fa2011-10-31 17:11:33 -0700356extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
357extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
358extern __printf(3, 4)
359int snprintf(char *buf, size_t size, const char *fmt, ...);
360extern __printf(3, 0)
361int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
362extern __printf(3, 4)
363int scnprintf(char *buf, size_t size, const char *fmt, ...);
364extern __printf(3, 0)
365int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
366extern __printf(2, 3)
367char *kasprintf(gfp_t gfp, const char *fmt, ...);
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700368extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
Joe Perches6061d942012-03-23 15:02:16 -0700370extern __scanf(2, 3)
371int sscanf(const char *, const char *, ...);
372extern __scanf(2, 0)
373int vsscanf(const char *, const char *, va_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
375extern int get_option(char **str, int *pint);
376extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700377extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
Trent Piepho5e376612006-05-15 09:44:06 -0700379extern int core_kernel_text(unsigned long addr);
Steven Rostedtcdbe61b2011-05-05 21:14:55 -0400380extern int core_kernel_data(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381extern int __kernel_text_address(unsigned long addr);
382extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700383extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700384
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800385struct pid;
386extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388unsigned long int_sqrt(unsigned long);
389
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800391extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700393extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200395extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700396extern int panic_on_io_nmi;
Mitsuo Hayasaka55af7792011-11-29 15:08:36 +0900397extern int sysctl_panic_on_stackoverflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700399extern void add_taint(unsigned flag);
400extern int test_taint(unsigned flag);
401extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800402extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
Tejun Heo2ce802f2011-01-20 12:06:35 +0100404extern bool early_boot_irqs_disabled;
405
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406/* Values used for system_state */
407extern enum system_states {
408 SYSTEM_BOOTING,
409 SYSTEM_RUNNING,
410 SYSTEM_HALT,
411 SYSTEM_POWER_OFF,
412 SYSTEM_RESTART,
413} system_state;
414
Andi Kleen25ddbb12008-10-15 22:01:41 -0700415#define TAINT_PROPRIETARY_MODULE 0
416#define TAINT_FORCED_MODULE 1
417#define TAINT_UNSAFE_SMP 2
418#define TAINT_FORCED_RMMOD 3
419#define TAINT_MACHINE_CHECK 4
420#define TAINT_BAD_PAGE 5
421#define TAINT_USER 6
422#define TAINT_DIE 7
423#define TAINT_OVERRIDDEN_ACPI_TABLE 8
424#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700425#define TAINT_CRAP 10
Ben Hutchings92946bc2010-04-03 19:36:42 +0100426#define TAINT_FIRMWARE_WORKAROUND 11
Ben Hutchings2449b8b2011-10-24 15:12:28 +0200427#define TAINT_OOT_MODULE 12
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428
Harvey Harrison3fc95772008-05-14 16:05:49 -0700429extern const char hex_asc[];
430#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
431#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
432
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700433static inline char *hex_byte_pack(char *buf, u8 byte)
Harvey Harrison3fc95772008-05-14 16:05:49 -0700434{
435 *buf++ = hex_asc_hi(byte);
436 *buf++ = hex_asc_lo(byte);
437 return buf;
438}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700439
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700440static inline char * __deprecated pack_hex_byte(char *buf, u8 byte)
441{
442 return hex_byte_pack(buf, byte);
443}
444
Andy Shevchenko903788892010-05-24 14:33:23 -0700445extern int hex_to_bin(char ch);
Mimi Zoharb7804982011-09-20 11:23:49 -0400446extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
Andy Shevchenko903788892010-05-24 14:33:23 -0700447
Joe Perches8a64f332009-12-14 18:00:25 -0800448/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100449 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500450 * tracing_on/tracing_off and tracing_start()/tracing_stop
451 *
452 * Use tracing_on/tracing_off when you want to quickly turn on or off
453 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900454 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500455 * file, which gives a means for the kernel and userspace to interact.
456 * Place a tracing_off() in the kernel where you want tracing to end.
457 * From user space, examine the trace, and then echo 1 > tracing_on
458 * to continue tracing.
459 *
460 * tracing_stop/tracing_start has slightly more overhead. It is used
461 * by things like suspend to ram where disabling the recording of the
462 * trace is not enough, but tracing must actually stop because things
463 * like calling smp_processor_id() may crash the system.
464 *
465 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100466 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500467#ifdef CONFIG_RING_BUFFER
Steven Rostedt2002c252009-03-05 10:35:56 -0500468/* trace_off_permanent stops recording with no way to bring it back */
469void tracing_off_permanent(void);
Steven Rostedt2002c252009-03-05 10:35:56 -0500470#else
Steven Rostedt2002c252009-03-05 10:35:56 -0500471static inline void tracing_off_permanent(void) { }
Steven Rostedt2002c252009-03-05 10:35:56 -0500472#endif
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200473
474enum ftrace_dump_mode {
475 DUMP_NONE,
476 DUMP_ALL,
477 DUMP_ORIG,
478};
479
Ingo Molnar526211b2009-03-05 10:28:45 +0100480#ifdef CONFIG_TRACING
Steven Rostedt93d68e52012-03-20 12:28:29 -0400481void tracing_on(void);
482void tracing_off(void);
483int tracing_is_on(void);
484
Ingo Molnar526211b2009-03-05 10:28:45 +0100485extern void tracing_start(void);
486extern void tracing_stop(void);
487extern void ftrace_off_permanent(void);
488
Joe Perchesb9075fa2011-10-31 17:11:33 -0700489static inline __printf(1, 2)
490void ____trace_printk_check_format(const char *fmt, ...)
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100491{
492}
493#define __trace_printk_check_format(fmt, args...) \
494do { \
495 if (0) \
496 ____trace_printk_check_format(fmt, ##args); \
497} while (0)
498
Ingo Molnar526211b2009-03-05 10:28:45 +0100499/**
500 * trace_printk - printf formatting in the ftrace buffer
501 * @fmt: the printf format for printing
502 *
503 * Note: __trace_printk is an internal function for trace_printk and
504 * the @ip is passed in via the trace_printk macro.
505 *
506 * This function allows a kernel developer to debug fast path sections
507 * that printk is not appropriate for. By scattering in various
508 * printk like tracing in the code, a developer can quickly see
509 * where problems are occurring.
510 *
511 * This is intended as a debugging tool for the developer only.
512 * Please refrain from leaving trace_printks scattered around in
513 * your code.
514 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100515
516#define trace_printk(fmt, args...) \
517do { \
Steven Rostedt07d777f2011-09-22 14:01:55 -0400518 static const char *trace_printk_fmt \
519 __attribute__((section("__trace_printk_fmt"))) = \
520 __builtin_constant_p(fmt) ? fmt : NULL; \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100521 \
Steven Rostedt07d777f2011-09-22 14:01:55 -0400522 __trace_printk_check_format(fmt, ##args); \
523 \
524 if (__builtin_constant_p(fmt)) \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100525 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
Steven Rostedt07d777f2011-09-22 14:01:55 -0400526 else \
527 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100528} while (0)
529
Joe Perchesb9075fa2011-10-31 17:11:33 -0700530extern __printf(2, 3)
531int __trace_bprintk(unsigned long ip, const char *fmt, ...);
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100532
Joe Perchesb9075fa2011-10-31 17:11:33 -0700533extern __printf(2, 3)
534int __trace_printk(unsigned long ip, const char *fmt, ...);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100535
Steven Rostedt03889382009-12-11 09:48:22 -0500536extern void trace_dump_stack(void);
537
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100538/*
539 * The double __builtin_constant_p is because gcc will give us an error
540 * if we try to allocate the static variable to fmt if it is not a
541 * constant. Even with the outer if statement.
542 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100543#define ftrace_vprintk(fmt, vargs) \
544do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100545 if (__builtin_constant_p(fmt)) { \
546 static const char *trace_printk_fmt \
547 __attribute__((section("__trace_printk_fmt"))) = \
548 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100549 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100550 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
551 } else \
552 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100553} while (0)
554
Ingo Molnar526211b2009-03-05 10:28:45 +0100555extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100556__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
557
558extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100559__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100560
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200561extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
Ingo Molnar526211b2009-03-05 10:28:45 +0100562#else
Ingo Molnar526211b2009-03-05 10:28:45 +0100563static inline void tracing_start(void) { }
564static inline void tracing_stop(void) { }
565static inline void ftrace_off_permanent(void) { }
Steven Rostedte36c5452009-12-14 15:58:33 -0500566static inline void trace_dump_stack(void) { }
Steven Rostedt93d68e52012-03-20 12:28:29 -0400567
568static inline void tracing_on(void) { }
569static inline void tracing_off(void) { }
570static inline int tracing_is_on(void) { return 0; }
571
Michal Hocko60efc152012-10-25 15:41:51 +0200572static inline __printf(1, 2)
573int trace_printk(const char *fmt, ...)
Ingo Molnar526211b2009-03-05 10:28:45 +0100574{
575 return 0;
576}
577static inline int
578ftrace_vprintk(const char *fmt, va_list ap)
579{
580 return 0;
581}
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200582static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100583#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100584
585/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700586 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 * strict type-checking.. See the
588 * "unnecessary" pointer comparison.
589 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700590#define min(x, y) ({ \
591 typeof(x) _min1 = (x); \
592 typeof(y) _min2 = (y); \
593 (void) (&_min1 == &_min2); \
594 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700596#define max(x, y) ({ \
597 typeof(x) _max1 = (x); \
598 typeof(y) _max2 = (y); \
599 (void) (&_max1 == &_max2); \
600 _max1 > _max2 ? _max1 : _max2; })
601
Hagen Paul Pfeiferf27c85c2010-10-26 14:22:21 -0700602#define min3(x, y, z) ({ \
603 typeof(x) _min1 = (x); \
604 typeof(y) _min2 = (y); \
605 typeof(z) _min3 = (z); \
606 (void) (&_min1 == &_min2); \
607 (void) (&_min1 == &_min3); \
608 _min1 < _min2 ? (_min1 < _min3 ? _min1 : _min3) : \
609 (_min2 < _min3 ? _min2 : _min3); })
610
611#define max3(x, y, z) ({ \
612 typeof(x) _max1 = (x); \
613 typeof(y) _max2 = (y); \
614 typeof(z) _max3 = (z); \
615 (void) (&_max1 == &_max2); \
616 (void) (&_max1 == &_max3); \
617 _max1 > _max2 ? (_max1 > _max3 ? _max1 : _max3) : \
618 (_max2 > _max3 ? _max2 : _max3); })
619
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700620/**
Martin K. Petersenc8bf1332010-09-10 20:07:38 +0200621 * min_not_zero - return the minimum that is _not_ zero, unless both are zero
622 * @x: value1
623 * @y: value2
624 */
625#define min_not_zero(x, y) ({ \
626 typeof(x) __x = (x); \
627 typeof(y) __y = (y); \
628 __x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
629
630/**
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700631 * clamp - return a value clamped to a given range with strict typechecking
632 * @val: current value
633 * @min: minimum allowable value
634 * @max: maximum allowable value
635 *
636 * This macro does strict typechecking of min/max to make sure they are of the
637 * same type as val. See the unnecessary pointer comparisons.
638 */
639#define clamp(val, min, max) ({ \
640 typeof(val) __val = (val); \
641 typeof(min) __min = (min); \
642 typeof(max) __max = (max); \
643 (void) (&__val == &__min); \
644 (void) (&__val == &__max); \
645 __val = __val < __min ? __min: __val; \
646 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
648/*
649 * ..and if you can't take the strict
650 * types, you can specify one yourself.
651 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700652 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700654#define min_t(type, x, y) ({ \
655 type __min1 = (x); \
656 type __min2 = (y); \
657 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700659#define max_t(type, x, y) ({ \
660 type __max1 = (x); \
661 type __max2 = (y); \
662 __max1 > __max2 ? __max1: __max2; })
663
664/**
665 * clamp_t - return a value clamped to a given range using a given type
666 * @type: the type of variable to use
667 * @val: current value
668 * @min: minimum allowable value
669 * @max: maximum allowable value
670 *
671 * This macro does no typechecking and uses temporary variables of type
672 * 'type' to make all the comparisons.
673 */
674#define clamp_t(type, val, min, max) ({ \
675 type __val = (val); \
676 type __min = (min); \
677 type __max = (max); \
678 __val = __val < __min ? __min: __val; \
679 __val > __max ? __max: __val; })
680
681/**
682 * clamp_val - return a value clamped to a given range using val's type
683 * @val: current value
684 * @min: minimum allowable value
685 * @max: maximum allowable value
686 *
687 * This macro does no typechecking and uses temporary variables of whatever
688 * type the input argument 'val' is. This is useful when val is an unsigned
689 * type and min and max are literals that will otherwise be assigned a signed
690 * integer type.
691 */
692#define clamp_val(val, min, max) ({ \
693 typeof(val) __val = (val); \
694 typeof(val) __min = (min); \
695 typeof(val) __max = (max); \
696 __val = __val < __min ? __min: __val; \
697 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
Wu Fengguang91f68b72009-01-07 18:09:12 -0800699
700/*
701 * swap - swap value of @a and @b
702 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800703#define swap(a, b) \
704 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800705
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706/**
707 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 * @ptr: the pointer to the member.
709 * @type: the type of the container struct this is embedded in.
710 * @member: the name of the member within the struct.
711 *
712 */
713#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700714 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
715 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
Arnaud Lacombeb9d4f422011-07-25 17:13:03 -0700717/* Trap pasters of __FUNCTION__ at compile-time */
718#define __FUNCTION__ (__func__)
719
James Hogancbdbf2a2012-11-23 12:08:15 +0000720/* This helps us to avoid #ifdef CONFIG_SYMBOL_PREFIX */
721#ifdef CONFIG_SYMBOL_PREFIX
722#define SYMBOL_PREFIX CONFIG_SYMBOL_PREFIX
723#else
724#define SYMBOL_PREFIX ""
725#endif
726
Arnaud Lacombeb9d4f422011-07-25 17:13:03 -0700727/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
728#ifdef CONFIG_FTRACE_MCOUNT_RECORD
729# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
730#endif
WANG Cong9d00f922011-07-25 17:13:02 -0700731
WANG Cong9d00f922011-07-25 17:13:02 -0700732extern int do_sysinfo(struct sysinfo *info);
733
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734#endif