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 bucket mempool driver.**
  45
  46   Added bucket mempool driver which provides a way to allocate contiguous
  47   block of objects.
  48   Number of objects in the block depends on how many objects fit in
  49   RTE_DRIVER_MEMPOOL_BUCKET_SIZE_KB memory chunk which is build time option.
  50   The number may be obtained using rte_mempool_ops_get_info() API.
  51   Contiguous blocks may be allocated using rte_mempool_get_contig_blocks() API.
  52
  53 * **Added PMD-recommended Tx and Rx parameters**
  54
  55   Applications can now query drivers for device-tuned values of
  56   ring sizes, burst sizes, and number of queues.
  57
  58 * **Added RSS hash and key update to CXGBE PMD.**
  59
  60   Support to update RSS hash and key has been added to CXGBE PMD.
  61
  62 * **Added CXGBE VF PMD.**
  63
  64   CXGBE VF Poll Mode Driver has been added to run DPDK over Chelsio
  65   T5/T6 NIC VF instances.
  66
  67 * **Updated Solarflare network PMD.**
  68
  69   Updated the sfc_efx driver including the following changes:
  70
  71   * Added support for Solarflare XtremeScale X2xxx family adapters.
  72   * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
  73   * Added support for DROP action in flow API.
  74
  75 * **Added Ethernet poll mode driver for AMD XGBE devices.**
  76
  77   Added the new ``axgbe`` ethernet poll mode driver for AMD XGBE devices.
  78   See the :doc:`../nics/axgbe` nic driver guide for more details on this
  79   new driver.
  80
  81 * **Updated szedata2 PMD.**
  82
  83   Added support for new NFB-200G2QL card.
  84
  85 * **Added support for Broadcom NetXtreme-S (BCM58800) family of controllers (aka Stingray)**
  86
  87   The BCM58800 devices feature a NetXtreme E-Series advanced network controller, a high-performance
  88   ARM CPU block, PCI Express (PCIe) Gen3 interfaces, key accelerators for compute offload and a high-
  89   speed memory subsystem including L3 cache and DDR4 interfaces, all interconnected by a coherent
  90   Network-on-chip (NOC) fabric.
  91
  92   The ARM CPU subsystem features eight ARMv8 Cortex-A72 CPUs at 3.0 GHz, arranged in a multi-cluster
  93   configuration.
  94
  95 * **Added IFCVF vDPA driver.**
  96
  97   Added IFCVF vDPA driver to support Intel FPGA 100G VF device. IFCVF works
  98   as a HW vhost data path accelerator, it supports live migration and is
  99   compatible with virtio 0.95 and 1.0. This driver registers ifcvf vDPA driver
 100   to vhost lib, when virtio connected, with the help of the registered vDPA
 101   driver the assigned VF gets configured to Rx/Tx directly to VM's virtio
 102   vrings.
 103
 104 * **Added support for virtio-user server mode.**
 105   In a container environment if the vhost-user backend restarts, there's no way
 106   for it to reconnect to virtio-user. To address this, support for server mode
 107   is added. In this mode the socket file is created by virtio-user, which the
 108   backend connects to. This means that if the backend restarts, it can reconnect
 109   to virtio-user and continue communications.
 110
 111 * **Added crypto workload support to vhost library.**
 112
 113   New APIs are introduced in vhost library to enable virtio crypto support
 114   including session creation/deletion handling and translating virtio-crypto
 115   request into DPDK crypto operations. A sample application is also introduced.
 116
 117 * **Added virtio crypto PMD.**
 118
 119   Added a new poll mode driver for virtio crypto devices, which provides
 120   AES-CBC ciphering and AES-CBC with HMAC-SHA1 algorithm-chaining. See the
 121   :doc:`../cryptodevs/virtio` crypto driver guide for more details on
 122   this new driver.
 123
 124 * **Added AMD CCP Crypto PMD.**
 125
 126   Added the new ``ccp`` crypto driver for AMD CCP devices. See the
 127   :doc:`../cryptodevs/ccp` crypto driver guide for more details on
 128   this new driver.
 129
 130 * **Updated AESNI MB PMD.**
 131
 132   The AESNI MB PMD has been updated with additional support for:
 133
 134   * AES-CMAC (128-bit key).
 135
 136 * **Added the Event Timer Adapter Library.**
 137
 138   The Event Timer Adapter Library extends the event-based model by introducing
 139   APIs that allow applications to arm/cancel event timers that generate
 140   timer expiry events. This new type of event is scheduled by an event device
 141   along with existing types of events.
 142
 143 * **Added device event monitor framework.**
 144
 145   Added a general device event monitor framework at EAL, for device dynamic management.
 146   Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
 147
 148   * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
 149     the event monitor enable and disable.
 150   * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
 151     are for the user's callbacks register and unregister.
 152
 153   Linux uevent is supported as backend of this device event notification framework.
 154
 155 * **Added support for procinfo and pdump on eth vdev.**
 156
 157   For ethernet virtual devices (like tap, pcap, etc), with this feature, we can get
 158   stats/xstats on shared memory from secondary process, and also pdump packets on
 159   those virtual devices.
 160
 161
 162 API Changes
 163 -----------
 164
 165 .. This section should contain API changes. Sample format:
 166
 167    * Add a short 1-2 sentence description of the API change. Use fixed width
 168      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 169      tense.
 170
 171    This section is a comment. Do not overwrite or remove it.
 172    Also, make sure to start the actual text at the margin.
 173    =========================================================
 174
 175 * service cores: no longer marked as experimental.
 176
 177   The service cores functions are no longer marked as experimental, and have
 178   become part of the normal DPDK API and ABI. Any future ABI changes will be
 179   announced at least one release before the ABI change is made. There are no
 180   ABI breaking changes planned.
 181
 182 * eal: ``rte_lcore_has_role()`` return value changed.
 183
 184   This function now returns true or false, respectively,
 185   rather than 0 or <0 for success or failure.
 186   It makes use of the function more intuitive.
 187
 188 * mempool: capability flags and related functions have been removed.
 189
 190   Flags ``MEMPOOL_F_CAPA_PHYS_CONTIG`` and
 191   ``MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS`` were used by octeontx mempool
 192   driver to customize generic mempool library behaviour.
 193   Now the new driver callbacks ``calc_mem_size`` and ``populate`` may be
 194   used to achieve it without specific knowledge in the generic code.
 195
 196 * mempool: xmem functions have been deprecated:
 197
 198   - ``rte_mempool_xmem_create``
 199   - ``rte_mempool_xmem_size``
 200   - ``rte_mempool_xmem_usage``
 201   - ``rte_mempool_populate_iova_tab``
 202
 203 * mbuf: The control mbuf API has been removed in v18.05. The impacted
 204   functions and macros are:
 205
 206   - ``rte_ctrlmbuf_init()``
 207   - ``rte_ctrlmbuf_alloc()``
 208   - ``rte_ctrlmbuf_free()``
 209   - ``rte_ctrlmbuf_data()``
 210   - ``rte_ctrlmbuf_len()``
 211   - ``rte_is_ctrlmbuf()``
 212   - ``CTRL_MBUF_FLAG``
 213
 214   The packet mbuf API should be used as a replacement.
 215
 216 * meter: updated to accommodate configuration profiles.
 217
 218   The meter API is changed to support meter configuration profiles. The
 219   configuration profile represents the set of configuration parameters
 220   for a given meter object, such as the rates and sizes for the token
 221   buckets. These configuration parameters were previously the part of meter
 222   object internal data strcuture. The separation of the configuration
 223   parameters from meter object data structure results in reducing its
 224   memory footprint which helps in better cache utilization when large number
 225   of meter objects are used.
 226
 227 * ethdev: The function ``rte_eth_dev_count``, often mis-used to iterate
 228   over ports, is deprecated and replaced by ``rte_eth_dev_count_avail``.
 229   There is also a new function ``rte_eth_dev_count_total`` to get the
 230   total number of allocated ports, available or not.
 231   The hotplug-proof applications should use ``RTE_ETH_FOREACH_DEV`` or
 232   ``RTE_ETH_FOREACH_DEV_OWNED_BY`` as port iterators.
 233
 234 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
 235   replaced with field ``struct rte_device *device``.
 236
 237 * **Changes to semantics of rte_eth_dev_configure() parameters.**
 238
 239    If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
 240    ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
 241    recommendations are not provided by the PMD the function will use ethdev
 242    fall-back values. Previously setting both of the parameters to zero would
 243    have resulted in ``-EINVAL`` being returned.
 244
 245 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
 246
 247    If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
 248    now use the PMD-recommended Rx ring size, or in the case where the PMD
 249    does not provide a recommendation, will use an ethdev-provided
 250    fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
 251    resulted in an error.
 252
 253 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
 254
 255    If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
 256    now use the PMD-recommended Tx ring size, or in the case where the PMD
 257    does not provide a recoomendation, will use an ethdev-provided
 258    fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
 259    resulted in an error.
 260
 261 * ethdev: unused DUP action was removed from the flow API.
 262
 263
 264 ABI Changes
 265 -----------
 266
 267 .. This section should contain ABI changes. Sample format:
 268
 269    * Add a short 1-2 sentence description of the ABI change that was announced
 270      in the previous releases and made in this release. Use fixed width quotes
 271      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 272
 273    This section is a comment. Do not overwrite or remove it.
 274    Also, make sure to start the actual text at the margin.
 275    =========================================================
 276
 277 * ring: the alignment constraints on the ring structure has been relaxed
 278   to one cache line instead of two, and an empty cache line padding is
 279   added between the producer and consumer structures. The size of the
 280   structure and the offset of the fields remains the same on platforms
 281   with 64B cache line, but change on other platforms.
 282
 283 * mempool: ops have changed.
 284
 285   A new callback ``calc_mem_size`` has been added to ``rte_mempool_ops``
 286   to allow to customize required memory size calculation.
 287   A new callback ``populate`` has been added to ``rte_mempool_ops``
 288   to allow to customize objects population.
 289   Callback ``get_capabilities`` has been removed from ``rte_mempool_ops``
 290   since its features are covered by ``calc_mem_size`` and ``populate``
 291   callbacks.
 292   Callback ``register_memory_area`` has been removed from ``rte_mempool_ops``
 293   since the new callback ``populate`` may be used instead of it.
 294
 295 * **Additional fields in rte_eth_dev_info.**
 296
 297   The ``rte_eth_dev_info`` structure has had two extra entries appended to the
 298   end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
 299   in turn are ``rte_eth_dev_portconf`` structures containing three fields of
 300   type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
 301   are parameter values recommended for use by the PMD.
 302
 303 * ethdev: ABI for all flow API functions was updated.
 304
 305   This includes functions ``rte_flow_copy``, ``rte_flow_create``,
 306   ``rte_flow_destroy``, ``rte_flow_error_set``, ``rte_flow_flush``,
 307   ``rte_flow_isolate``, ``rte_flow_query`` and ``rte_flow_validate``, due to
 308   changes in error type definitions (``enum rte_flow_error_type``) and
 309   removal of the unused DUP action (``enum rte_flow_action_type``).
 310
 311
 312 Removed Items
 313 -------------
 314
 315 .. This section should contain removed items in this release. Sample format:
 316
 317    * Add a short 1-2 sentence description of the removed item in the past
 318      tense.
 319
 320    This section is a comment. Do not overwrite or remove it.
 321    Also, make sure to start the actual text at the margin.
 322    =========================================================
 323
 324
 325 Known Issues
 326 ------------
 327
 328 .. This section should contain new known issues in this release. Sample format:
 329
 330    * **Add title in present tense with full stop.**
 331
 332      Add a short 1-2 sentence description of the known issue in the present
 333      tense. Add information on any known workarounds.
 334
 335    This section is a comment. Do not overwrite or remove it.
 336    Also, make sure to start the actual text at the margin.
 337    =========================================================
 338
 339 * **pdump is not compatible with old applications.**
 340
 341   As we changed to use generic multi-process communication for pdump negotiation
 342   instead of previous dedicated unix socket way, pdump applications, including
 343   dpdk-pdump example and any other applications using librte_pdump, cannot work
 344   with older version DPDK primary applications.
 345
 346
 347 Shared Library Versions
 348 -----------------------
 349
 350 .. Update any library version updated in this release and prepend with a ``+``
 351    sign, like this:
 352
 353      librte_acl.so.2
 354    + librte_cfgfile.so.2
 355      librte_cmdline.so.2
 356
 357    This section is a comment. Do not overwrite or remove it.
 358    =========================================================
 359
 360
 361 The libraries prepended with a plus sign were incremented in this version.
 362
 363 .. code-block:: diff
 364
 365      librte_acl.so.2
 366      librte_bbdev.so.1
 367      librte_bitratestats.so.2
 368      librte_bus_dpaa.so.1
 369      librte_bus_fslmc.so.1
 370      librte_bus_pci.so.1
 371      librte_bus_vdev.so.1
 372      librte_cfgfile.so.2
 373      librte_cmdline.so.2
 374    + librte_common_octeontx.so.1
 375      librte_cryptodev.so.4
 376      librte_distributor.so.1
 377    + librte_eal.so.7
 378    + librte_ethdev.so.9
 379      librte_eventdev.so.3
 380      librte_flow_classify.so.1
 381      librte_gro.so.1
 382      librte_gso.so.1
 383      librte_hash.so.2
 384      librte_ip_frag.so.1
 385      librte_jobstats.so.1
 386      librte_kni.so.2
 387      librte_kvargs.so.1
 388      librte_latencystats.so.1
 389      librte_lpm.so.2
 390    + librte_mbuf.so.4
 391    + librte_mempool.so.4
 392    + librte_meter.so.2
 393      librte_metrics.so.1
 394      librte_net.so.1
 395      librte_pci.so.1
 396      librte_pdump.so.2
 397      librte_pipeline.so.3
 398      librte_pmd_bnxt.so.2
 399      librte_pmd_bond.so.2
 400      librte_pmd_i40e.so.2
 401      librte_pmd_ixgbe.so.2
 402      librte_pmd_ring.so.2
 403      librte_pmd_softnic.so.1
 404      librte_pmd_vhost.so.2
 405      librte_port.so.3
 406      librte_power.so.1
 407      librte_rawdev.so.1
 408      librte_reorder.so.1
 409    + librte_ring.so.2
 410      librte_sched.so.1
 411      librte_security.so.1
 412      librte_table.so.3
 413      librte_timer.so.1
 414      librte_vhost.so.3
 415
 416
 417 Tested Platforms
 418 ----------------
 419
 420 .. This section should contain a list of platforms that were tested with this
 421    release.
 422
 423    The format is:
 424
 425    * <vendor> platform with <vendor> <type of devices> combinations
 426
 427      * List of CPU
 428      * List of OS
 429      * List of devices
 430      * Other relevant details...
 431
 432    This section is a comment. Do not overwrite or remove it.
 433    Also, make sure to start the actual text at the margin.
 434    =========================================================