FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
ip46_cli.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  * ip/ip4_cli.c: ip4 commands
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39 
40 #include <vnet/ip/ip.h>
43 
44 /**
45  * @file
46  * @brief Set IP Address.
47  *
48  * Configure an IPv4 or IPv6 address for on an interface.
49  */
50 
51 
52 int
54 {
55  return clib_net_to_host_u32 (a1->data_u32) -
56  clib_net_to_host_u32 (a2->data_u32);
57 }
58 
59 int
60 ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2)
61 {
62  int i;
63  for (i = 0; i < ARRAY_LEN (a1->as_u16); i++)
64  {
65  int cmp =
66  clib_net_to_host_u16 (a1->as_u16[i]) -
67  clib_net_to_host_u16 (a2->as_u16[i]);
68  if (cmp != 0)
69  return cmp;
70  }
71  return 0;
72 }
73 
74 /* *INDENT-OFF* */
76  .path = "set interface ip",
77  .short_help = "IP4/IP6 commands",
78 };
79 /* *INDENT-ON* */
80 
81 void
83 {
84  ip4_main_t *im4 = &ip4_main;
85  ip4_address_t *ip4_addrs = 0;
86  u32 *ip4_masks = 0;
87  ip6_main_t *im6 = &ip6_main;
88  ip6_address_t *ip6_addrs = 0;
89  u32 *ip6_masks = 0;
91  int i;
92 
93  /* *INDENT-OFF* */
95  0 /* honor unnumbered */,
96  ({
97  ip4_address_t * x = (ip4_address_t *)
98  ip_interface_address_get_address (&im4->lookup_main, ia);
99  vec_add1 (ip4_addrs, x[0]);
100  vec_add1 (ip4_masks, ia->address_length);
101  }));
102  /* *INDENT-ON* */
103 
104  /* *INDENT-OFF* */
106  0 /* honor unnumbered */,
107  ({
108  ip6_address_t * x = (ip6_address_t *)
109  ip_interface_address_get_address (&im6->lookup_main, ia);
110  vec_add1 (ip6_addrs, x[0]);
111  vec_add1 (ip6_masks, ia->address_length);
112  }));
113  /* *INDENT-ON* */
114 
115  for (i = 0; i < vec_len (ip4_addrs); i++)
117  ip4_masks[i], 1 /* is_del */ );
118  for (i = 0; i < vec_len (ip6_addrs); i++)
120  ip6_masks[i], 1 /* is_del */ );
121 
122  vec_free (ip4_addrs);
123  vec_free (ip4_masks);
124  vec_free (ip6_addrs);
125  vec_free (ip6_masks);
126 }
127 
128 static clib_error_t *
129 ip_address_delete_cleanup (vnet_main_t * vnm, u32 hw_if_index, u32 is_create)
130 {
133 
134  if (is_create)
135  return 0;
136 
137  hw = vnet_get_hw_interface (vnm, hw_if_index);
138 
140  return 0;
141 }
142 
144 
145 static clib_error_t *
147  unformat_input_t * input, vlib_cli_command_t * cmd)
148 {
149  vnet_main_t *vnm = vnet_get_main ();
150  ip4_address_t a4;
151  ip6_address_t a6;
152  clib_error_t *error = 0;
153  u32 sw_if_index, length, is_del;
154 
155  sw_if_index = ~0;
156  is_del = 0;
157 
158  if (unformat (input, "del"))
159  is_del = 1;
160 
162  {
163  error = clib_error_return (0, "unknown interface `%U'",
164  format_unformat_error, input);
165  goto done;
166  }
167 
168  if (is_del && unformat (input, "all"))
170  else if (unformat (input, "%U/%d", unformat_ip4_address, &a4, &length))
172  is_del);
173  else if (unformat (input, "%U/%d", unformat_ip6_address, &a6, &length))
175  is_del);
176  else
177  {
178  error = clib_error_return (0, "expected IP4/IP6 address/length `%U'",
179  format_unformat_error, input);
180  goto done;
181  }
182 
183 
184 done:
185  return error;
186 }
187 
188 /*?
189  * Add an IP Address to an interface or remove and IP Address from an interface.
190  * The IP Address can be an IPv4 or an IPv6 address. Interfaces may have multiple
191  * IPv4 and IPv6 addresses. There is no concept of primary vs. secondary
192  * interface addresses; they're just addresses.
193  *
194  * To display the addresses associated with a given interface, use the command
195  * '<em>show interface address <interface></em>'.
196  *
197  * Note that the debug CLI does not enforce classful mask-width / addressing
198  * constraints.
199  *
200  * @cliexpar
201  * @parblock
202  * An example of how to add an IPv4 address to an interface:
203  * @cliexcmd{set interface ip address GigabitEthernet2/0/0 172.16.2.12/24}
204  *
205  * An example of how to add an IPv6 address to an interface:
206  * @cliexcmd{set interface ip address GigabitEthernet2/0/0 @::a:1:1:0:7/126}
207  *
208  * To delete a specific interface ip address:
209  * @cliexcmd{set interface ip address del GigabitEthernet2/0/0 172.16.2.12/24}
210  *
211  * To delete all interfaces addresses (IPv4 and IPv6):
212  * @cliexcmd{set interface ip address del GigabitEthernet2/0/0 all}
213  * @endparblock
214  ?*/
215 /* *INDENT-OFF* */
217  .path = "set interface ip address",
218  .function = add_del_ip_address,
219  .short_help = "set interface ip address [del] <interface> <ip-addr>/<mask> | [all]",
220 };
221 /* *INDENT-ON* */
222 
223 static clib_error_t *
225  unformat_input_t * input, vlib_cli_command_t * cmd)
226 {
227  vnet_main_t *vnm = vnet_get_main ();
228  unformat_input_t _line_input, *line_input = &_line_input;
229  u32 sw_if_index = ~0;
230  u8 ip4_on = 0;
231  u8 ip6_on = 0;
232 
233  /* Get a line of input. */
234  if (!unformat_user (input, unformat_line_input, line_input))
235  {
236  return NULL;
237  }
238 
239  if (!unformat_user
240  (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
241  {
242  return clib_error_return (0, "Invalid interface name");
243  }
244 
245  if (unformat (line_input, "on"))
246  {
247  ip4_on = 1;
248  ip6_on = 1;
249  }
250  else if (unformat (line_input, "off"))
251  {
252  ip4_on = 0;
253  ip6_on = 0;
254  }
255  else if (unformat (line_input, "ip4"))
256  {
257  ip4_on = 1;
258  ip6_on = 0;
259  }
260  else if (unformat (line_input, "ip6"))
261  {
262  ip4_on = 0;
263  ip6_on = 1;
264  }
265  else
266  {
267  return clib_error_return (0, "Unknown input `%U'",
268  format_unformat_error, line_input);
269  }
270 
271 
274  if (rv4 && rv6)
275  {
276  return clib_error_return (0,
277  "`ip4_full_reass_enable_disable' API call failed, rv=%d:%U, "
278  "`ip6_full_reass_enable_disable' API call failed, rv=%d:%U",
279  (int) rv4, format_vnet_api_errno, rv4,
280  (int) rv6, format_vnet_api_errno, rv6);
281  }
282  else if (rv4)
283  {
284  return clib_error_return (0,
285  "`ip4_full_reass_enable_disable' API call failed, rv=%d:%U",
286  (int) rv4, format_vnet_api_errno, rv4);
287  }
288  else if (rv6)
289  {
290  return clib_error_return (0,
291  "`ip6_full_reass_enable_disable' API call failed, rv=%d:%U",
292  (int) rv6, format_vnet_api_errno, rv6);
293  }
294  return NULL;
295 }
296 
297 /* *INDENT-OFF* */
299  .path = "set interface reassembly",
300  .short_help = "set interface reassembly <interface-name> [on|off|ip4|ip6]",
301  .function = set_reassembly_command_fn,
302 };
303 /* *INDENT-ON* */
304 
305 /* Dummy init function to get us linked in. */
306 static clib_error_t *
308 {
309  return 0;
310 }
311 
313 
314 /*
315  * fd.io coding-style-patch-verification: ON
316  *
317  * Local Variables:
318  * eval: (c-set-style "gnu")
319  * End:
320  */
unformat_user
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:989
foreach_ip_interface_address
#define foreach_ip_interface_address(lm, a, sw_if_index, loop, body)
Definition: ip_interface.h:57
ip6_full_reass.h
IPv6 Reassembly.
ip4_main_t::lookup_main
ip_lookup_main_t lookup_main
Definition: ip4.h:109
ip4_main
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:1105
unformat_line_input
unformat_function_t unformat_line_input
Definition: format.h:275
ip6_address_compare
int ip6_address_compare(ip6_address_t *a1, ip6_address_t *a2)
Definition: ip46_cli.c:60
vnet_hw_interface_t::sw_if_index
u32 sw_if_index
Definition: interface.h:670
clib_error_return
#define clib_error_return(e, args...)
Definition: error.h:99
vlib_cli_command_t::path
char * path
Definition: cli.h:96
set_reassembly_command_fn
static clib_error_t * set_reassembly_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: ip46_cli.c:224
set_interface_ip_address_command
static vlib_cli_command_t set_interface_ip_address_command
(constructor) VLIB_CLI_COMMAND (set_interface_ip_address_command)
Definition: ip46_cli.c:216
ip4_address_compare
int ip4_address_compare(ip4_address_t *a1, ip4_address_t *a2)
Definition: ip46_cli.c:53
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
ip4_full_reass.h
IPv4 Reassembly.
format_vnet_api_errno
static u8 * format_vnet_api_errno(u8 *s, va_list *args)
Definition: api_errno.h:172
unformat_input_t
struct _unformat_input_t unformat_input_t
error
Definition: cJSON.c:88
unformat
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
ip6_full_reass_enable_disable
vnet_api_error_t ip6_full_reass_enable_disable(u32 sw_if_index, u8 enable_disable)
Definition: ip6_full_reass.c:1714
ip6_add_del_interface_address
clib_error_t * ip6_add_del_interface_address(vlib_main_t *vm, u32 sw_if_index, ip6_address_t *address, u32 address_length, u32 is_del)
Definition: ip6_forward.c:297
vec_len
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
Definition: vec_bootstrap.h:142
ip4_add_del_interface_address
clib_error_t * ip4_add_del_interface_address(vlib_main_t *vm, u32 sw_if_index, ip4_address_t *address, u32 address_length, u32 is_del)
Definition: ip4_forward.c:833
vnet_get_hw_interface
static vnet_hw_interface_t * vnet_get_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
Definition: interface_funcs.h:44
vnet_get_main
vnet_main_t * vnet_get_main(void)
Definition: pnat_test_stubs.h:56
ARRAY_LEN
#define ARRAY_LEN(x)
Definition: clib.h:70
i
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:261
format_unformat_error
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
VLIB_CLI_COMMAND
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:163
ip4_full_reass_enable_disable
vnet_api_error_t ip4_full_reass_enable_disable(u32 sw_if_index, u8 enable_disable)
Definition: ip4_full_reass.c:1743
ip4_address_t
Definition: ip4_packet.h:50
VNET_HW_INTERFACE_ADD_DEL_FUNCTION
VNET_HW_INTERFACE_ADD_DEL_FUNCTION(ip_address_delete_cleanup)
ip6_main
ip6_main_t ip6_main
Definition: ip6_forward.c:2787
vnet_hw_interface_t
Definition: interface.h:638
vnet_main_t
Definition: vnet.h:76
vec_free
#define vec_free(V)
Free vector's memory (no header).
Definition: vec.h:395
unformat_vnet_sw_interface
unformat_function_t unformat_vnet_sw_interface
Definition: interface_funcs.h:459
ip.h
u32
unsigned int u32
Definition: types.h:88
VLIB_INIT_FUNCTION
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:172
ip4_address_t::data_u32
u32 data_u32
Definition: ip4_packet.h:53
ip6_main_t::lookup_main
ip_lookup_main_t lookup_main
Definition: ip6.h:112
ip4_cli_init
static clib_error_t * ip4_cli_init(vlib_main_t *vm)
Definition: ip46_cli.c:307
ip6_main_t
Definition: ip6.h:110
length
char const int length
Definition: cJSON.h:163
vlib_main_t
Definition: main.h:102
vlib_get_main
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:38
u8
unsigned char u8
Definition: types.h:56
clib_error_t
Definition: clib_error.h:21
vlib_init_function_t
clib_error_t *() vlib_init_function_t(struct vlib_main_t *vm)
Definition: init.h:51
unformat_ip6_address
unformat_function_t unformat_ip6_address
Definition: format.h:89
set_interface_ip_command
static vlib_cli_command_t set_interface_ip_command
(constructor) VLIB_CLI_COMMAND (set_interface_ip_command)
Definition: ip46_cli.c:75
unformat_ip4_address
unformat_function_t unformat_ip4_address
Definition: format.h:68
ip_interface_address_t
Definition: lookup.h:89
set_reassembly_command
static vlib_cli_command_t set_reassembly_command
(constructor) VLIB_CLI_COMMAND (set_reassembly_command)
Definition: ip46_cli.c:298
ip_address_delete_cleanup
static clib_error_t * ip_address_delete_cleanup(vnet_main_t *vnm, u32 hw_if_index, u32 is_create)
Definition: ip46_cli.c:129
vlib_cli_command_t
Definition: cli.h:92
ip4_main_t
IPv4 main type.
Definition: ip4.h:107
sw_if_index
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
ip_del_all_interface_addresses
void ip_del_all_interface_addresses(vlib_main_t *vm, u32 sw_if_index)
Definition: ip46_cli.c:82
add_del_ip_address
static clib_error_t * add_del_ip_address(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: ip46_cli.c:146
vnet_api_error_t
vnet_api_error_t
Definition: api_errno.h:162