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 * **Updated the i40e base driver.**
  98
  99   updated the i40e base driver, including the following changes:
 100
 101   * replace existing legacy memcpy() calls with i40e_memcpy() calls.
 102   * use BIT() macro instead of bit fields
 103   * add clear all WoL filters implementation
 104   * add broadcast promiscuous control per VLAN
 105   * remove unused X722_SUPPORT and I40E_NDIS_SUPPORT MARCOs
 106
 107 * **Added Solarflare libefx-based network PMD.**
 108
 109   A new network PMD which supports Solarflare SFN7xxx and SFN8xxx family
 110   of 10/40 Gbps adapters has been added.
 111
 112 * **Added support for Mellanox ConnectX-5 adapters (mlx5).**
 113
 114   Support for Mellanox ConnectX-5 family of 10/25/40/50/100 Gbps adapters
 115   has been added to the existing mlx5 PMD.
 116
 117 * **virtio-user with vhost-kernel as another exceptional path.**
 118
 119   Previously, we upstreamed a virtual device, virtio-user with vhost-user
 120   as the backend, as a way for IPC (Inter-Process Communication) and user
 121   space container networking.
 122
 123   Virtio-user with vhost-kernel as the backend is a solution for exceptional
 124   path, such as KNI, which exchanges packets with kernel networking stack.
 125   This solution is very promising in:
 126
 127   * maintenance: vhost and vhost-net (kernel) is upstreamed and extensively
 128     used kernel module.
 129   * features: vhost-net is born to be a networking solution, which has
 130     lots of networking related features, like multi-queue, TSO, multi-seg
 131     mbuf, etc.
 132   * performance: similar to KNI, this solution would use one or more
 133     kthreads to send/receive packets from user space DPDK applications,
 134     which has little impact on user space polling thread (except that
 135     it might enter into kernel space to wake up those kthreads if
 136     necessary).
 137
 138 * **Added virtio Rx interrupt suppprt.**
 139
 140   This feature enables Rx interrupt mode for virtio pci net devices as
 141   binded to VFIO (noiommu mode) and drived by virtio PMD.
 142
 143   With this feature, virtio PMD can switch between polling mode and
 144   interrupt mode, to achieve best performance, and at the same time save
 145   power. It can work on both legacy and modern virtio devices. At this mode,
 146   each rxq is mapped with an exluded MSIx interrupt.
 147
 148   See the :ref:`Virtio Interrupt Mode <virtio_interrupt_mode>` documentation
 149   for more information.
 150
 151 * **Updated the QAT PMD.**
 152
 153   The QAT PMD was updated with additional support for:
 154
 155   * DES algorithm.
 156   * Scatter-gather list (SGL) support.
 157
 158 * **Updated the AESNI MB PMD.**
 159
 160   * The Intel(R) Multi Buffer Crypto for IPsec library used in
 161     AESNI MB PMD has been moved to a new repository, in GitHub.
 162   * Support for single operations (cipher only and authentication only).
 163
 164 * **Added Elastic Flow Distributor library (rte_efd).**
 165
 166   This new library uses perfect hashing to determine a target/value for a
 167   given incoming flow key.
 168
 169   It does not store the key itself for lookup operations, and therefore,
 170   lookup performance is not dependent on the key size. Also, the target/value
 171   can be any arbitrary value (8 bits by default). Finally, the storage requirement
 172   is much smaller than a hash-based flow table and therefore, it can better fit for
 173   CPU cache, being able to scale to millions of flow keys.
 174
 175   See the :ref:`Elastic Flow Distributor Library <Efd_Library>` documentation in
 176   the Programmers Guide document, for more information.
 177
 178
 179 Resolved Issues
 180 ---------------
 181
 182 .. This section should contain bug fixes added to the relevant sections. Sample format:
 183
 184    * **code/section Fixed issue in the past tense with a full stop.**
 185
 186      Add a short 1-2 sentence description of the resolved issue in the past tense.
 187      The title should contain the code/lib section like a commit message.
 188      Add the entries in alphabetic order in the relevant sections below.
 189
 190    This section is a comment. do not overwrite or remove it.
 191    Also, make sure to start the actual text at the margin.
 192    =========================================================
 193
 194
 195 EAL
 196 ~~~
 197
 198
 199 Drivers
 200 ~~~~~~~
 201
 202 * **net/virtio: Fixed multiple process support.**
 203
 204   Fixed few regressions introduced in recent releases that break the virtio
 205   multiple process support.
 206
 207
 208 Libraries
 209 ~~~~~~~~~
 210
 211
 212 Examples
 213 ~~~~~~~~
 214
 215 * **examples/ethtool: Fixed crash with non-PCI devices.**
 216
 217   Querying a non-PCI device was dereferencing non-existent PCI data
 218   resulting in a segmentation fault.
 219
 220
 221 Other
 222 ~~~~~
 223
 224
 225 Known Issues
 226 ------------
 227
 228 .. This section should contain new known issues in this release. Sample format:
 229
 230    * **Add title in present tense with full stop.**
 231
 232      Add a short 1-2 sentence description of the known issue in the present
 233      tense. Add information on any known workarounds.
 234
 235    This section is a comment. do not overwrite or remove it.
 236    Also, make sure to start the actual text at the margin.
 237    =========================================================
 238
 239
 240 API Changes
 241 -----------
 242
 243 .. This section should contain API changes. Sample format:
 244
 245    * Add a short 1-2 sentence description of the API change. Use fixed width
 246      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 247
 248    This section is a comment. do not overwrite or remove it.
 249    Also, make sure to start the actual text at the margin.
 250    =========================================================
 251
 252 * **Moved five APIs for VF management from the ethdev to the ixgbe PMD.**
 253
 254   The following five APIs for VF management from the PF have been removed from the ethdev,
 255   renamed and added to the ixgbe PMD::
 256
 257     rte_eth_dev_set_vf_rate_limit
 258     rte_eth_dev_set_vf_rx
 259     rte_eth_dev_set_vf_rxmode
 260     rte_eth_dev_set_vf_tx
 261     rte_eth_dev_set_vf_vlan_filter
 262
 263   The API's have been renamed to the following::
 264
 265     rte_pmd_ixgbe_set_vf_rate_limit
 266     rte_pmd_ixgbe_set_vf_rx
 267     rte_pmd_ixgbe_set_vf_rxmode
 268     rte_pmd_ixgbe_set_vf_tx
 269     rte_pmd_ixgbe_set_vf_vlan_filter
 270
 271   The declarations for the API’s can be found in ``rte_pmd_ixgbe.h``.
 272
 273 ABI Changes
 274 -----------
 275
 276 .. This section should contain ABI changes. Sample format:
 277
 278    * Add a short 1-2 sentence description of the ABI change that was announced in
 279      the previous releases and made in this release. Use fixed width quotes for
 280      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 281
 282    This section is a comment. do not overwrite or remove it.
 283    Also, make sure to start the actual text at the margin.
 284    =========================================================
 285
 286
 287
 288 Shared Library Versions
 289 -----------------------
 290
 291 .. Update any library version updated in this release and prepend with a ``+``
 292    sign, like this:
 293
 294      librte_acl.so.2
 295    + librte_cfgfile.so.2
 296      librte_cmdline.so.2
 297
 298    This section is a comment. do not overwrite or remove it.
 299    =========================================================
 300
 301
 302 The libraries prepended with a plus sign were incremented in this version.
 303
 304 .. code-block:: diff
 305
 306      librte_acl.so.2
 307      librte_cfgfile.so.2
 308      librte_cmdline.so.2
 309      librte_cryptodev.so.2
 310      librte_distributor.so.1
 311      librte_eal.so.3
 312    + librte_ethdev.so.6
 313      librte_hash.so.2
 314      librte_ip_frag.so.1
 315      librte_jobstats.so.1
 316      librte_kni.so.2
 317      librte_kvargs.so.1
 318      librte_lpm.so.2
 319      librte_mbuf.so.2
 320      librte_mempool.so.2
 321      librte_meter.so.1
 322      librte_net.so.1
 323      librte_pdump.so.1
 324      librte_pipeline.so.3
 325      librte_pmd_bond.so.1
 326      librte_pmd_ring.so.2
 327      librte_port.so.3
 328      librte_power.so.1
 329      librte_reorder.so.1
 330      librte_ring.so.1
 331      librte_sched.so.1
 332      librte_table.so.2
 333      librte_timer.so.1
 334      librte_vhost.so.3
 335
 336
 337 Tested Platforms
 338 ----------------
 339
 340 .. This section should contain a list of platforms that were tested with this release.
 341
 342    The format is:
 343
 344    #. Platform name.
 345
 346       * Platform details.
 347       * Platform details.
 348
 349    This section is a comment. do not overwrite or remove it.
 350    Also, make sure to start the actual text at the margin.
 351    =========================================================
 352
 353
 354 Tested NICs
 355 -----------
 356
 357 .. This section should contain a list of NICs that were tested with this release.
 358
 359    The format is:
 360
 361    #. NIC name.
 362
 363       * NIC details.
 364       * NIC details.
 365
 366    This section is a comment. do not overwrite or remove it.
 367    Also, make sure to start the actual text at the margin.
 368    =========================================================
 369
 370
 371 Tested OSes
 372 -----------
 373
 374 .. This section should contain a list of OSes that were tested with this release.
 375    The format is as follows, in alphabetical order:
 376
 377    * CentOS 7.0
 378    * Fedora 23
 379    * Fedora 24
 380    * FreeBSD 10.3
 381    * Red Hat Enterprise Linux 7.2
 382    * SUSE Enterprise Linux 12
 383    * Ubuntu 15.10
 384    * Ubuntu 16.04 LTS
 385    * Wind River Linux 8
 386
 387    This section is a comment. do not overwrite or remove it.
 388    Also, make sure to start the actual text at the margin.
 389    =========================================================