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