222bf41e5a4f76d7c327ab84613b6a3758a66bd2
[dpdk.git] / examples / vhost / main.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 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 /* Macros for printing using RTE_LOG */
38 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
39 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER2
40 #define RTE_LOGTYPE_VHOST_PORT   RTE_LOGTYPE_USER3
41
42 /*
43  * Device linked list structure for data path.
44  */
45 struct vhost_dev {
46         /**< Pointer to device created by vhost lib. */
47         struct virtio_net      *dev;
48         /**< Number of memory regions for gpa to hpa translation. */
49         uint32_t nregions_hpa;
50         /**< Device MAC address (Obtained on first TX packet). */
51         struct ether_addr mac_address;
52         /**< RX VMDQ queue number. */
53         uint16_t vmdq_rx_q;
54         /**< Vlan tag assigned to the pool */
55         uint32_t vlan_tag;
56         /**< Data core that the device is added to. */
57         uint16_t coreid;
58         /**< A device is set as ready if the MAC address has been set. */
59         volatile uint8_t ready;
60         /**< Device is marked for removal from the data core. */
61         volatile uint8_t remove;
62 } __rte_cache_aligned;
63
64 struct virtio_net_data_ll
65 {
66         struct vhost_dev                *vdev;  /* Pointer to device created by configuration core. */
67         struct virtio_net_data_ll       *next;  /* Pointer to next device in linked list. */
68 };
69
70 /*
71  * Structure containing data core specific information.
72  */
73 struct lcore_ll_info
74 {
75         struct virtio_net_data_ll       *ll_root_free;          /* Pointer to head in free linked list. */
76         struct virtio_net_data_ll       *ll_root_used;          /* Pointer to head of used linked list. */
77         uint32_t                                        device_num;                     /* Number of devices on lcore. */
78         volatile uint8_t                        dev_removal_flag;       /* Flag to synchronize device removal. */
79 };
80
81 struct lcore_info
82 {
83         struct lcore_ll_info    *lcore_ll;      /* Pointer to data core specific lcore_ll_info struct */
84 };
85
86 #endif /* _MAIN_H_ */