ddcd858fe00c614abffa5eed2d8cfec473358b27
[dpdk.git] / examples / vhost / main.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2016 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 <sys/queue.h>
38
39 #include <rte_ether.h>
40
41 /* Macros for printing using RTE_LOG */
42 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
43 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER2
44 #define RTE_LOGTYPE_VHOST_PORT   RTE_LOGTYPE_USER3
45
46 enum {VIRTIO_RXQ, VIRTIO_TXQ, VIRTIO_QNUM};
47
48 struct device_statistics {
49         uint64_t        tx;
50         uint64_t        tx_total;
51         rte_atomic64_t  rx_atomic;
52         rte_atomic64_t  rx_total_atomic;
53 };
54
55 struct vhost_dev {
56         /**< Number of memory regions for gpa to hpa translation. */
57         uint32_t nregions_hpa;
58         /**< Device MAC address (Obtained on first TX packet). */
59         struct ether_addr mac_address;
60         /**< RX VMDQ queue number. */
61         uint16_t vmdq_rx_q;
62         /**< Vlan tag assigned to the pool */
63         uint32_t vlan_tag;
64         /**< Data core that the device is added to. */
65         uint16_t coreid;
66         /**< A device is set as ready if the MAC address has been set. */
67         volatile uint8_t ready;
68         /**< Device is marked for removal from the data core. */
69         volatile uint8_t remove;
70
71         int vid;
72         struct device_statistics stats;
73         TAILQ_ENTRY(vhost_dev) global_vdev_entry;
74         TAILQ_ENTRY(vhost_dev) lcore_vdev_entry;
75 } __rte_cache_aligned;
76
77 TAILQ_HEAD(vhost_dev_tailq_list, vhost_dev);
78
79
80 #define REQUEST_DEV_REMOVAL     1
81 #define ACK_DEV_REMOVAL         0
82
83 /*
84  * Structure containing data core specific information.
85  */
86 struct lcore_info {
87         uint32_t                device_num;
88
89         /* Flag to synchronize device removal. */
90         volatile uint8_t        dev_removal_flag;
91
92         struct vhost_dev_tailq_list vdev_list;
93 };
94
95 #endif /* _MAIN_H_ */