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_add_del (vat_main_t * vam)
40 unformat_input_t *i = vam->input;
42 u32 vr_id, priority, interval;
43 u8 is_ipv6, no_preempt, accept_mode, vr_unicast, is_add, is_del;
44 u8 n_addrs4, n_addrs6;
45 vl_api_vrrp_vr_add_del_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;
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, "ipv6"))
69 else if (unformat (i, "priority %u", &priority))
71 else if (unformat (i, "interval %u", &interval))
73 else if (unformat (i, "no_preempt"))
75 else if (unformat (i, "accept_mode"))
77 else if (unformat (i, "unicast"))
79 else if (unformat (i, "%U", unformat_ip4_address, &addr.ip4))
81 vec_add1 (ip_addrs, addr);
83 clib_memset (&addr, 0, sizeof (addr));
85 else if (unformat (i, "%U", unformat_ip6_address, &addr.ip6))
87 vec_add1 (ip_addrs, addr);
89 clib_memset (&addr, 0, sizeof (addr));
91 else if (unformat (i, "add"))
93 else if (unformat (i, "del"))
101 errmsg ("One of add or del must be specified\n");
104 else if (sw_if_index == ~0)
106 errmsg ("Interface not set\n");
109 else if (n_addrs4 && (n_addrs6 || is_ipv6))
111 errmsg ("Address family mismatch\n");
118 /* Construct the API message */
119 M2 (VRRP_VR_ADD_DEL, mp, vec_len (ip_addrs) * sizeof (*api_addr));
122 mp->sw_if_index = ntohl (sw_if_index);
124 mp->priority = priority;
125 mp->interval = htons (interval);
126 mp->flags = VRRP_API_VR_PREEMPT; /* preempt by default */
129 mp->flags &= ~VRRP_API_VR_PREEMPT;
132 mp->flags |= VRRP_API_VR_ACCEPT;
135 mp->flags |= VRRP_API_VR_UNICAST;
138 mp->flags |= VRRP_API_VR_IPV6;
140 mp->flags = htonl (mp->flags);
142 mp->n_addrs = n_addrs4 + n_addrs6;
143 api_addr = mp->addrs;
145 vec_foreach (ip_addr, ip_addrs)
152 api_addr->af = ADDRESS_IP6;
154 dst = &api_addr->un.ip6;
155 len = sizeof (api_addr->un.ip6);
159 api_addr->af = ADDRESS_IP4;
161 dst = &api_addr->un.ip4;
162 len = sizeof (api_addr->un.ip4);
164 clib_memcpy (dst, src, len);
171 /* Wait for a reply... */
181 api_vrrp_vr_dump (vat_main_t * vam)
183 vrrp_test_main_t *vtm = &vrrp_test_main;
184 unformat_input_t *i = vam->input;
185 vl_api_vrrp_vr_dump_t *mp;
186 vl_api_control_ping_t *mp_ping;
187 u32 sw_if_index = ~0;
190 if (vam->json_output)
192 clib_warning ("JSON output not supported for vrrp_vr_dump");
196 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
198 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
200 else if (unformat (i, "sw_if_index %u", &sw_if_index))
206 M (VRRP_VR_DUMP, mp);
208 mp->sw_if_index = htonl (sw_if_index);
212 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
213 mp_ping->_vl_msg_id = htons (vtm->ping_id);
214 mp_ping->client_index = vam->my_client_index;
216 vam->result_ready = 0;
224 vl_api_vrrp_vr_details_t_handler (vl_api_vrrp_vr_details_t * mp)
226 vat_main_t *vam = vrrp_test_main.vat_main;
227 u32 api_flags = ntohl (mp->config.flags);
231 "VRRP_API_VR_STATE_INIT",
232 "VRRP_API_VR_STATE_BACKUP",
233 "VRRP_API_VR_STATE_MASTER",
237 state = ntohl (mp->runtime.state);
239 if (state > ARRAY_LEN (states) - 2)
240 state = ARRAY_LEN (states) - 1;
242 fformat (vam->ofp, "sw_if_index %u vr_id %u IPv%d: "
243 "priority %u interval %u preempt %s accept %s unicast %s "
244 "state %s master_adv_interval %u skew %u master_down_interval %u "
246 ntohl (mp->config.sw_if_index), mp->config.vr_id,
247 (mp->config.flags & VRRP_API_VR_IPV6) ? 6 : 4,
248 mp->config.priority, htons (mp->config.interval),
249 (api_flags & VRRP_API_VR_PREEMPT) ? "yes" : "no",
250 (api_flags & VRRP_API_VR_ACCEPT) ? "yes" : "no",
251 (api_flags & VRRP_API_VR_UNICAST) ? "yes" : "no",
253 ntohs (mp->runtime.master_adv_int), ntohs (mp->runtime.skew),
254 ntohs (mp->runtime.master_down_int),
255 format_ethernet_address, &mp->runtime.mac);
257 fformat (vam->ofp, "addresses: ");
259 for (i = 0; i < mp->n_addrs; i++)
261 vl_api_address_t *addr = mp->addrs + i;
263 fformat (vam->ofp, "%U ",
264 (addr->af) ? format_ip6_address : format_ip4_address,
268 fformat (vam->ofp, "\n");
272 api_vrrp_vr_start_stop (vat_main_t * vam)
274 unformat_input_t *i = vam->input;
275 vl_api_vrrp_vr_start_stop_t *mp;
276 u32 sw_if_index = ~0, vr_id;
277 u8 is_ipv6, is_start, is_stop;
280 vr_id = is_ipv6 = is_start = is_stop = 0;
282 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
284 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
286 else if (unformat (i, "sw_if_index %u", &sw_if_index))
288 else if (unformat (i, "vr_id %u", &vr_id))
290 else if (unformat (i, "ipv6"))
292 else if (unformat (i, "start"))
294 else if (unformat (i, "stop"))
300 if (is_start == is_stop)
302 errmsg ("One of add or del must be specified\n");
305 else if (sw_if_index == ~0)
307 errmsg ("Interface not set\n");
312 errmsg ("VR ID must be between 1 and 255");
316 M (VRRP_VR_START_STOP, mp);
318 mp->sw_if_index = htonl (sw_if_index);
320 mp->is_ipv6 = (is_ipv6 != 0);
321 mp->is_start = (is_start != 0);
330 api_vrrp_vr_track_if_add_del (vat_main_t * vam)
332 unformat_input_t *i = vam->input;
333 vl_api_vrrp_vr_track_if_add_del_t *mp;
334 vl_api_vrrp_vr_track_if_t *track_ifs = 0, *track_if;
335 u32 sw_if_index = ~0, track_sw_if_index = ~0, vr_id, priority;
336 u8 is_ipv6, is_add, is_del;
339 is_ipv6 = is_add = is_del = 0;
340 vr_id = priority = 0;
342 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
344 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
346 else if (unformat (i, "sw_if_index %u", &sw_if_index))
348 else if (unformat (i, "vr_id %u", &vr_id))
350 else if (unformat (i, "ipv6"))
352 else if (unformat (i, "track-index %u priority %u", &track_sw_if_index,
355 vec_add2 (track_ifs, track_if, 1);
356 track_if->sw_if_index = ntohl (track_sw_if_index);
357 track_if->priority = priority;
359 else if (unformat (i, "add"))
361 else if (unformat (i, "del"))
367 if (is_add == is_del)
369 errmsg ("One of add or del must be specified\n");
372 else if (sw_if_index == ~0)
374 errmsg ("VR interface not specified\n");
379 errmsg ("Invalid VR ID - must be between 1 and 255");
382 else if (vec_len (track_ifs) == 0)
384 errmsg ("No tracked interfaces specified for VR\n");
388 vec_foreach (track_if, track_ifs)
390 if (!track_if->priority)
392 errmsg ("Priority must be nonzero");
393 vec_free (track_ifs);
399 M2 (VRRP_VR_TRACK_IF_ADD_DEL, mp, vec_len (track_ifs) * sizeof (*track_if));
401 mp->sw_if_index = htonl (sw_if_index);
403 mp->is_ipv6 = (is_ipv6 != 0);
405 mp->n_ifs = vec_len (track_ifs);
406 clib_memcpy (mp->ifs, track_ifs, mp->n_ifs * sizeof (*track_if));
415 api_vrrp_vr_track_if_dump (vat_main_t * vam)
417 vrrp_test_main_t *vtm = &vrrp_test_main;
418 unformat_input_t *i = vam->input;
419 vl_api_vrrp_vr_track_if_dump_t *mp;
420 vl_api_control_ping_t *mp_ping;
421 u32 sw_if_index = ~0, vr_id = 0;
422 u8 is_ipv6 = 0, dump_all = 0;
425 if (vam->json_output)
427 clib_warning ("JSON output not supported for vrrp_vr_track_if_dump");
431 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
433 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
435 else if (unformat (i, "sw_if_index %u", &sw_if_index))
437 else if (unformat (i, "vr_id %u", &vr_id))
439 else if (unformat (i, "ipv6"))
445 /* If no arguments were provided, dump all VRs */
446 if ((sw_if_index == ~0) && !vr_id && !is_ipv6)
449 /* If any arguments provided, sw_if_index and vr_id must be valid */
450 else if (sw_if_index == ~0)
452 errmsg ("VR interface not specified\n");
457 errmsg ("Invalid VR ID - must be between 1 and 255");
461 M (VRRP_VR_TRACK_IF_DUMP, mp);
463 mp->dump_all = dump_all;
466 mp->sw_if_index = htonl (sw_if_index);
468 mp->is_ipv6 = is_ipv6;
473 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
474 mp_ping->_vl_msg_id = htons (vtm->ping_id);
475 mp_ping->client_index = vam->my_client_index;
477 vam->result_ready = 0;
485 vl_api_vrrp_vr_track_if_details_t_handler
486 (vl_api_vrrp_vr_track_if_details_t * mp)
488 vat_main_t *vam = vrrp_test_main.vat_main;
491 for (i = 0; i < mp->n_ifs; i++)
493 fformat (vam->ofp, "VR sw_if_index %u vr_id %u IPv%d - "
494 "track sw_if_index %u priority %u\n",
495 ntohl (mp->sw_if_index), mp->vr_id, (mp->is_ipv6) ? 6 : 4,
496 ntohl (mp->ifs[i].sw_if_index), mp->ifs[i].priority);
499 fformat (vam->ofp, "\n");
503 api_vrrp_vr_set_peers (vat_main_t * vam)
505 unformat_input_t *i = vam->input;
506 u32 sw_if_index = ~0;
509 u8 n_addrs4, n_addrs6;
510 vl_api_vrrp_vr_set_peers_t *mp;
511 vl_api_address_t *api_addr;
512 ip46_address_t *ip_addr, *ip_addrs = 0;
516 n_addrs4 = n_addrs6 = 0;
519 clib_memset (&addr, 0, sizeof (addr));
521 /* Parse args required to build the message */
522 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
524 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
526 else if (unformat (i, "sw_if_index %u", &sw_if_index))
528 else if (unformat (i, "vr_id %u", &vr_id))
530 else if (unformat (i, "ipv6"))
532 else if (unformat (i, "%U", unformat_ip4_address, &addr.ip4))
534 vec_add1 (ip_addrs, addr);
536 clib_memset (&addr, 0, sizeof (addr));
538 else if (unformat (i, "%U", unformat_ip6_address, &addr.ip6))
540 vec_add1 (ip_addrs, addr);
542 clib_memset (&addr, 0, sizeof (addr));
548 if (sw_if_index == ~0)
550 errmsg ("Interface not set\n");
553 else if (n_addrs4 && (n_addrs6 || is_ipv6))
555 errmsg ("Address family mismatch\n");
562 /* Construct the API message */
563 M2 (VRRP_VR_SET_PEERS, mp, vec_len (ip_addrs) * sizeof (*api_addr));
565 mp->sw_if_index = ntohl (sw_if_index);
567 mp->is_ipv6 = (is_ipv6 != 0);
569 mp->n_addrs = n_addrs4 + n_addrs6;
570 api_addr = mp->addrs;
572 vec_foreach (ip_addr, ip_addrs)
579 api_addr->af = ADDRESS_IP6;
581 dst = &api_addr->un.ip6;
582 len = sizeof (api_addr->un.ip6);
586 api_addr->af = ADDRESS_IP4;
588 dst = &api_addr->un.ip4;
589 len = sizeof (api_addr->un.ip4);
591 clib_memcpy (dst, src, len);
598 /* Wait for a reply... */
608 api_vrrp_vr_peer_dump (vat_main_t * vam)
610 vrrp_test_main_t *vtm = &vrrp_test_main;
611 unformat_input_t *i = vam->input;
612 vl_api_vrrp_vr_peer_dump_t *mp;
613 vl_api_control_ping_t *mp_ping;
614 u32 sw_if_index = ~0, vr_id = 0;
618 if (vam->json_output)
620 clib_warning ("JSON output not supported for vrrp_vr_track_if_dump");
624 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
626 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
628 else if (unformat (i, "sw_if_index %u", &sw_if_index))
630 else if (unformat (i, "vr_id %u", &vr_id))
632 else if (unformat (i, "ipv6"))
638 /* sw_if_index and vr_id must be valid */
639 if (sw_if_index == ~0)
641 errmsg ("VR interface not specified\n");
646 errmsg ("Invalid VR ID - must be between 1 and 255");
650 M (VRRP_VR_PEER_DUMP, mp);
652 mp->sw_if_index = htonl (sw_if_index);
654 mp->is_ipv6 = is_ipv6;
658 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
659 mp_ping->_vl_msg_id = htons (vtm->ping_id);
660 mp_ping->client_index = vam->my_client_index;
662 vam->result_ready = 0;
670 vl_api_vrrp_vr_peer_details_t_handler (vl_api_vrrp_vr_peer_details_t * mp)
672 vat_main_t *vam = vrrp_test_main.vat_main;
675 fformat (vam->ofp, "sw_if_index %u vr_id %u IPv%d ",
676 ntohl (mp->sw_if_index), mp->vr_id, (mp->is_ipv6) ? 6 : 4);
678 fformat (vam->ofp, "peer addresses: ");
680 for (i = 0; i < mp->n_peer_addrs; i++)
682 vl_api_address_t *addr = mp->peer_addrs + i;
684 fformat (vam->ofp, "%U ",
685 (addr->af) ? format_ip6_address : format_ip4_address,
689 fformat (vam->ofp, "\n");
693 api_want_vrrp_vr_events (vat_main_t * vam)
695 unformat_input_t *i = vam->input;
696 vl_api_want_vrrp_vr_events_t *mp;
700 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
702 if (unformat (i, "enable"))
704 else if (unformat (i, "disable"))
712 errmsg ("missing enable|disable");
716 M (WANT_VRRP_VR_EVENTS, mp);
717 mp->enable_disable = enable;
724 #include <vrrp/vrrp.api_test.c>
726 * fd.io coding-style-patch-verification: ON
729 * eval: (c-set-style "gnu")