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