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