xref: /freebsd/sys/compat/linuxkpi/common/include/linux/kernel.h (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013-2016 Mellanox Technologies, Ltd.
6  * Copyright (c) 2014-2015 François Tigeot
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice unmodified, this list of conditions, and the following
14  *    disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 #ifndef	_LINUX_KERNEL_H_
33 #define	_LINUX_KERNEL_H_
34 
35 #include <sys/cdefs.h>
36 #include <sys/types.h>
37 #include <sys/systm.h>
38 #include <sys/param.h>
39 #include <sys/libkern.h>
40 #include <sys/stat.h>
41 #include <sys/smp.h>
42 #include <sys/stddef.h>
43 #include <sys/syslog.h>
44 #include <sys/time.h>
45 
46 #include <linux/bitops.h>
47 #include <linux/compiler.h>
48 #include <linux/stringify.h>
49 #include <linux/errno.h>
50 #include <linux/sched.h>
51 #include <linux/types.h>
52 #include <linux/jiffies.h>
53 #include <linux/log2.h>
54 
55 #include <asm/byteorder.h>
56 #include <asm/uaccess.h>
57 
58 #include <machine/stdarg.h>
59 
60 #define KERN_CONT       ""
61 #define	KERN_EMERG	"<0>"
62 #define	KERN_ALERT	"<1>"
63 #define	KERN_CRIT	"<2>"
64 #define	KERN_ERR	"<3>"
65 #define	KERN_WARNING	"<4>"
66 #define	KERN_NOTICE	"<5>"
67 #define	KERN_INFO	"<6>"
68 #define	KERN_DEBUG	"<7>"
69 
70 #define	U8_MAX		((u8)~0U)
71 #define	S8_MAX		((s8)(U8_MAX >> 1))
72 #define	S8_MIN		((s8)(-S8_MAX - 1))
73 #define	U16_MAX		((u16)~0U)
74 #define	S16_MAX		((s16)(U16_MAX >> 1))
75 #define	S16_MIN		((s16)(-S16_MAX - 1))
76 #define	U32_MAX		((u32)~0U)
77 #define	S32_MAX		((s32)(U32_MAX >> 1))
78 #define	S32_MIN		((s32)(-S32_MAX - 1))
79 #define	U64_MAX		((u64)~0ULL)
80 #define	S64_MAX		((s64)(U64_MAX >> 1))
81 #define	S64_MIN		((s64)(-S64_MAX - 1))
82 
83 #define	S8_C(x)  x
84 #define	U8_C(x)  x ## U
85 #define	S16_C(x) x
86 #define	U16_C(x) x ## U
87 #define	S32_C(x) x
88 #define	U32_C(x) x ## U
89 #define	S64_C(x) x ## LL
90 #define	U64_C(x) x ## ULL
91 
92 /*
93  * BUILD_BUG_ON() can happen inside functions where _Static_assert() does not
94  * seem to work.  Use old-schoold-ish CTASSERT from before commit
95  * a3085588a88fa58eb5b1eaae471999e1995a29cf but also make sure we do not
96  * end up with an unused typedef or variable. The compiler should optimise
97  * it away entirely.
98  */
99 #define	_O_CTASSERT(x)		_O__CTASSERT(x, __LINE__)
100 #define	_O__CTASSERT(x, y)	_O___CTASSERT(x, y)
101 #define	_O___CTASSERT(x, y)	while (0) { \
102     typedef char __assert_line_ ## y[(x) ? 1 : -1]; \
103     __assert_line_ ## y _x; \
104     _x[0] = '\0'; \
105 }
106 
107 #define	BUILD_BUG()			do { CTASSERT(0); } while (0)
108 #define	BUILD_BUG_ON(x)			_O_CTASSERT(!(x))
109 #define	BUILD_BUG_ON_MSG(x, msg)	BUILD_BUG_ON(x)
110 #define	BUILD_BUG_ON_NOT_POWER_OF_2(x)	BUILD_BUG_ON(!powerof2(x))
111 #define	BUILD_BUG_ON_INVALID(expr)	while (0) { (void)(expr); }
112 
113 extern const volatile int lkpi_build_bug_on_zero;
114 #define	BUILD_BUG_ON_ZERO(x)	((x) ? lkpi_build_bug_on_zero : 0)
115 
116 #define	BUG()			panic("BUG at %s:%d", __FILE__, __LINE__)
117 #define	BUG_ON(cond)		do {				\
118 	if (cond) {						\
119 		panic("BUG ON %s failed at %s:%d",		\
120 		    __stringify(cond), __FILE__, __LINE__);	\
121 	}							\
122 } while (0)
123 
124 #define	WARN_ON(cond) ({					\
125       bool __ret = (cond);					\
126       if (__ret) {						\
127 		printf("WARNING %s failed at %s:%d\n",		\
128 		    __stringify(cond), __FILE__, __LINE__);	\
129 		linux_dump_stack();				\
130       }								\
131       unlikely(__ret);						\
132 })
133 
134 #define	WARN_ON_SMP(cond)	WARN_ON(cond)
135 
136 #define	WARN_ON_ONCE(cond) ({					\
137       static bool __warn_on_once;				\
138       bool __ret = (cond);					\
139       if (__ret && !__warn_on_once) {				\
140 		__warn_on_once = 1;				\
141 		printf("WARNING %s failed at %s:%d\n",		\
142 		    __stringify(cond), __FILE__, __LINE__);	\
143 		linux_dump_stack();				\
144       }								\
145       unlikely(__ret);						\
146 })
147 
148 #define	oops_in_progress	SCHEDULER_STOPPED()
149 
150 #undef	ALIGN
151 #define	ALIGN(x, y)		roundup2((x), (y))
152 #undef PTR_ALIGN
153 #define	PTR_ALIGN(p, a)		((__typeof(p))ALIGN((uintptr_t)(p), (a)))
154 #define	IS_ALIGNED(x, a)	(((x) & ((__typeof(x))(a) - 1)) == 0)
155 #define	DIV_ROUND_UP(x, n)	howmany(x, n)
156 #define	__KERNEL_DIV_ROUND_UP(x, n)	howmany(x, n)
157 #define	DIV_ROUND_UP_ULL(x, n)	DIV_ROUND_UP((unsigned long long)(x), (n))
158 #define	DIV_ROUND_DOWN_ULL(x, n) (((unsigned long long)(x) / (n)) * (n))
159 #define	FIELD_SIZEOF(t, f)	sizeof(((t *)0)->f)
160 
161 #define	printk(...)		printf(__VA_ARGS__)
162 #define	vprintk(f, a)		vprintf(f, a)
163 
164 #define	asm			__asm
165 
166 extern void linux_dump_stack(void);
167 #define	dump_stack()		linux_dump_stack()
168 
169 struct va_format {
170 	const char *fmt;
171 	va_list *va;
172 };
173 
174 static inline int
175 vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
176 {
177 	ssize_t ssize = size;
178 	int i;
179 
180 	i = vsnprintf(buf, size, fmt, args);
181 
182 	return ((i >= ssize) ? (ssize - 1) : i);
183 }
184 
185 static inline int
186 scnprintf(char *buf, size_t size, const char *fmt, ...)
187 {
188 	va_list args;
189 	int i;
190 
191 	va_start(args, fmt);
192 	i = vscnprintf(buf, size, fmt, args);
193 	va_end(args);
194 
195 	return (i);
196 }
197 
198 /*
199  * The "pr_debug()" and "pr_devel()" macros should produce zero code
200  * unless DEBUG is defined:
201  */
202 #ifdef DEBUG
203 extern int linuxkpi_debug;
204 #define pr_debug(fmt, ...)					\
205 	do {							\
206 		if (linuxkpi_debug)				\
207 			log(LOG_DEBUG, fmt, ##__VA_ARGS__);	\
208 	} while (0)
209 #define pr_devel(fmt, ...) \
210 	log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__)
211 #else
212 #define pr_debug(fmt, ...) \
213 	({ if (0) log(LOG_DEBUG, fmt, ##__VA_ARGS__); 0; })
214 #define pr_devel(fmt, ...) \
215 	({ if (0) log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__); 0; })
216 #endif
217 
218 #ifndef pr_fmt
219 #define pr_fmt(fmt) fmt
220 #endif
221 
222 /*
223  * Print a one-time message (analogous to WARN_ONCE() et al):
224  */
225 #define printk_once(...) do {			\
226 	static bool __print_once;		\
227 						\
228 	if (!__print_once) {			\
229 		__print_once = true;		\
230 		printk(__VA_ARGS__);		\
231 	}					\
232 } while (0)
233 
234 /*
235  * Log a one-time message (analogous to WARN_ONCE() et al):
236  */
237 #define log_once(level,...) do {		\
238 	static bool __log_once;			\
239 						\
240 	if (unlikely(!__log_once)) {		\
241 		__log_once = true;		\
242 		log(level, __VA_ARGS__);	\
243 	}					\
244 } while (0)
245 
246 #define pr_emerg(fmt, ...) \
247 	log(LOG_EMERG, pr_fmt(fmt), ##__VA_ARGS__)
248 #define pr_alert(fmt, ...) \
249 	log(LOG_ALERT, pr_fmt(fmt), ##__VA_ARGS__)
250 #define pr_crit(fmt, ...) \
251 	log(LOG_CRIT, pr_fmt(fmt), ##__VA_ARGS__)
252 #define pr_err(fmt, ...) \
253 	log(LOG_ERR, pr_fmt(fmt), ##__VA_ARGS__)
254 #define pr_warning(fmt, ...) \
255 	log(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__)
256 #define pr_warn(...) \
257 	pr_warning(__VA_ARGS__)
258 #define pr_warn_once(fmt, ...) \
259 	log_once(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__)
260 #define pr_notice(fmt, ...) \
261 	log(LOG_NOTICE, pr_fmt(fmt), ##__VA_ARGS__)
262 #define pr_info(fmt, ...) \
263 	log(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__)
264 #define pr_info_once(fmt, ...) \
265 	log_once(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__)
266 #define pr_cont(fmt, ...) \
267 	printk(KERN_CONT fmt, ##__VA_ARGS__)
268 #define	pr_warn_ratelimited(...) do {		\
269 	static linux_ratelimit_t __ratelimited;	\
270 	if (linux_ratelimited(&__ratelimited))	\
271 		pr_warning(__VA_ARGS__);	\
272 } while (0)
273 
274 #ifndef WARN
275 #define	WARN(condition, ...) ({			\
276 	bool __ret_warn_on = (condition);	\
277 	if (unlikely(__ret_warn_on))		\
278 		pr_warning(__VA_ARGS__);	\
279 	unlikely(__ret_warn_on);		\
280 })
281 #endif
282 
283 #ifndef WARN_ONCE
284 #define	WARN_ONCE(condition, ...) ({		\
285 	bool __ret_warn_on = (condition);	\
286 	if (unlikely(__ret_warn_on))		\
287 		pr_warn_once(__VA_ARGS__);	\
288 	unlikely(__ret_warn_on);		\
289 })
290 #endif
291 
292 #define container_of(ptr, type, member)				\
293 ({								\
294 	const __typeof(((type *)0)->member) *__p = (ptr);	\
295 	(type *)((uintptr_t)__p - offsetof(type, member));	\
296 })
297 
298 #define	ARRAY_SIZE(x)	(sizeof(x) / sizeof((x)[0]))
299 
300 #define	u64_to_user_ptr(val)	((void *)(uintptr_t)(val))
301 
302 static inline unsigned long long
303 simple_strtoull(const char *cp, char **endp, unsigned int base)
304 {
305 	return (strtouq(cp, endp, base));
306 }
307 
308 static inline long long
309 simple_strtoll(const char *cp, char **endp, unsigned int base)
310 {
311 	return (strtoq(cp, endp, base));
312 }
313 
314 static inline unsigned long
315 simple_strtoul(const char *cp, char **endp, unsigned int base)
316 {
317 	return (strtoul(cp, endp, base));
318 }
319 
320 static inline long
321 simple_strtol(const char *cp, char **endp, unsigned int base)
322 {
323 	return (strtol(cp, endp, base));
324 }
325 
326 static inline int
327 kstrtoul(const char *cp, unsigned int base, unsigned long *res)
328 {
329 	char *end;
330 
331 	*res = strtoul(cp, &end, base);
332 
333 	/* skip newline character, if any */
334 	if (*end == '\n')
335 		end++;
336 	if (*cp == 0 || *end != 0)
337 		return (-EINVAL);
338 	return (0);
339 }
340 
341 static inline int
342 kstrtol(const char *cp, unsigned int base, long *res)
343 {
344 	char *end;
345 
346 	*res = strtol(cp, &end, base);
347 
348 	/* skip newline character, if any */
349 	if (*end == '\n')
350 		end++;
351 	if (*cp == 0 || *end != 0)
352 		return (-EINVAL);
353 	return (0);
354 }
355 
356 static inline int
357 kstrtoint(const char *cp, unsigned int base, int *res)
358 {
359 	char *end;
360 	long temp;
361 
362 	*res = temp = strtol(cp, &end, base);
363 
364 	/* skip newline character, if any */
365 	if (*end == '\n')
366 		end++;
367 	if (*cp == 0 || *end != 0)
368 		return (-EINVAL);
369 	if (temp != (int)temp)
370 		return (-ERANGE);
371 	return (0);
372 }
373 
374 static inline int
375 kstrtouint(const char *cp, unsigned int base, unsigned int *res)
376 {
377 	char *end;
378 	unsigned long temp;
379 
380 	*res = temp = strtoul(cp, &end, base);
381 
382 	/* skip newline character, if any */
383 	if (*end == '\n')
384 		end++;
385 	if (*cp == 0 || *end != 0)
386 		return (-EINVAL);
387 	if (temp != (unsigned int)temp)
388 		return (-ERANGE);
389 	return (0);
390 }
391 
392 static inline int
393 kstrtou16(const char *cp, unsigned int base, u16 *res)
394 {
395 	char *end;
396 	unsigned long temp;
397 
398 	*res = temp = strtoul(cp, &end, base);
399 
400 	/* skip newline character, if any */
401 	if (*end == '\n')
402 		end++;
403 	if (*cp == 0 || *end != 0)
404 		return (-EINVAL);
405 	if (temp != (u16)temp)
406 		return (-ERANGE);
407 	return (0);
408 }
409 
410 static inline int
411 kstrtou32(const char *cp, unsigned int base, u32 *res)
412 {
413 	char *end;
414 	unsigned long temp;
415 
416 	*res = temp = strtoul(cp, &end, base);
417 
418 	/* skip newline character, if any */
419 	if (*end == '\n')
420 		end++;
421 	if (*cp == 0 || *end != 0)
422 		return (-EINVAL);
423 	if (temp != (u32)temp)
424 		return (-ERANGE);
425 	return (0);
426 }
427 
428 static inline int
429 kstrtou64(const char *cp, unsigned int base, u64 *res)
430 {
431        char *end;
432 
433        *res = strtouq(cp, &end, base);
434 
435        /* skip newline character, if any */
436        if (*end == '\n')
437                end++;
438        if (*cp == 0 || *end != 0)
439                return (-EINVAL);
440        return (0);
441 }
442 
443 static inline int
444 kstrtobool(const char *s, bool *res)
445 {
446 	int len;
447 
448 	if (s == NULL || (len = strlen(s)) == 0 || res == NULL)
449 		return (-EINVAL);
450 
451 	/* skip newline character, if any */
452 	if (s[len - 1] == '\n')
453 		len--;
454 
455 	if (len == 1 && strchr("yY1", s[0]) != NULL)
456 		*res = true;
457 	else if (len == 1 && strchr("nN0", s[0]) != NULL)
458 		*res = false;
459 	else if (strncasecmp("on", s, len) == 0)
460 		*res = true;
461 	else if (strncasecmp("off", s, len) == 0)
462 		*res = false;
463 	else
464 		return (-EINVAL);
465 
466 	return (0);
467 }
468 
469 static inline int
470 kstrtobool_from_user(const char __user *s, size_t count, bool *res)
471 {
472 	char buf[8] = {};
473 
474 	if (count > (sizeof(buf) - 1))
475 		count = (sizeof(buf) - 1);
476 
477 	if (copy_from_user(buf, s, count))
478 		return (-EFAULT);
479 
480 	return (kstrtobool(buf, res));
481 }
482 
483 #define min(x, y)	((x) < (y) ? (x) : (y))
484 #define max(x, y)	((x) > (y) ? (x) : (y))
485 
486 #define min3(a, b, c)	min(a, min(b,c))
487 #define max3(a, b, c)	max(a, max(b,c))
488 
489 #define	min_t(type, x, y) ({			\
490 	type __min1 = (x);			\
491 	type __min2 = (y);			\
492 	__min1 < __min2 ? __min1 : __min2; })
493 
494 #define	max_t(type, x, y) ({			\
495 	type __max1 = (x);			\
496 	type __max2 = (y);			\
497 	__max1 > __max2 ? __max1 : __max2; })
498 
499 #define offsetofend(t, m)	\
500         (offsetof(t, m) + sizeof((((t *)0)->m)))
501 
502 #define clamp_t(type, _x, min, max)	min_t(type, max_t(type, _x, min), max)
503 #define clamp(x, lo, hi)		min( max(x,lo), hi)
504 #define	clamp_val(val, lo, hi) clamp_t(typeof(val), val, lo, hi)
505 
506 /*
507  * This looks more complex than it should be. But we need to
508  * get the type for the ~ right in round_down (it needs to be
509  * as wide as the result!), and we want to evaluate the macro
510  * arguments just once each.
511  */
512 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
513 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
514 #define round_down(x, y) ((x) & ~__round_mask(x, y))
515 
516 #define	smp_processor_id()	PCPU_GET(cpuid)
517 #define	num_possible_cpus()	mp_ncpus
518 #define	num_online_cpus()	mp_ncpus
519 
520 #if defined(__i386__) || defined(__amd64__)
521 extern bool linux_cpu_has_clflush;
522 #define	cpu_has_clflush		linux_cpu_has_clflush
523 #endif
524 
525 typedef struct pm_message {
526 	int event;
527 } pm_message_t;
528 
529 /* Swap values of a and b */
530 #define swap(a, b) do {			\
531 	typeof(a) _swap_tmp = a;	\
532 	a = b;				\
533 	b = _swap_tmp;			\
534 } while (0)
535 
536 #define	DIV_ROUND_CLOSEST(x, divisor)	(((x) + ((divisor) / 2)) / (divisor))
537 
538 #define	DIV_ROUND_CLOSEST_ULL(x, divisor) ({		\
539 	__typeof(divisor) __d = (divisor);		\
540 	unsigned long long __ret = (x) + (__d) / 2;	\
541 	__ret /= __d;					\
542 	__ret;						\
543 })
544 
545 static inline uintmax_t
546 mult_frac(uintmax_t x, uintmax_t multiplier, uintmax_t divisor)
547 {
548 	uintmax_t q = (x / divisor);
549 	uintmax_t r = (x % divisor);
550 
551 	return ((q * multiplier) + ((r * multiplier) / divisor));
552 }
553 
554 static inline int64_t
555 abs64(int64_t x)
556 {
557 	return (x < 0 ? -x : x);
558 }
559 
560 typedef struct linux_ratelimit {
561 	struct timeval lasttime;
562 	int counter;
563 } linux_ratelimit_t;
564 
565 static inline bool
566 linux_ratelimited(linux_ratelimit_t *rl)
567 {
568 	return (ppsratecheck(&rl->lasttime, &rl->counter, 1));
569 }
570 
571 #define	struct_size(ptr, field, num) ({ \
572 	const size_t __size = offsetof(__typeof(*(ptr)), field); \
573 	const size_t __max = (SIZE_MAX - __size) / sizeof((ptr)->field[0]); \
574 	((num) > __max) ? SIZE_MAX : (__size + sizeof((ptr)->field[0]) * (num)); \
575 })
576 
577 #define	__is_constexpr(x) \
578 	__builtin_constant_p(x)
579 
580 /*
581  * The is_signed() macro below returns true if the passed data type is
582  * signed. Else false is returned.
583  */
584 #define	is_signed(datatype) (((datatype)-1 / (datatype)2) == (datatype)0)
585 
586 /*
587  * The type_max() macro below returns the maxium positive value the
588  * passed data type can hold.
589  */
590 #define	type_max(datatype) ( \
591   (sizeof(datatype) >= 8) ? (is_signed(datatype) ? INT64_MAX : UINT64_MAX) : \
592   (sizeof(datatype) >= 4) ? (is_signed(datatype) ? INT32_MAX : UINT32_MAX) : \
593   (sizeof(datatype) >= 2) ? (is_signed(datatype) ? INT16_MAX : UINT16_MAX) : \
594 			    (is_signed(datatype) ? INT8_MAX : UINT8_MAX) \
595 )
596 
597 /*
598  * The type_min() macro below returns the minimum value the passed
599  * data type can hold. For unsigned types the minimum value is always
600  * zero. For signed types it may vary.
601  */
602 #define	type_min(datatype) ( \
603   (sizeof(datatype) >= 8) ? (is_signed(datatype) ? INT64_MIN : 0) : \
604   (sizeof(datatype) >= 4) ? (is_signed(datatype) ? INT32_MIN : 0) : \
605   (sizeof(datatype) >= 2) ? (is_signed(datatype) ? INT16_MIN : 0) : \
606 			    (is_signed(datatype) ? INT8_MIN : 0) \
607 )
608 
609 #define	TAINT_WARN	0
610 #define	test_taint(x)	(0)
611 
612 /*
613  * Checking if an option is defined would be easy if we could do CPP inside CPP.
614  * The defined case whether -Dxxx or -Dxxx=1 are easy to deal with.  In either
615  * case the defined value is "1". A more general -Dxxx=<c> case will require
616  * more effort to deal with all possible "true" values. Hope we do not have
617  * to do this as well.
618  * The real problem is the undefined case.  To avoid this problem we do the
619  * concat/varargs trick: "yyy" ## xxx can make two arguments if xxx is "1"
620  * by having a #define for yyy_1 which is "ignore,".
621  * Otherwise we will just get "yyy".
622  * Need to be careful about variable substitutions in macros though.
623  * This way we make a (true, false) problem a (don't care, true, false) or a
624  * (don't care true, false).  Then we can use a variadic macro to only select
625  * the always well known and defined argument #2.  And that seems to be
626  * exactly what we need.  Use 1 for true and 0 for false to also allow
627  * #if IS_*() checks pre-compiler checks which do not like #if true.
628  */
629 #define ___XAB_1		dontcare,
630 #define ___IS_XAB(_ignore, _x, ...)	(_x)
631 #define	__IS_XAB(_x)		___IS_XAB(_x 1, 0)
632 #define	_IS_XAB(_x)		__IS_XAB(__CONCAT(___XAB_, _x))
633 
634 /* This is if CONFIG_ccc=y. */
635 #define	IS_BUILTIN(_x)		_IS_XAB(_x)
636 /* This is if CONFIG_ccc=m. */
637 #define	IS_MODULE(_x)		_IS_XAB(_x ## _MODULE)
638 /* This is if CONFIG_ccc is compiled in(=y) or a module(=m). */
639 #define	IS_ENABLED(_x)		(IS_BUILTIN(_x) || IS_MODULE(_x))
640 /*
641  * This is weird case.  If the CONFIG_ccc is builtin (=y) this returns true;
642  * or if the CONFIG_ccc is a module (=m) and the caller is built as a module
643  * (-DMODULE defined) this returns true, but if the callers is not a module
644  * (-DMODULE not defined, which means caller is BUILTIN) then it returns
645  * false.  In other words, a module can reach the kernel, a module can reach
646  * a module, but the kernel cannot reach a module, and code never compiled
647  * cannot be reached either.
648  * XXX -- I'd hope the module-to-module case would be handled by a proper
649  * module dependency definition (MODULE_DEPEND() in FreeBSD).
650  */
651 #define	IS_REACHABLE(_x)	(IS_BUILTIN(_x) || \
652 				    (IS_MODULE(_x) && IS_BUILTIN(MODULE)))
653 
654 #endif	/* _LINUX_KERNEL_H_ */
655