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
32 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
33 #define VHOST_USER_F_PROTOCOL_FEATURES 30
34 #define VHOST_USER_PROTOCOL_FEATURES (1ULL << VHOST_USER_PROTOCOL_F_MQ)
36 /* If multiqueue is provided by host, then we suppport it. */
37 #define VIRTIO_NET_CTRL_MQ 4
38 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0
39 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1
40 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000
43 #define foreach_virtio_net_feature \
44 _ (VIRTIO_NET_F_MRG_RXBUF, 15) \
45 _ (VIRTIO_F_ANY_LAYOUT, 27) \
46 _ (VHOST_F_LOG_ALL, 26) \
47 _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21) \
48 _ (VHOST_USER_F_PROTOCOL_FEATURES, 30)
52 #define _(f,n) FEAT_##f = (n),
53 foreach_virtio_net_feature
55 } virtio_net_feature_t;
57 int vhost_user_create_if(vnet_main_t * vnm, vlib_main_t * vm,
58 const char * sock_filename, u8 is_server,
59 u32 * sw_if_index, u64 feature_mask,
60 u8 renumber, u32 custom_dev_instance, u8 *hwaddr);
61 int vhost_user_modify_if(vnet_main_t * vnm, vlib_main_t * vm,
62 const char * sock_filename, u8 is_server,
63 u32 sw_if_index, u64 feature_mask,
64 u8 renumber, u32 custom_dev_instance);
65 int vhost_user_delete_if(vnet_main_t * vnm, vlib_main_t * vm, u32 sw_if_index);
67 typedef struct vhost_user_memory_region {
72 } vhost_user_memory_region_t;
74 typedef struct vhost_user_memory {
77 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
78 } vhost_user_memory_t;
80 typedef struct vhost_vring_state {
81 unsigned int index, num;
82 } vhost_vring_state_t;
84 typedef struct vhost_vring_addr {
85 unsigned int index, flags;
86 u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
89 typedef struct vhost_user_log {
94 typedef enum vhost_user_req {
96 VHOST_USER_GET_FEATURES = 1,
97 VHOST_USER_SET_FEATURES = 2,
98 VHOST_USER_SET_OWNER = 3,
99 VHOST_USER_RESET_OWNER = 4,
100 VHOST_USER_SET_MEM_TABLE = 5,
101 VHOST_USER_SET_LOG_BASE = 6,
102 VHOST_USER_SET_LOG_FD = 7,
103 VHOST_USER_SET_VRING_NUM = 8,
104 VHOST_USER_SET_VRING_ADDR = 9,
105 VHOST_USER_SET_VRING_BASE = 10,
106 VHOST_USER_GET_VRING_BASE = 11,
107 VHOST_USER_SET_VRING_KICK = 12,
108 VHOST_USER_SET_VRING_CALL = 13,
109 VHOST_USER_SET_VRING_ERR = 14,
110 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
111 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
112 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
113 VHOST_USER_GET_QUEUE_NUM = 17,
115 VHOST_USER_SET_VRING_ENABLE = 18,
119 // vring_desc I/O buffer descriptor
121 uint64_t addr; // packet data buffer address
122 uint32_t len; // packet data buffer size
123 uint16_t flags; // (see below)
124 uint16_t next; // optional index next descriptor in chain
125 } __attribute ((packed)) vring_desc_t;
130 uint16_t ring[VHOST_VRING_MAX_SIZE];
131 } __attribute ((packed)) vring_avail_t;
136 struct /* vring_used_elem */ {
139 } ring[VHOST_VRING_MAX_SIZE];
140 } __attribute ((packed)) vring_used_t;
149 } __attribute ((packed)) virtio_net_hdr_t;
152 virtio_net_hdr_t hdr;
154 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
156 typedef struct vhost_user_msg {
157 vhost_user_req_t request;
162 vhost_vring_state_t state;
163 vhost_vring_addr_t addr;
164 vhost_user_memory_t memory;
165 vhost_user_log_t log;
167 } __attribute ((packed)) vhost_user_msg_t;
174 vring_avail_t *avail;
182 u32 n_since_last_int;
184 } vhost_user_vring_t;
187 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
188 volatile u32 * lockp;
194 char sock_filename[256];
197 u32 hw_if_index, sw_if_index;
203 u64 protocol_features;
205 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
206 void * region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
207 u32 region_mmap_fd[VHOST_MEMORY_MAX_NREGIONS];
208 vhost_user_vring_t vrings[2];
209 int virtio_net_hdr_sz;
211 u32 * d_trace_buffers;
213 void * log_base_addr;
220 vhost_user_intf_t * vhost_user_interfaces;
221 u32 * vhost_user_inactive_interfaces_index;
222 uword * vhost_user_interface_index_by_listener_fd;
223 uword * vhost_user_interface_index_by_sock_fd;
224 uword * vhost_user_interface_index_by_sw_if_index;
225 u32 * show_dev_instance_by_real_dev_instance;
228 int dont_dump_vhost_user_memory;
234 u32 virtio_net_hdr_sz;
237 u8 sock_filename[256];
240 } vhost_user_intf_details_t;
242 int vhost_user_dump_ifs(vnet_main_t * vnm, vlib_main_t * vm,
243 vhost_user_intf_details_t **out_vuids);
245 // CLI commands to be used from dpdk
247 vhost_user_connect_command_fn (vlib_main_t * vm,
248 unformat_input_t * input,
249 vlib_cli_command_t * cmd);
251 vhost_user_delete_command_fn (vlib_main_t * vm,
252 unformat_input_t * input,
253 vlib_cli_command_t * cmd);
255 show_vhost_user_command_fn (vlib_main_t * vm,
256 unformat_input_t * input,
257 vlib_cli_command_t * cmd);