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