doc/guides/rel_notes/release_17_02.rst

   1 DPDK Release 17.02
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text 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: ``LIKE_THIS``.
  11
  12    Build the docs and view the output file to ensure the changes are correct::
  13
  14       make doc-guides-html
  15
  16       firefox build/doc/html/guides/rel_notes/release_17_02.html
  17
  18
  19 New Features
  20 ------------
  21
  22 .. This section should contain new features added in this release. Sample format:
  23
  24    * **Add a title in the past tense with a full stop.**
  25
  26      Add a short 1-2 sentence description in the past tense. The description
  27      should be enough to allow someone scanning the release notes to understand
  28      the new feature.
  29
  30      If the feature adds a lot of sub-features you can use a bullet list like this.
  31
  32      * Added feature foo to do something.
  33      * Enhanced feature bar to do something else.
  34
  35      Refer to the previous release notes for examples.
  36
  37      This section is a comment. do not overwrite or remove it.
  38      Also, make sure to start the actual text at the margin.
  39      =========================================================
  40
  41 * **Added generic flow API (rte_flow).**
  42
  43   This API provides a generic means to configure hardware to match specific
  44   ingress or egress traffic, alter its fate and query related counters
  45   according to any number of user-defined rules.
  46
  47   It is slightly higher-level than the legacy filtering framework which it
  48   encompasses and supersedes (including all functions and filter types) in
  49   order to expose a single interface with an unambiguous behavior that is
  50   common to all poll-mode drivers (PMDs).
  51
  52   See the :ref:`Generic flow API <Generic_flow_API>` documentation for more
  53   information.
  54
  55 * **Added firmware version get API.**
  56
  57   Added a new function ``rte_eth_dev_fw_version_get()`` to fetch firmware
  58   version by a given device.
  59
  60 * **Added APIs for MACsec offload support to the ixgbe PMD.**
  61
  62   Six new APIs have been added to the ixgbe PMD for MACsec offload support.
  63   The declarations for the APIs can be found in ``rte_pmd_ixgbe.h``.
  64
  65 * **Added I219 NICs support.**
  66
  67   Added support for I219 Intel 1GbE NICs.
  68
  69 * **Added Solarflare libefx-based network PMD.**
  70
  71   A new network PMD which supports Solarflare SFN7xxx and SFN8xxx family
  72   of 10/40 Gbps adapters has been added.
  73
  74 * **Added support for Mellanox ConnectX-5 adapters (mlx5).**
  75
  76   Support for Mellanox ConnectX-5 family of 10/25/40/50/100 Gbps adapters
  77   has been added to the existing mlx5 PMD.
  78
  79 * **virtio-user with vhost-kernel as another exceptional path.**
  80
  81   Previously, we upstreamed a virtual device, virtio-user with vhost-user
  82   as the backend, as a way for IPC (Inter-Process Communication) and user
  83   space container networking.
  84
  85   Virtio-user with vhost-kernel as the backend is a solution for exceptional
  86   path, such as KNI, which exchanges packets with kernel networking stack.
  87   This solution is very promising in:
  88
  89   * maintenance: vhost and vhost-net (kernel) is upstreamed and extensively
  90     used kernel module.
  91   * features: vhost-net is born to be a networking solution, which has
  92     lots of networking related features, like multi-queue, TSO, multi-seg
  93     mbuf, etc.
  94   * performance: similar to KNI, this solution would use one or more
  95     kthreads to send/receive packets from user space DPDK applications,
  96     which has little impact on user space polling thread (except that
  97     it might enter into kernel space to wake up those kthreads if
  98     necessary).
  99
 100 * **Added virtio Rx interrupt suppprt.**
 101
 102   This feature enables Rx interrupt mode for virtio pci net devices as
 103   binded to VFIO (noiommu mode) and drived by virtio PMD.
 104
 105   With this feature, virtio PMD can switch between polling mode and
 106   interrupt mode, to achieve best performance, and at the same time save
 107   power. It can work on both legacy and modern virtio devices. At this mode,
 108   each rxq is mapped with an exluded MSIx interrupt.
 109
 110   See the :ref:`Virtio Interrupt Mode <virtio_interrupt_mode>` documentation
 111   for more information.
 112
 113
 114 Resolved Issues
 115 ---------------
 116
 117 .. This section should contain bug fixes added to the relevant sections. Sample format:
 118
 119    * **code/section Fixed issue in the past tense with a full stop.**
 120
 121      Add a short 1-2 sentence description of the resolved issue in the past tense.
 122      The title should contain the code/lib section like a commit message.
 123      Add the entries in alphabetic order in the relevant sections below.
 124
 125    This section is a comment. do not overwrite or remove it.
 126    Also, make sure to start the actual text at the margin.
 127    =========================================================
 128
 129
 130 EAL
 131 ~~~
 132
 133
 134 Drivers
 135 ~~~~~~~
 136
 137 * **net/virtio: Fixed multiple process support.**
 138
 139   Fixed few regressions introduced in recent releases that break the virtio
 140   multiple process support.
 141
 142
 143 Libraries
 144 ~~~~~~~~~
 145
 146
 147 Examples
 148 ~~~~~~~~
 149
 150 * **examples/ethtool: Fixed crash with non-PCI devices.**
 151
 152   Querying a non-PCI device was dereferencing non-existent PCI data
 153   resulting in a segmentation fault.
 154
 155
 156 Other
 157 ~~~~~
 158
 159
 160 Known Issues
 161 ------------
 162
 163 .. This section should contain new known issues in this release. Sample format:
 164
 165    * **Add title in present tense with full stop.**
 166
 167      Add a short 1-2 sentence description of the known issue in the present
 168      tense. Add information on any known workarounds.
 169
 170    This section is a comment. do not overwrite or remove it.
 171    Also, make sure to start the actual text at the margin.
 172    =========================================================
 173
 174
 175 API Changes
 176 -----------
 177
 178 .. This section should contain API changes. Sample format:
 179
 180    * Add a short 1-2 sentence description of the API change. Use fixed width
 181      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 182
 183    This section is a comment. do not overwrite or remove it.
 184    Also, make sure to start the actual text at the margin.
 185    =========================================================
 186
 187 * **Moved five APIs for VF management from the ethdev to the ixgbe PMD.**
 188
 189   The following five APIs for VF management from the PF have been removed from the ethdev,
 190   renamed and added to the ixgbe PMD::
 191
 192     rte_eth_dev_set_vf_rate_limit
 193     rte_eth_dev_set_vf_rx
 194     rte_eth_dev_set_vf_rxmode
 195     rte_eth_dev_set_vf_tx
 196     rte_eth_dev_set_vf_vlan_filter
 197
 198   The API's have been renamed to the following::
 199
 200     rte_pmd_ixgbe_set_vf_rate_limit
 201     rte_pmd_ixgbe_set_vf_rx
 202     rte_pmd_ixgbe_set_vf_rxmode
 203     rte_pmd_ixgbe_set_vf_tx
 204     rte_pmd_ixgbe_set_vf_vlan_filter
 205
 206   The declarations for the API’s can be found in ``rte_pmd_ixgbe.h``.
 207
 208 ABI Changes
 209 -----------
 210
 211 .. This section should contain ABI changes. Sample format:
 212
 213    * Add a short 1-2 sentence description of the ABI change that was announced in
 214      the previous releases and made in this release. Use fixed width quotes for
 215      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 216
 217    This section is a comment. do not overwrite or remove it.
 218    Also, make sure to start the actual text at the margin.
 219    =========================================================
 220
 221
 222
 223 Shared Library Versions
 224 -----------------------
 225
 226 .. Update any library version updated in this release and prepend with a ``+``
 227    sign, like this:
 228
 229      librte_acl.so.2
 230    + librte_cfgfile.so.2
 231      librte_cmdline.so.2
 232
 233    This section is a comment. do not overwrite or remove it.
 234    =========================================================
 235
 236
 237 The libraries prepended with a plus sign were incremented in this version.
 238
 239 .. code-block:: diff
 240
 241      librte_acl.so.2
 242      librte_cfgfile.so.2
 243      librte_cmdline.so.2
 244      librte_cryptodev.so.2
 245      librte_distributor.so.1
 246      librte_eal.so.3
 247    + librte_ethdev.so.6
 248      librte_hash.so.2
 249      librte_ip_frag.so.1
 250      librte_jobstats.so.1
 251      librte_kni.so.2
 252      librte_kvargs.so.1
 253      librte_lpm.so.2
 254      librte_mbuf.so.2
 255      librte_mempool.so.2
 256      librte_meter.so.1
 257      librte_net.so.1
 258      librte_pdump.so.1
 259      librte_pipeline.so.3
 260      librte_pmd_bond.so.1
 261      librte_pmd_ring.so.2
 262      librte_port.so.3
 263      librte_power.so.1
 264      librte_reorder.so.1
 265      librte_ring.so.1
 266      librte_sched.so.1
 267      librte_table.so.2
 268      librte_timer.so.1
 269      librte_vhost.so.3
 270
 271
 272 Tested Platforms
 273 ----------------
 274
 275 .. This section should contain a list of platforms that were tested with this release.
 276
 277    The format is:
 278
 279    #. Platform name.
 280
 281       * Platform details.
 282       * Platform details.
 283
 284    This section is a comment. do not overwrite or remove it.
 285    Also, make sure to start the actual text at the margin.
 286    =========================================================
 287
 288
 289 Tested NICs
 290 -----------
 291
 292 .. This section should contain a list of NICs that were tested with this release.
 293
 294    The format is:
 295
 296    #. NIC name.
 297
 298       * NIC details.
 299       * NIC details.
 300
 301    This section is a comment. do not overwrite or remove it.
 302    Also, make sure to start the actual text at the margin.
 303    =========================================================
 304
 305
 306 Tested OSes
 307 -----------
 308
 309 .. This section should contain a list of OSes that were tested with this release.
 310    The format is as follows, in alphabetical order:
 311
 312    * CentOS 7.0
 313    * Fedora 23
 314    * Fedora 24
 315    * FreeBSD 10.3
 316    * Red Hat Enterprise Linux 7.2
 317    * SUSE Enterprise Linux 12
 318    * Ubuntu 15.10
 319    * Ubuntu 16.04 LTS
 320    * Wind River Linux 8
 321
 322    This section is a comment. do not overwrite or remove it.
 323    Also, make sure to start the actual text at the margin.
 324    =========================================================