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);
217 sw_if_index = htonl (mp->sw_if_index);
220 pool_foreach (vr, vmp->vrs, ({
222 if (sw_if_index && (sw_if_index != ~0) &&
223 (sw_if_index != vr->config.sw_if_index))
226 send_vrrp_vr_details (vr, reg, mp->context);
232 vl_api_vrrp_vr_start_stop_t_handler (vl_api_vrrp_vr_start_stop_t * mp)
234 vrrp_main_t *vmp = &vrrp_main;
235 vl_api_vrrp_vr_start_stop_reply_t *rmp;
236 vrrp_vr_key_t vr_key;
239 clib_memset (&vr_key, 0, sizeof (vr_key));
241 vr_key.sw_if_index = ntohl (mp->sw_if_index);
242 vr_key.vr_id = mp->vr_id;
243 vr_key.is_ipv6 = (mp->is_ipv6 != 0);
245 rv = vrrp_vr_start_stop ((mp->is_start != 0), &vr_key);
247 REPLY_MACRO (VL_API_VRRP_VR_START_STOP_REPLY);
251 vl_api_vrrp_vr_set_peers_t_handler (vl_api_vrrp_vr_set_peers_t * mp)
253 vrrp_main_t *vmp = &vrrp_main;
254 vl_api_vrrp_vr_set_peers_reply_t *rmp;
255 vrrp_vr_key_t vr_key;
256 ip46_address_t *peer_addrs = 0;
260 clib_memset (&vr_key, 0, sizeof (vr_key));
262 vr_key.sw_if_index = ntohl (mp->sw_if_index);
263 vr_key.vr_id = mp->vr_id;
264 vr_key.is_ipv6 = (mp->is_ipv6 != 0);
266 for (i = 0; i < mp->n_addrs; i++)
268 ip46_address_t *peer;
270 vec_add2 (peer_addrs, peer, 1);
273 clib_memcpy (&peer->ip6, mp->addrs[i].un.ip6, 16);
275 clib_memcpy (&peer->ip4, mp->addrs[i].un.ip4, 4);
278 rv = vrrp_vr_set_peers (&vr_key, peer_addrs);
280 vec_free (peer_addrs);
281 REPLY_MACRO (VL_API_VRRP_VR_SET_PEERS_REPLY);
285 send_vrrp_vr_peer_details (vrrp_vr_t * vr, vl_api_registration_t * reg,
288 vrrp_main_t *vmp = &vrrp_main;
289 vl_api_vrrp_vr_peer_details_t *mp;
290 int n_addrs, msg_size;
291 ip46_address_t *addr;
292 vl_api_address_t *api_addr;
294 n_addrs = vec_len (vr->config.peer_addrs);
295 msg_size = sizeof (*mp) + n_addrs * sizeof (*api_addr);
296 mp = vl_msg_api_alloc (msg_size);
299 clib_memset (mp, 0, msg_size);
300 mp->_vl_msg_id = htons (VL_API_VRRP_VR_PEER_DETAILS + vmp->msg_id_base);
301 mp->context = context;
303 mp->sw_if_index = htonl (vr->config.sw_if_index);
304 mp->vr_id = vr->config.vr_id;
305 mp->is_ipv6 = vrrp_vr_is_ipv6 (vr);
308 mp->n_peer_addrs = n_addrs;
309 api_addr = mp->peer_addrs;
310 vec_foreach (addr, vr->config.peer_addrs)
315 if (vrrp_vr_is_ipv6 (vr))
317 api_addr->af = htonl (ADDRESS_IP6);
318 dst = &api_addr->un.ip6;
320 len = sizeof (addr->ip6);
324 api_addr->af = htonl (ADDRESS_IP4);
325 dst = &api_addr->un.ip4;
327 len = sizeof (addr->ip4);
329 clib_memcpy (dst, src, len);
333 vl_api_send_msg (reg, (u8 *) mp);
337 vl_api_vrrp_vr_peer_dump_t_handler (vl_api_vrrp_vr_peer_dump_t * mp)
339 vrrp_main_t *vmp = &vrrp_main;
340 vl_api_registration_t *reg;
342 vrrp_vr_key_t vr_key;
344 reg = vl_api_client_index_to_registration (mp->client_index);
348 vr_key.sw_if_index = ntohl (mp->sw_if_index);
350 if (vr_key.sw_if_index && (vr_key.sw_if_index != ~0))
355 vr_key.vr_id = mp->vr_id;
356 vr_key.is_ipv6 = mp->is_ipv6;
358 p = mhash_get (&vmp->vr_index_by_key, &vr_key);
363 vr = pool_elt_at_index (vmp->vrs, vr_index);
364 send_vrrp_vr_peer_details (vr, reg, mp->context);
370 pool_foreach (vr, vmp->vrs, ({
372 if (!vec_len (vr->config.peer_addrs))
375 send_vrrp_vr_details (vr, reg, mp->context);
382 vl_api_vrrp_vr_track_if_add_del_t_handler
383 (vl_api_vrrp_vr_track_if_add_del_t * mp)
385 vrrp_main_t *vmp = &vrrp_main;
386 vl_api_vrrp_vr_track_if_add_del_reply_t *rmp;
388 vrrp_vr_tracking_if_t *track_if, *track_ifs = 0;
391 /* lookup VR and return error if it does not exist */
393 vrrp_vr_lookup (ntohl (mp->sw_if_index), mp->vr_id, (mp->is_ipv6 != 0));
396 rv = VNET_API_ERROR_INVALID_VALUE;
400 for (i = 0; i < mp->n_ifs; i++)
402 vl_api_vrrp_vr_track_if_t *api_track_if = &mp->ifs[i];
404 vec_add2 (track_ifs, track_if, 1);
405 track_if->sw_if_index = ntohl (api_track_if->sw_if_index);
406 track_if->priority = api_track_if->priority;
409 rv = vrrp_vr_tracking_ifs_add_del (vr, track_ifs, mp->is_add != 0);
412 vec_free (track_ifs);
413 REPLY_MACRO (VL_API_VRRP_VR_TRACK_IF_ADD_DEL_REPLY);
417 send_vrrp_vr_track_if_details (vrrp_vr_t * vr, vl_api_registration_t * reg,
420 vrrp_main_t *vmp = &vrrp_main;
421 vl_api_vrrp_vr_track_if_details_t *mp;
423 vl_api_vrrp_vr_track_if_t *api_track_if;
424 vrrp_vr_tracking_if_t *track_if;
429 n_ifs = vec_len (vr->tracking.interfaces);
430 msg_size = sizeof (*mp) + n_ifs * sizeof (*api_track_if);
431 mp = vl_msg_api_alloc (msg_size);
434 clib_memset (mp, 0, msg_size);
435 mp->_vl_msg_id = htons (VL_API_VRRP_VR_TRACK_IF_DETAILS + vmp->msg_id_base);
436 mp->context = context;
438 mp->sw_if_index = htonl (vr->config.sw_if_index);
439 mp->vr_id = vr->config.vr_id;
440 mp->is_ipv6 = vrrp_vr_is_ipv6 (vr);
442 /* tracked interfaces */
444 api_track_if = mp->ifs;
445 vec_foreach (track_if, vr->tracking.interfaces)
447 api_track_if->sw_if_index = htonl (track_if->sw_if_index);
448 api_track_if->priority = track_if->priority;
452 vl_api_send_msg (reg, (u8 *) mp);
456 vl_api_vrrp_vr_track_if_dump_t_handler (vl_api_vrrp_vr_track_if_dump_t * mp)
458 vrrp_main_t *vmp = &vrrp_main;
459 vl_api_registration_t *reg;
462 reg = vl_api_client_index_to_registration (mp->client_index);
468 vr = vrrp_vr_lookup (ntohl (mp->sw_if_index), mp->vr_id, mp->is_ipv6);
469 send_vrrp_vr_track_if_details (vr, reg, mp->context);
475 pool_foreach (vr, vmp->vrs, ({
477 if (!vec_len (vr->tracking.interfaces))
480 send_vrrp_vr_track_if_details (vr, reg, mp->context);
486 /* Set up the API message handling tables */
487 #include <vrrp/vrrp.api.c>
489 vrrp_plugin_api_hookup (vlib_main_t * vm)
491 vrrp_main_t *vmp = &vrrp_main;
493 /* Ask for a correctly-sized block of API message decode slots */
494 vmp->msg_id_base = setup_message_id_table ();
502 * fd.io coding-style-patch-verification: ON
505 * eval: (c-set-style "gnu")