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