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