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