FD.io VPP  v20.05.1-6-gf53edbc3b
Vector Packet Processing
cli.c
Go to the documentation of this file.
1 /*
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:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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  *------------------------------------------------------------------
16  */
17 #include <stdint.h>
18 #include <net/if.h>
19 #include <sys/ioctl.h>
20 #include <inttypes.h>
21 
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>
31 #include <vnet/devices/tap/tap.h>
32 
33 static clib_error_t *
35  vlib_cli_command_t * cmd)
36 {
37  unformat_input_t _line_input, *line_input = &_line_input;
38  tap_create_if_args_t args = { 0 };
39  int ip_addr_set = 0;
40  u32 tmp;
41 
42  args.id = ~0;
43  args.tap_flags = 0;
44  args.rv = -1;
45  args.num_rx_queues = 1;
46 
47  /* Get a line of input. */
48  if (unformat_user (input, unformat_line_input, line_input))
49  {
50  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
51  {
52  if (unformat (line_input, "id %u", &args.id))
53  ;
54  else
55  if (unformat (line_input, "host-if-name %s", &args.host_if_name))
56  ;
57  else if (unformat (line_input, "host-ns %s", &args.host_namespace))
58  ;
59  else if (unformat (line_input, "host-mac-addr %U",
61  args.host_mac_addr.bytes))
62  ;
63  else if (unformat (line_input, "host-bridge %s", &args.host_bridge))
64  ;
65  else if (unformat (line_input, "host-ip4-addr %U/%d",
67  &args.host_ip4_prefix_len))
68  ip_addr_set = 1;
69  else if (unformat (line_input, "host-ip4-gw %U",
71  args.host_ip4_gw_set = 1;
72  else if (unformat (line_input, "host-ip6-addr %U/%d",
74  &args.host_ip6_prefix_len))
75  ip_addr_set = 1;
76  else if (unformat (line_input, "host-ip6-gw %U",
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;
85  else
86  if (unformat
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",
105  args.mac_addr_set = 1;
106  else
107  {
108  unformat_free (line_input);
109  return clib_error_return (0, "unknown input `%U'",
110  format_unformat_error, input);
111  }
112  }
113  unformat_free (line_input);
114  }
115 
116  if (ip_addr_set && args.host_bridge)
117  return clib_error_return (0, "Please specify either host ip address or "
118  "host bridge");
119 
120  tap_create_if (vm, &args);
121 
122  if (!args.rv)
124  vnet_get_main (), args.sw_if_index);
125 
126  vec_free (args.host_if_name);
127  vec_free (args.host_namespace);
128  vec_free (args.host_bridge);
129 
130  return args.error;
131 
132 }
133 
134 /* *INDENT-OFF* */
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,
146 };
147 /* *INDENT-ON* */
148 
149 static clib_error_t *
151  vlib_cli_command_t * cmd)
152 {
153  unformat_input_t _line_input, *line_input = &_line_input;
154  u32 sw_if_index = ~0;
155  vnet_main_t *vnm = vnet_get_main ();
156  int rv;
157 
158  /* Get a line of input. */
159  if (!unformat_user (input, unformat_line_input, line_input))
160  return clib_error_return (0, "Missing <interface>");
161 
162  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
163  {
164  if (unformat (line_input, "sw_if_index %d", &sw_if_index))
165  ;
166  else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
167  vnm, &sw_if_index))
168  ;
169  else
170  return clib_error_return (0, "unknown input `%U'",
171  format_unformat_error, input);
172  }
173  unformat_free (line_input);
174 
175  if (sw_if_index == ~0)
176  return clib_error_return (0,
177  "please specify interface name or sw_if_index");
178 
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");
182  else if (rv != 0)
183  return clib_error_return (0, "error on deleting tap interface");
184 
185  return 0;
186 }
187 
188 /* *INDENT-OFF* */
189 VLIB_CLI_COMMAND (tap_delete__command, static) =
190 {
191  .path = "delete tap",
192  .short_help = "delete tap {<interface> | sw_if_index <sw_idx>}",
193  .function = tap_delete_command_fn,
194 };
195 /* *INDENT-ON* */
196 
197 static clib_error_t *
199  vlib_cli_command_t * cmd)
200 {
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;
205  int csum_offload_enable = 0, csum_offload_disable = 0;
206  int rv = 0;
207 
208  /* Get a line of input. */
209  if (!unformat_user (input, unformat_line_input, line_input))
210  return clib_error_return (0, "Missing <interface>");
211 
212  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
213  {
214  if (unformat (line_input, "sw_if_index %d", &sw_if_index))
215  ;
216  else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
217  vnm, &sw_if_index))
218  ;
219  else if (unformat (line_input, "gso-enable"))
220  gso_enable = 1;
221  else if (unformat (line_input, "gso-disable"))
222  gso_disable = 1;
223  else if (unformat (line_input, "csum-offload-enable"))
224  csum_offload_enable = 1;
225  else if (unformat (line_input, "csum-offload-disable"))
226  csum_offload_disable = 1;
227  else
228  return clib_error_return (0, "unknown input `%U'",
229  format_unformat_error, input);
230  }
231  unformat_free (line_input);
232 
233  if (sw_if_index == ~0)
234  return clib_error_return (0,
235  "please specify interface name or sw_if_index");
236 
237  if (gso_enable)
238  rv = tap_gso_enable_disable (vm, sw_if_index, 1);
239  else if (csum_offload_enable)
240  rv = tap_csum_offload_enable_disable (vm, sw_if_index, 1);
241  else if (gso_disable)
242  rv = tap_gso_enable_disable (vm, sw_if_index, 0);
243  else if (csum_offload_disable)
244  rv = tap_csum_offload_enable_disable (vm, sw_if_index, 0);
245 
246  if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
247  return clib_error_return (0, "not a tap interface");
248  else if (rv != 0)
249  return clib_error_return (0, "error on configuring GSO on tap interface");
250 
251  return 0;
252 }
253 
254 /* *INDENT-OFF* */
255 VLIB_CLI_COMMAND (tap_offload_command, static) =
256 {
257  .path = "set tap offload",
258  .short_help = "set tap offload {<interface> | sw_if_index <sw_idx>}"
259  " <gso-enable | gso-disable | csum-offload-enable | csum-offload-disable>",
260  .function = tap_offload_command_fn,
261 };
262 /* *INDENT-ON* */
263 
264 static clib_error_t *
266  vlib_cli_command_t * cmd)
267 {
268  virtio_main_t *mm = &virtio_main;
269  virtio_if_t *vif;
270  vnet_main_t *vnm = vnet_get_main ();
271  int show_descr = 0;
272  clib_error_t *error = 0;
273  u32 hw_if_index, *hw_if_indices = 0;
274 
276  {
277  if (unformat
278  (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
279  vec_add1 (hw_if_indices, hw_if_index);
280  else if (unformat (input, "descriptors"))
281  show_descr = 1;
282  else
283  {
284  error = clib_error_return (0, "unknown input `%U'",
285  format_unformat_error, input);
286  goto done;
287  }
288  }
289 
290  if (vec_len (hw_if_indices) == 0)
291  {
292  /* *INDENT-OFF* */
293  pool_foreach (vif, mm->interfaces,
294  vec_add1 (hw_if_indices, vif->hw_if_index);
295  );
296  /* *INDENT-ON* */
297  }
298 
299  virtio_show (vm, hw_if_indices, show_descr, VIRTIO_IF_TYPE_TAP);
300 
301 done:
302  vec_free (hw_if_indices);
303  return error;
304 }
305 
306 /* *INDENT-OFF* */
307 VLIB_CLI_COMMAND (tap_show_command, static) = {
308  .path = "show tap",
309  .short_help = "show tap {<interface>] [descriptors]",
310  .function = tap_show_command_fn,
311 };
312 /* *INDENT-ON* */
313 
314 static clib_error_t *
316  vlib_cli_command_t * cmd)
317 {
318  virtio_main_t *mm = &virtio_main;
319  virtio_if_t *vif;
320  vnet_main_t *vnm = vnet_get_main ();
321  int show_descr = 0;
322  clib_error_t *error = 0;
323  u32 hw_if_index, *hw_if_indices = 0;
324 
326  {
327  if (unformat
328  (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
329  vec_add1 (hw_if_indices, hw_if_index);
330  else if (unformat (input, "descriptors"))
331  show_descr = 1;
332  else
333  {
334  error = clib_error_return (0, "unknown input `%U'",
335  format_unformat_error, input);
336  goto done;
337  }
338  }
339 
340  if (vec_len (hw_if_indices) == 0)
341  {
342  /* *INDENT-OFF* */
343  pool_foreach (vif, mm->interfaces,
344  vec_add1 (hw_if_indices, vif->hw_if_index);
345  );
346  /* *INDENT-ON* */
347  }
348 
349  virtio_show (vm, hw_if_indices, show_descr, VIRTIO_IF_TYPE_TUN);
350 
351 done:
352  vec_free (hw_if_indices);
353  return error;
354 }
355 
356 /* *INDENT-OFF* */
357 VLIB_CLI_COMMAND (tun_show_command, static) = {
358  .path = "show tun",
359  .short_help = "show tun {<interface>] [descriptors]",
360  .function = tun_show_command_fn,
361 };
362 /* *INDENT-ON* */
363 
364 clib_error_t *
366 {
367  return 0;
368 }
369 
371 
372 /*
373  * fd.io coding-style-patch-verification: ON
374  *
375  * Local Variables:
376  * eval: (c-set-style "gnu")
377  * End:
378  */
unformat_function_t unformat_vnet_hw_interface
static clib_error_t * tun_show_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:315
virtio_if_t * interfaces
Definition: virtio.h:195
void virtio_show(vlib_main_t *vm, u32 *hw_if_indices, u8 show_descr, u32 type)
Definition: virtio.c:250
ip4_address_t host_ip4_addr
Definition: tap.h:53
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
int tap_gso_enable_disable(vlib_main_t *vm, u32 sw_if_index, int enable_disable)
Definition: tap.c:869
u8 host_ip6_prefix_len
Definition: tap.h:58
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:590
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:989
unformat_function_t unformat_vnet_sw_interface
int tap_csum_offload_enable_disable(vlib_main_t *vm, u32 sw_if_index, int enable_disable)
Definition: tap.c:808
u8 host_ip4_gw_set
Definition: tap.h:56
format_function_t format_vnet_sw_if_index_name
static clib_error_t * tap_show_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:265
static clib_error_t * tap_offload_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:198
u32 hw_if_index
Definition: virtio.h:146
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:513
unformat_function_t unformat_ip4_address
Definition: format.h:68
vl_api_interface_index_t sw_if_index
Definition: gre.api:53
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
int tap_delete_if(vlib_main_t *vm, u32 sw_if_index)
Definition: tap.c:773
#define clib_error_return(e, args...)
Definition: error.h:99
unsigned int u32
Definition: types.h:88
static clib_error_t * tap_delete_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:150
unformat_function_t unformat_line_input
Definition: format.h:283
clib_error_t * tap_cli_init(vlib_main_t *vm)
Definition: cli.c:365
static clib_error_t * tap_create_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:34
struct _unformat_input_t unformat_input_t
ip4_address_t host_ip4_gw
Definition: tap.h:55
ip6_address_t host_ip6_addr
Definition: tap.h:57
u8 host_ip4_prefix_len
Definition: tap.h:54
vlib_main_t * vm
Definition: in2out_ed.c:1599
unformat_function_t unformat_ip6_address
Definition: format.h:89
#define UNFORMAT_END_OF_INPUT
Definition: format.h:145
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:380
u32 host_mtu_size
Definition: tap.h:62
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:152
u8 * host_bridge
Definition: tap.h:52
uword unformat_ethernet_address(unformat_input_t *input, va_list *args)
Definition: format.c:233
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:689
ip6_address_t host_ip6_gw
Definition: tap.h:59
u8 * host_if_name
Definition: tap.h:50
virtio_main_t virtio_main
Definition: virtio.c:37
u8 host_ip6_gw_set
Definition: tap.h:60
void tap_create_if(vlib_main_t *vm, tap_create_if_args_t *args)
Definition: tap.c:133
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
static void unformat_free(unformat_input_t *i)
Definition: format.h:163
mac_address_t host_mac_addr
Definition: tap.h:51
mac_address_t mac_addr
Definition: tap.h:44
clib_error_t * error
Definition: tap.h:66
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
u8 * host_namespace
Definition: tap.h:49
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:171