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