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