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