FD.io VPP  v18.07.1-19-g511ce25
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 
27 #include <vnet/vnet_msg_enum.h>
28 
29 #define vl_typedefs /* define message structures */
30 #include <vnet/vnet_all_api_h.h>
31 #undef vl_typedefs
32 
33 #define vl_endianfun /* define message structures */
34 #include <vnet/vnet_all_api_h.h>
35 #undef vl_endianfun
36 
37 /* instantiate all the print functions we know about */
38 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
39 #define vl_printfun
40 #include <vnet/vnet_all_api_h.h>
41 #undef vl_printfun
42 
44 
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)
50 
51 /*
52  * WARNING: replicated pending api refactor completion
53  */
54 static void
56  vl_api_registration_t * reg, u32 sw_if_index)
57 {
59 
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);
64 
65  mp->admin_up_down = 0;
66  mp->link_up_down = 0;
67  mp->deleted = 1;
68  vl_api_send_msg (reg, (u8 *) mp);
69 }
70 
71 static void
73 {
74  int rv = 0;
76  u32 sw_if_index = (u32) ~ 0;
77  vnet_main_t *vnm = vnet_get_main ();
79 
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);
84 
85  /* Remember an interface tag for the new interface */
86  if (rv == 0)
87  {
88  /* If a tag was supplied... */
89  if (mp->tag[0])
90  {
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);
95  }
96  }
97 
98  /* *INDENT-OFF* */
99  REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_REPLY,
100  ({
101  rmp->sw_if_index = ntohl (sw_if_index);
102  }));
103  /* *INDENT-ON* */
104 }
105 
106 static void
108 {
109  int rv = 0;
110  vl_api_modify_vhost_user_if_reply_t *rmp;
111  u32 sw_if_index = ntohl (mp->sw_if_index);
112 
113  vnet_main_t *vnm = vnet_get_main ();
115 
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));
119 
120  REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_REPLY);
121 }
122 
123 static void
125 {
126  int rv = 0;
127  vl_api_delete_vhost_user_if_reply_t *rmp;
129  u32 sw_if_index = ntohl (mp->sw_if_index);
131 
132  vnet_main_t *vnm = vnet_get_main ();
134 
135  rv = vhost_user_delete_if (vnm, vm, sw_if_index);
136 
137  REPLY_MACRO (VL_API_DELETE_VHOST_USER_IF_REPLY);
138  if (!rv)
139  {
141  if (!reg)
142  return;
143 
144  vnet_clear_sw_interface_tag (vnm, sw_if_index);
145  send_sw_interface_event_deleted (vam, reg, sw_if_index);
146  }
147 }
148 
149 static void
151  vl_api_registration_t * reg,
153  u32 context)
154 {
156 
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;
167 
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);
172 
173  vl_api_send_msg (reg, (u8 *) mp);
174 }
175 
176 static void
179 {
180  int rv = 0;
182  vnet_main_t *vnm = vnet_get_main ();
187 
189  if (!reg)
190  return;
191 
192  rv = vhost_user_dump_ifs (vnm, vm, &ifaces);
193  if (rv)
194  return;
195 
196  vec_foreach (vuid, ifaces)
197  {
198  send_sw_interface_vhost_user_details (am, reg, vuid, mp->context);
199  }
200  vec_free (ifaces);
201 }
202 
203 /*
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()
209  */
210 #define vl_msg_name_crc_list
211 #include <vnet/vnet_all_api_h.h>
212 #undef vl_msg_name_crc_list
213 
214 static void
216 {
217 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
218  foreach_vl_msg_name_crc_vhost_user;
219 #undef _
220 }
221 
222 static clib_error_t *
224 {
225  api_main_t *am = &api_main;
226 
227 #define _(N,n) \
228  vl_msg_api_set_handlers(VL_API_##N, #n, \
229  vl_api_##n##_t_handler, \
230  vl_noop_handler, \
231  vl_api_##n##_t_endian, \
232  vl_api_##n##_t_print, \
233  sizeof(vl_api_##n##_t), 1);
235 #undef _
236 
237  /* Mark CREATE_VHOST_USER_IF as mp safe */
238  am->is_mp_safe[VL_API_CREATE_VHOST_USER_IF] = 1;
239 
240  /*
241  * Set up the (msg_name, crc, message-id) table
242  */
244 
245  return 0;
246 }
247 
249 
250 /*
251  * fd.io coding-style-patch-verification: ON
252  *
253  * Local Variables:
254  * eval: (c-set-style "gnu")
255  * End:
256  */
static clib_error_t * vhost_user_api_hookup(vlib_main_t *vm)
VLIB_API_INIT_FUNCTION(vhost_user_api_hookup)
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
Vhost-user interface details structure (fix this)
Definition: vhost_user.api:85
unsigned long u64
Definition: types.h:89
#define REPLY_MACRO2(t, body)
#define NULL
Definition: clib.h:55
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:34
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)
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
vhost-user interface create request
Definition: vhost_user.api:25
void * vl_msg_api_alloc(int nbytes)
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)
Definition: vhost_user.c:1517
unsigned char u8
Definition: types.h:56
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)
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)
Definition: vhost_user.c:1454
#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:1239
vhost-user interface create response
Definition: vhost_user.api:43
#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:1680
static void setup_message_id_table(api_main_t *am)
static void send_sw_interface_event_deleted(vpe_api_main_t *am, vl_api_registration_t *reg, u32 sw_if_index)
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:201
An API client registration, only in vpp/vlib.
Definition: api_common.h:44
vlib_main_t * vm
Definition: buffer.c:294
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:339
#define ARRAY_LEN(x)
Definition: clib.h:59
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
vhost-user interface modify request
Definition: vhost_user.api:55
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
Interface Event generated by want_interface_events.
Definition: interface.api:57
u8 * is_mp_safe
Message is mp safe vector.
Definition: api_common.h:224
#define vec_foreach(var, vec)
Vector iterator.
vhost-user interface delete request
Definition: vhost_user.api:69
vpe_api_main_t vpe_api_main
Definition: pipe_api.c:39
api_main_t api_main
Definition: api_shared.c:35
static void vl_api_sw_interface_vhost_user_dump_t_handler(vl_api_sw_interface_vhost_user_dump_t *mp)