fix #warning about using kernel headers in userpsace
[GitHub/mt8127/android_kernel_alcatel_ttab.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
e041c683 174extern struct atomic_notifier_head panic_notifier_list;
1da177e4
LT
175extern long (*panic_blink)(long time);
176NORET_TYPE void panic(const char * fmt, ...)
a586df06 177 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
dd287796
AM
178extern void oops_enter(void);
179extern void oops_exit(void);
180extern int oops_may_print(void);
ec701584 181NORET_TYPE void do_exit(long error_code)
1da177e4
LT
182 ATTRIB_NORET;
183NORET_TYPE void complete_and_exit(struct completion *, long)
184 ATTRIB_NORET;
185extern unsigned long simple_strtoul(const char *,char **,unsigned int);
186extern long simple_strtol(const char *,char **,unsigned int);
187extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
188extern long long simple_strtoll(const char *,char **,unsigned int);
06b2a76d
YY
189extern int strict_strtoul(const char *, unsigned int, unsigned long *);
190extern int strict_strtol(const char *, unsigned int, long *);
191extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
192extern int strict_strtoll(const char *, unsigned int, long long *);
1da177e4
LT
193extern int sprintf(char * buf, const char * fmt, ...)
194 __attribute__ ((format (printf, 2, 3)));
195extern int vsprintf(char *buf, const char *, va_list)
196 __attribute__ ((format (printf, 2, 0)));
197extern int snprintf(char * buf, size_t size, const char * fmt, ...)
198 __attribute__ ((format (printf, 3, 4)));
199extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
200 __attribute__ ((format (printf, 3, 0)));
201extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
202 __attribute__ ((format (printf, 3, 4)));
203extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
204 __attribute__ ((format (printf, 3, 0)));
e905914f
JF
205extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
206 __attribute__ ((format (printf, 2, 3)));
11443ec7 207extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
1da177e4
LT
208
209extern int sscanf(const char *, const char *, ...)
210 __attribute__ ((format (scanf, 2, 3)));
211extern int vsscanf(const char *, const char *, va_list)
212 __attribute__ ((format (scanf, 2, 0)));
213
214extern int get_option(char **str, int *pint);
215extern char *get_options(const char *str, int nints, int *ints);
d974ae37 216extern unsigned long long memparse(const char *ptr, char **retptr);
1da177e4 217
5e376613 218extern int core_kernel_text(unsigned long addr);
1da177e4
LT
219extern int __kernel_text_address(unsigned long addr);
220extern int kernel_text_address(unsigned long addr);
ab7476cf 221extern int func_ptr_is_kernel_text(void *ptr);
ab7476cf 222
04a2e6a5
EB
223struct pid;
224extern struct pid *session_of_pgrp(struct pid *pgrp);
1da177e4 225
a0ad05c7
TR
226/*
227 * FW_BUG
228 * Add this to a message where you are sure the firmware is buggy or behaves
229 * really stupid or out of spec. Be aware that the responsible BIOS developer
230 * should be able to fix this issue or at least get a concrete idea of the
231 * problem by reading your message without the need of looking at the kernel
232 * code.
233 *
234 * Use it for definite and high priority BIOS bugs.
235 *
236 * FW_WARN
237 * Use it for not that clear (e.g. could the kernel messed up things already?)
238 * and medium priority BIOS bugs.
239 *
240 * FW_INFO
241 * Use this one if you want to tell the user or vendor about something
242 * suspicious, but generally harmless related to the firmware.
243 *
244 * Use it for information or very low priority BIOS bugs.
245 */
246#define FW_BUG "[Firmware Bug]: "
247#define FW_WARN "[Firmware Warn]: "
248#define FW_INFO "[Firmware Info]: "
249
d59745ce 250#ifdef CONFIG_PRINTK
1da177e4
LT
251asmlinkage int vprintk(const char *fmt, va_list args)
252 __attribute__ ((format (printf, 1, 0)));
253asmlinkage int printk(const char * fmt, ...)
a586df06 254 __attribute__ ((format (printf, 1, 2))) __cold;
7ef3d2fd 255
5c828713
CB
256extern int __printk_ratelimit(const char *func);
257#define printk_ratelimit() __printk_ratelimit(__func__)
7ef3d2fd
JP
258extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
259 unsigned int interval_msec);
f036be96 260
af91322e
DY
261extern int printk_delay_msec;
262
f036be96
IM
263/*
264 * Print a one-time message (analogous to WARN_ONCE() et al):
265 */
266#define printk_once(x...) ({ \
0b2749aa 267 static bool __print_once; \
f036be96 268 \
0b2749aa
JP
269 if (!__print_once) { \
270 __print_once = true; \
f036be96
IM
271 printk(x); \
272 } \
273})
274
04d491ab 275void log_buf_kexec_setup(void);
d59745ce
MM
276#else
277static inline int vprintk(const char *s, va_list args)
278 __attribute__ ((format (printf, 1, 0)));
279static inline int vprintk(const char *s, va_list args) { return 0; }
280static inline int printk(const char *s, ...)
281 __attribute__ ((format (printf, 1, 2)));
a586df06 282static inline int __cold printk(const char *s, ...) { return 0; }
7ef3d2fd 283static inline int printk_ratelimit(void) { return 0; }
7ef3d2fd
JP
284static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
285 unsigned int interval_msec) \
286 { return false; }
f036be96
IM
287
288/* No effect, but we still get type checking even in the !PRINTK case: */
289#define printk_once(x...) printk(x)
290
04d491ab
NH
291static inline void log_buf_kexec_setup(void)
292{
293}
d59745ce 294#endif
1da177e4 295
ced9cd40
IM
296extern int printk_needs_cpu(int cpu);
297extern void printk_tick(void);
298
e17ba73b 299extern void asmlinkage __attribute__((format(printf, 1, 2)))
076f9776
IM
300 early_printk(const char *fmt, ...);
301
1da177e4
LT
302unsigned long int_sqrt(unsigned long);
303
1da177e4
LT
304static inline void console_silent(void)
305{
306 console_loglevel = 0;
307}
308
309static inline void console_verbose(void)
310{
311 if (console_loglevel)
312 console_loglevel = 15;
313}
314
315extern void bust_spinlocks(int yes);
e3e8a75d 316extern void wake_up_klogd(void);
1da177e4 317extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
aa727107 318extern int panic_timeout;
1da177e4 319extern int panic_on_oops;
8da5adda 320extern int panic_on_unrecovered_nmi;
5211a242 321extern int panic_on_io_nmi;
1da177e4 322extern const char *print_tainted(void);
25ddbb18
AK
323extern void add_taint(unsigned flag);
324extern int test_taint(unsigned flag);
325extern unsigned long get_taint(void);
b920de1b 326extern int root_mountflags;
1da177e4
LT
327
328/* Values used for system_state */
329extern enum system_states {
330 SYSTEM_BOOTING,
331 SYSTEM_RUNNING,
332 SYSTEM_HALT,
333 SYSTEM_POWER_OFF,
334 SYSTEM_RESTART,
729b4d4c 335 SYSTEM_SUSPEND_DISK,
1da177e4
LT
336} system_state;
337
25ddbb18
AK
338#define TAINT_PROPRIETARY_MODULE 0
339#define TAINT_FORCED_MODULE 1
340#define TAINT_UNSAFE_SMP 2
341#define TAINT_FORCED_RMMOD 3
342#define TAINT_MACHINE_CHECK 4
343#define TAINT_BAD_PAGE 5
344#define TAINT_USER 6
345#define TAINT_DIE 7
346#define TAINT_OVERRIDDEN_ACPI_TABLE 8
347#define TAINT_WARN 9
26e9a397 348#define TAINT_CRAP 10
92946bc7 349#define TAINT_FIRMWARE_WORKAROUND 11
1da177e4 350
a586df06 351extern void dump_stack(void) __cold;
1da177e4 352
99eaf3c4
RD
353enum {
354 DUMP_PREFIX_NONE,
355 DUMP_PREFIX_ADDRESS,
356 DUMP_PREFIX_OFFSET
357};
c7909234
RD
358extern void hex_dump_to_buffer(const void *buf, size_t len,
359 int rowsize, int groupsize,
360 char *linebuf, size_t linebuflen, bool ascii);
361extern void print_hex_dump(const char *level, const char *prefix_str,
362 int prefix_type, int rowsize, int groupsize,
6a0ed91e 363 const void *buf, size_t len, bool ascii);
c7909234 364extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
eb9a9a56 365 const void *buf, size_t len);
3fc95772
HH
366
367extern const char hex_asc[];
368#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
369#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
370
371static inline char *pack_hex_byte(char *buf, u8 byte)
372{
373 *buf++ = hex_asc_hi(byte);
374 *buf++ = hex_asc_lo(byte);
375 return buf;
376}
99eaf3c4 377
90378889
AS
378extern int hex_to_bin(char ch);
379
d091c2f5
MS
380#ifndef pr_fmt
381#define pr_fmt(fmt) fmt
382#endif
383
384#define pr_emerg(fmt, ...) \
385 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
386#define pr_alert(fmt, ...) \
387 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
388#define pr_crit(fmt, ...) \
389 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
390#define pr_err(fmt, ...) \
391 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
392#define pr_warning(fmt, ...) \
393 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
fc62f2f1 394#define pr_warn pr_warning
d091c2f5
MS
395#define pr_notice(fmt, ...) \
396 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
397#define pr_info(fmt, ...) \
398 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
311d0761
CG
399#define pr_cont(fmt, ...) \
400 printk(KERN_CONT fmt, ##__VA_ARGS__)
1f7c8234 401
4ccb4579
ME
402/* pr_devel() should produce zero code unless DEBUG is defined */
403#ifdef DEBUG
404#define pr_devel(fmt, ...) \
405 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
406#else
407#define pr_devel(fmt, ...) \
408 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
409#endif
410
1cc6daf2 411/* If you are writing a driver, please use dev_dbg instead */
d0d85ff9
CH
412#if defined(DEBUG)
413#define pr_debug(fmt, ...) \
414 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
e9d376f0 415#elif defined(CONFIG_DYNAMIC_DEBUG)
e6e66b02 416/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
00b55864
JP
417#define pr_debug(fmt, ...) \
418 dynamic_pr_debug(fmt, ##__VA_ARGS__)
1da177e4 419#else
d091c2f5
MS
420#define pr_debug(fmt, ...) \
421 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
1da177e4
LT
422#endif
423
8a64f336
JP
424/*
425 * ratelimited messages with local ratelimit_state,
426 * no local ratelimit_state used in the !PRINTK case
427 */
428#ifdef CONFIG_PRINTK
d8521fcc
OH
429#define printk_ratelimited(fmt, ...) ({ \
430 static DEFINE_RATELIMIT_STATE(_rs, \
431 DEFAULT_RATELIMIT_INTERVAL, \
432 DEFAULT_RATELIMIT_BURST); \
433 \
434 if (__ratelimit(&_rs)) \
435 printk(fmt, ##__VA_ARGS__); \
8a64f336
JP
436})
437#else
438/* No effect, but we still get type checking even in the !PRINTK case: */
439#define printk_ratelimited printk
440#endif
441
442#define pr_emerg_ratelimited(fmt, ...) \
443 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
444#define pr_alert_ratelimited(fmt, ...) \
445 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
446#define pr_crit_ratelimited(fmt, ...) \
447 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
448#define pr_err_ratelimited(fmt, ...) \
449 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
450#define pr_warning_ratelimited(fmt, ...) \
451 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
fc62f2f1 452#define pr_warn_ratelimited pr_warning_ratelimited
8a64f336
JP
453#define pr_notice_ratelimited(fmt, ...) \
454 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
455#define pr_info_ratelimited(fmt, ...) \
456 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
457/* no pr_cont_ratelimited, don't do that... */
458/* If you are writing a driver, please use dev_dbg instead */
459#if defined(DEBUG)
460#define pr_debug_ratelimited(fmt, ...) \
461 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
462#else
463#define pr_debug_ratelimited(fmt, ...) \
464 ({ if (0) printk_ratelimited(KERN_DEBUG pr_fmt(fmt), \
465 ##__VA_ARGS__); 0; })
466#endif
467
526211bc
IM
468/*
469 * General tracing related utility functions - trace_printk(),
2002c258
SR
470 * tracing_on/tracing_off and tracing_start()/tracing_stop
471 *
472 * Use tracing_on/tracing_off when you want to quickly turn on or off
473 * tracing. It simply enables or disables the recording of the trace events.
156f5a78 474 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
2002c258
SR
475 * file, which gives a means for the kernel and userspace to interact.
476 * Place a tracing_off() in the kernel where you want tracing to end.
477 * From user space, examine the trace, and then echo 1 > tracing_on
478 * to continue tracing.
479 *
480 * tracing_stop/tracing_start has slightly more overhead. It is used
481 * by things like suspend to ram where disabling the recording of the
482 * trace is not enough, but tracing must actually stop because things
483 * like calling smp_processor_id() may crash the system.
484 *
485 * Most likely, you want to use tracing_on/tracing_off.
526211bc 486 */
2002c258
SR
487#ifdef CONFIG_RING_BUFFER
488void tracing_on(void);
489void tracing_off(void);
490/* trace_off_permanent stops recording with no way to bring it back */
491void tracing_off_permanent(void);
492int tracing_is_on(void);
493#else
494static inline void tracing_on(void) { }
495static inline void tracing_off(void) { }
496static inline void tracing_off_permanent(void) { }
497static inline int tracing_is_on(void) { return 0; }
498#endif
cecbca96
FW
499
500enum ftrace_dump_mode {
501 DUMP_NONE,
502 DUMP_ALL,
503 DUMP_ORIG,
504};
505
526211bc
IM
506#ifdef CONFIG_TRACING
507extern void tracing_start(void);
508extern void tracing_stop(void);
509extern void ftrace_off_permanent(void);
510
511extern void
512ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
513
769b0441
FW
514static inline void __attribute__ ((format (printf, 1, 2)))
515____trace_printk_check_format(const char *fmt, ...)
516{
517}
518#define __trace_printk_check_format(fmt, args...) \
519do { \
520 if (0) \
521 ____trace_printk_check_format(fmt, ##args); \
522} while (0)
523
526211bc
IM
524/**
525 * trace_printk - printf formatting in the ftrace buffer
526 * @fmt: the printf format for printing
527 *
528 * Note: __trace_printk is an internal function for trace_printk and
529 * the @ip is passed in via the trace_printk macro.
530 *
531 * This function allows a kernel developer to debug fast path sections
532 * that printk is not appropriate for. By scattering in various
533 * printk like tracing in the code, a developer can quickly see
534 * where problems are occurring.
535 *
536 * This is intended as a debugging tool for the developer only.
537 * Please refrain from leaving trace_printks scattered around in
538 * your code.
539 */
769b0441
FW
540
541#define trace_printk(fmt, args...) \
542do { \
769b0441 543 __trace_printk_check_format(fmt, ##args); \
48ead020
FW
544 if (__builtin_constant_p(fmt)) { \
545 static const char *trace_printk_fmt \
546 __attribute__((section("__trace_printk_fmt"))) = \
547 __builtin_constant_p(fmt) ? fmt : NULL; \
548 \
549 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
550 } else \
551 __trace_printk(_THIS_IP_, fmt, ##args); \
769b0441
FW
552} while (0)
553
48ead020
FW
554extern int
555__trace_bprintk(unsigned long ip, const char *fmt, ...)
556 __attribute__ ((format (printf, 2, 3)));
557
526211bc
IM
558extern int
559__trace_printk(unsigned long ip, const char *fmt, ...)
560 __attribute__ ((format (printf, 2, 3)));
769b0441 561
03889384
SR
562extern void trace_dump_stack(void);
563
48ead020
FW
564/*
565 * The double __builtin_constant_p is because gcc will give us an error
566 * if we try to allocate the static variable to fmt if it is not a
567 * constant. Even with the outer if statement.
568 */
769b0441
FW
569#define ftrace_vprintk(fmt, vargs) \
570do { \
48ead020
FW
571 if (__builtin_constant_p(fmt)) { \
572 static const char *trace_printk_fmt \
573 __attribute__((section("__trace_printk_fmt"))) = \
574 __builtin_constant_p(fmt) ? fmt : NULL; \
7bffc23e 575 \
48ead020
FW
576 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
577 } else \
578 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
769b0441
FW
579} while (0)
580
48ead020
FW
581extern int
582__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
583
526211bc
IM
584extern int
585__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
769b0441 586
cecbca96 587extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
526211bc
IM
588#else
589static inline void
590ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
591static inline int
592trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
593
594static inline void tracing_start(void) { }
595static inline void tracing_stop(void) { }
596static inline void ftrace_off_permanent(void) { }
e36c5458 597static inline void trace_dump_stack(void) { }
526211bc
IM
598static inline int
599trace_printk(const char *fmt, ...)
600{
601 return 0;
602}
603static inline int
604ftrace_vprintk(const char *fmt, va_list ap)
605{
606 return 0;
607}
cecbca96 608static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
769b0441 609#endif /* CONFIG_TRACING */
526211bc 610
1da177e4
LT
611/*
612 * Display an IP address in readable format.
613 */
614
615#define NIPQUAD(addr) \
616 ((unsigned char *)&addr)[0], \
617 ((unsigned char *)&addr)[1], \
618 ((unsigned char *)&addr)[2], \
619 ((unsigned char *)&addr)[3]
46b86a2d 620#define NIPQUAD_FMT "%u.%u.%u.%u"
1da177e4 621
1da177e4 622/*
bdf4bbaa 623 * min()/max()/clamp() macros that also do
1da177e4
LT
624 * strict type-checking.. See the
625 * "unnecessary" pointer comparison.
626 */
bdf4bbaa
HH
627#define min(x, y) ({ \
628 typeof(x) _min1 = (x); \
629 typeof(y) _min2 = (y); \
630 (void) (&_min1 == &_min2); \
631 _min1 < _min2 ? _min1 : _min2; })
632
633#define max(x, y) ({ \
634 typeof(x) _max1 = (x); \
635 typeof(y) _max2 = (y); \
636 (void) (&_max1 == &_max2); \
637 _max1 > _max2 ? _max1 : _max2; })
638
639/**
640 * clamp - return a value clamped to a given range with strict typechecking
641 * @val: current value
642 * @min: minimum allowable value
643 * @max: maximum allowable value
644 *
645 * This macro does strict typechecking of min/max to make sure they are of the
646 * same type as val. See the unnecessary pointer comparisons.
647 */
648#define clamp(val, min, max) ({ \
649 typeof(val) __val = (val); \
650 typeof(min) __min = (min); \
651 typeof(max) __max = (max); \
652 (void) (&__val == &__min); \
653 (void) (&__val == &__max); \
654 __val = __val < __min ? __min: __val; \
655 __val > __max ? __max: __val; })
1da177e4
LT
656
657/*
658 * ..and if you can't take the strict
659 * types, you can specify one yourself.
660 *
bdf4bbaa
HH
661 * Or not use min/max/clamp at all, of course.
662 */
663#define min_t(type, x, y) ({ \
664 type __min1 = (x); \
665 type __min2 = (y); \
666 __min1 < __min2 ? __min1: __min2; })
667
668#define max_t(type, x, y) ({ \
669 type __max1 = (x); \
670 type __max2 = (y); \
671 __max1 > __max2 ? __max1: __max2; })
672
673/**
674 * clamp_t - return a value clamped to a given range using a given type
675 * @type: the type of variable to use
676 * @val: current value
677 * @min: minimum allowable value
678 * @max: maximum allowable value
679 *
680 * This macro does no typechecking and uses temporary variables of type
681 * 'type' to make all the comparisons.
1da177e4 682 */
bdf4bbaa
HH
683#define clamp_t(type, val, min, max) ({ \
684 type __val = (val); \
685 type __min = (min); \
686 type __max = (max); \
687 __val = __val < __min ? __min: __val; \
688 __val > __max ? __max: __val; })
1da177e4 689
bdf4bbaa
HH
690/**
691 * clamp_val - return a value clamped to a given range using val's type
692 * @val: current value
693 * @min: minimum allowable value
694 * @max: maximum allowable value
695 *
696 * This macro does no typechecking and uses temporary variables of whatever
697 * type the input argument 'val' is. This is useful when val is an unsigned
698 * type and min and max are literals that will otherwise be assigned a signed
699 * integer type.
700 */
701#define clamp_val(val, min, max) ({ \
702 typeof(val) __val = (val); \
703 typeof(val) __min = (min); \
704 typeof(val) __max = (max); \
705 __val = __val < __min ? __min: __val; \
706 __val > __max ? __max: __val; })
1da177e4 707
91f68b73
WF
708
709/*
710 * swap - swap value of @a and @b
711 */
ac7b9004
PZ
712#define swap(a, b) \
713 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
91f68b73 714
1da177e4
LT
715/**
716 * container_of - cast a member of a structure out to the containing structure
1da177e4
LT
717 * @ptr: the pointer to the member.
718 * @type: the type of the container struct this is embedded in.
719 * @member: the name of the member within the struct.
720 *
721 */
722#define container_of(ptr, type, member) ({ \
78db2ad6
DW
723 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
724 (type *)( (char *)__mptr - offsetof(type,member) );})
1da177e4 725
d4d23add
KM
726struct sysinfo;
727extern int do_sysinfo(struct sysinfo *info);
728
1da177e4
LT
729#endif /* __KERNEL__ */
730
731#define SI_LOAD_SHIFT 16
732struct sysinfo {
733 long uptime; /* Seconds since boot */
734 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
735 unsigned long totalram; /* Total usable main memory size */
736 unsigned long freeram; /* Available memory size */
737 unsigned long sharedram; /* Amount of shared memory */
738 unsigned long bufferram; /* Memory used by buffers */
739 unsigned long totalswap; /* Total swap space size */
740 unsigned long freeswap; /* swap space still available */
741 unsigned short procs; /* Number of current processes */
742 unsigned short pad; /* explicit padding for m68k */
743 unsigned long totalhigh; /* Total high memory size */
744 unsigned long freehigh; /* Available high memory size */
745 unsigned int mem_unit; /* Memory unit size in bytes */
746 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
747};
748
c0398ee6 749/* Force a compilation error if condition is true */
8c87df45
JB
750#define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))
751
752/* Force a compilation error if condition is constant and true */
753#define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
1da177e4 754
cc8ef6eb
RD
755/* Force a compilation error if a constant expression is not a power of 2 */
756#define BUILD_BUG_ON_NOT_POWER_OF_2(n) \
757 BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
758
4552d5dc
JB
759/* Force a compilation error if condition is true, but also produce a
760 result (of value 0 and type size_t), so the expression can be used
761 e.g. in a structure initializer (or where-ever else comma expressions
762 aren't permitted). */
8c87df45
JB
763#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
764#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
4552d5dc 765
1da177e4 766/* Trap pasters of __FUNCTION__ at compile-time */
1da177e4 767#define __FUNCTION__ (__func__)
1da177e4 768
08e0f6a9
CL
769/* This helps us to avoid #ifdef CONFIG_NUMA */
770#ifdef CONFIG_NUMA
771#define NUMA_BUILD 1
772#else
773#define NUMA_BUILD 0
774#endif
775
29e71abf
SR
776/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
777#ifdef CONFIG_FTRACE_MCOUNT_RECORD
778# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
779#endif
780
1da177e4 781#endif