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