[mirror_zfs.git] / lib / libspl / include / sys / sysmacros.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef _LIBSPL_SYS_SYSMACROS_H
#define	_LIBSPL_SYS_SYSMACROS_H

#include_next <sys/sysmacros.h>

/* 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

#define	makedevice(maj, min)	makedev(maj, min)
#define	_sysconf(a)		sysconf(a)
#define	__NORETURN		__attribute__((noreturn))

/*
 * 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) & -(align)))
#define	P2ROUNDUP_TYPED(x, align, type) \
				(-(-(type)(x) & -(type)(align)))
#define	P2BOUNDARY(off, len, align) \
				(((off) ^ ((off) + (len) - 1)) > (align) - 1)
#define	P2PHASE(x, align)	((x) & ((align) - 1))
#define	P2NPHASE(x, align)	(-(x) & ((align) - 1))
#define	P2NPHASE_TYPED(x, align, type) \
				(-(type)(x) & ((type)(align) - 1))
#define	ISP2(x)			(((x) & ((x) - 1)) == 0)
#define	IS_P2ALIGNED(v, a)	((((uintptr_t)(v)) & ((uintptr_t)(a) - 1)) == 0)

/*
 * 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) & -(type)(align)))
#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)))


/* avoid any possibility of clashing with <stddef.h> version */
#if defined(_KERNEL) && !defined(_KMEMUSER) && !defined(offsetof)
#define	offsetof(s, m)	((size_t)(&(((s *)0)->m)))
#endif

#endif /* _LIBSPL_SYS_SYSMACROS_H */
Commit	Line	Data
a26baf28 BB	1	/*
	2	* CDDL HEADER START
	3	*
	4	* The contents of this file are subject to the terms of the
	5	* Common Development and Distribution License, Version 1.0 only
	6	* (the "License"). You may not use this file except in compliance
	7	* with the License.
	8	*
	9	* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
	10	* or http://www.opensolaris.org/os/licensing.
	11	* See the License for the specific language governing permissions
	12	* and limitations under the License.
	13	*
	14	* When distributing Covered Code, include this CDDL HEADER in each
	15	* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
	16	* If applicable, add the following below this CDDL HEADER, with the
	17	* fields enclosed by brackets "[]" replaced with your own identifying
	18	* information: Portions Copyright [yyyy] [name of copyright owner]
	19	*
	20	* CDDL HEADER END
	21	*/
	22	/*
	23	* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
	24	* Use is subject to license terms.
	25	*/
	26
	27	#ifndef _LIBSPL_SYS_SYSMACROS_H
d1d7e268	28	#define _LIBSPL_SYS_SYSMACROS_H
a26baf28 BB	29
	30	#include_next <sys/sysmacros.h>
	31
	32	/* common macros */
	33	#ifndef MIN
d1d7e268	34	#define MIN(a, b) ((a) < (b) ? (a) : (b))
a26baf28 BB	35	#endif
a26baf28 BB	36	#ifndef MAX
d1d7e268	37	#define MAX(a, b) ((a) < (b) ? (b) : (a))
a26baf28 BB	38	#endif
a26baf28 BB	39	#ifndef ABS
d1d7e268	40	#define ABS(a) ((a) < 0 ? -(a) : (a))
a26baf28 BB	41	#endif
a26baf28 BB	42
d1d7e268 MK	43	#define makedevice(maj, min) makedev(maj, min)
	44	#define _sysconf(a) sysconf(a)
	45	#define __NORETURN __attribute__((noreturn))
a26baf28 BB	46
	47	/*
	48	* Compatibility macros/typedefs needed for Solaris -> Linux port
	49	*/
d1d7e268 MK	50	#define P2ALIGN(x, align) ((x) & -(align))
	51	#define P2CROSS(x, y, align) (((x) ^ (y)) > (align) - 1)
	52	#define P2ROUNDUP(x, align) (-(-(x) & -(align)))
	53	#define P2ROUNDUP_TYPED(x, align, type) \
a26baf28	54	(-(-(type)(x) & -(type)(align)))
d1d7e268	55	#define P2BOUNDARY(off, len, align) \
a26baf28	56	(((off) ^ ((off) + (len) - 1)) > (align) - 1)
d1d7e268 MK	57	#define P2PHASE(x, align) ((x) & ((align) - 1))
	58	#define P2NPHASE(x, align) (-(x) & ((align) - 1))
	59	#define P2NPHASE_TYPED(x, align, type) \
a26baf28	60	(-(type)(x) & ((type)(align) - 1))
d1d7e268 MK	61	#define ISP2(x) (((x) & ((x) - 1)) == 0)
d1d7e268 MK	62	#define IS_P2ALIGNED(v, a) ((((uintptr_t)(v)) & ((uintptr_t)(a) - 1)) == 0)
a26baf28 BB	63
	64	/*
	65	* Typed version of the P2* macros. These macros should be used to ensure
	66	* that the result is correctly calculated based on the data type of (x),
	67	* which is passed in as the last argument, regardless of the data
	68	* type of the alignment. For example, if (x) is of type uint64_t,
	69	* and we want to round it up to a page boundary using "PAGESIZE" as
	70	* the alignment, we can do either
	71	* P2ROUNDUP(x, (uint64_t)PAGESIZE)
	72	* or
	73	* P2ROUNDUP_TYPED(x, PAGESIZE, uint64_t)
	74	*/
d1d7e268 MK	75	#define P2ALIGN_TYPED(x, align, type) \
	76	((type)(x) & -(type)(align))
	77	#define P2PHASE_TYPED(x, align, type) \
	78	((type)(x) & ((type)(align) - 1))
	79	#define P2NPHASE_TYPED(x, align, type) \
	80	(-(type)(x) & ((type)(align) - 1))
	81	#define P2ROUNDUP_TYPED(x, align, type) \
	82	(-(-(type)(x) & -(type)(align)))
	83	#define P2END_TYPED(x, align, type) \
	84	(-(~(type)(x) & -(type)(align)))
	85	#define P2PHASEUP_TYPED(x, align, phase, type) \
	86	((type)(phase) - (((type)(phase) - (type)(x)) & -(type)(align)))
	87	#define P2CROSS_TYPED(x, y, align, type) \
	88	(((type)(x) ^ (type)(y)) > (type)(align) - 1)
	89	#define P2SAMEHIGHBIT_TYPED(x, y, type) \
	90	(((type)(x) ^ (type)(y)) < ((type)(x) & (type)(y)))
a26baf28 BB	91
	92
	93	/* avoid any possibility of clashing with <stddef.h> version */
	94	#if defined(_KERNEL) && !defined(_KMEMUSER) && !defined(offsetof)
	95	#define offsetof(s, m) ((size_t)(&(((s *)0)->m)))
	96	#endif
	97
	98	#endif /* _LIBSPL_SYS_SYSMACROS_H */