xref: /freebsd/sys/compat/linuxkpi/common/include/linux/kernel.h (revision cfd6422a5217410fbd66f7a7a8a64d9d85e61229)
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/errno.h>
49 #include <linux/sched.h>
50 #include <linux/types.h>
51 #include <linux/jiffies.h>
52 #include <linux/log2.h>
53 
54 #include <asm/byteorder.h>
55 #include <asm/uaccess.h>
56 
57 #include <machine/stdarg.h>
58 
59 #define KERN_CONT       ""
60 #define	KERN_EMERG	"<0>"
61 #define	KERN_ALERT	"<1>"
62 #define	KERN_CRIT	"<2>"
63 #define	KERN_ERR	"<3>"
64 #define	KERN_WARNING	"<4>"
65 #define	KERN_NOTICE	"<5>"
66 #define	KERN_INFO	"<6>"
67 #define	KERN_DEBUG	"<7>"
68 
69 #define	U8_MAX		((u8)~0U)
70 #define	S8_MAX		((s8)(U8_MAX >> 1))
71 #define	S8_MIN		((s8)(-S8_MAX - 1))
72 #define	U16_MAX		((u16)~0U)
73 #define	S16_MAX		((s16)(U16_MAX >> 1))
74 #define	S16_MIN		((s16)(-S16_MAX - 1))
75 #define	U32_MAX		((u32)~0U)
76 #define	S32_MAX		((s32)(U32_MAX >> 1))
77 #define	S32_MIN		((s32)(-S32_MAX - 1))
78 #define	U64_MAX		((u64)~0ULL)
79 #define	S64_MAX		((s64)(U64_MAX >> 1))
80 #define	S64_MIN		((s64)(-S64_MAX - 1))
81 
82 #define	S8_C(x)  x
83 #define	U8_C(x)  x ## U
84 #define	S16_C(x) x
85 #define	U16_C(x) x ## U
86 #define	S32_C(x) x
87 #define	U32_C(x) x ## U
88 #define	S64_C(x) x ## LL
89 #define	U64_C(x) x ## ULL
90 
91 #define	BUILD_BUG()			do { CTASSERT(0); } while (0)
92 #define	BUILD_BUG_ON(x)			CTASSERT(!(x))
93 #define	BUILD_BUG_ON_MSG(x, msg)	BUILD_BUG_ON(x)
94 #define	BUILD_BUG_ON_NOT_POWER_OF_2(x)	BUILD_BUG_ON(!powerof2(x))
95 #define	BUILD_BUG_ON_INVALID(expr)	while (0) { (void)(expr); }
96 
97 extern const volatile int lkpi_build_bug_on_zero;
98 #define	BUILD_BUG_ON_ZERO(x)	((x) ? lkpi_build_bug_on_zero : 0)
99 
100 #define	BUG()			panic("BUG at %s:%d", __FILE__, __LINE__)
101 #define	BUG_ON(cond)		do {				\
102 	if (cond) {						\
103 		panic("BUG ON %s failed at %s:%d",		\
104 		    __stringify(cond), __FILE__, __LINE__);	\
105 	}							\
106 } while (0)
107 
108 #define	WARN_ON(cond) ({					\
109       bool __ret = (cond);					\
110       if (__ret) {						\
111 		printf("WARNING %s failed at %s:%d\n",		\
112 		    __stringify(cond), __FILE__, __LINE__);	\
113 		linux_dump_stack();				\
114       }								\
115       unlikely(__ret);						\
116 })
117 
118 #define	WARN_ON_SMP(cond)	WARN_ON(cond)
119 
120 #define	WARN_ON_ONCE(cond) ({					\
121       static bool __warn_on_once;				\
122       bool __ret = (cond);					\
123       if (__ret && !__warn_on_once) {				\
124 		__warn_on_once = 1;				\
125 		printf("WARNING %s failed at %s:%d\n",		\
126 		    __stringify(cond), __FILE__, __LINE__);	\
127 		linux_dump_stack();				\
128       }								\
129       unlikely(__ret);						\
130 })
131 
132 #define	oops_in_progress	SCHEDULER_STOPPED()
133 
134 #undef	ALIGN
135 #define	ALIGN(x, y)		roundup2((x), (y))
136 #undef PTR_ALIGN
137 #define	PTR_ALIGN(p, a)		((__typeof(p))ALIGN((uintptr_t)(p), (a)))
138 #define	IS_ALIGNED(x, a)	(((x) & ((__typeof(x))(a) - 1)) == 0)
139 #define	DIV_ROUND_UP(x, n)	howmany(x, n)
140 #define	__KERNEL_DIV_ROUND_UP(x, n)	howmany(x, n)
141 #define	DIV_ROUND_UP_ULL(x, n)	DIV_ROUND_UP((unsigned long long)(x), (n))
142 #define	DIV_ROUND_DOWN_ULL(x, n) (((unsigned long long)(x) / (n)) * (n))
143 #define	FIELD_SIZEOF(t, f)	sizeof(((t *)0)->f)
144 
145 #define	printk(...)		printf(__VA_ARGS__)
146 #define	vprintk(f, a)		vprintf(f, a)
147 
148 #define	asm			__asm
149 
150 extern void linux_dump_stack(void);
151 #define	dump_stack()		linux_dump_stack()
152 
153 struct va_format {
154 	const char *fmt;
155 	va_list *va;
156 };
157 
158 static inline int
159 vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
160 {
161 	ssize_t ssize = size;
162 	int i;
163 
164 	i = vsnprintf(buf, size, fmt, args);
165 
166 	return ((i >= ssize) ? (ssize - 1) : i);
167 }
168 
169 static inline int
170 scnprintf(char *buf, size_t size, const char *fmt, ...)
171 {
172 	va_list args;
173 	int i;
174 
175 	va_start(args, fmt);
176 	i = vscnprintf(buf, size, fmt, args);
177 	va_end(args);
178 
179 	return (i);
180 }
181 
182 /*
183  * The "pr_debug()" and "pr_devel()" macros should produce zero code
184  * unless DEBUG is defined:
185  */
186 #ifdef DEBUG
187 extern int linuxkpi_debug;
188 #define pr_debug(fmt, ...)					\
189 	do {							\
190 		if (linuxkpi_debug)				\
191 			log(LOG_DEBUG, fmt, ##__VA_ARGS__);	\
192 	} while (0)
193 #define pr_devel(fmt, ...) \
194 	log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__)
195 #else
196 #define pr_debug(fmt, ...) \
197 	({ if (0) log(LOG_DEBUG, fmt, ##__VA_ARGS__); 0; })
198 #define pr_devel(fmt, ...) \
199 	({ if (0) log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__); 0; })
200 #endif
201 
202 #ifndef pr_fmt
203 #define pr_fmt(fmt) fmt
204 #endif
205 
206 /*
207  * Print a one-time message (analogous to WARN_ONCE() et al):
208  */
209 #define printk_once(...) do {			\
210 	static bool __print_once;		\
211 						\
212 	if (!__print_once) {			\
213 		__print_once = true;		\
214 		printk(__VA_ARGS__);		\
215 	}					\
216 } while (0)
217 
218 /*
219  * Log a one-time message (analogous to WARN_ONCE() et al):
220  */
221 #define log_once(level,...) do {		\
222 	static bool __log_once;			\
223 						\
224 	if (unlikely(!__log_once)) {		\
225 		__log_once = true;		\
226 		log(level, __VA_ARGS__);	\
227 	}					\
228 } while (0)
229 
230 #define pr_emerg(fmt, ...) \
231 	log(LOG_EMERG, pr_fmt(fmt), ##__VA_ARGS__)
232 #define pr_alert(fmt, ...) \
233 	log(LOG_ALERT, pr_fmt(fmt), ##__VA_ARGS__)
234 #define pr_crit(fmt, ...) \
235 	log(LOG_CRIT, pr_fmt(fmt), ##__VA_ARGS__)
236 #define pr_err(fmt, ...) \
237 	log(LOG_ERR, pr_fmt(fmt), ##__VA_ARGS__)
238 #define pr_warning(fmt, ...) \
239 	log(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__)
240 #define pr_warn(...) \
241 	pr_warning(__VA_ARGS__)
242 #define pr_warn_once(fmt, ...) \
243 	log_once(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__)
244 #define pr_notice(fmt, ...) \
245 	log(LOG_NOTICE, pr_fmt(fmt), ##__VA_ARGS__)
246 #define pr_info(fmt, ...) \
247 	log(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__)
248 #define pr_info_once(fmt, ...) \
249 	log_once(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__)
250 #define pr_cont(fmt, ...) \
251 	printk(KERN_CONT fmt, ##__VA_ARGS__)
252 #define	pr_warn_ratelimited(...) do {		\
253 	static linux_ratelimit_t __ratelimited;	\
254 	if (linux_ratelimited(&__ratelimited))	\
255 		pr_warning(__VA_ARGS__);	\
256 } while (0)
257 
258 #ifndef WARN
259 #define	WARN(condition, ...) ({			\
260 	bool __ret_warn_on = (condition);	\
261 	if (unlikely(__ret_warn_on))		\
262 		pr_warning(__VA_ARGS__);	\
263 	unlikely(__ret_warn_on);		\
264 })
265 #endif
266 
267 #ifndef WARN_ONCE
268 #define	WARN_ONCE(condition, ...) ({		\
269 	bool __ret_warn_on = (condition);	\
270 	if (unlikely(__ret_warn_on))		\
271 		pr_warn_once(__VA_ARGS__);	\
272 	unlikely(__ret_warn_on);		\
273 })
274 #endif
275 
276 #define container_of(ptr, type, member)				\
277 ({								\
278 	const __typeof(((type *)0)->member) *__p = (ptr);	\
279 	(type *)((uintptr_t)__p - offsetof(type, member));	\
280 })
281 
282 #define	ARRAY_SIZE(x)	(sizeof(x) / sizeof((x)[0]))
283 
284 #define	u64_to_user_ptr(val)	((void *)(uintptr_t)(val))
285 
286 static inline unsigned long long
287 simple_strtoull(const char *cp, char **endp, unsigned int base)
288 {
289 	return (strtouq(cp, endp, base));
290 }
291 
292 static inline long long
293 simple_strtoll(const char *cp, char **endp, unsigned int base)
294 {
295 	return (strtoq(cp, endp, base));
296 }
297 
298 static inline unsigned long
299 simple_strtoul(const char *cp, char **endp, unsigned int base)
300 {
301 	return (strtoul(cp, endp, base));
302 }
303 
304 static inline long
305 simple_strtol(const char *cp, char **endp, unsigned int base)
306 {
307 	return (strtol(cp, endp, base));
308 }
309 
310 static inline int
311 kstrtoul(const char *cp, unsigned int base, unsigned long *res)
312 {
313 	char *end;
314 
315 	*res = strtoul(cp, &end, base);
316 
317 	/* skip newline character, if any */
318 	if (*end == '\n')
319 		end++;
320 	if (*cp == 0 || *end != 0)
321 		return (-EINVAL);
322 	return (0);
323 }
324 
325 static inline int
326 kstrtol(const char *cp, unsigned int base, long *res)
327 {
328 	char *end;
329 
330 	*res = strtol(cp, &end, base);
331 
332 	/* skip newline character, if any */
333 	if (*end == '\n')
334 		end++;
335 	if (*cp == 0 || *end != 0)
336 		return (-EINVAL);
337 	return (0);
338 }
339 
340 static inline int
341 kstrtoint(const char *cp, unsigned int base, int *res)
342 {
343 	char *end;
344 	long temp;
345 
346 	*res = temp = 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 	if (temp != (int)temp)
354 		return (-ERANGE);
355 	return (0);
356 }
357 
358 static inline int
359 kstrtouint(const char *cp, unsigned int base, unsigned int *res)
360 {
361 	char *end;
362 	unsigned long temp;
363 
364 	*res = temp = strtoul(cp, &end, base);
365 
366 	/* skip newline character, if any */
367 	if (*end == '\n')
368 		end++;
369 	if (*cp == 0 || *end != 0)
370 		return (-EINVAL);
371 	if (temp != (unsigned int)temp)
372 		return (-ERANGE);
373 	return (0);
374 }
375 
376 static inline int
377 kstrtou16(const char *cp, unsigned int base, u16 *res)
378 {
379 	char *end;
380 	unsigned long temp;
381 
382 	*res = temp = strtoul(cp, &end, base);
383 
384 	/* skip newline character, if any */
385 	if (*end == '\n')
386 		end++;
387 	if (*cp == 0 || *end != 0)
388 		return (-EINVAL);
389 	if (temp != (u16)temp)
390 		return (-ERANGE);
391 	return (0);
392 }
393 
394 static inline int
395 kstrtou32(const char *cp, unsigned int base, u32 *res)
396 {
397 	char *end;
398 	unsigned long temp;
399 
400 	*res = temp = strtoul(cp, &end, base);
401 
402 	/* skip newline character, if any */
403 	if (*end == '\n')
404 		end++;
405 	if (*cp == 0 || *end != 0)
406 		return (-EINVAL);
407 	if (temp != (u32)temp)
408 		return (-ERANGE);
409 	return (0);
410 }
411 
412 static inline int
413 kstrtou64(const char *cp, unsigned int base, u64 *res)
414 {
415        char *end;
416 
417        *res = strtouq(cp, &end, base);
418 
419        /* skip newline character, if any */
420        if (*end == '\n')
421                end++;
422        if (*cp == 0 || *end != 0)
423                return (-EINVAL);
424        return (0);
425 }
426 
427 static inline int
428 kstrtobool(const char *s, bool *res)
429 {
430 	int len;
431 
432 	if (s == NULL || (len = strlen(s)) == 0 || res == NULL)
433 		return (-EINVAL);
434 
435 	/* skip newline character, if any */
436 	if (s[len - 1] == '\n')
437 		len--;
438 
439 	if (len == 1 && strchr("yY1", s[0]) != NULL)
440 		*res = true;
441 	else if (len == 1 && strchr("nN0", s[0]) != NULL)
442 		*res = false;
443 	else if (strncasecmp("on", s, len) == 0)
444 		*res = true;
445 	else if (strncasecmp("off", s, len) == 0)
446 		*res = false;
447 	else
448 		return (-EINVAL);
449 
450 	return (0);
451 }
452 
453 static inline int
454 kstrtobool_from_user(const char __user *s, size_t count, bool *res)
455 {
456 	char buf[8] = {};
457 
458 	if (count > (sizeof(buf) - 1))
459 		count = (sizeof(buf) - 1);
460 
461 	if (copy_from_user(buf, s, count))
462 		return (-EFAULT);
463 
464 	return (kstrtobool(buf, res));
465 }
466 
467 #define min(x, y)	((x) < (y) ? (x) : (y))
468 #define max(x, y)	((x) > (y) ? (x) : (y))
469 
470 #define min3(a, b, c)	min(a, min(b,c))
471 #define max3(a, b, c)	max(a, max(b,c))
472 
473 #define	min_t(type, x, y) ({			\
474 	type __min1 = (x);			\
475 	type __min2 = (y);			\
476 	__min1 < __min2 ? __min1 : __min2; })
477 
478 #define	max_t(type, x, y) ({			\
479 	type __max1 = (x);			\
480 	type __max2 = (y);			\
481 	__max1 > __max2 ? __max1 : __max2; })
482 
483 #define offsetofend(t, m)	\
484         (offsetof(t, m) + sizeof((((t *)0)->m)))
485 
486 #define clamp_t(type, _x, min, max)	min_t(type, max_t(type, _x, min), max)
487 #define clamp(x, lo, hi)		min( max(x,lo), hi)
488 #define	clamp_val(val, lo, hi) clamp_t(typeof(val), val, lo, hi)
489 
490 /*
491  * This looks more complex than it should be. But we need to
492  * get the type for the ~ right in round_down (it needs to be
493  * as wide as the result!), and we want to evaluate the macro
494  * arguments just once each.
495  */
496 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
497 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
498 #define round_down(x, y) ((x) & ~__round_mask(x, y))
499 
500 #define	smp_processor_id()	PCPU_GET(cpuid)
501 #define	num_possible_cpus()	mp_ncpus
502 #define	num_online_cpus()	mp_ncpus
503 
504 #if defined(__i386__) || defined(__amd64__)
505 extern bool linux_cpu_has_clflush;
506 #define	cpu_has_clflush		linux_cpu_has_clflush
507 #endif
508 
509 typedef struct pm_message {
510 	int event;
511 } pm_message_t;
512 
513 /* Swap values of a and b */
514 #define swap(a, b) do {			\
515 	typeof(a) _swap_tmp = a;	\
516 	a = b;				\
517 	b = _swap_tmp;			\
518 } while (0)
519 
520 #define	DIV_ROUND_CLOSEST(x, divisor)	(((x) + ((divisor) / 2)) / (divisor))
521 
522 #define	DIV_ROUND_CLOSEST_ULL(x, divisor) ({		\
523 	__typeof(divisor) __d = (divisor);		\
524 	unsigned long long __ret = (x) + (__d) / 2;	\
525 	__ret /= __d;					\
526 	__ret;						\
527 })
528 
529 static inline uintmax_t
530 mult_frac(uintmax_t x, uintmax_t multiplier, uintmax_t divisor)
531 {
532 	uintmax_t q = (x / divisor);
533 	uintmax_t r = (x % divisor);
534 
535 	return ((q * multiplier) + ((r * multiplier) / divisor));
536 }
537 
538 static inline int64_t
539 abs64(int64_t x)
540 {
541 	return (x < 0 ? -x : x);
542 }
543 
544 typedef struct linux_ratelimit {
545 	struct timeval lasttime;
546 	int counter;
547 } linux_ratelimit_t;
548 
549 static inline bool
550 linux_ratelimited(linux_ratelimit_t *rl)
551 {
552 	return (ppsratecheck(&rl->lasttime, &rl->counter, 1));
553 }
554 
555 #define	struct_size(ptr, field, num) ({ \
556 	const size_t __size = offsetof(__typeof(*(ptr)), field); \
557 	const size_t __max = (SIZE_MAX - __size) / sizeof((ptr)->field[0]); \
558 	((num) > __max) ? SIZE_MAX : (__size + sizeof((ptr)->field[0]) * (num)); \
559 })
560 
561 #define	__is_constexpr(x) \
562 	__builtin_constant_p(x)
563 
564 /*
565  * The is_signed() macro below returns true if the passed data type is
566  * signed. Else false is returned.
567  */
568 #define	is_signed(datatype) (((datatype)-1 / (datatype)2) == (datatype)0)
569 
570 /*
571  * The type_max() macro below returns the maxium positive value the
572  * passed data type can hold.
573  */
574 #define	type_max(datatype) ( \
575   (sizeof(datatype) >= 8) ? (is_signed(datatype) ? INT64_MAX : UINT64_MAX) : \
576   (sizeof(datatype) >= 4) ? (is_signed(datatype) ? INT32_MAX : UINT32_MAX) : \
577   (sizeof(datatype) >= 2) ? (is_signed(datatype) ? INT16_MAX : UINT16_MAX) : \
578 			    (is_signed(datatype) ? INT8_MAX : UINT8_MAX) \
579 )
580 
581 /*
582  * The type_min() macro below returns the minimum value the passed
583  * data type can hold. For unsigned types the minimum value is always
584  * zero. For signed types it may vary.
585  */
586 #define	type_min(datatype) ( \
587   (sizeof(datatype) >= 8) ? (is_signed(datatype) ? INT64_MIN : 0) : \
588   (sizeof(datatype) >= 4) ? (is_signed(datatype) ? INT32_MIN : 0) : \
589   (sizeof(datatype) >= 2) ? (is_signed(datatype) ? INT16_MIN : 0) : \
590 			    (is_signed(datatype) ? INT8_MIN : 0) \
591 )
592 
593 #define	TAINT_WARN	0
594 #define	test_taint(x)	(0)
595 
596 #endif	/* _LINUX_KERNEL_H_ */
597