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 * **Enabled bulk allocation of mbufs.**
  39
  40   A new function ``rte_pktmbuf_alloc_bulk()`` has been added to allow the user
  41   to allocate a bulk of mbufs.
  42
  43 * **Virtio 1.0.**
  44
  45   Enabled virtio 1.0 support for virtio pmd driver.
  46
  47 * **Supported virtio for ARM.**
  48
  49   Enabled virtio support for armv7/v8. Tested for arm64.
  50   Virtio for arm support VFIO-noiommu mode only.
  51   Virtio can work with other non-x86 arch too like powerpc.
  52
  53 * **Supported virtio offload in vhost-user.**
  54
  55   Add the offload and negotiation of checksum and TSO between vhost-user and
  56   vanilla Linux virtio guest.
  57
  58 * **Added vhost-user live migration support.**
  59
  60 * **Enabled PCI extended tag for i40e.**
  61
  62   It enabled extended tag by checking and writing corresponding PCI config
  63   space bytes, to boost the performance. In the meanwhile, it deprecated the
  64   legacy way via reading/writing sysfile supported by kernel module igb_uio.
  65
  66
  67 Resolved Issues
  68 ---------------
  69
  70 This section should contain bug fixes added to the relevant sections. Sample format:
  71
  72 * **code/section: Fixed issue in the past tense with a full stop.**
  73
  74   Add a short 1-2 sentence description of the resolved issue in the past tense.
  75   The title should contain the code/lib section like a commit message.
  76   Add the entries in alphabetic order in the relevant sections below.
  77
  78
  79 EAL
  80 ~~~
  81
  82
  83 Drivers
  84 ~~~~~~~
  85
  86 * **ethdev: Fixed byte order consistency between fdir flow and mask.**
  87
  88   Fixed issue in ethdev library that the structure for setting
  89   fdir's mask and flow entry was not consistent in byte ordering.
  90
  91 * **aesni_mb: Fixed wrong return value when creating a device.**
  92
  93   cryptodev_aesni_mb_init() was returning the device id of the device created,
  94   instead of 0 (when success), that rte_eal_vdev_init() expects.
  95   This made impossible the creation of more than one aesni_mb device
  96   from command line.
  97
  98
  99 Libraries
 100 ~~~~~~~~~
 101
 102 * **hash: Fixed CRC32c hash computation for non multiple of 4 bytes sizes.**
 103
 104   Fix crc32c hash functions to return a valid crc32c value for data lengths
 105   not multiple of 4 bytes.
 106
 107
 108 Examples
 109 ~~~~~~~~
 110
 111 * **examples/vhost: Fixed frequent mbuf allocation failure.**
 112
 113   vhost-switch often fails to allocate mbuf when dequeue from vring because it
 114   wrongly calculates the number of mbufs needed.
 115
 116
 117 Other
 118 ~~~~~
 119
 120
 121 Known Issues
 122 ------------
 123
 124 This section should contain new known issues in this release. Sample format:
 125
 126 * **Add title in present tense with full stop.**
 127
 128   Add a short 1-2 sentence description of the known issue in the present
 129   tense. Add information on any known workarounds.
 130
 131
 132 API Changes
 133 -----------
 134
 135 This section should contain API changes. Sample format:
 136
 137 * Add a short 1-2 sentence description of the API change. Use fixed width
 138   quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 139
 140
 141 ABI Changes
 142 -----------
 143
 144 * Add a short 1-2 sentence description of the ABI change that was announced in
 145   the previous releases and made in this release. Use fixed width quotes for
 146   ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 147
 148 * The fields in ethdev structure ``rte_eth_fdir_masks`` were changed
 149   to be in big endian.
 150
 151
 152 Shared Library Versions
 153 -----------------------
 154
 155 Update any library version updated in this release and prepend with a ``+`` sign.
 156
 157 The libraries prepended with a plus sign were incremented in this version.
 158
 159 .. code-block:: diff
 160
 161      libethdev.so.2
 162      librte_acl.so.2
 163      librte_cfgfile.so.2
 164      librte_cmdline.so.1
 165      librte_distributor.so.1
 166      librte_eal.so.2
 167      librte_hash.so.2
 168      librte_ip_frag.so.1
 169      librte_ivshmem.so.1
 170      librte_jobstats.so.1
 171      librte_kni.so.2
 172      librte_kvargs.so.1
 173      librte_lpm.so.2
 174      librte_mbuf.so.2
 175      librte_mempool.so.1
 176      librte_meter.so.1
 177      librte_pipeline.so.2
 178      librte_pmd_bond.so.1
 179      librte_pmd_ring.so.2
 180      librte_port.so.2
 181      librte_power.so.1
 182      librte_reorder.so.1
 183      librte_ring.so.1
 184      librte_sched.so.1
 185      librte_table.so.2
 186      librte_timer.so.1
 187      librte_vhost.so.2