blob: 3bef14c6586bc9d7d875e6579352a62e53e13c6a [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
Guenter Roeckc4e18492012-12-20 15:05:42 -080080 * to closest integer. Result is undefined for negative divisors and
81 * for negative dividends if the divisor variable type is unsigned.
Guenter Roeckb6d86d32012-08-24 17:25:01 -070082 */
Darrick J. Wong9fe06082009-01-06 14:40:51 -080083#define DIV_ROUND_CLOSEST(x, divisor)( \
84{ \
Guenter Roeckb6d86d32012-08-24 17:25:01 -070085 typeof(x) __x = x; \
86 typeof(divisor) __d = divisor; \
Guenter Roeckc4e18492012-12-20 15:05:42 -080087 (((typeof(x))-1) > 0 || \
88 ((typeof(divisor))-1) > 0 || (__x) > 0) ? \
Guenter Roeckb6d86d32012-08-24 17:25:01 -070089 (((__x) + ((__d) / 2)) / (__d)) : \
90 (((__x) - ((__d) / 2)) / (__d)); \
Darrick J. Wong9fe06082009-01-06 14:40:51 -080091} \
92)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Salman Qazi9993bc632012-03-09 16:41:01 -080094/*
95 * Multiplies an integer by a fraction, while avoiding unnecessary
96 * overflow or loss of precision.
97 */
98#define mult_frac(x, numer, denom)( \
99{ \
100 typeof(x) quot = (x) / (denom); \
101 typeof(x) rem = (x) % (denom); \
102 (quot * (numer)) + ((rem * (numer)) / (denom)); \
103} \
104)
105
106
Eduard - Gabriel Munteanuca31e142008-07-05 12:14:23 +0300107#define _RET_IP_ (unsigned long)__builtin_return_address(0)
108#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
109
Bartlomiej Zolnierkiewicz90c699a2009-06-19 08:08:50 +0200110#ifdef CONFIG_LBDAF
Jens Axboe2da96ac2007-10-12 12:40:38 +0200111# include <asm/div64.h>
112# define sector_div(a, b) do_div(a, b)
113#else
114# define sector_div(n, b)( \
115{ \
116 int _res; \
117 _res = (n) % (b); \
118 (n) /= (b); \
119 _res; \
120} \
121)
122#endif
123
Andrew Morton218e1802007-05-10 03:15:18 -0700124/**
125 * upper_32_bits - return bits 32-63 of a number
126 * @n: the number we're accessing
127 *
128 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
129 * the "right shift count >= width of type" warning when that quantity is
130 * 32-bits.
131 */
132#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
133
Joerg Roedel204b8852008-07-29 22:33:42 -0700134/**
135 * lower_32_bits - return bits 0-31 of a number
136 * @n: the number we're accessing
137 */
138#define lower_32_bits(n) ((u32)(n))
139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800141struct pt_regs;
142struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700144#ifdef CONFIG_PREEMPT_VOLUNTARY
145extern int _cond_resched(void);
146# define might_resched() _cond_resched()
147#else
148# define might_resched() do { } while (0)
149#endif
150
Frederic Weisbeckerd902db12011-06-08 19:31:56 +0200151#ifdef CONFIG_DEBUG_ATOMIC_SLEEP
Simon Kagstromd8948372009-12-23 11:08:18 +0100152 void __might_sleep(const char *file, int line, int preempt_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153/**
154 * might_sleep - annotation for functions that can sleep
155 *
156 * this macro will print a stack trace if it is executed in an atomic
157 * context (spinlock, irq-handler, ...).
158 *
159 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100160 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 * supposed to.
162 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700163# define might_sleep() \
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200164 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700165#else
Simon Kagstromd8948372009-12-23 11:08:18 +0100166 static inline void __might_sleep(const char *file, int line,
167 int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700168# define might_sleep() do { might_resched(); } while (0)
169#endif
170
Hua Zhong368a5fa2006-06-23 02:05:42 -0700171#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700172
Andrew Morton71a90482011-01-12 16:59:35 -0800173/*
174 * abs() handles unsigned and signed longs, ints, shorts and chars. For all
175 * input types abs() returns a signed long.
176 * abs() should not be used for 64-bit types (s64, u64, long long) - use abs64()
177 * for those.
178 */
179#define abs(x) ({ \
180 long ret; \
181 if (sizeof(x) == sizeof(long)) { \
182 long __x = (x); \
183 ret = (__x < 0) ? -__x : __x; \
184 } else { \
185 int __x = (x); \
186 ret = (__x < 0) ? -__x : __x; \
187 } \
188 ret; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 })
190
Brian Behlendorf658716d2010-10-26 14:23:10 -0700191#define abs64(x) ({ \
192 s64 __x = (x); \
193 (__x < 0) ? -__x : __x; \
194 })
195
Michael S. Tsirkin662bbcb2013-05-26 17:32:23 +0300196#if defined(CONFIG_PROVE_LOCKING) || defined(CONFIG_DEBUG_ATOMIC_SLEEP)
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200197void might_fault(void);
198#else
Michael S. Tsirkin662bbcb2013-05-26 17:32:23 +0300199static inline void might_fault(void) { }
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200200#endif
201
Alan Sterne041c682006-03-27 01:16:30 -0800202extern struct atomic_notifier_head panic_notifier_list;
TAMUKI Shoichic7ff0d92010-08-10 18:03:28 -0700203extern long (*panic_blink)(int state);
Joe Perches9402c952012-01-12 17:17:17 -0800204__printf(1, 2)
Joe Perches4da47852012-01-12 17:17:13 -0800205void panic(const char *fmt, ...)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800206 __noreturn __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800207extern void oops_enter(void);
208extern void oops_exit(void);
Anton Blanchard863a6042010-08-10 18:03:30 -0700209void print_oops_end_marker(void);
Andrew Mortondd287792006-03-23 03:00:57 -0800210extern int oops_may_print(void);
Joe Perches9402c952012-01-12 17:17:17 -0800211void do_exit(long error_code)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800212 __noreturn;
Joe Perches9402c952012-01-12 17:17:17 -0800213void complete_and_exit(struct completion *, long)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800214 __noreturn;
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700215
216/* Internal, do not use. */
217int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
218int __must_check _kstrtol(const char *s, unsigned int base, long *res);
219
220int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
221int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
Eldad Zack4c925d62012-12-17 16:03:04 -0800222
223/**
224 * kstrtoul - convert a string to an unsigned long
225 * @s: The start of the string. The string must be null-terminated, and may also
226 * include a single newline before its terminating null. The first character
227 * may also be a plus sign, but not a minus sign.
228 * @base: The number base to use. The maximum supported base is 16. If base is
229 * given as 0, then the base of the string is automatically detected with the
230 * conventional semantics - If it begins with 0x the number will be parsed as a
231 * hexadecimal (case insensitive), if it otherwise begins with 0, it will be
232 * parsed as an octal number. Otherwise it will be parsed as a decimal.
233 * @res: Where to write the result of the conversion on success.
234 *
235 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
236 * Used as a replacement for the obsolete simple_strtoull. Return code must
237 * be checked.
238*/
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700239static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
240{
241 /*
242 * We want to shortcut function call, but
243 * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
244 */
245 if (sizeof(unsigned long) == sizeof(unsigned long long) &&
246 __alignof__(unsigned long) == __alignof__(unsigned long long))
247 return kstrtoull(s, base, (unsigned long long *)res);
248 else
249 return _kstrtoul(s, base, res);
250}
251
Eldad Zack4c925d62012-12-17 16:03:04 -0800252/**
253 * kstrtol - convert a string to a long
254 * @s: The start of the string. The string must be null-terminated, and may also
255 * include a single newline before its terminating null. The first character
256 * may also be a plus sign or a minus sign.
257 * @base: The number base to use. The maximum supported base is 16. If base is
258 * given as 0, then the base of the string is automatically detected with the
259 * conventional semantics - If it begins with 0x the number will be parsed as a
260 * hexadecimal (case insensitive), if it otherwise begins with 0, it will be
261 * parsed as an octal number. Otherwise it will be parsed as a decimal.
262 * @res: Where to write the result of the conversion on success.
263 *
264 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
265 * Used as a replacement for the obsolete simple_strtoull. Return code must
266 * be checked.
267 */
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700268static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
269{
270 /*
271 * We want to shortcut function call, but
272 * __builtin_types_compatible_p(long, long long) = 0.
273 */
274 if (sizeof(long) == sizeof(long long) &&
275 __alignof__(long) == __alignof__(long long))
276 return kstrtoll(s, base, (long long *)res);
277 else
278 return _kstrtol(s, base, res);
279}
280
281int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
282int __must_check kstrtoint(const char *s, unsigned int base, int *res);
283
284static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
285{
286 return kstrtoull(s, base, res);
287}
288
289static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
290{
291 return kstrtoll(s, base, res);
292}
293
294static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
295{
296 return kstrtouint(s, base, res);
297}
298
299static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
300{
301 return kstrtoint(s, base, res);
302}
303
304int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
305int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
306int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
307int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);
308
Alexey Dobriyanc196e322011-05-24 17:13:31 -0700309int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
310int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
311int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
312int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
313int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
314int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
315int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
316int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
317int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
318int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);
319
320static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
321{
322 return kstrtoull_from_user(s, count, base, res);
323}
324
325static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
326{
327 return kstrtoll_from_user(s, count, base, res);
328}
329
330static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
331{
332 return kstrtouint_from_user(s, count, base, res);
333}
334
335static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
336{
337 return kstrtoint_from_user(s, count, base, res);
338}
339
Joe Perches67d0a072011-10-31 17:13:10 -0700340/* Obsolete, do not use. Use kstrto<foo> instead */
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342extern unsigned long simple_strtoul(const char *,char **,unsigned int);
343extern long simple_strtol(const char *,char **,unsigned int);
344extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
345extern long long simple_strtoll(const char *,char **,unsigned int);
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700346#define strict_strtoul kstrtoul
347#define strict_strtol kstrtol
348#define strict_strtoull kstrtoull
349#define strict_strtoll kstrtoll
350
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700351extern int num_to_str(char *buf, int size, unsigned long long num);
352
Joe Perches67d0a072011-10-31 17:13:10 -0700353/* lib/printf utilities */
354
Joe Perchesb9075fa2011-10-31 17:11:33 -0700355extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
356extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
357extern __printf(3, 4)
358int snprintf(char *buf, size_t size, const char *fmt, ...);
359extern __printf(3, 0)
360int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
361extern __printf(3, 4)
362int scnprintf(char *buf, size_t size, const char *fmt, ...);
363extern __printf(3, 0)
364int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
365extern __printf(2, 3)
366char *kasprintf(gfp_t gfp, const char *fmt, ...);
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700367extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Joe Perches6061d942012-03-23 15:02:16 -0700369extern __scanf(2, 3)
370int sscanf(const char *, const char *, ...);
371extern __scanf(2, 0)
372int vsscanf(const char *, const char *, va_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
374extern int get_option(char **str, int *pint);
375extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700376extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
Trent Piepho5e376612006-05-15 09:44:06 -0700378extern int core_kernel_text(unsigned long addr);
Steven Rostedtcdbe61b2011-05-05 21:14:55 -0400379extern int core_kernel_data(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380extern int __kernel_text_address(unsigned long addr);
381extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700382extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700383
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800384struct pid;
385extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387unsigned long int_sqrt(unsigned long);
388
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389extern void bust_spinlocks(int yes);
390extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700391extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200393extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700394extern int panic_on_io_nmi;
Mitsuo Hayasaka55af7792011-11-29 15:08:36 +0900395extern int sysctl_panic_on_stackoverflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396extern const char *print_tainted(void);
Rusty Russell373d4d02013-01-21 17:17:39 +1030397enum lockdep_ok {
398 LOCKDEP_STILL_OK,
399 LOCKDEP_NOW_UNRELIABLE
400};
401extern void add_taint(unsigned flag, enum lockdep_ok);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700402extern int test_taint(unsigned flag);
403extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800404extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
Tejun Heo2ce802f2011-01-20 12:06:35 +0100406extern bool early_boot_irqs_disabled;
407
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408/* Values used for system_state */
409extern enum system_states {
410 SYSTEM_BOOTING,
411 SYSTEM_RUNNING,
412 SYSTEM_HALT,
413 SYSTEM_POWER_OFF,
414 SYSTEM_RESTART,
415} system_state;
416
Andi Kleen25ddbb12008-10-15 22:01:41 -0700417#define TAINT_PROPRIETARY_MODULE 0
418#define TAINT_FORCED_MODULE 1
419#define TAINT_UNSAFE_SMP 2
420#define TAINT_FORCED_RMMOD 3
421#define TAINT_MACHINE_CHECK 4
422#define TAINT_BAD_PAGE 5
423#define TAINT_USER 6
424#define TAINT_DIE 7
425#define TAINT_OVERRIDDEN_ACPI_TABLE 8
426#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700427#define TAINT_CRAP 10
Ben Hutchings92946bc2010-04-03 19:36:42 +0100428#define TAINT_FIRMWARE_WORKAROUND 11
Ben Hutchings2449b8b2011-10-24 15:12:28 +0200429#define TAINT_OOT_MODULE 12
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
Harvey Harrison3fc95772008-05-14 16:05:49 -0700431extern const char hex_asc[];
432#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
433#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
434
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700435static inline char *hex_byte_pack(char *buf, u8 byte)
Harvey Harrison3fc95772008-05-14 16:05:49 -0700436{
437 *buf++ = hex_asc_hi(byte);
438 *buf++ = hex_asc_lo(byte);
439 return buf;
440}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700441
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700442static inline char * __deprecated pack_hex_byte(char *buf, u8 byte)
443{
444 return hex_byte_pack(buf, byte);
445}
446
Andy Shevchenko903788892010-05-24 14:33:23 -0700447extern int hex_to_bin(char ch);
Mimi Zoharb7804982011-09-20 11:23:49 -0400448extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
Andy Shevchenko903788892010-05-24 14:33:23 -0700449
Andy Shevchenko4cd57732013-06-04 19:46:26 +0300450int mac_pton(const char *s, u8 *mac);
451
Joe Perches8a64f332009-12-14 18:00:25 -0800452/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100453 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500454 * tracing_on/tracing_off and tracing_start()/tracing_stop
455 *
456 * Use tracing_on/tracing_off when you want to quickly turn on or off
457 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900458 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500459 * file, which gives a means for the kernel and userspace to interact.
460 * Place a tracing_off() in the kernel where you want tracing to end.
461 * From user space, examine the trace, and then echo 1 > tracing_on
462 * to continue tracing.
463 *
464 * tracing_stop/tracing_start has slightly more overhead. It is used
465 * by things like suspend to ram where disabling the recording of the
466 * trace is not enough, but tracing must actually stop because things
467 * like calling smp_processor_id() may crash the system.
468 *
469 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100470 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500471#ifdef CONFIG_RING_BUFFER
Steven Rostedt2002c252009-03-05 10:35:56 -0500472/* trace_off_permanent stops recording with no way to bring it back */
473void tracing_off_permanent(void);
Steven Rostedt2002c252009-03-05 10:35:56 -0500474#else
Steven Rostedt2002c252009-03-05 10:35:56 -0500475static inline void tracing_off_permanent(void) { }
Steven Rostedt2002c252009-03-05 10:35:56 -0500476#endif
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200477
478enum ftrace_dump_mode {
479 DUMP_NONE,
480 DUMP_ALL,
481 DUMP_ORIG,
482};
483
Ingo Molnar526211b2009-03-05 10:28:45 +0100484#ifdef CONFIG_TRACING
Steven Rostedt93d68e52012-03-20 12:28:29 -0400485void tracing_on(void);
486void tracing_off(void);
487int tracing_is_on(void);
Steven Rostedt (Red Hat)ad909e22013-03-06 21:45:37 -0500488void tracing_snapshot(void);
489void tracing_snapshot_alloc(void);
Steven Rostedt93d68e52012-03-20 12:28:29 -0400490
Ingo Molnar526211b2009-03-05 10:28:45 +0100491extern void tracing_start(void);
492extern void tracing_stop(void);
493extern void ftrace_off_permanent(void);
494
Joe Perchesb9075fa2011-10-31 17:11:33 -0700495static inline __printf(1, 2)
496void ____trace_printk_check_format(const char *fmt, ...)
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100497{
498}
499#define __trace_printk_check_format(fmt, args...) \
500do { \
501 if (0) \
502 ____trace_printk_check_format(fmt, ##args); \
503} while (0)
504
Ingo Molnar526211b2009-03-05 10:28:45 +0100505/**
506 * trace_printk - printf formatting in the ftrace buffer
507 * @fmt: the printf format for printing
508 *
509 * Note: __trace_printk is an internal function for trace_printk and
510 * the @ip is passed in via the trace_printk macro.
511 *
512 * This function allows a kernel developer to debug fast path sections
513 * that printk is not appropriate for. By scattering in various
514 * printk like tracing in the code, a developer can quickly see
515 * where problems are occurring.
516 *
517 * This is intended as a debugging tool for the developer only.
518 * Please refrain from leaving trace_printks scattered around in
Steven Rostedt (Red Hat)09ae7232013-03-08 21:02:34 -0500519 * your code. (Extra memory is used for special buffers that are
520 * allocated when trace_printk() is used)
Steven Rostedt (Red Hat)9d3c752c2013-03-08 22:11:57 -0500521 *
522 * A little optization trick is done here. If there's only one
523 * argument, there's no need to scan the string for printf formats.
524 * The trace_puts() will suffice. But how can we take advantage of
525 * using trace_puts() when trace_printk() has only one argument?
526 * By stringifying the args and checking the size we can tell
527 * whether or not there are args. __stringify((__VA_ARGS__)) will
528 * turn into "()\0" with a size of 3 when there are no args, anything
529 * else will be bigger. All we need to do is define a string to this,
530 * and then take its size and compare to 3. If it's bigger, use
531 * do_trace_printk() otherwise, optimize it to trace_puts(). Then just
532 * let gcc optimize the rest.
Ingo Molnar526211b2009-03-05 10:28:45 +0100533 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100534
Steven Rostedt (Red Hat)9d3c752c2013-03-08 22:11:57 -0500535#define trace_printk(fmt, ...) \
536do { \
537 char _______STR[] = __stringify((__VA_ARGS__)); \
538 if (sizeof(_______STR) > 3) \
539 do_trace_printk(fmt, ##__VA_ARGS__); \
540 else \
541 trace_puts(fmt); \
542} while (0)
543
544#define do_trace_printk(fmt, args...) \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100545do { \
Steven Rostedt07d777f2011-09-22 14:01:55 -0400546 static const char *trace_printk_fmt \
547 __attribute__((section("__trace_printk_fmt"))) = \
548 __builtin_constant_p(fmt) ? fmt : NULL; \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100549 \
Steven Rostedt07d777f2011-09-22 14:01:55 -0400550 __trace_printk_check_format(fmt, ##args); \
551 \
552 if (__builtin_constant_p(fmt)) \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100553 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
Steven Rostedt07d777f2011-09-22 14:01:55 -0400554 else \
555 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100556} while (0)
557
Joe Perchesb9075fa2011-10-31 17:11:33 -0700558extern __printf(2, 3)
559int __trace_bprintk(unsigned long ip, const char *fmt, ...);
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100560
Joe Perchesb9075fa2011-10-31 17:11:33 -0700561extern __printf(2, 3)
562int __trace_printk(unsigned long ip, const char *fmt, ...);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100563
Steven Rostedt (Red Hat)09ae7232013-03-08 21:02:34 -0500564/**
565 * trace_puts - write a string into the ftrace buffer
566 * @str: the string to record
567 *
568 * Note: __trace_bputs is an internal function for trace_puts and
569 * the @ip is passed in via the trace_puts macro.
570 *
571 * This is similar to trace_printk() but is made for those really fast
572 * paths that a developer wants the least amount of "Heisenbug" affects,
573 * where the processing of the print format is still too much.
574 *
575 * This function allows a kernel developer to debug fast path sections
576 * that printk is not appropriate for. By scattering in various
577 * printk like tracing in the code, a developer can quickly see
578 * where problems are occurring.
579 *
580 * This is intended as a debugging tool for the developer only.
581 * Please refrain from leaving trace_puts scattered around in
582 * your code. (Extra memory is used for special buffers that are
583 * allocated when trace_puts() is used)
584 *
585 * Returns: 0 if nothing was written, positive # if string was.
586 * (1 when __trace_bputs is used, strlen(str) when __trace_puts is used)
587 */
588
Steven Rostedt (Red Hat)09ae7232013-03-08 21:02:34 -0500589#define trace_puts(str) ({ \
590 static const char *trace_printk_fmt \
591 __attribute__((section("__trace_printk_fmt"))) = \
592 __builtin_constant_p(str) ? str : NULL; \
593 \
594 if (__builtin_constant_p(str)) \
595 __trace_bputs(_THIS_IP_, trace_printk_fmt); \
596 else \
597 __trace_puts(_THIS_IP_, str, strlen(str)); \
598})
Steven Rostedtbcf312c2013-05-02 11:26:13 -0400599extern int __trace_bputs(unsigned long ip, const char *str);
600extern int __trace_puts(unsigned long ip, const char *str, int size);
Steven Rostedt (Red Hat)09ae7232013-03-08 21:02:34 -0500601
Steven Rostedt (Red Hat)c142be82013-03-13 09:55:57 -0400602extern void trace_dump_stack(int skip);
Steven Rostedt03889382009-12-11 09:48:22 -0500603
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100604/*
605 * The double __builtin_constant_p is because gcc will give us an error
606 * if we try to allocate the static variable to fmt if it is not a
607 * constant. Even with the outer if statement.
608 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100609#define ftrace_vprintk(fmt, vargs) \
610do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100611 if (__builtin_constant_p(fmt)) { \
612 static const char *trace_printk_fmt \
613 __attribute__((section("__trace_printk_fmt"))) = \
614 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100615 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100616 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
617 } else \
618 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100619} while (0)
620
Ingo Molnar526211b2009-03-05 10:28:45 +0100621extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100622__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
623
624extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100625__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100626
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200627extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
Ingo Molnar526211b2009-03-05 10:28:45 +0100628#else
Ingo Molnar526211b2009-03-05 10:28:45 +0100629static inline void tracing_start(void) { }
630static inline void tracing_stop(void) { }
631static inline void ftrace_off_permanent(void) { }
Steven Rostedte36c5452009-12-14 15:58:33 -0500632static inline void trace_dump_stack(void) { }
Steven Rostedt93d68e52012-03-20 12:28:29 -0400633
634static inline void tracing_on(void) { }
635static inline void tracing_off(void) { }
636static inline int tracing_is_on(void) { return 0; }
Steven Rostedt (Red Hat)ad909e22013-03-06 21:45:37 -0500637static inline void tracing_snapshot(void) { }
638static inline void tracing_snapshot_alloc(void) { }
Steven Rostedt93d68e52012-03-20 12:28:29 -0400639
Michal Hocko60efc152012-10-25 15:41:51 +0200640static inline __printf(1, 2)
641int trace_printk(const char *fmt, ...)
Ingo Molnar526211b2009-03-05 10:28:45 +0100642{
643 return 0;
644}
645static inline int
646ftrace_vprintk(const char *fmt, va_list ap)
647{
648 return 0;
649}
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200650static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100651#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100652
653/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700654 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 * strict type-checking.. See the
656 * "unnecessary" pointer comparison.
657 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700658#define min(x, y) ({ \
659 typeof(x) _min1 = (x); \
660 typeof(y) _min2 = (y); \
661 (void) (&_min1 == &_min2); \
662 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700664#define max(x, y) ({ \
665 typeof(x) _max1 = (x); \
666 typeof(y) _max2 = (y); \
667 (void) (&_max1 == &_max2); \
668 _max1 > _max2 ? _max1 : _max2; })
669
Hagen Paul Pfeiferf27c85c2010-10-26 14:22:21 -0700670#define min3(x, y, z) ({ \
671 typeof(x) _min1 = (x); \
672 typeof(y) _min2 = (y); \
673 typeof(z) _min3 = (z); \
674 (void) (&_min1 == &_min2); \
675 (void) (&_min1 == &_min3); \
676 _min1 < _min2 ? (_min1 < _min3 ? _min1 : _min3) : \
677 (_min2 < _min3 ? _min2 : _min3); })
678
679#define max3(x, y, z) ({ \
680 typeof(x) _max1 = (x); \
681 typeof(y) _max2 = (y); \
682 typeof(z) _max3 = (z); \
683 (void) (&_max1 == &_max2); \
684 (void) (&_max1 == &_max3); \
685 _max1 > _max2 ? (_max1 > _max3 ? _max1 : _max3) : \
686 (_max2 > _max3 ? _max2 : _max3); })
687
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700688/**
Martin K. Petersenc8bf1332010-09-10 20:07:38 +0200689 * min_not_zero - return the minimum that is _not_ zero, unless both are zero
690 * @x: value1
691 * @y: value2
692 */
693#define min_not_zero(x, y) ({ \
694 typeof(x) __x = (x); \
695 typeof(y) __y = (y); \
696 __x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
697
698/**
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700699 * clamp - return a value clamped to a given range with strict typechecking
700 * @val: current value
701 * @min: minimum allowable value
702 * @max: maximum allowable value
703 *
704 * This macro does strict typechecking of min/max to make sure they are of the
705 * same type as val. See the unnecessary pointer comparisons.
706 */
707#define clamp(val, min, max) ({ \
708 typeof(val) __val = (val); \
709 typeof(min) __min = (min); \
710 typeof(max) __max = (max); \
711 (void) (&__val == &__min); \
712 (void) (&__val == &__max); \
713 __val = __val < __min ? __min: __val; \
714 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
716/*
717 * ..and if you can't take the strict
718 * types, you can specify one yourself.
719 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700720 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700722#define min_t(type, x, y) ({ \
723 type __min1 = (x); \
724 type __min2 = (y); \
725 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700727#define max_t(type, x, y) ({ \
728 type __max1 = (x); \
729 type __max2 = (y); \
730 __max1 > __max2 ? __max1: __max2; })
731
732/**
733 * clamp_t - return a value clamped to a given range using a given type
734 * @type: the type of variable to use
735 * @val: current value
736 * @min: minimum allowable value
737 * @max: maximum allowable value
738 *
739 * This macro does no typechecking and uses temporary variables of type
740 * 'type' to make all the comparisons.
741 */
742#define clamp_t(type, val, min, max) ({ \
743 type __val = (val); \
744 type __min = (min); \
745 type __max = (max); \
746 __val = __val < __min ? __min: __val; \
747 __val > __max ? __max: __val; })
748
749/**
750 * clamp_val - return a value clamped to a given range using val's type
751 * @val: current value
752 * @min: minimum allowable value
753 * @max: maximum allowable value
754 *
755 * This macro does no typechecking and uses temporary variables of whatever
756 * type the input argument 'val' is. This is useful when val is an unsigned
757 * type and min and max are literals that will otherwise be assigned a signed
758 * integer type.
759 */
760#define clamp_val(val, min, max) ({ \
761 typeof(val) __val = (val); \
762 typeof(val) __min = (min); \
763 typeof(val) __max = (max); \
764 __val = __val < __min ? __min: __val; \
765 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
Wu Fengguang91f68b72009-01-07 18:09:12 -0800767
768/*
769 * swap - swap value of @a and @b
770 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800771#define swap(a, b) \
772 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800773
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774/**
775 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 * @ptr: the pointer to the member.
777 * @type: the type of the container struct this is embedded in.
778 * @member: the name of the member within the struct.
779 *
780 */
781#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700782 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
783 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Arnaud Lacombeb9d4f422011-07-25 17:13:03 -0700785/* Trap pasters of __FUNCTION__ at compile-time */
786#define __FUNCTION__ (__func__)
787
Arnaud Lacombeb9d4f422011-07-25 17:13:03 -0700788/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
789#ifdef CONFIG_FTRACE_MCOUNT_RECORD
790# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
791#endif
WANG Cong9d00f922011-07-25 17:13:02 -0700792
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793#endif