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/nat_inlines.h>
29 #include <nat/nat44/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>
36 #include <vppinfra/bihash_16_8.h>
38 #include <vpp/app/version.h>
40 snat_main_t snat_main;
42 fib_source_t nat_fib_src_hi;
43 fib_source_t nat_fib_src_low;
46 /* Hook up input features */
47 VNET_FEATURE_INIT (nat_pre_in2out, static) = {
48 .arc_name = "ip4-unicast",
49 .node_name = "nat-pre-in2out",
50 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
51 "ip4-sv-reassembly-feature"),
53 VNET_FEATURE_INIT (nat_pre_out2in, static) = {
54 .arc_name = "ip4-unicast",
55 .node_name = "nat-pre-out2in",
56 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
57 "ip4-dhcp-client-detect",
58 "ip4-sv-reassembly-feature"),
60 VNET_FEATURE_INIT (snat_in2out_worker_handoff, static) = {
61 .arc_name = "ip4-unicast",
62 .node_name = "nat44-in2out-worker-handoff",
63 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
65 VNET_FEATURE_INIT (snat_out2in_worker_handoff, static) = {
66 .arc_name = "ip4-unicast",
67 .node_name = "nat44-out2in-worker-handoff",
68 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
69 "ip4-dhcp-client-detect"),
71 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
72 .arc_name = "ip4-unicast",
73 .node_name = "nat44-in2out",
74 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
76 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
77 .arc_name = "ip4-unicast",
78 .node_name = "nat44-out2in",
79 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
80 "ip4-dhcp-client-detect"),
82 VNET_FEATURE_INIT (ip4_nat_classify, static) = {
83 .arc_name = "ip4-unicast",
84 .node_name = "nat44-classify",
85 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
87 VNET_FEATURE_INIT (ip4_snat_det_in2out, static) = {
88 .arc_name = "ip4-unicast",
89 .node_name = "nat44-det-in2out",
90 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
92 VNET_FEATURE_INIT (ip4_snat_det_out2in, static) = {
93 .arc_name = "ip4-unicast",
94 .node_name = "nat44-det-out2in",
95 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
96 "ip4-dhcp-client-detect"),
98 VNET_FEATURE_INIT (ip4_nat_det_classify, static) = {
99 .arc_name = "ip4-unicast",
100 .node_name = "nat44-det-classify",
101 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
103 VNET_FEATURE_INIT (ip4_nat44_ed_in2out, static) = {
104 .arc_name = "ip4-unicast",
105 .node_name = "nat44-ed-in2out",
106 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
108 VNET_FEATURE_INIT (ip4_nat44_ed_out2in, static) = {
109 .arc_name = "ip4-unicast",
110 .node_name = "nat44-ed-out2in",
111 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
112 "ip4-dhcp-client-detect"),
114 VNET_FEATURE_INIT (ip4_nat44_ed_classify, static) = {
115 .arc_name = "ip4-unicast",
116 .node_name = "nat44-ed-classify",
117 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
119 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
120 .arc_name = "ip4-unicast",
121 .node_name = "nat44-handoff-classify",
122 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
124 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
125 .arc_name = "ip4-unicast",
126 .node_name = "nat44-in2out-fast",
127 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
129 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
130 .arc_name = "ip4-unicast",
131 .node_name = "nat44-out2in-fast",
132 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
133 "ip4-dhcp-client-detect"),
135 VNET_FEATURE_INIT (ip4_snat_hairpin_dst, static) = {
136 .arc_name = "ip4-unicast",
137 .node_name = "nat44-hairpin-dst",
138 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
140 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_dst, static) = {
141 .arc_name = "ip4-unicast",
142 .node_name = "nat44-ed-hairpin-dst",
143 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
146 /* Hook up output features */
147 VNET_FEATURE_INIT (ip4_snat_in2out_output, static) = {
148 .arc_name = "ip4-output",
149 .node_name = "nat44-in2out-output",
150 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
152 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
153 .arc_name = "ip4-output",
154 .node_name = "nat44-in2out-output-worker-handoff",
155 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
157 VNET_FEATURE_INIT (ip4_snat_hairpin_src, static) = {
158 .arc_name = "ip4-output",
159 .node_name = "nat44-hairpin-src",
160 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
162 VNET_FEATURE_INIT (ip4_nat44_ed_in2out_output, static) = {
163 .arc_name = "ip4-output",
164 .node_name = "nat44-ed-in2out-output",
165 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
166 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
168 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_src, static) = {
169 .arc_name = "ip4-output",
170 .node_name = "nat44-ed-hairpin-src",
171 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
172 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
175 /* Hook up ip4-local features */
176 VNET_FEATURE_INIT (ip4_nat_hairpinning, static) =
178 .arc_name = "ip4-local",
179 .node_name = "nat44-hairpinning",
180 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
182 VNET_FEATURE_INIT (ip4_nat44_ed_hairpinning, static) =
184 .arc_name = "ip4-local",
185 .node_name = "nat44-ed-hairpinning",
186 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
190 VLIB_PLUGIN_REGISTER () = {
191 .version = VPP_BUILD_VER,
192 .description = "Network Address Translation (NAT)",
197 nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index,
200 snat_session_key_t key;
201 clib_bihash_kv_8_8_t kv;
204 ip4_address_t *l_addr, *r_addr;
206 clib_bihash_kv_16_8_t ed_kv;
207 snat_main_per_thread_data_t *tsm =
208 vec_elt_at_index (sm->per_thread_data, thread_index);
210 if (is_fwd_bypass_session (s))
212 if (snat_is_unk_proto_session (s))
214 make_ed_kv (&s->in2out.addr, &s->ext_host_addr, s->in2out.port, 0,
215 0, 0, ~0ULL, &ed_kv);
219 l_port = s->in2out.port;
220 r_port = s->ext_host_port;
221 l_addr = &s->in2out.addr;
222 r_addr = &s->ext_host_addr;
223 proto = snat_proto_to_ip_proto (s->in2out.protocol);
224 make_ed_kv (l_addr, r_addr, proto, fib_index, l_port, r_port, ~0ULL,
227 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
228 nat_elog_warn ("in2out_ed key del failed");
232 /* session lookup tables */
233 if (is_ed_session (s))
235 if (is_affinity_sessions (s))
236 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
237 s->in2out.protocol, s->out2in.port);
238 l_addr = &s->out2in.addr;
239 r_addr = &s->ext_host_addr;
240 fib_index = s->out2in.fib_index;
241 if (snat_is_unk_proto_session (s))
243 proto = s->in2out.port;
249 proto = snat_proto_to_ip_proto (s->in2out.protocol);
250 l_port = s->out2in.port;
251 r_port = s->ext_host_port;
253 make_ed_kv (l_addr, r_addr, proto, fib_index, l_port, r_port, ~0ULL,
255 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &ed_kv, 0))
256 nat_elog_warn ("out2in_ed key del failed");
257 l_addr = &s->in2out.addr;
258 fib_index = s->in2out.fib_index;
259 if (!snat_is_unk_proto_session (s))
260 l_port = s->in2out.port;
261 if (is_twice_nat_session (s))
263 r_addr = &s->ext_host_nat_addr;
264 r_port = s->ext_host_nat_port;
266 make_ed_kv (l_addr, r_addr, proto, fib_index, l_port, r_port, ~0ULL,
268 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
269 nat_elog_warn ("in2out_ed key del failed");
272 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
273 &s->in2out.addr, s->in2out.port,
274 &s->ext_host_nat_addr, s->ext_host_nat_port,
275 &s->out2in.addr, s->out2in.port,
276 &s->ext_host_addr, s->ext_host_port,
277 s->in2out.protocol, is_twice_nat_session (s));
281 kv.key = s->in2out.as_u64;
282 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0))
283 nat_elog_warn ("in2out key del failed");
284 kv.key = s->out2in.as_u64;
285 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0))
286 nat_elog_warn ("out2in key del failed");
289 nat_syslog_nat44_apmdel (s->user_index, s->in2out.fib_index,
290 &s->in2out.addr, s->in2out.port,
291 &s->out2in.addr, s->out2in.port,
295 if (snat_is_unk_proto_session (s))
301 snat_ipfix_logging_nat44_ses_delete (thread_index,
302 s->in2out.addr.as_u32,
303 s->out2in.addr.as_u32,
307 s->in2out.fib_index);
309 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
310 s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
314 /* Twice NAT address and port for external host */
315 if (is_twice_nat_session (s))
317 key.protocol = s->in2out.protocol;
318 key.port = s->ext_host_nat_port;
319 key.addr.as_u32 = s->ext_host_nat_addr.as_u32;
320 snat_free_outside_address_and_port (sm->twice_nat_addresses,
324 if (snat_is_session_static (s))
327 snat_free_outside_address_and_port (sm->addresses, thread_index,
332 nat44_set_session_limit (u32 session_limit, u32 vrf_id)
334 snat_main_t *sm = &snat_main;
335 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
336 u32 len = vec_len (sm->max_translations_per_fib);
338 if (len <= fib_index)
340 vec_validate (sm->max_translations_per_fib, fib_index + 1);
342 for (; len < vec_len (sm->max_translations_per_fib); len++)
343 sm->max_translations_per_fib[len] = sm->max_translations;
346 sm->max_translations_per_fib[fib_index] = session_limit;
351 nat44_free_session_data (snat_main_t * sm, snat_session_t * s,
352 u32 thread_index, u8 is_ha)
354 snat_session_key_t key;
357 ip4_address_t *l_addr, *r_addr;
359 clib_bihash_kv_16_8_t ed_kv;
360 snat_main_per_thread_data_t *tsm =
361 vec_elt_at_index (sm->per_thread_data, thread_index);
363 if (is_fwd_bypass_session (s))
365 if (snat_is_unk_proto_session (s))
367 proto = s->in2out.port;
373 proto = snat_proto_to_ip_proto (s->in2out.protocol);
374 l_port = s->in2out.port;
375 r_port = s->ext_host_port;
378 l_addr = &s->in2out.addr;
379 r_addr = &s->ext_host_addr;
381 make_ed_kv (l_addr, r_addr, proto, fib_index, l_port, r_port, ~0ULL,
385 (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0)))
386 nat_elog_warn ("in2out_ed key del failed");
390 /* session lookup tables */
391 if (is_affinity_sessions (s))
392 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
393 s->in2out.protocol, s->out2in.port);
394 l_addr = &s->out2in.addr;
395 r_addr = &s->ext_host_addr;
396 fib_index = s->out2in.fib_index;
397 if (snat_is_unk_proto_session (s))
399 proto = s->in2out.port;
405 proto = snat_proto_to_ip_proto (s->in2out.protocol);
406 l_port = s->out2in.port;
407 r_port = s->ext_host_port;
409 make_ed_kv (l_addr, r_addr, proto, fib_index, l_port, r_port, ~0ULL,
412 if (PREDICT_FALSE (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &ed_kv, 0)))
413 nat_elog_warn ("out2in_ed key del failed");
415 l_addr = &s->in2out.addr;
416 fib_index = s->in2out.fib_index;
418 if (!snat_is_unk_proto_session (s))
419 l_port = s->in2out.port;
421 if (is_twice_nat_session (s))
423 r_addr = &s->ext_host_nat_addr;
424 r_port = s->ext_host_nat_port;
426 make_ed_kv (l_addr, r_addr, proto, fib_index, l_port, r_port, ~0ULL,
429 if (PREDICT_FALSE (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0)))
430 nat_elog_warn ("in2out_ed key del failed");
434 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
435 &s->in2out.addr, s->in2out.port,
436 &s->ext_host_nat_addr, s->ext_host_nat_port,
437 &s->out2in.addr, s->out2in.port,
438 &s->ext_host_addr, s->ext_host_port,
439 s->in2out.protocol, is_twice_nat_session (s));
442 if (snat_is_unk_proto_session (s))
448 snat_ipfix_logging_nat44_ses_delete (thread_index,
449 s->in2out.addr.as_u32,
450 s->out2in.addr.as_u32,
454 s->in2out.fib_index);
455 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
456 s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
460 /* Twice NAT address and port for external host */
461 if (is_twice_nat_session (s))
463 key.protocol = s->in2out.protocol;
464 key.port = s->ext_host_nat_port;
465 key.addr.as_u32 = s->ext_host_nat_addr.as_u32;
466 snat_free_outside_address_and_port (sm->twice_nat_addresses,
470 if (snat_is_session_static (s))
473 // should be called for every dynamic session
474 snat_free_outside_address_and_port (sm->addresses, thread_index,
480 nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr, u32 fib_index,
484 snat_user_key_t user_key;
485 clib_bihash_kv_8_8_t kv, value;
486 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
487 dlist_elt_t *per_user_list_head_elt;
489 user_key.addr.as_u32 = addr->as_u32;
490 user_key.fib_index = fib_index;
491 kv.key = user_key.as_u64;
493 /* Ever heard of the "user" = src ip4 address before? */
494 if (clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
496 /* no, make a new one */
497 pool_get (tsm->users, u);
498 clib_memset (u, 0, sizeof (*u));
500 u->addr.as_u32 = addr->as_u32;
501 u->fib_index = fib_index;
503 pool_get (tsm->list_pool, per_user_list_head_elt);
505 u->sessions_per_user_list_head_index = per_user_list_head_elt -
508 clib_dlist_init (tsm->list_pool, u->sessions_per_user_list_head_index);
510 kv.value = u - tsm->users;
513 if (clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 1))
515 nat_elog_warn ("user_hash key add failed");
516 nat44_delete_user_with_no_session (sm, u, thread_index);
520 vlib_set_simple_counter (&sm->total_users, thread_index, 0,
521 pool_elts (tsm->users));
525 u = pool_elt_at_index (tsm->users, value.value);
532 nat_session_alloc_or_recycle (snat_main_t * sm, snat_user_t * u,
533 u32 thread_index, f64 now)
536 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
537 u32 oldest_per_user_translation_list_index, session_index;
538 dlist_elt_t *oldest_per_user_translation_list_elt;
539 dlist_elt_t *per_user_translation_list_elt;
541 /* Over quota? Recycle the least recently used translation */
542 if ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user)
544 oldest_per_user_translation_list_index =
545 clib_dlist_remove_head (tsm->list_pool,
546 u->sessions_per_user_list_head_index);
548 ASSERT (oldest_per_user_translation_list_index != ~0);
550 /* Add it back to the end of the LRU list */
551 clib_dlist_addtail (tsm->list_pool,
552 u->sessions_per_user_list_head_index,
553 oldest_per_user_translation_list_index);
554 /* Get the list element */
555 oldest_per_user_translation_list_elt =
556 pool_elt_at_index (tsm->list_pool,
557 oldest_per_user_translation_list_index);
559 /* Get the session index from the list element */
560 session_index = oldest_per_user_translation_list_elt->value;
562 /* Get the session */
563 s = pool_elt_at_index (tsm->sessions, session_index);
564 nat_free_session_data (sm, s, thread_index, 0);
565 if (snat_is_session_static (s))
566 u->nstaticsessions--;
573 s->ext_host_addr.as_u32 = 0;
574 s->ext_host_port = 0;
575 s->ext_host_nat_addr.as_u32 = 0;
576 s->ext_host_nat_port = 0;
580 pool_get (tsm->sessions, s);
581 clib_memset (s, 0, sizeof (*s));
583 /* Create list elts */
584 pool_get (tsm->list_pool, per_user_translation_list_elt);
585 clib_dlist_init (tsm->list_pool,
586 per_user_translation_list_elt - tsm->list_pool);
588 per_user_translation_list_elt->value = s - tsm->sessions;
589 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
590 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
592 clib_dlist_addtail (tsm->list_pool,
593 s->per_user_list_head_index,
594 per_user_translation_list_elt - tsm->list_pool);
596 dlist_elt_t *global_lru_list_elt;
597 pool_get (tsm->global_lru_pool, global_lru_list_elt);
598 global_lru_list_elt->value = s - tsm->sessions;
599 s->global_lru_index = global_lru_list_elt - tsm->global_lru_pool;
600 clib_dlist_addtail (tsm->global_lru_pool, tsm->global_lru_head_index,
601 s->global_lru_index);
602 s->last_lru_update = now;
604 s->user_index = u - tsm->users;
605 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
606 pool_elts (tsm->sessions));
609 s->ha_last_refreshed = now;
615 nat_global_lru_free_one (snat_main_t * sm, int thread_index, f64 now)
617 snat_session_t *s = NULL;
618 dlist_elt_t *oldest_elt;
619 u64 sess_timeout_time;
621 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
622 oldest_index = clib_dlist_remove_head (tsm->global_lru_pool,
623 tsm->global_lru_head_index);
624 if (~0 != oldest_index)
626 oldest_elt = pool_elt_at_index (tsm->global_lru_pool, oldest_index);
627 s = pool_elt_at_index (tsm->sessions, oldest_elt->value);
630 s->last_heard + (f64) nat44_session_get_timeout (sm, s);
631 if (now >= sess_timeout_time
632 || (s->tcp_close_timestamp && now >= s->tcp_close_timestamp))
634 nat_free_session_data (sm, s, thread_index, 0);
635 nat44_ed_delete_session (sm, s, thread_index, 0);
640 clib_dlist_addhead (tsm->global_lru_pool,
641 tsm->global_lru_head_index, oldest_index);
648 nat_ed_session_alloc (snat_main_t * sm, u32 thread_index, f64 now)
651 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
653 nat_global_lru_free_one (sm, thread_index, now);
655 pool_get (tsm->sessions, s);
656 clib_memset (s, 0, sizeof (*s));
658 nat44_global_lru_insert (tsm, s, now);
660 s->ha_last_refreshed = now;
661 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
662 pool_elts (tsm->sessions));
667 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
670 fib_prefix_t prefix = {
672 .fp_proto = FIB_PROTOCOL_IP4,
674 .ip4.as_u32 = addr->as_u32,
677 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
680 fib_table_entry_update_one_path (fib_index,
683 (FIB_ENTRY_FLAG_CONNECTED |
684 FIB_ENTRY_FLAG_LOCAL |
685 FIB_ENTRY_FLAG_EXCLUSIVE),
689 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
691 fib_table_entry_delete (fib_index, &prefix, nat_fib_src_low);
695 snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
700 vlib_thread_main_t *tm = vlib_get_thread_main ();
702 if (twice_nat && !sm->endpoint_dependent)
703 return VNET_API_ERROR_FEATURE_DISABLED;
705 /* Check if address already exists */
707 vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
709 if (ap->addr.as_u32 == addr->as_u32)
710 return VNET_API_ERROR_VALUE_EXIST;
715 vec_add2 (sm->twice_nat_addresses, ap, 1);
717 vec_add2 (sm->addresses, ap, 1);
722 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
726 #define _(N, i, n, s) \
727 clib_memset(ap->busy_##n##_port_refcounts, 0, sizeof(ap->busy_##n##_port_refcounts));\
728 ap->busy_##n##_ports = 0; \
729 ap->busy_##n##_ports_per_thread = 0;\
730 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
731 foreach_snat_protocol
736 /* Add external address to FIB */
738 pool_foreach (i, sm->interfaces,
740 if (nat_interface_is_inside(i) || sm->out2in_dpo)
743 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
746 pool_foreach (i, sm->output_feature_interfaces,
748 if (nat_interface_is_inside(i) || sm->out2in_dpo)
751 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
760 is_snat_address_used_in_static_mapping (snat_main_t * sm, ip4_address_t addr)
762 snat_static_mapping_t *m;
764 pool_foreach (m, sm->static_mappings,
766 if (is_addr_only_static_mapping (m) ||
767 is_out2in_only_static_mapping (m) ||
768 is_identity_static_mapping (m))
770 if (m->external_addr.as_u32 == addr.as_u32)
779 snat_add_static_mapping_when_resolved (snat_main_t * sm,
780 ip4_address_t l_addr,
785 snat_protocol_t proto,
786 int addr_only, int is_add, u8 * tag,
787 int twice_nat, int out2in_only,
790 snat_static_map_resolve_t *rp;
792 vec_add2 (sm->to_resolve, rp, 1);
793 rp->l_addr.as_u32 = l_addr.as_u32;
795 rp->sw_if_index = sw_if_index;
799 rp->addr_only = addr_only;
801 rp->twice_nat = twice_nat;
802 rp->out2in_only = out2in_only;
803 rp->identity_nat = identity_nat;
804 rp->tag = vec_dup (tag);
808 get_thread_idx_by_port (u16 e_port)
810 snat_main_t *sm = &snat_main;
811 u32 thread_idx = sm->num_workers;
812 if (sm->num_workers > 1)
815 sm->first_worker_index +
816 sm->workers[(e_port - 1024) / sm->port_per_thread];
822 snat_static_mapping_del_sessions (snat_main_t * sm,
823 snat_main_per_thread_data_t * tsm,
824 snat_user_key_t u_key, int addr_only,
825 ip4_address_t e_addr, u16 e_port)
827 clib_bihash_kv_8_8_t kv, value;
828 kv.key = u_key.as_u64;
830 dlist_elt_t *head, *elt;
833 u32 elt_index, head_index, ses_index;
834 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
836 user_index = value.value;
837 u = pool_elt_at_index (tsm->users, user_index);
838 if (u->nstaticsessions)
840 head_index = u->sessions_per_user_list_head_index;
841 head = pool_elt_at_index (tsm->list_pool, head_index);
842 elt_index = head->next;
843 elt = pool_elt_at_index (tsm->list_pool, elt_index);
844 ses_index = elt->value;
845 while (ses_index != ~0)
847 s = pool_elt_at_index (tsm->sessions, ses_index);
848 elt = pool_elt_at_index (tsm->list_pool, elt->next);
849 ses_index = elt->value;
853 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
854 (clib_net_to_host_u16 (s->out2in.port) != e_port))
858 if (is_lb_session (s))
861 if (!snat_is_session_static (s))
864 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
865 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
875 snat_ed_static_mapping_del_sessions (snat_main_t * sm,
876 snat_main_per_thread_data_t * tsm,
877 ip4_address_t l_addr,
880 u32 fib_index, int addr_only,
881 ip4_address_t e_addr, u16 e_port)
884 u32 *indexes_to_free = NULL;
886 pool_foreach (s, tsm->sessions, {
887 if (s->in2out.fib_index != fib_index ||
888 s->in2out.addr.as_u32 != l_addr.as_u32)
894 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
895 (clib_net_to_host_u16 (s->out2in.port) != e_port) ||
896 clib_net_to_host_u16 (s->in2out.port) != l_port ||
897 s->in2out.protocol != protocol)
901 if (is_lb_session (s))
903 if (!snat_is_session_static (s))
905 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
906 vec_add1 (indexes_to_free, s - tsm->sessions);
912 vec_foreach (ses_index, indexes_to_free)
914 s = pool_elt_at_index (tsm->sessions, *ses_index);
915 nat44_ed_delete_session (sm, s, tsm - sm->per_thread_data, 1);
917 vec_free (indexes_to_free);
921 snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
922 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
923 u32 sw_if_index, snat_protocol_t proto, int is_add,
924 twice_nat_type_t twice_nat, u8 out2in_only, u8 * tag,
927 snat_main_t *sm = &snat_main;
928 snat_static_mapping_t *m;
929 snat_session_key_t m_key;
930 clib_bihash_kv_8_8_t kv, value;
931 snat_address_t *a = 0;
933 snat_interface_t *interface;
935 snat_main_per_thread_data_t *tsm;
936 snat_user_key_t u_key;
938 dlist_elt_t *head, *elt;
939 u32 elt_index, head_index;
943 snat_static_map_resolve_t *rp, *rp_match = 0;
944 nat44_lb_addr_port_t *local;
947 if (!sm->endpoint_dependent)
949 if (twice_nat || out2in_only)
950 return VNET_API_ERROR_FEATURE_DISABLED;
953 /* If the external address is a specific interface address */
954 if (sw_if_index != ~0)
956 ip4_address_t *first_int_addr;
958 for (i = 0; i < vec_len (sm->to_resolve); i++)
960 rp = sm->to_resolve + i;
961 if (rp->sw_if_index != sw_if_index ||
962 rp->l_addr.as_u32 != l_addr.as_u32 ||
963 rp->vrf_id != vrf_id || rp->addr_only != addr_only)
968 if ((rp->l_port != l_port && rp->e_port != e_port)
969 || rp->proto != proto)
977 /* Might be already set... */
978 first_int_addr = ip4_interface_first_address
979 (sm->ip4_main, sw_if_index, 0 /* just want the address */ );
984 return VNET_API_ERROR_VALUE_EXIST;
986 snat_add_static_mapping_when_resolved
987 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
988 addr_only, is_add, tag, twice_nat, out2in_only, identity_nat);
990 /* DHCP resolution required? */
991 if (first_int_addr == 0)
997 e_addr.as_u32 = first_int_addr->as_u32;
998 /* Identity mapping? */
999 if (l_addr.as_u32 == 0)
1000 l_addr.as_u32 = e_addr.as_u32;
1006 return VNET_API_ERROR_NO_SUCH_ENTRY;
1008 vec_del1 (sm->to_resolve, i);
1012 e_addr.as_u32 = first_int_addr->as_u32;
1013 /* Identity mapping? */
1014 if (l_addr.as_u32 == 0)
1015 l_addr.as_u32 = e_addr.as_u32;
1022 m_key.addr = e_addr;
1023 m_key.port = addr_only ? 0 : e_port;
1024 m_key.protocol = addr_only ? 0 : proto;
1025 m_key.fib_index = 0;
1026 kv.key = m_key.as_u64;
1027 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1030 m = pool_elt_at_index (sm->static_mappings, value.value);
1036 if (is_identity_static_mapping (m))
1039 pool_foreach (local, m->locals,
1041 if (local->vrf_id == vrf_id)
1042 return VNET_API_ERROR_VALUE_EXIST;
1045 pool_get (m->locals, local);
1046 local->vrf_id = vrf_id;
1048 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1050 m_key.addr = m->local_addr;
1051 m_key.port = m->local_port;
1052 m_key.protocol = m->proto;
1053 m_key.fib_index = local->fib_index;
1054 kv.key = m_key.as_u64;
1055 kv.value = m - sm->static_mappings;
1056 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1060 return VNET_API_ERROR_VALUE_EXIST;
1063 if (twice_nat && addr_only)
1064 return VNET_API_ERROR_UNSUPPORTED;
1066 /* Convert VRF id to FIB index */
1069 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1071 /* If not specified use inside VRF id from SNAT plugin startup config */
1074 fib_index = sm->inside_fib_index;
1075 vrf_id = sm->inside_vrf_id;
1076 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1079 if (!(out2in_only || identity_nat))
1081 m_key.addr = l_addr;
1082 m_key.port = addr_only ? 0 : l_port;
1083 m_key.protocol = addr_only ? 0 : proto;
1084 m_key.fib_index = fib_index;
1085 kv.key = m_key.as_u64;
1086 if (!clib_bihash_search_8_8
1087 (&sm->static_mapping_by_local, &kv, &value))
1088 return VNET_API_ERROR_VALUE_EXIST;
1091 /* Find external address in allocated addresses and reserve port for
1092 address and port pair mapping when dynamic translations enabled */
1093 if (!(addr_only || sm->static_mapping_only || out2in_only))
1095 for (i = 0; i < vec_len (sm->addresses); i++)
1097 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1099 a = sm->addresses + i;
1100 /* External port must be unused */
1103 #define _(N, j, n, s) \
1104 case SNAT_PROTOCOL_##N: \
1105 if (a->busy_##n##_port_refcounts[e_port]) \
1106 return VNET_API_ERROR_INVALID_VALUE; \
1107 ++a->busy_##n##_port_refcounts[e_port]; \
1108 if (e_port > 1024) \
1110 a->busy_##n##_ports++; \
1111 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1114 foreach_snat_protocol
1117 nat_elog_info ("unknown protocol");
1118 return VNET_API_ERROR_INVALID_VALUE_2;
1123 /* External address must be allocated */
1124 if (!a && (l_addr.as_u32 != e_addr.as_u32))
1126 if (sw_if_index != ~0)
1128 for (i = 0; i < vec_len (sm->to_resolve); i++)
1130 rp = sm->to_resolve + i;
1133 if (rp->sw_if_index != sw_if_index &&
1134 rp->l_addr.as_u32 != l_addr.as_u32 &&
1135 rp->vrf_id != vrf_id && rp->l_port != l_port &&
1136 rp->e_port != e_port && rp->proto != proto)
1139 vec_del1 (sm->to_resolve, i);
1143 return VNET_API_ERROR_NO_SUCH_ENTRY;
1147 pool_get (sm->static_mappings, m);
1148 clib_memset (m, 0, sizeof (*m));
1149 m->tag = vec_dup (tag);
1150 m->local_addr = l_addr;
1151 m->external_addr = e_addr;
1152 m->twice_nat = twice_nat;
1154 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1156 m->flags |= NAT_STATIC_MAPPING_FLAG_ADDR_ONLY;
1159 m->flags |= NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT;
1160 pool_get (m->locals, local);
1161 local->vrf_id = vrf_id;
1162 local->fib_index = fib_index;
1167 m->fib_index = fib_index;
1171 m->local_port = l_port;
1172 m->external_port = e_port;
1176 if (sm->num_workers > 1)
1179 .src_address = m->local_addr,
1181 vec_add1 (m->workers, sm->worker_in2out_cb (&ip, m->fib_index, 0));
1182 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1185 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1187 m_key.addr = m->local_addr;
1188 m_key.port = m->local_port;
1189 m_key.protocol = m->proto;
1190 m_key.fib_index = fib_index;
1191 kv.key = m_key.as_u64;
1192 kv.value = m - sm->static_mappings;
1194 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1196 m_key.addr = m->external_addr;
1197 m_key.port = m->external_port;
1198 m_key.fib_index = 0;
1199 kv.key = m_key.as_u64;
1200 kv.value = m - sm->static_mappings;
1201 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1);
1203 /* Delete dynamic sessions matching local address (+ local port) */
1204 if (!(sm->static_mapping_only))
1206 u_key.addr = m->local_addr;
1207 u_key.fib_index = m->fib_index;
1208 kv.key = u_key.as_u64;
1209 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1211 user_index = value.value;
1212 u = pool_elt_at_index (tsm->users, user_index);
1215 head_index = u->sessions_per_user_list_head_index;
1216 head = pool_elt_at_index (tsm->list_pool, head_index);
1217 elt_index = head->next;
1218 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1219 ses_index = elt->value;
1220 while (ses_index != ~0)
1222 s = pool_elt_at_index (tsm->sessions, ses_index);
1223 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1224 ses_index = elt->value;
1226 if (snat_is_session_static (s))
1230 && (clib_net_to_host_u16 (s->in2out.port) !=
1234 nat_free_session_data (sm, s,
1235 tsm - sm->per_thread_data, 0);
1236 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1238 if (!addr_only && !sm->endpoint_dependent)
1249 if (sw_if_index != ~0)
1252 return VNET_API_ERROR_NO_SUCH_ENTRY;
1258 vrf_id = sm->inside_vrf_id;
1261 pool_foreach (local, m->locals,
1263 if (local->vrf_id == vrf_id)
1264 find = local - m->locals;
1268 return VNET_API_ERROR_NO_SUCH_ENTRY;
1270 local = pool_elt_at_index (m->locals, find);
1271 fib_index = local->fib_index;
1272 pool_put (m->locals, local);
1275 fib_index = m->fib_index;
1277 /* Free external address port */
1278 if (!(addr_only || sm->static_mapping_only || out2in_only))
1280 for (i = 0; i < vec_len (sm->addresses); i++)
1282 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1284 a = sm->addresses + i;
1287 #define _(N, j, n, s) \
1288 case SNAT_PROTOCOL_##N: \
1289 --a->busy_##n##_port_refcounts[e_port]; \
1290 if (e_port > 1024) \
1292 a->busy_##n##_ports--; \
1293 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1296 foreach_snat_protocol
1299 nat_elog_info ("unknown protocol");
1300 return VNET_API_ERROR_INVALID_VALUE_2;
1307 if (sm->num_workers > 1)
1308 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1310 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1312 m_key.addr = m->local_addr;
1313 m_key.port = m->local_port;
1314 m_key.protocol = m->proto;
1315 m_key.fib_index = fib_index;
1316 kv.key = m_key.as_u64;
1318 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0);
1320 /* Delete session(s) for static mapping if exist */
1321 if (!(sm->static_mapping_only) ||
1322 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
1324 if (sm->endpoint_dependent)
1326 snat_ed_static_mapping_del_sessions (sm, tsm, m->local_addr,
1327 m->local_port, m->proto,
1328 fib_index, addr_only,
1333 u_key.addr = m->local_addr;
1334 u_key.fib_index = fib_index;
1335 kv.key = u_key.as_u64;
1336 snat_static_mapping_del_sessions (sm, tsm, u_key, addr_only,
1341 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1342 if (pool_elts (m->locals))
1345 m_key.addr = m->external_addr;
1346 m_key.port = m->external_port;
1347 m_key.fib_index = 0;
1348 kv.key = m_key.as_u64;
1349 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0);
1352 vec_free (m->workers);
1353 /* Delete static mapping from pool */
1354 pool_put (sm->static_mappings, m);
1357 if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
1360 /* Add/delete external address to FIB */
1362 pool_foreach (interface, sm->interfaces,
1364 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1367 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1370 pool_foreach (interface, sm->output_feature_interfaces,
1372 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1375 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1384 nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1385 snat_protocol_t proto,
1386 nat44_lb_addr_port_t * locals, u8 is_add,
1387 twice_nat_type_t twice_nat, u8 out2in_only,
1388 u8 * tag, u32 affinity)
1390 snat_main_t *sm = &snat_main;
1391 snat_static_mapping_t *m;
1392 snat_session_key_t m_key;
1393 clib_bihash_kv_8_8_t kv, value;
1394 snat_address_t *a = 0;
1396 nat44_lb_addr_port_t *local;
1397 snat_main_per_thread_data_t *tsm;
1401 if (!sm->endpoint_dependent)
1402 return VNET_API_ERROR_FEATURE_DISABLED;
1404 m_key.addr = e_addr;
1405 m_key.port = e_port;
1406 m_key.protocol = proto;
1407 m_key.fib_index = 0;
1408 kv.key = m_key.as_u64;
1409 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1412 m = pool_elt_at_index (sm->static_mappings, value.value);
1417 return VNET_API_ERROR_VALUE_EXIST;
1419 if (vec_len (locals) < 2)
1420 return VNET_API_ERROR_INVALID_VALUE;
1422 /* Find external address in allocated addresses and reserve port for
1423 address and port pair mapping when dynamic translations enabled */
1424 if (!(sm->static_mapping_only || out2in_only))
1426 for (i = 0; i < vec_len (sm->addresses); i++)
1428 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1430 a = sm->addresses + i;
1431 /* External port must be unused */
1434 #define _(N, j, n, s) \
1435 case SNAT_PROTOCOL_##N: \
1436 if (a->busy_##n##_port_refcounts[e_port]) \
1437 return VNET_API_ERROR_INVALID_VALUE; \
1438 ++a->busy_##n##_port_refcounts[e_port]; \
1439 if (e_port > 1024) \
1441 a->busy_##n##_ports++; \
1442 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1445 foreach_snat_protocol
1448 nat_elog_info ("unknown protocol");
1449 return VNET_API_ERROR_INVALID_VALUE_2;
1454 /* External address must be allocated */
1456 return VNET_API_ERROR_NO_SUCH_ENTRY;
1459 pool_get (sm->static_mappings, m);
1460 clib_memset (m, 0, sizeof (*m));
1461 m->tag = vec_dup (tag);
1462 m->external_addr = e_addr;
1463 m->external_port = e_port;
1465 m->twice_nat = twice_nat;
1466 m->flags |= NAT_STATIC_MAPPING_FLAG_LB;
1468 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1469 m->affinity = affinity;
1472 m->affinity_per_service_list_head_index =
1473 nat_affinity_get_per_service_list_head_index ();
1475 m->affinity_per_service_list_head_index = ~0;
1477 m_key.addr = m->external_addr;
1478 m_key.port = m->external_port;
1479 m_key.protocol = m->proto;
1480 m_key.fib_index = 0;
1481 kv.key = m_key.as_u64;
1482 kv.value = m - sm->static_mappings;
1483 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1))
1485 nat_elog_err ("static_mapping_by_external key add failed");
1486 return VNET_API_ERROR_UNSPECIFIED;
1489 m_key.fib_index = m->fib_index;
1490 for (i = 0; i < vec_len (locals); i++)
1492 locals[i].fib_index =
1493 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
1496 m_key.addr = locals[i].addr;
1497 m_key.fib_index = locals[i].fib_index;
1500 m_key.port = locals[i].port;
1501 kv.key = m_key.as_u64;
1502 kv.value = m - sm->static_mappings;
1503 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1505 locals[i].prefix = (i == 0) ? locals[i].probability :
1506 (locals[i - 1].prefix + locals[i].probability);
1507 pool_get (m->locals, local);
1509 if (sm->num_workers > 1)
1512 .src_address = locals[i].addr,
1515 clib_bitmap_set (bitmap,
1516 sm->worker_in2out_cb (&ip, m->fib_index, 0),
1521 /* Assign workers */
1522 if (sm->num_workers > 1)
1525 clib_bitmap_foreach (i, bitmap,
1527 vec_add1(m->workers, i);
1535 return VNET_API_ERROR_NO_SUCH_ENTRY;
1537 if (!is_lb_static_mapping (m))
1538 return VNET_API_ERROR_INVALID_VALUE;
1540 /* Free external address port */
1541 if (!(sm->static_mapping_only || out2in_only))
1543 for (i = 0; i < vec_len (sm->addresses); i++)
1545 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1547 a = sm->addresses + i;
1550 #define _(N, j, n, s) \
1551 case SNAT_PROTOCOL_##N: \
1552 --a->busy_##n##_port_refcounts[e_port]; \
1553 if (e_port > 1024) \
1555 a->busy_##n##_ports--; \
1556 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1559 foreach_snat_protocol
1562 nat_elog_info ("unknown protocol");
1563 return VNET_API_ERROR_INVALID_VALUE_2;
1570 m_key.addr = m->external_addr;
1571 m_key.port = m->external_port;
1572 m_key.protocol = m->proto;
1573 m_key.fib_index = 0;
1574 kv.key = m_key.as_u64;
1575 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0))
1577 nat_elog_err ("static_mapping_by_external key del failed");
1578 return VNET_API_ERROR_UNSPECIFIED;
1582 pool_foreach (local, m->locals,
1584 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4,
1586 m_key.addr = local->addr;
1589 m_key.port = local->port;
1590 m_key.fib_index = local->fib_index;
1591 kv.key = m_key.as_u64;
1592 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1594 nat_elog_err ("static_mapping_by_local key del failed");
1595 return VNET_API_ERROR_UNSPECIFIED;
1599 if (sm->num_workers > 1)
1602 .src_address = local->addr,
1604 tsm = vec_elt_at_index (sm->per_thread_data,
1605 sm->worker_in2out_cb (&ip, m->fib_index, 0));
1608 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1610 /* Delete sessions */
1611 pool_foreach (s, tsm->sessions, {
1612 if (!(is_lb_session (s)))
1615 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1616 (clib_net_to_host_u16 (s->in2out.port) != local->port))
1619 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1620 nat44_ed_delete_session (sm, s, tsm - sm->per_thread_data, 1);
1625 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1626 pool_free (m->locals);
1628 vec_free (m->workers);
1630 pool_put (sm->static_mappings, m);
1637 nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1638 ip4_address_t l_addr, u16 l_port,
1639 snat_protocol_t proto, u32 vrf_id,
1640 u8 probability, u8 is_add)
1642 snat_main_t *sm = &snat_main;
1643 snat_static_mapping_t *m = 0;
1644 snat_session_key_t m_key;
1645 clib_bihash_kv_8_8_t kv, value;
1646 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1647 snat_main_per_thread_data_t *tsm;
1653 if (!sm->endpoint_dependent)
1654 return VNET_API_ERROR_FEATURE_DISABLED;
1656 m_key.addr = e_addr;
1657 m_key.port = e_port;
1658 m_key.protocol = proto;
1659 m_key.fib_index = 0;
1660 kv.key = m_key.as_u64;
1661 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1662 m = pool_elt_at_index (sm->static_mappings, value.value);
1665 return VNET_API_ERROR_NO_SUCH_ENTRY;
1667 if (!is_lb_static_mapping (m))
1668 return VNET_API_ERROR_INVALID_VALUE;
1671 pool_foreach (local, m->locals,
1673 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1674 (local->vrf_id == vrf_id))
1676 match_local = local;
1685 return VNET_API_ERROR_VALUE_EXIST;
1687 pool_get (m->locals, local);
1688 clib_memset (local, 0, sizeof (*local));
1689 local->addr.as_u32 = l_addr.as_u32;
1690 local->port = l_port;
1691 local->probability = probability;
1692 local->vrf_id = vrf_id;
1694 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1697 if (!is_out2in_only_static_mapping (m))
1699 m_key.addr = l_addr;
1700 m_key.port = l_port;
1701 m_key.fib_index = local->fib_index;
1702 kv.key = m_key.as_u64;
1703 kv.value = m - sm->static_mappings;
1704 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1))
1705 nat_elog_err ("static_mapping_by_local key add failed");
1711 return VNET_API_ERROR_NO_SUCH_ENTRY;
1713 if (pool_elts (m->locals) < 3)
1714 return VNET_API_ERROR_UNSPECIFIED;
1716 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1719 if (!is_out2in_only_static_mapping (m))
1721 m_key.addr = l_addr;
1722 m_key.port = l_port;
1723 m_key.fib_index = match_local->fib_index;
1724 kv.key = m_key.as_u64;
1725 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0))
1726 nat_elog_err ("static_mapping_by_local key del failed");
1729 if (sm->num_workers > 1)
1732 .src_address = local->addr,
1734 tsm = vec_elt_at_index (sm->per_thread_data,
1735 sm->worker_in2out_cb (&ip, m->fib_index,
1739 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1741 /* Delete sessions */
1743 pool_foreach (s, tsm->sessions, {
1744 if (!(is_lb_session (s)))
1747 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1748 (clib_net_to_host_u16 (s->in2out.port) != match_local->port))
1751 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1752 nat44_ed_delete_session (sm, s, tsm - sm->per_thread_data, 1);
1756 pool_put (m->locals, match_local);
1759 vec_free (m->workers);
1762 pool_foreach (local, m->locals,
1764 vec_add1 (locals, local - m->locals);
1765 if (sm->num_workers > 1)
1768 ip.src_address.as_u32 = local->addr.as_u32,
1769 bitmap = clib_bitmap_set (bitmap,
1770 sm->worker_in2out_cb (&ip, local->fib_index, 0),
1776 ASSERT (vec_len (locals) > 1);
1778 local = pool_elt_at_index (m->locals, locals[0]);
1779 local->prefix = local->probability;
1780 for (i = 1; i < vec_len (locals); i++)
1782 local = pool_elt_at_index (m->locals, locals[i]);
1783 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1784 local->prefix = local->probability + prev_local->prefix;
1787 /* Assign workers */
1788 if (sm->num_workers > 1)
1791 clib_bitmap_foreach (i, bitmap, ({ vec_add1(m->workers, i); }));
1799 snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1802 snat_address_t *a = 0;
1803 snat_session_t *ses;
1804 u32 *ses_to_be_removed = 0, *ses_index;
1805 snat_main_per_thread_data_t *tsm;
1806 snat_static_mapping_t *m;
1807 snat_interface_t *interface;
1809 snat_address_t *addresses =
1810 twice_nat ? sm->twice_nat_addresses : sm->addresses;
1812 /* Find SNAT address */
1813 for (i = 0; i < vec_len (addresses); i++)
1815 if (addresses[i].addr.as_u32 == addr.as_u32)
1822 return VNET_API_ERROR_NO_SUCH_ENTRY;
1827 pool_foreach (m, sm->static_mappings,
1829 if (m->external_addr.as_u32 == addr.as_u32)
1830 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1831 m->local_port, m->external_port,
1832 m->vrf_id, is_addr_only_static_mapping(m), ~0,
1833 m->proto, 0, m->twice_nat,
1834 is_out2in_only_static_mapping(m), m->tag, is_identity_static_mapping(m));
1840 /* Check if address is used in some static mapping */
1841 if (is_snat_address_used_in_static_mapping (sm, addr))
1843 nat_elog_notice ("address used in static mapping");
1844 return VNET_API_ERROR_UNSPECIFIED;
1848 if (a->fib_index != ~0)
1849 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1851 /* Delete sessions using address */
1852 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1855 vec_foreach (tsm, sm->per_thread_data)
1857 pool_foreach (ses, tsm->sessions, ({
1858 if (ses->out2in.addr.as_u32 == addr.as_u32)
1860 nat_free_session_data (sm, ses, tsm - sm->per_thread_data, 0);
1861 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1865 if (sm->endpoint_dependent){
1866 vec_foreach (ses_index, ses_to_be_removed)
1868 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1869 nat44_ed_delete_session (sm, ses, tsm - sm->per_thread_data, 1);
1872 vec_foreach (ses_index, ses_to_be_removed)
1874 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1875 nat44_delete_session (sm, ses, tsm - sm->per_thread_data);
1879 vec_free (ses_to_be_removed);
1884 #define _(N, i, n, s) \
1885 vec_free (a->busy_##n##_ports_per_thread);
1886 foreach_snat_protocol
1890 vec_del1 (sm->twice_nat_addresses, i);
1894 vec_del1 (sm->addresses, i);
1896 /* Delete external address from FIB */
1898 pool_foreach (interface, sm->interfaces,
1900 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1903 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1906 pool_foreach (interface, sm->output_feature_interfaces,
1908 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1911 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1920 snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1922 snat_main_t *sm = &snat_main;
1923 snat_interface_t *i;
1924 const char *feature_name, *del_feature_name;
1926 snat_static_mapping_t *m;
1928 nat_outside_fib_t *outside_fib;
1929 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1932 if (sm->out2in_dpo && !is_inside)
1933 return VNET_API_ERROR_UNSUPPORTED;
1936 pool_foreach (i, sm->output_feature_interfaces,
1938 if (i->sw_if_index == sw_if_index)
1939 return VNET_API_ERROR_VALUE_EXIST;
1943 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1944 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1947 if (sm->num_workers > 1 && !sm->deterministic)
1949 is_inside ? "nat44-in2out-worker-handoff" :
1950 "nat44-out2in-worker-handoff";
1951 else if (sm->deterministic)
1952 feature_name = is_inside ? "nat44-det-in2out" : "nat44-det-out2in";
1953 else if (sm->endpoint_dependent)
1955 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1958 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1961 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1962 sm->fq_in2out_index =
1963 vlib_frame_queue_main_init (sm->handoff_in2out_index, NAT_FQ_NELTS);
1965 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1966 sm->fq_out2in_index =
1967 vlib_frame_queue_main_init (sm->handoff_out2in_index, NAT_FQ_NELTS);
1972 vec_foreach (outside_fib, sm->outside_fibs)
1974 if (outside_fib->fib_index == fib_index)
1978 outside_fib->refcount--;
1979 if (!outside_fib->refcount)
1980 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1983 outside_fib->refcount++;
1990 vec_add2 (sm->outside_fibs, outside_fib, 1);
1991 outside_fib->refcount = 1;
1992 outside_fib->fib_index = fib_index;
1997 pool_foreach (i, sm->interfaces,
1999 if (i->sw_if_index == sw_if_index)
2003 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
2006 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
2008 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
2010 if (sm->num_workers > 1 && !sm->deterministic)
2012 del_feature_name = "nat44-handoff-classify";
2013 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
2014 "nat44-out2in-worker-handoff";
2016 else if (sm->deterministic)
2018 del_feature_name = "nat44-det-classify";
2019 feature_name = !is_inside ? "nat44-det-in2out" :
2022 else if (sm->endpoint_dependent)
2024 del_feature_name = "nat44-ed-classify";
2025 feature_name = !is_inside ? "nat-pre-in2out" :
2030 del_feature_name = "nat44-classify";
2031 feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
2034 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2037 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
2038 sw_if_index, 0, 0, 0);
2039 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2040 sw_if_index, 1, 0, 0);
2043 if (sm->endpoint_dependent)
2044 vnet_feature_enable_disable ("ip4-local",
2045 "nat44-ed-hairpinning",
2046 sw_if_index, 1, 0, 0);
2047 else if (!sm->deterministic)
2048 vnet_feature_enable_disable ("ip4-local",
2049 "nat44-hairpinning",
2050 sw_if_index, 1, 0, 0);
2055 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2058 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2059 sw_if_index, 0, 0, 0);
2060 pool_put (sm->interfaces, i);
2063 if (sm->endpoint_dependent)
2064 vnet_feature_enable_disable ("ip4-local",
2065 "nat44-ed-hairpinning",
2066 sw_if_index, 0, 0, 0);
2067 else if (!sm->deterministic)
2068 vnet_feature_enable_disable ("ip4-local",
2069 "nat44-hairpinning",
2070 sw_if_index, 0, 0, 0);
2076 if ((nat_interface_is_inside(i) && is_inside) ||
2077 (nat_interface_is_outside(i) && !is_inside))
2080 if (sm->num_workers > 1 && !sm->deterministic)
2082 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
2083 "nat44-out2in-worker-handoff";
2084 feature_name = "nat44-handoff-classify";
2086 else if (sm->deterministic)
2088 del_feature_name = !is_inside ? "nat44-det-in2out" :
2090 feature_name = "nat44-det-classify";
2092 else if (sm->endpoint_dependent)
2094 del_feature_name = !is_inside ? "nat-pre-in2out" :
2097 feature_name = "nat44-ed-classify";
2101 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
2102 feature_name = "nat44-classify";
2105 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
2108 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
2109 sw_if_index, 0, 0, 0);
2110 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2111 sw_if_index, 1, 0, 0);
2114 if (sm->endpoint_dependent)
2115 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
2116 sw_if_index, 0, 0, 0);
2117 else if (!sm->deterministic)
2118 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
2119 sw_if_index, 0, 0, 0);
2130 return VNET_API_ERROR_NO_SUCH_ENTRY;
2132 pool_get (sm->interfaces, i);
2133 i->sw_if_index = sw_if_index;
2135 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0,
2138 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
2142 if (is_inside && !sm->out2in_dpo)
2144 if (sm->endpoint_dependent)
2145 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
2146 sw_if_index, 1, 0, 0);
2147 else if (!sm->deterministic)
2148 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
2149 sw_if_index, 1, 0, 0);
2155 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2159 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2161 /* Add/delete external addresses to FIB */
2164 vec_foreach (ap, sm->addresses)
2165 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2167 pool_foreach (m, sm->static_mappings,
2169 if (!(is_addr_only_static_mapping(m)) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2172 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2175 pool_foreach (dm, sm->det_maps,
2177 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
2185 snat_interface_add_del_output_feature (u32 sw_if_index,
2186 u8 is_inside, int is_del)
2188 snat_main_t *sm = &snat_main;
2189 snat_interface_t *i;
2191 snat_static_mapping_t *m;
2192 nat_outside_fib_t *outside_fib;
2193 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
2197 if (sm->deterministic ||
2198 (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
2199 return VNET_API_ERROR_UNSUPPORTED;
2202 pool_foreach (i, sm->interfaces,
2204 if (i->sw_if_index == sw_if_index)
2205 return VNET_API_ERROR_VALUE_EXIST;
2212 vec_foreach (outside_fib, sm->outside_fibs)
2214 if (outside_fib->fib_index == fib_index)
2218 outside_fib->refcount--;
2219 if (!outside_fib->refcount)
2220 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2223 outside_fib->refcount++;
2230 vec_add2 (sm->outside_fibs, outside_fib, 1);
2231 outside_fib->refcount = 1;
2232 outside_fib->fib_index = fib_index;
2239 if (sm->endpoint_dependent)
2242 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2246 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2250 vnet_feature_enable_disable ("ip4-unicast", "nat44-ed-hairpin-dst",
2251 sw_if_index, !is_del, 0, 0);
2252 vnet_feature_enable_disable ("ip4-output", "nat44-ed-hairpin-src",
2253 sw_if_index, !is_del, 0, 0);
2258 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2262 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2266 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
2267 sw_if_index, !is_del, 0, 0);
2268 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
2269 sw_if_index, !is_del, 0, 0);
2274 if (sm->num_workers > 1)
2276 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2280 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, !is_del);
2283 vnet_feature_enable_disable ("ip4-unicast",
2284 "nat44-out2in-worker-handoff",
2285 sw_if_index, !is_del, 0, 0);
2286 vnet_feature_enable_disable ("ip4-output",
2287 "nat44-in2out-output-worker-handoff",
2288 sw_if_index, !is_del, 0, 0);
2292 if (sm->endpoint_dependent)
2295 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2299 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2303 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
2304 sw_if_index, !is_del, 0, 0);
2305 vnet_feature_enable_disable ("ip4-output", "nat44-ed-in2out-output",
2306 sw_if_index, !is_del, 0, 0);
2311 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2315 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2319 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in",
2320 sw_if_index, !is_del, 0, 0);
2321 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
2322 sw_if_index, !is_del, 0, 0);
2327 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
2328 sm->fq_in2out_output_index =
2329 vlib_frame_queue_main_init (sm->handoff_in2out_output_index, 0);
2331 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
2332 sm->fq_out2in_index =
2333 vlib_frame_queue_main_init (sm->handoff_out2in_index, 0);
2336 pool_foreach (i, sm->output_feature_interfaces,
2338 if (i->sw_if_index == sw_if_index)
2341 pool_put (sm->output_feature_interfaces, i);
2343 return VNET_API_ERROR_VALUE_EXIST;
2351 return VNET_API_ERROR_NO_SUCH_ENTRY;
2353 pool_get (sm->output_feature_interfaces, i);
2354 i->sw_if_index = sw_if_index;
2357 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2359 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2361 /* Add/delete external addresses to FIB */
2367 vec_foreach (ap, sm->addresses)
2368 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2370 pool_foreach (m, sm->static_mappings,
2372 if (!((is_addr_only_static_mapping(m))) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2375 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2383 snat_set_workers (uword * bitmap)
2385 snat_main_t *sm = &snat_main;
2388 if (sm->num_workers < 2)
2389 return VNET_API_ERROR_FEATURE_DISABLED;
2391 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2392 return VNET_API_ERROR_INVALID_WORKER;
2394 vec_free (sm->workers);
2396 clib_bitmap_foreach (i, bitmap,
2398 vec_add1(sm->workers, i);
2399 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2400 sm->per_thread_data[sm->first_worker_index + i].thread_index = i;
2405 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
2406 sm->num_snat_thread = _vec_len (sm->workers);
2412 snat_update_outside_fib (u32 sw_if_index, u32 new_fib_index,
2415 snat_main_t *sm = &snat_main;
2416 nat_outside_fib_t *outside_fib;
2417 snat_interface_t *i;
2421 if (new_fib_index == old_fib_index)
2424 if (!vec_len (sm->outside_fibs))
2428 pool_foreach (i, sm->interfaces,
2430 if (i->sw_if_index == sw_if_index)
2432 if (!(nat_interface_is_outside (i)))
2438 pool_foreach (i, sm->output_feature_interfaces,
2440 if (i->sw_if_index == sw_if_index)
2442 if (!(nat_interface_is_outside (i)))
2452 vec_foreach (outside_fib, sm->outside_fibs)
2454 if (outside_fib->fib_index == old_fib_index)
2456 outside_fib->refcount--;
2457 if (!outside_fib->refcount)
2458 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2463 vec_foreach (outside_fib, sm->outside_fibs)
2465 if (outside_fib->fib_index == new_fib_index)
2467 outside_fib->refcount++;
2475 vec_add2 (sm->outside_fibs, outside_fib, 1);
2476 outside_fib->refcount = 1;
2477 outside_fib->fib_index = new_fib_index;
2482 snat_ip4_table_bind (ip4_main_t * im,
2484 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
2486 snat_update_outside_fib (sw_if_index, new_fib_index, old_fib_index);
2490 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2493 ip4_address_t * address,
2495 u32 if_address_index, u32 is_delete);
2498 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
2501 ip4_address_t * address,
2503 u32 if_address_index, u32 is_delete);
2506 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2509 snat_session_key_t * k,
2510 u16 port_per_thread, u32 snat_thread_index);
2513 test_ed_make_split ()
2515 ip4_address_t l_addr;
2516 l_addr.as_u8[0] = 1;
2517 l_addr.as_u8[1] = 1;
2518 l_addr.as_u8[2] = 1;
2519 l_addr.as_u8[3] = 1;
2520 ip4_address_t r_addr;
2521 r_addr.as_u8[0] = 2;
2522 r_addr.as_u8[1] = 2;
2523 r_addr.as_u8[2] = 2;
2524 r_addr.as_u8[3] = 2;
2528 u32 fib_index = 9000001;
2530 clib_bihash_kv_16_8_t kv;
2531 make_ed_kv (&l_addr, &r_addr, proto, fib_index, l_port, r_port, value, &kv);
2532 ip4_address_t l_addr2;
2533 ip4_address_t r_addr2;
2534 clib_memset (&l_addr2, 0, sizeof (l_addr2));
2535 clib_memset (&r_addr2, 0, sizeof (r_addr2));
2540 split_ed_kv (&kv, &l_addr2, &r_addr2, &proto2, &fib_index2, &l_port2,
2542 u64 value2 = kv.value;
2543 ASSERT (l_addr.as_u32 == l_addr2.as_u32);
2544 ASSERT (r_addr.as_u32 == r_addr2.as_u32);
2545 ASSERT (l_port == l_port2);
2546 ASSERT (r_port == r_port2);
2547 ASSERT (proto == proto2);
2548 ASSERT (fib_index == fib_index2);
2549 ASSERT (value == value2);
2552 static clib_error_t *
2553 snat_init (vlib_main_t * vm)
2555 snat_main_t *sm = &snat_main;
2556 clib_error_t *error = 0;
2557 ip4_main_t *im = &ip4_main;
2558 ip_lookup_main_t *lm = &im->lookup_main;
2560 vlib_thread_registration_t *tr;
2561 vlib_thread_main_t *tm = vlib_get_thread_main ();
2564 ip4_add_del_interface_address_callback_t cb4;
2567 sm->vnet_main = vnet_get_main ();
2569 sm->ip4_lookup_main = lm;
2570 sm->api_main = vlibapi_get_main ();
2571 sm->first_worker_index = 0;
2572 sm->num_workers = 0;
2573 sm->num_snat_thread = 1;
2575 sm->port_per_thread = 0xffff - 1024;
2576 sm->fq_in2out_index = ~0;
2577 sm->fq_in2out_output_index = ~0;
2578 sm->fq_out2in_index = ~0;
2580 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
2581 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
2582 sm->forwarding_enabled = 0;
2583 sm->log_class = vlib_log_register_class ("nat", 0);
2584 sm->log_level = SNAT_LOG_ERROR;
2585 sm->mss_clamping = 0;
2587 node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
2588 sm->error_node_index = node->index;
2590 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2591 sm->pre_in2out_node_index = node->index;
2592 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2593 sm->pre_out2in_node_index = node->index;
2595 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2596 sm->pre_in2out_node_index = node->index;
2598 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2599 sm->pre_out2in_node_index = node->index;
2601 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out");
2602 sm->in2out_node_index = node->index;
2603 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output");
2604 sm->in2out_output_node_index = node->index;
2605 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-fast");
2606 sm->in2out_fast_node_index = node->index;
2607 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-slowpath");
2608 sm->in2out_slowpath_node_index = node->index;
2609 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output-slowpath");
2610 sm->in2out_slowpath_output_node_index = node->index;
2612 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out");
2613 sm->ed_in2out_node_index = node->index;
2614 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-slowpath");
2615 sm->ed_in2out_slowpath_node_index = node->index;
2617 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in");
2618 sm->out2in_node_index = node->index;
2619 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in-fast");
2620 sm->out2in_fast_node_index = node->index;
2622 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in");
2623 sm->ed_out2in_node_index = node->index;
2624 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in-slowpath");
2625 sm->ed_out2in_slowpath_node_index = node->index;
2627 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-in2out");
2628 sm->det_in2out_node_index = node->index;
2629 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-out2in");
2630 sm->det_out2in_node_index = node->index;
2632 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpinning");
2633 sm->hairpinning_node_index = node->index;
2634 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-dst");
2635 sm->hairpin_dst_node_index = node->index;
2636 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-src");
2637 sm->hairpin_src_node_index = node->index;
2638 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpinning");
2639 sm->ed_hairpinning_node_index = node->index;
2640 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-dst");
2641 sm->ed_hairpin_dst_node_index = node->index;
2642 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-src");
2643 sm->ed_hairpin_src_node_index = node->index;
2645 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2648 tr = (vlib_thread_registration_t *) p[0];
2651 sm->num_workers = tr->count;
2652 sm->first_worker_index = tr->first_index;
2656 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2658 /* Use all available workers by default */
2659 if (sm->num_workers > 1)
2661 for (i = 0; i < sm->num_workers; i++)
2662 bitmap = clib_bitmap_set (bitmap, i, 1);
2663 // sets thread indexes for workes
2664 snat_set_workers (bitmap);
2665 clib_bitmap_free (bitmap);
2669 sm->per_thread_data[0].snat_thread_index = 0;
2672 error = snat_api_init (vm, sm);
2676 /* Set up the interface address add/del callback */
2677 cb4.function = snat_ip4_add_del_interface_address_cb;
2678 cb4.function_opaque = 0;
2680 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2682 cb4.function = nat_ip4_add_del_addr_only_sm_cb;
2683 cb4.function_opaque = 0;
2685 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2687 nat_dpo_module_init ();
2690 sm->total_users.name = "total-users";
2691 sm->total_users.stat_segment_name = "/nat44/total-users";
2692 vlib_validate_simple_counter (&sm->total_users, 0);
2693 vlib_zero_simple_counter (&sm->total_users, 0);
2694 sm->total_sessions.name = "total-sessions";
2695 sm->total_sessions.stat_segment_name = "/nat44/total-sessions";
2696 vlib_validate_simple_counter (&sm->total_sessions, 0);
2697 vlib_zero_simple_counter (&sm->total_sessions, 0);
2699 /* Init IPFIX logging */
2700 snat_ipfix_logging_init (vm);
2703 error = nat64_init (vm);
2709 ip4_table_bind_callback_t cbt4 = {
2710 .function = snat_ip4_table_bind,
2712 vec_add1 (ip4_main.table_bind_callbacks, cbt4);
2714 nat_fib_src_hi = fib_source_allocate ("nat-hi",
2715 FIB_SOURCE_PRIORITY_HI,
2716 FIB_SOURCE_BH_SIMPLE);
2717 nat_fib_src_low = fib_source_allocate ("nat-low",
2718 FIB_SOURCE_PRIORITY_LOW,
2719 FIB_SOURCE_BH_SIMPLE);
2721 test_ed_make_split ();
2725 VLIB_INIT_FUNCTION (snat_init);
2728 snat_free_outside_address_and_port (snat_address_t * addresses,
2729 u32 thread_index, snat_session_key_t * k)
2733 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2735 for (address_index = 0; address_index < vec_len (addresses);
2738 if (addresses[address_index].addr.as_u32 == k->addr.as_u32)
2742 ASSERT (address_index < vec_len (addresses));
2744 a = addresses + address_index;
2746 switch (k->protocol)
2748 #define _(N, i, n, s) \
2749 case SNAT_PROTOCOL_##N: \
2750 ASSERT (a->busy_##n##_port_refcounts[port_host_byte_order] >= 1); \
2751 --a->busy_##n##_port_refcounts[port_host_byte_order]; \
2752 a->busy_##n##_ports--; \
2753 a->busy_##n##_ports_per_thread[thread_index]--; \
2755 foreach_snat_protocol
2758 nat_elog_info ("unknown protocol");
2764 nat_set_outside_address_and_port (snat_address_t * addresses,
2765 u32 thread_index, snat_session_key_t * k)
2767 snat_address_t *a = 0;
2769 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2771 for (address_index = 0; address_index < vec_len (addresses);
2774 if (addresses[address_index].addr.as_u32 != k->addr.as_u32)
2777 a = addresses + address_index;
2778 switch (k->protocol)
2780 #define _(N, j, n, s) \
2781 case SNAT_PROTOCOL_##N: \
2782 if (a->busy_##n##_port_refcounts[port_host_byte_order]) \
2783 return VNET_API_ERROR_INSTANCE_IN_USE; \
2784 ++a->busy_##n##_port_refcounts[port_host_byte_order]; \
2785 a->busy_##n##_ports_per_thread[thread_index]++; \
2786 a->busy_##n##_ports++; \
2788 foreach_snat_protocol
2791 nat_elog_info ("unknown protocol");
2796 return VNET_API_ERROR_NO_SUCH_ENTRY;
2800 snat_static_mapping_match (snat_main_t * sm,
2801 snat_session_key_t match,
2802 snat_session_key_t * mapping,
2805 twice_nat_type_t * twice_nat,
2806 lb_nat_type_t * lb, ip4_address_t * ext_host_addr,
2807 u8 * is_identity_nat)
2809 clib_bihash_kv_8_8_t kv, value;
2810 snat_static_mapping_t *m;
2811 snat_session_key_t m_key;
2812 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
2813 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2815 nat44_lb_addr_port_t *local;
2817 m_key.fib_index = match.fib_index;
2820 mapping_hash = &sm->static_mapping_by_external;
2821 m_key.fib_index = 0;
2824 m_key.addr = match.addr;
2825 m_key.port = clib_net_to_host_u16 (match.port);
2826 m_key.protocol = match.protocol;
2828 kv.key = m_key.as_u64;
2830 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2832 /* Try address only mapping */
2835 kv.key = m_key.as_u64;
2836 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2840 m = pool_elt_at_index (sm->static_mappings, value.value);
2844 if (is_lb_static_mapping (m))
2846 if (PREDICT_FALSE (lb != 0))
2847 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2848 if (m->affinity && !nat_affinity_find_and_lock (ext_host_addr[0],
2854 local = pool_elt_at_index (m->locals, backend_index);
2855 mapping->addr = local->addr;
2856 mapping->port = clib_host_to_net_u16 (local->port);
2857 mapping->fib_index = local->fib_index;
2860 // pick locals matching this worker
2861 if (PREDICT_FALSE (sm->num_workers > 1))
2863 u32 thread_index = vlib_get_thread_index ();
2865 pool_foreach_index (i, m->locals,
2867 local = pool_elt_at_index (m->locals, i);
2870 .src_address = local->addr,
2873 if (sm->worker_in2out_cb (&ip, m->fib_index, 0) ==
2880 ASSERT (vec_len (tmp) != 0);
2885 pool_foreach_index (i, m->locals,
2891 hi = vec_len (tmp) - 1;
2892 local = pool_elt_at_index (m->locals, tmp[hi]);
2893 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2896 mid = ((hi - lo) >> 1) + lo;
2897 local = pool_elt_at_index (m->locals, tmp[mid]);
2898 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2900 local = pool_elt_at_index (m->locals, tmp[lo]);
2901 if (!(local->prefix >= rand))
2903 mapping->addr = local->addr;
2904 mapping->port = clib_host_to_net_u16 (local->port);
2905 mapping->fib_index = local->fib_index;
2908 if (nat_affinity_create_and_lock (ext_host_addr[0], match.addr,
2909 match.protocol, match.port,
2910 tmp[lo], m->affinity,
2911 m->affinity_per_service_list_head_index))
2912 nat_elog_info ("create affinity record failed");
2918 if (PREDICT_FALSE (lb != 0))
2920 mapping->fib_index = m->fib_index;
2921 mapping->addr = m->local_addr;
2922 /* Address only mapping doesn't change port */
2923 mapping->port = is_addr_only_static_mapping (m) ? match.port
2924 : clib_host_to_net_u16 (m->local_port);
2926 mapping->protocol = m->proto;
2930 mapping->addr = m->external_addr;
2931 /* Address only mapping doesn't change port */
2932 mapping->port = is_addr_only_static_mapping (m) ? match.port
2933 : clib_host_to_net_u16 (m->external_port);
2934 mapping->fib_index = sm->outside_fib_index;
2938 if (PREDICT_FALSE (is_addr_only != 0))
2939 *is_addr_only = is_addr_only_static_mapping (m);
2941 if (PREDICT_FALSE (twice_nat != 0))
2942 *twice_nat = m->twice_nat;
2944 if (PREDICT_FALSE (is_identity_nat != 0))
2945 *is_identity_nat = is_identity_static_mapping (m);
2950 static_always_inline u16
2951 snat_random_port (u16 min, u16 max)
2953 snat_main_t *sm = &snat_main;
2954 return min + random_u32 (&sm->random_seed) /
2955 (random_u32_max () / (max - min + 1) + 1);
2959 snat_alloc_outside_address_and_port (snat_address_t * addresses,
2962 snat_session_key_t * k,
2963 u16 port_per_thread,
2964 u32 snat_thread_index)
2966 snat_main_t *sm = &snat_main;
2968 return sm->alloc_addr_and_port (addresses, fib_index, thread_index, k,
2969 port_per_thread, snat_thread_index);
2973 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2976 snat_session_key_t * k,
2977 u16 port_per_thread, u32 snat_thread_index)
2980 snat_address_t *a, *ga = 0;
2983 for (i = 0; i < vec_len (addresses); i++)
2986 switch (k->protocol)
2988 #define _(N, j, n, s) \
2989 case SNAT_PROTOCOL_##N: \
2990 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
2992 if (a->fib_index == fib_index) \
2996 portnum = (port_per_thread * \
2997 snat_thread_index) + \
2998 snat_random_port(1, port_per_thread) + 1024; \
2999 if (a->busy_##n##_port_refcounts[portnum]) \
3001 --a->busy_##n##_port_refcounts[portnum]; \
3002 a->busy_##n##_ports_per_thread[thread_index]++; \
3003 a->busy_##n##_ports++; \
3004 k->addr = a->addr; \
3005 k->port = clib_host_to_net_u16(portnum); \
3009 else if (a->fib_index == ~0) \
3015 foreach_snat_protocol
3018 nat_elog_info ("unknown protocol");
3027 switch (k->protocol)
3029 #define _(N, j, n, s) \
3030 case SNAT_PROTOCOL_##N: \
3033 portnum = (port_per_thread * \
3034 snat_thread_index) + \
3035 snat_random_port(1, port_per_thread) + 1024; \
3036 if (a->busy_##n##_port_refcounts[portnum]) \
3038 ++a->busy_##n##_port_refcounts[portnum]; \
3039 a->busy_##n##_ports_per_thread[thread_index]++; \
3040 a->busy_##n##_ports++; \
3041 k->addr = a->addr; \
3042 k->port = clib_host_to_net_u16(portnum); \
3046 foreach_snat_protocol
3049 nat_elog_info ("unknown protocol");
3054 /* Totally out of translations to use... */
3055 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3060 nat_alloc_addr_and_port_mape (snat_address_t * addresses,
3063 snat_session_key_t * k,
3064 u16 port_per_thread, u32 snat_thread_index)
3066 snat_main_t *sm = &snat_main;
3067 snat_address_t *a = addresses;
3068 u16 m, ports, portnum, A, j;
3069 m = 16 - (sm->psid_offset + sm->psid_length);
3070 ports = (1 << (16 - sm->psid_length)) - (1 << m);
3072 if (!vec_len (addresses))
3075 switch (k->protocol)
3077 #define _(N, i, n, s) \
3078 case SNAT_PROTOCOL_##N: \
3079 if (a->busy_##n##_ports < ports) \
3083 A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
3084 j = snat_random_port(0, pow2_mask(m)); \
3085 portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
3086 if (a->busy_##n##_port_refcounts[portnum]) \
3088 ++a->busy_##n##_port_refcounts[portnum]; \
3089 a->busy_##n##_ports++; \
3090 k->addr = a->addr; \
3091 k->port = clib_host_to_net_u16 (portnum); \
3096 foreach_snat_protocol
3099 nat_elog_info ("unknown protocol");
3104 /* Totally out of translations to use... */
3105 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3110 nat_alloc_addr_and_port_range (snat_address_t * addresses,
3113 snat_session_key_t * k,
3114 u16 port_per_thread, u32 snat_thread_index)
3116 snat_main_t *sm = &snat_main;
3117 snat_address_t *a = addresses;
3120 ports = sm->end_port - sm->start_port + 1;
3122 if (!vec_len (addresses))
3125 switch (k->protocol)
3127 #define _(N, i, n, s) \
3128 case SNAT_PROTOCOL_##N: \
3129 if (a->busy_##n##_ports < ports) \
3133 portnum = snat_random_port(sm->start_port, sm->end_port); \
3134 if (a->busy_##n##_port_refcounts[portnum]) \
3136 ++a->busy_##n##_port_refcounts[portnum]; \
3137 a->busy_##n##_ports++; \
3138 k->addr = a->addr; \
3139 k->port = clib_host_to_net_u16 (portnum); \
3144 foreach_snat_protocol
3147 nat_elog_info ("unknown protocol");
3152 /* Totally out of translations to use... */
3153 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3158 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
3160 dpo_id_t dpo_v4 = DPO_INVALID;
3161 fib_prefix_t pfx = {
3162 .fp_proto = FIB_PROTOCOL_IP4,
3164 .fp_addr.ip4.as_u32 = addr.as_u32,
3169 nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
3170 fib_table_entry_special_dpo_add (0, &pfx, nat_fib_src_hi,
3171 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
3172 dpo_reset (&dpo_v4);
3176 fib_table_entry_special_remove (0, &pfx, nat_fib_src_hi);
3181 format_session_kvp (u8 * s, va_list * args)
3183 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3184 snat_session_key_t k;
3188 s = format (s, "%U session-index %llu", format_snat_key, &k, v->value);
3194 format_static_mapping_kvp (u8 * s, va_list * args)
3196 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3197 snat_session_key_t k;
3201 s = format (s, "%U static-mapping-index %llu",
3202 format_static_mapping_key, &k, v->value);
3208 format_user_kvp (u8 * s, va_list * args)
3210 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3215 s = format (s, "%U fib %d user-index %llu", format_ip4_address, &k.addr,
3216 k.fib_index, v->value);
3222 format_ed_session_kvp (u8 * s, va_list * args)
3224 clib_bihash_kv_16_8_t *v = va_arg (*args, clib_bihash_kv_16_8_t *);
3228 ip4_address_t l_addr, r_addr;
3231 split_ed_kv (v, &l_addr, &r_addr, &proto, &fib_index, &l_port, &r_port);
3233 format (s, "local %U:%d remote %U:%d proto %U fib %d session-index %llu",
3234 format_ip4_address, &l_addr, clib_net_to_host_u16 (l_port),
3235 format_ip4_address, &r_addr, clib_net_to_host_u16 (r_port),
3236 format_ip_protocol, proto, fib_index, v->value);
3242 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0,
3245 snat_main_t *sm = &snat_main;
3246 u32 next_worker_index = 0;
3249 next_worker_index = sm->first_worker_index;
3250 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
3251 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >> 24);
3253 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3254 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3256 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3258 return next_worker_index;
3262 snat_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip0,
3263 u32 rx_fib_index0, u8 is_output)
3265 snat_main_t *sm = &snat_main;
3268 snat_session_key_t m_key;
3269 clib_bihash_kv_8_8_t kv, value;
3270 snat_static_mapping_t *m;
3272 u32 next_worker_index = 0;
3274 /* first try static mappings without port */
3275 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3277 m_key.addr = ip0->dst_address;
3280 m_key.fib_index = rx_fib_index0;
3281 kv.key = m_key.as_u64;
3282 if (!clib_bihash_search_8_8
3283 (&sm->static_mapping_by_external, &kv, &value))
3285 m = pool_elt_at_index (sm->static_mappings, value.value);
3286 return m->workers[0];
3290 proto = ip_proto_to_snat_proto (ip0->protocol);
3291 udp = ip4_next_header (ip0);
3292 port = udp->dst_port;
3294 /* unknown protocol */
3295 if (PREDICT_FALSE (proto == ~0))
3297 /* use current thread */
3298 return vlib_get_thread_index ();
3301 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
3303 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3304 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3305 if (!icmp_type_is_error_message
3306 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3307 port = vnet_buffer (b)->ip.reass.l4_src_port;
3310 /* if error message, then it's not fragmented and we can access it */
3311 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3312 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3313 void *l4_header = ip4_next_header (inner_ip);
3316 case SNAT_PROTOCOL_ICMP:
3317 icmp = (icmp46_header_t *) l4_header;
3318 echo = (icmp_echo_header_t *) (icmp + 1);
3319 port = echo->identifier;
3321 case SNAT_PROTOCOL_UDP:
3322 case SNAT_PROTOCOL_TCP:
3323 port = ((tcp_udp_header_t *) l4_header)->src_port;
3326 return vlib_get_thread_index ();
3331 /* try static mappings with port */
3332 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3334 m_key.addr = ip0->dst_address;
3335 m_key.port = clib_net_to_host_u16 (port);
3336 m_key.protocol = proto;
3337 m_key.fib_index = rx_fib_index0;
3338 kv.key = m_key.as_u64;
3339 if (!clib_bihash_search_8_8
3340 (&sm->static_mapping_by_external, &kv, &value))
3342 m = pool_elt_at_index (sm->static_mappings, value.value);
3343 return m->workers[0];
3347 /* worker by outside port */
3348 next_worker_index = sm->first_worker_index;
3349 next_worker_index +=
3350 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3351 return next_worker_index;
3355 nat44_ed_get_worker_in2out_cb (ip4_header_t * ip, u32 rx_fib_index,
3358 snat_main_t *sm = &snat_main;
3359 u32 next_worker_index = sm->first_worker_index;
3362 clib_bihash_kv_16_8_t kv16, value16;
3363 snat_main_per_thread_data_t *tsm;
3366 if (PREDICT_FALSE (is_output))
3368 u32 fib_index = sm->outside_fib_index;
3369 nat_outside_fib_t *outside_fib;
3370 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3371 fib_prefix_t pfx = {
3372 .fp_proto = FIB_PROTOCOL_IP4,
3375 .ip4.as_u32 = ip->dst_address.as_u32,
3380 udp = ip4_next_header (ip);
3382 switch (vec_len (sm->outside_fibs))
3385 fib_index = sm->outside_fib_index;
3388 fib_index = sm->outside_fibs[0].fib_index;
3392 vec_foreach (outside_fib, sm->outside_fibs)
3394 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3395 if (FIB_NODE_INDEX_INVALID != fei)
3397 if (fib_entry_get_resolving_interface (fei) != ~0)
3399 fib_index = outside_fib->fib_index;
3408 make_ed_kv (&ip->src_address, &ip->dst_address,
3409 ip->protocol, fib_index, udp->src_port, udp->dst_port,
3413 vec_foreach (tsm, sm->per_thread_data)
3415 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3418 next_worker_index += tsm->thread_index;
3420 nat_elog_debug_handoff (
3421 "HANDOFF IN2OUT-OUTPUT-FEATURE (session)",
3422 next_worker_index, fib_index,
3423 clib_net_to_host_u32 (ip->src_address.as_u32),
3424 clib_net_to_host_u32 (ip->dst_address.as_u32));
3426 return next_worker_index;
3432 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3433 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3435 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3436 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3438 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3440 if (PREDICT_TRUE (!is_output))
3442 nat_elog_debug_handoff ("HANDOFF IN2OUT",
3443 next_worker_index, rx_fib_index,
3444 clib_net_to_host_u32 (ip->src_address.as_u32),
3445 clib_net_to_host_u32 (ip->dst_address.as_u32));
3449 nat_elog_debug_handoff ("HANDOFF IN2OUT-OUTPUT-FEATURE",
3450 next_worker_index, rx_fib_index,
3451 clib_net_to_host_u32 (ip->src_address.as_u32),
3452 clib_net_to_host_u32 (ip->dst_address.as_u32));
3455 return next_worker_index;
3459 nat44_ed_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip,
3460 u32 rx_fib_index, u8 is_output)
3462 snat_main_t *sm = &snat_main;
3463 clib_bihash_kv_8_8_t kv, value;
3464 clib_bihash_kv_16_8_t kv16, value16;
3465 snat_main_per_thread_data_t *tsm;
3467 u32 proto, next_worker_index = 0;
3470 snat_static_mapping_t *m;
3473 proto = ip_proto_to_snat_proto (ip->protocol);
3475 if (PREDICT_TRUE (proto == SNAT_PROTOCOL_UDP || proto == SNAT_PROTOCOL_TCP))
3477 udp = ip4_next_header (ip);
3479 make_ed_kv (&ip->dst_address, &ip->src_address,
3480 ip->protocol, rx_fib_index, udp->dst_port, udp->src_port,
3484 vec_foreach (tsm, sm->per_thread_data)
3486 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3489 next_worker_index = sm->first_worker_index + tsm->thread_index;
3490 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3491 next_worker_index, rx_fib_index,
3492 clib_net_to_host_u32 (ip->src_address.as_u32),
3493 clib_net_to_host_u32 (ip->dst_address.as_u32));
3494 return next_worker_index;
3499 else if (proto == SNAT_PROTOCOL_ICMP)
3501 if (!get_icmp_o2i_ed_key (b, ip, rx_fib_index, ~0ULL, 0, 0, 0, &kv16))
3504 vec_foreach (tsm, sm->per_thread_data)
3506 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3509 next_worker_index = sm->first_worker_index +
3511 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3512 next_worker_index, rx_fib_index,
3513 clib_net_to_host_u32 (ip->src_address.as_u32),
3514 clib_net_to_host_u32 (ip->dst_address.as_u32));
3515 return next_worker_index;
3522 /* first try static mappings without port */
3523 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3525 make_sm_kv (&kv, &ip->dst_address, 0, 0, 0);
3526 if (!clib_bihash_search_8_8
3527 (&sm->static_mapping_by_external, &kv, &value))
3529 m = pool_elt_at_index (sm->static_mappings, value.value);
3530 next_worker_index = m->workers[0];
3535 /* unknown protocol */
3536 if (PREDICT_FALSE (proto == ~0))
3538 /* use current thread */
3539 next_worker_index = vlib_get_thread_index ();
3543 udp = ip4_next_header (ip);
3544 port = udp->dst_port;
3546 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
3548 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3549 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3550 if (!icmp_type_is_error_message
3551 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3552 port = vnet_buffer (b)->ip.reass.l4_src_port;
3555 /* if error message, then it's not fragmented and we can access it */
3556 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3557 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3558 void *l4_header = ip4_next_header (inner_ip);
3561 case SNAT_PROTOCOL_ICMP:
3562 icmp = (icmp46_header_t *) l4_header;
3563 echo = (icmp_echo_header_t *) (icmp + 1);
3564 port = echo->identifier;
3566 case SNAT_PROTOCOL_UDP:
3567 case SNAT_PROTOCOL_TCP:
3568 port = ((tcp_udp_header_t *) l4_header)->src_port;
3571 next_worker_index = vlib_get_thread_index ();
3577 /* try static mappings with port */
3578 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3580 make_sm_kv (&kv, &ip->dst_address, proto, 0,
3581 clib_net_to_host_u16 (port));
3582 if (!clib_bihash_search_8_8
3583 (&sm->static_mapping_by_external, &kv, &value))
3585 m = pool_elt_at_index (sm->static_mappings, value.value);
3586 if (!is_lb_static_mapping (m))
3588 next_worker_index = m->workers[0];
3592 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3593 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3595 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
3597 m->workers[hash & (_vec_len (m->workers) - 1)];
3599 next_worker_index = m->workers[hash % _vec_len (m->workers)];
3604 /* worker by outside port */
3605 next_worker_index = sm->first_worker_index;
3606 next_worker_index +=
3607 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3610 nat_elog_debug_handoff ("HANDOFF OUT2IN", next_worker_index, rx_fib_index,
3611 clib_net_to_host_u32 (ip->src_address.as_u32),
3612 clib_net_to_host_u32 (ip->dst_address.as_u32));
3613 return next_worker_index;
3617 nat_ha_sadd_cb (ip4_address_t * in_addr, u16 in_port,
3618 ip4_address_t * out_addr, u16 out_port,
3619 ip4_address_t * eh_addr, u16 eh_port,
3620 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3621 u32 fib_index, u16 flags, u32 thread_index)
3623 snat_main_t *sm = &snat_main;
3624 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
3625 snat_session_key_t key;
3628 clib_bihash_kv_8_8_t kv;
3629 vlib_main_t *vm = vlib_get_main ();
3630 f64 now = vlib_time_now (vm);
3631 nat_outside_fib_t *outside_fib;
3632 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3633 fib_prefix_t pfx = {
3634 .fp_proto = FIB_PROTOCOL_IP4,
3637 .ip4.as_u32 = eh_addr->as_u32,
3641 key.addr.as_u32 = out_addr->as_u32;
3642 key.port = out_port;
3643 key.protocol = proto;
3645 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3647 if (nat_set_outside_address_and_port
3648 (sm->addresses, thread_index, &key))
3652 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3656 s = nat_session_alloc_or_recycle (sm, u, thread_index, now);
3660 s->last_heard = now;
3662 s->ext_host_addr.as_u32 = eh_addr->as_u32;
3663 s->ext_host_port = eh_port;
3664 user_session_increment (sm, u, snat_is_session_static (s));
3665 switch (vec_len (sm->outside_fibs))
3668 key.fib_index = sm->outside_fib_index;
3671 key.fib_index = sm->outside_fibs[0].fib_index;
3675 vec_foreach (outside_fib, sm->outside_fibs)
3677 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3678 if (FIB_NODE_INDEX_INVALID != fei)
3680 if (fib_entry_get_resolving_interface (fei) != ~0)
3682 key.fib_index = outside_fib->fib_index;
3691 kv.key = key.as_u64;
3692 kv.value = s - tsm->sessions;
3693 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 1))
3694 nat_elog_warn ("out2in key add failed");
3696 key.addr.as_u32 = in_addr->as_u32;
3698 key.fib_index = fib_index;
3700 kv.key = key.as_u64;
3701 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 1))
3702 nat_elog_warn ("in2out key add failed");
3706 nat_ha_sdel_cb (ip4_address_t * out_addr, u16 out_port,
3707 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3710 snat_main_t *sm = &snat_main;
3711 snat_session_key_t key;
3712 clib_bihash_kv_8_8_t kv, value;
3715 snat_main_per_thread_data_t *tsm;
3717 if (sm->num_workers > 1)
3719 sm->first_worker_index +
3720 (sm->workers[(clib_net_to_host_u16 (out_port) -
3721 1024) / sm->port_per_thread]);
3723 thread_index = sm->num_workers;
3724 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3726 key.addr.as_u32 = out_addr->as_u32;
3727 key.port = out_port;
3728 key.protocol = proto;
3729 key.fib_index = fib_index;
3730 kv.key = key.as_u64;
3731 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3734 s = pool_elt_at_index (tsm->sessions, value.value);
3735 nat_free_session_data (sm, s, thread_index, 1);
3736 nat44_delete_session (sm, s, thread_index);
3740 nat_ha_sref_cb (ip4_address_t * out_addr, u16 out_port,
3741 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3742 u32 total_pkts, u64 total_bytes, u32 thread_index)
3744 snat_main_t *sm = &snat_main;
3745 snat_session_key_t key;
3746 clib_bihash_kv_8_8_t kv, value;
3748 snat_main_per_thread_data_t *tsm;
3750 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3752 key.addr.as_u32 = out_addr->as_u32;
3753 key.port = out_port;
3754 key.protocol = proto;
3755 key.fib_index = fib_index;
3756 kv.key = key.as_u64;
3757 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3760 s = pool_elt_at_index (tsm->sessions, value.value);
3761 s->total_pkts = total_pkts;
3762 s->total_bytes = total_bytes;
3766 nat_ha_sadd_ed_cb (ip4_address_t * in_addr, u16 in_port,
3767 ip4_address_t * out_addr, u16 out_port,
3768 ip4_address_t * eh_addr, u16 eh_port,
3769 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3770 u32 fib_index, u16 flags, u32 thread_index)
3772 snat_main_t *sm = &snat_main;
3773 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
3774 snat_session_key_t key;
3776 clib_bihash_kv_16_8_t kv;
3777 vlib_main_t *vm = vlib_get_main ();
3778 f64 now = vlib_time_now (vm);
3779 nat_outside_fib_t *outside_fib;
3780 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3781 fib_prefix_t pfx = {
3782 .fp_proto = FIB_PROTOCOL_IP4,
3785 .ip4.as_u32 = eh_addr->as_u32,
3789 key.addr.as_u32 = out_addr->as_u32;
3790 key.port = out_port;
3791 key.protocol = proto;
3793 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3795 if (nat_set_outside_address_and_port
3796 (sm->addresses, thread_index, &key))
3800 key.addr.as_u32 = ehn_addr->as_u32;
3801 key.port = ehn_port;
3802 if (flags & SNAT_SESSION_FLAG_TWICE_NAT)
3804 if (nat_set_outside_address_and_port
3805 (sm->twice_nat_addresses, thread_index, &key))
3809 s = nat_ed_session_alloc (sm, thread_index, now);
3813 s->last_heard = now;
3815 s->ext_host_nat_addr.as_u32 = s->ext_host_addr.as_u32 = eh_addr->as_u32;
3816 s->ext_host_nat_port = s->ext_host_port = eh_port;
3817 if (is_twice_nat_session (s))
3819 s->ext_host_nat_addr.as_u32 = ehn_addr->as_u32;
3820 s->ext_host_nat_port = ehn_port;
3822 switch (vec_len (sm->outside_fibs))
3825 key.fib_index = sm->outside_fib_index;
3828 key.fib_index = sm->outside_fibs[0].fib_index;
3832 vec_foreach (outside_fib, sm->outside_fibs)
3834 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3835 if (FIB_NODE_INDEX_INVALID != fei)
3837 if (fib_entry_get_resolving_interface (fei) != ~0)
3839 key.fib_index = outside_fib->fib_index;
3847 key.addr.as_u32 = out_addr->as_u32;
3848 key.port = out_port;
3850 kv.value = s - tsm->sessions;
3852 key.addr.as_u32 = in_addr->as_u32;
3854 key.fib_index = fib_index;
3857 make_ed_kv (in_addr, &s->ext_host_nat_addr,
3858 snat_proto_to_ip_proto (proto), fib_index, in_port,
3859 s->ext_host_nat_port, s - tsm->sessions, &kv);
3860 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &kv, 1))
3861 nat_elog_warn ("in2out key add failed");
3863 make_ed_kv (out_addr, eh_addr, snat_proto_to_ip_proto (proto),
3864 s->out2in.fib_index, out_port, eh_port, s - tsm->sessions, &kv);
3865 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &kv, 1))
3866 nat_elog_warn ("out2in key add failed");
3870 nat_ha_sdel_ed_cb (ip4_address_t * out_addr, u16 out_port,
3871 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3872 u32 fib_index, u32 ti)
3874 snat_main_t *sm = &snat_main;
3875 clib_bihash_kv_16_8_t kv, value;
3878 snat_main_per_thread_data_t *tsm;
3880 if (sm->num_workers > 1)
3882 sm->first_worker_index +
3883 (sm->workers[(clib_net_to_host_u16 (out_port) -
3884 1024) / sm->port_per_thread]);
3886 thread_index = sm->num_workers;
3887 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3889 make_ed_kv (out_addr, eh_addr, proto, fib_index, out_port, eh_port, ~0ULL,
3891 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3894 s = pool_elt_at_index (tsm->sessions, value.value);
3895 nat_free_session_data (sm, s, thread_index, 1);
3896 nat44_delete_session (sm, s, thread_index);
3900 nat_ha_sref_ed_cb (ip4_address_t * out_addr, u16 out_port,
3901 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3902 u32 fib_index, u32 total_pkts, u64 total_bytes,
3905 snat_main_t *sm = &snat_main;
3906 clib_bihash_kv_16_8_t kv, value;
3908 snat_main_per_thread_data_t *tsm;
3910 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3912 make_ed_kv (out_addr, eh_addr, proto, fib_index, out_port, eh_port, ~0ULL,
3914 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3917 s = pool_elt_at_index (tsm->sessions, value.value);
3918 s->total_pkts = total_pkts;
3919 s->total_bytes = total_bytes;
3923 nat44_db_init (snat_main_per_thread_data_t * tsm)
3925 snat_main_t *sm = &snat_main;
3927 pool_alloc (tsm->sessions, sm->max_translations);
3928 pool_alloc (tsm->global_lru_pool, sm->max_translations);
3931 pool_get (tsm->global_lru_pool, head);
3932 tsm->global_lru_head_index = head - tsm->global_lru_pool;
3933 clib_dlist_init (tsm->global_lru_pool, tsm->global_lru_head_index);
3935 if (sm->endpoint_dependent)
3937 clib_bihash_init_16_8 (&tsm->in2out_ed, "in2out-ed",
3938 sm->translation_buckets,
3939 sm->translation_memory_size);
3940 clib_bihash_set_kvp_format_fn_16_8 (&tsm->in2out_ed,
3941 format_ed_session_kvp);
3942 clib_bihash_init_16_8 (&tsm->out2in_ed, "out2in-ed",
3943 sm->translation_buckets,
3944 sm->translation_memory_size);
3945 clib_bihash_set_kvp_format_fn_16_8 (&tsm->out2in_ed,
3946 format_ed_session_kvp);
3950 clib_bihash_init_8_8 (&tsm->in2out, "in2out",
3951 sm->translation_buckets,
3952 sm->translation_memory_size);
3953 clib_bihash_set_kvp_format_fn_8_8 (&tsm->in2out, format_session_kvp);
3954 clib_bihash_init_8_8 (&tsm->out2in, "out2in",
3955 sm->translation_buckets,
3956 sm->translation_memory_size);
3957 clib_bihash_set_kvp_format_fn_8_8 (&tsm->out2in, format_session_kvp);
3960 // TODO: resolve static mappings (put only to !ED)
3961 pool_alloc (tsm->list_pool, sm->max_translations);
3962 clib_bihash_init_8_8 (&tsm->user_hash, "users", sm->user_buckets,
3963 sm->user_memory_size);
3964 clib_bihash_set_kvp_format_fn_8_8 (&tsm->user_hash, format_user_kvp);
3968 nat44_db_free (snat_main_per_thread_data_t * tsm)
3970 snat_main_t *sm = &snat_main;
3972 pool_free (tsm->sessions);
3973 pool_free (tsm->global_lru_pool);
3975 if (sm->endpoint_dependent)
3977 clib_bihash_free_16_8 (&tsm->in2out_ed);
3978 clib_bihash_free_16_8 (&tsm->out2in_ed);
3982 clib_bihash_free_8_8 (&tsm->in2out);
3983 clib_bihash_free_8_8 (&tsm->out2in);
3986 // TODO: resolve static mappings (put only to !ED)
3987 pool_free (tsm->users);
3988 pool_free (tsm->list_pool);
3989 clib_bihash_free_8_8 (&tsm->user_hash);
3992 static clib_error_t *
3993 snat_config (vlib_main_t * vm, unformat_input_t * input)
3995 snat_main_t *sm = &snat_main;
3996 nat66_main_t *nm = &nat66_main;
3997 //dslite_main_t *dm = &dslite_main;
3998 snat_main_per_thread_data_t *tsm;
4000 u32 static_mapping_buckets = 1024;
4001 uword static_mapping_memory_size = 64 << 20;
4003 u32 nat64_bib_buckets = 1024;
4004 u32 nat64_bib_memory_size = 128 << 20;
4006 u32 nat64_st_buckets = 2048;
4007 uword nat64_st_memory_size = 256 << 20;
4009 u32 user_buckets = 128;
4010 uword user_memory_size = 64 << 20;
4011 u32 translation_buckets = 1024;
4012 uword translation_memory_size = 128 << 20;
4014 u32 max_translations_per_user = ~0;
4016 u32 outside_vrf_id = 0;
4017 u32 outside_ip6_vrf_id = 0;
4018 u32 inside_vrf_id = 0;
4019 u8 static_mapping_only = 0;
4020 u8 static_mapping_connection_tracking = 0;
4022 // configurable timeouts
4023 u32 udp_timeout = SNAT_UDP_TIMEOUT;
4024 u32 icmp_timeout = SNAT_ICMP_TIMEOUT;
4025 u32 tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
4026 u32 tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
4028 sm->deterministic = 0;
4030 sm->endpoint_dependent = 0;
4032 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
4035 (input, "translation hash buckets %d", &translation_buckets))
4037 else if (unformat (input, "udp timeout %d", &udp_timeout))
4039 else if (unformat (input, "icmp timeout %d", &icmp_timeout))
4041 else if (unformat (input, "tcp transitory timeout %d",
4042 &tcp_transitory_timeout));
4043 else if (unformat (input, "tcp established timeout %d",
4044 &tcp_established_timeout));
4045 else if (unformat (input, "translation hash memory %d",
4046 &translation_memory_size));
4047 else if (unformat (input, "user hash buckets %d", &user_buckets))
4049 else if (unformat (input, "user hash memory %d", &user_memory_size))
4051 else if (unformat (input, "max translations per user %d",
4052 &max_translations_per_user))
4054 else if (unformat (input, "outside VRF id %d", &outside_vrf_id))
4056 else if (unformat (input, "outside ip6 VRF id %d", &outside_ip6_vrf_id))
4058 else if (unformat (input, "inside VRF id %d", &inside_vrf_id))
4060 else if (unformat (input, "static mapping only"))
4062 static_mapping_only = 1;
4063 if (unformat (input, "connection tracking"))
4064 static_mapping_connection_tracking = 1;
4066 else if (unformat (input, "deterministic"))
4067 sm->deterministic = 1;
4068 else if (unformat (input, "nat64 bib hash buckets %d",
4069 &nat64_bib_buckets))
4071 else if (unformat (input, "nat64 bib hash memory %d",
4072 &nat64_bib_memory_size))
4075 if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
4077 else if (unformat (input, "nat64 st hash memory %d",
4078 &nat64_st_memory_size))
4080 else if (unformat (input, "out2in dpo"))
4082 //else if (unformat (input, "dslite ce"))
4083 //dslite_set_ce (dm, 1);
4084 else if (unformat (input, "endpoint-dependent"))
4085 sm->endpoint_dependent = 1;
4087 return clib_error_return (0, "unknown input '%U'",
4088 format_unformat_error, input);
4091 if (sm->deterministic && sm->endpoint_dependent)
4092 return clib_error_return (0,
4093 "deterministic and endpoint-dependent modes are mutually exclusive");
4095 if (static_mapping_only && (sm->deterministic || sm->endpoint_dependent))
4096 return clib_error_return (0,
4097 "static mapping only mode available only for simple nat");
4099 if (sm->out2in_dpo && (sm->deterministic || sm->endpoint_dependent))
4100 return clib_error_return (0,
4101 "out2in dpo mode available only for simple nat");
4103 /* optionally configurable timeouts for testing purposes */
4104 sm->udp_timeout = udp_timeout;
4105 sm->tcp_transitory_timeout = tcp_transitory_timeout;
4106 sm->tcp_established_timeout = tcp_established_timeout;
4107 sm->icmp_timeout = icmp_timeout;
4109 sm->user_buckets = user_buckets;
4110 sm->user_memory_size = user_memory_size;
4112 sm->translation_buckets = translation_buckets;
4113 sm->translation_memory_size = translation_memory_size;
4114 /* do not exceed load factor 10 */
4115 sm->max_translations = 10 * translation_buckets;
4116 vec_add1 (sm->max_translations_per_fib, sm->max_translations);
4118 sm->max_translations_per_user = max_translations_per_user == ~0 ?
4119 sm->max_translations : max_translations_per_user;
4121 sm->outside_vrf_id = outside_vrf_id;
4122 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
4125 nm->outside_vrf_id = outside_ip6_vrf_id;
4126 nm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6,
4129 sm->inside_vrf_id = inside_vrf_id;
4130 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
4133 sm->static_mapping_only = static_mapping_only;
4134 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
4136 nat64_set_hash (nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
4137 nat64_st_memory_size);
4139 if (sm->deterministic)
4141 sm->in2out_node_index = snat_det_in2out_node.index;
4142 sm->in2out_output_node_index = ~0;
4143 sm->out2in_node_index = snat_det_out2in_node.index;
4144 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
4145 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
4149 if (sm->endpoint_dependent)
4151 sm->worker_in2out_cb = nat44_ed_get_worker_in2out_cb;
4152 sm->worker_out2in_cb = nat44_ed_get_worker_out2in_cb;
4154 sm->handoff_out2in_index = nat_pre_out2in_node.index;
4155 sm->handoff_in2out_index = nat_pre_in2out_node.index;
4156 sm->handoff_in2out_output_index = nat44_ed_in2out_output_node.index;
4158 sm->in2out_node_index = nat44_ed_in2out_node.index;
4159 sm->in2out_output_node_index = nat44_ed_in2out_output_node.index;
4160 sm->out2in_node_index = nat44_ed_out2in_node.index;
4162 sm->icmp_match_in2out_cb = icmp_match_in2out_ed;
4163 sm->icmp_match_out2in_cb = icmp_match_out2in_ed;
4164 nat_affinity_init (vm);
4165 nat_ha_init (vm, nat_ha_sadd_ed_cb, nat_ha_sdel_ed_cb,
4170 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
4171 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
4173 sm->handoff_out2in_index = snat_out2in_node.index;
4174 sm->handoff_in2out_index = snat_in2out_node.index;
4175 sm->handoff_in2out_output_index = snat_in2out_output_node.index;
4177 sm->in2out_node_index = snat_in2out_node.index;
4178 sm->in2out_output_node_index = snat_in2out_output_node.index;
4179 sm->out2in_node_index = snat_out2in_node.index;
4180 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
4181 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
4182 nat_ha_init (vm, nat_ha_sadd_cb, nat_ha_sdel_cb, nat_ha_sref_cb);
4184 if (!static_mapping_only ||
4185 (static_mapping_only && static_mapping_connection_tracking))
4188 vec_foreach (tsm, sm->per_thread_data)
4190 nat44_db_init (tsm);
4196 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
4197 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
4199 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
4200 "static_mapping_by_local", static_mapping_buckets,
4201 static_mapping_memory_size);
4202 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_local,
4203 format_static_mapping_kvp);
4205 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
4206 "static_mapping_by_external",
4207 static_mapping_buckets,
4208 static_mapping_memory_size);
4209 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_external,
4210 format_static_mapping_kvp);
4216 VLIB_CONFIG_FUNCTION (snat_config, "nat");
4219 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
4222 ip4_address_t * address,
4224 u32 if_address_index, u32 is_delete)
4226 snat_main_t *sm = &snat_main;
4227 snat_static_map_resolve_t *rp;
4228 snat_static_mapping_t *m;
4229 snat_session_key_t m_key;
4230 clib_bihash_kv_8_8_t kv, value;
4232 ip4_address_t l_addr;
4234 for (i = 0; i < vec_len (sm->to_resolve); i++)
4236 rp = sm->to_resolve + i;
4237 if (rp->addr_only == 0)
4239 if (rp->sw_if_index == sw_if_index)
4246 m_key.addr.as_u32 = address->as_u32;
4247 m_key.port = rp->addr_only ? 0 : rp->e_port;
4248 m_key.protocol = rp->addr_only ? 0 : rp->proto;
4249 m_key.fib_index = sm->outside_fib_index;
4250 kv.key = m_key.as_u64;
4251 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
4254 m = pool_elt_at_index (sm->static_mappings, value.value);
4258 /* Don't trip over lease renewal, static config */
4268 /* Indetity mapping? */
4269 if (rp->l_addr.as_u32 == 0)
4270 l_addr.as_u32 = address[0].as_u32;
4272 l_addr.as_u32 = rp->l_addr.as_u32;
4273 /* Add the static mapping */
4274 rv = snat_add_static_mapping (l_addr,
4279 rp->addr_only, ~0 /* sw_if_index */ ,
4280 rp->proto, !is_delete, rp->twice_nat,
4281 rp->out2in_only, rp->tag, rp->identity_nat);
4283 nat_elog_notice_X1 ("snat_add_static_mapping returned %d", "i4", rv);
4287 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
4290 ip4_address_t * address,
4292 u32 if_address_index, u32 is_delete)
4294 snat_main_t *sm = &snat_main;
4295 snat_static_map_resolve_t *rp;
4296 ip4_address_t l_addr;
4300 snat_address_t *addresses = sm->addresses;
4302 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices); i++)
4304 if (sw_if_index == sm->auto_add_sw_if_indices[i])
4308 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices_twice_nat); i++)
4311 addresses = sm->twice_nat_addresses;
4312 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
4321 /* Don't trip over lease renewal, static config */
4322 for (j = 0; j < vec_len (addresses); j++)
4323 if (addresses[j].addr.as_u32 == address->as_u32)
4326 (void) snat_add_address (sm, address, ~0, twice_nat);
4327 /* Scan static map resolution vector */
4328 for (j = 0; j < vec_len (sm->to_resolve); j++)
4330 rp = sm->to_resolve + j;
4333 /* On this interface? */
4334 if (rp->sw_if_index == sw_if_index)
4336 /* Indetity mapping? */
4337 if (rp->l_addr.as_u32 == 0)
4338 l_addr.as_u32 = address[0].as_u32;
4340 l_addr.as_u32 = rp->l_addr.as_u32;
4341 /* Add the static mapping */
4342 rv = snat_add_static_mapping (l_addr,
4348 ~0 /* sw_if_index */ ,
4350 rp->is_add, rp->twice_nat,
4351 rp->out2in_only, rp->tag,
4354 nat_elog_notice_X1 ("snat_add_static_mapping returned %d",
4362 (void) snat_del_address (sm, address[0], 1, twice_nat);
4369 snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
4372 ip4_main_t *ip4_main = sm->ip4_main;
4373 ip4_address_t *first_int_addr;
4374 snat_static_map_resolve_t *rp;
4375 u32 *indices_to_delete = 0;
4377 u32 *auto_add_sw_if_indices =
4379 auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
4381 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0 /* just want the address */
4384 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
4386 if (auto_add_sw_if_indices[i] == sw_if_index)
4390 /* if have address remove it */
4392 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
4395 for (j = 0; j < vec_len (sm->to_resolve); j++)
4397 rp = sm->to_resolve + j;
4398 if (rp->sw_if_index == sw_if_index)
4399 vec_add1 (indices_to_delete, j);
4401 if (vec_len (indices_to_delete))
4403 for (j = vec_len (indices_to_delete) - 1; j >= 0; j--)
4404 vec_del1 (sm->to_resolve, j);
4405 vec_free (indices_to_delete);
4409 vec_del1 (sm->auto_add_sw_if_indices_twice_nat, i);
4411 vec_del1 (sm->auto_add_sw_if_indices, i);
4414 return VNET_API_ERROR_VALUE_EXIST;
4421 return VNET_API_ERROR_NO_SUCH_ENTRY;
4423 /* add to the auto-address list */
4425 vec_add1 (sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
4427 vec_add1 (sm->auto_add_sw_if_indices, sw_if_index);
4429 /* If the address is already bound - or static - add it now */
4431 (void) snat_add_address (sm, first_int_addr, ~0, twice_nat);
4437 nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4438 snat_protocol_t proto, u32 vrf_id, int is_in)
4440 snat_main_per_thread_data_t *tsm;
4441 clib_bihash_kv_8_8_t kv, value;
4443 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4444 snat_session_key_t key;
4446 clib_bihash_8_8_t *t;
4448 if (sm->endpoint_dependent)
4449 return VNET_API_ERROR_UNSUPPORTED;
4451 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4452 if (sm->num_workers > 1)
4454 vec_elt_at_index (sm->per_thread_data,
4455 sm->worker_in2out_cb (&ip, fib_index, 0));
4457 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4459 key.addr.as_u32 = addr->as_u32;
4460 key.port = clib_host_to_net_u16 (port);
4461 key.protocol = proto;
4462 key.fib_index = fib_index;
4463 kv.key = key.as_u64;
4464 t = is_in ? &tsm->in2out : &tsm->out2in;
4465 if (!clib_bihash_search_8_8 (t, &kv, &value))
4467 if (pool_is_free_index (tsm->sessions, value.value))
4468 return VNET_API_ERROR_UNSPECIFIED;
4470 s = pool_elt_at_index (tsm->sessions, value.value);
4471 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4472 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4476 return VNET_API_ERROR_NO_SUCH_ENTRY;
4480 nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4481 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
4482 u32 vrf_id, int is_in)
4485 clib_bihash_16_8_t *t;
4486 clib_bihash_kv_16_8_t kv, value;
4487 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4489 snat_main_per_thread_data_t *tsm;
4491 if (!sm->endpoint_dependent)
4492 return VNET_API_ERROR_FEATURE_DISABLED;
4494 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4495 if (sm->num_workers > 1)
4497 vec_elt_at_index (sm->per_thread_data,
4498 sm->worker_in2out_cb (&ip, fib_index, 0));
4500 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4502 t = is_in ? &tsm->in2out_ed : &tsm->out2in_ed;
4503 make_ed_kv (addr, eh_addr, proto, fib_index, clib_host_to_net_u16 (port),
4504 clib_host_to_net_u16 (eh_port), ~0ULL, &kv);
4505 if (clib_bihash_search_16_8 (t, &kv, &value))
4507 return VNET_API_ERROR_NO_SUCH_ENTRY;
4510 if (pool_is_free_index (tsm->sessions, value.value))
4511 return VNET_API_ERROR_UNSPECIFIED;
4512 s = pool_elt_at_index (tsm->sessions, value.value);
4513 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4514 nat44_ed_delete_session (sm, s, tsm - sm->per_thread_data, 1);
4519 nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset, u16 psid_length)
4521 snat_main_t *sm = &snat_main;
4523 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_MAPE;
4524 sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
4526 sm->psid_offset = psid_offset;
4527 sm->psid_length = psid_length;
4531 nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port)
4533 snat_main_t *sm = &snat_main;
4535 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_RANGE;
4536 sm->alloc_addr_and_port = nat_alloc_addr_and_port_range;
4537 sm->start_port = start_port;
4538 sm->end_port = end_port;
4542 nat_set_alloc_addr_and_port_default (void)
4544 snat_main_t *sm = &snat_main;
4546 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
4547 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
4550 VLIB_NODE_FN (nat_default_node) (vlib_main_t * vm,
4551 vlib_node_runtime_t * node,
4552 vlib_frame_t * frame)
4558 VLIB_REGISTER_NODE (nat_default_node) = {
4559 .name = "nat-default",
4560 .vector_size = sizeof (u32),
4562 .type = VLIB_NODE_TYPE_INTERNAL,
4564 .n_next_nodes = NAT_N_NEXT,
4566 [NAT_NEXT_DROP] = "error-drop",
4567 [NAT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
4568 [NAT_NEXT_IN2OUT_PRE] = "nat-pre-in2out",
4569 [NAT_NEXT_OUT2IN_PRE] = "nat-pre-out2in",
4570 [NAT_NEXT_IN2OUT_ED_FAST_PATH] = "nat44-ed-in2out",
4571 [NAT_NEXT_IN2OUT_ED_SLOW_PATH] = "nat44-ed-in2out-slowpath",
4572 [NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH] = "nat44-ed-in2out-output-slowpath",
4573 [NAT_NEXT_OUT2IN_ED_FAST_PATH] = "nat44-ed-out2in",
4574 [NAT_NEXT_OUT2IN_ED_SLOW_PATH] = "nat44-ed-out2in-slowpath",
4580 * fd.io coding-style-patch-verification: ON
4583 * eval: (c-set-style "gnu")