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 };
43 /* Get a line of input. */
44 if (unformat_user (input, unformat_line_input, line_input))
46 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
48 if (unformat (line_input, "id %u", &args.id))
51 if (unformat (line_input, "host-if-name %s", &args.host_if_name))
53 else if (unformat (line_input, "host-ns %s", &args.host_namespace))
55 else if (unformat (line_input, "host-mac-addr %U",
56 unformat_ethernet_address, args.host_mac_addr))
58 else if (unformat (line_input, "host-bridge %s", &args.host_bridge))
60 else if (unformat (line_input, "host-ip4-addr %U/%d",
61 unformat_ip4_address, &args.host_ip4_addr,
62 &args.host_ip4_prefix_len))
64 else if (unformat (line_input, "host-ip4-gw %U",
65 unformat_ip4_address, &args.host_ip4_gw))
66 args.host_ip4_gw_set = 1;
67 else if (unformat (line_input, "host-ip6-addr %U/%d",
68 unformat_ip6_address, &args.host_ip6_addr,
69 &args.host_ip6_prefix_len))
71 else if (unformat (line_input, "host-ip6-gw %U",
72 unformat_ip6_address, &args.host_ip6_gw))
73 args.host_ip6_gw_set = 1;
74 else if (unformat (line_input, "rx-ring-size %d", &args.rx_ring_sz))
76 else if (unformat (line_input, "tx-ring-size %d", &args.tx_ring_sz))
78 else if (unformat (line_input, "hw-addr %U",
79 unformat_ethernet_address, args.mac_addr))
80 args.mac_addr_set = 1;
83 unformat_free (line_input);
84 return clib_error_return (0, "unknown input `%U'",
85 format_unformat_error, input);
88 unformat_free (line_input);
91 if (ip_addr_set && args.host_bridge)
92 return clib_error_return (0, "Please specify either host ip address or "
95 tap_create_if (vm, &args);
97 vec_free (args.host_if_name);
98 vec_free (args.host_namespace);
99 vec_free (args.host_bridge);
106 VLIB_CLI_COMMAND (tap_create_command, static) = {
107 .path = "create tap",
108 .short_help = "create tap {id <if-id>} [hw-addr <mac-address>] "
109 "[rx-ring-size <size>] [tx-ring-size <size>] [host-ns <netns>] "
110 "[host-bridge <bridge-name>] [host-ip4-addr <ip4addr/mask>] "
111 "[host-ip6-addr <ip6-addr>] [host-ip4-gw <ip4-addr>] "
112 "[host-ip6-gw <ip6-addr>] [host-if-name <name>]",
113 .function = tap_create_command_fn,
117 static clib_error_t *
118 tap_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
119 vlib_cli_command_t * cmd)
121 unformat_input_t _line_input, *line_input = &_line_input;
122 u32 sw_if_index = ~0;
123 vnet_main_t *vnm = vnet_get_main ();
126 /* Get a line of input. */
127 if (!unformat_user (input, unformat_line_input, line_input))
128 return clib_error_return (0, "Missing <interface>");
130 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
132 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
134 else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
138 return clib_error_return (0, "unknown input `%U'",
139 format_unformat_error, input);
141 unformat_free (line_input);
143 if (sw_if_index == ~0)
144 return clib_error_return (0,
145 "please specify interface name or sw_if_index");
147 rv = tap_delete_if (vm, sw_if_index);
148 if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
149 return clib_error_return (0, "not a tap interface");
151 return clib_error_return (0, "error on deleting tap interface");
157 VLIB_CLI_COMMAND (tap_delete__command, static) =
159 .path = "delete tap",
160 .short_help = "delete tap {<interface> | sw_if_index <sw_idx>}",
161 .function = tap_delete_command_fn,
165 static clib_error_t *
166 tap_show_command_fn (vlib_main_t * vm, unformat_input_t * input,
167 vlib_cli_command_t * cmd)
169 virtio_main_t *mm = &virtio_main;
171 vnet_main_t *vnm = vnet_get_main ();
173 clib_error_t *error = 0;
174 u32 hw_if_index, *hw_if_indices = 0;
175 virtio_vring_t *vring;
182 struct feat_struct *feat_entry;
184 static struct feat_struct feat_array[] = {
185 #define _(s,b) { .str = #s, .bit = b, },
186 foreach_virtio_net_features
191 struct feat_struct *flag_entry;
192 static struct feat_struct flags_array[] = {
193 #define _(b,e,s) { .bit = b, .str = s, },
194 foreach_virtio_if_flag
199 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
202 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
203 vec_add1 (hw_if_indices, hw_if_index);
204 else if (unformat (input, "descriptors"))
208 error = clib_error_return (0, "unknown input `%U'",
209 format_unformat_error, input);
214 if (vec_len (hw_if_indices) == 0)
217 pool_foreach (vif, mm->interfaces,
218 vec_add1 (hw_if_indices, vif->hw_if_index);
223 for (hw_if_index = 0; hw_if_index < vec_len (hw_if_indices); hw_if_index++)
225 vnet_hw_interface_t *hi =
226 vnet_get_hw_interface (vnm, hw_if_indices[hw_if_index]);
227 vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
228 vlib_cli_output (vm, "interface %U", format_vnet_sw_if_index_name,
229 vnm, vif->sw_if_index);
230 if (vif->host_if_name)
231 vlib_cli_output (vm, " name \"%s\"", vif->host_if_name);
233 vlib_cli_output (vm, " host-ns \"%s\"", vif->net_ns);
234 vlib_cli_output (vm, " flags 0x%x", vif->flags);
235 flag_entry = (struct feat_struct *) &flags_array;
236 while (flag_entry->str)
238 if (vif->flags & (1ULL << flag_entry->bit))
239 vlib_cli_output (vm, " %s (%d)", flag_entry->str,
243 vlib_cli_output (vm, " fd %d", vif->fd);
244 vlib_cli_output (vm, " tap-fd %d", vif->tap_fd);
245 vlib_cli_output (vm, " features 0x%lx", vif->features);
246 feat_entry = (struct feat_struct *) &feat_array;
247 while (feat_entry->str)
249 if (vif->features & (1ULL << feat_entry->bit))
250 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
254 vlib_cli_output (vm, " remote-features 0x%lx", vif->remote_features);
255 feat_entry = (struct feat_struct *) &feat_array;
256 while (feat_entry->str)
258 if (vif->remote_features & (1ULL << feat_entry->bit))
259 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
263 vec_foreach_index (i, vif->vrings)
266 vring = vec_elt_at_index (vif->vrings, i);
267 vlib_cli_output (vm, " Virtqueue (%s)", (i & 1) ? "TX" : "RX");
268 vlib_cli_output (vm, " qsz %d, last_used_idx %d, desc_in_use %d",
269 vring->size, vring->last_used_idx,
272 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
273 vring->avail->flags, vring->avail->idx,
274 vring->used->flags, vring->used->idx);
275 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
279 vlib_cli_output (vm, "\n descriptor table:\n");
281 " id addr len flags next user_addr\n");
283 " ===== ================== ===== ====== ===== ==================\n");
285 for (j = 0; j < vring->size; j++)
287 struct vring_desc *desc = &vring->desc[j];
289 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
292 desc->flags, desc->next, desc->addr);
298 vec_free (hw_if_indices);
303 VLIB_CLI_COMMAND (tap_show_command, static) = {
305 .short_help = "show tap {<interface>] [descriptors]",
306 .function = tap_show_command_fn,
311 tap_cli_init (vlib_main_t * vm)
316 VLIB_INIT_FUNCTION (tap_cli_init);
319 * fd.io coding-style-patch-verification: ON
322 * eval: (c-set-style "gnu")