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.
34 #ifndef _VHOST_NET_USER_H
35 #define _VHOST_NET_USER_H
38 #include <linux/vhost.h>
40 #include "rte_vhost.h"
42 /* refer to hw/virtio/vhost-user.c */
44 #define VHOST_MEMORY_MAX_NREGIONS 8
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 #define VHOST_USER_PROTOCOL_F_NET_MTU 4
51 #define VHOST_USER_PROTOCOL_F_SLAVE_REQ 5
53 #define VHOST_USER_PROTOCOL_FEATURES ((1ULL << VHOST_USER_PROTOCOL_F_MQ) | \
54 (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |\
55 (1ULL << VHOST_USER_PROTOCOL_F_RARP) | \
56 (1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK) | \
57 (1ULL << VHOST_USER_PROTOCOL_F_NET_MTU) | \
58 (1ULL << VHOST_USER_PROTOCOL_F_SLAVE_REQ))
60 typedef enum VhostUserRequest {
62 VHOST_USER_GET_FEATURES = 1,
63 VHOST_USER_SET_FEATURES = 2,
64 VHOST_USER_SET_OWNER = 3,
65 VHOST_USER_RESET_OWNER = 4,
66 VHOST_USER_SET_MEM_TABLE = 5,
67 VHOST_USER_SET_LOG_BASE = 6,
68 VHOST_USER_SET_LOG_FD = 7,
69 VHOST_USER_SET_VRING_NUM = 8,
70 VHOST_USER_SET_VRING_ADDR = 9,
71 VHOST_USER_SET_VRING_BASE = 10,
72 VHOST_USER_GET_VRING_BASE = 11,
73 VHOST_USER_SET_VRING_KICK = 12,
74 VHOST_USER_SET_VRING_CALL = 13,
75 VHOST_USER_SET_VRING_ERR = 14,
76 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
77 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
78 VHOST_USER_GET_QUEUE_NUM = 17,
79 VHOST_USER_SET_VRING_ENABLE = 18,
80 VHOST_USER_SEND_RARP = 19,
81 VHOST_USER_NET_SET_MTU = 20,
82 VHOST_USER_SET_SLAVE_REQ_FD = 21,
83 VHOST_USER_IOTLB_MSG = 22,
87 typedef enum VhostUserSlaveRequest {
88 VHOST_USER_SLAVE_NONE = 0,
89 VHOST_USER_SLAVE_IOTLB_MSG = 1,
91 } VhostUserSlaveRequest;
93 typedef struct VhostUserMemoryRegion {
94 uint64_t guest_phys_addr;
96 uint64_t userspace_addr;
98 } VhostUserMemoryRegion;
100 typedef struct VhostUserMemory {
103 VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS];
106 typedef struct VhostUserLog {
108 uint64_t mmap_offset;
111 typedef struct VhostUserMsg {
112 VhostUserRequest request;
114 #define VHOST_USER_VERSION_MASK 0x3
115 #define VHOST_USER_REPLY_MASK (0x1 << 2)
116 #define VHOST_USER_NEED_REPLY (0x1 << 3)
118 uint32_t size; /* the following payload size */
120 #define VHOST_USER_VRING_IDX_MASK 0xff
121 #define VHOST_USER_VRING_NOFD_MASK (0x1<<8)
123 struct vhost_vring_state state;
124 struct vhost_vring_addr addr;
125 VhostUserMemory memory;
127 struct vhost_iotlb_msg iotlb;
129 int fds[VHOST_MEMORY_MAX_NREGIONS];
130 } __attribute((packed)) VhostUserMsg;
132 #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
134 /* The version of the protocol we support */
135 #define VHOST_USER_VERSION 0x1
139 int vhost_user_msg_handler(int vid, int fd);
140 int vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm);
143 int read_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num);
144 int send_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num);