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