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