lib/librte_vhost/vhost_user.h

   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 #ifndef _VHOST_NET_USER_H
  35 #define _VHOST_NET_USER_H
  36
  37 #include <stdint.h>
  38 #include <linux/vhost.h>
  39
  40 #include "rte_virtio_net.h"
  41
  42 /* refer to hw/virtio/vhost-user.c */
  43
  44 #define VHOST_MEMORY_MAX_NREGIONS 8
  45
  46 #define VHOST_USER_PROTOCOL_F_MQ        0
  47 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
  48 #define VHOST_USER_PROTOCOL_F_RARP      2
  49 #define VHOST_USER_PROTOCOL_F_REPLY_ACK 3
  50
  51 #define VHOST_USER_PROTOCOL_FEATURES    ((1ULL << VHOST_USER_PROTOCOL_F_MQ) | \
  52                                          (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |\
  53                                          (1ULL << VHOST_USER_PROTOCOL_F_RARP) | \
  54                                          (1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK))
  55
  56 typedef enum VhostUserRequest {
  57         VHOST_USER_NONE = 0,
  58         VHOST_USER_GET_FEATURES = 1,
  59         VHOST_USER_SET_FEATURES = 2,
  60         VHOST_USER_SET_OWNER = 3,
  61         VHOST_USER_RESET_OWNER = 4,
  62         VHOST_USER_SET_MEM_TABLE = 5,
  63         VHOST_USER_SET_LOG_BASE = 6,
  64         VHOST_USER_SET_LOG_FD = 7,
  65         VHOST_USER_SET_VRING_NUM = 8,
  66         VHOST_USER_SET_VRING_ADDR = 9,
  67         VHOST_USER_SET_VRING_BASE = 10,
  68         VHOST_USER_GET_VRING_BASE = 11,
  69         VHOST_USER_SET_VRING_KICK = 12,
  70         VHOST_USER_SET_VRING_CALL = 13,
  71         VHOST_USER_SET_VRING_ERR = 14,
  72         VHOST_USER_GET_PROTOCOL_FEATURES = 15,
  73         VHOST_USER_SET_PROTOCOL_FEATURES = 16,
  74         VHOST_USER_GET_QUEUE_NUM = 17,
  75         VHOST_USER_SET_VRING_ENABLE = 18,
  76         VHOST_USER_SEND_RARP = 19,
  77         VHOST_USER_MAX
  78 } VhostUserRequest;
  79
  80 typedef struct VhostUserMemoryRegion {
  81         uint64_t guest_phys_addr;
  82         uint64_t memory_size;
  83         uint64_t userspace_addr;
  84         uint64_t mmap_offset;
  85 } VhostUserMemoryRegion;
  86
  87 typedef struct VhostUserMemory {
  88         uint32_t nregions;
  89         uint32_t padding;
  90         VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS];
  91 } VhostUserMemory;
  92
  93 typedef struct VhostUserLog {
  94         uint64_t mmap_size;
  95         uint64_t mmap_offset;
  96 } VhostUserLog;
  97
  98 typedef struct VhostUserMsg {
  99         VhostUserRequest request;
 100
 101 #define VHOST_USER_VERSION_MASK     0x3
 102 #define VHOST_USER_REPLY_MASK       (0x1 << 2)
 103 #define VHOST_USER_NEED_REPLY           (0x1 << 3)
 104         uint32_t flags;
 105         uint32_t size; /* the following payload size */
 106         union {
 107 #define VHOST_USER_VRING_IDX_MASK   0xff
 108 #define VHOST_USER_VRING_NOFD_MASK  (0x1<<8)
 109                 uint64_t u64;
 110                 struct vhost_vring_state state;
 111                 struct vhost_vring_addr addr;
 112                 VhostUserMemory memory;
 113                 VhostUserLog    log;
 114         } payload;
 115         int fds[VHOST_MEMORY_MAX_NREGIONS];
 116 } __attribute((packed)) VhostUserMsg;
 117
 118 #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
 119
 120 /* The version of the protocol we support */
 121 #define VHOST_USER_VERSION    0x1
 122
 123
 124 /* vhost_user.c */
 125 int vhost_user_msg_handler(int vid, int fd);
 126
 127 /* socket.c */
 128 int read_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num);
 129 int send_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num);
 130
 131 #endif