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 ("ip4-sv-reassembly-output-feature"),
165 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
167 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_src, static) = {
168 .arc_name = "ip4-output",
169 .node_name = "nat44-ed-hairpin-src",
170 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
171 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
174 /* Hook up ip4-local features */
175 VNET_FEATURE_INIT (ip4_nat_hairpinning, static) =
177 .arc_name = "ip4-local",
178 .node_name = "nat44-hairpinning",
179 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
181 VNET_FEATURE_INIT (ip4_nat44_ed_hairpinning, static) =
183 .arc_name = "ip4-local",
184 .node_name = "nat44-ed-hairpinning",
185 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
189 VLIB_PLUGIN_REGISTER () = {
190 .version = VPP_BUILD_VER,
191 .description = "Network Address Translation (NAT)",
196 nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index,
199 snat_session_key_t key;
200 clib_bihash_kv_8_8_t kv;
201 nat_ed_ses_key_t ed_key;
202 clib_bihash_kv_16_8_t ed_kv;
203 snat_main_per_thread_data_t *tsm =
204 vec_elt_at_index (sm->per_thread_data, thread_index);
206 if (is_fwd_bypass_session (s))
208 if (snat_is_unk_proto_session (s))
210 ed_key.proto = s->in2out.port;
216 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
217 ed_key.l_port = s->in2out.port;
218 ed_key.r_port = s->ext_host_port;
220 ed_key.l_addr = s->in2out.addr;
221 ed_key.r_addr = s->ext_host_addr;
222 ed_key.fib_index = 0;
223 ed_kv.key[0] = ed_key.as_u64[0];
224 ed_kv.key[1] = ed_key.as_u64[1];
225 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
226 nat_elog_warn ("in2out_ed key del failed");
230 /* session lookup tables */
231 if (is_ed_session (s))
233 if (is_affinity_sessions (s))
234 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
235 s->in2out.protocol, s->out2in.port);
236 ed_key.l_addr = s->out2in.addr;
237 ed_key.r_addr = s->ext_host_addr;
238 ed_key.fib_index = s->out2in.fib_index;
239 if (snat_is_unk_proto_session (s))
241 ed_key.proto = s->in2out.port;
247 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
248 ed_key.l_port = s->out2in.port;
249 ed_key.r_port = s->ext_host_port;
251 ed_kv.key[0] = ed_key.as_u64[0];
252 ed_kv.key[1] = ed_key.as_u64[1];
253 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &ed_kv, 0))
254 nat_elog_warn ("out2in_ed key del failed");
255 ed_key.l_addr = s->in2out.addr;
256 ed_key.fib_index = s->in2out.fib_index;
257 if (!snat_is_unk_proto_session (s))
258 ed_key.l_port = s->in2out.port;
259 if (is_twice_nat_session (s))
261 ed_key.r_addr = s->ext_host_nat_addr;
262 ed_key.r_port = s->ext_host_nat_port;
264 ed_kv.key[0] = ed_key.as_u64[0];
265 ed_kv.key[1] = ed_key.as_u64[1];
266 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
267 nat_elog_warn ("in2out_ed key del failed");
270 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
271 &s->in2out.addr, s->in2out.port,
272 &s->ext_host_nat_addr, s->ext_host_nat_port,
273 &s->out2in.addr, s->out2in.port,
274 &s->ext_host_addr, s->ext_host_port,
275 s->in2out.protocol, is_twice_nat_session (s));
279 kv.key = s->in2out.as_u64;
280 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0))
281 nat_elog_warn ("in2out key del failed");
282 kv.key = s->out2in.as_u64;
283 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0))
284 nat_elog_warn ("out2in key del failed");
287 nat_syslog_nat44_apmdel (s->user_index, s->in2out.fib_index,
288 &s->in2out.addr, s->in2out.port,
289 &s->out2in.addr, s->out2in.port,
293 if (snat_is_unk_proto_session (s))
299 snat_ipfix_logging_nat44_ses_delete (thread_index,
300 s->in2out.addr.as_u32,
301 s->out2in.addr.as_u32,
305 s->in2out.fib_index);
307 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
308 s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
312 /* Twice NAT address and port for external host */
313 if (is_twice_nat_session (s))
315 key.protocol = s->in2out.protocol;
316 key.port = s->ext_host_nat_port;
317 key.addr.as_u32 = s->ext_host_nat_addr.as_u32;
318 snat_free_outside_address_and_port (sm->twice_nat_addresses,
322 if (snat_is_session_static (s))
325 snat_free_outside_address_and_port (sm->addresses, thread_index,
330 nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr, u32 fib_index,
334 snat_user_key_t user_key;
335 clib_bihash_kv_8_8_t kv, value;
336 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
337 dlist_elt_t *per_user_list_head_elt;
339 user_key.addr.as_u32 = addr->as_u32;
340 user_key.fib_index = fib_index;
341 kv.key = user_key.as_u64;
343 /* Ever heard of the "user" = src ip4 address before? */
344 if (clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
346 /* no, make a new one */
347 pool_get (tsm->users, u);
348 clib_memset (u, 0, sizeof (*u));
349 u->addr.as_u32 = addr->as_u32;
350 u->fib_index = fib_index;
352 pool_get (tsm->list_pool, per_user_list_head_elt);
354 u->sessions_per_user_list_head_index = per_user_list_head_elt -
357 clib_dlist_init (tsm->list_pool, u->sessions_per_user_list_head_index);
359 kv.value = u - tsm->users;
362 if (clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 1))
363 nat_elog_warn ("user_hash keay add failed");
365 vlib_set_simple_counter (&sm->total_users, thread_index, 0,
366 pool_elts (tsm->users));
370 u = pool_elt_at_index (tsm->users, value.value);
377 nat_session_alloc_or_recycle (snat_main_t * sm, snat_user_t * u,
378 u32 thread_index, f64 now)
381 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
382 u32 oldest_per_user_translation_list_index, session_index;
383 dlist_elt_t *oldest_per_user_translation_list_elt;
384 dlist_elt_t *per_user_translation_list_elt;
386 /* Over quota? Recycle the least recently used translation */
387 if ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user)
389 oldest_per_user_translation_list_index =
390 clib_dlist_remove_head (tsm->list_pool,
391 u->sessions_per_user_list_head_index);
393 ASSERT (oldest_per_user_translation_list_index != ~0);
395 /* Add it back to the end of the LRU list */
396 clib_dlist_addtail (tsm->list_pool,
397 u->sessions_per_user_list_head_index,
398 oldest_per_user_translation_list_index);
399 /* Get the list element */
400 oldest_per_user_translation_list_elt =
401 pool_elt_at_index (tsm->list_pool,
402 oldest_per_user_translation_list_index);
404 /* Get the session index from the list element */
405 session_index = oldest_per_user_translation_list_elt->value;
407 /* Get the session */
408 s = pool_elt_at_index (tsm->sessions, session_index);
409 nat_free_session_data (sm, s, thread_index, 0);
410 if (snat_is_session_static (s))
411 u->nstaticsessions--;
418 s->ext_host_addr.as_u32 = 0;
419 s->ext_host_port = 0;
420 s->ext_host_nat_addr.as_u32 = 0;
421 s->ext_host_nat_port = 0;
425 pool_get (tsm->sessions, s);
426 clib_memset (s, 0, sizeof (*s));
428 /* Create list elts */
429 pool_get (tsm->list_pool, per_user_translation_list_elt);
430 clib_dlist_init (tsm->list_pool,
431 per_user_translation_list_elt - tsm->list_pool);
433 per_user_translation_list_elt->value = s - tsm->sessions;
434 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
435 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
437 clib_dlist_addtail (tsm->list_pool,
438 s->per_user_list_head_index,
439 per_user_translation_list_elt - tsm->list_pool);
441 s->user_index = u - tsm->users;
442 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
443 pool_elts (tsm->sessions));
446 s->ha_last_refreshed = now;
452 nat_ed_session_alloc (snat_main_t * sm, snat_user_t * u, u32 thread_index,
456 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
457 dlist_elt_t *per_user_translation_list_elt, *oldest_elt;
459 u64 sess_timeout_time;
461 if (PREDICT_FALSE (!(u->nsessions) && !(u->nstaticsessions)))
465 clib_dlist_remove_head (tsm->list_pool,
466 u->sessions_per_user_list_head_index);
467 oldest_elt = pool_elt_at_index (tsm->list_pool, oldest_index);
468 s = pool_elt_at_index (tsm->sessions, oldest_elt->value);
470 sess_timeout_time = s->last_heard + (f64) nat44_session_get_timeout (sm, s);
471 if (now >= sess_timeout_time)
473 clib_dlist_addtail (tsm->list_pool,
474 u->sessions_per_user_list_head_index, oldest_index);
475 nat_free_session_data (sm, s, thread_index, 0);
476 if (snat_is_session_static (s))
477 u->nstaticsessions--;
484 s->ext_host_addr.as_u32 = 0;
485 s->ext_host_port = 0;
486 s->ext_host_nat_addr.as_u32 = 0;
487 s->ext_host_nat_port = 0;
491 clib_dlist_addhead (tsm->list_pool,
492 u->sessions_per_user_list_head_index, oldest_index);
493 if ((u->nsessions + u->nstaticsessions) >=
494 sm->max_translations_per_user)
496 nat_elog_addr (SNAT_LOG_WARNING, "[warn] max translations per user",
497 clib_net_to_host_u32 (u->addr.as_u32));
498 snat_ipfix_logging_max_entries_per_user
499 (thread_index, sm->max_translations_per_user, u->addr.as_u32);
505 pool_get (tsm->sessions, s);
506 clib_memset (s, 0, sizeof (*s));
508 /* Create list elts */
509 pool_get (tsm->list_pool, per_user_translation_list_elt);
510 clib_dlist_init (tsm->list_pool,
511 per_user_translation_list_elt - tsm->list_pool);
513 per_user_translation_list_elt->value = s - tsm->sessions;
514 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
515 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
517 clib_dlist_addtail (tsm->list_pool,
518 s->per_user_list_head_index,
519 per_user_translation_list_elt - tsm->list_pool);
522 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
523 pool_elts (tsm->sessions));
526 s->ha_last_refreshed = now;
532 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
535 fib_prefix_t prefix = {
537 .fp_proto = FIB_PROTOCOL_IP4,
539 .ip4.as_u32 = addr->as_u32,
542 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
545 fib_table_entry_update_one_path (fib_index,
548 (FIB_ENTRY_FLAG_CONNECTED |
549 FIB_ENTRY_FLAG_LOCAL |
550 FIB_ENTRY_FLAG_EXCLUSIVE),
554 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
556 fib_table_entry_delete (fib_index, &prefix, nat_fib_src_low);
560 snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
565 vlib_thread_main_t *tm = vlib_get_thread_main ();
567 if (twice_nat && !sm->endpoint_dependent)
568 return VNET_API_ERROR_FEATURE_DISABLED;
570 /* Check if address already exists */
572 vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
574 if (ap->addr.as_u32 == addr->as_u32)
575 return VNET_API_ERROR_VALUE_EXIST;
580 vec_add2 (sm->twice_nat_addresses, ap, 1);
582 vec_add2 (sm->addresses, ap, 1);
587 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
591 #define _(N, i, n, s) \
592 clib_bitmap_alloc (ap->busy_##n##_port_bitmap, 65535); \
593 ap->busy_##n##_ports = 0; \
594 ap->busy_##n##_ports_per_thread = 0;\
595 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
596 foreach_snat_protocol
601 /* Add external address to FIB */
603 pool_foreach (i, sm->interfaces,
605 if (nat_interface_is_inside(i) || sm->out2in_dpo)
608 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
611 pool_foreach (i, sm->output_feature_interfaces,
613 if (nat_interface_is_inside(i) || sm->out2in_dpo)
616 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
625 is_snat_address_used_in_static_mapping (snat_main_t * sm, ip4_address_t addr)
627 snat_static_mapping_t *m;
629 pool_foreach (m, sm->static_mappings,
631 if (is_addr_only_static_mapping (m) ||
632 is_out2in_only_static_mapping (m) ||
633 is_identity_static_mapping (m))
635 if (m->external_addr.as_u32 == addr.as_u32)
644 increment_v4_address (ip4_address_t * a)
648 v = clib_net_to_host_u32 (a->as_u32) + 1;
649 a->as_u32 = clib_host_to_net_u32 (v);
653 snat_add_static_mapping_when_resolved (snat_main_t * sm,
654 ip4_address_t l_addr,
659 snat_protocol_t proto,
660 int addr_only, int is_add, u8 * tag,
661 int twice_nat, int out2in_only,
664 snat_static_map_resolve_t *rp;
666 vec_add2 (sm->to_resolve, rp, 1);
667 rp->l_addr.as_u32 = l_addr.as_u32;
669 rp->sw_if_index = sw_if_index;
673 rp->addr_only = addr_only;
675 rp->twice_nat = twice_nat;
676 rp->out2in_only = out2in_only;
677 rp->identity_nat = identity_nat;
678 rp->tag = vec_dup (tag);
682 get_thread_idx_by_port (u16 e_port)
684 snat_main_t *sm = &snat_main;
685 u32 thread_idx = sm->num_workers;
686 if (sm->num_workers > 1)
689 sm->first_worker_index +
690 sm->workers[(e_port - 1024) / sm->port_per_thread];
696 snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
697 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
698 u32 sw_if_index, snat_protocol_t proto, int is_add,
699 twice_nat_type_t twice_nat, u8 out2in_only, u8 * tag,
702 snat_main_t *sm = &snat_main;
703 snat_static_mapping_t *m;
704 snat_session_key_t m_key;
705 clib_bihash_kv_8_8_t kv, value;
706 snat_address_t *a = 0;
708 snat_interface_t *interface;
710 snat_main_per_thread_data_t *tsm;
711 snat_user_key_t u_key;
713 dlist_elt_t *head, *elt;
714 u32 elt_index, head_index;
718 snat_static_map_resolve_t *rp, *rp_match = 0;
719 nat44_lb_addr_port_t *local;
722 if (!sm->endpoint_dependent)
724 if (twice_nat || out2in_only)
725 return VNET_API_ERROR_FEATURE_DISABLED;
728 /* If the external address is a specific interface address */
729 if (sw_if_index != ~0)
731 ip4_address_t *first_int_addr;
733 for (i = 0; i < vec_len (sm->to_resolve); i++)
735 rp = sm->to_resolve + i;
736 if (rp->sw_if_index != sw_if_index ||
737 rp->l_addr.as_u32 != l_addr.as_u32 ||
738 rp->vrf_id != vrf_id || rp->addr_only != addr_only)
743 if ((rp->l_port != l_port && rp->e_port != e_port)
744 || rp->proto != proto)
752 /* Might be already set... */
753 first_int_addr = ip4_interface_first_address
754 (sm->ip4_main, sw_if_index, 0 /* just want the address */ );
759 return VNET_API_ERROR_VALUE_EXIST;
761 snat_add_static_mapping_when_resolved
762 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
763 addr_only, is_add, tag, twice_nat, out2in_only, identity_nat);
765 /* DHCP resolution required? */
766 if (first_int_addr == 0)
772 e_addr.as_u32 = first_int_addr->as_u32;
773 /* Identity mapping? */
774 if (l_addr.as_u32 == 0)
775 l_addr.as_u32 = e_addr.as_u32;
781 return VNET_API_ERROR_NO_SUCH_ENTRY;
783 vec_del1 (sm->to_resolve, i);
787 e_addr.as_u32 = first_int_addr->as_u32;
788 /* Identity mapping? */
789 if (l_addr.as_u32 == 0)
790 l_addr.as_u32 = e_addr.as_u32;
798 m_key.port = addr_only ? 0 : e_port;
799 m_key.protocol = addr_only ? 0 : proto;
801 kv.key = m_key.as_u64;
802 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
805 m = pool_elt_at_index (sm->static_mappings, value.value);
811 if (is_identity_static_mapping (m))
814 pool_foreach (local, m->locals,
816 if (local->vrf_id == vrf_id)
817 return VNET_API_ERROR_VALUE_EXIST;
820 pool_get (m->locals, local);
821 local->vrf_id = vrf_id;
823 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
825 m_key.addr = m->local_addr;
826 m_key.port = m->local_port;
827 m_key.protocol = m->proto;
828 m_key.fib_index = local->fib_index;
829 kv.key = m_key.as_u64;
830 kv.value = m - sm->static_mappings;
831 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
835 return VNET_API_ERROR_VALUE_EXIST;
838 if (twice_nat && addr_only)
839 return VNET_API_ERROR_UNSUPPORTED;
841 /* Convert VRF id to FIB index */
844 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
846 /* If not specified use inside VRF id from SNAT plugin startup config */
849 fib_index = sm->inside_fib_index;
850 vrf_id = sm->inside_vrf_id;
851 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
854 if (!(out2in_only || identity_nat))
857 m_key.port = addr_only ? 0 : l_port;
858 m_key.protocol = addr_only ? 0 : proto;
859 m_key.fib_index = fib_index;
860 kv.key = m_key.as_u64;
861 if (!clib_bihash_search_8_8
862 (&sm->static_mapping_by_local, &kv, &value))
863 return VNET_API_ERROR_VALUE_EXIST;
866 /* Find external address in allocated addresses and reserve port for
867 address and port pair mapping when dynamic translations enabled */
868 if (!(addr_only || sm->static_mapping_only || out2in_only))
870 for (i = 0; i < vec_len (sm->addresses); i++)
872 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
874 a = sm->addresses + i;
875 /* External port must be unused */
878 #define _(N, j, n, s) \
879 case SNAT_PROTOCOL_##N: \
880 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
881 return VNET_API_ERROR_INVALID_VALUE; \
882 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
885 a->busy_##n##_ports++; \
886 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
889 foreach_snat_protocol
892 nat_elog_info ("unknown protocol");
893 return VNET_API_ERROR_INVALID_VALUE_2;
898 /* External address must be allocated */
899 if (!a && (l_addr.as_u32 != e_addr.as_u32))
901 if (sw_if_index != ~0)
903 for (i = 0; i < vec_len (sm->to_resolve); i++)
905 rp = sm->to_resolve + i;
908 if (rp->sw_if_index != sw_if_index &&
909 rp->l_addr.as_u32 != l_addr.as_u32 &&
910 rp->vrf_id != vrf_id && rp->l_port != l_port &&
911 rp->e_port != e_port && rp->proto != proto)
914 vec_del1 (sm->to_resolve, i);
918 return VNET_API_ERROR_NO_SUCH_ENTRY;
922 pool_get (sm->static_mappings, m);
923 clib_memset (m, 0, sizeof (*m));
924 m->tag = vec_dup (tag);
925 m->local_addr = l_addr;
926 m->external_addr = e_addr;
927 m->twice_nat = twice_nat;
929 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
931 m->flags |= NAT_STATIC_MAPPING_FLAG_ADDR_ONLY;
934 m->flags |= NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT;
935 pool_get (m->locals, local);
936 local->vrf_id = vrf_id;
937 local->fib_index = fib_index;
942 m->fib_index = fib_index;
946 m->local_port = l_port;
947 m->external_port = e_port;
951 if (sm->num_workers > 1)
954 .src_address = m->local_addr,
956 vec_add1 (m->workers, sm->worker_in2out_cb (&ip, m->fib_index, 0));
957 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
960 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
962 m_key.addr = m->local_addr;
963 m_key.port = m->local_port;
964 m_key.protocol = m->proto;
965 m_key.fib_index = fib_index;
966 kv.key = m_key.as_u64;
967 kv.value = m - sm->static_mappings;
969 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
971 m_key.addr = m->external_addr;
972 m_key.port = m->external_port;
974 kv.key = m_key.as_u64;
975 kv.value = m - sm->static_mappings;
976 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1);
978 /* Delete dynamic sessions matching local address (+ local port) */
979 if (!(sm->static_mapping_only))
981 u_key.addr = m->local_addr;
982 u_key.fib_index = m->fib_index;
983 kv.key = u_key.as_u64;
984 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
986 user_index = value.value;
987 u = pool_elt_at_index (tsm->users, user_index);
990 head_index = u->sessions_per_user_list_head_index;
991 head = pool_elt_at_index (tsm->list_pool, head_index);
992 elt_index = head->next;
993 elt = pool_elt_at_index (tsm->list_pool, elt_index);
994 ses_index = elt->value;
995 while (ses_index != ~0)
997 s = pool_elt_at_index (tsm->sessions, ses_index);
998 elt = pool_elt_at_index (tsm->list_pool, elt->next);
999 ses_index = elt->value;
1001 if (snat_is_session_static (s))
1005 && (clib_net_to_host_u16 (s->in2out.port) !=
1009 nat_free_session_data (sm, s,
1010 tsm - sm->per_thread_data, 0);
1011 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1013 if (!addr_only && !sm->endpoint_dependent)
1024 if (sw_if_index != ~0)
1027 return VNET_API_ERROR_NO_SUCH_ENTRY;
1033 vrf_id = sm->inside_vrf_id;
1036 pool_foreach (local, m->locals,
1038 if (local->vrf_id == vrf_id)
1039 find = local - m->locals;
1043 return VNET_API_ERROR_NO_SUCH_ENTRY;
1045 local = pool_elt_at_index (m->locals, find);
1046 fib_index = local->fib_index;
1047 pool_put (m->locals, local);
1050 fib_index = m->fib_index;
1052 /* Free external address port */
1053 if (!(addr_only || sm->static_mapping_only || out2in_only))
1055 for (i = 0; i < vec_len (sm->addresses); i++)
1057 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1059 a = sm->addresses + i;
1062 #define _(N, j, n, s) \
1063 case SNAT_PROTOCOL_##N: \
1064 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
1065 if (e_port > 1024) \
1067 a->busy_##n##_ports--; \
1068 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1071 foreach_snat_protocol
1074 nat_elog_info ("unknown protocol");
1075 return VNET_API_ERROR_INVALID_VALUE_2;
1082 if (sm->num_workers > 1)
1083 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1085 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1087 m_key.addr = m->local_addr;
1088 m_key.port = m->local_port;
1089 m_key.protocol = m->proto;
1090 m_key.fib_index = fib_index;
1091 kv.key = m_key.as_u64;
1093 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0);
1095 /* Delete session(s) for static mapping if exist */
1096 if (!(sm->static_mapping_only) ||
1097 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
1099 u_key.addr = m->local_addr;
1100 u_key.fib_index = fib_index;
1101 kv.key = u_key.as_u64;
1102 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1104 user_index = value.value;
1105 u = pool_elt_at_index (tsm->users, user_index);
1106 if (u->nstaticsessions)
1108 head_index = u->sessions_per_user_list_head_index;
1109 head = pool_elt_at_index (tsm->list_pool, head_index);
1110 elt_index = head->next;
1111 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1112 ses_index = elt->value;
1113 while (ses_index != ~0)
1115 s = pool_elt_at_index (tsm->sessions, ses_index);
1116 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1117 ses_index = elt->value;
1121 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
1122 (clib_net_to_host_u16 (s->out2in.port) !=
1127 if (is_lb_session (s))
1130 if (!snat_is_session_static (s))
1133 nat_free_session_data (sm, s,
1134 tsm - sm->per_thread_data, 0);
1135 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1137 if (!addr_only && !sm->endpoint_dependent)
1144 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1145 if (pool_elts (m->locals))
1148 m_key.addr = m->external_addr;
1149 m_key.port = m->external_port;
1150 m_key.fib_index = 0;
1151 kv.key = m_key.as_u64;
1152 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0);
1155 vec_free (m->workers);
1156 /* Delete static mapping from pool */
1157 pool_put (sm->static_mappings, m);
1160 if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
1163 /* Add/delete external address to FIB */
1165 pool_foreach (interface, sm->interfaces,
1167 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1170 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1173 pool_foreach (interface, sm->output_feature_interfaces,
1175 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1178 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1187 nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1188 snat_protocol_t proto,
1189 nat44_lb_addr_port_t * locals, u8 is_add,
1190 twice_nat_type_t twice_nat, u8 out2in_only,
1191 u8 * tag, u32 affinity)
1193 snat_main_t *sm = &snat_main;
1194 snat_static_mapping_t *m;
1195 snat_session_key_t m_key;
1196 clib_bihash_kv_8_8_t kv, value;
1197 snat_address_t *a = 0;
1199 nat44_lb_addr_port_t *local;
1200 u32 elt_index, head_index, ses_index;
1201 snat_main_per_thread_data_t *tsm;
1202 snat_user_key_t u_key;
1205 dlist_elt_t *head, *elt;
1208 if (!sm->endpoint_dependent)
1209 return VNET_API_ERROR_FEATURE_DISABLED;
1211 m_key.addr = e_addr;
1212 m_key.port = e_port;
1213 m_key.protocol = proto;
1214 m_key.fib_index = 0;
1215 kv.key = m_key.as_u64;
1216 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1219 m = pool_elt_at_index (sm->static_mappings, value.value);
1224 return VNET_API_ERROR_VALUE_EXIST;
1226 if (vec_len (locals) < 2)
1227 return VNET_API_ERROR_INVALID_VALUE;
1229 /* Find external address in allocated addresses and reserve port for
1230 address and port pair mapping when dynamic translations enabled */
1231 if (!(sm->static_mapping_only || out2in_only))
1233 for (i = 0; i < vec_len (sm->addresses); i++)
1235 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1237 a = sm->addresses + i;
1238 /* External port must be unused */
1241 #define _(N, j, n, s) \
1242 case SNAT_PROTOCOL_##N: \
1243 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
1244 return VNET_API_ERROR_INVALID_VALUE; \
1245 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
1246 if (e_port > 1024) \
1248 a->busy_##n##_ports++; \
1249 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1252 foreach_snat_protocol
1255 nat_elog_info ("unknown protocol");
1256 return VNET_API_ERROR_INVALID_VALUE_2;
1261 /* External address must be allocated */
1263 return VNET_API_ERROR_NO_SUCH_ENTRY;
1266 pool_get (sm->static_mappings, m);
1267 clib_memset (m, 0, sizeof (*m));
1268 m->tag = vec_dup (tag);
1269 m->external_addr = e_addr;
1270 m->external_port = e_port;
1272 m->twice_nat = twice_nat;
1273 m->flags |= NAT_STATIC_MAPPING_FLAG_LB;
1275 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1276 m->affinity = affinity;
1279 m->affinity_per_service_list_head_index =
1280 nat_affinity_get_per_service_list_head_index ();
1282 m->affinity_per_service_list_head_index = ~0;
1284 m_key.addr = m->external_addr;
1285 m_key.port = m->external_port;
1286 m_key.protocol = m->proto;
1287 m_key.fib_index = 0;
1288 kv.key = m_key.as_u64;
1289 kv.value = m - sm->static_mappings;
1290 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1))
1292 nat_elog_err ("static_mapping_by_external key add failed");
1293 return VNET_API_ERROR_UNSPECIFIED;
1296 m_key.fib_index = m->fib_index;
1297 for (i = 0; i < vec_len (locals); i++)
1299 locals[i].fib_index =
1300 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
1303 m_key.addr = locals[i].addr;
1304 m_key.fib_index = locals[i].fib_index;
1307 m_key.port = locals[i].port;
1308 kv.key = m_key.as_u64;
1309 kv.value = m - sm->static_mappings;
1310 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1312 locals[i].prefix = (i == 0) ? locals[i].probability :
1313 (locals[i - 1].prefix + locals[i].probability);
1314 pool_get (m->locals, local);
1316 if (sm->num_workers > 1)
1319 .src_address = locals[i].addr,
1322 clib_bitmap_set (bitmap,
1323 sm->worker_in2out_cb (&ip, m->fib_index, 0),
1328 /* Assign workers */
1329 if (sm->num_workers > 1)
1332 clib_bitmap_foreach (i, bitmap,
1334 vec_add1(m->workers, i);
1342 return VNET_API_ERROR_NO_SUCH_ENTRY;
1344 if (!is_lb_static_mapping (m))
1345 return VNET_API_ERROR_INVALID_VALUE;
1347 /* Free external address port */
1348 if (!(sm->static_mapping_only || out2in_only))
1350 for (i = 0; i < vec_len (sm->addresses); i++)
1352 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1354 a = sm->addresses + i;
1357 #define _(N, j, n, s) \
1358 case SNAT_PROTOCOL_##N: \
1359 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
1360 if (e_port > 1024) \
1362 a->busy_##n##_ports--; \
1363 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1366 foreach_snat_protocol
1369 nat_elog_info ("unknown protocol");
1370 return VNET_API_ERROR_INVALID_VALUE_2;
1377 m_key.addr = m->external_addr;
1378 m_key.port = m->external_port;
1379 m_key.protocol = m->proto;
1380 m_key.fib_index = 0;
1381 kv.key = m_key.as_u64;
1382 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0))
1384 nat_elog_err ("static_mapping_by_external key del failed");
1385 return VNET_API_ERROR_UNSPECIFIED;
1389 pool_foreach (local, m->locals,
1391 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4,
1393 m_key.addr = local->addr;
1396 m_key.port = local->port;
1397 m_key.fib_index = local->fib_index;
1398 kv.key = m_key.as_u64;
1399 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1401 nat_elog_err ("static_mapping_by_local key del failed");
1402 return VNET_API_ERROR_UNSPECIFIED;
1406 if (sm->num_workers > 1)
1409 .src_address = local->addr,
1411 tsm = vec_elt_at_index (sm->per_thread_data,
1412 sm->worker_in2out_cb (&ip, m->fib_index, 0));
1415 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1417 /* Delete sessions */
1418 u_key.addr = local->addr;
1419 u_key.fib_index = local->fib_index;
1420 kv.key = u_key.as_u64;
1421 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1423 u = pool_elt_at_index (tsm->users, value.value);
1424 if (u->nstaticsessions)
1426 head_index = u->sessions_per_user_list_head_index;
1427 head = pool_elt_at_index (tsm->list_pool, head_index);
1428 elt_index = head->next;
1429 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1430 ses_index = elt->value;
1431 while (ses_index != ~0)
1433 s = pool_elt_at_index (tsm->sessions, ses_index);
1434 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1435 ses_index = elt->value;
1437 if (!(is_lb_session (s)))
1440 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1441 (clib_net_to_host_u16 (s->in2out.port) != local->port))
1444 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1445 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1452 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1453 pool_free (m->locals);
1455 vec_free (m->workers);
1457 pool_put (sm->static_mappings, m);
1464 nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1465 ip4_address_t l_addr, u16 l_port,
1466 snat_protocol_t proto, u32 vrf_id,
1467 u8 probability, u8 is_add)
1469 snat_main_t *sm = &snat_main;
1470 snat_static_mapping_t *m = 0;
1471 snat_session_key_t m_key;
1472 clib_bihash_kv_8_8_t kv, value;
1473 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1474 snat_main_per_thread_data_t *tsm;
1475 snat_user_key_t u_key;
1478 dlist_elt_t *head, *elt;
1479 u32 elt_index, head_index, ses_index, *locals = 0;
1483 if (!sm->endpoint_dependent)
1484 return VNET_API_ERROR_FEATURE_DISABLED;
1486 m_key.addr = e_addr;
1487 m_key.port = e_port;
1488 m_key.protocol = proto;
1489 m_key.fib_index = 0;
1490 kv.key = m_key.as_u64;
1491 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1492 m = pool_elt_at_index (sm->static_mappings, value.value);
1495 return VNET_API_ERROR_NO_SUCH_ENTRY;
1497 if (!is_lb_static_mapping (m))
1498 return VNET_API_ERROR_INVALID_VALUE;
1501 pool_foreach (local, m->locals,
1503 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1504 (local->vrf_id == vrf_id))
1506 match_local = local;
1515 return VNET_API_ERROR_VALUE_EXIST;
1517 pool_get (m->locals, local);
1518 clib_memset (local, 0, sizeof (*local));
1519 local->addr.as_u32 = l_addr.as_u32;
1520 local->port = l_port;
1521 local->probability = probability;
1522 local->vrf_id = vrf_id;
1524 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1527 if (!is_out2in_only_static_mapping (m))
1529 m_key.addr = l_addr;
1530 m_key.port = l_port;
1531 m_key.fib_index = local->fib_index;
1532 kv.key = m_key.as_u64;
1533 kv.value = m - sm->static_mappings;
1534 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1))
1535 nat_elog_err ("static_mapping_by_local key add failed");
1541 return VNET_API_ERROR_NO_SUCH_ENTRY;
1543 if (pool_elts (m->locals) < 3)
1544 return VNET_API_ERROR_UNSPECIFIED;
1546 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1549 if (!is_out2in_only_static_mapping (m))
1551 m_key.addr = l_addr;
1552 m_key.port = l_port;
1553 m_key.fib_index = match_local->fib_index;
1554 kv.key = m_key.as_u64;
1555 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0))
1556 nat_elog_err ("static_mapping_by_local key del failed");
1559 if (sm->num_workers > 1)
1562 .src_address = local->addr,
1564 tsm = vec_elt_at_index (sm->per_thread_data,
1565 sm->worker_in2out_cb (&ip, m->fib_index,
1569 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1571 /* Delete sessions */
1572 u_key.addr = match_local->addr;
1573 u_key.fib_index = match_local->fib_index;
1574 kv.key = u_key.as_u64;
1575 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1577 u = pool_elt_at_index (tsm->users, value.value);
1578 if (u->nstaticsessions)
1580 head_index = u->sessions_per_user_list_head_index;
1581 head = pool_elt_at_index (tsm->list_pool, head_index);
1582 elt_index = head->next;
1583 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1584 ses_index = elt->value;
1585 while (ses_index != ~0)
1587 s = pool_elt_at_index (tsm->sessions, ses_index);
1588 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1589 ses_index = elt->value;
1591 if (!(is_lb_session (s)))
1594 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1595 (clib_net_to_host_u16 (s->in2out.port) !=
1599 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1600 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1605 pool_put (m->locals, match_local);
1608 vec_free (m->workers);
1611 pool_foreach (local, m->locals,
1613 vec_add1 (locals, local - m->locals);
1614 if (sm->num_workers > 1)
1617 ip.src_address.as_u32 = local->addr.as_u32,
1618 bitmap = clib_bitmap_set (bitmap,
1619 sm->worker_in2out_cb (&ip, local->fib_index, 0),
1625 ASSERT (vec_len (locals) > 1);
1627 local = pool_elt_at_index (m->locals, locals[0]);
1628 local->prefix = local->probability;
1629 for (i = 1; i < vec_len (locals); i++)
1631 local = pool_elt_at_index (m->locals, locals[i]);
1632 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1633 local->prefix = local->probability + prev_local->prefix;
1636 /* Assign workers */
1637 if (sm->num_workers > 1)
1640 clib_bitmap_foreach (i, bitmap, ({ vec_add1(m->workers, i); }));
1648 snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1651 snat_address_t *a = 0;
1652 snat_session_t *ses;
1653 u32 *ses_to_be_removed = 0, *ses_index;
1654 snat_main_per_thread_data_t *tsm;
1655 snat_static_mapping_t *m;
1656 snat_interface_t *interface;
1658 snat_address_t *addresses =
1659 twice_nat ? sm->twice_nat_addresses : sm->addresses;
1661 /* Find SNAT address */
1662 for (i = 0; i < vec_len (addresses); i++)
1664 if (addresses[i].addr.as_u32 == addr.as_u32)
1671 return VNET_API_ERROR_NO_SUCH_ENTRY;
1676 pool_foreach (m, sm->static_mappings,
1678 if (m->external_addr.as_u32 == addr.as_u32)
1679 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1680 m->local_port, m->external_port,
1681 m->vrf_id, is_addr_only_static_mapping(m), ~0,
1682 m->proto, 0, m->twice_nat,
1683 is_out2in_only_static_mapping(m), m->tag, is_identity_static_mapping(m));
1689 /* Check if address is used in some static mapping */
1690 if (is_snat_address_used_in_static_mapping (sm, addr))
1692 nat_elog_notice ("address used in static mapping");
1693 return VNET_API_ERROR_UNSPECIFIED;
1697 if (a->fib_index != ~0)
1698 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1700 /* Delete sessions using address */
1701 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1704 vec_foreach (tsm, sm->per_thread_data)
1706 pool_foreach (ses, tsm->sessions, ({
1707 if (ses->out2in.addr.as_u32 == addr.as_u32)
1709 nat_free_session_data (sm, ses, tsm - sm->per_thread_data, 0);
1710 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1714 vec_foreach (ses_index, ses_to_be_removed)
1716 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1717 nat44_delete_session (sm, ses, tsm - sm->per_thread_data);
1720 vec_free (ses_to_be_removed);
1725 #define _(N, i, n, s) \
1726 clib_bitmap_free (a->busy_##n##_port_bitmap); \
1727 vec_free (a->busy_##n##_ports_per_thread);
1728 foreach_snat_protocol
1732 vec_del1 (sm->twice_nat_addresses, i);
1736 vec_del1 (sm->addresses, i);
1738 /* Delete external address from FIB */
1740 pool_foreach (interface, sm->interfaces,
1742 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1745 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1748 pool_foreach (interface, sm->output_feature_interfaces,
1750 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1753 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1762 snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1764 snat_main_t *sm = &snat_main;
1765 snat_interface_t *i;
1766 const char *feature_name, *del_feature_name;
1768 snat_static_mapping_t *m;
1770 nat_outside_fib_t *outside_fib;
1771 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1774 if (sm->out2in_dpo && !is_inside)
1775 return VNET_API_ERROR_UNSUPPORTED;
1778 pool_foreach (i, sm->output_feature_interfaces,
1780 if (i->sw_if_index == sw_if_index)
1781 return VNET_API_ERROR_VALUE_EXIST;
1785 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1786 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1789 if (sm->num_workers > 1 && !sm->deterministic)
1791 is_inside ? "nat44-in2out-worker-handoff" :
1792 "nat44-out2in-worker-handoff";
1793 else if (sm->deterministic)
1794 feature_name = is_inside ? "nat44-det-in2out" : "nat44-det-out2in";
1795 else if (sm->endpoint_dependent)
1797 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1800 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1803 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1804 sm->fq_in2out_index =
1805 vlib_frame_queue_main_init (sm->handoff_in2out_index, NAT_FQ_NELTS);
1807 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1808 sm->fq_out2in_index =
1809 vlib_frame_queue_main_init (sm->handoff_out2in_index, NAT_FQ_NELTS);
1814 vec_foreach (outside_fib, sm->outside_fibs)
1816 if (outside_fib->fib_index == fib_index)
1820 outside_fib->refcount--;
1821 if (!outside_fib->refcount)
1822 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1825 outside_fib->refcount++;
1832 vec_add2 (sm->outside_fibs, outside_fib, 1);
1833 outside_fib->refcount = 1;
1834 outside_fib->fib_index = fib_index;
1839 pool_foreach (i, sm->interfaces,
1841 if (i->sw_if_index == sw_if_index)
1845 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1848 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1850 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1852 if (sm->num_workers > 1 && !sm->deterministic)
1854 del_feature_name = "nat44-handoff-classify";
1855 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1856 "nat44-out2in-worker-handoff";
1858 else if (sm->deterministic)
1860 del_feature_name = "nat44-det-classify";
1861 feature_name = !is_inside ? "nat44-det-in2out" :
1864 else if (sm->endpoint_dependent)
1866 del_feature_name = "nat44-ed-classify";
1867 feature_name = !is_inside ? "nat-pre-in2out" :
1872 del_feature_name = "nat44-classify";
1873 feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1876 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1879 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1880 sw_if_index, 0, 0, 0);
1881 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1882 sw_if_index, 1, 0, 0);
1885 if (sm->endpoint_dependent)
1886 vnet_feature_enable_disable ("ip4-local",
1887 "nat44-ed-hairpinning",
1888 sw_if_index, 1, 0, 0);
1889 else if (!sm->deterministic)
1890 vnet_feature_enable_disable ("ip4-local",
1891 "nat44-hairpinning",
1892 sw_if_index, 1, 0, 0);
1897 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1900 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1901 sw_if_index, 0, 0, 0);
1902 pool_put (sm->interfaces, i);
1905 if (sm->endpoint_dependent)
1906 vnet_feature_enable_disable ("ip4-local",
1907 "nat44-ed-hairpinning",
1908 sw_if_index, 0, 0, 0);
1909 else if (!sm->deterministic)
1910 vnet_feature_enable_disable ("ip4-local",
1911 "nat44-hairpinning",
1912 sw_if_index, 0, 0, 0);
1918 if ((nat_interface_is_inside(i) && is_inside) ||
1919 (nat_interface_is_outside(i) && !is_inside))
1922 if (sm->num_workers > 1 && !sm->deterministic)
1924 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1925 "nat44-out2in-worker-handoff";
1926 feature_name = "nat44-handoff-classify";
1928 else if (sm->deterministic)
1930 del_feature_name = !is_inside ? "nat44-det-in2out" :
1932 feature_name = "nat44-det-classify";
1934 else if (sm->endpoint_dependent)
1936 del_feature_name = !is_inside ? "nat-pre-in2out" :
1939 feature_name = "nat44-ed-classify";
1943 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1944 feature_name = "nat44-classify";
1947 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1950 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1951 sw_if_index, 0, 0, 0);
1952 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1953 sw_if_index, 1, 0, 0);
1956 if (sm->endpoint_dependent)
1957 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
1958 sw_if_index, 0, 0, 0);
1959 else if (!sm->deterministic)
1960 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1961 sw_if_index, 0, 0, 0);
1972 return VNET_API_ERROR_NO_SUCH_ENTRY;
1974 pool_get (sm->interfaces, i);
1975 i->sw_if_index = sw_if_index;
1977 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0,
1980 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1984 if (is_inside && !sm->out2in_dpo)
1986 if (sm->endpoint_dependent)
1987 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
1988 sw_if_index, 1, 0, 0);
1989 else if (!sm->deterministic)
1990 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1991 sw_if_index, 1, 0, 0);
1997 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2001 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2003 /* Add/delete external addresses to FIB */
2006 vec_foreach (ap, sm->addresses)
2007 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2009 pool_foreach (m, sm->static_mappings,
2011 if (!(is_addr_only_static_mapping(m)) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2014 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2017 pool_foreach (dm, sm->det_maps,
2019 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
2027 snat_interface_add_del_output_feature (u32 sw_if_index,
2028 u8 is_inside, int is_del)
2030 snat_main_t *sm = &snat_main;
2031 snat_interface_t *i;
2033 snat_static_mapping_t *m;
2034 nat_outside_fib_t *outside_fib;
2035 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
2039 if (sm->deterministic ||
2040 (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
2041 return VNET_API_ERROR_UNSUPPORTED;
2044 pool_foreach (i, sm->interfaces,
2046 if (i->sw_if_index == sw_if_index)
2047 return VNET_API_ERROR_VALUE_EXIST;
2054 vec_foreach (outside_fib, sm->outside_fibs)
2056 if (outside_fib->fib_index == fib_index)
2060 outside_fib->refcount--;
2061 if (!outside_fib->refcount)
2062 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2065 outside_fib->refcount++;
2072 vec_add2 (sm->outside_fibs, outside_fib, 1);
2073 outside_fib->refcount = 1;
2074 outside_fib->fib_index = fib_index;
2081 if (sm->endpoint_dependent)
2084 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2088 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2092 vnet_feature_enable_disable ("ip4-unicast", "nat44-ed-hairpin-dst",
2093 sw_if_index, !is_del, 0, 0);
2094 vnet_feature_enable_disable ("ip4-output", "nat44-ed-hairpin-src",
2095 sw_if_index, !is_del, 0, 0);
2100 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2104 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2108 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
2109 sw_if_index, !is_del, 0, 0);
2110 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
2111 sw_if_index, !is_del, 0, 0);
2116 if (sm->num_workers > 1)
2118 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2122 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, !is_del);
2125 vnet_feature_enable_disable ("ip4-unicast",
2126 "nat44-out2in-worker-handoff",
2127 sw_if_index, !is_del, 0, 0);
2128 vnet_feature_enable_disable ("ip4-output",
2129 "nat44-in2out-output-worker-handoff",
2130 sw_if_index, !is_del, 0, 0);
2134 if (sm->endpoint_dependent)
2137 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2141 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2145 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
2146 sw_if_index, !is_del, 0, 0);
2147 vnet_feature_enable_disable ("ip4-output", "nat44-ed-in2out-output",
2148 sw_if_index, !is_del, 0, 0);
2153 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2157 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2161 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in",
2162 sw_if_index, !is_del, 0, 0);
2163 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
2164 sw_if_index, !is_del, 0, 0);
2169 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
2170 sm->fq_in2out_output_index =
2171 vlib_frame_queue_main_init (sm->handoff_in2out_output_index, 0);
2173 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
2174 sm->fq_out2in_index =
2175 vlib_frame_queue_main_init (sm->handoff_out2in_index, 0);
2178 pool_foreach (i, sm->output_feature_interfaces,
2180 if (i->sw_if_index == sw_if_index)
2183 pool_put (sm->output_feature_interfaces, i);
2185 return VNET_API_ERROR_VALUE_EXIST;
2193 return VNET_API_ERROR_NO_SUCH_ENTRY;
2195 pool_get (sm->output_feature_interfaces, i);
2196 i->sw_if_index = sw_if_index;
2199 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2201 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2203 /* Add/delete external addresses to FIB */
2209 vec_foreach (ap, sm->addresses)
2210 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2212 pool_foreach (m, sm->static_mappings,
2214 if (!((is_addr_only_static_mapping(m))) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2217 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2225 snat_set_workers (uword * bitmap)
2227 snat_main_t *sm = &snat_main;
2230 if (sm->num_workers < 2)
2231 return VNET_API_ERROR_FEATURE_DISABLED;
2233 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2234 return VNET_API_ERROR_INVALID_WORKER;
2236 vec_free (sm->workers);
2238 clib_bitmap_foreach (i, bitmap,
2240 vec_add1(sm->workers, i);
2241 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2242 sm->per_thread_data[sm->first_worker_index + i].thread_index = i;
2247 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
2248 sm->num_snat_thread = _vec_len (sm->workers);
2254 snat_update_outside_fib (u32 sw_if_index, u32 new_fib_index,
2257 snat_main_t *sm = &snat_main;
2258 nat_outside_fib_t *outside_fib;
2259 snat_interface_t *i;
2263 if (new_fib_index == old_fib_index)
2266 if (!vec_len (sm->outside_fibs))
2270 pool_foreach (i, sm->interfaces,
2272 if (i->sw_if_index == sw_if_index)
2274 if (!(nat_interface_is_outside (i)))
2280 pool_foreach (i, sm->output_feature_interfaces,
2282 if (i->sw_if_index == sw_if_index)
2284 if (!(nat_interface_is_outside (i)))
2294 vec_foreach (outside_fib, sm->outside_fibs)
2296 if (outside_fib->fib_index == old_fib_index)
2298 outside_fib->refcount--;
2299 if (!outside_fib->refcount)
2300 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2305 vec_foreach (outside_fib, sm->outside_fibs)
2307 if (outside_fib->fib_index == new_fib_index)
2309 outside_fib->refcount++;
2317 vec_add2 (sm->outside_fibs, outside_fib, 1);
2318 outside_fib->refcount = 1;
2319 outside_fib->fib_index = new_fib_index;
2324 snat_ip4_table_bind (ip4_main_t * im,
2326 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
2328 snat_update_outside_fib (sw_if_index, new_fib_index, old_fib_index);
2332 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2335 ip4_address_t * address,
2337 u32 if_address_index, u32 is_delete);
2340 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
2343 ip4_address_t * address,
2345 u32 if_address_index, u32 is_delete);
2348 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2351 snat_session_key_t * k,
2352 u16 port_per_thread, u32 snat_thread_index);
2354 static clib_error_t *
2355 snat_init (vlib_main_t * vm)
2357 snat_main_t *sm = &snat_main;
2358 clib_error_t *error = 0;
2359 ip4_main_t *im = &ip4_main;
2360 ip_lookup_main_t *lm = &im->lookup_main;
2362 vlib_thread_registration_t *tr;
2363 vlib_thread_main_t *tm = vlib_get_thread_main ();
2366 ip4_add_del_interface_address_callback_t cb4;
2370 sm->vnet_main = vnet_get_main ();
2372 sm->ip4_lookup_main = lm;
2373 sm->api_main = vlibapi_get_main ();
2374 sm->first_worker_index = 0;
2375 sm->num_workers = 0;
2376 sm->num_snat_thread = 1;
2378 sm->port_per_thread = 0xffff - 1024;
2379 sm->fq_in2out_index = ~0;
2380 sm->fq_in2out_output_index = ~0;
2381 sm->fq_out2in_index = ~0;
2384 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
2385 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
2386 sm->forwarding_enabled = 0;
2387 sm->log_class = vlib_log_register_class ("nat", 0);
2388 sm->log_level = SNAT_LOG_ERROR;
2389 sm->mss_clamping = 0;
2391 node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
2392 sm->error_node_index = node->index;
2394 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2395 sm->pre_in2out_node_index = node->index;
2396 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2397 sm->pre_out2in_node_index = node->index;
2399 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2400 sm->pre_in2out_node_index = node->index;
2402 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2403 sm->pre_out2in_node_index = node->index;
2405 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out");
2406 sm->in2out_node_index = node->index;
2407 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output");
2408 sm->in2out_output_node_index = node->index;
2409 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-fast");
2410 sm->in2out_fast_node_index = node->index;
2411 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-slowpath");
2412 sm->in2out_slowpath_node_index = node->index;
2413 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output-slowpath");
2414 sm->in2out_slowpath_output_node_index = node->index;
2416 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out");
2417 sm->ed_in2out_node_index = node->index;
2418 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-slowpath");
2419 sm->ed_in2out_slowpath_node_index = node->index;
2421 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in");
2422 sm->out2in_node_index = node->index;
2423 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in-fast");
2424 sm->out2in_fast_node_index = node->index;
2426 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in");
2427 sm->ed_out2in_node_index = node->index;
2428 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in-slowpath");
2429 sm->ed_out2in_slowpath_node_index = node->index;
2431 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-in2out");
2432 sm->det_in2out_node_index = node->index;
2433 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-out2in");
2434 sm->det_out2in_node_index = node->index;
2436 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpinning");
2437 sm->hairpinning_node_index = node->index;
2438 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-dst");
2439 sm->hairpin_dst_node_index = node->index;
2440 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-src");
2441 sm->hairpin_src_node_index = node->index;
2442 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpinning");
2443 sm->ed_hairpinning_node_index = node->index;
2444 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-dst");
2445 sm->ed_hairpin_dst_node_index = node->index;
2446 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-src");
2447 sm->ed_hairpin_src_node_index = node->index;
2449 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2452 tr = (vlib_thread_registration_t *) p[0];
2455 sm->num_workers = tr->count;
2456 sm->first_worker_index = tr->first_index;
2460 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2462 /* Use all available workers by default */
2463 if (sm->num_workers > 1)
2465 for (i = 0; i < sm->num_workers; i++)
2466 bitmap = clib_bitmap_set (bitmap, i, 1);
2467 snat_set_workers (bitmap);
2468 clib_bitmap_free (bitmap);
2472 sm->per_thread_data[0].snat_thread_index = 0;
2475 error = snat_api_init (vm, sm);
2479 /* Set up the interface address add/del callback */
2480 cb4.function = snat_ip4_add_del_interface_address_cb;
2481 cb4.function_opaque = 0;
2483 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2485 cb4.function = nat_ip4_add_del_addr_only_sm_cb;
2486 cb4.function_opaque = 0;
2488 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2490 nat_dpo_module_init ();
2493 sm->total_users.name = "total-users";
2494 sm->total_users.stat_segment_name = "/nat44/total-users";
2495 vlib_validate_simple_counter (&sm->total_users, 0);
2496 vlib_zero_simple_counter (&sm->total_users, 0);
2497 sm->total_sessions.name = "total-sessions";
2498 sm->total_sessions.stat_segment_name = "/nat44/total-sessions";
2499 vlib_validate_simple_counter (&sm->total_sessions, 0);
2500 vlib_zero_simple_counter (&sm->total_sessions, 0);
2502 /* Init IPFIX logging */
2503 snat_ipfix_logging_init (vm);
2506 error = nat64_init (vm);
2514 ip4_table_bind_callback_t cbt4 = {
2515 .function = snat_ip4_table_bind,
2517 vec_add1 (ip4_main.table_bind_callbacks, cbt4);
2519 nat_fib_src_hi = fib_source_allocate ("nat-hi",
2520 FIB_SOURCE_PRIORITY_HI,
2521 FIB_SOURCE_BH_SIMPLE);
2522 nat_fib_src_low = fib_source_allocate ("nat-low",
2523 FIB_SOURCE_PRIORITY_LOW,
2524 FIB_SOURCE_BH_SIMPLE);
2529 VLIB_INIT_FUNCTION (snat_init);
2532 snat_free_outside_address_and_port (snat_address_t * addresses,
2533 u32 thread_index, snat_session_key_t * k)
2537 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2539 for (address_index = 0; address_index < vec_len (addresses);
2542 if (addresses[address_index].addr.as_u32 == k->addr.as_u32)
2546 ASSERT (address_index < vec_len (addresses));
2548 a = addresses + address_index;
2550 switch (k->protocol)
2552 #define _(N, i, n, s) \
2553 case SNAT_PROTOCOL_##N: \
2554 ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
2555 port_host_byte_order) == 1); \
2556 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
2557 port_host_byte_order, 0); \
2558 a->busy_##n##_ports--; \
2559 a->busy_##n##_ports_per_thread[thread_index]--; \
2561 foreach_snat_protocol
2564 nat_elog_info ("unknown protocol");
2570 nat_set_outside_address_and_port (snat_address_t * addresses,
2571 u32 thread_index, snat_session_key_t * k)
2573 snat_address_t *a = 0;
2575 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2577 for (address_index = 0; address_index < vec_len (addresses);
2580 if (addresses[address_index].addr.as_u32 != k->addr.as_u32)
2583 a = addresses + address_index;
2584 switch (k->protocol)
2586 #define _(N, j, n, s) \
2587 case SNAT_PROTOCOL_##N: \
2588 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, port_host_byte_order)) \
2589 return VNET_API_ERROR_INSTANCE_IN_USE; \
2590 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, port_host_byte_order, 1); \
2591 a->busy_##n##_ports_per_thread[thread_index]++; \
2592 a->busy_##n##_ports++; \
2594 foreach_snat_protocol
2597 nat_elog_info ("unknown protocol");
2602 return VNET_API_ERROR_NO_SUCH_ENTRY;
2606 snat_static_mapping_match (snat_main_t * sm,
2607 snat_session_key_t match,
2608 snat_session_key_t * mapping,
2611 twice_nat_type_t * twice_nat,
2612 lb_nat_type_t * lb, ip4_address_t * ext_host_addr,
2613 u8 * is_identity_nat)
2615 clib_bihash_kv_8_8_t kv, value;
2616 snat_static_mapping_t *m;
2617 snat_session_key_t m_key;
2618 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
2619 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2621 nat44_lb_addr_port_t *local;
2623 m_key.fib_index = match.fib_index;
2626 mapping_hash = &sm->static_mapping_by_external;
2627 m_key.fib_index = 0;
2630 m_key.addr = match.addr;
2631 m_key.port = clib_net_to_host_u16 (match.port);
2632 m_key.protocol = match.protocol;
2634 kv.key = m_key.as_u64;
2636 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2638 /* Try address only mapping */
2641 kv.key = m_key.as_u64;
2642 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2646 m = pool_elt_at_index (sm->static_mappings, value.value);
2650 if (is_lb_static_mapping (m))
2652 if (PREDICT_FALSE (lb != 0))
2653 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2654 if (m->affinity && !nat_affinity_find_and_lock (ext_host_addr[0],
2660 local = pool_elt_at_index (m->locals, backend_index);
2661 mapping->addr = local->addr;
2662 mapping->port = clib_host_to_net_u16 (local->port);
2663 mapping->fib_index = local->fib_index;
2666 // pick locals matching this worker
2667 if (PREDICT_FALSE (sm->num_workers > 1))
2669 u32 thread_index = vlib_get_thread_index ();
2671 pool_foreach_index (i, m->locals,
2673 local = pool_elt_at_index (m->locals, i);
2676 .src_address = local->addr,
2679 if (sm->worker_in2out_cb (&ip, m->fib_index, 0) ==
2686 ASSERT (vec_len (tmp) != 0);
2691 pool_foreach_index (i, m->locals,
2697 hi = vec_len (tmp) - 1;
2698 local = pool_elt_at_index (m->locals, tmp[hi]);
2699 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2702 mid = ((hi - lo) >> 1) + lo;
2703 local = pool_elt_at_index (m->locals, tmp[mid]);
2704 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2706 local = pool_elt_at_index (m->locals, tmp[lo]);
2707 if (!(local->prefix >= rand))
2709 mapping->addr = local->addr;
2710 mapping->port = clib_host_to_net_u16 (local->port);
2711 mapping->fib_index = local->fib_index;
2714 if (nat_affinity_create_and_lock (ext_host_addr[0], match.addr,
2715 match.protocol, match.port,
2716 tmp[lo], m->affinity,
2717 m->affinity_per_service_list_head_index))
2718 nat_elog_info ("create affinity record failed");
2724 if (PREDICT_FALSE (lb != 0))
2726 mapping->fib_index = m->fib_index;
2727 mapping->addr = m->local_addr;
2728 /* Address only mapping doesn't change port */
2729 mapping->port = is_addr_only_static_mapping (m) ? match.port
2730 : clib_host_to_net_u16 (m->local_port);
2732 mapping->protocol = m->proto;
2736 mapping->addr = m->external_addr;
2737 /* Address only mapping doesn't change port */
2738 mapping->port = is_addr_only_static_mapping (m) ? match.port
2739 : clib_host_to_net_u16 (m->external_port);
2740 mapping->fib_index = sm->outside_fib_index;
2744 if (PREDICT_FALSE (is_addr_only != 0))
2745 *is_addr_only = is_addr_only_static_mapping (m);
2747 if (PREDICT_FALSE (twice_nat != 0))
2748 *twice_nat = m->twice_nat;
2750 if (PREDICT_FALSE (is_identity_nat != 0))
2751 *is_identity_nat = is_identity_static_mapping (m);
2756 static_always_inline u16
2757 snat_random_port (u16 min, u16 max)
2759 snat_main_t *sm = &snat_main;
2760 return min + random_u32 (&sm->random_seed) /
2761 (random_u32_max () / (max - min + 1) + 1);
2765 snat_alloc_outside_address_and_port (snat_address_t * addresses,
2768 snat_session_key_t * k,
2769 u16 port_per_thread,
2770 u32 snat_thread_index)
2772 snat_main_t *sm = &snat_main;
2774 return sm->alloc_addr_and_port (addresses, fib_index, thread_index, k,
2775 port_per_thread, snat_thread_index);
2779 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2782 snat_session_key_t * k,
2783 u16 port_per_thread, u32 snat_thread_index)
2786 snat_address_t *a, *ga = 0;
2789 for (i = 0; i < vec_len (addresses); i++)
2792 switch (k->protocol)
2794 #define _(N, j, n, s) \
2795 case SNAT_PROTOCOL_##N: \
2796 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
2798 if (a->fib_index == fib_index) \
2802 portnum = (port_per_thread * \
2803 snat_thread_index) + \
2804 snat_random_port(1, port_per_thread) + 1024; \
2805 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2807 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2808 a->busy_##n##_ports_per_thread[thread_index]++; \
2809 a->busy_##n##_ports++; \
2810 k->addr = a->addr; \
2811 k->port = clib_host_to_net_u16(portnum); \
2815 else if (a->fib_index == ~0) \
2821 foreach_snat_protocol
2824 nat_elog_info ("unknown protocol");
2833 switch (k->protocol)
2835 #define _(N, j, n, s) \
2836 case SNAT_PROTOCOL_##N: \
2839 portnum = (port_per_thread * \
2840 snat_thread_index) + \
2841 snat_random_port(1, port_per_thread) + 1024; \
2842 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2844 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2845 a->busy_##n##_ports_per_thread[thread_index]++; \
2846 a->busy_##n##_ports++; \
2847 k->addr = a->addr; \
2848 k->port = clib_host_to_net_u16(portnum); \
2852 foreach_snat_protocol
2855 nat_elog_info ("unknown protocol");
2860 /* Totally out of translations to use... */
2861 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
2866 nat_alloc_addr_and_port_mape (snat_address_t * addresses,
2869 snat_session_key_t * k,
2870 u16 port_per_thread, u32 snat_thread_index)
2872 snat_main_t *sm = &snat_main;
2873 snat_address_t *a = addresses;
2874 u16 m, ports, portnum, A, j;
2875 m = 16 - (sm->psid_offset + sm->psid_length);
2876 ports = (1 << (16 - sm->psid_length)) - (1 << m);
2878 if (!vec_len (addresses))
2881 switch (k->protocol)
2883 #define _(N, i, n, s) \
2884 case SNAT_PROTOCOL_##N: \
2885 if (a->busy_##n##_ports < ports) \
2889 A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
2890 j = snat_random_port(0, pow2_mask(m)); \
2891 portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
2892 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2894 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2895 a->busy_##n##_ports++; \
2896 k->addr = a->addr; \
2897 k->port = clib_host_to_net_u16 (portnum); \
2902 foreach_snat_protocol
2905 nat_elog_info ("unknown protocol");
2910 /* Totally out of translations to use... */
2911 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
2916 nat_alloc_addr_and_port_range (snat_address_t * addresses,
2919 snat_session_key_t * k,
2920 u16 port_per_thread, u32 snat_thread_index)
2922 snat_main_t *sm = &snat_main;
2923 snat_address_t *a = addresses;
2926 ports = sm->end_port - sm->start_port + 1;
2928 if (!vec_len (addresses))
2931 switch (k->protocol)
2933 #define _(N, i, n, s) \
2934 case SNAT_PROTOCOL_##N: \
2935 if (a->busy_##n##_ports < ports) \
2939 portnum = snat_random_port(sm->start_port, sm->end_port); \
2940 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2942 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2943 a->busy_##n##_ports++; \
2944 k->addr = a->addr; \
2945 k->port = clib_host_to_net_u16 (portnum); \
2950 foreach_snat_protocol
2953 nat_elog_info ("unknown protocol");
2958 /* Totally out of translations to use... */
2959 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
2964 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
2966 dpo_id_t dpo_v4 = DPO_INVALID;
2967 fib_prefix_t pfx = {
2968 .fp_proto = FIB_PROTOCOL_IP4,
2970 .fp_addr.ip4.as_u32 = addr.as_u32,
2975 nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
2976 fib_table_entry_special_dpo_add (0, &pfx, nat_fib_src_hi,
2977 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
2978 dpo_reset (&dpo_v4);
2982 fib_table_entry_special_remove (0, &pfx, nat_fib_src_hi);
2987 format_session_kvp (u8 * s, va_list * args)
2989 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
2990 snat_session_key_t k;
2994 s = format (s, "%U session-index %llu", format_snat_key, &k, v->value);
3000 format_static_mapping_kvp (u8 * s, va_list * args)
3002 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3003 snat_session_key_t k;
3007 s = format (s, "%U static-mapping-index %llu",
3008 format_static_mapping_key, &k, v->value);
3014 format_user_kvp (u8 * s, va_list * args)
3016 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3021 s = format (s, "%U fib %d user-index %llu", format_ip4_address, &k.addr,
3022 k.fib_index, v->value);
3028 format_ed_session_kvp (u8 * s, va_list * args)
3030 clib_bihash_kv_16_8_t *v = va_arg (*args, clib_bihash_kv_16_8_t *);
3033 k.as_u64[0] = v->key[0];
3034 k.as_u64[1] = v->key[1];
3037 format (s, "local %U:%d remote %U:%d proto %U fib %d session-index %llu",
3038 format_ip4_address, &k.l_addr, clib_net_to_host_u16 (k.l_port),
3039 format_ip4_address, &k.r_addr, clib_net_to_host_u16 (k.r_port),
3040 format_ip_protocol, k.proto, k.fib_index, v->value);
3046 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0,
3049 snat_main_t *sm = &snat_main;
3050 u32 next_worker_index = 0;
3053 next_worker_index = sm->first_worker_index;
3054 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
3055 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >> 24);
3057 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3058 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3060 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3062 return next_worker_index;
3066 snat_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip0,
3067 u32 rx_fib_index0, u8 is_output)
3069 snat_main_t *sm = &snat_main;
3072 snat_session_key_t m_key;
3073 clib_bihash_kv_8_8_t kv, value;
3074 snat_static_mapping_t *m;
3076 u32 next_worker_index = 0;
3078 /* first try static mappings without port */
3079 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3081 m_key.addr = ip0->dst_address;
3084 m_key.fib_index = rx_fib_index0;
3085 kv.key = m_key.as_u64;
3086 if (!clib_bihash_search_8_8
3087 (&sm->static_mapping_by_external, &kv, &value))
3089 m = pool_elt_at_index (sm->static_mappings, value.value);
3090 return m->workers[0];
3094 proto = ip_proto_to_snat_proto (ip0->protocol);
3095 udp = ip4_next_header (ip0);
3096 port = udp->dst_port;
3098 /* unknown protocol */
3099 if (PREDICT_FALSE (proto == ~0))
3101 /* use current thread */
3102 return vlib_get_thread_index ();
3105 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
3107 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3108 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3109 if (!icmp_type_is_error_message
3110 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3111 port = vnet_buffer (b)->ip.reass.l4_src_port;
3114 /* if error message, then it's not fragmented and we can access it */
3115 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3116 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3117 void *l4_header = ip4_next_header (inner_ip);
3120 case SNAT_PROTOCOL_ICMP:
3121 icmp = (icmp46_header_t *) l4_header;
3122 echo = (icmp_echo_header_t *) (icmp + 1);
3123 port = echo->identifier;
3125 case SNAT_PROTOCOL_UDP:
3126 case SNAT_PROTOCOL_TCP:
3127 port = ((tcp_udp_header_t *) l4_header)->src_port;
3130 return vlib_get_thread_index ();
3135 /* try static mappings with port */
3136 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3138 m_key.addr = ip0->dst_address;
3139 m_key.port = clib_net_to_host_u16 (port);
3140 m_key.protocol = proto;
3141 m_key.fib_index = rx_fib_index0;
3142 kv.key = m_key.as_u64;
3143 if (!clib_bihash_search_8_8
3144 (&sm->static_mapping_by_external, &kv, &value))
3146 m = pool_elt_at_index (sm->static_mappings, value.value);
3147 return m->workers[0];
3151 /* worker by outside port */
3152 next_worker_index = sm->first_worker_index;
3153 next_worker_index +=
3154 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3155 return next_worker_index;
3159 nat44_ed_get_worker_in2out_cb (ip4_header_t * ip, u32 rx_fib_index,
3162 snat_main_t *sm = &snat_main;
3163 u32 next_worker_index = sm->first_worker_index;
3166 clib_bihash_kv_16_8_t kv16, value16;
3167 snat_main_per_thread_data_t *tsm;
3170 if (PREDICT_FALSE (is_output))
3172 u32 fib_index = sm->outside_fib_index;
3173 nat_outside_fib_t *outside_fib;
3174 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3175 fib_prefix_t pfx = {
3176 .fp_proto = FIB_PROTOCOL_IP4,
3179 .ip4.as_u32 = ip->dst_address.as_u32,
3184 udp = ip4_next_header (ip);
3186 switch (vec_len (sm->outside_fibs))
3189 fib_index = sm->outside_fib_index;
3192 fib_index = sm->outside_fibs[0].fib_index;
3196 vec_foreach (outside_fib, sm->outside_fibs)
3198 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3199 if (FIB_NODE_INDEX_INVALID != fei)
3201 if (fib_entry_get_resolving_interface (fei) != ~0)
3203 fib_index = outside_fib->fib_index;
3212 make_ed_kv (&kv16, &ip->src_address, &ip->dst_address,
3213 ip->protocol, fib_index, udp->src_port, udp->dst_port);
3216 vec_foreach (tsm, sm->per_thread_data)
3218 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3221 next_worker_index += tsm->thread_index;
3223 nat_elog_debug_handoff (
3224 "HANDOFF IN2OUT-OUTPUT-FEATURE (session)",
3225 next_worker_index, fib_index,
3226 clib_net_to_host_u32 (ip->src_address.as_u32),
3227 clib_net_to_host_u32 (ip->dst_address.as_u32));
3229 return next_worker_index;
3235 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3236 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3238 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3239 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3241 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3243 if (PREDICT_TRUE (!is_output))
3245 nat_elog_debug_handoff ("HANDOFF IN2OUT",
3246 next_worker_index, rx_fib_index,
3247 clib_net_to_host_u32 (ip->src_address.as_u32),
3248 clib_net_to_host_u32 (ip->dst_address.as_u32));
3252 nat_elog_debug_handoff ("HANDOFF IN2OUT-OUTPUT-FEATURE",
3253 next_worker_index, rx_fib_index,
3254 clib_net_to_host_u32 (ip->src_address.as_u32),
3255 clib_net_to_host_u32 (ip->dst_address.as_u32));
3258 return next_worker_index;
3262 nat44_ed_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip,
3263 u32 rx_fib_index, u8 is_output)
3265 snat_main_t *sm = &snat_main;
3266 clib_bihash_kv_8_8_t kv, value;
3267 clib_bihash_kv_16_8_t kv16, value16;
3268 snat_main_per_thread_data_t *tsm;
3270 u32 proto, next_worker_index = 0;
3273 snat_static_mapping_t *m;
3276 proto = ip_proto_to_snat_proto (ip->protocol);
3278 if (PREDICT_TRUE (proto == SNAT_PROTOCOL_UDP || proto == SNAT_PROTOCOL_TCP))
3280 udp = ip4_next_header (ip);
3282 make_ed_kv (&kv16, &ip->dst_address, &ip->src_address,
3283 ip->protocol, rx_fib_index, udp->dst_port, udp->src_port);
3286 vec_foreach (tsm, sm->per_thread_data)
3288 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3291 next_worker_index = sm->first_worker_index + tsm->thread_index;
3292 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3293 next_worker_index, rx_fib_index,
3294 clib_net_to_host_u32 (ip->src_address.as_u32),
3295 clib_net_to_host_u32 (ip->dst_address.as_u32));
3296 return next_worker_index;
3301 else if (proto == SNAT_PROTOCOL_ICMP)
3303 nat_ed_ses_key_t key;
3305 if (!get_icmp_o2i_ed_key (b, ip, &key))
3308 key.fib_index = rx_fib_index;
3309 kv16.key[0] = key.as_u64[0];
3310 kv16.key[1] = key.as_u64[1];
3313 vec_foreach (tsm, sm->per_thread_data)
3315 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3318 next_worker_index = sm->first_worker_index +
3320 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3321 next_worker_index, rx_fib_index,
3322 clib_net_to_host_u32 (ip->src_address.as_u32),
3323 clib_net_to_host_u32 (ip->dst_address.as_u32));
3324 return next_worker_index;
3331 /* first try static mappings without port */
3332 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3334 make_sm_kv (&kv, &ip->dst_address, 0, 0, 0);
3335 if (!clib_bihash_search_8_8
3336 (&sm->static_mapping_by_external, &kv, &value))
3338 m = pool_elt_at_index (sm->static_mappings, value.value);
3339 next_worker_index = m->workers[0];
3344 /* unknown protocol */
3345 if (PREDICT_FALSE (proto == ~0))
3347 /* use current thread */
3348 next_worker_index = vlib_get_thread_index ();
3352 udp = ip4_next_header (ip);
3353 port = udp->dst_port;
3355 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
3357 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3358 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3359 if (!icmp_type_is_error_message
3360 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3361 port = vnet_buffer (b)->ip.reass.l4_src_port;
3364 /* if error message, then it's not fragmented and we can access it */
3365 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3366 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3367 void *l4_header = ip4_next_header (inner_ip);
3370 case SNAT_PROTOCOL_ICMP:
3371 icmp = (icmp46_header_t *) l4_header;
3372 echo = (icmp_echo_header_t *) (icmp + 1);
3373 port = echo->identifier;
3375 case SNAT_PROTOCOL_UDP:
3376 case SNAT_PROTOCOL_TCP:
3377 port = ((tcp_udp_header_t *) l4_header)->src_port;
3380 next_worker_index = vlib_get_thread_index ();
3386 /* try static mappings with port */
3387 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3389 make_sm_kv (&kv, &ip->dst_address, proto, 0,
3390 clib_net_to_host_u16 (port));
3391 if (!clib_bihash_search_8_8
3392 (&sm->static_mapping_by_external, &kv, &value))
3394 m = pool_elt_at_index (sm->static_mappings, value.value);
3395 if (!is_lb_static_mapping (m))
3397 next_worker_index = m->workers[0];
3401 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3402 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3404 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
3406 m->workers[hash & (_vec_len (m->workers) - 1)];
3408 next_worker_index = m->workers[hash % _vec_len (m->workers)];
3413 /* worker by outside port */
3414 next_worker_index = sm->first_worker_index;
3415 next_worker_index +=
3416 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3419 nat_elog_debug_handoff ("HANDOFF OUT2IN", next_worker_index, rx_fib_index,
3420 clib_net_to_host_u32 (ip->src_address.as_u32),
3421 clib_net_to_host_u32 (ip->dst_address.as_u32));
3422 return next_worker_index;
3426 nat_ha_sadd_cb (ip4_address_t * in_addr, u16 in_port,
3427 ip4_address_t * out_addr, u16 out_port,
3428 ip4_address_t * eh_addr, u16 eh_port,
3429 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3430 u32 fib_index, u16 flags, u32 thread_index)
3432 snat_main_t *sm = &snat_main;
3433 snat_session_key_t key;
3436 clib_bihash_kv_8_8_t kv;
3437 f64 now = vlib_time_now (sm->vlib_main);
3438 nat_outside_fib_t *outside_fib;
3439 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3440 snat_main_per_thread_data_t *tsm;
3441 fib_prefix_t pfx = {
3442 .fp_proto = FIB_PROTOCOL_IP4,
3445 .ip4.as_u32 = eh_addr->as_u32,
3449 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3451 key.addr.as_u32 = out_addr->as_u32;
3452 key.port = out_port;
3453 key.protocol = proto;
3455 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3457 if (nat_set_outside_address_and_port
3458 (sm->addresses, thread_index, &key))
3462 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3466 s = nat_session_alloc_or_recycle (sm, u, thread_index, now);
3470 s->last_heard = now;
3472 s->ext_host_addr.as_u32 = eh_addr->as_u32;
3473 s->ext_host_port = eh_port;
3474 user_session_increment (sm, u, snat_is_session_static (s));
3475 switch (vec_len (sm->outside_fibs))
3478 key.fib_index = sm->outside_fib_index;
3481 key.fib_index = sm->outside_fibs[0].fib_index;
3485 vec_foreach (outside_fib, sm->outside_fibs)
3487 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3488 if (FIB_NODE_INDEX_INVALID != fei)
3490 if (fib_entry_get_resolving_interface (fei) != ~0)
3492 key.fib_index = outside_fib->fib_index;
3501 kv.key = key.as_u64;
3502 kv.value = s - tsm->sessions;
3503 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 1))
3504 nat_elog_warn ("out2in key add failed");
3506 key.addr.as_u32 = in_addr->as_u32;
3508 key.fib_index = fib_index;
3510 kv.key = key.as_u64;
3511 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 1))
3512 nat_elog_warn ("in2out key add failed");
3516 nat_ha_sdel_cb (ip4_address_t * out_addr, u16 out_port,
3517 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3520 snat_main_t *sm = &snat_main;
3521 snat_session_key_t key;
3522 clib_bihash_kv_8_8_t kv, value;
3525 snat_main_per_thread_data_t *tsm;
3527 if (sm->num_workers > 1)
3529 sm->first_worker_index +
3530 (sm->workers[(clib_net_to_host_u16 (out_port) -
3531 1024) / sm->port_per_thread]);
3533 thread_index = sm->num_workers;
3534 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3536 key.addr.as_u32 = out_addr->as_u32;
3537 key.port = out_port;
3538 key.protocol = proto;
3539 key.fib_index = fib_index;
3540 kv.key = key.as_u64;
3541 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3544 s = pool_elt_at_index (tsm->sessions, value.value);
3545 nat_free_session_data (sm, s, thread_index, 1);
3546 nat44_delete_session (sm, s, thread_index);
3550 nat_ha_sref_cb (ip4_address_t * out_addr, u16 out_port,
3551 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3552 u32 total_pkts, u64 total_bytes, u32 thread_index)
3554 snat_main_t *sm = &snat_main;
3555 snat_session_key_t key;
3556 clib_bihash_kv_8_8_t kv, value;
3558 snat_main_per_thread_data_t *tsm;
3560 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3562 key.addr.as_u32 = out_addr->as_u32;
3563 key.port = out_port;
3564 key.protocol = proto;
3565 key.fib_index = fib_index;
3566 kv.key = key.as_u64;
3567 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3570 s = pool_elt_at_index (tsm->sessions, value.value);
3571 s->total_pkts = total_pkts;
3572 s->total_bytes = total_bytes;
3576 nat_ha_sadd_ed_cb (ip4_address_t * in_addr, u16 in_port,
3577 ip4_address_t * out_addr, u16 out_port,
3578 ip4_address_t * eh_addr, u16 eh_port,
3579 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3580 u32 fib_index, u16 flags, u32 thread_index)
3582 snat_main_t *sm = &snat_main;
3583 snat_session_key_t key;
3586 clib_bihash_kv_16_8_t kv;
3587 f64 now = vlib_time_now (sm->vlib_main);
3588 nat_outside_fib_t *outside_fib;
3589 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3590 snat_main_per_thread_data_t *tsm;
3591 fib_prefix_t pfx = {
3592 .fp_proto = FIB_PROTOCOL_IP4,
3595 .ip4.as_u32 = eh_addr->as_u32,
3599 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3601 key.addr.as_u32 = out_addr->as_u32;
3602 key.port = out_port;
3603 key.protocol = proto;
3605 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3607 if (nat_set_outside_address_and_port
3608 (sm->addresses, thread_index, &key))
3612 key.addr.as_u32 = ehn_addr->as_u32;
3613 key.port = ehn_port;
3614 if (flags & SNAT_SESSION_FLAG_TWICE_NAT)
3616 if (nat_set_outside_address_and_port
3617 (sm->twice_nat_addresses, thread_index, &key))
3621 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3625 s = nat_ed_session_alloc (sm, u, thread_index, now);
3629 s->last_heard = now;
3631 s->ext_host_nat_addr.as_u32 = s->ext_host_addr.as_u32 = eh_addr->as_u32;
3632 s->ext_host_nat_port = s->ext_host_port = eh_port;
3633 if (is_twice_nat_session (s))
3635 s->ext_host_nat_addr.as_u32 = ehn_addr->as_u32;
3636 s->ext_host_nat_port = ehn_port;
3638 user_session_increment (sm, u, snat_is_session_static (s));
3639 switch (vec_len (sm->outside_fibs))
3642 key.fib_index = sm->outside_fib_index;
3645 key.fib_index = sm->outside_fibs[0].fib_index;
3649 vec_foreach (outside_fib, sm->outside_fibs)
3651 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3652 if (FIB_NODE_INDEX_INVALID != fei)
3654 if (fib_entry_get_resolving_interface (fei) != ~0)
3656 key.fib_index = outside_fib->fib_index;
3664 key.addr.as_u32 = out_addr->as_u32;
3665 key.port = out_port;
3667 kv.value = s - tsm->sessions;
3669 key.addr.as_u32 = in_addr->as_u32;
3671 key.fib_index = fib_index;
3674 make_ed_kv (&kv, in_addr, &s->ext_host_nat_addr,
3675 snat_proto_to_ip_proto (proto), fib_index, in_port,
3676 s->ext_host_nat_port);
3677 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &kv, 1))
3678 nat_elog_warn ("in2out key add failed");
3680 make_ed_kv (&kv, out_addr, eh_addr, snat_proto_to_ip_proto (proto),
3681 s->out2in.fib_index, out_port, eh_port);
3682 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &kv, 1))
3683 nat_elog_warn ("out2in key add failed");
3687 nat_ha_sdel_ed_cb (ip4_address_t * out_addr, u16 out_port,
3688 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3689 u32 fib_index, u32 ti)
3691 snat_main_t *sm = &snat_main;
3692 nat_ed_ses_key_t key;
3693 clib_bihash_kv_16_8_t kv, value;
3696 snat_main_per_thread_data_t *tsm;
3698 if (sm->num_workers > 1)
3700 sm->first_worker_index +
3701 (sm->workers[(clib_net_to_host_u16 (out_port) -
3702 1024) / sm->port_per_thread]);
3704 thread_index = sm->num_workers;
3705 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3707 key.l_addr.as_u32 = out_addr->as_u32;
3708 key.l_port = out_port;
3709 key.r_addr.as_u32 = eh_addr->as_u32;
3710 key.r_port = eh_port;
3712 key.fib_index = fib_index;
3713 kv.key[0] = key.as_u64[0];
3714 kv.key[1] = key.as_u64[1];
3715 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3718 s = pool_elt_at_index (tsm->sessions, value.value);
3719 nat_free_session_data (sm, s, thread_index, 1);
3720 nat44_delete_session (sm, s, thread_index);
3724 nat_ha_sref_ed_cb (ip4_address_t * out_addr, u16 out_port,
3725 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3726 u32 fib_index, u32 total_pkts, u64 total_bytes,
3729 snat_main_t *sm = &snat_main;
3730 nat_ed_ses_key_t key;
3731 clib_bihash_kv_16_8_t kv, value;
3733 snat_main_per_thread_data_t *tsm;
3735 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3737 key.l_addr.as_u32 = out_addr->as_u32;
3738 key.l_port = out_port;
3739 key.r_addr.as_u32 = eh_addr->as_u32;
3740 key.r_port = eh_port;
3742 key.fib_index = fib_index;
3743 kv.key[0] = key.as_u64[0];
3744 kv.key[1] = key.as_u64[1];
3745 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3748 s = pool_elt_at_index (tsm->sessions, value.value);
3749 s->total_pkts = total_pkts;
3750 s->total_bytes = total_bytes;
3753 static clib_error_t *
3754 snat_config (vlib_main_t * vm, unformat_input_t * input)
3756 snat_main_t *sm = &snat_main;
3757 nat66_main_t *nm = &nat66_main;
3758 dslite_main_t *dm = &dslite_main;
3759 snat_main_per_thread_data_t *tsm;
3761 u32 static_mapping_buckets = 1024;
3762 u32 static_mapping_memory_size = 64 << 20;
3764 u32 nat64_bib_buckets = 1024;
3765 u32 nat64_bib_memory_size = 128 << 20;
3767 u32 nat64_st_buckets = 2048;
3768 u32 nat64_st_memory_size = 256 << 20;
3770 u32 user_buckets = 128;
3771 u32 user_memory_size = 64 << 20;
3772 u32 translation_buckets = 1024;
3773 u32 translation_memory_size = 128 << 20;
3775 u32 max_translations_per_user = ~0;
3777 u32 outside_vrf_id = 0;
3778 u32 outside_ip6_vrf_id = 0;
3779 u32 inside_vrf_id = 0;
3780 u8 static_mapping_only = 0;
3781 u8 static_mapping_connection_tracking = 0;
3783 u32 udp_timeout = SNAT_UDP_TIMEOUT;
3784 u32 icmp_timeout = SNAT_ICMP_TIMEOUT;
3786 u32 tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
3787 u32 tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
3789 sm->deterministic = 0;
3791 sm->endpoint_dependent = 0;
3793 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3796 (input, "translation hash buckets %d", &translation_buckets))
3798 else if (unformat (input, "udp timeout %d", &udp_timeout))
3800 else if (unformat (input, "icmp timeout %d", &icmp_timeout))
3802 else if (unformat (input, "tcp transitory timeout %d",
3803 &tcp_transitory_timeout));
3804 else if (unformat (input, "tcp established timeout %d",
3805 &tcp_established_timeout));
3806 else if (unformat (input, "translation hash memory %d",
3807 &translation_memory_size));
3808 else if (unformat (input, "user hash buckets %d", &user_buckets))
3810 else if (unformat (input, "user hash memory %d", &user_memory_size))
3812 else if (unformat (input, "max translations per user %d",
3813 &max_translations_per_user))
3815 else if (unformat (input, "outside VRF id %d", &outside_vrf_id))
3817 else if (unformat (input, "outside ip6 VRF id %d", &outside_ip6_vrf_id))
3819 else if (unformat (input, "inside VRF id %d", &inside_vrf_id))
3821 else if (unformat (input, "static mapping only"))
3823 static_mapping_only = 1;
3824 if (unformat (input, "connection tracking"))
3825 static_mapping_connection_tracking = 1;
3827 else if (unformat (input, "deterministic"))
3828 sm->deterministic = 1;
3829 else if (unformat (input, "nat64 bib hash buckets %d",
3830 &nat64_bib_buckets))
3832 else if (unformat (input, "nat64 bib hash memory %d",
3833 &nat64_bib_memory_size))
3836 if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
3838 else if (unformat (input, "nat64 st hash memory %d",
3839 &nat64_st_memory_size))
3841 else if (unformat (input, "out2in dpo"))
3843 else if (unformat (input, "dslite ce"))
3844 dslite_set_ce (dm, 1);
3845 else if (unformat (input, "endpoint-dependent"))
3846 sm->endpoint_dependent = 1;
3848 return clib_error_return (0, "unknown input '%U'",
3849 format_unformat_error, input);
3852 if (sm->deterministic && sm->endpoint_dependent)
3853 return clib_error_return (0,
3854 "deterministic and endpoint-dependent modes are mutually exclusive");
3856 if (static_mapping_only && (sm->deterministic || sm->endpoint_dependent))
3857 return clib_error_return (0,
3858 "static mapping only mode available only for simple nat");
3860 if (sm->out2in_dpo && (sm->deterministic || sm->endpoint_dependent))
3861 return clib_error_return (0,
3862 "out2in dpo mode available only for simple nat");
3864 /* optionally configurable timeouts for testing purposes */
3865 sm->udp_timeout = udp_timeout;
3866 sm->icmp_timeout = icmp_timeout;
3867 sm->tcp_transitory_timeout = tcp_transitory_timeout;
3868 sm->tcp_established_timeout = tcp_established_timeout;
3870 sm->user_buckets = user_buckets;
3871 sm->user_memory_size = user_memory_size;
3873 sm->translation_buckets = translation_buckets;
3874 sm->translation_memory_size = translation_memory_size;
3876 /* do not exceed load factor 10 */
3877 sm->max_translations = 10 * translation_buckets;
3878 sm->max_translations_per_user = max_translations_per_user == ~0 ?
3879 sm->max_translations : max_translations_per_user;
3881 sm->outside_vrf_id = outside_vrf_id;
3882 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
3885 nm->outside_vrf_id = outside_ip6_vrf_id;
3886 nm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6,
3889 sm->inside_vrf_id = inside_vrf_id;
3890 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
3893 sm->static_mapping_only = static_mapping_only;
3894 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
3896 nat64_set_hash (nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
3897 nat64_st_memory_size);
3899 if (sm->deterministic)
3901 sm->in2out_node_index = snat_det_in2out_node.index;
3902 sm->in2out_output_node_index = ~0;
3903 sm->out2in_node_index = snat_det_out2in_node.index;
3904 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
3905 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
3909 if (sm->endpoint_dependent)
3911 sm->worker_in2out_cb = nat44_ed_get_worker_in2out_cb;
3912 sm->worker_out2in_cb = nat44_ed_get_worker_out2in_cb;
3914 sm->handoff_out2in_index = nat_pre_out2in_node.index;
3915 sm->handoff_in2out_index = nat_pre_in2out_node.index;
3916 sm->handoff_in2out_output_index = nat44_ed_in2out_output_node.index;
3918 sm->in2out_node_index = nat44_ed_in2out_node.index;
3919 sm->in2out_output_node_index = nat44_ed_in2out_output_node.index;
3920 sm->out2in_node_index = nat44_ed_out2in_node.index;
3922 sm->icmp_match_in2out_cb = icmp_match_in2out_ed;
3923 sm->icmp_match_out2in_cb = icmp_match_out2in_ed;
3924 nat_affinity_init (vm);
3925 nat_ha_init (vm, nat_ha_sadd_ed_cb, nat_ha_sdel_ed_cb,
3930 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
3931 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
3933 sm->handoff_out2in_index = snat_in2out_node.index;
3934 sm->handoff_in2out_index = snat_out2in_node.index;
3935 sm->handoff_in2out_output_index = snat_in2out_output_node.index;
3937 sm->in2out_node_index = snat_in2out_node.index;
3938 sm->in2out_output_node_index = snat_in2out_output_node.index;
3939 sm->out2in_node_index = snat_out2in_node.index;
3940 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
3941 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
3942 nat_ha_init (vm, nat_ha_sadd_cb, nat_ha_sdel_cb, nat_ha_sref_cb);
3944 if (!static_mapping_only ||
3945 (static_mapping_only && static_mapping_connection_tracking))
3948 vec_foreach (tsm, sm->per_thread_data)
3950 if (sm->endpoint_dependent)
3952 clib_bihash_init_16_8 (&tsm->in2out_ed, "in2out-ed",
3953 translation_buckets,
3954 translation_memory_size);
3955 clib_bihash_set_kvp_format_fn_16_8 (&tsm->in2out_ed,
3956 format_ed_session_kvp);
3958 clib_bihash_init_16_8 (&tsm->out2in_ed, "out2in-ed",
3959 translation_buckets,
3960 translation_memory_size);
3961 clib_bihash_set_kvp_format_fn_16_8 (&tsm->out2in_ed,
3962 format_ed_session_kvp);
3966 clib_bihash_init_8_8 (&tsm->in2out, "in2out",
3967 translation_buckets,
3968 translation_memory_size);
3969 clib_bihash_set_kvp_format_fn_8_8 (&tsm->in2out,
3970 format_session_kvp);
3972 clib_bihash_init_8_8 (&tsm->out2in, "out2in",
3973 translation_buckets,
3974 translation_memory_size);
3975 clib_bihash_set_kvp_format_fn_8_8 (&tsm->out2in,
3976 format_session_kvp);
3979 clib_bihash_init_8_8 (&tsm->user_hash, "users", user_buckets,
3981 clib_bihash_set_kvp_format_fn_8_8 (&tsm->user_hash,
3989 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
3990 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
3992 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
3993 "static_mapping_by_local", static_mapping_buckets,
3994 static_mapping_memory_size);
3995 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_local,
3996 format_static_mapping_kvp);
3998 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
3999 "static_mapping_by_external",
4000 static_mapping_buckets,
4001 static_mapping_memory_size);
4002 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_external,
4003 format_static_mapping_kvp);
4009 VLIB_CONFIG_FUNCTION (snat_config, "nat");
4012 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
4015 ip4_address_t * address,
4017 u32 if_address_index, u32 is_delete)
4019 snat_main_t *sm = &snat_main;
4020 snat_static_map_resolve_t *rp;
4021 snat_static_mapping_t *m;
4022 snat_session_key_t m_key;
4023 clib_bihash_kv_8_8_t kv, value;
4025 ip4_address_t l_addr;
4027 for (i = 0; i < vec_len (sm->to_resolve); i++)
4029 rp = sm->to_resolve + i;
4030 if (rp->addr_only == 0)
4032 if (rp->sw_if_index == sw_if_index)
4039 m_key.addr.as_u32 = address->as_u32;
4040 m_key.port = rp->addr_only ? 0 : rp->e_port;
4041 m_key.protocol = rp->addr_only ? 0 : rp->proto;
4042 m_key.fib_index = sm->outside_fib_index;
4043 kv.key = m_key.as_u64;
4044 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
4047 m = pool_elt_at_index (sm->static_mappings, value.value);
4051 /* Don't trip over lease renewal, static config */
4061 /* Indetity mapping? */
4062 if (rp->l_addr.as_u32 == 0)
4063 l_addr.as_u32 = address[0].as_u32;
4065 l_addr.as_u32 = rp->l_addr.as_u32;
4066 /* Add the static mapping */
4067 rv = snat_add_static_mapping (l_addr,
4072 rp->addr_only, ~0 /* sw_if_index */ ,
4073 rp->proto, !is_delete, rp->twice_nat,
4074 rp->out2in_only, rp->tag, rp->identity_nat);
4076 nat_elog_notice_X1 ("snat_add_static_mapping returned %d", "i4", rv);
4080 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
4083 ip4_address_t * address,
4085 u32 if_address_index, u32 is_delete)
4087 snat_main_t *sm = &snat_main;
4088 snat_static_map_resolve_t *rp;
4089 ip4_address_t l_addr;
4093 snat_address_t *addresses = sm->addresses;
4095 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices); i++)
4097 if (sw_if_index == sm->auto_add_sw_if_indices[i])
4101 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices_twice_nat); i++)
4104 addresses = sm->twice_nat_addresses;
4105 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
4114 /* Don't trip over lease renewal, static config */
4115 for (j = 0; j < vec_len (addresses); j++)
4116 if (addresses[j].addr.as_u32 == address->as_u32)
4119 (void) snat_add_address (sm, address, ~0, twice_nat);
4120 /* Scan static map resolution vector */
4121 for (j = 0; j < vec_len (sm->to_resolve); j++)
4123 rp = sm->to_resolve + j;
4126 /* On this interface? */
4127 if (rp->sw_if_index == sw_if_index)
4129 /* Indetity mapping? */
4130 if (rp->l_addr.as_u32 == 0)
4131 l_addr.as_u32 = address[0].as_u32;
4133 l_addr.as_u32 = rp->l_addr.as_u32;
4134 /* Add the static mapping */
4135 rv = snat_add_static_mapping (l_addr,
4141 ~0 /* sw_if_index */ ,
4143 rp->is_add, rp->twice_nat,
4144 rp->out2in_only, rp->tag,
4147 nat_elog_notice_X1 ("snat_add_static_mapping returned %d",
4155 (void) snat_del_address (sm, address[0], 1, twice_nat);
4162 snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
4165 ip4_main_t *ip4_main = sm->ip4_main;
4166 ip4_address_t *first_int_addr;
4167 snat_static_map_resolve_t *rp;
4168 u32 *indices_to_delete = 0;
4170 u32 *auto_add_sw_if_indices =
4172 auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
4174 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0 /* just want the address */
4177 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
4179 if (auto_add_sw_if_indices[i] == sw_if_index)
4183 /* if have address remove it */
4185 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
4188 for (j = 0; j < vec_len (sm->to_resolve); j++)
4190 rp = sm->to_resolve + j;
4191 if (rp->sw_if_index == sw_if_index)
4192 vec_add1 (indices_to_delete, j);
4194 if (vec_len (indices_to_delete))
4196 for (j = vec_len (indices_to_delete) - 1; j >= 0; j--)
4197 vec_del1 (sm->to_resolve, j);
4198 vec_free (indices_to_delete);
4202 vec_del1 (sm->auto_add_sw_if_indices_twice_nat, i);
4204 vec_del1 (sm->auto_add_sw_if_indices, i);
4207 return VNET_API_ERROR_VALUE_EXIST;
4214 return VNET_API_ERROR_NO_SUCH_ENTRY;
4216 /* add to the auto-address list */
4218 vec_add1 (sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
4220 vec_add1 (sm->auto_add_sw_if_indices, sw_if_index);
4222 /* If the address is already bound - or static - add it now */
4224 (void) snat_add_address (sm, first_int_addr, ~0, twice_nat);
4230 nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4231 snat_protocol_t proto, u32 vrf_id, int is_in)
4233 snat_main_per_thread_data_t *tsm;
4234 clib_bihash_kv_8_8_t kv, value;
4236 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4237 snat_session_key_t key;
4239 clib_bihash_8_8_t *t;
4241 if (sm->endpoint_dependent)
4242 return VNET_API_ERROR_UNSUPPORTED;
4244 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4245 if (sm->num_workers > 1)
4247 vec_elt_at_index (sm->per_thread_data,
4248 sm->worker_in2out_cb (&ip, fib_index, 0));
4250 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4252 key.addr.as_u32 = addr->as_u32;
4253 key.port = clib_host_to_net_u16 (port);
4254 key.protocol = proto;
4255 key.fib_index = fib_index;
4256 kv.key = key.as_u64;
4257 t = is_in ? &tsm->in2out : &tsm->out2in;
4258 if (!clib_bihash_search_8_8 (t, &kv, &value))
4260 if (pool_is_free_index (tsm->sessions, value.value))
4261 return VNET_API_ERROR_UNSPECIFIED;
4263 s = pool_elt_at_index (tsm->sessions, value.value);
4264 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4265 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4269 return VNET_API_ERROR_NO_SUCH_ENTRY;
4273 nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4274 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
4275 u32 vrf_id, int is_in)
4278 clib_bihash_16_8_t *t;
4279 nat_ed_ses_key_t key;
4280 clib_bihash_kv_16_8_t kv, value;
4281 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4283 snat_main_per_thread_data_t *tsm;
4285 if (!sm->endpoint_dependent)
4286 return VNET_API_ERROR_FEATURE_DISABLED;
4288 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4289 if (sm->num_workers > 1)
4291 vec_elt_at_index (sm->per_thread_data,
4292 sm->worker_in2out_cb (&ip, fib_index, 0));
4294 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4296 t = is_in ? &tsm->in2out_ed : &tsm->out2in_ed;
4297 key.l_addr.as_u32 = addr->as_u32;
4298 key.r_addr.as_u32 = eh_addr->as_u32;
4299 key.l_port = clib_host_to_net_u16 (port);
4300 key.r_port = clib_host_to_net_u16 (eh_port);
4302 key.fib_index = fib_index;
4303 kv.key[0] = key.as_u64[0];
4304 kv.key[1] = key.as_u64[1];
4305 if (clib_bihash_search_16_8 (t, &kv, &value))
4306 return VNET_API_ERROR_NO_SUCH_ENTRY;
4308 if (pool_is_free_index (tsm->sessions, value.value))
4309 return VNET_API_ERROR_UNSPECIFIED;
4310 s = pool_elt_at_index (tsm->sessions, value.value);
4311 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4312 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4317 nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset, u16 psid_length)
4319 snat_main_t *sm = &snat_main;
4321 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_MAPE;
4322 sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
4324 sm->psid_offset = psid_offset;
4325 sm->psid_length = psid_length;
4329 nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port)
4331 snat_main_t *sm = &snat_main;
4333 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_RANGE;
4334 sm->alloc_addr_and_port = nat_alloc_addr_and_port_range;
4335 sm->start_port = start_port;
4336 sm->end_port = end_port;
4340 nat_set_alloc_addr_and_port_default (void)
4342 snat_main_t *sm = &snat_main;
4344 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
4345 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
4348 VLIB_NODE_FN (nat_default_node) (vlib_main_t * vm,
4349 vlib_node_runtime_t * node,
4350 vlib_frame_t * frame)
4356 VLIB_REGISTER_NODE (nat_default_node) = {
4357 .name = "nat-default",
4358 .vector_size = sizeof (u32),
4360 .type = VLIB_NODE_TYPE_INTERNAL,
4362 .n_next_nodes = NAT_N_NEXT,
4364 [NAT_NEXT_DROP] = "error-drop",
4365 [NAT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
4366 [NAT_NEXT_IN2OUT_PRE] = "nat-pre-in2out",
4367 [NAT_NEXT_OUT2IN_PRE] = "nat-pre-out2in",
4368 [NAT_NEXT_IN2OUT_ED_FAST_PATH] = "nat44-ed-in2out",
4369 [NAT_NEXT_IN2OUT_ED_SLOW_PATH] = "nat44-ed-in2out-slowpath",
4370 [NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH] = "nat44-ed-in2out-output-slowpath",
4371 [NAT_NEXT_OUT2IN_ED_FAST_PATH] = "nat44-ed-out2in",
4372 [NAT_NEXT_OUT2IN_ED_SLOW_PATH] = "nat44-ed-out2in-slowpath",
4378 * fd.io coding-style-patch-verification: ON
4381 * eval: (c-set-style "gnu")