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 ed_bihash_kv_t bihash_key;
327 clib_memset (&bihash_key, 0, sizeof (bihash_key));
328 bihash_key.k.dst_address = s->ext_host_addr.as_u32;
329 bihash_key.k.dst_port = s->ext_host_port;
330 bihash_key.k.src_address = s->out2in.addr.as_u32;
331 bihash_key.k.src_port = s->out2in.port;
332 bihash_key.k.protocol = s->out2in.protocol;
333 if (sm->ed_ext_ports.instantiated)
334 clib_bihash_add_del_16_8 (&sm->ed_ext_ports, &bihash_key.kv,
337 snat_free_outside_address_and_port (sm->addresses, thread_index,
342 nat44_free_session_data (snat_main_t * sm, snat_session_t * s,
343 u32 thread_index, u8 is_ha)
345 snat_session_key_t key;
346 nat_ed_ses_key_t ed_key;
347 clib_bihash_kv_16_8_t ed_kv;
348 snat_main_per_thread_data_t *tsm =
349 vec_elt_at_index (sm->per_thread_data, thread_index);
351 if (is_fwd_bypass_session (s))
353 if (snat_is_unk_proto_session (s))
355 ed_key.proto = s->in2out.port;
361 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
362 ed_key.l_port = s->in2out.port;
363 ed_key.r_port = s->ext_host_port;
366 ed_key.l_addr = s->in2out.addr;
367 ed_key.r_addr = s->ext_host_addr;
368 ed_key.fib_index = 0;
369 ed_kv.key[0] = ed_key.as_u64[0];
370 ed_kv.key[1] = ed_key.as_u64[1];
373 (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0)))
374 nat_elog_warn ("in2out_ed key del failed");
378 /* session lookup tables */
379 if (is_affinity_sessions (s))
380 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
381 s->in2out.protocol, s->out2in.port);
382 ed_key.l_addr = s->out2in.addr;
383 ed_key.r_addr = s->ext_host_addr;
384 ed_key.fib_index = s->out2in.fib_index;
385 if (snat_is_unk_proto_session (s))
387 ed_key.proto = s->in2out.port;
393 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
394 ed_key.l_port = s->out2in.port;
395 ed_key.r_port = s->ext_host_port;
397 ed_kv.key[0] = ed_key.as_u64[0];
398 ed_kv.key[1] = ed_key.as_u64[1];
400 if (PREDICT_FALSE (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &ed_kv, 0)))
401 nat_elog_warn ("out2in_ed key del failed");
403 ed_key.l_addr = s->in2out.addr;
404 ed_key.fib_index = s->in2out.fib_index;
406 if (!snat_is_unk_proto_session (s))
407 ed_key.l_port = s->in2out.port;
409 if (is_twice_nat_session (s))
411 ed_key.r_addr = s->ext_host_nat_addr;
412 ed_key.r_port = s->ext_host_nat_port;
415 ed_kv.key[0] = ed_key.as_u64[0];
416 ed_kv.key[1] = ed_key.as_u64[1];
418 if (PREDICT_FALSE (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0)))
419 nat_elog_warn ("in2out_ed key del failed");
423 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
424 &s->in2out.addr, s->in2out.port,
425 &s->ext_host_nat_addr, s->ext_host_nat_port,
426 &s->out2in.addr, s->out2in.port,
427 &s->ext_host_addr, s->ext_host_port,
428 s->in2out.protocol, is_twice_nat_session (s));
431 if (snat_is_unk_proto_session (s))
437 snat_ipfix_logging_nat44_ses_delete (thread_index,
438 s->in2out.addr.as_u32,
439 s->out2in.addr.as_u32,
443 s->in2out.fib_index);
444 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
445 s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
449 /* Twice NAT address and port for external host */
450 if (is_twice_nat_session (s))
452 key.protocol = s->in2out.protocol;
453 key.port = s->ext_host_nat_port;
454 key.addr.as_u32 = s->ext_host_nat_addr.as_u32;
455 snat_free_outside_address_and_port (sm->twice_nat_addresses,
459 if (snat_is_session_static (s))
462 ed_bihash_kv_t bihash_key;
463 clib_memset (&bihash_key, 0, sizeof (bihash_key));
464 bihash_key.k.dst_address = s->ext_host_addr.as_u32;
465 bihash_key.k.dst_port = s->ext_host_port;
466 bihash_key.k.src_address = s->out2in.addr.as_u32;
467 bihash_key.k.src_port = s->out2in.port;
468 bihash_key.k.protocol = s->out2in.protocol;
469 if (sm->ed_ext_ports.instantiated)
470 clib_bihash_add_del_16_8 (&sm->ed_ext_ports, &bihash_key.kv,
473 // should be called for every dynamic session
474 snat_free_outside_address_and_port (sm->addresses, thread_index,
480 nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr, u32 fib_index,
484 snat_user_key_t user_key;
485 clib_bihash_kv_8_8_t kv, value;
486 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
487 dlist_elt_t *per_user_list_head_elt;
489 user_key.addr.as_u32 = addr->as_u32;
490 user_key.fib_index = fib_index;
491 kv.key = user_key.as_u64;
493 /* Ever heard of the "user" = src ip4 address before? */
494 if (clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
496 /* no, make a new one */
497 pool_get (tsm->users, u);
498 clib_memset (u, 0, sizeof (*u));
500 u->addr.as_u32 = addr->as_u32;
501 u->fib_index = fib_index;
503 pool_get (tsm->list_pool, per_user_list_head_elt);
505 u->sessions_per_user_list_head_index = per_user_list_head_elt -
508 clib_dlist_init (tsm->list_pool, u->sessions_per_user_list_head_index);
510 kv.value = u - tsm->users;
513 if (clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 1))
515 nat_elog_warn ("user_hash key add failed");
516 nat44_delete_user_with_no_session (sm, u, thread_index);
520 vlib_set_simple_counter (&sm->total_users, thread_index, 0,
521 pool_elts (tsm->users));
525 u = pool_elt_at_index (tsm->users, value.value);
532 nat_session_alloc_or_recycle (snat_main_t * sm, snat_user_t * u,
533 u32 thread_index, f64 now)
536 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
537 u32 oldest_per_user_translation_list_index, session_index;
538 dlist_elt_t *oldest_per_user_translation_list_elt;
539 dlist_elt_t *per_user_translation_list_elt;
541 /* Over quota? Recycle the least recently used translation */
542 if ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user)
544 oldest_per_user_translation_list_index =
545 clib_dlist_remove_head (tsm->list_pool,
546 u->sessions_per_user_list_head_index);
548 ASSERT (oldest_per_user_translation_list_index != ~0);
550 /* Add it back to the end of the LRU list */
551 clib_dlist_addtail (tsm->list_pool,
552 u->sessions_per_user_list_head_index,
553 oldest_per_user_translation_list_index);
554 /* Get the list element */
555 oldest_per_user_translation_list_elt =
556 pool_elt_at_index (tsm->list_pool,
557 oldest_per_user_translation_list_index);
559 /* Get the session index from the list element */
560 session_index = oldest_per_user_translation_list_elt->value;
562 /* Get the session */
563 s = pool_elt_at_index (tsm->sessions, session_index);
564 nat_free_session_data (sm, s, thread_index, 0);
565 if (snat_is_session_static (s))
566 u->nstaticsessions--;
573 s->ext_host_addr.as_u32 = 0;
574 s->ext_host_port = 0;
575 s->ext_host_nat_addr.as_u32 = 0;
576 s->ext_host_nat_port = 0;
580 pool_get (tsm->sessions, s);
581 clib_memset (s, 0, sizeof (*s));
583 /* Create list elts */
584 pool_get (tsm->list_pool, per_user_translation_list_elt);
585 clib_dlist_init (tsm->list_pool,
586 per_user_translation_list_elt - tsm->list_pool);
588 per_user_translation_list_elt->value = s - tsm->sessions;
589 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
590 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
592 clib_dlist_addtail (tsm->list_pool,
593 s->per_user_list_head_index,
594 per_user_translation_list_elt - tsm->list_pool);
596 dlist_elt_t *global_lru_list_elt;
597 pool_get (tsm->global_lru_pool, global_lru_list_elt);
598 global_lru_list_elt->value = s - tsm->sessions;
599 s->global_lru_index = global_lru_list_elt - tsm->global_lru_pool;
600 clib_dlist_addtail (tsm->global_lru_pool, tsm->global_lru_head_index,
601 s->global_lru_index);
602 s->last_lru_update = now;
604 s->user_index = u - tsm->users;
605 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
606 pool_elts (tsm->sessions));
609 s->ha_last_refreshed = now;
615 nat_ed_session_alloc (snat_main_t * sm, snat_user_t * u, u32 thread_index,
618 snat_session_t *s = NULL;
619 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
621 dlist_elt_t *oldest_elt;
622 u64 sess_timeout_time;
626 if (PREDICT_FALSE (!(u->nsessions) && !(u->nstaticsessions)))
631 ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user))
633 nat_elog_addr (SNAT_LOG_WARNING, "[warn] max translations per user",
634 clib_net_to_host_u32 (u->addr.as_u32));
635 snat_ipfix_logging_max_entries_per_user (thread_index,
636 sm->max_translations_per_user,
641 /* first try to reuse an expired session from this ip */
643 clib_dlist_remove_head (tsm->list_pool,
644 u->sessions_per_user_list_head_index);
645 oldest_elt = pool_elt_at_index (tsm->list_pool, oldest_index);
646 s = pool_elt_at_index (tsm->sessions, oldest_elt->value);
648 sess_timeout_time = s->last_heard + (f64) nat44_session_get_timeout (sm, s);
649 if (now >= sess_timeout_time ||
650 (s->tcp_close_timestamp && now >= s->tcp_close_timestamp))
653 clib_dlist_addtail (tsm->list_pool,
654 u->sessions_per_user_list_head_index, oldest_index);
655 s = nat44_session_reuse_old (sm, u, s, thread_index, now);
656 s->last_lru_update = now;
660 clib_dlist_addhead (tsm->list_pool,
661 u->sessions_per_user_list_head_index, oldest_index);
666 /* try to free an expired session from global LRU list */
669 oldest_index = clib_dlist_remove_head (tsm->global_lru_pool,
670 tsm->global_lru_head_index);
671 if (~0 != oldest_index)
673 oldest_elt = pool_elt_at_index (tsm->global_lru_pool, oldest_index);
674 s = pool_elt_at_index (tsm->sessions, oldest_elt->value);
677 s->last_heard + (f64) nat44_session_get_timeout (sm, s);
678 if (now >= sess_timeout_time
679 || (s->tcp_close_timestamp && now >= s->tcp_close_timestamp))
681 nat_free_session_data (sm, s, thread_index, 0);
682 nat44_ed_delete_session (sm, s, thread_index, 0);
686 clib_dlist_addhead (tsm->global_lru_pool,
687 tsm->global_lru_head_index, oldest_index);
694 s = nat44_session_alloc_new (tsm, u, now);
695 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
696 pool_elts (tsm->sessions));
702 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
705 fib_prefix_t prefix = {
707 .fp_proto = FIB_PROTOCOL_IP4,
709 .ip4.as_u32 = addr->as_u32,
712 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
715 fib_table_entry_update_one_path (fib_index,
718 (FIB_ENTRY_FLAG_CONNECTED |
719 FIB_ENTRY_FLAG_LOCAL |
720 FIB_ENTRY_FLAG_EXCLUSIVE),
724 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
726 fib_table_entry_delete (fib_index, &prefix, nat_fib_src_low);
730 snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
735 vlib_thread_main_t *tm = vlib_get_thread_main ();
737 if (twice_nat && !sm->endpoint_dependent)
738 return VNET_API_ERROR_FEATURE_DISABLED;
740 /* Check if address already exists */
742 vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
744 if (ap->addr.as_u32 == addr->as_u32)
745 return VNET_API_ERROR_VALUE_EXIST;
750 vec_add2 (sm->twice_nat_addresses, ap, 1);
752 vec_add2 (sm->addresses, ap, 1);
757 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
761 #define _(N, i, n, s) \
762 clib_memset(ap->busy_##n##_port_refcounts, 0, sizeof(ap->busy_##n##_port_refcounts));\
763 ap->busy_##n##_ports = 0; \
764 ap->busy_##n##_ports_per_thread = 0;\
765 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
766 foreach_snat_protocol
771 /* Add external address to FIB */
773 pool_foreach (i, sm->interfaces,
775 if (nat_interface_is_inside(i) || sm->out2in_dpo)
778 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
781 pool_foreach (i, sm->output_feature_interfaces,
783 if (nat_interface_is_inside(i) || sm->out2in_dpo)
786 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
795 is_snat_address_used_in_static_mapping (snat_main_t * sm, ip4_address_t addr)
797 snat_static_mapping_t *m;
799 pool_foreach (m, sm->static_mappings,
801 if (is_addr_only_static_mapping (m) ||
802 is_out2in_only_static_mapping (m) ||
803 is_identity_static_mapping (m))
805 if (m->external_addr.as_u32 == addr.as_u32)
814 snat_add_static_mapping_when_resolved (snat_main_t * sm,
815 ip4_address_t l_addr,
820 snat_protocol_t proto,
821 int addr_only, int is_add, u8 * tag,
822 int twice_nat, int out2in_only,
825 snat_static_map_resolve_t *rp;
827 vec_add2 (sm->to_resolve, rp, 1);
828 rp->l_addr.as_u32 = l_addr.as_u32;
830 rp->sw_if_index = sw_if_index;
834 rp->addr_only = addr_only;
836 rp->twice_nat = twice_nat;
837 rp->out2in_only = out2in_only;
838 rp->identity_nat = identity_nat;
839 rp->tag = vec_dup (tag);
843 get_thread_idx_by_port (u16 e_port)
845 snat_main_t *sm = &snat_main;
846 u32 thread_idx = sm->num_workers;
847 if (sm->num_workers > 1)
850 sm->first_worker_index +
851 sm->workers[(e_port - 1024) / sm->port_per_thread];
857 snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
858 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
859 u32 sw_if_index, snat_protocol_t proto, int is_add,
860 twice_nat_type_t twice_nat, u8 out2in_only, u8 * tag,
863 snat_main_t *sm = &snat_main;
864 snat_static_mapping_t *m;
865 snat_session_key_t m_key;
866 clib_bihash_kv_8_8_t kv, value;
867 snat_address_t *a = 0;
869 snat_interface_t *interface;
871 snat_main_per_thread_data_t *tsm;
872 snat_user_key_t u_key;
874 dlist_elt_t *head, *elt;
875 u32 elt_index, head_index;
879 snat_static_map_resolve_t *rp, *rp_match = 0;
880 nat44_lb_addr_port_t *local;
883 if (!sm->endpoint_dependent)
885 if (twice_nat || out2in_only)
886 return VNET_API_ERROR_FEATURE_DISABLED;
889 /* If the external address is a specific interface address */
890 if (sw_if_index != ~0)
892 ip4_address_t *first_int_addr;
894 for (i = 0; i < vec_len (sm->to_resolve); i++)
896 rp = sm->to_resolve + i;
897 if (rp->sw_if_index != sw_if_index ||
898 rp->l_addr.as_u32 != l_addr.as_u32 ||
899 rp->vrf_id != vrf_id || rp->addr_only != addr_only)
904 if ((rp->l_port != l_port && rp->e_port != e_port)
905 || rp->proto != proto)
913 /* Might be already set... */
914 first_int_addr = ip4_interface_first_address
915 (sm->ip4_main, sw_if_index, 0 /* just want the address */ );
920 return VNET_API_ERROR_VALUE_EXIST;
922 snat_add_static_mapping_when_resolved
923 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
924 addr_only, is_add, tag, twice_nat, out2in_only, identity_nat);
926 /* DHCP resolution required? */
927 if (first_int_addr == 0)
933 e_addr.as_u32 = first_int_addr->as_u32;
934 /* Identity mapping? */
935 if (l_addr.as_u32 == 0)
936 l_addr.as_u32 = e_addr.as_u32;
942 return VNET_API_ERROR_NO_SUCH_ENTRY;
944 vec_del1 (sm->to_resolve, i);
948 e_addr.as_u32 = first_int_addr->as_u32;
949 /* Identity mapping? */
950 if (l_addr.as_u32 == 0)
951 l_addr.as_u32 = e_addr.as_u32;
959 m_key.port = addr_only ? 0 : e_port;
960 m_key.protocol = addr_only ? 0 : proto;
962 kv.key = m_key.as_u64;
963 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
966 m = pool_elt_at_index (sm->static_mappings, value.value);
972 if (is_identity_static_mapping (m))
975 pool_foreach (local, m->locals,
977 if (local->vrf_id == vrf_id)
978 return VNET_API_ERROR_VALUE_EXIST;
981 pool_get (m->locals, local);
982 local->vrf_id = vrf_id;
984 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
986 m_key.addr = m->local_addr;
987 m_key.port = m->local_port;
988 m_key.protocol = m->proto;
989 m_key.fib_index = local->fib_index;
990 kv.key = m_key.as_u64;
991 kv.value = m - sm->static_mappings;
992 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
996 return VNET_API_ERROR_VALUE_EXIST;
999 if (twice_nat && addr_only)
1000 return VNET_API_ERROR_UNSUPPORTED;
1002 /* Convert VRF id to FIB index */
1005 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1007 /* If not specified use inside VRF id from SNAT plugin startup config */
1010 fib_index = sm->inside_fib_index;
1011 vrf_id = sm->inside_vrf_id;
1012 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1015 if (!(out2in_only || identity_nat))
1017 m_key.addr = l_addr;
1018 m_key.port = addr_only ? 0 : l_port;
1019 m_key.protocol = addr_only ? 0 : proto;
1020 m_key.fib_index = fib_index;
1021 kv.key = m_key.as_u64;
1022 if (!clib_bihash_search_8_8
1023 (&sm->static_mapping_by_local, &kv, &value))
1024 return VNET_API_ERROR_VALUE_EXIST;
1027 /* Find external address in allocated addresses and reserve port for
1028 address and port pair mapping when dynamic translations enabled */
1029 if (!(addr_only || sm->static_mapping_only || out2in_only))
1031 for (i = 0; i < vec_len (sm->addresses); i++)
1033 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1035 a = sm->addresses + i;
1036 /* External port must be unused */
1039 #define _(N, j, n, s) \
1040 case SNAT_PROTOCOL_##N: \
1041 if (a->busy_##n##_port_refcounts[e_port]) \
1042 return VNET_API_ERROR_INVALID_VALUE; \
1043 ++a->busy_##n##_port_refcounts[e_port]; \
1044 if (e_port > 1024) \
1046 a->busy_##n##_ports++; \
1047 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1050 foreach_snat_protocol
1053 nat_elog_info ("unknown protocol");
1054 return VNET_API_ERROR_INVALID_VALUE_2;
1059 /* External address must be allocated */
1060 if (!a && (l_addr.as_u32 != e_addr.as_u32))
1062 if (sw_if_index != ~0)
1064 for (i = 0; i < vec_len (sm->to_resolve); i++)
1066 rp = sm->to_resolve + i;
1069 if (rp->sw_if_index != sw_if_index &&
1070 rp->l_addr.as_u32 != l_addr.as_u32 &&
1071 rp->vrf_id != vrf_id && rp->l_port != l_port &&
1072 rp->e_port != e_port && rp->proto != proto)
1075 vec_del1 (sm->to_resolve, i);
1079 return VNET_API_ERROR_NO_SUCH_ENTRY;
1083 pool_get (sm->static_mappings, m);
1084 clib_memset (m, 0, sizeof (*m));
1085 m->tag = vec_dup (tag);
1086 m->local_addr = l_addr;
1087 m->external_addr = e_addr;
1088 m->twice_nat = twice_nat;
1090 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1092 m->flags |= NAT_STATIC_MAPPING_FLAG_ADDR_ONLY;
1095 m->flags |= NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT;
1096 pool_get (m->locals, local);
1097 local->vrf_id = vrf_id;
1098 local->fib_index = fib_index;
1103 m->fib_index = fib_index;
1107 m->local_port = l_port;
1108 m->external_port = e_port;
1112 if (sm->num_workers > 1)
1115 .src_address = m->local_addr,
1117 vec_add1 (m->workers, sm->worker_in2out_cb (&ip, m->fib_index, 0));
1118 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1121 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1123 m_key.addr = m->local_addr;
1124 m_key.port = m->local_port;
1125 m_key.protocol = m->proto;
1126 m_key.fib_index = fib_index;
1127 kv.key = m_key.as_u64;
1128 kv.value = m - sm->static_mappings;
1130 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1132 m_key.addr = m->external_addr;
1133 m_key.port = m->external_port;
1134 m_key.fib_index = 0;
1135 kv.key = m_key.as_u64;
1136 kv.value = m - sm->static_mappings;
1137 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1);
1139 /* Delete dynamic sessions matching local address (+ local port) */
1140 if (!(sm->static_mapping_only))
1142 u_key.addr = m->local_addr;
1143 u_key.fib_index = m->fib_index;
1144 kv.key = u_key.as_u64;
1145 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1147 user_index = value.value;
1148 u = pool_elt_at_index (tsm->users, user_index);
1151 head_index = u->sessions_per_user_list_head_index;
1152 head = pool_elt_at_index (tsm->list_pool, head_index);
1153 elt_index = head->next;
1154 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1155 ses_index = elt->value;
1156 while (ses_index != ~0)
1158 s = pool_elt_at_index (tsm->sessions, ses_index);
1159 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1160 ses_index = elt->value;
1162 if (snat_is_session_static (s))
1166 && (clib_net_to_host_u16 (s->in2out.port) !=
1170 nat_free_session_data (sm, s,
1171 tsm - sm->per_thread_data, 0);
1172 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1174 if (!addr_only && !sm->endpoint_dependent)
1185 if (sw_if_index != ~0)
1188 return VNET_API_ERROR_NO_SUCH_ENTRY;
1194 vrf_id = sm->inside_vrf_id;
1197 pool_foreach (local, m->locals,
1199 if (local->vrf_id == vrf_id)
1200 find = local - m->locals;
1204 return VNET_API_ERROR_NO_SUCH_ENTRY;
1206 local = pool_elt_at_index (m->locals, find);
1207 fib_index = local->fib_index;
1208 pool_put (m->locals, local);
1211 fib_index = m->fib_index;
1213 /* Free external address port */
1214 if (!(addr_only || sm->static_mapping_only || out2in_only))
1216 for (i = 0; i < vec_len (sm->addresses); i++)
1218 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1220 a = sm->addresses + i;
1223 #define _(N, j, n, s) \
1224 case SNAT_PROTOCOL_##N: \
1225 --a->busy_##n##_port_refcounts[e_port]; \
1226 if (e_port > 1024) \
1228 a->busy_##n##_ports--; \
1229 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1232 foreach_snat_protocol
1235 nat_elog_info ("unknown protocol");
1236 return VNET_API_ERROR_INVALID_VALUE_2;
1243 if (sm->num_workers > 1)
1244 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1246 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1248 m_key.addr = m->local_addr;
1249 m_key.port = m->local_port;
1250 m_key.protocol = m->proto;
1251 m_key.fib_index = fib_index;
1252 kv.key = m_key.as_u64;
1254 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0);
1256 /* Delete session(s) for static mapping if exist */
1257 if (!(sm->static_mapping_only) ||
1258 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
1260 u_key.addr = m->local_addr;
1261 u_key.fib_index = fib_index;
1262 kv.key = u_key.as_u64;
1263 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1265 user_index = value.value;
1266 u = pool_elt_at_index (tsm->users, user_index);
1267 if (u->nstaticsessions)
1269 head_index = u->sessions_per_user_list_head_index;
1270 head = pool_elt_at_index (tsm->list_pool, head_index);
1271 elt_index = head->next;
1272 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1273 ses_index = elt->value;
1274 while (ses_index != ~0)
1276 s = pool_elt_at_index (tsm->sessions, ses_index);
1277 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1278 ses_index = elt->value;
1282 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
1283 (clib_net_to_host_u16 (s->out2in.port) !=
1288 if (is_lb_session (s))
1291 if (!snat_is_session_static (s))
1294 nat_free_session_data (sm, s,
1295 tsm - sm->per_thread_data, 0);
1296 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1298 if (!addr_only && !sm->endpoint_dependent)
1305 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1306 if (pool_elts (m->locals))
1309 m_key.addr = m->external_addr;
1310 m_key.port = m->external_port;
1311 m_key.fib_index = 0;
1312 kv.key = m_key.as_u64;
1313 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0);
1316 vec_free (m->workers);
1317 /* Delete static mapping from pool */
1318 pool_put (sm->static_mappings, m);
1321 if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
1324 /* Add/delete external address to FIB */
1326 pool_foreach (interface, sm->interfaces,
1328 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1331 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1334 pool_foreach (interface, sm->output_feature_interfaces,
1336 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1339 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1348 nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1349 snat_protocol_t proto,
1350 nat44_lb_addr_port_t * locals, u8 is_add,
1351 twice_nat_type_t twice_nat, u8 out2in_only,
1352 u8 * tag, u32 affinity)
1354 snat_main_t *sm = &snat_main;
1355 snat_static_mapping_t *m;
1356 snat_session_key_t m_key;
1357 clib_bihash_kv_8_8_t kv, value;
1358 snat_address_t *a = 0;
1360 nat44_lb_addr_port_t *local;
1361 u32 elt_index, head_index, ses_index;
1362 snat_main_per_thread_data_t *tsm;
1363 snat_user_key_t u_key;
1366 dlist_elt_t *head, *elt;
1369 if (!sm->endpoint_dependent)
1370 return VNET_API_ERROR_FEATURE_DISABLED;
1372 m_key.addr = e_addr;
1373 m_key.port = e_port;
1374 m_key.protocol = proto;
1375 m_key.fib_index = 0;
1376 kv.key = m_key.as_u64;
1377 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1380 m = pool_elt_at_index (sm->static_mappings, value.value);
1385 return VNET_API_ERROR_VALUE_EXIST;
1387 if (vec_len (locals) < 2)
1388 return VNET_API_ERROR_INVALID_VALUE;
1390 /* Find external address in allocated addresses and reserve port for
1391 address and port pair mapping when dynamic translations enabled */
1392 if (!(sm->static_mapping_only || out2in_only))
1394 for (i = 0; i < vec_len (sm->addresses); i++)
1396 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1398 a = sm->addresses + i;
1399 /* External port must be unused */
1402 #define _(N, j, n, s) \
1403 case SNAT_PROTOCOL_##N: \
1404 if (a->busy_##n##_port_refcounts[e_port]) \
1405 return VNET_API_ERROR_INVALID_VALUE; \
1406 ++a->busy_##n##_port_refcounts[e_port]; \
1407 if (e_port > 1024) \
1409 a->busy_##n##_ports++; \
1410 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1413 foreach_snat_protocol
1416 nat_elog_info ("unknown protocol");
1417 return VNET_API_ERROR_INVALID_VALUE_2;
1422 /* External address must be allocated */
1424 return VNET_API_ERROR_NO_SUCH_ENTRY;
1427 pool_get (sm->static_mappings, m);
1428 clib_memset (m, 0, sizeof (*m));
1429 m->tag = vec_dup (tag);
1430 m->external_addr = e_addr;
1431 m->external_port = e_port;
1433 m->twice_nat = twice_nat;
1434 m->flags |= NAT_STATIC_MAPPING_FLAG_LB;
1436 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1437 m->affinity = affinity;
1440 m->affinity_per_service_list_head_index =
1441 nat_affinity_get_per_service_list_head_index ();
1443 m->affinity_per_service_list_head_index = ~0;
1445 m_key.addr = m->external_addr;
1446 m_key.port = m->external_port;
1447 m_key.protocol = m->proto;
1448 m_key.fib_index = 0;
1449 kv.key = m_key.as_u64;
1450 kv.value = m - sm->static_mappings;
1451 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1))
1453 nat_elog_err ("static_mapping_by_external key add failed");
1454 return VNET_API_ERROR_UNSPECIFIED;
1457 m_key.fib_index = m->fib_index;
1458 for (i = 0; i < vec_len (locals); i++)
1460 locals[i].fib_index =
1461 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
1464 m_key.addr = locals[i].addr;
1465 m_key.fib_index = locals[i].fib_index;
1468 m_key.port = locals[i].port;
1469 kv.key = m_key.as_u64;
1470 kv.value = m - sm->static_mappings;
1471 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1473 locals[i].prefix = (i == 0) ? locals[i].probability :
1474 (locals[i - 1].prefix + locals[i].probability);
1475 pool_get (m->locals, local);
1477 if (sm->num_workers > 1)
1480 .src_address = locals[i].addr,
1483 clib_bitmap_set (bitmap,
1484 sm->worker_in2out_cb (&ip, m->fib_index, 0),
1489 /* Assign workers */
1490 if (sm->num_workers > 1)
1493 clib_bitmap_foreach (i, bitmap,
1495 vec_add1(m->workers, i);
1503 return VNET_API_ERROR_NO_SUCH_ENTRY;
1505 if (!is_lb_static_mapping (m))
1506 return VNET_API_ERROR_INVALID_VALUE;
1508 /* Free external address port */
1509 if (!(sm->static_mapping_only || out2in_only))
1511 for (i = 0; i < vec_len (sm->addresses); i++)
1513 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1515 a = sm->addresses + i;
1518 #define _(N, j, n, s) \
1519 case SNAT_PROTOCOL_##N: \
1520 --a->busy_##n##_port_refcounts[e_port]; \
1521 if (e_port > 1024) \
1523 a->busy_##n##_ports--; \
1524 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1527 foreach_snat_protocol
1530 nat_elog_info ("unknown protocol");
1531 return VNET_API_ERROR_INVALID_VALUE_2;
1538 m_key.addr = m->external_addr;
1539 m_key.port = m->external_port;
1540 m_key.protocol = m->proto;
1541 m_key.fib_index = 0;
1542 kv.key = m_key.as_u64;
1543 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0))
1545 nat_elog_err ("static_mapping_by_external key del failed");
1546 return VNET_API_ERROR_UNSPECIFIED;
1550 pool_foreach (local, m->locals,
1552 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4,
1554 m_key.addr = local->addr;
1557 m_key.port = local->port;
1558 m_key.fib_index = local->fib_index;
1559 kv.key = m_key.as_u64;
1560 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1562 nat_elog_err ("static_mapping_by_local key del failed");
1563 return VNET_API_ERROR_UNSPECIFIED;
1567 if (sm->num_workers > 1)
1570 .src_address = local->addr,
1572 tsm = vec_elt_at_index (sm->per_thread_data,
1573 sm->worker_in2out_cb (&ip, m->fib_index, 0));
1576 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1578 /* Delete sessions */
1579 u_key.addr = local->addr;
1580 u_key.fib_index = local->fib_index;
1581 kv.key = u_key.as_u64;
1582 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1584 u = pool_elt_at_index (tsm->users, value.value);
1585 if (u->nstaticsessions)
1587 head_index = u->sessions_per_user_list_head_index;
1588 head = pool_elt_at_index (tsm->list_pool, head_index);
1589 elt_index = head->next;
1590 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1591 ses_index = elt->value;
1592 while (ses_index != ~0)
1594 s = pool_elt_at_index (tsm->sessions, ses_index);
1595 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1596 ses_index = elt->value;
1598 if (!(is_lb_session (s)))
1601 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1602 (clib_net_to_host_u16 (s->in2out.port) != local->port))
1605 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1606 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1613 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1614 pool_free (m->locals);
1616 vec_free (m->workers);
1618 pool_put (sm->static_mappings, m);
1625 nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1626 ip4_address_t l_addr, u16 l_port,
1627 snat_protocol_t proto, u32 vrf_id,
1628 u8 probability, u8 is_add)
1630 snat_main_t *sm = &snat_main;
1631 snat_static_mapping_t *m = 0;
1632 snat_session_key_t m_key;
1633 clib_bihash_kv_8_8_t kv, value;
1634 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1635 snat_main_per_thread_data_t *tsm;
1636 snat_user_key_t u_key;
1639 dlist_elt_t *head, *elt;
1640 u32 elt_index, head_index, ses_index, *locals = 0;
1644 if (!sm->endpoint_dependent)
1645 return VNET_API_ERROR_FEATURE_DISABLED;
1647 m_key.addr = e_addr;
1648 m_key.port = e_port;
1649 m_key.protocol = proto;
1650 m_key.fib_index = 0;
1651 kv.key = m_key.as_u64;
1652 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1653 m = pool_elt_at_index (sm->static_mappings, value.value);
1656 return VNET_API_ERROR_NO_SUCH_ENTRY;
1658 if (!is_lb_static_mapping (m))
1659 return VNET_API_ERROR_INVALID_VALUE;
1662 pool_foreach (local, m->locals,
1664 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1665 (local->vrf_id == vrf_id))
1667 match_local = local;
1676 return VNET_API_ERROR_VALUE_EXIST;
1678 pool_get (m->locals, local);
1679 clib_memset (local, 0, sizeof (*local));
1680 local->addr.as_u32 = l_addr.as_u32;
1681 local->port = l_port;
1682 local->probability = probability;
1683 local->vrf_id = vrf_id;
1685 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1688 if (!is_out2in_only_static_mapping (m))
1690 m_key.addr = l_addr;
1691 m_key.port = l_port;
1692 m_key.fib_index = local->fib_index;
1693 kv.key = m_key.as_u64;
1694 kv.value = m - sm->static_mappings;
1695 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1))
1696 nat_elog_err ("static_mapping_by_local key add failed");
1702 return VNET_API_ERROR_NO_SUCH_ENTRY;
1704 if (pool_elts (m->locals) < 3)
1705 return VNET_API_ERROR_UNSPECIFIED;
1707 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1710 if (!is_out2in_only_static_mapping (m))
1712 m_key.addr = l_addr;
1713 m_key.port = l_port;
1714 m_key.fib_index = match_local->fib_index;
1715 kv.key = m_key.as_u64;
1716 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0))
1717 nat_elog_err ("static_mapping_by_local key del failed");
1720 if (sm->num_workers > 1)
1723 .src_address = local->addr,
1725 tsm = vec_elt_at_index (sm->per_thread_data,
1726 sm->worker_in2out_cb (&ip, m->fib_index,
1730 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1732 /* Delete sessions */
1733 u_key.addr = match_local->addr;
1734 u_key.fib_index = match_local->fib_index;
1735 kv.key = u_key.as_u64;
1736 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1738 u = pool_elt_at_index (tsm->users, value.value);
1739 if (u->nstaticsessions)
1741 head_index = u->sessions_per_user_list_head_index;
1742 head = pool_elt_at_index (tsm->list_pool, head_index);
1743 elt_index = head->next;
1744 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1745 ses_index = elt->value;
1746 while (ses_index != ~0)
1748 s = pool_elt_at_index (tsm->sessions, ses_index);
1749 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1750 ses_index = elt->value;
1752 if (!(is_lb_session (s)))
1755 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1756 (clib_net_to_host_u16 (s->in2out.port) !=
1760 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1761 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1766 pool_put (m->locals, match_local);
1769 vec_free (m->workers);
1772 pool_foreach (local, m->locals,
1774 vec_add1 (locals, local - m->locals);
1775 if (sm->num_workers > 1)
1778 ip.src_address.as_u32 = local->addr.as_u32,
1779 bitmap = clib_bitmap_set (bitmap,
1780 sm->worker_in2out_cb (&ip, local->fib_index, 0),
1786 ASSERT (vec_len (locals) > 1);
1788 local = pool_elt_at_index (m->locals, locals[0]);
1789 local->prefix = local->probability;
1790 for (i = 1; i < vec_len (locals); i++)
1792 local = pool_elt_at_index (m->locals, locals[i]);
1793 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1794 local->prefix = local->probability + prev_local->prefix;
1797 /* Assign workers */
1798 if (sm->num_workers > 1)
1801 clib_bitmap_foreach (i, bitmap, ({ vec_add1(m->workers, i); }));
1809 snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1812 snat_address_t *a = 0;
1813 snat_session_t *ses;
1814 u32 *ses_to_be_removed = 0, *ses_index;
1815 snat_main_per_thread_data_t *tsm;
1816 snat_static_mapping_t *m;
1817 snat_interface_t *interface;
1819 snat_address_t *addresses =
1820 twice_nat ? sm->twice_nat_addresses : sm->addresses;
1822 /* Find SNAT address */
1823 for (i = 0; i < vec_len (addresses); i++)
1825 if (addresses[i].addr.as_u32 == addr.as_u32)
1832 return VNET_API_ERROR_NO_SUCH_ENTRY;
1837 pool_foreach (m, sm->static_mappings,
1839 if (m->external_addr.as_u32 == addr.as_u32)
1840 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1841 m->local_port, m->external_port,
1842 m->vrf_id, is_addr_only_static_mapping(m), ~0,
1843 m->proto, 0, m->twice_nat,
1844 is_out2in_only_static_mapping(m), m->tag, is_identity_static_mapping(m));
1850 /* Check if address is used in some static mapping */
1851 if (is_snat_address_used_in_static_mapping (sm, addr))
1853 nat_elog_notice ("address used in static mapping");
1854 return VNET_API_ERROR_UNSPECIFIED;
1858 if (a->fib_index != ~0)
1859 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1861 /* Delete sessions using address */
1862 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1865 vec_foreach (tsm, sm->per_thread_data)
1867 pool_foreach (ses, tsm->sessions, ({
1868 if (ses->out2in.addr.as_u32 == addr.as_u32)
1870 nat_free_session_data (sm, ses, tsm - sm->per_thread_data, 0);
1871 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1875 vec_foreach (ses_index, ses_to_be_removed)
1877 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1878 nat44_delete_session (sm, ses, tsm - sm->per_thread_data);
1881 vec_free (ses_to_be_removed);
1886 #define _(N, i, n, s) \
1887 vec_free (a->busy_##n##_ports_per_thread);
1888 foreach_snat_protocol
1892 vec_del1 (sm->twice_nat_addresses, i);
1896 vec_del1 (sm->addresses, i);
1898 /* Delete external address from FIB */
1900 pool_foreach (interface, sm->interfaces,
1902 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1905 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1908 pool_foreach (interface, sm->output_feature_interfaces,
1910 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1913 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1922 snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1924 snat_main_t *sm = &snat_main;
1925 snat_interface_t *i;
1926 const char *feature_name, *del_feature_name;
1928 snat_static_mapping_t *m;
1930 nat_outside_fib_t *outside_fib;
1931 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1934 if (sm->out2in_dpo && !is_inside)
1935 return VNET_API_ERROR_UNSUPPORTED;
1938 pool_foreach (i, sm->output_feature_interfaces,
1940 if (i->sw_if_index == sw_if_index)
1941 return VNET_API_ERROR_VALUE_EXIST;
1945 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1946 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1949 if (sm->num_workers > 1 && !sm->deterministic)
1951 is_inside ? "nat44-in2out-worker-handoff" :
1952 "nat44-out2in-worker-handoff";
1953 else if (sm->deterministic)
1954 feature_name = is_inside ? "nat44-det-in2out" : "nat44-det-out2in";
1955 else if (sm->endpoint_dependent)
1957 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1960 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1963 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1964 sm->fq_in2out_index =
1965 vlib_frame_queue_main_init (sm->handoff_in2out_index, NAT_FQ_NELTS);
1967 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1968 sm->fq_out2in_index =
1969 vlib_frame_queue_main_init (sm->handoff_out2in_index, NAT_FQ_NELTS);
1974 vec_foreach (outside_fib, sm->outside_fibs)
1976 if (outside_fib->fib_index == fib_index)
1980 outside_fib->refcount--;
1981 if (!outside_fib->refcount)
1982 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1985 outside_fib->refcount++;
1992 vec_add2 (sm->outside_fibs, outside_fib, 1);
1993 outside_fib->refcount = 1;
1994 outside_fib->fib_index = fib_index;
1999 pool_foreach (i, sm->interfaces,
2001 if (i->sw_if_index == sw_if_index)
2005 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
2008 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
2010 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
2012 if (sm->num_workers > 1 && !sm->deterministic)
2014 del_feature_name = "nat44-handoff-classify";
2015 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
2016 "nat44-out2in-worker-handoff";
2018 else if (sm->deterministic)
2020 del_feature_name = "nat44-det-classify";
2021 feature_name = !is_inside ? "nat44-det-in2out" :
2024 else if (sm->endpoint_dependent)
2026 del_feature_name = "nat44-ed-classify";
2027 feature_name = !is_inside ? "nat-pre-in2out" :
2032 del_feature_name = "nat44-classify";
2033 feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
2036 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2039 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
2040 sw_if_index, 0, 0, 0);
2041 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2042 sw_if_index, 1, 0, 0);
2045 if (sm->endpoint_dependent)
2046 vnet_feature_enable_disable ("ip4-local",
2047 "nat44-ed-hairpinning",
2048 sw_if_index, 1, 0, 0);
2049 else if (!sm->deterministic)
2050 vnet_feature_enable_disable ("ip4-local",
2051 "nat44-hairpinning",
2052 sw_if_index, 1, 0, 0);
2057 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2060 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2061 sw_if_index, 0, 0, 0);
2062 pool_put (sm->interfaces, i);
2065 if (sm->endpoint_dependent)
2066 vnet_feature_enable_disable ("ip4-local",
2067 "nat44-ed-hairpinning",
2068 sw_if_index, 0, 0, 0);
2069 else if (!sm->deterministic)
2070 vnet_feature_enable_disable ("ip4-local",
2071 "nat44-hairpinning",
2072 sw_if_index, 0, 0, 0);
2078 if ((nat_interface_is_inside(i) && is_inside) ||
2079 (nat_interface_is_outside(i) && !is_inside))
2082 if (sm->num_workers > 1 && !sm->deterministic)
2084 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
2085 "nat44-out2in-worker-handoff";
2086 feature_name = "nat44-handoff-classify";
2088 else if (sm->deterministic)
2090 del_feature_name = !is_inside ? "nat44-det-in2out" :
2092 feature_name = "nat44-det-classify";
2094 else if (sm->endpoint_dependent)
2096 del_feature_name = !is_inside ? "nat-pre-in2out" :
2099 feature_name = "nat44-ed-classify";
2103 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
2104 feature_name = "nat44-classify";
2107 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
2110 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
2111 sw_if_index, 0, 0, 0);
2112 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2113 sw_if_index, 1, 0, 0);
2116 if (sm->endpoint_dependent)
2117 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
2118 sw_if_index, 0, 0, 0);
2119 else if (!sm->deterministic)
2120 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
2121 sw_if_index, 0, 0, 0);
2132 return VNET_API_ERROR_NO_SUCH_ENTRY;
2134 pool_get (sm->interfaces, i);
2135 i->sw_if_index = sw_if_index;
2137 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0,
2140 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
2144 if (is_inside && !sm->out2in_dpo)
2146 if (sm->endpoint_dependent)
2147 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
2148 sw_if_index, 1, 0, 0);
2149 else if (!sm->deterministic)
2150 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
2151 sw_if_index, 1, 0, 0);
2157 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2161 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2163 /* Add/delete external addresses to FIB */
2166 vec_foreach (ap, sm->addresses)
2167 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2169 pool_foreach (m, sm->static_mappings,
2171 if (!(is_addr_only_static_mapping(m)) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2174 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2177 pool_foreach (dm, sm->det_maps,
2179 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
2187 snat_interface_add_del_output_feature (u32 sw_if_index,
2188 u8 is_inside, int is_del)
2190 snat_main_t *sm = &snat_main;
2191 snat_interface_t *i;
2193 snat_static_mapping_t *m;
2194 nat_outside_fib_t *outside_fib;
2195 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
2199 if (sm->deterministic ||
2200 (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
2201 return VNET_API_ERROR_UNSUPPORTED;
2204 pool_foreach (i, sm->interfaces,
2206 if (i->sw_if_index == sw_if_index)
2207 return VNET_API_ERROR_VALUE_EXIST;
2214 vec_foreach (outside_fib, sm->outside_fibs)
2216 if (outside_fib->fib_index == fib_index)
2220 outside_fib->refcount--;
2221 if (!outside_fib->refcount)
2222 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2225 outside_fib->refcount++;
2232 vec_add2 (sm->outside_fibs, outside_fib, 1);
2233 outside_fib->refcount = 1;
2234 outside_fib->fib_index = fib_index;
2241 if (sm->endpoint_dependent)
2244 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2248 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2252 vnet_feature_enable_disable ("ip4-unicast", "nat44-ed-hairpin-dst",
2253 sw_if_index, !is_del, 0, 0);
2254 vnet_feature_enable_disable ("ip4-output", "nat44-ed-hairpin-src",
2255 sw_if_index, !is_del, 0, 0);
2260 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2264 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2268 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
2269 sw_if_index, !is_del, 0, 0);
2270 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
2271 sw_if_index, !is_del, 0, 0);
2276 if (sm->num_workers > 1)
2278 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2282 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, !is_del);
2285 vnet_feature_enable_disable ("ip4-unicast",
2286 "nat44-out2in-worker-handoff",
2287 sw_if_index, !is_del, 0, 0);
2288 vnet_feature_enable_disable ("ip4-output",
2289 "nat44-in2out-output-worker-handoff",
2290 sw_if_index, !is_del, 0, 0);
2294 if (sm->endpoint_dependent)
2297 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2301 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2305 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
2306 sw_if_index, !is_del, 0, 0);
2307 vnet_feature_enable_disable ("ip4-output", "nat44-ed-in2out-output",
2308 sw_if_index, !is_del, 0, 0);
2313 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2317 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2321 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in",
2322 sw_if_index, !is_del, 0, 0);
2323 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
2324 sw_if_index, !is_del, 0, 0);
2329 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
2330 sm->fq_in2out_output_index =
2331 vlib_frame_queue_main_init (sm->handoff_in2out_output_index, 0);
2333 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
2334 sm->fq_out2in_index =
2335 vlib_frame_queue_main_init (sm->handoff_out2in_index, 0);
2338 pool_foreach (i, sm->output_feature_interfaces,
2340 if (i->sw_if_index == sw_if_index)
2343 pool_put (sm->output_feature_interfaces, i);
2345 return VNET_API_ERROR_VALUE_EXIST;
2353 return VNET_API_ERROR_NO_SUCH_ENTRY;
2355 pool_get (sm->output_feature_interfaces, i);
2356 i->sw_if_index = sw_if_index;
2359 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2361 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2363 /* Add/delete external addresses to FIB */
2369 vec_foreach (ap, sm->addresses)
2370 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2372 pool_foreach (m, sm->static_mappings,
2374 if (!((is_addr_only_static_mapping(m))) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2377 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2385 snat_set_workers (uword * bitmap)
2387 snat_main_t *sm = &snat_main;
2390 if (sm->num_workers < 2)
2391 return VNET_API_ERROR_FEATURE_DISABLED;
2393 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2394 return VNET_API_ERROR_INVALID_WORKER;
2396 vec_free (sm->workers);
2398 clib_bitmap_foreach (i, bitmap,
2400 vec_add1(sm->workers, i);
2401 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2402 sm->per_thread_data[sm->first_worker_index + i].thread_index = i;
2407 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
2408 sm->num_snat_thread = _vec_len (sm->workers);
2414 snat_update_outside_fib (u32 sw_if_index, u32 new_fib_index,
2417 snat_main_t *sm = &snat_main;
2418 nat_outside_fib_t *outside_fib;
2419 snat_interface_t *i;
2423 if (new_fib_index == old_fib_index)
2426 if (!vec_len (sm->outside_fibs))
2430 pool_foreach (i, sm->interfaces,
2432 if (i->sw_if_index == sw_if_index)
2434 if (!(nat_interface_is_outside (i)))
2440 pool_foreach (i, sm->output_feature_interfaces,
2442 if (i->sw_if_index == sw_if_index)
2444 if (!(nat_interface_is_outside (i)))
2454 vec_foreach (outside_fib, sm->outside_fibs)
2456 if (outside_fib->fib_index == old_fib_index)
2458 outside_fib->refcount--;
2459 if (!outside_fib->refcount)
2460 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2465 vec_foreach (outside_fib, sm->outside_fibs)
2467 if (outside_fib->fib_index == new_fib_index)
2469 outside_fib->refcount++;
2477 vec_add2 (sm->outside_fibs, outside_fib, 1);
2478 outside_fib->refcount = 1;
2479 outside_fib->fib_index = new_fib_index;
2484 snat_ip4_table_bind (ip4_main_t * im,
2486 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
2488 snat_update_outside_fib (sw_if_index, new_fib_index, old_fib_index);
2492 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2495 ip4_address_t * address,
2497 u32 if_address_index, u32 is_delete);
2500 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
2503 ip4_address_t * address,
2505 u32 if_address_index, u32 is_delete);
2508 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2511 snat_session_key_t * k,
2512 u16 port_per_thread, u32 snat_thread_index);
2514 static clib_error_t *
2515 snat_init (vlib_main_t * vm)
2517 snat_main_t *sm = &snat_main;
2518 clib_error_t *error = 0;
2519 ip4_main_t *im = &ip4_main;
2520 ip_lookup_main_t *lm = &im->lookup_main;
2522 vlib_thread_registration_t *tr;
2523 vlib_thread_main_t *tm = vlib_get_thread_main ();
2526 ip4_add_del_interface_address_callback_t cb4;
2530 sm->vnet_main = vnet_get_main ();
2532 sm->ip4_lookup_main = lm;
2533 sm->api_main = vlibapi_get_main ();
2534 sm->first_worker_index = 0;
2535 sm->num_workers = 0;
2536 sm->num_snat_thread = 1;
2538 sm->port_per_thread = 0xffff - 1024;
2539 sm->fq_in2out_index = ~0;
2540 sm->fq_in2out_output_index = ~0;
2541 sm->fq_out2in_index = ~0;
2543 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
2544 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
2545 sm->forwarding_enabled = 0;
2546 sm->log_class = vlib_log_register_class ("nat", 0);
2547 sm->log_level = SNAT_LOG_ERROR;
2548 sm->mss_clamping = 0;
2550 node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
2551 sm->error_node_index = node->index;
2553 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2554 sm->pre_in2out_node_index = node->index;
2555 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2556 sm->pre_out2in_node_index = node->index;
2558 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2559 sm->pre_in2out_node_index = node->index;
2561 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2562 sm->pre_out2in_node_index = node->index;
2564 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out");
2565 sm->in2out_node_index = node->index;
2566 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output");
2567 sm->in2out_output_node_index = node->index;
2568 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-fast");
2569 sm->in2out_fast_node_index = node->index;
2570 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-slowpath");
2571 sm->in2out_slowpath_node_index = node->index;
2572 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output-slowpath");
2573 sm->in2out_slowpath_output_node_index = node->index;
2575 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out");
2576 sm->ed_in2out_node_index = node->index;
2577 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-slowpath");
2578 sm->ed_in2out_slowpath_node_index = node->index;
2580 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in");
2581 sm->out2in_node_index = node->index;
2582 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in-fast");
2583 sm->out2in_fast_node_index = node->index;
2585 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in");
2586 sm->ed_out2in_node_index = node->index;
2587 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in-slowpath");
2588 sm->ed_out2in_slowpath_node_index = node->index;
2590 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-in2out");
2591 sm->det_in2out_node_index = node->index;
2592 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-out2in");
2593 sm->det_out2in_node_index = node->index;
2595 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpinning");
2596 sm->hairpinning_node_index = node->index;
2597 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-dst");
2598 sm->hairpin_dst_node_index = node->index;
2599 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-src");
2600 sm->hairpin_src_node_index = node->index;
2601 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpinning");
2602 sm->ed_hairpinning_node_index = node->index;
2603 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-dst");
2604 sm->ed_hairpin_dst_node_index = node->index;
2605 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-src");
2606 sm->ed_hairpin_src_node_index = node->index;
2608 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2611 tr = (vlib_thread_registration_t *) p[0];
2614 sm->num_workers = tr->count;
2615 sm->first_worker_index = tr->first_index;
2619 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2621 /* Use all available workers by default */
2622 if (sm->num_workers > 1)
2624 for (i = 0; i < sm->num_workers; i++)
2625 bitmap = clib_bitmap_set (bitmap, i, 1);
2626 snat_set_workers (bitmap);
2627 clib_bitmap_free (bitmap);
2631 sm->per_thread_data[0].snat_thread_index = 0;
2634 error = snat_api_init (vm, sm);
2638 /* Set up the interface address add/del callback */
2639 cb4.function = snat_ip4_add_del_interface_address_cb;
2640 cb4.function_opaque = 0;
2642 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2644 cb4.function = nat_ip4_add_del_addr_only_sm_cb;
2645 cb4.function_opaque = 0;
2647 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2649 nat_dpo_module_init ();
2652 sm->total_users.name = "total-users";
2653 sm->total_users.stat_segment_name = "/nat44/total-users";
2654 vlib_validate_simple_counter (&sm->total_users, 0);
2655 vlib_zero_simple_counter (&sm->total_users, 0);
2656 sm->total_sessions.name = "total-sessions";
2657 sm->total_sessions.stat_segment_name = "/nat44/total-sessions";
2658 vlib_validate_simple_counter (&sm->total_sessions, 0);
2659 vlib_zero_simple_counter (&sm->total_sessions, 0);
2661 /* Init IPFIX logging */
2662 snat_ipfix_logging_init (vm);
2665 error = nat64_init (vm);
2671 ip4_table_bind_callback_t cbt4 = {
2672 .function = snat_ip4_table_bind,
2674 vec_add1 (ip4_main.table_bind_callbacks, cbt4);
2676 nat_fib_src_hi = fib_source_allocate ("nat-hi",
2677 FIB_SOURCE_PRIORITY_HI,
2678 FIB_SOURCE_BH_SIMPLE);
2679 nat_fib_src_low = fib_source_allocate ("nat-low",
2680 FIB_SOURCE_PRIORITY_LOW,
2681 FIB_SOURCE_BH_SIMPLE);
2686 VLIB_INIT_FUNCTION (snat_init);
2689 snat_free_outside_address_and_port (snat_address_t * addresses,
2690 u32 thread_index, snat_session_key_t * k)
2694 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2696 for (address_index = 0; address_index < vec_len (addresses);
2699 if (addresses[address_index].addr.as_u32 == k->addr.as_u32)
2703 ASSERT (address_index < vec_len (addresses));
2705 a = addresses + address_index;
2707 switch (k->protocol)
2709 #define _(N, i, n, s) \
2710 case SNAT_PROTOCOL_##N: \
2711 ASSERT (a->busy_##n##_port_refcounts[port_host_byte_order] >= 1); \
2712 --a->busy_##n##_port_refcounts[port_host_byte_order]; \
2713 a->busy_##n##_ports--; \
2714 a->busy_##n##_ports_per_thread[thread_index]--; \
2716 foreach_snat_protocol
2719 nat_elog_info ("unknown protocol");
2725 nat_set_outside_address_and_port (snat_address_t * addresses,
2726 u32 thread_index, snat_session_key_t * k)
2728 snat_address_t *a = 0;
2730 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2732 for (address_index = 0; address_index < vec_len (addresses);
2735 if (addresses[address_index].addr.as_u32 != k->addr.as_u32)
2738 a = addresses + address_index;
2739 switch (k->protocol)
2741 #define _(N, j, n, s) \
2742 case SNAT_PROTOCOL_##N: \
2743 if (a->busy_##n##_port_refcounts[port_host_byte_order]) \
2744 return VNET_API_ERROR_INSTANCE_IN_USE; \
2745 ++a->busy_##n##_port_refcounts[port_host_byte_order]; \
2746 a->busy_##n##_ports_per_thread[thread_index]++; \
2747 a->busy_##n##_ports++; \
2749 foreach_snat_protocol
2752 nat_elog_info ("unknown protocol");
2757 return VNET_API_ERROR_NO_SUCH_ENTRY;
2761 snat_static_mapping_match (snat_main_t * sm,
2762 snat_session_key_t match,
2763 snat_session_key_t * mapping,
2766 twice_nat_type_t * twice_nat,
2767 lb_nat_type_t * lb, ip4_address_t * ext_host_addr,
2768 u8 * is_identity_nat)
2770 clib_bihash_kv_8_8_t kv, value;
2771 snat_static_mapping_t *m;
2772 snat_session_key_t m_key;
2773 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
2774 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2776 nat44_lb_addr_port_t *local;
2778 m_key.fib_index = match.fib_index;
2781 mapping_hash = &sm->static_mapping_by_external;
2782 m_key.fib_index = 0;
2785 m_key.addr = match.addr;
2786 m_key.port = clib_net_to_host_u16 (match.port);
2787 m_key.protocol = match.protocol;
2789 kv.key = m_key.as_u64;
2791 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2793 /* Try address only mapping */
2796 kv.key = m_key.as_u64;
2797 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2801 m = pool_elt_at_index (sm->static_mappings, value.value);
2805 if (is_lb_static_mapping (m))
2807 if (PREDICT_FALSE (lb != 0))
2808 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2809 if (m->affinity && !nat_affinity_find_and_lock (ext_host_addr[0],
2815 local = pool_elt_at_index (m->locals, backend_index);
2816 mapping->addr = local->addr;
2817 mapping->port = clib_host_to_net_u16 (local->port);
2818 mapping->fib_index = local->fib_index;
2821 // pick locals matching this worker
2822 if (PREDICT_FALSE (sm->num_workers > 1))
2824 u32 thread_index = vlib_get_thread_index ();
2826 pool_foreach_index (i, m->locals,
2828 local = pool_elt_at_index (m->locals, i);
2831 .src_address = local->addr,
2834 if (sm->worker_in2out_cb (&ip, m->fib_index, 0) ==
2841 ASSERT (vec_len (tmp) != 0);
2846 pool_foreach_index (i, m->locals,
2852 hi = vec_len (tmp) - 1;
2853 local = pool_elt_at_index (m->locals, tmp[hi]);
2854 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2857 mid = ((hi - lo) >> 1) + lo;
2858 local = pool_elt_at_index (m->locals, tmp[mid]);
2859 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2861 local = pool_elt_at_index (m->locals, tmp[lo]);
2862 if (!(local->prefix >= rand))
2864 mapping->addr = local->addr;
2865 mapping->port = clib_host_to_net_u16 (local->port);
2866 mapping->fib_index = local->fib_index;
2869 if (nat_affinity_create_and_lock (ext_host_addr[0], match.addr,
2870 match.protocol, match.port,
2871 tmp[lo], m->affinity,
2872 m->affinity_per_service_list_head_index))
2873 nat_elog_info ("create affinity record failed");
2879 if (PREDICT_FALSE (lb != 0))
2881 mapping->fib_index = m->fib_index;
2882 mapping->addr = m->local_addr;
2883 /* Address only mapping doesn't change port */
2884 mapping->port = is_addr_only_static_mapping (m) ? match.port
2885 : clib_host_to_net_u16 (m->local_port);
2887 mapping->protocol = m->proto;
2891 mapping->addr = m->external_addr;
2892 /* Address only mapping doesn't change port */
2893 mapping->port = is_addr_only_static_mapping (m) ? match.port
2894 : clib_host_to_net_u16 (m->external_port);
2895 mapping->fib_index = sm->outside_fib_index;
2899 if (PREDICT_FALSE (is_addr_only != 0))
2900 *is_addr_only = is_addr_only_static_mapping (m);
2902 if (PREDICT_FALSE (twice_nat != 0))
2903 *twice_nat = m->twice_nat;
2905 if (PREDICT_FALSE (is_identity_nat != 0))
2906 *is_identity_nat = is_identity_static_mapping (m);
2911 static_always_inline u16
2912 snat_random_port (u16 min, u16 max)
2914 snat_main_t *sm = &snat_main;
2915 return min + random_u32 (&sm->random_seed) /
2916 (random_u32_max () / (max - min + 1) + 1);
2920 snat_alloc_outside_address_and_port (snat_address_t * addresses,
2923 snat_session_key_t * k,
2924 u16 port_per_thread,
2925 u32 snat_thread_index)
2927 snat_main_t *sm = &snat_main;
2929 return sm->alloc_addr_and_port (addresses, fib_index, thread_index, k,
2930 port_per_thread, snat_thread_index);
2934 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2937 snat_session_key_t * k,
2938 u16 port_per_thread, u32 snat_thread_index)
2941 snat_address_t *a, *ga = 0;
2944 for (i = 0; i < vec_len (addresses); i++)
2947 switch (k->protocol)
2949 #define _(N, j, n, s) \
2950 case SNAT_PROTOCOL_##N: \
2951 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
2953 if (a->fib_index == fib_index) \
2957 portnum = (port_per_thread * \
2958 snat_thread_index) + \
2959 snat_random_port(1, port_per_thread) + 1024; \
2960 if (a->busy_##n##_port_refcounts[portnum]) \
2962 --a->busy_##n##_port_refcounts[portnum]; \
2963 a->busy_##n##_ports_per_thread[thread_index]++; \
2964 a->busy_##n##_ports++; \
2965 k->addr = a->addr; \
2966 k->port = clib_host_to_net_u16(portnum); \
2970 else if (a->fib_index == ~0) \
2976 foreach_snat_protocol
2979 nat_elog_info ("unknown protocol");
2988 switch (k->protocol)
2990 #define _(N, j, n, s) \
2991 case SNAT_PROTOCOL_##N: \
2994 portnum = (port_per_thread * \
2995 snat_thread_index) + \
2996 snat_random_port(1, port_per_thread) + 1024; \
2997 if (a->busy_##n##_port_refcounts[portnum]) \
2999 ++a->busy_##n##_port_refcounts[portnum]; \
3000 a->busy_##n##_ports_per_thread[thread_index]++; \
3001 a->busy_##n##_ports++; \
3002 k->addr = a->addr; \
3003 k->port = clib_host_to_net_u16(portnum); \
3007 foreach_snat_protocol
3010 nat_elog_info ("unknown protocol");
3015 /* Totally out of translations to use... */
3016 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3021 nat_alloc_addr_and_port_mape (snat_address_t * addresses,
3024 snat_session_key_t * k,
3025 u16 port_per_thread, u32 snat_thread_index)
3027 snat_main_t *sm = &snat_main;
3028 snat_address_t *a = addresses;
3029 u16 m, ports, portnum, A, j;
3030 m = 16 - (sm->psid_offset + sm->psid_length);
3031 ports = (1 << (16 - sm->psid_length)) - (1 << m);
3033 if (!vec_len (addresses))
3036 switch (k->protocol)
3038 #define _(N, i, n, s) \
3039 case SNAT_PROTOCOL_##N: \
3040 if (a->busy_##n##_ports < ports) \
3044 A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
3045 j = snat_random_port(0, pow2_mask(m)); \
3046 portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
3047 if (a->busy_##n##_port_refcounts[portnum]) \
3049 ++a->busy_##n##_port_refcounts[portnum]; \
3050 a->busy_##n##_ports++; \
3051 k->addr = a->addr; \
3052 k->port = clib_host_to_net_u16 (portnum); \
3057 foreach_snat_protocol
3060 nat_elog_info ("unknown protocol");
3065 /* Totally out of translations to use... */
3066 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3071 nat_alloc_addr_and_port_range (snat_address_t * addresses,
3074 snat_session_key_t * k,
3075 u16 port_per_thread, u32 snat_thread_index)
3077 snat_main_t *sm = &snat_main;
3078 snat_address_t *a = addresses;
3081 ports = sm->end_port - sm->start_port + 1;
3083 if (!vec_len (addresses))
3086 switch (k->protocol)
3088 #define _(N, i, n, s) \
3089 case SNAT_PROTOCOL_##N: \
3090 if (a->busy_##n##_ports < ports) \
3094 portnum = snat_random_port(sm->start_port, sm->end_port); \
3095 if (a->busy_##n##_port_refcounts[portnum]) \
3097 ++a->busy_##n##_port_refcounts[portnum]; \
3098 a->busy_##n##_ports++; \
3099 k->addr = a->addr; \
3100 k->port = clib_host_to_net_u16 (portnum); \
3105 foreach_snat_protocol
3108 nat_elog_info ("unknown protocol");
3113 /* Totally out of translations to use... */
3114 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3119 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
3121 dpo_id_t dpo_v4 = DPO_INVALID;
3122 fib_prefix_t pfx = {
3123 .fp_proto = FIB_PROTOCOL_IP4,
3125 .fp_addr.ip4.as_u32 = addr.as_u32,
3130 nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
3131 fib_table_entry_special_dpo_add (0, &pfx, nat_fib_src_hi,
3132 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
3133 dpo_reset (&dpo_v4);
3137 fib_table_entry_special_remove (0, &pfx, nat_fib_src_hi);
3142 format_session_kvp (u8 * s, va_list * args)
3144 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3145 snat_session_key_t k;
3149 s = format (s, "%U session-index %llu", format_snat_key, &k, v->value);
3155 format_static_mapping_kvp (u8 * s, va_list * args)
3157 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3158 snat_session_key_t k;
3162 s = format (s, "%U static-mapping-index %llu",
3163 format_static_mapping_key, &k, v->value);
3169 format_user_kvp (u8 * s, va_list * args)
3171 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3176 s = format (s, "%U fib %d user-index %llu", format_ip4_address, &k.addr,
3177 k.fib_index, v->value);
3183 format_ed_session_kvp (u8 * s, va_list * args)
3185 clib_bihash_kv_16_8_t *v = va_arg (*args, clib_bihash_kv_16_8_t *);
3188 k.as_u64[0] = v->key[0];
3189 k.as_u64[1] = v->key[1];
3192 format (s, "local %U:%d remote %U:%d proto %U fib %d session-index %llu",
3193 format_ip4_address, &k.l_addr, clib_net_to_host_u16 (k.l_port),
3194 format_ip4_address, &k.r_addr, clib_net_to_host_u16 (k.r_port),
3195 format_ip_protocol, k.proto, k.fib_index, v->value);
3201 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0,
3204 snat_main_t *sm = &snat_main;
3205 u32 next_worker_index = 0;
3208 next_worker_index = sm->first_worker_index;
3209 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
3210 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >> 24);
3212 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3213 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3215 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3217 return next_worker_index;
3221 snat_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip0,
3222 u32 rx_fib_index0, u8 is_output)
3224 snat_main_t *sm = &snat_main;
3227 snat_session_key_t m_key;
3228 clib_bihash_kv_8_8_t kv, value;
3229 snat_static_mapping_t *m;
3231 u32 next_worker_index = 0;
3233 /* first try static mappings without port */
3234 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3236 m_key.addr = ip0->dst_address;
3239 m_key.fib_index = rx_fib_index0;
3240 kv.key = m_key.as_u64;
3241 if (!clib_bihash_search_8_8
3242 (&sm->static_mapping_by_external, &kv, &value))
3244 m = pool_elt_at_index (sm->static_mappings, value.value);
3245 return m->workers[0];
3249 proto = ip_proto_to_snat_proto (ip0->protocol);
3250 udp = ip4_next_header (ip0);
3251 port = udp->dst_port;
3253 /* unknown protocol */
3254 if (PREDICT_FALSE (proto == ~0))
3256 /* use current thread */
3257 return vlib_get_thread_index ();
3260 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
3262 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3263 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3264 if (!icmp_type_is_error_message
3265 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3266 port = vnet_buffer (b)->ip.reass.l4_src_port;
3269 /* if error message, then it's not fragmented and we can access it */
3270 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3271 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3272 void *l4_header = ip4_next_header (inner_ip);
3275 case SNAT_PROTOCOL_ICMP:
3276 icmp = (icmp46_header_t *) l4_header;
3277 echo = (icmp_echo_header_t *) (icmp + 1);
3278 port = echo->identifier;
3280 case SNAT_PROTOCOL_UDP:
3281 case SNAT_PROTOCOL_TCP:
3282 port = ((tcp_udp_header_t *) l4_header)->src_port;
3285 return vlib_get_thread_index ();
3290 /* try static mappings with port */
3291 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3293 m_key.addr = ip0->dst_address;
3294 m_key.port = clib_net_to_host_u16 (port);
3295 m_key.protocol = proto;
3296 m_key.fib_index = rx_fib_index0;
3297 kv.key = m_key.as_u64;
3298 if (!clib_bihash_search_8_8
3299 (&sm->static_mapping_by_external, &kv, &value))
3301 m = pool_elt_at_index (sm->static_mappings, value.value);
3302 return m->workers[0];
3306 /* worker by outside port */
3307 next_worker_index = sm->first_worker_index;
3308 next_worker_index +=
3309 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3310 return next_worker_index;
3314 nat44_ed_get_worker_in2out_cb (ip4_header_t * ip, u32 rx_fib_index,
3317 snat_main_t *sm = &snat_main;
3318 u32 next_worker_index = sm->first_worker_index;
3321 clib_bihash_kv_16_8_t kv16, value16;
3322 snat_main_per_thread_data_t *tsm;
3325 if (PREDICT_FALSE (is_output))
3327 u32 fib_index = sm->outside_fib_index;
3328 nat_outside_fib_t *outside_fib;
3329 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3330 fib_prefix_t pfx = {
3331 .fp_proto = FIB_PROTOCOL_IP4,
3334 .ip4.as_u32 = ip->dst_address.as_u32,
3339 udp = ip4_next_header (ip);
3341 switch (vec_len (sm->outside_fibs))
3344 fib_index = sm->outside_fib_index;
3347 fib_index = sm->outside_fibs[0].fib_index;
3351 vec_foreach (outside_fib, sm->outside_fibs)
3353 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3354 if (FIB_NODE_INDEX_INVALID != fei)
3356 if (fib_entry_get_resolving_interface (fei) != ~0)
3358 fib_index = outside_fib->fib_index;
3367 make_ed_kv (&kv16, &ip->src_address, &ip->dst_address,
3368 ip->protocol, fib_index, udp->src_port, udp->dst_port);
3371 vec_foreach (tsm, sm->per_thread_data)
3373 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3376 next_worker_index += tsm->thread_index;
3378 nat_elog_debug_handoff (
3379 "HANDOFF IN2OUT-OUTPUT-FEATURE (session)",
3380 next_worker_index, fib_index,
3381 clib_net_to_host_u32 (ip->src_address.as_u32),
3382 clib_net_to_host_u32 (ip->dst_address.as_u32));
3384 return next_worker_index;
3390 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3391 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3393 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3394 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3396 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3398 if (PREDICT_TRUE (!is_output))
3400 nat_elog_debug_handoff ("HANDOFF IN2OUT",
3401 next_worker_index, rx_fib_index,
3402 clib_net_to_host_u32 (ip->src_address.as_u32),
3403 clib_net_to_host_u32 (ip->dst_address.as_u32));
3407 nat_elog_debug_handoff ("HANDOFF IN2OUT-OUTPUT-FEATURE",
3408 next_worker_index, rx_fib_index,
3409 clib_net_to_host_u32 (ip->src_address.as_u32),
3410 clib_net_to_host_u32 (ip->dst_address.as_u32));
3413 return next_worker_index;
3417 nat44_ed_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip,
3418 u32 rx_fib_index, u8 is_output)
3420 snat_main_t *sm = &snat_main;
3421 clib_bihash_kv_8_8_t kv, value;
3422 clib_bihash_kv_16_8_t kv16, value16;
3423 snat_main_per_thread_data_t *tsm;
3425 u32 proto, next_worker_index = 0;
3428 snat_static_mapping_t *m;
3431 proto = ip_proto_to_snat_proto (ip->protocol);
3433 if (PREDICT_TRUE (proto == SNAT_PROTOCOL_UDP || proto == SNAT_PROTOCOL_TCP))
3435 udp = ip4_next_header (ip);
3437 make_ed_kv (&kv16, &ip->dst_address, &ip->src_address,
3438 ip->protocol, rx_fib_index, udp->dst_port, udp->src_port);
3441 vec_foreach (tsm, sm->per_thread_data)
3443 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3446 next_worker_index = sm->first_worker_index + tsm->thread_index;
3447 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3448 next_worker_index, rx_fib_index,
3449 clib_net_to_host_u32 (ip->src_address.as_u32),
3450 clib_net_to_host_u32 (ip->dst_address.as_u32));
3451 return next_worker_index;
3456 else if (proto == SNAT_PROTOCOL_ICMP)
3458 nat_ed_ses_key_t key;
3460 if (!get_icmp_o2i_ed_key (b, ip, &key))
3463 key.fib_index = rx_fib_index;
3464 kv16.key[0] = key.as_u64[0];
3465 kv16.key[1] = key.as_u64[1];
3468 vec_foreach (tsm, sm->per_thread_data)
3470 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3473 next_worker_index = sm->first_worker_index +
3475 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3476 next_worker_index, rx_fib_index,
3477 clib_net_to_host_u32 (ip->src_address.as_u32),
3478 clib_net_to_host_u32 (ip->dst_address.as_u32));
3479 return next_worker_index;
3486 /* first try static mappings without port */
3487 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3489 make_sm_kv (&kv, &ip->dst_address, 0, 0, 0);
3490 if (!clib_bihash_search_8_8
3491 (&sm->static_mapping_by_external, &kv, &value))
3493 m = pool_elt_at_index (sm->static_mappings, value.value);
3494 next_worker_index = m->workers[0];
3499 /* unknown protocol */
3500 if (PREDICT_FALSE (proto == ~0))
3502 /* use current thread */
3503 next_worker_index = vlib_get_thread_index ();
3507 udp = ip4_next_header (ip);
3508 port = udp->dst_port;
3510 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
3512 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3513 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3514 if (!icmp_type_is_error_message
3515 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3516 port = vnet_buffer (b)->ip.reass.l4_src_port;
3519 /* if error message, then it's not fragmented and we can access it */
3520 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3521 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3522 void *l4_header = ip4_next_header (inner_ip);
3525 case SNAT_PROTOCOL_ICMP:
3526 icmp = (icmp46_header_t *) l4_header;
3527 echo = (icmp_echo_header_t *) (icmp + 1);
3528 port = echo->identifier;
3530 case SNAT_PROTOCOL_UDP:
3531 case SNAT_PROTOCOL_TCP:
3532 port = ((tcp_udp_header_t *) l4_header)->src_port;
3535 next_worker_index = vlib_get_thread_index ();
3541 /* try static mappings with port */
3542 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3544 make_sm_kv (&kv, &ip->dst_address, proto, 0,
3545 clib_net_to_host_u16 (port));
3546 if (!clib_bihash_search_8_8
3547 (&sm->static_mapping_by_external, &kv, &value))
3549 m = pool_elt_at_index (sm->static_mappings, value.value);
3550 if (!is_lb_static_mapping (m))
3552 next_worker_index = m->workers[0];
3556 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3557 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3559 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
3561 m->workers[hash & (_vec_len (m->workers) - 1)];
3563 next_worker_index = m->workers[hash % _vec_len (m->workers)];
3568 /* worker by outside port */
3569 next_worker_index = sm->first_worker_index;
3570 next_worker_index +=
3571 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3574 nat_elog_debug_handoff ("HANDOFF OUT2IN", next_worker_index, rx_fib_index,
3575 clib_net_to_host_u32 (ip->src_address.as_u32),
3576 clib_net_to_host_u32 (ip->dst_address.as_u32));
3577 return next_worker_index;
3581 nat_ha_sadd_cb (ip4_address_t * in_addr, u16 in_port,
3582 ip4_address_t * out_addr, u16 out_port,
3583 ip4_address_t * eh_addr, u16 eh_port,
3584 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3585 u32 fib_index, u16 flags, u32 thread_index)
3587 snat_main_t *sm = &snat_main;
3588 snat_session_key_t key;
3591 clib_bihash_kv_8_8_t kv;
3592 f64 now = vlib_time_now (sm->vlib_main);
3593 nat_outside_fib_t *outside_fib;
3594 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3595 snat_main_per_thread_data_t *tsm;
3596 fib_prefix_t pfx = {
3597 .fp_proto = FIB_PROTOCOL_IP4,
3600 .ip4.as_u32 = eh_addr->as_u32,
3604 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3606 key.addr.as_u32 = out_addr->as_u32;
3607 key.port = out_port;
3608 key.protocol = proto;
3610 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3612 if (nat_set_outside_address_and_port
3613 (sm->addresses, thread_index, &key))
3617 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3621 s = nat_session_alloc_or_recycle (sm, u, thread_index, now);
3625 s->last_heard = now;
3627 s->ext_host_addr.as_u32 = eh_addr->as_u32;
3628 s->ext_host_port = eh_port;
3629 user_session_increment (sm, u, snat_is_session_static (s));
3630 switch (vec_len (sm->outside_fibs))
3633 key.fib_index = sm->outside_fib_index;
3636 key.fib_index = sm->outside_fibs[0].fib_index;
3640 vec_foreach (outside_fib, sm->outside_fibs)
3642 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3643 if (FIB_NODE_INDEX_INVALID != fei)
3645 if (fib_entry_get_resolving_interface (fei) != ~0)
3647 key.fib_index = outside_fib->fib_index;
3656 kv.key = key.as_u64;
3657 kv.value = s - tsm->sessions;
3658 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 1))
3659 nat_elog_warn ("out2in key add failed");
3661 key.addr.as_u32 = in_addr->as_u32;
3663 key.fib_index = fib_index;
3665 kv.key = key.as_u64;
3666 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 1))
3667 nat_elog_warn ("in2out key add failed");
3671 nat_ha_sdel_cb (ip4_address_t * out_addr, u16 out_port,
3672 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3675 snat_main_t *sm = &snat_main;
3676 snat_session_key_t key;
3677 clib_bihash_kv_8_8_t kv, value;
3680 snat_main_per_thread_data_t *tsm;
3682 if (sm->num_workers > 1)
3684 sm->first_worker_index +
3685 (sm->workers[(clib_net_to_host_u16 (out_port) -
3686 1024) / sm->port_per_thread]);
3688 thread_index = sm->num_workers;
3689 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3691 key.addr.as_u32 = out_addr->as_u32;
3692 key.port = out_port;
3693 key.protocol = proto;
3694 key.fib_index = fib_index;
3695 kv.key = key.as_u64;
3696 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3699 s = pool_elt_at_index (tsm->sessions, value.value);
3700 nat_free_session_data (sm, s, thread_index, 1);
3701 nat44_delete_session (sm, s, thread_index);
3705 nat_ha_sref_cb (ip4_address_t * out_addr, u16 out_port,
3706 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3707 u32 total_pkts, u64 total_bytes, u32 thread_index)
3709 snat_main_t *sm = &snat_main;
3710 snat_session_key_t key;
3711 clib_bihash_kv_8_8_t kv, value;
3713 snat_main_per_thread_data_t *tsm;
3715 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3717 key.addr.as_u32 = out_addr->as_u32;
3718 key.port = out_port;
3719 key.protocol = proto;
3720 key.fib_index = fib_index;
3721 kv.key = key.as_u64;
3722 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3725 s = pool_elt_at_index (tsm->sessions, value.value);
3726 s->total_pkts = total_pkts;
3727 s->total_bytes = total_bytes;
3731 nat_ha_sadd_ed_cb (ip4_address_t * in_addr, u16 in_port,
3732 ip4_address_t * out_addr, u16 out_port,
3733 ip4_address_t * eh_addr, u16 eh_port,
3734 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3735 u32 fib_index, u16 flags, u32 thread_index)
3737 snat_main_t *sm = &snat_main;
3738 snat_session_key_t key;
3741 clib_bihash_kv_16_8_t kv;
3742 f64 now = vlib_time_now (sm->vlib_main);
3743 nat_outside_fib_t *outside_fib;
3744 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3745 snat_main_per_thread_data_t *tsm;
3746 fib_prefix_t pfx = {
3747 .fp_proto = FIB_PROTOCOL_IP4,
3750 .ip4.as_u32 = eh_addr->as_u32,
3754 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3756 key.addr.as_u32 = out_addr->as_u32;
3757 key.port = out_port;
3758 key.protocol = proto;
3760 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3762 if (nat_set_outside_address_and_port
3763 (sm->addresses, thread_index, &key))
3767 key.addr.as_u32 = ehn_addr->as_u32;
3768 key.port = ehn_port;
3769 if (flags & SNAT_SESSION_FLAG_TWICE_NAT)
3771 if (nat_set_outside_address_and_port
3772 (sm->twice_nat_addresses, thread_index, &key))
3776 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3780 s = nat_ed_session_alloc (sm, u, thread_index, now);
3784 s->last_heard = now;
3786 s->ext_host_nat_addr.as_u32 = s->ext_host_addr.as_u32 = eh_addr->as_u32;
3787 s->ext_host_nat_port = s->ext_host_port = eh_port;
3788 if (is_twice_nat_session (s))
3790 s->ext_host_nat_addr.as_u32 = ehn_addr->as_u32;
3791 s->ext_host_nat_port = ehn_port;
3793 user_session_increment (sm, u, snat_is_session_static (s));
3794 switch (vec_len (sm->outside_fibs))
3797 key.fib_index = sm->outside_fib_index;
3800 key.fib_index = sm->outside_fibs[0].fib_index;
3804 vec_foreach (outside_fib, sm->outside_fibs)
3806 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3807 if (FIB_NODE_INDEX_INVALID != fei)
3809 if (fib_entry_get_resolving_interface (fei) != ~0)
3811 key.fib_index = outside_fib->fib_index;
3819 key.addr.as_u32 = out_addr->as_u32;
3820 key.port = out_port;
3822 kv.value = s - tsm->sessions;
3824 key.addr.as_u32 = in_addr->as_u32;
3826 key.fib_index = fib_index;
3829 make_ed_kv (&kv, in_addr, &s->ext_host_nat_addr,
3830 snat_proto_to_ip_proto (proto), fib_index, in_port,
3831 s->ext_host_nat_port);
3832 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &kv, 1))
3833 nat_elog_warn ("in2out key add failed");
3835 make_ed_kv (&kv, out_addr, eh_addr, snat_proto_to_ip_proto (proto),
3836 s->out2in.fib_index, out_port, eh_port);
3837 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &kv, 1))
3838 nat_elog_warn ("out2in key add failed");
3842 nat_ha_sdel_ed_cb (ip4_address_t * out_addr, u16 out_port,
3843 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3844 u32 fib_index, u32 ti)
3846 snat_main_t *sm = &snat_main;
3847 nat_ed_ses_key_t key;
3848 clib_bihash_kv_16_8_t kv, value;
3851 snat_main_per_thread_data_t *tsm;
3853 if (sm->num_workers > 1)
3855 sm->first_worker_index +
3856 (sm->workers[(clib_net_to_host_u16 (out_port) -
3857 1024) / sm->port_per_thread]);
3859 thread_index = sm->num_workers;
3860 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3862 key.l_addr.as_u32 = out_addr->as_u32;
3863 key.l_port = out_port;
3864 key.r_addr.as_u32 = eh_addr->as_u32;
3865 key.r_port = eh_port;
3867 key.fib_index = fib_index;
3868 kv.key[0] = key.as_u64[0];
3869 kv.key[1] = key.as_u64[1];
3870 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3873 s = pool_elt_at_index (tsm->sessions, value.value);
3874 nat_free_session_data (sm, s, thread_index, 1);
3875 nat44_delete_session (sm, s, thread_index);
3879 nat_ha_sref_ed_cb (ip4_address_t * out_addr, u16 out_port,
3880 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3881 u32 fib_index, u32 total_pkts, u64 total_bytes,
3884 snat_main_t *sm = &snat_main;
3885 nat_ed_ses_key_t key;
3886 clib_bihash_kv_16_8_t kv, value;
3888 snat_main_per_thread_data_t *tsm;
3890 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3892 key.l_addr.as_u32 = out_addr->as_u32;
3893 key.l_port = out_port;
3894 key.r_addr.as_u32 = eh_addr->as_u32;
3895 key.r_port = eh_port;
3897 key.fib_index = fib_index;
3898 kv.key[0] = key.as_u64[0];
3899 kv.key[1] = key.as_u64[1];
3900 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3903 s = pool_elt_at_index (tsm->sessions, value.value);
3904 s->total_pkts = total_pkts;
3905 s->total_bytes = total_bytes;
3908 static clib_error_t *
3909 snat_config (vlib_main_t * vm, unformat_input_t * input)
3911 snat_main_t *sm = &snat_main;
3912 nat66_main_t *nm = &nat66_main;
3913 //dslite_main_t *dm = &dslite_main;
3914 snat_main_per_thread_data_t *tsm;
3916 u32 static_mapping_buckets = 1024;
3917 uword static_mapping_memory_size = 64 << 20;
3919 u32 nat64_bib_buckets = 1024;
3920 u32 nat64_bib_memory_size = 128 << 20;
3922 u32 nat64_st_buckets = 2048;
3923 uword nat64_st_memory_size = 256 << 20;
3925 u32 user_buckets = 128;
3926 uword user_memory_size = 64 << 20;
3927 u32 translation_buckets = 1024;
3928 uword translation_memory_size = 128 << 20;
3930 u32 max_translations_per_user = ~0;
3932 u32 outside_vrf_id = 0;
3933 u32 outside_ip6_vrf_id = 0;
3934 u32 inside_vrf_id = 0;
3935 u8 static_mapping_only = 0;
3936 u8 static_mapping_connection_tracking = 0;
3938 // configurable timeouts
3939 u32 udp_timeout = SNAT_UDP_TIMEOUT;
3940 u32 icmp_timeout = SNAT_ICMP_TIMEOUT;
3941 u32 tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
3942 u32 tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
3944 sm->deterministic = 0;
3946 sm->endpoint_dependent = 0;
3948 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3951 (input, "translation hash buckets %d", &translation_buckets))
3953 else if (unformat (input, "udp timeout %d", &udp_timeout))
3955 else if (unformat (input, "icmp timeout %d", &icmp_timeout))
3957 else if (unformat (input, "tcp transitory timeout %d",
3958 &tcp_transitory_timeout));
3959 else if (unformat (input, "tcp established timeout %d",
3960 &tcp_established_timeout));
3961 else if (unformat (input, "translation hash memory %d",
3962 &translation_memory_size));
3963 else if (unformat (input, "user hash buckets %d", &user_buckets))
3965 else if (unformat (input, "user hash memory %d", &user_memory_size))
3967 else if (unformat (input, "max translations per user %d",
3968 &max_translations_per_user))
3970 else if (unformat (input, "outside VRF id %d", &outside_vrf_id))
3972 else if (unformat (input, "outside ip6 VRF id %d", &outside_ip6_vrf_id))
3974 else if (unformat (input, "inside VRF id %d", &inside_vrf_id))
3976 else if (unformat (input, "static mapping only"))
3978 static_mapping_only = 1;
3979 if (unformat (input, "connection tracking"))
3980 static_mapping_connection_tracking = 1;
3982 else if (unformat (input, "deterministic"))
3983 sm->deterministic = 1;
3984 else if (unformat (input, "nat64 bib hash buckets %d",
3985 &nat64_bib_buckets))
3987 else if (unformat (input, "nat64 bib hash memory %d",
3988 &nat64_bib_memory_size))
3991 if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
3993 else if (unformat (input, "nat64 st hash memory %d",
3994 &nat64_st_memory_size))
3996 else if (unformat (input, "out2in dpo"))
3998 //else if (unformat (input, "dslite ce"))
3999 //dslite_set_ce (dm, 1);
4000 else if (unformat (input, "endpoint-dependent"))
4001 sm->endpoint_dependent = 1;
4003 return clib_error_return (0, "unknown input '%U'",
4004 format_unformat_error, input);
4007 if (sm->deterministic && sm->endpoint_dependent)
4008 return clib_error_return (0,
4009 "deterministic and endpoint-dependent modes are mutually exclusive");
4011 if (static_mapping_only && (sm->deterministic || sm->endpoint_dependent))
4012 return clib_error_return (0,
4013 "static mapping only mode available only for simple nat");
4015 if (sm->out2in_dpo && (sm->deterministic || sm->endpoint_dependent))
4016 return clib_error_return (0,
4017 "out2in dpo mode available only for simple nat");
4019 /* optionally configurable timeouts for testing purposes */
4020 sm->udp_timeout = udp_timeout;
4021 sm->tcp_transitory_timeout = tcp_transitory_timeout;
4022 sm->tcp_established_timeout = tcp_established_timeout;
4023 sm->icmp_timeout = icmp_timeout;
4025 sm->user_buckets = user_buckets;
4026 sm->user_memory_size = user_memory_size;
4028 sm->translation_buckets = translation_buckets;
4029 sm->translation_memory_size = translation_memory_size;
4031 /* do not exceed load factor 10 */
4032 sm->max_translations = 10 * translation_buckets;
4033 sm->max_translations_per_user = max_translations_per_user == ~0 ?
4034 sm->max_translations : max_translations_per_user;
4036 sm->outside_vrf_id = outside_vrf_id;
4037 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
4040 nm->outside_vrf_id = outside_ip6_vrf_id;
4041 nm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6,
4044 sm->inside_vrf_id = inside_vrf_id;
4045 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
4048 sm->static_mapping_only = static_mapping_only;
4049 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
4051 nat64_set_hash (nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
4052 nat64_st_memory_size);
4054 if (sm->deterministic)
4056 sm->in2out_node_index = snat_det_in2out_node.index;
4057 sm->in2out_output_node_index = ~0;
4058 sm->out2in_node_index = snat_det_out2in_node.index;
4059 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
4060 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
4064 if (sm->endpoint_dependent)
4066 sm->worker_in2out_cb = nat44_ed_get_worker_in2out_cb;
4067 sm->worker_out2in_cb = nat44_ed_get_worker_out2in_cb;
4069 sm->handoff_out2in_index = nat_pre_out2in_node.index;
4070 sm->handoff_in2out_index = nat_pre_in2out_node.index;
4071 sm->handoff_in2out_output_index = nat44_ed_in2out_output_node.index;
4073 sm->in2out_node_index = nat44_ed_in2out_node.index;
4074 sm->in2out_output_node_index = nat44_ed_in2out_output_node.index;
4075 sm->out2in_node_index = nat44_ed_out2in_node.index;
4077 sm->icmp_match_in2out_cb = icmp_match_in2out_ed;
4078 sm->icmp_match_out2in_cb = icmp_match_out2in_ed;
4079 nat_affinity_init (vm);
4080 nat_ha_init (vm, nat_ha_sadd_ed_cb, nat_ha_sdel_ed_cb,
4085 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
4086 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
4088 sm->handoff_out2in_index = snat_out2in_node.index;
4089 sm->handoff_in2out_index = snat_in2out_node.index;
4090 sm->handoff_in2out_output_index = snat_in2out_output_node.index;
4092 sm->in2out_node_index = snat_in2out_node.index;
4093 sm->in2out_output_node_index = snat_in2out_output_node.index;
4094 sm->out2in_node_index = snat_out2in_node.index;
4095 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
4096 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
4097 nat_ha_init (vm, nat_ha_sadd_cb, nat_ha_sdel_cb, nat_ha_sref_cb);
4099 if (!static_mapping_only ||
4100 (static_mapping_only && static_mapping_connection_tracking))
4103 vec_foreach (tsm, sm->per_thread_data)
4105 pool_alloc (tsm->sessions, sm->max_translations);
4106 pool_alloc (tsm->list_pool, sm->max_translations);
4107 pool_alloc (tsm->global_lru_pool, sm->max_translations);
4110 pool_get (tsm->global_lru_pool, head);
4111 tsm->global_lru_head_index = head - tsm->global_lru_pool;
4112 clib_dlist_init (tsm->global_lru_pool,
4113 tsm->global_lru_head_index);
4115 if (sm->endpoint_dependent)
4117 clib_bihash_init_16_8 (&tsm->in2out_ed, "in2out-ed",
4118 translation_buckets,
4119 translation_memory_size);
4120 clib_bihash_set_kvp_format_fn_16_8 (&tsm->in2out_ed,
4121 format_ed_session_kvp);
4123 clib_bihash_init_16_8 (&tsm->out2in_ed, "out2in-ed",
4124 translation_buckets,
4125 translation_memory_size);
4126 clib_bihash_set_kvp_format_fn_16_8 (&tsm->out2in_ed,
4127 format_ed_session_kvp);
4128 clib_bihash_init_16_8
4129 (&sm->ed_ext_ports, "ed-nat-5-tuple-port-overload-hash",
4130 translation_buckets, translation_memory_size);
4134 clib_bihash_init_8_8 (&tsm->in2out, "in2out",
4135 translation_buckets,
4136 translation_memory_size);
4137 clib_bihash_set_kvp_format_fn_8_8 (&tsm->in2out,
4138 format_session_kvp);
4140 clib_bihash_init_8_8 (&tsm->out2in, "out2in",
4141 translation_buckets,
4142 translation_memory_size);
4143 clib_bihash_set_kvp_format_fn_8_8 (&tsm->out2in,
4144 format_session_kvp);
4147 clib_bihash_init_8_8 (&tsm->user_hash, "users", user_buckets,
4149 clib_bihash_set_kvp_format_fn_8_8 (&tsm->user_hash,
4157 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
4158 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
4160 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
4161 "static_mapping_by_local", static_mapping_buckets,
4162 static_mapping_memory_size);
4163 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_local,
4164 format_static_mapping_kvp);
4166 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
4167 "static_mapping_by_external",
4168 static_mapping_buckets,
4169 static_mapping_memory_size);
4170 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_external,
4171 format_static_mapping_kvp);
4177 VLIB_CONFIG_FUNCTION (snat_config, "nat");
4180 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
4183 ip4_address_t * address,
4185 u32 if_address_index, u32 is_delete)
4187 snat_main_t *sm = &snat_main;
4188 snat_static_map_resolve_t *rp;
4189 snat_static_mapping_t *m;
4190 snat_session_key_t m_key;
4191 clib_bihash_kv_8_8_t kv, value;
4193 ip4_address_t l_addr;
4195 for (i = 0; i < vec_len (sm->to_resolve); i++)
4197 rp = sm->to_resolve + i;
4198 if (rp->addr_only == 0)
4200 if (rp->sw_if_index == sw_if_index)
4207 m_key.addr.as_u32 = address->as_u32;
4208 m_key.port = rp->addr_only ? 0 : rp->e_port;
4209 m_key.protocol = rp->addr_only ? 0 : rp->proto;
4210 m_key.fib_index = sm->outside_fib_index;
4211 kv.key = m_key.as_u64;
4212 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
4215 m = pool_elt_at_index (sm->static_mappings, value.value);
4219 /* Don't trip over lease renewal, static config */
4229 /* Indetity mapping? */
4230 if (rp->l_addr.as_u32 == 0)
4231 l_addr.as_u32 = address[0].as_u32;
4233 l_addr.as_u32 = rp->l_addr.as_u32;
4234 /* Add the static mapping */
4235 rv = snat_add_static_mapping (l_addr,
4240 rp->addr_only, ~0 /* sw_if_index */ ,
4241 rp->proto, !is_delete, rp->twice_nat,
4242 rp->out2in_only, rp->tag, rp->identity_nat);
4244 nat_elog_notice_X1 ("snat_add_static_mapping returned %d", "i4", rv);
4248 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
4251 ip4_address_t * address,
4253 u32 if_address_index, u32 is_delete)
4255 snat_main_t *sm = &snat_main;
4256 snat_static_map_resolve_t *rp;
4257 ip4_address_t l_addr;
4261 snat_address_t *addresses = sm->addresses;
4263 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices); i++)
4265 if (sw_if_index == sm->auto_add_sw_if_indices[i])
4269 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices_twice_nat); i++)
4272 addresses = sm->twice_nat_addresses;
4273 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
4282 /* Don't trip over lease renewal, static config */
4283 for (j = 0; j < vec_len (addresses); j++)
4284 if (addresses[j].addr.as_u32 == address->as_u32)
4287 (void) snat_add_address (sm, address, ~0, twice_nat);
4288 /* Scan static map resolution vector */
4289 for (j = 0; j < vec_len (sm->to_resolve); j++)
4291 rp = sm->to_resolve + j;
4294 /* On this interface? */
4295 if (rp->sw_if_index == sw_if_index)
4297 /* Indetity mapping? */
4298 if (rp->l_addr.as_u32 == 0)
4299 l_addr.as_u32 = address[0].as_u32;
4301 l_addr.as_u32 = rp->l_addr.as_u32;
4302 /* Add the static mapping */
4303 rv = snat_add_static_mapping (l_addr,
4309 ~0 /* sw_if_index */ ,
4311 rp->is_add, rp->twice_nat,
4312 rp->out2in_only, rp->tag,
4315 nat_elog_notice_X1 ("snat_add_static_mapping returned %d",
4323 (void) snat_del_address (sm, address[0], 1, twice_nat);
4330 snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
4333 ip4_main_t *ip4_main = sm->ip4_main;
4334 ip4_address_t *first_int_addr;
4335 snat_static_map_resolve_t *rp;
4336 u32 *indices_to_delete = 0;
4338 u32 *auto_add_sw_if_indices =
4340 auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
4342 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0 /* just want the address */
4345 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
4347 if (auto_add_sw_if_indices[i] == sw_if_index)
4351 /* if have address remove it */
4353 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
4356 for (j = 0; j < vec_len (sm->to_resolve); j++)
4358 rp = sm->to_resolve + j;
4359 if (rp->sw_if_index == sw_if_index)
4360 vec_add1 (indices_to_delete, j);
4362 if (vec_len (indices_to_delete))
4364 for (j = vec_len (indices_to_delete) - 1; j >= 0; j--)
4365 vec_del1 (sm->to_resolve, j);
4366 vec_free (indices_to_delete);
4370 vec_del1 (sm->auto_add_sw_if_indices_twice_nat, i);
4372 vec_del1 (sm->auto_add_sw_if_indices, i);
4375 return VNET_API_ERROR_VALUE_EXIST;
4382 return VNET_API_ERROR_NO_SUCH_ENTRY;
4384 /* add to the auto-address list */
4386 vec_add1 (sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
4388 vec_add1 (sm->auto_add_sw_if_indices, sw_if_index);
4390 /* If the address is already bound - or static - add it now */
4392 (void) snat_add_address (sm, first_int_addr, ~0, twice_nat);
4398 nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4399 snat_protocol_t proto, u32 vrf_id, int is_in)
4401 snat_main_per_thread_data_t *tsm;
4402 clib_bihash_kv_8_8_t kv, value;
4404 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4405 snat_session_key_t key;
4407 clib_bihash_8_8_t *t;
4409 if (sm->endpoint_dependent)
4410 return VNET_API_ERROR_UNSUPPORTED;
4412 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4413 if (sm->num_workers > 1)
4415 vec_elt_at_index (sm->per_thread_data,
4416 sm->worker_in2out_cb (&ip, fib_index, 0));
4418 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4420 key.addr.as_u32 = addr->as_u32;
4421 key.port = clib_host_to_net_u16 (port);
4422 key.protocol = proto;
4423 key.fib_index = fib_index;
4424 kv.key = key.as_u64;
4425 t = is_in ? &tsm->in2out : &tsm->out2in;
4426 if (!clib_bihash_search_8_8 (t, &kv, &value))
4428 if (pool_is_free_index (tsm->sessions, value.value))
4429 return VNET_API_ERROR_UNSPECIFIED;
4431 s = pool_elt_at_index (tsm->sessions, value.value);
4432 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4433 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4437 return VNET_API_ERROR_NO_SUCH_ENTRY;
4441 nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4442 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
4443 u32 vrf_id, int is_in)
4446 clib_bihash_16_8_t *t;
4447 nat_ed_ses_key_t key;
4448 clib_bihash_kv_16_8_t kv, value;
4449 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4451 snat_main_per_thread_data_t *tsm;
4453 if (!sm->endpoint_dependent)
4454 return VNET_API_ERROR_FEATURE_DISABLED;
4456 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4457 if (sm->num_workers > 1)
4459 vec_elt_at_index (sm->per_thread_data,
4460 sm->worker_in2out_cb (&ip, fib_index, 0));
4462 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4464 t = is_in ? &tsm->in2out_ed : &tsm->out2in_ed;
4465 key.l_addr.as_u32 = addr->as_u32;
4466 key.r_addr.as_u32 = eh_addr->as_u32;
4467 key.l_port = clib_host_to_net_u16 (port);
4468 key.r_port = clib_host_to_net_u16 (eh_port);
4470 key.fib_index = fib_index;
4471 kv.key[0] = key.as_u64[0];
4472 kv.key[1] = key.as_u64[1];
4473 if (clib_bihash_search_16_8 (t, &kv, &value))
4474 return VNET_API_ERROR_NO_SUCH_ENTRY;
4476 if (pool_is_free_index (tsm->sessions, value.value))
4477 return VNET_API_ERROR_UNSPECIFIED;
4478 s = pool_elt_at_index (tsm->sessions, value.value);
4479 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4480 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4485 nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset, u16 psid_length)
4487 snat_main_t *sm = &snat_main;
4489 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_MAPE;
4490 sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
4492 sm->psid_offset = psid_offset;
4493 sm->psid_length = psid_length;
4497 nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port)
4499 snat_main_t *sm = &snat_main;
4501 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_RANGE;
4502 sm->alloc_addr_and_port = nat_alloc_addr_and_port_range;
4503 sm->start_port = start_port;
4504 sm->end_port = end_port;
4508 nat_set_alloc_addr_and_port_default (void)
4510 snat_main_t *sm = &snat_main;
4512 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
4513 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
4516 VLIB_NODE_FN (nat_default_node) (vlib_main_t * vm,
4517 vlib_node_runtime_t * node,
4518 vlib_frame_t * frame)
4524 VLIB_REGISTER_NODE (nat_default_node) = {
4525 .name = "nat-default",
4526 .vector_size = sizeof (u32),
4528 .type = VLIB_NODE_TYPE_INTERNAL,
4530 .n_next_nodes = NAT_N_NEXT,
4532 [NAT_NEXT_DROP] = "error-drop",
4533 [NAT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
4534 [NAT_NEXT_IN2OUT_PRE] = "nat-pre-in2out",
4535 [NAT_NEXT_OUT2IN_PRE] = "nat-pre-out2in",
4536 [NAT_NEXT_IN2OUT_ED_FAST_PATH] = "nat44-ed-in2out",
4537 [NAT_NEXT_IN2OUT_ED_SLOW_PATH] = "nat44-ed-in2out-slowpath",
4538 [NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH] = "nat44-ed-in2out-output-slowpath",
4539 [NAT_NEXT_OUT2IN_ED_FAST_PATH] = "nat44-ed-out2in",
4540 [NAT_NEXT_OUT2IN_ED_SLOW_PATH] = "nat44-ed-out2in-slowpath",
4546 * fd.io coding-style-patch-verification: ON
4549 * eval: (c-set-style "gnu")