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 typedef struct
 123 {
 124   /* Required for vec_validate_aligned */
 125   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 126
 127   struct rte_ring *swq;
 128
 129   u64 hqos_field0_slabmask;
 130   u32 hqos_field0_slabpos;
 131   u32 hqos_field0_slabshr;
 132   u64 hqos_field1_slabmask;
 133   u32 hqos_field1_slabpos;
 134   u32 hqos_field1_slabshr;
 135   u64 hqos_field2_slabmask;
 136   u32 hqos_field2_slabpos;
 137   u32 hqos_field2_slabshr;
 138   u32 hqos_tc_table[64];
 139 } dpdk_device_hqos_per_worker_thread_t;
 140
 141 typedef struct
 142 {
 143   /* Required for vec_validate_aligned */
 144   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 145   struct rte_ring **swq;
 146   struct rte_mbuf **pkts_enq;
 147   struct rte_mbuf **pkts_deq;
 148   struct rte_sched_port *hqos;
 149   u32 hqos_burst_enq;
 150   u32 hqos_burst_deq;
 151   u32 pkts_enq_len;
 152   u32 swq_pos;
 153   u32 flush_count;
 154 } dpdk_device_hqos_per_hqos_thread_t;
 155
 156 #define foreach_dpdk_device_flags \
 157   _( 0, ADMIN_UP, "admin-up") \
 158   _( 1, PROMISC, "promisc") \
 159   _( 2, PMD, "pmd") \
 160   _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
 161   _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
 162   _( 5, HAVE_SUBIF, "subif") \
 163   _( 6, HQOS, "hqos") \
 164   _( 9, TX_OFFLOAD, "tx-offload") \
 165   _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
 166   _(11, RX_FLOW_OFFLOAD, "rx-flow-offload") \
 167   _(12, RX_IP4_CKSUM, "rx-ip4-cksum")
 168
 169 enum
 170 {
 171 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
 172   foreach_dpdk_device_flags
 173 #undef _
 174 };
 175
 176 typedef struct
 177 {
 178   u32 flow_index;
 179   u32 mark;
 180   struct rte_flow *handle;
 181 } dpdk_flow_entry_t;
 182
 183 typedef struct
 184 {
 185   u32 flow_id;
 186   u16 next_index;
 187   i16 buffer_advance;
 188 } dpdk_flow_lookup_entry_t;
 189
 190 typedef struct
 191 {
 192   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 193   volatile u32 **lockp;
 194
 195   /* Instance ID to access internal device array. */
 196   dpdk_portid_t device_index;
 197
 198   /* DPDK device port number */
 199   dpdk_portid_t port_id;
 200
 201   u32 hw_if_index;
 202   u32 sw_if_index;
 203
 204   /* next node index if we decide to steal the rx graph arc */
 205   u32 per_interface_next_index;
 206
 207   dpdk_pmd_t pmd:8;
 208   i8 cpu_socket;
 209
 210   u16 flags;
 211
 212   u16 nb_tx_desc;
 213     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 214
 215   u8 *name;
 216   u8 *interface_name_suffix;
 217
 218   /* number of sub-interfaces */
 219   u16 num_subifs;
 220
 221   /* PMD related */
 222   u16 tx_q_used;
 223   u16 rx_q_used;
 224   u16 nb_rx_desc;
 225   u16 *cpu_socket_id_by_queue;
 226   u8 *buffer_pool_for_queue;
 227   struct rte_eth_conf port_conf;
 228   struct rte_eth_txconf tx_conf;
 229
 230   /* flow related */
 231   u32 supported_flow_actions;
 232   dpdk_flow_entry_t *flow_entries;      /* pool */
 233   dpdk_flow_lookup_entry_t *flow_lookup_entries;        /* pool */
 234   u32 *parked_lookup_indexes;   /* vector */
 235   u32 parked_loop_count;
 236   struct rte_flow_error last_flow_error;
 237
 238   /* HQoS related */
 239   dpdk_device_hqos_per_worker_thread_t *hqos_wt;
 240   dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
 241
 242   /* af_packet instance number */
 243   u16 af_packet_instance_num;
 244
 245   struct rte_eth_link link;
 246   f64 time_last_link_update;
 247
 248   struct rte_eth_stats stats;
 249   struct rte_eth_stats last_stats;
 250   struct rte_eth_xstat *xstats;
 251   f64 time_last_stats_update;
 252   dpdk_port_type_t port_type;
 253
 254   /* mac address */
 255   u8 *default_mac_address;
 256
 257   /* error string */
 258   clib_error_t *errors;
 259 } dpdk_device_t;
 260
 261 #define DPDK_STATS_POLL_INTERVAL      (10.0)
 262 #define DPDK_MIN_STATS_POLL_INTERVAL  (0.001)   /* 1msec */
 263
 264 #define DPDK_LINK_POLL_INTERVAL       (3.0)
 265 #define DPDK_MIN_LINK_POLL_INTERVAL   (0.001)   /* 1msec */
 266
 267 typedef struct
 268 {
 269   u32 device;
 270   u16 queue_id;
 271 } dpdk_device_and_queue_t;
 272
 273 #ifndef DPDK_HQOS_DBG_BYPASS
 274 #define DPDK_HQOS_DBG_BYPASS 0
 275 #endif
 276
 277 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
 278 #define HQOS_FLUSH_COUNT_THRESHOLD              100000
 279 #endif
 280
 281 typedef struct dpdk_device_config_hqos_t
 282 {
 283   u32 hqos_thread;
 284   u32 hqos_thread_valid;
 285
 286   u32 swq_size;
 287   u32 burst_enq;
 288   u32 burst_deq;
 289
 290   u32 pktfield0_slabpos;
 291   u32 pktfield1_slabpos;
 292   u32 pktfield2_slabpos;
 293   u64 pktfield0_slabmask;
 294   u64 pktfield1_slabmask;
 295   u64 pktfield2_slabmask;
 296   u32 tc_table[64];
 297
 298   struct rte_sched_port_params port;
 299   struct rte_sched_subport_params *subport;
 300   struct rte_sched_pipe_params *pipe;
 301   uint32_t *pipe_map;
 302 } dpdk_device_config_hqos_t;
 303
 304 int dpdk_hqos_validate_mask (u64 mask, u32 n);
 305 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
 306                                                    hqos, u32 pipe_profile_id);
 307 #if 0
 308 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
 309 #endif
 310 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
 311                                     dpdk_device_config_hqos_t * hqos);
 312 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
 313                              struct rte_mbuf **pkts, u32 n_pkts);
 314
 315 #define foreach_dpdk_device_config_item \
 316   _ (num_rx_queues) \
 317   _ (num_tx_queues) \
 318   _ (num_rx_desc) \
 319   _ (num_tx_desc) \
 320   _ (rss_fn)
 321
 322 typedef struct
 323 {
 324   vlib_pci_addr_t pci_addr;
 325   u8 *name;
 326   u8 is_blacklisted;
 327   u8 vlan_strip_offload;
 328 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
 329 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
 330 #define DPDK_DEVICE_VLAN_STRIP_ON  2
 331
 332 #define _(x) uword x;
 333     foreach_dpdk_device_config_item
 334 #undef _
 335     clib_bitmap_t * workers;
 336   u32 hqos_enabled;
 337   dpdk_device_config_hqos_t hqos;
 338   u8 tso;
 339   u8 *devargs;
 340
 341 #define DPDK_DEVICE_TSO_DEFAULT 0
 342 #define DPDK_DEVICE_TSO_OFF 1
 343 #define DPDK_DEVICE_TSO_ON  2
 344 } dpdk_device_config_t;
 345
 346 typedef struct
 347 {
 348
 349   /* Config stuff */
 350   u8 **eal_init_args;
 351   u8 *eal_init_args_str;
 352   u8 *uio_driver_name;
 353   u8 no_multi_seg;
 354   u8 enable_tcp_udp_checksum;
 355   u8 no_tx_checksum_offload;
 356
 357   /* Required config parameters */
 358   u8 coremask_set_manually;
 359   u8 nchannels_set_manually;
 360   u32 coremask;
 361   u32 nchannels;
 362   u32 num_crypto_mbufs;
 363
 364   /*
 365    * format interface names ala xxxEthernet%d/%d/%d instead of
 366    * xxxEthernet%x/%x/%x.
 367    */
 368   u8 interface_name_format_decimal;
 369
 370   /* per-device config */
 371   dpdk_device_config_t default_devconf;
 372   dpdk_device_config_t *dev_confs;
 373   uword *device_config_index_by_pci_addr;
 374
 375   /* devices blacklist by pci vendor_id, device_id */
 376   u32 *blacklist_by_pci_vendor_and_device;
 377
 378 } dpdk_config_main_t;
 379
 380 extern dpdk_config_main_t dpdk_config_main;
 381
 382 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
 383
 384 typedef struct
 385 {
 386   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 387   struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
 388   u32 buffers[DPDK_RX_BURST_SZ];
 389   u16 next[DPDK_RX_BURST_SZ];
 390   u16 etype[DPDK_RX_BURST_SZ];
 391   u16 flags[DPDK_RX_BURST_SZ];
 392   vlib_buffer_t buffer_template;
 393 } dpdk_per_thread_data_t;
 394
 395 typedef struct
 396 {
 397
 398   /* Devices */
 399   dpdk_device_t *devices;
 400   dpdk_device_and_queue_t **devices_by_hqos_cpu;
 401   dpdk_per_thread_data_t *per_thread_data;
 402
 403   /* buffer flags template, configurable to enable/disable tcp / udp cksum */
 404   u32 buffer_flags_template;
 405
 406   /*
 407    * flag indicating that a posted admin up/down
 408    * (via post_sw_interface_set_flags) is in progress
 409    */
 410   u8 admin_up_down_in_progress;
 411
 412   /* which cpus are running I/O TX */
 413   int hqos_cpu_first_index;
 414   int hqos_cpu_count;
 415
 416   /* control interval of dpdk link state and stat polling */
 417   f64 link_state_poll_interval;
 418   f64 stat_poll_interval;
 419
 420   /* convenience */
 421   vlib_main_t *vlib_main;
 422   vnet_main_t *vnet_main;
 423   dpdk_config_main_t *conf;
 424
 425   /* API message ID base */
 426   u16 msg_id_base;
 427
 428   /* logging */
 429   vlib_log_class_t log_default;
 430 } dpdk_main_t;
 431
 432 extern dpdk_main_t dpdk_main;
 433
 434 typedef struct
 435 {
 436   u32 buffer_index;
 437   u16 device_index;
 438   u8 queue_index;
 439   struct rte_mbuf mb;
 440   /* Copy of VLIB buffer; packet data stored in pre_data. */
 441   vlib_buffer_t buffer;
 442   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 443 } dpdk_tx_trace_t;
 444
 445 typedef struct
 446 {
 447   u32 buffer_index;
 448   u16 device_index;
 449   u16 queue_index;
 450   struct rte_mbuf mb;
 451   vlib_buffer_t buffer;         /* Copy of VLIB buffer; pkt data stored in pre_data. */
 452   u8 data[256];                 /* First 256 data bytes, used for hexdump */
 453 } dpdk_rx_trace_t;
 454
 455 void dpdk_device_setup (dpdk_device_t * xd);
 456 void dpdk_device_start (dpdk_device_t * xd);
 457 void dpdk_device_stop (dpdk_device_t * xd);
 458
 459 int dpdk_port_state_callback (dpdk_portid_t port_id,
 460                               enum rte_eth_event_type type,
 461                               void *param, void *ret_param);
 462
 463 #define foreach_dpdk_error                                              \
 464   _(NONE, "no error")                                                   \
 465   _(RX_PACKET_ERROR, "Rx packet errors")                                \
 466   _(RX_BAD_FCS, "Rx bad fcs")                                           \
 467   _(IP_CHECKSUM_ERROR, "Rx ip checksum errors")                         \
 468   _(RX_ALLOC_FAIL, "rx buf alloc from free list failed")                \
 469   _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem")              \
 470   _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
 471
 472 typedef enum
 473 {
 474 #define _(f,s) DPDK_ERROR_##f,
 475   foreach_dpdk_error
 476 #undef _
 477     DPDK_N_ERROR,
 478 } dpdk_error_t;
 479
 480 #define dpdk_log_err(...) \
 481   vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
 482 #define dpdk_log_warn(...) \
 483   vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
 484 #define dpdk_log_notice(...) \
 485   vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
 486 #define dpdk_log_info(...) \
 487   vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
 488
 489 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
 490
 491 format_function_t format_dpdk_device_name;
 492 format_function_t format_dpdk_device;
 493 format_function_t format_dpdk_device_errors;
 494 format_function_t format_dpdk_tx_trace;
 495 format_function_t format_dpdk_rx_trace;
 496 format_function_t format_dpdk_rte_mbuf;
 497 format_function_t format_dpdk_rx_rte_mbuf;
 498 format_function_t format_dpdk_flow;
 499 format_function_t format_dpdk_rss_hf_name;
 500 format_function_t format_dpdk_rx_offload_caps;
 501 format_function_t format_dpdk_tx_offload_caps;
 502 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
 503
 504 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
 505 clib_error_t *unformat_hqos (unformat_input_t * input,
 506                              dpdk_device_config_hqos_t * hqos);
 507
 508 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
 509                                             *info);
 510 void dpdk_cli_reference (void);
 511
 512 #if CLI_DEBUG
 513 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
 514 void dpdk_buffer_poison_trajectory_all (void);
 515 #endif
 516
 517 #endif /* __included_dpdk_h__ */
 518
 519 /*
 520  * fd.io coding-style-patch-verification: ON
 521  *
 522  * Local Variables:
 523  * eval: (c-set-style "gnu")
 524  * End:
 525  */