sys/sys/endian.h

   1 /*-
   2  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
   3  *
   4  * Copyright (c) 2002 Thomas Moestl <tmm@FreeBSD.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD: src/sys/sys/endian.h,v 1.2.2.1 2002/09/09 05:45:04 imp Exp $
  29  */
  30
  31 #ifndef _SYS_ENDIAN_H_
  32 #define _SYS_ENDIAN_H_
  33
  34 #ifndef _SYS_TYPES_H_
  35 #include <sys/types.h>
  36 #endif
  37 #include <machine/endian.h>
  38
  39 /*
  40  * General byte order swapping functions.
  41  */
  42 #define bswap16(x)      __bswap16(x)
  43 #define bswap32(x)      __bswap32(x)
  44 #define bswap64(x)      __bswap64(x)
  45
  46 /*
  47  * Host to big endian, host to little endian, big endian to host, and little
  48  * endian to host byte order functions as detailed in byteorder(9).
  49  */
  50 #if _BYTE_ORDER == _LITTLE_ENDIAN
  51 #define htobe16(x)      bswap16((x))
  52 #define htobe32(x)      bswap32((x))
  53 #define htobe64(x)      bswap64((x))
  54 #define htole16(x)      ((uint16_t)(x))
  55 #define htole32(x)      ((uint32_t)(x))
  56 #define htole64(x)      ((uint64_t)(x))
  57
  58 #define be16toh(x)      bswap16((x))
  59 #define be32toh(x)      bswap32((x))
  60 #define be64toh(x)      bswap64((x))
  61 #define le16toh(x)      ((uint16_t)(x))
  62 #define le32toh(x)      ((uint32_t)(x))
  63 #define le64toh(x)      ((uint64_t)(x))
  64 #else /* _BYTE_ORDER != _LITTLE_ENDIAN */
  65 #define htobe16(x)      ((uint16_t)(x))
  66 #define htobe32(x)      ((uint32_t)(x))
  67 #define htobe64(x)      ((uint64_t)(x))
  68 #define htole16(x)      bswap16((x))
  69 #define htole32(x)      bswap32((x))
  70 #define htole64(x)      bswap64((x))
  71
  72 #define be16toh(x)      ((uint16_t)(x))
  73 #define be32toh(x)      ((uint32_t)(x))
  74 #define be64toh(x)      ((uint64_t)(x))
  75 #define le16toh(x)      bswap16((x))
  76 #define le32toh(x)      bswap32((x))
  77 #define le64toh(x)      bswap64((x))
  78 #endif /* _BYTE_ORDER == _LITTLE_ENDIAN */
  79
  80 /* Alignment-agnostic encode/decode bytestream to/from little/big endian. */
  81
  82 static __inline uint16_t
  83 be16dec(const void *pp)
  84 {
  85         const uint8_t *p = (const uint8_t *)pp;
  86
  87         return ((p[0] << 8) | p[1]);
  88 }
  89
  90 static __inline uint32_t
  91 be32dec(const void *pp)
  92 {
  93         const uint8_t *p = (const uint8_t *)pp;
  94
  95         return ((p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3]);
  96 }
  97
  98 static __inline uint64_t
  99 be64dec(const void *pp)
 100 {
 101         const uint8_t *p = (const uint8_t *)pp;
 102
 103         return (((uint64_t)be32dec(p) << 32) | be32dec(p + 4));
 104 }
 105
 106 static __inline uint16_t
 107 le16dec(const void *pp)
 108 {
 109         const uint8_t *p = (const uint8_t *)pp;
 110
 111         return ((p[1] << 8) | p[0]);
 112 }
 113
 114 static __inline uint32_t
 115 le32dec(const void *pp)
 116 {
 117         const uint8_t *p = (const uint8_t *)pp;
 118
 119         return ((p[3] << 24) | (p[2] << 16) | (p[1] << 8) | p[0]);
 120 }
 121
 122 static __inline uint64_t
 123 le64dec(const void *pp)
 124 {
 125         const uint8_t *p = (const uint8_t *)pp;
 126
 127         return (((uint64_t)le32dec(p + 4) << 32) | le32dec(p));
 128 }
 129
 130 static __inline void
 131 be16enc(void *pp, uint16_t u)
 132 {
 133         uint8_t *p = (uint8_t *)pp;
 134
 135         p[0] = (u >> 8) & 0xff;
 136         p[1] = u & 0xff;
 137 }
 138
 139 static __inline void
 140 be32enc(void *pp, uint32_t u)
 141 {
 142         uint8_t *p = (uint8_t *)pp;
 143
 144         p[0] = (u >> 24) & 0xff;
 145         p[1] = (u >> 16) & 0xff;
 146         p[2] = (u >> 8) & 0xff;
 147         p[3] = u & 0xff;
 148 }
 149
 150 static __inline void
 151 be64enc(void *pp, uint64_t u)
 152 {
 153         uint8_t *p = (uint8_t *)pp;
 154
 155         be32enc(p, u >> 32);
 156         be32enc(p + 4, u & 0xffffffff);
 157 }
 158
 159 static __inline void
 160 le16enc(void *pp, uint16_t u)
 161 {
 162         uint8_t *p = (uint8_t *)pp;
 163
 164         p[0] = u & 0xff;
 165         p[1] = (u >> 8) & 0xff;
 166 }
 167
 168 static __inline void
 169 le32enc(void *pp, uint32_t u)
 170 {
 171         uint8_t *p = (uint8_t *)pp;
 172
 173         p[0] = u & 0xff;
 174         p[1] = (u >> 8) & 0xff;
 175         p[2] = (u >> 16) & 0xff;
 176         p[3] = (u >> 24) & 0xff;
 177 }
 178
 179 static __inline void
 180 le64enc(void *pp, uint64_t u)
 181 {
 182         uint8_t *p = (uint8_t *)pp;
 183
 184         le32enc(p, u & 0xffffffff);
 185         le32enc(p + 4, u >> 32);
 186 }
 187
 188 #endif  /* _SYS_ENDIAN_H_ */