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