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