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