* [dpdk-dev] [PATCH] net: fix checksum API documentation
@ 2021-09-16 16:10 Lance Richardson
2021-09-17 10:57 ` Morten Brørup
2021-09-21 14:59 ` [dpdk-dev] [PATCH v2] " Lance Richardson
0 siblings, 2 replies; 9+ messages in thread
From: Lance Richardson @ 2021-09-16 16:10 UTC (permalink / raw)
To: Olivier Matz, Konstantin Ananyev, Morten Brørup, Andrew Rybchenko
Cc: dev, stable
[-- Attachment #1: Type: text/plain, Size: 1639 bytes --]
Minor corrections and improvements to documentation
for checksum APIs.
Fixes: 6006818cfb26 ("net: new checksum functions")
Fixes: 45a08ef55e44 ("net: introduce functions to verify L4 checksums")
Cc: stable@dpdk.org
Signed-off-by: Lance Richardson <lance.richardson@broadcom.com>
---
lib/net/rte_ip.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/lib/net/rte_ip.h b/lib/net/rte_ip.h
index 05948b69b7..fd08ea31b2 100644
--- a/lib/net/rte_ip.h
+++ b/lib/net/rte_ip.h
@@ -488,7 +488,7 @@ rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
}
/**
- * @internal Calculate the non-complemented IPv4 L4 checksum
+ * @internal Calculate the non-complemented IPv6 L4 checksum
*/
static inline uint16_t
__rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
@@ -509,15 +509,15 @@ __rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
/**
* Process the IPv6 UDP or TCP checksum.
*
- * The IPv4 header should not contains options. The layer 4 checksum
- * must be set to 0 in the packet by the caller.
+ * The IPv6 header must not be followed by extension headers. The layer 4
+ * checksum must be set to 0 in the L4 header by the caller.
*
* @param ipv6_hdr
* The pointer to the contiguous IPv6 header.
* @param l4_hdr
* The pointer to the beginning of the L4 header.
* @return
- * The complemented checksum to set in the IP packet.
+ * The complemented checksum to set in the L4 header.
*/
static inline uint16_t
rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
--
2.25.1
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [PATCH] net: fix checksum API documentation
2021-09-16 16:10 [dpdk-dev] [PATCH] net: fix checksum API documentation Lance Richardson
@ 2021-09-17 10:57 ` Morten Brørup
2021-09-21 9:28 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
2021-09-21 14:59 ` [dpdk-dev] [PATCH v2] " Lance Richardson
1 sibling, 1 reply; 9+ messages in thread
From: Morten Brørup @ 2021-09-17 10:57 UTC (permalink / raw)
To: Lance Richardson
Cc: dev, stable, Olivier Matz, Konstantin Ananyev, Andrew Rybchenko
> From: Lance Richardson [mailto:lance.richardson@broadcom.com]
> Sent: Thursday, 16 September 2021 18.11
>
> Minor corrections and improvements to documentation
> for checksum APIs.
>
> Fixes: 6006818cfb26 ("net: new checksum functions")
> Fixes: 45a08ef55e44 ("net: introduce functions to verify L4 checksums")
> Cc: stable@dpdk.org
> Signed-off-by: Lance Richardson <lance.richardson@broadcom.com>
> ---
> lib/net/rte_ip.h | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/lib/net/rte_ip.h b/lib/net/rte_ip.h
> index 05948b69b7..fd08ea31b2 100644
> --- a/lib/net/rte_ip.h
> +++ b/lib/net/rte_ip.h
> @@ -488,7 +488,7 @@ rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr
> *ipv6_hdr, uint64_t ol_flags)
> }
>
> /**
> - * @internal Calculate the non-complemented IPv4 L4 checksum
> + * @internal Calculate the non-complemented IPv6 L4 checksum
> */
> static inline uint16_t
> __rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const
> void *l4_hdr)
> @@ -509,15 +509,15 @@ __rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr
> *ipv6_hdr, const void *l4_hdr)
> /**
> * Process the IPv6 UDP or TCP checksum.
> *
> - * The IPv4 header should not contains options. The layer 4 checksum
> - * must be set to 0 in the packet by the caller.
> + * The IPv6 header must not be followed by extension headers. The
> layer 4
> + * checksum must be set to 0 in the L4 header by the caller.
> *
> * @param ipv6_hdr
> * The pointer to the contiguous IPv6 header.
> * @param l4_hdr
> * The pointer to the beginning of the L4 header.
> * @return
> - * The complemented checksum to set in the IP packet.
> + * The complemented checksum to set in the L4 header.
> */
> static inline uint16_t
> rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void
> *l4_hdr)
> --
> 2.25.1
Reviewed-by: Morten Brørup <mb@smartsharesystems.com>
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [dpdk-stable] [PATCH] net: fix checksum API documentation
2021-09-17 10:57 ` Morten Brørup
@ 2021-09-21 9:28 ` Ferruh Yigit
2021-09-21 10:11 ` Morten Brørup
0 siblings, 1 reply; 9+ messages in thread
From: Ferruh Yigit @ 2021-09-21 9:28 UTC (permalink / raw)
To: Morten Brørup, Lance Richardson
Cc: dev, stable, Olivier Matz, Konstantin Ananyev, Andrew Rybchenko
On 9/17/2021 11:57 AM, Morten Brørup wrote:
>> From: Lance Richardson [mailto:lance.richardson@broadcom.com]
>> Sent: Thursday, 16 September 2021 18.11
>>
>> Minor corrections and improvements to documentation
>> for checksum APIs.
>>
>> Fixes: 6006818cfb26 ("net: new checksum functions")
>> Fixes: 45a08ef55e44 ("net: introduce functions to verify L4 checksums")
>> Cc: stable@dpdk.org
>> Signed-off-by: Lance Richardson <lance.richardson@broadcom.com>
>> ---
>> lib/net/rte_ip.h | 8 ++++----
>> 1 file changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/lib/net/rte_ip.h b/lib/net/rte_ip.h
>> index 05948b69b7..fd08ea31b2 100644
>> --- a/lib/net/rte_ip.h
>> +++ b/lib/net/rte_ip.h
>> @@ -488,7 +488,7 @@ rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr
>> *ipv6_hdr, uint64_t ol_flags)
>> }
>>
>> /**
>> - * @internal Calculate the non-complemented IPv4 L4 checksum
>> + * @internal Calculate the non-complemented IPv6 L4 checksum
>> */
>> static inline uint16_t
>> __rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const
>> void *l4_hdr)
>> @@ -509,15 +509,15 @@ __rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr
>> *ipv6_hdr, const void *l4_hdr)
>> /**
>> * Process the IPv6 UDP or TCP checksum.
>> *
>> - * The IPv4 header should not contains options. The layer 4 checksum
>> - * must be set to 0 in the packet by the caller.
>> + * The IPv6 header must not be followed by extension headers. The
>> layer 4
>> + * checksum must be set to 0 in the L4 header by the caller.
>> *
>> * @param ipv6_hdr
>> * The pointer to the contiguous IPv6 header.
>> * @param l4_hdr
>> * The pointer to the beginning of the L4 header.
>> * @return
>> - * The complemented checksum to set in the IP packet.
>> + * The complemented checksum to set in the L4 header.
Isn't this wrong for 'rte_ipv4_udptcp_cksum()' too? Since you are touching this,
can you fix that one too?
>> */
>> static inline uint16_t
>> rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void
>> *l4_hdr)
>> --
>> 2.25.1
>
> Reviewed-by: Morten Brørup <mb@smartsharesystems.com>
>
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [dpdk-stable] [PATCH] net: fix checksum API documentation
2021-09-21 9:28 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
@ 2021-09-21 10:11 ` Morten Brørup
2021-09-21 14:50 ` Lance Richardson
0 siblings, 1 reply; 9+ messages in thread
From: Morten Brørup @ 2021-09-21 10:11 UTC (permalink / raw)
To: Ferruh Yigit, Lance Richardson
Cc: dev, stable, Olivier Matz, Konstantin Ananyev, Andrew Rybchenko
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit
> Sent: Tuesday, 21 September 2021 11.28
>
> On 9/17/2021 11:57 AM, Morten Brørup wrote:
> >> From: Lance Richardson [mailto:lance.richardson@broadcom.com]
> >> Sent: Thursday, 16 September 2021 18.11
> >>
> >> Minor corrections and improvements to documentation
> >> for checksum APIs.
> >>
> >> Fixes: 6006818cfb26 ("net: new checksum functions")
> >> Fixes: 45a08ef55e44 ("net: introduce functions to verify L4
> checksums")
> >> Cc: stable@dpdk.org
> >> Signed-off-by: Lance Richardson <lance.richardson@broadcom.com>
> >> ---
> >> lib/net/rte_ip.h | 8 ++++----
> >> 1 file changed, 4 insertions(+), 4 deletions(-)
> >>
> >> diff --git a/lib/net/rte_ip.h b/lib/net/rte_ip.h
> >> index 05948b69b7..fd08ea31b2 100644
> >> --- a/lib/net/rte_ip.h
> >> +++ b/lib/net/rte_ip.h
> >> @@ -488,7 +488,7 @@ rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr
> >> *ipv6_hdr, uint64_t ol_flags)
> >> }
> >>
> >> /**
> >> - * @internal Calculate the non-complemented IPv4 L4 checksum
> >> + * @internal Calculate the non-complemented IPv6 L4 checksum
> >> */
> >> static inline uint16_t
> >> __rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const
> >> void *l4_hdr)
> >> @@ -509,15 +509,15 @@ __rte_ipv6_udptcp_cksum(const struct
> rte_ipv6_hdr
> >> *ipv6_hdr, const void *l4_hdr)
> >> /**
> >> * Process the IPv6 UDP or TCP checksum.
> >> *
> >> - * The IPv4 header should not contains options. The layer 4
> checksum
> >> - * must be set to 0 in the packet by the caller.
> >> + * The IPv6 header must not be followed by extension headers. The
> >> layer 4
> >> + * checksum must be set to 0 in the L4 header by the caller.
> >> *
> >> * @param ipv6_hdr
> >> * The pointer to the contiguous IPv6 header.
> >> * @param l4_hdr
> >> * The pointer to the beginning of the L4 header.
> >> * @return
> >> - * The complemented checksum to set in the IP packet.
> >> + * The complemented checksum to set in the L4 header.
>
> Isn't this wrong for 'rte_ipv4_udptcp_cksum()' too? Since you are
> touching this,
> can you fix that one too?
>
Ferruh, the description of the return value is technically correct; it mentions the IP packet, not the IP header.
So this change is a clarification only.
However, I agree that the same clarification would also benefit 'rte_ipv4_udptcp_cksum()'.
> >> */
> >> static inline uint16_t
> >> rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const
> void
> >> *l4_hdr)
> >> --
> >> 2.25.1
> >
> > Reviewed-by: Morten Brørup <mb@smartsharesystems.com>
> >
>
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [dpdk-stable] [PATCH] net: fix checksum API documentation
2021-09-21 10:11 ` Morten Brørup
@ 2021-09-21 14:50 ` Lance Richardson
0 siblings, 0 replies; 9+ messages in thread
From: Lance Richardson @ 2021-09-21 14:50 UTC (permalink / raw)
To: Morten Brørup
Cc: Ferruh Yigit, dev, dpdk stable, Olivier Matz, Konstantin Ananyev,
Andrew Rybchenko
[-- Attachment #1: Type: text/plain, Size: 588 bytes --]
On Tue, Sep 21, 2021 at 6:11 AM Morten Brørup <mb@smartsharesystems.com> wrote:
> Ferruh, the description of the return value is technically correct; it mentions the IP packet, not the IP header.
> So this change is a clarification only.
>
> However, I agree that the same clarification would also benefit 'rte_ipv4_udptcp_cksum()'.
>
Sure, will fix in v2.
Also for rte_ipv4_udptcp_cksum(), a comment says "The IP and layer 4
checksum must be set to zero", but only the layer 4 checksum actually
needs to be set to zero. I'll fix that at the same time.
Thanks,
Lance
^ permalink raw reply [flat|nested] 9+ messages in thread
* [dpdk-dev] [PATCH v2] net: fix checksum API documentation
2021-09-16 16:10 [dpdk-dev] [PATCH] net: fix checksum API documentation Lance Richardson
2021-09-17 10:57 ` Morten Brørup
@ 2021-09-21 14:59 ` Lance Richardson
2021-09-22 9:16 ` Ferruh Yigit
1 sibling, 1 reply; 9+ messages in thread
From: Lance Richardson @ 2021-09-21 14:59 UTC (permalink / raw)
To: Olivier Matz, Konstantin Ananyev, Andrew Rybchenko, Morten Brørup
Cc: dev, ferruh.yigit, stable
[-- Attachment #1: Type: text/plain, Size: 2378 bytes --]
Minor corrections and improvements to documentation
for checksum APIs.
Fixes: 6006818cfb26 ("net: new checksum functions")
Fixes: 45a08ef55e44 ("net: introduce functions to verify L4 checksums")
Cc: stable@dpdk.org
Signed-off-by: Lance Richardson <lance.richardson@broadcom.com>
---
v2:
- Updates for rte_ipv4_udptcp_cksum()
lib/net/rte_ip.h | 13 ++++++-------
1 file changed, 6 insertions(+), 7 deletions(-)
diff --git a/lib/net/rte_ip.h b/lib/net/rte_ip.h
index 05948b69b7..bc3dd44a4c 100644
--- a/lib/net/rte_ip.h
+++ b/lib/net/rte_ip.h
@@ -371,15 +371,14 @@ __rte_ipv4_udptcp_cksum(const struct rte_ipv4_hdr *ipv4_hdr, const void *l4_hdr)
/**
* Process the IPv4 UDP or TCP checksum.
*
- * The IP and layer 4 checksum must be set to 0 in the packet by
- * the caller.
+ * The layer 4 checksum must be set to 0 in the L4 header by the caller.
*
* @param ipv4_hdr
* The pointer to the contiguous IPv4 header.
* @param l4_hdr
* The pointer to the beginning of the L4 header.
* @return
- * The complemented checksum to set in the IP packet.
+ * The complemented checksum to set in the L4 header.
*/
static inline uint16_t
rte_ipv4_udptcp_cksum(const struct rte_ipv4_hdr *ipv4_hdr, const void *l4_hdr)
@@ -488,7 +487,7 @@ rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
}
/**
- * @internal Calculate the non-complemented IPv4 L4 checksum
+ * @internal Calculate the non-complemented IPv6 L4 checksum
*/
static inline uint16_t
__rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
@@ -509,15 +508,15 @@ __rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
/**
* Process the IPv6 UDP or TCP checksum.
*
- * The IPv4 header should not contains options. The layer 4 checksum
- * must be set to 0 in the packet by the caller.
+ * The IPv6 header must not be followed by extension headers. The layer 4
+ * checksum must be set to 0 in the L4 header by the caller.
*
* @param ipv6_hdr
* The pointer to the contiguous IPv6 header.
* @param l4_hdr
* The pointer to the beginning of the L4 header.
* @return
- * The complemented checksum to set in the IP packet.
+ * The complemented checksum to set in the L4 header.
*/
static inline uint16_t
rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
--
2.25.1
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [PATCH v2] net: fix checksum API documentation
2021-09-21 14:59 ` [dpdk-dev] [PATCH v2] " Lance Richardson
@ 2021-09-22 9:16 ` Ferruh Yigit
2021-09-27 16:14 ` Olivier Matz
0 siblings, 1 reply; 9+ messages in thread
From: Ferruh Yigit @ 2021-09-22 9:16 UTC (permalink / raw)
To: Lance Richardson, Olivier Matz, Konstantin Ananyev,
Andrew Rybchenko, Morten Brørup
Cc: dev, stable
On 9/21/2021 3:59 PM, Lance Richardson wrote:
> Minor corrections and improvements to documentation
> for checksum APIs.
>
> Fixes: 6006818cfb26 ("net: new checksum functions")
> Fixes: 45a08ef55e44 ("net: introduce functions to verify L4 checksums")
> Cc: stable@dpdk.org
> Signed-off-by: Lance Richardson <lance.richardson@broadcom.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [PATCH v2] net: fix checksum API documentation
2021-09-22 9:16 ` Ferruh Yigit
@ 2021-09-27 16:14 ` Olivier Matz
2021-10-07 12:43 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
0 siblings, 1 reply; 9+ messages in thread
From: Olivier Matz @ 2021-09-27 16:14 UTC (permalink / raw)
To: Ferruh Yigit
Cc: Lance Richardson, Konstantin Ananyev, Andrew Rybchenko,
Morten Brørup, dev, stable
On Wed, Sep 22, 2021 at 10:16:09AM +0100, Ferruh Yigit wrote:
> On 9/21/2021 3:59 PM, Lance Richardson wrote:
> > Minor corrections and improvements to documentation
> > for checksum APIs.
> >
> > Fixes: 6006818cfb26 ("net: new checksum functions")
> > Fixes: 45a08ef55e44 ("net: introduce functions to verify L4 checksums")
> > Cc: stable@dpdk.org
> > Signed-off-by: Lance Richardson <lance.richardson@broadcom.com>
>
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
Thanks!
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [dpdk-stable] [PATCH v2] net: fix checksum API documentation
2021-09-27 16:14 ` Olivier Matz
@ 2021-10-07 12:43 ` Ferruh Yigit
0 siblings, 0 replies; 9+ messages in thread
From: Ferruh Yigit @ 2021-10-07 12:43 UTC (permalink / raw)
To: Olivier Matz
Cc: Lance Richardson, Konstantin Ananyev, Andrew Rybchenko,
Morten Brørup, dev, stable
On 9/27/2021 5:14 PM, Olivier Matz wrote:
> On Wed, Sep 22, 2021 at 10:16:09AM +0100, Ferruh Yigit wrote:
>> On 9/21/2021 3:59 PM, Lance Richardson wrote:
>>> Minor corrections and improvements to documentation
>>> for checksum APIs.
>>>
>>> Fixes: 6006818cfb26 ("net: new checksum functions")
>>> Fixes: 45a08ef55e44 ("net: introduce functions to verify L4 checksums")
>>> Cc: stable@dpdk.org
>>> Signed-off-by: Lance Richardson <lance.richardson@broadcom.com>
>>
>> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
>>
>
> Acked-by: Olivier Matz <olivier.matz@6wind.com>
>
Applied to dpdk-next-net/main, thanks.
^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2021-10-07 12:43 UTC | newest]
Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-09-16 16:10 [dpdk-dev] [PATCH] net: fix checksum API documentation Lance Richardson
2021-09-17 10:57 ` Morten Brørup
2021-09-21 9:28 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
2021-09-21 10:11 ` Morten Brørup
2021-09-21 14:50 ` Lance Richardson
2021-09-21 14:59 ` [dpdk-dev] [PATCH v2] " Lance Richardson
2021-09-22 9:16 ` Ferruh Yigit
2021-09-27 16:14 ` Olivier Matz
2021-10-07 12:43 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).