aboutsummaryrefslogtreecommitdiffstats
path: root/src/vnet/devices/virtio/vhost_user_api.c
blob: 6dd9da08a23c2103a48fb681f988adde7476e58d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
/*
 *------------------------------------------------------------------
 * vhost-user_api.c - vhost-user api
 *
 * Copyright (c) 2016 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *------------------------------------------------------------------
 */

#include <vnet/vnet.h>
#include <vlibmemory/api.h>

#include <vnet/interface.h>
#include <vnet/api_errno.h>
#include <vnet/devices/virtio/vhost_user.h>
#include <vnet/ethernet/ethernet.h>
#include <vnet/ethernet/ethernet_types_api.h>
#include <vnet/devices/virtio/virtio_types_api.h>

#include <vnet/format_fns.h>
#include <vnet/devices/virtio/vhost_user.api_enum.h>
#include <vnet/devices/virtio/vhost_user.api_types.h>

#define REPLY_MSG_ID_BASE msg_id_base
#include <vlibapi/api_helper_macros.h>

static u16 msg_id_base;

static void
vl_api_create_vhost_user_if_t_handler (vl_api_create_vhost_user_if_t * mp)
{
  int rv = 0;
  vl_api_create_vhost_user_if_reply_t *rmp;
  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();
  u64 disabled_features = (u64) (0ULL);
  vhost_user_create_if_args_t args = { 0 };

  args.sw_if_index = (u32) ~ 0;
  args.feature_mask = (u64) ~ (0ULL);
  if (mp->disable_mrg_rxbuf)
    disabled_features = VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);

  if (mp->disable_indirect_desc)
    disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);

  /*
   * GSO and PACKED are not supported by feature mask via binary API. We
   * disable GSO and PACKED feature in the feature mask. They may be enabled
   * explicitly via enable_gso and enable_packed argument
   */
  disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
    VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);

  /* EVENT_IDX is disabled by default */
  disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
  args.feature_mask &= ~disabled_features;

  if (mp->use_custom_mac)
    mac_address_decode (mp->mac_address, (mac_address_t *) args.hwaddr);

  args.use_custom_mac = mp->use_custom_mac;
  args.is_server = mp->is_server;
  args.sock_filename = (char *) mp->sock_filename;
  args.renumber = mp->renumber;
  args.custom_dev_instance = ntohl (mp->custom_dev_instance);
  args.enable_gso = mp->enable_gso;
  args.enable_packed = mp->enable_packed;
  rv = vhost_user_create_if (vnm, vm, &args);

  /* Remember an interface tag for the new interface */
  if (rv == 0)
    {
      /* If a tag was supplied... */
      if (mp->tag[0])
	{
	  /* Make sure it's a proper C-string */
	  mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
	  u8 *tag = format (0, "%s%c", mp->tag, 0);
	  vnet_set_sw_interface_tag (vnm, tag, args.sw_if_index);
	}
    }

  /* *INDENT-OFF* */
  REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_REPLY,
  ({
    rmp->sw_if_index = ntohl (args.sw_if_index);
  }));
  /* *INDENT-ON* */
}

static void
vl_api_modify_vhost_user_if_t_handler (vl_api_modify_vhost_user_if_t * mp)
{
  int rv = 0;
  vl_api_modify_vhost_user_if_reply_t *rmp;
  u64 disabled_features = (u64) (0ULL);
  vhost_user_create_if_args_t args = { 0 };
  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();

  args.feature_mask = (u64) ~ (0ULL);
  /*
   * GSO and PACKED are not supported by feature mask via binary API. We
   * disable GSO and PACKED feature in the feature mask. They may be enabled
   * explicitly via enable_gso and enable_packed argument
   */
  disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
    VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);

  /* EVENT_IDX is disabled by default */
  disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
  args.feature_mask &= ~disabled_features;

  args.sw_if_index = ntohl (mp->sw_if_index);
  args.sock_filename = (char *) mp->sock_filename;
  args.is_server = mp->is_server;
  args.renumber = mp->renumber;
  args.custom_dev_instance = ntohl (mp->custom_dev_instance);
  args.enable_gso = mp->enable_gso;
  args.enable_packed = mp->enable_packed;
  rv = vhost_user_modify_if (vnm, vm, &args);

  REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_REPLY);
}

static void
vl_api_create_vhost_user_if_v2_t_handler (vl_api_create_vhost_user_if_v2_t *
					  mp)
{
  int rv = 0;
  vl_api_create_vhost_user_if_v2_reply_t *rmp;
  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();
  u64 disabled_features = (u64) (0ULL);
  vhost_user_create_if_args_t args = { 0 };

  args.sw_if_index = (u32) ~ 0;
  args.feature_mask = (u64) ~ (0ULL);
  if (mp->disable_mrg_rxbuf)
    disabled_features = VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);

  if (mp->disable_indirect_desc)
    disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);

  /*
   * GSO and PACKED are not supported by feature mask via binary API. We
   * disable GSO and PACKED feature in the feature mask. They may be enabled
   * explicitly via enable_gso and enable_packed argument
   */
  disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
    VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);

  /* EVENT_IDX is disabled by default */
  disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
  args.feature_mask &= ~disabled_features;

  if (mp->use_custom_mac)
    mac_address_decode (mp->mac_address, (mac_address_t *) args.hwaddr);

  args.use_custom_mac = mp->use_custom_mac;
  args.is_server = mp->is_server;
  args.sock_filename = (char *) mp->sock_filename;
  args.renumber = mp->renumber;
  args.custom_dev_instance = ntohl (mp->custom_dev_instance);
  args.enable_gso = mp->enable_gso;
  args.enable_packed = mp->enable_packed;
  args.enable_event_idx = mp->enable_event_idx;
  rv = vhost_user_create_if (vnm, vm, &args);

  /* Remember an interface tag for the new interface */
  if (rv == 0)
    {
      /* If a tag was supplied... */
      if (mp->tag[0])
	{
	  /* Make sure it's a proper C-string */
	  mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
	  u8 *tag = format (0, "%s%c", mp->tag, 0);
	  vnet_set_sw_interface_tag (vnm, tag, args.sw_if_index);
	}
    }

  /* *INDENT-OFF* */
  REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_V2_REPLY,
  ({
    rmp->sw_if_index = ntohl (args.sw_if_index);
  }));
  /* *INDENT-ON* */
}

