]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/kernel.h
vsprintf: Recursive vsnprintf: Add "%pV", struct va_format
[net-next-2.6.git] / include / linux / kernel.h
CommitLineData
1da177e4
LT
1#ifndef _LINUX_KERNEL_H
2#define _LINUX_KERNEL_H
3
4/*
5 * 'kernel.h' contains some often-used function prototypes etc
6 */
a79ff731
AD
7#define __ALIGN_KERNEL(x, a) __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
8#define __ALIGN_KERNEL_MASK(x, mask) (((x) + (mask)) & ~(mask))
1da177e4
LT
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>
f0d1b0b3 18#include <linux/log2.h>
e0deaff4 19#include <linux/typecheck.h>
e9d376f0 20#include <linux/dynamic_debug.h>
1da177e4
LT
21#include <asm/byteorder.h>
22#include <asm/bug.h>
23
3eb3c740
RZ
24extern const char linux_banner[];
25extern const char linux_proc_banner[];
26
4be929be
AD
27#define USHRT_MAX ((u16)(~0U))
28#define SHRT_MAX ((s16)(USHRT_MAX>>1))
29#define SHRT_MIN ((s16)(-SHRT_MAX - 1))
1da177e4
LT
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)
111ebb6e
OH
36#define LLONG_MAX ((long long)(~0ULL>>1))
37#define LLONG_MIN (-LLONG_MAX - 1)
38#define ULLONG_MAX (~0ULL)
1da177e4
LT
39
40#define STACK_MAGIC 0xdeadbeef
41
a79ff731 42#define ALIGN(x, a) __ALIGN_KERNEL((x), (a))
9f93ff5b 43#define __ALIGN_MASK(x, mask) __ALIGN_KERNEL_MASK((x), (mask))
a83308e6 44#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
f10db627 45#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
2ea58144 46
c5e631cf
RR
47#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
48
9b3be9f9
YL
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
4552d5dc 59#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
930631ed 60#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
b4cac1a0 61#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
9fe06081
DW
62#define DIV_ROUND_CLOSEST(x, divisor)( \
63{ \
64 typeof(divisor) __divisor = divisor; \
65 (((x) + ((__divisor) / 2)) / (__divisor)); \
66} \
67)
1da177e4 68
ca31e146
EGM
69#define _RET_IP_ (unsigned long)__builtin_return_address(0)
70#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
71
90c699a9 72#ifdef CONFIG_LBDAF
2da96acd
JA
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
218e180e
AM
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
204b885e
JR
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
1da177e4
LT
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
e28d7137
LT
111/* Use the default kernel loglevel */
112#define KERN_DEFAULT "<d>"
47492527
IM
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 */
5fd29d6c 118#define KERN_CONT "<c>"
47492527 119
1da177e4
LT
120extern 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
127struct completion;
df2e71fb
AM
128struct pt_regs;
129struct user;
1da177e4 130
070cb065
UKK
131#ifdef CONFIG_PREEMPT_VOLUNTARY
132extern int _cond_resched(void);
133# define might_resched() _cond_resched()
134#else
135# define might_resched() do { } while (0)
136#endif
137
7106a27b 138#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
d894837f 139 void __might_sleep(const char *file, int line, int preempt_offset);
1da177e4
LT
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
e20ec991 147 * be bitten later when the calling function happens to sleep when it is not
1da177e4
LT
148 * supposed to.
149 */
f8cbd99b 150# define might_sleep() \
e4aafea2 151 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
1da177e4 152#else
d894837f
SK
153 static inline void __might_sleep(const char *file, int line,
154 int preempt_offset) { }
f8cbd99b 155# define might_sleep() do { might_resched(); } while (0)
1da177e4
LT
156#endif
157
368a5fa1 158#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
f8cbd99b 159
1da177e4 160#define abs(x) ({ \
a49c59c0 161 long __x = (x); \
1da177e4
LT
162 (__x < 0) ? -__x : __x; \
163 })
164
3ee1afa3
NP
165#ifdef CONFIG_PROVE_LOCKING
166void might_fault(void);
167#else
168static inline void might_fault(void)
169{
170 might_sleep();
171}
172#endif
173
7db6f5fb
JP
174struct va_format {
175 const char *fmt;
176 va_list *va;
177};
178
e041c683 179extern struct atomic_notifier_head panic_notifier_list;
1da177e4
LT
180extern long (*panic_blink)(long time);
181NORET_TYPE void panic(const char * fmt, ...)
a586df06 182 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
dd287796
AM
183extern void oops_enter(void);
184extern void oops_exit(void);
185extern int oops_may_print(void);
ec701584 186NORET_TYPE void do_exit(long error_code)
1da177e4
LT
187 ATTRIB_NORET;
188NORET_TYPE void complete_and_exit(struct completion *, long)
189 ATTRIB_NORET;
190extern unsigned long simple_strtoul(const char *,char **,unsigned int);
191extern long simple_strtol(const char *,char **,unsigned int);
192extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
193extern long long simple_strtoll(const char *,char **,unsigned int);
06b2a76d
YY
194extern int strict_strtoul(const char *, unsigned int, unsigned long *);
195extern int strict_strtol(const char *, unsigned int, long *);
196extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
197extern int strict_strtoll(const char *, unsigned int, long long *);
1da177e4
LT
198extern int sprintf(char * buf, const char * fmt, ...)
199 __attribute__ ((format (printf, 2, 3)));
200extern int vsprintf(char *buf, const char *, va_list)
201 __attribute__ ((format (printf, 2, 0)));
202extern int snprintf(char * buf, size_t size, const char * fmt, ...)
203 __attribute__ ((format (printf, 3, 4)));
204extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
205 __attribute__ ((format (printf, 3, 0)));
206extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
207 __attribute__ ((format (printf, 3, 4)));
208extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
209 __attribute__ ((format (printf, 3, 0)));
e905914f
JF
210extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
211 __attribute__ ((format (printf, 2, 3)));
11443ec7 212extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
1da177e4
LT
213
214extern int sscanf(const char *, const char *, ...)
215 __attribute__ ((format (scanf, 2, 3)));
216extern int vsscanf(const char *, const char *, va_list)
217 __attribute__ ((format (scanf, 2, 0)));
218
219extern int get_option(char **str, int *pint);
220extern char *get_options(const char *str, int nints, int *ints);
d974ae37 221extern unsigned long long memparse(const char *ptr, char **retptr);
1da177e4 222
5e376613 223extern int core_kernel_text(unsigned long addr);
1da177e4
LT
224extern int __kernel_text_address(unsigned long addr);
225extern int kernel_text_address(unsigned long addr);
ab7476cf 226extern int func_ptr_is_kernel_text(void *ptr);
ab7476cf 227
04a2e6a5
EB
228struct pid;
229extern struct pid *session_of_pgrp(struct pid *pgrp);
1da177e4 230
a0ad05c7
TR
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
d59745ce 255#ifdef CONFIG_PRINTK
1da177e4
LT
256asmlinkage int vprintk(const char *fmt, va_list args)
257 __attribute__ ((format (printf, 1, 0)));
258asmlinkage int printk(const char * fmt, ...)
a586df06 259 __attribute__ ((format (printf, 1, 2))) __cold;
7ef3d2fd 260
5c828713
CB
261extern int __printk_ratelimit(const char *func);
262#define printk_ratelimit() __printk_ratelimit(__func__)
7ef3d2fd
JP
263extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
264 unsigned int interval_msec);
f036be96 265
af91322e
DY
266extern int printk_delay_msec;
267
f036be96
IM
268/*
269 * Print a one-time message (analogous to WARN_ONCE() et al):
270 */
271#define printk_once(x...) ({ \
0b2749aa 272 static bool __print_once; \
f036be96 273 \
0b2749aa
JP
274 if (!__print_once) { \
275 __print_once = true; \
f036be96
IM
276 printk(x); \
277 } \
278})
279
04d491ab 280void log_buf_kexec_setup(void);
d59745ce
MM
281#else
282static inline int vprintk(const char *s, va_list args)
283 __attribute__ ((format (printf, 1, 0)));
284static inline int vprintk(const char *s, va_list args) { return 0; }
285static inline int printk(const char *s, ...)
286 __attribute__ ((format (printf, 1, 2)));
a586df06 287static inline int __cold printk(const char *s, ...) { return 0; }
7ef3d2fd 288static inline int printk_ratelimit(void) { return 0; }
7ef3d2fd
JP
289static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
290 unsigned int interval_msec) \
291 { return false; }
f036be96
IM
292
293/* No effect, but we still get type checking even in the !PRINTK case: */
294#define printk_once(x...) printk(x)
295
04d491ab
NH
296static inline void log_buf_kexec_setup(void)
297{
298}
d59745ce 299#endif
1da177e4 300
ced9cd40
IM
301extern int printk_needs_cpu(int cpu);
302extern void printk_tick(void);
303
e17ba73b 304extern void asmlinkage __attribute__((format(printf, 1, 2)))
076f9776
IM
305 early_printk(const char *fmt, ...);
306
1da177e4
LT
307unsigned long int_sqrt(unsigned long);
308
1da177e4
LT
309static inline void console_silent(void)
310{
311 console_loglevel = 0;
312}
313
314static inline void console_verbose(void)
315{
316 if (console_loglevel)
317 console_loglevel = 15;
318}
319
320extern void bust_spinlocks(int yes);
e3e8a75d 321extern void wake_up_klogd(void);
1da177e4 322extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
aa727107 323extern int panic_timeout;
1da177e4 324extern int panic_on_oops;
8da5adda 325extern int panic_on_unrecovered_nmi;
5211a242 326extern int panic_on_io_nmi;
1da177e4 327extern const char *print_tainted(void);
25ddbb18
AK
328extern void add_taint(unsigned flag);
329extern int test_taint(unsigned flag);
330extern unsigned long get_taint(void);
b920de1b 331extern int root_mountflags;
1da177e4
LT
332
333/* Values used for system_state */
334extern enum system_states {
335 SYSTEM_BOOTING,
336 SYSTEM_RUNNING,
337 SYSTEM_HALT,
338 SYSTEM_POWER_OFF,
339 SYSTEM_RESTART,
729b4d4c 340 SYSTEM_SUSPEND_DISK,
1da177e4
LT
341} system_state;
342
25ddbb18
AK
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
26e9a397 353#define TAINT_CRAP 10
92946bc7 354#define TAINT_FIRMWARE_WORKAROUND 11
1da177e4 355
a586df06 356extern void dump_stack(void) __cold;
1da177e4 357
99eaf3c4
RD
358enum {
359 DUMP_PREFIX_NONE,
360 DUMP_PREFIX_ADDRESS,
361 DUMP_PREFIX_OFFSET
362};
c7909234
RD
363extern void hex_dump_to_buffer(const void *buf, size_t len,
364 int rowsize, int groupsize,
365 char *linebuf, size_t linebuflen, bool ascii);
366extern void print_hex_dump(const char *level, const char *prefix_str,
367 int prefix_type, int rowsize, int groupsize,
6a0ed91e 368 const void *buf, size_t len, bool ascii);
c7909234 369extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
eb9a9a56 370 const void *buf, size_t len);
3fc95772
HH
371
372extern 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
376static 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}
99eaf3c4 382
90378889
AS
383extern int hex_to_bin(char ch);
384
d091c2f5
MS
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__)
fc62f2f1 399#define pr_warn pr_warning
d091c2f5
MS
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__)
311d0761
CG
404#define pr_cont(fmt, ...) \
405 printk(KERN_CONT fmt, ##__VA_ARGS__)
1f7c8234 406
4ccb4579
ME
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
1cc6daf2 416/* If you are writing a driver, please use dev_dbg instead */
d0d85ff9
CH
417#if defined(DEBUG)
418#define pr_debug(fmt, ...) \
419 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
e9d376f0 420#elif defined(CONFIG_DYNAMIC_DEBUG)
e6e66b02 421/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
00b55864
JP
422#define pr_debug(fmt, ...) \
423 dynamic_pr_debug(fmt, ##__VA_ARGS__)
1da177e4 424#else
d091c2f5
MS
425#define pr_debug(fmt, ...) \
426 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
1da177e4
LT
427#endif
428
8a64f336
JP
429/*
430 * ratelimited messages with local ratelimit_state,
431 * no local ratelimit_state used in the !PRINTK case
432 */
433#ifdef CONFIG_PRINTK
d8521fcc
OH
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__); \
8a64f336
JP
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__)
fc62f2f1 457#define pr_warn_ratelimited pr_warning_ratelimited
8a64f336
JP
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
526211bc
IM
473/*
474 * General tracing related utility functions - trace_printk(),
2002c258
SR
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.
156f5a78 479 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
2002c258
SR
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.
526211bc 491 */
2002c258
SR
492#ifdef CONFIG_RING_BUFFER
493void tracing_on(void);
494void tracing_off(void);
495/* trace_off_permanent stops recording with no way to bring it back */
496void tracing_off_permanent(void);
497int tracing_is_on(void);
498#else
499static inline void tracing_on(void) { }
500static inline void tracing_off(void) { }
501static inline void tracing_off_permanent(void) { }
502static inline int tracing_is_on(void) { return 0; }
503#endif
cecbca96
FW
504
505enum ftrace_dump_mode {
506 DUMP_NONE,
507 DUMP_ALL,
508 DUMP_ORIG,
509};
510
526211bc
IM
511#ifdef CONFIG_TRACING
512extern void tracing_start(void);
513extern void tracing_stop(void);
514extern void ftrace_off_permanent(void);
515
516extern void
517ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
518
769b0441
FW
519static 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...) \
524do { \
525 if (0) \
526 ____trace_printk_check_format(fmt, ##args); \
527} while (0)
528
526211bc
IM
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 */
769b0441
FW
545
546#define trace_printk(fmt, args...) \
547do { \
769b0441 548 __trace_printk_check_format(fmt, ##args); \
48ead020
FW
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); \
769b0441
FW
557} while (0)
558
48ead020
FW
559extern int
560__trace_bprintk(unsigned long ip, const char *fmt, ...)
561 __attribute__ ((format (printf, 2, 3)));
562
526211bc
IM
563extern int
564__trace_printk(unsigned long ip, const char *fmt, ...)
565 __attribute__ ((format (printf, 2, 3)));
769b0441 566
03889384
SR
567extern void trace_dump_stack(void);
568
48ead020
FW
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 */
769b0441
FW
574#define ftrace_vprintk(fmt, vargs) \
575do { \
48ead020
FW
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; \
7bffc23e 580 \
48ead020
FW
581 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
582 } else \
583 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
769b0441
FW
584} while (0)
585
48ead020
FW
586extern int
587__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
588
526211bc
IM
589extern int
590__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
769b0441 591
cecbca96 592extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
526211bc
IM
593#else
594static inline void
595ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
596static inline int
597trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
598
599static inline void tracing_start(void) { }
600static inline void tracing_stop(void) { }
601static inline void ftrace_off_permanent(void) { }
e36c5458 602static inline void trace_dump_stack(void) { }
526211bc
IM
603static inline int
604trace_printk(const char *fmt, ...)
605{
606 return 0;
607}
608static inline int
609ftrace_vprintk(const char *fmt, va_list ap)
610{
611 return 0;
612}
cecbca96 613static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
769b0441 614#endif /* CONFIG_TRACING */
526211bc 615
1da177e4
LT
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]
46b86a2d 625#define NIPQUAD_FMT "%u.%u.%u.%u"
1da177e4 626
1da177e4 627/*
bdf4bbaa 628 * min()/max()/clamp() macros that also do
1da177e4
LT
629 * strict type-checking.. See the
630 * "unnecessary" pointer comparison.
631 */
bdf4bbaa
HH
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; })
1da177e4
LT
661
662/*
663 * ..and if you can't take the strict
664 * types, you can specify one yourself.
665 *
bdf4bbaa
HH
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.
1da177e4 687 */
bdf4bbaa
HH
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; })
1da177e4 694
bdf4bbaa
HH
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; })
1da177e4 712
91f68b73
WF
713
714/*
715 * swap - swap value of @a and @b
716 */
ac7b9004
PZ
717#define swap(a, b) \
718 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
91f68b73 719
1da177e4
LT
720/**
721 * container_of - cast a member of a structure out to the containing structure
1da177e4
LT
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) ({ \
78db2ad6
DW
728 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
729 (type *)( (char *)__mptr - offsetof(type,member) );})
1da177e4 730
d4d23add
KM
731struct sysinfo;
732extern int do_sysinfo(struct sysinfo *info);
733
1da177e4
LT
734#endif /* __KERNEL__ */
735
c01226c3
AB
736#ifndef __EXPORTED_HEADERS__
737#ifndef __KERNEL__
738#warning Attempt to use kernel headers from user space, see http://kernelnewbies.org/KernelHeaders
739#endif /* __KERNEL__ */
740#endif /* __EXPORTED_HEADERS__ */
741
1da177e4
LT
742#define SI_LOAD_SHIFT 16
743struct sysinfo {
744 long uptime; /* Seconds since boot */
745 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
746 unsigned long totalram; /* Total usable main memory size */
747 unsigned long freeram; /* Available memory size */
748 unsigned long sharedram; /* Amount of shared memory */
749 unsigned long bufferram; /* Memory used by buffers */
750 unsigned long totalswap; /* Total swap space size */
751 unsigned long freeswap; /* swap space still available */
752 unsigned short procs; /* Number of current processes */
753 unsigned short pad; /* explicit padding for m68k */
754 unsigned long totalhigh; /* Total high memory size */
755 unsigned long freehigh; /* Available high memory size */
756 unsigned int mem_unit; /* Memory unit size in bytes */
757 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
758};
759
c0398ee6 760/* Force a compilation error if condition is true */
8c87df45
JB
761#define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))
762
763/* Force a compilation error if condition is constant and true */
764#define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
1da177e4 765
cc8ef6eb
RD
766/* Force a compilation error if a constant expression is not a power of 2 */
767#define BUILD_BUG_ON_NOT_POWER_OF_2(n) \
768 BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
769
4552d5dc
JB
770/* Force a compilation error if condition is true, but also produce a
771 result (of value 0 and type size_t), so the expression can be used
772 e.g. in a structure initializer (or where-ever else comma expressions
773 aren't permitted). */
8c87df45
JB
774#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
775#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
4552d5dc 776
1da177e4 777/* Trap pasters of __FUNCTION__ at compile-time */
1da177e4 778#define __FUNCTION__ (__func__)
1da177e4 779
08e0f6a9
CL
780/* This helps us to avoid #ifdef CONFIG_NUMA */
781#ifdef CONFIG_NUMA
782#define NUMA_BUILD 1
783#else
784#define NUMA_BUILD 0
785#endif
786
29e71abf
SR
787/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
788#ifdef CONFIG_FTRACE_MCOUNT_RECORD
789# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
790#endif
791
1da177e4 792#endif