blob: 4d9c916d06d91b2686b42ca68b57c89837f65b9c [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
Jan Beulich4552d5d2006-06-26 13:57:28 +020047#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
Steven Whitehouse930631e2006-09-25 23:32:40 -070048#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
David Howellsb4cac1a2006-07-10 04:44:54 -070049#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
Darrick J. Wong9fe06082009-01-06 14:40:51 -080050#define DIV_ROUND_CLOSEST(x, divisor)( \
51{ \
52 typeof(divisor) __divisor = divisor; \
53 (((x) + ((__divisor) / 2)) / (__divisor)); \
54} \
55)
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Eduard - Gabriel Munteanuca31e142008-07-05 12:14:23 +030057#define _RET_IP_ (unsigned long)__builtin_return_address(0)
58#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
59
Bartlomiej Zolnierkiewicz90c699a2009-06-19 08:08:50 +020060#ifdef CONFIG_LBDAF
Jens Axboe2da96ac2007-10-12 12:40:38 +020061# include <asm/div64.h>
62# define sector_div(a, b) do_div(a, b)
63#else
64# define sector_div(n, b)( \
65{ \
66 int _res; \
67 _res = (n) % (b); \
68 (n) /= (b); \
69 _res; \
70} \
71)
72#endif
73
Andrew Morton218e1802007-05-10 03:15:18 -070074/**
75 * upper_32_bits - return bits 32-63 of a number
76 * @n: the number we're accessing
77 *
78 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
79 * the "right shift count >= width of type" warning when that quantity is
80 * 32-bits.
81 */
82#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
83
Joerg Roedel204b8852008-07-29 22:33:42 -070084/**
85 * lower_32_bits - return bits 0-31 of a number
86 * @n: the number we're accessing
87 */
88#define lower_32_bits(n) ((u32)(n))
89
Linus Torvalds1da177e2005-04-16 15:20:36 -070090#define KERN_EMERG "<0>" /* system is unusable */
91#define KERN_ALERT "<1>" /* action must be taken immediately */
92#define KERN_CRIT "<2>" /* critical conditions */
93#define KERN_ERR "<3>" /* error conditions */
94#define KERN_WARNING "<4>" /* warning conditions */
95#define KERN_NOTICE "<5>" /* normal but significant condition */
96#define KERN_INFO "<6>" /* informational */
97#define KERN_DEBUG "<7>" /* debug-level messages */
98
Linus Torvaldse28d7132009-06-16 11:02:28 -070099/* Use the default kernel loglevel */
100#define KERN_DEFAULT "<d>"
Ingo Molnar47492522007-10-16 23:30:29 -0700101/*
102 * Annotation for a "continued" line of log printout (only done after a
103 * line that had no enclosing \n). Only to be used by core/arch code
104 * during early bootup (a continued line is not SMP-safe otherwise).
105 */
Linus Torvalds5fd29d62009-06-16 10:57:02 -0700106#define KERN_CONT "<c>"
Ingo Molnar47492522007-10-16 23:30:29 -0700107
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108extern int console_printk[];
109
110#define console_loglevel (console_printk[0])
111#define default_message_loglevel (console_printk[1])
112#define minimum_console_loglevel (console_printk[2])
113#define default_console_loglevel (console_printk[3])
114
115struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800116struct pt_regs;
117struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700119#ifdef CONFIG_PREEMPT_VOLUNTARY
120extern int _cond_resched(void);
121# define might_resched() _cond_resched()
122#else
123# define might_resched() do { } while (0)
124#endif
125
Randy Dunlap7106a272008-10-29 14:01:15 -0700126#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200127 void __might_sleep(char *file, int line, int preempt_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128/**
129 * might_sleep - annotation for functions that can sleep
130 *
131 * this macro will print a stack trace if it is executed in an atomic
132 * context (spinlock, irq-handler, ...).
133 *
134 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100135 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 * supposed to.
137 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700138# define might_sleep() \
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200139 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700140#else
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200141 static inline void __might_sleep(char *file, int line, int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700142# define might_sleep() do { might_resched(); } while (0)
143#endif
144
Hua Zhong368a5fa2006-06-23 02:05:42 -0700145#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147#define abs(x) ({ \
Rolf Eike Beera49c59c2009-09-22 16:44:03 -0700148 long __x = (x); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 (__x < 0) ? -__x : __x; \
150 })
151
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200152#ifdef CONFIG_PROVE_LOCKING
153void might_fault(void);
154#else
155static inline void might_fault(void)
156{
157 might_sleep();
158}
159#endif
160
Alan Sterne041c682006-03-27 01:16:30 -0800161extern struct atomic_notifier_head panic_notifier_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162extern long (*panic_blink)(long time);
163NORET_TYPE void panic(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200164 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800165extern void oops_enter(void);
166extern void oops_exit(void);
167extern int oops_may_print(void);
Harvey Harrisonec701582008-02-08 04:19:55 -0800168NORET_TYPE void do_exit(long error_code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 ATTRIB_NORET;
170NORET_TYPE void complete_and_exit(struct completion *, long)
171 ATTRIB_NORET;
172extern unsigned long simple_strtoul(const char *,char **,unsigned int);
173extern long simple_strtol(const char *,char **,unsigned int);
174extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
175extern long long simple_strtoll(const char *,char **,unsigned int);
Yi Yang06b2a762008-02-08 04:21:57 -0800176extern int strict_strtoul(const char *, unsigned int, unsigned long *);
177extern int strict_strtol(const char *, unsigned int, long *);
178extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
179extern int strict_strtoll(const char *, unsigned int, long long *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180extern int sprintf(char * buf, const char * fmt, ...)
181 __attribute__ ((format (printf, 2, 3)));
182extern int vsprintf(char *buf, const char *, va_list)
183 __attribute__ ((format (printf, 2, 0)));
184extern int snprintf(char * buf, size_t size, const char * fmt, ...)
185 __attribute__ ((format (printf, 3, 4)));
186extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
187 __attribute__ ((format (printf, 3, 0)));
188extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
189 __attribute__ ((format (printf, 3, 4)));
190extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
191 __attribute__ ((format (printf, 3, 0)));
Jeremy Fitzhardingee9059142006-06-25 05:49:17 -0700192extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
193 __attribute__ ((format (printf, 2, 3)));
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700194extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196extern int sscanf(const char *, const char *, ...)
197 __attribute__ ((format (scanf, 2, 3)));
198extern int vsscanf(const char *, const char *, va_list)
199 __attribute__ ((format (scanf, 2, 0)));
200
201extern int get_option(char **str, int *pint);
202extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700203extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Trent Piepho5e376612006-05-15 09:44:06 -0700205extern int core_kernel_text(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206extern int __kernel_text_address(unsigned long addr);
207extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700208extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700209
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800210struct pid;
211extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Thomas Renningera0ad05c2008-09-01 14:27:02 +0200213/*
214 * FW_BUG
215 * Add this to a message where you are sure the firmware is buggy or behaves
216 * really stupid or out of spec. Be aware that the responsible BIOS developer
217 * should be able to fix this issue or at least get a concrete idea of the
218 * problem by reading your message without the need of looking at the kernel
219 * code.
220 *
221 * Use it for definite and high priority BIOS bugs.
222 *
223 * FW_WARN
224 * Use it for not that clear (e.g. could the kernel messed up things already?)
225 * and medium priority BIOS bugs.
226 *
227 * FW_INFO
228 * Use this one if you want to tell the user or vendor about something
229 * suspicious, but generally harmless related to the firmware.
230 *
231 * Use it for information or very low priority BIOS bugs.
232 */
233#define FW_BUG "[Firmware Bug]: "
234#define FW_WARN "[Firmware Warn]: "
235#define FW_INFO "[Firmware Info]: "
236
Matt Mackalld59745c2005-05-01 08:59:02 -0700237#ifdef CONFIG_PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238asmlinkage int vprintk(const char *fmt, va_list args)
239 __attribute__ ((format (printf, 1, 0)));
240asmlinkage int printk(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200241 __attribute__ ((format (printf, 1, 2))) __cold;
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800242
Christian Borntraeger5c828712009-10-23 14:58:11 +0200243extern int __printk_ratelimit(const char *func);
244#define printk_ratelimit() __printk_ratelimit(__func__)
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800245extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
246 unsigned int interval_msec);
Ingo Molnarf036be92009-02-05 13:45:43 +0100247
Dave Youngaf913222009-09-22 16:43:33 -0700248extern int printk_delay_msec;
249
Ingo Molnarf036be92009-02-05 13:45:43 +0100250/*
251 * Print a one-time message (analogous to WARN_ONCE() et al):
252 */
253#define printk_once(x...) ({ \
Joe Perches0b2749a2009-12-14 18:00:19 -0800254 static bool __print_once; \
Ingo Molnarf036be92009-02-05 13:45:43 +0100255 \
Joe Perches0b2749a2009-12-14 18:00:19 -0800256 if (!__print_once) { \
257 __print_once = true; \
Ingo Molnarf036be92009-02-05 13:45:43 +0100258 printk(x); \
259 } \
260})
261
Neil Horman04d491a2009-04-02 16:58:57 -0700262void log_buf_kexec_setup(void);
Matt Mackalld59745c2005-05-01 08:59:02 -0700263#else
264static inline int vprintk(const char *s, va_list args)
265 __attribute__ ((format (printf, 1, 0)));
266static inline int vprintk(const char *s, va_list args) { return 0; }
267static inline int printk(const char *s, ...)
268 __attribute__ ((format (printf, 1, 2)));
Andi Kleena586df02007-07-21 17:10:00 +0200269static inline int __cold printk(const char *s, ...) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800270static inline int printk_ratelimit(void) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800271static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
272 unsigned int interval_msec) \
273 { return false; }
Ingo Molnarf036be92009-02-05 13:45:43 +0100274
275/* No effect, but we still get type checking even in the !PRINTK case: */
276#define printk_once(x...) printk(x)
277
Neil Horman04d491a2009-04-02 16:58:57 -0700278static inline void log_buf_kexec_setup(void)
279{
280}
Matt Mackalld59745c2005-05-01 08:59:02 -0700281#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
Ingo Molnarced9cd42008-08-11 14:38:12 +0200283extern int printk_needs_cpu(int cpu);
284extern void printk_tick(void);
285
Jiri Slabye17ba732008-05-12 15:44:40 +0200286extern void asmlinkage __attribute__((format(printf, 1, 2)))
Ingo Molnar076f9772008-01-30 13:33:06 +0100287 early_printk(const char *fmt, ...);
288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289unsigned long int_sqrt(unsigned long);
290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291static inline void console_silent(void)
292{
293 console_loglevel = 0;
294}
295
296static inline void console_verbose(void)
297{
298 if (console_loglevel)
299 console_loglevel = 15;
300}
301
302extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800303extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700305extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200307extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700308extern int panic_on_io_nmi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700310extern void add_taint(unsigned flag);
311extern int test_taint(unsigned flag);
312extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800313extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315/* Values used for system_state */
316extern enum system_states {
317 SYSTEM_BOOTING,
318 SYSTEM_RUNNING,
319 SYSTEM_HALT,
320 SYSTEM_POWER_OFF,
321 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500322 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323} system_state;
324
Andi Kleen25ddbb12008-10-15 22:01:41 -0700325#define TAINT_PROPRIETARY_MODULE 0
326#define TAINT_FORCED_MODULE 1
327#define TAINT_UNSAFE_SMP 2
328#define TAINT_FORCED_RMMOD 3
329#define TAINT_MACHINE_CHECK 4
330#define TAINT_BAD_PAGE 5
331#define TAINT_USER 6
332#define TAINT_DIE 7
333#define TAINT_OVERRIDDEN_ACPI_TABLE 8
334#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700335#define TAINT_CRAP 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
Andi Kleena586df02007-07-21 17:10:00 +0200337extern void dump_stack(void) __cold;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700339enum {
340 DUMP_PREFIX_NONE,
341 DUMP_PREFIX_ADDRESS,
342 DUMP_PREFIX_OFFSET
343};
Randy Dunlapc7909232007-06-08 13:47:04 -0700344extern void hex_dump_to_buffer(const void *buf, size_t len,
345 int rowsize, int groupsize,
346 char *linebuf, size_t linebuflen, bool ascii);
347extern void print_hex_dump(const char *level, const char *prefix_str,
348 int prefix_type, int rowsize, int groupsize,
Artem Bityutskiy6a0ed912007-08-07 23:43:14 +0300349 const void *buf, size_t len, bool ascii);
Randy Dunlapc7909232007-06-08 13:47:04 -0700350extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
Alan Sterneb9a9a52007-08-10 13:01:07 -0700351 const void *buf, size_t len);
Harvey Harrison3fc95772008-05-14 16:05:49 -0700352
353extern const char hex_asc[];
354#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
355#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
356
357static inline char *pack_hex_byte(char *buf, u8 byte)
358{
359 *buf++ = hex_asc_hi(byte);
360 *buf++ = hex_asc_lo(byte);
361 return buf;
362}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700363
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100364#ifndef pr_fmt
365#define pr_fmt(fmt) fmt
366#endif
367
368#define pr_emerg(fmt, ...) \
369 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
370#define pr_alert(fmt, ...) \
371 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
372#define pr_crit(fmt, ...) \
373 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
374#define pr_err(fmt, ...) \
375 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
376#define pr_warning(fmt, ...) \
377 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
378#define pr_notice(fmt, ...) \
379 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
380#define pr_info(fmt, ...) \
381 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
Cyrill Gorcunov311d0762009-03-31 15:23:51 -0700382#define pr_cont(fmt, ...) \
383 printk(KERN_CONT fmt, ##__VA_ARGS__)
Emil Medve1f7c8232007-10-16 23:29:48 -0700384
Michael Ellerman4ccb4572009-04-09 14:48:24 -0700385/* pr_devel() should produce zero code unless DEBUG is defined */
386#ifdef DEBUG
387#define pr_devel(fmt, ...) \
388 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
389#else
390#define pr_devel(fmt, ...) \
391 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
392#endif
393
Pavel Machek1cc6daf2006-08-08 01:37:15 +0200394/* If you are writing a driver, please use dev_dbg instead */
Cornelia Huckd0d85ff2008-12-04 16:55:47 +0100395#if defined(DEBUG)
396#define pr_debug(fmt, ...) \
397 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
Jason Barone9d376f2009-02-05 11:51:38 -0500398#elif defined(CONFIG_DYNAMIC_DEBUG)
Greg Bankse6e66b02009-03-11 21:07:28 +1100399/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
Joe Perches00b55862009-12-14 18:00:14 -0800400#define pr_debug(fmt, ...) \
401 dynamic_pr_debug(fmt, ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402#else
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100403#define pr_debug(fmt, ...) \
404 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405#endif
406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407/*
Joe Perches8a64f332009-12-14 18:00:25 -0800408 * ratelimited messages with local ratelimit_state,
409 * no local ratelimit_state used in the !PRINTK case
410 */
411#ifdef CONFIG_PRINTK
412#define printk_ratelimited(fmt, ...) ({ \
413 static struct ratelimit_state _rs = { \
414 .interval = DEFAULT_RATELIMIT_INTERVAL, \
415 .burst = DEFAULT_RATELIMIT_BURST, \
416 }; \
417 \
418 if (!__ratelimit(&_rs)) \
419 printk(fmt, ##__VA_ARGS__); \
420})
421#else
422/* No effect, but we still get type checking even in the !PRINTK case: */
423#define printk_ratelimited printk
424#endif
425
426#define pr_emerg_ratelimited(fmt, ...) \
427 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
428#define pr_alert_ratelimited(fmt, ...) \
429 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
430#define pr_crit_ratelimited(fmt, ...) \
431 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
432#define pr_err_ratelimited(fmt, ...) \
433 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
434#define pr_warning_ratelimited(fmt, ...) \
435 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
436#define pr_notice_ratelimited(fmt, ...) \
437 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
438#define pr_info_ratelimited(fmt, ...) \
439 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
440/* no pr_cont_ratelimited, don't do that... */
441/* If you are writing a driver, please use dev_dbg instead */
442#if defined(DEBUG)
443#define pr_debug_ratelimited(fmt, ...) \
444 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
445#else
446#define pr_debug_ratelimited(fmt, ...) \
447 ({ if (0) printk_ratelimited(KERN_DEBUG pr_fmt(fmt), \
448 ##__VA_ARGS__); 0; })
449#endif
450
451/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100452 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500453 * tracing_on/tracing_off and tracing_start()/tracing_stop
454 *
455 * Use tracing_on/tracing_off when you want to quickly turn on or off
456 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900457 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500458 * file, which gives a means for the kernel and userspace to interact.
459 * Place a tracing_off() in the kernel where you want tracing to end.
460 * From user space, examine the trace, and then echo 1 > tracing_on
461 * to continue tracing.
462 *
463 * tracing_stop/tracing_start has slightly more overhead. It is used
464 * by things like suspend to ram where disabling the recording of the
465 * trace is not enough, but tracing must actually stop because things
466 * like calling smp_processor_id() may crash the system.
467 *
468 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100469 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500470#ifdef CONFIG_RING_BUFFER
471void tracing_on(void);
472void tracing_off(void);
473/* trace_off_permanent stops recording with no way to bring it back */
474void tracing_off_permanent(void);
475int tracing_is_on(void);
476#else
477static inline void tracing_on(void) { }
478static inline void tracing_off(void) { }
479static inline void tracing_off_permanent(void) { }
480static inline int tracing_is_on(void) { return 0; }
481#endif
Ingo Molnar526211b2009-03-05 10:28:45 +0100482#ifdef CONFIG_TRACING
483extern void tracing_start(void);
484extern void tracing_stop(void);
485extern void ftrace_off_permanent(void);
486
487extern void
488ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
489
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100490static inline void __attribute__ ((format (printf, 1, 2)))
491____trace_printk_check_format(const char *fmt, ...)
492{
493}
494#define __trace_printk_check_format(fmt, args...) \
495do { \
496 if (0) \
497 ____trace_printk_check_format(fmt, ##args); \
498} while (0)
499
Ingo Molnar526211b2009-03-05 10:28:45 +0100500/**
501 * trace_printk - printf formatting in the ftrace buffer
502 * @fmt: the printf format for printing
503 *
504 * Note: __trace_printk is an internal function for trace_printk and
505 * the @ip is passed in via the trace_printk macro.
506 *
507 * This function allows a kernel developer to debug fast path sections
508 * that printk is not appropriate for. By scattering in various
509 * printk like tracing in the code, a developer can quickly see
510 * where problems are occurring.
511 *
512 * This is intended as a debugging tool for the developer only.
513 * Please refrain from leaving trace_printks scattered around in
514 * your code.
515 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100516
517#define trace_printk(fmt, args...) \
518do { \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100519 __trace_printk_check_format(fmt, ##args); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100520 if (__builtin_constant_p(fmt)) { \
521 static const char *trace_printk_fmt \
522 __attribute__((section("__trace_printk_fmt"))) = \
523 __builtin_constant_p(fmt) ? fmt : NULL; \
524 \
525 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
526 } else \
527 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100528} while (0)
529
Ingo Molnar526211b2009-03-05 10:28:45 +0100530extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100531__trace_bprintk(unsigned long ip, const char *fmt, ...)
532 __attribute__ ((format (printf, 2, 3)));
533
534extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100535__trace_printk(unsigned long ip, const char *fmt, ...)
536 __attribute__ ((format (printf, 2, 3)));
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100537
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100538/*
539 * The double __builtin_constant_p is because gcc will give us an error
540 * if we try to allocate the static variable to fmt if it is not a
541 * constant. Even with the outer if statement.
542 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100543#define ftrace_vprintk(fmt, vargs) \
544do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100545 if (__builtin_constant_p(fmt)) { \
546 static const char *trace_printk_fmt \
547 __attribute__((section("__trace_printk_fmt"))) = \
548 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100549 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100550 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
551 } else \
552 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100553} while (0)
554
Ingo Molnar526211b2009-03-05 10:28:45 +0100555extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100556__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
557
558extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100559__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100560
Ingo Molnar526211b2009-03-05 10:28:45 +0100561extern void ftrace_dump(void);
562#else
563static inline void
564ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
565static inline int
566trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
567
568static inline void tracing_start(void) { }
569static inline void tracing_stop(void) { }
570static inline void ftrace_off_permanent(void) { }
571static inline int
572trace_printk(const char *fmt, ...)
573{
574 return 0;
575}
576static inline int
577ftrace_vprintk(const char *fmt, va_list ap)
578{
579 return 0;
580}
581static inline void ftrace_dump(void) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100582#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100583
584/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 * Display an IP address in readable format.
586 */
587
588#define NIPQUAD(addr) \
589 ((unsigned char *)&addr)[0], \
590 ((unsigned char *)&addr)[1], \
591 ((unsigned char *)&addr)[2], \
592 ((unsigned char *)&addr)[3]
Joe Perches46b86a22006-01-13 14:29:07 -0800593#define NIPQUAD_FMT "%u.%u.%u.%u"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700596 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 * strict type-checking.. See the
598 * "unnecessary" pointer comparison.
599 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700600#define min(x, y) ({ \
601 typeof(x) _min1 = (x); \
602 typeof(y) _min2 = (y); \
603 (void) (&_min1 == &_min2); \
604 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700606#define max(x, y) ({ \
607 typeof(x) _max1 = (x); \
608 typeof(y) _max2 = (y); \
609 (void) (&_max1 == &_max2); \
610 _max1 > _max2 ? _max1 : _max2; })
611
612/**
613 * clamp - return a value clamped to a given range with strict typechecking
614 * @val: current value
615 * @min: minimum allowable value
616 * @max: maximum allowable value
617 *
618 * This macro does strict typechecking of min/max to make sure they are of the
619 * same type as val. See the unnecessary pointer comparisons.
620 */
621#define clamp(val, min, max) ({ \
622 typeof(val) __val = (val); \
623 typeof(min) __min = (min); \
624 typeof(max) __max = (max); \
625 (void) (&__val == &__min); \
626 (void) (&__val == &__max); \
627 __val = __val < __min ? __min: __val; \
628 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
630/*
631 * ..and if you can't take the strict
632 * types, you can specify one yourself.
633 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700634 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700636#define min_t(type, x, y) ({ \
637 type __min1 = (x); \
638 type __min2 = (y); \
639 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700641#define max_t(type, x, y) ({ \
642 type __max1 = (x); \
643 type __max2 = (y); \
644 __max1 > __max2 ? __max1: __max2; })
645
646/**
647 * clamp_t - return a value clamped to a given range using a given type
648 * @type: the type of variable to use
649 * @val: current value
650 * @min: minimum allowable value
651 * @max: maximum allowable value
652 *
653 * This macro does no typechecking and uses temporary variables of type
654 * 'type' to make all the comparisons.
655 */
656#define clamp_t(type, val, min, max) ({ \
657 type __val = (val); \
658 type __min = (min); \
659 type __max = (max); \
660 __val = __val < __min ? __min: __val; \
661 __val > __max ? __max: __val; })
662
663/**
664 * clamp_val - return a value clamped to a given range using val's type
665 * @val: current value
666 * @min: minimum allowable value
667 * @max: maximum allowable value
668 *
669 * This macro does no typechecking and uses temporary variables of whatever
670 * type the input argument 'val' is. This is useful when val is an unsigned
671 * type and min and max are literals that will otherwise be assigned a signed
672 * integer type.
673 */
674#define clamp_val(val, min, max) ({ \
675 typeof(val) __val = (val); \
676 typeof(val) __min = (min); \
677 typeof(val) __max = (max); \
678 __val = __val < __min ? __min: __val; \
679 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Wu Fengguang91f68b72009-01-07 18:09:12 -0800681
682/*
683 * swap - swap value of @a and @b
684 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800685#define swap(a, b) \
686 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800687
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688/**
689 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 * @ptr: the pointer to the member.
691 * @type: the type of the container struct this is embedded in.
692 * @member: the name of the member within the struct.
693 *
694 */
695#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700696 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
697 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
Kyle McMartind4d23ad2007-02-10 01:46:00 -0800699struct sysinfo;
700extern int do_sysinfo(struct sysinfo *info);
701
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702#endif /* __KERNEL__ */
703
Arnd Bergmannc01226c2009-09-21 16:37:12 +0200704#ifndef __EXPORTED_HEADERS__
705#ifndef __KERNEL__
706#warning Attempt to use kernel headers from user space, see http://kernelnewbies.org/KernelHeaders
707#endif /* __KERNEL__ */
708#endif /* __EXPORTED_HEADERS__ */
709
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710#define SI_LOAD_SHIFT 16
711struct sysinfo {
712 long uptime; /* Seconds since boot */
713 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
714 unsigned long totalram; /* Total usable main memory size */
715 unsigned long freeram; /* Available memory size */
716 unsigned long sharedram; /* Amount of shared memory */
717 unsigned long bufferram; /* Memory used by buffers */
718 unsigned long totalswap; /* Total swap space size */
719 unsigned long freeswap; /* swap space still available */
720 unsigned short procs; /* Number of current processes */
721 unsigned short pad; /* explicit padding for m68k */
722 unsigned long totalhigh; /* Total high memory size */
723 unsigned long freehigh; /* Available high memory size */
724 unsigned int mem_unit; /* Memory unit size in bytes */
725 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
726};
727
Nikita Danilovc0398ee2005-10-30 15:03:10 -0800728/* Force a compilation error if condition is true */
Jan Beulich8c87df42009-09-22 16:43:52 -0700729#define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))
730
731/* Force a compilation error if condition is constant and true */
732#define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
Jan Beulich4552d5d2006-06-26 13:57:28 +0200734/* Force a compilation error if condition is true, but also produce a
735 result (of value 0 and type size_t), so the expression can be used
736 e.g. in a structure initializer (or where-ever else comma expressions
737 aren't permitted). */
Jan Beulich8c87df42009-09-22 16:43:52 -0700738#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
739#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
Jan Beulich4552d5d2006-06-26 13:57:28 +0200740
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741/* Trap pasters of __FUNCTION__ at compile-time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742#define __FUNCTION__ (__func__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
Christoph Lameter08e0f6a2006-09-27 01:50:06 -0700744/* This helps us to avoid #ifdef CONFIG_NUMA */
745#ifdef CONFIG_NUMA
746#define NUMA_BUILD 1
747#else
748#define NUMA_BUILD 0
749#endif
750
Steven Rostedt29e71ab2008-08-14 15:45:10 -0400751/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
752#ifdef CONFIG_FTRACE_MCOUNT_RECORD
753# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
754#endif
755
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756#endif