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 VF TC min bandwidth setting on i40e.**
  87
  88   i40e HW supports to set the allocated bandwidth for a TC on a VF. Enable this
  89   capability.
  90
  91 * **Added VF TC max bandwidth setting on i40e.**
  92
  93   i40e HW supports to set the max bandwidth for a TC on a VF. Enable this
  94   capability.
  95
  96 * **Added TSO support for tunneled and non-tunneled packets on mlx5 driver.**
  97
  98   Added support for Hardware TSO for tunneled and non-tunneled packets.
  99   Tunneling protocols supported are GRE and VXLAN.
 100
 101 * **Added support for Rx interrupts on mlx5 driver.**
 102
 103   Rx queues can be armed with an interrupt which will trigger on the
 104   next packet arrival.
 105
 106 * **Updated the sfc_efx driver.**
 107
 108   * Generic flow API support for Ethernet, VLAN, IPv4, IPv6, UDP and TCP
 109     pattern items with QUEUE action for ingress traffic.
 110
 111   * Support virtual functions (VFs)
 112
 113 * **Added LiquidIO network PMD.**
 114
 115   Added poll mode driver support for Cavium LiquidIO II server adapter VFs.
 116
 117 * **Added vmxnet3 version 3 support.**
 118
 119   Added support for vmxnet3 version 3 which includes several
 120   performance enhancements viz. configurable TX data ring, Receive
 121   Data Ring, ability to register memory regions.
 122
 123
 124 Resolved Issues
 125 ---------------
 126
 127 .. This section should contain bug fixes added to the relevant
 128    sections. Sample format:
 129
 130    * **code/section Fixed issue in the past tense with a full stop.**
 131
 132      Add a short 1-2 sentence description of the resolved issue in the past
 133      tense.
 134
 135      The title should contain the code/lib section like a commit message.
 136
 137      Add the entries in alphabetic order in the relevant sections below.
 138
 139    This section is a comment. do not overwrite or remove it.
 140    Also, make sure to start the actual text at the margin.
 141    =========================================================
 142
 143
 144 EAL
 145 ~~~
 146
 147
 148 Drivers
 149 ~~~~~~~
 150
 151
 152 Libraries
 153 ~~~~~~~~~
 154
 155
 156 Examples
 157 ~~~~~~~~
 158
 159
 160 Other
 161 ~~~~~
 162
 163
 164 Known Issues
 165 ------------
 166
 167 .. This section should contain new known issues in this release. Sample format:
 168
 169    * **Add title in present tense with full stop.**
 170
 171      Add a short 1-2 sentence description of the known issue in the present
 172      tense. Add information on any known workarounds.
 173
 174    This section is a comment. do not overwrite or remove it.
 175    Also, make sure to start the actual text at the margin.
 176    =========================================================
 177
 178
 179 API Changes
 180 -----------
 181
 182 .. This section should contain API changes. Sample format:
 183
 184    * Add a short 1-2 sentence description of the API change. Use fixed width
 185      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 186      tense.
 187
 188    This section is a comment. do not overwrite or remove it.
 189    Also, make sure to start the actual text at the margin.
 190    =========================================================
 191
 192 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
 193   while keeping ABI compatibility.
 194
 195 * **Reworked rte_ring library**
 196
 197   The rte_ring library has been reworked and updated. The following changes
 198   have been made to it:
 199
 200   * removed the build-time setting ``CONFIG_RTE_RING_SPLIT_PROD_CONS``
 201   * removed the build-time setting ``CONFIG_RTE_LIBRTE_RING_DEBUG``
 202   * removed the build-time setting ``CONFIG_RTE_RING_PAUSE_REP_COUNT``
 203   * removed the function ``rte_ring_set_water_mark`` as part of a general
 204     removal of watermarks support in the library.
 205   * added an extra parameter to the burst/bulk enqueue functions to
 206     return the number of free spaces in the ring after enqueue. This can
 207     be used by an application to implement its own watermark functionality.
 208   * added an extra parameter to the burst/bulk dequeue functions to return
 209     the number elements remaining in the ring after dequeue.
 210   * changed the return value of the enqueue and dequeue bulk functions to
 211     match that of the burst equivalents. In all cases, ring functions which
 212     operate on multiple packets now return the number of elements enqueued
 213     or dequeued, as appropriate. The updated functions are:
 214
 215     - ``rte_ring_mp_enqueue_bulk``
 216     - ``rte_ring_sp_enqueue_bulk``
 217     - ``rte_ring_enqueue_bulk``
 218     - ``rte_ring_mc_dequeue_bulk``
 219     - ``rte_ring_sc_dequeue_bulk``
 220     - ``rte_ring_dequeue_bulk``
 221
 222     NOTE: the above functions all have different parameters as well as
 223     different return values, due to the other listed changes above. This
 224     means that all instances of the functions in existing code will be
 225     flagged by the compiler. The return value usage should be checked
 226     while fixing the compiler error due to the extra parameter.
 227
 228 ABI Changes
 229 -----------
 230
 231 .. This section should contain ABI changes. Sample format:
 232
 233    * Add a short 1-2 sentence description of the ABI change that was announced
 234      in the previous releases and made in this release. Use fixed width quotes
 235      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 236
 237    This section is a comment. do not overwrite or remove it.
 238    Also, make sure to start the actual text at the margin.
 239    =========================================================
 240
 241
 242 Removed Items
 243 -------------
 244
 245 .. This section should contain removed items in this release. Sample format:
 246
 247    * Add a short 1-2 sentence description of the removed item in the past
 248      tense.
 249
 250    This section is a comment. do not overwrite or remove it.
 251    Also, make sure to start the actual text at the margin.
 252    =========================================================
 253
 254 * KNI vhost support removed.
 255
 256
 257 Shared Library Versions
 258 -----------------------
 259
 260 .. Update any library version updated in this release and prepend with a ``+``
 261    sign, like this:
 262
 263      librte_acl.so.2
 264    + librte_cfgfile.so.2
 265      librte_cmdline.so.2
 266
 267    This section is a comment. do not overwrite or remove it.
 268    =========================================================
 269
 270
 271 The libraries prepended with a plus sign were incremented in this version.
 272
 273 .. code-block:: diff
 274
 275      librte_acl.so.2
 276      librte_cfgfile.so.2
 277      librte_cmdline.so.2
 278      librte_cryptodev.so.2
 279      librte_distributor.so.1
 280      librte_eal.so.3
 281      librte_ethdev.so.6
 282      librte_hash.so.2
 283      librte_ip_frag.so.1
 284      librte_jobstats.so.1
 285      librte_kni.so.2
 286      librte_kvargs.so.1
 287      librte_lpm.so.2
 288      librte_mbuf.so.2
 289      librte_mempool.so.2
 290      librte_meter.so.1
 291      librte_net.so.1
 292      librte_pdump.so.1
 293      librte_pipeline.so.3
 294      librte_pmd_bond.so.1
 295      librte_pmd_ring.so.2
 296      librte_port.so.3
 297      librte_power.so.1
 298      librte_reorder.so.1
 299      librte_ring.so.1
 300      librte_sched.so.1
 301      librte_table.so.2
 302      librte_timer.so.1
 303      librte_vhost.so.3
 304
 305
 306 Tested Platforms
 307 ----------------
 308
 309 .. This section should contain a list of platforms that were tested with this
 310    release.
 311
 312    The format is:
 313
 314    * <vendor> platform with <vendor> <type of devices> combinations
 315
 316      * List of CPU
 317      * List of OS
 318      * List of devices
 319      * Other relevant details...
 320
 321    This section is a comment. do not overwrite or remove it.
 322    Also, make sure to start the actual text at the margin.
 323    =========================================================