blob: 2b5b1e0899a81e93a4970e8f01924958423c968c [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>
Dave Young717115e2008-07-25 01:45:58 -070018#include <linux/ratelimit.h>
Jason Barone9d376f2009-02-05 11:51:38 -050019#include <linux/dynamic_debug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <asm/byteorder.h>
21#include <asm/bug.h>
22
Roman Zippel3eb3c742007-01-10 14:45:28 +010023extern const char linux_banner[];
24extern const char linux_proc_banner[];
25
Zhang, Yanmin44f564a2008-04-29 01:00:55 -070026#define USHORT_MAX ((u16)(~0U))
27#define SHORT_MAX ((s16)(USHORT_MAX>>1))
28#define SHORT_MIN (-SHORT_MAX - 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#define INT_MAX ((int)(~0U>>1))
30#define INT_MIN (-INT_MAX - 1)
31#define UINT_MAX (~0U)
32#define LONG_MAX ((long)(~0UL>>1))
33#define LONG_MIN (-LONG_MAX - 1)
34#define ULONG_MAX (~0UL)
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -070035#define LLONG_MAX ((long long)(~0ULL>>1))
36#define LLONG_MIN (-LLONG_MAX - 1)
37#define ULLONG_MAX (~0ULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39#define STACK_MAGIC 0xdeadbeef
40
Linus Torvalds2ea58142006-11-26 19:05:22 -080041#define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
42#define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
Matthew Wilcoxa83308e2007-09-11 15:23:47 -070043#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
Herbert Xuf10db622008-02-06 01:37:05 -080044#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
Linus Torvalds2ea58142006-11-26 19:05:22 -080045
Rusty Russellc5e631cf2007-05-06 14:51:05 -070046#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
47
Jan Beulich4552d5d2006-06-26 13:57:28 +020048#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
Steven Whitehouse930631e2006-09-25 23:32:40 -070049#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
David Howellsb4cac1a2006-07-10 04:44:54 -070050#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
Darrick J. Wong9fe06082009-01-06 14:40:51 -080051#define DIV_ROUND_CLOSEST(x, divisor)( \
52{ \
53 typeof(divisor) __divisor = divisor; \
54 (((x) + ((__divisor) / 2)) / (__divisor)); \
55} \
56)
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Eduard - Gabriel Munteanuca31e142008-07-05 12:14:23 +030058#define _RET_IP_ (unsigned long)__builtin_return_address(0)
59#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
60
Bartlomiej Zolnierkiewicz90c699a2009-06-19 08:08:50 +020061#ifdef CONFIG_LBDAF
Jens Axboe2da96ac2007-10-12 12:40:38 +020062# include <asm/div64.h>
63# define sector_div(a, b) do_div(a, b)
64#else
65# define sector_div(n, b)( \
66{ \
67 int _res; \
68 _res = (n) % (b); \
69 (n) /= (b); \
70 _res; \
71} \
72)
73#endif
74
Andrew Morton218e1802007-05-10 03:15:18 -070075/**
76 * upper_32_bits - return bits 32-63 of a number
77 * @n: the number we're accessing
78 *
79 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
80 * the "right shift count >= width of type" warning when that quantity is
81 * 32-bits.
82 */
83#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
84
Joerg Roedel204b8852008-07-29 22:33:42 -070085/**
86 * lower_32_bits - return bits 0-31 of a number
87 * @n: the number we're accessing
88 */
89#define lower_32_bits(n) ((u32)(n))
90
Linus Torvalds1da177e2005-04-16 15:20:36 -070091#define KERN_EMERG "<0>" /* system is unusable */
92#define KERN_ALERT "<1>" /* action must be taken immediately */
93#define KERN_CRIT "<2>" /* critical conditions */
94#define KERN_ERR "<3>" /* error conditions */
95#define KERN_WARNING "<4>" /* warning conditions */
96#define KERN_NOTICE "<5>" /* normal but significant condition */
97#define KERN_INFO "<6>" /* informational */
98#define KERN_DEBUG "<7>" /* debug-level messages */
99
Linus Torvaldse28d7132009-06-16 11:02:28 -0700100/* Use the default kernel loglevel */
101#define KERN_DEFAULT "<d>"
Ingo Molnar47492522007-10-16 23:30:29 -0700102/*
103 * Annotation for a "continued" line of log printout (only done after a
104 * line that had no enclosing \n). Only to be used by core/arch code
105 * during early bootup (a continued line is not SMP-safe otherwise).
106 */
Linus Torvalds5fd29d62009-06-16 10:57:02 -0700107#define KERN_CONT "<c>"
Ingo Molnar47492522007-10-16 23:30:29 -0700108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109extern int console_printk[];
110
111#define console_loglevel (console_printk[0])
112#define default_message_loglevel (console_printk[1])
113#define minimum_console_loglevel (console_printk[2])
114#define default_console_loglevel (console_printk[3])
115
116struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800117struct pt_regs;
118struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700120#ifdef CONFIG_PREEMPT_VOLUNTARY
121extern int _cond_resched(void);
122# define might_resched() _cond_resched()
123#else
124# define might_resched() do { } while (0)
125#endif
126
Randy Dunlap7106a272008-10-29 14:01:15 -0700127#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200128 void __might_sleep(char *file, int line, int preempt_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129/**
130 * might_sleep - annotation for functions that can sleep
131 *
132 * this macro will print a stack trace if it is executed in an atomic
133 * context (spinlock, irq-handler, ...).
134 *
135 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100136 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 * supposed to.
138 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700139# define might_sleep() \
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200140 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700141#else
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200142 static inline void __might_sleep(char *file, int line, int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700143# define might_sleep() do { might_resched(); } while (0)
144#endif
145
Hua Zhong368a5fa2006-06-23 02:05:42 -0700146#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148#define abs(x) ({ \
149 int __x = (x); \
150 (__x < 0) ? -__x : __x; \
151 })
152
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200153#ifdef CONFIG_PROVE_LOCKING
154void might_fault(void);
155#else
156static inline void might_fault(void)
157{
158 might_sleep();
159}
160#endif
161
Alan Sterne041c682006-03-27 01:16:30 -0800162extern struct atomic_notifier_head panic_notifier_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163extern long (*panic_blink)(long time);
164NORET_TYPE void panic(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200165 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800166extern void oops_enter(void);
167extern void oops_exit(void);
168extern int oops_may_print(void);
Harvey Harrisonec701582008-02-08 04:19:55 -0800169NORET_TYPE void do_exit(long error_code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 ATTRIB_NORET;
171NORET_TYPE void complete_and_exit(struct completion *, long)
172 ATTRIB_NORET;
173extern unsigned long simple_strtoul(const char *,char **,unsigned int);
174extern long simple_strtol(const char *,char **,unsigned int);
175extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
176extern long long simple_strtoll(const char *,char **,unsigned int);
Yi Yang06b2a762008-02-08 04:21:57 -0800177extern int strict_strtoul(const char *, unsigned int, unsigned long *);
178extern int strict_strtol(const char *, unsigned int, long *);
179extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
180extern int strict_strtoll(const char *, unsigned int, long long *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181extern int sprintf(char * buf, const char * fmt, ...)
182 __attribute__ ((format (printf, 2, 3)));
183extern int vsprintf(char *buf, const char *, va_list)
184 __attribute__ ((format (printf, 2, 0)));
185extern int snprintf(char * buf, size_t size, const char * fmt, ...)
186 __attribute__ ((format (printf, 3, 4)));
187extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
188 __attribute__ ((format (printf, 3, 0)));
189extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
190 __attribute__ ((format (printf, 3, 4)));
191extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
192 __attribute__ ((format (printf, 3, 0)));
Jeremy Fitzhardingee9059142006-06-25 05:49:17 -0700193extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
194 __attribute__ ((format (printf, 2, 3)));
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700195extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
197extern int sscanf(const char *, const char *, ...)
198 __attribute__ ((format (scanf, 2, 3)));
199extern int vsscanf(const char *, const char *, va_list)
200 __attribute__ ((format (scanf, 2, 0)));
201
202extern int get_option(char **str, int *pint);
203extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700204extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Trent Piepho5e376612006-05-15 09:44:06 -0700206extern int core_kernel_text(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207extern int __kernel_text_address(unsigned long addr);
208extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700209extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700210
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800211struct pid;
212extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Thomas Renningera0ad05c2008-09-01 14:27:02 +0200214/*
215 * FW_BUG
216 * Add this to a message where you are sure the firmware is buggy or behaves
217 * really stupid or out of spec. Be aware that the responsible BIOS developer
218 * should be able to fix this issue or at least get a concrete idea of the
219 * problem by reading your message without the need of looking at the kernel
220 * code.
221 *
222 * Use it for definite and high priority BIOS bugs.
223 *
224 * FW_WARN
225 * Use it for not that clear (e.g. could the kernel messed up things already?)
226 * and medium priority BIOS bugs.
227 *
228 * FW_INFO
229 * Use this one if you want to tell the user or vendor about something
230 * suspicious, but generally harmless related to the firmware.
231 *
232 * Use it for information or very low priority BIOS bugs.
233 */
234#define FW_BUG "[Firmware Bug]: "
235#define FW_WARN "[Firmware Warn]: "
236#define FW_INFO "[Firmware Info]: "
237
Matt Mackalld59745c2005-05-01 08:59:02 -0700238#ifdef CONFIG_PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239asmlinkage int vprintk(const char *fmt, va_list args)
240 __attribute__ ((format (printf, 1, 0)));
241asmlinkage int printk(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200242 __attribute__ ((format (printf, 1, 2))) __cold;
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800243
Dave Young717115e2008-07-25 01:45:58 -0700244extern struct ratelimit_state printk_ratelimit_state;
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800245extern int printk_ratelimit(void);
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800246extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
247 unsigned int interval_msec);
Ingo Molnarf036be92009-02-05 13:45:43 +0100248
249/*
250 * Print a one-time message (analogous to WARN_ONCE() et al):
251 */
252#define printk_once(x...) ({ \
253 static int __print_once = 1; \
254 \
255 if (__print_once) { \
256 __print_once = 0; \
257 printk(x); \
258 } \
259})
260
Neil Horman04d491a2009-04-02 16:58:57 -0700261void log_buf_kexec_setup(void);
Matt Mackalld59745c2005-05-01 08:59:02 -0700262#else
263static inline int vprintk(const char *s, va_list args)
264 __attribute__ ((format (printf, 1, 0)));
265static inline int vprintk(const char *s, va_list args) { return 0; }
266static inline int printk(const char *s, ...)
267 __attribute__ ((format (printf, 1, 2)));
Andi Kleena586df02007-07-21 17:10:00 +0200268static inline int __cold printk(const char *s, ...) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800269static inline int printk_ratelimit(void) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800270static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
271 unsigned int interval_msec) \
272 { return false; }
Ingo Molnarf036be92009-02-05 13:45:43 +0100273
274/* No effect, but we still get type checking even in the !PRINTK case: */
275#define printk_once(x...) printk(x)
276
Neil Horman04d491a2009-04-02 16:58:57 -0700277static inline void log_buf_kexec_setup(void)
278{
279}
Matt Mackalld59745c2005-05-01 08:59:02 -0700280#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Ingo Molnarced9cd42008-08-11 14:38:12 +0200282extern int printk_needs_cpu(int cpu);
283extern void printk_tick(void);
284
Jiri Slabye17ba732008-05-12 15:44:40 +0200285extern void asmlinkage __attribute__((format(printf, 1, 2)))
Ingo Molnar076f9772008-01-30 13:33:06 +0100286 early_printk(const char *fmt, ...);
287
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288unsigned long int_sqrt(unsigned long);
289
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290static inline void console_silent(void)
291{
292 console_loglevel = 0;
293}
294
295static inline void console_verbose(void)
296{
297 if (console_loglevel)
298 console_loglevel = 15;
299}
300
301extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800302extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700304extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200306extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700307extern int panic_on_io_nmi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700309extern void add_taint(unsigned flag);
310extern int test_taint(unsigned flag);
311extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800312extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
314/* Values used for system_state */
315extern enum system_states {
316 SYSTEM_BOOTING,
317 SYSTEM_RUNNING,
318 SYSTEM_HALT,
319 SYSTEM_POWER_OFF,
320 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500321 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322} system_state;
323
Andi Kleen25ddbb12008-10-15 22:01:41 -0700324#define TAINT_PROPRIETARY_MODULE 0
325#define TAINT_FORCED_MODULE 1
326#define TAINT_UNSAFE_SMP 2
327#define TAINT_FORCED_RMMOD 3
328#define TAINT_MACHINE_CHECK 4
329#define TAINT_BAD_PAGE 5
330#define TAINT_USER 6
331#define TAINT_DIE 7
332#define TAINT_OVERRIDDEN_ACPI_TABLE 8
333#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700334#define TAINT_CRAP 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
Andi Kleena586df02007-07-21 17:10:00 +0200336extern void dump_stack(void) __cold;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700338enum {
339 DUMP_PREFIX_NONE,
340 DUMP_PREFIX_ADDRESS,
341 DUMP_PREFIX_OFFSET
342};
Randy Dunlapc7909232007-06-08 13:47:04 -0700343extern void hex_dump_to_buffer(const void *buf, size_t len,
344 int rowsize, int groupsize,
345 char *linebuf, size_t linebuflen, bool ascii);
346extern void print_hex_dump(const char *level, const char *prefix_str,
347 int prefix_type, int rowsize, int groupsize,
Artem Bityutskiy6a0ed912007-08-07 23:43:14 +0300348 const void *buf, size_t len, bool ascii);
Randy Dunlapc7909232007-06-08 13:47:04 -0700349extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
Alan Sterneb9a9a52007-08-10 13:01:07 -0700350 const void *buf, size_t len);
Harvey Harrison3fc95772008-05-14 16:05:49 -0700351
352extern const char hex_asc[];
353#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
354#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
355
356static inline char *pack_hex_byte(char *buf, u8 byte)
357{
358 *buf++ = hex_asc_hi(byte);
359 *buf++ = hex_asc_lo(byte);
360 return buf;
361}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700362
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100363#ifndef pr_fmt
364#define pr_fmt(fmt) fmt
365#endif
366
367#define pr_emerg(fmt, ...) \
368 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
369#define pr_alert(fmt, ...) \
370 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
371#define pr_crit(fmt, ...) \
372 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
373#define pr_err(fmt, ...) \
374 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
375#define pr_warning(fmt, ...) \
376 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
377#define pr_notice(fmt, ...) \
378 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
379#define pr_info(fmt, ...) \
380 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
Cyrill Gorcunov311d0762009-03-31 15:23:51 -0700381#define pr_cont(fmt, ...) \
382 printk(KERN_CONT fmt, ##__VA_ARGS__)
Emil Medve1f7c8232007-10-16 23:29:48 -0700383
Michael Ellerman4ccb4572009-04-09 14:48:24 -0700384/* pr_devel() should produce zero code unless DEBUG is defined */
385#ifdef DEBUG
386#define pr_devel(fmt, ...) \
387 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
388#else
389#define pr_devel(fmt, ...) \
390 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
391#endif
392
Pavel Machek1cc6daf2006-08-08 01:37:15 +0200393/* If you are writing a driver, please use dev_dbg instead */
Cornelia Huckd0d85ff2008-12-04 16:55:47 +0100394#if defined(DEBUG)
395#define pr_debug(fmt, ...) \
396 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
Jason Barone9d376f2009-02-05 11:51:38 -0500397#elif defined(CONFIG_DYNAMIC_DEBUG)
Greg Bankse6e66b02009-03-11 21:07:28 +1100398/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
Jason Baron346e15b2008-08-12 16:46:19 -0400399#define pr_debug(fmt, ...) do { \
Greg Bankse6e66b02009-03-11 21:07:28 +1100400 dynamic_pr_debug(fmt, ##__VA_ARGS__); \
Jason Baron346e15b2008-08-12 16:46:19 -0400401 } while (0)
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/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100408 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500409 * tracing_on/tracing_off and tracing_start()/tracing_stop
410 *
411 * Use tracing_on/tracing_off when you want to quickly turn on or off
412 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900413 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500414 * file, which gives a means for the kernel and userspace to interact.
415 * Place a tracing_off() in the kernel where you want tracing to end.
416 * From user space, examine the trace, and then echo 1 > tracing_on
417 * to continue tracing.
418 *
419 * tracing_stop/tracing_start has slightly more overhead. It is used
420 * by things like suspend to ram where disabling the recording of the
421 * trace is not enough, but tracing must actually stop because things
422 * like calling smp_processor_id() may crash the system.
423 *
424 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100425 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500426#ifdef CONFIG_RING_BUFFER
427void tracing_on(void);
428void tracing_off(void);
429/* trace_off_permanent stops recording with no way to bring it back */
430void tracing_off_permanent(void);
431int tracing_is_on(void);
432#else
433static inline void tracing_on(void) { }
434static inline void tracing_off(void) { }
435static inline void tracing_off_permanent(void) { }
436static inline int tracing_is_on(void) { return 0; }
437#endif
Ingo Molnar526211b2009-03-05 10:28:45 +0100438#ifdef CONFIG_TRACING
439extern void tracing_start(void);
440extern void tracing_stop(void);
441extern void ftrace_off_permanent(void);
442
443extern void
444ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
445
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100446static inline void __attribute__ ((format (printf, 1, 2)))
447____trace_printk_check_format(const char *fmt, ...)
448{
449}
450#define __trace_printk_check_format(fmt, args...) \
451do { \
452 if (0) \
453 ____trace_printk_check_format(fmt, ##args); \
454} while (0)
455
Ingo Molnar526211b2009-03-05 10:28:45 +0100456/**
457 * trace_printk - printf formatting in the ftrace buffer
458 * @fmt: the printf format for printing
459 *
460 * Note: __trace_printk is an internal function for trace_printk and
461 * the @ip is passed in via the trace_printk macro.
462 *
463 * This function allows a kernel developer to debug fast path sections
464 * that printk is not appropriate for. By scattering in various
465 * printk like tracing in the code, a developer can quickly see
466 * where problems are occurring.
467 *
468 * This is intended as a debugging tool for the developer only.
469 * Please refrain from leaving trace_printks scattered around in
470 * your code.
471 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100472
473#define trace_printk(fmt, args...) \
474do { \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100475 __trace_printk_check_format(fmt, ##args); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100476 if (__builtin_constant_p(fmt)) { \
477 static const char *trace_printk_fmt \
478 __attribute__((section("__trace_printk_fmt"))) = \
479 __builtin_constant_p(fmt) ? fmt : NULL; \
480 \
481 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
482 } else \
483 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100484} while (0)
485
Ingo Molnar526211b2009-03-05 10:28:45 +0100486extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100487__trace_bprintk(unsigned long ip, const char *fmt, ...)
488 __attribute__ ((format (printf, 2, 3)));
489
490extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100491__trace_printk(unsigned long ip, const char *fmt, ...)
492 __attribute__ ((format (printf, 2, 3)));
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100493
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100494/*
495 * The double __builtin_constant_p is because gcc will give us an error
496 * if we try to allocate the static variable to fmt if it is not a
497 * constant. Even with the outer if statement.
498 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100499#define ftrace_vprintk(fmt, vargs) \
500do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100501 if (__builtin_constant_p(fmt)) { \
502 static const char *trace_printk_fmt \
503 __attribute__((section("__trace_printk_fmt"))) = \
504 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100505 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100506 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
507 } else \
508 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100509} while (0)
510
Ingo Molnar526211b2009-03-05 10:28:45 +0100511extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100512__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
513
514extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100515__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100516
Ingo Molnar526211b2009-03-05 10:28:45 +0100517extern void ftrace_dump(void);
518#else
519static inline void
520ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
521static inline int
522trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
523
524static inline void tracing_start(void) { }
525static inline void tracing_stop(void) { }
526static inline void ftrace_off_permanent(void) { }
527static inline int
528trace_printk(const char *fmt, ...)
529{
530 return 0;
531}
532static inline int
533ftrace_vprintk(const char *fmt, va_list ap)
534{
535 return 0;
536}
537static inline void ftrace_dump(void) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100538#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100539
540/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 * Display an IP address in readable format.
542 */
543
544#define NIPQUAD(addr) \
545 ((unsigned char *)&addr)[0], \
546 ((unsigned char *)&addr)[1], \
547 ((unsigned char *)&addr)[2], \
548 ((unsigned char *)&addr)[3]
Joe Perches46b86a22006-01-13 14:29:07 -0800549#define NIPQUAD_FMT "%u.%u.%u.%u"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700552 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 * strict type-checking.. See the
554 * "unnecessary" pointer comparison.
555 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700556#define min(x, y) ({ \
557 typeof(x) _min1 = (x); \
558 typeof(y) _min2 = (y); \
559 (void) (&_min1 == &_min2); \
560 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700562#define max(x, y) ({ \
563 typeof(x) _max1 = (x); \
564 typeof(y) _max2 = (y); \
565 (void) (&_max1 == &_max2); \
566 _max1 > _max2 ? _max1 : _max2; })
567
568/**
569 * clamp - return a value clamped to a given range with strict typechecking
570 * @val: current value
571 * @min: minimum allowable value
572 * @max: maximum allowable value
573 *
574 * This macro does strict typechecking of min/max to make sure they are of the
575 * same type as val. See the unnecessary pointer comparisons.
576 */
577#define clamp(val, min, max) ({ \
578 typeof(val) __val = (val); \
579 typeof(min) __min = (min); \
580 typeof(max) __max = (max); \
581 (void) (&__val == &__min); \
582 (void) (&__val == &__max); \
583 __val = __val < __min ? __min: __val; \
584 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
586/*
587 * ..and if you can't take the strict
588 * types, you can specify one yourself.
589 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700590 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700592#define min_t(type, x, y) ({ \
593 type __min1 = (x); \
594 type __min2 = (y); \
595 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700597#define max_t(type, x, y) ({ \
598 type __max1 = (x); \
599 type __max2 = (y); \
600 __max1 > __max2 ? __max1: __max2; })
601
602/**
603 * clamp_t - return a value clamped to a given range using a given type
604 * @type: the type of variable to use
605 * @val: current value
606 * @min: minimum allowable value
607 * @max: maximum allowable value
608 *
609 * This macro does no typechecking and uses temporary variables of type
610 * 'type' to make all the comparisons.
611 */
612#define clamp_t(type, val, min, max) ({ \
613 type __val = (val); \
614 type __min = (min); \
615 type __max = (max); \
616 __val = __val < __min ? __min: __val; \
617 __val > __max ? __max: __val; })
618
619/**
620 * clamp_val - return a value clamped to a given range using val's type
621 * @val: current value
622 * @min: minimum allowable value
623 * @max: maximum allowable value
624 *
625 * This macro does no typechecking and uses temporary variables of whatever
626 * type the input argument 'val' is. This is useful when val is an unsigned
627 * type and min and max are literals that will otherwise be assigned a signed
628 * integer type.
629 */
630#define clamp_val(val, min, max) ({ \
631 typeof(val) __val = (val); \
632 typeof(val) __min = (min); \
633 typeof(val) __max = (max); \
634 __val = __val < __min ? __min: __val; \
635 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Wu Fengguang91f68b72009-01-07 18:09:12 -0800637
638/*
639 * swap - swap value of @a and @b
640 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800641#define swap(a, b) \
642 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644/**
645 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 * @ptr: the pointer to the member.
647 * @type: the type of the container struct this is embedded in.
648 * @member: the name of the member within the struct.
649 *
650 */
651#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700652 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
653 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Kyle McMartind4d23ad2007-02-10 01:46:00 -0800655struct sysinfo;
656extern int do_sysinfo(struct sysinfo *info);
657
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658#endif /* __KERNEL__ */
659
660#define SI_LOAD_SHIFT 16
661struct sysinfo {
662 long uptime; /* Seconds since boot */
663 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
664 unsigned long totalram; /* Total usable main memory size */
665 unsigned long freeram; /* Available memory size */
666 unsigned long sharedram; /* Amount of shared memory */
667 unsigned long bufferram; /* Memory used by buffers */
668 unsigned long totalswap; /* Total swap space size */
669 unsigned long freeswap; /* swap space still available */
670 unsigned short procs; /* Number of current processes */
671 unsigned short pad; /* explicit padding for m68k */
672 unsigned long totalhigh; /* Total high memory size */
673 unsigned long freehigh; /* Available high memory size */
674 unsigned int mem_unit; /* Memory unit size in bytes */
675 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
676};
677
Nikita Danilovc0398ee2005-10-30 15:03:10 -0800678/* Force a compilation error if condition is true */
Andi Kleen921717a2005-09-13 01:25:13 -0700679#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Jan Beulich4552d5d2006-06-26 13:57:28 +0200681/* Force a compilation error if condition is true, but also produce a
682 result (of value 0 and type size_t), so the expression can be used
683 e.g. in a structure initializer (or where-ever else comma expressions
684 aren't permitted). */
685#define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
686
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687/* Trap pasters of __FUNCTION__ at compile-time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688#define __FUNCTION__ (__func__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689
Christoph Lameter08e0f6a2006-09-27 01:50:06 -0700690/* This helps us to avoid #ifdef CONFIG_NUMA */
691#ifdef CONFIG_NUMA
692#define NUMA_BUILD 1
693#else
694#define NUMA_BUILD 0
695#endif
696
Steven Rostedt29e71ab2008-08-14 15:45:10 -0400697/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
698#ifdef CONFIG_FTRACE_MCOUNT_RECORD
699# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
700#endif
701
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702#endif