vrrp: improve RFC compliance for ARP/ND
[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   vr->runtime.state = new_state;
355 }
356
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 }
360
361 static const mfib_prefix_t all_vrrp4_routers = {
362   .fp_proto = FIB_PROTOCOL_IP4,
363   .fp_len = 32,
364   .fp_grp_addr = {
365                   .ip4 = {
366                           .as_u8 = VRRP4_MCAST_ADDR_AS_U8,
367                           },
368                   },
369 };
370
371 static const mfib_prefix_t all_vrrp6_routers = {
372   .fp_proto = FIB_PROTOCOL_IP6,
373   .fp_len = 128,
374   .fp_grp_addr = {
375                   .ip6 = {
376                           .as_u8 = VRRP6_MCAST_ADDR_AS_U8,
377                           },
378                   },
379 };
380
381 static int
382 vrrp_intf_enable_disable_mcast (u8 enable, u32 sw_if_index, u8 is_ipv6)
383 {
384   vrrp_main_t *vrm = &vrrp_main;
385   vrrp_intf_t *intf;
386   u32 fib_index;
387   const mfib_prefix_t *vrrp_prefix;
388   fib_protocol_t proto;
389   vnet_link_t link_type;
390   fib_route_path_t for_us = {
391     .frp_sw_if_index = 0xffffffff,
392     .frp_weight = 1,
393     .frp_flags = FIB_ROUTE_PATH_LOCAL,
394     .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
395   };
396   fib_route_path_t via_itf = {
397     .frp_sw_if_index = sw_if_index,
398     .frp_weight = 1,
399     .frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT,
400   };
401
402   intf = vrrp_intf_get (sw_if_index);
403
404   if (is_ipv6)
405     {
406       proto = FIB_PROTOCOL_IP6;
407       link_type = VNET_LINK_IP6;
408       vrrp_prefix = &all_vrrp6_routers;
409     }
410   else
411     {
412       proto = FIB_PROTOCOL_IP4;
413       link_type = VNET_LINK_IP4;
414       vrrp_prefix = &all_vrrp4_routers;
415     }
416
417   for_us.frp_proto = fib_proto_to_dpo (proto);
418   via_itf.frp_proto = fib_proto_to_dpo (proto);
419   fib_index = mfib_table_get_index_for_sw_if_index (proto, sw_if_index);
420
421   if (enable)
422     {
423       if (pool_elts (vrm->vrs) == 1)
424         mfib_table_entry_path_update (fib_index, vrrp_prefix, MFIB_SOURCE_API,
425                                       &for_us);
426
427       mfib_table_entry_path_update (fib_index, vrrp_prefix, MFIB_SOURCE_API,
428                                     &via_itf);
429       intf->mcast_adj_index[! !is_ipv6] =
430         adj_mcast_add_or_lock (proto, link_type, sw_if_index);
431     }
432   else
433     {
434       if (pool_elts (vrm->vrs) == 0)
435         mfib_table_entry_path_remove (fib_index, vrrp_prefix, MFIB_SOURCE_API,
436                                       &for_us);
437
438       mfib_table_entry_path_remove (fib_index, vrrp_prefix, MFIB_SOURCE_API,
439                                     &via_itf);
440     }
441
442   return 0;
443 }
444
445 static int
446 vrrp_intf_vr_add_del (u8 is_add, u32 sw_if_index, u32 vr_index, u8 is_ipv6)
447 {
448   vrrp_intf_t *vr_intf;
449
450   vr_intf = vrrp_intf_get (sw_if_index);
451   if (!vr_intf)
452     return -1;
453
454   if (is_add)
455     {
456       if (!vec_len (vr_intf->vr_indices[is_ipv6]))
457         vrrp_intf_enable_disable_mcast (1, sw_if_index, is_ipv6);
458
459       vec_add1 (vr_intf->vr_indices[is_ipv6], vr_index);
460     }
461   else
462     {
463       u32 per_intf_index =
464         vec_search (vr_intf->vr_indices[is_ipv6], vr_index);
465
466       if (per_intf_index != ~0)
467         vec_del1 (vr_intf->vr_indices[is_ipv6], per_intf_index);
468
469       /* no more VRs on this interface, disable multicast */
470       if (!vec_len (vr_intf->vr_indices[is_ipv6]))
471         vrrp_intf_enable_disable_mcast (0, sw_if_index, is_ipv6);
472     }
473
474   return 0;
475 }
476
477 /* RFC 5798 section 8.3.2 says to take care not to configure more than
478  * one VRRP router as the "IPvX address owner" of a VRID. Make sure that
479  * all of the addresses configured for this VR are configured on the
480  * interface.
481  */
482 static int
483 vrrp_vr_valid_addrs_owner (vrrp_vr_config_t * vr_conf)
484 {
485   ip46_address_t *addr;
486   u8 is_ipv6 = (vr_conf->flags & VRRP_VR_IPV6) != 0;
487
488   vec_foreach (addr, vr_conf->vr_addrs)
489   {
490     if (!ip_interface_has_address (vr_conf->sw_if_index, addr, !is_ipv6))
491       return VNET_API_ERROR_ADDRESS_NOT_FOUND_FOR_INTERFACE;
492   }
493
494   return 0;
495 }
496
497 static int
498 vrrp_vr_valid_addrs_unused (vrrp_vr_config_t * vr_conf)
499 {
500   ip46_address_t *vr_addr;
501   u8 is_ipv6 = (vr_conf->flags & VRRP_VR_IPV6) != 0;
502
503   vec_foreach (vr_addr, vr_conf->vr_addrs)
504   {
505     u32 vr_index;
506     void *addr;
507
508     addr = (is_ipv6) ? (void *) &vr_addr->ip6 : (void *) &vr_addr->ip4;
509     vr_index = vrrp_vr_lookup_address (vr_conf->sw_if_index, is_ipv6, addr);
510     if (vr_index != ~0)
511       return VNET_API_ERROR_ADDRESS_IN_USE;
512   }
513
514   return 0;
515 }
516
517 static int
518 vrrp_vr_valid_addrs (vrrp_vr_config_t * vr_conf)
519 {
520   int ret = 0;
521
522   /* If the VR owns the addresses, make sure they are configured */
523   if (vr_conf->priority == 255 &&
524       (ret = vrrp_vr_valid_addrs_owner (vr_conf)) < 0)
525     return ret;
526
527   /* make sure no other VR has already configured any of the VR addresses */
528   ret = vrrp_vr_valid_addrs_unused (vr_conf);
529
530   return ret;
531 }
532
533 int
534 vrrp_vr_addr_add_del (vrrp_vr_t * vr, u8 is_add, ip46_address_t * vr_addr)
535 {
536   vrrp_main_t *vmp = &vrrp_main;
537   u32 vr_index;
538   vrrp4_arp_key_t key4;
539   vrrp6_nd_key_t key6;
540   ip46_address_t *addr;
541
542   if (!vr || !vr_addr)
543     return VNET_API_ERROR_INVALID_ARGUMENT;
544
545   vr_index = vr - vmp->vrs;
546
547   if (vrrp_vr_is_ipv6 (vr))
548     {
549       key6.sw_if_index = vr->config.sw_if_index;
550       key6.addr = vr_addr->ip6;
551       if (is_add)
552         {
553           hash_set_mem_alloc (&vmp->vrrp6_nd_lookup, &key6, vr_index);
554           vec_add1 (vr->config.vr_addrs, vr_addr[0]);
555         }
556       else
557         {
558           hash_unset_mem_free (&vmp->vrrp6_nd_lookup, &key6);
559           vec_foreach (addr, vr->config.vr_addrs)
560           {
561             if (!ip46_address_cmp (addr, vr_addr))
562               {
563                 vec_del1 (vr->config.vr_addrs, vr->config.vr_addrs - addr);
564                 break;
565               }
566           }
567         }
568     }
569   else
570     {
571       key4.sw_if_index = vr->config.sw_if_index;
572       key4.addr = vr_addr->ip4;
573       if (is_add)
574         {
575           hash_set (vmp->vrrp4_arp_lookup, key4.as_u64, vr_index);
576           vec_add1 (vr->config.vr_addrs, vr_addr[0]);
577         }
578       else
579         {
580           hash_unset (vmp->vrrp4_arp_lookup, key4.as_u64);
581           vec_foreach (addr, vr->config.vr_addrs)
582           {
583             if (!ip46_address_cmp (addr, vr_addr))
584               {
585                 vec_del1 (vr->config.vr_addrs, vr->config.vr_addrs - addr);
586                 break;
587               }
588           }
589         }
590     }
591
592   return 0;
593 }
594
595 static void
596 vrrp_vr_addrs_add_del (vrrp_vr_t * vr, u8 is_add, ip46_address_t * vr_addrs)
597 {
598   ip46_address_t *vr_addr;
599
600   vec_foreach (vr_addr, vr_addrs)
601   {
602     vrrp_vr_addr_add_del (vr, is_add, vr_addr);
603   }
604 }
605
606 /* Action function shared between message handler and debug CLI */
607 int
608 vrrp_vr_add_del (u8 is_add, vrrp_vr_config_t * vr_conf)
609 {
610   vrrp_main_t *vrm = &vrrp_main;
611   vnet_main_t *vnm = vnet_get_main ();
612   vrrp_vr_key_t key;
613   uword *p;
614   u32 vr_index;
615   vrrp_vr_t *vr = 0;
616   int ret;
617
618   if (vr_conf->sw_if_index == ~0 ||
619       !vnet_sw_interface_is_valid (vnm, vr_conf->sw_if_index))
620     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
621
622   clib_memset (&key, 0, sizeof (key));
623
624   key.sw_if_index = vr_conf->sw_if_index;
625   key.vr_id = vr_conf->vr_id;
626   key.is_ipv6 = ((vr_conf->flags & VRRP_VR_IPV6) != 0);
627
628   p = mhash_get (&vrm->vr_index_by_key, &key);
629
630   if (is_add)
631     {
632       /* does a VR matching this key already exist ? */
633       if (p)
634         {
635           clib_warning ("VR %u for IPv%d already exists on sw_if_index %u",
636                         key.vr_id, (key.is_ipv6) ? 6 : 4, key.sw_if_index);
637           return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
638         }
639
640       /* were IPvX addresses included ? */
641       if (!vec_len (vr_conf->vr_addrs))
642         {
643           clib_warning ("Conf of VR %u for IPv%d on sw_if_index %u "
644                         " does not contain IP addresses",
645                         key.vr_id, (key.is_ipv6) ? 6 : 4, key.sw_if_index);
646           return VNET_API_ERROR_INVALID_SRC_ADDRESS;
647         }
648
649       /* Make sure the addresses are ok to use */
650       if ((ret = vrrp_vr_valid_addrs (vr_conf)) < 0)
651         return ret;
652
653       pool_get_zero (vrm->vrs, vr);
654       vr_index = vr - vrm->vrs;
655
656       clib_memcpy (&vr->config, vr_conf, sizeof (vrrp_vr_config_t));
657
658       vr->config.vr_addrs = 0;  /* allocate our own memory */
659       vrrp_vr_addrs_add_del (vr, is_add, vr_conf->vr_addrs);
660
661       vr->runtime.state = VRRP_VR_STATE_INIT;
662       vr->runtime.timer_index = ~0;
663
664       /* set virtual MAC based on IP version and VR ID */
665       vr->runtime.mac = (key.is_ipv6) ? ipv6_vmac : ipv4_vmac;
666       vr->runtime.mac.bytes[5] = vr_conf->vr_id;
667
668       mhash_set (&vrm->vr_index_by_key, &key, vr_index, 0);
669     }
670   else
671     {
672       if (!p)
673         {
674           clib_warning ("No VR %u for IPv%d exists on sw_if_index %u",
675                         key.vr_id, (key.is_ipv6) ? 6 : 4, key.sw_if_index);
676           return VNET_API_ERROR_NO_SUCH_ENTRY;
677         }
678
679       vr_index = p[0];
680       vr = pool_elt_at_index (vrm->vrs, vr_index);
681
682       vrrp_vr_tracking_ifs_add_del (vr, vr->tracking.interfaces, is_add);
683       vrrp_vr_addrs_add_del (vr, is_add, vr->config.vr_addrs);
684       mhash_unset (&vrm->vr_index_by_key, &key, 0);
685       vec_free (vr->config.vr_addrs);
686       vec_free (vr->tracking.interfaces);
687       pool_put (vrm->vrs, vr);
688     }
689
690   vrrp_intf_vr_add_del (is_add, vr_conf->sw_if_index, vr_index, key.is_ipv6);
691
692   return 0;
693 }
694
695 int
696 vrrp_vr_start_stop (u8 is_start, vrrp_vr_key_t * vr_key)
697 {
698   vrrp_main_t *vmp = &vrrp_main;
699   uword *p;
700   vrrp_vr_t *vr = 0;
701
702   p = mhash_get (&vmp->vr_index_by_key, vr_key);
703   if (!p)
704     return VNET_API_ERROR_NO_SUCH_ENTRY;
705
706   vr = pool_elt_at_index (vmp->vrs, p[0]);
707
708   /* return success if already in the desired state */
709   switch (vr->runtime.state)
710     {
711     case VRRP_VR_STATE_INIT:
712       if (!is_start)
713         {
714           clib_warning ("Attempting to stop already stopped VR (%U)",
715                         format_vrrp_vr_key, vr);
716           return 0;
717         }
718       break;
719     default:
720       if (is_start)
721         {
722           clib_warning ("Attempting to start already started VR (%U)",
723                         format_vrrp_vr_key, vr);
724           return 0;
725         }
726       break;
727     }
728
729   if (is_start)
730     {
731       if (vrrp_vr_is_unicast (vr) && vec_len (vr->config.peer_addrs) == 0)
732         {
733           clib_warning ("Cannot start unicast VR without peers");
734           return VNET_API_ERROR_INIT_FAILED;
735         }
736
737       vmp->n_vrs_started++;
738
739       if (!vrrp_intf_is_up (vr->config.sw_if_index, vrrp_vr_is_ipv6 (vr),
740                             NULL))
741         {
742           clib_warning ("VRRP VR started on down interface (%U)",
743                         format_vrrp_vr_key, vr);
744           vrrp_vr_transition (vr, VRRP_VR_STATE_INTF_DOWN, NULL);
745         }
746       else if (vrrp_vr_is_owner (vr))
747         vrrp_vr_transition (vr, VRRP_VR_STATE_MASTER, NULL);
748       else
749         vrrp_vr_transition (vr, VRRP_VR_STATE_BACKUP, NULL);
750     }
751   else
752     {
753       vmp->n_vrs_started--;
754
755       vrrp_vr_transition (vr, VRRP_VR_STATE_INIT, NULL);
756     }
757
758   clib_warning ("%d VRs configured, %d VRs running",
759                 pool_elts (vmp->vrs), vmp->n_vrs_started);
760
761   return 0;
762 }
763
764 static int
765 vrrp_vr_set_peers_validate (vrrp_vr_t * vr, ip46_address_t * peers)
766 {
767   if (!vrrp_vr_is_unicast (vr))
768     {
769       clib_warning ("Peers can only be set on a unicast VR");
770       return VNET_API_ERROR_INVALID_ARGUMENT;
771     }
772
773   if (vr->runtime.state != VRRP_VR_STATE_INIT)
774     {
775       clib_warning ("Cannot set peers on a running VR");
776       return VNET_API_ERROR_RSRC_IN_USE;
777     }
778
779   if (vec_len (peers) == 0)
780     {
781       clib_warning ("No peer addresses provided");
782       return VNET_API_ERROR_INVALID_DST_ADDRESS;
783     }
784
785   return 0;
786 }
787
788 int
789 vrrp_vr_set_peers (vrrp_vr_key_t * vr_key, ip46_address_t * peers)
790 {
791   vrrp_main_t *vmp = &vrrp_main;
792   uword *p;
793   vrrp_vr_t *vr = 0;
794   int ret = 0;
795
796   p = mhash_get (&vmp->vr_index_by_key, vr_key);
797   if (!p)
798     return VNET_API_ERROR_NO_SUCH_ENTRY;
799
800   vr = pool_elt_at_index (vmp->vrs, p[0]);
801
802   ret = vrrp_vr_set_peers_validate (vr, peers);
803   if (ret < 0)
804     return ret;
805
806   if (vr->config.peer_addrs)
807     vec_free (vr->config.peer_addrs);
808
809   vr->config.peer_addrs = vec_dup (peers);
810
811   return 0;
812 }
813
814 /* Manage reference on the interface to the VRs which track that interface */
815 static void
816 vrrp_intf_tracking_vr_add_del (u32 sw_if_index, vrrp_vr_t * vr, u8 is_add)
817 {
818   vrrp_intf_t *intf;
819   u32 vr_index;
820   u8 is_ipv6 = vrrp_vr_is_ipv6 (vr);
821   int i;
822
823   intf = vrrp_intf_get (sw_if_index);
824   vr_index = vrrp_vr_index (vr);
825
826   /* Try to find the VR index in the list of tracking VRs */
827   vec_foreach_index (i, intf->tracking_vrs[is_ipv6])
828   {
829     if (vec_elt (intf->tracking_vrs[is_ipv6], i) != vr_index)
830       continue;
831
832     /* Current index matches VR index */
833     if (!is_add)
834       vec_delete (intf->tracking_vrs[is_ipv6], 1, i);
835
836     /* If deleting, the job is done. If adding, it's already here */
837     return;
838   }
839
840   /* vr index was not found. */
841   if (is_add)
842     vec_add1 (intf->tracking_vrs[is_ipv6], vr_index);
843 }
844
845 /* Check if sw intf admin state is up or in the process of coming up */
846 static int
847 vrrp_intf_sw_admin_up (u32 sw_if_index, vrrp_intf_update_t * pending)
848 {
849   vnet_main_t *vnm = vnet_get_main ();
850   int admin_up;
851
852   if (pending && (pending->type == VRRP_IF_UPDATE_SW_ADMIN))
853     admin_up = pending->intf_up;
854   else
855     admin_up = vnet_sw_interface_is_admin_up (vnm, sw_if_index);
856
857   return admin_up;
858 }
859
860 /* Check if hw intf link state is up or int the process of coming up */
861 static int
862 vrrp_intf_hw_link_up (u32 sw_if_index, vrrp_intf_update_t * pending)
863 {
864   vnet_main_t *vnm = vnet_get_main ();
865   vnet_sw_interface_t *sup_sw;
866   int link_up;
867
868   sup_sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
869
870   if (pending && (pending->type == VRRP_IF_UPDATE_HW_LINK) &&
871       (pending->hw_if_index == sup_sw->hw_if_index))
872     link_up = pending->intf_up;
873   else
874     link_up = vnet_hw_interface_is_link_up (vnm, sup_sw->hw_if_index);
875
876   return link_up;
877 }
878
879 /* Check if interface has ability to send IP packets. */
880 static int
881 vrrp_intf_ip_up (u32 sw_if_index, u8 is_ipv6, vrrp_intf_update_t * pending)
882 {
883   int ip_up;
884
885   if (pending && pending->type == VRRP_IF_UPDATE_IP)
886     ip_up = pending->intf_up;
887   else
888     /* Either a unicast address has to be explicitly assigned, or
889      * for IPv6 only, a link local assigned and multicast/ND enabled
890      */
891     ip_up =
892       ((ip_interface_get_first_ip (sw_if_index, !is_ipv6) != 0) ||
893        (is_ipv6 && ip6_link_is_enabled (sw_if_index)));
894
895   return ip_up;
896 }
897
898 static int
899 vrrp_intf_is_up (u32 sw_if_index, u8 is_ipv6, vrrp_intf_update_t * pending)
900 {
901   int admin_up, link_up, ip_up;
902
903   admin_up = vrrp_intf_sw_admin_up (sw_if_index, pending);
904   link_up = vrrp_intf_hw_link_up (sw_if_index, pending);
905   ip_up = vrrp_intf_ip_up (sw_if_index, is_ipv6, pending);
906
907   return (admin_up && link_up && ip_up);
908 }
909
910 /* Examine the state of interfaces tracked by a VR and compute the priority
911  * adjustment that should be applied to the VR. If this is being called
912  * by the hw_link_up_down callback, the pending new flags on the sup hw
913  * interface have not been updated yet, so accept those as an optional
914  * argument.
915  */
916 void
917 vrrp_vr_tracking_ifs_compute (vrrp_vr_t * vr, vrrp_intf_update_t * pending)
918 {
919   vrrp_vr_tracking_if_t *intf;
920   u32 total_priority = 0;
921
922   vec_foreach (intf, vr->tracking.interfaces)
923   {
924     if (vrrp_intf_is_up (intf->sw_if_index, vrrp_vr_is_ipv6 (vr), pending))
925       continue;
926
927     total_priority += intf->priority;
928   }
929
930   if (total_priority != vr->tracking.interfaces_dec)
931     {
932       clib_warning ("VR %U interface track adjustment change from %u to %u",
933                     format_vrrp_vr_key, vr, vr->tracking.interfaces_dec,
934                     total_priority);
935       vr->tracking.interfaces_dec = total_priority;
936     }
937 }
938
939 /* Manage tracked interfaces on a VR */
940 int
941 vrrp_vr_tracking_if_add_del (vrrp_vr_t * vr, u32 sw_if_index, u8 prio,
942                              u8 is_add)
943 {
944   vnet_main_t *vnm = vnet_get_main ();
945   vrrp_vr_tracking_if_t *track_intf;
946
947   /* VR can't track non-existent interface */
948   if (!vnet_sw_interface_is_valid (vnm, sw_if_index))
949     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
950
951   /* VR can't track it's own interface */
952   if (sw_if_index == vr->config.sw_if_index)
953     return VNET_API_ERROR_INVALID_SW_IF_INDEX_2;
954
955   /* update intf vector of tracking VRs */
956   vrrp_intf_tracking_vr_add_del (sw_if_index, vr, is_add);
957
958   /* update VR vector of tracked interfaces */
959   vec_foreach (track_intf, vr->tracking.interfaces)
960   {
961     if (track_intf->sw_if_index != sw_if_index)
962       continue;
963
964     /* found it */
965     if (!is_add)
966       vec_delete
967         (vr->tracking.interfaces, 1, track_intf - vr->tracking.interfaces);
968
969     return 0;
970   }
971
972   if (is_add)
973     {
974       vec_add2 (vr->tracking.interfaces, track_intf, 1);
975
976       track_intf->sw_if_index = sw_if_index;
977       track_intf->priority = prio;
978     }
979
980   return 0;
981 }
982
983 int
984 vrrp_vr_tracking_ifs_add_del (vrrp_vr_t * vr,
985                               vrrp_vr_tracking_if_t * track_ifs, u8 is_add)
986 {
987   vrrp_vr_tracking_if_t *track_if, *ifs_copy;
988   int rv = 0;
989
990   /* if deleting & track_ifs points to the VR list of tracked intfs, the
991    * vector could be modified as we iterate it. make a copy instead */
992   ifs_copy = vec_dup (track_ifs);
993
994   /* add each tracked interface in the vector */
995   vec_foreach (track_if, ifs_copy)
996   {
997     rv = vrrp_vr_tracking_if_add_del (vr, track_if->sw_if_index,
998                                       track_if->priority, (is_add != 0));
999
1000     /* if operation failed, undo the previous changes */
1001     if (rv)
1002       {
1003         vrrp_vr_tracking_if_t *rb_if;
1004
1005         for (rb_if = track_if - 1; rb_if >= track_ifs; rb_if -= 1)
1006           vrrp_vr_tracking_if_add_del (vr, rb_if->sw_if_index,
1007                                        rb_if->priority, !(is_add != 0));
1008         break;
1009       }
1010   }
1011
1012   vec_free (ifs_copy);
1013
1014   vrrp_vr_tracking_ifs_compute (vr, 0);
1015
1016   return rv;
1017 }
1018
1019 /* Compute priority to advertise on all VRs which track the given interface
1020  * and address family. The flags on an HW interface are not updated until
1021  * after link up/down callbacks are invoked, so if this function is called
1022  * by the link up/down callback, the flags about to be set will be passed
1023  * via the 'pending' argument. Otherwise, pending will be NULL.
1024  */
1025 static void
1026 vrrp_intf_tracking_vrs_compute (u32 sw_if_index,
1027                                 vrrp_intf_update_t * pending, u8 is_ipv6)
1028 {
1029   u32 *vr_index;
1030   vrrp_vr_t *vr;
1031   vrrp_intf_t *intf = vrrp_intf_get (sw_if_index);
1032
1033   vec_foreach (vr_index, intf->tracking_vrs[is_ipv6])
1034   {
1035     vr = vrrp_vr_lookup_index (*vr_index);
1036     if (vr)
1037       vrrp_vr_tracking_ifs_compute (vr, pending);
1038   }
1039 }
1040
1041 /* Interface being brought up/down is a quasi-{startup/shutdown} event.
1042  * Execute an appropriate state transition for all VRs on the interface.
1043  * This function may be invoked by:
1044  *    sw interface admin up/down event
1045  *    hw interface link up/down event
1046  */
1047 clib_error_t *
1048 vrrp_sw_interface_up_down (vrrp_intf_update_t * pending)
1049 {
1050   vrrp_intf_t *intf;
1051   int i;
1052   u32 *vr_index;
1053   vrrp_vr_t *vr;
1054
1055   intf = vrrp_intf_get (pending->sw_if_index);
1056   if (!intf)
1057     return 0;
1058
1059   /* adjust state of VR's configured on this interface */
1060   for (i = 0; i < 2; i++)
1061     {
1062       int is_up;
1063
1064       if (!intf->vr_indices[i])
1065         continue;
1066
1067       is_up = vrrp_intf_is_up (pending->sw_if_index, i, pending);
1068
1069       vec_foreach (vr_index, intf->vr_indices[i])
1070       {
1071         vrrp_vr_state_t vr_state;
1072
1073         vr = vrrp_vr_lookup_index (*vr_index);
1074         if (!vr)
1075           continue;
1076
1077         if (vr->runtime.state == VRRP_VR_STATE_INIT)
1078           continue;             /* VR not started yet, no transition */
1079
1080         if (!is_up)
1081           vr_state = VRRP_VR_STATE_INTF_DOWN;
1082         else
1083           {
1084             if (vr->runtime.state != VRRP_VR_STATE_INTF_DOWN)
1085               continue;         /* shouldn't happen */
1086
1087             vr_state = (vrrp_vr_is_owner (vr)) ?
1088               VRRP_VR_STATE_MASTER : VRRP_VR_STATE_BACKUP;
1089           }
1090
1091         vrrp_vr_transition (vr, vr_state, NULL);
1092       }
1093     }
1094
1095   /* compute adjustments on any VR's tracking this interface */
1096   vrrp_intf_tracking_vrs_compute (pending->sw_if_index, pending,
1097                                   0 /* is_ipv6 */ );
1098   vrrp_intf_tracking_vrs_compute (pending->sw_if_index, pending,
1099                                   1 /* is_ipv6 */ );
1100
1101   return 0;
1102 }
1103
1104 /* Process change in admin status on an interface */
1105 clib_error_t *
1106 vrrp_sw_interface_admin_up_down (vnet_main_t * vnm, u32 sw_if_index,
1107                                  u32 flags)
1108 {
1109   vrrp_intf_update_t pending = {
1110     .type = VRRP_IF_UPDATE_SW_ADMIN,
1111     .sw_if_index = sw_if_index,
1112     .intf_up = ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0),
1113   };
1114
1115   return vrrp_sw_interface_up_down (&pending);
1116 }
1117
1118 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (vrrp_sw_interface_admin_up_down);
1119
1120 static walk_rc_t
1121 vrrp_hw_interface_link_up_down_walk (vnet_main_t * vnm,
1122                                      u32 sw_if_index, void *arg)
1123 {
1124   vrrp_intf_update_t *pending = arg;
1125
1126   pending->sw_if_index = sw_if_index;
1127   vrrp_sw_interface_up_down (pending);
1128
1129   return WALK_CONTINUE;
1130 }
1131
1132 static clib_error_t *
1133 vrrp_hw_interface_link_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
1134 {
1135   vrrp_intf_update_t pending = {
1136     .type = VRRP_IF_UPDATE_HW_LINK,
1137     .hw_if_index = hw_if_index,
1138     .intf_up = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) != 0),
1139   };
1140
1141   /* walk the sw interface and sub interfaces to adjust interface tracking */
1142   vnet_hw_interface_walk_sw (vnm, hw_if_index,
1143                              vrrp_hw_interface_link_up_down_walk, &pending);
1144
1145   return 0;
1146 }
1147
1148 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (vrrp_hw_interface_link_up_down);
1149
1150 static void
1151 vrrp_ip4_add_del_interface_addr (ip4_main_t * im,
1152                                  uword opaque,
1153                                  u32 sw_if_index,
1154                                  ip4_address_t * address,
1155                                  u32 address_length,
1156                                  u32 if_address_index, u32 is_del)
1157 {
1158   vrrp_intf_tracking_vrs_compute (sw_if_index, NULL, 0 /* is_ipv6 */ );
1159 }
1160
1161 static ip6_link_delegate_id_t vrrp_ip6_delegate_id;
1162
1163 static u8 *
1164 format_vrrp_ip6_link (u8 * s, va_list * args)
1165 {
1166   index_t indi = va_arg (*args, index_t);
1167   u32 indent = va_arg (*args, u32);
1168   vrrp_intf_t *intf;
1169   u32 *vr_index;
1170
1171   intf = vrrp_intf_get ((u32) indi);
1172
1173   s = format (s, "%UVRRP VRs monitoring this link:\n",
1174               format_white_space, indent);
1175
1176   vec_foreach (vr_index, intf->tracking_vrs[1])
1177   {
1178     vrrp_vr_t *vr = vrrp_vr_lookup_index (*vr_index);
1179
1180     s = format (s, "%U%U\n", format_white_space, indent + 2,
1181                 format_vrrp_vr_key, vr);
1182   }
1183
1184   return s;
1185 }
1186
1187 static void
1188 vrrp_intf_ip6_enable_disable (u32 sw_if_index, int enable)
1189 {
1190   vrrp_intf_update_t pending = {
1191     .type = VRRP_IF_UPDATE_IP,
1192     .sw_if_index = sw_if_index,
1193     .intf_up = enable,
1194   };
1195
1196   vrrp_intf_tracking_vrs_compute (sw_if_index, &pending, 1 /* is_ipv6 */ );
1197 }
1198
1199 static void
1200 vrrp_intf_ip6_enable (u32 sw_if_index)
1201 {
1202   vrrp_intf_ip6_enable_disable (sw_if_index, 1 /* enable */ );
1203   ip6_link_delegate_update (sw_if_index, vrrp_ip6_delegate_id, sw_if_index);
1204 }
1205
1206 static void
1207 vrrp_intf_ip6_disable (index_t indi)
1208 {
1209   vrrp_intf_ip6_enable_disable (indi, 0 /* enable */ );
1210 }
1211
1212 const static ip6_link_delegate_vft_t vrrp_ip6_delegate_vft = {
1213   .ildv_enable = vrrp_intf_ip6_enable,
1214   .ildv_disable = vrrp_intf_ip6_disable,
1215   .ildv_format = format_vrrp_ip6_link,
1216 };
1217
1218 static clib_error_t *
1219 vrrp_init (vlib_main_t * vm)
1220 {
1221   vrrp_main_t *vmp = &vrrp_main;
1222   clib_error_t *error = 0;
1223   ip4_main_t *im4 = &ip4_main;
1224   ip4_add_del_interface_address_callback_t cb4;
1225   vlib_node_t *intf_output_node;
1226
1227   clib_memset (vmp, 0, sizeof (*vmp));
1228
1229   if ((error = vlib_call_init_function (vm, ip4_lookup_init)) ||
1230       (error = vlib_call_init_function (vm, ip6_lookup_init)))
1231     return error;
1232
1233   vmp->vlib_main = vm;
1234   vmp->vnet_main = vnet_get_main ();
1235
1236   intf_output_node = vlib_get_node_by_name (vm, (u8 *) "interface-output");
1237   vmp->intf_output_node_idx = intf_output_node->index;
1238
1239   error = vrrp_plugin_api_hookup (vm);
1240
1241   if (error)
1242     return error;
1243
1244   mhash_init (&vmp->vr_index_by_key, sizeof (u32), sizeof (vrrp_vr_key_t));
1245   vmp->vrrp4_arp_lookup = hash_create (0, sizeof (uword));
1246   vmp->vrrp6_nd_lookup = hash_create_mem (0, sizeof (vrrp6_nd_key_t),
1247                                           sizeof (uword));
1248
1249   cb4.function = vrrp_ip4_add_del_interface_addr;
1250   cb4.function_opaque = 0;
1251   vec_add1 (im4->add_del_interface_address_callbacks, cb4);
1252
1253   vrrp_ip6_delegate_id = ip6_link_delegate_register (&vrrp_ip6_delegate_vft);
1254
1255   return error;
1256 }
1257
1258 VLIB_INIT_FUNCTION (vrrp_init);
1259
1260
1261 /* *INDENT-OFF* */
1262 VLIB_PLUGIN_REGISTER () =
1263 {
1264   .version = VPP_BUILD_VER,
1265   .description = "VRRP v3 (RFC 5798)",
1266 };
1267 /* *INDENT-ON* */
1268
1269 /*
1270  * fd.io coding-style-patch-verification: ON
1271  *
1272  * Local Variables:
1273  * eval: (c-set-style "gnu")
1274  * End:
1275  */