src/vnet/devices/tap/cli.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2016 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 #include <stdint.h>
  18 #include <net/if.h>
  19 #include <sys/ioctl.h>
  20 #include <inttypes.h>
  21
  22 #include <vlib/vlib.h>
  23 #include <vlib/unix/unix.h>
  24 #include <vnet/ethernet/ethernet.h>
  25 #include <vnet/ip/ip4_packet.h>
  26 #include <vnet/ip/ip6_packet.h>
  27 #include <vnet/ip/format.h>
  28 #include <linux/virtio_net.h>
  29 #include <linux/vhost.h>
  30 #include <vnet/devices/virtio/virtio.h>
  31 #include <vnet/devices/tap/tap.h>
  32
  33 static clib_error_t *
  34 tap_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
  35                        vlib_cli_command_t * cmd)
  36 {
  37   unformat_input_t _line_input, *line_input = &_line_input;
  38   tap_create_if_args_t args = { 0 };
  39   int ip_addr_set = 0;
  40
  41   /* Get a line of input. */
  42   if (!unformat_user (input, unformat_line_input, line_input))
  43     return clib_error_return (0, "Missing name <interface>");
  44
  45   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
  46     {
  47       if (unformat (line_input, "name %s", &args.name))
  48         ;
  49       else if (unformat (line_input, "host-ns %s", &args.host_namespace))
  50         ;
  51       else if (unformat (line_input, "host-bridge %s", &args.host_bridge))
  52         ;
  53       else if (unformat (line_input, "host-ip4-addr %U/%d",
  54                          unformat_ip4_address, &args.host_ip4_addr,
  55                          &args.host_ip4_prefix_len))
  56         ip_addr_set = 1;
  57       else if (unformat (line_input, "host-ip6-addr %U/%d",
  58                          unformat_ip6_address, &args.host_ip6_addr,
  59                          &args.host_ip6_prefix_len))
  60         ip_addr_set = 1;
  61       else if (unformat (line_input, "rx-ring-size %d", &args.rx_ring_sz))
  62         ;
  63       else if (unformat (line_input, "tx-ring-size %d", &args.tx_ring_sz))
  64         ;
  65       else if (unformat (line_input, "hw-addr %U",
  66                          unformat_ethernet_address, args.hw_addr))
  67         args.hw_addr_set = 1;
  68       else
  69         return clib_error_return (0, "unknown input `%U'",
  70                                   format_unformat_error, input);
  71     }
  72   unformat_free (line_input);
  73
  74   if (ip_addr_set && args.host_bridge)
  75     return clib_error_return (0, "Please specify either host ip address or "
  76                               "host bridge");
  77
  78   tap_create_if (vm, &args);
  79
  80   vec_free (args.name);
  81   vec_free (args.host_namespace);
  82   vec_free (args.host_bridge);
  83
  84   return args.error;
  85
  86 }
  87
  88 /* *INDENT-OFF* */
  89 VLIB_CLI_COMMAND (tap_create_command, static) = {
  90   .path = "create tap",
  91   .short_help = "create tap {name <if-name>} [hw-addr <mac-address>] "
  92     "[rx-ring-size <size>] [tx-ring-size <size>] [host-ns <netns>] "
  93     "[host-bridge <bridge-name>] [host-ip4-addr <ip4addr/mask>] "
  94     "[host-ip6-addr <ip6-addr]",
  95   .function = tap_create_command_fn,
  96 };
  97 /* *INDENT-ON* */
  98
  99 static clib_error_t *
 100 tap_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
 101                        vlib_cli_command_t * cmd)
 102 {
 103   unformat_input_t _line_input, *line_input = &_line_input;
 104   u32 sw_if_index = ~0;
 105   vnet_main_t *vnm = vnet_get_main ();
 106   int rv;
 107
 108   /* Get a line of input. */
 109   if (!unformat_user (input, unformat_line_input, line_input))
 110     return clib_error_return (0, "Missing <interface>");
 111
 112   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 113     {
 114       if (unformat (line_input, "sw_if_index %d", &sw_if_index))
 115         ;
 116       else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
 117                          vnm, &sw_if_index))
 118         ;
 119       else
 120         return clib_error_return (0, "unknown input `%U'",
 121                                   format_unformat_error, input);
 122     }
 123   unformat_free (line_input);
 124
 125   if (sw_if_index == ~0)
 126     return clib_error_return (0,
 127                               "please specify interface name or sw_if_index");
 128
 129   rv = tap_delete_if (vm, sw_if_index);
 130   if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
 131     return clib_error_return (0, "not a tap interface");
 132   else if (rv != 0)
 133     return clib_error_return (0, "error on deleting tap interface");
 134
 135   return 0;
 136 }
 137
 138 /* *INDENT-OFF* */
 139 VLIB_CLI_COMMAND (tap_delete__command, static) =
 140 {
 141   .path = "delete tap",
 142   .short_help = "delete tap {<interface> | sw_if_index <sw_idx>}",
 143   .function = tap_delete_command_fn,
 144 };
 145 /* *INDENT-ON* */
 146
 147 static clib_error_t *
 148 tap_show_command_fn (vlib_main_t * vm, unformat_input_t * input,
 149                      vlib_cli_command_t * cmd)
 150 {
 151   virtio_main_t *mm = &virtio_main;
 152   virtio_if_t *vif;
 153   vnet_main_t *vnm = vnet_get_main ();
 154   int show_descr = 0;
 155   clib_error_t *error = 0;
 156   u32 hw_if_index, *hw_if_indices = 0;
 157   virtio_vring_t *vring;
 158   int i, j;
 159   struct feat_struct
 160   {
 161     u8 bit;
 162     char *str;
 163   };
 164   struct feat_struct *feat_entry;
 165
 166   static struct feat_struct feat_array[] = {
 167 #define _(s,b) { .str = #s, .bit = b, },
 168     foreach_virtio_net_features
 169 #undef _
 170     {.str = NULL}
 171   };
 172
 173   struct feat_struct *flag_entry;
 174   static struct feat_struct flags_array[] = {
 175 #define _(b,e,s) { .bit = b, .str = s, },
 176     foreach_virtio_if_flag
 177 #undef _
 178     {.str = NULL}
 179   };
 180
 181   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 182     {
 183       if (unformat
 184           (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
 185         vec_add1 (hw_if_indices, hw_if_index);
 186       else if (unformat (input, "descriptors"))
 187         show_descr = 1;
 188       else
 189         {
 190           error = clib_error_return (0, "unknown input `%U'",
 191                                      format_unformat_error, input);
 192           goto done;
 193         }
 194     }
 195
 196   if (vec_len (hw_if_indices) == 0)
 197     {
 198       /* *INDENT-OFF* */
 199       pool_foreach (vif, mm->interfaces,
 200           vec_add1 (hw_if_indices, vif->hw_if_index);
 201       );
 202       /* *INDENT-ON* */
 203     }
 204
 205   for (hw_if_index = 0; hw_if_index < vec_len (hw_if_indices); hw_if_index++)
 206     {
 207       vnet_hw_interface_t *hi =
 208         vnet_get_hw_interface (vnm, hw_if_indices[hw_if_index]);
 209       vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
 210       vlib_cli_output (vm, "interface %U", format_vnet_sw_if_index_name,
 211                        vnm, vif->sw_if_index);
 212       if (vif->name)
 213         vlib_cli_output (vm, "  name \"%s\"", vif->name);
 214       if (vif->net_ns)
 215         vlib_cli_output (vm, "  host-ns \"%s\"", vif->net_ns);
 216       vlib_cli_output (vm, "  flags 0x%x", vif->flags);
 217       flag_entry = (struct feat_struct *) &flags_array;
 218       while (flag_entry->str)
 219         {
 220           if (vif->flags & (1ULL << flag_entry->bit))
 221             vlib_cli_output (vm, "    %s (%d)", flag_entry->str,
 222                              flag_entry->bit);
 223           flag_entry++;
 224         }
 225       vlib_cli_output (vm, "  fd %d", vif->fd);
 226       vlib_cli_output (vm, "  tap-fd %d", vif->tap_fd);
 227       vlib_cli_output (vm, "  features 0x%lx", vif->features);
 228       feat_entry = (struct feat_struct *) &feat_array;
 229       while (feat_entry->str)
 230         {
 231           if (vif->features & (1ULL << feat_entry->bit))
 232             vlib_cli_output (vm, "    %s (%d)", feat_entry->str,
 233                              feat_entry->bit);
 234           feat_entry++;
 235         }
 236       vlib_cli_output (vm, "  remote-features 0x%lx", vif->remote_features);
 237       feat_entry = (struct feat_struct *) &feat_array;
 238       while (feat_entry->str)
 239         {
 240           if (vif->remote_features & (1ULL << feat_entry->bit))
 241             vlib_cli_output (vm, "    %s (%d)", feat_entry->str,
 242                              feat_entry->bit);
 243           feat_entry++;
 244         }
 245       vec_foreach_index (i, vif->vrings)
 246       {
 247         // RX = 0, TX = 1
 248         vring = vec_elt_at_index (vif->vrings, i);
 249         vlib_cli_output (vm, "  Virtqueue (%s)", (i & 1) ? "TX" : "RX");
 250         vlib_cli_output (vm, "    qsz %d, last_used_idx %d, desc_in_use %d",
 251                          vring->size, vring->last_used_idx,
 252                          vring->desc_in_use);
 253         vlib_cli_output (vm,
 254                          "    avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
 255                          vring->avail->flags, vring->avail->idx,
 256                          vring->used->flags, vring->used->idx);
 257         vlib_cli_output (vm, "    kickfd %d, callfd %d", vring->kick_fd,
 258                          vring->call_fd);
 259         if (show_descr)
 260           {
 261             vlib_cli_output (vm, "\n  descriptor table:\n");
 262             vlib_cli_output (vm,
 263                              "   id          addr         len  flags  next      user_addr\n");
 264             vlib_cli_output (vm,
 265                              "  ===== ================== ===== ====== ===== ==================\n");
 266             vring = vif->vrings;
 267             for (j = 0; j < vring->size; j++)
 268               {
 269                 struct vring_desc *desc = &vring->desc[j];
 270                 vlib_cli_output (vm,
 271                                  "  %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
 272                                  j, desc->addr,
 273                                  desc->len,
 274                                  desc->flags, desc->next, desc->addr);
 275               }
 276           }
 277       }
 278     }
 279 done:
 280   vec_free (hw_if_indices);
 281   return error;
 282 }
 283
 284 /* *INDENT-OFF* */
 285 VLIB_CLI_COMMAND (tap_show_command, static) = {
 286   .path = "show tap",
 287   .short_help = "show tap {<interface>] [descriptors]",
 288   .function = tap_show_command_fn,
 289 };
 290 /* *INDENT-ON* */
 291
 292 clib_error_t *
 293 tap_cli_init (vlib_main_t * vm)
 294 {
 295   return 0;
 296 }
 297
 298 VLIB_INIT_FUNCTION (tap_cli_init);
 299
 300 /*
 301  * fd.io coding-style-patch-verification: ON
 302  *
 303  * Local Variables:
 304  * eval: (c-set-style "gnu")
 305  * End:
 306  */