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