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