3 * snat.c - skeleton vpp-api-test plug-in
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:
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
25 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
27 /* Declare message IDs */
28 #include <snat/snat_msg_enum.h>
30 /* define message structures */
32 #include <snat/snat_all_api_h.h>
35 /* declare message handlers for each api */
37 #define vl_endianfun /* define message structures */
38 #include <snat/snat_all_api_h.h>
41 /* instantiate all the print functions we know about */
42 #define vl_print(handle, ...)
44 #include <snat/snat_all_api_h.h>
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>
53 /* API message ID base */
58 snat_test_main_t snat_test_main;
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 _(snat_add_del_interface_addr_reply)
68 static void vl_api_##n##_t_handler \
69 (vl_api_##n##_t * mp) \
71 vat_main_t * vam = snat_test_main.vat_main; \
72 i32 retval = ntohl(mp->retval); \
73 if (vam->async_mode) { \
74 vam->async_errors += (retval < 0); \
76 vam->retval = retval; \
77 vam->result_ready = 1; \
80 foreach_standard_reply_retval_handler;
84 * Table of message reply handlers, must include boilerplate handlers
87 #define foreach_vpe_api_reply_msg \
88 _(SNAT_ADD_ADDRESS_RANGE_REPLY, snat_add_address_range_reply) \
89 _(SNAT_INTERFACE_ADD_DEL_FEATURE_REPLY, \
90 snat_interface_add_del_feature_reply) \
91 _(SNAT_ADD_STATIC_MAPPING_REPLY, snat_add_static_mapping_reply) \
92 _(SNAT_CONTROL_PING_REPLY, snat_control_ping_reply) \
93 _(SNAT_STATIC_MAPPING_DETAILS, snat_static_mapping_details) \
94 _(SNAT_SHOW_CONFIG_REPLY, snat_show_config_reply) \
95 _(SNAT_ADDRESS_DETAILS, snat_address_details) \
96 _(SNAT_INTERFACE_DETAILS, snat_interface_details) \
97 _(SNAT_SET_WORKERS_REPLY, snat_set_workers_reply) \
98 _(SNAT_WORKER_DETAILS, snat_worker_details) \
99 _(SNAT_ADD_DEL_INTERFACE_ADDR_REPLY, \
100 snat_add_del_interface_addr_reply) \
101 _(SNAT_INTERFACE_ADDR_DETAILS, snat_interface_addr_details)
103 /* M: construct, but don't yet send a message */
106 vam->result_ready = 0; \
107 mp = vl_msg_api_alloc(sizeof(*mp)); \
108 memset (mp, 0, sizeof (*mp)); \
109 mp->_vl_msg_id = ntohs (VL_API_##T + sm->msg_id_base); \
110 mp->client_index = vam->my_client_index; \
115 vam->result_ready = 0; \
116 mp = vl_msg_api_alloc(sizeof(*mp)+(n)); \
117 memset (mp, 0, sizeof (*mp)); \
118 mp->_vl_msg_id = ntohs (VL_API_##T + sm->msg_id_base); \
119 mp->client_index = vam->my_client_index; \
122 /* S: send a message */
123 #define S (vl_msg_api_send_shmem (vam->vl_input_queue, (u8 *)&mp))
125 /* W: wait for results, with timeout */
128 timeout = vat_time_now (vam) + 1.0; \
130 while (vat_time_now (vam) < timeout) { \
131 if (vam->result_ready == 1) { \
132 return (vam->retval); \
138 static int api_snat_add_address_range (vat_main_t * vam)
140 snat_test_main_t * sm = &snat_test_main;
141 unformat_input_t * i = vam->input;
143 ip4_address_t start_addr, end_addr;
144 u32 start_host_order, end_host_order;
145 vl_api_snat_add_address_range_t * mp;
149 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
151 if (unformat (i, "%U - %U",
152 unformat_ip4_address, &start_addr,
153 unformat_ip4_address, &end_addr))
155 else if (unformat (i, "%U", unformat_ip4_address, &start_addr))
156 end_addr = start_addr;
157 else if (unformat (i, "del"))
161 clib_warning("unknown input '%U'", format_unformat_error, i);
166 start_host_order = clib_host_to_net_u32 (start_addr.as_u32);
167 end_host_order = clib_host_to_net_u32 (end_addr.as_u32);
169 if (end_host_order < start_host_order)
171 errmsg ("end address less than start address\n");
175 count = (end_host_order - start_host_order) + 1;
179 errmsg ("%U - %U, %d addresses...\n",
180 format_ip4_address, &start_addr,
181 format_ip4_address, &end_addr,
185 M(SNAT_ADD_ADDRESS_RANGE, snat_add_address_range);
187 memcpy (mp->first_ip_address, &start_addr, 4);
188 memcpy (mp->last_ip_address, &end_addr, 4);
198 static int api_snat_interface_add_del_feature (vat_main_t * vam)
200 snat_test_main_t * sm = &snat_test_main;
201 unformat_input_t * i = vam->input;
203 vl_api_snat_interface_add_del_feature_t * mp;
205 u8 sw_if_index_set = 0;
209 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
211 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
213 else if (unformat (i, "sw_if_index %d", &sw_if_index))
215 else if (unformat (i, "out"))
217 else if (unformat (i, "in"))
219 else if (unformat (i, "del"))
223 clib_warning("unknown input '%U'", format_unformat_error, i);
228 if (sw_if_index_set == 0)
230 errmsg ("interface / sw_if_index required\n");
234 M(SNAT_INTERFACE_ADD_DEL_FEATURE, snat_interface_add_del_feature);
235 mp->sw_if_index = ntohl(sw_if_index);
237 mp->is_inside = is_inside;
244 static int api_snat_add_static_mapping(vat_main_t * vam)
246 snat_test_main_t * sm = &snat_test_main;
247 unformat_input_t * i = vam->input;
249 vl_api_snat_add_static_mapping_t * mp;
253 ip4_address_t local_addr, external_addr;
254 u32 local_port = 0, external_port = 0, vrf_id = ~0;
256 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
258 if (unformat (i, "local_addr %U", unformat_ip4_address, &local_addr))
260 else if (unformat (i, "external_addr %U", unformat_ip4_address,
263 else if (unformat (i, "local_port %u", &local_port))
265 else if (unformat (i, "external_port %u", &external_port))
267 else if (unformat (i, "vrf %u", &vrf_id))
269 else if (unformat (i, "del"))
273 clib_warning("unknown input '%U'", format_unformat_error, i);
280 errmsg ("local_addr and remote_addr required\n");
284 M(SNAT_ADD_STATIC_MAPPING, snat_add_static_mapping);
287 mp->addr_only = addr_only;
288 mp->local_port = ntohs ((u16) local_port);
289 mp->external_port = ntohs ((u16) external_port);
290 mp->vrf_id = ntohl (vrf_id);
291 memcpy (mp->local_ip_address, &local_addr, 4);
292 memcpy (mp->external_ip_address, &external_addr, 4);
299 static void vl_api_snat_control_ping_reply_t_handler
300 (vl_api_snat_control_ping_reply_t * mp)
302 vat_main_t *vam = &vat_main;
303 i32 retval = ntohl (mp->retval);
306 vam->async_errors += (retval < 0);
310 vam->retval = retval;
311 vam->result_ready = 1;
315 static void vl_api_snat_static_mapping_details_t_handler
316 (vl_api_snat_static_mapping_details_t *mp)
318 snat_test_main_t * sm = &snat_test_main;
319 vat_main_t *vam = sm->vat_main;
322 fformat (vam->ofp, "%15U%6s%15U%6s%11d\n",
323 format_ip4_address, &mp->local_ip_address, "",
324 format_ip4_address, &mp->external_ip_address, "",
327 fformat (vam->ofp, "%15U%6d%15U%6d%11d\n",
328 format_ip4_address, &mp->local_ip_address,
329 ntohs (mp->local_port),
330 format_ip4_address, &mp->external_ip_address,
331 ntohs (mp->external_port),
336 static int api_snat_static_mapping_dump(vat_main_t * vam)
338 snat_test_main_t * sm = &snat_test_main;
340 vl_api_snat_static_mapping_dump_t * mp;
342 if (vam->json_output)
344 clib_warning ("JSON output not supported for snat_static_mapping_dump");
348 fformat (vam->ofp, "%21s%21s\n", "local", "external");
349 fformat (vam->ofp, "%15s%6s%15s%6s%11s\n", "address", "port", "address",
352 M(SNAT_STATIC_MAPPING_DUMP, snat_static_mapping_dump);
354 /* Use a control ping for synchronization */
356 vl_api_snat_control_ping_t *mp;
357 M (SNAT_CONTROL_PING, snat_control_ping);
365 static void vl_api_snat_show_config_reply_t_handler
366 (vl_api_snat_show_config_reply_t *mp)
368 snat_test_main_t * sm = &snat_test_main;
369 vat_main_t *vam = sm->vat_main;
370 i32 retval = ntohl (mp->retval);
374 fformat (vam->ofp, "translation hash buckets %d\n",
375 ntohl (mp->translation_buckets));
376 fformat (vam->ofp, "translation hash memory %d\n",
377 ntohl (mp->translation_memory_size));
378 fformat (vam->ofp, "user hash buckets %d\n", ntohl (mp->user_buckets));
379 fformat (vam->ofp, "user hash memory %d\n", ntohl (mp->user_memory_size));
380 fformat (vam->ofp, "max translations per user %d\n",
381 ntohl (mp->max_translations_per_user));
382 fformat (vam->ofp, "outside VRF id %d\n", ntohl (mp->outside_vrf_id));
383 fformat (vam->ofp, "inside VRF id %d\n", ntohl (mp->inside_vrf_id));
384 if (mp->static_mapping_only)
386 fformat (vam->ofp, "static mapping only");
387 if (mp->static_mapping_connection_tracking)
388 fformat (vam->ofp, " connection tracking");
389 fformat (vam->ofp, "\n");
392 vam->retval = retval;
393 vam->result_ready = 1;
396 static int api_snat_show_config(vat_main_t * vam)
398 snat_test_main_t * sm = &snat_test_main;
400 vl_api_snat_show_config_t * mp;
402 if (vam->json_output)
404 clib_warning ("JSON output not supported for snat_show_config");
408 M(SNAT_SHOW_CONFIG, snat_show_config);
414 static void vl_api_snat_address_details_t_handler
415 (vl_api_snat_address_details_t *mp)
417 snat_test_main_t * sm = &snat_test_main;
418 vat_main_t *vam = sm->vat_main;
420 fformat (vam->ofp, "%U\n", format_ip4_address, &mp->ip_address);
423 static int api_snat_address_dump(vat_main_t * vam)
425 snat_test_main_t * sm = &snat_test_main;
427 vl_api_snat_address_dump_t * mp;
429 if (vam->json_output)
431 clib_warning ("JSON output not supported for snat_address_dump");
435 M(SNAT_ADDRESS_DUMP, snat_address_dump);
437 /* Use a control ping for synchronization */
439 vl_api_snat_control_ping_t *mp;
440 M (SNAT_CONTROL_PING, snat_control_ping);
448 static void vl_api_snat_interface_details_t_handler
449 (vl_api_snat_interface_details_t *mp)
451 snat_test_main_t * sm = &snat_test_main;
452 vat_main_t *vam = sm->vat_main;
454 fformat (vam->ofp, "sw_if_index %d %s\n", ntohl (mp->sw_if_index),
455 mp->is_inside ? "in" : "out");
458 static int api_snat_interface_dump(vat_main_t * vam)
460 snat_test_main_t * sm = &snat_test_main;
462 vl_api_snat_interface_dump_t * mp;
464 if (vam->json_output)
466 clib_warning ("JSON output not supported for snat_address_dump");
470 M(SNAT_INTERFACE_DUMP, snat_interface_dump);
472 /* Use a control ping for synchronization */
474 vl_api_snat_control_ping_t *mp;
475 M (SNAT_CONTROL_PING, snat_control_ping);
483 static int api_snat_set_workers (vat_main_t * vam)
485 snat_test_main_t * sm = &snat_test_main;
486 unformat_input_t * i = vam->input;
488 vl_api_snat_set_workers_t * mp;
491 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
493 if (unformat (i, "%U", unformat_bitmap_list, &bitmap))
497 clib_warning("unknown input '%U'", format_unformat_error, i);
502 M(SNAT_SET_WORKERS, snat_set_workers);
503 mp->worker_mask = clib_host_to_net_u64 (bitmap[0]);
511 static void vl_api_snat_worker_details_t_handler
512 (vl_api_snat_worker_details_t *mp)
514 snat_test_main_t * sm = &snat_test_main;
515 vat_main_t *vam = sm->vat_main;
517 fformat (vam->ofp, "worker_index %d (%s at lcore %u)\n",
518 ntohl (mp->worker_index), mp->name, ntohl (mp->lcore_id));
521 static int api_snat_worker_dump(vat_main_t * vam)
523 snat_test_main_t * sm = &snat_test_main;
525 vl_api_snat_worker_dump_t * mp;
527 if (vam->json_output)
529 clib_warning ("JSON output not supported for snat_address_dump");
533 M(SNAT_WORKER_DUMP, snat_worker_dump);
535 /* Use a control ping for synchronization */
537 vl_api_snat_control_ping_t *mp;
538 M (SNAT_CONTROL_PING, snat_control_ping);
546 static int api_snat_add_del_interface_addr (vat_main_t * vam)
548 snat_test_main_t * sm = &snat_test_main;
549 unformat_input_t * i = vam->input;
551 vl_api_snat_add_del_interface_addr_t * mp;
553 u8 sw_if_index_set = 0;
556 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
558 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
560 else if (unformat (i, "sw_if_index %d", &sw_if_index))
562 else if (unformat (i, "del"))
566 clib_warning("unknown input '%U'", format_unformat_error, i);
571 if (sw_if_index_set == 0)
573 errmsg ("interface / sw_if_index required\n");
577 M(SNAT_ADD_DEL_INTERFACE_ADDR, snat_add_del_interface_addr);
578 mp->sw_if_index = ntohl(sw_if_index);
586 static void vl_api_snat_interface_addr_details_t_handler
587 (vl_api_snat_interface_addr_details_t *mp)
589 snat_test_main_t * sm = &snat_test_main;
590 vat_main_t *vam = sm->vat_main;
592 fformat (vam->ofp, "sw_if_index %d\n", ntohl (mp->sw_if_index));
595 static int api_snat_interface_addr_dump(vat_main_t * vam)
597 snat_test_main_t * sm = &snat_test_main;
599 vl_api_snat_interface_addr_dump_t * mp;
601 if (vam->json_output)
603 clib_warning ("JSON output not supported for snat_address_dump");
607 M(SNAT_INTERFACE_ADDR_DUMP, snat_interface_addr_dump);
609 /* Use a control ping for synchronization */
611 vl_api_snat_control_ping_t *mp;
612 M (SNAT_CONTROL_PING, snat_control_ping);
621 * List of messages that the api test plugin sends,
622 * and that the data plane plugin processes
624 #define foreach_vpe_api_msg \
625 _(snat_add_address_range, "<start-addr> [- <end-addr] [del]") \
626 _(snat_interface_add_del_feature, \
627 "<intfc> | sw_if_index <id> [in] [out] [del]") \
628 _(snat_add_static_mapping, "local_addr <ip> external_addr <ip> " \
629 "[local_port <n>] [external_port <n>] [vrf <table-id>] [del]") \
630 _(snat_set_workers, "<wokrers_bitmap>") \
631 _(snat_static_mapping_dump, "") \
632 _(snat_show_config, "") \
633 _(snat_address_dump, "") \
634 _(snat_interface_dump, "") \
635 _(snat_worker_dump, "") \
636 _(snat_add_del_interface_addr, \
637 "<intfc> | sw_if_index <id> [del]") \
638 _(snat_interface_addr_dump, "")
640 void vat_api_hookup (vat_main_t *vam)
642 snat_test_main_t * sm __attribute__((unused)) = &snat_test_main;
643 /* Hook up handlers for replies from the data plane plug-in */
645 vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base), \
647 vl_api_##n##_t_handler, \
649 vl_api_##n##_t_endian, \
650 vl_api_##n##_t_print, \
651 sizeof(vl_api_##n##_t), 1);
652 foreach_vpe_api_reply_msg;
655 /* API messages we can send */
656 #define _(n,h) hash_set_mem (vam->function_by_name, #n, api_##n);
661 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
666 clib_error_t * vat_plugin_register (vat_main_t *vam)
668 snat_test_main_t * sm = &snat_test_main;
673 /* Ask the vpp engine for the first assigned message-id */
674 name = format (0, "snat_%08x%c", api_version, 0);
675 sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
677 if (sm->msg_id_base != (u16) ~0)
678 vat_api_hookup (vam);