doc/guides/rel_notes/release_17_11.rst

   1 DPDK Release 17.11
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text in the sections 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:
  11    ``LIKE_THIS``.
  12
  13    Build the docs and view the output file to ensure the changes are correct::
  14
  15       make doc-guides-html
  16
  17       xdg-open build/doc/html/guides/rel_notes/release_17_11.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release. Sample
  24    format:
  25
  26    * **Add a title in the past tense with a full stop.**
  27
  28      Add a short 1-2 sentence description in the past tense. The description
  29      should be enough to allow someone scanning the release notes to
  30      understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list like
  33      this:
  34
  35      * Added feature foo to do something.
  36      * Enhanced feature bar to do something else.
  37
  38      Refer to the previous release notes for examples.
  39
  40      This section is a comment. do not overwrite or remove it.
  41      Also, make sure to start the actual text at the margin.
  42      =========================================================
  43
  44 * **Extended port_id range from uint8_t to uint16_t.**
  45
  46   Increased port_id range from 8 bits to 16 bits in order to support more than
  47   256 ports in dpdk. All ethdev APIs which have port_id as parameter are changed
  48   in the meantime.
  49
  50 * **Modified the return type of rte_eth_stats_reset.**
  51
  52   Changed return type of ``rte_eth_stats_reset`` from ``void`` to ``int``
  53   so the caller may know whether a device supports the operation or not
  54   and if the operation was carried out.
  55
  56 * **Added a new driver for Marvell Armada 7k/8k devices.**
  57
  58   Added the new mrvl net driver for Marvell Armada 7k/8k devices. See the
  59   "Network Interface Controller Drivers" document for more details on this new
  60   driver.
  61
  62 * **Added SoftNIC PMD.**
  63
  64   Added new SoftNIC PMD. This virtual device offers applications a software
  65   fallback support for traffic management.
  66
  67 * **nfp: Added PF support.**
  68
  69   Previously Netronome's NFP PMD had just support for VFs. PF support is
  70   just as a basic DPDK port and has no VF management yet.
  71
  72   PF support comes with firmware upload support which allows the PMD to
  73   independently work from kernel netdev NFP drivers.
  74
  75   NFP 4000 devices are also now supported along with previous 6000 devices.
  76
  77 * **Updated bnxt PMD.**
  78
  79   Major enhancements include:
  80
  81    * Support for Flow API
  82    * Support for Tx and Rx descriptor status functions
  83
  84 * **Updated QAT crypto PMD.**
  85
  86   Performance enhancements:
  87
  88   * Removed atomics from the internal queue pair structure.
  89   * Coalesce writes to HEAD CSR on response processing.
  90   * Coalesce writes to TAIL CSR on request processing.
  91
  92   Additional support for:
  93
  94   * AES CCM algorithm.
  95
  96 * **Updated the AESNI MB PMD.**
  97
  98   The AESNI MB PMD has been updated with additional support for:
  99
 100   * DES CBC algorithm.
 101   * DES DOCSIS BPI algorithm.
 102
 103   This requires the IPSec Multi-buffer library 0.47. For more details,
 104   check out the AESNI MB PMD documenation.
 105
 106 * **Updated the OpenSSL PMD.**
 107
 108   The OpenSSL PMD has been updated with additional support for:
 109
 110   * DES CBC algorithm.
 111   * AES CCM algorithm.
 112
 113 * **Add new benchmarking mode to dpdk-test-crypto-perf application.**
 114
 115   Added new "PMD cyclecount" benchmark mode to dpdk-test-crypto-perf application
 116   that displays more detailed breakdown of CPU cycles used by hardware
 117   acceleration.
 118
 119 * **Added IOMMU support to libvhost-user**
 120
 121   Implemented device IOTLB in Vhost-user backend, and enabled Virtio's IOMMU
 122   feature.
 123
 124 * **Added Membership library (rte_member).**
 125
 126   Added membership library. It provides an API for DPDK applications to insert a
 127   new member, delete an existing member, or query the existence of a member in a
 128   given set, or a group of sets. For the case of a group of sets the library
 129   will return not only whether the element has been inserted before in one of
 130   the sets but also which set it belongs to.
 131
 132   The Membership Library is an extension and generalization of a traditional
 133   filter (for example Bloom Filter) structure that has multiple usages in a wide
 134   variety of workloads and applications. In general, the Membership Library is a
 135   data structure that provides a “set-summary” and responds to set-membership
 136   queries whether a certain member belongs to a set(s).
 137
 138   See the :ref:`Membership Library <Member_Library>` documentation in
 139   the Programmers Guide document, for more information.
 140
 141 * **Added the Generic Segmentation Offload Library.**
 142
 143   Added the Generic Segmentation Offload (GSO) library to enable
 144   applications to split large packets (e.g. MTU is 64KB) into small
 145   ones (e.g. MTU is 1500B). Supported packet types are:
 146
 147   * TCP/IPv4 packets.
 148   * VxLAN packets, which must have an outer IPv4 header, and contain
 149     an inner TCP/IPv4 packet.
 150   * GRE packets, which must contain an outer IPv4 header, and inner
 151     TCP/IPv4 headers.
 152
 153   The GSO library doesn't check if the input packets have correct
 154   checksums, and doesn't update checksums for output packets.
 155   Additionally, the GSO library doesn't process IP fragmented packets.
 156
 157
 158 Resolved Issues
 159 ---------------
 160
 161 .. This section should contain bug fixes added to the relevant
 162    sections. Sample format:
 163
 164    * **code/section Fixed issue in the past tense with a full stop.**
 165
 166      Add a short 1-2 sentence description of the resolved issue in the past
 167      tense.
 168
 169      The title should contain the code/lib section like a commit message.
 170
 171      Add the entries in alphabetic order in the relevant sections below.
 172
 173    This section is a comment. do not overwrite or remove it.
 174    Also, make sure to start the actual text at the margin.
 175    =========================================================
 176
 177
 178 EAL
 179 ~~~
 180
 181 * **Service core fails to call service callback due to atomic lock**
 182
 183   In a specific configuration of multi-thread unsafe services and service
 184   cores, a service core previously did not correctly release the atomic lock
 185   on the service. This would result in the cores polling the service, but it
 186   looked like another thread was executing the service callback. The logic for
 187   atomic locking of the services has been fixed and refactored for readability.
 188
 189 Drivers
 190 ~~~~~~~
 191
 192
 193 Libraries
 194 ~~~~~~~~~
 195
 196
 197 Examples
 198 ~~~~~~~~
 199
 200
 201 Other
 202 ~~~~~
 203
 204
 205 Known Issues
 206 ------------
 207
 208 .. This section should contain new known issues in this release. Sample format:
 209
 210    * **Add title in present tense with full stop.**
 211
 212      Add a short 1-2 sentence description of the known issue in the present
 213      tense. Add information on any known workarounds.
 214
 215    This section is a comment. do not overwrite or remove it.
 216    Also, make sure to start the actual text at the margin.
 217    =========================================================
 218
 219
 220 API Changes
 221 -----------
 222
 223 .. This section should contain API changes. Sample format:
 224
 225    * Add a short 1-2 sentence description of the API change. Use fixed width
 226      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 227      tense.
 228
 229    This section is a comment. do not overwrite or remove it.
 230    Also, make sure to start the actual text at the margin.
 231    =========================================================
 232
 233 * **Ethdev device name length increased**
 234
 235   The size of internal device name is increased to 64 characters
 236   to allow for storing longer bus specific name.
 237
 238 * **Service cores API updated for usability**
 239
 240   The service cores API has been changed, removing pointers from the API
 241   where possible, instead using integer IDs to identify each service. This
 242   simplifed application code, aids debugging, and provides better
 243   encapsulation. A summary of the main changes made is as follows:
 244
 245   * Services identified by ID not by ``rte_service_spec`` pointer
 246   * Reduced API surface by using ``set`` functions instead of enable/disable
 247   * Reworked ``rte_service_register`` to provide the service ID to registrar
 248   * Rework start and stop APIs into ``rte_service_runstate_set``
 249   * Added API to set runstate of service implementation to indicate readyness
 250
 251 * **The following changes made in mempool library**
 252
 253   * Moved ``flags`` datatype from int to unsigned int for ``rte_mempool``.
 254   * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
 255     and ``rte_mempool_generic_get`` API.
 256   * Added ``flags`` param in ``rte_mempool_xmem_size`` and
 257     ``rte_mempool_xmem_usage``.
 258
 259 * Xen dom0 in EAL was removed, as well as xenvirt PMD and vhost_xen.
 260
 261 * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address;
 262   remove this API as Xen dom0 support was removed.
 263
 264 * **Add return value to stats_get dev op API**
 265
 266   The ``stats_get`` dev op API return value has been changed to be int.
 267   By this way PMDs can return an error value in case of failure at stats
 268   getting process time.
 269
 270 * **Modified the rte_cryptodev_allocate_driver function in the cryptodev library.**
 271
 272   The function ``rte_cryptodev_allocate_driver()`` has been modified.
 273   An extra parameter ``struct cryptodev_driver *crypto_drv`` has been added.
 274
 275
 276 ABI Changes
 277 -----------
 278
 279 .. This section should contain ABI changes. Sample format:
 280
 281    * Add a short 1-2 sentence description of the ABI change that was announced
 282      in the previous releases and made in this release. Use fixed width quotes
 283      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 284
 285    This section is a comment. do not overwrite or remove it.
 286    Also, make sure to start the actual text at the margin.
 287    =========================================================
 288
 289 * **Extended port_id range.**
 290
 291   The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
 292   changed, as described in the `New Features` section.
 293
 294
 295 Removed Items
 296 -------------
 297
 298 .. This section should contain removed items in this release. Sample format:
 299
 300    * Add a short 1-2 sentence description of the removed item in the past
 301      tense.
 302
 303    This section is a comment. do not overwrite or remove it.
 304    Also, make sure to start the actual text at the margin.
 305    =========================================================
 306
 307 * The crypto performance unit tests have been removed,
 308   replaced by the dpdk-test-crypto-perf application.
 309
 310
 311 Shared Library Versions
 312 -----------------------
 313
 314 .. Update any library version updated in this release and prepend with a ``+``
 315    sign, like this:
 316
 317      librte_acl.so.2
 318    + librte_cfgfile.so.2
 319      librte_cmdline.so.2
 320
 321    This section is a comment. do not overwrite or remove it.
 322    =========================================================
 323
 324
 325 The libraries prepended with a plus sign were incremented in this version.
 326
 327 .. code-block:: diff
 328
 329      librte_acl.so.2
 330      librte_bitratestats.so.2
 331      librte_cfgfile.so.2
 332      librte_cmdline.so.2
 333      librte_cryptodev.so.3
 334      librte_distributor.so.1
 335      librte_eal.so.5
 336      librte_ethdev.so.8
 337      librte_eventdev.so.3
 338      librte_gro.so.1
 339      librte_gso.so.1
 340      librte_hash.so.2
 341      librte_ip_frag.so.1
 342      librte_jobstats.so.1
 343      librte_kni.so.2
 344      librte_kvargs.so.1
 345      librte_latencystats.so.1
 346      librte_lpm.so.2
 347      librte_mbuf.so.3
 348      librte_mempool.so.2
 349      librte_meter.so.1
 350      librte_metrics.so.1
 351      librte_net.so.1
 352      librte_pdump.so.2
 353      librte_pipeline.so.3
 354      librte_pmd_bnxt.so.2
 355      librte_pmd_bond.so.2
 356      librte_pmd_i40e.so.2
 357      librte_pmd_ixgbe.so.2
 358      librte_pmd_ring.so.2
 359    + librte_pmd_softnic.so.1
 360      librte_pmd_vhost.so.2
 361      librte_port.so.3
 362      librte_power.so.1
 363      librte_reorder.so.1
 364      librte_ring.so.1
 365      librte_sched.so.1
 366      librte_table.so.2
 367      librte_timer.so.1
 368      librte_vhost.so.3
 369
 370
 371 Tested Platforms
 372 ----------------
 373
 374 .. This section should contain a list of platforms that were tested with this
 375    release.
 376
 377    The format is:
 378
 379    * <vendor> platform with <vendor> <type of devices> combinations
 380
 381      * List of CPU
 382      * List of OS
 383      * List of devices
 384      * Other relevant details...
 385
 386    This section is a comment. do not overwrite or remove it.
 387    Also, make sure to start the actual text at the margin.
 388    =========================================================