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