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 _(MEMIF_SOCKET_FILENAME_DETAILS, memif_socket_filename_details) \
 102 _(MEMIF_SOCKET_FILENAME_ADD_DEL_REPLY, memif_socket_filename_add_del_reply)
 103
 104 static uword
 105 unformat_memif_queues (unformat_input_t * input, va_list * args)
 106 {
 107   u32 *rx_queues = va_arg (*args, u32 *);
 108   u32 *tx_queues = va_arg (*args, u32 *);
 109
 110   if (unformat (input, "rx-queues %u", rx_queues))
 111     ;
 112   if (unformat (input, "tx-queues %u", tx_queues))
 113     ;
 114
 115   return 1;
 116 }
 117
 118 /* memif_socket_filename_add_del API */
 119 static int
 120 api_memif_socket_filename_add_del (vat_main_t * vam)
 121 {
 122   unformat_input_t *i = vam->input;
 123   vl_api_memif_socket_filename_add_del_t *mp;
 124   u8 is_add;
 125   u32 socket_id;
 126   u8 *socket_filename;
 127   int ret;
 128
 129   is_add = 1;
 130   socket_id = ~0;
 131   socket_filename = 0;
 132
 133   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 134     {
 135       if (unformat (i, "id %u", &socket_id))
 136         ;
 137       else if (unformat (i, "filename %s", &socket_filename))
 138         ;
 139       else if (unformat (i, "del"))
 140         is_add = 0;
 141       else if (unformat (i, "add"))
 142         is_add = 1;
 143       else
 144         {
 145           vec_free (socket_filename);
 146           clib_warning ("unknown input `%U'", format_unformat_error, i);
 147           return -99;
 148         }
 149     }
 150
 151   if (socket_id == 0 || socket_id == ~0)
 152     {
 153       vec_free (socket_filename);
 154       errmsg ("Invalid socket id");
 155       return -99;
 156     }
 157
 158   if (is_add && (!socket_filename || *socket_filename == 0))
 159     {
 160       vec_free (socket_filename);
 161       errmsg ("Invalid socket filename");
 162       return -99;
 163     }
 164
 165   M (MEMIF_SOCKET_FILENAME_ADD_DEL, mp);
 166
 167   memset (mp, 0, sizeof (*mp));
 168   mp->is_add = is_add;
 169   mp->socket_id = htonl (socket_id);
 170   memcpy (mp->socket_filename,
 171           socket_filename, sizeof (mp->socket_filename) - 1);
 172
 173   vec_free (socket_filename);
 174
 175   S (mp);
 176   W (ret);
 177
 178   return ret;
 179 }
 180
 181 /* memif_socket_filename_add_del reply handler */
 182 static void vl_api_memif_socket_filename_add_del_reply_t_handler
 183   (vl_api_memif_socket_filename_add_del_reply_t * mp)
 184 {
 185   vat_main_t *vam = memif_test_main.vat_main;
 186   i32 retval = ntohl (mp->retval);
 187
 188   vam->retval = retval;
 189   vam->result_ready = 1;
 190   vam->regenerate_interface_table = 1;
 191 }
 192
 193 /* memif-create API */
 194 static int
 195 api_memif_create (vat_main_t * vam)
 196 {
 197   unformat_input_t *i = vam->input;
 198   vl_api_memif_create_t *mp;
 199   u32 id = 0;
 200   u32 socket_id = 0;
 201   u8 *secret = 0;
 202   u8 role = 1;
 203   u32 ring_size = 0;
 204   u32 buffer_size = 0;
 205   u8 hw_addr[6] = { 0 };
 206   u32 rx_queues = MEMIF_DEFAULT_RX_QUEUES;
 207   u32 tx_queues = MEMIF_DEFAULT_TX_QUEUES;
 208   int ret;
 209   u8 mode = MEMIF_INTERFACE_MODE_ETHERNET;
 210
 211   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 212     {
 213       if (unformat (i, "id %u", &id))
 214         ;
 215       else if (unformat (i, "socket-id %u", &socket_id))
 216         ;
 217       else if (unformat (i, "secret %s", &secret))
 218         ;
 219       else if (unformat (i, "ring_size %u", &ring_size))
 220         ;
 221       else if (unformat (i, "buffer_size %u", &buffer_size))
 222         ;
 223       else if (unformat (i, "master"))
 224         role = 0;
 225       else if (unformat (i, "slave %U",
 226                          unformat_memif_queues, &rx_queues, &tx_queues))
 227         role = 1;
 228       else if (unformat (i, "mode ip"))
 229         mode = MEMIF_INTERFACE_MODE_IP;
 230       else if (unformat (i, "hw_addr %U", unformat_ethernet_address, hw_addr))
 231         ;
 232       else
 233         {
 234           clib_warning ("unknown input '%U'", format_unformat_error, i);
 235           return -99;
 236         }
 237     }
 238
 239   if (socket_id == ~0)
 240     {
 241       errmsg ("invalid socket-id\n");
 242       return -99;
 243     }
 244
 245   if (!is_pow2 (ring_size))
 246     {
 247       errmsg ("ring size must be power of 2\n");
 248       return -99;
 249     }
 250
 251   if (rx_queues > 255 || rx_queues < 1)
 252     {
 253       errmsg ("rx queue must be between 1 - 255\n");
 254       return -99;
 255     }
 256
 257   if (tx_queues > 255 || tx_queues < 1)
 258     {
 259       errmsg ("tx queue must be between 1 - 255\n");
 260       return -99;
 261     }
 262
 263   M (MEMIF_CREATE, mp);
 264
 265   mp->mode = mode;
 266   mp->id = clib_host_to_net_u32 (id);
 267   mp->role = role;
 268   mp->ring_size = clib_host_to_net_u32 (ring_size);
 269   mp->buffer_size = clib_host_to_net_u16 (buffer_size & 0xffff);
 270   mp->socket_id = clib_host_to_net_u32 (socket_id);
 271   if (secret != 0)
 272     {
 273       strncpy ((char *) mp->secret, (char *) secret, 16);
 274       vec_free (secret);
 275     }
 276   memcpy (mp->hw_addr, hw_addr, 6);
 277   mp->rx_queues = rx_queues;
 278   mp->tx_queues = tx_queues;
 279
 280   S (mp);
 281   W (ret);
 282   return ret;
 283 }
 284
 285 /* memif-create reply handler */
 286 static void vl_api_memif_create_reply_t_handler
 287   (vl_api_memif_create_reply_t * mp)
 288 {
 289   vat_main_t *vam = memif_test_main.vat_main;
 290   i32 retval = ntohl (mp->retval);
 291
 292   if (retval == 0)
 293     {
 294       fformat (vam->ofp, "created memif with sw_if_index %d\n",
 295                ntohl (mp->sw_if_index));
 296     }
 297
 298   vam->retval = retval;
 299   vam->result_ready = 1;
 300   vam->regenerate_interface_table = 1;
 301 }
 302
 303 /* memif-delete API */
 304 static int
 305 api_memif_delete (vat_main_t * vam)
 306 {
 307   unformat_input_t *i = vam->input;
 308   vl_api_memif_delete_t *mp;
 309   u32 sw_if_index = 0;
 310   u8 index_defined = 0;
 311   int ret;
 312
 313   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 314     {
 315       if (unformat (i, "sw_if_index %u", &sw_if_index))
 316         index_defined = 1;
 317       else
 318         {
 319           clib_warning ("unknown input '%U'", format_unformat_error, i);
 320           return -99;
 321         }
 322     }
 323
 324   if (!index_defined)
 325     {
 326       errmsg ("missing sw_if_index\n");
 327       return -99;
 328     }
 329
 330   M (MEMIF_DELETE, mp);
 331
 332   mp->sw_if_index = clib_host_to_net_u32 (sw_if_index);
 333
 334   S (mp);
 335   W (ret);
 336   return ret;
 337 }
 338
 339 /* memif-dump API */
 340 static int
 341 api_memif_dump (vat_main_t * vam)
 342 {
 343   memif_test_main_t *mm = &memif_test_main;
 344   vl_api_memif_dump_t *mp;
 345   vl_api_control_ping_t *mp_ping;
 346   int ret;
 347
 348   if (vam->json_output)
 349     {
 350       clib_warning ("JSON output not supported for memif_dump");
 351       return -99;
 352     }
 353
 354   M (MEMIF_DUMP, mp);
 355   S (mp);
 356
 357   /* Use a control ping for synchronization */
 358   mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
 359   mp_ping->_vl_msg_id = htons (mm->ping_id);
 360   mp_ping->client_index = vam->my_client_index;
 361
 362   fformat (vam->ofp, "Sending ping id=%d\n", mm->ping_id);
 363
 364   vam->result_ready = 0;
 365   S (mp_ping);
 366
 367   W (ret);
 368   return ret;
 369 }
 370
 371 /* memif-details message handler */
 372 static void
 373 vl_api_memif_details_t_handler (vl_api_memif_details_t * mp)
 374 {
 375   vat_main_t *vam = memif_test_main.vat_main;
 376
 377   fformat (vam->ofp, "%s: sw_if_index %u mac %U\n"
 378            "   id %u socket-id %u role %s\n"
 379            "   ring_size %u buffer_size %u\n"
 380            "   state %s link %s\n",
 381            mp->if_name, ntohl (mp->sw_if_index), format_ethernet_address,
 382            mp->hw_addr, clib_net_to_host_u32 (mp->id),
 383            clib_net_to_host_u32 (mp->socket_id),
 384            mp->role ? "slave" : "master",
 385            ntohl (mp->ring_size), ntohs (mp->buffer_size),
 386            mp->admin_up_down ? "up" : "down",
 387            mp->link_up_down ? "up" : "down");
 388 }
 389
 390 /* memif_socket_filename_dump API */
 391 static int
 392 api_memif_socket_filename_dump (vat_main_t * vam)
 393 {
 394   memif_test_main_t *mm = &memif_test_main;
 395   vl_api_memif_socket_filename_dump_t *mp;
 396   vl_api_control_ping_t *mp_ping;
 397   int ret;
 398
 399   if (vam->json_output)
 400     {
 401       clib_warning
 402         ("JSON output not supported for memif_socket_filename_dump");
 403       return -99;
 404     }
 405
 406   M (MEMIF_SOCKET_FILENAME_DUMP, mp);
 407   S (mp);
 408
 409   /* Use a control ping for synchronization */
 410   mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
 411   mp_ping->_vl_msg_id = htons (mm->ping_id);
 412   mp_ping->client_index = vam->my_client_index;
 413
 414   fformat (vam->ofp, "Sending ping id=%d\n", mm->ping_id);
 415
 416   vam->result_ready = 0;
 417   S (mp_ping);
 418
 419   W (ret);
 420   return ret;
 421 }
 422
 423 /* memif_socket_format_details message handler */
 424 static void vl_api_memif_socket_filename_details_t_handler
 425   (vl_api_memif_socket_filename_details_t * mp)
 426 {
 427   vat_main_t *vam = memif_test_main.vat_main;
 428
 429   fformat (vam->ofp,
 430            "id %u : filename %s\n",
 431            ntohl (mp->socket_id), mp->socket_filename);
 432 }
 433
 434 /*
 435  * List of messages that the api test plugin sends,
 436  * and that the data plane plugin processes
 437  */
 438 #define foreach_vpe_api_msg                                       \
 439 _(memif_create, "[id <id>] [socket-id <id>] [ring_size <size>] " \
 440                 "[buffer_size <size>] [hw_addr <mac_address>] "   \
 441                 "[secret <string>] [mode ip] <master|slave>")     \
 442 _(memif_delete, "<sw_if_index>")                                  \
 443 _(memif_dump, "")                                                 \
 444 _(memif_socket_filename_dump, "")                               \
 445 _(memif_socket_filename_add_del, "[add|del] id <id> filename <file>")
 446
 447 static void
 448 memif_vat_api_hookup (vat_main_t * vam)
 449 {
 450   memif_test_main_t *mm __attribute__ ((unused)) = &memif_test_main;
 451   /* Hook up handlers for replies from the data plane plug-in */
 452 #define _(N,n)                                                  \
 453   vl_msg_api_set_handlers((VL_API_##N + mm->msg_id_base),       \
 454                           #n,                                   \
 455                           vl_api_##n##_t_handler,               \
 456                           vl_noop_handler,                      \
 457                           vl_api_##n##_t_endian,                \
 458                           vl_api_##n##_t_print,                 \
 459                           sizeof(vl_api_##n##_t), 1);
 460   foreach_vpe_api_reply_msg;
 461 #undef _
 462
 463   /* API messages we can send */
 464 #define _(n,h)                                          \
 465   hash_set_mem (vam->function_by_name, #n, api_##n);
 466   foreach_vpe_api_msg;
 467 #undef _
 468
 469   /* Help strings */
 470 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
 471   foreach_vpe_api_msg;
 472 #undef _
 473 }
 474
 475 clib_error_t *
 476 vat_plugin_register (vat_main_t * vam)
 477 {
 478   memif_test_main_t *mm = &memif_test_main;
 479   u8 *name;
 480
 481   mm->vat_main = vam;
 482
 483   /* Ask the vpp engine for the first assigned message-id */
 484   name = format (0, "memif_%08x%c", api_version, 0);
 485   mm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
 486
 487   /* Get the control ping ID */
 488 #define _(id,n,crc) \
 489   const char *id ## _CRC __attribute__ ((unused)) = #n "_" #crc;
 490   foreach_vl_msg_name_crc_vpe;
 491 #undef _
 492   mm->ping_id = vl_msg_api_get_msg_index ((u8 *) (VL_API_CONTROL_PING_CRC));
 493
 494   if (mm->msg_id_base != (u16) ~ 0)
 495     memif_vat_api_hookup (vam);
 496
 497   vec_free (name);
 498
 499   return 0;
 500 }
 501
 502 /*
 503  * fd.io coding-style-patch-verification: ON
 504  *
 505  * Local Variables:
 506  * eval: (c-set-style "gnu")
 507  * End:
 508  */