cli.c

Go to the documentation of this file.

/*
 *------------------------------------------------------------------
 * Copyright (c) 2018 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *------------------------------------------------------------------
 */
#include <stdint.h>
#include <net/if.h>
#include <sys/ioctl.h>
#include <inttypes.h>

#include <vlib/vlib.h>
#include <vlib/unix/unix.h>
#include <vlib/pci/pci.h>
#include <vnet/ethernet/ethernet.h>

#include <vmxnet3/vmxnet3.h>

static clib_error_t *
vmxnet3_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
                           vlib_cli_command_t * cmd)
{
  unformat_input_t _line_input, *line_input = &_line_input;
  vmxnet3_create_if_args_t args;
  u32 size;

  /* Get a line of input. */
  if (!unformat_user (input, unformat_line_input, line_input))
    return 0;

  clib_memset (&args, 0, sizeof (args));
  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
    {
      if (unformat (line_input, "%U", unformat_vlib_pci_addr, &args.addr))
        ;
      else if (unformat (line_input, "elog"))
        args.enable_elog = 1;
      else if (unformat (line_input, "bind"))
        args.bind = 1;
      else if (unformat (line_input, "rx-queue-size %u", &size))
        args.rxq_size = size;
      else if (unformat (line_input, "tx-queue-size %u", &size))
        args.txq_size = size;
      else if (unformat (line_input, "num-tx-queues %u", &size))
        args.txq_num = size;
      else if (unformat (line_input, "num-rx-queues %u", &size))
        args.rxq_num = size;
      else
        return clib_error_return (0, "unknown input `%U'",
                                  format_unformat_error, input);
    }
  unformat_free (line_input);


  vmxnet3_create_if (vm, &args);

  return args.error;
}

/* *INDENT-OFF* */
VLIB_CLI_COMMAND (vmxnet3_create_command, static) = {
  .path = "create interface vmxnet3",
  .short_help = "create interface vmxnet3 <pci-address>"
                "[rx-queue-size <size>] [tx-queue-size <size>]"
                "[num-tx-queues <number>] [num-rx-queues <number>] [bind]",
  .function = vmxnet3_create_command_fn,
};
/* *INDENT-ON* */

static clib_error_t *
vmxnet3_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
                           vlib_cli_command_t * cmd)
{
  unformat_input_t _line_input, *line_input = &_line_input;
  u32 sw_if_index = ~0;
  vnet_hw_interface_t *hw;
  vmxnet3_main_t *vmxm = &vmxnet3_main;
  vmxnet3_device_t *vd;
  vnet_main_t *vnm = vnet_get_main ();

  /* Get a line of input. */
  if (!unformat_user (input, unformat_line_input, line_input))
    return 0;

  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
    {
      if (unformat (line_input, "sw_if_index %d", &sw_if_index))
        ;
      else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
                         vnm, &sw_if_index))
        ;
      else
        return clib_error_return (0, "unknown input `%U'",
                                  format_unformat_error, input);
    }
  unformat_free (line_input);

  if (sw_if_index == ~0)
    return clib_error_return (0,
                              "please specify interface name or sw_if_index");

  hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
  if (hw == NULL || vmxnet3_device_class.index != hw->dev_class_index)
    return clib_error_return (0, "not a vmxnet3 interface");

  vd = pool_elt_at_index (vmxm->devices, hw->dev_instance);

  vmxnet3_delete_if (vm, vd);

  return 0;
}

/* *INDENT-OFF* */
VLIB_CLI_COMMAND (vmxnet3_delete_command, static) = {
  .path = "delete interface vmxnet3",
  .short_help = "delete interface vmxnet3 "
    "{<interface> | sw_if_index <sw_idx>}",
  .function = vmxnet3_delete_command_fn,
};
/* *INDENT-ON* */

