net/tap: add basic flow API patterns and actions
[dpdk.git] / drivers / net / tap / rte_eth_tap.h
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 <inttypes.h>
39
40 #include <rte_ethdev.h>
41 #include <rte_ether.h>
42
43 #define RTE_PMD_TAP_MAX_QUEUES 16
44
45 struct pkt_stats {
46         uint64_t opackets;              /* Number of output packets */
47         uint64_t ipackets;              /* Number of input packets */
48         uint64_t obytes;                /* Number of bytes on output */
49         uint64_t ibytes;                /* Number of bytes on input */
50         uint64_t errs;                  /* Number of TX error packets */
51 };
52
53 struct rx_queue {
54         struct rte_mempool *mp;         /* Mempool for RX packets */
55         uint32_t trigger_seen;          /* Last seen Rx trigger value */
56         uint16_t in_port;               /* Port ID */
57         int fd;
58         struct pkt_stats stats;         /* Stats for this RX queue */
59 };
60
61 struct tx_queue {
62         int fd;
63         struct pkt_stats stats;         /* Stats for this TX queue */
64 };
65
66 struct pmd_internals {
67         char name[RTE_ETH_NAME_MAX_LEN];  /* Internal Tap device name */
68         uint16_t nb_queues;               /* Number of queues supported */
69         struct ether_addr eth_addr;       /* Mac address of the device port */
70         int if_index;                     /* IF_INDEX for the port */
71         int ioctl_sock;                   /* socket for ioctl calls */
72         int nlsk_fd;                      /* Netlink socket fd */
73         int flower_support;               /* 1 if kernel supports, else 0 */
74         int flower_vlan_support;          /* 1 if kernel supports, else 0 */
75         LIST_HEAD(tap_flows, rte_flow) flows;        /* rte_flow rules */
76         struct rx_queue rxq[RTE_PMD_TAP_MAX_QUEUES]; /* List of RX queues */
77         struct tx_queue txq[RTE_PMD_TAP_MAX_QUEUES]; /* List of TX queues */
78 };
79
80 #endif /* _RTE_ETH_TAP_H_ */