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