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