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 typedef struct
 156 {
 157   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 158   volatile u32 **lockp;
 159
 160   /* Instance ID */
 161   dpdk_portid_t device_index;
 162
 163   u32 hw_if_index;
 164   u32 vlib_sw_if_index;
 165
 166   /* next node index if we decide to steal the rx graph arc */
 167   u32 per_interface_next_index;
 168
 169   /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
 170   struct rte_mbuf ***tx_vectors;        /* one per worker thread */
 171   struct rte_mbuf ***rx_vectors;
 172
 173   dpdk_pmd_t pmd:8;
 174   i8 cpu_socket;
 175
 176   u16 flags;
 177 #define DPDK_DEVICE_FLAG_ADMIN_UP           (1 << 0)
 178 #define DPDK_DEVICE_FLAG_PROMISC            (1 << 1)
 179 #define DPDK_DEVICE_FLAG_PMD                (1 << 2)
 180 #define DPDK_DEVICE_FLAG_PMD_INIT_FAIL      (1 << 3)
 181 #define DPDK_DEVICE_FLAG_MAYBE_MULTISEG     (1 << 4)
 182 #define DPDK_DEVICE_FLAG_HAVE_SUBIF         (1 << 5)
 183 #define DPDK_DEVICE_FLAG_HQOS               (1 << 6)
 184 #define DPDK_DEVICE_FLAG_BOND_SLAVE         (1 << 7)
 185 #define DPDK_DEVICE_FLAG_BOND_SLAVE_UP      (1 << 8)
 186 #define DPDK_DEVICE_FLAG_TX_OFFLOAD         (1 << 9)
 187 #define DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM   (1 << 10)
 188
 189   u16 nb_tx_desc;
 190     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 191
 192   u8 *interface_name_suffix;
 193
 194   /* number of sub-interfaces */
 195   u16 num_subifs;
 196
 197   /* PMD related */
 198   u16 tx_q_used;
 199   u16 rx_q_used;
 200   u16 nb_rx_desc;
 201   u16 *cpu_socket_id_by_queue;
 202   u8 *buffer_pool_for_queue;
 203   struct rte_eth_conf port_conf;
 204   struct rte_eth_txconf tx_conf;
 205
 206   /* HQoS related */
 207   dpdk_device_hqos_per_worker_thread_t *hqos_wt;
 208   dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
 209
 210   /* af_packet or BondEthernet instance number */
 211   dpdk_portid_t port_id;
 212
 213   /* Bonded interface port# of a slave -
 214      only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
 215   dpdk_portid_t bond_port;
 216
 217   struct rte_eth_link link;
 218   f64 time_last_link_update;
 219
 220   struct rte_eth_stats stats;
 221   struct rte_eth_stats last_stats;
 222   struct rte_eth_stats last_cleared_stats;
 223   struct rte_eth_xstat *xstats;
 224   struct rte_eth_xstat *last_cleared_xstats;
 225   f64 time_last_stats_update;
 226   dpdk_port_type_t port_type;
 227
 228   /* mac address */
 229   u8 *default_mac_address;
 230
 231   /* error string */
 232   clib_error_t *errors;
 233 } dpdk_device_t;
 234
 235 #define DPDK_STATS_POLL_INTERVAL      (10.0)
 236 #define DPDK_MIN_STATS_POLL_INTERVAL  (0.001)   /* 1msec */
 237
 238 #define DPDK_LINK_POLL_INTERVAL       (3.0)
 239 #define DPDK_MIN_LINK_POLL_INTERVAL   (0.001)   /* 1msec */
 240
 241 typedef struct
 242 {
 243   u32 device;
 244   u16 queue_id;
 245 } dpdk_device_and_queue_t;
 246
 247 #ifndef DPDK_HQOS_DBG_BYPASS
 248 #define DPDK_HQOS_DBG_BYPASS 0
 249 #endif
 250
 251 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
 252 #define HQOS_FLUSH_COUNT_THRESHOLD              100000
 253 #endif
 254
 255 typedef struct dpdk_device_config_hqos_t
 256 {
 257   u32 hqos_thread;
 258   u32 hqos_thread_valid;
 259
 260   u32 swq_size;
 261   u32 burst_enq;
 262   u32 burst_deq;
 263
 264   u32 pktfield0_slabpos;
 265   u32 pktfield1_slabpos;
 266   u32 pktfield2_slabpos;
 267   u64 pktfield0_slabmask;
 268   u64 pktfield1_slabmask;
 269   u64 pktfield2_slabmask;
 270   u32 tc_table[64];
 271
 272   struct rte_sched_port_params port;
 273   struct rte_sched_subport_params *subport;
 274   struct rte_sched_pipe_params *pipe;
 275   uint32_t *pipe_map;
 276 } dpdk_device_config_hqos_t;
 277
 278 int dpdk_hqos_validate_mask (u64 mask, u32 n);
 279 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
 280                                                    hqos, u32 pipe_profile_id);
 281 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
 282 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
 283                                     dpdk_device_config_hqos_t * hqos);
 284 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
 285                              struct rte_mbuf **pkts, u32 n_pkts);
 286
 287 #define foreach_dpdk_device_config_item \
 288   _ (num_rx_queues) \
 289   _ (num_tx_queues) \
 290   _ (num_rx_desc) \
 291   _ (num_tx_desc) \
 292   _ (rss_fn)
 293
 294 typedef struct
 295 {
 296   vlib_pci_addr_t pci_addr;
 297   u8 is_blacklisted;
 298   u8 vlan_strip_offload;
 299 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
 300 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
 301 #define DPDK_DEVICE_VLAN_STRIP_ON  2
 302
 303 #define _(x) uword x;
 304     foreach_dpdk_device_config_item
 305 #undef _
 306     clib_bitmap_t * workers;
 307   u32 hqos_enabled;
 308   dpdk_device_config_hqos_t hqos;
 309 } dpdk_device_config_t;
 310
 311 typedef struct
 312 {
 313
 314   /* Config stuff */
 315   u8 **eal_init_args;
 316   u8 *eal_init_args_str;
 317   u8 *uio_driver_name;
 318   u8 no_multi_seg;
 319   u8 enable_tcp_udp_checksum;
 320   u8 no_tx_checksum_offload;
 321
 322   /* Required config parameters */
 323   u8 coremask_set_manually;
 324   u8 nchannels_set_manually;
 325   u32 coremask;
 326   u32 nchannels;
 327   u32 num_mbufs;
 328
 329   /*
 330    * format interface names ala xxxEthernet%d/%d/%d instead of
 331    * xxxEthernet%x/%x/%x.
 332    */
 333   u8 interface_name_format_decimal;
 334
 335   /* per-device config */
 336   dpdk_device_config_t default_devconf;
 337   dpdk_device_config_t *dev_confs;
 338   uword *device_config_index_by_pci_addr;
 339
 340 } dpdk_config_main_t;
 341
 342 extern dpdk_config_main_t dpdk_config_main;
 343
 344 typedef struct
 345 {
 346
 347   /* Devices */
 348   dpdk_device_t *devices;
 349   dpdk_device_and_queue_t **devices_by_hqos_cpu;
 350
 351   /* per-thread recycle lists */
 352   u32 **recycle;
 353
 354   /* per-thread buffer templates */
 355   vlib_buffer_t *buffer_templates;
 356
 357   /* buffer flags template, configurable to enable/disable tcp / udp cksum */
 358   u32 buffer_flags_template;
 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   /* which cpus are running I/O TX */
 374   int hqos_cpu_first_index;
 375   int hqos_cpu_count;
 376
 377   /* control interval of dpdk link state and stat polling */
 378   f64 link_state_poll_interval;
 379   f64 stat_poll_interval;
 380
 381   /* Sleep for this many usec after each device poll */
 382   u32 poll_sleep_usec;
 383
 384   /* convenience */
 385   vlib_main_t *vlib_main;
 386   vnet_main_t *vnet_main;
 387   dpdk_config_main_t *conf;
 388
 389   /* mempool */
 390   struct rte_mempool **pktmbuf_pools;
 391
 392   /* API message ID base */
 393   u16 msg_id_base;
 394 } dpdk_main_t;
 395
 396 extern dpdk_main_t dpdk_main;
 397
 398 typedef struct
 399 {
 400   u32 buffer_index;
 401   u16 device_index;
 402   u8 queue_index;
 403   struct rte_mbuf mb;
 404   /* Copy of VLIB buffer; packet data stored in pre_data. */
 405   vlib_buffer_t buffer;
 406   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 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 int dpdk_port_state_callback (dpdk_portid_t port_id,
 424                               enum rte_eth_event_type type,
 425                               void *param, void *ret_param);
 426
 427 #define foreach_dpdk_error                                              \
 428   _(NONE, "no error")                                                   \
 429   _(RX_PACKET_ERROR, "Rx packet errors")                                \
 430   _(RX_BAD_FCS, "Rx bad fcs")                                           \
 431   _(IP_CHECKSUM_ERROR, "Rx ip checksum errors")                         \
 432   _(RX_ALLOC_FAIL, "rx buf alloc from free list failed")                \
 433   _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem")              \
 434   _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
 435
 436 typedef enum
 437 {
 438 #define _(f,s) DPDK_ERROR_##f,
 439   foreach_dpdk_error
 440 #undef _
 441     DPDK_N_ERROR,
 442 } dpdk_error_t;
 443
 444 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
 445
 446 format_function_t format_dpdk_device_name;
 447 format_function_t format_dpdk_device;
 448 format_function_t format_dpdk_device_errors;
 449 format_function_t format_dpdk_tx_dma_trace;
 450 format_function_t format_dpdk_rx_dma_trace;
 451 format_function_t format_dpdk_rte_mbuf;
 452 format_function_t format_dpdk_rx_rte_mbuf;
 453 unformat_function_t unformat_dpdk_log_level;
 454 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
 455 clib_error_t *unformat_hqos (unformat_input_t * input,
 456                              dpdk_device_config_hqos_t * hqos);
 457
 458 uword
 459 admin_up_down_process (vlib_main_t * vm,
 460                        vlib_node_runtime_t * rt, vlib_frame_t * f);
 461
 462 clib_error_t *dpdk_pool_create (vlib_main_t * vm, u8 * pool_name,
 463                                 u32 elt_size, u32 num_elts,
 464                                 u32 pool_priv_size, u16 cache_size, u8 numa,
 465                                 struct rte_mempool **_mp,
 466                                 vlib_physmem_region_index_t * pri);
 467
 468 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
 469                                        unsigned socket_id);
 470
 471 #if CLI_DEBUG
 472 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
 473 void dpdk_buffer_poison_trajectory_all (void);
 474 #endif
 475
 476 #endif /* __included_dpdk_h__ */
 477
 478 /*
 479  * fd.io coding-style-patch-verification: ON
 480  *
 481  * Local Variables:
 482  * eval: (c-set-style "gnu")
 483  * End:
 484  */