blob: d3cd23f3003962de7d50219b1967a87e37f9d364 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_KERNEL_H
2#define _LINUX_KERNEL_H
3
4/*
5 * 'kernel.h' contains some often-used function prototypes etc
6 */
7
8#ifdef __KERNEL__
9
10#include <stdarg.h>
11#include <linux/linkage.h>
12#include <linux/stddef.h>
13#include <linux/types.h>
14#include <linux/compiler.h>
15#include <linux/bitops.h>
David Howellsf0d1b0b2006-12-08 02:37:49 -080016#include <linux/log2.h>
Andrew Mortone0deaff2008-07-25 01:45:24 -070017#include <linux/typecheck.h>
Dave Young717115e2008-07-25 01:45:58 -070018#include <linux/ratelimit.h>
Jason Barone9d376f2009-02-05 11:51:38 -050019#include <linux/dynamic_debug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <asm/byteorder.h>
21#include <asm/bug.h>
22
Roman Zippel3eb3c742007-01-10 14:45:28 +010023extern const char linux_banner[];
24extern const char linux_proc_banner[];
25
Zhang, Yanmin44f564a2008-04-29 01:00:55 -070026#define USHORT_MAX ((u16)(~0U))
27#define SHORT_MAX ((s16)(USHORT_MAX>>1))
28#define SHORT_MIN (-SHORT_MAX - 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#define INT_MAX ((int)(~0U>>1))
30#define INT_MIN (-INT_MAX - 1)
31#define UINT_MAX (~0U)
32#define LONG_MAX ((long)(~0UL>>1))
33#define LONG_MIN (-LONG_MAX - 1)
34#define ULONG_MAX (~0UL)
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -070035#define LLONG_MAX ((long long)(~0ULL>>1))
36#define LLONG_MIN (-LLONG_MAX - 1)
37#define ULLONG_MAX (~0ULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39#define STACK_MAGIC 0xdeadbeef
40
Linus Torvalds2ea58142006-11-26 19:05:22 -080041#define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
42#define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
Matthew Wilcoxa83308e2007-09-11 15:23:47 -070043#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
Herbert Xuf10db622008-02-06 01:37:05 -080044#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
Linus Torvalds2ea58142006-11-26 19:05:22 -080045
Rusty Russellc5e631c2007-05-06 14:51:05 -070046#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
47
Jan Beulich4552d5d2006-06-26 13:57:28 +020048#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
Steven Whitehouse930631e2006-09-25 23:32:40 -070049#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
David Howellsb4cac1a2006-07-10 04:44:54 -070050#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
Darrick J. Wong9fe06082009-01-06 14:40:51 -080051#define DIV_ROUND_CLOSEST(x, divisor)( \
52{ \
53 typeof(divisor) __divisor = divisor; \
54 (((x) + ((__divisor) / 2)) / (__divisor)); \
55} \
56)
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Eduard - Gabriel Munteanuca31e142008-07-05 12:14:23 +030058#define _RET_IP_ (unsigned long)__builtin_return_address(0)
59#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
60
Bartlomiej Zolnierkiewicz90c699a2009-06-19 08:08:50 +020061#ifdef CONFIG_LBDAF
Jens Axboe2da96ac2007-10-12 12:40:38 +020062# include <asm/div64.h>
63# define sector_div(a, b) do_div(a, b)
64#else
65# define sector_div(n, b)( \
66{ \
67 int _res; \
68 _res = (n) % (b); \
69 (n) /= (b); \
70 _res; \
71} \
72)
73#endif
74
Andrew Morton218e1802007-05-10 03:15:18 -070075/**
76 * upper_32_bits - return bits 32-63 of a number
77 * @n: the number we're accessing
78 *
79 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
80 * the "right shift count >= width of type" warning when that quantity is
81 * 32-bits.
82 */
83#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
84
Joerg Roedel204b8852008-07-29 22:33:42 -070085/**
86 * lower_32_bits - return bits 0-31 of a number
87 * @n: the number we're accessing
88 */
89#define lower_32_bits(n) ((u32)(n))
90
Linus Torvalds1da177e2005-04-16 15:20:36 -070091#define KERN_EMERG "<0>" /* system is unusable */
92#define KERN_ALERT "<1>" /* action must be taken immediately */
93#define KERN_CRIT "<2>" /* critical conditions */
94#define KERN_ERR "<3>" /* error conditions */
95#define KERN_WARNING "<4>" /* warning conditions */
96#define KERN_NOTICE "<5>" /* normal but significant condition */
97#define KERN_INFO "<6>" /* informational */
98#define KERN_DEBUG "<7>" /* debug-level messages */
99
Linus Torvaldse28d7132009-06-16 11:02:28 -0700100/* Use the default kernel loglevel */
101#define KERN_DEFAULT "<d>"
Ingo Molnar47492522007-10-16 23:30:29 -0700102/*
103 * Annotation for a "continued" line of log printout (only done after a
104 * line that had no enclosing \n). Only to be used by core/arch code
105 * during early bootup (a continued line is not SMP-safe otherwise).
106 */
Linus Torvalds5fd29d62009-06-16 10:57:02 -0700107#define KERN_CONT "<c>"
Ingo Molnar47492522007-10-16 23:30:29 -0700108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109extern int console_printk[];
110
111#define console_loglevel (console_printk[0])
112#define default_message_loglevel (console_printk[1])
113#define minimum_console_loglevel (console_printk[2])
114#define default_console_loglevel (console_printk[3])
115
116struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800117struct pt_regs;
118struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700120#ifdef CONFIG_PREEMPT_VOLUNTARY
121extern int _cond_resched(void);
122# define might_resched() _cond_resched()
123#else
124# define might_resched() do { } while (0)
125#endif
126
Randy Dunlap7106a272008-10-29 14:01:15 -0700127#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200128 void __might_sleep(char *file, int line, int preempt_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129/**
130 * might_sleep - annotation for functions that can sleep
131 *
132 * this macro will print a stack trace if it is executed in an atomic
133 * context (spinlock, irq-handler, ...).
134 *
135 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100136 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 * supposed to.
138 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700139# define might_sleep() \
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200140 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700141#else
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200142 static inline void __might_sleep(char *file, int line, int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700143# define might_sleep() do { might_resched(); } while (0)
144#endif
145
Hua Zhong368a5fa2006-06-23 02:05:42 -0700146#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148#define abs(x) ({ \
Rolf Eike Beera49c59c2009-09-22 16:44:03 -0700149 long __x = (x); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 (__x < 0) ? -__x : __x; \
151 })
152
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200153#ifdef CONFIG_PROVE_LOCKING
154void might_fault(void);
155#else
156static inline void might_fault(void)
157{
158 might_sleep();
159}
160#endif
161
Alan Sterne041c682006-03-27 01:16:30 -0800162extern struct atomic_notifier_head panic_notifier_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163extern long (*panic_blink)(long time);
164NORET_TYPE void panic(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200165 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800166extern void oops_enter(void);
167extern void oops_exit(void);
168extern int oops_may_print(void);
Harvey Harrisonec701582008-02-08 04:19:55 -0800169NORET_TYPE void do_exit(long error_code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 ATTRIB_NORET;
171NORET_TYPE void complete_and_exit(struct completion *, long)
172 ATTRIB_NORET;
173extern unsigned long simple_strtoul(const char *,char **,unsigned int);
174extern long simple_strtol(const char *,char **,unsigned int);
175extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
176extern long long simple_strtoll(const char *,char **,unsigned int);
Yi Yang06b2a762008-02-08 04:21:57 -0800177extern int strict_strtoul(const char *, unsigned int, unsigned long *);
178extern int strict_strtol(const char *, unsigned int, long *);
179extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
180extern int strict_strtoll(const char *, unsigned int, long long *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181extern int sprintf(char * buf, const char * fmt, ...)
182 __attribute__ ((format (printf, 2, 3)));
183extern int vsprintf(char *buf, const char *, va_list)
184 __attribute__ ((format (printf, 2, 0)));
185extern int snprintf(char * buf, size_t size, const char * fmt, ...)
186 __attribute__ ((format (printf, 3, 4)));
187extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
188 __attribute__ ((format (printf, 3, 0)));
189extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
190 __attribute__ ((format (printf, 3, 4)));
191extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
192 __attribute__ ((format (printf, 3, 0)));
Jeremy Fitzhardingee9059142006-06-25 05:49:17 -0700193extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
194 __attribute__ ((format (printf, 2, 3)));
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700195extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
197extern int sscanf(const char *, const char *, ...)
198 __attribute__ ((format (scanf, 2, 3)));
199extern int vsscanf(const char *, const char *, va_list)
200 __attribute__ ((format (scanf, 2, 0)));
201
202extern int get_option(char **str, int *pint);
203extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700204extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Trent Piepho5e376612006-05-15 09:44:06 -0700206extern int core_kernel_text(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207extern int __kernel_text_address(unsigned long addr);
208extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700209extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700210
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800211struct pid;
212extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Thomas Renningera0ad05c2008-09-01 14:27:02 +0200214/*
215 * FW_BUG
216 * Add this to a message where you are sure the firmware is buggy or behaves
217 * really stupid or out of spec. Be aware that the responsible BIOS developer
218 * should be able to fix this issue or at least get a concrete idea of the
219 * problem by reading your message without the need of looking at the kernel
220 * code.
221 *
222 * Use it for definite and high priority BIOS bugs.
223 *
224 * FW_WARN
225 * Use it for not that clear (e.g. could the kernel messed up things already?)
226 * and medium priority BIOS bugs.
227 *
228 * FW_INFO
229 * Use this one if you want to tell the user or vendor about something
230 * suspicious, but generally harmless related to the firmware.
231 *
232 * Use it for information or very low priority BIOS bugs.
233 */
234#define FW_BUG "[Firmware Bug]: "
235#define FW_WARN "[Firmware Warn]: "
236#define FW_INFO "[Firmware Info]: "
237
Matt Mackalld59745c2005-05-01 08:59:02 -0700238#ifdef CONFIG_PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239asmlinkage int vprintk(const char *fmt, va_list args)
240 __attribute__ ((format (printf, 1, 0)));
241asmlinkage int printk(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200242 __attribute__ ((format (printf, 1, 2))) __cold;
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800243
Dave Young717115e2008-07-25 01:45:58 -0700244extern struct ratelimit_state printk_ratelimit_state;
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800245extern int printk_ratelimit(void);
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800246extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
247 unsigned int interval_msec);
Ingo Molnarf036be92009-02-05 13:45:43 +0100248
Dave Youngaf913222009-09-22 16:43:33 -0700249extern int printk_delay_msec;
250
Ingo Molnarf036be92009-02-05 13:45:43 +0100251/*
252 * Print a one-time message (analogous to WARN_ONCE() et al):
253 */
254#define printk_once(x...) ({ \
Roland Dreier70867452009-09-22 16:43:46 -0700255 static bool __print_once = true; \
Ingo Molnarf036be92009-02-05 13:45:43 +0100256 \
257 if (__print_once) { \
Roland Dreier70867452009-09-22 16:43:46 -0700258 __print_once = false; \
Ingo Molnarf036be92009-02-05 13:45:43 +0100259 printk(x); \
260 } \
261})
262
Neil Horman04d491a2009-04-02 16:58:57 -0700263void log_buf_kexec_setup(void);
Matt Mackalld59745c2005-05-01 08:59:02 -0700264#else
265static inline int vprintk(const char *s, va_list args)
266 __attribute__ ((format (printf, 1, 0)));
267static inline int vprintk(const char *s, va_list args) { return 0; }
268static inline int printk(const char *s, ...)
269 __attribute__ ((format (printf, 1, 2)));
Andi Kleena586df02007-07-21 17:10:00 +0200270static inline int __cold printk(const char *s, ...) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800271static inline int printk_ratelimit(void) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800272static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
273 unsigned int interval_msec) \
274 { return false; }
Ingo Molnarf036be92009-02-05 13:45:43 +0100275
276/* No effect, but we still get type checking even in the !PRINTK case: */
277#define printk_once(x...) printk(x)
278
Neil Horman04d491a2009-04-02 16:58:57 -0700279static inline void log_buf_kexec_setup(void)
280{
281}
Matt Mackalld59745c2005-05-01 08:59:02 -0700282#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
Ingo Molnarced9cd42008-08-11 14:38:12 +0200284extern int printk_needs_cpu(int cpu);
285extern void printk_tick(void);
286
Jiri Slabye17ba732008-05-12 15:44:40 +0200287extern void asmlinkage __attribute__((format(printf, 1, 2)))
Ingo Molnar076f9772008-01-30 13:33:06 +0100288 early_printk(const char *fmt, ...);
289
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290unsigned long int_sqrt(unsigned long);
291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292static inline void console_silent(void)
293{
294 console_loglevel = 0;
295}
296
297static inline void console_verbose(void)
298{
299 if (console_loglevel)
300 console_loglevel = 15;
301}
302
303extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800304extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700306extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200308extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700309extern int panic_on_io_nmi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700311extern void add_taint(unsigned flag);
312extern int test_taint(unsigned flag);
313extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800314extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
316/* Values used for system_state */
317extern enum system_states {
318 SYSTEM_BOOTING,
319 SYSTEM_RUNNING,
320 SYSTEM_HALT,
321 SYSTEM_POWER_OFF,
322 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500323 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324} system_state;
325
Andi Kleen25ddbb12008-10-15 22:01:41 -0700326#define TAINT_PROPRIETARY_MODULE 0
327#define TAINT_FORCED_MODULE 1
328#define TAINT_UNSAFE_SMP 2
329#define TAINT_FORCED_RMMOD 3
330#define TAINT_MACHINE_CHECK 4
331#define TAINT_BAD_PAGE 5
332#define TAINT_USER 6
333#define TAINT_DIE 7
334#define TAINT_OVERRIDDEN_ACPI_TABLE 8
335#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700336#define TAINT_CRAP 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Andi Kleena586df02007-07-21 17:10:00 +0200338extern void dump_stack(void) __cold;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700340enum {
341 DUMP_PREFIX_NONE,
342 DUMP_PREFIX_ADDRESS,
343 DUMP_PREFIX_OFFSET
344};
Randy Dunlapc7909232007-06-08 13:47:04 -0700345extern void hex_dump_to_buffer(const void *buf, size_t len,
346 int rowsize, int groupsize,
347 char *linebuf, size_t linebuflen, bool ascii);
348extern void print_hex_dump(const char *level, const char *prefix_str,
349 int prefix_type, int rowsize, int groupsize,
Artem Bityutskiy6a0ed912007-08-07 23:43:14 +0300350 const void *buf, size_t len, bool ascii);
Randy Dunlapc7909232007-06-08 13:47:04 -0700351extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
Alan Sterneb9a9a52007-08-10 13:01:07 -0700352 const void *buf, size_t len);
Harvey Harrison3fc95772008-05-14 16:05:49 -0700353
354extern const char hex_asc[];
355#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
356#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
357
358static inline char *pack_hex_byte(char *buf, u8 byte)
359{
360 *buf++ = hex_asc_hi(byte);
361 *buf++ = hex_asc_lo(byte);
362 return buf;
363}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700364
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100365#ifndef pr_fmt
366#define pr_fmt(fmt) fmt
367#endif
368
369#define pr_emerg(fmt, ...) \
370 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
371#define pr_alert(fmt, ...) \
372 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
373#define pr_crit(fmt, ...) \
374 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
375#define pr_err(fmt, ...) \
376 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
377#define pr_warning(fmt, ...) \
378 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
379#define pr_notice(fmt, ...) \
380 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
381#define pr_info(fmt, ...) \
382 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
Cyrill Gorcunov311d0762009-03-31 15:23:51 -0700383#define pr_cont(fmt, ...) \
384 printk(KERN_CONT fmt, ##__VA_ARGS__)
Emil Medve1f7c8232007-10-16 23:29:48 -0700385
Michael Ellerman4ccb4572009-04-09 14:48:24 -0700386/* pr_devel() should produce zero code unless DEBUG is defined */
387#ifdef DEBUG
388#define pr_devel(fmt, ...) \
389 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
390#else
391#define pr_devel(fmt, ...) \
392 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
393#endif
394
Pavel Machek1cc6daf2006-08-08 01:37:15 +0200395/* If you are writing a driver, please use dev_dbg instead */
Cornelia Huckd0d85ff2008-12-04 16:55:47 +0100396#if defined(DEBUG)
397#define pr_debug(fmt, ...) \
398 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
Jason Barone9d376f2009-02-05 11:51:38 -0500399#elif defined(CONFIG_DYNAMIC_DEBUG)
Greg Bankse6e66b02009-03-11 21:07:28 +1100400/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
Jason Baron346e15b2008-08-12 16:46:19 -0400401#define pr_debug(fmt, ...) do { \
Greg Bankse6e66b02009-03-11 21:07:28 +1100402 dynamic_pr_debug(fmt, ##__VA_ARGS__); \
Jason Baron346e15b2008-08-12 16:46:19 -0400403 } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404#else
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100405#define pr_debug(fmt, ...) \
406 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407#endif
408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100410 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500411 * tracing_on/tracing_off and tracing_start()/tracing_stop
412 *
413 * Use tracing_on/tracing_off when you want to quickly turn on or off
414 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900415 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500416 * file, which gives a means for the kernel and userspace to interact.
417 * Place a tracing_off() in the kernel where you want tracing to end.
418 * From user space, examine the trace, and then echo 1 > tracing_on
419 * to continue tracing.
420 *
421 * tracing_stop/tracing_start has slightly more overhead. It is used
422 * by things like suspend to ram where disabling the recording of the
423 * trace is not enough, but tracing must actually stop because things
424 * like calling smp_processor_id() may crash the system.
425 *
426 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100427 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500428#ifdef CONFIG_RING_BUFFER
429void tracing_on(void);
430void tracing_off(void);
431/* trace_off_permanent stops recording with no way to bring it back */
432void tracing_off_permanent(void);
433int tracing_is_on(void);
434#else
435static inline void tracing_on(void) { }
436static inline void tracing_off(void) { }
437static inline void tracing_off_permanent(void) { }
438static inline int tracing_is_on(void) { return 0; }
439#endif
Ingo Molnar526211b2009-03-05 10:28:45 +0100440#ifdef CONFIG_TRACING
441extern void tracing_start(void);
442extern void tracing_stop(void);
443extern void ftrace_off_permanent(void);
444
445extern void
446ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
447
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100448static inline void __attribute__ ((format (printf, 1, 2)))
449____trace_printk_check_format(const char *fmt, ...)
450{
451}
452#define __trace_printk_check_format(fmt, args...) \
453do { \
454 if (0) \
455 ____trace_printk_check_format(fmt, ##args); \
456} while (0)
457
Ingo Molnar526211b2009-03-05 10:28:45 +0100458/**
459 * trace_printk - printf formatting in the ftrace buffer
460 * @fmt: the printf format for printing
461 *
462 * Note: __trace_printk is an internal function for trace_printk and
463 * the @ip is passed in via the trace_printk macro.
464 *
465 * This function allows a kernel developer to debug fast path sections
466 * that printk is not appropriate for. By scattering in various
467 * printk like tracing in the code, a developer can quickly see
468 * where problems are occurring.
469 *
470 * This is intended as a debugging tool for the developer only.
471 * Please refrain from leaving trace_printks scattered around in
472 * your code.
473 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100474
475#define trace_printk(fmt, args...) \
476do { \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100477 __trace_printk_check_format(fmt, ##args); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100478 if (__builtin_constant_p(fmt)) { \
479 static const char *trace_printk_fmt \
480 __attribute__((section("__trace_printk_fmt"))) = \
481 __builtin_constant_p(fmt) ? fmt : NULL; \
482 \
483 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
484 } else \
485 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100486} while (0)
487
Ingo Molnar526211b2009-03-05 10:28:45 +0100488extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100489__trace_bprintk(unsigned long ip, const char *fmt, ...)
490 __attribute__ ((format (printf, 2, 3)));
491
492extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100493__trace_printk(unsigned long ip, const char *fmt, ...)
494 __attribute__ ((format (printf, 2, 3)));
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100495
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100496/*
497 * The double __builtin_constant_p is because gcc will give us an error
498 * if we try to allocate the static variable to fmt if it is not a
499 * constant. Even with the outer if statement.
500 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100501#define ftrace_vprintk(fmt, vargs) \
502do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100503 if (__builtin_constant_p(fmt)) { \
504 static const char *trace_printk_fmt \
505 __attribute__((section("__trace_printk_fmt"))) = \
506 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100507 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100508 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
509 } else \
510 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100511} while (0)
512
Ingo Molnar526211b2009-03-05 10:28:45 +0100513extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100514__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
515
516extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100517__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100518
Ingo Molnar526211b2009-03-05 10:28:45 +0100519extern void ftrace_dump(void);
520#else
521static inline void
522ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
523static inline int
524trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
525
526static inline void tracing_start(void) { }
527static inline void tracing_stop(void) { }
528static inline void ftrace_off_permanent(void) { }
529static inline int
530trace_printk(const char *fmt, ...)
531{
532 return 0;
533}
534static inline int
535ftrace_vprintk(const char *fmt, va_list ap)
536{
537 return 0;
538}
539static inline void ftrace_dump(void) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100540#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100541
542/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 * Display an IP address in readable format.
544 */
545
546#define NIPQUAD(addr) \
547 ((unsigned char *)&addr)[0], \
548 ((unsigned char *)&addr)[1], \
549 ((unsigned char *)&addr)[2], \
550 ((unsigned char *)&addr)[3]
Joe Perches46b86a22006-01-13 14:29:07 -0800551#define NIPQUAD_FMT "%u.%u.%u.%u"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700554 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 * strict type-checking.. See the
556 * "unnecessary" pointer comparison.
557 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700558#define min(x, y) ({ \
559 typeof(x) _min1 = (x); \
560 typeof(y) _min2 = (y); \
561 (void) (&_min1 == &_min2); \
562 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700564#define max(x, y) ({ \
565 typeof(x) _max1 = (x); \
566 typeof(y) _max2 = (y); \
567 (void) (&_max1 == &_max2); \
568 _max1 > _max2 ? _max1 : _max2; })
569
570/**
571 * clamp - return a value clamped to a given range with strict typechecking
572 * @val: current value
573 * @min: minimum allowable value
574 * @max: maximum allowable value
575 *
576 * This macro does strict typechecking of min/max to make sure they are of the
577 * same type as val. See the unnecessary pointer comparisons.
578 */
579#define clamp(val, min, max) ({ \
580 typeof(val) __val = (val); \
581 typeof(min) __min = (min); \
582 typeof(max) __max = (max); \
583 (void) (&__val == &__min); \
584 (void) (&__val == &__max); \
585 __val = __val < __min ? __min: __val; \
586 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
588/*
589 * ..and if you can't take the strict
590 * types, you can specify one yourself.
591 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700592 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700594#define min_t(type, x, y) ({ \
595 type __min1 = (x); \
596 type __min2 = (y); \
597 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700599#define max_t(type, x, y) ({ \
600 type __max1 = (x); \
601 type __max2 = (y); \
602 __max1 > __max2 ? __max1: __max2; })
603
604/**
605 * clamp_t - return a value clamped to a given range using a given type
606 * @type: the type of variable to use
607 * @val: current value
608 * @min: minimum allowable value
609 * @max: maximum allowable value
610 *
611 * This macro does no typechecking and uses temporary variables of type
612 * 'type' to make all the comparisons.
613 */
614#define clamp_t(type, val, min, max) ({ \
615 type __val = (val); \
616 type __min = (min); \
617 type __max = (max); \
618 __val = __val < __min ? __min: __val; \
619 __val > __max ? __max: __val; })
620
621/**
622 * clamp_val - return a value clamped to a given range using val's type
623 * @val: current value
624 * @min: minimum allowable value
625 * @max: maximum allowable value
626 *
627 * This macro does no typechecking and uses temporary variables of whatever
628 * type the input argument 'val' is. This is useful when val is an unsigned
629 * type and min and max are literals that will otherwise be assigned a signed
630 * integer type.
631 */
632#define clamp_val(val, min, max) ({ \
633 typeof(val) __val = (val); \
634 typeof(val) __min = (min); \
635 typeof(val) __max = (max); \
636 __val = __val < __min ? __min: __val; \
637 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
Wu Fengguang91f68b72009-01-07 18:09:12 -0800639
640/*
641 * swap - swap value of @a and @b
642 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800643#define swap(a, b) \
644 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800645
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646/**
647 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 * @ptr: the pointer to the member.
649 * @type: the type of the container struct this is embedded in.
650 * @member: the name of the member within the struct.
651 *
652 */
653#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700654 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
655 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
Kyle McMartind4d23ad2007-02-10 01:46:00 -0800657struct sysinfo;
658extern int do_sysinfo(struct sysinfo *info);
659
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660#endif /* __KERNEL__ */
661
662#define SI_LOAD_SHIFT 16
663struct sysinfo {
664 long uptime; /* Seconds since boot */
665 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
666 unsigned long totalram; /* Total usable main memory size */
667 unsigned long freeram; /* Available memory size */
668 unsigned long sharedram; /* Amount of shared memory */
669 unsigned long bufferram; /* Memory used by buffers */
670 unsigned long totalswap; /* Total swap space size */
671 unsigned long freeswap; /* swap space still available */
672 unsigned short procs; /* Number of current processes */
673 unsigned short pad; /* explicit padding for m68k */
674 unsigned long totalhigh; /* Total high memory size */
675 unsigned long freehigh; /* Available high memory size */
676 unsigned int mem_unit; /* Memory unit size in bytes */
677 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
678};
679
Nikita Danilovc0398ee2005-10-30 15:03:10 -0800680/* Force a compilation error if condition is true */
Jan Beulich8c87df42009-09-22 16:43:52 -0700681#define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))
682
683/* Force a compilation error if condition is constant and true */
684#define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
Jan Beulich4552d5d2006-06-26 13:57:28 +0200686/* Force a compilation error if condition is true, but also produce a
687 result (of value 0 and type size_t), so the expression can be used
688 e.g. in a structure initializer (or where-ever else comma expressions
689 aren't permitted). */
Jan Beulich8c87df42009-09-22 16:43:52 -0700690#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
691#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
Jan Beulich4552d5d2006-06-26 13:57:28 +0200692
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693/* Trap pasters of __FUNCTION__ at compile-time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694#define __FUNCTION__ (__func__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695
Christoph Lameter08e0f6a2006-09-27 01:50:06 -0700696/* This helps us to avoid #ifdef CONFIG_NUMA */
697#ifdef CONFIG_NUMA
698#define NUMA_BUILD 1
699#else
700#define NUMA_BUILD 0
701#endif
702
Steven Rostedt29e71ab2008-08-14 15:45:10 -0400703/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
704#ifdef CONFIG_FTRACE_MCOUNT_RECORD
705# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
706#endif
707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708#endif