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 * **Added the ixgbe ethernet driver to support RSS with flow API.**
  45
  46   Rte_flow actually defined to include RSS, but till now, RSS is out of
  47   rte_flow. This patch is to support igb and ixgbe NIC with existing RSS
  48   configuration using rte_flow API.
  49
  50 * **Add MAC loopback support for i40e.**
  51
  52   Add MAC loopback support for i40e in order to support test task asked by
  53   users. According to the device configuration, it will setup TX->RX loopback
  54   link or not.
  55
  56 * **Add the support of run time determination of number of queues per i40e VF**
  57
  58   The number of queue per VF is determined by its host PF. If the PCI address
  59   of an i40e PF is aaaa:bb.cc, the number of queues per VF can be configured
  60   with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. The value n can be
  61   1, 2, 4, 8 or 16. If no such parameter is configured, the number of queues
  62   per VF is 4 by default.
  63
  64 * **Added the i40e ethernet driver to support RSS with flow API.**
  65
  66   Rte_flow actually defined to include RSS, but till now, RSS is out of
  67   rte_flow. This patch is to support i40e NIC with existing RSS
  68   configuration using rte_flow API.It also enable queue region configuration
  69   using flow API for i40e.
  70
  71 * **Added NVGRE and UDP tunnels support in Solarflare network PMD.**
  72
  73   Added support for NVGRE, VXLAN and GENEVE tunnels.
  74
  75   * Added support for UDP tunnel ports configuration.
  76   * Added tunneled packets classification.
  77   * Added inner checksum offload.
  78
  79 * **Added the igb ethernet driver to support RSS with flow API.**
  80
  81   Rte_flow actually defined to include RSS, but till now, RSS is out of
  82   rte_flow. This patch is to support igb NIC with existing RSS configuration
  83   using rte_flow API.
  84
  85 * **Add AVF (Adaptive Virtual Function) net PMD.**
  86
  87   A new net PMD has been added, which supports Intel® Ethernet Adaptive
  88   Virtual Function (AVF) with features list below:
  89
  90   * Basic Rx/Tx burst
  91   * SSE vectorized Rx/Tx burst
  92   * Promiscuous mode
  93   * MAC/VLAN offload
  94   * Checksum offload
  95   * TSO offload
  96   * Jumbo frame and MTU setting
  97   * RSS configuration
  98   * stats
  99   * Rx/Tx descriptor status
 100   * Link status update/event
 101
 102 * **Updated the AESNI-MB PMD.**
 103
 104   The AESNI-MB PMD has been updated with additional support for:
 105
 106   * AES-CCM algorithm.
 107
 108 * **Updated the DPAA_SEC crypto driver to support rte_security.**
 109
 110   Updated the ``dpaa_sec`` crypto PMD to support ``rte_security`` lookaside
 111   protocol offload for IPSec.
 112
 113 * **Added Wireless Base Band Device (bbdev) abstraction.**
 114
 115   The Wireless Baseband Device library is an acceleration abstraction
 116   framework for 3gpp Layer 1 processing functions that provides a common
 117   programming interface for seamless opeartion on integrated or discrete
 118   hardware accelerators or using optimized software libraries for signal
 119   processing.
 120   The current release only supports 3GPP CRC, Turbo Coding and Rate
 121   Matching operations, as specified in 3GPP TS 36.212.
 122
 123   See the :doc:`../prog_guide/bbdev` programmer's guide for more details.
 124
 125 * **Added New eventdev OPDL PMD**
 126
 127   The OPDL (Ordered Packet Distribution Library) eventdev is a specific
 128   implementation of the eventdev API. It is particularly suited to packet
 129   processing workloads that have high throughput and low latency requirements.
 130   All packets follow the same path through the device. The order in which
 131   packets  follow is determinted by the order in which queues are set up.
 132   Events are left on the ring until they are transmitted. As a result packets
 133   do not go out of order.
 134
 135   With this change, application can use OPDL PMD by eventdev api.
 136
 137 * **Added New pipeline use case for dpdk-test-eventdev application**
 138
 139   The pipeline case can be used to simulate various stages in a real world
 140   application from packet receive to transmit while maintaining the packet
 141   ordering also measure the performance of the event device across the stages
 142   of the pipeline.
 143
 144   The pipeline use case has been made generic to work will all the event
 145   devices based on the capabilities.
 146
 147 * **Updated Eventdev Sample application to support event devices based on capability**
 148
 149   Updated Eventdev pipeline sample application to support various types of pipelines
 150   based on the capabilities of the attached event and ethernet devices. Also,
 151   renamed the application from SW PMD specific ``eventdev_pipeline_sw_pmd``
 152   to PMD agnostic ``eventdev_pipeline``.
 153
 154
 155 API Changes
 156 -----------
 157
 158 .. This section should contain API changes. Sample format:
 159
 160    * Add a short 1-2 sentence description of the API change. Use fixed width
 161      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 162      tense.
 163
 164    This section is a comment. do not overwrite or remove it.
 165    Also, make sure to start the actual text at the margin.
 166    =========================================================
 167
 168
 169 ABI Changes
 170 -----------
 171
 172 .. This section should contain ABI changes. Sample format:
 173
 174    * Add a short 1-2 sentence description of the ABI change that was announced
 175      in the previous releases and made in this release. Use fixed width quotes
 176      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 177
 178    This section is a comment. do not overwrite or remove it.
 179    Also, make sure to start the actual text at the margin.
 180    =========================================================
 181
 182
 183 Removed Items
 184 -------------
 185
 186 .. This section should contain removed items in this release. Sample format:
 187
 188    * Add a short 1-2 sentence description of the removed item in the past
 189      tense.
 190
 191    This section is a comment. do not overwrite or remove it.
 192    Also, make sure to start the actual text at the margin.
 193    =========================================================
 194
 195
 196 Known Issues
 197 ------------
 198
 199 .. This section should contain new known issues in this release. Sample format:
 200
 201    * **Add title in present tense with full stop.**
 202
 203      Add a short 1-2 sentence description of the known issue in the present
 204      tense. Add information on any known workarounds.
 205
 206    This section is a comment. do not overwrite or remove it.
 207    Also, make sure to start the actual text at the margin.
 208    =========================================================
 209
 210
 211 Shared Library Versions
 212 -----------------------
 213
 214 .. Update any library version updated in this release and prepend with a ``+``
 215    sign, like this:
 216
 217      librte_acl.so.2
 218    + librte_cfgfile.so.2
 219      librte_cmdline.so.2
 220
 221    This section is a comment. do not overwrite or remove it.
 222    =========================================================
 223
 224
 225 The libraries prepended with a plus sign were incremented in this version.
 226
 227 .. code-block:: diff
 228
 229      librte_acl.so.2
 230    + librte_bbdev.so.1
 231      librte_bitratestats.so.2
 232      librte_bus_dpaa.so.1
 233      librte_bus_fslmc.so.1
 234      librte_bus_pci.so.1
 235      librte_bus_vdev.so.1
 236      librte_cfgfile.so.2
 237      librte_cmdline.so.2
 238      librte_cryptodev.so.4
 239      librte_distributor.so.1
 240      librte_eal.so.6
 241      librte_ethdev.so.8
 242      librte_eventdev.so.3
 243      librte_flow_classify.so.1
 244      librte_gro.so.1
 245      librte_gso.so.1
 246      librte_hash.so.2
 247      librte_ip_frag.so.1
 248      librte_jobstats.so.1
 249      librte_kni.so.2
 250      librte_kvargs.so.1
 251      librte_latencystats.so.1
 252      librte_lpm.so.2
 253      librte_mbuf.so.3
 254      librte_mempool.so.3
 255      librte_meter.so.1
 256      librte_metrics.so.1
 257      librte_net.so.1
 258      librte_pci.so.1
 259      librte_pdump.so.2
 260      librte_pipeline.so.3
 261      librte_pmd_bnxt.so.2
 262      librte_pmd_bond.so.2
 263      librte_pmd_i40e.so.2
 264      librte_pmd_ixgbe.so.2
 265      librte_pmd_ring.so.2
 266      librte_pmd_softnic.so.1
 267      librte_pmd_vhost.so.2
 268      librte_port.so.3
 269      librte_power.so.1
 270      librte_reorder.so.1
 271      librte_ring.so.1
 272      librte_sched.so.1
 273      librte_security.so.1
 274      librte_table.so.3
 275      librte_timer.so.1
 276      librte_vhost.so.3
 277
 278
 279
 280 Tested Platforms
 281 ----------------
 282
 283 .. This section should contain a list of platforms that were tested with this
 284    release.
 285
 286    The format is:
 287
 288    * <vendor> platform with <vendor> <type of devices> combinations
 289
 290      * List of CPU
 291      * List of OS
 292      * List of devices
 293      * Other relevant details...
 294
 295    This section is a comment. do not overwrite or remove it.
 296    Also, make sure to start the actual text at the margin.
 297    =========================================================