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