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 #include <rte_config.h>
  22
  23 #include <rte_common.h>
  24 #include <rte_dev.h>
  25 #include <rte_memory.h>
  26 #include <rte_eal.h>
  27 #include <rte_per_lcore.h>
  28 #include <rte_cycles.h>
  29 #include <rte_lcore.h>
  30 #include <rte_per_lcore.h>
  31 #include <rte_interrupts.h>
  32 #include <rte_pci.h>
  33 #include <rte_ether.h>
  34 #include <rte_ethdev.h>
  35 #include <rte_ring.h>
  36 #include <rte_mempool.h>
  37 #include <rte_mbuf.h>
  38 #include <rte_version.h>
  39 #include <rte_eth_bond.h>
  40 #include <rte_sched.h>
  41
  42 #include <vnet/unix/pcap.h>
  43 #include <vnet/devices/devices.h>
  44
  45 #if CLIB_DEBUG > 0
  46 #define always_inline static inline
  47 #else
  48 #define always_inline static inline __attribute__ ((__always_inline__))
  49 #endif
  50
  51 #include <vlib/pci/pci.h>
  52
  53 #define NB_MBUF   (16<<10)
  54
  55 extern vnet_device_class_t dpdk_device_class;
  56 extern vlib_node_registration_t dpdk_input_node;
  57
  58 #if RTE_VERSION >= RTE_VERSION_NUM(17, 2, 0, 0)
  59 #define foreach_dpdk_pmd          \
  60   _ ("net_thunderx", THUNDERX)    \
  61   _ ("net_e1000_em", E1000EM)     \
  62   _ ("net_e1000_igb", IGB)        \
  63   _ ("net_e1000_igb_vf", IGBVF)   \
  64   _ ("net_ixgbe", IXGBE)          \
  65   _ ("net_ixgbe_vf", IXGBEVF)     \
  66   _ ("net_i40e", I40E)            \
  67   _ ("net_i40e_vf", I40EVF)       \
  68   _ ("net_virtio", VIRTIO)        \
  69   _ ("net_enic", ENIC)            \
  70   _ ("net_vmxnet3", VMXNET3)      \
  71   _ ("AF_PACKET PMD", AF_PACKET)  \
  72   _ ("net_bonding", BOND)         \
  73   _ ("net_fm10k", FM10K)          \
  74   _ ("net_cxgbe", CXGBE)          \
  75   _ ("net_mlx4", MLX4)            \
  76   _ ("net_mlx5", MLX5)            \
  77   _ ("net_dpaa2", DPAA2)
  78 #else
  79 #define foreach_dpdk_pmd          \
  80   _ ("net_thunderx", THUNDERX)    \
  81   _ ("net_e1000_em", E1000EM)     \
  82   _ ("net_e1000_igb", IGB)        \
  83   _ ("net_e1000_igb_vf", IGBVF)   \
  84   _ ("net_ixgbe", IXGBE)          \
  85   _ ("net_ixgbe_vf", IXGBEVF)     \
  86   _ ("net_i40e", I40E)            \
  87   _ ("net_i40e_vf", I40EVF)       \
  88   _ ("net_virtio", VIRTIO)        \
  89   _ ("net_enic", ENIC)            \
  90   _ ("net_vmxnet3", VMXNET3)      \
  91   _ ("AF_PACKET PMD", AF_PACKET)  \
  92   _ ("rte_bond_pmd", BOND)        \
  93   _ ("net_fm10k", FM10K)          \
  94   _ ("net_cxgbe", CXGBE)          \
  95   _ ("net_mlx4", MLX4)            \
  96   _ ("net_mlx5", MLX5)            \
  97   _ ("net_dpaa2", DPAA2)
  98 #endif
  99
 100 typedef enum
 101 {
 102   VNET_DPDK_PMD_NONE,
 103 #define _(s,f) VNET_DPDK_PMD_##f,
 104   foreach_dpdk_pmd
 105 #undef _
 106     VNET_DPDK_PMD_UNKNOWN,      /* must be last */
 107 } dpdk_pmd_t;
 108
 109 typedef enum
 110 {
 111   VNET_DPDK_PORT_TYPE_ETH_1G,
 112   VNET_DPDK_PORT_TYPE_ETH_10G,
 113   VNET_DPDK_PORT_TYPE_ETH_25G,
 114   VNET_DPDK_PORT_TYPE_ETH_40G,
 115   VNET_DPDK_PORT_TYPE_ETH_100G,
 116   VNET_DPDK_PORT_TYPE_ETH_BOND,
 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_UNKNOWN,
 121 } dpdk_port_type_t;
 122
 123 /*
 124  * The header for the tx_vector in dpdk_device_t.
 125  * Head and tail are indexes into the tx_vector and are of type
 126  * u64 so they never overflow.
 127  */
 128 typedef struct
 129 {
 130   u64 tx_head;
 131   u64 tx_tail;
 132 } tx_ring_hdr_t;
 133
 134 typedef struct
 135 {
 136   struct rte_ring *swq;
 137
 138   u64 hqos_field0_slabmask;
 139   u32 hqos_field0_slabpos;
 140   u32 hqos_field0_slabshr;
 141   u64 hqos_field1_slabmask;
 142   u32 hqos_field1_slabpos;
 143   u32 hqos_field1_slabshr;
 144   u64 hqos_field2_slabmask;
 145   u32 hqos_field2_slabpos;
 146   u32 hqos_field2_slabshr;
 147   u32 hqos_tc_table[64];
 148 } dpdk_device_hqos_per_worker_thread_t;
 149
 150 typedef struct
 151 {
 152   struct rte_ring **swq;
 153   struct rte_mbuf **pkts_enq;
 154   struct rte_mbuf **pkts_deq;
 155   struct rte_sched_port *hqos;
 156   u32 hqos_burst_enq;
 157   u32 hqos_burst_deq;
 158   u32 pkts_enq_len;
 159   u32 swq_pos;
 160   u32 flush_count;
 161 } dpdk_device_hqos_per_hqos_thread_t;
 162
 163 typedef struct
 164 {
 165   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 166   volatile u32 **lockp;
 167
 168   /* Instance ID */
 169   u32 device_index;
 170
 171   u32 hw_if_index;
 172   u32 vlib_sw_if_index;
 173
 174   /* next node index if we decide to steal the rx graph arc */
 175   u32 per_interface_next_index;
 176
 177   /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
 178   struct rte_mbuf ***tx_vectors;        /* one per worker thread */
 179   struct rte_mbuf ***rx_vectors;
 180
 181   /* vector of traced contexts, per device */
 182   u32 **d_trace_buffers;
 183
 184   dpdk_pmd_t pmd:8;
 185   i8 cpu_socket;
 186
 187   u16 flags;
 188 #define DPDK_DEVICE_FLAG_ADMIN_UP           (1 << 0)
 189 #define DPDK_DEVICE_FLAG_PROMISC            (1 << 1)
 190 #define DPDK_DEVICE_FLAG_PMD                (1 << 2)
 191
 192 #define DPDK_DEVICE_FLAG_MAYBE_MULTISEG     (1 << 4)
 193 #define DPDK_DEVICE_FLAG_HAVE_SUBIF         (1 << 5)
 194 #define DPDK_DEVICE_FLAG_HQOS               (1 << 6)
 195
 196   u16 nb_tx_desc;
 197     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 198
 199   u8 *interface_name_suffix;
 200
 201   /* number of sub-interfaces */
 202   u16 num_subifs;
 203
 204   /* PMD related */
 205   u16 tx_q_used;
 206   u16 rx_q_used;
 207   u16 nb_rx_desc;
 208   u16 *cpu_socket_id_by_queue;
 209   struct rte_eth_conf port_conf;
 210   struct rte_eth_txconf tx_conf;
 211
 212   /* HQoS related */
 213   dpdk_device_hqos_per_worker_thread_t *hqos_wt;
 214   dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
 215
 216   /* af_packet or BondEthernet instance number */
 217   u8 port_id;
 218
 219   struct rte_eth_link link;
 220   f64 time_last_link_update;
 221
 222   struct rte_eth_stats stats;
 223   struct rte_eth_stats last_stats;
 224   struct rte_eth_stats last_cleared_stats;
 225   struct rte_eth_xstat *xstats;
 226   struct rte_eth_xstat *last_cleared_xstats;
 227   f64 time_last_stats_update;
 228   dpdk_port_type_t port_type;
 229
 230   /* mac address */
 231   u8 *default_mac_address;
 232 } dpdk_device_t;
 233
 234 #define DPDK_STATS_POLL_INTERVAL      (10.0)
 235 #define DPDK_MIN_STATS_POLL_INTERVAL  (0.001)   /* 1msec */
 236
 237 #define DPDK_LINK_POLL_INTERVAL       (3.0)
 238 #define DPDK_MIN_LINK_POLL_INTERVAL   (0.001)   /* 1msec */
 239
 240 typedef struct
 241 {
 242   u32 device;
 243   u16 queue_id;
 244 } dpdk_device_and_queue_t;
 245
 246 #ifndef DPDK_HQOS_DBG_BYPASS
 247 #define DPDK_HQOS_DBG_BYPASS 0
 248 #endif
 249
 250 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
 251 #define HQOS_FLUSH_COUNT_THRESHOLD              100000
 252 #endif
 253
 254 typedef struct dpdk_device_config_hqos_t
 255 {
 256   u32 hqos_thread;
 257   u32 hqos_thread_valid;
 258
 259   u32 swq_size;
 260   u32 burst_enq;
 261   u32 burst_deq;
 262
 263   u32 pktfield0_slabpos;
 264   u32 pktfield1_slabpos;
 265   u32 pktfield2_slabpos;
 266   u64 pktfield0_slabmask;
 267   u64 pktfield1_slabmask;
 268   u64 pktfield2_slabmask;
 269   u32 tc_table[64];
 270
 271   struct rte_sched_port_params port;
 272   struct rte_sched_subport_params *subport;
 273   struct rte_sched_pipe_params *pipe;
 274   uint32_t *pipe_map;
 275 } dpdk_device_config_hqos_t;
 276
 277 int dpdk_hqos_validate_mask (u64 mask, u32 n);
 278 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
 279                                                    hqos, u32 pipe_profile_id);
 280 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
 281 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
 282                                     dpdk_device_config_hqos_t * hqos);
 283 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
 284                              struct rte_mbuf **pkts, u32 n_pkts);
 285
 286 #define foreach_dpdk_device_config_item \
 287   _ (num_rx_queues) \
 288   _ (num_tx_queues) \
 289   _ (num_rx_desc) \
 290   _ (num_tx_desc) \
 291   _ (rss_fn)
 292
 293 typedef struct
 294 {
 295   vlib_pci_addr_t pci_addr;
 296   u8 is_blacklisted;
 297   u8 vlan_strip_offload;
 298 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
 299 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
 300 #define DPDK_DEVICE_VLAN_STRIP_ON  2
 301
 302 #define _(x) uword x;
 303     foreach_dpdk_device_config_item
 304 #undef _
 305     clib_bitmap_t * workers;
 306   u32 hqos_enabled;
 307   dpdk_device_config_hqos_t hqos;
 308 } dpdk_device_config_t;
 309
 310 typedef struct
 311 {
 312
 313   /* Config stuff */
 314   u8 **eal_init_args;
 315   u8 *eal_init_args_str;
 316   u8 *uio_driver_name;
 317   u8 no_multi_seg;
 318   u8 enable_tcp_udp_checksum;
 319
 320   /* Required config parameters */
 321   u8 coremask_set_manually;
 322   u8 nchannels_set_manually;
 323   u32 coremask;
 324   u32 nchannels;
 325   u32 num_mbufs;
 326
 327   /*
 328    * format interface names ala xxxEthernet%d/%d/%d instead of
 329    * xxxEthernet%x/%x/%x.
 330    */
 331   u8 interface_name_format_decimal;
 332
 333   /* per-device config */
 334   dpdk_device_config_t default_devconf;
 335   dpdk_device_config_t *dev_confs;
 336   uword *device_config_index_by_pci_addr;
 337
 338 } dpdk_config_main_t;
 339
 340 dpdk_config_main_t dpdk_config_main;
 341
 342 typedef struct
 343 {
 344
 345   /* Devices */
 346   dpdk_device_t *devices;
 347   dpdk_device_and_queue_t **devices_by_hqos_cpu;
 348
 349   /* per-thread recycle lists */
 350   u32 **recycle;
 351
 352   /* per-thread buffer templates */
 353   vlib_buffer_t *buffer_templates;
 354
 355   /* buffer flags template, configurable to enable/disable tcp / udp cksum */
 356   u32 buffer_flags_template;
 357
 358   /* vlib buffer free list, must be same size as an rte_mbuf */
 359   u32 vlib_buffer_free_list_index;
 360
 361   /* Ethernet input node index */
 362   u32 ethernet_input_node_index;
 363
 364   /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
 365   int tx_pcap_enable;
 366   pcap_main_t pcap_main;
 367   u8 *pcap_filename;
 368   u32 pcap_sw_if_index;
 369   u32 pcap_pkts_to_capture;
 370
 371   /*
 372    * flag indicating that a posted admin up/down
 373    * (via post_sw_interface_set_flags) is in progress
 374    */
 375   u8 admin_up_down_in_progress;
 376
 377   u8 use_rss;
 378
 379   /* which cpus are running I/O TX */
 380   int hqos_cpu_first_index;
 381   int hqos_cpu_count;
 382
 383   /* control interval of dpdk link state and stat polling */
 384   f64 link_state_poll_interval;
 385   f64 stat_poll_interval;
 386
 387   /* Sleep for this many usec after each device poll */
 388   u32 poll_sleep_usec;
 389
 390   /* convenience */
 391   vlib_main_t *vlib_main;
 392   vnet_main_t *vnet_main;
 393   dpdk_config_main_t *conf;
 394
 395   /* mempool */
 396   struct rte_mempool **pktmbuf_pools;
 397
 398   /* API message ID base */
 399   u16 msg_id_base;
 400 } dpdk_main_t;
 401
 402 extern dpdk_main_t dpdk_main;
 403
 404 typedef struct
 405 {
 406   u32 buffer_index;
 407   u16 device_index;
 408   u8 queue_index;
 409   struct rte_mbuf mb;
 410   /* Copy of VLIB buffer; packet data stored in pre_data. */
 411   vlib_buffer_t buffer;
 412 } dpdk_tx_dma_trace_t;
 413
 414 typedef struct
 415 {
 416   u32 buffer_index;
 417   u16 device_index;
 418   u16 queue_index;
 419   struct rte_mbuf mb;
 420   vlib_buffer_t buffer;         /* Copy of VLIB buffer; pkt data stored in pre_data. */
 421   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 422 } dpdk_rx_dma_trace_t;
 423
 424 clib_error_t *dpdk_device_setup (dpdk_device_t * xd);
 425 clib_error_t *dpdk_device_start (dpdk_device_t * xd);
 426 clib_error_t *dpdk_device_stop (dpdk_device_t * xd);
 427
 428 #define foreach_dpdk_error                                              \
 429   _(NONE, "no error")                                                   \
 430   _(RX_PACKET_ERROR, "Rx packet errors")                                \
 431   _(RX_BAD_FCS, "Rx bad fcs")                                           \
 432   _(IP_CHECKSUM_ERROR, "Rx ip checksum errors")                         \
 433   _(RX_ALLOC_FAIL, "rx buf alloc from free list failed")                \
 434   _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem")              \
 435   _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
 436
 437 typedef enum
 438 {
 439 #define _(f,s) DPDK_ERROR_##f,
 440   foreach_dpdk_error
 441 #undef _
 442     DPDK_N_ERROR,
 443 } dpdk_error_t;
 444
 445 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
 446
 447 format_function_t format_dpdk_device_name;
 448 format_function_t format_dpdk_device;
 449 format_function_t format_dpdk_tx_dma_trace;
 450 format_function_t format_dpdk_rx_dma_trace;
 451 format_function_t format_dpdk_rte_mbuf;
 452 format_function_t format_dpdk_rx_rte_mbuf;
 453 unformat_function_t unformat_socket_mem;
 454 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
 455 clib_error_t *unformat_hqos (unformat_input_t * input,
 456                              dpdk_device_config_hqos_t * hqos);
 457
 458 uword
 459 admin_up_down_process (vlib_main_t * vm,
 460                        vlib_node_runtime_t * rt, vlib_frame_t * f);
 461
 462 #endif /* __included_dpdk_h__ */
 463
 464 /*
 465  * fd.io coding-style-patch-verification: ON
 466  *
 467  * Local Variables:
 468  * eval: (c-set-style "gnu")
 469  * End:
 470  */