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_inlines.h>
30 #include <nat/nat_affinity.h>
31 #include <nat/nat_syslog.h>
32 #include <nat/nat_ha.h>
33 #include <vnet/fib/fib_table.h>
34 #include <vnet/fib/ip4_fib.h>
35 #include <vnet/ip/reass/ip4_sv_reass.h>
37 #include <vpp/app/version.h>
39 snat_main_t snat_main;
41 fib_source_t nat_fib_src_hi;
42 fib_source_t nat_fib_src_low;
45 /* Hook up input features */
46 VNET_FEATURE_INIT (nat_pre_in2out, static) = {
47 .arc_name = "ip4-unicast",
48 .node_name = "nat-pre-in2out",
49 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
50 "ip4-sv-reassembly-feature"),
52 VNET_FEATURE_INIT (nat_pre_out2in, static) = {
53 .arc_name = "ip4-unicast",
54 .node_name = "nat-pre-out2in",
55 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
56 "ip4-dhcp-client-detect",
57 "ip4-sv-reassembly-feature"),
59 VNET_FEATURE_INIT (snat_in2out_worker_handoff, static) = {
60 .arc_name = "ip4-unicast",
61 .node_name = "nat44-in2out-worker-handoff",
62 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
64 VNET_FEATURE_INIT (snat_out2in_worker_handoff, static) = {
65 .arc_name = "ip4-unicast",
66 .node_name = "nat44-out2in-worker-handoff",
67 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
68 "ip4-dhcp-client-detect"),
70 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
71 .arc_name = "ip4-unicast",
72 .node_name = "nat44-in2out",
73 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
75 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
76 .arc_name = "ip4-unicast",
77 .node_name = "nat44-out2in",
78 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
79 "ip4-dhcp-client-detect"),
81 VNET_FEATURE_INIT (ip4_nat_classify, static) = {
82 .arc_name = "ip4-unicast",
83 .node_name = "nat44-classify",
84 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
86 VNET_FEATURE_INIT (ip4_snat_det_in2out, static) = {
87 .arc_name = "ip4-unicast",
88 .node_name = "nat44-det-in2out",
89 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
91 VNET_FEATURE_INIT (ip4_snat_det_out2in, static) = {
92 .arc_name = "ip4-unicast",
93 .node_name = "nat44-det-out2in",
94 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
95 "ip4-dhcp-client-detect"),
97 VNET_FEATURE_INIT (ip4_nat_det_classify, static) = {
98 .arc_name = "ip4-unicast",
99 .node_name = "nat44-det-classify",
100 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
102 VNET_FEATURE_INIT (ip4_nat44_ed_in2out, static) = {
103 .arc_name = "ip4-unicast",
104 .node_name = "nat44-ed-in2out",
105 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
107 VNET_FEATURE_INIT (ip4_nat44_ed_out2in, static) = {
108 .arc_name = "ip4-unicast",
109 .node_name = "nat44-ed-out2in",
110 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
111 "ip4-dhcp-client-detect"),
113 VNET_FEATURE_INIT (ip4_nat44_ed_classify, static) = {
114 .arc_name = "ip4-unicast",
115 .node_name = "nat44-ed-classify",
116 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
118 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
119 .arc_name = "ip4-unicast",
120 .node_name = "nat44-handoff-classify",
121 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
123 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
124 .arc_name = "ip4-unicast",
125 .node_name = "nat44-in2out-fast",
126 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
128 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
129 .arc_name = "ip4-unicast",
130 .node_name = "nat44-out2in-fast",
131 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
132 "ip4-dhcp-client-detect"),
134 VNET_FEATURE_INIT (ip4_snat_hairpin_dst, static) = {
135 .arc_name = "ip4-unicast",
136 .node_name = "nat44-hairpin-dst",
137 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
139 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_dst, static) = {
140 .arc_name = "ip4-unicast",
141 .node_name = "nat44-ed-hairpin-dst",
142 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
145 /* Hook up output features */
146 VNET_FEATURE_INIT (ip4_snat_in2out_output, static) = {
147 .arc_name = "ip4-output",
148 .node_name = "nat44-in2out-output",
149 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
151 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
152 .arc_name = "ip4-output",
153 .node_name = "nat44-in2out-output-worker-handoff",
154 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
156 VNET_FEATURE_INIT (ip4_snat_hairpin_src, static) = {
157 .arc_name = "ip4-output",
158 .node_name = "nat44-hairpin-src",
159 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
161 VNET_FEATURE_INIT (ip4_nat44_ed_in2out_output, static) = {
162 .arc_name = "ip4-output",
163 .node_name = "nat44-ed-in2out-output",
164 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
166 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_src, static) = {
167 .arc_name = "ip4-output",
168 .node_name = "nat44-ed-hairpin-src",
169 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
172 /* Hook up ip4-local features */
173 VNET_FEATURE_INIT (ip4_nat_hairpinning, static) =
175 .arc_name = "ip4-local",
176 .node_name = "nat44-hairpinning",
177 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
179 VNET_FEATURE_INIT (ip4_nat44_ed_hairpinning, static) =
181 .arc_name = "ip4-local",
182 .node_name = "nat44-ed-hairpinning",
183 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
187 VLIB_PLUGIN_REGISTER () = {
188 .version = VPP_BUILD_VER,
189 .description = "Network Address Translation (NAT)",
194 nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index,
197 snat_session_key_t key;
198 clib_bihash_kv_8_8_t kv;
199 nat_ed_ses_key_t ed_key;
200 clib_bihash_kv_16_8_t ed_kv;
201 snat_main_per_thread_data_t *tsm =
202 vec_elt_at_index (sm->per_thread_data, thread_index);
204 if (is_fwd_bypass_session (s))
206 if (snat_is_unk_proto_session (s))
208 ed_key.proto = s->in2out.port;
214 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
215 ed_key.l_port = s->in2out.port;
216 ed_key.r_port = s->ext_host_port;
218 ed_key.l_addr = s->in2out.addr;
219 ed_key.r_addr = s->ext_host_addr;
220 ed_key.fib_index = 0;
221 ed_kv.key[0] = ed_key.as_u64[0];
222 ed_kv.key[1] = ed_key.as_u64[1];
223 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
224 nat_elog_warn ("in2out_ed key del failed");
228 /* session lookup tables */
229 if (is_ed_session (s))
231 if (is_affinity_sessions (s))
232 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
233 s->in2out.protocol, s->out2in.port);
234 ed_key.l_addr = s->out2in.addr;
235 ed_key.r_addr = s->ext_host_addr;
236 ed_key.fib_index = s->out2in.fib_index;
237 if (snat_is_unk_proto_session (s))
239 ed_key.proto = s->in2out.port;
245 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
246 ed_key.l_port = s->out2in.port;
247 ed_key.r_port = s->ext_host_port;
249 ed_kv.key[0] = ed_key.as_u64[0];
250 ed_kv.key[1] = ed_key.as_u64[1];
251 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &ed_kv, 0))
252 nat_elog_warn ("out2in_ed key del failed");
253 ed_key.l_addr = s->in2out.addr;
254 ed_key.fib_index = s->in2out.fib_index;
255 if (!snat_is_unk_proto_session (s))
256 ed_key.l_port = s->in2out.port;
257 if (is_twice_nat_session (s))
259 ed_key.r_addr = s->ext_host_nat_addr;
260 ed_key.r_port = s->ext_host_nat_port;
262 ed_kv.key[0] = ed_key.as_u64[0];
263 ed_kv.key[1] = ed_key.as_u64[1];
264 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
265 nat_elog_warn ("in2out_ed key del failed");
268 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
269 &s->in2out.addr, s->in2out.port,
270 &s->ext_host_nat_addr, s->ext_host_nat_port,
271 &s->out2in.addr, s->out2in.port,
272 &s->ext_host_addr, s->ext_host_port,
273 s->in2out.protocol, is_twice_nat_session (s));
277 kv.key = s->in2out.as_u64;
278 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0))
279 nat_elog_warn ("in2out key del failed");
280 kv.key = s->out2in.as_u64;
281 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0))
282 nat_elog_warn ("out2in key del failed");
285 nat_syslog_nat44_apmdel (s->user_index, s->in2out.fib_index,
286 &s->in2out.addr, s->in2out.port,
287 &s->out2in.addr, s->out2in.port,
291 if (snat_is_unk_proto_session (s))
297 snat_ipfix_logging_nat44_ses_delete (thread_index,
298 s->in2out.addr.as_u32,
299 s->out2in.addr.as_u32,
303 s->in2out.fib_index);
305 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
306 s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
310 /* Twice NAT address and port for external host */
311 if (is_twice_nat_session (s))
313 key.protocol = s->in2out.protocol;
314 key.port = s->ext_host_nat_port;
315 key.addr.as_u32 = s->ext_host_nat_addr.as_u32;
316 snat_free_outside_address_and_port (sm->twice_nat_addresses,
320 if (snat_is_session_static (s))
323 snat_free_outside_address_and_port (sm->addresses, thread_index,
328 nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr, u32 fib_index,
332 snat_user_key_t user_key;
333 clib_bihash_kv_8_8_t kv, value;
334 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
335 dlist_elt_t *per_user_list_head_elt;
337 user_key.addr.as_u32 = addr->as_u32;
338 user_key.fib_index = fib_index;
339 kv.key = user_key.as_u64;
341 /* Ever heard of the "user" = src ip4 address before? */
342 if (clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
344 /* no, make a new one */
345 pool_get (tsm->users, u);
346 clib_memset (u, 0, sizeof (*u));
347 u->addr.as_u32 = addr->as_u32;
348 u->fib_index = fib_index;
350 pool_get (tsm->list_pool, per_user_list_head_elt);
352 u->sessions_per_user_list_head_index = per_user_list_head_elt -
355 clib_dlist_init (tsm->list_pool, u->sessions_per_user_list_head_index);
357 kv.value = u - tsm->users;
360 if (clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 1))
361 nat_elog_warn ("user_hash keay add failed");
363 vlib_set_simple_counter (&sm->total_users, thread_index, 0,
364 pool_elts (tsm->users));
368 u = pool_elt_at_index (tsm->users, value.value);
375 nat_session_alloc_or_recycle (snat_main_t * sm, snat_user_t * u,
376 u32 thread_index, f64 now)
379 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
380 u32 oldest_per_user_translation_list_index, session_index;
381 dlist_elt_t *oldest_per_user_translation_list_elt;
382 dlist_elt_t *per_user_translation_list_elt;
384 /* Over quota? Recycle the least recently used translation */
385 if ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user)
387 oldest_per_user_translation_list_index =
388 clib_dlist_remove_head (tsm->list_pool,
389 u->sessions_per_user_list_head_index);
391 ASSERT (oldest_per_user_translation_list_index != ~0);
393 /* Add it back to the end of the LRU list */
394 clib_dlist_addtail (tsm->list_pool,
395 u->sessions_per_user_list_head_index,
396 oldest_per_user_translation_list_index);
397 /* Get the list element */
398 oldest_per_user_translation_list_elt =
399 pool_elt_at_index (tsm->list_pool,
400 oldest_per_user_translation_list_index);
402 /* Get the session index from the list element */
403 session_index = oldest_per_user_translation_list_elt->value;
405 /* Get the session */
406 s = pool_elt_at_index (tsm->sessions, session_index);
407 nat_free_session_data (sm, s, thread_index, 0);
408 if (snat_is_session_static (s))
409 u->nstaticsessions--;
416 s->ext_host_addr.as_u32 = 0;
417 s->ext_host_port = 0;
418 s->ext_host_nat_addr.as_u32 = 0;
419 s->ext_host_nat_port = 0;
423 pool_get (tsm->sessions, s);
424 clib_memset (s, 0, sizeof (*s));
426 /* Create list elts */
427 pool_get (tsm->list_pool, per_user_translation_list_elt);
428 clib_dlist_init (tsm->list_pool,
429 per_user_translation_list_elt - tsm->list_pool);
431 per_user_translation_list_elt->value = s - tsm->sessions;
432 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
433 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
435 clib_dlist_addtail (tsm->list_pool,
436 s->per_user_list_head_index,
437 per_user_translation_list_elt - tsm->list_pool);
439 s->user_index = u - tsm->users;
440 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
441 pool_elts (tsm->sessions));
444 s->ha_last_refreshed = now;
450 nat_ed_session_alloc (snat_main_t * sm, snat_user_t * u, u32 thread_index,
454 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
455 dlist_elt_t *per_user_translation_list_elt, *oldest_elt;
457 u64 sess_timeout_time;
459 if (PREDICT_FALSE (!(u->nsessions) && !(u->nstaticsessions)))
463 clib_dlist_remove_head (tsm->list_pool,
464 u->sessions_per_user_list_head_index);
465 oldest_elt = pool_elt_at_index (tsm->list_pool, oldest_index);
466 s = pool_elt_at_index (tsm->sessions, oldest_elt->value);
468 sess_timeout_time = s->last_heard + (f64) nat44_session_get_timeout (sm, s);
469 if (now >= sess_timeout_time)
471 clib_dlist_addtail (tsm->list_pool,
472 u->sessions_per_user_list_head_index, oldest_index);
473 nat_free_session_data (sm, s, thread_index, 0);
474 if (snat_is_session_static (s))
475 u->nstaticsessions--;
482 s->ext_host_addr.as_u32 = 0;
483 s->ext_host_port = 0;
484 s->ext_host_nat_addr.as_u32 = 0;
485 s->ext_host_nat_port = 0;
489 clib_dlist_addhead (tsm->list_pool,
490 u->sessions_per_user_list_head_index, oldest_index);
491 if ((u->nsessions + u->nstaticsessions) >=
492 sm->max_translations_per_user)
494 nat_elog_addr (SNAT_LOG_WARNING, "[warn] max translations per user",
495 clib_net_to_host_u32 (u->addr.as_u32));
496 snat_ipfix_logging_max_entries_per_user
497 (thread_index, sm->max_translations_per_user, u->addr.as_u32);
503 pool_get (tsm->sessions, s);
504 clib_memset (s, 0, sizeof (*s));
506 /* Create list elts */
507 pool_get (tsm->list_pool, per_user_translation_list_elt);
508 clib_dlist_init (tsm->list_pool,
509 per_user_translation_list_elt - tsm->list_pool);
511 per_user_translation_list_elt->value = s - tsm->sessions;
512 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
513 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
515 clib_dlist_addtail (tsm->list_pool,
516 s->per_user_list_head_index,
517 per_user_translation_list_elt - tsm->list_pool);
520 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
521 pool_elts (tsm->sessions));
524 s->ha_last_refreshed = now;
530 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
533 fib_prefix_t prefix = {
535 .fp_proto = FIB_PROTOCOL_IP4,
537 .ip4.as_u32 = addr->as_u32,
540 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
543 fib_table_entry_update_one_path (fib_index,
546 (FIB_ENTRY_FLAG_CONNECTED |
547 FIB_ENTRY_FLAG_LOCAL |
548 FIB_ENTRY_FLAG_EXCLUSIVE),
552 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
554 fib_table_entry_delete (fib_index, &prefix, nat_fib_src_low);
558 snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
563 vlib_thread_main_t *tm = vlib_get_thread_main ();
565 if (twice_nat && !sm->endpoint_dependent)
566 return VNET_API_ERROR_FEATURE_DISABLED;
568 /* Check if address already exists */
570 vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
572 if (ap->addr.as_u32 == addr->as_u32)
573 return VNET_API_ERROR_VALUE_EXIST;
578 vec_add2 (sm->twice_nat_addresses, ap, 1);
580 vec_add2 (sm->addresses, ap, 1);
585 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
589 #define _(N, i, n, s) \
590 clib_bitmap_alloc (ap->busy_##n##_port_bitmap, 65535); \
591 ap->busy_##n##_ports = 0; \
592 ap->busy_##n##_ports_per_thread = 0;\
593 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
594 foreach_snat_protocol
599 /* Add external address to FIB */
601 pool_foreach (i, sm->interfaces,
603 if (nat_interface_is_inside(i) || sm->out2in_dpo)
606 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
609 pool_foreach (i, sm->output_feature_interfaces,
611 if (nat_interface_is_inside(i) || sm->out2in_dpo)
614 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
623 is_snat_address_used_in_static_mapping (snat_main_t * sm, ip4_address_t addr)
625 snat_static_mapping_t *m;
627 pool_foreach (m, sm->static_mappings,
629 if (is_addr_only_static_mapping (m) ||
630 is_out2in_only_static_mapping (m) ||
631 is_identity_static_mapping (m))
633 if (m->external_addr.as_u32 == addr.as_u32)
642 increment_v4_address (ip4_address_t * a)
646 v = clib_net_to_host_u32 (a->as_u32) + 1;
647 a->as_u32 = clib_host_to_net_u32 (v);
651 snat_add_static_mapping_when_resolved (snat_main_t * sm,
652 ip4_address_t l_addr,
657 snat_protocol_t proto,
658 int addr_only, int is_add, u8 * tag,
659 int twice_nat, int out2in_only,
662 snat_static_map_resolve_t *rp;
664 vec_add2 (sm->to_resolve, rp, 1);
665 rp->l_addr.as_u32 = l_addr.as_u32;
667 rp->sw_if_index = sw_if_index;
671 rp->addr_only = addr_only;
673 rp->twice_nat = twice_nat;
674 rp->out2in_only = out2in_only;
675 rp->identity_nat = identity_nat;
676 rp->tag = vec_dup (tag);
680 get_thread_idx_by_port (u16 e_port)
682 snat_main_t *sm = &snat_main;
683 u32 thread_idx = sm->num_workers;
684 if (sm->num_workers > 1)
687 sm->first_worker_index +
688 sm->workers[(e_port - 1024) / sm->port_per_thread];
694 snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
695 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
696 u32 sw_if_index, snat_protocol_t proto, int is_add,
697 twice_nat_type_t twice_nat, u8 out2in_only, u8 * tag,
700 snat_main_t *sm = &snat_main;
701 snat_static_mapping_t *m;
702 snat_session_key_t m_key;
703 clib_bihash_kv_8_8_t kv, value;
704 snat_address_t *a = 0;
706 snat_interface_t *interface;
708 snat_main_per_thread_data_t *tsm;
709 snat_user_key_t u_key;
711 dlist_elt_t *head, *elt;
712 u32 elt_index, head_index;
716 snat_static_map_resolve_t *rp, *rp_match = 0;
717 nat44_lb_addr_port_t *local;
720 if (!sm->endpoint_dependent)
722 if (twice_nat || out2in_only)
723 return VNET_API_ERROR_FEATURE_DISABLED;
726 /* If the external address is a specific interface address */
727 if (sw_if_index != ~0)
729 ip4_address_t *first_int_addr;
731 for (i = 0; i < vec_len (sm->to_resolve); i++)
733 rp = sm->to_resolve + i;
734 if (rp->sw_if_index != sw_if_index ||
735 rp->l_addr.as_u32 != l_addr.as_u32 ||
736 rp->vrf_id != vrf_id || rp->addr_only != addr_only)
741 if ((rp->l_port != l_port && rp->e_port != e_port)
742 || rp->proto != proto)
750 /* Might be already set... */
751 first_int_addr = ip4_interface_first_address
752 (sm->ip4_main, sw_if_index, 0 /* just want the address */ );
757 return VNET_API_ERROR_VALUE_EXIST;
759 snat_add_static_mapping_when_resolved
760 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
761 addr_only, is_add, tag, twice_nat, out2in_only, identity_nat);
763 /* DHCP resolution required? */
764 if (first_int_addr == 0)
770 e_addr.as_u32 = first_int_addr->as_u32;
771 /* Identity mapping? */
772 if (l_addr.as_u32 == 0)
773 l_addr.as_u32 = e_addr.as_u32;
779 return VNET_API_ERROR_NO_SUCH_ENTRY;
781 vec_del1 (sm->to_resolve, i);
785 e_addr.as_u32 = first_int_addr->as_u32;
786 /* Identity mapping? */
787 if (l_addr.as_u32 == 0)
788 l_addr.as_u32 = e_addr.as_u32;
796 m_key.port = addr_only ? 0 : e_port;
797 m_key.protocol = addr_only ? 0 : proto;
799 kv.key = m_key.as_u64;
800 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
803 m = pool_elt_at_index (sm->static_mappings, value.value);
809 if (is_identity_static_mapping (m))
812 pool_foreach (local, m->locals,
814 if (local->vrf_id == vrf_id)
815 return VNET_API_ERROR_VALUE_EXIST;
818 pool_get (m->locals, local);
819 local->vrf_id = vrf_id;
821 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
823 m_key.addr = m->local_addr;
824 m_key.port = m->local_port;
825 m_key.protocol = m->proto;
826 m_key.fib_index = local->fib_index;
827 kv.key = m_key.as_u64;
828 kv.value = m - sm->static_mappings;
829 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
833 return VNET_API_ERROR_VALUE_EXIST;
836 if (twice_nat && addr_only)
837 return VNET_API_ERROR_UNSUPPORTED;
839 /* Convert VRF id to FIB index */
842 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
844 /* If not specified use inside VRF id from SNAT plugin startup config */
847 fib_index = sm->inside_fib_index;
848 vrf_id = sm->inside_vrf_id;
849 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
852 if (!(out2in_only || identity_nat))
855 m_key.port = addr_only ? 0 : l_port;
856 m_key.protocol = addr_only ? 0 : proto;
857 m_key.fib_index = fib_index;
858 kv.key = m_key.as_u64;
859 if (!clib_bihash_search_8_8
860 (&sm->static_mapping_by_local, &kv, &value))
861 return VNET_API_ERROR_VALUE_EXIST;
864 /* Find external address in allocated addresses and reserve port for
865 address and port pair mapping when dynamic translations enabled */
866 if (!(addr_only || sm->static_mapping_only || out2in_only))
868 for (i = 0; i < vec_len (sm->addresses); i++)
870 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
872 a = sm->addresses + i;
873 /* External port must be unused */
876 #define _(N, j, n, s) \
877 case SNAT_PROTOCOL_##N: \
878 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
879 return VNET_API_ERROR_INVALID_VALUE; \
880 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
883 a->busy_##n##_ports++; \
884 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
887 foreach_snat_protocol
890 nat_elog_info ("unknown protocol");
891 return VNET_API_ERROR_INVALID_VALUE_2;
896 /* External address must be allocated */
897 if (!a && (l_addr.as_u32 != e_addr.as_u32))
899 if (sw_if_index != ~0)
901 for (i = 0; i < vec_len (sm->to_resolve); i++)
903 rp = sm->to_resolve + i;
906 if (rp->sw_if_index != sw_if_index &&
907 rp->l_addr.as_u32 != l_addr.as_u32 &&
908 rp->vrf_id != vrf_id && rp->l_port != l_port &&
909 rp->e_port != e_port && rp->proto != proto)
912 vec_del1 (sm->to_resolve, i);
916 return VNET_API_ERROR_NO_SUCH_ENTRY;
920 pool_get (sm->static_mappings, m);
921 clib_memset (m, 0, sizeof (*m));
922 m->tag = vec_dup (tag);
923 m->local_addr = l_addr;
924 m->external_addr = e_addr;
925 m->twice_nat = twice_nat;
927 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
929 m->flags |= NAT_STATIC_MAPPING_FLAG_ADDR_ONLY;
932 m->flags |= NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT;
933 pool_get (m->locals, local);
934 local->vrf_id = vrf_id;
935 local->fib_index = fib_index;
940 m->fib_index = fib_index;
944 m->local_port = l_port;
945 m->external_port = e_port;
949 if (sm->num_workers > 1)
952 .src_address = m->local_addr,
954 vec_add1 (m->workers, sm->worker_in2out_cb (&ip, m->fib_index, 0));
955 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
958 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
960 m_key.addr = m->local_addr;
961 m_key.port = m->local_port;
962 m_key.protocol = m->proto;
963 m_key.fib_index = fib_index;
964 kv.key = m_key.as_u64;
965 kv.value = m - sm->static_mappings;
967 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
969 m_key.addr = m->external_addr;
970 m_key.port = m->external_port;
972 kv.key = m_key.as_u64;
973 kv.value = m - sm->static_mappings;
974 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1);
976 /* Delete dynamic sessions matching local address (+ local port) */
977 if (!(sm->static_mapping_only))
979 u_key.addr = m->local_addr;
980 u_key.fib_index = m->fib_index;
981 kv.key = u_key.as_u64;
982 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
984 user_index = value.value;
985 u = pool_elt_at_index (tsm->users, user_index);
988 head_index = u->sessions_per_user_list_head_index;
989 head = pool_elt_at_index (tsm->list_pool, head_index);
990 elt_index = head->next;
991 elt = pool_elt_at_index (tsm->list_pool, elt_index);
992 ses_index = elt->value;
993 while (ses_index != ~0)
995 s = pool_elt_at_index (tsm->sessions, ses_index);
996 elt = pool_elt_at_index (tsm->list_pool, elt->next);
997 ses_index = elt->value;
999 if (snat_is_session_static (s))
1003 && (clib_net_to_host_u16 (s->in2out.port) !=
1007 nat_free_session_data (sm, s,
1008 tsm - sm->per_thread_data, 0);
1009 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1011 if (!addr_only && !sm->endpoint_dependent)
1022 if (sw_if_index != ~0)
1025 return VNET_API_ERROR_NO_SUCH_ENTRY;
1031 vrf_id = sm->inside_vrf_id;
1034 pool_foreach (local, m->locals,
1036 if (local->vrf_id == vrf_id)
1037 find = local - m->locals;
1041 return VNET_API_ERROR_NO_SUCH_ENTRY;
1043 local = pool_elt_at_index (m->locals, find);
1044 fib_index = local->fib_index;
1045 pool_put (m->locals, local);
1048 fib_index = m->fib_index;
1050 /* Free external address port */
1051 if (!(addr_only || sm->static_mapping_only || out2in_only))
1053 for (i = 0; i < vec_len (sm->addresses); i++)
1055 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1057 a = sm->addresses + i;
1060 #define _(N, j, n, s) \
1061 case SNAT_PROTOCOL_##N: \
1062 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
1063 if (e_port > 1024) \
1065 a->busy_##n##_ports--; \
1066 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1069 foreach_snat_protocol
1072 nat_elog_info ("unknown protocol");
1073 return VNET_API_ERROR_INVALID_VALUE_2;
1080 if (sm->num_workers > 1)
1081 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1083 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1085 m_key.addr = m->local_addr;
1086 m_key.port = m->local_port;
1087 m_key.protocol = m->proto;
1088 m_key.fib_index = fib_index;
1089 kv.key = m_key.as_u64;
1091 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0);
1093 /* Delete session(s) for static mapping if exist */
1094 if (!(sm->static_mapping_only) ||
1095 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
1097 u_key.addr = m->local_addr;
1098 u_key.fib_index = fib_index;
1099 kv.key = u_key.as_u64;
1100 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1102 user_index = value.value;
1103 u = pool_elt_at_index (tsm->users, user_index);
1104 if (u->nstaticsessions)
1106 head_index = u->sessions_per_user_list_head_index;
1107 head = pool_elt_at_index (tsm->list_pool, head_index);
1108 elt_index = head->next;
1109 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1110 ses_index = elt->value;
1111 while (ses_index != ~0)
1113 s = pool_elt_at_index (tsm->sessions, ses_index);
1114 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1115 ses_index = elt->value;
1119 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
1120 (clib_net_to_host_u16 (s->out2in.port) !=
1125 if (is_lb_session (s))
1128 if (!snat_is_session_static (s))
1131 nat_free_session_data (sm, s,
1132 tsm - sm->per_thread_data, 0);
1133 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1135 if (!addr_only && !sm->endpoint_dependent)
1142 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1143 if (pool_elts (m->locals))
1146 m_key.addr = m->external_addr;
1147 m_key.port = m->external_port;
1148 m_key.fib_index = 0;
1149 kv.key = m_key.as_u64;
1150 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0);
1153 vec_free (m->workers);
1154 /* Delete static mapping from pool */
1155 pool_put (sm->static_mappings, m);
1158 if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
1161 /* Add/delete external address to FIB */
1163 pool_foreach (interface, sm->interfaces,
1165 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1168 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1171 pool_foreach (interface, sm->output_feature_interfaces,
1173 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1176 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1185 nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1186 snat_protocol_t proto,
1187 nat44_lb_addr_port_t * locals, u8 is_add,
1188 twice_nat_type_t twice_nat, u8 out2in_only,
1189 u8 * tag, u32 affinity)
1191 snat_main_t *sm = &snat_main;
1192 snat_static_mapping_t *m;
1193 snat_session_key_t m_key;
1194 clib_bihash_kv_8_8_t kv, value;
1195 snat_address_t *a = 0;
1197 nat44_lb_addr_port_t *local;
1198 u32 elt_index, head_index, ses_index;
1199 snat_main_per_thread_data_t *tsm;
1200 snat_user_key_t u_key;
1203 dlist_elt_t *head, *elt;
1206 if (!sm->endpoint_dependent)
1207 return VNET_API_ERROR_FEATURE_DISABLED;
1209 m_key.addr = e_addr;
1210 m_key.port = e_port;
1211 m_key.protocol = proto;
1212 m_key.fib_index = 0;
1213 kv.key = m_key.as_u64;
1214 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1217 m = pool_elt_at_index (sm->static_mappings, value.value);
1222 return VNET_API_ERROR_VALUE_EXIST;
1224 if (vec_len (locals) < 2)
1225 return VNET_API_ERROR_INVALID_VALUE;
1227 /* Find external address in allocated addresses and reserve port for
1228 address and port pair mapping when dynamic translations enabled */
1229 if (!(sm->static_mapping_only || out2in_only))
1231 for (i = 0; i < vec_len (sm->addresses); i++)
1233 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1235 a = sm->addresses + i;
1236 /* External port must be unused */
1239 #define _(N, j, n, s) \
1240 case SNAT_PROTOCOL_##N: \
1241 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
1242 return VNET_API_ERROR_INVALID_VALUE; \
1243 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
1244 if (e_port > 1024) \
1246 a->busy_##n##_ports++; \
1247 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1250 foreach_snat_protocol
1253 nat_elog_info ("unknown protocol");
1254 return VNET_API_ERROR_INVALID_VALUE_2;
1259 /* External address must be allocated */
1261 return VNET_API_ERROR_NO_SUCH_ENTRY;
1264 pool_get (sm->static_mappings, m);
1265 clib_memset (m, 0, sizeof (*m));
1266 m->tag = vec_dup (tag);
1267 m->external_addr = e_addr;
1268 m->external_port = e_port;
1270 m->twice_nat = twice_nat;
1271 m->flags |= NAT_STATIC_MAPPING_FLAG_LB;
1273 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1274 m->affinity = affinity;
1277 m->affinity_per_service_list_head_index =
1278 nat_affinity_get_per_service_list_head_index ();
1280 m->affinity_per_service_list_head_index = ~0;
1282 m_key.addr = m->external_addr;
1283 m_key.port = m->external_port;
1284 m_key.protocol = m->proto;
1285 m_key.fib_index = 0;
1286 kv.key = m_key.as_u64;
1287 kv.value = m - sm->static_mappings;
1288 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1))
1290 nat_elog_err ("static_mapping_by_external key add failed");
1291 return VNET_API_ERROR_UNSPECIFIED;
1294 m_key.fib_index = m->fib_index;
1295 for (i = 0; i < vec_len (locals); i++)
1297 locals[i].fib_index =
1298 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
1301 m_key.addr = locals[i].addr;
1302 m_key.fib_index = locals[i].fib_index;
1305 m_key.port = locals[i].port;
1306 kv.key = m_key.as_u64;
1307 kv.value = m - sm->static_mappings;
1308 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1310 locals[i].prefix = (i == 0) ? locals[i].probability :
1311 (locals[i - 1].prefix + locals[i].probability);
1312 pool_get (m->locals, local);
1314 if (sm->num_workers > 1)
1317 .src_address = locals[i].addr,
1320 clib_bitmap_set (bitmap,
1321 sm->worker_in2out_cb (&ip, m->fib_index, 0),
1326 /* Assign workers */
1327 if (sm->num_workers > 1)
1330 clib_bitmap_foreach (i, bitmap,
1332 vec_add1(m->workers, i);
1340 return VNET_API_ERROR_NO_SUCH_ENTRY;
1342 if (!is_lb_static_mapping (m))
1343 return VNET_API_ERROR_INVALID_VALUE;
1345 /* Free external address port */
1346 if (!(sm->static_mapping_only || out2in_only))
1348 for (i = 0; i < vec_len (sm->addresses); i++)
1350 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1352 a = sm->addresses + i;
1355 #define _(N, j, n, s) \
1356 case SNAT_PROTOCOL_##N: \
1357 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
1358 if (e_port > 1024) \
1360 a->busy_##n##_ports--; \
1361 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1364 foreach_snat_protocol
1367 nat_elog_info ("unknown protocol");
1368 return VNET_API_ERROR_INVALID_VALUE_2;
1375 m_key.addr = m->external_addr;
1376 m_key.port = m->external_port;
1377 m_key.protocol = m->proto;
1378 m_key.fib_index = 0;
1379 kv.key = m_key.as_u64;
1380 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0))
1382 nat_elog_err ("static_mapping_by_external key del failed");
1383 return VNET_API_ERROR_UNSPECIFIED;
1387 pool_foreach (local, m->locals,
1389 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4,
1391 m_key.addr = local->addr;
1394 m_key.port = local->port;
1395 m_key.fib_index = local->fib_index;
1396 kv.key = m_key.as_u64;
1397 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1399 nat_elog_err ("static_mapping_by_local key del failed");
1400 return VNET_API_ERROR_UNSPECIFIED;
1404 if (sm->num_workers > 1)
1407 .src_address = local->addr,
1409 tsm = vec_elt_at_index (sm->per_thread_data,
1410 sm->worker_in2out_cb (&ip, m->fib_index, 0));
1413 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1415 /* Delete sessions */
1416 u_key.addr = local->addr;
1417 u_key.fib_index = local->fib_index;
1418 kv.key = u_key.as_u64;
1419 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1421 u = pool_elt_at_index (tsm->users, value.value);
1422 if (u->nstaticsessions)
1424 head_index = u->sessions_per_user_list_head_index;
1425 head = pool_elt_at_index (tsm->list_pool, head_index);
1426 elt_index = head->next;
1427 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1428 ses_index = elt->value;
1429 while (ses_index != ~0)
1431 s = pool_elt_at_index (tsm->sessions, ses_index);
1432 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1433 ses_index = elt->value;
1435 if (!(is_lb_session (s)))
1438 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1439 (clib_net_to_host_u16 (s->in2out.port) != local->port))
1442 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1443 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1450 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1451 pool_free (m->locals);
1453 vec_free (m->workers);
1455 pool_put (sm->static_mappings, m);
1462 nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1463 ip4_address_t l_addr, u16 l_port,
1464 snat_protocol_t proto, u32 vrf_id,
1465 u8 probability, u8 is_add)
1467 snat_main_t *sm = &snat_main;
1468 snat_static_mapping_t *m = 0;
1469 snat_session_key_t m_key;
1470 clib_bihash_kv_8_8_t kv, value;
1471 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1472 snat_main_per_thread_data_t *tsm;
1473 snat_user_key_t u_key;
1476 dlist_elt_t *head, *elt;
1477 u32 elt_index, head_index, ses_index, *locals = 0;
1481 if (!sm->endpoint_dependent)
1482 return VNET_API_ERROR_FEATURE_DISABLED;
1484 m_key.addr = e_addr;
1485 m_key.port = e_port;
1486 m_key.protocol = proto;
1487 m_key.fib_index = 0;
1488 kv.key = m_key.as_u64;
1489 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1490 m = pool_elt_at_index (sm->static_mappings, value.value);
1493 return VNET_API_ERROR_NO_SUCH_ENTRY;
1495 if (!is_lb_static_mapping (m))
1496 return VNET_API_ERROR_INVALID_VALUE;
1499 pool_foreach (local, m->locals,
1501 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1502 (local->vrf_id == vrf_id))
1504 match_local = local;
1513 return VNET_API_ERROR_VALUE_EXIST;
1515 pool_get (m->locals, local);
1516 clib_memset (local, 0, sizeof (*local));
1517 local->addr.as_u32 = l_addr.as_u32;
1518 local->port = l_port;
1519 local->probability = probability;
1520 local->vrf_id = vrf_id;
1522 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1525 if (!is_out2in_only_static_mapping (m))
1527 m_key.addr = l_addr;
1528 m_key.port = l_port;
1529 m_key.fib_index = local->fib_index;
1530 kv.key = m_key.as_u64;
1531 kv.value = m - sm->static_mappings;
1532 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1))
1533 nat_elog_err ("static_mapping_by_local key add failed");
1539 return VNET_API_ERROR_NO_SUCH_ENTRY;
1541 if (pool_elts (m->locals) < 3)
1542 return VNET_API_ERROR_UNSPECIFIED;
1544 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1547 if (!is_out2in_only_static_mapping (m))
1549 m_key.addr = l_addr;
1550 m_key.port = l_port;
1551 m_key.fib_index = match_local->fib_index;
1552 kv.key = m_key.as_u64;
1553 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0))
1554 nat_elog_err ("static_mapping_by_local key del failed");
1557 if (sm->num_workers > 1)
1560 .src_address = local->addr,
1562 tsm = vec_elt_at_index (sm->per_thread_data,
1563 sm->worker_in2out_cb (&ip, m->fib_index,
1567 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1569 /* Delete sessions */
1570 u_key.addr = match_local->addr;
1571 u_key.fib_index = match_local->fib_index;
1572 kv.key = u_key.as_u64;
1573 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1575 u = pool_elt_at_index (tsm->users, value.value);
1576 if (u->nstaticsessions)
1578 head_index = u->sessions_per_user_list_head_index;
1579 head = pool_elt_at_index (tsm->list_pool, head_index);
1580 elt_index = head->next;
1581 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1582 ses_index = elt->value;
1583 while (ses_index != ~0)
1585 s = pool_elt_at_index (tsm->sessions, ses_index);
1586 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1587 ses_index = elt->value;
1589 if (!(is_lb_session (s)))
1592 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1593 (clib_net_to_host_u16 (s->in2out.port) !=
1597 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1598 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1603 pool_put (m->locals, match_local);
1606 vec_free (m->workers);
1609 pool_foreach (local, m->locals,
1611 vec_add1 (locals, local - m->locals);
1612 if (sm->num_workers > 1)
1615 ip.src_address.as_u32 = local->addr.as_u32,
1616 bitmap = clib_bitmap_set (bitmap,
1617 sm->worker_in2out_cb (&ip, local->fib_index, 0),
1623 ASSERT (vec_len (locals) > 1);
1625 local = pool_elt_at_index (m->locals, locals[0]);
1626 local->prefix = local->probability;
1627 for (i = 1; i < vec_len (locals); i++)
1629 local = pool_elt_at_index (m->locals, locals[i]);
1630 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1631 local->prefix = local->probability + prev_local->prefix;
1634 /* Assign workers */
1635 if (sm->num_workers > 1)
1638 clib_bitmap_foreach (i, bitmap, ({ vec_add1(m->workers, i); }));
1646 snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1649 snat_address_t *a = 0;
1650 snat_session_t *ses;
1651 u32 *ses_to_be_removed = 0, *ses_index;
1652 snat_main_per_thread_data_t *tsm;
1653 snat_static_mapping_t *m;
1654 snat_interface_t *interface;
1656 snat_address_t *addresses =
1657 twice_nat ? sm->twice_nat_addresses : sm->addresses;
1659 /* Find SNAT address */
1660 for (i = 0; i < vec_len (addresses); i++)
1662 if (addresses[i].addr.as_u32 == addr.as_u32)
1669 return VNET_API_ERROR_NO_SUCH_ENTRY;
1674 pool_foreach (m, sm->static_mappings,
1676 if (m->external_addr.as_u32 == addr.as_u32)
1677 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1678 m->local_port, m->external_port,
1679 m->vrf_id, is_addr_only_static_mapping(m), ~0,
1680 m->proto, 0, m->twice_nat,
1681 is_out2in_only_static_mapping(m), m->tag, is_identity_static_mapping(m));
1687 /* Check if address is used in some static mapping */
1688 if (is_snat_address_used_in_static_mapping (sm, addr))
1690 nat_elog_notice ("address used in static mapping");
1691 return VNET_API_ERROR_UNSPECIFIED;
1695 if (a->fib_index != ~0)
1696 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1698 /* Delete sessions using address */
1699 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1702 vec_foreach (tsm, sm->per_thread_data)
1704 pool_foreach (ses, tsm->sessions, ({
1705 if (ses->out2in.addr.as_u32 == addr.as_u32)
1707 nat_free_session_data (sm, ses, tsm - sm->per_thread_data, 0);
1708 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1712 vec_foreach (ses_index, ses_to_be_removed)
1714 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1715 nat44_delete_session (sm, ses, tsm - sm->per_thread_data);
1718 vec_free (ses_to_be_removed);
1723 #define _(N, i, n, s) \
1724 clib_bitmap_free (a->busy_##n##_port_bitmap); \
1725 vec_free (a->busy_##n##_ports_per_thread);
1726 foreach_snat_protocol
1730 vec_del1 (sm->twice_nat_addresses, i);
1734 vec_del1 (sm->addresses, i);
1736 /* Delete external address from FIB */
1738 pool_foreach (interface, sm->interfaces,
1740 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1743 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1746 pool_foreach (interface, sm->output_feature_interfaces,
1748 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1751 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1760 snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1762 snat_main_t *sm = &snat_main;
1763 snat_interface_t *i;
1764 const char *feature_name, *del_feature_name;
1766 snat_static_mapping_t *m;
1768 nat_outside_fib_t *outside_fib;
1769 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1772 if (sm->out2in_dpo && !is_inside)
1773 return VNET_API_ERROR_UNSUPPORTED;
1776 pool_foreach (i, sm->output_feature_interfaces,
1778 if (i->sw_if_index == sw_if_index)
1779 return VNET_API_ERROR_VALUE_EXIST;
1783 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1784 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1787 if (sm->num_workers > 1 && !sm->deterministic)
1789 is_inside ? "nat44-in2out-worker-handoff" :
1790 "nat44-out2in-worker-handoff";
1791 else if (sm->deterministic)
1792 feature_name = is_inside ? "nat44-det-in2out" : "nat44-det-out2in";
1793 else if (sm->endpoint_dependent)
1795 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1798 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1801 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1802 sm->fq_in2out_index =
1803 vlib_frame_queue_main_init (sm->handoff_in2out_index, NAT_FQ_NELTS);
1805 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1806 sm->fq_out2in_index =
1807 vlib_frame_queue_main_init (sm->handoff_out2in_index, NAT_FQ_NELTS);
1812 vec_foreach (outside_fib, sm->outside_fibs)
1814 if (outside_fib->fib_index == fib_index)
1818 outside_fib->refcount--;
1819 if (!outside_fib->refcount)
1820 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1823 outside_fib->refcount++;
1830 vec_add2 (sm->outside_fibs, outside_fib, 1);
1831 outside_fib->refcount = 1;
1832 outside_fib->fib_index = fib_index;
1837 pool_foreach (i, sm->interfaces,
1839 if (i->sw_if_index == sw_if_index)
1843 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1846 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1848 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1850 if (sm->num_workers > 1 && !sm->deterministic)
1852 del_feature_name = "nat44-handoff-classify";
1853 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1854 "nat44-out2in-worker-handoff";
1856 else if (sm->deterministic)
1858 del_feature_name = "nat44-det-classify";
1859 feature_name = !is_inside ? "nat44-det-in2out" :
1862 else if (sm->endpoint_dependent)
1864 del_feature_name = "nat44-ed-classify";
1865 feature_name = !is_inside ? "nat-pre-in2out" :
1870 del_feature_name = "nat44-classify";
1871 feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1874 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1877 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1878 sw_if_index, 0, 0, 0);
1879 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1880 sw_if_index, 1, 0, 0);
1883 if (sm->endpoint_dependent)
1884 vnet_feature_enable_disable ("ip4-local",
1885 "nat44-ed-hairpinning",
1886 sw_if_index, 1, 0, 0);
1887 else if (!sm->deterministic)
1888 vnet_feature_enable_disable ("ip4-local",
1889 "nat44-hairpinning",
1890 sw_if_index, 1, 0, 0);
1895 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1898 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1899 sw_if_index, 0, 0, 0);
1900 pool_put (sm->interfaces, i);
1903 if (sm->endpoint_dependent)
1904 vnet_feature_enable_disable ("ip4-local",
1905 "nat44-ed-hairpinning",
1906 sw_if_index, 0, 0, 0);
1907 else if (!sm->deterministic)
1908 vnet_feature_enable_disable ("ip4-local",
1909 "nat44-hairpinning",
1910 sw_if_index, 0, 0, 0);
1916 if ((nat_interface_is_inside(i) && is_inside) ||
1917 (nat_interface_is_outside(i) && !is_inside))
1920 if (sm->num_workers > 1 && !sm->deterministic)
1922 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1923 "nat44-out2in-worker-handoff";
1924 feature_name = "nat44-handoff-classify";
1926 else if (sm->deterministic)
1928 del_feature_name = !is_inside ? "nat44-det-in2out" :
1930 feature_name = "nat44-det-classify";
1932 else if (sm->endpoint_dependent)
1934 del_feature_name = !is_inside ? "nat-pre-in2out" :
1937 feature_name = "nat44-ed-classify";
1941 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1942 feature_name = "nat44-classify";
1945 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1948 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1949 sw_if_index, 0, 0, 0);
1950 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1951 sw_if_index, 1, 0, 0);
1954 if (sm->endpoint_dependent)
1955 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
1956 sw_if_index, 0, 0, 0);
1957 else if (!sm->deterministic)
1958 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1959 sw_if_index, 0, 0, 0);
1970 return VNET_API_ERROR_NO_SUCH_ENTRY;
1972 pool_get (sm->interfaces, i);
1973 i->sw_if_index = sw_if_index;
1975 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0,
1978 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1982 if (is_inside && !sm->out2in_dpo)
1984 if (sm->endpoint_dependent)
1985 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
1986 sw_if_index, 1, 0, 0);
1987 else if (!sm->deterministic)
1988 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1989 sw_if_index, 1, 0, 0);
1995 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1999 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2001 /* Add/delete external addresses to FIB */
2004 vec_foreach (ap, sm->addresses)
2005 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2007 pool_foreach (m, sm->static_mappings,
2009 if (!(is_addr_only_static_mapping(m)) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2012 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2015 pool_foreach (dm, sm->det_maps,
2017 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
2025 snat_interface_add_del_output_feature (u32 sw_if_index,
2026 u8 is_inside, int is_del)
2028 snat_main_t *sm = &snat_main;
2029 snat_interface_t *i;
2031 snat_static_mapping_t *m;
2032 nat_outside_fib_t *outside_fib;
2033 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
2037 if (sm->deterministic ||
2038 (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
2039 return VNET_API_ERROR_UNSUPPORTED;
2042 pool_foreach (i, sm->interfaces,
2044 if (i->sw_if_index == sw_if_index)
2045 return VNET_API_ERROR_VALUE_EXIST;
2052 vec_foreach (outside_fib, sm->outside_fibs)
2054 if (outside_fib->fib_index == fib_index)
2058 outside_fib->refcount--;
2059 if (!outside_fib->refcount)
2060 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2063 outside_fib->refcount++;
2070 vec_add2 (sm->outside_fibs, outside_fib, 1);
2071 outside_fib->refcount = 1;
2072 outside_fib->fib_index = fib_index;
2079 if (sm->endpoint_dependent)
2082 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2086 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2090 vnet_feature_enable_disable ("ip4-unicast", "nat44-ed-hairpin-dst",
2091 sw_if_index, !is_del, 0, 0);
2092 vnet_feature_enable_disable ("ip4-output", "nat44-ed-hairpin-src",
2093 sw_if_index, !is_del, 0, 0);
2098 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2102 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2106 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
2107 sw_if_index, !is_del, 0, 0);
2108 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
2109 sw_if_index, !is_del, 0, 0);
2114 if (sm->num_workers > 1)
2116 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2120 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, !is_del);
2123 vnet_feature_enable_disable ("ip4-unicast",
2124 "nat44-out2in-worker-handoff",
2125 sw_if_index, !is_del, 0, 0);
2126 vnet_feature_enable_disable ("ip4-output",
2127 "nat44-in2out-output-worker-handoff",
2128 sw_if_index, !is_del, 0, 0);
2132 if (sm->endpoint_dependent)
2135 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2139 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2143 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
2144 sw_if_index, !is_del, 0, 0);
2145 vnet_feature_enable_disable ("ip4-output", "nat44-ed-in2out-output",
2146 sw_if_index, !is_del, 0, 0);
2151 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2155 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2159 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in",
2160 sw_if_index, !is_del, 0, 0);
2161 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
2162 sw_if_index, !is_del, 0, 0);
2167 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
2168 sm->fq_in2out_output_index =
2169 vlib_frame_queue_main_init (sm->handoff_in2out_output_index, 0);
2171 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
2172 sm->fq_out2in_index =
2173 vlib_frame_queue_main_init (sm->handoff_out2in_index, 0);
2176 pool_foreach (i, sm->output_feature_interfaces,
2178 if (i->sw_if_index == sw_if_index)
2181 pool_put (sm->output_feature_interfaces, i);
2183 return VNET_API_ERROR_VALUE_EXIST;
2191 return VNET_API_ERROR_NO_SUCH_ENTRY;
2193 pool_get (sm->output_feature_interfaces, i);
2194 i->sw_if_index = sw_if_index;
2197 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2199 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2201 /* Add/delete external addresses to FIB */
2207 vec_foreach (ap, sm->addresses)
2208 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2210 pool_foreach (m, sm->static_mappings,
2212 if (!((is_addr_only_static_mapping(m))) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2215 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2223 snat_set_workers (uword * bitmap)
2225 snat_main_t *sm = &snat_main;
2228 if (sm->num_workers < 2)
2229 return VNET_API_ERROR_FEATURE_DISABLED;
2231 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2232 return VNET_API_ERROR_INVALID_WORKER;
2234 vec_free (sm->workers);
2236 clib_bitmap_foreach (i, bitmap,
2238 vec_add1(sm->workers, i);
2239 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2240 sm->per_thread_data[sm->first_worker_index + i].thread_index = i;
2245 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
2246 sm->num_snat_thread = _vec_len (sm->workers);
2252 snat_update_outside_fib (u32 sw_if_index, u32 new_fib_index,
2255 snat_main_t *sm = &snat_main;
2256 nat_outside_fib_t *outside_fib;
2257 snat_interface_t *i;
2261 if (new_fib_index == old_fib_index)
2264 if (!vec_len (sm->outside_fibs))
2268 pool_foreach (i, sm->interfaces,
2270 if (i->sw_if_index == sw_if_index)
2272 if (!(nat_interface_is_outside (i)))
2278 pool_foreach (i, sm->output_feature_interfaces,
2280 if (i->sw_if_index == sw_if_index)
2282 if (!(nat_interface_is_outside (i)))
2292 vec_foreach (outside_fib, sm->outside_fibs)
2294 if (outside_fib->fib_index == old_fib_index)
2296 outside_fib->refcount--;
2297 if (!outside_fib->refcount)
2298 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2303 vec_foreach (outside_fib, sm->outside_fibs)
2305 if (outside_fib->fib_index == new_fib_index)
2307 outside_fib->refcount++;
2315 vec_add2 (sm->outside_fibs, outside_fib, 1);
2316 outside_fib->refcount = 1;
2317 outside_fib->fib_index = new_fib_index;
2322 snat_ip4_table_bind (ip4_main_t * im,
2324 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
2326 snat_update_outside_fib (sw_if_index, new_fib_index, old_fib_index);
2330 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2333 ip4_address_t * address,
2335 u32 if_address_index, u32 is_delete);
2338 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
2341 ip4_address_t * address,
2343 u32 if_address_index, u32 is_delete);
2346 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2349 snat_session_key_t * k,
2350 u16 port_per_thread, u32 snat_thread_index);
2352 static clib_error_t *
2353 snat_init (vlib_main_t * vm)
2355 snat_main_t *sm = &snat_main;
2356 clib_error_t *error = 0;
2357 ip4_main_t *im = &ip4_main;
2358 ip_lookup_main_t *lm = &im->lookup_main;
2360 vlib_thread_registration_t *tr;
2361 vlib_thread_main_t *tm = vlib_get_thread_main ();
2364 ip4_add_del_interface_address_callback_t cb4;
2368 sm->vnet_main = vnet_get_main ();
2370 sm->ip4_lookup_main = lm;
2371 sm->api_main = vlibapi_get_main ();
2372 sm->first_worker_index = 0;
2373 sm->num_workers = 0;
2374 sm->num_snat_thread = 1;
2376 sm->port_per_thread = 0xffff - 1024;
2377 sm->fq_in2out_index = ~0;
2378 sm->fq_in2out_output_index = ~0;
2379 sm->fq_out2in_index = ~0;
2382 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
2383 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
2384 sm->forwarding_enabled = 0;
2385 sm->log_class = vlib_log_register_class ("nat", 0);
2386 sm->log_level = SNAT_LOG_ERROR;
2387 sm->mss_clamping = 0;
2389 node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
2390 sm->error_node_index = node->index;
2392 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2393 sm->pre_in2out_node_index = node->index;
2394 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2395 sm->pre_out2in_node_index = node->index;
2397 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2398 sm->pre_in2out_node_index = node->index;
2400 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2401 sm->pre_out2in_node_index = node->index;
2403 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out");
2404 sm->in2out_node_index = node->index;
2405 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output");
2406 sm->in2out_output_node_index = node->index;
2407 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-fast");
2408 sm->in2out_fast_node_index = node->index;
2409 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-slowpath");
2410 sm->in2out_slowpath_node_index = node->index;
2411 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output-slowpath");
2412 sm->in2out_slowpath_output_node_index = node->index;
2414 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out");
2415 sm->ed_in2out_node_index = node->index;
2416 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-slowpath");
2417 sm->ed_in2out_slowpath_node_index = node->index;
2419 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in");
2420 sm->out2in_node_index = node->index;
2421 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in-fast");
2422 sm->out2in_fast_node_index = node->index;
2424 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in");
2425 sm->ed_out2in_node_index = node->index;
2426 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in-slowpath");
2427 sm->ed_out2in_slowpath_node_index = node->index;
2429 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-in2out");
2430 sm->det_in2out_node_index = node->index;
2431 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-out2in");
2432 sm->det_out2in_node_index = node->index;
2434 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpinning");
2435 sm->hairpinning_node_index = node->index;
2436 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-dst");
2437 sm->hairpin_dst_node_index = node->index;
2438 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-src");
2439 sm->hairpin_src_node_index = node->index;
2440 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpinning");
2441 sm->ed_hairpinning_node_index = node->index;
2442 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-dst");
2443 sm->ed_hairpin_dst_node_index = node->index;
2444 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-src");
2445 sm->ed_hairpin_src_node_index = node->index;
2447 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2450 tr = (vlib_thread_registration_t *) p[0];
2453 sm->num_workers = tr->count;
2454 sm->first_worker_index = tr->first_index;
2458 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2460 /* Use all available workers by default */
2461 if (sm->num_workers > 1)
2463 for (i = 0; i < sm->num_workers; i++)
2464 bitmap = clib_bitmap_set (bitmap, i, 1);
2465 snat_set_workers (bitmap);
2466 clib_bitmap_free (bitmap);
2470 sm->per_thread_data[0].snat_thread_index = 0;
2473 error = snat_api_init (vm, sm);
2477 /* Set up the interface address add/del callback */
2478 cb4.function = snat_ip4_add_del_interface_address_cb;
2479 cb4.function_opaque = 0;
2481 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2483 cb4.function = nat_ip4_add_del_addr_only_sm_cb;
2484 cb4.function_opaque = 0;
2486 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2488 nat_dpo_module_init ();
2491 sm->total_users.name = "total-users";
2492 sm->total_users.stat_segment_name = "/nat44/total-users";
2493 vlib_validate_simple_counter (&sm->total_users, 0);
2494 vlib_zero_simple_counter (&sm->total_users, 0);
2495 sm->total_sessions.name = "total-sessions";
2496 sm->total_sessions.stat_segment_name = "/nat44/total-sessions";
2497 vlib_validate_simple_counter (&sm->total_sessions, 0);
2498 vlib_zero_simple_counter (&sm->total_sessions, 0);
2500 /* Init IPFIX logging */
2501 snat_ipfix_logging_init (vm);
2504 error = nat64_init (vm);
2512 ip4_table_bind_callback_t cbt4 = {
2513 .function = snat_ip4_table_bind,
2515 vec_add1 (ip4_main.table_bind_callbacks, cbt4);
2517 nat_fib_src_hi = fib_source_allocate ("nat-hi",
2518 FIB_SOURCE_PRIORITY_HI,
2519 FIB_SOURCE_BH_SIMPLE);
2520 nat_fib_src_low = fib_source_allocate ("nat-low",
2521 FIB_SOURCE_PRIORITY_LOW,
2522 FIB_SOURCE_BH_SIMPLE);
2527 VLIB_INIT_FUNCTION (snat_init);
2530 snat_free_outside_address_and_port (snat_address_t * addresses,
2531 u32 thread_index, snat_session_key_t * k)
2535 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2537 for (address_index = 0; address_index < vec_len (addresses);
2540 if (addresses[address_index].addr.as_u32 == k->addr.as_u32)
2544 ASSERT (address_index < vec_len (addresses));
2546 a = addresses + address_index;
2548 switch (k->protocol)
2550 #define _(N, i, n, s) \
2551 case SNAT_PROTOCOL_##N: \
2552 ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
2553 port_host_byte_order) == 1); \
2554 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
2555 port_host_byte_order, 0); \
2556 a->busy_##n##_ports--; \
2557 a->busy_##n##_ports_per_thread[thread_index]--; \
2559 foreach_snat_protocol
2562 nat_elog_info ("unknown protocol");
2568 nat_set_outside_address_and_port (snat_address_t * addresses,
2569 u32 thread_index, snat_session_key_t * k)
2571 snat_address_t *a = 0;
2573 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2575 for (address_index = 0; address_index < vec_len (addresses);
2578 if (addresses[address_index].addr.as_u32 != k->addr.as_u32)
2581 a = addresses + address_index;
2582 switch (k->protocol)
2584 #define _(N, j, n, s) \
2585 case SNAT_PROTOCOL_##N: \
2586 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, port_host_byte_order)) \
2587 return VNET_API_ERROR_INSTANCE_IN_USE; \
2588 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, port_host_byte_order, 1); \
2589 a->busy_##n##_ports_per_thread[thread_index]++; \
2590 a->busy_##n##_ports++; \
2592 foreach_snat_protocol
2595 nat_elog_info ("unknown protocol");
2600 return VNET_API_ERROR_NO_SUCH_ENTRY;
2604 snat_static_mapping_match (snat_main_t * sm,
2605 snat_session_key_t match,
2606 snat_session_key_t * mapping,
2609 twice_nat_type_t * twice_nat,
2610 lb_nat_type_t * lb, ip4_address_t * ext_host_addr,
2611 u8 * is_identity_nat)
2613 clib_bihash_kv_8_8_t kv, value;
2614 snat_static_mapping_t *m;
2615 snat_session_key_t m_key;
2616 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
2617 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2619 nat44_lb_addr_port_t *local;
2621 m_key.fib_index = match.fib_index;
2624 mapping_hash = &sm->static_mapping_by_external;
2625 m_key.fib_index = 0;
2628 m_key.addr = match.addr;
2629 m_key.port = clib_net_to_host_u16 (match.port);
2630 m_key.protocol = match.protocol;
2632 kv.key = m_key.as_u64;
2634 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2636 /* Try address only mapping */
2639 kv.key = m_key.as_u64;
2640 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2644 m = pool_elt_at_index (sm->static_mappings, value.value);
2648 if (is_lb_static_mapping (m))
2650 if (PREDICT_FALSE (lb != 0))
2651 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2652 if (m->affinity && !nat_affinity_find_and_lock (ext_host_addr[0],
2658 local = pool_elt_at_index (m->locals, backend_index);
2659 mapping->addr = local->addr;
2660 mapping->port = clib_host_to_net_u16 (local->port);
2661 mapping->fib_index = local->fib_index;
2664 // pick locals matching this worker
2665 if (PREDICT_FALSE (sm->num_workers > 1))
2667 u32 thread_index = vlib_get_thread_index ();
2669 pool_foreach_index (i, m->locals,
2671 local = pool_elt_at_index (m->locals, i);
2674 .src_address = local->addr,
2677 if (sm->worker_in2out_cb (&ip, m->fib_index, 0) ==
2684 ASSERT (vec_len (tmp) != 0);
2689 pool_foreach_index (i, m->locals,
2695 hi = vec_len (tmp) - 1;
2696 local = pool_elt_at_index (m->locals, tmp[hi]);
2697 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2700 mid = ((hi - lo) >> 1) + lo;
2701 local = pool_elt_at_index (m->locals, tmp[mid]);
2702 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2704 local = pool_elt_at_index (m->locals, tmp[lo]);
2705 if (!(local->prefix >= rand))
2707 mapping->addr = local->addr;
2708 mapping->port = clib_host_to_net_u16 (local->port);
2709 mapping->fib_index = local->fib_index;
2712 if (nat_affinity_create_and_lock (ext_host_addr[0], match.addr,
2713 match.protocol, match.port,
2714 tmp[lo], m->affinity,
2715 m->affinity_per_service_list_head_index))
2716 nat_elog_info ("create affinity record failed");
2722 if (PREDICT_FALSE (lb != 0))
2724 mapping->fib_index = m->fib_index;
2725 mapping->addr = m->local_addr;
2726 /* Address only mapping doesn't change port */
2727 mapping->port = is_addr_only_static_mapping (m) ? match.port
2728 : clib_host_to_net_u16 (m->local_port);
2730 mapping->protocol = m->proto;
2734 mapping->addr = m->external_addr;
2735 /* Address only mapping doesn't change port */
2736 mapping->port = is_addr_only_static_mapping (m) ? match.port
2737 : clib_host_to_net_u16 (m->external_port);
2738 mapping->fib_index = sm->outside_fib_index;
2742 if (PREDICT_FALSE (is_addr_only != 0))
2743 *is_addr_only = is_addr_only_static_mapping (m);
2745 if (PREDICT_FALSE (twice_nat != 0))
2746 *twice_nat = m->twice_nat;
2748 if (PREDICT_FALSE (is_identity_nat != 0))
2749 *is_identity_nat = is_identity_static_mapping (m);
2754 static_always_inline u16
2755 snat_random_port (u16 min, u16 max)
2757 snat_main_t *sm = &snat_main;
2758 return min + random_u32 (&sm->random_seed) /
2759 (random_u32_max () / (max - min + 1) + 1);
2763 snat_alloc_outside_address_and_port (snat_address_t * addresses,
2766 snat_session_key_t * k,
2767 u16 port_per_thread,
2768 u32 snat_thread_index)
2770 snat_main_t *sm = &snat_main;
2772 return sm->alloc_addr_and_port (addresses, fib_index, thread_index, k,
2773 port_per_thread, snat_thread_index);
2777 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2780 snat_session_key_t * k,
2781 u16 port_per_thread, u32 snat_thread_index)
2784 snat_address_t *a, *ga = 0;
2787 for (i = 0; i < vec_len (addresses); i++)
2790 switch (k->protocol)
2792 #define _(N, j, n, s) \
2793 case SNAT_PROTOCOL_##N: \
2794 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
2796 if (a->fib_index == fib_index) \
2800 portnum = (port_per_thread * \
2801 snat_thread_index) + \
2802 snat_random_port(1, port_per_thread) + 1024; \
2803 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2805 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2806 a->busy_##n##_ports_per_thread[thread_index]++; \
2807 a->busy_##n##_ports++; \
2808 k->addr = a->addr; \
2809 k->port = clib_host_to_net_u16(portnum); \
2813 else if (a->fib_index == ~0) \
2819 foreach_snat_protocol
2822 nat_elog_info ("unknown protocol");
2831 switch (k->protocol)
2833 #define _(N, j, n, s) \
2834 case SNAT_PROTOCOL_##N: \
2837 portnum = (port_per_thread * \
2838 snat_thread_index) + \
2839 snat_random_port(1, port_per_thread) + 1024; \
2840 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2842 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2843 a->busy_##n##_ports_per_thread[thread_index]++; \
2844 a->busy_##n##_ports++; \
2845 k->addr = a->addr; \
2846 k->port = clib_host_to_net_u16(portnum); \
2850 foreach_snat_protocol
2853 nat_elog_info ("unknown protocol");
2858 /* Totally out of translations to use... */
2859 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
2864 nat_alloc_addr_and_port_mape (snat_address_t * addresses,
2867 snat_session_key_t * k,
2868 u16 port_per_thread, u32 snat_thread_index)
2870 snat_main_t *sm = &snat_main;
2871 snat_address_t *a = addresses;
2872 u16 m, ports, portnum, A, j;
2873 m = 16 - (sm->psid_offset + sm->psid_length);
2874 ports = (1 << (16 - sm->psid_length)) - (1 << m);
2876 if (!vec_len (addresses))
2879 switch (k->protocol)
2881 #define _(N, i, n, s) \
2882 case SNAT_PROTOCOL_##N: \
2883 if (a->busy_##n##_ports < ports) \
2887 A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
2888 j = snat_random_port(0, pow2_mask(m)); \
2889 portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
2890 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2892 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2893 a->busy_##n##_ports++; \
2894 k->addr = a->addr; \
2895 k->port = clib_host_to_net_u16 (portnum); \
2900 foreach_snat_protocol
2903 nat_elog_info ("unknown protocol");
2908 /* Totally out of translations to use... */
2909 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
2914 nat_alloc_addr_and_port_range (snat_address_t * addresses,
2917 snat_session_key_t * k,
2918 u16 port_per_thread, u32 snat_thread_index)
2920 snat_main_t *sm = &snat_main;
2921 snat_address_t *a = addresses;
2924 ports = sm->end_port - sm->start_port + 1;
2926 if (!vec_len (addresses))
2929 switch (k->protocol)
2931 #define _(N, i, n, s) \
2932 case SNAT_PROTOCOL_##N: \
2933 if (a->busy_##n##_ports < ports) \
2937 portnum = snat_random_port(sm->start_port, sm->end_port); \
2938 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2940 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2941 a->busy_##n##_ports++; \
2942 k->addr = a->addr; \
2943 k->port = clib_host_to_net_u16 (portnum); \
2948 foreach_snat_protocol
2951 nat_elog_info ("unknown protocol");
2956 /* Totally out of translations to use... */
2957 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
2962 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
2964 dpo_id_t dpo_v4 = DPO_INVALID;
2965 fib_prefix_t pfx = {
2966 .fp_proto = FIB_PROTOCOL_IP4,
2968 .fp_addr.ip4.as_u32 = addr.as_u32,
2973 nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
2974 fib_table_entry_special_dpo_add (0, &pfx, nat_fib_src_hi,
2975 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
2976 dpo_reset (&dpo_v4);
2980 fib_table_entry_special_remove (0, &pfx, nat_fib_src_hi);
2985 format_session_kvp (u8 * s, va_list * args)
2987 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
2988 snat_session_key_t k;
2992 s = format (s, "%U session-index %llu", format_snat_key, &k, v->value);
2998 format_static_mapping_kvp (u8 * s, va_list * args)
3000 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3001 snat_session_key_t k;
3005 s = format (s, "%U static-mapping-index %llu",
3006 format_static_mapping_key, &k, v->value);
3012 format_user_kvp (u8 * s, va_list * args)
3014 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3019 s = format (s, "%U fib %d user-index %llu", format_ip4_address, &k.addr,
3020 k.fib_index, v->value);
3026 format_ed_session_kvp (u8 * s, va_list * args)
3028 clib_bihash_kv_16_8_t *v = va_arg (*args, clib_bihash_kv_16_8_t *);
3031 k.as_u64[0] = v->key[0];
3032 k.as_u64[1] = v->key[1];
3035 format (s, "local %U:%d remote %U:%d proto %U fib %d session-index %llu",
3036 format_ip4_address, &k.l_addr, clib_net_to_host_u16 (k.l_port),
3037 format_ip4_address, &k.r_addr, clib_net_to_host_u16 (k.r_port),
3038 format_ip_protocol, k.proto, k.fib_index, v->value);
3044 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0,
3047 snat_main_t *sm = &snat_main;
3048 u32 next_worker_index = 0;
3051 next_worker_index = sm->first_worker_index;
3052 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
3053 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >> 24);
3055 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3056 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3058 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3060 return next_worker_index;
3064 snat_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip0,
3065 u32 rx_fib_index0, u8 is_output)
3067 snat_main_t *sm = &snat_main;
3070 snat_session_key_t m_key;
3071 clib_bihash_kv_8_8_t kv, value;
3072 snat_static_mapping_t *m;
3074 u32 next_worker_index = 0;
3076 /* first try static mappings without port */
3077 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3079 m_key.addr = ip0->dst_address;
3082 m_key.fib_index = rx_fib_index0;
3083 kv.key = m_key.as_u64;
3084 if (!clib_bihash_search_8_8
3085 (&sm->static_mapping_by_external, &kv, &value))
3087 m = pool_elt_at_index (sm->static_mappings, value.value);
3088 return m->workers[0];
3092 proto = ip_proto_to_snat_proto (ip0->protocol);
3093 udp = ip4_next_header (ip0);
3094 port = udp->dst_port;
3096 /* unknown protocol */
3097 if (PREDICT_FALSE (proto == ~0))
3099 /* use current thread */
3100 return vlib_get_thread_index ();
3103 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
3105 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3106 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3107 if (!icmp_type_is_error_message
3108 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3109 port = vnet_buffer (b)->ip.reass.l4_src_port;
3112 /* if error message, then it's not fragmented and we can access it */
3113 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3114 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3115 void *l4_header = ip4_next_header (inner_ip);
3118 case SNAT_PROTOCOL_ICMP:
3119 icmp = (icmp46_header_t *) l4_header;
3120 echo = (icmp_echo_header_t *) (icmp + 1);
3121 port = echo->identifier;
3123 case SNAT_PROTOCOL_UDP:
3124 case SNAT_PROTOCOL_TCP:
3125 port = ((tcp_udp_header_t *) l4_header)->src_port;
3128 return vlib_get_thread_index ();
3133 /* try static mappings with port */
3134 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3136 m_key.addr = ip0->dst_address;
3137 m_key.port = clib_net_to_host_u16 (port);
3138 m_key.protocol = proto;
3139 m_key.fib_index = rx_fib_index0;
3140 kv.key = m_key.as_u64;
3141 if (!clib_bihash_search_8_8
3142 (&sm->static_mapping_by_external, &kv, &value))
3144 m = pool_elt_at_index (sm->static_mappings, value.value);
3145 return m->workers[0];
3149 /* worker by outside port */
3150 next_worker_index = sm->first_worker_index;
3151 next_worker_index +=
3152 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3153 return next_worker_index;
3157 nat44_ed_get_worker_in2out_cb (ip4_header_t * ip, u32 rx_fib_index,
3160 snat_main_t *sm = &snat_main;
3161 u32 next_worker_index = sm->first_worker_index;
3164 clib_bihash_kv_16_8_t kv16, value16;
3165 snat_main_per_thread_data_t *tsm;
3168 if (PREDICT_FALSE (is_output))
3170 u32 fib_index = sm->outside_fib_index;
3171 nat_outside_fib_t *outside_fib;
3172 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3173 fib_prefix_t pfx = {
3174 .fp_proto = FIB_PROTOCOL_IP4,
3177 .ip4.as_u32 = ip->dst_address.as_u32,
3182 udp = ip4_next_header (ip);
3184 switch (vec_len (sm->outside_fibs))
3187 fib_index = sm->outside_fib_index;
3190 fib_index = sm->outside_fibs[0].fib_index;
3194 vec_foreach (outside_fib, sm->outside_fibs)
3196 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3197 if (FIB_NODE_INDEX_INVALID != fei)
3199 if (fib_entry_get_resolving_interface (fei) != ~0)
3201 fib_index = outside_fib->fib_index;
3210 make_ed_kv (&kv16, &ip->src_address, &ip->dst_address,
3211 ip->protocol, fib_index, udp->src_port, udp->dst_port);
3214 vec_foreach (tsm, sm->per_thread_data)
3216 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3219 next_worker_index += tsm->thread_index;
3221 nat_elog_debug_handoff (
3222 "HANDOFF IN2OUT-OUTPUT-FEATURE (session)",
3223 next_worker_index, fib_index,
3224 clib_net_to_host_u32 (ip->src_address.as_u32),
3225 clib_net_to_host_u32 (ip->dst_address.as_u32));
3227 return next_worker_index;
3233 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3234 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3236 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3237 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3239 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3241 if (PREDICT_TRUE (!is_output))
3243 nat_elog_debug_handoff ("HANDOFF IN2OUT",
3244 next_worker_index, rx_fib_index,
3245 clib_net_to_host_u32 (ip->src_address.as_u32),
3246 clib_net_to_host_u32 (ip->dst_address.as_u32));
3250 nat_elog_debug_handoff ("HANDOFF IN2OUT-OUTPUT-FEATURE",
3251 next_worker_index, rx_fib_index,
3252 clib_net_to_host_u32 (ip->src_address.as_u32),
3253 clib_net_to_host_u32 (ip->dst_address.as_u32));
3256 return next_worker_index;
3260 nat44_ed_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip,
3261 u32 rx_fib_index, u8 is_output)
3263 snat_main_t *sm = &snat_main;
3264 clib_bihash_kv_8_8_t kv, value;
3265 clib_bihash_kv_16_8_t kv16, value16;
3266 snat_main_per_thread_data_t *tsm;
3268 u32 proto, next_worker_index = 0;
3271 snat_static_mapping_t *m;
3274 proto = ip_proto_to_snat_proto (ip->protocol);
3276 if (PREDICT_TRUE (proto == SNAT_PROTOCOL_UDP || proto == SNAT_PROTOCOL_TCP))
3278 udp = ip4_next_header (ip);
3280 make_ed_kv (&kv16, &ip->dst_address, &ip->src_address,
3281 ip->protocol, rx_fib_index, udp->dst_port, udp->src_port);
3284 vec_foreach (tsm, sm->per_thread_data)
3286 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3289 next_worker_index = sm->first_worker_index + tsm->thread_index;
3290 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3291 next_worker_index, rx_fib_index,
3292 clib_net_to_host_u32 (ip->src_address.as_u32),
3293 clib_net_to_host_u32 (ip->dst_address.as_u32));
3294 return next_worker_index;
3299 else if (proto == SNAT_PROTOCOL_ICMP)
3301 nat_ed_ses_key_t key;
3303 if (!get_icmp_o2i_ed_key (b, ip, &key))
3306 key.fib_index = rx_fib_index;
3307 kv16.key[0] = key.as_u64[0];
3308 kv16.key[1] = key.as_u64[1];
3311 vec_foreach (tsm, sm->per_thread_data)
3313 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3316 next_worker_index = sm->first_worker_index +
3318 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3319 next_worker_index, rx_fib_index,
3320 clib_net_to_host_u32 (ip->src_address.as_u32),
3321 clib_net_to_host_u32 (ip->dst_address.as_u32));
3322 return next_worker_index;
3329 /* first try static mappings without port */
3330 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3332 make_sm_kv (&kv, &ip->dst_address, 0, 0, 0);
3333 if (!clib_bihash_search_8_8
3334 (&sm->static_mapping_by_external, &kv, &value))
3336 m = pool_elt_at_index (sm->static_mappings, value.value);
3337 next_worker_index = m->workers[0];
3342 /* unknown protocol */
3343 if (PREDICT_FALSE (proto == ~0))
3345 /* use current thread */
3346 next_worker_index = vlib_get_thread_index ();
3350 udp = ip4_next_header (ip);
3351 port = udp->dst_port;
3353 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
3355 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3356 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3357 if (!icmp_type_is_error_message
3358 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3359 port = vnet_buffer (b)->ip.reass.l4_src_port;
3362 /* if error message, then it's not fragmented and we can access it */
3363 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3364 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3365 void *l4_header = ip4_next_header (inner_ip);
3368 case SNAT_PROTOCOL_ICMP:
3369 icmp = (icmp46_header_t *) l4_header;
3370 echo = (icmp_echo_header_t *) (icmp + 1);
3371 port = echo->identifier;
3373 case SNAT_PROTOCOL_UDP:
3374 case SNAT_PROTOCOL_TCP:
3375 port = ((tcp_udp_header_t *) l4_header)->src_port;
3378 next_worker_index = vlib_get_thread_index ();
3384 /* try static mappings with port */
3385 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3387 make_sm_kv (&kv, &ip->dst_address, proto, 0,
3388 clib_net_to_host_u16 (port));
3389 if (!clib_bihash_search_8_8
3390 (&sm->static_mapping_by_external, &kv, &value))
3392 m = pool_elt_at_index (sm->static_mappings, value.value);
3393 if (!is_lb_static_mapping (m))
3395 next_worker_index = m->workers[0];
3399 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3400 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3402 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
3404 m->workers[hash & (_vec_len (m->workers) - 1)];
3406 next_worker_index = m->workers[hash % _vec_len (m->workers)];
3411 /* worker by outside port */
3412 next_worker_index = sm->first_worker_index;
3413 next_worker_index +=
3414 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3417 nat_elog_debug_handoff ("HANDOFF OUT2IN", next_worker_index, rx_fib_index,
3418 clib_net_to_host_u32 (ip->src_address.as_u32),
3419 clib_net_to_host_u32 (ip->dst_address.as_u32));
3420 return next_worker_index;
3424 nat_ha_sadd_cb (ip4_address_t * in_addr, u16 in_port,
3425 ip4_address_t * out_addr, u16 out_port,
3426 ip4_address_t * eh_addr, u16 eh_port,
3427 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3428 u32 fib_index, u16 flags, u32 thread_index)
3430 snat_main_t *sm = &snat_main;
3431 snat_session_key_t key;
3434 clib_bihash_kv_8_8_t kv;
3435 f64 now = vlib_time_now (sm->vlib_main);
3436 nat_outside_fib_t *outside_fib;
3437 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3438 snat_main_per_thread_data_t *tsm;
3439 fib_prefix_t pfx = {
3440 .fp_proto = FIB_PROTOCOL_IP4,
3443 .ip4.as_u32 = eh_addr->as_u32,
3447 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3449 key.addr.as_u32 = out_addr->as_u32;
3450 key.port = out_port;
3451 key.protocol = proto;
3453 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3455 if (nat_set_outside_address_and_port
3456 (sm->addresses, thread_index, &key))
3460 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3464 s = nat_session_alloc_or_recycle (sm, u, thread_index, now);
3468 s->last_heard = now;
3470 s->ext_host_addr.as_u32 = eh_addr->as_u32;
3471 s->ext_host_port = eh_port;
3472 user_session_increment (sm, u, snat_is_session_static (s));
3473 switch (vec_len (sm->outside_fibs))
3476 key.fib_index = sm->outside_fib_index;
3479 key.fib_index = sm->outside_fibs[0].fib_index;
3483 vec_foreach (outside_fib, sm->outside_fibs)
3485 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3486 if (FIB_NODE_INDEX_INVALID != fei)
3488 if (fib_entry_get_resolving_interface (fei) != ~0)
3490 key.fib_index = outside_fib->fib_index;
3499 kv.key = key.as_u64;
3500 kv.value = s - tsm->sessions;
3501 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 1))
3502 nat_elog_warn ("out2in key add failed");
3504 key.addr.as_u32 = in_addr->as_u32;
3506 key.fib_index = fib_index;
3508 kv.key = key.as_u64;
3509 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 1))
3510 nat_elog_warn ("in2out key add failed");
3514 nat_ha_sdel_cb (ip4_address_t * out_addr, u16 out_port,
3515 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3518 snat_main_t *sm = &snat_main;
3519 snat_session_key_t key;
3520 clib_bihash_kv_8_8_t kv, value;
3523 snat_main_per_thread_data_t *tsm;
3525 if (sm->num_workers > 1)
3527 sm->first_worker_index +
3528 (sm->workers[(clib_net_to_host_u16 (out_port) -
3529 1024) / sm->port_per_thread]);
3531 thread_index = sm->num_workers;
3532 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3534 key.addr.as_u32 = out_addr->as_u32;
3535 key.port = out_port;
3536 key.protocol = proto;
3537 key.fib_index = fib_index;
3538 kv.key = key.as_u64;
3539 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3542 s = pool_elt_at_index (tsm->sessions, value.value);
3543 nat_free_session_data (sm, s, thread_index, 1);
3544 nat44_delete_session (sm, s, thread_index);
3548 nat_ha_sref_cb (ip4_address_t * out_addr, u16 out_port,
3549 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3550 u32 total_pkts, u64 total_bytes, u32 thread_index)
3552 snat_main_t *sm = &snat_main;
3553 snat_session_key_t key;
3554 clib_bihash_kv_8_8_t kv, value;
3556 snat_main_per_thread_data_t *tsm;
3558 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3560 key.addr.as_u32 = out_addr->as_u32;
3561 key.port = out_port;
3562 key.protocol = proto;
3563 key.fib_index = fib_index;
3564 kv.key = key.as_u64;
3565 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3568 s = pool_elt_at_index (tsm->sessions, value.value);
3569 s->total_pkts = total_pkts;
3570 s->total_bytes = total_bytes;
3574 nat_ha_sadd_ed_cb (ip4_address_t * in_addr, u16 in_port,
3575 ip4_address_t * out_addr, u16 out_port,
3576 ip4_address_t * eh_addr, u16 eh_port,
3577 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3578 u32 fib_index, u16 flags, u32 thread_index)
3580 snat_main_t *sm = &snat_main;
3581 snat_session_key_t key;
3584 clib_bihash_kv_16_8_t kv;
3585 f64 now = vlib_time_now (sm->vlib_main);
3586 nat_outside_fib_t *outside_fib;
3587 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3588 snat_main_per_thread_data_t *tsm;
3589 fib_prefix_t pfx = {
3590 .fp_proto = FIB_PROTOCOL_IP4,
3593 .ip4.as_u32 = eh_addr->as_u32,
3597 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3599 key.addr.as_u32 = out_addr->as_u32;
3600 key.port = out_port;
3601 key.protocol = proto;
3603 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3605 if (nat_set_outside_address_and_port
3606 (sm->addresses, thread_index, &key))
3610 key.addr.as_u32 = ehn_addr->as_u32;
3611 key.port = ehn_port;
3612 if (flags & SNAT_SESSION_FLAG_TWICE_NAT)
3614 if (nat_set_outside_address_and_port
3615 (sm->twice_nat_addresses, thread_index, &key))
3619 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3623 s = nat_ed_session_alloc (sm, u, thread_index, now);
3627 s->last_heard = now;
3629 s->ext_host_nat_addr.as_u32 = s->ext_host_addr.as_u32 = eh_addr->as_u32;
3630 s->ext_host_nat_port = s->ext_host_port = eh_port;
3631 if (is_twice_nat_session (s))
3633 s->ext_host_nat_addr.as_u32 = ehn_addr->as_u32;
3634 s->ext_host_nat_port = ehn_port;
3636 user_session_increment (sm, u, snat_is_session_static (s));
3637 switch (vec_len (sm->outside_fibs))
3640 key.fib_index = sm->outside_fib_index;
3643 key.fib_index = sm->outside_fibs[0].fib_index;
3647 vec_foreach (outside_fib, sm->outside_fibs)
3649 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3650 if (FIB_NODE_INDEX_INVALID != fei)
3652 if (fib_entry_get_resolving_interface (fei) != ~0)
3654 key.fib_index = outside_fib->fib_index;
3662 key.addr.as_u32 = out_addr->as_u32;
3663 key.port = out_port;
3665 kv.value = s - tsm->sessions;
3667 key.addr.as_u32 = in_addr->as_u32;
3669 key.fib_index = fib_index;
3672 make_ed_kv (&kv, in_addr, &s->ext_host_nat_addr,
3673 snat_proto_to_ip_proto (proto), fib_index, in_port,
3674 s->ext_host_nat_port);
3675 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &kv, 1))
3676 nat_elog_warn ("in2out key add failed");
3678 make_ed_kv (&kv, out_addr, eh_addr, snat_proto_to_ip_proto (proto),
3679 s->out2in.fib_index, out_port, eh_port);
3680 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &kv, 1))
3681 nat_elog_warn ("out2in key add failed");
3685 nat_ha_sdel_ed_cb (ip4_address_t * out_addr, u16 out_port,
3686 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3687 u32 fib_index, u32 ti)
3689 snat_main_t *sm = &snat_main;
3690 nat_ed_ses_key_t key;
3691 clib_bihash_kv_16_8_t kv, value;
3694 snat_main_per_thread_data_t *tsm;
3696 if (sm->num_workers > 1)
3698 sm->first_worker_index +
3699 (sm->workers[(clib_net_to_host_u16 (out_port) -
3700 1024) / sm->port_per_thread]);
3702 thread_index = sm->num_workers;
3703 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3705 key.l_addr.as_u32 = out_addr->as_u32;
3706 key.l_port = out_port;
3707 key.r_addr.as_u32 = eh_addr->as_u32;
3708 key.r_port = eh_port;
3710 key.fib_index = fib_index;
3711 kv.key[0] = key.as_u64[0];
3712 kv.key[1] = key.as_u64[1];
3713 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3716 s = pool_elt_at_index (tsm->sessions, value.value);
3717 nat_free_session_data (sm, s, thread_index, 1);
3718 nat44_delete_session (sm, s, thread_index);
3722 nat_ha_sref_ed_cb (ip4_address_t * out_addr, u16 out_port,
3723 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3724 u32 fib_index, u32 total_pkts, u64 total_bytes,
3727 snat_main_t *sm = &snat_main;
3728 nat_ed_ses_key_t key;
3729 clib_bihash_kv_16_8_t kv, value;
3731 snat_main_per_thread_data_t *tsm;
3733 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3735 key.l_addr.as_u32 = out_addr->as_u32;
3736 key.l_port = out_port;
3737 key.r_addr.as_u32 = eh_addr->as_u32;
3738 key.r_port = eh_port;
3740 key.fib_index = fib_index;
3741 kv.key[0] = key.as_u64[0];
3742 kv.key[1] = key.as_u64[1];
3743 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3746 s = pool_elt_at_index (tsm->sessions, value.value);
3747 s->total_pkts = total_pkts;
3748 s->total_bytes = total_bytes;
3751 static clib_error_t *
3752 snat_config (vlib_main_t * vm, unformat_input_t * input)
3754 snat_main_t *sm = &snat_main;
3755 nat66_main_t *nm = &nat66_main;
3756 dslite_main_t *dm = &dslite_main;
3757 snat_main_per_thread_data_t *tsm;
3759 u32 static_mapping_buckets = 1024;
3760 u32 static_mapping_memory_size = 64 << 20;
3762 u32 nat64_bib_buckets = 1024;
3763 u32 nat64_bib_memory_size = 128 << 20;
3765 u32 nat64_st_buckets = 2048;
3766 u32 nat64_st_memory_size = 256 << 20;
3768 u32 user_buckets = 128;
3769 u32 user_memory_size = 64 << 20;
3770 u32 translation_buckets = 1024;
3771 u32 translation_memory_size = 128 << 20;
3773 u32 max_translations_per_user = ~0;
3775 u32 outside_vrf_id = 0;
3776 u32 outside_ip6_vrf_id = 0;
3777 u32 inside_vrf_id = 0;
3778 u8 static_mapping_only = 0;
3779 u8 static_mapping_connection_tracking = 0;
3781 u32 udp_timeout = SNAT_UDP_TIMEOUT;
3782 u32 icmp_timeout = SNAT_ICMP_TIMEOUT;
3784 u32 tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
3785 u32 tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
3787 sm->deterministic = 0;
3789 sm->endpoint_dependent = 0;
3791 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3794 (input, "translation hash buckets %d", &translation_buckets))
3796 else if (unformat (input, "udp timeout %d", &udp_timeout))
3798 else if (unformat (input, "icmp timeout %d", &icmp_timeout))
3800 else if (unformat (input, "tcp transitory timeout %d",
3801 &tcp_transitory_timeout));
3802 else if (unformat (input, "tcp established timeout %d",
3803 &tcp_established_timeout));
3804 else if (unformat (input, "translation hash memory %d",
3805 &translation_memory_size));
3806 else if (unformat (input, "user hash buckets %d", &user_buckets))
3808 else if (unformat (input, "user hash memory %d", &user_memory_size))
3810 else if (unformat (input, "max translations per user %d",
3811 &max_translations_per_user))
3813 else if (unformat (input, "outside VRF id %d", &outside_vrf_id))
3815 else if (unformat (input, "outside ip6 VRF id %d", &outside_ip6_vrf_id))
3817 else if (unformat (input, "inside VRF id %d", &inside_vrf_id))
3819 else if (unformat (input, "static mapping only"))
3821 static_mapping_only = 1;
3822 if (unformat (input, "connection tracking"))
3823 static_mapping_connection_tracking = 1;
3825 else if (unformat (input, "deterministic"))
3826 sm->deterministic = 1;
3827 else if (unformat (input, "nat64 bib hash buckets %d",
3828 &nat64_bib_buckets))
3830 else if (unformat (input, "nat64 bib hash memory %d",
3831 &nat64_bib_memory_size))
3834 if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
3836 else if (unformat (input, "nat64 st hash memory %d",
3837 &nat64_st_memory_size))
3839 else if (unformat (input, "out2in dpo"))
3841 else if (unformat (input, "dslite ce"))
3842 dslite_set_ce (dm, 1);
3843 else if (unformat (input, "endpoint-dependent"))
3844 sm->endpoint_dependent = 1;
3846 return clib_error_return (0, "unknown input '%U'",
3847 format_unformat_error, input);
3850 if (sm->deterministic && sm->endpoint_dependent)
3851 return clib_error_return (0,
3852 "deterministic and endpoint-dependent modes are mutually exclusive");
3854 if (static_mapping_only && (sm->deterministic || sm->endpoint_dependent))
3855 return clib_error_return (0,
3856 "static mapping only mode available only for simple nat");
3858 if (sm->out2in_dpo && (sm->deterministic || sm->endpoint_dependent))
3859 return clib_error_return (0,
3860 "out2in dpo mode available only for simple nat");
3862 /* optionally configurable timeouts for testing purposes */
3863 sm->udp_timeout = udp_timeout;
3864 sm->icmp_timeout = icmp_timeout;
3865 sm->tcp_transitory_timeout = tcp_transitory_timeout;
3866 sm->tcp_established_timeout = tcp_established_timeout;
3868 sm->user_buckets = user_buckets;
3869 sm->user_memory_size = user_memory_size;
3871 sm->translation_buckets = translation_buckets;
3872 sm->translation_memory_size = translation_memory_size;
3874 /* do not exceed load factor 10 */
3875 sm->max_translations = 10 * translation_buckets;
3876 sm->max_translations_per_user = max_translations_per_user == ~0 ?
3877 sm->max_translations : max_translations_per_user;
3879 sm->outside_vrf_id = outside_vrf_id;
3880 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
3883 nm->outside_vrf_id = outside_ip6_vrf_id;
3884 nm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6,
3887 sm->inside_vrf_id = inside_vrf_id;
3888 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
3891 sm->static_mapping_only = static_mapping_only;
3892 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
3894 nat64_set_hash (nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
3895 nat64_st_memory_size);
3897 if (sm->deterministic)
3899 sm->in2out_node_index = snat_det_in2out_node.index;
3900 sm->in2out_output_node_index = ~0;
3901 sm->out2in_node_index = snat_det_out2in_node.index;
3902 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
3903 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
3907 if (sm->endpoint_dependent)
3909 sm->worker_in2out_cb = nat44_ed_get_worker_in2out_cb;
3910 sm->worker_out2in_cb = nat44_ed_get_worker_out2in_cb;
3912 sm->handoff_out2in_index = nat_pre_out2in_node.index;
3913 sm->handoff_in2out_index = nat_pre_in2out_node.index;
3914 sm->handoff_in2out_output_index = nat44_ed_in2out_output_node.index;
3916 sm->in2out_node_index = nat44_ed_in2out_node.index;
3917 sm->in2out_output_node_index = nat44_ed_in2out_output_node.index;
3918 sm->out2in_node_index = nat44_ed_out2in_node.index;
3920 sm->icmp_match_in2out_cb = icmp_match_in2out_ed;
3921 sm->icmp_match_out2in_cb = icmp_match_out2in_ed;
3922 nat_affinity_init (vm);
3923 nat_ha_init (vm, nat_ha_sadd_ed_cb, nat_ha_sdel_ed_cb,
3928 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
3929 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
3931 sm->handoff_out2in_index = snat_in2out_node.index;
3932 sm->handoff_in2out_index = snat_out2in_node.index;
3933 sm->handoff_in2out_output_index = snat_in2out_output_node.index;
3935 sm->in2out_node_index = snat_in2out_node.index;
3936 sm->in2out_output_node_index = snat_in2out_output_node.index;
3937 sm->out2in_node_index = snat_out2in_node.index;
3938 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
3939 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
3940 nat_ha_init (vm, nat_ha_sadd_cb, nat_ha_sdel_cb, nat_ha_sref_cb);
3942 if (!static_mapping_only ||
3943 (static_mapping_only && static_mapping_connection_tracking))
3946 vec_foreach (tsm, sm->per_thread_data)
3948 if (sm->endpoint_dependent)
3950 clib_bihash_init_16_8 (&tsm->in2out_ed, "in2out-ed",
3951 translation_buckets,
3952 translation_memory_size);
3953 clib_bihash_set_kvp_format_fn_16_8 (&tsm->in2out_ed,
3954 format_ed_session_kvp);
3956 clib_bihash_init_16_8 (&tsm->out2in_ed, "out2in-ed",
3957 translation_buckets,
3958 translation_memory_size);
3959 clib_bihash_set_kvp_format_fn_16_8 (&tsm->out2in_ed,
3960 format_ed_session_kvp);
3964 clib_bihash_init_8_8 (&tsm->in2out, "in2out",
3965 translation_buckets,
3966 translation_memory_size);
3967 clib_bihash_set_kvp_format_fn_8_8 (&tsm->in2out,
3968 format_session_kvp);
3970 clib_bihash_init_8_8 (&tsm->out2in, "out2in",
3971 translation_buckets,
3972 translation_memory_size);
3973 clib_bihash_set_kvp_format_fn_8_8 (&tsm->out2in,
3974 format_session_kvp);
3977 clib_bihash_init_8_8 (&tsm->user_hash, "users", user_buckets,
3979 clib_bihash_set_kvp_format_fn_8_8 (&tsm->user_hash,
3987 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
3988 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
3990 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
3991 "static_mapping_by_local", static_mapping_buckets,
3992 static_mapping_memory_size);
3993 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_local,
3994 format_static_mapping_kvp);
3996 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
3997 "static_mapping_by_external",
3998 static_mapping_buckets,
3999 static_mapping_memory_size);
4000 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_external,
4001 format_static_mapping_kvp);
4007 VLIB_CONFIG_FUNCTION (snat_config, "nat");
4010 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
4013 ip4_address_t * address,
4015 u32 if_address_index, u32 is_delete)
4017 snat_main_t *sm = &snat_main;
4018 snat_static_map_resolve_t *rp;
4019 snat_static_mapping_t *m;
4020 snat_session_key_t m_key;
4021 clib_bihash_kv_8_8_t kv, value;
4023 ip4_address_t l_addr;
4025 for (i = 0; i < vec_len (sm->to_resolve); i++)
4027 rp = sm->to_resolve + i;
4028 if (rp->addr_only == 0)
4030 if (rp->sw_if_index == sw_if_index)
4037 m_key.addr.as_u32 = address->as_u32;
4038 m_key.port = rp->addr_only ? 0 : rp->e_port;
4039 m_key.protocol = rp->addr_only ? 0 : rp->proto;
4040 m_key.fib_index = sm->outside_fib_index;
4041 kv.key = m_key.as_u64;
4042 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
4045 m = pool_elt_at_index (sm->static_mappings, value.value);
4049 /* Don't trip over lease renewal, static config */
4059 /* Indetity mapping? */
4060 if (rp->l_addr.as_u32 == 0)
4061 l_addr.as_u32 = address[0].as_u32;
4063 l_addr.as_u32 = rp->l_addr.as_u32;
4064 /* Add the static mapping */
4065 rv = snat_add_static_mapping (l_addr,
4070 rp->addr_only, ~0 /* sw_if_index */ ,
4071 rp->proto, !is_delete, rp->twice_nat,
4072 rp->out2in_only, rp->tag, rp->identity_nat);
4074 nat_elog_notice_X1 ("snat_add_static_mapping returned %d", "i4", rv);
4078 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
4081 ip4_address_t * address,
4083 u32 if_address_index, u32 is_delete)
4085 snat_main_t *sm = &snat_main;
4086 snat_static_map_resolve_t *rp;
4087 ip4_address_t l_addr;
4091 snat_address_t *addresses = sm->addresses;
4093 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices); i++)
4095 if (sw_if_index == sm->auto_add_sw_if_indices[i])
4099 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices_twice_nat); i++)
4102 addresses = sm->twice_nat_addresses;
4103 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
4112 /* Don't trip over lease renewal, static config */
4113 for (j = 0; j < vec_len (addresses); j++)
4114 if (addresses[j].addr.as_u32 == address->as_u32)
4117 (void) snat_add_address (sm, address, ~0, twice_nat);
4118 /* Scan static map resolution vector */
4119 for (j = 0; j < vec_len (sm->to_resolve); j++)
4121 rp = sm->to_resolve + j;
4124 /* On this interface? */
4125 if (rp->sw_if_index == sw_if_index)
4127 /* Indetity mapping? */
4128 if (rp->l_addr.as_u32 == 0)
4129 l_addr.as_u32 = address[0].as_u32;
4131 l_addr.as_u32 = rp->l_addr.as_u32;
4132 /* Add the static mapping */
4133 rv = snat_add_static_mapping (l_addr,
4139 ~0 /* sw_if_index */ ,
4141 rp->is_add, rp->twice_nat,
4142 rp->out2in_only, rp->tag,
4145 nat_elog_notice_X1 ("snat_add_static_mapping returned %d",
4153 (void) snat_del_address (sm, address[0], 1, twice_nat);
4160 snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
4163 ip4_main_t *ip4_main = sm->ip4_main;
4164 ip4_address_t *first_int_addr;
4165 snat_static_map_resolve_t *rp;
4166 u32 *indices_to_delete = 0;
4168 u32 *auto_add_sw_if_indices =
4170 auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
4172 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0 /* just want the address */
4175 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
4177 if (auto_add_sw_if_indices[i] == sw_if_index)
4181 /* if have address remove it */
4183 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
4186 for (j = 0; j < vec_len (sm->to_resolve); j++)
4188 rp = sm->to_resolve + j;
4189 if (rp->sw_if_index == sw_if_index)
4190 vec_add1 (indices_to_delete, j);
4192 if (vec_len (indices_to_delete))
4194 for (j = vec_len (indices_to_delete) - 1; j >= 0; j--)
4195 vec_del1 (sm->to_resolve, j);
4196 vec_free (indices_to_delete);
4200 vec_del1 (sm->auto_add_sw_if_indices_twice_nat, i);
4202 vec_del1 (sm->auto_add_sw_if_indices, i);
4205 return VNET_API_ERROR_VALUE_EXIST;
4212 return VNET_API_ERROR_NO_SUCH_ENTRY;
4214 /* add to the auto-address list */
4216 vec_add1 (sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
4218 vec_add1 (sm->auto_add_sw_if_indices, sw_if_index);
4220 /* If the address is already bound - or static - add it now */
4222 (void) snat_add_address (sm, first_int_addr, ~0, twice_nat);
4228 nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4229 snat_protocol_t proto, u32 vrf_id, int is_in)
4231 snat_main_per_thread_data_t *tsm;
4232 clib_bihash_kv_8_8_t kv, value;
4234 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4235 snat_session_key_t key;
4237 clib_bihash_8_8_t *t;
4239 if (sm->endpoint_dependent)
4240 return VNET_API_ERROR_UNSUPPORTED;
4242 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4243 if (sm->num_workers > 1)
4245 vec_elt_at_index (sm->per_thread_data,
4246 sm->worker_in2out_cb (&ip, fib_index, 0));
4248 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4250 key.addr.as_u32 = addr->as_u32;
4251 key.port = clib_host_to_net_u16 (port);
4252 key.protocol = proto;
4253 key.fib_index = fib_index;
4254 kv.key = key.as_u64;
4255 t = is_in ? &tsm->in2out : &tsm->out2in;
4256 if (!clib_bihash_search_8_8 (t, &kv, &value))
4258 if (pool_is_free_index (tsm->sessions, value.value))
4259 return VNET_API_ERROR_UNSPECIFIED;
4261 s = pool_elt_at_index (tsm->sessions, value.value);
4262 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4263 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4267 return VNET_API_ERROR_NO_SUCH_ENTRY;
4271 nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4272 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
4273 u32 vrf_id, int is_in)
4276 clib_bihash_16_8_t *t;
4277 nat_ed_ses_key_t key;
4278 clib_bihash_kv_16_8_t kv, value;
4279 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4281 snat_main_per_thread_data_t *tsm;
4283 if (!sm->endpoint_dependent)
4284 return VNET_API_ERROR_FEATURE_DISABLED;
4286 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4287 if (sm->num_workers > 1)
4289 vec_elt_at_index (sm->per_thread_data,
4290 sm->worker_in2out_cb (&ip, fib_index, 0));
4292 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4294 t = is_in ? &tsm->in2out_ed : &tsm->out2in_ed;
4295 key.l_addr.as_u32 = addr->as_u32;
4296 key.r_addr.as_u32 = eh_addr->as_u32;
4297 key.l_port = clib_host_to_net_u16 (port);
4298 key.r_port = clib_host_to_net_u16 (eh_port);
4300 key.fib_index = fib_index;
4301 kv.key[0] = key.as_u64[0];
4302 kv.key[1] = key.as_u64[1];
4303 if (clib_bihash_search_16_8 (t, &kv, &value))
4304 return VNET_API_ERROR_NO_SUCH_ENTRY;
4306 if (pool_is_free_index (tsm->sessions, value.value))
4307 return VNET_API_ERROR_UNSPECIFIED;
4308 s = pool_elt_at_index (tsm->sessions, value.value);
4309 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4310 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4315 nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset, u16 psid_length)
4317 snat_main_t *sm = &snat_main;
4319 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_MAPE;
4320 sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
4322 sm->psid_offset = psid_offset;
4323 sm->psid_length = psid_length;
4327 nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port)
4329 snat_main_t *sm = &snat_main;
4331 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_RANGE;
4332 sm->alloc_addr_and_port = nat_alloc_addr_and_port_range;
4333 sm->start_port = start_port;
4334 sm->end_port = end_port;
4338 nat_set_alloc_addr_and_port_default (void)
4340 snat_main_t *sm = &snat_main;
4342 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
4343 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
4346 VLIB_NODE_FN (nat_default_node) (vlib_main_t * vm,
4347 vlib_node_runtime_t * node,
4348 vlib_frame_t * frame)
4354 VLIB_REGISTER_NODE (nat_default_node) = {
4355 .name = "nat-default",
4356 .vector_size = sizeof (u32),
4358 .type = VLIB_NODE_TYPE_INTERNAL,
4360 .n_next_nodes = NAT_N_NEXT,
4362 [NAT_NEXT_DROP] = "error-drop",
4363 [NAT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
4364 [NAT_NEXT_IN2OUT_PRE] = "nat-pre-in2out",
4365 [NAT_NEXT_OUT2IN_PRE] = "nat-pre-out2in",
4366 [NAT_NEXT_IN2OUT_ED_FAST_PATH] = "nat44-ed-in2out",
4367 [NAT_NEXT_IN2OUT_ED_SLOW_PATH] = "nat44-ed-in2out-slowpath",
4368 [NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH] = "nat44-ed-in2out-output-slowpath",
4369 [NAT_NEXT_OUT2IN_ED_FAST_PATH] = "nat44-ed-out2in",
4370 [NAT_NEXT_OUT2IN_ED_SLOW_PATH] = "nat44-ed-out2in-slowpath",
4376 * fd.io coding-style-patch-verification: ON
4379 * eval: (c-set-style "gnu")