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 * **igb_uio: Fixed possible mmap failure for Linux >= 4.5.**
 199
 200   mmaping the iomem range of the PCI device fails for kernels that
 201   enabled CONFIG_IO_STRICT_DEVMEM option:
 202
 203   EAL: pci_map_resource():
 204            cannot mmap(39, 0x7f1c51800000, 0x100000, 0x0):
 205            Invalid argument (0xffffffffffffffff)
 206
 207   CONFIG_IO_STRICT_DEVMEM is introduced in Linux v4.5
 208
 209   Updated igb_uio to stop reserving PCI memory resources, from
 210   kernel point of view iomem region looks like idle and mmap worked
 211   again. This matches uio_pci_generic usage.
 212
 213
 214 Drivers
 215 ~~~~~~~
 216
 217 * **i40e: Fixed vlan stripping from inner header.**
 218
 219   Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
 220   tags of the inner header will be stripped without putting vlan
 221   info to descriptor.
 222   Now this issue is fixed by disabling vlan stripping from inner header.
 223
 224 * **i40e: Fixed the type issue of a single VLAN type.**
 225
 226   Currently, if a single VLAN header is added in a packet, it's treated
 227   as inner VLAN. But generally, a single VLAN header is treated as the
 228   outer VLAN header.
 229   This issue is fixed by changing corresponding register for single VLAN.
 230
 231
 232 Libraries
 233 ~~~~~~~~~
 234
 235 * **mbuf: Fixed refcnt update when detaching.**
 236
 237   Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
 238   mbuf's reference counter. The previous behavior was not to affect
 239   the reference counter. It lead a memory leak of the direct mbuf.
 240
 241
 242 Examples
 243 ~~~~~~~~
 244
 245
 246 Other
 247 ~~~~~
 248
 249
 250 Known Issues
 251 ------------
 252
 253 .. This section should contain new known issues in this release. Sample format:
 254
 255    * **Add title in present tense with full stop.**
 256
 257      Add a short 1-2 sentence description of the known issue in the present
 258      tense. Add information on any known workarounds.
 259
 260
 261 API Changes
 262 -----------
 263
 264 .. This section should contain API changes. Sample format:
 265
 266    * Add a short 1-2 sentence description of the API change. Use fixed width
 267      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 268
 269 * The following counters are removed from ``rte_eth_stats`` structure:
 270   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
 271   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
 272
 273 * The extended statistics are fetched by ids with ``rte_eth_xstats_get``
 274   after a lookup by name ``rte_eth_xstats_get_names``.
 275
 276 * The function ``rte_eth_dev_info_get`` fill the new fields ``nb_rx_queues``
 277   and ``nb_tx_queues`` in the structure ``rte_eth_dev_info``.
 278
 279 * The vhost function ``rte_vring_available_entries`` is renamed to
 280   ``rte_vhost_avail_entries``.
 281
 282 * All existing vhost APIs and callbacks with ``virtio_net`` struct pointer
 283   as the parameter have been changed due to the ABI refactoring mentioned
 284   below: it's replaced by ``int vid``.
 285
 286 * The function ``rte_vhost_enqueue_burst`` no longer supports concurrent enqueuing
 287   packets to the same queue.
 288
 289 * The function ``rte_eth_dev_set_mtu`` adds a new return value ``-EBUSY``, which
 290   indicates the operation is forbidden because the port is running.
 291
 292
 293 ABI Changes
 294 -----------
 295
 296 .. * Add a short 1-2 sentence description of the ABI change that was announced in
 297      the previous releases and made in this release. Use fixed width quotes for
 298      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 299
 300 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
 301   It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
 302
 303 * The ``rte_eth_dev_info`` structure has new fields ``nb_rx_queues`` and ``nb_tx_queues``
 304   to support number of queues configured by software.
 305
 306 * vhost ABI refactoring has been made: ``virtio_net`` structure is never
 307   exported to application any more. Instead, a handle, ``vid``, has been
 308   used to represent this structure internally.
 309
 310
 311 Shared Library Versions
 312 -----------------------
 313
 314 .. Update any library version updated in this release and prepend with a ``+`` sign.
 315
 316 The libraries prepended with a plus sign were incremented in this version.
 317
 318 .. code-block:: diff
 319
 320    + libethdev.so.4
 321      librte_acl.so.2
 322      librte_cfgfile.so.2
 323      librte_cmdline.so.2
 324      librte_distributor.so.1
 325      librte_eal.so.2
 326      librte_hash.so.2
 327      librte_ip_frag.so.1
 328      librte_ivshmem.so.1
 329      librte_jobstats.so.1
 330      librte_kni.so.2
 331      librte_kvargs.so.1
 332      librte_lpm.so.2
 333      librte_mbuf.so.2
 334    + librte_mempool.so.2
 335      librte_meter.so.1
 336      librte_pipeline.so.3
 337      librte_pmd_bond.so.1
 338      librte_pmd_ring.so.2
 339    + librte_port.so.3
 340      librte_power.so.1
 341      librte_reorder.so.1
 342      librte_ring.so.1
 343      librte_sched.so.1
 344      librte_table.so.2
 345      librte_timer.so.1
 346    + librte_vhost.so.3
 347
 348
 349 Tested Platforms
 350 ----------------
 351
 352 .. This section should contain a list of platforms that were tested with this
 353    release.
 354
 355    The format is:
 356
 357    #. Platform name.
 358
 359       - Platform details.
 360       - Platform details.
 361
 362
 363 Tested NICs
 364 -----------
 365
 366 .. This section should contain a list of NICs that were tested with this release.
 367
 368    The format is:
 369
 370    #. NIC name.
 371
 372       - NIC details.
 373       - NIC details.