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 * **Added new driver for Broadcom NetXtreme-C devices.**
  51
  52   Added the new bnxt driver for Broadcom NetXtreme-C devices. See the
  53   "Network Interface Controller Drivers" document for more details on this
  54   new driver.
  55
  56 * **Added new driver for ThunderX nicvf device.**
  57
  58 * **Added mailbox interrupt support for ixgbe and igb VFs.**
  59
  60   When the physical NIC link comes down or up, the PF driver will send a
  61   mailbox message to notify each VF. To handle this link up/down event,
  62   add mailbox interrupts support to receive the message and allow the app to
  63   register a callback for it.
  64
  65 * **Updated the i40e base driver.**
  66
  67   Updated the i40e base driver, which includes support for new devices IDs.
  68
  69 * **Supported virtio on IBM POWER8.**
  70
  71   The ioports are mapped in memory when using Linux UIO.
  72
  73 * **Virtio support for containers.**
  74
  75   Add a new virtual device, named virtio-user, to support virtio for containers.
  76
  77   Known limitations:
  78
  79   * Control queue and multi-queue are not supported yet.
  80   * Cannot work with --huge-unlink.
  81   * Cannot work with --no-huge.
  82   * Cannot work when there are more than VHOST_MEMORY_MAX_NREGIONS(8) hugepages.
  83   * Root privilege is a must for sorting hugepages by physical address.
  84   * Can only be used with vhost user backend.
  85
  86 * **Added vhost-user client mode.**
  87
  88   DPDK vhost-user could be the server as well as the client. It supports
  89   server mode only before, now it also supports client mode. Client mode
  90   is enabled when ``RTE_VHOST_USER_CLIENT`` flag is set while calling
  91   ``rte_vhost_driver_register``.
  92
  93   When DPDK vhost-user restarts from normal or abnormal quit (say crash),
  94   the client mode would allow DPDK to establish the connect again.  Note
  95   that a brand new QEMU version (v2.7 or above) is needed, otherwise, the
  96   reconnect won't work.
  97
  98   DPDK vhost-user will also try to reconnect by default when
  99
 100   * the first connect fails (when QEMU is not started yet)
 101   * the connection is broken (when QEMU restarts)
 102
 103   It can be turned off if flag ``RTE_VHOST_USER_NO_RECONNECT`` is set.
 104
 105 * **Added NSH packet recognition in i40e.**
 106
 107 * **Added AES-CTR support to AESNI MB PMD.**
 108
 109   Now AESNI MB PMD supports 128/192/256-bit counter mode AES encryption and
 110   decryption.
 111
 112 * **Added support of AES counter mode for Intel QuickAssist devices.**
 113
 114   Enabled support for the AES CTR algorithm for Intel QuickAssist devices.
 115   Provided support for algorithm-chaining operations.
 116
 117 * **Added KASUMI SW PMD.**
 118
 119   A new Crypto PMD has been added, which provides KASUMI F8 (UEA1) ciphering
 120   and KASUMI F9 (UIA1) hashing.
 121
 122 * **Added multi-writer support for RTE Hash with Intel TSX.**
 123
 124   The following features/modifications have been added to rte_hash library:
 125
 126   * Enabled application developers to use an extra flag for rte_hash creation
 127     to specify default behavior (multi-thread safe/unsafe) with rte_hash_add_key
 128     function.
 129   * Changed Cuckoo search algorithm to breadth first search for multi-writer
 130     routine and split Cuckoo Search and Move operations in order to reduce
 131     transactional code region and improve TSX performance.
 132   * Added a hash multi-writer test case for test app.
 133
 134 * **Improved IP Pipeline Application.**
 135
 136   The following features have been added to ip_pipeline application:
 137
 138   * Configure the MAC address in the routing pipeline and automatic routes
 139     updates with change in link state.
 140   * Enable RSS per network interface through the configuration file.
 141   * Streamline the CLI code.
 142
 143 * **Added keepalive enhancements.**
 144
 145   Adds support for reporting of core states other than dead to
 146   monitoring applications, enabling the support of broader liveness
 147   reporting to external processes.
 148
 149 * **Added packet capture framework.**
 150
 151   * A new library ``librte_pdump`` is added to provide packet capture API.
 152   * A new ``app/pdump`` tool is added to capture packets in DPDK.
 153
 154
 155 Resolved Issues
 156 ---------------
 157
 158 .. This section should contain bug fixes added to the relevant sections. Sample format:
 159
 160    * **code/section Fixed issue in the past tense with a full stop.**
 161
 162      Add a short 1-2 sentence description of the resolved issue in the past tense.
 163      The title should contain the code/lib section like a commit message.
 164      Add the entries in alphabetic order in the relevant sections below.
 165
 166
 167 EAL
 168 ~~~
 169
 170
 171 Drivers
 172 ~~~~~~~
 173
 174 * **i40e: Fixed vlan stripping from inner header.**
 175
 176   Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
 177   tags of the inner header will be stripped without putting vlan
 178   info to descriptor.
 179   Now this issue is fixed by disabling vlan stripping from inner header.
 180
 181 * **i40e: Fixed the type issue of a single VLAN type.**
 182
 183   Currently, if a single VLAN header is added in a packet, it's treated
 184   as inner VLAN. But generally, a single VLAN header is treated as the
 185   outer VLAN header.
 186   This issue is fixed by changing corresponding register for single VLAN.
 187
 188
 189 Libraries
 190 ~~~~~~~~~
 191
 192 * **mbuf: Fixed refcnt update when detaching.**
 193
 194   Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
 195   mbuf's reference counter. The previous behavior was not to affect
 196   the reference counter. It lead a memory leak of the direct mbuf.
 197
 198
 199 Examples
 200 ~~~~~~~~
 201
 202
 203 Other
 204 ~~~~~
 205
 206
 207 Known Issues
 208 ------------
 209
 210 .. This section should contain new known issues in this release. Sample format:
 211
 212    * **Add title in present tense with full stop.**
 213
 214      Add a short 1-2 sentence description of the known issue in the present
 215      tense. Add information on any known workarounds.
 216
 217
 218 API Changes
 219 -----------
 220
 221 .. This section should contain API changes. Sample format:
 222
 223    * Add a short 1-2 sentence description of the API change. Use fixed width
 224      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 225
 226 * The following counters are removed from ``rte_eth_stats`` structure:
 227   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
 228   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
 229
 230 * The extended statistics are fetched by ids with ``rte_eth_xstats_get``
 231   after a lookup by name ``rte_eth_xstats_get_names``.
 232
 233 * The function ``rte_eth_dev_info_get`` fill the new fields ``nb_rx_queues``
 234   and ``nb_tx_queues`` in the structure ``rte_eth_dev_info``.
 235
 236 * The vhost function ``rte_vring_available_entries`` is renamed to
 237   ``rte_vhost_avail_entries``.
 238
 239 * All existing vhost APIs and callbacks with ``virtio_net`` struct pointer
 240   as the parameter have been changed due to the ABI refactoring mentioned
 241   below: it's replaced by ``int vid``.
 242
 243 * The function ``rte_vhost_enqueue_burst`` no longer supports concurrent enqueuing
 244   packets to the same queue.
 245
 246 * The function ``rte_eth_dev_set_mtu`` adds a new return value ``-EBUSY``, which
 247   indicates the operation is forbidden because the port is running.
 248
 249
 250 ABI Changes
 251 -----------
 252
 253 .. * Add a short 1-2 sentence description of the ABI change that was announced in
 254      the previous releases and made in this release. Use fixed width quotes for
 255      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 256
 257 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
 258   It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
 259
 260 * The ``rte_eth_dev_info`` structure has new fields ``nb_rx_queues`` and ``nb_tx_queues``
 261   to support number of queues configured by software.
 262
 263 * vhost ABI refactoring has been made: ``virtio_net`` structure is never
 264   exported to application any more. Instead, a handle, ``vid``, has been
 265   used to represent this structure internally.
 266
 267
 268 Shared Library Versions
 269 -----------------------
 270
 271 .. Update any library version updated in this release and prepend with a ``+`` sign.
 272
 273 The libraries prepended with a plus sign were incremented in this version.
 274
 275 .. code-block:: diff
 276
 277    + libethdev.so.4
 278      librte_acl.so.2
 279      librte_cfgfile.so.2
 280      librte_cmdline.so.2
 281      librte_distributor.so.1
 282      librte_eal.so.2
 283      librte_hash.so.2
 284      librte_ip_frag.so.1
 285      librte_ivshmem.so.1
 286      librte_jobstats.so.1
 287      librte_kni.so.2
 288      librte_kvargs.so.1
 289      librte_lpm.so.2
 290      librte_mbuf.so.2
 291    + librte_mempool.so.2
 292      librte_meter.so.1
 293      librte_pipeline.so.3
 294      librte_pmd_bond.so.1
 295      librte_pmd_ring.so.2
 296    + librte_port.so.3
 297      librte_power.so.1
 298      librte_reorder.so.1
 299      librte_ring.so.1
 300      librte_sched.so.1
 301      librte_table.so.2
 302      librte_timer.so.1
 303    + librte_vhost.so.3
 304
 305
 306 Tested Platforms
 307 ----------------
 308
 309 .. This section should contain a list of platforms that were tested with this
 310    release.
 311
 312    The format is:
 313
 314    #. Platform name.
 315
 316       - Platform details.
 317       - Platform details.
 318
 319
 320 Tested NICs
 321 -----------
 322
 323 .. This section should contain a list of NICs that were tested with this release.
 324
 325    The format is:
 326
 327    #. NIC name.
 328
 329       - NIC details.
 330       - NIC details.