xref: /linux-6.15/include/linux/kernel.h (revision 3317fad5)
1 #ifndef _LINUX_KERNEL_H
2 #define _LINUX_KERNEL_H
3 
4 /*
5  * 'kernel.h' contains some often-used function prototypes etc
6  */
7 #define __ALIGN_KERNEL(x, a)		__ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
8 #define __ALIGN_KERNEL_MASK(x, mask)	(((x) + (mask)) & ~(mask))
9 
10 #ifdef __KERNEL__
11 
12 #include <stdarg.h>
13 #include <linux/linkage.h>
14 #include <linux/stddef.h>
15 #include <linux/types.h>
16 #include <linux/compiler.h>
17 #include <linux/bitops.h>
18 #include <linux/log2.h>
19 #include <linux/typecheck.h>
20 #include <linux/dynamic_debug.h>
21 #include <asm/byteorder.h>
22 #include <asm/bug.h>
23 
24 extern const char linux_banner[];
25 extern const char linux_proc_banner[];
26 
27 #define USHRT_MAX	((u16)(~0U))
28 #define SHRT_MAX	((s16)(USHRT_MAX>>1))
29 #define SHRT_MIN	((s16)(-SHRT_MAX - 1))
30 #define INT_MAX		((int)(~0U>>1))
31 #define INT_MIN		(-INT_MAX - 1)
32 #define UINT_MAX	(~0U)
33 #define LONG_MAX	((long)(~0UL>>1))
34 #define LONG_MIN	(-LONG_MAX - 1)
35 #define ULONG_MAX	(~0UL)
36 #define LLONG_MAX	((long long)(~0ULL>>1))
37 #define LLONG_MIN	(-LLONG_MAX - 1)
38 #define ULLONG_MAX	(~0ULL)
39 
40 #define STACK_MAGIC	0xdeadbeef
41 
42 #define ALIGN(x, a)		__ALIGN_KERNEL((x), (a))
43 #define __ALIGN_MASK(x, mask)	__ALIGN_KERNEL_MASK((x), (mask))
44 #define PTR_ALIGN(p, a)		((typeof(p))ALIGN((unsigned long)(p), (a)))
45 #define IS_ALIGNED(x, a)		(((x) & ((typeof(x))(a) - 1)) == 0)
46 
47 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
48 
49 /*
50  * This looks more complex than it should be. But we need to
51  * get the type for the ~ right in round_down (it needs to be
52  * as wide as the result!), and we want to evaluate the macro
53  * arguments just once each.
54  */
55 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
56 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
57 #define round_down(x, y) ((x) & ~__round_mask(x, y))
58 
59 #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
60 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
61 #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
62 #define DIV_ROUND_CLOSEST(x, divisor)(			\
63 {							\
64 	typeof(divisor) __divisor = divisor;		\
65 	(((x) + ((__divisor) / 2)) / (__divisor));	\
66 }							\
67 )
68 
69 #define _RET_IP_		(unsigned long)__builtin_return_address(0)
70 #define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })
71 
72 #ifdef CONFIG_LBDAF
73 # include <asm/div64.h>
74 # define sector_div(a, b) do_div(a, b)
75 #else
76 # define sector_div(n, b)( \
77 { \
78 	int _res; \
79 	_res = (n) % (b); \
80 	(n) /= (b); \
81 	_res; \
82 } \
83 )
84 #endif
85 
86 /**
87  * upper_32_bits - return bits 32-63 of a number
88  * @n: the number we're accessing
89  *
90  * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
91  * the "right shift count >= width of type" warning when that quantity is
92  * 32-bits.
93  */
94 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
95 
96 /**
97  * lower_32_bits - return bits 0-31 of a number
98  * @n: the number we're accessing
99  */
100 #define lower_32_bits(n) ((u32)(n))
101 
102 #define	KERN_EMERG	"<0>"	/* system is unusable			*/
103 #define	KERN_ALERT	"<1>"	/* action must be taken immediately	*/
104 #define	KERN_CRIT	"<2>"	/* critical conditions			*/
105 #define	KERN_ERR	"<3>"	/* error conditions			*/
106 #define	KERN_WARNING	"<4>"	/* warning conditions			*/
107 #define	KERN_NOTICE	"<5>"	/* normal but significant condition	*/
108 #define	KERN_INFO	"<6>"	/* informational			*/
109 #define	KERN_DEBUG	"<7>"	/* debug-level messages			*/
110 
111 /* Use the default kernel loglevel */
112 #define KERN_DEFAULT	"<d>"
113 /*
114  * Annotation for a "continued" line of log printout (only done after a
115  * line that had no enclosing \n). Only to be used by core/arch code
116  * during early bootup (a continued line is not SMP-safe otherwise).
117  */
118 #define	KERN_CONT	"<c>"
119 
120 extern int console_printk[];
121 
122 #define console_loglevel (console_printk[0])
123 #define default_message_loglevel (console_printk[1])
124 #define minimum_console_loglevel (console_printk[2])
125 #define default_console_loglevel (console_printk[3])
126 
127 struct completion;
128 struct pt_regs;
129 struct user;
130 
131 #ifdef CONFIG_PREEMPT_VOLUNTARY
132 extern int _cond_resched(void);
133 # define might_resched() _cond_resched()
134 #else
135 # define might_resched() do { } while (0)
136 #endif
137 
138 #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
139   void __might_sleep(const char *file, int line, int preempt_offset);
140 /**
141  * might_sleep - annotation for functions that can sleep
142  *
143  * this macro will print a stack trace if it is executed in an atomic
144  * context (spinlock, irq-handler, ...).
145  *
146  * This is a useful debugging help to be able to catch problems early and not
147  * be bitten later when the calling function happens to sleep when it is not
148  * supposed to.
149  */
150 # define might_sleep() \
151 	do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
152 #else
153   static inline void __might_sleep(const char *file, int line,
154 				   int preempt_offset) { }
155 # define might_sleep() do { might_resched(); } while (0)
156 #endif
157 
158 #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
159 
160 #define abs(x) ({				\
161 		long __x = (x);			\
162 		(__x < 0) ? -__x : __x;		\
163 	})
164 
165 #ifdef CONFIG_PROVE_LOCKING
166 void might_fault(void);
167 #else
168 static inline void might_fault(void)
169 {
170 	might_sleep();
171 }
172 #endif
173 
174 struct va_format {
175 	const char *fmt;
176 	va_list *va;
177 };
178 
179 extern struct atomic_notifier_head panic_notifier_list;
180 extern long (*panic_blink)(long time);
181 NORET_TYPE void panic(const char * fmt, ...)
182 	__attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
183 extern void oops_enter(void);
184 extern void oops_exit(void);
185 extern int oops_may_print(void);
186 NORET_TYPE void do_exit(long error_code)
187 	ATTRIB_NORET;
188 NORET_TYPE void complete_and_exit(struct completion *, long)
189 	ATTRIB_NORET;
190 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
191 extern long simple_strtol(const char *,char **,unsigned int);
192 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
193 extern long long simple_strtoll(const char *,char **,unsigned int);
194 extern int strict_strtoul(const char *, unsigned int, unsigned long *);
195 extern int strict_strtol(const char *, unsigned int, long *);
196 extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
197 extern int strict_strtoll(const char *, unsigned int, long long *);
198 extern int sprintf(char * buf, const char * fmt, ...)
199 	__attribute__ ((format (printf, 2, 3)));
200 extern int vsprintf(char *buf, const char *, va_list)
201 	__attribute__ ((format (printf, 2, 0)));
202 extern int snprintf(char * buf, size_t size, const char * fmt, ...)
203 	__attribute__ ((format (printf, 3, 4)));
204 extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
205 	__attribute__ ((format (printf, 3, 0)));
206 extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
207 	__attribute__ ((format (printf, 3, 4)));
208 extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
209 	__attribute__ ((format (printf, 3, 0)));
210 extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
211 	__attribute__ ((format (printf, 2, 3)));
212 extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
213 
214 extern int sscanf(const char *, const char *, ...)
215 	__attribute__ ((format (scanf, 2, 3)));
216 extern int vsscanf(const char *, const char *, va_list)
217 	__attribute__ ((format (scanf, 2, 0)));
218 
219 extern int get_option(char **str, int *pint);
220 extern char *get_options(const char *str, int nints, int *ints);
221 extern unsigned long long memparse(const char *ptr, char **retptr);
222 
223 extern int core_kernel_text(unsigned long addr);
224 extern int __kernel_text_address(unsigned long addr);
225 extern int kernel_text_address(unsigned long addr);
226 extern int func_ptr_is_kernel_text(void *ptr);
227 
228 struct pid;
229 extern struct pid *session_of_pgrp(struct pid *pgrp);
230 
231 /*
232  * FW_BUG
233  * Add this to a message where you are sure the firmware is buggy or behaves
234  * really stupid or out of spec. Be aware that the responsible BIOS developer
235  * should be able to fix this issue or at least get a concrete idea of the
236  * problem by reading your message without the need of looking at the kernel
237  * code.
238  *
239  * Use it for definite and high priority BIOS bugs.
240  *
241  * FW_WARN
242  * Use it for not that clear (e.g. could the kernel messed up things already?)
243  * and medium priority BIOS bugs.
244  *
245  * FW_INFO
246  * Use this one if you want to tell the user or vendor about something
247  * suspicious, but generally harmless related to the firmware.
248  *
249  * Use it for information or very low priority BIOS bugs.
250  */
251 #define FW_BUG		"[Firmware Bug]: "
252 #define FW_WARN		"[Firmware Warn]: "
253 #define FW_INFO		"[Firmware Info]: "
254 
255 #ifdef CONFIG_PRINTK
256 asmlinkage int vprintk(const char *fmt, va_list args)
257 	__attribute__ ((format (printf, 1, 0)));
258 asmlinkage int printk(const char * fmt, ...)
259 	__attribute__ ((format (printf, 1, 2))) __cold;
260 
261 extern int __printk_ratelimit(const char *func);
262 #define printk_ratelimit() __printk_ratelimit(__func__)
263 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
264 				   unsigned int interval_msec);
265 
266 extern int printk_delay_msec;
267 
268 /*
269  * Print a one-time message (analogous to WARN_ONCE() et al):
270  */
271 #define printk_once(x...) ({			\
272 	static bool __print_once;		\
273 						\
274 	if (!__print_once) {			\
275 		__print_once = true;		\
276 		printk(x);			\
277 	}					\
278 })
279 
280 void log_buf_kexec_setup(void);
281 #else
282 static inline int vprintk(const char *s, va_list args)
283 	__attribute__ ((format (printf, 1, 0)));
284 static inline int vprintk(const char *s, va_list args) { return 0; }
285 static inline int printk(const char *s, ...)
286 	__attribute__ ((format (printf, 1, 2)));
287 static inline int __cold printk(const char *s, ...) { return 0; }
288 static inline int printk_ratelimit(void) { return 0; }
289 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
290 					  unsigned int interval_msec)	\
291 		{ return false; }
292 
293 /* No effect, but we still get type checking even in the !PRINTK case: */
294 #define printk_once(x...) printk(x)
295 
296 static inline void log_buf_kexec_setup(void)
297 {
298 }
299 #endif
300 
301 extern int printk_needs_cpu(int cpu);
302 extern void printk_tick(void);
303 
304 extern void asmlinkage __attribute__((format(printf, 1, 2)))
305 	early_printk(const char *fmt, ...);
306 
307 unsigned long int_sqrt(unsigned long);
308 
309 static inline void console_silent(void)
310 {
311 	console_loglevel = 0;
312 }
313 
314 static inline void console_verbose(void)
315 {
316 	if (console_loglevel)
317 		console_loglevel = 15;
318 }
319 
320 extern void bust_spinlocks(int yes);
321 extern void wake_up_klogd(void);
322 extern int oops_in_progress;		/* If set, an oops, panic(), BUG() or die() is in progress */
323 extern int panic_timeout;
324 extern int panic_on_oops;
325 extern int panic_on_unrecovered_nmi;
326 extern int panic_on_io_nmi;
327 extern const char *print_tainted(void);
328 extern void add_taint(unsigned flag);
329 extern int test_taint(unsigned flag);
330 extern unsigned long get_taint(void);
331 extern int root_mountflags;
332 
333 /* Values used for system_state */
334 extern enum system_states {
335 	SYSTEM_BOOTING,
336 	SYSTEM_RUNNING,
337 	SYSTEM_HALT,
338 	SYSTEM_POWER_OFF,
339 	SYSTEM_RESTART,
340 	SYSTEM_SUSPEND_DISK,
341 } system_state;
342 
343 #define TAINT_PROPRIETARY_MODULE	0
344 #define TAINT_FORCED_MODULE		1
345 #define TAINT_UNSAFE_SMP		2
346 #define TAINT_FORCED_RMMOD		3
347 #define TAINT_MACHINE_CHECK		4
348 #define TAINT_BAD_PAGE			5
349 #define TAINT_USER			6
350 #define TAINT_DIE			7
351 #define TAINT_OVERRIDDEN_ACPI_TABLE	8
352 #define TAINT_WARN			9
353 #define TAINT_CRAP			10
354 #define TAINT_FIRMWARE_WORKAROUND	11
355 
356 extern void dump_stack(void) __cold;
357 
358 enum {
359 	DUMP_PREFIX_NONE,
360 	DUMP_PREFIX_ADDRESS,
361 	DUMP_PREFIX_OFFSET
362 };
363 extern void hex_dump_to_buffer(const void *buf, size_t len,
364 				int rowsize, int groupsize,
365 				char *linebuf, size_t linebuflen, bool ascii);
366 extern void print_hex_dump(const char *level, const char *prefix_str,
367 				int prefix_type, int rowsize, int groupsize,
368 				const void *buf, size_t len, bool ascii);
369 extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
370 			const void *buf, size_t len);
371 
372 extern const char hex_asc[];
373 #define hex_asc_lo(x)	hex_asc[((x) & 0x0f)]
374 #define hex_asc_hi(x)	hex_asc[((x) & 0xf0) >> 4]
375 
376 static inline char *pack_hex_byte(char *buf, u8 byte)
377 {
378 	*buf++ = hex_asc_hi(byte);
379 	*buf++ = hex_asc_lo(byte);
380 	return buf;
381 }
382 
383 extern int hex_to_bin(char ch);
384 
385 #ifndef pr_fmt
386 #define pr_fmt(fmt) fmt
387 #endif
388 
389 #define pr_emerg(fmt, ...) \
390         printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
391 #define pr_alert(fmt, ...) \
392         printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
393 #define pr_crit(fmt, ...) \
394         printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
395 #define pr_err(fmt, ...) \
396         printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
397 #define pr_warning(fmt, ...) \
398         printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
399 #define pr_warn pr_warning
400 #define pr_notice(fmt, ...) \
401         printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
402 #define pr_info(fmt, ...) \
403         printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
404 #define pr_cont(fmt, ...) \
405 	printk(KERN_CONT fmt, ##__VA_ARGS__)
406 
407 /* pr_devel() should produce zero code unless DEBUG is defined */
408 #ifdef DEBUG
409 #define pr_devel(fmt, ...) \
410 	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
411 #else
412 #define pr_devel(fmt, ...) \
413 	({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
414 #endif
415 
416 /* If you are writing a driver, please use dev_dbg instead */
417 #if defined(DEBUG)
418 #define pr_debug(fmt, ...) \
419 	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
420 #elif defined(CONFIG_DYNAMIC_DEBUG)
421 /* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
422 #define pr_debug(fmt, ...) \
423 	dynamic_pr_debug(fmt, ##__VA_ARGS__)
424 #else
425 #define pr_debug(fmt, ...) \
426 	({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
427 #endif
428 
429 /*
430  * ratelimited messages with local ratelimit_state,
431  * no local ratelimit_state used in the !PRINTK case
432  */
433 #ifdef CONFIG_PRINTK
434 #define printk_ratelimited(fmt, ...)  ({				\
435 	static DEFINE_RATELIMIT_STATE(_rs,				\
436 				      DEFAULT_RATELIMIT_INTERVAL,	\
437 				      DEFAULT_RATELIMIT_BURST);		\
438 									\
439 	if (__ratelimit(&_rs))						\
440 		printk(fmt, ##__VA_ARGS__);				\
441 })
442 #else
443 /* No effect, but we still get type checking even in the !PRINTK case: */
444 #define printk_ratelimited printk
445 #endif
446 
447 #define pr_emerg_ratelimited(fmt, ...) \
448 	printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
449 #define pr_alert_ratelimited(fmt, ...) \
450 	printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
451 #define pr_crit_ratelimited(fmt, ...) \
452 	printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
453 #define pr_err_ratelimited(fmt, ...) \
454 	printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
455 #define pr_warning_ratelimited(fmt, ...) \
456 	printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
457 #define pr_warn_ratelimited pr_warning_ratelimited
458 #define pr_notice_ratelimited(fmt, ...) \
459 	printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
460 #define pr_info_ratelimited(fmt, ...) \
461 	printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
462 /* no pr_cont_ratelimited, don't do that... */
463 /* If you are writing a driver, please use dev_dbg instead */
464 #if defined(DEBUG)
465 #define pr_debug_ratelimited(fmt, ...) \
466 	printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
467 #else
468 #define pr_debug_ratelimited(fmt, ...) \
469 	({ if (0) printk_ratelimited(KERN_DEBUG pr_fmt(fmt), \
470 				     ##__VA_ARGS__); 0; })
471 #endif
472 
473 /*
474  * General tracing related utility functions - trace_printk(),
475  * tracing_on/tracing_off and tracing_start()/tracing_stop
476  *
477  * Use tracing_on/tracing_off when you want to quickly turn on or off
478  * tracing. It simply enables or disables the recording of the trace events.
479  * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
480  * file, which gives a means for the kernel and userspace to interact.
481  * Place a tracing_off() in the kernel where you want tracing to end.
482  * From user space, examine the trace, and then echo 1 > tracing_on
483  * to continue tracing.
484  *
485  * tracing_stop/tracing_start has slightly more overhead. It is used
486  * by things like suspend to ram where disabling the recording of the
487  * trace is not enough, but tracing must actually stop because things
488  * like calling smp_processor_id() may crash the system.
489  *
490  * Most likely, you want to use tracing_on/tracing_off.
491  */
492 #ifdef CONFIG_RING_BUFFER
493 void tracing_on(void);
494 void tracing_off(void);
495 /* trace_off_permanent stops recording with no way to bring it back */
496 void tracing_off_permanent(void);
497 int tracing_is_on(void);
498 #else
499 static inline void tracing_on(void) { }
500 static inline void tracing_off(void) { }
501 static inline void tracing_off_permanent(void) { }
502 static inline int tracing_is_on(void) { return 0; }
503 #endif
504 
505 enum ftrace_dump_mode {
506 	DUMP_NONE,
507 	DUMP_ALL,
508 	DUMP_ORIG,
509 };
510 
511 #ifdef CONFIG_TRACING
512 extern void tracing_start(void);
513 extern void tracing_stop(void);
514 extern void ftrace_off_permanent(void);
515 
516 extern void
517 ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
518 
519 static inline void __attribute__ ((format (printf, 1, 2)))
520 ____trace_printk_check_format(const char *fmt, ...)
521 {
522 }
523 #define __trace_printk_check_format(fmt, args...)			\
524 do {									\
525 	if (0)								\
526 		____trace_printk_check_format(fmt, ##args);		\
527 } while (0)
528 
529 /**
530  * trace_printk - printf formatting in the ftrace buffer
531  * @fmt: the printf format for printing
532  *
533  * Note: __trace_printk is an internal function for trace_printk and
534  *       the @ip is passed in via the trace_printk macro.
535  *
536  * This function allows a kernel developer to debug fast path sections
537  * that printk is not appropriate for. By scattering in various
538  * printk like tracing in the code, a developer can quickly see
539  * where problems are occurring.
540  *
541  * This is intended as a debugging tool for the developer only.
542  * Please refrain from leaving trace_printks scattered around in
543  * your code.
544  */
545 
546 #define trace_printk(fmt, args...)					\
547 do {									\
548 	__trace_printk_check_format(fmt, ##args);			\
549 	if (__builtin_constant_p(fmt)) {				\
550 		static const char *trace_printk_fmt			\
551 		  __attribute__((section("__trace_printk_fmt"))) =	\
552 			__builtin_constant_p(fmt) ? fmt : NULL;		\
553 									\
554 		__trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args);	\
555 	} else								\
556 		__trace_printk(_THIS_IP_, fmt, ##args);		\
557 } while (0)
558 
559 extern int
560 __trace_bprintk(unsigned long ip, const char *fmt, ...)
561 	__attribute__ ((format (printf, 2, 3)));
562 
563 extern int
564 __trace_printk(unsigned long ip, const char *fmt, ...)
565 	__attribute__ ((format (printf, 2, 3)));
566 
567 extern void trace_dump_stack(void);
568 
569 /*
570  * The double __builtin_constant_p is because gcc will give us an error
571  * if we try to allocate the static variable to fmt if it is not a
572  * constant. Even with the outer if statement.
573  */
574 #define ftrace_vprintk(fmt, vargs)					\
575 do {									\
576 	if (__builtin_constant_p(fmt)) {				\
577 		static const char *trace_printk_fmt			\
578 		  __attribute__((section("__trace_printk_fmt"))) =	\
579 			__builtin_constant_p(fmt) ? fmt : NULL;		\
580 									\
581 		__ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs);	\
582 	} else								\
583 		__ftrace_vprintk(_THIS_IP_, fmt, vargs);		\
584 } while (0)
585 
586 extern int
587 __ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
588 
589 extern int
590 __ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
591 
592 extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
593 #else
594 static inline void
595 ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
596 static inline int
597 trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
598 
599 static inline void tracing_start(void) { }
600 static inline void tracing_stop(void) { }
601 static inline void ftrace_off_permanent(void) { }
602 static inline void trace_dump_stack(void) { }
603 static inline int
604 trace_printk(const char *fmt, ...)
605 {
606 	return 0;
607 }
608 static inline int
609 ftrace_vprintk(const char *fmt, va_list ap)
610 {
611 	return 0;
612 }
613 static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
614 #endif /* CONFIG_TRACING */
615 
616 /*
617  *      Display an IP address in readable format.
618  */
619 
620 #define NIPQUAD(addr) \
621 	((unsigned char *)&addr)[0], \
622 	((unsigned char *)&addr)[1], \
623 	((unsigned char *)&addr)[2], \
624 	((unsigned char *)&addr)[3]
625 #define NIPQUAD_FMT "%u.%u.%u.%u"
626 
627 /*
628  * min()/max()/clamp() macros that also do
629  * strict type-checking.. See the
630  * "unnecessary" pointer comparison.
631  */
632 #define min(x, y) ({				\
633 	typeof(x) _min1 = (x);			\
634 	typeof(y) _min2 = (y);			\
635 	(void) (&_min1 == &_min2);		\
636 	_min1 < _min2 ? _min1 : _min2; })
637 
638 #define max(x, y) ({				\
639 	typeof(x) _max1 = (x);			\
640 	typeof(y) _max2 = (y);			\
641 	(void) (&_max1 == &_max2);		\
642 	_max1 > _max2 ? _max1 : _max2; })
643 
644 /**
645  * clamp - return a value clamped to a given range with strict typechecking
646  * @val: current value
647  * @min: minimum allowable value
648  * @max: maximum allowable value
649  *
650  * This macro does strict typechecking of min/max to make sure they are of the
651  * same type as val.  See the unnecessary pointer comparisons.
652  */
653 #define clamp(val, min, max) ({			\
654 	typeof(val) __val = (val);		\
655 	typeof(min) __min = (min);		\
656 	typeof(max) __max = (max);		\
657 	(void) (&__val == &__min);		\
658 	(void) (&__val == &__max);		\
659 	__val = __val < __min ? __min: __val;	\
660 	__val > __max ? __max: __val; })
661 
662 /*
663  * ..and if you can't take the strict
664  * types, you can specify one yourself.
665  *
666  * Or not use min/max/clamp at all, of course.
667  */
668 #define min_t(type, x, y) ({			\
669 	type __min1 = (x);			\
670 	type __min2 = (y);			\
671 	__min1 < __min2 ? __min1: __min2; })
672 
673 #define max_t(type, x, y) ({			\
674 	type __max1 = (x);			\
675 	type __max2 = (y);			\
676 	__max1 > __max2 ? __max1: __max2; })
677 
678 /**
679  * clamp_t - return a value clamped to a given range using a given type
680  * @type: the type of variable to use
681  * @val: current value
682  * @min: minimum allowable value
683  * @max: maximum allowable value
684  *
685  * This macro does no typechecking and uses temporary variables of type
686  * 'type' to make all the comparisons.
687  */
688 #define clamp_t(type, val, min, max) ({		\
689 	type __val = (val);			\
690 	type __min = (min);			\
691 	type __max = (max);			\
692 	__val = __val < __min ? __min: __val;	\
693 	__val > __max ? __max: __val; })
694 
695 /**
696  * clamp_val - return a value clamped to a given range using val's type
697  * @val: current value
698  * @min: minimum allowable value
699  * @max: maximum allowable value
700  *
701  * This macro does no typechecking and uses temporary variables of whatever
702  * type the input argument 'val' is.  This is useful when val is an unsigned
703  * type and min and max are literals that will otherwise be assigned a signed
704  * integer type.
705  */
706 #define clamp_val(val, min, max) ({		\
707 	typeof(val) __val = (val);		\
708 	typeof(val) __min = (min);		\
709 	typeof(val) __max = (max);		\
710 	__val = __val < __min ? __min: __val;	\
711 	__val > __max ? __max: __val; })
712 
713 
714 /*
715  * swap - swap value of @a and @b
716  */
717 #define swap(a, b) \
718 	do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
719 
720 /**
721  * container_of - cast a member of a structure out to the containing structure
722  * @ptr:	the pointer to the member.
723  * @type:	the type of the container struct this is embedded in.
724  * @member:	the name of the member within the struct.
725  *
726  */
727 #define container_of(ptr, type, member) ({			\
728 	const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
729 	(type *)( (char *)__mptr - offsetof(type,member) );})
730 
731 struct sysinfo;
732 extern int do_sysinfo(struct sysinfo *info);
733 
734 #endif /* __KERNEL__ */
735 
736 #define SI_LOAD_SHIFT	16
737 struct sysinfo {
738 	long uptime;			/* Seconds since boot */
739 	unsigned long loads[3];		/* 1, 5, and 15 minute load averages */
740 	unsigned long totalram;		/* Total usable main memory size */
741 	unsigned long freeram;		/* Available memory size */
742 	unsigned long sharedram;	/* Amount of shared memory */
743 	unsigned long bufferram;	/* Memory used by buffers */
744 	unsigned long totalswap;	/* Total swap space size */
745 	unsigned long freeswap;		/* swap space still available */
746 	unsigned short procs;		/* Number of current processes */
747 	unsigned short pad;		/* explicit padding for m68k */
748 	unsigned long totalhigh;	/* Total high memory size */
749 	unsigned long freehigh;		/* Available high memory size */
750 	unsigned int mem_unit;		/* Memory unit size in bytes */
751 	char _f[20-2*sizeof(long)-sizeof(int)];	/* Padding: libc5 uses this.. */
752 };
753 
754 /* Force a compilation error if condition is true */
755 #define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))
756 
757 /* Force a compilation error if condition is constant and true */
758 #define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
759 
760 /* Force a compilation error if a constant expression is not a power of 2 */
761 #define BUILD_BUG_ON_NOT_POWER_OF_2(n)			\
762 	BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
763 
764 /* Force a compilation error if condition is true, but also produce a
765    result (of value 0 and type size_t), so the expression can be used
766    e.g. in a structure initializer (or where-ever else comma expressions
767    aren't permitted). */
768 #define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
769 #define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
770 
771 /* Trap pasters of __FUNCTION__ at compile-time */
772 #define __FUNCTION__ (__func__)
773 
774 /* This helps us to avoid #ifdef CONFIG_NUMA */
775 #ifdef CONFIG_NUMA
776 #define NUMA_BUILD 1
777 #else
778 #define NUMA_BUILD 0
779 #endif
780 
781 /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
782 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
783 # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
784 #endif
785 
786 #endif
787