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