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