[mirror_spl.git] / include / sys / sysmacros.h

/*
 *  Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
 *  Copyright (C) 2007 The Regents of the University of California.
 *  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
 *  Written by Brian Behlendorf <behlendorf1@llnl.gov>.
 *  UCRL-CODE-235197
 *
 *  This file is part of the SPL, Solaris Porting Layer.
 *  For details, see <http://zfsonlinux.org/>.
 *
 *  The SPL is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by the
 *  Free Software Foundation; either version 2 of the License, or (at your
 *  option) any later version.
 *
 *  The SPL is distributed in the hope that it will be useful, but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 *  for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with the SPL.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _SPL_SYSMACROS_H
#define	_SPL_SYSMACROS_H

#include <linux/module.h>
#include <linux/sched.h>
#include <linux/cpumask.h>
#include <sys/debug.h>
#include <sys/varargs.h>
#include <sys/zone.h>
#include <sys/signal.h>
#include <asm/page.h>

#ifdef HAVE_SCHED_RT_HEADER
#include <linux/sched/rt.h>
#endif

#ifndef _KERNEL
#define	_KERNEL				__KERNEL__
#endif

#define	FALSE				0
#define	TRUE				1

#define	INT8_MAX			(127)
#define	INT8_MIN			(-128)
#define	UINT8_MAX			(255)
#define	UINT8_MIN			(0)

#define	INT16_MAX			(32767)
#define	INT16_MIN			(-32768)
#define	UINT16_MAX			(65535)
#define	UINT16_MIN			(0)

#define	INT32_MAX			INT_MAX
#define	INT32_MIN			INT_MIN
#define	UINT32_MAX			UINT_MAX
#define	UINT32_MIN			UINT_MIN

#define	INT64_MAX			LLONG_MAX
#define	INT64_MIN			LLONG_MIN
#define	UINT64_MAX			ULLONG_MAX
#define	UINT64_MIN			ULLONG_MIN

#define	NBBY				8
#define	ENOTSUP				EOPNOTSUPP

#define	MAXMSGLEN			256
#define	MAXNAMELEN			256
#define	MAXPATHLEN			PATH_MAX
#define	MAXOFFSET_T			LLONG_MAX
#define	MAXBSIZE			8192
#define	DEV_BSIZE			512
#define	DEV_BSHIFT			9 /* log2(DEV_BSIZE) */

#define	proc_pageout			NULL
#define	curproc				current
#define	max_ncpus			num_possible_cpus()
#define	boot_ncpus			num_online_cpus()
#define	CPU_SEQID			smp_processor_id()
#define	_NOTE(x)
#define	is_system_labeled()		0

#ifndef RLIM64_INFINITY
#define	RLIM64_INFINITY			(~0ULL)
#endif

/*
 * 0..MAX_PRIO-1:		Process priority
 * 0..MAX_RT_PRIO-1:		RT priority tasks
 * MAX_RT_PRIO..MAX_PRIO-1:	SCHED_NORMAL tasks
 *
 * Treat shim tasks as SCHED_NORMAL tasks
 */
#define	minclsyspri			(MAX_PRIO-1)
#define	maxclsyspri			(MAX_RT_PRIO)
#define	defclsyspri			(DEFAULT_PRIO)

#ifndef NICE_TO_PRIO
#define	NICE_TO_PRIO(nice)		(MAX_RT_PRIO + (nice) + 20)
#endif
#ifndef PRIO_TO_NICE
#define	PRIO_TO_NICE(prio)		((prio) - MAX_RT_PRIO - 20)
#endif

/*
 * Missing macros
 */
#ifndef PAGESIZE
#define	PAGESIZE			PAGE_SIZE
#endif

#ifndef PAGESHIFT
#define	PAGESHIFT			PAGE_SHIFT
#endif

/* from Solaris sys/byteorder.h */
#define	BSWAP_8(x)	((x) & 0xff)
#define	BSWAP_16(x)	((BSWAP_8(x) << 8) | BSWAP_8((x) >> 8))
#define	BSWAP_32(x)	((BSWAP_16(x) << 16) | BSWAP_16((x) >> 16))
#define	BSWAP_64(x)	((BSWAP_32(x) << 32) | BSWAP_32((x) >> 32))

/*
 * Map some simple functions.
 */
#define	bzero(ptr, size)		memset(ptr, 0, size)
#define	bcopy(src, dest, size)		memmove(dest, src, size)
#define	bcmp(src, dest, size)		memcmp((src), (dest), (size_t)(size))

