[dpdk-dev,06/12] mbuf: add functions to get the name of an ol_flag
Commit Message
In test-pmd (rxonly.c), the code is able to dump the list of ol_flags.
The issue is that the list of flags in the application has to be
synchronized with the flags defined in rte_mbuf.h.
This patch introduces 2 new functions rte_get_rx_ol_flag_name()
and rte_get_tx_ol_flag_name() that returns the name of a flag from
its mask. It also fixes rxonly.c to use this new functions and to
display the proper flags.
Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
---
app/test-pmd/rxonly.c | 36 ++++++++--------------------
lib/librte_mbuf/rte_mbuf.h | 60 ++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 70 insertions(+), 26 deletions(-)
Comments
On Mon, Nov 10, 2014 at 04:59:20PM +0100, Olivier Matz wrote:
> In test-pmd (rxonly.c), the code is able to dump the list of ol_flags.
> The issue is that the list of flags in the application has to be
> synchronized with the flags defined in rte_mbuf.h.
>
> This patch introduces 2 new functions rte_get_rx_ol_flag_name()
> and rte_get_tx_ol_flag_name() that returns the name of a flag from
> its mask. It also fixes rxonly.c to use this new functions and to
> display the proper flags.
Good idea. Couple of minor comments below.
/Bruce
>
> Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
> ---
> app/test-pmd/rxonly.c | 36 ++++++++--------------------
> lib/librte_mbuf/rte_mbuf.h | 60 ++++++++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 70 insertions(+), 26 deletions(-)
>
> diff --git a/app/test-pmd/rxonly.c b/app/test-pmd/rxonly.c
> index 4410c3d..e7cd7e2 100644
> --- a/app/test-pmd/rxonly.c
> +++ b/app/test-pmd/rxonly.c
> @@ -71,26 +71,6 @@
>
> #include "testpmd.h"
>
> -#define MAX_PKT_RX_FLAGS 13
> -static const char *pkt_rx_flag_names[MAX_PKT_RX_FLAGS] = {
> - "VLAN_PKT",
> - "RSS_HASH",
> - "PKT_RX_FDIR",
> - "IP_CKSUM",
> - "IP_CKSUM_BAD",
> -
> - "IPV4_HDR",
> - "IPV4_HDR_EXT",
> - "IPV6_HDR",
> - "IPV6_HDR_EXT",
> -
> - "IEEE1588_PTP",
> - "IEEE1588_TMST",
> -
> - "TUNNEL_IPV4_HDR",
> - "TUNNEL_IPV6_HDR",
> -};
> -
> static inline void
> print_ether_addr(const char *what, struct ether_addr *eth_addr)
> {
> @@ -219,12 +199,16 @@ pkt_burst_receive(struct fwd_stream *fs)
> printf(" - Receive queue=0x%x", (unsigned) fs->rx_queue);
> printf("\n");
> if (ol_flags != 0) {
> - int rxf;
> -
> - for (rxf = 0; rxf < MAX_PKT_RX_FLAGS; rxf++) {
> - if (ol_flags & (1 << rxf))
> - printf(" PKT_RX_%s\n",
> - pkt_rx_flag_names[rxf]);
> + unsigned rxf;
> + const char *name;
> +
> + for (rxf = 0; rxf < sizeof(mb->ol_flags) * 8; rxf++) {
> + if ((ol_flags & (1ULL << rxf)) == 0)
> + continue;
> + name = rte_get_rx_ol_flag_name(1ULL << rxf);
> + if (name == NULL)
> + continue;
> + printf(" %s\n", name);
> }
> }
> rte_pktmbuf_free(mb);
> diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h
> index ff11b84..bcd8996 100644
> --- a/lib/librte_mbuf/rte_mbuf.h
> +++ b/lib/librte_mbuf/rte_mbuf.h
> @@ -129,6 +129,66 @@ extern "C" {
> /* Use final bit of flags to indicate a control mbuf */
> #define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */
>
> +/**
> + * Bit Mask to indicate what bits required for building TX context
I don't understand this first line - is it accidentally included?
> + * Get the name of a RX offload flag
> + *
> + * @param mask
> + * The mask describing the flag. Usually only one bit must be set.
> + * Several bits can be given if they belong to the same mask.
> + * Ex: PKT_TX_L4_MASK.
TX mask given as an example for a function for RX flags is confusing.
> + * @return
> + * The name of this flag, or NULL if it's not a valid RX flag.
> + */
> +static inline const char *rte_get_rx_ol_flag_name(uint64_t mask)
> +{
> + switch (mask) {
> + case PKT_RX_VLAN_PKT: return "PKT_RX_VLAN_PKT";
> + case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
> + case PKT_RX_FDIR: return "PKT_RX_FDIR";
> + case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
> + case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
> + /* case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD"; */
> + /* case PKT_RX_OVERSIZE: return "PKT_RX_OVERSIZE"; */
> + /* case PKT_RX_HBUF_OVERFLOW: return "PKT_RX_HBUF_OVERFLOW"; */
> + /* case PKT_RX_RECIP_ERR: return "PKT_RX_RECIP_ERR"; */
> + /* case PKT_RX_MAC_ERR: return "PKT_RX_MAC_ERR"; */
> + case PKT_RX_IPV4_HDR: return "PKT_RX_IPV4_HDR";
> + case PKT_RX_IPV4_HDR_EXT: return "PKT_RX_IPV4_HDR_EXT";
> + case PKT_RX_IPV6_HDR: return "PKT_RX_IPV6_HDR";
> + case PKT_RX_IPV6_HDR_EXT: return "PKT_RX_IPV6_HDR_EXT";
> + case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
> + case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
> + case PKT_RX_TUNNEL_IPV4_HDR: return "PKT_RX_TUNNEL_IPV4_HDR";
> + case PKT_RX_TUNNEL_IPV6_HDR: return "PKT_RX_TUNNEL_IPV6_HDR";
> + default: return NULL;
> + }
> +}
> +
> +/**
> + * Get the name of a TX offload flag
> + *
> + * @param mask
> + * The mask describing the flag. Usually only one bit must be set.
> + * Several bits can be given if they belong to the same mask.
> + * Ex: PKT_TX_L4_MASK.
> + * @return
> + * The name of this flag, or NULL if it's not a valid TX flag.
> + */
> +static inline const char *rte_get_tx_ol_flag_name(uint64_t mask)
> +{
> + switch (mask) {
> + case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
> + case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
> + case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
> + case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
> + case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
> + case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
> + case PKT_TX_VXLAN_CKSUM: return "PKT_TX_VXLAN_CKSUM";
> + default: return NULL;
> + }
> +}
> +
> /* define a set of marker types that can be used to refer to set points in the
> * mbuf */
> typedef void *MARKER[0]; /**< generic marker for a point in a structure */
> --
> 2.1.0
>
Hi Bruce,
Thank you for the review.
On 11/10/2014 06:29 PM, Bruce Richardson wrote:
>> +/**
>> + * Bit Mask to indicate what bits required for building TX context
>
> I don't understand this first line - is it accidentally included?
Right, it's a mistake, I'll remove this line.
>> + * Get the name of a RX offload flag
>> + *
>> + * @param mask
>> + * The mask describing the flag. Usually only one bit must be set.
>> + * Several bits can be given if they belong to the same mask.
>> + * Ex: PKT_TX_L4_MASK.
> TX mask given as an example for a function for RX flags is confusing.
I'll remove the last two lines of the description as there is no example
for RX flags.
Regards,
Olivier
> -----Original Message-----
> From: Richardson, Bruce
> Sent: Monday, November 10, 2014 5:30 PM
> To: Olivier Matz
> Cc: dev@dpdk.org; Walukiewicz, Miroslaw; Liu, Jijiang; Liu, Yong; jigsaw@gmail.com; Ananyev, Konstantin
> Subject: Re: [PATCH 06/12] mbuf: add functions to get the name of an ol_flag
>
> On Mon, Nov 10, 2014 at 04:59:20PM +0100, Olivier Matz wrote:
> > In test-pmd (rxonly.c), the code is able to dump the list of ol_flags.
> > The issue is that the list of flags in the application has to be
> > synchronized with the flags defined in rte_mbuf.h.
> >
> > This patch introduces 2 new functions rte_get_rx_ol_flag_name()
> > and rte_get_tx_ol_flag_name() that returns the name of a flag from
> > its mask. It also fixes rxonly.c to use this new functions and to
> > display the proper flags.
>
> Good idea. Couple of minor comments below.
Yes, that looks like a good idea to me too.
Just one thought - there is probably no need to make rte_get_*_ol_flag_name() inlined
and put them into rte_mbuf.h
Seems like rte_mbuf.c - is a good place for these 2 functions definitions.
Konstantin
>
> /Bruce
>
> >
> > Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
> > ---
> > app/test-pmd/rxonly.c | 36 ++++++++--------------------
> > lib/librte_mbuf/rte_mbuf.h | 60 ++++++++++++++++++++++++++++++++++++++++++++++
> > 2 files changed, 70 insertions(+), 26 deletions(-)
> >
> > diff --git a/app/test-pmd/rxonly.c b/app/test-pmd/rxonly.c
> > index 4410c3d..e7cd7e2 100644
> > --- a/app/test-pmd/rxonly.c
> > +++ b/app/test-pmd/rxonly.c
> > @@ -71,26 +71,6 @@
> >
> > #include "testpmd.h"
> >
> > -#define MAX_PKT_RX_FLAGS 13
> > -static const char *pkt_rx_flag_names[MAX_PKT_RX_FLAGS] = {
> > - "VLAN_PKT",
> > - "RSS_HASH",
> > - "PKT_RX_FDIR",
> > - "IP_CKSUM",
> > - "IP_CKSUM_BAD",
> > -
> > - "IPV4_HDR",
> > - "IPV4_HDR_EXT",
> > - "IPV6_HDR",
> > - "IPV6_HDR_EXT",
> > -
> > - "IEEE1588_PTP",
> > - "IEEE1588_TMST",
> > -
> > - "TUNNEL_IPV4_HDR",
> > - "TUNNEL_IPV6_HDR",
> > -};
> > -
> > static inline void
> > print_ether_addr(const char *what, struct ether_addr *eth_addr)
> > {
> > @@ -219,12 +199,16 @@ pkt_burst_receive(struct fwd_stream *fs)
> > printf(" - Receive queue=0x%x", (unsigned) fs->rx_queue);
> > printf("\n");
> > if (ol_flags != 0) {
> > - int rxf;
> > -
> > - for (rxf = 0; rxf < MAX_PKT_RX_FLAGS; rxf++) {
> > - if (ol_flags & (1 << rxf))
> > - printf(" PKT_RX_%s\n",
> > - pkt_rx_flag_names[rxf]);
> > + unsigned rxf;
> > + const char *name;
> > +
> > + for (rxf = 0; rxf < sizeof(mb->ol_flags) * 8; rxf++) {
> > + if ((ol_flags & (1ULL << rxf)) == 0)
> > + continue;
> > + name = rte_get_rx_ol_flag_name(1ULL << rxf);
> > + if (name == NULL)
> > + continue;
> > + printf(" %s\n", name);
> > }
> > }
> > rte_pktmbuf_free(mb);
> > diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h
> > index ff11b84..bcd8996 100644
> > --- a/lib/librte_mbuf/rte_mbuf.h
> > +++ b/lib/librte_mbuf/rte_mbuf.h
> > @@ -129,6 +129,66 @@ extern "C" {
> > /* Use final bit of flags to indicate a control mbuf */
> > #define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */
> >
> > +/**
> > + * Bit Mask to indicate what bits required for building TX context
> I don't understand this first line - is it accidentally included?
>
> > + * Get the name of a RX offload flag
> > + *
> > + * @param mask
> > + * The mask describing the flag. Usually only one bit must be set.
> > + * Several bits can be given if they belong to the same mask.
> > + * Ex: PKT_TX_L4_MASK.
> TX mask given as an example for a function for RX flags is confusing.
>
> > + * @return
> > + * The name of this flag, or NULL if it's not a valid RX flag.
> > + */
> > +static inline const char *rte_get_rx_ol_flag_name(uint64_t mask)
> > +{
> > + switch (mask) {
> > + case PKT_RX_VLAN_PKT: return "PKT_RX_VLAN_PKT";
> > + case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
> > + case PKT_RX_FDIR: return "PKT_RX_FDIR";
> > + case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
> > + case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
> > + /* case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD"; */
> > + /* case PKT_RX_OVERSIZE: return "PKT_RX_OVERSIZE"; */
> > + /* case PKT_RX_HBUF_OVERFLOW: return "PKT_RX_HBUF_OVERFLOW"; */
> > + /* case PKT_RX_RECIP_ERR: return "PKT_RX_RECIP_ERR"; */
> > + /* case PKT_RX_MAC_ERR: return "PKT_RX_MAC_ERR"; */
> > + case PKT_RX_IPV4_HDR: return "PKT_RX_IPV4_HDR";
> > + case PKT_RX_IPV4_HDR_EXT: return "PKT_RX_IPV4_HDR_EXT";
> > + case PKT_RX_IPV6_HDR: return "PKT_RX_IPV6_HDR";
> > + case PKT_RX_IPV6_HDR_EXT: return "PKT_RX_IPV6_HDR_EXT";
> > + case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
> > + case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
> > + case PKT_RX_TUNNEL_IPV4_HDR: return "PKT_RX_TUNNEL_IPV4_HDR";
> > + case PKT_RX_TUNNEL_IPV6_HDR: return "PKT_RX_TUNNEL_IPV6_HDR";
> > + default: return NULL;
> > + }
> > +}
> > +
> > +/**
> > + * Get the name of a TX offload flag
> > + *
> > + * @param mask
> > + * The mask describing the flag. Usually only one bit must be set.
> > + * Several bits can be given if they belong to the same mask.
> > + * Ex: PKT_TX_L4_MASK.
> > + * @return
> > + * The name of this flag, or NULL if it's not a valid TX flag.
> > + */
> > +static inline const char *rte_get_tx_ol_flag_name(uint64_t mask)
> > +{
> > + switch (mask) {
> > + case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
> > + case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
> > + case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
> > + case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
> > + case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
> > + case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
> > + case PKT_TX_VXLAN_CKSUM: return "PKT_TX_VXLAN_CKSUM";
> > + default: return NULL;
> > + }
> > +}
> > +
> > /* define a set of marker types that can be used to refer to set points in the
> > * mbuf */
> > typedef void *MARKER[0]; /**< generic marker for a point in a structure */
> > --
> > 2.1.0
> >
Hi Konstantin,
On 11/12/2014 06:21 PM, Ananyev, Konstantin wrote:
>>> This patch introduces 2 new functions rte_get_rx_ol_flag_name()
>>> and rte_get_tx_ol_flag_name() that returns the name of a flag from
>>> its mask. It also fixes rxonly.c to use this new functions and to
>>> display the proper flags.
>>
>> Good idea. Couple of minor comments below.
>
> Yes, that looks like a good idea to me too.
> Just one thought - there is probably no need to make rte_get_*_ol_flag_name() inlined
> and put them into rte_mbuf.h
> Seems like rte_mbuf.c - is a good place for these 2 functions definitions.
>
> Konstantin
>
Agree, I'll add this change to the list.
Thanks,
Olivier
@@ -71,26 +71,6 @@
#include "testpmd.h"
-#define MAX_PKT_RX_FLAGS 13
-static const char *pkt_rx_flag_names[MAX_PKT_RX_FLAGS] = {
- "VLAN_PKT",
- "RSS_HASH",
- "PKT_RX_FDIR",
- "IP_CKSUM",
- "IP_CKSUM_BAD",
-
- "IPV4_HDR",
- "IPV4_HDR_EXT",
- "IPV6_HDR",
- "IPV6_HDR_EXT",
-
- "IEEE1588_PTP",
- "IEEE1588_TMST",
-
- "TUNNEL_IPV4_HDR",
- "TUNNEL_IPV6_HDR",
-};
-
static inline void
print_ether_addr(const char *what, struct ether_addr *eth_addr)
{
@@ -219,12 +199,16 @@ pkt_burst_receive(struct fwd_stream *fs)
printf(" - Receive queue=0x%x", (unsigned) fs->rx_queue);
printf("\n");
if (ol_flags != 0) {
- int rxf;
-
- for (rxf = 0; rxf < MAX_PKT_RX_FLAGS; rxf++) {
- if (ol_flags & (1 << rxf))
- printf(" PKT_RX_%s\n",
- pkt_rx_flag_names[rxf]);
+ unsigned rxf;
+ const char *name;
+
+ for (rxf = 0; rxf < sizeof(mb->ol_flags) * 8; rxf++) {
+ if ((ol_flags & (1ULL << rxf)) == 0)
+ continue;
+ name = rte_get_rx_ol_flag_name(1ULL << rxf);
+ if (name == NULL)
+ continue;
+ printf(" %s\n", name);
}
}
rte_pktmbuf_free(mb);
@@ -129,6 +129,66 @@ extern "C" {
/* Use final bit of flags to indicate a control mbuf */
#define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */
+/**
+ * Bit Mask to indicate what bits required for building TX context
+ * Get the name of a RX offload flag
+ *
+ * @param mask
+ * The mask describing the flag. Usually only one bit must be set.
+ * Several bits can be given if they belong to the same mask.
+ * Ex: PKT_TX_L4_MASK.
+ * @return
+ * The name of this flag, or NULL if it's not a valid RX flag.
+ */
+static inline const char *rte_get_rx_ol_flag_name(uint64_t mask)
+{
+ switch (mask) {
+ case PKT_RX_VLAN_PKT: return "PKT_RX_VLAN_PKT";
+ case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
+ case PKT_RX_FDIR: return "PKT_RX_FDIR";
+ case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
+ case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
+ /* case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD"; */
+ /* case PKT_RX_OVERSIZE: return "PKT_RX_OVERSIZE"; */
+ /* case PKT_RX_HBUF_OVERFLOW: return "PKT_RX_HBUF_OVERFLOW"; */
+ /* case PKT_RX_RECIP_ERR: return "PKT_RX_RECIP_ERR"; */
+ /* case PKT_RX_MAC_ERR: return "PKT_RX_MAC_ERR"; */
+ case PKT_RX_IPV4_HDR: return "PKT_RX_IPV4_HDR";
+ case PKT_RX_IPV4_HDR_EXT: return "PKT_RX_IPV4_HDR_EXT";
+ case PKT_RX_IPV6_HDR: return "PKT_RX_IPV6_HDR";
+ case PKT_RX_IPV6_HDR_EXT: return "PKT_RX_IPV6_HDR_EXT";
+ case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
+ case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
+ case PKT_RX_TUNNEL_IPV4_HDR: return "PKT_RX_TUNNEL_IPV4_HDR";
+ case PKT_RX_TUNNEL_IPV6_HDR: return "PKT_RX_TUNNEL_IPV6_HDR";
+ default: return NULL;
+ }
+}
+
+/**
+ * Get the name of a TX offload flag
+ *
+ * @param mask
+ * The mask describing the flag. Usually only one bit must be set.
+ * Several bits can be given if they belong to the same mask.
+ * Ex: PKT_TX_L4_MASK.
+ * @return
+ * The name of this flag, or NULL if it's not a valid TX flag.
+ */
+static inline const char *rte_get_tx_ol_flag_name(uint64_t mask)
+{
+ switch (mask) {
+ case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
+ case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
+ case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
+ case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
+ case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
+ case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
+ case PKT_TX_VXLAN_CKSUM: return "PKT_TX_VXLAN_CKSUM";
+ default: return NULL;
+ }
+}
+
/* define a set of marker types that can be used to refer to set points in the
* mbuf */
typedef void *MARKER[0]; /**< generic marker for a point in a structure */