2 * Copyright (c) 2019 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #include <vnet/ip/ip6_link.h>
17 #include <vnet/ip/ip6_ll_table.h>
19 #include <vnet/ethernet/ethernet.h>
20 #include <vnet/mfib/ip6_mfib.h>
21 #include <vnet/adj/adj_mcast.h>
23 typedef struct ip6_link_delegate_t_
26 ip6_link_delegate_id_t ild_type;
28 } ip6_link_delegate_t;
30 const static ip6_link_delegate_t ip6_link_delegate_uninit = {
31 .ild_sw_if_index = ~0,
34 typedef struct ip6_link_t_
36 /** interface ip6 is enabled on */
39 /** link-local address - if unset that IP6 is disabled*/
40 ip6_address_t il_ll_addr;
42 /** list of delegates */
43 ip6_link_delegate_t *il_delegates;
45 /** multicast adjacency for this link */
46 adj_index_t il_mcast_adj;
48 /** number of references to IP6 enabled on this link */
52 #define FOREACH_IP6_LINK_DELEGATE(_ild, _il, body) \
55 vec_foreach (_ild, _il->il_delegates) { \
56 if (ip6_link_delegate_is_init(_ild)) \
62 #define FOREACH_IP6_LINK_DELEGATE_ID(_id) \
63 for (_id = 0; _id < il_delegate_id; _id++)
65 /** last used delegate ID */
66 static ip6_link_delegate_id_t il_delegate_id;
68 /** VFT registered per-delegate type */
69 static ip6_link_delegate_vft_t *il_delegate_vfts;
71 /** Per interface configs */
72 static ip6_link_t *ip6_links;
75 static u64 il_randomizer;
78 static vlib_log_class_t ip6_link_logger;
80 #define IP6_LINK_DBG(...) \
81 vlib_log_debug (ip6_link_logger, __VA_ARGS__);
83 #define IP6_LINK_INFO(...) \
84 vlib_log_notice (ip6_link_logger, __VA_ARGS__);
87 ip6_link_delegate_is_init (const ip6_link_delegate_t * ild)
89 return (~0 != ild->ild_sw_if_index);
93 ip6_link_is_enabled_i (const ip6_link_t * il)
95 return (!ip6_address_is_zero (&il->il_ll_addr));
99 ip6_link_local_address_from_mac (ip6_address_t * ip, const u8 * mac)
101 ip->as_u64[0] = clib_host_to_net_u64 (0xFE80000000000000ULL);
102 /* Invert the "u" bit */
103 ip->as_u8[8] = mac[0] ^ (1 << 1);
104 ip->as_u8[9] = mac[1];
105 ip->as_u8[10] = mac[2];
106 ip->as_u8[11] = 0xFF;
107 ip->as_u8[12] = 0xFE;
108 ip->as_u8[13] = mac[3];
109 ip->as_u8[14] = mac[4];
110 ip->as_u8[15] = mac[5];
114 ip6_mac_address_from_link_local (u8 * mac, const ip6_address_t * ip)
116 /* Invert the previously inverted "u" bit */
117 mac[0] = ip->as_u8[8] ^ (1 << 1);
118 mac[1] = ip->as_u8[9];
119 mac[2] = ip->as_u8[10];
120 mac[3] = ip->as_u8[13];
121 mac[4] = ip->as_u8[14];
122 mac[5] = ip->as_u8[15];
126 ip6_link_get (u32 sw_if_index)
130 if (sw_if_index >= vec_len (ip6_links))
133 il = &ip6_links[sw_if_index];
135 if (!ip6_link_is_enabled_i (il))
142 ip6_link_is_enabled (u32 sw_if_index)
144 return (NULL != ip6_link_get (sw_if_index));
149 ip6_link_enable (u32 sw_if_index, const ip6_address_t * link_local_addr)
154 il = ip6_link_get (sw_if_index);
158 const vnet_sw_interface_t *sw_sup;
159 const ethernet_interface_t *eth;
163 vnm = vnet_get_main ();
165 IP6_LINK_INFO ("enable: %U",
166 format_vnet_sw_if_index_name, vnm, sw_if_index);
168 sw_sup = vnet_get_sup_sw_interface (vnm, sw_if_index);
169 vec_validate (ip6_links, sw_if_index);
171 il = &ip6_links[sw_if_index];
173 il->il_sw_if_index = sw_if_index;
174 il->il_mcast_adj = ADJ_INDEX_INVALID;
176 if (sw_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
177 eth = ethernet_get_interface (ðernet_main, sw_sup->hw_if_index);
179 /* use a user provided LL address if given */
180 if (NULL != link_local_addr)
181 ip6_address_copy (&il->il_ll_addr, link_local_addr);
183 /* generate from ethernet MAC */
184 if (ip6_address_is_zero (&il->il_ll_addr) && NULL != eth)
185 ip6_link_local_address_from_mac (&il->il_ll_addr,
186 eth->address.mac.bytes);
188 /* choose a random address */
189 if (ip6_address_is_zero (&il->il_ll_addr))
191 il->il_ll_addr.as_u64[0] =
192 clib_host_to_net_u64 (0xFE80000000000000ULL);
194 /* make up an interface id */
195 il->il_ll_addr.as_u64[1] = random_u64 (&il_randomizer);
198 il->il_ll_addr.as_u8[8] &= 0xfd;
202 ip6_ll_prefix_t ilp = {
203 .ilp_addr = il->il_ll_addr,
204 .ilp_sw_if_index = sw_if_index,
207 ip6_ll_table_entry_update (&ilp, FIB_ROUTE_PATH_LOCAL);
210 /* essentially "enables" ipv6 on this interface */
211 ip6_mfib_interface_enable_disable (sw_if_index, 1);
212 ip6_sw_interface_enable_disable (sw_if_index, 1);
214 /* only ehternet interfaces support MLD and RA, which use the mcast adj
218 adj_mcast_add_or_lock (FIB_PROTOCOL_IP6, VNET_LINK_IP6, sw_if_index);
220 /* inform all register clients */
221 ip6_link_delegate_id_t id;
222 FOREACH_IP6_LINK_DELEGATE_ID (id)
224 if (NULL != il_delegate_vfts[id].ildv_enable)
225 il_delegate_vfts[id].ildv_enable (il->il_sw_if_index);
232 rv = VNET_API_ERROR_VALUE_EXIST;
241 ip6_link_delegate_flush (ip6_link_t * il)
243 ip6_link_delegate_t *ild;
246 FOREACH_IP6_LINK_DELEGATE (ild, il,
248 il_delegate_vfts[ild->ild_type].ildv_disable(ild->ild_index);
252 vec_free (il->il_delegates);
253 il->il_delegates = NULL;
257 ip6_link_last_lock_gone (ip6_link_t * il)
259 ip6_ll_prefix_t ilp = {
260 .ilp_addr = il->il_ll_addr,
261 .ilp_sw_if_index = il->il_sw_if_index,
264 IP6_LINK_INFO ("last-lock: %U",
265 format_vnet_sw_if_index_name,
266 vnet_get_main (), il->il_sw_if_index);
268 ip6_link_delegate_flush (il);
269 ip6_ll_table_entry_delete (&ilp);
271 ip6_mfib_interface_enable_disable (il->il_sw_if_index, 0);
272 ip6_sw_interface_enable_disable (il->il_sw_if_index, 0);
274 ip6_address_set_zero (&il->il_ll_addr);
275 adj_unlock (il->il_mcast_adj);
276 il->il_mcast_adj = ADJ_INDEX_INVALID;
280 ip6_link_unlock (ip6_link_t * il)
287 if (0 == il->il_locks)
288 ip6_link_last_lock_gone (il);
292 ip6_link_disable (u32 sw_if_index)
296 il = ip6_link_get (sw_if_index);
299 return (VNET_API_ERROR_IP6_NOT_ENABLED);
301 IP6_LINK_INFO ("disable: %U",
302 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index);
304 ip6_link_unlock (il);
309 const ip6_address_t *
310 ip6_get_link_local_address (u32 sw_if_index)
312 const ip6_link_t *il;
314 il = ip6_link_get (sw_if_index);
319 return (&il->il_ll_addr);
323 ip6_link_get_mcast_adj (u32 sw_if_index)
325 const ip6_link_t *il;
327 il = ip6_link_get (sw_if_index);
330 return (INDEX_INVALID);
332 return (il->il_mcast_adj);
336 ip6_link_set_local_address (u32 sw_if_index, const ip6_address_t * address)
338 ip6_link_delegate_t *ild;
341 il = ip6_link_get (sw_if_index);
344 return ip6_link_enable (sw_if_index, address);
346 ip6_ll_prefix_t ilp = {
347 .ilp_addr = il->il_ll_addr,
348 .ilp_sw_if_index = sw_if_index,
351 IP6_LINK_INFO ("set-ll: %U -> %U",
352 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
353 format_ip6_address, address);
355 ip6_ll_table_entry_delete (&ilp);
356 ip6_address_copy (&il->il_ll_addr, address);
357 ip6_address_copy (&ilp.ilp_addr, address);
358 ip6_ll_table_entry_update (&ilp, FIB_ROUTE_PATH_LOCAL);
361 FOREACH_IP6_LINK_DELEGATE (ild, il,
363 if (NULL != il_delegate_vfts[ild->ild_type].ildv_ll_change)
364 il_delegate_vfts[ild->ild_type].ildv_ll_change(ild->ild_index,
372 ip6_link_delegate_id_t
373 ip6_link_delegate_register (const ip6_link_delegate_vft_t * vft)
375 ip6_link_delegate_id_t rc = il_delegate_id++;
377 ASSERT (vft->ildv_disable);
379 vec_validate (il_delegate_vfts, rc);
381 il_delegate_vfts[rc] = *vft;
387 ip6_link_delegate_get (u32 sw_if_index, ip6_link_delegate_id_t id)
391 il = ip6_link_get (sw_if_index);
394 return (INDEX_INVALID);
396 vec_validate_init_empty (il->il_delegates, id, ip6_link_delegate_uninit);
398 if (!ip6_link_delegate_is_init (&il->il_delegates[id]))
399 return (INDEX_INVALID);
401 return (il->il_delegates[id].ild_index);
405 ip6_link_delegate_update (u32 sw_if_index,
406 ip6_link_delegate_id_t id, index_t ii)
410 il = ip6_link_get (sw_if_index);
415 vec_validate_init_empty (il->il_delegates, id, ip6_link_delegate_uninit);
417 il->il_delegates[id].ild_sw_if_index = sw_if_index;
418 il->il_delegates[id].ild_type = id;
419 il->il_delegates[id].ild_index = ii;
425 ip6_link_delegate_remove (u32 sw_if_index,
426 ip6_link_delegate_id_t id, index_t ii)
430 il = ip6_link_get (sw_if_index);
434 if (vec_len (il->il_delegates) > id)
436 clib_memcpy (&il->il_delegates[id],
437 &ip6_link_delegate_uninit,
438 sizeof (il->il_delegates[0]));
444 ip6_link_add_del_address (ip6_main_t * im,
447 ip6_address_t * address,
449 u32 if_address_index, u32 is_delete)
451 const ip6_link_delegate_t *ild;
454 if (ip6_address_is_link_local_unicast (address))
455 // only interested in global addresses here
458 IP6_LINK_INFO ("addr-%s: %U -> %U",
459 (is_delete ? "del" : "add"),
460 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
461 format_ip6_address, address);
463 il = ip6_link_get (sw_if_index);
469 FOREACH_IP6_LINK_DELEGATE (ild, il,
473 if (NULL != il_delegate_vfts[ild->ild_type].ildv_addr_del)
474 il_delegate_vfts[ild->ild_type].ildv_addr_del(ild->ild_index,
475 address, address_length);
479 if (NULL != il_delegate_vfts[ild->ild_type].ildv_addr_add)
480 il_delegate_vfts[ild->ild_type].ildv_addr_add(ild->ild_index,
481 address, address_length);
487 static clib_error_t *
488 ip6_link_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
494 il = ip6_link_get (sw_if_index);
496 IP6_LINK_DBG ("link-del: %U",
497 format_vnet_sw_if_index_name, vnet_get_main (),
502 ip6_link_last_lock_gone (il);
508 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip6_link_interface_add_del);
510 static clib_error_t *
511 ip6_link_init (vlib_main_t * vm)
513 il_randomizer = clib_cpu_time_now ();
514 ip6_link_logger = vlib_log_register_class ("ip6", "link");
517 ip6_add_del_interface_address_callback_t cb = {
518 .function = ip6_link_add_del_address,
520 vec_add1 (ip6_main.add_del_interface_address_callbacks, cb);
525 VLIB_INIT_FUNCTION (ip6_link_init);
528 static clib_error_t *
529 test_ip6_link_command_fn (vlib_main_t * vm,
530 unformat_input_t * input, vlib_cli_command_t * cmd)
533 ip6_address_t _a, *a = &_a;
535 if (unformat (input, "%U", unformat_ethernet_address, mac))
537 ip6_link_local_address_from_mac (a, mac);
538 vlib_cli_output (vm, "Link local address: %U", format_ip6_address, a);
539 ip6_mac_address_from_link_local (mac, a);
540 vlib_cli_output (vm, "Original MAC address: %U",
541 format_ethernet_address, mac);
548 * This command converts the given MAC Address into an IPv6 link-local
552 * Example of how to create an IPv6 link-local address:
553 * @cliexstart{test ip6 link 16:d9:e0:91:79:86}
554 * Link local address: fe80::14d9:e0ff:fe91:7986
555 * Original MAC address: 16:d9:e0:91:79:86
559 VLIB_CLI_COMMAND (test_link_command, static) =
561 .path = "test ip6 link",
562 .function = test_ip6_link_command_fn,
563 .short_help = "test ip6 link <mac-address>",
568 ip6_print_addrs (u8 * s, u32 * addrs)
570 ip_lookup_main_t *lm = &ip6_main.lookup_main;
573 for (i = 0; i < vec_len (addrs); i++)
575 ip_interface_address_t *a =
576 pool_elt_at_index (lm->if_address_pool, addrs[i]);
577 ip6_address_t *address = ip_interface_address_get_address (lm, a);
579 s = format (s, "%U%U/%d\n",
580 format_white_space, 4,
581 format_ip6_address, address, a->address_length);
588 format_ip6_link (u8 * s, va_list * arg)
590 const ip6_link_t *il = va_arg (*arg, ip6_link_t *);
591 ip_lookup_main_t *lm = &ip6_main.lookup_main;
592 vnet_main_t *vnm = vnet_get_main ();
594 if (!ip6_link_is_enabled_i (il))
597 s = format (s, "%U is admin %s\n",
598 format_vnet_sw_interface_name, vnm,
599 vnet_get_sw_interface (vnm, il->il_sw_if_index),
600 (vnet_sw_interface_is_admin_up (vnm, il->il_sw_if_index) ?
604 u32 *link_scope = 0, *global_scope = 0;
605 u32 *local_scope = 0, *unknown_scope = 0;
606 ip_interface_address_t *a;
607 const ip6_link_delegate_t *ild;
609 vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index,
610 il->il_sw_if_index, ~0);
611 ai = lm->if_address_pool_index_by_sw_if_index[il->il_sw_if_index];
613 while (ai != (u32) ~ 0)
615 a = pool_elt_at_index (lm->if_address_pool, ai);
616 ip6_address_t *address = ip_interface_address_get_address (lm, a);
618 if (ip6_address_is_link_local_unicast (address))
619 vec_add1 (link_scope, ai);
620 else if (ip6_address_is_global_unicast (address))
621 vec_add1 (global_scope, ai);
622 else if (ip6_address_is_local_unicast (address))
623 vec_add1 (local_scope, ai);
625 vec_add1 (unknown_scope, ai);
627 ai = a->next_this_sw_interface;
630 if (vec_len (link_scope))
632 s = format (s, "%ULink-local address(es):\n", format_white_space, 2);
633 s = ip6_print_addrs (s, link_scope);
634 vec_free (link_scope);
637 if (vec_len (local_scope))
639 s = format (s, "%ULocal unicast address(es):\n", format_white_space, 2);
640 s = ip6_print_addrs (s, local_scope);
641 vec_free (local_scope);
644 if (vec_len (global_scope))
646 s = format (s, "%UGlobal unicast address(es):\n",
647 format_white_space, 2);
648 s = ip6_print_addrs (s, global_scope);
649 vec_free (global_scope);
652 if (vec_len (unknown_scope))
654 s = format (s, "%UOther-scope address(es):\n", format_white_space, 2);
655 s = ip6_print_addrs (s, unknown_scope);
656 vec_free (unknown_scope);
659 s = format (s, "%ULink-local address(es):\n", format_white_space, 2);
660 s = format (s, "%U%U\n",
661 format_white_space, 4, format_ip6_address, &il->il_ll_addr);
664 FOREACH_IP6_LINK_DELEGATE(ild, il,
666 s = format (s, "%U", il_delegate_vfts[ild->ild_type].ildv_format,
674 static clib_error_t *
675 ip6_link_show (vlib_main_t * vm,
676 unformat_input_t * input, vlib_cli_command_t * cmd)
678 const ip6_link_t *il;
682 vnm = vnet_get_main ();
685 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
687 il = ip6_link_get (sw_if_index);
691 vlib_cli_output (vm, "IP6 disabled");
695 vlib_cli_output (vm, "%U", format_ip6_link, il);
699 vec_foreach (il, ip6_links)
700 vlib_cli_output (vm, "%U", format_ip6_link, il);
707 * This command is used to display various IPv6 attributes on a given
711 * Example of how to display IPv6 settings:
712 * @cliexstart{show ip6 interface GigabitEthernet2/0/0}
713 * GigabitEthernet2/0/0 is admin up
714 * Link-local address(es):
716 * Joined group address(es):
721 * Advertised Prefixes:
722 * prefix fe80::fe:28ff:fe9c:75b3, length 64
724 * ICMP error messages are unlimited
725 * ICMP redirects are disabled
726 * ICMP unreachables are not sent
728 * ND advertised reachable time is 0
729 * ND advertised retransmit interval is 0 (msec)
730 * ND router advertisements are sent every 200 seconds (min interval is 150)
731 * ND router advertisements live for 600 seconds
732 * Hosts use stateless autoconfig for addresses
733 * ND router advertisements sent 19336
734 * ND router solicitations received 0
735 * ND router solicitations dropped 0
737 * Example of output if IPv6 is not enabled on the interface:
738 * @cliexstart{show ip6 interface GigabitEthernet2/0/0}
739 * show ip6 interface: IPv6 not enabled on interface
743 VLIB_CLI_COMMAND (ip6_link_show_command, static) =
745 .path = "show ip6 interface",
746 .function = ip6_link_show,
747 .short_help = "show ip6 interface <interface>",
751 static clib_error_t *
752 enable_ip6_interface_cmd (vlib_main_t * vm,
753 unformat_input_t * input, vlib_cli_command_t * cmd)
755 vnet_main_t *vnm = vnet_get_main ();
756 clib_error_t *error = NULL;
761 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
763 if (ip6_link_enable (sw_if_index, NULL))
764 error = clib_error_return (0, "Failed\n");
768 error = clib_error_return (0, "unknown interface\n'",
769 format_unformat_error, input);
776 * This command is used to enable IPv6 on a given interface.
779 * Example of how enable IPv6 on a given interface:
780 * @cliexcmd{enable ip6 interface GigabitEthernet2/0/0}
783 VLIB_CLI_COMMAND (enable_ip6_interface_command, static) =
785 .path = "enable ip6 interface",
786 .function = enable_ip6_interface_cmd,
787 .short_help = "enable ip6 interface <interface>",
791 static clib_error_t *
792 disable_ip6_interface_cmd (vlib_main_t * vm,
793 unformat_input_t * input, vlib_cli_command_t * cmd)
795 vnet_main_t *vnm = vnet_get_main ();
796 clib_error_t *error = NULL;
801 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
803 if (ip6_link_disable (sw_if_index))
804 error = clib_error_return (0, "Failed\n");
808 error = clib_error_return (0, "unknown interface\n'",
809 format_unformat_error, input);
816 * This command is used to disable IPv6 on a given interface.
819 * Example of how disable IPv6 on a given interface:
820 * @cliexcmd{disable ip6 interface GigabitEthernet2/0/0}
823 VLIB_CLI_COMMAND (disable_ip6_interface_command, static) =
825 .path = "disable ip6 interface",
826 .function = disable_ip6_interface_cmd,
827 .short_help = "disable ip6 interface <interface>",
832 * fd.io coding-style-patch-verification: ON
835 * eval: (c-set-style "gnu")