src/plugins/memif/memif_test.c

   1 /*
   2  * memif VAT support
   3  *
   4  * Copyright (c) 2017 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <inttypes.h>
  19
  20 #include <vat/vat.h>
  21 #include <vlibapi/api.h>
  22 #include <vlibmemory/api.h>
  23
  24 #include <vppinfra/error.h>
  25 #include <vnet/ip/ip.h>
  26 #include <memif/memif.h>
  27 #include <memif/private.h>
  28
  29 #define __plugin_msg_base memif_test_main.msg_id_base
  30 #include <vlibapi/vat_helper_macros.h>
  31
  32 /* declare message IDs */
  33 #include <memif/memif_msg_enum.h>
  34
  35 /* Get CRC codes of the messages defined outside of this plugin */
  36 #define vl_msg_name_crc_list
  37 #include <vpp/api/vpe_all_api_h.h>
  38 #undef vl_msg_name_crc_list
  39
  40 /* define message structures */
  41 #define vl_typedefs
  42 #include <vpp/api/vpe_all_api_h.h>
  43 #include <memif/memif_all_api_h.h>
  44 #undef vl_typedefs
  45
  46 /* declare message handlers for each api */
  47
  48 #define vl_endianfun            /* define message structures */
  49 #include <memif/memif_all_api_h.h>
  50 #undef vl_endianfun
  51
  52 /* instantiate all the print functions we know about */
  53 #define vl_print(handle, ...)
  54 #define vl_printfun
  55 #include <memif/memif_all_api_h.h>
  56 #undef vl_printfun
  57
  58 /* Get the API version number. */
  59 #define vl_api_version(n,v) static u32 api_version=(v);
  60 #include <memif/memif_all_api_h.h>
  61 #undef vl_api_version
  62
  63 typedef struct
  64 {
  65   /* API message ID base */
  66   u16 msg_id_base;
  67   u32 ping_id;
  68   vat_main_t *vat_main;
  69 } memif_test_main_t;
  70
  71 memif_test_main_t memif_test_main;
  72
  73 /* standard reply handlers */
  74 #define foreach_standard_reply_retval_handler           \
  75 _(memif_delete_reply)
  76
  77 #define _(n)                                            \
  78     static void vl_api_##n##_t_handler                  \
  79     (vl_api_##n##_t * mp)                               \
  80     {                                                   \
  81         vat_main_t * vam = memif_test_main.vat_main;    \
  82         i32 retval = ntohl(mp->retval);                 \
  83         if (vam->async_mode) {                          \
  84             vam->async_errors += (retval < 0);          \
  85         } else {                                        \
  86             vam->retval = retval;                       \
  87             vam->result_ready = 1;                      \
  88         }                                               \
  89     }
  90 foreach_standard_reply_retval_handler;
  91 #undef _
  92
  93 /*
  94  * Table of message reply handlers, must include boilerplate handlers
  95  * we just generated
  96  */
  97 #define foreach_vpe_api_reply_msg                       \
  98 _(MEMIF_CREATE_REPLY, memif_create_reply)               \
  99 _(MEMIF_DELETE_REPLY, memif_delete_reply)               \
 100 _(MEMIF_DETAILS, memif_details)
 101
 102 static uword
 103 unformat_memif_queues (unformat_input_t * input, va_list * args)
 104 {
 105   u32 *rx_queues = va_arg (*args, u32 *);
 106   u32 *tx_queues = va_arg (*args, u32 *);
 107
 108   if (unformat (input, "rx-queues %u", rx_queues))
 109     ;
 110   if (unformat (input, "tx-queues %u", tx_queues))
 111     ;
 112
 113   return 1;
 114 }
 115
 116 /* memif-create API */
 117 static int
 118 api_memif_create (vat_main_t * vam)
 119 {
 120   unformat_input_t *i = vam->input;
 121   vl_api_memif_create_t *mp;
 122   u32 id = 0;
 123   u8 *socket_filename = 0;
 124   u8 *secret = 0;
 125   u8 role = 1;
 126   u32 ring_size = 0;
 127   u32 buffer_size = 0;
 128   u8 hw_addr[6] = { 0 };
 129   u32 rx_queues = MEMIF_DEFAULT_RX_QUEUES;
 130   u32 tx_queues = MEMIF_DEFAULT_TX_QUEUES;
 131   int ret;
 132   u8 mode = MEMIF_INTERFACE_MODE_ETHERNET;
 133
 134   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 135     {
 136       if (unformat (i, "id %u", &id))
 137         ;
 138       else if (unformat (i, "socket %s", &socket_filename))
 139         ;
 140       else if (unformat (i, "secret %s", &secret))
 141         ;
 142       else if (unformat (i, "ring_size %u", &ring_size))
 143         ;
 144       else if (unformat (i, "buffer_size %u", &buffer_size))
 145         ;
 146       else if (unformat (i, "master"))
 147         role = 0;
 148       else if (unformat (i, "slave %U",
 149                          unformat_memif_queues, &rx_queues, &tx_queues))
 150         role = 1;
 151       else if (unformat (i, "mode ip"))
 152         mode = MEMIF_INTERFACE_MODE_IP;
 153       else if (unformat (i, "hw_addr %U", unformat_ethernet_address, hw_addr))
 154         ;
 155       else
 156         {
 157           clib_warning ("unknown input '%U'", format_unformat_error, i);
 158           return -99;
 159         }
 160     }
 161
 162   if (!is_pow2 (ring_size))
 163     {
 164       errmsg ("ring size must be power of 2\n");
 165       return -99;
 166     }
 167
 168   if (rx_queues > 255 || rx_queues < 1)
 169     {
 170       errmsg ("rx queue must be between 1 - 255\n");
 171       return -99;
 172     }
 173
 174   if (tx_queues > 255 || tx_queues < 1)
 175     {
 176       errmsg ("tx queue must be between 1 - 255\n");
 177       return -99;
 178     }
 179
 180   M (MEMIF_CREATE, mp);
 181
 182   mp->mode = mode;
 183   mp->id = clib_host_to_net_u32 (id);
 184   mp->role = role;
 185   mp->ring_size = clib_host_to_net_u32 (ring_size);
 186   mp->buffer_size = clib_host_to_net_u16 (buffer_size & 0xffff);
 187   if (socket_filename != 0)
 188     {
 189       strncpy ((char *) mp->socket_filename, (char *) socket_filename, 127);
 190       vec_free (socket_filename);
 191     }
 192   if (secret != 0)
 193     {
 194       strncpy ((char *) mp->secret, (char *) secret, 16);
 195       vec_free (secret);
 196     }
 197   memcpy (mp->hw_addr, hw_addr, 6);
 198   mp->rx_queues = rx_queues;
 199   mp->tx_queues = tx_queues;
 200
 201   S (mp);
 202   W (ret);
 203   return ret;
 204 }
 205
 206 /* memif-create reply handler */
 207 static void vl_api_memif_create_reply_t_handler
 208   (vl_api_memif_create_reply_t * mp)
 209 {
 210   vat_main_t *vam = memif_test_main.vat_main;
 211   i32 retval = ntohl (mp->retval);
 212
 213   if (retval == 0)
 214     {
 215       fformat (vam->ofp, "created memif with sw_if_index %d\n",
 216                ntohl (mp->sw_if_index));
 217     }
 218
 219   vam->retval = retval;
 220   vam->result_ready = 1;
 221   vam->regenerate_interface_table = 1;
 222 }
 223
 224 /* memif-delete API */
 225 static int
 226 api_memif_delete (vat_main_t * vam)
 227 {
 228   unformat_input_t *i = vam->input;
 229   vl_api_memif_delete_t *mp;
 230   u32 sw_if_index = 0;
 231   u8 index_defined = 0;
 232   int ret;
 233
 234   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 235     {
 236       if (unformat (i, "sw_if_index %u", &sw_if_index))
 237         index_defined = 1;
 238       else
 239         {
 240           clib_warning ("unknown input '%U'", format_unformat_error, i);
 241           return -99;
 242         }
 243     }
 244
 245   if (!index_defined)
 246     {
 247       errmsg ("missing sw_if_index\n");
 248       return -99;
 249     }
 250
 251   M (MEMIF_DELETE, mp);
 252
 253   mp->sw_if_index = clib_host_to_net_u32 (sw_if_index);
 254
 255   S (mp);
 256   W (ret);
 257   return ret;
 258 }
 259
 260 /* memif-dump API */
 261 static int
 262 api_memif_dump (vat_main_t * vam)
 263 {
 264   memif_test_main_t *mm = &memif_test_main;
 265   vl_api_memif_dump_t *mp;
 266   vl_api_control_ping_t *mp_ping;
 267   int ret;
 268
 269   if (vam->json_output)
 270     {
 271       clib_warning ("JSON output not supported for memif_dump");
 272       return -99;
 273     }
 274
 275   M (MEMIF_DUMP, mp);
 276   S (mp);
 277
 278   /* Use a control ping for synchronization */
 279   mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
 280   mp_ping->_vl_msg_id = htons (mm->ping_id);
 281   mp_ping->client_index = vam->my_client_index;
 282
 283   fformat (vam->ofp, "Sending ping id=%d\n", mm->ping_id);
 284
 285   vam->result_ready = 0;
 286   S (mp_ping);
 287
 288   W (ret);
 289   return ret;
 290 }
 291
 292 /* memif-details message handler */
 293 static void vl_api_memif_details_t_handler (vl_api_memif_details_t * mp)
 294 {
 295   vat_main_t *vam = memif_test_main.vat_main;
 296
 297   fformat (vam->ofp, "%s: sw_if_index %u mac %U\n"
 298            "   id %u socket %s role %s\n"
 299            "   ring_size %u buffer_size %u\n"
 300            "   state %s link %s\n",
 301            mp->if_name, ntohl (mp->sw_if_index), format_ethernet_address,
 302            mp->hw_addr, clib_net_to_host_u32 (mp->id), mp->socket_filename,
 303            mp->role ? "slave" : "master",
 304            ntohl (mp->ring_size), ntohs (mp->buffer_size),
 305            mp->admin_up_down ? "up" : "down",
 306            mp->link_up_down ? "up" : "down");
 307 }
 308
 309 /*
 310  * List of messages that the api test plugin sends,
 311  * and that the data plane plugin processes
 312  */
 313 #define foreach_vpe_api_msg                                       \
 314 _(memif_create, "[id <id>] [socket <path>] [ring_size <size>] " \
 315                 "[buffer_size <size>] [hw_addr <mac_address>] "   \
 316                 "[secret <string>] [mode ip] <master|slave>")     \
 317 _(memif_delete, "<sw_if_index>")                                  \
 318 _(memif_dump, "")
 319
 320 static void
 321 memif_vat_api_hookup (vat_main_t * vam)
 322 {
 323   memif_test_main_t *mm __attribute__ ((unused)) = &memif_test_main;
 324   /* Hook up handlers for replies from the data plane plug-in */
 325 #define _(N,n)                                                  \
 326   vl_msg_api_set_handlers((VL_API_##N + mm->msg_id_base),       \
 327                           #n,                                   \
 328                           vl_api_##n##_t_handler,               \
 329                           vl_noop_handler,                      \
 330                           vl_api_##n##_t_endian,                \
 331                           vl_api_##n##_t_print,                 \
 332                           sizeof(vl_api_##n##_t), 1);
 333   foreach_vpe_api_reply_msg;
 334 #undef _
 335
 336   /* API messages we can send */
 337 #define _(n,h)                                          \
 338   hash_set_mem (vam->function_by_name, #n, api_##n);
 339   foreach_vpe_api_msg;
 340 #undef _
 341
 342   /* Help strings */
 343 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
 344   foreach_vpe_api_msg;
 345 #undef _
 346 }
 347
 348 clib_error_t *
 349 vat_plugin_register (vat_main_t * vam)
 350 {
 351   memif_test_main_t *mm = &memif_test_main;
 352   u8 *name;
 353
 354   mm->vat_main = vam;
 355
 356   /* Ask the vpp engine for the first assigned message-id */
 357   name = format (0, "memif_%08x%c", api_version, 0);
 358   mm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
 359
 360   /* Get the control ping ID */
 361 #define _(id,n,crc) \
 362   const char *id ## _CRC __attribute__ ((unused)) = #n "_" #crc;
 363   foreach_vl_msg_name_crc_vpe;
 364 #undef _
 365   mm->ping_id = vl_msg_api_get_msg_index ((u8 *) (VL_API_CONTROL_PING_CRC));
 366
 367   if (mm->msg_id_base != (u16) ~0)
 368     memif_vat_api_hookup (vam);
 369
 370   vec_free (name);
 371
 372   return 0;
 373 }