blob: 1759ba5adce845fa08d4b1fd899920ac65436938 [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 */
Alexey Dobriyana79ff732010-04-13 11:21:46 +02007#define __ALIGN_KERNEL(x, a) __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
8#define __ALIGN_KERNEL_MASK(x, mask) (((x) + (mask)) & ~(mask))
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
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>
David Howellsf0d1b0b2006-12-08 02:37:49 -080018#include <linux/log2.h>
Andrew Mortone0deaff42008-07-25 01:45:24 -070019#include <linux/typecheck.h>
Jason Barone9d376f2009-02-05 11:51:38 -050020#include <linux/dynamic_debug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <asm/byteorder.h>
22#include <asm/bug.h>
23
Roman Zippel3eb3c742007-01-10 14:45:28 +010024extern const char linux_banner[];
25extern const char linux_proc_banner[];
26
Alexey Dobriyan4be929b2010-05-24 14:33:03 -070027#define USHRT_MAX ((u16)(~0U))
28#define SHRT_MAX ((s16)(USHRT_MAX>>1))
29#define SHRT_MIN ((s16)(-SHRT_MAX - 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#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)
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -070036#define LLONG_MAX ((long long)(~0ULL>>1))
37#define LLONG_MIN (-LLONG_MAX - 1)
38#define ULLONG_MAX (~0ULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40#define STACK_MAGIC 0xdeadbeef
41
Alexey Dobriyana79ff732010-04-13 11:21:46 +020042#define ALIGN(x, a) __ALIGN_KERNEL((x), (a))
Alexey Dobriyan9f93ff52010-04-13 14:09:15 +020043#define __ALIGN_MASK(x, mask) __ALIGN_KERNEL_MASK((x), (mask))
Matthew Wilcoxa83308e2007-09-11 15:23:47 -070044#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
Herbert Xuf10db622008-02-06 01:37:05 -080045#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
Linus Torvalds2ea58142006-11-26 19:05:22 -080046
Rusty Russellc5e631cf2007-05-06 14:51:05 -070047#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
48
Yinghai Lu9b3be9f2010-02-10 01:20:29 -080049/*
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
Jan Beulich4552d5d2006-06-26 13:57:28 +020059#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
Steven Whitehouse930631e2006-09-25 23:32:40 -070060#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
Eric Parisb28efd52010-10-13 17:50:08 -040061#define roundup(x, y) ( \
62{ \
63 typeof(y) __y = y; \
64 (((x) + (__y - 1)) / __y) * __y; \
65} \
66)
Eric Paris686a0f32010-10-13 17:50:02 -040067#define rounddown(x, y) ( \
68{ \
69 typeof(x) __x = (x); \
70 __x - (__x % (y)); \
71} \
72)
Darrick J. Wong9fe06082009-01-06 14:40:51 -080073#define DIV_ROUND_CLOSEST(x, divisor)( \
74{ \
75 typeof(divisor) __divisor = divisor; \
76 (((x) + ((__divisor) / 2)) / (__divisor)); \
77} \
78)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Eduard - Gabriel Munteanuca31e142008-07-05 12:14:23 +030080#define _RET_IP_ (unsigned long)__builtin_return_address(0)
81#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
82
Bartlomiej Zolnierkiewicz90c699a2009-06-19 08:08:50 +020083#ifdef CONFIG_LBDAF
Jens Axboe2da96ac2007-10-12 12:40:38 +020084# include <asm/div64.h>
85# define sector_div(a, b) do_div(a, b)
86#else
87# define sector_div(n, b)( \
88{ \
89 int _res; \
90 _res = (n) % (b); \
91 (n) /= (b); \
92 _res; \
93} \
94)
95#endif
96
Andrew Morton218e1802007-05-10 03:15:18 -070097/**
98 * upper_32_bits - return bits 32-63 of a number
99 * @n: the number we're accessing
100 *
101 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
102 * the "right shift count >= width of type" warning when that quantity is
103 * 32-bits.
104 */
105#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
106
Joerg Roedel204b8852008-07-29 22:33:42 -0700107/**
108 * lower_32_bits - return bits 0-31 of a number
109 * @n: the number we're accessing
110 */
111#define lower_32_bits(n) ((u32)(n))
112
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113#define KERN_EMERG "<0>" /* system is unusable */
114#define KERN_ALERT "<1>" /* action must be taken immediately */
115#define KERN_CRIT "<2>" /* critical conditions */
116#define KERN_ERR "<3>" /* error conditions */
117#define KERN_WARNING "<4>" /* warning conditions */
118#define KERN_NOTICE "<5>" /* normal but significant condition */
119#define KERN_INFO "<6>" /* informational */
120#define KERN_DEBUG "<7>" /* debug-level messages */
121
Linus Torvaldse28d7132009-06-16 11:02:28 -0700122/* Use the default kernel loglevel */
123#define KERN_DEFAULT "<d>"
Ingo Molnar47492522007-10-16 23:30:29 -0700124/*
125 * Annotation for a "continued" line of log printout (only done after a
126 * line that had no enclosing \n). Only to be used by core/arch code
127 * during early bootup (a continued line is not SMP-safe otherwise).
128 */
Linus Torvalds5fd29d62009-06-16 10:57:02 -0700129#define KERN_CONT "<c>"
Ingo Molnar47492522007-10-16 23:30:29 -0700130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131extern int console_printk[];
132
133#define console_loglevel (console_printk[0])
134#define default_message_loglevel (console_printk[1])
135#define minimum_console_loglevel (console_printk[2])
136#define default_console_loglevel (console_printk[3])
137
138struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800139struct pt_regs;
140struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700142#ifdef CONFIG_PREEMPT_VOLUNTARY
143extern int _cond_resched(void);
144# define might_resched() _cond_resched()
145#else
146# define might_resched() do { } while (0)
147#endif
148
Randy Dunlap7106a272008-10-29 14:01:15 -0700149#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
Simon Kagstromd8948372009-12-23 11:08:18 +0100150 void __might_sleep(const char *file, int line, int preempt_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151/**
152 * might_sleep - annotation for functions that can sleep
153 *
154 * this macro will print a stack trace if it is executed in an atomic
155 * context (spinlock, irq-handler, ...).
156 *
157 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100158 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 * supposed to.
160 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700161# define might_sleep() \
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200162 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700163#else
Simon Kagstromd8948372009-12-23 11:08:18 +0100164 static inline void __might_sleep(const char *file, int line,
165 int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700166# define might_sleep() do { might_resched(); } while (0)
167#endif
168
Hua Zhong368a5fa2006-06-23 02:05:42 -0700169#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171#define abs(x) ({ \
Rolf Eike Beera49c59c2009-09-22 16:44:03 -0700172 long __x = (x); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 (__x < 0) ? -__x : __x; \
174 })
175
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200176#ifdef CONFIG_PROVE_LOCKING
177void might_fault(void);
178#else
179static inline void might_fault(void)
180{
181 might_sleep();
182}
183#endif
184
Joe Perches7db6f5f2010-06-27 01:02:33 +0000185struct va_format {
186 const char *fmt;
187 va_list *va;
188};
189
Alan Sterne041c682006-03-27 01:16:30 -0800190extern struct atomic_notifier_head panic_notifier_list;
TAMUKI Shoichic7ff0d92010-08-10 18:03:28 -0700191extern long (*panic_blink)(int state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192NORET_TYPE void panic(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200193 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800194extern void oops_enter(void);
195extern void oops_exit(void);
Anton Blanchard863a6042010-08-10 18:03:30 -0700196void print_oops_end_marker(void);
Andrew Mortondd287792006-03-23 03:00:57 -0800197extern int oops_may_print(void);
Harvey Harrisonec701582008-02-08 04:19:55 -0800198NORET_TYPE void do_exit(long error_code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 ATTRIB_NORET;
200NORET_TYPE void complete_and_exit(struct completion *, long)
201 ATTRIB_NORET;
202extern unsigned long simple_strtoul(const char *,char **,unsigned int);
203extern long simple_strtol(const char *,char **,unsigned int);
204extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
205extern long long simple_strtoll(const char *,char **,unsigned int);
Yi Yang06b2a762008-02-08 04:21:57 -0800206extern int strict_strtoul(const char *, unsigned int, unsigned long *);
207extern int strict_strtol(const char *, unsigned int, long *);
208extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
209extern int strict_strtoll(const char *, unsigned int, long long *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210extern int sprintf(char * buf, const char * fmt, ...)
211 __attribute__ ((format (printf, 2, 3)));
212extern int vsprintf(char *buf, const char *, va_list)
213 __attribute__ ((format (printf, 2, 0)));
214extern int snprintf(char * buf, size_t size, const char * fmt, ...)
215 __attribute__ ((format (printf, 3, 4)));
216extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
217 __attribute__ ((format (printf, 3, 0)));
218extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
219 __attribute__ ((format (printf, 3, 4)));
220extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
221 __attribute__ ((format (printf, 3, 0)));
Jeremy Fitzhardingee9059142006-06-25 05:49:17 -0700222extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
223 __attribute__ ((format (printf, 2, 3)));
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700224extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
226extern int sscanf(const char *, const char *, ...)
227 __attribute__ ((format (scanf, 2, 3)));
228extern int vsscanf(const char *, const char *, va_list)
229 __attribute__ ((format (scanf, 2, 0)));
230
231extern int get_option(char **str, int *pint);
232extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700233extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Trent Piepho5e376612006-05-15 09:44:06 -0700235extern int core_kernel_text(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236extern int __kernel_text_address(unsigned long addr);
237extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700238extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700239
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800240struct pid;
241extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Thomas Renningera0ad05c2008-09-01 14:27:02 +0200243/*
244 * FW_BUG
245 * Add this to a message where you are sure the firmware is buggy or behaves
246 * really stupid or out of spec. Be aware that the responsible BIOS developer
247 * should be able to fix this issue or at least get a concrete idea of the
248 * problem by reading your message without the need of looking at the kernel
249 * code.
250 *
251 * Use it for definite and high priority BIOS bugs.
252 *
253 * FW_WARN
254 * Use it for not that clear (e.g. could the kernel messed up things already?)
255 * and medium priority BIOS bugs.
256 *
257 * FW_INFO
258 * Use this one if you want to tell the user or vendor about something
259 * suspicious, but generally harmless related to the firmware.
260 *
261 * Use it for information or very low priority BIOS bugs.
262 */
263#define FW_BUG "[Firmware Bug]: "
264#define FW_WARN "[Firmware Warn]: "
265#define FW_INFO "[Firmware Info]: "
266
Huang Yingc6de9f02010-05-31 16:48:09 +0800267/*
268 * HW_ERR
269 * Add this to a message for hardware errors, so that user can report
270 * it to hardware vendor instead of LKML or software vendor.
271 */
272#define HW_ERR "[Hardware Error]: "
273
Matt Mackalld59745c2005-05-01 08:59:02 -0700274#ifdef CONFIG_PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275asmlinkage int vprintk(const char *fmt, va_list args)
276 __attribute__ ((format (printf, 1, 0)));
277asmlinkage int printk(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200278 __attribute__ ((format (printf, 1, 2))) __cold;
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800279
Christian Borntraeger5c828712009-10-23 14:58:11 +0200280extern int __printk_ratelimit(const char *func);
281#define printk_ratelimit() __printk_ratelimit(__func__)
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800282extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
283 unsigned int interval_msec);
Ingo Molnarf036be92009-02-05 13:45:43 +0100284
Dave Youngaf913222009-09-22 16:43:33 -0700285extern int printk_delay_msec;
286
Ingo Molnarf036be92009-02-05 13:45:43 +0100287/*
288 * Print a one-time message (analogous to WARN_ONCE() et al):
289 */
290#define printk_once(x...) ({ \
Joe Perches0b2749a2009-12-14 18:00:19 -0800291 static bool __print_once; \
Ingo Molnarf036be92009-02-05 13:45:43 +0100292 \
Joe Perches0b2749a2009-12-14 18:00:19 -0800293 if (!__print_once) { \
294 __print_once = true; \
Ingo Molnarf036be92009-02-05 13:45:43 +0100295 printk(x); \
296 } \
297})
298
Neil Horman04d491a2009-04-02 16:58:57 -0700299void log_buf_kexec_setup(void);
Matt Mackalld59745c2005-05-01 08:59:02 -0700300#else
301static inline int vprintk(const char *s, va_list args)
302 __attribute__ ((format (printf, 1, 0)));
303static inline int vprintk(const char *s, va_list args) { return 0; }
304static inline int printk(const char *s, ...)
305 __attribute__ ((format (printf, 1, 2)));
Andi Kleena586df02007-07-21 17:10:00 +0200306static inline int __cold printk(const char *s, ...) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800307static inline int printk_ratelimit(void) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800308static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
309 unsigned int interval_msec) \
310 { return false; }
Ingo Molnarf036be92009-02-05 13:45:43 +0100311
312/* No effect, but we still get type checking even in the !PRINTK case: */
313#define printk_once(x...) printk(x)
314
Neil Horman04d491a2009-04-02 16:58:57 -0700315static inline void log_buf_kexec_setup(void)
316{
317}
Matt Mackalld59745c2005-05-01 08:59:02 -0700318#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
David Howells12fdff32010-08-12 16:54:57 +0100320/*
321 * Dummy printk for disabled debugging statements to use whilst maintaining
322 * gcc's format and side-effect checking.
323 */
324static inline __attribute__ ((format (printf, 1, 2)))
325int no_printk(const char *s, ...) { return 0; }
326
Ingo Molnarced9cd42008-08-11 14:38:12 +0200327extern int printk_needs_cpu(int cpu);
328extern void printk_tick(void);
329
Jiri Slabye17ba732008-05-12 15:44:40 +0200330extern void asmlinkage __attribute__((format(printf, 1, 2)))
Ingo Molnar076f9772008-01-30 13:33:06 +0100331 early_printk(const char *fmt, ...);
332
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333unsigned long int_sqrt(unsigned long);
334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335static inline void console_silent(void)
336{
337 console_loglevel = 0;
338}
339
340static inline void console_verbose(void)
341{
342 if (console_loglevel)
343 console_loglevel = 15;
344}
345
346extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800347extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700349extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200351extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700352extern int panic_on_io_nmi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700354extern void add_taint(unsigned flag);
355extern int test_taint(unsigned flag);
356extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800357extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
359/* Values used for system_state */
360extern enum system_states {
361 SYSTEM_BOOTING,
362 SYSTEM_RUNNING,
363 SYSTEM_HALT,
364 SYSTEM_POWER_OFF,
365 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500366 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367} system_state;
368
Andi Kleen25ddbb12008-10-15 22:01:41 -0700369#define TAINT_PROPRIETARY_MODULE 0
370#define TAINT_FORCED_MODULE 1
371#define TAINT_UNSAFE_SMP 2
372#define TAINT_FORCED_RMMOD 3
373#define TAINT_MACHINE_CHECK 4
374#define TAINT_BAD_PAGE 5
375#define TAINT_USER 6
376#define TAINT_DIE 7
377#define TAINT_OVERRIDDEN_ACPI_TABLE 8
378#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700379#define TAINT_CRAP 10
Ben Hutchings92946bc2010-04-03 19:36:42 +0100380#define TAINT_FIRMWARE_WORKAROUND 11
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
Andi Kleena586df02007-07-21 17:10:00 +0200382extern void dump_stack(void) __cold;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700384enum {
385 DUMP_PREFIX_NONE,
386 DUMP_PREFIX_ADDRESS,
387 DUMP_PREFIX_OFFSET
388};
Randy Dunlapc7909232007-06-08 13:47:04 -0700389extern void hex_dump_to_buffer(const void *buf, size_t len,
390 int rowsize, int groupsize,
391 char *linebuf, size_t linebuflen, bool ascii);
392extern void print_hex_dump(const char *level, const char *prefix_str,
393 int prefix_type, int rowsize, int groupsize,
Artem Bityutskiy6a0ed912007-08-07 23:43:14 +0300394 const void *buf, size_t len, bool ascii);
Randy Dunlapc7909232007-06-08 13:47:04 -0700395extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
Alan Sterneb9a9a52007-08-10 13:01:07 -0700396 const void *buf, size_t len);
Harvey Harrison3fc95772008-05-14 16:05:49 -0700397
398extern const char hex_asc[];
399#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
400#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
401
402static inline char *pack_hex_byte(char *buf, u8 byte)
403{
404 *buf++ = hex_asc_hi(byte);
405 *buf++ = hex_asc_lo(byte);
406 return buf;
407}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700408
Andy Shevchenko903788892010-05-24 14:33:23 -0700409extern int hex_to_bin(char ch);
410
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100411#ifndef pr_fmt
412#define pr_fmt(fmt) fmt
413#endif
414
415#define pr_emerg(fmt, ...) \
416 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
417#define pr_alert(fmt, ...) \
418 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
419#define pr_crit(fmt, ...) \
420 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
421#define pr_err(fmt, ...) \
422 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
423#define pr_warning(fmt, ...) \
424 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
Joe Perchesfc62f2f2010-05-24 14:33:08 -0700425#define pr_warn pr_warning
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100426#define pr_notice(fmt, ...) \
427 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
428#define pr_info(fmt, ...) \
429 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
Cyrill Gorcunov311d0762009-03-31 15:23:51 -0700430#define pr_cont(fmt, ...) \
431 printk(KERN_CONT fmt, ##__VA_ARGS__)
Emil Medve1f7c8232007-10-16 23:29:48 -0700432
Michael Ellerman4ccb4572009-04-09 14:48:24 -0700433/* pr_devel() should produce zero code unless DEBUG is defined */
434#ifdef DEBUG
435#define pr_devel(fmt, ...) \
436 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
437#else
438#define pr_devel(fmt, ...) \
439 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
440#endif
441
Pavel Machek1cc6daf2006-08-08 01:37:15 +0200442/* If you are writing a driver, please use dev_dbg instead */
Cornelia Huckd0d85ff2008-12-04 16:55:47 +0100443#if defined(DEBUG)
444#define pr_debug(fmt, ...) \
445 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
Jason Barone9d376f2009-02-05 11:51:38 -0500446#elif defined(CONFIG_DYNAMIC_DEBUG)
Greg Bankse6e66b02009-03-11 21:07:28 +1100447/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
Joe Perches00b55862009-12-14 18:00:14 -0800448#define pr_debug(fmt, ...) \
449 dynamic_pr_debug(fmt, ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450#else
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100451#define pr_debug(fmt, ...) \
452 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453#endif
454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455/*
Joe Perches8a64f332009-12-14 18:00:25 -0800456 * ratelimited messages with local ratelimit_state,
457 * no local ratelimit_state used in the !PRINTK case
458 */
459#ifdef CONFIG_PRINTK
OGAWA Hirofumid8521fc2010-05-24 14:33:11 -0700460#define printk_ratelimited(fmt, ...) ({ \
461 static DEFINE_RATELIMIT_STATE(_rs, \
462 DEFAULT_RATELIMIT_INTERVAL, \
463 DEFAULT_RATELIMIT_BURST); \
464 \
465 if (__ratelimit(&_rs)) \
466 printk(fmt, ##__VA_ARGS__); \
Joe Perches8a64f332009-12-14 18:00:25 -0800467})
468#else
469/* No effect, but we still get type checking even in the !PRINTK case: */
470#define printk_ratelimited printk
471#endif
472
473#define pr_emerg_ratelimited(fmt, ...) \
474 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
475#define pr_alert_ratelimited(fmt, ...) \
476 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
477#define pr_crit_ratelimited(fmt, ...) \
478 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
479#define pr_err_ratelimited(fmt, ...) \
480 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
481#define pr_warning_ratelimited(fmt, ...) \
482 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
Joe Perchesfc62f2f2010-05-24 14:33:08 -0700483#define pr_warn_ratelimited pr_warning_ratelimited
Joe Perches8a64f332009-12-14 18:00:25 -0800484#define pr_notice_ratelimited(fmt, ...) \
485 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
486#define pr_info_ratelimited(fmt, ...) \
487 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
488/* no pr_cont_ratelimited, don't do that... */
489/* If you are writing a driver, please use dev_dbg instead */
490#if defined(DEBUG)
491#define pr_debug_ratelimited(fmt, ...) \
492 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
493#else
494#define pr_debug_ratelimited(fmt, ...) \
495 ({ if (0) printk_ratelimited(KERN_DEBUG pr_fmt(fmt), \
496 ##__VA_ARGS__); 0; })
497#endif
498
499/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100500 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500501 * tracing_on/tracing_off and tracing_start()/tracing_stop
502 *
503 * Use tracing_on/tracing_off when you want to quickly turn on or off
504 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900505 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500506 * file, which gives a means for the kernel and userspace to interact.
507 * Place a tracing_off() in the kernel where you want tracing to end.
508 * From user space, examine the trace, and then echo 1 > tracing_on
509 * to continue tracing.
510 *
511 * tracing_stop/tracing_start has slightly more overhead. It is used
512 * by things like suspend to ram where disabling the recording of the
513 * trace is not enough, but tracing must actually stop because things
514 * like calling smp_processor_id() may crash the system.
515 *
516 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100517 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500518#ifdef CONFIG_RING_BUFFER
519void tracing_on(void);
520void tracing_off(void);
521/* trace_off_permanent stops recording with no way to bring it back */
522void tracing_off_permanent(void);
523int tracing_is_on(void);
524#else
525static inline void tracing_on(void) { }
526static inline void tracing_off(void) { }
527static inline void tracing_off_permanent(void) { }
528static inline int tracing_is_on(void) { return 0; }
529#endif
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200530
531enum ftrace_dump_mode {
532 DUMP_NONE,
533 DUMP_ALL,
534 DUMP_ORIG,
535};
536
Ingo Molnar526211b2009-03-05 10:28:45 +0100537#ifdef CONFIG_TRACING
538extern void tracing_start(void);
539extern void tracing_stop(void);
540extern void ftrace_off_permanent(void);
541
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100542static inline void __attribute__ ((format (printf, 1, 2)))
543____trace_printk_check_format(const char *fmt, ...)
544{
545}
546#define __trace_printk_check_format(fmt, args...) \
547do { \
548 if (0) \
549 ____trace_printk_check_format(fmt, ##args); \
550} while (0)
551
Ingo Molnar526211b2009-03-05 10:28:45 +0100552/**
553 * trace_printk - printf formatting in the ftrace buffer
554 * @fmt: the printf format for printing
555 *
556 * Note: __trace_printk is an internal function for trace_printk and
557 * the @ip is passed in via the trace_printk macro.
558 *
559 * This function allows a kernel developer to debug fast path sections
560 * that printk is not appropriate for. By scattering in various
561 * printk like tracing in the code, a developer can quickly see
562 * where problems are occurring.
563 *
564 * This is intended as a debugging tool for the developer only.
565 * Please refrain from leaving trace_printks scattered around in
566 * your code.
567 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100568
569#define trace_printk(fmt, args...) \
570do { \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100571 __trace_printk_check_format(fmt, ##args); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100572 if (__builtin_constant_p(fmt)) { \
573 static const char *trace_printk_fmt \
574 __attribute__((section("__trace_printk_fmt"))) = \
575 __builtin_constant_p(fmt) ? fmt : NULL; \
576 \
577 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
578 } else \
579 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100580} while (0)
581
Ingo Molnar526211b2009-03-05 10:28:45 +0100582extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100583__trace_bprintk(unsigned long ip, const char *fmt, ...)
584 __attribute__ ((format (printf, 2, 3)));
585
586extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100587__trace_printk(unsigned long ip, const char *fmt, ...)
588 __attribute__ ((format (printf, 2, 3)));
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100589
Steven Rostedt03889382009-12-11 09:48:22 -0500590extern void trace_dump_stack(void);
591
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100592/*
593 * The double __builtin_constant_p is because gcc will give us an error
594 * if we try to allocate the static variable to fmt if it is not a
595 * constant. Even with the outer if statement.
596 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100597#define ftrace_vprintk(fmt, vargs) \
598do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100599 if (__builtin_constant_p(fmt)) { \
600 static const char *trace_printk_fmt \
601 __attribute__((section("__trace_printk_fmt"))) = \
602 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100603 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100604 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
605 } else \
606 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100607} while (0)
608
Ingo Molnar526211b2009-03-05 10:28:45 +0100609extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100610__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
611
612extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100613__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100614
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200615extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
Ingo Molnar526211b2009-03-05 10:28:45 +0100616#else
Ingo Molnar526211b2009-03-05 10:28:45 +0100617static inline int
618trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
619
620static inline void tracing_start(void) { }
621static inline void tracing_stop(void) { }
622static inline void ftrace_off_permanent(void) { }
Steven Rostedte36c5452009-12-14 15:58:33 -0500623static inline void trace_dump_stack(void) { }
Ingo Molnar526211b2009-03-05 10:28:45 +0100624static inline int
625trace_printk(const char *fmt, ...)
626{
627 return 0;
628}
629static inline int
630ftrace_vprintk(const char *fmt, va_list ap)
631{
632 return 0;
633}
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200634static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100635#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100636
637/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700638 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 * strict type-checking.. See the
640 * "unnecessary" pointer comparison.
641 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700642#define min(x, y) ({ \
643 typeof(x) _min1 = (x); \
644 typeof(y) _min2 = (y); \
645 (void) (&_min1 == &_min2); \
646 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700648#define max(x, y) ({ \
649 typeof(x) _max1 = (x); \
650 typeof(y) _max2 = (y); \
651 (void) (&_max1 == &_max2); \
652 _max1 > _max2 ? _max1 : _max2; })
653
654/**
655 * clamp - return a value clamped to a given range with strict typechecking
656 * @val: current value
657 * @min: minimum allowable value
658 * @max: maximum allowable value
659 *
660 * This macro does strict typechecking of min/max to make sure they are of the
661 * same type as val. See the unnecessary pointer comparisons.
662 */
663#define clamp(val, min, max) ({ \
664 typeof(val) __val = (val); \
665 typeof(min) __min = (min); \
666 typeof(max) __max = (max); \
667 (void) (&__val == &__min); \
668 (void) (&__val == &__max); \
669 __val = __val < __min ? __min: __val; \
670 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
672/*
673 * ..and if you can't take the strict
674 * types, you can specify one yourself.
675 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700676 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700678#define min_t(type, x, y) ({ \
679 type __min1 = (x); \
680 type __min2 = (y); \
681 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700683#define max_t(type, x, y) ({ \
684 type __max1 = (x); \
685 type __max2 = (y); \
686 __max1 > __max2 ? __max1: __max2; })
687
688/**
689 * clamp_t - return a value clamped to a given range using a given type
690 * @type: the type of variable to use
691 * @val: current value
692 * @min: minimum allowable value
693 * @max: maximum allowable value
694 *
695 * This macro does no typechecking and uses temporary variables of type
696 * 'type' to make all the comparisons.
697 */
698#define clamp_t(type, val, min, max) ({ \
699 type __val = (val); \
700 type __min = (min); \
701 type __max = (max); \
702 __val = __val < __min ? __min: __val; \
703 __val > __max ? __max: __val; })
704
705/**
706 * clamp_val - return a value clamped to a given range using val's type
707 * @val: current value
708 * @min: minimum allowable value
709 * @max: maximum allowable value
710 *
711 * This macro does no typechecking and uses temporary variables of whatever
712 * type the input argument 'val' is. This is useful when val is an unsigned
713 * type and min and max are literals that will otherwise be assigned a signed
714 * integer type.
715 */
716#define clamp_val(val, min, max) ({ \
717 typeof(val) __val = (val); \
718 typeof(val) __min = (min); \
719 typeof(val) __max = (max); \
720 __val = __val < __min ? __min: __val; \
721 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Wu Fengguang91f68b72009-01-07 18:09:12 -0800723
724/*
725 * swap - swap value of @a and @b
726 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800727#define swap(a, b) \
728 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730/**
731 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 * @ptr: the pointer to the member.
733 * @type: the type of the container struct this is embedded in.
734 * @member: the name of the member within the struct.
735 *
736 */
737#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700738 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
739 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740
Kyle McMartind4d23ad2007-02-10 01:46:00 -0800741struct sysinfo;
742extern int do_sysinfo(struct sysinfo *info);
743
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744#endif /* __KERNEL__ */
745
746#define SI_LOAD_SHIFT 16
747struct sysinfo {
748 long uptime; /* Seconds since boot */
749 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
750 unsigned long totalram; /* Total usable main memory size */
751 unsigned long freeram; /* Available memory size */
752 unsigned long sharedram; /* Amount of shared memory */
753 unsigned long bufferram; /* Memory used by buffers */
754 unsigned long totalswap; /* Total swap space size */
755 unsigned long freeswap; /* swap space still available */
756 unsigned short procs; /* Number of current processes */
757 unsigned short pad; /* explicit padding for m68k */
758 unsigned long totalhigh; /* Total high memory size */
759 unsigned long freehigh; /* Available high memory size */
760 unsigned int mem_unit; /* Memory unit size in bytes */
761 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
762};
763
Nikita Danilovc0398ee2005-10-30 15:03:10 -0800764/* Force a compilation error if condition is true */
Jan Beulich8c87df42009-09-22 16:43:52 -0700765#define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))
766
767/* Force a compilation error if condition is constant and true */
768#define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Roland Dreiercc8ef6e2010-01-15 17:01:22 -0800770/* Force a compilation error if a constant expression is not a power of 2 */
771#define BUILD_BUG_ON_NOT_POWER_OF_2(n) \
772 BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
773
Jan Beulich4552d5d2006-06-26 13:57:28 +0200774/* Force a compilation error if condition is true, but also produce a
775 result (of value 0 and type size_t), so the expression can be used
776 e.g. in a structure initializer (or where-ever else comma expressions
777 aren't permitted). */
Jan Beulich8c87df42009-09-22 16:43:52 -0700778#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
779#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
Jan Beulich4552d5d2006-06-26 13:57:28 +0200780
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781/* Trap pasters of __FUNCTION__ at compile-time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782#define __FUNCTION__ (__func__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
Christoph Lameter08e0f6a2006-09-27 01:50:06 -0700784/* This helps us to avoid #ifdef CONFIG_NUMA */
785#ifdef CONFIG_NUMA
786#define NUMA_BUILD 1
787#else
788#define NUMA_BUILD 0
789#endif
790
Steven Rostedt29e71ab2008-08-14 15:45:10 -0400791/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
792#ifdef CONFIG_FTRACE_MCOUNT_RECORD
793# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
794#endif
795
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796#endif