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