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