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