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 * **Enabled PCI extended tag for i40e.**
  68
  69   It enabled extended tag by checking and writing corresponding PCI config
  70   space bytes, to boost the performance. In the meanwhile, it deprecated the
  71   legacy way via reading/writing sysfile supported by kernel module igb_uio.
  72
  73 * **Supported ether type setting of single and double VLAN for i40e**
  74
  75 * **Increased number of next hops for LPM IPv4 to 2^24.**
  76
  77   The next_hop field is extended from 8 bits to 24 bits for IPv4.
  78
  79 * **Added support of SNOW 3G (UEA2 and UIA2) for Intel Quick Assist devices.**
  80
  81   Enabled support for SNOW 3G wireless algorithm for Intel Quick Assist devices.
  82   Support for cipher only, hash only is also provided
  83   along with alg-chaining operations.
  84
  85 * **Added SNOW3G SW PMD.**
  86
  87   A new Crypto PMD has been added, which provides SNOW 3G UEA2 ciphering
  88   and SNOW3G UIA2 hashing.
  89
  90 * **Added AES GCM PMD.**
  91
  92   Added new Crypto PMD to support AES-GCM authenticated encryption and
  93   authenticated decryption in SW.
  94
  95 * **Added NULL Crypto PMD**
  96
  97   Added new Crypto PMD to support null crypto operations in SW.
  98
  99 Resolved Issues
 100 ---------------
 101
 102 This section should contain bug fixes added to the relevant sections. Sample format:
 103
 104 * **code/section: Fixed issue in the past tense with a full stop.**
 105
 106   Add a short 1-2 sentence description of the resolved issue in the past tense.
 107   The title should contain the code/lib section like a commit message.
 108   Add the entries in alphabetic order in the relevant sections below.
 109
 110
 111 EAL
 112 ~~~
 113
 114
 115 Drivers
 116 ~~~~~~~
 117
 118 * **ethdev: Fixed byte order consistency between fdir flow and mask.**
 119
 120   Fixed issue in ethdev library that the structure for setting
 121   fdir's mask and flow entry was not consistent in byte ordering.
 122
 123 * **aesni_mb: Fixed wrong return value when creating a device.**
 124
 125   cryptodev_aesni_mb_init() was returning the device id of the device created,
 126   instead of 0 (when success), that rte_eal_vdev_init() expects.
 127   This made impossible the creation of more than one aesni_mb device
 128   from command line.
 129
 130 * **qat: Fixed AES GCM decryption.**
 131
 132   Allowed AES GCM on the cryptodev API, but in some cases gave invalid results
 133   due to incorrect IV setting.
 134
 135
 136 Libraries
 137 ~~~~~~~~~
 138
 139 * **hash: Fixed CRC32c hash computation for non multiple of 4 bytes sizes.**
 140
 141   Fix crc32c hash functions to return a valid crc32c value for data lengths
 142   not multiple of 4 bytes.
 143
 144
 145 Examples
 146 ~~~~~~~~
 147
 148 * **examples/vhost: Fixed frequent mbuf allocation failure.**
 149
 150   vhost-switch often fails to allocate mbuf when dequeue from vring because it
 151   wrongly calculates the number of mbufs needed.
 152
 153 * **examples/ipsec-secgw: ipsec security gateway**
 154
 155   New application implementing an IPsec Security Gateway.
 156
 157 Other
 158 ~~~~~
 159
 160
 161 Known Issues
 162 ------------
 163
 164 This section should contain new known issues in this release. Sample format:
 165
 166 * **Add title in present tense with full stop.**
 167
 168   Add a short 1-2 sentence description of the known issue in the present
 169   tense. Add information on any known workarounds.
 170
 171
 172 API Changes
 173 -----------
 174
 175 This section should contain API changes. Sample format:
 176
 177 * Add a short 1-2 sentence description of the API change. Use fixed width
 178   quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 179
 180 * The fields in ethdev structure ``rte_eth_fdir_masks`` were changed
 181   to be in big endian.
 182
 183 * A parameter ``vlan_type`` has been added to the function
 184   ``rte_eth_dev_set_vlan_ether_type``.
 185
 186 * The LPM ``next_hop`` field is extended from 8 bits to 24 bits for IPv4
 187   while keeping ABI compatibility.
 188
 189 * A new ``rte_lpm_config`` structure is used so LPM library will allocate
 190   exactly the amount of memory which is necessary to hold application’s rules.
 191   The previous ABI is kept for compatibility.
 192
 193 * The prototype for the pipeline input port, output port and table action
 194   handlers are updated: the pipeline parameter is added,
 195   the packets mask parameter has been either removed or made input-only.
 196
 197
 198 ABI Changes
 199 -----------
 200
 201 * Add a short 1-2 sentence description of the ABI change that was announced in
 202   the previous releases and made in this release. Use fixed width quotes for
 203   ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 204
 205 * The RETA entry size in ``rte_eth_rss_reta_entry64`` has been increased
 206   from 8-bit to 16-bit.
 207
 208 * The cmdline buffer size has been increase from 256 to 512.
 209
 210
 211 Shared Library Versions
 212 -----------------------
 213
 214 Update any library version updated in this release and prepend with a ``+`` sign.
 215
 216 The libraries prepended with a plus sign were incremented in this version.
 217
 218 .. code-block:: diff
 219
 220    + libethdev.so.3
 221      librte_acl.so.2
 222      librte_cfgfile.so.2
 223    + librte_cmdline.so.2
 224      librte_distributor.so.1
 225      librte_eal.so.2
 226      librte_hash.so.2
 227      librte_ip_frag.so.1
 228      librte_ivshmem.so.1
 229      librte_jobstats.so.1
 230      librte_kni.so.2
 231      librte_kvargs.so.1
 232      librte_lpm.so.2
 233      librte_mbuf.so.2
 234      librte_mempool.so.1
 235      librte_meter.so.1
 236    + librte_pipeline.so.3
 237      librte_pmd_bond.so.1
 238      librte_pmd_ring.so.2
 239      librte_port.so.2
 240      librte_power.so.1
 241      librte_reorder.so.1
 242      librte_ring.so.1
 243      librte_sched.so.1
 244      librte_table.so.2
 245      librte_timer.so.1
 246      librte_vhost.so.2