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)
154 il = ip6_link_get (sw_if_index);
158 const vnet_sw_interface_t *sw, *sw_sup;
159 const ethernet_interface_t *eth;
162 vnm = vnet_get_main ();
164 IP6_LINK_INFO ("enable: %U",
165 format_vnet_sw_if_index_name, vnm, sw_if_index);
167 sw_sup = vnet_get_sup_sw_interface (vnm, sw_if_index);
168 if (sw_sup->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
170 rv = VNET_API_ERROR_UNSUPPORTED;
174 eth = ethernet_get_interface (ðernet_main, sw_sup->hw_if_index);
178 rv = VNET_API_ERROR_UNSUPPORTED;
182 vec_validate (ip6_links, sw_if_index);
184 il = &ip6_links[sw_if_index];
186 il->il_sw_if_index = sw_if_index;
188 sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
190 if (sw->type == VNET_SW_INTERFACE_TYPE_SUB ||
191 sw->type == VNET_SW_INTERFACE_TYPE_PIPE ||
192 sw->type == VNET_SW_INTERFACE_TYPE_P2P)
194 il->il_ll_addr.as_u64[0] =
195 clib_host_to_net_u64 (0xFE80000000000000ULL);
197 /* make up an interface id */
198 il->il_ll_addr.as_u64[1] = random_u64 (&il_randomizer);
201 il->il_ll_addr.as_u8[8] &= 0xfd;
205 ip6_link_local_address_from_mac (&il->il_ll_addr, eth->address);
209 ip6_ll_prefix_t ilp = {
210 .ilp_addr = il->il_ll_addr,
211 .ilp_sw_if_index = sw_if_index,
214 ip6_ll_table_entry_update (&ilp, FIB_ROUTE_PATH_LOCAL);
217 /* essentially "enables" ipv6 on this interface */
218 ip6_mfib_interface_enable_disable (sw_if_index, 1);
219 ip6_sw_interface_enable_disable (sw_if_index, 1);
221 il->il_mcast_adj = adj_mcast_add_or_lock (FIB_PROTOCOL_IP6,
222 VNET_LINK_IP6, sw_if_index);
224 /* inform all register clients */
225 ip6_link_delegate_id_t id;
226 FOREACH_IP6_LINK_DELEGATE_ID (id)
228 if (NULL != il_delegate_vfts[id].ildv_enable)
229 il_delegate_vfts[id].ildv_enable (il->il_sw_if_index);
236 rv = VNET_API_ERROR_VALUE_EXIST;
244 ip6_link_delegate_flush (ip6_link_t * il)
246 ip6_link_delegate_t *ild;
249 FOREACH_IP6_LINK_DELEGATE (ild, il,
251 il_delegate_vfts[ild->ild_type].ildv_disable(ild->ild_index);
255 vec_free (il->il_delegates);
256 il->il_delegates = NULL;
260 ip6_link_last_lock_gone (ip6_link_t * il)
262 ip6_ll_prefix_t ilp = {
263 .ilp_addr = il->il_ll_addr,
264 .ilp_sw_if_index = il->il_sw_if_index,
267 IP6_LINK_INFO ("last-lock: %U",
268 format_vnet_sw_if_index_name,
269 vnet_get_main (), il->il_sw_if_index);
271 ip6_link_delegate_flush (il);
272 ip6_ll_table_entry_delete (&ilp);
274 ip6_mfib_interface_enable_disable (il->il_sw_if_index, 0);
275 ip6_sw_interface_enable_disable (il->il_sw_if_index, 0);
277 ip6_address_set_zero (&il->il_ll_addr);
278 adj_unlock (il->il_mcast_adj);
279 il->il_mcast_adj = ADJ_INDEX_INVALID;
283 ip6_link_unlock (ip6_link_t * il)
290 if (0 == il->il_locks)
291 ip6_link_last_lock_gone (il);
295 ip6_link_disable (u32 sw_if_index)
299 il = ip6_link_get (sw_if_index);
302 return (VNET_API_ERROR_IP6_NOT_ENABLED);
304 IP6_LINK_INFO ("disable: %U",
305 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index);
307 ip6_link_unlock (il);
312 const ip6_address_t *
313 ip6_get_link_local_address (u32 sw_if_index)
315 const ip6_link_t *il;
317 vec_validate (ip6_links, sw_if_index);
319 il = &ip6_links[sw_if_index];
321 return (&il->il_ll_addr);
325 ip6_link_get_mcast_adj (u32 sw_if_index)
327 const ip6_link_t *il;
329 il = &ip6_links[sw_if_index];
331 return (il->il_mcast_adj);
335 ip6_src_address_for_packet (u32 sw_if_index,
336 const ip6_address_t * dst, ip6_address_t * src)
338 ip_lookup_main_t *lm;
340 lm = &ip6_main.lookup_main;
342 if (ip6_address_is_link_local_unicast (dst))
344 ip6_address_copy (src, ip6_get_link_local_address (sw_if_index));
351 lm->if_address_pool_index_by_sw_if_index[sw_if_index];
352 if (PREDICT_TRUE (if_add_index != ~0))
354 ip_interface_address_t *if_add =
355 pool_elt_at_index (lm->if_address_pool, if_add_index);
356 ip6_address_t *if_ip =
357 ip_interface_address_get_address (lm, if_add);
370 ip6_set_link_local_address (u32 sw_if_index, const ip6_address_t * address)
372 ip6_link_delegate_t *ild;
375 il = ip6_link_get (sw_if_index);
378 return (VNET_API_ERROR_IP6_NOT_ENABLED);
380 ip6_ll_prefix_t ilp = {
381 .ilp_addr = il->il_ll_addr,
382 .ilp_sw_if_index = sw_if_index,
385 IP6_LINK_INFO ("set-ll: %U -> %U",
386 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
387 format_ip6_address, address);
389 ip6_ll_table_entry_delete (&ilp);
390 ip6_address_copy (&il->il_ll_addr, address);
391 ip6_address_copy (&ilp.ilp_addr, address);
392 ip6_ll_table_entry_update (&ilp, FIB_ROUTE_PATH_LOCAL);
395 FOREACH_IP6_LINK_DELEGATE (ild, il,
397 if (NULL != il_delegate_vfts[ild->ild_type].ildv_ll_change)
398 il_delegate_vfts[ild->ild_type].ildv_ll_change(ild->ild_index,
406 ip6_link_delegate_id_t
407 ip6_link_delegate_register (const ip6_link_delegate_vft_t * vft)
409 ip6_link_delegate_id_t rc = il_delegate_id++;
411 ASSERT (vft->ildv_disable);
413 vec_validate (il_delegate_vfts, rc);
415 il_delegate_vfts[rc] = *vft;
421 ip6_link_delegate_get (u32 sw_if_index, ip6_link_delegate_id_t id)
425 il = ip6_link_get (sw_if_index);
428 return (INDEX_INVALID);
430 vec_validate_init_empty (il->il_delegates, id, ip6_link_delegate_uninit);
432 if (!ip6_link_delegate_is_init (&il->il_delegates[id]))
433 return (INDEX_INVALID);
435 return (il->il_delegates[id].ild_index);
439 ip6_link_delegate_update (u32 sw_if_index,
440 ip6_link_delegate_id_t id, index_t ii)
444 il = ip6_link_get (sw_if_index);
449 vec_validate_init_empty (il->il_delegates, id, ip6_link_delegate_uninit);
451 il->il_delegates[id].ild_sw_if_index = sw_if_index;
452 il->il_delegates[id].ild_type = id;
453 il->il_delegates[id].ild_index = ii;
459 ip6_link_delegate_remove (u32 sw_if_index,
460 ip6_link_delegate_id_t id, index_t ii)
464 il = ip6_link_get (sw_if_index);
468 if (vec_len (il->il_delegates) > id)
470 clib_memcpy (&il->il_delegates[id],
471 &ip6_link_delegate_uninit,
472 sizeof (il->il_delegates[0]));
478 ip6_link_add_del_address (ip6_main_t * im,
481 ip6_address_t * address,
483 u32 if_address_index, u32 is_delete)
485 const ip6_link_delegate_t *ild;
488 if (ip6_address_is_link_local_unicast (address))
489 // only interested in global addresses here
492 IP6_LINK_INFO ("addr-%s: %U -> %U",
493 (is_delete ? "del" : "add"),
494 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
495 format_ip6_address, address);
497 il = ip6_link_get (sw_if_index);
503 FOREACH_IP6_LINK_DELEGATE (ild, il,
507 if (NULL != il_delegate_vfts[ild->ild_type].ildv_addr_del)
508 il_delegate_vfts[ild->ild_type].ildv_addr_del(ild->ild_index,
509 address, address_length);
513 if (NULL != il_delegate_vfts[ild->ild_type].ildv_addr_add)
514 il_delegate_vfts[ild->ild_type].ildv_addr_add(ild->ild_index,
515 address, address_length);
521 static clib_error_t *
522 ip6_link_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
528 il = ip6_link_get (sw_if_index);
530 IP6_LINK_DBG ("link-del: %U",
531 format_vnet_sw_if_index_name, vnet_get_main (),
536 ip6_link_last_lock_gone (il);
542 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip6_link_interface_add_del);
544 static clib_error_t *
545 ip6_link_init (vlib_main_t * vm)
547 il_randomizer = clib_cpu_time_now ();
548 ip6_link_logger = vlib_log_register_class ("ip6", "link");
551 ip6_add_del_interface_address_callback_t cb = {
552 .function = ip6_link_add_del_address,
554 vec_add1 (ip6_main.add_del_interface_address_callbacks, cb);
559 VLIB_INIT_FUNCTION (ip6_link_init);
562 static clib_error_t *
563 test_ip6_link_command_fn (vlib_main_t * vm,
564 unformat_input_t * input, vlib_cli_command_t * cmd)
567 ip6_address_t _a, *a = &_a;
569 if (unformat (input, "%U", unformat_ethernet_address, mac))
571 ip6_link_local_address_from_mac (a, mac);
572 vlib_cli_output (vm, "Link local address: %U", format_ip6_address, a);
573 ip6_mac_address_from_link_local (mac, a);
574 vlib_cli_output (vm, "Original MAC address: %U",
575 format_ethernet_address, mac);
582 * This command converts the given MAC Address into an IPv6 link-local
586 * Example of how to create an IPv6 link-local address:
587 * @cliexstart{test ip6 link 16:d9:e0:91:79:86}
588 * Link local address: fe80::14d9:e0ff:fe91:7986
589 * Original MAC address: 16:d9:e0:91:79:86
593 VLIB_CLI_COMMAND (test_link_command, static) =
595 .path = "test ip6 link",
596 .function = test_ip6_link_command_fn,
597 .short_help = "test ip6 link <mac-address>",
602 ip6_print_addrs (u8 * s, u32 * addrs)
604 ip_lookup_main_t *lm = &ip6_main.lookup_main;
607 for (i = 0; i < vec_len (addrs); i++)
609 ip_interface_address_t *a =
610 pool_elt_at_index (lm->if_address_pool, addrs[i]);
611 ip6_address_t *address = ip_interface_address_get_address (lm, a);
613 s = format (s, "%U%U/%d\n",
614 format_white_space, 4,
615 format_ip6_address, address, a->address_length);
622 format_ip6_link (u8 * s, va_list * arg)
624 const ip6_link_t *il = va_arg (*arg, ip6_link_t *);
625 ip_lookup_main_t *lm = &ip6_main.lookup_main;
626 vnet_main_t *vnm = vnet_get_main ();
628 if (!ip6_link_is_enabled_i (il))
631 s = format (s, "%U is admin %s\n",
632 format_vnet_sw_interface_name, vnm,
633 vnet_get_sw_interface (vnm, il->il_sw_if_index),
634 (vnet_sw_interface_is_admin_up (vnm, il->il_sw_if_index) ?
638 u32 *link_scope = 0, *global_scope = 0;
639 u32 *local_scope = 0, *unknown_scope = 0;
640 ip_interface_address_t *a;
641 const ip6_link_delegate_t *ild;
643 vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index,
644 il->il_sw_if_index, ~0);
645 ai = lm->if_address_pool_index_by_sw_if_index[il->il_sw_if_index];
647 while (ai != (u32) ~ 0)
649 a = pool_elt_at_index (lm->if_address_pool, ai);
650 ip6_address_t *address = ip_interface_address_get_address (lm, a);
652 if (ip6_address_is_link_local_unicast (address))
653 vec_add1 (link_scope, ai);
654 else if (ip6_address_is_global_unicast (address))
655 vec_add1 (global_scope, ai);
656 else if (ip6_address_is_local_unicast (address))
657 vec_add1 (local_scope, ai);
659 vec_add1 (unknown_scope, ai);
661 ai = a->next_this_sw_interface;
664 if (vec_len (link_scope))
666 s = format (s, "%ULink-local address(es):\n", format_white_space, 2);
667 s = ip6_print_addrs (s, link_scope);
668 vec_free (link_scope);
671 if (vec_len (local_scope))
673 s = format (s, "%ULocal unicast address(es):\n", format_white_space, 2);
674 s = ip6_print_addrs (s, local_scope);
675 vec_free (local_scope);
678 if (vec_len (global_scope))
680 s = format (s, "%UGlobal unicast address(es):\n",
681 format_white_space, 2);
682 s = ip6_print_addrs (s, global_scope);
683 vec_free (global_scope);
686 if (vec_len (unknown_scope))
688 s = format (s, "%UOther-scope address(es):\n", format_white_space, 2);
689 s = ip6_print_addrs (s, unknown_scope);
690 vec_free (unknown_scope);
693 s = format (s, "%ULink-local address(es):\n", format_white_space, 2);
694 s = format (s, "%U%U\n",
695 format_white_space, 4, format_ip6_address, &il->il_ll_addr);
698 FOREACH_IP6_LINK_DELEGATE(ild, il,
700 s = format (s, "%U", il_delegate_vfts[ild->ild_type].ildv_format,
708 static clib_error_t *
709 ip6_link_show (vlib_main_t * vm,
710 unformat_input_t * input, vlib_cli_command_t * cmd)
712 const ip6_link_t *il;
716 vnm = vnet_get_main ();
719 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
721 il = ip6_link_get (sw_if_index);
725 vlib_cli_output (vm, "IP6 disabled");
729 vlib_cli_output (vm, "%U", format_ip6_link, il);
733 vec_foreach (il, ip6_links)
734 vlib_cli_output (vm, "%U", format_ip6_link, il);
741 * This command is used to display various IPv6 attributes on a given
745 * Example of how to display IPv6 settings:
746 * @cliexstart{show ip6 interface GigabitEthernet2/0/0}
747 * GigabitEthernet2/0/0 is admin up
748 * Link-local address(es):
750 * Joined group address(es):
755 * Advertised Prefixes:
756 * prefix fe80::fe:28ff:fe9c:75b3, length 64
758 * ICMP error messages are unlimited
759 * ICMP redirects are disabled
760 * ICMP unreachables are not sent
762 * ND advertised reachable time is 0
763 * ND advertised retransmit interval is 0 (msec)
764 * ND router advertisements are sent every 200 seconds (min interval is 150)
765 * ND router advertisements live for 600 seconds
766 * Hosts use stateless autoconfig for addresses
767 * ND router advertisements sent 19336
768 * ND router solicitations received 0
769 * ND router solicitations dropped 0
771 * Example of output if IPv6 is not enabled on the interface:
772 * @cliexstart{show ip6 interface GigabitEthernet2/0/0}
773 * show ip6 interface: IPv6 not enabled on interface
777 VLIB_CLI_COMMAND (ip6_link_show_command, static) =
779 .path = "show ip6 interface",
780 .function = ip6_link_show,
781 .short_help = "show ip6 interface <interface>",
785 static clib_error_t *
786 enable_ip6_interface_cmd (vlib_main_t * vm,
787 unformat_input_t * input, vlib_cli_command_t * cmd)
789 vnet_main_t *vnm = vnet_get_main ();
790 clib_error_t *error = NULL;
795 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
797 if (ip6_link_enable (sw_if_index))
798 error = clib_error_return (0, "Failed\n");
802 error = clib_error_return (0, "unknown interface\n'",
803 format_unformat_error, input);
810 * This command is used to enable IPv6 on a given interface.
813 * Example of how enable IPv6 on a given interface:
814 * @cliexcmd{enable ip6 interface GigabitEthernet2/0/0}
817 VLIB_CLI_COMMAND (enable_ip6_interface_command, static) =
819 .path = "enable ip6 interface",
820 .function = enable_ip6_interface_cmd,
821 .short_help = "enable ip6 interface <interface>",
825 static clib_error_t *
826 disable_ip6_interface_cmd (vlib_main_t * vm,
827 unformat_input_t * input, vlib_cli_command_t * cmd)
829 vnet_main_t *vnm = vnet_get_main ();
830 clib_error_t *error = NULL;
835 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
837 if (ip6_link_disable (sw_if_index))
838 error = clib_error_return (0, "Failed\n");
842 error = clib_error_return (0, "unknown interface\n'",
843 format_unformat_error, input);
850 * This command is used to disable IPv6 on a given interface.
853 * Example of how disable IPv6 on a given interface:
854 * @cliexcmd{disable ip6 interface GigabitEthernet2/0/0}
857 VLIB_CLI_COMMAND (disable_ip6_interface_command, static) =
859 .path = "disable ip6 interface",
860 .function = disable_ip6_interface_cmd,
861 .short_help = "disable ip6 interface <interface>",
866 * fd.io coding-style-patch-verification: ON
869 * eval: (c-set-style "gnu")