blob: 05f332afc9e01f583056112bbea824555358358b [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 Mortone0deaff2008-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 Russellc5e631c2007-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))
David Howellsb4cac1a2006-07-10 04:44:54 -070061#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
Darrick J. Wong9fe06082009-01-06 14:40:51 -080062#define DIV_ROUND_CLOSEST(x, divisor)( \
63{ \
64 typeof(divisor) __divisor = divisor; \
65 (((x) + ((__divisor) / 2)) / (__divisor)); \
66} \
67)
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
Eduard - Gabriel Munteanuca31e142008-07-05 12:14:23 +030069#define _RET_IP_ (unsigned long)__builtin_return_address(0)
70#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
71
Bartlomiej Zolnierkiewicz90c699a2009-06-19 08:08:50 +020072#ifdef CONFIG_LBDAF
Jens Axboe2da96ac2007-10-12 12:40:38 +020073# include <asm/div64.h>
74# define sector_div(a, b) do_div(a, b)
75#else
76# define sector_div(n, b)( \
77{ \
78 int _res; \
79 _res = (n) % (b); \
80 (n) /= (b); \
81 _res; \
82} \
83)
84#endif
85
Andrew Morton218e1802007-05-10 03:15:18 -070086/**
87 * upper_32_bits - return bits 32-63 of a number
88 * @n: the number we're accessing
89 *
90 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
91 * the "right shift count >= width of type" warning when that quantity is
92 * 32-bits.
93 */
94#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
95
Joerg Roedel204b8852008-07-29 22:33:42 -070096/**
97 * lower_32_bits - return bits 0-31 of a number
98 * @n: the number we're accessing
99 */
100#define lower_32_bits(n) ((u32)(n))
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102#define KERN_EMERG "<0>" /* system is unusable */
103#define KERN_ALERT "<1>" /* action must be taken immediately */
104#define KERN_CRIT "<2>" /* critical conditions */
105#define KERN_ERR "<3>" /* error conditions */
106#define KERN_WARNING "<4>" /* warning conditions */
107#define KERN_NOTICE "<5>" /* normal but significant condition */
108#define KERN_INFO "<6>" /* informational */
109#define KERN_DEBUG "<7>" /* debug-level messages */
110
Linus Torvaldse28d7132009-06-16 11:02:28 -0700111/* Use the default kernel loglevel */
112#define KERN_DEFAULT "<d>"
Ingo Molnar47492522007-10-16 23:30:29 -0700113/*
114 * Annotation for a "continued" line of log printout (only done after a
115 * line that had no enclosing \n). Only to be used by core/arch code
116 * during early bootup (a continued line is not SMP-safe otherwise).
117 */
Linus Torvalds5fd29d62009-06-16 10:57:02 -0700118#define KERN_CONT "<c>"
Ingo Molnar47492522007-10-16 23:30:29 -0700119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120extern int console_printk[];
121
122#define console_loglevel (console_printk[0])
123#define default_message_loglevel (console_printk[1])
124#define minimum_console_loglevel (console_printk[2])
125#define default_console_loglevel (console_printk[3])
126
127struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800128struct pt_regs;
129struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700131#ifdef CONFIG_PREEMPT_VOLUNTARY
132extern int _cond_resched(void);
133# define might_resched() _cond_resched()
134#else
135# define might_resched() do { } while (0)
136#endif
137
Randy Dunlap7106a272008-10-29 14:01:15 -0700138#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
Simon Kagstromd8948372009-12-23 11:08:18 +0100139 void __might_sleep(const char *file, int line, int preempt_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140/**
141 * might_sleep - annotation for functions that can sleep
142 *
143 * this macro will print a stack trace if it is executed in an atomic
144 * context (spinlock, irq-handler, ...).
145 *
146 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100147 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 * supposed to.
149 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700150# define might_sleep() \
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200151 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700152#else
Simon Kagstromd8948372009-12-23 11:08:18 +0100153 static inline void __might_sleep(const char *file, int line,
154 int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700155# define might_sleep() do { might_resched(); } while (0)
156#endif
157
Hua Zhong368a5fa2006-06-23 02:05:42 -0700158#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700159
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160#define abs(x) ({ \
Rolf Eike Beera49c59c2009-09-22 16:44:03 -0700161 long __x = (x); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 (__x < 0) ? -__x : __x; \
163 })
164
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200165#ifdef CONFIG_PROVE_LOCKING
166void might_fault(void);
167#else
168static inline void might_fault(void)
169{
170 might_sleep();
171}
172#endif
173
Alan Sterne041c682006-03-27 01:16:30 -0800174extern struct atomic_notifier_head panic_notifier_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175extern long (*panic_blink)(long time);
176NORET_TYPE void panic(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200177 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800178extern void oops_enter(void);
179extern void oops_exit(void);
180extern int oops_may_print(void);
Harvey Harrisonec701582008-02-08 04:19:55 -0800181NORET_TYPE void do_exit(long error_code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 ATTRIB_NORET;
183NORET_TYPE void complete_and_exit(struct completion *, long)
184 ATTRIB_NORET;
185extern unsigned long simple_strtoul(const char *,char **,unsigned int);
186extern long simple_strtol(const char *,char **,unsigned int);
187extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
188extern long long simple_strtoll(const char *,char **,unsigned int);
Yi Yang06b2a762008-02-08 04:21:57 -0800189extern int strict_strtoul(const char *, unsigned int, unsigned long *);
190extern int strict_strtol(const char *, unsigned int, long *);
191extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
192extern int strict_strtoll(const char *, unsigned int, long long *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193extern int sprintf(char * buf, const char * fmt, ...)
194 __attribute__ ((format (printf, 2, 3)));
195extern int vsprintf(char *buf, const char *, va_list)
196 __attribute__ ((format (printf, 2, 0)));
197extern int snprintf(char * buf, size_t size, const char * fmt, ...)
198 __attribute__ ((format (printf, 3, 4)));
199extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
200 __attribute__ ((format (printf, 3, 0)));
201extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
202 __attribute__ ((format (printf, 3, 4)));
203extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
204 __attribute__ ((format (printf, 3, 0)));
Jeremy Fitzhardingee9059142006-06-25 05:49:17 -0700205extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
206 __attribute__ ((format (printf, 2, 3)));
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700207extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
209extern int sscanf(const char *, const char *, ...)
210 __attribute__ ((format (scanf, 2, 3)));
211extern int vsscanf(const char *, const char *, va_list)
212 __attribute__ ((format (scanf, 2, 0)));
213
214extern int get_option(char **str, int *pint);
215extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700216extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Trent Piepho5e376612006-05-15 09:44:06 -0700218extern int core_kernel_text(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219extern int __kernel_text_address(unsigned long addr);
220extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700221extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700222
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800223struct pid;
224extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Thomas Renningera0ad05c2008-09-01 14:27:02 +0200226/*
227 * FW_BUG
228 * Add this to a message where you are sure the firmware is buggy or behaves
229 * really stupid or out of spec. Be aware that the responsible BIOS developer
230 * should be able to fix this issue or at least get a concrete idea of the
231 * problem by reading your message without the need of looking at the kernel
232 * code.
233 *
234 * Use it for definite and high priority BIOS bugs.
235 *
236 * FW_WARN
237 * Use it for not that clear (e.g. could the kernel messed up things already?)
238 * and medium priority BIOS bugs.
239 *
240 * FW_INFO
241 * Use this one if you want to tell the user or vendor about something
242 * suspicious, but generally harmless related to the firmware.
243 *
244 * Use it for information or very low priority BIOS bugs.
245 */
246#define FW_BUG "[Firmware Bug]: "
247#define FW_WARN "[Firmware Warn]: "
248#define FW_INFO "[Firmware Info]: "
249
Matt Mackalld59745c2005-05-01 08:59:02 -0700250#ifdef CONFIG_PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251asmlinkage int vprintk(const char *fmt, va_list args)
252 __attribute__ ((format (printf, 1, 0)));
253asmlinkage int printk(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200254 __attribute__ ((format (printf, 1, 2))) __cold;
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800255
Christian Borntraeger5c828712009-10-23 14:58:11 +0200256extern int __printk_ratelimit(const char *func);
257#define printk_ratelimit() __printk_ratelimit(__func__)
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800258extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
259 unsigned int interval_msec);
Ingo Molnarf036be92009-02-05 13:45:43 +0100260
Dave Youngaf913222009-09-22 16:43:33 -0700261extern int printk_delay_msec;
262
Ingo Molnarf036be92009-02-05 13:45:43 +0100263/*
264 * Print a one-time message (analogous to WARN_ONCE() et al):
265 */
266#define printk_once(x...) ({ \
Joe Perches0b2749a2009-12-14 18:00:19 -0800267 static bool __print_once; \
Ingo Molnarf036be92009-02-05 13:45:43 +0100268 \
Joe Perches0b2749a2009-12-14 18:00:19 -0800269 if (!__print_once) { \
270 __print_once = true; \
Ingo Molnarf036be92009-02-05 13:45:43 +0100271 printk(x); \
272 } \
273})
274
Neil Horman04d491a2009-04-02 16:58:57 -0700275void log_buf_kexec_setup(void);
Matt Mackalld59745c2005-05-01 08:59:02 -0700276#else
277static inline int vprintk(const char *s, va_list args)
278 __attribute__ ((format (printf, 1, 0)));
279static inline int vprintk(const char *s, va_list args) { return 0; }
280static inline int printk(const char *s, ...)
281 __attribute__ ((format (printf, 1, 2)));
Andi Kleena586df02007-07-21 17:10:00 +0200282static inline int __cold printk(const char *s, ...) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800283static inline int printk_ratelimit(void) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800284static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
285 unsigned int interval_msec) \
286 { return false; }
Ingo Molnarf036be92009-02-05 13:45:43 +0100287
288/* No effect, but we still get type checking even in the !PRINTK case: */
289#define printk_once(x...) printk(x)
290
Neil Horman04d491a2009-04-02 16:58:57 -0700291static inline void log_buf_kexec_setup(void)
292{
293}
Matt Mackalld59745c2005-05-01 08:59:02 -0700294#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
Ingo Molnarced9cd42008-08-11 14:38:12 +0200296extern int printk_needs_cpu(int cpu);
297extern void printk_tick(void);
298
Jiri Slabye17ba732008-05-12 15:44:40 +0200299extern void asmlinkage __attribute__((format(printf, 1, 2)))
Ingo Molnar076f9772008-01-30 13:33:06 +0100300 early_printk(const char *fmt, ...);
301
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302unsigned long int_sqrt(unsigned long);
303
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304static inline void console_silent(void)
305{
306 console_loglevel = 0;
307}
308
309static inline void console_verbose(void)
310{
311 if (console_loglevel)
312 console_loglevel = 15;
313}
314
315extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800316extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700318extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200320extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700321extern int panic_on_io_nmi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700323extern void add_taint(unsigned flag);
324extern int test_taint(unsigned flag);
325extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800326extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328/* Values used for system_state */
329extern enum system_states {
330 SYSTEM_BOOTING,
331 SYSTEM_RUNNING,
332 SYSTEM_HALT,
333 SYSTEM_POWER_OFF,
334 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500335 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336} system_state;
337
Andi Kleen25ddbb12008-10-15 22:01:41 -0700338#define TAINT_PROPRIETARY_MODULE 0
339#define TAINT_FORCED_MODULE 1
340#define TAINT_UNSAFE_SMP 2
341#define TAINT_FORCED_RMMOD 3
342#define TAINT_MACHINE_CHECK 4
343#define TAINT_BAD_PAGE 5
344#define TAINT_USER 6
345#define TAINT_DIE 7
346#define TAINT_OVERRIDDEN_ACPI_TABLE 8
347#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700348#define TAINT_CRAP 10
Ben Hutchings92946bc2010-04-03 19:36:42 +0100349#define TAINT_FIRMWARE_WORKAROUND 11
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
Andi Kleena586df02007-07-21 17:10:00 +0200351extern void dump_stack(void) __cold;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700353enum {
354 DUMP_PREFIX_NONE,
355 DUMP_PREFIX_ADDRESS,
356 DUMP_PREFIX_OFFSET
357};
Randy Dunlapc7909232007-06-08 13:47:04 -0700358extern void hex_dump_to_buffer(const void *buf, size_t len,
359 int rowsize, int groupsize,
360 char *linebuf, size_t linebuflen, bool ascii);
361extern void print_hex_dump(const char *level, const char *prefix_str,
362 int prefix_type, int rowsize, int groupsize,
Artem Bityutskiy6a0ed912007-08-07 23:43:14 +0300363 const void *buf, size_t len, bool ascii);
Randy Dunlapc7909232007-06-08 13:47:04 -0700364extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
Alan Sterneb9a9a52007-08-10 13:01:07 -0700365 const void *buf, size_t len);
Harvey Harrison3fc95772008-05-14 16:05:49 -0700366
367extern const char hex_asc[];
368#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
369#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
370
371static inline char *pack_hex_byte(char *buf, u8 byte)
372{
373 *buf++ = hex_asc_hi(byte);
374 *buf++ = hex_asc_lo(byte);
375 return buf;
376}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700377
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100378#ifndef pr_fmt
379#define pr_fmt(fmt) fmt
380#endif
381
382#define pr_emerg(fmt, ...) \
383 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
384#define pr_alert(fmt, ...) \
385 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
386#define pr_crit(fmt, ...) \
387 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
388#define pr_err(fmt, ...) \
389 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
390#define pr_warning(fmt, ...) \
391 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
Joe Perchesfc62f2f2010-05-24 14:33:08 -0700392#define pr_warn pr_warning
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100393#define pr_notice(fmt, ...) \
394 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
395#define pr_info(fmt, ...) \
396 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
Cyrill Gorcunov311d0762009-03-31 15:23:51 -0700397#define pr_cont(fmt, ...) \
398 printk(KERN_CONT fmt, ##__VA_ARGS__)
Emil Medve1f7c8232007-10-16 23:29:48 -0700399
Michael Ellerman4ccb4572009-04-09 14:48:24 -0700400/* pr_devel() should produce zero code unless DEBUG is defined */
401#ifdef DEBUG
402#define pr_devel(fmt, ...) \
403 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
404#else
405#define pr_devel(fmt, ...) \
406 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
407#endif
408
Pavel Machek1cc6daf2006-08-08 01:37:15 +0200409/* If you are writing a driver, please use dev_dbg instead */
Cornelia Huckd0d85ff2008-12-04 16:55:47 +0100410#if defined(DEBUG)
411#define pr_debug(fmt, ...) \
412 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
Jason Barone9d376f2009-02-05 11:51:38 -0500413#elif defined(CONFIG_DYNAMIC_DEBUG)
Greg Bankse6e66b02009-03-11 21:07:28 +1100414/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
Joe Perches00b55862009-12-14 18:00:14 -0800415#define pr_debug(fmt, ...) \
416 dynamic_pr_debug(fmt, ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417#else
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100418#define pr_debug(fmt, ...) \
419 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420#endif
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422/*
Joe Perches8a64f332009-12-14 18:00:25 -0800423 * ratelimited messages with local ratelimit_state,
424 * no local ratelimit_state used in the !PRINTK case
425 */
426#ifdef CONFIG_PRINTK
OGAWA Hirofumid8521fc2010-05-24 14:33:11 -0700427#define printk_ratelimited(fmt, ...) ({ \
428 static DEFINE_RATELIMIT_STATE(_rs, \
429 DEFAULT_RATELIMIT_INTERVAL, \
430 DEFAULT_RATELIMIT_BURST); \
431 \
432 if (__ratelimit(&_rs)) \
433 printk(fmt, ##__VA_ARGS__); \
Joe Perches8a64f332009-12-14 18:00:25 -0800434})
435#else
436/* No effect, but we still get type checking even in the !PRINTK case: */
437#define printk_ratelimited printk
438#endif
439
440#define pr_emerg_ratelimited(fmt, ...) \
441 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
442#define pr_alert_ratelimited(fmt, ...) \
443 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
444#define pr_crit_ratelimited(fmt, ...) \
445 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
446#define pr_err_ratelimited(fmt, ...) \
447 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
448#define pr_warning_ratelimited(fmt, ...) \
449 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
Joe Perchesfc62f2f2010-05-24 14:33:08 -0700450#define pr_warn_ratelimited pr_warning_ratelimited
Joe Perches8a64f332009-12-14 18:00:25 -0800451#define pr_notice_ratelimited(fmt, ...) \
452 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
453#define pr_info_ratelimited(fmt, ...) \
454 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
455/* no pr_cont_ratelimited, don't do that... */
456/* If you are writing a driver, please use dev_dbg instead */
457#if defined(DEBUG)
458#define pr_debug_ratelimited(fmt, ...) \
459 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
460#else
461#define pr_debug_ratelimited(fmt, ...) \
462 ({ if (0) printk_ratelimited(KERN_DEBUG pr_fmt(fmt), \
463 ##__VA_ARGS__); 0; })
464#endif
465
466/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100467 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500468 * tracing_on/tracing_off and tracing_start()/tracing_stop
469 *
470 * Use tracing_on/tracing_off when you want to quickly turn on or off
471 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900472 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500473 * file, which gives a means for the kernel and userspace to interact.
474 * Place a tracing_off() in the kernel where you want tracing to end.
475 * From user space, examine the trace, and then echo 1 > tracing_on
476 * to continue tracing.
477 *
478 * tracing_stop/tracing_start has slightly more overhead. It is used
479 * by things like suspend to ram where disabling the recording of the
480 * trace is not enough, but tracing must actually stop because things
481 * like calling smp_processor_id() may crash the system.
482 *
483 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100484 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500485#ifdef CONFIG_RING_BUFFER
486void tracing_on(void);
487void tracing_off(void);
488/* trace_off_permanent stops recording with no way to bring it back */
489void tracing_off_permanent(void);
490int tracing_is_on(void);
491#else
492static inline void tracing_on(void) { }
493static inline void tracing_off(void) { }
494static inline void tracing_off_permanent(void) { }
495static inline int tracing_is_on(void) { return 0; }
496#endif
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200497
498enum ftrace_dump_mode {
499 DUMP_NONE,
500 DUMP_ALL,
501 DUMP_ORIG,
502};
503
Ingo Molnar526211b2009-03-05 10:28:45 +0100504#ifdef CONFIG_TRACING
505extern void tracing_start(void);
506extern void tracing_stop(void);
507extern void ftrace_off_permanent(void);
508
509extern void
510ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
511
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100512static inline void __attribute__ ((format (printf, 1, 2)))
513____trace_printk_check_format(const char *fmt, ...)
514{
515}
516#define __trace_printk_check_format(fmt, args...) \
517do { \
518 if (0) \
519 ____trace_printk_check_format(fmt, ##args); \
520} while (0)
521
Ingo Molnar526211b2009-03-05 10:28:45 +0100522/**
523 * trace_printk - printf formatting in the ftrace buffer
524 * @fmt: the printf format for printing
525 *
526 * Note: __trace_printk is an internal function for trace_printk and
527 * the @ip is passed in via the trace_printk macro.
528 *
529 * This function allows a kernel developer to debug fast path sections
530 * that printk is not appropriate for. By scattering in various
531 * printk like tracing in the code, a developer can quickly see
532 * where problems are occurring.
533 *
534 * This is intended as a debugging tool for the developer only.
535 * Please refrain from leaving trace_printks scattered around in
536 * your code.
537 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100538
539#define trace_printk(fmt, args...) \
540do { \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100541 __trace_printk_check_format(fmt, ##args); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100542 if (__builtin_constant_p(fmt)) { \
543 static const char *trace_printk_fmt \
544 __attribute__((section("__trace_printk_fmt"))) = \
545 __builtin_constant_p(fmt) ? fmt : NULL; \
546 \
547 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
548 } else \
549 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100550} while (0)
551
Ingo Molnar526211b2009-03-05 10:28:45 +0100552extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100553__trace_bprintk(unsigned long ip, const char *fmt, ...)
554 __attribute__ ((format (printf, 2, 3)));
555
556extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100557__trace_printk(unsigned long ip, const char *fmt, ...)
558 __attribute__ ((format (printf, 2, 3)));
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100559
Steven Rostedt03889382009-12-11 09:48:22 -0500560extern void trace_dump_stack(void);
561
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100562/*
563 * The double __builtin_constant_p is because gcc will give us an error
564 * if we try to allocate the static variable to fmt if it is not a
565 * constant. Even with the outer if statement.
566 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100567#define ftrace_vprintk(fmt, vargs) \
568do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100569 if (__builtin_constant_p(fmt)) { \
570 static const char *trace_printk_fmt \
571 __attribute__((section("__trace_printk_fmt"))) = \
572 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100573 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100574 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
575 } else \
576 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100577} while (0)
578
Ingo Molnar526211b2009-03-05 10:28:45 +0100579extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100580__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
581
582extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100583__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100584
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200585extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
Ingo Molnar526211b2009-03-05 10:28:45 +0100586#else
587static inline void
588ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
589static inline int
590trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
591
592static inline void tracing_start(void) { }
593static inline void tracing_stop(void) { }
594static inline void ftrace_off_permanent(void) { }
Steven Rostedte36c5452009-12-14 15:58:33 -0500595static inline void trace_dump_stack(void) { }
Ingo Molnar526211b2009-03-05 10:28:45 +0100596static inline int
597trace_printk(const char *fmt, ...)
598{
599 return 0;
600}
601static inline int
602ftrace_vprintk(const char *fmt, va_list ap)
603{
604 return 0;
605}
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200606static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100607#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100608
609/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 * Display an IP address in readable format.
611 */
612
613#define NIPQUAD(addr) \
614 ((unsigned char *)&addr)[0], \
615 ((unsigned char *)&addr)[1], \
616 ((unsigned char *)&addr)[2], \
617 ((unsigned char *)&addr)[3]
Joe Perches46b86a22006-01-13 14:29:07 -0800618#define NIPQUAD_FMT "%u.%u.%u.%u"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700621 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 * strict type-checking.. See the
623 * "unnecessary" pointer comparison.
624 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700625#define min(x, y) ({ \
626 typeof(x) _min1 = (x); \
627 typeof(y) _min2 = (y); \
628 (void) (&_min1 == &_min2); \
629 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700631#define max(x, y) ({ \
632 typeof(x) _max1 = (x); \
633 typeof(y) _max2 = (y); \
634 (void) (&_max1 == &_max2); \
635 _max1 > _max2 ? _max1 : _max2; })
636
637/**
638 * clamp - return a value clamped to a given range with strict typechecking
639 * @val: current value
640 * @min: minimum allowable value
641 * @max: maximum allowable value
642 *
643 * This macro does strict typechecking of min/max to make sure they are of the
644 * same type as val. See the unnecessary pointer comparisons.
645 */
646#define clamp(val, min, max) ({ \
647 typeof(val) __val = (val); \
648 typeof(min) __min = (min); \
649 typeof(max) __max = (max); \
650 (void) (&__val == &__min); \
651 (void) (&__val == &__max); \
652 __val = __val < __min ? __min: __val; \
653 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
655/*
656 * ..and if you can't take the strict
657 * types, you can specify one yourself.
658 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700659 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700661#define min_t(type, x, y) ({ \
662 type __min1 = (x); \
663 type __min2 = (y); \
664 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700666#define max_t(type, x, y) ({ \
667 type __max1 = (x); \
668 type __max2 = (y); \
669 __max1 > __max2 ? __max1: __max2; })
670
671/**
672 * clamp_t - return a value clamped to a given range using a given type
673 * @type: the type of variable to use
674 * @val: current value
675 * @min: minimum allowable value
676 * @max: maximum allowable value
677 *
678 * This macro does no typechecking and uses temporary variables of type
679 * 'type' to make all the comparisons.
680 */
681#define clamp_t(type, val, min, max) ({ \
682 type __val = (val); \
683 type __min = (min); \
684 type __max = (max); \
685 __val = __val < __min ? __min: __val; \
686 __val > __max ? __max: __val; })
687
688/**
689 * clamp_val - return a value clamped to a given range using val's type
690 * @val: current value
691 * @min: minimum allowable value
692 * @max: maximum allowable value
693 *
694 * This macro does no typechecking and uses temporary variables of whatever
695 * type the input argument 'val' is. This is useful when val is an unsigned
696 * type and min and max are literals that will otherwise be assigned a signed
697 * integer type.
698 */
699#define clamp_val(val, min, max) ({ \
700 typeof(val) __val = (val); \
701 typeof(val) __min = (min); \
702 typeof(val) __max = (max); \
703 __val = __val < __min ? __min: __val; \
704 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
Wu Fengguang91f68b72009-01-07 18:09:12 -0800706
707/*
708 * swap - swap value of @a and @b
709 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800710#define swap(a, b) \
711 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800712
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713/**
714 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 * @ptr: the pointer to the member.
716 * @type: the type of the container struct this is embedded in.
717 * @member: the name of the member within the struct.
718 *
719 */
720#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700721 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
722 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
Kyle McMartind4d23ad2007-02-10 01:46:00 -0800724struct sysinfo;
725extern int do_sysinfo(struct sysinfo *info);
726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727#endif /* __KERNEL__ */
728
Arnd Bergmannc01226c2009-09-21 16:37:12 +0200729#ifndef __EXPORTED_HEADERS__
730#ifndef __KERNEL__
731#warning Attempt to use kernel headers from user space, see http://kernelnewbies.org/KernelHeaders
732#endif /* __KERNEL__ */
733#endif /* __EXPORTED_HEADERS__ */
734
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735#define SI_LOAD_SHIFT 16
736struct sysinfo {
737 long uptime; /* Seconds since boot */
738 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
739 unsigned long totalram; /* Total usable main memory size */
740 unsigned long freeram; /* Available memory size */
741 unsigned long sharedram; /* Amount of shared memory */
742 unsigned long bufferram; /* Memory used by buffers */
743 unsigned long totalswap; /* Total swap space size */
744 unsigned long freeswap; /* swap space still available */
745 unsigned short procs; /* Number of current processes */
746 unsigned short pad; /* explicit padding for m68k */
747 unsigned long totalhigh; /* Total high memory size */
748 unsigned long freehigh; /* Available high memory size */
749 unsigned int mem_unit; /* Memory unit size in bytes */
750 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
751};
752
Nikita Danilovc0398ee2005-10-30 15:03:10 -0800753/* Force a compilation error if condition is true */
Jan Beulich8c87df42009-09-22 16:43:52 -0700754#define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))
755
756/* Force a compilation error if condition is constant and true */
757#define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
Roland Dreiercc8ef6e2010-01-15 17:01:22 -0800759/* Force a compilation error if a constant expression is not a power of 2 */
760#define BUILD_BUG_ON_NOT_POWER_OF_2(n) \
761 BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
762
Jan Beulich4552d5d2006-06-26 13:57:28 +0200763/* Force a compilation error if condition is true, but also produce a
764 result (of value 0 and type size_t), so the expression can be used
765 e.g. in a structure initializer (or where-ever else comma expressions
766 aren't permitted). */
Jan Beulich8c87df42009-09-22 16:43:52 -0700767#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
768#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
Jan Beulich4552d5d2006-06-26 13:57:28 +0200769
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770/* Trap pasters of __FUNCTION__ at compile-time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771#define __FUNCTION__ (__func__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Christoph Lameter08e0f6a2006-09-27 01:50:06 -0700773/* This helps us to avoid #ifdef CONFIG_NUMA */
774#ifdef CONFIG_NUMA
775#define NUMA_BUILD 1
776#else
777#define NUMA_BUILD 0
778#endif
779
Steven Rostedt29e71ab2008-08-14 15:45:10 -0400780/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
781#ifdef CONFIG_FTRACE_MCOUNT_RECORD
782# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
783#endif
784
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785#endif