Imported Upstream version 16.04
[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 #ifdef DEBUG
40 #define LOG_LEVEL RTE_LOG_DEBUG
41 #define LOG_DEBUG(log_type, fmt, args...) RTE_LOG(DEBUG, log_type, fmt, ##args)
42 #else
43 #define LOG_LEVEL RTE_LOG_INFO
44 #define LOG_DEBUG(log_type, fmt, args...) do {} while (0)
45 #endif
46
47 /* Macros for printing using RTE_LOG */
48 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
49 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER2
50 #define RTE_LOGTYPE_VHOST_PORT   RTE_LOGTYPE_USER3
51
52 /* State of virtio device. */
53 #define DEVICE_MAC_LEARNING     0
54 #define DEVICE_RX               1
55 #define DEVICE_SAFE_REMOVE      2
56
57 #define MAX_QUEUES 512
58
59 /* Max burst size for RX/TX */
60 #define MAX_PKT_BURST 32
61
62 /* Max number of devices. Limited by the application. */
63 #define MAX_DEVICES 64
64
65 /* Per-device statistics struct */
66 struct device_statistics {
67         uint64_t tx_total;
68         rte_atomic64_t rx_total_atomic;
69         uint64_t rx_total;
70         uint64_t tx;
71         rte_atomic64_t rx_atomic;
72         /**< Bad inner IP csum for tunneling pkt */
73         rte_atomic64_t rx_bad_ip_csum;
74         /**< Bad inner L4 csum for tunneling pkt */
75         rte_atomic64_t rx_bad_l4_csum;
76 } __rte_cache_aligned;
77
78 /**
79  * Device linked list structure for data path.
80  */
81 struct vhost_dev {
82         /**< Pointer to device created by vhost lib. */
83         struct virtio_net      *dev;
84         /**< Number of memory regions for gpa to hpa translation. */
85         uint32_t nregions_hpa;
86         /**< Memory region information for gpa to hpa translation. */
87         struct virtio_memory_regions_hpa *regions_hpa;
88         /**< Device MAC address (Obtained on first TX packet). */
89         struct ether_addr mac_address;
90         /**< RX queue number. */
91         uint16_t rx_q;
92         /**< Data core that the device is added to. */
93         uint16_t coreid;
94         /**< A device is set as ready if the MAC address has been set. */
95         volatile uint8_t ready;
96         /**< Device is marked for removal from the data core. */
97         volatile uint8_t remove;
98 } __rte_cache_aligned;
99
100 /**
101  * Structure containing data core specific information.
102  */
103 struct lcore_ll_info {
104         /**< Pointer to head in free linked list. */
105         struct virtio_net_data_ll *ll_root_free;
106         /**< Pointer to head of used linked list. */
107         struct virtio_net_data_ll *ll_root_used;
108         /**< Number of devices on lcore. */
109         uint32_t device_num;
110         /**< Flag to synchronize device removal. */
111         volatile uint8_t dev_removal_flag;
112 };
113
114 struct lcore_info {
115         /**< Pointer to data core specific lcore_ll_info struct */
116         struct lcore_ll_info    *lcore_ll;
117 };
118
119 struct virtio_net_data_ll {
120         /**< Pointer to device created by configuration core. */
121         struct vhost_dev            *vdev;
122         /**< Pointer to next device in linked list. */
123         struct virtio_net_data_ll   *next;
124 };
125
126 uint32_t
127 virtio_dev_rx(struct virtio_net *dev, struct rte_mbuf **pkts, uint32_t count);
128
129 #endif /* _MAIN_H_ */