kernel.h revision 339997 
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: stable/11/sys/compat/linuxkpi/common/include/linux/kernel.h 339997 2018-11-01 14:43:34Z hselasky $
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#define	BUG()			panic("BUG at %s:%d", __FILE__, __LINE__)
98#define	BUG_ON(cond)		do {				\
99	if (cond) {						\
100		panic("BUG ON %s failed at %s:%d",		\
101		    __stringify(cond), __FILE__, __LINE__);	\
102	}							\
103} while (0)
104
105#define	WARN_ON(cond) ({					\
106      bool __ret = (cond);					\
107      if (__ret) {						\
108		printf("WARNING %s failed at %s:%d\n",		\
109		    __stringify(cond), __FILE__, __LINE__);	\
110      }								\
111      unlikely(__ret);						\
112})
113
114#define	WARN_ON_SMP(cond)	WARN_ON(cond)
115
116#define	WARN_ON_ONCE(cond) ({					\
117      static bool __warn_on_once;				\
118      bool __ret = (cond);					\
119      if (__ret && !__warn_on_once) {				\
120		__warn_on_once = 1;				\
121		printf("WARNING %s failed at %s:%d\n",		\
122		    __stringify(cond), __FILE__, __LINE__);	\
123      }								\
124      unlikely(__ret);						\
125})
126
127#define	oops_in_progress	SCHEDULER_STOPPED()
128
129#undef	ALIGN
130#define	ALIGN(x, y)		roundup2((x), (y))
131#undef PTR_ALIGN
132#define	PTR_ALIGN(p, a)		((__typeof(p))ALIGN((uintptr_t)(p), (a)))
133#define	DIV_ROUND_UP(x, n)	howmany(x, n)
134#define	__KERNEL_DIV_ROUND_UP(x, n)	howmany(x, n)
135#define	DIV_ROUND_UP_ULL(x, n)	DIV_ROUND_UP((unsigned long long)(x), (n))
136#define	FIELD_SIZEOF(t, f)	sizeof(((t *)0)->f)
137
138#define	printk(...)		printf(__VA_ARGS__)
139#define	vprintk(f, a)		vprintf(f, a)
140
141struct va_format {
142	const char *fmt;
143	va_list *va;
144};
145
146static inline int
147vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
148{
149	ssize_t ssize = size;
150	int i;
151
152	i = vsnprintf(buf, size, fmt, args);
153
154	return ((i >= ssize) ? (ssize - 1) : i);
155}
156
157static inline int
158scnprintf(char *buf, size_t size, const char *fmt, ...)
159{
160	va_list args;
161	int i;
162
163	va_start(args, fmt);
164	i = vscnprintf(buf, size, fmt, args);
165	va_end(args);
166
167	return (i);
168}
169
170/*
171 * The "pr_debug()" and "pr_devel()" macros should produce zero code
172 * unless DEBUG is defined:
173 */
174#ifdef DEBUG
175#define pr_debug(fmt, ...) \
176	log(LOG_DEBUG, fmt, ##__VA_ARGS__)
177#define pr_devel(fmt, ...) \
178	log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__)
179#else
180#define pr_debug(fmt, ...) \
181	({ if (0) log(LOG_DEBUG, fmt, ##__VA_ARGS__); 0; })
182#define pr_devel(fmt, ...) \
183	({ if (0) log(LOG_DEBUG, pr_fmt(fmt), ##__VA_ARGS__); 0; })
184#endif
185
186#ifndef pr_fmt
187#define pr_fmt(fmt) fmt
188#endif
189
190/*
191 * Print a one-time message (analogous to WARN_ONCE() et al):
192 */
193#define printk_once(...) do {			\
194	static bool __print_once;		\
195						\
196	if (!__print_once) {			\
197		__print_once = true;		\
198		printk(__VA_ARGS__);		\
199	}					\
200} while (0)
201
202/*
203 * Log a one-time message (analogous to WARN_ONCE() et al):
204 */
205#define log_once(level,...) do {		\
206	static bool __log_once;			\
207						\
208	if (unlikely(!__log_once)) {		\
209		__log_once = true;		\
210		log(level, __VA_ARGS__);	\
211	}					\
212} while (0)
213
214#define pr_emerg(fmt, ...) \
215	log(LOG_EMERG, pr_fmt(fmt), ##__VA_ARGS__)
216#define pr_alert(fmt, ...) \
217	log(LOG_ALERT, pr_fmt(fmt), ##__VA_ARGS__)
218#define pr_crit(fmt, ...) \
219	log(LOG_CRIT, pr_fmt(fmt), ##__VA_ARGS__)
220#define pr_err(fmt, ...) \
221	log(LOG_ERR, pr_fmt(fmt), ##__VA_ARGS__)
222#define pr_warning(fmt, ...) \
223	log(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__)
224#define pr_warn(...) \
225	pr_warning(__VA_ARGS__)
226#define pr_warn_once(fmt, ...) \
227	log_once(LOG_WARNING, pr_fmt(fmt), ##__VA_ARGS__)
228#define pr_notice(fmt, ...) \
229	log(LOG_NOTICE, pr_fmt(fmt), ##__VA_ARGS__)
230#define pr_info(fmt, ...) \
231	log(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__)
232#define pr_info_once(fmt, ...) \
233	log_once(LOG_INFO, pr_fmt(fmt), ##__VA_ARGS__)
234#define pr_cont(fmt, ...) \
235	printk(KERN_CONT fmt, ##__VA_ARGS__)
236#define	pr_warn_ratelimited(...) do {		\
237	static linux_ratelimit_t __ratelimited;	\
238	if (linux_ratelimited(&__ratelimited))	\
239		pr_warning(__VA_ARGS__);	\
240} while (0)
241
242#ifndef WARN
243#define	WARN(condition, ...) ({			\
244	bool __ret_warn_on = (condition);	\
245	if (unlikely(__ret_warn_on))		\
246		pr_warning(__VA_ARGS__);	\
247	unlikely(__ret_warn_on);		\
248})
249#endif
250
251#ifndef WARN_ONCE
252#define	WARN_ONCE(condition, ...) ({		\
253	bool __ret_warn_on = (condition);	\
254	if (unlikely(__ret_warn_on))		\
255		pr_warn_once(__VA_ARGS__);	\
256	unlikely(__ret_warn_on);		\
257})
258#endif
259
260#define container_of(ptr, type, member)				\
261({								\
262	const __typeof(((type *)0)->member) *__p = (ptr);	\
263	(type *)((uintptr_t)__p - offsetof(type, member));	\
264})
265
266#define	ARRAY_SIZE(x)	(sizeof(x) / sizeof((x)[0]))
267
268#define	u64_to_user_ptr(val)	((void *)(uintptr_t)(val))
269
270static inline unsigned long long
271simple_strtoull(const char *cp, char **endp, unsigned int base)
272{
273	return (strtouq(cp, endp, base));
274}
275
276static inline long long
277simple_strtoll(const char *cp, char **endp, unsigned int base)
278{
279	return (strtoq(cp, endp, base));
280}
281
282static inline unsigned long
283simple_strtoul(const char *cp, char **endp, unsigned int base)
284{
285	return (strtoul(cp, endp, base));
286}
287
288static inline long
289simple_strtol(const char *cp, char **endp, unsigned int base)
290{
291	return (strtol(cp, endp, base));
292}
293
294static inline int
295kstrtoul(const char *cp, unsigned int base, unsigned long *res)
296{
297	char *end;
298
299	*res = strtoul(cp, &end, base);
300
301	/* skip newline character, if any */
302	if (*end == '\n')
303		end++;
304	if (*cp == 0 || *end != 0)
305		return (-EINVAL);
306	return (0);
307}
308
309static inline int
310kstrtol(const char *cp, unsigned int base, long *res)
311{
312	char *end;
313
314	*res = strtol(cp, &end, base);
315
316	/* skip newline character, if any */
317	if (*end == '\n')
318		end++;
319	if (*cp == 0 || *end != 0)
320		return (-EINVAL);
321	return (0);
322}
323
324static inline int
325kstrtoint(const char *cp, unsigned int base, int *res)
326{
327	char *end;
328	long temp;
329
330	*res = temp = 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	if (temp != (int)temp)
338		return (-ERANGE);
339	return (0);
340}
341
342static inline int
343kstrtouint(const char *cp, unsigned int base, unsigned int *res)
344{
345	char *end;
346	unsigned long temp;
347
348	*res = temp = strtoul(cp, &end, base);
349
350	/* skip newline character, if any */
351	if (*end == '\n')
352		end++;
353	if (*cp == 0 || *end != 0)
354		return (-EINVAL);
355	if (temp != (unsigned int)temp)
356		return (-ERANGE);
357	return (0);
358}
359
360static inline int
361kstrtou32(const char *cp, unsigned int base, u32 *res)
362{
363	char *end;
364	unsigned long temp;
365
366	*res = temp = strtoul(cp, &end, base);
367
368	/* skip newline character, if any */
369	if (*end == '\n')
370		end++;
371	if (*cp == 0 || *end != 0)
372		return (-EINVAL);
373	if (temp != (u32)temp)
374		return (-ERANGE);
375	return (0);
376}
377
378static inline int
379kstrtobool(const char *s, bool *res)
380{
381	int len;
382
383	if (s == NULL || (len = strlen(s)) == 0 || res == NULL)
384		return (-EINVAL);
385
386	/* skip newline character, if any */
387	if (s[len - 1] == '\n')
388		len--;
389
390	if (len == 1 && strchr("yY1", s[0]) != NULL)
391		*res = true;
392	else if (len == 1 && strchr("nN0", s[0]) != NULL)
393		*res = false;
394	else if (strncasecmp("on", s, len) == 0)
395		*res = true;
396	else if (strncasecmp("off", s, len) == 0)
397		*res = false;
398	else
399		return (-EINVAL);
400
401	return (0);
402}
403
404static inline int
405kstrtobool_from_user(const char __user *s, size_t count, bool *res)
406{
407	char buf[8] = {};
408
409	if (count > (sizeof(buf) - 1))
410		count = (sizeof(buf) - 1);
411
412	if (copy_from_user(buf, s, count))
413		return (-EFAULT);
414
415	return (kstrtobool(buf, res));
416}
417
418#define min(x, y)	((x) < (y) ? (x) : (y))
419#define max(x, y)	((x) > (y) ? (x) : (y))
420
421#define min3(a, b, c)	min(a, min(b,c))
422#define max3(a, b, c)	max(a, max(b,c))
423
424#define	min_t(type, x, y) ({			\
425	type __min1 = (x);			\
426	type __min2 = (y);			\
427	__min1 < __min2 ? __min1 : __min2; })
428
429#define	max_t(type, x, y) ({			\
430	type __max1 = (x);			\
431	type __max2 = (y);			\
432	__max1 > __max2 ? __max1 : __max2; })
433
434#define clamp_t(type, _x, min, max)	min_t(type, max_t(type, _x, min), max)
435#define clamp(x, lo, hi)		min( max(x,lo), hi)
436#define	clamp_val(val, lo, hi) clamp_t(typeof(val), val, lo, hi)
437
438/*
439 * This looks more complex than it should be. But we need to
440 * get the type for the ~ right in round_down (it needs to be
441 * as wide as the result!), and we want to evaluate the macro
442 * arguments just once each.
443 */
444#define __round_mask(x, y) ((__typeof__(x))((y)-1))
445#define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
446#define round_down(x, y) ((x) & ~__round_mask(x, y))
447
448#define	smp_processor_id()	PCPU_GET(cpuid)
449#define	num_possible_cpus()	mp_ncpus
450#define	num_online_cpus()	mp_ncpus
451
452#if defined(__i386__) || defined(__amd64__)
453extern bool linux_cpu_has_clflush;
454#define	cpu_has_clflush		linux_cpu_has_clflush
455#endif
456
457typedef struct pm_message {
458	int event;
459} pm_message_t;
460
461/* Swap values of a and b */
462#define swap(a, b) do {			\
463	typeof(a) _swap_tmp = a;	\
464	a = b;				\
465	b = _swap_tmp;			\
466} while (0)
467
468#define	DIV_ROUND_CLOSEST(x, divisor)	(((x) + ((divisor) / 2)) / (divisor))
469
470#define	DIV_ROUND_CLOSEST_ULL(x, divisor) ({		\
471	__typeof(divisor) __d = (divisor);		\
472	unsigned long long __ret = (x) + (__d) / 2;	\
473	__ret /= __d;					\
474	__ret;						\
475})
476
477static inline uintmax_t
478mult_frac(uintmax_t x, uintmax_t multiplier, uintmax_t divisor)
479{
480	uintmax_t q = (x / divisor);
481	uintmax_t r = (x % divisor);
482
483	return ((q * multiplier) + ((r * multiplier) / divisor));
484}
485
486static inline int64_t
487abs64(int64_t x)
488{
489	return (x < 0 ? -x : x);
490}
491
492typedef struct linux_ratelimit {
493	struct timeval lasttime;
494	int counter;
495} linux_ratelimit_t;
496
497static inline bool
498linux_ratelimited(linux_ratelimit_t *rl)
499{
500	return (ppsratecheck(&rl->lasttime, &rl->counter, 1));
501}
502
503#endif	/* _LINUX_KERNEL_H_ */
504