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
  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
  43 #include <vlibapi/api_helper_macros.h>
  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 static void
  52 vl_api_create_vhost_user_if_t_handler (vl_api_create_vhost_user_if_t * mp)
  53 {
  54   int rv = 0;
  55   vl_api_create_vhost_user_if_reply_t *rmp;
  56   u32 sw_if_index = (u32) ~ 0;
  57   vnet_main_t *vnm = vnet_get_main ();
  58   vlib_main_t *vm = vlib_get_main ();
  59   u64 features = (u64) ~ (0ULL);
  60   u64 disabled_features = (u64) (0ULL);
  61
  62   if (mp->disable_mrg_rxbuf)
  63     disabled_features = (1ULL << FEAT_VIRTIO_NET_F_MRG_RXBUF);
  64
  65   if (mp->disable_indirect_desc)
  66     disabled_features |= (1ULL << FEAT_VIRTIO_F_INDIRECT_DESC);
  67
  68   /*
  69    * feature mask is not supported via binary API. We disable GSO feature in the
  70    * feature mask. It may be enabled via enable_gso argument.
  71    */
  72   disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS;
  73   features &= ~disabled_features;
  74
  75   rv = vhost_user_create_if (vnm, vm, (char *) mp->sock_filename,
  76                              mp->is_server, &sw_if_index, features,
  77                              mp->renumber, ntohl (mp->custom_dev_instance),
  78                              (mp->use_custom_mac) ? mp->mac_address : NULL,
  79                              mp->enable_gso);
  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, 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 (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   u32 sw_if_index = ntohl (mp->sw_if_index);
 108   u64 features = (u64) ~ (0ULL);
 109   u64 disabled_features = (u64) (0ULL);
 110
 111   vnet_main_t *vnm = vnet_get_main ();
 112   vlib_main_t *vm = vlib_get_main ();
 113
 114   /*
 115    * feature mask is not supported via binary API. We disable GSO feature in the
 116    * feature mask. It may be enabled via enable_gso argument.
 117    */
 118   disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS;
 119   features &= ~disabled_features;
 120
 121   rv = vhost_user_modify_if (vnm, vm, (char *) mp->sock_filename,
 122                              mp->is_server, sw_if_index, features,
 123                              mp->renumber, ntohl (mp->custom_dev_instance),
 124                              mp->enable_gso);
 125
 126   REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_REPLY);
 127 }
 128
 129 static void
 130 vl_api_delete_vhost_user_if_t_handler (vl_api_delete_vhost_user_if_t * mp)
 131 {
 132   int rv = 0;
 133   vl_api_delete_vhost_user_if_reply_t *rmp;
 134   u32 sw_if_index = ntohl (mp->sw_if_index);
 135   vl_api_registration_t *reg;
 136
 137   vnet_main_t *vnm = vnet_get_main ();
 138   vlib_main_t *vm = vlib_get_main ();
 139
 140   rv = vhost_user_delete_if (vnm, vm, sw_if_index);
 141
 142   REPLY_MACRO (VL_API_DELETE_VHOST_USER_IF_REPLY);
 143   if (!rv)
 144     {
 145       reg = vl_api_client_index_to_registration (mp->client_index);
 146       if (!reg)
 147         return;
 148
 149       vnet_clear_sw_interface_tag (vnm, sw_if_index);
 150     }
 151 }
 152
 153 static void
 154 send_sw_interface_vhost_user_details (vpe_api_main_t * am,
 155                                       vl_api_registration_t * reg,
 156                                       vhost_user_intf_details_t * vui,
 157                                       u32 context)
 158 {
 159   vl_api_sw_interface_vhost_user_details_t *mp;
 160
 161   mp = vl_msg_api_alloc (sizeof (*mp));
 162   clib_memset (mp, 0, sizeof (*mp));
 163   mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_VHOST_USER_DETAILS);
 164   mp->sw_if_index = ntohl (vui->sw_if_index);
 165   mp->virtio_net_hdr_sz = ntohl (vui->virtio_net_hdr_sz);
 166   mp->features = clib_net_to_host_u64 (vui->features);
 167   mp->is_server = vui->is_server;
 168   mp->num_regions = ntohl (vui->num_regions);
 169   mp->sock_errno = ntohl (vui->sock_errno);
 170   mp->context = context;
 171
 172   strncpy ((char *) mp->sock_filename,
 173            (char *) vui->sock_filename, ARRAY_LEN (mp->sock_filename) - 1);
 174   strncpy ((char *) mp->interface_name,
 175            (char *) vui->if_name, ARRAY_LEN (mp->interface_name) - 1);
 176
 177   vl_api_send_msg (reg, (u8 *) mp);
 178 }
 179
 180 static void
 181   vl_api_sw_interface_vhost_user_dump_t_handler
 182   (vl_api_sw_interface_vhost_user_dump_t * mp)
 183 {
 184   int rv = 0;
 185   vpe_api_main_t *am = &vpe_api_main;
 186   vnet_main_t *vnm = vnet_get_main ();
 187   vlib_main_t *vm = vlib_get_main ();
 188   vhost_user_intf_details_t *ifaces = NULL;
 189   vhost_user_intf_details_t *vuid = NULL;
 190   vl_api_registration_t *reg;
 191
 192   reg = vl_api_client_index_to_registration (mp->client_index);
 193   if (!reg)
 194     return;
 195
 196   rv = vhost_user_dump_ifs (vnm, vm, &ifaces);
 197   if (rv)
 198     return;
 199
 200   vec_foreach (vuid, ifaces)
 201   {
 202     send_sw_interface_vhost_user_details (am, reg, vuid, mp->context);
 203   }
 204   vec_free (ifaces);
 205 }
 206
 207 /*
 208  * vhost-user_api_hookup
 209  * Add vpe's API message handlers to the table.
 210  * vlib has already mapped shared memory and
 211  * added the client registration handlers.
 212  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
 213  */
 214 #define vl_msg_name_crc_list
 215 #include <vnet/vnet_all_api_h.h>
 216 #undef vl_msg_name_crc_list
 217
 218 static void
 219 setup_message_id_table (api_main_t * am)
 220 {
 221 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
 222   foreach_vl_msg_name_crc_vhost_user;
 223 #undef _
 224 }
 225
 226 static clib_error_t *
 227 vhost_user_api_hookup (vlib_main_t * vm)
 228 {
 229   api_main_t *am = &api_main;
 230
 231 #define _(N,n)                                                  \
 232     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
 233                            vl_api_##n##_t_handler,              \
 234                            vl_noop_handler,                     \
 235                            vl_api_##n##_t_endian,               \
 236                            vl_api_##n##_t_print,                \
 237                            sizeof(vl_api_##n##_t), 1);
 238   foreach_vpe_api_msg;
 239 #undef _
 240
 241   /* Mark CREATE_VHOST_USER_IF as mp safe */
 242   am->is_mp_safe[VL_API_CREATE_VHOST_USER_IF] = 1;
 243
 244   /*
 245    * Set up the (msg_name, crc, message-id) table
 246    */
 247   setup_message_id_table (am);
 248
 249   return 0;
 250 }
 251
 252 VLIB_API_INIT_FUNCTION (vhost_user_api_hookup);
 253
 254 /*
 255  * fd.io coding-style-patch-verification: ON
 256  *
 257  * Local Variables:
 258  * eval: (c-set-style "gnu")
 259  * End:
 260  */