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 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);
65 mp->admin_up_down = 0;
68 vl_api_send_msg (reg, (u8 *) mp);
72 vl_api_create_vhost_user_if_t_handler (vl_api_create_vhost_user_if_t * mp)
75 vl_api_create_vhost_user_if_reply_t *rmp;
76 u32 sw_if_index = (u32) ~ 0;
77 vnet_main_t *vnm = vnet_get_main ();
78 vlib_main_t *vm = vlib_get_main ();
80 rv = vhost_user_create_if (vnm, vm, (char *) mp->sock_filename,
81 mp->is_server, &sw_if_index, (u64) ~ 0,
82 mp->renumber, ntohl (mp->custom_dev_instance),
83 (mp->use_custom_mac) ? mp->mac_address : NULL);
85 /* Remember an interface tag for the new interface */
88 /* If a tag was supplied... */
91 /* Make sure it's a proper C-string */
92 mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
93 u8 *tag = format (0, "%s%c", mp->tag, 0);
94 vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
99 REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_REPLY,
101 rmp->sw_if_index = ntohl (sw_if_index);
107 vl_api_modify_vhost_user_if_t_handler (vl_api_modify_vhost_user_if_t * mp)
110 vl_api_modify_vhost_user_if_reply_t *rmp;
111 u32 sw_if_index = ntohl (mp->sw_if_index);
113 vnet_main_t *vnm = vnet_get_main ();
114 vlib_main_t *vm = vlib_get_main ();
116 rv = vhost_user_modify_if (vnm, vm, (char *) mp->sock_filename,
117 mp->is_server, sw_if_index, (u64) ~ 0,
118 mp->renumber, ntohl (mp->custom_dev_instance));
120 REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_REPLY);
124 vl_api_delete_vhost_user_if_t_handler (vl_api_delete_vhost_user_if_t * mp)
127 vl_api_delete_vhost_user_if_reply_t *rmp;
128 vpe_api_main_t *vam = &vpe_api_main;
129 u32 sw_if_index = ntohl (mp->sw_if_index);
130 vl_api_registration_t *reg;
132 vnet_main_t *vnm = vnet_get_main ();
133 vlib_main_t *vm = vlib_get_main ();
135 rv = vhost_user_delete_if (vnm, vm, sw_if_index);
137 REPLY_MACRO (VL_API_DELETE_VHOST_USER_IF_REPLY);
140 reg = vl_api_client_index_to_registration (mp->client_index);
144 vnet_clear_sw_interface_tag (vnm, sw_if_index);
145 send_sw_interface_event_deleted (vam, reg, sw_if_index);
150 send_sw_interface_vhost_user_details (vpe_api_main_t * am,
151 vl_api_registration_t * reg,
152 vhost_user_intf_details_t * vui,
155 vl_api_sw_interface_vhost_user_details_t *mp;
157 mp = vl_msg_api_alloc (sizeof (*mp));
158 memset (mp, 0, sizeof (*mp));
159 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_VHOST_USER_DETAILS);
160 mp->sw_if_index = ntohl (vui->sw_if_index);
161 mp->virtio_net_hdr_sz = ntohl (vui->virtio_net_hdr_sz);
162 mp->features = clib_net_to_host_u64 (vui->features);
163 mp->is_server = vui->is_server;
164 mp->num_regions = ntohl (vui->num_regions);
165 mp->sock_errno = ntohl (vui->sock_errno);
166 mp->context = context;
168 strncpy ((char *) mp->sock_filename,
169 (char *) vui->sock_filename, ARRAY_LEN (mp->sock_filename) - 1);
170 strncpy ((char *) mp->interface_name,
171 (char *) vui->if_name, ARRAY_LEN (mp->interface_name) - 1);
173 vl_api_send_msg (reg, (u8 *) mp);
177 vl_api_sw_interface_vhost_user_dump_t_handler
178 (vl_api_sw_interface_vhost_user_dump_t * mp)
181 vpe_api_main_t *am = &vpe_api_main;
182 vnet_main_t *vnm = vnet_get_main ();
183 vlib_main_t *vm = vlib_get_main ();
184 vhost_user_intf_details_t *ifaces = NULL;
185 vhost_user_intf_details_t *vuid = NULL;
186 vl_api_registration_t *reg;
188 reg = vl_api_client_index_to_registration (mp->client_index);
192 rv = vhost_user_dump_ifs (vnm, vm, &ifaces);
196 vec_foreach (vuid, ifaces)
198 send_sw_interface_vhost_user_details (am, reg, vuid, mp->context);
204 * vhost-user_api_hookup
205 * Add vpe's API message handlers to the table.
206 * vlib has alread mapped shared memory and
207 * added the client registration handlers.
208 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
210 #define vl_msg_name_crc_list
211 #include <vnet/vnet_all_api_h.h>
212 #undef vl_msg_name_crc_list
215 setup_message_id_table (api_main_t * am)
217 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
218 foreach_vl_msg_name_crc_vhost_user;
222 static clib_error_t *
223 vhost_user_api_hookup (vlib_main_t * vm)
225 api_main_t *am = &api_main;
228 vl_msg_api_set_handlers(VL_API_##N, #n, \
229 vl_api_##n##_t_handler, \
231 vl_api_##n##_t_endian, \
232 vl_api_##n##_t_print, \
233 sizeof(vl_api_##n##_t), 1);
238 * Set up the (msg_name, crc, message-id) table
240 setup_message_id_table (am);
245 VLIB_API_INIT_FUNCTION (vhost_user_api_hookup);
248 * fd.io coding-style-patch-verification: ON
251 * eval: (c-set-style "gnu")