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