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