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