app/testpmd: use Tx preparation in txonly engine
PATCH 1/1 app/testpmd: use Tx preparation in txonly engine
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
We can reproduce this issue by these steps list blow on ICE and I40e.
./x86_64-native-linuxapp-gcc/app/dpdk-testpmd -c 0xf -n 4 -- -i --tx-offloads=0x00008000
testpmd>set txpkts 64,128,256,512,64,128,256,512,512 testpmd>set burst 1
testpmd>start tx_first 1
This commit will use Tx preparation API in txonly forwarding engine.
--- app/test-pmd/txonly.c | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-)
app/test-pmd/txonly.c +12 -1
@@ -339,6 +339,7 @@ pkt_burst_transmit(struct fwd_stream *fs)struct rte_ether_hdr eth_hdr;uint16_t nb_tx;uint16_t nb_pkt; +uint16_t nb_prep;uint16_t vlan_tci, vlan_tci_outer;uint64_t ol_flags =0 ;uint64_t tx_offloads;
@@ -396,7 +397,17 @@ pkt_burst_transmit(struct fwd_stream *fs)if (nb_pkt ==0 )return false; - nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_pkt); + nb_prep =rte_eth_tx_prepare (fs->tx_port, fs->tx_queue, + pkts_burst, nb_pkt); +if (unlikely (nb_prep != nb_pkt)) { +fprintf (stderr, +"Preparing packet burst to transmit failed: %s\n" , +rte_strerror (rte_errno)); + fs->fwd_dropped += (nb_pkt - nb_prep); +rte_pktmbuf_free_bulk (&pkts_burst[nb_prep], nb_pkt - nb_prep); + } + + nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_prep);if (txonly_multi_flow)RTE_PER_LCORE (_src_port_var) -= nb_pkt - nb_tx;
Signature · 1 line
2.34.1
app/test-pmd/txonly.c pkt_burst_transmit(struct fwd_stream *fs) · line 405
Quoted 8 lines · On Wed, 3 Jan 2024 09:29:12 +0800 Kaiwen Deng <[email protected]> wrote:
app/test-pmd/txonly.c +6
-1- nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_pkt); + nb_prep =rte_eth_tx_prepare (fs->tx_port, fs->tx_queue, + pkts_burst, nb_pkt); +if (unlikely (nb_prep != nb_pkt)) { +fprintf (stderr, +"Preparing packet burst to transmit failed: %s\n" , +rte_strerror (rte_errno));
The main failure likely is mismatched offload flags, so it might be helpful to print offload flags of that mbuf.
app/test-pmd/txonly.c pkt_burst_transmit(struct fwd_stream *fs) · line 406
Quoted 1 line
app/test-pmd/txonly.c +1
-0+ fs->fwd_dropped += (nb_pkt - nb_prep);
Nit: no parenthesis needed here.
Quoted 5 lines
app/test-pmd/txonly.c +4
-0+rte_pktmbuf_free_bulk (&pkts_burst[nb_prep], nb_pkt - nb_prep); + } + + nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_prep);
Quoted 41 lines · Kaiwen Deng
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
We can reproduce this issue by these steps list blow on ICE and I40e.
./x86_64-native-linuxapp-gcc/app/dpdk-testpmd -c
0xf-n 4 -- -i --tx-offloads=0x00008000testpmd>set txpkts 64,128,256,512,64,128,256,512,512 testpmd>set burst 1
testpmd>starttx_first1This commit will use Tx preparation API in txonly forwarding engine.
Fixes 655131ccf727 ("app/testpmd: factorize fwd engines Tx")Signed-off-by Kaiwen Deng <[email protected]>--- app/test-pmd/txonly.c | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-)app/test-pmd/txonly.c +1
-0@@ -339,6 +339,7 @@ pkt_burst_transmit(struct fwd_stream *fs)struct rte_ether_hdr eth_hdr;uint16_t nb_tx;uint16_t nb_pkt; +uint16_t nb_prep;uint16_t vlan_tci, vlan_tci_outer;uint64_t ol_flags =0 ;uint64_t tx_offloads;
app/test-pmd/txonly.c pkt_burst_transmit(struct fwd_stream *fs) · line 400
Quoted 5 lines
app/test-pmd/txonly.c +1
-1@@ -396,7 +397,17 @@ pkt_burst_transmit(struct fwd_stream *fs)if (nb_pkt ==0 )return false; - nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_pkt); + nb_prep = rte_eth_tx_prepare(fs->tx_port, fs->tx_queue,
More performant version will be
to have two versions of fwd_engine.packet_fwd based on the offload. And fix up the correct tx_only_engine.packet_fwd at runtime based on the offload selected.
PATCH v2 1/1 app/testpmd: use Tx preparation in txonly engine
In reply to Kaiwen DengTxonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
We can reproduce this issue by these steps list blow on ICE and I40e.
./x86_64-native-linuxapp-gcc/app/dpdk-testpmd -c 0xf -n 4 -- -i --tx-offloads=0x00008000
testpmd>set txpkts 64,128,256,512,64,128,256,512,512 testpmd>set burst 1
testpmd>start tx_first 1
This commit will use Tx preparation API in txonly forwarding engine.
--- app/test-pmd/txonly.c | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-)
app/test-pmd/txonly.c +16 -1
@@ -335,13 +335,16 @@ pkt_burst_transmit(struct fwd_stream *fs)struct rte_mbuf *pkts_burst[MAX_PKT_BURST ];struct rte_port *txp;struct rte_mbuf *pkt; +struct rte_mbuf *mb;struct rte_mempool *mbp;struct rte_ether_hdr eth_hdr;uint16_t nb_tx;uint16_t nb_pkt; +uint16_t nb_prep;uint16_t vlan_tci, vlan_tci_outer;uint64_t ol_flags =0 ;uint64_t tx_offloads; +char buf[256 ]; mbp =current_fwd_lcore ()->mbp; txp = &ports[fs->tx_port];
@@ -396,7 +399,19 @@ pkt_burst_transmit(struct fwd_stream *fs)if (nb_pkt ==0 )return false; - nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_pkt); + nb_prep =rte_eth_tx_prepare (fs->tx_port, fs->tx_queue, + pkts_burst, nb_pkt); +if (unlikely (nb_prep != nb_pkt)) { + mb = pkts_burst[nb_prep]; +rte_get_tx_ol_flag_list (mb->ol_flags, buf,sizeof (buf)); +fprintf (stderr, +"Preparing packet burst to transmit failed: %s ol_flags: %s\n" , +rte_strerror (rte_errno), buf); + fs->fwd_dropped += nb_pkt - nb_prep; +rte_pktmbuf_free_bulk (&pkts_burst[nb_prep], nb_pkt - nb_prep); + } + + nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_prep);if (txonly_multi_flow)RTE_PER_LCORE (_src_port_var) -= nb_pkt - nb_tx;
Signature · 1 line
2.34.1
lgtm,
Quoted 69 lines · Kaiwen Deng
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
We can reproduce this issue by these steps list blow on ICE and I40e.
./x86_64-native-linuxapp-gcc/app/dpdk-testpmd -c
0xf-n 4 -- -i --tx-offloads=0x00008000testpmd>set txpkts 64,128,256,512,64,128,256,512,512 testpmd>set burst 1
testpmd>starttx_first1This commit will use Tx preparation API in txonly forwarding engine.
Fixes 655131ccf727 ("app/testpmd: factorize fwd engines Tx")Signed-off-by Kaiwen Deng <[email protected]>--- app/test-pmd/txonly.c | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-)app/test-pmd/txonly.c +16
-1@@ -335,13 +335,16 @@ pkt_burst_transmit(struct fwd_stream *fs)struct rte_mbuf *pkts_burst[MAX_PKT_BURST ];struct rte_port *txp;struct rte_mbuf *pkt; +struct rte_mbuf *mb;struct rte_mempool *mbp;struct rte_ether_hdr eth_hdr;uint16_t nb_tx;uint16_t nb_pkt; +uint16_t nb_prep;uint16_t vlan_tci, vlan_tci_outer;uint64_t ol_flags =0 ;uint64_t tx_offloads; +char buf[256 ]; mbp =current_fwd_lcore ()->mbp; txp = &ports[fs->tx_port];@@ -396,7 +399,19 @@ pkt_burst_transmit(struct fwd_stream *fs)if (nb_pkt ==0 )return false; - nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_pkt); + nb_prep =rte_eth_tx_prepare (fs->tx_port, fs->tx_queue, + pkts_burst, nb_pkt); +if (unlikely (nb_prep != nb_pkt)) { + mb = pkts_burst[nb_prep]; +rte_get_tx_ol_flag_list (mb->ol_flags, buf,sizeof (buf)); +fprintf (stderr, +"Preparing packet burst to transmit failed: %s ol_flags: %s\n" , +rte_strerror (rte_errno), buf); + fs->fwd_dropped += nb_pkt - nb_prep; +rte_pktmbuf_free_bulk (&pkts_burst[nb_prep], nb_pkt - nb_prep); + } + + nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_prep);if (txonly_multi_flow)RTE_PER_LCORE (_src_port_var) -= nb_pkt - nb_tx;
Quoted 17 lines · On Thu, 11 Jan 2024 13:25:55 +0800 Kaiwen Deng <[email protected]> wrote:
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
We can reproduce this issue by these steps list blow on ICE and I40e.
./x86_64-native-linuxapp-gcc/app/dpdk-testpmd -c
0xf-n 4 -- -i --tx-offloads=0x00008000testpmd>set txpkts 64,128,256,512,64,128,256,512,512 testpmd>set burst 1
testpmd>starttx_first1
Quoted 6 lines
This commit will use Tx preparation API in txonly forwarding engine.
Fixes 655131ccf727 ("app/testpmd: factorize fwd engines Tx")Signed-off-by Kaiwen Deng <[email protected]>
Quoted 18 lines · Kaiwen Deng
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
We can reproduce this issue by these steps list blow on ICE and I40e.
./x86_64-native-linuxapp-gcc/app/dpdk-testpmd -c
0xf-n 4 -- -i --tx-offloads=0x00008000testpmd>set txpkts 64,128,256,512,64,128,256,512,512 testpmd>set burst 1
testpmd>starttx_first1
Quoted 6 lines
This commit will use Tx preparation API in txonly forwarding engine.
Fixes 655131ccf727 ("app/testpmd: factorize fwd engines Tx")Signed-off-by Kaiwen Deng <[email protected]>
I did not see a reply to Jerin concern on performance impact of this change.
Some additional comment below.
Quoted 26 lines
--- app/test-pmd/txonly.c | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-)app/test-pmd/txonly.c +3
-0@@ -335,13 +335,16 @@ pkt_burst_transmit(struct fwd_stream *fs)struct rte_mbuf *pkts_burst[MAX_PKT_BURST ];struct rte_port *txp;struct rte_mbuf *pkt; +struct rte_mbuf *mb;struct rte_mempool *mbp;struct rte_ether_hdr eth_hdr;uint16_t nb_tx;uint16_t nb_pkt; +uint16_t nb_prep;uint16_t vlan_tci, vlan_tci_outer;uint64_t ol_flags =0 ;uint64_t tx_offloads; +char buf[256 ]; mbp =current_fwd_lcore ()->mbp; txp = &ports[fs->tx_port];
app/test-pmd/txonly.c pkt_burst_transmit(struct fwd_stream *fs) · line 404
Quoted 7 lines
app/test-pmd/txonly.c +3
-1@@ -396,7 +399,19 @@ pkt_burst_transmit(struct fwd_stream *fs)if (nb_pkt ==0 )return false; - nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_pkt); + nb_prep =rte_eth_tx_prepare (fs->tx_port, fs->tx_queue, + pkts_burst, nb_pkt); +if (unlikely (nb_prep != nb_pkt)) {
The buf variable declaration can be moved at the start of this block as buf is not needed anywhere else.
app/test-pmd/txonly.c pkt_burst_transmit(struct fwd_stream *fs) · line 406
Quoted 2 lines
app/test-pmd/txonly.c +2
-0+ mb = pkts_burst[nb_prep]; +rte_get_tx_ol_flag_list (mb->ol_flags, buf,sizeof (buf));
You don't need a mb variable, simply pass pkts_burst[nb_prep]->ol_flags.
rte_get_tx_ol_flag_list() return value must be checked for the (theoretical) case when the 'buf' variable is too short to avoid the below fprintf outputting garbage since buf may be unterminated.
Quoted 14 lines
app/test-pmd/txonly.c +8
-1+fprintf (stderr, +"Preparing packet burst to transmit failed: %s ol_flags: %s\n" , +rte_strerror (rte_errno), buf); + fs->fwd_dropped += nb_pkt - nb_prep; +rte_pktmbuf_free_bulk (&pkts_burst[nb_prep], nb_pkt - nb_prep); + } + + nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_prep);if (txonly_multi_flow)RTE_PER_LCORE (_src_port_var) -= nb_pkt - nb_tx; --2.34.1
Signature · 1 line
David Marchand
Quoted 8 lines · Kaiwen Deng
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case may impact performance for users.
What happens when driver throws MDD (Malicious Driver Detection) event, can't it be ignored? As you are already OK to drop the packet, can device be configured to drop these packages?
Or as Jerin suggested adding a new forwarding engine is a solution, but that will create code duplication, I prefer to not have it if this can be handled in device level.
Quoted 15 lines · Kaiwen Deng
Quoted 8 lines
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case may impact performance for users.
Quoted 8 lines
What happens when driver throws MDD (Malicious Driver Detection) event, can't it be ignored? As you are already OK to drop the packet, can device be configured to drop these packages?
Or as Jerin suggested adding a new forwarding engine is a solution, but that will create code duplication, I prefer to not have it if this can be handled in device level.
Actually I am agree with the author of the patch - when TX offloads and/or multisegs are enabled, user supposed to invoke eth_tx_prepare().
Not doing that seems like a bug to me.
If it still works for some cases, that's a lucky coincidence, but not the expected behavior. About performance - first we can check is that really a drop.
Also as I remember most drivers set it to non-NULL value, only when some TX offloads were enabled by the user on that port, so hopefully for simple case (one segment, no tx offloads) it should be negligible.
Again, we can add manual check in testpmd tx-only code to decide do we need a TX prepare to be called or not.
Konstantin
Quoted 20 lines · Konstantin Ananyev
Quoted 20 lines · Kaiwen Deng
Quoted 8 lines
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case may impact performance for users.
What happens when driver throws MDD (Malicious Driver Detection) event, can't it be ignored? As you are already OK to drop the packet, can device be configured to drop these packages?
Quoted 9 lines
Quoted 3 lines
Or as Jerin suggested adding a new forwarding engine is a solution, but that will create code duplication, I prefer to not have it if this can be handled in device level.
Actually I am agree with the author of the patch - when TX offloads and/or multisegs are enabled, user supposed to invoke
eth_tx_prepare().
Not doing that seems like a bug to me.
If it still works for some cases, that's a lucky coincidence, but not the expected behavior.
fair enough
Quoted 5 lines
About performance - first we can check is that really a drop.
Also as I remember most drivers set it to non-NULL value, only when some TX offloads were enabled by the user on that port, so hopefully for simple case (one segment, no tx offloads) it should be negligible.
+1 to measure the impact, that helps to decide
Quoted 3 lines
Again, we can add manual check in testpmd tx-only code to decide do we need a TX prepare to be called or not.
What is the condition to call Tx prepare, is it only required when Tx offload are enabled?
@Kaiwen can you please give some details on the problematic case, "MSS spans more than 8 data fragments", and how to produce it?
Quoted 38 lines
Quoted 20 lines
Quoted 20 lines · Kaiwen Deng
Quoted 8 lines
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case may impact performance for users.
What happens when driver throws MDD (Malicious Driver Detection) event, can't it be ignored? As you are already OK to drop the packet, can device be configured to drop these packages?
Quoted 9 lines
Quoted 3 lines
Or as Jerin suggested adding a new forwarding engine is a solution, but that will create code duplication, I prefer to not have it if this can be handled in device level.
Actually I am agree with the author of the patch - when TX offloads and/or multisegs are enabled, user supposed to invoke
eth_tx_prepare().
Not doing that seems like a bug to me.
If it still works for some cases, that's a lucky coincidence, but not the expected behavior.fair enough
Quoted 5 lines
About performance - first we can check is that really a drop.
Also as I remember most drivers set it to non-NULL value, only when some TX offloads were enabled by the user on that port, so hopefully for simple case (one segment, no tx offloads) it should be negligible.
Quoted 8 lines
+1 to measure the impact, that helps to decide
Quoted 3 lines
Again, we can add manual check in testpmd tx-only code to decide do we need a TX prepare to be called or not.
What is the condition to call Tx prepare, is it only required when Tx offload are enabled?
Yes, as I remember, tx_prepare() need to be called only when TX offloads
(cksum, tso, etc.) are requested.
It also does some extra sanity checks - min pkt_len, max number of segments, etc.,
so there is no harm to call it even when no tx offloads are enabled, but then
user needs to be prepared for some extra overhead.
In theory user can do all these things manually I his own code, but as requirements vary between HW models, I suppose it will be a real pain for the user.
Quoted 4 lines
@Kaiwen can you please give some details on the problematic case, "MSS spans more than 8 data fragments", and how to produce it?
Quoted 25 lines
From: Konstantin Ananyev [mailto:[email protected]]
Sent: Thursday, 8 February 2024 11.50Quoted 7 lines · Kaiwen Deng
Quoted 6 lines
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx
preparation
Quoted 7 lines
Quoted 2 lines
API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case may impact performance for users.
What happens when driver throws MDD (Malicious Driver Detection)
event,
Quoted 5 lines
can't it be ignored? As you are already OK to drop the packet, can device be configured to drop these packages?
Or as Jerin suggested adding a new forwarding engine is a solution,
but
Quoted 8 lines
Quoted 1 line
that will create code duplication, I prefer to not have it if this
can
Quoted 1 line
be handled in device level.
Actually I am agree with the author of the patch - when TX offloads and/or multisegs are enabled,
user supposed to invokeeth_tx_prepare().
Not doing that seems like a bug to me.
I strongly disagree with that statement, Konstantin!
It is not documented anywhere that using TX offloads and/or multisegs requires calling rte_eth_tx_prepare() before rte_eth_tx_burst(). And none of the examples do it.
In my opinion:
If some driver has limitations for a feature, e.g. max 8 fragments, it should be documented for that driver, so the application developer can make the appropriate decisions when designing the application. Furthermore, we have APIs for the drivers to expose to the applications what the driver supports, so the application can configure itself optimally at startup. Perhaps those APIs need to be expanded. And if a feature limitation is common across the majority of drivers, that limitation should be mentioned in the documentation of the feature itself.
We don't want to check in the fast path what can be checked at startup or build time!
Quoted 12 lines
If it still works for some cases, that's a lucky coincidence, but not the expected behavior.
About performance - first we can check is that really a drop. Also as I remember most drivers set it to non-NULL value, only when some TX offloads were
enabled by the user on that port, so hopefully for simple case (one segment, no tx offloads) it
should be negligible.
Again, we can add manual check in testpmd tx-only code to decide do we need a TX prepare
to be called or not.
Konstantin
Quoted 24 lines
Quoted 24 lines
Quoted 5 lines
Quoted 5 lines
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx
preparation
Quoted 7 lines
Quoted 2 lines
API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case may impact performance for users.
What happens when driver throws MDD (Malicious Driver Detection)
event,
Quoted 5 lines
can't it be ignored? As you are already OK to drop the packet, can device be configured to drop these packages?
Or as Jerin suggested adding a new forwarding engine is a solution,
but
Quoted 1 line
that will create code duplication, I prefer to not have it if this
can
Quoted 1 line
be handled in device level.
Quoted 8 lines
Quoted 4 lines
Actually I am agree with the author of the patch - when TX offloads and/or multisegs are enabled,
user supposed to invokeeth_tx_prepare().
Not doing that seems like a bug to me.I strongly disagree with that statement, Konstantin!
It is not documented anywhere that using TX offloads and/or multisegs requires callingrte_eth_tx_prepare()beforerte_eth_tx_burst(). And none of the examples do it.
In fact, we do use it for test-pmd/csumonly.c.
About other sample apps:
AFAIK, not many of other DPDK apps do use L4 offloads.
Right now special treatment (pseudo-header cksum calculation) is needed only for L4 offloads (CKSUM, SEG). So, majority of our apps who rely on other TX offloads (multi-seg, ipv4 cksum, vlan insertion) happily run without calling tx_prepare(), even though it is not the safest way.
Quoted 8 lines
In my opinion:
If some driver has limitations for a feature, e.g. max 8 fragments, it should be documented for that driver, so the application developer can make the appropriate decisions when designing the application.
Furthermore, we have APIs for the drivers to expose to the applications what the driver supports, so the application can configure itself optimally at startup. Perhaps those APIs need to be expanded.
And if a feature limitation is common across the majority of drivers, that limitation should be mentioned in the documentation of the feature itself.
Many of such limitations *are* documented and in fact we do have an API to check max segments that each driver support, see struct rte_eth_desc_lim.
The problem is:
- none of our sample app does proper check on these values, so users don't have a good example how to do it.
- with current DPDK API not all of HW/PMD requirements could be extracted programmatically:
let say majority of Intel PMDs for TCP offloads expect pseudo-header cksum to be pre-calculated by the SW. another example, some HW expects pkt_len to be bigger then some threshold value, otherwise HW hang may appear.
- As new HW and PMD keep appearing it is hard to predict what extra limitations/requirements will arise, that's why tx_prepare() was introduced as s driver op.
Quoted 2 lines
We don't want to check in the fast path what can be checked at startup or build time!
If your app supposed to work with just a few, known in advance, NIC models, then sure, you can do that. For apps that supposed to work 'in general' with any possible PMDs that DPDK supports - that might be a problem. That's why tx_prepare() was introduced and it is strongly recommended to use it by the apps that do use TX offloads. Probably tx_prepare() is not the best possible approach, but right now there are not many alternatives within DPDK.
Quoted 13 lines
Quoted 13 lines
If it still works for some cases, that's a lucky coincidence, but not the expected behavior.
About performance - first we can check is that really a drop. Also as I remember most drivers set it to non-NULL value, only when some TX offloads were
enabled by the user on that port, so hopefully for simple case (one segment, no tx offloads) it
should be negligible.
Again, we can add manual check in testpmd tx-only code to decide do we need a TX prepare
to be called or not.
Konstantin
+CC: Ethernet API maintainers
+CC: Jerin (commented on another branch of this thread)
Quoted 57 lines
From: Konstantin Ananyev [mailto:[email protected]]
Sent: Sunday, 11 February 2024 16.04Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will
cause
Quoted 6 lines
Quoted 6 lines
Quoted 1 line
Quoted 1 line
MDD event if txonly forwarding engine does not call the Tx
preparation
Quoted 4 lines
Quoted 2 lines
API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case
may
Quoted 5 lines
Quoted 5 lines
Quoted 3 lines
impact performance for users.
What happens when driver throws MDD (Malicious Driver Detection)
event,
Quoted 1 line
can't it be ignored? As you are already OK to drop the packet,
can
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
device be configured to drop these packages?
Or as Jerin suggested adding a new forwarding engine is a
solution,
Quoted 2 lines
Quoted 2 lines
but
Quoted 1 line
that will create code duplication, I prefer to not have it if
this
Quoted 10 lines
Quoted 7 lines
can
Quoted 1 line
be handled in device level.
Actually I am agree with the author of the patch - when TX offloads and/or multisegs are enabled,
user supposed to invokeeth_tx_prepare().
Not doing that seems like a bug to me.I strongly disagree with that statement, Konstantin!
It is not documented anywhere that using TX offloads and/or multisegsrequires calling
rte_eth_tx_prepare()beforeQuoted 1 line
rte_eth_tx_burst(). And none of the examples do it.In fact, we do use it for
test-pmd/csumonly.c.
About other sample apps:
AFAIK, not many of other DPDK apps do use L4 offloads.
Right now special treatment (pseudo-header cksum calculation) is needed only for L4 offloads (CKSUM, SEG).
So, majority of our apps who rely on other TX offloads (multi-seg, ipv4 cksum, vlan insertion) happily run without
callingtx_prepare(), even though it is not the safest way.Quoted 3 lines
In my opinion:
If some driver has limitations for a feature, e.g. max 8 fragments,it should be documented for that driver, so the application
Quoted 1 line
developer can make the appropriate decisions when designing the
application.
Quoted 1 line
Furthermore, we have APIs for the drivers to expose to the
applications what the driver supports, so the application can configure
Quoted 8 lines
Quoted 2 lines
itself optimally at startup. Perhaps those APIs need to be expanded. And if a feature limitation is common across the majority of drivers,
that limitation should be mentioned in the documentation of the
Quoted 1 line
feature itself.
Many of such limitations *are* documented and in fact we do have an API to check max segments that each driver support,
see structrte_eth_desc_lim.
Yes, this is the kind of API we should provide, so the application can configure itself appropriately.
Quoted 3 lines
The problem is:
- none of our sample app does proper check on these values, so users don't have a good example how to do it.
Agreed.
Adding an example showing how to do it properly would be the best solution. Calling tx_prepare() in the examples is certainly not the solution.
Quoted 4 lines
- with current DPDK API not all of HW/PMD requirements could be extracted programmatically:
let say majority of Intel PMDs for TCP offloads expect pseudo-header
cksum to be pre-calculated by the SW.
I hope this requirement is documented somewhere.
Quoted 2 lines
another example, some HW expects
pkt_lento be bigger then some
threshold value, otherwise HW hang may appear.
I hope this requirement is also documented somewhere.
Generally, if the requirements cannot be extracted programmatically, they must be prominently documented, like this note to rte_eth_rx_burst():
* @note
* Some drivers using vector instructions require that *nb_pkts* is
* divisible by 4 or 8, depending on the driver implementation.
Quoted 8 lines
- As new HW and PMD keep appearing it is hard to predict what extra limitations/requirements will arise,
that's whytx_prepare()was introduced as s driver op.Quoted 2 lines
We don't want to check in the fast path what can be checked at
startup or build time!
Quoted 8 lines
If your app supposed to work with just a few, known in advance, NIC models, then sure, you can do that.
For apps that supposed to work 'in general' with any possible PMDs that DPDK supports - that might be a problem.
That's whytx_prepare()was introduced and it is strongly recommended to use it by the apps that do use TX offloads.
Probablytx_prepare()is not the best possible approach, but right now there are not many alternatives within DPDK.
What exactly is an application supposed to do if tx_prepare() doesn't accept the full burst? It doesn't return information about what is wrong. Dropping the packets might not be an option, e.g. for applications used in life support or tele-medicine.
If limitations are documented, an application can use the lowest common denominator of the NICs it supports. And if the application is supposed to work in general, that becomes the lowest common denominator of all NICs.
It looks like tx_prepare() has become a horrible workaround for undocumented limitations.
Limitations due to hardware and/or software tradeoffs are unavoidable, so we have to live with them; but we should not accept PMDs with undocumented limitations.
Quoted 16 lines
Quoted 3 lines
Quoted 3 lines
If it still works for some cases, that's a lucky coincidence, but
not
Quoted 8 lines
Quoted 8 lines
the expected behavior.
About performance - first we can check is that really a drop. Also as I remember most drivers set it to non-NULL value, only when some TX offloads were
enabled by the user on that port, so hopefully for simple case (one segment, no tx offloads) it
should be negligible.
Again, we can add manual check in testpmd tx-only code to decide dowe
Quoted 3 lines
Quoted 3 lines
need a TX prepare
to be called or not.
Konstantin
Quoted 85 lines
(quoted diff) +2
-0+CC: Ethernet API maintainers +CC: Jerin (commented on another branch of this thread)Quoted 58 lines
From: Konstantin Ananyev [mailto:[email protected]]
Sent: Sunday, 11 February 2024 16.04Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will
cause
Quoted 6 lines
Quoted 6 lines
Quoted 1 line
Quoted 1 line
MDD event if txonly forwarding engine does not call the Tx
preparation
Quoted 4 lines
Quoted 2 lines
API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case
may
Quoted 5 lines
Quoted 5 lines
Quoted 3 lines
impact performance for users.
What happens when driver throws MDD (Malicious Driver Detection)
event,
Quoted 1 line
can't it be ignored? As you are already OK to drop the packet,
can
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
device be configured to drop these packages?
Or as Jerin suggested adding a new forwarding engine is a
solution,
Quoted 2 lines
Quoted 2 lines
but
Quoted 1 line
that will create code duplication, I prefer to not have it if
this
Quoted 10 lines
Quoted 7 lines
can
Quoted 1 line
be handled in device level.
Actually I am agree with the author of the patch - when TX offloads and/or multisegs are enabled,
user supposed to invokeeth_tx_prepare().
Not doing that seems like a bug to me.I strongly disagree with that statement, Konstantin!
It is not documented anywhere that using TX offloads and/or multisegsrequires calling
rte_eth_tx_prepare()beforeQuoted 1 line
rte_eth_tx_burst(). And none of the examples do it.In fact, we do use it for
test-pmd/csumonly.c.
About other sample apps:
AFAIK, not many of other DPDK apps do use L4 offloads.
Right now special treatment (pseudo-header cksum calculation) is needed only for L4 offloads (CKSUM, SEG).
So, majority of our apps who rely on other TX offloads (multi-seg, ipv4 cksum, vlan insertion) happily run without
callingtx_prepare(), even though it is not the safest way.Quoted 3 lines
In my opinion:
If some driver has limitations for a feature, e.g. max 8 fragments,it should be documented for that driver, so the application
Quoted 1 line
developer can make the appropriate decisions when designing the
application.
Quoted 1 line
Furthermore, we have APIs for the drivers to expose to the
applications what the driver supports, so the application can configure
Quoted 8 lines
Quoted 2 lines
itself optimally at startup. Perhaps those APIs need to be expanded. And if a feature limitation is common across the majority of drivers,
that limitation should be mentioned in the documentation of the
Quoted 1 line
feature itself.
Many of such limitations *are* documented and in fact we do have an API to check max segments that each driver support,
see structrte_eth_desc_lim.Yes, this is the kind of API we should provide, so the application can configure itself appropriately.
Quoted 3 lines
The problem is:
- none of our sample app does proper check on these values, so users don't have a good example how to do it.Agreed.
Adding an example showing how to do it properly would be the best solution. Callingtx_prepare()in the examples is certainly not the solution.Quoted 4 lines
- with current DPDK API not all of HW/PMD requirements could be extracted programmatically:
let say majority of Intel PMDs for TCP offloads expect pseudo-header
cksum to be pre-calculated by the SW.
Quoted 6 lines
I hope this requirement is documented somewhere.
Quoted 2 lines
another example, some HW expects
pkt_lento be bigger then some
threshold value, otherwise HW hang may appear.I hope this requirement is also documented somewhere.
No idea, I found it only in the code.
Quoted 2 lines
Generally, if the requirements cannot be extracted programmatically, they must be prominently documented, like this note to
rte_eth_rx_burst():
Obviously, more detailed documentation is always good, but...
Right now we have 50+ different PMDs from different vendors.
Even if each and every of them will carefully document all possible limitations and necessary preparation steps, how DPDK app developer supposed to deal with all that?
Do you expect everyone, to read carefully through all of them, and handle all of them properly oh his own in each and every DPDK app he is going to write?
That seems unrealistic.
Again what to do with backward compatibility: when new driver (with new limitations) will arise *after* your app is already written and tested?
Quoted 22 lines
* @note
* Some drivers using vector instructions require that *nb_pkts* is
* divisible by 4 or 8, depending on the driver implementation.Quoted 8 lines
- As new HW and PMD keep appearing it is hard to predict what extra limitations/requirements will arise,
that's whytx_prepare()was introduced as s driver op.Quoted 2 lines
We don't want to check in the fast path what can be checked at
startup or build time!
Quoted 8 lines
If your app supposed to work with just a few, known in advance, NIC models, then sure, you can do that.
For apps that supposed to work 'in general' with any possible PMDs that DPDK supports - that might be a problem.
That's whytx_prepare()was introduced and it is strongly recommended to use it by the apps that do use TX offloads.
Probablytx_prepare()is not the best possible approach, but right now there are not many alternatives within DPDK.
Quoted 2 lines
What exactly is an application supposed to do if
tx_prepare()doesn't accept the full burst? It doesn't return information about what is wrong.
It provides some information, but it is *very* limited: just index of 'bad' packet and error code. In theory app can try to handle it in a 'smart' way: let say if ENOTSUP is returned, then try to disable all HW offloads and do all in SW. But again, it is much better to do so *before* submitting packets for TX, so in practice everyone just drop such 'bad' packets.
Dropping the packets might not be an option, e.g. for applications used in life support or tele-medicine.
If the packet is 'bad', then it is much better to drop it, then TX corrupted packet or even hang NIC HW completely. Though off-course it is much better to have an app that would check for limitations that can be checked by API provided and enable only supported offloads.
Quoted 2 lines
If limitations are documented, an application can use the lowest common denominator of the NICs it supports. And if the application is supposed to work in general, that becomes the lowest common denominator of all NICs.
I agree: for limitations that can be extracted with generic API, like:
number of segments per packet, supported TX offloads, mbuf fileds that must be provided for each TX offload, etc. - it is responsibility of well-written application to obey all of them.
Yes, many tx_prepare() implementations do such checks anyway, but from my perspective it is sort of last-line of defense. For well written application that should just never happen.
But there is one more important responsibility of tx_prepare() - it performs PMD specific packet modifications for requested offloads. As I already mentioned for Intel NICs - it does pseudo-header cksum calcucation, for packets with size less then minimal, it can probably do padding (even if doesn't do it right now), for some other PMDs - might be something else, I didn't check. Obviously it saves app developer from a burden to do all these things on his own.
Quoted 4 lines
It looks like
tx_prepare()has become a horrible workaround for undocumented limitations.Limitations due to hardware and/or software tradeoffs are unavoidable, so we have to live with them; but we should not accept PMDs with undocumented limitations.
As I already said, more documentation never hurts, but for that case, I think it is not enough. I expect PMD to provide a tx_prepare() implementation that would deal with such specific things.
Anyway, back to the original patch - I looked at it once again, and realized that the problem is just in the unsupported number of segments.
As we discussed above - such limitations should be handled by well written app, but none of DPDK apps does it right now.
So probably it is good opportunity to do things in a proper way and introduce such checks in testpmd ;)
Kaiwen, WDYT?
Quoted 16 lines
Quoted 16 lines
Quoted 3 lines
Quoted 3 lines
If it still works for some cases, that's a lucky coincidence, but
not
Quoted 8 lines
Quoted 8 lines
the expected behavior.
About performance - first we can check is that really a drop. Also as I remember most drivers set it to non-NULL value, only when some TX offloads were
enabled by the user on that port, so hopefully for simple case (one segment, no tx offloads) it
should be negligible.
Again, we can add manual check in testpmd tx-only code to decide dowe
Quoted 3 lines
Quoted 3 lines
need a TX prepare
to be called or not.
Konstantin
Quoted 85 lines · Konstantin Ananyev
Quoted 85 lines
(quoted diff) +2
-0+CC: Ethernet API maintainers +CC: Jerin (commented on another branch of this thread)Quoted 58 lines
From: Konstantin Ananyev [mailto:[email protected]]
Sent: Sunday, 11 February 2024 16.04Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will
cause
Quoted 6 lines
Quoted 6 lines
Quoted 1 line
Quoted 1 line
MDD event if txonly forwarding engine does not call the Tx
preparation
Quoted 4 lines
Quoted 2 lines
API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case
may
Quoted 5 lines
Quoted 5 lines
Quoted 3 lines
impact performance for users.
What happens when driver throws MDD (Malicious Driver Detection)
event,
Quoted 1 line
can't it be ignored? As you are already OK to drop the packet,
can
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
device be configured to drop these packages?
Or as Jerin suggested adding a new forwarding engine is a
solution,
Quoted 2 lines
Quoted 2 lines
but
Quoted 1 line
that will create code duplication, I prefer to not have it if
this
Quoted 10 lines
Quoted 7 lines
can
Quoted 1 line
be handled in device level.
Actually I am agree with the author of the patch - when TX offloads and/or multisegs are enabled,
user supposed to invokeeth_tx_prepare().
Not doing that seems like a bug to me.I strongly disagree with that statement, Konstantin!
It is not documented anywhere that using TX offloads and/or multisegsrequires calling
rte_eth_tx_prepare()beforeQuoted 1 line
rte_eth_tx_burst(). And none of the examples do it.In fact, we do use it for
test-pmd/csumonly.c.
About other sample apps:
AFAIK, not many of other DPDK apps do use L4 offloads.
Right now special treatment (pseudo-header cksum calculation) is needed only for L4 offloads (CKSUM, SEG).
So, majority of our apps who rely on other TX offloads (multi-seg, ipv4 cksum, vlan insertion) happily run without
callingtx_prepare(), even though it is not the safest way.Quoted 3 lines
In my opinion:
If some driver has limitations for a feature, e.g. max 8 fragments,it should be documented for that driver, so the application
Quoted 1 line
developer can make the appropriate decisions when designing the
application.
Quoted 1 line
Furthermore, we have APIs for the drivers to expose to the
applications what the driver supports, so the application can configure
Quoted 8 lines
Quoted 2 lines
itself optimally at startup. Perhaps those APIs need to be expanded. And if a feature limitation is common across the majority of drivers,
that limitation should be mentioned in the documentation of the
Quoted 1 line
feature itself.
Many of such limitations *are* documented and in fact we do have an API to check max segments that each driver support,
see structrte_eth_desc_lim.Yes, this is the kind of API we should provide, so the application can configure itself appropriately.
Quoted 3 lines
The problem is:
- none of our sample app does proper check on these values, so users don't have a good example how to do it.Agreed.
Adding an example showing how to do it properly would be the best solution. Callingtx_prepare()in the examples is certainly not the solution.Quoted 4 lines
- with current DPDK API not all of HW/PMD requirements could be extracted programmatically:
let say majority of Intel PMDs for TCP offloads expect pseudo-header
cksum to be pre-calculated by the SW.
Quoted 8 lines
Quoted 6 lines
I hope this requirement is documented somewhere.
Quoted 2 lines
another example, some HW expects
pkt_lento be bigger then some
threshold value, otherwise HW hang may appear.I hope this requirement is also documented somewhere.
No idea, I found it only in the code.
IMHO Tx burst must check such limitations. If you made your HW simpler (or just lost it on initial testing), pay in your drivers (or your HW+driver will be unusable because of such problems).
Quoted 12 lines
Quoted 2 lines
Generally, if the requirements cannot be extracted programmatically, they must be prominently documented, like this note to
rte_eth_rx_burst():Obviously, more detailed documentation is always good, but...
Right now we have 50+ different PMDs from different vendors.
Even if each and every of them will carefully document all possible limitations and necessary preparation steps, how DPDK app developer supposed to deal with all that?
Do you expect everyone, to read carefully through all of them, and handle all of them properly oh his own in each and every DPDK app he is going to write?
That seems unrealistic.
Again what to do with backward compatibility: when new driver (with new limitations) will arise *after* your app is already written and tested?
+1
Quoted 4 lines
Quoted 4 lines
* @note
* Some drivers using vector instructions require that *nb_pkts* is
* divisible by 4 or 8, depending on the driver implementation.
I'm wondering what application should do if it needs to send just one packet and do it now. IMHO, such limitations are not acceptable.
Quoted 21 lines
Quoted 18 lines
Quoted 9 lines
- As new HW and PMD keep appearing it is hard to predict what extra limitations/requirements will arise,
that's whytx_prepare()was introduced as s driver op.Quoted 2 lines
We don't want to check in the fast path what can be checked at
startup or build time!
Quoted 8 lines
If your app supposed to work with just a few, known in advance, NIC models, then sure, you can do that.
For apps that supposed to work 'in general' with any possible PMDs that DPDK supports - that might be a problem.
That's whytx_prepare()was introduced and it is strongly recommended to use it by the apps that do use TX offloads.
Probablytx_prepare()is not the best possible approach, but right now there are not many alternatives within DPDK.Quoted 2 lines
What exactly is an application supposed to do if
tx_prepare()doesn't accept the full burst? It doesn't return information about what is wrong.
Quoted 6 lines
It provides some information, but it is *very* limited: just index of 'bad' packet and error code. In theory app can try to handle it in a 'smart' way: let say if ENOTSUP is returned, then try to disable all HW offloads and do all in SW. But again, it is much better to do so *before* submitting packets for TX, so in practice everyone just drop such 'bad' packets.
Dropping the packets might not be an option, e.g. for applications used in life support or tele-medicine.
Critical applications should be able to do all Tx offloads in SW and retry. Of course, various statistics and logs should help to improve the application.
Quoted 1 line
If the packet is 'bad', then it is much better to drop it, then TX corrupted packet or even hang NIC HW completely.
IMHO Tx burst must drop packet which could hang NIC HW completely. I realize that it is an extra checks and performance drop, but vendor should pay in performance if HW is not good enough.
Quoted 2 lines
Though off-course it is much better to have an app that would check for limitations that can be checked by API provided and enable only supported offloads.
Yes, that's why API to get limitation is much better than documentation.
Quoted 14 lines
Quoted 2 lines
If limitations are documented, an application can use the lowest common denominator of the NICs it supports. And if the application is supposed to work in general, that becomes the lowest common denominator of all NICs.
I agree: for limitations that can be extracted with generic API, like:
number of segments per packet, supported TX offloads, mbuf fileds that must be provided for each TX offload, etc. - it is responsibility of well-written application to obey all of them.
Yes, manytx_prepare()implementations do such checks anyway, but from my perspective it is sort of last-line of defense. For well written application that should just never happen.
But there is one more important responsibility oftx_prepare()- it performs PMD specific packet modifications for requested offloads. As I already mentioned for Intel NICs - it does pseudo-header cksum calcucation, for packets with size less then minimal, it can probably do padding (even if doesn't do it right now), for some other PMDs - might be something else, I didn't check. Obviously it saves app developer from a burden to do all these things on his own.Quoted 1 line
It looks like
tx_prepare()has become a horrible workaround for undocumented limitations.
I strongly disagree. Documentation is never a solution for a generic application which is intended to work on any HW and IMHO it is the goal to have more and more applications which work on any HW.
Quoted 5 lines
Quoted 2 lines
Limitations due to hardware and/or software tradeoffs are unavoidable, so we have to live with them; but we should not accept PMDs with undocumented limitations.
As I already said, more documentation never hurts, but for that case, I think it is not enough. I expect PMD to provide a
tx_prepare()implementation that would deal with such specific things.
+1
Quoted 6 lines
Anyway, back to the original patch - I looked at it once again, and realized that the problem is just in the unsupported number of segments.
As we discussed above - such limitations should be handled by well written app, but none of DPDK apps does it right now.
So probably it is good opportunity to do things in a proper way and introduce such checks in testpmd ;)
+1 since we already have fields in device information to report such limitations, but it does not say that Tx prepare should be dropped. Drivers which don't need Tx prepare keep it NULL and it returns
immediately from ethdev. Since it is done per-burst, it should not
affect performance a lot.
Quoted 16 lines
Kaiwen, WDYT?
Quoted 14 lines
Quoted 14 lines
Quoted 14 lines
Quoted 14 lines
If it still works for some cases, that's a lucky coincidence, but not the expected behavior.
About performance - first we can check is that really a drop. Also as I remember most drivers set it to non-NULL value, only when some TX offloads were
enabled by the user on that port, so hopefully for simple case (one segment, no tx offloads) it
should be negligible.
Again, we can add manual check in testpmd tx-only code to decide do we need a TX prepare
to be called or not.
Konstantin
Quoted 195 lines
Quoted 80 lines
Quoted 80 lines
Quoted 56 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will
cause
Quoted 6 lines
Quoted 6 lines
Quoted 1 line
Quoted 1 line
MDD event if txonly forwarding engine does not call the Tx
preparation
Quoted 4 lines
Quoted 2 lines
API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case
may
Quoted 5 lines
Quoted 5 lines
Quoted 3 lines
impact performance for users.
What happens when driver throws MDD (Malicious Driver Detection)
event,
Quoted 1 line
can't it be ignored? As you are already OK to drop the packet,
can
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
device be configured to drop these packages?
Or as Jerin suggested adding a new forwarding engine is a
solution,
Quoted 2 lines
Quoted 2 lines
but
Quoted 1 line
that will create code duplication, I prefer to not have it if
this
Quoted 10 lines
Quoted 7 lines
can
Quoted 1 line
be handled in device level.
Actually I am agree with the author of the patch - when TX offloads and/or multisegs are enabled,
user supposed to invokeeth_tx_prepare().
Not doing that seems like a bug to me.I strongly disagree with that statement, Konstantin!
It is not documented anywhere that using TX offloads and/or multisegsrequires calling
rte_eth_tx_prepare()beforeQuoted 1 line
rte_eth_tx_burst(). And none of the examples do it.In fact, we do use it for
test-pmd/csumonly.c.
About other sample apps:
AFAIK, not many of other DPDK apps do use L4 offloads.
Right now special treatment (pseudo-header cksum calculation) is needed only for L4 offloads (CKSUM, SEG).
So, majority of our apps who rely on other TX offloads (multi-seg, ipv4 cksum, vlan insertion) happily run without
callingtx_prepare(), even though it is not the safest way.Quoted 3 lines
In my opinion:
If some driver has limitations for a feature, e.g. max 8 fragments,it should be documented for that driver, so the application
Quoted 1 line
developer can make the appropriate decisions when designing the
application.
Quoted 1 line
Furthermore, we have APIs for the drivers to expose to the
applications what the driver supports, so the application can configure
Quoted 8 lines
Quoted 2 lines
itself optimally at startup. Perhaps those APIs need to be expanded. And if a feature limitation is common across the majority of drivers,
that limitation should be mentioned in the documentation of the
Quoted 1 line
feature itself.
Many of such limitations *are* documented and in fact we do have an API to check max segments that each driver support,
see structrte_eth_desc_lim.Yes, this is the kind of API we should provide, so the application can configure itself appropriately.
Quoted 3 lines
The problem is:
- none of our sample app does proper check on these values, so users don't have a good example how to do it.Agreed.
Adding an example showing how to do it properly would be the best solution. Callingtx_prepare()in the examples is certainly not the solution.Quoted 4 lines
- with current DPDK API not all of HW/PMD requirements could be extracted programmatically:
let say majority of Intel PMDs for TCP offloads expect pseudo-header
cksum to be pre-calculated by the SW.Quoted 8 lines
Quoted 6 lines
I hope this requirement is documented somewhere.
Quoted 2 lines
another example, some HW expects
pkt_lento be bigger then some
threshold value, otherwise HW hang may appear.I hope this requirement is also documented somewhere.
No idea, I found it only in the code.
IMHO Tx burst must check such limitations. If you made your HW simpler (or just lost it on initial testing), pay in your drivers (or your HW+driver will be unusable because of such problems).
Quoted 12 lines
Quoted 2 lines
Generally, if the requirements cannot be extracted programmatically, they must be prominently documented, like this note to
rte_eth_rx_burst():Obviously, more detailed documentation is always good, but...
Right now we have 50+ different PMDs from different vendors.
Even if each and every of them will carefully document all possible limitations and necessary preparation steps, how DPDK app developer supposed to deal with all that?
Do you expect everyone, to read carefully through all of them, and handle all of them properly oh his own in each and every DPDK app he is going to write?
That seems unrealistic.
Again what to do with backward compatibility: when new driver (with new limitations) will arise *after* your app is already written and tested?+1
Quoted 4 lines
Quoted 4 lines
* @note
* Some drivers using vector instructions require that *nb_pkts* is
* divisible by 4 or 8, depending on the driver implementation.I'm wondering what application should do if it needs to send just one packet and do it now. IMHO, such limitations are not acceptable.
Quoted 18 lines
Quoted 18 lines
Quoted 17 lines
- As new HW and PMD keep appearing it is hard to predict what extra limitations/requirements will arise,
that's whytx_prepare()was introduced as s driver op.Quoted 2 lines
We don't want to check in the fast path what can be checked at
startup or build time!
If your app supposed to work with just a few, known in advance, NIC models, then sure, you can do that.
For apps that supposed to work 'in general' with any possible PMDs that DPDK supports - that might be a problem.
That's whytx_prepare()was introduced and it is strongly recommended to use it by the apps that do use TX offloads.
Probablytx_prepare()is not the best possible approach, but right now there are not many alternatives within DPDK.Quoted 1 line
Quoted 1 line
What exactly is an application supposed to do if
tx_prepare()doesn't accept the full burst? It doesn't return information aboutwhat is
Quoted 8 lines
Quoted 1 line
wrong.
It provides some information, but it is *very* limited: just index of 'bad' packet and error code. In theory app can try to handle it in a 'smart' way: let say if ENOTSUP is returned, then try to disable all HW offloads and do all in SW. But again, it is much better to do so *before* submitting packets for TX, so in practice everyone just drop such 'bad' packets.
Dropping the packets might not be an option, e.g. for applications used in life support or tele-medicine.
Critical applications should be able to do all Tx offloads in SW and retry. Of course, various statistics and logs should help to improve the application.
Quoted 1 line
If the packet is 'bad', then it is much better to drop it, then TX corrupted packet or even hang NIC HW completely.
IMHO Tx burst must drop packet which could hang NIC HW completely. I realize that it is an extra checks and performance drop, but vendor should pay in performance if HW is not good enough.
Quoted 2 lines
Though off-course it is much better to have an app that would check for limitations that can be checked by API provided and enable only supported offloads.
Yes, that's why API to get limitation is much better than documentation.
Quoted 1 line
Quoted 1 line
If limitations are documented, an application can use the lowest common denominator of the NICs it supports. And if the
application is
Quoted 8 lines
Quoted 1 line
supposed to work in general, that becomes the lowest common denominator of all NICs.
I agree: for limitations that can be extracted with generic API, like:
number of segments per packet, supported TX offloads, mbuf fileds that must be provided for each TX offload, etc. - it is responsibility of well-written application to obey all of them.
Yes, manytx_prepare()implementations do such checks anyway, but from my perspective it is sort of last-line of defense. For well written application that should just never happen.
But there is one more important responsibility oftx_prepare()- it performs PMD specific packet modifications for requestedoffloads.
Quoted 5 lines
As I already mentioned for Intel NICs - it does pseudo-header cksum calcucation, for packets with size less then minimal, it can probably do padding (even if doesn't do it right now), for some other PMDs - might be something else, I didn't check. Obviously it saves app developer from a burden to do all these things on his own.
Quoted 1 line
It looks like
tx_prepare()has become a horrible workaround for undocumented limitations.I strongly disagree. Documentation is never a solution for a generic application which is intended to work on any HW and IMHO it is the goal to have more and more applications which work on any HW.
Quoted 5 lines
Quoted 2 lines
Limitations due to hardware and/or software tradeoffs are unavoidable, so we have to live with them; but we should not accept PMDs with undocumented limitations.
As I already said, more documentation never hurts, but for that case, I think it is not enough. I expect PMD to provide a
tx_prepare()implementation that would deal with such specific things.+1
Quoted 6 lines
Anyway, back to the original patch - I looked at it once again, and realized that the problem is just in the unsupported number of segments.
As we discussed above - such limitations should be handled by well written app, but none of DPDK apps does it right now.
So probably it is good opportunity to do things in a proper way and introduce such checks in testpmd ;)
Quoted 6 lines
+1 since we already have fields in device information to report such limitations, but it does not say that Tx prepare should be dropped. Drivers which don't need Tx prepare keep it NULL and it returns immediately from ethdev. Since it is done per-burst, it should not affect performance a lot.
100% agree. I think tx_prepare needs to stay, and in general has to be strongly recommended for apps that do use TX offloads/multi-segs.
Quoted 120 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will
cause
Quoted 2 lines
Quoted 2 lines
Quoted 1 line
Quoted 1 line
MDD event if txonly forwarding engine does not call the Tx
preparation
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 2 lines
API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case
may
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
impact performance for users.
What happens when driver throws MDD (Malicious Driver
Detection)
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 2 lines
Quoted 2 lines
event,
Quoted 1 line
can't it be ignored? As you are already OK to drop the packet,
can
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
device be configured to drop these packages?
Or as Jerin suggested adding a new forwarding engine is a
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
solution,
Quoted 2 lines
Quoted 2 lines
but
Quoted 1 line
that will create code duplication, I prefer to not have it if
this
Quoted 4 lines
Quoted 4 lines
can
Quoted 1 line
be handled in device level.
Actually I am agree with the author of the patch - when TX
offloads
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 3 lines
and/or multisegs are enabled,
user supposed to invokeeth_tx_prepare().
Not doing that seems like a bug to me.I strongly disagree with that statement, Konstantin! It is not documented anywhere that using TX offloads and/or
multisegs
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
requires calling
rte_eth_tx_prepare()beforeQuoted 1 line
rte_eth_tx_burst(). And none of the examples do it.In fact, we do use it for
test-pmd/csumonly.c.
About other sample apps:
AFAIK, not many of other DPDK apps do use L4 offloads. Right now special treatment (pseudo-header cksum calculation) isneeded
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
only for L4 offloads (CKSUM, SEG).
So, majority of our apps who rely on other TX offloads (multi-seg,ipv4
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
cksum, vlan insertion) happily run without
callingtx_prepare(), even though it is not the safest way.Quoted 3 lines
In my opinion:
If some driver has limitations for a feature, e.g. max 8fragments,
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
it should be documented for that driver, so the application
Quoted 1 line
developer can make the appropriate decisions when designing the
application.
Quoted 1 line
Furthermore, we have APIs for the drivers to expose to the
applications what the driver supports, so the application can
configure
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
itself optimally at startup. Perhaps those APIs need to be
expanded.
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
And if a feature limitation is common across the majority of
drivers,
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
that limitation should be mentioned in the documentation of the
Quoted 1 line
feature itself.
Many of such limitations *are* documented and in fact we do have
an API
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 2 lines
to check max segments that each driver support, see struct
rte_eth_desc_lim.Yes, this is the kind of API we should provide, so the application
can configure itself appropriately.
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
The problem is:
- none of our sample app does proper check on these values, sousers
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 1 line
don't have a good example how to do it.
Agreed.
Adding an example showing how to do it properly would be the bestsolution.
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Calling
tx_prepare()in the examples is certainly not the solution.Quoted 3 lines
- with current DPDK API not all of HW/PMD requirements could be extracted programmatically:
let say majority of Intel PMDs for TCP offloads expect pseudo-header
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 1 line
cksum to be pre-calculated by the SW.
I hope this requirement is documented somewhere.
Quoted 2 lines
another example, some HW expects
pkt_lento be bigger then some
threshold value, otherwise HW hang may appear.Quoted 9 lines
Quoted 3 lines
Quoted 1 line
I hope this requirement is also documented somewhere.
No idea, I found it only in the code.
IMHO Tx burst must check such limitations. If you made your HW simpler (or just lost it on initial testing), pay in your drivers (or your HW+driver will be unusable because of such problems).
Quoted 1 line
Quoted 1 line
Generally, if the requirements cannot be extracted
programmatically, they must be prominently documented, like this note to
Quoted 5 lines
Quoted 5 lines
Quoted 1 line
rte_eth_rx_burst():Obviously, more detailed documentation is always good, but... Right now we have 50+ different PMDs from different vendors. Even if each and every of them will carefully document all possible
limitations and necessary preparation steps,
Quoted 2 lines
Quoted 2 lines
how DPDK app developer supposed to deal with all that? Do you expect everyone, to read carefully through all of them, and
handle all of them properly oh his own
Quoted 3 lines
Quoted 3 lines
in each and every DPDK app he is going to write?
That seems unrealistic.
Again what to do with backward compatibility: when new driver (withnew limitations) will arise
Quoted 12 lines
Quoted 7 lines
Quoted 1 line
*after* your app is already written and tested?
+1
Quoted 3 lines
Quoted 3 lines
* @note
* Some drivers using vector instructions require that *nb_pkts*is
Quoted 4 lines
Quoted 1 line
Quoted 1 line
* divisible by 4 or 8, depending on the driver implementation.
I'm wondering what application should do if it needs to send just one packet and do it now. IMHO, such limitations are not acceptable.
This common limitation for vector drivers is for RX burst, not TX burst. I agree such a limitation would be unacceptable for TX.
Quoted 118 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
- As new HW and PMD keep appearing it is hard to predict what
extra
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
limitations/requirements will arise,
that's whytx_prepare()was introduced as s driver op.Quoted 2 lines
We don't want to check in the fast path what can be checked at
startup or build time!
If your app supposed to work with just a few, known in advance,
NIC
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
models, then sure, you can do that.
For apps that supposed to work 'in general' with any possiblePMDs
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
that DPDK supports - that might be a problem. That's why
tx_prepare()was introduced and it is stronglyrecommended
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
to use it by the apps that do use TX offloads.
Probablytx_prepare()is not the best possible approach, but rightnow
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 1 line
there are not many alternatives within DPDK.
What exactly is an application supposed to do if
tx_prepare()doesn't accept the full burst? It doesn't return information about
Quoted 4 lines
what is
Quoted 3 lines
Quoted 1 line
wrong.
It provides some information, but it is *very* limited: just index
of 'bad' packet and error code.
Quoted 1 line
Quoted 1 line
In theory app can try to handle it in a 'smart' way: let say if
ENOTSUP is returned, then try to disable all HW offloads
Quoted 1 line
Quoted 1 line
and do all in SW. But again, it is much better to do so *before*
submitting packets for TX, so in practice everyone
Quoted 3 lines
Quoted 3 lines
just drop such 'bad' packets.
Dropping the packets might not be an option, e.g. for applications
used in life support or tele-medicine.
Quoted 3 lines
Critical applications should be able to do all Tx offloads in SW and retry. Of course, various statistics and logs should help to improve
the
Quoted 3 lines
application.
Quoted 1 line
If the packet is 'bad', then it is much better to drop it, then TX
corrupted packet or even hang NIC HW completely.
Quoted 6 lines
IMHO Tx burst must drop packet which could hang NIC HW completely. I realize that it is an extra checks and performance drop, but vendor should pay in performance if HW is not good enough.
Quoted 1 line
Though off-course it is much better to have an app that would check
for limitations that can be checked by API provided
Quoted 3 lines
Quoted 1 line
and enable only supported offloads.
Yes, that's why API to get limitation is much better than
documentation.
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
If limitations are documented, an application can use the lowest
common denominator of the NICs it supports. And if the
Quoted 2 lines
application is
Quoted 1 line
Quoted 1 line
supposed to work in general, that becomes the lowest common
denominator of all NICs.
Quoted 2 lines
Quoted 2 lines
I agree: for limitations that can be extracted with generic API,
like:
Quoted 1 line
Quoted 1 line
number of segments per packet, supported TX offloads, mbuf fileds
that must be provided for each TX offload, etc. -
Quoted 1 line
Quoted 1 line
it is responsibility of well-written application to obey all of
them.
Quoted 1 line
Quoted 1 line
Yes, many
tx_prepare()implementations do such checks anyway, butfrom my perspective it is sort of last-line of defense.
Quoted 2 lines
Quoted 2 lines
For well written application that should just never happen. But there is one more important responsibility of
tx_prepare()- itperforms PMD specific packet modifications for requested
Quoted 2 lines
offloads.
Quoted 1 line
As I already mentioned for Intel NICs - it does pseudo-header cksum
calcucation, for packets with size less then minimal, it can
Quoted 1 line
Quoted 1 line
probably do padding (even if doesn't do it right now), for some
other PMDs - might be something else, I didn't check.
Quoted 1 line
Quoted 1 line
Obviously it saves app developer from a burden to do all these
things on his own.
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
It looks like
tx_prepare()has become a horrible workaround forundocumented limitations.
Quoted 6 lines
I strongly disagree. Documentation is never a solution for a generic application which is intended to work on any HW and IMHO it is the goal to have more and more applications which work on any HW.
Quoted 1 line
Quoted 1 line
Limitations due to hardware and/or software tradeoffs are
unavoidable, so we have to live with them; but we should not accept
Quoted 3 lines
Quoted 3 lines
Quoted 1 line
PMDs with undocumented limitations.
As I already said, more documentation never hurts, but for that
case, I think it is not enough.
Quoted 1 line
Quoted 1 line
I expect PMD to provide a
tx_prepare()implementation that woulddeal with such specific things.
Quoted 3 lines
+1
Quoted 1 line
Anyway, back to the original patch - I looked at it once again, and
realized that the problem
Quoted 2 lines
Quoted 2 lines
is just in the unsupported number of segments.
As we discussed above - such limitations should be handled by wellwritten app,
Quoted 2 lines
Quoted 2 lines
but none of DPDK apps does it right now.
So probably it is good opportunity to do things in a proper way andintroduce such checks
Quoted 8 lines
Quoted 1 line
in testpmd ;)
+1 since we already have fields in device information to report such limitations, but it does not say that Tx prepare should be dropped. Drivers which don't need Tx prepare keep it NULL and it returns immediately from ethdev. Since it is done per-burst, it should not affect performance a lot.
Quoted 3 lines
100% agree. I think
tx_prepareneeds to stay, and in general has to be strongly recommended
for apps that do use TX offloads/multi-segs.
<irony>
Then tx_prepare should randomly reject packets and segments, to ensure the application has sufficient SW fallback implemented. </irony>
No, seriously, considering the above arguments, I think PMD conformance requirements would be a better solution. If a PMD claims support for some feature, it must conform to some minimum requirements for that feature.
E.g. support for multi-seg TX must be able to handle min. 8 segments (or some other reasonable number).
Common limitations and preconditions, such as minimum RX burst size for vector drivers and pseudo-header checksum precalculation for TCP offload, should be accepted and prominently documented.
Unusual HW limitations, such as inability to pad short Ethernet frames, should be handled by the driver's TX function as workarounds for unacceptable limitations (in DPDK API context) in the HW.
Quoted 262 lines
Subject: RE: [PATCH v2] app/testpmd: use Tx preparation in txonly engine
Quoted 120 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will
cause
Quoted 2 lines
Quoted 2 lines
Quoted 1 line
Quoted 1 line
MDD event if txonly forwarding engine does not call the Tx
preparation
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 2 lines
API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case
may
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
impact performance for users.
What happens when driver throws MDD (Malicious Driver
Detection)
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 2 lines
Quoted 2 lines
event,
Quoted 1 line
can't it be ignored? As you are already OK to drop the packet,
can
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
device be configured to drop these packages?
Or as Jerin suggested adding a new forwarding engine is a
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
solution,
Quoted 2 lines
Quoted 2 lines
but
Quoted 1 line
that will create code duplication, I prefer to not have it if
this
Quoted 4 lines
Quoted 4 lines
can
Quoted 1 line
be handled in device level.
Actually I am agree with the author of the patch - when TX
offloads
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 3 lines
and/or multisegs are enabled,
user supposed to invokeeth_tx_prepare().
Not doing that seems like a bug to me.I strongly disagree with that statement, Konstantin! It is not documented anywhere that using TX offloads and/or
multisegs
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
requires calling
rte_eth_tx_prepare()beforeQuoted 1 line
rte_eth_tx_burst(). And none of the examples do it.In fact, we do use it for
test-pmd/csumonly.c.
About other sample apps:
AFAIK, not many of other DPDK apps do use L4 offloads. Right now special treatment (pseudo-header cksum calculation) isneeded
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
only for L4 offloads (CKSUM, SEG).
So, majority of our apps who rely on other TX offloads (multi-seg,ipv4
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
cksum, vlan insertion) happily run without
callingtx_prepare(), even though it is not the safest way.Quoted 3 lines
In my opinion:
If some driver has limitations for a feature, e.g. max 8fragments,
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
it should be documented for that driver, so the application
Quoted 1 line
developer can make the appropriate decisions when designing the
application.
Quoted 1 line
Furthermore, we have APIs for the drivers to expose to the
applications what the driver supports, so the application can
configure
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
itself optimally at startup. Perhaps those APIs need to be
expanded.
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
And if a feature limitation is common across the majority of
drivers,
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
that limitation should be mentioned in the documentation of the
Quoted 1 line
feature itself.
Many of such limitations *are* documented and in fact we do have
an API
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 2 lines
to check max segments that each driver support, see struct
rte_eth_desc_lim.Yes, this is the kind of API we should provide, so the application
can configure itself appropriately.
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
The problem is:
- none of our sample app does proper check on these values, sousers
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 1 line
don't have a good example how to do it.
Agreed.
Adding an example showing how to do it properly would be the bestsolution.
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Calling
tx_prepare()in the examples is certainly not the solution.Quoted 3 lines
- with current DPDK API not all of HW/PMD requirements could be extracted programmatically:
let say majority of Intel PMDs for TCP offloads expect pseudo-header
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 1 line
cksum to be pre-calculated by the SW.
I hope this requirement is documented somewhere.
Quoted 2 lines
another example, some HW expects
pkt_lento be bigger then some
threshold value, otherwise HW hang may appear.Quoted 9 lines
Quoted 3 lines
Quoted 1 line
I hope this requirement is also documented somewhere.
No idea, I found it only in the code.
IMHO Tx burst must check such limitations. If you made your HW simpler (or just lost it on initial testing), pay in your drivers (or your HW+driver will be unusable because of such problems).
Quoted 1 line
Quoted 1 line
Generally, if the requirements cannot be extracted
programmatically, they must be prominently documented, like this note to
Quoted 5 lines
Quoted 5 lines
Quoted 1 line
rte_eth_rx_burst():Obviously, more detailed documentation is always good, but... Right now we have 50+ different PMDs from different vendors. Even if each and every of them will carefully document all possible
limitations and necessary preparation steps,
Quoted 2 lines
Quoted 2 lines
how DPDK app developer supposed to deal with all that? Do you expect everyone, to read carefully through all of them, and
handle all of them properly oh his own
Quoted 3 lines
Quoted 3 lines
in each and every DPDK app he is going to write?
That seems unrealistic.
Again what to do with backward compatibility: when new driver (withnew limitations) will arise
Quoted 12 lines
Quoted 7 lines
Quoted 1 line
*after* your app is already written and tested?
+1
Quoted 3 lines
Quoted 3 lines
* @note
* Some drivers using vector instructions require that *nb_pkts*is
Quoted 4 lines
Quoted 1 line
Quoted 1 line
* divisible by 4 or 8, depending on the driver implementation.
I'm wondering what application should do if it needs to send just one packet and do it now. IMHO, such limitations are not acceptable.
This common limitation for vector drivers is for RX burst, not TX burst. I agree such a limitation would be unacceptable for TX.
Quoted 118 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
- As new HW and PMD keep appearing it is hard to predict what
extra
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
limitations/requirements will arise,
that's whytx_prepare()was introduced as s driver op.Quoted 2 lines
We don't want to check in the fast path what can be checked at
startup or build time!
If your app supposed to work with just a few, known in advance,
NIC
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
models, then sure, you can do that.
For apps that supposed to work 'in general' with any possiblePMDs
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
that DPDK supports - that might be a problem. That's why
tx_prepare()was introduced and it is stronglyrecommended
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
to use it by the apps that do use TX offloads.
Probablytx_prepare()is not the best possible approach, but rightnow
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 1 line
there are not many alternatives within DPDK.
What exactly is an application supposed to do if
tx_prepare()doesn't accept the full burst? It doesn't return information about
Quoted 4 lines
what is
Quoted 3 lines
Quoted 1 line
wrong.
It provides some information, but it is *very* limited: just index
of 'bad' packet and error code.
Quoted 1 line
Quoted 1 line
In theory app can try to handle it in a 'smart' way: let say if
ENOTSUP is returned, then try to disable all HW offloads
Quoted 1 line
Quoted 1 line
and do all in SW. But again, it is much better to do so *before*
submitting packets for TX, so in practice everyone
Quoted 3 lines
Quoted 3 lines
just drop such 'bad' packets.
Dropping the packets might not be an option, e.g. for applications
used in life support or tele-medicine.
Quoted 3 lines
Critical applications should be able to do all Tx offloads in SW and retry. Of course, various statistics and logs should help to improve
the
Quoted 3 lines
application.
Quoted 1 line
If the packet is 'bad', then it is much better to drop it, then TX
corrupted packet or even hang NIC HW completely.
Quoted 6 lines
IMHO Tx burst must drop packet which could hang NIC HW completely. I realize that it is an extra checks and performance drop, but vendor should pay in performance if HW is not good enough.
Quoted 1 line
Though off-course it is much better to have an app that would check
for limitations that can be checked by API provided
Quoted 3 lines
Quoted 1 line
and enable only supported offloads.
Yes, that's why API to get limitation is much better than
documentation.
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
If limitations are documented, an application can use the lowest
common denominator of the NICs it supports. And if the
Quoted 2 lines
application is
Quoted 1 line
Quoted 1 line
supposed to work in general, that becomes the lowest common
denominator of all NICs.
Quoted 2 lines
Quoted 2 lines
I agree: for limitations that can be extracted with generic API,
like:
Quoted 1 line
Quoted 1 line
number of segments per packet, supported TX offloads, mbuf fileds
that must be provided for each TX offload, etc. -
Quoted 1 line
Quoted 1 line
it is responsibility of well-written application to obey all of
them.
Quoted 1 line
Quoted 1 line
Yes, many
tx_prepare()implementations do such checks anyway, butfrom my perspective it is sort of last-line of defense.
Quoted 2 lines
Quoted 2 lines
For well written application that should just never happen. But there is one more important responsibility of
tx_prepare()- itperforms PMD specific packet modifications for requested
Quoted 2 lines
offloads.
Quoted 1 line
As I already mentioned for Intel NICs - it does pseudo-header cksum
calcucation, for packets with size less then minimal, it can
Quoted 1 line
Quoted 1 line
probably do padding (even if doesn't do it right now), for some
other PMDs - might be something else, I didn't check.
Quoted 1 line
Quoted 1 line
Obviously it saves app developer from a burden to do all these
things on his own.
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
It looks like
tx_prepare()has become a horrible workaround forundocumented limitations.
Quoted 6 lines
I strongly disagree. Documentation is never a solution for a generic application which is intended to work on any HW and IMHO it is the goal to have more and more applications which work on any HW.
Quoted 1 line
Quoted 1 line
Limitations due to hardware and/or software tradeoffs are
unavoidable, so we have to live with them; but we should not accept
Quoted 3 lines
Quoted 3 lines
Quoted 1 line
PMDs with undocumented limitations.
As I already said, more documentation never hurts, but for that
case, I think it is not enough.
Quoted 1 line
Quoted 1 line
I expect PMD to provide a
tx_prepare()implementation that woulddeal with such specific things.
Quoted 3 lines
+1
Quoted 1 line
Anyway, back to the original patch - I looked at it once again, and
realized that the problem
Quoted 2 lines
Quoted 2 lines
is just in the unsupported number of segments.
As we discussed above - such limitations should be handled by wellwritten app,
Quoted 2 lines
Quoted 2 lines
but none of DPDK apps does it right now.
So probably it is good opportunity to do things in a proper way andintroduce such checks
Quoted 8 lines
Quoted 1 line
in testpmd ;)
+1 since we already have fields in device information to report such limitations, but it does not say that Tx prepare should be dropped. Drivers which don't need Tx prepare keep it NULL and it returns immediately from ethdev. Since it is done per-burst, it should not affect performance a lot.
Quoted 3 lines
100% agree. I think
tx_prepareneeds to stay, and in general has to be strongly recommended
for apps that do use TX offloads/multi-segs.
Quoted 8 lines
<irony>
Thentx_prepareshould randomly reject packets and segments, to ensure the application has sufficient SW fallback implemented. </irony>No, seriously, considering the above arguments, I think PMD conformance requirements would be a better solution. If a PMD claims support for some feature, it must conform to some minimum requirements for that feature.
E.g. support for multi-seg TX must be able to handle min. 8 segments (or some other reasonable number).
Hmm... why is that?
I thought we had a consensus here that good behaving app should use existing API (rte_eth_desc_lim) to deduce min common denominator, and that we need some code example, or even better a lib function that would do such thing.
Quoted 3 lines
Common limitations and preconditions, such as minimum RX burst size for vector drivers and pseudo-header checksum precalculation for TCP offload, should be accepted and prominently documented.
I still don't understand why these preconditions can't be done by tx_prepare().
Quoted 2 lines
Unusual HW limitations, such as inability to pad short Ethernet frames, should be handled by the driver's TX function as workarounds for unacceptable limitations (in DPDK API context) in the HW.
With current design, rte_eth_tx_burst() is not allowed to modify mbufs whose refcnt > 1. That's one of the reason why tx_prepare() was introduced.
Quoted 14 lines · Ferruh Yigit
Quoted 8 lines · Kaiwen Deng
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case may impact performance for users.
Quoted 7 lines
What happens when driver throws MDD (Malicious Driver Detection) event, can't it be ignored? As you are already OK to drop the packet, can device be configured to drop these packages?
Or as Jerin suggested adding a new forwarding engine is a solution, but that will create code duplication, I prefer to not have it if this can
We don't need to have full-blown NEW need forwarding engine. Just that, we need to select correct ".packet_fwd" based on the offload requirements.
It is easy to avoid code duplication by following without performance impact by moving the logic to compile time and use runtime to fix up
static inline generic_tx_only_packet_forward(...., const unsigned flag) {
#logic common for both packet forward
#if (flag & NEED_PREPARE)
prepare specific code
}
staticgeneric_tx_only_packet_forward_without_prepare()
{generic_tx_only_packet_forward(..., 0);
}
static generic_tx_only_packet_forward_with_prepare() {generic_tx_only_packet_forward(..., NEED_PREPARE); }
Select the correct .packet_fwd inruntime(generic_tx_only_packet_forward_without_prepare() vs generic_tx_only_packet_forward_with_prepare())
Quoted 2 lines
be handled in device level.
Quoted 52 lines · Jerin Jacob
Quoted 14 lines · Ferruh Yigit
Quoted 8 lines · Kaiwen Deng
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
txonly is used commonly, adding Tx prepare for a specific case may impact performance for users.
Quoted 7 lines
What happens when driver throws MDD (Malicious Driver Detection) event, can't it be ignored? As you are already OK to drop the packet, can device be configured to drop these packages?
Or as Jerin suggested adding a new forwarding engine is a solution, but that will create code duplication, I prefer to not have it if this can
We don't need to have full-blown NEW need forwarding engine. Just that, we need to select correct ".packet_fwd" based on the offload requirements.
It is easy to avoid code duplication by following without performance impact by moving the logic to compile time and use runtime to fix up
static inline
generic_tx_only_packet_forward(...., const unsigned flag){#logic common for both packet forward
#if (flag &NEED_PREPARE)
prepare specific code}
static
generic_tx_only_packet_forward_without_prepare()
{generic_tx_only_packet_forward(..., 0);
}static
generic_tx_only_packet_forward_with_prepare(){generic_tx_only_packet_forward(..., NEED_PREPARE); }
Quoted 4 lines
Select the correct .packet_fwd in
runtime(generic_tx_only_packet_forward_without_prepare() vs generic_tx_only_packet_forward_with_prepare())
+1 to not duplicate code, and I guess we can get requested mode as testpmd parameter, but how can we avoid from performance impact,
checking mode in the .packet_fwd brings additional check per burst, and we can't overwrite .packet_fwd.
Quoted 45 lines · On Wed, 3 Jan 2024 09:29:12 +0800 Kaiwen Deng <[email protected]> wrote:
Txonly forwarding engine does not call the Tx preparation API before transmitting packets. This may cause some problems.
TSO breaks when MSS spans more than 8 data fragments. Those packets will be dropped by Tx preparation API, but it will cause MDD event if txonly forwarding engine does not call the Tx preparation API before transmitting packets.
We can reproduce this issue by these steps list blow on ICE and I40e.
./x86_64-native-linuxapp-gcc/app/dpdk-testpmd -c
0xf-n 4 -- -i --tx-offloads=0x00008000testpmd>set txpkts 64,128,256,512,64,128,256,512,512 testpmd>set burst 1
testpmd>starttx_first1This commit will use Tx preparation API in txonly forwarding engine.
Fixes 655131ccf727 ("app/testpmd: factorize fwd engines Tx")Signed-off-by Kaiwen Deng <[email protected]>--- app/test-pmd/txonly.c | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-)app/test-pmd/txonly.c +2
-1@@ -339,6 +339,7 @@ pkt_burst_transmit(struct fwd_stream *fs)struct rte_ether_hdr eth_hdr;uint16_t nb_tx;uint16_t nb_pkt; +uint16_t nb_prep;uint16_t vlan_tci, vlan_tci_outer;uint64_t ol_flags =0 ;uint64_t tx_offloads;@@ -396,7 +397,17 @@ pkt_burst_transmit(struct fwd_stream *fs)if (nb_pkt ==0 )return false; - nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_pkt); + nb_prep = rte_eth_tx_prepare(fs->tx_port, fs->tx_queue,
app/test-pmd/txonly.c pkt_burst_transmit(struct fwd_stream *fs) · line 410
Quoted 10 lines
app/test-pmd/txonly.c +10
-0+ pkts_burst, nb_pkt); +if (unlikely (nb_prep != nb_pkt)) { +fprintf (stderr, +"Preparing packet burst to transmit failed: %s\n" , +rte_strerror (rte_errno)); + fs->fwd_dropped += (nb_pkt - nb_prep); +rte_pktmbuf_free_bulk (&pkts_burst[nb_prep], nb_pkt - nb_prep); + } + + nb_tx =common_fwd_stream_transmit (fs, pkts_burst, nb_prep);
The comment section on this patch raises lots of good points.
1. Testpmd and example applications are not calling tx_prepare.
2. Testpmd and examples are not checking descriptor limits.
3. It is not clear from documentation when tx_prepare is required.
On a practical level, if testpmd was being used in txonly mode, if the condition ever triggered, you really really don't want to print a message there since it would likely be endless stream of messages.
Please consider the comments and come back with a better solution in v2.