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 * **Added vhost-user client mode.**
  55
  56   DPDK vhost-user could be the server as well as the client. It supports
  57   server mode only before, now it also supports client mode. Client mode
  58   is enabled when ``RTE_VHOST_USER_CLIENT`` flag is set while calling
  59   ``rte_vhost_driver_register``.
  60
  61   When DPDK vhost-user restarts from normal or abnormal quit (say crash),
  62   the client mode would allow DPDK to establish the connect again.  Note
  63   that a brand new QEMU version (v2.7 or above) is needed, otherwise, the
  64   reconnect won't work.
  65
  66   DPDK vhost-user will also try to reconnect by default when
  67
  68   * the first connect fails (when QEMU is not started yet)
  69   * the connection is broken (when QEMU restarts)
  70
  71   It can be turned off if flag ``RTE_VHOST_USER_NO_RECONNECT`` is set.
  72
  73 * **Added AES-CTR support to AESNI MB PMD.**
  74
  75   Now AESNI MB PMD supports 128/192/256-bit counter mode AES encryption and
  76   decryption.
  77
  78 * **Added support of AES counter mode for Intel QuickAssist devices.**
  79
  80   Enabled support for the AES CTR algorithm for Intel QuickAssist devices.
  81   Provided support for algorithm-chaining operations.
  82
  83 * **Added KASUMI SW PMD.**
  84
  85   A new Crypto PMD has been added, which provides KASUMI F8 (UEA1) ciphering
  86   and KASUMI F9 (UIA1) hashing.
  87
  88 * **Improved IP Pipeline Application.**
  89
  90   The following features have been added to ip_pipeline application:
  91
  92   * Configure the MAC address in the routing pipeline and automatic routes
  93     updates with change in link state.
  94   * Enable RSS per network interface through the configuration file.
  95   * Streamline the CLI code.
  96
  97 * **Added keepalive enhancements.**
  98
  99   Adds support for reporting of core states other than dead to
 100   monitoring applications, enabling the support of broader liveness
 101   reporting to external processes.
 102
 103 * **Added packet capture framework.**
 104
 105   * A new library ``librte_pdump`` is added to provide packet capture API.
 106   * A new ``app/pdump`` tool is added to capture packets in DPDK.
 107
 108
 109 Resolved Issues
 110 ---------------
 111
 112 .. This section should contain bug fixes added to the relevant sections. Sample format:
 113
 114    * **code/section Fixed issue in the past tense with a full stop.**
 115
 116      Add a short 1-2 sentence description of the resolved issue in the past tense.
 117      The title should contain the code/lib section like a commit message.
 118      Add the entries in alphabetic order in the relevant sections below.
 119
 120
 121 EAL
 122 ~~~
 123
 124
 125 Drivers
 126 ~~~~~~~
 127
 128 * **i40e: Fixed vlan stripping from inner header.**
 129
 130   Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
 131   tags of the inner header will be stripped without putting vlan
 132   info to descriptor.
 133   Now this issue is fixed by disabling vlan stripping from inner header.
 134
 135
 136 Libraries
 137 ~~~~~~~~~
 138
 139 * **mbuf: Fixed refcnt update when detaching.**
 140
 141   Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
 142   mbuf's reference counter. The previous behavior was not to affect
 143   the reference counter. It lead a memory leak of the direct mbuf.
 144
 145
 146 Examples
 147 ~~~~~~~~
 148
 149
 150 Other
 151 ~~~~~
 152
 153
 154 Known Issues
 155 ------------
 156
 157 .. This section should contain new known issues in this release. Sample format:
 158
 159    * **Add title in present tense with full stop.**
 160
 161      Add a short 1-2 sentence description of the known issue in the present
 162      tense. Add information on any known workarounds.
 163
 164
 165 API Changes
 166 -----------
 167
 168 .. This section should contain API changes. Sample format:
 169
 170    * Add a short 1-2 sentence description of the API change. Use fixed width
 171      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 172
 173 * The following counters are removed from ``rte_eth_stats`` structure:
 174   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
 175   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
 176
 177 * The extended statistics are fetched by ids with ``rte_eth_xstats_get``
 178   after a lookup by name ``rte_eth_xstats_get_names``.
 179
 180 * The function ``rte_eth_dev_info_get`` fill the new fields ``nb_rx_queues``
 181   and ``nb_tx_queues`` in the structure ``rte_eth_dev_info``.
 182
 183 * The vhost function ``rte_vring_available_entries`` is renamed to
 184   ``rte_vhost_avail_entries``.
 185
 186 * All existing vhost APIs and callbacks with ``virtio_net`` struct pointer
 187   as the parameter have been changed due to the ABI refactoring mentioned
 188   below: it's replaced by ``int vid``.
 189
 190
 191 ABI Changes
 192 -----------
 193
 194 .. * Add a short 1-2 sentence description of the ABI change that was announced in
 195      the previous releases and made in this release. Use fixed width quotes for
 196      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 197
 198 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
 199   It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
 200
 201 * The ``rte_eth_dev_info`` structure has new fields ``nb_rx_queues`` and ``nb_tx_queues``
 202   to support number of queues configured by software.
 203
 204 * vhost ABI refactoring has been made: ``virtio_net`` structure is never
 205   exported to application any more. Instead, a handle, ``vid``, has been
 206   used to represent this structure internally.
 207
 208
 209 Shared Library Versions
 210 -----------------------
 211
 212 .. Update any library version updated in this release and prepend with a ``+`` sign.
 213
 214 The libraries prepended with a plus sign were incremented in this version.
 215
 216 .. code-block:: diff
 217
 218    + libethdev.so.4
 219      librte_acl.so.2
 220      librte_cfgfile.so.2
 221      librte_cmdline.so.2
 222      librte_distributor.so.1
 223      librte_eal.so.2
 224      librte_hash.so.2
 225      librte_ip_frag.so.1
 226      librte_ivshmem.so.1
 227      librte_jobstats.so.1
 228      librte_kni.so.2
 229      librte_kvargs.so.1
 230      librte_lpm.so.2
 231      librte_mbuf.so.2
 232    + librte_mempool.so.2
 233      librte_meter.so.1
 234      librte_pipeline.so.3
 235      librte_pmd_bond.so.1
 236      librte_pmd_ring.so.2
 237    + librte_port.so.3
 238      librte_power.so.1
 239      librte_reorder.so.1
 240      librte_ring.so.1
 241      librte_sched.so.1
 242      librte_table.so.2
 243      librte_timer.so.1
 244    + librte_vhost.so.3
 245
 246
 247 Tested Platforms
 248 ----------------
 249
 250 .. This section should contain a list of platforms that were tested with this
 251    release.
 252
 253    The format is:
 254
 255    #. Platform name.
 256
 257       - Platform details.
 258       - Platform details.
 259
 260
 261 Tested NICs
 262 -----------
 263
 264 .. This section should contain a list of NICs that were tested with this release.
 265
 266    The format is:
 267
 268    #. NIC name.
 269
 270       - NIC details.
 271       - NIC details.