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