src/plugins/memif/memif_api.c

   1 /*
   2  *------------------------------------------------------------------
   3  * memif_api.c - memif api
   4  *
   5  * Copyright (c) 2017 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 <vlib/vlib.h>
  21 #include <vnet/ethernet/ethernet.h>
  22 #include <vlib/unix/unix.h>
  23 #include <memif/memif.h>
  24 #include <memif/private.h>
  25
  26 #include <vlibapi/api.h>
  27 #include <vlibmemory/api.h>
  28 #include <vlibsocket/api.h>
  29
  30 /* define message IDs */
  31 #include <memif/memif_msg_enum.h>
  32
  33 /* define message structures */
  34 #define vl_typedefs
  35 #include <memif/memif_all_api_h.h>
  36 #undef vl_typedefs
  37
  38 /* define generated endian-swappers */
  39 #define vl_endianfun
  40 #include <memif/memif_all_api_h.h>
  41 #undef vl_endianfun
  42
  43 /* instantiate all the print functions we know about */
  44 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  45 #define vl_printfun
  46 #include <memif/memif_all_api_h.h>
  47 #undef vl_printfun
  48
  49 /* Get the API version number */
  50 #define vl_api_version(n,v) static u32 api_version=(v);
  51 #include <memif/memif_all_api_h.h>
  52 #undef vl_api_version
  53
  54 /*
  55  * A handy macro to set up a message reply.
  56  * Assumes that the following variables are available:
  57  * mp - pointer to request message
  58  * rmp - pointer to reply message type
  59  * rv - return value
  60  */
  61 #define REPLY_MACRO(t)                                          \
  62 do {                                                            \
  63     unix_shared_memory_queue_t * q =                            \
  64     vl_api_client_index_to_input_queue (mp->client_index);      \
  65     if (!q)                                                     \
  66         return;                                                 \
  67                                                                 \
  68     rmp = vl_msg_api_alloc (sizeof (*rmp));                     \
  69     rmp->_vl_msg_id = htons ((t)+mm->msg_id_base);              \
  70     rmp->context = mp->context;                                 \
  71     rmp->retval = htonl (rv);                                   \
  72                                                                 \
  73     vl_msg_api_send_shmem (q, (u8 *)&rmp);                      \
  74 } while(0);
  75
  76 #define REPLY_MACRO2(t, body)                                   \
  77 do {                                                            \
  78     unix_shared_memory_queue_t * q =                            \
  79     vl_api_client_index_to_input_queue (mp->client_index);      \
  80     if (!q)                                                     \
  81         return;                                                 \
  82                                                                 \
  83     rmp = vl_msg_api_alloc (sizeof (*rmp));                     \
  84     rmp->_vl_msg_id = htons ((t)+mm->msg_id_base);              \
  85     rmp->context = mp->context;                                 \
  86     rmp->retval = htonl (rv);                                   \
  87     do {body;} while (0);                                       \
  88     vl_msg_api_send_shmem (q, (u8 *)&rmp);                      \
  89 } while(0);
  90
  91 #define foreach_memif_plugin_api_msg                     \
  92 _(MEMIF_CREATE, memif_create)                            \
  93 _(MEMIF_DELETE, memif_delete)                            \
  94 _(MEMIF_DETAILS, memif_details)                          \
  95 _(MEMIF_DUMP, memif_dump)                                \
  96
  97 /**
  98  * @brief Message handler for memif_create API.
  99  * @param mp vl_api_memif_create_t * mp the api message
 100  */
 101 void
 102 vl_api_memif_create_t_handler (vl_api_memif_create_t * mp)
 103 {
 104   memif_main_t *mm = &memif_main;
 105   vlib_main_t *vm = vlib_get_main ();
 106   vl_api_memif_create_reply_t *rmp;
 107   memif_create_if_args_t args = { 0 };
 108   u32 ring_size = MEMIF_DEFAULT_RING_SIZE;
 109   static const u8 empty_hw_addr[6];
 110   int rv = 0;
 111
 112   /* id */
 113   args.id = clib_net_to_host_u32 (mp->id);
 114
 115   /* socket filename */
 116   mp->socket_filename[ARRAY_LEN (mp->socket_filename) - 1] = 0;
 117   if (strlen ((char *) mp->socket_filename) > 0)
 118     {
 119       vec_validate (args.socket_filename,
 120                     strlen ((char *) mp->socket_filename));
 121       strncpy ((char *) args.socket_filename, (char *) mp->socket_filename,
 122                vec_len (args.socket_filename));
 123     }
 124
 125   /* secret */
 126   mp->secret[ARRAY_LEN (mp->secret) - 1] = 0;
 127   if (strlen ((char *) mp->secret) > 0)
 128     {
 129       vec_validate (args.secret, strlen ((char *) mp->secret));
 130       strncpy ((char *) args.secret, (char *) mp->secret,
 131                vec_len (args.secret));
 132     }
 133
 134   /* role */
 135   args.is_master = (mp->role == 0);
 136   if (args.is_master == 0)
 137     {
 138       args.rx_queues = mp->rx_queues;
 139       args.tx_queues = mp->tx_queues;
 140     }
 141
 142   /* ring size */
 143   if (mp->ring_size)
 144     {
 145       ring_size = ntohl (mp->ring_size);
 146     }
 147   if (!is_pow2 (ring_size))
 148     {
 149       rv = VNET_API_ERROR_INVALID_ARGUMENT;
 150       goto reply;
 151     }
 152   args.log2_ring_size = min_log2 (ring_size);
 153
 154   /* buffer size */
 155   args.buffer_size = MEMIF_DEFAULT_BUFFER_SIZE;
 156   if (mp->buffer_size)
 157     {
 158       args.buffer_size = ntohs (mp->buffer_size);
 159     }
 160
 161   /* MAC address */
 162   if (memcmp (mp->hw_addr, empty_hw_addr, 6) != 0)
 163     {
 164       memcpy (args.hw_addr, mp->hw_addr, 6);
 165       args.hw_addr_set = 1;
 166     }
 167
 168   rv = memif_create_if (vm, &args);
 169
 170   vec_free (args.socket_filename);
 171   vec_free (args.secret);
 172
 173 reply:
 174   /* *INDENT-OFF* */
 175   REPLY_MACRO2 (VL_API_MEMIF_CREATE_REPLY,
 176     ({
 177        rmp->sw_if_index = htonl (args.sw_if_index);
 178     }));
 179   /* *INDENT-ON* */
 180 }
 181
 182 /**
 183  * @brief Message handler for memif_delete API.
 184  * @param mp vl_api_memif_delete_t * mp the api message
 185  */
 186 void
 187 vl_api_memif_delete_t_handler (vl_api_memif_delete_t * mp)
 188 {
 189   memif_main_t *mm = &memif_main;
 190   vlib_main_t *vm = vlib_get_main ();
 191   vnet_main_t *vnm = vnet_get_main ();
 192   vl_api_memif_delete_reply_t *rmp;
 193   vnet_hw_interface_t *hi =
 194     vnet_get_sup_hw_interface (vnm, ntohl (mp->sw_if_index));
 195   memif_if_t *mif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
 196   int rv = 0;
 197
 198   if (hi == NULL || memif_device_class.index != hi->dev_class_index)
 199     rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
 200   else
 201     rv = memif_delete_if (vm, mif);
 202
 203   REPLY_MACRO (VL_API_MEMIF_DELETE_REPLY);
 204 }
 205
 206 static void
 207 send_memif_details (unix_shared_memory_queue_t * q,
 208                     memif_if_t * mif,
 209                     vnet_sw_interface_t * swif,
 210                     u8 * interface_name, u32 context)
 211 {
 212   vl_api_memif_details_t *mp;
 213   vnet_main_t *vnm = vnet_get_main ();
 214   memif_main_t *mm = &memif_main;
 215   memif_socket_file_t *msf = vec_elt_at_index (mm->socket_files,
 216                                                mif->socket_file_index);
 217   vnet_hw_interface_t *hwif;
 218
 219   hwif = vnet_get_sup_hw_interface (vnm, swif->sw_if_index);
 220
 221   mp = vl_msg_api_alloc (sizeof (*mp));
 222   memset (mp, 0, sizeof (*mp));
 223
 224   mp->_vl_msg_id = htons (VL_API_MEMIF_DETAILS + mm->msg_id_base);
 225   mp->context = context;
 226
 227   mp->sw_if_index = htonl (swif->sw_if_index);
 228   strncpy ((char *) mp->if_name,
 229            (char *) interface_name, ARRAY_LEN (mp->if_name) - 1);
 230   memcpy (mp->hw_addr, hwif->hw_address, ARRAY_LEN (mp->hw_addr));
 231
 232   mp->id = clib_host_to_net_u32 (mif->id);
 233   mp->role = (mif->flags & MEMIF_IF_FLAG_IS_SLAVE) ? 1 : 0;
 234   strncpy ((char *) mp->socket_filename,
 235            (char *) msf->filename, ARRAY_LEN (mp->socket_filename) - 1);
 236
 237   mp->ring_size = htonl (1 << mif->run.log2_ring_size);
 238   mp->buffer_size = htons (mif->run.buffer_size);
 239
 240   mp->admin_up_down = (swif->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? 1 : 0;
 241   mp->link_up_down = (hwif->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ? 1 : 0;
 242
 243   vl_msg_api_send_shmem (q, (u8 *) & mp);
 244 }
 245
 246 /**
 247  * @brief Message handler for memif_dump API.
 248  * @param mp vl_api_memif_dump_t * mp the api message
 249  */
 250 void
 251 vl_api_memif_dump_t_handler (vl_api_memif_dump_t * mp)
 252 {
 253   memif_main_t *mm = &memif_main;
 254   vnet_main_t *vnm = vnet_get_main ();
 255   vnet_sw_interface_t *swif;
 256   memif_if_t *mif;
 257   u8 *if_name = 0;
 258   unix_shared_memory_queue_t *q;
 259
 260   q = vl_api_client_index_to_input_queue (mp->client_index);
 261   if (q == 0)
 262     return;
 263
 264   /* *INDENT-OFF* */
 265   pool_foreach (mif, mm->interfaces,
 266     ({
 267       swif = vnet_get_sw_interface (vnm, mif->sw_if_index);
 268
 269       if_name = format (if_name, "%U%c",
 270                         format_vnet_sw_interface_name,
 271                         vnm, swif, 0);
 272
 273       send_memif_details (q, mif, swif, if_name, mp->context);
 274       _vec_len (if_name) = 0;
 275     }));
 276   /* *INDENT-ON* */
 277
 278   vec_free (if_name);
 279 }
 280
 281 /**
 282  * @brief Message handler for memif_details API.
 283  * @param mp vl_api_memif_details_t * mp the api message
 284  */
 285 void
 286 vl_api_memif_details_t_handler (vl_api_memif_details_t * mp)
 287 {
 288   clib_warning ("BUG");
 289 }
 290
 291 #define vl_msg_name_crc_list
 292 #include <memif/memif_all_api_h.h>
 293 #undef vl_msg_name_crc_list
 294
 295 static void
 296 setup_message_id_table (memif_main_t * mm, api_main_t * am)
 297 {
 298 #define _(id,n,crc) \
 299   vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + mm->msg_id_base);
 300   foreach_vl_msg_name_crc_memif;
 301 #undef _
 302 }
 303
 304 /* Set up the API message handling tables */
 305 clib_error_t *
 306 memif_plugin_api_hookup (vlib_main_t * vm)
 307 {
 308   memif_main_t *mm = &memif_main;
 309   api_main_t *am = &api_main;
 310   u8 *name;
 311
 312   /* Construct the API name */
 313   name = format (0, "memif_%08x%c", api_version, 0);
 314
 315   /* Ask for a correctly-sized block of API message decode slots */
 316   mm->msg_id_base = vl_msg_api_get_msg_ids
 317     ((char *) name, VL_MSG_FIRST_AVAILABLE);
 318
 319 #define _(N,n)                                                  \
 320     vl_msg_api_set_handlers((VL_API_##N + mm->msg_id_base),     \
 321                            #n,                                  \
 322                            vl_api_##n##_t_handler,              \
 323                            vl_noop_handler,                     \
 324                            vl_api_##n##_t_endian,               \
 325                            vl_api_##n##_t_print,                \
 326                            sizeof(vl_api_##n##_t), 1);
 327   foreach_memif_plugin_api_msg;
 328 #undef _
 329
 330   /*
 331    * Set up the (msg_name, crc, message-id) table
 332    */
 333   setup_message_id_table (mm, am);
 334
 335   vec_free (name);
 336   return 0;
 337 }
 338
 339 /*
 340  * fd.io coding-style-patch-verification: ON
 341  *
 342  * Local Variables:
 343  * eval: (c-set-style "gnu")
 344  * End:
 345  */