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