src/plugins/dpdk/device/dpdk.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __included_dpdk_h__
  16 #define __included_dpdk_h__
  17
  18 /* $$$$ We should rename always_inline -> clib_always_inline */
  19 #undef always_inline
  20
  21 #define ALLOW_EXPERIMENTAL_API
  22
  23 #include <rte_config.h>
  24
  25 #include <rte_common.h>
  26 #include <rte_dev.h>
  27 #include <rte_memory.h>
  28 #include <rte_eal.h>
  29 #include <rte_per_lcore.h>
  30 #include <rte_cycles.h>
  31 #include <rte_lcore.h>
  32 #include <rte_per_lcore.h>
  33 #include <rte_interrupts.h>
  34 #include <rte_pci.h>
  35 #include <rte_ether.h>
  36 #include <rte_ethdev.h>
  37 #include <rte_ring.h>
  38 #include <rte_mempool.h>
  39 #include <rte_mbuf.h>
  40 #include <rte_version.h>
  41 #include <rte_sched.h>
  42 #include <rte_net.h>
  43 #include <rte_bus_pci.h>
  44 #include <rte_flow.h>
  45
  46 #include <vnet/devices/devices.h>
  47
  48 #if CLIB_DEBUG > 0
  49 #define always_inline static inline
  50 #else
  51 #define always_inline static inline __attribute__ ((__always_inline__))
  52 #endif
  53
  54 #include <vlib/pci/pci.h>
  55 #include <vnet/flow/flow.h>
  56
  57 extern vnet_device_class_t dpdk_device_class;
  58 extern vlib_node_registration_t dpdk_input_node;
  59 extern vlib_node_registration_t admin_up_down_process_node;
  60
  61 #if RTE_VERSION < RTE_VERSION_NUM(20, 8, 0, 0)
  62 #define DPDK_MLX5_PMD_NAME "net_mlx5"
  63 #else
  64 #define DPDK_MLX5_PMD_NAME "mlx5_pci"
  65 #endif
  66
  67 #define foreach_dpdk_pmd          \
  68   _ ("net_thunderx", THUNDERX)    \
  69   _ ("net_e1000_em", E1000EM)     \
  70   _ ("net_e1000_igb", IGB)        \
  71   _ ("net_e1000_igb_vf", IGBVF)   \
  72   _ ("net_ixgbe", IXGBE)          \
  73   _ ("net_ixgbe_vf", IXGBEVF)     \
  74   _ ("net_i40e", I40E)            \
  75   _ ("net_i40e_vf", I40EVF)       \
  76   _ ("net_ice", ICE)              \
  77   _ ("net_iavf", IAVF)            \
  78   _ ("net_virtio", VIRTIO)        \
  79   _ ("net_enic", ENIC)            \
  80   _ ("net_vmxnet3", VMXNET3)      \
  81   _ ("AF_PACKET PMD", AF_PACKET)  \
  82   _ ("net_fm10k", FM10K)          \
  83   _ ("net_cxgbe", CXGBE)          \
  84   _ ("net_mlx4", MLX4)            \
  85   _ (DPDK_MLX5_PMD_NAME, MLX5)    \
  86   _ ("net_dpaa2", DPAA2)          \
  87   _ ("net_virtio_user", VIRTIO_USER) \
  88   _ ("net_vhost", VHOST_ETHER)    \
  89   _ ("net_ena", ENA)              \
  90   _ ("net_failsafe", FAILSAFE)    \
  91   _ ("net_liovf", LIOVF_ETHER)    \
  92   _ ("net_qede", QEDE)            \
  93   _ ("net_netvsc", NETVSC)        \
  94   _ ("net_bnxt", BNXT)
  95
  96 typedef enum
  97 {
  98   VNET_DPDK_PMD_NONE,
  99 #define _(s,f) VNET_DPDK_PMD_##f,
 100   foreach_dpdk_pmd
 101 #undef _
 102     VNET_DPDK_PMD_UNKNOWN,      /* must be last */
 103 } dpdk_pmd_t;
 104
 105 typedef enum
 106 {
 107   VNET_DPDK_PORT_TYPE_ETH_1G,
 108   VNET_DPDK_PORT_TYPE_ETH_2_5G,
 109   VNET_DPDK_PORT_TYPE_ETH_5G,
 110   VNET_DPDK_PORT_TYPE_ETH_10G,
 111   VNET_DPDK_PORT_TYPE_ETH_20G,
 112   VNET_DPDK_PORT_TYPE_ETH_25G,
 113   VNET_DPDK_PORT_TYPE_ETH_40G,
 114   VNET_DPDK_PORT_TYPE_ETH_50G,
 115   VNET_DPDK_PORT_TYPE_ETH_56G,
 116   VNET_DPDK_PORT_TYPE_ETH_100G,
 117   VNET_DPDK_PORT_TYPE_ETH_SWITCH,
 118   VNET_DPDK_PORT_TYPE_AF_PACKET,
 119   VNET_DPDK_PORT_TYPE_ETH_VF,
 120   VNET_DPDK_PORT_TYPE_VIRTIO_USER,
 121   VNET_DPDK_PORT_TYPE_VHOST_ETHER,
 122   VNET_DPDK_PORT_TYPE_FAILSAFE,
 123   VNET_DPDK_PORT_TYPE_NETVSC,
 124   VNET_DPDK_PORT_TYPE_UNKNOWN,
 125 } dpdk_port_type_t;
 126
 127 typedef uint16_t dpdk_portid_t;
 128
 129 #define foreach_dpdk_device_flags \
 130   _( 0, ADMIN_UP, "admin-up") \
 131   _( 1, PROMISC, "promisc") \
 132   _( 2, PMD, "pmd") \
 133   _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
 134   _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
 135   _( 5, HAVE_SUBIF, "subif") \
 136   _( 9, TX_OFFLOAD, "tx-offload") \
 137   _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
 138   _(11, RX_FLOW_OFFLOAD, "rx-flow-offload") \
 139   _(12, RX_IP4_CKSUM, "rx-ip4-cksum")
 140
 141 enum
 142 {
 143 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
 144   foreach_dpdk_device_flags
 145 #undef _
 146 };
 147
 148 typedef struct
 149 {
 150   u32 flow_index;
 151   u32 mark;
 152   struct rte_flow *handle;
 153 } dpdk_flow_entry_t;
 154
 155 typedef struct
 156 {
 157   u32 flow_id;
 158   u16 next_index;
 159   i16 buffer_advance;
 160 } dpdk_flow_lookup_entry_t;
 161
 162 typedef struct
 163 {
 164   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 165   u8 buffer_pool_index;
 166 } dpdk_rx_queue_t;
 167
 168 typedef struct
 169 {
 170   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 171   clib_spinlock_t lock;
 172 } dpdk_tx_queue_t;
 173
 174 typedef struct
 175 {
 176   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 177
 178   dpdk_rx_queue_t *rx_queues;
 179   dpdk_tx_queue_t *tx_queues;
 180
 181   /* Instance ID to access internal device array. */
 182   u32 device_index;
 183
 184   u32 hw_if_index;
 185   u32 sw_if_index;
 186
 187   /* next node index if we decide to steal the rx graph arc */
 188   u32 per_interface_next_index;
 189
 190   u16 rx_q_used;
 191   u16 tx_q_used;
 192   u16 flags;
 193
 194   /* DPDK device port number */
 195   dpdk_portid_t port_id;
 196   dpdk_pmd_t pmd:8;
 197   i8 cpu_socket;
 198
 199     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 200   u16 nb_tx_desc;
 201   u16 nb_rx_desc;
 202
 203   u8 *name;
 204   u8 *interface_name_suffix;
 205
 206   /* number of sub-interfaces */
 207   u16 num_subifs;
 208
 209   /* PMD related */
 210   struct rte_eth_conf port_conf;
 211   struct rte_eth_txconf tx_conf;
 212
 213   /* flow related */
 214   u32 supported_flow_actions;
 215   dpdk_flow_entry_t *flow_entries;      /* pool */
 216   dpdk_flow_lookup_entry_t *flow_lookup_entries;        /* pool */
 217   u32 *parked_lookup_indexes;   /* vector */
 218   u32 parked_loop_count;
 219   struct rte_flow_error last_flow_error;
 220
 221   /* af_packet instance number */
 222   u16 af_packet_instance_num;
 223
 224   struct rte_eth_link link;
 225   f64 time_last_link_update;
 226
 227   struct rte_eth_stats stats;
 228   struct rte_eth_stats last_stats;
 229   struct rte_eth_xstat *xstats;
 230   f64 time_last_stats_update;
 231   dpdk_port_type_t port_type;
 232
 233   /* mac address */
 234   u8 *default_mac_address;
 235
 236   /* error string */
 237   clib_error_t *errors;
 238 } dpdk_device_t;
 239
 240 #define DPDK_STATS_POLL_INTERVAL      (10.0)
 241 #define DPDK_MIN_STATS_POLL_INTERVAL  (0.001)   /* 1msec */
 242
 243 #define DPDK_LINK_POLL_INTERVAL       (3.0)
 244 #define DPDK_MIN_LINK_POLL_INTERVAL   (0.001)   /* 1msec */
 245
 246 #define foreach_dpdk_device_config_item \
 247   _ (num_rx_queues) \
 248   _ (num_tx_queues) \
 249   _ (num_rx_desc) \
 250   _ (num_tx_desc) \
 251   _ (rss_fn)
 252
 253 typedef struct
 254 {
 255   vlib_pci_addr_t pci_addr;
 256   u8 *name;
 257   u8 is_blacklisted;
 258   u8 vlan_strip_offload;
 259 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
 260 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
 261 #define DPDK_DEVICE_VLAN_STRIP_ON  2
 262
 263 #define _(x) uword x;
 264     foreach_dpdk_device_config_item
 265 #undef _
 266     clib_bitmap_t * workers;
 267   u8 tso;
 268   u8 *devargs;
 269   clib_bitmap_t *rss_queues;
 270
 271 #define DPDK_DEVICE_TSO_DEFAULT 0
 272 #define DPDK_DEVICE_TSO_OFF 1
 273 #define DPDK_DEVICE_TSO_ON  2
 274 } dpdk_device_config_t;
 275
 276 typedef struct
 277 {
 278
 279   /* Config stuff */
 280   u8 **eal_init_args;
 281   u8 *eal_init_args_str;
 282   u8 *uio_driver_name;
 283   u8 no_multi_seg;
 284   u8 enable_tcp_udp_checksum;
 285   u8 no_tx_checksum_offload;
 286
 287   /* Required config parameters */
 288   u8 coremask_set_manually;
 289   u8 nchannels_set_manually;
 290   u32 coremask;
 291   u32 nchannels;
 292   u32 num_crypto_mbufs;
 293
 294   /*
 295    * format interface names ala xxxEthernet%d/%d/%d instead of
 296    * xxxEthernet%x/%x/%x.
 297    */
 298   u8 interface_name_format_decimal;
 299
 300   /* per-device config */
 301   dpdk_device_config_t default_devconf;
 302   dpdk_device_config_t *dev_confs;
 303   uword *device_config_index_by_pci_addr;
 304
 305   /* devices blacklist by pci vendor_id, device_id */
 306   u32 *blacklist_by_pci_vendor_and_device;
 307
 308 } dpdk_config_main_t;
 309
 310 extern dpdk_config_main_t dpdk_config_main;
 311
 312 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
 313
 314 typedef struct
 315 {
 316   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 317   struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
 318   u32 buffers[DPDK_RX_BURST_SZ];
 319   u16 next[DPDK_RX_BURST_SZ];
 320   u16 etype[DPDK_RX_BURST_SZ];
 321   u16 flags[DPDK_RX_BURST_SZ];
 322   vlib_buffer_t buffer_template;
 323 } dpdk_per_thread_data_t;
 324
 325 typedef struct
 326 {
 327
 328   /* Devices */
 329   dpdk_device_t *devices;
 330   dpdk_per_thread_data_t *per_thread_data;
 331
 332   /* buffer flags template, configurable to enable/disable tcp / udp cksum */
 333   u32 buffer_flags_template;
 334
 335   /*
 336    * flag indicating that a posted admin up/down
 337    * (via post_sw_interface_set_flags) is in progress
 338    */
 339   u8 admin_up_down_in_progress;
 340
 341   /* control interval of dpdk link state and stat polling */
 342   f64 link_state_poll_interval;
 343   f64 stat_poll_interval;
 344
 345   /* convenience */
 346   vlib_main_t *vlib_main;
 347   vnet_main_t *vnet_main;
 348   dpdk_config_main_t *conf;
 349
 350   /* API message ID base */
 351   u16 msg_id_base;
 352
 353   /* logging */
 354   vlib_log_class_t log_default;
 355   vlib_log_class_t log_cryptodev;
 356   vlib_log_class_t log_ipsec;
 357 } dpdk_main_t;
 358
 359 extern dpdk_main_t dpdk_main;
 360
 361 typedef struct
 362 {
 363   u32 buffer_index;
 364   u16 device_index;
 365   u8 queue_index;
 366   struct rte_mbuf mb;
 367   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 368   /* Copy of VLIB buffer; packet data stored in pre_data. */
 369   vlib_buffer_t buffer;
 370 } dpdk_tx_trace_t;
 371
 372 typedef struct
 373 {
 374   u32 buffer_index;
 375   u16 device_index;
 376   u16 queue_index;
 377   struct rte_mbuf mb;
 378   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 379   vlib_buffer_t buffer;         /* Copy of VLIB buffer; pkt data stored in pre_data. */
 380 } dpdk_rx_trace_t;
 381
 382 void dpdk_device_setup (dpdk_device_t * xd);
 383 void dpdk_device_start (dpdk_device_t * xd);
 384 void dpdk_device_stop (dpdk_device_t * xd);
 385 int dpdk_port_state_callback (dpdk_portid_t port_id,
 386                               enum rte_eth_event_type type,
 387                               void *param, void *ret_param);
 388
 389 #define foreach_dpdk_error                                              \
 390   _(NONE, "no error")                                                   \
 391   _(RX_PACKET_ERROR, "Rx packet errors")                                \
 392   _(RX_BAD_FCS, "Rx bad fcs")                                           \
 393   _(IP_CHECKSUM_ERROR, "Rx ip checksum errors")                         \
 394   _(RX_ALLOC_FAIL, "rx buf alloc from free list failed")                \
 395   _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem")              \
 396   _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
 397
 398 typedef enum
 399 {
 400 #define _(f,s) DPDK_ERROR_##f,
 401   foreach_dpdk_error
 402 #undef _
 403     DPDK_N_ERROR,
 404 } dpdk_error_t;
 405
 406 #define dpdk_log_err(...) \
 407   vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
 408 #define dpdk_log_warn(...) \
 409   vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
 410 #define dpdk_log_notice(...) \
 411   vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
 412 #define dpdk_log_info(...) \
 413   vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
 414
 415 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
 416
 417 #define foreach_dpdk_rss_hf                    \
 418   _(0, ETH_RSS_FRAG_IPV4,           "ipv4-frag")    \
 419   _(1, ETH_RSS_NONFRAG_IPV4_TCP,    "ipv4-tcp")     \
 420   _(2, ETH_RSS_NONFRAG_IPV4_UDP,    "ipv4-udp")     \
 421   _(3, ETH_RSS_NONFRAG_IPV4_SCTP,   "ipv4-sctp")    \
 422   _(4, ETH_RSS_NONFRAG_IPV4_OTHER,  "ipv4-other")   \
 423   _(5, ETH_RSS_IPV4,                "ipv4")         \
 424   _(6, ETH_RSS_IPV6_TCP_EX,         "ipv6-tcp-ex")  \
 425   _(7, ETH_RSS_IPV6_UDP_EX,         "ipv6-udp-ex")  \
 426   _(8, ETH_RSS_FRAG_IPV6,           "ipv6-frag")    \
 427   _(9, ETH_RSS_NONFRAG_IPV6_TCP,    "ipv6-tcp")     \
 428   _(10, ETH_RSS_NONFRAG_IPV6_UDP,   "ipv6-udp")     \
 429   _(11, ETH_RSS_NONFRAG_IPV6_SCTP,  "ipv6-sctp")    \
 430   _(12, ETH_RSS_NONFRAG_IPV6_OTHER, "ipv6-other")   \
 431   _(13, ETH_RSS_IPV6_EX,            "ipv6-ex")      \
 432   _(14, ETH_RSS_IPV6,               "ipv6")         \
 433   _(15, ETH_RSS_L2_PAYLOAD,         "l2-payload")   \
 434   _(16, ETH_RSS_PORT,               "port")         \
 435   _(17, ETH_RSS_VXLAN,              "vxlan")        \
 436   _(18, ETH_RSS_GENEVE,             "geneve")       \
 437   _(19, ETH_RSS_NVGRE,              "nvgre")        \
 438   _(20, ETH_RSS_GTPU,               "gtpu")         \
 439   _(60, ETH_RSS_L4_DST_ONLY,        "l4-dst-only")  \
 440   _(61, ETH_RSS_L4_SRC_ONLY,        "l4-src-only")  \
 441   _(62, ETH_RSS_L3_DST_ONLY,        "l3-dst-only")  \
 442   _(63, ETH_RSS_L3_SRC_ONLY,        "l3-src-only")
 443
 444 format_function_t format_dpdk_device_name;
 445 format_function_t format_dpdk_device;
 446 format_function_t format_dpdk_device_errors;
 447 format_function_t format_dpdk_tx_trace;
 448 format_function_t format_dpdk_rx_trace;
 449 format_function_t format_dpdk_rte_mbuf;
 450 format_function_t format_dpdk_rx_rte_mbuf;
 451 format_function_t format_dpdk_flow;
 452 format_function_t format_dpdk_rss_hf_name;
 453 format_function_t format_dpdk_rx_offload_caps;
 454 format_function_t format_dpdk_tx_offload_caps;
 455 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
 456
 457 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
 458
 459 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
 460                                             *info);
 461 void dpdk_cli_reference (void);
 462
 463 #if CLI_DEBUG
 464 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
 465 void dpdk_buffer_poison_trajectory_all (void);
 466 #endif
 467
 468 #endif /* __included_dpdk_h__ */
 469
 470 /*
 471  * fd.io coding-style-patch-verification: ON
 472  *
 473  * Local Variables:
 474  * eval: (c-set-style "gnu")
 475  * End:
 476  */