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