static clib_error_t *
vmxnet3_test_command_fn (vlib_main_t * vm, unformat_input_t * input,
                         vlib_cli_command_t * cmd)
{
  unformat_input_t _line_input, *line_input = &_line_input;
  u32 sw_if_index = ~0;
  vnet_hw_interface_t *hw;
  vmxnet3_main_t *vmxm = &vmxnet3_main;
  vmxnet3_device_t *vd;
  vnet_main_t *vnm = vnet_get_main ();
  int enable_elog = 0, disable_elog = 0;

  /* Get a line of input. */
  if (!unformat_user (input, unformat_line_input, line_input))
    return 0;

  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
    {
      if (unformat (line_input, "sw_if_index %d", &sw_if_index))
        ;
      else if (unformat (line_input, "elog-on"))
        enable_elog = 1;
      else if (unformat (line_input, "elog-off"))
        disable_elog = 1;
      else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
                         vnm, &sw_if_index))
        ;
      else
        return clib_error_return (0, "unknown input `%U'",
                                  format_unformat_error, input);
    }
  unformat_free (line_input);

  if (sw_if_index == ~0)
    return clib_error_return (0,
                              "please specify interface name or sw_if_index");

  hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
  if (hw == NULL || vmxnet3_device_class.index != hw->dev_class_index)
    return clib_error_return (0, "not a vmxnet3 interface");

  vd = pool_elt_at_index (vmxm->devices, hw->dev_instance);

  if (enable_elog)
    vd->flags |= VMXNET3_DEVICE_F_ELOG;

  if (disable_elog)
    vd->flags &= ~VMXNET3_DEVICE_F_ELOG;

  return 0;
}

/* *INDENT-OFF* */
VLIB_CLI_COMMAND (vmxnet3_test_command, static) = {
  .path = "test vmxnet3",
  .short_help = "test vmxnet3 <interface> | sw_if_index <sw_idx> [irq] "
    "[elog-on] [elog-off]",
  .function = vmxnet3_test_command_fn,
};
/* *INDENT-ON* */

