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