Convert message macro S to accept a message pointer parameter;
[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   f64 timeout;
113   ip4_address_t start_addr, end_addr;
114   u32 start_host_order, end_host_order;
115   vl_api_snat_add_address_range_t * mp;
116   u8 is_add = 1;
117   int count;
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;
164
165   /* NOTREACHED */
166   return 0;
167 }
168
169 static int api_snat_interface_add_del_feature (vat_main_t * vam)
170 {
171   unformat_input_t * i = vam->input;
172   f64 timeout;
173   vl_api_snat_interface_add_del_feature_t * mp;
174   u32 sw_if_index;
175   u8 sw_if_index_set = 0;
176   u8 is_inside = 1; 
177   u8 is_add = 1;
178
179   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
180     {
181       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
182         sw_if_index_set = 1;
183       else if (unformat (i, "sw_if_index %d", &sw_if_index))
184         sw_if_index_set = 1;
185       else if (unformat (i, "out"))
186         is_inside = 0;
187       else if (unformat (i, "in"))
188         is_inside = 1;
189       else if (unformat (i, "del"))
190         is_add = 0;
191       else
192         {
193           clib_warning("unknown input '%U'", format_unformat_error, i);
194           return -99;
195         }
196     }
197
198   if (sw_if_index_set == 0)
199     {
200       errmsg ("interface / sw_if_index required\n");
201       return -99;
202     }
203
204   M(SNAT_INTERFACE_ADD_DEL_FEATURE, mp);
205   mp->sw_if_index = ntohl(sw_if_index);
206   mp->is_add = is_add;
207   mp->is_inside = is_inside;
208   
209   S(mp);
210   W;
211   /* NOTREACHED */
212   return 0;
213 }
214
215 static int api_snat_add_static_mapping(vat_main_t * vam)
216 {
217   unformat_input_t * i = vam->input;
218   f64 timeout;
219   vl_api_snat_add_static_mapping_t * mp;
220   u8 external_addr_set = 0;
221   u8 local_addr_set;
222   u8 is_add = 1;
223   u8 addr_only = 1;
224   ip4_address_t local_addr, external_addr;
225   u32 local_port = 0, external_port = 0, vrf_id = ~0;
226   u32 sw_if_index = ~0;
227   u8 sw_if_index_set = 0;
228
229   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
230     {
231       if (unformat (i, "local_addr %U", unformat_ip4_address, &local_addr))
232         local_addr_set = 1;
233       else if (unformat (i, "external_addr %U", unformat_ip4_address,
234                          &external_addr))
235         external_addr_set = 1;
236       else if (unformat (i, "local_port %u", &local_port))
237         addr_only = 0;
238       else if (unformat (i, "external_port %u", &external_port))
239         addr_only = 0;
240       else if (unformat (i, "external_if %U", unformat_sw_if_index, vam,
241                          &sw_if_index))
242         sw_if_index_set = 1;
243       else if (unformat (i, "external_sw_if_index %d", &sw_if_index))
244         sw_if_index_set = 1;
245        else if (unformat (i, "vrf %u", &vrf_id))
246         ;
247       else if (unformat (i, "del"))
248         is_add = 0;
249       else
250         {
251           clib_warning("unknown input '%U'", format_unformat_error, i);
252           return -99;
253         }
254     }
255
256   if (!local_addr_set)
257     {
258       errmsg ("local addr required\n");
259       return -99;
260     }
261   if (!external_addr_set && !sw_if_index_set)
262     {
263       errmsg ("external addr or interface required\n");
264       return -99;
265     }
266
267   M(SNAT_ADD_STATIC_MAPPING, mp);
268   mp->is_add = is_add;
269   mp->is_ip4 = 1;
270   mp->addr_only = addr_only;
271   mp->local_port = ntohs ((u16) local_port);
272   mp->external_port = ntohs ((u16) external_port);
273   mp->external_sw_if_index = ntohl (sw_if_index);
274   mp->vrf_id = ntohl (vrf_id);
275   memcpy (mp->local_ip_address, &local_addr, 4);
276   memcpy (mp->external_ip_address, &external_addr, 4);
277
278   S(mp);
279   W;
280   /* NOTREACHED */
281   return 0;
282 }
283
284 static void vl_api_snat_control_ping_reply_t_handler
285   (vl_api_snat_control_ping_reply_t * mp)
286 {
287   vat_main_t *vam = &vat_main;
288   i32 retval = ntohl (mp->retval);
289   if (vam->async_mode)
290     {
291       vam->async_errors += (retval < 0);
292     }
293   else
294     {
295       vam->retval = retval;
296       vam->result_ready = 1;
297     }
298 }
299
300 static void vl_api_snat_static_mapping_details_t_handler
301   (vl_api_snat_static_mapping_details_t *mp)
302 {
303   snat_test_main_t * sm = &snat_test_main;
304   vat_main_t *vam = sm->vat_main;
305
306   if (mp->addr_only)
307       fformat (vam->ofp, "%15U%6s%15U%6s%11d\n",
308                format_ip4_address, &mp->local_ip_address, "",
309                format_ip4_address, &mp->external_ip_address, "",
310                ntohl (mp->vrf_id));
311   else
312       fformat (vam->ofp, "%15U%6d%15U%6d%11d\n",
313                format_ip4_address, &mp->local_ip_address,
314                ntohs (mp->local_port),
315                format_ip4_address, &mp->external_ip_address,
316                ntohs (mp->external_port),
317                ntohl (mp->vrf_id));
318
319 }
320
321 static int api_snat_static_mapping_dump(vat_main_t * vam)
322 {
323   f64 timeout;
324   vl_api_snat_static_mapping_dump_t * mp;
325
326   if (vam->json_output)
327     {
328       clib_warning ("JSON output not supported for snat_static_mapping_dump");
329       return -99;
330     }
331
332   fformat (vam->ofp, "%21s%21s\n", "local", "external");
333   fformat (vam->ofp, "%15s%6s%15s%6s%11s\n", "address", "port", "address",
334            "port", "vrf");
335
336   M(SNAT_STATIC_MAPPING_DUMP, mp);
337   S(mp);
338   /* Use a control ping for synchronization */
339   {
340     vl_api_snat_control_ping_t *mp;
341     M(SNAT_CONTROL_PING, mp);
342     S(mp);
343   }
344   W;
345   /* NOTREACHED */
346   return 0;
347 }
348
349 static void vl_api_snat_show_config_reply_t_handler
350   (vl_api_snat_show_config_reply_t *mp)
351 {
352   snat_test_main_t * sm = &snat_test_main;
353   vat_main_t *vam = sm->vat_main;
354   i32 retval = ntohl (mp->retval);
355
356   if (retval >= 0)
357     {
358       fformat (vam->ofp, "translation hash buckets %d\n",
359                ntohl (mp->translation_buckets));
360       fformat (vam->ofp, "translation hash memory %d\n",
361                ntohl (mp->translation_memory_size));
362       fformat (vam->ofp, "user hash buckets %d\n", ntohl (mp->user_buckets));
363       fformat (vam->ofp, "user hash memory %d\n", ntohl (mp->user_memory_size));
364       fformat (vam->ofp, "max translations per user %d\n",
365                ntohl (mp->max_translations_per_user));
366       fformat (vam->ofp, "outside VRF id %d\n", ntohl (mp->outside_vrf_id));
367       fformat (vam->ofp, "inside VRF id %d\n", ntohl (mp->inside_vrf_id));
368       if (mp->static_mapping_only)
369         {
370           fformat (vam->ofp, "static mapping only");
371           if (mp->static_mapping_connection_tracking)
372             fformat (vam->ofp, " connection tracking");
373           fformat (vam->ofp, "\n");
374         }
375     }
376   vam->retval = retval;
377   vam->result_ready = 1;
378 }
379
380 static int api_snat_show_config(vat_main_t * vam)
381 {
382   f64 timeout;
383   vl_api_snat_show_config_t * mp;
384
385   if (vam->json_output)
386     {
387       clib_warning ("JSON output not supported for snat_show_config");
388       return -99;
389     }
390
391   M(SNAT_SHOW_CONFIG, mp);
392   S(mp);
393   W;
394   /* NOTREACHED */
395   return 0;
396 }
397
398 static void vl_api_snat_address_details_t_handler
399   (vl_api_snat_address_details_t *mp)
400 {
401   snat_test_main_t * sm = &snat_test_main;
402   vat_main_t *vam = sm->vat_main;
403
404   fformat (vam->ofp, "%U\n", format_ip4_address, &mp->ip_address);
405 }
406
407 static int api_snat_address_dump(vat_main_t * vam)
408 {
409   f64 timeout;
410   vl_api_snat_address_dump_t * mp;
411
412   if (vam->json_output)
413     {
414       clib_warning ("JSON output not supported for snat_address_dump");
415       return -99;
416     }
417
418   M(SNAT_ADDRESS_DUMP, mp);
419   S(mp);
420   /* Use a control ping for synchronization */
421   {
422     vl_api_snat_control_ping_t *mp;
423     M(SNAT_CONTROL_PING, mp);
424     S(mp);
425   }
426   W;
427   /* NOTREACHED */
428   return 0;
429 }
430
431 static void vl_api_snat_interface_details_t_handler
432   (vl_api_snat_interface_details_t *mp)
433 {
434   snat_test_main_t * sm = &snat_test_main;
435   vat_main_t *vam = sm->vat_main;
436
437   fformat (vam->ofp, "sw_if_index %d %s\n", ntohl (mp->sw_if_index),
438            mp->is_inside ? "in" : "out");
439 }
440
441 static int api_snat_interface_dump(vat_main_t * vam)
442 {
443   f64 timeout;
444   vl_api_snat_interface_dump_t * mp;
445
446   if (vam->json_output)
447     {
448       clib_warning ("JSON output not supported for snat_address_dump");
449       return -99;
450     }
451
452   M(SNAT_INTERFACE_DUMP, mp);
453   S(mp);
454   /* Use a control ping for synchronization */
455   {
456     vl_api_snat_control_ping_t *mp;
457     M(SNAT_CONTROL_PING, mp);
458     S(mp);
459   }
460   W;
461   /* NOTREACHED */
462   return 0;
463 }
464
465 static int api_snat_set_workers (vat_main_t * vam)
466 {
467   unformat_input_t * i = vam->input;
468   f64 timeout;
469   vl_api_snat_set_workers_t * mp;
470   uword *bitmap;
471
472   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
473     {
474       if (unformat (i, "%U", unformat_bitmap_list, &bitmap))
475         ;
476       else
477         {
478           clib_warning("unknown input '%U'", format_unformat_error, i);
479           return -99;
480         }
481     }
482
483   M(SNAT_SET_WORKERS, mp);
484   mp->worker_mask = clib_host_to_net_u64 (bitmap[0]);
485
486   S(mp);
487   W;
488
489   /* NOTREACHED */
490   return 0;
491 }
492
493 static void vl_api_snat_worker_details_t_handler
494   (vl_api_snat_worker_details_t *mp)
495 {
496   snat_test_main_t * sm = &snat_test_main;
497   vat_main_t *vam = sm->vat_main;
498
499   fformat (vam->ofp, "worker_index %d (%s at lcore %u)\n",
500            ntohl (mp->worker_index), mp->name, ntohl (mp->lcore_id));
501 }
502
503 static int api_snat_worker_dump(vat_main_t * vam)
504 {
505   f64 timeout;
506   vl_api_snat_worker_dump_t * mp;
507
508   if (vam->json_output)
509     {
510       clib_warning ("JSON output not supported for snat_address_dump");
511       return -99;
512     }
513
514   M(SNAT_WORKER_DUMP, mp);
515   S(mp);
516   /* Use a control ping for synchronization */
517   {
518     vl_api_snat_control_ping_t *mp;
519     M(SNAT_CONTROL_PING, mp);
520     S(mp);
521   }
522   W;
523   /* NOTREACHED */
524   return 0;
525 }
526
527 static int api_snat_ipfix_enable_disable (vat_main_t * vam)
528 {
529   unformat_input_t * i = vam->input;
530   f64 timeout;
531   vl_api_snat_add_del_interface_addr_t * mp;
532   u32 sw_if_index;
533   u8 sw_if_index_set = 0;
534   u8 is_add = 1;
535
536   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
537     {
538       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
539         sw_if_index_set = 1;
540       else if (unformat (i, "sw_if_index %d", &sw_if_index))
541         sw_if_index_set = 1;
542       else if (unformat (i, "del"))
543         is_add = 0;
544       else
545         {
546           clib_warning("unknown input '%U'", format_unformat_error, i);
547           return -99;
548         }
549     }
550
551   if (sw_if_index_set == 0)
552     {
553       errmsg ("interface / sw_if_index required\n");
554       return -99;
555     }
556
557   M(SNAT_ADD_DEL_INTERFACE_ADDR, mp);
558   mp->sw_if_index = ntohl(sw_if_index);
559   mp->is_add = is_add;
560   
561   S(mp);
562   W;
563   /* NOTREACHED */
564   return 0;
565 }
566
567 static void vl_api_snat_interface_addr_details_t_handler
568   (vl_api_snat_interface_addr_details_t *mp)
569 {
570   snat_test_main_t * sm = &snat_test_main;
571   vat_main_t *vam = sm->vat_main;
572
573   fformat (vam->ofp, "sw_if_index %d\n", ntohl (mp->sw_if_index));
574 }
575
576 static int api_snat_interface_addr_dump(vat_main_t * vam)
577 {
578   f64 timeout;
579   vl_api_snat_interface_addr_dump_t * mp;
580
581   if (vam->json_output)
582     {
583       clib_warning ("JSON output not supported for snat_address_dump");
584       return -99;
585     }
586
587   M(SNAT_INTERFACE_ADDR_DUMP, mp);
588   S(mp);
589   /* Use a control ping for synchronization */
590   {
591     vl_api_snat_control_ping_t *mp;
592     M(SNAT_CONTROL_PING, mp);
593     S(mp);
594   }
595   W;
596   /* NOTREACHED */
597   return 0;
598 }
599
600 static int api_snat_add_del_interface_addr (vat_main_t * vam)
601 {
602   unformat_input_t * i = vam->input;
603   f64 timeout;
604   vl_api_snat_ipfix_enable_disable_t * mp;
605   u32 domain_id = 0;
606   u32 src_port = 0;
607   u8 enable = 1;
608
609   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
610     {
611       if (unformat (i, "domain %d", &domain_id))
612         ;
613       else if (unformat (i, "src_port %d", &src_port))
614         ;
615       else if (unformat (i, "disable"))
616         enable = 0;
617       else
618         {
619           clib_warning("unknown input '%U'", format_unformat_error, i);
620           return -99;
621         }
622     }
623
624   M(SNAT_IPFIX_ENABLE_DISABLE, mp);
625   mp->domain_id = htonl(domain_id);
626   mp->src_port = htons((u16) src_port);
627   mp->enable = enable;
628
629   S(mp);
630   W;
631   /* NOTREACHED */
632   return 0;
633 }
634
635 /* 
636  * List of messages that the api test plugin sends,
637  * and that the data plane plugin processes
638  */
639 #define foreach_vpe_api_msg                                      \
640 _(snat_add_address_range, "<start-addr> [- <end-addr] [del]")    \
641 _(snat_interface_add_del_feature,                                \
642   "<intfc> | sw_if_index <id> [in] [out] [del]")                 \
643 _(snat_add_static_mapping, "local_addr <ip> external_addr <ip> " \
644   "| external_if <intfc> | external_sw_if_ndex <id>) "           \
645   "[local_port <n>] [external_port <n>] [vrf <table-id>] [del]") \
646 _(snat_set_workers, "<wokrers_bitmap>")                          \
647 _(snat_static_mapping_dump, "")                                  \
648 _(snat_show_config, "")                                          \
649 _(snat_address_dump, "")                                         \
650 _(snat_interface_dump, "")                                       \
651 _(snat_worker_dump, "")                                          \
652 _(snat_add_del_interface_addr,                                   \
653   "<intfc> | sw_if_index <id> [del]")                            \
654 _(snat_interface_addr_dump, "")                                  \
655 _(snat_ipfix_enable_disable, "[domain <id>] [src_port <n>] "     \
656   "[disable]")
657
658 static void 
659 snat_vat_api_hookup (vat_main_t *vam)
660 {
661   snat_test_main_t * sm __attribute__((unused)) = &snat_test_main;
662   /* Hook up handlers for replies from the data plane plug-in */
663 #define _(N,n)                                                  \
664   vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base),       \
665                           #n,                                   \
666                           vl_api_##n##_t_handler,               \
667                           vl_noop_handler,                      \
668                           vl_api_##n##_t_endian,                \
669                           vl_api_##n##_t_print,                 \
670                           sizeof(vl_api_##n##_t), 1); 
671   foreach_vpe_api_reply_msg;
672 #undef _
673
674   /* API messages we can send */
675 #define _(n,h)                                          \
676   hash_set_mem (vam->function_by_name, #n, api_##n);    \
677   clib_warning ("vam %llx add '%s' handler %llx", vam, #n, api_##n);
678   foreach_vpe_api_msg;
679 #undef _    
680     
681   /* Help strings */
682 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
683   foreach_vpe_api_msg;
684 #undef _
685 }
686
687 clib_error_t * vat_plugin_register (vat_main_t *vam)
688 {
689   snat_test_main_t * sm = &snat_test_main;
690   u8 * name;
691
692   sm->vat_main = vam;
693
694   /* Ask the vpp engine for the first assigned message-id */
695   name = format (0, "snat_%08x%c", api_version, 0);
696   sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
697
698   if (sm->msg_id_base != (u16) ~0)
699     snat_vat_api_hookup (vam);
700   
701   vec_free(name);
702   
703   return 0;
704 }