xref: /freebsd/sys/sys/endian.h (revision e0c4386e)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
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 
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 _UINT8_T_DECLARED
37 typedef	__uint8_t	uint8_t;
38 #define	_UINT8_T_DECLARED
39 #endif
40 
41 #ifndef _UINT16_T_DECLARED
42 typedef	__uint16_t	uint16_t;
43 #define	_UINT16_T_DECLARED
44 #endif
45 
46 #ifndef _UINT32_T_DECLARED
47 typedef	__uint32_t	uint32_t;
48 #define	_UINT32_T_DECLARED
49 #endif
50 
51 #ifndef _UINT64_T_DECLARED
52 typedef	__uint64_t	uint64_t;
53 #define	_UINT64_T_DECLARED
54 #endif
55 
56 /*
57  * Note: While tempting to try to avoid namespace pollution from this file,
58  * several software packages assume these marcos are defined, even when it
59  * defines _POSIX_C_SOURCE to request an unpolluted namespace.
60  */
61 
62 /*
63  * General byte order swapping functions.
64  */
65 #define	bswap16(x)	__bswap16(x)
66 #define	bswap32(x)	__bswap32(x)
67 #define	bswap64(x)	__bswap64(x)
68 
69 /* Alignment-agnostic encode/decode bytestream to/from little/big endian. */
70 static __inline uint16_t
71 be16dec(const void *pp)
72 {
73 	uint8_t const *p = (uint8_t const *)pp;
74 
75 	return ((p[0] << 8) | p[1]);
76 }
77 
78 static __inline uint32_t
79 be32dec(const void *pp)
80 {
81 	uint8_t const *p = (uint8_t const *)pp;
82 
83 	return (((unsigned)p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3]);
84 }
85 
86 static __inline uint64_t
87 be64dec(const void *pp)
88 {
89 	uint8_t const *p = (uint8_t const *)pp;
90 
91 	return (((uint64_t)be32dec(p) << 32) | be32dec(p + 4));
92 }
93 
94 static __inline uint16_t
95 le16dec(const void *pp)
96 {
97 	uint8_t const *p = (uint8_t const *)pp;
98 
99 	return ((p[1] << 8) | p[0]);
100 }
101 
102 static __inline uint32_t
103 le32dec(const void *pp)
104 {
105 	uint8_t const *p = (uint8_t const *)pp;
106 
107 	return (((unsigned)p[3] << 24) | (p[2] << 16) | (p[1] << 8) | p[0]);
108 }
109 
110 static __inline uint64_t
111 le64dec(const void *pp)
112 {
113 	uint8_t const *p = (uint8_t const *)pp;
114 
115 	return (((uint64_t)le32dec(p + 4) << 32) | le32dec(p));
116 }
117 
118 static __inline void
119 be16enc(void *pp, uint16_t u)
120 {
121 	uint8_t *p = (uint8_t *)pp;
122 
123 	p[0] = (u >> 8) & 0xff;
124 	p[1] = u & 0xff;
125 }
126 
127 static __inline void
128 be32enc(void *pp, uint32_t u)
129 {
130 	uint8_t *p = (uint8_t *)pp;
131 
132 	p[0] = (u >> 24) & 0xff;
133 	p[1] = (u >> 16) & 0xff;
134 	p[2] = (u >> 8) & 0xff;
135 	p[3] = u & 0xff;
136 }
137 
138 static __inline void
139 be64enc(void *pp, uint64_t u)
140 {
141 	uint8_t *p = (uint8_t *)pp;
142 
143 	be32enc(p, (uint32_t)(u >> 32));
144 	be32enc(p + 4, (uint32_t)(u & 0xffffffffU));
145 }
146 
147 static __inline void
148 le16enc(void *pp, uint16_t u)
149 {
150 	uint8_t *p = (uint8_t *)pp;
151 
152 	p[0] = u & 0xff;
153 	p[1] = (u >> 8) & 0xff;
154 }
155 
156 static __inline void
157 le32enc(void *pp, uint32_t u)
158 {
159 	uint8_t *p = (uint8_t *)pp;
160 
161 	p[0] = u & 0xff;
162 	p[1] = (u >> 8) & 0xff;
163 	p[2] = (u >> 16) & 0xff;
164 	p[3] = (u >> 24) & 0xff;
165 }
166 
167 static __inline void
168 le64enc(void *pp, uint64_t u)
169 {
170 	uint8_t *p = (uint8_t *)pp;
171 
172 	le32enc(p, (uint32_t)(u & 0xffffffffU));
173 	le32enc(p + 4, (uint32_t)(u >> 32));
174 }
175 #endif	/* _SYS_ENDIAN_H_ */
176