src/plugins/vhost/vhost_user_api.c

   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>
  25 #include <vhost/vhost_user.h>
  26 #include <vnet/ethernet/ethernet.h>
  27 #include <vnet/ethernet/ethernet_types_api.h>
  28
  29 #include <vnet/format_fns.h>
  30 #include <vhost/vhost_user.api_enum.h>
  31 #include <vhost/vhost_user.api_types.h>
  32
  33 #define REPLY_MSG_ID_BASE msg_id_base
  34 #include <vlibapi/api_helper_macros.h>
  35
  36 static u16 msg_id_base;
  37
  38 static void
  39 vl_api_create_vhost_user_if_t_handler (vl_api_create_vhost_user_if_t * mp)
  40 {
  41   int rv = 0;
  42   vl_api_create_vhost_user_if_reply_t *rmp;
  43   vnet_main_t *vnm = vnet_get_main ();
  44   vlib_main_t *vm = vlib_get_main ();
  45   u64 disabled_features = (u64) (0ULL);
  46   vhost_user_create_if_args_t args = { 0 };
  47
  48   args.sw_if_index = (u32) ~ 0;
  49   args.feature_mask = (u64) ~ (0ULL);
  50   if (mp->disable_mrg_rxbuf)
  51     disabled_features = VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);
  52
  53   if (mp->disable_indirect_desc)
  54     disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
  55
  56   /*
  57    * GSO and PACKED are not supported by feature mask via binary API. We
  58    * disable GSO and PACKED feature in the feature mask. They may be enabled
  59    * explicitly via enable_gso and enable_packed argument
  60    */
  61   disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
  62     VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
  63
  64   /* EVENT_IDX is disabled by default */
  65   disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
  66   args.feature_mask &= ~disabled_features;
  67
  68   if (mp->use_custom_mac)
  69     mac_address_decode (mp->mac_address, (mac_address_t *) args.hwaddr);
  70
  71   args.use_custom_mac = mp->use_custom_mac;
  72   args.is_server = mp->is_server;
  73   args.sock_filename = (char *) mp->sock_filename;
  74   args.renumber = mp->renumber;
  75   args.custom_dev_instance = ntohl (mp->custom_dev_instance);
  76   args.enable_gso = mp->enable_gso;
  77   args.enable_packed = mp->enable_packed;
  78   rv = vhost_user_create_if (vnm, vm, &args);
  79
  80   /* Remember an interface tag for the new interface */
  81   if (rv == 0)
  82     {
  83       /* If a tag was supplied... */
  84       if (mp->tag[0])
  85         {
  86           /* Make sure it's a proper C-string */
  87           mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
  88           u8 *tag = format (0, "%s%c", mp->tag, 0);
  89           vnet_set_sw_interface_tag (vnm, tag, args.sw_if_index);
  90         }
  91     }
  92
  93   REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_REPLY,
  94   ({
  95     rmp->sw_if_index = ntohl (args.sw_if_index);
  96   }));
  97 }
  98
  99 static void
 100 vl_api_modify_vhost_user_if_t_handler (vl_api_modify_vhost_user_if_t * mp)
 101 {
 102   int rv = 0;
 103   vl_api_modify_vhost_user_if_reply_t *rmp;
 104   u64 disabled_features = (u64) (0ULL);
 105   vhost_user_create_if_args_t args = { 0 };
 106   vnet_main_t *vnm = vnet_get_main ();
 107   vlib_main_t *vm = vlib_get_main ();
 108
 109   args.feature_mask = (u64) ~ (0ULL);
 110   /*
 111    * GSO and PACKED are not supported by feature mask via binary API. We
 112    * disable GSO and PACKED feature in the feature mask. They may be enabled
 113    * explicitly via enable_gso and enable_packed argument
 114    */
 115   disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
 116     VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
 117
 118   /* EVENT_IDX is disabled by default */
 119   disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
 120   args.feature_mask &= ~disabled_features;
 121
 122   args.sw_if_index = ntohl (mp->sw_if_index);
 123   args.sock_filename = (char *) mp->sock_filename;
 124   args.is_server = mp->is_server;
 125   args.renumber = mp->renumber;
 126   args.custom_dev_instance = ntohl (mp->custom_dev_instance);
 127   args.enable_gso = mp->enable_gso;
 128   args.enable_packed = mp->enable_packed;
 129   rv = vhost_user_modify_if (vnm, vm, &args);
 130
 131   REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_REPLY);
 132 }
 133
 134 static void
 135 vl_api_create_vhost_user_if_v2_t_handler (vl_api_create_vhost_user_if_v2_t *
 136                                           mp)
 137 {
 138   int rv = 0;
 139   vl_api_create_vhost_user_if_v2_reply_t *rmp;
 140   vnet_main_t *vnm = vnet_get_main ();
 141   vlib_main_t *vm = vlib_get_main ();
 142   u64 disabled_features = (u64) (0ULL);
 143   vhost_user_create_if_args_t args = { 0 };
 144
 145   args.sw_if_index = (u32) ~ 0;
 146   args.feature_mask = (u64) ~ (0ULL);
 147   if (mp->disable_mrg_rxbuf)
 148     disabled_features = VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);
 149
 150   if (mp->disable_indirect_desc)
 151     disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
 152
 153   /*
 154    * GSO and PACKED are not supported by feature mask via binary API. We
 155    * disable GSO and PACKED feature in the feature mask. They may be enabled
 156    * explicitly via enable_gso and enable_packed argument
 157    */
 158   disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
 159     VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
 160
 161   /* EVENT_IDX is disabled by default */
 162   disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
 163   args.feature_mask &= ~disabled_features;
 164
 165   if (mp->use_custom_mac)
 166     mac_address_decode (mp->mac_address, (mac_address_t *) args.hwaddr);
 167
 168   args.use_custom_mac = mp->use_custom_mac;
 169   args.is_server = mp->is_server;
 170   args.sock_filename = (char *) mp->sock_filename;
 171   args.renumber = mp->renumber;
 172   args.custom_dev_instance = ntohl (mp->custom_dev_instance);
 173   args.enable_gso = mp->enable_gso;
 174   args.enable_packed = mp->enable_packed;
 175   args.enable_event_idx = mp->enable_event_idx;
 176   rv = vhost_user_create_if (vnm, vm, &args);
 177
 178   /* Remember an interface tag for the new interface */
 179   if (rv == 0)
 180     {
 181       /* If a tag was supplied... */
 182       if (mp->tag[0])
 183         {
 184           /* Make sure it's a proper C-string */
 185           mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
 186           u8 *tag = format (0, "%s%c", mp->tag, 0);
 187           vnet_set_sw_interface_tag (vnm, tag, args.sw_if_index);
 188         }
 189     }
 190
 191   REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_V2_REPLY,
 192   ({
 193     rmp->sw_if_index = ntohl (args.sw_if_index);
 194   }));
 195 }
 196
 197 static void
 198 vl_api_modify_vhost_user_if_v2_t_handler (vl_api_modify_vhost_user_if_v2_t *
 199                                           mp)
 200 {
 201   int rv = 0;
 202   vl_api_modify_vhost_user_if_v2_reply_t *rmp;
 203   u64 disabled_features = (u64) (0ULL);
 204   vhost_user_create_if_args_t args = { 0 };
 205   vnet_main_t *vnm = vnet_get_main ();
 206   vlib_main_t *vm = vlib_get_main ();
 207
 208   args.feature_mask = (u64) ~ (0ULL);
 209   /*
 210    * GSO and PACKED are not supported by feature mask via binary API. We
 211    * disable GSO and PACKED feature in the feature mask. They may be enabled
 212    * explicitly via enable_gso and enable_packed argument
 213    */
 214   disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
 215     VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);
 216
 217   /* EVENT_IDX is disabled by default */
 218   disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
 219   args.feature_mask &= ~disabled_features;
 220
 221   args.sw_if_index = ntohl (mp->sw_if_index);
 222   args.sock_filename = (char *) mp->sock_filename;
 223   args.is_server = mp->is_server;
 224   args.renumber = mp->renumber;
 225   args.custom_dev_instance = ntohl (mp->custom_dev_instance);
 226   args.enable_gso = mp->enable_gso;
 227   args.enable_packed = mp->enable_packed;
 228   args.enable_event_idx = mp->enable_event_idx;
 229   rv = vhost_user_modify_if (vnm, vm, &args);
 230
 231   REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_V2_REPLY);
 232 }
 233
 234 static void
 235 vl_api_delete_vhost_user_if_t_handler (vl_api_delete_vhost_user_if_t * mp)
 236 {
 237   int rv = 0;
 238   vl_api_delete_vhost_user_if_reply_t *rmp;
 239   u32 sw_if_index = ntohl (mp->sw_if_index);
 240   vl_api_registration_t *reg;
 241
 242   vnet_main_t *vnm = vnet_get_main ();
 243   vlib_main_t *vm = vlib_get_main ();
 244
 245   rv = vhost_user_delete_if (vnm, vm, sw_if_index);
 246
 247   REPLY_MACRO (VL_API_DELETE_VHOST_USER_IF_REPLY);
 248   if (!rv)
 249     {
 250       reg = vl_api_client_index_to_registration (mp->client_index);
 251       if (!reg)
 252         return;
 253
 254       vnet_clear_sw_interface_tag (vnm, sw_if_index);
 255     }
 256 }
 257
 258 static void
 259 vhost_user_features_encode (u64 features, u32 *first, u32 *last)
 260 {
 261   *first = clib_net_to_host_u32 (features);
 262   *last = clib_net_to_host_u32 (features >> 32);
 263 }
 264
 265 static void
 266 send_sw_interface_vhost_user_details (vpe_api_main_t * am,
 267                                       vl_api_registration_t * reg,
 268                                       vhost_user_intf_details_t * vui,
 269                                       u32 context)
 270 {
 271   vl_api_sw_interface_vhost_user_details_t *mp;
 272
 273   mp = vl_msg_api_alloc (sizeof (*mp));
 274   clib_memset (mp, 0, sizeof (*mp));
 275   mp->_vl_msg_id =
 276     ntohs (REPLY_MSG_ID_BASE + VL_API_SW_INTERFACE_VHOST_USER_DETAILS);
 277   mp->sw_if_index = ntohl (vui->sw_if_index);
 278   mp->virtio_net_hdr_sz = ntohl (vui->virtio_net_hdr_sz);
 279   vhost_user_features_encode (vui->features, (u32 *) &mp->features_first_32,
 280                               (u32 *) &mp->features_last_32);
 281   mp->is_server = vui->is_server;
 282   mp->num_regions = ntohl (vui->num_regions);
 283   mp->sock_errno = ntohl (vui->sock_errno);
 284   mp->context = context;
 285
 286   strncpy ((char *) mp->sock_filename,
 287            (char *) vui->sock_filename, ARRAY_LEN (mp->sock_filename) - 1);
 288   strncpy ((char *) mp->interface_name,
 289            (char *) vui->if_name, ARRAY_LEN (mp->interface_name) - 1);
 290
 291   vl_api_send_msg (reg, (u8 *) mp);
 292 }
 293
 294 static void
 295   vl_api_sw_interface_vhost_user_dump_t_handler
 296   (vl_api_sw_interface_vhost_user_dump_t * mp)
 297 {
 298   int rv = 0;
 299   vpe_api_main_t *am = &vpe_api_main;
 300   vnet_main_t *vnm = vnet_get_main ();
 301   vlib_main_t *vm = vlib_get_main ();
 302   vhost_user_intf_details_t *ifaces = NULL;
 303   vhost_user_intf_details_t *vuid = NULL;
 304   vl_api_registration_t *reg;
 305   u32 filter_sw_if_index;
 306
 307   reg = vl_api_client_index_to_registration (mp->client_index);
 308   if (!reg)
 309     return;
 310
 311   filter_sw_if_index = htonl (mp->sw_if_index);
 312   if (filter_sw_if_index != ~0)
 313     VALIDATE_SW_IF_INDEX (mp);
 314
 315   rv = vhost_user_dump_ifs (vnm, vm, &ifaces);
 316   if (rv)
 317     return;
 318
 319   vec_foreach (vuid, ifaces)
 320   {
 321     if ((filter_sw_if_index == ~0) ||
 322         (vuid->sw_if_index == filter_sw_if_index))
 323       send_sw_interface_vhost_user_details (am, reg, vuid, mp->context);
 324   }
 325   BAD_SW_IF_INDEX_LABEL;
 326   vec_free (ifaces);
 327 }
 328
 329 #include <vhost/vhost_user.api.c>
 330 static clib_error_t *
 331 vhost_user_api_hookup (vlib_main_t * vm)
 332 {
 333   api_main_t *am = vlibapi_get_main ();
 334
 335   /*
 336    * Set up the (msg_name, crc, message-id) table
 337    */
 338   REPLY_MSG_ID_BASE = setup_message_id_table ();
 339
 340   /* Mark CREATE_VHOST_USER_IF as mp safe */
 341   vl_api_set_msg_thread_safe (
 342     am, REPLY_MSG_ID_BASE + VL_API_CREATE_VHOST_USER_IF, 1);
 343   vl_api_set_msg_thread_safe (
 344     am, REPLY_MSG_ID_BASE + VL_API_CREATE_VHOST_USER_IF_V2, 1);
 345
 346   return 0;
 347 }
 348
 349 VLIB_API_INIT_FUNCTION (vhost_user_api_hookup);
 350
 351 /*
 352  * fd.io coding-style-patch-verification: ON
 353  *
 354  * Local Variables:
 355  * eval: (c-set-style "gnu")
 356  * End:
 357  */