plugins/snat-plugin/snat/snat_test.c

   1
   2 /*
   3  * snat.c - skeleton vpp-api-test plug-in
   4  *
   5  * Copyright (c) <current-year> <your-organization>
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 #include <vat/vat.h>
  19 #include <vlibapi/api.h>
  20 #include <vlibmemory/api.h>
  21 #include <vlibsocket/api.h>
  22 #include <vppinfra/error.h>
  23 #include <vnet/ip/ip.h>
  24
  25 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
  26
  27 /* Declare message IDs */
  28 #include <snat/snat_msg_enum.h>
  29
  30 /* define message structures */
  31 #define vl_typedefs
  32 #include <snat/snat_all_api_h.h>
  33 #undef vl_typedefs
  34
  35 /* declare message handlers for each api */
  36
  37 #define vl_endianfun             /* define message structures */
  38 #include <snat/snat_all_api_h.h>
  39 #undef vl_endianfun
  40
  41 /* instantiate all the print functions we know about */
  42 #define vl_print(handle, ...)
  43 #define vl_printfun
  44 #include <snat/snat_all_api_h.h>
  45 #undef vl_printfun
  46
  47 /* Get the API version number. */
  48 #define vl_api_version(n,v) static u32 api_version=(v);
  49 #include <snat/snat_all_api_h.h>
  50 #undef vl_api_version
  51
  52 typedef struct {
  53     /* API message ID base */
  54     u16 msg_id_base;
  55     vat_main_t *vat_main;
  56 } snat_test_main_t;
  57
  58 snat_test_main_t snat_test_main;
  59
  60 #define foreach_standard_reply_retval_handler   \
  61 _(snat_add_address_range_reply)                 \
  62 _(snat_interface_add_del_feature_reply)         \
  63 _(snat_add_static_mapping_reply)                \
  64 _(snat_set_workers_reply)
  65
  66 #define _(n)                                            \
  67     static void vl_api_##n##_t_handler                  \
  68     (vl_api_##n##_t * mp)                               \
  69     {                                                   \
  70         vat_main_t * vam = snat_test_main.vat_main;   \
  71         i32 retval = ntohl(mp->retval);                 \
  72         if (vam->async_mode) {                          \
  73             vam->async_errors += (retval < 0);          \
  74         } else {                                        \
  75             vam->retval = retval;                       \
  76             vam->result_ready = 1;                      \
  77         }                                               \
  78     }
  79 foreach_standard_reply_retval_handler;
  80 #undef _
  81
  82 /*
  83  * Table of message reply handlers, must include boilerplate handlers
  84  * we just generated
  85  */
  86 #define foreach_vpe_api_reply_msg                               \
  87 _(SNAT_ADD_ADDRESS_RANGE_REPLY, snat_add_address_range_reply)   \
  88 _(SNAT_INTERFACE_ADD_DEL_FEATURE_REPLY,                         \
  89   snat_interface_add_del_feature_reply)                         \
  90 _(SNAT_ADD_STATIC_MAPPING_REPLY, snat_add_static_mapping_reply) \
  91 _(SNAT_CONTROL_PING_REPLY, snat_control_ping_reply)             \
  92 _(SNAT_STATIC_MAPPING_DETAILS, snat_static_mapping_details)     \
  93 _(SNAT_SHOW_CONFIG_REPLY, snat_show_config_reply)               \
  94 _(SNAT_ADDRESS_DETAILS, snat_address_details)                   \
  95 _(SNAT_INTERFACE_DETAILS, snat_interface_details)               \
  96 _(SNAT_SET_WORKERS_REPLY, snat_set_workers_reply)               \
  97 _(SNAT_WORKER_DETAILS, snat_worker_details)
  98
  99 /* M: construct, but don't yet send a message */
 100 #define M(T,t)                                                  \
 101 do {                                                            \
 102     vam->result_ready = 0;                                      \
 103     mp = vl_msg_api_alloc(sizeof(*mp));                         \
 104     memset (mp, 0, sizeof (*mp));                               \
 105     mp->_vl_msg_id = ntohs (VL_API_##T + sm->msg_id_base);      \
 106     mp->client_index = vam->my_client_index;                    \
 107 } while(0);
 108
 109 #define M2(T,t,n)                                               \
 110 do {                                                            \
 111     vam->result_ready = 0;                                      \
 112     mp = vl_msg_api_alloc(sizeof(*mp)+(n));                     \
 113     memset (mp, 0, sizeof (*mp));                               \
 114     mp->_vl_msg_id = ntohs (VL_API_##T + sm->msg_id_base);      \
 115     mp->client_index = vam->my_client_index;                    \
 116 } while(0);
 117
 118 /* S: send a message */
 119 #define S (vl_msg_api_send_shmem (vam->vl_input_queue, (u8 *)&mp))
 120
 121 /* W: wait for results, with timeout */
 122 #define W                                       \
 123 do {                                            \
 124     timeout = vat_time_now (vam) + 1.0;         \
 125                                                 \
 126     while (vat_time_now (vam) < timeout) {      \
 127         if (vam->result_ready == 1) {           \
 128             return (vam->retval);               \
 129         }                                       \
 130     }                                           \
 131     return -99;                                 \
 132 } while(0);
 133
 134 static int api_snat_add_address_range (vat_main_t * vam)
 135 {
 136   snat_test_main_t * sm = &snat_test_main;
 137   unformat_input_t * i = vam->input;
 138   f64 timeout;
 139   ip4_address_t start_addr, end_addr;
 140   u32 start_host_order, end_host_order;
 141   vl_api_snat_add_address_range_t * mp;
 142   u8 is_add = 1;
 143   int count;
 144
 145   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 146     {
 147       if (unformat (i, "%U - %U",
 148                     unformat_ip4_address, &start_addr,
 149                     unformat_ip4_address, &end_addr))
 150         ;
 151       else if (unformat (i, "%U", unformat_ip4_address, &start_addr))
 152         end_addr = start_addr;
 153       else if (unformat (i, "del"))
 154         is_add = 0;
 155       else
 156         {
 157           clib_warning("unknown input '%U'", format_unformat_error, i);
 158           return -99;
 159         }
 160     }
 161
 162   start_host_order = clib_host_to_net_u32 (start_addr.as_u32);
 163   end_host_order = clib_host_to_net_u32 (end_addr.as_u32);
 164
 165   if (end_host_order < start_host_order)
 166     {
 167       errmsg ("end address less than start address\n");
 168       return -99;
 169     }
 170
 171   count = (end_host_order - start_host_order) + 1;
 172
 173   if (count > 1024)
 174     {
 175     errmsg ("%U - %U, %d addresses...\n",
 176            format_ip4_address, &start_addr,
 177            format_ip4_address, &end_addr,
 178            count);
 179     }
 180
 181   M(SNAT_ADD_ADDRESS_RANGE, snat_add_address_range);
 182
 183   memcpy (mp->first_ip_address, &start_addr, 4);
 184   memcpy (mp->last_ip_address, &end_addr, 4);
 185   mp->is_ip4 = 1;
 186   mp->is_add = is_add;
 187
 188   S; W;
 189
 190   /* NOTREACHED */
 191   return 0;
 192 }
 193
 194 static int api_snat_interface_add_del_feature (vat_main_t * vam)
 195 {
 196   snat_test_main_t * sm = &snat_test_main;
 197   unformat_input_t * i = vam->input;
 198   f64 timeout;
 199   vl_api_snat_interface_add_del_feature_t * mp;
 200   u32 sw_if_index;
 201   u8 sw_if_index_set = 0;
 202   u8 is_inside = 1;
 203   u8 is_add = 1;
 204
 205   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 206     {
 207       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
 208         sw_if_index_set = 1;
 209       else if (unformat (i, "sw_if_index %d", &sw_if_index))
 210         sw_if_index_set = 1;
 211       else if (unformat (i, "out"))
 212         is_inside = 0;
 213       else if (unformat (i, "in"))
 214         is_inside = 1;
 215       else if (unformat (i, "del"))
 216         is_add = 0;
 217       else
 218         {
 219           clib_warning("unknown input '%U'", format_unformat_error, i);
 220           return -99;
 221         }
 222     }
 223
 224   if (sw_if_index_set == 0)
 225     {
 226       errmsg ("interface / sw_if_index required\n");
 227       return -99;
 228     }
 229
 230   M(SNAT_INTERFACE_ADD_DEL_FEATURE, snat_interface_add_del_feature);
 231   mp->sw_if_index = ntohl(sw_if_index);
 232   mp->is_add = is_add;
 233   mp->is_inside = is_inside;
 234
 235   S; W;
 236   /* NOTREACHED */
 237   return 0;
 238 }
 239
 240 static int api_snat_add_static_mapping(vat_main_t * vam)
 241 {
 242   snat_test_main_t * sm = &snat_test_main;
 243   unformat_input_t * i = vam->input;
 244   f64 timeout;
 245   vl_api_snat_add_static_mapping_t * mp;
 246   u8 addr_set_n = 0;
 247   u8 is_add = 1;
 248   u8 addr_only = 1;
 249   ip4_address_t local_addr, external_addr;
 250   u32 local_port = 0, external_port = 0, vrf_id = ~0;
 251
 252   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 253     {
 254       if (unformat (i, "local_addr %U", unformat_ip4_address, &local_addr))
 255         addr_set_n++;
 256       else if (unformat (i, "external_addr %U", unformat_ip4_address,
 257                          &external_addr))
 258         addr_set_n++;
 259       else if (unformat (i, "local_port %u", &local_port))
 260         addr_only = 0;
 261       else if (unformat (i, "external_port %u", &external_port))
 262         addr_only = 0;
 263       else if (unformat (i, "vrf %u", &vrf_id))
 264         ;
 265       else if (unformat (i, "del"))
 266         is_add = 0;
 267       else
 268         {
 269           clib_warning("unknown input '%U'", format_unformat_error, i);
 270           return -99;
 271         }
 272     }
 273
 274   if (addr_set_n != 2)
 275     {
 276       errmsg ("local_addr and remote_addr required\n");
 277       return -99;
 278     }
 279
 280   M(SNAT_ADD_STATIC_MAPPING, snat_add_static_mapping);
 281   mp->is_add = is_add;
 282   mp->is_ip4 = 1;
 283   mp->addr_only = addr_only;
 284   mp->local_port = ntohs ((u16) local_port);
 285   mp->external_port = ntohs ((u16) external_port);
 286   mp->vrf_id = ntohl (vrf_id);
 287   memcpy (mp->local_ip_address, &local_addr, 4);
 288   memcpy (mp->external_ip_address, &external_addr, 4);
 289
 290   S; W;
 291   /* NOTREACHED */
 292   return 0;
 293 }
 294
 295 static void vl_api_snat_control_ping_reply_t_handler
 296   (vl_api_snat_control_ping_reply_t * mp)
 297 {
 298   vat_main_t *vam = &vat_main;
 299   i32 retval = ntohl (mp->retval);
 300   if (vam->async_mode)
 301     {
 302       vam->async_errors += (retval < 0);
 303     }
 304   else
 305     {
 306       vam->retval = retval;
 307       vam->result_ready = 1;
 308     }
 309 }
 310
 311 static void vl_api_snat_static_mapping_details_t_handler
 312   (vl_api_snat_static_mapping_details_t *mp)
 313 {
 314   snat_test_main_t * sm = &snat_test_main;
 315   vat_main_t *vam = sm->vat_main;
 316
 317   if (mp->addr_only)
 318       fformat (vam->ofp, "%15U%6s%15U%6s%11d\n",
 319                format_ip4_address, &mp->local_ip_address, "",
 320                format_ip4_address, &mp->external_ip_address, "",
 321                ntohl (mp->vrf_id));
 322   else
 323       fformat (vam->ofp, "%15U%6d%15U%6d%11d\n",
 324                format_ip4_address, &mp->local_ip_address,
 325                ntohs (mp->local_port),
 326                format_ip4_address, &mp->external_ip_address,
 327                ntohs (mp->external_port),
 328                ntohl (mp->vrf_id));
 329
 330 }
 331
 332 static int api_snat_static_mapping_dump(vat_main_t * vam)
 333 {
 334   snat_test_main_t * sm = &snat_test_main;
 335   f64 timeout;
 336   vl_api_snat_static_mapping_dump_t * mp;
 337
 338   if (vam->json_output)
 339     {
 340       clib_warning ("JSON output not supported for snat_static_mapping_dump");
 341       return -99;
 342     }
 343
 344   fformat (vam->ofp, "%21s%21s\n", "local", "external");
 345   fformat (vam->ofp, "%15s%6s%15s%6s%11s\n", "address", "port", "address",
 346            "port", "vrf");
 347
 348   M(SNAT_STATIC_MAPPING_DUMP, snat_static_mapping_dump);
 349   S;
 350   /* Use a control ping for synchronization */
 351   {
 352     vl_api_snat_control_ping_t *mp;
 353     M (SNAT_CONTROL_PING, snat_control_ping);
 354     S;
 355   }
 356   W;
 357   /* NOTREACHED */
 358   return 0;
 359 }
 360
 361 static void vl_api_snat_show_config_reply_t_handler
 362   (vl_api_snat_show_config_reply_t *mp)
 363 {
 364   snat_test_main_t * sm = &snat_test_main;
 365   vat_main_t *vam = sm->vat_main;
 366   i32 retval = ntohl (mp->retval);
 367
 368   if (retval >= 0)
 369     {
 370       fformat (vam->ofp, "translation hash buckets %d\n",
 371                ntohl (mp->translation_buckets));
 372       fformat (vam->ofp, "translation hash memory %d\n",
 373                ntohl (mp->translation_memory_size));
 374       fformat (vam->ofp, "user hash buckets %d\n", ntohl (mp->user_buckets));
 375       fformat (vam->ofp, "user hash memory %d\n", ntohl (mp->user_memory_size));
 376       fformat (vam->ofp, "max translations per user %d\n",
 377                ntohl (mp->max_translations_per_user));
 378       fformat (vam->ofp, "outside VRF id %d\n", ntohl (mp->outside_vrf_id));
 379       fformat (vam->ofp, "inside VRF id %d\n", ntohl (mp->inside_vrf_id));
 380       if (mp->static_mapping_only)
 381         {
 382           fformat (vam->ofp, "static mapping only");
 383           if (mp->static_mapping_connection_tracking)
 384             fformat (vam->ofp, " connection tracking");
 385           fformat (vam->ofp, "\n");
 386         }
 387     }
 388   vam->retval = retval;
 389   vam->result_ready = 1;
 390 }
 391
 392 static int api_snat_show_config(vat_main_t * vam)
 393 {
 394   snat_test_main_t * sm = &snat_test_main;
 395   f64 timeout;
 396   vl_api_snat_show_config_t * mp;
 397
 398   if (vam->json_output)
 399     {
 400       clib_warning ("JSON output not supported for snat_show_config");
 401       return -99;
 402     }
 403
 404   M(SNAT_SHOW_CONFIG, snat_show_config);
 405   S; W;
 406   /* NOTREACHED */
 407   return 0;
 408 }
 409
 410 static void vl_api_snat_address_details_t_handler
 411   (vl_api_snat_address_details_t *mp)
 412 {
 413   snat_test_main_t * sm = &snat_test_main;
 414   vat_main_t *vam = sm->vat_main;
 415
 416   fformat (vam->ofp, "%U\n", format_ip4_address, &mp->ip_address);
 417 }
 418
 419 static int api_snat_address_dump(vat_main_t * vam)
 420 {
 421   snat_test_main_t * sm = &snat_test_main;
 422   f64 timeout;
 423   vl_api_snat_address_dump_t * mp;
 424
 425   if (vam->json_output)
 426     {
 427       clib_warning ("JSON output not supported for snat_address_dump");
 428       return -99;
 429     }
 430
 431   M(SNAT_ADDRESS_DUMP, snat_address_dump);
 432   S;
 433   /* Use a control ping for synchronization */
 434   {
 435     vl_api_snat_control_ping_t *mp;
 436     M (SNAT_CONTROL_PING, snat_control_ping);
 437     S;
 438   }
 439   W;
 440   /* NOTREACHED */
 441   return 0;
 442 }
 443
 444 static void vl_api_snat_interface_details_t_handler
 445   (vl_api_snat_interface_details_t *mp)
 446 {
 447   snat_test_main_t * sm = &snat_test_main;
 448   vat_main_t *vam = sm->vat_main;
 449
 450   fformat (vam->ofp, "sw_if_index %d %s\n", ntohl (mp->sw_if_index),
 451            mp->is_inside ? "in" : "out");
 452 }
 453
 454 static int api_snat_interface_dump(vat_main_t * vam)
 455 {
 456   snat_test_main_t * sm = &snat_test_main;
 457   f64 timeout;
 458   vl_api_snat_interface_dump_t * mp;
 459
 460   if (vam->json_output)
 461     {
 462       clib_warning ("JSON output not supported for snat_address_dump");
 463       return -99;
 464     }
 465
 466   M(SNAT_INTERFACE_DUMP, snat_interface_dump);
 467   S;
 468   /* Use a control ping for synchronization */
 469   {
 470     vl_api_snat_control_ping_t *mp;
 471     M (SNAT_CONTROL_PING, snat_control_ping);
 472     S;
 473   }
 474   W;
 475   /* NOTREACHED */
 476   return 0;
 477 }
 478
 479 static int api_snat_set_workers (vat_main_t * vam)
 480 {
 481   snat_test_main_t * sm = &snat_test_main;
 482   unformat_input_t * i = vam->input;
 483   f64 timeout;
 484   vl_api_snat_set_workers_t * mp;
 485   uword *bitmap;
 486
 487   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
 488     {
 489       if (unformat (i, "%U", unformat_bitmap_list, &bitmap))
 490         ;
 491       else
 492         {
 493           clib_warning("unknown input '%U'", format_unformat_error, i);
 494           return -99;
 495         }
 496     }
 497
 498   M(SNAT_SET_WORKERS, snat_set_workers);
 499   mp->worker_mask = clib_host_to_net_u64 (bitmap[0]);
 500
 501   S; W;
 502
 503   /* NOTREACHED */
 504   return 0;
 505 }
 506
 507 static void vl_api_snat_worker_details_t_handler
 508   (vl_api_snat_worker_details_t *mp)
 509 {
 510   snat_test_main_t * sm = &snat_test_main;
 511   vat_main_t *vam = sm->vat_main;
 512
 513   fformat (vam->ofp, "worker_index %d (%s at lcore %u)\n",
 514            ntohl (mp->worker_index), mp->name, ntohl (mp->lcore_id));
 515 }
 516
 517 static int api_snat_worker_dump(vat_main_t * vam)
 518 {
 519   snat_test_main_t * sm = &snat_test_main;
 520   f64 timeout;
 521   vl_api_snat_worker_dump_t * mp;
 522
 523   if (vam->json_output)
 524     {
 525       clib_warning ("JSON output not supported for snat_address_dump");
 526       return -99;
 527     }
 528
 529   M(SNAT_WORKER_DUMP, snat_worker_dump);
 530   S;
 531   /* Use a control ping for synchronization */
 532   {
 533     vl_api_snat_control_ping_t *mp;
 534     M (SNAT_CONTROL_PING, snat_control_ping);
 535     S;
 536   }
 537   W;
 538   /* NOTREACHED */
 539   return 0;
 540 }
 541
 542 /*
 543  * List of messages that the api test plugin sends,
 544  * and that the data plane plugin processes
 545  */
 546 #define foreach_vpe_api_msg                                      \
 547 _(snat_add_address_range, "<start-addr> [- <end-addr] [del]")    \
 548 _(snat_interface_add_del_feature,                                \
 549   "<intfc> | sw_if_index <id> [in] [out] [del]")                 \
 550 _(snat_add_static_mapping, "local_addr <ip> external_addr <ip> " \
 551   "[local_port <n>] [external_port <n>] [vrf <table-id>] [del]") \
 552 _(snat_set_workers, "<wokrers_bitmap>")                          \
 553 _(snat_static_mapping_dump, "")                                  \
 554 _(snat_show_config, "")                                          \
 555 _(snat_address_dump, "")                                         \
 556 _(snat_interface_dump, "")                                       \
 557 _(snat_worker_dump, "")
 558
 559 void vat_api_hookup (vat_main_t *vam)
 560 {
 561   snat_test_main_t * sm __attribute__((unused)) = &snat_test_main;
 562   /* Hook up handlers for replies from the data plane plug-in */
 563 #define _(N,n)                                                  \
 564   vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base),       \
 565                           #n,                                   \
 566                           vl_api_##n##_t_handler,               \
 567                           vl_noop_handler,                      \
 568                           vl_api_##n##_t_endian,                \
 569                           vl_api_##n##_t_print,                 \
 570                           sizeof(vl_api_##n##_t), 1);
 571   foreach_vpe_api_reply_msg;
 572 #undef _
 573
 574   /* API messages we can send */
 575 #define _(n,h) hash_set_mem (vam->function_by_name, #n, api_##n);
 576   foreach_vpe_api_msg;
 577 #undef _
 578
 579   /* Help strings */
 580 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
 581   foreach_vpe_api_msg;
 582 #undef _
 583 }
 584
 585 clib_error_t * vat_plugin_register (vat_main_t *vam)
 586 {
 587   snat_test_main_t * sm = &snat_test_main;
 588   u8 * name;
 589
 590   sm->vat_main = vam;
 591
 592   /* Ask the vpp engine for the first assigned message-id */
 593   name = format (0, "snat_%08x%c", api_version, 0);
 594   sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
 595
 596   if (sm->msg_id_base != (u16) ~0)
 597     vat_api_hookup (vam);
 598
 599   vec_free(name);
 600
 601   return 0;
 602 }