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 #define __plugin_msg_base snat_test_main.msg_id_base
26 #include <vlibapi/vat_helper_macros.h>
28 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
30 /* Declare message IDs */
31 #include <snat/snat_msg_enum.h>
33 /* define message structures */
35 #include <snat/snat_all_api_h.h>
38 /* declare message handlers for each api */
40 #define vl_endianfun /* define message structures */
41 #include <snat/snat_all_api_h.h>
44 /* instantiate all the print functions we know about */
45 #define vl_print(handle, ...)
47 #include <snat/snat_all_api_h.h>
50 /* Get the API version number. */
51 #define vl_api_version(n,v) static u32 api_version=(v);
52 #include <snat/snat_all_api_h.h>
56 /* API message ID base */
61 snat_test_main_t snat_test_main;
63 #define foreach_standard_reply_retval_handler \
64 _(snat_add_address_range_reply) \
65 _(snat_interface_add_del_feature_reply) \
66 _(snat_add_static_mapping_reply) \
67 _(snat_set_workers_reply) \
68 _(snat_add_del_interface_addr_reply) \
69 _(snat_ipfix_enable_disable_reply)
72 static void vl_api_##n##_t_handler \
73 (vl_api_##n##_t * mp) \
75 vat_main_t * vam = snat_test_main.vat_main; \
76 i32 retval = ntohl(mp->retval); \
77 if (vam->async_mode) { \
78 vam->async_errors += (retval < 0); \
80 vam->retval = retval; \
81 vam->result_ready = 1; \
84 foreach_standard_reply_retval_handler;
88 * Table of message reply handlers, must include boilerplate handlers
91 #define foreach_vpe_api_reply_msg \
92 _(SNAT_ADD_ADDRESS_RANGE_REPLY, snat_add_address_range_reply) \
93 _(SNAT_INTERFACE_ADD_DEL_FEATURE_REPLY, \
94 snat_interface_add_del_feature_reply) \
95 _(SNAT_ADD_STATIC_MAPPING_REPLY, snat_add_static_mapping_reply) \
96 _(SNAT_CONTROL_PING_REPLY, snat_control_ping_reply) \
97 _(SNAT_STATIC_MAPPING_DETAILS, snat_static_mapping_details) \
98 _(SNAT_SHOW_CONFIG_REPLY, snat_show_config_reply) \
99 _(SNAT_ADDRESS_DETAILS, snat_address_details) \
100 _(SNAT_INTERFACE_DETAILS, snat_interface_details) \
101 _(SNAT_SET_WORKERS_REPLY, snat_set_workers_reply) \
102 _(SNAT_WORKER_DETAILS, snat_worker_details) \
103 _(SNAT_ADD_DEL_INTERFACE_ADDR_REPLY, \
104 snat_add_del_interface_addr_reply) \
105 _(SNAT_INTERFACE_ADDR_DETAILS, snat_interface_addr_details) \
106 _(SNAT_IPFIX_ENABLE_DISABLE_REPLY, \
107 snat_ipfix_enable_disable_reply) \
108 _(SNAT_USER_DETAILS, snat_user_details) \
109 _(SNAT_USER_SESSION_DETAILS, snat_user_session_details)
111 static int api_snat_add_address_range (vat_main_t * vam)
113 unformat_input_t * i = vam->input;
114 ip4_address_t start_addr, end_addr;
115 u32 start_host_order, end_host_order;
116 vl_api_snat_add_address_range_t * mp;
121 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
123 if (unformat (i, "%U - %U",
124 unformat_ip4_address, &start_addr,
125 unformat_ip4_address, &end_addr))
127 else if (unformat (i, "%U", unformat_ip4_address, &start_addr))
128 end_addr = start_addr;
129 else if (unformat (i, "del"))
133 clib_warning("unknown input '%U'", format_unformat_error, i);
138 start_host_order = clib_host_to_net_u32 (start_addr.as_u32);
139 end_host_order = clib_host_to_net_u32 (end_addr.as_u32);
141 if (end_host_order < start_host_order)
143 errmsg ("end address less than start address\n");
147 count = (end_host_order - start_host_order) + 1;
151 errmsg ("%U - %U, %d addresses...\n",
152 format_ip4_address, &start_addr,
153 format_ip4_address, &end_addr,
157 M(SNAT_ADD_ADDRESS_RANGE, mp);
159 memcpy (mp->first_ip_address, &start_addr, 4);
160 memcpy (mp->last_ip_address, &end_addr, 4);
169 static int api_snat_interface_add_del_feature (vat_main_t * vam)
171 unformat_input_t * i = vam->input;
172 vl_api_snat_interface_add_del_feature_t * mp;
174 u8 sw_if_index_set = 0;
179 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
181 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
183 else if (unformat (i, "sw_if_index %d", &sw_if_index))
185 else if (unformat (i, "out"))
187 else if (unformat (i, "in"))
189 else if (unformat (i, "del"))
193 clib_warning("unknown input '%U'", format_unformat_error, i);
198 if (sw_if_index_set == 0)
200 errmsg ("interface / sw_if_index required\n");
204 M(SNAT_INTERFACE_ADD_DEL_FEATURE, mp);
205 mp->sw_if_index = ntohl(sw_if_index);
207 mp->is_inside = is_inside;
214 static int api_snat_add_static_mapping(vat_main_t * vam)
216 unformat_input_t * i = vam->input;
217 vl_api_snat_add_static_mapping_t * mp;
218 u8 external_addr_set = 0;
219 u8 local_addr_set = 0;
222 ip4_address_t local_addr, external_addr;
223 u32 local_port = 0, external_port = 0, vrf_id = ~0;
224 u32 sw_if_index = ~0;
225 u8 sw_if_index_set = 0;
230 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
232 if (unformat (i, "local_addr %U", unformat_ip4_address, &local_addr))
234 else if (unformat (i, "external_addr %U", unformat_ip4_address,
236 external_addr_set = 1;
237 else if (unformat (i, "local_port %u", &local_port))
239 else if (unformat (i, "external_port %u", &external_port))
241 else if (unformat (i, "external_if %U", unformat_sw_if_index, vam,
244 else if (unformat (i, "external_sw_if_index %d", &sw_if_index))
246 else if (unformat (i, "vrf %u", &vrf_id))
248 else if (unformat (i, "protocol %u", &proto))
250 else if (unformat (i, "del"))
254 clib_warning("unknown input '%U'", format_unformat_error, i);
259 if (!addr_only && !proto_set)
261 errmsg ("protocol required\n");
267 errmsg ("local addr required\n");
270 if (!external_addr_set && !sw_if_index_set)
272 errmsg ("external addr or interface required\n");
276 M(SNAT_ADD_STATIC_MAPPING, mp);
279 mp->addr_only = addr_only;
280 mp->local_port = ntohs ((u16) local_port);
281 mp->external_port = ntohs ((u16) external_port);
282 mp->external_sw_if_index = ntohl (sw_if_index);
283 mp->vrf_id = ntohl (vrf_id);
284 mp->protocol = (u8) proto;
285 memcpy (mp->local_ip_address, &local_addr, 4);
286 memcpy (mp->external_ip_address, &external_addr, 4);
293 static void vl_api_snat_control_ping_reply_t_handler
294 (vl_api_snat_control_ping_reply_t * mp)
296 vat_main_t *vam = &vat_main;
297 i32 retval = ntohl (mp->retval);
300 vam->async_errors += (retval < 0);
304 vam->retval = retval;
305 vam->result_ready = 1;
309 static void vl_api_snat_static_mapping_details_t_handler
310 (vl_api_snat_static_mapping_details_t *mp)
312 snat_test_main_t * sm = &snat_test_main;
313 vat_main_t *vam = sm->vat_main;
315 if (mp->addr_only && mp->external_sw_if_index != ~0)
316 fformat (vam->ofp, "%15U%6s%15d%6s%11d%6d\n",
317 format_ip4_address, &mp->local_ip_address, "",
318 ntohl (mp->external_sw_if_index), "",
321 else if (mp->addr_only && mp->external_sw_if_index == ~0)
322 fformat (vam->ofp, "%15U%6s%15U%6s%11d%6d\n",
323 format_ip4_address, &mp->local_ip_address, "",
324 format_ip4_address, &mp->external_ip_address, "",
327 else if (!mp->addr_only && mp->external_sw_if_index != ~0)
328 fformat (vam->ofp, "%15U%6d%15d%6d%11d%6d\n",
329 format_ip4_address, &mp->local_ip_address,
330 ntohs (mp->local_port),
331 ntohl (mp->external_sw_if_index),
332 ntohs (mp->external_port),
336 fformat (vam->ofp, "%15U%6d%15U%6d%11d%6d\n",
337 format_ip4_address, &mp->local_ip_address,
338 ntohs (mp->local_port),
339 format_ip4_address, &mp->external_ip_address,
340 ntohs (mp->external_port),
346 static int api_snat_static_mapping_dump(vat_main_t * vam)
348 vl_api_snat_static_mapping_dump_t * mp;
349 vl_api_snat_control_ping_t *mp_ping;
352 if (vam->json_output)
354 clib_warning ("JSON output not supported for snat_static_mapping_dump");
358 fformat (vam->ofp, "%21s%21s\n", "local", "external");
359 fformat (vam->ofp, "%15s%6s%15s%6s%11s%6s\n", "address", "port",
360 "address/if_idx", "port", "vrf", "proto");
362 M(SNAT_STATIC_MAPPING_DUMP, mp);
365 /* Use a control ping for synchronization */
366 M(SNAT_CONTROL_PING, mp_ping);
373 static void vl_api_snat_show_config_reply_t_handler
374 (vl_api_snat_show_config_reply_t *mp)
376 snat_test_main_t * sm = &snat_test_main;
377 vat_main_t *vam = sm->vat_main;
378 i32 retval = ntohl (mp->retval);
382 fformat (vam->ofp, "translation hash buckets %d\n",
383 ntohl (mp->translation_buckets));
384 fformat (vam->ofp, "translation hash memory %d\n",
385 ntohl (mp->translation_memory_size));
386 fformat (vam->ofp, "user hash buckets %d\n", ntohl (mp->user_buckets));
387 fformat (vam->ofp, "user hash memory %d\n", ntohl (mp->user_memory_size));
388 fformat (vam->ofp, "max translations per user %d\n",
389 ntohl (mp->max_translations_per_user));
390 fformat (vam->ofp, "outside VRF id %d\n", ntohl (mp->outside_vrf_id));
391 fformat (vam->ofp, "inside VRF id %d\n", ntohl (mp->inside_vrf_id));
392 if (mp->static_mapping_only)
394 fformat (vam->ofp, "static mapping only");
395 if (mp->static_mapping_connection_tracking)
396 fformat (vam->ofp, " connection tracking");
397 fformat (vam->ofp, "\n");
400 vam->retval = retval;
401 vam->result_ready = 1;
404 static int api_snat_show_config(vat_main_t * vam)
406 vl_api_snat_show_config_t * mp;
409 if (vam->json_output)
411 clib_warning ("JSON output not supported for snat_show_config");
415 M(SNAT_SHOW_CONFIG, mp);
421 static void vl_api_snat_address_details_t_handler
422 (vl_api_snat_address_details_t *mp)
424 snat_test_main_t * sm = &snat_test_main;
425 vat_main_t *vam = sm->vat_main;
427 fformat (vam->ofp, "%U\n", format_ip4_address, &mp->ip_address);
430 static int api_snat_address_dump(vat_main_t * vam)
432 vl_api_snat_address_dump_t * mp;
433 vl_api_snat_control_ping_t *mp_ping;
436 if (vam->json_output)
438 clib_warning ("JSON output not supported for snat_address_dump");
442 M(SNAT_ADDRESS_DUMP, mp);
445 /* Use a control ping for synchronization */
446 M(SNAT_CONTROL_PING, mp_ping);
453 static void vl_api_snat_interface_details_t_handler
454 (vl_api_snat_interface_details_t *mp)
456 snat_test_main_t * sm = &snat_test_main;
457 vat_main_t *vam = sm->vat_main;
459 fformat (vam->ofp, "sw_if_index %d %s\n", ntohl (mp->sw_if_index),
460 mp->is_inside ? "in" : "out");
463 static int api_snat_interface_dump(vat_main_t * vam)
465 vl_api_snat_interface_dump_t * mp;
466 vl_api_snat_control_ping_t *mp_ping;
469 if (vam->json_output)
471 clib_warning ("JSON output not supported for snat_address_dump");
475 M(SNAT_INTERFACE_DUMP, mp);
478 /* Use a control ping for synchronization */
479 M(SNAT_CONTROL_PING, mp_ping);
486 static int api_snat_set_workers (vat_main_t * vam)
488 unformat_input_t * i = vam->input;
489 vl_api_snat_set_workers_t * mp;
493 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
495 if (unformat (i, "%U", unformat_bitmap_list, &bitmap))
499 clib_warning("unknown input '%U'", format_unformat_error, i);
504 M(SNAT_SET_WORKERS, mp);
505 mp->worker_mask = clib_host_to_net_u64 (bitmap[0]);
512 static void vl_api_snat_worker_details_t_handler
513 (vl_api_snat_worker_details_t *mp)
515 snat_test_main_t * sm = &snat_test_main;
516 vat_main_t *vam = sm->vat_main;
518 fformat (vam->ofp, "worker_index %d (%s at lcore %u)\n",
519 ntohl (mp->worker_index), mp->name, ntohl (mp->lcore_id));
522 static int api_snat_worker_dump(vat_main_t * vam)
524 vl_api_snat_worker_dump_t * mp;
525 vl_api_snat_control_ping_t *mp_ping;
528 if (vam->json_output)
530 clib_warning ("JSON output not supported for snat_address_dump");
534 M(SNAT_WORKER_DUMP, mp);
537 /* Use a control ping for synchronization */
538 M(SNAT_CONTROL_PING, mp_ping);
545 static int api_snat_add_del_interface_addr (vat_main_t * vam)
547 unformat_input_t * i = vam->input;
548 vl_api_snat_add_del_interface_addr_t * mp;
550 u8 sw_if_index_set = 0;
554 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
556 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
558 else if (unformat (i, "sw_if_index %d", &sw_if_index))
560 else if (unformat (i, "del"))
564 clib_warning("unknown input '%U'", format_unformat_error, i);
569 if (sw_if_index_set == 0)
571 errmsg ("interface / sw_if_index required\n");
575 M(SNAT_ADD_DEL_INTERFACE_ADDR, mp);
576 mp->sw_if_index = ntohl(sw_if_index);
584 static void vl_api_snat_interface_addr_details_t_handler
585 (vl_api_snat_interface_addr_details_t *mp)
587 snat_test_main_t * sm = &snat_test_main;
588 vat_main_t *vam = sm->vat_main;
590 fformat (vam->ofp, "sw_if_index %d\n", ntohl (mp->sw_if_index));
593 static int api_snat_interface_addr_dump(vat_main_t * vam)
595 vl_api_snat_interface_addr_dump_t * mp;
596 vl_api_snat_control_ping_t *mp_ping;
599 if (vam->json_output)
601 clib_warning ("JSON output not supported for snat_address_dump");
605 M(SNAT_INTERFACE_ADDR_DUMP, mp);
608 /* Use a control ping for synchronization */
609 M(SNAT_CONTROL_PING, mp_ping);
616 static int api_snat_ipfix_enable_disable (vat_main_t * vam)
618 unformat_input_t * i = vam->input;
619 vl_api_snat_ipfix_enable_disable_t * mp;
625 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
627 if (unformat (i, "domain %d", &domain_id))
629 else if (unformat (i, "src_port %d", &src_port))
631 else if (unformat (i, "disable"))
635 clib_warning("unknown input '%U'", format_unformat_error, i);
640 M(SNAT_IPFIX_ENABLE_DISABLE, mp);
641 mp->domain_id = htonl(domain_id);
642 mp->src_port = htons((u16) src_port);
650 static void vl_api_snat_user_session_details_t_handler
651 (vl_api_snat_user_session_details_t *mp)
653 snat_test_main_t * sm = &snat_test_main;
654 vat_main_t *vam = sm->vat_main;
656 fformat(vam->ofp, "%s session %U:%d to %U:%d protocol id %d "
657 "total packets %d total bytes %d\n",
658 mp->is_static ? "static" : "dynamic",
659 format_ip4_address, mp->inside_ip_address, ntohl(mp->inside_port),
660 format_ip4_address, mp->outside_ip_address, ntohl(mp->outside_port),
661 ntohl(mp->protocol), ntohl(mp->total_pkts), ntohl(mp->total_bytes));
664 static int api_snat_user_session_dump(vat_main_t * vam)
666 vl_api_snat_user_session_dump_t * mp;
667 vl_api_snat_control_ping_t *mp_ping;
670 if (vam->json_output)
672 clib_warning ("JSON output not supported for snat_address_dump");
676 M(SNAT_USER_SESSION_DUMP, mp);
679 /* Use a control ping for synchronization */
680 M(SNAT_CONTROL_PING, mp_ping);
687 static void vl_api_snat_user_details_t_handler
688 (vl_api_snat_user_details_t *mp)
690 snat_test_main_t * sm = &snat_test_main;
691 vat_main_t *vam = sm->vat_main;
693 fformat(vam->ofp, "user with ip %U with vrf_id %d "
694 "with %d sessions and %d static sessions\n",
695 format_ip4_address, mp->ip_address, ntohl(mp->vrf_id),
696 ntohl(mp->nsessions), ntohl(mp->nstaticsessions));
699 static int api_snat_user_dump(vat_main_t * vam)
701 vl_api_snat_user_dump_t * mp;
702 vl_api_snat_control_ping_t *mp_ping;
705 if (vam->json_output)
707 clib_warning ("JSON output not supported for snat_address_dump");
711 M(SNAT_USER_DUMP, mp);
714 /* Use a control ping for synchronization */
715 M(SNAT_CONTROL_PING, mp_ping);
723 * List of messages that the api test plugin sends,
724 * and that the data plane plugin processes
726 #define foreach_vpe_api_msg \
727 _(snat_add_address_range, "<start-addr> [- <end-addr] [del]") \
728 _(snat_interface_add_del_feature, \
729 "<intfc> | sw_if_index <id> [in] [out] [del]") \
730 _(snat_add_static_mapping, "local_addr <ip> (external_addr <ip>" \
731 " | external_if <intfc> | external_sw_if_ndex <id>) " \
732 "[local_port <n>] [external_port <n>] [vrf <table-id>] [del] " \
734 _(snat_set_workers, "<wokrers_bitmap>") \
735 _(snat_static_mapping_dump, "") \
736 _(snat_show_config, "") \
737 _(snat_address_dump, "") \
738 _(snat_interface_dump, "") \
739 _(snat_worker_dump, "") \
740 _(snat_add_del_interface_addr, \
741 "<intfc> | sw_if_index <id> [del]") \
742 _(snat_interface_addr_dump, "") \
743 _(snat_ipfix_enable_disable, "[domain <id>] [src_port <n>] " \
745 _(snat_user_dump, "") \
746 _(snat_user_session_dump, "ip_address <ip> vrf_id <table-id>")
749 snat_vat_api_hookup (vat_main_t *vam)
751 snat_test_main_t * sm __attribute__((unused)) = &snat_test_main;
752 /* Hook up handlers for replies from the data plane plug-in */
754 vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base), \
756 vl_api_##n##_t_handler, \
758 vl_api_##n##_t_endian, \
759 vl_api_##n##_t_print, \
760 sizeof(vl_api_##n##_t), 1);
761 foreach_vpe_api_reply_msg;
764 /* API messages we can send */
766 hash_set_mem (vam->function_by_name, #n, api_##n); \
767 clib_warning ("vam %llx add '%s' handler %llx", vam, #n, api_##n);
772 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
777 clib_error_t * vat_plugin_register (vat_main_t *vam)
779 snat_test_main_t * sm = &snat_test_main;
784 /* Ask the vpp engine for the first assigned message-id */
785 name = format (0, "snat_%08x%c", api_version, 0);
786 sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
788 if (sm->msg_id_base != (u16) ~0)
789 snat_vat_api_hookup (vam);