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 new poll-mode driver for Amazon Elastic Network Adapters (ENA).**
  51
  52   The driver operates variety of ENA adapters through feature negotiation
  53   with the adapter and upgradable commands set.
  54   ENA driver handles PCI Physical and Virtual ENA functions.
  55
  56 * **Restored vmxnet3 Tx data ring.**
  57
  58   Tx data ring has been shown to improve small pkt forwarding performance
  59   on vSphere environment.
  60
  61 * **Added vmxnet3 Tx L4 checksum offload.**
  62
  63   Support TCP/UDP checksum offload.
  64
  65 * **Added vmxnet3 TSO support.**
  66
  67 * **Added vmxnet3 support for jumbo frames.**
  68
  69   Added support for linking multi-segment buffers together to
  70   handle Jumbo packets.
  71
  72 * **Virtio 1.0.**
  73
  74   Enabled virtio 1.0 support for virtio pmd driver.
  75
  76 * **Supported virtio for ARM.**
  77
  78   Enabled virtio support for armv7/v8. Tested for arm64.
  79   Virtio for arm support VFIO-noiommu mode only.
  80   Virtio can work with other non-x86 arch too like powerpc.
  81
  82 * **Supported virtio offload in vhost-user.**
  83
  84   Add the offload and negotiation of checksum and TSO between vhost-user and
  85   vanilla Linux virtio guest.
  86
  87 * **Added vhost-user live migration support.**
  88
  89 * **Added multicast promiscuous mode support on VF for ixgbe.**
  90
  91   Added multicast promiscuous mode support on ixgbe VF driver. So all the VFs
  92   can receive the multicast packets.
  93
  94   Please note if we want to use this promiscuous mode, we need both PF and VF
  95   driver to support it. The reason is this VF feature is configured on PF.
  96   If use kernel PF driver + dpdk VF driver, make sure kernel PF driver support
  97   VF multicast promiscuous mode. If use dpdk PF + dpdk VF, better make sure PF
  98   driver is the same version as VF.
  99
 100 * **Added support for E-tag on X550.**
 101
 102   E-tag is defined in 802.1br. Please reference
 103   http://www.ieee802.org/1/pages/802.1br.html.
 104
 105   This feature is for VF, but the settings are on PF. It means
 106   the CLIs should be used on PF, but some of their effects will be shown on VF.
 107   The forwarding of E-tag packets based on GRP and E-CID_base will have effect
 108   on PF. Theoretically the E-tag packets can be forwarded to any pool/queue.
 109   But normally we'd like to forward the packets to the pools/queues belonging
 110   to the VFs. And E-tag insertion and stripping will have effect on VFs. When
 111   VF receives E-tag packets, it should strip the E-tag. When VF transmits
 112   packets, it should insert the E-tag. Both can be offloaded.
 113
 114   When we want to use this E-tag support feature, the forwarding should be
 115   enabled to forward the packets received by PF to indicated VFs. And insertion
 116   and stripping should be enabled for VFs to offload the effort to HW.
 117
 118   * Support E-tag offloading of insertion and stripping.
 119   * Support Forwarding E-tag packets to pools based on
 120     GRP and E-CID_base.
 121
 122 * **Added support for VxLAN & NVGRE checksum off-load on X550.**
 123
 124   * Added support for VxLAN & NVGRE RX/TX checksum off-load on
 125     X550. RX/TX checksum off-load is provided on both inner and
 126     outer IP header and TCP header.
 127   * Added functions to support VxLAN port configuration. The
 128     default VxLAN port number is 4789 but this can be updated
 129     programmatically.
 130
 131 * **Added new X550EM_a devices.**
 132
 133   Added new X550EM_a devices and their mac types, X550EM_a and X550EM_a_vf.
 134   Updated the code to use the new devices and mac types.
 135
 136 * **Added x550em_x V2 device support.**
 137
 138   Only x550em_x V1 was supported before. Now V2 is supported.
 139   A mask for V1 and V2 is defined and used to support both.
 140
 141 * **Supported link speed auto-negotiation on X550EM_X**
 142
 143   Normally the auto-negotiation is supported by FW. SW need not care about
 144   that. But on x550em_x, FW doesn't support auto-neg. As the ports of x550em_x
 145   are 10G, if we connect the port with a peer which is 1G, the link will always
 146   be down.
 147   We added the support of auto-neg by SW to avoid this link down issue.
 148
 149 * **Added sw-firmware sync on X550EM_a.**
 150
 151   Added support for sw-firmware sync for resource sharing.
 152   Use the PHY token, shared between sw-fw for PHY access on X550EM_a.
 153
 154 * **Updated the i40e base driver.**
 155
 156   The i40e base driver was updated with changes including the
 157   following:
 158
 159   * Use Rx control AQ commands to read/write Rx control registers.
 160   * Add new X722 device IDs, and removed X710 one was never used.
 161   * Expose registers for HASH/FD input set configuring.
 162
 163 * **Enabled PCI extended tag for i40e.**
 164
 165   It enabled extended tag by checking and writing corresponding PCI config
 166   space bytes, to boost the performance. In the meanwhile, it deprecated the
 167   legacy way via reading/writing sysfile supported by kernel module igb_uio.
 168
 169 * **Added i40e support for setting mac addresses.**
 170
 171 * **Added dump of i40e registers and EEPROM.**
 172
 173 * **Supported ether type setting of single and double VLAN for i40e**
 174
 175 * **Added VMDQ DCB mode in i40e.**
 176
 177   Added support for DCB in VMDQ mode to i40e driver.
 178
 179 * **Added i40e VEB switching support.**
 180
 181 * **Added fm10k Rx interrupt support.**
 182
 183 * **Optimized fm10k Tx.**
 184
 185   * Free multiple mbufs at a time to reduce freeing mbuf cycles.
 186
 187 * **Handled error flags in fm10k vector Rx.**
 188
 189   Parse err flags in Rx desc and set error bits in mbuf with vector instructions.
 190
 191 * **Added fm10k FTAG based forwarding support.**
 192
 193 * **Added mlx5 flow director support.**
 194
 195   Added flow director support (RTE_FDIR_MODE_PERFECT and
 196   RTE_FDIR_MODE_PERFECT_MAC_VLAN).
 197
 198   Only available with Mellanox OFED >= 3.2.
 199
 200 * **Added mlx5 RX VLAN stripping support.**
 201
 202   Added support for RX VLAN stripping.
 203
 204   Only available with Mellanox OFED >= 3.2.
 205
 206 * **Changed szedata2 type of driver from vdev to pdev.**
 207
 208   Previously szedata2 device had to be added by ``--vdev`` option.
 209   Now szedata2 PMD recognises the device automatically during EAL
 210   initialization.
 211
 212 * **Added szedata2 functions for setting link up/down.**
 213
 214 * **Added szedata2 promiscuous and allmulticast modes.**
 215
 216 * **Added af_packet dynamic removal function.**
 217
 218   Af_packet device can now be detached using API, like other PMD devices.
 219
 220 * **Increased number of next hops for LPM IPv4 to 2^24.**
 221
 222   The next_hop field is extended from 8 bits to 24 bits for IPv4.
 223
 224 * **Added support of SNOW 3G (UEA2 and UIA2) for Intel Quick Assist devices.**
 225
 226   Enabled support for SNOW 3G wireless algorithm for Intel Quick Assist devices.
 227   Support for cipher only, hash only is also provided
 228   along with alg-chaining operations.
 229
 230 * **Added SNOW3G SW PMD.**
 231
 232   A new Crypto PMD has been added, which provides SNOW 3G UEA2 ciphering
 233   and SNOW3G UIA2 hashing.
 234
 235 * **Added AES GCM PMD.**
 236
 237   Added new Crypto PMD to support AES-GCM authenticated encryption and
 238   authenticated decryption in SW.
 239
 240 * **Added NULL Crypto PMD**
 241
 242   Added new Crypto PMD to support null crypto operations in SW.
 243
 244 * **Improved IP Pipeline Application.**
 245
 246   The following features have been added to ip_pipeline application;
 247
 248   * Added CPU utilization measurement and idle cycle rate computation.
 249   * Added link idenfication support through existing port-mask option or by
 250     specifying PCI device in every LINK section in the configuration file.
 251   * Added load balancing support in passthrough pipeline.
 252
 253 * **Added IPsec security gateway example.**
 254
 255   New application implementing an IPsec Security Gateway.
 256
 257
 258 Resolved Issues
 259 ---------------
 260
 261 This section should contain bug fixes added to the relevant sections. Sample format:
 262
 263 * **code/section: Fixed issue in the past tense with a full stop.**
 264
 265   Add a short 1-2 sentence description of the resolved issue in the past tense.
 266   The title should contain the code/lib section like a commit message.
 267   Add the entries in alphabetic order in the relevant sections below.
 268
 269
 270 EAL
 271 ~~~
 272
 273
 274 Drivers
 275 ~~~~~~~
 276
 277 * **ethdev: Fixed byte order consistency between fdir flow and mask.**
 278
 279   Fixed issue in ethdev library that the structure for setting
 280   fdir's mask and flow entry was not consistent in byte ordering.
 281
 282 * **cxgbe: Fixed crash due to incorrect size allocated for RSS table.**
 283
 284   Fixed a segfault that occurs when accessing part of port 0's RSS
 285   table that gets overwritten by subsequent port 1's part of the RSS
 286   table due to incorrect size allocated for each entry in the table.
 287
 288 * **cxgbe: Fixed setting wrong device MTU.**
 289
 290   Fixed an incorrect device MTU being set due to ethernet header and
 291   CRC lengths being added twice.
 292
 293 * **ixgbe: Fixed zeroed VF mac address.**
 294
 295   Resolved an issue where VF mac address is zeroed out in cases where the VF
 296   driver is loaded while the PF interface is down.
 297   The solution is to only set it when we get an ACK from the PF.
 298
 299 * **ixgbe: Fixed setting flow director flag twice.**
 300
 301   Resolved an issue where packets were being dropped when switching to perfect
 302   filters mode.
 303
 304 * **ixgbe: Set MDIO speed after MAC reset.**
 305
 306   The MDIO clock speed must be reconfigured after the MAC reset. The MDIO clock
 307   speed becomes invalid, therefore the driver reads invalid PHY register values.
 308   The driver now set the MDIO clock speed prior to initializing PHY ops and
 309   again after the MAC reset.
 310
 311 * **i40e: Generated MAC address for each VFs.**
 312
 313   It generates a MAC address for each VFs during PF host initialization,
 314   and keeps the VF MAC address the same among different VF launch.
 315
 316 * **i40e: Fixed failure of reading/writing Rx control registers.**
 317
 318   Fixed i40e issue of failing to read/write rx control registers when
 319   under stress with traffic, which might result in application launch
 320   failure.
 321
 322 * **mlx5: Fixed possible crash during initialization.**
 323
 324   A crash could occur when failing to allocate private device context.
 325
 326 * **mlx5: Added port type check.**
 327
 328   Done to prevent port initialization on non-Ethernet link layers and
 329   to report an error.
 330
 331 * **mlx5: Applied VLAN filtering to broadcast and IPv6 multicast flows.**
 332
 333   Prevented reception of multicast frames outside of configured VLANs.
 334
 335 * **mlx5: Fixed RX checksum offload in non L3/L4 packets.**
 336
 337   Fixed report of bad checksum for packets of unknown type.
 338
 339 * **aesni_mb: Fixed wrong return value when creating a device.**
 340
 341   cryptodev_aesni_mb_init() was returning the device id of the device created,
 342   instead of 0 (when success), that rte_eal_vdev_init() expects.
 343   This made impossible the creation of more than one aesni_mb device
 344   from command line.
 345
 346 * **qat: Fixed AES GCM decryption.**
 347
 348   Allowed AES GCM on the cryptodev API, but in some cases gave invalid results
 349   due to incorrect IV setting.
 350
 351
 352 Libraries
 353 ~~~~~~~~~
 354
 355 * **hash: Fixed CRC32c hash computation for non multiple of 4 bytes sizes.**
 356
 357   Fix crc32c hash functions to return a valid crc32c value for data lengths
 358   not multiple of 4 bytes.
 359
 360 * **librte_port: Fixed segmentation fault for ring and ethdev writer nodrop.**
 361
 362   Fixed core dump issue on txq and swq when dropless is set to yes.
 363
 364
 365 Examples
 366 ~~~~~~~~
 367
 368 * **l3fwd-power: Fixed memory leak for non-IP packet.**
 369
 370   Fixed issue in l3fwd-power where, on receiving packets of types
 371   other than IPv4 or IPv6, the mbuf was not released, and caused
 372   a memory leak.
 373
 374 * **examples/vhost: Fixed frequent mbuf allocation failure.**
 375
 376   vhost-switch often fails to allocate mbuf when dequeue from vring because it
 377   wrongly calculates the number of mbufs needed.
 378
 379
 380 Other
 381 ~~~~~
 382
 383
 384 Known Issues
 385 ------------
 386
 387 This section should contain new known issues in this release. Sample format:
 388
 389 * **Add title in present tense with full stop.**
 390
 391   Add a short 1-2 sentence description of the known issue in the present
 392   tense. Add information on any known workarounds.
 393
 394
 395 API Changes
 396 -----------
 397
 398 This section should contain API changes. Sample format:
 399
 400 * Add a short 1-2 sentence description of the API change. Use fixed width
 401   quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 402
 403 * The ethdev statistics counter imissed is considered to be independent of ierrors.
 404   All drivers are now counting the missed packets only once, i.e. drivers will
 405   not increment ierrors anymore for missed packets.
 406
 407 * The functions ``rte_eth_dev_udp_tunnel_add`` and ``rte_eth_dev_udp_tunnel_delete``
 408   have been renamed into ``rte_eth_dev_udp_tunnel_port_add`` and
 409   ``rte_eth_dev_udp_tunnel_port_delete``.
 410
 411 * The ``outer_mac`` and ``inner_mac`` fields in structure
 412   ``rte_eth_tunnel_filter_conf`` are changed from pointer to struct in order
 413   to keep code's readability.
 414
 415 * The fields in ethdev structure ``rte_eth_fdir_masks`` were changed
 416   to be in big endian.
 417
 418 * A parameter ``vlan_type`` has been added to the function
 419   ``rte_eth_dev_set_vlan_ether_type``.
 420
 421 * AF_packet device init function is no longer public. Device should be attached
 422   with API.
 423
 424 * The LPM ``next_hop`` field is extended from 8 bits to 24 bits for IPv4
 425   while keeping ABI compatibility.
 426
 427 * A new ``rte_lpm_config`` structure is used so LPM library will allocate
 428   exactly the amount of memory which is necessary to hold application’s rules.
 429   The previous ABI is kept for compatibility.
 430
 431 * The prototype for the pipeline input port, output port and table action
 432   handlers are updated: the pipeline parameter is added,
 433   the packets mask parameter has been either removed or made input-only.
 434
 435
 436 ABI Changes
 437 -----------
 438
 439 * Add a short 1-2 sentence description of the ABI change that was announced in
 440   the previous releases and made in this release. Use fixed width quotes for
 441   ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 442
 443 * The RETA entry size in ``rte_eth_rss_reta_entry64`` has been increased
 444   from 8-bit to 16-bit.
 445
 446 * The cmdline buffer size has been increase from 256 to 512.
 447
 448
 449 Shared Library Versions
 450 -----------------------
 451
 452 Update any library version updated in this release and prepend with a ``+`` sign.
 453
 454 The libraries prepended with a plus sign were incremented in this version.
 455
 456 .. code-block:: diff
 457
 458    + libethdev.so.3
 459      librte_acl.so.2
 460      librte_cfgfile.so.2
 461    + librte_cmdline.so.2
 462      librte_distributor.so.1
 463      librte_eal.so.2
 464      librte_hash.so.2
 465      librte_ip_frag.so.1
 466      librte_ivshmem.so.1
 467      librte_jobstats.so.1
 468      librte_kni.so.2
 469      librte_kvargs.so.1
 470      librte_lpm.so.2
 471      librte_mbuf.so.2
 472      librte_mempool.so.1
 473      librte_meter.so.1
 474    + librte_pipeline.so.3
 475      librte_pmd_bond.so.1
 476      librte_pmd_ring.so.2
 477      librte_port.so.2
 478      librte_power.so.1
 479      librte_reorder.so.1
 480      librte_ring.so.1
 481      librte_sched.so.1
 482      librte_table.so.2
 483      librte_timer.so.1
 484      librte_vhost.so.2