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