SNAT: Port allocation per protocol
[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 = 0;
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   u32 proto = ~0;
225   int ret;
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, "protocol %u", &proto))
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   mp->protocol = (u8) proto;
276   memcpy (mp->local_ip_address, &local_addr, 4);
277   memcpy (mp->external_ip_address, &external_addr, 4);
278
279   S(mp);
280   W (ret);
281   return ret;
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%6d\n",
308                format_ip4_address, &mp->local_ip_address, "",
309                format_ip4_address, &mp->external_ip_address, "",
310                ntohl (mp->vrf_id),
311                mp->protocol);
312   else
313       fformat (vam->ofp, "%15U%6d%15U%6d%11d%6d\n",
314                format_ip4_address, &mp->local_ip_address,
315                ntohs (mp->local_port),
316                format_ip4_address, &mp->external_ip_address,
317                ntohs (mp->external_port),
318                ntohl (mp->vrf_id),
319                mp->protocol);
320
321 }
322
323 static int api_snat_static_mapping_dump(vat_main_t * vam)
324 {
325   vl_api_snat_static_mapping_dump_t * mp;
326   vl_api_snat_control_ping_t *mp_ping;
327   int ret;
328
329   if (vam->json_output)
330     {
331       clib_warning ("JSON output not supported for snat_static_mapping_dump");
332       return -99;
333     }
334
335   fformat (vam->ofp, "%21s%21s\n", "local", "external");
336   fformat (vam->ofp, "%15s%6s%15s%6s%11s%6s\n", "address", "port", "address",
337            "port", "vrf", "proto");
338
339   M(SNAT_STATIC_MAPPING_DUMP, mp);
340   S(mp);
341
342   /* Use a control ping for synchronization */
343   M(SNAT_CONTROL_PING, mp_ping);
344   S(mp_ping);
345
346   W (ret);
347   return ret;
348 }
349
350 static void vl_api_snat_show_config_reply_t_handler
351   (vl_api_snat_show_config_reply_t *mp)
352 {
353   snat_test_main_t * sm = &snat_test_main;
354   vat_main_t *vam = sm->vat_main;
355   i32 retval = ntohl (mp->retval);
356
357   if (retval >= 0)
358     {
359       fformat (vam->ofp, "translation hash buckets %d\n",
360                ntohl (mp->translation_buckets));
361       fformat (vam->ofp, "translation hash memory %d\n",
362                ntohl (mp->translation_memory_size));
363       fformat (vam->ofp, "user hash buckets %d\n", ntohl (mp->user_buckets));
364       fformat (vam->ofp, "user hash memory %d\n", ntohl (mp->user_memory_size));
365       fformat (vam->ofp, "max translations per user %d\n",
366                ntohl (mp->max_translations_per_user));
367       fformat (vam->ofp, "outside VRF id %d\n", ntohl (mp->outside_vrf_id));
368       fformat (vam->ofp, "inside VRF id %d\n", ntohl (mp->inside_vrf_id));
369       if (mp->static_mapping_only)
370         {
371           fformat (vam->ofp, "static mapping only");
372           if (mp->static_mapping_connection_tracking)
373             fformat (vam->ofp, " connection tracking");
374           fformat (vam->ofp, "\n");
375         }
376     }
377   vam->retval = retval;
378   vam->result_ready = 1;
379 }
380
381 static int api_snat_show_config(vat_main_t * vam)
382 {
383   vl_api_snat_show_config_t * mp;
384   int ret;
385
386   if (vam->json_output)
387     {
388       clib_warning ("JSON output not supported for snat_show_config");
389       return -99;
390     }
391
392   M(SNAT_SHOW_CONFIG, mp);
393   S(mp);
394   W (ret);
395   return ret;
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   vl_api_snat_address_dump_t * mp;
410   vl_api_snat_control_ping_t *mp_ping;
411   int ret;
412
413   if (vam->json_output)
414     {
415       clib_warning ("JSON output not supported for snat_address_dump");
416       return -99;
417     }
418
419   M(SNAT_ADDRESS_DUMP, mp);
420   S(mp);
421
422   /* Use a control ping for synchronization */
423   M(SNAT_CONTROL_PING, mp_ping);
424   S(mp_ping);
425
426   W (ret);
427   return ret;
428 }
429
430 static void vl_api_snat_interface_details_t_handler
431   (vl_api_snat_interface_details_t *mp)
432 {
433   snat_test_main_t * sm = &snat_test_main;
434   vat_main_t *vam = sm->vat_main;
435
436   fformat (vam->ofp, "sw_if_index %d %s\n", ntohl (mp->sw_if_index),
437            mp->is_inside ? "in" : "out");
438 }
439
440 static int api_snat_interface_dump(vat_main_t * vam)
441 {
442   vl_api_snat_interface_dump_t * mp;
443   vl_api_snat_control_ping_t *mp_ping;
444   int ret;
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
455   /* Use a control ping for synchronization */
456   M(SNAT_CONTROL_PING, mp_ping);
457   S(mp_ping);
458
459   W (ret);
460   return ret;
461 }
462
463 static int api_snat_set_workers (vat_main_t * vam)
464 {
465   unformat_input_t * i = vam->input;
466   vl_api_snat_set_workers_t * mp;
467   uword *bitmap;
468   int ret;
469
470   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
471     {
472       if (unformat (i, "%U", unformat_bitmap_list, &bitmap))
473         ;
474       else
475         {
476           clib_warning("unknown input '%U'", format_unformat_error, i);
477           return -99;
478         }
479     }
480
481   M(SNAT_SET_WORKERS, mp);
482   mp->worker_mask = clib_host_to_net_u64 (bitmap[0]);
483
484   S(mp);
485   W (ret);
486   return ret;
487 }
488
489 static void vl_api_snat_worker_details_t_handler
490   (vl_api_snat_worker_details_t *mp)
491 {
492   snat_test_main_t * sm = &snat_test_main;
493   vat_main_t *vam = sm->vat_main;
494
495   fformat (vam->ofp, "worker_index %d (%s at lcore %u)\n",
496            ntohl (mp->worker_index), mp->name, ntohl (mp->lcore_id));
497 }
498
499 static int api_snat_worker_dump(vat_main_t * vam)
500 {
501   vl_api_snat_worker_dump_t * mp;
502   vl_api_snat_control_ping_t *mp_ping;
503   int ret;
504
505   if (vam->json_output)
506     {
507       clib_warning ("JSON output not supported for snat_address_dump");
508       return -99;
509     }
510
511   M(SNAT_WORKER_DUMP, mp);
512   S(mp);
513
514   /* Use a control ping for synchronization */
515   M(SNAT_CONTROL_PING, mp_ping);
516   S(mp_ping);
517
518   W (ret);
519   return ret;
520 }
521
522 static int api_snat_ipfix_enable_disable (vat_main_t * vam)
523 {
524   unformat_input_t * i = vam->input;
525   vl_api_snat_add_del_interface_addr_t * mp;
526   u32 sw_if_index;
527   u8 sw_if_index_set = 0;
528   u8 is_add = 1;
529   int ret;
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, mp);
553   mp->sw_if_index = ntohl(sw_if_index);
554   mp->is_add = is_add;
555   
556   S(mp);
557   W (ret);
558   return ret;
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   vl_api_snat_interface_addr_dump_t * mp;
573   vl_api_snat_control_ping_t *mp_ping;
574   int ret;
575
576   if (vam->json_output)
577     {
578       clib_warning ("JSON output not supported for snat_address_dump");
579       return -99;
580     }
581
582   M(SNAT_INTERFACE_ADDR_DUMP, mp);
583   S(mp);
584
585   /* Use a control ping for synchronization */
586   M(SNAT_CONTROL_PING, mp_ping);
587   S(mp_ping);
588
589   W (ret);
590   return ret;
591 }
592
593 static int api_snat_add_del_interface_addr (vat_main_t * vam)
594 {
595   unformat_input_t * i = vam->input;
596   vl_api_snat_ipfix_enable_disable_t * mp;
597   u32 domain_id = 0;
598   u32 src_port = 0;
599   u8 enable = 1;
600   int ret;
601
602   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
603     {
604       if (unformat (i, "domain %d", &domain_id))
605         ;
606       else if (unformat (i, "src_port %d", &src_port))
607         ;
608       else if (unformat (i, "disable"))
609         enable = 0;
610       else
611         {
612           clib_warning("unknown input '%U'", format_unformat_error, i);
613           return -99;
614         }
615     }
616
617   M(SNAT_IPFIX_ENABLE_DISABLE, mp);
618   mp->domain_id = htonl(domain_id);
619   mp->src_port = htons((u16) src_port);
620   mp->enable = enable;
621
622   S(mp);
623   W (ret);
624   return ret;
625 }
626
627 /* 
628  * List of messages that the api test plugin sends,
629  * and that the data plane plugin processes
630  */
631 #define foreach_vpe_api_msg                                      \
632 _(snat_add_address_range, "<start-addr> [- <end-addr] [del]")    \
633 _(snat_interface_add_del_feature,                                \
634   "<intfc> | sw_if_index <id> [in] [out] [del]")                 \
635 _(snat_add_static_mapping, "local_addr <ip> (external_addr <ip>" \
636   " | external_if <intfc> | external_sw_if_ndex <id>) "          \
637   "[local_port <n>] [external_port <n>] [vrf <table-id>] [del] " \
638   "protocol <n>")                                                \
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 }