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