8ed817d46499f559b214636f8bd80c28a251cc72
[deb_dpdk.git] / examples / tep_termination / main.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5  *   All rights reserved.
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 Intel Corporation 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 _MAIN_H_
35 #define _MAIN_H_
36
37 #include <rte_ether.h>
38
39 /* Macros for printing using RTE_LOG */
40 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
41 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER2
42 #define RTE_LOGTYPE_VHOST_PORT   RTE_LOGTYPE_USER3
43
44 /* State of virtio device. */
45 #define DEVICE_MAC_LEARNING     0
46 #define DEVICE_RX               1
47 #define DEVICE_SAFE_REMOVE      2
48
49 #define MAX_QUEUES 512
50
51 /* Max burst size for RX/TX */
52 #define MAX_PKT_BURST 32
53
54 /* Max number of devices. Limited by the application. */
55 #define MAX_DEVICES 64
56
57 enum {VIRTIO_RXQ, VIRTIO_TXQ, VIRTIO_QNUM};
58
59 /* Per-device statistics struct */
60 struct device_statistics {
61         uint64_t tx_total;
62         rte_atomic64_t rx_total_atomic;
63         uint64_t rx_total;
64         uint64_t tx;
65         rte_atomic64_t rx_atomic;
66         /**< Bad inner IP csum for tunneling pkt */
67         rte_atomic64_t rx_bad_ip_csum;
68         /**< Bad inner L4 csum for tunneling pkt */
69         rte_atomic64_t rx_bad_l4_csum;
70 } __rte_cache_aligned;
71
72 /**
73  * Device linked list structure for data path.
74  */
75 struct vhost_dev {
76         int vid;
77         /**< Number of memory regions for gpa to hpa translation. */
78         uint32_t nregions_hpa;
79         /**< Memory region information for gpa to hpa translation. */
80         struct virtio_memory_regions_hpa *regions_hpa;
81         /**< Device MAC address (Obtained on first TX packet). */
82         struct ether_addr mac_address;
83         /**< RX queue number. */
84         uint16_t rx_q;
85         /**< Data core that the device is added to. */
86         uint16_t coreid;
87         /**< A device is set as ready if the MAC address has been set. */
88         volatile uint8_t ready;
89         /**< Device is marked for removal from the data core. */
90         volatile uint8_t remove;
91 } __rte_cache_aligned;
92
93 /**
94  * Structure containing data core specific information.
95  */
96 struct lcore_ll_info {
97         /**< Pointer to head in free linked list. */
98         struct virtio_net_data_ll *ll_root_free;
99         /**< Pointer to head of used linked list. */
100         struct virtio_net_data_ll *ll_root_used;
101         /**< Number of devices on lcore. */
102         uint32_t device_num;
103         /**< Flag to synchronize device removal. */
104         volatile uint8_t dev_removal_flag;
105 };
106
107 struct lcore_info {
108         /**< Pointer to data core specific lcore_ll_info struct */
109         struct lcore_ll_info    *lcore_ll;
110 };
111
112 struct virtio_net_data_ll {
113         /**< Pointer to device created by configuration core. */
114         struct vhost_dev            *vdev;
115         /**< Pointer to next device in linked list. */
116         struct virtio_net_data_ll   *next;
117 };
118
119 uint32_t
120 virtio_dev_rx(int vid, struct rte_mbuf **pkts, uint32_t count);
121
122 #endif /* _MAIN_H_ */