2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #ifndef __VIRTIO_VHOST_USER_H__
16 #define __VIRTIO_VHOST_USER_H__
17 /* vhost-user data structures */
19 #define VHOST_MEMORY_MAX_NREGIONS 8
20 #define VHOST_USER_MSG_HDR_SZ 12
21 #define VHOST_VRING_MAX_SIZE 32768
22 #define VHOST_NET_VRING_IDX_RX 0
23 #define VHOST_NET_VRING_IDX_TX 1
24 #define VHOST_NET_VRING_NUM 2
26 #define VIRTQ_DESC_F_NEXT 1
27 #define VHOST_USER_REPLY_MASK (0x1 << 2)
29 #define VHOST_USER_PROTOCOL_F_MQ 0
30 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
31 #define VHOST_VRING_F_LOG 0
33 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
34 #define VHOST_USER_F_PROTOCOL_FEATURES 30
35 #define VHOST_USER_PROTOCOL_FEATURES (1ULL << VHOST_USER_PROTOCOL_F_MQ)
37 /* If multiqueue is provided by host, then we suppport it. */
38 #define VIRTIO_NET_CTRL_MQ 4
39 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0
40 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1
41 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000
44 #define foreach_virtio_net_feature \
45 _ (VIRTIO_NET_F_MRG_RXBUF, 15) \
46 _ (VIRTIO_F_ANY_LAYOUT, 27) \
47 _ (VHOST_F_LOG_ALL, 26) \
48 _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21) \
49 _ (VHOST_USER_F_PROTOCOL_FEATURES, 30)
53 #define _(f,n) FEAT_##f = (n),
54 foreach_virtio_net_feature
56 } virtio_net_feature_t;
58 int vhost_user_create_if(vnet_main_t * vnm, vlib_main_t * vm,
59 const char * sock_filename, u8 is_server,
60 u32 * sw_if_index, u64 feature_mask,
61 u8 renumber, u32 custom_dev_instance, u8 *hwaddr);
62 int vhost_user_modify_if(vnet_main_t * vnm, vlib_main_t * vm,
63 const char * sock_filename, u8 is_server,
64 u32 sw_if_index, u64 feature_mask,
65 u8 renumber, u32 custom_dev_instance);
66 int vhost_user_delete_if(vnet_main_t * vnm, vlib_main_t * vm, u32 sw_if_index);
68 typedef struct vhost_user_memory_region {
73 } vhost_user_memory_region_t;
75 typedef struct vhost_user_memory {
78 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
79 } vhost_user_memory_t;
82 unsigned int index, num;
83 } vhost_vring_state_t;
86 unsigned int index, flags;
87 u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
90 typedef struct vhost_user_log {
95 typedef enum vhost_user_req {
97 VHOST_USER_GET_FEATURES = 1,
98 VHOST_USER_SET_FEATURES = 2,
99 VHOST_USER_SET_OWNER = 3,
100 VHOST_USER_RESET_OWNER = 4,
101 VHOST_USER_SET_MEM_TABLE = 5,
102 VHOST_USER_SET_LOG_BASE = 6,
103 VHOST_USER_SET_LOG_FD = 7,
104 VHOST_USER_SET_VRING_NUM = 8,
105 VHOST_USER_SET_VRING_ADDR = 9,
106 VHOST_USER_SET_VRING_BASE = 10,
107 VHOST_USER_GET_VRING_BASE = 11,
108 VHOST_USER_SET_VRING_KICK = 12,
109 VHOST_USER_SET_VRING_CALL = 13,
110 VHOST_USER_SET_VRING_ERR = 14,
111 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
112 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
113 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
114 VHOST_USER_GET_QUEUE_NUM = 17,
116 VHOST_USER_SET_VRING_ENABLE = 18,
120 // vring_desc I/O buffer descriptor
122 uint64_t addr; // packet data buffer address
123 uint32_t len; // packet data buffer size
124 uint16_t flags; // (see below)
125 uint16_t next; // optional index next descriptor in chain
126 } __attribute ((packed)) vring_desc_t;
131 uint16_t ring[VHOST_VRING_MAX_SIZE];
132 } __attribute ((packed)) vring_avail_t;
137 struct /* vring_used_elem */ {
140 } ring[VHOST_VRING_MAX_SIZE];
141 } __attribute ((packed)) vring_used_t;
150 } __attribute ((packed)) virtio_net_hdr_t;
153 virtio_net_hdr_t hdr;
155 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
157 typedef struct vhost_user_msg {
158 vhost_user_req_t request;
163 vhost_vring_state_t state;
164 vhost_vring_addr_t addr;
165 vhost_user_memory_t memory;
166 vhost_user_log_t log;
168 } __attribute ((packed)) vhost_user_msg_t;
175 vring_avail_t *avail;
184 u32 n_since_last_int;
186 } vhost_user_vring_t;
189 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
190 volatile u32 * lockp;
196 char sock_filename[256];
199 u32 hw_if_index, sw_if_index;
205 u64 protocol_features;
207 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
208 void * region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
209 u32 region_mmap_fd[VHOST_MEMORY_MAX_NREGIONS];
210 vhost_user_vring_t vrings[2];
211 int virtio_net_hdr_sz;
213 u32 * d_trace_buffers;
215 void * log_base_addr;
222 vhost_user_intf_t * vhost_user_interfaces;
223 u32 * vhost_user_inactive_interfaces_index;
224 uword * vhost_user_interface_index_by_listener_fd;
225 uword * vhost_user_interface_index_by_sock_fd;
226 uword * vhost_user_interface_index_by_sw_if_index;
227 u32 * show_dev_instance_by_real_dev_instance;
230 int dont_dump_vhost_user_memory;
236 u32 virtio_net_hdr_sz;
239 u8 sock_filename[256];
242 } vhost_user_intf_details_t;
244 int vhost_user_dump_ifs(vnet_main_t * vnm, vlib_main_t * vm,
245 vhost_user_intf_details_t **out_vuids);
247 // CLI commands to be used from dpdk
249 vhost_user_connect_command_fn (vlib_main_t * vm,
250 unformat_input_t * input,
251 vlib_cli_command_t * cmd);
253 vhost_user_delete_command_fn (vlib_main_t * vm,
254 unformat_input_t * input,
255 vlib_cli_command_t * cmd);
257 show_vhost_user_command_fn (vlib_main_t * vm,
258 unformat_input_t * input,
259 vlib_cli_command_t * cmd);