[dpdk-dev] mbuf vlan_tci validity unclear

[dpdk-dev] mbuf vlan_tci validity unclear

[Morten Brørup]

In rte_mbuf.h, the description of the PKT_RX_VLAN flag (lines 93-94) says that mbuf->vlan_tci contains the VLAN TCI if the flag is set; however, the description of the vlan_tci field (line 513) says that the PKT_RX_VLAN_STRIPPED flag must be set for it to be valid.

 

Which one is it? And will someone please update the comments in rte_mbuf.h accordingly.

 

 

Med venlig hilsen / kind regards

 

Morten Brørup

CTO

 

 

SmartShare Systems A/S

Tonsbakken 16-18

DK-2740 Skovlunde

Denmark

 

Office      +45 70 20 00 93

Direct      +45 89 93 50 22

Mobile     +45 25 40 82 12

 

mb@smartsharesystems.com <mailto:mb@smartsharesystems.com> 

www.smartsharesystems.com <https://www.smartsharesystems.com/> 

 

Re: [dpdk-dev] mbuf vlan_tci validity unclear

[Olivier Matz]

Hi Morten,

On Wed, Jan 17, 2018 at 10:20:53PM +0100, Morten Brørup wrote:
> In rte_mbuf.h, the description of the PKT_RX_VLAN flag (lines 93-94) says that
> mbuf->vlan_tci contains the VLAN TCI if the flag is set; however, the
> description of the vlan_tci field (line 513) says that the
> PKT_RX_VLAN_STRIPPED flag must be set for it to be valid.
>
> Which one is it? And will someone please update the comments in rte_mbuf.h
> accordingly.

Thanks for spotting this, I will send a patch to fix it.

PKT_RX_VLAN means that mbuf->vlan_tci is valid.
And PKT_RX_VLAN_STRIPPED implies that PKT_RX_VLAN is set too.

[dpdk-dev] [PATCH] mbuf: fix API documentation regarding VLAN flags

[Olivier Matz]

Fix inconsistency between mbuf structure documentation and flags
documentation.

Fixes: 380a7aab1ae2 ("mbuf: rename deprecated VLAN flags")
Cc: stable@dpdk.org

Reported-by: Morten Brørup <mb@smartsharesystems.com>
Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
---
 lib/librte_mbuf/rte_mbuf.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h
index 2fd4f5ef9..7835a2be8 100644
--- a/lib/librte_mbuf/rte_mbuf.h
+++ b/lib/librte_mbuf/rte_mbuf.h
@@ -510,7 +510,7 @@ struct rte_mbuf {
 
 	uint32_t pkt_len;         /**< Total pkt len: sum of all segments. */
 	uint16_t data_len;        /**< Amount of data in segment buffer. */
-	/** VLAN TCI (CPU order), valid if PKT_RX_VLAN_STRIPPED is set. */
+	/** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */
 	uint16_t vlan_tci;
 
 	union {
@@ -536,7 +536,7 @@ struct rte_mbuf {
 		uint32_t usr;	  /**< User defined tags. See rte_distributor_process() */
 	} hash;                   /**< hash information */
 
-	/** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ_STRIPPED is set. */
+	/** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */
 	uint16_t vlan_tci_outer;
 
 	uint16_t buf_len;         /**< Length of segment buffer. */
-- 
2.11.0

Re: [dpdk-dev] [dpdk-stable] [PATCH] mbuf: fix API documentation regarding VLAN flags

[Thomas Monjalon]

29/01/2018 10:36, Olivier Matz:
> Fix inconsistency between mbuf structure documentation and flags
> documentation.
> 
> Fixes: 380a7aab1ae2 ("mbuf: rename deprecated VLAN flags")
> Cc: stable@dpdk.org
> 
> Reported-by: Morten Brørup <mb@smartsharesystems.com>
> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>

Applied, thanks