[dpdk-dev] mbuf TX VLAN flags should be renamed

[dpdk-dev] mbuf TX VLAN flags should be renamed

[Morten Brørup]

PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT were renamed to PKT_RX_VLAN and PKT_RX_QINQ somewhere between DPDK version 16.07 and version 17.11.

 

Shouldn’t PKT_TX_VLAN_PKT and PKT_TX_QINQ_PKT follow the same naming convention and get rid of the _PKT postfix?

 

 

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 TX VLAN flags should be renamed

[Olivier Matz]

On Wed, Jan 17, 2018 at 10:23:06PM +0100, Morten Brørup wrote:
> PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT were renamed to PKT_RX_VLAN and
> PKT_RX_QINQ somewhere between DPDK version 16.07 and version 17.11.
>
> Shouldn’t PKT_TX_VLAN_PKT and PKT_TX_QINQ_PKT follow the same naming
> convention and get rid of the _PKT postfix?

Yes. I'll send a patch for this.

Thanks
Olivier

[dpdk-dev] [PATCH] mbuf: rename Tx VLAN flags

[Olivier Matz]

For consistency with the Rx flags, the flags PKT_TX_VLAN_PKT and
PKT_TX_QINQ_PKT are respectively renamed as PKT_TX_VLAN and
PKT_TX_QINQ. The old defines are deprecated but will stay for some time
for compatibility.

Reported-by: Morten Brørup <mb@smartsharesystems.com>
Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
---
 doc/guides/rel_notes/deprecation.rst |  4 ++++
 lib/librte_mbuf/rte_mbuf.h           | 11 +++++++++--
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index e98ce6a0a..43a39d827 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -72,3 +72,7 @@ Deprecation Notices
   - ``CTRL_MBUF_FLAG``
 
   The packet mbuf API should be used as a replacement.
+
+* mbuf: The mbuf flags ``PKT_TX_VLAN_PKT`` and ``PKT_TX_QINQ_PKT`` are
+  respectively renamed as ``PKT_TX_VLAN`` and ``PKT_TX_QINQ``. The old
+  names will be removed in v18.08.
diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h
index 7835a2be8..4519fb303 100644
--- a/lib/librte_mbuf/rte_mbuf.h
+++ b/lib/librte_mbuf/rte_mbuf.h
@@ -244,7 +244,9 @@ extern "C" {
 /**
  * Second VLAN insertion (QinQ) flag.
  */
-#define PKT_TX_QINQ_PKT    (1ULL << 49)   /**< TX packet with double VLAN inserted. */
+#define PKT_TX_QINQ        (1ULL << 49)   /**< TX packet with double VLAN inserted. */
+/* this old name is deprecated */
+#define PKT_TX_QINQ_PKT    PKT_TX_QINQ
 
 /**
  * TCP segmentation offload. To enable this offload feature for a
@@ -305,7 +307,12 @@ extern "C" {
  */
 #define PKT_TX_IPV6          (1ULL << 56)
 
-#define PKT_TX_VLAN_PKT      (1ULL << 57) /**< TX packet is a 802.1q VLAN packet. */
+/**
+ * TX packet is a 802.1q VLAN packet.
+ */
+#define PKT_TX_VLAN          (1ULL << 57)
+/* this old name is deprecated */
+#define PKT_TX_VLAN_PKT      PKT_TX_VLAN
 
 /**
  * Offload the IP checksum of an external header in the hardware. The
-- 
2.11.0

Re: [dpdk-dev] [PATCH] mbuf: rename Tx VLAN flags

[Thomas Monjalon]

29/01/2018 10:37, Olivier Matz:
> For consistency with the Rx flags, the flags PKT_TX_VLAN_PKT and
> PKT_TX_QINQ_PKT are respectively renamed as PKT_TX_VLAN and
> PKT_TX_QINQ. The old defines are deprecated but will stay for some time
> for compatibility.
> 
> Reported-by: Morten Brørup <mb@smartsharesystems.com>
> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
> ---
>  doc/guides/rel_notes/deprecation.rst |  4 ++++
>  lib/librte_mbuf/rte_mbuf.h           | 11 +++++++++--
>  2 files changed, 13 insertions(+), 2 deletions(-)

Applied without the deprecation notice.
The deprecation notice should be separate and wait for 3 acks.
I think we should try to group it with full cleanup of the mbuf
namespace.