static void
show_vmxnet3 (vlib_main_t * vm, u32 * hw_if_indices, u8 show_descr,
              u8 show_one_table, u32 which, u8 show_one_slot, u32 slot)
{
  u32 i, desc_idx;
  vmxnet3_device_t *vd;
  vnet_main_t *vnm = &vnet_main;
  vmxnet3_main_t *vmxm = &vmxnet3_main;
  vnet_hw_interface_t *hi;
  vmxnet3_rxq_t *rxq;
  vmxnet3_rx_desc *rxd;
  vmxnet3_rx_comp *rx_comp;
  vmxnet3_txq_t *txq;
  vmxnet3_tx_desc *txd;
  vmxnet3_tx_comp *tx_comp;
  u16 qid;

  if (!hw_if_indices)
    return;

  vlib_cli_output (vm, "LRO/TSO configured: %u", vmxm->lro_configured);
  for (i = 0; i < vec_len (hw_if_indices); i++)
    {
      hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
      vd = vec_elt_at_index (vmxm->devices, hi->dev_instance);
      vlib_cli_output (vm, "Interface: %U (ifindex %d)",
                       format_vnet_hw_if_index_name, vnm, hw_if_indices[i],
                       hw_if_indices[i]);
      vlib_cli_output (vm, "  Version: %u", vd->version);
      vlib_cli_output (vm, "  LRO/TSO enable: %u", vd->lro_enable);
      vlib_cli_output (vm, "  PCI Address: %U", format_vlib_pci_addr,
                       &vd->pci_addr);
      vlib_cli_output (vm, "  Mac Address: %U", format_ethernet_address,
                       vd->mac_addr);
      vlib_cli_output (vm, "  hw if index: %u", vd->hw_if_index);
      vlib_cli_output (vm, "  Device instance: %u", vd->dev_instance);
      vlib_cli_output (vm, "  Number of interrupts: %u", vd->num_intrs);

      vec_foreach_index (qid, vd->rxqs)
      {
        rxq = vec_elt_at_index (vd->rxqs, qid);
        u16 rid;

        vlib_cli_output (vm, "  Queue %u (RX)", qid);
        vlib_cli_output (vm, "    RX completion next index %u",
                         rxq->rx_comp_ring.next);
        vlib_cli_output (vm, "    RX completion generation flag 0x%x",
                         rxq->rx_comp_ring.gen);

        /* RX descriptors tables */
        for (rid = 0; rid < VMXNET3_RX_RING_SIZE; rid++)
          {
            vmxnet3_rx_ring *ring = &rxq->rx_ring[rid];

            vlib_cli_output (vm,
                             "    ring %u size %u fill %u "
                             "consume %u produce %u", rid,
                             rxq->size, ring->fill, ring->consume,
                             ring->produce);
            if (show_descr)
              {
                vlib_cli_output (vm, "RX descriptors table");
                vlib_cli_output (vm, "  %5s  %18s  %10s",
                                 "slot", "address", "flags");
                for (desc_idx = 0; desc_idx < rxq->size; desc_idx++)
                  {
                    rxd = &rxq->rx_desc[rid][desc_idx];
                    vlib_cli_output (vm, "  %5u  0x%016llx  0x%08x",
                                     desc_idx, rxd->address, rxd->flags);
                  }
              }
            else if (show_one_table)
              {
                if (((which == VMXNET3_SHOW_RX_DESC0) && (rid == 0)) ||
                    ((which == VMXNET3_SHOW_RX_DESC1) && (rid == 1)))
                  {
                    vlib_cli_output (vm, "RX descriptors table");
                    vlib_cli_output (vm, "  %5s  %18s  %10s",
                                     "slot", "address", "flags");
                    if (show_one_slot)
                      {
                        rxd = &rxq->rx_desc[rid][slot];
                        vlib_cli_output (vm, "  %5u  0x%016llx  0x%08x",
                                         slot, rxd->address, rxd->flags);
                      }
                    else
                      for (desc_idx = 0; desc_idx < rxq->size; desc_idx++)
                        {
                          rxd = &rxq->rx_desc[rid][desc_idx];
                          vlib_cli_output (vm, "  %5u  0x%016llx  0x%08x",
                                           desc_idx, rxd->address,
                                           rxd->flags);
                        }
                  }
              }
          }

        /* RX completion table */
        if (show_descr)
          {
            vlib_cli_output (vm, "RX completion descriptors table");
            vlib_cli_output (vm, "  %5s  %10s  %10s  %10s  %10s",
                             "slot", "index", "rss", "len", "flags");
            for (desc_idx = 0; desc_idx < rxq->size; desc_idx++)
              {
                rx_comp = &rxq->rx_comp[desc_idx];
                vlib_cli_output (vm, "  %5u  0x%08x  %10u  %10u  0x%08x",
                                 desc_idx, rx_comp->index, rx_comp->rss,
                                 rx_comp->len, rx_comp->flags);
              }
          }
        else if (show_one_table)
          {
            if (which == VMXNET3_SHOW_RX_COMP)
              {
                vlib_cli_output (vm, "RX completion descriptors table");
                vlib_cli_output (vm, "  %5s  %10s  %10s  %10s  %10s",
                                 "slot", "index", "rss", "len", "flags");
                if (show_one_slot)
                  {
                    rx_comp = &rxq->rx_comp[slot];
                    vlib_cli_output (vm, "  %5u  0x%08x  %10u  %10u  0x%08x",
                                     slot, rx_comp->index, rx_comp->rss,
                                     rx_comp->len, rx_comp->flags);
                  }
                else
                  for (desc_idx = 0; desc_idx < rxq->size; desc_idx++)
                    {
                      rx_comp = &rxq->rx_comp[desc_idx];
                      vlib_cli_output (vm,
                                       "  %5u  0x%08x  %10u  %10u  0x%08x",
                                       desc_idx, rx_comp->index, rx_comp->rss,
                                       rx_comp->len, rx_comp->flags);
                    }
              }
          }
      }

      vec_foreach_index (qid, vd->txqs)
      {
        txq = vec_elt_at_index (vd->txqs, qid);
        vlib_cli_output (vm, "  Queue %u (TX)", qid);
        vlib_cli_output (vm, "    TX completion next index %u",
                         txq->tx_comp_ring.next);
        vlib_cli_output (vm, "    TX completion generation flag 0x%x",
                         txq->tx_comp_ring.gen);
        vlib_cli_output (vm, "    size %u consume %u produce %u",
                         txq->size, txq->tx_ring.consume,
                         txq->tx_ring.produce);
        if (show_descr)
          {
            vlib_cli_output (vm, "TX descriptors table");
            vlib_cli_output (vm, "  %5s  %18s  %10s  %10s",
                             "slot", "address", "flags0", "flags1");
            for (desc_idx = 0; desc_idx < txq->size; desc_idx++)
              {
                txd = &txq->tx_desc[desc_idx];
                vlib_cli_output (vm, "  %5u  0x%016llx  0x%08x  0x%08x",
                                 desc_idx, txd->address, txd->flags[0],
                                 txd->flags[1]);
              }

            vlib_cli_output (vm, "TX completion descriptors table");
            vlib_cli_output (vm, "  %5s  %10s  %10s",
                             "slot", "index", "flags");
            for (desc_idx = 0; desc_idx < txq->size; desc_idx++)
              {
                tx_comp = &txq->tx_comp[desc_idx];
                vlib_cli_output (vm, "  %5u  0x%08x  0x%08x",
                                 desc_idx, tx_comp->index, tx_comp->flags);
              }
          }
        else if (show_one_table)
          {
            if (which == VMXNET3_SHOW_TX_DESC)
              {
                vlib_cli_output (vm, "TX descriptors table");
                vlib_cli_output (vm, "  %5s  %18s  %10s  %10s",
                                 "slot", "address", "flags0", "flags1");
                if (show_one_slot)
                  {
                    txd = &txq->tx_desc[slot];
                    vlib_cli_output (vm, "  %5u  0x%016llx  0x%08x  0x%08x",
                                     slot, txd->address, txd->flags[0],
                                     txd->flags[1]);
                  }
                else
                  for (desc_idx = 0; desc_idx < txq->size; desc_idx++)
                    {
                      txd = &txq->tx_desc[desc_idx];
                      vlib_cli_output (vm, "  %5u  0x%016llx  0x%08x  0x%08x",
                                       desc_idx, txd->address, txd->flags[0],
                                       txd->flags[1]);
                    }
              }
            else if (which == VMXNET3_SHOW_TX_COMP)
              {
                vlib_cli_output (vm, "TX completion descriptors table");
                vlib_cli_output (vm, "  %5s  %10s  %10s",
                                 "slot", "index", "flags");
                if (show_one_slot)
                  {
                    tx_comp = &txq->tx_comp[slot];
                    vlib_cli_output (vm, "  %5u  0x%08x  0x%08x",
                                     slot, tx_comp->index, tx_comp->flags);
                  }
                else
                  for (desc_idx = 0; desc_idx < txq->size; desc_idx++)
                    {
                      tx_comp = &txq->tx_comp[desc_idx];
                      vlib_cli_output (vm, "  %5u  0x%08x  0x%08x",
                                       desc_idx, tx_comp->index,
                                       tx_comp->flags);
                    }
              }
          }
      }
    }
}

