lib/librte_eal/common/include/generic/rte_byteorder.h

   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
  37 /**
  38  * @file
  39  *
  40  * Byte Swap Operations
  41  *
  42  * This file defines a generic API for byte swap operations. Part of
  43  * the implementation is architecture-specific.
  44  */
  45
  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 #if !defined(RTE_BYTE_ORDER)
  78 #error Unknown endianness.
  79 #endif
  80
  81 #define RTE_STATIC_BSWAP16(v) \
  82         ((((uint16_t)(v) & UINT16_C(0x00ff)) << 8) | \
  83          (((uint16_t)(v) & UINT16_C(0xff00)) >> 8))
  84
  85 #define RTE_STATIC_BSWAP32(v) \
  86         ((((uint32_t)(v) & UINT32_C(0x000000ff)) << 24) | \
  87          (((uint32_t)(v) & UINT32_C(0x0000ff00)) <<  8) | \
  88          (((uint32_t)(v) & UINT32_C(0x00ff0000)) >>  8) | \
  89          (((uint32_t)(v) & UINT32_C(0xff000000)) >> 24))
  90
  91 #define RTE_STATIC_BSWAP64(v) \
  92         ((((uint64_t)(v) & UINT64_C(0x00000000000000ff)) << 56) | \
  93          (((uint64_t)(v) & UINT64_C(0x000000000000ff00)) << 40) | \
  94          (((uint64_t)(v) & UINT64_C(0x0000000000ff0000)) << 24) | \
  95          (((uint64_t)(v) & UINT64_C(0x00000000ff000000)) <<  8) | \
  96          (((uint64_t)(v) & UINT64_C(0x000000ff00000000)) >>  8) | \
  97          (((uint64_t)(v) & UINT64_C(0x0000ff0000000000)) >> 24) | \
  98          (((uint64_t)(v) & UINT64_C(0x00ff000000000000)) >> 40) | \
  99          (((uint64_t)(v) & UINT64_C(0xff00000000000000)) >> 56))
 100
 101 /*
 102  * These macros are functionally similar to rte_cpu_to_(be|le)(16|32|64)(),
 103  * they take values in host CPU order and return them converted to the
 104  * intended endianness.
 105  *
 106  * They resolve at compilation time to integer constants which can safely be
 107  * used with static initializers, since those cannot involve function calls.
 108  *
 109  * On the other hand, they are not as optimized as their rte_cpu_to_*()
 110  * counterparts, therefore applications should refrain from using them on
 111  * variable values, particularly inside performance-sensitive code.
 112  */
 113 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
 114 #define RTE_BE16(v) (rte_be16_t)(v)
 115 #define RTE_BE32(v) (rte_be32_t)(v)
 116 #define RTE_BE64(v) (rte_be64_t)(v)
 117 #define RTE_LE16(v) (rte_le16_t)(RTE_STATIC_BSWAP16(v))
 118 #define RTE_LE32(v) (rte_le32_t)(RTE_STATIC_BSWAP32(v))
 119 #define RTE_LE64(v) (rte_le64_t)(RTE_STATIC_BSWAP64(v))
 120 #elif RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
 121 #define RTE_BE16(v) (rte_be16_t)(RTE_STATIC_BSWAP16(v))
 122 #define RTE_BE32(v) (rte_be32_t)(RTE_STATIC_BSWAP32(v))
 123 #define RTE_BE64(v) (rte_be64_t)(RTE_STATIC_BSWAP64(v))
 124 #define RTE_LE16(v) (rte_be16_t)(v)
 125 #define RTE_LE32(v) (rte_be32_t)(v)
 126 #define RTE_LE64(v) (rte_be64_t)(v)
 127 #else
 128 #error Unsupported endianness.
 129 #endif
 130
 131 /*
 132  * The following types should be used when handling values according to a
 133  * specific byte ordering, which may differ from that of the host CPU.
 134  *
 135  * Libraries, public APIs and applications are encouraged to use them for
 136  * documentation purposes.
 137  */
 138 typedef uint16_t rte_be16_t; /**< 16-bit big-endian value. */
 139 typedef uint32_t rte_be32_t; /**< 32-bit big-endian value. */
 140 typedef uint64_t rte_be64_t; /**< 64-bit big-endian value. */
 141 typedef uint16_t rte_le16_t; /**< 16-bit little-endian value. */
 142 typedef uint32_t rte_le32_t; /**< 32-bit little-endian value. */
 143 typedef uint64_t rte_le64_t; /**< 64-bit little-endian value. */
 144
 145 /*
 146  * An internal function to swap bytes in a 16-bit value.
 147  *
 148  * It is used by rte_bswap16() when the value is constant. Do not use
 149  * this function directly; rte_bswap16() is preferred.
 150  */
 151 static inline uint16_t
 152 rte_constant_bswap16(uint16_t x)
 153 {
 154         return RTE_STATIC_BSWAP16(x);
 155 }
 156
 157 /*
 158  * An internal function to swap bytes in a 32-bit value.
 159  *
 160  * It is used by rte_bswap32() when the value is constant. Do not use
 161  * this function directly; rte_bswap32() is preferred.
 162  */
 163 static inline uint32_t
 164 rte_constant_bswap32(uint32_t x)
 165 {
 166         return RTE_STATIC_BSWAP32(x);
 167 }
 168
 169 /*
 170  * An internal function to swap bytes of a 64-bit value.
 171  *
 172  * It is used by rte_bswap64() when the value is constant. Do not use
 173  * this function directly; rte_bswap64() is preferred.
 174  */
 175 static inline uint64_t
 176 rte_constant_bswap64(uint64_t x)
 177 {
 178         return RTE_STATIC_BSWAP64(x);
 179 }
 180
 181
 182 #ifdef __DOXYGEN__
 183
 184 /**
 185  * Swap bytes in a 16-bit value.
 186  */
 187 static uint16_t rte_bswap16(uint16_t _x);
 188
 189 /**
 190  * Swap bytes in a 32-bit value.
 191  */
 192 static uint32_t rte_bswap32(uint32_t x);
 193
 194 /**
 195  * Swap bytes in a 64-bit value.
 196  */
 197 static uint64_t rte_bswap64(uint64_t x);
 198
 199 /**
 200  * Convert a 16-bit value from CPU order to little endian.
 201  */
 202 static rte_le16_t rte_cpu_to_le_16(uint16_t x);
 203
 204 /**
 205  * Convert a 32-bit value from CPU order to little endian.
 206  */
 207 static rte_le32_t rte_cpu_to_le_32(uint32_t x);
 208
 209 /**
 210  * Convert a 64-bit value from CPU order to little endian.
 211  */
 212 static rte_le64_t rte_cpu_to_le_64(uint64_t x);
 213
 214
 215 /**
 216  * Convert a 16-bit value from CPU order to big endian.
 217  */
 218 static rte_be16_t rte_cpu_to_be_16(uint16_t x);
 219
 220 /**
 221  * Convert a 32-bit value from CPU order to big endian.
 222  */
 223 static rte_be32_t rte_cpu_to_be_32(uint32_t x);
 224
 225 /**
 226  * Convert a 64-bit value from CPU order to big endian.
 227  */
 228 static rte_be64_t rte_cpu_to_be_64(uint64_t x);
 229
 230
 231 /**
 232  * Convert a 16-bit value from little endian to CPU order.
 233  */
 234 static uint16_t rte_le_to_cpu_16(rte_le16_t x);
 235
 236 /**
 237  * Convert a 32-bit value from little endian to CPU order.
 238  */
 239 static uint32_t rte_le_to_cpu_32(rte_le32_t x);
 240
 241 /**
 242  * Convert a 64-bit value from little endian to CPU order.
 243  */
 244 static uint64_t rte_le_to_cpu_64(rte_le64_t x);
 245
 246
 247 /**
 248  * Convert a 16-bit value from big endian to CPU order.
 249  */
 250 static uint16_t rte_be_to_cpu_16(rte_be16_t x);
 251
 252 /**
 253  * Convert a 32-bit value from big endian to CPU order.
 254  */
 255 static uint32_t rte_be_to_cpu_32(rte_be32_t x);
 256
 257 /**
 258  * Convert a 64-bit value from big endian to CPU order.
 259  */
 260 static uint64_t rte_be_to_cpu_64(rte_be64_t x);
 261
 262 #endif /* __DOXYGEN__ */
 263
 264 #ifdef RTE_FORCE_INTRINSICS
 265 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
 266 #define rte_bswap16(x) __builtin_bswap16(x)
 267 #endif
 268
 269 #define rte_bswap32(x) __builtin_bswap32(x)
 270
 271 #define rte_bswap64(x) __builtin_bswap64(x)
 272
 273 #endif
 274
 275 #endif /* _RTE_BYTEORDER_H_ */