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 /*
  54  * Compile-time endianness detection
  55  */
  56 #define RTE_BIG_ENDIAN    1
  57 #define RTE_LITTLE_ENDIAN 2
  58 #if defined __BYTE_ORDER__
  59 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
  60 #define RTE_BYTE_ORDER RTE_BIG_ENDIAN
  61 #elif __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
  62 #define RTE_BYTE_ORDER RTE_LITTLE_ENDIAN
  63 #endif /* __BYTE_ORDER__ */
  64 #elif defined __BYTE_ORDER
  65 #if __BYTE_ORDER == __BIG_ENDIAN
  66 #define RTE_BYTE_ORDER RTE_BIG_ENDIAN
  67 #elif __BYTE_ORDER == __LITTLE_ENDIAN
  68 #define RTE_BYTE_ORDER RTE_LITTLE_ENDIAN
  69 #endif /* __BYTE_ORDER */
  70 #elif defined __BIG_ENDIAN__
  71 #define RTE_BYTE_ORDER RTE_BIG_ENDIAN
  72 #elif defined __LITTLE_ENDIAN__
  73 #define RTE_BYTE_ORDER RTE_LITTLE_ENDIAN
  74 #endif
  75
  76 /*
  77  * An internal function to swap bytes in a 16-bit value.
  78  *
  79  * It is used by rte_bswap16() when the value is constant. Do not use
  80  * this function directly; rte_bswap16() is preferred.
  81  */
  82 static inline uint16_t
  83 rte_constant_bswap16(uint16_t x)
  84 {
  85         return (uint16_t)(((x & 0x00ffU) << 8) |
  86                 ((x & 0xff00U) >> 8));
  87 }
  88
  89 /*
  90  * An internal function to swap bytes in a 32-bit value.
  91  *
  92  * It is used by rte_bswap32() when the value is constant. Do not use
  93  * this function directly; rte_bswap32() is preferred.
  94  */
  95 static inline uint32_t
  96 rte_constant_bswap32(uint32_t x)
  97 {
  98         return  ((x & 0x000000ffUL) << 24) |
  99                 ((x & 0x0000ff00UL) << 8) |
 100                 ((x & 0x00ff0000UL) >> 8) |
 101                 ((x & 0xff000000UL) >> 24);
 102 }
 103
 104 /*
 105  * An internal function to swap bytes of a 64-bit value.
 106  *
 107  * It is used by rte_bswap64() when the value is constant. Do not use
 108  * this function directly; rte_bswap64() is preferred.
 109  */
 110 static inline uint64_t
 111 rte_constant_bswap64(uint64_t x)
 112 {
 113         return  ((x & 0x00000000000000ffULL) << 56) |
 114                 ((x & 0x000000000000ff00ULL) << 40) |
 115                 ((x & 0x0000000000ff0000ULL) << 24) |
 116                 ((x & 0x00000000ff000000ULL) <<  8) |
 117                 ((x & 0x000000ff00000000ULL) >>  8) |
 118                 ((x & 0x0000ff0000000000ULL) >> 24) |
 119                 ((x & 0x00ff000000000000ULL) >> 40) |
 120                 ((x & 0xff00000000000000ULL) >> 56);
 121 }
 122
 123
 124 #ifdef __DOXYGEN__
 125
 126 /**
 127  * Swap bytes in a 16-bit value.
 128  */
 129 static uint16_t rte_bswap16(uint16_t _x);
 130
 131 /**
 132  * Swap bytes in a 32-bit value.
 133  */
 134 static uint32_t rte_bswap32(uint32_t x);
 135
 136 /**
 137  * Swap bytes in a 64-bit value.
 138  */
 139 static uint64_t rte_bswap64(uint64_t x);
 140
 141 /**
 142  * Convert a 16-bit value from CPU order to little endian.
 143  */
 144 static uint16_t rte_cpu_to_le_16(uint16_t x);
 145
 146 /**
 147  * Convert a 32-bit value from CPU order to little endian.
 148  */
 149 static uint32_t rte_cpu_to_le_32(uint32_t x);
 150
 151 /**
 152  * Convert a 64-bit value from CPU order to little endian.
 153  */
 154 static uint64_t rte_cpu_to_le_64(uint64_t x);
 155
 156
 157 /**
 158  * Convert a 16-bit value from CPU order to big endian.
 159  */
 160 static uint16_t rte_cpu_to_be_16(uint16_t x);
 161
 162 /**
 163  * Convert a 32-bit value from CPU order to big endian.
 164  */
 165 static uint32_t rte_cpu_to_be_32(uint32_t x);
 166
 167 /**
 168  * Convert a 64-bit value from CPU order to big endian.
 169  */
 170 static uint64_t rte_cpu_to_be_64(uint64_t x);
 171
 172
 173 /**
 174  * Convert a 16-bit value from little endian to CPU order.
 175  */
 176 static uint16_t rte_le_to_cpu_16(uint16_t x);
 177
 178 /**
 179  * Convert a 32-bit value from little endian to CPU order.
 180  */
 181 static uint32_t rte_le_to_cpu_32(uint32_t x);
 182
 183 /**
 184  * Convert a 64-bit value from little endian to CPU order.
 185  */
 186 static uint64_t rte_le_to_cpu_64(uint64_t x);
 187
 188
 189 /**
 190  * Convert a 16-bit value from big endian to CPU order.
 191  */
 192 static uint16_t rte_be_to_cpu_16(uint16_t x);
 193
 194 /**
 195  * Convert a 32-bit value from big endian to CPU order.
 196  */
 197 static uint32_t rte_be_to_cpu_32(uint32_t x);
 198
 199 /**
 200  * Convert a 64-bit value from big endian to CPU order.
 201  */
 202 static uint64_t rte_be_to_cpu_64(uint64_t x);
 203
 204 #endif /* __DOXYGEN__ */
 205
 206 #ifdef RTE_FORCE_INTRINSICS
 207 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
 208 #define rte_bswap16(x) __builtin_bswap16(x)
 209 #endif
 210
 211 #define rte_bswap32(x) __builtin_bswap32(x)
 212
 213 #define rte_bswap64(x) __builtin_bswap64(x)
 214
 215 #endif
 216
 217 #endif /* _RTE_BYTEORDER_H_ */