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;
202 nat_ed_ses_key_t ed_key;
203 clib_bihash_kv_16_8_t ed_kv;
204 snat_main_per_thread_data_t *tsm =
205 vec_elt_at_index (sm->per_thread_data, thread_index);
207 if (is_fwd_bypass_session (s))
209 if (snat_is_unk_proto_session (s))
211 ed_key.proto = s->in2out.port;
217 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
218 ed_key.l_port = s->in2out.port;
219 ed_key.r_port = s->ext_host_port;
221 ed_key.l_addr = s->in2out.addr;
222 ed_key.r_addr = s->ext_host_addr;
223 ed_key.fib_index = 0;
224 ed_kv.key[0] = ed_key.as_u64[0];
225 ed_kv.key[1] = ed_key.as_u64[1];
226 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
227 nat_elog_warn ("in2out_ed key del failed");
231 /* session lookup tables */
232 if (is_ed_session (s))
234 if (is_affinity_sessions (s))
235 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
236 s->in2out.protocol, s->out2in.port);
237 ed_key.l_addr = s->out2in.addr;
238 ed_key.r_addr = s->ext_host_addr;
239 ed_key.fib_index = s->out2in.fib_index;
240 if (snat_is_unk_proto_session (s))
242 ed_key.proto = s->in2out.port;
248 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
249 ed_key.l_port = s->out2in.port;
250 ed_key.r_port = s->ext_host_port;
252 ed_kv.key[0] = ed_key.as_u64[0];
253 ed_kv.key[1] = ed_key.as_u64[1];
254 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &ed_kv, 0))
255 nat_elog_warn ("out2in_ed key del failed");
256 ed_key.l_addr = s->in2out.addr;
257 ed_key.fib_index = s->in2out.fib_index;
258 if (!snat_is_unk_proto_session (s))
259 ed_key.l_port = s->in2out.port;
260 if (is_twice_nat_session (s))
262 ed_key.r_addr = s->ext_host_nat_addr;
263 ed_key.r_port = s->ext_host_nat_port;
265 ed_kv.key[0] = ed_key.as_u64[0];
266 ed_kv.key[1] = ed_key.as_u64[1];
267 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
268 nat_elog_warn ("in2out_ed key del failed");
271 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
272 &s->in2out.addr, s->in2out.port,
273 &s->ext_host_nat_addr, s->ext_host_nat_port,
274 &s->out2in.addr, s->out2in.port,
275 &s->ext_host_addr, s->ext_host_port,
276 s->in2out.protocol, is_twice_nat_session (s));
280 kv.key = s->in2out.as_u64;
281 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0))
282 nat_elog_warn ("in2out key del failed");
283 kv.key = s->out2in.as_u64;
284 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0))
285 nat_elog_warn ("out2in key del failed");
288 nat_syslog_nat44_apmdel (s->user_index, s->in2out.fib_index,
289 &s->in2out.addr, s->in2out.port,
290 &s->out2in.addr, s->out2in.port,
294 if (snat_is_unk_proto_session (s))
300 snat_ipfix_logging_nat44_ses_delete (thread_index,
301 s->in2out.addr.as_u32,
302 s->out2in.addr.as_u32,
306 s->in2out.fib_index);
308 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
309 s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
313 /* Twice NAT address and port for external host */
314 if (is_twice_nat_session (s))
316 key.protocol = s->in2out.protocol;
317 key.port = s->ext_host_nat_port;
318 key.addr.as_u32 = s->ext_host_nat_addr.as_u32;
319 snat_free_outside_address_and_port (sm->twice_nat_addresses,
323 if (snat_is_session_static (s))
326 snat_free_outside_address_and_port (sm->addresses, thread_index,
331 nat44_free_session_data (snat_main_t * sm, snat_session_t * s,
332 u32 thread_index, u8 is_ha)
334 snat_session_key_t key;
335 nat_ed_ses_key_t ed_key;
336 clib_bihash_kv_16_8_t ed_kv;
337 snat_main_per_thread_data_t *tsm =
338 vec_elt_at_index (sm->per_thread_data, thread_index);
340 if (is_fwd_bypass_session (s))
342 if (snat_is_unk_proto_session (s))
344 ed_key.proto = s->in2out.port;
350 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
351 ed_key.l_port = s->in2out.port;
352 ed_key.r_port = s->ext_host_port;
355 ed_key.l_addr = s->in2out.addr;
356 ed_key.r_addr = s->ext_host_addr;
357 ed_key.fib_index = 0;
358 ed_kv.key[0] = ed_key.as_u64[0];
359 ed_kv.key[1] = ed_key.as_u64[1];
362 (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0)))
363 nat_elog_warn ("in2out_ed key del failed");
367 /* session lookup tables */
368 if (is_affinity_sessions (s))
369 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
370 s->in2out.protocol, s->out2in.port);
371 ed_key.l_addr = s->out2in.addr;
372 ed_key.r_addr = s->ext_host_addr;
373 ed_key.fib_index = s->out2in.fib_index;
374 if (snat_is_unk_proto_session (s))
376 ed_key.proto = s->in2out.port;
382 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
383 ed_key.l_port = s->out2in.port;
384 ed_key.r_port = s->ext_host_port;
386 ed_kv.key[0] = ed_key.as_u64[0];
387 ed_kv.key[1] = ed_key.as_u64[1];
389 if (PREDICT_FALSE (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &ed_kv, 0)))
390 nat_elog_warn ("out2in_ed key del failed");
392 ed_key.l_addr = s->in2out.addr;
393 ed_key.fib_index = s->in2out.fib_index;
395 if (!snat_is_unk_proto_session (s))
396 ed_key.l_port = s->in2out.port;
398 if (is_twice_nat_session (s))
400 ed_key.r_addr = s->ext_host_nat_addr;
401 ed_key.r_port = s->ext_host_nat_port;
404 ed_kv.key[0] = ed_key.as_u64[0];
405 ed_kv.key[1] = ed_key.as_u64[1];
407 if (PREDICT_FALSE (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0)))
408 nat_elog_warn ("in2out_ed key del failed");
412 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
413 &s->in2out.addr, s->in2out.port,
414 &s->ext_host_nat_addr, s->ext_host_nat_port,
415 &s->out2in.addr, s->out2in.port,
416 &s->ext_host_addr, s->ext_host_port,
417 s->in2out.protocol, is_twice_nat_session (s));
420 if (snat_is_unk_proto_session (s))
426 snat_ipfix_logging_nat44_ses_delete (thread_index,
427 s->in2out.addr.as_u32,
428 s->out2in.addr.as_u32,
432 s->in2out.fib_index);
433 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
434 s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
438 /* Twice NAT address and port for external host */
439 if (is_twice_nat_session (s))
441 key.protocol = s->in2out.protocol;
442 key.port = s->ext_host_nat_port;
443 key.addr.as_u32 = s->ext_host_nat_addr.as_u32;
444 snat_free_outside_address_and_port (sm->twice_nat_addresses,
448 if (snat_is_session_static (s))
451 // should be called for every dynamic session
452 snat_free_outside_address_and_port (sm->addresses, thread_index,
458 nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr, u32 fib_index,
462 snat_user_key_t user_key;
463 clib_bihash_kv_8_8_t kv, value;
464 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
465 dlist_elt_t *per_user_list_head_elt;
467 user_key.addr.as_u32 = addr->as_u32;
468 user_key.fib_index = fib_index;
469 kv.key = user_key.as_u64;
471 /* Ever heard of the "user" = src ip4 address before? */
472 if (clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
474 /* no, make a new one */
475 pool_get (tsm->users, u);
476 clib_memset (u, 0, sizeof (*u));
478 u->addr.as_u32 = addr->as_u32;
479 u->fib_index = fib_index;
481 pool_get (tsm->list_pool, per_user_list_head_elt);
483 u->sessions_per_user_list_head_index = per_user_list_head_elt -
486 clib_dlist_init (tsm->list_pool, u->sessions_per_user_list_head_index);
488 kv.value = u - tsm->users;
491 if (clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 1))
493 nat_elog_warn ("user_hash key add failed");
494 nat44_delete_user_with_no_session (sm, u, thread_index);
498 vlib_set_simple_counter (&sm->total_users, thread_index, 0,
499 pool_elts (tsm->users));
503 u = pool_elt_at_index (tsm->users, value.value);
510 nat_session_alloc_or_recycle (snat_main_t * sm, snat_user_t * u,
511 u32 thread_index, f64 now)
514 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
515 u32 oldest_per_user_translation_list_index, session_index;
516 dlist_elt_t *oldest_per_user_translation_list_elt;
517 dlist_elt_t *per_user_translation_list_elt;
519 /* Over quota? Recycle the least recently used translation */
520 if ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user)
522 oldest_per_user_translation_list_index =
523 clib_dlist_remove_head (tsm->list_pool,
524 u->sessions_per_user_list_head_index);
526 ASSERT (oldest_per_user_translation_list_index != ~0);
528 /* Add it back to the end of the LRU list */
529 clib_dlist_addtail (tsm->list_pool,
530 u->sessions_per_user_list_head_index,
531 oldest_per_user_translation_list_index);
532 /* Get the list element */
533 oldest_per_user_translation_list_elt =
534 pool_elt_at_index (tsm->list_pool,
535 oldest_per_user_translation_list_index);
537 /* Get the session index from the list element */
538 session_index = oldest_per_user_translation_list_elt->value;
540 /* Get the session */
541 s = pool_elt_at_index (tsm->sessions, session_index);
542 nat_free_session_data (sm, s, thread_index, 0);
543 if (snat_is_session_static (s))
544 u->nstaticsessions--;
551 s->ext_host_addr.as_u32 = 0;
552 s->ext_host_port = 0;
553 s->ext_host_nat_addr.as_u32 = 0;
554 s->ext_host_nat_port = 0;
558 pool_get (tsm->sessions, s);
559 clib_memset (s, 0, sizeof (*s));
561 /* Create list elts */
562 pool_get (tsm->list_pool, per_user_translation_list_elt);
563 clib_dlist_init (tsm->list_pool,
564 per_user_translation_list_elt - tsm->list_pool);
566 per_user_translation_list_elt->value = s - tsm->sessions;
567 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
568 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
570 clib_dlist_addtail (tsm->list_pool,
571 s->per_user_list_head_index,
572 per_user_translation_list_elt - tsm->list_pool);
574 dlist_elt_t *global_lru_list_elt;
575 pool_get (tsm->global_lru_pool, global_lru_list_elt);
576 global_lru_list_elt->value = s - tsm->sessions;
577 s->global_lru_index = global_lru_list_elt - tsm->global_lru_pool;
578 clib_dlist_addtail (tsm->global_lru_pool, tsm->global_lru_head_index,
579 s->global_lru_index);
580 s->last_lru_update = now;
582 s->user_index = u - tsm->users;
583 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
584 pool_elts (tsm->sessions));
587 s->ha_last_refreshed = now;
593 nat_global_lru_free_one (snat_main_t * sm, int thread_index, f64 now)
595 snat_session_t *s = NULL;
596 dlist_elt_t *oldest_elt;
597 u64 sess_timeout_time;
599 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
600 oldest_index = clib_dlist_remove_head (tsm->global_lru_pool,
601 tsm->global_lru_head_index);
602 if (~0 != oldest_index)
604 oldest_elt = pool_elt_at_index (tsm->global_lru_pool, oldest_index);
605 s = pool_elt_at_index (tsm->sessions, oldest_elt->value);
608 s->last_heard + (f64) nat44_session_get_timeout (sm, s);
609 if (now >= sess_timeout_time
610 || (s->tcp_close_timestamp && now >= s->tcp_close_timestamp))
612 nat_free_session_data (sm, s, thread_index, 0);
613 nat44_ed_delete_session (sm, s, thread_index, 0);
618 clib_dlist_addhead (tsm->global_lru_pool,
619 tsm->global_lru_head_index, oldest_index);
626 nat_ed_session_alloc (snat_main_t * sm, snat_user_t * u, u32 thread_index,
629 snat_session_t *s = NULL;
630 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
632 dlist_elt_t *oldest_elt;
633 u64 sess_timeout_time;
637 if (PREDICT_FALSE (!(u->nsessions) && !(u->nstaticsessions)))
642 ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user))
644 nat_elog_addr (SNAT_LOG_WARNING, "[warn] max translations per user",
645 clib_net_to_host_u32 (u->addr.as_u32));
646 snat_ipfix_logging_max_entries_per_user (thread_index,
647 sm->max_translations_per_user,
652 /* first try to reuse an expired session from this ip */
654 clib_dlist_remove_head (tsm->list_pool,
655 u->sessions_per_user_list_head_index);
656 oldest_elt = pool_elt_at_index (tsm->list_pool, oldest_index);
657 s = pool_elt_at_index (tsm->sessions, oldest_elt->value);
659 sess_timeout_time = s->last_heard + (f64) nat44_session_get_timeout (sm, s);
660 if (now >= sess_timeout_time ||
661 (s->tcp_close_timestamp && now >= s->tcp_close_timestamp))
664 clib_dlist_addtail (tsm->list_pool,
665 u->sessions_per_user_list_head_index, oldest_index);
666 s = nat44_session_reuse_old (sm, u, s, thread_index, now);
667 s->last_lru_update = now;
671 clib_dlist_addhead (tsm->list_pool,
672 u->sessions_per_user_list_head_index, oldest_index);
679 nat_global_lru_free_one (sm, thread_index, now);
680 s = nat44_session_alloc_new (tsm, u, now);
681 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
682 pool_elts (tsm->sessions));
688 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
691 fib_prefix_t prefix = {
693 .fp_proto = FIB_PROTOCOL_IP4,
695 .ip4.as_u32 = addr->as_u32,
698 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
701 fib_table_entry_update_one_path (fib_index,
704 (FIB_ENTRY_FLAG_CONNECTED |
705 FIB_ENTRY_FLAG_LOCAL |
706 FIB_ENTRY_FLAG_EXCLUSIVE),
710 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
712 fib_table_entry_delete (fib_index, &prefix, nat_fib_src_low);
716 snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
721 vlib_thread_main_t *tm = vlib_get_thread_main ();
723 if (twice_nat && !sm->endpoint_dependent)
724 return VNET_API_ERROR_FEATURE_DISABLED;
726 /* Check if address already exists */
728 vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
730 if (ap->addr.as_u32 == addr->as_u32)
731 return VNET_API_ERROR_VALUE_EXIST;
736 vec_add2 (sm->twice_nat_addresses, ap, 1);
738 vec_add2 (sm->addresses, ap, 1);
743 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
747 #define _(N, i, n, s) \
748 clib_memset(ap->busy_##n##_port_refcounts, 0, sizeof(ap->busy_##n##_port_refcounts));\
749 ap->busy_##n##_ports = 0; \
750 ap->busy_##n##_ports_per_thread = 0;\
751 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
752 foreach_snat_protocol
757 /* Add external address to FIB */
759 pool_foreach (i, sm->interfaces,
761 if (nat_interface_is_inside(i) || sm->out2in_dpo)
764 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
767 pool_foreach (i, sm->output_feature_interfaces,
769 if (nat_interface_is_inside(i) || sm->out2in_dpo)
772 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
781 is_snat_address_used_in_static_mapping (snat_main_t * sm, ip4_address_t addr)
783 snat_static_mapping_t *m;
785 pool_foreach (m, sm->static_mappings,
787 if (is_addr_only_static_mapping (m) ||
788 is_out2in_only_static_mapping (m) ||
789 is_identity_static_mapping (m))
791 if (m->external_addr.as_u32 == addr.as_u32)
800 snat_add_static_mapping_when_resolved (snat_main_t * sm,
801 ip4_address_t l_addr,
806 snat_protocol_t proto,
807 int addr_only, int is_add, u8 * tag,
808 int twice_nat, int out2in_only,
811 snat_static_map_resolve_t *rp;
813 vec_add2 (sm->to_resolve, rp, 1);
814 rp->l_addr.as_u32 = l_addr.as_u32;
816 rp->sw_if_index = sw_if_index;
820 rp->addr_only = addr_only;
822 rp->twice_nat = twice_nat;
823 rp->out2in_only = out2in_only;
824 rp->identity_nat = identity_nat;
825 rp->tag = vec_dup (tag);
829 get_thread_idx_by_port (u16 e_port)
831 snat_main_t *sm = &snat_main;
832 u32 thread_idx = sm->num_workers;
833 if (sm->num_workers > 1)
836 sm->first_worker_index +
837 sm->workers[(e_port - 1024) / sm->port_per_thread];
843 snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
844 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
845 u32 sw_if_index, snat_protocol_t proto, int is_add,
846 twice_nat_type_t twice_nat, u8 out2in_only, u8 * tag,
849 snat_main_t *sm = &snat_main;
850 snat_static_mapping_t *m;
851 snat_session_key_t m_key;
852 clib_bihash_kv_8_8_t kv, value;
853 snat_address_t *a = 0;
855 snat_interface_t *interface;
857 snat_main_per_thread_data_t *tsm;
858 snat_user_key_t u_key;
860 dlist_elt_t *head, *elt;
861 u32 elt_index, head_index;
865 snat_static_map_resolve_t *rp, *rp_match = 0;
866 nat44_lb_addr_port_t *local;
869 if (!sm->endpoint_dependent)
871 if (twice_nat || out2in_only)
872 return VNET_API_ERROR_FEATURE_DISABLED;
875 /* If the external address is a specific interface address */
876 if (sw_if_index != ~0)
878 ip4_address_t *first_int_addr;
880 for (i = 0; i < vec_len (sm->to_resolve); i++)
882 rp = sm->to_resolve + i;
883 if (rp->sw_if_index != sw_if_index ||
884 rp->l_addr.as_u32 != l_addr.as_u32 ||
885 rp->vrf_id != vrf_id || rp->addr_only != addr_only)
890 if ((rp->l_port != l_port && rp->e_port != e_port)
891 || rp->proto != proto)
899 /* Might be already set... */
900 first_int_addr = ip4_interface_first_address
901 (sm->ip4_main, sw_if_index, 0 /* just want the address */ );
906 return VNET_API_ERROR_VALUE_EXIST;
908 snat_add_static_mapping_when_resolved
909 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
910 addr_only, is_add, tag, twice_nat, out2in_only, identity_nat);
912 /* DHCP resolution required? */
913 if (first_int_addr == 0)
919 e_addr.as_u32 = first_int_addr->as_u32;
920 /* Identity mapping? */
921 if (l_addr.as_u32 == 0)
922 l_addr.as_u32 = e_addr.as_u32;
928 return VNET_API_ERROR_NO_SUCH_ENTRY;
930 vec_del1 (sm->to_resolve, i);
934 e_addr.as_u32 = first_int_addr->as_u32;
935 /* Identity mapping? */
936 if (l_addr.as_u32 == 0)
937 l_addr.as_u32 = e_addr.as_u32;
945 m_key.port = addr_only ? 0 : e_port;
946 m_key.protocol = addr_only ? 0 : proto;
948 kv.key = m_key.as_u64;
949 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
952 m = pool_elt_at_index (sm->static_mappings, value.value);
958 if (is_identity_static_mapping (m))
961 pool_foreach (local, m->locals,
963 if (local->vrf_id == vrf_id)
964 return VNET_API_ERROR_VALUE_EXIST;
967 pool_get (m->locals, local);
968 local->vrf_id = vrf_id;
970 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
972 m_key.addr = m->local_addr;
973 m_key.port = m->local_port;
974 m_key.protocol = m->proto;
975 m_key.fib_index = local->fib_index;
976 kv.key = m_key.as_u64;
977 kv.value = m - sm->static_mappings;
978 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
982 return VNET_API_ERROR_VALUE_EXIST;
985 if (twice_nat && addr_only)
986 return VNET_API_ERROR_UNSUPPORTED;
988 /* Convert VRF id to FIB index */
991 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
993 /* If not specified use inside VRF id from SNAT plugin startup config */
996 fib_index = sm->inside_fib_index;
997 vrf_id = sm->inside_vrf_id;
998 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1001 if (!(out2in_only || identity_nat))
1003 m_key.addr = l_addr;
1004 m_key.port = addr_only ? 0 : l_port;
1005 m_key.protocol = addr_only ? 0 : proto;
1006 m_key.fib_index = fib_index;
1007 kv.key = m_key.as_u64;
1008 if (!clib_bihash_search_8_8
1009 (&sm->static_mapping_by_local, &kv, &value))
1010 return VNET_API_ERROR_VALUE_EXIST;
1013 /* Find external address in allocated addresses and reserve port for
1014 address and port pair mapping when dynamic translations enabled */
1015 if (!(addr_only || sm->static_mapping_only || out2in_only))
1017 for (i = 0; i < vec_len (sm->addresses); i++)
1019 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1021 a = sm->addresses + i;
1022 /* External port must be unused */
1025 #define _(N, j, n, s) \
1026 case SNAT_PROTOCOL_##N: \
1027 if (a->busy_##n##_port_refcounts[e_port]) \
1028 return VNET_API_ERROR_INVALID_VALUE; \
1029 ++a->busy_##n##_port_refcounts[e_port]; \
1030 if (e_port > 1024) \
1032 a->busy_##n##_ports++; \
1033 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1036 foreach_snat_protocol
1039 nat_elog_info ("unknown protocol");
1040 return VNET_API_ERROR_INVALID_VALUE_2;
1045 /* External address must be allocated */
1046 if (!a && (l_addr.as_u32 != e_addr.as_u32))
1048 if (sw_if_index != ~0)
1050 for (i = 0; i < vec_len (sm->to_resolve); i++)
1052 rp = sm->to_resolve + i;
1055 if (rp->sw_if_index != sw_if_index &&
1056 rp->l_addr.as_u32 != l_addr.as_u32 &&
1057 rp->vrf_id != vrf_id && rp->l_port != l_port &&
1058 rp->e_port != e_port && rp->proto != proto)
1061 vec_del1 (sm->to_resolve, i);
1065 return VNET_API_ERROR_NO_SUCH_ENTRY;
1069 pool_get (sm->static_mappings, m);
1070 clib_memset (m, 0, sizeof (*m));
1071 m->tag = vec_dup (tag);
1072 m->local_addr = l_addr;
1073 m->external_addr = e_addr;
1074 m->twice_nat = twice_nat;
1076 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1078 m->flags |= NAT_STATIC_MAPPING_FLAG_ADDR_ONLY;
1081 m->flags |= NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT;
1082 pool_get (m->locals, local);
1083 local->vrf_id = vrf_id;
1084 local->fib_index = fib_index;
1089 m->fib_index = fib_index;
1093 m->local_port = l_port;
1094 m->external_port = e_port;
1098 if (sm->num_workers > 1)
1101 .src_address = m->local_addr,
1103 vec_add1 (m->workers, sm->worker_in2out_cb (&ip, m->fib_index, 0));
1104 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1107 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1109 m_key.addr = m->local_addr;
1110 m_key.port = m->local_port;
1111 m_key.protocol = m->proto;
1112 m_key.fib_index = fib_index;
1113 kv.key = m_key.as_u64;
1114 kv.value = m - sm->static_mappings;
1116 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1118 m_key.addr = m->external_addr;
1119 m_key.port = m->external_port;
1120 m_key.fib_index = 0;
1121 kv.key = m_key.as_u64;
1122 kv.value = m - sm->static_mappings;
1123 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1);
1125 /* Delete dynamic sessions matching local address (+ local port) */
1126 if (!(sm->static_mapping_only))
1128 u_key.addr = m->local_addr;
1129 u_key.fib_index = m->fib_index;
1130 kv.key = u_key.as_u64;
1131 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1133 user_index = value.value;
1134 u = pool_elt_at_index (tsm->users, user_index);
1137 head_index = u->sessions_per_user_list_head_index;
1138 head = pool_elt_at_index (tsm->list_pool, head_index);
1139 elt_index = head->next;
1140 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1141 ses_index = elt->value;
1142 while (ses_index != ~0)
1144 s = pool_elt_at_index (tsm->sessions, ses_index);
1145 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1146 ses_index = elt->value;
1148 if (snat_is_session_static (s))
1152 && (clib_net_to_host_u16 (s->in2out.port) !=
1156 nat_free_session_data (sm, s,
1157 tsm - sm->per_thread_data, 0);
1158 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1160 if (!addr_only && !sm->endpoint_dependent)
1171 if (sw_if_index != ~0)
1174 return VNET_API_ERROR_NO_SUCH_ENTRY;
1180 vrf_id = sm->inside_vrf_id;
1183 pool_foreach (local, m->locals,
1185 if (local->vrf_id == vrf_id)
1186 find = local - m->locals;
1190 return VNET_API_ERROR_NO_SUCH_ENTRY;
1192 local = pool_elt_at_index (m->locals, find);
1193 fib_index = local->fib_index;
1194 pool_put (m->locals, local);
1197 fib_index = m->fib_index;
1199 /* Free external address port */
1200 if (!(addr_only || sm->static_mapping_only || out2in_only))
1202 for (i = 0; i < vec_len (sm->addresses); i++)
1204 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1206 a = sm->addresses + i;
1209 #define _(N, j, n, s) \
1210 case SNAT_PROTOCOL_##N: \
1211 --a->busy_##n##_port_refcounts[e_port]; \
1212 if (e_port > 1024) \
1214 a->busy_##n##_ports--; \
1215 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1218 foreach_snat_protocol
1221 nat_elog_info ("unknown protocol");
1222 return VNET_API_ERROR_INVALID_VALUE_2;
1229 if (sm->num_workers > 1)
1230 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1232 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1234 m_key.addr = m->local_addr;
1235 m_key.port = m->local_port;
1236 m_key.protocol = m->proto;
1237 m_key.fib_index = fib_index;
1238 kv.key = m_key.as_u64;
1240 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0);
1242 /* Delete session(s) for static mapping if exist */
1243 if (!(sm->static_mapping_only) ||
1244 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
1246 u_key.addr = m->local_addr;
1247 u_key.fib_index = fib_index;
1248 kv.key = u_key.as_u64;
1249 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1251 user_index = value.value;
1252 u = pool_elt_at_index (tsm->users, user_index);
1253 if (u->nstaticsessions)
1255 head_index = u->sessions_per_user_list_head_index;
1256 head = pool_elt_at_index (tsm->list_pool, head_index);
1257 elt_index = head->next;
1258 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1259 ses_index = elt->value;
1260 while (ses_index != ~0)
1262 s = pool_elt_at_index (tsm->sessions, ses_index);
1263 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1264 ses_index = elt->value;
1268 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
1269 (clib_net_to_host_u16 (s->out2in.port) !=
1274 if (is_lb_session (s))
1277 if (!snat_is_session_static (s))
1280 nat_free_session_data (sm, s,
1281 tsm - sm->per_thread_data, 0);
1282 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1284 if (!addr_only && !sm->endpoint_dependent)
1291 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1292 if (pool_elts (m->locals))
1295 m_key.addr = m->external_addr;
1296 m_key.port = m->external_port;
1297 m_key.fib_index = 0;
1298 kv.key = m_key.as_u64;
1299 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0);
1302 vec_free (m->workers);
1303 /* Delete static mapping from pool */
1304 pool_put (sm->static_mappings, m);
1307 if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
1310 /* Add/delete external address to FIB */
1312 pool_foreach (interface, sm->interfaces,
1314 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1317 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1320 pool_foreach (interface, sm->output_feature_interfaces,
1322 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1325 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1334 nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1335 snat_protocol_t proto,
1336 nat44_lb_addr_port_t * locals, u8 is_add,
1337 twice_nat_type_t twice_nat, u8 out2in_only,
1338 u8 * tag, u32 affinity)
1340 snat_main_t *sm = &snat_main;
1341 snat_static_mapping_t *m;
1342 snat_session_key_t m_key;
1343 clib_bihash_kv_8_8_t kv, value;
1344 snat_address_t *a = 0;
1346 nat44_lb_addr_port_t *local;
1347 u32 elt_index, head_index, ses_index;
1348 snat_main_per_thread_data_t *tsm;
1349 snat_user_key_t u_key;
1352 dlist_elt_t *head, *elt;
1355 if (!sm->endpoint_dependent)
1356 return VNET_API_ERROR_FEATURE_DISABLED;
1358 m_key.addr = e_addr;
1359 m_key.port = e_port;
1360 m_key.protocol = proto;
1361 m_key.fib_index = 0;
1362 kv.key = m_key.as_u64;
1363 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1366 m = pool_elt_at_index (sm->static_mappings, value.value);
1371 return VNET_API_ERROR_VALUE_EXIST;
1373 if (vec_len (locals) < 2)
1374 return VNET_API_ERROR_INVALID_VALUE;
1376 /* Find external address in allocated addresses and reserve port for
1377 address and port pair mapping when dynamic translations enabled */
1378 if (!(sm->static_mapping_only || out2in_only))
1380 for (i = 0; i < vec_len (sm->addresses); i++)
1382 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1384 a = sm->addresses + i;
1385 /* External port must be unused */
1388 #define _(N, j, n, s) \
1389 case SNAT_PROTOCOL_##N: \
1390 if (a->busy_##n##_port_refcounts[e_port]) \
1391 return VNET_API_ERROR_INVALID_VALUE; \
1392 ++a->busy_##n##_port_refcounts[e_port]; \
1393 if (e_port > 1024) \
1395 a->busy_##n##_ports++; \
1396 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1399 foreach_snat_protocol
1402 nat_elog_info ("unknown protocol");
1403 return VNET_API_ERROR_INVALID_VALUE_2;
1408 /* External address must be allocated */
1410 return VNET_API_ERROR_NO_SUCH_ENTRY;
1413 pool_get (sm->static_mappings, m);
1414 clib_memset (m, 0, sizeof (*m));
1415 m->tag = vec_dup (tag);
1416 m->external_addr = e_addr;
1417 m->external_port = e_port;
1419 m->twice_nat = twice_nat;
1420 m->flags |= NAT_STATIC_MAPPING_FLAG_LB;
1422 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1423 m->affinity = affinity;
1426 m->affinity_per_service_list_head_index =
1427 nat_affinity_get_per_service_list_head_index ();
1429 m->affinity_per_service_list_head_index = ~0;
1431 m_key.addr = m->external_addr;
1432 m_key.port = m->external_port;
1433 m_key.protocol = m->proto;
1434 m_key.fib_index = 0;
1435 kv.key = m_key.as_u64;
1436 kv.value = m - sm->static_mappings;
1437 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1))
1439 nat_elog_err ("static_mapping_by_external key add failed");
1440 return VNET_API_ERROR_UNSPECIFIED;
1443 m_key.fib_index = m->fib_index;
1444 for (i = 0; i < vec_len (locals); i++)
1446 locals[i].fib_index =
1447 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
1450 m_key.addr = locals[i].addr;
1451 m_key.fib_index = locals[i].fib_index;
1454 m_key.port = locals[i].port;
1455 kv.key = m_key.as_u64;
1456 kv.value = m - sm->static_mappings;
1457 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1459 locals[i].prefix = (i == 0) ? locals[i].probability :
1460 (locals[i - 1].prefix + locals[i].probability);
1461 pool_get (m->locals, local);
1463 if (sm->num_workers > 1)
1466 .src_address = locals[i].addr,
1469 clib_bitmap_set (bitmap,
1470 sm->worker_in2out_cb (&ip, m->fib_index, 0),
1475 /* Assign workers */
1476 if (sm->num_workers > 1)
1479 clib_bitmap_foreach (i, bitmap,
1481 vec_add1(m->workers, i);
1489 return VNET_API_ERROR_NO_SUCH_ENTRY;
1491 if (!is_lb_static_mapping (m))
1492 return VNET_API_ERROR_INVALID_VALUE;
1494 /* Free external address port */
1495 if (!(sm->static_mapping_only || out2in_only))
1497 for (i = 0; i < vec_len (sm->addresses); i++)
1499 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1501 a = sm->addresses + i;
1504 #define _(N, j, n, s) \
1505 case SNAT_PROTOCOL_##N: \
1506 --a->busy_##n##_port_refcounts[e_port]; \
1507 if (e_port > 1024) \
1509 a->busy_##n##_ports--; \
1510 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1513 foreach_snat_protocol
1516 nat_elog_info ("unknown protocol");
1517 return VNET_API_ERROR_INVALID_VALUE_2;
1524 m_key.addr = m->external_addr;
1525 m_key.port = m->external_port;
1526 m_key.protocol = m->proto;
1527 m_key.fib_index = 0;
1528 kv.key = m_key.as_u64;
1529 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0))
1531 nat_elog_err ("static_mapping_by_external key del failed");
1532 return VNET_API_ERROR_UNSPECIFIED;
1536 pool_foreach (local, m->locals,
1538 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4,
1540 m_key.addr = local->addr;
1543 m_key.port = local->port;
1544 m_key.fib_index = local->fib_index;
1545 kv.key = m_key.as_u64;
1546 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1548 nat_elog_err ("static_mapping_by_local key del failed");
1549 return VNET_API_ERROR_UNSPECIFIED;
1553 if (sm->num_workers > 1)
1556 .src_address = local->addr,
1558 tsm = vec_elt_at_index (sm->per_thread_data,
1559 sm->worker_in2out_cb (&ip, m->fib_index, 0));
1562 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1564 /* Delete sessions */
1565 u_key.addr = local->addr;
1566 u_key.fib_index = local->fib_index;
1567 kv.key = u_key.as_u64;
1568 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1570 u = pool_elt_at_index (tsm->users, value.value);
1571 if (u->nstaticsessions)
1573 head_index = u->sessions_per_user_list_head_index;
1574 head = pool_elt_at_index (tsm->list_pool, head_index);
1575 elt_index = head->next;
1576 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1577 ses_index = elt->value;
1578 while (ses_index != ~0)
1580 s = pool_elt_at_index (tsm->sessions, ses_index);
1581 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1582 ses_index = elt->value;
1584 if (!(is_lb_session (s)))
1587 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1588 (clib_net_to_host_u16 (s->in2out.port) != local->port))
1591 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1592 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1599 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1600 pool_free (m->locals);
1602 vec_free (m->workers);
1604 pool_put (sm->static_mappings, m);
1611 nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1612 ip4_address_t l_addr, u16 l_port,
1613 snat_protocol_t proto, u32 vrf_id,
1614 u8 probability, u8 is_add)
1616 snat_main_t *sm = &snat_main;
1617 snat_static_mapping_t *m = 0;
1618 snat_session_key_t m_key;
1619 clib_bihash_kv_8_8_t kv, value;
1620 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1621 snat_main_per_thread_data_t *tsm;
1622 snat_user_key_t u_key;
1625 dlist_elt_t *head, *elt;
1626 u32 elt_index, head_index, ses_index, *locals = 0;
1630 if (!sm->endpoint_dependent)
1631 return VNET_API_ERROR_FEATURE_DISABLED;
1633 m_key.addr = e_addr;
1634 m_key.port = e_port;
1635 m_key.protocol = proto;
1636 m_key.fib_index = 0;
1637 kv.key = m_key.as_u64;
1638 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1639 m = pool_elt_at_index (sm->static_mappings, value.value);
1642 return VNET_API_ERROR_NO_SUCH_ENTRY;
1644 if (!is_lb_static_mapping (m))
1645 return VNET_API_ERROR_INVALID_VALUE;
1648 pool_foreach (local, m->locals,
1650 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1651 (local->vrf_id == vrf_id))
1653 match_local = local;
1662 return VNET_API_ERROR_VALUE_EXIST;
1664 pool_get (m->locals, local);
1665 clib_memset (local, 0, sizeof (*local));
1666 local->addr.as_u32 = l_addr.as_u32;
1667 local->port = l_port;
1668 local->probability = probability;
1669 local->vrf_id = vrf_id;
1671 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1674 if (!is_out2in_only_static_mapping (m))
1676 m_key.addr = l_addr;
1677 m_key.port = l_port;
1678 m_key.fib_index = local->fib_index;
1679 kv.key = m_key.as_u64;
1680 kv.value = m - sm->static_mappings;
1681 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1))
1682 nat_elog_err ("static_mapping_by_local key add failed");
1688 return VNET_API_ERROR_NO_SUCH_ENTRY;
1690 if (pool_elts (m->locals) < 3)
1691 return VNET_API_ERROR_UNSPECIFIED;
1693 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1696 if (!is_out2in_only_static_mapping (m))
1698 m_key.addr = l_addr;
1699 m_key.port = l_port;
1700 m_key.fib_index = match_local->fib_index;
1701 kv.key = m_key.as_u64;
1702 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0))
1703 nat_elog_err ("static_mapping_by_local key del failed");
1706 if (sm->num_workers > 1)
1709 .src_address = local->addr,
1711 tsm = vec_elt_at_index (sm->per_thread_data,
1712 sm->worker_in2out_cb (&ip, m->fib_index,
1716 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1718 /* Delete sessions */
1719 u_key.addr = match_local->addr;
1720 u_key.fib_index = match_local->fib_index;
1721 kv.key = u_key.as_u64;
1722 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1724 u = pool_elt_at_index (tsm->users, value.value);
1725 if (u->nstaticsessions)
1727 head_index = u->sessions_per_user_list_head_index;
1728 head = pool_elt_at_index (tsm->list_pool, head_index);
1729 elt_index = head->next;
1730 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1731 ses_index = elt->value;
1732 while (ses_index != ~0)
1734 s = pool_elt_at_index (tsm->sessions, ses_index);
1735 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1736 ses_index = elt->value;
1738 if (!(is_lb_session (s)))
1741 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1742 (clib_net_to_host_u16 (s->in2out.port) !=
1746 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1747 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1752 pool_put (m->locals, match_local);
1755 vec_free (m->workers);
1758 pool_foreach (local, m->locals,
1760 vec_add1 (locals, local - m->locals);
1761 if (sm->num_workers > 1)
1764 ip.src_address.as_u32 = local->addr.as_u32,
1765 bitmap = clib_bitmap_set (bitmap,
1766 sm->worker_in2out_cb (&ip, local->fib_index, 0),
1772 ASSERT (vec_len (locals) > 1);
1774 local = pool_elt_at_index (m->locals, locals[0]);
1775 local->prefix = local->probability;
1776 for (i = 1; i < vec_len (locals); i++)
1778 local = pool_elt_at_index (m->locals, locals[i]);
1779 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1780 local->prefix = local->probability + prev_local->prefix;
1783 /* Assign workers */
1784 if (sm->num_workers > 1)
1787 clib_bitmap_foreach (i, bitmap, ({ vec_add1(m->workers, i); }));
1795 snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1798 snat_address_t *a = 0;
1799 snat_session_t *ses;
1800 u32 *ses_to_be_removed = 0, *ses_index;
1801 snat_main_per_thread_data_t *tsm;
1802 snat_static_mapping_t *m;
1803 snat_interface_t *interface;
1805 snat_address_t *addresses =
1806 twice_nat ? sm->twice_nat_addresses : sm->addresses;
1808 /* Find SNAT address */
1809 for (i = 0; i < vec_len (addresses); i++)
1811 if (addresses[i].addr.as_u32 == addr.as_u32)
1818 return VNET_API_ERROR_NO_SUCH_ENTRY;
1823 pool_foreach (m, sm->static_mappings,
1825 if (m->external_addr.as_u32 == addr.as_u32)
1826 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1827 m->local_port, m->external_port,
1828 m->vrf_id, is_addr_only_static_mapping(m), ~0,
1829 m->proto, 0, m->twice_nat,
1830 is_out2in_only_static_mapping(m), m->tag, is_identity_static_mapping(m));
1836 /* Check if address is used in some static mapping */
1837 if (is_snat_address_used_in_static_mapping (sm, addr))
1839 nat_elog_notice ("address used in static mapping");
1840 return VNET_API_ERROR_UNSPECIFIED;
1844 if (a->fib_index != ~0)
1845 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1847 /* Delete sessions using address */
1848 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1851 vec_foreach (tsm, sm->per_thread_data)
1853 pool_foreach (ses, tsm->sessions, ({
1854 if (ses->out2in.addr.as_u32 == addr.as_u32)
1856 nat_free_session_data (sm, ses, tsm - sm->per_thread_data, 0);
1857 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1861 vec_foreach (ses_index, ses_to_be_removed)
1863 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1864 nat44_delete_session (sm, ses, tsm - sm->per_thread_data);
1867 vec_free (ses_to_be_removed);
1872 #define _(N, i, n, s) \
1873 vec_free (a->busy_##n##_ports_per_thread);
1874 foreach_snat_protocol
1878 vec_del1 (sm->twice_nat_addresses, i);
1882 vec_del1 (sm->addresses, i);
1884 /* Delete external address from FIB */
1886 pool_foreach (interface, sm->interfaces,
1888 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1891 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1894 pool_foreach (interface, sm->output_feature_interfaces,
1896 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1899 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1908 snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1910 snat_main_t *sm = &snat_main;
1911 snat_interface_t *i;
1912 const char *feature_name, *del_feature_name;
1914 snat_static_mapping_t *m;
1916 nat_outside_fib_t *outside_fib;
1917 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1920 if (sm->out2in_dpo && !is_inside)
1921 return VNET_API_ERROR_UNSUPPORTED;
1924 pool_foreach (i, sm->output_feature_interfaces,
1926 if (i->sw_if_index == sw_if_index)
1927 return VNET_API_ERROR_VALUE_EXIST;
1931 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1932 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1935 if (sm->num_workers > 1 && !sm->deterministic)
1937 is_inside ? "nat44-in2out-worker-handoff" :
1938 "nat44-out2in-worker-handoff";
1939 else if (sm->deterministic)
1940 feature_name = is_inside ? "nat44-det-in2out" : "nat44-det-out2in";
1941 else if (sm->endpoint_dependent)
1943 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1946 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1949 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1950 sm->fq_in2out_index =
1951 vlib_frame_queue_main_init (sm->handoff_in2out_index, NAT_FQ_NELTS);
1953 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1954 sm->fq_out2in_index =
1955 vlib_frame_queue_main_init (sm->handoff_out2in_index, NAT_FQ_NELTS);
1960 vec_foreach (outside_fib, sm->outside_fibs)
1962 if (outside_fib->fib_index == fib_index)
1966 outside_fib->refcount--;
1967 if (!outside_fib->refcount)
1968 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1971 outside_fib->refcount++;
1978 vec_add2 (sm->outside_fibs, outside_fib, 1);
1979 outside_fib->refcount = 1;
1980 outside_fib->fib_index = fib_index;
1985 pool_foreach (i, sm->interfaces,
1987 if (i->sw_if_index == sw_if_index)
1991 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1994 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1996 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1998 if (sm->num_workers > 1 && !sm->deterministic)
2000 del_feature_name = "nat44-handoff-classify";
2001 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
2002 "nat44-out2in-worker-handoff";
2004 else if (sm->deterministic)
2006 del_feature_name = "nat44-det-classify";
2007 feature_name = !is_inside ? "nat44-det-in2out" :
2010 else if (sm->endpoint_dependent)
2012 del_feature_name = "nat44-ed-classify";
2013 feature_name = !is_inside ? "nat-pre-in2out" :
2018 del_feature_name = "nat44-classify";
2019 feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
2022 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2025 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
2026 sw_if_index, 0, 0, 0);
2027 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2028 sw_if_index, 1, 0, 0);
2031 if (sm->endpoint_dependent)
2032 vnet_feature_enable_disable ("ip4-local",
2033 "nat44-ed-hairpinning",
2034 sw_if_index, 1, 0, 0);
2035 else if (!sm->deterministic)
2036 vnet_feature_enable_disable ("ip4-local",
2037 "nat44-hairpinning",
2038 sw_if_index, 1, 0, 0);
2043 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2046 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2047 sw_if_index, 0, 0, 0);
2048 pool_put (sm->interfaces, i);
2051 if (sm->endpoint_dependent)
2052 vnet_feature_enable_disable ("ip4-local",
2053 "nat44-ed-hairpinning",
2054 sw_if_index, 0, 0, 0);
2055 else if (!sm->deterministic)
2056 vnet_feature_enable_disable ("ip4-local",
2057 "nat44-hairpinning",
2058 sw_if_index, 0, 0, 0);
2064 if ((nat_interface_is_inside(i) && is_inside) ||
2065 (nat_interface_is_outside(i) && !is_inside))
2068 if (sm->num_workers > 1 && !sm->deterministic)
2070 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
2071 "nat44-out2in-worker-handoff";
2072 feature_name = "nat44-handoff-classify";
2074 else if (sm->deterministic)
2076 del_feature_name = !is_inside ? "nat44-det-in2out" :
2078 feature_name = "nat44-det-classify";
2080 else if (sm->endpoint_dependent)
2082 del_feature_name = !is_inside ? "nat-pre-in2out" :
2085 feature_name = "nat44-ed-classify";
2089 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
2090 feature_name = "nat44-classify";
2093 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
2096 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
2097 sw_if_index, 0, 0, 0);
2098 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2099 sw_if_index, 1, 0, 0);
2102 if (sm->endpoint_dependent)
2103 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
2104 sw_if_index, 0, 0, 0);
2105 else if (!sm->deterministic)
2106 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
2107 sw_if_index, 0, 0, 0);
2118 return VNET_API_ERROR_NO_SUCH_ENTRY;
2120 pool_get (sm->interfaces, i);
2121 i->sw_if_index = sw_if_index;
2123 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0,
2126 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
2130 if (is_inside && !sm->out2in_dpo)
2132 if (sm->endpoint_dependent)
2133 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
2134 sw_if_index, 1, 0, 0);
2135 else if (!sm->deterministic)
2136 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
2137 sw_if_index, 1, 0, 0);
2143 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2147 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2149 /* Add/delete external addresses to FIB */
2152 vec_foreach (ap, sm->addresses)
2153 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2155 pool_foreach (m, sm->static_mappings,
2157 if (!(is_addr_only_static_mapping(m)) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2160 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2163 pool_foreach (dm, sm->det_maps,
2165 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
2173 snat_interface_add_del_output_feature (u32 sw_if_index,
2174 u8 is_inside, int is_del)
2176 snat_main_t *sm = &snat_main;
2177 snat_interface_t *i;
2179 snat_static_mapping_t *m;
2180 nat_outside_fib_t *outside_fib;
2181 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
2185 if (sm->deterministic ||
2186 (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
2187 return VNET_API_ERROR_UNSUPPORTED;
2190 pool_foreach (i, sm->interfaces,
2192 if (i->sw_if_index == sw_if_index)
2193 return VNET_API_ERROR_VALUE_EXIST;
2200 vec_foreach (outside_fib, sm->outside_fibs)
2202 if (outside_fib->fib_index == fib_index)
2206 outside_fib->refcount--;
2207 if (!outside_fib->refcount)
2208 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2211 outside_fib->refcount++;
2218 vec_add2 (sm->outside_fibs, outside_fib, 1);
2219 outside_fib->refcount = 1;
2220 outside_fib->fib_index = fib_index;
2227 if (sm->endpoint_dependent)
2230 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2234 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2238 vnet_feature_enable_disable ("ip4-unicast", "nat44-ed-hairpin-dst",
2239 sw_if_index, !is_del, 0, 0);
2240 vnet_feature_enable_disable ("ip4-output", "nat44-ed-hairpin-src",
2241 sw_if_index, !is_del, 0, 0);
2246 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2250 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2254 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
2255 sw_if_index, !is_del, 0, 0);
2256 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
2257 sw_if_index, !is_del, 0, 0);
2262 if (sm->num_workers > 1)
2264 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2268 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, !is_del);
2271 vnet_feature_enable_disable ("ip4-unicast",
2272 "nat44-out2in-worker-handoff",
2273 sw_if_index, !is_del, 0, 0);
2274 vnet_feature_enable_disable ("ip4-output",
2275 "nat44-in2out-output-worker-handoff",
2276 sw_if_index, !is_del, 0, 0);
2280 if (sm->endpoint_dependent)
2283 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2287 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2291 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
2292 sw_if_index, !is_del, 0, 0);
2293 vnet_feature_enable_disable ("ip4-output", "nat44-ed-in2out-output",
2294 sw_if_index, !is_del, 0, 0);
2299 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2303 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2307 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in",
2308 sw_if_index, !is_del, 0, 0);
2309 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
2310 sw_if_index, !is_del, 0, 0);
2315 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
2316 sm->fq_in2out_output_index =
2317 vlib_frame_queue_main_init (sm->handoff_in2out_output_index, 0);
2319 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
2320 sm->fq_out2in_index =
2321 vlib_frame_queue_main_init (sm->handoff_out2in_index, 0);
2324 pool_foreach (i, sm->output_feature_interfaces,
2326 if (i->sw_if_index == sw_if_index)
2329 pool_put (sm->output_feature_interfaces, i);
2331 return VNET_API_ERROR_VALUE_EXIST;
2339 return VNET_API_ERROR_NO_SUCH_ENTRY;
2341 pool_get (sm->output_feature_interfaces, i);
2342 i->sw_if_index = sw_if_index;
2345 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2347 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2349 /* Add/delete external addresses to FIB */
2355 vec_foreach (ap, sm->addresses)
2356 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2358 pool_foreach (m, sm->static_mappings,
2360 if (!((is_addr_only_static_mapping(m))) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2363 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2371 snat_set_workers (uword * bitmap)
2373 snat_main_t *sm = &snat_main;
2376 if (sm->num_workers < 2)
2377 return VNET_API_ERROR_FEATURE_DISABLED;
2379 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2380 return VNET_API_ERROR_INVALID_WORKER;
2382 vec_free (sm->workers);
2384 clib_bitmap_foreach (i, bitmap,
2386 vec_add1(sm->workers, i);
2387 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2388 sm->per_thread_data[sm->first_worker_index + i].thread_index = i;
2393 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
2394 sm->num_snat_thread = _vec_len (sm->workers);
2400 snat_update_outside_fib (u32 sw_if_index, u32 new_fib_index,
2403 snat_main_t *sm = &snat_main;
2404 nat_outside_fib_t *outside_fib;
2405 snat_interface_t *i;
2409 if (new_fib_index == old_fib_index)
2412 if (!vec_len (sm->outside_fibs))
2416 pool_foreach (i, sm->interfaces,
2418 if (i->sw_if_index == sw_if_index)
2420 if (!(nat_interface_is_outside (i)))
2426 pool_foreach (i, sm->output_feature_interfaces,
2428 if (i->sw_if_index == sw_if_index)
2430 if (!(nat_interface_is_outside (i)))
2440 vec_foreach (outside_fib, sm->outside_fibs)
2442 if (outside_fib->fib_index == old_fib_index)
2444 outside_fib->refcount--;
2445 if (!outside_fib->refcount)
2446 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2451 vec_foreach (outside_fib, sm->outside_fibs)
2453 if (outside_fib->fib_index == new_fib_index)
2455 outside_fib->refcount++;
2463 vec_add2 (sm->outside_fibs, outside_fib, 1);
2464 outside_fib->refcount = 1;
2465 outside_fib->fib_index = new_fib_index;
2470 snat_ip4_table_bind (ip4_main_t * im,
2472 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
2474 snat_update_outside_fib (sw_if_index, new_fib_index, old_fib_index);
2478 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2481 ip4_address_t * address,
2483 u32 if_address_index, u32 is_delete);
2486 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
2489 ip4_address_t * address,
2491 u32 if_address_index, u32 is_delete);
2494 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2497 snat_session_key_t * k,
2498 u16 port_per_thread, u32 snat_thread_index);
2500 static clib_error_t *
2501 snat_init (vlib_main_t * vm)
2503 snat_main_t *sm = &snat_main;
2504 clib_error_t *error = 0;
2505 ip4_main_t *im = &ip4_main;
2506 ip_lookup_main_t *lm = &im->lookup_main;
2508 vlib_thread_registration_t *tr;
2509 vlib_thread_main_t *tm = vlib_get_thread_main ();
2512 ip4_add_del_interface_address_callback_t cb4;
2516 sm->vnet_main = vnet_get_main ();
2518 sm->ip4_lookup_main = lm;
2519 sm->api_main = vlibapi_get_main ();
2520 sm->first_worker_index = 0;
2521 sm->num_workers = 0;
2522 sm->num_snat_thread = 1;
2524 sm->port_per_thread = 0xffff - 1024;
2525 sm->fq_in2out_index = ~0;
2526 sm->fq_in2out_output_index = ~0;
2527 sm->fq_out2in_index = ~0;
2529 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
2530 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
2531 sm->forwarding_enabled = 0;
2532 sm->log_class = vlib_log_register_class ("nat", 0);
2533 sm->log_level = SNAT_LOG_ERROR;
2534 sm->mss_clamping = 0;
2536 node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
2537 sm->error_node_index = node->index;
2539 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2540 sm->pre_in2out_node_index = node->index;
2541 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2542 sm->pre_out2in_node_index = node->index;
2544 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2545 sm->pre_in2out_node_index = node->index;
2547 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2548 sm->pre_out2in_node_index = node->index;
2550 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out");
2551 sm->in2out_node_index = node->index;
2552 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output");
2553 sm->in2out_output_node_index = node->index;
2554 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-fast");
2555 sm->in2out_fast_node_index = node->index;
2556 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-slowpath");
2557 sm->in2out_slowpath_node_index = node->index;
2558 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output-slowpath");
2559 sm->in2out_slowpath_output_node_index = node->index;
2561 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out");
2562 sm->ed_in2out_node_index = node->index;
2563 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-slowpath");
2564 sm->ed_in2out_slowpath_node_index = node->index;
2566 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in");
2567 sm->out2in_node_index = node->index;
2568 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in-fast");
2569 sm->out2in_fast_node_index = node->index;
2571 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in");
2572 sm->ed_out2in_node_index = node->index;
2573 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in-slowpath");
2574 sm->ed_out2in_slowpath_node_index = node->index;
2576 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-in2out");
2577 sm->det_in2out_node_index = node->index;
2578 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-out2in");
2579 sm->det_out2in_node_index = node->index;
2581 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpinning");
2582 sm->hairpinning_node_index = node->index;
2583 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-dst");
2584 sm->hairpin_dst_node_index = node->index;
2585 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-src");
2586 sm->hairpin_src_node_index = node->index;
2587 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpinning");
2588 sm->ed_hairpinning_node_index = node->index;
2589 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-dst");
2590 sm->ed_hairpin_dst_node_index = node->index;
2591 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-src");
2592 sm->ed_hairpin_src_node_index = node->index;
2594 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2597 tr = (vlib_thread_registration_t *) p[0];
2600 sm->num_workers = tr->count;
2601 sm->first_worker_index = tr->first_index;
2605 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2607 /* Use all available workers by default */
2608 if (sm->num_workers > 1)
2610 for (i = 0; i < sm->num_workers; i++)
2611 bitmap = clib_bitmap_set (bitmap, i, 1);
2612 snat_set_workers (bitmap);
2613 clib_bitmap_free (bitmap);
2617 sm->per_thread_data[0].snat_thread_index = 0;
2620 error = snat_api_init (vm, sm);
2624 /* Set up the interface address add/del callback */
2625 cb4.function = snat_ip4_add_del_interface_address_cb;
2626 cb4.function_opaque = 0;
2628 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2630 cb4.function = nat_ip4_add_del_addr_only_sm_cb;
2631 cb4.function_opaque = 0;
2633 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2635 nat_dpo_module_init ();
2638 sm->total_users.name = "total-users";
2639 sm->total_users.stat_segment_name = "/nat44/total-users";
2640 vlib_validate_simple_counter (&sm->total_users, 0);
2641 vlib_zero_simple_counter (&sm->total_users, 0);
2642 sm->total_sessions.name = "total-sessions";
2643 sm->total_sessions.stat_segment_name = "/nat44/total-sessions";
2644 vlib_validate_simple_counter (&sm->total_sessions, 0);
2645 vlib_zero_simple_counter (&sm->total_sessions, 0);
2647 /* Init IPFIX logging */
2648 snat_ipfix_logging_init (vm);
2651 error = nat64_init (vm);
2657 ip4_table_bind_callback_t cbt4 = {
2658 .function = snat_ip4_table_bind,
2660 vec_add1 (ip4_main.table_bind_callbacks, cbt4);
2662 nat_fib_src_hi = fib_source_allocate ("nat-hi",
2663 FIB_SOURCE_PRIORITY_HI,
2664 FIB_SOURCE_BH_SIMPLE);
2665 nat_fib_src_low = fib_source_allocate ("nat-low",
2666 FIB_SOURCE_PRIORITY_LOW,
2667 FIB_SOURCE_BH_SIMPLE);
2672 VLIB_INIT_FUNCTION (snat_init);
2675 snat_free_outside_address_and_port (snat_address_t * addresses,
2676 u32 thread_index, snat_session_key_t * k)
2680 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2682 for (address_index = 0; address_index < vec_len (addresses);
2685 if (addresses[address_index].addr.as_u32 == k->addr.as_u32)
2689 ASSERT (address_index < vec_len (addresses));
2691 a = addresses + address_index;
2693 switch (k->protocol)
2695 #define _(N, i, n, s) \
2696 case SNAT_PROTOCOL_##N: \
2697 ASSERT (a->busy_##n##_port_refcounts[port_host_byte_order] >= 1); \
2698 --a->busy_##n##_port_refcounts[port_host_byte_order]; \
2699 a->busy_##n##_ports--; \
2700 a->busy_##n##_ports_per_thread[thread_index]--; \
2702 foreach_snat_protocol
2705 nat_elog_info ("unknown protocol");
2711 nat_set_outside_address_and_port (snat_address_t * addresses,
2712 u32 thread_index, snat_session_key_t * k)
2714 snat_address_t *a = 0;
2716 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2718 for (address_index = 0; address_index < vec_len (addresses);
2721 if (addresses[address_index].addr.as_u32 != k->addr.as_u32)
2724 a = addresses + address_index;
2725 switch (k->protocol)
2727 #define _(N, j, n, s) \
2728 case SNAT_PROTOCOL_##N: \
2729 if (a->busy_##n##_port_refcounts[port_host_byte_order]) \
2730 return VNET_API_ERROR_INSTANCE_IN_USE; \
2731 ++a->busy_##n##_port_refcounts[port_host_byte_order]; \
2732 a->busy_##n##_ports_per_thread[thread_index]++; \
2733 a->busy_##n##_ports++; \
2735 foreach_snat_protocol
2738 nat_elog_info ("unknown protocol");
2743 return VNET_API_ERROR_NO_SUCH_ENTRY;
2747 snat_static_mapping_match (snat_main_t * sm,
2748 snat_session_key_t match,
2749 snat_session_key_t * mapping,
2752 twice_nat_type_t * twice_nat,
2753 lb_nat_type_t * lb, ip4_address_t * ext_host_addr,
2754 u8 * is_identity_nat)
2756 clib_bihash_kv_8_8_t kv, value;
2757 snat_static_mapping_t *m;
2758 snat_session_key_t m_key;
2759 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
2760 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2762 nat44_lb_addr_port_t *local;
2764 m_key.fib_index = match.fib_index;
2767 mapping_hash = &sm->static_mapping_by_external;
2768 m_key.fib_index = 0;
2771 m_key.addr = match.addr;
2772 m_key.port = clib_net_to_host_u16 (match.port);
2773 m_key.protocol = match.protocol;
2775 kv.key = m_key.as_u64;
2777 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2779 /* Try address only mapping */
2782 kv.key = m_key.as_u64;
2783 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2787 m = pool_elt_at_index (sm->static_mappings, value.value);
2791 if (is_lb_static_mapping (m))
2793 if (PREDICT_FALSE (lb != 0))
2794 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2795 if (m->affinity && !nat_affinity_find_and_lock (ext_host_addr[0],
2801 local = pool_elt_at_index (m->locals, backend_index);
2802 mapping->addr = local->addr;
2803 mapping->port = clib_host_to_net_u16 (local->port);
2804 mapping->fib_index = local->fib_index;
2807 // pick locals matching this worker
2808 if (PREDICT_FALSE (sm->num_workers > 1))
2810 u32 thread_index = vlib_get_thread_index ();
2812 pool_foreach_index (i, m->locals,
2814 local = pool_elt_at_index (m->locals, i);
2817 .src_address = local->addr,
2820 if (sm->worker_in2out_cb (&ip, m->fib_index, 0) ==
2827 ASSERT (vec_len (tmp) != 0);
2832 pool_foreach_index (i, m->locals,
2838 hi = vec_len (tmp) - 1;
2839 local = pool_elt_at_index (m->locals, tmp[hi]);
2840 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2843 mid = ((hi - lo) >> 1) + lo;
2844 local = pool_elt_at_index (m->locals, tmp[mid]);
2845 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2847 local = pool_elt_at_index (m->locals, tmp[lo]);
2848 if (!(local->prefix >= rand))
2850 mapping->addr = local->addr;
2851 mapping->port = clib_host_to_net_u16 (local->port);
2852 mapping->fib_index = local->fib_index;
2855 if (nat_affinity_create_and_lock (ext_host_addr[0], match.addr,
2856 match.protocol, match.port,
2857 tmp[lo], m->affinity,
2858 m->affinity_per_service_list_head_index))
2859 nat_elog_info ("create affinity record failed");
2865 if (PREDICT_FALSE (lb != 0))
2867 mapping->fib_index = m->fib_index;
2868 mapping->addr = m->local_addr;
2869 /* Address only mapping doesn't change port */
2870 mapping->port = is_addr_only_static_mapping (m) ? match.port
2871 : clib_host_to_net_u16 (m->local_port);
2873 mapping->protocol = m->proto;
2877 mapping->addr = m->external_addr;
2878 /* Address only mapping doesn't change port */
2879 mapping->port = is_addr_only_static_mapping (m) ? match.port
2880 : clib_host_to_net_u16 (m->external_port);
2881 mapping->fib_index = sm->outside_fib_index;
2885 if (PREDICT_FALSE (is_addr_only != 0))
2886 *is_addr_only = is_addr_only_static_mapping (m);
2888 if (PREDICT_FALSE (twice_nat != 0))
2889 *twice_nat = m->twice_nat;
2891 if (PREDICT_FALSE (is_identity_nat != 0))
2892 *is_identity_nat = is_identity_static_mapping (m);
2897 static_always_inline u16
2898 snat_random_port (u16 min, u16 max)
2900 snat_main_t *sm = &snat_main;
2901 return min + random_u32 (&sm->random_seed) /
2902 (random_u32_max () / (max - min + 1) + 1);
2906 snat_alloc_outside_address_and_port (snat_address_t * addresses,
2909 snat_session_key_t * k,
2910 u16 port_per_thread,
2911 u32 snat_thread_index)
2913 snat_main_t *sm = &snat_main;
2915 return sm->alloc_addr_and_port (addresses, fib_index, thread_index, k,
2916 port_per_thread, snat_thread_index);
2920 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2923 snat_session_key_t * k,
2924 u16 port_per_thread, u32 snat_thread_index)
2927 snat_address_t *a, *ga = 0;
2930 for (i = 0; i < vec_len (addresses); i++)
2933 switch (k->protocol)
2935 #define _(N, j, n, s) \
2936 case SNAT_PROTOCOL_##N: \
2937 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
2939 if (a->fib_index == fib_index) \
2943 portnum = (port_per_thread * \
2944 snat_thread_index) + \
2945 snat_random_port(1, port_per_thread) + 1024; \
2946 if (a->busy_##n##_port_refcounts[portnum]) \
2948 --a->busy_##n##_port_refcounts[portnum]; \
2949 a->busy_##n##_ports_per_thread[thread_index]++; \
2950 a->busy_##n##_ports++; \
2951 k->addr = a->addr; \
2952 k->port = clib_host_to_net_u16(portnum); \
2956 else if (a->fib_index == ~0) \
2962 foreach_snat_protocol
2965 nat_elog_info ("unknown protocol");
2974 switch (k->protocol)
2976 #define _(N, j, n, s) \
2977 case SNAT_PROTOCOL_##N: \
2980 portnum = (port_per_thread * \
2981 snat_thread_index) + \
2982 snat_random_port(1, port_per_thread) + 1024; \
2983 if (a->busy_##n##_port_refcounts[portnum]) \
2985 ++a->busy_##n##_port_refcounts[portnum]; \
2986 a->busy_##n##_ports_per_thread[thread_index]++; \
2987 a->busy_##n##_ports++; \
2988 k->addr = a->addr; \
2989 k->port = clib_host_to_net_u16(portnum); \
2993 foreach_snat_protocol
2996 nat_elog_info ("unknown protocol");
3001 /* Totally out of translations to use... */
3002 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3007 nat_alloc_addr_and_port_mape (snat_address_t * addresses,
3010 snat_session_key_t * k,
3011 u16 port_per_thread, u32 snat_thread_index)
3013 snat_main_t *sm = &snat_main;
3014 snat_address_t *a = addresses;
3015 u16 m, ports, portnum, A, j;
3016 m = 16 - (sm->psid_offset + sm->psid_length);
3017 ports = (1 << (16 - sm->psid_length)) - (1 << m);
3019 if (!vec_len (addresses))
3022 switch (k->protocol)
3024 #define _(N, i, n, s) \
3025 case SNAT_PROTOCOL_##N: \
3026 if (a->busy_##n##_ports < ports) \
3030 A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
3031 j = snat_random_port(0, pow2_mask(m)); \
3032 portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
3033 if (a->busy_##n##_port_refcounts[portnum]) \
3035 ++a->busy_##n##_port_refcounts[portnum]; \
3036 a->busy_##n##_ports++; \
3037 k->addr = a->addr; \
3038 k->port = clib_host_to_net_u16 (portnum); \
3043 foreach_snat_protocol
3046 nat_elog_info ("unknown protocol");
3051 /* Totally out of translations to use... */
3052 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3057 nat_alloc_addr_and_port_range (snat_address_t * addresses,
3060 snat_session_key_t * k,
3061 u16 port_per_thread, u32 snat_thread_index)
3063 snat_main_t *sm = &snat_main;
3064 snat_address_t *a = addresses;
3067 ports = sm->end_port - sm->start_port + 1;
3069 if (!vec_len (addresses))
3072 switch (k->protocol)
3074 #define _(N, i, n, s) \
3075 case SNAT_PROTOCOL_##N: \
3076 if (a->busy_##n##_ports < ports) \
3080 portnum = snat_random_port(sm->start_port, sm->end_port); \
3081 if (a->busy_##n##_port_refcounts[portnum]) \
3083 ++a->busy_##n##_port_refcounts[portnum]; \
3084 a->busy_##n##_ports++; \
3085 k->addr = a->addr; \
3086 k->port = clib_host_to_net_u16 (portnum); \
3091 foreach_snat_protocol
3094 nat_elog_info ("unknown protocol");
3099 /* Totally out of translations to use... */
3100 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3105 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
3107 dpo_id_t dpo_v4 = DPO_INVALID;
3108 fib_prefix_t pfx = {
3109 .fp_proto = FIB_PROTOCOL_IP4,
3111 .fp_addr.ip4.as_u32 = addr.as_u32,
3116 nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
3117 fib_table_entry_special_dpo_add (0, &pfx, nat_fib_src_hi,
3118 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
3119 dpo_reset (&dpo_v4);
3123 fib_table_entry_special_remove (0, &pfx, nat_fib_src_hi);
3128 format_session_kvp (u8 * s, va_list * args)
3130 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3131 snat_session_key_t k;
3135 s = format (s, "%U session-index %llu", format_snat_key, &k, v->value);
3141 format_static_mapping_kvp (u8 * s, va_list * args)
3143 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3144 snat_session_key_t k;
3148 s = format (s, "%U static-mapping-index %llu",
3149 format_static_mapping_key, &k, v->value);
3155 format_user_kvp (u8 * s, va_list * args)
3157 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3162 s = format (s, "%U fib %d user-index %llu", format_ip4_address, &k.addr,
3163 k.fib_index, v->value);
3169 format_ed_session_kvp (u8 * s, va_list * args)
3171 clib_bihash_kv_16_8_t *v = va_arg (*args, clib_bihash_kv_16_8_t *);
3174 k.as_u64[0] = v->key[0];
3175 k.as_u64[1] = v->key[1];
3178 format (s, "local %U:%d remote %U:%d proto %U fib %d session-index %llu",
3179 format_ip4_address, &k.l_addr, clib_net_to_host_u16 (k.l_port),
3180 format_ip4_address, &k.r_addr, clib_net_to_host_u16 (k.r_port),
3181 format_ip_protocol, k.proto, k.fib_index, v->value);
3187 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0,
3190 snat_main_t *sm = &snat_main;
3191 u32 next_worker_index = 0;
3194 next_worker_index = sm->first_worker_index;
3195 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
3196 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >> 24);
3198 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3199 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3201 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3203 return next_worker_index;
3207 snat_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip0,
3208 u32 rx_fib_index0, u8 is_output)
3210 snat_main_t *sm = &snat_main;
3213 snat_session_key_t m_key;
3214 clib_bihash_kv_8_8_t kv, value;
3215 snat_static_mapping_t *m;
3217 u32 next_worker_index = 0;
3219 /* first try static mappings without port */
3220 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3222 m_key.addr = ip0->dst_address;
3225 m_key.fib_index = rx_fib_index0;
3226 kv.key = m_key.as_u64;
3227 if (!clib_bihash_search_8_8
3228 (&sm->static_mapping_by_external, &kv, &value))
3230 m = pool_elt_at_index (sm->static_mappings, value.value);
3231 return m->workers[0];
3235 proto = ip_proto_to_snat_proto (ip0->protocol);
3236 udp = ip4_next_header (ip0);
3237 port = udp->dst_port;
3239 /* unknown protocol */
3240 if (PREDICT_FALSE (proto == ~0))
3242 /* use current thread */
3243 return vlib_get_thread_index ();
3246 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
3248 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3249 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3250 if (!icmp_type_is_error_message
3251 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3252 port = vnet_buffer (b)->ip.reass.l4_src_port;
3255 /* if error message, then it's not fragmented and we can access it */
3256 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3257 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3258 void *l4_header = ip4_next_header (inner_ip);
3261 case SNAT_PROTOCOL_ICMP:
3262 icmp = (icmp46_header_t *) l4_header;
3263 echo = (icmp_echo_header_t *) (icmp + 1);
3264 port = echo->identifier;
3266 case SNAT_PROTOCOL_UDP:
3267 case SNAT_PROTOCOL_TCP:
3268 port = ((tcp_udp_header_t *) l4_header)->src_port;
3271 return vlib_get_thread_index ();
3276 /* try static mappings with port */
3277 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3279 m_key.addr = ip0->dst_address;
3280 m_key.port = clib_net_to_host_u16 (port);
3281 m_key.protocol = proto;
3282 m_key.fib_index = rx_fib_index0;
3283 kv.key = m_key.as_u64;
3284 if (!clib_bihash_search_8_8
3285 (&sm->static_mapping_by_external, &kv, &value))
3287 m = pool_elt_at_index (sm->static_mappings, value.value);
3288 return m->workers[0];
3292 /* worker by outside port */
3293 next_worker_index = sm->first_worker_index;
3294 next_worker_index +=
3295 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3296 return next_worker_index;
3300 nat44_ed_get_worker_in2out_cb (ip4_header_t * ip, u32 rx_fib_index,
3303 snat_main_t *sm = &snat_main;
3304 u32 next_worker_index = sm->first_worker_index;
3307 clib_bihash_kv_16_8_t kv16, value16;
3308 snat_main_per_thread_data_t *tsm;
3311 if (PREDICT_FALSE (is_output))
3313 u32 fib_index = sm->outside_fib_index;
3314 nat_outside_fib_t *outside_fib;
3315 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3316 fib_prefix_t pfx = {
3317 .fp_proto = FIB_PROTOCOL_IP4,
3320 .ip4.as_u32 = ip->dst_address.as_u32,
3325 udp = ip4_next_header (ip);
3327 switch (vec_len (sm->outside_fibs))
3330 fib_index = sm->outside_fib_index;
3333 fib_index = sm->outside_fibs[0].fib_index;
3337 vec_foreach (outside_fib, sm->outside_fibs)
3339 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3340 if (FIB_NODE_INDEX_INVALID != fei)
3342 if (fib_entry_get_resolving_interface (fei) != ~0)
3344 fib_index = outside_fib->fib_index;
3353 make_ed_kv (&kv16, &ip->src_address, &ip->dst_address,
3354 ip->protocol, fib_index, udp->src_port, udp->dst_port);
3357 vec_foreach (tsm, sm->per_thread_data)
3359 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3362 next_worker_index += tsm->thread_index;
3364 nat_elog_debug_handoff (
3365 "HANDOFF IN2OUT-OUTPUT-FEATURE (session)",
3366 next_worker_index, fib_index,
3367 clib_net_to_host_u32 (ip->src_address.as_u32),
3368 clib_net_to_host_u32 (ip->dst_address.as_u32));
3370 return next_worker_index;
3376 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3377 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3379 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3380 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3382 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3384 if (PREDICT_TRUE (!is_output))
3386 nat_elog_debug_handoff ("HANDOFF IN2OUT",
3387 next_worker_index, rx_fib_index,
3388 clib_net_to_host_u32 (ip->src_address.as_u32),
3389 clib_net_to_host_u32 (ip->dst_address.as_u32));
3393 nat_elog_debug_handoff ("HANDOFF IN2OUT-OUTPUT-FEATURE",
3394 next_worker_index, rx_fib_index,
3395 clib_net_to_host_u32 (ip->src_address.as_u32),
3396 clib_net_to_host_u32 (ip->dst_address.as_u32));
3399 return next_worker_index;
3403 nat44_ed_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip,
3404 u32 rx_fib_index, u8 is_output)
3406 snat_main_t *sm = &snat_main;
3407 clib_bihash_kv_8_8_t kv, value;
3408 clib_bihash_kv_16_8_t kv16, value16;
3409 snat_main_per_thread_data_t *tsm;
3411 u32 proto, next_worker_index = 0;
3414 snat_static_mapping_t *m;
3417 proto = ip_proto_to_snat_proto (ip->protocol);
3419 if (PREDICT_TRUE (proto == SNAT_PROTOCOL_UDP || proto == SNAT_PROTOCOL_TCP))
3421 udp = ip4_next_header (ip);
3423 make_ed_kv (&kv16, &ip->dst_address, &ip->src_address,
3424 ip->protocol, rx_fib_index, udp->dst_port, udp->src_port);
3427 vec_foreach (tsm, sm->per_thread_data)
3429 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3432 next_worker_index = sm->first_worker_index + tsm->thread_index;
3433 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3434 next_worker_index, rx_fib_index,
3435 clib_net_to_host_u32 (ip->src_address.as_u32),
3436 clib_net_to_host_u32 (ip->dst_address.as_u32));
3437 return next_worker_index;
3442 else if (proto == SNAT_PROTOCOL_ICMP)
3444 nat_ed_ses_key_t key;
3446 if (!get_icmp_o2i_ed_key (b, ip, &key))
3449 key.fib_index = rx_fib_index;
3450 kv16.key[0] = key.as_u64[0];
3451 kv16.key[1] = key.as_u64[1];
3454 vec_foreach (tsm, sm->per_thread_data)
3456 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3459 next_worker_index = sm->first_worker_index +
3461 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3462 next_worker_index, rx_fib_index,
3463 clib_net_to_host_u32 (ip->src_address.as_u32),
3464 clib_net_to_host_u32 (ip->dst_address.as_u32));
3465 return next_worker_index;
3472 /* first try static mappings without port */
3473 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3475 make_sm_kv (&kv, &ip->dst_address, 0, 0, 0);
3476 if (!clib_bihash_search_8_8
3477 (&sm->static_mapping_by_external, &kv, &value))
3479 m = pool_elt_at_index (sm->static_mappings, value.value);
3480 next_worker_index = m->workers[0];
3485 /* unknown protocol */
3486 if (PREDICT_FALSE (proto == ~0))
3488 /* use current thread */
3489 next_worker_index = vlib_get_thread_index ();
3493 udp = ip4_next_header (ip);
3494 port = udp->dst_port;
3496 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
3498 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3499 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3500 if (!icmp_type_is_error_message
3501 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3502 port = vnet_buffer (b)->ip.reass.l4_src_port;
3505 /* if error message, then it's not fragmented and we can access it */
3506 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3507 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3508 void *l4_header = ip4_next_header (inner_ip);
3511 case SNAT_PROTOCOL_ICMP:
3512 icmp = (icmp46_header_t *) l4_header;
3513 echo = (icmp_echo_header_t *) (icmp + 1);
3514 port = echo->identifier;
3516 case SNAT_PROTOCOL_UDP:
3517 case SNAT_PROTOCOL_TCP:
3518 port = ((tcp_udp_header_t *) l4_header)->src_port;
3521 next_worker_index = vlib_get_thread_index ();
3527 /* try static mappings with port */
3528 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3530 make_sm_kv (&kv, &ip->dst_address, proto, 0,
3531 clib_net_to_host_u16 (port));
3532 if (!clib_bihash_search_8_8
3533 (&sm->static_mapping_by_external, &kv, &value))
3535 m = pool_elt_at_index (sm->static_mappings, value.value);
3536 if (!is_lb_static_mapping (m))
3538 next_worker_index = m->workers[0];
3542 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3543 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3545 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
3547 m->workers[hash & (_vec_len (m->workers) - 1)];
3549 next_worker_index = m->workers[hash % _vec_len (m->workers)];
3554 /* worker by outside port */
3555 next_worker_index = sm->first_worker_index;
3556 next_worker_index +=
3557 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3560 nat_elog_debug_handoff ("HANDOFF OUT2IN", next_worker_index, rx_fib_index,
3561 clib_net_to_host_u32 (ip->src_address.as_u32),
3562 clib_net_to_host_u32 (ip->dst_address.as_u32));
3563 return next_worker_index;
3567 nat_ha_sadd_cb (ip4_address_t * in_addr, u16 in_port,
3568 ip4_address_t * out_addr, u16 out_port,
3569 ip4_address_t * eh_addr, u16 eh_port,
3570 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3571 u32 fib_index, u16 flags, u32 thread_index)
3573 snat_main_t *sm = &snat_main;
3574 snat_session_key_t key;
3577 clib_bihash_kv_8_8_t kv;
3578 f64 now = vlib_time_now (sm->vlib_main);
3579 nat_outside_fib_t *outside_fib;
3580 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3581 snat_main_per_thread_data_t *tsm;
3582 fib_prefix_t pfx = {
3583 .fp_proto = FIB_PROTOCOL_IP4,
3586 .ip4.as_u32 = eh_addr->as_u32,
3590 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3592 key.addr.as_u32 = out_addr->as_u32;
3593 key.port = out_port;
3594 key.protocol = proto;
3596 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3598 if (nat_set_outside_address_and_port
3599 (sm->addresses, thread_index, &key))
3603 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3607 s = nat_session_alloc_or_recycle (sm, u, thread_index, now);
3611 s->last_heard = now;
3613 s->ext_host_addr.as_u32 = eh_addr->as_u32;
3614 s->ext_host_port = eh_port;
3615 user_session_increment (sm, u, snat_is_session_static (s));
3616 switch (vec_len (sm->outside_fibs))
3619 key.fib_index = sm->outside_fib_index;
3622 key.fib_index = sm->outside_fibs[0].fib_index;
3626 vec_foreach (outside_fib, sm->outside_fibs)
3628 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3629 if (FIB_NODE_INDEX_INVALID != fei)
3631 if (fib_entry_get_resolving_interface (fei) != ~0)
3633 key.fib_index = outside_fib->fib_index;
3642 kv.key = key.as_u64;
3643 kv.value = s - tsm->sessions;
3644 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 1))
3645 nat_elog_warn ("out2in key add failed");
3647 key.addr.as_u32 = in_addr->as_u32;
3649 key.fib_index = fib_index;
3651 kv.key = key.as_u64;
3652 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 1))
3653 nat_elog_warn ("in2out key add failed");
3657 nat_ha_sdel_cb (ip4_address_t * out_addr, u16 out_port,
3658 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3661 snat_main_t *sm = &snat_main;
3662 snat_session_key_t key;
3663 clib_bihash_kv_8_8_t kv, value;
3666 snat_main_per_thread_data_t *tsm;
3668 if (sm->num_workers > 1)
3670 sm->first_worker_index +
3671 (sm->workers[(clib_net_to_host_u16 (out_port) -
3672 1024) / sm->port_per_thread]);
3674 thread_index = sm->num_workers;
3675 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3677 key.addr.as_u32 = out_addr->as_u32;
3678 key.port = out_port;
3679 key.protocol = proto;
3680 key.fib_index = fib_index;
3681 kv.key = key.as_u64;
3682 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3685 s = pool_elt_at_index (tsm->sessions, value.value);
3686 nat_free_session_data (sm, s, thread_index, 1);
3687 nat44_delete_session (sm, s, thread_index);
3691 nat_ha_sref_cb (ip4_address_t * out_addr, u16 out_port,
3692 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3693 u32 total_pkts, u64 total_bytes, u32 thread_index)
3695 snat_main_t *sm = &snat_main;
3696 snat_session_key_t key;
3697 clib_bihash_kv_8_8_t kv, value;
3699 snat_main_per_thread_data_t *tsm;
3701 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3703 key.addr.as_u32 = out_addr->as_u32;
3704 key.port = out_port;
3705 key.protocol = proto;
3706 key.fib_index = fib_index;
3707 kv.key = key.as_u64;
3708 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3711 s = pool_elt_at_index (tsm->sessions, value.value);
3712 s->total_pkts = total_pkts;
3713 s->total_bytes = total_bytes;
3717 nat_ha_sadd_ed_cb (ip4_address_t * in_addr, u16 in_port,
3718 ip4_address_t * out_addr, u16 out_port,
3719 ip4_address_t * eh_addr, u16 eh_port,
3720 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3721 u32 fib_index, u16 flags, u32 thread_index)
3723 snat_main_t *sm = &snat_main;
3724 snat_session_key_t key;
3727 clib_bihash_kv_16_8_t kv;
3728 f64 now = vlib_time_now (sm->vlib_main);
3729 nat_outside_fib_t *outside_fib;
3730 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3731 snat_main_per_thread_data_t *tsm;
3732 fib_prefix_t pfx = {
3733 .fp_proto = FIB_PROTOCOL_IP4,
3736 .ip4.as_u32 = eh_addr->as_u32,
3740 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3742 key.addr.as_u32 = out_addr->as_u32;
3743 key.port = out_port;
3744 key.protocol = proto;
3746 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3748 if (nat_set_outside_address_and_port
3749 (sm->addresses, thread_index, &key))
3753 key.addr.as_u32 = ehn_addr->as_u32;
3754 key.port = ehn_port;
3755 if (flags & SNAT_SESSION_FLAG_TWICE_NAT)
3757 if (nat_set_outside_address_and_port
3758 (sm->twice_nat_addresses, thread_index, &key))
3762 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3766 s = nat_ed_session_alloc (sm, u, thread_index, now);
3770 s->last_heard = now;
3772 s->ext_host_nat_addr.as_u32 = s->ext_host_addr.as_u32 = eh_addr->as_u32;
3773 s->ext_host_nat_port = s->ext_host_port = eh_port;
3774 if (is_twice_nat_session (s))
3776 s->ext_host_nat_addr.as_u32 = ehn_addr->as_u32;
3777 s->ext_host_nat_port = ehn_port;
3779 user_session_increment (sm, u, snat_is_session_static (s));
3780 switch (vec_len (sm->outside_fibs))
3783 key.fib_index = sm->outside_fib_index;
3786 key.fib_index = sm->outside_fibs[0].fib_index;
3790 vec_foreach (outside_fib, sm->outside_fibs)
3792 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3793 if (FIB_NODE_INDEX_INVALID != fei)
3795 if (fib_entry_get_resolving_interface (fei) != ~0)
3797 key.fib_index = outside_fib->fib_index;
3805 key.addr.as_u32 = out_addr->as_u32;
3806 key.port = out_port;
3808 kv.value = s - tsm->sessions;
3810 key.addr.as_u32 = in_addr->as_u32;
3812 key.fib_index = fib_index;
3815 make_ed_kv (&kv, in_addr, &s->ext_host_nat_addr,
3816 snat_proto_to_ip_proto (proto), fib_index, in_port,
3817 s->ext_host_nat_port);
3818 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &kv, 1))
3819 nat_elog_warn ("in2out key add failed");
3821 make_ed_kv (&kv, out_addr, eh_addr, snat_proto_to_ip_proto (proto),
3822 s->out2in.fib_index, out_port, eh_port);
3823 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &kv, 1))
3824 nat_elog_warn ("out2in key add failed");
3828 nat_ha_sdel_ed_cb (ip4_address_t * out_addr, u16 out_port,
3829 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3830 u32 fib_index, u32 ti)
3832 snat_main_t *sm = &snat_main;
3833 nat_ed_ses_key_t key;
3834 clib_bihash_kv_16_8_t kv, value;
3837 snat_main_per_thread_data_t *tsm;
3839 if (sm->num_workers > 1)
3841 sm->first_worker_index +
3842 (sm->workers[(clib_net_to_host_u16 (out_port) -
3843 1024) / sm->port_per_thread]);
3845 thread_index = sm->num_workers;
3846 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3848 key.l_addr.as_u32 = out_addr->as_u32;
3849 key.l_port = out_port;
3850 key.r_addr.as_u32 = eh_addr->as_u32;
3851 key.r_port = eh_port;
3853 key.fib_index = fib_index;
3854 kv.key[0] = key.as_u64[0];
3855 kv.key[1] = key.as_u64[1];
3856 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3859 s = pool_elt_at_index (tsm->sessions, value.value);
3860 nat_free_session_data (sm, s, thread_index, 1);
3861 nat44_delete_session (sm, s, thread_index);
3865 nat_ha_sref_ed_cb (ip4_address_t * out_addr, u16 out_port,
3866 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3867 u32 fib_index, u32 total_pkts, u64 total_bytes,
3870 snat_main_t *sm = &snat_main;
3871 nat_ed_ses_key_t key;
3872 clib_bihash_kv_16_8_t kv, value;
3874 snat_main_per_thread_data_t *tsm;
3876 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3878 key.l_addr.as_u32 = out_addr->as_u32;
3879 key.l_port = out_port;
3880 key.r_addr.as_u32 = eh_addr->as_u32;
3881 key.r_port = eh_port;
3883 key.fib_index = fib_index;
3884 kv.key[0] = key.as_u64[0];
3885 kv.key[1] = key.as_u64[1];
3886 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3889 s = pool_elt_at_index (tsm->sessions, value.value);
3890 s->total_pkts = total_pkts;
3891 s->total_bytes = total_bytes;
3894 static clib_error_t *
3895 snat_config (vlib_main_t * vm, unformat_input_t * input)
3897 snat_main_t *sm = &snat_main;
3898 nat66_main_t *nm = &nat66_main;
3899 //dslite_main_t *dm = &dslite_main;
3900 snat_main_per_thread_data_t *tsm;
3902 u32 static_mapping_buckets = 1024;
3903 uword static_mapping_memory_size = 64 << 20;
3905 u32 nat64_bib_buckets = 1024;
3906 u32 nat64_bib_memory_size = 128 << 20;
3908 u32 nat64_st_buckets = 2048;
3909 uword nat64_st_memory_size = 256 << 20;
3911 u32 user_buckets = 128;
3912 uword user_memory_size = 64 << 20;
3913 u32 translation_buckets = 1024;
3914 uword translation_memory_size = 128 << 20;
3916 u32 max_translations_per_user = ~0;
3918 u32 outside_vrf_id = 0;
3919 u32 outside_ip6_vrf_id = 0;
3920 u32 inside_vrf_id = 0;
3921 u8 static_mapping_only = 0;
3922 u8 static_mapping_connection_tracking = 0;
3924 // configurable timeouts
3925 u32 udp_timeout = SNAT_UDP_TIMEOUT;
3926 u32 icmp_timeout = SNAT_ICMP_TIMEOUT;
3927 u32 tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
3928 u32 tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
3930 sm->deterministic = 0;
3932 sm->endpoint_dependent = 0;
3934 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3937 (input, "translation hash buckets %d", &translation_buckets))
3939 else if (unformat (input, "udp timeout %d", &udp_timeout))
3941 else if (unformat (input, "icmp timeout %d", &icmp_timeout))
3943 else if (unformat (input, "tcp transitory timeout %d",
3944 &tcp_transitory_timeout));
3945 else if (unformat (input, "tcp established timeout %d",
3946 &tcp_established_timeout));
3947 else if (unformat (input, "translation hash memory %d",
3948 &translation_memory_size));
3949 else if (unformat (input, "user hash buckets %d", &user_buckets))
3951 else if (unformat (input, "user hash memory %d", &user_memory_size))
3953 else if (unformat (input, "max translations per user %d",
3954 &max_translations_per_user))
3956 else if (unformat (input, "outside VRF id %d", &outside_vrf_id))
3958 else if (unformat (input, "outside ip6 VRF id %d", &outside_ip6_vrf_id))
3960 else if (unformat (input, "inside VRF id %d", &inside_vrf_id))
3962 else if (unformat (input, "static mapping only"))
3964 static_mapping_only = 1;
3965 if (unformat (input, "connection tracking"))
3966 static_mapping_connection_tracking = 1;
3968 else if (unformat (input, "deterministic"))
3969 sm->deterministic = 1;
3970 else if (unformat (input, "nat64 bib hash buckets %d",
3971 &nat64_bib_buckets))
3973 else if (unformat (input, "nat64 bib hash memory %d",
3974 &nat64_bib_memory_size))
3977 if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
3979 else if (unformat (input, "nat64 st hash memory %d",
3980 &nat64_st_memory_size))
3982 else if (unformat (input, "out2in dpo"))
3984 //else if (unformat (input, "dslite ce"))
3985 //dslite_set_ce (dm, 1);
3986 else if (unformat (input, "endpoint-dependent"))
3987 sm->endpoint_dependent = 1;
3989 return clib_error_return (0, "unknown input '%U'",
3990 format_unformat_error, input);
3993 if (sm->deterministic && sm->endpoint_dependent)
3994 return clib_error_return (0,
3995 "deterministic and endpoint-dependent modes are mutually exclusive");
3997 if (static_mapping_only && (sm->deterministic || sm->endpoint_dependent))
3998 return clib_error_return (0,
3999 "static mapping only mode available only for simple nat");
4001 if (sm->out2in_dpo && (sm->deterministic || sm->endpoint_dependent))
4002 return clib_error_return (0,
4003 "out2in dpo mode available only for simple nat");
4005 /* optionally configurable timeouts for testing purposes */
4006 sm->udp_timeout = udp_timeout;
4007 sm->tcp_transitory_timeout = tcp_transitory_timeout;
4008 sm->tcp_established_timeout = tcp_established_timeout;
4009 sm->icmp_timeout = icmp_timeout;
4011 sm->user_buckets = user_buckets;
4012 sm->user_memory_size = user_memory_size;
4014 sm->translation_buckets = translation_buckets;
4015 sm->translation_memory_size = translation_memory_size;
4017 /* do not exceed load factor 10 */
4018 sm->max_translations = 10 * translation_buckets;
4019 sm->max_translations_per_user = max_translations_per_user == ~0 ?
4020 sm->max_translations : max_translations_per_user;
4022 sm->outside_vrf_id = outside_vrf_id;
4023 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
4026 nm->outside_vrf_id = outside_ip6_vrf_id;
4027 nm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6,
4030 sm->inside_vrf_id = inside_vrf_id;
4031 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
4034 sm->static_mapping_only = static_mapping_only;
4035 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
4037 nat64_set_hash (nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
4038 nat64_st_memory_size);
4040 if (sm->deterministic)
4042 sm->in2out_node_index = snat_det_in2out_node.index;
4043 sm->in2out_output_node_index = ~0;
4044 sm->out2in_node_index = snat_det_out2in_node.index;
4045 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
4046 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
4050 if (sm->endpoint_dependent)
4052 sm->worker_in2out_cb = nat44_ed_get_worker_in2out_cb;
4053 sm->worker_out2in_cb = nat44_ed_get_worker_out2in_cb;
4055 sm->handoff_out2in_index = nat_pre_out2in_node.index;
4056 sm->handoff_in2out_index = nat_pre_in2out_node.index;
4057 sm->handoff_in2out_output_index = nat44_ed_in2out_output_node.index;
4059 sm->in2out_node_index = nat44_ed_in2out_node.index;
4060 sm->in2out_output_node_index = nat44_ed_in2out_output_node.index;
4061 sm->out2in_node_index = nat44_ed_out2in_node.index;
4063 sm->icmp_match_in2out_cb = icmp_match_in2out_ed;
4064 sm->icmp_match_out2in_cb = icmp_match_out2in_ed;
4065 nat_affinity_init (vm);
4066 nat_ha_init (vm, nat_ha_sadd_ed_cb, nat_ha_sdel_ed_cb,
4071 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
4072 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
4074 sm->handoff_out2in_index = snat_out2in_node.index;
4075 sm->handoff_in2out_index = snat_in2out_node.index;
4076 sm->handoff_in2out_output_index = snat_in2out_output_node.index;
4078 sm->in2out_node_index = snat_in2out_node.index;
4079 sm->in2out_output_node_index = snat_in2out_output_node.index;
4080 sm->out2in_node_index = snat_out2in_node.index;
4081 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
4082 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
4083 nat_ha_init (vm, nat_ha_sadd_cb, nat_ha_sdel_cb, nat_ha_sref_cb);
4085 if (!static_mapping_only ||
4086 (static_mapping_only && static_mapping_connection_tracking))
4089 vec_foreach (tsm, sm->per_thread_data)
4091 pool_alloc (tsm->sessions, sm->max_translations);
4092 pool_alloc (tsm->list_pool, sm->max_translations);
4093 pool_alloc (tsm->global_lru_pool, sm->max_translations);
4096 pool_get (tsm->global_lru_pool, head);
4097 tsm->global_lru_head_index = head - tsm->global_lru_pool;
4098 clib_dlist_init (tsm->global_lru_pool,
4099 tsm->global_lru_head_index);
4101 if (sm->endpoint_dependent)
4103 clib_bihash_init_16_8 (&tsm->in2out_ed, "in2out-ed",
4104 translation_buckets,
4105 translation_memory_size);
4106 clib_bihash_set_kvp_format_fn_16_8 (&tsm->in2out_ed,
4107 format_ed_session_kvp);
4109 clib_bihash_init_16_8 (&tsm->out2in_ed, "out2in-ed",
4110 translation_buckets,
4111 translation_memory_size);
4112 clib_bihash_set_kvp_format_fn_16_8 (&tsm->out2in_ed,
4113 format_ed_session_kvp);
4117 clib_bihash_init_8_8 (&tsm->in2out, "in2out",
4118 translation_buckets,
4119 translation_memory_size);
4120 clib_bihash_set_kvp_format_fn_8_8 (&tsm->in2out,
4121 format_session_kvp);
4123 clib_bihash_init_8_8 (&tsm->out2in, "out2in",
4124 translation_buckets,
4125 translation_memory_size);
4126 clib_bihash_set_kvp_format_fn_8_8 (&tsm->out2in,
4127 format_session_kvp);
4130 clib_bihash_init_8_8 (&tsm->user_hash, "users", user_buckets,
4132 clib_bihash_set_kvp_format_fn_8_8 (&tsm->user_hash,
4140 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
4141 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
4143 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
4144 "static_mapping_by_local", static_mapping_buckets,
4145 static_mapping_memory_size);
4146 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_local,
4147 format_static_mapping_kvp);
4149 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
4150 "static_mapping_by_external",
4151 static_mapping_buckets,
4152 static_mapping_memory_size);
4153 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_external,
4154 format_static_mapping_kvp);
4160 VLIB_CONFIG_FUNCTION (snat_config, "nat");
4163 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
4166 ip4_address_t * address,
4168 u32 if_address_index, u32 is_delete)
4170 snat_main_t *sm = &snat_main;
4171 snat_static_map_resolve_t *rp;
4172 snat_static_mapping_t *m;
4173 snat_session_key_t m_key;
4174 clib_bihash_kv_8_8_t kv, value;
4176 ip4_address_t l_addr;
4178 for (i = 0; i < vec_len (sm->to_resolve); i++)
4180 rp = sm->to_resolve + i;
4181 if (rp->addr_only == 0)
4183 if (rp->sw_if_index == sw_if_index)
4190 m_key.addr.as_u32 = address->as_u32;
4191 m_key.port = rp->addr_only ? 0 : rp->e_port;
4192 m_key.protocol = rp->addr_only ? 0 : rp->proto;
4193 m_key.fib_index = sm->outside_fib_index;
4194 kv.key = m_key.as_u64;
4195 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
4198 m = pool_elt_at_index (sm->static_mappings, value.value);
4202 /* Don't trip over lease renewal, static config */
4212 /* Indetity mapping? */
4213 if (rp->l_addr.as_u32 == 0)
4214 l_addr.as_u32 = address[0].as_u32;
4216 l_addr.as_u32 = rp->l_addr.as_u32;
4217 /* Add the static mapping */
4218 rv = snat_add_static_mapping (l_addr,
4223 rp->addr_only, ~0 /* sw_if_index */ ,
4224 rp->proto, !is_delete, rp->twice_nat,
4225 rp->out2in_only, rp->tag, rp->identity_nat);
4227 nat_elog_notice_X1 ("snat_add_static_mapping returned %d", "i4", rv);
4231 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
4234 ip4_address_t * address,
4236 u32 if_address_index, u32 is_delete)
4238 snat_main_t *sm = &snat_main;
4239 snat_static_map_resolve_t *rp;
4240 ip4_address_t l_addr;
4244 snat_address_t *addresses = sm->addresses;
4246 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices); i++)
4248 if (sw_if_index == sm->auto_add_sw_if_indices[i])
4252 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices_twice_nat); i++)
4255 addresses = sm->twice_nat_addresses;
4256 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
4265 /* Don't trip over lease renewal, static config */
4266 for (j = 0; j < vec_len (addresses); j++)
4267 if (addresses[j].addr.as_u32 == address->as_u32)
4270 (void) snat_add_address (sm, address, ~0, twice_nat);
4271 /* Scan static map resolution vector */
4272 for (j = 0; j < vec_len (sm->to_resolve); j++)
4274 rp = sm->to_resolve + j;
4277 /* On this interface? */
4278 if (rp->sw_if_index == sw_if_index)
4280 /* Indetity mapping? */
4281 if (rp->l_addr.as_u32 == 0)
4282 l_addr.as_u32 = address[0].as_u32;
4284 l_addr.as_u32 = rp->l_addr.as_u32;
4285 /* Add the static mapping */
4286 rv = snat_add_static_mapping (l_addr,
4292 ~0 /* sw_if_index */ ,
4294 rp->is_add, rp->twice_nat,
4295 rp->out2in_only, rp->tag,
4298 nat_elog_notice_X1 ("snat_add_static_mapping returned %d",
4306 (void) snat_del_address (sm, address[0], 1, twice_nat);
4313 snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
4316 ip4_main_t *ip4_main = sm->ip4_main;
4317 ip4_address_t *first_int_addr;
4318 snat_static_map_resolve_t *rp;
4319 u32 *indices_to_delete = 0;
4321 u32 *auto_add_sw_if_indices =
4323 auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
4325 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0 /* just want the address */
4328 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
4330 if (auto_add_sw_if_indices[i] == sw_if_index)
4334 /* if have address remove it */
4336 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
4339 for (j = 0; j < vec_len (sm->to_resolve); j++)
4341 rp = sm->to_resolve + j;
4342 if (rp->sw_if_index == sw_if_index)
4343 vec_add1 (indices_to_delete, j);
4345 if (vec_len (indices_to_delete))
4347 for (j = vec_len (indices_to_delete) - 1; j >= 0; j--)
4348 vec_del1 (sm->to_resolve, j);
4349 vec_free (indices_to_delete);
4353 vec_del1 (sm->auto_add_sw_if_indices_twice_nat, i);
4355 vec_del1 (sm->auto_add_sw_if_indices, i);
4358 return VNET_API_ERROR_VALUE_EXIST;
4365 return VNET_API_ERROR_NO_SUCH_ENTRY;
4367 /* add to the auto-address list */
4369 vec_add1 (sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
4371 vec_add1 (sm->auto_add_sw_if_indices, sw_if_index);
4373 /* If the address is already bound - or static - add it now */
4375 (void) snat_add_address (sm, first_int_addr, ~0, twice_nat);
4381 nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4382 snat_protocol_t proto, u32 vrf_id, int is_in)
4384 snat_main_per_thread_data_t *tsm;
4385 clib_bihash_kv_8_8_t kv, value;
4387 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4388 snat_session_key_t key;
4390 clib_bihash_8_8_t *t;
4392 if (sm->endpoint_dependent)
4393 return VNET_API_ERROR_UNSUPPORTED;
4395 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4396 if (sm->num_workers > 1)
4398 vec_elt_at_index (sm->per_thread_data,
4399 sm->worker_in2out_cb (&ip, fib_index, 0));
4401 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4403 key.addr.as_u32 = addr->as_u32;
4404 key.port = clib_host_to_net_u16 (port);
4405 key.protocol = proto;
4406 key.fib_index = fib_index;
4407 kv.key = key.as_u64;
4408 t = is_in ? &tsm->in2out : &tsm->out2in;
4409 if (!clib_bihash_search_8_8 (t, &kv, &value))
4411 if (pool_is_free_index (tsm->sessions, value.value))
4412 return VNET_API_ERROR_UNSPECIFIED;
4414 s = pool_elt_at_index (tsm->sessions, value.value);
4415 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4416 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4420 return VNET_API_ERROR_NO_SUCH_ENTRY;
4424 nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4425 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
4426 u32 vrf_id, int is_in)
4429 clib_bihash_16_8_t *t;
4430 nat_ed_ses_key_t key;
4431 clib_bihash_kv_16_8_t kv, value;
4432 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4434 snat_main_per_thread_data_t *tsm;
4436 if (!sm->endpoint_dependent)
4437 return VNET_API_ERROR_FEATURE_DISABLED;
4439 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4440 if (sm->num_workers > 1)
4442 vec_elt_at_index (sm->per_thread_data,
4443 sm->worker_in2out_cb (&ip, fib_index, 0));
4445 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4447 t = is_in ? &tsm->in2out_ed : &tsm->out2in_ed;
4448 key.l_addr.as_u32 = addr->as_u32;
4449 key.r_addr.as_u32 = eh_addr->as_u32;
4450 key.l_port = clib_host_to_net_u16 (port);
4451 key.r_port = clib_host_to_net_u16 (eh_port);
4453 key.fib_index = fib_index;
4454 kv.key[0] = key.as_u64[0];
4455 kv.key[1] = key.as_u64[1];
4456 if (clib_bihash_search_16_8 (t, &kv, &value))
4457 return VNET_API_ERROR_NO_SUCH_ENTRY;
4459 if (pool_is_free_index (tsm->sessions, value.value))
4460 return VNET_API_ERROR_UNSPECIFIED;
4461 s = pool_elt_at_index (tsm->sessions, value.value);
4462 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4463 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4468 nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset, u16 psid_length)
4470 snat_main_t *sm = &snat_main;
4472 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_MAPE;
4473 sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
4475 sm->psid_offset = psid_offset;
4476 sm->psid_length = psid_length;
4480 nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port)
4482 snat_main_t *sm = &snat_main;
4484 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_RANGE;
4485 sm->alloc_addr_and_port = nat_alloc_addr_and_port_range;
4486 sm->start_port = start_port;
4487 sm->end_port = end_port;
4491 nat_set_alloc_addr_and_port_default (void)
4493 snat_main_t *sm = &snat_main;
4495 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
4496 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
4499 VLIB_NODE_FN (nat_default_node) (vlib_main_t * vm,
4500 vlib_node_runtime_t * node,
4501 vlib_frame_t * frame)
4507 VLIB_REGISTER_NODE (nat_default_node) = {
4508 .name = "nat-default",
4509 .vector_size = sizeof (u32),
4511 .type = VLIB_NODE_TYPE_INTERNAL,
4513 .n_next_nodes = NAT_N_NEXT,
4515 [NAT_NEXT_DROP] = "error-drop",
4516 [NAT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
4517 [NAT_NEXT_IN2OUT_PRE] = "nat-pre-in2out",
4518 [NAT_NEXT_OUT2IN_PRE] = "nat-pre-out2in",
4519 [NAT_NEXT_IN2OUT_ED_FAST_PATH] = "nat44-ed-in2out",
4520 [NAT_NEXT_IN2OUT_ED_SLOW_PATH] = "nat44-ed-in2out-slowpath",
4521 [NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH] = "nat44-ed-in2out-output-slowpath",
4522 [NAT_NEXT_OUT2IN_ED_FAST_PATH] = "nat44-ed-out2in",
4523 [NAT_NEXT_OUT2IN_ED_SLOW_PATH] = "nat44-ed-out2in-slowpath",
4529 * fd.io coding-style-patch-verification: ON
4532 * eval: (c-set-style "gnu")