vrrp: fix support for VRs in different FIBs
[vpp.git] / src / plugins / vrrp / vrrp.c
1 /*
2  * vrrp.c - vrrp plugin action functions
3  *
4  * Copyright 2019-2020 Rubicon Communications, LLC (Netgate)
5  *
6  * SPDX-License-Identifier: Apache-2.0
7  *
8  */
9
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>
19
20 #include <vrrp/vrrp.h>
21 #include <vrrp/vrrp_packet.h>
22
23 #include <vpp/app/version.h>
24
25 vrrp_main_t vrrp_main;
26
27 static const mac_address_t ipv4_vmac = {
28   .bytes = {0x00, 0x00, 0x5e, 0x00, 0x01, 0x00}
29 };
30
31 static const mac_address_t ipv6_vmac = {
32   .bytes = {0x00, 0x00, 0x5e, 0x00, 0x02, 0x00}
33 };
34
35 typedef struct
36 {
37   vrrp_vr_key_t key;
38   u32 count;
39 } vrrp_hwif_vr_count_t;
40
41 typedef enum
42 {
43   VRRP_IF_UPDATE_IP,
44   VRRP_IF_UPDATE_HW_LINK,
45   VRRP_IF_UPDATE_SW_ADMIN,
46 } vrrp_intf_update_type_t;
47
48 typedef struct
49 {
50   vrrp_intf_update_type_t type;
51   u32 sw_if_index;
52   u32 hw_if_index;
53   int intf_up;
54 } vrrp_intf_update_t;
55
56 static int vrrp_intf_is_up (u32 sw_if_index, u8 is_ipv6,
57                             vrrp_intf_update_t * pending);
58
59 static walk_rc_t
60 vrrp_hwif_master_count_walk (vnet_main_t * vnm, u32 sw_if_index, void *arg)
61 {
62   vrrp_hwif_vr_count_t *vr_count = arg;
63   vrrp_vr_t *vr;
64
65   vr = vrrp_vr_lookup (sw_if_index, vr_count->key.vr_id,
66                        vr_count->key.is_ipv6);
67
68   if (vr && (vr->runtime.state == VRRP_VR_STATE_MASTER))
69     vr_count->count++;
70
71   return WALK_CONTINUE;
72 }
73
74 /*
75  * Get a count of VRs in master state on a given hardware interface with
76  * the provided VR ID and AF.
77  */
78 static u32
79 vrrp_vr_hwif_master_vrs_by_vrid (u32 hw_if_index, u8 vr_id, u8 is_ipv6)
80 {
81   vnet_main_t *vnm = vnet_get_main ();
82   vrrp_hwif_vr_count_t vr_count;
83
84   clib_memset (&vr_count, 0, sizeof (vr_count));
85
86   vr_count.key.vr_id = vr_id;
87   vr_count.key.is_ipv6 = is_ipv6;
88
89   vnet_hw_interface_walk_sw (vnm, hw_if_index,
90                              vrrp_hwif_master_count_walk, &vr_count);
91
92   return vr_count.count;
93 }
94
95 /*
96  * Add or delete the VR virtual MAC address on the hardware interface
97  * when a VR enters or leaves the master state.
98  *
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.
102  */
103 void
104 vrrp_vr_transition_vmac (vrrp_vr_t * vr, vrrp_vr_state_t new_state)
105 {
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);
110   u32 n_master_vrs;
111
112   hw = vnet_get_sup_hw_interface (vnm, vr->config.sw_if_index);
113   n_master_vrs =
114     vrrp_vr_hwif_master_vrs_by_vrid (hw->hw_if_index, vr->config.vr_id,
115                                      vrrp_vr_is_ipv6 (vr));
116
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)))
119     {
120       clib_warning ("%s virtual MAC address %U on hardware interface %u",
121                     (enable) ? "Adding" : "Deleting",
122                     format_ethernet_address, vr->runtime.mac.bytes,
123                     hw->hw_if_index);
124
125       error = vnet_hw_interface_add_del_mac_address
126         (vnm, hw->hw_if_index, vr->runtime.mac.bytes, enable);
127     }
128
129   if (error)
130     clib_error_report (error);
131 }
132
133 /*
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
137  */
138 static void
139 vrrp_vr_transition_intf (vrrp_vr_t * vr, vrrp_vr_state_t new_state)
140 {
141   vrrp_intf_t *intf;
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);
145   u32 *vr_index;
146   int n_master_accept = 0;
147   int n_started = 0;
148
149   if (is_ipv6)
150     {
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";
155     }
156   else
157     {
158       arc_name = "arp";
159       node_name = "vrrp4-arp-input";
160       mc_arc_name = "ip4-multicast";
161       mc_node_name = "vrrp4-accept-owner-input";
162     }
163
164   intf = vrrp_intf_get (vr->config.sw_if_index);
165
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])
168   {
169     vrrp_vr_t *intf_vr = vrrp_vr_lookup_index (*vr_index);
170
171     if (intf_vr == vr)
172       continue;
173
174     if (intf_vr->runtime.state == VRRP_VR_STATE_INIT)
175       continue;
176
177     n_started++;
178
179     if ((intf_vr->runtime.state == VRRP_VR_STATE_MASTER) &&
180         vrrp_vr_accept_mode_enabled (intf_vr))
181       n_master_accept++;
182   }
183
184   /* If entering/leaving init state, start/stop ARP or ND feature if no other
185    * VRs are active on the interface.
186    */
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);
192
193   /* Special housekeeping when entering/leaving master mode */
194   if ((vr->runtime.state == VRRP_VR_STATE_MASTER) ||
195       (new_state == VRRP_VR_STATE_MASTER))
196     {
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]--;
202
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
205        * spoofing check.
206        */
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),
211                                      NULL, 0);
212     }
213 }
214
215 /* If accept mode enabled, add/remove VR addresses from interface */
216 static void
217 vrrp_vr_transition_addrs (vrrp_vr_t * vr, vrrp_vr_state_t new_state)
218 {
219   vlib_main_t *vm = vlib_get_main ();
220   u8 is_del;
221   ip46_address_t *vr_addr;
222
223   if (!vrrp_vr_accept_mode_enabled (vr))
224     return;
225
226   /* owner always has VR addresses configured, should never remove them */
227   if (vrrp_vr_is_owner (vr))
228     return;
229
230   if (vrrp_vr_is_unicast (vr))
231     return;
232
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))
236     return;
237
238   is_del = (new_state != VRRP_VR_STATE_MASTER);
239
240   clib_warning ("%s VR addresses on sw_if_index %u",
241                 (is_del) ? "Deleting" : "Adding", vr->config.sw_if_index);
242
243   vec_foreach (vr_addr, vr->config.vr_addrs)
244   {
245     ip_interface_address_t *ia = NULL;
246
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).
249      */
250     if (!vrrp_vr_is_ipv6 (vr))
251       {
252         ip4_main_t *im = &ip4_main;
253         ip4_address_t *intf4;
254
255         intf4 =
256           ip4_interface_address_matching_destination
257           (im, &vr_addr->ip4, vr->config.sw_if_index, &ia);
258
259         ip4_add_del_interface_address (vm, vr->config.sw_if_index,
260                                        &vr_addr->ip4,
261                                        (intf4 ? ia->address_length : 24),
262                                        is_del);
263       }
264     else
265       {
266         ip6_main_t *im = &ip6_main;
267         ip6_address_t *intf6;
268
269         intf6 =
270           ip6_interface_address_matching_destination
271           (im, &vr_addr->ip6, vr->config.sw_if_index, &ia);
272
273         ip6_add_del_interface_address (vm, vr->config.sw_if_index,
274                                        &vr_addr->ip6,
275                                        (intf6 ? ia->address_length : 64),
276                                        is_del);
277       }
278   }
279 }
280
281 void
282 vrrp_vr_transition (vrrp_vr_t * vr, vrrp_vr_state_t new_state, void *data)
283 {
284
285   clib_warning ("VR %U transitioning to %U", format_vrrp_vr_key, vr,
286                 format_vrrp_vr_state, new_state);
287
288   /* Don't do anything if transitioning to the state VR is already in.
289    * This should never happen, just covering our bases.
290    */
291   if (new_state == vr->runtime.state)
292     return;
293
294   if (new_state == VRRP_VR_STATE_MASTER)
295     {
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
298        */
299
300       vrrp_vr_multicast_group_join (vr);
301       vrrp_adv_send (vr, 0);
302       vrrp_garp_or_na_send (vr);
303
304       vrrp_vr_timer_set (vr, VRRP_VR_TIMER_ADV);
305     }
306   else if (new_state == VRRP_VR_STATE_BACKUP)
307     {
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
310        */
311
312       vrrp_vr_multicast_group_join (vr);
313
314       if (vr->runtime.state == VRRP_VR_STATE_MASTER)
315         {
316           vrrp_header_t *pkt = data;
317           vr->runtime.master_adv_int = vrrp_adv_int_from_packet (pkt);
318
319         }
320       else                      /* INIT, INTF_DOWN */
321         vr->runtime.master_adv_int = vr->config.adv_interval;
322
323       vrrp_vr_skew_compute (vr);
324       vrrp_vr_master_down_compute (vr);
325       vrrp_vr_timer_set (vr, VRRP_VR_TIMER_MASTER_DOWN);
326
327     }
328   else if (new_state == VRRP_VR_STATE_INIT)
329     {
330       /* RFC 5798 sec 6.4.2 (345) - shutdown event for backup VR
331        *          sec 6.4.3 (655) - shutdown event for master VR
332        */
333
334       vrrp_vr_timer_cancel (vr);
335       if (vr->runtime.state == VRRP_VR_STATE_MASTER)
336         vrrp_adv_send (vr, 1);
337     }
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
342      */
343     vrrp_vr_timer_cancel (vr);
344
345   /* add/delete virtual IP addrs if accept_mode is true */
346   vrrp_vr_transition_addrs (vr, new_state);
347
348   /* enable/disable input features if necessary */
349   vrrp_vr_transition_intf (vr, new_state);
350
351   /* add/delete virtual MAC address on NIC if necessary */
352   vrrp_vr_transition_vmac (vr, new_state);
353
354   vrrp_vr_event (vr, new_state);
355
356   vr->runtime.state = new_state;
357 }
358
359 #define VRRP4_MCAST_ADDR_AS_U8 { 224, 0, 0, 18 }
360 #define VRRP6_MCAST_ADDR_AS_U8 \
361 { 0xff, 0x2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x12 }
362
363 static const mfib_prefix_t all_vrrp4_routers = {
364   .fp_proto = FIB_PROTOCOL_IP4,
365   .fp_len = 32,
366   .fp_grp_addr = {
367                   .ip4 = {
368                           .as_u8 = VRRP4_MCAST_ADDR_AS_U8,
369                           },
370                   },
371 };
372
373 static const mfib_prefix_t all_vrrp6_routers = {
374   .fp_proto = FIB_PROTOCOL_IP6,
375   .fp_len = 128,
376   .fp_grp_addr = {
377                   .ip6 = {
378                           .as_u8 = VRRP6_MCAST_ADDR_AS_U8,
379                           },
380                   },
381 };
382
383 static int
384 vrrp_intf_enable_disable_mcast (u8 enable, u32 sw_if_index, u8 is_ipv6)
385 {
386   vrrp_main_t *vrm = &vrrp_main;
387   vrrp_intf_t *intf;
388   u32 fib_index, i;
389   u32 n_vrs_in_fib = 0;
390   const mfib_prefix_t *vrrp_prefix;
391   fib_protocol_t proto;
392   vnet_link_t link_type;
393   fib_route_path_t for_us = {
394     .frp_sw_if_index = 0xffffffff,
395     .frp_weight = 1,
396     .frp_flags = FIB_ROUTE_PATH_LOCAL,
397     .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
398   };
399   fib_route_path_t via_itf = {
400     .frp_sw_if_index = sw_if_index,
401     .frp_weight = 1,
402     .frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT,
403   };
404
405   intf = vrrp_intf_get (sw_if_index);
406
407   if (is_ipv6)
408     {
409       proto = FIB_PROTOCOL_IP6;
410       link_type = VNET_LINK_IP6;
411       vrrp_prefix = &all_vrrp6_routers;
412     }
413   else
414     {
415       proto = FIB_PROTOCOL_IP4;
416       link_type = VNET_LINK_IP4;
417       vrrp_prefix = &all_vrrp4_routers;
418     }
419
420   for_us.frp_proto = fib_proto_to_dpo (proto);
421   via_itf.frp_proto = fib_proto_to_dpo (proto);
422   fib_index = mfib_table_get_index_for_sw_if_index (proto, sw_if_index);
423
424   vec_foreach_index (i, vrm->vrrp_intfs)
425     {
426       if (mfib_table_get_index_for_sw_if_index (proto, i) != fib_index)
427         continue;
428
429       n_vrs_in_fib += vrrp_intf_num_vrs (i, is_ipv6);
430     }
431
432   if (enable)
433     {
434       /* ensure that the local mcast route exists */
435       mfib_table_entry_path_update (fib_index, vrrp_prefix, MFIB_SOURCE_API,
436                                     MFIB_ENTRY_FLAG_NONE, &for_us);
437
438       mfib_table_entry_path_update (fib_index, vrrp_prefix, MFIB_SOURCE_API,
439                                     MFIB_ENTRY_FLAG_NONE, &via_itf);
440       intf->mcast_adj_index[! !is_ipv6] =
441         adj_mcast_add_or_lock (proto, link_type, sw_if_index);
442     }
443   else
444     {
445       /* Remove mcast local routes if this is the last VR being deleted */
446       if (n_vrs_in_fib == 0)
447         mfib_table_entry_path_remove (fib_index, vrrp_prefix, MFIB_SOURCE_API,
448                                       &for_us);
449
450       mfib_table_entry_path_remove (fib_index, vrrp_prefix, MFIB_SOURCE_API,
451                                     &via_itf);
452     }
453
454   return 0;
455 }
456
457 static int
458 vrrp_intf_vr_add_del (u8 is_add, u32 sw_if_index, u32 vr_index, u8 is_ipv6)
459 {
460   vrrp_intf_t *vr_intf;
461
462   vr_intf = vrrp_intf_get (sw_if_index);
463   if (!vr_intf)
464     return -1;
465
466   if (is_add)
467     {
468       if (!vec_len (vr_intf->vr_indices[is_ipv6]))
469         vrrp_intf_enable_disable_mcast (1, sw_if_index, is_ipv6);
470
471       vec_add1 (vr_intf->vr_indices[is_ipv6], vr_index);
472     }
473   else
474     {
475       u32 per_intf_index =
476         vec_search (vr_intf->vr_indices[is_ipv6], vr_index);
477
478       if (per_intf_index != ~0)
479         vec_del1 (vr_intf->vr_indices[is_ipv6], per_intf_index);
480
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);
484     }
485
486   return 0;
487 }
488
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
492  * interface.
493  */
494 static int
495 vrrp_vr_valid_addrs_owner (vrrp_vr_config_t * vr_conf)
496 {
497   ip46_address_t *addr;
498   u8 is_ipv6 = (vr_conf->flags & VRRP_VR_IPV6) != 0;
499
500   vec_foreach (addr, vr_conf->vr_addrs)
501   {
502     if (!ip_interface_has_address (vr_conf->sw_if_index, addr, !is_ipv6))
503       return VNET_API_ERROR_ADDRESS_NOT_FOUND_FOR_INTERFACE;
504   }
505
506   return 0;
507 }
508
509 static int
510 vrrp_vr_valid_addrs_unused (vrrp_vr_config_t * vr_conf)
511 {
512   ip46_address_t *vr_addr;
513   u8 is_ipv6 = (vr_conf->flags & VRRP_VR_IPV6) != 0;
514
515   vec_foreach (vr_addr, vr_conf->vr_addrs)
516   {
517     u32 vr_index;
518     void *addr;
519
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);
522     if (vr_index != ~0)
523       return VNET_API_ERROR_ADDRESS_IN_USE;
524   }
525
526   return 0;
527 }
528
529 static int
530 vrrp_vr_valid_addrs (vrrp_vr_config_t * vr_conf)
531 {
532   int ret = 0;
533
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)
537     return ret;
538
539   /* make sure no other VR has already configured any of the VR addresses */
540   ret = vrrp_vr_valid_addrs_unused (vr_conf);
541
542   return ret;
543 }
544
545 int
546 vrrp_vr_addr_add_del (vrrp_vr_t * vr, u8 is_add, ip46_address_t * vr_addr)
547 {
548   vrrp_main_t *vmp = &vrrp_main;
549   u32 vr_index;
550   vrrp4_arp_key_t key4;
551   vrrp6_nd_key_t key6;
552   ip46_address_t *addr;
553
554   if (!vr || !vr_addr)
555     return VNET_API_ERROR_INVALID_ARGUMENT;
556
557   vr_index = vr - vmp->vrs;
558
559   if (vrrp_vr_is_ipv6 (vr))
560     {
561       key6.sw_if_index = vr->config.sw_if_index;
562       key6.addr = vr_addr->ip6;
563       if (is_add)
564         {
565           hash_set_mem_alloc (&vmp->vrrp6_nd_lookup, &key6, vr_index);
566           vec_add1 (vr->config.vr_addrs, vr_addr[0]);
567         }
568       else
569         {
570           hash_unset_mem_free (&vmp->vrrp6_nd_lookup, &key6);
571           vec_foreach (addr, vr->config.vr_addrs)
572           {
573             if (!ip46_address_cmp (addr, vr_addr))
574               {
575                 vec_del1 (vr->config.vr_addrs, vr->config.vr_addrs - addr);
576                 break;
577               }
578           }
579         }
580     }
581   else
582     {
583       key4.sw_if_index = vr->config.sw_if_index;
584       key4.addr = vr_addr->ip4;
585       if (is_add)
586         {
587           hash_set (vmp->vrrp4_arp_lookup, key4.as_u64, vr_index);
588           vec_add1 (vr->config.vr_addrs, vr_addr[0]);
589         }
590       else
591         {
592           hash_unset (vmp->vrrp4_arp_lookup, key4.as_u64);
593           vec_foreach (addr, vr->config.vr_addrs)
594           {
595             if (!ip46_address_cmp (addr, vr_addr))
596               {
597                 vec_del1 (vr->config.vr_addrs, vr->config.vr_addrs - addr);
598                 break;
599               }
600           }
601         }
602     }
603
604   return 0;
605 }
606
607 static void
608 vrrp_vr_addrs_add_del (vrrp_vr_t * vr, u8 is_add, ip46_address_t * vr_addrs)
609 {
610   ip46_address_t *vr_addr;
611
612   vec_foreach (vr_addr, vr_addrs)
613   {
614     vrrp_vr_addr_add_del (vr, is_add, vr_addr);
615   }
616 }
617
618 /* Action function shared between message handler and debug CLI */
619 int
620 vrrp_vr_add_del (u8 is_add, vrrp_vr_config_t * vr_conf)
621 {
622   vrrp_main_t *vrm = &vrrp_main;
623   vnet_main_t *vnm = vnet_get_main ();
624   vrrp_vr_key_t key;
625   uword *p;
626   u32 vr_index;
627   vrrp_vr_t *vr = 0;
628   int ret;
629
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;
633
634   clib_memset (&key, 0, sizeof (key));
635
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);
639
640   p = mhash_get (&vrm->vr_index_by_key, &key);
641
642   if (is_add)
643     {
644       /* does a VR matching this key already exist ? */
645       if (p)
646         {
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;
650         }
651
652       /* were IPvX addresses included ? */
653       if (!vec_len (vr_conf->vr_addrs))
654         {
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;
659         }
660
661       /* Make sure the addresses are ok to use */
662       if ((ret = vrrp_vr_valid_addrs (vr_conf)) < 0)
663         return ret;
664
665       pool_get_zero (vrm->vrs, vr);
666       vr_index = vr - vrm->vrs;
667
668       clib_memcpy (&vr->config, vr_conf, sizeof (vrrp_vr_config_t));
669
670       vr->config.vr_addrs = 0;  /* allocate our own memory */
671       vrrp_vr_addrs_add_del (vr, is_add, vr_conf->vr_addrs);
672
673       vr->runtime.state = VRRP_VR_STATE_INIT;
674       vr->runtime.timer_index = ~0;
675
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;
679
680       mhash_set (&vrm->vr_index_by_key, &key, vr_index, 0);
681     }
682   else
683     {
684       if (!p)
685         {
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;
689         }
690
691       vr_index = p[0];
692       vr = pool_elt_at_index (vrm->vrs, vr_index);
693
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.peer_addrs);
698       vec_free (vr->config.vr_addrs);
699       vec_free (vr->tracking.interfaces);
700       pool_put (vrm->vrs, vr);
701     }
702
703   vrrp_intf_vr_add_del (is_add, vr_conf->sw_if_index, vr_index, key.is_ipv6);
704
705   return 0;
706 }
707
708 int
709 vrrp_vr_start_stop (u8 is_start, vrrp_vr_key_t * vr_key)
710 {
711   vrrp_main_t *vmp = &vrrp_main;
712   uword *p;
713   vrrp_vr_t *vr = 0;
714
715   p = mhash_get (&vmp->vr_index_by_key, vr_key);
716   if (!p)
717     return VNET_API_ERROR_NO_SUCH_ENTRY;
718
719   vr = pool_elt_at_index (vmp->vrs, p[0]);
720
721   /* return success if already in the desired state */
722   switch (vr->runtime.state)
723     {
724     case VRRP_VR_STATE_INIT:
725       if (!is_start)
726         {
727           clib_warning ("Attempting to stop already stopped VR (%U)",
728                         format_vrrp_vr_key, vr);
729           return 0;
730         }
731       break;
732     default:
733       if (is_start)
734         {
735           clib_warning ("Attempting to start already started VR (%U)",
736                         format_vrrp_vr_key, vr);
737           return 0;
738         }
739       break;
740     }
741
742   if (is_start)
743     {
744       if (vrrp_vr_is_unicast (vr) && vec_len (vr->config.peer_addrs) == 0)
745         {
746           clib_warning ("Cannot start unicast VR without peers");
747           return VNET_API_ERROR_INIT_FAILED;
748         }
749
750       vmp->n_vrs_started++;
751
752       if (!vrrp_intf_is_up (vr->config.sw_if_index, vrrp_vr_is_ipv6 (vr),
753                             NULL))
754         {
755           clib_warning ("VRRP VR started on down interface (%U)",
756                         format_vrrp_vr_key, vr);
757           vrrp_vr_transition (vr, VRRP_VR_STATE_INTF_DOWN, NULL);
758         }
759       else if (vrrp_vr_is_owner (vr))
760         vrrp_vr_transition (vr, VRRP_VR_STATE_MASTER, NULL);
761       else
762         vrrp_vr_transition (vr, VRRP_VR_STATE_BACKUP, NULL);
763     }
764   else
765     {
766       vmp->n_vrs_started--;
767
768       vrrp_vr_transition (vr, VRRP_VR_STATE_INIT, NULL);
769     }
770
771   clib_warning ("%d VRs configured, %d VRs running",
772                 pool_elts (vmp->vrs), vmp->n_vrs_started);
773
774   return 0;
775 }
776
777 static int
778 vrrp_vr_set_peers_validate (vrrp_vr_t * vr, ip46_address_t * peers)
779 {
780   if (!vrrp_vr_is_unicast (vr))
781     {
782       clib_warning ("Peers can only be set on a unicast VR");
783       return VNET_API_ERROR_INVALID_ARGUMENT;
784     }
785
786   if (vr->runtime.state != VRRP_VR_STATE_INIT)
787     {
788       clib_warning ("Cannot set peers on a running VR");
789       return VNET_API_ERROR_RSRC_IN_USE;
790     }
791
792   if (vec_len (peers) == 0)
793     {
794       clib_warning ("No peer addresses provided");
795       return VNET_API_ERROR_INVALID_DST_ADDRESS;
796     }
797
798   return 0;
799 }
800
801 int
802 vrrp_vr_set_peers (vrrp_vr_key_t * vr_key, ip46_address_t * peers)
803 {
804   vrrp_main_t *vmp = &vrrp_main;
805   uword *p;
806   vrrp_vr_t *vr = 0;
807   int ret = 0;
808
809   p = mhash_get (&vmp->vr_index_by_key, vr_key);
810   if (!p)
811     return VNET_API_ERROR_NO_SUCH_ENTRY;
812
813   vr = pool_elt_at_index (vmp->vrs, p[0]);
814
815   ret = vrrp_vr_set_peers_validate (vr, peers);
816   if (ret < 0)
817     return ret;
818
819   if (vr->config.peer_addrs)
820     vec_free (vr->config.peer_addrs);
821
822   vr->config.peer_addrs = vec_dup (peers);
823
824   return 0;
825 }
826
827 /* Manage reference on the interface to the VRs which track that interface */
828 static void
829 vrrp_intf_tracking_vr_add_del (u32 sw_if_index, vrrp_vr_t * vr, u8 is_add)
830 {
831   vrrp_intf_t *intf;
832   u32 vr_index;
833   u8 is_ipv6 = vrrp_vr_is_ipv6 (vr);
834   int i;
835
836   intf = vrrp_intf_get (sw_if_index);
837   vr_index = vrrp_vr_index (vr);
838
839   /* Try to find the VR index in the list of tracking VRs */
840   vec_foreach_index (i, intf->tracking_vrs[is_ipv6])
841   {
842     if (vec_elt (intf->tracking_vrs[is_ipv6], i) != vr_index)
843       continue;
844
845     /* Current index matches VR index */
846     if (!is_add)
847       vec_delete (intf->tracking_vrs[is_ipv6], 1, i);
848
849     /* If deleting, the job is done. If adding, it's already here */
850     return;
851   }
852
853   /* vr index was not found. */
854   if (is_add)
855     vec_add1 (intf->tracking_vrs[is_ipv6], vr_index);
856 }
857
858 /* Check if sw intf admin state is up or in the process of coming up */
859 static int
860 vrrp_intf_sw_admin_up (u32 sw_if_index, vrrp_intf_update_t * pending)
861 {
862   vnet_main_t *vnm = vnet_get_main ();
863   int admin_up;
864
865   if (pending && (pending->type == VRRP_IF_UPDATE_SW_ADMIN))
866     admin_up = pending->intf_up;
867   else
868     admin_up = vnet_sw_interface_is_admin_up (vnm, sw_if_index);
869
870   return admin_up;
871 }
872
873 /* Check if hw intf link state is up or int the process of coming up */
874 static int
875 vrrp_intf_hw_link_up (u32 sw_if_index, vrrp_intf_update_t * pending)
876 {
877   vnet_main_t *vnm = vnet_get_main ();
878   vnet_sw_interface_t *sup_sw;
879   int link_up;
880
881   sup_sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
882
883   if (pending && (pending->type == VRRP_IF_UPDATE_HW_LINK) &&
884       (pending->hw_if_index == sup_sw->hw_if_index))
885     link_up = pending->intf_up;
886   else
887     link_up = vnet_hw_interface_is_link_up (vnm, sup_sw->hw_if_index);
888
889   return link_up;
890 }
891
892 /* Check if interface has ability to send IP packets. */
893 static int
894 vrrp_intf_ip_up (u32 sw_if_index, u8 is_ipv6, vrrp_intf_update_t * pending)
895 {
896   int ip_up;
897
898   if (pending && pending->type == VRRP_IF_UPDATE_IP)
899     ip_up = pending->intf_up;
900   else
901     /* Either a unicast address has to be explicitly assigned, or
902      * for IPv6 only, a link local assigned and multicast/ND enabled
903      */
904     ip_up =
905       ((ip_interface_get_first_ip (sw_if_index, !is_ipv6) != 0) ||
906        (is_ipv6 && ip6_link_is_enabled (sw_if_index)));
907
908   return ip_up;
909 }
910
911 static int
912 vrrp_intf_is_up (u32 sw_if_index, u8 is_ipv6, vrrp_intf_update_t * pending)
913 {
914   int admin_up, link_up, ip_up;
915
916   admin_up = vrrp_intf_sw_admin_up (sw_if_index, pending);
917   link_up = vrrp_intf_hw_link_up (sw_if_index, pending);
918   ip_up = vrrp_intf_ip_up (sw_if_index, is_ipv6, pending);
919
920   return (admin_up && link_up && ip_up);
921 }
922
923 /* Examine the state of interfaces tracked by a VR and compute the priority
924  * adjustment that should be applied to the VR. If this is being called
925  * by the hw_link_up_down callback, the pending new flags on the sup hw
926  * interface have not been updated yet, so accept those as an optional
927  * argument.
928  */
929 void
930 vrrp_vr_tracking_ifs_compute (vrrp_vr_t * vr, vrrp_intf_update_t * pending)
931 {
932   vrrp_vr_tracking_if_t *intf;
933   u32 total_priority = 0;
934
935   vec_foreach (intf, vr->tracking.interfaces)
936   {
937     if (vrrp_intf_is_up (intf->sw_if_index, vrrp_vr_is_ipv6 (vr), pending))
938       continue;
939
940     total_priority += intf->priority;
941   }
942
943   if (total_priority != vr->tracking.interfaces_dec)
944     {
945       clib_warning ("VR %U interface track adjustment change from %u to %u",
946                     format_vrrp_vr_key, vr, vr->tracking.interfaces_dec,
947                     total_priority);
948       vr->tracking.interfaces_dec = total_priority;
949     }
950 }
951
952 /* Manage tracked interfaces on a VR */
953 int
954 vrrp_vr_tracking_if_add_del (vrrp_vr_t * vr, u32 sw_if_index, u8 prio,
955                              u8 is_add)
956 {
957   vnet_main_t *vnm = vnet_get_main ();
958   vrrp_vr_tracking_if_t *track_intf;
959
960   /* VR can't track non-existent interface */
961   if (!vnet_sw_interface_is_valid (vnm, sw_if_index))
962     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
963
964   /* VR can't track it's own interface */
965   if (sw_if_index == vr->config.sw_if_index)
966     return VNET_API_ERROR_INVALID_SW_IF_INDEX_2;
967
968   /* update intf vector of tracking VRs */
969   vrrp_intf_tracking_vr_add_del (sw_if_index, vr, is_add);
970
971   /* update VR vector of tracked interfaces */
972   vec_foreach (track_intf, vr->tracking.interfaces)
973   {
974     if (track_intf->sw_if_index != sw_if_index)
975       continue;
976
977     /* found it */
978     if (!is_add)
979       vec_delete
980         (vr->tracking.interfaces, 1, track_intf - vr->tracking.interfaces);
981
982     return 0;
983   }
984
985   if (is_add)
986     {
987       vec_add2 (vr->tracking.interfaces, track_intf, 1);
988
989       track_intf->sw_if_index = sw_if_index;
990       track_intf->priority = prio;
991     }
992
993   return 0;
994 }
995
996 int
997 vrrp_vr_tracking_ifs_add_del (vrrp_vr_t * vr,
998                               vrrp_vr_tracking_if_t * track_ifs, u8 is_add)
999 {
1000   vrrp_vr_tracking_if_t *track_if, *ifs_copy;
1001   int rv = 0;
1002
1003   /* if deleting & track_ifs points to the VR list of tracked intfs, the
1004    * vector could be modified as we iterate it. make a copy instead */
1005   ifs_copy = vec_dup (track_ifs);
1006
1007   /* add each tracked interface in the vector */
1008   vec_foreach (track_if, ifs_copy)
1009   {
1010     rv = vrrp_vr_tracking_if_add_del (vr, track_if->sw_if_index,
1011                                       track_if->priority, (is_add != 0));
1012
1013     /* if operation failed, undo the previous changes */
1014     if (rv)
1015       {
1016         vrrp_vr_tracking_if_t *rb_if;
1017
1018         for (rb_if = track_if - 1; rb_if >= track_ifs; rb_if -= 1)
1019           vrrp_vr_tracking_if_add_del (vr, rb_if->sw_if_index,
1020                                        rb_if->priority, !(is_add != 0));
1021         break;
1022       }
1023   }
1024
1025   vec_free (ifs_copy);
1026
1027   vrrp_vr_tracking_ifs_compute (vr, 0);
1028
1029   return rv;
1030 }
1031
1032 /* Compute priority to advertise on all VRs which track the given interface
1033  * and address family. The flags on an HW interface are not updated until
1034  * after link up/down callbacks are invoked, so if this function is called
1035  * by the link up/down callback, the flags about to be set will be passed
1036  * via the 'pending' argument. Otherwise, pending will be NULL.
1037  */
1038 static void
1039 vrrp_intf_tracking_vrs_compute (u32 sw_if_index,
1040                                 vrrp_intf_update_t * pending, u8 is_ipv6)
1041 {
1042   u32 *vr_index;
1043   vrrp_vr_t *vr;
1044   vrrp_intf_t *intf = vrrp_intf_get (sw_if_index);
1045
1046   vec_foreach (vr_index, intf->tracking_vrs[is_ipv6])
1047   {
1048     vr = vrrp_vr_lookup_index (*vr_index);
1049     if (vr)
1050       vrrp_vr_tracking_ifs_compute (vr, pending);
1051   }
1052 }
1053
1054 /* Interface being brought up/down is a quasi-{startup/shutdown} event.
1055  * Execute an appropriate state transition for all VRs on the interface.
1056  * This function may be invoked by:
1057  *    sw interface admin up/down event
1058  *    hw interface link up/down event
1059  */
1060 clib_error_t *
1061 vrrp_sw_interface_up_down (vrrp_intf_update_t * pending)
1062 {
1063   vrrp_intf_t *intf;
1064   int i;
1065   u32 *vr_index;
1066   vrrp_vr_t *vr;
1067
1068   intf = vrrp_intf_get (pending->sw_if_index);
1069   if (!intf)
1070     return 0;
1071
1072   /* adjust state of VR's configured on this interface */
1073   for (i = 0; i < 2; i++)
1074     {
1075       int is_up;
1076
1077       if (!intf->vr_indices[i])
1078         continue;
1079
1080       is_up = vrrp_intf_is_up (pending->sw_if_index, i, pending);
1081
1082       vec_foreach (vr_index, intf->vr_indices[i])
1083       {
1084         vrrp_vr_state_t vr_state;
1085
1086         vr = vrrp_vr_lookup_index (*vr_index);
1087         if (!vr)
1088           continue;
1089
1090         if (vr->runtime.state == VRRP_VR_STATE_INIT)
1091           continue;             /* VR not started yet, no transition */
1092
1093         if (!is_up)
1094           vr_state = VRRP_VR_STATE_INTF_DOWN;
1095         else
1096           {
1097             if (vr->runtime.state != VRRP_VR_STATE_INTF_DOWN)
1098               continue;         /* shouldn't happen */
1099
1100             vr_state = (vrrp_vr_is_owner (vr)) ?
1101               VRRP_VR_STATE_MASTER : VRRP_VR_STATE_BACKUP;
1102           }
1103
1104         vrrp_vr_transition (vr, vr_state, NULL);
1105       }
1106     }
1107
1108   /* compute adjustments on any VR's tracking this interface */
1109   vrrp_intf_tracking_vrs_compute (pending->sw_if_index, pending,
1110                                   0 /* is_ipv6 */ );
1111   vrrp_intf_tracking_vrs_compute (pending->sw_if_index, pending,
1112                                   1 /* is_ipv6 */ );
1113
1114   return 0;
1115 }
1116
1117 /* Process change in admin status on an interface */
1118 clib_error_t *
1119 vrrp_sw_interface_admin_up_down (vnet_main_t * vnm, u32 sw_if_index,
1120                                  u32 flags)
1121 {
1122   vrrp_intf_update_t pending = {
1123     .type = VRRP_IF_UPDATE_SW_ADMIN,
1124     .sw_if_index = sw_if_index,
1125     .intf_up = ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0),
1126   };
1127
1128   return vrrp_sw_interface_up_down (&pending);
1129 }
1130
1131 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (vrrp_sw_interface_admin_up_down);
1132
1133 static walk_rc_t
1134 vrrp_hw_interface_link_up_down_walk (vnet_main_t * vnm,
1135                                      u32 sw_if_index, void *arg)
1136 {
1137   vrrp_intf_update_t *pending = arg;
1138
1139   pending->sw_if_index = sw_if_index;
1140   vrrp_sw_interface_up_down (pending);
1141
1142   return WALK_CONTINUE;
1143 }
1144
1145 static clib_error_t *
1146 vrrp_hw_interface_link_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
1147 {
1148   vrrp_intf_update_t pending = {
1149     .type = VRRP_IF_UPDATE_HW_LINK,
1150     .hw_if_index = hw_if_index,
1151     .intf_up = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) != 0),
1152   };
1153
1154   /* walk the sw interface and sub interfaces to adjust interface tracking */
1155   vnet_hw_interface_walk_sw (vnm, hw_if_index,
1156                              vrrp_hw_interface_link_up_down_walk, &pending);
1157
1158   return 0;
1159 }
1160
1161 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (vrrp_hw_interface_link_up_down);
1162
1163 static void
1164 vrrp_ip4_add_del_interface_addr (ip4_main_t * im,
1165                                  uword opaque,
1166                                  u32 sw_if_index,
1167                                  ip4_address_t * address,
1168                                  u32 address_length,
1169                                  u32 if_address_index, u32 is_del)
1170 {
1171   vrrp_intf_tracking_vrs_compute (sw_if_index, NULL, 0 /* is_ipv6 */ );
1172 }
1173
1174 static ip6_link_delegate_id_t vrrp_ip6_delegate_id;
1175
1176 static u8 *
1177 format_vrrp_ip6_link (u8 * s, va_list * args)
1178 {
1179   index_t indi = va_arg (*args, index_t);
1180   u32 indent = va_arg (*args, u32);
1181   vrrp_intf_t *intf;
1182   u32 *vr_index;
1183
1184   intf = vrrp_intf_get ((u32) indi);
1185
1186   s = format (s, "%UVRRP VRs monitoring this link:\n",
1187               format_white_space, indent);
1188
1189   vec_foreach (vr_index, intf->tracking_vrs[1])
1190   {
1191     vrrp_vr_t *vr = vrrp_vr_lookup_index (*vr_index);
1192
1193     s = format (s, "%U%U\n", format_white_space, indent + 2,
1194                 format_vrrp_vr_key, vr);
1195   }
1196
1197   return s;
1198 }
1199
1200 static void
1201 vrrp_intf_ip6_enable_disable (u32 sw_if_index, int enable)
1202 {
1203   vrrp_intf_update_t pending = {
1204     .type = VRRP_IF_UPDATE_IP,
1205     .sw_if_index = sw_if_index,
1206     .intf_up = enable,
1207   };
1208
1209   vrrp_intf_tracking_vrs_compute (sw_if_index, &pending, 1 /* is_ipv6 */ );
1210 }
1211
1212 static void
1213 vrrp_intf_ip6_enable (u32 sw_if_index)
1214 {
1215   vrrp_intf_ip6_enable_disable (sw_if_index, 1 /* enable */ );
1216   ip6_link_delegate_update (sw_if_index, vrrp_ip6_delegate_id, sw_if_index);
1217 }
1218
1219 static void
1220 vrrp_intf_ip6_disable (index_t indi)
1221 {
1222   vrrp_intf_ip6_enable_disable (indi, 0 /* enable */ );
1223 }
1224
1225 const static ip6_link_delegate_vft_t vrrp_ip6_delegate_vft = {
1226   .ildv_enable = vrrp_intf_ip6_enable,
1227   .ildv_disable = vrrp_intf_ip6_disable,
1228   .ildv_format = format_vrrp_ip6_link,
1229 };
1230
1231 static clib_error_t *
1232 vrrp_init (vlib_main_t * vm)
1233 {
1234   vrrp_main_t *vmp = &vrrp_main;
1235   clib_error_t *error = 0;
1236   ip4_main_t *im4 = &ip4_main;
1237   ip4_add_del_interface_address_callback_t cb4;
1238   vlib_node_t *intf_output_node;
1239
1240   clib_memset (vmp, 0, sizeof (*vmp));
1241
1242   if ((error = vlib_call_init_function (vm, ip4_lookup_init)) ||
1243       (error = vlib_call_init_function (vm, ip6_lookup_init)))
1244     return error;
1245
1246   vmp->vlib_main = vm;
1247   vmp->vnet_main = vnet_get_main ();
1248
1249   intf_output_node = vlib_get_node_by_name (vm, (u8 *) "interface-output");
1250   vmp->intf_output_node_idx = intf_output_node->index;
1251
1252   error = vrrp_plugin_api_hookup (vm);
1253
1254   if (error)
1255     return error;
1256
1257   mhash_init (&vmp->vr_index_by_key, sizeof (u32), sizeof (vrrp_vr_key_t));
1258   vmp->vrrp4_arp_lookup = hash_create (0, sizeof (uword));
1259   vmp->vrrp6_nd_lookup = hash_create_mem (0, sizeof (vrrp6_nd_key_t),
1260                                           sizeof (uword));
1261
1262   cb4.function = vrrp_ip4_add_del_interface_addr;
1263   cb4.function_opaque = 0;
1264   vec_add1 (im4->add_del_interface_address_callbacks, cb4);
1265
1266   vrrp_ip6_delegate_id = ip6_link_delegate_register (&vrrp_ip6_delegate_vft);
1267
1268   return error;
1269 }
1270
1271 VLIB_INIT_FUNCTION (vrrp_init);
1272
1273
1274 /* *INDENT-OFF* */
1275 VLIB_PLUGIN_REGISTER () =
1276 {
1277   .version = VPP_BUILD_VER,
1278   .description = "VRRP v3 (RFC 5798)",
1279 };
1280 /* *INDENT-ON* */
1281
1282 /*
1283  * fd.io coding-style-patch-verification: ON
1284  *
1285  * Local Variables:
1286  * eval: (c-set-style "gnu")
1287  * End:
1288  */