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, "rx-queue-size %u", &args.rxq_size))
 121         ;
 122       else if (unformat (i, "tx-queue-size %u", &args.txq_size))
 123         ;
 124       else if (unformat (i, "num-tx-queues %u", &args.txq_num))
 125         ;
 126       else
 127         {
 128           clib_warning ("unknown input '%U'", format_unformat_error, i);
 129           return -99;
 130         }
 131     }
 132
 133   M (VMXNET3_CREATE, mp);
 134
 135   mp->pci_addr = clib_host_to_net_u32 (args.addr.as_u32);
 136   mp->enable_elog = clib_host_to_net_u16 (args.enable_elog);
 137   mp->rxq_size = clib_host_to_net_u16 (args.rxq_size);
 138   mp->txq_size = clib_host_to_net_u16 (args.txq_size);
 139   mp->txq_num = clib_host_to_net_u16 (args.txq_num);
 140
 141   S (mp);
 142   W (ret);
 143
 144   return ret;
 145 }
 146
 147 /* vmxnet3-create reply handler */
 148 static void
 149 vl_api_vmxnet3_create_reply_t_handler (vl_api_vmxnet3_create_reply_t * mp)
 150 {
 151   vat_main_t *vam = vmxnet3_test_main.vat_main;
 152   i32 retval = ntohl (mp->retval);
 153
 154   if (retval == 0)
 155     {
 156       fformat (vam->ofp, "created vmxnet3 with sw_if_index %d\n",
 157                ntohl (mp->sw_if_index));
 158     }
 159
 160   vam->retval = retval;
 161   vam->result_ready = 1;
 162   vam->regenerate_interface_table = 1;
 163 }
 164
 165 /* vmxnet3 delete API */
 166 static int
 167 api_vmxnet3_delete (vat_main_t * vam)
 168 {
 169   unformat_input_t *i = vam->input;
 170   vl_api_vmxnet3_delete_t *mp;
 171   u32 sw_if_index = 0;
 172   u8 index_defined = 0;
 173   int ret;
 174
 175   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 176     {
 177       if (unformat (i, "sw_if_index %u", &sw_if_index))
 178         index_defined = 1;
 179       else
 180         {
 181           clib_warning ("unknown input '%U'", format_unformat_error, i);
 182           return -99;
 183         }
 184     }
 185
 186   if (!index_defined)
 187     {
 188       errmsg ("missing sw_if_index\n");
 189       return -99;
 190     }
 191
 192   M (VMXNET3_DELETE, mp);
 193
 194   mp->sw_if_index = clib_host_to_net_u32 (sw_if_index);
 195
 196   S (mp);
 197   W (ret);
 198
 199   return ret;
 200 }
 201
 202 static int
 203 api_vmxnet3_dump (vat_main_t * vam)
 204 {
 205   vmxnet3_test_main_t *vxm = &vmxnet3_test_main;
 206   vl_api_vmxnet3_dump_t *mp;
 207   vl_api_control_ping_t *mp_ping;
 208   int ret;
 209
 210   if (vam->json_output)
 211     {
 212       clib_warning ("JSON output not supported for vmxnet3_dump");
 213       return -99;
 214     }
 215
 216   M (VMXNET3_DUMP, mp);
 217   S (mp);
 218
 219   /* Use a control ping for synchronization */
 220   mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
 221   mp_ping->_vl_msg_id = htons (vxm->ping_id);
 222   mp_ping->client_index = vam->my_client_index;
 223
 224   fformat (vam->ofp, "Sending ping id=%d\n", vxm->ping_id);
 225
 226   vam->result_ready = 0;
 227   S (mp_ping);
 228
 229   W (ret);
 230   return ret;
 231 }
 232
 233 static u8 *
 234 format_pci_addr (u8 * s, va_list * va)
 235 {
 236   vlib_pci_addr_t *addr = va_arg (*va, vlib_pci_addr_t *);
 237   return format (s, "%04x:%02x:%02x.%x", addr->domain, addr->bus,
 238                  addr->slot, addr->function);
 239 }
 240
 241 static void
 242 vl_api_vmxnet3_details_t_handler (vl_api_vmxnet3_details_t * mp)
 243 {
 244   vat_main_t *vam = vmxnet3_test_main.vat_main;
 245   u32 pci_addr = ntohl (mp->pci_addr);
 246   u16 qid;
 247
 248   fformat (vam->ofp, "%s: sw_if_index %u mac %U\n"
 249            "   version: %u\n"
 250            "   PCI Address: %U\n"
 251            "   state %s\n"
 252            "   RX Queue 0\n"
 253            "     RX completion next index %u\n"
 254            "     ring 0 size %u fill %u consume %u produce %u\n"
 255            "     ring 1 size %u fill %u consume %u produce %u\n",
 256            mp->if_name, ntohl (mp->sw_if_index), format_ethernet_address,
 257            mp->hw_addr, mp->version,
 258            format_pci_addr, &pci_addr,
 259            mp->admin_up_down ? "up" : "down",
 260            ntohs (mp->rx_next),
 261            ntohs (mp->rx_qsize), ntohs (mp->rx_fill[0]),
 262            ntohs (mp->rx_consume[0]),
 263            ntohs (mp->rx_produce[0]),
 264            ntohs (mp->rx_qsize), ntohs (mp->rx_fill[1]),
 265            ntohs (mp->rx_consume[1]), ntohs (mp->rx_produce[1]));
 266   for (qid = 0; qid < mp->tx_count; qid++)
 267     {
 268       vl_api_vmxnet3_tx_list_t *tx_list = &mp->tx_list[qid];
 269       fformat (vam->ofp,
 270                "   TX Queue %u\n"
 271                "     TX completion next index %u\n"
 272                "     size %u consume %u produce %u\n",
 273                qid,
 274                ntohs (tx_list->tx_next),
 275                ntohs (tx_list->tx_qsize), ntohs (tx_list->tx_consume),
 276                ntohs (tx_list->tx_produce));
 277     }
 278 }
 279
 280 /*
 281  * List of messages that the api test plugin sends,
 282  * and that the data plane plugin processes
 283  */
 284 #define foreach_vpe_api_msg                                     \
 285 _(vmxnet3_create, "<pci-address> [rx-queue-size <size>] "       \
 286               "[tx-queue-size <size>] [num-tx-queues <num>]")   \
 287 _(vmxnet3_delete, "sw_if_index <sw_if_index>")                  \
 288 _(vmxnet3_dump, "")
 289
 290 static void
 291 vmxnet3_vat_api_hookup (vat_main_t * vam)
 292 {
 293   vmxnet3_test_main_t *vxm __attribute__ ((unused)) = &vmxnet3_test_main;
 294 #define _(N,n)                                                  \
 295   vl_msg_api_set_handlers((VL_API_##N + vxm->msg_id_base),      \
 296                           #n,                                   \
 297                           vl_api_##n##_t_handler,               \
 298                           vl_noop_handler,                      \
 299                           vl_api_##n##_t_endian,                \
 300                           vl_api_##n##_t_print,                 \
 301                           sizeof(vl_api_##n##_t), 1);
 302   foreach_vpe_api_reply_msg;
 303 #undef _
 304
 305 #define _(n,h)                                                  \
 306   hash_set_mem (vam->function_by_name, #n, api_##n);
 307   foreach_vpe_api_msg;
 308 #undef _
 309
 310 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
 311   foreach_vpe_api_msg;
 312 #undef _
 313 }
 314
 315 clib_error_t *
 316 vat_plugin_register (vat_main_t * vam)
 317 {
 318   vmxnet3_test_main_t *vxm = &vmxnet3_test_main;
 319   u8 *name;
 320
 321   vxm->vat_main = vam;
 322
 323   name = format (0, "vmxnet3_%08x%c", api_version, 0);
 324   vxm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
 325
 326   /* Get the control ping ID */
 327 #define _(id,n,crc) \
 328   const char *id ## _CRC __attribute__ ((unused)) = #n "_" #crc;
 329   foreach_vl_msg_name_crc_vpe;
 330 #undef _
 331   vxm->ping_id = vl_msg_api_get_msg_index ((u8 *) (VL_API_CONTROL_PING_CRC));
 332
 333   if (vxm->msg_id_base != (u16) ~ 0)
 334     vmxnet3_vat_api_hookup (vam);
 335
 336   vec_free (name);
 337
 338   return 0;
 339 }
 340
 341 /*
 342  * fd.io coding-style-patch-verification: ON
 343  *
 344  * Local Variables:
 345  * eval: (c-set-style "gnu")
 346  * End:
 347  */