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