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  * $DragonFly: src/sys/sys/endian.h,v 1.4 2004/08/24 06:10:57 joerg Exp $
  30  */
  31
  32 #ifndef _SYS_ENDIAN_H_
  33 #define _SYS_ENDIAN_H_
  34
  35 #include <sys/types.h>
  36
  37 /*
  38  * General byte order swapping functions.
  39  */
  40 #define bswap16(x)      __bswap16(x)
  41 #define bswap32(x)      __bswap32(x)
  42 #define bswap64(x)      __bswap64(x)
  43
  44 /*
  45  * Host to big endian, host to little endian, big endian to host, and little
  46  * endian to host byte order functions as detailed in byteorder(9).
  47  */
  48 #if _BYTE_ORDER == _LITTLE_ENDIAN
  49 #define htobe16(x)      bswap16((x))
  50 #define htobe32(x)      bswap32((x))
  51 #define htobe64(x)      bswap64((x))
  52 #define htole16(x)      ((uint16_t)(x))
  53 #define htole32(x)      ((uint32_t)(x))
  54 #define htole64(x)      ((uint64_t)(x))
  55
  56 #define be16toh(x)      bswap16((x))
  57 #define be32toh(x)      bswap32((x))
  58 #define be64toh(x)      bswap64((x))
  59 #define le16toh(x)      ((uint16_t)(x))
  60 #define le32toh(x)      ((uint32_t)(x))
  61 #define le64toh(x)      ((uint64_t)(x))
  62 #else /* _BYTE_ORDER != _LITTLE_ENDIAN */
  63 #define htobe16(x)      ((uint16_t)(x))
  64 #define htobe32(x)      ((uint32_t)(x))
  65 #define htobe64(x)      ((uint64_t)(x))
  66 #define htole16(x)      bswap16((x))
  67 #define htole32(x)      bswap32((x))
  68 #define htole64(x)      bswap64((x))
  69
  70 #define be16toh(x)      ((uint16_t)(x))
  71 #define be32toh(x)      ((uint32_t)(x))
  72 #define be64toh(x)      ((uint64_t)(x))
  73 #define le16toh(x)      bswap16((x))
  74 #define le32toh(x)      bswap32((x))
  75 #define le64toh(x)      bswap64((x))
  76 #endif /* _BYTE_ORDER == _LITTLE_ENDIAN */
  77
  78 /* Alignment-agnostic encode/decode bytestream to/from little/big endian. */
  79
  80 static __inline uint16_t
  81 be16dec(const void *pp)
  82 {
  83         const uint8_t *p = (const uint8_t *)pp;
  84
  85         return ((p[0] << 8) | p[1]);
  86 }
  87
  88 static __inline uint32_t
  89 be32dec(const void *pp)
  90 {
  91         const uint8_t *p = (const uint8_t *)pp;
  92
  93         return ((p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3]);
  94 }
  95
  96 static __inline uint64_t
  97 be64dec(const void *pp)
  98 {
  99         const uint8_t *p = (const uint8_t *)pp;
 100
 101         return (((uint64_t)be32dec(p) << 32) | be32dec(p + 4));
 102 }
 103
 104 static __inline uint16_t
 105 le16dec(const void *pp)
 106 {
 107         const uint8_t *p = (const uint8_t *)pp;
 108
 109         return ((p[1] << 8) | p[0]);
 110 }
 111
 112 static __inline uint32_t
 113 le32dec(const void *pp)
 114 {
 115         const uint8_t *p = (const uint8_t *)pp;
 116
 117         return ((p[3] << 24) | (p[2] << 16) | (p[1] << 8) | p[0]);
 118 }
 119
 120 static __inline uint64_t
 121 le64dec(const void *pp)
 122 {
 123         const uint8_t *p = (const uint8_t *)pp;
 124
 125         return (((uint64_t)le32dec(p + 4) << 32) | le32dec(p));
 126 }
 127
 128 static __inline void
 129 be16enc(void *pp, uint16_t u)
 130 {
 131         uint8_t *p = (uint8_t *)pp;
 132
 133         p[0] = (u >> 8) & 0xff;
 134         p[1] = u & 0xff;
 135 }
 136
 137 static __inline void
 138 be32enc(void *pp, uint32_t u)
 139 {
 140         uint8_t *p = (uint8_t *)pp;
 141
 142         p[0] = (u >> 24) & 0xff;
 143         p[1] = (u >> 16) & 0xff;
 144         p[2] = (u >> 8) & 0xff;
 145         p[3] = u & 0xff;
 146 }
 147
 148 static __inline void
 149 be64enc(void *pp, uint64_t u)
 150 {
 151         uint8_t *p = (uint8_t *)pp;
 152
 153         be32enc(p, u >> 32);
 154         be32enc(p + 4, u & 0xffffffff);
 155 }
 156
 157 static __inline void
 158 le16enc(void *pp, uint16_t u)
 159 {
 160         uint8_t *p = (uint8_t *)pp;
 161
 162         p[0] = u & 0xff;
 163         p[1] = (u >> 8) & 0xff;
 164 }
 165
 166 static __inline void
 167 le32enc(void *pp, uint32_t u)
 168 {
 169         uint8_t *p = (uint8_t *)pp;
 170
 171         p[0] = u & 0xff;
 172         p[1] = (u >> 8) & 0xff;
 173         p[2] = (u >> 16) & 0xff;
 174         p[3] = (u >> 24) & 0xff;
 175 }
 176
 177 static __inline void
 178 le64enc(void *pp, uint64_t u)
 179 {
 180         uint8_t *p = (uint8_t *)pp;
 181
 182         le32enc(p, u & 0xffffffff);
 183         le32enc(p + 4, u >> 32);
 184 }
 185
 186 #endif  /* _SYS_ENDIAN_H_ */