vnet/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_memcpy.h>
  28 #include <rte_memzone.h>
  29 #include <rte_tailq.h>
  30 #include <rte_eal.h>
  31 #include <rte_per_lcore.h>
  32 #include <rte_launch.h>
  33 #include <rte_atomic.h>
  34 #include <rte_cycles.h>
  35 #include <rte_prefetch.h>
  36 #include <rte_lcore.h>
  37 #include <rte_per_lcore.h>
  38 #include <rte_branch_prediction.h>
  39 #include <rte_interrupts.h>
  40 #include <rte_pci.h>
  41 #include <rte_random.h>
  42 #include <rte_debug.h>
  43 #include <rte_ether.h>
  44 #include <rte_ethdev.h>
  45 #include <rte_ring.h>
  46 #include <rte_mempool.h>
  47 #include <rte_mbuf.h>
  48 #include <rte_kni.h>
  49 #include <rte_virtio_net.h>
  50 #include <rte_pci_dev_ids.h>
  51 #include <rte_version.h>
  52
  53 #include <vnet/unix/pcap.h>
  54 #include <vnet/devices/virtio/vhost-user.h>
  55
  56 #if CLIB_DEBUG > 0
  57 #define always_inline static inline
  58 #else
  59 #define always_inline static inline __attribute__ ((__always_inline__))
  60 #endif
  61
  62 #define MBUF_SIZE (2048 + sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
  63 #define NB_MBUF   (32<<10)
  64
  65 vnet_device_class_t dpdk_device_class;
  66 vlib_node_registration_t dpdk_input_node;
  67 vlib_node_registration_t dpdk_io_input_node;
  68 vlib_node_registration_t handoff_dispatch_node;
  69
  70 typedef enum {
  71   VNET_DPDK_DEV_ETH = 1,      /* Standard DPDK PMD driver */
  72   VNET_DPDK_DEV_KNI,          /* Kernel NIC Interface */
  73   VNET_DPDK_DEV_VHOST_USER,
  74   VNET_DPDK_DEV_UNKNOWN,      /* must be last */
  75 } dpdk_device_type_t;
  76
  77 #define foreach_dpdk_pmd          \
  78   _ ("rte_nicvf_pmd", THUNDERX)   \
  79   _ ("rte_em_pmd", E1000EM)       \
  80   _ ("rte_igb_pmd", IGB)          \
  81   _ ("rte_igbvf_pmd", IGBVF)      \
  82   _ ("rte_ixgbe_pmd", IXGBE)      \
  83   _ ("rte_ixgbevf_pmd", IXGBEVF)  \
  84   _ ("rte_i40e_pmd", I40E)        \
  85   _ ("rte_i40evf_pmd", I40EVF)    \
  86   _ ("rte_virtio_pmd", VIRTIO)    \
  87   _ ("rte_vice_pmd", VICE)        \
  88   _ ("rte_enic_pmd", ENIC)        \
  89   _ ("rte_vmxnet3_pmd", VMXNET3)  \
  90   _ ("AF_PACKET PMD", AF_PACKET)  \
  91   _ ("rte_pmd_fm10k", FM10K)
  92
  93 typedef enum {
  94   VNET_DPDK_PMD_NONE,
  95 #define _(s,f) VNET_DPDK_PMD_##f,
  96   foreach_dpdk_pmd
  97 #undef _
  98 #ifdef NETMAP
  99   VNET_DPDK_PMD_NETMAP,
 100 #endif
 101   VNET_DPDK_PMD_UNKNOWN, /* must be last */
 102 } dpdk_pmd_t;
 103
 104 typedef enum {
 105   VNET_DPDK_PORT_TYPE_ETH_1G,
 106   VNET_DPDK_PORT_TYPE_ETH_10G,
 107   VNET_DPDK_PORT_TYPE_ETH_40G,
 108   VNET_DPDK_PORT_TYPE_ETH_SWITCH,
 109 #ifdef NETMAP
 110   VNET_DPDK_PORT_TYPE_NETMAP,
 111 #endif
 112   VNET_DPDK_PORT_TYPE_AF_PACKET,
 113   VNET_DPDK_PORT_TYPE_UNKNOWN,
 114 } dpdk_port_type_t;
 115
 116 typedef struct {
 117   f64 deadline;
 118   vlib_frame_t * frame;
 119 } dpdk_frame_t;
 120
 121 #define DPDK_EFD_MAX_DISCARD_RATE 10
 122
 123 typedef struct {
 124   u16 last_burst_sz;
 125   u16 max_burst_sz;
 126   u32 full_frames_cnt;
 127   u32 consec_full_frames_cnt;
 128   u32 congestion_cnt;
 129   u64 last_poll_time;
 130   u64 max_poll_delay;
 131   u32 discard_cnt;
 132   u32 total_packet_cnt;
 133 } dpdk_efd_agent_t;
 134
 135 typedef struct {
 136   int callfd;
 137   int kickfd;
 138   int errfd;
 139   u32 callfd_idx;
 140   u32 n_since_last_int;
 141   f64 int_deadline;
 142 } dpdk_vu_vring;
 143
 144 typedef struct {
 145   u32 is_up;
 146   u32 unix_fd;
 147   u32 unix_file_index;
 148   u32 client_fd;
 149   char sock_filename[256];
 150   int sock_errno;
 151   u8 sock_is_server;
 152   u8 active;
 153
 154   u64 feature_mask;
 155   u32 num_vrings;
 156   dpdk_vu_vring vrings[2];
 157   u64 region_addr[VHOST_MEMORY_MAX_NREGIONS];
 158   u32 region_fd[VHOST_MEMORY_MAX_NREGIONS];
 159 } dpdk_vu_intf_t;
 160
 161 typedef void (*dpdk_flowcontrol_callback_t) (vlib_main_t *vm,
 162                                              u32 hw_if_index,
 163                                              u32 n_packets);
 164
 165 /*
 166  * The header for the tx_vector in dpdk_device_t.
 167  * Head and tail are indexes into the tx_vector and are of type
 168  * u64 so they never overflow.
 169  */
 170 typedef struct {
 171   u64 tx_head;
 172   u64 tx_tail;
 173 } tx_ring_hdr_t;
 174
 175 typedef struct {
 176   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
 177   volatile u32 *lockp;
 178
 179   /* Instance ID */
 180   u32 device_index;
 181
 182   u32 vlib_hw_if_index;
 183   u32 vlib_sw_if_index;
 184
 185   /* next node index if we decide to steal the rx graph arc */
 186   u32 per_interface_next_index;
 187
 188   /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
 189   struct rte_mbuf *** tx_vectors; /* one per worker thread */
 190   struct rte_mbuf *** rx_vectors;
 191
 192   /* vector of traced contexts, per device */
 193   u32 * d_trace_buffers;
 194
 195   /* per-worker destination frame queue */
 196   dpdk_frame_t * frames;
 197
 198   dpdk_device_type_t dev_type:8;
 199   dpdk_pmd_t pmd:8;
 200   i8 cpu_socket;
 201
 202   u8 admin_up;
 203   u8 promisc;
 204
 205   CLIB_CACHE_LINE_ALIGN_MARK(cacheline1);
 206
 207   /* PMD related */
 208   u16 tx_q_used;
 209   u16 rx_q_used;
 210   u16 nb_rx_desc;
 211   u16 nb_tx_desc;
 212   u16 * cpu_socket_id_by_queue;
 213   struct rte_eth_conf port_conf;
 214   struct rte_eth_txconf tx_conf;
 215
 216   /* KNI related */
 217   struct rte_kni *kni;
 218   u8 kni_port_id;
 219
 220   /* vhost-user related */
 221   u32 vu_if_id;
 222   struct virtio_net  vu_vhost_dev;
 223   u32 vu_is_running;
 224   dpdk_vu_intf_t *vu_intf;
 225
 226   /* af_packet */
 227   u8 af_packet_port_id;
 228
 229   struct rte_eth_link link;
 230   f64 time_last_link_update;
 231
 232   struct rte_eth_stats stats;
 233   struct rte_eth_stats last_stats;
 234   struct rte_eth_xstats * xstats;
 235   f64 time_last_stats_update;
 236   dpdk_port_type_t port_type;
 237
 238   dpdk_efd_agent_t efd_agent;
 239 } dpdk_device_t;
 240
 241 #define MAX_NELTS 32
 242 typedef struct {
 243   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
 244   u64 head;
 245   u64 head_hint;
 246   u64 tail;
 247   u32 n_in_use;
 248   u32 nelts;
 249   u32 written;
 250   u32 threshold;
 251   i32 n_vectors[MAX_NELTS];
 252 } frame_queue_trace_t;
 253
 254 #define DPDK_TX_RING_SIZE (4 * 1024)
 255
 256 #define DPDK_STATS_POLL_INTERVAL  10.0
 257 #define DPDK_LINK_POLL_INTERVAL   3.0
 258
 259 typedef struct {
 260   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
 261
 262   /* total input packet counter */
 263   u64 aggregate_rx_packets;
 264 } dpdk_worker_t;
 265
 266 typedef struct {
 267   u32 device;
 268   u16 queue_id;
 269 } dpdk_device_and_queue_t;
 270
 271 /* Early-Fast-Discard (EFD) */
 272 #define DPDK_EFD_DISABLED                       0
 273 #define DPDK_EFD_DISCARD_ENABLED                (1 << 0)
 274 #define DPDK_EFD_MONITOR_ENABLED                (1 << 1)
 275 #define DPDK_EFD_DROPALL_ENABLED                (1 << 2)
 276
 277 #define DPDK_EFD_DEFAULT_DEVICE_QUEUE_HI_THRESH_PCT    90
 278 #define DPDK_EFD_DEFAULT_CONSEC_FULL_FRAMES_HI_THRESH  6
 279
 280 typedef struct dpdk_efd_t {
 281   u16 enabled;
 282   u16 queue_hi_thresh;
 283   u16 consec_full_frames_hi_thresh;
 284   u16 pad;
 285 } dpdk_efd_t;
 286
 287 typedef struct {
 288
 289   /* Devices */
 290   dpdk_device_t * devices;
 291   dpdk_device_and_queue_t ** devices_by_cpu;
 292
 293   /* per-thread recycle lists */
 294   u32 ** recycle;
 295
 296   /* flow control callback. If 0 then flow control is disabled */
 297   dpdk_flowcontrol_callback_t flowcontrol_callback;
 298
 299   /* vlib buffer free list, must be same size as an rte_mbuf */
 300   u32 vlib_buffer_free_list_index;
 301
 302   /*
 303    * format interface names ala xxxEthernet%d/%d/%d instead of
 304    * xxxEthernet%x/%x/%x. For VIRL.
 305    */
 306   u8 interface_name_format_decimal;
 307
 308
 309   /* dpdk worker "threads" */
 310   dpdk_worker_t * workers;
 311
 312   /* Config stuff */
 313   u8 ** eal_init_args;
 314   u8 * eth_if_blacklist;
 315   u8 * eth_if_whitelist;
 316   u8 * uio_driver_name;
 317   u8 no_multi_seg;
 318
 319   /* Required config parameters */
 320   u8 coremask_set_manually;
 321   u8 nchannels_set_manually;
 322   u32 coremask;
 323   u32 nchannels;
 324   u32 num_mbufs;
 325   u32 use_rss;
 326   u8 num_kni; /* while kni_init allows u32, port_id in callback fn is only u8 */
 327
 328   /* Ethernet input node index */
 329   u32 ethernet_input_node_index;
 330
 331   /* dpdk i/o thread initialization barrier */
 332   volatile u32 io_thread_release;
 333
 334   /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
 335   int tx_pcap_enable;
 336   pcap_main_t pcap_main;
 337   u8 * pcap_filename;
 338   u32 pcap_sw_if_index;
 339   u32 pcap_pkts_to_capture;
 340
 341   /* virtio vhost-user switch */
 342   u8 use_virtio_vhost;
 343
 344   /* vhost-user coalescence frames config */
 345   u32 vhost_coalesce_frames;
 346   f64 vhost_coalesce_time;
 347
 348   /* hashes */
 349   uword * dpdk_device_by_kni_port_id;
 350   uword * vu_sw_if_index_by_listener_fd;
 351   uword * vu_sw_if_index_by_sock_fd;
 352   u32 * vu_inactive_interfaces_device_index;
 353
 354   u32 next_vu_if_id;
 355
 356   /* efd (early-fast-discard) settings */
 357   dpdk_efd_t efd;
 358
 359   /*
 360    * flag indicating that a posted admin up/down
 361    * (via post_sw_interface_set_flags) is in progress
 362    */
 363   u8 admin_up_down_in_progress;
 364
 365   u8 have_io_threads;
 366
 367   /* which cpus are running dpdk-input */
 368   int input_cpu_first_index;
 369   int input_cpu_count;
 370
 371   /* convenience */
 372   vlib_main_t * vlib_main;
 373   vnet_main_t * vnet_main;
 374 } dpdk_main_t;
 375
 376 dpdk_main_t dpdk_main;
 377
 378 typedef enum {
 379   DPDK_RX_NEXT_IP4_INPUT,
 380   DPDK_RX_NEXT_IP6_INPUT,
 381   DPDK_RX_NEXT_MPLS_INPUT,
 382   DPDK_RX_NEXT_ETHERNET_INPUT,
 383   DPDK_RX_NEXT_DROP,
 384   DPDK_RX_N_NEXT,
 385 } dpdk_rx_next_t;
 386
 387 void vnet_buffer_needs_dpdk_mb (vlib_buffer_t * b);
 388
 389 void dpdk_set_next_node (dpdk_rx_next_t, char *);
 390
 391 typedef void (*dpdk_io_thread_callback_t) (vlib_main_t *vm);
 392
 393 void dpdk_io_thread (vlib_worker_thread_t * w,
 394                      u32 instances,
 395                      u32 instance_id,
 396                      char *worker_name,
 397                      dpdk_io_thread_callback_t callback);
 398 void dpdk_thread_input (dpdk_main_t * dm, dpdk_device_t * xd);
 399
 400 clib_error_t * dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
 401
 402 void dpdk_set_flowcontrol_callback (vlib_main_t *vm,
 403                                     dpdk_flowcontrol_callback_t callback);
 404
 405 u32 dpdk_interface_tx_vector (vlib_main_t * vm, u32 dev_instance);
 406
 407 vlib_frame_queue_elt_t * vlib_get_handoff_queue_elt (u32 vlib_worker_index);
 408
 409 u32 dpdk_get_handoff_node_index (void);
 410
 411 void set_efd_bitmap (u8 *bitmap, u32 value, u32 op);
 412
 413 #define foreach_dpdk_error                                              \
 414   _(NONE, "no error")                                                   \
 415   _(RX_PACKET_ERROR, "Rx packet errors")                                \
 416   _(RX_BAD_FCS, "Rx bad fcs")                                           \
 417   _(L4_CHECKSUM_ERROR, "Rx L4 checksum errors")                         \
 418   _(IP_CHECKSUM_ERROR, "Rx ip checksum errors")                         \
 419   _(RX_ALLOC_FAIL, "rx buf alloc from free list failed")                \
 420   _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem")              \
 421   _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")        \
 422   _(IPV4_EFD_DROP_PKTS, "IPV4 Early Fast Discard rx drops")             \
 423   _(IPV6_EFD_DROP_PKTS, "IPV6 Early Fast Discard rx drops")             \
 424   _(MPLS_EFD_DROP_PKTS, "MPLS Early Fast Discard rx drops")             \
 425   _(VLAN_EFD_DROP_PKTS, "VLAN Early Fast Discard rx drops")
 426
 427 typedef enum {
 428 #define _(f,s) DPDK_ERROR_##f,
 429   foreach_dpdk_error
 430 #undef _
 431   DPDK_N_ERROR,
 432 } dpdk_error_t;
 433
 434 /*
 435  * Increment EFD drop counter
 436  */
 437 static_always_inline
 438 void increment_efd_drop_counter (vlib_main_t * vm, u32 counter_index, u32 count)
 439 {
 440    vlib_node_t *my_n;
 441
 442    my_n = vlib_get_node (vm, dpdk_input_node.index);
 443    vm->error_main.counters[my_n->error_heap_index+counter_index] += count;
 444 }
 445
 446 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
 447 void dpdk_efd_update_counters(dpdk_device_t *xd, u32 n_buffers, u16 enabled);
 448 u32 is_efd_discardable(vlib_thread_main_t *tm,
 449                        vlib_buffer_t * b0,
 450                        struct rte_mbuf *mb);
 451
 452 /* dpdk vhost-user interrupt management */
 453 u8 dpdk_vhost_user_want_interrupt (dpdk_device_t *xd, int idx);
 454 void dpdk_vhost_user_send_interrupt (vlib_main_t * vm, dpdk_device_t * xd,
 455                                     int idx);
 456
 457
 458 static inline u64 vnet_get_aggregate_rx_packets (void)
 459 {
 460     dpdk_main_t * dm = &dpdk_main;
 461     u64 sum = 0;
 462     dpdk_worker_t * dw;
 463
 464     vec_foreach(dw, dm->workers)
 465         sum += dw->aggregate_rx_packets;
 466
 467     return sum;
 468 }
 469
 470 void dpdk_rx_trace (dpdk_main_t * dm,
 471                     vlib_node_runtime_t * node,
 472                     dpdk_device_t * xd,
 473                     u16 queue_id,
 474                     u32 * buffers,
 475                     uword n_buffers);
 476
 477 #define EFD_OPERATION_LESS_THAN          0
 478 #define EFD_OPERATION_GREATER_OR_EQUAL   1
 479
 480 void efd_config(u32 enabled,
 481                 u32 ip_prec,  u32 ip_op,
 482                 u32 mpls_exp, u32 mpls_op,
 483                 u32 vlan_cos, u32 vlan_op);
 484
 485 void post_sw_interface_set_flags (vlib_main_t *vm, u32 sw_if_index, u32 flags);
 486
 487 typedef struct vhost_user_memory vhost_user_memory_t;
 488
 489 void dpdk_vhost_user_process_init (void **ctx);
 490 void dpdk_vhost_user_process_cleanup (void *ctx);
 491 uword dpdk_vhost_user_process_if (vlib_main_t *vm, dpdk_device_t *xd, void *ctx);
 492
 493 // vhost-user calls
 494 int dpdk_vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
 495                               const char * sock_filename,
 496                               u8 is_server,
 497                               u32 * sw_if_index,
 498                               u64 feature_mask,
 499                               u8 renumber, u32 custom_dev_instance);
 500 int dpdk_vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
 501                               const char * sock_filename,
 502                               u8 is_server,
 503                               u32 sw_if_index,
 504                               u64 feature_mask,
 505                               u8 renumber, u32 custom_dev_instance);
 506 int dpdk_vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
 507                               u32 sw_if_index);
 508 int dpdk_vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
 509                              vhost_user_intf_details_t **out_vuids);
 510
 511 u32 dpdk_get_admin_up_down_in_progress (void);
 512
 513 uword
 514 dpdk_input_rss (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * f);
 515
 516 #endif /* __included_dpdk_h__ */