2 * vrrp.c - VRRP vpp-api-test plug-in
4 * Copyright 2019-2020 Rubicon Communications, LLC (Netgate)
6 * SPDX-License-Identifier: Apache-2.0
10 #include <vlibapi/api.h>
11 #include <vlibmemory/api.h>
12 #include <vppinfra/error.h>
14 #include <vnet/ip/ip.h>
16 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
18 /* Declare message IDs */
19 #include <vnet/format_fns.h>
20 #include <vrrp/vrrp.api_enum.h>
21 #include <vrrp/vrrp.api_types.h>
22 #include <vpp/api/vpe.api_types.h>
27 /* API message ID base */
33 vrrp_test_main_t vrrp_test_main;
35 #define __plugin_msg_base vrrp_test_main.msg_id_base
36 #include <vlibapi/vat_helper_macros.h>
39 api_vrrp_vr_add_del (vat_main_t * vam)
41 unformat_input_t *i = vam->input;
43 u32 vr_id, priority, interval;
44 u8 is_ipv6, no_preempt, accept_mode, vr_unicast, is_add, is_del;
45 u8 n_addrs4, n_addrs6;
46 vl_api_vrrp_vr_add_del_t *mp;
47 vl_api_address_t *api_addr;
48 ip46_address_t *ip_addr, *ip_addrs = 0;
52 interval = priority = 100;
53 n_addrs4 = n_addrs6 = 0;
54 vr_id = is_ipv6 = no_preempt = accept_mode = vr_unicast = 0;
57 clib_memset (&addr, 0, sizeof (addr));
59 /* Parse args required to build the message */
60 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
62 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
64 else if (unformat (i, "sw_if_index %u", &sw_if_index))
66 else if (unformat (i, "vr_id %u", &vr_id))
68 else if (unformat (i, "ipv6"))
70 else if (unformat (i, "priority %u", &priority))
72 else if (unformat (i, "interval %u", &interval))
74 else if (unformat (i, "no_preempt"))
76 else if (unformat (i, "accept_mode"))
78 else if (unformat (i, "unicast"))
80 else if (unformat (i, "%U", unformat_ip4_address, &addr.ip4))
82 vec_add1 (ip_addrs, addr);
84 clib_memset (&addr, 0, sizeof (addr));
86 else if (unformat (i, "%U", unformat_ip6_address, &addr.ip6))
88 vec_add1 (ip_addrs, addr);
90 clib_memset (&addr, 0, sizeof (addr));
92 else if (unformat (i, "add"))
94 else if (unformat (i, "del"))
100 if (is_add == is_del)
102 errmsg ("One of add or del must be specified\n");
105 else if (sw_if_index == ~0)
107 errmsg ("Interface not set\n");
110 else if (n_addrs4 && (n_addrs6 || is_ipv6))
112 errmsg ("Address family mismatch\n");
119 /* Construct the API message */
120 M2 (VRRP_VR_ADD_DEL, mp, vec_len (ip_addrs) * sizeof (*api_addr));
123 mp->sw_if_index = ntohl (sw_if_index);
125 mp->priority = priority;
126 mp->interval = htons (interval);
127 mp->flags = VRRP_API_VR_PREEMPT; /* preempt by default */
130 mp->flags &= ~VRRP_API_VR_PREEMPT;
133 mp->flags |= VRRP_API_VR_ACCEPT;
136 mp->flags |= VRRP_API_VR_UNICAST;
139 mp->flags |= VRRP_API_VR_IPV6;
141 mp->flags = htonl (mp->flags);
143 mp->n_addrs = n_addrs4 + n_addrs6;
144 api_addr = mp->addrs;
146 vec_foreach (ip_addr, ip_addrs)
153 api_addr->af = ADDRESS_IP6;
155 dst = &api_addr->un.ip6;
156 len = sizeof (api_addr->un.ip6);
160 api_addr->af = ADDRESS_IP4;
162 dst = &api_addr->un.ip4;
163 len = sizeof (api_addr->un.ip4);
165 clib_memcpy (dst, src, len);
172 /* Wait for a reply... */
182 api_vrrp_vr_dump (vat_main_t * vam)
184 vrrp_test_main_t *vtm = &vrrp_test_main;
185 unformat_input_t *i = vam->input;
186 vl_api_vrrp_vr_dump_t *mp;
187 vl_api_control_ping_t *mp_ping;
188 u32 sw_if_index = ~0;
191 if (vam->json_output)
193 clib_warning ("JSON output not supported for vrrp_vr_dump");
197 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
199 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
201 else if (unformat (i, "sw_if_index %u", &sw_if_index))
207 M (VRRP_VR_DUMP, mp);
209 mp->sw_if_index = htonl (sw_if_index);
213 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
214 mp_ping->_vl_msg_id = htons (vtm->ping_id);
215 mp_ping->client_index = vam->my_client_index;
217 vam->result_ready = 0;
225 vl_api_vrrp_vr_details_t_handler (vl_api_vrrp_vr_details_t * mp)
227 vat_main_t *vam = vrrp_test_main.vat_main;
228 u32 api_flags = ntohl (mp->config.flags);
232 "VRRP_API_VR_STATE_INIT",
233 "VRRP_API_VR_STATE_BACKUP",
234 "VRRP_API_VR_STATE_MASTER",
238 state = ntohl (mp->runtime.state);
240 if (state > ARRAY_LEN (states) - 2)
241 state = ARRAY_LEN (states) - 1;
243 fformat (vam->ofp, "sw_if_index %u vr_id %u IPv%d: "
244 "priority %u interval %u preempt %s accept %s unicast %s "
245 "state %s master_adv_interval %u skew %u master_down_interval %u "
247 ntohl (mp->config.sw_if_index), mp->config.vr_id,
248 (mp->config.flags & VRRP_API_VR_IPV6) ? 6 : 4,
249 mp->config.priority, htons (mp->config.interval),
250 (api_flags & VRRP_API_VR_PREEMPT) ? "yes" : "no",
251 (api_flags & VRRP_API_VR_ACCEPT) ? "yes" : "no",
252 (api_flags & VRRP_API_VR_UNICAST) ? "yes" : "no",
254 ntohs (mp->runtime.master_adv_int), ntohs (mp->runtime.skew),
255 ntohs (mp->runtime.master_down_int),
256 format_ethernet_address, &mp->runtime.mac);
258 fformat (vam->ofp, "addresses: ");
260 for (i = 0; i < mp->n_addrs; i++)
262 vl_api_address_t *addr = mp->addrs + i;
264 fformat (vam->ofp, "%U ",
265 (addr->af) ? format_ip6_address : format_ip4_address,
269 fformat (vam->ofp, "\n");
273 api_vrrp_vr_start_stop (vat_main_t * vam)
275 unformat_input_t *i = vam->input;
276 vl_api_vrrp_vr_start_stop_t *mp;
277 u32 sw_if_index = ~0, vr_id;
278 u8 is_ipv6, is_start, is_stop;
281 vr_id = is_ipv6 = is_start = is_stop = 0;
283 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
285 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
287 else if (unformat (i, "sw_if_index %u", &sw_if_index))
289 else if (unformat (i, "vr_id %u", &vr_id))
291 else if (unformat (i, "ipv6"))
293 else if (unformat (i, "start"))
295 else if (unformat (i, "stop"))
301 if (is_start == is_stop)
303 errmsg ("One of add or del must be specified\n");
306 else if (sw_if_index == ~0)
308 errmsg ("Interface not set\n");
313 errmsg ("VR ID must be between 1 and 255");
317 M (VRRP_VR_START_STOP, mp);
319 mp->sw_if_index = htonl (sw_if_index);
321 mp->is_ipv6 = (is_ipv6 != 0);
322 mp->is_start = (is_start != 0);
331 api_vrrp_vr_track_if_add_del (vat_main_t * vam)
333 unformat_input_t *i = vam->input;
334 vl_api_vrrp_vr_track_if_add_del_t *mp;
335 vl_api_vrrp_vr_track_if_t *track_ifs = 0, *track_if;
336 u32 sw_if_index = ~0, track_sw_if_index = ~0, vr_id, priority;
337 u8 is_ipv6, is_add, is_del;
340 is_ipv6 = is_add = is_del = 0;
341 vr_id = priority = 0;
343 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
345 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
347 else if (unformat (i, "sw_if_index %u", &sw_if_index))
349 else if (unformat (i, "vr_id %u", &vr_id))
351 else if (unformat (i, "ipv6"))
353 else if (unformat (i, "track-index %u priority %u", &track_sw_if_index,
356 vec_add2 (track_ifs, track_if, 1);
357 track_if->sw_if_index = ntohl (track_sw_if_index);
358 track_if->priority = priority;
360 else if (unformat (i, "add"))
362 else if (unformat (i, "del"))
368 if (is_add == is_del)
370 errmsg ("One of add or del must be specified\n");
373 else if (sw_if_index == ~0)
375 errmsg ("VR interface not specified\n");
380 errmsg ("Invalid VR ID - must be between 1 and 255");
383 else if (vec_len (track_ifs) == 0)
385 errmsg ("No tracked interfaces specified for VR\n");
389 vec_foreach (track_if, track_ifs)
391 if (!track_if->priority)
393 errmsg ("Priority must be nonzero");
394 vec_free (track_ifs);
400 M2 (VRRP_VR_TRACK_IF_ADD_DEL, mp, vec_len (track_ifs) * sizeof (*track_if));
402 mp->sw_if_index = htonl (sw_if_index);
404 mp->is_ipv6 = (is_ipv6 != 0);
406 mp->n_ifs = vec_len (track_ifs);
407 clib_memcpy (mp->ifs, track_ifs, mp->n_ifs * sizeof (*track_if));
416 api_vrrp_vr_track_if_dump (vat_main_t * vam)
418 vrrp_test_main_t *vtm = &vrrp_test_main;
419 unformat_input_t *i = vam->input;
420 vl_api_vrrp_vr_track_if_dump_t *mp;
421 vl_api_control_ping_t *mp_ping;
422 u32 sw_if_index = ~0, vr_id = 0;
423 u8 is_ipv6 = 0, dump_all = 0;
426 if (vam->json_output)
428 clib_warning ("JSON output not supported for vrrp_vr_track_if_dump");
432 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
434 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
436 else if (unformat (i, "sw_if_index %u", &sw_if_index))
438 else if (unformat (i, "vr_id %u", &vr_id))
440 else if (unformat (i, "ipv6"))
446 /* If no arguments were provided, dump all VRs */
447 if ((sw_if_index == ~0) && !vr_id && !is_ipv6)
450 /* If any arguments provided, sw_if_index and vr_id must be valid */
451 else if (sw_if_index == ~0)
453 errmsg ("VR interface not specified\n");
458 errmsg ("Invalid VR ID - must be between 1 and 255");
462 M (VRRP_VR_TRACK_IF_DUMP, mp);
464 mp->dump_all = dump_all;
467 mp->sw_if_index = htonl (sw_if_index);
469 mp->is_ipv6 = is_ipv6;
474 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
475 mp_ping->_vl_msg_id = htons (vtm->ping_id);
476 mp_ping->client_index = vam->my_client_index;
478 vam->result_ready = 0;
486 vl_api_vrrp_vr_track_if_details_t_handler
487 (vl_api_vrrp_vr_track_if_details_t * mp)
489 vat_main_t *vam = vrrp_test_main.vat_main;
492 for (i = 0; i < mp->n_ifs; i++)
494 fformat (vam->ofp, "VR sw_if_index %u vr_id %u IPv%d - "
495 "track sw_if_index %u priority %u\n",
496 ntohl (mp->sw_if_index), mp->vr_id, (mp->is_ipv6) ? 6 : 4,
497 ntohl (mp->ifs[i].sw_if_index), mp->ifs[i].priority);
500 fformat (vam->ofp, "\n");
504 api_vrrp_vr_set_peers (vat_main_t * vam)
506 unformat_input_t *i = vam->input;
507 u32 sw_if_index = ~0;
510 u8 n_addrs4, n_addrs6;
511 vl_api_vrrp_vr_set_peers_t *mp;
512 vl_api_address_t *api_addr;
513 ip46_address_t *ip_addr, *ip_addrs = 0;
517 n_addrs4 = n_addrs6 = 0;
520 clib_memset (&addr, 0, sizeof (addr));
522 /* Parse args required to build the message */
523 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
525 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
527 else if (unformat (i, "sw_if_index %u", &sw_if_index))
529 else if (unformat (i, "vr_id %u", &vr_id))
531 else if (unformat (i, "ipv6"))
533 else if (unformat (i, "%U", unformat_ip4_address, &addr.ip4))
535 vec_add1 (ip_addrs, addr);
537 clib_memset (&addr, 0, sizeof (addr));
539 else if (unformat (i, "%U", unformat_ip6_address, &addr.ip6))
541 vec_add1 (ip_addrs, addr);
543 clib_memset (&addr, 0, sizeof (addr));
549 if (sw_if_index == ~0)
551 errmsg ("Interface not set\n");
554 else if (n_addrs4 && (n_addrs6 || is_ipv6))
556 errmsg ("Address family mismatch\n");
563 /* Construct the API message */
564 M2 (VRRP_VR_SET_PEERS, mp, vec_len (ip_addrs) * sizeof (*api_addr));
566 mp->sw_if_index = ntohl (sw_if_index);
568 mp->is_ipv6 = (is_ipv6 != 0);
570 mp->n_addrs = n_addrs4 + n_addrs6;
571 api_addr = mp->addrs;
573 vec_foreach (ip_addr, ip_addrs)
580 api_addr->af = ADDRESS_IP6;
582 dst = &api_addr->un.ip6;
583 len = sizeof (api_addr->un.ip6);
587 api_addr->af = ADDRESS_IP4;
589 dst = &api_addr->un.ip4;
590 len = sizeof (api_addr->un.ip4);
592 clib_memcpy (dst, src, len);
599 /* Wait for a reply... */
609 api_vrrp_vr_peer_dump (vat_main_t * vam)
611 vrrp_test_main_t *vtm = &vrrp_test_main;
612 unformat_input_t *i = vam->input;
613 vl_api_vrrp_vr_peer_dump_t *mp;
614 vl_api_control_ping_t *mp_ping;
615 u32 sw_if_index = ~0, vr_id = 0;
619 if (vam->json_output)
621 clib_warning ("JSON output not supported for vrrp_vr_track_if_dump");
625 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
627 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
629 else if (unformat (i, "sw_if_index %u", &sw_if_index))
631 else if (unformat (i, "vr_id %u", &vr_id))
633 else if (unformat (i, "ipv6"))
639 /* sw_if_index and vr_id must be valid */
640 if (sw_if_index == ~0)
642 errmsg ("VR interface not specified\n");
647 errmsg ("Invalid VR ID - must be between 1 and 255");
651 M (VRRP_VR_PEER_DUMP, mp);
653 mp->sw_if_index = htonl (sw_if_index);
655 mp->is_ipv6 = is_ipv6;
659 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
660 mp_ping->_vl_msg_id = htons (vtm->ping_id);
661 mp_ping->client_index = vam->my_client_index;
663 vam->result_ready = 0;
671 vl_api_vrrp_vr_peer_details_t_handler (vl_api_vrrp_vr_peer_details_t * mp)
673 vat_main_t *vam = vrrp_test_main.vat_main;
676 fformat (vam->ofp, "sw_if_index %u vr_id %u IPv%d ",
677 ntohl (mp->sw_if_index), mp->vr_id, (mp->is_ipv6) ? 6 : 4);
679 fformat (vam->ofp, "peer addresses: ");
681 for (i = 0; i < mp->n_peer_addrs; i++)
683 vl_api_address_t *addr = mp->peer_addrs + i;
685 fformat (vam->ofp, "%U ",
686 (addr->af) ? format_ip6_address : format_ip4_address,
690 fformat (vam->ofp, "\n");
693 #include <vrrp/vrrp.api_test.c>
695 * fd.io coding-style-patch-verification: ON
698 * eval: (c-set-style "gnu")