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   _ (13, INT_SUPPORTED, "int-supported")                                      \
 143   _ (14, INT_UNMASKABLE, "int-unmaskable")
 144
 145 enum
 146 {
 147 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
 148   foreach_dpdk_device_flags
 149 #undef _
 150 };
 151
 152 typedef struct
 153 {
 154   u32 flow_index;
 155   u32 mark;
 156   struct rte_flow *handle;
 157 } dpdk_flow_entry_t;
 158
 159 typedef struct
 160 {
 161   u32 flow_id;
 162   u16 next_index;
 163   i16 buffer_advance;
 164 } dpdk_flow_lookup_entry_t;
 165
 166 typedef struct
 167 {
 168   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 169   u8 buffer_pool_index;
 170   u32 queue_index;
 171   int efd;
 172   uword clib_file_index;
 173 } dpdk_rx_queue_t;
 174
 175 typedef struct
 176 {
 177   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 178   clib_spinlock_t lock;
 179 } dpdk_tx_queue_t;
 180
 181 typedef struct
 182 {
 183   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 184
 185   dpdk_rx_queue_t *rx_queues;
 186   dpdk_tx_queue_t *tx_queues;
 187
 188   /* Instance ID to access internal device array. */
 189   u32 device_index;
 190
 191   u32 hw_if_index;
 192   u32 sw_if_index;
 193
 194   /* next node index if we decide to steal the rx graph arc */
 195   u32 per_interface_next_index;
 196
 197   u16 rx_q_used;
 198   u16 tx_q_used;
 199   u16 flags;
 200
 201   /* DPDK device port number */
 202   dpdk_portid_t port_id;
 203   dpdk_pmd_t pmd:8;
 204   i8 cpu_socket;
 205
 206     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 207   u16 nb_tx_desc;
 208   u16 nb_rx_desc;
 209
 210   u8 *name;
 211   u8 *interface_name_suffix;
 212
 213   /* number of sub-interfaces */
 214   u16 num_subifs;
 215
 216   /* PMD related */
 217   struct rte_eth_conf port_conf;
 218   struct rte_eth_txconf tx_conf;
 219
 220   /* flow related */
 221   u32 supported_flow_actions;
 222   dpdk_flow_entry_t *flow_entries;      /* pool */
 223   dpdk_flow_lookup_entry_t *flow_lookup_entries;        /* pool */
 224   u32 *parked_lookup_indexes;   /* vector */
 225   u32 parked_loop_count;
 226   struct rte_flow_error last_flow_error;
 227
 228   /* af_packet instance number */
 229   u16 af_packet_instance_num;
 230
 231   struct rte_eth_link link;
 232   f64 time_last_link_update;
 233
 234   struct rte_eth_stats stats;
 235   struct rte_eth_stats last_stats;
 236   struct rte_eth_xstat *xstats;
 237   f64 time_last_stats_update;
 238   dpdk_port_type_t port_type;
 239
 240   /* mac address */
 241   u8 *default_mac_address;
 242
 243   /* error string */
 244   clib_error_t *errors;
 245 } dpdk_device_t;
 246
 247 #define DPDK_STATS_POLL_INTERVAL      (10.0)
 248 #define DPDK_MIN_STATS_POLL_INTERVAL  (0.001)   /* 1msec */
 249
 250 #define DPDK_LINK_POLL_INTERVAL       (3.0)
 251 #define DPDK_MIN_LINK_POLL_INTERVAL   (0.001)   /* 1msec */
 252
 253 #define foreach_dpdk_device_config_item \
 254   _ (num_rx_queues) \
 255   _ (num_tx_queues) \
 256   _ (num_rx_desc) \
 257   _ (num_tx_desc) \
 258   _ (rss_fn)
 259
 260 typedef enum
 261 {
 262   VNET_DEV_ADDR_PCI,
 263   VNET_DEV_ADDR_VMBUS,
 264   VNET_DEV_ADDR_ANY,
 265 } dpdk_device_addr_type_t;
 266
 267 typedef struct
 268 {
 269   union
 270   {
 271     vlib_pci_addr_t pci_addr;
 272     vlib_vmbus_addr_t vmbus_addr;
 273   };
 274   dpdk_device_addr_type_t dev_addr_type;
 275   u8 *name;
 276   u8 is_blacklisted;
 277   u8 vlan_strip_offload;
 278 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
 279 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
 280 #define DPDK_DEVICE_VLAN_STRIP_ON  2
 281
 282 #define _(x) uword x;
 283     foreach_dpdk_device_config_item
 284 #undef _
 285     clib_bitmap_t * workers;
 286   u8 tso;
 287   u8 *devargs;
 288   clib_bitmap_t *rss_queues;
 289
 290 #define DPDK_DEVICE_TSO_DEFAULT 0
 291 #define DPDK_DEVICE_TSO_OFF 1
 292 #define DPDK_DEVICE_TSO_ON  2
 293 } dpdk_device_config_t;
 294
 295 typedef struct
 296 {
 297
 298   /* Config stuff */
 299   u8 **eal_init_args;
 300   u8 *eal_init_args_str;
 301   u8 *uio_driver_name;
 302   u8 no_multi_seg;
 303   u8 enable_tcp_udp_checksum;
 304   u8 no_tx_checksum_offload;
 305   u8 enable_telemetry;
 306
 307   /* Required config parameters */
 308   u8 coremask_set_manually;
 309   u8 nchannels_set_manually;
 310   u32 coremask;
 311   u32 nchannels;
 312   u32 num_crypto_mbufs;
 313
 314   /*
 315    * format interface names ala xxxEthernet%d/%d/%d instead of
 316    * xxxEthernet%x/%x/%x.
 317    */
 318   u8 interface_name_format_decimal;
 319
 320   /* per-device config */
 321   dpdk_device_config_t default_devconf;
 322   dpdk_device_config_t *dev_confs;
 323   uword *device_config_index_by_pci_addr;
 324   mhash_t device_config_index_by_vmbus_addr;
 325
 326   /* devices blacklist by pci vendor_id, device_id */
 327   u32 *blacklist_by_pci_vendor_and_device;
 328   /* devices blacklist by VMBUS address */
 329   vlib_vmbus_addr_t *blacklist_by_vmbus_addr;
 330
 331 } dpdk_config_main_t;
 332
 333 extern dpdk_config_main_t dpdk_config_main;
 334
 335 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
 336
 337 typedef struct
 338 {
 339   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 340   struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
 341   u32 buffers[DPDK_RX_BURST_SZ];
 342   u16 next[DPDK_RX_BURST_SZ];
 343   u16 etype[DPDK_RX_BURST_SZ];
 344   u16 flags[DPDK_RX_BURST_SZ];
 345   vlib_buffer_t buffer_template;
 346 } dpdk_per_thread_data_t;
 347
 348 typedef struct
 349 {
 350
 351   /* Devices */
 352   dpdk_device_t *devices;
 353   dpdk_per_thread_data_t *per_thread_data;
 354
 355   /* buffer flags template, configurable to enable/disable tcp / udp cksum */
 356   u32 buffer_flags_template;
 357
 358   /*
 359    * flag indicating that a posted admin up/down
 360    * (via post_sw_interface_set_flags) is in progress
 361    */
 362   u8 admin_up_down_in_progress;
 363
 364   /* control interval of dpdk link state and stat polling */
 365   f64 link_state_poll_interval;
 366   f64 stat_poll_interval;
 367
 368   /* convenience */
 369   vlib_main_t *vlib_main;
 370   vnet_main_t *vnet_main;
 371   dpdk_config_main_t *conf;
 372
 373   /* API message ID base */
 374   u16 msg_id_base;
 375
 376   /* logging */
 377   vlib_log_class_t log_default;
 378   vlib_log_class_t log_cryptodev;
 379   vlib_log_class_t log_ipsec;
 380 } dpdk_main_t;
 381
 382 extern dpdk_main_t dpdk_main;
 383
 384 typedef struct
 385 {
 386   u32 buffer_index;
 387   u16 device_index;
 388   u8 queue_index;
 389   struct rte_mbuf mb;
 390   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 391   /* Copy of VLIB buffer; packet data stored in pre_data. */
 392   vlib_buffer_t buffer;
 393 } dpdk_tx_trace_t;
 394
 395 typedef struct
 396 {
 397   u32 buffer_index;
 398   u16 device_index;
 399   u16 queue_index;
 400   struct rte_mbuf mb;
 401   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 402   vlib_buffer_t buffer;         /* Copy of VLIB buffer; pkt data stored in pre_data. */
 403 } dpdk_rx_trace_t;
 404
 405 void dpdk_device_setup (dpdk_device_t * xd);
 406 void dpdk_device_start (dpdk_device_t * xd);
 407 void dpdk_device_stop (dpdk_device_t * xd);
 408 int dpdk_port_state_callback (dpdk_portid_t port_id,
 409                               enum rte_eth_event_type type,
 410                               void *param, void *ret_param);
 411
 412 #define foreach_dpdk_error                                              \
 413   _(NONE, "no error")                                                   \
 414   _(RX_PACKET_ERROR, "Rx packet errors")                                \
 415   _(RX_BAD_FCS, "Rx bad fcs")                                           \
 416   _(IP_CHECKSUM_ERROR, "Rx ip checksum errors")                         \
 417   _(RX_ALLOC_FAIL, "rx buf alloc from free list failed")                \
 418   _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem")              \
 419   _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
 420
 421 typedef enum
 422 {
 423 #define _(f,s) DPDK_ERROR_##f,
 424   foreach_dpdk_error
 425 #undef _
 426     DPDK_N_ERROR,
 427 } dpdk_error_t;
 428
 429 #define dpdk_log_err(...) \
 430   vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
 431 #define dpdk_log_warn(...) \
 432   vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
 433 #define dpdk_log_notice(...) \
 434   vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
 435 #define dpdk_log_info(...) \
 436   vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
 437
 438 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
 439
 440 #define foreach_dpdk_rss_hf                    \
 441   _(0, ETH_RSS_FRAG_IPV4,           "ipv4-frag")    \
 442   _(1, ETH_RSS_NONFRAG_IPV4_TCP,    "ipv4-tcp")     \
 443   _(2, ETH_RSS_NONFRAG_IPV4_UDP,    "ipv4-udp")     \
 444   _(3, ETH_RSS_NONFRAG_IPV4_SCTP,   "ipv4-sctp")    \
 445   _(4, ETH_RSS_NONFRAG_IPV4_OTHER,  "ipv4-other")   \
 446   _(5, ETH_RSS_IPV4,                "ipv4")         \
 447   _(6, ETH_RSS_IPV6_TCP_EX,         "ipv6-tcp-ex")  \
 448   _(7, ETH_RSS_IPV6_UDP_EX,         "ipv6-udp-ex")  \
 449   _(8, ETH_RSS_FRAG_IPV6,           "ipv6-frag")    \
 450   _(9, ETH_RSS_NONFRAG_IPV6_TCP,    "ipv6-tcp")     \
 451   _(10, ETH_RSS_NONFRAG_IPV6_UDP,   "ipv6-udp")     \
 452   _(11, ETH_RSS_NONFRAG_IPV6_SCTP,  "ipv6-sctp")    \
 453   _(12, ETH_RSS_NONFRAG_IPV6_OTHER, "ipv6-other")   \
 454   _(13, ETH_RSS_IPV6_EX,            "ipv6-ex")      \
 455   _(14, ETH_RSS_IPV6,               "ipv6")         \
 456   _(15, ETH_RSS_L2_PAYLOAD,         "l2-payload")   \
 457   _(16, ETH_RSS_PORT,               "port")         \
 458   _(17, ETH_RSS_VXLAN,              "vxlan")        \
 459   _(18, ETH_RSS_GENEVE,             "geneve")       \
 460   _(19, ETH_RSS_NVGRE,              "nvgre")        \
 461   _(20, ETH_RSS_GTPU,               "gtpu")         \
 462   _(60, ETH_RSS_L4_DST_ONLY,        "l4-dst-only")  \
 463   _(61, ETH_RSS_L4_SRC_ONLY,        "l4-src-only")  \
 464   _(62, ETH_RSS_L3_DST_ONLY,        "l3-dst-only")  \
 465   _(63, ETH_RSS_L3_SRC_ONLY,        "l3-src-only")
 466
 467 format_function_t format_dpdk_device_name;
 468 format_function_t format_dpdk_device;
 469 format_function_t format_dpdk_device_errors;
 470 format_function_t format_dpdk_tx_trace;
 471 format_function_t format_dpdk_rx_trace;
 472 format_function_t format_dpdk_rte_mbuf;
 473 format_function_t format_dpdk_rx_rte_mbuf;
 474 format_function_t format_dpdk_flow;
 475 format_function_t format_dpdk_rss_hf_name;
 476 format_function_t format_dpdk_rx_offload_caps;
 477 format_function_t format_dpdk_tx_offload_caps;
 478 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
 479
 480 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
 481
 482 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
 483                                             *info);
 484 struct rte_vmbus_device *
 485 dpdk_get_vmbus_device (const struct rte_eth_dev_info *info);
 486 void dpdk_cli_reference (void);
 487
 488 #if CLI_DEBUG
 489 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
 490 void dpdk_buffer_poison_trajectory_all (void);
 491 #endif
 492
 493 #endif /* __included_dpdk_h__ */
 494
 495 /*
 496  * fd.io coding-style-patch-verification: ON
 497  *
 498  * Local Variables:
 499  * eval: (c-set-style "gnu")
 500  * End:
 501  */