DPDK  16.11.8
rte_byteorder.h
Go to the documentation of this file.
1 /*-
2  * BSD LICENSE
3  *
4  * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
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  *
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
16  * distribution.
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.
20  *
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.
32  */
33 
34 #ifndef _RTE_BYTEORDER_H_
35 #define _RTE_BYTEORDER_H_
36 
46 #include <stdint.h>
47 #ifdef RTE_EXEC_ENV_BSDAPP
48 #include <sys/endian.h>
49 #else
50 #include <endian.h>
51 #endif
52 
53 #include <rte_common.h>
54 
55 /*
56  * Compile-time endianness detection
57  */
58 #define RTE_BIG_ENDIAN 1
59 #define RTE_LITTLE_ENDIAN 2
60 #if defined __BYTE_ORDER__
61 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
62 #define RTE_BYTE_ORDER RTE_BIG_ENDIAN
63 #elif __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
64 #define RTE_BYTE_ORDER RTE_LITTLE_ENDIAN
65 #endif /* __BYTE_ORDER__ */
66 #elif defined __BYTE_ORDER
67 #if __BYTE_ORDER == __BIG_ENDIAN
68 #define RTE_BYTE_ORDER RTE_BIG_ENDIAN
69 #elif __BYTE_ORDER == __LITTLE_ENDIAN
70 #define RTE_BYTE_ORDER RTE_LITTLE_ENDIAN
71 #endif /* __BYTE_ORDER */
72 #elif defined __BIG_ENDIAN__
73 #define RTE_BYTE_ORDER RTE_BIG_ENDIAN
74 #elif defined __LITTLE_ENDIAN__
75 #define RTE_BYTE_ORDER RTE_LITTLE_ENDIAN
76 #endif
77 
78 /*
79  * An internal function to swap bytes in a 16-bit value.
80  *
81  * It is used by rte_bswap16() when the value is constant. Do not use
82  * this function directly; rte_bswap16() is preferred.
83  */
84 static inline uint16_t
85 rte_constant_bswap16(uint16_t x)
86 {
87  return (uint16_t)(((x & 0x00ffU) << 8) |
88  ((x & 0xff00U) >> 8));
89 }
90 
91 /*
92  * An internal function to swap bytes in a 32-bit value.
93  *
94  * It is used by rte_bswap32() when the value is constant. Do not use
95  * this function directly; rte_bswap32() is preferred.
96  */
97 static inline uint32_t
98 rte_constant_bswap32(uint32_t x)
99 {
100  return ((x & 0x000000ffUL) << 24) |
101  ((x & 0x0000ff00UL) << 8) |
102  ((x & 0x00ff0000UL) >> 8) |
103  ((x & 0xff000000UL) >> 24);
104 }
105 
106 /*
107  * An internal function to swap bytes of a 64-bit value.
108  *
109  * It is used by rte_bswap64() when the value is constant. Do not use
110  * this function directly; rte_bswap64() is preferred.
111  */
112 static inline uint64_t
113 rte_constant_bswap64(uint64_t x)
114 {
115  return ((x & 0x00000000000000ffULL) << 56) |
116  ((x & 0x000000000000ff00ULL) << 40) |
117  ((x & 0x0000000000ff0000ULL) << 24) |
118  ((x & 0x00000000ff000000ULL) << 8) |
119  ((x & 0x000000ff00000000ULL) >> 8) |
120  ((x & 0x0000ff0000000000ULL) >> 24) |
121  ((x & 0x00ff000000000000ULL) >> 40) |
122  ((x & 0xff00000000000000ULL) >> 56);
123 }
124 
125 
126 #ifdef __DOXYGEN__
127 
131 static uint16_t rte_bswap16(uint16_t _x);
132 
136 static uint32_t rte_bswap32(uint32_t x);
137 
141 static uint64_t rte_bswap64(uint64_t x);
142 
146 static uint16_t rte_cpu_to_le_16(uint16_t x);
147 
151 static uint32_t rte_cpu_to_le_32(uint32_t x);
152 
156 static uint64_t rte_cpu_to_le_64(uint64_t x);
157 
158 
162 static uint16_t rte_cpu_to_be_16(uint16_t x);
163 
167 static uint32_t rte_cpu_to_be_32(uint32_t x);
168 
172 static uint64_t rte_cpu_to_be_64(uint64_t x);
173 
174 
178 static uint16_t rte_le_to_cpu_16(uint16_t x);
179 
183 static uint32_t rte_le_to_cpu_32(uint32_t x);
184 
188 static uint64_t rte_le_to_cpu_64(uint64_t x);
189 
190 
194 static uint16_t rte_be_to_cpu_16(uint16_t x);
195 
199 static uint32_t rte_be_to_cpu_32(uint32_t x);
200 
204 static uint64_t rte_be_to_cpu_64(uint64_t x);
205 
206 #endif /* __DOXYGEN__ */
207 
208 #ifdef RTE_FORCE_INTRINSICS
209 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
210 #define rte_bswap16(x) __builtin_bswap16(x)
211 #endif
212 
213 #define rte_bswap32(x) __builtin_bswap32(x)
214 
215 #define rte_bswap64(x) __builtin_bswap64(x)
216 
217 #endif
218 
219 #endif /* _RTE_BYTEORDER_H_ */