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
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.
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]
22 /* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
23 /* All Rights Reserved */
27 * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
28 * Use is subject to license terms.
31 #ifndef _SYS_SYSMACROS_H
32 #define _SYS_SYSMACROS_H
34 #pragma ident "%Z%%M% %I% %E% SMI"
36 #include <sys/param.h>
43 * Some macros for units conversion
46 * Disk blocks (sectors) and bytes.
48 #define dtob(DD) ((DD) << DEV_BSHIFT)
49 #define btod(BB) (((BB) + DEV_BSIZE - 1) >> DEV_BSHIFT)
50 #define btodt(BB) ((BB) >> DEV_BSHIFT)
51 #define lbtod(BB) (((offset_t)(BB) + DEV_BSIZE - 1) >> DEV_BSHIFT)
55 #define MIN(a, b) ((a) < (b) ? (a) : (b))
58 #define MAX(a, b) ((a) < (b) ? (b) : (a))
61 #define ABS(a) ((a) < 0 ? -(a) : (a))
67 * Convert a single byte to/from binary-coded decimal (BCD).
69 extern unsigned char byte_to_bcd[256];
70 extern unsigned char bcd_to_byte[256];
72 #define BYTE_TO_BCD(x) byte_to_bcd[(x) & 0xff]
73 #define BCD_TO_BYTE(x) bcd_to_byte[(x) & 0xff]
78 * WARNING: The device number macros defined here should not be used by device
79 * drivers or user software. Device drivers should use the device functions
80 * defined in the DDI/DKI interface (see also ddi.h). Application software
81 * should make use of the library routines available in makedev(3). A set of
82 * new device macros are provided to operate on the expanded device number
83 * format supported in SVR4. Macro versions of the DDI device functions are
84 * provided for use by kernel proper routines only. Macro routines bmajor(),
85 * major(), minor(), emajor(), eminor(), and makedev() will be removed or
86 * their definitions changed at the next major release following SVR4.
89 #define O_BITSMAJOR 7 /* # of SVR3 major device bits */
90 #define O_BITSMINOR 8 /* # of SVR3 minor device bits */
91 #define O_MAXMAJ 0x7f /* SVR3 max major value */
92 #define O_MAXMIN 0xff /* SVR3 max minor value */
95 #define L_BITSMAJOR32 14 /* # of SVR4 major device bits */
96 #define L_BITSMINOR32 18 /* # of SVR4 minor device bits */
97 #define L_MAXMAJ32 0x3fff /* SVR4 max major value */
98 #define L_MAXMIN32 0x3ffff /* MAX minor for 3b2 software drivers. */
99 /* For 3b2 hardware devices the minor is */
100 /* restricted to 256 (0-255) */
103 #define L_BITSMAJOR 32 /* # of major device bits in 64-bit Solaris */
104 #define L_BITSMINOR 32 /* # of minor device bits in 64-bit Solaris */
105 #define L_MAXMAJ 0xfffffffful /* max major value */
106 #define L_MAXMIN 0xfffffffful /* max minor value */
108 #define L_BITSMAJOR L_BITSMAJOR32
109 #define L_BITSMINOR L_BITSMINOR32
110 #define L_MAXMAJ L_MAXMAJ32
111 #define L_MAXMIN L_MAXMIN32
116 /* major part of a device internal to the kernel */
118 #define major(x) (major_t)((((unsigned)(x)) >> O_BITSMINOR) & O_MAXMAJ)
119 #define bmajor(x) (major_t)((((unsigned)(x)) >> O_BITSMINOR) & O_MAXMAJ)
121 /* get internal major part of expanded device number */
123 #define getmajor(x) (major_t)((((dev_t)(x)) >> L_BITSMINOR) & L_MAXMAJ)
125 /* minor part of a device internal to the kernel */
127 #define minor(x) (minor_t)((x) & O_MAXMIN)
129 /* get internal minor part of expanded device number */
131 #define getminor(x) (minor_t)((x) & L_MAXMIN)
135 /* major part of a device external from the kernel (same as emajor below) */
137 #define major(x) (major_t)((((unsigned)(x)) >> O_BITSMINOR) & O_MAXMAJ)
139 /* minor part of a device external from the kernel (same as eminor below) */
141 #define minor(x) (minor_t)((x) & O_MAXMIN)
145 /* create old device number */
147 #define makedev(x, y) (unsigned short)(((x) << O_BITSMINOR) | ((y) & O_MAXMIN))
149 /* make an new device number */
151 #define makedevice(x, y) (dev_t)(((dev_t)(x) << L_BITSMINOR) | ((y) & L_MAXMIN))
155 * emajor() allows kernel/driver code to print external major numbers
156 * eminor() allows kernel/driver code to print external minor numbers
160 (major_t)(((unsigned int)(x) >> O_BITSMINOR) > O_MAXMAJ) ? \
161 NODEV : (((unsigned int)(x) >> O_BITSMINOR) & O_MAXMAJ)
164 (minor_t)((x) & O_MAXMIN)
167 * get external major and minor device
168 * components from expanded device number
170 #define getemajor(x) (major_t)((((dev_t)(x) >> L_BITSMINOR) > L_MAXMAJ) ? \
171 NODEV : (((dev_t)(x) >> L_BITSMINOR) & L_MAXMAJ))
172 #define geteminor(x) (minor_t)((x) & L_MAXMIN)
175 * These are versions of the kernel routines for compressing and
176 * expanding long device numbers that don't return errors.
178 #if (L_BITSMAJOR32 == L_BITSMAJOR) && (L_BITSMINOR32 == L_BITSMINOR)
180 #define DEVCMPL(x) (x)
181 #define DEVEXPL(x) (x)
186 (dev32_t)((((x) >> L_BITSMINOR) > L_MAXMAJ32 || \
187 ((x) & L_MAXMIN) > L_MAXMIN32) ? NODEV32 : \
188 ((((x) >> L_BITSMINOR) << L_BITSMINOR32) | ((x) & L_MAXMIN32)))
191 (((x) == NODEV32) ? NODEV : \
192 makedevice(((x) >> L_BITSMINOR32) & L_MAXMAJ32, (x) & L_MAXMIN32))
194 #endif /* L_BITSMAJOR32 ... */
196 /* convert to old (SVR3.2) dev format */
199 (o_dev_t)((((x) >> L_BITSMINOR) > O_MAXMAJ || \
200 ((x) & L_MAXMIN) > O_MAXMIN) ? NODEV : \
201 ((((x) >> L_BITSMINOR) << O_BITSMINOR) | ((x) & O_MAXMIN)))
203 /* convert to new (SVR4) dev format */
206 (dev_t)(((dev_t)(((x) >> O_BITSMINOR) & O_MAXMAJ) << L_BITSMINOR) | \
210 * Macro for checking power of 2 address alignment.
212 #define IS_P2ALIGNED(v, a) ((((uintptr_t)(v)) & ((uintptr_t)(a) - 1)) == 0)
215 * Macros for counting and rounding.
217 #define howmany(x, y) (((x)+((y)-1))/(y))
218 #define roundup(x, y) ((((x)+((y)-1))/(y))*(y))
221 * Macro to determine if value is a power of 2
223 #define ISP2(x) (((x) & ((x) - 1)) == 0)
226 * Macros for various sorts of alignment and rounding when the alignment
227 * is known to be a power of 2.
229 #define P2ALIGN(x, align) ((x) & -(align))
230 #define P2PHASE(x, align) ((x) & ((align) - 1))
231 #define P2NPHASE(x, align) (-(x) & ((align) - 1))
232 #define P2ROUNDUP(x, align) (-(-(x) & -(align)))
233 #define P2END(x, align) (-(~(x) & -(align)))
234 #define P2PHASEUP(x, align, phase) ((phase) - (((phase) - (x)) & -(align)))
235 #define P2CROSS(x, y, align) (((x) ^ (y)) > (align) - 1)
237 * Determine whether two numbers have the same high-order bit.
239 #define P2SAMEHIGHBIT(x, y) (((x) ^ (y)) < ((x) & (y)))
242 * Typed version of the P2* macros. These macros should be used to ensure
243 * that the result is correctly calculated based on the data type of (x),
244 * which is passed in as the last argument, regardless of the data
245 * type of the alignment. For example, if (x) is of type uint64_t,
246 * and we want to round it up to a page boundary using "PAGESIZE" as
247 * the alignment, we can do either
248 * P2ROUNDUP(x, (uint64_t)PAGESIZE)
250 * P2ROUNDUP_TYPED(x, PAGESIZE, uint64_t)
252 #define P2ALIGN_TYPED(x, align, type) \
253 ((type)(x) & -(type)(align))
254 #define P2PHASE_TYPED(x, align, type) \
255 ((type)(x) & ((type)(align) - 1))
256 #define P2NPHASE_TYPED(x, align, type) \
257 (-(type)(x) & ((type)(align) - 1))
258 #define P2ROUNDUP_TYPED(x, align, type) \
259 (-(-(type)(x) & -(type)(align)))
260 #define P2END_TYPED(x, align, type) \
261 (-(~(type)(x) & -(type)(align)))
262 #define P2PHASEUP_TYPED(x, align, phase, type) \
263 ((type)(phase) - (((type)(phase) - (type)(x)) & -(type)(align)))
264 #define P2CROSS_TYPED(x, y, align, type) \
265 (((type)(x) ^ (type)(y)) > (type)(align) - 1)
266 #define P2SAMEHIGHBIT_TYPED(x, y, type) \
267 (((type)(x) ^ (type)(y)) < ((type)(x) & (type)(y)))
270 * Macros to atomically increment/decrement a variable. mutex and var
273 #define INCR_COUNT(var, mutex) mutex_enter(mutex), (*(var))++, mutex_exit(mutex)
274 #define DECR_COUNT(var, mutex) mutex_enter(mutex), (*(var))--, mutex_exit(mutex)
276 #if defined(_KERNEL) && !defined(_KMEMUSER) && !defined(offsetof)
278 /* avoid any possibility of clashing with <stddef.h> version */
280 #define offsetof(s, m) ((size_t)(&(((s *)0)->m)))
287 #endif /* _SYS_SYSMACROS_H */