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