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