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;
245 FOREACH_IP6_LINK_DELEGATE (ild, il,
247 il_delegate_vfts[ild->ild_type].ildv_disable(ild->ild_index);
250 vec_free (il->il_delegates);
251 il->il_delegates = NULL;
255 ip6_link_last_lock_gone (ip6_link_t * il)
257 ip6_ll_prefix_t ilp = {
258 .ilp_addr = il->il_ll_addr,
259 .ilp_sw_if_index = il->il_sw_if_index,
262 IP6_LINK_INFO ("last-lock: %U",
263 format_vnet_sw_if_index_name,
264 vnet_get_main (), il->il_sw_if_index);
266 ip6_link_delegate_flush (il);
267 ip6_ll_table_entry_delete (&ilp);
269 ip6_mfib_interface_enable_disable (il->il_sw_if_index, 0);
270 ip6_sw_interface_enable_disable (il->il_sw_if_index, 0);
272 ip6_address_set_zero (&il->il_ll_addr);
273 adj_unlock (il->il_mcast_adj);
274 il->il_mcast_adj = ADJ_INDEX_INVALID;
278 ip6_link_unlock (ip6_link_t * il)
285 if (0 == il->il_locks)
286 ip6_link_last_lock_gone (il);
290 ip6_link_disable (u32 sw_if_index)
294 il = ip6_link_get (sw_if_index);
297 return (VNET_API_ERROR_IP6_NOT_ENABLED);
299 IP6_LINK_INFO ("disable: %U",
300 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index);
302 ip6_link_unlock (il);
307 const ip6_address_t *
308 ip6_get_link_local_address (u32 sw_if_index)
310 const ip6_link_t *il;
312 il = ip6_link_get (sw_if_index);
317 return (&il->il_ll_addr);
321 ip6_link_get_mcast_adj (u32 sw_if_index)
323 const ip6_link_t *il;
325 il = ip6_link_get (sw_if_index);
328 return (INDEX_INVALID);
330 return (il->il_mcast_adj);
334 ip6_link_set_local_address (u32 sw_if_index, const ip6_address_t * address)
336 ip6_link_delegate_t *ild;
339 il = ip6_link_get (sw_if_index);
342 return ip6_link_enable (sw_if_index, address);
344 ip6_ll_prefix_t ilp = {
345 .ilp_addr = il->il_ll_addr,
346 .ilp_sw_if_index = sw_if_index,
349 IP6_LINK_INFO ("set-ll: %U -> %U",
350 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
351 format_ip6_address, address);
353 ip6_ll_table_entry_delete (&ilp);
354 ip6_address_copy (&il->il_ll_addr, address);
355 ip6_address_copy (&ilp.ilp_addr, address);
356 ip6_ll_table_entry_update (&ilp, FIB_ROUTE_PATH_LOCAL);
358 FOREACH_IP6_LINK_DELEGATE (ild, il,
360 if (NULL != il_delegate_vfts[ild->ild_type].ildv_ll_change)
361 il_delegate_vfts[ild->ild_type].ildv_ll_change(ild->ild_index,
368 ip6_link_delegate_id_t
369 ip6_link_delegate_register (const ip6_link_delegate_vft_t * vft)
371 ip6_link_delegate_id_t rc = il_delegate_id++;
373 ASSERT (vft->ildv_disable);
375 vec_validate (il_delegate_vfts, rc);
377 il_delegate_vfts[rc] = *vft;
383 ip6_link_delegate_get (u32 sw_if_index, ip6_link_delegate_id_t id)
387 il = ip6_link_get (sw_if_index);
390 return (INDEX_INVALID);
392 vec_validate_init_empty (il->il_delegates, id, ip6_link_delegate_uninit);
394 if (!ip6_link_delegate_is_init (&il->il_delegates[id]))
395 return (INDEX_INVALID);
397 return (il->il_delegates[id].ild_index);
401 ip6_link_delegate_update (u32 sw_if_index,
402 ip6_link_delegate_id_t id, index_t ii)
406 il = ip6_link_get (sw_if_index);
411 vec_validate_init_empty (il->il_delegates, id, ip6_link_delegate_uninit);
413 il->il_delegates[id].ild_sw_if_index = sw_if_index;
414 il->il_delegates[id].ild_type = id;
415 il->il_delegates[id].ild_index = ii;
421 ip6_link_delegate_remove (u32 sw_if_index,
422 ip6_link_delegate_id_t id, index_t ii)
426 il = ip6_link_get (sw_if_index);
430 if (vec_len (il->il_delegates) > id)
432 clib_memcpy (&il->il_delegates[id],
433 &ip6_link_delegate_uninit,
434 sizeof (il->il_delegates[0]));
440 ip6_link_add_del_address (ip6_main_t * im,
443 ip6_address_t * address,
445 u32 if_address_index, u32 is_delete)
447 const ip6_link_delegate_t *ild;
450 if (ip6_address_is_link_local_unicast (address))
451 // only interested in global addresses here
454 IP6_LINK_INFO ("addr-%s: %U -> %U",
455 (is_delete ? "del" : "add"),
456 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
457 format_ip6_address, address);
459 il = ip6_link_get (sw_if_index);
464 FOREACH_IP6_LINK_DELEGATE (ild, il,
468 if (NULL != il_delegate_vfts[ild->ild_type].ildv_addr_del)
469 il_delegate_vfts[ild->ild_type].ildv_addr_del(ild->ild_index,
470 address, address_length);
474 if (NULL != il_delegate_vfts[ild->ild_type].ildv_addr_add)
475 il_delegate_vfts[ild->ild_type].ildv_addr_add(ild->ild_index,
476 address, address_length);
481 static clib_error_t *
482 ip6_link_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
488 il = ip6_link_get (sw_if_index);
490 IP6_LINK_DBG ("link-del: %U",
491 format_vnet_sw_if_index_name, vnet_get_main (),
496 ip6_link_last_lock_gone (il);
502 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip6_link_interface_add_del);
504 static clib_error_t *
505 ip6_link_init (vlib_main_t * vm)
507 il_randomizer = clib_cpu_time_now ();
508 ip6_link_logger = vlib_log_register_class ("ip6", "link");
511 ip6_add_del_interface_address_callback_t cb = {
512 .function = ip6_link_add_del_address,
514 vec_add1 (ip6_main.add_del_interface_address_callbacks, cb);
519 VLIB_INIT_FUNCTION (ip6_link_init);
522 static clib_error_t *
523 test_ip6_link_command_fn (vlib_main_t * vm,
524 unformat_input_t * input, vlib_cli_command_t * cmd)
527 ip6_address_t _a, *a = &_a;
529 if (unformat (input, "%U", unformat_ethernet_address, mac))
531 ip6_link_local_address_from_mac (a, mac);
532 vlib_cli_output (vm, "Link local address: %U", format_ip6_address, a);
533 ip6_mac_address_from_link_local (mac, a);
534 vlib_cli_output (vm, "Original MAC address: %U",
535 format_ethernet_address, mac);
542 * This command converts the given MAC Address into an IPv6 link-local
546 * Example of how to create an IPv6 link-local address:
547 * @cliexstart{test ip6 link 16:d9:e0:91:79:86}
548 * Link local address: fe80::14d9:e0ff:fe91:7986
549 * Original MAC address: 16:d9:e0:91:79:86
552 VLIB_CLI_COMMAND (test_link_command, static) =
554 .path = "test ip6 link",
555 .function = test_ip6_link_command_fn,
556 .short_help = "test ip6 link <mac-address>",
560 ip6_print_addrs (u8 * s, u32 * addrs)
562 ip_lookup_main_t *lm = &ip6_main.lookup_main;
565 for (i = 0; i < vec_len (addrs); i++)
567 ip_interface_address_t *a =
568 pool_elt_at_index (lm->if_address_pool, addrs[i]);
569 ip6_address_t *address = ip_interface_address_get_address (lm, a);
571 s = format (s, "%U%U/%d\n",
572 format_white_space, 4,
573 format_ip6_address, address, a->address_length);
580 format_ip6_link (u8 * s, va_list * arg)
582 const ip6_link_t *il = va_arg (*arg, ip6_link_t *);
583 ip_lookup_main_t *lm = &ip6_main.lookup_main;
584 vnet_main_t *vnm = vnet_get_main ();
586 if (!ip6_link_is_enabled_i (il))
590 s, "%U is admin %s\n", format_vnet_sw_if_index_name, vnm,
592 (vnet_sw_interface_is_admin_up (vnm, il->il_sw_if_index) ? "up" : "down"));
595 u32 *link_scope = 0, *global_scope = 0;
596 u32 *local_scope = 0, *unknown_scope = 0;
597 ip_interface_address_t *a;
598 const ip6_link_delegate_t *ild;
600 vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index,
601 il->il_sw_if_index, ~0);
602 ai = lm->if_address_pool_index_by_sw_if_index[il->il_sw_if_index];
604 while (ai != (u32) ~ 0)
606 a = pool_elt_at_index (lm->if_address_pool, ai);
607 ip6_address_t *address = ip_interface_address_get_address (lm, a);
609 if (ip6_address_is_link_local_unicast (address))
610 vec_add1 (link_scope, ai);
611 else if (ip6_address_is_global_unicast (address))
612 vec_add1 (global_scope, ai);
613 else if (ip6_address_is_local_unicast (address))
614 vec_add1 (local_scope, ai);
616 vec_add1 (unknown_scope, ai);
618 ai = a->next_this_sw_interface;
621 if (vec_len (link_scope))
623 s = format (s, "%ULink-local address(es):\n", format_white_space, 2);
624 s = ip6_print_addrs (s, link_scope);
625 vec_free (link_scope);
628 if (vec_len (local_scope))
630 s = format (s, "%ULocal unicast address(es):\n", format_white_space, 2);
631 s = ip6_print_addrs (s, local_scope);
632 vec_free (local_scope);
635 if (vec_len (global_scope))
637 s = format (s, "%UGlobal unicast address(es):\n",
638 format_white_space, 2);
639 s = ip6_print_addrs (s, global_scope);
640 vec_free (global_scope);
643 if (vec_len (unknown_scope))
645 s = format (s, "%UOther-scope address(es):\n", format_white_space, 2);
646 s = ip6_print_addrs (s, unknown_scope);
647 vec_free (unknown_scope);
650 s = format (s, "%ULink-local address(es):\n", format_white_space, 2);
651 s = format (s, "%U%U\n",
652 format_white_space, 4, format_ip6_address, &il->il_ll_addr);
654 FOREACH_IP6_LINK_DELEGATE(ild, il,
656 s = format (s, "%U", il_delegate_vfts[ild->ild_type].ildv_format,
663 static clib_error_t *
664 ip6_link_show (vlib_main_t * vm,
665 unformat_input_t * input, vlib_cli_command_t * cmd)
667 const ip6_link_t *il;
671 vnm = vnet_get_main ();
674 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
676 il = ip6_link_get (sw_if_index);
680 vlib_cli_output (vm, "IP6 disabled");
684 vlib_cli_output (vm, "%U", format_ip6_link, il);
688 vec_foreach (il, ip6_links)
689 vlib_cli_output (vm, "%U", format_ip6_link, il);
696 * This command is used to display various IPv6 attributes on a given
700 * Example of how to display IPv6 settings:
701 * @cliexstart{show ip6 interface GigabitEthernet2/0/0}
702 * GigabitEthernet2/0/0 is admin up
703 * Link-local address(es):
705 * Joined group address(es):
710 * Advertised Prefixes:
711 * prefix fe80::fe:28ff:fe9c:75b3, length 64
713 * ICMP error messages are unlimited
714 * ICMP redirects are disabled
715 * ICMP unreachables are not sent
717 * ND advertised reachable time is 0
718 * ND advertised retransmit interval is 0 (msec)
719 * ND router advertisements are sent every 200 seconds (min interval is 150)
720 * ND router advertisements live for 600 seconds
721 * Hosts use stateless autoconfig for addresses
722 * ND router advertisements sent 19336
723 * ND router solicitations received 0
724 * ND router solicitations dropped 0
726 * Example of output if IPv6 is not enabled on the interface:
727 * @cliexstart{show ip6 interface GigabitEthernet2/0/0}
728 * show ip6 interface: IPv6 not enabled on interface
731 VLIB_CLI_COMMAND (ip6_link_show_command, static) =
733 .path = "show ip6 interface",
734 .function = ip6_link_show,
735 .short_help = "show ip6 interface <interface>",
738 static clib_error_t *
739 enable_ip6_interface_cmd (vlib_main_t * vm,
740 unformat_input_t * input, vlib_cli_command_t * cmd)
742 vnet_main_t *vnm = vnet_get_main ();
743 clib_error_t *error = NULL;
748 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
750 if (ip6_link_enable (sw_if_index, NULL))
751 error = clib_error_return (0, "Failed\n");
755 error = clib_error_return (0, "unknown interface\n'",
756 format_unformat_error, input);
763 * This command is used to enable IPv6 on a given interface.
766 * Example of how enable IPv6 on a given interface:
767 * @cliexcmd{enable ip6 interface GigabitEthernet2/0/0}
769 VLIB_CLI_COMMAND (enable_ip6_interface_command, static) =
771 .path = "enable ip6 interface",
772 .function = enable_ip6_interface_cmd,
773 .short_help = "enable ip6 interface <interface>",
776 static clib_error_t *
777 disable_ip6_interface_cmd (vlib_main_t * vm,
778 unformat_input_t * input, vlib_cli_command_t * cmd)
780 vnet_main_t *vnm = vnet_get_main ();
781 clib_error_t *error = NULL;
786 if (unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
788 if (ip6_link_disable (sw_if_index))
789 error = clib_error_return (0, "Failed\n");
793 error = clib_error_return (0, "unknown interface\n'",
794 format_unformat_error, input);
801 * This command is used to disable IPv6 on a given interface.
804 * Example of how disable IPv6 on a given interface:
805 * @cliexcmd{disable ip6 interface GigabitEthernet2/0/0}
807 VLIB_CLI_COMMAND (disable_ip6_interface_command, static) =
809 .path = "disable ip6 interface",
810 .function = disable_ip6_interface_cmd,
811 .short_help = "disable ip6 interface <interface>",
815 * fd.io coding-style-patch-verification: ON
818 * eval: (c-set-style "gnu")