static clib_error_t *
show_vmxnet3_fn (vlib_main_t * vm, unformat_input_t * input,
                 vlib_cli_command_t * cmd)
{
  vmxnet3_main_t *vmxm = &vmxnet3_main;
  vnet_main_t *vnm = &vnet_main;
  vmxnet3_device_t *vd;
  clib_error_t *error = 0;
  u32 hw_if_index, *hw_if_indices = 0;
  vnet_hw_interface_t *hi = 0;
  u8 show_descr = 0, show_one_table = 0, show_one_slot = 0;
  u32 which = ~0, slot;

  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
    {
      if (unformat
          (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
        {
          hi = vnet_get_hw_interface (vnm, hw_if_index);
          if (vmxnet3_device_class.index != hi->dev_class_index)
            {
              error = clib_error_return (0, "unknown input `%U'",
                                         format_unformat_error, input);
              goto done;
            }
          vec_add1 (hw_if_indices, hw_if_index);
        }
      else if (unformat (input, "desc"))
        show_descr = 1;
      else if (hi)
        {
          vmxnet3_device_t *vd =
            vec_elt_at_index (vmxm->devices, hi->dev_instance);

          if (unformat (input, "rx-comp"))
            {
              show_one_table = 1;
              which = VMXNET3_SHOW_RX_COMP;
              if (unformat (input, "%u", &slot))
                {
                  vmxnet3_rxq_t *rxq = vec_elt_at_index (vd->rxqs, 0);

                  if (slot >= rxq->size)
                    {
                      error = clib_error_return (0,
                                                 "slot size must be < rx queue "
                                                 "size %u", rxq->size);
                      goto done;
                    }
                  show_one_slot = 1;
                }
            }
          else if (unformat (input, "rx-desc-0"))
            {
              show_one_table = 1;
              which = VMXNET3_SHOW_RX_DESC0;
              if (unformat (input, "%u", &slot))
                {
                  vmxnet3_rxq_t *rxq = vec_elt_at_index (vd->rxqs, 0);

                  if (slot >= rxq->size)
                    {
                      error = clib_error_return (0,
                                                 "slot size must be < rx queue "
                                                 "size %u", rxq->size);
                      goto done;
                    }
                  show_one_slot = 1;
                }
            }
          else if (unformat (input, "rx-desc-1"))
            {
              show_one_table = 1;
              which = VMXNET3_SHOW_RX_DESC1;
              if (unformat (input, "%u", &slot))
                {
                  vmxnet3_rxq_t *rxq = vec_elt_at_index (vd->rxqs, 0);

                  if (slot >= rxq->size)
                    {
                      error = clib_error_return (0,
                                                 "slot size must be < rx queue "
                                                 "size %u", rxq->size);
                      goto done;
                    }
                  show_one_slot = 1;
                }
            }
          else if (unformat (input, "tx-comp"))
            {
              show_one_table = 1;
              which = VMXNET3_SHOW_TX_COMP;
              if (unformat (input, "%u", &slot))
                {
                  vmxnet3_txq_t *txq = vec_elt_at_index (vd->txqs, 0);

                  if (slot >= txq->size)
                    {
                      error = clib_error_return (0,
                                                 "slot size must be < tx queue "
                                                 "size %u", txq->size);
                      goto done;
                    }
                  show_one_slot = 1;
                }
            }
          else if (unformat (input, "tx-desc"))
            {
              show_one_table = 1;
              which = VMXNET3_SHOW_TX_DESC;
              if (unformat (input, "%u", &slot))
                {
                  vmxnet3_txq_t *txq = vec_elt_at_index (vd->txqs, 0);

                  if (slot >= txq->size)
                    {
                      error = clib_error_return (0,
                                                 "slot size must be < tx queue "
                                                 "size %u", txq->size);
                      goto done;
                    }
                  show_one_slot = 1;
                }
            }
          else
            {
              error = clib_error_return (0, "unknown input `%U'",
                                         format_unformat_error, input);
              goto done;
            }
        }
      else
        {
          error = clib_error_return (0, "unknown input `%U'",
                                     format_unformat_error, input);
          goto done;
        }
    }

  if (vec_len (hw_if_indices) == 0)
    {
      pool_foreach (vd, vmxm->devices,
                    vec_add1 (hw_if_indices, vd->hw_if_index);
        );
    }

  show_vmxnet3 (vm, hw_if_indices, show_descr, show_one_table, which,
                show_one_slot, slot);

done:
  vec_free (hw_if_indices);
  return error;
}

/* *INDENT-OFF* */
VLIB_CLI_COMMAND (show_vmxnet3_command, static) = {
  .path = "show vmxnet3",
  .short_help = "show vmxnet3 [[<interface>] ([desc] | ([rx-comp] | "
  "[rx-desc-0] | [rx-desc-1] | [tx-comp] | [tx-desc]) [<slot>])]",
  .function = show_vmxnet3_fn,
};
/* *INDENT-ON* */

clib_error_t *
vmxnet3_cli_init (vlib_main_t * vm)
{
  vmxnet3_main_t *vmxm = &vmxnet3_main;

  /* initialize binary API */
  vmxnet3_plugin_api_hookup (vm);

  vmxm->log_default = vlib_log_register_class ("vmxnet3", 0);
  return 0;
}

VLIB_INIT_FUNCTION (vmxnet3_cli_init);

static clib_error_t *
vmxnet3_config (vlib_main_t * vm, unformat_input_t * input)
{
  vmxnet3_main_t *vmxm = &vmxnet3_main;

  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
    {
      if (unformat (input, "lro"))
        vmxm->lro_configured = 1;
      else
        return clib_error_return (0, "unknown input `%U'",
                                  format_unformat_error, input);
    }

  return 0;
}

/* vmxnet3 { ... } configuration. */
VLIB_CONFIG_FUNCTION (vmxnet3_config, "vmxnet3");

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */