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