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