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 <vlibmemory/vlib.api_types.h>
26 /* API message ID base */
32 vrrp_test_main_t vrrp_test_main;
34 #define __plugin_msg_base vrrp_test_main.msg_id_base
35 #include <vlibapi/vat_helper_macros.h>
38 api_vrrp_vr_update (vat_main_t *vam)
40 unformat_input_t *i = vam->input;
42 u32 vr_id, priority, interval, vrrp_index;
43 u8 is_ipv6, no_preempt, accept_mode, vr_unicast;
44 u8 n_addrs4, n_addrs6;
45 vl_api_vrrp_vr_update_t *mp;
46 vl_api_address_t *api_addr;
47 ip46_address_t *ip_addr, *ip_addrs = 0;
51 interval = priority = 100;
52 n_addrs4 = n_addrs6 = 0;
53 vr_id = is_ipv6 = no_preempt = accept_mode = vr_unicast = 0;
54 vrrp_index = INDEX_INVALID;
56 clib_memset (&addr, 0, sizeof (addr));
58 /* Parse args required to build the message */
59 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
61 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
63 else if (unformat (i, "sw_if_index %u", &sw_if_index))
65 else if (unformat (i, "vr_id %u", &vr_id))
67 else if (unformat (i, "vrrp_index %u", &vrrp_index))
69 else if (unformat (i, "ipv6"))
71 else if (unformat (i, "priority %u", &priority))
73 else if (unformat (i, "interval %u", &interval))
75 else if (unformat (i, "no_preempt"))
77 else if (unformat (i, "accept_mode"))
79 else if (unformat (i, "unicast"))
81 else if (unformat (i, "%U", unformat_ip4_address, &addr.ip4))
83 vec_add1 (ip_addrs, addr);
85 clib_memset (&addr, 0, sizeof (addr));
87 else if (unformat (i, "%U", unformat_ip6_address, &addr.ip6))
89 vec_add1 (ip_addrs, addr);
91 clib_memset (&addr, 0, sizeof (addr));
97 if (sw_if_index == ~0)
99 errmsg ("Interface not set\n");
102 else if (n_addrs4 && (n_addrs6 || is_ipv6))
104 errmsg ("Address family mismatch\n");
111 /* Construct the API message */
112 M2 (VRRP_VR_UPDATE, mp, vec_len (ip_addrs) * sizeof (*api_addr));
114 mp->vrrp_index = htonl (vrrp_index);
115 mp->sw_if_index = ntohl (sw_if_index);
117 mp->priority = priority;
118 mp->interval = htons (interval);
119 mp->flags = VRRP_API_VR_PREEMPT; /* preempt by default */
122 mp->flags &= ~VRRP_API_VR_PREEMPT;
125 mp->flags |= VRRP_API_VR_ACCEPT;
128 mp->flags |= VRRP_API_VR_UNICAST;
131 mp->flags |= VRRP_API_VR_IPV6;
133 mp->flags = htonl (mp->flags);
135 mp->n_addrs = n_addrs4 + n_addrs6;
136 api_addr = mp->addrs;
138 vec_foreach (ip_addr, ip_addrs)
145 api_addr->af = ADDRESS_IP6;
147 dst = &api_addr->un.ip6;
148 len = sizeof (api_addr->un.ip6);
152 api_addr->af = ADDRESS_IP4;
154 dst = &api_addr->un.ip4;
155 len = sizeof (api_addr->un.ip4);
157 clib_memcpy (dst, src, len);
164 /* Wait for a reply... */
174 vl_api_vrrp_vr_update_reply_t_handler (vl_api_vrrp_vr_update_reply_t *mp)
179 api_vrrp_vr_del (vat_main_t *vam)
181 unformat_input_t *i = vam->input;
182 vl_api_vrrp_vr_del_t *mp;
183 u32 vrrp_index = INDEX_INVALID;
186 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
188 if (unformat (i, "vrrp_index %u", &vrrp_index))
194 /* Construct the API message */
196 mp->vrrp_index = htonl (vrrp_index);
201 /* Wait for a reply... */
208 api_vrrp_vr_add_del (vat_main_t * vam)
210 unformat_input_t *i = vam->input;
211 u32 sw_if_index = ~0;
212 u32 vr_id, priority, interval;
213 u8 is_ipv6, no_preempt, accept_mode, vr_unicast, is_add, is_del;
214 u8 n_addrs4, n_addrs6;
215 vl_api_vrrp_vr_add_del_t *mp;
216 vl_api_address_t *api_addr;
217 ip46_address_t *ip_addr, *ip_addrs = 0;
221 interval = priority = 100;
222 n_addrs4 = n_addrs6 = 0;
223 vr_id = is_ipv6 = no_preempt = accept_mode = vr_unicast = 0;
226 clib_memset (&addr, 0, sizeof (addr));
228 /* Parse args required to build the message */
229 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
231 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
233 else if (unformat (i, "sw_if_index %u", &sw_if_index))
235 else if (unformat (i, "vr_id %u", &vr_id))
237 else if (unformat (i, "ipv6"))
239 else if (unformat (i, "priority %u", &priority))
241 else if (unformat (i, "interval %u", &interval))
243 else if (unformat (i, "no_preempt"))
245 else if (unformat (i, "accept_mode"))
247 else if (unformat (i, "unicast"))
249 else if (unformat (i, "%U", unformat_ip4_address, &addr.ip4))
251 vec_add1 (ip_addrs, addr);
253 clib_memset (&addr, 0, sizeof (addr));
255 else if (unformat (i, "%U", unformat_ip6_address, &addr.ip6))
257 vec_add1 (ip_addrs, addr);
259 clib_memset (&addr, 0, sizeof (addr));
261 else if (unformat (i, "add"))
263 else if (unformat (i, "del"))
269 if (is_add == is_del)
271 errmsg ("One of add or del must be specified\n");
274 else if (sw_if_index == ~0)
276 errmsg ("Interface not set\n");
279 else if (n_addrs4 && (n_addrs6 || is_ipv6))
281 errmsg ("Address family mismatch\n");
288 /* Construct the API message */
289 M2 (VRRP_VR_ADD_DEL, mp, vec_len (ip_addrs) * sizeof (*api_addr));
292 mp->sw_if_index = ntohl (sw_if_index);
294 mp->priority = priority;
295 mp->interval = htons (interval);
296 mp->flags = VRRP_API_VR_PREEMPT; /* preempt by default */
299 mp->flags &= ~VRRP_API_VR_PREEMPT;
302 mp->flags |= VRRP_API_VR_ACCEPT;
305 mp->flags |= VRRP_API_VR_UNICAST;
308 mp->flags |= VRRP_API_VR_IPV6;
310 mp->flags = htonl (mp->flags);
312 mp->n_addrs = n_addrs4 + n_addrs6;
313 api_addr = mp->addrs;
315 vec_foreach (ip_addr, ip_addrs)
322 api_addr->af = ADDRESS_IP6;
324 dst = &api_addr->un.ip6;
325 len = sizeof (api_addr->un.ip6);
329 api_addr->af = ADDRESS_IP4;
331 dst = &api_addr->un.ip4;
332 len = sizeof (api_addr->un.ip4);
334 clib_memcpy (dst, src, len);
341 /* Wait for a reply... */
351 api_vrrp_vr_dump (vat_main_t * vam)
353 vrrp_test_main_t *vtm = &vrrp_test_main;
354 unformat_input_t *i = vam->input;
355 vl_api_vrrp_vr_dump_t *mp;
356 vl_api_control_ping_t *mp_ping;
357 u32 sw_if_index = ~0;
360 if (vam->json_output)
362 clib_warning ("JSON output not supported for vrrp_vr_dump");
366 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
368 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
370 else if (unformat (i, "sw_if_index %u", &sw_if_index))
376 M (VRRP_VR_DUMP, mp);
378 mp->sw_if_index = htonl (sw_if_index);
382 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
383 mp_ping->_vl_msg_id = htons (vtm->ping_id);
384 mp_ping->client_index = vam->my_client_index;
386 vam->result_ready = 0;
394 vl_api_vrrp_vr_details_t_handler (vl_api_vrrp_vr_details_t * mp)
396 vat_main_t *vam = vrrp_test_main.vat_main;
397 u32 api_flags = ntohl (mp->config.flags);
401 "VRRP_API_VR_STATE_INIT",
402 "VRRP_API_VR_STATE_BACKUP",
403 "VRRP_API_VR_STATE_MASTER",
407 state = ntohl (mp->runtime.state);
409 if (state > ARRAY_LEN (states) - 2)
410 state = ARRAY_LEN (states) - 1;
412 fformat (vam->ofp, "sw_if_index %u vr_id %u IPv%d: "
413 "priority %u interval %u preempt %s accept %s unicast %s "
414 "state %s master_adv_interval %u skew %u master_down_interval %u "
416 ntohl (mp->config.sw_if_index), mp->config.vr_id,
417 (mp->config.flags & VRRP_API_VR_IPV6) ? 6 : 4,
418 mp->config.priority, htons (mp->config.interval),
419 (api_flags & VRRP_API_VR_PREEMPT) ? "yes" : "no",
420 (api_flags & VRRP_API_VR_ACCEPT) ? "yes" : "no",
421 (api_flags & VRRP_API_VR_UNICAST) ? "yes" : "no",
423 ntohs (mp->runtime.master_adv_int), ntohs (mp->runtime.skew),
424 ntohs (mp->runtime.master_down_int),
425 format_ethernet_address, &mp->runtime.mac);
427 fformat (vam->ofp, "addresses: ");
429 for (i = 0; i < mp->n_addrs; i++)
431 vl_api_address_t *addr = mp->addrs + i;
433 fformat (vam->ofp, "%U ",
434 (addr->af) ? format_ip6_address : format_ip4_address,
438 fformat (vam->ofp, "\n");
442 api_vrrp_vr_start_stop (vat_main_t * vam)
444 unformat_input_t *i = vam->input;
445 vl_api_vrrp_vr_start_stop_t *mp;
446 u32 sw_if_index = ~0, vr_id;
447 u8 is_ipv6, is_start, is_stop;
450 vr_id = is_ipv6 = is_start = is_stop = 0;
452 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
454 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
456 else if (unformat (i, "sw_if_index %u", &sw_if_index))
458 else if (unformat (i, "vr_id %u", &vr_id))
460 else if (unformat (i, "ipv6"))
462 else if (unformat (i, "start"))
464 else if (unformat (i, "stop"))
470 if (is_start == is_stop)
472 errmsg ("One of add or del must be specified\n");
475 else if (sw_if_index == ~0)
477 errmsg ("Interface not set\n");
482 errmsg ("VR ID must be between 1 and 255");
486 M (VRRP_VR_START_STOP, mp);
488 mp->sw_if_index = htonl (sw_if_index);
490 mp->is_ipv6 = (is_ipv6 != 0);
491 mp->is_start = (is_start != 0);
500 api_vrrp_vr_track_if_add_del (vat_main_t * vam)
502 unformat_input_t *i = vam->input;
503 vl_api_vrrp_vr_track_if_add_del_t *mp;
504 vl_api_vrrp_vr_track_if_t *track_ifs = 0, *track_if;
505 u32 sw_if_index = ~0, track_sw_if_index = ~0, vr_id, priority;
506 u8 is_ipv6, is_add, is_del;
509 is_ipv6 = is_add = is_del = 0;
510 vr_id = priority = 0;
512 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
514 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
516 else if (unformat (i, "sw_if_index %u", &sw_if_index))
518 else if (unformat (i, "vr_id %u", &vr_id))
520 else if (unformat (i, "ipv6"))
522 else if (unformat (i, "track-index %u priority %u", &track_sw_if_index,
525 vec_add2 (track_ifs, track_if, 1);
526 track_if->sw_if_index = ntohl (track_sw_if_index);
527 track_if->priority = priority;
529 else if (unformat (i, "add"))
531 else if (unformat (i, "del"))
537 if (is_add == is_del)
539 errmsg ("One of add or del must be specified\n");
542 else if (sw_if_index == ~0)
544 errmsg ("VR interface not specified\n");
549 errmsg ("Invalid VR ID - must be between 1 and 255");
552 else if (vec_len (track_ifs) == 0)
554 errmsg ("No tracked interfaces specified for VR\n");
558 vec_foreach (track_if, track_ifs)
560 if (!track_if->priority)
562 errmsg ("Priority must be nonzero");
563 vec_free (track_ifs);
569 M2 (VRRP_VR_TRACK_IF_ADD_DEL, mp, vec_len (track_ifs) * sizeof (*track_if));
571 mp->sw_if_index = htonl (sw_if_index);
573 mp->is_ipv6 = (is_ipv6 != 0);
575 mp->n_ifs = vec_len (track_ifs);
576 clib_memcpy (mp->ifs, track_ifs, mp->n_ifs * sizeof (*track_if));
585 api_vrrp_vr_track_if_dump (vat_main_t * vam)
587 vrrp_test_main_t *vtm = &vrrp_test_main;
588 unformat_input_t *i = vam->input;
589 vl_api_vrrp_vr_track_if_dump_t *mp;
590 vl_api_control_ping_t *mp_ping;
591 u32 sw_if_index = ~0, vr_id = 0;
592 u8 is_ipv6 = 0, dump_all = 0;
595 if (vam->json_output)
597 clib_warning ("JSON output not supported for vrrp_vr_track_if_dump");
601 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
603 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
605 else if (unformat (i, "sw_if_index %u", &sw_if_index))
607 else if (unformat (i, "vr_id %u", &vr_id))
609 else if (unformat (i, "ipv6"))
615 /* If no arguments were provided, dump all VRs */
616 if ((sw_if_index == ~0) && !vr_id && !is_ipv6)
619 /* If any arguments provided, sw_if_index and vr_id must be valid */
620 else if (sw_if_index == ~0)
622 errmsg ("VR interface not specified\n");
627 errmsg ("Invalid VR ID - must be between 1 and 255");
631 M (VRRP_VR_TRACK_IF_DUMP, mp);
633 mp->dump_all = dump_all;
636 mp->sw_if_index = htonl (sw_if_index);
638 mp->is_ipv6 = is_ipv6;
643 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
644 mp_ping->_vl_msg_id = htons (vtm->ping_id);
645 mp_ping->client_index = vam->my_client_index;
647 vam->result_ready = 0;
655 vl_api_vrrp_vr_track_if_details_t_handler
656 (vl_api_vrrp_vr_track_if_details_t * mp)
658 vat_main_t *vam = vrrp_test_main.vat_main;
661 for (i = 0; i < mp->n_ifs; i++)
663 fformat (vam->ofp, "VR sw_if_index %u vr_id %u IPv%d - "
664 "track sw_if_index %u priority %u\n",
665 ntohl (mp->sw_if_index), mp->vr_id, (mp->is_ipv6) ? 6 : 4,
666 ntohl (mp->ifs[i].sw_if_index), mp->ifs[i].priority);
669 fformat (vam->ofp, "\n");
673 api_vrrp_vr_set_peers (vat_main_t * vam)
675 unformat_input_t *i = vam->input;
676 u32 sw_if_index = ~0;
679 u8 n_addrs4, n_addrs6;
680 vl_api_vrrp_vr_set_peers_t *mp;
681 vl_api_address_t *api_addr;
682 ip46_address_t *ip_addr, *ip_addrs = 0;
686 n_addrs4 = n_addrs6 = 0;
689 clib_memset (&addr, 0, sizeof (addr));
691 /* Parse args required to build the message */
692 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
694 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
696 else if (unformat (i, "sw_if_index %u", &sw_if_index))
698 else if (unformat (i, "vr_id %u", &vr_id))
700 else if (unformat (i, "ipv6"))
702 else if (unformat (i, "%U", unformat_ip4_address, &addr.ip4))
704 vec_add1 (ip_addrs, addr);
706 clib_memset (&addr, 0, sizeof (addr));
708 else if (unformat (i, "%U", unformat_ip6_address, &addr.ip6))
710 vec_add1 (ip_addrs, addr);
712 clib_memset (&addr, 0, sizeof (addr));
718 if (sw_if_index == ~0)
720 errmsg ("Interface not set\n");
723 else if (n_addrs4 && (n_addrs6 || is_ipv6))
725 errmsg ("Address family mismatch\n");
732 /* Construct the API message */
733 M2 (VRRP_VR_SET_PEERS, mp, vec_len (ip_addrs) * sizeof (*api_addr));
735 mp->sw_if_index = ntohl (sw_if_index);
737 mp->is_ipv6 = (is_ipv6 != 0);
739 mp->n_addrs = n_addrs4 + n_addrs6;
740 api_addr = mp->addrs;
742 vec_foreach (ip_addr, ip_addrs)
749 api_addr->af = ADDRESS_IP6;
751 dst = &api_addr->un.ip6;
752 len = sizeof (api_addr->un.ip6);
756 api_addr->af = ADDRESS_IP4;
758 dst = &api_addr->un.ip4;
759 len = sizeof (api_addr->un.ip4);
761 clib_memcpy (dst, src, len);
768 /* Wait for a reply... */
778 api_vrrp_vr_peer_dump (vat_main_t * vam)
780 vrrp_test_main_t *vtm = &vrrp_test_main;
781 unformat_input_t *i = vam->input;
782 vl_api_vrrp_vr_peer_dump_t *mp;
783 vl_api_control_ping_t *mp_ping;
784 u32 sw_if_index = ~0, vr_id = 0;
788 if (vam->json_output)
790 clib_warning ("JSON output not supported for vrrp_vr_track_if_dump");
794 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
796 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
798 else if (unformat (i, "sw_if_index %u", &sw_if_index))
800 else if (unformat (i, "vr_id %u", &vr_id))
802 else if (unformat (i, "ipv6"))
808 /* sw_if_index and vr_id must be valid */
809 if (sw_if_index == ~0)
811 errmsg ("VR interface not specified\n");
816 errmsg ("Invalid VR ID - must be between 1 and 255");
820 M (VRRP_VR_PEER_DUMP, mp);
822 mp->sw_if_index = htonl (sw_if_index);
824 mp->is_ipv6 = is_ipv6;
828 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
829 mp_ping->_vl_msg_id = htons (vtm->ping_id);
830 mp_ping->client_index = vam->my_client_index;
832 vam->result_ready = 0;
840 vl_api_vrrp_vr_peer_details_t_handler (vl_api_vrrp_vr_peer_details_t * mp)
842 vat_main_t *vam = vrrp_test_main.vat_main;
845 fformat (vam->ofp, "sw_if_index %u vr_id %u IPv%d ",
846 ntohl (mp->sw_if_index), mp->vr_id, (mp->is_ipv6) ? 6 : 4);
848 fformat (vam->ofp, "peer addresses: ");
850 for (i = 0; i < mp->n_peer_addrs; i++)
852 vl_api_address_t *addr = mp->peer_addrs + i;
854 fformat (vam->ofp, "%U ",
855 (addr->af) ? format_ip6_address : format_ip4_address,
859 fformat (vam->ofp, "\n");
863 api_want_vrrp_vr_events (vat_main_t * vam)
865 unformat_input_t *i = vam->input;
866 vl_api_want_vrrp_vr_events_t *mp;
870 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
872 if (unformat (i, "enable"))
874 else if (unformat (i, "disable"))
882 errmsg ("missing enable|disable");
886 M (WANT_VRRP_VR_EVENTS, mp);
887 mp->enable_disable = enable;
894 #include <vrrp/vrrp.api_test.c>
896 * fd.io coding-style-patch-verification: ON
899 * eval: (c-set-style "gnu")