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