1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2016 Intel Corporation
5 #include <sys/socket.h>
14 #include <rte_string_fns.h>
15 #include <rte_fbarray.h>
18 #include "virtio_user_dev.h"
20 /* The version of the protocol we support */
21 #define VHOST_USER_VERSION 0x1
23 #define VHOST_MEMORY_MAX_NREGIONS 8
27 struct vhost_memory_region regions[VHOST_MEMORY_MAX_NREGIONS];
30 struct vhost_user_msg {
31 enum vhost_user_request request;
33 #define VHOST_USER_VERSION_MASK 0x3
34 #define VHOST_USER_REPLY_MASK (0x1 << 2)
36 uint32_t size; /* the following payload size */
38 #define VHOST_USER_VRING_IDX_MASK 0xff
39 #define VHOST_USER_VRING_NOFD_MASK (0x1 << 8)
41 struct vhost_vring_state state;
42 struct vhost_vring_addr addr;
43 struct vhost_memory memory;
45 int fds[VHOST_MEMORY_MAX_NREGIONS];
48 #define VHOST_USER_HDR_SIZE offsetof(struct vhost_user_msg, payload.u64)
49 #define VHOST_USER_PAYLOAD_SIZE \
50 (sizeof(struct vhost_user_msg) - VHOST_USER_HDR_SIZE)
53 vhost_user_write(int fd, void *buf, int len, int *fds, int fd_num)
58 size_t fd_size = fd_num * sizeof(int);
59 char control[CMSG_SPACE(fd_size)];
62 memset(&msgh, 0, sizeof(msgh));
63 memset(control, 0, sizeof(control));
65 iov.iov_base = (uint8_t *)buf;
70 msgh.msg_control = control;
71 msgh.msg_controllen = sizeof(control);
73 cmsg = CMSG_FIRSTHDR(&msgh);
74 cmsg->cmsg_len = CMSG_LEN(fd_size);
75 cmsg->cmsg_level = SOL_SOCKET;
76 cmsg->cmsg_type = SCM_RIGHTS;
77 memcpy(CMSG_DATA(cmsg), fds, fd_size);
80 r = sendmsg(fd, &msgh, 0);
81 } while (r < 0 && errno == EINTR);
87 vhost_user_read(int fd, struct vhost_user_msg *msg)
89 uint32_t valid_flags = VHOST_USER_REPLY_MASK | VHOST_USER_VERSION;
90 int ret, sz_hdr = VHOST_USER_HDR_SIZE, sz_payload;
92 ret = recv(fd, (void *)msg, sz_hdr, 0);
94 PMD_DRV_LOG(ERR, "Failed to recv msg hdr: %d instead of %d.",
99 /* validate msg flags */
100 if (msg->flags != (valid_flags)) {
101 PMD_DRV_LOG(ERR, "Failed to recv msg: flags %x instead of %x.",
102 msg->flags, valid_flags);
106 sz_payload = msg->size;
108 if ((size_t)sz_payload > sizeof(msg->payload))
112 ret = recv(fd, (void *)((char *)msg + sz_hdr), sz_payload, 0);
113 if (ret < sz_payload) {
115 "Failed to recv msg payload: %d instead of %d.",
128 struct vhost_memory *vm;
134 update_memory_region(const struct rte_memseg_list *msl __rte_unused,
135 const struct rte_memseg *ms, void *arg)
137 struct walk_arg *wa = arg;
138 struct vhost_memory_region *mr;
139 uint64_t start_addr, end_addr;
143 fd = rte_memseg_get_fd_thread_unsafe(ms);
145 PMD_DRV_LOG(ERR, "Failed to get fd, ms=%p rte_errno=%d",
150 if (rte_memseg_get_fd_offset_thread_unsafe(ms, &offset) < 0) {
151 PMD_DRV_LOG(ERR, "Failed to get offset, ms=%p rte_errno=%d",
156 start_addr = (uint64_t)(uintptr_t)ms->addr;
157 end_addr = start_addr + ms->len;
159 for (i = 0; i < wa->region_nr; i++) {
160 if (wa->fds[i] != fd)
163 mr = &wa->vm->regions[i];
165 if (mr->userspace_addr + mr->memory_size < end_addr)
166 mr->memory_size = end_addr - mr->userspace_addr;
168 if (mr->userspace_addr > start_addr) {
169 mr->userspace_addr = start_addr;
170 mr->guest_phys_addr = start_addr;
173 if (mr->mmap_offset > offset)
174 mr->mmap_offset = offset;
176 PMD_DRV_LOG(DEBUG, "index=%d fd=%d offset=0x%" PRIx64
177 " addr=0x%" PRIx64 " len=%" PRIu64, i, fd,
178 mr->mmap_offset, mr->userspace_addr,
184 if (i >= VHOST_MEMORY_MAX_NREGIONS) {
185 PMD_DRV_LOG(ERR, "Too many memory regions");
189 mr = &wa->vm->regions[i];
192 mr->guest_phys_addr = start_addr;
193 mr->userspace_addr = start_addr;
194 mr->memory_size = ms->len;
195 mr->mmap_offset = offset;
197 PMD_DRV_LOG(DEBUG, "index=%d fd=%d offset=0x%" PRIx64
198 " addr=0x%" PRIx64 " len=%" PRIu64, i, fd,
199 mr->mmap_offset, mr->userspace_addr,
208 prepare_vhost_memory_user(struct vhost_user_msg *msg, int fds[])
213 wa.vm = &msg->payload.memory;
217 * The memory lock has already been taken by memory subsystem
218 * or virtio_user_start_device().
220 if (rte_memseg_walk_thread_unsafe(update_memory_region, &wa) < 0)
223 msg->payload.memory.nregions = wa.region_nr;
224 msg->payload.memory.padding = 0;
229 static struct vhost_user_msg m;
231 const char * const vhost_msg_strings[] = {
232 [VHOST_USER_SET_OWNER] = "VHOST_SET_OWNER",
233 [VHOST_USER_RESET_OWNER] = "VHOST_RESET_OWNER",
234 [VHOST_USER_SET_FEATURES] = "VHOST_SET_FEATURES",
235 [VHOST_USER_GET_FEATURES] = "VHOST_GET_FEATURES",
236 [VHOST_USER_SET_VRING_CALL] = "VHOST_SET_VRING_CALL",
237 [VHOST_USER_SET_VRING_NUM] = "VHOST_SET_VRING_NUM",
238 [VHOST_USER_SET_VRING_BASE] = "VHOST_SET_VRING_BASE",
239 [VHOST_USER_GET_VRING_BASE] = "VHOST_GET_VRING_BASE",
240 [VHOST_USER_SET_VRING_ADDR] = "VHOST_SET_VRING_ADDR",
241 [VHOST_USER_SET_VRING_KICK] = "VHOST_SET_VRING_KICK",
242 [VHOST_USER_SET_MEM_TABLE] = "VHOST_SET_MEM_TABLE",
243 [VHOST_USER_SET_VRING_ENABLE] = "VHOST_SET_VRING_ENABLE",
244 [VHOST_USER_GET_PROTOCOL_FEATURES] = "VHOST_USER_GET_PROTOCOL_FEATURES",
245 [VHOST_USER_SET_PROTOCOL_FEATURES] = "VHOST_USER_SET_PROTOCOL_FEATURES",
249 vhost_user_sock(struct virtio_user_dev *dev,
250 enum vhost_user_request req,
253 struct vhost_user_msg msg;
254 struct vhost_vring_file *file = 0;
256 int fds[VHOST_MEMORY_MAX_NREGIONS];
259 int vhostfd = dev->vhostfd;
263 PMD_DRV_LOG(INFO, "%s", vhost_msg_strings[req]);
265 if (dev->is_server && vhostfd < 0)
269 msg.flags = VHOST_USER_VERSION;
273 case VHOST_USER_GET_FEATURES:
274 case VHOST_USER_GET_PROTOCOL_FEATURES:
278 case VHOST_USER_SET_FEATURES:
279 case VHOST_USER_SET_PROTOCOL_FEATURES:
280 case VHOST_USER_SET_LOG_BASE:
281 msg.payload.u64 = *((__u64 *)arg);
282 msg.size = sizeof(m.payload.u64);
285 case VHOST_USER_SET_OWNER:
286 case VHOST_USER_RESET_OWNER:
289 case VHOST_USER_SET_MEM_TABLE:
290 if (prepare_vhost_memory_user(&msg, fds) < 0)
292 fd_num = msg.payload.memory.nregions;
293 msg.size = sizeof(m.payload.memory.nregions);
294 msg.size += sizeof(m.payload.memory.padding);
295 msg.size += fd_num * sizeof(struct vhost_memory_region);
298 case VHOST_USER_SET_LOG_FD:
299 fds[fd_num++] = *((int *)arg);
302 case VHOST_USER_SET_VRING_NUM:
303 case VHOST_USER_SET_VRING_BASE:
304 case VHOST_USER_SET_VRING_ENABLE:
305 memcpy(&msg.payload.state, arg, sizeof(msg.payload.state));
306 msg.size = sizeof(m.payload.state);
309 case VHOST_USER_GET_VRING_BASE:
310 memcpy(&msg.payload.state, arg, sizeof(msg.payload.state));
311 msg.size = sizeof(m.payload.state);
315 case VHOST_USER_SET_VRING_ADDR:
316 memcpy(&msg.payload.addr, arg, sizeof(msg.payload.addr));
317 msg.size = sizeof(m.payload.addr);
320 case VHOST_USER_SET_VRING_KICK:
321 case VHOST_USER_SET_VRING_CALL:
322 case VHOST_USER_SET_VRING_ERR:
324 msg.payload.u64 = file->index & VHOST_USER_VRING_IDX_MASK;
325 msg.size = sizeof(m.payload.u64);
327 fds[fd_num++] = file->fd;
329 msg.payload.u64 |= VHOST_USER_VRING_NOFD_MASK;
333 PMD_DRV_LOG(ERR, "trying to send unhandled msg type");
337 len = VHOST_USER_HDR_SIZE + msg.size;
338 if (vhost_user_write(vhostfd, &msg, len, fds, fd_num) < 0) {
339 PMD_DRV_LOG(ERR, "%s failed: %s",
340 vhost_msg_strings[req], strerror(errno));
345 if (vhost_user_read(vhostfd, &msg) < 0) {
346 PMD_DRV_LOG(ERR, "Received msg failed: %s",
351 if (req != msg.request) {
352 PMD_DRV_LOG(ERR, "Received unexpected msg type");
357 case VHOST_USER_GET_FEATURES:
358 case VHOST_USER_GET_PROTOCOL_FEATURES:
359 if (msg.size != sizeof(m.payload.u64)) {
360 PMD_DRV_LOG(ERR, "Received bad msg size");
363 *((__u64 *)arg) = msg.payload.u64;
365 case VHOST_USER_GET_VRING_BASE:
366 if (msg.size != sizeof(m.payload.state)) {
367 PMD_DRV_LOG(ERR, "Received bad msg size");
370 memcpy(arg, &msg.payload.state,
371 sizeof(struct vhost_vring_state));
374 PMD_DRV_LOG(ERR, "Received unexpected msg type");
382 #define MAX_VIRTIO_USER_BACKLOG 1
384 virtio_user_start_server(struct virtio_user_dev *dev, struct sockaddr_un *un)
388 int fd = dev->listenfd;
390 ret = bind(fd, (struct sockaddr *)un, sizeof(*un));
392 PMD_DRV_LOG(ERR, "failed to bind to %s: %s; remove it and try again\n",
393 dev->path, strerror(errno));
396 ret = listen(fd, MAX_VIRTIO_USER_BACKLOG);
400 flag = fcntl(fd, F_GETFL);
401 if (fcntl(fd, F_SETFL, flag | O_NONBLOCK) < 0) {
402 PMD_DRV_LOG(ERR, "fcntl failed, %s", strerror(errno));
410 * Set up environment to talk with a vhost user backend.
417 vhost_user_setup(struct virtio_user_dev *dev)
421 struct sockaddr_un un;
423 fd = socket(AF_UNIX, SOCK_STREAM, 0);
425 PMD_DRV_LOG(ERR, "socket() error, %s", strerror(errno));
429 flag = fcntl(fd, F_GETFD);
430 if (fcntl(fd, F_SETFD, flag | FD_CLOEXEC) < 0)
431 PMD_DRV_LOG(WARNING, "fcntl failed, %s", strerror(errno));
433 memset(&un, 0, sizeof(un));
434 un.sun_family = AF_UNIX;
435 strlcpy(un.sun_path, dev->path, sizeof(un.sun_path));
437 if (dev->is_server) {
439 if (virtio_user_start_server(dev, &un) < 0) {
440 PMD_DRV_LOG(ERR, "virtio-user startup fails in server mode");
446 if (connect(fd, (struct sockaddr *)&un, sizeof(un)) < 0) {
447 PMD_DRV_LOG(ERR, "connect error, %s", strerror(errno));
458 vhost_user_enable_queue_pair(struct virtio_user_dev *dev,
464 if (dev->qp_enabled[pair_idx] == enable)
467 for (i = 0; i < 2; ++i) {
468 struct vhost_vring_state state = {
469 .index = pair_idx * 2 + i,
473 if (vhost_user_sock(dev, VHOST_USER_SET_VRING_ENABLE, &state))
477 dev->qp_enabled[pair_idx] = enable;
481 struct virtio_user_backend_ops virtio_ops_user = {
482 .setup = vhost_user_setup,
483 .send_request = vhost_user_sock,
484 .enable_qp = vhost_user_enable_queue_pair