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