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