src/plugins/vrrp/vrrp_test.c

   1 /*
   2  * vrrp.c - VRRP vpp-api-test plug-in
   3  *
   4  * Copyright 2019-2020 Rubicon Communications, LLC (Netgate)
   5  *
   6  * SPDX-License-Identifier: Apache-2.0
   7  *
   8  */
   9 #include <vat/vat.h>
  10 #include <vlibapi/api.h>
  11 #include <vlibmemory/api.h>
  12 #include <vppinfra/error.h>
  13
  14 #include <vnet/ip/ip.h>
  15
  16 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
  17
  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>
  23
  24
  25 typedef struct
  26 {
  27   /* API message ID base */
  28   u16 msg_id_base;
  29   u32 ping_id;
  30   vat_main_t *vat_main;
  31 } vrrp_test_main_t;
  32
  33 vrrp_test_main_t vrrp_test_main;
  34
  35 #define __plugin_msg_base vrrp_test_main.msg_id_base
  36 #include <vlibapi/vat_helper_macros.h>
  37
  38 static int
  39 api_vrrp_vr_add_del (vat_main_t * vam)
  40 {
  41   unformat_input_t *i = vam->input;
  42   u32 sw_if_index = ~0;
  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;
  49   ip46_address_t addr;
  50   int ret = 0;
  51
  52   interval = priority = 100;
  53   n_addrs4 = n_addrs6 = 0;
  54   vr_id = is_ipv6 = no_preempt = accept_mode = vr_unicast = 0;
  55   is_add = is_del = 0;
  56
  57   clib_memset (&addr, 0, sizeof (addr));
  58
  59   /* Parse args required to build the message */
  60   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
  61     {
  62       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
  63         ;
  64       else if (unformat (i, "sw_if_index %u", &sw_if_index))
  65         ;
  66       else if (unformat (i, "vr_id %u", &vr_id))
  67         ;
  68       else if (unformat (i, "ipv6"))
  69         is_ipv6 = 1;
  70       else if (unformat (i, "priority %u", &priority))
  71         ;
  72       else if (unformat (i, "interval %u", &interval))
  73         ;
  74       else if (unformat (i, "no_preempt"))
  75         no_preempt = 1;
  76       else if (unformat (i, "accept_mode"))
  77         accept_mode = 1;
  78       else if (unformat (i, "unicast"))
  79         vr_unicast = 1;
  80       else if (unformat (i, "%U", unformat_ip4_address, &addr.ip4))
  81         {
  82           vec_add1 (ip_addrs, addr);
  83           n_addrs4++;
  84           clib_memset (&addr, 0, sizeof (addr));
  85         }
  86       else if (unformat (i, "%U", unformat_ip6_address, &addr.ip6))
  87         {
  88           vec_add1 (ip_addrs, addr);
  89           n_addrs6++;
  90           clib_memset (&addr, 0, sizeof (addr));
  91         }
  92       else if (unformat (i, "add"))
  93         is_add = 1;
  94       else if (unformat (i, "del"))
  95         is_del = 1;
  96       else
  97         break;
  98     }
  99
 100   if (is_add == is_del)
 101     {
 102       errmsg ("One of add or del must be specified\n");
 103       ret = -99;
 104     }
 105   else if (sw_if_index == ~0)
 106     {
 107       errmsg ("Interface not set\n");
 108       ret = -99;
 109     }
 110   else if (n_addrs4 && (n_addrs6 || is_ipv6))
 111     {
 112       errmsg ("Address family mismatch\n");
 113       ret = -99;
 114     }
 115
 116   if (ret)
 117     goto done;
 118
 119   /* Construct the API message */
 120   M2 (VRRP_VR_ADD_DEL, mp, vec_len (ip_addrs) * sizeof (*api_addr));
 121
 122   mp->is_add = is_add;
 123   mp->sw_if_index = ntohl (sw_if_index);
 124   mp->vr_id = vr_id;
 125   mp->priority = priority;
 126   mp->interval = htons (interval);
 127   mp->flags = VRRP_API_VR_PREEMPT;      /* preempt by default */
 128
 129   if (no_preempt)
 130     mp->flags &= ~VRRP_API_VR_PREEMPT;
 131
 132   if (accept_mode)
 133     mp->flags |= VRRP_API_VR_ACCEPT;
 134
 135   if (vr_unicast)
 136     mp->flags |= VRRP_API_VR_UNICAST;
 137
 138   if (is_ipv6)
 139     mp->flags |= VRRP_API_VR_IPV6;
 140
 141   mp->flags = htonl (mp->flags);
 142
 143   mp->n_addrs = n_addrs4 + n_addrs6;
 144   api_addr = mp->addrs;
 145
 146   vec_foreach (ip_addr, ip_addrs)
 147   {
 148     void *src, *dst;
 149     int len;
 150
 151     if (is_ipv6)
 152       {
 153         api_addr->af = ADDRESS_IP6;
 154         src = &ip_addr->ip6;
 155         dst = &api_addr->un.ip6;
 156         len = sizeof (api_addr->un.ip6);
 157       }
 158     else
 159       {
 160         api_addr->af = ADDRESS_IP4;
 161         src = &ip_addr->ip4;
 162         dst = &api_addr->un.ip4;
 163         len = sizeof (api_addr->un.ip4);
 164       }
 165     clib_memcpy (dst, src, len);
 166     api_addr++;
 167   }
 168
 169   /* send it... */
 170   S (mp);
 171
 172   /* Wait for a reply... */
 173   W (ret);
 174
 175 done:
 176   vec_free (ip_addrs);
 177
 178   return ret;
 179 }
 180
 181 static int
 182 api_vrrp_vr_dump (vat_main_t * vam)
 183 {
 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;
 189   int ret;
 190
 191   if (vam->json_output)
 192     {
 193       clib_warning ("JSON output not supported for vrrp_vr_dump");
 194       return -99;
 195     }
 196
 197   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 198     {
 199       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
 200         ;
 201       else if (unformat (i, "sw_if_index %u", &sw_if_index))
 202         ;
 203       else
 204         break;
 205     }
 206
 207   M (VRRP_VR_DUMP, mp);
 208
 209   mp->sw_if_index = htonl (sw_if_index);
 210
 211   S (mp);
 212
 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;
 216
 217   vam->result_ready = 0;
 218   S (mp_ping);
 219
 220   W (ret);
 221   return ret;
 222 }
 223
 224 static void
 225 vl_api_vrrp_vr_details_t_handler (vl_api_vrrp_vr_details_t * mp)
 226 {
 227   vat_main_t *vam = vrrp_test_main.vat_main;
 228   u32 api_flags = ntohl (mp->config.flags);
 229   int i;
 230   char *states[] = {
 231     "VRRP_API_VR_STATE_INIT",
 232     "VRRP_API_VR_STATE_BACKUP",
 233     "VRRP_API_VR_STATE_MASTER",
 234   };
 235
 236   fformat (vam->ofp, "sw_if_index %u vr_id %u IPv%d: "
 237            "priority %u interval %u preempt %s accept %s unicast %s "
 238            "state %s master_adv_interval %u skew %u master_down_interval %u "
 239            "mac %U ",
 240            ntohl (mp->config.sw_if_index), mp->config.vr_id,
 241            (mp->config.flags & VRRP_API_VR_IPV6) ? 6 : 4,
 242            mp->config.priority, htons (mp->config.interval),
 243            (api_flags & VRRP_API_VR_PREEMPT) ? "yes" : "no",
 244            (api_flags & VRRP_API_VR_ACCEPT) ? "yes" : "no",
 245            (api_flags & VRRP_API_VR_UNICAST) ? "yes" : "no",
 246            states[ntohl (mp->runtime.state)],
 247            ntohs (mp->runtime.master_adv_int), ntohs (mp->runtime.skew),
 248            ntohs (mp->runtime.master_down_int),
 249            format_ethernet_address, &mp->runtime.mac);
 250
 251   fformat (vam->ofp, "addresses: ");
 252
 253   for (i = 0; i < mp->n_addrs; i++)
 254     {
 255       vl_api_address_t *addr = mp->addrs + i;
 256
 257       fformat (vam->ofp, "%U ",
 258                (addr->af) ? format_ip6_address : format_ip4_address,
 259                (u8 *) & addr->un);
 260     }
 261
 262   fformat (vam->ofp, "\n");
 263 }
 264
 265 static int
 266 api_vrrp_vr_start_stop (vat_main_t * vam)
 267 {
 268   unformat_input_t *i = vam->input;
 269   vl_api_vrrp_vr_start_stop_t *mp;
 270   u32 sw_if_index = ~0, vr_id;
 271   u8 is_ipv6, is_start, is_stop;
 272   int ret;
 273
 274   vr_id = is_ipv6 = is_start = is_stop = 0;
 275
 276   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 277     {
 278       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
 279         ;
 280       else if (unformat (i, "sw_if_index %u", &sw_if_index))
 281         ;
 282       else if (unformat (i, "vr_id %u", &vr_id))
 283         ;
 284       else if (unformat (i, "ipv6"))
 285         is_ipv6 = 1;
 286       else if (unformat (i, "start"))
 287         is_start = 1;
 288       else if (unformat (i, "stop"))
 289         is_stop = 1;
 290       else
 291         break;
 292     }
 293
 294   if (is_start == is_stop)
 295     {
 296       errmsg ("One of add or del must be specified\n");
 297       return -99;
 298     }
 299   else if (sw_if_index == ~0)
 300     {
 301       errmsg ("Interface not set\n");
 302       return -99;
 303     }
 304   else if (!vr_id)
 305     {
 306       errmsg ("VR ID must be between 1 and 255");
 307       return -99;
 308     }
 309
 310   M (VRRP_VR_START_STOP, mp);
 311
 312   mp->sw_if_index = htonl (sw_if_index);
 313   mp->vr_id = vr_id;
 314   mp->is_ipv6 = (is_ipv6 != 0);
 315   mp->is_start = (is_start != 0);
 316
 317   S (mp);
 318
 319   W (ret);
 320   return ret;
 321 }
 322
 323 static int
 324 api_vrrp_vr_track_if_add_del (vat_main_t * vam)
 325 {
 326   unformat_input_t *i = vam->input;
 327   vl_api_vrrp_vr_track_if_add_del_t *mp;
 328   vl_api_vrrp_vr_track_if_t *track_ifs = 0, *track_if;
 329   u32 sw_if_index = ~0, track_sw_if_index = ~0, vr_id, priority;
 330   u8 is_ipv6, is_add, is_del;
 331   int ret;
 332
 333   is_ipv6 = is_add = is_del = 0;
 334   vr_id = priority = 0;
 335
 336   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 337     {
 338       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
 339         ;
 340       else if (unformat (i, "sw_if_index %u", &sw_if_index))
 341         ;
 342       else if (unformat (i, "vr_id %u", &vr_id))
 343         ;
 344       else if (unformat (i, "ipv6"))
 345         is_ipv6 = 1;
 346       else if (unformat (i, "track-index %u priority %u", &track_sw_if_index,
 347                          &priority))
 348         {
 349           vec_add2 (track_ifs, track_if, 1);
 350           track_if->sw_if_index = ntohl (track_sw_if_index);
 351           track_if->priority = priority;
 352         }
 353       else if (unformat (i, "add"))
 354         is_add = 1;
 355       else if (unformat (i, "del"))
 356         is_del = 1;
 357       else
 358         break;
 359     }
 360
 361   if (is_add == is_del)
 362     {
 363       errmsg ("One of add or del must be specified\n");
 364       ret = -99;
 365     }
 366   else if (sw_if_index == ~0)
 367     {
 368       errmsg ("VR interface not specified\n");
 369       return -99;
 370     }
 371   else if (!vr_id)
 372     {
 373       errmsg ("Invalid VR ID - must be between 1 and 255");
 374       return -99;
 375     }
 376   else if (vec_len (track_ifs) == 0)
 377     {
 378       errmsg ("No tracked interfaces specified for VR\n");
 379       return -99;
 380     }
 381
 382   vec_foreach (track_if, track_ifs)
 383   {
 384     if (!track_if->priority)
 385       {
 386         errmsg ("Priority must be nonzero");
 387         vec_free (track_ifs);
 388         return -99;
 389       }
 390   }
 391
 392
 393   M2 (VRRP_VR_TRACK_IF_ADD_DEL, mp, vec_len (track_ifs) * sizeof (*track_if));
 394
 395   mp->sw_if_index = htonl (sw_if_index);
 396   mp->vr_id = vr_id;
 397   mp->is_ipv6 = (is_ipv6 != 0);
 398   mp->is_add = is_add;
 399   mp->n_ifs = vec_len (track_ifs);
 400   clib_memcpy (mp->ifs, track_ifs, mp->n_ifs * sizeof (*track_if));
 401
 402   S (mp);
 403
 404   W (ret);
 405   return ret;
 406 }
 407
 408 static int
 409 api_vrrp_vr_track_if_dump (vat_main_t * vam)
 410 {
 411   vrrp_test_main_t *vtm = &vrrp_test_main;
 412   unformat_input_t *i = vam->input;
 413   vl_api_vrrp_vr_track_if_dump_t *mp;
 414   vl_api_control_ping_t *mp_ping;
 415   u32 sw_if_index = ~0, vr_id = 0;
 416   u8 is_ipv6 = 0, dump_all = 0;
 417   int ret;
 418
 419   if (vam->json_output)
 420     {
 421       clib_warning ("JSON output not supported for vrrp_vr_track_if_dump");
 422       return -99;
 423     }
 424
 425   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 426     {
 427       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
 428         ;
 429       else if (unformat (i, "sw_if_index %u", &sw_if_index))
 430         ;
 431       else if (unformat (i, "vr_id %u", &vr_id))
 432         ;
 433       else if (unformat (i, "ipv6"))
 434         is_ipv6 = 1;
 435       else
 436         break;
 437     }
 438
 439   /* If no arguments were provided, dump all VRs */
 440   if ((sw_if_index == ~0) && !vr_id && !is_ipv6)
 441     dump_all = 1;
 442
 443   /* If any arguments provided, sw_if_index and vr_id must be valid */
 444   else if (sw_if_index == ~0)
 445     {
 446       errmsg ("VR interface not specified\n");
 447       return -99;
 448     }
 449   else if (!vr_id)
 450     {
 451       errmsg ("Invalid VR ID - must be between 1 and 255");
 452       return -99;
 453     }
 454
 455   M (VRRP_VR_TRACK_IF_DUMP, mp);
 456
 457   mp->dump_all = dump_all;
 458   if (!dump_all)
 459     {
 460       mp->sw_if_index = htonl (sw_if_index);
 461       mp->vr_id = vr_id;
 462       mp->is_ipv6 = is_ipv6;
 463     }
 464
 465   S (mp);
 466
 467   mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
 468   mp_ping->_vl_msg_id = htons (vtm->ping_id);
 469   mp_ping->client_index = vam->my_client_index;
 470
 471   vam->result_ready = 0;
 472   S (mp_ping);
 473
 474   W (ret);
 475   return ret;
 476 }
 477
 478 static void
 479   vl_api_vrrp_vr_track_if_details_t_handler
 480   (vl_api_vrrp_vr_track_if_details_t * mp)
 481 {
 482   vat_main_t *vam = vrrp_test_main.vat_main;
 483   int i;
 484
 485   for (i = 0; i < mp->n_ifs; i++)
 486     {
 487       fformat (vam->ofp, "VR sw_if_index %u vr_id %u IPv%d - "
 488                "track sw_if_index %u priority %u\n",
 489                ntohl (mp->sw_if_index), mp->vr_id, (mp->is_ipv6) ? 6 : 4,
 490                ntohl (mp->ifs[i].sw_if_index), mp->ifs[i].priority);
 491     }
 492
 493   fformat (vam->ofp, "\n");
 494 }
 495
 496 static int
 497 api_vrrp_vr_set_peers (vat_main_t * vam)
 498 {
 499   unformat_input_t *i = vam->input;
 500   u32 sw_if_index = ~0;
 501   u32 vr_id;
 502   u8 is_ipv6;
 503   u8 n_addrs4, n_addrs6;
 504   vl_api_vrrp_vr_set_peers_t *mp;
 505   vl_api_address_t *api_addr;
 506   ip46_address_t *ip_addr, *ip_addrs = 0;
 507   ip46_address_t addr;
 508   int ret = 0;
 509
 510   n_addrs4 = n_addrs6 = 0;
 511   vr_id = is_ipv6 = 0;
 512
 513   clib_memset (&addr, 0, sizeof (addr));
 514
 515   /* Parse args required to build the message */
 516   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 517     {
 518       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
 519         ;
 520       else if (unformat (i, "sw_if_index %u", &sw_if_index))
 521         ;
 522       else if (unformat (i, "vr_id %u", &vr_id))
 523         ;
 524       else if (unformat (i, "ipv6"))
 525         is_ipv6 = 1;
 526       else if (unformat (i, "%U", unformat_ip4_address, &addr.ip4))
 527         {
 528           vec_add1 (ip_addrs, addr);
 529           n_addrs4++;
 530           clib_memset (&addr, 0, sizeof (addr));
 531         }
 532       else if (unformat (i, "%U", unformat_ip6_address, &addr.ip6))
 533         {
 534           vec_add1 (ip_addrs, addr);
 535           n_addrs6++;
 536           clib_memset (&addr, 0, sizeof (addr));
 537         }
 538       else
 539         break;
 540     }
 541
 542   if (sw_if_index == ~0)
 543     {
 544       errmsg ("Interface not set\n");
 545       ret = -99;
 546     }
 547   else if (n_addrs4 && (n_addrs6 || is_ipv6))
 548     {
 549       errmsg ("Address family mismatch\n");
 550       ret = -99;
 551     }
 552
 553   if (ret)
 554     goto done;
 555
 556   /* Construct the API message */
 557   M2 (VRRP_VR_SET_PEERS, mp, vec_len (ip_addrs) * sizeof (*api_addr));
 558
 559   mp->sw_if_index = ntohl (sw_if_index);
 560   mp->vr_id = vr_id;
 561   mp->is_ipv6 = (is_ipv6 != 0);
 562
 563   mp->n_addrs = n_addrs4 + n_addrs6;
 564   api_addr = mp->addrs;
 565
 566   vec_foreach (ip_addr, ip_addrs)
 567   {
 568     void *src, *dst;
 569     int len;
 570
 571     if (is_ipv6)
 572       {
 573         api_addr->af = ADDRESS_IP6;
 574         src = &ip_addr->ip6;
 575         dst = &api_addr->un.ip6;
 576         len = sizeof (api_addr->un.ip6);
 577       }
 578     else
 579       {
 580         api_addr->af = ADDRESS_IP4;
 581         src = &ip_addr->ip4;
 582         dst = &api_addr->un.ip4;
 583         len = sizeof (api_addr->un.ip4);
 584       }
 585     clib_memcpy (dst, src, len);
 586     api_addr++;
 587   }
 588
 589   /* send it... */
 590   S (mp);
 591
 592   /* Wait for a reply... */
 593   W (ret);
 594
 595 done:
 596   vec_free (ip_addrs);
 597
 598   return ret;
 599 }
 600
 601 static int
 602 api_vrrp_vr_peer_dump (vat_main_t * vam)
 603 {
 604   vrrp_test_main_t *vtm = &vrrp_test_main;
 605   unformat_input_t *i = vam->input;
 606   vl_api_vrrp_vr_peer_dump_t *mp;
 607   vl_api_control_ping_t *mp_ping;
 608   u32 sw_if_index = ~0, vr_id = 0;
 609   u8 is_ipv6 = 0;
 610   int ret;
 611
 612   if (vam->json_output)
 613     {
 614       clib_warning ("JSON output not supported for vrrp_vr_track_if_dump");
 615       return -99;
 616     }
 617
 618   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 619     {
 620       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
 621         ;
 622       else if (unformat (i, "sw_if_index %u", &sw_if_index))
 623         ;
 624       else if (unformat (i, "vr_id %u", &vr_id))
 625         ;
 626       else if (unformat (i, "ipv6"))
 627         is_ipv6 = 1;
 628       else
 629         break;
 630     }
 631
 632   /* sw_if_index and vr_id must be valid */
 633   if (sw_if_index == ~0)
 634     {
 635       errmsg ("VR interface not specified\n");
 636       return -99;
 637     }
 638   else if (!vr_id)
 639     {
 640       errmsg ("Invalid VR ID - must be between 1 and 255");
 641       return -99;
 642     }
 643
 644   M (VRRP_VR_PEER_DUMP, mp);
 645
 646   mp->sw_if_index = htonl (sw_if_index);
 647   mp->vr_id = vr_id;
 648   mp->is_ipv6 = is_ipv6;
 649
 650   S (mp);
 651
 652   mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
 653   mp_ping->_vl_msg_id = htons (vtm->ping_id);
 654   mp_ping->client_index = vam->my_client_index;
 655
 656   vam->result_ready = 0;
 657   S (mp_ping);
 658
 659   W (ret);
 660   return ret;
 661 }
 662
 663 static void
 664 vl_api_vrrp_vr_peer_details_t_handler (vl_api_vrrp_vr_peer_details_t * mp)
 665 {
 666   vat_main_t *vam = vrrp_test_main.vat_main;
 667   int i;
 668
 669   fformat (vam->ofp, "sw_if_index %u vr_id %u IPv%d ",
 670            ntohl (mp->sw_if_index), mp->vr_id, (mp->is_ipv6) ? 6 : 4);
 671
 672   fformat (vam->ofp, "peer addresses: ");
 673
 674   for (i = 0; i < mp->n_peer_addrs; i++)
 675     {
 676       vl_api_address_t *addr = mp->peer_addrs + i;
 677
 678       fformat (vam->ofp, "%U ",
 679                (addr->af) ? format_ip6_address : format_ip4_address,
 680                (u8 *) & addr->un);
 681     }
 682
 683   fformat (vam->ofp, "\n");
 684 }
 685
 686 #include <vrrp/vrrp.api_test.c>
 687 /*
 688  * fd.io coding-style-patch-verification: ON
 689  *
 690  * Local Variables:
 691  * eval: (c-set-style "gnu")
 692  * End:
 693  */