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