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