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