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