/* Dtrace probes do not exist in the linux kernel */
#ifdef DTRACE_PROBE
#undef  DTRACE_PROBE
#endif  /* DTRACE_PROBE */
#define	DTRACE_PROBE(a)					((void)0)

#ifdef DTRACE_PROBE1
#undef  DTRACE_PROBE1
#endif  /* DTRACE_PROBE1 */
#define	DTRACE_PROBE1(a, b, c)				((void)0)

#ifdef DTRACE_PROBE2
#undef  DTRACE_PROBE2
#endif  /* DTRACE_PROBE2 */
#define	DTRACE_PROBE2(a, b, c, d, e)			((void)0)

#ifdef DTRACE_PROBE3
#undef  DTRACE_PROBE3
#endif  /* DTRACE_PROBE3 */
#define	DTRACE_PROBE3(a, b, c, d, e, f, g)		((void)0)

#ifdef DTRACE_PROBE4
#undef  DTRACE_PROBE4
#endif  /* DTRACE_PROBE4 */
#define	DTRACE_PROBE4(a, b, c, d, e, f, g, h, i)	((void)0)

/* Missing globals */
extern char spl_version[32];
extern unsigned long spl_hostid;

/* Missing misc functions */
extern uint32_t zone_get_hostid(void *zone);
extern void spl_setup(void);
extern void spl_cleanup(void);

#define	highbit(x)		__fls(x)
#define	lowbit(x)		__ffs(x)

#define	highbit64(x)		fls64(x)
#define	makedevice(maj, min)	makedev(maj, min)

/* common macros */
#ifndef MIN
#define	MIN(a, b)		((a) < (b) ? (a) : (b))
#endif
#ifndef MAX
#define	MAX(a, b)		((a) < (b) ? (b) : (a))
#endif
#ifndef ABS
#define	ABS(a)			((a) < 0 ? -(a) : (a))
#endif
#ifndef DIV_ROUND_UP
#define	DIV_ROUND_UP(n, d)	(((n) + (d) - 1) / (d))
#endif
#ifndef roundup
#define	roundup(x, y)		((((x) + ((y) - 1)) / (y)) * (y))
#endif
#ifndef howmany
#define	howmany(x, y)		(((x) + ((y) - 1)) / (y))
#endif

/*
 * Compatibility macros/typedefs needed for Solaris -> Linux port
 */
#define	P2ALIGN(x, align)	((x) & -(align))
#define	P2CROSS(x, y, align)	(((x) ^ (y)) > (align) - 1)
#define	P2ROUNDUP(x, align)	((((x) - 1) | ((align) - 1)) + 1)
#define	P2PHASE(x, align)	((x) & ((align) - 1))
#define	P2NPHASE(x, align)	(-(x) & ((align) - 1))
#define	ISP2(x)			(((x) & ((x) - 1)) == 0)
#define	IS_P2ALIGNED(v, a)	((((uintptr_t)(v)) & ((uintptr_t)(a) - 1)) == 0)
#define	P2BOUNDARY(off, len, align) \
				(((off) ^ ((off) + (len) - 1)) > (align) - 1)

/*
 * Typed version of the P2* macros.  These macros should be used to ensure
 * that the result is correctly calculated based on the data type of (x),
 * which is passed in as the last argument, regardless of the data
 * type of the alignment.  For example, if (x) is of type uint64_t,
 * and we want to round it up to a page boundary using "PAGESIZE" as
 * the alignment, we can do either
 *
 * P2ROUNDUP(x, (uint64_t)PAGESIZE)
 * or
 * P2ROUNDUP_TYPED(x, PAGESIZE, uint64_t)
 */
#define	P2ALIGN_TYPED(x, align, type)   \
	((type)(x) & -(type)(align))
#define	P2PHASE_TYPED(x, align, type)   \
	((type)(x) & ((type)(align) - 1))
#define	P2NPHASE_TYPED(x, align, type)  \
	(-(type)(x) & ((type)(align) - 1))
#define	P2ROUNDUP_TYPED(x, align, type) \
	((((type)(x) - 1) | ((type)(align) - 1)) + 1)
#define	P2END_TYPED(x, align, type)     \
	(-(~(type)(x) & -(type)(align)))
#define	P2PHASEUP_TYPED(x, align, phase, type)  \
	((type)(phase) - (((type)(phase) - (type)(x)) & -(type)(align)))
