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