net/tap: use SPDX tags in 6WIND copyrighted files
[dpdk.git] / drivers / net / tap / rte_eth_tap.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2017 6WIND S.A.
3  * Copyright 2017 Mellanox.
4  */
5
6 #ifndef _RTE_ETH_TAP_H_
7 #define _RTE_ETH_TAP_H_
8
9 #include <sys/queue.h>
10 #include <sys/uio.h>
11 #include <inttypes.h>
12 #include <net/if.h>
13
14 #include <linux/if_tun.h>
15
16 #include <rte_ethdev_driver.h>
17 #include <rte_ether.h>
18
19 #ifdef IFF_MULTI_QUEUE
20 #define RTE_PMD_TAP_MAX_QUEUES  TAP_MAX_QUEUES
21 #else
22 #define RTE_PMD_TAP_MAX_QUEUES  1
23 #endif
24
25 struct pkt_stats {
26         uint64_t opackets;              /* Number of output packets */
27         uint64_t ipackets;              /* Number of input packets */
28         uint64_t obytes;                /* Number of bytes on output */
29         uint64_t ibytes;                /* Number of bytes on input */
30         uint64_t errs;                  /* Number of TX error packets */
31         uint64_t ierrors;               /* Number of RX error packets */
32         uint64_t rx_nombuf;             /* Nb of RX mbuf alloc failures */
33 };
34
35 struct rx_queue {
36         struct rte_mempool *mp;         /* Mempool for RX packets */
37         uint32_t trigger_seen;          /* Last seen Rx trigger value */
38         uint16_t in_port;               /* Port ID */
39         int fd;
40         struct pkt_stats stats;         /* Stats for this RX queue */
41         uint16_t nb_rx_desc;            /* max number of mbufs available */
42         struct rte_eth_rxmode *rxmode;  /* RX features */
43         struct rte_mbuf *pool;          /* mbufs pool for this queue */
44         struct iovec (*iovecs)[];       /* descriptors for this queue */
45         struct tun_pi pi;               /* packet info for iovecs */
46 };
47
48 struct tx_queue {
49         int fd;
50         uint16_t *mtu;                  /* Pointer to MTU from dev_data */
51         uint16_t csum:1;                /* Enable checksum offloading */
52         struct pkt_stats stats;         /* Stats for this TX queue */
53 };
54
55 struct pmd_internals {
56         struct rte_eth_dev *dev;          /* Ethernet device. */
57         char remote_iface[RTE_ETH_NAME_MAX_LEN]; /* Remote netdevice name */
58         char name[RTE_ETH_NAME_MAX_LEN];  /* Internal Tap device name */
59         struct ether_addr eth_addr;       /* Mac address of the device port */
60         struct ifreq remote_initial_flags;   /* Remote netdevice flags on init */
61         int remote_if_index;              /* remote netdevice IF_INDEX */
62         int if_index;                     /* IF_INDEX for the port */
63         int ioctl_sock;                   /* socket for ioctl calls */
64         int nlsk_fd;                      /* Netlink socket fd */
65         int flow_isolate;                 /* 1 if flow isolation is enabled */
66         int flower_support;               /* 1 if kernel supports, else 0 */
67         int flower_vlan_support;          /* 1 if kernel supports, else 0 */
68         int rss_enabled;                  /* 1 if RSS is enabled, else 0 */
69         /* implicit rules set when RSS is enabled */
70         int map_fd;                       /* BPF RSS map fd */
71         int bpf_fd[RTE_PMD_TAP_MAX_QUEUES];/* List of bpf fds per queue */
72         LIST_HEAD(tap_rss_flows, rte_flow) rss_flows;
73         LIST_HEAD(tap_flows, rte_flow) flows;        /* rte_flow rules */
74         /* implicit rte_flow rules set when a remote device is active */
75         LIST_HEAD(tap_implicit_flows, rte_flow) implicit_flows;
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         struct rte_intr_handle intr_handle;          /* LSC interrupt handle. */
79 };
80
81 /* tap_intr.c */
82
83 int tap_rx_intr_vec_set(struct rte_eth_dev *dev, int set);
84
85 #endif /* _RTE_ETH_TAP_H_ */