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