xref: /linux-6.15/include/linux/kernel.h (revision d8e5ddef)
11da177e4SLinus Torvalds #ifndef _LINUX_KERNEL_H
21da177e4SLinus Torvalds #define _LINUX_KERNEL_H
31da177e4SLinus Torvalds 
4*d8e5ddefSH. Peter Anvin #include <linux/sysinfo.h>
5*d8e5ddefSH. Peter Anvin 
61da177e4SLinus Torvalds /*
71da177e4SLinus Torvalds  * 'kernel.h' contains some often-used function prototypes etc
81da177e4SLinus Torvalds  */
9a79ff731SAlexey Dobriyan #define __ALIGN_KERNEL(x, a)		__ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
10a79ff731SAlexey Dobriyan #define __ALIGN_KERNEL_MASK(x, mask)	(((x) + (mask)) & ~(mask))
111da177e4SLinus Torvalds 
121da177e4SLinus Torvalds #ifdef __KERNEL__
131da177e4SLinus Torvalds 
141da177e4SLinus Torvalds #include <stdarg.h>
151da177e4SLinus Torvalds #include <linux/linkage.h>
161da177e4SLinus Torvalds #include <linux/stddef.h>
171da177e4SLinus Torvalds #include <linux/types.h>
181da177e4SLinus Torvalds #include <linux/compiler.h>
191da177e4SLinus Torvalds #include <linux/bitops.h>
20f0d1b0b3SDavid Howells #include <linux/log2.h>
21e0deaff4SAndrew Morton #include <linux/typecheck.h>
22968ab183SLinus Torvalds #include <linux/printk.h>
23e9d376f0SJason Baron #include <linux/dynamic_debug.h>
241da177e4SLinus Torvalds #include <asm/byteorder.h>
251da177e4SLinus Torvalds #include <asm/bug.h>
261da177e4SLinus Torvalds 
274be929beSAlexey Dobriyan #define USHRT_MAX	((u16)(~0U))
284be929beSAlexey Dobriyan #define SHRT_MAX	((s16)(USHRT_MAX>>1))
294be929beSAlexey Dobriyan #define SHRT_MIN	((s16)(-SHRT_MAX - 1))
301da177e4SLinus Torvalds #define INT_MAX		((int)(~0U>>1))
311da177e4SLinus Torvalds #define INT_MIN		(-INT_MAX - 1)
321da177e4SLinus Torvalds #define UINT_MAX	(~0U)
331da177e4SLinus Torvalds #define LONG_MAX	((long)(~0UL>>1))
341da177e4SLinus Torvalds #define LONG_MIN	(-LONG_MAX - 1)
351da177e4SLinus Torvalds #define ULONG_MAX	(~0UL)
36111ebb6eSOGAWA Hirofumi #define LLONG_MAX	((long long)(~0ULL>>1))
37111ebb6eSOGAWA Hirofumi #define LLONG_MIN	(-LLONG_MAX - 1)
38111ebb6eSOGAWA Hirofumi #define ULLONG_MAX	(~0ULL)
391da177e4SLinus Torvalds 
401da177e4SLinus Torvalds #define STACK_MAGIC	0xdeadbeef
411da177e4SLinus Torvalds 
42a79ff731SAlexey Dobriyan #define ALIGN(x, a)		__ALIGN_KERNEL((x), (a))
439f93ff5bSAlexey Dobriyan #define __ALIGN_MASK(x, mask)	__ALIGN_KERNEL_MASK((x), (mask))
44a83308e6SMatthew Wilcox #define PTR_ALIGN(p, a)		((typeof(p))ALIGN((unsigned long)(p), (a)))
45f10db627SHerbert Xu #define IS_ALIGNED(x, a)		(((x) & ((typeof(x))(a) - 1)) == 0)
462ea58144SLinus Torvalds 
47c5e631cfSRusty Russell #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
48c5e631cfSRusty Russell 
499b3be9f9SYinghai Lu /*
509b3be9f9SYinghai Lu  * This looks more complex than it should be. But we need to
519b3be9f9SYinghai Lu  * get the type for the ~ right in round_down (it needs to be
529b3be9f9SYinghai Lu  * as wide as the result!), and we want to evaluate the macro
539b3be9f9SYinghai Lu  * arguments just once each.
549b3be9f9SYinghai Lu  */
559b3be9f9SYinghai Lu #define __round_mask(x, y) ((__typeof__(x))((y)-1))
569b3be9f9SYinghai Lu #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
579b3be9f9SYinghai Lu #define round_down(x, y) ((x) & ~__round_mask(x, y))
589b3be9f9SYinghai Lu 
594552d5dcSJan Beulich #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
60930631edSSteven Whitehouse #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
6136a26c69SNicholas Bellinger #define DIV_ROUND_UP_ULL(ll,d) \
6236a26c69SNicholas Bellinger 	({ unsigned long long _tmp = (ll)+(d)-1; do_div(_tmp, d); _tmp; })
6336a26c69SNicholas Bellinger 
6436a26c69SNicholas Bellinger #if BITS_PER_LONG == 32
6536a26c69SNicholas Bellinger # define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP_ULL(ll, d)
6636a26c69SNicholas Bellinger #else
6736a26c69SNicholas Bellinger # define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP(ll,d)
6836a26c69SNicholas Bellinger #endif
69074e61ecSJames Morris 
70074e61ecSJames Morris /* The `const' in roundup() prevents gcc-3.3 from calling __divdi3 */
71b28efd54SEric Paris #define roundup(x, y) (					\
72b28efd54SEric Paris {							\
736070bf35STetsuo Handa 	const typeof(y) __y = y;			\
74b28efd54SEric Paris 	(((x) + (__y - 1)) / __y) * __y;		\
75b28efd54SEric Paris }							\
76b28efd54SEric Paris )
77686a0f3dSEric Paris #define rounddown(x, y) (				\
78686a0f3dSEric Paris {							\
79686a0f3dSEric Paris 	typeof(x) __x = (x);				\
80686a0f3dSEric Paris 	__x - (__x % (y));				\
81686a0f3dSEric Paris }							\
82686a0f3dSEric Paris )
839fe06081SDarrick J. Wong #define DIV_ROUND_CLOSEST(x, divisor)(			\
849fe06081SDarrick J. Wong {							\
859fe06081SDarrick J. Wong 	typeof(divisor) __divisor = divisor;		\
869fe06081SDarrick J. Wong 	(((x) + ((__divisor) / 2)) / (__divisor));	\
879fe06081SDarrick J. Wong }							\
889fe06081SDarrick J. Wong )
891da177e4SLinus Torvalds 
90ca31e146SEduard - Gabriel Munteanu #define _RET_IP_		(unsigned long)__builtin_return_address(0)
91ca31e146SEduard - Gabriel Munteanu #define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })
92ca31e146SEduard - Gabriel Munteanu 
9390c699a9SBartlomiej Zolnierkiewicz #ifdef CONFIG_LBDAF
942da96acdSJens Axboe # include <asm/div64.h>
952da96acdSJens Axboe # define sector_div(a, b) do_div(a, b)
962da96acdSJens Axboe #else
972da96acdSJens Axboe # define sector_div(n, b)( \
982da96acdSJens Axboe { \
992da96acdSJens Axboe 	int _res; \
1002da96acdSJens Axboe 	_res = (n) % (b); \
1012da96acdSJens Axboe 	(n) /= (b); \
1022da96acdSJens Axboe 	_res; \
1032da96acdSJens Axboe } \
1042da96acdSJens Axboe )
1052da96acdSJens Axboe #endif
1062da96acdSJens Axboe 
107218e180eSAndrew Morton /**
108218e180eSAndrew Morton  * upper_32_bits - return bits 32-63 of a number
109218e180eSAndrew Morton  * @n: the number we're accessing
110218e180eSAndrew Morton  *
111218e180eSAndrew Morton  * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
112218e180eSAndrew Morton  * the "right shift count >= width of type" warning when that quantity is
113218e180eSAndrew Morton  * 32-bits.
114218e180eSAndrew Morton  */
115218e180eSAndrew Morton #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
116218e180eSAndrew Morton 
117204b885eSJoerg Roedel /**
118204b885eSJoerg Roedel  * lower_32_bits - return bits 0-31 of a number
119204b885eSJoerg Roedel  * @n: the number we're accessing
120204b885eSJoerg Roedel  */
121204b885eSJoerg Roedel #define lower_32_bits(n) ((u32)(n))
122204b885eSJoerg Roedel 
1231da177e4SLinus Torvalds struct completion;
124df2e71fbS[email protected] struct pt_regs;
125df2e71fbS[email protected] struct user;
1261da177e4SLinus Torvalds 
127070cb065SUwe Kleine-König #ifdef CONFIG_PREEMPT_VOLUNTARY
128070cb065SUwe Kleine-König extern int _cond_resched(void);
129070cb065SUwe Kleine-König # define might_resched() _cond_resched()
130070cb065SUwe Kleine-König #else
131070cb065SUwe Kleine-König # define might_resched() do { } while (0)
132070cb065SUwe Kleine-König #endif
133070cb065SUwe Kleine-König 
134d902db1eSFrederic Weisbecker #ifdef CONFIG_DEBUG_ATOMIC_SLEEP
135d894837fSSimon Kagstrom   void __might_sleep(const char *file, int line, int preempt_offset);
1361da177e4SLinus Torvalds /**
1371da177e4SLinus Torvalds  * might_sleep - annotation for functions that can sleep
1381da177e4SLinus Torvalds  *
1391da177e4SLinus Torvalds  * this macro will print a stack trace if it is executed in an atomic
1401da177e4SLinus Torvalds  * context (spinlock, irq-handler, ...).
1411da177e4SLinus Torvalds  *
1421da177e4SLinus Torvalds  * This is a useful debugging help to be able to catch problems early and not
143e20ec991SJim Cromie  * be bitten later when the calling function happens to sleep when it is not
1441da177e4SLinus Torvalds  * supposed to.
1451da177e4SLinus Torvalds  */
146f8cbd99bSIngo Molnar # define might_sleep() \
147e4aafea2SFrederic Weisbecker 	do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
148f8cbd99bSIngo Molnar #else
149d894837fSSimon Kagstrom   static inline void __might_sleep(const char *file, int line,
150d894837fSSimon Kagstrom 				   int preempt_offset) { }
151f8cbd99bSIngo Molnar # define might_sleep() do { might_resched(); } while (0)
152f8cbd99bSIngo Molnar #endif
153f8cbd99bSIngo Molnar 
154368a5fa1SHua Zhong #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
155f8cbd99bSIngo Molnar 
15671a90484SAndrew Morton /*
15771a90484SAndrew Morton  * abs() handles unsigned and signed longs, ints, shorts and chars.  For all
15871a90484SAndrew Morton  * input types abs() returns a signed long.
15971a90484SAndrew Morton  * abs() should not be used for 64-bit types (s64, u64, long long) - use abs64()
16071a90484SAndrew Morton  * for those.
16171a90484SAndrew Morton  */
1621da177e4SLinus Torvalds #define abs(x) ({						\
16371a90484SAndrew Morton 		long ret;					\
16471a90484SAndrew Morton 		if (sizeof(x) == sizeof(long)) {		\
165a49c59c0SRolf Eike Beer 			long __x = (x);				\
16671a90484SAndrew Morton 			ret = (__x < 0) ? -__x : __x;		\
16771a90484SAndrew Morton 		} else {					\
16871a90484SAndrew Morton 			int __x = (x);				\
16971a90484SAndrew Morton 			ret = (__x < 0) ? -__x : __x;		\
17071a90484SAndrew Morton 		}						\
17171a90484SAndrew Morton 		ret;						\
1721da177e4SLinus Torvalds 	})
1731da177e4SLinus Torvalds 
174658716d1SBrian Behlendorf #define abs64(x) ({				\
175658716d1SBrian Behlendorf 		s64 __x = (x);			\
176658716d1SBrian Behlendorf 		(__x < 0) ? -__x : __x;		\
177658716d1SBrian Behlendorf 	})
178658716d1SBrian Behlendorf 
1793ee1afa3SNick Piggin #ifdef CONFIG_PROVE_LOCKING
1803ee1afa3SNick Piggin void might_fault(void);
1813ee1afa3SNick Piggin #else
1823ee1afa3SNick Piggin static inline void might_fault(void)
1833ee1afa3SNick Piggin {
1843ee1afa3SNick Piggin 	might_sleep();
1853ee1afa3SNick Piggin }
1863ee1afa3SNick Piggin #endif
1873ee1afa3SNick Piggin 
188e041c683SAlan Stern extern struct atomic_notifier_head panic_notifier_list;
189c7ff0d9cSTAMUKI Shoichi extern long (*panic_blink)(int state);
1909402c95fSJoe Perches __printf(1, 2)
1914da47859SJoe Perches void panic(const char *fmt, ...)
192ff2d8b19SJoe Perches 	__noreturn __cold;
193dd287796SAndrew Morton extern void oops_enter(void);
194dd287796SAndrew Morton extern void oops_exit(void);
195863a6049SAnton Blanchard void print_oops_end_marker(void);
196dd287796SAndrew Morton extern int oops_may_print(void);
1979402c95fSJoe Perches void do_exit(long error_code)
198ff2d8b19SJoe Perches 	__noreturn;
1999402c95fSJoe Perches void complete_and_exit(struct completion *, long)
200ff2d8b19SJoe Perches 	__noreturn;
20133ee3b2eSAlexey Dobriyan 
20233ee3b2eSAlexey Dobriyan /* Internal, do not use. */
20333ee3b2eSAlexey Dobriyan int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
20433ee3b2eSAlexey Dobriyan int __must_check _kstrtol(const char *s, unsigned int base, long *res);
20533ee3b2eSAlexey Dobriyan 
20633ee3b2eSAlexey Dobriyan int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
20733ee3b2eSAlexey Dobriyan int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
20833ee3b2eSAlexey Dobriyan static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
20933ee3b2eSAlexey Dobriyan {
21033ee3b2eSAlexey Dobriyan 	/*
21133ee3b2eSAlexey Dobriyan 	 * We want to shortcut function call, but
21233ee3b2eSAlexey Dobriyan 	 * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
21333ee3b2eSAlexey Dobriyan 	 */
21433ee3b2eSAlexey Dobriyan 	if (sizeof(unsigned long) == sizeof(unsigned long long) &&
21533ee3b2eSAlexey Dobriyan 	    __alignof__(unsigned long) == __alignof__(unsigned long long))
21633ee3b2eSAlexey Dobriyan 		return kstrtoull(s, base, (unsigned long long *)res);
21733ee3b2eSAlexey Dobriyan 	else
21833ee3b2eSAlexey Dobriyan 		return _kstrtoul(s, base, res);
21933ee3b2eSAlexey Dobriyan }
22033ee3b2eSAlexey Dobriyan 
22133ee3b2eSAlexey Dobriyan static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
22233ee3b2eSAlexey Dobriyan {
22333ee3b2eSAlexey Dobriyan 	/*
22433ee3b2eSAlexey Dobriyan 	 * We want to shortcut function call, but
22533ee3b2eSAlexey Dobriyan 	 * __builtin_types_compatible_p(long, long long) = 0.
22633ee3b2eSAlexey Dobriyan 	 */
22733ee3b2eSAlexey Dobriyan 	if (sizeof(long) == sizeof(long long) &&
22833ee3b2eSAlexey Dobriyan 	    __alignof__(long) == __alignof__(long long))
22933ee3b2eSAlexey Dobriyan 		return kstrtoll(s, base, (long long *)res);
23033ee3b2eSAlexey Dobriyan 	else
23133ee3b2eSAlexey Dobriyan 		return _kstrtol(s, base, res);
23233ee3b2eSAlexey Dobriyan }
23333ee3b2eSAlexey Dobriyan 
23433ee3b2eSAlexey Dobriyan int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
23533ee3b2eSAlexey Dobriyan int __must_check kstrtoint(const char *s, unsigned int base, int *res);
23633ee3b2eSAlexey Dobriyan 
23733ee3b2eSAlexey Dobriyan static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
23833ee3b2eSAlexey Dobriyan {
23933ee3b2eSAlexey Dobriyan 	return kstrtoull(s, base, res);
24033ee3b2eSAlexey Dobriyan }
24133ee3b2eSAlexey Dobriyan 
24233ee3b2eSAlexey Dobriyan static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
24333ee3b2eSAlexey Dobriyan {
24433ee3b2eSAlexey Dobriyan 	return kstrtoll(s, base, res);
24533ee3b2eSAlexey Dobriyan }
24633ee3b2eSAlexey Dobriyan 
24733ee3b2eSAlexey Dobriyan static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
24833ee3b2eSAlexey Dobriyan {
24933ee3b2eSAlexey Dobriyan 	return kstrtouint(s, base, res);
25033ee3b2eSAlexey Dobriyan }
25133ee3b2eSAlexey Dobriyan 
25233ee3b2eSAlexey Dobriyan static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
25333ee3b2eSAlexey Dobriyan {
25433ee3b2eSAlexey Dobriyan 	return kstrtoint(s, base, res);
25533ee3b2eSAlexey Dobriyan }
25633ee3b2eSAlexey Dobriyan 
25733ee3b2eSAlexey Dobriyan int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
25833ee3b2eSAlexey Dobriyan int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
25933ee3b2eSAlexey Dobriyan int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
26033ee3b2eSAlexey Dobriyan int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);
26133ee3b2eSAlexey Dobriyan 
262c196e32aSAlexey Dobriyan int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
263c196e32aSAlexey Dobriyan int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
264c196e32aSAlexey Dobriyan int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
265c196e32aSAlexey Dobriyan int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
266c196e32aSAlexey Dobriyan int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
267c196e32aSAlexey Dobriyan int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
268c196e32aSAlexey Dobriyan int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
269c196e32aSAlexey Dobriyan int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
270c196e32aSAlexey Dobriyan int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
271c196e32aSAlexey Dobriyan int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);
272c196e32aSAlexey Dobriyan 
273c196e32aSAlexey Dobriyan static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
274c196e32aSAlexey Dobriyan {
275c196e32aSAlexey Dobriyan 	return kstrtoull_from_user(s, count, base, res);
276c196e32aSAlexey Dobriyan }
277c196e32aSAlexey Dobriyan 
278c196e32aSAlexey Dobriyan static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
279c196e32aSAlexey Dobriyan {
280c196e32aSAlexey Dobriyan 	return kstrtoll_from_user(s, count, base, res);
281c196e32aSAlexey Dobriyan }
282c196e32aSAlexey Dobriyan 
283c196e32aSAlexey Dobriyan static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
284c196e32aSAlexey Dobriyan {
285c196e32aSAlexey Dobriyan 	return kstrtouint_from_user(s, count, base, res);
286c196e32aSAlexey Dobriyan }
287c196e32aSAlexey Dobriyan 
288c196e32aSAlexey Dobriyan static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
289c196e32aSAlexey Dobriyan {
290c196e32aSAlexey Dobriyan 	return kstrtoint_from_user(s, count, base, res);
291c196e32aSAlexey Dobriyan }
292c196e32aSAlexey Dobriyan 
29367d0a075SJoe Perches /* Obsolete, do not use.  Use kstrto<foo> instead */
29467d0a075SJoe Perches 
2951da177e4SLinus Torvalds extern unsigned long simple_strtoul(const char *,char **,unsigned int);
2961da177e4SLinus Torvalds extern long simple_strtol(const char *,char **,unsigned int);
2971da177e4SLinus Torvalds extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
2981da177e4SLinus Torvalds extern long long simple_strtoll(const char *,char **,unsigned int);
29933ee3b2eSAlexey Dobriyan #define strict_strtoul	kstrtoul
30033ee3b2eSAlexey Dobriyan #define strict_strtol	kstrtol
30133ee3b2eSAlexey Dobriyan #define strict_strtoull	kstrtoull
30233ee3b2eSAlexey Dobriyan #define strict_strtoll	kstrtoll
30333ee3b2eSAlexey Dobriyan 
30467d0a075SJoe Perches /* lib/printf utilities */
30567d0a075SJoe Perches 
306b9075fa9SJoe Perches extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
307b9075fa9SJoe Perches extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
308b9075fa9SJoe Perches extern __printf(3, 4)
309b9075fa9SJoe Perches int snprintf(char *buf, size_t size, const char *fmt, ...);
310b9075fa9SJoe Perches extern __printf(3, 0)
311b9075fa9SJoe Perches int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
312b9075fa9SJoe Perches extern __printf(3, 4)
313b9075fa9SJoe Perches int scnprintf(char *buf, size_t size, const char *fmt, ...);
314b9075fa9SJoe Perches extern __printf(3, 0)
315b9075fa9SJoe Perches int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
316b9075fa9SJoe Perches extern __printf(2, 3)
317b9075fa9SJoe Perches char *kasprintf(gfp_t gfp, const char *fmt, ...);
31811443ec7SJeremy Fitzhardinge extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
3191da177e4SLinus Torvalds 
3201da177e4SLinus Torvalds extern int sscanf(const char *, const char *, ...)
3211da177e4SLinus Torvalds 	__attribute__ ((format (scanf, 2, 3)));
3221da177e4SLinus Torvalds extern int vsscanf(const char *, const char *, va_list)
3231da177e4SLinus Torvalds 	__attribute__ ((format (scanf, 2, 0)));
3241da177e4SLinus Torvalds 
3251da177e4SLinus Torvalds extern int get_option(char **str, int *pint);
3261da177e4SLinus Torvalds extern char *get_options(const char *str, int nints, int *ints);
327d974ae37SJeremy Fitzhardinge extern unsigned long long memparse(const char *ptr, char **retptr);
3281da177e4SLinus Torvalds 
3295e376613STrent Piepho extern int core_kernel_text(unsigned long addr);
330cdbe61bfSSteven Rostedt extern int core_kernel_data(unsigned long addr);
3311da177e4SLinus Torvalds extern int __kernel_text_address(unsigned long addr);
3321da177e4SLinus Torvalds extern int kernel_text_address(unsigned long addr);
333ab7476cfSArjan van de Ven extern int func_ptr_is_kernel_text(void *ptr);
334ab7476cfSArjan van de Ven 
33504a2e6a5SEric W. Biederman struct pid;
33604a2e6a5SEric W. Biederman extern struct pid *session_of_pgrp(struct pid *pgrp);
3371da177e4SLinus Torvalds 
3381da177e4SLinus Torvalds unsigned long int_sqrt(unsigned long);
3391da177e4SLinus Torvalds 
3401da177e4SLinus Torvalds extern void bust_spinlocks(int yes);
341e3e8a75dSKirill Korotaev extern void wake_up_klogd(void);
3421da177e4SLinus Torvalds extern int oops_in_progress;		/* If set, an oops, panic(), BUG() or die() is in progress */
343aa727107SAdrian Bunk extern int panic_timeout;
3441da177e4SLinus Torvalds extern int panic_on_oops;
3458da5addaSDon Zickus extern int panic_on_unrecovered_nmi;
3465211a242SKurt Garloff extern int panic_on_io_nmi;
34755af7796SMitsuo Hayasaka extern int sysctl_panic_on_stackoverflow;
3481da177e4SLinus Torvalds extern const char *print_tainted(void);
34925ddbb18SAndi Kleen extern void add_taint(unsigned flag);
35025ddbb18SAndi Kleen extern int test_taint(unsigned flag);
35125ddbb18SAndi Kleen extern unsigned long get_taint(void);
352b920de1bSDavid Howells extern int root_mountflags;
3531da177e4SLinus Torvalds 
3542ce802f6STejun Heo extern bool early_boot_irqs_disabled;
3552ce802f6STejun Heo 
3561da177e4SLinus Torvalds /* Values used for system_state */
3571da177e4SLinus Torvalds extern enum system_states {
3581da177e4SLinus Torvalds 	SYSTEM_BOOTING,
3591da177e4SLinus Torvalds 	SYSTEM_RUNNING,
3601da177e4SLinus Torvalds 	SYSTEM_HALT,
3611da177e4SLinus Torvalds 	SYSTEM_POWER_OFF,
3621da177e4SLinus Torvalds 	SYSTEM_RESTART,
363729b4d4cSAlexey Starikovskiy 	SYSTEM_SUSPEND_DISK,
3641da177e4SLinus Torvalds } system_state;
3651da177e4SLinus Torvalds 
36625ddbb18SAndi Kleen #define TAINT_PROPRIETARY_MODULE	0
36725ddbb18SAndi Kleen #define TAINT_FORCED_MODULE		1
36825ddbb18SAndi Kleen #define TAINT_UNSAFE_SMP		2
36925ddbb18SAndi Kleen #define TAINT_FORCED_RMMOD		3
37025ddbb18SAndi Kleen #define TAINT_MACHINE_CHECK		4
37125ddbb18SAndi Kleen #define TAINT_BAD_PAGE			5
37225ddbb18SAndi Kleen #define TAINT_USER			6
37325ddbb18SAndi Kleen #define TAINT_DIE			7
37425ddbb18SAndi Kleen #define TAINT_OVERRIDDEN_ACPI_TABLE	8
37525ddbb18SAndi Kleen #define TAINT_WARN			9
37626e9a397SLinus Torvalds #define TAINT_CRAP			10
37792946bc7SBen Hutchings #define TAINT_FIRMWARE_WORKAROUND	11
3782449b8baSBen Hutchings #define TAINT_OOT_MODULE		12
3791da177e4SLinus Torvalds 
3803fc95772SHarvey Harrison extern const char hex_asc[];
3813fc95772SHarvey Harrison #define hex_asc_lo(x)	hex_asc[((x) & 0x0f)]
3823fc95772SHarvey Harrison #define hex_asc_hi(x)	hex_asc[((x) & 0xf0) >> 4]
3833fc95772SHarvey Harrison 
38455036ba7SAndy Shevchenko static inline char *hex_byte_pack(char *buf, u8 byte)
3853fc95772SHarvey Harrison {
3863fc95772SHarvey Harrison 	*buf++ = hex_asc_hi(byte);
3873fc95772SHarvey Harrison 	*buf++ = hex_asc_lo(byte);
3883fc95772SHarvey Harrison 	return buf;
3893fc95772SHarvey Harrison }
39099eaf3c4SRandy Dunlap 
39155036ba7SAndy Shevchenko static inline char * __deprecated pack_hex_byte(char *buf, u8 byte)
39255036ba7SAndy Shevchenko {
39355036ba7SAndy Shevchenko 	return hex_byte_pack(buf, byte);
39455036ba7SAndy Shevchenko }
39555036ba7SAndy Shevchenko 
39690378889SAndy Shevchenko extern int hex_to_bin(char ch);
397b7804983SMimi Zohar extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
39890378889SAndy Shevchenko 
3998a64f336SJoe Perches /*
400526211bcSIngo Molnar  * General tracing related utility functions - trace_printk(),
4012002c258SSteven Rostedt  * tracing_on/tracing_off and tracing_start()/tracing_stop
4022002c258SSteven Rostedt  *
4032002c258SSteven Rostedt  * Use tracing_on/tracing_off when you want to quickly turn on or off
4042002c258SSteven Rostedt  * tracing. It simply enables or disables the recording of the trace events.
405156f5a78SGeunSik Lim  * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
4062002c258SSteven Rostedt  * file, which gives a means for the kernel and userspace to interact.
4072002c258SSteven Rostedt  * Place a tracing_off() in the kernel where you want tracing to end.
4082002c258SSteven Rostedt  * From user space, examine the trace, and then echo 1 > tracing_on
4092002c258SSteven Rostedt  * to continue tracing.
4102002c258SSteven Rostedt  *
4112002c258SSteven Rostedt  * tracing_stop/tracing_start has slightly more overhead. It is used
4122002c258SSteven Rostedt  * by things like suspend to ram where disabling the recording of the
4132002c258SSteven Rostedt  * trace is not enough, but tracing must actually stop because things
4142002c258SSteven Rostedt  * like calling smp_processor_id() may crash the system.
4152002c258SSteven Rostedt  *
4162002c258SSteven Rostedt  * Most likely, you want to use tracing_on/tracing_off.
417526211bcSIngo Molnar  */
4182002c258SSteven Rostedt #ifdef CONFIG_RING_BUFFER
4192002c258SSteven Rostedt void tracing_on(void);
4202002c258SSteven Rostedt void tracing_off(void);
4212002c258SSteven Rostedt /* trace_off_permanent stops recording with no way to bring it back */
4222002c258SSteven Rostedt void tracing_off_permanent(void);
4232002c258SSteven Rostedt int tracing_is_on(void);
4242002c258SSteven Rostedt #else
4252002c258SSteven Rostedt static inline void tracing_on(void) { }
4262002c258SSteven Rostedt static inline void tracing_off(void) { }
4272002c258SSteven Rostedt static inline void tracing_off_permanent(void) { }
4282002c258SSteven Rostedt static inline int tracing_is_on(void) { return 0; }
4292002c258SSteven Rostedt #endif
430cecbca96SFrederic Weisbecker 
431cecbca96SFrederic Weisbecker enum ftrace_dump_mode {
432cecbca96SFrederic Weisbecker 	DUMP_NONE,
433cecbca96SFrederic Weisbecker 	DUMP_ALL,
434cecbca96SFrederic Weisbecker 	DUMP_ORIG,
435cecbca96SFrederic Weisbecker };
436cecbca96SFrederic Weisbecker 
437526211bcSIngo Molnar #ifdef CONFIG_TRACING
438526211bcSIngo Molnar extern void tracing_start(void);
439526211bcSIngo Molnar extern void tracing_stop(void);
440526211bcSIngo Molnar extern void ftrace_off_permanent(void);
441526211bcSIngo Molnar 
442b9075fa9SJoe Perches static inline __printf(1, 2)
443b9075fa9SJoe Perches void ____trace_printk_check_format(const char *fmt, ...)
444769b0441SFrederic Weisbecker {
445769b0441SFrederic Weisbecker }
446769b0441SFrederic Weisbecker #define __trace_printk_check_format(fmt, args...)			\
447769b0441SFrederic Weisbecker do {									\
448769b0441SFrederic Weisbecker 	if (0)								\
449769b0441SFrederic Weisbecker 		____trace_printk_check_format(fmt, ##args);		\
450769b0441SFrederic Weisbecker } while (0)
451769b0441SFrederic Weisbecker 
452526211bcSIngo Molnar /**
453526211bcSIngo Molnar  * trace_printk - printf formatting in the ftrace buffer
454526211bcSIngo Molnar  * @fmt: the printf format for printing
455526211bcSIngo Molnar  *
456526211bcSIngo Molnar  * Note: __trace_printk is an internal function for trace_printk and
457526211bcSIngo Molnar  *       the @ip is passed in via the trace_printk macro.
458526211bcSIngo Molnar  *
459526211bcSIngo Molnar  * This function allows a kernel developer to debug fast path sections
460526211bcSIngo Molnar  * that printk is not appropriate for. By scattering in various
461526211bcSIngo Molnar  * printk like tracing in the code, a developer can quickly see
462526211bcSIngo Molnar  * where problems are occurring.
463526211bcSIngo Molnar  *
464526211bcSIngo Molnar  * This is intended as a debugging tool for the developer only.
465526211bcSIngo Molnar  * Please refrain from leaving trace_printks scattered around in
466526211bcSIngo Molnar  * your code.
467526211bcSIngo Molnar  */
468769b0441SFrederic Weisbecker 
469769b0441SFrederic Weisbecker #define trace_printk(fmt, args...)					\
470769b0441SFrederic Weisbecker do {									\
471769b0441SFrederic Weisbecker 	__trace_printk_check_format(fmt, ##args);			\
47248ead020SFrederic Weisbecker 	if (__builtin_constant_p(fmt)) {				\
47348ead020SFrederic Weisbecker 		static const char *trace_printk_fmt			\
47448ead020SFrederic Weisbecker 		  __attribute__((section("__trace_printk_fmt"))) =	\
47548ead020SFrederic Weisbecker 			__builtin_constant_p(fmt) ? fmt : NULL;		\
47648ead020SFrederic Weisbecker 									\
47748ead020SFrederic Weisbecker 		__trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args);	\
47848ead020SFrederic Weisbecker 	} else								\
47948ead020SFrederic Weisbecker 		__trace_printk(_THIS_IP_, fmt, ##args);		\
480769b0441SFrederic Weisbecker } while (0)
481769b0441SFrederic Weisbecker 
482b9075fa9SJoe Perches extern __printf(2, 3)
483b9075fa9SJoe Perches int __trace_bprintk(unsigned long ip, const char *fmt, ...);
48448ead020SFrederic Weisbecker 
485b9075fa9SJoe Perches extern __printf(2, 3)
486b9075fa9SJoe Perches int __trace_printk(unsigned long ip, const char *fmt, ...);
487769b0441SFrederic Weisbecker 
48803889384SSteven Rostedt extern void trace_dump_stack(void);
48903889384SSteven Rostedt 
49048ead020SFrederic Weisbecker /*
49148ead020SFrederic Weisbecker  * The double __builtin_constant_p is because gcc will give us an error
49248ead020SFrederic Weisbecker  * if we try to allocate the static variable to fmt if it is not a
49348ead020SFrederic Weisbecker  * constant. Even with the outer if statement.
49448ead020SFrederic Weisbecker  */
495769b0441SFrederic Weisbecker #define ftrace_vprintk(fmt, vargs)					\
496769b0441SFrederic Weisbecker do {									\
49748ead020SFrederic Weisbecker 	if (__builtin_constant_p(fmt)) {				\
498769b0441SFrederic Weisbecker 		static const char *trace_printk_fmt			\
49948ead020SFrederic Weisbecker 		  __attribute__((section("__trace_printk_fmt"))) =	\
50048ead020SFrederic Weisbecker 			__builtin_constant_p(fmt) ? fmt : NULL;		\
5017bffc23eSIngo Molnar 									\
50248ead020SFrederic Weisbecker 		__ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs);	\
50348ead020SFrederic Weisbecker 	} else								\
50448ead020SFrederic Weisbecker 		__ftrace_vprintk(_THIS_IP_, fmt, vargs);		\
505769b0441SFrederic Weisbecker } while (0)
506769b0441SFrederic Weisbecker 
507526211bcSIngo Molnar extern int
50848ead020SFrederic Weisbecker __ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
50948ead020SFrederic Weisbecker 
51048ead020SFrederic Weisbecker extern int
511526211bcSIngo Molnar __ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
512769b0441SFrederic Weisbecker 
513cecbca96SFrederic Weisbecker extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
514526211bcSIngo Molnar #else
515b9075fa9SJoe Perches static inline __printf(1, 2)
516b9075fa9SJoe Perches int trace_printk(const char *fmt, ...);
517526211bcSIngo Molnar 
518526211bcSIngo Molnar static inline void tracing_start(void) { }
519526211bcSIngo Molnar static inline void tracing_stop(void) { }
520526211bcSIngo Molnar static inline void ftrace_off_permanent(void) { }
521e36c5458SSteven Rostedt static inline void trace_dump_stack(void) { }
522526211bcSIngo Molnar static inline int
523526211bcSIngo Molnar trace_printk(const char *fmt, ...)
524526211bcSIngo Molnar {
525526211bcSIngo Molnar 	return 0;
526526211bcSIngo Molnar }
527526211bcSIngo Molnar static inline int
528526211bcSIngo Molnar ftrace_vprintk(const char *fmt, va_list ap)
529526211bcSIngo Molnar {
530526211bcSIngo Molnar 	return 0;
531526211bcSIngo Molnar }
532cecbca96SFrederic Weisbecker static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
533769b0441SFrederic Weisbecker #endif /* CONFIG_TRACING */
534526211bcSIngo Molnar 
535526211bcSIngo Molnar /*
536bdf4bbaaSHarvey Harrison  * min()/max()/clamp() macros that also do
5371da177e4SLinus Torvalds  * strict type-checking.. See the
5381da177e4SLinus Torvalds  * "unnecessary" pointer comparison.
5391da177e4SLinus Torvalds  */
5401da177e4SLinus Torvalds #define min(x, y) ({				\
541bdf4bbaaSHarvey Harrison 	typeof(x) _min1 = (x);			\
542bdf4bbaaSHarvey Harrison 	typeof(y) _min2 = (y);			\
543bdf4bbaaSHarvey Harrison 	(void) (&_min1 == &_min2);		\
544bdf4bbaaSHarvey Harrison 	_min1 < _min2 ? _min1 : _min2; })
5451da177e4SLinus Torvalds 
5461da177e4SLinus Torvalds #define max(x, y) ({				\
547bdf4bbaaSHarvey Harrison 	typeof(x) _max1 = (x);			\
548bdf4bbaaSHarvey Harrison 	typeof(y) _max2 = (y);			\
549bdf4bbaaSHarvey Harrison 	(void) (&_max1 == &_max2);		\
550bdf4bbaaSHarvey Harrison 	_max1 > _max2 ? _max1 : _max2; })
551bdf4bbaaSHarvey Harrison 
552f27c85c5SHagen Paul Pfeifer #define min3(x, y, z) ({			\
553f27c85c5SHagen Paul Pfeifer 	typeof(x) _min1 = (x);			\
554f27c85c5SHagen Paul Pfeifer 	typeof(y) _min2 = (y);			\
555f27c85c5SHagen Paul Pfeifer 	typeof(z) _min3 = (z);			\
556f27c85c5SHagen Paul Pfeifer 	(void) (&_min1 == &_min2);		\
557f27c85c5SHagen Paul Pfeifer 	(void) (&_min1 == &_min3);		\
558f27c85c5SHagen Paul Pfeifer 	_min1 < _min2 ? (_min1 < _min3 ? _min1 : _min3) : \
559f27c85c5SHagen Paul Pfeifer 		(_min2 < _min3 ? _min2 : _min3); })
560f27c85c5SHagen Paul Pfeifer 
561f27c85c5SHagen Paul Pfeifer #define max3(x, y, z) ({			\
562f27c85c5SHagen Paul Pfeifer 	typeof(x) _max1 = (x);			\
563f27c85c5SHagen Paul Pfeifer 	typeof(y) _max2 = (y);			\
564f27c85c5SHagen Paul Pfeifer 	typeof(z) _max3 = (z);			\
565f27c85c5SHagen Paul Pfeifer 	(void) (&_max1 == &_max2);		\
566f27c85c5SHagen Paul Pfeifer 	(void) (&_max1 == &_max3);		\
567f27c85c5SHagen Paul Pfeifer 	_max1 > _max2 ? (_max1 > _max3 ? _max1 : _max3) : \
568f27c85c5SHagen Paul Pfeifer 		(_max2 > _max3 ? _max2 : _max3); })
569f27c85c5SHagen Paul Pfeifer 
570bdf4bbaaSHarvey Harrison /**
571c8bf1336SMartin K. Petersen  * min_not_zero - return the minimum that is _not_ zero, unless both are zero
572c8bf1336SMartin K. Petersen  * @x: value1
573c8bf1336SMartin K. Petersen  * @y: value2
574c8bf1336SMartin K. Petersen  */
575c8bf1336SMartin K. Petersen #define min_not_zero(x, y) ({			\
576c8bf1336SMartin K. Petersen 	typeof(x) __x = (x);			\
577c8bf1336SMartin K. Petersen 	typeof(y) __y = (y);			\
578c8bf1336SMartin K. Petersen 	__x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
579c8bf1336SMartin K. Petersen 
580c8bf1336SMartin K. Petersen /**
581bdf4bbaaSHarvey Harrison  * clamp - return a value clamped to a given range with strict typechecking
582bdf4bbaaSHarvey Harrison  * @val: current value
583bdf4bbaaSHarvey Harrison  * @min: minimum allowable value
584bdf4bbaaSHarvey Harrison  * @max: maximum allowable value
585bdf4bbaaSHarvey Harrison  *
586bdf4bbaaSHarvey Harrison  * This macro does strict typechecking of min/max to make sure they are of the
587bdf4bbaaSHarvey Harrison  * same type as val.  See the unnecessary pointer comparisons.
588bdf4bbaaSHarvey Harrison  */
589bdf4bbaaSHarvey Harrison #define clamp(val, min, max) ({			\
590bdf4bbaaSHarvey Harrison 	typeof(val) __val = (val);		\
591bdf4bbaaSHarvey Harrison 	typeof(min) __min = (min);		\
592bdf4bbaaSHarvey Harrison 	typeof(max) __max = (max);		\
593bdf4bbaaSHarvey Harrison 	(void) (&__val == &__min);		\
594bdf4bbaaSHarvey Harrison 	(void) (&__val == &__max);		\
595bdf4bbaaSHarvey Harrison 	__val = __val < __min ? __min: __val;	\
596bdf4bbaaSHarvey Harrison 	__val > __max ? __max: __val; })
5971da177e4SLinus Torvalds 
5981da177e4SLinus Torvalds /*
5991da177e4SLinus Torvalds  * ..and if you can't take the strict
6001da177e4SLinus Torvalds  * types, you can specify one yourself.
6011da177e4SLinus Torvalds  *
602bdf4bbaaSHarvey Harrison  * Or not use min/max/clamp at all, of course.
6031da177e4SLinus Torvalds  */
604bdf4bbaaSHarvey Harrison #define min_t(type, x, y) ({			\
605bdf4bbaaSHarvey Harrison 	type __min1 = (x);			\
606bdf4bbaaSHarvey Harrison 	type __min2 = (y);			\
607bdf4bbaaSHarvey Harrison 	__min1 < __min2 ? __min1: __min2; })
6081da177e4SLinus Torvalds 
609bdf4bbaaSHarvey Harrison #define max_t(type, x, y) ({			\
610bdf4bbaaSHarvey Harrison 	type __max1 = (x);			\
611bdf4bbaaSHarvey Harrison 	type __max2 = (y);			\
612bdf4bbaaSHarvey Harrison 	__max1 > __max2 ? __max1: __max2; })
613bdf4bbaaSHarvey Harrison 
614bdf4bbaaSHarvey Harrison /**
615bdf4bbaaSHarvey Harrison  * clamp_t - return a value clamped to a given range using a given type
616bdf4bbaaSHarvey Harrison  * @type: the type of variable to use
617bdf4bbaaSHarvey Harrison  * @val: current value
618bdf4bbaaSHarvey Harrison  * @min: minimum allowable value
619bdf4bbaaSHarvey Harrison  * @max: maximum allowable value
620bdf4bbaaSHarvey Harrison  *
621bdf4bbaaSHarvey Harrison  * This macro does no typechecking and uses temporary variables of type
622bdf4bbaaSHarvey Harrison  * 'type' to make all the comparisons.
623bdf4bbaaSHarvey Harrison  */
624bdf4bbaaSHarvey Harrison #define clamp_t(type, val, min, max) ({		\
625bdf4bbaaSHarvey Harrison 	type __val = (val);			\
626bdf4bbaaSHarvey Harrison 	type __min = (min);			\
627bdf4bbaaSHarvey Harrison 	type __max = (max);			\
628bdf4bbaaSHarvey Harrison 	__val = __val < __min ? __min: __val;	\
629bdf4bbaaSHarvey Harrison 	__val > __max ? __max: __val; })
630bdf4bbaaSHarvey Harrison 
631bdf4bbaaSHarvey Harrison /**
632bdf4bbaaSHarvey Harrison  * clamp_val - return a value clamped to a given range using val's type
633bdf4bbaaSHarvey Harrison  * @val: current value
634bdf4bbaaSHarvey Harrison  * @min: minimum allowable value
635bdf4bbaaSHarvey Harrison  * @max: maximum allowable value
636bdf4bbaaSHarvey Harrison  *
637bdf4bbaaSHarvey Harrison  * This macro does no typechecking and uses temporary variables of whatever
638bdf4bbaaSHarvey Harrison  * type the input argument 'val' is.  This is useful when val is an unsigned
639bdf4bbaaSHarvey Harrison  * type and min and max are literals that will otherwise be assigned a signed
640bdf4bbaaSHarvey Harrison  * integer type.
641bdf4bbaaSHarvey Harrison  */
642bdf4bbaaSHarvey Harrison #define clamp_val(val, min, max) ({		\
643bdf4bbaaSHarvey Harrison 	typeof(val) __val = (val);		\
644bdf4bbaaSHarvey Harrison 	typeof(val) __min = (min);		\
645bdf4bbaaSHarvey Harrison 	typeof(val) __max = (max);		\
646bdf4bbaaSHarvey Harrison 	__val = __val < __min ? __min: __val;	\
647bdf4bbaaSHarvey Harrison 	__val > __max ? __max: __val; })
6481da177e4SLinus Torvalds 
64991f68b73SWu Fengguang 
65091f68b73SWu Fengguang /*
65191f68b73SWu Fengguang  * swap - swap value of @a and @b
65291f68b73SWu Fengguang  */
653ac7b9004SPeter Zijlstra #define swap(a, b) \
654ac7b9004SPeter Zijlstra 	do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
65591f68b73SWu Fengguang 
6561da177e4SLinus Torvalds /**
6571da177e4SLinus Torvalds  * container_of - cast a member of a structure out to the containing structure
6581da177e4SLinus Torvalds  * @ptr:	the pointer to the member.
6591da177e4SLinus Torvalds  * @type:	the type of the container struct this is embedded in.
6601da177e4SLinus Torvalds  * @member:	the name of the member within the struct.
6611da177e4SLinus Torvalds  *
6621da177e4SLinus Torvalds  */
6631da177e4SLinus Torvalds #define container_of(ptr, type, member) ({			\
6641da177e4SLinus Torvalds 	const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
6651da177e4SLinus Torvalds 	(type *)( (char *)__mptr - offsetof(type,member) );})
6661da177e4SLinus Torvalds 
667903c0c7cSKOSAKI Motohiro #ifdef __CHECKER__
668903c0c7cSKOSAKI Motohiro #define BUILD_BUG_ON_NOT_POWER_OF_2(n)
669ca39599cSDr. David Alan Gilbert #define BUILD_BUG_ON_ZERO(e) (0)
670ca39599cSDr. David Alan Gilbert #define BUILD_BUG_ON_NULL(e) ((void*)0)
671903c0c7cSKOSAKI Motohiro #define BUILD_BUG_ON(condition)
6721399ff86SDavid Daney #define BUILD_BUG() (0)
673903c0c7cSKOSAKI Motohiro #else /* __CHECKER__ */
674903c0c7cSKOSAKI Motohiro 
675cc8ef6ebSRoland Dreier /* Force a compilation error if a constant expression is not a power of 2 */
676cc8ef6ebSRoland Dreier #define BUILD_BUG_ON_NOT_POWER_OF_2(n)			\
677cc8ef6ebSRoland Dreier 	BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
678cc8ef6ebSRoland Dreier 
6794552d5dcSJan Beulich /* Force a compilation error if condition is true, but also produce a
6804552d5dcSJan Beulich    result (of value 0 and type size_t), so the expression can be used
6814552d5dcSJan Beulich    e.g. in a structure initializer (or where-ever else comma expressions
6824552d5dcSJan Beulich    aren't permitted). */
6838c87df45SJan Beulich #define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
6848c87df45SJan Beulich #define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
6854552d5dcSJan Beulich 
6867ef88ad5SRusty Russell /**
6877ef88ad5SRusty Russell  * BUILD_BUG_ON - break compile if a condition is true.
688ffbbf2daSRandy Dunlap  * @condition: the condition which the compiler should know is false.
6897ef88ad5SRusty Russell  *
6907ef88ad5SRusty Russell  * If you have some code which relies on certain constants being equal, or
6917ef88ad5SRusty Russell  * other compile-time-evaluated condition, you should use BUILD_BUG_ON to
6927ef88ad5SRusty Russell  * detect if someone changes it.
6937ef88ad5SRusty Russell  *
6947ef88ad5SRusty Russell  * The implementation uses gcc's reluctance to create a negative array, but
6957ef88ad5SRusty Russell  * gcc (as of 4.4) only emits that error for obvious cases (eg. not arguments
6967ef88ad5SRusty Russell  * to inline functions).  So as a fallback we use the optimizer; if it can't
6977ef88ad5SRusty Russell  * prove the condition is false, it will cause a link error on the undefined
6987ef88ad5SRusty Russell  * "__build_bug_on_failed".  This error message can be harder to track down
6997ef88ad5SRusty Russell  * though, hence the two different methods.
7007ef88ad5SRusty Russell  */
7017ef88ad5SRusty Russell #ifndef __OPTIMIZE__
7027ef88ad5SRusty Russell #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
7037ef88ad5SRusty Russell #else
7047ef88ad5SRusty Russell extern int __build_bug_on_failed;
7057ef88ad5SRusty Russell #define BUILD_BUG_ON(condition)					\
7067ef88ad5SRusty Russell 	do {							\
7077ef88ad5SRusty Russell 		((void)sizeof(char[1 - 2*!!(condition)]));	\
7087ef88ad5SRusty Russell 		if (condition) __build_bug_on_failed = 1;	\
7097ef88ad5SRusty Russell 	} while(0)
7107ef88ad5SRusty Russell #endif
7111399ff86SDavid Daney 
7121399ff86SDavid Daney /**
7131399ff86SDavid Daney  * BUILD_BUG - break compile if used.
7141399ff86SDavid Daney  *
7151399ff86SDavid Daney  * If you have some code that you expect the compiler to eliminate at
7161399ff86SDavid Daney  * build time, you should use BUILD_BUG to detect if it is
7171399ff86SDavid Daney  * unexpectedly used.
7181399ff86SDavid Daney  */
7191399ff86SDavid Daney #define BUILD_BUG()						\
7201399ff86SDavid Daney 	do {							\
7211399ff86SDavid Daney 		extern void __build_bug_failed(void)		\
7221399ff86SDavid Daney 			__linktime_error("BUILD_BUG failed");	\
7231399ff86SDavid Daney 		__build_bug_failed();				\
7241399ff86SDavid Daney 	} while (0)
7251399ff86SDavid Daney 
726903c0c7cSKOSAKI Motohiro #endif	/* __CHECKER__ */
7277ef88ad5SRusty Russell 
728b9d4f426SArnaud Lacombe /* Trap pasters of __FUNCTION__ at compile-time */
729b9d4f426SArnaud Lacombe #define __FUNCTION__ (__func__)
730b9d4f426SArnaud Lacombe 
731b9d4f426SArnaud Lacombe /* This helps us to avoid #ifdef CONFIG_NUMA */
732b9d4f426SArnaud Lacombe #ifdef CONFIG_NUMA
733b9d4f426SArnaud Lacombe #define NUMA_BUILD 1
734b9d4f426SArnaud Lacombe #else
735b9d4f426SArnaud Lacombe #define NUMA_BUILD 0
736b9d4f426SArnaud Lacombe #endif
737b9d4f426SArnaud Lacombe 
738b9d4f426SArnaud Lacombe /* This helps us avoid #ifdef CONFIG_COMPACTION */
739b9d4f426SArnaud Lacombe #ifdef CONFIG_COMPACTION
740b9d4f426SArnaud Lacombe #define COMPACTION_BUILD 1
741b9d4f426SArnaud Lacombe #else
742b9d4f426SArnaud Lacombe #define COMPACTION_BUILD 0
743b9d4f426SArnaud Lacombe #endif
744b9d4f426SArnaud Lacombe 
745b9d4f426SArnaud Lacombe /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
746b9d4f426SArnaud Lacombe #ifdef CONFIG_FTRACE_MCOUNT_RECORD
747b9d4f426SArnaud Lacombe # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
748b9d4f426SArnaud Lacombe #endif
7499d00f92fSWANG Cong 
7509d00f92fSWANG Cong extern int do_sysinfo(struct sysinfo *info);
7519d00f92fSWANG Cong 
7529d00f92fSWANG Cong #endif /* __KERNEL__ */
7539d00f92fSWANG Cong 
7541da177e4SLinus Torvalds #endif
755