2 *------------------------------------------------------------------
3 * vhost-user_api.c - vhost-user api
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:
10 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/devices/virtio/vhost_user.h>
27 #include <vnet/vnet_msg_enum.h>
29 #define vl_typedefs /* define message structures */
30 #include <vnet/vnet_all_api_h.h>
33 #define vl_endianfun /* define message structures */
34 #include <vnet/vnet_all_api_h.h>
37 /* instantiate all the print functions we know about */
38 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
40 #include <vnet/vnet_all_api_h.h>
43 #include <vlibapi/api_helper_macros.h>
45 #define foreach_vpe_api_msg \
46 _(CREATE_VHOST_USER_IF, create_vhost_user_if) \
47 _(MODIFY_VHOST_USER_IF, modify_vhost_user_if) \
48 _(DELETE_VHOST_USER_IF, delete_vhost_user_if) \
49 _(SW_INTERFACE_VHOST_USER_DUMP, sw_interface_vhost_user_dump)
52 * WARNING: replicated pending api refactor completion
55 send_sw_interface_event_deleted (vpe_api_main_t * am,
56 vl_api_registration_t * reg, u32 sw_if_index)
58 vl_api_sw_interface_event_t *mp;
60 mp = vl_msg_api_alloc (sizeof (*mp));
61 clib_memset (mp, 0, sizeof (*mp));
62 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
63 mp->sw_if_index = ntohl (sw_if_index);
67 vl_api_send_msg (reg, (u8 *) mp);
71 vl_api_create_vhost_user_if_t_handler (vl_api_create_vhost_user_if_t * mp)
74 vl_api_create_vhost_user_if_reply_t *rmp;
75 u32 sw_if_index = (u32) ~ 0;
76 vnet_main_t *vnm = vnet_get_main ();
77 vlib_main_t *vm = vlib_get_main ();
78 u64 features = (u64) ~ (0ULL);
79 u64 disabled_features = (u64) (0ULL);
81 if (mp->disable_mrg_rxbuf)
82 disabled_features = (1ULL << FEAT_VIRTIO_NET_F_MRG_RXBUF);
84 if (mp->disable_indirect_desc)
85 disabled_features |= (1ULL << FEAT_VIRTIO_F_INDIRECT_DESC);
87 features &= ~disabled_features;
89 rv = vhost_user_create_if (vnm, vm, (char *) mp->sock_filename,
90 mp->is_server, &sw_if_index, features,
91 mp->renumber, ntohl (mp->custom_dev_instance),
92 (mp->use_custom_mac) ? mp->mac_address : NULL);
94 /* Remember an interface tag for the new interface */
97 /* If a tag was supplied... */
100 /* Make sure it's a proper C-string */
101 mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
102 u8 *tag = format (0, "%s%c", mp->tag, 0);
103 vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
108 REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_REPLY,
110 rmp->sw_if_index = ntohl (sw_if_index);
116 vl_api_modify_vhost_user_if_t_handler (vl_api_modify_vhost_user_if_t * mp)
119 vl_api_modify_vhost_user_if_reply_t *rmp;
120 u32 sw_if_index = ntohl (mp->sw_if_index);
122 vnet_main_t *vnm = vnet_get_main ();
123 vlib_main_t *vm = vlib_get_main ();
125 rv = vhost_user_modify_if (vnm, vm, (char *) mp->sock_filename,
126 mp->is_server, sw_if_index, (u64) ~ 0,
127 mp->renumber, ntohl (mp->custom_dev_instance));
129 REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_REPLY);
133 vl_api_delete_vhost_user_if_t_handler (vl_api_delete_vhost_user_if_t * mp)
136 vl_api_delete_vhost_user_if_reply_t *rmp;
137 vpe_api_main_t *vam = &vpe_api_main;
138 u32 sw_if_index = ntohl (mp->sw_if_index);
139 vl_api_registration_t *reg;
141 vnet_main_t *vnm = vnet_get_main ();
142 vlib_main_t *vm = vlib_get_main ();
144 rv = vhost_user_delete_if (vnm, vm, sw_if_index);
146 REPLY_MACRO (VL_API_DELETE_VHOST_USER_IF_REPLY);
149 reg = vl_api_client_index_to_registration (mp->client_index);
153 vnet_clear_sw_interface_tag (vnm, sw_if_index);
154 send_sw_interface_event_deleted (vam, reg, sw_if_index);
159 send_sw_interface_vhost_user_details (vpe_api_main_t * am,
160 vl_api_registration_t * reg,
161 vhost_user_intf_details_t * vui,
164 vl_api_sw_interface_vhost_user_details_t *mp;
166 mp = vl_msg_api_alloc (sizeof (*mp));
167 clib_memset (mp, 0, sizeof (*mp));
168 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_VHOST_USER_DETAILS);
169 mp->sw_if_index = ntohl (vui->sw_if_index);
170 mp->virtio_net_hdr_sz = ntohl (vui->virtio_net_hdr_sz);
171 mp->features = clib_net_to_host_u64 (vui->features);
172 mp->is_server = vui->is_server;
173 mp->num_regions = ntohl (vui->num_regions);
174 mp->sock_errno = ntohl (vui->sock_errno);
175 mp->context = context;
177 strncpy ((char *) mp->sock_filename,
178 (char *) vui->sock_filename, ARRAY_LEN (mp->sock_filename) - 1);
179 strncpy ((char *) mp->interface_name,
180 (char *) vui->if_name, ARRAY_LEN (mp->interface_name) - 1);
182 vl_api_send_msg (reg, (u8 *) mp);
186 vl_api_sw_interface_vhost_user_dump_t_handler
187 (vl_api_sw_interface_vhost_user_dump_t * mp)
190 vpe_api_main_t *am = &vpe_api_main;
191 vnet_main_t *vnm = vnet_get_main ();
192 vlib_main_t *vm = vlib_get_main ();
193 vhost_user_intf_details_t *ifaces = NULL;
194 vhost_user_intf_details_t *vuid = NULL;
195 vl_api_registration_t *reg;
197 reg = vl_api_client_index_to_registration (mp->client_index);
201 rv = vhost_user_dump_ifs (vnm, vm, &ifaces);
205 vec_foreach (vuid, ifaces)
207 send_sw_interface_vhost_user_details (am, reg, vuid, mp->context);
213 * vhost-user_api_hookup
214 * Add vpe's API message handlers to the table.
215 * vlib has alread mapped shared memory and
216 * added the client registration handlers.
217 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
219 #define vl_msg_name_crc_list
220 #include <vnet/vnet_all_api_h.h>
221 #undef vl_msg_name_crc_list
224 setup_message_id_table (api_main_t * am)
226 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
227 foreach_vl_msg_name_crc_vhost_user;
231 static clib_error_t *
232 vhost_user_api_hookup (vlib_main_t * vm)
234 api_main_t *am = &api_main;
237 vl_msg_api_set_handlers(VL_API_##N, #n, \
238 vl_api_##n##_t_handler, \
240 vl_api_##n##_t_endian, \
241 vl_api_##n##_t_print, \
242 sizeof(vl_api_##n##_t), 1);
246 /* Mark CREATE_VHOST_USER_IF as mp safe */
247 am->is_mp_safe[VL_API_CREATE_VHOST_USER_IF] = 1;
250 * Set up the (msg_name, crc, message-id) table
252 setup_message_id_table (am);
257 VLIB_API_INIT_FUNCTION (vhost_user_api_hookup);
260 * fd.io coding-style-patch-verification: ON
263 * eval: (c-set-style "gnu")