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