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