FD.io VPP  v21.01.1
Vector Packet Processing
vhost_user_api.c
Go to the documentation of this file.
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>
26 #include <vnet/ethernet/ethernet.h>
29 
30 #include <vnet/vnet_msg_enum.h>
31 
32 #define vl_typedefs /* define message structures */
33 #include <vnet/vnet_all_api_h.h>
34 #undef vl_typedefs
35 
36 #define vl_endianfun /* define message structures */
37 #include <vnet/vnet_all_api_h.h>
38 #undef vl_endianfun
39 
40 /* instantiate all the print functions we know about */
41 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
42 #define vl_printfun
43 #include <vnet/vnet_all_api_h.h>
44 #undef vl_printfun
45 
47 
48 #define foreach_vpe_api_msg \
49 _(CREATE_VHOST_USER_IF, create_vhost_user_if) \
50 _(MODIFY_VHOST_USER_IF, modify_vhost_user_if) \
51 _(DELETE_VHOST_USER_IF, delete_vhost_user_if) \
52 _(SW_INTERFACE_VHOST_USER_DUMP, sw_interface_vhost_user_dump)
53 
54 static void
56 {
57  int rv = 0;
59  u32 sw_if_index = (u32) ~ 0;
60  vnet_main_t *vnm = vnet_get_main ();
62  u64 features = (u64) ~ (0ULL);
63  u64 disabled_features = (u64) (0ULL);
65  u8 *mac_p = NULL;
66 
67  if (mp->disable_mrg_rxbuf)
68  disabled_features = VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);
69 
70  if (mp->disable_indirect_desc)
71  disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
72 
73  /*
74  * GSO and PACKED are not supported by feature mask via binary API. We
75  * disable GSO and PACKED feature in the feature mask. They may be enabled
76  * explicitly via enable_gso and enable_packed argument
77  */
79  VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
80  features &= ~disabled_features;
81 
82  if (mp->use_custom_mac)
83  {
84  mac_address_decode (mp->mac_address, &mac);
85  mac_p = (u8 *) & mac;
86  }
87 
88  rv = vhost_user_create_if (vnm, vm, (char *) mp->sock_filename,
89  mp->is_server, &sw_if_index, features,
90  mp->renumber, ntohl (mp->custom_dev_instance),
91  mac_p, mp->enable_gso, mp->enable_packed);
92 
93  /* Remember an interface tag for the new interface */
94  if (rv == 0)
95  {
96  /* If a tag was supplied... */
97  if (mp->tag[0])
98  {
99  /* Make sure it's a proper C-string */
100  mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
101  u8 *tag = format (0, "%s%c", mp->tag, 0);
102  vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
103  }
104  }
105 
106  /* *INDENT-OFF* */
107  REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_REPLY,
108  ({
109  rmp->sw_if_index = ntohl (sw_if_index);
110  }));
111  /* *INDENT-ON* */
112 }
113 
114 static void
116 {
117  int rv = 0;
118  vl_api_modify_vhost_user_if_reply_t *rmp;
119  u32 sw_if_index = ntohl (mp->sw_if_index);
120  u64 features = (u64) ~ (0ULL);
121  u64 disabled_features = (u64) (0ULL);
122 
123  vnet_main_t *vnm = vnet_get_main ();
125 
126  /*
127  * GSO and PACKED are not supported by feature mask via binary API. We
128  * disable GSO and PACKED feature in the feature mask. They may be enabled
129  * explicitly via enable_gso and enable_packed argument
130  */
132  VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
133  features &= ~disabled_features;
134 
135  rv = vhost_user_modify_if (vnm, vm, (char *) mp->sock_filename,
136  mp->is_server, sw_if_index, features,
137  mp->renumber, ntohl (mp->custom_dev_instance),
138  mp->enable_gso, mp->enable_packed);
139 
140  REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_REPLY);
141 }
142 
143 static void
145 {
146  int rv = 0;
147  vl_api_delete_vhost_user_if_reply_t *rmp;
148  u32 sw_if_index = ntohl (mp->sw_if_index);
150 
151  vnet_main_t *vnm = vnet_get_main ();
153 
154  rv = vhost_user_delete_if (vnm, vm, sw_if_index);
155 
156  REPLY_MACRO (VL_API_DELETE_VHOST_USER_IF_REPLY);
157  if (!rv)
158  {
160  if (!reg)
161  return;
162 
163  vnet_clear_sw_interface_tag (vnm, sw_if_index);
164  }
165 }
166 
167 static void
169  vl_api_registration_t * reg,
171  u32 context)
172 {
174 
175  mp = vl_msg_api_alloc (sizeof (*mp));
176  clib_memset (mp, 0, sizeof (*mp));
177  mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_VHOST_USER_DETAILS);
178  mp->sw_if_index = ntohl (vui->sw_if_index);
179  mp->virtio_net_hdr_sz = ntohl (vui->virtio_net_hdr_sz);
181  (u32 *) & mp->features_last_32);
182  mp->is_server = vui->is_server;
183  mp->num_regions = ntohl (vui->num_regions);
184  mp->sock_errno = ntohl (vui->sock_errno);
185  mp->context = context;
186 
187  strncpy ((char *) mp->sock_filename,
188  (char *) vui->sock_filename, ARRAY_LEN (mp->sock_filename) - 1);
189  strncpy ((char *) mp->interface_name,
190  (char *) vui->if_name, ARRAY_LEN (mp->interface_name) - 1);
191 
192  vl_api_send_msg (reg, (u8 *) mp);
193 }
194 
195 static void
198 {
199  int rv = 0;
201  vnet_main_t *vnm = vnet_get_main ();
203  vhost_user_intf_details_t *ifaces = NULL;
204  vhost_user_intf_details_t *vuid = NULL;
206  u32 filter_sw_if_index;
207 
209  if (!reg)
210  return;
211 
212  filter_sw_if_index = htonl (mp->sw_if_index);
213  if (filter_sw_if_index != ~0)
215 
216  rv = vhost_user_dump_ifs (vnm, vm, &ifaces);
217  if (rv)
218  return;
219 
220  vec_foreach (vuid, ifaces)
221  {
222  if ((filter_sw_if_index == ~0) ||
223  (vuid->sw_if_index == filter_sw_if_index))
224  send_sw_interface_vhost_user_details (am, reg, vuid, mp->context);
225  }
227  vec_free (ifaces);
228 }
229 
230 /*
231  * vhost-user_api_hookup
232  * Add vpe's API message handlers to the table.
233  * vlib has already mapped shared memory and
234  * added the client registration handlers.
235  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
236  */
237 #define vl_msg_name_crc_list
238 #include <vnet/vnet_all_api_h.h>
239 #undef vl_msg_name_crc_list
240 
241 static void
243 {
244 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
245  foreach_vl_msg_name_crc_vhost_user;
246 #undef _
247 }
248 
249 static clib_error_t *
251 {
252  api_main_t *am = vlibapi_get_main ();
253 
254 #define _(N,n) \
255  vl_msg_api_set_handlers(VL_API_##N, #n, \
256  vl_api_##n##_t_handler, \
257  vl_noop_handler, \
258  vl_api_##n##_t_endian, \
259  vl_api_##n##_t_print, \
260  sizeof(vl_api_##n##_t), 1);
262 #undef _
263 
264  /* Mark CREATE_VHOST_USER_IF as mp safe */
265  am->is_mp_safe[VL_API_CREATE_VHOST_USER_IF] = 1;
266 
267  /*
268  * Set up the (msg_name, crc, message-id) table
269  */
271 
272  return 0;
273 }
274 
276 
277 /*
278  * fd.io coding-style-patch-verification: ON
279  *
280  * Local Variables:
281  * eval: (c-set-style "gnu")
282  * End:
283  */
static clib_error_t * vhost_user_api_hookup(vlib_main_t *vm)
vl_api_mac_address_t mac
Definition: l2.api:502
#define ntohs(x)
Definition: af_xdp.bpf.c:29
VLIB_API_INIT_FUNCTION(vhost_user_api_hookup)
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
Vhost-user interface details structure (fix this)
Definition: vhost_user.api:103
vl_api_mac_address_t mac_address
Definition: vhost_user.api:46
unsigned long u64
Definition: types.h:89
#define REPLY_MACRO2(t, body)
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:35
static void vl_api_delete_vhost_user_if_t_handler(vl_api_delete_vhost_user_if_t *mp)
static void vnet_clear_sw_interface_tag(vnet_main_t *vnm, u32 sw_if_index)
vlib_main_t * vm
Definition: in2out_ed.c:1580
vhost-user interface create request
Definition: vhost_user.api:33
void * vl_msg_api_alloc(int nbytes)
unsigned char u8
Definition: types.h:56
#define VIRTIO_FEATURE(X)
Definition: virtio_std.h:69
vl_api_virtio_net_features_last_32_t features_last_32
Definition: vhost_user.api:110
Vhost-user interface dump request.
Definition: vhost_user.api:120
description fragment has unexpected format
Definition: map.api:433
static void vl_api_modify_vhost_user_if_t_handler(vl_api_modify_vhost_user_if_t *mp)
unsigned int u32
Definition: types.h:88
static void vl_api_create_vhost_user_if_t_handler(vl_api_create_vhost_user_if_t *mp)
vl_api_interface_index_t sw_if_index
Definition: vhost_user.api:89
int vhost_user_create_if(vnet_main_t *vnm, vlib_main_t *vm, const char *sock_filename, u8 is_server, u32 *sw_if_index, u64 feature_mask, u8 renumber, u32 custom_dev_instance, u8 *hwaddr, u8 enable_gso, u8 enable_packed)
Definition: vhost_user.c:1579
#define foreach_vpe_api_msg
int vhost_user_delete_if(vnet_main_t *vnm, vlib_main_t *vm, u32 sw_if_index)
Definition: vhost_user.c:1343
vhost-user interface create response
Definition: vhost_user.api:55
#define REPLY_MACRO(t)
int vhost_user_dump_ifs(vnet_main_t *vnm, vlib_main_t *vm, vhost_user_intf_details_t **out_vuids)
Definition: vhost_user.c:1820
static void setup_message_id_table(api_main_t *am)
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:227
vl_api_interface_index_t sw_if_index
Definition: vhost_user.api:106
vl_api_virtio_net_features_first_32_t features_first_32
Definition: vhost_user.api:109
An API client registration, only in vpp/vlib.
Definition: api_common.h:47
#define BAD_SW_IF_INDEX_LABEL
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:380
#define ARRAY_LEN(x)
Definition: clib.h:67
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:79
void virtio_features_encode(u64 features, u32 *first, u32 *last)
int vhost_user_modify_if(vnet_main_t *vnm, vlib_main_t *vm, const char *sock_filename, u8 is_server, u32 sw_if_index, u64 feature_mask, u8 renumber, u32 custom_dev_instance, u8 enable_gso, u8 enable_packed)
Definition: vhost_user.c:1643
vhost-user interface modify request
Definition: vhost_user.api:69
static void vnet_set_sw_interface_tag(vnet_main_t *vnm, u8 *tag, u32 sw_if_index)
static void send_sw_interface_vhost_user_details(vpe_api_main_t *am, vl_api_registration_t *reg, vhost_user_intf_details_t *vui, u32 context)
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
vl_api_interface_index_t sw_if_index
Definition: vhost_user.api:73
vl_api_interface_index_t sw_if_index
Definition: vhost_user.api:59
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:389
u8 * is_mp_safe
Message is mp safe vector.
Definition: api_common.h:250
#define vec_foreach(var, vec)
Vector iterator.
vhost-user interface delete request
Definition: vhost_user.api:85
vpe_api_main_t vpe_api_main
Definition: interface_api.c:54
#define FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS
Definition: vhost_user.h:89
void mac_address_decode(const u8 *in, mac_address_t *out)
Conversion functions to/from (decode/encode) API types to VPP internal types.
static void vl_api_sw_interface_vhost_user_dump_t_handler(vl_api_sw_interface_vhost_user_dump_t *mp)
vl_api_interface_index_t sw_if_index[default=0xffffffff]
Definition: vhost_user.api:124
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
#define VALIDATE_SW_IF_INDEX(mp)