lib/librte_vhost/vhost_cuse/vhost-net-cdev.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  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
  16  *       distribution.
  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.
  20  *
  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.
  32  */
  33
  34 #include <errno.h>
  35 #include <fuse/cuse_lowlevel.h>
  36 #include <linux/limits.h>
  37 #include <linux/vhost.h>
  38 #include <stdint.h>
  39 #include <string.h>
  40 #include <unistd.h>
  41
  42 #include <rte_ethdev.h>
  43 #include <rte_log.h>
  44 #include <rte_string_fns.h>
  45 #include <rte_virtio_net.h>
  46
  47 #include "vhost-net.h"
  48 #include "eventfd_copy.h"
  49
  50 #define FUSE_OPT_DUMMY "\0\0"
  51 #define FUSE_OPT_FORE  "-f\0\0"
  52 #define FUSE_OPT_NOMULTI "-s\0\0"
  53
  54 static const uint32_t default_major = 231;
  55 static const uint32_t default_minor = 1;
  56 static const char cuse_device_name[] = "/dev/cuse";
  57 static const char default_cdev[] = "vhost-net";
  58
  59 static struct fuse_session *session;
  60 static struct vhost_net_device_ops const *ops;
  61
  62 /*
  63  * Returns vhost_device_ctx from given fuse_req_t. The index is populated later
  64  * when the device is added to the device linked list.
  65  */
  66 static struct vhost_device_ctx
  67 fuse_req_to_vhost_ctx(fuse_req_t req, struct fuse_file_info *fi)
  68 {
  69         struct vhost_device_ctx ctx;
  70         struct fuse_ctx const *const req_ctx = fuse_req_ctx(req);
  71
  72         ctx.pid = req_ctx->pid;
  73         ctx.fh = fi->fh;
  74
  75         return ctx;
  76 }
  77
  78 /*
  79  * When the device is created in QEMU it gets initialised here and
  80  * added to the device linked list.
  81  */
  82 static void
  83 vhost_net_open(fuse_req_t req, struct fuse_file_info *fi)
  84 {
  85         struct vhost_device_ctx ctx = fuse_req_to_vhost_ctx(req, fi);
  86         int err = 0;
  87
  88         err = ops->new_device(ctx);
  89         if (err == -1) {
  90                 fuse_reply_err(req, EPERM);
  91                 return;
  92         }
  93
  94         fi->fh = err;
  95
  96         RTE_LOG(INFO, VHOST_CONFIG,
  97                 "(%"PRIu64") Device configuration started\n", fi->fh);
  98         fuse_reply_open(req, fi);
  99 }
 100
 101 /*
 102  * When QEMU is shutdown or killed the device gets released.
 103  */
 104 static void
 105 vhost_net_release(fuse_req_t req, struct fuse_file_info *fi)
 106 {
 107         int err = 0;
 108         struct vhost_device_ctx ctx = fuse_req_to_vhost_ctx(req, fi);
 109
 110         ops->destroy_device(ctx);
 111         RTE_LOG(INFO, VHOST_CONFIG, "(%"PRIu64") Device released\n", ctx.fh);
 112         fuse_reply_err(req, err);
 113 }
 114
 115 /*
 116  * Boilerplate code for CUSE IOCTL
 117  * Implicit arguments: ctx, req, result.
 118  */
 119 #define VHOST_IOCTL(func) do {  \
 120         result = (func)(ctx);   \
 121         fuse_reply_ioctl(req, result, NULL, 0); \
 122 } while (0)
 123
 124 /*
 125  * Boilerplate IOCTL RETRY
 126  * Implicit arguments: req.
 127  */
 128 #define VHOST_IOCTL_RETRY(size_r, size_w) do {  \
 129         struct iovec iov_r = { arg, (size_r) }; \
 130         struct iovec iov_w = { arg, (size_w) }; \
 131         fuse_reply_ioctl_retry(req, &iov_r,     \
 132                 (size_r) ? 1 : 0, &iov_w, (size_w) ? 1 : 0);\
 133 } while (0)
 134
 135 /*
 136  * Boilerplate code for CUSE Read IOCTL
 137  * Implicit arguments: ctx, req, result, in_bufsz, in_buf.
 138  */
 139 #define VHOST_IOCTL_R(type, var, func) do {     \
 140         if (!in_bufsz) {        \
 141                 VHOST_IOCTL_RETRY(sizeof(type), 0);\
 142         } else {        \
 143                 (var) = *(const type*)in_buf;   \
 144                 result = func(ctx, &(var));     \
 145                 fuse_reply_ioctl(req, result, NULL, 0);\
 146         }       \
 147 } while (0)
 148
 149 /*
 150  * Boilerplate code for CUSE Write IOCTL
 151  * Implicit arguments: ctx, req, result, out_bufsz.
 152  */
 153 #define VHOST_IOCTL_W(type, var, func) do {     \
 154         if (!out_bufsz) {       \
 155                 VHOST_IOCTL_RETRY(0, sizeof(type));\
 156         } else {        \
 157                 result = (func)(ctx, &(var));\
 158                 fuse_reply_ioctl(req, result, &(var), sizeof(type));\
 159         } \
 160 } while (0)
 161
 162 /*
 163  * Boilerplate code for CUSE Read/Write IOCTL
 164  * Implicit arguments: ctx, req, result, in_bufsz, in_buf.
 165  */
 166 #define VHOST_IOCTL_RW(type1, var1, type2, var2, func) do {     \
 167         if (!in_bufsz) {        \
 168                 VHOST_IOCTL_RETRY(sizeof(type1), sizeof(type2));\
 169         } else {        \
 170                 (var1) = *(const type1*) (in_buf);      \
 171                 result = (func)(ctx, (var1), &(var2));  \
 172                 fuse_reply_ioctl(req, result, &(var2), sizeof(type2));\
 173         }       \
 174 } while (0)
 175
 176 /*
 177  * The IOCTLs are handled using CUSE/FUSE in userspace. Depending on the type
 178  * of IOCTL a buffer is requested to read or to write. This request is handled
 179  * by FUSE and the buffer is then given to CUSE.
 180  */
 181 static void
 182 vhost_net_ioctl(fuse_req_t req, int cmd, void *arg,
 183                 struct fuse_file_info *fi, __rte_unused unsigned flags,
 184                 const void *in_buf, size_t in_bufsz, size_t out_bufsz)
 185 {
 186         struct vhost_device_ctx ctx = fuse_req_to_vhost_ctx(req, fi);
 187         struct vhost_vring_file file;
 188         struct vhost_vring_state state;
 189         struct vhost_vring_addr addr;
 190         uint64_t features;
 191         uint32_t index;
 192         int result = 0;
 193
 194         switch (cmd) {
 195         case VHOST_NET_SET_BACKEND:
 196                 LOG_DEBUG(VHOST_CONFIG,
 197                         "(%"PRIu64") IOCTL: VHOST_NET_SET_BACKEND\n", ctx.fh);
 198                 VHOST_IOCTL_R(struct vhost_vring_file, file, ops->set_backend);
 199                 break;
 200
 201         case VHOST_GET_FEATURES:
 202                 LOG_DEBUG(VHOST_CONFIG,
 203                         "(%"PRIu64") IOCTL: VHOST_GET_FEATURES\n", ctx.fh);
 204                 VHOST_IOCTL_W(uint64_t, features, ops->get_features);
 205                 break;
 206
 207         case VHOST_SET_FEATURES:
 208                 LOG_DEBUG(VHOST_CONFIG,
 209                         "(%"PRIu64") IOCTL: VHOST_SET_FEATURES\n", ctx.fh);
 210                 VHOST_IOCTL_R(uint64_t, features, ops->set_features);
 211                 break;
 212
 213         case VHOST_RESET_OWNER:
 214                 LOG_DEBUG(VHOST_CONFIG,
 215                         "(%"PRIu64") IOCTL: VHOST_RESET_OWNER\n", ctx.fh);
 216                 VHOST_IOCTL(ops->reset_owner);
 217                 break;
 218
 219         case VHOST_SET_OWNER:
 220                 LOG_DEBUG(VHOST_CONFIG,
 221                         "(%"PRIu64") IOCTL: VHOST_SET_OWNER\n", ctx.fh);
 222                 VHOST_IOCTL(ops->set_owner);
 223                 break;
 224
 225         case VHOST_SET_MEM_TABLE:
 226                 /*TODO fix race condition.*/
 227                 LOG_DEBUG(VHOST_CONFIG,
 228                         "(%"PRIu64") IOCTL: VHOST_SET_MEM_TABLE\n", ctx.fh);
 229                 static struct vhost_memory mem_temp;
 230
 231                 switch (in_bufsz) {
 232                 case 0:
 233                         VHOST_IOCTL_RETRY(sizeof(struct vhost_memory), 0);
 234                         break;
 235
 236                 case sizeof(struct vhost_memory):
 237                         mem_temp = *(const struct vhost_memory *) in_buf;
 238
 239                         if (mem_temp.nregions > 0) {
 240                                 VHOST_IOCTL_RETRY(sizeof(struct vhost_memory) +
 241                                         (sizeof(struct vhost_memory_region) *
 242                                                 mem_temp.nregions), 0);
 243                         } else {
 244                                 result = -1;
 245                                 fuse_reply_ioctl(req, result, NULL, 0);
 246                         }
 247                         break;
 248
 249                 default:
 250                         result = ops->set_mem_table(ctx,
 251                                         in_buf, mem_temp.nregions);
 252                         if (result)
 253                                 fuse_reply_err(req, EINVAL);
 254                         else
 255                                 fuse_reply_ioctl(req, result, NULL, 0);
 256                 }
 257                 break;
 258
 259         case VHOST_SET_VRING_NUM:
 260                 LOG_DEBUG(VHOST_CONFIG,
 261                         "(%"PRIu64") IOCTL: VHOST_SET_VRING_NUM\n", ctx.fh);
 262                 VHOST_IOCTL_R(struct vhost_vring_state, state,
 263                         ops->set_vring_num);
 264                 break;
 265
 266         case VHOST_SET_VRING_BASE:
 267                 LOG_DEBUG(VHOST_CONFIG,
 268                         "(%"PRIu64") IOCTL: VHOST_SET_VRING_BASE\n", ctx.fh);
 269                 VHOST_IOCTL_R(struct vhost_vring_state, state,
 270                         ops->set_vring_base);
 271                 break;
 272
 273         case VHOST_GET_VRING_BASE:
 274                 LOG_DEBUG(VHOST_CONFIG,
 275                         "(%"PRIu64") IOCTL: VHOST_GET_VRING_BASE\n", ctx.fh);
 276                 VHOST_IOCTL_RW(uint32_t, index,
 277                         struct vhost_vring_state, state, ops->get_vring_base);
 278                 break;
 279
 280         case VHOST_SET_VRING_ADDR:
 281                 LOG_DEBUG(VHOST_CONFIG,
 282                         "(%"PRIu64") IOCTL: VHOST_SET_VRING_ADDR\n", ctx.fh);
 283                 VHOST_IOCTL_R(struct vhost_vring_addr, addr,
 284                         ops->set_vring_addr);
 285                 break;
 286
 287         case VHOST_SET_VRING_KICK:
 288         case VHOST_SET_VRING_CALL:
 289                 if (cmd == VHOST_SET_VRING_KICK)
 290                         LOG_DEBUG(VHOST_CONFIG,
 291                                 "(%"PRIu64") IOCTL: VHOST_SET_VRING_KICK\n",
 292                         ctx.fh);
 293                 else
 294                         LOG_DEBUG(VHOST_CONFIG,
 295                                 "(%"PRIu64") IOCTL: VHOST_SET_VRING_CALL\n",
 296                         ctx.fh);
 297                 if (!in_buf)
 298                         VHOST_IOCTL_RETRY(sizeof(struct vhost_vring_file), 0);
 299                 else {
 300                         int fd;
 301                         file = *(const struct vhost_vring_file *)in_buf;
 302                         LOG_DEBUG(VHOST_CONFIG,
 303                                 "idx:%d fd:%d\n", file.index, file.fd);
 304                         fd = eventfd_copy(file.fd, ctx.pid);
 305                         if (fd < 0) {
 306                                 fuse_reply_ioctl(req, -1, NULL, 0);
 307                                 result = -1;
 308                                 break;
 309                         }
 310                         file.fd = fd;
 311                         if (cmd == VHOST_SET_VRING_KICK) {
 312                                 result = ops->set_vring_kick(ctx, &file);
 313                                 fuse_reply_ioctl(req, result, NULL, 0);
 314                         } else {
 315                                 result = ops->set_vring_call(ctx, &file);
 316                                 fuse_reply_ioctl(req, result, NULL, 0);
 317                         }
 318                 }
 319                 break;
 320
 321         default:
 322                 RTE_LOG(ERR, VHOST_CONFIG,
 323                         "(%"PRIu64") IOCTL: DOESN NOT EXIST\n", ctx.fh);
 324                 result = -1;
 325                 fuse_reply_ioctl(req, result, NULL, 0);
 326         }
 327
 328         if (result < 0)
 329                 LOG_DEBUG(VHOST_CONFIG,
 330                         "(%"PRIu64") IOCTL: FAIL\n", ctx.fh);
 331         else
 332                 LOG_DEBUG(VHOST_CONFIG,
 333                         "(%"PRIu64") IOCTL: SUCCESS\n", ctx.fh);
 334 }
 335
 336 /*
 337  * Structure handling open, release and ioctl function pointers is populated.
 338  */
 339 static const struct cuse_lowlevel_ops vhost_net_ops = {
 340         .open           = vhost_net_open,
 341         .release        = vhost_net_release,
 342         .ioctl          = vhost_net_ioctl,
 343 };
 344
 345 /*
 346  * cuse_info is populated and used to register the cuse device.
 347  * vhost_net_device_ops are also passed when the device is registered in app.
 348  */
 349 int
 350 rte_vhost_driver_register(const char *dev_name)
 351 {
 352         struct cuse_info cuse_info;
 353         char device_name[PATH_MAX] = "";
 354         char char_device_name[PATH_MAX] = "";
 355         const char *device_argv[] = { device_name };
 356
 357         char fuse_opt_dummy[] = FUSE_OPT_DUMMY;
 358         char fuse_opt_fore[] = FUSE_OPT_FORE;
 359         char fuse_opt_nomulti[] = FUSE_OPT_NOMULTI;
 360         char *fuse_argv[] = {fuse_opt_dummy, fuse_opt_fore, fuse_opt_nomulti};
 361
 362         if (access(cuse_device_name, R_OK | W_OK) < 0) {
 363                 RTE_LOG(ERR, VHOST_CONFIG,
 364                         "char device %s can't be accessed, maybe not exist\n",
 365                         cuse_device_name);
 366                 return -1;
 367         }
 368
 369         /*
 370          * The device name is created. This is passed to QEMU so that it can
 371          * register the device with our application.
 372          */
 373         snprintf(device_name, PATH_MAX, "DEVNAME=%s", dev_name);
 374         snprintf(char_device_name, PATH_MAX, "/dev/%s", dev_name);
 375
 376         /* Check if device already exists. */
 377         if (access(char_device_name, F_OK) != -1) {
 378                 RTE_LOG(ERR, VHOST_CONFIG,
 379                         "char device %s already exists\n", char_device_name);
 380                 return -1;
 381         }
 382
 383         memset(&cuse_info, 0, sizeof(cuse_info));
 384         cuse_info.dev_major = default_major;
 385         cuse_info.dev_minor = default_minor;
 386         cuse_info.dev_info_argc = 1;
 387         cuse_info.dev_info_argv = device_argv;
 388         cuse_info.flags = CUSE_UNRESTRICTED_IOCTL;
 389
 390         ops = get_virtio_net_callbacks();
 391
 392         session = cuse_lowlevel_setup(3, fuse_argv,
 393                         &cuse_info, &vhost_net_ops, 0, NULL);
 394         if (session == NULL)
 395                 return -1;
 396
 397         return 0;
 398 }
 399
 400 /**
 401  * The CUSE session is launched allowing the application to receive open,
 402  * release and ioctl calls.
 403  */
 404 int
 405 rte_vhost_driver_session_start(void)
 406 {
 407         fuse_session_loop(session);
 408
 409         return 0;
 410 }