[dpdk-dev,v5,1/4] net/tap: move private elements to external header

Message ID ce2980b215e54ccc5899e620d57d688598a190f9.1489589508.git.pascal.mazon@6wind.com (mailing list archive)
State Changes Requested, archived
Delegated to: Ferruh Yigit
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Pascal Mazon March 15, 2017, 2:54 p.m. UTC
  In the next patch, access to struct pmd_internals will be necessary in
tap_flow.c to store the flows.

Signed-off-by: Pascal Mazon <pascal.mazon@6wind.com>
Acked-by: Olga Shern <olgas@mellanox.com>
---
 drivers/net/tap/Makefile      |  1 +
 drivers/net/tap/rte_eth_tap.c | 36 ++-------------------
 drivers/net/tap/rte_eth_tap.h | 75 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 78 insertions(+), 34 deletions(-)
 create mode 100644 drivers/net/tap/rte_eth_tap.h
  

Comments

Wiles, Keith March 21, 2017, 3:32 p.m. UTC | #1
> On Mar 15, 2017, at 9:54 AM, Pascal Mazon <pascal.mazon@6wind.com> wrote:
> 
> In the next patch, access to struct pmd_internals will be necessary in
> tap_flow.c to store the flows.
> 
> Signed-off-by: Pascal Mazon <pascal.mazon@6wind.com>
> Acked-by: Olga Shern <olgas@mellanox.com>
> ---
> drivers/net/tap/Makefile      |  1 +
> drivers/net/tap/rte_eth_tap.c | 36 ++-------------------
> drivers/net/tap/rte_eth_tap.h | 75 +++++++++++++++++++++++++++++++++++++++++++
> 3 files changed, 78 insertions(+), 34 deletions(-)
> create mode 100644 drivers/net/tap/rte_eth_tap.h
> 
> diff --git a/drivers/net/tap/Makefile b/drivers/net/tap/Makefile
> index ddf87232d335..fa4658bd1e75 100644
> --- a/drivers/net/tap/Makefile
> +++ b/drivers/net/tap/Makefile
> @@ -40,6 +40,7 @@ EXPORT_MAP := rte_pmd_tap_version.map
> LIBABIVER := 1
> 
> CFLAGS += -O3
> +CFLAGS += -I$(SRCDIR)
> CFLAGS += $(WERROR_FLAGS)
> 
> #
> diff --git a/drivers/net/tap/rte_eth_tap.c b/drivers/net/tap/rte_eth_tap.c
> index f8d9cc7dc3b2..6bb63e5ec873 100644
> --- a/drivers/net/tap/rte_eth_tap.c
> +++ b/drivers/net/tap/rte_eth_tap.c
> @@ -55,6 +55,8 @@
> #include <linux/if_ether.h>
> #include <fcntl.h>
> 
> +#include <rte_eth_tap.h>
> +
> /* Linux based path to the TUN device */
> #define TUN_TAP_DEV_PATH        "/dev/net/tun"
> #define DEFAULT_TAP_NAME        "dtap"
> @@ -87,40 +89,6 @@ static struct rte_eth_link pmd_link = {
> 	.link_autoneg = ETH_LINK_SPEED_AUTONEG
> };
> 
> -struct pkt_stats {
> -	uint64_t opackets;		/* Number of output packets */
> -	uint64_t ipackets;		/* Number of input packets */
> -	uint64_t obytes;		/* Number of bytes on output */
> -	uint64_t ibytes;		/* Number of bytes on input */
> -	uint64_t errs;			/* Number of error packets */
> -};
> -
> -struct rx_queue {
> -	struct rte_mempool *mp;		/* Mempool for RX packets */
> -	uint32_t trigger_seen;		/* Last seen Rx trigger value */
> -	uint16_t in_port;		/* Port ID */
> -	int fd;
> -
> -	struct pkt_stats stats;		/* Stats for this RX queue */
> -};
> -
> -struct tx_queue {
> -	int fd;
> -	struct pkt_stats stats;		/* Stats for this TX queue */
> -};
> -
> -struct pmd_internals {
> -	char name[RTE_ETH_NAME_MAX_LEN];	/* Internal Tap device name */
> -	uint16_t nb_queues;		/* Number of queues supported */
> -	struct ether_addr eth_addr;	/* Mac address of the device port */
> -
> -	int if_index;			/* IF_INDEX for the port */
> -	int ioctl_sock;			/* socket for ioctl calls */
> -
> -	struct rx_queue rxq[RTE_PMD_TAP_MAX_QUEUES];	/* List of RX queues */
> -	struct tx_queue txq[RTE_PMD_TAP_MAX_QUEUES];	/* List of TX queues */
> -};
> -
> static void
> tap_trigger_cb(int sig __rte_unused)
> {
> diff --git a/drivers/net/tap/rte_eth_tap.h b/drivers/net/tap/rte_eth_tap.h
> new file mode 100644
> index 000000000000..aafdef1faa99
> --- /dev/null
> +++ b/drivers/net/tap/rte_eth_tap.h
> @@ -0,0 +1,75 @@
> +/*-
> + *   BSD LICENSE
> + *
> + *   Copyright 2017 6WIND S.A.
> + *   Copyright 2017 Mellanox.
> + *
> + *   Redistribution and use in source and binary forms, with or without
> + *   modification, are permitted provided that the following conditions
> + *   are met:
> + *
> + *     * Redistributions of source code must retain the above copyright
> + *       notice, this list of conditions and the following disclaimer.
> + *     * Redistributions in binary form must reproduce the above copyright
> + *       notice, this list of conditions and the following disclaimer in
> + *       the documentation and/or other materials provided with the
> + *       distribution.
> + *     * Neither the name of 6WIND S.A. nor the names of its
> + *       contributors may be used to endorse or promote products derived
> + *       from this software without specific prior written permission.
> + *
> + *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
> + *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
> + *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
> + *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
> + *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
> + *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
> + *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
> + *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
> + *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
> + *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
> + *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
> + */
> +
> +#ifndef _RTE_ETH_TAP_H_
> +#define _RTE_ETH_TAP_H_
> +
> +#include <inttypes.h>
> +
> +#include <rte_ethdev.h>
> +#include <rte_ether.h>

Just noticed this new header does not have the C++ ifdefs. Create a new patch to fix this problem, unless you need to update this patch series. Just starting my review of this one, sorry was traveling last week.

> +
> +#define RTE_PMD_TAP_MAX_QUEUES 16
> +
> +struct pkt_stats {
> +	uint64_t opackets;              /* Number of output packets */
> +	uint64_t ipackets;              /* Number of input packets */
> +	uint64_t obytes;                /* Number of bytes on output */
> +	uint64_t ibytes;                /* Number of bytes on input */
> +	uint64_t errs;                  /* Number of TX error packets */
> +};
> +
> +struct rx_queue {
> +	struct rte_mempool *mp;         /* Mempool for RX packets */
> +	uint32_t trigger_seen;          /* Last seen Rx trigger value */
> +	uint16_t in_port;               /* Port ID */
> +	int fd;
> +	struct pkt_stats stats;         /* Stats for this RX queue */
> +};
> +
> +struct tx_queue {
> +	int fd;
> +	struct pkt_stats stats;         /* Stats for this TX queue */
> +};
> +
> +struct pmd_internals {
> +	char name[RTE_ETH_NAME_MAX_LEN];  /* Internal Tap device name */
> +	uint16_t nb_queues;               /* Number of queues supported */
> +	struct ether_addr eth_addr;       /* Mac address of the device port */
> +	int if_index;                     /* IF_INDEX for the port */
> +	int ioctl_sock;                   /* socket for ioctl calls */
> +	struct rx_queue rxq[RTE_PMD_TAP_MAX_QUEUES]; /* List of RX queues */
> +	struct tx_queue txq[RTE_PMD_TAP_MAX_QUEUES]; /* List of TX queues */
> +};
> +
> +#endif /* _RTE_ETH_TAP_H_ */
> -- 
> 2.8.0.rc0
> 

Regards,
Keith
  
Pascal Mazon March 21, 2017, 4:57 p.m. UTC | #2
On Tue, 21 Mar 2017 15:32:06 +0000
"Wiles, Keith" <keith.wiles@intel.com> wrote:

> 
> Just noticed this new header does not have the C++ ifdefs. Create a
> new patch to fix this problem, unless you need to update this patch
> series. Just starting my review of this one, sorry was traveling last
> week.
> 
> Regards,
> Keith
> 

Hi Keith,

rte_eth_tap.h header is only presenting functions for local use within
the tap driver. That part of the code is completely internal to the
driver, compiled as pure C, and is not to be used directly by the
(potentially c++) user application linking itself with DPDK.

It's thus normal to keep it standard C without the need for c++ ifdefs.

The other PMDs in drivers/net also don't use the c++ ifdefs in their
headers, by the way.

Best regards,
Pascal
  

Patch

diff --git a/drivers/net/tap/Makefile b/drivers/net/tap/Makefile
index ddf87232d335..fa4658bd1e75 100644
--- a/drivers/net/tap/Makefile
+++ b/drivers/net/tap/Makefile
@@ -40,6 +40,7 @@  EXPORT_MAP := rte_pmd_tap_version.map
 LIBABIVER := 1
 
 CFLAGS += -O3
+CFLAGS += -I$(SRCDIR)
 CFLAGS += $(WERROR_FLAGS)
 
 #
diff --git a/drivers/net/tap/rte_eth_tap.c b/drivers/net/tap/rte_eth_tap.c
index f8d9cc7dc3b2..6bb63e5ec873 100644
--- a/drivers/net/tap/rte_eth_tap.c
+++ b/drivers/net/tap/rte_eth_tap.c
@@ -55,6 +55,8 @@ 
 #include <linux/if_ether.h>
 #include <fcntl.h>
 
+#include <rte_eth_tap.h>
+
 /* Linux based path to the TUN device */
 #define TUN_TAP_DEV_PATH        "/dev/net/tun"
 #define DEFAULT_TAP_NAME        "dtap"
@@ -87,40 +89,6 @@  static struct rte_eth_link pmd_link = {
 	.link_autoneg = ETH_LINK_SPEED_AUTONEG
 };
 
-struct pkt_stats {
-	uint64_t opackets;		/* Number of output packets */
-	uint64_t ipackets;		/* Number of input packets */
-	uint64_t obytes;		/* Number of bytes on output */
-	uint64_t ibytes;		/* Number of bytes on input */
-	uint64_t errs;			/* Number of error packets */
-};
-
-struct rx_queue {
-	struct rte_mempool *mp;		/* Mempool for RX packets */
-	uint32_t trigger_seen;		/* Last seen Rx trigger value */
-	uint16_t in_port;		/* Port ID */
-	int fd;
-
-	struct pkt_stats stats;		/* Stats for this RX queue */
-};
-
-struct tx_queue {
-	int fd;
-	struct pkt_stats stats;		/* Stats for this TX queue */
-};
-
-struct pmd_internals {
-	char name[RTE_ETH_NAME_MAX_LEN];	/* Internal Tap device name */
-	uint16_t nb_queues;		/* Number of queues supported */
-	struct ether_addr eth_addr;	/* Mac address of the device port */
-
-	int if_index;			/* IF_INDEX for the port */
-	int ioctl_sock;			/* socket for ioctl calls */
-
-	struct rx_queue rxq[RTE_PMD_TAP_MAX_QUEUES];	/* List of RX queues */
-	struct tx_queue txq[RTE_PMD_TAP_MAX_QUEUES];	/* List of TX queues */
-};
-
 static void
 tap_trigger_cb(int sig __rte_unused)
 {
diff --git a/drivers/net/tap/rte_eth_tap.h b/drivers/net/tap/rte_eth_tap.h
new file mode 100644
index 000000000000..aafdef1faa99
--- /dev/null
+++ b/drivers/net/tap/rte_eth_tap.h
@@ -0,0 +1,75 @@ 
+/*-
+ *   BSD LICENSE
+ *
+ *   Copyright 2017 6WIND S.A.
+ *   Copyright 2017 Mellanox.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
+ *   are met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
+ *       distribution.
+ *     * Neither the name of 6WIND S.A. nor the names of its
+ *       contributors may be used to endorse or promote products derived
+ *       from this software without specific prior written permission.
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef _RTE_ETH_TAP_H_
+#define _RTE_ETH_TAP_H_
+
+#include <inttypes.h>
+
+#include <rte_ethdev.h>
+#include <rte_ether.h>
+
+#define RTE_PMD_TAP_MAX_QUEUES 16
+
+struct pkt_stats {
+	uint64_t opackets;              /* Number of output packets */
+	uint64_t ipackets;              /* Number of input packets */
+	uint64_t obytes;                /* Number of bytes on output */
+	uint64_t ibytes;                /* Number of bytes on input */
+	uint64_t errs;                  /* Number of TX error packets */
+};
+
+struct rx_queue {
+	struct rte_mempool *mp;         /* Mempool for RX packets */
+	uint32_t trigger_seen;          /* Last seen Rx trigger value */
+	uint16_t in_port;               /* Port ID */
+	int fd;
+	struct pkt_stats stats;         /* Stats for this RX queue */
+};
+
+struct tx_queue {
+	int fd;
+	struct pkt_stats stats;         /* Stats for this TX queue */
+};
+
+struct pmd_internals {
+	char name[RTE_ETH_NAME_MAX_LEN];  /* Internal Tap device name */
+	uint16_t nb_queues;               /* Number of queues supported */
+	struct ether_addr eth_addr;       /* Mac address of the device port */
+	int if_index;                     /* IF_INDEX for the port */
+	int ioctl_sock;                   /* socket for ioctl calls */
+	struct rx_queue rxq[RTE_PMD_TAP_MAX_QUEUES]; /* List of RX queues */
+	struct tx_queue txq[RTE_PMD_TAP_MAX_QUEUES]; /* List of TX queues */
+};
+
+#endif /* _RTE_ETH_TAP_H_ */