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