doc/guides/rel_notes/release_17_05.rst

   1 DPDK Release 17.05
   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_05.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 * **Added free Tx mbuf on demand API.**
  45
  46   Added a new function ``rte_eth_tx_done_cleanup()`` which allows an application
  47   to request the driver to release mbufs from their Tx ring that are no longer
  48   in use, independent of whether or not the ``tx_rs_thresh`` has been crossed.
  49
  50 * **Added descriptor status ethdev API.**
  51
  52   Added a new API to get the status of a descriptor.
  53
  54   For Rx, it is almost similar to the ``rx_descriptor_done`` API, except
  55   it differentiates descriptors which are hold by the driver and not
  56   returned to the hardware. For Tx, it is a new API.
  57
  58 * **Increased number of next hops for LPM IPv6 to 2^21.**
  59
  60   The next_hop field is extended from 8 bits to 21 bits for IPv6.
  61
  62 * **Added VFIO hotplug support.**
  63
  64   How hotplug supported with UIO and VFIO drivers.
  65
  66 * **Added powerpc support in pci probing for vfio-pci devices.**
  67
  68   sPAPR IOMMU based pci probing enabled for vfio-pci devices.
  69
  70 * **Updated the ixgbe base driver.**
  71
  72   Updated the ixgbe base driver, including the following changes:
  73
  74   * Add link block check for KR.
  75   * Complete HW initialization even if SFP is not present.
  76   * Add VF xcast promiscuous mode.
  77
  78 * **Added powerpc support for i40e and its vector PMD .**
  79
  80   i40e PMD and its vector PMD enabled by default in powerpc.
  81
  82 * **Added VF max bandwidth setting on i40e.**
  83
  84   i40e HW supports to set the max bandwidth for a VF. Enable this capability.
  85
  86 * **Added TSO support for tunneled and non-tunneled packets on mlx5 driver.**
  87
  88   Added support for Hardware TSO for tunneled and non-tunneled packets.
  89   Tunneling protocols supported are GRE and VXLAN.
  90
  91 * **Added support for Rx interrupts on mlx5 driver.**
  92
  93   Rx queues can be armed with an interrupt which will trigger on the
  94   next packet arrival.
  95
  96 * **Updated the sfc_efx driver.**
  97
  98   * Generic flow API support for Ethernet, VLAN, IPv4, IPv6, UDP and TCP
  99     pattern items with QUEUE action for ingress traffic.
 100
 101   * Support virtual functions (VFs)
 102
 103 * **Added LiquidIO network PMD.**
 104
 105   Added poll mode driver support for Cavium LiquidIO II server adapter VFs.
 106
 107 * **Added vmxnet3 version 3 support.**
 108
 109   Added support for vmxnet3 version 3 which includes several
 110   performance enhancements viz. configurable TX data ring, Receive
 111   Data Ring, ability to register memory regions.
 112
 113
 114 Resolved Issues
 115 ---------------
 116
 117 .. This section should contain bug fixes added to the relevant
 118    sections. Sample format:
 119
 120    * **code/section Fixed issue in the past tense with a full stop.**
 121
 122      Add a short 1-2 sentence description of the resolved issue in the past
 123      tense.
 124
 125      The title should contain the code/lib section like a commit message.
 126
 127      Add the entries in alphabetic order in the relevant sections below.
 128
 129    This section is a comment. do not overwrite or remove it.
 130    Also, make sure to start the actual text at the margin.
 131    =========================================================
 132
 133
 134 EAL
 135 ~~~
 136
 137
 138 Drivers
 139 ~~~~~~~
 140
 141
 142 Libraries
 143 ~~~~~~~~~
 144
 145
 146 Examples
 147 ~~~~~~~~
 148
 149
 150 Other
 151 ~~~~~
 152
 153
 154 Known Issues
 155 ------------
 156
 157 .. This section should contain new known issues in this release. Sample format:
 158
 159    * **Add title in present tense with full stop.**
 160
 161      Add a short 1-2 sentence description of the known issue in the present
 162      tense. Add information on any known workarounds.
 163
 164    This section is a comment. do not overwrite or remove it.
 165    Also, make sure to start the actual text at the margin.
 166    =========================================================
 167
 168
 169 API Changes
 170 -----------
 171
 172 .. This section should contain API changes. Sample format:
 173
 174    * Add a short 1-2 sentence description of the API change. Use fixed width
 175      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 176      tense.
 177
 178    This section is a comment. do not overwrite or remove it.
 179    Also, make sure to start the actual text at the margin.
 180    =========================================================
 181
 182 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
 183   while keeping ABI compatibility.
 184
 185 * **Reworked rte_ring library**
 186
 187   The rte_ring library has been reworked and updated. The following changes
 188   have been made to it:
 189
 190   * removed the build-time setting ``CONFIG_RTE_RING_SPLIT_PROD_CONS``
 191   * removed the build-time setting ``CONFIG_RTE_LIBRTE_RING_DEBUG``
 192   * removed the build-time setting ``CONFIG_RTE_RING_PAUSE_REP_COUNT``
 193   * removed the function ``rte_ring_set_water_mark`` as part of a general
 194     removal of watermarks support in the library.
 195   * added an extra parameter to the burst/bulk enqueue functions to
 196     return the number of free spaces in the ring after enqueue. This can
 197     be used by an application to implement its own watermark functionality.
 198   * added an extra parameter to the burst/bulk dequeue functions to return
 199     the number elements remaining in the ring after dequeue.
 200   * changed the return value of the enqueue and dequeue bulk functions to
 201     match that of the burst equivalents. In all cases, ring functions which
 202     operate on multiple packets now return the number of elements enqueued
 203     or dequeued, as appropriate. The updated functions are:
 204
 205     - ``rte_ring_mp_enqueue_bulk``
 206     - ``rte_ring_sp_enqueue_bulk``
 207     - ``rte_ring_enqueue_bulk``
 208     - ``rte_ring_mc_dequeue_bulk``
 209     - ``rte_ring_sc_dequeue_bulk``
 210     - ``rte_ring_dequeue_bulk``
 211
 212     NOTE: the above functions all have different parameters as well as
 213     different return values, due to the other listed changes above. This
 214     means that all instances of the functions in existing code will be
 215     flagged by the compiler. The return value usage should be checked
 216     while fixing the compiler error due to the extra parameter.
 217
 218 ABI Changes
 219 -----------
 220
 221 .. This section should contain ABI changes. Sample format:
 222
 223    * Add a short 1-2 sentence description of the ABI change that was announced
 224      in the previous releases and made in this release. Use fixed width quotes
 225      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 226
 227    This section is a comment. do not overwrite or remove it.
 228    Also, make sure to start the actual text at the margin.
 229    =========================================================
 230
 231
 232 Removed Items
 233 -------------
 234
 235 .. This section should contain removed items in this release. Sample format:
 236
 237    * Add a short 1-2 sentence description of the removed item in the past
 238      tense.
 239
 240    This section is a comment. do not overwrite or remove it.
 241    Also, make sure to start the actual text at the margin.
 242    =========================================================
 243
 244 * KNI vhost support removed.
 245
 246
 247 Shared Library Versions
 248 -----------------------
 249
 250 .. Update any library version updated in this release and prepend with a ``+``
 251    sign, like this:
 252
 253      librte_acl.so.2
 254    + librte_cfgfile.so.2
 255      librte_cmdline.so.2
 256
 257    This section is a comment. do not overwrite or remove it.
 258    =========================================================
 259
 260
 261 The libraries prepended with a plus sign were incremented in this version.
 262
 263 .. code-block:: diff
 264
 265      librte_acl.so.2
 266      librte_cfgfile.so.2
 267      librte_cmdline.so.2
 268      librte_cryptodev.so.2
 269      librte_distributor.so.1
 270      librte_eal.so.3
 271      librte_ethdev.so.6
 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_lpm.so.2
 278      librte_mbuf.so.2
 279      librte_mempool.so.2
 280      librte_meter.so.1
 281      librte_net.so.1
 282      librte_pdump.so.1
 283      librte_pipeline.so.3
 284      librte_pmd_bond.so.1
 285      librte_pmd_ring.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    =========================================================