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