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