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