4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef _VHOST_NET_CDEV_H_
35 #define _VHOST_NET_CDEV_H_
38 #include <sys/types.h>
39 #include <sys/queue.h>
41 #include <linux/vhost.h>
45 #include "rte_virtio_net.h"
47 /* Used to indicate that the device is running on a data core */
48 #define VIRTIO_DEV_RUNNING 1
50 /* Backend value set by guest. */
51 #define VIRTIO_DEV_STOPPED -1
53 #define BUF_VECTOR_MAX 256
55 #define VHOST_LOG_CACHE_NR 32
58 * Structure contains buffer address, length and descriptor index
59 * from vring to do scatter RX.
68 * A structure to hold some fields needed in zero copy code path,
69 * mainly for associating an mbuf with the right desc_idx.
72 struct rte_mbuf *mbuf;
76 TAILQ_ENTRY(zcopy_mbuf) next;
78 TAILQ_HEAD(zcopy_mbuf_list, zcopy_mbuf);
81 * Structure that contains the info for batched dirty logging.
83 struct log_cache_entry {
89 * Structure contains variables relevant to RX/TX virtqueues.
91 struct vhost_virtqueue {
92 struct vring_desc *desc;
93 struct vring_avail *avail;
94 struct vring_used *used;
97 uint16_t last_avail_idx;
98 uint16_t last_used_idx;
99 #define VIRTIO_INVALID_EVENTFD (-1)
100 #define VIRTIO_UNINITIALIZED_EVENTFD (-2)
102 /* Backend value to determine if device should started/stopped */
104 rte_spinlock_t access_lock;
106 /* Used to notify the guest (trigger interrupt) */
108 /* Currently unused as polling mode is enabled */
112 /* Physical address of used ring, for logging */
113 uint64_t log_guest_addr;
117 uint16_t last_zmbuf_idx;
118 struct zcopy_mbuf *zmbufs;
119 struct zcopy_mbuf_list zmbuf_list;
121 struct vring_used_elem *shadow_used_ring;
122 uint16_t shadow_used_idx;
124 struct log_cache_entry log_cache[VHOST_LOG_CACHE_NR];
125 uint16_t log_cache_nb_elem;
126 } __rte_cache_aligned;
128 /* Old kernels have no such macros defined */
129 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
130 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
133 #ifndef VIRTIO_NET_F_MQ
134 #define VIRTIO_NET_F_MQ 22
136 #define VHOST_MAX_QUEUE_PAIRS 0x80
139 * Define virtio 1.0 for older kernels
141 #ifndef VIRTIO_F_VERSION_1
142 #define VIRTIO_F_VERSION_1 32
146 uint64_t guest_phys_addr;
147 uint64_t host_phys_addr;
152 * Device structure contains all configuration information relating
156 /* Frontend (QEMU) memory and memory region information */
157 struct virtio_memory *mem;
159 uint64_t protocol_features;
163 /* to tell if we need broadcast rarp packet */
164 rte_atomic16_t broadcast_rarp;
166 int dequeue_zero_copy;
167 struct vhost_virtqueue *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
168 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
169 char ifname[IF_NAME_SZ];
173 struct ether_addr mac;
175 uint32_t nr_guest_pages;
176 uint32_t max_guest_pages;
177 struct guest_page *guest_pages;
178 } __rte_cache_aligned;
181 * Information relating to memory regions including offsets to
182 * addresses in QEMUs memory file.
184 struct virtio_memory_region {
185 uint64_t guest_phys_addr;
186 uint64_t guest_user_addr;
187 uint64_t host_user_addr;
196 * Memory structure includes region and mapping information.
198 struct virtio_memory {
200 struct virtio_memory_region regions[0];
204 /* Macros for printing using RTE_LOG */
205 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
206 #define RTE_LOGTYPE_VHOST_DATA RTE_LOGTYPE_USER1
208 #ifdef RTE_LIBRTE_VHOST_DEBUG
209 #define VHOST_MAX_PRINT_BUFF 6072
210 #define LOG_LEVEL RTE_LOG_DEBUG
211 #define VHOST_LOG_DEBUG(log_type, fmt, args...) \
212 RTE_LOG(DEBUG, log_type, fmt, ##args)
213 #define PRINT_PACKET(device, addr, size, header) do { \
214 char *pkt_addr = (char *)(addr); \
215 unsigned int index; \
216 char packet[VHOST_MAX_PRINT_BUFF]; \
219 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
221 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
222 for (index = 0; index < (size); index++) { \
223 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
224 "%02hhx ", pkt_addr[index]); \
226 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
228 VHOST_LOG_DEBUG(VHOST_DATA, "%s", packet); \
231 #define LOG_LEVEL RTE_LOG_INFO
232 #define VHOST_LOG_DEBUG(log_type, fmt, args...) do {} while (0)
233 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
236 extern uint64_t VHOST_FEATURES;
237 #define MAX_VHOST_DEVICE 1024
238 extern struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
240 /* Convert guest physical Address to host virtual address */
241 static inline uint64_t __attribute__((always_inline))
242 gpa_to_vva(struct virtio_net *dev, uint64_t gpa, uint64_t *len)
244 struct virtio_memory_region *r;
247 for (i = 0; i < dev->mem->nregions; i++) {
248 r = &dev->mem->regions[i];
249 if (gpa >= r->guest_phys_addr &&
250 gpa < r->guest_phys_addr + r->size) {
252 if (unlikely(*len > r->guest_phys_addr + r->size - gpa))
253 *len = r->guest_phys_addr + r->size - gpa;
255 return gpa - r->guest_phys_addr +
264 /* Convert guest physical address to host physical address */
265 static inline phys_addr_t __attribute__((always_inline))
266 gpa_to_hpa(struct virtio_net *dev, uint64_t gpa, uint64_t size)
269 struct guest_page *page;
271 for (i = 0; i < dev->nr_guest_pages; i++) {
272 page = &dev->guest_pages[i];
274 if (gpa >= page->guest_phys_addr &&
275 gpa + size < page->guest_phys_addr + page->size) {
276 return gpa - page->guest_phys_addr +
277 page->host_phys_addr;
284 struct virtio_net_device_ops const *notify_ops;
285 struct virtio_net *get_device(int vid);
287 int vhost_new_device(void);
288 void cleanup_device(struct virtio_net *dev, int destroy);
289 void reset_device(struct virtio_net *dev);
290 void vhost_destroy_device(int);
292 int alloc_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx);
294 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
295 void vhost_enable_dequeue_zero_copy(int vid);
298 * Backend-specific cleanup.
300 * TODO: fix it; we have one backend now
302 void vhost_backend_cleanup(struct virtio_net *dev);
304 #endif /* _VHOST_NET_CDEV_H_ */