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