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)
67 static void vl_api_##n##_t_handler \
68 (vl_api_##n##_t * mp) \
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); \
75 vam->retval = retval; \
76 vam->result_ready = 1; \
79 foreach_standard_reply_retval_handler;
83 * Table of message reply handlers, must include boilerplate handlers
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)
99 /* M: construct, but don't yet send a message */
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; \
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; \
118 /* S: send a message */
119 #define S (vl_msg_api_send_shmem (vam->vl_input_queue, (u8 *)&mp))
121 /* W: wait for results, with timeout */
124 timeout = vat_time_now (vam) + 1.0; \
126 while (vat_time_now (vam) < timeout) { \
127 if (vam->result_ready == 1) { \
128 return (vam->retval); \
134 static int api_snat_add_address_range (vat_main_t * vam)
136 snat_test_main_t * sm = &snat_test_main;
137 unformat_input_t * i = vam->input;
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;
145 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
147 if (unformat (i, "%U - %U",
148 unformat_ip4_address, &start_addr,
149 unformat_ip4_address, &end_addr))
151 else if (unformat (i, "%U", unformat_ip4_address, &start_addr))
152 end_addr = start_addr;
153 else if (unformat (i, "del"))
157 clib_warning("unknown input '%U'", format_unformat_error, i);
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);
165 if (end_host_order < start_host_order)
167 errmsg ("end address less than start address\n");
171 count = (end_host_order - start_host_order) + 1;
175 errmsg ("%U - %U, %d addresses...\n",
176 format_ip4_address, &start_addr,
177 format_ip4_address, &end_addr,
181 M(SNAT_ADD_ADDRESS_RANGE, snat_add_address_range);
183 memcpy (mp->first_ip_address, &start_addr, 4);
184 memcpy (mp->last_ip_address, &end_addr, 4);
194 static int api_snat_interface_add_del_feature (vat_main_t * vam)
196 snat_test_main_t * sm = &snat_test_main;
197 unformat_input_t * i = vam->input;
199 vl_api_snat_interface_add_del_feature_t * mp;
201 u8 sw_if_index_set = 0;
205 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
207 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
209 else if (unformat (i, "sw_if_index %d", &sw_if_index))
211 else if (unformat (i, "out"))
213 else if (unformat (i, "in"))
215 else if (unformat (i, "del"))
219 clib_warning("unknown input '%U'", format_unformat_error, i);
224 if (sw_if_index_set == 0)
226 errmsg ("interface / sw_if_index required\n");
230 M(SNAT_INTERFACE_ADD_DEL_FEATURE, snat_interface_add_del_feature);
231 mp->sw_if_index = ntohl(sw_if_index);
233 mp->is_inside = is_inside;
240 static int api_snat_add_static_mapping(vat_main_t * vam)
242 snat_test_main_t * sm = &snat_test_main;
243 unformat_input_t * i = vam->input;
245 vl_api_snat_add_static_mapping_t * mp;
249 ip4_address_t local_addr, external_addr;
250 u32 local_port = 0, external_port = 0, vrf_id = ~0;
252 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
254 if (unformat (i, "local_addr %U", unformat_ip4_address, &local_addr))
256 else if (unformat (i, "external_addr %U", unformat_ip4_address,
259 else if (unformat (i, "local_port %u", &local_port))
261 else if (unformat (i, "external_port %u", &external_port))
263 else if (unformat (i, "vrf %u", &vrf_id))
265 else if (unformat (i, "del"))
269 clib_warning("unknown input '%U'", format_unformat_error, i);
276 errmsg ("local_addr and remote_addr required\n");
280 M(SNAT_ADD_STATIC_MAPPING, snat_add_static_mapping);
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);
295 static void vl_api_snat_control_ping_reply_t_handler
296 (vl_api_snat_control_ping_reply_t * mp)
298 vat_main_t *vam = &vat_main;
299 i32 retval = ntohl (mp->retval);
302 vam->async_errors += (retval < 0);
306 vam->retval = retval;
307 vam->result_ready = 1;
311 static void vl_api_snat_static_mapping_details_t_handler
312 (vl_api_snat_static_mapping_details_t *mp)
314 snat_test_main_t * sm = &snat_test_main;
315 vat_main_t *vam = sm->vat_main;
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, "",
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),
332 static int api_snat_static_mapping_dump(vat_main_t * vam)
334 snat_test_main_t * sm = &snat_test_main;
336 vl_api_snat_static_mapping_dump_t * mp;
338 if (vam->json_output)
340 clib_warning ("JSON output not supported for snat_static_mapping_dump");
344 fformat (vam->ofp, "%21s%21s\n", "local", "external");
345 fformat (vam->ofp, "%15s%6s%15s%6s%11s\n", "address", "port", "address",
348 M(SNAT_STATIC_MAPPING_DUMP, snat_static_mapping_dump);
350 /* Use a control ping for synchronization */
352 vl_api_snat_control_ping_t *mp;
353 M (SNAT_CONTROL_PING, snat_control_ping);
361 static void vl_api_snat_show_config_reply_t_handler
362 (vl_api_snat_show_config_reply_t *mp)
364 snat_test_main_t * sm = &snat_test_main;
365 vat_main_t *vam = sm->vat_main;
366 i32 retval = ntohl (mp->retval);
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)
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");
388 vam->retval = retval;
389 vam->result_ready = 1;
392 static int api_snat_show_config(vat_main_t * vam)
394 snat_test_main_t * sm = &snat_test_main;
396 vl_api_snat_show_config_t * mp;
398 if (vam->json_output)
400 clib_warning ("JSON output not supported for snat_show_config");
404 M(SNAT_SHOW_CONFIG, snat_show_config);
410 static void vl_api_snat_address_details_t_handler
411 (vl_api_snat_address_details_t *mp)
413 snat_test_main_t * sm = &snat_test_main;
414 vat_main_t *vam = sm->vat_main;
416 fformat (vam->ofp, "%U\n", format_ip4_address, &mp->ip_address);
419 static int api_snat_address_dump(vat_main_t * vam)
421 snat_test_main_t * sm = &snat_test_main;
423 vl_api_snat_address_dump_t * mp;
425 if (vam->json_output)
427 clib_warning ("JSON output not supported for snat_address_dump");
431 M(SNAT_ADDRESS_DUMP, snat_address_dump);
433 /* Use a control ping for synchronization */
435 vl_api_snat_control_ping_t *mp;
436 M (SNAT_CONTROL_PING, snat_control_ping);
444 static void vl_api_snat_interface_details_t_handler
445 (vl_api_snat_interface_details_t *mp)
447 snat_test_main_t * sm = &snat_test_main;
448 vat_main_t *vam = sm->vat_main;
450 fformat (vam->ofp, "sw_if_index %d %s\n", ntohl (mp->sw_if_index),
451 mp->is_inside ? "in" : "out");
454 static int api_snat_interface_dump(vat_main_t * vam)
456 snat_test_main_t * sm = &snat_test_main;
458 vl_api_snat_interface_dump_t * mp;
460 if (vam->json_output)
462 clib_warning ("JSON output not supported for snat_address_dump");
466 M(SNAT_INTERFACE_DUMP, snat_interface_dump);
468 /* Use a control ping for synchronization */
470 vl_api_snat_control_ping_t *mp;
471 M (SNAT_CONTROL_PING, snat_control_ping);
479 static int api_snat_set_workers (vat_main_t * vam)
481 snat_test_main_t * sm = &snat_test_main;
482 unformat_input_t * i = vam->input;
484 vl_api_snat_set_workers_t * mp;
487 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
489 if (unformat (i, "%U", unformat_bitmap_list, &bitmap))
493 clib_warning("unknown input '%U'", format_unformat_error, i);
498 M(SNAT_SET_WORKERS, snat_set_workers);
499 mp->worker_mask = clib_host_to_net_u64 (bitmap[0]);
507 static void vl_api_snat_worker_details_t_handler
508 (vl_api_snat_worker_details_t *mp)
510 snat_test_main_t * sm = &snat_test_main;
511 vat_main_t *vam = sm->vat_main;
513 fformat (vam->ofp, "worker_index %d (%s at lcore %u)\n",
514 ntohl (mp->worker_index), mp->name, ntohl (mp->lcore_id));
517 static int api_snat_worker_dump(vat_main_t * vam)
519 snat_test_main_t * sm = &snat_test_main;
521 vl_api_snat_worker_dump_t * mp;
523 if (vam->json_output)
525 clib_warning ("JSON output not supported for snat_address_dump");
529 M(SNAT_WORKER_DUMP, snat_worker_dump);
531 /* Use a control ping for synchronization */
533 vl_api_snat_control_ping_t *mp;
534 M (SNAT_CONTROL_PING, snat_control_ping);
543 * List of messages that the api test plugin sends,
544 * and that the data plane plugin processes
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, "")
559 void vat_api_hookup (vat_main_t *vam)
561 snat_test_main_t * sm __attribute__((unused)) = &snat_test_main;
562 /* Hook up handlers for replies from the data plane plug-in */
564 vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base), \
566 vl_api_##n##_t_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;
574 /* API messages we can send */
575 #define _(n,h) hash_set_mem (vam->function_by_name, #n, api_##n);
580 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
585 clib_error_t * vat_plugin_register (vat_main_t *vam)
587 snat_test_main_t * sm = &snat_test_main;
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);
596 if (sm->msg_id_base != (u16) ~0)
597 vat_api_hookup (vam);