xref: /dpdk/examples/vhost/main.h (revision fc1f2750a3ec6da919e3c86e59d56f34ec97154b)
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 #ifdef RTE_EXEC_ENV_BAREMETAL
38 #define MAIN _main
39 #else
40 #define MAIN main
41 #endif
42 
43 //#define DEBUG
44 
45 #ifdef DEBUG
46 #define LOG_LEVEL RTE_LOG_DEBUG
47 #define LOG_DEBUG(log_type, fmt, args...) do {	\
48 	RTE_LOG(DEBUG, log_type, fmt, ##args);		\
49 } while (0)
50 #else
51 #define LOG_LEVEL RTE_LOG_INFO
52 #define LOG_DEBUG(log_type, fmt, args...) do{} while(0)
53 #endif
54 
55 /* Macros for printing using RTE_LOG */
56 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
57 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER2
58 #define RTE_LOGTYPE_VHOST_PORT   RTE_LOGTYPE_USER3
59 
60 /**
61  * Information relating to memory regions including offsets to
62  * addresses in host physical space.
63  */
64 struct virtio_memory_regions_hpa {
65 	/**< Base guest physical address of region. */
66 	uint64_t    guest_phys_address;
67 	/**< End guest physical address of region. */
68 	uint64_t    guest_phys_address_end;
69 	/**< Size of region. */
70 	uint64_t    memory_size;
71 	/**< Offset of region for gpa to hpa translation. */
72 	uint64_t    host_phys_addr_offset;
73 };
74 
75 /*
76  * Device linked list structure for data path.
77  */
78 struct vhost_dev {
79 	/**< Pointer to device created by vhost lib. */
80 	struct virtio_net      *dev;
81 	/**< Number of memory regions for gpa to hpa translation. */
82 	uint32_t nregions_hpa;
83 	/**< Memory region information for gpa to hpa translation. */
84 	struct virtio_memory_regions_hpa *regions_hpa;
85 	/**< Device MAC address (Obtained on first TX packet). */
86 	struct ether_addr mac_address;
87 	/**< RX VMDQ queue number. */
88 	uint16_t vmdq_rx_q;
89 	/**< Vlan tag assigned to the pool */
90 	uint32_t vlan_tag;
91 	/**< Data core that the device is added to. */
92 	uint16_t coreid;
93 	/**< A device is set as ready if the MAC address has been set. */
94 	volatile uint8_t ready;
95 	/**< Device is marked for removal from the data core. */
96 	volatile uint8_t remove;
97 } __rte_cache_aligned;
98 
99 struct virtio_net_data_ll
100 {
101 	struct vhost_dev		*vdev;	/* Pointer to device created by configuration core. */
102 	struct virtio_net_data_ll	*next;  /* Pointer to next device in linked list. */
103 };
104 
105 /*
106  * Structure containing data core specific information.
107  */
108 struct lcore_ll_info
109 {
110 	struct virtio_net_data_ll	*ll_root_free; 		/* Pointer to head in free linked list. */
111 	struct virtio_net_data_ll	*ll_root_used;		/* Pointer to head of used linked list. */
112 	uint32_t 					device_num;			/* Number of devices on lcore. */
113 	volatile uint8_t			dev_removal_flag;	/* Flag to synchronize device removal. */
114 };
115 
116 struct lcore_info
117 {
118 	struct lcore_ll_info	*lcore_ll;	/* Pointer to data core specific lcore_ll_info struct */
119 };
120 
121 int MAIN(int argc, char **argv);
122 #endif /* _MAIN_H_ */
123