blob: 953352a88336c0385e2e385f93e41c278513be7b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_KERNEL_H
2#define _LINUX_KERNEL_H
3
4/*
5 * 'kernel.h' contains some often-used function prototypes etc
6 */
Alexey Dobriyana79ff732010-04-13 11:21:46 +02007#define __ALIGN_KERNEL(x, a) __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
8#define __ALIGN_KERNEL_MASK(x, mask) (((x) + (mask)) & ~(mask))
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10#ifdef __KERNEL__
11
12#include <stdarg.h>
13#include <linux/linkage.h>
14#include <linux/stddef.h>
15#include <linux/types.h>
16#include <linux/compiler.h>
17#include <linux/bitops.h>
David Howellsf0d1b0b2006-12-08 02:37:49 -080018#include <linux/log2.h>
Andrew Mortone0deaff42008-07-25 01:45:24 -070019#include <linux/typecheck.h>
Linus Torvalds968ab182010-11-15 13:37:37 -080020#include <linux/printk.h>
Jason Barone9d376f2009-02-05 11:51:38 -050021#include <linux/dynamic_debug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <asm/byteorder.h>
23#include <asm/bug.h>
24
Alexey Dobriyan4be929b2010-05-24 14:33:03 -070025#define USHRT_MAX ((u16)(~0U))
26#define SHRT_MAX ((s16)(USHRT_MAX>>1))
27#define SHRT_MIN ((s16)(-SHRT_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
Alexey Dobriyana79ff732010-04-13 11:21:46 +020040#define ALIGN(x, a) __ALIGN_KERNEL((x), (a))
Alexey Dobriyan9f93ff52010-04-13 14:09:15 +020041#define __ALIGN_MASK(x, mask) __ALIGN_KERNEL_MASK((x), (mask))
Matthew Wilcoxa83308e2007-09-11 15:23:47 -070042#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
Herbert Xuf10db622008-02-06 01:37:05 -080043#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
Linus Torvalds2ea58142006-11-26 19:05:22 -080044
Rusty Russellc5e631cf2007-05-06 14:51:05 -070045#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
46
Yinghai Lu9b3be9f2010-02-10 01:20:29 -080047/*
48 * This looks more complex than it should be. But we need to
49 * get the type for the ~ right in round_down (it needs to be
50 * as wide as the result!), and we want to evaluate the macro
51 * arguments just once each.
52 */
53#define __round_mask(x, y) ((__typeof__(x))((y)-1))
54#define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
55#define round_down(x, y) ((x) & ~__round_mask(x, y))
56
Jan Beulich4552d5d2006-06-26 13:57:28 +020057#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
Steven Whitehouse930631e2006-09-25 23:32:40 -070058#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
James Morris074e61e2010-11-10 09:01:31 +110059
60/* The `const' in roundup() prevents gcc-3.3 from calling __divdi3 */
Eric Parisb28efd52010-10-13 17:50:08 -040061#define roundup(x, y) ( \
62{ \
Tetsuo Handa6070bf32010-11-08 11:20:49 +090063 const typeof(y) __y = y; \
Eric Parisb28efd52010-10-13 17:50:08 -040064 (((x) + (__y - 1)) / __y) * __y; \
65} \
66)
Eric Paris686a0f32010-10-13 17:50:02 -040067#define rounddown(x, y) ( \
68{ \
69 typeof(x) __x = (x); \
70 __x - (__x % (y)); \
71} \
72)
Darrick J. Wong9fe06082009-01-06 14:40:51 -080073#define DIV_ROUND_CLOSEST(x, divisor)( \
74{ \
75 typeof(divisor) __divisor = divisor; \
76 (((x) + ((__divisor) / 2)) / (__divisor)); \
77} \
78)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Eduard - Gabriel Munteanuca31e142008-07-05 12:14:23 +030080#define _RET_IP_ (unsigned long)__builtin_return_address(0)
81#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
82
Bartlomiej Zolnierkiewicz90c699a2009-06-19 08:08:50 +020083#ifdef CONFIG_LBDAF
Jens Axboe2da96ac2007-10-12 12:40:38 +020084# include <asm/div64.h>
85# define sector_div(a, b) do_div(a, b)
86#else
87# define sector_div(n, b)( \
88{ \
89 int _res; \
90 _res = (n) % (b); \
91 (n) /= (b); \
92 _res; \
93} \
94)
95#endif
96
Andrew Morton218e1802007-05-10 03:15:18 -070097/**
98 * upper_32_bits - return bits 32-63 of a number
99 * @n: the number we're accessing
100 *
101 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
102 * the "right shift count >= width of type" warning when that quantity is
103 * 32-bits.
104 */
105#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
106
Joerg Roedel204b8852008-07-29 22:33:42 -0700107/**
108 * lower_32_bits - return bits 0-31 of a number
109 * @n: the number we're accessing
110 */
111#define lower_32_bits(n) ((u32)(n))
112
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800114struct pt_regs;
115struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700117#ifdef CONFIG_PREEMPT_VOLUNTARY
118extern int _cond_resched(void);
119# define might_resched() _cond_resched()
120#else
121# define might_resched() do { } while (0)
122#endif
123
Randy Dunlap7106a272008-10-29 14:01:15 -0700124#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
Simon Kagstromd8948372009-12-23 11:08:18 +0100125 void __might_sleep(const char *file, int line, int preempt_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126/**
127 * might_sleep - annotation for functions that can sleep
128 *
129 * this macro will print a stack trace if it is executed in an atomic
130 * context (spinlock, irq-handler, ...).
131 *
132 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100133 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 * supposed to.
135 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700136# define might_sleep() \
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200137 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700138#else
Simon Kagstromd8948372009-12-23 11:08:18 +0100139 static inline void __might_sleep(const char *file, int line,
140 int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700141# define might_sleep() do { might_resched(); } while (0)
142#endif
143
Hua Zhong368a5fa2006-06-23 02:05:42 -0700144#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700145
Andrew Morton71a90482011-01-12 16:59:35 -0800146/*
147 * abs() handles unsigned and signed longs, ints, shorts and chars. For all
148 * input types abs() returns a signed long.
149 * abs() should not be used for 64-bit types (s64, u64, long long) - use abs64()
150 * for those.
151 */
152#define abs(x) ({ \
153 long ret; \
154 if (sizeof(x) == sizeof(long)) { \
155 long __x = (x); \
156 ret = (__x < 0) ? -__x : __x; \
157 } else { \
158 int __x = (x); \
159 ret = (__x < 0) ? -__x : __x; \
160 } \
161 ret; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 })
163
Brian Behlendorf658716d2010-10-26 14:23:10 -0700164#define abs64(x) ({ \
165 s64 __x = (x); \
166 (__x < 0) ? -__x : __x; \
167 })
168
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200169#ifdef CONFIG_PROVE_LOCKING
170void might_fault(void);
171#else
172static inline void might_fault(void)
173{
174 might_sleep();
175}
176#endif
177
Alan Sterne041c682006-03-27 01:16:30 -0800178extern struct atomic_notifier_head panic_notifier_list;
TAMUKI Shoichic7ff0d92010-08-10 18:03:28 -0700179extern long (*panic_blink)(int state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180NORET_TYPE void panic(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200181 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800182extern void oops_enter(void);
183extern void oops_exit(void);
Anton Blanchard863a6042010-08-10 18:03:30 -0700184void print_oops_end_marker(void);
Andrew Mortondd287792006-03-23 03:00:57 -0800185extern int oops_may_print(void);
Harvey Harrisonec701582008-02-08 04:19:55 -0800186NORET_TYPE void do_exit(long error_code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 ATTRIB_NORET;
188NORET_TYPE void complete_and_exit(struct completion *, long)
189 ATTRIB_NORET;
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700190
191/* Internal, do not use. */
192int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
193int __must_check _kstrtol(const char *s, unsigned int base, long *res);
194
195int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
196int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
197static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
198{
199 /*
200 * We want to shortcut function call, but
201 * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
202 */
203 if (sizeof(unsigned long) == sizeof(unsigned long long) &&
204 __alignof__(unsigned long) == __alignof__(unsigned long long))
205 return kstrtoull(s, base, (unsigned long long *)res);
206 else
207 return _kstrtoul(s, base, res);
208}
209
210static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
211{
212 /*
213 * We want to shortcut function call, but
214 * __builtin_types_compatible_p(long, long long) = 0.
215 */
216 if (sizeof(long) == sizeof(long long) &&
217 __alignof__(long) == __alignof__(long long))
218 return kstrtoll(s, base, (long long *)res);
219 else
220 return _kstrtol(s, base, res);
221}
222
223int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
224int __must_check kstrtoint(const char *s, unsigned int base, int *res);
225
226static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
227{
228 return kstrtoull(s, base, res);
229}
230
231static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
232{
233 return kstrtoll(s, base, res);
234}
235
236static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
237{
238 return kstrtouint(s, base, res);
239}
240
241static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
242{
243 return kstrtoint(s, base, res);
244}
245
246int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
247int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
248int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
249int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);
250
Alexey Dobriyanc196e322011-05-24 17:13:31 -0700251int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
252int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
253int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
254int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
255int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
256int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
257int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
258int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
259int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
260int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);
261
262static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
263{
264 return kstrtoull_from_user(s, count, base, res);
265}
266
267static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
268{
269 return kstrtoll_from_user(s, count, base, res);
270}
271
272static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
273{
274 return kstrtouint_from_user(s, count, base, res);
275}
276
277static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
278{
279 return kstrtoint_from_user(s, count, base, res);
280}
281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282extern unsigned long simple_strtoul(const char *,char **,unsigned int);
283extern long simple_strtol(const char *,char **,unsigned int);
284extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
285extern long long simple_strtoll(const char *,char **,unsigned int);
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700286#define strict_strtoul kstrtoul
287#define strict_strtol kstrtol
288#define strict_strtoull kstrtoull
289#define strict_strtoll kstrtoll
290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291extern int sprintf(char * buf, const char * fmt, ...)
292 __attribute__ ((format (printf, 2, 3)));
293extern int vsprintf(char *buf, const char *, va_list)
294 __attribute__ ((format (printf, 2, 0)));
295extern int snprintf(char * buf, size_t size, const char * fmt, ...)
296 __attribute__ ((format (printf, 3, 4)));
297extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
298 __attribute__ ((format (printf, 3, 0)));
299extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
300 __attribute__ ((format (printf, 3, 4)));
301extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
302 __attribute__ ((format (printf, 3, 0)));
Jeremy Fitzhardingee9059142006-06-25 05:49:17 -0700303extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
304 __attribute__ ((format (printf, 2, 3)));
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700305extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
307extern int sscanf(const char *, const char *, ...)
308 __attribute__ ((format (scanf, 2, 3)));
309extern int vsscanf(const char *, const char *, va_list)
310 __attribute__ ((format (scanf, 2, 0)));
311
312extern int get_option(char **str, int *pint);
313extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700314extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
Trent Piepho5e376612006-05-15 09:44:06 -0700316extern int core_kernel_text(unsigned long addr);
Steven Rostedtcdbe61b2011-05-05 21:14:55 -0400317extern int core_kernel_data(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318extern int __kernel_text_address(unsigned long addr);
319extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700320extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700321
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800322struct pid;
323extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325unsigned long int_sqrt(unsigned long);
326
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800328extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700330extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200332extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700333extern int panic_on_io_nmi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700335extern void add_taint(unsigned flag);
336extern int test_taint(unsigned flag);
337extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800338extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Tejun Heo2ce802f2011-01-20 12:06:35 +0100340extern bool early_boot_irqs_disabled;
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342/* Values used for system_state */
343extern enum system_states {
344 SYSTEM_BOOTING,
345 SYSTEM_RUNNING,
346 SYSTEM_HALT,
347 SYSTEM_POWER_OFF,
348 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500349 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350} system_state;
351
Andi Kleen25ddbb12008-10-15 22:01:41 -0700352#define TAINT_PROPRIETARY_MODULE 0
353#define TAINT_FORCED_MODULE 1
354#define TAINT_UNSAFE_SMP 2
355#define TAINT_FORCED_RMMOD 3
356#define TAINT_MACHINE_CHECK 4
357#define TAINT_BAD_PAGE 5
358#define TAINT_USER 6
359#define TAINT_DIE 7
360#define TAINT_OVERRIDDEN_ACPI_TABLE 8
361#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700362#define TAINT_CRAP 10
Ben Hutchings92946bc2010-04-03 19:36:42 +0100363#define TAINT_FIRMWARE_WORKAROUND 11
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Harvey Harrison3fc95772008-05-14 16:05:49 -0700365extern const char hex_asc[];
366#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
367#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
368
369static inline char *pack_hex_byte(char *buf, u8 byte)
370{
371 *buf++ = hex_asc_hi(byte);
372 *buf++ = hex_asc_lo(byte);
373 return buf;
374}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700375
Andy Shevchenko903788892010-05-24 14:33:23 -0700376extern int hex_to_bin(char ch);
Mimi Zohardc88e462010-11-23 17:50:31 -0500377extern void hex2bin(u8 *dst, const char *src, size_t count);
Andy Shevchenko903788892010-05-24 14:33:23 -0700378
Joe Perches8a64f332009-12-14 18:00:25 -0800379/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100380 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500381 * tracing_on/tracing_off and tracing_start()/tracing_stop
382 *
383 * Use tracing_on/tracing_off when you want to quickly turn on or off
384 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900385 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500386 * file, which gives a means for the kernel and userspace to interact.
387 * Place a tracing_off() in the kernel where you want tracing to end.
388 * From user space, examine the trace, and then echo 1 > tracing_on
389 * to continue tracing.
390 *
391 * tracing_stop/tracing_start has slightly more overhead. It is used
392 * by things like suspend to ram where disabling the recording of the
393 * trace is not enough, but tracing must actually stop because things
394 * like calling smp_processor_id() may crash the system.
395 *
396 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100397 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500398#ifdef CONFIG_RING_BUFFER
399void tracing_on(void);
400void tracing_off(void);
401/* trace_off_permanent stops recording with no way to bring it back */
402void tracing_off_permanent(void);
403int tracing_is_on(void);
404#else
405static inline void tracing_on(void) { }
406static inline void tracing_off(void) { }
407static inline void tracing_off_permanent(void) { }
408static inline int tracing_is_on(void) { return 0; }
409#endif
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200410
411enum ftrace_dump_mode {
412 DUMP_NONE,
413 DUMP_ALL,
414 DUMP_ORIG,
415};
416
Ingo Molnar526211b2009-03-05 10:28:45 +0100417#ifdef CONFIG_TRACING
418extern void tracing_start(void);
419extern void tracing_stop(void);
420extern void ftrace_off_permanent(void);
421
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100422static inline void __attribute__ ((format (printf, 1, 2)))
423____trace_printk_check_format(const char *fmt, ...)
424{
425}
426#define __trace_printk_check_format(fmt, args...) \
427do { \
428 if (0) \
429 ____trace_printk_check_format(fmt, ##args); \
430} while (0)
431
Ingo Molnar526211b2009-03-05 10:28:45 +0100432/**
433 * trace_printk - printf formatting in the ftrace buffer
434 * @fmt: the printf format for printing
435 *
436 * Note: __trace_printk is an internal function for trace_printk and
437 * the @ip is passed in via the trace_printk macro.
438 *
439 * This function allows a kernel developer to debug fast path sections
440 * that printk is not appropriate for. By scattering in various
441 * printk like tracing in the code, a developer can quickly see
442 * where problems are occurring.
443 *
444 * This is intended as a debugging tool for the developer only.
445 * Please refrain from leaving trace_printks scattered around in
446 * your code.
447 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100448
449#define trace_printk(fmt, args...) \
450do { \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100451 __trace_printk_check_format(fmt, ##args); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100452 if (__builtin_constant_p(fmt)) { \
453 static const char *trace_printk_fmt \
454 __attribute__((section("__trace_printk_fmt"))) = \
455 __builtin_constant_p(fmt) ? fmt : NULL; \
456 \
457 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
458 } else \
459 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100460} while (0)
461
Ingo Molnar526211b2009-03-05 10:28:45 +0100462extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100463__trace_bprintk(unsigned long ip, const char *fmt, ...)
464 __attribute__ ((format (printf, 2, 3)));
465
466extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100467__trace_printk(unsigned long ip, const char *fmt, ...)
468 __attribute__ ((format (printf, 2, 3)));
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100469
Steven Rostedt03889382009-12-11 09:48:22 -0500470extern void trace_dump_stack(void);
471
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100472/*
473 * The double __builtin_constant_p is because gcc will give us an error
474 * if we try to allocate the static variable to fmt if it is not a
475 * constant. Even with the outer if statement.
476 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100477#define ftrace_vprintk(fmt, vargs) \
478do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100479 if (__builtin_constant_p(fmt)) { \
480 static const char *trace_printk_fmt \
481 __attribute__((section("__trace_printk_fmt"))) = \
482 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100483 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100484 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
485 } else \
486 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100487} while (0)
488
Ingo Molnar526211b2009-03-05 10:28:45 +0100489extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100490__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
491
492extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100493__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100494
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200495extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
Ingo Molnar526211b2009-03-05 10:28:45 +0100496#else
Ingo Molnar526211b2009-03-05 10:28:45 +0100497static inline int
498trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
499
500static inline void tracing_start(void) { }
501static inline void tracing_stop(void) { }
502static inline void ftrace_off_permanent(void) { }
Steven Rostedte36c5452009-12-14 15:58:33 -0500503static inline void trace_dump_stack(void) { }
Ingo Molnar526211b2009-03-05 10:28:45 +0100504static inline int
505trace_printk(const char *fmt, ...)
506{
507 return 0;
508}
509static inline int
510ftrace_vprintk(const char *fmt, va_list ap)
511{
512 return 0;
513}
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200514static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100515#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100516
517/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700518 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 * strict type-checking.. See the
520 * "unnecessary" pointer comparison.
521 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700522#define min(x, y) ({ \
523 typeof(x) _min1 = (x); \
524 typeof(y) _min2 = (y); \
525 (void) (&_min1 == &_min2); \
526 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700528#define max(x, y) ({ \
529 typeof(x) _max1 = (x); \
530 typeof(y) _max2 = (y); \
531 (void) (&_max1 == &_max2); \
532 _max1 > _max2 ? _max1 : _max2; })
533
Hagen Paul Pfeiferf27c85c2010-10-26 14:22:21 -0700534#define min3(x, y, z) ({ \
535 typeof(x) _min1 = (x); \
536 typeof(y) _min2 = (y); \
537 typeof(z) _min3 = (z); \
538 (void) (&_min1 == &_min2); \
539 (void) (&_min1 == &_min3); \
540 _min1 < _min2 ? (_min1 < _min3 ? _min1 : _min3) : \
541 (_min2 < _min3 ? _min2 : _min3); })
542
543#define max3(x, y, z) ({ \
544 typeof(x) _max1 = (x); \
545 typeof(y) _max2 = (y); \
546 typeof(z) _max3 = (z); \
547 (void) (&_max1 == &_max2); \
548 (void) (&_max1 == &_max3); \
549 _max1 > _max2 ? (_max1 > _max3 ? _max1 : _max3) : \
550 (_max2 > _max3 ? _max2 : _max3); })
551
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700552/**
Martin K. Petersenc8bf1332010-09-10 20:07:38 +0200553 * min_not_zero - return the minimum that is _not_ zero, unless both are zero
554 * @x: value1
555 * @y: value2
556 */
557#define min_not_zero(x, y) ({ \
558 typeof(x) __x = (x); \
559 typeof(y) __y = (y); \
560 __x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
561
562/**
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700563 * clamp - return a value clamped to a given range with strict typechecking
564 * @val: current value
565 * @min: minimum allowable value
566 * @max: maximum allowable value
567 *
568 * This macro does strict typechecking of min/max to make sure they are of the
569 * same type as val. See the unnecessary pointer comparisons.
570 */
571#define clamp(val, min, max) ({ \
572 typeof(val) __val = (val); \
573 typeof(min) __min = (min); \
574 typeof(max) __max = (max); \
575 (void) (&__val == &__min); \
576 (void) (&__val == &__max); \
577 __val = __val < __min ? __min: __val; \
578 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
580/*
581 * ..and if you can't take the strict
582 * types, you can specify one yourself.
583 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700584 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700586#define min_t(type, x, y) ({ \
587 type __min1 = (x); \
588 type __min2 = (y); \
589 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700591#define max_t(type, x, y) ({ \
592 type __max1 = (x); \
593 type __max2 = (y); \
594 __max1 > __max2 ? __max1: __max2; })
595
596/**
597 * clamp_t - return a value clamped to a given range using a given type
598 * @type: the type of variable to use
599 * @val: current value
600 * @min: minimum allowable value
601 * @max: maximum allowable value
602 *
603 * This macro does no typechecking and uses temporary variables of type
604 * 'type' to make all the comparisons.
605 */
606#define clamp_t(type, val, min, max) ({ \
607 type __val = (val); \
608 type __min = (min); \
609 type __max = (max); \
610 __val = __val < __min ? __min: __val; \
611 __val > __max ? __max: __val; })
612
613/**
614 * clamp_val - return a value clamped to a given range using val's type
615 * @val: current value
616 * @min: minimum allowable value
617 * @max: maximum allowable value
618 *
619 * This macro does no typechecking and uses temporary variables of whatever
620 * type the input argument 'val' is. This is useful when val is an unsigned
621 * type and min and max are literals that will otherwise be assigned a signed
622 * integer type.
623 */
624#define clamp_val(val, min, max) ({ \
625 typeof(val) __val = (val); \
626 typeof(val) __min = (min); \
627 typeof(val) __max = (max); \
628 __val = __val < __min ? __min: __val; \
629 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Wu Fengguang91f68b72009-01-07 18:09:12 -0800631
632/*
633 * swap - swap value of @a and @b
634 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800635#define swap(a, b) \
636 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800637
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638/**
639 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 * @ptr: the pointer to the member.
641 * @type: the type of the container struct this is embedded in.
642 * @member: the name of the member within the struct.
643 *
644 */
645#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700646 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
647 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Kyle McMartind4d23ad2007-02-10 01:46:00 -0800649struct sysinfo;
650extern int do_sysinfo(struct sysinfo *info);
651
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652#endif /* __KERNEL__ */
653
654#define SI_LOAD_SHIFT 16
655struct sysinfo {
656 long uptime; /* Seconds since boot */
657 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
658 unsigned long totalram; /* Total usable main memory size */
659 unsigned long freeram; /* Available memory size */
660 unsigned long sharedram; /* Amount of shared memory */
661 unsigned long bufferram; /* Memory used by buffers */
662 unsigned long totalswap; /* Total swap space size */
663 unsigned long freeswap; /* swap space still available */
664 unsigned short procs; /* Number of current processes */
665 unsigned short pad; /* explicit padding for m68k */
666 unsigned long totalhigh; /* Total high memory size */
667 unsigned long freehigh; /* Available high memory size */
668 unsigned int mem_unit; /* Memory unit size in bytes */
669 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
670};
671
KOSAKI Motohiro903c0c72011-05-24 17:13:16 -0700672#ifdef __CHECKER__
673#define BUILD_BUG_ON_NOT_POWER_OF_2(n)
Dr. David Alan Gilbertca395992011-06-15 15:08:27 -0700674#define BUILD_BUG_ON_ZERO(e) (0)
675#define BUILD_BUG_ON_NULL(e) ((void*)0)
KOSAKI Motohiro903c0c72011-05-24 17:13:16 -0700676#define BUILD_BUG_ON(condition)
677#else /* __CHECKER__ */
678
Roland Dreiercc8ef6e2010-01-15 17:01:22 -0800679/* Force a compilation error if a constant expression is not a power of 2 */
680#define BUILD_BUG_ON_NOT_POWER_OF_2(n) \
681 BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
682
Jan Beulich4552d5d2006-06-26 13:57:28 +0200683/* Force a compilation error if condition is true, but also produce a
684 result (of value 0 and type size_t), so the expression can be used
685 e.g. in a structure initializer (or where-ever else comma expressions
686 aren't permitted). */
Jan Beulich8c87df42009-09-22 16:43:52 -0700687#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
688#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
Jan Beulich4552d5d2006-06-26 13:57:28 +0200689
Rusty Russell7ef88ad2011-01-24 14:45:10 -0600690/**
691 * BUILD_BUG_ON - break compile if a condition is true.
Randy Dunlapffbbf2d2011-01-31 09:29:14 -0800692 * @condition: the condition which the compiler should know is false.
Rusty Russell7ef88ad2011-01-24 14:45:10 -0600693 *
694 * If you have some code which relies on certain constants being equal, or
695 * other compile-time-evaluated condition, you should use BUILD_BUG_ON to
696 * detect if someone changes it.
697 *
698 * The implementation uses gcc's reluctance to create a negative array, but
699 * gcc (as of 4.4) only emits that error for obvious cases (eg. not arguments
700 * to inline functions). So as a fallback we use the optimizer; if it can't
701 * prove the condition is false, it will cause a link error on the undefined
702 * "__build_bug_on_failed". This error message can be harder to track down
703 * though, hence the two different methods.
704 */
705#ifndef __OPTIMIZE__
706#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
707#else
708extern int __build_bug_on_failed;
709#define BUILD_BUG_ON(condition) \
710 do { \
711 ((void)sizeof(char[1 - 2*!!(condition)])); \
712 if (condition) __build_bug_on_failed = 1; \
713 } while(0)
714#endif
KOSAKI Motohiro903c0c72011-05-24 17:13:16 -0700715#endif /* __CHECKER__ */
Rusty Russell7ef88ad2011-01-24 14:45:10 -0600716
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717/* Trap pasters of __FUNCTION__ at compile-time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718#define __FUNCTION__ (__func__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Christoph Lameter08e0f6a2006-09-27 01:50:06 -0700720/* This helps us to avoid #ifdef CONFIG_NUMA */
721#ifdef CONFIG_NUMA
722#define NUMA_BUILD 1
723#else
724#define NUMA_BUILD 0
725#endif
726
Mel Gorman3e7d3442011-01-13 15:45:56 -0800727/* This helps us avoid #ifdef CONFIG_COMPACTION */
728#ifdef CONFIG_COMPACTION
729#define COMPACTION_BUILD 1
730#else
731#define COMPACTION_BUILD 0
732#endif
733
Steven Rostedt29e71ab2008-08-14 15:45:10 -0400734/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
735#ifdef CONFIG_FTRACE_MCOUNT_RECORD
736# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
737#endif
738
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739#endif