doc/guides/rel_notes/release_16_07.rst

   1 DPDK Release 16.07
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text below explains how to update the release notes.
   7
   8    Use proper spelling, capitalization and punctuation in all sections.
   9
  10    Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
  11
  12    Build the docs and view the output file to ensure the changes are correct::
  13
  14       make doc-guides-html
  15
  16       firefox build/doc/html/guides/rel_notes/release_16_07.html
  17
  18
  19 New Features
  20 ------------
  21
  22 .. This section should contain new features added in this release. Sample format:
  23
  24    * **Add a title in the past tense with a full stop.**
  25
  26      Add a short 1-2 sentence description in the past tense. The description
  27      should be enough to allow someone scanning the release notes to understand
  28      the new feature.
  29
  30      If the feature adds a lot of sub-features you can use a bullet list like this.
  31
  32      * Added feature foo to do something.
  33      * Enhanced feature bar to do something else.
  34
  35      Refer to the previous release notes for examples.
  36
  37 * **Removed mempool cache if not needed.**
  38
  39   The size of the mempool structure is reduced if the per-lcore cache is disabled.
  40
  41 * **Changed the memory allocation in mempool library.**
  42
  43   * Added ability to allocate a large mempool in virtually fragmented memory.
  44   * Added new APIs to populate a mempool with memory.
  45   * Added an API to free a mempool.
  46   * Modified the API of rte_mempool_obj_iter() function.
  47   * Dropped specific Xen Dom0 code.
  48   * Dropped specific anonymous mempool code in testpmd.
  49
  50 * **Supported virtio on IBM POWER8.**
  51
  52   The ioports are mapped in memory when using Linux UIO.
  53
  54 * **Virtio support for containers.**
  55
  56   Add a new virtual device, named virtio-user, to support virtio for containers.
  57
  58   Known limitations:
  59
  60   * Control queue and multi-queue are not supported yet.
  61   * Cannot work with --huge-unlink.
  62   * Cannot work with --no-huge.
  63   * Cannot work when there are more than VHOST_MEMORY_MAX_NREGIONS(8) hugepages.
  64   * Root privilege is a must for sorting hugepages by physical address.
  65   * Can only be used with vhost user backend.
  66
  67 * **Added vhost-user client mode.**
  68
  69   DPDK vhost-user could be the server as well as the client. It supports
  70   server mode only before, now it also supports client mode. Client mode
  71   is enabled when ``RTE_VHOST_USER_CLIENT`` flag is set while calling
  72   ``rte_vhost_driver_register``.
  73
  74   When DPDK vhost-user restarts from normal or abnormal quit (say crash),
  75   the client mode would allow DPDK to establish the connect again.  Note
  76   that a brand new QEMU version (v2.7 or above) is needed, otherwise, the
  77   reconnect won't work.
  78
  79   DPDK vhost-user will also try to reconnect by default when
  80
  81   * the first connect fails (when QEMU is not started yet)
  82   * the connection is broken (when QEMU restarts)
  83
  84   It can be turned off if flag ``RTE_VHOST_USER_NO_RECONNECT`` is set.
  85
  86 * **Added AES-CTR support to AESNI MB PMD.**
  87
  88   Now AESNI MB PMD supports 128/192/256-bit counter mode AES encryption and
  89   decryption.
  90
  91 * **Added support of AES counter mode for Intel QuickAssist devices.**
  92
  93   Enabled support for the AES CTR algorithm for Intel QuickAssist devices.
  94   Provided support for algorithm-chaining operations.
  95
  96 * **Added KASUMI SW PMD.**
  97
  98   A new Crypto PMD has been added, which provides KASUMI F8 (UEA1) ciphering
  99   and KASUMI F9 (UIA1) hashing.
 100
 101 * **Improved IP Pipeline Application.**
 102
 103   The following features have been added to ip_pipeline application:
 104
 105   * Configure the MAC address in the routing pipeline and automatic routes
 106     updates with change in link state.
 107   * Enable RSS per network interface through the configuration file.
 108   * Streamline the CLI code.
 109
 110 * **Added keepalive enhancements.**
 111
 112   Adds support for reporting of core states other than dead to
 113   monitoring applications, enabling the support of broader liveness
 114   reporting to external processes.
 115
 116 * **Added packet capture framework.**
 117
 118   * A new library ``librte_pdump`` is added to provide packet capture API.
 119   * A new ``app/pdump`` tool is added to capture packets in DPDK.
 120
 121
 122 Resolved Issues
 123 ---------------
 124
 125 .. This section should contain bug fixes added to the relevant sections. Sample format:
 126
 127    * **code/section Fixed issue in the past tense with a full stop.**
 128
 129      Add a short 1-2 sentence description of the resolved issue in the past tense.
 130      The title should contain the code/lib section like a commit message.
 131      Add the entries in alphabetic order in the relevant sections below.
 132
 133
 134 EAL
 135 ~~~
 136
 137
 138 Drivers
 139 ~~~~~~~
 140
 141 * **i40e: Fixed vlan stripping from inner header.**
 142
 143   Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
 144   tags of the inner header will be stripped without putting vlan
 145   info to descriptor.
 146   Now this issue is fixed by disabling vlan stripping from inner header.
 147
 148
 149 Libraries
 150 ~~~~~~~~~
 151
 152 * **mbuf: Fixed refcnt update when detaching.**
 153
 154   Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
 155   mbuf's reference counter. The previous behavior was not to affect
 156   the reference counter. It lead a memory leak of the direct mbuf.
 157
 158
 159 Examples
 160 ~~~~~~~~
 161
 162
 163 Other
 164 ~~~~~
 165
 166
 167 Known Issues
 168 ------------
 169
 170 .. This section should contain new known issues in this release. Sample format:
 171
 172    * **Add title in present tense with full stop.**
 173
 174      Add a short 1-2 sentence description of the known issue in the present
 175      tense. Add information on any known workarounds.
 176
 177
 178 API Changes
 179 -----------
 180
 181 .. This section should contain API changes. Sample format:
 182
 183    * Add a short 1-2 sentence description of the API change. Use fixed width
 184      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 185
 186 * The following counters are removed from ``rte_eth_stats`` structure:
 187   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
 188   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
 189
 190 * The extended statistics are fetched by ids with ``rte_eth_xstats_get``
 191   after a lookup by name ``rte_eth_xstats_get_names``.
 192
 193 * The function ``rte_eth_dev_info_get`` fill the new fields ``nb_rx_queues``
 194   and ``nb_tx_queues`` in the structure ``rte_eth_dev_info``.
 195
 196 * The vhost function ``rte_vring_available_entries`` is renamed to
 197   ``rte_vhost_avail_entries``.
 198
 199 * All existing vhost APIs and callbacks with ``virtio_net`` struct pointer
 200   as the parameter have been changed due to the ABI refactoring mentioned
 201   below: it's replaced by ``int vid``.
 202
 203 * The function ``rte_vhost_enqueue_burst`` no longer supports concurrent enqueuing
 204   packets to the same queue.
 205
 206
 207 ABI Changes
 208 -----------
 209
 210 .. * Add a short 1-2 sentence description of the ABI change that was announced in
 211      the previous releases and made in this release. Use fixed width quotes for
 212      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 213
 214 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
 215   It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
 216
 217 * The ``rte_eth_dev_info`` structure has new fields ``nb_rx_queues`` and ``nb_tx_queues``
 218   to support number of queues configured by software.
 219
 220 * vhost ABI refactoring has been made: ``virtio_net`` structure is never
 221   exported to application any more. Instead, a handle, ``vid``, has been
 222   used to represent this structure internally.
 223
 224
 225 Shared Library Versions
 226 -----------------------
 227
 228 .. Update any library version updated in this release and prepend with a ``+`` sign.
 229
 230 The libraries prepended with a plus sign were incremented in this version.
 231
 232 .. code-block:: diff
 233
 234    + libethdev.so.4
 235      librte_acl.so.2
 236      librte_cfgfile.so.2
 237      librte_cmdline.so.2
 238      librte_distributor.so.1
 239      librte_eal.so.2
 240      librte_hash.so.2
 241      librte_ip_frag.so.1
 242      librte_ivshmem.so.1
 243      librte_jobstats.so.1
 244      librte_kni.so.2
 245      librte_kvargs.so.1
 246      librte_lpm.so.2
 247      librte_mbuf.so.2
 248    + librte_mempool.so.2
 249      librte_meter.so.1
 250      librte_pipeline.so.3
 251      librte_pmd_bond.so.1
 252      librte_pmd_ring.so.2
 253    + librte_port.so.3
 254      librte_power.so.1
 255      librte_reorder.so.1
 256      librte_ring.so.1
 257      librte_sched.so.1
 258      librte_table.so.2
 259      librte_timer.so.1
 260    + librte_vhost.so.3
 261
 262
 263 Tested Platforms
 264 ----------------
 265
 266 .. This section should contain a list of platforms that were tested with this
 267    release.
 268
 269    The format is:
 270
 271    #. Platform name.
 272
 273       - Platform details.
 274       - Platform details.
 275
 276
 277 Tested NICs
 278 -----------
 279
 280 .. This section should contain a list of NICs that were tested with this release.
 281
 282    The format is:
 283
 284    #. NIC name.
 285
 286       - NIC details.
 287       - NIC details.