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>
40 #include <linux/vhost.h>
44 #include "rte_virtio_net.h"
46 /* Used to indicate that the device is running on a data core */
47 #define VIRTIO_DEV_RUNNING 1
49 /* Backend value set by guest. */
50 #define VIRTIO_DEV_STOPPED -1
52 #define BUF_VECTOR_MAX 256
55 * Structure contains buffer address, length and descriptor index
56 * from vring to do scatter RX.
65 * Structure contains variables relevant to RX/TX virtqueues.
67 struct vhost_virtqueue {
68 struct vring_desc *desc;
69 struct vring_avail *avail;
70 struct vring_used *used;
73 /* Last index used on the available ring */
74 volatile uint16_t last_used_idx;
75 #define VIRTIO_INVALID_EVENTFD (-1)
76 #define VIRTIO_UNINITIALIZED_EVENTFD (-2)
78 /* Backend value to determine if device should started/stopped */
80 /* Used to notify the guest (trigger interrupt) */
82 /* Currently unused as polling mode is enabled */
86 /* Physical address of used ring, for logging */
87 uint64_t log_guest_addr;
88 } __rte_cache_aligned;
90 /* Old kernels have no such macro defined */
91 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
92 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
97 * Make an extra wrapper for VIRTIO_NET_F_MQ and
98 * VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX as they are
99 * introduced since kernel v3.8. This makes our
100 * code buildable for older kernel.
102 #ifdef VIRTIO_NET_F_MQ
103 #define VHOST_MAX_QUEUE_PAIRS VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX
104 #define VHOST_SUPPORTS_MQ (1ULL << VIRTIO_NET_F_MQ)
106 #define VHOST_MAX_QUEUE_PAIRS 1
107 #define VHOST_SUPPORTS_MQ 0
111 * Define virtio 1.0 for older kernels
113 #ifndef VIRTIO_F_VERSION_1
114 #define VIRTIO_F_VERSION_1 32
118 * Device structure contains all configuration information relating
122 /* Frontend (QEMU) memory and memory region information */
123 struct virtio_memory *mem;
125 uint64_t protocol_features;
129 /* to tell if we need broadcast rarp packet */
130 rte_atomic16_t broadcast_rarp;
132 struct vhost_virtqueue *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
133 #define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
134 char ifname[IF_NAME_SZ];
138 struct ether_addr mac;
140 } __rte_cache_aligned;
143 * Information relating to memory regions including offsets to
144 * addresses in QEMUs memory file.
146 struct virtio_memory_regions {
147 uint64_t guest_phys_address;
148 uint64_t guest_phys_address_end;
149 uint64_t memory_size;
150 uint64_t userspace_address;
151 uint64_t address_offset;
156 * Memory structure includes region and mapping information.
158 struct virtio_memory {
159 /* Base QEMU userspace address of the memory file. */
160 uint64_t base_address;
161 uint64_t mapped_address;
162 uint64_t mapped_size;
164 struct virtio_memory_regions regions[0];
168 /* Macros for printing using RTE_LOG */
169 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
170 #define RTE_LOGTYPE_VHOST_DATA RTE_LOGTYPE_USER1
172 #ifdef RTE_LIBRTE_VHOST_DEBUG
173 #define VHOST_MAX_PRINT_BUFF 6072
174 #define LOG_LEVEL RTE_LOG_DEBUG
175 #define LOG_DEBUG(log_type, fmt, args...) RTE_LOG(DEBUG, log_type, fmt, ##args)
176 #define PRINT_PACKET(device, addr, size, header) do { \
177 char *pkt_addr = (char *)(addr); \
178 unsigned int index; \
179 char packet[VHOST_MAX_PRINT_BUFF]; \
182 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
184 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
185 for (index = 0; index < (size); index++) { \
186 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
187 "%02hhx ", pkt_addr[index]); \
189 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
191 LOG_DEBUG(VHOST_DATA, "%s", packet); \
194 #define LOG_LEVEL RTE_LOG_INFO
195 #define LOG_DEBUG(log_type, fmt, args...) do {} while (0)
196 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
199 extern uint64_t VHOST_FEATURES;
200 #define MAX_VHOST_DEVICE 1024
201 extern struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
204 * Function to convert guest physical addresses to vhost virtual addresses.
205 * This is used to convert guest virtio buffer addresses.
207 static inline uint64_t __attribute__((always_inline))
208 gpa_to_vva(struct virtio_net *dev, uint64_t guest_pa)
210 struct virtio_memory_regions *region;
212 uint64_t vhost_va = 0;
214 for (regionidx = 0; regionidx < dev->mem->nregions; regionidx++) {
215 region = &dev->mem->regions[regionidx];
216 if ((guest_pa >= region->guest_phys_address) &&
217 (guest_pa <= region->guest_phys_address_end)) {
218 vhost_va = region->address_offset + guest_pa;
225 struct virtio_net_device_ops const *notify_ops;
226 struct virtio_net *get_device(int vid);
228 int vhost_new_device(void);
229 void cleanup_device(struct virtio_net *dev, int destroy);
230 void reset_device(struct virtio_net *dev);
231 void vhost_destroy_device(int);
233 int alloc_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx);
235 void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
238 * Backend-specific cleanup. Defined by vhost-cuse and vhost-user.
240 void vhost_backend_cleanup(struct virtio_net *dev);
242 #endif /* _VHOST_NET_CDEV_H_ */