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