blob: d9e75ec7def5b9e3eea71595c32d25d5757ee2a2 [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
Jens Axboe2da96ac2007-10-12 12:40:38 +020061#ifdef CONFIG_LBD
62# 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
Ingo Molnar47492522007-10-16 23:30:29 -0700100/*
101 * Annotation for a "continued" line of log printout (only done after a
102 * line that had no enclosing \n). Only to be used by core/arch code
103 * during early bootup (a continued line is not SMP-safe otherwise).
104 */
105#define KERN_CONT ""
106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107extern int console_printk[];
108
109#define console_loglevel (console_printk[0])
110#define default_message_loglevel (console_printk[1])
111#define minimum_console_loglevel (console_printk[2])
112#define default_console_loglevel (console_printk[3])
113
114struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800115struct pt_regs;
116struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700118#ifdef CONFIG_PREEMPT_VOLUNTARY
119extern int _cond_resched(void);
120# define might_resched() _cond_resched()
121#else
122# define might_resched() do { } while (0)
123#endif
124
Randy Dunlap7106a272008-10-29 14:01:15 -0700125#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
126 void __might_sleep(char *file, int line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127/**
128 * might_sleep - annotation for functions that can sleep
129 *
130 * this macro will print a stack trace if it is executed in an atomic
131 * context (spinlock, irq-handler, ...).
132 *
133 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100134 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 * supposed to.
136 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700137# define might_sleep() \
138 do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
139#else
140# define might_sleep() do { might_resched(); } while (0)
141#endif
142
Hua Zhong368a5fa2006-06-23 02:05:42 -0700143#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145#define abs(x) ({ \
146 int __x = (x); \
147 (__x < 0) ? -__x : __x; \
148 })
149
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200150#ifdef CONFIG_PROVE_LOCKING
151void might_fault(void);
152#else
153static inline void might_fault(void)
154{
155 might_sleep();
156}
157#endif
158
Alan Sterne041c682006-03-27 01:16:30 -0800159extern struct atomic_notifier_head panic_notifier_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160extern long (*panic_blink)(long time);
161NORET_TYPE void panic(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200162 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800163extern void oops_enter(void);
164extern void oops_exit(void);
165extern int oops_may_print(void);
Harvey Harrisonec701582008-02-08 04:19:55 -0800166NORET_TYPE void do_exit(long error_code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 ATTRIB_NORET;
168NORET_TYPE void complete_and_exit(struct completion *, long)
169 ATTRIB_NORET;
170extern unsigned long simple_strtoul(const char *,char **,unsigned int);
171extern long simple_strtol(const char *,char **,unsigned int);
172extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
173extern long long simple_strtoll(const char *,char **,unsigned int);
Yi Yang06b2a762008-02-08 04:21:57 -0800174extern int strict_strtoul(const char *, unsigned int, unsigned long *);
175extern int strict_strtol(const char *, unsigned int, long *);
176extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
177extern int strict_strtoll(const char *, unsigned int, long long *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178extern int sprintf(char * buf, const char * fmt, ...)
179 __attribute__ ((format (printf, 2, 3)));
180extern int vsprintf(char *buf, const char *, va_list)
181 __attribute__ ((format (printf, 2, 0)));
182extern int snprintf(char * buf, size_t size, const char * fmt, ...)
183 __attribute__ ((format (printf, 3, 4)));
184extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
185 __attribute__ ((format (printf, 3, 0)));
186extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
187 __attribute__ ((format (printf, 3, 4)));
188extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
189 __attribute__ ((format (printf, 3, 0)));
Jeremy Fitzhardingee9059142006-06-25 05:49:17 -0700190extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
191 __attribute__ ((format (printf, 2, 3)));
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700192extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194extern int sscanf(const char *, const char *, ...)
195 __attribute__ ((format (scanf, 2, 3)));
196extern int vsscanf(const char *, const char *, va_list)
197 __attribute__ ((format (scanf, 2, 0)));
198
199extern int get_option(char **str, int *pint);
200extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700201extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Trent Piepho5e376612006-05-15 09:44:06 -0700203extern int core_kernel_text(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204extern int __kernel_text_address(unsigned long addr);
205extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700206extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700207
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800208struct pid;
209extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
Thomas Renningera0ad05c2008-09-01 14:27:02 +0200211/*
212 * FW_BUG
213 * Add this to a message where you are sure the firmware is buggy or behaves
214 * really stupid or out of spec. Be aware that the responsible BIOS developer
215 * should be able to fix this issue or at least get a concrete idea of the
216 * problem by reading your message without the need of looking at the kernel
217 * code.
218 *
219 * Use it for definite and high priority BIOS bugs.
220 *
221 * FW_WARN
222 * Use it for not that clear (e.g. could the kernel messed up things already?)
223 * and medium priority BIOS bugs.
224 *
225 * FW_INFO
226 * Use this one if you want to tell the user or vendor about something
227 * suspicious, but generally harmless related to the firmware.
228 *
229 * Use it for information or very low priority BIOS bugs.
230 */
231#define FW_BUG "[Firmware Bug]: "
232#define FW_WARN "[Firmware Warn]: "
233#define FW_INFO "[Firmware Info]: "
234
Matt Mackalld59745c2005-05-01 08:59:02 -0700235#ifdef CONFIG_PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236asmlinkage int vprintk(const char *fmt, va_list args)
237 __attribute__ ((format (printf, 1, 0)));
238asmlinkage int printk(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200239 __attribute__ ((format (printf, 1, 2))) __cold;
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800240
Dave Young717115e2008-07-25 01:45:58 -0700241extern struct ratelimit_state printk_ratelimit_state;
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800242extern int printk_ratelimit(void);
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800243extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
244 unsigned int interval_msec);
Ingo Molnarf036be92009-02-05 13:45:43 +0100245
246/*
247 * Print a one-time message (analogous to WARN_ONCE() et al):
248 */
249#define printk_once(x...) ({ \
250 static int __print_once = 1; \
251 \
252 if (__print_once) { \
253 __print_once = 0; \
254 printk(x); \
255 } \
256})
257
Neil Horman04d491a2009-04-02 16:58:57 -0700258void log_buf_kexec_setup(void);
Matt Mackalld59745c2005-05-01 08:59:02 -0700259#else
260static inline int vprintk(const char *s, va_list args)
261 __attribute__ ((format (printf, 1, 0)));
262static inline int vprintk(const char *s, va_list args) { return 0; }
263static inline int printk(const char *s, ...)
264 __attribute__ ((format (printf, 1, 2)));
Andi Kleena586df02007-07-21 17:10:00 +0200265static inline int __cold printk(const char *s, ...) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800266static inline int printk_ratelimit(void) { return 0; }
Joe Perches7ef3d2f2008-02-08 04:21:25 -0800267static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
268 unsigned int interval_msec) \
269 { return false; }
Ingo Molnarf036be92009-02-05 13:45:43 +0100270
271/* No effect, but we still get type checking even in the !PRINTK case: */
272#define printk_once(x...) printk(x)
273
Neil Horman04d491a2009-04-02 16:58:57 -0700274static inline void log_buf_kexec_setup(void)
275{
276}
Matt Mackalld59745c2005-05-01 08:59:02 -0700277#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
Ingo Molnarced9cd42008-08-11 14:38:12 +0200279extern int printk_needs_cpu(int cpu);
280extern void printk_tick(void);
281
Jiri Slabye17ba732008-05-12 15:44:40 +0200282extern void asmlinkage __attribute__((format(printf, 1, 2)))
Ingo Molnar076f9772008-01-30 13:33:06 +0100283 early_printk(const char *fmt, ...);
284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285unsigned long int_sqrt(unsigned long);
286
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287static inline void console_silent(void)
288{
289 console_loglevel = 0;
290}
291
292static inline void console_verbose(void)
293{
294 if (console_loglevel)
295 console_loglevel = 15;
296}
297
298extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800299extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700301extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200303extern int panic_on_unrecovered_nmi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700305extern void add_taint(unsigned flag);
306extern int test_taint(unsigned flag);
307extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800308extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
310/* Values used for system_state */
311extern enum system_states {
312 SYSTEM_BOOTING,
313 SYSTEM_RUNNING,
314 SYSTEM_HALT,
315 SYSTEM_POWER_OFF,
316 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500317 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318} system_state;
319
Andi Kleen25ddbb12008-10-15 22:01:41 -0700320#define TAINT_PROPRIETARY_MODULE 0
321#define TAINT_FORCED_MODULE 1
322#define TAINT_UNSAFE_SMP 2
323#define TAINT_FORCED_RMMOD 3
324#define TAINT_MACHINE_CHECK 4
325#define TAINT_BAD_PAGE 5
326#define TAINT_USER 6
327#define TAINT_DIE 7
328#define TAINT_OVERRIDDEN_ACPI_TABLE 8
329#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700330#define TAINT_CRAP 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
Andi Kleena586df02007-07-21 17:10:00 +0200332extern void dump_stack(void) __cold;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700334enum {
335 DUMP_PREFIX_NONE,
336 DUMP_PREFIX_ADDRESS,
337 DUMP_PREFIX_OFFSET
338};
Randy Dunlapc7909232007-06-08 13:47:04 -0700339extern void hex_dump_to_buffer(const void *buf, size_t len,
340 int rowsize, int groupsize,
341 char *linebuf, size_t linebuflen, bool ascii);
342extern void print_hex_dump(const char *level, const char *prefix_str,
343 int prefix_type, int rowsize, int groupsize,
Artem Bityutskiy6a0ed912007-08-07 23:43:14 +0300344 const void *buf, size_t len, bool ascii);
Randy Dunlapc7909232007-06-08 13:47:04 -0700345extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
Alan Sterneb9a9a52007-08-10 13:01:07 -0700346 const void *buf, size_t len);
Harvey Harrison3fc95772008-05-14 16:05:49 -0700347
348extern const char hex_asc[];
349#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
350#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
351
352static inline char *pack_hex_byte(char *buf, u8 byte)
353{
354 *buf++ = hex_asc_hi(byte);
355 *buf++ = hex_asc_lo(byte);
356 return buf;
357}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700358
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100359#ifndef pr_fmt
360#define pr_fmt(fmt) fmt
361#endif
362
363#define pr_emerg(fmt, ...) \
364 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
365#define pr_alert(fmt, ...) \
366 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
367#define pr_crit(fmt, ...) \
368 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
369#define pr_err(fmt, ...) \
370 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
371#define pr_warning(fmt, ...) \
372 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
373#define pr_notice(fmt, ...) \
374 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
375#define pr_info(fmt, ...) \
376 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
Cyrill Gorcunov311d0762009-03-31 15:23:51 -0700377#define pr_cont(fmt, ...) \
378 printk(KERN_CONT fmt, ##__VA_ARGS__)
Emil Medve1f7c8232007-10-16 23:29:48 -0700379
Pavel Machek1cc6daf2006-08-08 01:37:15 +0200380/* If you are writing a driver, please use dev_dbg instead */
Cornelia Huckd0d85ff2008-12-04 16:55:47 +0100381#if defined(DEBUG)
382#define pr_debug(fmt, ...) \
383 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
Jason Barone9d376f2009-02-05 11:51:38 -0500384#elif defined(CONFIG_DYNAMIC_DEBUG)
Greg Bankse6e66b02009-03-11 21:07:28 +1100385/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
Jason Baron346e15b2008-08-12 16:46:19 -0400386#define pr_debug(fmt, ...) do { \
Greg Bankse6e66b02009-03-11 21:07:28 +1100387 dynamic_pr_debug(fmt, ##__VA_ARGS__); \
Jason Baron346e15b2008-08-12 16:46:19 -0400388 } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389#else
Martin Schwidefskyd091c2f2008-11-12 21:16:43 +0100390#define pr_debug(fmt, ...) \
391 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392#endif
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100395 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500396 * tracing_on/tracing_off and tracing_start()/tracing_stop
397 *
398 * Use tracing_on/tracing_off when you want to quickly turn on or off
399 * tracing. It simply enables or disables the recording of the trace events.
400 * This also corresponds to the user space debugfs/tracing/tracing_on
401 * file, which gives a means for the kernel and userspace to interact.
402 * Place a tracing_off() in the kernel where you want tracing to end.
403 * From user space, examine the trace, and then echo 1 > tracing_on
404 * to continue tracing.
405 *
406 * tracing_stop/tracing_start has slightly more overhead. It is used
407 * by things like suspend to ram where disabling the recording of the
408 * trace is not enough, but tracing must actually stop because things
409 * like calling smp_processor_id() may crash the system.
410 *
411 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100412 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500413#ifdef CONFIG_RING_BUFFER
414void tracing_on(void);
415void tracing_off(void);
416/* trace_off_permanent stops recording with no way to bring it back */
417void tracing_off_permanent(void);
418int tracing_is_on(void);
419#else
420static inline void tracing_on(void) { }
421static inline void tracing_off(void) { }
422static inline void tracing_off_permanent(void) { }
423static inline int tracing_is_on(void) { return 0; }
424#endif
Ingo Molnar526211b2009-03-05 10:28:45 +0100425#ifdef CONFIG_TRACING
426extern void tracing_start(void);
427extern void tracing_stop(void);
428extern void ftrace_off_permanent(void);
429
430extern void
431ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
432
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100433static inline void __attribute__ ((format (printf, 1, 2)))
434____trace_printk_check_format(const char *fmt, ...)
435{
436}
437#define __trace_printk_check_format(fmt, args...) \
438do { \
439 if (0) \
440 ____trace_printk_check_format(fmt, ##args); \
441} while (0)
442
Ingo Molnar526211b2009-03-05 10:28:45 +0100443/**
444 * trace_printk - printf formatting in the ftrace buffer
445 * @fmt: the printf format for printing
446 *
447 * Note: __trace_printk is an internal function for trace_printk and
448 * the @ip is passed in via the trace_printk macro.
449 *
450 * This function allows a kernel developer to debug fast path sections
451 * that printk is not appropriate for. By scattering in various
452 * printk like tracing in the code, a developer can quickly see
453 * where problems are occurring.
454 *
455 * This is intended as a debugging tool for the developer only.
456 * Please refrain from leaving trace_printks scattered around in
457 * your code.
458 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100459
460#define trace_printk(fmt, args...) \
461do { \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100462 __trace_printk_check_format(fmt, ##args); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100463 if (__builtin_constant_p(fmt)) { \
464 static const char *trace_printk_fmt \
465 __attribute__((section("__trace_printk_fmt"))) = \
466 __builtin_constant_p(fmt) ? fmt : NULL; \
467 \
468 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
469 } else \
470 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100471} while (0)
472
Ingo Molnar526211b2009-03-05 10:28:45 +0100473extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100474__trace_bprintk(unsigned long ip, const char *fmt, ...)
475 __attribute__ ((format (printf, 2, 3)));
476
477extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100478__trace_printk(unsigned long ip, const char *fmt, ...)
479 __attribute__ ((format (printf, 2, 3)));
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100480
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100481/*
482 * The double __builtin_constant_p is because gcc will give us an error
483 * if we try to allocate the static variable to fmt if it is not a
484 * constant. Even with the outer if statement.
485 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100486#define ftrace_vprintk(fmt, vargs) \
487do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100488 if (__builtin_constant_p(fmt)) { \
489 static const char *trace_printk_fmt \
490 __attribute__((section("__trace_printk_fmt"))) = \
491 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100492 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100493 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
494 } else \
495 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100496} while (0)
497
Ingo Molnar526211b2009-03-05 10:28:45 +0100498extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100499__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
500
501extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100502__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100503
Ingo Molnar526211b2009-03-05 10:28:45 +0100504extern void ftrace_dump(void);
505#else
506static inline void
507ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
508static inline int
509trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
510
511static inline void tracing_start(void) { }
512static inline void tracing_stop(void) { }
513static inline void ftrace_off_permanent(void) { }
514static inline int
515trace_printk(const char *fmt, ...)
516{
517 return 0;
518}
519static inline int
520ftrace_vprintk(const char *fmt, va_list ap)
521{
522 return 0;
523}
524static inline void ftrace_dump(void) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100525#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100526
527/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 * Display an IP address in readable format.
529 */
530
531#define NIPQUAD(addr) \
532 ((unsigned char *)&addr)[0], \
533 ((unsigned char *)&addr)[1], \
534 ((unsigned char *)&addr)[2], \
535 ((unsigned char *)&addr)[3]
Joe Perches46b86a22006-01-13 14:29:07 -0800536#define NIPQUAD_FMT "%u.%u.%u.%u"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700539 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 * strict type-checking.. See the
541 * "unnecessary" pointer comparison.
542 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700543#define min(x, y) ({ \
544 typeof(x) _min1 = (x); \
545 typeof(y) _min2 = (y); \
546 (void) (&_min1 == &_min2); \
547 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700549#define max(x, y) ({ \
550 typeof(x) _max1 = (x); \
551 typeof(y) _max2 = (y); \
552 (void) (&_max1 == &_max2); \
553 _max1 > _max2 ? _max1 : _max2; })
554
555/**
556 * clamp - return a value clamped to a given range with strict typechecking
557 * @val: current value
558 * @min: minimum allowable value
559 * @max: maximum allowable value
560 *
561 * This macro does strict typechecking of min/max to make sure they are of the
562 * same type as val. See the unnecessary pointer comparisons.
563 */
564#define clamp(val, min, max) ({ \
565 typeof(val) __val = (val); \
566 typeof(min) __min = (min); \
567 typeof(max) __max = (max); \
568 (void) (&__val == &__min); \
569 (void) (&__val == &__max); \
570 __val = __val < __min ? __min: __val; \
571 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
573/*
574 * ..and if you can't take the strict
575 * types, you can specify one yourself.
576 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700577 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700579#define min_t(type, x, y) ({ \
580 type __min1 = (x); \
581 type __min2 = (y); \
582 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700584#define max_t(type, x, y) ({ \
585 type __max1 = (x); \
586 type __max2 = (y); \
587 __max1 > __max2 ? __max1: __max2; })
588
589/**
590 * clamp_t - return a value clamped to a given range using a given type
591 * @type: the type of variable to use
592 * @val: current value
593 * @min: minimum allowable value
594 * @max: maximum allowable value
595 *
596 * This macro does no typechecking and uses temporary variables of type
597 * 'type' to make all the comparisons.
598 */
599#define clamp_t(type, val, min, max) ({ \
600 type __val = (val); \
601 type __min = (min); \
602 type __max = (max); \
603 __val = __val < __min ? __min: __val; \
604 __val > __max ? __max: __val; })
605
606/**
607 * clamp_val - return a value clamped to a given range using val's type
608 * @val: current value
609 * @min: minimum allowable value
610 * @max: maximum allowable value
611 *
612 * This macro does no typechecking and uses temporary variables of whatever
613 * type the input argument 'val' is. This is useful when val is an unsigned
614 * type and min and max are literals that will otherwise be assigned a signed
615 * integer type.
616 */
617#define clamp_val(val, min, max) ({ \
618 typeof(val) __val = (val); \
619 typeof(val) __min = (min); \
620 typeof(val) __max = (max); \
621 __val = __val < __min ? __min: __val; \
622 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
Wu Fengguang91f68b72009-01-07 18:09:12 -0800624
625/*
626 * swap - swap value of @a and @b
627 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800628#define swap(a, b) \
629 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800630
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631/**
632 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 * @ptr: the pointer to the member.
634 * @type: the type of the container struct this is embedded in.
635 * @member: the name of the member within the struct.
636 *
637 */
638#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700639 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
640 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
Kyle McMartind4d23ad2007-02-10 01:46:00 -0800642struct sysinfo;
643extern int do_sysinfo(struct sysinfo *info);
644
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645#endif /* __KERNEL__ */
646
647#define SI_LOAD_SHIFT 16
648struct sysinfo {
649 long uptime; /* Seconds since boot */
650 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
651 unsigned long totalram; /* Total usable main memory size */
652 unsigned long freeram; /* Available memory size */
653 unsigned long sharedram; /* Amount of shared memory */
654 unsigned long bufferram; /* Memory used by buffers */
655 unsigned long totalswap; /* Total swap space size */
656 unsigned long freeswap; /* swap space still available */
657 unsigned short procs; /* Number of current processes */
658 unsigned short pad; /* explicit padding for m68k */
659 unsigned long totalhigh; /* Total high memory size */
660 unsigned long freehigh; /* Available high memory size */
661 unsigned int mem_unit; /* Memory unit size in bytes */
662 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
663};
664
Nikita Danilovc0398ee2005-10-30 15:03:10 -0800665/* Force a compilation error if condition is true */
Andi Kleen921717a2005-09-13 01:25:13 -0700666#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
Jan Beulich4552d5d2006-06-26 13:57:28 +0200668/* Force a compilation error if condition is true, but also produce a
669 result (of value 0 and type size_t), so the expression can be used
670 e.g. in a structure initializer (or where-ever else comma expressions
671 aren't permitted). */
672#define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
673
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674/* Trap pasters of __FUNCTION__ at compile-time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675#define __FUNCTION__ (__func__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
Christoph Lameter08e0f6a2006-09-27 01:50:06 -0700677/* This helps us to avoid #ifdef CONFIG_NUMA */
678#ifdef CONFIG_NUMA
679#define NUMA_BUILD 1
680#else
681#define NUMA_BUILD 0
682#endif
683
Steven Rostedt29e71ab2008-08-14 15:45:10 -0400684/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
685#ifdef CONFIG_FTRACE_MCOUNT_RECORD
686# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
687#endif
688
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689#endif