]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/kernel.h
fs, proc: unconditional cond_resched when reading smaps
[mirror_ubuntu-bionic-kernel.git] / include / linux / kernel.h
CommitLineData
1da177e4
LT
1#ifndef _LINUX_KERNEL_H
2#define _LINUX_KERNEL_H
3
1da177e4
LT
4
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>
f0d1b0b3 11#include <linux/log2.h>
e0deaff4 12#include <linux/typecheck.h>
968ab183 13#include <linux/printk.h>
c7acec71 14#include <linux/build_bug.h>
1da177e4 15#include <asm/byteorder.h>
607ca46e 16#include <uapi/linux/kernel.h>
1da177e4 17
4be929be
AD
18#define USHRT_MAX ((u16)(~0U))
19#define SHRT_MAX ((s16)(USHRT_MAX>>1))
20#define SHRT_MIN ((s16)(-SHRT_MAX - 1))
1da177e4
LT
21#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)
111ebb6e
OH
27#define LLONG_MAX ((long long)(~0ULL>>1))
28#define LLONG_MIN (-LLONG_MAX - 1)
29#define ULLONG_MAX (~0ULL)
a3860c1c 30#define SIZE_MAX (~(size_t)0)
1da177e4 31
89a07141
AE
32#define U8_MAX ((u8)~0U)
33#define S8_MAX ((s8)(U8_MAX>>1))
34#define S8_MIN ((s8)(-S8_MAX - 1))
35#define U16_MAX ((u16)~0U)
36#define S16_MAX ((s16)(U16_MAX>>1))
37#define S16_MIN ((s16)(-S16_MAX - 1))
38#define U32_MAX ((u32)~0U)
39#define S32_MAX ((s32)(U32_MAX>>1))
40#define S32_MIN ((s32)(-S32_MAX - 1))
41#define U64_MAX ((u64)~0ULL)
42#define S64_MAX ((s64)(U64_MAX>>1))
43#define S64_MIN ((s64)(-S64_MAX - 1))
44
1da177e4
LT
45#define STACK_MAGIC 0xdeadbeef
46
44696908
DM
47#define REPEAT_BYTE(x) ((~0ul / 0xff) * (x))
48
3ca45a46 49/* @a is a power of 2 value */
a79ff731 50#define ALIGN(x, a) __ALIGN_KERNEL((x), (a))
ed067d4a 51#define ALIGN_DOWN(x, a) __ALIGN_KERNEL((x) - ((a) - 1), (a))
9f93ff5b 52#define __ALIGN_MASK(x, mask) __ALIGN_KERNEL_MASK((x), (mask))
a83308e6 53#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
f10db627 54#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
2ea58144 55
d3849953
CH
56/* generic data direction definitions */
57#define READ 0
58#define WRITE 1
59
c5e631cf
RR
60#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
61
3ed605bc
GP
62#define u64_to_user_ptr(x) ( \
63{ \
64 typecheck(u64, x); \
65 (void __user *)(uintptr_t)x; \
66} \
67)
68
9b3be9f9
YL
69/*
70 * This looks more complex than it should be. But we need to
71 * get the type for the ~ right in round_down (it needs to be
72 * as wide as the result!), and we want to evaluate the macro
73 * arguments just once each.
74 */
75#define __round_mask(x, y) ((__typeof__(x))((y)-1))
76#define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
77#define round_down(x, y) ((x) & ~__round_mask(x, y))
78
4552d5dc 79#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
b5d3755a 80#define DIV_ROUND_UP __KERNEL_DIV_ROUND_UP
36a26c69
NB
81#define DIV_ROUND_UP_ULL(ll,d) \
82 ({ unsigned long long _tmp = (ll)+(d)-1; do_div(_tmp, d); _tmp; })
83
84#if BITS_PER_LONG == 32
85# define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP_ULL(ll, d)
86#else
87# define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP(ll,d)
88#endif
074e61ec
JM
89
90/* The `const' in roundup() prevents gcc-3.3 from calling __divdi3 */
b28efd54
EP
91#define roundup(x, y) ( \
92{ \
6070bf35 93 const typeof(y) __y = y; \
b28efd54
EP
94 (((x) + (__y - 1)) / __y) * __y; \
95} \
96)
686a0f3d
EP
97#define rounddown(x, y) ( \
98{ \
99 typeof(x) __x = (x); \
100 __x - (__x % (y)); \
101} \
102)
b6d86d3d
GR
103
104/*
4f5901f5
NS
105 * Divide positive or negative dividend by positive or negative divisor
106 * and round to closest integer. Result is undefined for negative
107 * divisors if he dividend variable type is unsigned and for negative
108 * dividends if the divisor variable type is unsigned.
b6d86d3d 109 */
9fe06081
DW
110#define DIV_ROUND_CLOSEST(x, divisor)( \
111{ \
b6d86d3d
GR
112 typeof(x) __x = x; \
113 typeof(divisor) __d = divisor; \
c4e18497 114 (((typeof(x))-1) > 0 || \
4f5901f5
NS
115 ((typeof(divisor))-1) > 0 || \
116 (((__x) > 0) == ((__d) > 0))) ? \
b6d86d3d
GR
117 (((__x) + ((__d) / 2)) / (__d)) : \
118 (((__x) - ((__d) / 2)) / (__d)); \
9fe06081
DW
119} \
120)
f766093e
JM
121/*
122 * Same as above but for u64 dividends. divisor must be a 32-bit
123 * number.
124 */
125#define DIV_ROUND_CLOSEST_ULL(x, divisor)( \
126{ \
127 typeof(divisor) __d = divisor; \
128 unsigned long long _tmp = (x) + (__d) / 2; \
129 do_div(_tmp, __d); \
130 _tmp; \
131} \
132)
1da177e4 133
9993bc63
SQ
134/*
135 * Multiplies an integer by a fraction, while avoiding unnecessary
136 * overflow or loss of precision.
137 */
138#define mult_frac(x, numer, denom)( \
139{ \
140 typeof(x) quot = (x) / (denom); \
141 typeof(x) rem = (x) % (denom); \
142 (quot * (numer)) + ((rem * (numer)) / (denom)); \
143} \
144)
145
146
ca31e146
EGM
147#define _RET_IP_ (unsigned long)__builtin_return_address(0)
148#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
149
90c699a9 150#ifdef CONFIG_LBDAF
2da96acd
JA
151# include <asm/div64.h>
152# define sector_div(a, b) do_div(a, b)
153#else
154# define sector_div(n, b)( \
155{ \
156 int _res; \
157 _res = (n) % (b); \
158 (n) /= (b); \
159 _res; \
160} \
161)
162#endif
163
218e180e
AM
164/**
165 * upper_32_bits - return bits 32-63 of a number
166 * @n: the number we're accessing
167 *
168 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
169 * the "right shift count >= width of type" warning when that quantity is
170 * 32-bits.
171 */
172#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
173
204b885e
JR
174/**
175 * lower_32_bits - return bits 0-31 of a number
176 * @n: the number we're accessing
177 */
178#define lower_32_bits(n) ((u32)(n))
179
1da177e4 180struct completion;
df2e71fb 181struct pt_regs;
182struct user;
1da177e4 183
070cb065
UKK
184#ifdef CONFIG_PREEMPT_VOLUNTARY
185extern int _cond_resched(void);
186# define might_resched() _cond_resched()
187#else
188# define might_resched() do { } while (0)
189#endif
190
d902db1e 191#ifdef CONFIG_DEBUG_ATOMIC_SLEEP
3427445a 192 void ___might_sleep(const char *file, int line, int preempt_offset);
d894837f 193 void __might_sleep(const char *file, int line, int preempt_offset);
1da177e4
LT
194/**
195 * might_sleep - annotation for functions that can sleep
196 *
197 * this macro will print a stack trace if it is executed in an atomic
198 * context (spinlock, irq-handler, ...).
199 *
200 * This is a useful debugging help to be able to catch problems early and not
e20ec991 201 * be bitten later when the calling function happens to sleep when it is not
1da177e4
LT
202 * supposed to.
203 */
f8cbd99b 204# define might_sleep() \
e4aafea2 205 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
00845eb9 206# define sched_annotate_sleep() (current->task_state_change = 0)
1da177e4 207#else
3427445a
PZ
208 static inline void ___might_sleep(const char *file, int line,
209 int preempt_offset) { }
d894837f
SK
210 static inline void __might_sleep(const char *file, int line,
211 int preempt_offset) { }
f8cbd99b 212# define might_sleep() do { might_resched(); } while (0)
1029a2b5 213# define sched_annotate_sleep() do { } while (0)
1da177e4
LT
214#endif
215
368a5fa1 216#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
f8cbd99b 217
c8299cb6
MN
218/**
219 * abs - return absolute value of an argument
8f57e4d9
MN
220 * @x: the value. If it is unsigned type, it is converted to signed type first.
221 * char is treated as if it was signed (regardless of whether it really is)
222 * but the macro's return type is preserved as char.
c8299cb6 223 *
8f57e4d9 224 * Return: an absolute value of x.
71a90484 225 */
8f57e4d9
MN
226#define abs(x) __abs_choose_expr(x, long long, \
227 __abs_choose_expr(x, long, \
228 __abs_choose_expr(x, int, \
229 __abs_choose_expr(x, short, \
230 __abs_choose_expr(x, char, \
231 __builtin_choose_expr( \
232 __builtin_types_compatible_p(typeof(x), char), \
233 (char)({ signed char __x = (x); __x<0?-__x:__x; }), \
234 ((void)0)))))))
235
236#define __abs_choose_expr(x, type, other) __builtin_choose_expr( \
237 __builtin_types_compatible_p(typeof(x), signed type) || \
238 __builtin_types_compatible_p(typeof(x), unsigned type), \
239 ({ signed type __x = (x); __x < 0 ? -__x : __x; }), other)
c8299cb6 240
89770b0a
DB
241/**
242 * reciprocal_scale - "scale" a value into range [0, ep_ro)
243 * @val: value
244 * @ep_ro: right open interval endpoint
245 *
246 * Perform a "reciprocal multiplication" in order to "scale" a value into
247 * range [0, ep_ro), where the upper interval endpoint is right-open.
248 * This is useful, e.g. for accessing a index of an array containing
249 * ep_ro elements, for example. Think of it as sort of modulus, only that
250 * the result isn't that of modulo. ;) Note that if initial input is a
251 * small value, then result will return 0.
252 *
253 * Return: a result based on val in interval [0, ep_ro).
254 */
255static inline u32 reciprocal_scale(u32 val, u32 ep_ro)
256{
257 return (u32)(((u64) val * ep_ro) >> 32);
258}
259
386e7906
AL
260#if defined(CONFIG_MMU) && \
261 (defined(CONFIG_PROVE_LOCKING) || defined(CONFIG_DEBUG_ATOMIC_SLEEP))
9ec23531
DH
262#define might_fault() __might_fault(__FILE__, __LINE__)
263void __might_fault(const char *file, int line);
3ee1afa3 264#else
662bbcb2 265static inline void might_fault(void) { }
3ee1afa3
NP
266#endif
267
e041c683 268extern struct atomic_notifier_head panic_notifier_list;
c7ff0d9c 269extern long (*panic_blink)(int state);
9402c95f 270__printf(1, 2)
9af6528e 271void panic(const char *fmt, ...) __noreturn __cold;
ebc41f20 272void nmi_panic(struct pt_regs *regs, const char *msg);
dd287796
AM
273extern void oops_enter(void);
274extern void oops_exit(void);
863a6049 275void print_oops_end_marker(void);
dd287796 276extern int oops_may_print(void);
9af6528e
PZ
277void do_exit(long error_code) __noreturn;
278void complete_and_exit(struct completion *, long) __noreturn;
33ee3b2e 279
7a46ec0e
KC
280#ifdef CONFIG_ARCH_HAS_REFCOUNT
281void refcount_error_report(struct pt_regs *regs, const char *err);
282#else
283static inline void refcount_error_report(struct pt_regs *regs, const char *err)
284{ }
285#endif
286
33ee3b2e
AD
287/* Internal, do not use. */
288int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
289int __must_check _kstrtol(const char *s, unsigned int base, long *res);
290
291int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
292int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
4c925d60
EZ
293
294/**
295 * kstrtoul - convert a string to an unsigned long
296 * @s: The start of the string. The string must be null-terminated, and may also
297 * include a single newline before its terminating null. The first character
298 * may also be a plus sign, but not a minus sign.
299 * @base: The number base to use. The maximum supported base is 16. If base is
300 * given as 0, then the base of the string is automatically detected with the
301 * conventional semantics - If it begins with 0x the number will be parsed as a
302 * hexadecimal (case insensitive), if it otherwise begins with 0, it will be
303 * parsed as an octal number. Otherwise it will be parsed as a decimal.
304 * @res: Where to write the result of the conversion on success.
305 *
306 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
307 * Used as a replacement for the obsolete simple_strtoull. Return code must
308 * be checked.
309*/
33ee3b2e
AD
310static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
311{
312 /*
313 * We want to shortcut function call, but
314 * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
315 */
316 if (sizeof(unsigned long) == sizeof(unsigned long long) &&
317 __alignof__(unsigned long) == __alignof__(unsigned long long))
318 return kstrtoull(s, base, (unsigned long long *)res);
319 else
320 return _kstrtoul(s, base, res);
321}
322
4c925d60
EZ
323/**
324 * kstrtol - convert a string to a long
325 * @s: The start of the string. The string must be null-terminated, and may also
326 * include a single newline before its terminating null. The first character
327 * may also be a plus sign or a minus sign.
328 * @base: The number base to use. The maximum supported base is 16. If base is
329 * given as 0, then the base of the string is automatically detected with the
330 * conventional semantics - If it begins with 0x the number will be parsed as a
331 * hexadecimal (case insensitive), if it otherwise begins with 0, it will be
332 * parsed as an octal number. Otherwise it will be parsed as a decimal.
333 * @res: Where to write the result of the conversion on success.
334 *
335 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
336 * Used as a replacement for the obsolete simple_strtoull. Return code must
337 * be checked.
338 */
33ee3b2e
AD
339static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
340{
341 /*
342 * We want to shortcut function call, but
343 * __builtin_types_compatible_p(long, long long) = 0.
344 */
345 if (sizeof(long) == sizeof(long long) &&
346 __alignof__(long) == __alignof__(long long))
347 return kstrtoll(s, base, (long long *)res);
348 else
349 return _kstrtol(s, base, res);
350}
351
352int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
353int __must_check kstrtoint(const char *s, unsigned int base, int *res);
354
355static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
356{
357 return kstrtoull(s, base, res);
358}
359
360static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
361{
362 return kstrtoll(s, base, res);
363}
364
365static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
366{
367 return kstrtouint(s, base, res);
368}
369
370static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
371{
372 return kstrtoint(s, base, res);
373}
374
375int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
376int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
377int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
378int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);
ef951599 379int __must_check kstrtobool(const char *s, bool *res);
33ee3b2e 380
c196e32a
AD
381int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
382int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
383int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
384int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
385int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
386int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
387int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
388int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
389int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
390int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);
ef951599 391int __must_check kstrtobool_from_user(const char __user *s, size_t count, bool *res);
c196e32a
AD
392
393static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
394{
395 return kstrtoull_from_user(s, count, base, res);
396}
397
398static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
399{
400 return kstrtoll_from_user(s, count, base, res);
401}
402
403static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
404{
405 return kstrtouint_from_user(s, count, base, res);
406}
407
408static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
409{
410 return kstrtoint_from_user(s, count, base, res);
411}
412
67d0a075
JP
413/* Obsolete, do not use. Use kstrto<foo> instead */
414
1da177e4
LT
415extern unsigned long simple_strtoul(const char *,char **,unsigned int);
416extern long simple_strtol(const char *,char **,unsigned int);
417extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
418extern long long simple_strtoll(const char *,char **,unsigned int);
33ee3b2e 419
1ac101a5
KH
420extern int num_to_str(char *buf, int size, unsigned long long num);
421
67d0a075
JP
422/* lib/printf utilities */
423
b9075fa9
JP
424extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
425extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
426extern __printf(3, 4)
427int snprintf(char *buf, size_t size, const char *fmt, ...);
428extern __printf(3, 0)
429int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
430extern __printf(3, 4)
431int scnprintf(char *buf, size_t size, const char *fmt, ...);
432extern __printf(3, 0)
433int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
48a27055 434extern __printf(2, 3) __malloc
b9075fa9 435char *kasprintf(gfp_t gfp, const char *fmt, ...);
48a27055 436extern __printf(2, 0) __malloc
8db14860 437char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
0a9df786
RV
438extern __printf(2, 0)
439const char *kvasprintf_const(gfp_t gfp, const char *fmt, va_list args);
1da177e4 440
6061d949
JP
441extern __scanf(2, 3)
442int sscanf(const char *, const char *, ...);
443extern __scanf(2, 0)
444int vsscanf(const char *, const char *, va_list);
1da177e4
LT
445
446extern int get_option(char **str, int *pint);
447extern char *get_options(const char *str, int nints, int *ints);
d974ae37 448extern unsigned long long memparse(const char *ptr, char **retptr);
6ccc72b8 449extern bool parse_option_str(const char *str, const char *option);
f51b17c8 450extern char *next_arg(char *args, char **param, char **val);
1da177e4 451
5e376613 452extern int core_kernel_text(unsigned long addr);
cdbe61bf 453extern int core_kernel_data(unsigned long addr);
1da177e4
LT
454extern int __kernel_text_address(unsigned long addr);
455extern int kernel_text_address(unsigned long addr);
ab7476cf 456extern int func_ptr_is_kernel_text(void *ptr);
ab7476cf 457
1da177e4
LT
458unsigned long int_sqrt(unsigned long);
459
1da177e4
LT
460extern void bust_spinlocks(int yes);
461extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
aa727107 462extern int panic_timeout;
1da177e4 463extern int panic_on_oops;
8da5adda 464extern int panic_on_unrecovered_nmi;
5211a242 465extern int panic_on_io_nmi;
9e3961a0 466extern int panic_on_warn;
088e9d25 467extern int sysctl_panic_on_rcu_stall;
55af7796 468extern int sysctl_panic_on_stackoverflow;
5375b708
HD
469
470extern bool crash_kexec_post_notifiers;
471
1717f209
HK
472/*
473 * panic_cpu is used for synchronizing panic() and crash_kexec() execution. It
474 * holds a CPU number which is executing panic() currently. A value of
475 * PANIC_CPU_INVALID means no CPU has entered panic() or crash_kexec().
476 */
477extern atomic_t panic_cpu;
478#define PANIC_CPU_INVALID -1
479
5800dc3c
JB
480/*
481 * Only to be used by arch init code. If the user over-wrote the default
482 * CONFIG_PANIC_TIMEOUT, honor it.
483 */
484static inline void set_arch_panic_timeout(int timeout, int arch_default_timeout)
485{
486 if (panic_timeout == arch_default_timeout)
487 panic_timeout = timeout;
488}
1da177e4 489extern const char *print_tainted(void);
373d4d09
RR
490enum lockdep_ok {
491 LOCKDEP_STILL_OK,
492 LOCKDEP_NOW_UNRELIABLE
493};
494extern void add_taint(unsigned flag, enum lockdep_ok);
25ddbb18
AK
495extern int test_taint(unsigned flag);
496extern unsigned long get_taint(void);
b920de1b 497extern int root_mountflags;
1da177e4 498
2ce802f6
TH
499extern bool early_boot_irqs_disabled;
500
69a78ff2
TG
501/*
502 * Values used for system_state. Ordering of the states must not be changed
503 * as code checks for <, <=, >, >= STATE.
504 */
1da177e4
LT
505extern enum system_states {
506 SYSTEM_BOOTING,
69a78ff2 507 SYSTEM_SCHEDULING,
1da177e4
LT
508 SYSTEM_RUNNING,
509 SYSTEM_HALT,
510 SYSTEM_POWER_OFF,
511 SYSTEM_RESTART,
512} system_state;
513
25ddbb18
AK
514#define TAINT_PROPRIETARY_MODULE 0
515#define TAINT_FORCED_MODULE 1
8c90487c 516#define TAINT_CPU_OUT_OF_SPEC 2
25ddbb18
AK
517#define TAINT_FORCED_RMMOD 3
518#define TAINT_MACHINE_CHECK 4
519#define TAINT_BAD_PAGE 5
520#define TAINT_USER 6
521#define TAINT_DIE 7
522#define TAINT_OVERRIDDEN_ACPI_TABLE 8
523#define TAINT_WARN 9
26e9a397 524#define TAINT_CRAP 10
92946bc7 525#define TAINT_FIRMWARE_WORKAROUND 11
2449b8ba 526#define TAINT_OOT_MODULE 12
66cc69e3 527#define TAINT_UNSIGNED_MODULE 13
69361eef 528#define TAINT_SOFTLOCKUP 14
c5f45465 529#define TAINT_LIVEPATCH 15
7fd8329b
PM
530#define TAINT_FLAGS_COUNT 16
531
532struct taint_flag {
5eb7c0d0
LF
533 char c_true; /* character printed when tainted */
534 char c_false; /* character printed when not tainted */
7fd8329b
PM
535 bool module; /* also show as a per-module taint flag */
536};
537
538extern const struct taint_flag taint_flags[TAINT_FLAGS_COUNT];
1da177e4 539
3fc95772
HH
540extern const char hex_asc[];
541#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
542#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
543
55036ba7 544static inline char *hex_byte_pack(char *buf, u8 byte)
3fc95772
HH
545{
546 *buf++ = hex_asc_hi(byte);
547 *buf++ = hex_asc_lo(byte);
548 return buf;
549}
99eaf3c4 550
c26d436c
AN
551extern const char hex_asc_upper[];
552#define hex_asc_upper_lo(x) hex_asc_upper[((x) & 0x0f)]
553#define hex_asc_upper_hi(x) hex_asc_upper[((x) & 0xf0) >> 4]
554
555static inline char *hex_byte_pack_upper(char *buf, u8 byte)
556{
557 *buf++ = hex_asc_upper_hi(byte);
558 *buf++ = hex_asc_upper_lo(byte);
559 return buf;
560}
561
90378889 562extern int hex_to_bin(char ch);
b7804983 563extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
53d91c5c 564extern char *bin2hex(char *dst, const void *src, size_t count);
90378889 565
a69f5edb 566bool mac_pton(const char *s, u8 *mac);
4cd5773a 567
526211bc
IM
568/*
569 * General tracing related utility functions - trace_printk(),
2002c258
SR
570 * tracing_on/tracing_off and tracing_start()/tracing_stop
571 *
572 * Use tracing_on/tracing_off when you want to quickly turn on or off
573 * tracing. It simply enables or disables the recording of the trace events.
156f5a78 574 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
2002c258
SR
575 * file, which gives a means for the kernel and userspace to interact.
576 * Place a tracing_off() in the kernel where you want tracing to end.
577 * From user space, examine the trace, and then echo 1 > tracing_on
578 * to continue tracing.
579 *
580 * tracing_stop/tracing_start has slightly more overhead. It is used
581 * by things like suspend to ram where disabling the recording of the
582 * trace is not enough, but tracing must actually stop because things
583 * like calling smp_processor_id() may crash the system.
584 *
585 * Most likely, you want to use tracing_on/tracing_off.
526211bc 586 */
cecbca96
FW
587
588enum ftrace_dump_mode {
589 DUMP_NONE,
590 DUMP_ALL,
591 DUMP_ORIG,
592};
593
526211bc 594#ifdef CONFIG_TRACING
93d68e52
SR
595void tracing_on(void);
596void tracing_off(void);
597int tracing_is_on(void);
ad909e21
SRRH
598void tracing_snapshot(void);
599void tracing_snapshot_alloc(void);
93d68e52 600
526211bc
IM
601extern void tracing_start(void);
602extern void tracing_stop(void);
526211bc 603
b9075fa9
JP
604static inline __printf(1, 2)
605void ____trace_printk_check_format(const char *fmt, ...)
769b0441
FW
606{
607}
608#define __trace_printk_check_format(fmt, args...) \
609do { \
610 if (0) \
611 ____trace_printk_check_format(fmt, ##args); \
612} while (0)
613
526211bc
IM
614/**
615 * trace_printk - printf formatting in the ftrace buffer
616 * @fmt: the printf format for printing
617 *
618 * Note: __trace_printk is an internal function for trace_printk and
619 * the @ip is passed in via the trace_printk macro.
620 *
621 * This function allows a kernel developer to debug fast path sections
622 * that printk is not appropriate for. By scattering in various
623 * printk like tracing in the code, a developer can quickly see
624 * where problems are occurring.
625 *
626 * This is intended as a debugging tool for the developer only.
627 * Please refrain from leaving trace_printks scattered around in
09ae7234
SRRH
628 * your code. (Extra memory is used for special buffers that are
629 * allocated when trace_printk() is used)
9d3c752c
SRRH
630 *
631 * A little optization trick is done here. If there's only one
632 * argument, there's no need to scan the string for printf formats.
633 * The trace_puts() will suffice. But how can we take advantage of
634 * using trace_puts() when trace_printk() has only one argument?
635 * By stringifying the args and checking the size we can tell
636 * whether or not there are args. __stringify((__VA_ARGS__)) will
637 * turn into "()\0" with a size of 3 when there are no args, anything
638 * else will be bigger. All we need to do is define a string to this,
639 * and then take its size and compare to 3. If it's bigger, use
640 * do_trace_printk() otherwise, optimize it to trace_puts(). Then just
641 * let gcc optimize the rest.
526211bc 642 */
769b0441 643
9d3c752c
SRRH
644#define trace_printk(fmt, ...) \
645do { \
646 char _______STR[] = __stringify((__VA_ARGS__)); \
647 if (sizeof(_______STR) > 3) \
648 do_trace_printk(fmt, ##__VA_ARGS__); \
649 else \
650 trace_puts(fmt); \
651} while (0)
652
653#define do_trace_printk(fmt, args...) \
769b0441 654do { \
3debb0a9 655 static const char *trace_printk_fmt __used \
07d777fe
SR
656 __attribute__((section("__trace_printk_fmt"))) = \
657 __builtin_constant_p(fmt) ? fmt : NULL; \
658 \
769b0441 659 __trace_printk_check_format(fmt, ##args); \
48ead020 660 \
07d777fe 661 if (__builtin_constant_p(fmt)) \
48ead020 662 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
07d777fe
SR
663 else \
664 __trace_printk(_THIS_IP_, fmt, ##args); \
769b0441
FW
665} while (0)
666
b9075fa9
JP
667extern __printf(2, 3)
668int __trace_bprintk(unsigned long ip, const char *fmt, ...);
48ead020 669
b9075fa9
JP
670extern __printf(2, 3)
671int __trace_printk(unsigned long ip, const char *fmt, ...);
769b0441 672
09ae7234
SRRH
673/**
674 * trace_puts - write a string into the ftrace buffer
675 * @str: the string to record
676 *
677 * Note: __trace_bputs is an internal function for trace_puts and
678 * the @ip is passed in via the trace_puts macro.
679 *
680 * This is similar to trace_printk() but is made for those really fast
681 * paths that a developer wants the least amount of "Heisenbug" affects,
682 * where the processing of the print format is still too much.
683 *
684 * This function allows a kernel developer to debug fast path sections
685 * that printk is not appropriate for. By scattering in various
686 * printk like tracing in the code, a developer can quickly see
687 * where problems are occurring.
688 *
689 * This is intended as a debugging tool for the developer only.
690 * Please refrain from leaving trace_puts scattered around in
691 * your code. (Extra memory is used for special buffers that are
692 * allocated when trace_puts() is used)
693 *
694 * Returns: 0 if nothing was written, positive # if string was.
695 * (1 when __trace_bputs is used, strlen(str) when __trace_puts is used)
696 */
697
09ae7234 698#define trace_puts(str) ({ \
3debb0a9 699 static const char *trace_printk_fmt __used \
09ae7234
SRRH
700 __attribute__((section("__trace_printk_fmt"))) = \
701 __builtin_constant_p(str) ? str : NULL; \
702 \
703 if (__builtin_constant_p(str)) \
704 __trace_bputs(_THIS_IP_, trace_printk_fmt); \
705 else \
706 __trace_puts(_THIS_IP_, str, strlen(str)); \
707})
bcf312cf
SR
708extern int __trace_bputs(unsigned long ip, const char *str);
709extern int __trace_puts(unsigned long ip, const char *str, int size);
09ae7234 710
c142be8e 711extern void trace_dump_stack(int skip);
03889384 712
48ead020
FW
713/*
714 * The double __builtin_constant_p is because gcc will give us an error
715 * if we try to allocate the static variable to fmt if it is not a
716 * constant. Even with the outer if statement.
717 */
769b0441
FW
718#define ftrace_vprintk(fmt, vargs) \
719do { \
48ead020 720 if (__builtin_constant_p(fmt)) { \
3debb0a9 721 static const char *trace_printk_fmt __used \
48ead020
FW
722 __attribute__((section("__trace_printk_fmt"))) = \
723 __builtin_constant_p(fmt) ? fmt : NULL; \
7bffc23e 724 \
48ead020
FW
725 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
726 } else \
727 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
769b0441
FW
728} while (0)
729
8db14860 730extern __printf(2, 0) int
48ead020
FW
731__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
732
8db14860 733extern __printf(2, 0) int
526211bc 734__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
769b0441 735
cecbca96 736extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
526211bc 737#else
526211bc
IM
738static inline void tracing_start(void) { }
739static inline void tracing_stop(void) { }
e67bc51e 740static inline void trace_dump_stack(int skip) { }
93d68e52
SR
741
742static inline void tracing_on(void) { }
743static inline void tracing_off(void) { }
744static inline int tracing_is_on(void) { return 0; }
ad909e21
SRRH
745static inline void tracing_snapshot(void) { }
746static inline void tracing_snapshot_alloc(void) { }
93d68e52 747
60efc15a
MH
748static inline __printf(1, 2)
749int trace_printk(const char *fmt, ...)
526211bc
IM
750{
751 return 0;
752}
8db14860 753static __printf(1, 0) inline int
526211bc
IM
754ftrace_vprintk(const char *fmt, va_list ap)
755{
756 return 0;
757}
cecbca96 758static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
769b0441 759#endif /* CONFIG_TRACING */
526211bc 760
1da177e4 761/*
bdf4bbaa 762 * min()/max()/clamp() macros that also do
1da177e4
LT
763 * strict type-checking.. See the
764 * "unnecessary" pointer comparison.
765 */
589a9785
JB
766#define __min(t1, t2, min1, min2, x, y) ({ \
767 t1 min1 = (x); \
768 t2 min2 = (y); \
769 (void) (&min1 == &min2); \
770 min1 < min2 ? min1 : min2; })
771#define min(x, y) \
772 __min(typeof(x), typeof(y), \
773 __UNIQUE_ID(min1_), __UNIQUE_ID(min2_), \
774 x, y)
775
776#define __max(t1, t2, max1, max2, x, y) ({ \
777 t1 max1 = (x); \
778 t2 max2 = (y); \
779 (void) (&max1 == &max2); \
780 max1 > max2 ? max1 : max2; })
781#define max(x, y) \
782 __max(typeof(x), typeof(y), \
783 __UNIQUE_ID(max1_), __UNIQUE_ID(max2_), \
784 x, y)
bdf4bbaa 785
2e1d06e1
MN
786#define min3(x, y, z) min((typeof(x))min(x, y), z)
787#define max3(x, y, z) max((typeof(x))max(x, y), z)
f27c85c5 788
c8bf1336
MP
789/**
790 * min_not_zero - return the minimum that is _not_ zero, unless both are zero
791 * @x: value1
792 * @y: value2
793 */
794#define min_not_zero(x, y) ({ \
795 typeof(x) __x = (x); \
796 typeof(y) __y = (y); \
797 __x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
798
bdf4bbaa
HH
799/**
800 * clamp - return a value clamped to a given range with strict typechecking
801 * @val: current value
2e1d06e1
MN
802 * @lo: lowest allowable value
803 * @hi: highest allowable value
bdf4bbaa 804 *
c185b07f 805 * This macro does strict typechecking of lo/hi to make sure they are of the
bdf4bbaa
HH
806 * same type as val. See the unnecessary pointer comparisons.
807 */
2e1d06e1 808#define clamp(val, lo, hi) min((typeof(val))max(val, lo), hi)
1da177e4
LT
809
810/*
811 * ..and if you can't take the strict
812 * types, you can specify one yourself.
813 *
bdf4bbaa
HH
814 * Or not use min/max/clamp at all, of course.
815 */
589a9785
JB
816#define min_t(type, x, y) \
817 __min(type, type, \
818 __UNIQUE_ID(min1_), __UNIQUE_ID(min2_), \
819 x, y)
820
821#define max_t(type, x, y) \
822 __max(type, type, \
823 __UNIQUE_ID(min1_), __UNIQUE_ID(min2_), \
824 x, y)
bdf4bbaa
HH
825
826/**
827 * clamp_t - return a value clamped to a given range using a given type
828 * @type: the type of variable to use
829 * @val: current value
c185b07f
MN
830 * @lo: minimum allowable value
831 * @hi: maximum allowable value
bdf4bbaa
HH
832 *
833 * This macro does no typechecking and uses temporary variables of type
834 * 'type' to make all the comparisons.
1da177e4 835 */
c185b07f 836#define clamp_t(type, val, lo, hi) min_t(type, max_t(type, val, lo), hi)
1da177e4 837
bdf4bbaa
HH
838/**
839 * clamp_val - return a value clamped to a given range using val's type
840 * @val: current value
c185b07f
MN
841 * @lo: minimum allowable value
842 * @hi: maximum allowable value
bdf4bbaa
HH
843 *
844 * This macro does no typechecking and uses temporary variables of whatever
845 * type the input argument 'val' is. This is useful when val is an unsigned
846 * type and min and max are literals that will otherwise be assigned a signed
847 * integer type.
848 */
c185b07f 849#define clamp_val(val, lo, hi) clamp_t(typeof(val), val, lo, hi)
1da177e4 850
91f68b73
WF
851
852/*
853 * swap - swap value of @a and @b
854 */
ac7b9004
PZ
855#define swap(a, b) \
856 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
91f68b73 857
1da177e4
LT
858/**
859 * container_of - cast a member of a structure out to the containing structure
1da177e4
LT
860 * @ptr: the pointer to the member.
861 * @type: the type of the container struct this is embedded in.
862 * @member: the name of the member within the struct.
863 *
864 */
c7acec71
IA
865#define container_of(ptr, type, member) ({ \
866 void *__mptr = (void *)(ptr); \
867 BUILD_BUG_ON_MSG(!__same_type(*(ptr), ((type *)0)->member) && \
868 !__same_type(*(ptr), void), \
869 "pointer type mismatch in container_of()"); \
870 ((type *)(__mptr - offsetof(type, member))); })
1da177e4 871
b9d4f426
AL
872/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
873#ifdef CONFIG_FTRACE_MCOUNT_RECORD
874# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
875#endif
9d00f92f 876
58f86cc8 877/* Permissions on a sysfs file: you didn't miss the 0 prefix did you? */
28b8d0c8
GCM
878#define VERIFY_OCTAL_PERMISSIONS(perms) \
879 (BUILD_BUG_ON_ZERO((perms) < 0) + \
880 BUILD_BUG_ON_ZERO((perms) > 0777) + \
881 /* USER_READABLE >= GROUP_READABLE >= OTHER_READABLE */ \
882 BUILD_BUG_ON_ZERO((((perms) >> 6) & 4) < (((perms) >> 3) & 4)) + \
883 BUILD_BUG_ON_ZERO((((perms) >> 3) & 4) < ((perms) & 4)) + \
884 /* USER_WRITABLE >= GROUP_WRITABLE */ \
885 BUILD_BUG_ON_ZERO((((perms) >> 6) & 2) < (((perms) >> 3) & 2)) + \
886 /* OTHER_WRITABLE? Generally considered a bad idea. */ \
887 BUILD_BUG_ON_ZERO((perms) & 2) + \
58f86cc8 888 (perms))
1da177e4 889#endif