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