blob: 2451f1f7a1d969f29bb2a3137c846566bfaf614a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_KERNEL_H
2#define _LINUX_KERNEL_H
3
H. Peter Anvind8e5dde2012-02-06 16:36:48 -08004#include <linux/sysinfo.h>
5
Linus Torvalds1da177e2005-04-16 15:20:36 -07006/*
7 * 'kernel.h' contains some often-used function prototypes etc
8 */
Alexey Dobriyana79ff732010-04-13 11:21:46 +02009#define __ALIGN_KERNEL(x, a) __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
10#define __ALIGN_KERNEL_MASK(x, mask) (((x) + (mask)) & ~(mask))
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
12#ifdef __KERNEL__
13
14#include <stdarg.h>
15#include <linux/linkage.h>
16#include <linux/stddef.h>
17#include <linux/types.h>
18#include <linux/compiler.h>
19#include <linux/bitops.h>
David Howellsf0d1b0b2006-12-08 02:37:49 -080020#include <linux/log2.h>
Andrew Mortone0deaff42008-07-25 01:45:24 -070021#include <linux/typecheck.h>
Linus Torvalds968ab182010-11-15 13:37:37 -080022#include <linux/printk.h>
Jason Barone9d376f2009-02-05 11:51:38 -050023#include <linux/dynamic_debug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <asm/byteorder.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
Alexey Dobriyan4be929b2010-05-24 14:33:03 -070026#define USHRT_MAX ((u16)(~0U))
27#define SHRT_MAX ((s16)(USHRT_MAX>>1))
28#define SHRT_MIN ((s16)(-SHRT_MAX - 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#define INT_MAX ((int)(~0U>>1))
30#define INT_MIN (-INT_MAX - 1)
31#define UINT_MAX (~0U)
32#define LONG_MAX ((long)(~0UL>>1))
33#define LONG_MIN (-LONG_MAX - 1)
34#define ULONG_MAX (~0UL)
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -070035#define LLONG_MAX ((long long)(~0ULL>>1))
36#define LLONG_MIN (-LLONG_MAX - 1)
37#define ULLONG_MAX (~0ULL)
Xi Wanga3860c12012-05-31 16:26:04 -070038#define SIZE_MAX (~(size_t)0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40#define STACK_MAGIC 0xdeadbeef
41
David S. Miller44696902012-05-23 20:12:50 -070042#define REPEAT_BYTE(x) ((~0ul / 0xff) * (x))
43
Alexey Dobriyana79ff732010-04-13 11:21:46 +020044#define ALIGN(x, a) __ALIGN_KERNEL((x), (a))
Alexey Dobriyan9f93ff52010-04-13 14:09:15 +020045#define __ALIGN_MASK(x, mask) __ALIGN_KERNEL_MASK((x), (mask))
Matthew Wilcoxa83308e2007-09-11 15:23:47 -070046#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
Herbert Xuf10db622008-02-06 01:37:05 -080047#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
Linus Torvalds2ea58142006-11-26 19:05:22 -080048
Rusty Russellc5e631cf2007-05-06 14:51:05 -070049#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
50
Yinghai Lu9b3be9f2010-02-10 01:20:29 -080051/*
52 * This looks more complex than it should be. But we need to
53 * get the type for the ~ right in round_down (it needs to be
54 * as wide as the result!), and we want to evaluate the macro
55 * arguments just once each.
56 */
57#define __round_mask(x, y) ((__typeof__(x))((y)-1))
58#define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
59#define round_down(x, y) ((x) & ~__round_mask(x, y))
60
Jan Beulich4552d5d2006-06-26 13:57:28 +020061#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
Steven Whitehouse930631e2006-09-25 23:32:40 -070062#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
Nicholas Bellinger36a26c62011-07-26 00:35:26 -070063#define DIV_ROUND_UP_ULL(ll,d) \
64 ({ unsigned long long _tmp = (ll)+(d)-1; do_div(_tmp, d); _tmp; })
65
66#if BITS_PER_LONG == 32
67# define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP_ULL(ll, d)
68#else
69# define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP(ll,d)
70#endif
James Morris074e61e2010-11-10 09:01:31 +110071
72/* The `const' in roundup() prevents gcc-3.3 from calling __divdi3 */
Eric Parisb28efd52010-10-13 17:50:08 -040073#define roundup(x, y) ( \
74{ \
Tetsuo Handa6070bf32010-11-08 11:20:49 +090075 const typeof(y) __y = y; \
Eric Parisb28efd52010-10-13 17:50:08 -040076 (((x) + (__y - 1)) / __y) * __y; \
77} \
78)
Eric Paris686a0f32010-10-13 17:50:02 -040079#define rounddown(x, y) ( \
80{ \
81 typeof(x) __x = (x); \
82 __x - (__x % (y)); \
83} \
84)
Guenter Roeckb6d86d32012-08-24 17:25:01 -070085
86/*
87 * Divide positive or negative dividend by positive divisor and round
88 * to closest integer. Result is undefined for negative divisors.
89 */
Darrick J. Wong9fe06082009-01-06 14:40:51 -080090#define DIV_ROUND_CLOSEST(x, divisor)( \
91{ \
Guenter Roeckb6d86d32012-08-24 17:25:01 -070092 typeof(x) __x = x; \
93 typeof(divisor) __d = divisor; \
Guenter Roeck263a5232012-09-18 20:42:31 -070094 (((typeof(x))-1) > 0 || (__x) > 0) ? \
Guenter Roeckb6d86d32012-08-24 17:25:01 -070095 (((__x) + ((__d) / 2)) / (__d)) : \
96 (((__x) - ((__d) / 2)) / (__d)); \
Darrick J. Wong9fe06082009-01-06 14:40:51 -080097} \
98)
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Salman Qazi9993bc632012-03-09 16:41:01 -0800100/*
101 * Multiplies an integer by a fraction, while avoiding unnecessary
102 * overflow or loss of precision.
103 */
104#define mult_frac(x, numer, denom)( \
105{ \
106 typeof(x) quot = (x) / (denom); \
107 typeof(x) rem = (x) % (denom); \
108 (quot * (numer)) + ((rem * (numer)) / (denom)); \
109} \
110)
111
112
Eduard - Gabriel Munteanuca31e142008-07-05 12:14:23 +0300113#define _RET_IP_ (unsigned long)__builtin_return_address(0)
114#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
115
Bartlomiej Zolnierkiewicz90c699a2009-06-19 08:08:50 +0200116#ifdef CONFIG_LBDAF
Jens Axboe2da96ac2007-10-12 12:40:38 +0200117# include <asm/div64.h>
118# define sector_div(a, b) do_div(a, b)
119#else
120# define sector_div(n, b)( \
121{ \
122 int _res; \
123 _res = (n) % (b); \
124 (n) /= (b); \
125 _res; \
126} \
127)
128#endif
129
Andrew Morton218e1802007-05-10 03:15:18 -0700130/**
131 * upper_32_bits - return bits 32-63 of a number
132 * @n: the number we're accessing
133 *
134 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
135 * the "right shift count >= width of type" warning when that quantity is
136 * 32-bits.
137 */
138#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
139
Joerg Roedel204b8852008-07-29 22:33:42 -0700140/**
141 * lower_32_bits - return bits 0-31 of a number
142 * @n: the number we're accessing
143 */
144#define lower_32_bits(n) ((u32)(n))
145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -0800147struct pt_regs;
148struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
Uwe Kleine-König070cb062008-08-12 15:08:59 -0700150#ifdef CONFIG_PREEMPT_VOLUNTARY
151extern int _cond_resched(void);
152# define might_resched() _cond_resched()
153#else
154# define might_resched() do { } while (0)
155#endif
156
Frederic Weisbeckerd902db12011-06-08 19:31:56 +0200157#ifdef CONFIG_DEBUG_ATOMIC_SLEEP
Simon Kagstromd8948372009-12-23 11:08:18 +0100158 void __might_sleep(const char *file, int line, int preempt_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159/**
160 * might_sleep - annotation for functions that can sleep
161 *
162 * this macro will print a stack trace if it is executed in an atomic
163 * context (spinlock, irq-handler, ...).
164 *
165 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100166 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 * supposed to.
168 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700169# define might_sleep() \
Frederic Weisbeckere4aafea2009-07-16 15:44:29 +0200170 do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700171#else
Simon Kagstromd8948372009-12-23 11:08:18 +0100172 static inline void __might_sleep(const char *file, int line,
173 int preempt_offset) { }
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700174# define might_sleep() do { might_resched(); } while (0)
175#endif
176
Hua Zhong368a5fa2006-06-23 02:05:42 -0700177#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700178
Andrew Morton71a90482011-01-12 16:59:35 -0800179/*
180 * abs() handles unsigned and signed longs, ints, shorts and chars. For all
181 * input types abs() returns a signed long.
182 * abs() should not be used for 64-bit types (s64, u64, long long) - use abs64()
183 * for those.
184 */
185#define abs(x) ({ \
186 long ret; \
187 if (sizeof(x) == sizeof(long)) { \
188 long __x = (x); \
189 ret = (__x < 0) ? -__x : __x; \
190 } else { \
191 int __x = (x); \
192 ret = (__x < 0) ? -__x : __x; \
193 } \
194 ret; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 })
196
Brian Behlendorf658716d2010-10-26 14:23:10 -0700197#define abs64(x) ({ \
198 s64 __x = (x); \
199 (__x < 0) ? -__x : __x; \
200 })
201
Nick Piggin3ee1afa2008-09-10 13:37:17 +0200202#ifdef CONFIG_PROVE_LOCKING
203void might_fault(void);
204#else
205static inline void might_fault(void)
206{
207 might_sleep();
208}
209#endif
210
Alan Sterne041c682006-03-27 01:16:30 -0800211extern struct atomic_notifier_head panic_notifier_list;
TAMUKI Shoichic7ff0d92010-08-10 18:03:28 -0700212extern long (*panic_blink)(int state);
Joe Perches9402c952012-01-12 17:17:17 -0800213__printf(1, 2)
Joe Perches4da47852012-01-12 17:17:13 -0800214void panic(const char *fmt, ...)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800215 __noreturn __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800216extern void oops_enter(void);
217extern void oops_exit(void);
Anton Blanchard863a6042010-08-10 18:03:30 -0700218void print_oops_end_marker(void);
Andrew Mortondd287792006-03-23 03:00:57 -0800219extern int oops_may_print(void);
Joe Perches9402c952012-01-12 17:17:17 -0800220void do_exit(long error_code)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800221 __noreturn;
Joe Perches9402c952012-01-12 17:17:17 -0800222void complete_and_exit(struct completion *, long)
Joe Perchesff2d8b12012-01-12 17:17:21 -0800223 __noreturn;
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700224
225/* Internal, do not use. */
226int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
227int __must_check _kstrtol(const char *s, unsigned int base, long *res);
228
229int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
230int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
231static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
232{
233 /*
234 * We want to shortcut function call, but
235 * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
236 */
237 if (sizeof(unsigned long) == sizeof(unsigned long long) &&
238 __alignof__(unsigned long) == __alignof__(unsigned long long))
239 return kstrtoull(s, base, (unsigned long long *)res);
240 else
241 return _kstrtoul(s, base, res);
242}
243
244static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
245{
246 /*
247 * We want to shortcut function call, but
248 * __builtin_types_compatible_p(long, long long) = 0.
249 */
250 if (sizeof(long) == sizeof(long long) &&
251 __alignof__(long) == __alignof__(long long))
252 return kstrtoll(s, base, (long long *)res);
253 else
254 return _kstrtol(s, base, res);
255}
256
257int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
258int __must_check kstrtoint(const char *s, unsigned int base, int *res);
259
260static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
261{
262 return kstrtoull(s, base, res);
263}
264
265static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
266{
267 return kstrtoll(s, base, res);
268}
269
270static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
271{
272 return kstrtouint(s, base, res);
273}
274
275static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
276{
277 return kstrtoint(s, base, res);
278}
279
280int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
281int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
282int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
283int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);
284
Alexey Dobriyanc196e322011-05-24 17:13:31 -0700285int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
286int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
287int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
288int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
289int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
290int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
291int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
292int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
293int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
294int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);
295
296static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
297{
298 return kstrtoull_from_user(s, count, base, res);
299}
300
301static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
302{
303 return kstrtoll_from_user(s, count, base, res);
304}
305
306static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
307{
308 return kstrtouint_from_user(s, count, base, res);
309}
310
311static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
312{
313 return kstrtoint_from_user(s, count, base, res);
314}
315
Joe Perches67d0a072011-10-31 17:13:10 -0700316/* Obsolete, do not use. Use kstrto<foo> instead */
317
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318extern unsigned long simple_strtoul(const char *,char **,unsigned int);
319extern long simple_strtol(const char *,char **,unsigned int);
320extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
321extern long long simple_strtoll(const char *,char **,unsigned int);
Alexey Dobriyan33ee3b22011-03-22 16:34:40 -0700322#define strict_strtoul kstrtoul
323#define strict_strtol kstrtol
324#define strict_strtoull kstrtoull
325#define strict_strtoll kstrtoll
326
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700327extern int num_to_str(char *buf, int size, unsigned long long num);
328
Joe Perches67d0a072011-10-31 17:13:10 -0700329/* lib/printf utilities */
330
Joe Perchesb9075fa2011-10-31 17:11:33 -0700331extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
332extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
333extern __printf(3, 4)
334int snprintf(char *buf, size_t size, const char *fmt, ...);
335extern __printf(3, 0)
336int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
337extern __printf(3, 4)
338int scnprintf(char *buf, size_t size, const char *fmt, ...);
339extern __printf(3, 0)
340int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
341extern __printf(2, 3)
342char *kasprintf(gfp_t gfp, const char *fmt, ...);
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700343extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
Joe Perches6061d942012-03-23 15:02:16 -0700345extern __scanf(2, 3)
346int sscanf(const char *, const char *, ...);
347extern __scanf(2, 0)
348int vsscanf(const char *, const char *, va_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
350extern int get_option(char **str, int *pint);
351extern char *get_options(const char *str, int nints, int *ints);
Jeremy Fitzhardinged974ae32008-07-24 16:27:46 -0700352extern unsigned long long memparse(const char *ptr, char **retptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
Trent Piepho5e376612006-05-15 09:44:06 -0700354extern int core_kernel_text(unsigned long addr);
Steven Rostedtcdbe61b2011-05-05 21:14:55 -0400355extern int core_kernel_data(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356extern int __kernel_text_address(unsigned long addr);
357extern int kernel_text_address(unsigned long addr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700358extern int func_ptr_is_kernel_text(void *ptr);
Arjan van de Venab7476c2008-08-15 15:29:38 -0700359
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800360struct pid;
361extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363unsigned long int_sqrt(unsigned long);
364
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800366extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700368extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200370extern int panic_on_unrecovered_nmi;
Kurt Garloff5211a242009-06-24 14:32:11 -0700371extern int panic_on_io_nmi;
Mitsuo Hayasaka55af7792011-11-29 15:08:36 +0900372extern int sysctl_panic_on_stackoverflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373extern const char *print_tainted(void);
Andi Kleen25ddbb12008-10-15 22:01:41 -0700374extern void add_taint(unsigned flag);
375extern int test_taint(unsigned flag);
376extern unsigned long get_taint(void);
David Howellsb920de12008-02-08 04:19:31 -0800377extern int root_mountflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
Tejun Heo2ce802f2011-01-20 12:06:35 +0100379extern bool early_boot_irqs_disabled;
380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381/* Values used for system_state */
382extern enum system_states {
383 SYSTEM_BOOTING,
384 SYSTEM_RUNNING,
385 SYSTEM_HALT,
386 SYSTEM_POWER_OFF,
387 SYSTEM_RESTART,
388} system_state;
389
Andi Kleen25ddbb12008-10-15 22:01:41 -0700390#define TAINT_PROPRIETARY_MODULE 0
391#define TAINT_FORCED_MODULE 1
392#define TAINT_UNSAFE_SMP 2
393#define TAINT_FORCED_RMMOD 3
394#define TAINT_MACHINE_CHECK 4
395#define TAINT_BAD_PAGE 5
396#define TAINT_USER 6
397#define TAINT_DIE 7
398#define TAINT_OVERRIDDEN_ACPI_TABLE 8
399#define TAINT_WARN 9
Linus Torvalds26e9a392008-10-17 09:50:12 -0700400#define TAINT_CRAP 10
Ben Hutchings92946bc2010-04-03 19:36:42 +0100401#define TAINT_FIRMWARE_WORKAROUND 11
Ben Hutchings2449b8b2011-10-24 15:12:28 +0200402#define TAINT_OOT_MODULE 12
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
Harvey Harrison3fc95772008-05-14 16:05:49 -0700404extern const char hex_asc[];
405#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
406#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
407
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700408static inline char *hex_byte_pack(char *buf, u8 byte)
Harvey Harrison3fc95772008-05-14 16:05:49 -0700409{
410 *buf++ = hex_asc_hi(byte);
411 *buf++ = hex_asc_lo(byte);
412 return buf;
413}
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700414
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700415static inline char * __deprecated pack_hex_byte(char *buf, u8 byte)
416{
417 return hex_byte_pack(buf, byte);
418}
419
Andy Shevchenko903788892010-05-24 14:33:23 -0700420extern int hex_to_bin(char ch);
Mimi Zoharb7804982011-09-20 11:23:49 -0400421extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
Andy Shevchenko903788892010-05-24 14:33:23 -0700422
Joe Perches8a64f332009-12-14 18:00:25 -0800423/*
Ingo Molnar526211b2009-03-05 10:28:45 +0100424 * General tracing related utility functions - trace_printk(),
Steven Rostedt2002c252009-03-05 10:35:56 -0500425 * tracing_on/tracing_off and tracing_start()/tracing_stop
426 *
427 * Use tracing_on/tracing_off when you want to quickly turn on or off
428 * tracing. It simply enables or disables the recording of the trace events.
GeunSik Lim156f5a72009-06-02 15:01:37 +0900429 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
Steven Rostedt2002c252009-03-05 10:35:56 -0500430 * file, which gives a means for the kernel and userspace to interact.
431 * Place a tracing_off() in the kernel where you want tracing to end.
432 * From user space, examine the trace, and then echo 1 > tracing_on
433 * to continue tracing.
434 *
435 * tracing_stop/tracing_start has slightly more overhead. It is used
436 * by things like suspend to ram where disabling the recording of the
437 * trace is not enough, but tracing must actually stop because things
438 * like calling smp_processor_id() may crash the system.
439 *
440 * Most likely, you want to use tracing_on/tracing_off.
Ingo Molnar526211b2009-03-05 10:28:45 +0100441 */
Steven Rostedt2002c252009-03-05 10:35:56 -0500442#ifdef CONFIG_RING_BUFFER
Steven Rostedt2002c252009-03-05 10:35:56 -0500443/* trace_off_permanent stops recording with no way to bring it back */
444void tracing_off_permanent(void);
Steven Rostedt2002c252009-03-05 10:35:56 -0500445#else
Steven Rostedt2002c252009-03-05 10:35:56 -0500446static inline void tracing_off_permanent(void) { }
Steven Rostedt2002c252009-03-05 10:35:56 -0500447#endif
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200448
449enum ftrace_dump_mode {
450 DUMP_NONE,
451 DUMP_ALL,
452 DUMP_ORIG,
453};
454
Ingo Molnar526211b2009-03-05 10:28:45 +0100455#ifdef CONFIG_TRACING
Steven Rostedt93d68e52012-03-20 12:28:29 -0400456void tracing_on(void);
457void tracing_off(void);
458int tracing_is_on(void);
459
Ingo Molnar526211b2009-03-05 10:28:45 +0100460extern void tracing_start(void);
461extern void tracing_stop(void);
462extern void ftrace_off_permanent(void);
463
Joe Perchesb9075fa2011-10-31 17:11:33 -0700464static inline __printf(1, 2)
465void ____trace_printk_check_format(const char *fmt, ...)
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100466{
467}
468#define __trace_printk_check_format(fmt, args...) \
469do { \
470 if (0) \
471 ____trace_printk_check_format(fmt, ##args); \
472} while (0)
473
Ingo Molnar526211b2009-03-05 10:28:45 +0100474/**
475 * trace_printk - printf formatting in the ftrace buffer
476 * @fmt: the printf format for printing
477 *
478 * Note: __trace_printk is an internal function for trace_printk and
479 * the @ip is passed in via the trace_printk macro.
480 *
481 * This function allows a kernel developer to debug fast path sections
482 * that printk is not appropriate for. By scattering in various
483 * printk like tracing in the code, a developer can quickly see
484 * where problems are occurring.
485 *
486 * This is intended as a debugging tool for the developer only.
487 * Please refrain from leaving trace_printks scattered around in
488 * your code.
489 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100490
491#define trace_printk(fmt, args...) \
492do { \
Steven Rostedt07d777f2011-09-22 14:01:55 -0400493 static const char *trace_printk_fmt \
494 __attribute__((section("__trace_printk_fmt"))) = \
495 __builtin_constant_p(fmt) ? fmt : NULL; \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100496 \
Steven Rostedt07d777f2011-09-22 14:01:55 -0400497 __trace_printk_check_format(fmt, ##args); \
498 \
499 if (__builtin_constant_p(fmt)) \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100500 __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
Steven Rostedt07d777f2011-09-22 14:01:55 -0400501 else \
502 __trace_printk(_THIS_IP_, fmt, ##args); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100503} while (0)
504
Joe Perchesb9075fa2011-10-31 17:11:33 -0700505extern __printf(2, 3)
506int __trace_bprintk(unsigned long ip, const char *fmt, ...);
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100507
Joe Perchesb9075fa2011-10-31 17:11:33 -0700508extern __printf(2, 3)
509int __trace_printk(unsigned long ip, const char *fmt, ...);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100510
Steven Rostedt03889382009-12-11 09:48:22 -0500511extern void trace_dump_stack(void);
512
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100513/*
514 * The double __builtin_constant_p is because gcc will give us an error
515 * if we try to allocate the static variable to fmt if it is not a
516 * constant. Even with the outer if statement.
517 */
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100518#define ftrace_vprintk(fmt, vargs) \
519do { \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100520 if (__builtin_constant_p(fmt)) { \
521 static const char *trace_printk_fmt \
522 __attribute__((section("__trace_printk_fmt"))) = \
523 __builtin_constant_p(fmt) ? fmt : NULL; \
Ingo Molnar7bffc232009-03-09 10:11:36 +0100524 \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100525 __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
526 } else \
527 __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100528} while (0)
529
Ingo Molnar526211b2009-03-05 10:28:45 +0100530extern int
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100531__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
532
533extern int
Ingo Molnar526211b2009-03-05 10:28:45 +0100534__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100535
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200536extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
Ingo Molnar526211b2009-03-05 10:28:45 +0100537#else
Joe Perchesb9075fa2011-10-31 17:11:33 -0700538static inline __printf(1, 2)
539int trace_printk(const char *fmt, ...);
Ingo Molnar526211b2009-03-05 10:28:45 +0100540
541static inline void tracing_start(void) { }
542static inline void tracing_stop(void) { }
543static inline void ftrace_off_permanent(void) { }
Steven Rostedte36c5452009-12-14 15:58:33 -0500544static inline void trace_dump_stack(void) { }
Steven Rostedt93d68e52012-03-20 12:28:29 -0400545
546static inline void tracing_on(void) { }
547static inline void tracing_off(void) { }
548static inline int tracing_is_on(void) { return 0; }
549
Ingo Molnar526211b2009-03-05 10:28:45 +0100550static inline int
551trace_printk(const char *fmt, ...)
552{
553 return 0;
554}
555static inline int
556ftrace_vprintk(const char *fmt, va_list ap)
557{
558 return 0;
559}
Frederic Weisbeckercecbca92010-04-18 19:08:41 +0200560static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100561#endif /* CONFIG_TRACING */
Ingo Molnar526211b2009-03-05 10:28:45 +0100562
563/*
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700564 * min()/max()/clamp() macros that also do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 * strict type-checking.. See the
566 * "unnecessary" pointer comparison.
567 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700568#define min(x, y) ({ \
569 typeof(x) _min1 = (x); \
570 typeof(y) _min2 = (y); \
571 (void) (&_min1 == &_min2); \
572 _min1 < _min2 ? _min1 : _min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700574#define max(x, y) ({ \
575 typeof(x) _max1 = (x); \
576 typeof(y) _max2 = (y); \
577 (void) (&_max1 == &_max2); \
578 _max1 > _max2 ? _max1 : _max2; })
579
Hagen Paul Pfeiferf27c85c2010-10-26 14:22:21 -0700580#define min3(x, y, z) ({ \
581 typeof(x) _min1 = (x); \
582 typeof(y) _min2 = (y); \
583 typeof(z) _min3 = (z); \
584 (void) (&_min1 == &_min2); \
585 (void) (&_min1 == &_min3); \
586 _min1 < _min2 ? (_min1 < _min3 ? _min1 : _min3) : \
587 (_min2 < _min3 ? _min2 : _min3); })
588
589#define max3(x, y, z) ({ \
590 typeof(x) _max1 = (x); \
591 typeof(y) _max2 = (y); \
592 typeof(z) _max3 = (z); \
593 (void) (&_max1 == &_max2); \
594 (void) (&_max1 == &_max3); \
595 _max1 > _max2 ? (_max1 > _max3 ? _max1 : _max3) : \
596 (_max2 > _max3 ? _max2 : _max3); })
597
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700598/**
Martin K. Petersenc8bf1332010-09-10 20:07:38 +0200599 * min_not_zero - return the minimum that is _not_ zero, unless both are zero
600 * @x: value1
601 * @y: value2
602 */
603#define min_not_zero(x, y) ({ \
604 typeof(x) __x = (x); \
605 typeof(y) __y = (y); \
606 __x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
607
608/**
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700609 * clamp - return a value clamped to a given range with strict typechecking
610 * @val: current value
611 * @min: minimum allowable value
612 * @max: maximum allowable value
613 *
614 * This macro does strict typechecking of min/max to make sure they are of the
615 * same type as val. See the unnecessary pointer comparisons.
616 */
617#define clamp(val, min, max) ({ \
618 typeof(val) __val = (val); \
619 typeof(min) __min = (min); \
620 typeof(max) __max = (max); \
621 (void) (&__val == &__min); \
622 (void) (&__val == &__max); \
623 __val = __val < __min ? __min: __val; \
624 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
626/*
627 * ..and if you can't take the strict
628 * types, you can specify one yourself.
629 *
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700630 * Or not use min/max/clamp at all, of course.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 */
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700632#define min_t(type, x, y) ({ \
633 type __min1 = (x); \
634 type __min2 = (y); \
635 __min1 < __min2 ? __min1: __min2; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Harvey Harrisonbdf4bba2008-04-30 00:54:55 -0700637#define max_t(type, x, y) ({ \
638 type __max1 = (x); \
639 type __max2 = (y); \
640 __max1 > __max2 ? __max1: __max2; })
641
642/**
643 * clamp_t - return a value clamped to a given range using a given type
644 * @type: the type of variable to use
645 * @val: current value
646 * @min: minimum allowable value
647 * @max: maximum allowable value
648 *
649 * This macro does no typechecking and uses temporary variables of type
650 * 'type' to make all the comparisons.
651 */
652#define clamp_t(type, val, min, max) ({ \
653 type __val = (val); \
654 type __min = (min); \
655 type __max = (max); \
656 __val = __val < __min ? __min: __val; \
657 __val > __max ? __max: __val; })
658
659/**
660 * clamp_val - return a value clamped to a given range using val's type
661 * @val: current value
662 * @min: minimum allowable value
663 * @max: maximum allowable value
664 *
665 * This macro does no typechecking and uses temporary variables of whatever
666 * type the input argument 'val' is. This is useful when val is an unsigned
667 * type and min and max are literals that will otherwise be assigned a signed
668 * integer type.
669 */
670#define clamp_val(val, min, max) ({ \
671 typeof(val) __val = (val); \
672 typeof(val) __min = (min); \
673 typeof(val) __max = (max); \
674 __val = __val < __min ? __min: __val; \
675 __val > __max ? __max: __val; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
Wu Fengguang91f68b72009-01-07 18:09:12 -0800677
678/*
679 * swap - swap value of @a and @b
680 */
Peter Zijlstraac7b9002009-02-04 15:11:59 -0800681#define swap(a, b) \
682 do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
Wu Fengguang91f68b72009-01-07 18:09:12 -0800683
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684/**
685 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 * @ptr: the pointer to the member.
687 * @type: the type of the container struct this is embedded in.
688 * @member: the name of the member within the struct.
689 *
690 */
691#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700692 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
693 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Arnaud Lacombeb9d4f422011-07-25 17:13:03 -0700695/* Trap pasters of __FUNCTION__ at compile-time */
696#define __FUNCTION__ (__func__)
697
698/* This helps us to avoid #ifdef CONFIG_NUMA */
699#ifdef CONFIG_NUMA
700#define NUMA_BUILD 1
701#else
702#define NUMA_BUILD 0
703#endif
704
705/* This helps us avoid #ifdef CONFIG_COMPACTION */
706#ifdef CONFIG_COMPACTION
707#define COMPACTION_BUILD 1
708#else
709#define COMPACTION_BUILD 0
710#endif
711
712/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
713#ifdef CONFIG_FTRACE_MCOUNT_RECORD
714# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
715#endif
WANG Cong9d00f922011-07-25 17:13:02 -0700716
WANG Cong9d00f922011-07-25 17:13:02 -0700717extern int do_sysinfo(struct sysinfo *info);
718
719#endif /* __KERNEL__ */
720
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721#endif