src/plugins/vmxnet3/vmxnet3_test.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2018 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #include <vlib/vlib.h>
  19 #include <vlib/unix/unix.h>
  20 #include <vlib/pci/pci.h>
  21 #include <vnet/ethernet/ethernet.h>
  22
  23 #include <vat/vat.h>
  24 #include <vlibapi/api.h>
  25 #include <vlibmemory/api.h>
  26
  27 #include <vppinfra/error.h>
  28 #include <vmxnet3/vmxnet3.h>
  29
  30 #define __plugin_msg_base vmxnet3_test_main.msg_id_base
  31 #include <vlibapi/vat_helper_macros.h>
  32
  33 /* declare message IDs */
  34 #include <vmxnet3/vmxnet3_msg_enum.h>
  35
  36 /* Get CRC codes of the messages defined outside of this plugin */
  37 #define vl_msg_name_crc_list
  38 #include <vpp/api/vpe_all_api_h.h>
  39 #undef vl_msg_name_crc_list
  40
  41 /* define message structures */
  42 #define vl_typedefs
  43 #include <vpp/api/vpe_all_api_h.h>
  44 #include <vmxnet3/vmxnet3_all_api_h.h>
  45 #undef vl_typedefs
  46
  47 /* declare message handlers for each api */
  48 #define vl_endianfun
  49 #include <vmxnet3/vmxnet3_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 <vmxnet3/vmxnet3_all_api_h.h>
  56 #undef vl_printfun
  57
  58 /* get API version number */
  59 #define vl_api_version(n,v) static u32 api_version=(v);
  60 #include <vmxnet3/vmxnet3_all_api_h.h>
  61 #undef vp_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 } vmxnet3_test_main_t;
  70
  71 vmxnet3_test_main_t vmxnet3_test_main;
  72
  73 #define foreach_standard_reply_retval_handler           \
  74 _(vmxnet3_delete_reply)
  75
  76 #define _(n)                                            \
  77     static void vl_api_##n##_t_handler                  \
  78     (vl_api_##n##_t * mp)                               \
  79     {                                                   \
  80         vat_main_t * vam = vmxnet3_test_main.vat_main;  \
  81         i32 retval = ntohl(mp->retval);                 \
  82         if (vam->async_mode) {                          \
  83             vam->async_errors += (retval < 0);          \
  84         } else {                                        \
  85             vam->retval = retval;                       \
  86             vam->result_ready = 1;                      \
  87         }                                               \
  88     }
  89 foreach_standard_reply_retval_handler;
  90 #undef _
  91
  92 #define foreach_vpe_api_reply_msg                       \
  93 _(VMXNET3_CREATE_REPLY, vmxnet3_create_reply)           \
  94 _(VMXNET3_DELETE_REPLY, vmxnet3_delete_reply)           \
  95 _(VMXNET3_DETAILS, vmxnet3_details)
  96
  97 /* vmxnet3 create API */
  98 static int
  99 api_vmxnet3_create (vat_main_t * vam)
 100 {
 101   unformat_input_t *i = vam->input;
 102   vl_api_vmxnet3_create_t *mp;
 103   vmxnet3_create_if_args_t args;
 104   int ret;
 105   u32 x[4];
 106
 107   clib_memset (&args, 0, sizeof (vmxnet3_create_if_args_t));
 108
 109   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 110     {
 111       if (unformat (i, "%x:%x:%x.%x", &x[0], &x[1], &x[2], &x[3]))
 112         {
 113           args.addr.domain = x[0];
 114           args.addr.bus = x[1];
 115           args.addr.slot = x[2];
 116           args.addr.function = x[3];
 117         }
 118       else if (unformat (i, "elog"))
 119         args.enable_elog = 1;
 120       else if (unformat (i, "bind"))
 121         args.bind = 1;
 122       else if (unformat (i, "rx-queue-size %u", &args.rxq_size))
 123         ;
 124       else if (unformat (i, "tx-queue-size %u", &args.txq_size))
 125         ;
 126       else if (unformat (i, "num-tx-queues %u", &args.txq_num))
 127         ;
 128       else if (unformat (i, "num-rx-queues %u", &args.rxq_num))
 129         ;
 130       else
 131         {
 132           clib_warning ("unknown input '%U'", format_unformat_error, i);
 133           return -99;
 134         }
 135     }
 136
 137   M (VMXNET3_CREATE, mp);
 138
 139   mp->pci_addr = clib_host_to_net_u32 (args.addr.as_u32);
 140   mp->enable_elog = clib_host_to_net_u16 (args.enable_elog);
 141   mp->rxq_size = clib_host_to_net_u16 (args.rxq_size);
 142   mp->txq_size = clib_host_to_net_u16 (args.txq_size);
 143   mp->txq_num = clib_host_to_net_u16 (args.txq_num);
 144   mp->rxq_num = clib_host_to_net_u16 (args.rxq_num);
 145   mp->bind = args.bind;
 146
 147   S (mp);
 148   W (ret);
 149
 150   return ret;
 151 }
 152
 153 /* vmxnet3-create reply handler */
 154 static void
 155 vl_api_vmxnet3_create_reply_t_handler (vl_api_vmxnet3_create_reply_t * mp)
 156 {
 157   vat_main_t *vam = vmxnet3_test_main.vat_main;
 158   i32 retval = ntohl (mp->retval);
 159
 160   if (retval == 0)
 161     {
 162       fformat (vam->ofp, "created vmxnet3 with sw_if_index %d\n",
 163                ntohl (mp->sw_if_index));
 164     }
 165
 166   vam->retval = retval;
 167   vam->result_ready = 1;
 168   vam->regenerate_interface_table = 1;
 169 }
 170
 171 /* vmxnet3 delete API */
 172 static int
 173 api_vmxnet3_delete (vat_main_t * vam)
 174 {
 175   unformat_input_t *i = vam->input;
 176   vl_api_vmxnet3_delete_t *mp;
 177   u32 sw_if_index = 0;
 178   u8 index_defined = 0;
 179   int ret;
 180
 181   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 182     {
 183       if (unformat (i, "sw_if_index %u", &sw_if_index))
 184         index_defined = 1;
 185       else
 186         {
 187           clib_warning ("unknown input '%U'", format_unformat_error, i);
 188           return -99;
 189         }
 190     }
 191
 192   if (!index_defined)
 193     {
 194       errmsg ("missing sw_if_index\n");
 195       return -99;
 196     }
 197
 198   M (VMXNET3_DELETE, mp);
 199
 200   mp->sw_if_index = clib_host_to_net_u32 (sw_if_index);
 201
 202   S (mp);
 203   W (ret);
 204
 205   return ret;
 206 }
 207
 208 static int
 209 api_vmxnet3_dump (vat_main_t * vam)
 210 {
 211   vmxnet3_test_main_t *vxm = &vmxnet3_test_main;
 212   vl_api_vmxnet3_dump_t *mp;
 213   vl_api_control_ping_t *mp_ping;
 214   int ret;
 215
 216   if (vam->json_output)
 217     {
 218       clib_warning ("JSON output not supported for vmxnet3_dump");
 219       return -99;
 220     }
 221
 222   M (VMXNET3_DUMP, mp);
 223   S (mp);
 224
 225   /* Use a control ping for synchronization */
 226   mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
 227   mp_ping->_vl_msg_id = htons (vxm->ping_id);
 228   mp_ping->client_index = vam->my_client_index;
 229
 230   fformat (vam->ofp, "Sending ping id=%d\n", vxm->ping_id);
 231
 232   vam->result_ready = 0;
 233   S (mp_ping);
 234
 235   W (ret);
 236   return ret;
 237 }
 238
 239 static u8 *
 240 format_pci_addr (u8 * s, va_list * va)
 241 {
 242   vlib_pci_addr_t *addr = va_arg (*va, vlib_pci_addr_t *);
 243   return format (s, "%04x:%02x:%02x.%x", addr->domain, addr->bus,
 244                  addr->slot, addr->function);
 245 }
 246
 247 static void
 248 vl_api_vmxnet3_details_t_handler (vl_api_vmxnet3_details_t * mp)
 249 {
 250   vat_main_t *vam = vmxnet3_test_main.vat_main;
 251   u32 pci_addr = ntohl (mp->pci_addr);
 252   u16 qid;
 253
 254   fformat (vam->ofp, "%s: sw_if_index %u mac %U\n"
 255            "   version: %u\n"
 256            "   PCI Address: %U\n"
 257            "   state %s\n",
 258            mp->if_name, ntohl (mp->sw_if_index), format_ethernet_address,
 259            mp->hw_addr, mp->version,
 260            format_pci_addr, &pci_addr, mp->admin_up_down ? "up" : "down");
 261   for (qid = 0; qid < mp->rx_count; qid++)
 262     {
 263       vl_api_vmxnet3_rx_list_t *rx_list = &mp->rx_list[qid];
 264       fformat (vam->ofp,
 265                "   RX Queue %u\n"
 266                "     RX completion next index %u\n"
 267                "     ring 0 size %u fill %u consume %u produce %u\n"
 268                "     ring 1 size %u fill %u consume %u produce %u\n",
 269                qid,
 270                ntohs (rx_list->rx_next),
 271                ntohs (rx_list->rx_qsize), ntohs (rx_list->rx_fill[0]),
 272                ntohs (rx_list->rx_consume[0]),
 273                ntohs (rx_list->rx_produce[0]),
 274                ntohs (rx_list->rx_qsize), ntohs (rx_list->rx_fill[1]),
 275                ntohs (rx_list->rx_consume[1]),
 276                ntohs (rx_list->rx_produce[1]));
 277     }
 278   for (qid = 0; qid < mp->tx_count; qid++)
 279     {
 280       vl_api_vmxnet3_tx_list_t *tx_list = &mp->tx_list[qid];
 281       fformat (vam->ofp,
 282                "   TX Queue %u\n"
 283                "     TX completion next index %u\n"
 284                "     size %u consume %u produce %u\n",
 285                qid,
 286                ntohs (tx_list->tx_next),
 287                ntohs (tx_list->tx_qsize), ntohs (tx_list->tx_consume),
 288                ntohs (tx_list->tx_produce));
 289     }
 290 }
 291
 292 /*
 293  * List of messages that the api test plugin sends,
 294  * and that the data plane plugin processes
 295  */
 296 #define foreach_vpe_api_msg                                     \
 297 _(vmxnet3_create, "<pci-address> [rx-queue-size <size>] "       \
 298   "[tx-queue-size <size>] [num-tx-queues <num>]"                \
 299   "[num-rx-queues <num>] [bind]")                               \
 300 _(vmxnet3_delete, "sw_if_index <sw_if_index>")                  \
 301 _(vmxnet3_dump, "")
 302
 303 static void
 304 vmxnet3_vat_api_hookup (vat_main_t * vam)
 305 {
 306   vmxnet3_test_main_t *vxm __attribute__ ((unused)) = &vmxnet3_test_main;
 307 #define _(N,n)                                                  \
 308   vl_msg_api_set_handlers((VL_API_##N + vxm->msg_id_base),      \
 309                           #n,                                   \
 310                           vl_api_##n##_t_handler,               \
 311                           vl_noop_handler,                      \
 312                           vl_api_##n##_t_endian,                \
 313                           vl_api_##n##_t_print,                 \
 314                           sizeof(vl_api_##n##_t), 1);
 315   foreach_vpe_api_reply_msg;
 316 #undef _
 317
 318 #define _(n,h)                                                  \
 319   hash_set_mem (vam->function_by_name, #n, api_##n);
 320   foreach_vpe_api_msg;
 321 #undef _
 322
 323 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
 324   foreach_vpe_api_msg;
 325 #undef _
 326 }
 327
 328 clib_error_t *
 329 vat_plugin_register (vat_main_t * vam)
 330 {
 331   vmxnet3_test_main_t *vxm = &vmxnet3_test_main;
 332   u8 *name;
 333
 334   vxm->vat_main = vam;
 335
 336   name = format (0, "vmxnet3_%08x%c", api_version, 0);
 337   vxm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
 338
 339   /* Get the control ping ID */
 340 #define _(id,n,crc) \
 341   const char *id ## _CRC __attribute__ ((unused)) = #n "_" #crc;
 342   foreach_vl_msg_name_crc_vpe;
 343 #undef _
 344   vxm->ping_id = vl_msg_api_get_msg_index ((u8 *) (VL_API_CONTROL_PING_CRC));
 345
 346   if (vxm->msg_id_base != (u16) ~ 0)
 347     vmxnet3_vat_api_hookup (vam);
 348
 349   vec_free (name);
 350
 351   return 0;
 352 }
 353
 354 /*
 355  * fd.io coding-style-patch-verification: ON
 356  *
 357  * Local Variables:
 358  * eval: (c-set-style "gnu")
 359  * End:
 360  */