xref: /f-stack/dpdk/drivers/net/tap/rte_eth_tap.h (revision 031be553)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright 2017 6WIND S.A.
5  *   Copyright 2017 Mellanox.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of 6WIND S.A. nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef _RTE_ETH_TAP_H_
35 #define _RTE_ETH_TAP_H_
36 
37 #include <sys/queue.h>
38 #include <sys/uio.h>
39 #include <inttypes.h>
40 #include <net/if.h>
41 
42 #include <linux/if_tun.h>
43 
44 #include <rte_ethdev.h>
45 #include <rte_ether.h>
46 
47 #ifdef IFF_MULTI_QUEUE
48 #define RTE_PMD_TAP_MAX_QUEUES	16
49 #else
50 #define RTE_PMD_TAP_MAX_QUEUES	1
51 #endif
52 
53 struct pkt_stats {
54 	uint64_t opackets;              /* Number of output packets */
55 	uint64_t ipackets;              /* Number of input packets */
56 	uint64_t obytes;                /* Number of bytes on output */
57 	uint64_t ibytes;                /* Number of bytes on input */
58 	uint64_t errs;                  /* Number of TX error packets */
59 	uint64_t ierrors;               /* Number of RX error packets */
60 	uint64_t rx_nombuf;             /* Nb of RX mbuf alloc failures */
61 };
62 
63 struct rx_queue {
64 	struct rte_mempool *mp;         /* Mempool for RX packets */
65 	uint32_t trigger_seen;          /* Last seen Rx trigger value */
66 	uint16_t in_port;               /* Port ID */
67 	int fd;
68 	struct pkt_stats stats;         /* Stats for this RX queue */
69 	uint16_t nb_rx_desc;            /* max number of mbufs available */
70 	struct rte_eth_rxmode *rxmode;  /* RX features */
71 	struct rte_mbuf *pool;          /* mbufs pool for this queue */
72 	struct iovec (*iovecs)[];       /* descriptors for this queue */
73 	struct tun_pi pi;               /* packet info for iovecs */
74 };
75 
76 struct tx_queue {
77 	int fd;
78 	uint16_t *mtu;                  /* Pointer to MTU from dev_data */
79 	struct pkt_stats stats;         /* Stats for this TX queue */
80 };
81 
82 struct pmd_internals {
83 	struct rte_eth_dev *dev;          /* Ethernet device. */
84 	char remote_iface[RTE_ETH_NAME_MAX_LEN]; /* Remote netdevice name */
85 	char name[RTE_ETH_NAME_MAX_LEN];  /* Internal Tap device name */
86 	struct ether_addr eth_addr;       /* Mac address of the device port */
87 	struct ifreq remote_initial_flags;   /* Remote netdevice flags on init */
88 	int remote_if_index;              /* remote netdevice IF_INDEX */
89 	int if_index;                     /* IF_INDEX for the port */
90 	int ioctl_sock;                   /* socket for ioctl calls */
91 	int nlsk_fd;                      /* Netlink socket fd */
92 	int flow_isolate;                 /* 1 if flow isolation is enabled */
93 	LIST_HEAD(tap_flows, rte_flow) flows;        /* rte_flow rules */
94 	/* implicit rte_flow rules set when a remote device is active */
95 	LIST_HEAD(tap_implicit_flows, rte_flow) implicit_flows;
96 	struct rx_queue rxq[RTE_PMD_TAP_MAX_QUEUES]; /* List of RX queues */
97 	struct tx_queue txq[RTE_PMD_TAP_MAX_QUEUES]; /* List of TX queues */
98 	struct rte_intr_handle intr_handle;          /* LSC interrupt handle. */
99 };
100 
101 #endif /* _RTE_ETH_TAP_H_ */
102