doc/guides/rel_notes/release_16_04.rst

   1 DPDK Release 16.04
   2 ==================
   3
   4
   5 **Read this first**
   6
   7 The text below explains how to update the release notes.
   8
   9 Use proper spelling, capitalization and punctuation in all sections.
  10
  11 Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
  12
  13 Build the docs and view the output file to ensure the changes are correct::
  14
  15    make doc-guides-html
  16
  17    firefox build/doc/html/guides/rel_notes/release_16_04.html
  18
  19
  20 New Features
  21 ------------
  22
  23 This section should contain new features added in this release. Sample format:
  24
  25 * **Add a title in the past tense with a full stop.**
  26
  27   Add a short 1-2 sentence description in the past tense. The description
  28   should be enough to allow someone scanning the release notes to understand
  29   the new feature.
  30
  31   If the feature adds a lot of sub-features you can use a bullet list like this.
  32
  33   * Added feature foo to do something.
  34   * Enhanced feature bar to do something else.
  35
  36   Refer to the previous release notes for examples.
  37
  38 * **Added function to check primary process state.**
  39
  40   A new function ``rte_eal_primary_proc_alive()`` has been added
  41   to allow the user to detect if a primary process is running.
  42   Use cases for this feature include fault detection, and monitoring
  43   using secondary processes.
  44
  45 * **Enabled bulk allocation of mbufs.**
  46
  47   A new function ``rte_pktmbuf_alloc_bulk()`` has been added to allow the user
  48   to allocate a bulk of mbufs.
  49
  50 * **Added device link speed capabilities.**
  51
  52   The structure ``rte_eth_dev_info`` has now a ``speed_capa`` bitmap, which
  53   allows the application to know the supported speeds of each device.
  54
  55 * **Added bitmap of link speeds to advertise.**
  56
  57   Allow defining a set of advertised speeds for auto-negotiation,
  58   explicitly disabling link auto-negotiation (single speed)
  59   and full auto-negotiation.
  60
  61 * **Added new poll-mode driver for Amazon Elastic Network Adapters (ENA).**
  62
  63   The driver operates variety of ENA adapters through feature negotiation
  64   with the adapter and upgradable commands set.
  65   ENA driver handles PCI Physical and Virtual ENA functions.
  66
  67 * **Restored vmxnet3 Tx data ring.**
  68
  69   Tx data ring has been shown to improve small pkt forwarding performance
  70   on vSphere environment.
  71
  72 * **Added vmxnet3 Tx L4 checksum offload.**
  73
  74   Support TCP/UDP checksum offload.
  75
  76 * **Added vmxnet3 TSO support.**
  77
  78 * **Added vmxnet3 support for jumbo frames.**
  79
  80   Added support for linking multi-segment buffers together to
  81   handle Jumbo packets.
  82
  83 * **Virtio 1.0.**
  84
  85   Enabled virtio 1.0 support for virtio pmd driver.
  86
  87 * **Supported virtio for ARM.**
  88
  89   Enabled virtio support for armv7/v8. Tested for arm64.
  90   Virtio for arm support VFIO-noiommu mode only.
  91   Virtio can work with other non-x86 arch too like powerpc.
  92
  93 * **Supported virtio offload in vhost-user.**
  94
  95   Add the offload and negotiation of checksum and TSO between vhost-user and
  96   vanilla Linux virtio guest.
  97
  98 * **Added vhost-user live migration support.**
  99
 100 * **Added vhost driver.**
 101
 102   Added virtual PMD that wraps librte_vhost.
 103
 104 * **Added multicast promiscuous mode support on VF for ixgbe.**
 105
 106   Added multicast promiscuous mode support on ixgbe VF driver. So all the VFs
 107   can receive the multicast packets.
 108
 109   Please note if we want to use this promiscuous mode, we need both PF and VF
 110   driver to support it. The reason is this VF feature is configured on PF.
 111   If use kernel PF driver + dpdk VF driver, make sure kernel PF driver support
 112   VF multicast promiscuous mode. If use dpdk PF + dpdk VF, better make sure PF
 113   driver is the same version as VF.
 114
 115 * **Added support for E-tag on X550.**
 116
 117   E-tag is defined in 802.1br. Please reference
 118   http://www.ieee802.org/1/pages/802.1br.html.
 119
 120   This feature is for VF, but the settings are on PF. It means
 121   the CLIs should be used on PF, but some of their effects will be shown on VF.
 122   The forwarding of E-tag packets based on GRP and E-CID_base will have effect
 123   on PF. Theoretically the E-tag packets can be forwarded to any pool/queue.
 124   But normally we'd like to forward the packets to the pools/queues belonging
 125   to the VFs. And E-tag insertion and stripping will have effect on VFs. When
 126   VF receives E-tag packets, it should strip the E-tag. When VF transmits
 127   packets, it should insert the E-tag. Both can be offloaded.
 128
 129   When we want to use this E-tag support feature, the forwarding should be
 130   enabled to forward the packets received by PF to indicated VFs. And insertion
 131   and stripping should be enabled for VFs to offload the effort to HW.
 132
 133   * Support E-tag offloading of insertion and stripping.
 134   * Support Forwarding E-tag packets to pools based on
 135     GRP and E-CID_base.
 136
 137 * **Added support for VxLAN & NVGRE checksum off-load on X550.**
 138
 139   * Added support for VxLAN & NVGRE RX/TX checksum off-load on
 140     X550. RX/TX checksum off-load is provided on both inner and
 141     outer IP header and TCP header.
 142   * Added functions to support VxLAN port configuration. The
 143     default VxLAN port number is 4789 but this can be updated
 144     programmatically.
 145
 146 * **Added new X550EM_a devices.**
 147
 148   Added new X550EM_a devices and their mac types, X550EM_a and X550EM_a_vf.
 149   Updated the code to use the new devices and mac types.
 150
 151 * **Added x550em_x V2 device support.**
 152
 153   Only x550em_x V1 was supported before. Now V2 is supported.
 154   A mask for V1 and V2 is defined and used to support both.
 155
 156 * **Supported link speed auto-negotiation on X550EM_X**
 157
 158   Normally the auto-negotiation is supported by FW. SW need not care about
 159   that. But on x550em_x, FW doesn't support auto-neg. As the ports of x550em_x
 160   are 10G, if we connect the port with a peer which is 1G, the link will always
 161   be down.
 162   We added the support of auto-neg by SW to avoid this link down issue.
 163
 164 * **Added sw-firmware sync on X550EM_a.**
 165
 166   Added support for sw-firmware sync for resource sharing.
 167   Use the PHY token, shared between sw-fw for PHY access on X550EM_a.
 168
 169 * **Updated the i40e base driver.**
 170
 171   The i40e base driver was updated with changes including the
 172   following:
 173
 174   * Use Rx control AQ commands to read/write Rx control registers.
 175   * Add new X722 device IDs, and removed X710 one was never used.
 176   * Expose registers for HASH/FD input set configuring.
 177
 178 * **Enabled PCI extended tag for i40e.**
 179
 180   It enabled extended tag by checking and writing corresponding PCI config
 181   space bytes, to boost the performance. In the meanwhile, it deprecated the
 182   legacy way via reading/writing sysfile supported by kernel module igb_uio.
 183
 184 * **Added i40e support for setting mac addresses.**
 185
 186 * **Added dump of i40e registers and EEPROM.**
 187
 188 * **Supported ether type setting of single and double VLAN for i40e**
 189
 190 * **Added VMDQ DCB mode in i40e.**
 191
 192   Added support for DCB in VMDQ mode to i40e driver.
 193
 194 * **Added i40e VEB switching support.**
 195
 196 * **Added Flow director enhancements in i40e.**
 197
 198 * **Added PF reset event reporting in i40e VF driver.**
 199
 200 * **Added fm10k Rx interrupt support.**
 201
 202 * **Optimized fm10k Tx.**
 203
 204   * Free multiple mbufs at a time to reduce freeing mbuf cycles.
 205
 206 * **Handled error flags in fm10k vector Rx.**
 207
 208   Parse err flags in Rx desc and set error bits in mbuf with vector instructions.
 209
 210 * **Added fm10k FTAG based forwarding support.**
 211
 212 * **Added mlx5 flow director support.**
 213
 214   Added flow director support (RTE_FDIR_MODE_PERFECT and
 215   RTE_FDIR_MODE_PERFECT_MAC_VLAN).
 216
 217   Only available with Mellanox OFED >= 3.2.
 218
 219 * **Added mlx5 RX VLAN stripping support.**
 220
 221   Added support for RX VLAN stripping.
 222
 223   Only available with Mellanox OFED >= 3.2.
 224
 225 * **Added mlx5 link up/down callbacks.**
 226
 227   Implemented callbacks to bring link up and down.
 228
 229 * **Added mlx5 support for operation in secondary processes.**
 230
 231   Implemented TX support in secondary processes (like mlx4).
 232
 233 * **Added mlx5 RX CRC stripping configuration.**
 234
 235   Until now, CRC was always stripped. It can now be configured.
 236
 237   Only available with Mellanox OFED >= 3.2.
 238
 239 * **Added mlx5 optional packet padding by HW.**
 240
 241   Added an option to make PCI bus transactions rounded to multiple of a
 242   cache line size for better alignment.
 243
 244   Only available with Mellanox OFED >= 3.2.
 245
 246 * **Added mlx5 TX VLAN insertion support.**
 247
 248   Added support for TX VLAN insertion.
 249
 250   Only available with Mellanox OFED >= 3.2.
 251
 252 * **Changed szedata2 type of driver from vdev to pdev.**
 253
 254   Previously szedata2 device had to be added by ``--vdev`` option.
 255   Now szedata2 PMD recognises the device automatically during EAL
 256   initialization.
 257
 258 * **Added szedata2 functions for setting link up/down.**
 259
 260 * **Added szedata2 promiscuous and allmulticast modes.**
 261
 262 * **Added af_packet dynamic removal function.**
 263
 264   Af_packet device can now be detached using API, like other PMD devices.
 265
 266 * **Increased number of next hops for LPM IPv4 to 2^24.**
 267
 268   The next_hop field is extended from 8 bits to 24 bits for IPv4.
 269
 270 * **Added support of SNOW 3G (UEA2 and UIA2) for Intel Quick Assist devices.**
 271
 272   Enabled support for SNOW 3G wireless algorithm for Intel Quick Assist devices.
 273   Support for cipher only, hash only is also provided
 274   along with alg-chaining operations.
 275
 276 * **Added SNOW3G SW PMD.**
 277
 278   A new Crypto PMD has been added, which provides SNOW 3G UEA2 ciphering
 279   and SNOW3G UIA2 hashing.
 280
 281 * **Added AES GCM PMD.**
 282
 283   Added new Crypto PMD to support AES-GCM authenticated encryption and
 284   authenticated decryption in SW.
 285
 286 * **Added NULL Crypto PMD**
 287
 288   Added new Crypto PMD to support null crypto operations in SW.
 289
 290 * **Improved IP Pipeline Application.**
 291
 292   The following features have been added to ip_pipeline application;
 293
 294   * Added CPU utilization measurement and idle cycle rate computation.
 295   * Added link idenfication support through existing port-mask option or by
 296     specifying PCI device in every LINK section in the configuration file.
 297   * Added load balancing support in passthrough pipeline.
 298
 299 * **Added IPsec security gateway example.**
 300
 301   New application implementing an IPsec Security Gateway.
 302
 303
 304 Resolved Issues
 305 ---------------
 306
 307 This section should contain bug fixes added to the relevant sections. Sample format:
 308
 309 * **code/section: Fixed issue in the past tense with a full stop.**
 310
 311   Add a short 1-2 sentence description of the resolved issue in the past tense.
 312   The title should contain the code/lib section like a commit message.
 313   Add the entries in alphabetic order in the relevant sections below.
 314
 315
 316 EAL
 317 ~~~
 318
 319
 320 Drivers
 321 ~~~~~~~
 322
 323 * **ethdev: Fixed overflow for 100Gbps.**
 324
 325   100Gbps in Mbps (100000) was exceeding 16-bit max value of ``link_speed``
 326   in ``rte_eth_link``.
 327
 328 * **ethdev: Fixed byte order consistency between fdir flow and mask.**
 329
 330   Fixed issue in ethdev library that the structure for setting
 331   fdir's mask and flow entry was not consistent in byte ordering.
 332
 333 * **cxgbe: Fixed crash due to incorrect size allocated for RSS table.**
 334
 335   Fixed a segfault that occurs when accessing part of port 0's RSS
 336   table that gets overwritten by subsequent port 1's part of the RSS
 337   table due to incorrect size allocated for each entry in the table.
 338
 339 * **cxgbe: Fixed setting wrong device MTU.**
 340
 341   Fixed an incorrect device MTU being set due to ethernet header and
 342   CRC lengths being added twice.
 343
 344 * **ixgbe: Fixed zeroed VF mac address.**
 345
 346   Resolved an issue where VF mac address is zeroed out in cases where the VF
 347   driver is loaded while the PF interface is down.
 348   The solution is to only set it when we get an ACK from the PF.
 349
 350 * **ixgbe: Fixed setting flow director flag twice.**
 351
 352   Resolved an issue where packets were being dropped when switching to perfect
 353   filters mode.
 354
 355 * **ixgbe: Set MDIO speed after MAC reset.**
 356
 357   The MDIO clock speed must be reconfigured after the MAC reset. The MDIO clock
 358   speed becomes invalid, therefore the driver reads invalid PHY register values.
 359   The driver now set the MDIO clock speed prior to initializing PHY ops and
 360   again after the MAC reset.
 361
 362 * **ixgbe: Fixed maximum number of available TX queues.**
 363
 364   In IXGBE, the maximum number of TX queues varies depending on the NIC operating
 365   mode. This was not being updated in the device information, providing
 366   an incorrect number in some cases.
 367
 368 * **i40e: Generated MAC address for each VFs.**
 369
 370   It generates a MAC address for each VFs during PF host initialization,
 371   and keeps the VF MAC address the same among different VF launch.
 372
 373 * **i40e: Fixed failure of reading/writing Rx control registers.**
 374
 375   Fixed i40e issue of failing to read/write rx control registers when
 376   under stress with traffic, which might result in application launch
 377   failure.
 378
 379 * **i40e: Enabled vector driver by default.**
 380
 381   Previously, vector driver is disabled by default as it cannot fill packet type
 382   info for l3fwd to work well. Now there is an option for l3fwd to analysis
 383   packet type softly, so enable vector driver by default.
 384
 385 * **i40e: Fixed link info of VF.**
 386
 387   Previously, the VF's link speed kept as 10G and status always was up.
 388   It did not change even the physical link's status changed.
 389   Now this issue is fixed to make VF's link info consistent with physical link.
 390
 391 * **mlx5: Fixed possible crash during initialization.**
 392
 393   A crash could occur when failing to allocate private device context.
 394
 395 * **mlx5: Added port type check.**
 396
 397   Done to prevent port initialization on non-Ethernet link layers and
 398   to report an error.
 399
 400 * **mlx5: Applied VLAN filtering to broadcast and IPv6 multicast flows.**
 401
 402   Prevented reception of multicast frames outside of configured VLANs.
 403
 404 * **mlx5: Fixed RX checksum offload in non L3/L4 packets.**
 405
 406   Fixed report of bad checksum for packets of unknown type.
 407
 408 * **aesni_mb: Fixed wrong return value when creating a device.**
 409
 410   cryptodev_aesni_mb_init() was returning the device id of the device created,
 411   instead of 0 (when success), that rte_eal_vdev_init() expects.
 412   This made impossible the creation of more than one aesni_mb device
 413   from command line.
 414
 415 * **qat: Fixed AES GCM decryption.**
 416
 417   Allowed AES GCM on the cryptodev API, but in some cases gave invalid results
 418   due to incorrect IV setting.
 419
 420
 421 Libraries
 422 ~~~~~~~~~
 423
 424 * **hash: Fixed CRC32c hash computation for non multiple of 4 bytes sizes.**
 425
 426   Fix crc32c hash functions to return a valid crc32c value for data lengths
 427   not multiple of 4 bytes.
 428
 429 * **hash: Fixed hash library to support multi-process mode.**
 430
 431   Fix hash library to support multi-process mode, using a jump table,
 432   instead of storing a function pointer to the key compare function.
 433   Multi-process mode only works with the built-in compare functions,
 434   however a custom compare function (not in the jump table) can only
 435   be used in single-process mode.
 436
 437 * **lpm: Fixed return value when allocating an existing object.**
 438
 439   Changed the ``rte_lpm*_create()`` functions to return ``NULL`` and set
 440   ``rte_errno`` to ``EEXIST`` when the object name already exists. This is
 441   the behavior described in the API documentation in the header file.
 442   The previous behavior was to return a pointer to the existing object in
 443   that case, preventing the caller to know if the object had to be freed
 444   or not.
 445
 446 * **librte_port: Fixed segmentation fault for ring and ethdev writer nodrop.**
 447
 448   Fixed core dump issue on txq and swq when dropless is set to yes.
 449
 450
 451 Examples
 452 ~~~~~~~~
 453
 454 * **l3fwd-power: Fixed memory leak for non-IP packet.**
 455
 456   Fixed issue in l3fwd-power where, on receiving packets of types
 457   other than IPv4 or IPv6, the mbuf was not released, and caused
 458   a memory leak.
 459
 460 * **l3fwd: Fixed using packet type blindly.**
 461
 462   l3fwd makes use of packet type information without even query if devices or PMDs
 463   really set it. For those don't set ptypes, add an option to parse it softly.
 464
 465 * **examples/vhost: Fixed frequent mbuf allocation failure.**
 466
 467   vhost-switch often fails to allocate mbuf when dequeue from vring because it
 468   wrongly calculates the number of mbufs needed.
 469
 470
 471 Other
 472 ~~~~~
 473
 474
 475 Known Issues
 476 ------------
 477
 478 This section should contain new known issues in this release. Sample format:
 479
 480 * **Add title in present tense with full stop.**
 481
 482   Add a short 1-2 sentence description of the known issue in the present
 483   tense. Add information on any known workarounds.
 484
 485
 486 API Changes
 487 -----------
 488
 489 This section should contain API changes. Sample format:
 490
 491 * Add a short 1-2 sentence description of the API change. Use fixed width
 492   quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 493
 494 * The ethdev statistics counter imissed is considered to be independent of ierrors.
 495   All drivers are now counting the missed packets only once, i.e. drivers will
 496   not increment ierrors anymore for missed packets.
 497
 498 * The ethdev structure ``rte_eth_dev_info`` was changed to support device
 499   speed capabilities.
 500
 501 * The ethdev structures ``rte_eth_link`` and ``rte_eth_conf`` were changed to
 502   support the new link API.
 503
 504 * The functions ``rte_eth_dev_udp_tunnel_add`` and ``rte_eth_dev_udp_tunnel_delete``
 505   have been renamed into ``rte_eth_dev_udp_tunnel_port_add`` and
 506   ``rte_eth_dev_udp_tunnel_port_delete``.
 507
 508 * The ``outer_mac`` and ``inner_mac`` fields in structure
 509   ``rte_eth_tunnel_filter_conf`` are changed from pointer to struct in order
 510   to keep code's readability.
 511
 512 * The fields in ethdev structure ``rte_eth_fdir_masks`` were changed
 513   to be in big endian.
 514
 515 * A parameter ``vlan_type`` has been added to the function
 516   ``rte_eth_dev_set_vlan_ether_type``.
 517
 518 * AF_packet device init function is no longer public. Device should be attached
 519   with API.
 520
 521 * The LPM ``next_hop`` field is extended from 8 bits to 24 bits for IPv4
 522   while keeping ABI compatibility.
 523
 524 * A new ``rte_lpm_config`` structure is used so LPM library will allocate
 525   exactly the amount of memory which is necessary to hold application’s rules.
 526   The previous ABI is kept for compatibility.
 527
 528 * The prototype for the pipeline input port, output port and table action
 529   handlers are updated: the pipeline parameter is added,
 530   the packets mask parameter has been either removed or made input-only.
 531
 532
 533 ABI Changes
 534 -----------
 535
 536 * Add a short 1-2 sentence description of the ABI change that was announced in
 537   the previous releases and made in this release. Use fixed width quotes for
 538   ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 539
 540 * The RETA entry size in ``rte_eth_rss_reta_entry64`` has been increased
 541   from 8-bit to 16-bit.
 542
 543 * The ethdev flow director structure ``rte_eth_fdir_flow`` structure was
 544   changed. New fields were added to extend flow director's input set.
 545
 546 * The cmdline buffer size has been increase from 256 to 512.
 547
 548
 549 Shared Library Versions
 550 -----------------------
 551
 552 Update any library version updated in this release and prepend with a ``+`` sign.
 553
 554 The libraries prepended with a plus sign were incremented in this version.
 555
 556 .. code-block:: diff
 557
 558    + libethdev.so.3
 559      librte_acl.so.2
 560      librte_cfgfile.so.2
 561    + librte_cmdline.so.2
 562      librte_distributor.so.1
 563      librte_eal.so.2
 564      librte_hash.so.2
 565      librte_ip_frag.so.1
 566      librte_ivshmem.so.1
 567      librte_jobstats.so.1
 568      librte_kni.so.2
 569      librte_kvargs.so.1
 570      librte_lpm.so.2
 571      librte_mbuf.so.2
 572      librte_mempool.so.1
 573      librte_meter.so.1
 574    + librte_pipeline.so.3
 575      librte_pmd_bond.so.1
 576      librte_pmd_ring.so.2
 577      librte_port.so.2
 578      librte_power.so.1
 579      librte_reorder.so.1
 580      librte_ring.so.1
 581      librte_sched.so.1
 582      librte_table.so.2
 583      librte_timer.so.1
 584      librte_vhost.so.2