src/vnet/devices/dpdk/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(16, 11, 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   _ ("rte_bond_pmd", 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   _ ("rte_nicvf_pmd", THUNDERX)   \
  91   _ ("rte_em_pmd", E1000EM)       \
  92   _ ("rte_igb_pmd", IGB)          \
  93   _ ("rte_igbvf_pmd", IGBVF)      \
  94   _ ("rte_ixgbe_pmd", IXGBE)      \
  95   _ ("rte_ixgbevf_pmd", IXGBEVF)  \
  96   _ ("rte_i40e_pmd", I40E)        \
  97   _ ("rte_i40evf_pmd", I40EVF)    \
  98   _ ("rte_virtio_pmd", VIRTIO)    \
  99   _ ("rte_enic_pmd", ENIC)        \
 100   _ ("rte_vmxnet3_pmd", VMXNET3)  \
 101   _ ("AF_PACKET PMD", AF_PACKET)  \
 102   _ ("rte_bond_pmd", BOND)        \
 103   _ ("rte_pmd_fm10k", FM10K)      \
 104   _ ("rte_cxgbe_pmd", CXGBE)      \
 105   _ ("rte_dpaa2_dpni", DPAA2)
 106 #endif
 107
 108 typedef enum
 109 {
 110   VNET_DPDK_PMD_NONE,
 111 #define _(s,f) VNET_DPDK_PMD_##f,
 112   foreach_dpdk_pmd
 113 #undef _
 114     VNET_DPDK_PMD_UNKNOWN,      /* must be last */
 115 } dpdk_pmd_t;
 116
 117 typedef enum
 118 {
 119   VNET_DPDK_PORT_TYPE_ETH_1G,
 120   VNET_DPDK_PORT_TYPE_ETH_10G,
 121   VNET_DPDK_PORT_TYPE_ETH_40G,
 122   VNET_DPDK_PORT_TYPE_ETH_100G,
 123   VNET_DPDK_PORT_TYPE_ETH_BOND,
 124   VNET_DPDK_PORT_TYPE_ETH_SWITCH,
 125   VNET_DPDK_PORT_TYPE_AF_PACKET,
 126   VNET_DPDK_PORT_TYPE_UNKNOWN,
 127 } dpdk_port_type_t;
 128
 129 /*
 130  * The header for the tx_vector in dpdk_device_t.
 131  * Head and tail are indexes into the tx_vector and are of type
 132  * u64 so they never overflow.
 133  */
 134 typedef struct
 135 {
 136   u64 tx_head;
 137   u64 tx_tail;
 138 } tx_ring_hdr_t;
 139
 140 typedef struct
 141 {
 142   struct rte_ring *swq;
 143
 144   u64 hqos_field0_slabmask;
 145   u32 hqos_field0_slabpos;
 146   u32 hqos_field0_slabshr;
 147   u64 hqos_field1_slabmask;
 148   u32 hqos_field1_slabpos;
 149   u32 hqos_field1_slabshr;
 150   u64 hqos_field2_slabmask;
 151   u32 hqos_field2_slabpos;
 152   u32 hqos_field2_slabshr;
 153   u32 hqos_tc_table[64];
 154 } dpdk_device_hqos_per_worker_thread_t;
 155
 156 typedef struct
 157 {
 158   struct rte_ring **swq;
 159   struct rte_mbuf **pkts_enq;
 160   struct rte_mbuf **pkts_deq;
 161   struct rte_sched_port *hqos;
 162   u32 hqos_burst_enq;
 163   u32 hqos_burst_deq;
 164   u32 pkts_enq_len;
 165   u32 swq_pos;
 166   u32 flush_count;
 167 } dpdk_device_hqos_per_hqos_thread_t;
 168
 169 typedef struct
 170 {
 171   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 172   volatile u32 **lockp;
 173
 174   /* Instance ID */
 175   u32 device_index;
 176
 177   u32 vlib_hw_if_index;
 178   u32 vlib_sw_if_index;
 179
 180   /* next node index if we decide to steal the rx graph arc */
 181   u32 per_interface_next_index;
 182
 183   /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
 184   struct rte_mbuf ***tx_vectors;        /* one per worker thread */
 185   struct rte_mbuf ***rx_vectors;
 186
 187   /* vector of traced contexts, per device */
 188   u32 **d_trace_buffers;
 189
 190   dpdk_pmd_t pmd:8;
 191   i8 cpu_socket;
 192
 193   u16 flags;
 194 #define DPDK_DEVICE_FLAG_ADMIN_UP           (1 << 0)
 195 #define DPDK_DEVICE_FLAG_PROMISC            (1 << 1)
 196 #define DPDK_DEVICE_FLAG_PMD                (1 << 2)
 197 #define DPDK_DEVICE_FLAG_PMD_SUPPORTS_PTYPE (1 << 3)
 198 #define DPDK_DEVICE_FLAG_MAYBE_MULTISEG     (1 << 4)
 199 #define DPDK_DEVICE_FLAG_HAVE_SUBIF         (1 << 5)
 200 #define DPDK_DEVICE_FLAG_HQOS               (1 << 6)
 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   struct rte_eth_conf port_conf;
 216   struct rte_eth_txconf tx_conf;
 217
 218   /* HQoS related */
 219   dpdk_device_hqos_per_worker_thread_t *hqos_wt;
 220   dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
 221
 222   /* af_packet */
 223   u8 af_packet_port_id;
 224
 225   struct rte_eth_link link;
 226   f64 time_last_link_update;
 227
 228   struct rte_eth_stats stats;
 229   struct rte_eth_stats last_stats;
 230   struct rte_eth_stats last_cleared_stats;
 231   struct rte_eth_xstat *xstats;
 232   struct rte_eth_xstat *last_cleared_xstats;
 233   f64 time_last_stats_update;
 234   dpdk_port_type_t port_type;
 235
 236   /* mac address */
 237   u8 *default_mac_address;
 238 } dpdk_device_t;
 239
 240 #define DPDK_STATS_POLL_INTERVAL      (10.0)
 241 #define DPDK_MIN_STATS_POLL_INTERVAL  (0.001)   /* 1msec */
 242
 243 #define DPDK_LINK_POLL_INTERVAL       (3.0)
 244 #define DPDK_MIN_LINK_POLL_INTERVAL   (0.001)   /* 1msec */
 245
 246 typedef struct
 247 {
 248   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 249
 250   /* total input packet counter */
 251   u64 aggregate_rx_packets;
 252 } dpdk_worker_t;
 253
 254 typedef struct
 255 {
 256   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 257
 258   /* total input packet counter */
 259   u64 aggregate_rx_packets;
 260 } dpdk_hqos_thread_t;
 261
 262 typedef struct
 263 {
 264   u32 device;
 265   u16 queue_id;
 266 } dpdk_device_and_queue_t;
 267
 268 #ifndef DPDK_HQOS_DBG_BYPASS
 269 #define DPDK_HQOS_DBG_BYPASS 0
 270 #endif
 271
 272 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
 273 #define HQOS_FLUSH_COUNT_THRESHOLD              100000
 274 #endif
 275
 276 typedef struct dpdk_device_config_hqos_t
 277 {
 278   u32 hqos_thread;
 279   u32 hqos_thread_valid;
 280
 281   u32 swq_size;
 282   u32 burst_enq;
 283   u32 burst_deq;
 284
 285   u32 pktfield0_slabpos;
 286   u32 pktfield1_slabpos;
 287   u32 pktfield2_slabpos;
 288   u64 pktfield0_slabmask;
 289   u64 pktfield1_slabmask;
 290   u64 pktfield2_slabmask;
 291   u32 tc_table[64];
 292
 293   struct rte_sched_port_params port;
 294   struct rte_sched_subport_params *subport;
 295   struct rte_sched_pipe_params *pipe;
 296   uint32_t *pipe_map;
 297 } dpdk_device_config_hqos_t;
 298
 299 int dpdk_hqos_validate_mask (u64 mask, u32 n);
 300 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
 301                                                    hqos, u32 pipe_profile_id);
 302 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
 303 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
 304                                     dpdk_device_config_hqos_t * hqos);
 305 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
 306                              struct rte_mbuf **pkts, u32 n_pkts);
 307
 308 #define foreach_dpdk_device_config_item \
 309   _ (num_rx_queues) \
 310   _ (num_tx_queues) \
 311   _ (num_rx_desc) \
 312   _ (num_tx_desc) \
 313   _ (rss_fn)
 314
 315 typedef struct
 316 {
 317   vlib_pci_addr_t pci_addr;
 318   u8 is_blacklisted;
 319   u8 vlan_strip_offload;
 320 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
 321 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
 322 #define DPDK_DEVICE_VLAN_STRIP_ON  2
 323
 324 #define _(x) uword x;
 325     foreach_dpdk_device_config_item
 326 #undef _
 327     clib_bitmap_t * workers;
 328   u32 hqos_enabled;
 329   dpdk_device_config_hqos_t hqos;
 330 } dpdk_device_config_t;
 331
 332 typedef struct
 333 {
 334
 335   /* Config stuff */
 336   u8 **eal_init_args;
 337   u8 *eal_init_args_str;
 338   u8 *uio_driver_name;
 339   u8 no_multi_seg;
 340   u8 enable_tcp_udp_checksum;
 341
 342   /* Required config parameters */
 343   u8 coremask_set_manually;
 344   u8 nchannels_set_manually;
 345   u32 coremask;
 346   u32 nchannels;
 347   u32 num_mbufs;
 348   u8 num_kni;                   /* while kni_init allows u32, port_id in callback fn is only u8 */
 349
 350   /*
 351    * format interface names ala xxxEthernet%d/%d/%d instead of
 352    * xxxEthernet%x/%x/%x.
 353    */
 354   u8 interface_name_format_decimal;
 355
 356   /* per-device config */
 357   dpdk_device_config_t default_devconf;
 358   dpdk_device_config_t *dev_confs;
 359   uword *device_config_index_by_pci_addr;
 360
 361 } dpdk_config_main_t;
 362
 363 dpdk_config_main_t dpdk_config_main;
 364
 365 typedef struct
 366 {
 367
 368   /* Devices */
 369   dpdk_device_t *devices;
 370   dpdk_device_and_queue_t **devices_by_cpu;
 371   dpdk_device_and_queue_t **devices_by_hqos_cpu;
 372
 373   /* per-thread recycle lists */
 374   u32 **recycle;
 375
 376   /* buffer flags template, configurable to enable/disable tcp / udp cksum */
 377   u32 buffer_flags_template;
 378
 379   /* vlib buffer free list, must be same size as an rte_mbuf */
 380   u32 vlib_buffer_free_list_index;
 381
 382   /* dpdk worker "threads" */
 383   dpdk_worker_t *workers;
 384
 385   /* dpdk HQoS "threads" */
 386   dpdk_hqos_thread_t *hqos_threads;
 387
 388   /* Ethernet input node index */
 389   u32 ethernet_input_node_index;
 390
 391   /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
 392   int tx_pcap_enable;
 393   pcap_main_t pcap_main;
 394   u8 *pcap_filename;
 395   u32 pcap_sw_if_index;
 396   u32 pcap_pkts_to_capture;
 397
 398   /* hashes */
 399   uword *dpdk_device_by_kni_port_id;
 400   uword *vu_sw_if_index_by_listener_fd;
 401   uword *vu_sw_if_index_by_sock_fd;
 402   u32 *vu_inactive_interfaces_device_index;
 403
 404   /*
 405    * flag indicating that a posted admin up/down
 406    * (via post_sw_interface_set_flags) is in progress
 407    */
 408   u8 admin_up_down_in_progress;
 409
 410   u8 use_rss;
 411
 412   /* which cpus are running dpdk-input */
 413   int input_cpu_first_index;
 414   int input_cpu_count;
 415
 416   /* which cpus are running I/O TX */
 417   int hqos_cpu_first_index;
 418   int hqos_cpu_count;
 419
 420   /* control interval of dpdk link state and stat polling */
 421   f64 link_state_poll_interval;
 422   f64 stat_poll_interval;
 423
 424   /* Sleep for this many MS after each device poll */
 425   u32 poll_sleep;
 426
 427   /* convenience */
 428   vlib_main_t *vlib_main;
 429   vnet_main_t *vnet_main;
 430   dpdk_config_main_t *conf;
 431
 432   /* mempool */
 433   struct rte_mempool **pktmbuf_pools;
 434 } dpdk_main_t;
 435
 436 dpdk_main_t dpdk_main;
 437
 438 typedef struct
 439 {
 440   u32 buffer_index;
 441   u16 device_index;
 442   u8 queue_index;
 443   struct rte_mbuf mb;
 444   /* Copy of VLIB buffer; packet data stored in pre_data. */
 445   vlib_buffer_t buffer;
 446 } dpdk_tx_dma_trace_t;
 447
 448 typedef struct
 449 {
 450   u32 buffer_index;
 451   u16 device_index;
 452   u16 queue_index;
 453   struct rte_mbuf mb;
 454   vlib_buffer_t buffer;         /* Copy of VLIB buffer; pkt data stored in pre_data. */
 455   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 456 } dpdk_rx_dma_trace_t;
 457
 458 void vnet_buffer_needs_dpdk_mb (vlib_buffer_t * b);
 459
 460 clib_error_t *dpdk_set_mac_address (vnet_hw_interface_t * hi, char *address);
 461
 462 clib_error_t *dpdk_set_mc_filter (vnet_hw_interface_t * hi,
 463                                   struct ether_addr mc_addr_vec[], int naddr);
 464
 465 void dpdk_thread_input (dpdk_main_t * dm, dpdk_device_t * xd);
 466
 467 clib_error_t *dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
 468
 469 u32 dpdk_interface_tx_vector (vlib_main_t * vm, u32 dev_instance);
 470
 471 struct rte_mbuf *dpdk_replicate_packet_mb (vlib_buffer_t * b);
 472 struct rte_mbuf *dpdk_zerocopy_replicate_packet_mb (vlib_buffer_t * b);
 473
 474 #define foreach_dpdk_error                                              \
 475   _(NONE, "no error")                                                   \
 476   _(RX_PACKET_ERROR, "Rx packet errors")                                \
 477   _(RX_BAD_FCS, "Rx bad fcs")                                           \
 478   _(IP_CHECKSUM_ERROR, "Rx ip checksum errors")                         \
 479   _(RX_ALLOC_FAIL, "rx buf alloc from free list failed")                \
 480   _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem")              \
 481   _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
 482
 483 typedef enum
 484 {
 485 #define _(f,s) DPDK_ERROR_##f,
 486   foreach_dpdk_error
 487 #undef _
 488     DPDK_N_ERROR,
 489 } dpdk_error_t;
 490
 491 int dpdk_set_stat_poll_interval (f64 interval);
 492 int dpdk_set_link_state_poll_interval (f64 interval);
 493 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
 494 void dpdk_device_lock_init (dpdk_device_t * xd);
 495 void dpdk_device_lock_free (dpdk_device_t * xd);
 496
 497 static inline u64
 498 vnet_get_aggregate_rx_packets (void)
 499 {
 500   dpdk_main_t *dm = &dpdk_main;
 501   u64 sum = 0;
 502   dpdk_worker_t *dw;
 503
 504   vec_foreach (dw, dm->workers) sum += dw->aggregate_rx_packets;
 505
 506   return sum;
 507 }
 508
 509 void dpdk_rx_trace (dpdk_main_t * dm,
 510                     vlib_node_runtime_t * node,
 511                     dpdk_device_t * xd,
 512                     u16 queue_id, u32 * buffers, uword n_buffers);
 513
 514 #define EFD_OPERATION_LESS_THAN          0
 515 #define EFD_OPERATION_GREATER_OR_EQUAL   1
 516
 517 format_function_t format_dpdk_device_name;
 518 format_function_t format_dpdk_device;
 519 format_function_t format_dpdk_tx_dma_trace;
 520 format_function_t format_dpdk_rx_dma_trace;
 521 format_function_t format_dpdk_rte_mbuf;
 522 format_function_t format_dpdk_rx_rte_mbuf;
 523 unformat_function_t unformat_socket_mem;
 524 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
 525 clib_error_t *unformat_hqos (unformat_input_t * input,
 526                              dpdk_device_config_hqos_t * hqos);
 527
 528 uword
 529 admin_up_down_process (vlib_main_t * vm,
 530                        vlib_node_runtime_t * rt, vlib_frame_t * f);
 531
 532 #endif /* __included_dpdk_h__ */
 533
 534 /*
 535  * fd.io coding-style-patch-verification: ON
 536  *
 537  * Local Variables:
 538  * eval: (c-set-style "gnu")
 539  * End:
 540  */