blob: d45e372fad81000bfbc0219d3e49aba833b3ef8c [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 Mortone0deaff42008-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 Russellc5e631cf2007-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
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200137 void __might_sleep(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
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200151 static inline void __might_sleep(char *file, int line, int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700152# define might_sleep() do { might_resched(); } while (0)
153#endif
154
Hua Zhong368a5fa2006-06-23 02:05:42 -0700155#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157#define abs(x) ({ \
Rolf Eike Beera49c59c2009-09-22 16:44:03 -0700158 long __x = (x); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 (__x < 0) ? -__x : __x; \
160 })
161
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200162#ifdef CONFIG_PROVE_LOCKING
163void might_fault(void);
164#else
165static inline void might_fault(void)
166{
167 might_sleep();
168}
169#endif
170
Alan Sterne041c682006-03-27 01:16:30 -0800171extern struct atomic_notifier_head panic_notifier_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172extern long (*panic_blink)(long time);
173NORET_TYPE void panic(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200174 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800175extern void oops_enter(void);
176extern void oops_exit(void);
177extern int oops_may_print(void);
Harvey Harrisonec701582008-02-08 04:19:55 -0800178NORET_TYPE void do_exit(long error_code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 ATTRIB_NORET;
180NORET_TYPE void complete_and_exit(struct completion *, long)
181 ATTRIB_NORET;
182extern unsigned long simple_strtoul(const char *,char **,unsigned int);
183extern long simple_strtol(const char *,char **,unsigned int);
184extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
185extern long long simple_strtoll(const char *,char **,unsigned int);
Yi Yang06b2a762008-02-08 04:21:57 -0800186extern int strict_strtoul(const char *, unsigned int, unsigned long *);
187extern int strict_strtol(const char *, unsigned int, long *);
188extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
189extern int strict_strtoll(const char *, unsigned int, long long *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190extern int sprintf(char * buf, const char * fmt, ...)
191 __attribute__ ((format (printf, 2, 3)));
192extern int vsprintf(char *buf, const char *, va_list)
193 __attribute__ ((format (printf, 2, 0)));
194extern int snprintf(char * buf, size_t size, const char * fmt, ...)
195 __attribute__ ((format (printf, 3, 4)));
196extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
197 __attribute__ ((format (printf, 3, 0)));
198extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
199 __attribute__ ((format (printf, 3, 4)));
200extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
201 __attribute__ ((format (printf, 3, 0)));
Jeremy Fitzhardingee9059142006-06-25 05:49:17 -0700202extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
203 __attribute__ ((format (printf, 2, 3)));
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700204extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206extern int sscanf(const char *, const char *, ...)
207 __attribute__ ((format (scanf, 2, 3)));
208extern int vsscanf(const char *, const char *, va_list)
209 __attribute__ ((format (scanf, 2, 0)));
210
211extern int get_option(char **str, int *pint);
212extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700213extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Trent Piepho5e376612006-05-15 09:44:06 -0700215extern int core_kernel_text(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216extern int __kernel_text_address(unsigned long addr);
217extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700218extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700219
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800220struct pid;
221extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Thomas Renningera0ad05c2008-09-01 14:27:02 +0200223/*
224 * FW_BUG
225 * Add this to a message where you are sure the firmware is buggy or behaves
226 * really stupid or out of spec. Be aware that the responsible BIOS developer
227 * should be able to fix this issue or at least get a concrete idea of the
228 * problem by reading your message without the need of looking at the kernel
229 * code.
230 *
231 * Use it for definite and high priority BIOS bugs.
232 *
233 * FW_WARN
234 * Use it for not that clear (e.g. could the kernel messed up things already?)
235 * and medium priority BIOS bugs.
236 *
237 * FW_INFO
238 * Use this one if you want to tell the user or vendor about something
239 * suspicious, but generally harmless related to the firmware.
240 *
241 * Use it for information or very low priority BIOS bugs.
242 */
243#define FW_BUG "[Firmware Bug]: "
244#define FW_WARN "[Firmware Warn]: "
245#define FW_INFO "[Firmware Info]: "
246
Matt Mackalld59745c2005-05-01 08:59:02 -0700247#ifdef CONFIG_PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248asmlinkage int vprintk(const char *fmt, va_list args)
249 __attribute__ ((format (printf, 1, 0)));
250asmlinkage int printk(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200251 __attribute__ ((format (printf, 1, 2))) __cold;
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800252
Christian Borntraeger5c828712009-10-23 14:58:11 +0200253extern int __printk_ratelimit(const char *func);
254#define printk_ratelimit() __printk_ratelimit(__func__)
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800255extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
256 unsigned int interval_msec);
Ingo Molnarf036be92009-02-05 13:45:43 +0100257
Dave Youngaf913222009-09-22 16:43:33 -0700258extern int printk_delay_msec;
259
Ingo Molnarf036be92009-02-05 13:45:43 +0100260/*
261 * Print a one-time message (analogous to WARN_ONCE() et al):
262 */
263#define printk_once(x...) ({ \
Joe Perches0b2749a2009-12-14 18:00:19 -0800264 static bool __print_once; \
Ingo Molnarf036be92009-02-05 13:45:43 +0100265 \
Joe Perches0b2749a2009-12-14 18:00:19 -0800266 if (!__print_once) { \
267 __print_once = true; \
Ingo Molnarf036be92009-02-05 13:45:43 +0100268 printk(x); \
269 } \
270})
271
Neil Horman04d491a2009-04-02 16:58:57 -0700272void log_buf_kexec_setup(void);
Matt Mackalld59745c2005-05-01 08:59:02 -0700273#else
274static inline int vprintk(const char *s, va_list args)
275 __attribute__ ((format (printf, 1, 0)));
276static inline int vprintk(const char *s, va_list args) { return 0; }
277static inline int printk(const char *s, ...)
278 __attribute__ ((format (printf, 1, 2)));
Andi Kleena586df02007-07-21 17:10:00 +0200279static inline int __cold printk(const char *s, ...) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800280static inline int printk_ratelimit(void) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800281static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
282 unsigned int interval_msec) \
283 { return false; }
Ingo Molnarf036be92009-02-05 13:45:43 +0100284
285/* No effect, but we still get type checking even in the !PRINTK case: */
286#define printk_once(x...) printk(x)
287
Neil Horman04d491a2009-04-02 16:58:57 -0700288static inline void log_buf_kexec_setup(void)
289{
290}
Matt Mackalld59745c2005-05-01 08:59:02 -0700291#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Ingo Molnarced9cd42008-08-11 14:38:12 +0200293extern int printk_needs_cpu(int cpu);
294extern void printk_tick(void);
295
Jiri Slabye17ba732008-05-12 15:44:40 +0200296extern void asmlinkage __attribute__((format(printf, 1, 2)))
Ingo Molnar076f9772008-01-30 13:33:06 +0100297 early_printk(const char *fmt, ...);
298
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299unsigned long int_sqrt(unsigned long);
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301static inline void console_silent(void)
302{
303 console_loglevel = 0;
304}
305
306static inline void console_verbose(void)
307{
308 if (console_loglevel)
309 console_loglevel = 15;
310}
311
312extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800313extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700315extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200317extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700318extern int panic_on_io_nmi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700320extern void add_taint(unsigned flag);
321extern int test_taint(unsigned flag);
322extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800323extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
325/* Values used for system_state */
326extern enum system_states {
327 SYSTEM_BOOTING,
328 SYSTEM_RUNNING,
329 SYSTEM_HALT,
330 SYSTEM_POWER_OFF,
331 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500332 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333} system_state;
334
Andi Kleen25ddbb12008-10-15 22:01:41 -0700335#define TAINT_PROPRIETARY_MODULE 0
336#define TAINT_FORCED_MODULE 1
337#define TAINT_UNSAFE_SMP 2
338#define TAINT_FORCED_RMMOD 3
339#define TAINT_MACHINE_CHECK 4
340#define TAINT_BAD_PAGE 5
341#define TAINT_USER 6
342#define TAINT_DIE 7
343#define TAINT_OVERRIDDEN_ACPI_TABLE 8
344#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700345#define TAINT_CRAP 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Andi Kleena586df02007-07-21 17:10:00 +0200347extern void dump_stack(void) __cold;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700349enum {
350 DUMP_PREFIX_NONE,
351 DUMP_PREFIX_ADDRESS,
352 DUMP_PREFIX_OFFSET
353};
Randy Dunlapc7909232007-06-08 13:47:04 -0700354extern void hex_dump_to_buffer(const void *buf, size_t len,
355 int rowsize, int groupsize,
356 char *linebuf, size_t linebuflen, bool ascii);
357extern void print_hex_dump(const char *level, const char *prefix_str,
358 int prefix_type, int rowsize, int groupsize,
Artem Bityutskiy6a0ed912007-08-07 23:43:14 +0300359 const void *buf, size_t len, bool ascii);
Randy Dunlapc7909232007-06-08 13:47:04 -0700360extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
Alan Sterneb9a9a52007-08-10 13:01:07 -0700361 const void *buf, size_t len);
Harvey Harrison3fc95772008-05-14 16:05:49 -0700362
363extern const char hex_asc[];
364#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
365#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
366
367static inline char *pack_hex_byte(char *buf, u8 byte)
368{
369 *buf++ = hex_asc_hi(byte);
370 *buf++ = hex_asc_lo(byte);
371 return buf;
372}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700373
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100374#ifndef pr_fmt
375#define pr_fmt(fmt) fmt
376#endif
377
378#define pr_emerg(fmt, ...) \
379 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
380#define pr_alert(fmt, ...) \
381 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
382#define pr_crit(fmt, ...) \
383 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
384#define pr_err(fmt, ...) \
385 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
386#define pr_warning(fmt, ...) \
387 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
388#define pr_notice(fmt, ...) \
389 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
390#define pr_info(fmt, ...) \
391 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
Cyrill Gorcunov311d0762009-03-31 15:23:51 -0700392#define pr_cont(fmt, ...) \
393 printk(KERN_CONT fmt, ##__VA_ARGS__)
Emil Medve1f7c8232007-10-16 23:29:48 -0700394
Michael Ellerman4ccb4572009-04-09 14:48:24 -0700395/* pr_devel() should produce zero code unless DEBUG is defined */
396#ifdef DEBUG
397#define pr_devel(fmt, ...) \
398 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
399#else
400#define pr_devel(fmt, ...) \
401 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
402#endif
403
Pavel Machek1cc6daf2006-08-08 01:37:15 +0200404/* If you are writing a driver, please use dev_dbg instead */
Cornelia Huckd0d85ff2008-12-04 16:55:47 +0100405#if defined(DEBUG)
406#define pr_debug(fmt, ...) \
407 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
Jason Barone9d376f2009-02-05 11:51:38 -0500408#elif defined(CONFIG_DYNAMIC_DEBUG)
Greg Bankse6e66b02009-03-11 21:07:28 +1100409/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
Joe Perches00b55862009-12-14 18:00:14 -0800410#define pr_debug(fmt, ...) \
411 dynamic_pr_debug(fmt, ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412#else
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100413#define pr_debug(fmt, ...) \
414 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415#endif
416
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417/*
Joe Perches8a64f332009-12-14 18:00:25 -0800418 * ratelimited messages with local ratelimit_state,
419 * no local ratelimit_state used in the !PRINTK case
420 */
421#ifdef CONFIG_PRINTK
422#define printk_ratelimited(fmt, ...) ({ \
423 static struct ratelimit_state _rs = { \
424 .interval = DEFAULT_RATELIMIT_INTERVAL, \
425 .burst = DEFAULT_RATELIMIT_BURST, \
426 }; \
427 \
428 if (!__ratelimit(&_rs)) \
429 printk(fmt, ##__VA_ARGS__); \
430})
431#else
432/* No effect, but we still get type checking even in the !PRINTK case: */
433#define printk_ratelimited printk
434#endif
435
436#define pr_emerg_ratelimited(fmt, ...) \
437 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
438#define pr_alert_ratelimited(fmt, ...) \
439 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
440#define pr_crit_ratelimited(fmt, ...) \
441 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
442#define pr_err_ratelimited(fmt, ...) \
443 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
444#define pr_warning_ratelimited(fmt, ...) \
445 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
446#define pr_notice_ratelimited(fmt, ...) \
447 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
448#define pr_info_ratelimited(fmt, ...) \
449 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
450/* no pr_cont_ratelimited, don't do that... */
451/* If you are writing a driver, please use dev_dbg instead */
452#if defined(DEBUG)
453#define pr_debug_ratelimited(fmt, ...) \
454 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
455#else
456#define pr_debug_ratelimited(fmt, ...) \
457 ({ if (0) printk_ratelimited(KERN_DEBUG pr_fmt(fmt), \
458 ##__VA_ARGS__); 0; })
459#endif
460
461/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100462 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500463 * tracing_on/tracing_off and tracing_start()/tracing_stop
464 *
465 * Use tracing_on/tracing_off when you want to quickly turn on or off
466 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900467 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500468 * file, which gives a means for the kernel and userspace to interact.
469 * Place a tracing_off() in the kernel where you want tracing to end.
470 * From user space, examine the trace, and then echo 1 > tracing_on
471 * to continue tracing.
472 *
473 * tracing_stop/tracing_start has slightly more overhead. It is used
474 * by things like suspend to ram where disabling the recording of the
475 * trace is not enough, but tracing must actually stop because things
476 * like calling smp_processor_id() may crash the system.
477 *
478 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100479 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500480#ifdef CONFIG_RING_BUFFER
481void tracing_on(void);
482void tracing_off(void);
483/* trace_off_permanent stops recording with no way to bring it back */
484void tracing_off_permanent(void);
485int tracing_is_on(void);
486#else
487static inline void tracing_on(void) { }
488static inline void tracing_off(void) { }
489static inline void tracing_off_permanent(void) { }
490static inline int tracing_is_on(void) { return 0; }
491#endif
Ingo Molnar526211b2009-03-05 10:28:45 +0100492#ifdef CONFIG_TRACING
493extern void tracing_start(void);
494extern void tracing_stop(void);
495extern void ftrace_off_permanent(void);
496
497extern void
498ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
499
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100500static inline void __attribute__ ((format (printf, 1, 2)))
501____trace_printk_check_format(const char *fmt, ...)
502{
503}
504#define __trace_printk_check_format(fmt, args...) \
505do { \
506 if (0) \
507 ____trace_printk_check_format(fmt, ##args); \
508} while (0)
509
Ingo Molnar526211b2009-03-05 10:28:45 +0100510/**
511 * trace_printk - printf formatting in the ftrace buffer
512 * @fmt: the printf format for printing
513 *
514 * Note: __trace_printk is an internal function for trace_printk and
515 * the @ip is passed in via the trace_printk macro.
516 *
517 * This function allows a kernel developer to debug fast path sections
518 * that printk is not appropriate for. By scattering in various
519 * printk like tracing in the code, a developer can quickly see
520 * where problems are occurring.
521 *
522 * This is intended as a debugging tool for the developer only.
523 * Please refrain from leaving trace_printks scattered around in
524 * your code.
525 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100526
527#define trace_printk(fmt, args...) \
528do { \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100529 __trace_printk_check_format(fmt, ##args); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100530 if (__builtin_constant_p(fmt)) { \
531 static const char *trace_printk_fmt \
532 __attribute__((section("__trace_printk_fmt"))) = \
533 __builtin_constant_p(fmt) ? fmt : NULL; \
534 \
535 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
536 } else \
537 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100538} while (0)
539
Ingo Molnar526211b2009-03-05 10:28:45 +0100540extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100541__trace_bprintk(unsigned long ip, const char *fmt, ...)
542 __attribute__ ((format (printf, 2, 3)));
543
544extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100545__trace_printk(unsigned long ip, const char *fmt, ...)
546 __attribute__ ((format (printf, 2, 3)));
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100547
Steven Rostedt03889382009-12-11 09:48:22 -0500548extern void trace_dump_stack(void);
549
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100550/*
551 * The double __builtin_constant_p is because gcc will give us an error
552 * if we try to allocate the static variable to fmt if it is not a
553 * constant. Even with the outer if statement.
554 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100555#define ftrace_vprintk(fmt, vargs) \
556do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100557 if (__builtin_constant_p(fmt)) { \
558 static const char *trace_printk_fmt \
559 __attribute__((section("__trace_printk_fmt"))) = \
560 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100561 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100562 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
563 } else \
564 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100565} while (0)
566
Ingo Molnar526211b2009-03-05 10:28:45 +0100567extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100568__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
569
570extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100571__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100572
Ingo Molnar526211b2009-03-05 10:28:45 +0100573extern void ftrace_dump(void);
574#else
575static inline void
576ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
577static inline int
578trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
579
580static inline void tracing_start(void) { }
581static inline void tracing_stop(void) { }
582static inline void ftrace_off_permanent(void) { }
Steven Rostedte36c5452009-12-14 15:58:33 -0500583static inline void trace_dump_stack(void) { }
Ingo Molnar526211b2009-03-05 10:28:45 +0100584static inline int
585trace_printk(const char *fmt, ...)
586{
587 return 0;
588}
589static inline int
590ftrace_vprintk(const char *fmt, va_list ap)
591{
592 return 0;
593}
594static inline void ftrace_dump(void) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100595#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100596
597/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 * Display an IP address in readable format.
599 */
600
601#define NIPQUAD(addr) \
602 ((unsigned char *)&addr)[0], \
603 ((unsigned char *)&addr)[1], \
604 ((unsigned char *)&addr)[2], \
605 ((unsigned char *)&addr)[3]
Joe Perches46b86a22006-01-13 14:29:07 -0800606#define NIPQUAD_FMT "%u.%u.%u.%u"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700609 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 * strict type-checking.. See the
611 * "unnecessary" pointer comparison.
612 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700613#define min(x, y) ({ \
614 typeof(x) _min1 = (x); \
615 typeof(y) _min2 = (y); \
616 (void) (&_min1 == &_min2); \
617 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700619#define max(x, y) ({ \
620 typeof(x) _max1 = (x); \
621 typeof(y) _max2 = (y); \
622 (void) (&_max1 == &_max2); \
623 _max1 > _max2 ? _max1 : _max2; })
624
625/**
626 * clamp - return a value clamped to a given range with strict typechecking
627 * @val: current value
628 * @min: minimum allowable value
629 * @max: maximum allowable value
630 *
631 * This macro does strict typechecking of min/max to make sure they are of the
632 * same type as val. See the unnecessary pointer comparisons.
633 */
634#define clamp(val, min, max) ({ \
635 typeof(val) __val = (val); \
636 typeof(min) __min = (min); \
637 typeof(max) __max = (max); \
638 (void) (&__val == &__min); \
639 (void) (&__val == &__max); \
640 __val = __val < __min ? __min: __val; \
641 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
643/*
644 * ..and if you can't take the strict
645 * types, you can specify one yourself.
646 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700647 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700649#define min_t(type, x, y) ({ \
650 type __min1 = (x); \
651 type __min2 = (y); \
652 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700654#define max_t(type, x, y) ({ \
655 type __max1 = (x); \
656 type __max2 = (y); \
657 __max1 > __max2 ? __max1: __max2; })
658
659/**
660 * clamp_t - return a value clamped to a given range using a given type
661 * @type: the type of variable to use
662 * @val: current value
663 * @min: minimum allowable value
664 * @max: maximum allowable value
665 *
666 * This macro does no typechecking and uses temporary variables of type
667 * 'type' to make all the comparisons.
668 */
669#define clamp_t(type, val, min, max) ({ \
670 type __val = (val); \
671 type __min = (min); \
672 type __max = (max); \
673 __val = __val < __min ? __min: __val; \
674 __val > __max ? __max: __val; })
675
676/**
677 * clamp_val - return a value clamped to a given range using val's type
678 * @val: current value
679 * @min: minimum allowable value
680 * @max: maximum allowable value
681 *
682 * This macro does no typechecking and uses temporary variables of whatever
683 * type the input argument 'val' is. This is useful when val is an unsigned
684 * type and min and max are literals that will otherwise be assigned a signed
685 * integer type.
686 */
687#define clamp_val(val, min, max) ({ \
688 typeof(val) __val = (val); \
689 typeof(val) __min = (min); \
690 typeof(val) __max = (max); \
691 __val = __val < __min ? __min: __val; \
692 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
Wu Fengguang91f68b72009-01-07 18:09:12 -0800694
695/*
696 * swap - swap value of @a and @b
697 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800698#define swap(a, b) \
699 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800700
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701/**
702 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 * @ptr: the pointer to the member.
704 * @type: the type of the container struct this is embedded in.
705 * @member: the name of the member within the struct.
706 *
707 */
708#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700709 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
710 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
Kyle McMartind4d23ad2007-02-10 01:46:00 -0800712struct sysinfo;
713extern int do_sysinfo(struct sysinfo *info);
714
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715#endif /* __KERNEL__ */
716
Arnd Bergmannc01226c2009-09-21 16:37:12 +0200717#ifndef __EXPORTED_HEADERS__
718#ifndef __KERNEL__
719#warning Attempt to use kernel headers from user space, see http://kernelnewbies.org/KernelHeaders
720#endif /* __KERNEL__ */
721#endif /* __EXPORTED_HEADERS__ */
722
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723#define SI_LOAD_SHIFT 16
724struct sysinfo {
725 long uptime; /* Seconds since boot */
726 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
727 unsigned long totalram; /* Total usable main memory size */
728 unsigned long freeram; /* Available memory size */
729 unsigned long sharedram; /* Amount of shared memory */
730 unsigned long bufferram; /* Memory used by buffers */
731 unsigned long totalswap; /* Total swap space size */
732 unsigned long freeswap; /* swap space still available */
733 unsigned short procs; /* Number of current processes */
734 unsigned short pad; /* explicit padding for m68k */
735 unsigned long totalhigh; /* Total high memory size */
736 unsigned long freehigh; /* Available high memory size */
737 unsigned int mem_unit; /* Memory unit size in bytes */
738 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
739};
740
Nikita Danilovc0398ee2005-10-30 15:03:10 -0800741/* Force a compilation error if condition is true */
Jan Beulich8c87df42009-09-22 16:43:52 -0700742#define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))
743
744/* Force a compilation error if condition is constant and true */
745#define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746
Roland Dreiercc8ef6e2010-01-15 17:01:22 -0800747/* Force a compilation error if a constant expression is not a power of 2 */
748#define BUILD_BUG_ON_NOT_POWER_OF_2(n) \
749 BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
750
Jan Beulich4552d5d2006-06-26 13:57:28 +0200751/* Force a compilation error if condition is true, but also produce a
752 result (of value 0 and type size_t), so the expression can be used
753 e.g. in a structure initializer (or where-ever else comma expressions
754 aren't permitted). */
Jan Beulich8c87df42009-09-22 16:43:52 -0700755#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
756#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
Jan Beulich4552d5d2006-06-26 13:57:28 +0200757
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758/* Trap pasters of __FUNCTION__ at compile-time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759#define __FUNCTION__ (__func__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
Christoph Lameter08e0f6a2006-09-27 01:50:06 -0700761/* This helps us to avoid #ifdef CONFIG_NUMA */
762#ifdef CONFIG_NUMA
763#define NUMA_BUILD 1
764#else
765#define NUMA_BUILD 0
766#endif
767
Steven Rostedt29e71ab2008-08-14 15:45:10 -0400768/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
769#ifdef CONFIG_FTRACE_MCOUNT_RECORD
770# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
771#endif
772
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773#endif