xref: /dragonfly/sys/cpu/x86_64/include/endian.h (revision 245bd6bc)
1 /*-
2  * Copyright (c) 1987, 1991 Regents of the University of California.
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  * 3. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)endian.h	7.8 (Berkeley) 4/3/91
30  * $FreeBSD: src/sys/amd64/include/endian.h,v 1.5 2003/09/22 22:37:49 peter Exp $
31  */
32 
33 #ifndef _CPU_ENDIAN_H_
34 #define	_CPU_ENDIAN_H_
35 
36 #include <sys/cdefs.h>
37 #include <machine/stdint.h>
38 
39 /*
40  * Definitions for byte order, according to byte significance from low
41  * address to high.
42  */
43 #define	_LITTLE_ENDIAN	1234	/* LSB first: i386, vax */
44 #define	_BIG_ENDIAN	4321	/* MSB first: 68000, ibm, net */
45 #define	_PDP_ENDIAN	3412	/* LSB first in word, MSW first in long */
46 
47 #define	_BYTE_ORDER	_LITTLE_ENDIAN
48 
49 /*
50  * Deprecated variants that don't have enough underscores to be useful in more
51  * strict namespaces.
52  */
53 #if __BSD_VISIBLE
54 #define	LITTLE_ENDIAN	_LITTLE_ENDIAN
55 #define	BIG_ENDIAN	_BIG_ENDIAN
56 #define	PDP_ENDIAN	_PDP_ENDIAN
57 #define	BYTE_ORDER	_BYTE_ORDER
58 #endif
59 
60 #ifdef __GNUC__
61 
62 #define __word_swap_int_var(x) \
63 __extension__ ({ __uint32_t __X = (x); \
64    __asm ("rorl $16, %0" : "+r" (__X)); \
65    __X; })
66 
67 #ifdef __OPTIMIZE__
68 
69 #define	__word_swap_int_const(x) \
70 	((((x) & 0xffff0000) >> 16) | \
71 	 (((x) & 0x0000ffff) << 16))
72 #define	__word_swap_int(x) (__builtin_constant_p(x) ? \
73 	__word_swap_int_const(x) : __word_swap_int_var(x))
74 
75 #else	/* __OPTIMIZE__ */
76 
77 #define	__word_swap_int(x) __word_swap_int_var(x)
78 
79 #endif	/* __OPTIMIZE__ */
80 
81 #define __byte_swap_int_var(x) \
82 __extension__ ({ __uint32_t __X = (x); \
83    __asm ("bswap %0" : "+r" (__X)); \
84    __X; })
85 
86 #ifdef __OPTIMIZE__
87 
88 #define	__byte_swap_int_const(x) \
89 	((((x) & 0xff000000) >> 24) | \
90 	 (((x) & 0x00ff0000) >>  8) | \
91 	 (((x) & 0x0000ff00) <<  8) | \
92 	 (((x) & 0x000000ff) << 24))
93 #define	__byte_swap_int(x) (__builtin_constant_p(x) ? \
94 	__byte_swap_int_const(x) : __byte_swap_int_var(x))
95 
96 #else	/* __OPTIMIZE__ */
97 
98 #define	__byte_swap_int(x) __byte_swap_int_var(x)
99 
100 #endif	/* __OPTIMIZE__ */
101 
102 #define __byte_swap_long_var(x) \
103 __extension__ ({ __uint64_t __X = (x); \
104    __asm ("bswap %0" : "+r" (__X)); \
105    __X; })
106 
107 #define	__byte_swap_long_const(x) \
108 	(((x >> 56) | \
109 	 ((x >> 40) & 0xff00) | \
110 	 ((x >> 24) & 0xff0000) | \
111 	 ((x >> 8) & 0xff000000) | \
112 	 ((x << 8) & ((__uint64_t)0xff << 32)) | \
113 	 ((x << 24) & ((__uint64_t)0xff << 40)) | \
114 	 ((x << 40) & ((__uint64_t)0xff << 48)) | \
115 	 ((x << 56))))
116 
117 #ifdef __i386__
118 
119 #define	__byte_swap_long(x)	__byte_swap_long_const(x)
120 
121 #else
122 
123 #ifdef __OPTIMIZE__
124 #define	__byte_swap_long(x)	(__builtin_constant_p(x) ? \
125 	__byte_swap_long_const(x) : __byte_swap_long_var(x))
126 #else	/* __OPTIMIZE__ */
127 #define	__byte_swap_long(x)	__byte_swap_long_var(x)
128 #endif	/* __OPTIMIZE__ */
129 
130 #endif	/* __i386__ */
131 
132 #define __byte_swap_word_var(x) \
133 __extension__ ({ __uint16_t __X = (x); \
134    __asm ("xchgb %h0, %b0" : "+Q" (__X)); \
135    __X; })
136 
137 #ifdef __OPTIMIZE__
138 
139 #define	__byte_swap_word_const(x) \
140 	((((x) & 0xff00) >> 8) | \
141 	 (((x) & 0x00ff) << 8))
142 
143 #define	__byte_swap_word(x) (__builtin_constant_p(x) ? \
144 	__byte_swap_word_const(x) : __byte_swap_word_var(x))
145 
146 #else	/* __OPTIMIZE__ */
147 
148 #define	__byte_swap_word(x) __byte_swap_word_var(x)
149 
150 #endif	/* __OPTIMIZE__ */
151 
152 static __inline __always_inline __uint64_t
153 __bswap64(__uint64_t _x)
154 {
155 #if __GNUC_PREREQ__(4, 8) && defined(__cplusplus)
156 	return (__builtin_bswap64(_x));
157 #else
158 	return (__byte_swap_long(_x));
159 #endif
160 }
161 
162 static __inline __always_inline __uint32_t
163 __bswap32(__uint32_t _x)
164 {
165 #if __GNUC_PREREQ__(4, 8) && defined(__cplusplus)
166 	return (__builtin_bswap32(_x));
167 #else
168 	return (__byte_swap_int(_x));
169 #endif
170 }
171 
172 static __inline __always_inline __uint16_t
173 __bswap16(__uint16_t _x)
174 {
175 #if __GNUC_PREREQ__(4, 8) && defined(__cplusplus)
176 	return (__builtin_bswap16(_x));
177 #else
178 	return (__byte_swap_word(_x));
179 #endif
180 }
181 
182 #define	__htonl(x)	__bswap32(x)
183 #define	__htons(x)	__bswap16(x)
184 #define	__ntohl(x)	__bswap32(x)
185 #define	__ntohs(x)	__bswap16(x)
186 
187 #else /* !__GNUC__ */
188 
189 /*
190  * No optimizations are available for this compiler.  Fall back to
191  * non-optimized functions by defining the constant usually used to prevent
192  * redefinition.
193  */
194 #define	_BYTEORDER_FUNC_DEFINED
195 
196 #endif /* __GNUC__ */
197 
198 /*
199  * Userland compatibility double underscore variants to help with DPorts
200  * (injected through <sys/types.h>).
201  */
202 #ifndef _KERNEL
203 #define	__LITTLE_ENDIAN	_LITTLE_ENDIAN
204 #define	__BIG_ENDIAN	_BIG_ENDIAN
205 #define	__PDP_ENDIAN	_PDP_ENDIAN
206 #define	__BYTE_ORDER	_BYTE_ORDER
207 #endif
208 
209 #endif /* !_CPU_ENDIAN_H_ */
210