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