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