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