diff options
Diffstat (limited to 'doc/guides/rel_notes')
| -rw-r--r-- | doc/guides/rel_notes/deprecation.rst | 50 | ||||
| -rw-r--r-- | doc/guides/rel_notes/known_issues.rst | 67 | ||||
| -rw-r--r-- | doc/guides/rel_notes/release_18_05.rst | 10 | ||||
| -rw-r--r-- | doc/guides/rel_notes/release_18_11.rst | 549 |
4 files changed, 534 insertions, 142 deletions
diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 34b28234..b48486d3 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -11,6 +11,20 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- +* linux: Linux kernel version 3.2 (which is the current minimum required + version for the DPDK) is not maintained anymore. Therefore the planned + minimum required kernel version for DPDK 19.02 will be the next oldest + Long Term Stable (LTS) version which is 3.16, but compatibility for + recent distribution kernels will be kept. + +* kvargs: The function ``rte_kvargs_process`` will get a new parameter + for returning key match count. It will ease handling of no-match case. + +* eal: function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to + ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function + will be added in the next release in ``rte_common.h`` that follows convention + set by existing ``rte_bsf32`` function. + * eal: both declaring and identifying devices will be streamlined in v18.11. New functions will appear to query a specific port from buses, classes of device and device drivers. Device declaration will be made coherent with the @@ -29,11 +43,22 @@ Deprecation Notices - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse`` - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp`` +* dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced + by a pa-va search library. This structure was earlier being used for holding + memory segments used by dpaa2 driver for faster pa->va translation. This + structure would be made internal (or removed if all dependencies are cleared) + in future releases. + * mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic definition in line with the ethdev TM and MTR APIs. Currently, this field is defined in librte_sched in a non-generic way. The new generic format will contain: queue ID, traffic class, color. Field size will not change. +* sched: Some API functions will change prototype due to the above + deprecation note for mbuf->hash.sched, e.g. ``rte_sched_port_pkt_write()`` + and ``rte_sched_port_pkt_read()`` will likely have an additional parameter + of type ``struct rte_sched_port``. + * mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()`` @@ -49,6 +74,31 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. +* ethdev: Maximum and minimum MTU values vary between hardware devices. In + hardware agnostic DPDK applications access to such information would allow + a more accurate way of validating and setting supported MTU values on a per + device basis rather than using a defined default for all devices. To + resolve this, the following members will be added to ``rte_eth_dev_info``. + Note: these can be added to fit a hole in the existing structure for amd64 + but not for 32-bit, as such ABI change will occur as size of the structure + will increase. + + - Member ``uint16_t min_mtu`` the minimum MTU allowed. + - Member ``uint16_t max_mtu`` the maximum MTU allowed. + +* security: New field ``uint64_t opaque_data`` is planned to be added into + ``rte_security_session`` structure. That would allow upper layer to easily + associate/de-associate some user defined data with the security session. + +* cryptodev: several API and ABI changes are planned for rte_cryptodev + in v19.02: + + - The size and layout of ``rte_cryptodev_sym_session`` will change + to fix existing issues. + - The size and layout of ``rte_cryptodev_qp_conf`` and syntax of + ``rte_cryptodev_queue_pair_setup`` will change to to allow to use + two different mempools for crypto and device private sessions. + * pdump: As we changed to use generic IPC, some changes in APIs and structure are expected in subsequent release. diff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes/known_issues.rst index 95e4ce69..a1face9c 100644 --- a/doc/guides/rel_notes/known_issues.rst +++ b/doc/guides/rel_notes/known_issues.rst @@ -759,3 +759,70 @@ Netvsc driver and application restart **Driver/Module**: ``uio_hv_generic`` module. + + +PHY link up fails when rebinding i40e NICs to kernel driver +----------------------------------------------------------- + +**Description**: + Some kernel drivers are not able to handle the link status correctly + after DPDK application sets the PHY to link down. + +**Implication**: + The link status can't be set to "up" after the NIC is rebound to the + kernel driver. Before a DPDK application quits it will invoke the + function ``i40e_dev_stop()`` which will sets the PHY to link down. Some + kernel drivers may not be able to handle the link status correctly after + it retakes control of the device. This is a known PHY link configuration + issue in the i40e kernel driver. The fix has been addressed in the 2.7.4 rc + version. So if the i40e kernel driver is < 2.7.4 and doesn't have the + fix backported it will encounter this issue. + +**Resolution/Workaround**: + First try to remove and reinsert the i40e kernel driver. If that fails + reboot the system. + +**Affected Environment/Platform**: + All. + +**Driver/Module**: + Poll Mode Driver (PMD). + + +Restricted vdev ethdev operations supported in secondary process +---------------------------------------------------------------- +**Description** + In current virtual device sharing model, Ethernet device data structure will be + shared between primary and secondary process. Only those Ethernet device operations + which based on it are workable in secondary process. + +**Implication** + Some Ethernet device operations like device start/stop will be failed on virtual + device in secondary process. + +**Affected Environment/Platform**: + ALL. + +**Driver/Module**: + Virtual Device Poll Mode Driver (PMD). + + +Kernel crash when hot-unplug igb_uio device while DPDK application is running +----------------------------------------------------------------------------- + +**Description**: + When device has been bound to igb_uio driver and application is running, + hot-unplugging the device may cause kernel crash. + +**Reason**: + When device is hot-unplugged, igb_uio driver will be removed which will destroy UIO resources. + Later trying to access any uio resource will cause kernel crash. + +**Resolution/Workaround**: + If using DPDK for PCI HW hot-unplug, prefer to bind device with VFIO instead of IGB_UIO. + +**Affected Environment/Platform**: + ALL. + +**Driver/Module**: + ``igb_uio`` module. diff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst index 8dc22b01..3413d8de 100644 --- a/doc/guides/rel_notes/release_18_05.rst +++ b/doc/guides/rel_notes/release_18_05.rst @@ -594,7 +594,7 @@ Known Issues The issue is explained in more detail, including potential workarounds, in the Bugzilla entry referenced below. - Bugzilla entry: https://dpdk.org/tracker/show_bug.cgi?id=50 + Bugzilla entry: https://bugs.dpdk.org/show_bug.cgi?id=50 * **pdump is not compatible with old applications.** @@ -619,21 +619,21 @@ Known Issues needs to be run per-shell session, or before every test run. This change can also be made persistent by adding ``kern.coredump=0`` to ``/etc/sysctl.conf``. - Bugzilla entry: https://dpdk.org/tracker/show_bug.cgi?id=53 + Bugzilla entry: https://bugs.dpdk.org/show_bug.cgi?id=53 * **ixgbe PMD crash on hotplug detach when no VF created.** ixgbe PMD uninit path cause null pointer dereference because of port representor cleanup when number of VF is zero. - Bugzilla entry: https://dpdk.org/tracker/show_bug.cgi?id=57 + Bugzilla entry: https://bugs.dpdk.org/show_bug.cgi?id=57 * **Bonding PMD may fail to accept new slave ports in certain conditions.** In certain conditions when using testpmd, bonding may fail to register new slave ports. - Bugzilla entry: https://dpdk.org/tracker/show_bug.cgi?id=52. + Bugzilla entry: https://bugs.dpdk.org/show_bug.cgi?id=52. * **Unexpected performance regression in Vhost library.** @@ -641,7 +641,7 @@ Known Issues drop. However, in some setups, bigger performance drops have been measured when running micro-benchmarks. - Bugzilla entry: https://dpdk.org/tracker/show_bug.cgi?id=48 + Bugzilla entry: https://bugs.dpdk.org/show_bug.cgi?id=48 Shared Library Versions diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst index 32ff0e5c..65bab557 100644 --- a/doc/guides/rel_notes/release_18_11.rst +++ b/doc/guides/rel_notes/release_18_11.rst @@ -48,7 +48,7 @@ New Features - eventdev (lib, PMDs) - etc * Other libs - * Apps, Examples, Tools (if significative) + * Apps, Examples, Tools (if significant) This section is a comment. Do not overwrite or remove it. Also, make sure to start the actual text at the margin. @@ -56,40 +56,42 @@ New Features * **Added support for using externally allocated memory in DPDK.** - DPDK has gained support for creating new ``rte_malloc`` heaps referencing + DPDK has added support for creating new ``rte_malloc`` heaps referencing memory that was created outside of DPDK's own page allocator, and using that memory natively with any other DPDK library or data structure. -* **Added check for ensuring allocated memory addressable by devices.** +* **Added check for ensuring allocated memory is addressable by devices.** Some devices can have addressing limitations so a new function, - ``rte_mem_check_dma_mask``, has been added for checking allocated memory is - not out of the device range. Because now memory can be dynamically allocated - after initialization, a dma mask is kept and any new allocated memory will be - checked out against that dma mask and rejected if out of range. If more than - one device has addressing limitations, the dma mask is the more restricted one. + ``rte_mem_check_dma_mask()``, has been added for checking that allocated + memory is not out of the device range. Since memory can now be allocated + dynamically after initialization, a DMA mask is stored and any new allocated + memory will be checked against it and rejected if it is out of range. If + more than one device has addressing limitations, the DMA mask is the more + restrictive one. -* **Updated the C11 memory model version of ring library.** +* **Updated the C11 memory model version of the ring library.** - The latency is decreased for architectures using the C11 memory model - version of the ring library. + Added changes to decrease latency for architectures using the C11 memory + model version of the ring library. - On Cavium ThunderX2 platform, the changes decreased latency by 27~29% - and 3~15% for MPMC and SPSC cases respectively (with 2 lcores). The + On Cavium ThunderX2 platform, the changes decreased latency by 27-29% + and 3-15% for MPMC and SPSC cases respectively (with 2 lcores). The real improvements may vary with the number of contending lcores and - the size of ring. + the size of the ring. * **Added hot-unplug handle mechanism.** - ``rte_dev_hotplug_handle_enable`` and ``rte_dev_hotplug_handle_disable`` are - for enabling or disabling hotplug handle mechanism. + Added ``rte_dev_hotplug_handle_enable()`` and + ``rte_dev_hotplug_handle_disable()`` for enabling or disabling the hotplug + handle mechanism. -* **Support device multi-process hotplug.** +* **Added support for device multi-process hotplug.** - Hotplug and hot-unplug for devices will now be supported in multiprocessing - scenario. Any ethdev devices created in the primary process will be regarded - as shared and will be available for all DPDK processes. Synchronization - between processes will be done using DPDK IPC. + Added support for hotplug and hot-unplug in a multiprocessing scenario. Any + ethdev devices created in the primary process will be regarded as shared and + will be available for all DPDK processes. Synchronization between processes + will be done using DPDK IPC. * **Added new Flow API actions to rewrite fields in packet headers.** @@ -105,9 +107,10 @@ New Features Added new Flow API action to swap the source and destination MAC addresses in the outermost Ethernet header. -* **Add support to offload more flow match and actions for CXGBE PMD** +* **Add support to offload more flow match and actions for CXGBE PMD.** - Flow API support has been enhanced for CXGBE Poll Mode Driver to offload: + The Flow API support has been enhanced for the CXGBE Poll Mode Driver to + offload: * Match items: destination MAC address. * Action items: push/pop/rewrite vlan header, @@ -116,6 +119,7 @@ New Features swap MAC addresses in outermost Ethernet header. * **Added a devarg to use the latest supported vector path in i40e.** + A new devarg ``use-latest-supported-vec`` was introduced to allow users to choose the latest vector path that the platform supported. For example, users can use AVX2 vector path on BDW/HSW to get better performance. @@ -133,15 +137,33 @@ New Features * **Added NXP ENETC PMD.** - Added the new enetc driver for NXP enetc platform. See the - "ENETC Poll Mode Driver" document for more details on this new driver. + Added the new enetc driver for the NXP enetc platform. See the + :doc:`../nics/enetc` NIC driver guide for more details on this new driver. * **Added Ethernet poll mode driver for Aquantia aQtion family of 10G devices.** Added the new ``atlantic`` ethernet poll mode driver for Aquantia XGBE devices. - See the :doc:`../nics/atlantic` nic driver guide for more details on this + See the :doc:`../nics/atlantic` NIC driver guide for more details on this driver. +* **Updated mlx5 driver.** + + Updated the mlx5 driver including the following changes: + + * Improved security of PMD to prevent the NIC from getting stuck when + the application misbehaves. + * Reworked flow engine to supported e-switch flow rules (transfer attribute). + * Added support for header re-write(L2-L4), VXLAN encap/decap, count, match + on TCP flags and multiple flow groups with e-switch flow rules. + * Added support for match on metadata, VXLAN and MPLS encap/decap with flow + rules. + * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag to provide better + support for representors. + * Added support for meson build. + * Fixed build issue with PPC. + * Added support for BlueField VF. + * Added support for externally allocated static memory for DMA. + * **Updated Solarflare network PMD.** Updated the sfc_efx driver including the following changes: @@ -156,36 +178,38 @@ New Features * Added AVX2-based vectorized Rx handler. * Added VLAN and checksum offloads to the simple Tx handler. - * Added the count flow action. + * Added the "count" flow action. * Enabled the virtual address IOVA mode. -* **Updated failsafe driver.** +* **Updated the failsafe driver.** Updated the failsafe driver including the following changes: - * Support for Rx and Tx queues start and stop. - * Support for Rx and Tx queues deferred start. - * Support for runtime Rx and Tx queues setup. - * Support multicast MAC address set. + * Added support for Rx and Tx queues start and stop. + * Added support for Rx and Tx queues deferred start. + * Added support for runtime Rx and Tx queues setup. + * Added support multicast MAC address set. -* **Added a devarg to use PCAP interface physical MAC address.** - A new devarg ``phy_mac`` was introduced to allow users to use physical +* **Added a devarg to use a PCAP interface physical MAC address.** + + A new devarg ``phy_mac`` was introduced to allow users to use the physical MAC address of the selected PCAP interface. * **Added TAP Rx/Tx queues sharing with a secondary process.** - A secondary process can attach a TAP device created in the primary process, - probe the queues, and process Rx/Tx in a secondary process. + Added support to allow a secondary process to attach a TAP device created + in the primary process, probe the queues, and process Rx/Tx in a secondary + process. * **Added classification and metering support to SoftNIC PMD.** Added support for flow classification (rte_flow API), and metering and policing (rte_mtr API) to the SoftNIC PMD. -* **Added Crypto support to Softnic PMD.** +* **Added Crypto support to the Softnic PMD.** The Softnic is now capable of processing symmetric crypto workloads such - as cipher, cipher-authentication chaining, and aead encryption and + as cipher, cipher-authentication chaining, and AEAD encryption and decryption. This is achieved by calling DPDK Cryptodev APIs. * **Added cryptodev port to port library.** @@ -195,30 +219,30 @@ New Features * **Added symmetric cryptographic actions to the pipeline library.** - In the pipeline library an added symmetric crypto action parsing and action - handler are implemented. The action allows automatically preparing the crypto - operation with the rules specified such as algorithm, key, and IV, etc for - the cryptodev port to process. + In the pipeline library support was added for symmetric crypto action + parsing and an action handler was implemented. The action allows automatic + preparation of the crypto operation with the rules specified such as + algorithm, key, and IV, etc. for the cryptodev port to process. -* **Added support for GEN3 devices to Intel QAT driver .** +* **Updated the AESNI MB PMD.** - Added support for the third generation of Intel QuickAssist devices. + The AESNI MB PMD has been updated with additional support for the AES-GCM + algorithm. -* **Updated the QAT PMD.** +* **Added NXP CAAM JR PMD.** - The QAT PMD was updated with additional support for: + Added the new caam job ring driver for NXP platforms. See the + :doc:`../cryptodevs/caam_jr` guide for more details on this new driver. - * AES-CMAC algorithm. +* **Added support for GEN3 devices to Intel QAT driver.** -* **Updated the AESNI MB PMD.** + Added support for the third generation of Intel QuickAssist devices. - The AESNI MB PMD has been updated with additional support for AES-GCM - algorithm support. +* **Updated the QAT PMD.** -* **Added NXP CAAM JR PMD.** + The QAT PMD was updated with additional support for: - Added the new caam job ring driver for NXP platforms. See the - "NXP CAAM JOB RING (caam_jr)" document for more details on this new driver. + * The AES-CMAC algorithm. * **Added support for Dynamic Huffman Encoding to Intel QAT comp PMD.** @@ -227,7 +251,7 @@ New Features * **Added Event Ethernet Tx Adapter.** - Added event ethernet Tx adapter library that provides configuration and + Added event ethernet Tx adapter library that provides configuration and data path APIs for the ethernet transmit stage of an event driven packet processing application. These APIs abstract the implementation of the transmit stage and allow the application to use eventdev PMD support or @@ -243,23 +267,23 @@ New Features * **Added extendable bucket feature to hash library (rte_hash).** - This new “extendable bucket” feature provides 100% insertion guarantee to + This new "extendable bucket" feature provides 100% insertion guarantee to the capacity specified by the user by extending hash table with extra buckets when needed to accommodate the unlikely event of intensive hash - collisions. In addition, the internal hashing algorithm was changed to use + collisions. In addition, the internal hashing algorithm was changed to use partial-key hashing to improve memory efficiency and lookup performance. * **Added lock free reader/writer concurrency to hash library (rte_hash).** Lock free reader/writer concurrency prevents the readers from getting - blocked due to a pre-empted writer thread. This allows the hash library - to be used in scenarios where the writer thread runs on control plane. + blocked due to a preempted writer thread. This allows the hash library + to be used in scenarios where the writer thread runs on the control plane. -* **Added Traffic Pattern Aware Power Control Library** +* **Added Traffic Pattern Aware Power Control Library.** - Added an experimental library. This extend Power Library and provide - empty_poll APIs. This feature measure how many times empty_poll are - executed per core, use the number of empty polls as a hint for system + Added an experimental library that extends the Power Library and provides + empty_poll APIs. This feature measures how many times empty_polls are + executed per core and uses the number of empty polls as a hint for system power management. See the :doc:`../prog_guide/power_man` section of the DPDK Programmers @@ -275,27 +299,27 @@ New Features * **Added Telemetry API.** - Added the telemetry API which allows applications to transparently expose - their telemetry via a UNIX socket in JSON. The JSON can be consumed by any + Added a new telemetry API which allows applications to transparently expose + their telemetry in JSON via a UNIX socket. The JSON can be consumed by any Service Assurance agent, such as CollectD. * **Updated KNI kernel module, rte_kni library, and KNI sample application.** Updated the KNI kernel module with a new kernel module parameter, ``carrier=[on|off]`` to allow the user to control the default carrier - state of KNI kernel network interfaces. The default carrier state + state of the KNI kernel network interfaces. The default carrier state is now set to ``off``, so the interfaces cannot be used until the carrier state is set to ``on`` via ``rte_kni_update_link`` or by writing ``1`` to ``/sys/devices/virtual/net/<iface>/carrier``. In previous versions the default carrier state was left undefined. See :doc:`../prog_guide/kernel_nic_interface` for more information. - Added the new API function ``rte_kni_update_link`` to allow the user + Also added the new API function ``rte_kni_update_link()`` to allow the user to set the carrier state of the KNI kernel network interface. - Added a new command line flag ``-m`` to the KNI sample application to + Also added a new command line flag ``-m`` to the KNI sample application to monitor and automatically reflect the physical NIC carrier state to the - KNI kernel network interface with the new ``rte_kni_update_link`` API. + KNI kernel network interface with the new ``rte_kni_update_link()`` API. See :doc:`../sample_app_ug/kernel_nic_interface` for more information. * **Added ability to switch queue deferred start flag on testpmd app.** @@ -305,7 +329,7 @@ New Features the specified port. The port must be stopped before the command call in order to reconfigure queues. -* **Add a new sample for vDPA** +* **Add a new sample application for vDPA.** The vdpa sample application creates vhost-user sockets by using the vDPA backend. vDPA stands for vhost Data Path Acceleration which utilizes @@ -320,12 +344,12 @@ New Features computation to the NIST Cryptographic Algorithm Validation Program (CAVP) test vectors. -* **Allow unit test binary to take parameters from the environment** +* **Allow unit test binary to take parameters from the environment.** The unit test "test", or "dpdk-test", binary is often called from scripts, - which can make passing additional parameters, such as a coremask, to it more - awkward. Support has been added to the application to allow it to take - additional command-line parameter values from the "DPDK_TEST_PARAMS" + which can make passing additional parameters, such as a coremask, + difficult. Support has been added to the application to allow it to take + additional command-line parameter values from the ``DPDK_TEST_PARAMS`` environment variable to make this application easier to use. @@ -347,13 +371,14 @@ API Changes for any users of memseg-walk-related functions, as they will now have to skip externally allocated segments in most cases if the intent is to only iterate over internal DPDK memory. - ``socket_id`` parameter across the entire DPDK has gained additional meaning, - as some socket ID's will now be representing externally allocated memory. No - changes will be required for existing code as backwards compatibility will be - kept, and those who do not use this feature will not see these extra socket - ID's. Any new API's must not check socket ID parameters themselves, and must - instead leave it to the memory subsystem to decide whether socket ID is a - valid one. + + In addition the ``socket_id`` parameter across the entire DPDK has gained + additional meaning, as some socket ID's will now be representing externally + allocated memory. No changes will be required for existing code as backwards + compatibility will be kept, and those who do not use this feature will not + see these extra socket ID's. Any new API's must not check socket ID + parameters themselves, and must instead leave it to the memory subsystem to + decide whether socket ID is a valid one. * eal: The following devargs functions, which were deprecated in 18.05, were removed in 18.11: @@ -370,8 +395,8 @@ API Changes ``rte_dev_remove`` or ``rte_eal_hotplug_remove``. * eal: The scope of ``rte_eal_hotplug_add()``/``rte_dev_probe()`` - and ``rte_eal_hotplug_remove()``/``rte_dev_remove()`` is extended. - In multi-process model, they will guarantee that the device is + and ``rte_eal_hotplug_remove()``/``rte_dev_remove()`` has been extended. + In the multi-process model, they will guarantee that the device is attached or detached on all processes. * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()`` @@ -379,42 +404,43 @@ API Changes ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``. * ethdev: The deprecated functions attach/detach were removed in 18.11. - ``rte_eth_dev_attach`` can be replaced by ``RTE_ETH_FOREACH_MATCHING_DEV`` - and ``rte_dev_probe`` or ``rte_eal_hotplug_add``. - ``rte_eth_dev_detach`` can be replaced by - ``rte_dev_remove`` or ``rte_eal_hotplug_remove``. + ``rte_eth_dev_attach()`` can be replaced by ``RTE_ETH_FOREACH_MATCHING_DEV`` + and ``rte_dev_probe()`` or ``rte_eal_hotplug_add()``. + ``rte_eth_dev_detach()`` can be replaced by + ``rte_dev_remove()`` or ``rte_eal_hotplug_remove()``. * ethdev: A call to ``rte_eth_dev_release_port()`` has been added in ``rte_eth_dev_close()``. As a consequence, a closed port is freed and seen as invalid because of its state ``RTE_ETH_DEV_UNUSED``. - This new behaviour is enabled per driver for a migration period. + This new behavior is enabled per driver for a migration period. -* A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of - actions inside rte_eth_dev_start regarding MAC set. Some NICs do not +* A new device flag, ``RTE_ETH_DEV_NOLIVE_MAC_ADDR``, changes the order of + actions inside ``rte_eth_dev_start()`` regarding MAC set. Some NICs do not support MAC changes once the port has started and with this new device flag the MAC can be properly configured in any case. This is particularly important for bonding. -* The default behaviour of CRC strip offload changed. Without any specific Rx - offload flag, default behavior by PMD is now to strip CRC. - DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed. - To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx - offload. +* The default behavior of CRC strip offload has changed in this + release. Without any specific Rx offload flag, default behavior by a PMD is + now to strip CRC. ``DEV_RX_OFFLOAD_CRC_STRIP`` offload flag has been removed. + To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` + Rx offload. -* eventdev: Type of 2nd parameter to ``rte_event_eth_rx_adapter_caps_get()`` - has been changed from uint8_t to uint16_t. +* eventdev: The type of the second parameter to + ``rte_event_eth_rx_adapter_caps_get()`` has been changed from uint8_t to + uint16_t. * kni: By default, interface carrier status is ``off`` which means there won't - be any traffic. It can be set to ``on`` via ``rte_kni_update_link()`` API - or via ``sysfs`` interface: - ``echo 1 > /sys/class/net/vEth0/carrier``. + be any traffic. It can be set to ``on`` via ``rte_kni_update_link()`` API or + via ``sysfs`` interface: ``echo 1 > /sys/class/net/vEth0/carrier``. + Note interface should be ``up`` to be able to read/write sysfs interface. When KNI sample application is used, ``-m`` parameter can be used to automatically update the carrier status for the interface. -* kni: When ethtool support enabled (``CONFIG_RTE_KNI_KMOD_ETHTOOL=y``) - ethtool commands ``ETHTOOL_GSET & ETHTOOL_SSET`` are no more supported for the - kernels that has ``ETHTOOL_GLINKSETTINGS & ETHTOOL_SLINKSETTINGS`` support. +* kni: When ethtool support is enabled (``CONFIG_RTE_KNI_KMOD_ETHTOOL=y``) + ethtool commands ``ETHTOOL_GSET & ETHTOOL_SSET`` are no longer supported for + kernels that have ``ETHTOOL_GLINKSETTINGS & ETHTOOL_SLINKSETTINGS`` support. This means ``ethtool "-a|--show-pause", "-s|--change"`` won't work, and ``ethtool <iface>`` output will have less information. @@ -434,42 +460,30 @@ ABI Changes ========================================================= * eal: added ``legacy_mem`` and ``single_file_segments`` values to - ``rte_config`` structure on account of improving DPDK usability when - using either ``--legacy-mem`` or ``--single-file-segments`` flags. + ``rte_config`` structure on account of improving DPDK usability when + using either ``--legacy-mem`` or ``--single-file-segments`` flags. * eal: EAL library ABI version was changed due to previously announced work on - supporting external memory in DPDK: - - structure ``rte_memseg_list`` now has a new field indicating length - of memory addressed by the segment list - - structure ``rte_memseg_list`` now has a new flag indicating whether - the memseg list refers to external memory - - structure ``rte_malloc_heap`` now has a new field indicating socket - ID the malloc heap belongs to - - structure ``rte_mem_config`` has had its ``malloc_heaps`` array - resized from ``RTE_MAX_NUMA_NODES`` to ``RTE_MAX_HEAPS`` value - - structure ``rte_malloc_heap`` now has a ``heap_name`` member - - structure ``rte_eal_memconfig`` has been extended to contain next - socket ID for externally allocated segments - -* eal: Added ``dma_maskbits`` to ``rte_mem_config`` for keeping more restricted - dma mask based on devices addressing limitations. + supporting external memory in DPDK: -* eal: The structure ``rte_device`` got a new field to reference a ``rte_bus``. - It is changing the size of the ``struct rte_device`` and the inherited - device structures of all buses. + - Structure ``rte_memseg_list`` now has a new field indicating length + of memory addressed by the segment list + - Structure ``rte_memseg_list`` now has a new flag indicating whether + the memseg list refers to external memory + - Structure ``rte_malloc_heap`` now has a new field indicating socket + ID the malloc heap belongs to + - Structure ``rte_mem_config`` has had its ``malloc_heaps`` array + resized from ``RTE_MAX_NUMA_NODES`` to ``RTE_MAX_HEAPS`` value + - Structure ``rte_malloc_heap`` now has a ``heap_name`` member + - Structure ``rte_eal_memconfig`` has been extended to contain next + socket ID for externally allocated segments +* eal: Added ``dma_maskbits`` to ``rte_mem_config`` for keeping the most + restrictive DMA mask based on the devices addressing limitations. -Removed Items -------------- - -.. This section should contain removed items in this release. Sample format: - - * Add a short 1-2 sentence description of the removed item - in the past tense. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= +* eal: The structure ``rte_device`` has a new field to reference a + ``rte_bus``. It thus changes the size of the ``struct rte_device`` and the + inherited device structures of all buses. Shared Library Versions @@ -561,11 +575,24 @@ Known Issues Also, make sure to start the actual text at the margin. ========================================================= -* When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated - driver; the Linux netvsc device must be brought up before the netvsc device is - unbound and passed to the DPDK. +* When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 + bifurcated driver the Linux netvsc device must be brought up before the + netvsc device is unbound and passed to the DPDK. + +* IBM Power8 is not supported in this release of DPDK. IBM Power9 is + supported. -* IBM Power8 is not supported by this release of DPDK. IBM Power9 is supported. +* ``AVX-512`` support has been disabled for ``GCC`` builds [1] because of a + crash [2]. This can affect ``native`` machine type build targets on the + platforms that support ``AVX512F`` like ``Intel Skylake`` processors, and + can cause a possible performance drop. The immediate workaround is to use + ``clang`` compiler on these platforms. The issue has been identified as a + GCC defect and reported to the GCC community [3]. Further actions will be + taken based on the GCC defect result. + + - [1]: Commit 8d07c82b239f ("mk: disable gcc AVX512F support") + - [2]: https://bugs.dpdk.org/show_bug.cgi?id=97 + - [3]: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88096 Tested Platforms @@ -586,3 +613,251 @@ Tested Platforms This section is a comment. Do not overwrite or remove it. Also, make sure to start the actual text at the margin. ========================================================= + +* Intel(R) platforms with Intel(R) NICs combinations + + * CPU + + * Intel(R) Atom(TM) CPU C3758 @ 2.20GHz + * Intel(R) Xeon(R) CPU D-1541 @ 2.10GHz + * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz + * Intel(R) Xeon(R) CPU E5-2699 v3 @ 2.30GHz + * Intel(R) Xeon(R) CPU E5-2699 v4 @ 2.20GHz + * Intel(R) Xeon(R) Platinum 8180 CPU @ 2.50GHz + + * OS: + + * CentOS 7.5 + * Fedora 25 + * Fedora 28 + * FreeBSD 11.2 + * Red Hat Enterprise Linux Server release 7.5 + * Open SUSE 15 + * Wind River Linux 8 + * Ubuntu 14.04 + * Ubuntu 16.04 + * Ubuntu 16.10 + * Ubuntu 17.10 + * Ubuntu 18.04 + + * NICs: + + * Intel(R) 82599ES 10 Gigabit Ethernet Controller + + * Firmware version: 0x61bf0001 + * Device id (pf/vf): 8086:10fb / 8086:10ed + * Driver version: 5.2.3 (ixgbe) + + * Intel(R) Corporation Ethernet Connection X552/X557-AT 10GBASE-T + + * Firmware version: 0x800003e7 + * Device id (pf/vf): 8086:15ad / 8086:15a8 + * Driver version: 4.4.6 (ixgbe) + + * Intel(R) Ethernet Converged Network Adapter X710-DA4 (4x10G) + + * Firmware version: 6.01 0x80003221 + * Device id (pf/vf): 8086:1572 / 8086:154c + * Driver version: 2.4.6 (i40e) + + * Intel(R) Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G) + + * Firmware version: 3.33 0x80000fd5 0.0.0 + * Device id (pf/vf): 8086:37d0 / 8086:37cd + * Driver version: 2.4.6 (i40e) + + * Intel(R) Ethernet Converged Network Adapter XXV710-DA2 (2x25G) + + * Firmware version: 6.01 0x80003221 + * Device id (pf/vf): 8086:158b / 8086:154c + * Driver version: 2.4.6 (i40e) + + * Intel(R) Ethernet Converged Network Adapter XL710-QDA2 (2X40G) + + * Firmware version: 6.01 0x8000321c + * Device id (pf/vf): 8086:1583 / 8086:154c + * Driver version: 2.4.6 (i40e) + + * Intel(R) Corporation I350 Gigabit Network Connection + + * Firmware version: 1.63, 0x80000dda + * Device id (pf/vf): 8086:1521 / 8086:1520 + * Driver version: 5.4.0-k (igb) + +* Intel(R) platforms with Mellanox(R) NICs combinations + + * CPU: + + * Intel(R) Xeon(R) Gold 6154 CPU @ 3.00GHz + * Intel(R) Xeon(R) CPU E5-2697A v4 @ 2.60GHz + * Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz + * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz + * Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz + * Intel(R) Xeon(R) CPU E5-2640 @ 2.50GHz + * Intel(R) Xeon(R) CPU E5-2620 v4 @ 2.10GHz + + * OS: + + * Red Hat Enterprise Linux Server release 7.6 (Maipo) + * Red Hat Enterprise Linux Server release 7.5 (Maipo) + * Red Hat Enterprise Linux Server release 7.4 (Maipo) + * Red Hat Enterprise Linux Server release 7.3 (Maipo) + * Red Hat Enterprise Linux Server release 7.2 (Maipo) + * Ubuntu 18.10 + * Ubuntu 18.04 + * Ubuntu 17.10 + * Ubuntu 16.04 + * SUSE Linux Enterprise Server 15 + + * MLNX_OFED: 4.4-2.0.1.0 + * MLNX_OFED: 4.5-0.3.1.0 + + * NICs: + + * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2x40G) + + * Host interface: PCI Express 3.0 x8 + * Device ID: 15b3:1007 + * Firmware version: 2.42.5000 + + * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G) + + * Host interface: PCI Express 3.0 x8 + * Device ID: 15b3:1013 + * Firmware version: 12.23.8022 and above + + * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G) + + * Host interface: PCI Express 3.0 x8 + * Device ID: 15b3:1013 + * Firmware version: 12.23.8022 and above + + * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G) + + * Host interface: PCI Express 3.0 x8 + * Device ID: 15b3:1013 + * Firmware version: 12.23.8022 and above + + * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G) + + * Host interface: PCI Express 3.0 x8 + * Device ID: 15b3:1013 + * Firmware version: 12.23.8022 and above + + * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G) + + * Host interface: PCI Express 3.0 x8 + * Device ID: 15b3:1013 + * Firmware version: 12.23.8022 and above + + * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G) + + * Host interface: PCI Express 3.0 x16 + * Device ID: 15b3:1013 + * Firmware version: 12.23.8022 and above + + * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G) + + * Host interface: PCI Express 3.0 x8 + * Device ID: 15b3:1013 + * Firmware version: 12.23.8022 and above + + * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G) + + * Host interface: PCI Express 3.0 x8 + * Device ID: 15b3:1013 + * Firmware version: 12.23.8022 and above + + * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT (2x50G) + + * Host interface: PCI Express 3.0 x16 + * Device ID: 15b3:1013 + * Firmware version: 12.23.8022 and above + * Firmware version: 12.23.8022 and above + + * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G) + + * Host interface: PCI Express 3.0 x16 + * Device ID: 15b3:1013 + * Firmware version: 12.23.8022 and above + + * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G) + + * Host interface: PCI Express 3.0 x16 + * Device ID: 15b3:1013 + * Firmware version: 12.23.8022 and above + + * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G) + + * Host interface: PCI Express 3.0 x8 + * Device ID: 15b3:1015 + * Firmware version: 14.23.8022 and above + + * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G) + + * Host interface: PCI Express 3.0 x8 + * Device ID: 15b3:1015 + * Firmware version: 14.23.8022 and above + + * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G) + + * Host interface: PCI Express 3.0 x16 + * Device ID: 15b3:1017 + * Firmware version: 16.23.8022 and above + + * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G) + + * Host interface: PCI Express 4.0 x16 + * Device ID: 15b3:1019 + * Firmware version: 16.23.8022 and above + +* ARM platforms with Mellanox(R) NICs combinations + + * CPU: + + * Qualcomm ARM 1.1 2500MHz + + * OS: + + * Red Hat Enterprise Linux Server release 7.5 (Maipo) + + * NICs: + + * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G) + + * Host interface: PCI Express 3.0 x8 + * Device ID: 15b3:1015 + * Firmware version: 14.24.0220 + + * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G) + + * Host interface: PCI Express 3.0 x16 + * Device ID: 15b3:1017 + * Firmware version: 16.24.0220 + +* Mellanox(R) BlueField SmartNIC + + * Mellanox(R) BlueField SmartNIC MT416842 (2x25G) + + * Host interface: PCI Express 3.0 x16 + * Device ID: 15b3:a2d2 + * Firmware version: 18.24.0246 + + * SoC ARM cores running OS: + + * CentOS Linux release 7.4.1708 (AltArch) + * MLNX_OFED 4.4-2.5.3.0 + + * DPDK application running on ARM cores inside SmartNIC + +* ARM SoC combinations from NXP (with integrated NICs) + + * SoC: + + * NXP/Freescale QorIQ LS1046A with ARM Cortex A72 + * NXP/Freescale QorIQ LS2088A with ARM Cortex A72 + + * OS: + + * Ubuntu 18.04.1 LTS with NXP QorIQ LSDK 1809 support packages + * Ubuntu 16.04.3 LTS with NXP QorIQ LSDK 1803 support packages |