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
 183 ABI Changes
 184 -----------
 185
 186 .. This section should contain ABI changes. Sample format:
 187
 188    * Add a short 1-2 sentence description of the ABI change that was announced in
 189      the previous releases and made in this release. Use fixed width quotes for
 190      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 191
 192    This section is a comment. do not overwrite or remove it.
 193    Also, make sure to start the actual text at the margin.
 194    =========================================================
 195
 196
 197
 198 Shared Library Versions
 199 -----------------------
 200
 201 .. Update any library version updated in this release and prepend with a ``+``
 202    sign, like this:
 203
 204      librte_acl.so.2
 205    + librte_cfgfile.so.2
 206      librte_cmdline.so.2
 207
 208    This section is a comment. do not overwrite or remove it.
 209    =========================================================
 210
 211
 212 The libraries prepended with a plus sign were incremented in this version.
 213
 214 .. code-block:: diff
 215
 216      librte_acl.so.2
 217      librte_cfgfile.so.2
 218      librte_cmdline.so.2
 219      librte_cryptodev.so.2
 220      librte_distributor.so.1
 221      librte_eal.so.3
 222      librte_ethdev.so.5
 223      librte_hash.so.2
 224      librte_ip_frag.so.1
 225      librte_jobstats.so.1
 226      librte_kni.so.2
 227      librte_kvargs.so.1
 228      librte_lpm.so.2
 229      librte_mbuf.so.2
 230      librte_mempool.so.2
 231      librte_meter.so.1
 232      librte_net.so.1
 233      librte_pdump.so.1
 234      librte_pipeline.so.3
 235      librte_pmd_bond.so.1
 236      librte_pmd_ring.so.2
 237      librte_port.so.3
 238      librte_power.so.1
 239      librte_reorder.so.1
 240      librte_ring.so.1
 241      librte_sched.so.1
 242      librte_table.so.2
 243      librte_timer.so.1
 244      librte_vhost.so.3
 245
 246
 247 Tested Platforms
 248 ----------------
 249
 250 .. This section should contain a list of platforms that were tested with this release.
 251
 252    The format is:
 253
 254    #. Platform name.
 255
 256       * Platform details.
 257       * Platform details.
 258
 259    This section is a comment. do not overwrite or remove it.
 260    Also, make sure to start the actual text at the margin.
 261    =========================================================
 262
 263
 264 Tested NICs
 265 -----------
 266
 267 .. This section should contain a list of NICs that were tested with this release.
 268
 269    The format is:
 270
 271    #. NIC name.
 272
 273       * NIC details.
 274       * NIC details.
 275
 276    This section is a comment. do not overwrite or remove it.
 277    Also, make sure to start the actual text at the margin.
 278    =========================================================
 279
 280
 281 Tested OSes
 282 -----------
 283
 284 .. This section should contain a list of OSes that were tested with this release.
 285    The format is as follows, in alphabetical order:
 286
 287    * CentOS 7.0
 288    * Fedora 23
 289    * Fedora 24
 290    * FreeBSD 10.3
 291    * Red Hat Enterprise Linux 7.2
 292    * SUSE Enterprise Linux 12
 293    * Ubuntu 15.10
 294    * Ubuntu 16.04 LTS
 295    * Wind River Linux 8
 296
 297    This section is a comment. do not overwrite or remove it.
 298    Also, make sure to start the actual text at the margin.
 299    =========================================================