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 * **Updated the AESNI MB PMD.**
  93
  94   The AESNI MB PMD has been updated with additional support for:
  95
  96   * DES CBC algorithm.
  97   * DES DOCSIS BPI algorithm.
  98
  99   This requires the IPSec Multi-buffer library 0.47. For more details,
 100   check out the AESNI MB PMD documenation.
 101
 102 * **Updated the OpenSSL PMD.**
 103
 104   The OpenSSL PMD has been updated with additional support for:
 105
 106   * DES CBC algorithm.
 107   * AES CCM algorithm.
 108
 109 * **Add new benchmarking mode to dpdk-test-crypto-perf application.**
 110
 111   Added new "PMD cyclecount" benchmark mode to dpdk-test-crypto-perf application
 112   that displays more detailed breakdown of CPU cycles used by hardware
 113   acceleration.
 114
 115 * **Added IOMMU support to libvhost-user**
 116
 117   Implemented device IOTLB in Vhost-user backend, and enabled Virtio's IOMMU
 118   feature.
 119
 120 * **Added Membership library (rte_member).**
 121
 122   Added membership library. It provides an API for DPDK applications to insert a
 123   new member, delete an existing member, or query the existence of a member in a
 124   given set, or a group of sets. For the case of a group of sets the library
 125   will return not only whether the element has been inserted before in one of
 126   the sets but also which set it belongs to.
 127
 128   The Membership Library is an extension and generalization of a traditional
 129   filter (for example Bloom Filter) structure that has multiple usages in a wide
 130   variety of workloads and applications. In general, the Membership Library is a
 131   data structure that provides a “set-summary” and responds to set-membership
 132   queries whether a certain member belongs to a set(s).
 133
 134   See the :ref:`Membership Library <Member_Library>` documentation in
 135   the Programmers Guide document, for more information.
 136
 137 * **Added the Generic Segmentation Offload Library.**
 138
 139   Added the Generic Segmentation Offload (GSO) library to enable
 140   applications to split large packets (e.g. MTU is 64KB) into small
 141   ones (e.g. MTU is 1500B). Supported packet types are:
 142
 143   * TCP/IPv4 packets.
 144   * VxLAN packets, which must have an outer IPv4 header, and contain
 145     an inner TCP/IPv4 packet.
 146   * GRE packets, which must contain an outer IPv4 header, and inner
 147     TCP/IPv4 headers.
 148
 149   The GSO library doesn't check if the input packets have correct
 150   checksums, and doesn't update checksums for output packets.
 151   Additionally, the GSO library doesn't process IP fragmented packets.
 152
 153
 154 Resolved Issues
 155 ---------------
 156
 157 .. This section should contain bug fixes added to the relevant
 158    sections. Sample format:
 159
 160    * **code/section Fixed issue in the past tense with a full stop.**
 161
 162      Add a short 1-2 sentence description of the resolved issue in the past
 163      tense.
 164
 165      The title should contain the code/lib section like a commit message.
 166
 167      Add the entries in alphabetic order in the relevant sections below.
 168
 169    This section is a comment. do not overwrite or remove it.
 170    Also, make sure to start the actual text at the margin.
 171    =========================================================
 172
 173
 174 EAL
 175 ~~~
 176
 177 * **Service core fails to call service callback due to atomic lock**
 178
 179   In a specific configuration of multi-thread unsafe services and service
 180   cores, a service core previously did not correctly release the atomic lock
 181   on the service. This would result in the cores polling the service, but it
 182   looked like another thread was executing the service callback. The logic for
 183   atomic locking of the services has been fixed and refactored for readability.
 184
 185 Drivers
 186 ~~~~~~~
 187
 188
 189 Libraries
 190 ~~~~~~~~~
 191
 192
 193 Examples
 194 ~~~~~~~~
 195
 196
 197 Other
 198 ~~~~~
 199
 200
 201 Known Issues
 202 ------------
 203
 204 .. This section should contain new known issues in this release. Sample format:
 205
 206    * **Add title in present tense with full stop.**
 207
 208      Add a short 1-2 sentence description of the known issue in the present
 209      tense. Add information on any known workarounds.
 210
 211    This section is a comment. do not overwrite or remove it.
 212    Also, make sure to start the actual text at the margin.
 213    =========================================================
 214
 215
 216 API Changes
 217 -----------
 218
 219 .. This section should contain API changes. Sample format:
 220
 221    * Add a short 1-2 sentence description of the API change. Use fixed width
 222      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 223      tense.
 224
 225    This section is a comment. do not overwrite or remove it.
 226    Also, make sure to start the actual text at the margin.
 227    =========================================================
 228
 229 * **Ethdev device name length increased**
 230
 231   The size of internal device name is increased to 64 characters
 232   to allow for storing longer bus specific name.
 233
 234 * **Service cores API updated for usability**
 235
 236   The service cores API has been changed, removing pointers from the API
 237   where possible, instead using integer IDs to identify each service. This
 238   simplifed application code, aids debugging, and provides better
 239   encapsulation. A summary of the main changes made is as follows:
 240
 241   * Services identified by ID not by ``rte_service_spec`` pointer
 242   * Reduced API surface by using ``set`` functions instead of enable/disable
 243   * Reworked ``rte_service_register`` to provide the service ID to registrar
 244   * Rework start and stop APIs into ``rte_service_runstate_set``
 245   * Added API to set runstate of service implementation to indicate readyness
 246
 247 * **The following changes made in mempool library**
 248
 249   * Moved ``flags`` datatype from int to unsigned int for ``rte_mempool``.
 250   * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
 251     and ``rte_mempool_generic_get`` API.
 252   * Added ``flags`` param in ``rte_mempool_xmem_size`` and
 253     ``rte_mempool_xmem_usage``.
 254
 255 * Xen dom0 in EAL was removed, as well as xenvirt PMD and vhost_xen.
 256
 257 * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address;
 258   remove this API as Xen dom0 support was removed.
 259
 260 * **Add return value to stats_get dev op API**
 261
 262   The ``stats_get`` dev op API return value has been changed to be int.
 263   By this way PMDs can return an error value in case of failure at stats
 264   getting process time.
 265
 266 * **Modified the rte_cryptodev_allocate_driver function in the cryptodev library.**
 267
 268   The function ``rte_cryptodev_allocate_driver()`` has been modified.
 269   An extra parameter ``struct cryptodev_driver *crypto_drv`` has been added.
 270
 271
 272 ABI Changes
 273 -----------
 274
 275 .. This section should contain ABI changes. Sample format:
 276
 277    * Add a short 1-2 sentence description of the ABI change that was announced
 278      in the previous releases and made in this release. Use fixed width quotes
 279      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 280
 281    This section is a comment. do not overwrite or remove it.
 282    Also, make sure to start the actual text at the margin.
 283    =========================================================
 284
 285 * **Extended port_id range.**
 286
 287   The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
 288   changed, as described in the `New Features` section.
 289
 290
 291 Removed Items
 292 -------------
 293
 294 .. This section should contain removed items in this release. Sample format:
 295
 296    * Add a short 1-2 sentence description of the removed item in the past
 297      tense.
 298
 299    This section is a comment. do not overwrite or remove it.
 300    Also, make sure to start the actual text at the margin.
 301    =========================================================
 302
 303 * The crypto performance unit tests have been removed,
 304   replaced by the dpdk-test-crypto-perf application.
 305
 306
 307 Shared Library Versions
 308 -----------------------
 309
 310 .. Update any library version updated in this release and prepend with a ``+``
 311    sign, like this:
 312
 313      librte_acl.so.2
 314    + librte_cfgfile.so.2
 315      librte_cmdline.so.2
 316
 317    This section is a comment. do not overwrite or remove it.
 318    =========================================================
 319
 320
 321 The libraries prepended with a plus sign were incremented in this version.
 322
 323 .. code-block:: diff
 324
 325      librte_acl.so.2
 326      librte_bitratestats.so.2
 327      librte_cfgfile.so.2
 328      librte_cmdline.so.2
 329      librte_cryptodev.so.3
 330      librte_distributor.so.1
 331      librte_eal.so.5
 332      librte_ethdev.so.8
 333      librte_eventdev.so.3
 334      librte_gro.so.1
 335      librte_gso.so.1
 336      librte_hash.so.2
 337      librte_ip_frag.so.1
 338      librte_jobstats.so.1
 339      librte_kni.so.2
 340      librte_kvargs.so.1
 341      librte_latencystats.so.1
 342      librte_lpm.so.2
 343      librte_mbuf.so.3
 344      librte_mempool.so.2
 345      librte_meter.so.1
 346      librte_metrics.so.1
 347      librte_net.so.1
 348      librte_pdump.so.2
 349      librte_pipeline.so.3
 350      librte_pmd_bnxt.so.2
 351      librte_pmd_bond.so.2
 352      librte_pmd_i40e.so.2
 353      librte_pmd_ixgbe.so.2
 354      librte_pmd_ring.so.2
 355    + librte_pmd_softnic.so.1
 356      librte_pmd_vhost.so.2
 357      librte_port.so.3
 358      librte_power.so.1
 359      librte_reorder.so.1
 360      librte_ring.so.1
 361      librte_sched.so.1
 362      librte_table.so.2
 363      librte_timer.so.1
 364      librte_vhost.so.3
 365
 366
 367 Tested Platforms
 368 ----------------
 369
 370 .. This section should contain a list of platforms that were tested with this
 371    release.
 372
 373    The format is:
 374
 375    * <vendor> platform with <vendor> <type of devices> combinations
 376
 377      * List of CPU
 378      * List of OS
 379      * List of devices
 380      * Other relevant details...
 381
 382    This section is a comment. do not overwrite or remove it.
 383    Also, make sure to start the actual text at the margin.
 384    =========================================================