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