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