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.
40 #include <sys/types.h>
41 #include <sys/socket.h>
47 #include <rte_virtio_net.h>
50 #include "vhost-net-user.h"
51 #include "vhost-net.h"
52 #include "virtio-net-user.h"
54 #define MAX_VIRTIO_BACKLOG 128
56 static void vserver_new_vq_conn(int fd, void *data, int *remove);
57 static void vserver_message_handler(int fd, void *dat, int *remove);
58 struct vhost_net_device_ops const *ops;
61 struct vhost_server *vserver;
65 #define MAX_VHOST_SERVER 1024
66 struct _vhost_server {
67 struct vhost_server *server[MAX_VHOST_SERVER];
70 pthread_mutex_t server_mutex;
73 static struct _vhost_server g_vhost_server = {
75 .fd = { [0 ... MAX_FDS - 1] = {-1, NULL, NULL, NULL, 0} },
76 .fd_mutex = PTHREAD_MUTEX_INITIALIZER,
80 .server_mutex = PTHREAD_MUTEX_INITIALIZER,
83 static const char *vhost_message_str[VHOST_USER_MAX] = {
84 [VHOST_USER_NONE] = "VHOST_USER_NONE",
85 [VHOST_USER_GET_FEATURES] = "VHOST_USER_GET_FEATURES",
86 [VHOST_USER_SET_FEATURES] = "VHOST_USER_SET_FEATURES",
87 [VHOST_USER_SET_OWNER] = "VHOST_USER_SET_OWNER",
88 [VHOST_USER_RESET_OWNER] = "VHOST_USER_RESET_OWNER",
89 [VHOST_USER_SET_MEM_TABLE] = "VHOST_USER_SET_MEM_TABLE",
90 [VHOST_USER_SET_LOG_BASE] = "VHOST_USER_SET_LOG_BASE",
91 [VHOST_USER_SET_LOG_FD] = "VHOST_USER_SET_LOG_FD",
92 [VHOST_USER_SET_VRING_NUM] = "VHOST_USER_SET_VRING_NUM",
93 [VHOST_USER_SET_VRING_ADDR] = "VHOST_USER_SET_VRING_ADDR",
94 [VHOST_USER_SET_VRING_BASE] = "VHOST_USER_SET_VRING_BASE",
95 [VHOST_USER_GET_VRING_BASE] = "VHOST_USER_GET_VRING_BASE",
96 [VHOST_USER_SET_VRING_KICK] = "VHOST_USER_SET_VRING_KICK",
97 [VHOST_USER_SET_VRING_CALL] = "VHOST_USER_SET_VRING_CALL",
98 [VHOST_USER_SET_VRING_ERR] = "VHOST_USER_SET_VRING_ERR",
99 [VHOST_USER_GET_PROTOCOL_FEATURES] = "VHOST_USER_GET_PROTOCOL_FEATURES",
100 [VHOST_USER_SET_PROTOCOL_FEATURES] = "VHOST_USER_SET_PROTOCOL_FEATURES",
101 [VHOST_USER_GET_QUEUE_NUM] = "VHOST_USER_GET_QUEUE_NUM",
102 [VHOST_USER_SET_VRING_ENABLE] = "VHOST_USER_SET_VRING_ENABLE",
106 * Create a unix domain socket, bind to path and listen for connection.
108 * socket fd or -1 on failure
111 uds_socket(const char *path)
113 struct sockaddr_un un;
120 sockfd = socket(AF_UNIX, SOCK_STREAM, 0);
123 RTE_LOG(INFO, VHOST_CONFIG, "socket created, fd:%d\n", sockfd);
125 memset(&un, 0, sizeof(un));
126 un.sun_family = AF_UNIX;
127 snprintf(un.sun_path, sizeof(un.sun_path), "%s", path);
128 ret = bind(sockfd, (struct sockaddr *)&un, sizeof(un));
130 RTE_LOG(ERR, VHOST_CONFIG, "fail to bind fd:%d, remove file:%s and try again.\n",
134 RTE_LOG(INFO, VHOST_CONFIG, "bind to %s\n", path);
136 ret = listen(sockfd, MAX_VIRTIO_BACKLOG);
147 /* return bytes# of read on success or negative val on failure. */
149 read_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num)
153 size_t fdsize = fd_num * sizeof(int);
154 char control[CMSG_SPACE(fdsize)];
155 struct cmsghdr *cmsg;
158 memset(&msgh, 0, sizeof(msgh));
160 iov.iov_len = buflen;
164 msgh.msg_control = control;
165 msgh.msg_controllen = sizeof(control);
167 ret = recvmsg(sockfd, &msgh, 0);
169 RTE_LOG(ERR, VHOST_CONFIG, "recvmsg failed\n");
173 if (msgh.msg_flags & (MSG_TRUNC | MSG_CTRUNC)) {
174 RTE_LOG(ERR, VHOST_CONFIG, "truncted msg\n");
178 for (cmsg = CMSG_FIRSTHDR(&msgh); cmsg != NULL;
179 cmsg = CMSG_NXTHDR(&msgh, cmsg)) {
180 if ((cmsg->cmsg_level == SOL_SOCKET) &&
181 (cmsg->cmsg_type == SCM_RIGHTS)) {
182 memcpy(fds, CMSG_DATA(cmsg), fdsize);
190 /* return bytes# of read on success or negative val on failure. */
192 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
196 ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
197 msg->fds, VHOST_MEMORY_MAX_NREGIONS);
201 if (msg && msg->size) {
202 if (msg->size > sizeof(msg->payload)) {
203 RTE_LOG(ERR, VHOST_CONFIG,
204 "invalid msg size: %d\n", msg->size);
207 ret = read(sockfd, &msg->payload, msg->size);
210 if (ret != (int)msg->size) {
211 RTE_LOG(ERR, VHOST_CONFIG,
212 "read control message failed\n");
221 send_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num)
226 size_t fdsize = fd_num * sizeof(int);
227 char control[CMSG_SPACE(fdsize)];
228 struct cmsghdr *cmsg;
231 memset(&msgh, 0, sizeof(msgh));
233 iov.iov_len = buflen;
238 if (fds && fd_num > 0) {
239 msgh.msg_control = control;
240 msgh.msg_controllen = sizeof(control);
241 cmsg = CMSG_FIRSTHDR(&msgh);
242 cmsg->cmsg_len = CMSG_LEN(fdsize);
243 cmsg->cmsg_level = SOL_SOCKET;
244 cmsg->cmsg_type = SCM_RIGHTS;
245 memcpy(CMSG_DATA(cmsg), fds, fdsize);
247 msgh.msg_control = NULL;
248 msgh.msg_controllen = 0;
252 ret = sendmsg(sockfd, &msgh, 0);
253 } while (ret < 0 && errno == EINTR);
256 RTE_LOG(ERR, VHOST_CONFIG, "sendmsg error\n");
264 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
271 msg->flags &= ~VHOST_USER_VERSION_MASK;
272 msg->flags |= VHOST_USER_VERSION;
273 msg->flags |= VHOST_USER_REPLY_MASK;
275 ret = send_fd_message(sockfd, (char *)msg,
276 VHOST_USER_HDR_SIZE + msg->size, NULL, 0);
281 /* call back when there is new virtio connection. */
283 vserver_new_vq_conn(int fd, void *dat, __rte_unused int *remove)
285 struct vhost_server *vserver = (struct vhost_server *)dat;
287 struct connfd_ctx *ctx;
289 struct vhost_device_ctx vdev_ctx = { (pid_t)0, 0 };
292 conn_fd = accept(fd, NULL, NULL);
293 RTE_LOG(INFO, VHOST_CONFIG,
294 "new virtio connection is %d\n", conn_fd);
298 ctx = calloc(1, sizeof(*ctx));
304 fh = ops->new_device(vdev_ctx);
312 size = strnlen(vserver->path, PATH_MAX);
313 ops->set_ifname(vdev_ctx, vserver->path,
316 RTE_LOG(INFO, VHOST_CONFIG, "new device, handle is %d\n", fh);
318 ctx->vserver = vserver;
320 fdset_add(&g_vhost_server.fdset,
321 conn_fd, vserver_message_handler, NULL, ctx);
324 /* callback when there is message on the connfd */
326 vserver_message_handler(int connfd, void *dat, int *remove)
328 struct vhost_device_ctx ctx;
329 struct connfd_ctx *cfd_ctx = (struct connfd_ctx *)dat;
330 struct VhostUserMsg msg;
334 ctx.fh = cfd_ctx->fh;
335 ret = read_vhost_message(connfd, &msg);
336 if (ret <= 0 || msg.request >= VHOST_USER_MAX) {
338 RTE_LOG(ERR, VHOST_CONFIG,
339 "vhost read message failed\n");
341 RTE_LOG(INFO, VHOST_CONFIG,
342 "vhost peer closed\n");
344 RTE_LOG(ERR, VHOST_CONFIG,
345 "vhost read incorrect message\n");
350 user_destroy_device(ctx);
351 ops->destroy_device(ctx);
356 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
357 vhost_message_str[msg.request]);
358 switch (msg.request) {
359 case VHOST_USER_GET_FEATURES:
360 ret = ops->get_features(ctx, &features);
361 msg.payload.u64 = features;
362 msg.size = sizeof(msg.payload.u64);
363 send_vhost_message(connfd, &msg);
365 case VHOST_USER_SET_FEATURES:
366 features = msg.payload.u64;
367 ops->set_features(ctx, &features);
370 case VHOST_USER_GET_PROTOCOL_FEATURES:
371 msg.payload.u64 = VHOST_USER_PROTOCOL_FEATURES;
372 msg.size = sizeof(msg.payload.u64);
373 send_vhost_message(connfd, &msg);
375 case VHOST_USER_SET_PROTOCOL_FEATURES:
376 user_set_protocol_features(ctx, msg.payload.u64);
379 case VHOST_USER_SET_OWNER:
382 case VHOST_USER_RESET_OWNER:
383 ops->reset_owner(ctx);
386 case VHOST_USER_SET_MEM_TABLE:
387 user_set_mem_table(ctx, &msg);
390 case VHOST_USER_SET_LOG_BASE:
391 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
394 case VHOST_USER_SET_LOG_FD:
396 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
399 case VHOST_USER_SET_VRING_NUM:
400 ops->set_vring_num(ctx, &msg.payload.state);
402 case VHOST_USER_SET_VRING_ADDR:
403 ops->set_vring_addr(ctx, &msg.payload.addr);
405 case VHOST_USER_SET_VRING_BASE:
406 ops->set_vring_base(ctx, &msg.payload.state);
409 case VHOST_USER_GET_VRING_BASE:
410 ret = user_get_vring_base(ctx, &msg.payload.state);
411 msg.size = sizeof(msg.payload.state);
412 send_vhost_message(connfd, &msg);
415 case VHOST_USER_SET_VRING_KICK:
416 user_set_vring_kick(ctx, &msg);
418 case VHOST_USER_SET_VRING_CALL:
419 user_set_vring_call(ctx, &msg);
422 case VHOST_USER_SET_VRING_ERR:
423 if (!(msg.payload.u64 & VHOST_USER_VRING_NOFD_MASK))
425 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
428 case VHOST_USER_GET_QUEUE_NUM:
429 msg.payload.u64 = VHOST_MAX_QUEUE_PAIRS;
430 msg.size = sizeof(msg.payload.u64);
431 send_vhost_message(connfd, &msg);
434 case VHOST_USER_SET_VRING_ENABLE:
435 user_set_vring_enable(ctx, &msg.payload.state);
445 * Creates and initialise the vhost server.
448 rte_vhost_driver_register(const char *path)
450 struct vhost_server *vserver;
452 pthread_mutex_lock(&g_vhost_server.server_mutex);
454 ops = get_virtio_net_callbacks();
456 if (g_vhost_server.vserver_cnt == MAX_VHOST_SERVER) {
457 RTE_LOG(ERR, VHOST_CONFIG,
458 "error: the number of servers reaches maximum\n");
459 pthread_mutex_unlock(&g_vhost_server.server_mutex);
463 vserver = calloc(sizeof(struct vhost_server), 1);
464 if (vserver == NULL) {
465 pthread_mutex_unlock(&g_vhost_server.server_mutex);
469 vserver->listenfd = uds_socket(path);
470 if (vserver->listenfd < 0) {
472 pthread_mutex_unlock(&g_vhost_server.server_mutex);
476 vserver->path = strdup(path);
478 fdset_add(&g_vhost_server.fdset, vserver->listenfd,
479 vserver_new_vq_conn, NULL, vserver);
481 g_vhost_server.server[g_vhost_server.vserver_cnt++] = vserver;
482 pthread_mutex_unlock(&g_vhost_server.server_mutex);
489 * Unregister the specified vhost server
492 rte_vhost_driver_unregister(const char *path)
497 pthread_mutex_lock(&g_vhost_server.server_mutex);
499 for (i = 0; i < g_vhost_server.vserver_cnt; i++) {
500 if (!strcmp(g_vhost_server.server[i]->path, path)) {
501 fdset_del(&g_vhost_server.fdset,
502 g_vhost_server.server[i]->listenfd);
504 close(g_vhost_server.server[i]->listenfd);
505 free(g_vhost_server.server[i]->path);
506 free(g_vhost_server.server[i]);
510 count = --g_vhost_server.vserver_cnt;
511 g_vhost_server.server[i] = g_vhost_server.server[count];
512 g_vhost_server.server[count] = NULL;
513 pthread_mutex_unlock(&g_vhost_server.server_mutex);
518 pthread_mutex_unlock(&g_vhost_server.server_mutex);
524 rte_vhost_driver_session_start(void)
526 fdset_event_dispatch(&g_vhost_server.fdset);