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