#define	P2CROSS_TYPED(x, y, align, type)	\
	(((type)(x) ^ (type)(y)) > (type)(align) - 1)
#define	P2SAMEHIGHBIT_TYPED(x, y, type) \
	(((type)(x) ^ (type)(y)) < ((type)(x) & (type)(y)))

#if defined(_KERNEL) && !defined(_KMEMUSER) && !defined(offsetof)

/* avoid any possibility of clashing with <stddef.h> version */

#define	offsetof(s, m)  ((size_t)(&(((s *)0)->m)))
#endif

#endif  /* _SPL_SYSMACROS_H */
Commit	Line	Data
4b393c50	1	/*
716154c5 BB	2	* Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
	3	* Copyright (C) 2007 The Regents of the University of California.
	4	* Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
	5	* Written by Brian Behlendorf <behlendorf1@llnl.gov>.
715f6251	6	* UCRL-CODE-235197
715f6251	7	*
716154c5	8	* This file is part of the SPL, Solaris Porting Layer.
3d6af2dd	9	* For details, see <http://zfsonlinux.org/>.
716154c5 BB	10	*
	11	* The SPL is free software; you can redistribute it and/or modify it
	12	* under the terms of the GNU General Public License as published by the
	13	* Free Software Foundation; either version 2 of the License, or (at your
	14	* option) any later version.
715f6251	15	*
716154c5	16	* The SPL is distributed in the hope that it will be useful, but WITHOUT
715f6251	17	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	18	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	19	* for more details.
	20	*
	21	* You should have received a copy of the GNU General Public License along
716154c5	22	* with the SPL. If not, see <http://www.gnu.org/licenses/>.
4b393c50	23	*/
715f6251	24
14c5326c	25	#ifndef _SPL_SYSMACROS_H
5461eefe	26	#define _SPL_SYSMACROS_H
14c5326c	27
14c5326c	28	#include <linux/module.h>
10087fe1	29	#include <linux/sched.h>
15b52c08	30	#include <linux/cpumask.h>
57d1b188	31	#include <sys/debug.h>
05ae387b	32	#include <sys/varargs.h>
36e6f861	33	#include <sys/zone.h>
1ec74a11	34	#include <sys/signal.h>
43b857fd	35	#include <asm/page.h>
14c5326c	36
10087fe1 RY	37	#ifdef HAVE_SCHED_RT_HEADER
	38	#include <linux/sched/rt.h>
	39	#endif
	40
14c5326c	41	#ifndef _KERNEL
5461eefe	42	#define _KERNEL __KERNEL__
14c5326c	43	#endif
14c5326c	44
5461eefe BB	45	#define FALSE 0
	46	#define TRUE 1
	47
	48	#define INT8_MAX (127)
	49	#define INT8_MIN (-128)
	50	#define UINT8_MAX (255)
	51	#define UINT8_MIN (0)
	52
	53	#define INT16_MAX (32767)
	54	#define INT16_MIN (-32768)
	55	#define UINT16_MAX (65535)
	56	#define UINT16_MIN (0)
	57
	58	#define INT32_MAX INT_MAX
	59	#define INT32_MIN INT_MIN
	60	#define UINT32_MAX UINT_MAX
	61	#define UINT32_MIN UINT_MIN
	62
	63	#define INT64_MAX LLONG_MAX
	64	#define INT64_MIN LLONG_MIN
	65	#define UINT64_MAX ULLONG_MAX
	66	#define UINT64_MIN ULLONG_MIN
	67
	68	#define NBBY 8
	69	#define ENOTSUP EOPNOTSUPP
	70
	71	#define MAXMSGLEN 256
	72	#define MAXNAMELEN 256
	73	#define MAXPATHLEN PATH_MAX
	74	#define MAXOFFSET_T LLONG_MAX
	75	#define MAXBSIZE 8192
	76	#define DEV_BSIZE 512
	77	#define DEV_BSHIFT 9 /* log2(DEV_BSIZE) */
	78
	79	#define proc_pageout NULL
	80	#define curproc current
	81	#define max_ncpus num_possible_cpus()
	82	#define boot_ncpus num_online_cpus()
	83	#define CPU_SEQID smp_processor_id()
	84	#define _NOTE(x)
	85	#define is_system_labeled() 0
