2 * vrrp.c - vpp vrrp plug-in
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 <vrrp/vrrp.h>
14 #include <vlibapi/api.h>
15 #include <vlibmemory/api.h>
16 #include <vpp/app/version.h>
18 /* define message IDs */
19 #include <vnet/format_fns.h>
20 #include <vrrp/vrrp.api_enum.h>
21 #include <vrrp/vrrp.api_types.h>
23 #define REPLY_MSG_ID_BASE vmp->msg_id_base
24 #include <vlibapi/api_helper_macros.h>
26 /* API message handlers */
28 vl_api_vrrp_vr_add_del_t_handler (vl_api_vrrp_vr_add_del_t * mp)
30 vrrp_main_t *vmp = &vrrp_main;
31 vl_api_vrrp_vr_add_del_reply_t *rmp;
32 vrrp_vr_config_t vr_conf;
34 ip46_address_t *addrs = 0;
37 api_flags = htonl (mp->flags);
39 clib_memset (&vr_conf, 0, sizeof (vr_conf));
41 vr_conf.sw_if_index = ntohl (mp->sw_if_index);
42 vr_conf.vr_id = mp->vr_id;
43 vr_conf.priority = mp->priority;
44 vr_conf.adv_interval = ntohs (mp->interval);
46 if (api_flags & VRRP_API_VR_PREEMPT)
47 vr_conf.flags |= VRRP_VR_PREEMPT;
49 if (api_flags & VRRP_API_VR_ACCEPT)
50 vr_conf.flags |= VRRP_VR_ACCEPT;
52 if (api_flags & VRRP_API_VR_UNICAST)
53 vr_conf.flags |= VRRP_VR_UNICAST;
55 if (api_flags & VRRP_API_VR_IPV6)
56 vr_conf.flags |= VRRP_VR_IPV6;
62 for (i = 0; i < mp->n_addrs; i++)
68 vec_add2 (addrs, addr, 1);
70 if (ntohl (mp->addrs[i].af) == ADDRESS_IP4)
72 src = &mp->addrs[i].un.ip4;
74 len = sizeof (addr->ip4);
78 src = &mp->addrs[i].un.ip6;
80 len = sizeof (addr->ip6);
83 clib_memcpy (dst, src, len);
86 vr_conf.vr_addrs = addrs;
89 if (vr_conf.priority == 0)
91 clib_warning ("VR priority must be > 0");
92 rv = VNET_API_ERROR_INVALID_VALUE;
94 else if (vr_conf.adv_interval == 0)
96 clib_warning ("VR advertisement interval must be > 0");
97 rv = VNET_API_ERROR_INVALID_VALUE;
99 else if (vr_conf.vr_id == 0)
101 clib_warning ("VR ID must be > 0");
102 rv = VNET_API_ERROR_INVALID_VALUE;
105 rv = vrrp_vr_add_del (mp->is_add, &vr_conf);
109 REPLY_MACRO (VL_API_VRRP_VR_ADD_DEL_REPLY);
113 send_vrrp_vr_details (vrrp_vr_t * vr, vl_api_registration_t * reg,
116 vrrp_main_t *vmp = &vrrp_main;
117 vl_api_vrrp_vr_details_t *mp;
118 int n_addrs, msg_size;
119 ip46_address_t *addr;
120 vl_api_address_t *api_addr;
123 n_addrs = vec_len (vr->config.vr_addrs);
124 msg_size = sizeof (*mp) + n_addrs * sizeof (*api_addr);
125 mp = vl_msg_api_alloc (msg_size);
128 clib_memset (mp, 0, msg_size);
129 mp->_vl_msg_id = htons (VL_API_VRRP_VR_DETAILS + vmp->msg_id_base);
130 mp->context = context;
133 mp->config.sw_if_index = htonl (vr->config.sw_if_index);
134 mp->config.vr_id = vr->config.vr_id;
135 mp->config.priority = vr->config.priority;
136 mp->config.interval = htons (vr->config.adv_interval);
138 if (vr->config.flags & VRRP_VR_PREEMPT)
139 api_flags |= VRRP_API_VR_PREEMPT;
140 if (vr->config.flags & VRRP_VR_ACCEPT)
141 api_flags |= VRRP_API_VR_ACCEPT;
142 if (vrrp_vr_is_unicast (vr))
143 api_flags |= VRRP_API_VR_UNICAST;
144 if (vrrp_vr_is_ipv6 (vr))
145 api_flags |= VRRP_API_VR_IPV6;
147 mp->config.flags = htonl (api_flags);
150 switch (vr->runtime.state)
152 case VRRP_VR_STATE_INIT:
153 mp->runtime.state = htonl (VRRP_API_VR_STATE_INIT);
155 case VRRP_VR_STATE_BACKUP:
156 mp->runtime.state = htonl (VRRP_API_VR_STATE_BACKUP);
158 case VRRP_VR_STATE_MASTER:
159 mp->runtime.state = htonl (VRRP_API_VR_STATE_MASTER);
161 case VRRP_VR_STATE_INTF_DOWN:
162 mp->runtime.state = htonl (VRRP_API_VR_STATE_INTF_DOWN);
168 mp->runtime.master_adv_int = htons (vr->runtime.master_adv_int);
169 mp->runtime.skew = htons (vr->runtime.skew);
170 mp->runtime.master_down_int = htons (vr->runtime.master_down_int);
171 clib_memcpy (&mp->runtime.mac, &vr->runtime.mac, sizeof (vr->runtime.mac));
173 mp->runtime.tracking.interfaces_dec = htonl (vr->tracking.interfaces_dec);
174 mp->runtime.tracking.priority = vrrp_vr_priority (vr);
177 mp->n_addrs = vec_len (vr->config.vr_addrs);
178 api_addr = mp->addrs;
179 vec_foreach (addr, vr->config.vr_addrs)
184 if (vrrp_vr_is_ipv6 (vr))
186 api_addr->af = htonl (ADDRESS_IP6);
187 dst = &api_addr->un.ip6;
189 len = sizeof (addr->ip6);
193 api_addr->af = htonl (ADDRESS_IP4);
194 dst = &api_addr->un.ip4;
196 len = sizeof (addr->ip4);
198 clib_memcpy (dst, src, len);
202 vl_api_send_msg (reg, (u8 *) mp);
206 vl_api_vrrp_vr_dump_t_handler (vl_api_vrrp_vr_dump_t * mp)
208 vrrp_main_t *vmp = &vrrp_main;
209 vl_api_registration_t *reg;
213 reg = vl_api_client_index_to_registration (mp->client_index);
215 sw_if_index = htonl (mp->sw_if_index);
218 pool_foreach (vr, vmp->vrs, ({
220 if (sw_if_index && (sw_if_index != ~0) &&
221 (sw_if_index != vr->config.sw_if_index))
224 send_vrrp_vr_details (vr, reg, mp->context);
230 vl_api_vrrp_vr_start_stop_t_handler (vl_api_vrrp_vr_start_stop_t * mp)
232 vrrp_main_t *vmp = &vrrp_main;
233 vl_api_vrrp_vr_start_stop_reply_t *rmp;
234 vrrp_vr_key_t vr_key;
237 clib_memset (&vr_key, 0, sizeof (vr_key));
239 vr_key.sw_if_index = ntohl (mp->sw_if_index);
240 vr_key.vr_id = mp->vr_id;
241 vr_key.is_ipv6 = (mp->is_ipv6 != 0);
243 rv = vrrp_vr_start_stop ((mp->is_start != 0), &vr_key);
245 REPLY_MACRO (VL_API_VRRP_VR_START_STOP_REPLY);
249 vl_api_vrrp_vr_set_peers_t_handler (vl_api_vrrp_vr_set_peers_t * mp)
251 vrrp_main_t *vmp = &vrrp_main;
252 vl_api_vrrp_vr_set_peers_reply_t *rmp;
253 vrrp_vr_key_t vr_key;
254 ip46_address_t *peer_addrs = 0;
258 clib_memset (&vr_key, 0, sizeof (vr_key));
260 vr_key.sw_if_index = ntohl (mp->sw_if_index);
261 vr_key.vr_id = mp->vr_id;
262 vr_key.is_ipv6 = (mp->is_ipv6 != 0);
264 for (i = 0; i < mp->n_addrs; i++)
266 ip46_address_t *peer;
268 vec_add2 (peer_addrs, peer, 1);
271 clib_memcpy (&peer->ip6, mp->addrs[i].un.ip6, 16);
273 clib_memcpy (&peer->ip4, mp->addrs[i].un.ip4, 4);
276 rv = vrrp_vr_set_peers (&vr_key, peer_addrs);
278 vec_free (peer_addrs);
279 REPLY_MACRO (VL_API_VRRP_VR_SET_PEERS_REPLY);
283 send_vrrp_vr_peer_details (vrrp_vr_t * vr, vl_api_registration_t * reg,
286 vrrp_main_t *vmp = &vrrp_main;
287 vl_api_vrrp_vr_peer_details_t *mp;
288 int n_addrs, msg_size;
289 ip46_address_t *addr;
290 vl_api_address_t *api_addr;
292 n_addrs = vec_len (vr->config.peer_addrs);
293 msg_size = sizeof (*mp) + n_addrs * sizeof (*api_addr);
294 mp = vl_msg_api_alloc (msg_size);
297 clib_memset (mp, 0, msg_size);
298 mp->_vl_msg_id = htons (VL_API_VRRP_VR_PEER_DETAILS + vmp->msg_id_base);
299 mp->context = context;
301 mp->sw_if_index = htonl (vr->config.sw_if_index);
302 mp->vr_id = vr->config.vr_id;
303 mp->is_ipv6 = vrrp_vr_is_ipv6 (vr);
306 mp->n_peer_addrs = n_addrs;
307 api_addr = mp->peer_addrs;
308 vec_foreach (addr, vr->config.peer_addrs)
313 if (vrrp_vr_is_ipv6 (vr))
315 api_addr->af = htonl (ADDRESS_IP6);
316 dst = &api_addr->un.ip6;
318 len = sizeof (addr->ip6);
322 api_addr->af = htonl (ADDRESS_IP4);
323 dst = &api_addr->un.ip4;
325 len = sizeof (addr->ip4);
327 clib_memcpy (dst, src, len);
331 vl_api_send_msg (reg, (u8 *) mp);
335 vl_api_vrrp_vr_peer_dump_t_handler (vl_api_vrrp_vr_peer_dump_t * mp)
337 vrrp_main_t *vmp = &vrrp_main;
338 vl_api_registration_t *reg;
340 vrrp_vr_key_t vr_key;
342 reg = vl_api_client_index_to_registration (mp->client_index);
344 vr_key.sw_if_index = ntohl (mp->sw_if_index);
346 if (vr_key.sw_if_index && (vr_key.sw_if_index != ~0))
351 vr_key.vr_id = mp->vr_id;
352 vr_key.is_ipv6 = mp->is_ipv6;
354 p = mhash_get (&vmp->vr_index_by_key, &vr_key);
359 vr = pool_elt_at_index (vmp->vrs, vr_index);
360 send_vrrp_vr_peer_details (vr, reg, mp->context);
366 pool_foreach (vr, vmp->vrs, ({
368 if (!vec_len (vr->config.peer_addrs))
371 send_vrrp_vr_details (vr, reg, mp->context);
378 vl_api_vrrp_vr_track_if_add_del_t_handler
379 (vl_api_vrrp_vr_track_if_add_del_t * mp)
381 vrrp_main_t *vmp = &vrrp_main;
382 vl_api_vrrp_vr_track_if_add_del_reply_t *rmp;
384 vrrp_vr_tracking_if_t *track_if, *track_ifs = 0;
387 /* lookup VR and return error if it does not exist */
389 vrrp_vr_lookup (ntohl (mp->sw_if_index), mp->vr_id, (mp->is_ipv6 != 0));
392 rv = VNET_API_ERROR_INVALID_VALUE;
396 for (i = 0; i < mp->n_ifs; i++)
398 vl_api_vrrp_vr_track_if_t *api_track_if = &mp->ifs[i];
400 vec_add2 (track_ifs, track_if, 1);
401 track_if->sw_if_index = ntohl (api_track_if->sw_if_index);
402 track_if->priority = api_track_if->priority;
405 rv = vrrp_vr_tracking_ifs_add_del (vr, track_ifs, mp->is_add != 0);
408 vec_free (track_ifs);
409 REPLY_MACRO (VL_API_VRRP_VR_TRACK_IF_ADD_DEL_REPLY);
413 send_vrrp_vr_track_if_details (vrrp_vr_t * vr, vl_api_registration_t * reg,
416 vrrp_main_t *vmp = &vrrp_main;
417 vl_api_vrrp_vr_track_if_details_t *mp;
419 vl_api_vrrp_vr_track_if_t *api_track_if;
420 vrrp_vr_tracking_if_t *track_if;
425 n_ifs = vec_len (vr->tracking.interfaces);
426 msg_size = sizeof (*mp) + n_ifs * sizeof (*api_track_if);
427 mp = vl_msg_api_alloc (msg_size);
430 clib_memset (mp, 0, msg_size);
431 mp->_vl_msg_id = htons (VL_API_VRRP_VR_TRACK_IF_DETAILS + vmp->msg_id_base);
432 mp->context = context;
434 mp->sw_if_index = htonl (vr->config.sw_if_index);
435 mp->vr_id = vr->config.vr_id;
436 mp->is_ipv6 = vrrp_vr_is_ipv6 (vr);
438 /* tracked interfaces */
440 api_track_if = mp->ifs;
441 vec_foreach (track_if, vr->tracking.interfaces)
443 api_track_if->sw_if_index = htonl (track_if->sw_if_index);
444 api_track_if->priority = track_if->priority;
448 vl_api_send_msg (reg, (u8 *) mp);
452 vl_api_vrrp_vr_track_if_dump_t_handler (vl_api_vrrp_vr_track_if_dump_t * mp)
454 vrrp_main_t *vmp = &vrrp_main;
455 vl_api_registration_t *reg;
458 reg = vl_api_client_index_to_registration (mp->client_index);
462 vr = vrrp_vr_lookup (ntohl (mp->sw_if_index), mp->vr_id, mp->is_ipv6);
463 send_vrrp_vr_track_if_details (vr, reg, mp->context);
469 pool_foreach (vr, vmp->vrs, ({
471 if (!vec_len (vr->tracking.interfaces))
474 send_vrrp_vr_track_if_details (vr, reg, mp->context);
480 /* Set up the API message handling tables */
481 #include <vrrp/vrrp.api.c>
483 vrrp_plugin_api_hookup (vlib_main_t * vm)
485 vrrp_main_t *vmp = &vrrp_main;
487 /* Ask for a correctly-sized block of API message decode slots */
488 vmp->msg_id_base = setup_message_id_table ();
496 * fd.io coding-style-patch-verification: ON
499 * eval: (c-set-style "gnu")