ceph/src/spdk/lib/virtio/virtio_user/vhost.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2016 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 #ifndef _VHOST_NET_USER_H
  35 #define _VHOST_NET_USER_H
  36
  37 #include "spdk/stdinc.h"
  38
  39 #include <linux/vhost.h>
  40
  41 #include "spdk_internal/log.h"
  42 #include "spdk_internal/virtio.h"
  43
  44 #define VHOST_USER_MAX_CONFIG_SIZE 256
  45
  46 #ifndef VHOST_USER_PROTOCOL_F_MQ
  47 #define VHOST_USER_PROTOCOL_F_MQ        0
  48 #endif
  49
  50 #ifndef VHOST_USER_PROTOCOL_F_CONFIG
  51 #define VHOST_USER_PROTOCOL_F_CONFIG    9
  52 #endif
  53
  54 enum vhost_user_request {
  55         VHOST_USER_NONE = 0,
  56         VHOST_USER_GET_FEATURES = 1,
  57         VHOST_USER_SET_FEATURES = 2,
  58         VHOST_USER_SET_OWNER = 3,
  59         VHOST_USER_RESET_OWNER = 4,
  60         VHOST_USER_SET_MEM_TABLE = 5,
  61         VHOST_USER_SET_LOG_BASE = 6,
  62         VHOST_USER_SET_LOG_FD = 7,
  63         VHOST_USER_SET_VRING_NUM = 8,
  64         VHOST_USER_SET_VRING_ADDR = 9,
  65         VHOST_USER_SET_VRING_BASE = 10,
  66         VHOST_USER_GET_VRING_BASE = 11,
  67         VHOST_USER_SET_VRING_KICK = 12,
  68         VHOST_USER_SET_VRING_CALL = 13,
  69         VHOST_USER_SET_VRING_ERR = 14,
  70         VHOST_USER_GET_PROTOCOL_FEATURES = 15,
  71         VHOST_USER_SET_PROTOCOL_FEATURES = 16,
  72         VHOST_USER_GET_QUEUE_NUM = 17,
  73         VHOST_USER_SET_VRING_ENABLE = 18,
  74         VHOST_USER_GET_CONFIG = 24,
  75         VHOST_USER_SET_CONFIG = 25,
  76         VHOST_USER_MAX
  77 };
  78
  79 struct virtio_user_backend_ops;
  80
  81 struct virtio_user_dev {
  82         int             vhostfd;
  83
  84         int             callfds[SPDK_VIRTIO_MAX_VIRTQUEUES];
  85         int             kickfds[SPDK_VIRTIO_MAX_VIRTQUEUES];
  86         uint32_t        queue_size;
  87
  88         uint8_t         status;
  89         char            path[PATH_MAX];
  90         uint64_t        protocol_features;
  91         struct vring    vrings[SPDK_VIRTIO_MAX_VIRTQUEUES];
  92         struct virtio_user_backend_ops *ops;
  93         struct spdk_mem_map *mem_map;
  94 };
  95
  96 struct virtio_user_backend_ops {
  97         int (*setup)(struct virtio_user_dev *dev);
  98         int (*send_request)(struct virtio_user_dev *dev,
  99                             enum vhost_user_request req,
 100                             void *arg);
 101 };
 102
 103 /* get/set config msg */
 104 struct vhost_user_config {
 105         uint32_t offset;
 106         uint32_t size;
 107         uint32_t flags;
 108         uint8_t region[VHOST_USER_MAX_CONFIG_SIZE];
 109 };
 110
 111 extern struct virtio_user_backend_ops ops_user;
 112
 113 #endif