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