FD.io VPP  v20.09-64-g4f7b92f0a
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>
29 #include <vnet/devices/tap/tap.h>
30 
31 static clib_error_t *
33  vlib_cli_command_t * cmd)
34 {
35  unformat_input_t _line_input, *line_input = &_line_input;
36  tap_create_if_args_t args = { 0 };
37  int ip_addr_set = 0;
38  u32 tmp;
39 
40  args.id = ~0;
41  args.tap_flags = 0;
42  args.rv = -1;
43  args.num_rx_queues = 1;
44 
45  /* Get a line of input. */
46  if (unformat_user (input, unformat_line_input, line_input))
47  {
48  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
49  {
50  if (unformat (line_input, "id %u", &args.id))
51  ;
52  else
53  if (unformat (line_input, "host-if-name %s", &args.host_if_name))
54  ;
55  else if (unformat (line_input, "host-ns %s", &args.host_namespace))
56  ;
57  else if (unformat (line_input, "host-mac-addr %U",
59  args.host_mac_addr.bytes))
60  ;
61  else if (unformat (line_input, "host-bridge %s", &args.host_bridge))
62  ;
63  else if (unformat (line_input, "host-ip4-addr %U/%d",
65  &args.host_ip4_prefix_len))
66  ip_addr_set = 1;
67  else if (unformat (line_input, "host-ip4-gw %U",
69  args.host_ip4_gw_set = 1;
70  else if (unformat (line_input, "host-ip6-addr %U/%d",
72  &args.host_ip6_prefix_len))
73  ip_addr_set = 1;
74  else if (unformat (line_input, "host-ip6-gw %U",
76  args.host_ip6_gw_set = 1;
77  else if (unformat (line_input, "num-rx-queues %d", &tmp))
78  args.num_rx_queues = tmp;
79  else if (unformat (line_input, "rx-ring-size %d", &tmp))
80  args.rx_ring_sz = tmp;
81  else if (unformat (line_input, "tx-ring-size %d", &tmp))
82  args.tx_ring_sz = tmp;
83  else
84  if (unformat
85  (line_input, "host-mtu-size %d", &args.host_mtu_size))
86  args.host_mtu_set = 1;
87  else if (unformat (line_input, "no-gso"))
88  args.tap_flags &= ~TAP_FLAG_GSO;
89  else if (unformat (line_input, "gso"))
90  args.tap_flags |= TAP_FLAG_GSO;
91  else if (unformat (line_input, "gro-coalesce"))
92  args.tap_flags |= TAP_FLAG_GRO_COALESCE;
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, "packed"))
102  args.tap_flags |= TAP_FLAG_PACKED;
103  else if (unformat (line_input, "in-order"))
104  args.tap_flags |= TAP_FLAG_IN_ORDER;
105  else if (unformat (line_input, "hw-addr %U",
107  args.mac_addr_set = 1;
108  else
109  {
110  unformat_free (line_input);
111  return clib_error_return (0, "unknown input `%U'",
112  format_unformat_error, input);
113  }
114  }
115  unformat_free (line_input);
116  }
117 
118  if (ip_addr_set && args.host_bridge)
119  return clib_error_return (0, "Please specify either host ip address or "
120  "host bridge");
121 
122  tap_create_if (vm, &args);
123 
124  if (!args.rv)
126  vnet_get_main (), args.sw_if_index);
127 
128  vec_free (args.host_if_name);
129  vec_free (args.host_namespace);
130  vec_free (args.host_bridge);
131 
132  return args.error;
133 
134 }
135 
136 /* *INDENT-OFF* */
137 VLIB_CLI_COMMAND (tap_create_command, static) = {
138  .path = "create tap",
139  .short_help = "create tap {id <if-id>} [hw-addr <mac-address>] "
140  "[num-rx-queues <n>] [rx-ring-size <size>] [tx-ring-size <size>] "
141  "[host-ns <netns>] [host-bridge <bridge-name>] "
142  "[host-ip4-addr <ip4addr/mask>] [host-ip6-addr <ip6-addr>] "
143  "[host-ip4-gw <ip4-addr>] [host-ip6-gw <ip6-addr>] "
144  "[host-mac-addr <host-mac-address>] [host-if-name <name>] "
145  "[host-mtu-size <size>] [no-gso|gso [gro-coalesce]|csum-offload] "
146  "[persist] [attach] [tun] [packed] [in-order]",
147  .function = tap_create_command_fn,
148 };
149 /* *INDENT-ON* */
150 
151 static clib_error_t *
153  vlib_cli_command_t * cmd)
154 {
155  unformat_input_t _line_input, *line_input = &_line_input;
156  u32 sw_if_index = ~0;
157  vnet_main_t *vnm = vnet_get_main ();
158  int rv;
159 
160  /* Get a line of input. */
161  if (!unformat_user (input, unformat_line_input, line_input))
162  return clib_error_return (0, "Missing <interface>");
163 
164  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
165  {
166  if (unformat (line_input, "sw_if_index %d", &sw_if_index))
167  ;
168  else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
169  vnm, &sw_if_index))
170  ;
171  else
172  return clib_error_return (0, "unknown input `%U'",
173  format_unformat_error, input);
174  }
175  unformat_free (line_input);
176 
177  if (sw_if_index == ~0)
178  return clib_error_return (0,
179  "please specify interface name or sw_if_index");
180 
181  rv = tap_delete_if (vm, sw_if_index);
182  if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
183  return clib_error_return (0, "not a tap interface");
184  else if (rv != 0)
185  return clib_error_return (0, "error on deleting tap interface");
186 
187  return 0;
188 }
189 
190 /* *INDENT-OFF* */
191 VLIB_CLI_COMMAND (tap_delete__command, static) =
192 {
193  .path = "delete tap",
194  .short_help = "delete tap {<interface> | sw_if_index <sw_idx>}",
195  .function = tap_delete_command_fn,
196 };
197 /* *INDENT-ON* */
198 
199 static clib_error_t *
201  vlib_cli_command_t * cmd)
202 {
203  unformat_input_t _line_input, *line_input = &_line_input;
204  u32 sw_if_index = ~0;
205  vnet_main_t *vnm = vnet_get_main ();
206  int gso_enable = 0, gso_disable = 0, is_gro_coalesce = 0;
207  int csum_offload_enable = 0, csum_offload_disable = 0;
208  int rv = 0;
209 
210  /* Get a line of input. */
211  if (!unformat_user (input, unformat_line_input, line_input))
212  return clib_error_return (0, "Missing <interface>");
213 
214  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
215  {
216  if (unformat (line_input, "sw_if_index %d", &sw_if_index))
217  ;
218  else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
219  vnm, &sw_if_index))
220  ;
221  else if (unformat (line_input, "gso-enable"))
222  {
223  gso_enable = 1;
224  if (unformat (line_input, "gro-coalesce"))
225  is_gro_coalesce = 1;
226  }
227  else if (unformat (line_input, "gso-disable"))
228  gso_disable = 1;
229  else if (unformat (line_input, "csum-offload-enable"))
230  csum_offload_enable = 1;
231  else if (unformat (line_input, "csum-offload-disable"))
232  csum_offload_disable = 1;
233  else
234  return clib_error_return (0, "unknown input `%U'",
235  format_unformat_error, input);
236  }
237  unformat_free (line_input);
238 
239  if (sw_if_index == ~0)
240  return clib_error_return (0,
241  "please specify interface name or sw_if_index");
242 
243  if (gso_enable)
244  rv = tap_gso_enable_disable (vm, sw_if_index, 1, is_gro_coalesce);
245  else if (csum_offload_enable)
246  rv = tap_csum_offload_enable_disable (vm, sw_if_index, 1);
247  else if (gso_disable)
248  rv = tap_gso_enable_disable (vm, sw_if_index, 0, 0);
249  else if (csum_offload_disable)
250  rv = tap_csum_offload_enable_disable (vm, sw_if_index, 0);
251 
252  if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
253  return clib_error_return (0, "not a tap interface");
254  else if (rv != 0)
255  return clib_error_return (0, "error on configuring GSO on tap interface");
256 
257  return 0;
258 }
259 
260 /* *INDENT-OFF* */
261 VLIB_CLI_COMMAND (tap_offload_command, static) =
262 {
263  .path = "set tap offload",
264  .short_help = "set tap offload {<interface> | sw_if_index <sw_idx>}"
265  " <gso-enable [gro-coalesce] | gso-disable | csum-offload-enable |"
266  "csum-offload-disable>",
267  .function = tap_offload_command_fn,
268 };
269 /* *INDENT-ON* */
270 
271 static clib_error_t *
273  vlib_cli_command_t * cmd)
274 {
275  virtio_main_t *mm = &virtio_main;
276  virtio_if_t *vif;
277  vnet_main_t *vnm = vnet_get_main ();
278  int show_descr = 0;
279  clib_error_t *error = 0;
280  u32 hw_if_index, *hw_if_indices = 0;
281 
283  {
284  if (unformat
285  (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
286  vec_add1 (hw_if_indices, hw_if_index);
287  else if (unformat (input, "descriptors"))
288  show_descr = 1;
289  else
290  {
291  error = clib_error_return (0, "unknown input `%U'",
292  format_unformat_error, input);
293  goto done;
294  }
295  }
296 
297  if (vec_len (hw_if_indices) == 0)
298  {
299  /* *INDENT-OFF* */
300  pool_foreach (vif, mm->interfaces,
301  vec_add1 (hw_if_indices, vif->hw_if_index);
302  );
303  /* *INDENT-ON* */
304  }
305 
306  virtio_show (vm, hw_if_indices, show_descr, VIRTIO_IF_TYPE_TAP);
307 
308 done:
309  vec_free (hw_if_indices);
310  return error;
311 }
312 
313 /* *INDENT-OFF* */
314 VLIB_CLI_COMMAND (tap_show_command, static) = {
315  .path = "show tap",
316  .short_help = "show tap {<interface>] [descriptors]",
317  .function = tap_show_command_fn,
318 };
319 /* *INDENT-ON* */
320 
321 static clib_error_t *
323  vlib_cli_command_t * cmd)
324 {
325  virtio_main_t *mm = &virtio_main;
326  virtio_if_t *vif;
327  vnet_main_t *vnm = vnet_get_main ();
328  int show_descr = 0;
329  clib_error_t *error = 0;
330  u32 hw_if_index, *hw_if_indices = 0;
331 
333  {
334  if (unformat
335  (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
336  vec_add1 (hw_if_indices, hw_if_index);
337  else if (unformat (input, "descriptors"))
338  show_descr = 1;
339  else
340  {
341  error = clib_error_return (0, "unknown input `%U'",
342  format_unformat_error, input);
343  goto done;
344  }
345  }
346 
347  if (vec_len (hw_if_indices) == 0)
348  {
349  /* *INDENT-OFF* */
350  pool_foreach (vif, mm->interfaces,
351  vec_add1 (hw_if_indices, vif->hw_if_index);
352  );
353  /* *INDENT-ON* */
354  }
355 
356  virtio_show (vm, hw_if_indices, show_descr, VIRTIO_IF_TYPE_TUN);
357 
358 done:
359  vec_free (hw_if_indices);
360  return error;
361 }
362 
363 /* *INDENT-OFF* */
364 VLIB_CLI_COMMAND (tun_show_command, static) = {
365  .path = "show tun",
366  .short_help = "show tun {<interface>] [descriptors]",
367  .function = tun_show_command_fn,
368 };
369 /* *INDENT-ON* */
370 
371 clib_error_t *
373 {
374  return 0;
375 }
376 
378 
379 /*
380  * fd.io coding-style-patch-verification: ON
381  *
382  * Local Variables:
383  * eval: (c-set-style "gnu")
384  * End:
385  */
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:322
virtio_if_t * interfaces
Definition: virtio.h:192
void virtio_show(vlib_main_t *vm, u32 *hw_if_indices, u8 show_descr, u32 type)
Definition: virtio.c:265
ip4_address_t host_ip4_addr
Definition: tap.h:55
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
u8 host_ip6_prefix_len
Definition: tap.h:60
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:592
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:989
vlib_main_t * vm
Definition: in2out_ed.c:1582
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:810
u8 host_ip4_gw_set
Definition: tap.h:58
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:272
static clib_error_t * tap_offload_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:200
u32 hw_if_index
Definition: virtio.h:128
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:513
unformat_function_t unformat_ip4_address
Definition: format.h:68
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
int tap_delete_if(vlib_main_t *vm, u32 sw_if_index)
Definition: tap.c:775
#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:152
unformat_function_t unformat_line_input
Definition: format.h:283
clib_error_t * tap_cli_init(vlib_main_t *vm)
Definition: cli.c:372
static clib_error_t * tap_create_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:32
struct _unformat_input_t unformat_input_t
ip4_address_t host_ip4_gw
Definition: tap.h:57
ip6_address_t host_ip6_addr
Definition: tap.h:59
u8 host_ip4_prefix_len
Definition: tap.h:56
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:64
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:158
u8 * host_bridge
Definition: tap.h:54
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:696
ip6_address_t host_ip6_gw
Definition: tap.h:61
u8 * host_if_name
Definition: tap.h:52
virtio_main_t virtio_main
Definition: virtio.c:35
u8 host_ip6_gw_set
Definition: tap.h:62
void tap_create_if(vlib_main_t *vm, tap_create_if_args_t *args)
Definition: tap.c:131
#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:53
int tap_gso_enable_disable(vlib_main_t *vm, u32 sw_if_index, int enable_disable, int is_packet_coalesce)
Definition: tap.c:869
mac_address_t mac_addr
Definition: tap.h:46
clib_error_t * error
Definition: tap.h:68
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
u8 * host_namespace
Definition: tap.h:51
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:33
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