doc/guides/rel_notes/release_18_02.rst

   1 DPDK Release 18.02
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text in the sections 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:
  11    ``LIKE_THIS``.
  12
  13    Build the docs and view the output file to ensure the changes are correct::
  14
  15       make doc-guides-html
  16
  17       xdg-open build/doc/html/guides/rel_notes/release_18_02.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release. Sample
  24    format:
  25
  26    * **Add a title in the past tense with a full stop.**
  27
  28      Add a short 1-2 sentence description in the past tense. The description
  29      should be enough to allow someone scanning the release notes to
  30      understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list like
  33      this:
  34
  35      * Added feature foo to do something.
  36      * Enhanced feature bar to do something else.
  37
  38      Refer to the previous release notes for examples.
  39
  40      This section is a comment. do not overwrite or remove it.
  41      Also, make sure to start the actual text at the margin.
  42      =========================================================
  43
  44 * **Add function to allow releasing internal EAL resources on exit**
  45
  46   During ``rte_eal_init()`` EAL allocates memory from hugepages to enable its
  47   core libraries to perform their tasks. The ``rte_eal_cleanup()`` function
  48   releases these resources, ensuring that no hugepage memory is leaked. It is
  49   expected that all DPDK applications call ``rte_eal_cleanup()`` before
  50   exiting. Not calling this function could result in leaking hugepages, leading
  51   to failure during initialization of secondary processes.
  52
  53 * **Added the ixgbe ethernet driver to support RSS with flow API.**
  54
  55   Rte_flow actually defined to include RSS, but till now, RSS is out of
  56   rte_flow. This patch is to support igb and ixgbe NIC with existing RSS
  57   configuration using rte_flow API.
  58
  59 * **Add MAC loopback support for i40e.**
  60
  61   Add MAC loopback support for i40e in order to support test task asked by
  62   users. According to the device configuration, it will setup TX->RX loopback
  63   link or not.
  64
  65 * **Add the support of run time determination of number of queues per i40e VF**
  66
  67   The number of queue per VF is determined by its host PF. If the PCI address
  68   of an i40e PF is aaaa:bb.cc, the number of queues per VF can be configured
  69   with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. The value n can be
  70   1, 2, 4, 8 or 16. If no such parameter is configured, the number of queues
  71   per VF is 4 by default.
  72
  73 * **Added the i40e ethernet driver to support RSS with flow API.**
  74
  75   Rte_flow actually defined to include RSS, but till now, RSS is out of
  76   rte_flow. This patch is to support i40e NIC with existing RSS
  77   configuration using rte_flow API.It also enable queue region configuration
  78   using flow API for i40e.
  79
  80 * **Updated i40e driver to support PPPoE/PPPoL2TP.**
  81
  82   Updated i40e PMD to support PPPoE/PPPoL2TP with PPPoE/PPPoL2TP supporting
  83   profiles which can be programmed by dynamic device personalization (DDP)
  84   process.
  85
  86 * **Updated mlx5 driver.**
  87
  88   Updated the mlx5 driver including the following changes:
  89
  90   * Enabled compilation as a plugin, thus removed the mandatory dependency with rdma-core.
  91     With the special compilation, the rdma-core libraries will be loaded only in case
  92     Mellanox device is being used. For binaries creation the PMD can be enabled, still not
  93     requiring from every end user to install rdma-core.
  94   * Improved multi-segment packet performance.
  95   * Changed driver name to use the PCI address to be compatible with OVS-DPDK APIs.
  96   * Extended statistics for physical port packet/byte counters.
  97   * Converted to the new offloads API.
  98   * Supported device removal check operation.
  99
 100 * **Updated mlx4 driver.**
 101
 102   Updated the mlx4 driver including the following changes:
 103
 104   * Enabled compilation as a plugin, thus removed the mandatory dependency with rdma-core.
 105     With the special compilation, the rdma-core libraries will be loaded only in case
 106     Mellanox device is being used. For binaries creation the PMD can be enabled, still not
 107     requiring from every end user to install rdma-core.
 108   * Improved data path performance.
 109   * Converted to the new offloads API.
 110   * Supported device removal check operation.
 111
 112 * **Added NVGRE and UDP tunnels support in Solarflare network PMD.**
 113
 114   Added support for NVGRE, VXLAN and GENEVE tunnels.
 115
 116   * Added support for UDP tunnel ports configuration.
 117   * Added tunneled packets classification.
 118   * Added inner checksum offload.
 119
 120 * **Added the igb ethernet driver to support RSS with flow API.**
 121
 122   Rte_flow actually defined to include RSS, but till now, RSS is out of
 123   rte_flow. This patch is to support igb NIC with existing RSS configuration
 124   using rte_flow API.
 125
 126 * **Add AVF (Adaptive Virtual Function) net PMD.**
 127
 128   A new net PMD has been added, which supports Intel® Ethernet Adaptive
 129   Virtual Function (AVF) with features list below:
 130
 131   * Basic Rx/Tx burst
 132   * SSE vectorized Rx/Tx burst
 133   * Promiscuous mode
 134   * MAC/VLAN offload
 135   * Checksum offload
 136   * TSO offload
 137   * Jumbo frame and MTU setting
 138   * RSS configuration
 139   * stats
 140   * Rx/Tx descriptor status
 141   * Link status update/event
 142
 143 * **Add feature supports for live migration from vhost-net to vhost-user.**
 144
 145   To make live migration from vhost-net to vhost-user possible, added
 146   feature supports for vhost-user. The features include:
 147
 148   * VIRTIO_F_ANY_LAYOUT
 149   * VIRTIO_F_EVENT_IDX
 150   * VIRTIO_NET_F_GUEST_ECN, VIRTIO_NET_F_HOST_ECN
 151   * VIRTIO_NET_F_GUEST_UFO, VIRTIO_NET_F_HOST_UFO
 152   * VIRTIO_NET_F_GSO
 153
 154 * **Updated the AESNI-MB PMD.**
 155
 156   The AESNI-MB PMD has been updated with additional support for:
 157
 158   * AES-CCM algorithm.
 159
 160 * **Updated the DPAA_SEC crypto driver to support rte_security.**
 161
 162   Updated the ``dpaa_sec`` crypto PMD to support ``rte_security`` lookaside
 163   protocol offload for IPSec.
 164
 165 * **Added Wireless Base Band Device (bbdev) abstraction.**
 166
 167   The Wireless Baseband Device library is an acceleration abstraction
 168   framework for 3gpp Layer 1 processing functions that provides a common
 169   programming interface for seamless opeartion on integrated or discrete
 170   hardware accelerators or using optimized software libraries for signal
 171   processing.
 172   The current release only supports 3GPP CRC, Turbo Coding and Rate
 173   Matching operations, as specified in 3GPP TS 36.212.
 174
 175   See the :doc:`../prog_guide/bbdev` programmer's guide for more details.
 176
 177 * **Added New eventdev OPDL PMD**
 178
 179   The OPDL (Ordered Packet Distribution Library) eventdev is a specific
 180   implementation of the eventdev API. It is particularly suited to packet
 181   processing workloads that have high throughput and low latency requirements.
 182   All packets follow the same path through the device. The order in which
 183   packets  follow is determinted by the order in which queues are set up.
 184   Events are left on the ring until they are transmitted. As a result packets
 185   do not go out of order.
 186
 187   With this change, application can use OPDL PMD by eventdev api.
 188
 189 * **Added New pipeline use case for dpdk-test-eventdev application**
 190
 191   The pipeline case can be used to simulate various stages in a real world
 192   application from packet receive to transmit while maintaining the packet
 193   ordering also measure the performance of the event device across the stages
 194   of the pipeline.
 195
 196   The pipeline use case has been made generic to work will all the event
 197   devices based on the capabilities.
 198
 199 * **Updated Eventdev Sample application to support event devices based on capability**
 200
 201   Updated Eventdev pipeline sample application to support various types of pipelines
 202   based on the capabilities of the attached event and ethernet devices. Also,
 203   renamed the application from SW PMD specific ``eventdev_pipeline_sw_pmd``
 204   to PMD agnostic ``eventdev_pipeline``.
 205
 206 * **Added Rawdev, a generic device support library.**
 207
 208   Rawdev library provides support for integrating any generic device type with
 209   DPDK framework. Generic devices are those which do not have a pre-defined
 210   type within DPDK, for example, ethernet, crypto, event etc.
 211   A set of northbound APIs have been defined which encompass a generic set of
 212   operations by allowing applications to interact with device using opaque
 213   structures/buffers. Also, southbound APIs provide APIs for integrating device
 214   either as as part of a physical bus (PCI, FSLMC etc) or through ``vdev``.
 215
 216   See the :doc:`../prog_guide/rawdev` programmer's guide for more details.
 217
 218 * **Added new multi-process communication channel**
 219
 220   Added a generic channel in EAL for multi-process (primary/secondary) communication.
 221   Consumers of this channel need to register an action with an action name to response
 222   a message received; the actions will be identified by the action name and executed
 223   in the context of a new dedicated thread for this channel. The list of new APIs:
 224
 225   * ``rte_mp_register`` and ``rte_mp_unregister`` are for action (un)registration.
 226   * ``rte_mp_sendmsg`` is for sending a message without blocking for a response.
 227   * ``rte_mp_request`` is for sending a request message and will block until
 228     it gets a reply message which is sent from the peer by ``rte_mp_reply``.
 229
 230 * **Add GRO support for VxLAN-tunneled packets.**
 231
 232   Add GRO support for VxLAN-tunneled packets. Supported VxLAN packets
 233   must contain an outer IPv4 header and inner TCP/IPv4 headers. VxLAN
 234   GRO doesn't check if input packets have correct checksums and doesn't
 235   update checksums for output packets. Additionally, it assumes the
 236   packets are complete (i.e., MF==0 && frag_off==0), when IP
 237   fragmentation is possible (i.e., DF==0).
 238
 239 * **Increased default Rx and Tx ring size in sample applications.**
 240
 241   Increased the default ``RX_RING_SIZE`` and ``TX_RING_SIZE`` to 1024 entries
 242   in testpmd and the sample applications to give better performance in the
 243   general case. The user should experiment with various Rx and Tx ring sizes
 244   for their specific application to get best performance.
 245
 246 * **Added new DPDK build system using the tools "meson" and "ninja" [EXPERIMENTAL]**
 247
 248   Added in support for building DPDK using ``meson`` and ``ninja``, which gives
 249   additional features, such as automatic build-time configuration, over the
 250   current build system using ``make``. For instructions on how to do a DPDK build
 251   using the new system, see the instructions in ``doc/build-sdk-meson.txt``.
 252
 253 .. note::
 254
 255     This new build system support is incomplete at this point and is added
 256     as experimental in this release. The existing build system using ``make``
 257     is unaffected by these changes, and can continue to be used for this
 258     and subsequent releases until such time as it's deprecation is announced.
 259
 260
 261 API Changes
 262 -----------
 263
 264 .. This section should contain API changes. Sample format:
 265
 266    * Add a short 1-2 sentence description of the API change. Use fixed width
 267      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 268      tense.
 269
 270    This section is a comment. do not overwrite or remove it.
 271    Also, make sure to start the actual text at the margin.
 272    =========================================================
 273
 274
 275 ABI Changes
 276 -----------
 277
 278 .. This section should contain ABI changes. Sample format:
 279
 280    * Add a short 1-2 sentence description of the ABI change that was announced
 281      in the previous releases and made in this release. Use fixed width quotes
 282      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 283
 284    This section is a comment. do not overwrite or remove it.
 285    Also, make sure to start the actual text at the margin.
 286    =========================================================
 287
 288
 289 Removed Items
 290 -------------
 291
 292 .. This section should contain removed items in this release. Sample format:
 293
 294    * Add a short 1-2 sentence description of the removed item in the past
 295      tense.
 296
 297    This section is a comment. do not overwrite or remove it.
 298    Also, make sure to start the actual text at the margin.
 299    =========================================================
 300
 301
 302 Known Issues
 303 ------------
 304
 305 .. This section should contain new known issues in this release. Sample format:
 306
 307    * **Add title in present tense with full stop.**
 308
 309      Add a short 1-2 sentence description of the known issue in the present
 310      tense. Add information on any known workarounds.
 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 Shared Library Versions
 318 -----------------------
 319
 320 .. Update any library version updated in this release and prepend with a ``+``
 321    sign, like this:
 322
 323      librte_acl.so.2
 324    + librte_cfgfile.so.2
 325      librte_cmdline.so.2
 326
 327    This section is a comment. do not overwrite or remove it.
 328    =========================================================
 329
 330
 331 The libraries prepended with a plus sign were incremented in this version.
 332
 333 .. code-block:: diff
 334
 335      librte_acl.so.2
 336    + librte_bbdev.so.1
 337      librte_bitratestats.so.2
 338      librte_bus_dpaa.so.1
 339      librte_bus_fslmc.so.1
 340      librte_bus_pci.so.1
 341      librte_bus_vdev.so.1
 342      librte_cfgfile.so.2
 343      librte_cmdline.so.2
 344      librte_cryptodev.so.4
 345      librte_distributor.so.1
 346      librte_eal.so.6
 347      librte_ethdev.so.8
 348      librte_eventdev.so.3
 349      librte_flow_classify.so.1
 350      librte_gro.so.1
 351      librte_gso.so.1
 352      librte_hash.so.2
 353      librte_ip_frag.so.1
 354      librte_jobstats.so.1
 355      librte_kni.so.2
 356      librte_kvargs.so.1
 357      librte_latencystats.so.1
 358      librte_lpm.so.2
 359      librte_mbuf.so.3
 360      librte_mempool.so.3
 361      librte_meter.so.1
 362      librte_metrics.so.1
 363      librte_net.so.1
 364      librte_pci.so.1
 365      librte_pdump.so.2
 366      librte_pipeline.so.3
 367      librte_pmd_bnxt.so.2
 368      librte_pmd_bond.so.2
 369      librte_pmd_i40e.so.2
 370      librte_pmd_ixgbe.so.2
 371      librte_pmd_ring.so.2
 372      librte_pmd_softnic.so.1
 373      librte_pmd_vhost.so.2
 374      librte_port.so.3
 375      librte_power.so.1
 376    + librte_rawdev.so.1
 377      librte_reorder.so.1
 378      librte_ring.so.1
 379      librte_sched.so.1
 380      librte_security.so.1
 381      librte_table.so.3
 382      librte_timer.so.1
 383      librte_vhost.so.3
 384
 385
 386
 387 Tested Platforms
 388 ----------------
 389
 390 .. This section should contain a list of platforms that were tested with this
 391    release.
 392
 393    The format is:
 394
 395    * <vendor> platform with <vendor> <type of devices> combinations
 396
 397      * List of CPU
 398      * List of OS
 399      * List of devices
 400      * Other relevant details...
 401
 402    This section is a comment. do not overwrite or remove it.
 403    Also, make sure to start the actual text at the margin.
 404    =========================================================
 405
 406 * Intel(R) platforms with Intel(R) NICs combinations
 407
 408    * CPU
 409
 410      * Intel(R) Atom(TM) CPU C2758 @ 2.40GHz
 411      * Intel(R) Xeon(R) CPU D-1540 @ 2.00GHz
 412      * Intel(R) Xeon(R) CPU D-1541 @ 2.10GHz
 413      * Intel(R) Xeon(R) CPU E5-4667 v3 @ 2.00GHz
 414      * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
 415      * Intel(R) Xeon(R) CPU E5-2699 v4 @ 2.20GHz
 416      * Intel(R) Xeon(R) CPU E5-2695 v4 @ 2.10GHz
 417      * Intel(R) Xeon(R) CPU E5-2658 v2 @ 2.40GHz
 418      * Intel(R) Xeon(R) CPU E5-2658 v3 @ 2.20GHz
 419      * Intel(R) Xeon(R) Platinum 8180 CPU @ 2.50GHz
 420
 421    * OS:
 422
 423      * CentOS 7.2
 424      * Fedora 25
 425      * Fedora 26
 426      * Fedora 27
 427      * FreeBSD 11
 428      * Red Hat Enterprise Linux Server release 7.3
 429      * SUSE Enterprise Linux 12
 430      * Wind River Linux 8
 431      * Ubantu 14.04
 432      * Ubuntu 16.04
 433      * Ubuntu 16.10
 434      * Ubantu 17.10
 435
 436    * NICs:
 437
 438      * Intel(R) 82599ES 10 Gigabit Ethernet Controller
 439
 440        * Firmware version: 0x61bf0001
 441        * Device id (pf/vf): 8086:10fb / 8086:10ed
 442        * Driver version: 5.2.3 (ixgbe)
 443
 444      * Intel(R) Corporation Ethernet Connection X552/X557-AT 10GBASE-T
 445
 446        * Firmware version: 0x800003e7
 447        * Device id (pf/vf): 8086:15ad / 8086:15a8
 448        * Driver version: 4.4.6 (ixgbe)
 449
 450      * Intel(R) Ethernet Converged Network Adapter X710-DA4 (4x10G)
 451
 452        * Firmware version: 6.01 0x80003221
 453        * Device id (pf/vf): 8086:1572 / 8086:154c
 454        * Driver version: 2.4.3 (i40e)
 455
 456      * Intel Corporation Ethernet Connection X722 for 10GBASE-T
 457
 458        * firmware-version: 6.01 0x80003221
 459        * Device id: 8086:37d2 / 8086:154c
 460        * Driver version: 2.4.3 (i40e)
 461
 462      * Intel(R) Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
 463
 464        * Firmware version: 6.01 0x80003221
 465        * Device id (pf/vf): 8086:158b / 8086:154c
 466        * Driver version: 2.4.3 (i40e)
 467
 468      * Intel(R) Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
 469
 470        * Firmware version: 6.01 0x8000321c
 471        * Device id (pf/vf): 8086:1583 / 8086:154c
 472        * Driver version: 2.4.3 (i40e)
 473
 474      * Intel(R) Corporation I350 Gigabit Network Connection
 475
 476        * Firmware version: 1.63, 0x80000dda
 477        * Device id (pf/vf): 8086:1521 / 8086:1520
 478        * Driver version: 5.3.0-k (igb)
 479