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,
208 eth->address.mac.bytes);
212 ip6_ll_prefix_t ilp = {
213 .ilp_addr = il->il_ll_addr,
214 .ilp_sw_if_index = sw_if_index,
217 ip6_ll_table_entry_update (&ilp, FIB_ROUTE_PATH_LOCAL);
220 /* essentially "enables" ipv6 on this interface */
221 ip6_mfib_interface_enable_disable (sw_if_index, 1);
222 ip6_sw_interface_enable_disable (sw_if_index, 1);
224 il->il_mcast_adj = adj_mcast_add_or_lock (FIB_PROTOCOL_IP6,
225 VNET_LINK_IP6, sw_if_index);
227 /* inform all register clients */
228 ip6_link_delegate_id_t id;
229 FOREACH_IP6_LINK_DELEGATE_ID (id)
231 if (NULL != il_delegate_vfts[id].ildv_enable)
232 il_delegate_vfts[id].ildv_enable (il->il_sw_if_index);
239 rv = VNET_API_ERROR_VALUE_EXIST;
249 ip6_link_delegate_flush (ip6_link_t * il)
251 ip6_link_delegate_t *ild;
254 FOREACH_IP6_LINK_DELEGATE (ild, il,
256 il_delegate_vfts[ild->ild_type].ildv_disable(ild->ild_index);
260 vec_free (il->il_delegates);
261 il->il_delegates = NULL;
265 ip6_link_last_lock_gone (ip6_link_t * il)
267 ip6_ll_prefix_t ilp = {
268 .ilp_addr = il->il_ll_addr,
269 .ilp_sw_if_index = il->il_sw_if_index,
272 IP6_LINK_INFO ("last-lock: %U",
273 format_vnet_sw_if_index_name,
274 vnet_get_main (), il->il_sw_if_index);
276 ip6_link_delegate_flush (il);
277 ip6_ll_table_entry_delete (&ilp);
279 ip6_mfib_interface_enable_disable (il->il_sw_if_index, 0);
280 ip6_sw_interface_enable_disable (il->il_sw_if_index, 0);
282 ip6_address_set_zero (&il->il_ll_addr);
283 adj_unlock (il->il_mcast_adj);
284 il->il_mcast_adj = ADJ_INDEX_INVALID;
288 ip6_link_unlock (ip6_link_t * il)
295 if (0 == il->il_locks)
296 ip6_link_last_lock_gone (il);
300 ip6_link_disable (u32 sw_if_index)
304 il = ip6_link_get (sw_if_index);
307 return (VNET_API_ERROR_IP6_NOT_ENABLED);
309 IP6_LINK_INFO ("disable: %U",
310 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index);
312 ip6_link_unlock (il);
317 const ip6_address_t *
318 ip6_get_link_local_address (u32 sw_if_index)
320 const ip6_link_t *il;
322 vec_validate (ip6_links, sw_if_index);
324 il = &ip6_links[sw_if_index];
326 return (&il->il_ll_addr);
330 ip6_link_get_mcast_adj (u32 sw_if_index)
332 const ip6_link_t *il;
334 il = &ip6_links[sw_if_index];
336 return (il->il_mcast_adj);
340 ip6_link_set_local_address (u32 sw_if_index, const ip6_address_t * address)
342 ip6_link_delegate_t *ild;
345 il = ip6_link_get (sw_if_index);
348 return ip6_link_enable (sw_if_index, address);
350 ip6_ll_prefix_t ilp = {
351 .ilp_addr = il->il_ll_addr,
352 .ilp_sw_if_index = sw_if_index,
355 IP6_LINK_INFO ("set-ll: %U -> %U",
356 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
357 format_ip6_address, address);
359 ip6_ll_table_entry_delete (&ilp);
360 ip6_address_copy (&il->il_ll_addr, address);
361 ip6_address_copy (&ilp.ilp_addr, address);
362 ip6_ll_table_entry_update (&ilp, FIB_ROUTE_PATH_LOCAL);
365 FOREACH_IP6_LINK_DELEGATE (ild, il,
367 if (NULL != il_delegate_vfts[ild->ild_type].ildv_ll_change)
368 il_delegate_vfts[ild->ild_type].ildv_ll_change(ild->ild_index,
376 ip6_link_delegate_id_t
377 ip6_link_delegate_register (const ip6_link_delegate_vft_t * vft)
379 ip6_link_delegate_id_t rc = il_delegate_id++;
381 ASSERT (vft->ildv_disable);
383 vec_validate (il_delegate_vfts, rc);
385 il_delegate_vfts[rc] = *vft;
391 ip6_link_delegate_get (u32 sw_if_index, ip6_link_delegate_id_t id)
395 il = ip6_link_get (sw_if_index);
398 return (INDEX_INVALID);
400 vec_validate_init_empty (il->il_delegates, id, ip6_link_delegate_uninit);
402 if (!ip6_link_delegate_is_init (&il->il_delegates[id]))
403 return (INDEX_INVALID);
405 return (il->il_delegates[id].ild_index);
409 ip6_link_delegate_update (u32 sw_if_index,
410 ip6_link_delegate_id_t id, index_t ii)
414 il = ip6_link_get (sw_if_index);
419 vec_validate_init_empty (il->il_delegates, id, ip6_link_delegate_uninit);
421 il->il_delegates[id].ild_sw_if_index = sw_if_index;
422 il->il_delegates[id].ild_type = id;
423 il->il_delegates[id].ild_index = ii;
429 ip6_link_delegate_remove (u32 sw_if_index,
430 ip6_link_delegate_id_t id, index_t ii)
434 il = ip6_link_get (sw_if_index);
438 if (vec_len (il->il_delegates) > id)
440 clib_memcpy (&il->il_delegates[id],
441 &ip6_link_delegate_uninit,
442 sizeof (il->il_delegates[0]));
448 ip6_link_add_del_address (ip6_main_t * im,
451 ip6_address_t * address,
453 u32 if_address_index, u32 is_delete)
455 const ip6_link_delegate_t *ild;
458 if (ip6_address_is_link_local_unicast (address))
459 // only interested in global addresses here
462 IP6_LINK_INFO ("addr-%s: %U -> %U",
463 (is_delete ? "del" : "add"),
464 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
465 format_ip6_address, address);
467 il = ip6_link_get (sw_if_index);
473 FOREACH_IP6_LINK_DELEGATE (ild, il,
477 if (NULL != il_delegate_vfts[ild->ild_type].ildv_addr_del)
478 il_delegate_vfts[ild->ild_type].ildv_addr_del(ild->ild_index,
479 address, address_length);
483 if (NULL != il_delegate_vfts[ild->ild_type].ildv_addr_add)
484 il_delegate_vfts[ild->ild_type].ildv_addr_add(ild->ild_index,
485 address, address_length);
491 static clib_error_t *
492 ip6_link_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
498 il = ip6_link_get (sw_if_index);
500 IP6_LINK_DBG ("link-del: %U",
501 format_vnet_sw_if_index_name, vnet_get_main (),
506 ip6_link_last_lock_gone (il);
512 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip6_link_interface_add_del);
514 static clib_error_t *
515 ip6_link_init (vlib_main_t * vm)
517 il_randomizer = clib_cpu_time_now ();
518 ip6_link_logger = vlib_log_register_class ("ip6", "link");
521 ip6_add_del_interface_address_callback_t cb = {
522 .function = ip6_link_add_del_address,
524 vec_add1 (ip6_main.add_del_interface_address_callbacks, cb);
529 VLIB_INIT_FUNCTION (ip6_link_init);
532 static clib_error_t *
533 test_ip6_link_command_fn (vlib_main_t * vm,
534 unformat_input_t * input, vlib_cli_command_t * cmd)
537 ip6_address_t _a, *a = &_a;
539 if (unformat (input, "%U", unformat_ethernet_address, mac))
541 ip6_link_local_address_from_mac (a, mac);
542 vlib_cli_output (vm, "Link local address: %U", format_ip6_address, a);
543 ip6_mac_address_from_link_local (mac, a);
544 vlib_cli_output (vm, "Original MAC address: %U",
545 format_ethernet_address, mac);
552 * This command converts the given MAC Address into an IPv6 link-local
556 * Example of how to create an IPv6 link-local address:
557 * @cliexstart{test ip6 link 16:d9:e0:91:79:86}
558 * Link local address: fe80::14d9:e0ff:fe91:7986
559 * Original MAC address: 16:d9:e0:91:79:86
563 VLIB_CLI_COMMAND (test_link_command, static) =
565 .path = "test ip6 link",
566 .function = test_ip6_link_command_fn,
567 .short_help = "test ip6 link <mac-address>",
572 ip6_print_addrs (u8 * s, u32 * addrs)
574 ip_lookup_main_t *lm = &ip6_main.lookup_main;
577 for (i = 0; i < vec_len (addrs); i++)
579 ip_interface_address_t *a =
580 pool_elt_at_index (lm->if_address_pool, addrs[i]);
581 ip6_address_t *address = ip_interface_address_get_address (lm, a);
583 s = format (s, "%U%U/%d\n",
584 format_white_space, 4,
585 format_ip6_address, address, a->address_length);
592 format_ip6_link (u8 * s, va_list * arg)
594 const ip6_link_t *il = va_arg (*arg, ip6_link_t *);
595 ip_lookup_main_t *lm = &ip6_main.lookup_main;
596 vnet_main_t *vnm = vnet_get_main ();
598 if (!ip6_link_is_enabled_i (il))
601 s = format (s, "%U is admin %s\n",
602 format_vnet_sw_interface_name, vnm,
603 vnet_get_sw_interface (vnm, il->il_sw_if_index),
604 (vnet_sw_interface_is_admin_up (vnm, il->il_sw_if_index) ?
608 u32 *link_scope = 0, *global_scope = 0;
609 u32 *local_scope = 0, *unknown_scope = 0;
610 ip_interface_address_t *a;
611 const ip6_link_delegate_t *ild;
613 vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index,
614 il->il_sw_if_index, ~0);
615 ai = lm->if_address_pool_index_by_sw_if_index[il->il_sw_if_index];
617 while (ai != (u32) ~ 0)
619 a = pool_elt_at_index (lm->if_address_pool, ai);
620 ip6_address_t *address = ip_interface_address_get_address (lm, a);
622 if (ip6_address_is_link_local_unicast (address))
623 vec_add1 (link_scope, ai);
624 else if (ip6_address_is_global_unicast (address))
625 vec_add1 (global_scope, ai);
626 else if (ip6_address_is_local_unicast (address))
627 vec_add1 (local_scope, ai);
629 vec_add1 (unknown_scope, ai);
631 ai = a->next_this_sw_interface;
634 if (vec_len (link_scope))
636 s = format (s, "%ULink-local address(es):\n", format_white_space, 2);
637 s = ip6_print_addrs (s, link_scope);
638 vec_free (link_scope);
641 if (vec_len (local_scope))
643 s = format (s, "%ULocal unicast address(es):\n", format_white_space, 2);
644 s = ip6_print_addrs (s, local_scope);
645 vec_free (local_scope);
648 if (vec_len (global_scope))
650 s = format (s, "%UGlobal unicast address(es):\n",
651 format_white_space, 2);
652 s = ip6_print_addrs (s, global_scope);
653 vec_free (global_scope);
656 if (vec_len (unknown_scope))
658 s = format (s, "%UOther-scope address(es):\n", format_white_space, 2);
659 s = ip6_print_addrs (s, unknown_scope);
660 vec_free (unknown_scope);
663 s = format (s, "%ULink-local address(es):\n", format_white_space, 2);
664 s = format (s, "%U%U\n",
665 format_white_space, 4, format_ip6_address, &il->il_ll_addr);
668 FOREACH_IP6_LINK_DELEGATE(ild, il,
670 s = format (s, "%U", il_delegate_vfts[ild->ild_type].ildv_format,
678 static clib_error_t *
679 ip6_link_show (vlib_main_t * vm,
680 unformat_input_t * input, vlib_cli_command_t * cmd)
682 const ip6_link_t *il;
686 vnm = vnet_get_main ();
689 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
691 il = ip6_link_get (sw_if_index);
695 vlib_cli_output (vm, "IP6 disabled");
699 vlib_cli_output (vm, "%U", format_ip6_link, il);
703 vec_foreach (il, ip6_links)
704 vlib_cli_output (vm, "%U", format_ip6_link, il);
711 * This command is used to display various IPv6 attributes on a given
715 * Example of how to display IPv6 settings:
716 * @cliexstart{show ip6 interface GigabitEthernet2/0/0}
717 * GigabitEthernet2/0/0 is admin up
718 * Link-local address(es):
720 * Joined group address(es):
725 * Advertised Prefixes:
726 * prefix fe80::fe:28ff:fe9c:75b3, length 64
728 * ICMP error messages are unlimited
729 * ICMP redirects are disabled
730 * ICMP unreachables are not sent
732 * ND advertised reachable time is 0
733 * ND advertised retransmit interval is 0 (msec)
734 * ND router advertisements are sent every 200 seconds (min interval is 150)
735 * ND router advertisements live for 600 seconds
736 * Hosts use stateless autoconfig for addresses
737 * ND router advertisements sent 19336
738 * ND router solicitations received 0
739 * ND router solicitations dropped 0
741 * Example of output if IPv6 is not enabled on the interface:
742 * @cliexstart{show ip6 interface GigabitEthernet2/0/0}
743 * show ip6 interface: IPv6 not enabled on interface
747 VLIB_CLI_COMMAND (ip6_link_show_command, static) =
749 .path = "show ip6 interface",
750 .function = ip6_link_show,
751 .short_help = "show ip6 interface <interface>",
755 static clib_error_t *
756 enable_ip6_interface_cmd (vlib_main_t * vm,
757 unformat_input_t * input, vlib_cli_command_t * cmd)
759 vnet_main_t *vnm = vnet_get_main ();
760 clib_error_t *error = NULL;
765 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
767 if (ip6_link_enable (sw_if_index, NULL))
768 error = clib_error_return (0, "Failed\n");
772 error = clib_error_return (0, "unknown interface\n'",
773 format_unformat_error, input);
780 * This command is used to enable IPv6 on a given interface.
783 * Example of how enable IPv6 on a given interface:
784 * @cliexcmd{enable ip6 interface GigabitEthernet2/0/0}
787 VLIB_CLI_COMMAND (enable_ip6_interface_command, static) =
789 .path = "enable ip6 interface",
790 .function = enable_ip6_interface_cmd,
791 .short_help = "enable ip6 interface <interface>",
795 static clib_error_t *
796 disable_ip6_interface_cmd (vlib_main_t * vm,
797 unformat_input_t * input, vlib_cli_command_t * cmd)
799 vnet_main_t *vnm = vnet_get_main ();
800 clib_error_t *error = NULL;
805 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
807 if (ip6_link_disable (sw_if_index))
808 error = clib_error_return (0, "Failed\n");
812 error = clib_error_return (0, "unknown interface\n'",
813 format_unformat_error, input);
820 * This command is used to disable IPv6 on a given interface.
823 * Example of how disable IPv6 on a given interface:
824 * @cliexcmd{disable ip6 interface GigabitEthernet2/0/0}
827 VLIB_CLI_COMMAND (disable_ip6_interface_command, static) =
829 .path = "disable ip6 interface",
830 .function = disable_ip6_interface_cmd,
831 .short_help = "disable ip6 interface <interface>",
836 * fd.io coding-style-patch-verification: ON
839 * eval: (c-set-style "gnu")