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>
24 #include <vlibapi/vat_helper_macros.h>
26 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
28 /* Declare message IDs */
29 #include <snat/snat_msg_enum.h>
31 /* define message structures */
33 #include <snat/snat_all_api_h.h>
36 /* declare message handlers for each api */
38 #define vl_endianfun /* define message structures */
39 #include <snat/snat_all_api_h.h>
42 /* instantiate all the print functions we know about */
43 #define vl_print(handle, ...)
45 #include <snat/snat_all_api_h.h>
48 /* Get the API version number. */
49 #define vl_api_version(n,v) static u32 api_version=(v);
50 #include <snat/snat_all_api_h.h>
54 /* API message ID base */
59 snat_test_main_t snat_test_main;
61 #define foreach_standard_reply_retval_handler \
62 _(snat_add_address_range_reply) \
63 _(snat_interface_add_del_feature_reply) \
64 _(snat_add_static_mapping_reply) \
65 _(snat_set_workers_reply) \
66 _(snat_add_del_interface_addr_reply) \
67 _(snat_ipfix_enable_disable_reply)
70 static void vl_api_##n##_t_handler \
71 (vl_api_##n##_t * mp) \
73 vat_main_t * vam = snat_test_main.vat_main; \
74 i32 retval = ntohl(mp->retval); \
75 if (vam->async_mode) { \
76 vam->async_errors += (retval < 0); \
78 vam->retval = retval; \
79 vam->result_ready = 1; \
82 foreach_standard_reply_retval_handler;
86 * Table of message reply handlers, must include boilerplate handlers
89 #define foreach_vpe_api_reply_msg \
90 _(SNAT_ADD_ADDRESS_RANGE_REPLY, snat_add_address_range_reply) \
91 _(SNAT_INTERFACE_ADD_DEL_FEATURE_REPLY, \
92 snat_interface_add_del_feature_reply) \
93 _(SNAT_ADD_STATIC_MAPPING_REPLY, snat_add_static_mapping_reply) \
94 _(SNAT_CONTROL_PING_REPLY, snat_control_ping_reply) \
95 _(SNAT_STATIC_MAPPING_DETAILS, snat_static_mapping_details) \
96 _(SNAT_SHOW_CONFIG_REPLY, snat_show_config_reply) \
97 _(SNAT_ADDRESS_DETAILS, snat_address_details) \
98 _(SNAT_INTERFACE_DETAILS, snat_interface_details) \
99 _(SNAT_SET_WORKERS_REPLY, snat_set_workers_reply) \
100 _(SNAT_WORKER_DETAILS, snat_worker_details) \
101 _(SNAT_ADD_DEL_INTERFACE_ADDR_REPLY, \
102 snat_add_del_interface_addr_reply) \
103 _(SNAT_INTERFACE_ADDR_DETAILS, snat_interface_addr_details) \
104 _(SNAT_IPFIX_ENABLE_DISABLE_REPLY, \
105 snat_ipfix_enable_disable_reply)
107 static int api_snat_add_address_range (vat_main_t * vam)
109 unformat_input_t * i = vam->input;
111 ip4_address_t start_addr, end_addr;
112 u32 start_host_order, end_host_order;
113 vl_api_snat_add_address_range_t * mp;
117 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
119 if (unformat (i, "%U - %U",
120 unformat_ip4_address, &start_addr,
121 unformat_ip4_address, &end_addr))
123 else if (unformat (i, "%U", unformat_ip4_address, &start_addr))
124 end_addr = start_addr;
125 else if (unformat (i, "del"))
129 clib_warning("unknown input '%U'", format_unformat_error, i);
134 start_host_order = clib_host_to_net_u32 (start_addr.as_u32);
135 end_host_order = clib_host_to_net_u32 (end_addr.as_u32);
137 if (end_host_order < start_host_order)
139 errmsg ("end address less than start address\n");
143 count = (end_host_order - start_host_order) + 1;
147 errmsg ("%U - %U, %d addresses...\n",
148 format_ip4_address, &start_addr,
149 format_ip4_address, &end_addr,
153 M(SNAT_ADD_ADDRESS_RANGE, snat_add_address_range);
155 memcpy (mp->first_ip_address, &start_addr, 4);
156 memcpy (mp->last_ip_address, &end_addr, 4);
166 static int api_snat_interface_add_del_feature (vat_main_t * vam)
168 unformat_input_t * i = vam->input;
170 vl_api_snat_interface_add_del_feature_t * mp;
172 u8 sw_if_index_set = 0;
176 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
178 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
180 else if (unformat (i, "sw_if_index %d", &sw_if_index))
182 else if (unformat (i, "out"))
184 else if (unformat (i, "in"))
186 else if (unformat (i, "del"))
190 clib_warning("unknown input '%U'", format_unformat_error, i);
195 if (sw_if_index_set == 0)
197 errmsg ("interface / sw_if_index required\n");
201 M(SNAT_INTERFACE_ADD_DEL_FEATURE, snat_interface_add_del_feature);
202 mp->sw_if_index = ntohl(sw_if_index);
204 mp->is_inside = is_inside;
211 static int api_snat_add_static_mapping(vat_main_t * vam)
213 unformat_input_t * i = vam->input;
215 vl_api_snat_add_static_mapping_t * mp;
216 u8 external_addr_set = 0;
220 ip4_address_t local_addr, external_addr;
221 u32 local_port = 0, external_port = 0, vrf_id = ~0;
222 u32 sw_if_index = ~0;
223 u8 sw_if_index_set = 0;
225 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
227 if (unformat (i, "local_addr %U", unformat_ip4_address, &local_addr))
229 else if (unformat (i, "external_addr %U", unformat_ip4_address,
231 external_addr_set = 1;
232 else if (unformat (i, "local_port %u", &local_port))
234 else if (unformat (i, "external_port %u", &external_port))
236 else if (unformat (i, "external_if %U", unformat_sw_if_index, vam,
239 else if (unformat (i, "external_sw_if_index %d", &sw_if_index))
241 else if (unformat (i, "vrf %u", &vrf_id))
243 else if (unformat (i, "del"))
247 clib_warning("unknown input '%U'", format_unformat_error, i);
254 errmsg ("local addr required\n");
257 if (!external_addr_set && !sw_if_index_set)
259 errmsg ("external addr or interface required\n");
263 M(SNAT_ADD_STATIC_MAPPING, snat_add_static_mapping);
266 mp->addr_only = addr_only;
267 mp->local_port = ntohs ((u16) local_port);
268 mp->external_port = ntohs ((u16) external_port);
269 mp->external_sw_if_index = ntohl (sw_if_index);
270 mp->vrf_id = ntohl (vrf_id);
271 memcpy (mp->local_ip_address, &local_addr, 4);
272 memcpy (mp->external_ip_address, &external_addr, 4);
279 static void vl_api_snat_control_ping_reply_t_handler
280 (vl_api_snat_control_ping_reply_t * mp)
282 vat_main_t *vam = &vat_main;
283 i32 retval = ntohl (mp->retval);
286 vam->async_errors += (retval < 0);
290 vam->retval = retval;
291 vam->result_ready = 1;
295 static void vl_api_snat_static_mapping_details_t_handler
296 (vl_api_snat_static_mapping_details_t *mp)
298 snat_test_main_t * sm = &snat_test_main;
299 vat_main_t *vam = sm->vat_main;
302 fformat (vam->ofp, "%15U%6s%15U%6s%11d\n",
303 format_ip4_address, &mp->local_ip_address, "",
304 format_ip4_address, &mp->external_ip_address, "",
307 fformat (vam->ofp, "%15U%6d%15U%6d%11d\n",
308 format_ip4_address, &mp->local_ip_address,
309 ntohs (mp->local_port),
310 format_ip4_address, &mp->external_ip_address,
311 ntohs (mp->external_port),
316 static int api_snat_static_mapping_dump(vat_main_t * vam)
319 vl_api_snat_static_mapping_dump_t * mp;
321 if (vam->json_output)
323 clib_warning ("JSON output not supported for snat_static_mapping_dump");
327 fformat (vam->ofp, "%21s%21s\n", "local", "external");
328 fformat (vam->ofp, "%15s%6s%15s%6s%11s\n", "address", "port", "address",
331 M(SNAT_STATIC_MAPPING_DUMP, snat_static_mapping_dump);
333 /* Use a control ping for synchronization */
335 vl_api_snat_control_ping_t *mp;
336 M (SNAT_CONTROL_PING, snat_control_ping);
344 static void vl_api_snat_show_config_reply_t_handler
345 (vl_api_snat_show_config_reply_t *mp)
347 snat_test_main_t * sm = &snat_test_main;
348 vat_main_t *vam = sm->vat_main;
349 i32 retval = ntohl (mp->retval);
353 fformat (vam->ofp, "translation hash buckets %d\n",
354 ntohl (mp->translation_buckets));
355 fformat (vam->ofp, "translation hash memory %d\n",
356 ntohl (mp->translation_memory_size));
357 fformat (vam->ofp, "user hash buckets %d\n", ntohl (mp->user_buckets));
358 fformat (vam->ofp, "user hash memory %d\n", ntohl (mp->user_memory_size));
359 fformat (vam->ofp, "max translations per user %d\n",
360 ntohl (mp->max_translations_per_user));
361 fformat (vam->ofp, "outside VRF id %d\n", ntohl (mp->outside_vrf_id));
362 fformat (vam->ofp, "inside VRF id %d\n", ntohl (mp->inside_vrf_id));
363 if (mp->static_mapping_only)
365 fformat (vam->ofp, "static mapping only");
366 if (mp->static_mapping_connection_tracking)
367 fformat (vam->ofp, " connection tracking");
368 fformat (vam->ofp, "\n");
371 vam->retval = retval;
372 vam->result_ready = 1;
375 static int api_snat_show_config(vat_main_t * vam)
378 vl_api_snat_show_config_t * mp;
380 if (vam->json_output)
382 clib_warning ("JSON output not supported for snat_show_config");
386 M(SNAT_SHOW_CONFIG, snat_show_config);
392 static void vl_api_snat_address_details_t_handler
393 (vl_api_snat_address_details_t *mp)
395 snat_test_main_t * sm = &snat_test_main;
396 vat_main_t *vam = sm->vat_main;
398 fformat (vam->ofp, "%U\n", format_ip4_address, &mp->ip_address);
401 static int api_snat_address_dump(vat_main_t * vam)
404 vl_api_snat_address_dump_t * mp;
406 if (vam->json_output)
408 clib_warning ("JSON output not supported for snat_address_dump");
412 M(SNAT_ADDRESS_DUMP, snat_address_dump);
414 /* Use a control ping for synchronization */
416 vl_api_snat_control_ping_t *mp;
417 M (SNAT_CONTROL_PING, snat_control_ping);
425 static void vl_api_snat_interface_details_t_handler
426 (vl_api_snat_interface_details_t *mp)
428 snat_test_main_t * sm = &snat_test_main;
429 vat_main_t *vam = sm->vat_main;
431 fformat (vam->ofp, "sw_if_index %d %s\n", ntohl (mp->sw_if_index),
432 mp->is_inside ? "in" : "out");
435 static int api_snat_interface_dump(vat_main_t * vam)
438 vl_api_snat_interface_dump_t * mp;
440 if (vam->json_output)
442 clib_warning ("JSON output not supported for snat_address_dump");
446 M(SNAT_INTERFACE_DUMP, snat_interface_dump);
448 /* Use a control ping for synchronization */
450 vl_api_snat_control_ping_t *mp;
451 M (SNAT_CONTROL_PING, snat_control_ping);
459 static int api_snat_set_workers (vat_main_t * vam)
461 unformat_input_t * i = vam->input;
463 vl_api_snat_set_workers_t * mp;
466 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
468 if (unformat (i, "%U", unformat_bitmap_list, &bitmap))
472 clib_warning("unknown input '%U'", format_unformat_error, i);
477 M(SNAT_SET_WORKERS, snat_set_workers);
478 mp->worker_mask = clib_host_to_net_u64 (bitmap[0]);
486 static void vl_api_snat_worker_details_t_handler
487 (vl_api_snat_worker_details_t *mp)
489 snat_test_main_t * sm = &snat_test_main;
490 vat_main_t *vam = sm->vat_main;
492 fformat (vam->ofp, "worker_index %d (%s at lcore %u)\n",
493 ntohl (mp->worker_index), mp->name, ntohl (mp->lcore_id));
496 static int api_snat_worker_dump(vat_main_t * vam)
499 vl_api_snat_worker_dump_t * mp;
501 if (vam->json_output)
503 clib_warning ("JSON output not supported for snat_address_dump");
507 M(SNAT_WORKER_DUMP, snat_worker_dump);
509 /* Use a control ping for synchronization */
511 vl_api_snat_control_ping_t *mp;
512 M (SNAT_CONTROL_PING, snat_control_ping);
520 static int api_snat_ipfix_enable_disable (vat_main_t * vam)
522 unformat_input_t * i = vam->input;
524 vl_api_snat_add_del_interface_addr_t * mp;
526 u8 sw_if_index_set = 0;
529 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
531 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
533 else if (unformat (i, "sw_if_index %d", &sw_if_index))
535 else if (unformat (i, "del"))
539 clib_warning("unknown input '%U'", format_unformat_error, i);
544 if (sw_if_index_set == 0)
546 errmsg ("interface / sw_if_index required\n");
550 M(SNAT_ADD_DEL_INTERFACE_ADDR, snat_add_del_interface_addr);
551 mp->sw_if_index = ntohl(sw_if_index);
559 static void vl_api_snat_interface_addr_details_t_handler
560 (vl_api_snat_interface_addr_details_t *mp)
562 snat_test_main_t * sm = &snat_test_main;
563 vat_main_t *vam = sm->vat_main;
565 fformat (vam->ofp, "sw_if_index %d\n", ntohl (mp->sw_if_index));
568 static int api_snat_interface_addr_dump(vat_main_t * vam)
571 vl_api_snat_interface_addr_dump_t * mp;
573 if (vam->json_output)
575 clib_warning ("JSON output not supported for snat_address_dump");
579 M(SNAT_INTERFACE_ADDR_DUMP, snat_interface_addr_dump);
581 /* Use a control ping for synchronization */
583 vl_api_snat_control_ping_t *mp;
584 M (SNAT_CONTROL_PING, snat_control_ping);
592 static int api_snat_add_del_interface_addr (vat_main_t * vam)
594 unformat_input_t * i = vam->input;
596 vl_api_snat_ipfix_enable_disable_t * mp;
601 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
603 if (unformat (i, "domain %d", &domain_id))
605 else if (unformat (i, "src_port %d", &src_port))
607 else if (unformat (i, "disable"))
611 clib_warning("unknown input '%U'", format_unformat_error, i);
616 M(SNAT_IPFIX_ENABLE_DISABLE, snat_ipfix_enable_disable);
617 mp->domain_id = htonl(domain_id);
618 mp->src_port = htons((u16) src_port);
627 * List of messages that the api test plugin sends,
628 * and that the data plane plugin processes
630 #define foreach_vpe_api_msg \
631 _(snat_add_address_range, "<start-addr> [- <end-addr] [del]") \
632 _(snat_interface_add_del_feature, \
633 "<intfc> | sw_if_index <id> [in] [out] [del]") \
634 _(snat_add_static_mapping, "local_addr <ip> external_addr <ip> " \
635 "| external_if <intfc> | external_sw_if_ndex <id>) " \
636 "[local_port <n>] [external_port <n>] [vrf <table-id>] [del]") \
637 _(snat_set_workers, "<wokrers_bitmap>") \
638 _(snat_static_mapping_dump, "") \
639 _(snat_show_config, "") \
640 _(snat_address_dump, "") \
641 _(snat_interface_dump, "") \
642 _(snat_worker_dump, "") \
643 _(snat_add_del_interface_addr, \
644 "<intfc> | sw_if_index <id> [del]") \
645 _(snat_interface_addr_dump, "") \
646 _(snat_ipfix_enable_disable, "[domain <id>] [src_port <n>] " \
650 snat_vat_api_hookup (vat_main_t *vam)
652 snat_test_main_t * sm __attribute__((unused)) = &snat_test_main;
653 /* Hook up handlers for replies from the data plane plug-in */
655 vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base), \
657 vl_api_##n##_t_handler, \
659 vl_api_##n##_t_endian, \
660 vl_api_##n##_t_print, \
661 sizeof(vl_api_##n##_t), 1);
662 foreach_vpe_api_reply_msg;
665 /* API messages we can send */
667 hash_set_mem (vam->function_by_name, #n, api_##n); \
668 clib_warning ("vam %llx add '%s' handler %llx", vam, #n, api_##n);
673 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
678 clib_error_t * vat_plugin_register (vat_main_t *vam)
680 snat_test_main_t * sm = &snat_test_main;
685 /* Ask the vpp engine for the first assigned message-id */
686 name = format (0, "snat_%08x%c", api_version, 0);
687 sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
689 if (sm->msg_id_base != (u16) ~0)
690 snat_vat_api_hookup (vam);