4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _RTE_BYTEORDER_H_
35 #define _RTE_BYTEORDER_H_
40 * Byte Swap Operations
42 * This file defines a generic API for byte swap operations. Part of
43 * the implementation is architecture-specific.
47 #ifdef RTE_EXEC_ENV_BSDAPP
48 #include <sys/endian.h>
53 #include <rte_common.h>
54 #include <rte_config.h>
57 * Compile-time endianness detection
59 #define RTE_BIG_ENDIAN 1
60 #define RTE_LITTLE_ENDIAN 2
61 #if defined __BYTE_ORDER__
62 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
63 #define RTE_BYTE_ORDER RTE_BIG_ENDIAN
64 #elif __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
65 #define RTE_BYTE_ORDER RTE_LITTLE_ENDIAN
66 #endif /* __BYTE_ORDER__ */
67 #elif defined __BYTE_ORDER
68 #if __BYTE_ORDER == __BIG_ENDIAN
69 #define RTE_BYTE_ORDER RTE_BIG_ENDIAN
70 #elif __BYTE_ORDER == __LITTLE_ENDIAN
71 #define RTE_BYTE_ORDER RTE_LITTLE_ENDIAN
72 #endif /* __BYTE_ORDER */
73 #elif defined __BIG_ENDIAN__
74 #define RTE_BYTE_ORDER RTE_BIG_ENDIAN
75 #elif defined __LITTLE_ENDIAN__
76 #define RTE_BYTE_ORDER RTE_LITTLE_ENDIAN
78 #if !defined(RTE_BYTE_ORDER)
79 #error Unknown endianness.
82 #define RTE_STATIC_BSWAP16(v) \
83 ((((uint16_t)(v) & UINT16_C(0x00ff)) << 8) | \
84 (((uint16_t)(v) & UINT16_C(0xff00)) >> 8))
86 #define RTE_STATIC_BSWAP32(v) \
87 ((((uint32_t)(v) & UINT32_C(0x000000ff)) << 24) | \
88 (((uint32_t)(v) & UINT32_C(0x0000ff00)) << 8) | \
89 (((uint32_t)(v) & UINT32_C(0x00ff0000)) >> 8) | \
90 (((uint32_t)(v) & UINT32_C(0xff000000)) >> 24))
92 #define RTE_STATIC_BSWAP64(v) \
93 ((((uint64_t)(v) & UINT64_C(0x00000000000000ff)) << 56) | \
94 (((uint64_t)(v) & UINT64_C(0x000000000000ff00)) << 40) | \
95 (((uint64_t)(v) & UINT64_C(0x0000000000ff0000)) << 24) | \
96 (((uint64_t)(v) & UINT64_C(0x00000000ff000000)) << 8) | \
97 (((uint64_t)(v) & UINT64_C(0x000000ff00000000)) >> 8) | \
98 (((uint64_t)(v) & UINT64_C(0x0000ff0000000000)) >> 24) | \
99 (((uint64_t)(v) & UINT64_C(0x00ff000000000000)) >> 40) | \
100 (((uint64_t)(v) & UINT64_C(0xff00000000000000)) >> 56))
103 * These macros are functionally similar to rte_cpu_to_(be|le)(16|32|64)(),
104 * they take values in host CPU order and return them converted to the
105 * intended endianness.
107 * They resolve at compilation time to integer constants which can safely be
108 * used with static initializers, since those cannot involve function calls.
110 * On the other hand, they are not as optimized as their rte_cpu_to_*()
111 * counterparts, therefore applications should refrain from using them on
112 * variable values, particularly inside performance-sensitive code.
114 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
115 #define RTE_BE16(v) (rte_be16_t)(v)
116 #define RTE_BE32(v) (rte_be32_t)(v)
117 #define RTE_BE64(v) (rte_be64_t)(v)
118 #define RTE_LE16(v) (rte_le16_t)(RTE_STATIC_BSWAP16(v))
119 #define RTE_LE32(v) (rte_le32_t)(RTE_STATIC_BSWAP32(v))
120 #define RTE_LE64(v) (rte_le64_t)(RTE_STATIC_BSWAP64(v))
121 #elif RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
122 #define RTE_BE16(v) (rte_be16_t)(RTE_STATIC_BSWAP16(v))
123 #define RTE_BE32(v) (rte_be32_t)(RTE_STATIC_BSWAP32(v))
124 #define RTE_BE64(v) (rte_be64_t)(RTE_STATIC_BSWAP64(v))
125 #define RTE_LE16(v) (rte_be16_t)(v)
126 #define RTE_LE32(v) (rte_be32_t)(v)
127 #define RTE_LE64(v) (rte_be64_t)(v)
129 #error Unsupported endianness.
133 * The following types should be used when handling values according to a
134 * specific byte ordering, which may differ from that of the host CPU.
136 * Libraries, public APIs and applications are encouraged to use them for
137 * documentation purposes.
139 typedef uint16_t rte_be16_t; /**< 16-bit big-endian value. */
140 typedef uint32_t rte_be32_t; /**< 32-bit big-endian value. */
141 typedef uint64_t rte_be64_t; /**< 64-bit big-endian value. */
142 typedef uint16_t rte_le16_t; /**< 16-bit little-endian value. */
143 typedef uint32_t rte_le32_t; /**< 32-bit little-endian value. */
144 typedef uint64_t rte_le64_t; /**< 64-bit little-endian value. */
147 * An internal function to swap bytes in a 16-bit value.
149 * It is used by rte_bswap16() when the value is constant. Do not use
150 * this function directly; rte_bswap16() is preferred.
152 static inline uint16_t
153 rte_constant_bswap16(uint16_t x)
155 return RTE_STATIC_BSWAP16(x);
159 * An internal function to swap bytes in a 32-bit value.
161 * It is used by rte_bswap32() when the value is constant. Do not use
162 * this function directly; rte_bswap32() is preferred.
164 static inline uint32_t
165 rte_constant_bswap32(uint32_t x)
167 return RTE_STATIC_BSWAP32(x);
171 * An internal function to swap bytes of a 64-bit value.
173 * It is used by rte_bswap64() when the value is constant. Do not use
174 * this function directly; rte_bswap64() is preferred.
176 static inline uint64_t
177 rte_constant_bswap64(uint64_t x)
179 return RTE_STATIC_BSWAP64(x);
186 * Swap bytes in a 16-bit value.
188 static uint16_t rte_bswap16(uint16_t _x);
191 * Swap bytes in a 32-bit value.
193 static uint32_t rte_bswap32(uint32_t x);
196 * Swap bytes in a 64-bit value.
198 static uint64_t rte_bswap64(uint64_t x);
201 * Convert a 16-bit value from CPU order to little endian.
203 static rte_le16_t rte_cpu_to_le_16(uint16_t x);
206 * Convert a 32-bit value from CPU order to little endian.
208 static rte_le32_t rte_cpu_to_le_32(uint32_t x);
211 * Convert a 64-bit value from CPU order to little endian.
213 static rte_le64_t rte_cpu_to_le_64(uint64_t x);
217 * Convert a 16-bit value from CPU order to big endian.
219 static rte_be16_t rte_cpu_to_be_16(uint16_t x);
222 * Convert a 32-bit value from CPU order to big endian.
224 static rte_be32_t rte_cpu_to_be_32(uint32_t x);
227 * Convert a 64-bit value from CPU order to big endian.
229 static rte_be64_t rte_cpu_to_be_64(uint64_t x);
233 * Convert a 16-bit value from little endian to CPU order.
235 static uint16_t rte_le_to_cpu_16(rte_le16_t x);
238 * Convert a 32-bit value from little endian to CPU order.
240 static uint32_t rte_le_to_cpu_32(rte_le32_t x);
243 * Convert a 64-bit value from little endian to CPU order.
245 static uint64_t rte_le_to_cpu_64(rte_le64_t x);
249 * Convert a 16-bit value from big endian to CPU order.
251 static uint16_t rte_be_to_cpu_16(rte_be16_t x);
254 * Convert a 32-bit value from big endian to CPU order.
256 static uint32_t rte_be_to_cpu_32(rte_be32_t x);
259 * Convert a 64-bit value from big endian to CPU order.
261 static uint64_t rte_be_to_cpu_64(rte_be64_t x);
263 #endif /* __DOXYGEN__ */
265 #ifdef RTE_FORCE_INTRINSICS
266 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
267 #define rte_bswap16(x) __builtin_bswap16(x)
270 #define rte_bswap32(x) __builtin_bswap32(x)
272 #define rte_bswap64(x) __builtin_bswap64(x)
276 #endif /* _RTE_BYTEORDER_H_ */