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