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 <vnet/format_fns.h>
  34 #include <memif/memif.api_enum.h>
  35 #include <memif/memif.api_types.h>
  36 #include <vpp/api/vpe.api_types.h>
  37 //#include <vnet/ethernet/ethernet_types.api_types.h>
  38
  39 typedef struct
  40 {
  41   /* API message ID base */
  42   u16 msg_id_base;
  43   u32 ping_id;
  44   vat_main_t *vat_main;
  45 } memif_test_main_t;
  46
  47 memif_test_main_t memif_test_main;
  48
  49 static uword
  50 unformat_memif_queues (unformat_input_t * input, va_list * args)
  51 {
  52   u32 *rx_queues = va_arg (*args, u32 *);
  53   u32 *tx_queues = va_arg (*args, u32 *);
  54
  55   if (unformat (input, "rx-queues %u", rx_queues))
  56     ;
  57   if (unformat (input, "tx-queues %u", tx_queues))
  58     ;
  59
  60   return 1;
  61 }
  62
  63 /* memif_socket_filename_add_del API */
  64 static int
  65 api_memif_socket_filename_add_del (vat_main_t * vam)
  66 {
  67   unformat_input_t *i = vam->input;
  68   vl_api_memif_socket_filename_add_del_t *mp;
  69   u8 is_add;
  70   u32 socket_id;
  71   u8 *socket_filename;
  72   int ret;
  73
  74   is_add = 1;
  75   socket_id = ~0;
  76   socket_filename = 0;
  77
  78   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
  79     {
  80       if (unformat (i, "id %u", &socket_id))
  81         ;
  82       else if (unformat (i, "filename %s", &socket_filename))
  83         ;
  84       else if (unformat (i, "del"))
  85         is_add = 0;
  86       else if (unformat (i, "add"))
  87         is_add = 1;
  88       else
  89         {
  90           vec_free (socket_filename);
  91           clib_warning ("unknown input `%U'", format_unformat_error, i);
  92           return -99;
  93         }
  94     }
  95
  96   if (socket_id == 0 || socket_id == ~0)
  97     {
  98       vec_free (socket_filename);
  99       errmsg ("Invalid socket id");
 100       return -99;
 101     }
 102
 103   if (is_add && (!socket_filename || *socket_filename == 0))
 104     {
 105       vec_free (socket_filename);
 106       errmsg ("Invalid socket filename");
 107       return -99;
 108     }
 109
 110   M2 (MEMIF_SOCKET_FILENAME_ADD_DEL, mp, strlen ((char *) socket_filename));
 111
 112   mp->is_add = is_add;
 113   mp->socket_id = htonl (socket_id);
 114   char *p = (char *) &mp->socket_filename;
 115   p +=
 116     vl_api_to_api_string (strlen ((char *) socket_filename),
 117                           (char *) socket_filename, (vl_api_string_t *) p);
 118
 119   vec_free (socket_filename);
 120
 121   S (mp);
 122   W (ret);
 123
 124   return ret;
 125 }
 126
 127 /* memif_socket_filename_add_del reply handler */
 128 #define VL_API_MEMIF_SOCKET_FILENAME_ADD_DEL_REPLY_T_HANLDER
 129 static void vl_api_memif_socket_filename_add_del_reply_t_handler
 130   (vl_api_memif_socket_filename_add_del_reply_t * mp)
 131 {
 132   vat_main_t *vam = memif_test_main.vat_main;
 133   i32 retval = ntohl (mp->retval);
 134
 135   vam->retval = retval;
 136   vam->result_ready = 1;
 137   vam->regenerate_interface_table = 1;
 138 }
 139
 140 /* memif-create API */
 141 static int
 142 api_memif_create (vat_main_t * vam)
 143 {
 144   unformat_input_t *i = vam->input;
 145   vl_api_memif_create_t *mp;
 146   u32 id = 0;
 147   u32 socket_id = 0;
 148   u8 *secret = 0;
 149   u8 role = 1;
 150   u32 ring_size = 0;
 151   u32 buffer_size = 0;
 152   u8 hw_addr[6] = { 0 };
 153   u32 rx_queues = MEMIF_DEFAULT_RX_QUEUES;
 154   u32 tx_queues = MEMIF_DEFAULT_TX_QUEUES;
 155   int ret;
 156   u8 mode = MEMIF_INTERFACE_MODE_ETHERNET;
 157
 158   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 159     {
 160       if (unformat (i, "id %u", &id))
 161         ;
 162       else if (unformat (i, "socket-id %u", &socket_id))
 163         ;
 164       else if (unformat (i, "secret %s", &secret))
 165         ;
 166       else if (unformat (i, "ring_size %u", &ring_size))
 167         ;
 168       else if (unformat (i, "buffer_size %u", &buffer_size))
 169         ;
 170       else if (unformat (i, "master"))
 171         role = 0;
 172       else if (unformat (i, "slave %U",
 173                          unformat_memif_queues, &rx_queues, &tx_queues))
 174         role = 1;
 175       else if (unformat (i, "mode ip"))
 176         mode = MEMIF_INTERFACE_MODE_IP;
 177       else if (unformat (i, "hw_addr %U", unformat_ethernet_address, hw_addr))
 178         ;
 179       else
 180         {
 181           clib_warning ("unknown input '%U'", format_unformat_error, i);
 182           return -99;
 183         }
 184     }
 185
 186   if (socket_id == ~0)
 187     {
 188       errmsg ("invalid socket-id\n");
 189       return -99;
 190     }
 191
 192   if (!is_pow2 (ring_size))
 193     {
 194       errmsg ("ring size must be power of 2\n");
 195       return -99;
 196     }
 197
 198   if (rx_queues > 255 || rx_queues < 1)
 199     {
 200       errmsg ("rx queue must be between 1 - 255\n");
 201       return -99;
 202     }
 203
 204   if (tx_queues > 255 || tx_queues < 1)
 205     {
 206       errmsg ("tx queue must be between 1 - 255\n");
 207       return -99;
 208     }
 209
 210   M2 (MEMIF_CREATE, mp, strlen ((char *) secret));
 211
 212   mp->mode = mode;
 213   mp->id = clib_host_to_net_u32 (id);
 214   mp->role = role;
 215   mp->ring_size = clib_host_to_net_u32 (ring_size);
 216   mp->buffer_size = clib_host_to_net_u16 (buffer_size & 0xffff);
 217   mp->socket_id = clib_host_to_net_u32 (socket_id);
 218   if (secret != 0)
 219     {
 220       char *p = (char *) &mp->secret;
 221       p += vl_api_to_api_string (strlen ((char *) secret), (char *) secret,
 222                                  (vl_api_string_t *) p);
 223       vec_free (secret);
 224     }
 225   memcpy (mp->hw_addr, hw_addr, 6);
 226   mp->rx_queues = rx_queues;
 227   mp->tx_queues = tx_queues;
 228
 229   S (mp);
 230   W (ret);
 231   return ret;
 232 }
 233
 234 /* memif-create reply handler */
 235 static void vl_api_memif_create_reply_t_handler
 236   (vl_api_memif_create_reply_t * mp)
 237 {
 238   vat_main_t *vam = memif_test_main.vat_main;
 239   i32 retval = ntohl (mp->retval);
 240
 241   if (retval == 0)
 242     {
 243       fformat (vam->ofp, "created memif with sw_if_index %d\n",
 244                ntohl (mp->sw_if_index));
 245     }
 246
 247   vam->retval = retval;
 248   vam->result_ready = 1;
 249   vam->regenerate_interface_table = 1;
 250 }
 251
 252 /* memif-delete API */
 253 static int
 254 api_memif_delete (vat_main_t * vam)
 255 {
 256   unformat_input_t *i = vam->input;
 257   vl_api_memif_delete_t *mp;
 258   u32 sw_if_index = 0;
 259   u8 index_defined = 0;
 260   int ret;
 261
 262   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 263     {
 264       if (unformat (i, "sw_if_index %u", &sw_if_index))
 265         index_defined = 1;
 266       else
 267         {
 268           clib_warning ("unknown input '%U'", format_unformat_error, i);
 269           return -99;
 270         }
 271     }
 272
 273   if (!index_defined)
 274     {
 275       errmsg ("missing sw_if_index\n");
 276       return -99;
 277     }
 278
 279   M (MEMIF_DELETE, mp);
 280
 281   mp->sw_if_index = clib_host_to_net_u32 (sw_if_index);
 282
 283   S (mp);
 284   W (ret);
 285   return ret;
 286 }
 287
 288 /* memif-dump API */
 289 static int
 290 api_memif_dump (vat_main_t * vam)
 291 {
 292   memif_test_main_t *mm = &memif_test_main;
 293   vl_api_memif_dump_t *mp;
 294   vl_api_control_ping_t *mp_ping;
 295   int ret;
 296
 297   if (vam->json_output)
 298     {
 299       clib_warning ("JSON output not supported for memif_dump");
 300       return -99;
 301     }
 302
 303   M (MEMIF_DUMP, mp);
 304   S (mp);
 305
 306   /* Use a control ping for synchronization */
 307   mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
 308   mp_ping->_vl_msg_id = htons (mm->ping_id);
 309   mp_ping->client_index = vam->my_client_index;
 310
 311   fformat (vam->ofp, "Sending ping id=%d\n", mm->ping_id);
 312
 313   vam->result_ready = 0;
 314   S (mp_ping);
 315
 316   W (ret);
 317   return ret;
 318 }
 319
 320 /* memif-details message handler */
 321 static void
 322 vl_api_memif_details_t_handler (vl_api_memif_details_t * mp)
 323 {
 324   vat_main_t *vam = memif_test_main.vat_main;
 325
 326   fformat (vam->ofp, "%s: sw_if_index %u mac %U\n"
 327            "   id %u socket-id %u role %s\n"
 328            "   ring_size %u buffer_size %u\n"
 329            "   state %s link %s\n",
 330            mp->if_name, ntohl (mp->sw_if_index), format_ethernet_address,
 331            mp->hw_addr, clib_net_to_host_u32 (mp->id),
 332            clib_net_to_host_u32 (mp->socket_id),
 333            mp->role ? "slave" : "master",
 334            ntohl (mp->ring_size), ntohs (mp->buffer_size),
 335            (mp->flags & IF_STATUS_API_FLAG_ADMIN_UP) ? "up" : "down",
 336            (mp->flags & IF_STATUS_API_FLAG_LINK_UP) ? "up" : "down");
 337 }
 338
 339 /* memif_socket_filename_dump API */
 340 static int
 341 api_memif_socket_filename_dump (vat_main_t * vam)
 342 {
 343   memif_test_main_t *mm = &memif_test_main;
 344   vl_api_memif_socket_filename_dump_t *mp;
 345   vl_api_control_ping_t *mp_ping;
 346   int ret;
 347
 348   if (vam->json_output)
 349     {
 350       clib_warning
 351         ("JSON output not supported for memif_socket_filename_dump");
 352       return -99;
 353     }
 354
 355   M (MEMIF_SOCKET_FILENAME_DUMP, mp);
 356   S (mp);
 357
 358   /* Use a control ping for synchronization */
 359   mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
 360   mp_ping->_vl_msg_id = htons (mm->ping_id);
 361   mp_ping->client_index = vam->my_client_index;
 362
 363   fformat (vam->ofp, "Sending ping id=%d\n", mm->ping_id);
 364
 365   vam->result_ready = 0;
 366   S (mp_ping);
 367
 368   W (ret);
 369   return ret;
 370 }
 371
 372 /* memif_socket_format_details message handler */
 373 static void vl_api_memif_socket_filename_details_t_handler
 374   (vl_api_memif_socket_filename_details_t * mp)
 375 {
 376   vat_main_t *vam = memif_test_main.vat_main;
 377
 378   fformat (vam->ofp,
 379            "id %u : filename %s\n",
 380            ntohl (mp->socket_id), mp->socket_filename);
 381 }
 382
 383 #include <memif/memif.api_test.c>
 384
 385 /*
 386  * fd.io coding-style-patch-verification: ON
 387  *
 388  * Local Variables:
 389  * eval: (c-set-style "gnu")
 390  * End:
 391  */