doc/guides/rel_notes/release_21_11.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.11
   7 ==================
   8
   9 .. **Read this first.**
  10
  11    The text in the sections below explains how to update the release notes.
  12
  13    Use proper spelling, capitalization and punctuation in all sections.
  14
  15    Variable and config names should be quoted as fixed width text:
  16    ``LIKE_THIS``.
  17
  18    Build the docs and view the output file to ensure the changes are correct::
  19
  20       ninja -C build doc
  21       xdg-open build/doc/guides/html/rel_notes/release_21_11.html
  22
  23
  24 New Features
  25 ------------
  26
  27 .. This section should contain new features added in this release.
  28    Sample format:
  29
  30    * **Add a title in the past tense with a full stop.**
  31
  32      Add a short 1-2 sentence description in the past tense.
  33      The description should be enough to allow someone scanning
  34      the release notes to understand the new feature.
  35
  36      If the feature adds a lot of sub-features you can use a bullet list
  37      like this:
  38
  39      * Added feature foo to do something.
  40      * Enhanced feature bar to do something else.
  41
  42      Refer to the previous release notes for examples.
  43
  44      Suggested order in release notes items:
  45      * Core libs (EAL, mempool, ring, mbuf, buses)
  46      * Device abstraction libs and PMDs (ordered alphabetically by vendor name)
  47        - ethdev (lib, PMDs)
  48        - cryptodev (lib, PMDs)
  49        - eventdev (lib, PMDs)
  50        - etc
  51      * Other libs
  52      * Apps, Examples, Tools (if significant)
  53
  54      This section is a comment. Do not overwrite or remove it.
  55      Also, make sure to start the actual text at the margin.
  56      =======================================================
  57
  58 * **Enabled new devargs parser.**
  59
  60   * Enabled devargs syntax
  61     ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``
  62   * Added bus-level parsing of the devargs syntax.
  63   * Kept compatibility with the legacy syntax as parsing fallback.
  64
  65 * **Updated EAL hugetlbfs mount handling for Linux.**
  66
  67   * Modified to allow ``--huge-dir`` option to specify a sub-directory
  68     within a hugetlbfs mountpoint.
  69
  70 * **Added dmadev library.**
  71
  72   * Added a DMA device framework for management and provision of
  73     hardware and software DMA devices.
  74   * Added generic API which support a number of different DMA
  75     operations.
  76   * Added multi-process support.
  77
  78 * **Updated default KNI behavior on net devices control callbacks.**
  79
  80   Updated KNI net devices control callbacks to run with ``rtnl`` kernel lock
  81   held by default. A newly added ``enable_bifurcated`` KNI kernel module
  82   parameter can be used to run callbacks with ``rtnl`` lock released.
  83
  84 * **Added HiSilicon DMA driver.**
  85
  86   The HiSilicon DMA driver provides device drivers for the Kunpeng's DMA devices.
  87   This device driver can be used through the generic dmadev API.
  88
  89 * **Added IDXD dmadev driver implementation.**
  90
  91   The IDXD dmadev driver provide device drivers for the Intel DSA devices.
  92   This device driver can be used through the generic dmadev API.
  93
  94 * **Added IOAT dmadev driver implementation.**
  95
  96   The Intel I/O Acceleration Technology (IOAT) dmadev driver provides a device
  97   driver for Intel IOAT devices such as Crystal Beach DMA (CBDMA) on Ice Lake,
  98   Skylake and Broadwell. This device driver can be used through the generic dmadev API.
  99
 100 * **Added Marvell CNXK DMA driver.**
 101
 102   Added dmadev driver for the DPI DMA hardware accelerator
 103   of Marvell OCTEONTX2 and OCTEONTX3 family of SoCs.
 104
 105 * **Added NXP DPAA DMA driver.**
 106
 107   Added a new dmadev driver for NXP DPAA platform.
 108
 109 * **Added support to get all MAC addresses of a device.**
 110
 111   Added ``rte_eth_macaddrs_get`` to allow user to retrieve all Ethernet
 112   addresses assigned to given ethernet port.
 113
 114 * **Introduced GPU device class with first features:**
 115
 116   * Device information
 117   * Memory management
 118   * Communication flag & list
 119
 120 * **Added NVIDIA GPU driver implemented with CUDA library.**
 121
 122 * **Added new RSS offload types for IPv4/L4 checksum in RSS flow.**
 123
 124   Added macros ETH_RSS_IPV4_CHKSUM and ETH_RSS_L4_CHKSUM, now IPv4 and
 125   TCP/UDP/SCTP header checksum field can be used as input set for RSS.
 126
 127 * **Added L2TPv2 and PPP protocol support in flow API.**
 128
 129   Added flow pattern items and header formats of L2TPv2 and PPP protocol.
 130
 131 * **Added flow flex item.**
 132
 133   The configurable flow flex item provides the capability to introduce
 134   an arbitrary user-specified network protocol header,
 135   configure the hardware accordingly, and perform match on this header
 136   with desired patterns and masks.
 137
 138 * **Added ethdev support to control delivery of Rx metadata from the HW to the PMD.**
 139
 140   A new API, ``rte_eth_rx_metadata_negotiate()``, was added.
 141   The following parts of Rx metadata were defined:
 142
 143   * ``RTE_ETH_RX_METADATA_USER_FLAG``
 144   * ``RTE_ETH_RX_METADATA_USER_MARK``
 145   * ``RTE_ETH_RX_METADATA_TUNNEL_ID``
 146
 147 * **Added an API to get a proxy port to manage "transfer" flows.**
 148
 149   A new API, ``rte_flow_pick_transfer_proxy()``, was added.
 150
 151 * **Added ethdev shared Rx queue support.**
 152
 153   * Added new device capability flag and Rx domain field to switch info.
 154   * Added share group and share queue ID to Rx queue configuration.
 155   * Added testpmd support and dedicate forwarding engine.
 156
 157 * **Updated af_packet ethdev driver.**
 158
 159   * Default VLAN strip behavior was changed. VLAN tag won't be stripped
 160     unless ``DEV_RX_OFFLOAD_VLAN_STRIP`` offload is enabled.
 161
 162 * **Added API to get device configuration in ethdev.**
 163
 164   Added an ethdev API which can help users get device configuration.
 165
 166 * **Updated AF_XDP PMD.**
 167
 168   * Disabled secondary process support.
 169
 170 * **Updated Amazon ENA PMD.**
 171
 172   Updated the Amazon ENA PMD. The new driver version (v2.5.0) introduced
 173   bug fixes and improvements, including:
 174
 175   * Support for the tx_free_thresh and rx_free_thresh configuration parameters.
 176   * NUMA aware allocations for the queue helper structures.
 177   * Watchdog's feature which is checking for missing Tx completions.
 178
 179 * **Updated Broadcom bnxt PMD.**
 180
 181   * Added flow offload support for Thor.
 182   * Added TruFlow and AFM SRAM partitioning support.
 183   * Implement support for tunnel offload.
 184   * Updated HWRM API to version 1.10.2.68.
 185   * Added NAT support for dest IP and port combination.
 186   * Added support for socket redirection.
 187   * Added wildcard match support for ingress flows.
 188   * Added support for inner IP header for GRE tunnel flows.
 189   * Updated support for RSS action in flow rule.
 190   * Removed devargs option for stats accumulation.
 191
 192 * **Updated Cisco enic driver.**
 193
 194   * Added rte_flow support for matching GTP, GTP-C and GTP-U headers.
 195
 196 * **Updated Intel e1000 emulated driver.**
 197
 198   * Added Intel e1000 support on Windows.
 199
 200 * **Updated Intel iavf driver.**
 201
 202   * Added Intel iavf support on Windows.
 203   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
 204   * Added PPPoL2TPv2oUDP RSS hash based on inner IP address and TCP/UDP port.
 205   * Added Intel iavf inline crypto support.
 206
 207 * **Updated Intel ice driver.**
 208
 209   * Added protocol agnostic flow offloading support in Flow Director.
 210   * Added protocol agnostic flow offloading support in RSS hash.
 211   * Added 1PPS out support by a devargs.
 212   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
 213   * Added DEV_RX_OFFLOAD_TIMESTAMP support.
 214   * Added timesync API support under scalar path.
 215   * Added DCF reset API support.
 216
 217 * **Updated Intel ixgbe driver.**
 218
 219   * Added Intel ixgbe support on Windows.
 220
 221 * **Updated Marvell cnxk ethdev driver.**
 222
 223   * Added rte_flow support for dual VLAN insert and strip actions.
 224   * Added rte_tm support.
 225   * Added support for Inline IPsec for CN9K event mode and CN10K
 226     poll mode and event mode.
 227   * Added support for ingress meter for CN10K platform.
 228
 229 * **Updated Mellanox mlx5 driver.**
 230
 231   Updated the Mellanox mlx5 driver with new features and improvements, including:
 232
 233   * Added implicit mempool registration to avoid data path hiccups (opt-out).
 234   * Added delay drop support for Rx queue.
 235   * Added NIC offloads for the PMD on Windows (TSO, VLAN strip, CRC keep).
 236   * Added socket direct mode bonding support.
 237
 238 * **Added NXP ENETFEC PMD [EXPERIMENTAL].**
 239
 240   Added the new ENETFEC driver for the NXP IMX8MMEVK platform. See the
 241   :doc:`../nics/enetfec` NIC driver guide for more details on this new driver.
 242
 243 * **Updated Solarflare network PMD.**
 244
 245   Updated the Solarflare ``sfc_efx`` driver with changes including:
 246
 247   * Added port representors support on SN1000 SmartNICs
 248   * Added flow API transfer proxy support
 249   * Added SN1000 virtual functions (VF) support
 250   * Added support for flow counters without service cores
 251   * Added support for regioned DMA mapping required on SN1022 SoC
 252
 253 * **Added power monitor API in vhost library.**
 254
 255   Added an API to support power monitor in vhost library.
 256
 257 * **Updated vhost PMD.**
 258
 259   Add power monitor support in vhost PMD.
 260
 261 * **Updated virtio PMD.**
 262
 263   * Initial support for RSS receive mode has been added to the Virtio PMD,
 264     with the capability for the application to configure the hash key,
 265     the RETA and the hash types.
 266     Virtio hash reporting is yet to be added.
 267   * Added power monitor support in virtio PMD.
 268
 269 * **Updated Wangxun ngbe driver.**
 270
 271   * Added offloads and packet type on RxTx.
 272   * Added VLAN and MAC filters.
 273   * Added device basic statistics and extended stats.
 274   * Added multi-queue and RSS.
 275   * Added SRIOV.
 276   * Added flow control.
 277   * Added IEEE 1588.
 278
 279 * **Added new vDPA PMD based on Xilinx devices.**
 280
 281   Added a new Xilinx vDPA  (``sfc_vdpa``) PMD.
 282   See the :doc:`../vdpadevs/sfc` guide for more details on this driver.
 283
 284 * **Added telemetry callbacks to cryptodev library.**
 285
 286   Added telemetry callback functions which allow a list of crypto devices,
 287   stats for a crypto device, and other device information to be queried.
 288   Also added callback to get cryptodev capabilities.
 289
 290 * **Added telemetry to security library.**
 291
 292   Added telemetry callback functions to query security capabilities of
 293   crypto device.
 294
 295 * **Updated Marvell cnxk crypto PMD.**
 296
 297   * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
 298   * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
 299   * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
 300   * Added support for lookaside protocol (IPsec) offload for CN9K.
 301   * Added support for ZUC algorithm with 256-bit key length for CN10K.
 302   * Added support for CN98xx dual block.
 303   * Added inner checksum support in lookaside protocol (IPsec) for CN10K.
 304   * Added AES-CBC NULL auth support in lookaside protocol (IPsec) for CN10K.
 305   * Added ESN and anti-replay support in lookaside protocol (IPsec) for CN9K.
 306
 307 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
 308
 309   * Added event crypto adapter OP_FORWARD mode support.
 310
 311 * **Updated Mellanox mlx5 crypto driver.**
 312
 313   * Added Windows support.
 314   * Added support for BlueField 2 and ConnectX-6 Dx.
 315
 316 * **Updated NXP dpaa_sec crypto PMD.**
 317
 318   * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
 319   * Added PDCP short MAC-I support.
 320   * Added raw vector datapath API support.
 321
 322 * **Updated NXP dpaa2_sec crypto PMD.**
 323
 324   * Added PDCP short MAC-I support.
 325   * Added raw vector datapath API support.
 326
 327 * **Added framework for consolidation of IPsec_MB dependent SW Crypto PMDs.**
 328
 329   * The IPsec_MB framework was added to share common code between Intel
 330     SW Crypto PMDs that depend on the intel-ipsec-mb library.
 331   * Multiprocess support was added for the consolidated PMDs,
 332     which requires v1.1 of the intel-ipsec-mb library.
 333   * The following PMDs were moved into a single source folder,
 334     however their usage and EAL options remain unchanged.
 335     * AESNI_MB PMD.
 336     * AESNI_GCM PMD.
 337     * KASUMI PMD.
 338     * SNOW3G PMD.
 339     * ZUC PMD.
 340     * CHACHA20_POLY1305 - A new PMD added.
 341
 342 * **Updated the aesni_mb crypto PMD.**
 343
 344   * Added support for ZUC-EEA3-256 and ZUC-EIA3-256.
 345
 346 * **Added digest appended ops support for Snow3G PMD.**
 347
 348   * Added support for out-of-place auth-cipher operations that encrypt
 349     the digest along with the rest of the raw data.
 350   * Added support for partially encrypted digest when using auth-cipher
 351     operations.
 352
 353 * **Updated the ACC100 bbdev PMD.**
 354
 355   Added support for more comprehensive CRC options.
 356
 357 * **Updated the turbo_sw bbdev PMD.**
 358
 359   Added support for more comprehensive CRC options.
 360
 361 * **Added NXP LA12xx baseband PMD.**
 362
 363   * Added a new baseband PMD driver for NXP LA12xx Software defined radio.
 364   * See the :doc:`../bbdevs/la12xx` for more details.
 365
 366 * **Updated Mellanox compress driver.**
 367
 368   * Added devargs option to allow manual setting of Huffman block size.
 369
 370 * **Updated Mellanox regex driver.**
 371
 372   * Added support for new ROF file format.
 373
 374 * **Updated IPsec library.**
 375
 376   * Added support for more AEAD algorithms AES_CCM, CHACHA20_POLY1305
 377     and AES_GMAC.
 378   * Added support for NAT-T / UDP encapsulated ESP.
 379   * Added support for SA telemetry.
 380   * Added support for setting a non default starting ESN value.
 381   * Added support for TSO in inline crypto mode.
 382
 383 * **Added optimized Toeplitz hash implementation.**
 384
 385   Added optimized Toeplitz hash implementation using Galois Fields New Instructions.
 386
 387 * **Added multi-process support for testpmd.**
 388
 389   Added command-line options to specify total number of processes and
 390   current process ID. Each process owns subset of Rx and Tx queues.
 391
 392 * **Updated test-crypto-perf application with new cases.**
 393
 394   * Added support for asymmetric crypto throughput performance measurement.
 395     Only modex is supported for now.
 396   * Added support for lookaside IPsec protocol offload throughput measurement.
 397
 398 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
 399
 400   * Added known vector tests (AES-GCM 128, 192, 256).
 401   * Added tests to verify error reporting with ICV corruption.
 402   * Added tests to verify IV generation.
 403   * Added tests to verify UDP encapsulation.
 404   * Added tests to verify UDP encapsulation ports.
 405   * Added tests to validate packets soft expiry.
 406   * Added tests to validate packets hard expiry.
 407   * Added tests to verify tunnel header verification in IPsec inbound.
 408   * Added tests to verify inner checksum.
 409   * Added tests for CHACHA20_POLY1305 PMD, including a new testcase for SGL OOP.
 410
 411 * **Updated l3fwd sample application.**
 412
 413   * Increased number of routes to 16 for all lookup modes (LPM, EM and FIB),
 414     this helps in validating SoC with many ethernet devices.
 415   * Updated EM mode to use RFC2544 reserved IP address space with RFC863
 416     UDP discard protocol.
 417
 418 * **Updated IPsec Security Gateway sample application with new features.**
 419
 420   * Added support for TSO (only for inline crypto TCP packets).
 421   * Added support for telemetry.
 422   * Added support for more AEAD algorithms: AES-GMAC, AES_CTR, AES_XCBC_MAC,
 423     AES_CCM, CHACHA20_POLY1305
 424   * Added support for event vectors for inline protocol offload mode.
 425
 426 * **Revised packet capture framework.**
 427
 428   * New dpdk-dumpcap program that has most of the features
 429     of the wireshark dumpcap utility including:
 430     capture of multiple interfaces, filtering,
 431     and stopping after number of bytes, packets.
 432   * New library for writing pcapng packet capture files.
 433   * Enhancements to the pdump library to support:
 434     * Packet filter with BPF.
 435     * Pcapng format with timestamps and meta-data.
 436     * Fixes packet capture with stripped VLAN tags.
 437
 438 * **Added ASan support.**
 439
 440   `AddressSanitizer
 441   <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_ (ASan)
 442   is a widely-used debugging tool to detect memory access errors.
 443   It helps to detect issues like use-after-free, various kinds of buffer
 444   overruns in C/C++ programs, and other similar errors, as well as
 445   printing out detailed debug information whenever an error is detected.
 446
 447
 448 Removed Items
 449 -------------
 450
 451 .. This section should contain removed items in this release. Sample format:
 452
 453    * Add a short 1-2 sentence description of the removed item
 454      in the past tense.
 455
 456    This section is a comment. Do not overwrite or remove it.
 457    Also, make sure to start the actual text at the margin.
 458    =======================================================
 459
 460 * eal: Removed the deprecated function ``rte_get_master_lcore()``
 461   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
 462
 463 * eal: The old api arguments that were deprecated for
 464   blacklist/whitelist are removed. Users must use the new
 465   block/allow list arguments.
 466
 467 * mbuf: Removed offload flag ``PKT_RX_EIP_CKSUM_BAD``.
 468   ``PKT_RX_OUTER_IP_CKSUM_BAD`` should be used as a replacement.
 469
 470 * ethdev: Removed the port mirroring API. A more fine-grain flow API
 471   action ``RTE_FLOW_ACTION_TYPE_SAMPLE`` should be used instead.
 472   The structures ``rte_eth_mirror_conf`` and ``rte_eth_vlan_mirror`` and
 473   the functions ``rte_eth_mirror_rule_set`` and
 474   ``rte_eth_mirror_rule_reset`` along with the associated macros
 475   ``ETH_MIRROR_*`` are removed.
 476
 477 * ethdev: Removed ``rte_eth_rx_descriptor_done`` API function and its
 478   driver callback. It is replaced by the more complete function
 479   ``rte_eth_rx_descriptor_status``.
 480
 481 * ethdev: Removed deprecated ``shared`` attribute of the
 482   ``struct rte_flow_action_count``. Shared counters should be managed
 483   using indirect actions API (``rte_flow_action_handle_create`` etc).
 484
 485 * i40e: Removed i40evf driver.
 486   iavf already became the default VF driver for i40e devices,
 487   so there is no need to maintain i40evf.
 488
 489
 490 API Changes
 491 -----------
 492
 493 .. This section should contain API changes. Sample format:
 494
 495    * sample: Add a short 1-2 sentence description of the API change
 496      which was announced in the previous releases and made in this release.
 497      Start with a scope label like "ethdev:".
 498      Use fixed width quotes for ``function_names`` or ``struct_names``.
 499      Use the past tense.
 500
 501    This section is a comment. Do not overwrite or remove it.
 502    Also, make sure to start the actual text at the margin.
 503    =======================================================
 504
 505 * eal: The lcore state ``FINISHED`` is removed from
 506   the ``enum rte_lcore_state_t``.
 507   The lcore state ``WAIT`` is enough to represent the same state.
 508
 509 * eal: Made ``rte_intr_handle`` structure definition hidden.
 510
 511 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
 512   removed. Its usages have been replaced by a new function
 513   ``rte_kvargs_get_with_value()``.
 514
 515 * cmdline: ``cmdline_stdin_exit()`` now frees the ``cmdline`` structure.
 516   Calls to ``cmdline_free()`` after it need to be deleted from applications.
 517
 518 * cmdline: Made ``cmdline`` structure definition hidden on Linux and FreeBSD.
 519
 520 * cmdline: Made ``rdline`` structure definition hidden. Functions are added
 521   to dynamically allocate and free it, and to access user data in callbacks.
 522
 523 * mempool: Added ``RTE_MEMPOOL_F_NON_IO`` flag to give a hint to DPDK components
 524   that objects from this pool will not be used for device IO (e.g. DMA).
 525
 526 * mempool: The mempool flags ``MEMPOOL_F_*`` will be deprecated in the future.
 527   Newly added flags with ``RTE_MEMPOOL_F_`` prefix should be used instead.
 528
 529 * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated.
 530   The replacement macro ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only.
 531
 532 * mempool: Macro to register mempool driver ``MEMPOOL_REGISTER_OPS()`` is
 533   deprecated.  Use replacement ``RTE_MEMPOOL_REGISTER_OPS()``.
 534
 535 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
 536   will be removed in DPDK 22.11.
 537
 538 * mbuf: The mbuf offload flags ``PKT_*`` are renamed as ``RTE_MBUF_F_*``. A
 539   compatibility layer will be kept until DPDK 22.11.
 540 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
 541   to ``src_addr`` and ``dst_addr``, respectively.
 542
 543 * net: Added ``version`` and ``ihl`` bit-fields to ``struct rte_ipv4_hdr``.
 544   Existing ``version_ihl`` field is kept for backward compatibility.
 545
 546 * ethdev: Added items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` to
 547   flow API.
 548
 549 * ethdev: Deprecated items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID``.
 550   Suggested items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` instead.
 551
 552 * ethdev: Deprecated the use of attributes ``ingress`` / ``egress`` combined
 553   with ``transfer``. See items ``PORT_REPRESENTOR``, ``REPRESENTED_PORT``.
 554
 555 * ethdev: ``rte_flow_action_modify_data`` structure updated, immediate data
 556   array is extended, data pointer field is explicitly added to union, the
 557   action behavior is defined in more strict fashion and documentation updated.
 558   The immediate value behavior has been changed, the entire immediate field
 559   should be provided, and offset for immediate source bitfield is assigned
 560   from destination one.
 561
 562 * vhost: ``rte_vdpa_register_device``, ``rte_vdpa_unregister_device``,
 563   ``rte_vhost_host_notifier_ctrl`` and ``rte_vdpa_relay_vring_used`` vDPA
 564   driver interface are marked as internal.
 565
 566 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
 567   rte_cryptodev_is_valid_dev as it can be used by the application as
 568   well as PMD to check whether the device is valid or not.
 569
 570 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
 571   as it is for drivers only and should be private to DPDK, and not
 572   installed for app use.
 573
 574 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
 575   renamed to ``aux_flags`` to indicate warnings and other information from
 576   the crypto/security operation. This field will be used to communicate
 577   events such as soft expiry with IPsec in lookaside mode.
 578
 579 * cryptodev: The field ``dataunit_len`` of the ``struct rte_crypto_cipher_xform``
 580   moved to the end of the structure and extended to ``uint32_t``.
 581
 582 * cryptodev: The structure ``rte_crypto_vec`` was updated to add ``tot_len``
 583   field to support total buffer length to facilitate protocol offload case.
 584
 585 * cryptodev: The structure ``rte_crypto_sym_vec`` was updated to add
 586   ``dest_sgl`` to support out of place processing.
 587
 588 * bbdev: Added device info related to data byte endianness processing.
 589
 590 * eventdev: Moved memory used by timer adapters to hugepage. This will prevent
 591   TLB misses if any and aligns to memory structure of other subsystems.
 592
 593 * fib: Added the ``rib_ext_sz`` field to ``rte_fib_conf`` and ``rte_fib6_conf``
 594   so that user can specify the size of the RIB extension inside the FIB.
 595
 596 * ip_frag: All macros updated to have ``RTE_IP_FRAG_`` prefix.
 597   Obsolete macros are kept for compatibility.
 598   DPDK components updated to use new names.
 599   Experimental function ``rte_frag_table_del_expired_entries`` was renamed
 600   to ``rte_ip_frag_table_del_expired_entries``
 601   to comply with other public API naming convention.
 602
 603
 604 ABI Changes
 605 -----------
 606
 607 .. This section should contain ABI changes. Sample format:
 608
 609    * sample: Add a short 1-2 sentence description of the ABI change
 610      which was announced in the previous releases and made in this release.
 611      Start with a scope label like "ethdev:".
 612      Use fixed width quotes for ``function_names`` or ``struct_names``.
 613      Use the past tense.
 614
 615    This section is a comment. Do not overwrite or remove it.
 616    Also, make sure to start the actual text at the margin.
 617    =======================================================
 618
 619 * ethdev: All enums & macros updated to have ``RTE_ETH`` prefix and structures
 620   updated to have ``rte_eth`` prefix. DPDK components updated to use new names.
 621
 622 * ethdev: Input parameters for ``eth_rx_queue_count_t`` was changed.
 623   Instead of pointer to ``rte_eth_dev`` and queue index, now it accepts pointer
 624   to internal queue data as input parameter. While this change is transparent
 625   to user, it still counts as an ABI change, as ``eth_rx_queue_count_t``
 626   is used by  public inline function ``rte_eth_rx_queue_count``.
 627
 628 * ethdev: Made ``rte_eth_dev``, ``rte_eth_dev_data``, ``rte_eth_rxtx_callback``
 629   private data structures. ``rte_eth_devices[]`` can't be accessed directly
 630   by user any more. While it is an ABI breakage, this change is intended
 631   to be transparent for both users (no changes in user app is required) and
 632   PMD developers (no changes in PMD is required).
 633
 634 * vhost: rename ``struct vhost_device_ops`` to ``struct rte_vhost_device_ops``.
 635
 636 * cryptodev: Made ``rte_cryptodev``, ``rte_cryptodev_data`` private
 637   structures internal to DPDK. ``rte_cryptodevs`` can't be accessed directly
 638   by user any more. While it is an ABI breakage, this change is intended
 639   to be transparent for both users (no changes in user app is required) and
 640   PMD developers (no changes in PMD is required).
 641
 642 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
 643   routines used by inline outbound and inline inbound security processing were
 644   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
 645   have much processing in PMD specific callbacks but just 64-bit set/get.
 646   This avoids a per packet function pointer jump overhead for such PMDs.
 647
 648 * security: A new option ``iv_gen_disable`` was added in structure
 649   ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
 650   so that application can provide its own IV and test known test vectors.
 651
 652 * security: A new option ``tunnel_hdr_verify`` was added in structure
 653   ``rte_security_ipsec_sa_options`` to indicate whether outer header
 654   verification need to be done as part of inbound IPsec processing.
 655
 656 * security: A new option ``udp_ports_verify`` was added in structure
 657   ``rte_security_ipsec_sa_options`` to indicate whether UDP ports
 658   verification need to be done as part of inbound IPsec processing.
 659
 660 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
 661   replace ``esn_soft_limit`` in IPsec configuration structure
 662   ``rte_security_ipsec_xform`` to allow applications to configure SA soft
 663   and hard expiry limits. Limits can be either in number of packets or bytes.
 664
 665 * security: The new options ``ip_csum_enable`` and ``l4_csum_enable`` were added
 666   in structure ``rte_security_ipsec_sa_options`` to indicate whether inner
 667   packet IPv4 header checksum and L4 checksum need to be offloaded to
 668   security device.
 669
 670 * security: A new structure ``esn`` was added in structure
 671   ``rte_security_ipsec_xform`` to set an initial ESN value. This permits
 672   application to start from an arbitrary ESN value for debug and SA lifetime
 673   enforcement purposes.
 674
 675 * security: A new structure ``udp`` was added in structure
 676   ``rte_security_ipsec_xform`` to allow setting the source and destination ports
 677   for UDP encapsulated IPsec traffic.
 678
 679 * bbdev: Added capability related to more comprehensive CRC options,
 680   shifting values of the ``enum rte_bbdev_op_ldpcdec_flag_bitmasks``.
 681
 682 * eventdev: New variables ``rx_event_buf_count`` and ``rx_event_buf_size``
 683   were added in structure ``rte_event_eth_rx_adapter_stats`` to get additional
 684   status.
 685
 686 * eventdev: A new structure ``rte_event_fp_ops`` has been added which is now used
 687   by the fastpath inline functions. The structures ``rte_eventdev``,
 688   ``rte_eventdev_data`` have been made internal. ``rte_eventdevs[]`` can't be
 689   accessed directly by user any more. This change is transparent to both
 690   applications and PMDs.
 691
 692 * eventdev: Re-arranged fields in ``rte_event_timer`` to remove holes.
 693
 694 * ip_frag: Increased default value for config parameter
 695   ``RTE_LIBRTE_IP_FRAG_MAX_FRAG`` from ``4`` to ``8``.
 696   This parameter controls maximum number of fragments per packet
 697   in IP reassembly table. Increasing this value from ``4`` to ``8``
 698   will allow to cover common case with jumbo packet size of ``9KB``
 699   and fragments with default frame size ``(1500B)``.
 700
 701
 702 Known Issues
 703 ------------
 704
 705 .. This section should contain new known issues in this release. Sample format:
 706
 707    * **Add title in present tense with full stop.**
 708
 709      Add a short 1-2 sentence description of the known issue
 710      in the present tense. Add information on any known workarounds.
 711
 712    This section is a comment. Do not overwrite or remove it.
 713    Also, make sure to start the actual text at the margin.
 714    =======================================================
 715
 716
 717 Tested Platforms
 718 ----------------
 719
 720 .. This section should contain a list of platforms that were tested
 721    with this release.
 722
 723    The format is:
 724
 725    * <vendor> platform with <vendor> <type of devices> combinations
 726
 727      * List of CPU
 728      * List of OS
 729      * List of devices
 730      * Other relevant details...
 731
 732    This section is a comment. Do not overwrite or remove it.
 733    Also, make sure to start the actual text at the margin.
 734    =======================================================
 735
 736 * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
 737
 738   * CPU
 739
 740     * Intel\ |reg| Atom\ |trade| CPU C3758 @ 2.20GHz
 741     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
 742     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v3 @ 2.30GHz
 743     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @ 2.20GHz
 744     * Intel\ |reg| Xeon\ |reg| Gold 6140M CPU @ 2.30GHz
 745     * Intel\ |reg| Xeon\ |reg| Gold 6139 CPU @ 2.30GHz
 746     * Intel\ |reg| Xeon\ |reg| Gold 6252N CPU @ 2.30GHz
 747     * Intel\ |reg| Xeon\ |reg| Gold 6348 CPU @ 2.60GHz
 748     * Intel\ |reg| Xeon\ |reg| Platinum 8180M CPU @ 2.50GHz
 749     * Intel\ |reg| Xeon\ |reg| Platinum 8280M CPU @ 2.70GHz
 750
 751   * OS:
 752
 753     * Fedora 34
 754     * OpenWRT 21.02.0
 755     * FreeBSD 13.0
 756     * Red Hat Enterprise Linux Server release 8.4
 757     * Suse 15 SP3
 758     * Ubuntu 20.04.3
 759     * Ubuntu 21.10
 760
 761   * NICs:
 762
 763     * Intel\ |reg| Ethernet Controller E810-C for SFP (4x25G)
 764
 765       * Firmware version: 3.10 0x8000aa86 1.3100.0
 766       * Device id (pf/vf): 8086:1593 / 8086:1889
 767       * Driver version: 1.7.11_7_g444e5edb (ice)
 768       * OS Default DDP: 1.3.27.0
 769       * COMMS DDP: 1.3.31.0
 770       * Wireless Edge DDP: 1.3.7.0
 771
 772     * Intel\ |reg| Ethernet Controller E810-C for QSFP (2x100G)
 773
 774       * Firmware version: 3.10 0x8000aa66 1.3100.0
 775       * Device id (pf/vf): 8086:1592 / 8086:1889
 776       * Driver version: 1.7.11_7_g444e5edb (ice)
 777       * OS Default DDP: 1.3.27.0
 778       * COMMS DDP: 1.3.31.0
 779       * Wireless Edge DDP: 1.3.7.0
 780
 781     * Intel\ |reg| 82599ES 10 Gigabit Ethernet Controller
 782
 783       * Firmware version: 0x61bf0001
 784       * Device id (pf/vf): 8086:10fb / 8086:10ed
 785       * Driver version(in-tree): 5.1.0-k (ixgbe)
 786       * Driver version(out-tree): 5.13.4 (ixgbe)
 787
 788     * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
 789
 790       * PF Firmware version: 8.30 0x8000a49d 1.2926.0
 791       * VF Firmware version: 8.50 0x8000b6d9 1.3082.0
 792       * Device id (pf/vf): 8086:1572 / 8086:154c
 793       * Driver version: 2.17.4 (i40e)
 794
 795     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
 796
 797       * Firmware version: 5.30 0x80002a29 1.2926.0
 798       * Device id (pf/vf): 8086:37d0 / 8086:37cd
 799       * Driver version: 2.17.4 (i40e)
 800
 801     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T (2x10G)
 802
 803       * Firmware version: 5.40 0x80002e2f 1.2935.0
 804       * Device id (pf/vf): 8086:37d2 / 8086:37cd
 805       * Driver version: 2.17.4 (i40e)
 806
 807     * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
 808
 809       * PF Firmware version: 8.30 0x8000a483 1.2926.0
 810       * VF Firmware version: 8.50 0x8000b703 1.3082.0
 811       * Device id (pf/vf): 8086:158b / 8086:154c
 812       * Driver version: 2.17.4 (i40e)
 813
 814     * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
 815
 816       * PF Firmware version: 8.30 0x8000a4ae 1.2926.0
 817       * VF Firmware version: 8.50 0x8000b6c7 1.3082.0
 818       * Device id (pf/vf): 8086:1583 / 8086:154c
 819       * Driver version: 2.17.4 (i40e)
 820
 821     * Intel\ |reg| Ethernet Converged Network Adapter X710-T2L
 822
 823       * Firmware version: 8.30 0x8000a489 1.2879.0
 824       * Device id (pf): 8086:15ff
 825       * Driver version: 2.17.4 (i40e)