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