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