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 the Event Timer Adapter Library.**
 100
 101   The Event Timer Adapter Library extends the event-based model by introducing
 102   APIs that allow applications to arm/cancel event timers that generate
 103   timer expiry events. This new type of event is scheduled by an event device
 104   along with existing types of events.
 105
 106 * **Added device event monitor framework.**
 107
 108   Added a general device event monitor framework at EAL, for device dynamic management.
 109   Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
 110
 111   * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
 112     the event monitor enable and disable.
 113   * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
 114     are for the user's callbacks register and unregister.
 115
 116   Linux uevent is supported as backend of this device event notification framework.
 117
 118
 119 API Changes
 120 -----------
 121
 122 .. This section should contain API changes. Sample format:
 123
 124    * Add a short 1-2 sentence description of the API change. Use fixed width
 125      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 126      tense.
 127
 128    This section is a comment. Do not overwrite or remove it.
 129    Also, make sure to start the actual text at the margin.
 130    =========================================================
 131
 132 * mbuf: The control mbuf API has been removed in v18.05. The impacted
 133   functions and macros are:
 134
 135   - ``rte_ctrlmbuf_init()``
 136   - ``rte_ctrlmbuf_alloc()``
 137   - ``rte_ctrlmbuf_free()``
 138   - ``rte_ctrlmbuf_data()``
 139   - ``rte_ctrlmbuf_len()``
 140   - ``rte_is_ctrlmbuf()``
 141   - ``CTRL_MBUF_FLAG``
 142
 143   The packet mbuf API should be used as a replacement.
 144
 145 * meter: updated to accommodate configuration profiles.
 146
 147   The meter API is changed to support meter configuration profiles. The
 148   configuration profile represents the set of configuration parameters
 149   for a given meter object, such as the rates and sizes for the token
 150   buckets. These configuration parameters were previously the part of meter
 151   object internal data strcuture. The separation of the configuration
 152   parameters from meter object data structure results in reducing its
 153   memory footprint which helps in better cache utilization when large number
 154   of meter objects are used.
 155
 156 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
 157   replaced with field ``struct rte_device *device``.
 158
 159 * **Changes to semantics of rte_eth_dev_configure() parameters.**
 160
 161    If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
 162    ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
 163    recommendations are not provided by the PMD the function will use ethdev
 164    fall-back values. Previously setting both of the parameters to zero would
 165    have resulted in ``-EINVAL`` being returned.
 166
 167 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
 168
 169    If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
 170    now use the PMD-recommended Rx ring size, or in the case where the PMD
 171    does not provide a recommendation, will use an ethdev-provided
 172    fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
 173    resulted in an error.
 174
 175 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
 176
 177    If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
 178    now use the PMD-recommended Tx ring size, or in the case where the PMD
 179    does not provide a recoomendation, will use an ethdev-provided
 180    fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
 181    resulted in an error.
 182
 183
 184 ABI Changes
 185 -----------
 186
 187 .. This section should contain ABI changes. Sample format:
 188
 189    * Add a short 1-2 sentence description of the ABI change that was announced
 190      in the previous releases and made in this release. Use fixed width quotes
 191      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 192
 193    This section is a comment. Do not overwrite or remove it.
 194    Also, make sure to start the actual text at the margin.
 195    =========================================================
 196
 197 * **Additional fields in rte_eth_dev_info.**
 198
 199   The ``rte_eth_dev_info`` structure has had two extra entries appended to the
 200   end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
 201   in turn are ``rte_eth_dev_portconf`` structures containing three fields of
 202   type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
 203   are parameter values recommended for use by the PMD.
 204
 205 Removed Items
 206 -------------
 207
 208 .. This section should contain removed items in this release. Sample format:
 209
 210    * Add a short 1-2 sentence description of the removed item in the past
 211      tense.
 212
 213    This section is a comment. Do not overwrite or remove it.
 214    Also, make sure to start the actual text at the margin.
 215    =========================================================
 216
 217
 218 Known Issues
 219 ------------
 220
 221 .. This section should contain new known issues in this release. Sample format:
 222
 223    * **Add title in present tense with full stop.**
 224
 225      Add a short 1-2 sentence description of the known issue in the present
 226      tense. Add information on any known workarounds.
 227
 228    This section is a comment. Do not overwrite or remove it.
 229    Also, make sure to start the actual text at the margin.
 230    =========================================================
 231
 232
 233 Shared Library Versions
 234 -----------------------
 235
 236 .. Update any library version updated in this release and prepend with a ``+``
 237    sign, like this:
 238
 239      librte_acl.so.2
 240    + librte_cfgfile.so.2
 241      librte_cmdline.so.2
 242
 243    This section is a comment. Do not overwrite or remove it.
 244    =========================================================
 245
 246
 247 The libraries prepended with a plus sign were incremented in this version.
 248
 249 .. code-block:: diff
 250
 251      librte_acl.so.2
 252      librte_bbdev.so.1
 253      librte_bitratestats.so.2
 254      librte_bus_dpaa.so.1
 255      librte_bus_fslmc.so.1
 256      librte_bus_pci.so.1
 257      librte_bus_vdev.so.1
 258      librte_cfgfile.so.2
 259      librte_cmdline.so.2
 260    + librte_common_octeontx.so.1
 261      librte_cryptodev.so.4
 262      librte_distributor.so.1
 263    + librte_eal.so.7
 264    + librte_ethdev.so.9
 265      librte_eventdev.so.3
 266      librte_flow_classify.so.1
 267      librte_gro.so.1
 268      librte_gso.so.1
 269      librte_hash.so.2
 270      librte_ip_frag.so.1
 271      librte_jobstats.so.1
 272      librte_kni.so.2
 273      librte_kvargs.so.1
 274      librte_latencystats.so.1
 275      librte_lpm.so.2
 276    + librte_mbuf.so.4
 277      librte_mempool.so.3
 278    + librte_meter.so.2
 279      librte_metrics.so.1
 280      librte_net.so.1
 281      librte_pci.so.1
 282      librte_pdump.so.2
 283      librte_pipeline.so.3
 284      librte_pmd_bnxt.so.2
 285      librte_pmd_bond.so.2
 286      librte_pmd_i40e.so.2
 287      librte_pmd_ixgbe.so.2
 288      librte_pmd_ring.so.2
 289      librte_pmd_softnic.so.1
 290      librte_pmd_vhost.so.2
 291      librte_port.so.3
 292      librte_power.so.1
 293      librte_rawdev.so.1
 294      librte_reorder.so.1
 295      librte_ring.so.1
 296      librte_sched.so.1
 297      librte_security.so.1
 298      librte_table.so.3
 299      librte_timer.so.1
 300      librte_vhost.so.3
 301
 302
 303 Tested Platforms
 304 ----------------
 305
 306 .. This section should contain a list of platforms that were tested with this
 307    release.
 308
 309    The format is:
 310
 311    * <vendor> platform with <vendor> <type of devices> combinations
 312
 313      * List of CPU
 314      * List of OS
 315      * List of devices
 316      * Other relevant details...
 317
 318    This section is a comment. Do not overwrite or remove it.
 319    Also, make sure to start the actual text at the margin.
 320    =========================================================