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 * **Updated mlx5 driver.**
  63
  64   Updated the mlx5 driver including the following changes:
  65
  66    * Enabled PMD to run on top of upstream linux kernel and rdma-core libs.
  67      By that removed the dependency on specific Mellanox OFED libraries.
  68    * Improved PMD latency performance.
  69    * Improved PMD memory footprint.
  70    * Supported vectorized Rx/Tx burst for ARMv8.
  71    * Supported secondary process.
  72    * Supported flow counters.
  73    * Supported Rx hardware timestamp offload.
  74    * Supported device removal event.
  75
  76 * **Added SoftNIC PMD.**
  77
  78   Added new SoftNIC PMD. This virtual device offers applications a software
  79   fallback support for traffic management.
  80
  81 * **nfp: Added PF support.**
  82
  83   Previously Netronome's NFP PMD had just support for VFs. PF support is
  84   just as a basic DPDK port and has no VF management yet.
  85
  86   PF support comes with firmware upload support which allows the PMD to
  87   independently work from kernel netdev NFP drivers.
  88
  89   NFP 4000 devices are also now supported along with previous 6000 devices.
  90
  91 * **Updated bnxt PMD.**
  92
  93   Major enhancements include:
  94
  95    * Support for Flow API
  96    * Support for Tx and Rx descriptor status functions
  97
  98 * **Add bus agnostic functions to cryptodev for PMD initialisation**
  99
 100   Adds new PMD assist functions ``rte_cryptodev_pmd_parse_input_args()``,
 101   ``rte_cryptodev_pmd_create()`` and ``rte_cryptodev_pmd_destroy()`` which
 102   are bus independent for driver to manage creation and destruction of new
 103   device instances.
 104
 105 * **Updated QAT crypto PMD.**
 106
 107   Performance enhancements:
 108
 109   * Removed atomics from the internal queue pair structure.
 110   * Coalesce writes to HEAD CSR on response processing.
 111   * Coalesce writes to TAIL CSR on request processing.
 112
 113   Additional support for:
 114
 115   * AES CCM algorithm.
 116
 117 * **Updated the AESNI MB PMD.**
 118
 119   The AESNI MB PMD has been updated with additional support for:
 120
 121   * DES CBC algorithm.
 122   * DES DOCSIS BPI algorithm.
 123
 124   This requires the IPSec Multi-buffer library 0.47. For more details,
 125   check out the AESNI MB PMD documenation.
 126
 127 * **Updated the OpenSSL PMD.**
 128
 129   The OpenSSL PMD has been updated with additional support for:
 130
 131   * DES CBC algorithm.
 132   * AES CCM algorithm.
 133
 134 * **Added NXP DPAA SEC crypto PMD.**
 135
 136   A new "dpaa_sec" hardware based crypto PMD for NXP DPAA devices has been
 137   added. See the "Crypto Device Drivers" document for more details on this
 138   driver.
 139
 140 * **Added MRVL crypto PMD.**
 141
 142   A new crypto PMD has been added, which provides several ciphering and hashing
 143   algorithms. All cryptography operations use the MUSDK library crypto API.
 144
 145 * **Add new benchmarking mode to dpdk-test-crypto-perf application.**
 146
 147   Added new "PMD cyclecount" benchmark mode to dpdk-test-crypto-perf application
 148   that displays more detailed breakdown of CPU cycles used by hardware
 149   acceleration.
 150
 151 * **Added IOMMU support to libvhost-user**
 152
 153   Implemented device IOTLB in Vhost-user backend, and enabled Virtio's IOMMU
 154   feature.
 155
 156 * **Added Membership library (rte_member).**
 157
 158   Added membership library. It provides an API for DPDK applications to insert a
 159   new member, delete an existing member, or query the existence of a member in a
 160   given set, or a group of sets. For the case of a group of sets the library
 161   will return not only whether the element has been inserted before in one of
 162   the sets but also which set it belongs to.
 163
 164   The Membership Library is an extension and generalization of a traditional
 165   filter (for example Bloom Filter) structure that has multiple usages in a wide
 166   variety of workloads and applications. In general, the Membership Library is a
 167   data structure that provides a “set-summary” and responds to set-membership
 168   queries whether a certain member belongs to a set(s).
 169
 170   See the :ref:`Membership Library <Member_Library>` documentation in
 171   the Programmers Guide document, for more information.
 172
 173 * **Added the Generic Segmentation Offload Library.**
 174
 175   Added the Generic Segmentation Offload (GSO) library to enable
 176   applications to split large packets (e.g. MTU is 64KB) into small
 177   ones (e.g. MTU is 1500B). Supported packet types are:
 178
 179   * TCP/IPv4 packets.
 180   * VxLAN packets, which must have an outer IPv4 header, and contain
 181     an inner TCP/IPv4 packet.
 182   * GRE packets, which must contain an outer IPv4 header, and inner
 183     TCP/IPv4 headers.
 184
 185   The GSO library doesn't check if the input packets have correct
 186   checksums, and doesn't update checksums for output packets.
 187   Additionally, the GSO library doesn't process IP fragmented packets.
 188
 189 * **Added the Flow Classification Library.**
 190
 191   Added the Flow Classification library, it provides an API for DPDK
 192   applications to classify an input packet by matching it against a set of flow
 193   rules. It uses the librte_table API to manage the flow rules.
 194
 195
 196 Resolved Issues
 197 ---------------
 198
 199 .. This section should contain bug fixes added to the relevant
 200    sections. Sample format:
 201
 202    * **code/section Fixed issue in the past tense with a full stop.**
 203
 204      Add a short 1-2 sentence description of the resolved issue in the past
 205      tense.
 206
 207      The title should contain the code/lib section like a commit message.
 208
 209      Add the entries in alphabetic order in the relevant sections below.
 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 EAL
 217 ~~~
 218
 219 * **Service core fails to call service callback due to atomic lock**
 220
 221   In a specific configuration of multi-thread unsafe services and service
 222   cores, a service core previously did not correctly release the atomic lock
 223   on the service. This would result in the cores polling the service, but it
 224   looked like another thread was executing the service callback. The logic for
 225   atomic locking of the services has been fixed and refactored for readability.
 226
 227 Drivers
 228 ~~~~~~~
 229
 230
 231 Libraries
 232 ~~~~~~~~~
 233
 234
 235 Examples
 236 ~~~~~~~~
 237
 238
 239 Other
 240 ~~~~~
 241
 242
 243 Known Issues
 244 ------------
 245
 246 .. This section should contain new known issues in this release. Sample format:
 247
 248    * **Add title in present tense with full stop.**
 249
 250      Add a short 1-2 sentence description of the known issue in the present
 251      tense. Add information on any known workarounds.
 252
 253    This section is a comment. do not overwrite or remove it.
 254    Also, make sure to start the actual text at the margin.
 255    =========================================================
 256
 257
 258 API Changes
 259 -----------
 260
 261 .. This section should contain API changes. Sample format:
 262
 263    * Add a short 1-2 sentence description of the API change. Use fixed width
 264      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 265      tense.
 266
 267    This section is a comment. do not overwrite or remove it.
 268    Also, make sure to start the actual text at the margin.
 269    =========================================================
 270
 271 * **Ethdev device name length increased**
 272
 273   The size of internal device name is increased to 64 characters
 274   to allow for storing longer bus specific name.
 275
 276 * **Service cores API updated for usability**
 277
 278   The service cores API has been changed, removing pointers from the API
 279   where possible, instead using integer IDs to identify each service. This
 280   simplifed application code, aids debugging, and provides better
 281   encapsulation. A summary of the main changes made is as follows:
 282
 283   * Services identified by ID not by ``rte_service_spec`` pointer
 284   * Reduced API surface by using ``set`` functions instead of enable/disable
 285   * Reworked ``rte_service_register`` to provide the service ID to registrar
 286   * Rework start and stop APIs into ``rte_service_runstate_set``
 287   * Added API to set runstate of service implementation to indicate readyness
 288
 289 * **The following changes made in mempool library**
 290
 291   * Moved ``flags`` datatype from int to unsigned int for ``rte_mempool``.
 292   * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
 293     and ``rte_mempool_generic_get`` API.
 294   * Added ``flags`` param in ``rte_mempool_xmem_size`` and
 295     ``rte_mempool_xmem_usage``.
 296
 297 * Xen dom0 in EAL was removed, as well as xenvirt PMD and vhost_xen.
 298
 299 * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address;
 300   remove this API as Xen dom0 support was removed.
 301
 302 * **Add return value to stats_get dev op API**
 303
 304   The ``stats_get`` dev op API return value has been changed to be int.
 305   By this way PMDs can return an error value in case of failure at stats
 306   getting process time.
 307
 308 * **Modified the rte_cryptodev_allocate_driver function in the cryptodev library.**
 309
 310   The function ``rte_cryptodev_allocate_driver()`` has been modified.
 311   An extra parameter ``struct cryptodev_driver *crypto_drv`` has been added.
 312
 313 * **Removed virtual device bus specific functions from librte_cryptodev.**
 314
 315   The functions ``rte_cryptodev_vdev_parse_init_params()`` and
 316   ``rte_cryptodev_vdev_pmd_init()`` have been removed from librte_cryptodev
 317   and have been replaced by non bus specific functions
 318   ``rte_cryptodev_pmd_parse_input_args()`` and ``rte_cryptodev_pmd_create()``.
 319
 320 * **Removed PCI device bus specific functions from librte_cryptodev.**
 321
 322   The functions ``rte_cryptodev_pci_generic_probe()`` and
 323   ``rte_cryptodev_pci_generic_remove()`` have been removed from librte_cryptodev
 324   and have been replaced by non bus specific functions
 325   ``rte_cryptodev_pmd_create()`` and ``rte_cryptodev_pmd_destroy()``.
 326
 327 * **Removed deprecated functions to manage log level or type.**
 328
 329   The functions ``rte_set_log_level()``, ``rte_get_log_level()``,
 330   ``rte_set_log_type()`` and ``rte_get_log_type()`` have been removed.
 331   They are respectively replaced by ``rte_log_set_global_level()``,
 332   ``rte_log_get_global_level()``, ``rte_log_set_level()`` and
 333   ``rte_log_get_level()``.
 334
 335
 336 ABI Changes
 337 -----------
 338
 339 .. This section should contain ABI changes. Sample format:
 340
 341    * Add a short 1-2 sentence description of the ABI change that was announced
 342      in the previous releases and made in this release. Use fixed width quotes
 343      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 344
 345    This section is a comment. do not overwrite or remove it.
 346    Also, make sure to start the actual text at the margin.
 347    =========================================================
 348
 349 * **Extended port_id range.**
 350
 351   The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
 352   changed, as described in the `New Features` section.
 353
 354
 355 Removed Items
 356 -------------
 357
 358 .. This section should contain removed items in this release. Sample format:
 359
 360    * Add a short 1-2 sentence description of the removed item in the past
 361      tense.
 362
 363    This section is a comment. do not overwrite or remove it.
 364    Also, make sure to start the actual text at the margin.
 365    =========================================================
 366
 367 * The crypto performance unit tests have been removed,
 368   replaced by the dpdk-test-crypto-perf application.
 369
 370
 371 Shared Library Versions
 372 -----------------------
 373
 374 .. Update any library version updated in this release and prepend with a ``+``
 375    sign, like this:
 376
 377      librte_acl.so.2
 378    + librte_cfgfile.so.2
 379      librte_cmdline.so.2
 380
 381    This section is a comment. do not overwrite or remove it.
 382    =========================================================
 383
 384
 385 The libraries prepended with a plus sign were incremented in this version.
 386
 387 .. code-block:: diff
 388
 389      librte_acl.so.2
 390    + librte_bitratestats.so.2
 391      librte_cfgfile.so.2
 392      librte_cmdline.so.2
 393    + librte_cryptodev.so.4
 394      librte_distributor.so.1
 395    + librte_eal.so.6
 396    + librte_ethdev.so.8
 397    + librte_eventdev.so.3
 398    + librte_flow_classify.so.1
 399      librte_gro.so.1
 400    + librte_gso.so.1
 401      librte_hash.so.2
 402      librte_ip_frag.so.1
 403      librte_jobstats.so.1
 404      librte_kni.so.2
 405      librte_kvargs.so.1
 406      librte_latencystats.so.1
 407      librte_lpm.so.2
 408      librte_mbuf.so.3
 409      librte_mempool.so.2
 410      librte_meter.so.1
 411      librte_metrics.so.1
 412      librte_net.so.1
 413    + librte_pdump.so.2
 414      librte_pipeline.so.3
 415    + librte_pmd_bnxt.so.2
 416    + librte_pmd_bond.so.2
 417    + librte_pmd_i40e.so.2
 418    + librte_pmd_ixgbe.so.2
 419      librte_pmd_ring.so.2
 420    + librte_pmd_softnic.so.1
 421    + librte_pmd_vhost.so.2
 422      librte_port.so.3
 423      librte_power.so.1
 424      librte_reorder.so.1
 425      librte_ring.so.1
 426      librte_sched.so.1
 427    + librte_security.so.1
 428    + librte_table.so.3
 429      librte_timer.so.1
 430      librte_vhost.so.3
 431
 432
 433 Tested Platforms
 434 ----------------
 435
 436 .. This section should contain a list of platforms that were tested with this
 437    release.
 438
 439    The format is:
 440
 441    * <vendor> platform with <vendor> <type of devices> combinations
 442
 443      * List of CPU
 444      * List of OS
 445      * List of devices
 446      * Other relevant details...
 447
 448    This section is a comment. do not overwrite or remove it.
 449    Also, make sure to start the actual text at the margin.
 450    =========================================================