2 * snat.c - simple nat plugin
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include <vnet/vnet.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/ip/ip4.h>
21 #include <vnet/plugin/plugin.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 <nat/nat_inlines.h>
31 #include <nat/nat_affinity.h>
32 #include <nat/nat_syslog.h>
33 #include <nat/nat_ha.h>
34 #include <vnet/fib/fib_table.h>
35 #include <vnet/fib/ip4_fib.h>
37 #include <vpp/app/version.h>
39 snat_main_t snat_main;
42 /* Hook up input features */
43 VNET_FEATURE_INIT (nat_pre_in2out, static) = {
44 .arc_name = "ip4-unicast",
45 .node_name = "nat-pre-in2out",
46 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
48 VNET_FEATURE_INIT (nat_pre_out2in, static) = {
49 .arc_name = "ip4-unicast",
50 .node_name = "nat-pre-out2in",
51 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
52 "ip4-dhcp-client-detect"),
54 VNET_FEATURE_INIT (snat_in2out_worker_handoff, static) = {
55 .arc_name = "ip4-unicast",
56 .node_name = "nat44-in2out-worker-handoff",
57 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
59 VNET_FEATURE_INIT (snat_out2in_worker_handoff, static) = {
60 .arc_name = "ip4-unicast",
61 .node_name = "nat44-out2in-worker-handoff",
62 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
63 "ip4-dhcp-client-detect"),
65 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
66 .arc_name = "ip4-unicast",
67 .node_name = "nat44-in2out",
68 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
70 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
71 .arc_name = "ip4-unicast",
72 .node_name = "nat44-out2in",
73 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
74 "ip4-dhcp-client-detect"),
76 VNET_FEATURE_INIT (ip4_nat_classify, static) = {
77 .arc_name = "ip4-unicast",
78 .node_name = "nat44-classify",
79 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
81 VNET_FEATURE_INIT (ip4_snat_det_in2out, static) = {
82 .arc_name = "ip4-unicast",
83 .node_name = "nat44-det-in2out",
84 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
86 VNET_FEATURE_INIT (ip4_snat_det_out2in, static) = {
87 .arc_name = "ip4-unicast",
88 .node_name = "nat44-det-out2in",
89 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
90 "ip4-dhcp-client-detect"),
92 VNET_FEATURE_INIT (ip4_nat_det_classify, static) = {
93 .arc_name = "ip4-unicast",
94 .node_name = "nat44-det-classify",
95 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
97 VNET_FEATURE_INIT (ip4_nat44_ed_in2out, static) = {
98 .arc_name = "ip4-unicast",
99 .node_name = "nat44-ed-in2out",
100 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
102 VNET_FEATURE_INIT (ip4_nat44_ed_out2in, static) = {
103 .arc_name = "ip4-unicast",
104 .node_name = "nat44-ed-out2in",
105 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
106 "ip4-dhcp-client-detect"),
108 VNET_FEATURE_INIT (ip4_nat44_ed_classify, static) = {
109 .arc_name = "ip4-unicast",
110 .node_name = "nat44-ed-classify",
111 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
113 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
114 .arc_name = "ip4-unicast",
115 .node_name = "nat44-handoff-classify",
116 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
118 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
119 .arc_name = "ip4-unicast",
120 .node_name = "nat44-in2out-fast",
121 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
123 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
124 .arc_name = "ip4-unicast",
125 .node_name = "nat44-out2in-fast",
126 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
127 "ip4-dhcp-client-detect"),
129 VNET_FEATURE_INIT (ip4_snat_hairpin_dst, static) = {
130 .arc_name = "ip4-unicast",
131 .node_name = "nat44-hairpin-dst",
132 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
134 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_dst, static) = {
135 .arc_name = "ip4-unicast",
136 .node_name = "nat44-ed-hairpin-dst",
137 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
140 /* Hook up output features */
141 VNET_FEATURE_INIT (ip4_snat_in2out_output, static) = {
142 .arc_name = "ip4-output",
143 .node_name = "nat44-in2out-output",
144 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
146 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
147 .arc_name = "ip4-output",
148 .node_name = "nat44-in2out-output-worker-handoff",
149 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
151 VNET_FEATURE_INIT (ip4_snat_hairpin_src, static) = {
152 .arc_name = "ip4-output",
153 .node_name = "nat44-hairpin-src",
154 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
156 VNET_FEATURE_INIT (ip4_nat44_ed_in2out_output, static) = {
157 .arc_name = "ip4-output",
158 .node_name = "nat44-ed-in2out-output",
159 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
161 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_src, static) = {
162 .arc_name = "ip4-output",
163 .node_name = "nat44-ed-hairpin-src",
164 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
167 /* Hook up ip4-local features */
168 VNET_FEATURE_INIT (ip4_nat_hairpinning, static) =
170 .arc_name = "ip4-local",
171 .node_name = "nat44-hairpinning",
172 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
174 VNET_FEATURE_INIT (ip4_nat44_ed_hairpinning, static) =
176 .arc_name = "ip4-local",
177 .node_name = "nat44-ed-hairpinning",
178 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
182 VLIB_PLUGIN_REGISTER () = {
183 .version = VPP_BUILD_VER,
184 .description = "Network Address Translation (NAT)",
189 nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index,
192 snat_session_key_t key;
193 clib_bihash_kv_8_8_t kv;
194 nat_ed_ses_key_t ed_key;
195 clib_bihash_kv_16_8_t ed_kv;
196 snat_main_per_thread_data_t *tsm =
197 vec_elt_at_index (sm->per_thread_data, thread_index);
199 if (is_fwd_bypass_session (s))
201 if (snat_is_unk_proto_session (s))
203 ed_key.proto = s->in2out.port;
209 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
210 ed_key.l_port = s->in2out.port;
211 ed_key.r_port = s->ext_host_port;
213 ed_key.l_addr = s->in2out.addr;
214 ed_key.r_addr = s->ext_host_addr;
215 ed_key.fib_index = 0;
216 ed_kv.key[0] = ed_key.as_u64[0];
217 ed_kv.key[1] = ed_key.as_u64[1];
218 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
219 nat_elog_warn ("in2out_ed key del failed");
223 /* session lookup tables */
224 if (is_ed_session (s))
226 if (is_affinity_sessions (s))
227 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
228 s->in2out.protocol, s->out2in.port);
229 ed_key.l_addr = s->out2in.addr;
230 ed_key.r_addr = s->ext_host_addr;
231 ed_key.fib_index = s->out2in.fib_index;
232 if (snat_is_unk_proto_session (s))
234 ed_key.proto = s->in2out.port;
240 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
241 ed_key.l_port = s->out2in.port;
242 ed_key.r_port = s->ext_host_port;
244 ed_kv.key[0] = ed_key.as_u64[0];
245 ed_kv.key[1] = ed_key.as_u64[1];
246 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &ed_kv, 0))
247 nat_elog_warn ("out2in_ed key del failed");
248 ed_key.l_addr = s->in2out.addr;
249 ed_key.fib_index = s->in2out.fib_index;
250 if (!snat_is_unk_proto_session (s))
251 ed_key.l_port = s->in2out.port;
252 if (is_twice_nat_session (s))
254 ed_key.r_addr = s->ext_host_nat_addr;
255 ed_key.r_port = s->ext_host_nat_port;
257 ed_kv.key[0] = ed_key.as_u64[0];
258 ed_kv.key[1] = ed_key.as_u64[1];
259 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
260 nat_elog_warn ("in2out_ed key del failed");
263 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
264 &s->in2out.addr, s->in2out.port,
265 &s->ext_host_nat_addr, s->ext_host_nat_port,
266 &s->out2in.addr, s->out2in.port,
267 &s->ext_host_addr, s->ext_host_port,
268 s->in2out.protocol, is_twice_nat_session (s));
272 kv.key = s->in2out.as_u64;
273 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0))
274 nat_elog_warn ("in2out key del failed");
275 kv.key = s->out2in.as_u64;
276 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0))
277 nat_elog_warn ("out2in key del failed");
280 nat_syslog_nat44_apmdel (s->user_index, s->in2out.fib_index,
281 &s->in2out.addr, s->in2out.port,
282 &s->out2in.addr, s->out2in.port,
286 if (snat_is_unk_proto_session (s))
292 snat_ipfix_logging_nat44_ses_delete (thread_index,
293 s->in2out.addr.as_u32,
294 s->out2in.addr.as_u32,
298 s->in2out.fib_index);
300 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
301 s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
305 /* Twice NAT address and port for external host */
306 if (is_twice_nat_session (s))
308 key.protocol = s->in2out.protocol;
309 key.port = s->ext_host_nat_port;
310 key.addr.as_u32 = s->ext_host_nat_addr.as_u32;
311 snat_free_outside_address_and_port (sm->twice_nat_addresses,
315 if (snat_is_session_static (s))
318 snat_free_outside_address_and_port (sm->addresses, thread_index,
323 nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr, u32 fib_index,
327 snat_user_key_t user_key;
328 clib_bihash_kv_8_8_t kv, value;
329 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
330 dlist_elt_t *per_user_list_head_elt;
332 user_key.addr.as_u32 = addr->as_u32;
333 user_key.fib_index = fib_index;
334 kv.key = user_key.as_u64;
336 /* Ever heard of the "user" = src ip4 address before? */
337 if (clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
339 /* no, make a new one */
340 pool_get (tsm->users, u);
341 clib_memset (u, 0, sizeof (*u));
342 u->addr.as_u32 = addr->as_u32;
343 u->fib_index = fib_index;
345 pool_get (tsm->list_pool, per_user_list_head_elt);
347 u->sessions_per_user_list_head_index = per_user_list_head_elt -
350 clib_dlist_init (tsm->list_pool, u->sessions_per_user_list_head_index);
352 kv.value = u - tsm->users;
355 if (clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 1))
356 nat_elog_warn ("user_hash keay add failed");
358 vlib_set_simple_counter (&sm->total_users, thread_index, 0,
359 pool_elts (tsm->users));
363 u = pool_elt_at_index (tsm->users, value.value);
370 nat_session_alloc_or_recycle (snat_main_t * sm, snat_user_t * u,
371 u32 thread_index, f64 now)
374 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
375 u32 oldest_per_user_translation_list_index, session_index;
376 dlist_elt_t *oldest_per_user_translation_list_elt;
377 dlist_elt_t *per_user_translation_list_elt;
379 /* Over quota? Recycle the least recently used translation */
380 if ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user)
382 oldest_per_user_translation_list_index =
383 clib_dlist_remove_head (tsm->list_pool,
384 u->sessions_per_user_list_head_index);
386 ASSERT (oldest_per_user_translation_list_index != ~0);
388 /* Add it back to the end of the LRU list */
389 clib_dlist_addtail (tsm->list_pool,
390 u->sessions_per_user_list_head_index,
391 oldest_per_user_translation_list_index);
392 /* Get the list element */
393 oldest_per_user_translation_list_elt =
394 pool_elt_at_index (tsm->list_pool,
395 oldest_per_user_translation_list_index);
397 /* Get the session index from the list element */
398 session_index = oldest_per_user_translation_list_elt->value;
400 /* Get the session */
401 s = pool_elt_at_index (tsm->sessions, session_index);
402 nat_free_session_data (sm, s, thread_index, 0);
403 if (snat_is_session_static (s))
404 u->nstaticsessions--;
411 s->ext_host_addr.as_u32 = 0;
412 s->ext_host_port = 0;
413 s->ext_host_nat_addr.as_u32 = 0;
414 s->ext_host_nat_port = 0;
418 pool_get (tsm->sessions, s);
419 clib_memset (s, 0, sizeof (*s));
421 /* Create list elts */
422 pool_get (tsm->list_pool, per_user_translation_list_elt);
423 clib_dlist_init (tsm->list_pool,
424 per_user_translation_list_elt - tsm->list_pool);
426 per_user_translation_list_elt->value = s - tsm->sessions;
427 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
428 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
430 clib_dlist_addtail (tsm->list_pool,
431 s->per_user_list_head_index,
432 per_user_translation_list_elt - tsm->list_pool);
434 s->user_index = u - tsm->users;
435 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
436 pool_elts (tsm->sessions));
439 s->ha_last_refreshed = now;
445 nat_ed_session_alloc (snat_main_t * sm, snat_user_t * u, u32 thread_index,
449 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
450 dlist_elt_t *per_user_translation_list_elt, *oldest_elt;
452 u64 sess_timeout_time;
454 if (PREDICT_FALSE (!(u->nsessions) && !(u->nstaticsessions)))
458 clib_dlist_remove_head (tsm->list_pool,
459 u->sessions_per_user_list_head_index);
460 oldest_elt = pool_elt_at_index (tsm->list_pool, oldest_index);
461 s = pool_elt_at_index (tsm->sessions, oldest_elt->value);
462 sess_timeout_time = s->last_heard + (f64) nat44_session_get_timeout (sm, s);
463 if (now >= sess_timeout_time)
465 clib_dlist_addtail (tsm->list_pool,
466 u->sessions_per_user_list_head_index, oldest_index);
467 nat_free_session_data (sm, s, thread_index, 0);
468 if (snat_is_session_static (s))
469 u->nstaticsessions--;
476 s->ext_host_addr.as_u32 = 0;
477 s->ext_host_port = 0;
478 s->ext_host_nat_addr.as_u32 = 0;
479 s->ext_host_nat_port = 0;
483 clib_dlist_addhead (tsm->list_pool,
484 u->sessions_per_user_list_head_index, oldest_index);
485 if ((u->nsessions + u->nstaticsessions) >=
486 sm->max_translations_per_user)
488 nat_elog_addr (SNAT_LOG_WARNING, "[warn] max translations per user",
489 clib_net_to_host_u32 (u->addr.as_u32));
490 snat_ipfix_logging_max_entries_per_user
491 (thread_index, sm->max_translations_per_user, u->addr.as_u32);
497 pool_get (tsm->sessions, s);
498 clib_memset (s, 0, sizeof (*s));
500 /* Create list elts */
501 pool_get (tsm->list_pool, per_user_translation_list_elt);
502 clib_dlist_init (tsm->list_pool,
503 per_user_translation_list_elt - tsm->list_pool);
505 per_user_translation_list_elt->value = s - tsm->sessions;
506 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
507 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
509 clib_dlist_addtail (tsm->list_pool,
510 s->per_user_list_head_index,
511 per_user_translation_list_elt - tsm->list_pool);
514 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
515 pool_elts (tsm->sessions));
518 s->ha_last_refreshed = now;
524 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
527 fib_prefix_t prefix = {
529 .fp_proto = FIB_PROTOCOL_IP4,
531 .ip4.as_u32 = addr->as_u32,
534 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
537 fib_table_entry_update_one_path (fib_index,
539 FIB_SOURCE_PLUGIN_LOW,
540 (FIB_ENTRY_FLAG_CONNECTED |
541 FIB_ENTRY_FLAG_LOCAL |
542 FIB_ENTRY_FLAG_EXCLUSIVE),
546 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
548 fib_table_entry_delete (fib_index, &prefix, FIB_SOURCE_PLUGIN_LOW);
552 snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
557 vlib_thread_main_t *tm = vlib_get_thread_main ();
559 if (twice_nat && !sm->endpoint_dependent)
560 return VNET_API_ERROR_FEATURE_DISABLED;
562 /* Check if address already exists */
564 vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
566 if (ap->addr.as_u32 == addr->as_u32)
567 return VNET_API_ERROR_VALUE_EXIST;
572 vec_add2 (sm->twice_nat_addresses, ap, 1);
574 vec_add2 (sm->addresses, ap, 1);
579 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
580 FIB_SOURCE_PLUGIN_LOW);
583 #define _(N, i, n, s) \
584 clib_bitmap_alloc (ap->busy_##n##_port_bitmap, 65535); \
585 ap->busy_##n##_ports = 0; \
586 ap->busy_##n##_ports_per_thread = 0;\
587 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
588 foreach_snat_protocol
593 /* Add external address to FIB */
595 pool_foreach (i, sm->interfaces,
597 if (nat_interface_is_inside(i) || sm->out2in_dpo)
600 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
603 pool_foreach (i, sm->output_feature_interfaces,
605 if (nat_interface_is_inside(i) || sm->out2in_dpo)
608 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
617 is_snat_address_used_in_static_mapping (snat_main_t * sm, ip4_address_t addr)
619 snat_static_mapping_t *m;
621 pool_foreach (m, sm->static_mappings,
623 if (is_addr_only_static_mapping (m) ||
624 is_out2in_only_static_mapping (m) ||
625 is_identity_static_mapping (m))
627 if (m->external_addr.as_u32 == addr.as_u32)
636 increment_v4_address (ip4_address_t * a)
640 v = clib_net_to_host_u32 (a->as_u32) + 1;
641 a->as_u32 = clib_host_to_net_u32 (v);
645 snat_add_static_mapping_when_resolved (snat_main_t * sm,
646 ip4_address_t l_addr,
651 snat_protocol_t proto,
652 int addr_only, int is_add, u8 * tag,
653 int twice_nat, int out2in_only,
656 snat_static_map_resolve_t *rp;
658 vec_add2 (sm->to_resolve, rp, 1);
659 rp->l_addr.as_u32 = l_addr.as_u32;
661 rp->sw_if_index = sw_if_index;
665 rp->addr_only = addr_only;
667 rp->twice_nat = twice_nat;
668 rp->out2in_only = out2in_only;
669 rp->identity_nat = identity_nat;
670 rp->tag = vec_dup (tag);
674 get_thread_idx_by_port (u16 e_port)
676 snat_main_t *sm = &snat_main;
677 u32 thread_idx = sm->num_workers;
678 if (sm->num_workers > 1)
681 sm->first_worker_index +
682 sm->workers[(e_port - 1024) / sm->port_per_thread];
688 snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
689 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
690 u32 sw_if_index, snat_protocol_t proto, int is_add,
691 twice_nat_type_t twice_nat, u8 out2in_only, u8 * tag,
694 snat_main_t *sm = &snat_main;
695 snat_static_mapping_t *m;
696 snat_session_key_t m_key;
697 clib_bihash_kv_8_8_t kv, value;
698 snat_address_t *a = 0;
700 snat_interface_t *interface;
702 snat_main_per_thread_data_t *tsm;
703 snat_user_key_t u_key;
705 dlist_elt_t *head, *elt;
706 u32 elt_index, head_index;
710 snat_static_map_resolve_t *rp, *rp_match = 0;
711 nat44_lb_addr_port_t *local;
714 if (!sm->endpoint_dependent)
716 if (twice_nat || out2in_only)
717 return VNET_API_ERROR_FEATURE_DISABLED;
720 /* If the external address is a specific interface address */
721 if (sw_if_index != ~0)
723 ip4_address_t *first_int_addr;
725 for (i = 0; i < vec_len (sm->to_resolve); i++)
727 rp = sm->to_resolve + i;
728 if (rp->sw_if_index != sw_if_index ||
729 rp->l_addr.as_u32 != l_addr.as_u32 ||
730 rp->vrf_id != vrf_id || rp->addr_only != addr_only)
735 if ((rp->l_port != l_port && rp->e_port != e_port)
736 || rp->proto != proto)
744 /* Might be already set... */
745 first_int_addr = ip4_interface_first_address
746 (sm->ip4_main, sw_if_index, 0 /* just want the address */ );
751 return VNET_API_ERROR_VALUE_EXIST;
753 snat_add_static_mapping_when_resolved
754 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
755 addr_only, is_add, tag, twice_nat, out2in_only, identity_nat);
757 /* DHCP resolution required? */
758 if (first_int_addr == 0)
764 e_addr.as_u32 = first_int_addr->as_u32;
765 /* Identity mapping? */
766 if (l_addr.as_u32 == 0)
767 l_addr.as_u32 = e_addr.as_u32;
773 return VNET_API_ERROR_NO_SUCH_ENTRY;
775 vec_del1 (sm->to_resolve, i);
779 e_addr.as_u32 = first_int_addr->as_u32;
780 /* Identity mapping? */
781 if (l_addr.as_u32 == 0)
782 l_addr.as_u32 = e_addr.as_u32;
790 m_key.port = addr_only ? 0 : e_port;
791 m_key.protocol = addr_only ? 0 : proto;
793 kv.key = m_key.as_u64;
794 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
797 m = pool_elt_at_index (sm->static_mappings, value.value);
803 if (is_identity_static_mapping (m))
806 pool_foreach (local, m->locals,
808 if (local->vrf_id == vrf_id)
809 return VNET_API_ERROR_VALUE_EXIST;
812 pool_get (m->locals, local);
813 local->vrf_id = vrf_id;
815 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
816 FIB_SOURCE_PLUGIN_LOW);
817 m_key.addr = m->local_addr;
818 m_key.port = m->local_port;
819 m_key.protocol = m->proto;
820 m_key.fib_index = local->fib_index;
821 kv.key = m_key.as_u64;
822 kv.value = m - sm->static_mappings;
823 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
827 return VNET_API_ERROR_VALUE_EXIST;
830 if (twice_nat && addr_only)
831 return VNET_API_ERROR_UNSUPPORTED;
833 /* Convert VRF id to FIB index */
836 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
837 FIB_SOURCE_PLUGIN_LOW);
838 /* If not specified use inside VRF id from SNAT plugin startup config */
841 fib_index = sm->inside_fib_index;
842 vrf_id = sm->inside_vrf_id;
843 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_PLUGIN_LOW);
846 if (!(out2in_only || identity_nat))
849 m_key.port = addr_only ? 0 : l_port;
850 m_key.protocol = addr_only ? 0 : proto;
851 m_key.fib_index = fib_index;
852 kv.key = m_key.as_u64;
853 if (!clib_bihash_search_8_8
854 (&sm->static_mapping_by_local, &kv, &value))
855 return VNET_API_ERROR_VALUE_EXIST;
858 /* Find external address in allocated addresses and reserve port for
859 address and port pair mapping when dynamic translations enabled */
860 if (!(addr_only || sm->static_mapping_only || out2in_only))
862 for (i = 0; i < vec_len (sm->addresses); i++)
864 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
866 a = sm->addresses + i;
867 /* External port must be unused */
870 #define _(N, j, n, s) \
871 case SNAT_PROTOCOL_##N: \
872 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
873 return VNET_API_ERROR_INVALID_VALUE; \
874 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
877 a->busy_##n##_ports++; \
878 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
881 foreach_snat_protocol
884 nat_elog_info ("unknown protocol");
885 return VNET_API_ERROR_INVALID_VALUE_2;
890 /* External address must be allocated */
891 if (!a && (l_addr.as_u32 != e_addr.as_u32))
893 if (sw_if_index != ~0)
895 for (i = 0; i < vec_len (sm->to_resolve); i++)
897 rp = sm->to_resolve + i;
900 if (rp->sw_if_index != sw_if_index &&
901 rp->l_addr.as_u32 != l_addr.as_u32 &&
902 rp->vrf_id != vrf_id && rp->l_port != l_port &&
903 rp->e_port != e_port && rp->proto != proto)
906 vec_del1 (sm->to_resolve, i);
910 return VNET_API_ERROR_NO_SUCH_ENTRY;
914 pool_get (sm->static_mappings, m);
915 clib_memset (m, 0, sizeof (*m));
916 m->tag = vec_dup (tag);
917 m->local_addr = l_addr;
918 m->external_addr = e_addr;
919 m->twice_nat = twice_nat;
921 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
923 m->flags |= NAT_STATIC_MAPPING_FLAG_ADDR_ONLY;
926 m->flags |= NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT;
927 pool_get (m->locals, local);
928 local->vrf_id = vrf_id;
929 local->fib_index = fib_index;
934 m->fib_index = fib_index;
938 m->local_port = l_port;
939 m->external_port = e_port;
943 if (sm->num_workers > 1)
946 .src_address = m->local_addr,
948 vec_add1 (m->workers, sm->worker_in2out_cb (&ip, m->fib_index, 0));
949 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
952 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
954 m_key.addr = m->local_addr;
955 m_key.port = m->local_port;
956 m_key.protocol = m->proto;
957 m_key.fib_index = fib_index;
958 kv.key = m_key.as_u64;
959 kv.value = m - sm->static_mappings;
961 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
963 m_key.addr = m->external_addr;
964 m_key.port = m->external_port;
966 kv.key = m_key.as_u64;
967 kv.value = m - sm->static_mappings;
968 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1);
970 /* Delete dynamic sessions matching local address (+ local port) */
971 if (!(sm->static_mapping_only))
973 u_key.addr = m->local_addr;
974 u_key.fib_index = m->fib_index;
975 kv.key = u_key.as_u64;
976 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
978 user_index = value.value;
979 u = pool_elt_at_index (tsm->users, user_index);
982 head_index = u->sessions_per_user_list_head_index;
983 head = pool_elt_at_index (tsm->list_pool, head_index);
984 elt_index = head->next;
985 elt = pool_elt_at_index (tsm->list_pool, elt_index);
986 ses_index = elt->value;
987 while (ses_index != ~0)
989 s = pool_elt_at_index (tsm->sessions, ses_index);
990 elt = pool_elt_at_index (tsm->list_pool, elt->next);
991 ses_index = elt->value;
993 if (snat_is_session_static (s))
997 && (clib_net_to_host_u16 (s->in2out.port) !=
1001 nat_free_session_data (sm, s,
1002 tsm - sm->per_thread_data, 0);
1003 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1005 if (!addr_only && !sm->endpoint_dependent)
1016 if (sw_if_index != ~0)
1019 return VNET_API_ERROR_NO_SUCH_ENTRY;
1025 vrf_id = sm->inside_vrf_id;
1028 pool_foreach (local, m->locals,
1030 if (local->vrf_id == vrf_id)
1031 find = local - m->locals;
1035 return VNET_API_ERROR_NO_SUCH_ENTRY;
1037 local = pool_elt_at_index (m->locals, find);
1038 fib_index = local->fib_index;
1039 pool_put (m->locals, local);
1042 fib_index = m->fib_index;
1044 /* Free external address port */
1045 if (!(addr_only || sm->static_mapping_only || out2in_only))
1047 for (i = 0; i < vec_len (sm->addresses); i++)
1049 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1051 a = sm->addresses + i;
1054 #define _(N, j, n, s) \
1055 case SNAT_PROTOCOL_##N: \
1056 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
1057 if (e_port > 1024) \
1059 a->busy_##n##_ports--; \
1060 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1063 foreach_snat_protocol
1066 nat_elog_info ("unknown protocol");
1067 return VNET_API_ERROR_INVALID_VALUE_2;
1074 if (sm->num_workers > 1)
1075 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1077 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1079 m_key.addr = m->local_addr;
1080 m_key.port = m->local_port;
1081 m_key.protocol = m->proto;
1082 m_key.fib_index = fib_index;
1083 kv.key = m_key.as_u64;
1085 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0);
1087 /* Delete session(s) for static mapping if exist */
1088 if (!(sm->static_mapping_only) ||
1089 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
1091 u_key.addr = m->local_addr;
1092 u_key.fib_index = fib_index;
1093 kv.key = u_key.as_u64;
1094 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1096 user_index = value.value;
1097 u = pool_elt_at_index (tsm->users, user_index);
1098 if (u->nstaticsessions)
1100 head_index = u->sessions_per_user_list_head_index;
1101 head = pool_elt_at_index (tsm->list_pool, head_index);
1102 elt_index = head->next;
1103 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1104 ses_index = elt->value;
1105 while (ses_index != ~0)
1107 s = pool_elt_at_index (tsm->sessions, ses_index);
1108 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1109 ses_index = elt->value;
1113 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
1114 (clib_net_to_host_u16 (s->out2in.port) !=
1119 if (is_lb_session (s))
1122 if (!snat_is_session_static (s))
1125 nat_free_session_data (sm, s,
1126 tsm - sm->per_thread_data, 0);
1127 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1129 if (!addr_only && !sm->endpoint_dependent)
1136 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_PLUGIN_LOW);
1137 if (pool_elts (m->locals))
1140 m_key.addr = m->external_addr;
1141 m_key.port = m->external_port;
1142 m_key.fib_index = 0;
1143 kv.key = m_key.as_u64;
1144 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0);
1147 vec_free (m->workers);
1148 /* Delete static mapping from pool */
1149 pool_put (sm->static_mappings, m);
1152 if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
1155 /* Add/delete external address to FIB */
1157 pool_foreach (interface, sm->interfaces,
1159 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1162 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1165 pool_foreach (interface, sm->output_feature_interfaces,
1167 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1170 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1179 nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1180 snat_protocol_t proto,
1181 nat44_lb_addr_port_t * locals, u8 is_add,
1182 twice_nat_type_t twice_nat, u8 out2in_only,
1183 u8 * tag, u32 affinity)
1185 snat_main_t *sm = &snat_main;
1186 snat_static_mapping_t *m;
1187 snat_session_key_t m_key;
1188 clib_bihash_kv_8_8_t kv, value;
1189 snat_address_t *a = 0;
1191 nat44_lb_addr_port_t *local;
1192 u32 elt_index, head_index, ses_index;
1193 snat_main_per_thread_data_t *tsm;
1194 snat_user_key_t u_key;
1197 dlist_elt_t *head, *elt;
1200 if (!sm->endpoint_dependent)
1201 return VNET_API_ERROR_FEATURE_DISABLED;
1203 m_key.addr = e_addr;
1204 m_key.port = e_port;
1205 m_key.protocol = proto;
1206 m_key.fib_index = 0;
1207 kv.key = m_key.as_u64;
1208 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1211 m = pool_elt_at_index (sm->static_mappings, value.value);
1216 return VNET_API_ERROR_VALUE_EXIST;
1218 if (vec_len (locals) < 2)
1219 return VNET_API_ERROR_INVALID_VALUE;
1221 /* Find external address in allocated addresses and reserve port for
1222 address and port pair mapping when dynamic translations enabled */
1223 if (!(sm->static_mapping_only || out2in_only))
1225 for (i = 0; i < vec_len (sm->addresses); i++)
1227 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1229 a = sm->addresses + i;
1230 /* External port must be unused */
1233 #define _(N, j, n, s) \
1234 case SNAT_PROTOCOL_##N: \
1235 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
1236 return VNET_API_ERROR_INVALID_VALUE; \
1237 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
1238 if (e_port > 1024) \
1240 a->busy_##n##_ports++; \
1241 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1244 foreach_snat_protocol
1247 nat_elog_info ("unknown protocol");
1248 return VNET_API_ERROR_INVALID_VALUE_2;
1253 /* External address must be allocated */
1255 return VNET_API_ERROR_NO_SUCH_ENTRY;
1258 pool_get (sm->static_mappings, m);
1259 clib_memset (m, 0, sizeof (*m));
1260 m->tag = vec_dup (tag);
1261 m->external_addr = e_addr;
1262 m->external_port = e_port;
1264 m->twice_nat = twice_nat;
1265 m->flags |= NAT_STATIC_MAPPING_FLAG_LB;
1267 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1268 m->affinity = affinity;
1271 m->affinity_per_service_list_head_index =
1272 nat_affinity_get_per_service_list_head_index ();
1274 m->affinity_per_service_list_head_index = ~0;
1276 m_key.addr = m->external_addr;
1277 m_key.port = m->external_port;
1278 m_key.protocol = m->proto;
1279 m_key.fib_index = 0;
1280 kv.key = m_key.as_u64;
1281 kv.value = m - sm->static_mappings;
1282 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1))
1284 nat_elog_err ("static_mapping_by_external key add failed");
1285 return VNET_API_ERROR_UNSPECIFIED;
1288 m_key.fib_index = m->fib_index;
1289 for (i = 0; i < vec_len (locals); i++)
1291 locals[i].fib_index =
1292 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
1294 FIB_SOURCE_PLUGIN_LOW);
1295 m_key.addr = locals[i].addr;
1296 m_key.fib_index = locals[i].fib_index;
1299 m_key.port = locals[i].port;
1300 kv.key = m_key.as_u64;
1301 kv.value = m - sm->static_mappings;
1302 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1304 locals[i].prefix = (i == 0) ? locals[i].probability :
1305 (locals[i - 1].prefix + locals[i].probability);
1306 pool_get (m->locals, local);
1308 if (sm->num_workers > 1)
1311 .src_address = locals[i].addr,
1314 clib_bitmap_set (bitmap,
1315 sm->worker_in2out_cb (&ip, m->fib_index, 0),
1320 /* Assign workers */
1321 if (sm->num_workers > 1)
1324 clib_bitmap_foreach (i, bitmap,
1326 vec_add1(m->workers, i);
1334 return VNET_API_ERROR_NO_SUCH_ENTRY;
1336 if (!is_lb_static_mapping (m))
1337 return VNET_API_ERROR_INVALID_VALUE;
1339 /* Free external address port */
1340 if (!(sm->static_mapping_only || out2in_only))
1342 for (i = 0; i < vec_len (sm->addresses); i++)
1344 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1346 a = sm->addresses + i;
1349 #define _(N, j, n, s) \
1350 case SNAT_PROTOCOL_##N: \
1351 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
1352 if (e_port > 1024) \
1354 a->busy_##n##_ports--; \
1355 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1358 foreach_snat_protocol
1361 nat_elog_info ("unknown protocol");
1362 return VNET_API_ERROR_INVALID_VALUE_2;
1369 m_key.addr = m->external_addr;
1370 m_key.port = m->external_port;
1371 m_key.protocol = m->proto;
1372 m_key.fib_index = 0;
1373 kv.key = m_key.as_u64;
1374 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0))
1376 nat_elog_err ("static_mapping_by_external key del failed");
1377 return VNET_API_ERROR_UNSPECIFIED;
1381 pool_foreach (local, m->locals,
1383 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4,
1384 FIB_SOURCE_PLUGIN_LOW);
1385 m_key.addr = local->addr;
1388 m_key.port = local->port;
1389 m_key.fib_index = local->fib_index;
1390 kv.key = m_key.as_u64;
1391 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1393 nat_elog_err ("static_mapping_by_local key del failed");
1394 return VNET_API_ERROR_UNSPECIFIED;
1398 if (sm->num_workers > 1)
1401 .src_address = local->addr,
1403 tsm = vec_elt_at_index (sm->per_thread_data,
1404 sm->worker_in2out_cb (&ip, m->fib_index, 0));
1407 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1409 /* Delete sessions */
1410 u_key.addr = local->addr;
1411 u_key.fib_index = local->fib_index;
1412 kv.key = u_key.as_u64;
1413 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1415 u = pool_elt_at_index (tsm->users, value.value);
1416 if (u->nstaticsessions)
1418 head_index = u->sessions_per_user_list_head_index;
1419 head = pool_elt_at_index (tsm->list_pool, head_index);
1420 elt_index = head->next;
1421 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1422 ses_index = elt->value;
1423 while (ses_index != ~0)
1425 s = pool_elt_at_index (tsm->sessions, ses_index);
1426 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1427 ses_index = elt->value;
1429 if (!(is_lb_session (s)))
1432 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1433 (clib_net_to_host_u16 (s->in2out.port) != local->port))
1436 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1437 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1444 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1445 pool_free (m->locals);
1447 vec_free (m->workers);
1449 pool_put (sm->static_mappings, m);
1456 nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1457 ip4_address_t l_addr, u16 l_port,
1458 snat_protocol_t proto, u32 vrf_id,
1459 u8 probability, u8 is_add)
1461 snat_main_t *sm = &snat_main;
1462 snat_static_mapping_t *m = 0;
1463 snat_session_key_t m_key;
1464 clib_bihash_kv_8_8_t kv, value;
1465 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1466 snat_main_per_thread_data_t *tsm;
1467 snat_user_key_t u_key;
1470 dlist_elt_t *head, *elt;
1471 u32 elt_index, head_index, ses_index, *locals = 0;
1475 if (!sm->endpoint_dependent)
1476 return VNET_API_ERROR_FEATURE_DISABLED;
1478 m_key.addr = e_addr;
1479 m_key.port = e_port;
1480 m_key.protocol = proto;
1481 m_key.fib_index = 0;
1482 kv.key = m_key.as_u64;
1483 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1484 m = pool_elt_at_index (sm->static_mappings, value.value);
1487 return VNET_API_ERROR_NO_SUCH_ENTRY;
1489 if (!is_lb_static_mapping (m))
1490 return VNET_API_ERROR_INVALID_VALUE;
1493 pool_foreach (local, m->locals,
1495 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1496 (local->vrf_id == vrf_id))
1498 match_local = local;
1507 return VNET_API_ERROR_VALUE_EXIST;
1509 pool_get (m->locals, local);
1510 clib_memset (local, 0, sizeof (*local));
1511 local->addr.as_u32 = l_addr.as_u32;
1512 local->port = l_port;
1513 local->probability = probability;
1514 local->vrf_id = vrf_id;
1516 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1517 FIB_SOURCE_PLUGIN_LOW);
1519 if (!is_out2in_only_static_mapping (m))
1521 m_key.addr = l_addr;
1522 m_key.port = l_port;
1523 m_key.fib_index = local->fib_index;
1524 kv.key = m_key.as_u64;
1525 kv.value = m - sm->static_mappings;
1526 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1))
1527 nat_elog_err ("static_mapping_by_local key add failed");
1533 return VNET_API_ERROR_NO_SUCH_ENTRY;
1535 if (pool_elts (m->locals) < 3)
1536 return VNET_API_ERROR_UNSPECIFIED;
1538 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1539 FIB_SOURCE_PLUGIN_LOW);
1541 if (!is_out2in_only_static_mapping (m))
1543 m_key.addr = l_addr;
1544 m_key.port = l_port;
1545 m_key.fib_index = match_local->fib_index;
1546 kv.key = m_key.as_u64;
1547 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0))
1548 nat_elog_err ("static_mapping_by_local key del failed");
1551 if (sm->num_workers > 1)
1554 .src_address = local->addr,
1556 tsm = vec_elt_at_index (sm->per_thread_data,
1557 sm->worker_in2out_cb (&ip, m->fib_index,
1561 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1563 /* Delete sessions */
1564 u_key.addr = match_local->addr;
1565 u_key.fib_index = match_local->fib_index;
1566 kv.key = u_key.as_u64;
1567 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1569 u = pool_elt_at_index (tsm->users, value.value);
1570 if (u->nstaticsessions)
1572 head_index = u->sessions_per_user_list_head_index;
1573 head = pool_elt_at_index (tsm->list_pool, head_index);
1574 elt_index = head->next;
1575 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1576 ses_index = elt->value;
1577 while (ses_index != ~0)
1579 s = pool_elt_at_index (tsm->sessions, ses_index);
1580 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1581 ses_index = elt->value;
1583 if (!(is_lb_session (s)))
1586 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1587 (clib_net_to_host_u16 (s->in2out.port) !=
1591 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1592 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1597 pool_put (m->locals, match_local);
1600 vec_free (m->workers);
1603 pool_foreach (local, m->locals,
1605 vec_add1 (locals, local - m->locals);
1606 if (sm->num_workers > 1)
1609 ip.src_address.as_u32 = local->addr.as_u32,
1610 bitmap = clib_bitmap_set (bitmap,
1611 sm->worker_in2out_cb (&ip, local->fib_index, 0),
1617 ASSERT (vec_len (locals) > 1);
1619 local = pool_elt_at_index (m->locals, locals[0]);
1620 local->prefix = local->probability;
1621 for (i = 1; i < vec_len (locals); i++)
1623 local = pool_elt_at_index (m->locals, locals[i]);
1624 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1625 local->prefix = local->probability + prev_local->prefix;
1628 /* Assign workers */
1629 if (sm->num_workers > 1)
1632 clib_bitmap_foreach (i, bitmap, ({ vec_add1(m->workers, i); }));
1640 snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1643 snat_address_t *a = 0;
1644 snat_session_t *ses;
1645 u32 *ses_to_be_removed = 0, *ses_index;
1646 snat_main_per_thread_data_t *tsm;
1647 snat_static_mapping_t *m;
1648 snat_interface_t *interface;
1650 snat_address_t *addresses =
1651 twice_nat ? sm->twice_nat_addresses : sm->addresses;
1653 /* Find SNAT address */
1654 for (i = 0; i < vec_len (addresses); i++)
1656 if (addresses[i].addr.as_u32 == addr.as_u32)
1663 return VNET_API_ERROR_NO_SUCH_ENTRY;
1668 pool_foreach (m, sm->static_mappings,
1670 if (m->external_addr.as_u32 == addr.as_u32)
1671 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1672 m->local_port, m->external_port,
1673 m->vrf_id, is_addr_only_static_mapping(m), ~0,
1674 m->proto, 0, m->twice_nat,
1675 is_out2in_only_static_mapping(m), m->tag, is_identity_static_mapping(m));
1681 /* Check if address is used in some static mapping */
1682 if (is_snat_address_used_in_static_mapping (sm, addr))
1684 nat_elog_notice ("address used in static mapping");
1685 return VNET_API_ERROR_UNSPECIFIED;
1689 if (a->fib_index != ~0)
1690 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_PLUGIN_LOW);
1692 /* Delete sessions using address */
1693 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1696 vec_foreach (tsm, sm->per_thread_data)
1698 pool_foreach (ses, tsm->sessions, ({
1699 if (ses->out2in.addr.as_u32 == addr.as_u32)
1701 nat_free_session_data (sm, ses, tsm - sm->per_thread_data, 0);
1702 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1706 vec_foreach (ses_index, ses_to_be_removed)
1708 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1709 nat44_delete_session (sm, ses, tsm - sm->per_thread_data);
1712 vec_free (ses_to_be_removed);
1717 #define _(N, i, n, s) \
1718 clib_bitmap_free (a->busy_##n##_port_bitmap); \
1719 vec_free (a->busy_##n##_ports_per_thread);
1720 foreach_snat_protocol
1724 vec_del1 (sm->twice_nat_addresses, i);
1728 vec_del1 (sm->addresses, i);
1730 /* Delete external address from FIB */
1732 pool_foreach (interface, sm->interfaces,
1734 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1737 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1740 pool_foreach (interface, sm->output_feature_interfaces,
1742 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1745 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1754 snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1756 snat_main_t *sm = &snat_main;
1757 snat_interface_t *i;
1758 const char *feature_name, *del_feature_name;
1760 snat_static_mapping_t *m;
1762 nat_outside_fib_t *outside_fib;
1763 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1766 if (sm->out2in_dpo && !is_inside)
1767 return VNET_API_ERROR_UNSUPPORTED;
1770 pool_foreach (i, sm->output_feature_interfaces,
1772 if (i->sw_if_index == sw_if_index)
1773 return VNET_API_ERROR_VALUE_EXIST;
1777 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1778 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1781 if (sm->num_workers > 1 && !sm->deterministic)
1783 is_inside ? "nat44-in2out-worker-handoff" :
1784 "nat44-out2in-worker-handoff";
1785 else if (sm->deterministic)
1786 feature_name = is_inside ? "nat44-det-in2out" : "nat44-det-out2in";
1787 else if (sm->endpoint_dependent)
1789 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1792 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1795 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1796 sm->fq_in2out_index =
1797 vlib_frame_queue_main_init (sm->handoff_in2out_index, NAT_FQ_NELTS);
1799 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1800 sm->fq_out2in_index =
1801 vlib_frame_queue_main_init (sm->handoff_out2in_index, NAT_FQ_NELTS);
1806 vec_foreach (outside_fib, sm->outside_fibs)
1808 if (outside_fib->fib_index == fib_index)
1812 outside_fib->refcount--;
1813 if (!outside_fib->refcount)
1814 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1817 outside_fib->refcount++;
1824 vec_add2 (sm->outside_fibs, outside_fib, 1);
1825 outside_fib->refcount = 1;
1826 outside_fib->fib_index = fib_index;
1831 pool_foreach (i, sm->interfaces,
1833 if (i->sw_if_index == sw_if_index)
1837 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1840 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1842 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1844 if (sm->num_workers > 1 && !sm->deterministic)
1846 del_feature_name = "nat44-handoff-classify";
1847 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1848 "nat44-out2in-worker-handoff";
1850 else if (sm->deterministic)
1852 del_feature_name = "nat44-det-classify";
1853 feature_name = !is_inside ? "nat44-det-in2out" :
1856 else if (sm->endpoint_dependent)
1858 del_feature_name = "nat44-ed-classify";
1859 feature_name = !is_inside ? "nat-pre-in2out" :
1864 del_feature_name = "nat44-classify";
1865 feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1868 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1869 sw_if_index, 0, 0, 0);
1870 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1871 sw_if_index, 1, 0, 0);
1874 if (sm->endpoint_dependent)
1875 vnet_feature_enable_disable ("ip4-local",
1876 "nat44-ed-hairpinning",
1877 sw_if_index, 1, 0, 0);
1878 else if (!sm->deterministic)
1879 vnet_feature_enable_disable ("ip4-local",
1880 "nat44-hairpinning",
1881 sw_if_index, 1, 0, 0);
1886 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1887 sw_if_index, 0, 0, 0);
1888 pool_put (sm->interfaces, i);
1891 if (sm->endpoint_dependent)
1892 vnet_feature_enable_disable ("ip4-local",
1893 "nat44-ed-hairpinning",
1894 sw_if_index, 0, 0, 0);
1895 else if (!sm->deterministic)
1896 vnet_feature_enable_disable ("ip4-local",
1897 "nat44-hairpinning",
1898 sw_if_index, 0, 0, 0);
1904 if ((nat_interface_is_inside(i) && is_inside) ||
1905 (nat_interface_is_outside(i) && !is_inside))
1908 if (sm->num_workers > 1 && !sm->deterministic)
1910 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1911 "nat44-out2in-worker-handoff";
1912 feature_name = "nat44-handoff-classify";
1914 else if (sm->deterministic)
1916 del_feature_name = !is_inside ? "nat44-det-in2out" :
1918 feature_name = "nat44-det-classify";
1920 else if (sm->endpoint_dependent)
1922 del_feature_name = !is_inside ? "nat-pre-in2out" :
1925 feature_name = "nat44-ed-classify";
1929 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1930 feature_name = "nat44-classify";
1933 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1934 sw_if_index, 0, 0, 0);
1935 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1936 sw_if_index, 1, 0, 0);
1939 if (sm->endpoint_dependent)
1940 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
1941 sw_if_index, 0, 0, 0);
1942 else if (!sm->deterministic)
1943 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1944 sw_if_index, 0, 0, 0);
1955 return VNET_API_ERROR_NO_SUCH_ENTRY;
1957 pool_get (sm->interfaces, i);
1958 i->sw_if_index = sw_if_index;
1960 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0,
1963 if (is_inside && !sm->out2in_dpo)
1965 if (sm->endpoint_dependent)
1966 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
1967 sw_if_index, 1, 0, 0);
1968 else if (!sm->deterministic)
1969 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1970 sw_if_index, 1, 0, 0);
1976 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1980 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1982 /* Add/delete external addresses to FIB */
1985 vec_foreach (ap, sm->addresses)
1986 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1988 pool_foreach (m, sm->static_mappings,
1990 if (!(is_addr_only_static_mapping(m)) || (m->local_addr.as_u32 == m->external_addr.as_u32))
1993 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1996 pool_foreach (dm, sm->det_maps,
1998 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
2006 snat_interface_add_del_output_feature (u32 sw_if_index,
2007 u8 is_inside, int is_del)
2009 snat_main_t *sm = &snat_main;
2010 snat_interface_t *i;
2012 snat_static_mapping_t *m;
2013 nat_outside_fib_t *outside_fib;
2014 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
2018 if (sm->deterministic ||
2019 (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
2020 return VNET_API_ERROR_UNSUPPORTED;
2023 pool_foreach (i, sm->interfaces,
2025 if (i->sw_if_index == sw_if_index)
2026 return VNET_API_ERROR_VALUE_EXIST;
2033 vec_foreach (outside_fib, sm->outside_fibs)
2035 if (outside_fib->fib_index == fib_index)
2039 outside_fib->refcount--;
2040 if (!outside_fib->refcount)
2041 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2044 outside_fib->refcount++;
2051 vec_add2 (sm->outside_fibs, outside_fib, 1);
2052 outside_fib->refcount = 1;
2053 outside_fib->fib_index = fib_index;
2060 if (sm->endpoint_dependent)
2062 vnet_feature_enable_disable ("ip4-unicast", "nat44-ed-hairpin-dst",
2063 sw_if_index, !is_del, 0, 0);
2064 vnet_feature_enable_disable ("ip4-output", "nat44-ed-hairpin-src",
2065 sw_if_index, !is_del, 0, 0);
2069 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
2070 sw_if_index, !is_del, 0, 0);
2071 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
2072 sw_if_index, !is_del, 0, 0);
2077 if (sm->num_workers > 1)
2079 vnet_feature_enable_disable ("ip4-unicast",
2080 "nat44-out2in-worker-handoff",
2081 sw_if_index, !is_del, 0, 0);
2082 vnet_feature_enable_disable ("ip4-output",
2083 "nat44-in2out-output-worker-handoff",
2084 sw_if_index, !is_del, 0, 0);
2088 if (sm->endpoint_dependent)
2090 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
2091 sw_if_index, !is_del, 0, 0);
2092 vnet_feature_enable_disable ("ip4-output", "nat44-ed-in2out-output",
2093 sw_if_index, !is_del, 0, 0);
2097 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in",
2098 sw_if_index, !is_del, 0, 0);
2099 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
2100 sw_if_index, !is_del, 0, 0);
2105 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
2106 sm->fq_in2out_output_index =
2107 vlib_frame_queue_main_init (sm->handoff_in2out_output_index, 0);
2109 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
2110 sm->fq_out2in_index =
2111 vlib_frame_queue_main_init (sm->handoff_out2in_index, 0);
2114 pool_foreach (i, sm->output_feature_interfaces,
2116 if (i->sw_if_index == sw_if_index)
2119 pool_put (sm->output_feature_interfaces, i);
2121 return VNET_API_ERROR_VALUE_EXIST;
2129 return VNET_API_ERROR_NO_SUCH_ENTRY;
2131 pool_get (sm->output_feature_interfaces, i);
2132 i->sw_if_index = sw_if_index;
2135 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2137 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2139 /* Add/delete external addresses to FIB */
2145 vec_foreach (ap, sm->addresses)
2146 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2148 pool_foreach (m, sm->static_mappings,
2150 if (!((is_addr_only_static_mapping(m))) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2153 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2161 snat_set_workers (uword * bitmap)
2163 snat_main_t *sm = &snat_main;
2166 if (sm->num_workers < 2)
2167 return VNET_API_ERROR_FEATURE_DISABLED;
2169 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2170 return VNET_API_ERROR_INVALID_WORKER;
2172 vec_free (sm->workers);
2174 clib_bitmap_foreach (i, bitmap,
2176 vec_add1(sm->workers, i);
2177 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2178 sm->per_thread_data[sm->first_worker_index + i].thread_index = i;
2183 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
2184 sm->num_snat_thread = _vec_len (sm->workers);
2190 snat_update_outside_fib (u32 sw_if_index, u32 new_fib_index,
2193 snat_main_t *sm = &snat_main;
2194 nat_outside_fib_t *outside_fib;
2195 snat_interface_t *i;
2199 if (new_fib_index == old_fib_index)
2202 if (!vec_len (sm->outside_fibs))
2206 pool_foreach (i, sm->interfaces,
2208 if (i->sw_if_index == sw_if_index)
2210 if (!(nat_interface_is_outside (i)))
2216 pool_foreach (i, sm->output_feature_interfaces,
2218 if (i->sw_if_index == sw_if_index)
2220 if (!(nat_interface_is_outside (i)))
2230 vec_foreach (outside_fib, sm->outside_fibs)
2232 if (outside_fib->fib_index == old_fib_index)
2234 outside_fib->refcount--;
2235 if (!outside_fib->refcount)
2236 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2241 vec_foreach (outside_fib, sm->outside_fibs)
2243 if (outside_fib->fib_index == new_fib_index)
2245 outside_fib->refcount++;
2253 vec_add2 (sm->outside_fibs, outside_fib, 1);
2254 outside_fib->refcount = 1;
2255 outside_fib->fib_index = new_fib_index;
2260 snat_ip4_table_bind (ip4_main_t * im,
2262 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
2264 snat_update_outside_fib (sw_if_index, new_fib_index, old_fib_index);
2268 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2271 ip4_address_t * address,
2273 u32 if_address_index, u32 is_delete);
2276 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
2279 ip4_address_t * address,
2281 u32 if_address_index, u32 is_delete);
2284 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2287 snat_session_key_t * k,
2288 u16 port_per_thread, u32 snat_thread_index);
2290 static clib_error_t *
2291 snat_init (vlib_main_t * vm)
2293 snat_main_t *sm = &snat_main;
2294 clib_error_t *error = 0;
2295 ip4_main_t *im = &ip4_main;
2296 ip_lookup_main_t *lm = &im->lookup_main;
2298 vlib_thread_registration_t *tr;
2299 vlib_thread_main_t *tm = vlib_get_thread_main ();
2302 ip4_add_del_interface_address_callback_t cb4;
2306 sm->vnet_main = vnet_get_main ();
2308 sm->ip4_lookup_main = lm;
2309 sm->api_main = &api_main;
2310 sm->first_worker_index = 0;
2311 sm->num_workers = 0;
2312 sm->num_snat_thread = 1;
2314 sm->port_per_thread = 0xffff - 1024;
2315 sm->fq_in2out_index = ~0;
2316 sm->fq_in2out_output_index = ~0;
2317 sm->fq_out2in_index = ~0;
2318 sm->udp_timeout = SNAT_UDP_TIMEOUT;
2319 sm->tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
2320 sm->tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
2321 sm->icmp_timeout = SNAT_ICMP_TIMEOUT;
2322 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
2323 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
2324 sm->forwarding_enabled = 0;
2325 sm->log_class = vlib_log_register_class ("nat", 0);
2326 sm->log_level = SNAT_LOG_ERROR;
2327 sm->mss_clamping = 0;
2329 node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
2330 sm->error_node_index = node->index;
2332 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2333 sm->pre_in2out_node_index = node->index;
2334 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2335 sm->pre_out2in_node_index = node->index;
2337 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2338 sm->pre_in2out_node_index = node->index;
2340 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2341 sm->pre_out2in_node_index = node->index;
2343 // TODO: output ?? (special node)
2345 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out");
2346 sm->in2out_node_index = node->index;
2347 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output");
2348 sm->in2out_output_node_index = node->index;
2349 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-fast");
2350 sm->in2out_fast_node_index = node->index;
2351 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-slowpath");
2352 sm->in2out_slowpath_node_index = node->index;
2353 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output-slowpath");
2354 sm->in2out_slowpath_output_node_index = node->index;
2355 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-reass");
2356 sm->in2out_reass_node_index = node->index;
2358 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out");
2359 sm->ed_in2out_node_index = node->index;
2360 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-slowpath");
2361 sm->ed_in2out_slowpath_node_index = node->index;
2362 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-reass");
2363 sm->ed_in2out_reass_node_index = node->index;
2365 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in");
2366 sm->out2in_node_index = node->index;
2367 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in-fast");
2368 sm->out2in_fast_node_index = node->index;
2369 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in-reass");
2370 sm->out2in_reass_node_index = node->index;
2372 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in");
2373 sm->ed_out2in_node_index = node->index;
2374 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in-slowpath");
2375 sm->ed_out2in_slowpath_node_index = node->index;
2376 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in-reass");
2377 sm->ed_out2in_reass_node_index = node->index;
2379 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-in2out");
2380 sm->det_in2out_node_index = node->index;
2381 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-out2in");
2382 sm->det_out2in_node_index = node->index;
2384 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpinning");
2385 sm->hairpinning_node_index = node->index;
2386 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-dst");
2387 sm->hairpin_dst_node_index = node->index;
2388 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-src");
2389 sm->hairpin_src_node_index = node->index;
2390 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpinning");
2391 sm->ed_hairpinning_node_index = node->index;
2392 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-dst");
2393 sm->ed_hairpin_dst_node_index = node->index;
2394 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-src");
2395 sm->ed_hairpin_src_node_index = node->index;
2397 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2400 tr = (vlib_thread_registration_t *) p[0];
2403 sm->num_workers = tr->count;
2404 sm->first_worker_index = tr->first_index;
2408 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2410 /* Use all available workers by default */
2411 if (sm->num_workers > 1)
2413 for (i = 0; i < sm->num_workers; i++)
2414 bitmap = clib_bitmap_set (bitmap, i, 1);
2415 snat_set_workers (bitmap);
2416 clib_bitmap_free (bitmap);
2420 sm->per_thread_data[0].snat_thread_index = 0;
2423 error = snat_api_init (vm, sm);
2427 /* Set up the interface address add/del callback */
2428 cb4.function = snat_ip4_add_del_interface_address_cb;
2429 cb4.function_opaque = 0;
2431 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2433 cb4.function = nat_ip4_add_del_addr_only_sm_cb;
2434 cb4.function_opaque = 0;
2436 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2438 nat_dpo_module_init ();
2441 sm->total_users.name = "total-users";
2442 sm->total_users.stat_segment_name = "/nat44/total-users";
2443 vlib_validate_simple_counter (&sm->total_users, 0);
2444 vlib_zero_simple_counter (&sm->total_users, 0);
2445 sm->total_sessions.name = "total-sessions";
2446 sm->total_sessions.stat_segment_name = "/nat44/total-sessions";
2447 vlib_validate_simple_counter (&sm->total_sessions, 0);
2448 vlib_zero_simple_counter (&sm->total_sessions, 0);
2450 /* Init IPFIX logging */
2451 snat_ipfix_logging_init (vm);
2454 error = nat64_init (vm);
2462 ip4_table_bind_callback_t cbt4 = {
2463 .function = snat_ip4_table_bind,
2465 vec_add1 (ip4_main.table_bind_callbacks, cbt4);
2467 /* Init virtual fragmenentation reassembly */
2468 return nat_reass_init (vm);
2471 VLIB_INIT_FUNCTION (snat_init);
2474 snat_free_outside_address_and_port (snat_address_t * addresses,
2475 u32 thread_index, snat_session_key_t * k)
2479 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2481 for (address_index = 0; address_index < vec_len (addresses);
2484 if (addresses[address_index].addr.as_u32 == k->addr.as_u32)
2488 ASSERT (address_index < vec_len (addresses));
2490 a = addresses + address_index;
2492 switch (k->protocol)
2494 #define _(N, i, n, s) \
2495 case SNAT_PROTOCOL_##N: \
2496 ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
2497 port_host_byte_order) == 1); \
2498 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
2499 port_host_byte_order, 0); \
2500 a->busy_##n##_ports--; \
2501 a->busy_##n##_ports_per_thread[thread_index]--; \
2503 foreach_snat_protocol
2506 nat_elog_info ("unknown protocol");
2512 nat_set_outside_address_and_port (snat_address_t * addresses,
2513 u32 thread_index, snat_session_key_t * k)
2515 snat_address_t *a = 0;
2517 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2519 for (address_index = 0; address_index < vec_len (addresses);
2522 if (addresses[address_index].addr.as_u32 != k->addr.as_u32)
2525 a = addresses + address_index;
2526 switch (k->protocol)
2528 #define _(N, j, n, s) \
2529 case SNAT_PROTOCOL_##N: \
2530 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, port_host_byte_order)) \
2531 return VNET_API_ERROR_INSTANCE_IN_USE; \
2532 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, port_host_byte_order, 1); \
2533 a->busy_##n##_ports_per_thread[thread_index]++; \
2534 a->busy_##n##_ports++; \
2536 foreach_snat_protocol
2539 nat_elog_info ("unknown protocol");
2544 return VNET_API_ERROR_NO_SUCH_ENTRY;
2548 snat_static_mapping_match (snat_main_t * sm,
2549 snat_session_key_t match,
2550 snat_session_key_t * mapping,
2553 twice_nat_type_t * twice_nat,
2554 lb_nat_type_t * lb, ip4_address_t * ext_host_addr,
2555 u8 * is_identity_nat)
2557 clib_bihash_kv_8_8_t kv, value;
2558 snat_static_mapping_t *m;
2559 snat_session_key_t m_key;
2560 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
2561 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2563 nat44_lb_addr_port_t *local;
2565 m_key.fib_index = match.fib_index;
2568 mapping_hash = &sm->static_mapping_by_external;
2569 m_key.fib_index = 0;
2572 m_key.addr = match.addr;
2573 m_key.port = clib_net_to_host_u16 (match.port);
2574 m_key.protocol = match.protocol;
2576 kv.key = m_key.as_u64;
2578 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2580 /* Try address only mapping */
2583 kv.key = m_key.as_u64;
2584 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2588 m = pool_elt_at_index (sm->static_mappings, value.value);
2592 if (is_lb_static_mapping (m))
2594 if (PREDICT_FALSE (lb != 0))
2595 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2596 if (m->affinity && !nat_affinity_find_and_lock (ext_host_addr[0],
2602 local = pool_elt_at_index (m->locals, backend_index);
2603 mapping->addr = local->addr;
2604 mapping->port = clib_host_to_net_u16 (local->port);
2605 mapping->fib_index = local->fib_index;
2608 // pick locals matching this worker
2609 if (PREDICT_FALSE (sm->num_workers > 1))
2611 u32 thread_index = vlib_get_thread_index ();
2613 pool_foreach_index (i, m->locals,
2615 local = pool_elt_at_index (m->locals, i);
2618 .src_address = local->addr,
2621 if (sm->worker_in2out_cb (&ip, m->fib_index, 0) ==
2628 ASSERT (vec_len (tmp) != 0);
2633 pool_foreach_index (i, m->locals,
2639 hi = vec_len (tmp) - 1;
2640 local = pool_elt_at_index (m->locals, tmp[hi]);
2641 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2644 mid = ((hi - lo) >> 1) + lo;
2645 local = pool_elt_at_index (m->locals, tmp[mid]);
2646 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2648 local = pool_elt_at_index (m->locals, tmp[lo]);
2649 if (!(local->prefix >= rand))
2651 mapping->addr = local->addr;
2652 mapping->port = clib_host_to_net_u16 (local->port);
2653 mapping->fib_index = local->fib_index;
2656 if (nat_affinity_create_and_lock (ext_host_addr[0], match.addr,
2657 match.protocol, match.port,
2658 tmp[lo], m->affinity,
2659 m->affinity_per_service_list_head_index))
2660 nat_elog_info ("create affinity record failed");
2666 if (PREDICT_FALSE (lb != 0))
2668 mapping->fib_index = m->fib_index;
2669 mapping->addr = m->local_addr;
2670 /* Address only mapping doesn't change port */
2671 mapping->port = is_addr_only_static_mapping (m) ? match.port
2672 : clib_host_to_net_u16 (m->local_port);
2674 mapping->protocol = m->proto;
2678 mapping->addr = m->external_addr;
2679 /* Address only mapping doesn't change port */
2680 mapping->port = is_addr_only_static_mapping (m) ? match.port
2681 : clib_host_to_net_u16 (m->external_port);
2682 mapping->fib_index = sm->outside_fib_index;
2686 if (PREDICT_FALSE (is_addr_only != 0))
2687 *is_addr_only = is_addr_only_static_mapping (m);
2689 if (PREDICT_FALSE (twice_nat != 0))
2690 *twice_nat = m->twice_nat;
2692 if (PREDICT_FALSE (is_identity_nat != 0))
2693 *is_identity_nat = is_identity_static_mapping (m);
2698 static_always_inline u16
2699 snat_random_port (u16 min, u16 max)
2701 snat_main_t *sm = &snat_main;
2702 return min + random_u32 (&sm->random_seed) /
2703 (random_u32_max () / (max - min + 1) + 1);
2707 snat_alloc_outside_address_and_port (snat_address_t * addresses,
2710 snat_session_key_t * k,
2711 u16 port_per_thread,
2712 u32 snat_thread_index)
2714 snat_main_t *sm = &snat_main;
2716 return sm->alloc_addr_and_port (addresses, fib_index, thread_index, k,
2717 port_per_thread, snat_thread_index);
2721 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2724 snat_session_key_t * k,
2725 u16 port_per_thread, u32 snat_thread_index)
2728 snat_address_t *a, *ga = 0;
2731 for (i = 0; i < vec_len (addresses); i++)
2734 switch (k->protocol)
2736 #define _(N, j, n, s) \
2737 case SNAT_PROTOCOL_##N: \
2738 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
2740 if (a->fib_index == fib_index) \
2744 portnum = (port_per_thread * \
2745 snat_thread_index) + \
2746 snat_random_port(1, port_per_thread) + 1024; \
2747 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2749 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2750 a->busy_##n##_ports_per_thread[thread_index]++; \
2751 a->busy_##n##_ports++; \
2752 k->addr = a->addr; \
2753 k->port = clib_host_to_net_u16(portnum); \
2757 else if (a->fib_index == ~0) \
2763 foreach_snat_protocol
2766 nat_elog_info ("unknown protocol");
2775 switch (k->protocol)
2777 #define _(N, j, n, s) \
2778 case SNAT_PROTOCOL_##N: \
2781 portnum = (port_per_thread * \
2782 snat_thread_index) + \
2783 snat_random_port(1, port_per_thread) + 1024; \
2784 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2786 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2787 a->busy_##n##_ports_per_thread[thread_index]++; \
2788 a->busy_##n##_ports++; \
2789 k->addr = a->addr; \
2790 k->port = clib_host_to_net_u16(portnum); \
2794 foreach_snat_protocol
2797 nat_elog_info ("unknown protocol");
2802 /* Totally out of translations to use... */
2803 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
2808 nat_alloc_addr_and_port_mape (snat_address_t * addresses,
2811 snat_session_key_t * k,
2812 u16 port_per_thread, u32 snat_thread_index)
2814 snat_main_t *sm = &snat_main;
2815 snat_address_t *a = addresses;
2816 u16 m, ports, portnum, A, j;
2817 m = 16 - (sm->psid_offset + sm->psid_length);
2818 ports = (1 << (16 - sm->psid_length)) - (1 << m);
2820 if (!vec_len (addresses))
2823 switch (k->protocol)
2825 #define _(N, i, n, s) \
2826 case SNAT_PROTOCOL_##N: \
2827 if (a->busy_##n##_ports < ports) \
2831 A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
2832 j = snat_random_port(0, pow2_mask(m)); \
2833 portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
2834 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2836 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2837 a->busy_##n##_ports++; \
2838 k->addr = a->addr; \
2839 k->port = clib_host_to_net_u16 (portnum); \
2844 foreach_snat_protocol
2847 nat_elog_info ("unknown protocol");
2852 /* Totally out of translations to use... */
2853 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
2858 nat_alloc_addr_and_port_range (snat_address_t * addresses,
2861 snat_session_key_t * k,
2862 u16 port_per_thread, u32 snat_thread_index)
2864 snat_main_t *sm = &snat_main;
2865 snat_address_t *a = addresses;
2868 ports = sm->end_port - sm->start_port + 1;
2870 if (!vec_len (addresses))
2873 switch (k->protocol)
2875 #define _(N, i, n, s) \
2876 case SNAT_PROTOCOL_##N: \
2877 if (a->busy_##n##_ports < ports) \
2881 portnum = snat_random_port(sm->start_port, sm->end_port); \
2882 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2884 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2885 a->busy_##n##_ports++; \
2886 k->addr = a->addr; \
2887 k->port = clib_host_to_net_u16 (portnum); \
2892 foreach_snat_protocol
2895 nat_elog_info ("unknown protocol");
2900 /* Totally out of translations to use... */
2901 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
2906 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
2908 dpo_id_t dpo_v4 = DPO_INVALID;
2909 fib_prefix_t pfx = {
2910 .fp_proto = FIB_PROTOCOL_IP4,
2912 .fp_addr.ip4.as_u32 = addr.as_u32,
2917 nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
2918 fib_table_entry_special_dpo_add (0, &pfx, FIB_SOURCE_PLUGIN_HI,
2919 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
2920 dpo_reset (&dpo_v4);
2924 fib_table_entry_special_remove (0, &pfx, FIB_SOURCE_PLUGIN_HI);
2929 format_session_kvp (u8 * s, va_list * args)
2931 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
2932 snat_session_key_t k;
2936 s = format (s, "%U session-index %llu", format_snat_key, &k, v->value);
2942 format_static_mapping_kvp (u8 * s, va_list * args)
2944 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
2945 snat_session_key_t k;
2949 s = format (s, "%U static-mapping-index %llu",
2950 format_static_mapping_key, &k, v->value);
2956 format_user_kvp (u8 * s, va_list * args)
2958 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
2963 s = format (s, "%U fib %d user-index %llu", format_ip4_address, &k.addr,
2964 k.fib_index, v->value);
2970 format_ed_session_kvp (u8 * s, va_list * args)
2972 clib_bihash_kv_16_8_t *v = va_arg (*args, clib_bihash_kv_16_8_t *);
2975 k.as_u64[0] = v->key[0];
2976 k.as_u64[1] = v->key[1];
2979 format (s, "local %U:%d remote %U:%d proto %U fib %d session-index %llu",
2980 format_ip4_address, &k.l_addr, clib_net_to_host_u16 (k.l_port),
2981 format_ip4_address, &k.r_addr, clib_net_to_host_u16 (k.r_port),
2982 format_ip_protocol, k.proto, k.fib_index, v->value);
2988 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0,
2991 snat_main_t *sm = &snat_main;
2992 u32 next_worker_index = 0;
2995 next_worker_index = sm->first_worker_index;
2996 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
2997 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >> 24);
2999 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3000 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3002 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3004 return next_worker_index;
3008 snat_get_worker_out2in_cb (ip4_header_t * ip0, u32 rx_fib_index0,
3011 snat_main_t *sm = &snat_main;
3014 snat_session_key_t m_key;
3015 clib_bihash_kv_8_8_t kv, value;
3016 snat_static_mapping_t *m;
3018 u32 next_worker_index = 0;
3020 /* first try static mappings without port */
3021 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3023 m_key.addr = ip0->dst_address;
3026 m_key.fib_index = rx_fib_index0;
3027 kv.key = m_key.as_u64;
3028 if (!clib_bihash_search_8_8
3029 (&sm->static_mapping_by_external, &kv, &value))
3031 m = pool_elt_at_index (sm->static_mappings, value.value);
3032 return m->workers[0];
3036 proto = ip_proto_to_snat_proto (ip0->protocol);
3037 udp = ip4_next_header (ip0);
3038 port = udp->dst_port;
3040 if (PREDICT_FALSE (ip4_is_fragment (ip0)))
3042 if (PREDICT_FALSE (nat_reass_is_drop_frag (0)))
3043 return vlib_get_thread_index ();
3045 nat_reass_ip4_t *reass;
3046 reass = nat_ip4_reass_find (ip0->src_address, ip0->dst_address,
3047 ip0->fragment_id, ip0->protocol);
3049 if (reass && (reass->thread_index != (u32) ~ 0))
3050 return reass->thread_index;
3052 if (ip4_is_first_fragment (ip0))
3055 nat_ip4_reass_create (ip0->src_address, ip0->dst_address,
3056 ip0->fragment_id, ip0->protocol);
3060 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3062 m_key.addr = ip0->dst_address;
3063 m_key.port = clib_net_to_host_u16 (port);
3064 m_key.protocol = proto;
3065 m_key.fib_index = rx_fib_index0;
3066 kv.key = m_key.as_u64;
3067 if (!clib_bihash_search_8_8
3068 (&sm->static_mapping_by_external, &kv, &value))
3070 m = pool_elt_at_index (sm->static_mappings, value.value);
3071 reass->thread_index = m->workers[0];
3072 return reass->thread_index;
3075 reass->thread_index = sm->first_worker_index;
3076 reass->thread_index +=
3077 sm->workers[(clib_net_to_host_u16 (port) - 1024) /
3078 sm->port_per_thread];
3079 return reass->thread_index;
3082 return vlib_get_thread_index ();
3086 /* unknown protocol */
3087 if (PREDICT_FALSE (proto == ~0))
3089 /* use current thread */
3090 return vlib_get_thread_index ();
3093 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
3095 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3096 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3097 if (!icmp_is_error_message (icmp))
3098 port = echo->identifier;
3101 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3102 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3103 void *l4_header = ip4_next_header (inner_ip);
3106 case SNAT_PROTOCOL_ICMP:
3107 icmp = (icmp46_header_t *) l4_header;
3108 echo = (icmp_echo_header_t *) (icmp + 1);
3109 port = echo->identifier;
3111 case SNAT_PROTOCOL_UDP:
3112 case SNAT_PROTOCOL_TCP:
3113 port = ((tcp_udp_header_t *) l4_header)->src_port;
3116 return vlib_get_thread_index ();
3121 /* try static mappings with port */
3122 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3124 m_key.addr = ip0->dst_address;
3125 m_key.port = clib_net_to_host_u16 (port);
3126 m_key.protocol = proto;
3127 m_key.fib_index = rx_fib_index0;
3128 kv.key = m_key.as_u64;
3129 if (!clib_bihash_search_8_8
3130 (&sm->static_mapping_by_external, &kv, &value))
3132 m = pool_elt_at_index (sm->static_mappings, value.value);
3133 return m->workers[0];
3137 /* worker by outside port */
3138 next_worker_index = sm->first_worker_index;
3139 next_worker_index +=
3140 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3141 return next_worker_index;
3145 nat44_ed_get_worker_in2out_cb (ip4_header_t * ip, u32 rx_fib_index,
3148 snat_main_t *sm = &snat_main;
3149 u32 next_worker_index = sm->first_worker_index;
3152 clib_bihash_kv_16_8_t kv16, value16;
3153 snat_main_per_thread_data_t *tsm;
3156 if (PREDICT_FALSE (is_output))
3158 u32 fib_index = sm->outside_fib_index;
3159 nat_outside_fib_t *outside_fib;
3160 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3161 fib_prefix_t pfx = {
3162 .fp_proto = FIB_PROTOCOL_IP4,
3165 .ip4.as_u32 = ip->dst_address.as_u32,
3170 udp = ip4_next_header (ip);
3172 switch (vec_len (sm->outside_fibs))
3175 fib_index = sm->outside_fib_index;
3178 fib_index = sm->outside_fibs[0].fib_index;
3182 vec_foreach (outside_fib, sm->outside_fibs)
3184 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3185 if (FIB_NODE_INDEX_INVALID != fei)
3187 if (fib_entry_get_resolving_interface (fei) != ~0)
3189 fib_index = outside_fib->fib_index;
3198 make_ed_kv (&kv16, &ip->src_address, &ip->dst_address,
3199 ip->protocol, fib_index, udp->src_port, udp->dst_port);
3202 vec_foreach (tsm, sm->per_thread_data)
3204 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3207 next_worker_index += tsm->thread_index;
3209 nat_elog_debug_handoff (
3210 "HANDOFF IN2OUT-OUTPUT-FEATURE (session)",
3211 next_worker_index, fib_index,
3212 clib_net_to_host_u32 (ip->src_address.as_u32),
3213 clib_net_to_host_u32 (ip->dst_address.as_u32));
3215 return next_worker_index;
3221 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3222 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3224 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3225 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3227 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3229 if (PREDICT_TRUE (!is_output))
3231 nat_elog_debug_handoff ("HANDOFF IN2OUT",
3232 next_worker_index, rx_fib_index,
3233 clib_net_to_host_u32 (ip->src_address.as_u32),
3234 clib_net_to_host_u32 (ip->dst_address.as_u32));
3238 nat_elog_debug_handoff ("HANDOFF IN2OUT-OUTPUT-FEATURE",
3239 next_worker_index, rx_fib_index,
3240 clib_net_to_host_u32 (ip->src_address.as_u32),
3241 clib_net_to_host_u32 (ip->dst_address.as_u32));
3244 return next_worker_index;
3248 nat44_ed_get_worker_out2in_cb (ip4_header_t * ip, u32 rx_fib_index,
3251 snat_main_t *sm = &snat_main;
3252 clib_bihash_kv_8_8_t kv, value;
3253 clib_bihash_kv_16_8_t kv16, value16;
3254 snat_main_per_thread_data_t *tsm;
3256 u32 proto, next_worker_index = 0;
3259 snat_static_mapping_t *m;
3262 proto = ip_proto_to_snat_proto (ip->protocol);
3264 if (PREDICT_TRUE (proto == SNAT_PROTOCOL_UDP || proto == SNAT_PROTOCOL_TCP))
3266 udp = ip4_next_header (ip);
3268 make_ed_kv (&kv16, &ip->dst_address, &ip->src_address,
3269 ip->protocol, rx_fib_index, udp->dst_port, udp->src_port);
3272 vec_foreach (tsm, sm->per_thread_data)
3274 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3277 next_worker_index = sm->first_worker_index + tsm->thread_index;
3278 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3279 next_worker_index, rx_fib_index,
3280 clib_net_to_host_u32 (ip->src_address.as_u32),
3281 clib_net_to_host_u32 (ip->dst_address.as_u32));
3282 return next_worker_index;
3287 else if (proto == SNAT_PROTOCOL_ICMP)
3289 nat_ed_ses_key_t key;
3291 if (!get_icmp_o2i_ed_key (ip, &key))
3294 key.fib_index = rx_fib_index;
3295 kv16.key[0] = key.as_u64[0];
3296 kv16.key[1] = key.as_u64[1];
3299 vec_foreach (tsm, sm->per_thread_data)
3301 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3304 next_worker_index = sm->first_worker_index +
3306 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3307 next_worker_index, rx_fib_index,
3308 clib_net_to_host_u32 (ip->src_address.as_u32),
3309 clib_net_to_host_u32 (ip->dst_address.as_u32));
3310 return next_worker_index;
3317 /* first try static mappings without port */
3318 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3320 make_sm_kv (&kv, &ip->dst_address, 0, 0, 0);
3321 if (!clib_bihash_search_8_8
3322 (&sm->static_mapping_by_external, &kv, &value))
3324 m = pool_elt_at_index (sm->static_mappings, value.value);
3325 next_worker_index = m->workers[0];
3330 /* unknown protocol */
3331 if (PREDICT_FALSE (proto == ~0))
3333 /* use current thread */
3334 next_worker_index = vlib_get_thread_index ();
3338 udp = ip4_next_header (ip);
3339 port = udp->dst_port;
3341 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
3343 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3344 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3345 if (!icmp_is_error_message (icmp))
3346 port = echo->identifier;
3349 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3350 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3351 void *l4_header = ip4_next_header (inner_ip);
3354 case SNAT_PROTOCOL_ICMP:
3355 icmp = (icmp46_header_t *) l4_header;
3356 echo = (icmp_echo_header_t *) (icmp + 1);
3357 port = echo->identifier;
3359 case SNAT_PROTOCOL_UDP:
3360 case SNAT_PROTOCOL_TCP:
3361 port = ((tcp_udp_header_t *) l4_header)->src_port;
3364 next_worker_index = vlib_get_thread_index ();
3370 /* try static mappings with port */
3371 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3373 make_sm_kv (&kv, &ip->dst_address, proto, 0,
3374 clib_net_to_host_u16 (port));
3375 if (!clib_bihash_search_8_8
3376 (&sm->static_mapping_by_external, &kv, &value))
3378 m = pool_elt_at_index (sm->static_mappings, value.value);
3379 if (!is_lb_static_mapping (m))
3381 next_worker_index = m->workers[0];
3385 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3386 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3388 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
3390 m->workers[hash & (_vec_len (m->workers) - 1)];
3392 next_worker_index = m->workers[hash % _vec_len (m->workers)];
3397 /* worker by outside port */
3398 next_worker_index = sm->first_worker_index;
3399 next_worker_index +=
3400 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3403 nat_elog_debug_handoff ("HANDOFF OUT2IN", next_worker_index, rx_fib_index,
3404 clib_net_to_host_u32 (ip->src_address.as_u32),
3405 clib_net_to_host_u32 (ip->dst_address.as_u32));
3406 return next_worker_index;
3410 nat_ha_sadd_cb (ip4_address_t * in_addr, u16 in_port,
3411 ip4_address_t * out_addr, u16 out_port,
3412 ip4_address_t * eh_addr, u16 eh_port,
3413 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3414 u32 fib_index, u16 flags, u32 thread_index)
3416 snat_main_t *sm = &snat_main;
3417 snat_session_key_t key;
3420 clib_bihash_kv_8_8_t kv;
3421 f64 now = vlib_time_now (sm->vlib_main);
3422 nat_outside_fib_t *outside_fib;
3423 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3424 snat_main_per_thread_data_t *tsm;
3425 fib_prefix_t pfx = {
3426 .fp_proto = FIB_PROTOCOL_IP4,
3429 .ip4.as_u32 = eh_addr->as_u32,
3433 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3435 key.addr.as_u32 = out_addr->as_u32;
3436 key.port = out_port;
3437 key.protocol = proto;
3439 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3441 if (nat_set_outside_address_and_port
3442 (sm->addresses, thread_index, &key))
3446 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3450 s = nat_session_alloc_or_recycle (sm, u, thread_index, now);
3454 s->last_heard = now;
3456 s->ext_host_addr.as_u32 = eh_addr->as_u32;
3457 s->ext_host_port = eh_port;
3458 user_session_increment (sm, u, snat_is_session_static (s));
3459 switch (vec_len (sm->outside_fibs))
3462 key.fib_index = sm->outside_fib_index;
3465 key.fib_index = sm->outside_fibs[0].fib_index;
3469 vec_foreach (outside_fib, sm->outside_fibs)
3471 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3472 if (FIB_NODE_INDEX_INVALID != fei)
3474 if (fib_entry_get_resolving_interface (fei) != ~0)
3476 key.fib_index = outside_fib->fib_index;
3485 kv.key = key.as_u64;
3486 kv.value = s - tsm->sessions;
3487 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 1))
3488 nat_elog_warn ("out2in key add failed");
3490 key.addr.as_u32 = in_addr->as_u32;
3492 key.fib_index = fib_index;
3494 kv.key = key.as_u64;
3495 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 1))
3496 nat_elog_warn ("in2out key add failed");
3500 nat_ha_sdel_cb (ip4_address_t * out_addr, u16 out_port,
3501 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3504 snat_main_t *sm = &snat_main;
3505 snat_session_key_t key;
3506 clib_bihash_kv_8_8_t kv, value;
3509 snat_main_per_thread_data_t *tsm;
3511 if (sm->num_workers > 1)
3513 sm->first_worker_index +
3514 (sm->workers[(clib_net_to_host_u16 (out_port) -
3515 1024) / sm->port_per_thread]);
3517 thread_index = sm->num_workers;
3518 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3520 key.addr.as_u32 = out_addr->as_u32;
3521 key.port = out_port;
3522 key.protocol = proto;
3523 key.fib_index = fib_index;
3524 kv.key = key.as_u64;
3525 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3528 s = pool_elt_at_index (tsm->sessions, value.value);
3529 nat_free_session_data (sm, s, thread_index, 1);
3530 nat44_delete_session (sm, s, thread_index);
3534 nat_ha_sref_cb (ip4_address_t * out_addr, u16 out_port,
3535 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3536 u32 total_pkts, u64 total_bytes, u32 thread_index)
3538 snat_main_t *sm = &snat_main;
3539 snat_session_key_t key;
3540 clib_bihash_kv_8_8_t kv, value;
3542 snat_main_per_thread_data_t *tsm;
3544 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3546 key.addr.as_u32 = out_addr->as_u32;
3547 key.port = out_port;
3548 key.protocol = proto;
3549 key.fib_index = fib_index;
3550 kv.key = key.as_u64;
3551 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3554 s = pool_elt_at_index (tsm->sessions, value.value);
3555 s->total_pkts = total_pkts;
3556 s->total_bytes = total_bytes;
3560 nat_ha_sadd_ed_cb (ip4_address_t * in_addr, u16 in_port,
3561 ip4_address_t * out_addr, u16 out_port,
3562 ip4_address_t * eh_addr, u16 eh_port,
3563 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3564 u32 fib_index, u16 flags, u32 thread_index)
3566 snat_main_t *sm = &snat_main;
3567 snat_session_key_t key;
3570 clib_bihash_kv_16_8_t kv;
3571 f64 now = vlib_time_now (sm->vlib_main);
3572 nat_outside_fib_t *outside_fib;
3573 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3574 snat_main_per_thread_data_t *tsm;
3575 fib_prefix_t pfx = {
3576 .fp_proto = FIB_PROTOCOL_IP4,
3579 .ip4.as_u32 = eh_addr->as_u32,
3583 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3585 key.addr.as_u32 = out_addr->as_u32;
3586 key.port = out_port;
3587 key.protocol = proto;
3589 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3591 if (nat_set_outside_address_and_port
3592 (sm->addresses, thread_index, &key))
3596 key.addr.as_u32 = ehn_addr->as_u32;
3597 key.port = ehn_port;
3598 if (flags & SNAT_SESSION_FLAG_TWICE_NAT)
3600 if (nat_set_outside_address_and_port
3601 (sm->twice_nat_addresses, thread_index, &key))
3605 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3609 s = nat_ed_session_alloc (sm, u, thread_index, now);
3613 s->last_heard = now;
3615 s->ext_host_nat_addr.as_u32 = s->ext_host_addr.as_u32 = eh_addr->as_u32;
3616 s->ext_host_nat_port = s->ext_host_port = eh_port;
3617 if (is_twice_nat_session (s))
3619 s->ext_host_nat_addr.as_u32 = ehn_addr->as_u32;
3620 s->ext_host_nat_port = ehn_port;
3622 user_session_increment (sm, u, snat_is_session_static (s));
3623 switch (vec_len (sm->outside_fibs))
3626 key.fib_index = sm->outside_fib_index;
3629 key.fib_index = sm->outside_fibs[0].fib_index;
3633 vec_foreach (outside_fib, sm->outside_fibs)
3635 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3636 if (FIB_NODE_INDEX_INVALID != fei)
3638 if (fib_entry_get_resolving_interface (fei) != ~0)
3640 key.fib_index = outside_fib->fib_index;
3648 key.addr.as_u32 = out_addr->as_u32;
3649 key.port = out_port;
3651 kv.value = s - tsm->sessions;
3653 key.addr.as_u32 = in_addr->as_u32;
3655 key.fib_index = fib_index;
3658 make_ed_kv (&kv, in_addr, &s->ext_host_nat_addr,
3659 snat_proto_to_ip_proto (proto), fib_index, in_port,
3660 s->ext_host_nat_port);
3661 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &kv, 1))
3662 nat_elog_warn ("in2out key add failed");
3664 make_ed_kv (&kv, out_addr, eh_addr, snat_proto_to_ip_proto (proto),
3665 s->out2in.fib_index, out_port, eh_port);
3666 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &kv, 1))
3667 nat_elog_warn ("out2in key add failed");
3671 nat_ha_sdel_ed_cb (ip4_address_t * out_addr, u16 out_port,
3672 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3673 u32 fib_index, u32 ti)
3675 snat_main_t *sm = &snat_main;
3676 nat_ed_ses_key_t key;
3677 clib_bihash_kv_16_8_t kv, value;
3680 snat_main_per_thread_data_t *tsm;
3682 if (sm->num_workers > 1)
3684 sm->first_worker_index +
3685 (sm->workers[(clib_net_to_host_u16 (out_port) -
3686 1024) / sm->port_per_thread]);
3688 thread_index = sm->num_workers;
3689 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3691 key.l_addr.as_u32 = out_addr->as_u32;
3692 key.l_port = out_port;
3693 key.r_addr.as_u32 = eh_addr->as_u32;
3694 key.r_port = eh_port;
3696 key.fib_index = fib_index;
3697 kv.key[0] = key.as_u64[0];
3698 kv.key[1] = key.as_u64[1];
3699 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3702 s = pool_elt_at_index (tsm->sessions, value.value);
3703 nat_free_session_data (sm, s, thread_index, 1);
3704 nat44_delete_session (sm, s, thread_index);
3708 nat_ha_sref_ed_cb (ip4_address_t * out_addr, u16 out_port,
3709 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3710 u32 fib_index, u32 total_pkts, u64 total_bytes,
3713 snat_main_t *sm = &snat_main;
3714 nat_ed_ses_key_t key;
3715 clib_bihash_kv_16_8_t kv, value;
3717 snat_main_per_thread_data_t *tsm;
3719 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3721 key.l_addr.as_u32 = out_addr->as_u32;
3722 key.l_port = out_port;
3723 key.r_addr.as_u32 = eh_addr->as_u32;
3724 key.r_port = eh_port;
3726 key.fib_index = fib_index;
3727 kv.key[0] = key.as_u64[0];
3728 kv.key[1] = key.as_u64[1];
3729 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3732 s = pool_elt_at_index (tsm->sessions, value.value);
3733 s->total_pkts = total_pkts;
3734 s->total_bytes = total_bytes;
3737 static clib_error_t *
3738 snat_config (vlib_main_t * vm, unformat_input_t * input)
3740 snat_main_t *sm = &snat_main;
3741 nat66_main_t *nm = &nat66_main;
3742 u32 translation_buckets = 1024;
3743 u32 translation_memory_size = 128 << 20;
3744 u32 user_buckets = 128;
3745 u32 user_memory_size = 64 << 20;
3746 u32 max_translations_per_user = 100;
3747 u32 outside_vrf_id = 0;
3748 u32 outside_ip6_vrf_id = 0;
3749 u32 inside_vrf_id = 0;
3750 u32 static_mapping_buckets = 1024;
3751 u32 static_mapping_memory_size = 64 << 20;
3752 u32 nat64_bib_buckets = 1024;
3753 u32 nat64_bib_memory_size = 128 << 20;
3754 u32 nat64_st_buckets = 2048;
3755 u32 nat64_st_memory_size = 256 << 20;
3756 u8 static_mapping_only = 0;
3757 u8 static_mapping_connection_tracking = 0;
3758 snat_main_per_thread_data_t *tsm;
3759 dslite_main_t *dm = &dslite_main;
3761 sm->deterministic = 0;
3763 sm->endpoint_dependent = 0;
3765 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3768 (input, "translation hash buckets %d", &translation_buckets))
3770 else if (unformat (input, "translation hash memory %d",
3771 &translation_memory_size));
3772 else if (unformat (input, "user hash buckets %d", &user_buckets))
3774 else if (unformat (input, "user hash memory %d", &user_memory_size))
3776 else if (unformat (input, "max translations per user %d",
3777 &max_translations_per_user))
3779 else if (unformat (input, "outside VRF id %d", &outside_vrf_id))
3781 else if (unformat (input, "outside ip6 VRF id %d", &outside_ip6_vrf_id))
3783 else if (unformat (input, "inside VRF id %d", &inside_vrf_id))
3785 else if (unformat (input, "static mapping only"))
3787 static_mapping_only = 1;
3788 if (unformat (input, "connection tracking"))
3789 static_mapping_connection_tracking = 1;
3791 else if (unformat (input, "deterministic"))
3792 sm->deterministic = 1;
3793 else if (unformat (input, "nat64 bib hash buckets %d",
3794 &nat64_bib_buckets))
3796 else if (unformat (input, "nat64 bib hash memory %d",
3797 &nat64_bib_memory_size))
3800 if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
3802 else if (unformat (input, "nat64 st hash memory %d",
3803 &nat64_st_memory_size))
3805 else if (unformat (input, "out2in dpo"))
3807 else if (unformat (input, "dslite ce"))
3808 dslite_set_ce (dm, 1);
3809 else if (unformat (input, "endpoint-dependent"))
3810 sm->endpoint_dependent = 1;
3812 return clib_error_return (0, "unknown input '%U'",
3813 format_unformat_error, input);
3816 if (sm->deterministic && sm->endpoint_dependent)
3817 return clib_error_return (0,
3818 "deterministic and endpoint-dependent modes are mutually exclusive");
3820 if (static_mapping_only && (sm->deterministic || sm->endpoint_dependent))
3821 return clib_error_return (0,
3822 "static mapping only mode available only for simple nat");
3824 if (sm->out2in_dpo && (sm->deterministic || sm->endpoint_dependent))
3825 return clib_error_return (0,
3826 "out2in dpo mode available only for simple nat");
3828 /* for show commands, etc. */
3829 sm->translation_buckets = translation_buckets;
3830 sm->translation_memory_size = translation_memory_size;
3831 /* do not exceed load factor 10 */
3832 sm->max_translations = 10 * translation_buckets;
3833 sm->user_buckets = user_buckets;
3834 sm->user_memory_size = user_memory_size;
3835 sm->max_translations_per_user = max_translations_per_user;
3836 sm->outside_vrf_id = outside_vrf_id;
3837 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
3839 FIB_SOURCE_PLUGIN_HI);
3840 nm->outside_vrf_id = outside_ip6_vrf_id;
3841 nm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6,
3843 FIB_SOURCE_PLUGIN_HI);
3844 sm->inside_vrf_id = inside_vrf_id;
3845 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
3847 FIB_SOURCE_PLUGIN_HI);
3848 sm->static_mapping_only = static_mapping_only;
3849 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
3851 nat64_set_hash (nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
3852 nat64_st_memory_size);
3854 if (sm->deterministic)
3856 sm->in2out_node_index = snat_det_in2out_node.index;
3857 sm->in2out_output_node_index = ~0;
3858 sm->out2in_node_index = snat_det_out2in_node.index;
3859 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
3860 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
3864 if (sm->endpoint_dependent)
3866 sm->worker_in2out_cb = nat44_ed_get_worker_in2out_cb;
3867 sm->worker_out2in_cb = nat44_ed_get_worker_out2in_cb;
3869 sm->handoff_out2in_index = nat_pre_out2in_node.index;
3870 sm->handoff_in2out_index = nat_pre_in2out_node.index;
3872 sm->handoff_in2out_output_index = nat44_ed_in2out_output_node.index;
3874 sm->in2out_node_index = nat44_ed_in2out_node.index;
3875 sm->in2out_output_node_index = nat44_ed_in2out_output_node.index;
3876 sm->out2in_node_index = nat44_ed_out2in_node.index;
3878 sm->icmp_match_in2out_cb = icmp_match_in2out_ed;
3879 sm->icmp_match_out2in_cb = icmp_match_out2in_ed;
3880 nat_affinity_init (vm);
3881 nat_ha_init (vm, nat_ha_sadd_ed_cb, nat_ha_sdel_ed_cb,
3886 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
3887 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
3889 sm->handoff_out2in_index = snat_in2out_node.index;
3890 sm->handoff_in2out_index = snat_out2in_node.index;
3892 sm->handoff_in2out_output_index = snat_in2out_output_node.index;
3894 sm->in2out_node_index = snat_in2out_node.index;
3895 sm->in2out_output_node_index = snat_in2out_output_node.index;
3896 sm->out2in_node_index = snat_out2in_node.index;
3897 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
3898 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
3899 nat_ha_init (vm, nat_ha_sadd_cb, nat_ha_sdel_cb, nat_ha_sref_cb);
3901 if (!static_mapping_only ||
3902 (static_mapping_only && static_mapping_connection_tracking))
3905 vec_foreach (tsm, sm->per_thread_data)
3907 if (sm->endpoint_dependent)
3909 clib_bihash_init_16_8 (&tsm->in2out_ed, "in2out-ed",
3910 translation_buckets,
3911 translation_memory_size);
3912 clib_bihash_set_kvp_format_fn_16_8 (&tsm->in2out_ed,
3913 format_ed_session_kvp);
3915 clib_bihash_init_16_8 (&tsm->out2in_ed, "out2in-ed",
3916 translation_buckets,
3917 translation_memory_size);
3918 clib_bihash_set_kvp_format_fn_16_8 (&tsm->out2in_ed,
3919 format_ed_session_kvp);
3923 clib_bihash_init_8_8 (&tsm->in2out, "in2out",
3924 translation_buckets,
3925 translation_memory_size);
3926 clib_bihash_set_kvp_format_fn_8_8 (&tsm->in2out,
3927 format_session_kvp);
3929 clib_bihash_init_8_8 (&tsm->out2in, "out2in",
3930 translation_buckets,
3931 translation_memory_size);
3932 clib_bihash_set_kvp_format_fn_8_8 (&tsm->out2in,
3933 format_session_kvp);
3936 clib_bihash_init_8_8 (&tsm->user_hash, "users", user_buckets,
3938 clib_bihash_set_kvp_format_fn_8_8 (&tsm->user_hash,
3946 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
3947 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
3949 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
3950 "static_mapping_by_local", static_mapping_buckets,
3951 static_mapping_memory_size);
3952 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_local,
3953 format_static_mapping_kvp);
3955 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
3956 "static_mapping_by_external",
3957 static_mapping_buckets,
3958 static_mapping_memory_size);
3959 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_external,
3960 format_static_mapping_kvp);
3966 VLIB_CONFIG_FUNCTION (snat_config, "nat");
3969 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
3972 ip4_address_t * address,
3974 u32 if_address_index, u32 is_delete)
3976 snat_main_t *sm = &snat_main;
3977 snat_static_map_resolve_t *rp;
3978 snat_static_mapping_t *m;
3979 snat_session_key_t m_key;
3980 clib_bihash_kv_8_8_t kv, value;
3982 ip4_address_t l_addr;
3984 for (i = 0; i < vec_len (sm->to_resolve); i++)
3986 rp = sm->to_resolve + i;
3987 if (rp->addr_only == 0)
3989 if (rp->sw_if_index == sw_if_index)
3996 m_key.addr.as_u32 = address->as_u32;
3997 m_key.port = rp->addr_only ? 0 : rp->e_port;
3998 m_key.protocol = rp->addr_only ? 0 : rp->proto;
3999 m_key.fib_index = sm->outside_fib_index;
4000 kv.key = m_key.as_u64;
4001 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
4004 m = pool_elt_at_index (sm->static_mappings, value.value);
4008 /* Don't trip over lease renewal, static config */
4018 /* Indetity mapping? */
4019 if (rp->l_addr.as_u32 == 0)
4020 l_addr.as_u32 = address[0].as_u32;
4022 l_addr.as_u32 = rp->l_addr.as_u32;
4023 /* Add the static mapping */
4024 rv = snat_add_static_mapping (l_addr,
4029 rp->addr_only, ~0 /* sw_if_index */ ,
4030 rp->proto, !is_delete, rp->twice_nat,
4031 rp->out2in_only, rp->tag, rp->identity_nat);
4033 nat_elog_notice_X1 ("snat_add_static_mapping returned %d", "i4", rv);
4037 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
4040 ip4_address_t * address,
4042 u32 if_address_index, u32 is_delete)
4044 snat_main_t *sm = &snat_main;
4045 snat_static_map_resolve_t *rp;
4046 ip4_address_t l_addr;
4050 snat_address_t *addresses = sm->addresses;
4052 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices); i++)
4054 if (sw_if_index == sm->auto_add_sw_if_indices[i])
4058 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices_twice_nat); i++)
4061 addresses = sm->twice_nat_addresses;
4062 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
4071 /* Don't trip over lease renewal, static config */
4072 for (j = 0; j < vec_len (addresses); j++)
4073 if (addresses[j].addr.as_u32 == address->as_u32)
4076 (void) snat_add_address (sm, address, ~0, twice_nat);
4077 /* Scan static map resolution vector */
4078 for (j = 0; j < vec_len (sm->to_resolve); j++)
4080 rp = sm->to_resolve + j;
4083 /* On this interface? */
4084 if (rp->sw_if_index == sw_if_index)
4086 /* Indetity mapping? */
4087 if (rp->l_addr.as_u32 == 0)
4088 l_addr.as_u32 = address[0].as_u32;
4090 l_addr.as_u32 = rp->l_addr.as_u32;
4091 /* Add the static mapping */
4092 rv = snat_add_static_mapping (l_addr,
4098 ~0 /* sw_if_index */ ,
4100 rp->is_add, rp->twice_nat,
4101 rp->out2in_only, rp->tag,
4104 nat_elog_notice_X1 ("snat_add_static_mapping returned %d",
4112 (void) snat_del_address (sm, address[0], 1, twice_nat);
4119 snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
4122 ip4_main_t *ip4_main = sm->ip4_main;
4123 ip4_address_t *first_int_addr;
4124 snat_static_map_resolve_t *rp;
4125 u32 *indices_to_delete = 0;
4127 u32 *auto_add_sw_if_indices =
4129 auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
4131 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0 /* just want the address */
4134 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
4136 if (auto_add_sw_if_indices[i] == sw_if_index)
4140 /* if have address remove it */
4142 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
4145 for (j = 0; j < vec_len (sm->to_resolve); j++)
4147 rp = sm->to_resolve + j;
4148 if (rp->sw_if_index == sw_if_index)
4149 vec_add1 (indices_to_delete, j);
4151 if (vec_len (indices_to_delete))
4153 for (j = vec_len (indices_to_delete) - 1; j >= 0; j--)
4154 vec_del1 (sm->to_resolve, j);
4155 vec_free (indices_to_delete);
4159 vec_del1 (sm->auto_add_sw_if_indices_twice_nat, i);
4161 vec_del1 (sm->auto_add_sw_if_indices, i);
4164 return VNET_API_ERROR_VALUE_EXIST;
4171 return VNET_API_ERROR_NO_SUCH_ENTRY;
4173 /* add to the auto-address list */
4175 vec_add1 (sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
4177 vec_add1 (sm->auto_add_sw_if_indices, sw_if_index);
4179 /* If the address is already bound - or static - add it now */
4181 (void) snat_add_address (sm, first_int_addr, ~0, twice_nat);
4187 nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4188 snat_protocol_t proto, u32 vrf_id, int is_in)
4190 snat_main_per_thread_data_t *tsm;
4191 clib_bihash_kv_8_8_t kv, value;
4193 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4194 snat_session_key_t key;
4196 clib_bihash_8_8_t *t;
4198 if (sm->endpoint_dependent)
4199 return VNET_API_ERROR_UNSUPPORTED;
4201 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4202 if (sm->num_workers > 1)
4204 vec_elt_at_index (sm->per_thread_data,
4205 sm->worker_in2out_cb (&ip, fib_index, 0));
4207 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4209 key.addr.as_u32 = addr->as_u32;
4210 key.port = clib_host_to_net_u16 (port);
4211 key.protocol = proto;
4212 key.fib_index = fib_index;
4213 kv.key = key.as_u64;
4214 t = is_in ? &tsm->in2out : &tsm->out2in;
4215 if (!clib_bihash_search_8_8 (t, &kv, &value))
4217 if (pool_is_free_index (tsm->sessions, value.value))
4218 return VNET_API_ERROR_UNSPECIFIED;
4220 s = pool_elt_at_index (tsm->sessions, value.value);
4221 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4222 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4226 return VNET_API_ERROR_NO_SUCH_ENTRY;
4230 nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4231 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
4232 u32 vrf_id, int is_in)
4235 clib_bihash_16_8_t *t;
4236 nat_ed_ses_key_t key;
4237 clib_bihash_kv_16_8_t kv, value;
4238 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4240 snat_main_per_thread_data_t *tsm;
4242 if (!sm->endpoint_dependent)
4243 return VNET_API_ERROR_FEATURE_DISABLED;
4245 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4246 if (sm->num_workers > 1)
4248 vec_elt_at_index (sm->per_thread_data,
4249 sm->worker_in2out_cb (&ip, fib_index, 0));
4251 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4253 t = is_in ? &tsm->in2out_ed : &tsm->out2in_ed;
4254 key.l_addr.as_u32 = addr->as_u32;
4255 key.r_addr.as_u32 = eh_addr->as_u32;
4256 key.l_port = clib_host_to_net_u16 (port);
4257 key.r_port = clib_host_to_net_u16 (eh_port);
4259 key.fib_index = fib_index;
4260 kv.key[0] = key.as_u64[0];
4261 kv.key[1] = key.as_u64[1];
4262 if (clib_bihash_search_16_8 (t, &kv, &value))
4263 return VNET_API_ERROR_NO_SUCH_ENTRY;
4265 if (pool_is_free_index (tsm->sessions, value.value))
4266 return VNET_API_ERROR_UNSPECIFIED;
4267 s = pool_elt_at_index (tsm->sessions, value.value);
4268 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4269 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4274 nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset, u16 psid_length)
4276 snat_main_t *sm = &snat_main;
4278 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_MAPE;
4279 sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
4281 sm->psid_offset = psid_offset;
4282 sm->psid_length = psid_length;
4286 nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port)
4288 snat_main_t *sm = &snat_main;
4290 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_RANGE;
4291 sm->alloc_addr_and_port = nat_alloc_addr_and_port_range;
4292 sm->start_port = start_port;
4293 sm->end_port = end_port;
4297 nat_set_alloc_addr_and_port_default (void)
4299 snat_main_t *sm = &snat_main;
4301 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
4302 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
4305 VLIB_NODE_FN (nat_default_node) (vlib_main_t * vm,
4306 vlib_node_runtime_t * node,
4307 vlib_frame_t * frame)
4313 VLIB_REGISTER_NODE (nat_default_node) = {
4314 .name = "nat-default",
4315 .vector_size = sizeof (u32),
4317 .type = VLIB_NODE_TYPE_INTERNAL,
4319 .n_next_nodes = NAT_N_NEXT,
4321 [NAT_NEXT_DROP] = "error-drop",
4322 [NAT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
4323 [NAT_NEXT_IN2OUT_PRE] = "nat-pre-in2out",
4324 [NAT_NEXT_OUT2IN_PRE] = "nat-pre-out2in",
4325 [NAT_NEXT_IN2OUT_ED_FAST_PATH] = "nat44-ed-in2out",
4326 [NAT_NEXT_IN2OUT_ED_SLOW_PATH] = "nat44-ed-in2out-slowpath",
4327 [NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH] = "nat44-ed-in2out-output-slowpath",
4328 [NAT_NEXT_IN2OUT_ED_REASS] = "nat44-ed-in2out-reass",
4329 [NAT_NEXT_IN2OUT_ED_OUTPUT_REASS] = "nat44-ed-in2out-reass-output",
4330 [NAT_NEXT_OUT2IN_ED_FAST_PATH] = "nat44-ed-out2in",
4331 [NAT_NEXT_OUT2IN_ED_SLOW_PATH] = "nat44-ed-out2in-slowpath",
4332 [NAT_NEXT_OUT2IN_ED_REASS] = "nat44-ed-out2in-reass",
4338 * fd.io coding-style-patch-verification: ON
4341 * eval: (c-set-style "gnu")