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