4 * Copyright(c) 2010-2016 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.
41 #include <sys/eventfd.h>
42 #include <sys/types.h>
47 #include "virtio_user_dev.h"
48 #include "../virtio_ethdev.h"
51 virtio_user_create_queue(struct virtio_user_dev *dev, uint32_t queue_sel)
53 /* Of all per virtqueue MSGs, make sure VHOST_SET_VRING_CALL come
54 * firstly because vhost depends on this msg to allocate virtqueue
57 struct vhost_vring_file file;
59 file.index = queue_sel;
60 file.fd = dev->callfds[queue_sel];
61 dev->ops->send_request(dev, VHOST_USER_SET_VRING_CALL, &file);
67 virtio_user_kick_queue(struct virtio_user_dev *dev, uint32_t queue_sel)
69 struct vhost_vring_file file;
70 struct vhost_vring_state state;
71 struct vring *vring = &dev->vrings[queue_sel];
72 struct vhost_vring_addr addr = {
74 .desc_user_addr = (uint64_t)(uintptr_t)vring->desc,
75 .avail_user_addr = (uint64_t)(uintptr_t)vring->avail,
76 .used_user_addr = (uint64_t)(uintptr_t)vring->used,
78 .flags = 0, /* disable log */
81 state.index = queue_sel;
82 state.num = vring->num;
83 dev->ops->send_request(dev, VHOST_USER_SET_VRING_NUM, &state);
85 state.index = queue_sel;
86 state.num = 0; /* no reservation */
87 dev->ops->send_request(dev, VHOST_USER_SET_VRING_BASE, &state);
89 dev->ops->send_request(dev, VHOST_USER_SET_VRING_ADDR, &addr);
91 /* Of all per virtqueue MSGs, make sure VHOST_USER_SET_VRING_KICK comes
92 * lastly because vhost depends on this msg to judge if
95 file.index = queue_sel;
96 file.fd = dev->kickfds[queue_sel];
97 dev->ops->send_request(dev, VHOST_USER_SET_VRING_KICK, &file);
103 virtio_user_queue_setup(struct virtio_user_dev *dev,
104 int (*fn)(struct virtio_user_dev *, uint32_t))
106 uint32_t i, queue_sel;
108 for (i = 0; i < dev->max_queue_pairs; ++i) {
109 queue_sel = 2 * i + VTNET_SQ_RQ_QUEUE_IDX;
110 if (fn(dev, queue_sel) < 0) {
111 PMD_DRV_LOG(INFO, "setup rx vq fails: %u", i);
115 for (i = 0; i < dev->max_queue_pairs; ++i) {
116 queue_sel = 2 * i + VTNET_SQ_TQ_QUEUE_IDX;
117 if (fn(dev, queue_sel) < 0) {
118 PMD_DRV_LOG(INFO, "setup tx vq fails: %u", i);
127 virtio_user_start_device(struct virtio_user_dev *dev)
132 /* Step 0: tell vhost to create queues */
133 if (virtio_user_queue_setup(dev, virtio_user_create_queue) < 0)
136 /* Step 1: set features */
137 features = dev->features;
138 /* Strip VIRTIO_NET_F_MAC, as MAC address is handled in vdev init */
139 features &= ~(1ull << VIRTIO_NET_F_MAC);
140 /* Strip VIRTIO_NET_F_CTRL_VQ, as devices do not really need to know */
141 features &= ~(1ull << VIRTIO_NET_F_CTRL_VQ);
142 ret = dev->ops->send_request(dev, VHOST_USER_SET_FEATURES, &features);
145 PMD_DRV_LOG(INFO, "set features: %" PRIx64, features);
147 /* Step 2: share memory regions */
148 ret = dev->ops->send_request(dev, VHOST_USER_SET_MEM_TABLE, NULL);
152 /* Step 3: kick queues */
153 if (virtio_user_queue_setup(dev, virtio_user_kick_queue) < 0)
156 /* Step 4: enable queues
157 * we enable the 1st queue pair by default.
159 dev->ops->enable_qp(dev, 0, 1);
163 /* TODO: free resource here or caller to check */
167 int virtio_user_stop_device(struct virtio_user_dev *dev)
171 for (i = 0; i < dev->max_queue_pairs; ++i)
172 dev->ops->enable_qp(dev, i, 0);
178 parse_mac(struct virtio_user_dev *dev, const char *mac)
181 uint32_t tmp[ETHER_ADDR_LEN];
186 r = sscanf(mac, "%x:%x:%x:%x:%x:%x", &tmp[0],
187 &tmp[1], &tmp[2], &tmp[3], &tmp[4], &tmp[5]);
188 if (r == ETHER_ADDR_LEN) {
189 for (i = 0; i < ETHER_ADDR_LEN; ++i)
190 dev->mac_addr[i] = (uint8_t)tmp[i];
191 dev->mac_specified = 1;
193 /* ignore the wrong mac, use random mac */
194 PMD_DRV_LOG(ERR, "wrong format of mac: %s", mac);
199 is_vhost_user_by_type(const char *path)
203 if (stat(path, &sb) == -1)
206 return S_ISSOCK(sb.st_mode);
210 virtio_user_dev_init_notify(struct virtio_user_dev *dev)
216 for (i = 0; i < VIRTIO_MAX_VIRTQUEUES; ++i) {
217 if (i >= dev->max_queue_pairs * 2) {
218 dev->kickfds[i] = -1;
219 dev->callfds[i] = -1;
223 /* May use invalid flag, but some backend uses kickfd and
224 * callfd as criteria to judge if dev is alive. so finally we
227 callfd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
229 PMD_DRV_LOG(ERR, "callfd error, %s", strerror(errno));
232 kickfd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
234 PMD_DRV_LOG(ERR, "kickfd error, %s", strerror(errno));
237 dev->callfds[i] = callfd;
238 dev->kickfds[i] = kickfd;
241 if (i < VIRTIO_MAX_VIRTQUEUES) {
242 for (j = 0; j <= i; ++j) {
243 close(dev->callfds[j]);
244 close(dev->kickfds[j]);
254 virtio_user_dev_setup(struct virtio_user_dev *dev)
259 dev->vhostfds = NULL;
262 if (virtio_user_dev_init_notify(dev) < 0)
265 if (is_vhost_user_by_type(dev->path)) {
266 dev->ops = &ops_user;
268 dev->ops = &ops_kernel;
270 dev->vhostfds = malloc(dev->max_queue_pairs * sizeof(int));
271 dev->tapfds = malloc(dev->max_queue_pairs * sizeof(int));
272 if (!dev->vhostfds || !dev->tapfds) {
273 PMD_INIT_LOG(ERR, "Failed to malloc");
277 for (q = 0; q < dev->max_queue_pairs; ++q) {
278 dev->vhostfds[q] = -1;
283 return dev->ops->setup(dev);
287 virtio_user_dev_init(struct virtio_user_dev *dev, char *path, int queues,
288 int cq, int queue_size, const char *mac, char **ifname)
290 snprintf(dev->path, PATH_MAX, "%s", path);
291 dev->max_queue_pairs = queues;
292 dev->queue_pairs = 1; /* mq disabled by default */
293 dev->queue_size = queue_size;
294 dev->mac_specified = 0;
298 dev->ifname = *ifname;
302 if (virtio_user_dev_setup(dev) < 0) {
303 PMD_INIT_LOG(ERR, "backend set up fails");
306 if (dev->ops->send_request(dev, VHOST_USER_SET_OWNER, NULL) < 0) {
307 PMD_INIT_LOG(ERR, "set_owner fails: %s", strerror(errno));
311 if (dev->ops->send_request(dev, VHOST_USER_GET_FEATURES,
312 &dev->device_features) < 0) {
313 PMD_INIT_LOG(ERR, "get_features failed: %s", strerror(errno));
316 if (dev->mac_specified)
317 dev->device_features |= (1ull << VIRTIO_NET_F_MAC);
320 /* device does not really need to know anything about CQ,
321 * so if necessary, we just claim to support CQ
323 dev->device_features |= (1ull << VIRTIO_NET_F_CTRL_VQ);
325 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_VQ);
326 /* Also disable features depends on VIRTIO_NET_F_CTRL_VQ */
327 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_RX);
328 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_VLAN);
329 dev->device_features &= ~(1ull << VIRTIO_NET_F_GUEST_ANNOUNCE);
330 dev->device_features &= ~(1ull << VIRTIO_NET_F_MQ);
331 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_MAC_ADDR);
338 virtio_user_dev_uninit(struct virtio_user_dev *dev)
342 virtio_user_stop_device(dev);
344 for (i = 0; i < dev->max_queue_pairs * 2; ++i) {
345 close(dev->callfds[i]);
346 close(dev->kickfds[i]);
352 for (i = 0; i < dev->max_queue_pairs; ++i)
353 close(dev->vhostfds[i]);
362 virtio_user_handle_mq(struct virtio_user_dev *dev, uint16_t q_pairs)
367 if (q_pairs > dev->max_queue_pairs) {
368 PMD_INIT_LOG(ERR, "multi-q config %u, but only %u supported",
369 q_pairs, dev->max_queue_pairs);
373 for (i = 0; i < q_pairs; ++i)
374 ret |= dev->ops->enable_qp(dev, i, 1);
375 for (i = q_pairs; i < dev->max_queue_pairs; ++i)
376 ret |= dev->ops->enable_qp(dev, i, 0);
378 dev->queue_pairs = q_pairs;
384 virtio_user_handle_ctrl_msg(struct virtio_user_dev *dev, struct vring *vring,
387 struct virtio_net_ctrl_hdr *hdr;
388 virtio_net_ctrl_ack status = ~0;
389 uint16_t i, idx_data, idx_status;
390 uint32_t n_descs = 0;
392 /* locate desc for header, data, and status */
393 idx_data = vring->desc[idx_hdr].next;
397 while (vring->desc[i].flags == VRING_DESC_F_NEXT) {
398 i = vring->desc[i].next;
402 /* locate desc for status */
406 hdr = (void *)(uintptr_t)vring->desc[idx_hdr].addr;
407 if (hdr->class == VIRTIO_NET_CTRL_MQ &&
408 hdr->cmd == VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET) {
411 queues = *(uint16_t *)(uintptr_t)vring->desc[idx_data].addr;
412 status = virtio_user_handle_mq(dev, queues);
416 *(virtio_net_ctrl_ack *)(uintptr_t)vring->desc[idx_status].addr = status;
422 virtio_user_handle_cq(struct virtio_user_dev *dev, uint16_t queue_idx)
424 uint16_t avail_idx, desc_idx;
425 struct vring_used_elem *uep;
427 struct vring *vring = &dev->vrings[queue_idx];
429 /* Consume avail ring, using used ring idx as first one */
430 while (vring->used->idx != vring->avail->idx) {
431 avail_idx = (vring->used->idx) & (vring->num - 1);
432 desc_idx = vring->avail->ring[avail_idx];
434 n_descs = virtio_user_handle_ctrl_msg(dev, vring, desc_idx);
436 /* Update used ring */
437 uep = &vring->used->ring[avail_idx];