Remove unnecessary block structure around CONTROL_PING messages.
[vpp.git] / src / plugins / 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 #define __plugin_msg_base snat_test_main.msg_id_base
26 #include <vlibapi/vat_helper_macros.h>
27
28 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
29
30 /* Declare message IDs */
31 #include <snat/snat_msg_enum.h>
32
33 /* define message structures */
34 #define vl_typedefs
35 #include <snat/snat_all_api_h.h> 
36 #undef vl_typedefs
37
38 /* declare message handlers for each api */
39
40 #define vl_endianfun             /* define message structures */
41 #include <snat/snat_all_api_h.h> 
42 #undef vl_endianfun
43
44 /* instantiate all the print functions we know about */
45 #define vl_print(handle, ...)
46 #define vl_printfun
47 #include <snat/snat_all_api_h.h> 
48 #undef vl_printfun
49
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>
53 #undef vl_api_version
54
55 typedef struct {
56     /* API message ID base */
57     u16 msg_id_base;
58     vat_main_t *vat_main;
59 } snat_test_main_t;
60
61 snat_test_main_t snat_test_main;
62
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)
70
71 #define _(n)                                            \
72     static void vl_api_##n##_t_handler                  \
73     (vl_api_##n##_t * mp)                               \
74     {                                                   \
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);          \
79         } else {                                        \
80             vam->retval = retval;                       \
81             vam->result_ready = 1;                      \
82         }                                               \
83     }
84 foreach_standard_reply_retval_handler;
85 #undef _
86
87 /* 
88  * Table of message reply handlers, must include boilerplate handlers
89  * we just generated
90  */
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
109 static int api_snat_add_address_range (vat_main_t * vam)
110 {
111   unformat_input_t * i = vam->input;
112   ip4_address_t start_addr, end_addr;
113   u32 start_host_order, end_host_order;
114   vl_api_snat_add_address_range_t * mp;
115   u8 is_add = 1;
116   int count;
117   int ret;
118
119   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
120     {
121       if (unformat (i, "%U - %U",
122                     unformat_ip4_address, &start_addr,
123                     unformat_ip4_address, &end_addr))
124         ;
125       else if (unformat (i, "%U", unformat_ip4_address, &start_addr))
126         end_addr = start_addr;
127       else if (unformat (i, "del"))
128         is_add = 0;
129       else
130         {
131           clib_warning("unknown input '%U'", format_unformat_error, i);
132           return -99;
133         }
134     }
135
136   start_host_order = clib_host_to_net_u32 (start_addr.as_u32);
137   end_host_order = clib_host_to_net_u32 (end_addr.as_u32);
138   
139   if (end_host_order < start_host_order)
140     {
141       errmsg ("end address less than start address\n");
142       return -99;
143     }
144
145   count = (end_host_order - start_host_order) + 1;
146
147   if (count > 1024)
148     {
149     errmsg ("%U - %U, %d addresses...\n",
150            format_ip4_address, &start_addr,
151            format_ip4_address, &end_addr,
152            count);
153     }
154   
155   M(SNAT_ADD_ADDRESS_RANGE, mp);
156
157   memcpy (mp->first_ip_address, &start_addr, 4);
158   memcpy (mp->last_ip_address, &end_addr, 4);
159   mp->is_ip4 = 1;
160   mp->is_add = is_add;
161
162   S(mp);
163   W (ret);
164   return ret;
165 }
166
167 static int api_snat_interface_add_del_feature (vat_main_t * vam)
168 {
169   unformat_input_t * i = vam->input;
170   vl_api_snat_interface_add_del_feature_t * mp;
171   u32 sw_if_index;
172   u8 sw_if_index_set = 0;
173   u8 is_inside = 1; 
174   u8 is_add = 1;
175   int ret;
176
177   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
178     {
179       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
180         sw_if_index_set = 1;
181       else if (unformat (i, "sw_if_index %d", &sw_if_index))
182         sw_if_index_set = 1;
183       else if (unformat (i, "out"))
184         is_inside = 0;
185       else if (unformat (i, "in"))
186         is_inside = 1;
187       else if (unformat (i, "del"))
188         is_add = 0;
189       else
190         {
191           clib_warning("unknown input '%U'", format_unformat_error, i);
192           return -99;
193         }
194     }
195
196   if (sw_if_index_set == 0)
197     {
198       errmsg ("interface / sw_if_index required\n");
199       return -99;
200     }
201
202   M(SNAT_INTERFACE_ADD_DEL_FEATURE, mp);
203   mp->sw_if_index = ntohl(sw_if_index);
204   mp->is_add = is_add;
205   mp->is_inside = is_inside;
206   
207   S(mp);
208   W (ret);
209   return ret;
210 }
211
212 static int api_snat_add_static_mapping(vat_main_t * vam)
213 {
214   unformat_input_t * i = vam->input;
215   vl_api_snat_add_static_mapping_t * mp;
216   u8 external_addr_set = 0;
217   u8 local_addr_set;
218   u8 is_add = 1;
219   u8 addr_only = 1;
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;
224   int ret;
225
226   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
227     {
228       if (unformat (i, "local_addr %U", unformat_ip4_address, &local_addr))
229         local_addr_set = 1;
230       else if (unformat (i, "external_addr %U", unformat_ip4_address,
231                          &external_addr))
232         external_addr_set = 1;
233       else if (unformat (i, "local_port %u", &local_port))
234         addr_only = 0;
235       else if (unformat (i, "external_port %u", &external_port))
236         addr_only = 0;
237       else if (unformat (i, "external_if %U", unformat_sw_if_index, vam,
238                          &sw_if_index))
239         sw_if_index_set = 1;
240       else if (unformat (i, "external_sw_if_index %d", &sw_if_index))
241         sw_if_index_set = 1;
242        else if (unformat (i, "vrf %u", &vrf_id))
243         ;
244       else if (unformat (i, "del"))
245         is_add = 0;
246       else
247         {
248           clib_warning("unknown input '%U'", format_unformat_error, i);
249           return -99;
250         }
251     }
252
253   if (!local_addr_set)
254     {
255       errmsg ("local addr required\n");
256       return -99;
257     }
258   if (!external_addr_set && !sw_if_index_set)
259     {
260       errmsg ("external addr or interface required\n");
261       return -99;
262     }
263
264   M(SNAT_ADD_STATIC_MAPPING, mp);
265   mp->is_add = is_add;
266   mp->is_ip4 = 1;
267   mp->addr_only = addr_only;
268   mp->local_port = ntohs ((u16) local_port);
269   mp->external_port = ntohs ((u16) external_port);
270   mp->external_sw_if_index = ntohl (sw_if_index);
271   mp->vrf_id = ntohl (vrf_id);
272   memcpy (mp->local_ip_address, &local_addr, 4);
273   memcpy (mp->external_ip_address, &external_addr, 4);
274
275   S(mp);
276   W (ret);
277   return ret;
278 }
279
280 static void vl_api_snat_control_ping_reply_t_handler
281   (vl_api_snat_control_ping_reply_t * mp)
282 {
283   vat_main_t *vam = &vat_main;
284   i32 retval = ntohl (mp->retval);
285   if (vam->async_mode)
286     {
287       vam->async_errors += (retval < 0);
288     }
289   else
290     {
291       vam->retval = retval;
292       vam->result_ready = 1;
293     }
294 }
295
296 static void vl_api_snat_static_mapping_details_t_handler
297   (vl_api_snat_static_mapping_details_t *mp)
298 {
299   snat_test_main_t * sm = &snat_test_main;
300   vat_main_t *vam = sm->vat_main;
301
302   if (mp->addr_only)
303       fformat (vam->ofp, "%15U%6s%15U%6s%11d\n",
304                format_ip4_address, &mp->local_ip_address, "",
305                format_ip4_address, &mp->external_ip_address, "",
306                ntohl (mp->vrf_id));
307   else
308       fformat (vam->ofp, "%15U%6d%15U%6d%11d\n",
309                format_ip4_address, &mp->local_ip_address,
310                ntohs (mp->local_port),
311                format_ip4_address, &mp->external_ip_address,
312                ntohs (mp->external_port),
313                ntohl (mp->vrf_id));
314
315 }
316
317 static int api_snat_static_mapping_dump(vat_main_t * vam)
318 {
319   vl_api_snat_static_mapping_dump_t * mp;
320   vl_api_snat_control_ping_t *mp_ping;
321   int ret;
322
323   if (vam->json_output)
324     {
325       clib_warning ("JSON output not supported for snat_static_mapping_dump");
326       return -99;
327     }
328
329   fformat (vam->ofp, "%21s%21s\n", "local", "external");
330   fformat (vam->ofp, "%15s%6s%15s%6s%11s\n", "address", "port", "address",
331            "port", "vrf");
332
333   M(SNAT_STATIC_MAPPING_DUMP, mp);
334   S(mp);
335
336   /* Use a control ping for synchronization */
337   M(SNAT_CONTROL_PING, mp_ping);
338   S(mp_ping);
339
340   W (ret);
341   return ret;
342 }
343
344 static void vl_api_snat_show_config_reply_t_handler
345   (vl_api_snat_show_config_reply_t *mp)
346 {
347   snat_test_main_t * sm = &snat_test_main;
348   vat_main_t *vam = sm->vat_main;
349   i32 retval = ntohl (mp->retval);
350
351   if (retval >= 0)
352     {
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)
364         {
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");
369         }
370     }
371   vam->retval = retval;
372   vam->result_ready = 1;
373 }
374
375 static int api_snat_show_config(vat_main_t * vam)
376 {
377   vl_api_snat_show_config_t * mp;
378   int ret;
379
380   if (vam->json_output)
381     {
382       clib_warning ("JSON output not supported for snat_show_config");
383       return -99;
384     }
385
386   M(SNAT_SHOW_CONFIG, mp);
387   S(mp);
388   W (ret);
389   return ret;
390 }
391
392 static void vl_api_snat_address_details_t_handler
393   (vl_api_snat_address_details_t *mp)
394 {
395   snat_test_main_t * sm = &snat_test_main;
396   vat_main_t *vam = sm->vat_main;
397
398   fformat (vam->ofp, "%U\n", format_ip4_address, &mp->ip_address);
399 }
400
401 static int api_snat_address_dump(vat_main_t * vam)
402 {
403   vl_api_snat_address_dump_t * mp;
404   vl_api_snat_control_ping_t *mp_ping;
405   int ret;
406
407   if (vam->json_output)
408     {
409       clib_warning ("JSON output not supported for snat_address_dump");
410       return -99;
411     }
412
413   M(SNAT_ADDRESS_DUMP, mp);
414   S(mp);
415
416   /* Use a control ping for synchronization */
417   M(SNAT_CONTROL_PING, mp_ping);
418   S(mp_ping);
419
420   W (ret);
421   return ret;
422 }
423
424 static void vl_api_snat_interface_details_t_handler
425   (vl_api_snat_interface_details_t *mp)
426 {
427   snat_test_main_t * sm = &snat_test_main;
428   vat_main_t *vam = sm->vat_main;
429
430   fformat (vam->ofp, "sw_if_index %d %s\n", ntohl (mp->sw_if_index),
431            mp->is_inside ? "in" : "out");
432 }
433
434 static int api_snat_interface_dump(vat_main_t * vam)
435 {
436   vl_api_snat_interface_dump_t * mp;
437   vl_api_snat_control_ping_t *mp_ping;
438   int ret;
439
440   if (vam->json_output)
441     {
442       clib_warning ("JSON output not supported for snat_address_dump");
443       return -99;
444     }
445
446   M(SNAT_INTERFACE_DUMP, mp);
447   S(mp);
448
449   /* Use a control ping for synchronization */
450   M(SNAT_CONTROL_PING, mp_ping);
451   S(mp_ping);
452
453   W (ret);
454   return ret;
455 }
456
457 static int api_snat_set_workers (vat_main_t * vam)
458 {
459   unformat_input_t * i = vam->input;
460   vl_api_snat_set_workers_t * mp;
461   uword *bitmap;
462   int ret;
463
464   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
465     {
466       if (unformat (i, "%U", unformat_bitmap_list, &bitmap))
467         ;
468       else
469         {
470           clib_warning("unknown input '%U'", format_unformat_error, i);
471           return -99;
472         }
473     }
474
475   M(SNAT_SET_WORKERS, mp);
476   mp->worker_mask = clib_host_to_net_u64 (bitmap[0]);
477
478   S(mp);
479   W (ret);
480   return ret;
481 }
482
483 static void vl_api_snat_worker_details_t_handler
484   (vl_api_snat_worker_details_t *mp)
485 {
486   snat_test_main_t * sm = &snat_test_main;
487   vat_main_t *vam = sm->vat_main;
488
489   fformat (vam->ofp, "worker_index %d (%s at lcore %u)\n",
490            ntohl (mp->worker_index), mp->name, ntohl (mp->lcore_id));
491 }
492
493 static int api_snat_worker_dump(vat_main_t * vam)
494 {
495   vl_api_snat_worker_dump_t * mp;
496   vl_api_snat_control_ping_t *mp_ping;
497   int ret;
498
499   if (vam->json_output)
500     {
501       clib_warning ("JSON output not supported for snat_address_dump");
502       return -99;
503     }
504
505   M(SNAT_WORKER_DUMP, mp);
506   S(mp);
507
508   /* Use a control ping for synchronization */
509   M(SNAT_CONTROL_PING, mp_ping);
510   S(mp_ping);
511
512   W (ret);
513   return ret;
514 }
515
516 static int api_snat_ipfix_enable_disable (vat_main_t * vam)
517 {
518   unformat_input_t * i = vam->input;
519   vl_api_snat_add_del_interface_addr_t * mp;
520   u32 sw_if_index;
521   u8 sw_if_index_set = 0;
522   u8 is_add = 1;
523   int ret;
524
525   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
526     {
527       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
528         sw_if_index_set = 1;
529       else if (unformat (i, "sw_if_index %d", &sw_if_index))
530         sw_if_index_set = 1;
531       else if (unformat (i, "del"))
532         is_add = 0;
533       else
534         {
535           clib_warning("unknown input '%U'", format_unformat_error, i);
536           return -99;
537         }
538     }
539
540   if (sw_if_index_set == 0)
541     {
542       errmsg ("interface / sw_if_index required\n");
543       return -99;
544     }
545
546   M(SNAT_ADD_DEL_INTERFACE_ADDR, mp);
547   mp->sw_if_index = ntohl(sw_if_index);
548   mp->is_add = is_add;
549   
550   S(mp);
551   W (ret);
552   return ret;
553 }
554
555 static void vl_api_snat_interface_addr_details_t_handler
556   (vl_api_snat_interface_addr_details_t *mp)
557 {
558   snat_test_main_t * sm = &snat_test_main;
559   vat_main_t *vam = sm->vat_main;
560
561   fformat (vam->ofp, "sw_if_index %d\n", ntohl (mp->sw_if_index));
562 }
563
564 static int api_snat_interface_addr_dump(vat_main_t * vam)
565 {
566   vl_api_snat_interface_addr_dump_t * mp;
567   vl_api_snat_control_ping_t *mp_ping;
568   int ret;
569
570   if (vam->json_output)
571     {
572       clib_warning ("JSON output not supported for snat_address_dump");
573       return -99;
574     }
575
576   M(SNAT_INTERFACE_ADDR_DUMP, mp);
577   S(mp);
578
579   /* Use a control ping for synchronization */
580   M(SNAT_CONTROL_PING, mp_ping);
581   S(mp_ping);
582
583   W (ret);
584   return ret;
585 }
586
587 static int api_snat_add_del_interface_addr (vat_main_t * vam)
588 {
589   unformat_input_t * i = vam->input;
590   vl_api_snat_ipfix_enable_disable_t * mp;
591   u32 domain_id = 0;
592   u32 src_port = 0;
593   u8 enable = 1;
594   int ret;
595
596   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
597     {
598       if (unformat (i, "domain %d", &domain_id))
599         ;
600       else if (unformat (i, "src_port %d", &src_port))
601         ;
602       else if (unformat (i, "disable"))
603         enable = 0;
604       else
605         {
606           clib_warning("unknown input '%U'", format_unformat_error, i);
607           return -99;
608         }
609     }
610
611   M(SNAT_IPFIX_ENABLE_DISABLE, mp);
612   mp->domain_id = htonl(domain_id);
613   mp->src_port = htons((u16) src_port);
614   mp->enable = enable;
615
616   S(mp);
617   W (ret);
618   return ret;
619 }
620
621 /* 
622  * List of messages that the api test plugin sends,
623  * and that the data plane plugin processes
624  */
625 #define foreach_vpe_api_msg                                      \
626 _(snat_add_address_range, "<start-addr> [- <end-addr] [del]")    \
627 _(snat_interface_add_del_feature,                                \
628   "<intfc> | sw_if_index <id> [in] [out] [del]")                 \
629 _(snat_add_static_mapping, "local_addr <ip> external_addr <ip> " \
630   "| external_if <intfc> | external_sw_if_ndex <id>) "           \
631   "[local_port <n>] [external_port <n>] [vrf <table-id>] [del]") \
632 _(snat_set_workers, "<wokrers_bitmap>")                          \
633 _(snat_static_mapping_dump, "")                                  \
634 _(snat_show_config, "")                                          \
635 _(snat_address_dump, "")                                         \
636 _(snat_interface_dump, "")                                       \
637 _(snat_worker_dump, "")                                          \
638 _(snat_add_del_interface_addr,                                   \
639   "<intfc> | sw_if_index <id> [del]")                            \
640 _(snat_interface_addr_dump, "")                                  \
641 _(snat_ipfix_enable_disable, "[domain <id>] [src_port <n>] "     \
642   "[disable]")
643
644 static void 
645 snat_vat_api_hookup (vat_main_t *vam)
646 {
647   snat_test_main_t * sm __attribute__((unused)) = &snat_test_main;
648   /* Hook up handlers for replies from the data plane plug-in */
649 #define _(N,n)                                                  \
650   vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base),       \
651                           #n,                                   \
652                           vl_api_##n##_t_handler,               \
653                           vl_noop_handler,                      \
654                           vl_api_##n##_t_endian,                \
655                           vl_api_##n##_t_print,                 \
656                           sizeof(vl_api_##n##_t), 1); 
657   foreach_vpe_api_reply_msg;
658 #undef _
659
660   /* API messages we can send */
661 #define _(n,h)                                          \
662   hash_set_mem (vam->function_by_name, #n, api_##n);    \
663   clib_warning ("vam %llx add '%s' handler %llx", vam, #n, api_##n);
664   foreach_vpe_api_msg;
665 #undef _    
666     
667   /* Help strings */
668 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
669   foreach_vpe_api_msg;
670 #undef _
671 }
672
673 clib_error_t * vat_plugin_register (vat_main_t *vam)
674 {
675   snat_test_main_t * sm = &snat_test_main;
676   u8 * name;
677
678   sm->vat_main = vam;
679
680   /* Ask the vpp engine for the first assigned message-id */
681   name = format (0, "snat_%08x%c", api_version, 0);
682   sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
683
684   if (sm->msg_id_base != (u16) ~0)
685     snat_vat_api_hookup (vam);
686   
687   vec_free(name);
688   
689   return 0;
690 }