14c5326c	86
a50cede3	87	#ifndef RLIM64_INFINITY
5461eefe	88	#define RLIM64_INFINITY (~0ULL)
a50cede3	89	#endif
6adf99e7	90
5461eefe BB	91	/*
5461eefe BB	92	* 0..MAX_PRIO-1: Process priority
14c5326c	93	* 0..MAX_RT_PRIO-1: RT priority tasks
	94	* MAX_RT_PRIO..MAX_PRIO-1: SCHED_NORMAL tasks
	95	*
	96	* Treat shim tasks as SCHED_NORMAL tasks
	97	*/
5461eefe BB	98	#define minclsyspri (MAX_PRIO-1)
	99	#define maxclsyspri (MAX_RT_PRIO)
	100	#define defclsyspri (DEFAULT_PRIO)
14c5326c	101
1538f4b6	102	#ifndef NICE_TO_PRIO
5461eefe	103	#define NICE_TO_PRIO(nice) (MAX_RT_PRIO + (nice) + 20)
1538f4b6 CC	104	#endif
1538f4b6 CC	105	#ifndef PRIO_TO_NICE
5461eefe	106	#define PRIO_TO_NICE(prio) ((prio) - MAX_RT_PRIO - 20)
1538f4b6	107	#endif
14c5326c	108
f9bde4f7	109	/*
f9bde4f7	110	* Missing macros
14c5326c	111	*/
f9bde4f7	112	#ifndef PAGESIZE
5461eefe	113	#define PAGESIZE PAGE_SIZE
f9bde4f7	114	#endif
14c5326c	115
43b857fd	116	#ifndef PAGESHIFT
5461eefe	117	#define PAGESHIFT PAGE_SHIFT
43b857fd DQ	118	#endif
43b857fd DQ	119
14c5326c	120	/* from Solaris sys/byteorder.h */
5461eefe BB	121	#define BSWAP_8(x) ((x) & 0xff)
	122	#define BSWAP_16(x) ((BSWAP_8(x) << 8) \| BSWAP_8((x) >> 8))
	123	#define BSWAP_32(x) ((BSWAP_16(x) << 16) \| BSWAP_16((x) >> 16))
	124	#define BSWAP_64(x) ((BSWAP_32(x) << 32) \| BSWAP_32((x) >> 32))
14c5326c	125
5461eefe BB	126	/*
5461eefe BB	127	* Map some simple functions.
14c5326c	128	*/
5461eefe BB	129	#define bzero(ptr, size) memset(ptr, 0, size)
	130	#define bcopy(src, dest, size) memmove(dest, src, size)
	131	#define bcmp(src, dest, size) memcmp((src), (dest), (size_t)(size))
a713518f	132
a713518f	133	/* Dtrace probes do not exist in the linux kernel */
0f372044 BB	134	#ifdef DTRACE_PROBE
	135	#undef DTRACE_PROBE
	136	#endif /* DTRACE_PROBE */
5461eefe	137	#define DTRACE_PROBE(a) ((void)0)
a713518f	138
	139	#ifdef DTRACE_PROBE1
	140	#undef DTRACE_PROBE1
	141	#endif /* DTRACE_PROBE1 */
5461eefe	142	#define DTRACE_PROBE1(a, b, c) ((void)0)
a713518f	143
	144	#ifdef DTRACE_PROBE2
	145	#undef DTRACE_PROBE2
	146	#endif /* DTRACE_PROBE2 */
5461eefe	147	#define DTRACE_PROBE2(a, b, c, d, e) ((void)0)
a713518f	148
	149	#ifdef DTRACE_PROBE3
	150	#undef DTRACE_PROBE3
	151	#endif /* DTRACE_PROBE3 */
5461eefe	152	#define DTRACE_PROBE3(a, b, c, d, e, f, g) ((void)0)
a713518f	153
	154	#ifdef DTRACE_PROBE4
	155	#undef DTRACE_PROBE4
	156	#endif /* DTRACE_PROBE4 */
5461eefe	157	#define DTRACE_PROBE4(a, b, c, d, e, f, g, h, i) ((void)0)
14c5326c	158
77b1fe8f	159	/* Missing globals */
0835057e	160	extern char spl_version[32];
fa6f7d8f	161	extern unsigned long spl_hostid;
14c5326c	162
77b1fe8f	163	/* Missing misc functions */
99639e4a	164	extern uint32_t zone_get_hostid(void *zone);
51a727e9 BB	165	extern void spl_setup(void);
51a727e9 BB	166	extern void spl_cleanup(void);
77b1fe8f	167
d2f97b2a TC	168	#define highbit(x) __fls(x)
	169	#define lowbit(x) __ffs(x)
	170
