Print this page
6136 sysmacros.h unnecessarily polutes the namespace
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/uts/common/sys/sysmacros.h
+++ new/usr/src/uts/common/sys/sysmacros.h
1 1 /*
2 2 * CDDL HEADER START
3 3 *
4 4 * The contents of this file are subject to the terms of the
5 5 * Common Development and Distribution License (the "License").
6 6 * You may not use this file except in compliance with the License.
7 7 *
8 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 9 * or http://www.opensolaris.org/os/licensing.
10 10 * See the License for the specific language governing permissions
11 11 * and limitations under the License.
12 12 *
13 13 * When distributing Covered Code, include this CDDL HEADER in each
14 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 15 * If applicable, add the following below this CDDL HEADER, with the
16 16 * fields enclosed by brackets "[]" replaced with your own identifying
17 17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 18 *
19 19 * CDDL HEADER END
20 20 */
21 21 /* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
22 22 /* All Rights Reserved */
23 23
24 24
25 25 /*
26 26 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
27 27 * Use is subject to license terms.
28 28 *
29 29 * Copyright 2013 Nexenta Systems, Inc. All rights reserved.
30 30 */
31 31
32 32 #ifndef _SYS_SYSMACROS_H
33 33 #define _SYS_SYSMACROS_H
34 34
35 35 #include <sys/param.h>
36 36
37 37 #ifdef __cplusplus
38 38 extern "C" {
39 39 #endif
40 40
41 41 /*
42 42 * Some macros for units conversion
43 43 */
44 44 /*
45 45 * Disk blocks (sectors) and bytes.
46 46 */
47 47 #define dtob(DD) ((DD) << DEV_BSHIFT)
48 48 #define btod(BB) (((BB) + DEV_BSIZE - 1) >> DEV_BSHIFT)
49 49 #define btodt(BB) ((BB) >> DEV_BSHIFT)
50 50 #define lbtod(BB) (((offset_t)(BB) + DEV_BSIZE - 1) >> DEV_BSHIFT)
51 51
52 52 /* common macros */
53 53 #ifndef MIN
54 54 #define MIN(a, b) ((a) < (b) ? (a) : (b))
55 55 #endif
56 56 #ifndef MAX
57 57 #define MAX(a, b) ((a) < (b) ? (b) : (a))
58 58 #endif
59 59 #ifndef ABS
60 60 #define ABS(a) ((a) < 0 ? -(a) : (a))
61 61 #endif
62 62 #ifndef SIGNOF
63 63 #define SIGNOF(a) ((a) < 0 ? -1 : (a) > 0)
64 64 #endif
65 65
66 66 #ifdef _KERNEL
67 67
68 68 /*
69 69 * Convert a single byte to/from binary-coded decimal (BCD).
70 70 */
71 71 extern unsigned char byte_to_bcd[256];
72 72 extern unsigned char bcd_to_byte[256];
73 73
74 74 #define BYTE_TO_BCD(x) byte_to_bcd[(x) & 0xff]
75 75 #define BCD_TO_BYTE(x) bcd_to_byte[(x) & 0xff]
|
↓ open down ↓ |
75 lines elided |
↑ open up ↑ |
76 76
77 77 #endif /* _KERNEL */
78 78
79 79 /*
80 80 * WARNING: The device number macros defined here should not be used by device
81 81 * drivers or user software. Device drivers should use the device functions
82 82 * defined in the DDI/DKI interface (see also ddi.h). Application software
83 83 * should make use of the library routines available in makedev(3). A set of
84 84 * new device macros are provided to operate on the expanded device number
85 85 * format supported in SVR4. Macro versions of the DDI device functions are
86 - * provided for use by kernel proper routines only. Macro routines bmajor(),
87 - * major(), minor(), emajor(), eminor(), and makedev() will be removed or
88 - * their definitions changed at the next major release following SVR4.
86 + * provided for use by kernel proper routines only.
89 87 */
90 88
91 89 #define O_BITSMAJOR 7 /* # of SVR3 major device bits */
92 90 #define O_BITSMINOR 8 /* # of SVR3 minor device bits */
93 91 #define O_MAXMAJ 0x7f /* SVR3 max major value */
94 92 #define O_MAXMIN 0xff /* SVR3 max minor value */
95 93
96 94
97 95 #define L_BITSMAJOR32 14 /* # of SVR4 major device bits */
98 96 #define L_BITSMINOR32 18 /* # of SVR4 minor device bits */
99 97 #define L_MAXMAJ32 0x3fff /* SVR4 max major value */
100 98 #define L_MAXMIN32 0x3ffff /* MAX minor for 3b2 software drivers. */
101 99 /* For 3b2 hardware devices the minor is */
102 100 /* restricted to 256 (0-255) */
103 101
104 102 #ifdef _LP64
105 103 #define L_BITSMAJOR 32 /* # of major device bits in 64-bit Solaris */
106 104 #define L_BITSMINOR 32 /* # of minor device bits in 64-bit Solaris */
107 105 #define L_MAXMAJ 0xfffffffful /* max major value */
|
↓ open down ↓ |
9 lines elided |
↑ open up ↑ |
108 106 #define L_MAXMIN 0xfffffffful /* max minor value */
109 107 #else
110 108 #define L_BITSMAJOR L_BITSMAJOR32
111 109 #define L_BITSMINOR L_BITSMINOR32
112 110 #define L_MAXMAJ L_MAXMAJ32
113 111 #define L_MAXMIN L_MAXMIN32
114 112 #endif
115 113
116 114 #ifdef _KERNEL
117 115
118 -/* major part of a device internal to the kernel */
119 -
120 -#define major(x) (major_t)((((unsigned)(x)) >> O_BITSMINOR) & O_MAXMAJ)
121 -#define bmajor(x) (major_t)((((unsigned)(x)) >> O_BITSMINOR) & O_MAXMAJ)
122 -
123 116 /* get internal major part of expanded device number */
124 117
125 118 #define getmajor(x) (major_t)((((dev_t)(x)) >> L_BITSMINOR) & L_MAXMAJ)
126 119
127 -/* minor part of a device internal to the kernel */
128 -
129 -#define minor(x) (minor_t)((x) & O_MAXMIN)
130 -
131 120 /* get internal minor part of expanded device number */
132 121
133 122 #define getminor(x) (minor_t)((x) & L_MAXMIN)
134 123
135 -#else /* _KERNEL */
136 -
137 -/* major part of a device external from the kernel (same as emajor below) */
138 -
139 -#define major(x) (major_t)((((unsigned)(x)) >> O_BITSMINOR) & O_MAXMAJ)
140 -
141 -/* minor part of a device external from the kernel (same as eminor below) */
142 -
143 -#define minor(x) (minor_t)((x) & O_MAXMIN)
144 -
145 124 #endif /* _KERNEL */
146 125
147 -/* create old device number */
148 -
149 -#define makedev(x, y) (unsigned short)(((x) << O_BITSMINOR) | ((y) & O_MAXMIN))
150 -
151 126 /* make an new device number */
152 127
153 128 #define makedevice(x, y) (dev_t)(((dev_t)(x) << L_BITSMINOR) | ((y) & L_MAXMIN))
154 -
155 -
156 -/*
157 - * emajor() allows kernel/driver code to print external major numbers
158 - * eminor() allows kernel/driver code to print external minor numbers
159 - */
160 -
161 -#define emajor(x) \
162 - (major_t)(((unsigned int)(x) >> O_BITSMINOR) > O_MAXMAJ) ? \
163 - NODEV : (((unsigned int)(x) >> O_BITSMINOR) & O_MAXMAJ)
164 -
165 -#define eminor(x) \
166 - (minor_t)((x) & O_MAXMIN)
167 129
168 130 /*
169 131 * get external major and minor device
170 132 * components from expanded device number
171 133 */
172 134 #define getemajor(x) (major_t)((((dev_t)(x) >> L_BITSMINOR) > L_MAXMAJ) ? \
173 135 NODEV : (((dev_t)(x) >> L_BITSMINOR) & L_MAXMAJ))
174 136 #define geteminor(x) (minor_t)((x) & L_MAXMIN)
175 137
176 138 /*
177 139 * These are versions of the kernel routines for compressing and
178 140 * expanding long device numbers that don't return errors.
179 141 */
180 142 #if (L_BITSMAJOR32 == L_BITSMAJOR) && (L_BITSMINOR32 == L_BITSMINOR)
181 143
182 144 #define DEVCMPL(x) (x)
183 145 #define DEVEXPL(x) (x)
184 146
185 147 #else
186 148
187 149 #define DEVCMPL(x) \
188 150 (dev32_t)((((x) >> L_BITSMINOR) > L_MAXMAJ32 || \
189 151 ((x) & L_MAXMIN) > L_MAXMIN32) ? NODEV32 : \
190 152 ((((x) >> L_BITSMINOR) << L_BITSMINOR32) | ((x) & L_MAXMIN32)))
191 153
192 154 #define DEVEXPL(x) \
193 155 (((x) == NODEV32) ? NODEV : \
194 156 makedevice(((x) >> L_BITSMINOR32) & L_MAXMAJ32, (x) & L_MAXMIN32))
195 157
196 158 #endif /* L_BITSMAJOR32 ... */
197 159
198 160 /* convert to old (SVR3.2) dev format */
199 161
200 162 #define cmpdev(x) \
201 163 (o_dev_t)((((x) >> L_BITSMINOR) > O_MAXMAJ || \
202 164 ((x) & L_MAXMIN) > O_MAXMIN) ? NODEV : \
203 165 ((((x) >> L_BITSMINOR) << O_BITSMINOR) | ((x) & O_MAXMIN)))
204 166
205 167 /* convert to new (SVR4) dev format */
206 168
207 169 #define expdev(x) \
208 170 (dev_t)(((dev_t)(((x) >> O_BITSMINOR) & O_MAXMAJ) << L_BITSMINOR) | \
209 171 ((x) & O_MAXMIN))
210 172
211 173 /*
212 174 * Macro for checking power of 2 address alignment.
213 175 */
214 176 #define IS_P2ALIGNED(v, a) ((((uintptr_t)(v)) & ((uintptr_t)(a) - 1)) == 0)
215 177
216 178 /*
217 179 * Macros for counting and rounding.
218 180 */
219 181 #define howmany(x, y) (((x)+((y)-1))/(y))
220 182 #define roundup(x, y) ((((x)+((y)-1))/(y))*(y))
221 183
222 184 /*
223 185 * Macro to determine if value is a power of 2
224 186 */
225 187 #define ISP2(x) (((x) & ((x) - 1)) == 0)
226 188
227 189 /*
228 190 * Macros for various sorts of alignment and rounding. The "align" must
229 191 * be a power of 2. Often times it is a block, sector, or page.
230 192 */
231 193
232 194 /*
233 195 * return x rounded down to an align boundary
234 196 * eg, P2ALIGN(1200, 1024) == 1024 (1*align)
235 197 * eg, P2ALIGN(1024, 1024) == 1024 (1*align)
236 198 * eg, P2ALIGN(0x1234, 0x100) == 0x1200 (0x12*align)
237 199 * eg, P2ALIGN(0x5600, 0x100) == 0x5600 (0x56*align)
238 200 */
239 201 #define P2ALIGN(x, align) ((x) & -(align))
240 202
241 203 /*
242 204 * return x % (mod) align
243 205 * eg, P2PHASE(0x1234, 0x100) == 0x34 (x-0x12*align)
244 206 * eg, P2PHASE(0x5600, 0x100) == 0x00 (x-0x56*align)
245 207 */
246 208 #define P2PHASE(x, align) ((x) & ((align) - 1))
247 209
248 210 /*
249 211 * return how much space is left in this block (but if it's perfectly
250 212 * aligned, return 0).
251 213 * eg, P2NPHASE(0x1234, 0x100) == 0xcc (0x13*align-x)
252 214 * eg, P2NPHASE(0x5600, 0x100) == 0x00 (0x56*align-x)
253 215 */
254 216 #define P2NPHASE(x, align) (-(x) & ((align) - 1))
255 217
256 218 /*
257 219 * return x rounded up to an align boundary
258 220 * eg, P2ROUNDUP(0x1234, 0x100) == 0x1300 (0x13*align)
259 221 * eg, P2ROUNDUP(0x5600, 0x100) == 0x5600 (0x56*align)
260 222 */
261 223 #define P2ROUNDUP(x, align) (-(-(x) & -(align)))
262 224
263 225 /*
264 226 * return the ending address of the block that x is in
265 227 * eg, P2END(0x1234, 0x100) == 0x12ff (0x13*align - 1)
266 228 * eg, P2END(0x5600, 0x100) == 0x56ff (0x57*align - 1)
267 229 */
268 230 #define P2END(x, align) (-(~(x) & -(align)))
269 231
270 232 /*
271 233 * return x rounded up to the next phase (offset) within align.
272 234 * phase should be < align.
273 235 * eg, P2PHASEUP(0x1234, 0x100, 0x10) == 0x1310 (0x13*align + phase)
274 236 * eg, P2PHASEUP(0x5600, 0x100, 0x10) == 0x5610 (0x56*align + phase)
275 237 */
276 238 #define P2PHASEUP(x, align, phase) ((phase) - (((phase) - (x)) & -(align)))
277 239
278 240 /*
279 241 * return TRUE if adding len to off would cause it to cross an align
280 242 * boundary.
281 243 * eg, P2BOUNDARY(0x1234, 0xe0, 0x100) == TRUE (0x1234 + 0xe0 == 0x1314)
282 244 * eg, P2BOUNDARY(0x1234, 0x50, 0x100) == FALSE (0x1234 + 0x50 == 0x1284)
283 245 */
284 246 #define P2BOUNDARY(off, len, align) \
285 247 (((off) ^ ((off) + (len) - 1)) > (align) - 1)
286 248
287 249 /*
288 250 * Return TRUE if they have the same highest bit set.
289 251 * eg, P2SAMEHIGHBIT(0x1234, 0x1001) == TRUE (the high bit is 0x1000)
290 252 * eg, P2SAMEHIGHBIT(0x1234, 0x3010) == FALSE (high bit of 0x3010 is 0x2000)
291 253 */
292 254 #define P2SAMEHIGHBIT(x, y) (((x) ^ (y)) < ((x) & (y)))
293 255
294 256 /*
295 257 * Typed version of the P2* macros. These macros should be used to ensure
296 258 * that the result is correctly calculated based on the data type of (x),
297 259 * which is passed in as the last argument, regardless of the data
298 260 * type of the alignment. For example, if (x) is of type uint64_t,
299 261 * and we want to round it up to a page boundary using "PAGESIZE" as
300 262 * the alignment, we can do either
301 263 * P2ROUNDUP(x, (uint64_t)PAGESIZE)
302 264 * or
303 265 * P2ROUNDUP_TYPED(x, PAGESIZE, uint64_t)
304 266 */
305 267 #define P2ALIGN_TYPED(x, align, type) \
306 268 ((type)(x) & -(type)(align))
307 269 #define P2PHASE_TYPED(x, align, type) \
308 270 ((type)(x) & ((type)(align) - 1))
309 271 #define P2NPHASE_TYPED(x, align, type) \
310 272 (-(type)(x) & ((type)(align) - 1))
311 273 #define P2ROUNDUP_TYPED(x, align, type) \
312 274 (-(-(type)(x) & -(type)(align)))
313 275 #define P2END_TYPED(x, align, type) \
314 276 (-(~(type)(x) & -(type)(align)))
315 277 #define P2PHASEUP_TYPED(x, align, phase, type) \
316 278 ((type)(phase) - (((type)(phase) - (type)(x)) & -(type)(align)))
317 279 #define P2CROSS_TYPED(x, y, align, type) \
318 280 (((type)(x) ^ (type)(y)) > (type)(align) - 1)
319 281 #define P2SAMEHIGHBIT_TYPED(x, y, type) \
320 282 (((type)(x) ^ (type)(y)) < ((type)(x) & (type)(y)))
321 283
322 284 /*
323 285 * Macros to atomically increment/decrement a variable. mutex and var
324 286 * must be pointers.
325 287 */
326 288 #define INCR_COUNT(var, mutex) mutex_enter(mutex), (*(var))++, mutex_exit(mutex)
327 289 #define DECR_COUNT(var, mutex) mutex_enter(mutex), (*(var))--, mutex_exit(mutex)
328 290
329 291 /*
330 292 * Macros to declare bitfields - the order in the parameter list is
331 293 * Low to High - that is, declare bit 0 first. We only support 8-bit bitfields
332 294 * because if a field crosses a byte boundary it's not likely to be meaningful
333 295 * without reassembly in its nonnative endianness.
334 296 */
335 297 #if defined(_BIT_FIELDS_LTOH)
336 298 #define DECL_BITFIELD2(_a, _b) \
337 299 uint8_t _a, _b
338 300 #define DECL_BITFIELD3(_a, _b, _c) \
339 301 uint8_t _a, _b, _c
340 302 #define DECL_BITFIELD4(_a, _b, _c, _d) \
341 303 uint8_t _a, _b, _c, _d
342 304 #define DECL_BITFIELD5(_a, _b, _c, _d, _e) \
343 305 uint8_t _a, _b, _c, _d, _e
344 306 #define DECL_BITFIELD6(_a, _b, _c, _d, _e, _f) \
345 307 uint8_t _a, _b, _c, _d, _e, _f
346 308 #define DECL_BITFIELD7(_a, _b, _c, _d, _e, _f, _g) \
347 309 uint8_t _a, _b, _c, _d, _e, _f, _g
348 310 #define DECL_BITFIELD8(_a, _b, _c, _d, _e, _f, _g, _h) \
349 311 uint8_t _a, _b, _c, _d, _e, _f, _g, _h
350 312 #elif defined(_BIT_FIELDS_HTOL)
351 313 #define DECL_BITFIELD2(_a, _b) \
352 314 uint8_t _b, _a
353 315 #define DECL_BITFIELD3(_a, _b, _c) \
354 316 uint8_t _c, _b, _a
355 317 #define DECL_BITFIELD4(_a, _b, _c, _d) \
356 318 uint8_t _d, _c, _b, _a
357 319 #define DECL_BITFIELD5(_a, _b, _c, _d, _e) \
358 320 uint8_t _e, _d, _c, _b, _a
359 321 #define DECL_BITFIELD6(_a, _b, _c, _d, _e, _f) \
360 322 uint8_t _f, _e, _d, _c, _b, _a
361 323 #define DECL_BITFIELD7(_a, _b, _c, _d, _e, _f, _g) \
362 324 uint8_t _g, _f, _e, _d, _c, _b, _a
363 325 #define DECL_BITFIELD8(_a, _b, _c, _d, _e, _f, _g, _h) \
364 326 uint8_t _h, _g, _f, _e, _d, _c, _b, _a
365 327 #else
366 328 #error One of _BIT_FIELDS_LTOH or _BIT_FIELDS_HTOL must be defined
367 329 #endif /* _BIT_FIELDS_LTOH */
368 330
369 331 /* avoid any possibility of clashing with <stddef.h> version */
370 332 #if (defined(_KERNEL) || defined(_FAKE_KERNEL)) && !defined(_KMEMUSER)
371 333
372 334 #if !defined(offsetof)
373 335 #define offsetof(s, m) ((size_t)(&(((s *)0)->m)))
374 336 #endif /* !offsetof */
375 337
376 338 #define container_of(m, s, name) \
377 339 (void *)((uintptr_t)(m) - (uintptr_t)offsetof(s, name))
378 340
379 341 #define ARRAY_SIZE(x) (sizeof (x) / sizeof (x[0]))
380 342 #endif /* _KERNEL, !_KMEMUSER */
381 343
382 344 #ifdef __cplusplus
383 345 }
384 346 #endif
385 347
386 348 #endif /* _SYS_SYSMACROS_H */
|
↓ open down ↓ |
210 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX