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 * **virtio-user with vhost-kernel as another exceptional path.**
  75
  76   Previously, we upstreamed a virtual device, virtio-user with vhost-user
  77   as the backend, as a way for IPC (Inter-Process Communication) and user
  78   space container networking.
  79
  80   Virtio-user with vhost-kernel as the backend is a solution for exceptional
  81   path, such as KNI, which exchanges packets with kernel networking stack.
  82   This solution is very promising in:
  83
  84   * maintenance: vhost and vhost-net (kernel) is upstreamed and extensively
  85     used kernel module.
  86   * features: vhost-net is born to be a networking solution, which has
  87     lots of networking related features, like multi-queue, TSO, multi-seg
  88     mbuf, etc.
  89   * performance: similar to KNI, this solution would use one or more
  90     kthreads to send/receive packets from user space DPDK applications,
  91     which has little impact on user space polling thread (except that
  92     it might enter into kernel space to wake up those kthreads if
  93     necessary).
  94
  95 * **Added virtio Rx interrupt suppprt.**
  96
  97   This feature enables Rx interrupt mode for virtio pci net devices as
  98   binded to VFIO (noiommu mode) and drived by virtio PMD.
  99
 100   With this feature, virtio PMD can switch between polling mode and
 101   interrupt mode, to achieve best performance, and at the same time save
 102   power. It can work on both legacy and modern virtio devices. At this mode,
 103   each rxq is mapped with an exluded MSIx interrupt.
 104
 105   See the :ref:`Virtio Interrupt Mode <virtio_interrupt_mode>` documentation
 106   for more information.
 107
 108
 109 Resolved Issues
 110 ---------------
 111
 112 .. This section should contain bug fixes added to the relevant sections. Sample format:
 113
 114    * **code/section Fixed issue in the past tense with a full stop.**
 115
 116      Add a short 1-2 sentence description of the resolved issue in the past tense.
 117      The title should contain the code/lib section like a commit message.
 118      Add the entries in alphabetic order in the relevant sections below.
 119
 120    This section is a comment. do not overwrite or remove it.
 121    Also, make sure to start the actual text at the margin.
 122    =========================================================
 123
 124
 125 EAL
 126 ~~~
 127
 128
 129 Drivers
 130 ~~~~~~~
 131
 132 * **net/virtio: Fixed multiple process support.**
 133
 134   Fixed few regressions introduced in recent releases that break the virtio
 135   multiple process support.
 136
 137
 138 Libraries
 139 ~~~~~~~~~
 140
 141
 142 Examples
 143 ~~~~~~~~
 144
 145 * **examples/ethtool: Fixed crash with non-PCI devices.**
 146
 147   Querying a non-PCI device was dereferencing non-existent PCI data
 148   resulting in a segmentation fault.
 149
 150
 151 Other
 152 ~~~~~
 153
 154
 155 Known Issues
 156 ------------
 157
 158 .. This section should contain new known issues in this release. Sample format:
 159
 160    * **Add title in present tense with full stop.**
 161
 162      Add a short 1-2 sentence description of the known issue in the present
 163      tense. Add information on any known workarounds.
 164
 165    This section is a comment. do not overwrite or remove it.
 166    Also, make sure to start the actual text at the margin.
 167    =========================================================
 168
 169
 170 API Changes
 171 -----------
 172
 173 .. This section should contain API changes. Sample format:
 174
 175    * Add a short 1-2 sentence description of the API change. Use fixed width
 176      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past 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 * **Moved five APIs for VF management from the ethdev to the ixgbe PMD.**
 183
 184   The following five APIs for VF management from the PF have been removed from the ethdev,
 185   renamed and added to the ixgbe PMD::
 186
 187     rte_eth_dev_set_vf_rate_limit
 188     rte_eth_dev_set_vf_rx
 189     rte_eth_dev_set_vf_rxmode
 190     rte_eth_dev_set_vf_tx
 191     rte_eth_dev_set_vf_vlan_filter
 192
 193   The API's have been renamed to the following::
 194
 195     rte_pmd_ixgbe_set_vf_rate_limit
 196     rte_pmd_ixgbe_set_vf_rx
 197     rte_pmd_ixgbe_set_vf_rxmode
 198     rte_pmd_ixgbe_set_vf_tx
 199     rte_pmd_ixgbe_set_vf_vlan_filter
 200
 201   The declarations for the API’s can be found in ``rte_pmd_ixgbe.h``.
 202
 203 ABI Changes
 204 -----------
 205
 206 .. This section should contain ABI changes. Sample format:
 207
 208    * Add a short 1-2 sentence description of the ABI change that was announced in
 209      the previous releases and made in this release. Use fixed width quotes for
 210      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 211
 212    This section is a comment. do not overwrite or remove it.
 213    Also, make sure to start the actual text at the margin.
 214    =========================================================
 215
 216
 217
 218 Shared Library Versions
 219 -----------------------
 220
 221 .. Update any library version updated in this release and prepend with a ``+``
 222    sign, like this:
 223
 224      librte_acl.so.2
 225    + librte_cfgfile.so.2
 226      librte_cmdline.so.2
 227
 228    This section is a comment. do not overwrite or remove it.
 229    =========================================================
 230
 231
 232 The libraries prepended with a plus sign were incremented in this version.
 233
 234 .. code-block:: diff
 235
 236      librte_acl.so.2
 237      librte_cfgfile.so.2
 238      librte_cmdline.so.2
 239      librte_cryptodev.so.2
 240      librte_distributor.so.1
 241      librte_eal.so.3
 242    + librte_ethdev.so.6
 243      librte_hash.so.2
 244      librte_ip_frag.so.1
 245      librte_jobstats.so.1
 246      librte_kni.so.2
 247      librte_kvargs.so.1
 248      librte_lpm.so.2
 249      librte_mbuf.so.2
 250      librte_mempool.so.2
 251      librte_meter.so.1
 252      librte_net.so.1
 253      librte_pdump.so.1
 254      librte_pipeline.so.3
 255      librte_pmd_bond.so.1
 256      librte_pmd_ring.so.2
 257      librte_port.so.3
 258      librte_power.so.1
 259      librte_reorder.so.1
 260      librte_ring.so.1
 261      librte_sched.so.1
 262      librte_table.so.2
 263      librte_timer.so.1
 264      librte_vhost.so.3
 265
 266
 267 Tested Platforms
 268 ----------------
 269
 270 .. This section should contain a list of platforms that were tested with this release.
 271
 272    The format is:
 273
 274    #. Platform name.
 275
 276       * Platform details.
 277       * Platform details.
 278
 279    This section is a comment. do not overwrite or remove it.
 280    Also, make sure to start the actual text at the margin.
 281    =========================================================
 282
 283
 284 Tested NICs
 285 -----------
 286
 287 .. This section should contain a list of NICs that were tested with this release.
 288
 289    The format is:
 290
 291    #. NIC name.
 292
 293       * NIC details.
 294       * NIC details.
 295
 296    This section is a comment. do not overwrite or remove it.
 297    Also, make sure to start the actual text at the margin.
 298    =========================================================
 299
 300
 301 Tested OSes
 302 -----------
 303
 304 .. This section should contain a list of OSes that were tested with this release.
 305    The format is as follows, in alphabetical order:
 306
 307    * CentOS 7.0
 308    * Fedora 23
 309    * Fedora 24
 310    * FreeBSD 10.3
 311    * Red Hat Enterprise Linux 7.2
 312    * SUSE Enterprise Linux 12
 313    * Ubuntu 15.10
 314    * Ubuntu 16.04 LTS
 315    * Wind River Linux 8
 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    =========================================================