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 Ifpga Bus, a generic Intel FPGA Bus library.**
 175
 176   The Ifpga Bus library provides support for integrating any Intel FPGA device with
 177   the DPDK framework. It provides Intel FPGA Partial Bit Stream AFU (Accelerated
 178   Function Unit) scan and drivers probe.
 179
 180 * **Added IFPGA (Intel FPGA) Rawdev Driver.**
 181
 182   Added a new Rawdev driver called IFPGA(Intel FPGA) Rawdev Driver, which cooperates
 183   with OPAE (Open Programmable Acceleration Engine) share code provides common FPGA
 184   management ops for FPGA operation.
 185
 186   See the :doc:`../rawdevs/ifpga_rawdev` programmer's guide for more details.
 187
 188 * **Added DPAA2 QDMA Driver (in rawdev).**
 189
 190   The DPAA2 QDMA is an implementation of the rawdev API, that provide means
 191   to initiate a DMA transaction from CPU. The initiated DMA is performed
 192   without CPU being involved in the actual DMA transaction.
 193
 194   See the :doc:`../rawdevs/dpaa2_qdma` guide for more details.
 195
 196 * **Added DPAA2 Command Interface Driver (in rawdev).**
 197
 198   The DPAA2 CMDIF is an implementation of the rawdev API, that provides
 199   communication between the GPP and NXP's QorIQ based AIOP Block (Firmware).
 200   Advanced IO Processor i.e. AIOP is clusters of programmable RISC engines
 201   optimised for flexible networking and I/O operations. The communication
 202   between GPP and AIOP is achieved via using DPCI devices exposed by MC for
 203   GPP <--> AIOP interaction.
 204
 205   See the :doc:`../rawdevs/dpaa2_cmdif` guide for more details.
 206
 207 * **Added device event monitor framework.**
 208
 209   Added a general device event monitor framework at EAL, for device dynamic management.
 210   Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
 211
 212   * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
 213     the event monitor enable and disable.
 214   * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
 215     are for the user's callbacks register and unregister.
 216
 217   Linux uevent is supported as backend of this device event notification framework.
 218
 219 * **Added support for procinfo and pdump on eth vdev.**
 220
 221   For ethernet virtual devices (like tap, pcap, etc), with this feature, we can get
 222   stats/xstats on shared memory from secondary process, and also pdump packets on
 223   those virtual devices.
 224
 225 * **Added the BPF Library.**
 226
 227   The BPF Library provides the ability to load and execute
 228   Enhanced Berkeley Packet Filter (eBPF) within user-space dpdk application.
 229
 230
 231 API Changes
 232 -----------
 233
 234 .. This section should contain API changes. Sample format:
 235
 236    * Add a short 1-2 sentence description of the API change. Use fixed width
 237      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 238      tense.
 239
 240    This section is a comment. Do not overwrite or remove it.
 241    Also, make sure to start the actual text at the margin.
 242    =========================================================
 243
 244 * service cores: no longer marked as experimental.
 245
 246   The service cores functions are no longer marked as experimental, and have
 247   become part of the normal DPDK API and ABI. Any future ABI changes will be
 248   announced at least one release before the ABI change is made. There are no
 249   ABI breaking changes planned.
 250
 251 * eal: ``rte_lcore_has_role()`` return value changed.
 252
 253   This function now returns true or false, respectively,
 254   rather than 0 or <0 for success or failure.
 255   It makes use of the function more intuitive.
 256
 257 * mempool: capability flags and related functions have been removed.
 258
 259   Flags ``MEMPOOL_F_CAPA_PHYS_CONTIG`` and
 260   ``MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS`` were used by octeontx mempool
 261   driver to customize generic mempool library behaviour.
 262   Now the new driver callbacks ``calc_mem_size`` and ``populate`` may be
 263   used to achieve it without specific knowledge in the generic code.
 264
 265 * mempool: xmem functions have been deprecated:
 266
 267   - ``rte_mempool_xmem_create``
 268   - ``rte_mempool_xmem_size``
 269   - ``rte_mempool_xmem_usage``
 270   - ``rte_mempool_populate_iova_tab``
 271
 272 * mbuf: The control mbuf API has been removed in v18.05. The impacted
 273   functions and macros are:
 274
 275   - ``rte_ctrlmbuf_init()``
 276   - ``rte_ctrlmbuf_alloc()``
 277   - ``rte_ctrlmbuf_free()``
 278   - ``rte_ctrlmbuf_data()``
 279   - ``rte_ctrlmbuf_len()``
 280   - ``rte_is_ctrlmbuf()``
 281   - ``CTRL_MBUF_FLAG``
 282
 283   The packet mbuf API should be used as a replacement.
 284
 285 * meter: updated to accommodate configuration profiles.
 286
 287   The meter API is changed to support meter configuration profiles. The
 288   configuration profile represents the set of configuration parameters
 289   for a given meter object, such as the rates and sizes for the token
 290   buckets. These configuration parameters were previously the part of meter
 291   object internal data strcuture. The separation of the configuration
 292   parameters from meter object data structure results in reducing its
 293   memory footprint which helps in better cache utilization when large number
 294   of meter objects are used.
 295
 296 * ethdev: The function ``rte_eth_dev_count``, often mis-used to iterate
 297   over ports, is deprecated and replaced by ``rte_eth_dev_count_avail``.
 298   There is also a new function ``rte_eth_dev_count_total`` to get the
 299   total number of allocated ports, available or not.
 300   The hotplug-proof applications should use ``RTE_ETH_FOREACH_DEV`` or
 301   ``RTE_ETH_FOREACH_DEV_OWNED_BY`` as port iterators.
 302
 303 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
 304   replaced with field ``struct rte_device *device``.
 305
 306 * **Changes to semantics of rte_eth_dev_configure() parameters.**
 307
 308    If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
 309    ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
 310    recommendations are not provided by the PMD the function will use ethdev
 311    fall-back values. Previously setting both of the parameters to zero would
 312    have resulted in ``-EINVAL`` being returned.
 313
 314 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
 315
 316    If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
 317    now use the PMD-recommended Rx ring size, or in the case where the PMD
 318    does not provide a recommendation, will use an ethdev-provided
 319    fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
 320    resulted in an error.
 321
 322 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
 323
 324    If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
 325    now use the PMD-recommended Tx ring size, or in the case where the PMD
 326    does not provide a recoomendation, will use an ethdev-provided
 327    fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
 328    resulted in an error.
 329
 330 * ethdev: several changes were made to the flow API.
 331
 332   * Unused DUP action was removed.
 333   * Actions semantics in flow rules: list order now matters ("first
 334     to last" instead of "all simultaneously"), repeated actions are now
 335     all performed, and they do not individually have (non-)terminating
 336     properties anymore.
 337   * Flow rules are now always terminating unless a PASSTHRU action is
 338     present.
 339   * C99-style flexible arrays were replaced with standard pointers in RSS
 340     action and in RAW pattern item structures due to compatibility issues.
 341   * The RSS action was modified to not rely on external
 342     ``struct rte_eth_rss_conf`` anymore to instead expose its own and more
 343     appropriately named configuration fields directly
 344     (``rss_conf->rss_key`` => ``key``,
 345     ``rss_conf->rss_key_len`` => ``key_len``,
 346     ``rss_conf->rss_hf`` => ``types``,
 347     ``num`` => ``queue_num``), and the addition of missing RSS parameters
 348     (``func`` for RSS hash function to apply and ``level`` for the
 349     encapsulation level).
 350   * The VLAN pattern item (``struct rte_flow_item_vlan``) was modified to
 351     include inner EtherType instead of outer TPID. Its default mask was also
 352     modified to cover the VID part (lower 12 bits) of TCI only.
 353   * A new transfer attribute was added to ``struct rte_flow_attr`` in order
 354     to clarify the behavior of some pattern items.
 355   * PF and VF pattern items are now only accepted by PMDs that implement
 356     them (bnxt and i40e) when the transfer attribute is also present for
 357     consistency.
 358   * Pattern item PORT was renamed PHY_PORT to avoid confusion with DPDK port
 359     IDs.
 360   * An action counterpart to the PHY_PORT pattern item was added in order to
 361     redirect matching traffic to a specific physical port.
 362   * PORT_ID pattern item and actions were added to match and target DPDK
 363     port IDs at a higher level than PHY_PORT.
 364
 365 * ethdev: change flow APIs regarding count action:
 366   * ``rte_flow_create()`` API count action now requires the ``struct rte_flow_action_count``.
 367   * ``rte_flow_query()`` API parameter changed from action type to action structure.
 368
 369
 370 ABI Changes
 371 -----------
 372
 373 .. This section should contain ABI changes. Sample format:
 374
 375    * Add a short 1-2 sentence description of the ABI change that was announced
 376      in the previous releases and made in this release. Use fixed width quotes
 377      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 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 * ring: the alignment constraints on the ring structure has been relaxed
 384   to one cache line instead of two, and an empty cache line padding is
 385   added between the producer and consumer structures. The size of the
 386   structure and the offset of the fields remains the same on platforms
 387   with 64B cache line, but change on other platforms.
 388
 389 * mempool: ops have changed.
 390
 391   A new callback ``calc_mem_size`` has been added to ``rte_mempool_ops``
 392   to allow to customize required memory size calculation.
 393   A new callback ``populate`` has been added to ``rte_mempool_ops``
 394   to allow to customize objects population.
 395   Callback ``get_capabilities`` has been removed from ``rte_mempool_ops``
 396   since its features are covered by ``calc_mem_size`` and ``populate``
 397   callbacks.
 398   Callback ``register_memory_area`` has been removed from ``rte_mempool_ops``
 399   since the new callback ``populate`` may be used instead of it.
 400
 401 * **Additional fields in rte_eth_dev_info.**
 402
 403   The ``rte_eth_dev_info`` structure has had two extra entries appended to the
 404   end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
 405   in turn are ``rte_eth_dev_portconf`` structures containing three fields of
 406   type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
 407   are parameter values recommended for use by the PMD.
 408
 409 * ethdev: ABI for all flow API functions was updated.
 410
 411   This includes functions ``rte_flow_copy``, ``rte_flow_create``,
 412   ``rte_flow_destroy``, ``rte_flow_error_set``, ``rte_flow_flush``,
 413   ``rte_flow_isolate``, ``rte_flow_query`` and ``rte_flow_validate``, due to
 414   changes in error type definitions (``enum rte_flow_error_type``), removal
 415   of the unused DUP action (``enum rte_flow_action_type``), modified
 416   behavior for flow rule actions (see API changes), removal of C99 flexible
 417   array from RAW pattern item (``struct rte_flow_item_raw``), complete
 418   rework of the RSS action definition (``struct rte_flow_action_rss``),
 419   sanity fix in the VLAN pattern item (``struct rte_flow_item_vlan``) and
 420   new transfer attribute (``struct rte_flow_attr``).
 421
 422 **New parameter added to rte_bbdev_op_cap_turbo_dec.**
 423
 424   A new parameter ``max_llr_modulus`` has been added to
 425   ``rte_bbdev_op_cap_turbo_dec`` structure to specify maximal LLR (likelihood
 426   ratio) absolute value.
 427
 428 * **BBdev Queue Groups split into UL/DL Groups**
 429
 430   Queue Groups have been split into UL/DL Groups in Turbo Software Driver.
 431   They are independent for Decode/Encode. ``rte_bbdev_driver_info`` reflects
 432   introduced changes.
 433
 434
 435 Removed Items
 436 -------------
 437
 438 .. This section should contain removed items in this release. Sample format:
 439
 440    * Add a short 1-2 sentence description of the removed item in the past
 441      tense.
 442
 443    This section is a comment. Do not overwrite or remove it.
 444    Also, make sure to start the actual text at the margin.
 445    =========================================================
 446
 447
 448 Known Issues
 449 ------------
 450
 451 .. This section should contain new known issues in this release. Sample format:
 452
 453    * **Add title in present tense with full stop.**
 454
 455      Add a short 1-2 sentence description of the known issue in the present
 456      tense. Add information on any known workarounds.
 457
 458    This section is a comment. Do not overwrite or remove it.
 459    Also, make sure to start the actual text at the margin.
 460    =========================================================
 461
 462 * **pdump is not compatible with old applications.**
 463
 464   As we changed to use generic multi-process communication for pdump negotiation
 465   instead of previous dedicated unix socket way, pdump applications, including
 466   dpdk-pdump example and any other applications using librte_pdump, cannot work
 467   with older version DPDK primary applications.
 468
 469
 470 Shared Library Versions
 471 -----------------------
 472
 473 .. Update any library version updated in this release and prepend with a ``+``
 474    sign, like this:
 475
 476      librte_acl.so.2
 477    + librte_cfgfile.so.2
 478      librte_cmdline.so.2
 479
 480    This section is a comment. Do not overwrite or remove it.
 481    =========================================================
 482
 483
 484 The libraries prepended with a plus sign were incremented in this version.
 485
 486 .. code-block:: diff
 487
 488      librte_acl.so.2
 489      librte_bbdev.so.1
 490      librte_bitratestats.so.2
 491    + librte_bpf.so.1
 492      librte_bus_dpaa.so.1
 493      librte_bus_fslmc.so.1
 494      librte_bus_pci.so.1
 495      librte_bus_vdev.so.1
 496      librte_cfgfile.so.2
 497      librte_cmdline.so.2
 498    + librte_common_octeontx.so.1
 499    + librte_compressdev.so.1
 500      librte_cryptodev.so.4
 501      librte_distributor.so.1
 502    + librte_eal.so.7
 503    + librte_ethdev.so.9
 504    + librte_eventdev.so.4
 505      librte_flow_classify.so.1
 506      librte_gro.so.1
 507      librte_gso.so.1
 508      librte_hash.so.2
 509      librte_ip_frag.so.1
 510      librte_jobstats.so.1
 511      librte_kni.so.2
 512      librte_kvargs.so.1
 513      librte_latencystats.so.1
 514      librte_lpm.so.2
 515    + librte_mbuf.so.4
 516    + librte_mempool.so.4
 517    + librte_meter.so.2
 518      librte_metrics.so.1
 519      librte_net.so.1
 520      librte_pci.so.1
 521      librte_pdump.so.2
 522      librte_pipeline.so.3
 523      librte_pmd_bnxt.so.2
 524      librte_pmd_bond.so.2
 525      librte_pmd_i40e.so.2
 526      librte_pmd_ixgbe.so.2
 527    + librte_pmd_dpaa2_cmdif.so.1
 528    + librte_pmd_dpaa2_qdma.so.1
 529      librte_pmd_ring.so.2
 530      librte_pmd_softnic.so.1
 531      librte_pmd_vhost.so.2
 532      librte_port.so.3
 533      librte_power.so.1
 534      librte_rawdev.so.1
 535      librte_reorder.so.1
 536    + librte_ring.so.2
 537      librte_sched.so.1
 538      librte_security.so.1
 539      librte_table.so.3
 540      librte_timer.so.1
 541      librte_vhost.so.3
 542
 543
 544 Tested Platforms
 545 ----------------
 546
 547 .. This section should contain a list of platforms that were tested with this
 548    release.
 549
 550    The format is:
 551
 552    * <vendor> platform with <vendor> <type of devices> combinations
 553
 554      * List of CPU
 555      * List of OS
 556      * List of devices
 557      * Other relevant details...
 558
 559    This section is a comment. Do not overwrite or remove it.
 560    Also, make sure to start the actual text at the margin.
 561    =========================================================