Line data Source code
1 : /*
2 : *------------------------------------------------------------------
3 : * vhost-user_api.c - vhost-user api
4 : *
5 : * Copyright (c) 2016 Cisco and/or its affiliates.
6 : * Licensed under the Apache License, Version 2.0 (the "License");
7 : * you may not use this file except in compliance with the License.
8 : * You may obtain a copy of the License at:
9 : *
10 : * http://www.apache.org/licenses/LICENSE-2.0
11 : *
12 : * Unless required by applicable law or agreed to in writing, software
13 : * distributed under the License is distributed on an "AS IS" BASIS,
14 : * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 : * See the License for the specific language governing permissions and
16 : * limitations under the License.
17 : *------------------------------------------------------------------
18 : */
19 :
20 : #include <vnet/vnet.h>
21 : #include <vlibmemory/api.h>
22 :
23 : #include <vnet/interface.h>
24 : #include <vnet/api_errno.h>
25 : #include <vhost/vhost_user.h>
26 : #include <vnet/ethernet/ethernet.h>
27 : #include <vnet/ethernet/ethernet_types_api.h>
28 :
29 : #include <vnet/format_fns.h>
30 : #include <vhost/vhost_user.api_enum.h>
31 : #include <vhost/vhost_user.api_types.h>
32 :
33 : #define REPLY_MSG_ID_BASE msg_id_base
34 : #include <vlibapi/api_helper_macros.h>
35 :
36 : static u16 msg_id_base;
37 :
38 : static void
39 0 : vl_api_create_vhost_user_if_t_handler (vl_api_create_vhost_user_if_t * mp)
40 : {
41 0 : int rv = 0;
42 : vl_api_create_vhost_user_if_reply_t *rmp;
43 0 : vnet_main_t *vnm = vnet_get_main ();
44 0 : vlib_main_t *vm = vlib_get_main ();
45 0 : u64 disabled_features = (u64) (0ULL);
46 0 : vhost_user_create_if_args_t args = { 0 };
47 :
48 0 : args.sw_if_index = (u32) ~ 0;
49 0 : args.feature_mask = (u64) ~ (0ULL);
50 0 : if (mp->disable_mrg_rxbuf)
51 0 : disabled_features = VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);
52 :
53 0 : if (mp->disable_indirect_desc)
54 0 : disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
55 :
56 : /*
57 : * GSO and PACKED are not supported by feature mask via binary API. We
58 : * disable GSO and PACKED feature in the feature mask. They may be enabled
59 : * explicitly via enable_gso and enable_packed argument
60 : */
61 0 : disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
62 : VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
63 :
64 : /* EVENT_IDX is disabled by default */
65 0 : disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
66 0 : args.feature_mask &= ~disabled_features;
67 :
68 0 : if (mp->use_custom_mac)
69 0 : mac_address_decode (mp->mac_address, (mac_address_t *) args.hwaddr);
70 :
71 0 : args.use_custom_mac = mp->use_custom_mac;
72 0 : args.is_server = mp->is_server;
73 0 : args.sock_filename = (char *) mp->sock_filename;
74 0 : args.renumber = mp->renumber;
75 0 : args.custom_dev_instance = ntohl (mp->custom_dev_instance);
76 0 : args.enable_gso = mp->enable_gso;
77 0 : args.enable_packed = mp->enable_packed;
78 0 : rv = vhost_user_create_if (vnm, vm, &args);
79 :
80 : /* Remember an interface tag for the new interface */
81 0 : if (rv == 0)
82 : {
83 : /* If a tag was supplied... */
84 0 : if (mp->tag[0])
85 : {
86 : /* Make sure it's a proper C-string */
87 0 : mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
88 0 : u8 *tag = format (0, "%s%c", mp->tag, 0);
89 0 : vnet_set_sw_interface_tag (vnm, tag, args.sw_if_index);
90 : }
91 : }
92 :
93 : /* *INDENT-OFF* */
94 0 : REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_REPLY,
95 : ({
96 : rmp->sw_if_index = ntohl (args.sw_if_index);
97 : }));
98 : /* *INDENT-ON* */
99 : }
100 :
101 : static void
102 0 : vl_api_modify_vhost_user_if_t_handler (vl_api_modify_vhost_user_if_t * mp)
103 : {
104 0 : int rv = 0;
105 : vl_api_modify_vhost_user_if_reply_t *rmp;
106 0 : u64 disabled_features = (u64) (0ULL);
107 0 : vhost_user_create_if_args_t args = { 0 };
108 0 : vnet_main_t *vnm = vnet_get_main ();
109 0 : vlib_main_t *vm = vlib_get_main ();
110 :
111 0 : args.feature_mask = (u64) ~ (0ULL);
112 : /*
113 : * GSO and PACKED are not supported by feature mask via binary API. We
114 : * disable GSO and PACKED feature in the feature mask. They may be enabled
115 : * explicitly via enable_gso and enable_packed argument
116 : */
117 0 : disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
118 : VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
119 :
120 : /* EVENT_IDX is disabled by default */
121 0 : disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
122 0 : args.feature_mask &= ~disabled_features;
123 :
124 0 : args.sw_if_index = ntohl (mp->sw_if_index);
125 0 : args.sock_filename = (char *) mp->sock_filename;
126 0 : args.is_server = mp->is_server;
127 0 : args.renumber = mp->renumber;
128 0 : args.custom_dev_instance = ntohl (mp->custom_dev_instance);
129 0 : args.enable_gso = mp->enable_gso;
130 0 : args.enable_packed = mp->enable_packed;
131 0 : rv = vhost_user_modify_if (vnm, vm, &args);
132 :
133 0 : REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_REPLY);
134 : }
135 :
136 : static void
137 4 : vl_api_create_vhost_user_if_v2_t_handler (vl_api_create_vhost_user_if_v2_t *
138 : mp)
139 : {
140 4 : int rv = 0;
141 : vl_api_create_vhost_user_if_v2_reply_t *rmp;
142 4 : vnet_main_t *vnm = vnet_get_main ();
143 4 : vlib_main_t *vm = vlib_get_main ();
144 4 : u64 disabled_features = (u64) (0ULL);
145 4 : vhost_user_create_if_args_t args = { 0 };
146 :
147 4 : args.sw_if_index = (u32) ~ 0;
148 4 : args.feature_mask = (u64) ~ (0ULL);
149 4 : if (mp->disable_mrg_rxbuf)
150 0 : disabled_features = VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);
151 :
152 4 : if (mp->disable_indirect_desc)
153 0 : disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
154 :
155 : /*
156 : * GSO and PACKED are not supported by feature mask via binary API. We
157 : * disable GSO and PACKED feature in the feature mask. They may be enabled
158 : * explicitly via enable_gso and enable_packed argument
159 : */
160 4 : disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
161 : VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
162 :
163 : /* EVENT_IDX is disabled by default */
164 4 : disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
165 4 : args.feature_mask &= ~disabled_features;
166 :
167 4 : if (mp->use_custom_mac)
168 1 : mac_address_decode (mp->mac_address, (mac_address_t *) args.hwaddr);
169 :
170 4 : args.use_custom_mac = mp->use_custom_mac;
171 4 : args.is_server = mp->is_server;
172 4 : args.sock_filename = (char *) mp->sock_filename;
173 4 : args.renumber = mp->renumber;
174 4 : args.custom_dev_instance = ntohl (mp->custom_dev_instance);
175 4 : args.enable_gso = mp->enable_gso;
176 4 : args.enable_packed = mp->enable_packed;
177 4 : args.enable_event_idx = mp->enable_event_idx;
178 4 : rv = vhost_user_create_if (vnm, vm, &args);
179 :
180 : /* Remember an interface tag for the new interface */
181 4 : if (rv == 0)
182 : {
183 : /* If a tag was supplied... */
184 4 : if (mp->tag[0])
185 : {
186 : /* Make sure it's a proper C-string */
187 0 : mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
188 0 : u8 *tag = format (0, "%s%c", mp->tag, 0);
189 0 : vnet_set_sw_interface_tag (vnm, tag, args.sw_if_index);
190 : }
191 : }
192 :
193 : /* *INDENT-OFF* */
194 4 : REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_V2_REPLY,
195 : ({
196 : rmp->sw_if_index = ntohl (args.sw_if_index);
197 : }));
198 : /* *INDENT-ON* */
199 : }
200 :
201 : static void
202 0 : vl_api_modify_vhost_user_if_v2_t_handler (vl_api_modify_vhost_user_if_v2_t *
203 : mp)
204 : {
205 0 : int rv = 0;
206 : vl_api_modify_vhost_user_if_v2_reply_t *rmp;
207 0 : u64 disabled_features = (u64) (0ULL);
208 0 : vhost_user_create_if_args_t args = { 0 };
209 0 : vnet_main_t *vnm = vnet_get_main ();
210 0 : vlib_main_t *vm = vlib_get_main ();
211 :
212 0 : args.feature_mask = (u64) ~ (0ULL);
213 : /*
214 : * GSO and PACKED are not supported by feature mask via binary API. We
215 : * disable GSO and PACKED feature in the feature mask. They may be enabled
216 : * explicitly via enable_gso and enable_packed argument
217 : */
218 0 : disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
219 : VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
220 :
221 : /* EVENT_IDX is disabled by default */
222 0 : disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
223 0 : args.feature_mask &= ~disabled_features;
224 :
225 0 : args.sw_if_index = ntohl (mp->sw_if_index);
226 0 : args.sock_filename = (char *) mp->sock_filename;
227 0 : args.is_server = mp->is_server;
228 0 : args.renumber = mp->renumber;
229 0 : args.custom_dev_instance = ntohl (mp->custom_dev_instance);
230 0 : args.enable_gso = mp->enable_gso;
231 0 : args.enable_packed = mp->enable_packed;
232 0 : args.enable_event_idx = mp->enable_event_idx;
233 0 : rv = vhost_user_modify_if (vnm, vm, &args);
234 :
235 0 : REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_V2_REPLY);
236 : }
237 :
238 : static void
239 4 : vl_api_delete_vhost_user_if_t_handler (vl_api_delete_vhost_user_if_t * mp)
240 : {
241 4 : int rv = 0;
242 : vl_api_delete_vhost_user_if_reply_t *rmp;
243 4 : u32 sw_if_index = ntohl (mp->sw_if_index);
244 : vl_api_registration_t *reg;
245 :
246 4 : vnet_main_t *vnm = vnet_get_main ();
247 4 : vlib_main_t *vm = vlib_get_main ();
248 :
249 4 : rv = vhost_user_delete_if (vnm, vm, sw_if_index);
250 :
251 4 : REPLY_MACRO (VL_API_DELETE_VHOST_USER_IF_REPLY);
252 4 : if (!rv)
253 : {
254 4 : reg = vl_api_client_index_to_registration (mp->client_index);
255 4 : if (!reg)
256 0 : return;
257 :
258 4 : vnet_clear_sw_interface_tag (vnm, sw_if_index);
259 : }
260 : }
261 :
262 : static void
263 3 : vhost_user_features_encode (u64 features, u32 *first, u32 *last)
264 : {
265 3 : *first = clib_net_to_host_u32 (features);
266 3 : *last = clib_net_to_host_u32 (features >> 32);
267 3 : }
268 :
269 : static void
270 3 : send_sw_interface_vhost_user_details (vpe_api_main_t * am,
271 : vl_api_registration_t * reg,
272 : vhost_user_intf_details_t * vui,
273 : u32 context)
274 : {
275 : vl_api_sw_interface_vhost_user_details_t *mp;
276 :
277 3 : mp = vl_msg_api_alloc (sizeof (*mp));
278 3 : clib_memset (mp, 0, sizeof (*mp));
279 3 : mp->_vl_msg_id =
280 3 : ntohs (REPLY_MSG_ID_BASE + VL_API_SW_INTERFACE_VHOST_USER_DETAILS);
281 3 : mp->sw_if_index = ntohl (vui->sw_if_index);
282 3 : mp->virtio_net_hdr_sz = ntohl (vui->virtio_net_hdr_sz);
283 3 : vhost_user_features_encode (vui->features, (u32 *) &mp->features_first_32,
284 3 : (u32 *) &mp->features_last_32);
285 3 : mp->is_server = vui->is_server;
286 3 : mp->num_regions = ntohl (vui->num_regions);
287 3 : mp->sock_errno = ntohl (vui->sock_errno);
288 3 : mp->context = context;
289 :
290 3 : strncpy ((char *) mp->sock_filename,
291 3 : (char *) vui->sock_filename, ARRAY_LEN (mp->sock_filename) - 1);
292 3 : strncpy ((char *) mp->interface_name,
293 3 : (char *) vui->if_name, ARRAY_LEN (mp->interface_name) - 1);
294 :
295 3 : vl_api_send_msg (reg, (u8 *) mp);
296 3 : }
297 :
298 : static void
299 6 : vl_api_sw_interface_vhost_user_dump_t_handler
300 : (vl_api_sw_interface_vhost_user_dump_t * mp)
301 : {
302 6 : int rv = 0;
303 6 : vpe_api_main_t *am = &vpe_api_main;
304 6 : vnet_main_t *vnm = vnet_get_main ();
305 6 : vlib_main_t *vm = vlib_get_main ();
306 6 : vhost_user_intf_details_t *ifaces = NULL;
307 6 : vhost_user_intf_details_t *vuid = NULL;
308 : vl_api_registration_t *reg;
309 : u32 filter_sw_if_index;
310 :
311 6 : reg = vl_api_client_index_to_registration (mp->client_index);
312 6 : if (!reg)
313 0 : return;
314 :
315 6 : filter_sw_if_index = htonl (mp->sw_if_index);
316 6 : if (filter_sw_if_index != ~0)
317 0 : VALIDATE_SW_IF_INDEX (mp);
318 :
319 6 : rv = vhost_user_dump_ifs (vnm, vm, &ifaces);
320 6 : if (rv)
321 0 : return;
322 :
323 9 : vec_foreach (vuid, ifaces)
324 : {
325 3 : if ((filter_sw_if_index == ~0) ||
326 0 : (vuid->sw_if_index == filter_sw_if_index))
327 3 : send_sw_interface_vhost_user_details (am, reg, vuid, mp->context);
328 : }
329 6 : BAD_SW_IF_INDEX_LABEL;
330 6 : vec_free (ifaces);
331 : }
332 :
333 : #include <vhost/vhost_user.api.c>
334 : static clib_error_t *
335 575 : vhost_user_api_hookup (vlib_main_t * vm)
336 : {
337 575 : api_main_t *am = vlibapi_get_main ();
338 :
339 : /*
340 : * Set up the (msg_name, crc, message-id) table
341 : */
342 575 : REPLY_MSG_ID_BASE = setup_message_id_table ();
343 :
344 : /* Mark CREATE_VHOST_USER_IF as mp safe */
345 575 : vl_api_set_msg_thread_safe (
346 : am, REPLY_MSG_ID_BASE + VL_API_CREATE_VHOST_USER_IF, 1);
347 575 : vl_api_set_msg_thread_safe (
348 575 : am, REPLY_MSG_ID_BASE + VL_API_CREATE_VHOST_USER_IF_V2, 1);
349 :
350 575 : return 0;
351 : }
352 :
353 1151 : VLIB_API_INIT_FUNCTION (vhost_user_api_hookup);
354 :
355 : /*
356 : * fd.io coding-style-patch-verification: ON
357 : *
358 : * Local Variables:
359 : * eval: (c-set-style "gnu")
360 : * End:
361 : */
|
