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