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, *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 (NULL != link_local_addr)
191 ip6_address_copy (&il->il_ll_addr, link_local_addr);
192 else if (sw->type == VNET_SW_INTERFACE_TYPE_SUB ||
193 sw->type == VNET_SW_INTERFACE_TYPE_PIPE ||
194 sw->type == VNET_SW_INTERFACE_TYPE_P2P)
196 il->il_ll_addr.as_u64[0] =
197 clib_host_to_net_u64 (0xFE80000000000000ULL);
199 /* make up an interface id */
200 il->il_ll_addr.as_u64[1] = random_u64 (&il_randomizer);
203 il->il_ll_addr.as_u8[8] &= 0xfd;
207 ip6_link_local_address_from_mac (&il->il_ll_addr, eth->address);
211 ip6_ll_prefix_t ilp = {
212 .ilp_addr = il->il_ll_addr,
213 .ilp_sw_if_index = sw_if_index,
216 ip6_ll_table_entry_update (&ilp, FIB_ROUTE_PATH_LOCAL);
219 /* essentially "enables" ipv6 on this interface */
220 ip6_mfib_interface_enable_disable (sw_if_index, 1);
221 ip6_sw_interface_enable_disable (sw_if_index, 1);
223 il->il_mcast_adj = adj_mcast_add_or_lock (FIB_PROTOCOL_IP6,
224 VNET_LINK_IP6, sw_if_index);
226 /* inform all register clients */
227 ip6_link_delegate_id_t id;
228 FOREACH_IP6_LINK_DELEGATE_ID (id)
230 if (NULL != il_delegate_vfts[id].ildv_enable)
231 il_delegate_vfts[id].ildv_enable (il->il_sw_if_index);
238 rv = VNET_API_ERROR_VALUE_EXIST;
248 ip6_link_delegate_flush (ip6_link_t * il)
250 ip6_link_delegate_t *ild;
253 FOREACH_IP6_LINK_DELEGATE (ild, il,
255 il_delegate_vfts[ild->ild_type].ildv_disable(ild->ild_index);
259 vec_free (il->il_delegates);
260 il->il_delegates = NULL;
264 ip6_link_last_lock_gone (ip6_link_t * il)
266 ip6_ll_prefix_t ilp = {
267 .ilp_addr = il->il_ll_addr,
268 .ilp_sw_if_index = il->il_sw_if_index,
271 IP6_LINK_INFO ("last-lock: %U",
272 format_vnet_sw_if_index_name,
273 vnet_get_main (), il->il_sw_if_index);
275 ip6_link_delegate_flush (il);
276 ip6_ll_table_entry_delete (&ilp);
278 ip6_mfib_interface_enable_disable (il->il_sw_if_index, 0);
279 ip6_sw_interface_enable_disable (il->il_sw_if_index, 0);
281 ip6_address_set_zero (&il->il_ll_addr);
282 adj_unlock (il->il_mcast_adj);
283 il->il_mcast_adj = ADJ_INDEX_INVALID;
287 ip6_link_unlock (ip6_link_t * il)
294 if (0 == il->il_locks)
295 ip6_link_last_lock_gone (il);
299 ip6_link_disable (u32 sw_if_index)
303 il = ip6_link_get (sw_if_index);
306 return (VNET_API_ERROR_IP6_NOT_ENABLED);
308 IP6_LINK_INFO ("disable: %U",
309 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index);
311 ip6_link_unlock (il);
316 const ip6_address_t *
317 ip6_get_link_local_address (u32 sw_if_index)
319 const ip6_link_t *il;
321 vec_validate (ip6_links, sw_if_index);
323 il = &ip6_links[sw_if_index];
325 return (&il->il_ll_addr);
329 ip6_link_get_mcast_adj (u32 sw_if_index)
331 const ip6_link_t *il;
333 il = &ip6_links[sw_if_index];
335 return (il->il_mcast_adj);
339 ip6_src_address_for_packet (u32 sw_if_index,
340 const ip6_address_t * dst, ip6_address_t * src)
342 ip_lookup_main_t *lm;
344 lm = &ip6_main.lookup_main;
346 if (ip6_address_is_link_local_unicast (dst))
348 ip6_address_copy (src, ip6_get_link_local_address (sw_if_index));
355 lm->if_address_pool_index_by_sw_if_index[sw_if_index];
356 if (PREDICT_TRUE (if_add_index != ~0))
358 ip_interface_address_t *if_add =
359 pool_elt_at_index (lm->if_address_pool, if_add_index);
360 ip6_address_t *if_ip =
361 ip_interface_address_get_address (lm, if_add);
374 ip6_link_set_local_address (u32 sw_if_index, const ip6_address_t * address)
376 ip6_link_delegate_t *ild;
379 il = ip6_link_get (sw_if_index);
382 return ip6_link_enable (sw_if_index, address);
384 ip6_ll_prefix_t ilp = {
385 .ilp_addr = il->il_ll_addr,
386 .ilp_sw_if_index = sw_if_index,
389 IP6_LINK_INFO ("set-ll: %U -> %U",
390 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
391 format_ip6_address, address);
393 ip6_ll_table_entry_delete (&ilp);
394 ip6_address_copy (&il->il_ll_addr, address);
395 ip6_address_copy (&ilp.ilp_addr, address);
396 ip6_ll_table_entry_update (&ilp, FIB_ROUTE_PATH_LOCAL);
399 FOREACH_IP6_LINK_DELEGATE (ild, il,
401 if (NULL != il_delegate_vfts[ild->ild_type].ildv_ll_change)
402 il_delegate_vfts[ild->ild_type].ildv_ll_change(ild->ild_index,
410 ip6_link_delegate_id_t
411 ip6_link_delegate_register (const ip6_link_delegate_vft_t * vft)
413 ip6_link_delegate_id_t rc = il_delegate_id++;
415 ASSERT (vft->ildv_disable);
417 vec_validate (il_delegate_vfts, rc);
419 il_delegate_vfts[rc] = *vft;
425 ip6_link_delegate_get (u32 sw_if_index, ip6_link_delegate_id_t id)
429 il = ip6_link_get (sw_if_index);
432 return (INDEX_INVALID);
434 vec_validate_init_empty (il->il_delegates, id, ip6_link_delegate_uninit);
436 if (!ip6_link_delegate_is_init (&il->il_delegates[id]))
437 return (INDEX_INVALID);
439 return (il->il_delegates[id].ild_index);
443 ip6_link_delegate_update (u32 sw_if_index,
444 ip6_link_delegate_id_t id, index_t ii)
448 il = ip6_link_get (sw_if_index);
453 vec_validate_init_empty (il->il_delegates, id, ip6_link_delegate_uninit);
455 il->il_delegates[id].ild_sw_if_index = sw_if_index;
456 il->il_delegates[id].ild_type = id;
457 il->il_delegates[id].ild_index = ii;
463 ip6_link_delegate_remove (u32 sw_if_index,
464 ip6_link_delegate_id_t id, index_t ii)
468 il = ip6_link_get (sw_if_index);
472 if (vec_len (il->il_delegates) > id)
474 clib_memcpy (&il->il_delegates[id],
475 &ip6_link_delegate_uninit,
476 sizeof (il->il_delegates[0]));
482 ip6_link_add_del_address (ip6_main_t * im,
485 ip6_address_t * address,
487 u32 if_address_index, u32 is_delete)
489 const ip6_link_delegate_t *ild;
492 if (ip6_address_is_link_local_unicast (address))
493 // only interested in global addresses here
496 IP6_LINK_INFO ("addr-%s: %U -> %U",
497 (is_delete ? "del" : "add"),
498 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
499 format_ip6_address, address);
501 il = ip6_link_get (sw_if_index);
507 FOREACH_IP6_LINK_DELEGATE (ild, il,
511 if (NULL != il_delegate_vfts[ild->ild_type].ildv_addr_del)
512 il_delegate_vfts[ild->ild_type].ildv_addr_del(ild->ild_index,
513 address, address_length);
517 if (NULL != il_delegate_vfts[ild->ild_type].ildv_addr_add)
518 il_delegate_vfts[ild->ild_type].ildv_addr_add(ild->ild_index,
519 address, address_length);
525 static clib_error_t *
526 ip6_link_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
532 il = ip6_link_get (sw_if_index);
534 IP6_LINK_DBG ("link-del: %U",
535 format_vnet_sw_if_index_name, vnet_get_main (),
540 ip6_link_last_lock_gone (il);
546 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip6_link_interface_add_del);
548 static clib_error_t *
549 ip6_link_init (vlib_main_t * vm)
551 il_randomizer = clib_cpu_time_now ();
552 ip6_link_logger = vlib_log_register_class ("ip6", "link");
555 ip6_add_del_interface_address_callback_t cb = {
556 .function = ip6_link_add_del_address,
558 vec_add1 (ip6_main.add_del_interface_address_callbacks, cb);
563 VLIB_INIT_FUNCTION (ip6_link_init);
566 static clib_error_t *
567 test_ip6_link_command_fn (vlib_main_t * vm,
568 unformat_input_t * input, vlib_cli_command_t * cmd)
571 ip6_address_t _a, *a = &_a;
573 if (unformat (input, "%U", unformat_ethernet_address, mac))
575 ip6_link_local_address_from_mac (a, mac);
576 vlib_cli_output (vm, "Link local address: %U", format_ip6_address, a);
577 ip6_mac_address_from_link_local (mac, a);
578 vlib_cli_output (vm, "Original MAC address: %U",
579 format_ethernet_address, mac);
586 * This command converts the given MAC Address into an IPv6 link-local
590 * Example of how to create an IPv6 link-local address:
591 * @cliexstart{test ip6 link 16:d9:e0:91:79:86}
592 * Link local address: fe80::14d9:e0ff:fe91:7986
593 * Original MAC address: 16:d9:e0:91:79:86
597 VLIB_CLI_COMMAND (test_link_command, static) =
599 .path = "test ip6 link",
600 .function = test_ip6_link_command_fn,
601 .short_help = "test ip6 link <mac-address>",
606 ip6_print_addrs (u8 * s, u32 * addrs)
608 ip_lookup_main_t *lm = &ip6_main.lookup_main;
611 for (i = 0; i < vec_len (addrs); i++)
613 ip_interface_address_t *a =
614 pool_elt_at_index (lm->if_address_pool, addrs[i]);
615 ip6_address_t *address = ip_interface_address_get_address (lm, a);
617 s = format (s, "%U%U/%d\n",
618 format_white_space, 4,
619 format_ip6_address, address, a->address_length);
626 format_ip6_link (u8 * s, va_list * arg)
628 const ip6_link_t *il = va_arg (*arg, ip6_link_t *);
629 ip_lookup_main_t *lm = &ip6_main.lookup_main;
630 vnet_main_t *vnm = vnet_get_main ();
632 if (!ip6_link_is_enabled_i (il))
635 s = format (s, "%U is admin %s\n",
636 format_vnet_sw_interface_name, vnm,
637 vnet_get_sw_interface (vnm, il->il_sw_if_index),
638 (vnet_sw_interface_is_admin_up (vnm, il->il_sw_if_index) ?
642 u32 *link_scope = 0, *global_scope = 0;
643 u32 *local_scope = 0, *unknown_scope = 0;
644 ip_interface_address_t *a;
645 const ip6_link_delegate_t *ild;
647 vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index,
648 il->il_sw_if_index, ~0);
649 ai = lm->if_address_pool_index_by_sw_if_index[il->il_sw_if_index];
651 while (ai != (u32) ~ 0)
653 a = pool_elt_at_index (lm->if_address_pool, ai);
654 ip6_address_t *address = ip_interface_address_get_address (lm, a);
656 if (ip6_address_is_link_local_unicast (address))
657 vec_add1 (link_scope, ai);
658 else if (ip6_address_is_global_unicast (address))
659 vec_add1 (global_scope, ai);
660 else if (ip6_address_is_local_unicast (address))
661 vec_add1 (local_scope, ai);
663 vec_add1 (unknown_scope, ai);
665 ai = a->next_this_sw_interface;
668 if (vec_len (link_scope))
670 s = format (s, "%ULink-local address(es):\n", format_white_space, 2);
671 s = ip6_print_addrs (s, link_scope);
672 vec_free (link_scope);
675 if (vec_len (local_scope))
677 s = format (s, "%ULocal unicast address(es):\n", format_white_space, 2);
678 s = ip6_print_addrs (s, local_scope);
679 vec_free (local_scope);
682 if (vec_len (global_scope))
684 s = format (s, "%UGlobal unicast address(es):\n",
685 format_white_space, 2);
686 s = ip6_print_addrs (s, global_scope);
687 vec_free (global_scope);
690 if (vec_len (unknown_scope))
692 s = format (s, "%UOther-scope address(es):\n", format_white_space, 2);
693 s = ip6_print_addrs (s, unknown_scope);
694 vec_free (unknown_scope);
697 s = format (s, "%ULink-local address(es):\n", format_white_space, 2);
698 s = format (s, "%U%U\n",
699 format_white_space, 4, format_ip6_address, &il->il_ll_addr);
702 FOREACH_IP6_LINK_DELEGATE(ild, il,
704 s = format (s, "%U", il_delegate_vfts[ild->ild_type].ildv_format,
712 static clib_error_t *
713 ip6_link_show (vlib_main_t * vm,
714 unformat_input_t * input, vlib_cli_command_t * cmd)
716 const ip6_link_t *il;
720 vnm = vnet_get_main ();
723 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
725 il = ip6_link_get (sw_if_index);
729 vlib_cli_output (vm, "IP6 disabled");
733 vlib_cli_output (vm, "%U", format_ip6_link, il);
737 vec_foreach (il, ip6_links)
738 vlib_cli_output (vm, "%U", format_ip6_link, il);
745 * This command is used to display various IPv6 attributes on a given
749 * Example of how to display IPv6 settings:
750 * @cliexstart{show ip6 interface GigabitEthernet2/0/0}
751 * GigabitEthernet2/0/0 is admin up
752 * Link-local address(es):
754 * Joined group address(es):
759 * Advertised Prefixes:
760 * prefix fe80::fe:28ff:fe9c:75b3, length 64
762 * ICMP error messages are unlimited
763 * ICMP redirects are disabled
764 * ICMP unreachables are not sent
766 * ND advertised reachable time is 0
767 * ND advertised retransmit interval is 0 (msec)
768 * ND router advertisements are sent every 200 seconds (min interval is 150)
769 * ND router advertisements live for 600 seconds
770 * Hosts use stateless autoconfig for addresses
771 * ND router advertisements sent 19336
772 * ND router solicitations received 0
773 * ND router solicitations dropped 0
775 * Example of output if IPv6 is not enabled on the interface:
776 * @cliexstart{show ip6 interface GigabitEthernet2/0/0}
777 * show ip6 interface: IPv6 not enabled on interface
781 VLIB_CLI_COMMAND (ip6_link_show_command, static) =
783 .path = "show ip6 interface",
784 .function = ip6_link_show,
785 .short_help = "show ip6 interface <interface>",
789 static clib_error_t *
790 enable_ip6_interface_cmd (vlib_main_t * vm,
791 unformat_input_t * input, vlib_cli_command_t * cmd)
793 vnet_main_t *vnm = vnet_get_main ();
794 clib_error_t *error = NULL;
799 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
801 if (ip6_link_enable (sw_if_index, NULL))
802 error = clib_error_return (0, "Failed\n");
806 error = clib_error_return (0, "unknown interface\n'",
807 format_unformat_error, input);
814 * This command is used to enable IPv6 on a given interface.
817 * Example of how enable IPv6 on a given interface:
818 * @cliexcmd{enable ip6 interface GigabitEthernet2/0/0}
821 VLIB_CLI_COMMAND (enable_ip6_interface_command, static) =
823 .path = "enable ip6 interface",
824 .function = enable_ip6_interface_cmd,
825 .short_help = "enable ip6 interface <interface>",
829 static clib_error_t *
830 disable_ip6_interface_cmd (vlib_main_t * vm,
831 unformat_input_t * input, vlib_cli_command_t * cmd)
833 vnet_main_t *vnm = vnet_get_main ();
834 clib_error_t *error = NULL;
839 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
841 if (ip6_link_disable (sw_if_index))
842 error = clib_error_return (0, "Failed\n");
846 error = clib_error_return (0, "unknown interface\n'",
847 format_unformat_error, input);
854 * This command is used to disable IPv6 on a given interface.
857 * Example of how disable IPv6 on a given interface:
858 * @cliexcmd{disable ip6 interface GigabitEthernet2/0/0}
861 VLIB_CLI_COMMAND (disable_ip6_interface_command, static) =
863 .path = "disable ip6 interface",
864 .function = disable_ip6_interface_cmd,
865 .short_help = "disable ip6 interface <interface>",
870 * fd.io coding-style-patch-verification: ON
873 * eval: (c-set-style "gnu")