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 VIRTQ_DESC_F_INDIRECT 4
28 #define VHOST_USER_REPLY_MASK (0x1 << 2)
30 #define VHOST_USER_PROTOCOL_F_MQ 0
31 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
32 #define VHOST_VRING_F_LOG 0
34 #define VHOST_USER_F_PROTOCOL_FEATURES 30
36 #define RTE_VERSION_NUM(a,b,c,d) 1
39 #if RTE_VERSION >= RTE_VERSION_NUM(16, 4, 0, 0)
40 #define VHOST_USER_PROTOCOL_FEATURES ((1ULL << VHOST_USER_PROTOCOL_F_MQ) | \
41 (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD))
43 #define VHOST_USER_PROTOCOL_FEATURES (1ULL << VHOST_USER_PROTOCOL_F_MQ)
46 /* If multiqueue is provided by host, then we suppport it. */
47 #define VIRTIO_NET_CTRL_MQ 4
48 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0
49 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1
50 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000
52 #define foreach_virtio_net_feature \
53 _ (VIRTIO_NET_F_MRG_RXBUF, 15) \
54 _ (VIRTIO_F_ANY_LAYOUT, 27) \
55 _ (VIRTIO_F_INDIRECT_DESC, 28) \
56 _ (VHOST_F_LOG_ALL, 26) \
57 _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21) \
58 _ (VHOST_USER_F_PROTOCOL_FEATURES, 30)
63 #define _(f,n) FEAT_##f = (n),
64 foreach_virtio_net_feature
66 } virtio_net_feature_t;
68 int vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
69 const char *sock_filename, u8 is_server,
70 u32 * sw_if_index, u64 feature_mask,
71 u8 renumber, u32 custom_dev_instance, u8 * hwaddr);
72 int vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
73 const char *sock_filename, u8 is_server,
74 u32 sw_if_index, u64 feature_mask,
75 u8 renumber, u32 custom_dev_instance);
76 int vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
79 typedef struct vhost_user_memory_region
85 } vhost_user_memory_region_t;
87 typedef struct vhost_user_memory
91 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
92 } vhost_user_memory_t;
96 unsigned int index, num;
97 } vhost_vring_state_t;
101 unsigned int index, flags;
102 u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
103 } vhost_vring_addr_t;
105 typedef struct vhost_user_log
111 typedef enum vhost_user_req
114 VHOST_USER_GET_FEATURES = 1,
115 VHOST_USER_SET_FEATURES = 2,
116 VHOST_USER_SET_OWNER = 3,
117 VHOST_USER_RESET_OWNER = 4,
118 VHOST_USER_SET_MEM_TABLE = 5,
119 VHOST_USER_SET_LOG_BASE = 6,
120 VHOST_USER_SET_LOG_FD = 7,
121 VHOST_USER_SET_VRING_NUM = 8,
122 VHOST_USER_SET_VRING_ADDR = 9,
123 VHOST_USER_SET_VRING_BASE = 10,
124 VHOST_USER_GET_VRING_BASE = 11,
125 VHOST_USER_SET_VRING_KICK = 12,
126 VHOST_USER_SET_VRING_CALL = 13,
127 VHOST_USER_SET_VRING_ERR = 14,
128 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
129 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
130 VHOST_USER_GET_QUEUE_NUM = 17,
131 VHOST_USER_SET_VRING_ENABLE = 18,
135 // vring_desc I/O buffer descriptor
139 uint64_t addr; // packet data buffer address
140 uint32_t len; // packet data buffer size
141 uint16_t flags; // (see below)
142 uint16_t next; // optional index next descriptor in chain
143 } __attribute ((packed)) vring_desc_t;
149 uint16_t ring[VHOST_VRING_MAX_SIZE];
150 } __attribute ((packed)) vring_avail_t;
156 struct /* vring_used_elem */
160 } ring[VHOST_VRING_MAX_SIZE];
161 } __attribute ((packed)) vring_used_t;
171 } __attribute ((packed)) virtio_net_hdr_t;
174 virtio_net_hdr_t hdr;
176 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
178 typedef struct vhost_user_msg {
179 vhost_user_req_t request;
185 vhost_vring_state_t state;
186 vhost_vring_addr_t addr;
187 vhost_user_memory_t memory;
188 vhost_user_log_t log;
190 } __attribute ((packed)) vhost_user_msg_t;
199 vring_avail_t *avail;
208 u32 n_since_last_int;
210 } vhost_user_vring_t;
214 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
221 char sock_filename[256];
224 u32 hw_if_index, sw_if_index;
230 u64 protocol_features;
232 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
233 void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
234 u32 region_mmap_fd[VHOST_MEMORY_MAX_NREGIONS];
235 vhost_user_vring_t vrings[2];
236 int virtio_net_hdr_sz;
238 u32 *d_trace_buffers;
248 vhost_user_intf_t *vhost_user_interfaces;
249 u32 *vhost_user_inactive_interfaces_index;
250 uword *vhost_user_interface_index_by_listener_fd;
251 uword *vhost_user_interface_index_by_sock_fd;
252 uword *vhost_user_interface_index_by_sw_if_index;
253 u32 *show_dev_instance_by_real_dev_instance;
256 int dont_dump_vhost_user_memory;
263 u32 virtio_net_hdr_sz;
266 u8 sock_filename[256];
269 } vhost_user_intf_details_t;
271 int vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
272 vhost_user_intf_details_t ** out_vuids);
274 // CLI commands to be used from dpdk
275 clib_error_t *vhost_user_connect_command_fn (vlib_main_t * vm,
276 unformat_input_t * input,
277 vlib_cli_command_t * cmd);
278 clib_error_t *vhost_user_delete_command_fn (vlib_main_t * vm,
279 unformat_input_t * input,
280 vlib_cli_command_t * cmd);
281 clib_error_t *show_vhost_user_command_fn (vlib_main_t * vm,
282 unformat_input_t * input,
283 vlib_cli_command_t * cmd);
288 * fd.io coding-style-patch-verification: ON
291 * eval: (c-set-style "gnu")