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, "gro-coalesce"))
  94             args.tap_flags |= TAP_FLAG_GRO_COALESCE;
  95           else if (unformat (line_input, "csum-offload"))
  96             args.tap_flags |= TAP_FLAG_CSUM_OFFLOAD;
  97           else if (unformat (line_input, "persist"))
  98             args.tap_flags |= TAP_FLAG_PERSIST;
  99           else if (unformat (line_input, "attach"))
 100             args.tap_flags |= TAP_FLAG_ATTACH;
 101           else if (unformat (line_input, "tun"))
 102             args.tap_flags |= TAP_FLAG_TUN;
 103           else if (unformat (line_input, "packed"))
 104             args.tap_flags |= TAP_FLAG_PACKED;
 105           else if (unformat (line_input, "in-order"))
 106             args.tap_flags |= TAP_FLAG_IN_ORDER;
 107           else if (unformat (line_input, "hw-addr %U",
 108                              unformat_ethernet_address, args.mac_addr.bytes))
 109             args.mac_addr_set = 1;
 110           else
 111             {
 112               unformat_free (line_input);
 113               return clib_error_return (0, "unknown input `%U'",
 114                                         format_unformat_error, input);
 115             }
 116         }
 117       unformat_free (line_input);
 118     }
 119
 120   if (ip_addr_set && args.host_bridge)
 121     return clib_error_return (0, "Please specify either host ip address or "
 122                               "host bridge");
 123
 124   tap_create_if (vm, &args);
 125
 126   if (!args.rv)
 127     vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
 128                      vnet_get_main (), args.sw_if_index);
 129
 130   vec_free (args.host_if_name);
 131   vec_free (args.host_namespace);
 132   vec_free (args.host_bridge);
 133
 134   return args.error;
 135
 136 }
 137
 138 /* *INDENT-OFF* */
 139 VLIB_CLI_COMMAND (tap_create_command, static) = {
 140   .path = "create tap",
 141   .short_help = "create tap {id <if-id>} [hw-addr <mac-address>] "
 142     "[num-rx-queues <n>] [rx-ring-size <size>] [tx-ring-size <size>] "
 143     "[host-ns <netns>] [host-bridge <bridge-name>] "
 144     "[host-ip4-addr <ip4addr/mask>] [host-ip6-addr <ip6-addr>] "
 145     "[host-ip4-gw <ip4-addr>] [host-ip6-gw <ip6-addr>] "
 146     "[host-mac-addr <host-mac-address>] [host-if-name <name>] "
 147     "[host-mtu-size <size>] [no-gso|gso|csum-offload|gro-coalesce] "
 148     "[persist] [attach] [tun] [packed] [in-order]",
 149   .function = tap_create_command_fn,
 150 };
 151 /* *INDENT-ON* */
 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 /* *INDENT-OFF* */
 193 VLIB_CLI_COMMAND (tap_delete__command, static) =
 194 {
 195   .path = "delete tap",
 196   .short_help = "delete tap {<interface> | sw_if_index <sw_idx>}",
 197   .function = tap_delete_command_fn,
 198 };
 199 /* *INDENT-ON* */
 200
 201 static clib_error_t *
 202 tap_offload_command_fn (vlib_main_t * vm, unformat_input_t * input,
 203                         vlib_cli_command_t * cmd)
 204 {
 205   unformat_input_t _line_input, *line_input = &_line_input;
 206   u32 sw_if_index = ~0;
 207   vnet_main_t *vnm = vnet_get_main ();
 208   int gso_enable = 0, gso_disable = 0, is_gro_coalesce = 0;
 209   int csum_offload_enable = 0, csum_offload_disable = 0;
 210   int rv = 0;
 211
 212   /* Get a line of input. */
 213   if (!unformat_user (input, unformat_line_input, line_input))
 214     return clib_error_return (0, "Missing <interface>");
 215
 216   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 217     {
 218       if (unformat (line_input, "sw_if_index %d", &sw_if_index))
 219         ;
 220       else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
 221                          vnm, &sw_if_index))
 222         ;
 223       else if (unformat (line_input, "gso-enable"))
 224         {
 225           gso_enable = 1;
 226           if (unformat (line_input, "gro-coalesce"))
 227             is_gro_coalesce = 1;
 228         }
 229       else if (unformat (line_input, "gso-disable"))
 230         gso_disable = 1;
 231       else if (unformat (line_input, "csum-offload-enable"))
 232         csum_offload_enable = 1;
 233       else if (unformat (line_input, "csum-offload-disable"))
 234         csum_offload_disable = 1;
 235       else
 236         return clib_error_return (0, "unknown input `%U'",
 237                                   format_unformat_error, input);
 238     }
 239   unformat_free (line_input);
 240
 241   if (sw_if_index == ~0)
 242     return clib_error_return (0,
 243                               "please specify interface name or sw_if_index");
 244
 245   if (gso_enable)
 246     rv = tap_gso_enable_disable (vm, sw_if_index, 1, is_gro_coalesce);
 247   else if (csum_offload_enable)
 248     rv = tap_csum_offload_enable_disable (vm, sw_if_index, 1);
 249   else if (gso_disable)
 250     rv = tap_gso_enable_disable (vm, sw_if_index, 0, 0);
 251   else if (csum_offload_disable)
 252     rv = tap_csum_offload_enable_disable (vm, sw_if_index, 0);
 253
 254   if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
 255     return clib_error_return (0, "not a tap interface");
 256   else if (rv != 0)
 257     return clib_error_return (0, "error on configuring GSO on tap interface");
 258
 259   return 0;
 260 }
 261
 262 /* *INDENT-OFF* */
 263 VLIB_CLI_COMMAND (tap_offload_command, static) =
 264 {
 265   .path = "set tap offload",
 266   .short_help = "set tap offload {<interface> | sw_if_index <sw_idx>}"
 267     " <gso-enable [gro-coalesce]  | gso-disable | csum-offload-enable |"
 268     "csum-offload-disable>",
 269   .function = tap_offload_command_fn,
 270 };
 271 /* *INDENT-ON* */
 272
 273 static clib_error_t *
 274 tap_show_command_fn (vlib_main_t * vm, unformat_input_t * input,
 275                      vlib_cli_command_t * cmd)
 276 {
 277   virtio_main_t *mm = &virtio_main;
 278   virtio_if_t *vif;
 279   vnet_main_t *vnm = vnet_get_main ();
 280   int show_descr = 0;
 281   clib_error_t *error = 0;
 282   u32 hw_if_index, *hw_if_indices = 0;
 283
 284   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 285     {
 286       if (unformat
 287           (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
 288         vec_add1 (hw_if_indices, hw_if_index);
 289       else if (unformat (input, "descriptors"))
 290         show_descr = 1;
 291       else
 292         {
 293           error = clib_error_return (0, "unknown input `%U'",
 294                                      format_unformat_error, input);
 295           goto done;
 296         }
 297     }
 298
 299   if (vec_len (hw_if_indices) == 0)
 300     {
 301       /* *INDENT-OFF* */
 302       pool_foreach (vif, mm->interfaces,
 303           vec_add1 (hw_if_indices, vif->hw_if_index);
 304       );
 305       /* *INDENT-ON* */
 306     }
 307
 308   virtio_show (vm, hw_if_indices, show_descr, VIRTIO_IF_TYPE_TAP);
 309
 310 done:
 311   vec_free (hw_if_indices);
 312   return error;
 313 }
 314
 315 /* *INDENT-OFF* */
 316 VLIB_CLI_COMMAND (tap_show_command, static) = {
 317   .path = "show tap",
 318   .short_help = "show tap {<interface>] [descriptors]",
 319   .function = tap_show_command_fn,
 320 };
 321 /* *INDENT-ON* */
 322
 323 static clib_error_t *
 324 tun_show_command_fn (vlib_main_t * vm, unformat_input_t * input,
 325                      vlib_cli_command_t * cmd)
 326 {
 327   virtio_main_t *mm = &virtio_main;
 328   virtio_if_t *vif;
 329   vnet_main_t *vnm = vnet_get_main ();
 330   int show_descr = 0;
 331   clib_error_t *error = 0;
 332   u32 hw_if_index, *hw_if_indices = 0;
 333
 334   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 335     {
 336       if (unformat
 337           (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
 338         vec_add1 (hw_if_indices, hw_if_index);
 339       else if (unformat (input, "descriptors"))
 340         show_descr = 1;
 341       else
 342         {
 343           error = clib_error_return (0, "unknown input `%U'",
 344                                      format_unformat_error, input);
 345           goto done;
 346         }
 347     }
 348
 349   if (vec_len (hw_if_indices) == 0)
 350     {
 351       /* *INDENT-OFF* */
 352       pool_foreach (vif, mm->interfaces,
 353           vec_add1 (hw_if_indices, vif->hw_if_index);
 354       );
 355       /* *INDENT-ON* */
 356     }
 357
 358   virtio_show (vm, hw_if_indices, show_descr, VIRTIO_IF_TYPE_TUN);
 359
 360 done:
 361   vec_free (hw_if_indices);
 362   return error;
 363 }
 364
 365 /* *INDENT-OFF* */
 366 VLIB_CLI_COMMAND (tun_show_command, static) = {
 367   .path = "show tun",
 368   .short_help = "show tun {<interface>] [descriptors]",
 369   .function = tun_show_command_fn,
 370 };
 371 /* *INDENT-ON* */
 372
 373 clib_error_t *
 374 tap_cli_init (vlib_main_t * vm)
 375 {
 376   return 0;
 377 }
 378
 379 VLIB_INIT_FUNCTION (tap_cli_init);
 380
 381 /*
 382  * fd.io coding-style-patch-verification: ON
 383  *
 384  * Local Variables:
 385  * eval: (c-set-style "gnu")
 386  * End:
 387  */