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 typedef uint16_t dpdk_portid_t;
  49
  50 #define foreach_dpdk_device_flags                                             \
  51   _ (0, ADMIN_UP, "admin-up")                                                 \
  52   _ (1, PROMISC, "promisc")                                                   \
  53   _ (3, PMD_INIT_FAIL, "pmd-init-fail")                                       \
  54   _ (4, MAYBE_MULTISEG, "maybe-multiseg")                                     \
  55   _ (5, HAVE_SUBIF, "subif")                                                  \
  56   _ (9, TX_OFFLOAD, "tx-offload")                                             \
  57   _ (10, INTEL_PHDR_CKSUM, "intel-phdr-cksum")                                \
  58   _ (11, RX_FLOW_OFFLOAD, "rx-flow-offload")                                  \
  59   _ (12, RX_IP4_CKSUM, "rx-ip4-cksum")                                        \
  60   _ (13, INT_SUPPORTED, "int-supported")                                      \
  61   _ (14, INT_UNMASKABLE, "int-unmaskable")
  62
  63 typedef enum
  64 {
  65 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
  66   foreach_dpdk_device_flags
  67 #undef _
  68 } dpdk_device_flag_t;
  69
  70 typedef struct
  71 {
  72   u32 flow_index;
  73   u32 mark;
  74   struct rte_flow *handle;
  75 } dpdk_flow_entry_t;
  76
  77 typedef struct
  78 {
  79   u32 flow_id;
  80   u16 next_index;
  81   i16 buffer_advance;
  82 } dpdk_flow_lookup_entry_t;
  83
  84 typedef struct
  85 {
  86   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  87   u8 buffer_pool_index;
  88   u32 queue_index;
  89   int efd;
  90   uword clib_file_index;
  91 } dpdk_rx_queue_t;
  92
  93 typedef struct
  94 {
  95   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  96   clib_spinlock_t lock;
  97 } dpdk_tx_queue_t;
  98
  99 typedef struct
 100 {
 101   const char *name;
 102   const char *desc;
 103 } dpdk_driver_name_t;
 104
 105 typedef struct
 106 {
 107   dpdk_driver_name_t *drivers;
 108   const char *interface_name_prefix;
 109   u16 n_rx_desc;
 110   u16 n_tx_desc;
 111   u32 supported_flow_actions;
 112   i32 enable_lsc_int : 1;
 113   i32 enable_rxq_int : 1;
 114   i32 disable_rx_scatter : 1;
 115   i32 program_vlans : 1;
 116   i32 mq_mode_none : 1;
 117   i32 interface_number_from_port_id : 1;
 118   i32 use_intel_phdr_cksum : 1;
 119   i32 int_unmaskable : 1;
 120 } dpdk_driver_t;
 121
 122 dpdk_driver_t *dpdk_driver_find (const char *name, const char **desc);
 123
 124 typedef union
 125 {
 126   struct
 127   {
 128     u16 disable_multi_seg : 1;
 129     u16 enable_lro : 1;
 130     u16 enable_tso : 1;
 131     u16 enable_tcp_udp_checksum : 1;
 132     u16 enable_outer_checksum_offload : 1;
 133     u16 enable_lsc_int : 1;
 134     u16 enable_rxq_int : 1;
 135     u16 disable_tx_checksum_offload : 1;
 136     u16 disable_rss : 1;
 137     u16 disable_rx_scatter : 1;
 138     u16 n_rx_queues;
 139     u16 n_tx_queues;
 140     u16 n_rx_desc;
 141     u16 n_tx_desc;
 142     u32 max_lro_pkt_size;
 143     u64 rss_hf;
 144   };
 145   u64 as_u64[3];
 146 } dpdk_port_conf_t;
 147
 148 STATIC_ASSERT_SIZEOF (dpdk_port_conf_t, 24);
 149
 150 typedef struct
 151 {
 152   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 153
 154   dpdk_rx_queue_t *rx_queues;
 155   dpdk_tx_queue_t *tx_queues;
 156
 157   /* Instance ID to access internal device array. */
 158   u32 device_index;
 159
 160   u32 hw_if_index;
 161   u32 sw_if_index;
 162   u32 buffer_flags;
 163
 164   /* next node index if we decide to steal the rx graph arc */
 165   u32 per_interface_next_index;
 166
 167   u16 flags;
 168
 169   /* DPDK device port number */
 170   dpdk_portid_t port_id;
 171   i8 cpu_socket;
 172
 173   CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 174
 175   u64 enabled_tx_off;
 176   u64 enabled_rx_off;
 177   dpdk_driver_t *driver;
 178   u8 *name;
 179   const char *if_desc;
 180
 181   /* number of sub-interfaces */
 182   u16 num_subifs;
 183
 184   /* flow related */
 185   u32 supported_flow_actions;
 186   dpdk_flow_entry_t *flow_entries;      /* pool */
 187   dpdk_flow_lookup_entry_t *flow_lookup_entries;        /* pool */
 188   u32 *parked_lookup_indexes;   /* vector */
 189   u32 parked_loop_count;
 190   struct rte_flow_error last_flow_error;
 191
 192   struct rte_eth_link link;
 193   f64 time_last_link_update;
 194
 195   struct rte_eth_stats stats;
 196   struct rte_eth_stats last_stats;
 197   struct rte_eth_xstat *xstats;
 198   f64 time_last_stats_update;
 199
 200   /* mac address */
 201   u8 *default_mac_address;
 202
 203   /* maximum supported max frame size */
 204   u16 max_supported_frame_size;
 205
 206   /* due to lack of API to get ethernet max_frame_size we store information
 207    * deducted from device info */
 208   u8 driver_frame_overhead;
 209
 210   /* error string */
 211   clib_error_t *errors;
 212   dpdk_port_conf_t conf;
 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 #define foreach_dpdk_device_config_item                                       \
 222   _ (num_rx_queues)                                                           \
 223   _ (num_tx_queues)                                                           \
 224   _ (num_rx_desc)                                                             \
 225   _ (num_tx_desc)                                                             \
 226   _ (max_lro_pkt_size)                                                        \
 227   _ (rss_fn)
 228
 229 typedef enum
 230 {
 231   VNET_DEV_ADDR_PCI,
 232   VNET_DEV_ADDR_VMBUS,
 233   VNET_DEV_ADDR_ANY,
 234 } dpdk_device_addr_type_t;
 235
 236 typedef struct
 237 {
 238   union
 239   {
 240     vlib_pci_addr_t pci_addr;
 241     vlib_vmbus_addr_t vmbus_addr;
 242   };
 243   dpdk_device_addr_type_t dev_addr_type;
 244   u8 *name;
 245   u8 is_blacklisted;
 246
 247 #define _(x) uword x;
 248     foreach_dpdk_device_config_item
 249 #undef _
 250     clib_bitmap_t * workers;
 251   u8 tso;
 252   u8 *devargs;
 253   clib_bitmap_t *rss_queues;
 254
 255 #define DPDK_DEVICE_TSO_DEFAULT 0
 256 #define DPDK_DEVICE_TSO_OFF 1
 257 #define DPDK_DEVICE_TSO_ON  2
 258 } dpdk_device_config_t;
 259
 260 typedef struct
 261 {
 262
 263   /* Config stuff */
 264   u8 **eal_init_args;
 265   u8 *eal_init_args_str;
 266   u8 *uio_driver_name;
 267   u8 enable_telemetry;
 268   u16 max_simd_bitwidth;
 269
 270 #define DPDK_MAX_SIMD_BITWIDTH_DEFAULT 0
 271 #define DPDK_MAX_SIMD_BITWIDTH_256     256
 272 #define DPDK_MAX_SIMD_BITWIDTH_512     512
 273
 274   /*
 275    * format interface names ala xxxEthernet%d/%d/%d instead of
 276    * xxxEthernet%x/%x/%x.
 277    */
 278   u8 interface_name_format_decimal;
 279
 280   /* per-device config */
 281   dpdk_device_config_t default_devconf;
 282   dpdk_device_config_t *dev_confs;
 283   uword *device_config_index_by_pci_addr;
 284   mhash_t device_config_index_by_vmbus_addr;
 285
 286   /* devices blacklist by pci vendor_id, device_id */
 287   u32 *blacklist_by_pci_vendor_and_device;
 288   /* devices blacklist by VMBUS address */
 289   vlib_vmbus_addr_t *blacklist_by_vmbus_addr;
 290
 291 } dpdk_config_main_t;
 292
 293 extern dpdk_config_main_t dpdk_config_main;
 294
 295 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
 296
 297 typedef struct
 298 {
 299   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 300   struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
 301   u32 buffers[DPDK_RX_BURST_SZ];
 302   u16 next[DPDK_RX_BURST_SZ];
 303   u16 etype[DPDK_RX_BURST_SZ];
 304   u32 flags[DPDK_RX_BURST_SZ];
 305   vlib_buffer_t buffer_template;
 306 } dpdk_per_thread_data_t;
 307
 308 typedef struct
 309 {
 310   /* Devices */
 311   dpdk_device_t *devices;
 312   dpdk_per_thread_data_t *per_thread_data;
 313
 314   /*
 315    * flag indicating that a posted admin up/down
 316    * (via post_sw_interface_set_flags) is in progress
 317    */
 318   u8 admin_up_down_in_progress;
 319
 320   /* control interval of dpdk link state and stat polling */
 321   f64 link_state_poll_interval;
 322   f64 stat_poll_interval;
 323
 324   dpdk_config_main_t *conf;
 325   dpdk_port_conf_t default_port_conf;
 326
 327   /* API message ID base */
 328   u16 msg_id_base;
 329
 330   /* logging */
 331   vlib_log_class_t log_default;
 332   vlib_log_class_t log_cryptodev;
 333 } dpdk_main_t;
 334
 335 extern dpdk_main_t dpdk_main;
 336
 337 typedef struct
 338 {
 339   u32 buffer_index;
 340   u16 device_index;
 341   u8 queue_index;
 342   struct rte_mbuf mb;
 343   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 344   /* Copy of VLIB buffer; packet data stored in pre_data. */
 345   vlib_buffer_t buffer;
 346 } dpdk_tx_trace_t;
 347
 348 typedef struct
 349 {
 350   u32 buffer_index;
 351   u16 device_index;
 352   u16 queue_index;
 353   struct rte_mbuf mb;
 354   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 355   vlib_buffer_t buffer;         /* Copy of VLIB buffer; pkt data stored in pre_data. */
 356 } dpdk_rx_trace_t;
 357
 358 void dpdk_device_setup (dpdk_device_t * xd);
 359 void dpdk_device_start (dpdk_device_t * xd);
 360 void dpdk_device_stop (dpdk_device_t * xd);
 361 int dpdk_port_state_callback (dpdk_portid_t port_id,
 362                               enum rte_eth_event_type type,
 363                               void *param, void *ret_param);
 364
 365 #define foreach_dpdk_error                                              \
 366   _(NONE, "no error")                                                   \
 367   _(RX_PACKET_ERROR, "Rx packet errors")                                \
 368   _(RX_BAD_FCS, "Rx bad fcs")                                           \
 369   _(IP_CHECKSUM_ERROR, "Rx ip checksum errors")                         \
 370   _(RX_ALLOC_FAIL, "rx buf alloc from free list failed")                \
 371   _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem")              \
 372   _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
 373
 374 typedef enum
 375 {
 376 #define _(f,s) DPDK_ERROR_##f,
 377   foreach_dpdk_error
 378 #undef _
 379     DPDK_N_ERROR,
 380 } dpdk_error_t;
 381
 382 #define dpdk_log_err(...) \
 383   vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
 384 #define dpdk_log_warn(...) \
 385   vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
 386 #define dpdk_log_notice(...) \
 387   vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
 388 #define dpdk_log_info(...) \
 389   vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
 390 #define dpdk_log_debug(...)                                                   \
 391   vlib_log (VLIB_LOG_LEVEL_DEBUG, dpdk_main.log_default, __VA_ARGS__)
 392
 393 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
 394
 395 #define foreach_dpdk_rss_hf                                                   \
 396   _ (0, RTE_ETH_RSS_FRAG_IPV4, "ipv4-frag")                                   \
 397   _ (1, RTE_ETH_RSS_NONFRAG_IPV4_TCP, "ipv4-tcp")                             \
 398   _ (2, RTE_ETH_RSS_NONFRAG_IPV4_UDP, "ipv4-udp")                             \
 399   _ (3, RTE_ETH_RSS_NONFRAG_IPV4_SCTP, "ipv4-sctp")                           \
 400   _ (4, RTE_ETH_RSS_NONFRAG_IPV4_OTHER, "ipv4-other")                         \
 401   _ (5, RTE_ETH_RSS_IPV4, "ipv4")                                             \
 402   _ (6, RTE_ETH_RSS_IPV6_TCP_EX, "ipv6-tcp-ex")                               \
 403   _ (7, RTE_ETH_RSS_IPV6_UDP_EX, "ipv6-udp-ex")                               \
 404   _ (8, RTE_ETH_RSS_FRAG_IPV6, "ipv6-frag")                                   \
 405   _ (9, RTE_ETH_RSS_NONFRAG_IPV6_TCP, "ipv6-tcp")                             \
 406   _ (10, RTE_ETH_RSS_NONFRAG_IPV6_UDP, "ipv6-udp")                            \
 407   _ (11, RTE_ETH_RSS_NONFRAG_IPV6_SCTP, "ipv6-sctp")                          \
 408   _ (12, RTE_ETH_RSS_NONFRAG_IPV6_OTHER, "ipv6-other")                        \
 409   _ (13, RTE_ETH_RSS_IPV6_EX, "ipv6-ex")                                      \
 410   _ (14, RTE_ETH_RSS_IPV6, "ipv6")                                            \
 411   _ (15, RTE_ETH_RSS_L2_PAYLOAD, "l2-payload")                                \
 412   _ (16, RTE_ETH_RSS_PORT, "port")                                            \
 413   _ (17, RTE_ETH_RSS_VXLAN, "vxlan")                                          \
 414   _ (18, RTE_ETH_RSS_GENEVE, "geneve")                                        \
 415   _ (19, RTE_ETH_RSS_NVGRE, "nvgre")                                          \
 416   _ (20, RTE_ETH_RSS_GTPU, "gtpu")                                            \
 417   _ (21, RTE_ETH_RSS_ESP, "esp")                                              \
 418   _ (60, RTE_ETH_RSS_L4_DST_ONLY, "l4-dst-only")                              \
 419   _ (61, RTE_ETH_RSS_L4_SRC_ONLY, "l4-src-only")                              \
 420   _ (62, RTE_ETH_RSS_L3_DST_ONLY, "l3-dst-only")                              \
 421   _ (63, RTE_ETH_RSS_L3_SRC_ONLY, "l3-src-only")
 422
 423 format_function_t format_dpdk_device_name;
 424 format_function_t format_dpdk_device;
 425 format_function_t format_dpdk_device_errors;
 426 format_function_t format_dpdk_tx_trace;
 427 format_function_t format_dpdk_rx_trace;
 428 format_function_t format_dpdk_rte_mbuf;
 429 format_function_t format_dpdk_rx_rte_mbuf;
 430 format_function_t format_dpdk_flow;
 431 format_function_t format_dpdk_rss_hf_name;
 432 format_function_t format_dpdk_rx_offload_caps;
 433 format_function_t format_dpdk_tx_offload_caps;
 434 format_function_t format_dpdk_burst_fn;
 435 format_function_t format_dpdk_rte_device;
 436 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
 437
 438 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
 439
 440 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
 441                                             *info);
 442 struct rte_vmbus_device *
 443 dpdk_get_vmbus_device (const struct rte_eth_dev_info *info);
 444 void dpdk_cli_reference (void);
 445
 446 #if CLI_DEBUG
 447 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
 448 void dpdk_buffer_poison_trajectory_all (void);
 449 #endif
 450
 451 #endif /* __included_dpdk_h__ */
 452
 453 /*
 454  * fd.io coding-style-patch-verification: ON
 455  *
 456  * Local Variables:
 457  * eval: (c-set-style "gnu")
 458  * End:
 459  */