eal: set name when creating a control thread
[dpdk.git] / lib / librte_vhost / socket.c
index 422da00..4a561ad 100644 (file)
@@ -1,39 +1,9 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2016 Intel Corporation
  */
 
 #include <stdint.h>
 #include <stdio.h>
-#include <stdbool.h>
 #include <limits.h>
 #include <stdlib.h>
 #include <unistd.h>
@@ -69,6 +39,7 @@ struct vhost_user_socket {
        bool reconnect;
        bool dequeue_zero_copy;
        bool iommu_support;
+       bool use_builtin_virtio_net;
 
        /*
         * The "supported_features" indicates the feature bits the
@@ -80,6 +51,13 @@ struct vhost_user_socket {
        uint64_t supported_features;
        uint64_t features;
 
+       /*
+        * Device id to identify a specific backend device.
+        * It's set to -1 for the default software implementation.
+        * If valid, one socket can have 1 connection only.
+        */
+       int vdpa_dev_id;
+
        struct vhost_device_ops const *notify_ops;
 };
 
@@ -125,6 +103,7 @@ read_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num)
        size_t fdsize = fd_num * sizeof(int);
        char control[CMSG_SPACE(fdsize)];
        struct cmsghdr *cmsg;
+       int got_fds = 0;
        int ret;
 
        memset(&msgh, 0, sizeof(msgh));
@@ -151,11 +130,16 @@ read_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num)
                cmsg = CMSG_NXTHDR(&msgh, cmsg)) {
                if ((cmsg->cmsg_level == SOL_SOCKET) &&
                        (cmsg->cmsg_type == SCM_RIGHTS)) {
-                       memcpy(fds, CMSG_DATA(cmsg), fdsize);
+                       got_fds = (cmsg->cmsg_len - CMSG_LEN(0)) / sizeof(int);
+                       memcpy(fds, CMSG_DATA(cmsg), got_fds * sizeof(int));
                        break;
                }
        }
 
+       /* Clear out unused file descriptors */
+       while (got_fds < fd_num)
+               fds[got_fds++] = -1;
+
        return ret;
 }
 
@@ -181,6 +165,11 @@ send_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num)
                msgh.msg_control = control;
                msgh.msg_controllen = sizeof(control);
                cmsg = CMSG_FIRSTHDR(&msgh);
+               if (cmsg == NULL) {
+                       RTE_LOG(ERR, VHOST_CONFIG, "cmsg == NULL\n");
+                       errno = EINVAL;
+                       return -1;
+               }
                cmsg->cmsg_len = CMSG_LEN(fdsize);
                cmsg->cmsg_level = SOL_SOCKET;
                cmsg->cmsg_type = SCM_RIGHTS;
