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 * **Updated the AES-NI GCM PMD.**
 165
 166   The AES-NI GCM PMD was migrated from MB library to ISA-L library.
 167   The migration entailed the following additional support for:
 168
 169   * GMAC algorithm.
 170   * 256-bit cipher key.
 171   * Session-less mode.
 172   * Out-of place processing
 173   * Scatter-gatter support for chained mbufs (only out-of place and destination
 174     mbuf must be contiguous)
 175
 176 * **Added Elastic Flow Distributor library (rte_efd).**
 177
 178   This new library uses perfect hashing to determine a target/value for a
 179   given incoming flow key.
 180
 181   It does not store the key itself for lookup operations, and therefore,
 182   lookup performance is not dependent on the key size. Also, the target/value
 183   can be any arbitrary value (8 bits by default). Finally, the storage requirement
 184   is much smaller than a hash-based flow table and therefore, it can better fit for
 185   CPU cache, being able to scale to millions of flow keys.
 186
 187   See the :ref:`Elastic Flow Distributor Library <Efd_Library>` documentation in
 188   the Programmers Guide document, for more information.
 189
 190
 191 Resolved Issues
 192 ---------------
 193
 194 .. This section should contain bug fixes added to the relevant sections. Sample format:
 195
 196    * **code/section Fixed issue in the past tense with a full stop.**
 197
 198      Add a short 1-2 sentence description of the resolved issue in the past tense.
 199      The title should contain the code/lib section like a commit message.
 200      Add the entries in alphabetic order in the relevant sections below.
 201
 202    This section is a comment. do not overwrite or remove it.
 203    Also, make sure to start the actual text at the margin.
 204    =========================================================
 205
 206
 207 EAL
 208 ~~~
 209
 210
 211 Drivers
 212 ~~~~~~~
 213
 214 * **net/virtio: Fixed multiple process support.**
 215
 216   Fixed few regressions introduced in recent releases that break the virtio
 217   multiple process support.
 218
 219
 220 Libraries
 221 ~~~~~~~~~
 222
 223
 224 Examples
 225 ~~~~~~~~
 226
 227 * **examples/ethtool: Fixed crash with non-PCI devices.**
 228
 229   Querying a non-PCI device was dereferencing non-existent PCI data
 230   resulting in a segmentation fault.
 231
 232
 233 Other
 234 ~~~~~
 235
 236
 237 Known Issues
 238 ------------
 239
 240 .. This section should contain new known issues in this release. Sample format:
 241
 242    * **Add title in present tense with full stop.**
 243
 244      Add a short 1-2 sentence description of the known issue in the present
 245      tense. Add information on any known workarounds.
 246
 247    This section is a comment. do not overwrite or remove it.
 248    Also, make sure to start the actual text at the margin.
 249    =========================================================
 250
 251
 252 API Changes
 253 -----------
 254
 255 .. This section should contain API changes. Sample format:
 256
 257    * Add a short 1-2 sentence description of the API change. Use fixed width
 258      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 259
 260    This section is a comment. do not overwrite or remove it.
 261    Also, make sure to start the actual text at the margin.
 262    =========================================================
 263
 264 * **Moved five APIs for VF management from the ethdev to the ixgbe PMD.**
 265
 266   The following five APIs for VF management from the PF have been removed from the ethdev,
 267   renamed and added to the ixgbe PMD::
 268
 269     rte_eth_dev_set_vf_rate_limit
 270     rte_eth_dev_set_vf_rx
 271     rte_eth_dev_set_vf_rxmode
 272     rte_eth_dev_set_vf_tx
 273     rte_eth_dev_set_vf_vlan_filter
 274
 275   The API's have been renamed to the following::
 276
 277     rte_pmd_ixgbe_set_vf_rate_limit
 278     rte_pmd_ixgbe_set_vf_rx
 279     rte_pmd_ixgbe_set_vf_rxmode
 280     rte_pmd_ixgbe_set_vf_tx
 281     rte_pmd_ixgbe_set_vf_vlan_filter
 282
 283   The declarations for the API’s can be found in ``rte_pmd_ixgbe.h``.
 284
 285 ABI Changes
 286 -----------
 287
 288 .. This section should contain ABI changes. Sample format:
 289
 290    * Add a short 1-2 sentence description of the ABI change that was announced in
 291      the previous releases and made in this release. Use fixed width quotes for
 292      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 293
 294    This section is a comment. do not overwrite or remove it.
 295    Also, make sure to start the actual text at the margin.
 296    =========================================================
 297
 298
 299
 300 Shared Library Versions
 301 -----------------------
 302
 303 .. Update any library version updated in this release and prepend with a ``+``
 304    sign, like this:
 305
 306      librte_acl.so.2
 307    + librte_cfgfile.so.2
 308      librte_cmdline.so.2
 309
 310    This section is a comment. do not overwrite or remove it.
 311    =========================================================
 312
 313
 314 The libraries prepended with a plus sign were incremented in this version.
 315
 316 .. code-block:: diff
 317
 318      librte_acl.so.2
 319      librte_cfgfile.so.2
 320      librte_cmdline.so.2
 321      librte_cryptodev.so.2
 322      librte_distributor.so.1
 323      librte_eal.so.3
 324    + librte_ethdev.so.6
 325      librte_hash.so.2
 326      librte_ip_frag.so.1
 327      librte_jobstats.so.1
 328      librte_kni.so.2
 329      librte_kvargs.so.1
 330      librte_lpm.so.2
 331      librte_mbuf.so.2
 332      librte_mempool.so.2
 333      librte_meter.so.1
 334      librte_net.so.1
 335      librte_pdump.so.1
 336      librte_pipeline.so.3
 337      librte_pmd_bond.so.1
 338      librte_pmd_ring.so.2
 339      librte_port.so.3
 340      librte_power.so.1
 341      librte_reorder.so.1
 342      librte_ring.so.1
 343      librte_sched.so.1
 344      librte_table.so.2
 345      librte_timer.so.1
 346      librte_vhost.so.3
 347
 348
 349 Tested Platforms
 350 ----------------
 351
 352 .. This section should contain a list of platforms that were tested with this release.
 353
 354    The format is:
 355
 356    #. Platform name.
 357
 358       * Platform details.
 359       * Platform details.
 360
 361    This section is a comment. do not overwrite or remove it.
 362    Also, make sure to start the actual text at the margin.
 363    =========================================================
 364
 365
 366 Tested NICs
 367 -----------
 368
 369 .. This section should contain a list of NICs that were tested with this release.
 370
 371    The format is:
 372
 373    #. NIC name.
 374
 375       * NIC details.
 376       * NIC details.
 377
 378    This section is a comment. do not overwrite or remove it.
 379    Also, make sure to start the actual text at the margin.
 380    =========================================================
 381
 382
 383 Tested OSes
 384 -----------
 385
 386 .. This section should contain a list of OSes that were tested with this release.
 387    The format is as follows, in alphabetical order:
 388
 389    * CentOS 7.0
 390    * Fedora 23
 391    * Fedora 24
 392    * FreeBSD 10.3
 393    * Red Hat Enterprise Linux 7.2
 394    * SUSE Enterprise Linux 12
 395    * Ubuntu 15.10
 396    * Ubuntu 16.04 LTS
 397    * Wind River Linux 8
 398
 399    This section is a comment. do not overwrite or remove it.
 400    Also, make sure to start the actual text at the margin.
 401    =========================================================