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_ether.h>
  36 #include <rte_ethdev.h>
  37 #include <rte_ring.h>
  38 #include <rte_mempool.h>
  39 #include <rte_mbuf.h>
  40 #include <rte_version.h>
  41 #include <rte_sched.h>
  42 #include <rte_net.h>
  43 #include <rte_bus_pci.h>
  44 #include <rte_flow.h>
  45
  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 extern vnet_device_class_t dpdk_device_class;
  58 extern vlib_node_registration_t dpdk_input_node;
  59 extern vlib_node_registration_t admin_up_down_process_node;
  60
  61 #define foreach_dpdk_pmd          \
  62   _ ("net_thunderx", THUNDERX)    \
  63   _ ("net_e1000_em", E1000EM)     \
  64   _ ("net_e1000_igb", IGB)        \
  65   _ ("net_e1000_igb_vf", IGBVF)   \
  66   _ ("net_ixgbe", IXGBE)          \
  67   _ ("net_ixgbe_vf", IXGBEVF)     \
  68   _ ("net_i40e", I40E)            \
  69   _ ("net_i40e_vf", I40EVF)       \
  70   _ ("net_ice", ICE)              \
  71   _ ("net_virtio", VIRTIO)        \
  72   _ ("net_enic", ENIC)            \
  73   _ ("net_vmxnet3", VMXNET3)      \
  74   _ ("AF_PACKET PMD", AF_PACKET)  \
  75   _ ("net_fm10k", FM10K)          \
  76   _ ("net_cxgbe", CXGBE)          \
  77   _ ("net_mlx4", MLX4)            \
  78   _ ("net_mlx5", MLX5)            \
  79   _ ("net_dpaa2", DPAA2)          \
  80   _ ("net_virtio_user", VIRTIO_USER) \
  81   _ ("net_vhost", VHOST_ETHER)    \
  82   _ ("net_ena", ENA)              \
  83   _ ("net_failsafe", FAILSAFE)    \
  84   _ ("net_liovf", LIOVF_ETHER)    \
  85   _ ("net_qede", QEDE)            \
  86   _ ("net_netvsc", NETVSC)        \
  87   _ ("net_bnxt", BNXT)
  88
  89 typedef enum
  90 {
  91   VNET_DPDK_PMD_NONE,
  92 #define _(s,f) VNET_DPDK_PMD_##f,
  93   foreach_dpdk_pmd
  94 #undef _
  95     VNET_DPDK_PMD_UNKNOWN,      /* must be last */
  96 } dpdk_pmd_t;
  97
  98 typedef enum
  99 {
 100   VNET_DPDK_PORT_TYPE_ETH_1G,
 101   VNET_DPDK_PORT_TYPE_ETH_2_5G,
 102   VNET_DPDK_PORT_TYPE_ETH_5G,
 103   VNET_DPDK_PORT_TYPE_ETH_10G,
 104   VNET_DPDK_PORT_TYPE_ETH_20G,
 105   VNET_DPDK_PORT_TYPE_ETH_25G,
 106   VNET_DPDK_PORT_TYPE_ETH_40G,
 107   VNET_DPDK_PORT_TYPE_ETH_50G,
 108   VNET_DPDK_PORT_TYPE_ETH_56G,
 109   VNET_DPDK_PORT_TYPE_ETH_100G,
 110   VNET_DPDK_PORT_TYPE_ETH_SWITCH,
 111   VNET_DPDK_PORT_TYPE_AF_PACKET,
 112   VNET_DPDK_PORT_TYPE_ETH_VF,
 113   VNET_DPDK_PORT_TYPE_VIRTIO_USER,
 114   VNET_DPDK_PORT_TYPE_VHOST_ETHER,
 115   VNET_DPDK_PORT_TYPE_FAILSAFE,
 116   VNET_DPDK_PORT_TYPE_NETVSC,
 117   VNET_DPDK_PORT_TYPE_UNKNOWN,
 118 } dpdk_port_type_t;
 119
 120 typedef uint16_t dpdk_portid_t;
 121
 122 #define foreach_dpdk_device_flags \
 123   _( 0, ADMIN_UP, "admin-up") \
 124   _( 1, PROMISC, "promisc") \
 125   _( 2, PMD, "pmd") \
 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
 134 enum
 135 {
 136 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
 137   foreach_dpdk_device_flags
 138 #undef _
 139 };
 140
 141 typedef struct
 142 {
 143   u32 flow_index;
 144   u32 mark;
 145   struct rte_flow *handle;
 146 } dpdk_flow_entry_t;
 147
 148 typedef struct
 149 {
 150   u32 flow_id;
 151   u16 next_index;
 152   i16 buffer_advance;
 153 } dpdk_flow_lookup_entry_t;
 154
 155 typedef struct
 156 {
 157   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 158   volatile u32 **lockp;
 159
 160   /* Instance ID to access internal device array. */
 161   dpdk_portid_t device_index;
 162
 163   /* DPDK device port number */
 164   dpdk_portid_t port_id;
 165
 166   u32 hw_if_index;
 167   u32 sw_if_index;
 168
 169   /* next node index if we decide to steal the rx graph arc */
 170   u32 per_interface_next_index;
 171
 172   dpdk_pmd_t pmd:8;
 173   i8 cpu_socket;
 174
 175   u16 flags;
 176
 177   u16 nb_tx_desc;
 178     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 179
 180   u8 *name;
 181   u8 *interface_name_suffix;
 182
 183   /* number of sub-interfaces */
 184   u16 num_subifs;
 185
 186   /* PMD related */
 187   u16 tx_q_used;
 188   u16 rx_q_used;
 189   u16 nb_rx_desc;
 190   u16 *cpu_socket_id_by_queue;
 191   u8 *buffer_pool_for_queue;
 192   struct rte_eth_conf port_conf;
 193   struct rte_eth_txconf tx_conf;
 194
 195   /* flow related */
 196   u32 supported_flow_actions;
 197   dpdk_flow_entry_t *flow_entries;      /* pool */
 198   dpdk_flow_lookup_entry_t *flow_lookup_entries;        /* pool */
 199   u32 *parked_lookup_indexes;   /* vector */
 200   u32 parked_loop_count;
 201   struct rte_flow_error last_flow_error;
 202
 203   /* af_packet instance number */
 204   u16 af_packet_instance_num;
 205
 206   struct rte_eth_link link;
 207   f64 time_last_link_update;
 208
 209   struct rte_eth_stats stats;
 210   struct rte_eth_stats last_stats;
 211   struct rte_eth_xstat *xstats;
 212   f64 time_last_stats_update;
 213   dpdk_port_type_t port_type;
 214
 215   /* mac address */
 216   u8 *default_mac_address;
 217
 218   /* error string */
 219   clib_error_t *errors;
 220 } dpdk_device_t;
 221
 222 #define DPDK_STATS_POLL_INTERVAL      (10.0)
 223 #define DPDK_MIN_STATS_POLL_INTERVAL  (0.001)   /* 1msec */
 224
 225 #define DPDK_LINK_POLL_INTERVAL       (3.0)
 226 #define DPDK_MIN_LINK_POLL_INTERVAL   (0.001)   /* 1msec */
 227
 228 typedef struct
 229 {
 230   u32 device;
 231   u16 queue_id;
 232 } dpdk_device_and_queue_t;
 233
 234 #ifndef DPDK_HQOS_DBG_BYPASS
 235 #define DPDK_HQOS_DBG_BYPASS 0
 236 #endif
 237
 238 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
 239 #define HQOS_FLUSH_COUNT_THRESHOLD              100000
 240 #endif
 241
 242
 243 #define foreach_dpdk_device_config_item \
 244   _ (num_rx_queues) \
 245   _ (num_tx_queues) \
 246   _ (num_rx_desc) \
 247   _ (num_tx_desc) \
 248   _ (rss_fn)
 249
 250 typedef struct
 251 {
 252   vlib_pci_addr_t pci_addr;
 253   u8 *name;
 254   u8 is_blacklisted;
 255   u8 vlan_strip_offload;
 256 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
 257 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
 258 #define DPDK_DEVICE_VLAN_STRIP_ON  2
 259
 260 #define _(x) uword x;
 261     foreach_dpdk_device_config_item
 262 #undef _
 263     clib_bitmap_t * workers;
 264   u8 tso;
 265   u8 *devargs;
 266
 267 #define DPDK_DEVICE_TSO_DEFAULT 0
 268 #define DPDK_DEVICE_TSO_OFF 1
 269 #define DPDK_DEVICE_TSO_ON  2
 270 } dpdk_device_config_t;
 271
 272 typedef struct
 273 {
 274
 275   /* Config stuff */
 276   u8 **eal_init_args;
 277   u8 *eal_init_args_str;
 278   u8 *uio_driver_name;
 279   u8 no_multi_seg;
 280   u8 enable_tcp_udp_checksum;
 281   u8 no_tx_checksum_offload;
 282
 283   /* Required config parameters */
 284   u8 coremask_set_manually;
 285   u8 nchannels_set_manually;
 286   u32 coremask;
 287   u32 nchannels;
 288   u32 num_crypto_mbufs;
 289
 290   /*
 291    * format interface names ala xxxEthernet%d/%d/%d instead of
 292    * xxxEthernet%x/%x/%x.
 293    */
 294   u8 interface_name_format_decimal;
 295
 296   /* per-device config */
 297   dpdk_device_config_t default_devconf;
 298   dpdk_device_config_t *dev_confs;
 299   uword *device_config_index_by_pci_addr;
 300
 301   /* devices blacklist by pci vendor_id, device_id */
 302   u32 *blacklist_by_pci_vendor_and_device;
 303
 304 } dpdk_config_main_t;
 305
 306 extern dpdk_config_main_t dpdk_config_main;
 307
 308 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
 309
 310 typedef struct
 311 {
 312   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 313   struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
 314   u32 buffers[DPDK_RX_BURST_SZ];
 315   u16 next[DPDK_RX_BURST_SZ];
 316   u16 etype[DPDK_RX_BURST_SZ];
 317   u16 flags[DPDK_RX_BURST_SZ];
 318   vlib_buffer_t buffer_template;
 319 } dpdk_per_thread_data_t;
 320
 321 typedef struct
 322 {
 323
 324   /* Devices */
 325   dpdk_device_t *devices;
 326   dpdk_per_thread_data_t *per_thread_data;
 327
 328   /* buffer flags template, configurable to enable/disable tcp / udp cksum */
 329   u32 buffer_flags_template;
 330
 331   /*
 332    * flag indicating that a posted admin up/down
 333    * (via post_sw_interface_set_flags) is in progress
 334    */
 335   u8 admin_up_down_in_progress;
 336
 337   /* control interval of dpdk link state and stat polling */
 338   f64 link_state_poll_interval;
 339   f64 stat_poll_interval;
 340
 341   /* convenience */
 342   vlib_main_t *vlib_main;
 343   vnet_main_t *vnet_main;
 344   dpdk_config_main_t *conf;
 345
 346   /* API message ID base */
 347   u16 msg_id_base;
 348
 349   /* logging */
 350   vlib_log_class_t log_default;
 351 } dpdk_main_t;
 352
 353 extern dpdk_main_t dpdk_main;
 354
 355 typedef struct
 356 {
 357   u32 buffer_index;
 358   u16 device_index;
 359   u8 queue_index;
 360   struct rte_mbuf mb;
 361   /* Copy of VLIB buffer; packet data stored in pre_data. */
 362   vlib_buffer_t buffer;
 363   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 364 } dpdk_tx_trace_t;
 365
 366 typedef struct
 367 {
 368   u32 buffer_index;
 369   u16 device_index;
 370   u16 queue_index;
 371   struct rte_mbuf mb;
 372   vlib_buffer_t buffer;         /* Copy of VLIB buffer; pkt data stored in pre_data. */
 373   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 374 } dpdk_rx_trace_t;
 375
 376 void dpdk_device_setup (dpdk_device_t * xd);
 377 void dpdk_device_start (dpdk_device_t * xd);
 378 void dpdk_device_stop (dpdk_device_t * xd);
 379
 380 int dpdk_port_state_callback (dpdk_portid_t port_id,
 381                               enum rte_eth_event_type type,
 382                               void *param, void *ret_param);
 383
 384 #define foreach_dpdk_error                                              \
 385   _(NONE, "no error")                                                   \
 386   _(RX_PACKET_ERROR, "Rx packet errors")                                \
 387   _(RX_BAD_FCS, "Rx bad fcs")                                           \
 388   _(IP_CHECKSUM_ERROR, "Rx ip checksum errors")                         \
 389   _(RX_ALLOC_FAIL, "rx buf alloc from free list failed")                \
 390   _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem")              \
 391   _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
 392
 393 typedef enum
 394 {
 395 #define _(f,s) DPDK_ERROR_##f,
 396   foreach_dpdk_error
 397 #undef _
 398     DPDK_N_ERROR,
 399 } dpdk_error_t;
 400
 401 #define dpdk_log_err(...) \
 402   vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
 403 #define dpdk_log_warn(...) \
 404   vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
 405 #define dpdk_log_notice(...) \
 406   vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
 407 #define dpdk_log_info(...) \
 408   vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
 409
 410 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
 411
 412 format_function_t format_dpdk_device_name;
 413 format_function_t format_dpdk_device;
 414 format_function_t format_dpdk_device_errors;
 415 format_function_t format_dpdk_tx_trace;
 416 format_function_t format_dpdk_rx_trace;
 417 format_function_t format_dpdk_rte_mbuf;
 418 format_function_t format_dpdk_rx_rte_mbuf;
 419 format_function_t format_dpdk_flow;
 420 format_function_t format_dpdk_rss_hf_name;
 421 format_function_t format_dpdk_rx_offload_caps;
 422 format_function_t format_dpdk_tx_offload_caps;
 423 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
 424
 425 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
 426
 427 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
 428                                             *info);
 429 void dpdk_cli_reference (void);
 430
 431 #if CLI_DEBUG
 432 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
 433 void dpdk_buffer_poison_trajectory_all (void);
 434 #endif
 435
 436 #endif /* __included_dpdk_h__ */
 437
 438 /*
 439  * fd.io coding-style-patch-verification: ON
 440  *
 441  * Local Variables:
 442  * eval: (c-set-style "gnu")
 443  * End:
 444  */