FD.io VPP  v18.01.2-1-g9b554f3
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
57  u32 sw_if_index)
58 {
60 
61  mp = vl_msg_api_alloc (sizeof (*mp));
62  memset (mp, 0, sizeof (*mp));
63  mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
64  mp->sw_if_index = ntohl (sw_if_index);
65 
66  mp->admin_up_down = 0;
67  mp->link_up_down = 0;
68  mp->deleted = 1;
69  vl_msg_api_send_shmem (q, (u8 *) & mp);
70 }
71 
72 static void
74 {
75  int rv = 0;
77  u32 sw_if_index = (u32) ~ 0;
78  vnet_main_t *vnm = vnet_get_main ();
80 
81  rv = vhost_user_create_if (vnm, vm, (char *) mp->sock_filename,
82  mp->is_server, &sw_if_index, (u64) ~ 0,
83  mp->renumber, ntohl (mp->custom_dev_instance),
84  (mp->use_custom_mac) ? mp->mac_address : NULL);
85 
86  /* Remember an interface tag for the new interface */
87  if (rv == 0)
88  {
89  /* If a tag was supplied... */
90  if (mp->tag[0])
91  {
92  /* Make sure it's a proper C-string */
93  mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
94  u8 *tag = format (0, "%s%c", mp->tag, 0);
95  vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
96  }
97  }
98 
99  /* *INDENT-OFF* */
100  REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_REPLY,
101  ({
102  rmp->sw_if_index = ntohl (sw_if_index);
103  }));
104  /* *INDENT-ON* */
105 }
106 
107 static void
109 {
110  int rv = 0;
111  vl_api_modify_vhost_user_if_reply_t *rmp;
112  u32 sw_if_index = ntohl (mp->sw_if_index);
113 
114  vnet_main_t *vnm = vnet_get_main ();
116 
117  rv = vhost_user_modify_if (vnm, vm, (char *) mp->sock_filename,
118  mp->is_server, sw_if_index, (u64) ~ 0,
119  mp->renumber, ntohl (mp->custom_dev_instance));
120 
121  REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_REPLY);
122 }
123 
124 static void
126 {
127  int rv = 0;
128  vl_api_delete_vhost_user_if_reply_t *rmp;
130  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  {
142  if (!q)
143  return;
144 
145  vnet_clear_sw_interface_tag (vnm, sw_if_index);
146  send_sw_interface_event_deleted (vam, q, sw_if_index);
147  }
148 }
149 
150 static void
154  u32 context)
155 {
157 
158  mp = vl_msg_api_alloc (sizeof (*mp));
159  memset (mp, 0, sizeof (*mp));
160  mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_VHOST_USER_DETAILS);
161  mp->sw_if_index = ntohl (vui->sw_if_index);
162  mp->virtio_net_hdr_sz = ntohl (vui->virtio_net_hdr_sz);
163  mp->features = clib_net_to_host_u64 (vui->features);
164  mp->is_server = vui->is_server;
165  mp->num_regions = ntohl (vui->num_regions);
166  mp->sock_errno = ntohl (vui->sock_errno);
167  mp->context = context;
168 
169  strncpy ((char *) mp->sock_filename,
170  (char *) vui->sock_filename, ARRAY_LEN (mp->sock_filename) - 1);
171  strncpy ((char *) mp->interface_name,
172  (char *) vui->if_name, ARRAY_LEN (mp->interface_name) - 1);
173 
174  vl_msg_api_send_shmem (q, (u8 *) & mp);
175 }
176 
177 static void
180 {
181  int rv = 0;
183  vnet_main_t *vnm = vnet_get_main ();
188 
190  if (q == 0)
191  return;
192 
193  rv = vhost_user_dump_ifs (vnm, vm, &ifaces);
194  if (rv)
195  return;
196 
197  vec_foreach (vuid, ifaces)
198  {
200  }
201  vec_free (ifaces);
202 }
203 
204 /*
205  * vhost-user_api_hookup
206  * Add vpe's API message handlers to the table.
207  * vlib has alread mapped shared memory and
208  * added the client registration handlers.
209  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
210  */
211 #define vl_msg_name_crc_list
212 #include <vnet/vnet_all_api_h.h>
213 #undef vl_msg_name_crc_list
214 
215 static void
217 {
218 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
219  foreach_vl_msg_name_crc_vhost_user;
220 #undef _
221 }
222 
223 static clib_error_t *
225 {
226  api_main_t *am = &api_main;
227 
228 #define _(N,n) \
229  vl_msg_api_set_handlers(VL_API_##N, #n, \
230  vl_api_##n##_t_handler, \
231  vl_noop_handler, \
232  vl_api_##n##_t_endian, \
233  vl_api_##n##_t_print, \
234  sizeof(vl_api_##n##_t), 1);
236 #undef _
237 
238  /*
239  * Set up the (msg_name, crc, message-id) table
240  */
242 
243  return 0;
244 }
245 
247 
248 /*
249  * fd.io coding-style-patch-verification: ON
250  *
251  * Local Variables:
252  * eval: (c-set-style "gnu")
253  * End:
254  */
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
#define REPLY_MACRO2(t, body)
#define NULL
Definition: clib.h:55
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
unsigned long u64
Definition: types.h:89
static void vl_api_modify_vhost_user_if_t_handler(vl_api_modify_vhost_user_if_t *mp)
static void vl_api_create_vhost_user_if_t_handler(vl_api_create_vhost_user_if_t *mp)
void * vl_msg_api_alloc(int nbytes)
int vhost_user_delete_if(vnet_main_t *vnm, vlib_main_t *vm, u32 sw_if_index)
Definition: vhost-user.c:2644
#define foreach_vpe_api_msg
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:3082
static void setup_message_id_table(api_main_t *am)
static void send_sw_interface_event_deleted(vpe_api_main_t *am, unix_shared_memory_queue_t *q, u32 sw_if_index)
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:198
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:2861
api_main_t api_main
Definition: api_shared.c:35
vlib_main_t * vm
Definition: buffer.c:283
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:336
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:2919
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
#define ARRAY_LEN(x)
Definition: clib.h:59
vhost-user interface modify request
Definition: vhost_user.api:55
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
unsigned int u32
Definition: types.h:88
static void vnet_set_sw_interface_tag(vnet_main_t *vnm, u8 *tag, u32 sw_if_index)
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
Interface Event generated by want_interface_events.
Definition: interface.api:41
unsigned char u8
Definition: types.h:56
#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: interface_api.c:49
static void vl_api_sw_interface_vhost_user_dump_t_handler(vl_api_sw_interface_vhost_user_dump_t *mp)
struct _unix_shared_memory_queue unix_shared_memory_queue_t
static void send_sw_interface_vhost_user_details(vpe_api_main_t *am, unix_shared_memory_queue_t *q, vhost_user_intf_details_t *vui, u32 context)