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-ip6-addr %U/%d",
65 unformat_ip6_address, &args.host_ip6_addr,
66 &args.host_ip6_prefix_len))
68 else if (unformat (line_input, "rx-ring-size %d", &args.rx_ring_sz))
70 else if (unformat (line_input, "tx-ring-size %d", &args.tx_ring_sz))
72 else if (unformat (line_input, "hw-addr %U",
73 unformat_ethernet_address, args.mac_addr))
74 args.mac_addr_set = 1;
77 unformat_free (line_input);
78 return clib_error_return (0, "unknown input `%U'",
79 format_unformat_error, input);
82 unformat_free (line_input);
85 if (ip_addr_set && args.host_bridge)
86 return clib_error_return (0, "Please specify either host ip address or "
89 tap_create_if (vm, &args);
91 vec_free (args.host_if_name);
92 vec_free (args.host_namespace);
93 vec_free (args.host_bridge);
100 VLIB_CLI_COMMAND (tap_create_command, static) = {
101 .path = "create tap",
102 .short_help = "create tap {id <if-id>} [hw-addr <mac-address>] "
103 "[rx-ring-size <size>] [tx-ring-size <size>] [host-ns <netns>] "
104 "[host-bridge <bridge-name>] [host-ip4-addr <ip4addr/mask>] "
105 "[host-ip6-addr <ip6-addr] [host-if-name <name>]",
106 .function = tap_create_command_fn,
110 static clib_error_t *
111 tap_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
112 vlib_cli_command_t * cmd)
114 unformat_input_t _line_input, *line_input = &_line_input;
115 u32 sw_if_index = ~0;
116 vnet_main_t *vnm = vnet_get_main ();
119 /* Get a line of input. */
120 if (!unformat_user (input, unformat_line_input, line_input))
121 return clib_error_return (0, "Missing <interface>");
123 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
125 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
127 else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
131 return clib_error_return (0, "unknown input `%U'",
132 format_unformat_error, input);
134 unformat_free (line_input);
136 if (sw_if_index == ~0)
137 return clib_error_return (0,
138 "please specify interface name or sw_if_index");
140 rv = tap_delete_if (vm, sw_if_index);
141 if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
142 return clib_error_return (0, "not a tap interface");
144 return clib_error_return (0, "error on deleting tap interface");
150 VLIB_CLI_COMMAND (tap_delete__command, static) =
152 .path = "delete tap",
153 .short_help = "delete tap {<interface> | sw_if_index <sw_idx>}",
154 .function = tap_delete_command_fn,
158 static clib_error_t *
159 tap_show_command_fn (vlib_main_t * vm, unformat_input_t * input,
160 vlib_cli_command_t * cmd)
162 virtio_main_t *mm = &virtio_main;
164 vnet_main_t *vnm = vnet_get_main ();
166 clib_error_t *error = 0;
167 u32 hw_if_index, *hw_if_indices = 0;
168 virtio_vring_t *vring;
175 struct feat_struct *feat_entry;
177 static struct feat_struct feat_array[] = {
178 #define _(s,b) { .str = #s, .bit = b, },
179 foreach_virtio_net_features
184 struct feat_struct *flag_entry;
185 static struct feat_struct flags_array[] = {
186 #define _(b,e,s) { .bit = b, .str = s, },
187 foreach_virtio_if_flag
192 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
195 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
196 vec_add1 (hw_if_indices, hw_if_index);
197 else if (unformat (input, "descriptors"))
201 error = clib_error_return (0, "unknown input `%U'",
202 format_unformat_error, input);
207 if (vec_len (hw_if_indices) == 0)
210 pool_foreach (vif, mm->interfaces,
211 vec_add1 (hw_if_indices, vif->hw_if_index);
216 for (hw_if_index = 0; hw_if_index < vec_len (hw_if_indices); hw_if_index++)
218 vnet_hw_interface_t *hi =
219 vnet_get_hw_interface (vnm, hw_if_indices[hw_if_index]);
220 vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
221 vlib_cli_output (vm, "interface %U", format_vnet_sw_if_index_name,
222 vnm, vif->sw_if_index);
223 if (vif->host_if_name)
224 vlib_cli_output (vm, " name \"%s\"", vif->host_if_name);
226 vlib_cli_output (vm, " host-ns \"%s\"", vif->net_ns);
227 vlib_cli_output (vm, " flags 0x%x", vif->flags);
228 flag_entry = (struct feat_struct *) &flags_array;
229 while (flag_entry->str)
231 if (vif->flags & (1ULL << flag_entry->bit))
232 vlib_cli_output (vm, " %s (%d)", flag_entry->str,
236 vlib_cli_output (vm, " fd %d", vif->fd);
237 vlib_cli_output (vm, " tap-fd %d", vif->tap_fd);
238 vlib_cli_output (vm, " features 0x%lx", vif->features);
239 feat_entry = (struct feat_struct *) &feat_array;
240 while (feat_entry->str)
242 if (vif->features & (1ULL << feat_entry->bit))
243 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
247 vlib_cli_output (vm, " remote-features 0x%lx", vif->remote_features);
248 feat_entry = (struct feat_struct *) &feat_array;
249 while (feat_entry->str)
251 if (vif->remote_features & (1ULL << feat_entry->bit))
252 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
256 vec_foreach_index (i, vif->vrings)
259 vring = vec_elt_at_index (vif->vrings, i);
260 vlib_cli_output (vm, " Virtqueue (%s)", (i & 1) ? "TX" : "RX");
261 vlib_cli_output (vm, " qsz %d, last_used_idx %d, desc_in_use %d",
262 vring->size, vring->last_used_idx,
265 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
266 vring->avail->flags, vring->avail->idx,
267 vring->used->flags, vring->used->idx);
268 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
272 vlib_cli_output (vm, "\n descriptor table:\n");
274 " id addr len flags next user_addr\n");
276 " ===== ================== ===== ====== ===== ==================\n");
278 for (j = 0; j < vring->size; j++)
280 struct vring_desc *desc = &vring->desc[j];
282 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
285 desc->flags, desc->next, desc->addr);
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")