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