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, "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, "tun"))
100 args.tap_flags |= TAP_FLAG_TUN;
101 else if (unformat (line_input, "hw-addr %U",
102 unformat_ethernet_address, args.mac_addr.bytes))
103 args.mac_addr_set = 1;
106 unformat_free (line_input);
107 return clib_error_return (0, "unknown input `%U'",
108 format_unformat_error, input);
111 unformat_free (line_input);
114 if (ip_addr_set && args.host_bridge)
115 return clib_error_return (0, "Please specify either host ip address or "
118 tap_create_if (vm, &args);
121 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
122 vnet_get_main (), args.sw_if_index);
124 vec_free (args.host_if_name);
125 vec_free (args.host_namespace);
126 vec_free (args.host_bridge);
133 VLIB_CLI_COMMAND (tap_create_command, static) = {
134 .path = "create tap",
135 .short_help = "create tap {id <if-id>} [hw-addr <mac-address>] "
136 "[num-rx-queues <n>] [rx-ring-size <size>] [tx-ring-size <size>] "
137 "[host-ns <netns>] [host-bridge <bridge-name>] "
138 "[host-ip4-addr <ip4addr/mask>] [host-ip6-addr <ip6-addr>] "
139 "[host-ip4-gw <ip4-addr>] [host-ip6-gw <ip6-addr>] "
140 "[host-mac-addr <host-mac-address>] [host-if-name <name>] "
141 "[host-mtu-size <size>] [no-gso|gso|csum-offload] [persist] [attach] [tun]",
142 .function = tap_create_command_fn,
146 static clib_error_t *
147 tap_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
148 vlib_cli_command_t * cmd)
150 unformat_input_t _line_input, *line_input = &_line_input;
151 u32 sw_if_index = ~0;
152 vnet_main_t *vnm = vnet_get_main ();
155 /* Get a line of input. */
156 if (!unformat_user (input, unformat_line_input, line_input))
157 return clib_error_return (0, "Missing <interface>");
159 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
161 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
163 else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
167 return clib_error_return (0, "unknown input `%U'",
168 format_unformat_error, input);
170 unformat_free (line_input);
172 if (sw_if_index == ~0)
173 return clib_error_return (0,
174 "please specify interface name or sw_if_index");
176 rv = tap_delete_if (vm, sw_if_index);
177 if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
178 return clib_error_return (0, "not a tap interface");
180 return clib_error_return (0, "error on deleting tap interface");
186 VLIB_CLI_COMMAND (tap_delete__command, static) =
188 .path = "delete tap",
189 .short_help = "delete tap {<interface> | sw_if_index <sw_idx>}",
190 .function = tap_delete_command_fn,
194 static clib_error_t *
195 tap_offload_command_fn (vlib_main_t * vm, unformat_input_t * input,
196 vlib_cli_command_t * cmd)
198 unformat_input_t _line_input, *line_input = &_line_input;
199 u32 sw_if_index = ~0;
200 vnet_main_t *vnm = vnet_get_main ();
201 int gso_enable = 0, gso_disable = 0;
202 int csum_offload_enable = 0, csum_offload_disable = 0;
205 /* Get a line of input. */
206 if (!unformat_user (input, unformat_line_input, line_input))
207 return clib_error_return (0, "Missing <interface>");
209 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
211 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
213 else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
216 else if (unformat (line_input, "gso-enable"))
218 else if (unformat (line_input, "gso-disable"))
220 else if (unformat (line_input, "csum-offload-enable"))
221 csum_offload_enable = 1;
222 else if (unformat (line_input, "csum-offload-disable"))
223 csum_offload_disable = 1;
225 return clib_error_return (0, "unknown input `%U'",
226 format_unformat_error, input);
228 unformat_free (line_input);
230 if (sw_if_index == ~0)
231 return clib_error_return (0,
232 "please specify interface name or sw_if_index");
235 rv = tap_gso_enable_disable (vm, sw_if_index, 1);
236 else if (csum_offload_enable)
237 rv = tap_csum_offload_enable_disable (vm, sw_if_index, 1);
238 else if (gso_disable)
239 rv = tap_gso_enable_disable (vm, sw_if_index, 0);
240 else if (csum_offload_disable)
241 rv = tap_csum_offload_enable_disable (vm, sw_if_index, 0);
243 if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
244 return clib_error_return (0, "not a tap interface");
246 return clib_error_return (0, "error on configuring GSO on tap interface");
252 VLIB_CLI_COMMAND (tap_offload_command, static) =
254 .path = "set tap offload",
255 .short_help = "set tap offload {<interface> | sw_if_index <sw_idx>}"
256 " <gso-enable | gso-disable | csum-offload-enable | csum-offload-disable>",
257 .function = tap_offload_command_fn,
261 static clib_error_t *
262 tap_show_command_fn (vlib_main_t * vm, unformat_input_t * input,
263 vlib_cli_command_t * cmd)
265 virtio_main_t *mm = &virtio_main;
267 vnet_main_t *vnm = vnet_get_main ();
269 clib_error_t *error = 0;
270 u32 hw_if_index, *hw_if_indices = 0;
272 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
275 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
276 vec_add1 (hw_if_indices, hw_if_index);
277 else if (unformat (input, "descriptors"))
281 error = clib_error_return (0, "unknown input `%U'",
282 format_unformat_error, input);
287 if (vec_len (hw_if_indices) == 0)
290 pool_foreach (vif, mm->interfaces,
291 vec_add1 (hw_if_indices, vif->hw_if_index);
296 virtio_show (vm, hw_if_indices, show_descr, VIRTIO_IF_TYPE_TAP);
299 vec_free (hw_if_indices);
304 VLIB_CLI_COMMAND (tap_show_command, static) = {
306 .short_help = "show tap {<interface>] [descriptors]",
307 .function = tap_show_command_fn,
311 static clib_error_t *
312 tun_show_command_fn (vlib_main_t * vm, unformat_input_t * input,
313 vlib_cli_command_t * cmd)
315 virtio_main_t *mm = &virtio_main;
317 vnet_main_t *vnm = vnet_get_main ();
319 clib_error_t *error = 0;
320 u32 hw_if_index, *hw_if_indices = 0;
322 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
325 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
326 vec_add1 (hw_if_indices, hw_if_index);
327 else if (unformat (input, "descriptors"))
331 error = clib_error_return (0, "unknown input `%U'",
332 format_unformat_error, input);
337 if (vec_len (hw_if_indices) == 0)
340 pool_foreach (vif, mm->interfaces,
341 vec_add1 (hw_if_indices, vif->hw_if_index);
346 virtio_show (vm, hw_if_indices, show_descr, VIRTIO_IF_TYPE_TUN);
349 vec_free (hw_if_indices);
354 VLIB_CLI_COMMAND (tun_show_command, static) = {
356 .short_help = "show tun {<interface>] [descriptors]",
357 .function = tun_show_command_fn,
362 tap_cli_init (vlib_main_t * vm)
367 VLIB_INIT_FUNCTION (tap_cli_init);
370 * fd.io coding-style-patch-verification: ON
373 * eval: (c-set-style "gnu")