doc/guides/rel_notes/release_2_2.rst

   1 DPDK Release 2.2
   2 ================
   3
   4 New Features
   5 ------------
   6
   7 * **Introduce ARMv7 and ARMv8 architectures**
   8
   9   * It is now possible to build DPDK for the ARMv7 and ARMv8 platforms.
  10   * ARMv7 can be tested with virtual PMD drivers.
  11   * ARMv8 can be tested with virtual and physical PMD drivers.
  12
  13 * **Enabled freeing of ring.**
  14
  15   New function rte_ring_free() allows the user to free a ring
  16   if it was created with rte_ring_create().
  17
  18 * **Added keepalive support to EAL and example application.**
  19
  20 * **Added experimental cryptodev API**
  21
  22   The cryptographic processing of packet is provided as a preview
  23   with two drivers for:
  24
  25   * Intel QuickAssist devices
  26   * Intel AES-NI multi-buffer library
  27
  28   Due to its experimental state, the API may change without prior notice.
  29
  30 * **Added ethdev API to support IEEE1588.**
  31
  32   Added functions to read, write and adjust system time in the NIC.
  33
  34 * **Extended Statistics**
  35
  36   Define extended statistics naming scheme to store metadata in the name
  37   string name of each statistic, refer to the Extended Statistics section
  38   of the programmers guide. Implemented the extended stats API for these
  39   PMDs:
  40
  41   * igb
  42   * igbvf
  43   * i40e
  44   * i40evf
  45   * fm10k
  46   * virtio
  47
  48 * **Added API in ethdev to retrieve RX/TX queue information.**
  49
  50   *  Add the ability for the upper layer to query RX/TX queue information.
  51   *  Add into rte_eth_dev_info new fields to represent information about
  52      RX/TX descriptors min/max/align numbers per queue for the device.
  53
  54 * **Added RSS dynamic configuration to bonding.**
  55
  56 * **Updated the e1000 base driver.**
  57
  58   The e1000 base driver was updated with several features including the
  59   following:
  60
  61   * Add new i218 devices
  62   * Allow both ULP and EEE in Sx state
  63   * Initialize 88E1543 (Marvell 1543) PHY
  64   * Add flags to set EEE advertisement modes
  65   * Support inverted format ETrackId
  66   * Add bit to disable packetbuffer read
  67   * Add defaults for i210 Rx/Tx PBSIZE
  68   * Check more errors for ESB2 init and reset
  69   * Check more NVM read errors
  70   * Return code after setting receive address register
  71   * Remove all NAHUM6LP_HW tags
  72
  73 * **Added e1000 Rx interrupt support.**
  74
  75 * **Added igb TSO support for both PF and VF.**
  76
  77 * **RSS enhancement on Intel x550 NIC**
  78
  79   * Support 512 entries RSS redirection table.
  80   * Support per VF RSS redirection table.
  81
  82 * **Flow director enhancement on Intel x550 NIC**
  83
  84   * Add 2 new flow director modes on x550.
  85   * One is MAC VLAN mode, the other is tunnel mode.
  86
  87 * **Updated the i40e base driver.**
  88
  89   The i40e base driver was updated with several changes including the
  90   following:
  91
  92   *  Added promiscuous on VLAN support
  93   *  Added a workaround to drop all flow control frames
  94   *  Added VF capabilities to virtual channel interface
  95   *  Added Tx Scheduling related AQ commands
  96   *  Added additional PCTYPES supported for FortPark RSS
  97   *  Added parsing for CEE DCBX TLVs
  98   *  Added FortPark specific registers
  99   *  Added AQ functions to handle RSS Key and LUT programming
 100   *  Increased pf reset max loop limit
 101
 102 * **Added i40e vector RX/TX.**
 103
 104 * **Added i40e Rx interrupt support.**
 105
 106 * **Added i40e flow control support.**
 107
 108 * **Added DCB support to i40e PF driver.**
 109
 110 * **Added RSS/FD input set granularity on Intel X710/XL710.**
 111
 112 * **Added different GRE key length for input set on Intel X710/XL710.**
 113
 114 * **Added flow director support in i40e VF.**
 115
 116 * **Added fm10k vector RX/TX.**
 117
 118 * **Added fm10k TSO support for both PF and VF.**
 119
 120 * **Added fm10k VMDQ support.**
 121
 122 * **New NIC Boulder Rapid support.**
 123
 124   Boulder Rapid is a new NIC of Intel's fm10k family.
 125
 126 * **Enhanced support for the Chelsio CXGBE driver.**
 127
 128   *  Added support for Jumbo Frames.
 129   *  Optimize forwarding performance for Chelsio T5 40GbE cards.
 130
 131 * **Improved enic Tx packet rate.**
 132
 133   Reduced frequency of Tx tail pointer updates to the NIC.
 134
 135 * **Added support for Mellanox ConnectX-4 adapters (mlx5).**
 136
 137   The mlx5 poll-mode driver implements support for Mellanox ConnectX-4 EN
 138   and Mellanox ConnectX-4 Lx EN families of 10/25/40/50/100 Gb/s adapters.
 139
 140   Like mlx4, this PMD is only available for Linux and is disabled by default
 141   due to external dependencies (libibverbs and libmlx5).
 142
 143 * **Added driver for Netronome nfp-6xxx card.**
 144
 145   Support for using Netronome nfp-6xxx with PCI VFs.
 146
 147 * **Added virtual szedata2 driver for COMBO cards.**
 148
 149   Added virtual PMD for COMBO-100G and COMBO-80G cards.
 150   PMD is disabled in default configuration.
 151
 152 * **Enhanced support for virtio driver.**
 153
 154   * Virtio ring layout optimization (fixed avail ring)
 155   * Vector RX
 156   * Simple TX
 157
 158 * **Added vhost-user multiple queue support.**
 159
 160 * **Added port hotplug support to vmxnet3.**
 161
 162 * **Added port hotplug support to xenvirt.**
 163
 164 * **Added ethtool shim and sample application.**
 165
 166 * **Added experimental performance thread example application.**
 167
 168   The application demonstrates L3 fowarding with different threading
 169   models: pthreads, cgroups, or lighweight threads. The example inludes
 170   a simple cooperative scheduler.
 171
 172   Due to its experimental state this application may change without notice.
 173   The application is supported only for Linux x86_64.
 174
 175
 176 Resolved Issues
 177 ---------------
 178
 179 EAL
 180 ~~~
 181
 182 * **eal/linux: Fixed epoll timeout.**
 183
 184   Fixed issue where the ``rte_epoll_wait()`` function didn't return when the
 185   underlying call to ``epoll_wait()`` timed out.
 186
 187
 188 Drivers
 189 ~~~~~~~
 190
 191 * **e1000/base: Synchronize PHY interface on non-ME systems.**
 192
 193   On power up, the MAC - PHY interface needs to be set to PCIe, even if
 194   cable is disconnected.  In ME systems, the ME handles this on exit from
 195   Sx(Sticky mode) state. In non-ME, the driver handles it. Add a check
 196   for non-ME system to the driver code that handles that.
 197
 198 * **e1000/base: Increase timeout of reset check.**
 199
 200   Previously, in check_reset_block RSPCIPHY was polled for 100 ms before
 201   determining that the ME veto is set. It's not enough. It need to be increased
 202   to 300 ms.
 203
 204 * **e1000/base: Disable IPv6 extension header parsing on 82575.**
 205
 206   Disable IPv6 options as per hardware limitation.
 207
 208 * **e1000/base: Prevent ULP flow if cable connected.**
 209
 210   Enabling ulp on link down when cable is connect caused an infinite
 211   loop of linkup/down indications in the NDIS driver.
 212   After discussed, correct flow is to enable ULP only when cable is
 213   disconnected.
 214
 215 * **e1000/base: Support different EEARBC for i210.**
 216
 217   EEARBC has changed on i210. It means EEARBC has a different address on
 218   i210 than on other NICs. So, add a new entity named EEARBC_I210 to the
 219   register list and make sure the right one is being used on i210.
 220
 221 * **e1000/base: Fix K1 configuration**
 222
 223   This patch is for the following updates to the K1 configurations:
 224   Tx idle period for entering K1 should be 128 ns.
 225   Minimum Tx idle period in K1 should be 256 ns.
 226
 227 * **e1000/base: Fix link detect flow**
 228
 229   In case that auto-negotiate is not enabled, call
 230   e1000_setup_copper_link_generic instead of e1000_phy_setup_autoneg.
 231
 232 * **e1000/base: Fix link check for i354 M88E1112 PHY**
 233
 234   e1000_check_for_link_media_swap() is supposed to check PHY page 0 for
 235   copper and PHY page 1 for "other" (fiber) link. We switched back from
 236   page 1 to page 0 too soon, before e1000_check_for_link_82575() is
 237   executed and we were never finding link on fiber (other).
 238
 239   If the link is copper, as the M88E1112 page address is set to 1, it should be
 240   set back to 0 before checking this link.
 241
 242 * **e1000/base: Fix beacon duration for i217**
 243
 244   Fix for I217 Packet Loss issue - The Management Engine sets the FEXTNVM4
 245   Beacon Duration incorrectly.  This fix ensures that the correct value will
 246   always be set. Correct value for this field is 8 usec.
 247
 248 * **e1000/base: Fix TIPG for non 10 half duplex mode**
 249
 250   TIPG value is increased when setting speed to 10 half to prevent
 251   packet loss. However, it was never decreased again when speed
 252   changes. This caused performance issues in the NDIS driver.
 253   Fix this to restore TIPG to default value on non 10 half.
 254
 255 * **e1000/base: Fix reset of DH89XXCC SGMII**
 256
 257   For DH89XXCC_SGMII, write flush leaves registers of this device trashed
 258   (0xFFFFFFFF). Add check for this device.
 259   Also, after both for Port SW Reset and Device Reset case, platform should
 260   wait at least 3ms before reading any registers. Since waiting is
 261   conditionally executed only for Device Reset - remove the condition.
 262
 263 * **e1000/base: Fix redundant PHY power down for i210**
 264
 265   Bit 11 of PHYREG 0 is used to power down PHY. The use of PHYREG 16 is
 266   unnecessary any more.
 267
 268 * **e1000/base: fix jumbo frame CRC failures**
 269
 270   Change the value of register 776.20[11:2] for jumbo mode from 0x1A to 0x1F.
 271   This is to enlarge the gap between read and write pointers in the TX Fifo.
 272   And replace the magic number with a macro by the way.
 273
 274 * **e1000/base: Fix link flap on 82579**
 275
 276   Several customers have reported a link flap issue on 82579. The symptoms
 277   are random and intermittent link losses when 82579 is connected to specific
 278   switches. Issue has been root caused as interoperability problem between
 279   the NIC and at least some Broadcom PHYs in the Energy Efficient Ethernet
 280   wake mechanism.
 281   To fix the issue, we are disabling the Phase Locked Loop shutdown in 100M
 282   Low Power Idle. This solution will cause an increase of power in 100M EEE
 283   link. It may cost additional 28mW in this specific mode.
 284
 285 * **igb: Fixed IEEE1588 frame identification in I210.**
 286
 287   Fixed issue where the flag PKT_RX_IEEE1588_PTP was not being set
 288   in Intel I210 NIC, as EtherType in RX descriptor is in bits 8:10 of
 289   Packet Type and not in the default bits 0:2.
 290
 291 * **igb: Fixed VF start with PF stopped.**
 292
 293   VF needs the PF interrupt support initialized even if not started.
 294
 295 * **igb: Fixed VF MAC address when using with DPDK PF.**
 296
 297   Assign a random MAC address in VF when not assigned by PF.
 298
 299 * **ixgbe: Fixed issue with X550 DCB.**
 300
 301   Fixed a DCB issue with x550 where for 8 TCs (Traffic Classes), if a packet
 302   with user priority 6 or 7 was injected to the NIC, then the NIC would only
 303   put 3 packets into the queue. There was also a similar issue for 4 TCs.
 304
 305 * **ixgbe: Removed burst size restriction of vector RX.**
 306
 307   Fixed issue where a burst size less than 32 didn't receive anything.
 308
 309 * **ixgbe: Fixed VF start with PF stopped.**
 310
 311   VF needs the PF interrupt support initialized even if not started.
 312
 313 * **ixgbe: Fixed TX hang when RS distance exceeds HW limit.**
 314
 315   Fixed an issue when TX queue can hang when a lot of highly fragmented
 316   packets have to be sent.
 317   As part of that fix, tx_rs_thresh for ixgbe PMD is not allowed to be greater
 318   then to 32 to comply with HW restrictions.
 319
 320 * **i40e: Fixed base driver allocation when not using first numa node.**
 321
 322   Fixed i40e issue that occurred when a DPDK application didn't initialize
 323   ports if memory wasn't available on socket 0.
 324
 325 * **i40e: Fixed maximum of 64 queues per port.**
 326
 327   Fixed the issue in i40e of cannot supporting more than 64 queues per port,
 328   though hardware actually supports that. The real number of queues may vary,
 329   as long as the total number of queues used in PF, VFs, VMDq and FD does not
 330   exceeds the hardware maximum.
 331
 332 * **i40e: Fixed statistics of packets.**
 333
 334   Added discarding packets on VSI to the stats and rectify the old statistics.
 335
 336 * **i40e: Fixed issue of not freeing memzone.**
 337
 338   Fixed the issue of not freeing memzone in the call to free the memory for
 339   adminq DMA.
 340
 341 * **mlx: Fixed driver loading.**
 342
 343   The mlx drivers were unable to load when built as a shared library,
 344   due to a missing symbol in mempool library.
 345
 346 * **vhost: Fixed Qemu shutdown.**
 347
 348   Fixed issue with libvirt ``virsh destroy`` not killing the VM.
 349
 350 * **virtio: Fixed crash after changing link state.**
 351
 352   Fixed io permission in the interrupt handler.
 353
 354 * **virtio: Fixed crash when releasing queue.**
 355
 356   Fixed issue when releasing null control queue.
 357
 358
 359 Libraries
 360 ~~~~~~~~~
 361
 362 * **hash: Fixed memory allocation of Cuckoo Hash key table.**
 363
 364   Fixed issue where an incorrect Cuckoo Hash key table size could be
 365   calculated limiting the size to 4GB.
 366
 367 * **hash: Fixed incorrect lookup if key is all zero.**
 368
 369   Fixed issue in hash library that occurred if an all zero
 370   key was not added in the table and the key was looked up,
 371   resulting in an incorrect hit.
 372
 373 * **hash: Fixed thread scaling by reducing contention.**
 374
 375   Fixed issue in hash library where, using multiple cores with
 376   hardware transactional memory support, thread scaling did not work,
 377   due to the global ring that is shared by all cores.
 378
 379
 380 Examples
 381 ~~~~~~~~
 382
 383 * **l3fwd: Fixed crash with IPv6.**
 384
 385 * **vhost_xen: Fixed compile error.**
 386
 387
 388 Other
 389 ~~~~~
 390
 391 * This release drops compatibility with Linux kernel 2.6.33. The minimum
 392   kernel requirement is now 2.6.34.
 393
 394
 395 Known Issues
 396 ------------
 397
 398 * Some drivers do not fill the packet type when receiving.
 399   As the l3fwd example application requires this info, the i40e vector
 400   driver must be disabled to benefit of the packet type with i40e.
 401
 402
 403 API Changes
 404 -----------
 405
 406 * The deprecated flow director API is removed.
 407   It was replaced by rte_eth_dev_filter_ctrl().
 408
 409 * The dcb_queue is renamed to dcb_tc in following dcb configuration
 410   structures: rte_eth_dcb_rx_conf, rte_eth_dcb_tx_conf,
 411   rte_eth_vmdq_dcb_conf, rte_eth_vmdq_dcb_tx_conf.
 412
 413 * The rte_eth_rx_queue_count() function now returns "int" instead of "uint32_t"
 414   to allow the use of negative values as error codes on return.
 415
 416 * The function rte_eal_pci_close_one() is removed.
 417   It was replaced by rte_eal_pci_detach().
 418
 419 * The deprecated ACL API ipv4vlan is removed.
 420
 421 * The deprecated hash function rte_jhash2() is removed.
 422   It was replaced by rte_jhash_32b().
 423
 424 * The deprecated KNI functions are removed:
 425   rte_kni_create(), rte_kni_get_port_id() and rte_kni_info_get().
 426
 427 * The deprecated ring PMD functions are removed:
 428   rte_eth_ring_pair_create() and rte_eth_ring_pair_attach().
 429
 430 * The devargs union field virtual is renamed to virt for C++ compatibility.
 431
 432 ABI Changes
 433 -----------
 434
 435 * The EAL and ethdev structures rte_intr_handle and rte_eth_conf were changed
 436   to support Rx interrupt. It was already done in 2.1 for CONFIG_RTE_NEXT_ABI.
 437
 438 * The ethdev flow director entries for SCTP were changed.
 439   It was already done in 2.1 for CONFIG_RTE_NEXT_ABI.
 440
 441 * The ethdev flow director structure rte_eth_fdir_flow_ext structure is changed.
 442   New fields are added to support flow director filtering in VF.
 443
 444 * The size of the ethdev structure rte_eth_hash_filter_info is changed
 445   by adding a new element rte_eth_input_set_conf in an union.
 446
 447 * The new fields rx_desc_lim and tx_desc_lim are added into rte_eth_dev_info
 448   structure.
 449
 450 * For debug builds, the functions rte_eth_rx_burst(), rte_eth_tx_burst()
 451   rte_eth_rx_descriptor_done() and rte_eth_rx_queue_count() will
 452   no longer be separate functions in the DPDK libraries. Instead, they will
 453   only be present in the rte_ethdev.h header file.
 454
 455 * The maximum number of queues per port CONFIG_RTE_MAX_QUEUES_PER_PORT is
 456   increased to 1024.
 457
 458 * The mbuf structure was changed to support unified packet type.
 459   It was already done in 2.1 for CONFIG_RTE_NEXT_ABI.
 460
 461 * The dummy malloc library is removed. The content was moved into EAL in 2.1.
 462
 463 * The LPM structure is changed. The deprecated field mem_location is removed.
 464
 465 * librte_table LPM: A new parameter to hold the table name will be added to
 466   the LPM table parameter structure.
 467
 468 * librte_table hash: The key mask parameter is added to the hash table
 469   parameter structure for 8-byte key and 16-byte key extendible bucket
 470   and LRU tables.
 471
 472 * librte_port: Macros to access the packet meta-data stored within the packet
 473   buffer has been adjusted to cover the packet mbuf structure.
 474
 475 * librte_cfgfile: Allow longer names and values by increasing the constants
 476   CFG_NAME_LEN and CFG_VALUE_LEN to 64 and 256 respectively.
 477
 478
 479 Shared Library Versions
 480 -----------------------
 481
 482 The libraries prepended with a plus sign were incremented in this version.
 483
 484 .. code-block:: diff
 485
 486    + libethdev.so.2
 487    + librte_acl.so.2
 488    + librte_cfgfile.so.2
 489      librte_cmdline.so.1
 490      librte_distributor.so.1
 491    + librte_eal.so.2
 492    + librte_hash.so.2
 493      librte_ip_frag.so.1
 494      librte_ivshmem.so.1
 495      librte_jobstats.so.1
 496    + librte_kni.so.2
 497      librte_kvargs.so.1
 498    + librte_lpm.so.2
 499    + librte_mbuf.so.2
 500      librte_mempool.so.1
 501      librte_meter.so.1
 502    + librte_pipeline.so.2
 503      librte_pmd_bond.so.1
 504    + librte_pmd_ring.so.2
 505    + librte_port.so.2
 506      librte_power.so.1
 507      librte_reorder.so.1
 508      librte_ring.so.1
 509      librte_sched.so.1
 510    + librte_table.so.2
 511      librte_timer.so.1
 512      librte_vhost.so.1