Refactor SNAT ICMP code
[vpp.git] / src / plugins / snat / snat.c
1 /*
2  * snat.c - simple nat plugin
3  *
4  * Copyright (c) 2016 Cisco and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #include <vnet/vnet.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/ip/ip4.h>
21 #include <vnet/plugin/plugin.h>
22 #include <vlibapi/api.h>
23 #include <snat/snat.h>
24 #include <snat/snat_ipfix_logging.h>
25 #include <snat/snat_det.h>
26 #include <vnet/fib/fib_table.h>
27 #include <vnet/fib/ip4_fib.h>
28
29 #include <vlibapi/api.h>
30 #include <vlibmemory/api.h>
31 #include <vlibsocket/api.h>
32 #include <vpp/app/version.h>
33
34 snat_main_t snat_main;
35
36 /* define message IDs */
37 #include <snat/snat_msg_enum.h>
38
39 /* define message structures */
40 #define vl_typedefs
41 #include <snat/snat_all_api_h.h> 
42 #undef vl_typedefs
43
44 /* define generated endian-swappers */
45 #define vl_endianfun
46 #include <snat/snat_all_api_h.h> 
47 #undef vl_endianfun
48
49 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
50
51 /* Get the API version number */
52 #define vl_api_version(n,v) static u32 api_version=(v);
53 #include <snat/snat_all_api_h.h>
54 #undef vl_api_version
55
56 /* Macro to finish up custom dump fns */
57 #define FINISH                                  \
58     vec_add1 (s, 0);                            \
59     vl_print (handle, (char *)s);               \
60     vec_free (s);                               \
61     return handle;
62
63 /* 
64  * A handy macro to set up a message reply.
65  * Assumes that the following variables are available:
66  * mp - pointer to request message
67  * rmp - pointer to reply message type
68  * rv - return value
69  */
70
71 #define REPLY_MACRO(t)                                          \
72 do {                                                            \
73     unix_shared_memory_queue_t * q =                            \
74     vl_api_client_index_to_input_queue (mp->client_index);      \
75     if (!q)                                                     \
76         return;                                                 \
77                                                                 \
78     rmp = vl_msg_api_alloc (sizeof (*rmp));                     \
79     rmp->_vl_msg_id = ntohs((t)+sm->msg_id_base);               \
80     rmp->context = mp->context;                                 \
81     rmp->retval = ntohl(rv);                                    \
82                                                                 \
83     vl_msg_api_send_shmem (q, (u8 *)&rmp);                      \
84 } while(0);
85
86 #define REPLY_MACRO2(t, body)                                   \
87 do {                                                            \
88     unix_shared_memory_queue_t * q =                            \
89     vl_api_client_index_to_input_queue (mp->client_index);      \
90     if (!q)                                                     \
91         return;                                                 \
92                                                                 \
93     rmp = vl_msg_api_alloc (sizeof (*rmp));                     \
94     rmp->_vl_msg_id = ntohs((t)+sm->msg_id_base);               \
95     rmp->context = mp->context;                                 \
96     rmp->retval = ntohl(rv);                                    \
97     do {body;} while (0);                                       \
98     vl_msg_api_send_shmem (q, (u8 *)&rmp);                      \
99 } while(0);
100
101
102 /* Hook up input features */
103 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
104   .arc_name = "ip4-unicast",
105   .node_name = "snat-in2out",
106   .runs_before = VNET_FEATURES ("snat-out2in"),
107 };
108 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
109   .arc_name = "ip4-unicast",
110   .node_name = "snat-out2in",
111   .runs_before = VNET_FEATURES ("ip4-lookup"),
112 };
113 VNET_FEATURE_INIT (ip4_snat_det_in2out, static) = {
114   .arc_name = "ip4-unicast",
115   .node_name = "snat-det-in2out",
116   .runs_before = VNET_FEATURES ("snat-det-out2in"),
117 };
118 VNET_FEATURE_INIT (ip4_snat_det_out2in, static) = {
119   .arc_name = "ip4-unicast",
120   .node_name = "snat-det-out2in",
121   .runs_before = VNET_FEATURES ("ip4-lookup"),
122 };
123 VNET_FEATURE_INIT (ip4_snat_in2out_worker_handoff, static) = {
124   .arc_name = "ip4-unicast",
125   .node_name = "snat-in2out-worker-handoff",
126   .runs_before = VNET_FEATURES ("snat-out2in-worker-handoff"),
127 };
128 VNET_FEATURE_INIT (ip4_snat_out2in_worker_handoff, static) = {
129   .arc_name = "ip4-unicast",
130   .node_name = "snat-out2in-worker-handoff",
131   .runs_before = VNET_FEATURES ("ip4-lookup"),
132 };
133 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
134   .arc_name = "ip4-unicast",
135   .node_name = "snat-in2out-fast",
136   .runs_before = VNET_FEATURES ("snat-out2in-fast"),
137 };
138 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
139   .arc_name = "ip4-unicast",
140   .node_name = "snat-out2in-fast",
141   .runs_before = VNET_FEATURES ("ip4-lookup"),
142 };
143
144 /* *INDENT-OFF* */
145 VLIB_PLUGIN_REGISTER () = {
146     .version = VPP_BUILD_VER,
147 };
148 /* *INDENT-ON* */
149
150 /*$$$$$ move to an installed header file */
151 #if (1 || CLIB_DEBUG > 0)       /* "trust, but verify" */
152
153 #define VALIDATE_SW_IF_INDEX(mp)                                \
154  do { u32 __sw_if_index = ntohl(mp->sw_if_index);               \
155     vnet_main_t *__vnm = vnet_get_main();                       \
156     if (pool_is_free_index(__vnm->interface_main.sw_interfaces, \
157                            __sw_if_index)) {                    \
158         rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;                \
159         goto bad_sw_if_index;                                   \
160     }                                                           \
161 } while(0);
162
163 #define BAD_SW_IF_INDEX_LABEL                   \
164 do {                                            \
165 bad_sw_if_index:                                \
166     ;                                           \
167 } while (0);
168
169 #define VALIDATE_RX_SW_IF_INDEX(mp)                             \
170  do { u32 __rx_sw_if_index = ntohl(mp->rx_sw_if_index);         \
171     vnet_main_t *__vnm = vnet_get_main();                       \
172     if (pool_is_free_index(__vnm->interface_main.sw_interfaces, \
173                            __rx_sw_if_index)) {                 \
174         rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;                \
175         goto bad_rx_sw_if_index;                                \
176     }                                                           \
177 } while(0);
178
179 #define BAD_RX_SW_IF_INDEX_LABEL                \
180 do {                                            \
181 bad_rx_sw_if_index:                             \
182     ;                                           \
183 } while (0);
184
185 #define VALIDATE_TX_SW_IF_INDEX(mp)                             \
186  do { u32 __tx_sw_if_index = ntohl(mp->tx_sw_if_index);         \
187     vnet_main_t *__vnm = vnet_get_main();                       \
188     if (pool_is_free_index(__vnm->interface_main.sw_interfaces, \
189                            __tx_sw_if_index)) {                 \
190         rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;                \
191         goto bad_tx_sw_if_index;                                \
192     }                                                           \
193 } while(0);
194
195 #define BAD_TX_SW_IF_INDEX_LABEL                \
196 do {                                            \
197 bad_tx_sw_if_index:                             \
198     ;                                           \
199 } while (0);
200
201 #else
202
203 #define VALIDATE_SW_IF_INDEX(mp)
204 #define BAD_SW_IF_INDEX_LABEL
205 #define VALIDATE_RX_SW_IF_INDEX(mp)
206 #define BAD_RX_SW_IF_INDEX_LABEL
207 #define VALIDATE_TX_SW_IF_INDEX(mp)
208 #define BAD_TX_SW_IF_INDEX_LABEL
209
210 #endif  /* CLIB_DEBUG > 0 */
211
212 /**
213  * @brief Add/del NAT address to FIB.
214  *
215  * Add the external NAT address to the FIB as receive entries. This ensures
216  * that VPP will reply to ARP for this address and we don't need to enable
217  * proxy ARP on the outside interface.
218  *
219  * @param addr IPv4 address.
220  * @param plen address prefix length
221  * @param sw_if_index Interface.
222  * @param is_add If 0 delete, otherwise add.
223  */
224 void
225 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
226                           int is_add)
227 {
228   fib_prefix_t prefix = {
229     .fp_len = p_len,
230     .fp_proto = FIB_PROTOCOL_IP4,
231     .fp_addr = {
232         .ip4.as_u32 = addr->as_u32,
233     },
234   };
235   u32 fib_index = ip4_fib_table_get_index_for_sw_if_index(sw_if_index);
236
237   if (is_add)
238     fib_table_entry_update_one_path(fib_index,
239                                     &prefix,
240                                     FIB_SOURCE_PLUGIN_HI,
241                                     (FIB_ENTRY_FLAG_CONNECTED |
242                                      FIB_ENTRY_FLAG_LOCAL |
243                                      FIB_ENTRY_FLAG_EXCLUSIVE),
244                                     FIB_PROTOCOL_IP4,
245                                     NULL,
246                                     sw_if_index,
247                                     ~0,
248                                     1,
249                                     NULL,
250                                     FIB_ROUTE_PATH_FLAG_NONE);
251   else
252     fib_table_entry_delete(fib_index,
253                            &prefix,
254                            FIB_SOURCE_PLUGIN_HI);
255 }
256
257 void snat_add_address (snat_main_t *sm, ip4_address_t *addr, u32 vrf_id)
258 {
259   snat_address_t * ap;
260   snat_interface_t *i;
261
262   if (vrf_id != ~0)
263     sm->vrf_mode = 1;
264
265   /* Check if address already exists */
266   vec_foreach (ap, sm->addresses)
267     {
268       if (ap->addr.as_u32 == addr->as_u32)
269         return;
270     }
271
272   vec_add2 (sm->addresses, ap, 1);
273   ap->addr = *addr;
274   ap->fib_index = ip4_fib_index_from_table_id(vrf_id);
275 #define _(N, i, n, s) \
276   clib_bitmap_alloc (ap->busy_##n##_port_bitmap, 65535);
277   foreach_snat_protocol
278 #undef _
279
280   /* Add external address to FIB */
281   pool_foreach (i, sm->interfaces,
282   ({
283     if (i->is_inside)
284       continue;
285
286     snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
287     break;
288   }));
289 }
290
291 static int is_snat_address_used_in_static_mapping (snat_main_t *sm,
292                                                    ip4_address_t addr)
293 {
294   snat_static_mapping_t *m;
295   pool_foreach (m, sm->static_mappings,
296   ({
297       if (m->external_addr.as_u32 == addr.as_u32)
298         return 1;
299   }));
300
301   return 0;
302 }
303
304 static void increment_v4_address (ip4_address_t * a)
305 {
306   u32 v;
307   
308   v = clib_net_to_host_u32(a->as_u32) + 1;
309   a->as_u32 = clib_host_to_net_u32(v);
310 }
311
312 static void 
313 snat_add_static_mapping_when_resolved (snat_main_t * sm, 
314                                        ip4_address_t l_addr, 
315                                        u16 l_port, 
316                                        u32 sw_if_index, 
317                                        u16 e_port, 
318                                        u32 vrf_id,
319                                        snat_protocol_t proto,
320                                        int addr_only,  
321                                        int is_add)
322 {
323   snat_static_map_resolve_t *rp;
324
325   vec_add2 (sm->to_resolve, rp, 1);
326   rp->l_addr.as_u32 = l_addr.as_u32;
327   rp->l_port = l_port;
328   rp->sw_if_index = sw_if_index;
329   rp->e_port = e_port;
330   rp->vrf_id = vrf_id;
331   rp->proto = proto;
332   rp->addr_only = addr_only;
333   rp->is_add = is_add;
334 }
335
336 /**
337  * @brief Add static mapping.
338  *
339  * Create static mapping between local addr+port and external addr+port.
340  *
341  * @param l_addr Local IPv4 address.
342  * @param e_addr External IPv4 address.
343  * @param l_port Local port number.
344  * @param e_port External port number.
345  * @param vrf_id VRF ID.
346  * @param addr_only If 0 address port and pair mapping, otherwise address only.
347  * @param sw_if_index External port instead of specific IP address.
348  * @param is_add If 0 delete static mapping, otherwise add.
349  *
350  * @returns
351  */
352 int snat_add_static_mapping(ip4_address_t l_addr, ip4_address_t e_addr,
353                             u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
354                             u32 sw_if_index, snat_protocol_t proto, int is_add)
355 {
356   snat_main_t * sm = &snat_main;
357   snat_static_mapping_t *m;
358   snat_session_key_t m_key;
359   clib_bihash_kv_8_8_t kv, value;
360   snat_address_t *a = 0;
361   u32 fib_index = ~0;
362   uword * p;
363   snat_interface_t *interface;
364   int i;
365
366   /* If the external address is a specific interface address */
367   if (sw_if_index != ~0)
368     {
369       ip4_address_t * first_int_addr;
370
371       /* Might be already set... */
372       first_int_addr = ip4_interface_first_address 
373         (sm->ip4_main, sw_if_index, 0 /* just want the address*/);
374
375       /* DHCP resolution required? */
376       if (first_int_addr == 0)
377         {
378           snat_add_static_mapping_when_resolved 
379             (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
380              addr_only,  is_add);
381           return 0;
382         }
383         else
384           e_addr.as_u32 = first_int_addr->as_u32;
385     }
386
387   m_key.addr = e_addr;
388   m_key.port = addr_only ? 0 : e_port;
389   m_key.protocol = addr_only ? 0 : proto;
390   m_key.fib_index = sm->outside_fib_index;
391   kv.key = m_key.as_u64;
392   if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
393     m = 0;
394   else
395     m = pool_elt_at_index (sm->static_mappings, value.value);
396
397   if (is_add)
398     {
399       if (m)
400         return VNET_API_ERROR_VALUE_EXIST;
401
402       /* Convert VRF id to FIB index */
403       if (vrf_id != ~0)
404         {
405           p = hash_get (sm->ip4_main->fib_index_by_table_id, vrf_id);
406           if (!p)
407             return VNET_API_ERROR_NO_SUCH_FIB;
408           fib_index = p[0];
409         }
410       /* If not specified use inside VRF id from SNAT plugin startup config */
411       else
412         {
413           fib_index = sm->inside_fib_index;
414           vrf_id = sm->inside_vrf_id;
415         }
416
417       /* Find external address in allocated addresses and reserve port for
418          address and port pair mapping when dynamic translations enabled */
419       if (!addr_only && !(sm->static_mapping_only))
420         {
421           for (i = 0; i < vec_len (sm->addresses); i++)
422             {
423               if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
424                 {
425                   a = sm->addresses + i;
426                   /* External port must be unused */
427                   switch (proto)
428                     {
429 #define _(N, j, n, s) \
430                     case SNAT_PROTOCOL_##N: \
431                       if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
432                         return VNET_API_ERROR_INVALID_VALUE; \
433                       clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
434                       if (e_port > 1024) \
435                         a->busy_##n##_ports++; \
436                       break;
437                       foreach_snat_protocol
438 #undef _
439                     default:
440                       clib_warning("unknown_protocol");
441                       return VNET_API_ERROR_INVALID_VALUE_2;
442                     }
443                   break;
444                 }
445             }
446           /* External address must be allocated */
447           if (!a)
448             return VNET_API_ERROR_NO_SUCH_ENTRY;
449         }
450
451       pool_get (sm->static_mappings, m);
452       memset (m, 0, sizeof (*m));
453       m->local_addr = l_addr;
454       m->external_addr = e_addr;
455       m->addr_only = addr_only;
456       m->vrf_id = vrf_id;
457       m->fib_index = fib_index;
458       if (!addr_only)
459         {
460           m->local_port = l_port;
461           m->external_port = e_port;
462           m->proto = proto;
463         }
464
465       m_key.addr = m->local_addr;
466       m_key.port = m->local_port;
467       m_key.protocol = m->proto;
468       m_key.fib_index = m->fib_index;
469       kv.key = m_key.as_u64;
470       kv.value = m - sm->static_mappings;
471       clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 1);
472
473       m_key.addr = m->external_addr;
474       m_key.port = m->external_port;
475       m_key.fib_index = sm->outside_fib_index;
476       kv.key = m_key.as_u64;
477       kv.value = m - sm->static_mappings;
478       clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 1);
479
480       /* Assign worker */
481       if (sm->workers)
482         {
483           snat_user_key_t w_key0;
484           snat_worker_key_t w_key1;
485
486           w_key0.addr = m->local_addr;
487           w_key0.fib_index = m->fib_index;
488           kv.key = w_key0.as_u64;
489
490           if (clib_bihash_search_8_8 (&sm->worker_by_in, &kv, &value))
491             {
492               kv.value = sm->first_worker_index +
493                 sm->workers[sm->next_worker++ % vec_len (sm->workers)];
494
495               clib_bihash_add_del_8_8 (&sm->worker_by_in, &kv, 1);
496             }
497           else
498             {
499               kv.value = value.value;
500             }
501
502           w_key1.addr = m->external_addr;
503           w_key1.port = clib_host_to_net_u16 (m->external_port);
504           w_key1.fib_index = sm->outside_fib_index;
505           kv.key = w_key1.as_u64;
506           clib_bihash_add_del_8_8 (&sm->worker_by_out, &kv, 1);
507         }
508     }
509   else
510     {
511       if (!m)
512         return VNET_API_ERROR_NO_SUCH_ENTRY;
513
514       /* Free external address port */
515       if (!addr_only && !(sm->static_mapping_only))
516         {
517           for (i = 0; i < vec_len (sm->addresses); i++)
518             {
519               if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
520                 {
521                   a = sm->addresses + i;
522                   switch (proto)
523                     {
524 #define _(N, j, n, s) \
525                     case SNAT_PROTOCOL_##N: \
526                       clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
527                       if (e_port > 1024) \
528                         a->busy_##n##_ports--; \
529                       break;
530                       foreach_snat_protocol
531 #undef _
532                     default:
533                       clib_warning("unknown_protocol");
534                       return VNET_API_ERROR_INVALID_VALUE_2;
535                     }
536                   break;
537                 }
538             }
539         }
540
541       m_key.addr = m->local_addr;
542       m_key.port = m->local_port;
543       m_key.protocol = m->proto;
544       m_key.fib_index = m->fib_index;
545       kv.key = m_key.as_u64;
546       clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0);
547
548       m_key.addr = m->external_addr;
549       m_key.port = m->external_port;
550       m_key.fib_index = sm->outside_fib_index;
551       kv.key = m_key.as_u64;
552       clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 0);
553
554       /* Delete session(s) for static mapping if exist */
555       if (!(sm->static_mapping_only) ||
556           (sm->static_mapping_only && sm->static_mapping_connection_tracking))
557         {
558           snat_user_key_t u_key;
559           snat_user_t *u;
560           dlist_elt_t * head, * elt;
561           u32 elt_index, head_index, del_elt_index;
562           u32 ses_index;
563           u64 user_index;
564           snat_session_t * s;
565           snat_main_per_thread_data_t *tsm;
566
567           u_key.addr = m->local_addr;
568           u_key.fib_index = m->fib_index;
569           kv.key = u_key.as_u64;
570           if (!clib_bihash_search_8_8 (&sm->user_hash, &kv, &value))
571             {
572               user_index = value.value;
573               if (!clib_bihash_search_8_8 (&sm->worker_by_in, &kv, &value))
574                 tsm = vec_elt_at_index (sm->per_thread_data, value.value);
575               else
576                 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
577               u = pool_elt_at_index (tsm->users, user_index);
578               if (u->nstaticsessions)
579                 {
580                   head_index = u->sessions_per_user_list_head_index;
581                   head = pool_elt_at_index (tsm->list_pool, head_index);
582                   elt_index = head->next;
583                   elt = pool_elt_at_index (tsm->list_pool, elt_index);
584                   ses_index = elt->value;
585                   while (ses_index != ~0)
586                     {
587                       s =  pool_elt_at_index (tsm->sessions, ses_index);
588                       del_elt_index = elt_index;
589                       elt_index = elt->next;
590                       elt = pool_elt_at_index (tsm->list_pool, elt_index);
591                       ses_index = elt->value;
592
593                       if (!addr_only)
594                         {
595                           if ((s->out2in.addr.as_u32 != e_addr.as_u32) &&
596                               (clib_net_to_host_u16 (s->out2in.port) != e_port))
597                             continue;
598                         }
599
600                       /* log NAT event */
601                       snat_ipfix_logging_nat44_ses_delete(s->in2out.addr.as_u32,
602                                                           s->out2in.addr.as_u32,
603                                                           s->in2out.protocol,
604                                                           s->in2out.port,
605                                                           s->out2in.port,
606                                                           s->in2out.fib_index);
607
608                       value.key = s->in2out.as_u64;
609                       clib_bihash_add_del_8_8 (&sm->in2out, &value, 0);
610                       value.key = s->out2in.as_u64;
611                       clib_bihash_add_del_8_8 (&sm->out2in, &value, 0);
612                       pool_put (tsm->sessions, s);
613
614                       clib_dlist_remove (tsm->list_pool, del_elt_index);
615                       pool_put_index (tsm->list_pool, del_elt_index);
616                       u->nstaticsessions--;
617
618                       if (!addr_only)
619                         break;
620                     }
621                   if (addr_only)
622                     {
623                       pool_put (tsm->users, u);
624                       clib_bihash_add_del_8_8 (&sm->user_hash, &kv, 0);
625                     }
626                 }
627             }
628         }
629
630       /* Delete static mapping from pool */
631       pool_put (sm->static_mappings, m);
632     }
633
634   if (!addr_only)
635     return 0;
636
637   /* Add/delete external address to FIB */
638   pool_foreach (interface, sm->interfaces,
639   ({
640     if (interface->is_inside)
641       continue;
642
643     snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
644     break;
645   }));
646
647   return 0;
648 }
649
650 int snat_del_address (snat_main_t *sm, ip4_address_t addr, u8 delete_sm)
651 {
652   snat_address_t *a = 0;
653   snat_session_t *ses;
654   u32 *ses_to_be_removed = 0, *ses_index;
655   clib_bihash_kv_8_8_t kv, value;
656   snat_user_key_t user_key;
657   snat_user_t *u;
658   snat_main_per_thread_data_t *tsm;
659   snat_static_mapping_t *m;
660   snat_interface_t *interface;
661   int i;
662
663   /* Find SNAT address */
664   for (i=0; i < vec_len (sm->addresses); i++)
665     {
666       if (sm->addresses[i].addr.as_u32 == addr.as_u32)
667         {
668           a = sm->addresses + i;
669           break;
670         }
671     }
672   if (!a)
673     return VNET_API_ERROR_NO_SUCH_ENTRY;
674
675   if (delete_sm)
676     {
677       pool_foreach (m, sm->static_mappings,
678       ({
679           if (m->external_addr.as_u32 == addr.as_u32)
680             (void) snat_add_static_mapping (m->local_addr, m->external_addr,
681                                             m->local_port, m->external_port,
682                                             m->vrf_id, m->addr_only, ~0,
683                                             m->proto, 0);
684       }));
685     }
686   else
687     {
688       /* Check if address is used in some static mapping */
689       if (is_snat_address_used_in_static_mapping(sm, addr))
690         {
691           clib_warning ("address used in static mapping");
692           return VNET_API_ERROR_UNSPECIFIED;
693         }
694     }
695
696   /* Delete sessions using address */
697   if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
698     {
699       vec_foreach (tsm, sm->per_thread_data)
700         {
701           pool_foreach (ses, tsm->sessions, ({
702             if (ses->out2in.addr.as_u32 == addr.as_u32)
703               {
704                 /* log NAT event */
705                 snat_ipfix_logging_nat44_ses_delete(ses->in2out.addr.as_u32,
706                                                     ses->out2in.addr.as_u32,
707                                                     ses->in2out.protocol,
708                                                     ses->in2out.port,
709                                                     ses->out2in.port,
710                                                     ses->in2out.fib_index);
711                 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
712                 kv.key = ses->in2out.as_u64;
713                 clib_bihash_add_del_8_8 (&sm->in2out, &kv, 0);
714                 kv.key = ses->out2in.as_u64;
715                 clib_bihash_add_del_8_8 (&sm->out2in, &kv, 0);
716                 clib_dlist_remove (tsm->list_pool, ses->per_user_index);
717                 user_key.addr = ses->in2out.addr;
718                 user_key.fib_index = ses->in2out.fib_index;
719                 kv.key = user_key.as_u64;
720                 if (!clib_bihash_search_8_8 (&sm->user_hash, &kv, &value))
721                   {
722                     u = pool_elt_at_index (tsm->users, value.value);
723                     u->nsessions--;
724                   }
725               }
726           }));
727
728           vec_foreach (ses_index, ses_to_be_removed)
729             pool_put_index (tsm->sessions, ses_index[0]);
730
731           vec_free (ses_to_be_removed);
732        }
733     }
734
735   vec_del1 (sm->addresses, i);
736
737   /* Delete external address from FIB */
738   pool_foreach (interface, sm->interfaces,
739   ({
740     if (interface->is_inside)
741       continue;
742
743     snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
744     break;
745   }));
746
747   return 0;
748 }
749
750 static int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
751 {
752   snat_main_t *sm = &snat_main;
753   snat_interface_t *i;
754   const char * feature_name;
755   snat_address_t * ap;
756   snat_static_mapping_t * m;
757   snat_det_map_t * dm;
758
759   if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
760     feature_name = is_inside ?  "snat-in2out-fast" : "snat-out2in-fast";
761   else
762     {
763       if (sm->num_workers > 1 && !sm->deterministic)
764         feature_name = is_inside ?  "snat-in2out-worker-handoff" : "snat-out2in-worker-handoff";
765       else if (sm->deterministic)
766         feature_name = is_inside ?  "snat-det-in2out" : "snat-det-out2in";
767       else
768         feature_name = is_inside ?  "snat-in2out" : "snat-out2in";
769     }
770
771   vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index,
772                                !is_del, 0, 0);
773
774   if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
775     sm->fq_in2out_index = vlib_frame_queue_main_init (sm->in2out_node_index, 0);
776
777   if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
778     sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index, 0);
779
780   pool_foreach (i, sm->interfaces,
781   ({
782     if (i->sw_if_index == sw_if_index)
783       {
784         if (is_del)
785           pool_put (sm->interfaces, i);
786         else
787           return VNET_API_ERROR_VALUE_EXIST;
788
789         goto fib;
790       }
791   }));
792
793   if (is_del)
794     return VNET_API_ERROR_NO_SUCH_ENTRY;
795
796   pool_get (sm->interfaces, i);
797   i->sw_if_index = sw_if_index;
798   i->is_inside = is_inside;
799
800   /* Add/delete external addresses to FIB */
801 fib:
802   if (is_inside)
803     return 0;
804
805   vec_foreach (ap, sm->addresses)
806     snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
807
808   pool_foreach (m, sm->static_mappings,
809   ({
810     if (!(m->addr_only))
811       continue;
812
813     snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
814   }));
815
816   pool_foreach (dm, sm->det_maps,
817   ({
818     snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
819   }));
820
821   return 0;
822 }
823
824 static int snat_set_workers (uword * bitmap)
825 {
826   snat_main_t *sm = &snat_main;
827   int i;
828
829   if (sm->num_workers < 2)
830     return VNET_API_ERROR_FEATURE_DISABLED;
831
832   if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
833     return VNET_API_ERROR_INVALID_WORKER;
834
835   vec_free (sm->workers);
836   clib_bitmap_foreach (i, bitmap,
837     ({
838       vec_add1(sm->workers, i);
839     }));
840
841   return 0;
842 }
843
844 static void 
845 vl_api_snat_add_address_range_t_handler
846 (vl_api_snat_add_address_range_t * mp)
847 {
848   snat_main_t * sm = &snat_main;
849   vl_api_snat_add_address_range_reply_t * rmp;
850   ip4_address_t this_addr;
851   u32 start_host_order, end_host_order;
852   u32 vrf_id;
853   int i, count;
854   int rv = 0;
855   u32 * tmp;
856
857   if (mp->is_ip4 != 1)
858     {
859       rv = VNET_API_ERROR_UNIMPLEMENTED;
860       goto send_reply;
861     }
862
863   if (sm->static_mapping_only)
864     {
865       rv = VNET_API_ERROR_FEATURE_DISABLED;
866       goto send_reply;
867     }
868
869   tmp = (u32 *) mp->first_ip_address;
870   start_host_order = clib_host_to_net_u32 (tmp[0]);
871   tmp = (u32 *) mp->last_ip_address;
872   end_host_order = clib_host_to_net_u32 (tmp[0]);
873
874   count = (end_host_order - start_host_order) + 1;
875
876   vrf_id = clib_host_to_net_u32 (mp->vrf_id);
877
878   if (count > 1024)
879     clib_warning ("%U - %U, %d addresses...",
880                   format_ip4_address, mp->first_ip_address,
881                   format_ip4_address, mp->last_ip_address,
882                   count);
883   
884   memcpy (&this_addr.as_u8, mp->first_ip_address, 4);
885
886   for (i = 0; i < count; i++)
887     {
888       if (mp->is_add)
889         snat_add_address (sm, &this_addr, vrf_id);
890       else
891         rv = snat_del_address (sm, this_addr, 0);
892
893       if (rv)
894         goto send_reply;
895
896       increment_v4_address (&this_addr);
897     }
898
899  send_reply:
900   REPLY_MACRO (VL_API_SNAT_ADD_ADDRESS_RANGE_REPLY);
901 }
902
903 static void *vl_api_snat_add_address_range_t_print
904 (vl_api_snat_add_address_range_t *mp, void * handle)
905 {
906   u8 * s;
907
908   s = format (0, "SCRIPT: snat_add_address_range ");
909   s = format (s, "%U ", format_ip4_address, mp->first_ip_address);
910   if (memcmp (mp->first_ip_address, mp->last_ip_address, 4))
911     {
912       s = format (s, " - %U ", format_ip4_address, mp->last_ip_address);
913     }
914   FINISH;
915 }
916
917 static void
918 send_snat_address_details
919 (snat_address_t * a, unix_shared_memory_queue_t * q, u32 context)
920 {
921   vl_api_snat_address_details_t *rmp;
922   snat_main_t * sm = &snat_main;
923
924   rmp = vl_msg_api_alloc (sizeof (*rmp));
925   memset (rmp, 0, sizeof (*rmp));
926   rmp->_vl_msg_id = ntohs (VL_API_SNAT_ADDRESS_DETAILS+sm->msg_id_base);
927   rmp->is_ip4 = 1;
928   clib_memcpy (rmp->ip_address, &(a->addr), 4);
929   if (a->fib_index != ~0)
930     rmp->vrf_id = ntohl(ip4_fib_get(a->fib_index)->table_id);
931   else
932     rmp->vrf_id = ~0;
933   rmp->context = context;
934
935   vl_msg_api_send_shmem (q, (u8 *) & rmp);
936 }
937
938 static void
939 vl_api_snat_address_dump_t_handler
940 (vl_api_snat_address_dump_t * mp)
941 {
942   unix_shared_memory_queue_t *q;
943   snat_main_t * sm = &snat_main;
944   snat_address_t * a;
945
946   q = vl_api_client_index_to_input_queue (mp->client_index);
947   if (q == 0)
948     return;
949
950   vec_foreach (a, sm->addresses)
951     send_snat_address_details (a, q, mp->context);
952 }
953
954 static void *vl_api_snat_address_dump_t_print
955 (vl_api_snat_address_dump_t *mp, void * handle)
956 {
957   u8 *s;
958
959   s = format (0, "SCRIPT: snat_address_dump ");
960
961   FINISH;
962 }
963
964 static void
965 vl_api_snat_interface_add_del_feature_t_handler
966 (vl_api_snat_interface_add_del_feature_t * mp)
967 {
968   snat_main_t * sm = &snat_main;
969   vl_api_snat_interface_add_del_feature_reply_t * rmp;
970   u8 is_del = mp->is_add == 0;
971   u32 sw_if_index = ntohl(mp->sw_if_index);
972   int rv = 0;
973
974   VALIDATE_SW_IF_INDEX(mp);
975
976   rv = snat_interface_add_del (sw_if_index, mp->is_inside, is_del);
977   
978   BAD_SW_IF_INDEX_LABEL;
979
980   REPLY_MACRO(VL_API_SNAT_INTERFACE_ADD_DEL_FEATURE_REPLY);
981 }
982
983 static void *vl_api_snat_interface_add_del_feature_t_print
984 (vl_api_snat_interface_add_del_feature_t * mp, void *handle)
985 {
986   u8 * s;
987
988   s = format (0, "SCRIPT: snat_interface_add_del_feature ");
989   s = format (s, "sw_if_index %d %s %s",
990               clib_host_to_net_u32(mp->sw_if_index),
991               mp->is_inside ? "in":"out",
992               mp->is_add ? "" : "del");
993
994   FINISH;
995 }
996
997 static void
998 send_snat_interface_details
999 (snat_interface_t * i, unix_shared_memory_queue_t * q, u32 context)
1000 {
1001   vl_api_snat_interface_details_t *rmp;
1002   snat_main_t * sm = &snat_main;
1003
1004   rmp = vl_msg_api_alloc (sizeof (*rmp));
1005   memset (rmp, 0, sizeof (*rmp));
1006   rmp->_vl_msg_id = ntohs (VL_API_SNAT_INTERFACE_DETAILS+sm->msg_id_base);
1007   rmp->sw_if_index = ntohl (i->sw_if_index);
1008   rmp->is_inside = i->is_inside;
1009   rmp->context = context;
1010
1011   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1012 }
1013
1014 static void
1015 vl_api_snat_interface_dump_t_handler
1016 (vl_api_snat_interface_dump_t * mp)
1017 {
1018   unix_shared_memory_queue_t *q;
1019   snat_main_t * sm = &snat_main;
1020   snat_interface_t * i;
1021
1022   q = vl_api_client_index_to_input_queue (mp->client_index);
1023   if (q == 0)
1024     return;
1025
1026   pool_foreach (i, sm->interfaces,
1027   ({
1028     send_snat_interface_details(i, q, mp->context);
1029   }));
1030 }
1031
1032 static void *vl_api_snat_interface_dump_t_print
1033 (vl_api_snat_interface_dump_t *mp, void * handle)
1034 {
1035   u8 *s;
1036
1037   s = format (0, "SCRIPT: snat_interface_dump ");
1038
1039   FINISH;
1040 }static void
1041
1042 vl_api_snat_add_static_mapping_t_handler
1043 (vl_api_snat_add_static_mapping_t * mp)
1044 {
1045   snat_main_t * sm = &snat_main;
1046   vl_api_snat_add_static_mapping_reply_t * rmp;
1047   ip4_address_t local_addr, external_addr;
1048   u16 local_port = 0, external_port = 0;
1049   u32 vrf_id, external_sw_if_index;
1050   int rv = 0;
1051   snat_protocol_t proto;
1052
1053   if (mp->is_ip4 != 1)
1054     {
1055       rv = VNET_API_ERROR_UNIMPLEMENTED;
1056       goto send_reply;
1057     }
1058
1059   memcpy (&local_addr.as_u8, mp->local_ip_address, 4);
1060   memcpy (&external_addr.as_u8, mp->external_ip_address, 4);
1061   if (mp->addr_only == 0)
1062     {
1063       local_port = clib_net_to_host_u16 (mp->local_port);
1064       external_port = clib_net_to_host_u16 (mp->external_port);
1065     }
1066   vrf_id = clib_net_to_host_u32 (mp->vrf_id);
1067   external_sw_if_index = clib_net_to_host_u32 (mp->external_sw_if_index);
1068   proto = ip_proto_to_snat_proto (mp->protocol);
1069
1070   rv = snat_add_static_mapping(local_addr, external_addr, local_port,
1071                                external_port, vrf_id, mp->addr_only,
1072                                external_sw_if_index, proto, mp->is_add);
1073
1074  send_reply:
1075   REPLY_MACRO (VL_API_SNAT_ADD_ADDRESS_RANGE_REPLY);
1076 }
1077
1078 static void *vl_api_snat_add_static_mapping_t_print
1079 (vl_api_snat_add_static_mapping_t *mp, void * handle)
1080 {
1081   u8 * s;
1082
1083   s = format (0, "SCRIPT: snat_add_static_mapping ");
1084   s = format (s, "protocol %d local_addr %U external_addr %U ",
1085               mp->protocol,
1086               format_ip4_address, mp->local_ip_address,
1087               format_ip4_address, mp->external_ip_address);
1088
1089   if (mp->addr_only == 0)
1090     s = format (s, "local_port %d external_port %d ",
1091                 clib_net_to_host_u16 (mp->local_port),
1092                 clib_net_to_host_u16 (mp->external_port));
1093
1094   if (mp->vrf_id != ~0)
1095     s = format (s, "vrf %d", clib_net_to_host_u32 (mp->vrf_id));
1096
1097   if (mp->external_sw_if_index != ~0)
1098     s = format (s, "external_sw_if_index %d",
1099                 clib_net_to_host_u32 (mp->external_sw_if_index));
1100   FINISH;
1101 }
1102
1103 static void
1104 send_snat_static_mapping_details
1105 (snat_static_mapping_t * m, unix_shared_memory_queue_t * q, u32 context)
1106 {
1107   vl_api_snat_static_mapping_details_t *rmp;
1108   snat_main_t * sm = &snat_main;
1109
1110   rmp = vl_msg_api_alloc (sizeof (*rmp));
1111   memset (rmp, 0, sizeof (*rmp));
1112   rmp->_vl_msg_id = ntohs (VL_API_SNAT_STATIC_MAPPING_DETAILS+sm->msg_id_base);
1113   rmp->is_ip4 = 1;
1114   rmp->addr_only = m->addr_only;
1115   clib_memcpy (rmp->local_ip_address, &(m->local_addr), 4);
1116   clib_memcpy (rmp->external_ip_address, &(m->external_addr), 4);
1117   rmp->local_port = htons (m->local_port);
1118   rmp->external_port = htons (m->external_port);
1119   rmp->external_sw_if_index = ~0; 
1120   rmp->vrf_id = htonl (m->vrf_id);
1121   rmp->protocol = snat_proto_to_ip_proto (m->proto);
1122   rmp->context = context;
1123
1124   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1125 }
1126
1127 static void
1128 send_snat_static_map_resolve_details
1129 (snat_static_map_resolve_t * m, unix_shared_memory_queue_t * q, u32 context)
1130 {
1131   vl_api_snat_static_mapping_details_t *rmp;
1132   snat_main_t * sm = &snat_main;
1133
1134   rmp = vl_msg_api_alloc (sizeof (*rmp));
1135   memset (rmp, 0, sizeof (*rmp));
1136   rmp->_vl_msg_id = ntohs (VL_API_SNAT_STATIC_MAPPING_DETAILS+sm->msg_id_base);
1137   rmp->is_ip4 = 1;
1138   rmp->addr_only = m->addr_only;
1139   clib_memcpy (rmp->local_ip_address, &(m->l_addr), 4);
1140   rmp->local_port = htons (m->l_port);
1141   rmp->external_port = htons (m->e_port);
1142   rmp->external_sw_if_index = htonl (m->sw_if_index); 
1143   rmp->vrf_id = htonl (m->vrf_id);
1144   rmp->protocol = snat_proto_to_ip_proto (m->proto);
1145   rmp->context = context;
1146
1147   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1148 }
1149
1150 static void
1151 vl_api_snat_static_mapping_dump_t_handler
1152 (vl_api_snat_static_mapping_dump_t * mp)
1153 {
1154   unix_shared_memory_queue_t *q;
1155   snat_main_t * sm = &snat_main;
1156   snat_static_mapping_t * m;
1157   snat_static_map_resolve_t *rp;
1158   int j;
1159
1160   q = vl_api_client_index_to_input_queue (mp->client_index);
1161   if (q == 0)
1162     return;
1163
1164   pool_foreach (m, sm->static_mappings,
1165   ({
1166       send_snat_static_mapping_details (m, q, mp->context);
1167   }));
1168
1169   for (j = 0; j < vec_len (sm->to_resolve); j++)
1170    {
1171      rp = sm->to_resolve + j;
1172      send_snat_static_map_resolve_details (rp, q, mp->context);
1173    }
1174 }
1175
1176 static void *vl_api_snat_static_mapping_dump_t_print
1177 (vl_api_snat_static_mapping_dump_t *mp, void * handle)
1178 {
1179   u8 *s;
1180
1181   s = format (0, "SCRIPT: snat_static_mapping_dump ");
1182
1183   FINISH;
1184 }
1185
1186 static void
1187 vl_api_snat_control_ping_t_handler
1188 (vl_api_snat_control_ping_t * mp)
1189 {
1190   vl_api_snat_control_ping_reply_t *rmp;
1191   snat_main_t * sm = &snat_main;
1192   int rv = 0;
1193
1194   REPLY_MACRO2(VL_API_SNAT_CONTROL_PING_REPLY,
1195   ({
1196     rmp->vpe_pid = ntohl (getpid());
1197   }));
1198 }
1199
1200 static void *vl_api_snat_control_ping_t_print
1201 (vl_api_snat_control_ping_t *mp, void * handle)
1202 {
1203   u8 *s;
1204
1205   s = format (0, "SCRIPT: snat_control_ping ");
1206
1207   FINISH;
1208 }
1209
1210 static void
1211 vl_api_snat_show_config_t_handler
1212 (vl_api_snat_show_config_t * mp)
1213 {
1214   vl_api_snat_show_config_reply_t *rmp;
1215   snat_main_t * sm = &snat_main;
1216   int rv = 0;
1217
1218   REPLY_MACRO2(VL_API_SNAT_SHOW_CONFIG_REPLY,
1219   ({
1220     rmp->translation_buckets = htonl (sm->translation_buckets);
1221     rmp->translation_memory_size = htonl (sm->translation_memory_size);
1222     rmp->user_buckets = htonl (sm->user_buckets);
1223     rmp->user_memory_size = htonl (sm->user_memory_size);
1224     rmp->max_translations_per_user = htonl (sm->max_translations_per_user);
1225     rmp->outside_vrf_id = htonl (sm->outside_vrf_id);
1226     rmp->inside_vrf_id = htonl (sm->inside_vrf_id);
1227     rmp->static_mapping_only = sm->static_mapping_only;
1228     rmp->static_mapping_connection_tracking =
1229       sm->static_mapping_connection_tracking;
1230     rmp->deterministic = sm->deterministic;
1231   }));
1232 }
1233
1234 static void *vl_api_snat_show_config_t_print
1235 (vl_api_snat_show_config_t *mp, void * handle)
1236 {
1237   u8 *s;
1238
1239   s = format (0, "SCRIPT: snat_show_config ");
1240
1241   FINISH;
1242 }
1243
1244 static void 
1245 vl_api_snat_set_workers_t_handler
1246 (vl_api_snat_set_workers_t * mp)
1247 {
1248   snat_main_t * sm = &snat_main;
1249   vl_api_snat_set_workers_reply_t * rmp;
1250   int rv = 0;
1251   uword *bitmap = 0;
1252   u64 mask = clib_net_to_host_u64 (mp->worker_mask);
1253
1254   if (sm->num_workers < 2)
1255     {
1256       rv = VNET_API_ERROR_FEATURE_DISABLED;
1257       goto send_reply;
1258     }
1259
1260   bitmap = clib_bitmap_set_multiple (bitmap, 0, mask, BITS (mask)); 
1261   rv = snat_set_workers(bitmap);
1262   clib_bitmap_free (bitmap);
1263
1264  send_reply:
1265   REPLY_MACRO (VL_API_SNAT_SET_WORKERS_REPLY);
1266 }
1267
1268 static void *vl_api_snat_set_workers_t_print
1269 (vl_api_snat_set_workers_t *mp, void * handle)
1270 {
1271   u8 * s;
1272   uword *bitmap = 0;
1273   u8 first = 1;
1274   int i;
1275   u64 mask = clib_net_to_host_u64 (mp->worker_mask);
1276
1277   s = format (0, "SCRIPT: snat_set_workers ");
1278   bitmap = clib_bitmap_set_multiple (bitmap, 0, mask, BITS (mask)); 
1279   clib_bitmap_foreach (i, bitmap,
1280     ({
1281       if (first)
1282         s = format (s, "%d", i);
1283       else
1284         s = format (s, ",%d", i);
1285       first = 0;
1286     }));
1287   clib_bitmap_free (bitmap);
1288   FINISH;
1289 }
1290
1291 static void
1292 send_snat_worker_details
1293 (u32 worker_index, unix_shared_memory_queue_t * q, u32 context)
1294 {
1295   vl_api_snat_worker_details_t *rmp;
1296   snat_main_t * sm = &snat_main;
1297   vlib_worker_thread_t *w =
1298     vlib_worker_threads + worker_index + sm->first_worker_index;
1299
1300   rmp = vl_msg_api_alloc (sizeof (*rmp));
1301   memset (rmp, 0, sizeof (*rmp));
1302   rmp->_vl_msg_id = ntohs (VL_API_SNAT_WORKER_DETAILS+sm->msg_id_base);
1303   rmp->context = context;
1304   rmp->worker_index = htonl (worker_index);
1305   rmp->lcore_id = htonl (w->lcore_id);
1306   strncpy ((char *) rmp->name, (char *) w->name, ARRAY_LEN (rmp->name) - 1);
1307
1308   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1309 }
1310
1311 static void
1312 vl_api_snat_worker_dump_t_handler
1313 (vl_api_snat_worker_dump_t * mp)
1314 {
1315   unix_shared_memory_queue_t *q;
1316   snat_main_t * sm = &snat_main;
1317   u32 * worker_index;
1318
1319   q = vl_api_client_index_to_input_queue (mp->client_index);
1320   if (q == 0)
1321     return;
1322
1323   vec_foreach (worker_index, sm->workers)
1324     {
1325       send_snat_worker_details(*worker_index, q, mp->context);
1326     }
1327 }
1328
1329 static void *vl_api_snat_worker_dump_t_print
1330 (vl_api_snat_worker_dump_t *mp, void * handle)
1331 {
1332   u8 *s;
1333
1334   s = format (0, "SCRIPT: snat_worker_dump ");
1335
1336   FINISH;
1337 }
1338
1339 static int snat_add_interface_address(snat_main_t *sm,
1340                                       u32 sw_if_index,
1341                                       int is_del);
1342
1343 static void
1344 vl_api_snat_add_del_interface_addr_t_handler
1345 (vl_api_snat_add_del_interface_addr_t * mp)
1346 {
1347   snat_main_t * sm = &snat_main;
1348   vl_api_snat_add_del_interface_addr_reply_t * rmp;
1349   u8 is_del = mp->is_add == 0;
1350   u32 sw_if_index = ntohl(mp->sw_if_index);
1351   int rv = 0;
1352
1353   VALIDATE_SW_IF_INDEX(mp);
1354
1355   rv = snat_add_interface_address (sm, sw_if_index, is_del);
1356   
1357   BAD_SW_IF_INDEX_LABEL;
1358
1359   REPLY_MACRO(VL_API_SNAT_ADD_DEL_INTERFACE_ADDR_REPLY);
1360 }
1361
1362 static void *vl_api_snat_add_del_interface_addr_t_print
1363 (vl_api_snat_add_del_interface_addr_t * mp, void *handle)
1364 {
1365   u8 * s;
1366
1367   s = format (0, "SCRIPT: snat_add_del_interface_addr ");
1368   s = format (s, "sw_if_index %d %s",
1369               clib_host_to_net_u32(mp->sw_if_index),
1370               mp->is_add ? "" : "del");
1371
1372   FINISH;
1373 }
1374
1375 static void
1376 send_snat_interface_addr_details
1377 (u32 sw_if_index, unix_shared_memory_queue_t * q, u32 context)
1378 {
1379   vl_api_snat_interface_addr_details_t *rmp;
1380   snat_main_t * sm = &snat_main;
1381
1382   rmp = vl_msg_api_alloc (sizeof (*rmp));
1383   memset (rmp, 0, sizeof (*rmp));
1384   rmp->_vl_msg_id = ntohs (VL_API_SNAT_INTERFACE_ADDR_DETAILS+sm->msg_id_base);
1385   rmp->sw_if_index = ntohl (sw_if_index);
1386   rmp->context = context;
1387
1388   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1389 }
1390
1391 static void
1392 vl_api_snat_interface_addr_dump_t_handler
1393 (vl_api_snat_interface_addr_dump_t * mp)
1394 {
1395   unix_shared_memory_queue_t *q;
1396   snat_main_t * sm = &snat_main;
1397   u32 * i;
1398
1399   q = vl_api_client_index_to_input_queue (mp->client_index);
1400   if (q == 0)
1401     return;
1402
1403   vec_foreach (i, sm->auto_add_sw_if_indices)
1404     send_snat_interface_addr_details(*i, q, mp->context);
1405 }
1406
1407 static void *vl_api_snat_interface_addr_dump_t_print
1408 (vl_api_snat_interface_addr_dump_t *mp, void * handle)
1409 {
1410   u8 *s;
1411
1412   s = format (0, "SCRIPT: snat_interface_addr_dump ");
1413
1414   FINISH;
1415 }
1416
1417 static void
1418 vl_api_snat_ipfix_enable_disable_t_handler
1419 (vl_api_snat_ipfix_enable_disable_t * mp)
1420 {
1421   snat_main_t * sm = &snat_main;
1422   vl_api_snat_ipfix_enable_disable_reply_t * rmp;
1423   int rv = 0;
1424
1425   rv = snat_ipfix_logging_enable_disable(mp->enable,
1426                                          clib_host_to_net_u32 (mp->domain_id),
1427                                          clib_host_to_net_u16 (mp->src_port));
1428
1429   REPLY_MACRO (VL_API_SNAT_IPFIX_ENABLE_DISABLE_REPLY);
1430 }
1431
1432 static void *vl_api_snat_ipfix_enable_disable_t_print
1433 (vl_api_snat_ipfix_enable_disable_t *mp, void * handle)
1434 {
1435   u8 * s;
1436
1437   s = format (0, "SCRIPT: snat_ipfix_enable_disable ");
1438   if (mp->domain_id)
1439     s = format (s, "domain %d ", clib_net_to_host_u32 (mp->domain_id));
1440   if (mp->src_port)
1441     s = format (s, "src_port %d ", clib_net_to_host_u16 (mp->src_port));
1442   if (!mp->enable)
1443     s = format (s, "disable ");
1444
1445   FINISH;
1446 }
1447
1448 static void
1449 send_snat_user_details
1450 (snat_user_t * u, unix_shared_memory_queue_t * q, u32 context)
1451 {
1452   vl_api_snat_user_details_t * rmp;
1453   snat_main_t * sm = &snat_main;
1454   ip4_fib_t * fib_table;
1455
1456   rmp = vl_msg_api_alloc (sizeof (*rmp));
1457   memset (rmp, 0, sizeof (*rmp));
1458   rmp->_vl_msg_id = ntohs (VL_API_SNAT_USER_DETAILS+sm->msg_id_base);
1459
1460   fib_table = ip4_fib_get(u->fib_index);
1461   rmp->vrf_id = ntohl (fib_table->table_id);
1462
1463   rmp->is_ip4 = 1;
1464   clib_memcpy(rmp->ip_address, &(u->addr), 4);
1465   rmp->nsessions = ntohl (u->nsessions);
1466   rmp->nstaticsessions = ntohl (u->nstaticsessions);
1467   rmp->context = context;
1468
1469   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1470 }
1471
1472 static void
1473 vl_api_snat_user_dump_t_handler
1474 (vl_api_snat_user_dump_t * mp)
1475 {
1476   unix_shared_memory_queue_t *q;
1477   snat_main_t * sm = &snat_main;
1478   snat_main_per_thread_data_t * tsm;
1479   snat_user_t * u;
1480
1481   q = vl_api_client_index_to_input_queue (mp->client_index);
1482   if (q == 0)
1483     return;
1484
1485   vec_foreach (tsm, sm->per_thread_data)
1486     vec_foreach (u, tsm->users)
1487       send_snat_user_details (u, q, mp->context);
1488 }
1489
1490 static void *vl_api_snat_user_dump_t_print
1491 (vl_api_snat_user_dump_t *mp, void * handle)
1492 {
1493   u8 *s;
1494
1495   s = format (0, "SCRIPT: snat_user_dump ");
1496
1497   FINISH;
1498 }
1499
1500 static void
1501 send_snat_user_session_details
1502 (snat_session_t * s, unix_shared_memory_queue_t * q, u32 context)
1503 {
1504   vl_api_snat_user_session_details_t * rmp;
1505   snat_main_t * sm = &snat_main;
1506
1507   rmp = vl_msg_api_alloc (sizeof(*rmp));
1508   memset (rmp, 0, sizeof (*rmp));
1509   rmp->_vl_msg_id = ntohs (VL_API_SNAT_USER_SESSION_DETAILS+sm->msg_id_base);
1510   rmp->is_ip4 = 1;
1511   clib_memcpy(rmp->outside_ip_address, (&s->out2in.addr), 4);
1512   rmp->outside_port = s->out2in.port;
1513   clib_memcpy(rmp->inside_ip_address, (&s->in2out.addr), 4);
1514   rmp->inside_port = s->in2out.port;
1515   rmp->protocol = ntohs(snat_proto_to_ip_proto(s->in2out.protocol));
1516   rmp->is_static = s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING ? 1 : 0;
1517   rmp->last_heard = clib_host_to_net_u64((u64)s->last_heard);
1518   rmp->total_bytes = clib_host_to_net_u64(s->total_bytes);
1519   rmp->total_pkts = ntohl(s->total_pkts);
1520   rmp->context = context;
1521
1522   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1523 }
1524
1525 static void
1526 vl_api_snat_user_session_dump_t_handler
1527 (vl_api_snat_user_session_dump_t * mp)
1528 {
1529   unix_shared_memory_queue_t *q;
1530   snat_main_t * sm = &snat_main;
1531   snat_main_per_thread_data_t *tsm;
1532   snat_session_t * s;
1533   clib_bihash_kv_8_8_t key, value;
1534   snat_user_key_t ukey;
1535   snat_user_t * u;
1536   u32 session_index, head_index, elt_index;
1537   dlist_elt_t * head, * elt;
1538
1539   q = vl_api_client_index_to_input_queue (mp->client_index);
1540   if (q == 0)
1541     return;
1542   if (!mp->is_ip4)
1543     return;
1544
1545   clib_memcpy (&ukey.addr, mp->ip_address, 4);
1546   ukey.fib_index = ip4_fib_index_from_table_id (ntohl(mp->vrf_id));
1547   key.key = ukey.as_u64;
1548   if (!clib_bihash_search_8_8 (&sm->worker_by_in, &key, &value))
1549     tsm = vec_elt_at_index (sm->per_thread_data, value.value);
1550   else
1551     tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1552   if (clib_bihash_search_8_8 (&sm->user_hash, &key, &value))
1553     return;
1554   u = pool_elt_at_index (tsm->users, value.value);
1555   if (!u->nsessions && !u->nstaticsessions)
1556     return;
1557
1558   head_index = u->sessions_per_user_list_head_index;
1559   head = pool_elt_at_index (tsm->list_pool, head_index);
1560   elt_index = head->next;
1561   elt = pool_elt_at_index (tsm->list_pool, elt_index);
1562   session_index = elt->value;
1563   while (session_index != ~0)
1564     {
1565       s = pool_elt_at_index (tsm->sessions, session_index);
1566
1567       send_snat_user_session_details (s, q, mp->context);
1568
1569       elt_index = elt->next;
1570       elt = pool_elt_at_index (tsm->list_pool, elt_index);
1571       session_index = elt->value;
1572     }
1573 }
1574
1575 static void *vl_api_snat_user_session_dump_t_print
1576 (vl_api_snat_user_session_dump_t *mp, void * handle)
1577 {
1578   u8 *s;
1579
1580   s = format (0, "SCRIPT: snat_user_session_dump ");
1581   s = format (s, "ip_address %U vrf_id %d\n",
1582               format_ip4_address, mp->ip_address,
1583               clib_net_to_host_u32 (mp->vrf_id));
1584
1585   FINISH;
1586 }
1587
1588 static void
1589 vl_api_snat_add_det_map_t_handler
1590 (vl_api_snat_add_det_map_t * mp)
1591 {
1592   snat_main_t * sm = &snat_main;
1593   vl_api_snat_add_det_map_reply_t * rmp;
1594   int rv = 0;
1595   ip4_address_t in_addr, out_addr;
1596
1597   clib_memcpy(&in_addr, mp->in_addr, 4);
1598   clib_memcpy(&out_addr, mp->out_addr, 4);
1599   rv = snat_det_add_map(sm, &in_addr, mp->in_plen, &out_addr,
1600                         mp->out_plen, mp->is_add);
1601
1602   REPLY_MACRO (VL_API_SNAT_ADD_DET_MAP_REPLY);
1603 }
1604
1605 static void *vl_api_snat_add_det_map_t_print
1606 (vl_api_snat_add_det_map_t *mp, void * handle)
1607 {
1608   u8 * s;
1609
1610   s = format (0, "SCRIPT: snat_add_det_map ");
1611   s = format (s, "inside address %U/%d outside address %U/%d\n",
1612               format_ip4_address, mp->in_addr, mp->in_plen,
1613               format_ip4_address, mp->out_addr, mp->out_plen);
1614
1615   FINISH;
1616 }
1617
1618 static void
1619 vl_api_snat_det_forward_t_handler
1620 (vl_api_snat_det_forward_t * mp)
1621 {
1622   snat_main_t * sm = &snat_main;
1623   vl_api_snat_det_forward_reply_t * rmp;
1624   int rv = 0;
1625   u16 lo_port = 0, hi_port = 0;
1626   snat_det_map_t * dm;
1627   ip4_address_t in_addr, out_addr;
1628
1629   out_addr.as_u32 = 0;
1630   clib_memcpy(&in_addr, mp->in_addr, 4);
1631   dm = snat_det_map_by_user(sm, &in_addr);
1632   if (!dm)
1633     {
1634       rv = VNET_API_ERROR_NO_SUCH_ENTRY;
1635       goto send_reply;
1636     }
1637
1638   snat_det_forward(dm, &in_addr, &out_addr, &lo_port);
1639   hi_port = lo_port + dm->ports_per_host - 1;
1640
1641 send_reply:
1642   REPLY_MACRO2(VL_API_SNAT_DET_FORWARD_REPLY,
1643   ({
1644     rmp->out_port_lo = ntohs(lo_port);
1645     rmp->out_port_hi = ntohs(hi_port);
1646     rmp->is_ip4 = 1;
1647     memset(rmp->out_addr, 0, 16);
1648     clib_memcpy(rmp->out_addr, &out_addr, 4);
1649   }))
1650 }
1651
1652 static void *vl_api_snat_det_forward_t_print
1653 (vl_api_snat_det_forward_t * mp, void * handle)
1654 {
1655   u8 * s;
1656
1657   s = format (0, "SCRIPT: smat_det_forward_t");
1658   s = format (s, "inside ip address %U\n",
1659               format_ip4_address, mp->in_addr);
1660
1661   FINISH;
1662 }
1663
1664 static void
1665 vl_api_snat_det_reverse_t_handler
1666 (vl_api_snat_det_reverse_t * mp)
1667 {
1668   snat_main_t * sm = &snat_main;
1669   vl_api_snat_det_reverse_reply_t * rmp;
1670   int rv = 0;
1671   ip4_address_t out_addr, in_addr;
1672   snat_det_map_t * dm;
1673
1674   in_addr.as_u32 = 0;
1675   clib_memcpy(&out_addr, mp->out_addr, 4);
1676   dm = snat_det_map_by_out(sm, &out_addr);
1677   if (!dm)
1678     {
1679       rv = VNET_API_ERROR_NO_SUCH_ENTRY;
1680       goto send_reply;
1681     }
1682
1683   snat_det_reverse(dm, &out_addr, htons(mp->out_port), &in_addr);
1684
1685  send_reply:
1686   REPLY_MACRO2(VL_API_SNAT_DET_REVERSE_REPLY,
1687   ({
1688     rmp->is_ip4 = 1;
1689     memset(rmp->in_addr, 0, 16);
1690     clib_memcpy(rmp->in_addr, &in_addr, 4);
1691   }))
1692 }
1693
1694 static void *vl_api_snat_det_reverse_t_print
1695 (vl_api_snat_det_reverse_t * mp, void * handle)
1696 {
1697   u8 * s;
1698
1699   s = format(0, "SCRIPT: smat_det_reverse_t");
1700   s = format(s, "outside ip address %U outside port %d",
1701              format_ip4_address, mp->out_addr, ntohs(mp->out_port));
1702
1703   FINISH;
1704 }
1705
1706 static void
1707 sent_snat_det_map_details
1708 (snat_det_map_t * m, unix_shared_memory_queue_t * q, u32 context)
1709 {
1710   vl_api_snat_det_map_details_t *rmp;
1711   snat_main_t * sm = &snat_main;
1712
1713   rmp = vl_msg_api_alloc (sizeof (*rmp));
1714   memset (rmp, 0, sizeof (*rmp));
1715   rmp->_vl_msg_id = ntohs (VL_API_SNAT_DET_MAP_DETAILS+sm->msg_id_base);
1716   rmp->is_ip4 = 1;
1717   clib_memcpy (rmp->in_addr, &m->in_addr, 4);
1718   rmp->in_plen = m->in_plen;
1719   clib_memcpy (rmp->out_addr, &m->out_addr, 4);
1720   rmp->out_plen = m->out_plen;
1721   rmp->sharing_ratio = htonl (m->sharing_ratio);
1722   rmp->ports_per_host = htons (m->ports_per_host);
1723   rmp->ses_num = htonl (m->ses_num);
1724   rmp->context = context;
1725
1726   vl_msg_api_send_shmem (q, (u8 *) & rmp);
1727 }
1728
1729 static void
1730 vl_api_snat_det_map_dump_t_handler
1731 (vl_api_snat_det_map_dump_t * mp)
1732 {
1733   unix_shared_memory_queue_t *q;
1734   snat_main_t * sm = &snat_main;
1735   snat_det_map_t * m;
1736
1737   q = vl_api_client_index_to_input_queue (mp->client_index);
1738   if (q == 0)
1739     return;
1740
1741   vec_foreach(m, sm->det_maps)
1742     sent_snat_det_map_details(m, q, mp->context);
1743 }
1744
1745 static void * vl_api_snat_det_map_dump_t_print
1746 (vl_api_snat_det_map_dump_t *mp, void * handle)
1747 {
1748   u8 * s;
1749
1750   s = format (0, "SCRIPT: snat_det_map_dump ");
1751
1752   FINISH;
1753 }
1754
1755 /* List of message types that this plugin understands */
1756 #define foreach_snat_plugin_api_msg                                     \
1757 _(SNAT_ADD_ADDRESS_RANGE, snat_add_address_range)                       \
1758 _(SNAT_INTERFACE_ADD_DEL_FEATURE, snat_interface_add_del_feature)       \
1759 _(SNAT_ADD_STATIC_MAPPING, snat_add_static_mapping)                     \
1760 _(SNAT_CONTROL_PING, snat_control_ping)                                 \
1761 _(SNAT_STATIC_MAPPING_DUMP, snat_static_mapping_dump)                   \
1762 _(SNAT_SHOW_CONFIG, snat_show_config)                                   \
1763 _(SNAT_ADDRESS_DUMP, snat_address_dump)                                 \
1764 _(SNAT_INTERFACE_DUMP, snat_interface_dump)                             \
1765 _(SNAT_SET_WORKERS, snat_set_workers)                                   \
1766 _(SNAT_WORKER_DUMP, snat_worker_dump)                                   \
1767 _(SNAT_ADD_DEL_INTERFACE_ADDR, snat_add_del_interface_addr)             \
1768 _(SNAT_INTERFACE_ADDR_DUMP, snat_interface_addr_dump)                   \
1769 _(SNAT_IPFIX_ENABLE_DISABLE, snat_ipfix_enable_disable)                 \
1770 _(SNAT_USER_DUMP, snat_user_dump)                                       \
1771 _(SNAT_USER_SESSION_DUMP, snat_user_session_dump)                       \
1772 _(SNAT_ADD_DET_MAP, snat_add_det_map)                                   \
1773 _(SNAT_DET_FORWARD, snat_det_forward)                                   \
1774 _(SNAT_DET_REVERSE, snat_det_reverse)                                   \
1775 _(SNAT_DET_MAP_DUMP, snat_det_map_dump)
1776
1777 /* Set up the API message handling tables */
1778 static clib_error_t *
1779 snat_plugin_api_hookup (vlib_main_t *vm)
1780 {
1781    snat_main_t * sm __attribute__ ((unused)) = &snat_main;
1782 #define _(N,n)                                                  \
1783     vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base),     \
1784                            #n,                                  \
1785                            vl_api_##n##_t_handler,              \
1786                            vl_noop_handler,                     \
1787                            vl_api_##n##_t_endian,               \
1788                            vl_api_##n##_t_print,                \
1789                            sizeof(vl_api_##n##_t), 1); 
1790     foreach_snat_plugin_api_msg;
1791 #undef _
1792
1793     return 0;
1794 }
1795
1796 #define vl_msg_name_crc_list
1797 #include <snat/snat_all_api_h.h>
1798 #undef vl_msg_name_crc_list
1799
1800 static void
1801 setup_message_id_table (snat_main_t * sm, api_main_t * am)
1802 {
1803 #define _(id,n,crc) \
1804   vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + sm->msg_id_base);
1805   foreach_vl_msg_name_crc_snat;
1806 #undef _
1807 }
1808
1809 static void plugin_custom_dump_configure (snat_main_t * sm) 
1810 {
1811 #define _(n,f) sm->api_main->msg_print_handlers \
1812   [VL_API_##n + sm->msg_id_base]                \
1813     = (void *) vl_api_##f##_t_print;
1814   foreach_snat_plugin_api_msg;
1815 #undef _
1816 }
1817
1818
1819 static void
1820 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
1821                                        uword opaque,
1822                                        u32 sw_if_index,
1823                                        ip4_address_t * address,
1824                                        u32 address_length,
1825                                        u32 if_address_index,
1826                                        u32 is_delete);
1827
1828 static clib_error_t * snat_init (vlib_main_t * vm)
1829 {
1830   snat_main_t * sm = &snat_main;
1831   clib_error_t * error = 0;
1832   ip4_main_t * im = &ip4_main;
1833   ip_lookup_main_t * lm = &im->lookup_main;
1834   u8 * name;
1835   uword *p;
1836   vlib_thread_registration_t *tr;
1837   vlib_thread_main_t *tm = vlib_get_thread_main ();
1838   uword *bitmap = 0;
1839   u32 i;
1840   ip4_add_del_interface_address_callback_t cb4;
1841
1842   name = format (0, "snat_%08x%c", api_version, 0);
1843
1844   /* Ask for a correctly-sized block of API message decode slots */
1845   sm->msg_id_base = vl_msg_api_get_msg_ids 
1846       ((char *) name, VL_MSG_FIRST_AVAILABLE);
1847
1848   sm->vlib_main = vm;
1849   sm->vnet_main = vnet_get_main();
1850   sm->ip4_main = im;
1851   sm->ip4_lookup_main = lm;
1852   sm->api_main = &api_main;
1853   sm->first_worker_index = 0;
1854   sm->next_worker = 0;
1855   sm->num_workers = 0;
1856   sm->workers = 0;
1857   sm->fq_in2out_index = ~0;
1858   sm->fq_out2in_index = ~0;
1859
1860   p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1861   if (p)
1862     {
1863       tr = (vlib_thread_registration_t *) p[0];
1864       if (tr)
1865         {
1866           sm->num_workers = tr->count;
1867           sm->first_worker_index = tr->first_index;
1868         }
1869     }
1870
1871   /* Use all available workers by default */
1872   if (sm->num_workers > 1)
1873     {
1874       for (i=0; i < sm->num_workers; i++)
1875         bitmap = clib_bitmap_set (bitmap, i, 1);
1876       snat_set_workers(bitmap);
1877       clib_bitmap_free (bitmap);
1878     }
1879
1880   error = snat_plugin_api_hookup (vm);
1881
1882   /* Add our API messages to the global name_crc hash table */
1883   setup_message_id_table (sm, &api_main);
1884
1885   plugin_custom_dump_configure (sm);
1886   vec_free(name);
1887
1888   /* Set up the interface address add/del callback */
1889   cb4.function = snat_ip4_add_del_interface_address_cb;
1890   cb4.function_opaque = 0;
1891
1892   vec_add1 (im->add_del_interface_address_callbacks, cb4);
1893
1894   /* Init IPFIX logging */
1895   snat_ipfix_logging_init(vm);
1896
1897   return error;
1898 }
1899
1900 VLIB_INIT_FUNCTION (snat_init);
1901
1902 void snat_free_outside_address_and_port (snat_main_t * sm, 
1903                                          snat_session_key_t * k, 
1904                                          u32 address_index)
1905 {
1906   snat_address_t *a;
1907   u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
1908   
1909   ASSERT (address_index < vec_len (sm->addresses));
1910
1911   a = sm->addresses + address_index;
1912
1913   switch (k->protocol)
1914     {
1915 #define _(N, i, n, s) \
1916     case SNAT_PROTOCOL_##N: \
1917       ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
1918         port_host_byte_order) == 1); \
1919       clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
1920         port_host_byte_order, 0); \
1921       a->busy_##n##_ports--; \
1922       break;
1923       foreach_snat_protocol
1924 #undef _
1925     default:
1926       clib_warning("unknown_protocol");
1927       return;
1928     }
1929 }  
1930
1931 /**
1932  * @brief Match SNAT static mapping.
1933  *
1934  * @param sm          SNAT main.
1935  * @param match       Address and port to match.
1936  * @param mapping     External or local address and port of the matched mapping.
1937  * @param by_external If 0 match by local address otherwise match by external
1938  *                    address.
1939  *
1940  * @returns 0 if match found otherwise 1.
1941  */
1942 int snat_static_mapping_match (snat_main_t * sm,
1943                                snat_session_key_t match,
1944                                snat_session_key_t * mapping,
1945                                u8 by_external)
1946 {
1947   clib_bihash_kv_8_8_t kv, value;
1948   snat_static_mapping_t *m;
1949   snat_session_key_t m_key;
1950   clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
1951
1952   if (by_external)
1953     mapping_hash = &sm->static_mapping_by_external;
1954
1955   m_key.addr = match.addr;
1956   m_key.port = clib_net_to_host_u16 (match.port);
1957   m_key.protocol = match.protocol;
1958   m_key.fib_index = match.fib_index;
1959
1960   kv.key = m_key.as_u64;
1961
1962   if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
1963     {
1964       /* Try address only mapping */
1965       m_key.port = 0;
1966       m_key.protocol = 0;
1967       kv.key = m_key.as_u64;
1968       if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
1969         return 1;
1970     }
1971
1972   m = pool_elt_at_index (sm->static_mappings, value.value);
1973
1974   if (by_external)
1975     {
1976       mapping->addr = m->local_addr;
1977       /* Address only mapping doesn't change port */
1978       mapping->port = m->addr_only ? match.port
1979         : clib_host_to_net_u16 (m->local_port);
1980       mapping->fib_index = m->fib_index;
1981     }
1982   else
1983     {
1984       mapping->addr = m->external_addr;
1985       /* Address only mapping doesn't change port */
1986       mapping->port = m->addr_only ? match.port
1987         : clib_host_to_net_u16 (m->external_port);
1988       mapping->fib_index = sm->outside_fib_index;
1989     }
1990
1991   return 0;
1992 }
1993
1994 int snat_alloc_outside_address_and_port (snat_main_t * sm, 
1995                                          u32 fib_index,
1996                                          snat_session_key_t * k,
1997                                          u32 * address_indexp)
1998 {
1999   int i;
2000   snat_address_t *a;
2001   u32 portnum;
2002
2003   for (i = 0; i < vec_len (sm->addresses); i++)
2004     {
2005       a = sm->addresses + i;
2006       if (sm->vrf_mode && a->fib_index != ~0 && a->fib_index != fib_index)
2007         continue;
2008       switch (k->protocol)
2009         {
2010 #define _(N, j, n, s) \
2011         case SNAT_PROTOCOL_##N: \
2012           if (a->busy_##n##_ports < (65535-1024)) \
2013             { \
2014               while (1) \
2015                 { \
2016                   portnum = random_u32 (&sm->random_seed); \
2017                   portnum &= 0xFFFF; \
2018                   if (portnum < 1024) \
2019                     continue; \
2020                   if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2021                     continue; \
2022                   clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2023                   a->busy_##n##_ports++; \
2024                   k->addr = a->addr; \
2025                   k->port = clib_host_to_net_u16(portnum); \
2026                   *address_indexp = i; \
2027                   return 0; \
2028                 } \
2029             } \
2030           break;
2031           foreach_snat_protocol
2032 #undef _
2033         default:
2034           clib_warning("unknown protocol");
2035           return 1;
2036         }
2037
2038     }
2039   /* Totally out of translations to use... */
2040   snat_ipfix_logging_addresses_exhausted(0);
2041   return 1;
2042 }
2043
2044
2045 static clib_error_t *
2046 add_address_command_fn (vlib_main_t * vm,
2047                         unformat_input_t * input,
2048                         vlib_cli_command_t * cmd)
2049 {
2050   unformat_input_t _line_input, *line_input = &_line_input;
2051   snat_main_t * sm = &snat_main;
2052   ip4_address_t start_addr, end_addr, this_addr;
2053   u32 start_host_order, end_host_order;
2054   u32 vrf_id = ~0;
2055   int i, count;
2056   int is_add = 1;
2057   int rv = 0;
2058   clib_error_t *error = 0;
2059
2060   /* Get a line of input. */
2061   if (!unformat_user (input, unformat_line_input, line_input))
2062     return 0;
2063
2064   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2065     {
2066       if (unformat (line_input, "%U - %U",
2067                     unformat_ip4_address, &start_addr,
2068                     unformat_ip4_address, &end_addr))
2069         ;
2070       else if (unformat (line_input, "tenant-vrf %u", &vrf_id))
2071         ;
2072       else if (unformat (line_input, "%U", unformat_ip4_address, &start_addr))
2073         end_addr = start_addr;
2074       else if (unformat (line_input, "del"))
2075         is_add = 0;
2076       else
2077         {
2078           error = clib_error_return (0, "unknown input '%U'",
2079             format_unformat_error, line_input);
2080           goto done;
2081         }
2082      }
2083
2084   if (sm->static_mapping_only)
2085     {
2086       error = clib_error_return (0, "static mapping only mode");
2087       goto done;
2088     }
2089
2090   start_host_order = clib_host_to_net_u32 (start_addr.as_u32);
2091   end_host_order = clib_host_to_net_u32 (end_addr.as_u32);
2092   
2093   if (end_host_order < start_host_order)
2094     {
2095       error = clib_error_return (0, "end address less than start address");
2096       goto done;
2097     }
2098
2099   count = (end_host_order - start_host_order) + 1;
2100
2101   if (count > 1024)
2102     clib_warning ("%U - %U, %d addresses...",
2103                   format_ip4_address, &start_addr,
2104                   format_ip4_address, &end_addr,
2105                   count);
2106   
2107   this_addr = start_addr;
2108
2109   for (i = 0; i < count; i++)
2110     {
2111       if (is_add)
2112         snat_add_address (sm, &this_addr, vrf_id);
2113       else
2114         rv = snat_del_address (sm, this_addr, 0);
2115
2116       switch (rv)
2117         {
2118         case VNET_API_ERROR_NO_SUCH_ENTRY:
2119           error = clib_error_return (0, "S-NAT address not exist.");
2120           goto done;
2121         case VNET_API_ERROR_UNSPECIFIED:
2122           error = clib_error_return (0, "S-NAT address used in static mapping.");
2123           goto done;
2124         default:
2125           break;
2126         }
2127
2128       increment_v4_address (&this_addr);
2129     }
2130
2131 done:
2132   unformat_free (line_input);
2133
2134   return error;
2135 }
2136
2137 VLIB_CLI_COMMAND (add_address_command, static) = {
2138   .path = "snat add address",
2139   .short_help = "snat add addresses <ip4-range-start> [- <ip4-range-end>] "
2140                 "[tenant-vrf <vrf-id>] [del]",
2141   .function = add_address_command_fn,
2142 };
2143
2144 static clib_error_t *
2145 snat_feature_command_fn (vlib_main_t * vm,
2146                           unformat_input_t * input,
2147                           vlib_cli_command_t * cmd)
2148 {
2149   unformat_input_t _line_input, *line_input = &_line_input;
2150   vnet_main_t * vnm = vnet_get_main();
2151   clib_error_t * error = 0;
2152   u32 sw_if_index;
2153   u32 * inside_sw_if_indices = 0;
2154   u32 * outside_sw_if_indices = 0;
2155   int is_del = 0;
2156   int i;
2157
2158   sw_if_index = ~0;
2159
2160   /* Get a line of input. */
2161   if (!unformat_user (input, unformat_line_input, line_input))
2162     return 0;
2163
2164   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2165     {
2166       if (unformat (line_input, "in %U", unformat_vnet_sw_interface,
2167                     vnm, &sw_if_index))
2168         vec_add1 (inside_sw_if_indices, sw_if_index);
2169       else if (unformat (line_input, "out %U", unformat_vnet_sw_interface,
2170                          vnm, &sw_if_index))
2171         vec_add1 (outside_sw_if_indices, sw_if_index);
2172       else if (unformat (line_input, "del"))
2173         is_del = 1;
2174       else
2175         {
2176           error = clib_error_return (0, "unknown input '%U'",
2177             format_unformat_error, line_input);
2178           goto done;
2179         }
2180     }
2181
2182   if (vec_len (inside_sw_if_indices))
2183     {
2184       for (i = 0; i < vec_len(inside_sw_if_indices); i++)
2185         {
2186           sw_if_index = inside_sw_if_indices[i];
2187           snat_interface_add_del (sw_if_index, 1, is_del);
2188         }
2189     }
2190
2191   if (vec_len (outside_sw_if_indices))
2192     {
2193       for (i = 0; i < vec_len(outside_sw_if_indices); i++)
2194         {
2195           sw_if_index = outside_sw_if_indices[i];
2196           snat_interface_add_del (sw_if_index, 0, is_del);
2197         }
2198     }
2199
2200 done:
2201   unformat_free (line_input);
2202   vec_free (inside_sw_if_indices);
2203   vec_free (outside_sw_if_indices);
2204
2205   return error;
2206 }
2207
2208 VLIB_CLI_COMMAND (set_interface_snat_command, static) = {
2209   .path = "set interface snat",
2210   .function = snat_feature_command_fn,
2211   .short_help = "set interface snat in <intfc> out <intfc> [del]",
2212 };
2213
2214 uword
2215 unformat_snat_protocol (unformat_input_t * input, va_list * args)
2216 {
2217   u32 *r = va_arg (*args, u32 *);
2218
2219   if (0);
2220 #define _(N, i, n, s) else if (unformat (input, s)) *r = SNAT_PROTOCOL_##N;
2221   foreach_snat_protocol
2222 #undef _
2223   else
2224     return 0;
2225   return 1;
2226 }
2227
2228 u8 *
2229 format_snat_protocol (u8 * s, va_list * args)
2230 {
2231   u32 i = va_arg (*args, u32);
2232   u8 *t = 0;
2233
2234   switch (i)
2235     {
2236 #define _(N, j, n, str) case SNAT_PROTOCOL_##N: t = (u8 *) str; break;
2237       foreach_snat_protocol
2238 #undef _
2239     default:
2240       s = format (s, "unknown");
2241     }
2242   s = format (s, "%s", t);
2243   return s;
2244 }
2245
2246 static clib_error_t *
2247 add_static_mapping_command_fn (vlib_main_t * vm,
2248                                unformat_input_t * input,
2249                                vlib_cli_command_t * cmd)
2250 {
2251   unformat_input_t _line_input, *line_input = &_line_input;
2252   clib_error_t * error = 0;
2253   ip4_address_t l_addr, e_addr;
2254   u32 l_port = 0, e_port = 0, vrf_id = ~0;
2255   int is_add = 1;
2256   int addr_only = 1;
2257   u32 sw_if_index = ~0;
2258   vnet_main_t * vnm = vnet_get_main();
2259   int rv;
2260   snat_protocol_t proto;
2261   u8 proto_set = 0;
2262
2263   /* Get a line of input. */
2264   if (!unformat_user (input, unformat_line_input, line_input))
2265     return 0;
2266
2267   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2268     {
2269       if (unformat (line_input, "local %U %u", unformat_ip4_address, &l_addr,
2270                     &l_port))
2271         addr_only = 0;
2272       else if (unformat (line_input, "local %U", unformat_ip4_address, &l_addr))
2273         ;
2274       else if (unformat (line_input, "external %U %u", unformat_ip4_address,
2275                          &e_addr, &e_port))
2276         addr_only = 0;
2277       else if (unformat (line_input, "external %U", unformat_ip4_address,
2278                          &e_addr))
2279         ;
2280       else if (unformat (line_input, "external %U %u",
2281                          unformat_vnet_sw_interface, vnm, &sw_if_index,
2282                          &e_port))
2283         addr_only = 0;
2284
2285       else if (unformat (line_input, "external %U",
2286                          unformat_vnet_sw_interface, vnm, &sw_if_index))
2287         ;
2288       else if (unformat (line_input, "vrf %u", &vrf_id))
2289         ;
2290       else if (unformat (line_input, "%U", unformat_snat_protocol, &proto))
2291         proto_set = 1;
2292       else if (unformat (line_input, "del"))
2293         is_add = 0;
2294       else
2295         {
2296           error = clib_error_return (0, "unknown input: '%U'",
2297             format_unformat_error, line_input);
2298           goto done;
2299         }
2300     }
2301
2302   if (!addr_only && !proto_set)
2303     {
2304       error = clib_error_return (0, "missing protocol");
2305       goto done;
2306     }
2307
2308   rv = snat_add_static_mapping(l_addr, e_addr, (u16) l_port, (u16) e_port,
2309                                vrf_id, addr_only, sw_if_index, proto, is_add);
2310
2311   switch (rv)
2312     {
2313     case VNET_API_ERROR_INVALID_VALUE:
2314       error = clib_error_return (0, "External port already in use.");
2315       goto done;
2316     case VNET_API_ERROR_NO_SUCH_ENTRY:
2317       if (is_add)
2318         error = clib_error_return (0, "External addres must be allocated.");
2319       else
2320         error = clib_error_return (0, "Mapping not exist.");
2321       goto done;
2322     case VNET_API_ERROR_NO_SUCH_FIB:
2323       error = clib_error_return (0, "No such VRF id.");
2324       goto done;
2325     case VNET_API_ERROR_VALUE_EXIST:
2326       error = clib_error_return (0, "Mapping already exist.");
2327       goto done;
2328     default:
2329       break;
2330     }
2331
2332 done:
2333   unformat_free (line_input);
2334
2335   return error;
2336 }
2337
2338 /*?
2339  * @cliexpar
2340  * @cliexstart{snat add static mapping}
2341  * Static mapping allows hosts on the external network to initiate connection
2342  * to to the local network host.
2343  * To create static mapping between local host address 10.0.0.3 port 6303 and
2344  * external address 4.4.4.4 port 3606 for TCP protocol use:
2345  *  vpp# snat add static mapping local tcp 10.0.0.3 6303 external 4.4.4.4 3606
2346  * If not runnig "static mapping only" S-NAT plugin mode use before:
2347  *  vpp# snat add address 4.4.4.4
2348  * To create static mapping between local and external address use:
2349  *  vpp# snat add static mapping local 10.0.0.3 external 4.4.4.4
2350  * @cliexend
2351 ?*/
2352 VLIB_CLI_COMMAND (add_static_mapping_command, static) = {
2353   .path = "snat add static mapping",
2354   .function = add_static_mapping_command_fn,
2355   .short_help =
2356     "snat add static mapping local tcp|udp|icmp <addr> [<port>] external <addr> [<port>] [vrf <table-id>] [del]",
2357 };
2358
2359 static clib_error_t *
2360 set_workers_command_fn (vlib_main_t * vm,
2361                         unformat_input_t * input,
2362                         vlib_cli_command_t * cmd)
2363 {
2364   unformat_input_t _line_input, *line_input = &_line_input;
2365   uword *bitmap = 0;
2366   int rv = 0;
2367   clib_error_t *error = 0;
2368
2369   /* Get a line of input. */
2370   if (!unformat_user (input, unformat_line_input, line_input))
2371     return 0;
2372
2373   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2374     {
2375       if (unformat (line_input, "%U", unformat_bitmap_list, &bitmap))
2376         ;
2377       else
2378         {
2379           error = clib_error_return (0, "unknown input '%U'",
2380             format_unformat_error, line_input);
2381           goto done;
2382         }
2383      }
2384
2385   if (bitmap == 0)
2386     {
2387       error = clib_error_return (0, "List of workers must be specified.");
2388       goto done;
2389     }
2390
2391   rv = snat_set_workers(bitmap);
2392
2393   clib_bitmap_free (bitmap);
2394
2395   switch (rv)
2396     {
2397     case VNET_API_ERROR_INVALID_WORKER:
2398       error = clib_error_return (0, "Invalid worker(s).");
2399       goto done;
2400     case VNET_API_ERROR_FEATURE_DISABLED:
2401       error = clib_error_return (0,
2402         "Supported only if 2 or more workes available.");
2403       goto done;
2404     default:
2405       break;
2406     }
2407
2408 done:
2409   unformat_free (line_input);
2410
2411   return error;
2412 }
2413
2414 /*?
2415  * @cliexpar
2416  * @cliexstart{set snat workers}
2417  * Set SNAT workers if 2 or more workers available, use:
2418  *  vpp# set snat workers 0-2,5
2419  * @cliexend
2420 ?*/
2421 VLIB_CLI_COMMAND (set_workers_command, static) = {
2422   .path = "set snat workers",
2423   .function = set_workers_command_fn,
2424   .short_help =
2425     "set snat workers <workers-list>",
2426 };
2427
2428 static clib_error_t *
2429 snat_ipfix_logging_enable_disable_command_fn (vlib_main_t * vm,
2430                                               unformat_input_t * input,
2431                                               vlib_cli_command_t * cmd)
2432 {
2433   unformat_input_t _line_input, *line_input = &_line_input;
2434   u32 domain_id = 0;
2435   u32 src_port = 0;
2436   u8 enable = 1;
2437   int rv = 0;
2438   clib_error_t *error = 0;
2439
2440   /* Get a line of input. */
2441   if (!unformat_user (input, unformat_line_input, line_input))
2442     return 0;
2443
2444   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2445     {
2446       if (unformat (line_input, "domain %d", &domain_id))
2447         ;
2448       else if (unformat (line_input, "src-port %d", &src_port))
2449         ;
2450       else if (unformat (line_input, "disable"))
2451         enable = 0;
2452       else
2453         {
2454           error = clib_error_return (0, "unknown input '%U'",
2455             format_unformat_error, line_input);
2456           goto done;
2457         }
2458      }
2459
2460   rv = snat_ipfix_logging_enable_disable (enable, domain_id, (u16) src_port);
2461
2462   if (rv)
2463     {
2464       error = clib_error_return (0, "ipfix logging enable failed");
2465       goto done;
2466     }
2467
2468 done:
2469   unformat_free (line_input);
2470
2471   return error;
2472 }
2473
2474 /*?
2475  * @cliexpar
2476  * @cliexstart{snat ipfix logging}
2477  * To enable SNAT IPFIX logging use:
2478  *  vpp# snat ipfix logging
2479  * To set IPFIX exporter use:
2480  *  vpp# set ipfix exporter collector 10.10.10.3 src 10.10.10.1
2481  * @cliexend
2482 ?*/
2483 VLIB_CLI_COMMAND (snat_ipfix_logging_enable_disable_command, static) = {
2484   .path = "snat ipfix logging",
2485   .function = snat_ipfix_logging_enable_disable_command_fn,
2486   .short_help = "snat ipfix logging [domain <domain-id>] [src-port <port>] [disable]",
2487 };
2488
2489 static u32
2490 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2491 {
2492   snat_main_t *sm = &snat_main;
2493   snat_user_key_t key0;
2494   clib_bihash_kv_8_8_t kv0, value0;
2495   u32 next_worker_index = 0;
2496
2497   key0.addr = ip0->src_address;
2498   key0.fib_index = rx_fib_index0;
2499
2500   kv0.key = key0.as_u64;
2501
2502   /* Ever heard of of the "user" before? */
2503   if (clib_bihash_search_8_8 (&sm->worker_by_in, &kv0, &value0))
2504     {
2505       /* No, assign next available worker (RR) */
2506       next_worker_index = sm->first_worker_index;
2507       if (vec_len (sm->workers))
2508         {
2509           next_worker_index +=
2510             sm->workers[sm->next_worker++ % _vec_len (sm->workers)];
2511         }
2512
2513       /* add non-traslated packets worker lookup */
2514       kv0.value = next_worker_index;
2515       clib_bihash_add_del_8_8 (&sm->worker_by_in, &kv0, 1);
2516     }
2517   else
2518     next_worker_index = value0.value;
2519
2520   return next_worker_index;
2521 }
2522
2523 static u32
2524 snat_get_worker_out2in_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2525 {
2526   snat_main_t *sm = &snat_main;
2527   snat_worker_key_t key0;
2528   clib_bihash_kv_8_8_t kv0, value0;
2529   udp_header_t * udp0;
2530   u32 next_worker_index = 0;
2531
2532   udp0 = ip4_next_header (ip0);
2533
2534   key0.addr = ip0->dst_address;
2535   key0.port = udp0->dst_port;
2536   key0.fib_index = rx_fib_index0;
2537
2538   if (PREDICT_FALSE(ip0->protocol == IP_PROTOCOL_ICMP))
2539     {
2540       icmp46_header_t * icmp0 = (icmp46_header_t *) udp0;
2541       icmp_echo_header_t *echo0 = (icmp_echo_header_t *)(icmp0+1);
2542       key0.port = echo0->identifier;
2543     }
2544
2545   kv0.key = key0.as_u64;
2546
2547   /* Ever heard of of the "user" before? */
2548   if (clib_bihash_search_8_8 (&sm->worker_by_out, &kv0, &value0))
2549     {
2550       key0.port = 0;
2551       kv0.key = key0.as_u64;
2552
2553       if (clib_bihash_search_8_8 (&sm->worker_by_out, &kv0, &value0))
2554         {
2555           /* No, assign next available worker (RR) */
2556           next_worker_index = sm->first_worker_index;
2557           if (vec_len (sm->workers))
2558             {
2559               next_worker_index +=
2560                 sm->workers[sm->next_worker++ % _vec_len (sm->workers)];
2561             }
2562         }
2563       else
2564         {
2565           /* Static mapping without port */
2566           next_worker_index = value0.value;
2567         }
2568
2569       /* Add to translated packets worker lookup */
2570       kv0.value = next_worker_index;
2571       clib_bihash_add_del_8_8 (&sm->worker_by_out, &kv0, 1);
2572     }
2573   else
2574     next_worker_index = value0.value;
2575
2576   return next_worker_index;
2577 }
2578
2579 static clib_error_t *
2580 snat_config (vlib_main_t * vm, unformat_input_t * input)
2581 {
2582   snat_main_t * sm = &snat_main;
2583   u32 translation_buckets = 1024;
2584   u32 translation_memory_size = 128<<20;
2585   u32 user_buckets = 128;
2586   u32 user_memory_size = 64<<20;
2587   u32 max_translations_per_user = 100;
2588   u32 outside_vrf_id = 0;
2589   u32 inside_vrf_id = 0;
2590   u32 static_mapping_buckets = 1024;
2591   u32 static_mapping_memory_size = 64<<20;
2592   u8 static_mapping_only = 0;
2593   u8 static_mapping_connection_tracking = 0;
2594   vlib_thread_main_t *tm = vlib_get_thread_main ();
2595
2596   sm->deterministic = 0;
2597
2598   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2599     {
2600       if (unformat (input, "translation hash buckets %d", &translation_buckets))
2601         ;
2602       else if (unformat (input, "translation hash memory %d",
2603                          &translation_memory_size));
2604       else if (unformat (input, "user hash buckets %d", &user_buckets))
2605         ;
2606       else if (unformat (input, "user hash memory %d",
2607                          &user_memory_size))
2608         ;
2609       else if (unformat (input, "max translations per user %d",
2610                          &max_translations_per_user))
2611         ;
2612       else if (unformat (input, "outside VRF id %d",
2613                          &outside_vrf_id))
2614         ;
2615       else if (unformat (input, "inside VRF id %d",
2616                          &inside_vrf_id))
2617         ;
2618       else if (unformat (input, "static mapping only"))
2619         {
2620           static_mapping_only = 1;
2621           if (unformat (input, "connection tracking"))
2622             static_mapping_connection_tracking = 1;
2623         }
2624       else if (unformat (input, "deterministic"))
2625         sm->deterministic = 1;
2626       else
2627         return clib_error_return (0, "unknown input '%U'",
2628                                   format_unformat_error, input);
2629     }
2630
2631   /* for show commands, etc. */
2632   sm->translation_buckets = translation_buckets;
2633   sm->translation_memory_size = translation_memory_size;
2634   sm->user_buckets = user_buckets;
2635   sm->user_memory_size = user_memory_size;
2636   sm->max_translations_per_user = max_translations_per_user;
2637   sm->outside_vrf_id = outside_vrf_id;
2638   sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2639                                                              outside_vrf_id);
2640   sm->inside_vrf_id = inside_vrf_id;
2641   sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2642                                                             inside_vrf_id);
2643   sm->static_mapping_only = static_mapping_only;
2644   sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
2645
2646   if (sm->deterministic)
2647     {
2648       sm->in2out_node_index = snat_det_in2out_node.index;
2649       sm->out2in_node_index = snat_det_out2in_node.index;
2650     }
2651   else
2652     {
2653       sm->worker_in2out_cb = snat_get_worker_in2out_cb;
2654       sm->worker_out2in_cb = snat_get_worker_out2in_cb;
2655       sm->in2out_node_index = snat_in2out_node.index;
2656       sm->out2in_node_index = snat_out2in_node.index;
2657       if (!static_mapping_only ||
2658           (static_mapping_only && static_mapping_connection_tracking))
2659         {
2660           sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
2661           sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
2662
2663           clib_bihash_init_8_8 (&sm->worker_by_in, "worker-by-in", user_buckets,
2664                                 user_memory_size);
2665
2666           clib_bihash_init_8_8 (&sm->worker_by_out, "worker-by-out", user_buckets,
2667                                 user_memory_size);
2668
2669           vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2670
2671           clib_bihash_init_8_8 (&sm->in2out, "in2out", translation_buckets,
2672                                 translation_memory_size);
2673
2674           clib_bihash_init_8_8 (&sm->out2in, "out2in", translation_buckets,
2675                                 translation_memory_size);
2676
2677           clib_bihash_init_8_8 (&sm->user_hash, "users", user_buckets,
2678                                 user_memory_size);
2679         }
2680       else
2681         {
2682           sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
2683           sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
2684         }
2685       clib_bihash_init_8_8 (&sm->static_mapping_by_local,
2686                             "static_mapping_by_local", static_mapping_buckets,
2687                             static_mapping_memory_size);
2688
2689       clib_bihash_init_8_8 (&sm->static_mapping_by_external,
2690                             "static_mapping_by_external", static_mapping_buckets,
2691                             static_mapping_memory_size);
2692     }
2693
2694   return 0;
2695 }
2696
2697 VLIB_CONFIG_FUNCTION (snat_config, "snat");
2698
2699 u8 * format_snat_session_state (u8 * s, va_list * args)
2700 {
2701   u32 i = va_arg (*args, u32);
2702   u8 *t = 0;
2703
2704   switch (i)
2705     {
2706 #define _(v, N, str) case SNAT_SESSION_##N: t = (u8 *) str; break;
2707     foreach_snat_session_state
2708 #undef _
2709     default:
2710       t = format (t, "unknown");
2711     }
2712   s = format (s, "%s", t);
2713   return s;
2714 }
2715
2716 u8 * format_snat_key (u8 * s, va_list * args)
2717 {
2718   snat_session_key_t * key = va_arg (*args, snat_session_key_t *);
2719   char * protocol_string = "unknown";
2720   static char *protocol_strings[] = {
2721       "UDP",
2722       "TCP",
2723       "ICMP",
2724   };
2725
2726   if (key->protocol < ARRAY_LEN(protocol_strings))
2727       protocol_string = protocol_strings[key->protocol];
2728
2729   s = format (s, "%U proto %s port %d fib %d",
2730               format_ip4_address, &key->addr, protocol_string,
2731               clib_net_to_host_u16 (key->port), key->fib_index);
2732   return s;
2733 }
2734
2735 u8 * format_snat_session (u8 * s, va_list * args)
2736 {
2737   snat_main_t * sm __attribute__((unused)) = va_arg (*args, snat_main_t *);
2738   snat_session_t * sess = va_arg (*args, snat_session_t *);
2739
2740   s = format (s, "  i2o %U\n", format_snat_key, &sess->in2out);
2741   s = format (s, "    o2i %U\n", format_snat_key, &sess->out2in);
2742   s = format (s, "       last heard %.2f\n", sess->last_heard);
2743   s = format (s, "       total pkts %d, total bytes %lld\n",
2744               sess->total_pkts, sess->total_bytes);
2745   if (snat_is_session_static (sess))
2746     s = format (s, "       static translation\n");
2747   else
2748     s = format (s, "       dynamic translation\n");
2749
2750   return s;
2751 }
2752
2753 u8 * format_snat_user (u8 * s, va_list * args)
2754 {
2755   snat_main_per_thread_data_t * sm = va_arg (*args, snat_main_per_thread_data_t *);
2756   snat_user_t * u = va_arg (*args, snat_user_t *);
2757   int verbose = va_arg (*args, int);
2758   dlist_elt_t * head, * elt;
2759   u32 elt_index, head_index;
2760   u32 session_index;
2761   snat_session_t * sess;
2762
2763   s = format (s, "%U: %d dynamic translations, %d static translations\n",
2764               format_ip4_address, &u->addr, u->nsessions, u->nstaticsessions);
2765
2766   if (verbose == 0)
2767     return s;
2768
2769   if (u->nsessions || u->nstaticsessions)
2770     {
2771       head_index = u->sessions_per_user_list_head_index;
2772       head = pool_elt_at_index (sm->list_pool, head_index);
2773
2774       elt_index = head->next;
2775       elt = pool_elt_at_index (sm->list_pool, elt_index);
2776       session_index = elt->value;
2777
2778       while (session_index != ~0)
2779         {
2780           sess = pool_elt_at_index (sm->sessions, session_index);
2781
2782           s = format (s, "  %U\n", format_snat_session, sm, sess);
2783
2784           elt_index = elt->next;
2785           elt = pool_elt_at_index (sm->list_pool, elt_index);
2786           session_index = elt->value;
2787         }
2788     }
2789
2790   return s;
2791 }
2792
2793 u8 * format_snat_static_mapping (u8 * s, va_list * args)
2794 {
2795   snat_static_mapping_t *m = va_arg (*args, snat_static_mapping_t *);
2796
2797   if (m->addr_only)
2798       s = format (s, "local %U external %U vrf %d",
2799                   format_ip4_address, &m->local_addr,
2800                   format_ip4_address, &m->external_addr,
2801                   m->vrf_id);
2802   else
2803       s = format (s, "%U local %U:%d external %U:%d vrf %d",
2804                   format_snat_protocol, m->proto,
2805                   format_ip4_address, &m->local_addr, m->local_port,
2806                   format_ip4_address, &m->external_addr, m->external_port,
2807                   m->vrf_id);
2808
2809   return s;
2810 }
2811
2812 u8 * format_snat_static_map_to_resolve (u8 * s, va_list * args)
2813 {
2814   snat_static_map_resolve_t *m = va_arg (*args, snat_static_map_resolve_t *);
2815   vnet_main_t *vnm = vnet_get_main();
2816
2817   if (m->addr_only)
2818       s = format (s, "local %U external %U vrf %d",
2819                   format_ip4_address, &m->l_addr,
2820                   format_vnet_sw_interface_name, vnm,
2821                   vnet_get_sw_interface (vnm, m->sw_if_index),
2822                   m->vrf_id);
2823   else
2824       s = format (s, "%U local %U:%d external %U:%d vrf %d",
2825                   format_snat_protocol, m->proto,
2826                   format_ip4_address, &m->l_addr, m->l_port,
2827                   format_vnet_sw_interface_name, vnm,
2828                   vnet_get_sw_interface (vnm, m->sw_if_index), m->e_port,
2829                   m->vrf_id);
2830
2831   return s;
2832 }
2833
2834 u8 * format_det_map_ses (u8 * s, va_list * args)
2835 {
2836   snat_det_map_t * det_map = va_arg (*args, snat_det_map_t *);
2837   ip4_address_t in_addr, out_addr;
2838   u32 in_offset, out_offset;
2839   snat_det_session_t * ses = va_arg (*args, snat_det_session_t *);
2840   u32 * i = va_arg (*args, u32 *);
2841
2842   u32 user_index = *i / SNAT_DET_SES_PER_USER;
2843   in_addr.as_u32 = clib_host_to_net_u32 (
2844     clib_net_to_host_u32(det_map->in_addr.as_u32) + user_index);
2845   in_offset = clib_net_to_host_u32(in_addr.as_u32) -
2846     clib_net_to_host_u32(det_map->in_addr.as_u32);
2847   out_offset = in_offset / det_map->sharing_ratio;
2848   out_addr.as_u32 = clib_host_to_net_u32(
2849     clib_net_to_host_u32(det_map->out_addr.as_u32) + out_offset);
2850   s = format (s, "in %U:%d out %U:%d external host %U:%d state: %U expire: %d\n",
2851               format_ip4_address, &in_addr,
2852               clib_net_to_host_u16 (ses->in_port),
2853               format_ip4_address, &out_addr,
2854               clib_net_to_host_u16 (ses->out.out_port),
2855               format_ip4_address, &ses->out.ext_host_addr,
2856               clib_net_to_host_u16 (ses->out.ext_host_port),
2857               format_snat_session_state, ses->state,
2858               ses->expire);
2859
2860   return s;
2861 }
2862
2863 static clib_error_t *
2864 show_snat_command_fn (vlib_main_t * vm,
2865                  unformat_input_t * input,
2866                  vlib_cli_command_t * cmd)
2867 {
2868   int verbose = 0;
2869   snat_main_t * sm = &snat_main;
2870   snat_user_t * u;
2871   snat_static_mapping_t *m;
2872   snat_interface_t *i;
2873   snat_address_t * ap;
2874   vnet_main_t *vnm = vnet_get_main();
2875   snat_main_per_thread_data_t *tsm;
2876   u32 users_num = 0, sessions_num = 0, *worker, *sw_if_index;
2877   uword j = 0;
2878   snat_static_map_resolve_t *rp;
2879   snat_det_map_t * dm;
2880   snat_det_session_t * ses;
2881
2882   if (unformat (input, "detail"))
2883     verbose = 1;
2884   else if (unformat (input, "verbose"))
2885     verbose = 2;
2886
2887   if (sm->static_mapping_only)
2888     {
2889       if (sm->static_mapping_connection_tracking)
2890         vlib_cli_output (vm, "SNAT mode: static mapping only connection "
2891                          "tracking");
2892       else
2893         vlib_cli_output (vm, "SNAT mode: static mapping only");
2894     }
2895   else if (sm->deterministic)
2896     {
2897       vlib_cli_output (vm, "SNAT mode: deterministic mapping");
2898     }
2899   else
2900     {
2901       vlib_cli_output (vm, "SNAT mode: dynamic translations enabled");
2902     }
2903
2904   if (verbose > 0)
2905     {
2906       pool_foreach (i, sm->interfaces,
2907       ({
2908         vlib_cli_output (vm, "%U %s", format_vnet_sw_interface_name, vnm,
2909                          vnet_get_sw_interface (vnm, i->sw_if_index),
2910                          i->is_inside ? "in" : "out");
2911       }));
2912
2913       if (vec_len (sm->auto_add_sw_if_indices))
2914         {
2915           vlib_cli_output (vm, "SNAT pool addresses interfaces:");
2916           vec_foreach (sw_if_index, sm->auto_add_sw_if_indices)
2917             {
2918               vlib_cli_output (vm, "%U", format_vnet_sw_interface_name, vnm,
2919                                vnet_get_sw_interface (vnm, *sw_if_index));
2920             }
2921         }
2922
2923       vec_foreach (ap, sm->addresses)
2924         {
2925           vlib_cli_output (vm, "%U", format_ip4_address, &ap->addr);
2926           if (ap->fib_index != ~0)
2927               vlib_cli_output (vm, "  tenant VRF: %u",
2928                                ip4_fib_get(ap->fib_index)->table_id);
2929           else
2930             vlib_cli_output (vm, "  tenant VRF independent");
2931 #define _(N, i, n, s) \
2932           vlib_cli_output (vm, "  %d busy %s ports", ap->busy_##n##_ports, s);
2933           foreach_snat_protocol
2934 #undef _
2935         }
2936     }
2937
2938   if (sm->num_workers > 1)
2939     {
2940       vlib_cli_output (vm, "%d workers", vec_len (sm->workers));
2941       if (verbose > 0)
2942         {
2943           vec_foreach (worker, sm->workers)
2944             {
2945               vlib_worker_thread_t *w =
2946                 vlib_worker_threads + *worker + sm->first_worker_index;
2947               vlib_cli_output (vm, "  %s", w->name);
2948             }
2949         }
2950     }
2951
2952   if (sm->deterministic)
2953     {
2954       vlib_cli_output (vm, "%d deterministic mappings",
2955                        pool_elts (sm->det_maps));
2956       if (verbose > 0)
2957         {
2958           pool_foreach (dm, sm->det_maps,
2959           ({
2960             vlib_cli_output (vm, "in %U/%d out %U/%d\n",
2961                              format_ip4_address, &dm->in_addr, dm->in_plen,
2962                              format_ip4_address, &dm->out_addr, dm->out_plen);
2963             vlib_cli_output (vm, " outside address sharing ratio: %d\n",
2964                              dm->sharing_ratio);
2965             vlib_cli_output (vm, " number of ports per inside host: %d\n",
2966                              dm->ports_per_host);
2967             vlib_cli_output (vm, " sessions number: %d\n", dm->ses_num);
2968             if (verbose > 1)
2969               {
2970                 vec_foreach_index (j, dm->sessions)
2971                   {
2972                     ses = vec_elt_at_index (dm->sessions, j);
2973                     if (ses->in_port)
2974                       vlib_cli_output (vm, "  %U", format_det_map_ses, dm, ses,
2975                                        &j);
2976                   }
2977               }
2978           }));
2979         }
2980     }
2981   else
2982     {
2983       if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
2984         {
2985           vlib_cli_output (vm, "%d static mappings",
2986                            pool_elts (sm->static_mappings));
2987
2988           if (verbose > 0)
2989             {
2990               pool_foreach (m, sm->static_mappings,
2991               ({
2992                 vlib_cli_output (vm, "%U", format_snat_static_mapping, m);
2993               }));
2994             }
2995         }
2996       else
2997         {
2998           vec_foreach (tsm, sm->per_thread_data)
2999             {
3000               users_num += pool_elts (tsm->users);
3001               sessions_num += pool_elts (tsm->sessions);
3002             }
3003
3004           vlib_cli_output (vm, "%d users, %d outside addresses, %d active sessions,"
3005                            " %d static mappings",
3006                            users_num,
3007                            vec_len (sm->addresses),
3008                            sessions_num,
3009                            pool_elts (sm->static_mappings));
3010
3011           if (verbose > 0)
3012             {
3013               vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->in2out,
3014                                verbose - 1);
3015               vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->out2in,
3016                                verbose - 1);
3017               vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->worker_by_in,
3018                                verbose - 1);
3019               vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->worker_by_out,
3020                                verbose - 1);
3021               vec_foreach_index (j, sm->per_thread_data)
3022                 {
3023                   tsm = vec_elt_at_index (sm->per_thread_data, j);
3024
3025                   if (pool_elts (tsm->users) == 0)
3026                     continue;
3027
3028                   vlib_worker_thread_t *w = vlib_worker_threads + j;
3029                   vlib_cli_output (vm, "Thread %d (%s at lcore %u):", j, w->name,
3030                                    w->lcore_id);
3031                   vlib_cli_output (vm, "  %d list pool elements",
3032                                    pool_elts (tsm->list_pool));
3033
3034                   pool_foreach (u, tsm->users,
3035                   ({
3036                     vlib_cli_output (vm, "  %U", format_snat_user, tsm, u,
3037                                      verbose - 1);
3038                   }));
3039                 }
3040
3041               if (pool_elts (sm->static_mappings))
3042                 {
3043                   vlib_cli_output (vm, "static mappings:");
3044                   pool_foreach (m, sm->static_mappings,
3045                   ({
3046                     vlib_cli_output (vm, "%U", format_snat_static_mapping, m);
3047                   }));
3048                   for (j = 0; j < vec_len (sm->to_resolve); j++)
3049                     {
3050                       rp = sm->to_resolve + j;
3051                       vlib_cli_output (vm, "%U",
3052                                        format_snat_static_map_to_resolve, rp);
3053                     }
3054                 }
3055             }
3056         }
3057     }
3058   return 0;
3059 }
3060
3061 VLIB_CLI_COMMAND (show_snat_command, static) = {
3062     .path = "show snat",
3063     .short_help = "show snat",
3064     .function = show_snat_command_fn,
3065 };
3066
3067
3068 static void
3069 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
3070                                        uword opaque,
3071                                        u32 sw_if_index,
3072                                        ip4_address_t * address,
3073                                        u32 address_length,
3074                                        u32 if_address_index,
3075                                        u32 is_delete)
3076 {
3077   snat_main_t *sm = &snat_main;
3078   snat_static_map_resolve_t *rp;
3079   u32 *indices_to_delete = 0;
3080   int i, j;
3081   int rv;
3082
3083   for (i = 0; i < vec_len(sm->auto_add_sw_if_indices); i++)
3084     {
3085       if (sw_if_index == sm->auto_add_sw_if_indices[i])
3086         {
3087           if (!is_delete)
3088             {
3089               /* Don't trip over lease renewal, static config */
3090               for (j = 0; j < vec_len(sm->addresses); j++)
3091                 if (sm->addresses[j].addr.as_u32 == address->as_u32)
3092                   return;
3093
3094               snat_add_address (sm, address, ~0);
3095               /* Scan static map resolution vector */
3096               for (j = 0; j < vec_len (sm->to_resolve); j++)
3097                 {
3098                   rp = sm->to_resolve + j;
3099                   /* On this interface? */
3100                   if (rp->sw_if_index == sw_if_index)
3101                     {
3102                       /* Add the static mapping */
3103                       rv = snat_add_static_mapping (rp->l_addr,
3104                                                     address[0],
3105                                                     rp->l_port,
3106                                                     rp->e_port,
3107                                                     rp->vrf_id,
3108                                                     rp->addr_only,
3109                                                     ~0 /* sw_if_index */,
3110                                                     rp->proto,
3111                                                     rp->is_add);
3112                       if (rv)
3113                         clib_warning ("snat_add_static_mapping returned %d", 
3114                                       rv);
3115                       vec_add1 (indices_to_delete, j);
3116                     }
3117                 }
3118               /* If we resolved any of the outstanding static mappings */
3119               if (vec_len(indices_to_delete))
3120                 {
3121                   /* Delete them */
3122                   for (j = vec_len(indices_to_delete)-1; j >= 0; j--)
3123                     vec_delete(sm->to_resolve, 1, j);
3124                   vec_free(indices_to_delete);
3125                 }
3126               return;
3127             }
3128           else
3129             {
3130               (void) snat_del_address(sm, address[0], 1);
3131               return;
3132             }
3133         }
3134     }
3135 }
3136
3137
3138 static int snat_add_interface_address (snat_main_t *sm,
3139                                        u32 sw_if_index,
3140                                        int is_del)
3141 {
3142   ip4_main_t * ip4_main = sm->ip4_main;
3143   ip4_address_t * first_int_addr;
3144   snat_static_map_resolve_t *rp;
3145   u32 *indices_to_delete = 0;
3146   int i, j;
3147
3148   first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index,
3149                                                 0 /* just want the address*/);
3150
3151   for (i = 0; i < vec_len(sm->auto_add_sw_if_indices); i++)
3152     {
3153       if (sm->auto_add_sw_if_indices[i] == sw_if_index)
3154         {
3155           if (is_del)
3156             {
3157               /* if have address remove it */
3158               if (first_int_addr)
3159                   (void) snat_del_address (sm, first_int_addr[0], 1);
3160               else
3161                 {
3162                   for (j = 0; j < vec_len (sm->to_resolve); j++)
3163                     {
3164                       rp = sm->to_resolve + j;
3165                       if (rp->sw_if_index == sw_if_index)
3166                         vec_add1 (indices_to_delete, j);
3167                     }
3168                   if (vec_len(indices_to_delete))
3169                     {
3170                       for (j = vec_len(indices_to_delete)-1; j >= 0; j--)
3171                         vec_del1(sm->to_resolve, j);
3172                       vec_free(indices_to_delete);
3173                     }
3174                 }
3175               vec_del1(sm->auto_add_sw_if_indices, i);
3176             }
3177           else
3178             return VNET_API_ERROR_VALUE_EXIST;
3179
3180           return 0;
3181         }
3182     }
3183   
3184   if (is_del)
3185     return VNET_API_ERROR_NO_SUCH_ENTRY;
3186
3187   /* add to the auto-address list */
3188   vec_add1(sm->auto_add_sw_if_indices, sw_if_index);
3189
3190   /* If the address is already bound - or static - add it now */
3191   if (first_int_addr)
3192       snat_add_address (sm, first_int_addr, ~0);
3193
3194   return 0;
3195 }
3196
3197 static clib_error_t *
3198 snat_add_interface_address_command_fn (vlib_main_t * vm,
3199                                        unformat_input_t * input,
3200                                        vlib_cli_command_t * cmd)
3201 {
3202   snat_main_t *sm = &snat_main;
3203   unformat_input_t _line_input, *line_input = &_line_input;
3204   u32 sw_if_index;
3205   int rv;
3206   int is_del = 0;
3207   clib_error_t *error = 0;
3208
3209   /* Get a line of input. */
3210   if (!unformat_user (input, unformat_line_input, line_input))
3211     return 0;
3212
3213   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3214     {
3215       if (unformat (line_input, "%U", unformat_vnet_sw_interface,
3216                     sm->vnet_main, &sw_if_index))
3217         ;
3218       else if (unformat (line_input, "del"))
3219         is_del = 1;
3220       else
3221         {
3222           error = clib_error_return (0, "unknown input '%U'",
3223                                      format_unformat_error, line_input);
3224           goto done;
3225         }
3226     }
3227
3228   rv = snat_add_interface_address (sm, sw_if_index, is_del);
3229
3230   switch (rv)
3231     {
3232     case 0:
3233       break;
3234
3235     default:
3236       error = clib_error_return (0, "snat_add_interface_address returned %d",
3237                                  rv);
3238       goto done;
3239     }
3240
3241 done:
3242   unformat_free (line_input);
3243
3244   return error;
3245 }
3246
3247 VLIB_CLI_COMMAND (snat_add_interface_address_command, static) = {
3248     .path = "snat add interface address",
3249     .short_help = "snat add interface address <interface> [del]",
3250     .function = snat_add_interface_address_command_fn,
3251 };
3252
3253 static clib_error_t *
3254 snat_det_map_command_fn (vlib_main_t * vm,
3255                          unformat_input_t * input,
3256                          vlib_cli_command_t * cmd)
3257 {
3258   snat_main_t *sm = &snat_main;
3259   unformat_input_t _line_input, *line_input = &_line_input;
3260   ip4_address_t in_addr, out_addr;
3261   u32 in_plen, out_plen;
3262   int is_add = 1, rv;
3263   clib_error_t *error = 0;
3264
3265   /* Get a line of input. */
3266   if (!unformat_user (input, unformat_line_input, line_input))
3267     return 0;
3268
3269   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3270     {
3271       if (unformat (line_input, "in %U/%u", unformat_ip4_address, &in_addr, &in_plen))
3272         ;
3273       else if (unformat (line_input, "out %U/%u", unformat_ip4_address, &out_addr, &out_plen))
3274         ;
3275       else if (unformat (line_input, "del"))
3276         is_add = 0;
3277       else
3278         {
3279           error = clib_error_return (0, "unknown input '%U'",
3280                                      format_unformat_error, line_input);
3281           goto done;
3282         }
3283     }
3284
3285   unformat_free (line_input);
3286
3287   rv = snat_det_add_map(sm, &in_addr, (u8) in_plen, &out_addr, (u8)out_plen,
3288                         is_add);
3289
3290   if (rv)
3291     {
3292       error = clib_error_return (0, "snat_det_add_map return %d", rv);
3293       goto done;
3294     }
3295
3296 done:
3297   unformat_free (line_input);
3298
3299   return error;
3300 }
3301
3302 /*?
3303  * @cliexpar
3304  * @cliexstart{snat deterministic add}
3305  * Create bijective mapping of inside address to outside address and port range
3306  * pairs, with the purpose of enabling deterministic NAT to reduce logging in
3307  * CGN deployments.
3308  * To create deterministic mapping between inside network 10.0.0.0/18 and
3309  * outside network 1.1.1.0/30 use:
3310  * # vpp# snat deterministic add in 10.0.0.0/18 out 1.1.1.0/30
3311  * @cliexend
3312 ?*/
3313 VLIB_CLI_COMMAND (snat_det_map_command, static) = {
3314     .path = "snat deterministic add",
3315     .short_help = "snat deterministic add in <addr>/<plen> out <addr>/<plen> [del]",
3316     .function = snat_det_map_command_fn,
3317 };
3318
3319 static clib_error_t *
3320 snat_det_forward_command_fn (vlib_main_t * vm,
3321                              unformat_input_t * input,
3322                              vlib_cli_command_t * cmd)
3323 {
3324   snat_main_t *sm = &snat_main;
3325   unformat_input_t _line_input, *line_input = &_line_input;
3326   ip4_address_t in_addr, out_addr;
3327   u16 lo_port;
3328   snat_det_map_t * dm;
3329   clib_error_t *error = 0;
3330
3331   /* Get a line of input. */
3332   if (!unformat_user (input, unformat_line_input, line_input))
3333     return 0;
3334
3335   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3336     {
3337       if (unformat (line_input, "%U", unformat_ip4_address, &in_addr))
3338         ;
3339       else
3340         {
3341           error = clib_error_return (0, "unknown input '%U'",
3342                                      format_unformat_error, line_input);
3343           goto done;
3344         }
3345     }
3346
3347   unformat_free (line_input);
3348
3349   dm = snat_det_map_by_user(sm, &in_addr);
3350   if (!dm)
3351     vlib_cli_output (vm, "no match");
3352   else
3353     {
3354       snat_det_forward (dm, &in_addr, &out_addr, &lo_port);
3355       vlib_cli_output (vm, "%U:<%d-%d>", format_ip4_address, &out_addr,
3356                        lo_port, lo_port + dm->ports_per_host - 1);
3357     }
3358
3359 done:
3360   unformat_free (line_input);
3361
3362   return error;
3363 }
3364
3365 /*?
3366  * @cliexpar
3367  * @cliexstart{snat deterministic forward}
3368  * Return outside address and port range from inside address for deterministic
3369  * NAT.
3370  * To obtain outside address and port of inside host use:
3371  *  vpp# snat deterministic forward 10.0.0.2
3372  *  1.1.1.0:<1054-1068>
3373  * @cliexend
3374 ?*/
3375 VLIB_CLI_COMMAND (snat_det_forward_command, static) = {
3376     .path = "snat deterministic forward",
3377     .short_help = "snat deterministic forward <addr>",
3378     .function = snat_det_forward_command_fn,
3379 };
3380
3381 static clib_error_t *
3382 snat_det_reverse_command_fn (vlib_main_t * vm,
3383                              unformat_input_t * input,
3384                              vlib_cli_command_t * cmd)
3385 {
3386   snat_main_t *sm = &snat_main;
3387   unformat_input_t _line_input, *line_input = &_line_input;
3388   ip4_address_t in_addr, out_addr;
3389   u32 out_port;
3390   snat_det_map_t * dm;
3391   clib_error_t *error = 0;
3392
3393   /* Get a line of input. */
3394   if (!unformat_user (input, unformat_line_input, line_input))
3395     return 0;
3396
3397   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3398     {
3399       if (unformat (line_input, "%U:%d", unformat_ip4_address, &out_addr, &out_port))
3400         ;
3401       else
3402         {
3403           error =  clib_error_return (0, "unknown input '%U'",
3404                                       format_unformat_error, line_input);
3405         }
3406     }
3407
3408   unformat_free (line_input);
3409
3410   if (out_port < 1024 || out_port > 65535)
3411     {
3412       error = clib_error_return (0, "wrong port, must be <1024-65535>");
3413       goto done;
3414     }
3415
3416   dm = snat_det_map_by_out(sm, &out_addr);
3417   if (!dm)
3418     vlib_cli_output (vm, "no match");
3419   else
3420     {
3421       snat_det_reverse (dm, &out_addr, (u16) out_port, &in_addr);
3422       vlib_cli_output (vm, "%U", format_ip4_address, &in_addr);
3423     }
3424
3425 done:
3426   unformat_free (line_input);
3427
3428   return error;
3429 }
3430
3431 /*?
3432  * @cliexpar
3433  * @cliexstart{snat deterministic reverse}
3434  * Return inside address from outside address and port for deterministic NAT.
3435  * To obtain inside host address from outside address and port use:
3436  *  #vpp snat deterministic reverse 1.1.1.1:1276
3437  *  10.0.16.16
3438  * @cliexend
3439 ?*/
3440 VLIB_CLI_COMMAND (snat_det_reverse_command, static) = {
3441     .path = "snat deterministic reverse",
3442     .short_help = "snat deterministic reverse <addr>:<port>",
3443     .function = snat_det_reverse_command_fn,
3444 };