2 * vrrp.c - vrrp plugin action functions
4 * Copyright 2019-2020 Rubicon Communications, LLC (Netgate)
6 * SPDX-License-Identifier: Apache-2.0
10 #include <vnet/vnet.h>
11 #include <vnet/plugin/plugin.h>
12 #include <vnet/mfib/mfib_entry.h>
13 #include <vnet/mfib/mfib_table.h>
14 #include <vnet/adj/adj.h>
15 #include <vnet/adj/adj_mcast.h>
16 #include <vnet/fib/fib_table.h>
17 #include <vnet/ip/igmp_packet.h>
18 #include <vnet/ip/ip6_link.h>
20 #include <vrrp/vrrp.h>
21 #include <vrrp/vrrp_packet.h>
23 #include <vpp/app/version.h>
25 vrrp_main_t vrrp_main;
27 static const mac_address_t ipv4_vmac = {
28 .bytes = {0x00, 0x00, 0x5e, 0x00, 0x01, 0x00}
31 static const mac_address_t ipv6_vmac = {
32 .bytes = {0x00, 0x00, 0x5e, 0x00, 0x02, 0x00}
39 } vrrp_hwif_vr_count_t;
44 VRRP_IF_UPDATE_HW_LINK,
45 VRRP_IF_UPDATE_SW_ADMIN,
46 } vrrp_intf_update_type_t;
50 vrrp_intf_update_type_t type;
56 static int vrrp_intf_is_up (u32 sw_if_index, u8 is_ipv6,
57 vrrp_intf_update_t * pending);
60 vrrp_hwif_master_count_walk (vnet_main_t * vnm, u32 sw_if_index, void *arg)
62 vrrp_hwif_vr_count_t *vr_count = arg;
65 vr = vrrp_vr_lookup (sw_if_index, vr_count->key.vr_id,
66 vr_count->key.is_ipv6);
68 if (vr && (vr->runtime.state == VRRP_VR_STATE_MASTER))
75 * Get a count of VRs in master state on a given hardware interface with
76 * the provided VR ID and AF.
79 vrrp_vr_hwif_master_vrs_by_vrid (u32 hw_if_index, u8 vr_id, u8 is_ipv6)
81 vnet_main_t *vnm = vnet_get_main ();
82 vrrp_hwif_vr_count_t vr_count;
84 clib_memset (&vr_count, 0, sizeof (vr_count));
86 vr_count.key.vr_id = vr_id;
87 vr_count.key.is_ipv6 = is_ipv6;
89 vnet_hw_interface_walk_sw (vnm, hw_if_index,
90 vrrp_hwif_master_count_walk, &vr_count);
92 return vr_count.count;
96 * Add or delete the VR virtual MAC address on the hardware interface
97 * when a VR enters or leaves the master state.
99 * Multiple subinterfaces may host the same VR ID. We should only add or
100 * delete the virtual MAC if this is the first VR being enabled on the
101 * hardware interface or the last one being disabled, respectively.
104 vrrp_vr_transition_vmac (vrrp_vr_t * vr, vrrp_vr_state_t new_state)
106 vnet_main_t *vnm = vnet_get_main ();
107 clib_error_t *error = 0;
108 vnet_hw_interface_t *hw;
109 u8 enable = (new_state == VRRP_VR_STATE_MASTER);
112 hw = vnet_get_sup_hw_interface (vnm, vr->config.sw_if_index);
114 vrrp_vr_hwif_master_vrs_by_vrid (hw->hw_if_index, vr->config.vr_id,
115 vrrp_vr_is_ipv6 (vr));
117 /* enable only if current master vrs is 0, disable only if 0 or 1 */
118 if ((enable && !n_master_vrs) || (!enable && (n_master_vrs < 2)))
120 clib_warning ("%s virtual MAC address %U on hardware interface %u",
121 (enable) ? "Adding" : "Deleting",
122 format_ethernet_address, vr->runtime.mac.bytes,
125 error = vnet_hw_interface_add_del_mac_address
126 (vnm, hw->hw_if_index, vr->runtime.mac.bytes, enable);
130 clib_error_report (error);
134 * Manage VR interface data on transition to/from master:
135 * - enable or disable ARP/ND input feature if appropriate
136 * - update count of VRs in master state
139 vrrp_vr_transition_intf (vrrp_vr_t * vr, vrrp_vr_state_t new_state)
142 const char *arc_name = 0, *node_name = 0;
143 const char *mc_arc_name = 0, *mc_node_name = 0;
144 u8 is_ipv6 = vrrp_vr_is_ipv6 (vr);
146 int n_master_accept = 0;
151 arc_name = "ip6-local";
152 node_name = "vrrp6-nd-input";
153 mc_arc_name = "ip6-multicast";
154 mc_node_name = "vrrp6-accept-owner-input";
159 node_name = "vrrp4-arp-input";
160 mc_arc_name = "ip4-multicast";
161 mc_node_name = "vrrp4-accept-owner-input";
164 intf = vrrp_intf_get (vr->config.sw_if_index);
166 /* Check other VRs on this intf to see if features need to be toggled */
167 vec_foreach (vr_index, intf->vr_indices[is_ipv6])
169 vrrp_vr_t *intf_vr = vrrp_vr_lookup_index (*vr_index);
174 if (intf_vr->runtime.state == VRRP_VR_STATE_INIT)
179 if ((intf_vr->runtime.state == VRRP_VR_STATE_MASTER) &&
180 vrrp_vr_accept_mode_enabled (intf_vr))
184 /* If entering/leaving init state, start/stop ARP or ND feature if no other
185 * VRs are active on the interface.
187 if (((vr->runtime.state == VRRP_VR_STATE_INIT) ||
188 (new_state == VRRP_VR_STATE_INIT)) && (n_started == 0))
189 vnet_feature_enable_disable (arc_name, node_name,
190 vr->config.sw_if_index,
191 (new_state != VRRP_VR_STATE_INIT), NULL, 0);
193 /* Special housekeeping when entering/leaving master mode */
194 if ((vr->runtime.state == VRRP_VR_STATE_MASTER) ||
195 (new_state == VRRP_VR_STATE_MASTER))
197 /* Maintain count of master state VRs on interface */
198 if (new_state == VRRP_VR_STATE_MASTER)
199 intf->n_master_vrs[is_ipv6]++;
200 else if (intf->n_master_vrs[is_ipv6] > 0)
201 intf->n_master_vrs[is_ipv6]--;
203 /* If accept mode is enabled and no other master on intf has accept
204 * mode enabled, enable/disable feature node to avoid spurious drops by
207 if (vrrp_vr_accept_mode_enabled (vr) && !n_master_accept)
208 vnet_feature_enable_disable (mc_arc_name, mc_node_name,
209 vr->config.sw_if_index,
210 (new_state == VRRP_VR_STATE_MASTER),
215 /* If accept mode enabled, add/remove VR addresses from interface */
217 vrrp_vr_transition_addrs (vrrp_vr_t * vr, vrrp_vr_state_t new_state)
219 vlib_main_t *vm = vlib_get_main ();
221 ip46_address_t *vr_addr;
223 if (!vrrp_vr_accept_mode_enabled (vr))
226 /* owner always has VR addresses configured, should never remove them */
227 if (vrrp_vr_is_owner (vr))
230 if (vrrp_vr_is_unicast (vr))
233 /* only need to do something if entering or leaving master state */
234 if ((vr->runtime.state != VRRP_VR_STATE_MASTER) &&
235 (new_state != VRRP_VR_STATE_MASTER))
238 is_del = (new_state != VRRP_VR_STATE_MASTER);
240 clib_warning ("%s VR addresses on sw_if_index %u",
241 (is_del) ? "Deleting" : "Adding", vr->config.sw_if_index);
243 vec_foreach (vr_addr, vr->config.vr_addrs)
245 ip_interface_address_t *ia = NULL;
247 /* We need to know the address length to use, find it from another
248 * address on the interface. Or use a default (/24, /64).
250 if (!vrrp_vr_is_ipv6 (vr))
252 ip4_main_t *im = &ip4_main;
253 ip4_address_t *intf4;
256 ip4_interface_address_matching_destination
257 (im, &vr_addr->ip4, vr->config.sw_if_index, &ia);
259 ip4_add_del_interface_address (vm, vr->config.sw_if_index,
261 (intf4 ? ia->address_length : 24),
266 ip6_main_t *im = &ip6_main;
267 ip6_address_t *intf6;
270 ip6_interface_address_matching_destination
271 (im, &vr_addr->ip6, vr->config.sw_if_index, &ia);
273 ip6_add_del_interface_address (vm, vr->config.sw_if_index,
275 (intf6 ? ia->address_length : 64),
282 vrrp_vr_transition (vrrp_vr_t * vr, vrrp_vr_state_t new_state, void *data)
285 clib_warning ("VR %U transitioning to %U", format_vrrp_vr_key, vr,
286 format_vrrp_vr_state, new_state);
288 /* Don't do anything if transitioning to the state VR is already in.
289 * This should never happen, just covering our bases.
291 if (new_state == vr->runtime.state)
294 if (new_state == VRRP_VR_STATE_MASTER)
296 /* RFC 5798 sec 6.4.1 (105) - startup event for VR with priority 255
297 * sec 6.4.2 (365) - master down timer fires on backup VR
300 vrrp_vr_multicast_group_join (vr);
301 vrrp_adv_send (vr, 0);
302 vrrp_garp_or_na_send (vr);
304 vrrp_vr_timer_set (vr, VRRP_VR_TIMER_ADV);
306 else if (new_state == VRRP_VR_STATE_BACKUP)
308 /* RFC 5798 sec 6.4.1 (150) - startup event for VR with priority < 255
309 * sec 6.4.3 (735) - master preempted by higher priority VR
312 vrrp_vr_multicast_group_join (vr);
314 if (vr->runtime.state == VRRP_VR_STATE_MASTER)
316 vrrp_header_t *pkt = data;
317 vr->runtime.master_adv_int = vrrp_adv_int_from_packet (pkt);
320 else /* INIT, INTF_DOWN */
321 vr->runtime.master_adv_int = vr->config.adv_interval;
323 vrrp_vr_skew_compute (vr);
324 vrrp_vr_master_down_compute (vr);
325 vrrp_vr_timer_set (vr, VRRP_VR_TIMER_MASTER_DOWN);
328 else if (new_state == VRRP_VR_STATE_INIT)
330 /* RFC 5798 sec 6.4.2 (345) - shutdown event for backup VR
331 * sec 6.4.3 (655) - shutdown event for master VR
334 vrrp_vr_timer_cancel (vr);
335 if (vr->runtime.state == VRRP_VR_STATE_MASTER)
336 vrrp_adv_send (vr, 1);
338 else if (new_state == VRRP_VR_STATE_INTF_DOWN)
339 /* State is not specified by RFC. This is to avoid attempting to
340 * send packets on an interface that's down and to avoid having a
341 * VR believe it is already the master when an interface is brought up
343 vrrp_vr_timer_cancel (vr);
345 /* add/delete virtual IP addrs if accept_mode is true */
346 vrrp_vr_transition_addrs (vr, new_state);
348 /* enable/disable input features if necessary */
349 vrrp_vr_transition_intf (vr, new_state);
351 /* add/delete virtual MAC address on NIC if necessary */
352 vrrp_vr_transition_vmac (vr, new_state);
354 vr->runtime.state = new_state;
357 #define VRRP4_MCAST_ADDR_AS_U8 { 224, 0, 0, 18 }
358 #define VRRP6_MCAST_ADDR_AS_U8 \
359 { 0xff, 0x2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x12 }
361 static const mfib_prefix_t all_vrrp4_routers = {
362 .fp_proto = FIB_PROTOCOL_IP4,
366 .as_u8 = VRRP4_MCAST_ADDR_AS_U8,
371 static const mfib_prefix_t all_vrrp6_routers = {
372 .fp_proto = FIB_PROTOCOL_IP6,
376 .as_u8 = VRRP6_MCAST_ADDR_AS_U8,
382 vrrp_intf_enable_disable_mcast (u8 enable, u32 sw_if_index, u8 is_ipv6)
384 vrrp_main_t *vrm = &vrrp_main;
389 const mfib_prefix_t *vrrp_prefix;
390 fib_protocol_t proto;
391 vnet_link_t link_type;
392 fib_route_path_t for_us = {
393 .frp_sw_if_index = 0xffffffff,
395 .frp_flags = FIB_ROUTE_PATH_LOCAL,
396 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
398 fib_route_path_t via_itf = {
399 .frp_sw_if_index = sw_if_index,
401 .frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT,
404 intf = vrrp_intf_get (sw_if_index);
408 proto = FIB_PROTOCOL_IP6;
409 link_type = VNET_LINK_IP6;
410 vrrp_prefix = &all_vrrp6_routers;
414 proto = FIB_PROTOCOL_IP4;
415 link_type = VNET_LINK_IP4;
416 vrrp_prefix = &all_vrrp4_routers;
419 for_us.frp_proto = fib_proto_to_dpo (proto);
420 via_itf.frp_proto = fib_proto_to_dpo (proto);
421 fib_index = mfib_table_get_index_for_sw_if_index (proto, sw_if_index);
424 pool_foreach (vr, vrm->vrs,
426 if (vrrp_vr_is_ipv6 (vr) == is_ipv6)
433 /* If this is the first VR configured, add the local mcast routes */
435 mfib_table_entry_path_update (fib_index, vrrp_prefix, MFIB_SOURCE_API,
438 mfib_table_entry_path_update (fib_index, vrrp_prefix, MFIB_SOURCE_API,
440 intf->mcast_adj_index[! !is_ipv6] =
441 adj_mcast_add_or_lock (proto, link_type, sw_if_index);
445 /* Remove mcast local routes if this is the last VR being deleted */
447 mfib_table_entry_path_remove (fib_index, vrrp_prefix, MFIB_SOURCE_API,
450 mfib_table_entry_path_remove (fib_index, vrrp_prefix, MFIB_SOURCE_API,
458 vrrp_intf_vr_add_del (u8 is_add, u32 sw_if_index, u32 vr_index, u8 is_ipv6)
460 vrrp_intf_t *vr_intf;
462 vr_intf = vrrp_intf_get (sw_if_index);
468 if (!vec_len (vr_intf->vr_indices[is_ipv6]))
469 vrrp_intf_enable_disable_mcast (1, sw_if_index, is_ipv6);
471 vec_add1 (vr_intf->vr_indices[is_ipv6], vr_index);
476 vec_search (vr_intf->vr_indices[is_ipv6], vr_index);
478 if (per_intf_index != ~0)
479 vec_del1 (vr_intf->vr_indices[is_ipv6], per_intf_index);
481 /* no more VRs on this interface, disable multicast */
482 if (!vec_len (vr_intf->vr_indices[is_ipv6]))
483 vrrp_intf_enable_disable_mcast (0, sw_if_index, is_ipv6);
489 /* RFC 5798 section 8.3.2 says to take care not to configure more than
490 * one VRRP router as the "IPvX address owner" of a VRID. Make sure that
491 * all of the addresses configured for this VR are configured on the
495 vrrp_vr_valid_addrs_owner (vrrp_vr_config_t * vr_conf)
497 ip46_address_t *addr;
498 u8 is_ipv6 = (vr_conf->flags & VRRP_VR_IPV6) != 0;
500 vec_foreach (addr, vr_conf->vr_addrs)
502 if (!ip_interface_has_address (vr_conf->sw_if_index, addr, !is_ipv6))
503 return VNET_API_ERROR_ADDRESS_NOT_FOUND_FOR_INTERFACE;
510 vrrp_vr_valid_addrs_unused (vrrp_vr_config_t * vr_conf)
512 ip46_address_t *vr_addr;
513 u8 is_ipv6 = (vr_conf->flags & VRRP_VR_IPV6) != 0;
515 vec_foreach (vr_addr, vr_conf->vr_addrs)
520 addr = (is_ipv6) ? (void *) &vr_addr->ip6 : (void *) &vr_addr->ip4;
521 vr_index = vrrp_vr_lookup_address (vr_conf->sw_if_index, is_ipv6, addr);
523 return VNET_API_ERROR_ADDRESS_IN_USE;
530 vrrp_vr_valid_addrs (vrrp_vr_config_t * vr_conf)
534 /* If the VR owns the addresses, make sure they are configured */
535 if (vr_conf->priority == 255 &&
536 (ret = vrrp_vr_valid_addrs_owner (vr_conf)) < 0)
539 /* make sure no other VR has already configured any of the VR addresses */
540 ret = vrrp_vr_valid_addrs_unused (vr_conf);
546 vrrp_vr_addr_add_del (vrrp_vr_t * vr, u8 is_add, ip46_address_t * vr_addr)
548 vrrp_main_t *vmp = &vrrp_main;
550 vrrp4_arp_key_t key4;
552 ip46_address_t *addr;
555 return VNET_API_ERROR_INVALID_ARGUMENT;
557 vr_index = vr - vmp->vrs;
559 if (vrrp_vr_is_ipv6 (vr))
561 key6.sw_if_index = vr->config.sw_if_index;
562 key6.addr = vr_addr->ip6;
565 hash_set_mem_alloc (&vmp->vrrp6_nd_lookup, &key6, vr_index);
566 vec_add1 (vr->config.vr_addrs, vr_addr[0]);
570 hash_unset_mem_free (&vmp->vrrp6_nd_lookup, &key6);
571 vec_foreach (addr, vr->config.vr_addrs)
573 if (!ip46_address_cmp (addr, vr_addr))
575 vec_del1 (vr->config.vr_addrs, vr->config.vr_addrs - addr);
583 key4.sw_if_index = vr->config.sw_if_index;
584 key4.addr = vr_addr->ip4;
587 hash_set (vmp->vrrp4_arp_lookup, key4.as_u64, vr_index);
588 vec_add1 (vr->config.vr_addrs, vr_addr[0]);
592 hash_unset (vmp->vrrp4_arp_lookup, key4.as_u64);
593 vec_foreach (addr, vr->config.vr_addrs)
595 if (!ip46_address_cmp (addr, vr_addr))
597 vec_del1 (vr->config.vr_addrs, vr->config.vr_addrs - addr);
608 vrrp_vr_addrs_add_del (vrrp_vr_t * vr, u8 is_add, ip46_address_t * vr_addrs)
610 ip46_address_t *vr_addr;
612 vec_foreach (vr_addr, vr_addrs)
614 vrrp_vr_addr_add_del (vr, is_add, vr_addr);
618 /* Action function shared between message handler and debug CLI */
620 vrrp_vr_add_del (u8 is_add, vrrp_vr_config_t * vr_conf)
622 vrrp_main_t *vrm = &vrrp_main;
623 vnet_main_t *vnm = vnet_get_main ();
630 if (vr_conf->sw_if_index == ~0 ||
631 !vnet_sw_interface_is_valid (vnm, vr_conf->sw_if_index))
632 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
634 clib_memset (&key, 0, sizeof (key));
636 key.sw_if_index = vr_conf->sw_if_index;
637 key.vr_id = vr_conf->vr_id;
638 key.is_ipv6 = ((vr_conf->flags & VRRP_VR_IPV6) != 0);
640 p = mhash_get (&vrm->vr_index_by_key, &key);
644 /* does a VR matching this key already exist ? */
647 clib_warning ("VR %u for IPv%d already exists on sw_if_index %u",
648 key.vr_id, (key.is_ipv6) ? 6 : 4, key.sw_if_index);
649 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
652 /* were IPvX addresses included ? */
653 if (!vec_len (vr_conf->vr_addrs))
655 clib_warning ("Conf of VR %u for IPv%d on sw_if_index %u "
656 " does not contain IP addresses",
657 key.vr_id, (key.is_ipv6) ? 6 : 4, key.sw_if_index);
658 return VNET_API_ERROR_INVALID_SRC_ADDRESS;
661 /* Make sure the addresses are ok to use */
662 if ((ret = vrrp_vr_valid_addrs (vr_conf)) < 0)
665 pool_get_zero (vrm->vrs, vr);
666 vr_index = vr - vrm->vrs;
668 clib_memcpy (&vr->config, vr_conf, sizeof (vrrp_vr_config_t));
670 vr->config.vr_addrs = 0; /* allocate our own memory */
671 vrrp_vr_addrs_add_del (vr, is_add, vr_conf->vr_addrs);
673 vr->runtime.state = VRRP_VR_STATE_INIT;
674 vr->runtime.timer_index = ~0;
676 /* set virtual MAC based on IP version and VR ID */
677 vr->runtime.mac = (key.is_ipv6) ? ipv6_vmac : ipv4_vmac;
678 vr->runtime.mac.bytes[5] = vr_conf->vr_id;
680 mhash_set (&vrm->vr_index_by_key, &key, vr_index, 0);
686 clib_warning ("No VR %u for IPv%d exists on sw_if_index %u",
687 key.vr_id, (key.is_ipv6) ? 6 : 4, key.sw_if_index);
688 return VNET_API_ERROR_NO_SUCH_ENTRY;
692 vr = pool_elt_at_index (vrm->vrs, vr_index);
694 vrrp_vr_tracking_ifs_add_del (vr, vr->tracking.interfaces, is_add);
695 vrrp_vr_addrs_add_del (vr, is_add, vr->config.vr_addrs);
696 mhash_unset (&vrm->vr_index_by_key, &key, 0);
697 vec_free (vr->config.vr_addrs);
698 vec_free (vr->tracking.interfaces);
699 pool_put (vrm->vrs, vr);
702 vrrp_intf_vr_add_del (is_add, vr_conf->sw_if_index, vr_index, key.is_ipv6);
708 vrrp_vr_start_stop (u8 is_start, vrrp_vr_key_t * vr_key)
710 vrrp_main_t *vmp = &vrrp_main;
714 p = mhash_get (&vmp->vr_index_by_key, vr_key);
716 return VNET_API_ERROR_NO_SUCH_ENTRY;
718 vr = pool_elt_at_index (vmp->vrs, p[0]);
720 /* return success if already in the desired state */
721 switch (vr->runtime.state)
723 case VRRP_VR_STATE_INIT:
726 clib_warning ("Attempting to stop already stopped VR (%U)",
727 format_vrrp_vr_key, vr);
734 clib_warning ("Attempting to start already started VR (%U)",
735 format_vrrp_vr_key, vr);
743 if (vrrp_vr_is_unicast (vr) && vec_len (vr->config.peer_addrs) == 0)
745 clib_warning ("Cannot start unicast VR without peers");
746 return VNET_API_ERROR_INIT_FAILED;
749 vmp->n_vrs_started++;
751 if (!vrrp_intf_is_up (vr->config.sw_if_index, vrrp_vr_is_ipv6 (vr),
754 clib_warning ("VRRP VR started on down interface (%U)",
755 format_vrrp_vr_key, vr);
756 vrrp_vr_transition (vr, VRRP_VR_STATE_INTF_DOWN, NULL);
758 else if (vrrp_vr_is_owner (vr))
759 vrrp_vr_transition (vr, VRRP_VR_STATE_MASTER, NULL);
761 vrrp_vr_transition (vr, VRRP_VR_STATE_BACKUP, NULL);
765 vmp->n_vrs_started--;
767 vrrp_vr_transition (vr, VRRP_VR_STATE_INIT, NULL);
770 clib_warning ("%d VRs configured, %d VRs running",
771 pool_elts (vmp->vrs), vmp->n_vrs_started);
777 vrrp_vr_set_peers_validate (vrrp_vr_t * vr, ip46_address_t * peers)
779 if (!vrrp_vr_is_unicast (vr))
781 clib_warning ("Peers can only be set on a unicast VR");
782 return VNET_API_ERROR_INVALID_ARGUMENT;
785 if (vr->runtime.state != VRRP_VR_STATE_INIT)
787 clib_warning ("Cannot set peers on a running VR");
788 return VNET_API_ERROR_RSRC_IN_USE;
791 if (vec_len (peers) == 0)
793 clib_warning ("No peer addresses provided");
794 return VNET_API_ERROR_INVALID_DST_ADDRESS;
801 vrrp_vr_set_peers (vrrp_vr_key_t * vr_key, ip46_address_t * peers)
803 vrrp_main_t *vmp = &vrrp_main;
808 p = mhash_get (&vmp->vr_index_by_key, vr_key);
810 return VNET_API_ERROR_NO_SUCH_ENTRY;
812 vr = pool_elt_at_index (vmp->vrs, p[0]);
814 ret = vrrp_vr_set_peers_validate (vr, peers);
818 if (vr->config.peer_addrs)
819 vec_free (vr->config.peer_addrs);
821 vr->config.peer_addrs = vec_dup (peers);
826 /* Manage reference on the interface to the VRs which track that interface */
828 vrrp_intf_tracking_vr_add_del (u32 sw_if_index, vrrp_vr_t * vr, u8 is_add)
832 u8 is_ipv6 = vrrp_vr_is_ipv6 (vr);
835 intf = vrrp_intf_get (sw_if_index);
836 vr_index = vrrp_vr_index (vr);
838 /* Try to find the VR index in the list of tracking VRs */
839 vec_foreach_index (i, intf->tracking_vrs[is_ipv6])
841 if (vec_elt (intf->tracking_vrs[is_ipv6], i) != vr_index)
844 /* Current index matches VR index */
846 vec_delete (intf->tracking_vrs[is_ipv6], 1, i);
848 /* If deleting, the job is done. If adding, it's already here */
852 /* vr index was not found. */
854 vec_add1 (intf->tracking_vrs[is_ipv6], vr_index);
857 /* Check if sw intf admin state is up or in the process of coming up */
859 vrrp_intf_sw_admin_up (u32 sw_if_index, vrrp_intf_update_t * pending)
861 vnet_main_t *vnm = vnet_get_main ();
864 if (pending && (pending->type == VRRP_IF_UPDATE_SW_ADMIN))
865 admin_up = pending->intf_up;
867 admin_up = vnet_sw_interface_is_admin_up (vnm, sw_if_index);
872 /* Check if hw intf link state is up or int the process of coming up */
874 vrrp_intf_hw_link_up (u32 sw_if_index, vrrp_intf_update_t * pending)
876 vnet_main_t *vnm = vnet_get_main ();
877 vnet_sw_interface_t *sup_sw;
880 sup_sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
882 if (pending && (pending->type == VRRP_IF_UPDATE_HW_LINK) &&
883 (pending->hw_if_index == sup_sw->hw_if_index))
884 link_up = pending->intf_up;
886 link_up = vnet_hw_interface_is_link_up (vnm, sup_sw->hw_if_index);
891 /* Check if interface has ability to send IP packets. */
893 vrrp_intf_ip_up (u32 sw_if_index, u8 is_ipv6, vrrp_intf_update_t * pending)
897 if (pending && pending->type == VRRP_IF_UPDATE_IP)
898 ip_up = pending->intf_up;
900 /* Either a unicast address has to be explicitly assigned, or
901 * for IPv6 only, a link local assigned and multicast/ND enabled
904 ((ip_interface_get_first_ip (sw_if_index, !is_ipv6) != 0) ||
905 (is_ipv6 && ip6_link_is_enabled (sw_if_index)));
911 vrrp_intf_is_up (u32 sw_if_index, u8 is_ipv6, vrrp_intf_update_t * pending)
913 int admin_up, link_up, ip_up;
915 admin_up = vrrp_intf_sw_admin_up (sw_if_index, pending);
916 link_up = vrrp_intf_hw_link_up (sw_if_index, pending);
917 ip_up = vrrp_intf_ip_up (sw_if_index, is_ipv6, pending);
919 return (admin_up && link_up && ip_up);
922 /* Examine the state of interfaces tracked by a VR and compute the priority
923 * adjustment that should be applied to the VR. If this is being called
924 * by the hw_link_up_down callback, the pending new flags on the sup hw
925 * interface have not been updated yet, so accept those as an optional
929 vrrp_vr_tracking_ifs_compute (vrrp_vr_t * vr, vrrp_intf_update_t * pending)
931 vrrp_vr_tracking_if_t *intf;
932 u32 total_priority = 0;
934 vec_foreach (intf, vr->tracking.interfaces)
936 if (vrrp_intf_is_up (intf->sw_if_index, vrrp_vr_is_ipv6 (vr), pending))
939 total_priority += intf->priority;
942 if (total_priority != vr->tracking.interfaces_dec)
944 clib_warning ("VR %U interface track adjustment change from %u to %u",
945 format_vrrp_vr_key, vr, vr->tracking.interfaces_dec,
947 vr->tracking.interfaces_dec = total_priority;
951 /* Manage tracked interfaces on a VR */
953 vrrp_vr_tracking_if_add_del (vrrp_vr_t * vr, u32 sw_if_index, u8 prio,
956 vnet_main_t *vnm = vnet_get_main ();
957 vrrp_vr_tracking_if_t *track_intf;
959 /* VR can't track non-existent interface */
960 if (!vnet_sw_interface_is_valid (vnm, sw_if_index))
961 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
963 /* VR can't track it's own interface */
964 if (sw_if_index == vr->config.sw_if_index)
965 return VNET_API_ERROR_INVALID_SW_IF_INDEX_2;
967 /* update intf vector of tracking VRs */
968 vrrp_intf_tracking_vr_add_del (sw_if_index, vr, is_add);
970 /* update VR vector of tracked interfaces */
971 vec_foreach (track_intf, vr->tracking.interfaces)
973 if (track_intf->sw_if_index != sw_if_index)
979 (vr->tracking.interfaces, 1, track_intf - vr->tracking.interfaces);
986 vec_add2 (vr->tracking.interfaces, track_intf, 1);
988 track_intf->sw_if_index = sw_if_index;
989 track_intf->priority = prio;
996 vrrp_vr_tracking_ifs_add_del (vrrp_vr_t * vr,
997 vrrp_vr_tracking_if_t * track_ifs, u8 is_add)
999 vrrp_vr_tracking_if_t *track_if, *ifs_copy;
1002 /* if deleting & track_ifs points to the VR list of tracked intfs, the
1003 * vector could be modified as we iterate it. make a copy instead */
1004 ifs_copy = vec_dup (track_ifs);
1006 /* add each tracked interface in the vector */
1007 vec_foreach (track_if, ifs_copy)
1009 rv = vrrp_vr_tracking_if_add_del (vr, track_if->sw_if_index,
1010 track_if->priority, (is_add != 0));
1012 /* if operation failed, undo the previous changes */
1015 vrrp_vr_tracking_if_t *rb_if;
1017 for (rb_if = track_if - 1; rb_if >= track_ifs; rb_if -= 1)
1018 vrrp_vr_tracking_if_add_del (vr, rb_if->sw_if_index,
1019 rb_if->priority, !(is_add != 0));
1024 vec_free (ifs_copy);
1026 vrrp_vr_tracking_ifs_compute (vr, 0);
1031 /* Compute priority to advertise on all VRs which track the given interface
1032 * and address family. The flags on an HW interface are not updated until
1033 * after link up/down callbacks are invoked, so if this function is called
1034 * by the link up/down callback, the flags about to be set will be passed
1035 * via the 'pending' argument. Otherwise, pending will be NULL.
1038 vrrp_intf_tracking_vrs_compute (u32 sw_if_index,
1039 vrrp_intf_update_t * pending, u8 is_ipv6)
1043 vrrp_intf_t *intf = vrrp_intf_get (sw_if_index);
1045 vec_foreach (vr_index, intf->tracking_vrs[is_ipv6])
1047 vr = vrrp_vr_lookup_index (*vr_index);
1049 vrrp_vr_tracking_ifs_compute (vr, pending);
1053 /* Interface being brought up/down is a quasi-{startup/shutdown} event.
1054 * Execute an appropriate state transition for all VRs on the interface.
1055 * This function may be invoked by:
1056 * sw interface admin up/down event
1057 * hw interface link up/down event
1060 vrrp_sw_interface_up_down (vrrp_intf_update_t * pending)
1067 intf = vrrp_intf_get (pending->sw_if_index);
1071 /* adjust state of VR's configured on this interface */
1072 for (i = 0; i < 2; i++)
1076 if (!intf->vr_indices[i])
1079 is_up = vrrp_intf_is_up (pending->sw_if_index, i, pending);
1081 vec_foreach (vr_index, intf->vr_indices[i])
1083 vrrp_vr_state_t vr_state;
1085 vr = vrrp_vr_lookup_index (*vr_index);
1089 if (vr->runtime.state == VRRP_VR_STATE_INIT)
1090 continue; /* VR not started yet, no transition */
1093 vr_state = VRRP_VR_STATE_INTF_DOWN;
1096 if (vr->runtime.state != VRRP_VR_STATE_INTF_DOWN)
1097 continue; /* shouldn't happen */
1099 vr_state = (vrrp_vr_is_owner (vr)) ?
1100 VRRP_VR_STATE_MASTER : VRRP_VR_STATE_BACKUP;
1103 vrrp_vr_transition (vr, vr_state, NULL);
1107 /* compute adjustments on any VR's tracking this interface */
1108 vrrp_intf_tracking_vrs_compute (pending->sw_if_index, pending,
1110 vrrp_intf_tracking_vrs_compute (pending->sw_if_index, pending,
1116 /* Process change in admin status on an interface */
1118 vrrp_sw_interface_admin_up_down (vnet_main_t * vnm, u32 sw_if_index,
1121 vrrp_intf_update_t pending = {
1122 .type = VRRP_IF_UPDATE_SW_ADMIN,
1123 .sw_if_index = sw_if_index,
1124 .intf_up = ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0),
1127 return vrrp_sw_interface_up_down (&pending);
1130 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (vrrp_sw_interface_admin_up_down);
1133 vrrp_hw_interface_link_up_down_walk (vnet_main_t * vnm,
1134 u32 sw_if_index, void *arg)
1136 vrrp_intf_update_t *pending = arg;
1138 pending->sw_if_index = sw_if_index;
1139 vrrp_sw_interface_up_down (pending);
1141 return WALK_CONTINUE;
1144 static clib_error_t *
1145 vrrp_hw_interface_link_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
1147 vrrp_intf_update_t pending = {
1148 .type = VRRP_IF_UPDATE_HW_LINK,
1149 .hw_if_index = hw_if_index,
1150 .intf_up = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) != 0),
1153 /* walk the sw interface and sub interfaces to adjust interface tracking */
1154 vnet_hw_interface_walk_sw (vnm, hw_if_index,
1155 vrrp_hw_interface_link_up_down_walk, &pending);
1160 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (vrrp_hw_interface_link_up_down);
1163 vrrp_ip4_add_del_interface_addr (ip4_main_t * im,
1166 ip4_address_t * address,
1168 u32 if_address_index, u32 is_del)
1170 vrrp_intf_tracking_vrs_compute (sw_if_index, NULL, 0 /* is_ipv6 */ );
1173 static ip6_link_delegate_id_t vrrp_ip6_delegate_id;
1176 format_vrrp_ip6_link (u8 * s, va_list * args)
1178 index_t indi = va_arg (*args, index_t);
1179 u32 indent = va_arg (*args, u32);
1183 intf = vrrp_intf_get ((u32) indi);
1185 s = format (s, "%UVRRP VRs monitoring this link:\n",
1186 format_white_space, indent);
1188 vec_foreach (vr_index, intf->tracking_vrs[1])
1190 vrrp_vr_t *vr = vrrp_vr_lookup_index (*vr_index);
1192 s = format (s, "%U%U\n", format_white_space, indent + 2,
1193 format_vrrp_vr_key, vr);
1200 vrrp_intf_ip6_enable_disable (u32 sw_if_index, int enable)
1202 vrrp_intf_update_t pending = {
1203 .type = VRRP_IF_UPDATE_IP,
1204 .sw_if_index = sw_if_index,
1208 vrrp_intf_tracking_vrs_compute (sw_if_index, &pending, 1 /* is_ipv6 */ );
1212 vrrp_intf_ip6_enable (u32 sw_if_index)
1214 vrrp_intf_ip6_enable_disable (sw_if_index, 1 /* enable */ );
1215 ip6_link_delegate_update (sw_if_index, vrrp_ip6_delegate_id, sw_if_index);
1219 vrrp_intf_ip6_disable (index_t indi)
1221 vrrp_intf_ip6_enable_disable (indi, 0 /* enable */ );
1224 const static ip6_link_delegate_vft_t vrrp_ip6_delegate_vft = {
1225 .ildv_enable = vrrp_intf_ip6_enable,
1226 .ildv_disable = vrrp_intf_ip6_disable,
1227 .ildv_format = format_vrrp_ip6_link,
1230 static clib_error_t *
1231 vrrp_init (vlib_main_t * vm)
1233 vrrp_main_t *vmp = &vrrp_main;
1234 clib_error_t *error = 0;
1235 ip4_main_t *im4 = &ip4_main;
1236 ip4_add_del_interface_address_callback_t cb4;
1237 vlib_node_t *intf_output_node;
1239 clib_memset (vmp, 0, sizeof (*vmp));
1241 if ((error = vlib_call_init_function (vm, ip4_lookup_init)) ||
1242 (error = vlib_call_init_function (vm, ip6_lookup_init)))
1245 vmp->vlib_main = vm;
1246 vmp->vnet_main = vnet_get_main ();
1248 intf_output_node = vlib_get_node_by_name (vm, (u8 *) "interface-output");
1249 vmp->intf_output_node_idx = intf_output_node->index;
1251 error = vrrp_plugin_api_hookup (vm);
1256 mhash_init (&vmp->vr_index_by_key, sizeof (u32), sizeof (vrrp_vr_key_t));
1257 vmp->vrrp4_arp_lookup = hash_create (0, sizeof (uword));
1258 vmp->vrrp6_nd_lookup = hash_create_mem (0, sizeof (vrrp6_nd_key_t),
1261 cb4.function = vrrp_ip4_add_del_interface_addr;
1262 cb4.function_opaque = 0;
1263 vec_add1 (im4->add_del_interface_address_callbacks, cb4);
1265 vrrp_ip6_delegate_id = ip6_link_delegate_register (&vrrp_ip6_delegate_vft);
1270 VLIB_INIT_FUNCTION (vrrp_init);
1274 VLIB_PLUGIN_REGISTER () =
1276 .version = VPP_BUILD_VER,
1277 .description = "VRRP v3 (RFC 5798)",
1282 * fd.io coding-style-patch-verification: ON
1285 * eval: (c-set-style "gnu")