FD.io VPP  v19.04-6-g6f05f72
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 
41  args.id = ~0;
42  args.tap_flags = 0;
43 
44  /* Get a line of input. */
45  if (unformat_user (input, unformat_line_input, line_input))
46  {
47  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
48  {
49  if (unformat (line_input, "id %u", &args.id))
50  ;
51  else
52  if (unformat (line_input, "host-if-name %s", &args.host_if_name))
53  ;
54  else if (unformat (line_input, "host-ns %s", &args.host_namespace))
55  ;
56  else if (unformat (line_input, "host-mac-addr %U",
58  ;
59  else if (unformat (line_input, "host-bridge %s", &args.host_bridge))
60  ;
61  else if (unformat (line_input, "host-ip4-addr %U/%d",
63  &args.host_ip4_prefix_len))
64  ip_addr_set = 1;
65  else if (unformat (line_input, "host-ip4-gw %U",
67  args.host_ip4_gw_set = 1;
68  else if (unformat (line_input, "host-ip6-addr %U/%d",
70  &args.host_ip6_prefix_len))
71  ip_addr_set = 1;
72  else if (unformat (line_input, "host-ip6-gw %U",
74  args.host_ip6_gw_set = 1;
75  else if (unformat (line_input, "rx-ring-size %d", &args.rx_ring_sz))
76  ;
77  else if (unformat (line_input, "tx-ring-size %d", &args.tx_ring_sz))
78  ;
79  else if (unformat (line_input, "no-gso"))
80  args.tap_flags &= ~TAP_FLAG_GSO;
81  else if (unformat (line_input, "gso"))
82  args.tap_flags |= TAP_FLAG_GSO;
83  else if (unformat (line_input, "hw-addr %U",
85  args.mac_addr_set = 1;
86  else
87  {
88  unformat_free (line_input);
89  return clib_error_return (0, "unknown input `%U'",
90  format_unformat_error, input);
91  }
92  }
93  unformat_free (line_input);
94  }
95 
96  if (ip_addr_set && args.host_bridge)
97  return clib_error_return (0, "Please specify either host ip address or "
98  "host bridge");
99 
100  tap_create_if (vm, &args);
101 
102  vec_free (args.host_if_name);
103  vec_free (args.host_namespace);
104  vec_free (args.host_bridge);
105 
106  return args.error;
107 
108 }
109 
110 /* *INDENT-OFF* */
111 VLIB_CLI_COMMAND (tap_create_command, static) = {
112  .path = "create tap",
113  .short_help = "create tap {id <if-id>} [hw-addr <mac-address>] "
114  "[rx-ring-size <size>] [tx-ring-size <size>] [host-ns <netns>] "
115  "[host-bridge <bridge-name>] [host-ip4-addr <ip4addr/mask>] "
116  "[host-ip6-addr <ip6-addr>] [host-ip4-gw <ip4-addr>] "
117  "[host-ip6-gw <ip6-addr>] [host-if-name <name>] [no-gso|gso]",
118  .function = tap_create_command_fn,
119 };
120 /* *INDENT-ON* */
121 
122 static clib_error_t *
124  vlib_cli_command_t * cmd)
125 {
126  unformat_input_t _line_input, *line_input = &_line_input;
127  u32 sw_if_index = ~0;
128  vnet_main_t *vnm = vnet_get_main ();
129  int rv;
130 
131  /* Get a line of input. */
132  if (!unformat_user (input, unformat_line_input, line_input))
133  return clib_error_return (0, "Missing <interface>");
134 
135  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
136  {
137  if (unformat (line_input, "sw_if_index %d", &sw_if_index))
138  ;
139  else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
140  vnm, &sw_if_index))
141  ;
142  else
143  return clib_error_return (0, "unknown input `%U'",
144  format_unformat_error, input);
145  }
146  unformat_free (line_input);
147 
148  if (sw_if_index == ~0)
149  return clib_error_return (0,
150  "please specify interface name or sw_if_index");
151 
152  rv = tap_delete_if (vm, sw_if_index);
153  if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
154  return clib_error_return (0, "not a tap interface");
155  else if (rv != 0)
156  return clib_error_return (0, "error on deleting tap interface");
157 
158  return 0;
159 }
160 
161 /* *INDENT-OFF* */
162 VLIB_CLI_COMMAND (tap_delete__command, static) =
163 {
164  .path = "delete tap",
165  .short_help = "delete tap {<interface> | sw_if_index <sw_idx>}",
166  .function = tap_delete_command_fn,
167 };
168 /* *INDENT-ON* */
169 
170 static clib_error_t *
172  vlib_cli_command_t * cmd)
173 {
174  unformat_input_t _line_input, *line_input = &_line_input;
175  u32 sw_if_index = ~0;
176  vnet_main_t *vnm = vnet_get_main ();
177  int enable = 1;
178  int rv;
179 
180  /* Get a line of input. */
181  if (!unformat_user (input, unformat_line_input, line_input))
182  return clib_error_return (0, "Missing <interface>");
183 
184  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
185  {
186  if (unformat (line_input, "sw_if_index %d", &sw_if_index))
187  ;
188  else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
189  vnm, &sw_if_index))
190  ;
191  else if (unformat (line_input, "enable"))
192  enable = 1;
193  else if (unformat (line_input, "disable"))
194  enable = 0;
195  else
196  return clib_error_return (0, "unknown input `%U'",
197  format_unformat_error, input);
198  }
199  unformat_free (line_input);
200 
201  if (sw_if_index == ~0)
202  return clib_error_return (0,
203  "please specify interface name or sw_if_index");
204 
205  rv = tap_gso_enable_disable (vm, sw_if_index, enable);
206  if (rv == VNET_API_ERROR_INVALID_SW_IF_INDEX)
207  return clib_error_return (0, "not a tap interface");
208  else if (rv != 0)
209  return clib_error_return (0, "error on configuring GSO on tap interface");
210 
211  return 0;
212 }
213 
214 /* *INDENT-OFF* */
215 VLIB_CLI_COMMAND (tap_gso__command, static) =
216 {
217  .path = "set tap gso",
218  .short_help = "set tap gso {<interface> | sw_if_index <sw_idx>} <enable|disable>",
219  .function = tap_gso_command_fn,
220 };
221 /* *INDENT-ON* */
222 
223 static clib_error_t *
225  vlib_cli_command_t * cmd)
226 {
227  virtio_main_t *mm = &virtio_main;
228  virtio_if_t *vif;
229  vnet_main_t *vnm = vnet_get_main ();
230  int show_descr = 0;
231  clib_error_t *error = 0;
232  u32 hw_if_index, *hw_if_indices = 0;
233 
235  {
236  if (unformat
237  (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
238  vec_add1 (hw_if_indices, hw_if_index);
239  else if (unformat (input, "descriptors"))
240  show_descr = 1;
241  else
242  {
243  error = clib_error_return (0, "unknown input `%U'",
244  format_unformat_error, input);
245  goto done;
246  }
247  }
248 
249  if (vec_len (hw_if_indices) == 0)
250  {
251  /* *INDENT-OFF* */
252  pool_foreach (vif, mm->interfaces,
253  vec_add1 (hw_if_indices, vif->hw_if_index);
254  );
255  /* *INDENT-ON* */
256  }
257 
258  virtio_show (vm, hw_if_indices, show_descr, VIRTIO_IF_TYPE_TAP);
259 
260 done:
261  vec_free (hw_if_indices);
262  return error;
263 }
264 
265 /* *INDENT-OFF* */
266 VLIB_CLI_COMMAND (tap_show_command, static) = {
267  .path = "show tap",
268  .short_help = "show tap {<interface>] [descriptors]",
269  .function = tap_show_command_fn,
270 };
271 /* *INDENT-ON* */
272 
273 clib_error_t *
275 {
276  return 0;
277 }
278 
280 
281 /*
282  * fd.io coding-style-patch-verification: ON
283  *
284  * Local Variables:
285  * eval: (c-set-style "gnu")
286  * End:
287  */
unformat_function_t unformat_vnet_hw_interface
u32 sw_if_index
Definition: ipsec_gre.api:37
#define TAP_FLAG_GSO
Definition: tap.h:33
virtio_if_t * interfaces
Definition: virtio.h:193
void virtio_show(vlib_main_t *vm, u32 *hw_if_indices, u8 show_descr, u32 type)
Definition: virtio.c:254
ip4_address_t host_ip4_addr
Definition: tap.h:38
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
int tap_gso_enable_disable(vlib_main_t *vm, u32 sw_if_index, int enable_disable)
Definition: tap.c:495
static clib_error_t * tap_gso_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:171
static clib_error_t * tap_show_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:224
u8 host_ip6_prefix_len
Definition: tap.h:43
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:522
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
unformat_function_t unformat_vnet_sw_interface
u8 host_ip4_gw_set
Definition: tap.h:41
clib_error_t * tap_cli_init(vlib_main_t *vm)
Definition: cli.c:274
static clib_error_t * tap_delete_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:123
u32 hw_if_index
Definition: virtio.h:142
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:493
unformat_function_t unformat_ip4_address
Definition: format.h:70
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:163
int tap_delete_if(vlib_main_t *vm, u32 sw_if_index)
Definition: tap.c:444
#define clib_error_return(e, args...)
Definition: error.h:99
u8 host_mac_addr[6]
Definition: tap.h:36
unsigned int u32
Definition: types.h:88
unformat_function_t unformat_line_input
Definition: format.h:282
struct _unformat_input_t unformat_input_t
ip4_address_t host_ip4_gw
Definition: tap.h:40
ip6_address_t host_ip6_addr
Definition: tap.h:42
u8 host_ip4_prefix_len
Definition: tap.h:39
unformat_function_t unformat_ip6_address
Definition: format.h:91
#define UNFORMAT_END_OF_INPUT
Definition: format.h:144
vlib_main_t * vm
Definition: buffer.c:312
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
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
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:155
u8 * host_bridge
Definition: tap.h:37
uword unformat_ethernet_address(unformat_input_t *input, va_list *args)
Definition: format.c:233
ip6_address_t host_ip6_gw
Definition: tap.h:44
u8 * host_if_name
Definition: tap.h:35
virtio_main_t virtio_main
Definition: virtio.c:37
u8 host_ip6_gw_set
Definition: tap.h:45
void tap_create_if(vlib_main_t *vm, tap_create_if_args_t *args)
Definition: tap.c:81
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
static void unformat_free(unformat_input_t *i)
Definition: format.h:162
u8 mac_addr[6]
Definition: tap.h:29
clib_error_t * error
Definition: tap.h:49
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
u8 * host_namespace
Definition: tap.h:34
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:170