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