blob: 51b9548fd12db5b52177ae3edad144f74a63bd9a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_KERNEL_H
2#define _LINUX_KERNEL_H
3
4/*
5 * 'kernel.h' contains some often-used function prototypes etc
6 */
Alexey Dobriyana79ff732010-04-13 11:21:46 +02007#define __ALIGN_KERNEL(x, a) __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
8#define __ALIGN_KERNEL_MASK(x, mask) (((x) + (mask)) & ~(mask))
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10#ifdef __KERNEL__
11
12#include <stdarg.h>
13#include <linux/linkage.h>
14#include <linux/stddef.h>
15#include <linux/types.h>
16#include <linux/compiler.h>
17#include <linux/bitops.h>
David Howellsf0d1b0b2006-12-08 02:37:49 -080018#include <linux/log2.h>
Andrew Mortone0deaff2008-07-25 01:45:24 -070019#include <linux/typecheck.h>
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 Russellc5e631c2007-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))
Nicholas Bellinger36a26c62011-07-26 00:35:26 -070059#define DIV_ROUND_UP_ULL(ll,d) \
60 ({ unsigned long long _tmp = (ll)+(d)-1; do_div(_tmp, d); _tmp; })
61
62#if BITS_PER_LONG == 32
63# define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP_ULL(ll, d)
64#else
65# define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP(ll,d)
66#endif
James Morris074e61e2010-11-10 09:01:31 +110067
68/* The `const' in roundup() prevents gcc-3.3 from calling __divdi3 */
Eric Parisb28efd52010-10-13 17:50:08 -040069#define roundup(x, y) ( \
70{ \
Tetsuo Handa6070bf32010-11-08 11:20:49 +090071 const typeof(y) __y = y; \
Eric Parisb28efd52010-10-13 17:50:08 -040072 (((x) + (__y - 1)) / __y) * __y; \
73} \
74)
Eric Paris686a0f32010-10-13 17:50:02 -040075#define rounddown(x, y) ( \
76{ \
77 typeof(x) __x = (x); \
78 __x - (__x % (y)); \
79} \
80)
Darrick J. Wong9fe06082009-01-06 14:40:51 -080081#define DIV_ROUND_CLOSEST(x, divisor)( \
82{ \
83 typeof(divisor) __divisor = divisor; \
84 (((x) + ((__divisor) / 2)) / (__divisor)); \
85} \
86)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Eduard - Gabriel Munteanuca31e142008-07-05 12:14:23 +030088#define _RET_IP_ (unsigned long)__builtin_return_address(0)
89#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
90
Bartlomiej Zolnierkiewicz90c699a2009-06-19 08:08:50 +020091#ifdef CONFIG_LBDAF
Jens Axboe2da96ac2007-10-12 12:40:38 +020092# include <asm/div64.h>
93# define sector_div(a, b) do_div(a, b)
94#else
95# define sector_div(n, b)( \
96{ \
97 int _res; \
98 _res = (n) % (b); \
99 (n) /= (b); \
100 _res; \
101} \
102)
103#endif
104
Andrew Morton218e1802007-05-10 03:15:18 -0700105/**
106 * upper_32_bits - return bits 32-63 of a number
107 * @n: the number we're accessing
108 *
109 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
110 * the "right shift count >= width of type" warning when that quantity is
111 * 32-bits.
112 */
113#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
114
Joerg Roedel204b8852008-07-29 22:33:42 -0700115/**
116 * lower_32_bits - return bits 0-31 of a number
117 * @n: the number we're accessing
118 */
119#define lower_32_bits(n) ((u32)(n))
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800122struct pt_regs;
123struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700125#ifdef CONFIG_PREEMPT_VOLUNTARY
126extern int _cond_resched(void);
127# define might_resched() _cond_resched()
128#else
129# define might_resched() do { } while (0)
130#endif
131
Frederic Weisbeckerd902db12011-06-08 19:31:56 +0200132#ifdef CONFIG_DEBUG_ATOMIC_SLEEP
Simon Kagstromd8948372009-12-23 11:08:18 +0100133 void __might_sleep(const char *file, int line, int preempt_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134/**
135 * might_sleep - annotation for functions that can sleep
136 *
137 * this macro will print a stack trace if it is executed in an atomic
138 * context (spinlock, irq-handler, ...).
139 *
140 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100141 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 * supposed to.
143 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700144# define might_sleep() \
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200145 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700146#else
Simon Kagstromd8948372009-12-23 11:08:18 +0100147 static inline void __might_sleep(const char *file, int line,
148 int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700149# define might_sleep() do { might_resched(); } while (0)
150#endif
151
Hua Zhong368a5fa2006-06-23 02:05:42 -0700152#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700153
Andrew Morton71a90482011-01-12 16:59:35 -0800154/*
155 * abs() handles unsigned and signed longs, ints, shorts and chars. For all
156 * input types abs() returns a signed long.
157 * abs() should not be used for 64-bit types (s64, u64, long long) - use abs64()
158 * for those.
159 */
160#define abs(x) ({ \
161 long ret; \
162 if (sizeof(x) == sizeof(long)) { \
163 long __x = (x); \
164 ret = (__x < 0) ? -__x : __x; \
165 } else { \
166 int __x = (x); \
167 ret = (__x < 0) ? -__x : __x; \
168 } \
169 ret; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 })
171
Brian Behlendorf658716d2010-10-26 14:23:10 -0700172#define abs64(x) ({ \
173 s64 __x = (x); \
174 (__x < 0) ? -__x : __x; \
175 })
176
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200177#ifdef CONFIG_PROVE_LOCKING
178void might_fault(void);
179#else
180static inline void might_fault(void)
181{
182 might_sleep();
183}
184#endif
185
Alan Sterne041c682006-03-27 01:16:30 -0800186extern struct atomic_notifier_head panic_notifier_list;
TAMUKI Shoichic7ff0d92010-08-10 18:03:28 -0700187extern long (*panic_blink)(int state);
Joe Perches9402c952012-01-12 17:17:17 -0800188__printf(1, 2)
Joe Perches4da47852012-01-12 17:17:13 -0800189void panic(const char *fmt, ...)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800190 __noreturn __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800191extern void oops_enter(void);
192extern void oops_exit(void);
Anton Blanchard863a6042010-08-10 18:03:30 -0700193void print_oops_end_marker(void);
Andrew Mortondd287792006-03-23 03:00:57 -0800194extern int oops_may_print(void);
Joe Perches9402c952012-01-12 17:17:17 -0800195void do_exit(long error_code)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800196 __noreturn;
Joe Perches9402c952012-01-12 17:17:17 -0800197void complete_and_exit(struct completion *, long)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800198 __noreturn;
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700199
200/* Internal, do not use. */
201int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
202int __must_check _kstrtol(const char *s, unsigned int base, long *res);
203
204int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
205int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
206static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
207{
208 /*
209 * We want to shortcut function call, but
210 * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
211 */
212 if (sizeof(unsigned long) == sizeof(unsigned long long) &&
213 __alignof__(unsigned long) == __alignof__(unsigned long long))
214 return kstrtoull(s, base, (unsigned long long *)res);
215 else
216 return _kstrtoul(s, base, res);
217}
218
219static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
220{
221 /*
222 * We want to shortcut function call, but
223 * __builtin_types_compatible_p(long, long long) = 0.
224 */
225 if (sizeof(long) == sizeof(long long) &&
226 __alignof__(long) == __alignof__(long long))
227 return kstrtoll(s, base, (long long *)res);
228 else
229 return _kstrtol(s, base, res);
230}
231
232int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
233int __must_check kstrtoint(const char *s, unsigned int base, int *res);
234
235static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
236{
237 return kstrtoull(s, base, res);
238}
239
240static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
241{
242 return kstrtoll(s, base, res);
243}
244
245static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
246{
247 return kstrtouint(s, base, res);
248}
249
250static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
251{
252 return kstrtoint(s, base, res);
253}
254
255int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
256int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
257int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
258int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);
259
Alexey Dobriyanc196e322011-05-24 17:13:31 -0700260int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
261int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
262int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
263int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
264int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
265int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
266int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
267int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
268int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
269int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);
270
271static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
272{
273 return kstrtoull_from_user(s, count, base, res);
274}
275
276static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
277{
278 return kstrtoll_from_user(s, count, base, res);
279}
280
281static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
282{
283 return kstrtouint_from_user(s, count, base, res);
284}
285
286static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
287{
288 return kstrtoint_from_user(s, count, base, res);
289}
290
Joe Perches67d0a072011-10-31 17:13:10 -0700291/* Obsolete, do not use. Use kstrto<foo> instead */
292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293extern unsigned long simple_strtoul(const char *,char **,unsigned int);
294extern long simple_strtol(const char *,char **,unsigned int);
295extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
296extern long long simple_strtoll(const char *,char **,unsigned int);
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700297#define strict_strtoul kstrtoul
298#define strict_strtol kstrtol
299#define strict_strtoull kstrtoull
300#define strict_strtoll kstrtoll
301
Joe Perches67d0a072011-10-31 17:13:10 -0700302/* lib/printf utilities */
303
Joe Perchesb9075fa2011-10-31 17:11:33 -0700304extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
305extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
306extern __printf(3, 4)
307int snprintf(char *buf, size_t size, const char *fmt, ...);
308extern __printf(3, 0)
309int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
310extern __printf(3, 4)
311int scnprintf(char *buf, size_t size, const char *fmt, ...);
312extern __printf(3, 0)
313int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
314extern __printf(2, 3)
315char *kasprintf(gfp_t gfp, const char *fmt, ...);
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700316extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
318extern int sscanf(const char *, const char *, ...)
319 __attribute__ ((format (scanf, 2, 3)));
320extern int vsscanf(const char *, const char *, va_list)
321 __attribute__ ((format (scanf, 2, 0)));
322
323extern int get_option(char **str, int *pint);
324extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700325extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
Trent Piepho5e376612006-05-15 09:44:06 -0700327extern int core_kernel_text(unsigned long addr);
Steven Rostedtcdbe61b2011-05-05 21:14:55 -0400328extern int core_kernel_data(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329extern int __kernel_text_address(unsigned long addr);
330extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700331extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700332
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800333struct pid;
334extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336unsigned long int_sqrt(unsigned long);
337
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800339extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700341extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200343extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700344extern int panic_on_io_nmi;
Mitsuo Hayasaka55af7792011-11-29 15:08:36 +0900345extern int sysctl_panic_on_stackoverflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700347extern void add_taint(unsigned flag);
348extern int test_taint(unsigned flag);
349extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800350extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
Tejun Heo2ce802f2011-01-20 12:06:35 +0100352extern bool early_boot_irqs_disabled;
353
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354/* Values used for system_state */
355extern enum system_states {
356 SYSTEM_BOOTING,
357 SYSTEM_RUNNING,
358 SYSTEM_HALT,
359 SYSTEM_POWER_OFF,
360 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500361 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362} system_state;
363
Andi Kleen25ddbb12008-10-15 22:01:41 -0700364#define TAINT_PROPRIETARY_MODULE 0
365#define TAINT_FORCED_MODULE 1
366#define TAINT_UNSAFE_SMP 2
367#define TAINT_FORCED_RMMOD 3
368#define TAINT_MACHINE_CHECK 4
369#define TAINT_BAD_PAGE 5
370#define TAINT_USER 6
371#define TAINT_DIE 7
372#define TAINT_OVERRIDDEN_ACPI_TABLE 8
373#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700374#define TAINT_CRAP 10
Ben Hutchings92946bc2010-04-03 19:36:42 +0100375#define TAINT_FIRMWARE_WORKAROUND 11
Ben Hutchings2449b8b2011-10-24 15:12:28 +0200376#define TAINT_OOT_MODULE 12
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
Harvey Harrison3fc95772008-05-14 16:05:49 -0700378extern const char hex_asc[];
379#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
380#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
381
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700382static inline char *hex_byte_pack(char *buf, u8 byte)
Harvey Harrison3fc95772008-05-14 16:05:49 -0700383{
384 *buf++ = hex_asc_hi(byte);
385 *buf++ = hex_asc_lo(byte);
386 return buf;
387}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700388
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700389static inline char * __deprecated pack_hex_byte(char *buf, u8 byte)
390{
391 return hex_byte_pack(buf, byte);
392}
393
Andy Shevchenko90378882010-05-24 14:33:23 -0700394extern int hex_to_bin(char ch);
Mimi Zoharb7804982011-09-20 11:23:49 -0400395extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
Andy Shevchenko90378882010-05-24 14:33:23 -0700396
Joe Perches8a64f332009-12-14 18:00:25 -0800397/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100398 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500399 * tracing_on/tracing_off and tracing_start()/tracing_stop
400 *
401 * Use tracing_on/tracing_off when you want to quickly turn on or off
402 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900403 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500404 * file, which gives a means for the kernel and userspace to interact.
405 * Place a tracing_off() in the kernel where you want tracing to end.
406 * From user space, examine the trace, and then echo 1 > tracing_on
407 * to continue tracing.
408 *
409 * tracing_stop/tracing_start has slightly more overhead. It is used
410 * by things like suspend to ram where disabling the recording of the
411 * trace is not enough, but tracing must actually stop because things
412 * like calling smp_processor_id() may crash the system.
413 *
414 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100415 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500416#ifdef CONFIG_RING_BUFFER
Steven Rostedt2002c252009-03-05 10:35:56 -0500417/* trace_off_permanent stops recording with no way to bring it back */
418void tracing_off_permanent(void);
Steven Rostedt2002c252009-03-05 10:35:56 -0500419#else
Steven Rostedt2002c252009-03-05 10:35:56 -0500420static inline void tracing_off_permanent(void) { }
Steven Rostedt2002c252009-03-05 10:35:56 -0500421#endif
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200422
423enum ftrace_dump_mode {
424 DUMP_NONE,
425 DUMP_ALL,
426 DUMP_ORIG,
427};
428
Ingo Molnar526211b2009-03-05 10:28:45 +0100429#ifdef CONFIG_TRACING
Steven Rostedt93d68e52012-03-20 12:28:29 -0400430void tracing_on(void);
431void tracing_off(void);
432int tracing_is_on(void);
433
Ingo Molnar526211b2009-03-05 10:28:45 +0100434extern void tracing_start(void);
435extern void tracing_stop(void);
436extern void ftrace_off_permanent(void);
437
Joe Perchesb9075fa2011-10-31 17:11:33 -0700438static inline __printf(1, 2)
439void ____trace_printk_check_format(const char *fmt, ...)
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100440{
441}
442#define __trace_printk_check_format(fmt, args...) \
443do { \
444 if (0) \
445 ____trace_printk_check_format(fmt, ##args); \
446} while (0)
447
Ingo Molnar526211b2009-03-05 10:28:45 +0100448/**
449 * trace_printk - printf formatting in the ftrace buffer
450 * @fmt: the printf format for printing
451 *
452 * Note: __trace_printk is an internal function for trace_printk and
453 * the @ip is passed in via the trace_printk macro.
454 *
455 * This function allows a kernel developer to debug fast path sections
456 * that printk is not appropriate for. By scattering in various
457 * printk like tracing in the code, a developer can quickly see
458 * where problems are occurring.
459 *
460 * This is intended as a debugging tool for the developer only.
461 * Please refrain from leaving trace_printks scattered around in
462 * your code.
463 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100464
465#define trace_printk(fmt, args...) \
466do { \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100467 __trace_printk_check_format(fmt, ##args); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100468 if (__builtin_constant_p(fmt)) { \
469 static const char *trace_printk_fmt \
470 __attribute__((section("__trace_printk_fmt"))) = \
471 __builtin_constant_p(fmt) ? fmt : NULL; \
472 \
473 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
474 } else \
475 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100476} while (0)
477
Joe Perchesb9075fa2011-10-31 17:11:33 -0700478extern __printf(2, 3)
479int __trace_bprintk(unsigned long ip, const char *fmt, ...);
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100480
Joe Perchesb9075fa2011-10-31 17:11:33 -0700481extern __printf(2, 3)
482int __trace_printk(unsigned long ip, const char *fmt, ...);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100483
Steven Rostedt03889382009-12-11 09:48:22 -0500484extern void trace_dump_stack(void);
485
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100486/*
487 * The double __builtin_constant_p is because gcc will give us an error
488 * if we try to allocate the static variable to fmt if it is not a
489 * constant. Even with the outer if statement.
490 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100491#define ftrace_vprintk(fmt, vargs) \
492do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100493 if (__builtin_constant_p(fmt)) { \
494 static const char *trace_printk_fmt \
495 __attribute__((section("__trace_printk_fmt"))) = \
496 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100497 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100498 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
499 } else \
500 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100501} while (0)
502
Ingo Molnar526211b2009-03-05 10:28:45 +0100503extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100504__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
505
506extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100507__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100508
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200509extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
Ingo Molnar526211b2009-03-05 10:28:45 +0100510#else
Joe Perchesb9075fa2011-10-31 17:11:33 -0700511static inline __printf(1, 2)
512int trace_printk(const char *fmt, ...);
Ingo Molnar526211b2009-03-05 10:28:45 +0100513
514static inline void tracing_start(void) { }
515static inline void tracing_stop(void) { }
516static inline void ftrace_off_permanent(void) { }
Steven Rostedte36c5452009-12-14 15:58:33 -0500517static inline void trace_dump_stack(void) { }
Steven Rostedt93d68e52012-03-20 12:28:29 -0400518
519static inline void tracing_on(void) { }
520static inline void tracing_off(void) { }
521static inline int tracing_is_on(void) { return 0; }
522
Ingo Molnar526211b2009-03-05 10:28:45 +0100523static inline int
524trace_printk(const char *fmt, ...)
525{
526 return 0;
527}
528static inline int
529ftrace_vprintk(const char *fmt, va_list ap)
530{
531 return 0;
532}
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200533static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100534#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100535
536/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700537 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 * strict type-checking.. See the
539 * "unnecessary" pointer comparison.
540 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700541#define min(x, y) ({ \
542 typeof(x) _min1 = (x); \
543 typeof(y) _min2 = (y); \
544 (void) (&_min1 == &_min2); \
545 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700547#define max(x, y) ({ \
548 typeof(x) _max1 = (x); \
549 typeof(y) _max2 = (y); \
550 (void) (&_max1 == &_max2); \
551 _max1 > _max2 ? _max1 : _max2; })
552
Hagen Paul Pfeiferf27c85c2010-10-26 14:22:21 -0700553#define min3(x, y, z) ({ \
554 typeof(x) _min1 = (x); \
555 typeof(y) _min2 = (y); \
556 typeof(z) _min3 = (z); \
557 (void) (&_min1 == &_min2); \
558 (void) (&_min1 == &_min3); \
559 _min1 < _min2 ? (_min1 < _min3 ? _min1 : _min3) : \
560 (_min2 < _min3 ? _min2 : _min3); })
561
562#define max3(x, y, z) ({ \
563 typeof(x) _max1 = (x); \
564 typeof(y) _max2 = (y); \
565 typeof(z) _max3 = (z); \
566 (void) (&_max1 == &_max2); \
567 (void) (&_max1 == &_max3); \
568 _max1 > _max2 ? (_max1 > _max3 ? _max1 : _max3) : \
569 (_max2 > _max3 ? _max2 : _max3); })
570
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700571/**
Martin K. Petersenc8bf1332010-09-10 20:07:38 +0200572 * min_not_zero - return the minimum that is _not_ zero, unless both are zero
573 * @x: value1
574 * @y: value2
575 */
576#define min_not_zero(x, y) ({ \
577 typeof(x) __x = (x); \
578 typeof(y) __y = (y); \
579 __x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
580
581/**
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700582 * clamp - return a value clamped to a given range with strict typechecking
583 * @val: current value
584 * @min: minimum allowable value
585 * @max: maximum allowable value
586 *
587 * This macro does strict typechecking of min/max to make sure they are of the
588 * same type as val. See the unnecessary pointer comparisons.
589 */
590#define clamp(val, min, max) ({ \
591 typeof(val) __val = (val); \
592 typeof(min) __min = (min); \
593 typeof(max) __max = (max); \
594 (void) (&__val == &__min); \
595 (void) (&__val == &__max); \
596 __val = __val < __min ? __min: __val; \
597 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
599/*
600 * ..and if you can't take the strict
601 * types, you can specify one yourself.
602 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700603 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700605#define min_t(type, x, y) ({ \
606 type __min1 = (x); \
607 type __min2 = (y); \
608 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700610#define max_t(type, x, y) ({ \
611 type __max1 = (x); \
612 type __max2 = (y); \
613 __max1 > __max2 ? __max1: __max2; })
614
615/**
616 * clamp_t - return a value clamped to a given range using a given type
617 * @type: the type of variable to use
618 * @val: current value
619 * @min: minimum allowable value
620 * @max: maximum allowable value
621 *
622 * This macro does no typechecking and uses temporary variables of type
623 * 'type' to make all the comparisons.
624 */
625#define clamp_t(type, val, min, max) ({ \
626 type __val = (val); \
627 type __min = (min); \
628 type __max = (max); \
629 __val = __val < __min ? __min: __val; \
630 __val > __max ? __max: __val; })
631
632/**
633 * clamp_val - return a value clamped to a given range using val's type
634 * @val: current value
635 * @min: minimum allowable value
636 * @max: maximum allowable value
637 *
638 * This macro does no typechecking and uses temporary variables of whatever
639 * type the input argument 'val' is. This is useful when val is an unsigned
640 * type and min and max are literals that will otherwise be assigned a signed
641 * integer type.
642 */
643#define clamp_val(val, min, max) ({ \
644 typeof(val) __val = (val); \
645 typeof(val) __min = (min); \
646 typeof(val) __max = (max); \
647 __val = __val < __min ? __min: __val; \
648 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649
Wu Fengguang91f68b72009-01-07 18:09:12 -0800650
651/*
652 * swap - swap value of @a and @b
653 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800654#define swap(a, b) \
655 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800656
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657/**
658 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 * @ptr: the pointer to the member.
660 * @type: the type of the container struct this is embedded in.
661 * @member: the name of the member within the struct.
662 *
663 */
664#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700665 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
666 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
KOSAKI Motohiro903c0c72011-05-24 17:13:16 -0700668#ifdef __CHECKER__
669#define BUILD_BUG_ON_NOT_POWER_OF_2(n)
Dr. David Alan Gilbertca395992011-06-15 15:08:27 -0700670#define BUILD_BUG_ON_ZERO(e) (0)
671#define BUILD_BUG_ON_NULL(e) ((void*)0)
KOSAKI Motohiro903c0c72011-05-24 17:13:16 -0700672#define BUILD_BUG_ON(condition)
David Daney1399ff82012-01-10 15:07:25 -0800673#define BUILD_BUG() (0)
KOSAKI Motohiro903c0c72011-05-24 17:13:16 -0700674#else /* __CHECKER__ */
675
Roland Dreiercc8ef6e2010-01-15 17:01:22 -0800676/* Force a compilation error if a constant expression is not a power of 2 */
677#define BUILD_BUG_ON_NOT_POWER_OF_2(n) \
678 BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
679
Jan Beulich4552d5d2006-06-26 13:57:28 +0200680/* Force a compilation error if condition is true, but also produce a
681 result (of value 0 and type size_t), so the expression can be used
682 e.g. in a structure initializer (or where-ever else comma expressions
683 aren't permitted). */
Jan Beulich8c87df42009-09-22 16:43:52 -0700684#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
685#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
Jan Beulich4552d5d2006-06-26 13:57:28 +0200686
Rusty Russell7ef88ad2011-01-24 14:45:10 -0600687/**
688 * BUILD_BUG_ON - break compile if a condition is true.
Randy Dunlapffbbf2d2011-01-31 09:29:14 -0800689 * @condition: the condition which the compiler should know is false.
Rusty Russell7ef88ad2011-01-24 14:45:10 -0600690 *
691 * If you have some code which relies on certain constants being equal, or
692 * other compile-time-evaluated condition, you should use BUILD_BUG_ON to
693 * detect if someone changes it.
694 *
695 * The implementation uses gcc's reluctance to create a negative array, but
696 * gcc (as of 4.4) only emits that error for obvious cases (eg. not arguments
697 * to inline functions). So as a fallback we use the optimizer; if it can't
698 * prove the condition is false, it will cause a link error on the undefined
699 * "__build_bug_on_failed". This error message can be harder to track down
700 * though, hence the two different methods.
701 */
702#ifndef __OPTIMIZE__
703#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
704#else
705extern int __build_bug_on_failed;
706#define BUILD_BUG_ON(condition) \
707 do { \
708 ((void)sizeof(char[1 - 2*!!(condition)])); \
709 if (condition) __build_bug_on_failed = 1; \
710 } while(0)
711#endif
David Daney1399ff82012-01-10 15:07:25 -0800712
713/**
714 * BUILD_BUG - break compile if used.
715 *
716 * If you have some code that you expect the compiler to eliminate at
717 * build time, you should use BUILD_BUG to detect if it is
718 * unexpectedly used.
719 */
720#define BUILD_BUG() \
721 do { \
722 extern void __build_bug_failed(void) \
723 __linktime_error("BUILD_BUG failed"); \
724 __build_bug_failed(); \
725 } while (0)
726
KOSAKI Motohiro903c0c72011-05-24 17:13:16 -0700727#endif /* __CHECKER__ */
Rusty Russell7ef88ad2011-01-24 14:45:10 -0600728
Arnaud Lacombeb9d4f422011-07-25 17:13:03 -0700729/* Trap pasters of __FUNCTION__ at compile-time */
730#define __FUNCTION__ (__func__)
731
732/* This helps us to avoid #ifdef CONFIG_NUMA */
733#ifdef CONFIG_NUMA
734#define NUMA_BUILD 1
735#else
736#define NUMA_BUILD 0
737#endif
738
739/* This helps us avoid #ifdef CONFIG_COMPACTION */
740#ifdef CONFIG_COMPACTION
741#define COMPACTION_BUILD 1
742#else
743#define COMPACTION_BUILD 0
744#endif
745
746/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
747#ifdef CONFIG_FTRACE_MCOUNT_RECORD
748# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
749#endif
WANG Cong9d00f922011-07-25 17:13:02 -0700750
751struct sysinfo;
752extern int do_sysinfo(struct sysinfo *info);
753
754#endif /* __KERNEL__ */
755
756#define SI_LOAD_SHIFT 16
757struct sysinfo {
758 long uptime; /* Seconds since boot */
759 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
760 unsigned long totalram; /* Total usable main memory size */
761 unsigned long freeram; /* Available memory size */
762 unsigned long sharedram; /* Amount of shared memory */
763 unsigned long bufferram; /* Memory used by buffers */
764 unsigned long totalswap; /* Total swap space size */
765 unsigned long freeswap; /* swap space still available */
766 unsigned short procs; /* Number of current processes */
767 unsigned short pad; /* explicit padding for m68k */
768 unsigned long totalhigh; /* Total high memory size */
769 unsigned long freehigh; /* Available high memory size */
770 unsigned int mem_unit; /* Memory unit size in bytes */
771 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
772};
773
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774#endif