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