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