]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
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 | ||
11fdf7f2 | 40 | #include "rte_vhost.h" |
7c673cae FG |
41 | |
42 | /* refer to hw/virtio/vhost-user.c */ | |
43 | ||
44 | #define VHOST_MEMORY_MAX_NREGIONS 8 | |
45 | ||
11fdf7f2 TL |
46 | /* |
47 | * Maximum size of virtio device config space | |
48 | */ | |
49 | #define VHOST_USER_MAX_CONFIG_SIZE 256 | |
50 | ||
7c673cae FG |
51 | #define VHOST_USER_PROTOCOL_F_MQ 0 |
52 | #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1 | |
53 | #define VHOST_USER_PROTOCOL_F_RARP 2 | |
11fdf7f2 TL |
54 | #define VHOST_USER_PROTOCOL_F_REPLY_ACK 3 |
55 | #define VHOST_USER_PROTOCOL_F_NET_MTU 4 | |
56 | #define VHOST_USER_PROTOCOL_F_CONFIG 9 | |
7c673cae FG |
57 | |
58 | #define VHOST_USER_PROTOCOL_FEATURES ((1ULL << VHOST_USER_PROTOCOL_F_MQ) | \ | |
59 | (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |\ | |
11fdf7f2 TL |
60 | (1ULL << VHOST_USER_PROTOCOL_F_RARP) | \ |
61 | (1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK) | \ | |
62 | (1ULL << VHOST_USER_PROTOCOL_F_NET_MTU) | \ | |
63 | (1ULL << VHOST_USER_PROTOCOL_F_CONFIG)) | |
7c673cae FG |
64 | |
65 | typedef enum VhostUserRequest { | |
66 | VHOST_USER_NONE = 0, | |
67 | VHOST_USER_GET_FEATURES = 1, | |
68 | VHOST_USER_SET_FEATURES = 2, | |
69 | VHOST_USER_SET_OWNER = 3, | |
70 | VHOST_USER_RESET_OWNER = 4, | |
71 | VHOST_USER_SET_MEM_TABLE = 5, | |
72 | VHOST_USER_SET_LOG_BASE = 6, | |
73 | VHOST_USER_SET_LOG_FD = 7, | |
74 | VHOST_USER_SET_VRING_NUM = 8, | |
75 | VHOST_USER_SET_VRING_ADDR = 9, | |
76 | VHOST_USER_SET_VRING_BASE = 10, | |
77 | VHOST_USER_GET_VRING_BASE = 11, | |
78 | VHOST_USER_SET_VRING_KICK = 12, | |
79 | VHOST_USER_SET_VRING_CALL = 13, | |
80 | VHOST_USER_SET_VRING_ERR = 14, | |
81 | VHOST_USER_GET_PROTOCOL_FEATURES = 15, | |
82 | VHOST_USER_SET_PROTOCOL_FEATURES = 16, | |
83 | VHOST_USER_GET_QUEUE_NUM = 17, | |
84 | VHOST_USER_SET_VRING_ENABLE = 18, | |
85 | VHOST_USER_SEND_RARP = 19, | |
11fdf7f2 TL |
86 | VHOST_USER_NET_SET_MTU = 20, |
87 | VHOST_USER_GET_CONFIG = 24, | |
88 | VHOST_USER_SET_CONFIG = 25, | |
89 | VHOST_USER_NVME_ADMIN = 80, | |
90 | VHOST_USER_NVME_SET_CQ_CALL = 81, | |
91 | VHOST_USER_NVME_GET_CAP = 82, | |
92 | VHOST_USER_NVME_START_STOP = 83, | |
93 | VHOST_USER_NVME_IO_CMD = 84, | |
7c673cae FG |
94 | VHOST_USER_MAX |
95 | } VhostUserRequest; | |
96 | ||
11fdf7f2 TL |
97 | typedef enum VhostUserSlaveRequest { |
98 | VHOST_USER_SLAVE_NONE = 0, | |
99 | VHOST_USER_SLAVE_IOTLB_MSG = 1, | |
100 | VHOST_USER_SLAVE_CONFIG_CHANGE_MSG = 2, | |
101 | VHOST_USER_SLAVE_MAX | |
102 | } VhostUserSlaveRequest; | |
103 | ||
7c673cae FG |
104 | typedef struct VhostUserMemoryRegion { |
105 | uint64_t guest_phys_addr; | |
106 | uint64_t memory_size; | |
107 | uint64_t userspace_addr; | |
108 | uint64_t mmap_offset; | |
109 | } VhostUserMemoryRegion; | |
110 | ||
111 | typedef struct VhostUserMemory { | |
112 | uint32_t nregions; | |
113 | uint32_t padding; | |
114 | VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS]; | |
115 | } VhostUserMemory; | |
116 | ||
117 | typedef struct VhostUserLog { | |
118 | uint64_t mmap_size; | |
119 | uint64_t mmap_offset; | |
120 | } VhostUserLog; | |
121 | ||
11fdf7f2 TL |
122 | typedef struct VhostUserConfig { |
123 | uint32_t offset; | |
124 | uint32_t size; | |
125 | uint32_t flags; | |
126 | uint8_t region[VHOST_USER_MAX_CONFIG_SIZE]; | |
127 | } VhostUserConfig; | |
128 | ||
129 | enum VhostUserNvmeQueueTypes { | |
130 | VHOST_USER_NVME_SUBMISSION_QUEUE = 1, | |
131 | VHOST_USER_NVME_COMPLETION_QUEUE = 2, | |
132 | }; | |
133 | ||
134 | typedef struct VhostUserNvmeIO { | |
135 | enum VhostUserNvmeQueueTypes queue_type; | |
136 | uint32_t qid; | |
137 | uint32_t tail_head; | |
138 | } VhostUserNvmeIO; | |
139 | ||
7c673cae FG |
140 | typedef struct VhostUserMsg { |
141 | VhostUserRequest request; | |
142 | ||
143 | #define VHOST_USER_VERSION_MASK 0x3 | |
144 | #define VHOST_USER_REPLY_MASK (0x1 << 2) | |
11fdf7f2 | 145 | #define VHOST_USER_NEED_REPLY (0x1 << 3) |
7c673cae FG |
146 | uint32_t flags; |
147 | uint32_t size; /* the following payload size */ | |
148 | union { | |
149 | #define VHOST_USER_VRING_IDX_MASK 0xff | |
150 | #define VHOST_USER_VRING_NOFD_MASK (0x1<<8) | |
151 | uint64_t u64; | |
152 | struct vhost_vring_state state; | |
153 | struct vhost_vring_addr addr; | |
154 | VhostUserMemory memory; | |
155 | VhostUserLog log; | |
11fdf7f2 TL |
156 | VhostUserConfig config; |
157 | struct nvme { | |
158 | union { | |
159 | uint8_t req[64]; | |
160 | uint8_t cqe[16]; | |
161 | } cmd; | |
162 | uint8_t buf[4096]; | |
163 | } nvme; | |
164 | struct VhostUserNvmeIO nvme_io; | |
7c673cae FG |
165 | } payload; |
166 | int fds[VHOST_MEMORY_MAX_NREGIONS]; | |
167 | } __attribute((packed)) VhostUserMsg; | |
168 | ||
169 | #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64) | |
170 | ||
171 | /* The version of the protocol we support */ | |
172 | #define VHOST_USER_VERSION 0x1 | |
173 | ||
174 | ||
175 | /* vhost_user.c */ | |
176 | int vhost_user_msg_handler(int vid, int fd); | |
177 | ||
178 | /* socket.c */ | |
179 | int read_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num); | |
180 | int send_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num); | |
181 | ||
182 | #endif |