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