blob: d801acb5e680897bf0914c91ce3a32ec487f05d3 [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))
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
Salman Qazi9993bc632012-03-09 16:41:01 -080088/*
89 * Multiplies an integer by a fraction, while avoiding unnecessary
90 * overflow or loss of precision.
91 */
92#define mult_frac(x, numer, denom)( \
93{ \
94 typeof(x) quot = (x) / (denom); \
95 typeof(x) rem = (x) % (denom); \
96 (quot * (numer)) + ((rem * (numer)) / (denom)); \
97} \
98)
99
100
Eduard - Gabriel Munteanuca31e142008-07-05 12:14:23 +0300101#define _RET_IP_ (unsigned long)__builtin_return_address(0)
102#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
103
Bartlomiej Zolnierkiewicz90c699a2009-06-19 08:08:50 +0200104#ifdef CONFIG_LBDAF
Jens Axboe2da96ac2007-10-12 12:40:38 +0200105# include <asm/div64.h>
106# define sector_div(a, b) do_div(a, b)
107#else
108# define sector_div(n, b)( \
109{ \
110 int _res; \
111 _res = (n) % (b); \
112 (n) /= (b); \
113 _res; \
114} \
115)
116#endif
117
Andrew Morton218e1802007-05-10 03:15:18 -0700118/**
119 * upper_32_bits - return bits 32-63 of a number
120 * @n: the number we're accessing
121 *
122 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
123 * the "right shift count >= width of type" warning when that quantity is
124 * 32-bits.
125 */
126#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
127
Joerg Roedel204b8852008-07-29 22:33:42 -0700128/**
129 * lower_32_bits - return bits 0-31 of a number
130 * @n: the number we're accessing
131 */
132#define lower_32_bits(n) ((u32)(n))
133
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800135struct pt_regs;
136struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700138#ifdef CONFIG_PREEMPT_VOLUNTARY
139extern int _cond_resched(void);
140# define might_resched() _cond_resched()
141#else
142# define might_resched() do { } while (0)
143#endif
144
Frederic Weisbeckerd902db12011-06-08 19:31:56 +0200145#ifdef CONFIG_DEBUG_ATOMIC_SLEEP
Simon Kagstromd8948372009-12-23 11:08:18 +0100146 void __might_sleep(const char *file, int line, int preempt_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147/**
148 * might_sleep - annotation for functions that can sleep
149 *
150 * this macro will print a stack trace if it is executed in an atomic
151 * context (spinlock, irq-handler, ...).
152 *
153 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100154 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 * supposed to.
156 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700157# define might_sleep() \
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200158 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700159#else
Simon Kagstromd8948372009-12-23 11:08:18 +0100160 static inline void __might_sleep(const char *file, int line,
161 int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700162# define might_sleep() do { might_resched(); } while (0)
163#endif
164
Hua Zhong368a5fa2006-06-23 02:05:42 -0700165#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700166
Andrew Morton71a90482011-01-12 16:59:35 -0800167/*
168 * abs() handles unsigned and signed longs, ints, shorts and chars. For all
169 * input types abs() returns a signed long.
170 * abs() should not be used for 64-bit types (s64, u64, long long) - use abs64()
171 * for those.
172 */
173#define abs(x) ({ \
174 long ret; \
175 if (sizeof(x) == sizeof(long)) { \
176 long __x = (x); \
177 ret = (__x < 0) ? -__x : __x; \
178 } else { \
179 int __x = (x); \
180 ret = (__x < 0) ? -__x : __x; \
181 } \
182 ret; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 })
184
Brian Behlendorf658716d2010-10-26 14:23:10 -0700185#define abs64(x) ({ \
186 s64 __x = (x); \
187 (__x < 0) ? -__x : __x; \
188 })
189
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200190#ifdef CONFIG_PROVE_LOCKING
191void might_fault(void);
192#else
193static inline void might_fault(void)
194{
195 might_sleep();
196}
197#endif
198
Alan Sterne041c682006-03-27 01:16:30 -0800199extern struct atomic_notifier_head panic_notifier_list;
TAMUKI Shoichic7ff0d92010-08-10 18:03:28 -0700200extern long (*panic_blink)(int state);
Joe Perches9402c952012-01-12 17:17:17 -0800201__printf(1, 2)
Joe Perches4da47852012-01-12 17:17:13 -0800202void panic(const char *fmt, ...)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800203 __noreturn __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800204extern void oops_enter(void);
205extern void oops_exit(void);
Anton Blanchard863a6042010-08-10 18:03:30 -0700206void print_oops_end_marker(void);
Andrew Mortondd287792006-03-23 03:00:57 -0800207extern int oops_may_print(void);
Joe Perches9402c952012-01-12 17:17:17 -0800208void do_exit(long error_code)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800209 __noreturn;
Joe Perches9402c952012-01-12 17:17:17 -0800210void complete_and_exit(struct completion *, long)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800211 __noreturn;
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700212
213/* Internal, do not use. */
214int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
215int __must_check _kstrtol(const char *s, unsigned int base, long *res);
216
217int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
218int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
219static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
220{
221 /*
222 * We want to shortcut function call, but
223 * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
224 */
225 if (sizeof(unsigned long) == sizeof(unsigned long long) &&
226 __alignof__(unsigned long) == __alignof__(unsigned long long))
227 return kstrtoull(s, base, (unsigned long long *)res);
228 else
229 return _kstrtoul(s, base, res);
230}
231
232static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
233{
234 /*
235 * We want to shortcut function call, but
236 * __builtin_types_compatible_p(long, long long) = 0.
237 */
238 if (sizeof(long) == sizeof(long long) &&
239 __alignof__(long) == __alignof__(long long))
240 return kstrtoll(s, base, (long long *)res);
241 else
242 return _kstrtol(s, base, res);
243}
244
245int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
246int __must_check kstrtoint(const char *s, unsigned int base, int *res);
247
248static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
249{
250 return kstrtoull(s, base, res);
251}
252
253static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
254{
255 return kstrtoll(s, base, res);
256}
257
258static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
259{
260 return kstrtouint(s, base, res);
261}
262
263static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
264{
265 return kstrtoint(s, base, res);
266}
267
268int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
269int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
270int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
271int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);
272
Alexey Dobriyanc196e322011-05-24 17:13:31 -0700273int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
274int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
275int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
276int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
277int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
278int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
279int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
280int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
281int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
282int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);
283
284static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
285{
286 return kstrtoull_from_user(s, count, base, res);
287}
288
289static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
290{
291 return kstrtoll_from_user(s, count, base, res);
292}
293
294static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
295{
296 return kstrtouint_from_user(s, count, base, res);
297}
298
299static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
300{
301 return kstrtoint_from_user(s, count, base, res);
302}
303
Joe Perches67d0a072011-10-31 17:13:10 -0700304/* Obsolete, do not use. Use kstrto<foo> instead */
305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306extern unsigned long simple_strtoul(const char *,char **,unsigned int);
307extern long simple_strtol(const char *,char **,unsigned int);
308extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
309extern long long simple_strtoll(const char *,char **,unsigned int);
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700310#define strict_strtoul kstrtoul
311#define strict_strtol kstrtol
312#define strict_strtoull kstrtoull
313#define strict_strtoll kstrtoll
314
Joe Perches67d0a072011-10-31 17:13:10 -0700315/* lib/printf utilities */
316
Joe Perchesb9075fa2011-10-31 17:11:33 -0700317extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
318extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
319extern __printf(3, 4)
320int snprintf(char *buf, size_t size, const char *fmt, ...);
321extern __printf(3, 0)
322int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
323extern __printf(3, 4)
324int scnprintf(char *buf, size_t size, const char *fmt, ...);
325extern __printf(3, 0)
326int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
327extern __printf(2, 3)
328char *kasprintf(gfp_t gfp, const char *fmt, ...);
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700329extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
331extern int sscanf(const char *, const char *, ...)
332 __attribute__ ((format (scanf, 2, 3)));
333extern int vsscanf(const char *, const char *, va_list)
334 __attribute__ ((format (scanf, 2, 0)));
335
336extern int get_option(char **str, int *pint);
337extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700338extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Trent Piepho5e376612006-05-15 09:44:06 -0700340extern int core_kernel_text(unsigned long addr);
Steven Rostedtcdbe61b2011-05-05 21:14:55 -0400341extern int core_kernel_data(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342extern int __kernel_text_address(unsigned long addr);
343extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700344extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700345
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800346struct pid;
347extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349unsigned long int_sqrt(unsigned long);
350
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800352extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700354extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200356extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700357extern int panic_on_io_nmi;
Mitsuo Hayasaka55af7792011-11-29 15:08:36 +0900358extern int sysctl_panic_on_stackoverflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700360extern void add_taint(unsigned flag);
361extern int test_taint(unsigned flag);
362extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800363extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Tejun Heo2ce802f2011-01-20 12:06:35 +0100365extern bool early_boot_irqs_disabled;
366
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367/* Values used for system_state */
368extern enum system_states {
369 SYSTEM_BOOTING,
370 SYSTEM_RUNNING,
371 SYSTEM_HALT,
372 SYSTEM_POWER_OFF,
373 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500374 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375} system_state;
376
Andi Kleen25ddbb12008-10-15 22:01:41 -0700377#define TAINT_PROPRIETARY_MODULE 0
378#define TAINT_FORCED_MODULE 1
379#define TAINT_UNSAFE_SMP 2
380#define TAINT_FORCED_RMMOD 3
381#define TAINT_MACHINE_CHECK 4
382#define TAINT_BAD_PAGE 5
383#define TAINT_USER 6
384#define TAINT_DIE 7
385#define TAINT_OVERRIDDEN_ACPI_TABLE 8
386#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700387#define TAINT_CRAP 10
Ben Hutchings92946bc2010-04-03 19:36:42 +0100388#define TAINT_FIRMWARE_WORKAROUND 11
Ben Hutchings2449b8b2011-10-24 15:12:28 +0200389#define TAINT_OOT_MODULE 12
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Harvey Harrison3fc95772008-05-14 16:05:49 -0700391extern const char hex_asc[];
392#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
393#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
394
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700395static inline char *hex_byte_pack(char *buf, u8 byte)
Harvey Harrison3fc95772008-05-14 16:05:49 -0700396{
397 *buf++ = hex_asc_hi(byte);
398 *buf++ = hex_asc_lo(byte);
399 return buf;
400}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700401
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700402static inline char * __deprecated pack_hex_byte(char *buf, u8 byte)
403{
404 return hex_byte_pack(buf, byte);
405}
406
Andy Shevchenko903788892010-05-24 14:33:23 -0700407extern int hex_to_bin(char ch);
Mimi Zoharb7804982011-09-20 11:23:49 -0400408extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
Andy Shevchenko903788892010-05-24 14:33:23 -0700409
Joe Perches8a64f332009-12-14 18:00:25 -0800410/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100411 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500412 * tracing_on/tracing_off and tracing_start()/tracing_stop
413 *
414 * Use tracing_on/tracing_off when you want to quickly turn on or off
415 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900416 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500417 * file, which gives a means for the kernel and userspace to interact.
418 * Place a tracing_off() in the kernel where you want tracing to end.
419 * From user space, examine the trace, and then echo 1 > tracing_on
420 * to continue tracing.
421 *
422 * tracing_stop/tracing_start has slightly more overhead. It is used
423 * by things like suspend to ram where disabling the recording of the
424 * trace is not enough, but tracing must actually stop because things
425 * like calling smp_processor_id() may crash the system.
426 *
427 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100428 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500429#ifdef CONFIG_RING_BUFFER
430void tracing_on(void);
431void tracing_off(void);
432/* trace_off_permanent stops recording with no way to bring it back */
433void tracing_off_permanent(void);
434int tracing_is_on(void);
435#else
436static inline void tracing_on(void) { }
437static inline void tracing_off(void) { }
438static inline void tracing_off_permanent(void) { }
439static inline int tracing_is_on(void) { return 0; }
440#endif
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200441
442enum ftrace_dump_mode {
443 DUMP_NONE,
444 DUMP_ALL,
445 DUMP_ORIG,
446};
447
Ingo Molnar526211b2009-03-05 10:28:45 +0100448#ifdef CONFIG_TRACING
449extern void tracing_start(void);
450extern void tracing_stop(void);
451extern void ftrace_off_permanent(void);
452
Joe Perchesb9075fa2011-10-31 17:11:33 -0700453static inline __printf(1, 2)
454void ____trace_printk_check_format(const char *fmt, ...)
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100455{
456}
457#define __trace_printk_check_format(fmt, args...) \
458do { \
459 if (0) \
460 ____trace_printk_check_format(fmt, ##args); \
461} while (0)
462
Ingo Molnar526211b2009-03-05 10:28:45 +0100463/**
464 * trace_printk - printf formatting in the ftrace buffer
465 * @fmt: the printf format for printing
466 *
467 * Note: __trace_printk is an internal function for trace_printk and
468 * the @ip is passed in via the trace_printk macro.
469 *
470 * This function allows a kernel developer to debug fast path sections
471 * that printk is not appropriate for. By scattering in various
472 * printk like tracing in the code, a developer can quickly see
473 * where problems are occurring.
474 *
475 * This is intended as a debugging tool for the developer only.
476 * Please refrain from leaving trace_printks scattered around in
477 * your code.
478 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100479
480#define trace_printk(fmt, args...) \
481do { \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100482 __trace_printk_check_format(fmt, ##args); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100483 if (__builtin_constant_p(fmt)) { \
484 static const char *trace_printk_fmt \
485 __attribute__((section("__trace_printk_fmt"))) = \
486 __builtin_constant_p(fmt) ? fmt : NULL; \
487 \
488 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
489 } else \
490 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100491} while (0)
492
Joe Perchesb9075fa2011-10-31 17:11:33 -0700493extern __printf(2, 3)
494int __trace_bprintk(unsigned long ip, const char *fmt, ...);
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100495
Joe Perchesb9075fa2011-10-31 17:11:33 -0700496extern __printf(2, 3)
497int __trace_printk(unsigned long ip, const char *fmt, ...);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100498
Steven Rostedt03889382009-12-11 09:48:22 -0500499extern void trace_dump_stack(void);
500
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100501/*
502 * The double __builtin_constant_p is because gcc will give us an error
503 * if we try to allocate the static variable to fmt if it is not a
504 * constant. Even with the outer if statement.
505 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100506#define ftrace_vprintk(fmt, vargs) \
507do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100508 if (__builtin_constant_p(fmt)) { \
509 static const char *trace_printk_fmt \
510 __attribute__((section("__trace_printk_fmt"))) = \
511 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100512 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100513 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
514 } else \
515 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100516} while (0)
517
Ingo Molnar526211b2009-03-05 10:28:45 +0100518extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100519__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
520
521extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100522__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100523
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200524extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
Ingo Molnar526211b2009-03-05 10:28:45 +0100525#else
Joe Perchesb9075fa2011-10-31 17:11:33 -0700526static inline __printf(1, 2)
527int trace_printk(const char *fmt, ...);
Ingo Molnar526211b2009-03-05 10:28:45 +0100528
529static inline void tracing_start(void) { }
530static inline void tracing_stop(void) { }
531static inline void ftrace_off_permanent(void) { }
Steven Rostedte36c5452009-12-14 15:58:33 -0500532static inline void trace_dump_stack(void) { }
Ingo Molnar526211b2009-03-05 10:28:45 +0100533static inline int
534trace_printk(const char *fmt, ...)
535{
536 return 0;
537}
538static inline int
539ftrace_vprintk(const char *fmt, va_list ap)
540{
541 return 0;
542}
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200543static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100544#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100545
546/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700547 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 * strict type-checking.. See the
549 * "unnecessary" pointer comparison.
550 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700551#define min(x, y) ({ \
552 typeof(x) _min1 = (x); \
553 typeof(y) _min2 = (y); \
554 (void) (&_min1 == &_min2); \
555 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700557#define max(x, y) ({ \
558 typeof(x) _max1 = (x); \
559 typeof(y) _max2 = (y); \
560 (void) (&_max1 == &_max2); \
561 _max1 > _max2 ? _max1 : _max2; })
562
Hagen Paul Pfeiferf27c85c2010-10-26 14:22:21 -0700563#define min3(x, y, z) ({ \
564 typeof(x) _min1 = (x); \
565 typeof(y) _min2 = (y); \
566 typeof(z) _min3 = (z); \
567 (void) (&_min1 == &_min2); \
568 (void) (&_min1 == &_min3); \
569 _min1 < _min2 ? (_min1 < _min3 ? _min1 : _min3) : \
570 (_min2 < _min3 ? _min2 : _min3); })
571
572#define max3(x, y, z) ({ \
573 typeof(x) _max1 = (x); \
574 typeof(y) _max2 = (y); \
575 typeof(z) _max3 = (z); \
576 (void) (&_max1 == &_max2); \
577 (void) (&_max1 == &_max3); \
578 _max1 > _max2 ? (_max1 > _max3 ? _max1 : _max3) : \
579 (_max2 > _max3 ? _max2 : _max3); })
580
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700581/**
Martin K. Petersenc8bf1332010-09-10 20:07:38 +0200582 * min_not_zero - return the minimum that is _not_ zero, unless both are zero
583 * @x: value1
584 * @y: value2
585 */
586#define min_not_zero(x, y) ({ \
587 typeof(x) __x = (x); \
588 typeof(y) __y = (y); \
589 __x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
590
591/**
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700592 * clamp - return a value clamped to a given range with strict typechecking
593 * @val: current value
594 * @min: minimum allowable value
595 * @max: maximum allowable value
596 *
597 * This macro does strict typechecking of min/max to make sure they are of the
598 * same type as val. See the unnecessary pointer comparisons.
599 */
600#define clamp(val, min, max) ({ \
601 typeof(val) __val = (val); \
602 typeof(min) __min = (min); \
603 typeof(max) __max = (max); \
604 (void) (&__val == &__min); \
605 (void) (&__val == &__max); \
606 __val = __val < __min ? __min: __val; \
607 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
609/*
610 * ..and if you can't take the strict
611 * types, you can specify one yourself.
612 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700613 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700615#define min_t(type, x, y) ({ \
616 type __min1 = (x); \
617 type __min2 = (y); \
618 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700620#define max_t(type, x, y) ({ \
621 type __max1 = (x); \
622 type __max2 = (y); \
623 __max1 > __max2 ? __max1: __max2; })
624
625/**
626 * clamp_t - return a value clamped to a given range using a given type
627 * @type: the type of variable to use
628 * @val: current value
629 * @min: minimum allowable value
630 * @max: maximum allowable value
631 *
632 * This macro does no typechecking and uses temporary variables of type
633 * 'type' to make all the comparisons.
634 */
635#define clamp_t(type, val, min, max) ({ \
636 type __val = (val); \
637 type __min = (min); \
638 type __max = (max); \
639 __val = __val < __min ? __min: __val; \
640 __val > __max ? __max: __val; })
641
642/**
643 * clamp_val - return a value clamped to a given range using val's type
644 * @val: current value
645 * @min: minimum allowable value
646 * @max: maximum allowable value
647 *
648 * This macro does no typechecking and uses temporary variables of whatever
649 * type the input argument 'val' is. This is useful when val is an unsigned
650 * type and min and max are literals that will otherwise be assigned a signed
651 * integer type.
652 */
653#define clamp_val(val, min, max) ({ \
654 typeof(val) __val = (val); \
655 typeof(val) __min = (min); \
656 typeof(val) __max = (max); \
657 __val = __val < __min ? __min: __val; \
658 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
Wu Fengguang91f68b72009-01-07 18:09:12 -0800660
661/*
662 * swap - swap value of @a and @b
663 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800664#define swap(a, b) \
665 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800666
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667/**
668 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 * @ptr: the pointer to the member.
670 * @type: the type of the container struct this is embedded in.
671 * @member: the name of the member within the struct.
672 *
673 */
674#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700675 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
676 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
KOSAKI Motohiro903c0c72011-05-24 17:13:16 -0700678#ifdef __CHECKER__
679#define BUILD_BUG_ON_NOT_POWER_OF_2(n)
Dr. David Alan Gilbertca395992011-06-15 15:08:27 -0700680#define BUILD_BUG_ON_ZERO(e) (0)
681#define BUILD_BUG_ON_NULL(e) ((void*)0)
KOSAKI Motohiro903c0c72011-05-24 17:13:16 -0700682#define BUILD_BUG_ON(condition)
David Daney1399ff82012-01-10 15:07:25 -0800683#define BUILD_BUG() (0)
KOSAKI Motohiro903c0c72011-05-24 17:13:16 -0700684#else /* __CHECKER__ */
685
Roland Dreiercc8ef6e2010-01-15 17:01:22 -0800686/* Force a compilation error if a constant expression is not a power of 2 */
687#define BUILD_BUG_ON_NOT_POWER_OF_2(n) \
688 BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
689
Jan Beulich4552d5d2006-06-26 13:57:28 +0200690/* Force a compilation error if condition is true, but also produce a
691 result (of value 0 and type size_t), so the expression can be used
692 e.g. in a structure initializer (or where-ever else comma expressions
693 aren't permitted). */
Jan Beulich8c87df42009-09-22 16:43:52 -0700694#define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
695#define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
Jan Beulich4552d5d2006-06-26 13:57:28 +0200696
Rusty Russell7ef88ad2011-01-24 14:45:10 -0600697/**
698 * BUILD_BUG_ON - break compile if a condition is true.
Randy Dunlapffbbf2d2011-01-31 09:29:14 -0800699 * @condition: the condition which the compiler should know is false.
Rusty Russell7ef88ad2011-01-24 14:45:10 -0600700 *
701 * If you have some code which relies on certain constants being equal, or
702 * other compile-time-evaluated condition, you should use BUILD_BUG_ON to
703 * detect if someone changes it.
704 *
705 * The implementation uses gcc's reluctance to create a negative array, but
706 * gcc (as of 4.4) only emits that error for obvious cases (eg. not arguments
707 * to inline functions). So as a fallback we use the optimizer; if it can't
708 * prove the condition is false, it will cause a link error on the undefined
709 * "__build_bug_on_failed". This error message can be harder to track down
710 * though, hence the two different methods.
711 */
712#ifndef __OPTIMIZE__
713#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
714#else
715extern int __build_bug_on_failed;
716#define BUILD_BUG_ON(condition) \
717 do { \
718 ((void)sizeof(char[1 - 2*!!(condition)])); \
719 if (condition) __build_bug_on_failed = 1; \
720 } while(0)
721#endif
David Daney1399ff82012-01-10 15:07:25 -0800722
723/**
724 * BUILD_BUG - break compile if used.
725 *
726 * If you have some code that you expect the compiler to eliminate at
727 * build time, you should use BUILD_BUG to detect if it is
728 * unexpectedly used.
729 */
730#define BUILD_BUG() \
731 do { \
732 extern void __build_bug_failed(void) \
733 __linktime_error("BUILD_BUG failed"); \
734 __build_bug_failed(); \
735 } while (0)
736
KOSAKI Motohiro903c0c72011-05-24 17:13:16 -0700737#endif /* __CHECKER__ */
Rusty Russell7ef88ad2011-01-24 14:45:10 -0600738
Arnaud Lacombeb9d4f422011-07-25 17:13:03 -0700739/* Trap pasters of __FUNCTION__ at compile-time */
740#define __FUNCTION__ (__func__)
741
742/* This helps us to avoid #ifdef CONFIG_NUMA */
743#ifdef CONFIG_NUMA
744#define NUMA_BUILD 1
745#else
746#define NUMA_BUILD 0
747#endif
748
749/* This helps us avoid #ifdef CONFIG_COMPACTION */
750#ifdef CONFIG_COMPACTION
751#define COMPACTION_BUILD 1
752#else
753#define COMPACTION_BUILD 0
754#endif
755
756/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
757#ifdef CONFIG_FTRACE_MCOUNT_RECORD
758# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
759#endif
WANG Cong9d00f922011-07-25 17:13:02 -0700760
761struct sysinfo;
762extern int do_sysinfo(struct sysinfo *info);
763
764#endif /* __KERNEL__ */
765
766#define SI_LOAD_SHIFT 16
767struct sysinfo {
768 long uptime; /* Seconds since boot */
769 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
770 unsigned long totalram; /* Total usable main memory size */
771 unsigned long freeram; /* Available memory size */
772 unsigned long sharedram; /* Amount of shared memory */
773 unsigned long bufferram; /* Memory used by buffers */
774 unsigned long totalswap; /* Total swap space size */
775 unsigned long freeswap; /* swap space still available */
776 unsigned short procs; /* Number of current processes */
777 unsigned short pad; /* explicit padding for m68k */
778 unsigned long totalhigh; /* Total high memory size */
779 unsigned long freehigh; /* Available high memory size */
780 unsigned int mem_unit; /* Memory unit size in bytes */
781 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
782};
783
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784#endif