drivers/net/mlx4/mlx4.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2012-2017 6WIND S.A.
   5  *   Copyright 2012-2017 Mellanox.
   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 6WIND S.A. 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_PMD_MLX4_H_
  35 #define RTE_PMD_MLX4_H_
  36
  37 #include <stddef.h>
  38 #include <stdint.h>
  39 #include <limits.h>
  40
  41 /*
  42  * Runtime logging through RTE_LOG() is enabled when not in debugging mode.
  43  * Intermediate LOG_*() macros add the required end-of-line characters.
  44  */
  45 #ifndef NDEBUG
  46 #define INFO(...) DEBUG(__VA_ARGS__)
  47 #define WARN(...) DEBUG(__VA_ARGS__)
  48 #define ERROR(...) DEBUG(__VA_ARGS__)
  49 #else
  50 #define LOG__(level, m, ...) \
  51         RTE_LOG(level, PMD, MLX4_DRIVER_NAME ": " m "%c", __VA_ARGS__)
  52 #define LOG_(level, ...) LOG__(level, __VA_ARGS__, '\n')
  53 #define INFO(...) LOG_(INFO, __VA_ARGS__)
  54 #define WARN(...) LOG_(WARNING, __VA_ARGS__)
  55 #define ERROR(...) LOG_(ERR, __VA_ARGS__)
  56 #endif
  57
  58 /* Verbs header. */
  59 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
  60 #ifdef PEDANTIC
  61 #pragma GCC diagnostic ignored "-Wpedantic"
  62 #endif
  63 #include <infiniband/verbs.h>
  64 #ifdef PEDANTIC
  65 #pragma GCC diagnostic error "-Wpedantic"
  66 #endif
  67
  68 /*
  69  * Maximum number of simultaneous MAC addresses supported.
  70  *
  71  * According to ConnectX's Programmer Reference Manual:
  72  *   The L2 Address Match is implemented by comparing a MAC/VLAN combination
  73  *   of 128 MAC addresses and 127 VLAN values, comprising 128x127 possible
  74  *   L2 addresses.
  75  */
  76 #define MLX4_MAX_MAC_ADDRESSES 128
  77
  78 /* Maximum number of simultaneous VLAN filters supported. See above. */
  79 #define MLX4_MAX_VLAN_IDS 127
  80
  81 /* Request send completion once in every 64 sends, might be less. */
  82 #define MLX4_PMD_TX_PER_COMP_REQ 64
  83
  84 /* Maximum number of Scatter/Gather Elements per Work Request. */
  85 #ifndef MLX4_PMD_SGE_WR_N
  86 #define MLX4_PMD_SGE_WR_N 4
  87 #endif
  88
  89 /* Maximum size for inline data. */
  90 #ifndef MLX4_PMD_MAX_INLINE
  91 #define MLX4_PMD_MAX_INLINE 0
  92 #endif
  93
  94 /*
  95  * Maximum number of cached Memory Pools (MPs) per TX queue. Each RTE MP
  96  * from which buffers are to be transmitted will have to be mapped by this
  97  * driver to their own Memory Region (MR). This is a slow operation.
  98  *
  99  * This value is always 1 for RX queues.
 100  */
 101 #ifndef MLX4_PMD_TX_MP_CACHE
 102 #define MLX4_PMD_TX_MP_CACHE 8
 103 #endif
 104
 105 /*
 106  * If defined, only use software counters. The PMD will never ask the hardware
 107  * for these, and many of them won't be available.
 108  */
 109 #ifndef MLX4_PMD_SOFT_COUNTERS
 110 #define MLX4_PMD_SOFT_COUNTERS 1
 111 #endif
 112
 113 /* Alarm timeout. */
 114 #define MLX4_ALARM_TIMEOUT_US 100000
 115
 116 enum {
 117         PCI_VENDOR_ID_MELLANOX = 0x15b3,
 118 };
 119
 120 enum {
 121         PCI_DEVICE_ID_MELLANOX_CONNECTX3 = 0x1003,
 122         PCI_DEVICE_ID_MELLANOX_CONNECTX3VF = 0x1004,
 123         PCI_DEVICE_ID_MELLANOX_CONNECTX3PRO = 0x1007,
 124 };
 125
 126 #define MLX4_DRIVER_NAME "net_mlx4"
 127
 128 /* Bit-field manipulation. */
 129 #define BITFIELD_DECLARE(bf, type, size)                                \
 130         type bf[(((size_t)(size) / (sizeof(type) * CHAR_BIT)) +         \
 131                  !!((size_t)(size) % (sizeof(type) * CHAR_BIT)))]
 132 #define BITFIELD_DEFINE(bf, type, size)                                 \
 133         BITFIELD_DECLARE((bf), type, (size)) = { 0 }
 134 #define BITFIELD_SET(bf, b)                                             \
 135         (assert((size_t)(b) < (sizeof(bf) * CHAR_BIT)),                 \
 136          (void)((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] |=           \
 137                 ((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT)))))
 138 #define BITFIELD_RESET(bf, b)                                           \
 139         (assert((size_t)(b) < (sizeof(bf) * CHAR_BIT)),                 \
 140          (void)((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] &=           \
 141                 ~((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT)))))
 142 #define BITFIELD_ISSET(bf, b)                                           \
 143         (assert((size_t)(b) < (sizeof(bf) * CHAR_BIT)),                 \
 144          !!(((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] &               \
 145              ((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT))))))
 146
 147 /* Number of elements in array. */
 148 #define elemof(a) (sizeof(a) / sizeof((a)[0]))
 149
 150 /* Cast pointer p to structure member m to its parent structure of type t. */
 151 #define containerof(p, t, m) ((t *)((uint8_t *)(p) - offsetof(t, m)))
 152
 153 /* Branch prediction helpers. */
 154 #ifndef likely
 155 #define likely(c) __builtin_expect(!!(c), 1)
 156 #endif
 157 #ifndef unlikely
 158 #define unlikely(c) __builtin_expect(!!(c), 0)
 159 #endif
 160
 161 /* Debugging */
 162 #ifndef NDEBUG
 163 #include <stdio.h>
 164 #define DEBUG__(m, ...)                                         \
 165         (fprintf(stderr, "%s:%d: %s(): " m "%c",                \
 166                  __FILE__, __LINE__, __func__, __VA_ARGS__),    \
 167          fflush(stderr),                                        \
 168          (void)0)
 169 /*
 170  * Save/restore errno around DEBUG__().
 171  * XXX somewhat undefined behavior, but works.
 172  */
 173 #define DEBUG_(...)                             \
 174         (errno = ((int []){                     \
 175                 *(volatile int *)&errno,        \
 176                 (DEBUG__(__VA_ARGS__), 0)       \
 177         })[0])
 178 #define DEBUG(...) DEBUG_(__VA_ARGS__, '\n')
 179 #define claim_zero(...) assert((__VA_ARGS__) == 0)
 180 #define claim_nonzero(...) assert((__VA_ARGS__) != 0)
 181 #define claim_positive(...) assert((__VA_ARGS__) >= 0)
 182 #else /* NDEBUG */
 183 /* No-ops. */
 184 #define DEBUG(...) (void)0
 185 #define claim_zero(...) (__VA_ARGS__)
 186 #define claim_nonzero(...) (__VA_ARGS__)
 187 #define claim_positive(...) (__VA_ARGS__)
 188 #endif /* NDEBUG */
 189
 190 struct mlx4_rxq_stats {
 191         unsigned int idx; /**< Mapping index. */
 192 #ifdef MLX4_PMD_SOFT_COUNTERS
 193         uint64_t ipackets; /**< Total of successfully received packets. */
 194         uint64_t ibytes; /**< Total of successfully received bytes. */
 195 #endif
 196         uint64_t idropped; /**< Total of packets dropped when RX ring full. */
 197         uint64_t rx_nombuf; /**< Total of RX mbuf allocation failures. */
 198 };
 199
 200 /* RX element (scattered packets). */
 201 struct rxq_elt_sp {
 202         struct ibv_recv_wr wr; /* Work Request. */
 203         struct ibv_sge sges[MLX4_PMD_SGE_WR_N]; /* Scatter/Gather Elements. */
 204         struct rte_mbuf *bufs[MLX4_PMD_SGE_WR_N]; /* SGEs buffers. */
 205 };
 206
 207 /* RX element. */
 208 struct rxq_elt {
 209         struct ibv_recv_wr wr; /* Work Request. */
 210         struct ibv_sge sge; /* Scatter/Gather Element. */
 211         /* mbuf pointer is derived from WR_ID(wr.wr_id).offset. */
 212 };
 213
 214 /* RX queue descriptor. */
 215 struct rxq {
 216         struct priv *priv; /* Back pointer to private data. */
 217         struct rte_mempool *mp; /* Memory Pool for allocations. */
 218         struct ibv_mr *mr; /* Memory Region (for mp). */
 219         struct ibv_cq *cq; /* Completion Queue. */
 220         struct ibv_qp *qp; /* Queue Pair. */
 221         struct ibv_exp_qp_burst_family *if_qp; /* QP burst interface. */
 222         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 223         /*
 224          * Each VLAN ID requires a separate flow steering rule.
 225          */
 226         BITFIELD_DECLARE(mac_configured, uint32_t, MLX4_MAX_MAC_ADDRESSES);
 227         struct ibv_flow *mac_flow[MLX4_MAX_MAC_ADDRESSES][MLX4_MAX_VLAN_IDS];
 228         struct ibv_flow *promisc_flow; /* Promiscuous flow. */
 229         struct ibv_flow *allmulti_flow; /* Multicast flow. */
 230         unsigned int port_id; /* Port ID for incoming packets. */
 231         unsigned int elts_n; /* (*elts)[] length. */
 232         unsigned int elts_head; /* Current index in (*elts)[]. */
 233         union {
 234                 struct rxq_elt_sp (*sp)[]; /* Scattered RX elements. */
 235                 struct rxq_elt (*no_sp)[]; /* RX elements. */
 236         } elts;
 237         unsigned int sp:1; /* Use scattered RX elements. */
 238         unsigned int csum:1; /* Enable checksum offloading. */
 239         unsigned int csum_l2tun:1; /* Same for L2 tunnels. */
 240         struct mlx4_rxq_stats stats; /* RX queue counters. */
 241         unsigned int socket; /* CPU socket ID for allocations. */
 242         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 243 };
 244
 245 /* TX element. */
 246 struct txq_elt {
 247         struct rte_mbuf *buf;
 248 };
 249
 250 struct mlx4_txq_stats {
 251         unsigned int idx; /**< Mapping index. */
 252 #ifdef MLX4_PMD_SOFT_COUNTERS
 253         uint64_t opackets; /**< Total of successfully sent packets. */
 254         uint64_t obytes;   /**< Total of successfully sent bytes. */
 255 #endif
 256         uint64_t odropped; /**< Total of packets not sent when TX ring full. */
 257 };
 258
 259 /*
 260  * Linear buffer type. It is used when transmitting buffers with too many
 261  * segments that do not fit the hardware queue (see max_send_sge).
 262  * Extra segments are copied (linearized) in such buffers, replacing the
 263  * last SGE during TX.
 264  * The size is arbitrary but large enough to hold a jumbo frame with
 265  * 8 segments considering mbuf.buf_len is about 2048 bytes.
 266  */
 267 typedef uint8_t linear_t[16384];
 268
 269 /* TX queue descriptor. */
 270 struct txq {
 271         struct priv *priv; /* Back pointer to private data. */
 272         struct {
 273                 const struct rte_mempool *mp; /* Cached Memory Pool. */
 274                 struct ibv_mr *mr; /* Memory Region (for mp). */
 275                 uint32_t lkey; /* mr->lkey */
 276         } mp2mr[MLX4_PMD_TX_MP_CACHE]; /* MP to MR translation table. */
 277         struct ibv_cq *cq; /* Completion Queue. */
 278         struct ibv_qp *qp; /* Queue Pair. */
 279         struct ibv_exp_qp_burst_family *if_qp; /* QP burst interface. */
 280         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 281 #if MLX4_PMD_MAX_INLINE > 0
 282         uint32_t max_inline; /* Max inline send size <= MLX4_PMD_MAX_INLINE. */
 283 #endif
 284         unsigned int elts_n; /* (*elts)[] length. */
 285         struct txq_elt (*elts)[]; /* TX elements. */
 286         unsigned int elts_head; /* Current index in (*elts)[]. */
 287         unsigned int elts_tail; /* First element awaiting completion. */
 288         unsigned int elts_comp; /* Number of completion requests. */
 289         unsigned int elts_comp_cd; /* Countdown for next completion request. */
 290         unsigned int elts_comp_cd_init; /* Initial value for countdown. */
 291         struct mlx4_txq_stats stats; /* TX queue counters. */
 292         linear_t (*elts_linear)[]; /* Linearized buffers. */
 293         struct ibv_mr *mr_linear; /* Memory Region for linearized buffers. */
 294         unsigned int socket; /* CPU socket ID for allocations. */
 295         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 296 };
 297
 298 struct rte_flow;
 299
 300 struct priv {
 301         struct rte_eth_dev *dev; /* Ethernet device. */
 302         struct ibv_context *ctx; /* Verbs context. */
 303         struct ibv_device_attr device_attr; /* Device properties. */
 304         struct ibv_pd *pd; /* Protection Domain. */
 305         /*
 306          * MAC addresses array and configuration bit-field.
 307          * An extra entry that cannot be modified by the DPDK is reserved
 308          * for broadcast frames (destination MAC address ff:ff:ff:ff:ff:ff).
 309          */
 310         struct ether_addr mac[MLX4_MAX_MAC_ADDRESSES];
 311         BITFIELD_DECLARE(mac_configured, uint32_t, MLX4_MAX_MAC_ADDRESSES);
 312         /* VLAN filters. */
 313         struct {
 314                 unsigned int enabled:1; /* If enabled. */
 315                 unsigned int id:12; /* VLAN ID (0-4095). */
 316         } vlan_filter[MLX4_MAX_VLAN_IDS]; /* VLAN filters table. */
 317         /* Device properties. */
 318         uint16_t mtu; /* Configured MTU. */
 319         uint8_t port; /* Physical port number. */
 320         unsigned int started:1; /* Device started, flows enabled. */
 321         unsigned int promisc:1; /* Device in promiscuous mode. */
 322         unsigned int allmulti:1; /* Device receives all multicast packets. */
 323         unsigned int hw_qpg:1; /* QP groups are supported. */
 324         unsigned int hw_tss:1; /* TSS is supported. */
 325         unsigned int hw_rss:1; /* RSS is supported. */
 326         unsigned int hw_csum:1; /* Checksum offload is supported. */
 327         unsigned int hw_csum_l2tun:1; /* Same for L2 tunnels. */
 328         unsigned int rss:1; /* RSS is enabled. */
 329         unsigned int vf:1; /* This is a VF device. */
 330         unsigned int pending_alarm:1; /* An alarm is pending. */
 331 #ifdef INLINE_RECV
 332         unsigned int inl_recv_size; /* Inline recv size */
 333 #endif
 334         unsigned int max_rss_tbl_sz; /* Maximum number of RSS queues. */
 335         /* RX/TX queues. */
 336         struct rxq rxq_parent; /* Parent queue when RSS is enabled. */
 337         unsigned int rxqs_n; /* RX queues array size. */
 338         unsigned int txqs_n; /* TX queues array size. */
 339         struct rxq *(*rxqs)[]; /* RX queues. */
 340         struct txq *(*txqs)[]; /* TX queues. */
 341         struct rte_intr_handle intr_handle; /* Interrupt handler. */
 342         LIST_HEAD(mlx4_flows, rte_flow) flows;
 343         rte_spinlock_t lock; /* Lock for control functions. */
 344 };
 345
 346 void priv_lock(struct priv *priv);
 347 void priv_unlock(struct priv *priv);
 348
 349 #endif /* RTE_PMD_MLX4_H_ */