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