path: root/doc
diff options
authorDekel Peled <>2018-10-21 17:22:48 +0300
committerFerruh Yigit <>2018-10-26 22:14:05 +0200
commitc18feafa193c0d816eae3a4861b1f9016cf236d7 (patch)
treee05d57a5ca923ec4719b03cfc22225237ca3993a /doc
parent839b20be0e9bbf5db119762c098ea865fafb9075 (diff)
app/testpmd: support metadata as flow rule item
As described in [1], this series adds option to set metadata value as match pattern when creating a new flow rule. This patch introduces additional options in testpmd commands: - New item type "meta" "data" - New per-port offload flag "match_metadata". It also adds commands to configure the tx_metadata value to use: - New 'config' command takes a 32 bit value and stores it per port: port config <port_id> tx_metadata <value> testpmd will add to any Tx packet sent from this port the metadata value, and set ol_flags accordingly. - A matching 'show' command is added to read the configured value: port config <port_id> tx_metadata <value> [1] "ethdev: support metadata as flow rule criteria" Signed-off-by: Dekel Peled <> Reviewed-by: Ferruh Yigit <>
Diffstat (limited to 'doc')
1 files changed, 20 insertions, 1 deletions
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index d712bb6..3854271 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -423,6 +423,12 @@ List port level and all queue level Tx offloading configuration::
testpmd> show port (port_id) tx_offload configuration
+show tx metadata setting
+Show Tx metadata value set for a specific port::
+ testpmd> show port (port_id) tx_metadata
Configuration Functions
@@ -1532,7 +1538,8 @@ Enable or disable a per port Tx offloading on all Tx queues of a port::
sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
- mt_lockfree, multi_segs, mbuf_fast_free, security
+ mt_lockfree, multi_segs, mbuf_fast_free, security,
+ match_metadata
This command should be run when the port is stopped, or else it will fail.
@@ -2028,6 +2035,14 @@ port config udp_tunnel_port
Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve (udp_port)
+port config tx_metadata
+Set Tx metadata value per port.
+testpmd will add this value to any Tx packet sent from this port::
+ testpmd> port config (port_id) tx_metadata (value)
Link Bonding Functions
@@ -3595,6 +3610,10 @@ This section lists supported pattern items and their attributes, if any.
- ``tla {MAC-48}``: target Ethernet LLA.
+- ``meta``: match application specific metadata.
+ - ``data {unsigned}``: metadata value.
Actions list