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