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