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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
19 #include <sys/ioctl.h>
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>
34 tap_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
35 vlib_cli_command_t * cmd)
37 unformat_input_t _line_input, *line_input = &_line_input;
38 tap_create_if_args_t args = { 0 };
45 args.num_rx_queues = 1;
47 /* Get a line of input. */
48 if (unformat_user (input, unformat_line_input, line_input))
50 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
52 if (unformat (line_input, "id %u", &args.id))
55 if (unformat (line_input, "host-if-name %s", &args.host_if_name))
57 else if (unformat (line_input, "host-ns %s", &args.host_namespace))
59 else if (unformat (line_input, "host-mac-addr %U",
60 unformat_ethernet_address,
61 args.host_mac_addr.bytes))
63 else if (unformat (line_input, "host-bridge %s", &args.host_bridge))
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))
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))
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;
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, "hw-addr %U",
104 unformat_ethernet_address, args.mac_addr.bytes))
105 args.mac_addr_set = 1;
108 unformat_free (line_input);
109 return clib_error_return (0, "unknown input `%U'",
110 format_unformat_error, input);
113 unformat_free (line_input);
116 if (ip_addr_set && args.host_bridge)
117 return clib_error_return (0, "Please specify either host ip address or "
120 tap_create_if (vm, &args);
123 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
124 vnet_get_main (), args.sw_if_index);
126 vec_free (args.host_if_name);
127 vec_free (args.host_namespace);
128 vec_free (args.host_bridge);
135 VLIB_CLI_COMMAND (tap_create_command, static) = {
136 .path = "create tap",
137 .short_help = "create tap {id <if-id>} [hw-addr <mac-address>] "
138 "[num-rx-queues <n>] [rx-ring-size <size>] [tx-ring-size <size>] "
139 "[host-ns <netns>] [host-bridge <bridge-name>] "
140 "[host-ip4-addr <ip4addr/mask>] [host-ip6-addr <ip6-addr>] "
141 "[host-ip4-gw <ip4-addr>] [host-ip6-gw <ip6-addr>] "
142 "[host-mac-addr <host-mac-address>] [host-if-name <name>] "
143 "[host-mtu-size <size>] [no-gso|gso|csum-offload|gro-coalesce] "
144 "[persist] [attach] [tun]",
145 .function = tap_create_command_fn,
149 static clib_error_t *
150 tap_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
151 vlib_cli_command_t * cmd)
153 unformat_input_t _line_input, *line_input = &_line_input;
154 u32 sw_if_index = ~0;
155 vnet_main_t *vnm = vnet_get_main ();
158 /* Get a line of input. */
159 if (!unformat_user (input, unformat_line_input, line_input))
160 return clib_error_return (0, "Missing <interface>");
162 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
164 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
166 else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
170 return clib_error_return (0, "unknown input `%U'",
171 format_unformat_error, input);
173 unformat_free (line_input);
175 if (sw_if_index == ~0)
176 return clib_error_return (0,
177 "please specify interface name or sw_if_index");
179 rv = tap_delete_if (vm, sw_if_index);
180 if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
181 return clib_error_return (0, "not a tap interface");
183 return clib_error_return (0, "error on deleting tap interface");
189 VLIB_CLI_COMMAND (tap_delete__command, static) =
191 .path = "delete tap",
192 .short_help = "delete tap {<interface> | sw_if_index <sw_idx>}",
193 .function = tap_delete_command_fn,
197 static clib_error_t *
198 tap_offload_command_fn (vlib_main_t * vm, unformat_input_t * input,
199 vlib_cli_command_t * cmd)
201 unformat_input_t _line_input, *line_input = &_line_input;
202 u32 sw_if_index = ~0;
203 vnet_main_t *vnm = vnet_get_main ();
204 int gso_enable = 0, gso_disable = 0, is_gro_coalesce = 0;
205 int csum_offload_enable = 0, csum_offload_disable = 0;
208 /* Get a line of input. */
209 if (!unformat_user (input, unformat_line_input, line_input))
210 return clib_error_return (0, "Missing <interface>");
212 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
214 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
216 else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
219 else if (unformat (line_input, "gso-enable"))
222 if (unformat (line_input, "gro-coalesce"))
225 else if (unformat (line_input, "gso-disable"))
227 else if (unformat (line_input, "csum-offload-enable"))
228 csum_offload_enable = 1;
229 else if (unformat (line_input, "csum-offload-disable"))
230 csum_offload_disable = 1;
232 return clib_error_return (0, "unknown input `%U'",
233 format_unformat_error, input);
235 unformat_free (line_input);
237 if (sw_if_index == ~0)
238 return clib_error_return (0,
239 "please specify interface name or sw_if_index");
242 rv = tap_gso_enable_disable (vm, sw_if_index, 1, is_gro_coalesce);
243 else if (csum_offload_enable)
244 rv = tap_csum_offload_enable_disable (vm, sw_if_index, 1);
245 else if (gso_disable)
246 rv = tap_gso_enable_disable (vm, sw_if_index, 0, 0);
247 else if (csum_offload_disable)
248 rv = tap_csum_offload_enable_disable (vm, sw_if_index, 0);
250 if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
251 return clib_error_return (0, "not a tap interface");
253 return clib_error_return (0, "error on configuring GSO on tap interface");
259 VLIB_CLI_COMMAND (tap_offload_command, static) =
261 .path = "set tap offload",
262 .short_help = "set tap offload {<interface> | sw_if_index <sw_idx>}"
263 " <gso-enable [gro-coalesce] | gso-disable | csum-offload-enable |"
264 "csum-offload-disable>",
265 .function = tap_offload_command_fn,
269 static clib_error_t *
270 tap_show_command_fn (vlib_main_t * vm, unformat_input_t * input,
271 vlib_cli_command_t * cmd)
273 virtio_main_t *mm = &virtio_main;
275 vnet_main_t *vnm = vnet_get_main ();
277 clib_error_t *error = 0;
278 u32 hw_if_index, *hw_if_indices = 0;
280 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
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"))
289 error = clib_error_return (0, "unknown input `%U'",
290 format_unformat_error, input);
295 if (vec_len (hw_if_indices) == 0)
298 pool_foreach (vif, mm->interfaces,
299 vec_add1 (hw_if_indices, vif->hw_if_index);
304 virtio_show (vm, hw_if_indices, show_descr, VIRTIO_IF_TYPE_TAP);
307 vec_free (hw_if_indices);
312 VLIB_CLI_COMMAND (tap_show_command, static) = {
314 .short_help = "show tap {<interface>] [descriptors]",
315 .function = tap_show_command_fn,
319 static clib_error_t *
320 tun_show_command_fn (vlib_main_t * vm, unformat_input_t * input,
321 vlib_cli_command_t * cmd)
323 virtio_main_t *mm = &virtio_main;
325 vnet_main_t *vnm = vnet_get_main ();
327 clib_error_t *error = 0;
328 u32 hw_if_index, *hw_if_indices = 0;
330 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
333 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
334 vec_add1 (hw_if_indices, hw_if_index);
335 else if (unformat (input, "descriptors"))
339 error = clib_error_return (0, "unknown input `%U'",
340 format_unformat_error, input);
345 if (vec_len (hw_if_indices) == 0)
348 pool_foreach (vif, mm->interfaces,
349 vec_add1 (hw_if_indices, vif->hw_if_index);
354 virtio_show (vm, hw_if_indices, show_descr, VIRTIO_IF_TYPE_TUN);
357 vec_free (hw_if_indices);
362 VLIB_CLI_COMMAND (tun_show_command, static) = {
364 .short_help = "show tun {<interface>] [descriptors]",
365 .function = tun_show_command_fn,
370 tap_cli_init (vlib_main_t * vm)
375 VLIB_INIT_FUNCTION (tap_cli_init);
378 * fd.io coding-style-patch-verification: ON
381 * eval: (c-set-style "gnu")