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