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 * **Added floating VEB support for i40e PF driver.**
 168
 169   A "floating VEB" is a special Virtual Ethernet Bridge (VEB) which does not
 170   have an upload port, but instead is used for switching traffic between
 171   virtual functions (VFs) on a port.
 172
 173   For information on this feature,  please see the "I40E Poll Mode Driver"
 174   section of the "Network Interface Controller Drivers" document.
 175
 176
 177 Resolved Issues
 178 ---------------
 179
 180 .. This section should contain bug fixes added to the relevant sections. Sample format:
 181
 182    * **code/section Fixed issue in the past tense with a full stop.**
 183
 184      Add a short 1-2 sentence description of the resolved issue in the past tense.
 185      The title should contain the code/lib section like a commit message.
 186      Add the entries in alphabetic order in the relevant sections below.
 187
 188
 189 EAL
 190 ~~~
 191
 192
 193 Drivers
 194 ~~~~~~~
 195
 196 * **i40e: Fixed vlan stripping from inner header.**
 197
 198   Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
 199   tags of the inner header will be stripped without putting vlan
 200   info to descriptor.
 201   Now this issue is fixed by disabling vlan stripping from inner header.
 202
 203 * **i40e: Fixed the type issue of a single VLAN type.**
 204
 205   Currently, if a single VLAN header is added in a packet, it's treated
 206   as inner VLAN. But generally, a single VLAN header is treated as the
 207   outer VLAN header.
 208   This issue is fixed by changing corresponding register for single VLAN.
 209
 210
 211 Libraries
 212 ~~~~~~~~~
 213
 214 * **mbuf: Fixed refcnt update when detaching.**
 215
 216   Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
 217   mbuf's reference counter. The previous behavior was not to affect
 218   the reference counter. It lead a memory leak of the direct mbuf.
 219
 220
 221 Examples
 222 ~~~~~~~~
 223
 224
 225 Other
 226 ~~~~~
 227
 228
 229 Known Issues
 230 ------------
 231
 232 .. This section should contain new known issues in this release. Sample format:
 233
 234    * **Add title in present tense with full stop.**
 235
 236      Add a short 1-2 sentence description of the known issue in the present
 237      tense. Add information on any known workarounds.
 238
 239
 240 API Changes
 241 -----------
 242
 243 .. This section should contain API changes. Sample format:
 244
 245    * Add a short 1-2 sentence description of the API change. Use fixed width
 246      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 247
 248 * The following counters are removed from ``rte_eth_stats`` structure:
 249   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
 250   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
 251
 252 * The extended statistics are fetched by ids with ``rte_eth_xstats_get``
 253   after a lookup by name ``rte_eth_xstats_get_names``.
 254
 255 * The function ``rte_eth_dev_info_get`` fill the new fields ``nb_rx_queues``
 256   and ``nb_tx_queues`` in the structure ``rte_eth_dev_info``.
 257
 258 * The vhost function ``rte_vring_available_entries`` is renamed to
 259   ``rte_vhost_avail_entries``.
 260
 261 * All existing vhost APIs and callbacks with ``virtio_net`` struct pointer
 262   as the parameter have been changed due to the ABI refactoring mentioned
 263   below: it's replaced by ``int vid``.
 264
 265 * The function ``rte_vhost_enqueue_burst`` no longer supports concurrent enqueuing
 266   packets to the same queue.
 267
 268 * The function ``rte_eth_dev_set_mtu`` adds a new return value ``-EBUSY``, which
 269   indicates the operation is forbidden because the port is running.
 270
 271
 272 ABI Changes
 273 -----------
 274
 275 .. * Add a short 1-2 sentence description of the ABI change that was announced in
 276      the previous releases and made in this release. Use fixed width quotes for
 277      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 278
 279 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
 280   It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
 281
 282 * The ``rte_eth_dev_info`` structure has new fields ``nb_rx_queues`` and ``nb_tx_queues``
 283   to support number of queues configured by software.
 284
 285 * vhost ABI refactoring has been made: ``virtio_net`` structure is never
 286   exported to application any more. Instead, a handle, ``vid``, has been
 287   used to represent this structure internally.
 288
 289
 290 Shared Library Versions
 291 -----------------------
 292
 293 .. Update any library version updated in this release and prepend with a ``+`` sign.
 294
 295 The libraries prepended with a plus sign were incremented in this version.
 296
 297 .. code-block:: diff
 298
 299    + libethdev.so.4
 300      librte_acl.so.2
 301      librte_cfgfile.so.2
 302      librte_cmdline.so.2
 303      librte_distributor.so.1
 304      librte_eal.so.2
 305      librte_hash.so.2
 306      librte_ip_frag.so.1
 307      librte_ivshmem.so.1
 308      librte_jobstats.so.1
 309      librte_kni.so.2
 310      librte_kvargs.so.1
 311      librte_lpm.so.2
 312      librte_mbuf.so.2
 313    + librte_mempool.so.2
 314      librte_meter.so.1
 315      librte_pipeline.so.3
 316      librte_pmd_bond.so.1
 317      librte_pmd_ring.so.2
 318    + librte_port.so.3
 319      librte_power.so.1
 320      librte_reorder.so.1
 321      librte_ring.so.1
 322      librte_sched.so.1
 323      librte_table.so.2
 324      librte_timer.so.1
 325    + librte_vhost.so.3
 326
 327
 328 Tested Platforms
 329 ----------------
 330
 331 .. This section should contain a list of platforms that were tested with this
 332    release.
 333
 334    The format is:
 335
 336    #. Platform name.
 337
 338       - Platform details.
 339       - Platform details.
 340
 341
 342 Tested NICs
 343 -----------
 344
 345 .. This section should contain a list of NICs that were tested with this release.
 346
 347    The format is:
 348
 349    #. NIC name.
 350
 351       - NIC details.
 352       - NIC details.