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 #define ALLOW_EXPERIMENTAL_API
  22
  23 #include <rte_config.h>
  24
  25 #include <rte_common.h>
  26 #include <rte_dev.h>
  27 #include <rte_memory.h>
  28 #include <rte_eal.h>
  29 #include <rte_per_lcore.h>
  30 #include <rte_cycles.h>
  31 #include <rte_lcore.h>
  32 #include <rte_per_lcore.h>
  33 #include <rte_interrupts.h>
  34 #include <rte_pci.h>
  35 #include <rte_bus_vmbus.h>
  36 #include <rte_ether.h>
  37 #include <rte_ethdev.h>
  38 #include <rte_ring.h>
  39 #include <rte_mempool.h>
  40 #include <rte_mbuf.h>
  41 #include <rte_version.h>
  42 #include <rte_sched.h>
  43 #include <rte_net.h>
  44 #include <rte_bus_pci.h>
  45 #include <rte_flow.h>
  46
  47 #include <vnet/devices/devices.h>
  48
  49 #if CLIB_DEBUG > 0
  50 #define always_inline static inline
  51 #else
  52 #define always_inline static inline __attribute__ ((__always_inline__))
  53 #endif
  54
  55 #include <vlib/pci/pci.h>
  56 #include <vlib/vmbus/vmbus.h>
  57 #include <vnet/flow/flow.h>
  58
  59 extern vnet_device_class_t dpdk_device_class;
  60 extern vlib_node_registration_t dpdk_input_node;
  61 extern vlib_node_registration_t admin_up_down_process_node;
  62
  63 #if RTE_VERSION < RTE_VERSION_NUM(20, 8, 0, 0)
  64 #define DPDK_MLX5_PMD_NAME "net_mlx5"
  65 #else
  66 #define DPDK_MLX5_PMD_NAME "mlx5_pci"
  67 #endif
  68
  69 #define foreach_dpdk_pmd                                                      \
  70   _ ("net_thunderx", THUNDERX)                                                \
  71   _ ("net_e1000_em", E1000EM)                                                 \
  72   _ ("net_e1000_igb", IGB)                                                    \
  73   _ ("net_e1000_igb_vf", IGBVF)                                               \
  74   _ ("net_ixgbe", IXGBE)                                                      \
  75   _ ("net_ixgbe_vf", IXGBEVF)                                                 \
  76   _ ("net_i40e", I40E)                                                        \
  77   _ ("net_i40e_vf", I40EVF)                                                   \
  78   _ ("net_ice", ICE)                                                          \
  79   _ ("net_iavf", IAVF)                                                        \
  80   _ ("net_igc", IGC)                                                          \
  81   _ ("net_virtio", VIRTIO)                                                    \
  82   _ ("net_enic", ENIC)                                                        \
  83   _ ("net_vmxnet3", VMXNET3)                                                  \
  84   _ ("AF_PACKET PMD", AF_PACKET)                                              \
  85   _ ("net_fm10k", FM10K)                                                      \
  86   _ ("net_cxgbe", CXGBE)                                                      \
  87   _ ("net_mlx4", MLX4)                                                        \
  88   _ (DPDK_MLX5_PMD_NAME, MLX5)                                                \
  89   _ ("net_dpaa2", DPAA2)                                                      \
  90   _ ("net_virtio_user", VIRTIO_USER)                                          \
  91   _ ("net_vhost", VHOST_ETHER)                                                \
  92   _ ("net_ena", ENA)                                                          \
  93   _ ("net_failsafe", FAILSAFE)                                                \
  94   _ ("net_liovf", LIOVF_ETHER)                                                \
  95   _ ("net_qede", QEDE)                                                        \
  96   _ ("net_netvsc", NETVSC)                                                    \
  97   _ ("net_bnxt", BNXT)
  98
  99 typedef enum
 100 {
 101   VNET_DPDK_PMD_NONE,
 102 #define _(s,f) VNET_DPDK_PMD_##f,
 103   foreach_dpdk_pmd
 104 #undef _
 105     VNET_DPDK_PMD_UNKNOWN,      /* must be last */
 106 } dpdk_pmd_t;
 107
 108 typedef enum
 109 {
 110   VNET_DPDK_PORT_TYPE_ETH_1G,
 111   VNET_DPDK_PORT_TYPE_ETH_2_5G,
 112   VNET_DPDK_PORT_TYPE_ETH_5G,
 113   VNET_DPDK_PORT_TYPE_ETH_10G,
 114   VNET_DPDK_PORT_TYPE_ETH_20G,
 115   VNET_DPDK_PORT_TYPE_ETH_25G,
 116   VNET_DPDK_PORT_TYPE_ETH_40G,
 117   VNET_DPDK_PORT_TYPE_ETH_50G,
 118   VNET_DPDK_PORT_TYPE_ETH_56G,
 119   VNET_DPDK_PORT_TYPE_ETH_100G,
 120   VNET_DPDK_PORT_TYPE_ETH_SWITCH,
 121   VNET_DPDK_PORT_TYPE_AF_PACKET,
 122   VNET_DPDK_PORT_TYPE_ETH_VF,
 123   VNET_DPDK_PORT_TYPE_VIRTIO_USER,
 124   VNET_DPDK_PORT_TYPE_VHOST_ETHER,
 125   VNET_DPDK_PORT_TYPE_FAILSAFE,
 126   VNET_DPDK_PORT_TYPE_NETVSC,
 127   VNET_DPDK_PORT_TYPE_UNKNOWN,
 128 } dpdk_port_type_t;
 129
 130 typedef uint16_t dpdk_portid_t;
 131
 132 #define foreach_dpdk_device_flags                                             \
 133   _ (0, ADMIN_UP, "admin-up")                                                 \
 134   _ (1, PROMISC, "promisc")                                                   \
 135   _ (2, PMD, "pmd")                                                           \
 136   _ (3, PMD_INIT_FAIL, "pmd-init-fail")                                       \
 137   _ (4, MAYBE_MULTISEG, "maybe-multiseg")                                     \
 138   _ (5, HAVE_SUBIF, "subif")                                                  \
 139   _ (9, TX_OFFLOAD, "tx-offload")                                             \
 140   _ (10, INTEL_PHDR_CKSUM, "intel-phdr-cksum")                                \
 141   _ (11, RX_FLOW_OFFLOAD, "rx-flow-offload")                                  \
 142   _ (12, RX_IP4_CKSUM, "rx-ip4-cksum")                                        \
 143   _ (13, INT_SUPPORTED, "int-supported")                                      \
 144   _ (14, INT_UNMASKABLE, "int-unmaskable")
 145
 146 enum
 147 {
 148 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
 149   foreach_dpdk_device_flags
 150 #undef _
 151 };
 152
 153 typedef struct
 154 {
 155   u32 flow_index;
 156   u32 mark;
 157   struct rte_flow *handle;
 158 } dpdk_flow_entry_t;
 159
 160 typedef struct
 161 {
 162   u32 flow_id;
 163   u16 next_index;
 164   i16 buffer_advance;
 165 } dpdk_flow_lookup_entry_t;
 166
 167 typedef struct
 168 {
 169   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 170   u8 buffer_pool_index;
 171   u32 queue_index;
 172   int efd;
 173   uword clib_file_index;
 174 } dpdk_rx_queue_t;
 175
 176 typedef struct
 177 {
 178   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 179   clib_spinlock_t lock;
 180 } dpdk_tx_queue_t;
 181
 182 typedef struct
 183 {
 184   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 185
 186   dpdk_rx_queue_t *rx_queues;
 187   dpdk_tx_queue_t *tx_queues;
 188
 189   /* Instance ID to access internal device array. */
 190   u32 device_index;
 191
 192   u32 hw_if_index;
 193   u32 sw_if_index;
 194
 195   /* next node index if we decide to steal the rx graph arc */
 196   u32 per_interface_next_index;
 197
 198   u16 rx_q_used;
 199   u16 tx_q_used;
 200   u16 flags;
 201
 202   /* DPDK device port number */
 203   dpdk_portid_t port_id;
 204   dpdk_pmd_t pmd:8;
 205   i8 cpu_socket;
 206
 207     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 208   u16 nb_tx_desc;
 209   u16 nb_rx_desc;
 210
 211   u8 *name;
 212   u8 *interface_name_suffix;
 213
 214   /* number of sub-interfaces */
 215   u16 num_subifs;
 216
 217   /* PMD related */
 218   struct rte_eth_conf port_conf;
 219   struct rte_eth_txconf tx_conf;
 220
 221   /* flow related */
 222   u32 supported_flow_actions;
 223   dpdk_flow_entry_t *flow_entries;      /* pool */
 224   dpdk_flow_lookup_entry_t *flow_lookup_entries;        /* pool */
 225   u32 *parked_lookup_indexes;   /* vector */
 226   u32 parked_loop_count;
 227   struct rte_flow_error last_flow_error;
 228
 229   /* af_packet instance number */
 230   u16 af_packet_instance_num;
 231
 232   struct rte_eth_link link;
 233   f64 time_last_link_update;
 234
 235   struct rte_eth_stats stats;
 236   struct rte_eth_stats last_stats;
 237   struct rte_eth_xstat *xstats;
 238   f64 time_last_stats_update;
 239   dpdk_port_type_t port_type;
 240
 241   /* mac address */
 242   u8 *default_mac_address;
 243
 244   /* error string */
 245   clib_error_t *errors;
 246 } dpdk_device_t;
 247
 248 #define DPDK_STATS_POLL_INTERVAL      (10.0)
 249 #define DPDK_MIN_STATS_POLL_INTERVAL  (0.001)   /* 1msec */
 250
 251 #define DPDK_LINK_POLL_INTERVAL       (3.0)
 252 #define DPDK_MIN_LINK_POLL_INTERVAL   (0.001)   /* 1msec */
 253
 254 #define foreach_dpdk_device_config_item                                       \
 255   _ (num_rx_queues)                                                           \
 256   _ (num_tx_queues)                                                           \
 257   _ (num_rx_desc)                                                             \
 258   _ (num_tx_desc)                                                             \
 259   _ (max_lro_pkt_size)                                                        \
 260   _ (rss_fn)
 261
 262 typedef enum
 263 {
 264   VNET_DEV_ADDR_PCI,
 265   VNET_DEV_ADDR_VMBUS,
 266   VNET_DEV_ADDR_ANY,
 267 } dpdk_device_addr_type_t;
 268
 269 typedef struct
 270 {
 271   union
 272   {
 273     vlib_pci_addr_t pci_addr;
 274     vlib_vmbus_addr_t vmbus_addr;
 275   };
 276   dpdk_device_addr_type_t dev_addr_type;
 277   u8 *name;
 278   u8 is_blacklisted;
 279   u8 vlan_strip_offload;
 280 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
 281 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
 282 #define DPDK_DEVICE_VLAN_STRIP_ON  2
 283
 284 #define _(x) uword x;
 285     foreach_dpdk_device_config_item
 286 #undef _
 287     clib_bitmap_t * workers;
 288   u8 tso;
 289   u8 *devargs;
 290   clib_bitmap_t *rss_queues;
 291
 292 #define DPDK_DEVICE_TSO_DEFAULT 0
 293 #define DPDK_DEVICE_TSO_OFF 1
 294 #define DPDK_DEVICE_TSO_ON  2
 295 } dpdk_device_config_t;
 296
 297 typedef struct
 298 {
 299
 300   /* Config stuff */
 301   u8 **eal_init_args;
 302   u8 *eal_init_args_str;
 303   u8 *uio_driver_name;
 304   u8 no_multi_seg;
 305   u8 enable_lro;
 306   u8 enable_tcp_udp_checksum;
 307   u8 no_tx_checksum_offload;
 308   u8 enable_telemetry;
 309   u16 max_simd_bitwidth;
 310
 311 #define DPDK_MAX_SIMD_BITWIDTH_DEFAULT 0
 312 #define DPDK_MAX_SIMD_BITWIDTH_256     256
 313 #define DPDK_MAX_SIMD_BITWIDTH_512     512
 314
 315   /* Required config parameters */
 316   u8 coremask_set_manually;
 317   u8 nchannels_set_manually;
 318   u32 coremask;
 319   u32 nchannels;
 320   u32 num_crypto_mbufs;
 321
 322   /*
 323    * format interface names ala xxxEthernet%d/%d/%d instead of
 324    * xxxEthernet%x/%x/%x.
 325    */
 326   u8 interface_name_format_decimal;
 327
 328   /* per-device config */
 329   dpdk_device_config_t default_devconf;
 330   dpdk_device_config_t *dev_confs;
 331   uword *device_config_index_by_pci_addr;
 332   mhash_t device_config_index_by_vmbus_addr;
 333
 334   /* devices blacklist by pci vendor_id, device_id */
 335   u32 *blacklist_by_pci_vendor_and_device;
 336   /* devices blacklist by VMBUS address */
 337   vlib_vmbus_addr_t *blacklist_by_vmbus_addr;
 338
 339 } dpdk_config_main_t;
 340
 341 extern dpdk_config_main_t dpdk_config_main;
 342
 343 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
 344
 345 typedef struct
 346 {
 347   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 348   struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
 349   u32 buffers[DPDK_RX_BURST_SZ];
 350   u16 next[DPDK_RX_BURST_SZ];
 351   u16 etype[DPDK_RX_BURST_SZ];
 352   u32 flags[DPDK_RX_BURST_SZ];
 353   vlib_buffer_t buffer_template;
 354 } dpdk_per_thread_data_t;
 355
 356 typedef struct
 357 {
 358
 359   /* Devices */
 360   dpdk_device_t *devices;
 361   dpdk_per_thread_data_t *per_thread_data;
 362
 363   /* buffer flags template, configurable to enable/disable tcp / udp cksum */
 364   u32 buffer_flags_template;
 365
 366   /*
 367    * flag indicating that a posted admin up/down
 368    * (via post_sw_interface_set_flags) is in progress
 369    */
 370   u8 admin_up_down_in_progress;
 371
 372   /* control interval of dpdk link state and stat polling */
 373   f64 link_state_poll_interval;
 374   f64 stat_poll_interval;
 375
 376   /* convenience */
 377   vlib_main_t *vlib_main;
 378   vnet_main_t *vnet_main;
 379   dpdk_config_main_t *conf;
 380
 381   /* API message ID base */
 382   u16 msg_id_base;
 383
 384   /* logging */
 385   vlib_log_class_t log_default;
 386   vlib_log_class_t log_cryptodev;
 387   vlib_log_class_t log_ipsec;
 388 } dpdk_main_t;
 389
 390 extern dpdk_main_t dpdk_main;
 391
 392 typedef struct
 393 {
 394   u32 buffer_index;
 395   u16 device_index;
 396   u8 queue_index;
 397   struct rte_mbuf mb;
 398   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 399   /* Copy of VLIB buffer; packet data stored in pre_data. */
 400   vlib_buffer_t buffer;
 401 } dpdk_tx_trace_t;
 402
 403 typedef struct
 404 {
 405   u32 buffer_index;
 406   u16 device_index;
 407   u16 queue_index;
 408   struct rte_mbuf mb;
 409   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 410   vlib_buffer_t buffer;         /* Copy of VLIB buffer; pkt data stored in pre_data. */
 411 } dpdk_rx_trace_t;
 412
 413 void dpdk_device_setup (dpdk_device_t * xd);
 414 void dpdk_device_start (dpdk_device_t * xd);
 415 void dpdk_device_stop (dpdk_device_t * xd);
 416 int dpdk_port_state_callback (dpdk_portid_t port_id,
 417                               enum rte_eth_event_type type,
 418                               void *param, void *ret_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 #define dpdk_log_err(...) \
 438   vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
 439 #define dpdk_log_warn(...) \
 440   vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
 441 #define dpdk_log_notice(...) \
 442   vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
 443 #define dpdk_log_info(...) \
 444   vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
 445
 446 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
 447
 448 #define foreach_dpdk_rss_hf                                                   \
 449   _ (0, ETH_RSS_FRAG_IPV4, "ipv4-frag")                                       \
 450   _ (1, ETH_RSS_NONFRAG_IPV4_TCP, "ipv4-tcp")                                 \
 451   _ (2, ETH_RSS_NONFRAG_IPV4_UDP, "ipv4-udp")                                 \
 452   _ (3, ETH_RSS_NONFRAG_IPV4_SCTP, "ipv4-sctp")                               \
 453   _ (4, ETH_RSS_NONFRAG_IPV4_OTHER, "ipv4-other")                             \
 454   _ (5, ETH_RSS_IPV4, "ipv4")                                                 \
 455   _ (6, ETH_RSS_IPV6_TCP_EX, "ipv6-tcp-ex")                                   \
 456   _ (7, ETH_RSS_IPV6_UDP_EX, "ipv6-udp-ex")                                   \
 457   _ (8, ETH_RSS_FRAG_IPV6, "ipv6-frag")                                       \
 458   _ (9, ETH_RSS_NONFRAG_IPV6_TCP, "ipv6-tcp")                                 \
 459   _ (10, ETH_RSS_NONFRAG_IPV6_UDP, "ipv6-udp")                                \
 460   _ (11, ETH_RSS_NONFRAG_IPV6_SCTP, "ipv6-sctp")                              \
 461   _ (12, ETH_RSS_NONFRAG_IPV6_OTHER, "ipv6-other")                            \
 462   _ (13, ETH_RSS_IPV6_EX, "ipv6-ex")                                          \
 463   _ (14, ETH_RSS_IPV6, "ipv6")                                                \
 464   _ (15, ETH_RSS_L2_PAYLOAD, "l2-payload")                                    \
 465   _ (16, ETH_RSS_PORT, "port")                                                \
 466   _ (17, ETH_RSS_VXLAN, "vxlan")                                              \
 467   _ (18, ETH_RSS_GENEVE, "geneve")                                            \
 468   _ (19, ETH_RSS_NVGRE, "nvgre")                                              \
 469   _ (20, ETH_RSS_GTPU, "gtpu")                                                \
 470   _ (21, ETH_RSS_ESP, "esp")                                                  \
 471   _ (60, ETH_RSS_L4_DST_ONLY, "l4-dst-only")                                  \
 472   _ (61, ETH_RSS_L4_SRC_ONLY, "l4-src-only")                                  \
 473   _ (62, ETH_RSS_L3_DST_ONLY, "l3-dst-only")                                  \
 474   _ (63, ETH_RSS_L3_SRC_ONLY, "l3-src-only")
 475
 476 format_function_t format_dpdk_device_name;
 477 format_function_t format_dpdk_device;
 478 format_function_t format_dpdk_device_errors;
 479 format_function_t format_dpdk_tx_trace;
 480 format_function_t format_dpdk_rx_trace;
 481 format_function_t format_dpdk_rte_mbuf;
 482 format_function_t format_dpdk_rx_rte_mbuf;
 483 format_function_t format_dpdk_flow;
 484 format_function_t format_dpdk_rss_hf_name;
 485 format_function_t format_dpdk_rx_offload_caps;
 486 format_function_t format_dpdk_tx_offload_caps;
 487 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
 488
 489 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
 490
 491 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
 492                                             *info);
 493 struct rte_vmbus_device *
 494 dpdk_get_vmbus_device (const struct rte_eth_dev_info *info);
 495 void dpdk_cli_reference (void);
 496
 497 #if CLI_DEBUG
 498 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
 499 void dpdk_buffer_poison_trajectory_all (void);
 500 #endif
 501
 502 #endif /* __included_dpdk_h__ */
 503
 504 /*
 505  * fd.io coding-style-patch-verification: ON
 506  *
 507  * Local Variables:
 508  * eval: (c-set-style "gnu")
 509  * End:
 510  */