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