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 support for E-tag on X550.**
  68
  69   E-tag is defined in 802.1br. Please reference
  70   http://www.ieee802.org/1/pages/802.1br.html.
  71
  72   This feature is for VF, but the settings are on PF. It means
  73   the CLIs should be used on PF, but some of their effects will be shown on VF.
  74   The forwarding of E-tag packets based on GRP and E-CID_base will have effect
  75   on PF. Theoretically the E-tag packets can be forwarded to any pool/queue.
  76   But normally we'd like to forward the packets to the pools/queues belonging
  77   to the VFs. And E-tag insertion and stripping will have effect on VFs. When
  78   VF receives E-tag packets, it should strip the E-tag. When VF transmits
  79   packets, it should insert the E-tag. Both can be offloaded.
  80
  81   When we want to use this E-tag support feature, the forwarding should be
  82   enabled to forward the packets received by PF to indicated VFs. And insertion
  83   and stripping should be enabled for VFs to offload the effort to HW.
  84
  85   * Support E-tag offloading of insertion and stripping.
  86   * Support Forwarding E-tag packets to pools based on
  87     GRP and E-CID_base.
  88
  89 * **Added support for VxLAN & NVGRE checksum off-load on X550.**
  90
  91   * Added support for VxLAN & NVGRE RX/TX checksum off-load on
  92     X550. RX/TX checksum off-load is provided on both inner and
  93     outer IP header and TCP header.
  94   * Added functions to support VxLAN port configuration. The
  95     default VxLAN port number is 4789 but this can be updated
  96     programmatically.
  97
  98 * **Added new X550EM_a devices.**
  99
 100   Added new X550EM_a devices and their mac types, X550EM_a and X550EM_a_vf.
 101   Updated the code to use the new devices and mac types.
 102
 103 * **Added x550em_x V2 device support.**
 104
 105   Only x550em_x V1 was supported before. Now V2 is supported.
 106   A mask for V1 and V2 is defined and used to support both.
 107
 108 * **Added sw-firmware sync on X550EM_a.**
 109
 110   Added support for sw-firmware sync for resource sharing.
 111   Use the PHY token, shared between sw-fw for PHY access on X550EM_a.
 112
 113 * **Enabled PCI extended tag for i40e.**
 114
 115   It enabled extended tag by checking and writing corresponding PCI config
 116   space bytes, to boost the performance. In the meanwhile, it deprecated the
 117   legacy way via reading/writing sysfile supported by kernel module igb_uio.
 118
 119 * **Supported ether type setting of single and double VLAN for i40e**
 120
 121 * **Increased number of next hops for LPM IPv4 to 2^24.**
 122
 123   The next_hop field is extended from 8 bits to 24 bits for IPv4.
 124
 125 * **Added support of SNOW 3G (UEA2 and UIA2) for Intel Quick Assist devices.**
 126
 127   Enabled support for SNOW 3G wireless algorithm for Intel Quick Assist devices.
 128   Support for cipher only, hash only is also provided
 129   along with alg-chaining operations.
 130
 131 * **Added SNOW3G SW PMD.**
 132
 133   A new Crypto PMD has been added, which provides SNOW 3G UEA2 ciphering
 134   and SNOW3G UIA2 hashing.
 135
 136 * **Added AES GCM PMD.**
 137
 138   Added new Crypto PMD to support AES-GCM authenticated encryption and
 139   authenticated decryption in SW.
 140
 141 * **Added NULL Crypto PMD**
 142
 143   Added new Crypto PMD to support null crypto operations in SW.
 144
 145 * **Added IPsec security gateway example.**
 146
 147   New application implementing an IPsec Security Gateway.
 148
 149
 150 Resolved Issues
 151 ---------------
 152
 153 This section should contain bug fixes added to the relevant sections. Sample format:
 154
 155 * **code/section: Fixed issue in the past tense with a full stop.**
 156
 157   Add a short 1-2 sentence description of the resolved issue in the past tense.
 158   The title should contain the code/lib section like a commit message.
 159   Add the entries in alphabetic order in the relevant sections below.
 160
 161
 162 EAL
 163 ~~~
 164
 165
 166 Drivers
 167 ~~~~~~~
 168
 169 * **ethdev: Fixed byte order consistency between fdir flow and mask.**
 170
 171   Fixed issue in ethdev library that the structure for setting
 172   fdir's mask and flow entry was not consistent in byte ordering.
 173
 174 * **cxgbe: Fixed crash due to incorrect size allocated for RSS table.**
 175
 176   Fixed a segfault that occurs when accessing part of port 0's RSS
 177   table that gets overwritten by subsequent port 1's part of the RSS
 178   table due to incorrect size allocated for each entry in the table.
 179
 180 * **cxgbe: Fixed setting wrong device MTU.**
 181
 182   Fixed an incorrect device MTU being set due to ethernet header and
 183   CRC lengths being added twice.
 184
 185 * **aesni_mb: Fixed wrong return value when creating a device.**
 186
 187   cryptodev_aesni_mb_init() was returning the device id of the device created,
 188   instead of 0 (when success), that rte_eal_vdev_init() expects.
 189   This made impossible the creation of more than one aesni_mb device
 190   from command line.
 191
 192 * **qat: Fixed AES GCM decryption.**
 193
 194   Allowed AES GCM on the cryptodev API, but in some cases gave invalid results
 195   due to incorrect IV setting.
 196
 197
 198 Libraries
 199 ~~~~~~~~~
 200
 201 * **hash: Fixed CRC32c hash computation for non multiple of 4 bytes sizes.**
 202
 203   Fix crc32c hash functions to return a valid crc32c value for data lengths
 204   not multiple of 4 bytes.
 205
 206
 207 Examples
 208 ~~~~~~~~
 209
 210 * **examples/vhost: Fixed frequent mbuf allocation failure.**
 211
 212   vhost-switch often fails to allocate mbuf when dequeue from vring because it
 213   wrongly calculates the number of mbufs needed.
 214
 215
 216 Other
 217 ~~~~~
 218
 219
 220 Known Issues
 221 ------------
 222
 223 This section should contain new known issues in this release. Sample format:
 224
 225 * **Add title in present tense with full stop.**
 226
 227   Add a short 1-2 sentence description of the known issue in the present
 228   tense. Add information on any known workarounds.
 229
 230
 231 API Changes
 232 -----------
 233
 234 This section should contain API changes. Sample format:
 235
 236 * Add a short 1-2 sentence description of the API change. Use fixed width
 237   quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 238
 239 * The functions ``rte_eth_dev_udp_tunnel_add`` and ``rte_eth_dev_udp_tunnel_delete``
 240   have been renamed into ``rte_eth_dev_udp_tunnel_port_add`` and
 241   ``rte_eth_dev_udp_tunnel_port_delete``.
 242
 243 * The ``outer_mac`` and ``inner_mac`` fields in structure
 244   ``rte_eth_tunnel_filter_conf`` are changed from pointer to struct in order
 245   to keep code's readability.
 246
 247 * The fields in ethdev structure ``rte_eth_fdir_masks`` were changed
 248   to be in big endian.
 249
 250 * A parameter ``vlan_type`` has been added to the function
 251   ``rte_eth_dev_set_vlan_ether_type``.
 252
 253 * The LPM ``next_hop`` field is extended from 8 bits to 24 bits for IPv4
 254   while keeping ABI compatibility.
 255
 256 * A new ``rte_lpm_config`` structure is used so LPM library will allocate
 257   exactly the amount of memory which is necessary to hold application’s rules.
 258   The previous ABI is kept for compatibility.
 259
 260 * The prototype for the pipeline input port, output port and table action
 261   handlers are updated: the pipeline parameter is added,
 262   the packets mask parameter has been either removed or made input-only.
 263
 264
 265 ABI Changes
 266 -----------
 267
 268 * Add a short 1-2 sentence description of the ABI change that was announced in
 269   the previous releases and made in this release. Use fixed width quotes for
 270   ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 271
 272 * The RETA entry size in ``rte_eth_rss_reta_entry64`` has been increased
 273   from 8-bit to 16-bit.
 274
 275 * The cmdline buffer size has been increase from 256 to 512.
 276
 277
 278 Shared Library Versions
 279 -----------------------
 280
 281 Update any library version updated in this release and prepend with a ``+`` sign.
 282
 283 The libraries prepended with a plus sign were incremented in this version.
 284
 285 .. code-block:: diff
 286
 287    + libethdev.so.3
 288      librte_acl.so.2
 289      librte_cfgfile.so.2
 290    + librte_cmdline.so.2
 291      librte_distributor.so.1
 292      librte_eal.so.2
 293      librte_hash.so.2
 294      librte_ip_frag.so.1
 295      librte_ivshmem.so.1
 296      librte_jobstats.so.1
 297      librte_kni.so.2
 298      librte_kvargs.so.1
 299      librte_lpm.so.2
 300      librte_mbuf.so.2
 301      librte_mempool.so.1
 302      librte_meter.so.1
 303    + librte_pipeline.so.3
 304      librte_pmd_bond.so.1
 305      librte_pmd_ring.so.2
 306      librte_port.so.2
 307      librte_power.so.1
 308      librte_reorder.so.1
 309      librte_ring.so.1
 310      librte_sched.so.1
 311      librte_table.so.2
 312      librte_timer.so.1
 313      librte_vhost.so.2