doc: update release notes for 18.11

Fix grammar, spelling and formatting of DPDK 18.11 release notes.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
This commit is contained in:
John McNamara 2018-11-26 10:51:01 +00:00 committed by Thomas Monjalon
parent 43d162bc16
commit d514a53118

View File

@ -48,7 +48,7 @@ New Features
- eventdev (lib, PMDs) - eventdev (lib, PMDs)
- etc - etc
* Other libs * Other libs
* Apps, Examples, Tools (if significative) * Apps, Examples, Tools (if significant)
This section is a comment. Do not overwrite or remove it. This section is a comment. Do not overwrite or remove it.
Also, make sure to start the actual text at the margin. 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.** * **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 that was created outside of DPDK's own page allocator, and using that
memory natively with any other DPDK library or data structure. 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, Some devices can have addressing limitations so a new function,
``rte_mem_check_dma_mask``, has been added for checking allocated memory is ``rte_mem_check_dma_mask()``, has been added for checking that allocated
not out of the device range. Because now memory can be dynamically allocated memory is not out of the device range. Since memory can now be allocated
after initialization, a dma mask is kept and any new allocated memory will be dynamically after initialization, a DMA mask is stored and any new allocated
checked out against that dma mask and rejected if out of range. If more than memory will be checked against it and rejected if it is out of range. If
one device has addressing limitations, the dma mask is the more restricted one. 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 Added changes to decrease latency for architectures using the C11 memory
version of the ring library. model version of the ring library.
On Cavium ThunderX2 platform, the changes decreased latency by 27~29% On Cavium ThunderX2 platform, the changes decreased latency by 27-29%
and 3~15% for MPMC and SPSC cases respectively (with 2 lcores). The and 3-15% for MPMC and SPSC cases respectively (with 2 lcores). The
real improvements may vary with the number of contending lcores and 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.** * **Added hot-unplug handle mechanism.**
``rte_dev_hotplug_handle_enable`` and ``rte_dev_hotplug_handle_disable`` are Added ``rte_dev_hotplug_handle_enable()`` and
for enabling or disabling hotplug handle mechanism. ``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 Added support for hotplug and hot-unplug in a multiprocessing scenario. Any
scenario. Any ethdev devices created in the primary process will be regarded ethdev devices created in the primary process will be regarded as shared and
as shared and will be available for all DPDK processes. Synchronization will be available for all DPDK processes. Synchronization between processes
between processes will be done using DPDK IPC. will be done using DPDK IPC.
* **Added new Flow API actions to rewrite fields in packet headers.** * **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 Added new Flow API action to swap the source and destination MAC
addresses in the outermost Ethernet header. 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. * Match items: destination MAC address.
* Action items: push/pop/rewrite vlan header, * Action items: push/pop/rewrite vlan header,
@ -116,6 +119,7 @@ New Features
swap MAC addresses in outermost Ethernet header. swap MAC addresses in outermost Ethernet header.
* **Added a devarg to use the latest supported vector path in i40e.** * **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 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 choose the latest vector path that the platform supported. For example, users
can use AVX2 vector path on BDW/HSW to get better performance. can use AVX2 vector path on BDW/HSW to get better performance.
@ -133,13 +137,13 @@ New Features
* **Added NXP ENETC PMD.** * **Added NXP ENETC PMD.**
Added the new enetc driver for NXP enetc platform. See the Added the new enetc driver for the NXP enetc platform. See the
"ENETC Poll Mode Driver" document for more details on this new driver. :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 Ethernet poll mode driver for Aquantia aQtion family of 10G devices.**
Added the new ``atlantic`` ethernet poll mode driver for Aquantia XGBE 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. driver.
* **Updated mlx5 driver.** * **Updated mlx5 driver.**
@ -147,17 +151,18 @@ New Features
Updated the mlx5 driver including the following changes: Updated the mlx5 driver including the following changes:
* Improved security of PMD to prevent the NIC from getting stuck when * Improved security of PMD to prevent the NIC from getting stuck when
application misbehaves. the application misbehaves.
* reworked flow engine to supported e-switch flow rules (transfer attribute). * Reworked flow engine to supported e-switch flow rules (transfer attribute).
* Supported header re-write(L2-L4), VXLAN encap/decap, count ,match * 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. on TCP flags and multiple flow groups with e-switch flow rules.
* Supported match on medatada, VXLAN and MPLS encap/decap with flow rules. * Added support for match on metadata, VXLAN and MPLS encap/decap with flow
* Supported RTE_ETH_DEV_CLOSE_REMOVE flag to provide better support for rules.
representors. * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag to provide better
* Supported meson build. support for representors.
* Added support for meson build.
* Fixed build issue with PPC. * Fixed build issue with PPC.
* Supported BlueField VF. * Added support for BlueField VF.
* Supported externally allocated static memory for DMA. * Added support for externally allocated static memory for DMA.
* **Updated Solarflare network PMD.** * **Updated Solarflare network PMD.**
@ -173,36 +178,38 @@ New Features
* Added AVX2-based vectorized Rx handler. * Added AVX2-based vectorized Rx handler.
* Added VLAN and checksum offloads to the simple Tx 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. * Enabled the virtual address IOVA mode.
* **Updated failsafe driver.** * **Updated the failsafe driver.**
Updated the failsafe driver including the following changes: Updated the failsafe driver including the following changes:
* Support for Rx and Tx queues start and stop. * Added support for Rx and Tx queues start and stop.
* Support for Rx and Tx queues deferred start. * Added support for Rx and Tx queues deferred start.
* Support for runtime Rx and Tx queues setup. * Added support for runtime Rx and Tx queues setup.
* Support multicast MAC address set. * Added support multicast MAC address set.
* **Added a devarg to use PCAP interface physical MAC address.** * **Added a devarg to use a PCAP interface physical MAC address.**
A new devarg ``phy_mac`` was introduced to allow users to use physical
A new devarg ``phy_mac`` was introduced to allow users to use the physical
MAC address of the selected PCAP interface. MAC address of the selected PCAP interface.
* **Added TAP Rx/Tx queues sharing with a secondary process.** * **Added TAP Rx/Tx queues sharing with a secondary process.**
A secondary process can attach a TAP device created in the primary process, Added support to allow a secondary process to attach a TAP device created
probe the queues, and process Rx/Tx in a secondary process. in the primary process, probe the queues, and process Rx/Tx in a secondary
process.
* **Added classification and metering support to SoftNIC PMD.** * **Added classification and metering support to SoftNIC PMD.**
Added support for flow classification (rte_flow API), and metering and Added support for flow classification (rte_flow API), and metering and
policing (rte_mtr API) to the SoftNIC PMD. 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 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. decryption. This is achieved by calling DPDK Cryptodev APIs.
* **Added cryptodev port to port library.** * **Added cryptodev port to port library.**
@ -212,12 +219,22 @@ New Features
* **Added symmetric cryptographic actions to the pipeline library.** * **Added symmetric cryptographic actions to the pipeline library.**
In the pipeline library an added symmetric crypto action parsing and action In the pipeline library support was added for symmetric crypto action
handler are implemented. The action allows automatically preparing the crypto parsing and an action handler was implemented. The action allows automatic
operation with the rules specified such as algorithm, key, and IV, etc for preparation of the crypto operation with the rules specified such as
the cryptodev port to process. 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.**
The AESNI MB PMD has been updated with additional support for the AES-GCM
algorithm.
* **Added NXP CAAM JR PMD.**
Added the new caam job ring driver for NXP platforms. See the
:doc:`../cryptodevs/caam_jr` guide for more details on this new driver.
* **Added support for GEN3 devices to Intel QAT driver.**
Added support for the third generation of Intel QuickAssist devices. Added support for the third generation of Intel QuickAssist devices.
@ -225,17 +242,7 @@ New Features
The QAT PMD was updated with additional support for: The QAT PMD was updated with additional support for:
* AES-CMAC algorithm. * The AES-CMAC algorithm.
* **Updated the AESNI MB PMD.**
The AESNI MB PMD has been updated with additional support for AES-GCM
algorithm support.
* **Added NXP CAAM JR PMD.**
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.
* **Added support for Dynamic Huffman Encoding to Intel QAT comp PMD.** * **Added support for Dynamic Huffman Encoding to Intel QAT comp PMD.**
@ -244,7 +251,7 @@ New Features
* **Added Event Ethernet Tx Adapter.** * **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 data path APIs for the ethernet transmit stage of an event driven packet
processing application. These APIs abstract the implementation of the processing application. These APIs abstract the implementation of the
transmit stage and allow the application to use eventdev PMD support or transmit stage and allow the application to use eventdev PMD support or
@ -260,23 +267,23 @@ New Features
* **Added extendable bucket feature to hash library (rte_hash).** * **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 the capacity specified by the user by extending hash table with extra
buckets when needed to accommodate the unlikely event of intensive hash 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. partial-key hashing to improve memory efficiency and lookup performance.
* **Added lock free reader/writer concurrency to hash library (rte_hash).** * **Added lock free reader/writer concurrency to hash library (rte_hash).**
Lock free reader/writer concurrency prevents the readers from getting Lock free reader/writer concurrency prevents the readers from getting
blocked due to a pre-empted writer thread. This allows the hash library blocked due to a preempted writer thread. This allows the hash library
to be used in scenarios where the writer thread runs on control plane. 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 Added an experimental library that extends the Power Library and provides
empty_poll APIs. This feature measure how many times empty_poll are empty_poll APIs. This feature measures how many times empty_polls are
executed per core, use the number of empty polls as a hint for system executed per core and uses the number of empty polls as a hint for system
power management. power management.
See the :doc:`../prog_guide/power_man` section of the DPDK Programmers See the :doc:`../prog_guide/power_man` section of the DPDK Programmers
@ -292,27 +299,27 @@ New Features
* **Added Telemetry API.** * **Added Telemetry API.**
Added the telemetry API which allows applications to transparently expose Added a new telemetry API which allows applications to transparently expose
their telemetry via a UNIX socket in JSON. The JSON can be consumed by any their telemetry in JSON via a UNIX socket. The JSON can be consumed by any
Service Assurance agent, such as CollectD. Service Assurance agent, such as CollectD.
* **Updated KNI kernel module, rte_kni library, and KNI sample application.** * **Updated KNI kernel module, rte_kni library, and KNI sample application.**
Updated the KNI kernel module with a new kernel module parameter, Updated the KNI kernel module with a new kernel module parameter,
``carrier=[on|off]`` to allow the user to control the default carrier ``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 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 carrier state is set to ``on`` via ``rte_kni_update_link`` or
by writing ``1`` to ``/sys/devices/virtual/net/<iface>/carrier``. by writing ``1`` to ``/sys/devices/virtual/net/<iface>/carrier``.
In previous versions the default carrier state was left undefined. In previous versions the default carrier state was left undefined.
See :doc:`../prog_guide/kernel_nic_interface` for more information. 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. 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 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. See :doc:`../sample_app_ug/kernel_nic_interface` for more information.
* **Added ability to switch queue deferred start flag on testpmd app.** * **Added ability to switch queue deferred start flag on testpmd app.**
@ -322,7 +329,7 @@ New Features
the specified port. The port must be stopped before the command call in order the specified port. The port must be stopped before the command call in order
to reconfigure queues. 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 The vdpa sample application creates vhost-user sockets by using the
vDPA backend. vDPA stands for vhost Data Path Acceleration which utilizes vDPA backend. vDPA stands for vhost Data Path Acceleration which utilizes
@ -337,12 +344,12 @@ New Features
computation to the NIST Cryptographic Algorithm Validation Program (CAVP) computation to the NIST Cryptographic Algorithm Validation Program (CAVP)
test vectors. 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, 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 which can make passing additional parameters, such as a coremask,
awkward. Support has been added to the application to allow it to take difficult. Support has been added to the application to allow it to take
additional command-line parameter values from the "DPDK_TEST_PARAMS" additional command-line parameter values from the ``DPDK_TEST_PARAMS``
environment variable to make this application easier to use. environment variable to make this application easier to use.
@ -364,13 +371,14 @@ API Changes
for any users of memseg-walk-related functions, as they will now have to skip 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 externally allocated segments in most cases if the intent is to only iterate
over internal DPDK memory. 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 In addition the ``socket_id`` parameter across the entire DPDK has gained
changes will be required for existing code as backwards compatibility will be additional meaning, as some socket ID's will now be representing externally
kept, and those who do not use this feature will not see these extra socket allocated memory. No changes will be required for existing code as backwards
ID's. Any new API's must not check socket ID parameters themselves, and must compatibility will be kept, and those who do not use this feature will not
instead leave it to the memory subsystem to decide whether socket ID is a see these extra socket ID's. Any new API's must not check socket ID
valid one. 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, * eal: The following devargs functions, which were deprecated in 18.05,
were removed in 18.11: were removed in 18.11:
@ -387,8 +395,8 @@ API Changes
``rte_dev_remove`` or ``rte_eal_hotplug_remove``. ``rte_dev_remove`` or ``rte_eal_hotplug_remove``.
* eal: The scope of ``rte_eal_hotplug_add()``/``rte_dev_probe()`` * eal: The scope of ``rte_eal_hotplug_add()``/``rte_dev_probe()``
and ``rte_eal_hotplug_remove()``/``rte_dev_remove()`` is extended. and ``rte_eal_hotplug_remove()``/``rte_dev_remove()`` has been extended.
In multi-process model, they will guarantee that the device is In the multi-process model, they will guarantee that the device is
attached or detached on all processes. attached or detached on all processes.
* mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()`` * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
@ -396,42 +404,43 @@ API Changes
``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``. ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
* ethdev: The deprecated functions attach/detach were removed in 18.11. * ethdev: The deprecated functions attach/detach were removed in 18.11.
``rte_eth_dev_attach`` can be replaced by ``RTE_ETH_FOREACH_MATCHING_DEV`` ``rte_eth_dev_attach()`` can be replaced by ``RTE_ETH_FOREACH_MATCHING_DEV``
and ``rte_dev_probe`` or ``rte_eal_hotplug_add``. and ``rte_dev_probe()`` or ``rte_eal_hotplug_add()``.
``rte_eth_dev_detach`` can be replaced by ``rte_eth_dev_detach()`` can be replaced by
``rte_dev_remove`` or ``rte_eal_hotplug_remove``. ``rte_dev_remove()`` or ``rte_eal_hotplug_remove()``.
* ethdev: A call to ``rte_eth_dev_release_port()`` has been added in * 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 ``rte_eth_dev_close()``. As a consequence, a closed port is freed
and seen as invalid because of its state ``RTE_ETH_DEV_UNUSED``. 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 * 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 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 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 flag the MAC can be properly configured in any case. This is particularly
important for bonding. important for bonding.
* The default behaviour of CRC strip offload changed. Without any specific Rx * The default behavior of CRC strip offload has changed in this
offload flag, default behavior by PMD is now to strip CRC. release. Without any specific Rx offload flag, default behavior by a PMD is
DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed. 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 To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC``
offload. Rx offload.
* eventdev: Type of 2nd parameter to ``rte_event_eth_rx_adapter_caps_get()`` * eventdev: The type of the second parameter to
has been changed from uint8_t to uint16_t. ``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 * 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 be any traffic. It can be set to ``on`` via ``rte_kni_update_link()`` API or
or via ``sysfs`` interface: via ``sysfs`` interface: ``echo 1 > /sys/class/net/vEth0/carrier``.
``echo 1 > /sys/class/net/vEth0/carrier``.
Note interface should be ``up`` to be able to read/write sysfs interface. 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 When KNI sample application is used, ``-m`` parameter can be used to
automatically update the carrier status for the interface. automatically update the carrier status for the interface.
* kni: When ethtool support enabled (``CONFIG_RTE_KNI_KMOD_ETHTOOL=y``) * kni: When ethtool support is enabled (``CONFIG_RTE_KNI_KMOD_ETHTOOL=y``)
ethtool commands ``ETHTOOL_GSET & ETHTOOL_SSET`` are no more supported for the ethtool commands ``ETHTOOL_GSET & ETHTOOL_SSET`` are no longer supported for
kernels that has ``ETHTOOL_GLINKSETTINGS & ETHTOOL_SLINKSETTINGS`` support. kernels that have ``ETHTOOL_GLINKSETTINGS & ETHTOOL_SLINKSETTINGS`` support.
This means ``ethtool "-a|--show-pause", "-s|--change"`` won't work, and This means ``ethtool "-a|--show-pause", "-s|--change"`` won't work, and
``ethtool <iface>`` output will have less information. ``ethtool <iface>`` output will have less information.
@ -451,42 +460,30 @@ ABI Changes
========================================================= =========================================================
* eal: added ``legacy_mem`` and ``single_file_segments`` values to * eal: added ``legacy_mem`` and ``single_file_segments`` values to
``rte_config`` structure on account of improving DPDK usability when ``rte_config`` structure on account of improving DPDK usability when
using either ``--legacy-mem`` or ``--single-file-segments`` flags. using either ``--legacy-mem`` or ``--single-file-segments`` flags.
* eal: EAL library ABI version was changed due to previously announced work on * eal: EAL library ABI version was changed due to previously announced work on
supporting external memory in DPDK: 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 - Structure ``rte_memseg_list`` now has a new field indicating length
dma mask based on devices addressing limitations. 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: The structure ``rte_device`` got a new field to reference a ``rte_bus``. * eal: Added ``dma_maskbits`` to ``rte_mem_config`` for keeping the most
It is changing the size of the ``struct rte_device`` and the inherited restrictive DMA mask based on the devices addressing limitations.
device structures of all buses.
* eal: The structure ``rte_device`` has a new field to reference a
Removed Items ``rte_bus``. It thus changes the size of the ``struct rte_device`` and the
------------- inherited device structures of all buses.
.. 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.
=========================================================
Shared Library Versions Shared Library Versions
@ -578,22 +575,24 @@ Known Issues
Also, make sure to start the actual text at the margin. 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 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5
driver; the Linux netvsc device must be brought up before the netvsc device is bifurcated driver the Linux netvsc device must be brought up before the
unbound and passed to the DPDK. netvsc device is unbound and passed to the DPDK.
* IBM Power8 is not supported by this release of DPDK. IBM Power9 is supported. * IBM Power8 is not supported in this release of DPDK. IBM Power9 is
supported.
* ``AVX-512`` support has been disabled for ``GCC`` builds [1] because of a crash [2]. * ``AVX-512`` support has been disabled for ``GCC`` builds [1] because of a
This can affect ``native`` machine type build targets on the platforms that support crash [2]. This can affect ``native`` machine type build targets on the
``AVX512F`` like ``Intel Skylake`` processors, and can cause a possible performance drop. platforms that support ``AVX512F`` like ``Intel Skylake`` processors, and
The immediate workaround is to use ``clang`` compiler on these platforms. can cause a possible performance drop. The immediate workaround is to use
Issue has been identified as a GCC defect and reported to GCC community [3]. Further ``clang`` compiler on these platforms. The issue has been identified as a
actions will be taken based on the GCC defect result. 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") - [1]: Commit 8d07c82b239f ("mk: disable gcc AVX512F support")
[2]: https://bugs.dpdk.org/show_bug.cgi?id=97 - [2]: https://bugs.dpdk.org/show_bug.cgi?id=97
[3]: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88096 - [3]: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88096
Tested Platforms Tested Platforms
@ -661,7 +660,7 @@ Tested Platforms
* Device id (pf/vf): 8086:1572 / 8086:154c * Device id (pf/vf): 8086:1572 / 8086:154c
* Driver version: 2.4.6 (i40e) * Driver version: 2.4.6 (i40e)
* Intel Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G) * Intel(R) Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
* Firmware version: 3.33 0x80000fd5 0.0.0 * Firmware version: 3.33 0x80000fd5 0.0.0
* Device id (pf/vf): 8086:37d0 / 8086:37cd * Device id (pf/vf): 8086:37d0 / 8086:37cd
@ -839,11 +838,13 @@ Tested Platforms
* Mellanox(R) BlueField SmartNIC * Mellanox(R) BlueField SmartNIC
* Mellanox(R) BlueField SmartNIC MT416842 (2x25G) * Mellanox(R) BlueField SmartNIC MT416842 (2x25G)
* Host interface: PCI Express 3.0 x16 * Host interface: PCI Express 3.0 x16
* Device ID: 15b3:a2d2 * Device ID: 15b3:a2d2
* Firmware version: 18.24.0246 * Firmware version: 18.24.0246
* SoC ARM cores running OS: * SoC ARM cores running OS:
* CentOS Linux release 7.4.1708 (AltArch) * CentOS Linux release 7.4.1708 (AltArch)
* MLNX_OFED 4.4-2.5.3.0 * MLNX_OFED 4.4-2.5.3.0