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 #include <rte_flow.h>
  44
  45 #include <vnet/unix/pcap.h>
  46 #include <vnet/devices/devices.h>
  47
  48 #if CLIB_DEBUG > 0
  49 #define always_inline static inline
  50 #else
  51 #define always_inline static inline __attribute__ ((__always_inline__))
  52 #endif
  53
  54 #include <vlib/pci/pci.h>
  55 #include <vnet/flow/flow.h>
  56
  57 #define NB_MBUF   (16<<10)
  58
  59 extern vnet_device_class_t dpdk_device_class;
  60 extern vlib_node_registration_t dpdk_input_node;
  61
  62 #define foreach_dpdk_pmd          \
  63   _ ("net_thunderx", THUNDERX)    \
  64   _ ("net_e1000_em", E1000EM)     \
  65   _ ("net_e1000_igb", IGB)        \
  66   _ ("net_e1000_igb_vf", IGBVF)   \
  67   _ ("net_ixgbe", IXGBE)          \
  68   _ ("net_ixgbe_vf", IXGBEVF)     \
  69   _ ("net_i40e", I40E)            \
  70   _ ("net_i40e_vf", I40EVF)       \
  71   _ ("net_virtio", VIRTIO)        \
  72   _ ("net_enic", ENIC)            \
  73   _ ("net_vmxnet3", VMXNET3)      \
  74   _ ("AF_PACKET PMD", AF_PACKET)  \
  75   _ ("net_bonding", BOND)         \
  76   _ ("net_fm10k", FM10K)          \
  77   _ ("net_cxgbe", CXGBE)          \
  78   _ ("net_mlx4", MLX4)            \
  79   _ ("net_mlx5", MLX5)            \
  80   _ ("net_dpaa2", DPAA2)          \
  81   _ ("net_virtio_user", VIRTIO_USER) \
  82   _ ("net_vhost", VHOST_ETHER)    \
  83   _ ("net_ena", ENA)              \
  84   _ ("net_failsafe", FAILSAFE)    \
  85   _ ("net_liovf", LIOVF_ETHER)
  86
  87 typedef enum
  88 {
  89   VNET_DPDK_PMD_NONE,
  90 #define _(s,f) VNET_DPDK_PMD_##f,
  91   foreach_dpdk_pmd
  92 #undef _
  93     VNET_DPDK_PMD_UNKNOWN,      /* must be last */
  94 } dpdk_pmd_t;
  95
  96 typedef enum
  97 {
  98   VNET_DPDK_PORT_TYPE_ETH_1G,
  99   VNET_DPDK_PORT_TYPE_ETH_2_5G,
 100   VNET_DPDK_PORT_TYPE_ETH_5G,
 101   VNET_DPDK_PORT_TYPE_ETH_10G,
 102   VNET_DPDK_PORT_TYPE_ETH_20G,
 103   VNET_DPDK_PORT_TYPE_ETH_25G,
 104   VNET_DPDK_PORT_TYPE_ETH_40G,
 105   VNET_DPDK_PORT_TYPE_ETH_50G,
 106   VNET_DPDK_PORT_TYPE_ETH_56G,
 107   VNET_DPDK_PORT_TYPE_ETH_100G,
 108   VNET_DPDK_PORT_TYPE_ETH_BOND,
 109   VNET_DPDK_PORT_TYPE_ETH_SWITCH,
 110   VNET_DPDK_PORT_TYPE_AF_PACKET,
 111   VNET_DPDK_PORT_TYPE_ETH_VF,
 112   VNET_DPDK_PORT_TYPE_VIRTIO_USER,
 113   VNET_DPDK_PORT_TYPE_VHOST_ETHER,
 114   VNET_DPDK_PORT_TYPE_FAILSAFE,
 115   VNET_DPDK_PORT_TYPE_UNKNOWN,
 116 } dpdk_port_type_t;
 117
 118 typedef uint16_t dpdk_portid_t;
 119
 120 typedef struct
 121 {
 122   /* Required for vec_validate_aligned */
 123   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 124
 125   struct rte_ring *swq;
 126
 127   u64 hqos_field0_slabmask;
 128   u32 hqos_field0_slabpos;
 129   u32 hqos_field0_slabshr;
 130   u64 hqos_field1_slabmask;
 131   u32 hqos_field1_slabpos;
 132   u32 hqos_field1_slabshr;
 133   u64 hqos_field2_slabmask;
 134   u32 hqos_field2_slabpos;
 135   u32 hqos_field2_slabshr;
 136   u32 hqos_tc_table[64];
 137 } dpdk_device_hqos_per_worker_thread_t;
 138
 139 typedef struct
 140 {
 141   /* Required for vec_validate_aligned */
 142   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 143   struct rte_ring **swq;
 144   struct rte_mbuf **pkts_enq;
 145   struct rte_mbuf **pkts_deq;
 146   struct rte_sched_port *hqos;
 147   u32 hqos_burst_enq;
 148   u32 hqos_burst_deq;
 149   u32 pkts_enq_len;
 150   u32 swq_pos;
 151   u32 flush_count;
 152 } dpdk_device_hqos_per_hqos_thread_t;
 153
 154 #define foreach_dpdk_device_flags \
 155   _( 0, ADMIN_UP, "admin-up") \
 156   _( 1, PROMISC, "promisc") \
 157   _( 2, PMD, "pmd") \
 158   _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
 159   _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
 160   _( 5, HAVE_SUBIF, "subif") \
 161   _( 6, HQOS, "hqos") \
 162   _( 7, BOND_SLAVE, "bond-slave") \
 163   _( 8, BOND_SLAVE_UP, "bond-slave-up") \
 164   _( 9, TX_OFFLOAD, "tx-offload") \
 165   _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
 166   _(11, RX_FLOW_OFFLOAD, "rx-flow-offload")
 167
 168 enum
 169 {
 170 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
 171   foreach_dpdk_device_flags
 172 #undef _
 173 };
 174
 175 typedef struct
 176 {
 177   u32 flow_index;
 178   u32 mark;
 179   struct rte_flow *handle;
 180 } dpdk_flow_entry_t;
 181
 182 typedef struct
 183 {
 184   u32 flow_id;
 185   u16 next_index;
 186   i16 buffer_advance;
 187 } dpdk_flow_lookup_entry_t;
 188
 189 typedef struct
 190 {
 191   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 192   volatile u32 **lockp;
 193
 194   /* Instance ID */
 195   dpdk_portid_t device_index;
 196
 197   u32 hw_if_index;
 198   u32 sw_if_index;
 199
 200   /* next node index if we decide to steal the rx graph arc */
 201   u32 per_interface_next_index;
 202
 203   dpdk_pmd_t pmd:8;
 204   i8 cpu_socket;
 205
 206   u16 flags;
 207
 208   u16 nb_tx_desc;
 209     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 210
 211   u8 *interface_name_suffix;
 212
 213   /* number of sub-interfaces */
 214   u16 num_subifs;
 215
 216   /* PMD related */
 217   u16 tx_q_used;
 218   u16 rx_q_used;
 219   u16 nb_rx_desc;
 220   u16 *cpu_socket_id_by_queue;
 221   u8 *buffer_pool_for_queue;
 222   struct rte_eth_conf port_conf;
 223   struct rte_eth_txconf tx_conf;
 224
 225   /* flow related */
 226   u32 supported_flow_actions;
 227   dpdk_flow_entry_t *flow_entries;      /* pool */
 228   dpdk_flow_lookup_entry_t *flow_lookup_entries;        /* vector */
 229   struct rte_flow_error last_flow_error;
 230
 231   /* HQoS related */
 232   dpdk_device_hqos_per_worker_thread_t *hqos_wt;
 233   dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
 234
 235   /* af_packet or BondEthernet instance number */
 236   u16 af_packet_instance_num;
 237   u16 bond_instance_num;
 238
 239   /* Bonded interface port# of a slave -
 240      only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
 241   dpdk_portid_t bond_port;
 242
 243   struct rte_eth_link link;
 244   f64 time_last_link_update;
 245
 246   struct rte_eth_stats stats;
 247   struct rte_eth_stats last_stats;
 248   struct rte_eth_stats last_cleared_stats;
 249   struct rte_eth_xstat *xstats;
 250   struct rte_eth_xstat *last_cleared_xstats;
 251   f64 time_last_stats_update;
 252   dpdk_port_type_t port_type;
 253
 254   /* mac address */
 255   u8 *default_mac_address;
 256
 257   /* error string */
 258   clib_error_t *errors;
 259 } dpdk_device_t;
 260
 261 #define DPDK_STATS_POLL_INTERVAL      (10.0)
 262 #define DPDK_MIN_STATS_POLL_INTERVAL  (0.001)   /* 1msec */
 263
 264 #define DPDK_LINK_POLL_INTERVAL       (3.0)
 265 #define DPDK_MIN_LINK_POLL_INTERVAL   (0.001)   /* 1msec */
 266
 267 typedef struct
 268 {
 269   u32 device;
 270   u16 queue_id;
 271 } dpdk_device_and_queue_t;
 272
 273 #ifndef DPDK_HQOS_DBG_BYPASS
 274 #define DPDK_HQOS_DBG_BYPASS 0
 275 #endif
 276
 277 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
 278 #define HQOS_FLUSH_COUNT_THRESHOLD              100000
 279 #endif
 280
 281 typedef struct dpdk_device_config_hqos_t
 282 {
 283   u32 hqos_thread;
 284   u32 hqos_thread_valid;
 285
 286   u32 swq_size;
 287   u32 burst_enq;
 288   u32 burst_deq;
 289
 290   u32 pktfield0_slabpos;
 291   u32 pktfield1_slabpos;
 292   u32 pktfield2_slabpos;
 293   u64 pktfield0_slabmask;
 294   u64 pktfield1_slabmask;
 295   u64 pktfield2_slabmask;
 296   u32 tc_table[64];
 297
 298   struct rte_sched_port_params port;
 299   struct rte_sched_subport_params *subport;
 300   struct rte_sched_pipe_params *pipe;
 301   uint32_t *pipe_map;
 302 } dpdk_device_config_hqos_t;
 303
 304 int dpdk_hqos_validate_mask (u64 mask, u32 n);
 305 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
 306                                                    hqos, u32 pipe_profile_id);
 307 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
 308 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
 309                                     dpdk_device_config_hqos_t * hqos);
 310 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
 311                              struct rte_mbuf **pkts, u32 n_pkts);
 312
 313 #define foreach_dpdk_device_config_item \
 314   _ (num_rx_queues) \
 315   _ (num_tx_queues) \
 316   _ (num_rx_desc) \
 317   _ (num_tx_desc) \
 318   _ (rss_fn)
 319
 320 typedef struct
 321 {
 322   vlib_pci_addr_t pci_addr;
 323   u8 is_blacklisted;
 324   u8 vlan_strip_offload;
 325 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
 326 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
 327 #define DPDK_DEVICE_VLAN_STRIP_ON  2
 328
 329 #define _(x) uword x;
 330     foreach_dpdk_device_config_item
 331 #undef _
 332     clib_bitmap_t * workers;
 333   u32 hqos_enabled;
 334   dpdk_device_config_hqos_t hqos;
 335 } dpdk_device_config_t;
 336
 337 typedef struct
 338 {
 339
 340   /* Config stuff */
 341   u8 **eal_init_args;
 342   u8 *eal_init_args_str;
 343   u8 *uio_driver_name;
 344   u8 no_multi_seg;
 345   u8 enable_tcp_udp_checksum;
 346   u8 no_tx_checksum_offload;
 347
 348   /* Required config parameters */
 349   u8 coremask_set_manually;
 350   u8 nchannels_set_manually;
 351   u32 coremask;
 352   u32 nchannels;
 353   u32 num_mbufs;
 354
 355   /*
 356    * format interface names ala xxxEthernet%d/%d/%d instead of
 357    * xxxEthernet%x/%x/%x.
 358    */
 359   u8 interface_name_format_decimal;
 360
 361   /* per-device config */
 362   dpdk_device_config_t default_devconf;
 363   dpdk_device_config_t *dev_confs;
 364   uword *device_config_index_by_pci_addr;
 365
 366 } dpdk_config_main_t;
 367
 368 extern dpdk_config_main_t dpdk_config_main;
 369
 370 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
 371
 372 typedef struct
 373 {
 374   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 375   struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
 376   u32 buffers[DPDK_RX_BURST_SZ];
 377   u16 next[DPDK_RX_BURST_SZ];
 378   u16 etype[DPDK_RX_BURST_SZ];
 379   u8 flags[DPDK_RX_BURST_SZ];
 380   vlib_buffer_t buffer_template;
 381 } dpdk_per_thread_data_t;
 382
 383 typedef struct
 384 {
 385   int pcap_enable;
 386   pcap_main_t pcap_main;
 387   u8 *pcap_filename;
 388   u32 pcap_sw_if_index;
 389   u32 pcap_pkts_to_capture;
 390 } dpdk_pcap_t;
 391
 392 typedef struct
 393 {
 394
 395   /* Devices */
 396   dpdk_device_t *devices;
 397   dpdk_device_and_queue_t **devices_by_hqos_cpu;
 398   dpdk_per_thread_data_t *per_thread_data;
 399
 400   /* per-thread recycle lists */
 401   u32 **recycle;
 402
 403   /* buffer flags template, configurable to enable/disable tcp / udp cksum */
 404   u32 buffer_flags_template;
 405
 406   /* pcap tracing */
 407   dpdk_pcap_t pcap[VLIB_N_RX_TX];
 408
 409   int pcap_enable;
 410   pcap_main_t pcap_main;
 411   u8 *pcap_filename;
 412   u32 pcap_sw_if_index;
 413   u32 pcap_pkts_to_capture;
 414
 415   /*
 416    * flag indicating that a posted admin up/down
 417    * (via post_sw_interface_set_flags) is in progress
 418    */
 419   u8 admin_up_down_in_progress;
 420
 421   /* which cpus are running I/O TX */
 422   int hqos_cpu_first_index;
 423   int hqos_cpu_count;
 424
 425   /* control interval of dpdk link state and stat polling */
 426   f64 link_state_poll_interval;
 427   f64 stat_poll_interval;
 428
 429   /* Sleep for this many usec after each device poll */
 430   u32 poll_sleep_usec;
 431
 432   /* convenience */
 433   vlib_main_t *vlib_main;
 434   vnet_main_t *vnet_main;
 435   dpdk_config_main_t *conf;
 436
 437   /* mempool */
 438   struct rte_mempool **pktmbuf_pools;
 439
 440   /* API message ID base */
 441   u16 msg_id_base;
 442
 443   /* logging */
 444   vlib_log_class_t log_default;
 445 } dpdk_main_t;
 446
 447 extern dpdk_main_t dpdk_main;
 448
 449 typedef struct
 450 {
 451   u32 buffer_index;
 452   u16 device_index;
 453   u8 queue_index;
 454   struct rte_mbuf mb;
 455   /* Copy of VLIB buffer; packet data stored in pre_data. */
 456   vlib_buffer_t buffer;
 457   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 458 } dpdk_tx_trace_t;
 459
 460 typedef struct
 461 {
 462   u32 buffer_index;
 463   u16 device_index;
 464   u16 queue_index;
 465   struct rte_mbuf mb;
 466   vlib_buffer_t buffer;         /* Copy of VLIB buffer; pkt data stored in pre_data. */
 467   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 468 } dpdk_rx_trace_t;
 469
 470 void dpdk_device_setup (dpdk_device_t * xd);
 471 void dpdk_device_start (dpdk_device_t * xd);
 472 void dpdk_device_stop (dpdk_device_t * xd);
 473
 474 int dpdk_port_state_callback (dpdk_portid_t port_id,
 475                               enum rte_eth_event_type type,
 476                               void *param, void *ret_param);
 477
 478 #define foreach_dpdk_error                                              \
 479   _(NONE, "no error")                                                   \
 480   _(RX_PACKET_ERROR, "Rx packet errors")                                \
 481   _(RX_BAD_FCS, "Rx bad fcs")                                           \
 482   _(IP_CHECKSUM_ERROR, "Rx ip checksum errors")                         \
 483   _(RX_ALLOC_FAIL, "rx buf alloc from free list failed")                \
 484   _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem")              \
 485   _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
 486
 487 typedef enum
 488 {
 489 #define _(f,s) DPDK_ERROR_##f,
 490   foreach_dpdk_error
 491 #undef _
 492     DPDK_N_ERROR,
 493 } dpdk_error_t;
 494
 495 #define dpdk_log_err(...) \
 496   vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
 497 #define dpdk_log_warn(...) \
 498   vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
 499 #define dpdk_log_notice(...) \
 500   vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
 501 #define dpdk_log_info(...) \
 502   vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
 503
 504 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
 505
 506 format_function_t format_dpdk_device_name;
 507 format_function_t format_dpdk_device;
 508 format_function_t format_dpdk_device_errors;
 509 format_function_t format_dpdk_tx_trace;
 510 format_function_t format_dpdk_rx_trace;
 511 format_function_t format_dpdk_rte_mbuf;
 512 format_function_t format_dpdk_rx_rte_mbuf;
 513 format_function_t format_dpdk_flow;
 514 unformat_function_t unformat_dpdk_log_level;
 515 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
 516
 517 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
 518 clib_error_t *unformat_hqos (unformat_input_t * input,
 519                              dpdk_device_config_hqos_t * hqos);
 520
 521 uword
 522 admin_up_down_process (vlib_main_t * vm,
 523                        vlib_node_runtime_t * rt, vlib_frame_t * f);
 524
 525 clib_error_t *dpdk_pool_create (vlib_main_t * vm, u8 * pool_name,
 526                                 u32 elt_size, u32 num_elts,
 527                                 u32 pool_priv_size, u16 cache_size, u8 numa,
 528                                 struct rte_mempool **_mp,
 529                                 vlib_physmem_region_index_t * pri);
 530
 531 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
 532                                        unsigned socket_id);
 533
 534 #if CLI_DEBUG
 535 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
 536 void dpdk_buffer_poison_trajectory_all (void);
 537 #endif
 538
 539 #endif /* __included_dpdk_h__ */
 540
 541 /*
 542  * fd.io coding-style-patch-verification: ON
 543  *
 544  * Local Variables:
 545  * eval: (c-set-style "gnu")
 546  * End:
 547  */