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 * **Added NVGRE and UDP tunnels support in Solarflare network PMD.**
  87
  88   Added support for NVGRE, VXLAN and GENEVE tunnels.
  89
  90   * Added support for UDP tunnel ports configuration.
  91   * Added tunneled packets classification.
  92   * Added inner checksum offload.
  93
  94 * **Added the igb ethernet driver to support RSS with flow API.**
  95
  96   Rte_flow actually defined to include RSS, but till now, RSS is out of
  97   rte_flow. This patch is to support igb NIC with existing RSS configuration
  98   using rte_flow API.
  99
 100 * **Add AVF (Adaptive Virtual Function) net PMD.**
 101
 102   A new net PMD has been added, which supports Intel® Ethernet Adaptive
 103   Virtual Function (AVF) with features list below:
 104
 105   * Basic Rx/Tx burst
 106   * SSE vectorized Rx/Tx burst
 107   * Promiscuous mode
 108   * MAC/VLAN offload
 109   * Checksum offload
 110   * TSO offload
 111   * Jumbo frame and MTU setting
 112   * RSS configuration
 113   * stats
 114   * Rx/Tx descriptor status
 115   * Link status update/event
 116
 117 * **Updated the AESNI-MB PMD.**
 118
 119   The AESNI-MB PMD has been updated with additional support for:
 120
 121   * AES-CCM algorithm.
 122
 123 * **Updated the DPAA_SEC crypto driver to support rte_security.**
 124
 125   Updated the ``dpaa_sec`` crypto PMD to support ``rte_security`` lookaside
 126   protocol offload for IPSec.
 127
 128 * **Added Wireless Base Band Device (bbdev) abstraction.**
 129
 130   The Wireless Baseband Device library is an acceleration abstraction
 131   framework for 3gpp Layer 1 processing functions that provides a common
 132   programming interface for seamless opeartion on integrated or discrete
 133   hardware accelerators or using optimized software libraries for signal
 134   processing.
 135   The current release only supports 3GPP CRC, Turbo Coding and Rate
 136   Matching operations, as specified in 3GPP TS 36.212.
 137
 138   See the :doc:`../prog_guide/bbdev` programmer's guide for more details.
 139
 140 * **Added New eventdev OPDL PMD**
 141
 142   The OPDL (Ordered Packet Distribution Library) eventdev is a specific
 143   implementation of the eventdev API. It is particularly suited to packet
 144   processing workloads that have high throughput and low latency requirements.
 145   All packets follow the same path through the device. The order in which
 146   packets  follow is determinted by the order in which queues are set up.
 147   Events are left on the ring until they are transmitted. As a result packets
 148   do not go out of order.
 149
 150   With this change, application can use OPDL PMD by eventdev api.
 151
 152 * **Added New pipeline use case for dpdk-test-eventdev application**
 153
 154   The pipeline case can be used to simulate various stages in a real world
 155   application from packet receive to transmit while maintaining the packet
 156   ordering also measure the performance of the event device across the stages
 157   of the pipeline.
 158
 159   The pipeline use case has been made generic to work will all the event
 160   devices based on the capabilities.
 161
 162 * **Updated Eventdev Sample application to support event devices based on capability**
 163
 164   Updated Eventdev pipeline sample application to support various types of pipelines
 165   based on the capabilities of the attached event and ethernet devices. Also,
 166   renamed the application from SW PMD specific ``eventdev_pipeline_sw_pmd``
 167   to PMD agnostic ``eventdev_pipeline``.
 168
 169 * **Added new multi-process communication channel**
 170
 171   Added a generic channel in EAL for multi-process (primary/secondary) communication.
 172   Consumers of this channel need to register an action with an action name to response
 173   a message received; the actions will be identified by the action name and executed
 174   in the context of a new dedicated thread for this channel. The list of new APIs:
 175
 176   * ``rte_mp_register`` and ``rte_mp_unregister`` are for action (un)registration.
 177   * ``rte_mp_sendmsg`` is for sending a message without blocking for a response.
 178   * ``rte_mp_request`` is for sending a request message and will block until
 179     it gets a reply message which is sent from the peer by ``rte_mp_reply``.
 180
 181 * **Added new DPDK build system using the tools "meson" and "ninja" [EXPERIMENTAL]**
 182
 183   Added in support for building DPDK using ``meson`` and ``ninja``, which gives
 184   additional features, such as automatic build-time configuration, over the
 185   current build system using ``make``. For instructions on how to do a DPDK build
 186   using the new system, see the instructions in ``doc/build-sdk-meson.txt``.
 187
 188 .. note::
 189
 190     This new build system support is incomplete at this point and is added
 191     as experimental in this release. The existing build system using ``make``
 192     is unaffected by these changes, and can continue to be used for this
 193     and subsequent releases until such time as it's deprecation is announced.
 194
 195
 196 API Changes
 197 -----------
 198
 199 .. This section should contain API changes. Sample format:
 200
 201    * Add a short 1-2 sentence description of the API change. Use fixed width
 202      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 203      tense.
 204
 205    This section is a comment. do not overwrite or remove it.
 206    Also, make sure to start the actual text at the margin.
 207    =========================================================
 208
 209
 210 ABI Changes
 211 -----------
 212
 213 .. This section should contain ABI changes. Sample format:
 214
 215    * Add a short 1-2 sentence description of the ABI change that was announced
 216      in the previous releases and made in this release. Use fixed width quotes
 217      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 218
 219    This section is a comment. do not overwrite or remove it.
 220    Also, make sure to start the actual text at the margin.
 221    =========================================================
 222
 223
 224 Removed Items
 225 -------------
 226
 227 .. This section should contain removed items in this release. Sample format:
 228
 229    * Add a short 1-2 sentence description of the removed item in the past
 230      tense.
 231
 232    This section is a comment. do not overwrite or remove it.
 233    Also, make sure to start the actual text at the margin.
 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 Shared Library Versions
 253 -----------------------
 254
 255 .. Update any library version updated in this release and prepend with a ``+``
 256    sign, like this:
 257
 258      librte_acl.so.2
 259    + librte_cfgfile.so.2
 260      librte_cmdline.so.2
 261
 262    This section is a comment. do not overwrite or remove it.
 263    =========================================================
 264
 265
 266 The libraries prepended with a plus sign were incremented in this version.
 267
 268 .. code-block:: diff
 269
 270      librte_acl.so.2
 271    + librte_bbdev.so.1
 272      librte_bitratestats.so.2
 273      librte_bus_dpaa.so.1
 274      librte_bus_fslmc.so.1
 275      librte_bus_pci.so.1
 276      librte_bus_vdev.so.1
 277      librte_cfgfile.so.2
 278      librte_cmdline.so.2
 279      librte_cryptodev.so.4
 280      librte_distributor.so.1
 281      librte_eal.so.6
 282      librte_ethdev.so.8
 283      librte_eventdev.so.3
 284      librte_flow_classify.so.1
 285      librte_gro.so.1
 286      librte_gso.so.1
 287      librte_hash.so.2
 288      librte_ip_frag.so.1
 289      librte_jobstats.so.1
 290      librte_kni.so.2
 291      librte_kvargs.so.1
 292      librte_latencystats.so.1
 293      librte_lpm.so.2
 294      librte_mbuf.so.3
 295      librte_mempool.so.3
 296      librte_meter.so.1
 297      librte_metrics.so.1
 298      librte_net.so.1
 299      librte_pci.so.1
 300      librte_pdump.so.2
 301      librte_pipeline.so.3
 302      librte_pmd_bnxt.so.2
 303      librte_pmd_bond.so.2
 304      librte_pmd_i40e.so.2
 305      librte_pmd_ixgbe.so.2
 306      librte_pmd_ring.so.2
 307      librte_pmd_softnic.so.1
 308      librte_pmd_vhost.so.2
 309      librte_port.so.3
 310      librte_power.so.1
 311      librte_reorder.so.1
 312      librte_ring.so.1
 313      librte_sched.so.1
 314      librte_security.so.1
 315      librte_table.so.3
 316      librte_timer.so.1
 317      librte_vhost.so.3
 318
 319
 320
 321 Tested Platforms
 322 ----------------
 323
 324 .. This section should contain a list of platforms that were tested with this
 325    release.
 326
 327    The format is:
 328
 329    * <vendor> platform with <vendor> <type of devices> combinations
 330
 331      * List of CPU
 332      * List of OS
 333      * List of devices
 334      * Other relevant 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    =========================================================