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, args.host_mac_addr))
62 else if (unformat (line_input, "host-bridge %s", &args.host_bridge))
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))
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))
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, "rx-ring-size %d", &tmp))
81 args.rx_ring_sz = tmp;
82 else if (unformat (line_input, "tx-ring-size %d", &tmp))
83 args.tx_ring_sz = tmp;
86 (line_input, "host-mtu-size %d", &args.host_mtu_size))
87 args.host_mtu_set = 1;
88 else if (unformat (line_input, "no-gso"))
89 args.tap_flags &= ~TAP_FLAG_GSO;
90 else if (unformat (line_input, "gso"))
91 args.tap_flags |= TAP_FLAG_GSO;
92 else if (unformat (line_input, "csum-offload"))
93 args.tap_flags |= TAP_FLAG_CSUM_OFFLOAD;
94 else if (unformat (line_input, "hw-addr %U",
95 unformat_ethernet_address, args.mac_addr.bytes))
96 args.mac_addr_set = 1;
99 unformat_free (line_input);
100 return clib_error_return (0, "unknown input `%U'",
101 format_unformat_error, input);
104 unformat_free (line_input);
107 if (ip_addr_set && args.host_bridge)
108 return clib_error_return (0, "Please specify either host ip address or "
111 tap_create_if (vm, &args);
114 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
115 vnet_get_main (), args.sw_if_index);
117 vec_free (args.host_if_name);
118 vec_free (args.host_namespace);
119 vec_free (args.host_bridge);
126 VLIB_CLI_COMMAND (tap_create_command, static) = {
127 .path = "create tap",
128 .short_help = "create tap {id <if-id>} [hw-addr <mac-address>] "
129 "[rx-ring-size <size>] [tx-ring-size <size>] [host-ns <netns>] "
130 "[host-bridge <bridge-name>] [host-ip4-addr <ip4addr/mask>] "
131 "[host-ip6-addr <ip6-addr>] [host-ip4-gw <ip4-addr>] "
132 "[host-ip6-gw <ip6-addr>] [host-mac-addr <host-mac-address>] "
133 "[host-if-name <name>] [host-mtu-size <size>] [no-gso|gso|csum-offload]",
134 .function = tap_create_command_fn,
138 static clib_error_t *
139 tap_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
140 vlib_cli_command_t * cmd)
142 unformat_input_t _line_input, *line_input = &_line_input;
143 u32 sw_if_index = ~0;
144 vnet_main_t *vnm = vnet_get_main ();
147 /* Get a line of input. */
148 if (!unformat_user (input, unformat_line_input, line_input))
149 return clib_error_return (0, "Missing <interface>");
151 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
153 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
155 else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
159 return clib_error_return (0, "unknown input `%U'",
160 format_unformat_error, input);
162 unformat_free (line_input);
164 if (sw_if_index == ~0)
165 return clib_error_return (0,
166 "please specify interface name or sw_if_index");
168 rv = tap_delete_if (vm, sw_if_index);
169 if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
170 return clib_error_return (0, "not a tap interface");
172 return clib_error_return (0, "error on deleting tap interface");
178 VLIB_CLI_COMMAND (tap_delete__command, static) =
180 .path = "delete tap",
181 .short_help = "delete tap {<interface> | sw_if_index <sw_idx>}",
182 .function = tap_delete_command_fn,
186 static clib_error_t *
187 tap_offload_command_fn (vlib_main_t * vm, unformat_input_t * input,
188 vlib_cli_command_t * cmd)
190 unformat_input_t _line_input, *line_input = &_line_input;
191 u32 sw_if_index = ~0;
192 vnet_main_t *vnm = vnet_get_main ();
193 int gso_enable = 0, gso_disable = 0;
194 int csum_offload_enable = 0, csum_offload_disable = 0;
197 /* Get a line of input. */
198 if (!unformat_user (input, unformat_line_input, line_input))
199 return clib_error_return (0, "Missing <interface>");
201 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
203 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
205 else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
208 else if (unformat (line_input, "gso-enable"))
210 else if (unformat (line_input, "gso-disable"))
212 else if (unformat (line_input, "csum-offload-enable"))
213 csum_offload_enable = 1;
214 else if (unformat (line_input, "csum-offload-disable"))
215 csum_offload_disable = 1;
217 return clib_error_return (0, "unknown input `%U'",
218 format_unformat_error, input);
220 unformat_free (line_input);
222 if (sw_if_index == ~0)
223 return clib_error_return (0,
224 "please specify interface name or sw_if_index");
227 rv = tap_gso_enable_disable (vm, sw_if_index, 1);
228 else if (csum_offload_enable)
229 rv = tap_csum_offload_enable_disable (vm, sw_if_index, 1);
230 else if (gso_disable)
231 rv = tap_gso_enable_disable (vm, sw_if_index, 0);
232 else if (csum_offload_disable)
233 rv = tap_csum_offload_enable_disable (vm, sw_if_index, 0);
235 if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
236 return clib_error_return (0, "not a tap interface");
238 return clib_error_return (0, "error on configuring GSO on tap interface");
244 VLIB_CLI_COMMAND (tap_offload_command, static) =
246 .path = "set tap offload",
247 .short_help = "set tap offload {<interface> | sw_if_index <sw_idx>}"
248 " <gso-enable | gso-disable | csum-offload-enable | csum-offload-disable>",
249 .function = tap_offload_command_fn,
253 static clib_error_t *
254 tap_show_command_fn (vlib_main_t * vm, unformat_input_t * input,
255 vlib_cli_command_t * cmd)
257 virtio_main_t *mm = &virtio_main;
259 vnet_main_t *vnm = vnet_get_main ();
261 clib_error_t *error = 0;
262 u32 hw_if_index, *hw_if_indices = 0;
264 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
267 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
268 vec_add1 (hw_if_indices, hw_if_index);
269 else if (unformat (input, "descriptors"))
273 error = clib_error_return (0, "unknown input `%U'",
274 format_unformat_error, input);
279 if (vec_len (hw_if_indices) == 0)
282 pool_foreach (vif, mm->interfaces,
283 vec_add1 (hw_if_indices, vif->hw_if_index);
288 virtio_show (vm, hw_if_indices, show_descr, VIRTIO_IF_TYPE_TAP);
291 vec_free (hw_if_indices);
296 VLIB_CLI_COMMAND (tap_show_command, static) = {
298 .short_help = "show tap {<interface>] [descriptors]",
299 .function = tap_show_command_fn,
304 tap_cli_init (vlib_main_t * vm)
309 VLIB_INIT_FUNCTION (tap_cli_init);
312 * fd.io coding-style-patch-verification: ON
315 * eval: (c-set-style "gnu")