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 no_multi_seg : 1;
 177     u16 enable_lro : 1;
 178     u16 enable_tcp_udp_checksum : 1;
 179     u16 enable_outer_checksum_offload : 1;
 180     u16 no_tx_checksum_offload : 1;
 181     u16 n_rx_queues;
 182     u16 n_tx_queues;
 183     u16 n_rx_desc;
 184     u16 n_tx_desc;
 185   };
 186   u64 as_u64[3];
 187 } dpdk_port_conf_t;
 188
 189 STATIC_ASSERT_SIZEOF (dpdk_port_conf_t, 24);
 190
 191 typedef struct
 192 {
 193   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 194
 195   dpdk_rx_queue_t *rx_queues;
 196   dpdk_tx_queue_t *tx_queues;
 197
 198   /* Instance ID to access internal device array. */
 199   u32 device_index;
 200
 201   u32 hw_if_index;
 202   u32 sw_if_index;
 203   u32 buffer_flags;
 204
 205   /* next node index if we decide to steal the rx graph arc */
 206   u32 per_interface_next_index;
 207
 208   u16 flags;
 209
 210   /* DPDK device port number */
 211   dpdk_portid_t port_id;
 212   dpdk_pmd_t pmd:8;
 213   i8 cpu_socket;
 214
 215     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 216
 217   u8 *name;
 218   u8 *interface_name_suffix;
 219
 220   /* number of sub-interfaces */
 221   u16 num_subifs;
 222
 223   /* PMD related */
 224   struct rte_eth_conf port_conf;
 225
 226   /* flow related */
 227   u32 supported_flow_actions;
 228   dpdk_flow_entry_t *flow_entries;      /* pool */
 229   dpdk_flow_lookup_entry_t *flow_lookup_entries;        /* pool */
 230   u32 *parked_lookup_indexes;   /* vector */
 231   u32 parked_loop_count;
 232   struct rte_flow_error last_flow_error;
 233
 234   struct rte_eth_link link;
 235   f64 time_last_link_update;
 236
 237   struct rte_eth_stats stats;
 238   struct rte_eth_stats last_stats;
 239   struct rte_eth_xstat *xstats;
 240   f64 time_last_stats_update;
 241   dpdk_port_type_t port_type;
 242
 243   /* mac address */
 244   u8 *default_mac_address;
 245
 246   /* error string */
 247   clib_error_t *errors;
 248   dpdk_port_conf_t conf;
 249 } dpdk_device_t;
 250
 251 #define DPDK_STATS_POLL_INTERVAL      (10.0)
 252 #define DPDK_MIN_STATS_POLL_INTERVAL  (0.001)   /* 1msec */
 253
 254 #define DPDK_LINK_POLL_INTERVAL       (3.0)
 255 #define DPDK_MIN_LINK_POLL_INTERVAL   (0.001)   /* 1msec */
 256
 257 #define foreach_dpdk_device_config_item                                       \
 258   _ (num_rx_queues)                                                           \
 259   _ (num_tx_queues)                                                           \
 260   _ (num_rx_desc)                                                             \
 261   _ (num_tx_desc)                                                             \
 262   _ (max_lro_pkt_size)                                                        \
 263   _ (rss_fn)
 264
 265 typedef enum
 266 {
 267   VNET_DEV_ADDR_PCI,
 268   VNET_DEV_ADDR_VMBUS,
 269   VNET_DEV_ADDR_ANY,
 270 } dpdk_device_addr_type_t;
 271
 272 typedef struct
 273 {
 274   union
 275   {
 276     vlib_pci_addr_t pci_addr;
 277     vlib_vmbus_addr_t vmbus_addr;
 278   };
 279   dpdk_device_addr_type_t dev_addr_type;
 280   u8 *name;
 281   u8 is_blacklisted;
 282
 283 #define _(x) uword x;
 284     foreach_dpdk_device_config_item
 285 #undef _
 286     clib_bitmap_t * workers;
 287   u8 tso;
 288   u8 *devargs;
 289   clib_bitmap_t *rss_queues;
 290
 291 #define DPDK_DEVICE_TSO_DEFAULT 0
 292 #define DPDK_DEVICE_TSO_OFF 1
 293 #define DPDK_DEVICE_TSO_ON  2
 294 } dpdk_device_config_t;
 295
 296 typedef struct
 297 {
 298
 299   /* Config stuff */
 300   u8 **eal_init_args;
 301   u8 *eal_init_args_str;
 302   u8 *uio_driver_name;
 303   u8 enable_telemetry;
 304   u16 max_simd_bitwidth;
 305
 306 #define DPDK_MAX_SIMD_BITWIDTH_DEFAULT 0
 307 #define DPDK_MAX_SIMD_BITWIDTH_256     256
 308 #define DPDK_MAX_SIMD_BITWIDTH_512     512
 309
 310   /*
 311    * format interface names ala xxxEthernet%d/%d/%d instead of
 312    * xxxEthernet%x/%x/%x.
 313    */
 314   u8 interface_name_format_decimal;
 315
 316   /* per-device config */
 317   dpdk_device_config_t default_devconf;
 318   dpdk_device_config_t *dev_confs;
 319   uword *device_config_index_by_pci_addr;
 320   mhash_t device_config_index_by_vmbus_addr;
 321
 322   /* devices blacklist by pci vendor_id, device_id */
 323   u32 *blacklist_by_pci_vendor_and_device;
 324   /* devices blacklist by VMBUS address */
 325   vlib_vmbus_addr_t *blacklist_by_vmbus_addr;
 326
 327 } dpdk_config_main_t;
 328
 329 extern dpdk_config_main_t dpdk_config_main;
 330
 331 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
 332
 333 typedef struct
 334 {
 335   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 336   struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
 337   u32 buffers[DPDK_RX_BURST_SZ];
 338   u16 next[DPDK_RX_BURST_SZ];
 339   u16 etype[DPDK_RX_BURST_SZ];
 340   u32 flags[DPDK_RX_BURST_SZ];
 341   vlib_buffer_t buffer_template;
 342 } dpdk_per_thread_data_t;
 343
 344 typedef struct
 345 {
 346   /* Devices */
 347   dpdk_device_t *devices;
 348   dpdk_per_thread_data_t *per_thread_data;
 349
 350   /*
 351    * flag indicating that a posted admin up/down
 352    * (via post_sw_interface_set_flags) is in progress
 353    */
 354   u8 admin_up_down_in_progress;
 355
 356   /* control interval of dpdk link state and stat polling */
 357   f64 link_state_poll_interval;
 358   f64 stat_poll_interval;
 359
 360   dpdk_config_main_t *conf;
 361   dpdk_port_conf_t default_port_conf;
 362
 363   /* API message ID base */
 364   u16 msg_id_base;
 365
 366   /* logging */
 367   vlib_log_class_t log_default;
 368   vlib_log_class_t log_cryptodev;
 369 } dpdk_main_t;
 370
 371 extern dpdk_main_t dpdk_main;
 372
 373 typedef struct
 374 {
 375   u32 buffer_index;
 376   u16 device_index;
 377   u8 queue_index;
 378   struct rte_mbuf mb;
 379   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 380   /* Copy of VLIB buffer; packet data stored in pre_data. */
 381   vlib_buffer_t buffer;
 382 } dpdk_tx_trace_t;
 383
 384 typedef struct
 385 {
 386   u32 buffer_index;
 387   u16 device_index;
 388   u16 queue_index;
 389   struct rte_mbuf mb;
 390   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 391   vlib_buffer_t buffer;         /* Copy of VLIB buffer; pkt data stored in pre_data. */
 392 } dpdk_rx_trace_t;
 393
 394 void dpdk_device_setup (dpdk_device_t * xd);
 395 void dpdk_device_start (dpdk_device_t * xd);
 396 void dpdk_device_stop (dpdk_device_t * xd);
 397 int dpdk_port_state_callback (dpdk_portid_t port_id,
 398                               enum rte_eth_event_type type,
 399                               void *param, void *ret_param);
 400
 401 #define foreach_dpdk_error                                              \
 402   _(NONE, "no error")                                                   \
 403   _(RX_PACKET_ERROR, "Rx packet errors")                                \
 404   _(RX_BAD_FCS, "Rx bad fcs")                                           \
 405   _(IP_CHECKSUM_ERROR, "Rx ip checksum errors")                         \
 406   _(RX_ALLOC_FAIL, "rx buf alloc from free list failed")                \
 407   _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem")              \
 408   _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
 409
 410 typedef enum
 411 {
 412 #define _(f,s) DPDK_ERROR_##f,
 413   foreach_dpdk_error
 414 #undef _
 415     DPDK_N_ERROR,
 416 } dpdk_error_t;
 417
 418 #define dpdk_log_err(...) \
 419   vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
 420 #define dpdk_log_warn(...) \
 421   vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
 422 #define dpdk_log_notice(...) \
 423   vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
 424 #define dpdk_log_info(...) \
 425   vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
 426 #define dpdk_log_debug(...)                                                   \
 427   vlib_log (VLIB_LOG_LEVEL_DEBUG, dpdk_main.log_default, __VA_ARGS__)
 428
 429 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
 430
 431 #define foreach_dpdk_rss_hf                                                   \
 432   _ (0, ETH_RSS_FRAG_IPV4, "ipv4-frag")                                       \
 433   _ (1, ETH_RSS_NONFRAG_IPV4_TCP, "ipv4-tcp")                                 \
 434   _ (2, ETH_RSS_NONFRAG_IPV4_UDP, "ipv4-udp")                                 \
 435   _ (3, ETH_RSS_NONFRAG_IPV4_SCTP, "ipv4-sctp")                               \
 436   _ (4, ETH_RSS_NONFRAG_IPV4_OTHER, "ipv4-other")                             \
 437   _ (5, ETH_RSS_IPV4, "ipv4")                                                 \
 438   _ (6, ETH_RSS_IPV6_TCP_EX, "ipv6-tcp-ex")                                   \
 439   _ (7, ETH_RSS_IPV6_UDP_EX, "ipv6-udp-ex")                                   \
 440   _ (8, ETH_RSS_FRAG_IPV6, "ipv6-frag")                                       \
 441   _ (9, ETH_RSS_NONFRAG_IPV6_TCP, "ipv6-tcp")                                 \
 442   _ (10, ETH_RSS_NONFRAG_IPV6_UDP, "ipv6-udp")                                \
 443   _ (11, ETH_RSS_NONFRAG_IPV6_SCTP, "ipv6-sctp")                              \
 444   _ (12, ETH_RSS_NONFRAG_IPV6_OTHER, "ipv6-other")                            \
 445   _ (13, ETH_RSS_IPV6_EX, "ipv6-ex")                                          \
 446   _ (14, ETH_RSS_IPV6, "ipv6")                                                \
 447   _ (15, ETH_RSS_L2_PAYLOAD, "l2-payload")                                    \
 448   _ (16, ETH_RSS_PORT, "port")                                                \
 449   _ (17, ETH_RSS_VXLAN, "vxlan")                                              \
 450   _ (18, ETH_RSS_GENEVE, "geneve")                                            \
 451   _ (19, ETH_RSS_NVGRE, "nvgre")                                              \
 452   _ (20, ETH_RSS_GTPU, "gtpu")                                                \
 453   _ (21, ETH_RSS_ESP, "esp")                                                  \
 454   _ (60, ETH_RSS_L4_DST_ONLY, "l4-dst-only")                                  \
 455   _ (61, ETH_RSS_L4_SRC_ONLY, "l4-src-only")                                  \
 456   _ (62, ETH_RSS_L3_DST_ONLY, "l3-dst-only")                                  \
 457   _ (63, ETH_RSS_L3_SRC_ONLY, "l3-src-only")
 458
 459 format_function_t format_dpdk_device_name;
 460 format_function_t format_dpdk_device;
 461 format_function_t format_dpdk_device_errors;
 462 format_function_t format_dpdk_tx_trace;
 463 format_function_t format_dpdk_rx_trace;
 464 format_function_t format_dpdk_rte_mbuf;
 465 format_function_t format_dpdk_rx_rte_mbuf;
 466 format_function_t format_dpdk_flow;
 467 format_function_t format_dpdk_rss_hf_name;
 468 format_function_t format_dpdk_rx_offload_caps;
 469 format_function_t format_dpdk_tx_offload_caps;
 470 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
 471
 472 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
 473
 474 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
 475                                             *info);
 476 struct rte_vmbus_device *
 477 dpdk_get_vmbus_device (const struct rte_eth_dev_info *info);
 478 void dpdk_cli_reference (void);
 479
 480 #if CLI_DEBUG
 481 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
 482 void dpdk_buffer_poison_trajectory_all (void);
 483 #endif
 484
 485 #endif /* __included_dpdk_h__ */
 486
 487 /*
 488  * fd.io coding-style-patch-verification: ON
 489  *
 490  * Local Variables:
 491  * eval: (c-set-style "gnu")
 492  * End:
 493  */