blob: 9365227dbaf6498f4b4318c7205e8e1a61103da5 [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>
Jason Barone9d376f2009-02-05 11:51:38 -050018#include <linux/dynamic_debug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <asm/byteorder.h>
20#include <asm/bug.h>
21
Roman Zippel3eb3c742007-01-10 14:45:28 +010022extern const char linux_banner[];
23extern const char linux_proc_banner[];
24
Zhang, Yanmin44f564a2008-04-29 01:00:55 -070025#define USHORT_MAX ((u16)(~0U))
26#define SHORT_MAX ((s16)(USHORT_MAX>>1))
27#define SHORT_MIN (-SHORT_MAX - 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#define INT_MAX ((int)(~0U>>1))
29#define INT_MIN (-INT_MAX - 1)
30#define UINT_MAX (~0U)
31#define LONG_MAX ((long)(~0UL>>1))
32#define LONG_MIN (-LONG_MAX - 1)
33#define ULONG_MAX (~0UL)
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -070034#define LLONG_MAX ((long long)(~0ULL>>1))
35#define LLONG_MIN (-LLONG_MAX - 1)
36#define ULLONG_MAX (~0ULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38#define STACK_MAGIC 0xdeadbeef
39
Linus Torvalds2ea58142006-11-26 19:05:22 -080040#define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
41#define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
Matthew Wilcoxa83308e2007-09-11 15:23:47 -070042#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
Herbert Xuf10db622008-02-06 01:37:05 -080043#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
Linus Torvalds2ea58142006-11-26 19:05:22 -080044
Rusty Russellc5e631c2007-05-06 14:51:05 -070045#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
46
Yinghai Lu9b3be9f2010-02-10 01:20:29 -080047/*
48 * This looks more complex than it should be. But we need to
49 * get the type for the ~ right in round_down (it needs to be
50 * as wide as the result!), and we want to evaluate the macro
51 * arguments just once each.
52 */
53#define __round_mask(x, y) ((__typeof__(x))((y)-1))
54#define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
55#define round_down(x, y) ((x) & ~__round_mask(x, y))
56
Jan Beulich4552d5d2006-06-26 13:57:28 +020057#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
Steven Whitehouse930631e2006-09-25 23:32:40 -070058#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
David Howellsb4cac1a2006-07-10 04:44:54 -070059#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
Darrick J. Wong9fe06082009-01-06 14:40:51 -080060#define DIV_ROUND_CLOSEST(x, divisor)( \
61{ \
62 typeof(divisor) __divisor = divisor; \
63 (((x) + ((__divisor) / 2)) / (__divisor)); \
64} \
65)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Eduard - Gabriel Munteanuca31e142008-07-05 12:14:23 +030067#define _RET_IP_ (unsigned long)__builtin_return_address(0)
68#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
69
Bartlomiej Zolnierkiewicz90c699a2009-06-19 08:08:50 +020070#ifdef CONFIG_LBDAF
Jens Axboe2da96ac2007-10-12 12:40:38 +020071# include <asm/div64.h>
72# define sector_div(a, b) do_div(a, b)
73#else
74# define sector_div(n, b)( \
75{ \
76 int _res; \
77 _res = (n) % (b); \
78 (n) /= (b); \
79 _res; \
80} \
81)
82#endif
83
Andrew Morton218e1802007-05-10 03:15:18 -070084/**
85 * upper_32_bits - return bits 32-63 of a number
86 * @n: the number we're accessing
87 *
88 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
89 * the "right shift count >= width of type" warning when that quantity is
90 * 32-bits.
91 */
92#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
93
Joerg Roedel204b8852008-07-29 22:33:42 -070094/**
95 * lower_32_bits - return bits 0-31 of a number
96 * @n: the number we're accessing
97 */
98#define lower_32_bits(n) ((u32)(n))
99
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100#define KERN_EMERG "<0>" /* system is unusable */
101#define KERN_ALERT "<1>" /* action must be taken immediately */
102#define KERN_CRIT "<2>" /* critical conditions */
103#define KERN_ERR "<3>" /* error conditions */
104#define KERN_WARNING "<4>" /* warning conditions */
105#define KERN_NOTICE "<5>" /* normal but significant condition */
106#define KERN_INFO "<6>" /* informational */
107#define KERN_DEBUG "<7>" /* debug-level messages */
108
Linus Torvaldse28d7132009-06-16 11:02:28 -0700109/* Use the default kernel loglevel */
110#define KERN_DEFAULT "<d>"
Ingo Molnar47492522007-10-16 23:30:29 -0700111/*
112 * Annotation for a "continued" line of log printout (only done after a
113 * line that had no enclosing \n). Only to be used by core/arch code
114 * during early bootup (a continued line is not SMP-safe otherwise).
115 */
Linus Torvalds5fd29d62009-06-16 10:57:02 -0700116#define KERN_CONT "<c>"
Ingo Molnar47492522007-10-16 23:30:29 -0700117
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118extern int console_printk[];
119
120#define console_loglevel (console_printk[0])
121#define default_message_loglevel (console_printk[1])
122#define minimum_console_loglevel (console_printk[2])
123#define default_console_loglevel (console_printk[3])
124
125struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800126struct pt_regs;
127struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700129#ifdef CONFIG_PREEMPT_VOLUNTARY
130extern int _cond_resched(void);
131# define might_resched() _cond_resched()
132#else
133# define might_resched() do { } while (0)
134#endif
135
Randy Dunlap7106a272008-10-29 14:01:15 -0700136#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
Simon Kagstromd8948372009-12-23 11:08:18 +0100137 void __might_sleep(const char *file, int line, int preempt_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138/**
139 * might_sleep - annotation for functions that can sleep
140 *
141 * this macro will print a stack trace if it is executed in an atomic
142 * context (spinlock, irq-handler, ...).
143 *
144 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100145 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 * supposed to.
147 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700148# define might_sleep() \
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200149 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700150#else
Simon Kagstromd8948372009-12-23 11:08:18 +0100151 static inline void __might_sleep(const char *file, int line,
152 int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700153# define might_sleep() do { might_resched(); } while (0)
154#endif
155
Hua Zhong368a5fa2006-06-23 02:05:42 -0700156#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158#define abs(x) ({ \
Rolf Eike Beera49c59c2009-09-22 16:44:03 -0700159 long __x = (x); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 (__x < 0) ? -__x : __x; \
161 })
162
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200163#ifdef CONFIG_PROVE_LOCKING
164void might_fault(void);
165#else
166static inline void might_fault(void)
167{
168 might_sleep();
169}
170#endif
171
Alan Sterne041c682006-03-27 01:16:30 -0800172extern struct atomic_notifier_head panic_notifier_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173extern long (*panic_blink)(long time);
174NORET_TYPE void panic(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200175 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800176extern void oops_enter(void);
177extern void oops_exit(void);
178extern int oops_may_print(void);
Harvey Harrisonec701582008-02-08 04:19:55 -0800179NORET_TYPE void do_exit(long error_code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 ATTRIB_NORET;
181NORET_TYPE void complete_and_exit(struct completion *, long)
182 ATTRIB_NORET;
183extern unsigned long simple_strtoul(const char *,char **,unsigned int);
184extern long simple_strtol(const char *,char **,unsigned int);
185extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
186extern long long simple_strtoll(const char *,char **,unsigned int);
Yi Yang06b2a762008-02-08 04:21:57 -0800187extern int strict_strtoul(const char *, unsigned int, unsigned long *);
188extern int strict_strtol(const char *, unsigned int, long *);
189extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
190extern int strict_strtoll(const char *, unsigned int, long long *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191extern int sprintf(char * buf, const char * fmt, ...)
192 __attribute__ ((format (printf, 2, 3)));
193extern int vsprintf(char *buf, const char *, va_list)
194 __attribute__ ((format (printf, 2, 0)));
195extern int snprintf(char * buf, size_t size, const char * fmt, ...)
196 __attribute__ ((format (printf, 3, 4)));
197extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
198 __attribute__ ((format (printf, 3, 0)));
199extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
200 __attribute__ ((format (printf, 3, 4)));
201extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
202 __attribute__ ((format (printf, 3, 0)));
Jeremy Fitzhardingee9059142006-06-25 05:49:17 -0700203extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
204 __attribute__ ((format (printf, 2, 3)));
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700205extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207extern int sscanf(const char *, const char *, ...)
208 __attribute__ ((format (scanf, 2, 3)));
209extern int vsscanf(const char *, const char *, va_list)
210 __attribute__ ((format (scanf, 2, 0)));
211
212extern int get_option(char **str, int *pint);
213extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700214extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Trent Piepho5e376612006-05-15 09:44:06 -0700216extern int core_kernel_text(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217extern int __kernel_text_address(unsigned long addr);
218extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700219extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700220
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800221struct pid;
222extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Thomas Renningera0ad05c2008-09-01 14:27:02 +0200224/*
225 * FW_BUG
226 * Add this to a message where you are sure the firmware is buggy or behaves
227 * really stupid or out of spec. Be aware that the responsible BIOS developer
228 * should be able to fix this issue or at least get a concrete idea of the
229 * problem by reading your message without the need of looking at the kernel
230 * code.
231 *
232 * Use it for definite and high priority BIOS bugs.
233 *
234 * FW_WARN
235 * Use it for not that clear (e.g. could the kernel messed up things already?)
236 * and medium priority BIOS bugs.
237 *
238 * FW_INFO
239 * Use this one if you want to tell the user or vendor about something
240 * suspicious, but generally harmless related to the firmware.
241 *
242 * Use it for information or very low priority BIOS bugs.
243 */
244#define FW_BUG "[Firmware Bug]: "
245#define FW_WARN "[Firmware Warn]: "
246#define FW_INFO "[Firmware Info]: "
247
Matt Mackalld59745c2005-05-01 08:59:02 -0700248#ifdef CONFIG_PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249asmlinkage int vprintk(const char *fmt, va_list args)
250 __attribute__ ((format (printf, 1, 0)));
251asmlinkage int printk(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200252 __attribute__ ((format (printf, 1, 2))) __cold;
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800253
Christian Borntraeger5c828712009-10-23 14:58:11 +0200254extern int __printk_ratelimit(const char *func);
255#define printk_ratelimit() __printk_ratelimit(__func__)
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800256extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
257 unsigned int interval_msec);
Ingo Molnarf036be92009-02-05 13:45:43 +0100258
Dave Youngaf913222009-09-22 16:43:33 -0700259extern int printk_delay_msec;
260
Ingo Molnarf036be92009-02-05 13:45:43 +0100261/*
262 * Print a one-time message (analogous to WARN_ONCE() et al):
263 */
264#define printk_once(x...) ({ \
Joe Perches0b2749a2009-12-14 18:00:19 -0800265 static bool __print_once; \
Ingo Molnarf036be92009-02-05 13:45:43 +0100266 \
Joe Perches0b2749a2009-12-14 18:00:19 -0800267 if (!__print_once) { \
268 __print_once = true; \
Ingo Molnarf036be92009-02-05 13:45:43 +0100269 printk(x); \
270 } \
271})
272
Neil Horman04d491a2009-04-02 16:58:57 -0700273void log_buf_kexec_setup(void);
Matt Mackalld59745c2005-05-01 08:59:02 -0700274#else
275static inline int vprintk(const char *s, va_list args)
276 __attribute__ ((format (printf, 1, 0)));
277static inline int vprintk(const char *s, va_list args) { return 0; }
278static inline int printk(const char *s, ...)
279 __attribute__ ((format (printf, 1, 2)));
Andi Kleena586df02007-07-21 17:10:00 +0200280static inline int __cold printk(const char *s, ...) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800281static inline int printk_ratelimit(void) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800282static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
283 unsigned int interval_msec) \
284 { return false; }
Ingo Molnarf036be92009-02-05 13:45:43 +0100285
286/* No effect, but we still get type checking even in the !PRINTK case: */
287#define printk_once(x...) printk(x)
288
Neil Horman04d491a2009-04-02 16:58:57 -0700289static inline void log_buf_kexec_setup(void)
290{
291}
Matt Mackalld59745c2005-05-01 08:59:02 -0700292#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Ingo Molnarced9cd42008-08-11 14:38:12 +0200294extern int printk_needs_cpu(int cpu);
295extern void printk_tick(void);
296
Jiri Slabye17ba732008-05-12 15:44:40 +0200297extern void asmlinkage __attribute__((format(printf, 1, 2)))
Ingo Molnar076f9772008-01-30 13:33:06 +0100298 early_printk(const char *fmt, ...);
299
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300unsigned long int_sqrt(unsigned long);
301
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302static inline void console_silent(void)
303{
304 console_loglevel = 0;
305}
306
307static inline void console_verbose(void)
308{
309 if (console_loglevel)
310 console_loglevel = 15;
311}
312
313extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800314extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700316extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200318extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700319extern int panic_on_io_nmi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700321extern void add_taint(unsigned flag);
322extern int test_taint(unsigned flag);
323extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800324extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326/* Values used for system_state */
327extern enum system_states {
328 SYSTEM_BOOTING,
329 SYSTEM_RUNNING,
330 SYSTEM_HALT,
331 SYSTEM_POWER_OFF,
332 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500333 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334} system_state;
335
Andi Kleen25ddbb12008-10-15 22:01:41 -0700336#define TAINT_PROPRIETARY_MODULE 0
337#define TAINT_FORCED_MODULE 1
338#define TAINT_UNSAFE_SMP 2
339#define TAINT_FORCED_RMMOD 3
340#define TAINT_MACHINE_CHECK 4
341#define TAINT_BAD_PAGE 5
342#define TAINT_USER 6
343#define TAINT_DIE 7
344#define TAINT_OVERRIDDEN_ACPI_TABLE 8
345#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700346#define TAINT_CRAP 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
Andi Kleena586df02007-07-21 17:10:00 +0200348extern void dump_stack(void) __cold;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700350enum {
351 DUMP_PREFIX_NONE,
352 DUMP_PREFIX_ADDRESS,
353 DUMP_PREFIX_OFFSET
354};
Randy Dunlapc7909232007-06-08 13:47:04 -0700355extern void hex_dump_to_buffer(const void *buf, size_t len,
356 int rowsize, int groupsize,
357 char *linebuf, size_t linebuflen, bool ascii);
358extern void print_hex_dump(const char *level, const char *prefix_str,
359 int prefix_type, int rowsize, int groupsize,
Artem Bityutskiy6a0ed912007-08-07 23:43:14 +0300360 const void *buf, size_t len, bool ascii);
Randy Dunlapc7909232007-06-08 13:47:04 -0700361extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
Alan Sterneb9a9a52007-08-10 13:01:07 -0700362 const void *buf, size_t len);
Harvey Harrison3fc95772008-05-14 16:05:49 -0700363
364extern const char hex_asc[];
365#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
366#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
367
368static inline char *pack_hex_byte(char *buf, u8 byte)
369{
370 *buf++ = hex_asc_hi(byte);
371 *buf++ = hex_asc_lo(byte);
372 return buf;
373}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700374
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100375#ifndef pr_fmt
376#define pr_fmt(fmt) fmt
377#endif
378
379#define pr_emerg(fmt, ...) \
380 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
381#define pr_alert(fmt, ...) \
382 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
383#define pr_crit(fmt, ...) \
384 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
385#define pr_err(fmt, ...) \
386 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
387#define pr_warning(fmt, ...) \
388 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
389#define pr_notice(fmt, ...) \
390 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
391#define pr_info(fmt, ...) \
392 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
Cyrill Gorcunov311d0762009-03-31 15:23:51 -0700393#define pr_cont(fmt, ...) \
394 printk(KERN_CONT fmt, ##__VA_ARGS__)
Emil Medve1f7c8232007-10-16 23:29:48 -0700395
Michael Ellerman4ccb4572009-04-09 14:48:24 -0700396/* pr_devel() should produce zero code unless DEBUG is defined */
397#ifdef DEBUG
398#define pr_devel(fmt, ...) \
399 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
400#else
401#define pr_devel(fmt, ...) \
402 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
403#endif
404
Pavel Machek1cc6daf2006-08-08 01:37:15 +0200405/* If you are writing a driver, please use dev_dbg instead */
Cornelia Huckd0d85ff2008-12-04 16:55:47 +0100406#if defined(DEBUG)
407#define pr_debug(fmt, ...) \
408 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
Jason Barone9d376f2009-02-05 11:51:38 -0500409#elif defined(CONFIG_DYNAMIC_DEBUG)
Greg Bankse6e66b02009-03-11 21:07:28 +1100410/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
Joe Perches00b55862009-12-14 18:00:14 -0800411#define pr_debug(fmt, ...) \
412 dynamic_pr_debug(fmt, ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413#else
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100414#define pr_debug(fmt, ...) \
415 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416#endif
417
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418/*
Joe Perches8a64f332009-12-14 18:00:25 -0800419 * ratelimited messages with local ratelimit_state,
420 * no local ratelimit_state used in the !PRINTK case
421 */
422#ifdef CONFIG_PRINTK
423#define printk_ratelimited(fmt, ...) ({ \
424 static struct ratelimit_state _rs = { \
425 .interval = DEFAULT_RATELIMIT_INTERVAL, \
426 .burst = DEFAULT_RATELIMIT_BURST, \
427 }; \
428 \
Yong Zhangbb1dc0b2010-04-06 14:35:02 -0700429 if (__ratelimit(&_rs)) \
Joe Perches8a64f332009-12-14 18:00:25 -0800430 printk(fmt, ##__VA_ARGS__); \
431})
432#else
433/* No effect, but we still get type checking even in the !PRINTK case: */
434#define printk_ratelimited printk
435#endif
436
437#define pr_emerg_ratelimited(fmt, ...) \
438 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
439#define pr_alert_ratelimited(fmt, ...) \
440 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
441#define pr_crit_ratelimited(fmt, ...) \
442 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
443#define pr_err_ratelimited(fmt, ...) \
444 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
445#define pr_warning_ratelimited(fmt, ...) \
446 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
447#define pr_notice_ratelimited(fmt, ...) \
448 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
449#define pr_info_ratelimited(fmt, ...) \
450 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
451/* no pr_cont_ratelimited, don't do that... */
452/* If you are writing a driver, please use dev_dbg instead */
453#if defined(DEBUG)
454#define pr_debug_ratelimited(fmt, ...) \
455 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
456#else
457#define pr_debug_ratelimited(fmt, ...) \
458 ({ if (0) printk_ratelimited(KERN_DEBUG pr_fmt(fmt), \
459 ##__VA_ARGS__); 0; })
460#endif
461
462/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100463 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500464 * tracing_on/tracing_off and tracing_start()/tracing_stop
465 *
466 * Use tracing_on/tracing_off when you want to quickly turn on or off
467 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900468 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500469 * file, which gives a means for the kernel and userspace to interact.
470 * Place a tracing_off() in the kernel where you want tracing to end.
471 * From user space, examine the trace, and then echo 1 > tracing_on
472 * to continue tracing.
473 *
474 * tracing_stop/tracing_start has slightly more overhead. It is used
475 * by things like suspend to ram where disabling the recording of the
476 * trace is not enough, but tracing must actually stop because things
477 * like calling smp_processor_id() may crash the system.
478 *
479 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100480 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500481#ifdef CONFIG_RING_BUFFER
482void tracing_on(void);
483void tracing_off(void);
484/* trace_off_permanent stops recording with no way to bring it back */
485void tracing_off_permanent(void);
486int tracing_is_on(void);
487#else
488static inline void tracing_on(void) { }
489static inline void tracing_off(void) { }
490static inline void tracing_off_permanent(void) { }
491static inline int tracing_is_on(void) { return 0; }
492#endif
Ingo Molnar526211b2009-03-05 10:28:45 +0100493#ifdef CONFIG_TRACING
494extern void tracing_start(void);
495extern void tracing_stop(void);
496extern void ftrace_off_permanent(void);
497
498extern void
499ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
500
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100501static inline void __attribute__ ((format (printf, 1, 2)))
502____trace_printk_check_format(const char *fmt, ...)
503{
504}
505#define __trace_printk_check_format(fmt, args...) \
506do { \
507 if (0) \
508 ____trace_printk_check_format(fmt, ##args); \
509} while (0)
510
Ingo Molnar526211b2009-03-05 10:28:45 +0100511/**
512 * trace_printk - printf formatting in the ftrace buffer
513 * @fmt: the printf format for printing
514 *
515 * Note: __trace_printk is an internal function for trace_printk and
516 * the @ip is passed in via the trace_printk macro.
517 *
518 * This function allows a kernel developer to debug fast path sections
519 * that printk is not appropriate for. By scattering in various
520 * printk like tracing in the code, a developer can quickly see
521 * where problems are occurring.
522 *
523 * This is intended as a debugging tool for the developer only.
524 * Please refrain from leaving trace_printks scattered around in
525 * your code.
526 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100527
528#define trace_printk(fmt, args...) \
529do { \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100530 __trace_printk_check_format(fmt, ##args); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100531 if (__builtin_constant_p(fmt)) { \
532 static const char *trace_printk_fmt \
533 __attribute__((section("__trace_printk_fmt"))) = \
534 __builtin_constant_p(fmt) ? fmt : NULL; \
535 \
536 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
537 } else \
538 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100539} while (0)
540
Ingo Molnar526211b2009-03-05 10:28:45 +0100541extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100542__trace_bprintk(unsigned long ip, const char *fmt, ...)
543 __attribute__ ((format (printf, 2, 3)));
544
545extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100546__trace_printk(unsigned long ip, const char *fmt, ...)
547 __attribute__ ((format (printf, 2, 3)));
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100548
Steven Rostedt03889382009-12-11 09:48:22 -0500549extern void trace_dump_stack(void);
550
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100551/*
552 * The double __builtin_constant_p is because gcc will give us an error
553 * if we try to allocate the static variable to fmt if it is not a
554 * constant. Even with the outer if statement.
555 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100556#define ftrace_vprintk(fmt, vargs) \
557do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100558 if (__builtin_constant_p(fmt)) { \
559 static const char *trace_printk_fmt \
560 __attribute__((section("__trace_printk_fmt"))) = \
561 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100562 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100563 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
564 } else \
565 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100566} while (0)
567
Ingo Molnar526211b2009-03-05 10:28:45 +0100568extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100569__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
570
571extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100572__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100573
Ingo Molnar526211b2009-03-05 10:28:45 +0100574extern void ftrace_dump(void);
575#else
576static inline void
577ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
578static inline int
579trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
580
581static inline void tracing_start(void) { }
582static inline void tracing_stop(void) { }
583static inline void ftrace_off_permanent(void) { }
Steven Rostedte36c5452009-12-14 15:58:33 -0500584static inline void trace_dump_stack(void) { }
Ingo Molnar526211b2009-03-05 10:28:45 +0100585static inline int
586trace_printk(const char *fmt, ...)
587{
588 return 0;
589}
590static inline int
591ftrace_vprintk(const char *fmt, va_list ap)
592{
593 return 0;
594}
595static inline void ftrace_dump(void) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100596#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100597
598/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 * Display an IP address in readable format.
600 */
601
602#define NIPQUAD(addr) \
603 ((unsigned char *)&addr)[0], \
604 ((unsigned char *)&addr)[1], \
605 ((unsigned char *)&addr)[2], \
606 ((unsigned char *)&addr)[3]
Joe Perches46b86a22006-01-13 14:29:07 -0800607#define NIPQUAD_FMT "%u.%u.%u.%u"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700610 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 * strict type-checking.. See the
612 * "unnecessary" pointer comparison.
613 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700614#define min(x, y) ({ \
615 typeof(x) _min1 = (x); \
616 typeof(y) _min2 = (y); \
617 (void) (&_min1 == &_min2); \
618 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700620#define max(x, y) ({ \
621 typeof(x) _max1 = (x); \
622 typeof(y) _max2 = (y); \
623 (void) (&_max1 == &_max2); \
624 _max1 > _max2 ? _max1 : _max2; })
625
626/**
627 * clamp - return a value clamped to a given range with strict typechecking
628 * @val: current value
629 * @min: minimum allowable value
630 * @max: maximum allowable value
631 *
632 * This macro does strict typechecking of min/max to make sure they are of the
633 * same type as val. See the unnecessary pointer comparisons.
634 */
635#define clamp(val, min, max) ({ \
636 typeof(val) __val = (val); \
637 typeof(min) __min = (min); \
638 typeof(max) __max = (max); \
639 (void) (&__val == &__min); \
640 (void) (&__val == &__max); \
641 __val = __val < __min ? __min: __val; \
642 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
644/*
645 * ..and if you can't take the strict
646 * types, you can specify one yourself.
647 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700648 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700650#define min_t(type, x, y) ({ \
651 type __min1 = (x); \
652 type __min2 = (y); \
653 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700655#define max_t(type, x, y) ({ \
656 type __max1 = (x); \
657 type __max2 = (y); \
658 __max1 > __max2 ? __max1: __max2; })
659
660/**
661 * clamp_t - return a value clamped to a given range using a given type
662 * @type: the type of variable to use
663 * @val: current value
664 * @min: minimum allowable value
665 * @max: maximum allowable value
666 *
667 * This macro does no typechecking and uses temporary variables of type
668 * 'type' to make all the comparisons.
669 */
670#define clamp_t(type, val, min, max) ({ \
671 type __val = (val); \
672 type __min = (min); \
673 type __max = (max); \
674 __val = __val < __min ? __min: __val; \
675 __val > __max ? __max: __val; })
676
677/**
678 * clamp_val - return a value clamped to a given range using val's type
679 * @val: current value
680 * @min: minimum allowable value
681 * @max: maximum allowable value
682 *
683 * This macro does no typechecking and uses temporary variables of whatever
684 * type the input argument 'val' is. This is useful when val is an unsigned
685 * type and min and max are literals that will otherwise be assigned a signed
686 * integer type.
687 */
688#define clamp_val(val, min, max) ({ \
689 typeof(val) __val = (val); \
690 typeof(val) __min = (min); \
691 typeof(val) __max = (max); \
692 __val = __val < __min ? __min: __val; \
693 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Wu Fengguang91f68b72009-01-07 18:09:12 -0800695
696/*
697 * swap - swap value of @a and @b
698 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800699#define swap(a, b) \
700 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800701
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702/**
703 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 * @ptr: the pointer to the member.
705 * @type: the type of the container struct this is embedded in.
706 * @member: the name of the member within the struct.
707 *
708 */
709#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700710 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
711 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
Kyle McMartind4d23ad2007-02-10 01:46:00 -0800713struct sysinfo;
714extern int do_sysinfo(struct sysinfo *info);
715
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716#endif /* __KERNEL__ */
717
Arnd Bergmannc01226c2009-09-21 16:37:12 +0200718#ifndef __EXPORTED_HEADERS__
719#ifndef __KERNEL__
720#warning Attempt to use kernel headers from user space, see http://kernelnewbies.org/KernelHeaders
721#endif /* __KERNEL__ */
722#endif /* __EXPORTED_HEADERS__ */
723
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724#define SI_LOAD_SHIFT 16
725struct sysinfo {
726 long uptime; /* Seconds since boot */
727 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
728 unsigned long totalram; /* Total usable main memory size */
729 unsigned long freeram; /* Available memory size */
730 unsigned long sharedram; /* Amount of shared memory */
731 unsigned long bufferram; /* Memory used by buffers */
732 unsigned long totalswap; /* Total swap space size */
733 unsigned long freeswap; /* swap space still available */
734 unsigned short procs; /* Number of current processes */
735 unsigned short pad; /* explicit padding for m68k */
736 unsigned long totalhigh; /* Total high memory size */
737 unsigned long freehigh; /* Available high memory size */
738 unsigned int mem_unit; /* Memory unit size in bytes */
739 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
740};
741
Nikita Danilovc0398ee2005-10-30 15:03:10 -0800742/* Force a compilation error if condition is true */
Jan Beulich8c87df42009-09-22 16:43:52 -0700743#define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))
744
745/* Force a compilation error if condition is constant and true */
746#define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
Roland Dreiercc8ef6e2010-01-15 17:01:22 -0800748/* Force a compilation error if a constant expression is not a power of 2 */
749#define BUILD_BUG_ON_NOT_POWER_OF_2(n) \
750 BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
751
Jan Beulich4552d5d2006-06-26 13:57:28 +0200752/* Force a compilation error if condition is true, but also produce a
753 result (of value 0 and type size_t), so the expression can be used
754 e.g. in a structure initializer (or where-ever else comma expressions
755 aren't permitted). */
Jan Beulich8c87df42009-09-22 16:43:52 -0700756#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
757#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
Jan Beulich4552d5d2006-06-26 13:57:28 +0200758
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759/* Trap pasters of __FUNCTION__ at compile-time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760#define __FUNCTION__ (__func__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
Christoph Lameter08e0f6a2006-09-27 01:50:06 -0700762/* This helps us to avoid #ifdef CONFIG_NUMA */
763#ifdef CONFIG_NUMA
764#define NUMA_BUILD 1
765#else
766#define NUMA_BUILD 0
767#endif
768
Steven Rostedt29e71ab2008-08-14 15:45:10 -0400769/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
770#ifdef CONFIG_FTRACE_MCOUNT_RECORD
771# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
772#endif
773
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774#endif