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