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_DUMP, memif_dump)                                \
  95
  96 /**
  97  * @brief Message handler for memif_create API.
  98  * @param mp vl_api_memif_create_t * mp the api message
  99  */
 100 void
 101 vl_api_memif_create_t_handler (vl_api_memif_create_t * mp)
 102 {
 103   memif_main_t *mm = &memif_main;
 104   vlib_main_t *vm = vlib_get_main ();
 105   vl_api_memif_create_reply_t *rmp;
 106   memif_create_if_args_t args = { 0 };
 107   u32 ring_size = MEMIF_DEFAULT_RING_SIZE;
 108   static const u8 empty_hw_addr[6];
 109   int rv = 0;
 110
 111   /* id */
 112   args.id = clib_net_to_host_u32 (mp->id);
 113
 114   /* socket filename */
 115   mp->socket_filename[ARRAY_LEN (mp->socket_filename) - 1] = 0;
 116   if (strlen ((char *) mp->socket_filename) > 0)
 117     {
 118       vec_validate (args.socket_filename,
 119                     strlen ((char *) mp->socket_filename));
 120       strncpy ((char *) args.socket_filename, (char *) mp->socket_filename,
 121                vec_len (args.socket_filename));
 122     }
 123
 124   /* secret */
 125   mp->secret[ARRAY_LEN (mp->secret) - 1] = 0;
 126   if (strlen ((char *) mp->secret) > 0)
 127     {
 128       vec_validate (args.secret, strlen ((char *) mp->secret));
 129       strncpy ((char *) args.secret, (char *) mp->secret,
 130                vec_len (args.secret));
 131     }
 132
 133   /* role */
 134   args.is_master = (mp->role == 0);
 135
 136   /* rx/tx queues */
 137   if (args.is_master == 0)
 138     {
 139       args.rx_queues = MEMIF_DEFAULT_RX_QUEUES;
 140       args.tx_queues = MEMIF_DEFAULT_TX_QUEUES;
 141       if (mp->rx_queues)
 142         {
 143           args.rx_queues = mp->rx_queues;
 144         }
 145       if (mp->tx_queues)
 146         {
 147           args.tx_queues = mp->tx_queues;
 148         }
 149     }
 150
 151   /* ring size */
 152   if (mp->ring_size)
 153     {
 154       ring_size = ntohl (mp->ring_size);
 155     }
 156   if (!is_pow2 (ring_size))
 157     {
 158       rv = VNET_API_ERROR_INVALID_ARGUMENT;
 159       goto reply;
 160     }
 161   args.log2_ring_size = min_log2 (ring_size);
 162
 163   /* buffer size */
 164   args.buffer_size = MEMIF_DEFAULT_BUFFER_SIZE;
 165   if (mp->buffer_size)
 166     {
 167       args.buffer_size = ntohs (mp->buffer_size);
 168     }
 169
 170   /* MAC address */
 171   if (memcmp (mp->hw_addr, empty_hw_addr, 6) != 0)
 172     {
 173       memcpy (args.hw_addr, mp->hw_addr, 6);
 174       args.hw_addr_set = 1;
 175     }
 176
 177   rv = memif_create_if (vm, &args);
 178
 179   vec_free (args.socket_filename);
 180   vec_free (args.secret);
 181
 182 reply:
 183   /* *INDENT-OFF* */
 184   REPLY_MACRO2 (VL_API_MEMIF_CREATE_REPLY,
 185     ({
 186        rmp->sw_if_index = htonl (args.sw_if_index);
 187     }));
 188   /* *INDENT-ON* */
 189 }
 190
 191 /**
 192  * @brief Message handler for memif_delete API.
 193  * @param mp vl_api_memif_delete_t * mp the api message
 194  */
 195 void
 196 vl_api_memif_delete_t_handler (vl_api_memif_delete_t * mp)
 197 {
 198   memif_main_t *mm = &memif_main;
 199   vlib_main_t *vm = vlib_get_main ();
 200   vnet_main_t *vnm = vnet_get_main ();
 201   vl_api_memif_delete_reply_t *rmp;
 202   vnet_hw_interface_t *hi =
 203     vnet_get_sup_hw_interface (vnm, ntohl (mp->sw_if_index));
 204   memif_if_t *mif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
 205   int rv = 0;
 206
 207   if (hi == NULL || memif_device_class.index != hi->dev_class_index)
 208     rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
 209   else
 210     rv = memif_delete_if (vm, mif);
 211
 212   REPLY_MACRO (VL_API_MEMIF_DELETE_REPLY);
 213 }
 214
 215 static void
 216 send_memif_details (unix_shared_memory_queue_t * q,
 217                     memif_if_t * mif,
 218                     vnet_sw_interface_t * swif,
 219                     u8 * interface_name, u32 context)
 220 {
 221   vl_api_memif_details_t *mp;
 222   vnet_main_t *vnm = vnet_get_main ();
 223   memif_main_t *mm = &memif_main;
 224   memif_socket_file_t *msf = vec_elt_at_index (mm->socket_files,
 225                                                mif->socket_file_index);
 226   vnet_hw_interface_t *hwif;
 227
 228   hwif = vnet_get_sup_hw_interface (vnm, swif->sw_if_index);
 229
 230   mp = vl_msg_api_alloc (sizeof (*mp));
 231   memset (mp, 0, sizeof (*mp));
 232
 233   mp->_vl_msg_id = htons (VL_API_MEMIF_DETAILS + mm->msg_id_base);
 234   mp->context = context;
 235
 236   mp->sw_if_index = htonl (swif->sw_if_index);
 237   strncpy ((char *) mp->if_name,
 238            (char *) interface_name, ARRAY_LEN (mp->if_name) - 1);
 239   memcpy (mp->hw_addr, hwif->hw_address, ARRAY_LEN (mp->hw_addr));
 240
 241   mp->id = clib_host_to_net_u32 (mif->id);
 242   mp->role = (mif->flags & MEMIF_IF_FLAG_IS_SLAVE) ? 1 : 0;
 243   strncpy ((char *) mp->socket_filename,
 244            (char *) msf->filename, ARRAY_LEN (mp->socket_filename) - 1);
 245
 246   mp->ring_size = htonl (1 << mif->run.log2_ring_size);
 247   mp->buffer_size = htons (mif->run.buffer_size);
 248
 249   mp->admin_up_down = (swif->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? 1 : 0;
 250   mp->link_up_down = (hwif->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ? 1 : 0;
 251
 252   vl_msg_api_send_shmem (q, (u8 *) & mp);
 253 }
 254
 255 /**
 256  * @brief Message handler for memif_dump API.
 257  * @param mp vl_api_memif_dump_t * mp the api message
 258  */
 259 void
 260 vl_api_memif_dump_t_handler (vl_api_memif_dump_t * mp)
 261 {
 262   memif_main_t *mm = &memif_main;
 263   vnet_main_t *vnm = vnet_get_main ();
 264   vnet_sw_interface_t *swif;
 265   memif_if_t *mif;
 266   u8 *if_name = 0;
 267   unix_shared_memory_queue_t *q;
 268
 269   q = vl_api_client_index_to_input_queue (mp->client_index);
 270   if (q == 0)
 271     return;
 272
 273   /* *INDENT-OFF* */
 274   pool_foreach (mif, mm->interfaces,
 275     ({
 276       swif = vnet_get_sw_interface (vnm, mif->sw_if_index);
 277
 278       if_name = format (if_name, "%U%c",
 279                         format_vnet_sw_interface_name,
 280                         vnm, swif, 0);
 281
 282       send_memif_details (q, mif, swif, if_name, mp->context);
 283       _vec_len (if_name) = 0;
 284     }));
 285   /* *INDENT-ON* */
 286
 287   vec_free (if_name);
 288 }
 289
 290 #define vl_msg_name_crc_list
 291 #include <memif/memif_all_api_h.h>
 292 #undef vl_msg_name_crc_list
 293
 294 static void
 295 setup_message_id_table (memif_main_t * mm, api_main_t * am)
 296 {
 297 #define _(id,n,crc) \
 298   vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + mm->msg_id_base);
 299   foreach_vl_msg_name_crc_memif;
 300 #undef _
 301 }
 302
 303 /* Set up the API message handling tables */
 304 clib_error_t *
 305 memif_plugin_api_hookup (vlib_main_t * vm)
 306 {
 307   memif_main_t *mm = &memif_main;
 308   api_main_t *am = &api_main;
 309   u8 *name;
 310
 311   /* Construct the API name */
 312   name = format (0, "memif_%08x%c", api_version, 0);
 313
 314   /* Ask for a correctly-sized block of API message decode slots */
 315   mm->msg_id_base = vl_msg_api_get_msg_ids
 316     ((char *) name, VL_MSG_FIRST_AVAILABLE);
 317
 318 #define _(N,n)                                                  \
 319     vl_msg_api_set_handlers((VL_API_##N + mm->msg_id_base),     \
 320                            #n,                                  \
 321                            vl_api_##n##_t_handler,              \
 322                            vl_noop_handler,                     \
 323                            vl_api_##n##_t_endian,               \
 324                            vl_api_##n##_t_print,                \
 325                            sizeof(vl_api_##n##_t), 1);
 326   foreach_memif_plugin_api_msg;
 327 #undef _
 328
 329   /*
 330    * Set up the (msg_name, crc, message-id) table
 331    */
 332   setup_message_id_table (mm, am);
 333
 334   vec_free (name);
 335   return 0;
 336 }
 337
 338 /*
 339  * fd.io coding-style-patch-verification: ON
 340  *
 341  * Local Variables:
 342  * eval: (c-set-style "gnu")
 343  * End:
 344  */