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