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