doc/guides/rel_notes/release_18_05.rst

   1 DPDK Release 18.05
   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_05.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 PMD-recommended Tx and Rx parameters**
  45
  46   Applications can now query drivers for device-tuned values of
  47   ring sizes, burst sizes, and number of queues.
  48
  49 * **Added RSS hash and key update to CXGBE PMD.**
  50
  51   Support to update RSS hash and key has been added to CXGBE PMD.
  52
  53 * **Added CXGBE VF PMD.**
  54
  55   CXGBE VF Poll Mode Driver has been added to run DPDK over Chelsio
  56   T5/T6 NIC VF instances.
  57
  58 * **Updated Solarflare network PMD.**
  59
  60   Updated the sfc_efx driver including the following changes:
  61
  62   * Added support for Solarflare XtremeScale X2xxx family adapters.
  63   * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
  64   * Added support for DROP action in flow API.
  65
  66 * **Added Ethernet poll mode driver for AMD XGBE devices.**
  67
  68   Added the new ``axgbe`` ethernet poll mode driver for AMD XGBE devices.
  69   See the :doc:`../nics/axgbe` nic driver guide for more details on this
  70   new driver.
  71
  72 * **Updated szedata2 PMD.**
  73
  74   Added support for new NFB-200G2QL card.
  75
  76 * **Added support for Broadcom NetXtreme-S (BCM58800) family of controllers (aka Stingray)**
  77
  78   The BCM58800 devices feature a NetXtreme E-Series advanced network controller, a high-performance
  79   ARM CPU block, PCI Express (PCIe) Gen3 interfaces, key accelerators for compute offload and a high-
  80   speed memory subsystem including L3 cache and DDR4 interfaces, all interconnected by a coherent
  81   Network-on-chip (NOC) fabric.
  82
  83   The ARM CPU subsystem features eight ARMv8 Cortex-A72 CPUs at 3.0 GHz, arranged in a multi-cluster
  84   configuration.
  85
  86 * **Added support for virtio-user server mode.**
  87   In a container environment if the vhost-user backend restarts, there's no way
  88   for it to reconnect to virtio-user. To address this, support for server mode
  89   is added. In this mode the socket file is created by virtio-user, which the
  90   backend connects to. This means that if the backend restarts, it can reconnect
  91   to virtio-user and continue communications.
  92
  93 * **Added crypto workload support to vhost library.**
  94
  95   New APIs are introduced in vhost library to enable virtio crypto support
  96   including session creation/deletion handling and translating virtio-crypto
  97   request into DPDK crypto operations. A sample application is also introduced.
  98
  99 * **Added device event monitor framework.**
 100
 101   Added a general device event monitor framework at EAL, for device dynamic management.
 102   Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
 103
 104   * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
 105     the event monitor enable and disable.
 106   * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
 107     are for the user's callbacks register and unregister.
 108
 109   Linux uevent is supported as backend of this device event notification framework.
 110
 111
 112 API Changes
 113 -----------
 114
 115 .. This section should contain API changes. Sample format:
 116
 117    * Add a short 1-2 sentence description of the API change. Use fixed width
 118      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 119      tense.
 120
 121    This section is a comment. Do not overwrite or remove it.
 122    Also, make sure to start the actual text at the margin.
 123    =========================================================
 124
 125 * mbuf: The control mbuf API has been removed in v18.05. The impacted
 126   functions and macros are:
 127
 128   - ``rte_ctrlmbuf_init()``
 129   - ``rte_ctrlmbuf_alloc()``
 130   - ``rte_ctrlmbuf_free()``
 131   - ``rte_ctrlmbuf_data()``
 132   - ``rte_ctrlmbuf_len()``
 133   - ``rte_is_ctrlmbuf()``
 134   - ``CTRL_MBUF_FLAG``
 135
 136   The packet mbuf API should be used as a replacement.
 137
 138 * meter: updated to accommodate configuration profiles.
 139
 140   The meter API is changed to support meter configuration profiles. The
 141   configuration profile represents the set of configuration parameters
 142   for a given meter object, such as the rates and sizes for the token
 143   buckets. These configuration parameters were previously the part of meter
 144   object internal data strcuture. The separation of the configuration
 145   parameters from meter object data structure results in reducing its
 146   memory footprint which helps in better cache utilization when large number
 147   of meter objects are used.
 148
 149 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
 150   replaced with field ``struct rte_device *device``.
 151
 152 * **Changes to semantics of rte_eth_dev_configure() parameters.**
 153
 154    If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
 155    ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
 156    recommendations are not provided by the PMD the function will use ethdev
 157    fall-back values. Previously setting both of the parameters to zero would
 158    have resulted in ``-EINVAL`` being returned.
 159
 160 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
 161
 162    If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
 163    now use the PMD-recommended Rx ring size, or in the case where the PMD
 164    does not provide a recommendation, will use an ethdev-provided
 165    fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
 166    resulted in an error.
 167
 168 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
 169
 170    If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
 171    now use the PMD-recommended Tx ring size, or in the case where the PMD
 172    does not provide a recoomendation, will use an ethdev-provided
 173    fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
 174    resulted in an error.
 175
 176
 177 ABI Changes
 178 -----------
 179
 180 .. This section should contain ABI changes. Sample format:
 181
 182    * Add a short 1-2 sentence description of the ABI change that was announced
 183      in the previous releases and made in this release. Use fixed width quotes
 184      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 185
 186    This section is a comment. Do not overwrite or remove it.
 187    Also, make sure to start the actual text at the margin.
 188    =========================================================
 189
 190 * **Additional fields in rte_eth_dev_info.**
 191
 192   The ``rte_eth_dev_info`` structure has had two extra entries appended to the
 193   end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
 194   in turn are ``rte_eth_dev_portconf`` structures containing three fields of
 195   type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
 196   are parameter values recommended for use by the PMD.
 197
 198 Removed Items
 199 -------------
 200
 201 .. This section should contain removed items in this release. Sample format:
 202
 203    * Add a short 1-2 sentence description of the removed item in the past
 204      tense.
 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 Known Issues
 212 ------------
 213
 214 .. This section should contain new known issues in this release. Sample format:
 215
 216    * **Add title in present tense with full stop.**
 217
 218      Add a short 1-2 sentence description of the known issue in the present
 219      tense. Add information on any known workarounds.
 220
 221    This section is a comment. Do not overwrite or remove it.
 222    Also, make sure to start the actual text at the margin.
 223    =========================================================
 224
 225
 226 Shared Library Versions
 227 -----------------------
 228
 229 .. Update any library version updated in this release and prepend with a ``+``
 230    sign, like this:
 231
 232      librte_acl.so.2
 233    + librte_cfgfile.so.2
 234      librte_cmdline.so.2
 235
 236    This section is a comment. Do not overwrite or remove it.
 237    =========================================================
 238
 239
 240 The libraries prepended with a plus sign were incremented in this version.
 241
 242 .. code-block:: diff
 243
 244      librte_acl.so.2
 245      librte_bbdev.so.1
 246      librte_bitratestats.so.2
 247      librte_bus_dpaa.so.1
 248      librte_bus_fslmc.so.1
 249      librte_bus_pci.so.1
 250      librte_bus_vdev.so.1
 251      librte_cfgfile.so.2
 252      librte_cmdline.so.2
 253    + librte_common_octeontx.so.1
 254      librte_cryptodev.so.4
 255      librte_distributor.so.1
 256    + librte_eal.so.7
 257    + librte_ethdev.so.9
 258      librte_eventdev.so.3
 259      librte_flow_classify.so.1
 260      librte_gro.so.1
 261      librte_gso.so.1
 262      librte_hash.so.2
 263      librte_ip_frag.so.1
 264      librte_jobstats.so.1
 265      librte_kni.so.2
 266      librte_kvargs.so.1
 267      librte_latencystats.so.1
 268      librte_lpm.so.2
 269    + librte_mbuf.so.4
 270      librte_mempool.so.3
 271    + librte_meter.so.2
 272      librte_metrics.so.1
 273      librte_net.so.1
 274      librte_pci.so.1
 275      librte_pdump.so.2
 276      librte_pipeline.so.3
 277      librte_pmd_bnxt.so.2
 278      librte_pmd_bond.so.2
 279      librte_pmd_i40e.so.2
 280      librte_pmd_ixgbe.so.2
 281      librte_pmd_ring.so.2
 282      librte_pmd_softnic.so.1
 283      librte_pmd_vhost.so.2
 284      librte_port.so.3
 285      librte_power.so.1
 286      librte_rawdev.so.1
 287      librte_reorder.so.1
 288      librte_ring.so.1
 289      librte_sched.so.1
 290      librte_security.so.1
 291      librte_table.so.3
 292      librte_timer.so.1
 293      librte_vhost.so.3
 294
 295
 296 Tested Platforms
 297 ----------------
 298
 299 .. This section should contain a list of platforms that were tested with this
 300    release.
 301
 302    The format is:
 303
 304    * <vendor> platform with <vendor> <type of devices> combinations
 305
 306      * List of CPU
 307      * List of OS
 308      * List of devices
 309      * Other relevant details...
 310
 311    This section is a comment. Do not overwrite or remove it.
 312    Also, make sure to start the actual text at the margin.
 313    =========================================================