87f8055a	171	#define highbit64(x) fls64(x)
5461eefe	172	#define makedevice(maj, min) makedev(maj, min)
14c5326c	173
14c5326c	174	/* common macros */
14c5326c	175	#ifndef MIN
5461eefe	176	#define MIN(a, b) ((a) < (b) ? (a) : (b))
14c5326c	177	#endif
14c5326c	178	#ifndef MAX
5461eefe	179	#define MAX(a, b) ((a) < (b) ? (b) : (a))
14c5326c	180	#endif
14c5326c	181	#ifndef ABS
5461eefe	182	#define ABS(a) ((a) < 0 ? -(a) : (a))
37319315 BB	183	#endif
37319315 BB	184	#ifndef DIV_ROUND_UP
5461eefe	185	#define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
37319315 BB	186	#endif
37319315 BB	187	#ifndef roundup
5461eefe	188	#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
14c5326c	189	#endif
7f23e001	190	#ifndef howmany
5461eefe	191	#define howmany(x, y) (((x) + ((y) - 1)) / (y))
7f23e001	192	#endif
14c5326c	193
	194	/*
	195	* Compatibility macros/typedefs needed for Solaris -> Linux port
	196	*/
5461eefe BB	197	#define P2ALIGN(x, align) ((x) & -(align))
	198	#define P2CROSS(x, y, align) (((x) ^ (y)) > (align) - 1)
	199	#define P2ROUNDUP(x, align) ((((x) - 1) \| ((align) - 1)) + 1)
	200	#define P2PHASE(x, align) ((x) & ((align) - 1))
	201	#define P2NPHASE(x, align) (-(x) & ((align) - 1))
	202	#define ISP2(x) (((x) & ((x) - 1)) == 0)
	203	#define IS_P2ALIGNED(v, a) ((((uintptr_t)(v)) & ((uintptr_t)(a) - 1)) == 0)
	204	#define P2BOUNDARY(off, len, align) \
32c6147d	205	(((off) ^ ((off) + (len) - 1)) > (align) - 1)
14c5326c	206
	207	/*
	208	* Typed version of the P2* macros. These macros should be used to ensure
	209	* that the result is correctly calculated based on the data type of (x),
	210	* which is passed in as the last argument, regardless of the data
	211	* type of the alignment. For example, if (x) is of type uint64_t,
	212	* and we want to round it up to a page boundary using "PAGESIZE" as
	213	* the alignment, we can do either
32c6147d	214	*
14c5326c	215	* P2ROUNDUP(x, (uint64_t)PAGESIZE)
	216	* or
	217	* P2ROUNDUP_TYPED(x, PAGESIZE, uint64_t)
	218	*/
5461eefe BB	219	#define P2ALIGN_TYPED(x, align, type) \
	220	((type)(x) & -(type)(align))
	221	#define P2PHASE_TYPED(x, align, type) \
	222	((type)(x) & ((type)(align) - 1))
	223	#define P2NPHASE_TYPED(x, align, type) \
	224	(-(type)(x) & ((type)(align) - 1))
	225	#define P2ROUNDUP_TYPED(x, align, type) \
	226	((((type)(x) - 1) \| ((type)(align) - 1)) + 1)
	227	#define P2END_TYPED(x, align, type) \
	228	(-(~(type)(x) & -(type)(align)))
	229	#define P2PHASEUP_TYPED(x, align, phase, type) \
	230	((type)(phase) - (((type)(phase) - (type)(x)) & -(type)(align)))
	231	#define P2CROSS_TYPED(x, y, align, type) \
	232	(((type)(x) ^ (type)(y)) > (type)(align) - 1)
	233	#define P2SAMEHIGHBIT_TYPED(x, y, type) \
	234	(((type)(x) ^ (type)(y)) < ((type)(x) & (type)(y)))
14c5326c	235
	236	#if defined(_KERNEL) && !defined(_KMEMUSER) && !defined(offsetof)
	237
	238	/* avoid any possibility of clashing with <stddef.h> version */
	239
5461eefe	240	#define offsetof(s, m) ((size_t)(&(((s *)0)->m)))
14c5326c	241	#endif
14c5326c	242
14c5326c	243	#endif /* _SPL_SYSMACROS_H */