NAT44: don't add static mapping to resolution vector if failed (VPP-1225)
[vpp.git] / src / plugins / nat / nat.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 <nat/nat.h>
23 #include <nat/nat_dpo.h>
24 #include <nat/nat_ipfix_logging.h>
25 #include <nat/nat_det.h>
26 #include <nat/nat64.h>
27 #include <nat/nat66.h>
28 #include <nat/dslite.h>
29 #include <nat/nat_reass.h>
30 #include <vnet/fib/fib_table.h>
31 #include <vnet/fib/ip4_fib.h>
32
33 #include <vpp/app/version.h>
34
35 snat_main_t snat_main;
36
37
38 /* Hook up input features */
39 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
40   .arc_name = "ip4-unicast",
41   .node_name = "nat44-in2out",
42   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
43 };
44 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
45   .arc_name = "ip4-unicast",
46   .node_name = "nat44-out2in",
47   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
48 };
49 VNET_FEATURE_INIT (ip4_nat_classify, static) = {
50   .arc_name = "ip4-unicast",
51   .node_name = "nat44-classify",
52   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
53 };
54 VNET_FEATURE_INIT (ip4_snat_det_in2out, static) = {
55   .arc_name = "ip4-unicast",
56   .node_name = "nat44-det-in2out",
57   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
58 };
59 VNET_FEATURE_INIT (ip4_snat_det_out2in, static) = {
60   .arc_name = "ip4-unicast",
61   .node_name = "nat44-det-out2in",
62   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
63 };
64 VNET_FEATURE_INIT (ip4_nat_det_classify, static) = {
65   .arc_name = "ip4-unicast",
66   .node_name = "nat44-det-classify",
67   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
68 };
69 VNET_FEATURE_INIT (ip4_snat_in2out_worker_handoff, static) = {
70   .arc_name = "ip4-unicast",
71   .node_name = "nat44-in2out-worker-handoff",
72   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
73 };
74 VNET_FEATURE_INIT (ip4_snat_out2in_worker_handoff, static) = {
75   .arc_name = "ip4-unicast",
76   .node_name = "nat44-out2in-worker-handoff",
77   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
78 };
79 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
80   .arc_name = "ip4-unicast",
81   .node_name = "nat44-handoff-classify",
82   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
83 };
84 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
85   .arc_name = "ip4-unicast",
86   .node_name = "nat44-in2out-fast",
87   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
88 };
89 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
90   .arc_name = "ip4-unicast",
91   .node_name = "nat44-out2in-fast",
92   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
93 };
94 VNET_FEATURE_INIT (ip4_snat_hairpin_dst, static) = {
95   .arc_name = "ip4-unicast",
96   .node_name = "nat44-hairpin-dst",
97   .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
98 };
99
100 /* Hook up output features */
101 VNET_FEATURE_INIT (ip4_snat_in2out_output, static) = {
102   .arc_name = "ip4-output",
103   .node_name = "nat44-in2out-output",
104   .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
105 };
106 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
107   .arc_name = "ip4-output",
108   .node_name = "nat44-in2out-output-worker-handoff",
109   .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
110 };
111 VNET_FEATURE_INIT (ip4_snat_hairpin_src, static) = {
112   .arc_name = "ip4-output",
113   .node_name = "nat44-hairpin-src",
114   .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
115 };
116
117 /* Hook up ip4-local features */
118 VNET_FEATURE_INIT (ip4_nat_hairpinning, static) =
119 {
120   .arc_name = "ip4-local",
121   .node_name = "nat44-hairpinning",
122   .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
123 };
124
125
126 /* *INDENT-OFF* */
127 VLIB_PLUGIN_REGISTER () = {
128     .version = VPP_BUILD_VER,
129     .description = "Network Address Translation",
130 };
131 /* *INDENT-ON* */
132
133 vlib_node_registration_t nat44_classify_node;
134 vlib_node_registration_t nat44_det_classify_node;
135 vlib_node_registration_t nat44_handoff_classify_node;
136
137 typedef enum {
138   NAT44_CLASSIFY_NEXT_IN2OUT,
139   NAT44_CLASSIFY_NEXT_OUT2IN,
140   NAT44_CLASSIFY_N_NEXT,
141 } nat44_classify_next_t;
142
143 void
144 nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index)
145 {
146   snat_session_key_t key;
147   clib_bihash_kv_8_8_t kv;
148   nat_ed_ses_key_t ed_key;
149   clib_bihash_kv_16_8_t ed_kv;
150   int i;
151   snat_address_t *a;
152   snat_main_per_thread_data_t *tsm =
153     vec_elt_at_index (sm->per_thread_data, thread_index);
154
155   /* Endpoint dependent session lookup tables */
156   if (is_ed_session (s))
157     {
158       ed_key.l_addr = s->out2in.addr;
159       ed_key.r_addr = s->ext_host_addr;
160       ed_key.fib_index = s->out2in.fib_index;
161       if (snat_is_unk_proto_session (s))
162         {
163           ed_key.proto = s->in2out.port;
164           ed_key.r_port = 0;
165           ed_key.l_port = 0;
166         }
167       else
168         {
169           ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
170           ed_key.l_port = s->out2in.port;
171           ed_key.r_port = s->ext_host_port;
172         }
173       ed_kv.key[0] = ed_key.as_u64[0];
174       ed_kv.key[1] = ed_key.as_u64[1];
175       if (clib_bihash_add_del_16_8 (&sm->out2in_ed, &ed_kv, 0))
176         clib_warning ("out2in_ed key del failed");
177
178       ed_key.l_addr = s->in2out.addr;
179       ed_key.fib_index = s->in2out.fib_index;
180       if (!snat_is_unk_proto_session (s))
181         ed_key.l_port = s->in2out.port;
182       if (is_twice_nat_session (s))
183         {
184           ed_key.r_addr = s->ext_host_nat_addr;
185           ed_key.r_port = s->ext_host_nat_port;
186         }
187       ed_kv.key[0] = ed_key.as_u64[0];
188       ed_kv.key[1] = ed_key.as_u64[1];
189       if (clib_bihash_add_del_16_8 (&sm->in2out_ed, &ed_kv, 0))
190         clib_warning ("in2out_ed key del failed");
191     }
192
193   if (snat_is_unk_proto_session (s))
194     return;
195
196   /* log NAT event */
197   snat_ipfix_logging_nat44_ses_delete(s->in2out.addr.as_u32,
198                                       s->out2in.addr.as_u32,
199                                       s->in2out.protocol,
200                                       s->in2out.port,
201                                       s->out2in.port,
202                                       s->in2out.fib_index);
203
204   /* Twice NAT address and port for external host */
205   if (is_twice_nat_session (s))
206     {
207       for (i = 0; i < vec_len (sm->twice_nat_addresses); i++)
208         {
209           key.protocol = s->in2out.protocol;
210           key.port = s->ext_host_nat_port;
211           a = sm->twice_nat_addresses + i;
212           if (a->addr.as_u32 == s->ext_host_nat_addr.as_u32)
213             {
214               snat_free_outside_address_and_port (sm->twice_nat_addresses,
215                                                   thread_index, &key, i);
216               break;
217             }
218         }
219     }
220
221   if (is_ed_session (s))
222     return;
223
224   /* Session lookup tables */
225   kv.key = s->in2out.as_u64;
226   if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0))
227     clib_warning ("in2out key del failed");
228   kv.key = s->out2in.as_u64;
229   if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0))
230     clib_warning ("out2in key del failed");
231
232   if (snat_is_session_static (s))
233     return;
234
235   if (s->outside_address_index != ~0)
236     snat_free_outside_address_and_port (sm->addresses, thread_index,
237                                         &s->out2in, s->outside_address_index);
238 }
239
240 snat_user_t *
241 nat_user_get_or_create (snat_main_t *sm, ip4_address_t *addr, u32 fib_index,
242                         u32 thread_index)
243 {
244   snat_user_t *u = 0;
245   snat_user_key_t user_key;
246   clib_bihash_kv_8_8_t kv, value;
247   snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
248   dlist_elt_t * per_user_list_head_elt;
249
250   user_key.addr.as_u32 = addr->as_u32;
251   user_key.fib_index = fib_index;
252   kv.key = user_key.as_u64;
253
254   /* Ever heard of the "user" = src ip4 address before? */
255   if (clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
256     {
257       /* no, make a new one */
258       pool_get (tsm->users, u);
259       memset (u, 0, sizeof (*u));
260       u->addr.as_u32 = addr->as_u32;
261       u->fib_index = fib_index;
262
263       pool_get (tsm->list_pool, per_user_list_head_elt);
264
265       u->sessions_per_user_list_head_index = per_user_list_head_elt -
266         tsm->list_pool;
267
268       clib_dlist_init (tsm->list_pool, u->sessions_per_user_list_head_index);
269
270       kv.value = u - tsm->users;
271
272       /* add user */
273       if (clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 1))
274         clib_warning ("user_hash keay add failed");
275     }
276   else
277     {
278       u = pool_elt_at_index (tsm->users, value.value);
279     }
280
281   return u;
282 }
283
284 snat_session_t *
285 nat_session_alloc_or_recycle (snat_main_t *sm, snat_user_t *u, u32 thread_index)
286 {
287   snat_session_t *s;
288   snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
289   u32 oldest_per_user_translation_list_index, session_index;
290   dlist_elt_t * oldest_per_user_translation_list_elt;
291   dlist_elt_t * per_user_translation_list_elt;
292
293   /* Over quota? Recycle the least recently used translation */
294   if ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user)
295     {
296       oldest_per_user_translation_list_index =
297         clib_dlist_remove_head (tsm->list_pool,
298                                 u->sessions_per_user_list_head_index);
299
300       ASSERT (oldest_per_user_translation_list_index != ~0);
301
302       /* Add it back to the end of the LRU list */
303       clib_dlist_addtail (tsm->list_pool,
304                           u->sessions_per_user_list_head_index,
305                           oldest_per_user_translation_list_index);
306       /* Get the list element */
307       oldest_per_user_translation_list_elt =
308         pool_elt_at_index (tsm->list_pool,
309                            oldest_per_user_translation_list_index);
310
311       /* Get the session index from the list element */
312       session_index = oldest_per_user_translation_list_elt->value;
313
314       /* Get the session */
315       s = pool_elt_at_index (tsm->sessions, session_index);
316       nat_free_session_data (sm, s, thread_index);
317       s->outside_address_index = ~0;
318       s->flags = 0;
319       s->total_bytes = 0;
320       s->total_pkts = 0;
321     }
322   else
323     {
324       pool_get (tsm->sessions, s);
325       memset (s, 0, sizeof (*s));
326       s->outside_address_index = ~0;
327
328       /* Create list elts */
329       pool_get (tsm->list_pool, per_user_translation_list_elt);
330       clib_dlist_init (tsm->list_pool,
331                        per_user_translation_list_elt - tsm->list_pool);
332
333       per_user_translation_list_elt->value = s - tsm->sessions;
334       s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
335       s->per_user_list_head_index = u->sessions_per_user_list_head_index;
336
337       clib_dlist_addtail (tsm->list_pool,
338                           s->per_user_list_head_index,
339                           per_user_translation_list_elt - tsm->list_pool);
340     }
341
342   return s;
343 }
344
345 static inline uword
346 nat44_classify_node_fn_inline (vlib_main_t * vm,
347                                vlib_node_runtime_t * node,
348                                vlib_frame_t * frame)
349 {
350   u32 n_left_from, * from, * to_next;
351   nat44_classify_next_t next_index;
352   snat_main_t *sm = &snat_main;
353
354   from = vlib_frame_vector_args (frame);
355   n_left_from = frame->n_vectors;
356   next_index = node->cached_next_index;
357
358   while (n_left_from > 0)
359     {
360       u32 n_left_to_next;
361
362       vlib_get_next_frame (vm, node, next_index,
363                            to_next, n_left_to_next);
364
365       while (n_left_from > 0 && n_left_to_next > 0)
366         {
367           u32 bi0;
368           vlib_buffer_t *b0;
369           u32 next0 = NAT44_CLASSIFY_NEXT_IN2OUT;
370           ip4_header_t *ip0;
371           snat_address_t *ap;
372           snat_session_key_t m_key0;
373           clib_bihash_kv_8_8_t kv0, value0;
374
375           /* speculatively enqueue b0 to the current next frame */
376           bi0 = from[0];
377           to_next[0] = bi0;
378           from += 1;
379           to_next += 1;
380           n_left_from -= 1;
381           n_left_to_next -= 1;
382
383           b0 = vlib_get_buffer (vm, bi0);
384           ip0 = vlib_buffer_get_current (b0);
385
386           vec_foreach (ap, sm->addresses)
387             {
388               if (ip0->dst_address.as_u32 == ap->addr.as_u32)
389                 {
390                   next0 = NAT44_CLASSIFY_NEXT_OUT2IN;
391                   goto enqueue0;
392                 }
393             }
394
395           if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
396             {
397               m_key0.addr = ip0->dst_address;
398               m_key0.port = 0;
399               m_key0.protocol = 0;
400               m_key0.fib_index = sm->outside_fib_index;
401               kv0.key = m_key0.as_u64;
402               if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv0, &value0))
403                 {
404                   next0 = NAT44_CLASSIFY_NEXT_OUT2IN;
405                   goto enqueue0;
406                 }
407               udp_header_t * udp0 = ip4_next_header (ip0);
408               m_key0.port = clib_net_to_host_u16 (udp0->dst_port);
409               m_key0.protocol = ip_proto_to_snat_proto (ip0->protocol);
410               kv0.key = m_key0.as_u64;
411               if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv0, &value0))
412                 next0 = NAT44_CLASSIFY_NEXT_OUT2IN;
413             }
414
415         enqueue0:
416           /* verify speculative enqueue, maybe switch current next frame */
417           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
418                                            to_next, n_left_to_next,
419                                            bi0, next0);
420         }
421
422       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
423     }
424
425   return frame->n_vectors;
426 }
427
428 static uword
429 nat44_classify_node_fn (vlib_main_t * vm,
430                         vlib_node_runtime_t * node,
431                         vlib_frame_t * frame)
432 {
433   return nat44_classify_node_fn_inline (vm, node, frame);
434 };
435
436 VLIB_REGISTER_NODE (nat44_classify_node) = {
437   .function = nat44_classify_node_fn,
438   .name = "nat44-classify",
439   .vector_size = sizeof (u32),
440   .type = VLIB_NODE_TYPE_INTERNAL,
441   .n_next_nodes = NAT44_CLASSIFY_N_NEXT,
442   .next_nodes = {
443     [NAT44_CLASSIFY_NEXT_IN2OUT] = "nat44-in2out",
444     [NAT44_CLASSIFY_NEXT_OUT2IN] = "nat44-out2in",
445   },
446 };
447
448 VLIB_NODE_FUNCTION_MULTIARCH (nat44_classify_node,
449                               nat44_classify_node_fn);
450
451 static uword
452 nat44_det_classify_node_fn (vlib_main_t * vm,
453                             vlib_node_runtime_t * node,
454                             vlib_frame_t * frame)
455 {
456   return nat44_classify_node_fn_inline (vm, node, frame);
457 };
458
459 VLIB_REGISTER_NODE (nat44_det_classify_node) = {
460   .function = nat44_det_classify_node_fn,
461   .name = "nat44-det-classify",
462   .vector_size = sizeof (u32),
463   .type = VLIB_NODE_TYPE_INTERNAL,
464   .n_next_nodes = NAT44_CLASSIFY_N_NEXT,
465   .next_nodes = {
466     [NAT44_CLASSIFY_NEXT_IN2OUT] = "nat44-det-in2out",
467     [NAT44_CLASSIFY_NEXT_OUT2IN] = "nat44-det-out2in",
468   },
469 };
470
471 VLIB_NODE_FUNCTION_MULTIARCH (nat44_det_classify_node,
472                               nat44_det_classify_node_fn);
473
474 static uword
475 nat44_handoff_classify_node_fn (vlib_main_t * vm,
476                                 vlib_node_runtime_t * node,
477                                 vlib_frame_t * frame)
478 {
479   return nat44_classify_node_fn_inline (vm, node, frame);
480 };
481
482 VLIB_REGISTER_NODE (nat44_handoff_classify_node) = {
483   .function = nat44_handoff_classify_node_fn,
484   .name = "nat44-handoff-classify",
485   .vector_size = sizeof (u32),
486   .type = VLIB_NODE_TYPE_INTERNAL,
487   .n_next_nodes = NAT44_CLASSIFY_N_NEXT,
488   .next_nodes = {
489     [NAT44_CLASSIFY_NEXT_IN2OUT] = "nat44-in2out-worker-handoff",
490     [NAT44_CLASSIFY_NEXT_OUT2IN] = "nat44-out2in-worker-handoff",
491   },
492 };
493
494 VLIB_NODE_FUNCTION_MULTIARCH (nat44_handoff_classify_node,
495                               nat44_handoff_classify_node_fn);
496
497 /**
498  * @brief Add/del NAT address to FIB.
499  *
500  * Add the external NAT address to the FIB as receive entries. This ensures
501  * that VPP will reply to ARP for this address and we don't need to enable
502  * proxy ARP on the outside interface.
503  *
504  * @param addr IPv4 address.
505  * @param plen address prefix length
506  * @param sw_if_index Interface.
507  * @param is_add If 0 delete, otherwise add.
508  */
509 void
510 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
511                           int is_add)
512 {
513   fib_prefix_t prefix = {
514     .fp_len = p_len,
515     .fp_proto = FIB_PROTOCOL_IP4,
516     .fp_addr = {
517         .ip4.as_u32 = addr->as_u32,
518     },
519   };
520   u32 fib_index = ip4_fib_table_get_index_for_sw_if_index(sw_if_index);
521
522   if (is_add)
523     fib_table_entry_update_one_path(fib_index,
524                                     &prefix,
525                                     FIB_SOURCE_PLUGIN_LOW,
526                                     (FIB_ENTRY_FLAG_CONNECTED |
527                                      FIB_ENTRY_FLAG_LOCAL |
528                                      FIB_ENTRY_FLAG_EXCLUSIVE),
529                                     DPO_PROTO_IP4,
530                                     NULL,
531                                     sw_if_index,
532                                     ~0,
533                                     1,
534                                     NULL,
535                                     FIB_ROUTE_PATH_FLAG_NONE);
536   else
537     fib_table_entry_delete(fib_index,
538                            &prefix,
539                            FIB_SOURCE_PLUGIN_LOW);
540 }
541
542 void snat_add_address (snat_main_t *sm, ip4_address_t *addr, u32 vrf_id,
543                        u8 twice_nat)
544 {
545   snat_address_t * ap;
546   snat_interface_t *i;
547   vlib_thread_main_t *tm = vlib_get_thread_main ();
548
549   /* Check if address already exists */
550   vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
551     {
552       if (ap->addr.as_u32 == addr->as_u32)
553         return;
554     }
555
556   if (twice_nat)
557     vec_add2 (sm->twice_nat_addresses, ap, 1);
558   else
559     vec_add2 (sm->addresses, ap, 1);
560
561   ap->addr = *addr;
562   if (vrf_id != ~0)
563     ap->fib_index =
564       fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
565                                          FIB_SOURCE_PLUGIN_LOW);
566   else
567     ap->fib_index = ~0;
568 #define _(N, i, n, s) \
569   clib_bitmap_alloc (ap->busy_##n##_port_bitmap, 65535); \
570   ap->busy_##n##_ports = 0; \
571   vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
572   foreach_snat_protocol
573 #undef _
574
575   if (twice_nat)
576     return;
577
578   /* Add external address to FIB */
579   pool_foreach (i, sm->interfaces,
580   ({
581     if (nat_interface_is_inside(i) || sm->out2in_dpo)
582       continue;
583
584     snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
585     break;
586   }));
587   pool_foreach (i, sm->output_feature_interfaces,
588   ({
589     if (nat_interface_is_inside(i) || sm->out2in_dpo)
590       continue;
591
592     snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
593     break;
594   }));
595 }
596
597 static int is_snat_address_used_in_static_mapping (snat_main_t *sm,
598                                                    ip4_address_t addr)
599 {
600   snat_static_mapping_t *m;
601   pool_foreach (m, sm->static_mappings,
602   ({
603       if (m->external_addr.as_u32 == addr.as_u32)
604         return 1;
605   }));
606
607   return 0;
608 }
609
610 void increment_v4_address (ip4_address_t * a)
611 {
612   u32 v;
613
614   v = clib_net_to_host_u32(a->as_u32) + 1;
615   a->as_u32 = clib_host_to_net_u32(v);
616 }
617
618 static void
619 snat_add_static_mapping_when_resolved (snat_main_t * sm,
620                                        ip4_address_t l_addr,
621                                        u16 l_port,
622                                        u32 sw_if_index,
623                                        u16 e_port,
624                                        u32 vrf_id,
625                                        snat_protocol_t proto,
626                                        int addr_only,
627                                        int is_add,
628                                        u8 * tag)
629 {
630   snat_static_map_resolve_t *rp;
631
632   vec_add2 (sm->to_resolve, rp, 1);
633   rp->l_addr.as_u32 = l_addr.as_u32;
634   rp->l_port = l_port;
635   rp->sw_if_index = sw_if_index;
636   rp->e_port = e_port;
637   rp->vrf_id = vrf_id;
638   rp->proto = proto;
639   rp->addr_only = addr_only;
640   rp->is_add = is_add;
641   rp->tag = vec_dup (tag);
642 }
643
644 /**
645  * @brief Add static mapping.
646  *
647  * Create static mapping between local addr+port and external addr+port.
648  *
649  * @param l_addr Local IPv4 address.
650  * @param e_addr External IPv4 address.
651  * @param l_port Local port number.
652  * @param e_port External port number.
653  * @param vrf_id VRF ID.
654  * @param addr_only If 0 address port and pair mapping, otherwise address only.
655  * @param sw_if_index External port instead of specific IP address.
656  * @param is_add If 0 delete static mapping, otherwise add.
657  * @param twice_nat If 1 translate external host address and port.
658  * @param out2in_only If 1 rule match only out2in direction
659  * @param tag - opaque string tag
660  *
661  * @returns
662  */
663 int snat_add_static_mapping(ip4_address_t l_addr, ip4_address_t e_addr,
664                             u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
665                             u32 sw_if_index, snat_protocol_t proto, int is_add,
666                             u8 twice_nat, u8 out2in_only, u8 * tag)
667 {
668   snat_main_t * sm = &snat_main;
669   snat_static_mapping_t *m;
670   snat_session_key_t m_key;
671   clib_bihash_kv_8_8_t kv, value;
672   snat_address_t *a = 0;
673   u32 fib_index = ~0;
674   uword * p;
675   snat_interface_t *interface;
676   int i;
677   snat_main_per_thread_data_t *tsm;
678   snat_user_key_t u_key;
679   snat_user_t *u;
680   dlist_elt_t * head, * elt;
681   u32 elt_index, head_index;
682   u32 ses_index;
683   u64 user_index;
684   snat_session_t * s;
685   snat_static_map_resolve_t *rp, *rp_match = 0;
686
687   /* If the external address is a specific interface address */
688   if (sw_if_index != ~0)
689     {
690       ip4_address_t * first_int_addr;
691
692       for (i = 0; i < vec_len (sm->to_resolve); i++)
693         {
694           rp = sm->to_resolve + i;
695           if (rp->sw_if_index != sw_if_index &&
696               rp->l_addr.as_u32 != l_addr.as_u32 &&
697               rp->vrf_id != vrf_id && rp->addr_only != addr_only)
698             continue;
699
700           if (!addr_only)
701             {
702               if (rp->l_port != l_port && rp->e_port != e_port && rp->proto != proto)
703                 continue;
704             }
705
706           rp_match = rp;
707           break;
708         }
709
710       /* Might be already set... */
711       first_int_addr = ip4_interface_first_address
712         (sm->ip4_main, sw_if_index, 0 /* just want the address*/);
713
714       if (is_add)
715         {
716           if (rp_match)
717             return VNET_API_ERROR_VALUE_EXIST;
718
719           snat_add_static_mapping_when_resolved
720             (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
721              addr_only,  is_add, tag);
722
723           /* DHCP resolution required? */
724           if (first_int_addr == 0)
725             {
726               return 0;
727             }
728           else
729             {
730               e_addr.as_u32 = first_int_addr->as_u32;
731               /* Identity mapping? */
732               if (l_addr.as_u32 == 0)
733                 l_addr.as_u32 = e_addr.as_u32;
734             }
735         }
736       else
737         {
738           if (!rp_match)
739             return VNET_API_ERROR_NO_SUCH_ENTRY;
740
741           vec_del1 (sm->to_resolve, i);
742
743           if (first_int_addr)
744             {
745               e_addr.as_u32 = first_int_addr->as_u32;
746               /* Identity mapping? */
747               if (l_addr.as_u32 == 0)
748                 l_addr.as_u32 = e_addr.as_u32;
749             }
750           else
751             return 0;
752         }
753     }
754
755   m_key.addr = e_addr;
756   m_key.port = addr_only ? 0 : e_port;
757   m_key.protocol = addr_only ? 0 : proto;
758   m_key.fib_index = sm->outside_fib_index;
759   kv.key = m_key.as_u64;
760   if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
761     m = 0;
762   else
763     m = pool_elt_at_index (sm->static_mappings, value.value);
764
765   if (is_add)
766     {
767       if (m)
768         return VNET_API_ERROR_VALUE_EXIST;
769
770       if (twice_nat && addr_only)
771         return VNET_API_ERROR_UNSUPPORTED;
772
773       /* Convert VRF id to FIB index */
774       if (vrf_id != ~0)
775         {
776           p = hash_get (sm->ip4_main->fib_index_by_table_id, vrf_id);
777           if (!p)
778             return VNET_API_ERROR_NO_SUCH_FIB;
779           fib_index = p[0];
780         }
781       /* If not specified use inside VRF id from SNAT plugin startup config */
782       else
783         {
784           fib_index = sm->inside_fib_index;
785           vrf_id = sm->inside_vrf_id;
786         }
787
788       if (!out2in_only)
789         {
790           m_key.addr = l_addr;
791           m_key.port = addr_only ? 0 : l_port;
792           m_key.protocol = addr_only ? 0 : proto;
793           m_key.fib_index = fib_index;
794           kv.key = m_key.as_u64;
795           if (!clib_bihash_search_8_8 (&sm->static_mapping_by_local, &kv, &value))
796             return VNET_API_ERROR_VALUE_EXIST;
797         }
798
799       /* Find external address in allocated addresses and reserve port for
800          address and port pair mapping when dynamic translations enabled */
801       if (!(addr_only || sm->static_mapping_only || out2in_only))
802         {
803           for (i = 0; i < vec_len (sm->addresses); i++)
804             {
805               if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
806                 {
807                   a = sm->addresses + i;
808                   /* External port must be unused */
809                   switch (proto)
810                     {
811 #define _(N, j, n, s) \
812                     case SNAT_PROTOCOL_##N: \
813                       if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
814                         return VNET_API_ERROR_INVALID_VALUE; \
815                       clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
816                       if (e_port > 1024) \
817                         { \
818                           a->busy_##n##_ports++; \
819                           a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]++; \
820                         } \
821                       break;
822                       foreach_snat_protocol
823 #undef _
824                     default:
825                       clib_warning("unknown_protocol");
826                       return VNET_API_ERROR_INVALID_VALUE_2;
827                     }
828                   break;
829                 }
830             }
831           /* External address must be allocated */
832           if (!a && (l_addr.as_u32 != e_addr.as_u32))
833             {
834               if (sw_if_index != ~0)
835                 {
836                   for (i = 0; i < vec_len (sm->to_resolve); i++)
837                     {
838                       rp = sm->to_resolve + i;
839                       if (rp->addr_only)
840                          continue;
841                       if (rp->sw_if_index != sw_if_index &&
842                           rp->l_addr.as_u32 != l_addr.as_u32 &&
843                           rp->vrf_id != vrf_id && rp->l_port != l_port &&
844                           rp->e_port != e_port && rp->proto != proto)
845                         continue;
846
847                       vec_del1 (sm->to_resolve, i);
848                       break;
849                     }
850                 }
851               return VNET_API_ERROR_NO_SUCH_ENTRY;
852             }
853         }
854
855       pool_get (sm->static_mappings, m);
856       memset (m, 0, sizeof (*m));
857       m->tag = vec_dup (tag);
858       m->local_addr = l_addr;
859       m->external_addr = e_addr;
860       m->addr_only = addr_only;
861       m->vrf_id = vrf_id;
862       m->fib_index = fib_index;
863       m->twice_nat = twice_nat;
864       m->out2in_only = out2in_only;
865       if (!addr_only)
866         {
867           m->local_port = l_port;
868           m->external_port = e_port;
869           m->proto = proto;
870         }
871
872       if (sm->workers)
873         {
874           ip4_header_t ip = {
875             .src_address = m->local_addr,
876           };
877           m->worker_index = sm->worker_in2out_cb (&ip, m->fib_index);
878           tsm = vec_elt_at_index (sm->per_thread_data, m->worker_index);
879         }
880       else
881         tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
882
883       m_key.addr = m->local_addr;
884       m_key.port = m->local_port;
885       m_key.protocol = m->proto;
886       m_key.fib_index = m->fib_index;
887       kv.key = m_key.as_u64;
888       kv.value = m - sm->static_mappings;
889       if (!out2in_only)
890         clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 1);
891       if (twice_nat || out2in_only)
892         {
893           m_key.port = clib_host_to_net_u16 (l_port);
894           kv.key = m_key.as_u64;
895           kv.value = ~0ULL;
896           if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 1))
897             clib_warning ("in2out key add failed");
898         }
899
900       m_key.addr = m->external_addr;
901       m_key.port = m->external_port;
902       m_key.fib_index = sm->outside_fib_index;
903       kv.key = m_key.as_u64;
904       kv.value = m - sm->static_mappings;
905       clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 1);
906       if (twice_nat || out2in_only)
907         {
908           m_key.port = clib_host_to_net_u16 (e_port);
909           kv.key = m_key.as_u64;
910           kv.value = ~0ULL;
911           if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 1))
912             clib_warning ("out2in key add failed");
913         }
914
915       /* Delete dynamic sessions matching local address (+ local port) */
916       if (!(sm->static_mapping_only))
917         {
918           u_key.addr = m->local_addr;
919           u_key.fib_index = m->fib_index;
920           kv.key = u_key.as_u64;
921           if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
922             {
923               user_index = value.value;
924               u = pool_elt_at_index (tsm->users, user_index);
925               if (u->nsessions)
926                 {
927                   head_index = u->sessions_per_user_list_head_index;
928                   head = pool_elt_at_index (tsm->list_pool, head_index);
929                   elt_index = head->next;
930                   elt = pool_elt_at_index (tsm->list_pool, elt_index);
931                   ses_index = elt->value;
932                   while (ses_index != ~0)
933                     {
934                       s =  pool_elt_at_index (tsm->sessions, ses_index);
935                       elt = pool_elt_at_index (tsm->list_pool, elt->next);
936                       ses_index = elt->value;
937
938                       if (snat_is_session_static (s))
939                         continue;
940
941                       if (!addr_only)
942                         {
943                           if ((s->out2in.addr.as_u32 != e_addr.as_u32) &&
944                               (clib_net_to_host_u16 (s->out2in.port) != e_port))
945                             continue;
946                         }
947
948                       nat_free_session_data (sm, s, tsm - sm->per_thread_data);
949                       clib_dlist_remove (tsm->list_pool, s->per_user_index);
950                       pool_put_index (tsm->list_pool, s->per_user_index);
951                       pool_put (tsm->sessions, s);
952                       u->nsessions--;
953
954                       if (!addr_only)
955                         break;
956                     }
957                 }
958             }
959         }
960     }
961   else
962     {
963       if (!m)
964         {
965           if (sw_if_index != ~0)
966             return 0;
967           else
968             return VNET_API_ERROR_NO_SUCH_ENTRY;
969         }
970
971       /* Free external address port */
972       if (!(addr_only || sm->static_mapping_only || out2in_only))
973         {
974           for (i = 0; i < vec_len (sm->addresses); i++)
975             {
976               if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
977                 {
978                   a = sm->addresses + i;
979                   switch (proto)
980                     {
981 #define _(N, j, n, s) \
982                     case SNAT_PROTOCOL_##N: \
983                       clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
984                       if (e_port > 1024) \
985                         { \
986                           a->busy_##n##_ports--; \
987                           a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]--; \
988                         } \
989                       break;
990                       foreach_snat_protocol
991 #undef _
992                     default:
993                       clib_warning("unknown_protocol");
994                       return VNET_API_ERROR_INVALID_VALUE_2;
995                     }
996                   break;
997                 }
998             }
999         }
1000
1001       if (sm->num_workers > 1)
1002         tsm = vec_elt_at_index (sm->per_thread_data, m->worker_index);
1003       else
1004         tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1005
1006       m_key.addr = m->local_addr;
1007       m_key.port = m->local_port;
1008       m_key.protocol = m->proto;
1009       m_key.fib_index = m->fib_index;
1010       kv.key = m_key.as_u64;
1011       if (!out2in_only)
1012         clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0);
1013       if (twice_nat || out2in_only)
1014         {
1015           m_key.port = clib_host_to_net_u16 (m->local_port);
1016           kv.key = m_key.as_u64;
1017           kv.value = ~0ULL;
1018           if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 0))
1019             clib_warning ("in2out key del failed");
1020         }
1021
1022       m_key.addr = m->external_addr;
1023       m_key.port = m->external_port;
1024       m_key.fib_index = sm->outside_fib_index;
1025       kv.key = m_key.as_u64;
1026       clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 0);
1027       if (twice_nat || out2in_only)
1028         {
1029           m_key.port = clib_host_to_net_u16 (m->external_port);
1030           kv.key = m_key.as_u64;
1031           kv.value = ~0ULL;
1032           if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 0))
1033             clib_warning ("in2out key del failed");
1034         }
1035
1036       /* Delete session(s) for static mapping if exist */
1037       if (!(sm->static_mapping_only) ||
1038           (sm->static_mapping_only && sm->static_mapping_connection_tracking))
1039         {
1040           u_key.addr = m->local_addr;
1041           u_key.fib_index = m->fib_index;
1042           kv.key = u_key.as_u64;
1043           if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1044             {
1045               user_index = value.value;
1046               u = pool_elt_at_index (tsm->users, user_index);
1047               if (u->nstaticsessions)
1048                 {
1049                   head_index = u->sessions_per_user_list_head_index;
1050                   head = pool_elt_at_index (tsm->list_pool, head_index);
1051                   elt_index = head->next;
1052                   elt = pool_elt_at_index (tsm->list_pool, elt_index);
1053                   ses_index = elt->value;
1054                   while (ses_index != ~0)
1055                     {
1056                       s =  pool_elt_at_index (tsm->sessions, ses_index);
1057                       elt = pool_elt_at_index (tsm->list_pool, elt->next);
1058                       ses_index = elt->value;
1059
1060                       if (!addr_only)
1061                         {
1062                           if ((s->out2in.addr.as_u32 != e_addr.as_u32) &&
1063                               (clib_net_to_host_u16 (s->out2in.port) != e_port))
1064                             continue;
1065                         }
1066
1067                       nat_free_session_data (sm, s, tsm - sm->per_thread_data);
1068                       clib_dlist_remove (tsm->list_pool, s->per_user_index);
1069                       pool_put_index (tsm->list_pool, s->per_user_index);
1070                       pool_put (tsm->sessions, s);
1071                       u->nstaticsessions--;
1072
1073                       if (!addr_only)
1074                         break;
1075                     }
1076                   if (addr_only)
1077                     {
1078                       pool_put (tsm->users, u);
1079                       clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 0);
1080                     }
1081                 }
1082             }
1083         }
1084
1085       vec_free (m->tag);
1086       /* Delete static mapping from pool */
1087       pool_put (sm->static_mappings, m);
1088     }
1089
1090   if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
1091     return 0;
1092
1093   /* Add/delete external address to FIB */
1094   pool_foreach (interface, sm->interfaces,
1095   ({
1096     if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1097       continue;
1098
1099     snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1100     break;
1101   }));
1102   pool_foreach (interface, sm->output_feature_interfaces,
1103   ({
1104     if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1105       continue;
1106
1107     snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1108     break;
1109   }));
1110
1111   return 0;
1112 }
1113
1114 static int lb_local_exists (nat44_lb_addr_port_t * local,
1115                             ip4_address_t * e_addr, u16 e_port)
1116 {
1117   snat_main_t *sm = &snat_main;
1118   snat_static_mapping_t *m;
1119   nat44_lb_addr_port_t *ap;
1120
1121   /* *INDENT-OFF* */
1122   pool_foreach (m, sm->static_mappings,
1123   ({
1124       if (vec_len(m->locals))
1125         {
1126           if (m->external_port == e_port && m->external_addr.as_u32 == e_addr->as_u32)
1127             continue;
1128
1129           vec_foreach (ap, m->locals)
1130           {
1131             if (ap->port == local->port && ap->addr.as_u32 == local->addr.as_u32)
1132               return 1;
1133           }
1134         }
1135   }));
1136   /* *INDENT-ON* */
1137
1138   return 0;
1139 }
1140
1141 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1142                                      snat_protocol_t proto, u32 vrf_id,
1143                                      nat44_lb_addr_port_t *locals, u8 is_add,
1144                                      u8 twice_nat, u8 out2in_only, u8 *tag)
1145 {
1146   snat_main_t * sm = &snat_main;
1147   snat_static_mapping_t *m;
1148   snat_session_key_t m_key;
1149   clib_bihash_kv_8_8_t kv, value;
1150   u32 fib_index;
1151   snat_address_t *a = 0;
1152   int i;
1153   nat44_lb_addr_port_t *local;
1154   u32 worker_index = 0, elt_index, head_index, ses_index;
1155   snat_main_per_thread_data_t *tsm;
1156   snat_user_key_t u_key;
1157   snat_user_t *u;
1158   snat_session_t * s;
1159   dlist_elt_t * head, * elt;
1160
1161   m_key.addr = e_addr;
1162   m_key.port = e_port;
1163   m_key.protocol = proto;
1164   m_key.fib_index = sm->outside_fib_index;
1165   kv.key = m_key.as_u64;
1166   if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1167     m = 0;
1168   else
1169     m = pool_elt_at_index (sm->static_mappings, value.value);
1170
1171   if (is_add)
1172     {
1173       if (m)
1174         return VNET_API_ERROR_VALUE_EXIST;
1175
1176       if (vec_len (locals) < 2)
1177         return VNET_API_ERROR_INVALID_VALUE;
1178
1179       fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
1180                                                      vrf_id,
1181                                                      FIB_SOURCE_PLUGIN_LOW);
1182
1183       /* Find external address in allocated addresses and reserve port for
1184          address and port pair mapping when dynamic translations enabled */
1185       if (!(sm->static_mapping_only || out2in_only))
1186         {
1187           for (i = 0; i < vec_len (sm->addresses); i++)
1188             {
1189               if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1190                 {
1191                   a = sm->addresses + i;
1192                   /* External port must be unused */
1193                   switch (proto)
1194                     {
1195 #define _(N, j, n, s) \
1196                     case SNAT_PROTOCOL_##N: \
1197                       if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
1198                         return VNET_API_ERROR_INVALID_VALUE; \
1199                       clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
1200                       if (e_port > 1024) \
1201                         { \
1202                           a->busy_##n##_ports++; \
1203                           a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]++; \
1204                         } \
1205                       break;
1206                       foreach_snat_protocol
1207 #undef _
1208                     default:
1209                       clib_warning("unknown_protocol");
1210                       return VNET_API_ERROR_INVALID_VALUE_2;
1211                     }
1212                   break;
1213                 }
1214             }
1215           /* External address must be allocated */
1216           if (!a)
1217             return VNET_API_ERROR_NO_SUCH_ENTRY;
1218         }
1219
1220       pool_get (sm->static_mappings, m);
1221       memset (m, 0, sizeof (*m));
1222       m->tag = vec_dup (tag);
1223       m->external_addr = e_addr;
1224       m->addr_only = 0;
1225       m->vrf_id = vrf_id;
1226       m->fib_index = fib_index;
1227       m->external_port = e_port;
1228       m->proto = proto;
1229       m->twice_nat = twice_nat;
1230       m->out2in_only = out2in_only;
1231
1232       m_key.addr = m->external_addr;
1233       m_key.port = m->external_port;
1234       m_key.protocol = m->proto;
1235       m_key.fib_index = sm->outside_fib_index;
1236       kv.key = m_key.as_u64;
1237       kv.value = m - sm->static_mappings;
1238       if (clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 1))
1239         {
1240           clib_warning ("static_mapping_by_external key add failed");
1241           return VNET_API_ERROR_UNSPECIFIED;
1242         }
1243
1244       /* Assign worker */
1245       if (sm->workers)
1246         {
1247           worker_index = sm->first_worker_index +
1248             sm->workers[sm->next_worker++ % vec_len (sm->workers)];
1249           tsm = vec_elt_at_index (sm->per_thread_data, worker_index);
1250           m->worker_index = worker_index;
1251         }
1252       else
1253         tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1254
1255       m_key.port = clib_host_to_net_u16 (m->external_port);
1256       kv.key = m_key.as_u64;
1257       kv.value = ~0ULL;
1258       if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 1))
1259         {
1260           clib_warning ("out2in key add failed");
1261           return VNET_API_ERROR_UNSPECIFIED;
1262         }
1263
1264       m_key.fib_index = m->fib_index;
1265       for (i = 0; i < vec_len (locals); i++)
1266         {
1267           m_key.addr = locals[i].addr;
1268           if (!out2in_only)
1269             {
1270               m_key.port = locals[i].port;
1271               kv.key = m_key.as_u64;
1272               kv.value = m - sm->static_mappings;
1273               clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 1);
1274             }
1275           locals[i].prefix = (i == 0) ? locals[i].probability :\
1276             (locals[i - 1].prefix + locals[i].probability);
1277           vec_add1 (m->locals, locals[i]);
1278
1279           m_key.port = clib_host_to_net_u16 (locals[i].port);
1280           kv.key = m_key.as_u64;
1281           kv.value = ~0ULL;
1282           if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 1))
1283             {
1284               clib_warning ("in2out key add failed");
1285               return VNET_API_ERROR_UNSPECIFIED;
1286             }
1287         }
1288     }
1289   else
1290     {
1291       if (!m)
1292         return VNET_API_ERROR_NO_SUCH_ENTRY;
1293
1294       fib_table_unlock (m->fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_PLUGIN_LOW);
1295
1296       /* Free external address port */
1297       if (!(sm->static_mapping_only || out2in_only))
1298         {
1299           for (i = 0; i < vec_len (sm->addresses); i++)
1300             {
1301               if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1302                 {
1303                   a = sm->addresses + i;
1304                   switch (proto)
1305                     {
1306 #define _(N, j, n, s) \
1307                     case SNAT_PROTOCOL_##N: \
1308                       clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
1309                       if (e_port > 1024) \
1310                         { \
1311                           a->busy_##n##_ports--; \
1312                           a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]--; \
1313                         } \
1314                       break;
1315                       foreach_snat_protocol
1316 #undef _
1317                     default:
1318                       clib_warning("unknown_protocol");
1319                       return VNET_API_ERROR_INVALID_VALUE_2;
1320                     }
1321                   break;
1322                 }
1323             }
1324         }
1325
1326       tsm = vec_elt_at_index (sm->per_thread_data, m->worker_index);
1327       m_key.addr = m->external_addr;
1328       m_key.port = m->external_port;
1329       m_key.protocol = m->proto;
1330       m_key.fib_index = sm->outside_fib_index;
1331       kv.key = m_key.as_u64;
1332       if (clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 0))
1333         {
1334           clib_warning ("static_mapping_by_external key del failed");
1335           return VNET_API_ERROR_UNSPECIFIED;
1336         }
1337
1338       m_key.port = clib_host_to_net_u16 (m->external_port);
1339       kv.key = m_key.as_u64;
1340       if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 0))
1341         {
1342           clib_warning ("outi2in key del failed");
1343           return VNET_API_ERROR_UNSPECIFIED;
1344         }
1345
1346       vec_foreach (local, m->locals)
1347         {
1348           m_key.addr = local->addr;
1349           if (!out2in_only)
1350             {
1351               m_key.port = local->port;
1352               m_key.fib_index = m->fib_index;
1353               kv.key = m_key.as_u64;
1354               if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1355                 {
1356                   clib_warning ("static_mapping_by_local key del failed");
1357                   return VNET_API_ERROR_UNSPECIFIED;
1358                 }
1359             }
1360
1361           if (!lb_local_exists(local, &e_addr, e_port))
1362             {
1363               m_key.port = clib_host_to_net_u16 (local->port);
1364               kv.key = m_key.as_u64;
1365               if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 0))
1366                 {
1367                   clib_warning ("in2out key del failed");
1368                   return VNET_API_ERROR_UNSPECIFIED;
1369                 }
1370             }
1371           /* Delete sessions */
1372           u_key.addr = local->addr;
1373           u_key.fib_index = m->fib_index;
1374           kv.key = u_key.as_u64;
1375           if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1376             {
1377               u = pool_elt_at_index (tsm->users, value.value);
1378               if (u->nstaticsessions)
1379                 {
1380                   head_index = u->sessions_per_user_list_head_index;
1381                   head = pool_elt_at_index (tsm->list_pool, head_index);
1382                   elt_index = head->next;
1383                   elt = pool_elt_at_index (tsm->list_pool, elt_index);
1384                   ses_index = elt->value;
1385                   while (ses_index != ~0)
1386                     {
1387                       s =  pool_elt_at_index (tsm->sessions, ses_index);
1388                       elt = pool_elt_at_index (tsm->list_pool, elt->next);
1389                       ses_index = elt->value;
1390
1391                       if ((s->in2out.addr.as_u32 != local->addr.as_u32) &&
1392                           (clib_net_to_host_u16 (s->in2out.port) != local->port))
1393                         continue;
1394
1395                       nat_free_session_data (sm, s, tsm - sm->per_thread_data);
1396                       clib_dlist_remove (tsm->list_pool, s->per_user_index);
1397                       pool_put_index (tsm->list_pool, s->per_user_index);
1398                       pool_put (tsm->sessions, s);
1399                       u->nstaticsessions--;
1400                     }
1401                 }
1402             }
1403         }
1404       vec_free(m->locals);
1405       vec_free(m->tag);
1406
1407       pool_put (sm->static_mappings, m);
1408     }
1409
1410   return 0;
1411 }
1412
1413 int
1414 snat_del_address (snat_main_t *sm, ip4_address_t addr, u8 delete_sm,
1415                   u8 twice_nat)
1416 {
1417   snat_address_t *a = 0;
1418   snat_session_t *ses;
1419   u32 *ses_to_be_removed = 0, *ses_index;
1420   clib_bihash_kv_8_8_t kv, value;
1421   snat_user_key_t user_key;
1422   snat_user_t *u;
1423   snat_main_per_thread_data_t *tsm;
1424   snat_static_mapping_t *m;
1425   snat_interface_t *interface;
1426   int i;
1427   snat_address_t *addresses = twice_nat ? sm->twice_nat_addresses : sm->addresses;
1428
1429   /* Find SNAT address */
1430   for (i=0; i < vec_len (addresses); i++)
1431     {
1432       if (addresses[i].addr.as_u32 == addr.as_u32)
1433         {
1434           a = addresses + i;
1435           break;
1436         }
1437     }
1438   if (!a)
1439     return VNET_API_ERROR_NO_SUCH_ENTRY;
1440
1441   if (delete_sm)
1442     {
1443       pool_foreach (m, sm->static_mappings,
1444       ({
1445           if (m->external_addr.as_u32 == addr.as_u32)
1446             (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1447                                             m->local_port, m->external_port,
1448                                             m->vrf_id, m->addr_only, ~0,
1449                                             m->proto, 0, m->twice_nat,
1450                                             m->out2in_only, m->tag);
1451       }));
1452     }
1453   else
1454     {
1455       /* Check if address is used in some static mapping */
1456       if (is_snat_address_used_in_static_mapping(sm, addr))
1457         {
1458           clib_warning ("address used in static mapping");
1459           return VNET_API_ERROR_UNSPECIFIED;
1460         }
1461     }
1462
1463   if (a->fib_index != ~0)
1464     fib_table_unlock(a->fib_index, FIB_PROTOCOL_IP4,
1465                      FIB_SOURCE_PLUGIN_LOW);
1466
1467   /* Delete sessions using address */
1468   if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1469     {
1470       vec_foreach (tsm, sm->per_thread_data)
1471         {
1472           pool_foreach (ses, tsm->sessions, ({
1473             if (ses->out2in.addr.as_u32 == addr.as_u32)
1474               {
1475                 ses->outside_address_index = ~0;
1476                 nat_free_session_data (sm, ses, tsm - sm->per_thread_data);
1477                 clib_dlist_remove (tsm->list_pool, ses->per_user_index);
1478                 pool_put_index (tsm->list_pool, ses->per_user_index);
1479                 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1480                 user_key.addr = ses->in2out.addr;
1481                 user_key.fib_index = ses->in2out.fib_index;
1482                 kv.key = user_key.as_u64;
1483                 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1484                   {
1485                     u = pool_elt_at_index (tsm->users, value.value);
1486                     u->nsessions--;
1487                   }
1488               }
1489           }));
1490
1491           vec_foreach (ses_index, ses_to_be_removed)
1492             pool_put_index (tsm->sessions, ses_index[0]);
1493
1494           vec_free (ses_to_be_removed);
1495        }
1496     }
1497
1498   if (twice_nat)
1499     {
1500       vec_del1 (sm->twice_nat_addresses, i);
1501       return 0;
1502     }
1503   else
1504     vec_del1 (sm->addresses, i);
1505
1506   /* Delete external address from FIB */
1507   pool_foreach (interface, sm->interfaces,
1508   ({
1509     if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1510       continue;
1511
1512     snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1513     break;
1514   }));
1515   pool_foreach (interface, sm->output_feature_interfaces,
1516   ({
1517     if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1518       continue;
1519
1520     snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1521     break;
1522   }));
1523
1524   return 0;
1525 }
1526
1527 int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1528 {
1529   snat_main_t *sm = &snat_main;
1530   snat_interface_t *i;
1531   const char * feature_name, *del_feature_name;
1532   snat_address_t * ap;
1533   snat_static_mapping_t * m;
1534   snat_det_map_t * dm;
1535
1536   if (sm->out2in_dpo && !is_inside)
1537     return VNET_API_ERROR_UNSUPPORTED;
1538
1539   pool_foreach (i, sm->output_feature_interfaces,
1540   ({
1541     if (i->sw_if_index == sw_if_index)
1542       return VNET_API_ERROR_VALUE_EXIST;
1543   }));
1544
1545   if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1546     feature_name = is_inside ?  "nat44-in2out-fast" : "nat44-out2in-fast";
1547   else
1548     {
1549       if (sm->num_workers > 1 && !sm->deterministic)
1550         feature_name = is_inside ?  "nat44-in2out-worker-handoff" : "nat44-out2in-worker-handoff";
1551       else if (sm->deterministic)
1552         feature_name = is_inside ?  "nat44-det-in2out" : "nat44-det-out2in";
1553       else
1554         feature_name = is_inside ?  "nat44-in2out" : "nat44-out2in";
1555     }
1556
1557   if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1558     sm->fq_in2out_index = vlib_frame_queue_main_init (sm->in2out_node_index, 0);
1559
1560   if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1561     sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index, 0);
1562
1563   pool_foreach (i, sm->interfaces,
1564   ({
1565     if (i->sw_if_index == sw_if_index)
1566       {
1567         if (is_del)
1568           {
1569             if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1570               {
1571                 if (is_inside)
1572                   i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1573                 else
1574                   i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1575
1576                 if (sm->num_workers > 1 && !sm->deterministic)
1577                   {
1578                     del_feature_name = "nat44-handoff-classify";
1579                     feature_name = !is_inside ?  "nat44-in2out-worker-handoff" :
1580                                                  "nat44-out2in-worker-handoff";
1581                   }
1582                 else if (sm->deterministic)
1583                   {
1584                     del_feature_name = "nat44-det-classify";
1585                     feature_name = !is_inside ?  "nat44-det-in2out" :
1586                                                  "nat44-det-out2in";
1587                   }
1588                 else
1589                   {
1590                     del_feature_name = "nat44-classify";
1591                     feature_name = !is_inside ?  "nat44-in2out" : "nat44-out2in";
1592                   }
1593
1594                 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1595                                              sw_if_index, 0, 0, 0);
1596                 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1597                                              sw_if_index, 1, 0, 0);
1598               }
1599             else
1600               {
1601                 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1602                                              sw_if_index, 0, 0, 0);
1603                 pool_put (sm->interfaces, i);
1604               }
1605           }
1606         else
1607           {
1608             if ((nat_interface_is_inside(i) && is_inside) ||
1609                 (nat_interface_is_outside(i) && !is_inside))
1610               return 0;
1611
1612             if (sm->num_workers > 1 && !sm->deterministic)
1613               {
1614                 del_feature_name = !is_inside ?  "nat44-in2out-worker-handoff" :
1615                                                  "nat44-out2in-worker-handoff";
1616                 feature_name = "nat44-handoff-classify";
1617               }
1618             else if (sm->deterministic)
1619               {
1620                 del_feature_name = !is_inside ?  "nat44-det-in2out" :
1621                                                  "nat44-det-out2in";
1622                 feature_name = "nat44-det-classify";
1623               }
1624             else
1625               {
1626                 del_feature_name = !is_inside ?  "nat44-in2out" : "nat44-out2in";
1627                 feature_name = "nat44-classify";
1628               }
1629
1630             vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1631                                          sw_if_index, 0, 0, 0);
1632             vnet_feature_enable_disable ("ip4-unicast", feature_name,
1633                                          sw_if_index, 1, 0, 0);
1634             goto set_flags;
1635           }
1636
1637         goto fib;
1638       }
1639   }));
1640
1641   if (is_del)
1642     return VNET_API_ERROR_NO_SUCH_ENTRY;
1643
1644   pool_get (sm->interfaces, i);
1645   i->sw_if_index = sw_if_index;
1646   i->flags = 0;
1647   vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0, 0);
1648
1649 set_flags:
1650   if (is_inside)
1651     i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1652   else
1653     i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1654
1655   /* Add/delete external addresses to FIB */
1656 fib:
1657   if (is_inside && !sm->out2in_dpo)
1658     {
1659       vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1660                                    sw_if_index, !is_del, 0, 0);
1661       return 0;
1662     }
1663
1664   vec_foreach (ap, sm->addresses)
1665     snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1666
1667   pool_foreach (m, sm->static_mappings,
1668   ({
1669     if (!(m->addr_only) || (m->local_addr.as_u32 == m->external_addr.as_u32))
1670       continue;
1671
1672     snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1673   }));
1674
1675   pool_foreach (dm, sm->det_maps,
1676   ({
1677     snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
1678   }));
1679
1680   return 0;
1681 }
1682
1683 int snat_interface_add_del_output_feature (u32 sw_if_index,
1684                                            u8 is_inside,
1685                                            int is_del)
1686 {
1687   snat_main_t *sm = &snat_main;
1688   snat_interface_t *i;
1689   snat_address_t * ap;
1690   snat_static_mapping_t * m;
1691
1692   if (sm->deterministic ||
1693       (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
1694     return VNET_API_ERROR_UNSUPPORTED;
1695
1696   pool_foreach (i, sm->interfaces,
1697   ({
1698     if (i->sw_if_index == sw_if_index)
1699       return VNET_API_ERROR_VALUE_EXIST;
1700   }));
1701
1702   if (is_inside)
1703     {
1704       vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
1705                                    sw_if_index, !is_del, 0, 0);
1706       vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
1707                                    sw_if_index, !is_del, 0, 0);
1708       goto fq;
1709     }
1710
1711   if (sm->num_workers > 1)
1712     {
1713       vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in-worker-handoff",
1714                                    sw_if_index, !is_del, 0, 0);
1715       vnet_feature_enable_disable ("ip4-output",
1716                                    "nat44-in2out-output-worker-handoff",
1717                                    sw_if_index, !is_del, 0, 0);
1718     }
1719   else
1720     {
1721       vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in", sw_if_index,
1722                                    !is_del, 0, 0);
1723       vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
1724                                    sw_if_index, !is_del, 0, 0);
1725     }
1726
1727 fq:
1728   if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
1729     sm->fq_in2out_output_index =
1730       vlib_frame_queue_main_init (sm->in2out_output_node_index, 0);
1731
1732   if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
1733     sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index, 0);
1734
1735   pool_foreach (i, sm->output_feature_interfaces,
1736   ({
1737     if (i->sw_if_index == sw_if_index)
1738       {
1739         if (is_del)
1740           pool_put (sm->output_feature_interfaces, i);
1741         else
1742           return VNET_API_ERROR_VALUE_EXIST;
1743
1744         goto fib;
1745       }
1746   }));
1747
1748   if (is_del)
1749     return VNET_API_ERROR_NO_SUCH_ENTRY;
1750
1751   pool_get (sm->output_feature_interfaces, i);
1752   i->sw_if_index = sw_if_index;
1753   i->flags = 0;
1754   if (is_inside)
1755     i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1756   else
1757     i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1758
1759   /* Add/delete external addresses to FIB */
1760 fib:
1761   if (is_inside)
1762     return 0;
1763
1764   vec_foreach (ap, sm->addresses)
1765     snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1766
1767   pool_foreach (m, sm->static_mappings,
1768   ({
1769     if (!(m->addr_only))
1770       continue;
1771
1772     snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1773   }));
1774
1775   return 0;
1776 }
1777
1778 int snat_set_workers (uword * bitmap)
1779 {
1780   snat_main_t *sm = &snat_main;
1781   int i, j = 0;
1782
1783   if (sm->num_workers < 2)
1784     return VNET_API_ERROR_FEATURE_DISABLED;
1785
1786   if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
1787     return VNET_API_ERROR_INVALID_WORKER;
1788
1789   vec_free (sm->workers);
1790   clib_bitmap_foreach (i, bitmap,
1791     ({
1792       vec_add1(sm->workers, i);
1793       sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
1794       j++;
1795     }));
1796
1797   sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
1798   sm->num_snat_thread = _vec_len (sm->workers);
1799
1800   return 0;
1801 }
1802
1803
1804 static void
1805 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
1806                                        uword opaque,
1807                                        u32 sw_if_index,
1808                                        ip4_address_t * address,
1809                                        u32 address_length,
1810                                        u32 if_address_index,
1811                                        u32 is_delete);
1812
1813 static void
1814 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
1815                                  uword opaque,
1816                                  u32 sw_if_index,
1817                                  ip4_address_t * address,
1818                                  u32 address_length,
1819                                  u32 if_address_index,
1820                                  u32 is_delete);
1821
1822 static int
1823 nat_alloc_addr_and_port_default (snat_address_t * addresses,
1824                                  u32 fib_index,
1825                                  u32 thread_index,
1826                                  snat_session_key_t * k,
1827                                  u32 * address_indexp,
1828                                  u16 port_per_thread,
1829                                  u32 snat_thread_index);
1830
1831 static clib_error_t * snat_init (vlib_main_t * vm)
1832 {
1833   snat_main_t * sm = &snat_main;
1834   clib_error_t * error = 0;
1835   ip4_main_t * im = &ip4_main;
1836   ip_lookup_main_t * lm = &im->lookup_main;
1837   uword *p;
1838   vlib_thread_registration_t *tr;
1839   vlib_thread_main_t *tm = vlib_get_thread_main ();
1840   uword *bitmap = 0;
1841   u32 i;
1842   ip4_add_del_interface_address_callback_t cb4;
1843
1844   sm->vlib_main = vm;
1845   sm->vnet_main = vnet_get_main();
1846   sm->ip4_main = im;
1847   sm->ip4_lookup_main = lm;
1848   sm->api_main = &api_main;
1849   sm->first_worker_index = 0;
1850   sm->next_worker = 0;
1851   sm->num_workers = 0;
1852   sm->num_snat_thread = 1;
1853   sm->workers = 0;
1854   sm->port_per_thread = 0xffff - 1024;
1855   sm->fq_in2out_index = ~0;
1856   sm->fq_out2in_index = ~0;
1857   sm->udp_timeout = SNAT_UDP_TIMEOUT;
1858   sm->tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
1859   sm->tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
1860   sm->icmp_timeout = SNAT_ICMP_TIMEOUT;
1861   sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
1862   sm->forwarding_enabled = 0;
1863
1864   p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1865   if (p)
1866     {
1867       tr = (vlib_thread_registration_t *) p[0];
1868       if (tr)
1869         {
1870           sm->num_workers = tr->count;
1871           sm->first_worker_index = tr->first_index;
1872         }
1873     }
1874
1875   vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
1876
1877   /* Use all available workers by default */
1878   if (sm->num_workers > 1)
1879     {
1880       for (i=0; i < sm->num_workers; i++)
1881         bitmap = clib_bitmap_set (bitmap, i, 1);
1882       snat_set_workers(bitmap);
1883       clib_bitmap_free (bitmap);
1884     }
1885   else
1886     {
1887       sm->per_thread_data[0].snat_thread_index = 0;
1888     }
1889
1890   error = snat_api_init(vm, sm);
1891   if (error)
1892     return error;
1893
1894   /* Set up the interface address add/del callback */
1895   cb4.function = snat_ip4_add_del_interface_address_cb;
1896   cb4.function_opaque = 0;
1897
1898   vec_add1 (im->add_del_interface_address_callbacks, cb4);
1899
1900   cb4.function = nat_ip4_add_del_addr_only_sm_cb;
1901   cb4.function_opaque = 0;
1902
1903   vec_add1 (im->add_del_interface_address_callbacks, cb4);
1904
1905   nat_dpo_module_init ();
1906
1907   /* Init IPFIX logging */
1908   snat_ipfix_logging_init(vm);
1909
1910   /* Init NAT64 */
1911   error = nat64_init(vm);
1912   if (error)
1913     return error;
1914
1915   dslite_init(vm);
1916
1917   nat66_init();
1918
1919   /* Init virtual fragmenentation reassembly */
1920   return nat_reass_init(vm);
1921 }
1922
1923 VLIB_INIT_FUNCTION (snat_init);
1924
1925 void snat_free_outside_address_and_port (snat_address_t * addresses,
1926                                          u32 thread_index,
1927                                          snat_session_key_t * k,
1928                                          u32 address_index)
1929 {
1930   snat_address_t *a;
1931   u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
1932
1933   ASSERT (address_index < vec_len (addresses));
1934
1935   a = addresses + address_index;
1936
1937   switch (k->protocol)
1938     {
1939 #define _(N, i, n, s) \
1940     case SNAT_PROTOCOL_##N: \
1941       ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
1942         port_host_byte_order) == 1); \
1943       clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
1944         port_host_byte_order, 0); \
1945       a->busy_##n##_ports--; \
1946       a->busy_##n##_ports_per_thread[thread_index]--; \
1947       break;
1948       foreach_snat_protocol
1949 #undef _
1950     default:
1951       clib_warning("unknown_protocol");
1952       return;
1953     }
1954 }
1955
1956 /**
1957  * @brief Match NAT44 static mapping.
1958  *
1959  * @param sm          NAT main.
1960  * @param match       Address and port to match.
1961  * @param mapping     External or local address and port of the matched mapping.
1962  * @param by_external If 0 match by local address otherwise match by external
1963  *                    address.
1964  * @param is_addr_only If matched mapping is address only
1965  * @param twice_nat If matched mapping is twice NAT.
1966  *
1967  * @returns 0 if match found otherwise 1.
1968  */
1969 int snat_static_mapping_match (snat_main_t * sm,
1970                                snat_session_key_t match,
1971                                snat_session_key_t * mapping,
1972                                u8 by_external,
1973                                u8 *is_addr_only,
1974                                u8 *twice_nat)
1975 {
1976   clib_bihash_kv_8_8_t kv, value;
1977   snat_static_mapping_t *m;
1978   snat_session_key_t m_key;
1979   clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
1980   u32 rand, lo = 0, hi, mid;
1981
1982   if (by_external)
1983     mapping_hash = &sm->static_mapping_by_external;
1984
1985   m_key.addr = match.addr;
1986   m_key.port = clib_net_to_host_u16 (match.port);
1987   m_key.protocol = match.protocol;
1988   m_key.fib_index = match.fib_index;
1989
1990   kv.key = m_key.as_u64;
1991
1992   if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
1993     {
1994       /* Try address only mapping */
1995       m_key.port = 0;
1996       m_key.protocol = 0;
1997       kv.key = m_key.as_u64;
1998       if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
1999         return 1;
2000     }
2001
2002   m = pool_elt_at_index (sm->static_mappings, value.value);
2003
2004   if (by_external)
2005     {
2006       if (vec_len (m->locals))
2007         {
2008           hi = vec_len (m->locals) - 1;
2009           rand = 1 + (random_u32 (&sm->random_seed) % m->locals[hi].prefix);
2010           while (lo < hi)
2011             {
2012               mid = ((hi - lo) >> 1) + lo;
2013               (rand > m->locals[mid].prefix) ? (lo = mid + 1) : (hi = mid);
2014             }
2015           if (!(m->locals[lo].prefix >= rand))
2016             return 1;
2017           mapping->addr = m->locals[lo].addr;
2018           mapping->port = clib_host_to_net_u16 (m->locals[lo].port);
2019         }
2020       else
2021         {
2022           mapping->addr = m->local_addr;
2023           /* Address only mapping doesn't change port */
2024           mapping->port = m->addr_only ? match.port
2025             : clib_host_to_net_u16 (m->local_port);
2026         }
2027       mapping->fib_index = m->fib_index;
2028       mapping->protocol = m->proto;
2029     }
2030   else
2031     {
2032       mapping->addr = m->external_addr;
2033       /* Address only mapping doesn't change port */
2034       mapping->port = m->addr_only ? match.port
2035         : clib_host_to_net_u16 (m->external_port);
2036       mapping->fib_index = sm->outside_fib_index;
2037     }
2038
2039   if (PREDICT_FALSE(is_addr_only != 0))
2040     *is_addr_only = m->addr_only;
2041
2042   if (PREDICT_FALSE(twice_nat != 0))
2043     *twice_nat = m->twice_nat;
2044
2045   return 0;
2046 }
2047
2048 static_always_inline u16
2049 snat_random_port (u16 min, u16 max)
2050 {
2051   snat_main_t *sm = &snat_main;
2052   return min + random_u32 (&sm->random_seed) /
2053     (random_u32_max() / (max - min + 1) + 1);
2054 }
2055
2056 int
2057 snat_alloc_outside_address_and_port (snat_address_t * addresses,
2058                                      u32 fib_index,
2059                                      u32 thread_index,
2060                                      snat_session_key_t * k,
2061                                      u32 * address_indexp,
2062                                      u16 port_per_thread,
2063                                      u32 snat_thread_index)
2064 {
2065   snat_main_t *sm = &snat_main;
2066
2067   return sm->alloc_addr_and_port(addresses, fib_index, thread_index, k,
2068                                  address_indexp, port_per_thread,
2069                                  snat_thread_index);
2070 }
2071
2072 static int
2073 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2074                                  u32 fib_index,
2075                                  u32 thread_index,
2076                                  snat_session_key_t * k,
2077                                  u32 * address_indexp,
2078                                  u16 port_per_thread,
2079                                  u32 snat_thread_index)
2080 {
2081   int i, gi = 0;
2082   snat_address_t *a, *ga = 0;
2083   u32 portnum;
2084
2085   for (i = 0; i < vec_len (addresses); i++)
2086     {
2087       a = addresses + i;
2088       switch (k->protocol)
2089         {
2090 #define _(N, j, n, s) \
2091         case SNAT_PROTOCOL_##N: \
2092           if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
2093             { \
2094               if (a->fib_index == fib_index) \
2095                 { \
2096                   while (1) \
2097                     { \
2098                       portnum = (port_per_thread * \
2099                         snat_thread_index) + \
2100                         snat_random_port(1, port_per_thread) + 1024; \
2101                       if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2102                         continue; \
2103                       clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2104                       a->busy_##n##_ports_per_thread[thread_index]++; \
2105                       a->busy_##n##_ports++; \
2106                       k->addr = a->addr; \
2107                       k->port = clib_host_to_net_u16(portnum); \
2108                       *address_indexp = i; \
2109                       return 0; \
2110                     } \
2111                 } \
2112               else if (a->fib_index == ~0) \
2113                 { \
2114                   ga = a; \
2115                   gi = i; \
2116                 } \
2117             } \
2118           break;
2119           foreach_snat_protocol
2120 #undef _
2121         default:
2122           clib_warning("unknown protocol");
2123           return 1;
2124         }
2125
2126     }
2127
2128   if (ga)
2129     {
2130       a = ga;
2131       switch (k->protocol)
2132         {
2133 #define _(N, j, n, s) \
2134         case SNAT_PROTOCOL_##N: \
2135           while (1) \
2136             { \
2137               portnum = (port_per_thread * \
2138                 snat_thread_index) + \
2139                 snat_random_port(1, port_per_thread) + 1024; \
2140               if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2141                 continue; \
2142               clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2143               a->busy_##n##_ports_per_thread[thread_index]++; \
2144               a->busy_##n##_ports++; \
2145               k->addr = a->addr; \
2146               k->port = clib_host_to_net_u16(portnum); \
2147               *address_indexp = gi; \
2148               return 0; \
2149             }
2150           break;
2151           foreach_snat_protocol
2152 #undef _
2153         default:
2154           clib_warning ("unknown protocol");
2155           return 1;
2156         }
2157     }
2158
2159   /* Totally out of translations to use... */
2160   snat_ipfix_logging_addresses_exhausted(0);
2161   return 1;
2162 }
2163
2164 static int
2165 nat_alloc_addr_and_port_mape (snat_address_t * addresses,
2166                               u32 fib_index,
2167                               u32 thread_index,
2168                               snat_session_key_t * k,
2169                               u32 * address_indexp,
2170                               u16 port_per_thread,
2171                               u32 snat_thread_index)
2172 {
2173   snat_main_t *sm = &snat_main;
2174   snat_address_t *a = addresses;
2175   u16 m, ports, portnum, A, j;
2176   m = 16 - (sm->psid_offset + sm->psid_length);
2177   ports = (1 << (16 - sm->psid_length)) - (1 << m);
2178
2179   if (!vec_len (addresses))
2180     goto exhausted;
2181
2182   switch (k->protocol)
2183     {
2184 #define _(N, i, n, s) \
2185     case SNAT_PROTOCOL_##N: \
2186       if (a->busy_##n##_ports < ports) \
2187         { \
2188           while (1) \
2189             { \
2190               A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
2191               j = snat_random_port(0, pow2_mask(m)); \
2192               portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
2193               if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2194                 continue; \
2195               clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2196               a->busy_##n##_ports++; \
2197               k->addr = a->addr; \
2198               k->port = clib_host_to_net_u16 (portnum); \
2199               *address_indexp = i; \
2200               return 0; \
2201             } \
2202         } \
2203       break;
2204       foreach_snat_protocol
2205 #undef _
2206     default:
2207       clib_warning("unknown protocol");
2208       return 1;
2209     }
2210
2211 exhausted:
2212   /* Totally out of translations to use... */
2213   snat_ipfix_logging_addresses_exhausted(0);
2214   return 1;
2215 }
2216
2217 void
2218 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
2219 {
2220   dpo_id_t dpo_v4 = DPO_INVALID;
2221   fib_prefix_t pfx = {
2222     .fp_proto = FIB_PROTOCOL_IP4,
2223     .fp_len = 32,
2224     .fp_addr.ip4.as_u32 = addr.as_u32,
2225   };
2226
2227   if (is_add)
2228     {
2229       nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
2230       fib_table_entry_special_dpo_add (0, &pfx, FIB_SOURCE_PLUGIN_HI,
2231                                        FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
2232       dpo_reset (&dpo_v4);
2233     }
2234   else
2235     {
2236       fib_table_entry_special_remove (0, &pfx, FIB_SOURCE_PLUGIN_HI);
2237     }
2238 }
2239
2240 uword
2241 unformat_snat_protocol (unformat_input_t * input, va_list * args)
2242 {
2243   u32 *r = va_arg (*args, u32 *);
2244
2245   if (0);
2246 #define _(N, i, n, s) else if (unformat (input, s)) *r = SNAT_PROTOCOL_##N;
2247   foreach_snat_protocol
2248 #undef _
2249   else
2250     return 0;
2251   return 1;
2252 }
2253
2254 u8 *
2255 format_snat_protocol (u8 * s, va_list * args)
2256 {
2257   u32 i = va_arg (*args, u32);
2258   u8 *t = 0;
2259
2260   switch (i)
2261     {
2262 #define _(N, j, n, str) case SNAT_PROTOCOL_##N: t = (u8 *) str; break;
2263       foreach_snat_protocol
2264 #undef _
2265     default:
2266       s = format (s, "unknown");
2267       return s;
2268     }
2269   s = format (s, "%s", t);
2270   return s;
2271 }
2272
2273 static u32
2274 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2275 {
2276   snat_main_t *sm = &snat_main;
2277   u32 next_worker_index = 0;
2278   u32 hash;
2279
2280   next_worker_index = sm->first_worker_index;
2281   hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
2282          (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >>24);
2283
2284   if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
2285     next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
2286   else
2287     next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
2288
2289   return next_worker_index;
2290 }
2291
2292 static u32
2293 snat_get_worker_out2in_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2294 {
2295   snat_main_t *sm = &snat_main;
2296   udp_header_t *udp;
2297   u16 port;
2298   snat_session_key_t m_key;
2299   clib_bihash_kv_8_8_t kv, value;
2300   snat_static_mapping_t *m;
2301   nat_ed_ses_key_t key;
2302   clib_bihash_kv_16_8_t s_kv, s_value;
2303   snat_main_per_thread_data_t *tsm;
2304   snat_session_t *s;
2305   int i;
2306   u32 proto;
2307   u32 next_worker_index = 0;
2308
2309   /* first try static mappings without port */
2310   if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2311     {
2312       m_key.addr = ip0->dst_address;
2313       m_key.port = 0;
2314       m_key.protocol = 0;
2315       m_key.fib_index = rx_fib_index0;
2316       kv.key = m_key.as_u64;
2317       if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
2318         {
2319           m = pool_elt_at_index (sm->static_mappings, value.value);
2320           return m->worker_index;
2321         }
2322     }
2323
2324   proto = ip_proto_to_snat_proto (ip0->protocol);
2325   udp = ip4_next_header (ip0);
2326   port = udp->dst_port;
2327
2328   if (PREDICT_FALSE (ip4_is_fragment (ip0)))
2329     {
2330       if (PREDICT_FALSE (nat_reass_is_drop_frag (0)))
2331         return vlib_get_thread_index ();
2332
2333       if (PREDICT_TRUE (!ip4_is_first_fragment (ip0)))
2334         {
2335           nat_reass_ip4_t *reass;
2336
2337           reass = nat_ip4_reass_find (ip0->src_address, ip0->dst_address,
2338                                       ip0->fragment_id, ip0->protocol);
2339
2340           if (reass && (reass->thread_index != (u32) ~ 0))
2341             return reass->thread_index;
2342           else
2343             return vlib_get_thread_index ();
2344         }
2345     }
2346
2347   /* unknown protocol */
2348   if (PREDICT_FALSE (proto == ~0))
2349     {
2350       key.l_addr = ip0->dst_address;
2351       key.r_addr = ip0->src_address;
2352       key.fib_index = rx_fib_index0;
2353       key.proto = ip0->protocol;
2354       key.r_port = 0;
2355       key.l_port = 0;
2356       s_kv.key[0] = key.as_u64[0];
2357       s_kv.key[1] = key.as_u64[1];
2358
2359       if (!clib_bihash_search_16_8 (&sm->out2in_ed, &s_kv, &s_value))
2360         {
2361           for (i = 0; i < _vec_len (sm->per_thread_data); i++)
2362             {
2363               tsm = vec_elt_at_index (sm->per_thread_data, i);
2364               if (!pool_is_free_index(tsm->sessions, s_value.value))
2365                 {
2366                   s = pool_elt_at_index (tsm->sessions, s_value.value);
2367                   if (s->out2in.addr.as_u32 == ip0->dst_address.as_u32 &&
2368                       s->out2in.port == ip0->protocol &&
2369                       snat_is_unk_proto_session (s))
2370                     return i;
2371                 }
2372             }
2373          }
2374
2375       /* if no session use current thread */
2376       return vlib_get_thread_index ();
2377     }
2378
2379   if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
2380     {
2381       icmp46_header_t * icmp = (icmp46_header_t *) udp;
2382       icmp_echo_header_t *echo = (icmp_echo_header_t *)(icmp + 1);
2383       if (!icmp_is_error_message (icmp))
2384         port = echo->identifier;
2385       else
2386         {
2387           ip4_header_t *inner_ip = (ip4_header_t *)(echo + 1);
2388           proto = ip_proto_to_snat_proto (inner_ip->protocol);
2389           void *l4_header = ip4_next_header (inner_ip);
2390           switch (proto)
2391             {
2392             case SNAT_PROTOCOL_ICMP:
2393               icmp = (icmp46_header_t*)l4_header;
2394               echo = (icmp_echo_header_t *)(icmp + 1);
2395               port = echo->identifier;
2396               break;
2397             case SNAT_PROTOCOL_UDP:
2398             case SNAT_PROTOCOL_TCP:
2399               port = ((tcp_udp_header_t*)l4_header)->src_port;
2400               break;
2401             default:
2402               return vlib_get_thread_index ();
2403             }
2404         }
2405     }
2406
2407   /* try static mappings with port */
2408   if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2409     {
2410       m_key.addr = ip0->dst_address;
2411       m_key.port = clib_net_to_host_u16 (port);
2412       m_key.protocol = proto;
2413       m_key.fib_index = rx_fib_index0;
2414       kv.key = m_key.as_u64;
2415       if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
2416         {
2417           m = pool_elt_at_index (sm->static_mappings, value.value);
2418           return m->worker_index;
2419         }
2420     }
2421
2422   /* worker by outside port */
2423   next_worker_index = sm->first_worker_index;
2424   next_worker_index +=
2425     sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
2426   return next_worker_index;
2427 }
2428
2429 static clib_error_t *
2430 snat_config (vlib_main_t * vm, unformat_input_t * input)
2431 {
2432   snat_main_t * sm = &snat_main;
2433   u32 translation_buckets = 1024;
2434   u32 translation_memory_size = 128<<20;
2435   u32 user_buckets = 128;
2436   u32 user_memory_size = 64<<20;
2437   u32 max_translations_per_user = 100;
2438   u32 outside_vrf_id = 0;
2439   u32 inside_vrf_id = 0;
2440   u32 static_mapping_buckets = 1024;
2441   u32 static_mapping_memory_size = 64<<20;
2442   u32 nat64_bib_buckets = 1024;
2443   u32 nat64_bib_memory_size = 128 << 20;
2444   u32 nat64_st_buckets = 2048;
2445   u32 nat64_st_memory_size = 256 << 20;
2446   u8 static_mapping_only = 0;
2447   u8 static_mapping_connection_tracking = 0;
2448   snat_main_per_thread_data_t *tsm;
2449   dslite_main_t * dm = &dslite_main;
2450
2451   sm->deterministic = 0;
2452   sm->out2in_dpo = 0;
2453
2454   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2455     {
2456       if (unformat (input, "translation hash buckets %d", &translation_buckets))
2457         ;
2458       else if (unformat (input, "translation hash memory %d",
2459                          &translation_memory_size));
2460       else if (unformat (input, "user hash buckets %d", &user_buckets))
2461         ;
2462       else if (unformat (input, "user hash memory %d",
2463                          &user_memory_size))
2464         ;
2465       else if (unformat (input, "max translations per user %d",
2466                          &max_translations_per_user))
2467         ;
2468       else if (unformat (input, "outside VRF id %d",
2469                          &outside_vrf_id))
2470         ;
2471       else if (unformat (input, "inside VRF id %d",
2472                          &inside_vrf_id))
2473         ;
2474       else if (unformat (input, "static mapping only"))
2475         {
2476           static_mapping_only = 1;
2477           if (unformat (input, "connection tracking"))
2478             static_mapping_connection_tracking = 1;
2479         }
2480       else if (unformat (input, "deterministic"))
2481         sm->deterministic = 1;
2482       else if (unformat (input, "nat64 bib hash buckets %d",
2483                          &nat64_bib_buckets))
2484         ;
2485       else if (unformat (input, "nat64 bib hash memory %d",
2486                          &nat64_bib_memory_size))
2487         ;
2488       else if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
2489         ;
2490       else if (unformat (input, "nat64 st hash memory %d",
2491                          &nat64_st_memory_size))
2492         ;
2493       else if (unformat (input, "out2in dpo"))
2494         sm->out2in_dpo = 1;
2495       else if (unformat (input, "dslite ce"))
2496         dslite_set_ce(dm, 1);
2497       else
2498         return clib_error_return (0, "unknown input '%U'",
2499                                   format_unformat_error, input);
2500     }
2501
2502   /* for show commands, etc. */
2503   sm->translation_buckets = translation_buckets;
2504   sm->translation_memory_size = translation_memory_size;
2505   /* do not exceed load factor 10 */
2506   sm->max_translations = 10 * translation_buckets;
2507   sm->user_buckets = user_buckets;
2508   sm->user_memory_size = user_memory_size;
2509   sm->max_translations_per_user = max_translations_per_user;
2510   sm->outside_vrf_id = outside_vrf_id;
2511   sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2512                                                              outside_vrf_id,
2513                                                              FIB_SOURCE_PLUGIN_HI);
2514   sm->inside_vrf_id = inside_vrf_id;
2515   sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2516                                                             inside_vrf_id,
2517                                                             FIB_SOURCE_PLUGIN_HI);
2518   sm->static_mapping_only = static_mapping_only;
2519   sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
2520
2521   nat64_set_hash(nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
2522                  nat64_st_memory_size);
2523
2524   if (sm->deterministic)
2525     {
2526       sm->in2out_node_index = snat_det_in2out_node.index;
2527       sm->in2out_output_node_index = ~0;
2528       sm->out2in_node_index = snat_det_out2in_node.index;
2529       sm->icmp_match_in2out_cb = icmp_match_in2out_det;
2530       sm->icmp_match_out2in_cb = icmp_match_out2in_det;
2531     }
2532   else
2533     {
2534       sm->worker_in2out_cb = snat_get_worker_in2out_cb;
2535       sm->worker_out2in_cb = snat_get_worker_out2in_cb;
2536       sm->in2out_node_index = snat_in2out_node.index;
2537       sm->in2out_output_node_index = snat_in2out_output_node.index;
2538       sm->out2in_node_index = snat_out2in_node.index;
2539       if (!static_mapping_only ||
2540           (static_mapping_only && static_mapping_connection_tracking))
2541         {
2542           sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
2543           sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
2544
2545           vec_foreach (tsm, sm->per_thread_data)
2546             {
2547               clib_bihash_init_8_8 (&tsm->in2out, "in2out", translation_buckets,
2548                                     translation_memory_size);
2549
2550               clib_bihash_init_8_8 (&tsm->out2in, "out2in", translation_buckets,
2551                                     translation_memory_size);
2552
2553               clib_bihash_init_8_8 (&tsm->user_hash, "users", user_buckets,
2554                                     user_memory_size);
2555             }
2556
2557           clib_bihash_init_16_8 (&sm->in2out_ed, "in2out-ed",
2558                                  translation_buckets, translation_memory_size);
2559
2560           clib_bihash_init_16_8 (&sm->out2in_ed, "out2in-ed",
2561                                  translation_buckets, translation_memory_size);
2562         }
2563       else
2564         {
2565           sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
2566           sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
2567         }
2568       clib_bihash_init_8_8 (&sm->static_mapping_by_local,
2569                             "static_mapping_by_local", static_mapping_buckets,
2570                             static_mapping_memory_size);
2571
2572       clib_bihash_init_8_8 (&sm->static_mapping_by_external,
2573                             "static_mapping_by_external", static_mapping_buckets,
2574                             static_mapping_memory_size);
2575     }
2576
2577   return 0;
2578 }
2579
2580 VLIB_CONFIG_FUNCTION (snat_config, "nat");
2581
2582 u8 * format_snat_session_state (u8 * s, va_list * args)
2583 {
2584   u32 i = va_arg (*args, u32);
2585   u8 *t = 0;
2586
2587   switch (i)
2588     {
2589 #define _(v, N, str) case SNAT_SESSION_##N: t = (u8 *) str; break;
2590     foreach_snat_session_state
2591 #undef _
2592     default:
2593       t = format (t, "unknown");
2594     }
2595   s = format (s, "%s", t);
2596   return s;
2597 }
2598
2599 u8 * format_snat_key (u8 * s, va_list * args)
2600 {
2601   snat_session_key_t * key = va_arg (*args, snat_session_key_t *);
2602
2603   s = format (s, "%U proto %U port %d fib %d",
2604               format_ip4_address, &key->addr,
2605               format_snat_protocol, key->protocol,
2606               clib_net_to_host_u16 (key->port), key->fib_index);
2607   return s;
2608 }
2609
2610 u8 * format_snat_session (u8 * s, va_list * args)
2611 {
2612   snat_main_t * sm __attribute__((unused)) = va_arg (*args, snat_main_t *);
2613   snat_session_t * sess = va_arg (*args, snat_session_t *);
2614
2615   if (snat_is_unk_proto_session (sess))
2616     {
2617       s = format (s, "  i2o %U proto %u fib %u\n",
2618                   format_ip4_address, &sess->in2out.addr,
2619                   clib_net_to_host_u16 (sess->in2out.port),
2620                   sess->in2out.fib_index);
2621       s = format (s, "    o2i %U proto %u fib %u\n",
2622                   format_ip4_address, &sess->out2in.addr,
2623                   clib_net_to_host_u16 (sess->out2in.port),
2624                   sess->out2in.fib_index);
2625     }
2626   else
2627     {
2628       s = format (s, "  i2o %U\n", format_snat_key, &sess->in2out);
2629       s = format (s, "    o2i %U\n", format_snat_key, &sess->out2in);
2630     }
2631   if (is_twice_nat_session (sess))
2632     {
2633       s = format (s, "       external host o2i %U:%d i2o %U:%d\n",
2634                   format_ip4_address, &sess->ext_host_addr,
2635                   clib_net_to_host_u16 (sess->ext_host_port),
2636                   format_ip4_address, &sess->ext_host_nat_addr,
2637                   clib_net_to_host_u16 (sess->ext_host_nat_port));
2638     }
2639   else
2640     {
2641       if (sess->ext_host_addr.as_u32)
2642           s = format (s, "       external host %U\n",
2643                       format_ip4_address, &sess->ext_host_addr);
2644     }
2645   s = format (s, "       last heard %.2f\n", sess->last_heard);
2646   s = format (s, "       total pkts %d, total bytes %lld\n",
2647               sess->total_pkts, sess->total_bytes);
2648   if (snat_is_session_static (sess))
2649     s = format (s, "       static translation\n");
2650   else
2651     s = format (s, "       dynamic translation\n");
2652   if (sess->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
2653     s = format (s, "       load-balancing\n");
2654   if (is_twice_nat_session (sess))
2655     s = format (s, "       twice-nat\n");
2656
2657   return s;
2658 }
2659
2660 u8 * format_snat_user (u8 * s, va_list * args)
2661 {
2662   snat_main_per_thread_data_t * sm = va_arg (*args, snat_main_per_thread_data_t *);
2663   snat_user_t * u = va_arg (*args, snat_user_t *);
2664   int verbose = va_arg (*args, int);
2665   dlist_elt_t * head, * elt;
2666   u32 elt_index, head_index;
2667   u32 session_index;
2668   snat_session_t * sess;
2669
2670   s = format (s, "%U: %d dynamic translations, %d static translations\n",
2671               format_ip4_address, &u->addr, u->nsessions, u->nstaticsessions);
2672
2673   if (verbose == 0)
2674     return s;
2675
2676   if (u->nsessions || u->nstaticsessions)
2677     {
2678       head_index = u->sessions_per_user_list_head_index;
2679       head = pool_elt_at_index (sm->list_pool, head_index);
2680
2681       elt_index = head->next;
2682       elt = pool_elt_at_index (sm->list_pool, elt_index);
2683       session_index = elt->value;
2684
2685       while (session_index != ~0)
2686         {
2687           sess = pool_elt_at_index (sm->sessions, session_index);
2688
2689           s = format (s, "  %U\n", format_snat_session, sm, sess);
2690
2691           elt_index = elt->next;
2692           elt = pool_elt_at_index (sm->list_pool, elt_index);
2693           session_index = elt->value;
2694         }
2695     }
2696
2697   return s;
2698 }
2699
2700 u8 * format_snat_static_mapping (u8 * s, va_list * args)
2701 {
2702   snat_static_mapping_t *m = va_arg (*args, snat_static_mapping_t *);
2703   nat44_lb_addr_port_t *local;
2704
2705   if (m->addr_only)
2706       s = format (s, "local %U external %U vrf %d %s",
2707                   format_ip4_address, &m->local_addr,
2708                   format_ip4_address, &m->external_addr,
2709                   m->vrf_id, m->twice_nat ? "twice-nat" : "");
2710   else
2711    {
2712       if (vec_len (m->locals))
2713         {
2714           s = format (s, "%U vrf %d external %U:%d %s %s",
2715                       format_snat_protocol, m->proto,
2716                       m->vrf_id,
2717                       format_ip4_address, &m->external_addr, m->external_port,
2718                       m->twice_nat ? "twice-nat" : "",
2719                       m->out2in_only ? "out2in-only" : "");
2720           vec_foreach (local, m->locals)
2721             s = format (s, "\n  local %U:%d probability %d\%",
2722                         format_ip4_address, &local->addr, local->port,
2723                         local->probability);
2724         }
2725       else
2726         s = format (s, "%U local %U:%d external %U:%d vrf %d %s %s",
2727                     format_snat_protocol, m->proto,
2728                     format_ip4_address, &m->local_addr, m->local_port,
2729                     format_ip4_address, &m->external_addr, m->external_port,
2730                     m->vrf_id, m->twice_nat ? "twice-nat" : "",
2731                     m->out2in_only ? "out2in-only" : "");
2732    }
2733   return s;
2734 }
2735
2736 u8 * format_snat_static_map_to_resolve (u8 * s, va_list * args)
2737 {
2738   snat_static_map_resolve_t *m = va_arg (*args, snat_static_map_resolve_t *);
2739   vnet_main_t *vnm = vnet_get_main();
2740
2741   if (m->addr_only)
2742       s = format (s, "local %U external %U vrf %d",
2743                   format_ip4_address, &m->l_addr,
2744                   format_vnet_sw_if_index_name, vnm, m->sw_if_index,
2745                   m->vrf_id);
2746   else
2747       s = format (s, "%U local %U:%d external %U:%d vrf %d",
2748                   format_snat_protocol, m->proto,
2749                   format_ip4_address, &m->l_addr, m->l_port,
2750                   format_vnet_sw_if_index_name, vnm, m->sw_if_index,
2751                   m->e_port, m->vrf_id);
2752
2753   return s;
2754 }
2755
2756 u8 * format_det_map_ses (u8 * s, va_list * args)
2757 {
2758   snat_det_map_t * det_map = va_arg (*args, snat_det_map_t *);
2759   ip4_address_t in_addr, out_addr;
2760   u32 in_offset, out_offset;
2761   snat_det_session_t * ses = va_arg (*args, snat_det_session_t *);
2762   u32 * i = va_arg (*args, u32 *);
2763
2764   u32 user_index = *i / SNAT_DET_SES_PER_USER;
2765   in_addr.as_u32 = clib_host_to_net_u32 (
2766     clib_net_to_host_u32(det_map->in_addr.as_u32) + user_index);
2767   in_offset = clib_net_to_host_u32(in_addr.as_u32) -
2768     clib_net_to_host_u32(det_map->in_addr.as_u32);
2769   out_offset = in_offset / det_map->sharing_ratio;
2770   out_addr.as_u32 = clib_host_to_net_u32(
2771     clib_net_to_host_u32(det_map->out_addr.as_u32) + out_offset);
2772   s = format (s, "in %U:%d out %U:%d external host %U:%d state: %U expire: %d\n",
2773               format_ip4_address, &in_addr,
2774               clib_net_to_host_u16 (ses->in_port),
2775               format_ip4_address, &out_addr,
2776               clib_net_to_host_u16 (ses->out.out_port),
2777               format_ip4_address, &ses->out.ext_host_addr,
2778               clib_net_to_host_u16 (ses->out.ext_host_port),
2779               format_snat_session_state, ses->state,
2780               ses->expire);
2781
2782   return s;
2783 }
2784
2785 static void
2786 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
2787                                  uword opaque,
2788                                  u32 sw_if_index,
2789                                  ip4_address_t * address,
2790                                  u32 address_length,
2791                                  u32 if_address_index,
2792                                  u32 is_delete)
2793 {
2794   snat_main_t *sm = &snat_main;
2795   snat_static_map_resolve_t *rp;
2796   snat_static_mapping_t *m;
2797   snat_session_key_t m_key;
2798   clib_bihash_kv_8_8_t kv, value;
2799   int i, rv;
2800   ip4_address_t l_addr;
2801
2802   for (i = 0; i < vec_len (sm->to_resolve); i++)
2803     {
2804       rp = sm->to_resolve + i;
2805       if (rp->addr_only == 0)
2806         continue;
2807       if (rp->sw_if_index == sw_if_index)
2808         goto match;
2809     }
2810
2811   return;
2812
2813 match:
2814   m_key.addr.as_u32 = address->as_u32;
2815   m_key.port = rp->addr_only ? 0 : rp->e_port;
2816   m_key.protocol = rp->addr_only ? 0 : rp->proto;
2817   m_key.fib_index = sm->outside_fib_index;
2818   kv.key = m_key.as_u64;
2819   if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
2820     m = 0;
2821   else
2822     m = pool_elt_at_index (sm->static_mappings, value.value);
2823
2824   if (!is_delete)
2825     {
2826       /* Don't trip over lease renewal, static config */
2827       if (m)
2828         return;
2829     }
2830   else
2831     {
2832       if (!m)
2833         return;
2834     }
2835
2836   /* Indetity mapping? */
2837   if (rp->l_addr.as_u32 == 0)
2838     l_addr.as_u32 = address[0].as_u32;
2839   else
2840     l_addr.as_u32 = rp->l_addr.as_u32;
2841   /* Add the static mapping */
2842   rv = snat_add_static_mapping (l_addr,
2843                                 address[0],
2844                                 rp->l_port,
2845                                 rp->e_port,
2846                                 rp->vrf_id,
2847                                 rp->addr_only,
2848                                 ~0 /* sw_if_index */,
2849                                 rp->proto,
2850                                 !is_delete,
2851                                 0, 0, rp->tag);
2852   if (rv)
2853     clib_warning ("snat_add_static_mapping returned %d", rv);
2854 }
2855
2856 static void
2857 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2858                                        uword opaque,
2859                                        u32 sw_if_index,
2860                                        ip4_address_t * address,
2861                                        u32 address_length,
2862                                        u32 if_address_index,
2863                                        u32 is_delete)
2864 {
2865   snat_main_t *sm = &snat_main;
2866   snat_static_map_resolve_t *rp;
2867   ip4_address_t l_addr;
2868   int i, j;
2869   int rv;
2870   u8 twice_nat = 0;
2871   snat_address_t *addresses = sm->addresses;
2872
2873   for (i = 0; i < vec_len(sm->auto_add_sw_if_indices); i++)
2874     {
2875       if (sw_if_index == sm->auto_add_sw_if_indices[i])
2876           goto match;
2877     }
2878
2879   for (i = 0; i < vec_len(sm->auto_add_sw_if_indices_twice_nat); i++)
2880     {
2881       twice_nat = 1;
2882       addresses = sm->twice_nat_addresses;
2883       if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
2884           goto match;
2885     }
2886
2887   return;
2888
2889 match:
2890   if (!is_delete)
2891     {
2892       /* Don't trip over lease renewal, static config */
2893       for (j = 0; j < vec_len(addresses); j++)
2894         if (addresses[j].addr.as_u32 == address->as_u32)
2895           return;
2896
2897       snat_add_address (sm, address, ~0, twice_nat);
2898       /* Scan static map resolution vector */
2899       for (j = 0; j < vec_len (sm->to_resolve); j++)
2900         {
2901           rp = sm->to_resolve + j;
2902           if (rp->addr_only)
2903             continue;
2904           /* On this interface? */
2905           if (rp->sw_if_index == sw_if_index)
2906             {
2907               /* Indetity mapping? */
2908               if (rp->l_addr.as_u32 == 0)
2909                 l_addr.as_u32 = address[0].as_u32;
2910               else
2911                 l_addr.as_u32 = rp->l_addr.as_u32;
2912               /* Add the static mapping */
2913               rv = snat_add_static_mapping (l_addr,
2914                                             address[0],
2915                                             rp->l_port,
2916                                             rp->e_port,
2917                                             rp->vrf_id,
2918                                             rp->addr_only,
2919                                             ~0 /* sw_if_index */,
2920                                             rp->proto,
2921                                             rp->is_add,
2922                                             0, 0, rp->tag);
2923               if (rv)
2924                 clib_warning ("snat_add_static_mapping returned %d",
2925                               rv);
2926             }
2927         }
2928       return;
2929     }
2930   else
2931     {
2932       (void) snat_del_address(sm, address[0], 1, twice_nat);
2933       return;
2934     }
2935 }
2936
2937
2938 int snat_add_interface_address (snat_main_t *sm, u32 sw_if_index, int is_del,
2939                                 u8 twice_nat)
2940 {
2941   ip4_main_t * ip4_main = sm->ip4_main;
2942   ip4_address_t * first_int_addr;
2943   snat_static_map_resolve_t *rp;
2944   u32 *indices_to_delete = 0;
2945   int i, j;
2946   u32 *auto_add_sw_if_indices =
2947     twice_nat ? sm->auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
2948
2949   first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index,
2950                                                 0 /* just want the address*/);
2951
2952   for (i = 0; i < vec_len(auto_add_sw_if_indices); i++)
2953     {
2954       if (auto_add_sw_if_indices[i] == sw_if_index)
2955         {
2956           if (is_del)
2957             {
2958               /* if have address remove it */
2959               if (first_int_addr)
2960                   (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
2961               else
2962                 {
2963                   for (j = 0; j < vec_len (sm->to_resolve); j++)
2964                     {
2965                       rp = sm->to_resolve + j;
2966                       if (rp->sw_if_index == sw_if_index)
2967                         vec_add1 (indices_to_delete, j);
2968                     }
2969                   if (vec_len(indices_to_delete))
2970                     {
2971                       for (j = vec_len(indices_to_delete)-1; j >= 0; j--)
2972                         vec_del1(sm->to_resolve, j);
2973                       vec_free(indices_to_delete);
2974                     }
2975                 }
2976               if (twice_nat)
2977                 vec_del1(sm->auto_add_sw_if_indices_twice_nat, i);
2978               else
2979                 vec_del1(sm->auto_add_sw_if_indices, i);
2980             }
2981           else
2982             return VNET_API_ERROR_VALUE_EXIST;
2983
2984           return 0;
2985         }
2986     }
2987
2988   if (is_del)
2989     return VNET_API_ERROR_NO_SUCH_ENTRY;
2990
2991   /* add to the auto-address list */
2992   if (twice_nat)
2993     vec_add1(sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
2994   else
2995     vec_add1(sm->auto_add_sw_if_indices, sw_if_index);
2996
2997   /* If the address is already bound - or static - add it now */
2998   if (first_int_addr)
2999       snat_add_address (sm, first_int_addr, ~0, twice_nat);
3000
3001   return 0;
3002 }
3003
3004 int
3005 nat44_del_session (snat_main_t *sm, ip4_address_t *addr, u16 port,
3006                    snat_protocol_t proto, u32 vrf_id, int is_in)
3007 {
3008   snat_main_per_thread_data_t *tsm;
3009   clib_bihash_kv_8_8_t kv, value;
3010   ip4_header_t ip;
3011   u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3012   snat_session_key_t key;
3013   snat_session_t *s;
3014   clib_bihash_8_8_t *t;
3015   snat_user_key_t u_key;
3016   snat_user_t *u;
3017
3018   ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
3019   if (sm->num_workers > 1)
3020     tsm =
3021       vec_elt_at_index (sm->per_thread_data,
3022                         sm->worker_in2out_cb (&ip, fib_index));
3023   else
3024     tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
3025
3026   key.addr.as_u32 = addr->as_u32;
3027   key.port = clib_host_to_net_u16 (port);
3028   key.protocol = proto;
3029   key.fib_index = fib_index;
3030   kv.key = key.as_u64;
3031   t = is_in ? &tsm->in2out : &tsm->out2in;
3032   if (!clib_bihash_search_8_8 (t, &kv, &value))
3033     {
3034       s = pool_elt_at_index (tsm->sessions, value.value);
3035       kv.key = s->in2out.as_u64;
3036       clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0);
3037       kv.key = s->out2in.as_u64;
3038       clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0);
3039       u_key.addr = s->in2out.addr;
3040       u_key.fib_index = s->in2out.fib_index;
3041       kv.key = u_key.as_u64;
3042       if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
3043         {
3044           u = pool_elt_at_index (tsm->users, value.value);
3045           u->nsessions--;
3046         }
3047       clib_dlist_remove (tsm->list_pool, s->per_user_index);
3048       pool_put (tsm->sessions, s);
3049       return 0;
3050     }
3051
3052   return VNET_API_ERROR_NO_SUCH_ENTRY;
3053 }
3054
3055 void
3056 nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset, u16 psid_length)
3057 {
3058   snat_main_t *sm = &snat_main;
3059
3060   sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
3061   sm->psid = psid;
3062   sm->psid_offset = psid_offset;
3063   sm->psid_length = psid_length;
3064 }
3065
3066 void
3067 nat_set_alloc_addr_and_port_default (void)
3068 {
3069   snat_main_t *sm = &snat_main;
3070
3071   sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
3072 }
3073