xref: /linux-6.15/include/linux/kernel.h (revision a58130dd)
1 #ifndef _LINUX_KERNEL_H
2 #define _LINUX_KERNEL_H
3 
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>
11 #include <linux/log2.h>
12 #include <linux/typecheck.h>
13 #include <linux/printk.h>
14 #include <linux/dynamic_debug.h>
15 #include <asm/byteorder.h>
16 #include <uapi/linux/kernel.h>
17 
18 #define USHRT_MAX	((u16)(~0U))
19 #define SHRT_MAX	((s16)(USHRT_MAX>>1))
20 #define SHRT_MIN	((s16)(-SHRT_MAX - 1))
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)
27 #define LLONG_MAX	((long long)(~0ULL>>1))
28 #define LLONG_MIN	(-LLONG_MAX - 1)
29 #define ULLONG_MAX	(~0ULL)
30 #define SIZE_MAX	(~(size_t)0)
31 
32 #define STACK_MAGIC	0xdeadbeef
33 
34 #define REPEAT_BYTE(x)	((~0ul / 0xff) * (x))
35 
36 #define ALIGN(x, a)		__ALIGN_KERNEL((x), (a))
37 #define __ALIGN_MASK(x, mask)	__ALIGN_KERNEL_MASK((x), (mask))
38 #define PTR_ALIGN(p, a)		((typeof(p))ALIGN((unsigned long)(p), (a)))
39 #define IS_ALIGNED(x, a)		(((x) & ((typeof(x))(a) - 1)) == 0)
40 
41 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
42 
43 /*
44  * This looks more complex than it should be. But we need to
45  * get the type for the ~ right in round_down (it needs to be
46  * as wide as the result!), and we want to evaluate the macro
47  * arguments just once each.
48  */
49 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
50 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
51 #define round_down(x, y) ((x) & ~__round_mask(x, y))
52 
53 #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
54 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
55 #define DIV_ROUND_UP_ULL(ll,d) \
56 	({ unsigned long long _tmp = (ll)+(d)-1; do_div(_tmp, d); _tmp; })
57 
58 #if BITS_PER_LONG == 32
59 # define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP_ULL(ll, d)
60 #else
61 # define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP(ll,d)
62 #endif
63 
64 /* The `const' in roundup() prevents gcc-3.3 from calling __divdi3 */
65 #define roundup(x, y) (					\
66 {							\
67 	const typeof(y) __y = y;			\
68 	(((x) + (__y - 1)) / __y) * __y;		\
69 }							\
70 )
71 #define rounddown(x, y) (				\
72 {							\
73 	typeof(x) __x = (x);				\
74 	__x - (__x % (y));				\
75 }							\
76 )
77 
78 /*
79  * Divide positive or negative dividend by positive divisor and round
80  * to closest integer. Result is undefined for negative divisors.
81  */
82 #define DIV_ROUND_CLOSEST(x, divisor)(			\
83 {							\
84 	typeof(x) __x = x;				\
85 	typeof(divisor) __d = divisor;			\
86 	(((typeof(x))-1) > 0 || (__x) > 0) ?		\
87 		(((__x) + ((__d) / 2)) / (__d)) :	\
88 		(((__x) - ((__d) / 2)) / (__d));	\
89 }							\
90 )
91 
92 /*
93  * Multiplies an integer by a fraction, while avoiding unnecessary
94  * overflow or loss of precision.
95  */
96 #define mult_frac(x, numer, denom)(			\
97 {							\
98 	typeof(x) quot = (x) / (denom);			\
99 	typeof(x) rem  = (x) % (denom);			\
100 	(quot * (numer)) + ((rem * (numer)) / (denom));	\
101 }							\
102 )
103 
104 
105 #define _RET_IP_		(unsigned long)__builtin_return_address(0)
106 #define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })
107 
108 #ifdef CONFIG_LBDAF
109 # include <asm/div64.h>
110 # define sector_div(a, b) do_div(a, b)
111 #else
112 # define sector_div(n, b)( \
113 { \
114 	int _res; \
115 	_res = (n) % (b); \
116 	(n) /= (b); \
117 	_res; \
118 } \
119 )
120 #endif
121 
122 /**
123  * upper_32_bits - return bits 32-63 of a number
124  * @n: the number we're accessing
125  *
126  * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
127  * the "right shift count >= width of type" warning when that quantity is
128  * 32-bits.
129  */
130 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
131 
132 /**
133  * lower_32_bits - return bits 0-31 of a number
134  * @n: the number we're accessing
135  */
136 #define lower_32_bits(n) ((u32)(n))
137 
138 struct completion;
139 struct pt_regs;
140 struct user;
141 
142 #ifdef CONFIG_PREEMPT_VOLUNTARY
143 extern int _cond_resched(void);
144 # define might_resched() _cond_resched()
145 #else
146 # define might_resched() do { } while (0)
147 #endif
148 
149 #ifdef CONFIG_DEBUG_ATOMIC_SLEEP
150   void __might_sleep(const char *file, int line, int preempt_offset);
151 /**
152  * might_sleep - annotation for functions that can sleep
153  *
154  * this macro will print a stack trace if it is executed in an atomic
155  * context (spinlock, irq-handler, ...).
156  *
157  * This is a useful debugging help to be able to catch problems early and not
158  * be bitten later when the calling function happens to sleep when it is not
159  * supposed to.
160  */
161 # define might_sleep() \
162 	do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
163 #else
164   static inline void __might_sleep(const char *file, int line,
165 				   int preempt_offset) { }
166 # define might_sleep() do { might_resched(); } while (0)
167 #endif
168 
169 #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
170 
171 /*
172  * abs() handles unsigned and signed longs, ints, shorts and chars.  For all
173  * input types abs() returns a signed long.
174  * abs() should not be used for 64-bit types (s64, u64, long long) - use abs64()
175  * for those.
176  */
177 #define abs(x) ({						\
178 		long ret;					\
179 		if (sizeof(x) == sizeof(long)) {		\
180 			long __x = (x);				\
181 			ret = (__x < 0) ? -__x : __x;		\
182 		} else {					\
183 			int __x = (x);				\
184 			ret = (__x < 0) ? -__x : __x;		\
185 		}						\
186 		ret;						\
187 	})
188 
189 #define abs64(x) ({				\
190 		s64 __x = (x);			\
191 		(__x < 0) ? -__x : __x;		\
192 	})
193 
194 #ifdef CONFIG_PROVE_LOCKING
195 void might_fault(void);
196 #else
197 static inline void might_fault(void)
198 {
199 	might_sleep();
200 }
201 #endif
202 
203 extern struct atomic_notifier_head panic_notifier_list;
204 extern long (*panic_blink)(int state);
205 __printf(1, 2)
206 void panic(const char *fmt, ...)
207 	__noreturn __cold;
208 extern void oops_enter(void);
209 extern void oops_exit(void);
210 void print_oops_end_marker(void);
211 extern int oops_may_print(void);
212 void do_exit(long error_code)
213 	__noreturn;
214 void complete_and_exit(struct completion *, long)
215 	__noreturn;
216 
217 /* Internal, do not use. */
218 int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
219 int __must_check _kstrtol(const char *s, unsigned int base, long *res);
220 
221 int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
222 int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
223 
224 /**
225  * kstrtoul - convert a string to an unsigned long
226  * @s: The start of the string. The string must be null-terminated, and may also
227  *  include a single newline before its terminating null. The first character
228  *  may also be a plus sign, but not a minus sign.
229  * @base: The number base to use. The maximum supported base is 16. If base is
230  *  given as 0, then the base of the string is automatically detected with the
231  *  conventional semantics - If it begins with 0x the number will be parsed as a
232  *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be
233  *  parsed as an octal number. Otherwise it will be parsed as a decimal.
234  * @res: Where to write the result of the conversion on success.
235  *
236  * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
237  * Used as a replacement for the obsolete simple_strtoull. Return code must
238  * be checked.
239 */
240 static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
241 {
242 	/*
243 	 * We want to shortcut function call, but
244 	 * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
245 	 */
246 	if (sizeof(unsigned long) == sizeof(unsigned long long) &&
247 	    __alignof__(unsigned long) == __alignof__(unsigned long long))
248 		return kstrtoull(s, base, (unsigned long long *)res);
249 	else
250 		return _kstrtoul(s, base, res);
251 }
252 
253 /**
254  * kstrtol - convert a string to a long
255  * @s: The start of the string. The string must be null-terminated, and may also
256  *  include a single newline before its terminating null. The first character
257  *  may also be a plus sign or a minus sign.
258  * @base: The number base to use. The maximum supported base is 16. If base is
259  *  given as 0, then the base of the string is automatically detected with the
260  *  conventional semantics - If it begins with 0x the number will be parsed as a
261  *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be
262  *  parsed as an octal number. Otherwise it will be parsed as a decimal.
263  * @res: Where to write the result of the conversion on success.
264  *
265  * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
266  * Used as a replacement for the obsolete simple_strtoull. Return code must
267  * be checked.
268  */
269 static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
270 {
271 	/*
272 	 * We want to shortcut function call, but
273 	 * __builtin_types_compatible_p(long, long long) = 0.
274 	 */
275 	if (sizeof(long) == sizeof(long long) &&
276 	    __alignof__(long) == __alignof__(long long))
277 		return kstrtoll(s, base, (long long *)res);
278 	else
279 		return _kstrtol(s, base, res);
280 }
281 
282 int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
283 int __must_check kstrtoint(const char *s, unsigned int base, int *res);
284 
285 static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
286 {
287 	return kstrtoull(s, base, res);
288 }
289 
290 static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
291 {
292 	return kstrtoll(s, base, res);
293 }
294 
295 static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
296 {
297 	return kstrtouint(s, base, res);
298 }
299 
300 static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
301 {
302 	return kstrtoint(s, base, res);
303 }
304 
305 int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
306 int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
307 int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
308 int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);
309 
310 int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
311 int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
312 int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
313 int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
314 int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
315 int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
316 int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
317 int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
318 int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
319 int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);
320 
321 static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
322 {
323 	return kstrtoull_from_user(s, count, base, res);
324 }
325 
326 static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
327 {
328 	return kstrtoll_from_user(s, count, base, res);
329 }
330 
331 static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
332 {
333 	return kstrtouint_from_user(s, count, base, res);
334 }
335 
336 static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
337 {
338 	return kstrtoint_from_user(s, count, base, res);
339 }
340 
341 /* Obsolete, do not use.  Use kstrto<foo> instead */
342 
343 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
344 extern long simple_strtol(const char *,char **,unsigned int);
345 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
346 extern long long simple_strtoll(const char *,char **,unsigned int);
347 #define strict_strtoul	kstrtoul
348 #define strict_strtol	kstrtol
349 #define strict_strtoull	kstrtoull
350 #define strict_strtoll	kstrtoll
351 
352 extern int num_to_str(char *buf, int size, unsigned long long num);
353 
354 /* lib/printf utilities */
355 
356 extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
357 extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
358 extern __printf(3, 4)
359 int snprintf(char *buf, size_t size, const char *fmt, ...);
360 extern __printf(3, 0)
361 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
362 extern __printf(3, 4)
363 int scnprintf(char *buf, size_t size, const char *fmt, ...);
364 extern __printf(3, 0)
365 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
366 extern __printf(2, 3)
367 char *kasprintf(gfp_t gfp, const char *fmt, ...);
368 extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
369 
370 extern __scanf(2, 3)
371 int sscanf(const char *, const char *, ...);
372 extern __scanf(2, 0)
373 int vsscanf(const char *, const char *, va_list);
374 
375 extern int get_option(char **str, int *pint);
376 extern char *get_options(const char *str, int nints, int *ints);
377 extern unsigned long long memparse(const char *ptr, char **retptr);
378 
379 extern int core_kernel_text(unsigned long addr);
380 extern int core_kernel_data(unsigned long addr);
381 extern int __kernel_text_address(unsigned long addr);
382 extern int kernel_text_address(unsigned long addr);
383 extern int func_ptr_is_kernel_text(void *ptr);
384 
385 struct pid;
386 extern struct pid *session_of_pgrp(struct pid *pgrp);
387 
388 unsigned long int_sqrt(unsigned long);
389 
390 extern void bust_spinlocks(int yes);
391 extern void wake_up_klogd(void);
392 extern int oops_in_progress;		/* If set, an oops, panic(), BUG() or die() is in progress */
393 extern int panic_timeout;
394 extern int panic_on_oops;
395 extern int panic_on_unrecovered_nmi;
396 extern int panic_on_io_nmi;
397 extern int sysctl_panic_on_stackoverflow;
398 extern const char *print_tainted(void);
399 extern void add_taint(unsigned flag);
400 extern int test_taint(unsigned flag);
401 extern unsigned long get_taint(void);
402 extern int root_mountflags;
403 
404 extern bool early_boot_irqs_disabled;
405 
406 /* Values used for system_state */
407 extern enum system_states {
408 	SYSTEM_BOOTING,
409 	SYSTEM_RUNNING,
410 	SYSTEM_HALT,
411 	SYSTEM_POWER_OFF,
412 	SYSTEM_RESTART,
413 } system_state;
414 
415 #define TAINT_PROPRIETARY_MODULE	0
416 #define TAINT_FORCED_MODULE		1
417 #define TAINT_UNSAFE_SMP		2
418 #define TAINT_FORCED_RMMOD		3
419 #define TAINT_MACHINE_CHECK		4
420 #define TAINT_BAD_PAGE			5
421 #define TAINT_USER			6
422 #define TAINT_DIE			7
423 #define TAINT_OVERRIDDEN_ACPI_TABLE	8
424 #define TAINT_WARN			9
425 #define TAINT_CRAP			10
426 #define TAINT_FIRMWARE_WORKAROUND	11
427 #define TAINT_OOT_MODULE		12
428 
429 extern const char hex_asc[];
430 #define hex_asc_lo(x)	hex_asc[((x) & 0x0f)]
431 #define hex_asc_hi(x)	hex_asc[((x) & 0xf0) >> 4]
432 
433 static inline char *hex_byte_pack(char *buf, u8 byte)
434 {
435 	*buf++ = hex_asc_hi(byte);
436 	*buf++ = hex_asc_lo(byte);
437 	return buf;
438 }
439 
440 static inline char * __deprecated pack_hex_byte(char *buf, u8 byte)
441 {
442 	return hex_byte_pack(buf, byte);
443 }
444 
445 extern int hex_to_bin(char ch);
446 extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
447 
448 /*
449  * General tracing related utility functions - trace_printk(),
450  * tracing_on/tracing_off and tracing_start()/tracing_stop
451  *
452  * Use tracing_on/tracing_off when you want to quickly turn on or off
453  * tracing. It simply enables or disables the recording of the trace events.
454  * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
455  * file, which gives a means for the kernel and userspace to interact.
456  * Place a tracing_off() in the kernel where you want tracing to end.
457  * From user space, examine the trace, and then echo 1 > tracing_on
458  * to continue tracing.
459  *
460  * tracing_stop/tracing_start has slightly more overhead. It is used
461  * by things like suspend to ram where disabling the recording of the
462  * trace is not enough, but tracing must actually stop because things
463  * like calling smp_processor_id() may crash the system.
464  *
465  * Most likely, you want to use tracing_on/tracing_off.
466  */
467 #ifdef CONFIG_RING_BUFFER
468 /* trace_off_permanent stops recording with no way to bring it back */
469 void tracing_off_permanent(void);
470 #else
471 static inline void tracing_off_permanent(void) { }
472 #endif
473 
474 enum ftrace_dump_mode {
475 	DUMP_NONE,
476 	DUMP_ALL,
477 	DUMP_ORIG,
478 };
479 
480 #ifdef CONFIG_TRACING
481 void tracing_on(void);
482 void tracing_off(void);
483 int tracing_is_on(void);
484 
485 extern void tracing_start(void);
486 extern void tracing_stop(void);
487 extern void ftrace_off_permanent(void);
488 
489 static inline __printf(1, 2)
490 void ____trace_printk_check_format(const char *fmt, ...)
491 {
492 }
493 #define __trace_printk_check_format(fmt, args...)			\
494 do {									\
495 	if (0)								\
496 		____trace_printk_check_format(fmt, ##args);		\
497 } while (0)
498 
499 /**
500  * trace_printk - printf formatting in the ftrace buffer
501  * @fmt: the printf format for printing
502  *
503  * Note: __trace_printk is an internal function for trace_printk and
504  *       the @ip is passed in via the trace_printk macro.
505  *
506  * This function allows a kernel developer to debug fast path sections
507  * that printk is not appropriate for. By scattering in various
508  * printk like tracing in the code, a developer can quickly see
509  * where problems are occurring.
510  *
511  * This is intended as a debugging tool for the developer only.
512  * Please refrain from leaving trace_printks scattered around in
513  * your code.
514  */
515 
516 #define trace_printk(fmt, args...)					\
517 do {									\
518 	static const char *trace_printk_fmt				\
519 		__attribute__((section("__trace_printk_fmt"))) =	\
520 		__builtin_constant_p(fmt) ? fmt : NULL;			\
521 									\
522 	__trace_printk_check_format(fmt, ##args);			\
523 									\
524 	if (__builtin_constant_p(fmt))					\
525 		__trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args);	\
526 	else								\
527 		__trace_printk(_THIS_IP_, fmt, ##args);			\
528 } while (0)
529 
530 extern __printf(2, 3)
531 int __trace_bprintk(unsigned long ip, const char *fmt, ...);
532 
533 extern __printf(2, 3)
534 int __trace_printk(unsigned long ip, const char *fmt, ...);
535 
536 extern void trace_dump_stack(void);
537 
538 /*
539  * The double __builtin_constant_p is because gcc will give us an error
540  * if we try to allocate the static variable to fmt if it is not a
541  * constant. Even with the outer if statement.
542  */
543 #define ftrace_vprintk(fmt, vargs)					\
544 do {									\
545 	if (__builtin_constant_p(fmt)) {				\
546 		static const char *trace_printk_fmt			\
547 		  __attribute__((section("__trace_printk_fmt"))) =	\
548 			__builtin_constant_p(fmt) ? fmt : NULL;		\
549 									\
550 		__ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs);	\
551 	} else								\
552 		__ftrace_vprintk(_THIS_IP_, fmt, vargs);		\
553 } while (0)
554 
555 extern int
556 __ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
557 
558 extern int
559 __ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
560 
561 extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
562 #else
563 static inline void tracing_start(void) { }
564 static inline void tracing_stop(void) { }
565 static inline void ftrace_off_permanent(void) { }
566 static inline void trace_dump_stack(void) { }
567 
568 static inline void tracing_on(void) { }
569 static inline void tracing_off(void) { }
570 static inline int tracing_is_on(void) { return 0; }
571 
572 static inline __printf(1, 2)
573 int trace_printk(const char *fmt, ...)
574 {
575 	return 0;
576 }
577 static inline int
578 ftrace_vprintk(const char *fmt, va_list ap)
579 {
580 	return 0;
581 }
582 static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
583 #endif /* CONFIG_TRACING */
584 
585 /*
586  * min()/max()/clamp() macros that also do
587  * strict type-checking.. See the
588  * "unnecessary" pointer comparison.
589  */
590 #define min(x, y) ({				\
591 	typeof(x) _min1 = (x);			\
592 	typeof(y) _min2 = (y);			\
593 	(void) (&_min1 == &_min2);		\
594 	_min1 < _min2 ? _min1 : _min2; })
595 
596 #define max(x, y) ({				\
597 	typeof(x) _max1 = (x);			\
598 	typeof(y) _max2 = (y);			\
599 	(void) (&_max1 == &_max2);		\
600 	_max1 > _max2 ? _max1 : _max2; })
601 
602 #define min3(x, y, z) ({			\
603 	typeof(x) _min1 = (x);			\
604 	typeof(y) _min2 = (y);			\
605 	typeof(z) _min3 = (z);			\
606 	(void) (&_min1 == &_min2);		\
607 	(void) (&_min1 == &_min3);		\
608 	_min1 < _min2 ? (_min1 < _min3 ? _min1 : _min3) : \
609 		(_min2 < _min3 ? _min2 : _min3); })
610 
611 #define max3(x, y, z) ({			\
612 	typeof(x) _max1 = (x);			\
613 	typeof(y) _max2 = (y);			\
614 	typeof(z) _max3 = (z);			\
615 	(void) (&_max1 == &_max2);		\
616 	(void) (&_max1 == &_max3);		\
617 	_max1 > _max2 ? (_max1 > _max3 ? _max1 : _max3) : \
618 		(_max2 > _max3 ? _max2 : _max3); })
619 
620 /**
621  * min_not_zero - return the minimum that is _not_ zero, unless both are zero
622  * @x: value1
623  * @y: value2
624  */
625 #define min_not_zero(x, y) ({			\
626 	typeof(x) __x = (x);			\
627 	typeof(y) __y = (y);			\
628 	__x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
629 
630 /**
631  * clamp - return a value clamped to a given range with strict typechecking
632  * @val: current value
633  * @min: minimum allowable value
634  * @max: maximum allowable value
635  *
636  * This macro does strict typechecking of min/max to make sure they are of the
637  * same type as val.  See the unnecessary pointer comparisons.
638  */
639 #define clamp(val, min, max) ({			\
640 	typeof(val) __val = (val);		\
641 	typeof(min) __min = (min);		\
642 	typeof(max) __max = (max);		\
643 	(void) (&__val == &__min);		\
644 	(void) (&__val == &__max);		\
645 	__val = __val < __min ? __min: __val;	\
646 	__val > __max ? __max: __val; })
647 
648 /*
649  * ..and if you can't take the strict
650  * types, you can specify one yourself.
651  *
652  * Or not use min/max/clamp at all, of course.
653  */
654 #define min_t(type, x, y) ({			\
655 	type __min1 = (x);			\
656 	type __min2 = (y);			\
657 	__min1 < __min2 ? __min1: __min2; })
658 
659 #define max_t(type, x, y) ({			\
660 	type __max1 = (x);			\
661 	type __max2 = (y);			\
662 	__max1 > __max2 ? __max1: __max2; })
663 
664 /**
665  * clamp_t - return a value clamped to a given range using a given type
666  * @type: the type of variable to use
667  * @val: current value
668  * @min: minimum allowable value
669  * @max: maximum allowable value
670  *
671  * This macro does no typechecking and uses temporary variables of type
672  * 'type' to make all the comparisons.
673  */
674 #define clamp_t(type, val, min, max) ({		\
675 	type __val = (val);			\
676 	type __min = (min);			\
677 	type __max = (max);			\
678 	__val = __val < __min ? __min: __val;	\
679 	__val > __max ? __max: __val; })
680 
681 /**
682  * clamp_val - return a value clamped to a given range using val's type
683  * @val: current value
684  * @min: minimum allowable value
685  * @max: maximum allowable value
686  *
687  * This macro does no typechecking and uses temporary variables of whatever
688  * type the input argument 'val' is.  This is useful when val is an unsigned
689  * type and min and max are literals that will otherwise be assigned a signed
690  * integer type.
691  */
692 #define clamp_val(val, min, max) ({		\
693 	typeof(val) __val = (val);		\
694 	typeof(val) __min = (min);		\
695 	typeof(val) __max = (max);		\
696 	__val = __val < __min ? __min: __val;	\
697 	__val > __max ? __max: __val; })
698 
699 
700 /*
701  * swap - swap value of @a and @b
702  */
703 #define swap(a, b) \
704 	do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
705 
706 /**
707  * container_of - cast a member of a structure out to the containing structure
708  * @ptr:	the pointer to the member.
709  * @type:	the type of the container struct this is embedded in.
710  * @member:	the name of the member within the struct.
711  *
712  */
713 #define container_of(ptr, type, member) ({			\
714 	const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
715 	(type *)( (char *)__mptr - offsetof(type,member) );})
716 
717 /* Trap pasters of __FUNCTION__ at compile-time */
718 #define __FUNCTION__ (__func__)
719 
720 /* This helps us to avoid #ifdef CONFIG_SYMBOL_PREFIX */
721 #ifdef CONFIG_SYMBOL_PREFIX
722 #define SYMBOL_PREFIX CONFIG_SYMBOL_PREFIX
723 #else
724 #define SYMBOL_PREFIX ""
725 #endif
726 
727 /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
728 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
729 # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
730 #endif
731 
732 extern int do_sysinfo(struct sysinfo *info);
733 
734 #endif
735