static void
vl_api_modify_vhost_user_if_v2_t_handler (vl_api_modify_vhost_user_if_v2_t *
					  mp)
{
  int rv = 0;
  vl_api_modify_vhost_user_if_v2_reply_t *rmp;
  u64 disabled_features = (u64) (0ULL);
  vhost_user_create_if_args_t args = { 0 };
  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();

  args.feature_mask = (u64) ~ (0ULL);
  /*
   * GSO and PACKED are not supported by feature mask via binary API. We
   * disable GSO and PACKED feature in the feature mask. They may be enabled
   * explicitly via enable_gso and enable_packed argument
   */
  disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
    VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);

  /* EVENT_IDX is disabled by default */
  disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
  args.feature_mask &= ~disabled_features;

  args.sw_if_index = ntohl (mp->sw_if_index);
  args.sock_filename = (char *) mp->sock_filename;
  args.is_server = mp->is_server;
  args.renumber = mp->renumber;
  args.custom_dev_instance = ntohl (mp->custom_dev_instance);
  args.enable_gso = mp->enable_gso;
  args.enable_packed = mp->enable_packed;
  args.enable_event_idx = mp->enable_event_idx;
  rv = vhost_user_modify_if (vnm, vm, &args);

  REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_V2_REPLY);
}

static void
vl_api_delete_vhost_user_if_t_handler (vl_api_delete_vhost_user_if_t * mp)
{
  int rv = 0;
  vl_api_delete_vhost_user_if_reply_t *rmp;
  u32 sw_if_index = ntohl (mp->sw_if_index);
  vl_api_registration_t *reg;

  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();

  rv = vhost_user_delete_if (vnm, vm, sw_if_index);

  REPLY_MACRO (VL_API_DELETE_VHOST_USER_IF_REPLY);
  if (!rv)
    {
      reg = vl_api_client_index_to_registration (mp->client_index);
      if (!reg)
	return;

      vnet_clear_sw_interface_tag (vnm, 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)
{
  vl_api_sw_interface_vhost_user_details_t *mp;

  mp = vl_msg_api_alloc (sizeof (*mp));
  clib_memset (mp, 0, sizeof (*mp));
  mp->_vl_msg_id =
    ntohs (REPLY_MSG_ID_BASE + VL_API_SW_INTERFACE_VHOST_USER_DETAILS);
  mp->sw_if_index = ntohl (vui->sw_if_index);
  mp->virtio_net_hdr_sz = ntohl (vui->virtio_net_hdr_sz);
  virtio_features_encode (vui->features, (u32 *) & mp->features_first_32,
			  (u32 *) & mp->features_last_32);
  mp->is_server = vui->is_server;
  mp->num_regions = ntohl (vui->num_regions);
  mp->sock_errno = ntohl (vui->sock_errno);
  mp->context = context;

  strncpy ((char *) mp->sock_filename,
	   (char *) vui->sock_filename, ARRAY_LEN (mp->sock_filename) - 1);
  strncpy ((char *) mp->interface_name,
	   (char *) vui->if_name, ARRAY_LEN (mp->interface_name) - 1);

  vl_api_send_msg (reg, (u8 *) mp);
}

static void
  vl_api_sw_interface_vhost_user_dump_t_handler
  (vl_api_sw_interface_vhost_user_dump_t * mp)
{
  int rv = 0;
  vpe_api_main_t *am = &vpe_api_main;
  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();
  vhost_user_intf_details_t *ifaces = NULL;
  vhost_user_intf_details_t *vuid = NULL;
  vl_api_registration_t *reg;
  u32 filter_sw_if_index;

  reg = vl_api_client_index_to_registration (mp->client_index);
  if (!reg)
    return;

  filter_sw_if_index = htonl (mp->sw_if_index);
  if (filter_sw_if_index != ~0)
    VALIDATE_SW_IF_INDEX (mp);

  rv = vhost_user_dump_ifs (vnm, vm, &ifaces);
  if (rv)
    return;

  vec_foreach (vuid, ifaces)
  {
    if ((filter_sw_if_index == ~0) ||
	(vuid->sw_if_index == filter_sw_if_index))
      send_sw_interface_vhost_user_details (am, reg, vuid, mp->context);
  }
  BAD_SW_IF_INDEX_LABEL;
  vec_free (ifaces);
}

#include <vnet/devices/virtio/vhost_user.api.c>
static clib_error_t *
vhost_user_api_hookup (vlib_main_t * vm)
{
  api_main_t *am = vlibapi_get_main ();
  /* Mark CREATE_VHOST_USER_IF as mp safe */
  am->is_mp_safe[VL_API_CREATE_VHOST_USER_IF] = 1;
  am->is_mp_safe[VL_API_CREATE_VHOST_USER_IF_V2] = 1;

  /*
   * Set up the (msg_name, crc, message-id) table
   */
  REPLY_MSG_ID_BASE = setup_message_id_table ();

  return 0;
}

VLIB_API_INIT_FUNCTION (vhost_user_api_hookup);

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */