sys/cddl/contrib/opensolaris/uts/common/sys/sysmacros.h

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