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