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