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
  90 Resolved Issues
  91 ---------------
  92
  93 .. This section should contain bug fixes added to the relevant
  94    sections. Sample format:
  95
  96    * **code/section Fixed issue in the past tense with a full stop.**
  97
  98      Add a short 1-2 sentence description of the resolved issue in the past
  99      tense.
 100
 101      The title should contain the code/lib section like a commit message.
 102
 103      Add the entries in alphabetic order in the relevant sections below.
 104
 105    This section is a comment. do not overwrite or remove it.
 106    Also, make sure to start the actual text at the margin.
 107    =========================================================
 108
 109
 110 EAL
 111 ~~~
 112
 113 * **Service core fails to call service callback due to atomic lock**
 114
 115   In a specific configuration of multi-thread unsafe services and service
 116   cores, a service core previously did not correctly release the atomic lock
 117   on the service. This would result in the cores polling the service, but it
 118   looked like another thread was executing the service callback. The logic for
 119   atomic locking of the services has been fixed and refactored for readability.
 120
 121 Drivers
 122 ~~~~~~~
 123
 124
 125 Libraries
 126 ~~~~~~~~~
 127
 128
 129 Examples
 130 ~~~~~~~~
 131
 132
 133 Other
 134 ~~~~~
 135
 136
 137 Known Issues
 138 ------------
 139
 140 .. This section should contain new known issues in this release. Sample format:
 141
 142    * **Add title in present tense with full stop.**
 143
 144      Add a short 1-2 sentence description of the known issue in the present
 145      tense. Add information on any known workarounds.
 146
 147    This section is a comment. do not overwrite or remove it.
 148    Also, make sure to start the actual text at the margin.
 149    =========================================================
 150
 151
 152 API Changes
 153 -----------
 154
 155 .. This section should contain API changes. Sample format:
 156
 157    * Add a short 1-2 sentence description of the API change. Use fixed width
 158      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 159      tense.
 160
 161    This section is a comment. do not overwrite or remove it.
 162    Also, make sure to start the actual text at the margin.
 163    =========================================================
 164
 165 * **Service cores API updated for usability**
 166
 167   The service cores API has been changed, removing pointers from the API
 168   where possible, instead using integer IDs to identify each service. This
 169   simplifed application code, aids debugging, and provides better
 170   encapsulation. A summary of the main changes made is as follows:
 171
 172   * Services identified by ID not by ``rte_service_spec`` pointer
 173   * Reduced API surface by using ``set`` functions instead of enable/disable
 174   * Reworked ``rte_service_register`` to provide the service ID to registrar
 175   * Rework start and stop APIs into ``rte_service_runstate_set``
 176   * Added API to set runstate of service implementation to indicate readyness
 177
 178 * **The following changes made in mempool library**
 179
 180   * Moved ``flags`` datatype from int to unsigned int for ``rte_mempool``.
 181   * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
 182     and ``rte_mempool_generic_get`` API.
 183   * Added ``flags`` param in ``rte_mempool_xmem_size`` and
 184     ``rte_mempool_xmem_usage``.
 185
 186 * Xen dom0 in EAL was removed, as well as xenvirt PMD and vhost_xen.
 187
 188 * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address;
 189   remove this API as Xen dom0 support was removed.
 190
 191
 192 ABI Changes
 193 -----------
 194
 195 .. This section should contain ABI changes. Sample format:
 196
 197    * Add a short 1-2 sentence description of the ABI change that was announced
 198      in the previous releases and made in this release. Use fixed width quotes
 199      for ``rte_function_names`` or ``rte_struct_names``. Use the past 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 * **Extended port_id range.**
 206
 207   The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
 208   changed, as described in the `New Features` section.
 209
 210 Shared Library Versions
 211 -----------------------
 212
 213 .. Update any library version updated in this release and prepend with a ``+``
 214    sign, like this:
 215
 216      librte_acl.so.2
 217    + librte_cfgfile.so.2
 218      librte_cmdline.so.2
 219
 220    This section is a comment. do not overwrite or remove it.
 221    =========================================================
 222
 223
 224 The libraries prepended with a plus sign were incremented in this version.
 225
 226 .. code-block:: diff
 227
 228      librte_acl.so.2
 229      librte_bitratestats.so.2
 230      librte_cfgfile.so.2
 231      librte_cmdline.so.2
 232      librte_cryptodev.so.3
 233      librte_distributor.so.1
 234      librte_eal.so.5
 235      librte_ethdev.so.8
 236      librte_eventdev.so.3
 237      librte_gro.so.1
 238      librte_hash.so.2
 239      librte_ip_frag.so.1
 240      librte_jobstats.so.1
 241      librte_kni.so.2
 242      librte_kvargs.so.1
 243      librte_latencystats.so.1
 244      librte_lpm.so.2
 245      librte_mbuf.so.3
 246      librte_mempool.so.2
 247      librte_meter.so.1
 248      librte_metrics.so.1
 249      librte_net.so.1
 250      librte_pdump.so.2
 251      librte_pipeline.so.3
 252      librte_pmd_bnxt.so.2
 253      librte_pmd_bond.so.2
 254      librte_pmd_i40e.so.2
 255      librte_pmd_ixgbe.so.2
 256      librte_pmd_ring.so.2
 257      librte_pmd_vhost.so.2
 258      librte_port.so.3
 259      librte_power.so.1
 260      librte_reorder.so.1
 261      librte_ring.so.1
 262      librte_sched.so.1
 263      librte_table.so.2
 264      librte_timer.so.1
 265      librte_vhost.so.3
 266
 267
 268 Tested Platforms
 269 ----------------
 270
 271 .. This section should contain a list of platforms that were tested with this
 272    release.
 273
 274    The format is:
 275
 276    * <vendor> platform with <vendor> <type of devices> combinations
 277
 278      * List of CPU
 279      * List of OS
 280      * List of devices
 281      * Other relevant details...
 282
 283    This section is a comment. do not overwrite or remove it.
 284    Also, make sure to start the actual text at the margin.
 285    =========================================================