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 <sys/uio.h>
  39 #include <inttypes.h>
  40
  41 #include <linux/if_tun.h>
  42
  43 #include <rte_ethdev.h>
  44 #include <rte_ether.h>
  45
  46 #ifdef IFF_MULTI_QUEUE
  47 #define RTE_PMD_TAP_MAX_QUEUES  16
  48 #else
  49 #define RTE_PMD_TAP_MAX_QUEUES  1
  50 #endif
  51
  52 struct pkt_stats {
  53         uint64_t opackets;              /* Number of output packets */
  54         uint64_t ipackets;              /* Number of input packets */
  55         uint64_t obytes;                /* Number of bytes on output */
  56         uint64_t ibytes;                /* Number of bytes on input */
  57         uint64_t errs;                  /* Number of TX error packets */
  58         uint64_t ierrors;               /* Number of RX error packets */
  59         uint64_t rx_nombuf;             /* Nb of RX mbuf alloc failures */
  60 };
  61
  62 struct rx_queue {
  63         struct rte_mempool *mp;         /* Mempool for RX packets */
  64         uint32_t trigger_seen;          /* Last seen Rx trigger value */
  65         uint16_t in_port;               /* Port ID */
  66         int fd;
  67         struct pkt_stats stats;         /* Stats for this RX queue */
  68         uint16_t nb_rx_desc;            /* max number of mbufs available */
  69         struct rte_eth_rxmode *rxmode;  /* RX features */
  70         struct rte_mbuf *pool;          /* mbufs pool for this queue */
  71         struct iovec (*iovecs)[];       /* descriptors for this queue */
  72         struct tun_pi pi;               /* packet info for iovecs */
  73 };
  74
  75 struct tx_queue {
  76         int fd;
  77         uint16_t *mtu;                  /* Pointer to MTU from dev_data */
  78         struct pkt_stats stats;         /* Stats for this TX queue */
  79 };
  80
  81 struct pmd_internals {
  82         char remote_iface[RTE_ETH_NAME_MAX_LEN]; /* Remote netdevice name */
  83         char name[RTE_ETH_NAME_MAX_LEN];  /* Internal Tap device name */
  84         uint16_t nb_queues;               /* Number of queues supported */
  85         struct ether_addr eth_addr;       /* Mac address of the device port */
  86         int remote_if_index;              /* remote netdevice IF_INDEX */
  87         int if_index;                     /* IF_INDEX for the port */
  88         int ioctl_sock;                   /* socket for ioctl calls */
  89         int nlsk_fd;                      /* Netlink socket fd */
  90         int flower_support;               /* 1 if kernel supports, else 0 */
  91         int flower_vlan_support;          /* 1 if kernel supports, else 0 */
  92         LIST_HEAD(tap_flows, rte_flow) flows;        /* rte_flow rules */
  93         /* implicit rte_flow rules set when a remote device is active */
  94         LIST_HEAD(tap_implicit_flows, rte_flow) implicit_flows;
  95         struct rx_queue rxq[RTE_PMD_TAP_MAX_QUEUES]; /* List of RX queues */
  96         struct tx_queue txq[RTE_PMD_TAP_MAX_QUEUES]; /* List of TX queues */
  97         struct rte_intr_handle intr_handle;          /* LSC interrupt handle. */
  98 };
  99
 100 #endif /* _RTE_ETH_TAP_H_ */