@@ -191,7 +180,7 @@ send_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num)
        }
 
        do {
-               ret = sendmsg(sockfd, &msgh, 0);
+               ret = sendmsg(sockfd, &msgh, MSG_NOSIGNAL);
        } while (ret < 0 && errno == EINTR);
 
        if (ret < 0) {
@@ -224,6 +213,10 @@ vhost_user_add_connection(int fd, struct vhost_user_socket *vsocket)
        size = strnlen(vsocket->path, PATH_MAX);
        vhost_set_ifname(vid, vsocket->path, size);
 
+       vhost_set_builtin_virtio_net(vid, vsocket->use_builtin_virtio_net);
+
+       vhost_attach_vdpa_device(vid, vsocket->vdpa_dev_id);
+
        if (vsocket->dequeue_zero_copy)
                vhost_enable_dequeue_zero_copy(vid);
 
@@ -258,6 +251,8 @@ vhost_user_add_connection(int fd, struct vhost_user_socket *vsocket)
        pthread_mutex_lock(&vsocket->conn_mutex);
        TAILQ_INSERT_TAIL(&vsocket->conn_list, conn, next);
        pthread_mutex_unlock(&vsocket->conn_mutex);
+
+       fdset_pipe_notify(&vhost_user.fdset);
        return;
 
 err:
@@ -344,6 +339,16 @@ vhost_user_start_server(struct vhost_user_socket *vsocket)
        int fd = vsocket->socket_fd;
        const char *path = vsocket->path;
 
+       /*
+        * bind () may fail if the socket file with the same name already
+        * exists. But the library obviously should not delete the file
+        * provided by the user, since we can not be sure that it is not
+        * being used by other applications. Moreover, many applications form
+        * socket names based on user input, which is prone to errors.
+        *
+        * The user must ensure that the socket does not exist before
+        * registering the vhost driver in server mode.
+        */
        ret = bind(fd, (struct sockaddr *)&vsocket->un, sizeof(vsocket->un));
        if (ret < 0) {
                RTE_LOG(ERR, VHOST_CONFIG,
@@ -470,9 +475,9 @@ vhost_user_reconnect_init(void)
        }
        TAILQ_INIT(&reconn_list.head);
 
-       ret = pthread_create(&reconn_tid, NULL,
+       ret = rte_ctrl_thread_create(&reconn_tid, "vhost_reconn", NULL,
                             vhost_user_client_reconnect, NULL);
-       if (ret < 0) {
+       if (ret != 0) {
                RTE_LOG(ERR, VHOST_CONFIG, "failed to create reconnect thread");
                if (pthread_mutex_destroy(&reconn_list.mutex)) {
                        RTE_LOG(ERR, VHOST_CONFIG,
@@ -540,6 +545,52 @@ find_vhost_user_socket(const char *path)
        return NULL;
 }
 
+int
+rte_vhost_driver_attach_vdpa_device(const char *path, int did)
+{
+       struct vhost_user_socket *vsocket;
+
+       if (rte_vdpa_get_device(did) == NULL)
+               return -1;
+
+       pthread_mutex_lock(&vhost_user.mutex);
+       vsocket = find_vhost_user_socket(path);
+       if (vsocket)
+               vsocket->vdpa_dev_id = did;
+       pthread_mutex_unlock(&vhost_user.mutex);
+
+       return vsocket ? 0 : -1;
+}
+
+int
+rte_vhost_driver_detach_vdpa_device(const char *path)
+{
+       struct vhost_user_socket *vsocket;
+
+       pthread_mutex_lock(&vhost_user.mutex);
+       vsocket = find_vhost_user_socket(path);
+       if (vsocket)
+               vsocket->vdpa_dev_id = -1;
+       pthread_mutex_unlock(&vhost_user.mutex);
+
+       return vsocket ? 0 : -1;
+}
+
+int
+rte_vhost_driver_get_vdpa_device_id(const char *path)
+{
+       struct vhost_user_socket *vsocket;
+       int did = -1;
+
+       pthread_mutex_lock(&vhost_user.mutex);
+       vsocket = find_vhost_user_socket(path);
+       if (vsocket)
+               did = vsocket->vdpa_dev_id;
+       pthread_mutex_unlock(&vhost_user.mutex);
+
+       return did;
+}
+
 int
 rte_vhost_driver_disable_features(const char *path, uint64_t features)
 {
@@ -547,6 +598,12 @@ rte_vhost_driver_disable_features(const char *path, uint64_t features)
 
        pthread_mutex_lock(&vhost_user.mutex);
        vsocket = find_vhost_user_socket(path);
+
+       /* Note that use_builtin_virtio_net is not affected by this function
+        * since callers may want to selectively disable features of the
+        * built-in vhost net device backend.
+        */
+
        if (vsocket)
                vsocket->features &= ~features;
        pthread_mutex_unlock(&vhost_user.mutex);
@@ -587,6 +644,11 @@ rte_vhost_driver_set_features(const char *path, uint64_t features)
        if (vsocket) {
                vsocket->supported_features = features;
                vsocket->features = features;
+
+               /* Anyone setting feature bits is implementing their own vhost
+                * device backend.
+                */
+               vsocket->use_builtin_virtio_net = false;
        }
        pthread_mutex_unlock(&vhost_user.mutex);
 
@@ -597,20 +659,123 @@ int
 rte_vhost_driver_get_features(const char *path, uint64_t *features)
 {
        struct vhost_user_socket *vsocket;
+       uint64_t vdpa_features;
+       struct rte_vdpa_device *vdpa_dev;
+       int did = -1;
+       int ret = 0;
 
        pthread_mutex_lock(&vhost_user.mutex);
        vsocket = find_vhost_user_socket(path);
-       if (vsocket)
+       if (!vsocket) {
+               RTE_LOG(ERR, VHOST_CONFIG,
+                       "socket file %s is not registered yet.\n", path);
+               ret = -1;
+               goto unlock_exit;
+       }
+
+       did = vsocket->vdpa_dev_id;
+       vdpa_dev = rte_vdpa_get_device(did);
+       if (!vdpa_dev || !vdpa_dev->ops->get_features) {
                *features = vsocket->features;
+               goto unlock_exit;
+       }
+
+       if (vdpa_dev->ops->get_features(did, &vdpa_features) < 0) {
+               RTE_LOG(ERR, VHOST_CONFIG,
+                               "failed to get vdpa features "
+                               "for socket file %s.\n", path);
+               ret = -1;
+               goto unlock_exit;
+       }
+
+       *features = vsocket->features & vdpa_features;
+
+unlock_exit:
        pthread_mutex_unlock(&vhost_user.mutex);
+       return ret;
+}
 
+int
+rte_vhost_driver_get_protocol_features(const char *path,
+               uint64_t *protocol_features)
+{
+       struct vhost_user_socket *vsocket;
+       uint64_t vdpa_protocol_features;
+       struct rte_vdpa_device *vdpa_dev;
+       int did = -1;
+       int ret = 0;
+
+       pthread_mutex_lock(&vhost_user.mutex);
+       vsocket = find_vhost_user_socket(path);
        if (!vsocket) {
                RTE_LOG(ERR, VHOST_CONFIG,
                        "socket file %s is not registered yet.\n", path);
-               return -1;
-       } else {
-               return 0;
+               ret = -1;
+               goto unlock_exit;
+       }
+
+       did = vsocket->vdpa_dev_id;
+       vdpa_dev = rte_vdpa_get_device(did);
+       if (!vdpa_dev || !vdpa_dev->ops->get_protocol_features) {
+               *protocol_features = VHOST_USER_PROTOCOL_FEATURES;
+               goto unlock_exit;
+       }
+
+       if (vdpa_dev->ops->get_protocol_features(did,
+                               &vdpa_protocol_features) < 0) {
+               RTE_LOG(ERR, VHOST_CONFIG,
+                               "failed to get vdpa protocol features "
+                               "for socket file %s.\n", path);
+               ret = -1;
+               goto unlock_exit;
+       }
+
+       *protocol_features = VHOST_USER_PROTOCOL_FEATURES
+               & vdpa_protocol_features;
+
+unlock_exit:
+       pthread_mutex_unlock(&vhost_user.mutex);
+       return ret;
+}
+
+int
+rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num)
+{
+       struct vhost_user_socket *vsocket;
+       uint32_t vdpa_queue_num;
+       struct rte_vdpa_device *vdpa_dev;
+       int did = -1;
+       int ret = 0;
+
+       pthread_mutex_lock(&vhost_user.mutex);
+       vsocket = find_vhost_user_socket(path);
+       if (!vsocket) {
+               RTE_LOG(ERR, VHOST_CONFIG,
+                       "socket file %s is not registered yet.\n", path);
+               ret = -1;
+               goto unlock_exit;
        }
+
+       did = vsocket->vdpa_dev_id;
+       vdpa_dev = rte_vdpa_get_device(did);
+       if (!vdpa_dev || !vdpa_dev->ops->get_queue_num) {
+               *queue_num = VHOST_MAX_QUEUE_PAIRS;
+               goto unlock_exit;
+       }
+
+       if (vdpa_dev->ops->get_queue_num(did, &vdpa_queue_num) < 0) {
+               RTE_LOG(ERR, VHOST_CONFIG,
+                               "failed to get vdpa queue number "
+                               "for socket file %s.\n", path);
+               ret = -1;
+               goto unlock_exit;
+       }
+
+       *queue_num = RTE_MIN((uint32_t)VHOST_MAX_QUEUE_PAIRS, vdpa_queue_num);
+
+unlock_exit:
+       pthread_mutex_unlock(&vhost_user.mutex);
+       return ret;
 }
 
 /*
@@ -667,6 +832,7 @@ rte_vhost_driver_register(const char *path, uint64_t flags)
         * rte_vhost_driver_set_features(), which will overwrite following
         * two values.
         */
+       vsocket->use_builtin_virtio_net = true;
        vsocket->supported_features = VIRTIO_NET_SUPPORTED_FEATURES;
        vsocket->features           = VIRTIO_NET_SUPPORTED_FEATURES;
 
@@ -678,9 +844,8 @@ rte_vhost_driver_register(const char *path, uint64_t flags)
        if ((flags & RTE_VHOST_USER_CLIENT) != 0) {
                vsocket->reconnect = !(flags & RTE_VHOST_USER_NO_RECONNECT);
                if (vsocket->reconnect && reconn_tid == 0) {
-                       if (vhost_user_reconnect_init() < 0) {
+                       if (vhost_user_reconnect_init() != 0)
                                goto out_mutex;
-                       }
                }
        } else {
                vsocket->is_server = true;
@@ -835,11 +1000,26 @@ rte_vhost_driver_start(const char *path)
                return -1;
 
        if (fdset_tid == 0) {
-               int ret = pthread_create(&fdset_tid, NULL, fdset_event_dispatch,
-                                    &vhost_user.fdset);
-               if (ret < 0)
+               /**
+                * create a pipe which will be waited by poll and notified to
+                * rebuild the wait list of poll.
+                */
+               if (fdset_pipe_init(&vhost_user.fdset) < 0) {
+                       RTE_LOG(ERR, VHOST_CONFIG,
+                               "failed to create pipe for vhost fdset\n");
+                       return -1;
+               }
+
+               int ret = rte_ctrl_thread_create(&fdset_tid,
+                       "vhost-events", NULL, fdset_event_dispatch,
+                       &vhost_user.fdset);
+               if (ret != 0) {
                        RTE_LOG(ERR, VHOST_CONFIG,
                                "failed to create fdset handling thread");
+
+                       fdset_pipe_uninit(&vhost_user.fdset);
+                       return -1;
+               }
        }
 
        if (vsocket->is_server)