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