SNAT: fix snat_add_static_mapping_command() uninitialized variable
[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   u8 proto_set = 0;
226   int ret;
227
228   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
229     {
230       if (unformat (i, "local_addr %U", unformat_ip4_address, &local_addr))
231         local_addr_set = 1;
232       else if (unformat (i, "external_addr %U", unformat_ip4_address,
233                          &external_addr))
234         external_addr_set = 1;
235       else if (unformat (i, "local_port %u", &local_port))
236         addr_only = 0;
237       else if (unformat (i, "external_port %u", &external_port))
238         addr_only = 0;
239       else if (unformat (i, "external_if %U", unformat_sw_if_index, vam,
240                          &sw_if_index))
241         sw_if_index_set = 1;
242       else if (unformat (i, "external_sw_if_index %d", &sw_if_index))
243         sw_if_index_set = 1;
244       else if (unformat (i, "vrf %u", &vrf_id))
245         ;
246       else if (unformat (i, "protocol %u", &proto))
247         proto_set = 1;
248       else if (unformat (i, "del"))
249         is_add = 0;
250       else
251         {
252           clib_warning("unknown input '%U'", format_unformat_error, i);
253           return -99;
254         }
255     }
256
257   if (!addr_only && !proto_set)
258     {
259       errmsg ("protocol required\n");
260       return -99;
261     }
262
263   if (!local_addr_set)
264     {
265       errmsg ("local addr required\n");
266       return -99;
267     }
268   if (!external_addr_set && !sw_if_index_set)
269     {
270       errmsg ("external addr or interface required\n");
271       return -99;
272     }
273
274   M(SNAT_ADD_STATIC_MAPPING, mp);
275   mp->is_add = is_add;
276   mp->is_ip4 = 1;
277   mp->addr_only = addr_only;
278   mp->local_port = ntohs ((u16) local_port);
279   mp->external_port = ntohs ((u16) external_port);
280   mp->external_sw_if_index = ntohl (sw_if_index);
281   mp->vrf_id = ntohl (vrf_id);
282   mp->protocol = (u8) proto;
283   memcpy (mp->local_ip_address, &local_addr, 4);
284   memcpy (mp->external_ip_address, &external_addr, 4);
285
286   S(mp);
287   W (ret);
288   return ret;
289 }
290
291 static void vl_api_snat_control_ping_reply_t_handler
292   (vl_api_snat_control_ping_reply_t * mp)
293 {
294   vat_main_t *vam = &vat_main;
295   i32 retval = ntohl (mp->retval);
296   if (vam->async_mode)
297     {
298       vam->async_errors += (retval < 0);
299     }
300   else
301     {
302       vam->retval = retval;
303       vam->result_ready = 1;
304     }
305 }
306
307 static void vl_api_snat_static_mapping_details_t_handler
308   (vl_api_snat_static_mapping_details_t *mp)
309 {
310   snat_test_main_t * sm = &snat_test_main;
311   vat_main_t *vam = sm->vat_main;
312
313   if (mp->addr_only)
314       fformat (vam->ofp, "%15U%6s%15U%6s%11d%6d\n",
315                format_ip4_address, &mp->local_ip_address, "",
316                format_ip4_address, &mp->external_ip_address, "",
317                ntohl (mp->vrf_id),
318                mp->protocol);
319   else
320       fformat (vam->ofp, "%15U%6d%15U%6d%11d%6d\n",
321                format_ip4_address, &mp->local_ip_address,
322                ntohs (mp->local_port),
323                format_ip4_address, &mp->external_ip_address,
324                ntohs (mp->external_port),
325                ntohl (mp->vrf_id),
326                mp->protocol);
327
328 }
329
330 static int api_snat_static_mapping_dump(vat_main_t * vam)
331 {
332   vl_api_snat_static_mapping_dump_t * mp;
333   vl_api_snat_control_ping_t *mp_ping;
334   int ret;
335
336   if (vam->json_output)
337     {
338       clib_warning ("JSON output not supported for snat_static_mapping_dump");
339       return -99;
340     }
341
342   fformat (vam->ofp, "%21s%21s\n", "local", "external");
343   fformat (vam->ofp, "%15s%6s%15s%6s%11s%6s\n", "address", "port", "address",
344            "port", "vrf", "proto");
345
346   M(SNAT_STATIC_MAPPING_DUMP, mp);
347   S(mp);
348
349   /* Use a control ping for synchronization */
350   M(SNAT_CONTROL_PING, mp_ping);
351   S(mp_ping);
352
353   W (ret);
354   return ret;
355 }
356
357 static void vl_api_snat_show_config_reply_t_handler
358   (vl_api_snat_show_config_reply_t *mp)
359 {
360   snat_test_main_t * sm = &snat_test_main;
361   vat_main_t *vam = sm->vat_main;
362   i32 retval = ntohl (mp->retval);
363
364   if (retval >= 0)
365     {
366       fformat (vam->ofp, "translation hash buckets %d\n",
367                ntohl (mp->translation_buckets));
368       fformat (vam->ofp, "translation hash memory %d\n",
369                ntohl (mp->translation_memory_size));
370       fformat (vam->ofp, "user hash buckets %d\n", ntohl (mp->user_buckets));
371       fformat (vam->ofp, "user hash memory %d\n", ntohl (mp->user_memory_size));
372       fformat (vam->ofp, "max translations per user %d\n",
373                ntohl (mp->max_translations_per_user));
374       fformat (vam->ofp, "outside VRF id %d\n", ntohl (mp->outside_vrf_id));
375       fformat (vam->ofp, "inside VRF id %d\n", ntohl (mp->inside_vrf_id));
376       if (mp->static_mapping_only)
377         {
378           fformat (vam->ofp, "static mapping only");
379           if (mp->static_mapping_connection_tracking)
380             fformat (vam->ofp, " connection tracking");
381           fformat (vam->ofp, "\n");
382         }
383     }
384   vam->retval = retval;
385   vam->result_ready = 1;
386 }
387
388 static int api_snat_show_config(vat_main_t * vam)
389 {
390   vl_api_snat_show_config_t * mp;
391   int ret;
392
393   if (vam->json_output)
394     {
395       clib_warning ("JSON output not supported for snat_show_config");
396       return -99;
397     }
398
399   M(SNAT_SHOW_CONFIG, mp);
400   S(mp);
401   W (ret);
402   return ret;
403 }
404
405 static void vl_api_snat_address_details_t_handler
406   (vl_api_snat_address_details_t *mp)
407 {
408   snat_test_main_t * sm = &snat_test_main;
409   vat_main_t *vam = sm->vat_main;
410
411   fformat (vam->ofp, "%U\n", format_ip4_address, &mp->ip_address);
412 }
413
414 static int api_snat_address_dump(vat_main_t * vam)
415 {
416   vl_api_snat_address_dump_t * mp;
417   vl_api_snat_control_ping_t *mp_ping;
418   int ret;
419
420   if (vam->json_output)
421     {
422       clib_warning ("JSON output not supported for snat_address_dump");
423       return -99;
424     }
425
426   M(SNAT_ADDRESS_DUMP, mp);
427   S(mp);
428
429   /* Use a control ping for synchronization */
430   M(SNAT_CONTROL_PING, mp_ping);
431   S(mp_ping);
432
433   W (ret);
434   return ret;
435 }
436
437 static void vl_api_snat_interface_details_t_handler
438   (vl_api_snat_interface_details_t *mp)
439 {
440   snat_test_main_t * sm = &snat_test_main;
441   vat_main_t *vam = sm->vat_main;
442
443   fformat (vam->ofp, "sw_if_index %d %s\n", ntohl (mp->sw_if_index),
444            mp->is_inside ? "in" : "out");
445 }
446
447 static int api_snat_interface_dump(vat_main_t * vam)
448 {
449   vl_api_snat_interface_dump_t * mp;
450   vl_api_snat_control_ping_t *mp_ping;
451   int ret;
452
453   if (vam->json_output)
454     {
455       clib_warning ("JSON output not supported for snat_address_dump");
456       return -99;
457     }
458
459   M(SNAT_INTERFACE_DUMP, mp);
460   S(mp);
461
462   /* Use a control ping for synchronization */
463   M(SNAT_CONTROL_PING, mp_ping);
464   S(mp_ping);
465
466   W (ret);
467   return ret;
468 }
469
470 static int api_snat_set_workers (vat_main_t * vam)
471 {
472   unformat_input_t * i = vam->input;
473   vl_api_snat_set_workers_t * mp;
474   uword *bitmap;
475   int ret;
476
477   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
478     {
479       if (unformat (i, "%U", unformat_bitmap_list, &bitmap))
480         ;
481       else
482         {
483           clib_warning("unknown input '%U'", format_unformat_error, i);
484           return -99;
485         }
486     }
487
488   M(SNAT_SET_WORKERS, mp);
489   mp->worker_mask = clib_host_to_net_u64 (bitmap[0]);
490
491   S(mp);
492   W (ret);
493   return ret;
494 }
495
496 static void vl_api_snat_worker_details_t_handler
497   (vl_api_snat_worker_details_t *mp)
498 {
499   snat_test_main_t * sm = &snat_test_main;
500   vat_main_t *vam = sm->vat_main;
501
502   fformat (vam->ofp, "worker_index %d (%s at lcore %u)\n",
503            ntohl (mp->worker_index), mp->name, ntohl (mp->lcore_id));
504 }
505
506 static int api_snat_worker_dump(vat_main_t * vam)
507 {
508   vl_api_snat_worker_dump_t * mp;
509   vl_api_snat_control_ping_t *mp_ping;
510   int ret;
511
512   if (vam->json_output)
513     {
514       clib_warning ("JSON output not supported for snat_address_dump");
515       return -99;
516     }
517
518   M(SNAT_WORKER_DUMP, mp);
519   S(mp);
520
521   /* Use a control ping for synchronization */
522   M(SNAT_CONTROL_PING, mp_ping);
523   S(mp_ping);
524
525   W (ret);
526   return ret;
527 }
528
529 static int api_snat_ipfix_enable_disable (vat_main_t * vam)
530 {
531   unformat_input_t * i = vam->input;
532   vl_api_snat_add_del_interface_addr_t * mp;
533   u32 sw_if_index;
534   u8 sw_if_index_set = 0;
535   u8 is_add = 1;
536   int ret;
537
538   while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
539     {
540       if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
541         sw_if_index_set = 1;
542       else if (unformat (i, "sw_if_index %d", &sw_if_index))
543         sw_if_index_set = 1;
544       else if (unformat (i, "del"))
545         is_add = 0;
546       else
547         {
548           clib_warning("unknown input '%U'", format_unformat_error, i);
549           return -99;
550         }
551     }
552
553   if (sw_if_index_set == 0)
554     {
555       errmsg ("interface / sw_if_index required\n");
556       return -99;
557     }
558
559   M(SNAT_ADD_DEL_INTERFACE_ADDR, mp);
560   mp->sw_if_index = ntohl(sw_if_index);
561   mp->is_add = is_add;
562   
563   S(mp);
564   W (ret);
565   return ret;
566 }
567
568 static void vl_api_snat_interface_addr_details_t_handler
569   (vl_api_snat_interface_addr_details_t *mp)
570 {
571   snat_test_main_t * sm = &snat_test_main;
572   vat_main_t *vam = sm->vat_main;
573
574   fformat (vam->ofp, "sw_if_index %d\n", ntohl (mp->sw_if_index));
575 }
576
577 static int api_snat_interface_addr_dump(vat_main_t * vam)
578 {
579   vl_api_snat_interface_addr_dump_t * mp;
580   vl_api_snat_control_ping_t *mp_ping;
581   int ret;
582
583   if (vam->json_output)
584     {
585       clib_warning ("JSON output not supported for snat_address_dump");
586       return -99;
587     }
588
589   M(SNAT_INTERFACE_ADDR_DUMP, mp);
590   S(mp);
591
592   /* Use a control ping for synchronization */
593   M(SNAT_CONTROL_PING, mp_ping);
594   S(mp_ping);
595
596   W (ret);
597   return ret;
598 }
599
600 static int api_snat_add_del_interface_addr (vat_main_t * vam)
601 {
602   unformat_input_t * i = vam->input;
603   vl_api_snat_ipfix_enable_disable_t * mp;
604   u32 domain_id = 0;
605   u32 src_port = 0;
606   u8 enable = 1;
607   int ret;
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 (ret);
631   return ret;
632 }
633
634 /* 
635  * List of messages that the api test plugin sends,
636  * and that the data plane plugin processes
637  */
638 #define foreach_vpe_api_msg                                      \
639 _(snat_add_address_range, "<start-addr> [- <end-addr] [del]")    \
640 _(snat_interface_add_del_feature,                                \
641   "<intfc> | sw_if_index <id> [in] [out] [del]")                 \
642 _(snat_add_static_mapping, "local_addr <ip> (external_addr <ip>" \
643   " | external_if <intfc> | external_sw_if_ndex <id>) "          \
644   "[local_port <n>] [external_port <n>] [vrf <table-id>] [del] " \
645   "protocol <n>")                                                \
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 }