2 * snat.c - simple nat plugin
4 * Copyright (c) 2016 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vnet/vnet.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/ip/ip4.h>
21 #include <vnet/plugin/plugin.h>
23 #include <nat/nat_dpo.h>
24 #include <nat/nat_ipfix_logging.h>
25 #include <nat/nat_det.h>
26 #include <nat/nat64.h>
27 #include <nat/nat66.h>
28 #include <nat/nat_inlines.h>
29 #include <nat/nat44/inlines.h>
30 #include <nat/nat_affinity.h>
31 #include <nat/nat_syslog.h>
32 #include <nat/nat_ha.h>
33 #include <vnet/fib/fib_table.h>
34 #include <vnet/fib/ip4_fib.h>
35 #include <vnet/ip/reass/ip4_sv_reass.h>
36 #include <vppinfra/bihash_16_8.h>
38 #include <vpp/app/version.h>
40 snat_main_t snat_main;
42 fib_source_t nat_fib_src_hi;
43 fib_source_t nat_fib_src_low;
46 /* Hook up input features */
47 VNET_FEATURE_INIT (nat_pre_in2out, static) = {
48 .arc_name = "ip4-unicast",
49 .node_name = "nat-pre-in2out",
50 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
51 "ip4-sv-reassembly-feature"),
53 VNET_FEATURE_INIT (nat_pre_out2in, static) = {
54 .arc_name = "ip4-unicast",
55 .node_name = "nat-pre-out2in",
56 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
57 "ip4-dhcp-client-detect",
58 "ip4-sv-reassembly-feature"),
60 VNET_FEATURE_INIT (snat_in2out_worker_handoff, static) = {
61 .arc_name = "ip4-unicast",
62 .node_name = "nat44-in2out-worker-handoff",
63 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
65 VNET_FEATURE_INIT (snat_out2in_worker_handoff, static) = {
66 .arc_name = "ip4-unicast",
67 .node_name = "nat44-out2in-worker-handoff",
68 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
69 "ip4-dhcp-client-detect"),
71 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
72 .arc_name = "ip4-unicast",
73 .node_name = "nat44-in2out",
74 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
76 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
77 .arc_name = "ip4-unicast",
78 .node_name = "nat44-out2in",
79 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
80 "ip4-dhcp-client-detect"),
82 VNET_FEATURE_INIT (ip4_nat_classify, static) = {
83 .arc_name = "ip4-unicast",
84 .node_name = "nat44-classify",
85 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
87 VNET_FEATURE_INIT (ip4_snat_det_in2out, static) = {
88 .arc_name = "ip4-unicast",
89 .node_name = "nat44-det-in2out",
90 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
92 VNET_FEATURE_INIT (ip4_snat_det_out2in, static) = {
93 .arc_name = "ip4-unicast",
94 .node_name = "nat44-det-out2in",
95 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
96 "ip4-dhcp-client-detect"),
98 VNET_FEATURE_INIT (ip4_nat_det_classify, static) = {
99 .arc_name = "ip4-unicast",
100 .node_name = "nat44-det-classify",
101 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
103 VNET_FEATURE_INIT (ip4_nat44_ed_in2out, static) = {
104 .arc_name = "ip4-unicast",
105 .node_name = "nat44-ed-in2out",
106 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
108 VNET_FEATURE_INIT (ip4_nat44_ed_out2in, static) = {
109 .arc_name = "ip4-unicast",
110 .node_name = "nat44-ed-out2in",
111 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
112 "ip4-dhcp-client-detect"),
114 VNET_FEATURE_INIT (ip4_nat44_ed_classify, static) = {
115 .arc_name = "ip4-unicast",
116 .node_name = "nat44-ed-classify",
117 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
119 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
120 .arc_name = "ip4-unicast",
121 .node_name = "nat44-handoff-classify",
122 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
124 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
125 .arc_name = "ip4-unicast",
126 .node_name = "nat44-in2out-fast",
127 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
129 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
130 .arc_name = "ip4-unicast",
131 .node_name = "nat44-out2in-fast",
132 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
133 "ip4-dhcp-client-detect"),
135 VNET_FEATURE_INIT (ip4_snat_hairpin_dst, static) = {
136 .arc_name = "ip4-unicast",
137 .node_name = "nat44-hairpin-dst",
138 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
140 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_dst, static) = {
141 .arc_name = "ip4-unicast",
142 .node_name = "nat44-ed-hairpin-dst",
143 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
146 /* Hook up output features */
147 VNET_FEATURE_INIT (ip4_snat_in2out_output, static) = {
148 .arc_name = "ip4-output",
149 .node_name = "nat44-in2out-output",
150 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
152 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
153 .arc_name = "ip4-output",
154 .node_name = "nat44-in2out-output-worker-handoff",
155 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
157 VNET_FEATURE_INIT (ip4_snat_hairpin_src, static) = {
158 .arc_name = "ip4-output",
159 .node_name = "nat44-hairpin-src",
160 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
162 VNET_FEATURE_INIT (ip4_nat44_ed_in2out_output, static) = {
163 .arc_name = "ip4-output",
164 .node_name = "nat44-ed-in2out-output",
165 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
166 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
168 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_src, static) = {
169 .arc_name = "ip4-output",
170 .node_name = "nat44-ed-hairpin-src",
171 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
172 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
175 /* Hook up ip4-local features */
176 VNET_FEATURE_INIT (ip4_nat_hairpinning, static) =
178 .arc_name = "ip4-local",
179 .node_name = "nat44-hairpinning",
180 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
182 VNET_FEATURE_INIT (ip4_nat44_ed_hairpinning, static) =
184 .arc_name = "ip4-local",
185 .node_name = "nat44-ed-hairpinning",
186 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
190 VLIB_PLUGIN_REGISTER () = {
191 .version = VPP_BUILD_VER,
192 .description = "Network Address Translation (NAT)",
197 nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index,
200 snat_session_key_t key;
201 clib_bihash_kv_8_8_t kv;
202 nat_ed_ses_key_t ed_key;
203 clib_bihash_kv_16_8_t ed_kv;
204 snat_main_per_thread_data_t *tsm =
205 vec_elt_at_index (sm->per_thread_data, thread_index);
207 if (is_fwd_bypass_session (s))
209 if (snat_is_unk_proto_session (s))
211 ed_key.proto = s->in2out.port;
217 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
218 ed_key.l_port = s->in2out.port;
219 ed_key.r_port = s->ext_host_port;
221 ed_key.l_addr = s->in2out.addr;
222 ed_key.r_addr = s->ext_host_addr;
223 ed_key.fib_index = 0;
224 ed_kv.key[0] = ed_key.as_u64[0];
225 ed_kv.key[1] = ed_key.as_u64[1];
226 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
227 nat_elog_warn ("in2out_ed key del failed");
231 /* session lookup tables */
232 if (is_ed_session (s))
234 if (is_affinity_sessions (s))
235 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
236 s->in2out.protocol, s->out2in.port);
237 ed_key.l_addr = s->out2in.addr;
238 ed_key.r_addr = s->ext_host_addr;
239 ed_key.fib_index = s->out2in.fib_index;
240 if (snat_is_unk_proto_session (s))
242 ed_key.proto = s->in2out.port;
248 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
249 ed_key.l_port = s->out2in.port;
250 ed_key.r_port = s->ext_host_port;
252 ed_kv.key[0] = ed_key.as_u64[0];
253 ed_kv.key[1] = ed_key.as_u64[1];
254 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &ed_kv, 0))
255 nat_elog_warn ("out2in_ed key del failed");
256 ed_key.l_addr = s->in2out.addr;
257 ed_key.fib_index = s->in2out.fib_index;
258 if (!snat_is_unk_proto_session (s))
259 ed_key.l_port = s->in2out.port;
260 if (is_twice_nat_session (s))
262 ed_key.r_addr = s->ext_host_nat_addr;
263 ed_key.r_port = s->ext_host_nat_port;
265 ed_kv.key[0] = ed_key.as_u64[0];
266 ed_kv.key[1] = ed_key.as_u64[1];
267 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
268 nat_elog_warn ("in2out_ed key del failed");
271 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
272 &s->in2out.addr, s->in2out.port,
273 &s->ext_host_nat_addr, s->ext_host_nat_port,
274 &s->out2in.addr, s->out2in.port,
275 &s->ext_host_addr, s->ext_host_port,
276 s->in2out.protocol, is_twice_nat_session (s));
280 kv.key = s->in2out.as_u64;
281 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0))
282 nat_elog_warn ("in2out key del failed");
283 kv.key = s->out2in.as_u64;
284 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0))
285 nat_elog_warn ("out2in key del failed");
288 nat_syslog_nat44_apmdel (s->user_index, s->in2out.fib_index,
289 &s->in2out.addr, s->in2out.port,
290 &s->out2in.addr, s->out2in.port,
294 if (snat_is_unk_proto_session (s))
300 snat_ipfix_logging_nat44_ses_delete (thread_index,
301 s->in2out.addr.as_u32,
302 s->out2in.addr.as_u32,
306 s->in2out.fib_index);
308 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
309 s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
313 /* Twice NAT address and port for external host */
314 if (is_twice_nat_session (s))
316 key.protocol = s->in2out.protocol;
317 key.port = s->ext_host_nat_port;
318 key.addr.as_u32 = s->ext_host_nat_addr.as_u32;
319 snat_free_outside_address_and_port (sm->twice_nat_addresses,
323 if (snat_is_session_static (s))
326 snat_free_outside_address_and_port (sm->addresses, thread_index,
331 nat44_free_session_data (snat_main_t * sm, snat_session_t * s,
332 u32 thread_index, u8 is_ha)
334 snat_session_key_t key;
335 nat_ed_ses_key_t ed_key;
336 clib_bihash_kv_16_8_t ed_kv;
337 snat_main_per_thread_data_t *tsm =
338 vec_elt_at_index (sm->per_thread_data, thread_index);
340 if (is_fwd_bypass_session (s))
342 if (snat_is_unk_proto_session (s))
344 ed_key.proto = s->in2out.port;
350 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
351 ed_key.l_port = s->in2out.port;
352 ed_key.r_port = s->ext_host_port;
355 ed_key.l_addr = s->in2out.addr;
356 ed_key.r_addr = s->ext_host_addr;
357 ed_key.fib_index = 0;
358 ed_kv.key[0] = ed_key.as_u64[0];
359 ed_kv.key[1] = ed_key.as_u64[1];
362 (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0)))
363 nat_elog_warn ("in2out_ed key del failed");
367 /* session lookup tables */
368 if (is_affinity_sessions (s))
369 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
370 s->in2out.protocol, s->out2in.port);
371 ed_key.l_addr = s->out2in.addr;
372 ed_key.r_addr = s->ext_host_addr;
373 ed_key.fib_index = s->out2in.fib_index;
374 if (snat_is_unk_proto_session (s))
376 ed_key.proto = s->in2out.port;
382 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
383 ed_key.l_port = s->out2in.port;
384 ed_key.r_port = s->ext_host_port;
386 ed_kv.key[0] = ed_key.as_u64[0];
387 ed_kv.key[1] = ed_key.as_u64[1];
389 if (PREDICT_FALSE (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &ed_kv, 0)))
390 nat_elog_warn ("out2in_ed key del failed");
392 ed_key.l_addr = s->in2out.addr;
393 ed_key.fib_index = s->in2out.fib_index;
395 if (!snat_is_unk_proto_session (s))
396 ed_key.l_port = s->in2out.port;
398 if (is_twice_nat_session (s))
400 ed_key.r_addr = s->ext_host_nat_addr;
401 ed_key.r_port = s->ext_host_nat_port;
404 ed_kv.key[0] = ed_key.as_u64[0];
405 ed_kv.key[1] = ed_key.as_u64[1];
407 if (PREDICT_FALSE (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0)))
408 nat_elog_warn ("in2out_ed key del failed");
412 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
413 &s->in2out.addr, s->in2out.port,
414 &s->ext_host_nat_addr, s->ext_host_nat_port,
415 &s->out2in.addr, s->out2in.port,
416 &s->ext_host_addr, s->ext_host_port,
417 s->in2out.protocol, is_twice_nat_session (s));
420 if (snat_is_unk_proto_session (s))
426 snat_ipfix_logging_nat44_ses_delete (thread_index,
427 s->in2out.addr.as_u32,
428 s->out2in.addr.as_u32,
432 s->in2out.fib_index);
433 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
434 s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
438 /* Twice NAT address and port for external host */
439 if (is_twice_nat_session (s))
441 key.protocol = s->in2out.protocol;
442 key.port = s->ext_host_nat_port;
443 key.addr.as_u32 = s->ext_host_nat_addr.as_u32;
444 snat_free_outside_address_and_port (sm->twice_nat_addresses,
448 if (snat_is_session_static (s))
451 // should be called for every dynamic session
452 snat_free_outside_address_and_port (sm->addresses, thread_index,
458 nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr, u32 fib_index,
462 snat_user_key_t user_key;
463 clib_bihash_kv_8_8_t kv, value;
464 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
465 dlist_elt_t *per_user_list_head_elt;
467 user_key.addr.as_u32 = addr->as_u32;
468 user_key.fib_index = fib_index;
469 kv.key = user_key.as_u64;
471 /* Ever heard of the "user" = src ip4 address before? */
472 if (clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
474 /* no, make a new one */
475 pool_get (tsm->users, u);
476 clib_memset (u, 0, sizeof (*u));
478 u->addr.as_u32 = addr->as_u32;
479 u->fib_index = fib_index;
481 pool_get (tsm->list_pool, per_user_list_head_elt);
483 u->sessions_per_user_list_head_index = per_user_list_head_elt -
486 clib_dlist_init (tsm->list_pool, u->sessions_per_user_list_head_index);
488 kv.value = u - tsm->users;
491 if (clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 1))
493 nat_elog_warn ("user_hash key add failed");
494 nat44_delete_user_with_no_session (sm, u, thread_index);
498 vlib_set_simple_counter (&sm->total_users, thread_index, 0,
499 pool_elts (tsm->users));
503 u = pool_elt_at_index (tsm->users, value.value);
510 nat_session_alloc_or_recycle (snat_main_t * sm, snat_user_t * u,
511 u32 thread_index, f64 now)
514 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
515 u32 oldest_per_user_translation_list_index, session_index;
516 dlist_elt_t *oldest_per_user_translation_list_elt;
517 dlist_elt_t *per_user_translation_list_elt;
519 /* Over quota? Recycle the least recently used translation */
520 if ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user)
522 oldest_per_user_translation_list_index =
523 clib_dlist_remove_head (tsm->list_pool,
524 u->sessions_per_user_list_head_index);
526 ASSERT (oldest_per_user_translation_list_index != ~0);
528 /* Add it back to the end of the LRU list */
529 clib_dlist_addtail (tsm->list_pool,
530 u->sessions_per_user_list_head_index,
531 oldest_per_user_translation_list_index);
532 /* Get the list element */
533 oldest_per_user_translation_list_elt =
534 pool_elt_at_index (tsm->list_pool,
535 oldest_per_user_translation_list_index);
537 /* Get the session index from the list element */
538 session_index = oldest_per_user_translation_list_elt->value;
540 /* Get the session */
541 s = pool_elt_at_index (tsm->sessions, session_index);
542 nat_free_session_data (sm, s, thread_index, 0);
543 if (snat_is_session_static (s))
544 u->nstaticsessions--;
551 s->ext_host_addr.as_u32 = 0;
552 s->ext_host_port = 0;
553 s->ext_host_nat_addr.as_u32 = 0;
554 s->ext_host_nat_port = 0;
558 pool_get (tsm->sessions, s);
559 clib_memset (s, 0, sizeof (*s));
561 /* Create list elts */
562 pool_get (tsm->list_pool, per_user_translation_list_elt);
563 clib_dlist_init (tsm->list_pool,
564 per_user_translation_list_elt - tsm->list_pool);
566 per_user_translation_list_elt->value = s - tsm->sessions;
567 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
568 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
570 clib_dlist_addtail (tsm->list_pool,
571 s->per_user_list_head_index,
572 per_user_translation_list_elt - tsm->list_pool);
574 dlist_elt_t *global_lru_list_elt;
575 pool_get (tsm->global_lru_pool, global_lru_list_elt);
576 global_lru_list_elt->value = s - tsm->sessions;
577 s->global_lru_index = global_lru_list_elt - tsm->global_lru_pool;
578 clib_dlist_addtail (tsm->global_lru_pool, tsm->global_lru_head_index,
579 s->global_lru_index);
580 s->last_lru_update = now;
582 s->user_index = u - tsm->users;
583 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
584 pool_elts (tsm->sessions));
587 s->ha_last_refreshed = now;
593 nat_global_lru_free_one (snat_main_t * sm, int thread_index, f64 now)
595 snat_session_t *s = NULL;
596 dlist_elt_t *oldest_elt;
597 u64 sess_timeout_time;
599 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
600 oldest_index = clib_dlist_remove_head (tsm->global_lru_pool,
601 tsm->global_lru_head_index);
602 if (~0 != oldest_index)
604 oldest_elt = pool_elt_at_index (tsm->global_lru_pool, oldest_index);
605 s = pool_elt_at_index (tsm->sessions, oldest_elt->value);
608 s->last_heard + (f64) nat44_session_get_timeout (sm, s);
609 if (now >= sess_timeout_time
610 || (s->tcp_close_timestamp && now >= s->tcp_close_timestamp))
612 nat_free_session_data (sm, s, thread_index, 0);
613 nat44_ed_delete_session (sm, s, thread_index, 0);
618 clib_dlist_addhead (tsm->global_lru_pool,
619 tsm->global_lru_head_index, oldest_index);
626 nat_ed_session_alloc (snat_main_t * sm, u32 thread_index, f64 now)
629 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
631 nat_global_lru_free_one (sm, thread_index, now);
633 pool_get (tsm->sessions, s);
634 clib_memset (s, 0, sizeof (*s));
636 nat44_global_lru_insert (tsm, s, now);
638 s->ha_last_refreshed = now;
639 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
640 pool_elts (tsm->sessions));
645 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
648 fib_prefix_t prefix = {
650 .fp_proto = FIB_PROTOCOL_IP4,
652 .ip4.as_u32 = addr->as_u32,
655 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
658 fib_table_entry_update_one_path (fib_index,
661 (FIB_ENTRY_FLAG_CONNECTED |
662 FIB_ENTRY_FLAG_LOCAL |
663 FIB_ENTRY_FLAG_EXCLUSIVE),
667 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
669 fib_table_entry_delete (fib_index, &prefix, nat_fib_src_low);
673 snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
678 vlib_thread_main_t *tm = vlib_get_thread_main ();
680 if (twice_nat && !sm->endpoint_dependent)
681 return VNET_API_ERROR_FEATURE_DISABLED;
683 /* Check if address already exists */
685 vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
687 if (ap->addr.as_u32 == addr->as_u32)
688 return VNET_API_ERROR_VALUE_EXIST;
693 vec_add2 (sm->twice_nat_addresses, ap, 1);
695 vec_add2 (sm->addresses, ap, 1);
700 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
704 #define _(N, i, n, s) \
705 clib_memset(ap->busy_##n##_port_refcounts, 0, sizeof(ap->busy_##n##_port_refcounts));\
706 ap->busy_##n##_ports = 0; \
707 ap->busy_##n##_ports_per_thread = 0;\
708 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
709 foreach_snat_protocol
714 /* Add external address to FIB */
716 pool_foreach (i, sm->interfaces,
718 if (nat_interface_is_inside(i) || sm->out2in_dpo)
721 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
724 pool_foreach (i, sm->output_feature_interfaces,
726 if (nat_interface_is_inside(i) || sm->out2in_dpo)
729 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
738 is_snat_address_used_in_static_mapping (snat_main_t * sm, ip4_address_t addr)
740 snat_static_mapping_t *m;
742 pool_foreach (m, sm->static_mappings,
744 if (is_addr_only_static_mapping (m) ||
745 is_out2in_only_static_mapping (m) ||
746 is_identity_static_mapping (m))
748 if (m->external_addr.as_u32 == addr.as_u32)
757 snat_add_static_mapping_when_resolved (snat_main_t * sm,
758 ip4_address_t l_addr,
763 snat_protocol_t proto,
764 int addr_only, int is_add, u8 * tag,
765 int twice_nat, int out2in_only,
768 snat_static_map_resolve_t *rp;
770 vec_add2 (sm->to_resolve, rp, 1);
771 rp->l_addr.as_u32 = l_addr.as_u32;
773 rp->sw_if_index = sw_if_index;
777 rp->addr_only = addr_only;
779 rp->twice_nat = twice_nat;
780 rp->out2in_only = out2in_only;
781 rp->identity_nat = identity_nat;
782 rp->tag = vec_dup (tag);
786 get_thread_idx_by_port (u16 e_port)
788 snat_main_t *sm = &snat_main;
789 u32 thread_idx = sm->num_workers;
790 if (sm->num_workers > 1)
793 sm->first_worker_index +
794 sm->workers[(e_port - 1024) / sm->port_per_thread];
800 snat_static_mapping_del_sessions (snat_main_t * sm,
801 snat_main_per_thread_data_t * tsm,
802 snat_user_key_t u_key, int addr_only,
803 ip4_address_t e_addr, u16 e_port)
805 clib_bihash_kv_8_8_t kv, value;
806 kv.key = u_key.as_u64;
808 dlist_elt_t *head, *elt;
811 u32 elt_index, head_index, ses_index;
812 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
814 user_index = value.value;
815 u = pool_elt_at_index (tsm->users, user_index);
816 if (u->nstaticsessions)
818 head_index = u->sessions_per_user_list_head_index;
819 head = pool_elt_at_index (tsm->list_pool, head_index);
820 elt_index = head->next;
821 elt = pool_elt_at_index (tsm->list_pool, elt_index);
822 ses_index = elt->value;
823 while (ses_index != ~0)
825 s = pool_elt_at_index (tsm->sessions, ses_index);
826 elt = pool_elt_at_index (tsm->list_pool, elt->next);
827 ses_index = elt->value;
831 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
832 (clib_net_to_host_u16 (s->out2in.port) != e_port))
836 if (is_lb_session (s))
839 if (!snat_is_session_static (s))
842 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
843 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
853 snat_ed_static_mapping_del_sessions (snat_main_t * sm,
854 snat_main_per_thread_data_t * tsm,
855 ip4_address_t l_addr,
858 u32 fib_index, int addr_only,
859 ip4_address_t e_addr, u16 e_port)
862 u32 *indexes_to_free = NULL;
864 pool_foreach (s, tsm->sessions, {
865 if (s->in2out.fib_index != fib_index ||
866 s->in2out.addr.as_u32 != l_addr.as_u32)
872 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
873 (clib_net_to_host_u16 (s->out2in.port) != e_port) ||
874 clib_net_to_host_u16 (s->in2out.port) != l_port ||
875 s->in2out.protocol != protocol)
879 if (is_lb_session (s))
881 if (!snat_is_session_static (s))
883 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
884 vec_add1 (indexes_to_free, s - tsm->sessions);
890 vec_foreach (ses_index, indexes_to_free)
892 s = pool_elt_at_index (tsm->sessions, *ses_index);
893 nat44_ed_delete_session (sm, s, tsm - sm->per_thread_data, 1);
895 vec_free (indexes_to_free);
899 snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
900 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
901 u32 sw_if_index, snat_protocol_t proto, int is_add,
902 twice_nat_type_t twice_nat, u8 out2in_only, u8 * tag,
905 snat_main_t *sm = &snat_main;
906 snat_static_mapping_t *m;
907 snat_session_key_t m_key;
908 clib_bihash_kv_8_8_t kv, value;
909 snat_address_t *a = 0;
911 snat_interface_t *interface;
913 snat_main_per_thread_data_t *tsm;
914 snat_user_key_t u_key;
916 dlist_elt_t *head, *elt;
917 u32 elt_index, head_index;
921 snat_static_map_resolve_t *rp, *rp_match = 0;
922 nat44_lb_addr_port_t *local;
925 if (!sm->endpoint_dependent)
927 if (twice_nat || out2in_only)
928 return VNET_API_ERROR_FEATURE_DISABLED;
931 /* If the external address is a specific interface address */
932 if (sw_if_index != ~0)
934 ip4_address_t *first_int_addr;
936 for (i = 0; i < vec_len (sm->to_resolve); i++)
938 rp = sm->to_resolve + i;
939 if (rp->sw_if_index != sw_if_index ||
940 rp->l_addr.as_u32 != l_addr.as_u32 ||
941 rp->vrf_id != vrf_id || rp->addr_only != addr_only)
946 if ((rp->l_port != l_port && rp->e_port != e_port)
947 || rp->proto != proto)
955 /* Might be already set... */
956 first_int_addr = ip4_interface_first_address
957 (sm->ip4_main, sw_if_index, 0 /* just want the address */ );
962 return VNET_API_ERROR_VALUE_EXIST;
964 snat_add_static_mapping_when_resolved
965 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
966 addr_only, is_add, tag, twice_nat, out2in_only, identity_nat);
968 /* DHCP resolution required? */
969 if (first_int_addr == 0)
975 e_addr.as_u32 = first_int_addr->as_u32;
976 /* Identity mapping? */
977 if (l_addr.as_u32 == 0)
978 l_addr.as_u32 = e_addr.as_u32;
984 return VNET_API_ERROR_NO_SUCH_ENTRY;
986 vec_del1 (sm->to_resolve, i);
990 e_addr.as_u32 = first_int_addr->as_u32;
991 /* Identity mapping? */
992 if (l_addr.as_u32 == 0)
993 l_addr.as_u32 = e_addr.as_u32;
1000 m_key.addr = e_addr;
1001 m_key.port = addr_only ? 0 : e_port;
1002 m_key.protocol = addr_only ? 0 : proto;
1003 m_key.fib_index = 0;
1004 kv.key = m_key.as_u64;
1005 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1008 m = pool_elt_at_index (sm->static_mappings, value.value);
1014 if (is_identity_static_mapping (m))
1017 pool_foreach (local, m->locals,
1019 if (local->vrf_id == vrf_id)
1020 return VNET_API_ERROR_VALUE_EXIST;
1023 pool_get (m->locals, local);
1024 local->vrf_id = vrf_id;
1026 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1028 m_key.addr = m->local_addr;
1029 m_key.port = m->local_port;
1030 m_key.protocol = m->proto;
1031 m_key.fib_index = local->fib_index;
1032 kv.key = m_key.as_u64;
1033 kv.value = m - sm->static_mappings;
1034 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1038 return VNET_API_ERROR_VALUE_EXIST;
1041 if (twice_nat && addr_only)
1042 return VNET_API_ERROR_UNSUPPORTED;
1044 /* Convert VRF id to FIB index */
1047 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1049 /* If not specified use inside VRF id from SNAT plugin startup config */
1052 fib_index = sm->inside_fib_index;
1053 vrf_id = sm->inside_vrf_id;
1054 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1057 if (!(out2in_only || identity_nat))
1059 m_key.addr = l_addr;
1060 m_key.port = addr_only ? 0 : l_port;
1061 m_key.protocol = addr_only ? 0 : proto;
1062 m_key.fib_index = fib_index;
1063 kv.key = m_key.as_u64;
1064 if (!clib_bihash_search_8_8
1065 (&sm->static_mapping_by_local, &kv, &value))
1066 return VNET_API_ERROR_VALUE_EXIST;
1069 /* Find external address in allocated addresses and reserve port for
1070 address and port pair mapping when dynamic translations enabled */
1071 if (!(addr_only || sm->static_mapping_only || out2in_only))
1073 for (i = 0; i < vec_len (sm->addresses); i++)
1075 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1077 a = sm->addresses + i;
1078 /* External port must be unused */
1081 #define _(N, j, n, s) \
1082 case SNAT_PROTOCOL_##N: \
1083 if (a->busy_##n##_port_refcounts[e_port]) \
1084 return VNET_API_ERROR_INVALID_VALUE; \
1085 ++a->busy_##n##_port_refcounts[e_port]; \
1086 if (e_port > 1024) \
1088 a->busy_##n##_ports++; \
1089 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1092 foreach_snat_protocol
1095 nat_elog_info ("unknown protocol");
1096 return VNET_API_ERROR_INVALID_VALUE_2;
1101 /* External address must be allocated */
1102 if (!a && (l_addr.as_u32 != e_addr.as_u32))
1104 if (sw_if_index != ~0)
1106 for (i = 0; i < vec_len (sm->to_resolve); i++)
1108 rp = sm->to_resolve + i;
1111 if (rp->sw_if_index != sw_if_index &&
1112 rp->l_addr.as_u32 != l_addr.as_u32 &&
1113 rp->vrf_id != vrf_id && rp->l_port != l_port &&
1114 rp->e_port != e_port && rp->proto != proto)
1117 vec_del1 (sm->to_resolve, i);
1121 return VNET_API_ERROR_NO_SUCH_ENTRY;
1125 pool_get (sm->static_mappings, m);
1126 clib_memset (m, 0, sizeof (*m));
1127 m->tag = vec_dup (tag);
1128 m->local_addr = l_addr;
1129 m->external_addr = e_addr;
1130 m->twice_nat = twice_nat;
1132 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1134 m->flags |= NAT_STATIC_MAPPING_FLAG_ADDR_ONLY;
1137 m->flags |= NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT;
1138 pool_get (m->locals, local);
1139 local->vrf_id = vrf_id;
1140 local->fib_index = fib_index;
1145 m->fib_index = fib_index;
1149 m->local_port = l_port;
1150 m->external_port = e_port;
1154 if (sm->num_workers > 1)
1157 .src_address = m->local_addr,
1159 vec_add1 (m->workers, sm->worker_in2out_cb (&ip, m->fib_index, 0));
1160 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1163 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1165 m_key.addr = m->local_addr;
1166 m_key.port = m->local_port;
1167 m_key.protocol = m->proto;
1168 m_key.fib_index = fib_index;
1169 kv.key = m_key.as_u64;
1170 kv.value = m - sm->static_mappings;
1172 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1174 m_key.addr = m->external_addr;
1175 m_key.port = m->external_port;
1176 m_key.fib_index = 0;
1177 kv.key = m_key.as_u64;
1178 kv.value = m - sm->static_mappings;
1179 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1);
1181 /* Delete dynamic sessions matching local address (+ local port) */
1182 if (!(sm->static_mapping_only))
1184 u_key.addr = m->local_addr;
1185 u_key.fib_index = m->fib_index;
1186 kv.key = u_key.as_u64;
1187 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1189 user_index = value.value;
1190 u = pool_elt_at_index (tsm->users, user_index);
1193 head_index = u->sessions_per_user_list_head_index;
1194 head = pool_elt_at_index (tsm->list_pool, head_index);
1195 elt_index = head->next;
1196 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1197 ses_index = elt->value;
1198 while (ses_index != ~0)
1200 s = pool_elt_at_index (tsm->sessions, ses_index);
1201 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1202 ses_index = elt->value;
1204 if (snat_is_session_static (s))
1208 && (clib_net_to_host_u16 (s->in2out.port) !=
1212 nat_free_session_data (sm, s,
1213 tsm - sm->per_thread_data, 0);
1214 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1216 if (!addr_only && !sm->endpoint_dependent)
1227 if (sw_if_index != ~0)
1230 return VNET_API_ERROR_NO_SUCH_ENTRY;
1236 vrf_id = sm->inside_vrf_id;
1239 pool_foreach (local, m->locals,
1241 if (local->vrf_id == vrf_id)
1242 find = local - m->locals;
1246 return VNET_API_ERROR_NO_SUCH_ENTRY;
1248 local = pool_elt_at_index (m->locals, find);
1249 fib_index = local->fib_index;
1250 pool_put (m->locals, local);
1253 fib_index = m->fib_index;
1255 /* Free external address port */
1256 if (!(addr_only || sm->static_mapping_only || out2in_only))
1258 for (i = 0; i < vec_len (sm->addresses); i++)
1260 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1262 a = sm->addresses + i;
1265 #define _(N, j, n, s) \
1266 case SNAT_PROTOCOL_##N: \
1267 --a->busy_##n##_port_refcounts[e_port]; \
1268 if (e_port > 1024) \
1270 a->busy_##n##_ports--; \
1271 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1274 foreach_snat_protocol
1277 nat_elog_info ("unknown protocol");
1278 return VNET_API_ERROR_INVALID_VALUE_2;
1285 if (sm->num_workers > 1)
1286 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1288 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1290 m_key.addr = m->local_addr;
1291 m_key.port = m->local_port;
1292 m_key.protocol = m->proto;
1293 m_key.fib_index = fib_index;
1294 kv.key = m_key.as_u64;
1296 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0);
1298 /* Delete session(s) for static mapping if exist */
1299 if (!(sm->static_mapping_only) ||
1300 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
1302 if (sm->endpoint_dependent)
1304 snat_ed_static_mapping_del_sessions (sm, tsm, m->local_addr,
1305 m->local_port, m->proto,
1306 fib_index, addr_only,
1311 u_key.addr = m->local_addr;
1312 u_key.fib_index = fib_index;
1313 kv.key = u_key.as_u64;
1314 snat_static_mapping_del_sessions (sm, tsm, u_key, addr_only,
1319 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1320 if (pool_elts (m->locals))
1323 m_key.addr = m->external_addr;
1324 m_key.port = m->external_port;
1325 m_key.fib_index = 0;
1326 kv.key = m_key.as_u64;
1327 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0);
1330 vec_free (m->workers);
1331 /* Delete static mapping from pool */
1332 pool_put (sm->static_mappings, m);
1335 if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
1338 /* Add/delete external address to FIB */
1340 pool_foreach (interface, sm->interfaces,
1342 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1345 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1348 pool_foreach (interface, sm->output_feature_interfaces,
1350 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1353 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1362 nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1363 snat_protocol_t proto,
1364 nat44_lb_addr_port_t * locals, u8 is_add,
1365 twice_nat_type_t twice_nat, u8 out2in_only,
1366 u8 * tag, u32 affinity)
1368 snat_main_t *sm = &snat_main;
1369 snat_static_mapping_t *m;
1370 snat_session_key_t m_key;
1371 clib_bihash_kv_8_8_t kv, value;
1372 snat_address_t *a = 0;
1374 nat44_lb_addr_port_t *local;
1375 snat_main_per_thread_data_t *tsm;
1379 if (!sm->endpoint_dependent)
1380 return VNET_API_ERROR_FEATURE_DISABLED;
1382 m_key.addr = e_addr;
1383 m_key.port = e_port;
1384 m_key.protocol = proto;
1385 m_key.fib_index = 0;
1386 kv.key = m_key.as_u64;
1387 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1390 m = pool_elt_at_index (sm->static_mappings, value.value);
1395 return VNET_API_ERROR_VALUE_EXIST;
1397 if (vec_len (locals) < 2)
1398 return VNET_API_ERROR_INVALID_VALUE;
1400 /* Find external address in allocated addresses and reserve port for
1401 address and port pair mapping when dynamic translations enabled */
1402 if (!(sm->static_mapping_only || out2in_only))
1404 for (i = 0; i < vec_len (sm->addresses); i++)
1406 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1408 a = sm->addresses + i;
1409 /* External port must be unused */
1412 #define _(N, j, n, s) \
1413 case SNAT_PROTOCOL_##N: \
1414 if (a->busy_##n##_port_refcounts[e_port]) \
1415 return VNET_API_ERROR_INVALID_VALUE; \
1416 ++a->busy_##n##_port_refcounts[e_port]; \
1417 if (e_port > 1024) \
1419 a->busy_##n##_ports++; \
1420 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1423 foreach_snat_protocol
1426 nat_elog_info ("unknown protocol");
1427 return VNET_API_ERROR_INVALID_VALUE_2;
1432 /* External address must be allocated */
1434 return VNET_API_ERROR_NO_SUCH_ENTRY;
1437 pool_get (sm->static_mappings, m);
1438 clib_memset (m, 0, sizeof (*m));
1439 m->tag = vec_dup (tag);
1440 m->external_addr = e_addr;
1441 m->external_port = e_port;
1443 m->twice_nat = twice_nat;
1444 m->flags |= NAT_STATIC_MAPPING_FLAG_LB;
1446 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1447 m->affinity = affinity;
1450 m->affinity_per_service_list_head_index =
1451 nat_affinity_get_per_service_list_head_index ();
1453 m->affinity_per_service_list_head_index = ~0;
1455 m_key.addr = m->external_addr;
1456 m_key.port = m->external_port;
1457 m_key.protocol = m->proto;
1458 m_key.fib_index = 0;
1459 kv.key = m_key.as_u64;
1460 kv.value = m - sm->static_mappings;
1461 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1))
1463 nat_elog_err ("static_mapping_by_external key add failed");
1464 return VNET_API_ERROR_UNSPECIFIED;
1467 m_key.fib_index = m->fib_index;
1468 for (i = 0; i < vec_len (locals); i++)
1470 locals[i].fib_index =
1471 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
1474 m_key.addr = locals[i].addr;
1475 m_key.fib_index = locals[i].fib_index;
1478 m_key.port = locals[i].port;
1479 kv.key = m_key.as_u64;
1480 kv.value = m - sm->static_mappings;
1481 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1483 locals[i].prefix = (i == 0) ? locals[i].probability :
1484 (locals[i - 1].prefix + locals[i].probability);
1485 pool_get (m->locals, local);
1487 if (sm->num_workers > 1)
1490 .src_address = locals[i].addr,
1493 clib_bitmap_set (bitmap,
1494 sm->worker_in2out_cb (&ip, m->fib_index, 0),
1499 /* Assign workers */
1500 if (sm->num_workers > 1)
1503 clib_bitmap_foreach (i, bitmap,
1505 vec_add1(m->workers, i);
1513 return VNET_API_ERROR_NO_SUCH_ENTRY;
1515 if (!is_lb_static_mapping (m))
1516 return VNET_API_ERROR_INVALID_VALUE;
1518 /* Free external address port */
1519 if (!(sm->static_mapping_only || out2in_only))
1521 for (i = 0; i < vec_len (sm->addresses); i++)
1523 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1525 a = sm->addresses + i;
1528 #define _(N, j, n, s) \
1529 case SNAT_PROTOCOL_##N: \
1530 --a->busy_##n##_port_refcounts[e_port]; \
1531 if (e_port > 1024) \
1533 a->busy_##n##_ports--; \
1534 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1537 foreach_snat_protocol
1540 nat_elog_info ("unknown protocol");
1541 return VNET_API_ERROR_INVALID_VALUE_2;
1548 m_key.addr = m->external_addr;
1549 m_key.port = m->external_port;
1550 m_key.protocol = m->proto;
1551 m_key.fib_index = 0;
1552 kv.key = m_key.as_u64;
1553 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0))
1555 nat_elog_err ("static_mapping_by_external key del failed");
1556 return VNET_API_ERROR_UNSPECIFIED;
1560 pool_foreach (local, m->locals,
1562 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4,
1564 m_key.addr = local->addr;
1567 m_key.port = local->port;
1568 m_key.fib_index = local->fib_index;
1569 kv.key = m_key.as_u64;
1570 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1572 nat_elog_err ("static_mapping_by_local key del failed");
1573 return VNET_API_ERROR_UNSPECIFIED;
1577 if (sm->num_workers > 1)
1580 .src_address = local->addr,
1582 tsm = vec_elt_at_index (sm->per_thread_data,
1583 sm->worker_in2out_cb (&ip, m->fib_index, 0));
1586 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1588 /* Delete sessions */
1589 pool_foreach (s, tsm->sessions, {
1590 if (!(is_lb_session (s)))
1593 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1594 (clib_net_to_host_u16 (s->in2out.port) != local->port))
1597 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1598 nat44_ed_delete_session (sm, s, tsm - sm->per_thread_data, 1);
1603 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1604 pool_free (m->locals);
1606 vec_free (m->workers);
1608 pool_put (sm->static_mappings, m);
1615 nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1616 ip4_address_t l_addr, u16 l_port,
1617 snat_protocol_t proto, u32 vrf_id,
1618 u8 probability, u8 is_add)
1620 snat_main_t *sm = &snat_main;
1621 snat_static_mapping_t *m = 0;
1622 snat_session_key_t m_key;
1623 clib_bihash_kv_8_8_t kv, value;
1624 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1625 snat_main_per_thread_data_t *tsm;
1631 if (!sm->endpoint_dependent)
1632 return VNET_API_ERROR_FEATURE_DISABLED;
1634 m_key.addr = e_addr;
1635 m_key.port = e_port;
1636 m_key.protocol = proto;
1637 m_key.fib_index = 0;
1638 kv.key = m_key.as_u64;
1639 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1640 m = pool_elt_at_index (sm->static_mappings, value.value);
1643 return VNET_API_ERROR_NO_SUCH_ENTRY;
1645 if (!is_lb_static_mapping (m))
1646 return VNET_API_ERROR_INVALID_VALUE;
1649 pool_foreach (local, m->locals,
1651 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1652 (local->vrf_id == vrf_id))
1654 match_local = local;
1663 return VNET_API_ERROR_VALUE_EXIST;
1665 pool_get (m->locals, local);
1666 clib_memset (local, 0, sizeof (*local));
1667 local->addr.as_u32 = l_addr.as_u32;
1668 local->port = l_port;
1669 local->probability = probability;
1670 local->vrf_id = vrf_id;
1672 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1675 if (!is_out2in_only_static_mapping (m))
1677 m_key.addr = l_addr;
1678 m_key.port = l_port;
1679 m_key.fib_index = local->fib_index;
1680 kv.key = m_key.as_u64;
1681 kv.value = m - sm->static_mappings;
1682 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1))
1683 nat_elog_err ("static_mapping_by_local key add failed");
1689 return VNET_API_ERROR_NO_SUCH_ENTRY;
1691 if (pool_elts (m->locals) < 3)
1692 return VNET_API_ERROR_UNSPECIFIED;
1694 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1697 if (!is_out2in_only_static_mapping (m))
1699 m_key.addr = l_addr;
1700 m_key.port = l_port;
1701 m_key.fib_index = match_local->fib_index;
1702 kv.key = m_key.as_u64;
1703 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0))
1704 nat_elog_err ("static_mapping_by_local key del failed");
1707 if (sm->num_workers > 1)
1710 .src_address = local->addr,
1712 tsm = vec_elt_at_index (sm->per_thread_data,
1713 sm->worker_in2out_cb (&ip, m->fib_index,
1717 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1719 /* Delete sessions */
1721 pool_foreach (s, tsm->sessions, {
1722 if (!(is_lb_session (s)))
1725 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1726 (clib_net_to_host_u16 (s->in2out.port) != match_local->port))
1729 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1730 nat44_ed_delete_session (sm, s, tsm - sm->per_thread_data, 1);
1734 pool_put (m->locals, match_local);
1737 vec_free (m->workers);
1740 pool_foreach (local, m->locals,
1742 vec_add1 (locals, local - m->locals);
1743 if (sm->num_workers > 1)
1746 ip.src_address.as_u32 = local->addr.as_u32,
1747 bitmap = clib_bitmap_set (bitmap,
1748 sm->worker_in2out_cb (&ip, local->fib_index, 0),
1754 ASSERT (vec_len (locals) > 1);
1756 local = pool_elt_at_index (m->locals, locals[0]);
1757 local->prefix = local->probability;
1758 for (i = 1; i < vec_len (locals); i++)
1760 local = pool_elt_at_index (m->locals, locals[i]);
1761 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1762 local->prefix = local->probability + prev_local->prefix;
1765 /* Assign workers */
1766 if (sm->num_workers > 1)
1769 clib_bitmap_foreach (i, bitmap, ({ vec_add1(m->workers, i); }));
1777 snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1780 snat_address_t *a = 0;
1781 snat_session_t *ses;
1782 u32 *ses_to_be_removed = 0, *ses_index;
1783 snat_main_per_thread_data_t *tsm;
1784 snat_static_mapping_t *m;
1785 snat_interface_t *interface;
1787 snat_address_t *addresses =
1788 twice_nat ? sm->twice_nat_addresses : sm->addresses;
1790 /* Find SNAT address */
1791 for (i = 0; i < vec_len (addresses); i++)
1793 if (addresses[i].addr.as_u32 == addr.as_u32)
1800 return VNET_API_ERROR_NO_SUCH_ENTRY;
1805 pool_foreach (m, sm->static_mappings,
1807 if (m->external_addr.as_u32 == addr.as_u32)
1808 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1809 m->local_port, m->external_port,
1810 m->vrf_id, is_addr_only_static_mapping(m), ~0,
1811 m->proto, 0, m->twice_nat,
1812 is_out2in_only_static_mapping(m), m->tag, is_identity_static_mapping(m));
1818 /* Check if address is used in some static mapping */
1819 if (is_snat_address_used_in_static_mapping (sm, addr))
1821 nat_elog_notice ("address used in static mapping");
1822 return VNET_API_ERROR_UNSPECIFIED;
1826 if (a->fib_index != ~0)
1827 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1829 /* Delete sessions using address */
1830 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1833 vec_foreach (tsm, sm->per_thread_data)
1835 pool_foreach (ses, tsm->sessions, ({
1836 if (ses->out2in.addr.as_u32 == addr.as_u32)
1838 nat_free_session_data (sm, ses, tsm - sm->per_thread_data, 0);
1839 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1843 if (sm->endpoint_dependent){
1844 vec_foreach (ses_index, ses_to_be_removed)
1846 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1847 nat44_ed_delete_session (sm, ses, tsm - sm->per_thread_data, 1);
1850 vec_foreach (ses_index, ses_to_be_removed)
1852 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1853 nat44_delete_session (sm, ses, tsm - sm->per_thread_data);
1857 vec_free (ses_to_be_removed);
1862 #define _(N, i, n, s) \
1863 vec_free (a->busy_##n##_ports_per_thread);
1864 foreach_snat_protocol
1868 vec_del1 (sm->twice_nat_addresses, i);
1872 vec_del1 (sm->addresses, i);
1874 /* Delete external address from FIB */
1876 pool_foreach (interface, sm->interfaces,
1878 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1881 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1884 pool_foreach (interface, sm->output_feature_interfaces,
1886 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1889 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1898 snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1900 snat_main_t *sm = &snat_main;
1901 snat_interface_t *i;
1902 const char *feature_name, *del_feature_name;
1904 snat_static_mapping_t *m;
1906 nat_outside_fib_t *outside_fib;
1907 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1910 if (sm->out2in_dpo && !is_inside)
1911 return VNET_API_ERROR_UNSUPPORTED;
1914 pool_foreach (i, sm->output_feature_interfaces,
1916 if (i->sw_if_index == sw_if_index)
1917 return VNET_API_ERROR_VALUE_EXIST;
1921 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1922 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1925 if (sm->num_workers > 1 && !sm->deterministic)
1927 is_inside ? "nat44-in2out-worker-handoff" :
1928 "nat44-out2in-worker-handoff";
1929 else if (sm->deterministic)
1930 feature_name = is_inside ? "nat44-det-in2out" : "nat44-det-out2in";
1931 else if (sm->endpoint_dependent)
1933 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1936 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1939 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1940 sm->fq_in2out_index =
1941 vlib_frame_queue_main_init (sm->handoff_in2out_index, NAT_FQ_NELTS);
1943 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1944 sm->fq_out2in_index =
1945 vlib_frame_queue_main_init (sm->handoff_out2in_index, NAT_FQ_NELTS);
1950 vec_foreach (outside_fib, sm->outside_fibs)
1952 if (outside_fib->fib_index == fib_index)
1956 outside_fib->refcount--;
1957 if (!outside_fib->refcount)
1958 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1961 outside_fib->refcount++;
1968 vec_add2 (sm->outside_fibs, outside_fib, 1);
1969 outside_fib->refcount = 1;
1970 outside_fib->fib_index = fib_index;
1975 pool_foreach (i, sm->interfaces,
1977 if (i->sw_if_index == sw_if_index)
1981 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1984 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1986 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1988 if (sm->num_workers > 1 && !sm->deterministic)
1990 del_feature_name = "nat44-handoff-classify";
1991 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1992 "nat44-out2in-worker-handoff";
1994 else if (sm->deterministic)
1996 del_feature_name = "nat44-det-classify";
1997 feature_name = !is_inside ? "nat44-det-in2out" :
2000 else if (sm->endpoint_dependent)
2002 del_feature_name = "nat44-ed-classify";
2003 feature_name = !is_inside ? "nat-pre-in2out" :
2008 del_feature_name = "nat44-classify";
2009 feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
2012 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2015 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
2016 sw_if_index, 0, 0, 0);
2017 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2018 sw_if_index, 1, 0, 0);
2021 if (sm->endpoint_dependent)
2022 vnet_feature_enable_disable ("ip4-local",
2023 "nat44-ed-hairpinning",
2024 sw_if_index, 1, 0, 0);
2025 else if (!sm->deterministic)
2026 vnet_feature_enable_disable ("ip4-local",
2027 "nat44-hairpinning",
2028 sw_if_index, 1, 0, 0);
2033 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2036 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2037 sw_if_index, 0, 0, 0);
2038 pool_put (sm->interfaces, i);
2041 if (sm->endpoint_dependent)
2042 vnet_feature_enable_disable ("ip4-local",
2043 "nat44-ed-hairpinning",
2044 sw_if_index, 0, 0, 0);
2045 else if (!sm->deterministic)
2046 vnet_feature_enable_disable ("ip4-local",
2047 "nat44-hairpinning",
2048 sw_if_index, 0, 0, 0);
2054 if ((nat_interface_is_inside(i) && is_inside) ||
2055 (nat_interface_is_outside(i) && !is_inside))
2058 if (sm->num_workers > 1 && !sm->deterministic)
2060 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
2061 "nat44-out2in-worker-handoff";
2062 feature_name = "nat44-handoff-classify";
2064 else if (sm->deterministic)
2066 del_feature_name = !is_inside ? "nat44-det-in2out" :
2068 feature_name = "nat44-det-classify";
2070 else if (sm->endpoint_dependent)
2072 del_feature_name = !is_inside ? "nat-pre-in2out" :
2075 feature_name = "nat44-ed-classify";
2079 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
2080 feature_name = "nat44-classify";
2083 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
2086 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
2087 sw_if_index, 0, 0, 0);
2088 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2089 sw_if_index, 1, 0, 0);
2092 if (sm->endpoint_dependent)
2093 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
2094 sw_if_index, 0, 0, 0);
2095 else if (!sm->deterministic)
2096 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
2097 sw_if_index, 0, 0, 0);
2108 return VNET_API_ERROR_NO_SUCH_ENTRY;
2110 pool_get (sm->interfaces, i);
2111 i->sw_if_index = sw_if_index;
2113 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0,
2116 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
2120 if (is_inside && !sm->out2in_dpo)
2122 if (sm->endpoint_dependent)
2123 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
2124 sw_if_index, 1, 0, 0);
2125 else if (!sm->deterministic)
2126 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
2127 sw_if_index, 1, 0, 0);
2133 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2137 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2139 /* Add/delete external addresses to FIB */
2142 vec_foreach (ap, sm->addresses)
2143 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2145 pool_foreach (m, sm->static_mappings,
2147 if (!(is_addr_only_static_mapping(m)) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2150 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2153 pool_foreach (dm, sm->det_maps,
2155 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
2163 snat_interface_add_del_output_feature (u32 sw_if_index,
2164 u8 is_inside, int is_del)
2166 snat_main_t *sm = &snat_main;
2167 snat_interface_t *i;
2169 snat_static_mapping_t *m;
2170 nat_outside_fib_t *outside_fib;
2171 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
2175 if (sm->deterministic ||
2176 (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
2177 return VNET_API_ERROR_UNSUPPORTED;
2180 pool_foreach (i, sm->interfaces,
2182 if (i->sw_if_index == sw_if_index)
2183 return VNET_API_ERROR_VALUE_EXIST;
2190 vec_foreach (outside_fib, sm->outside_fibs)
2192 if (outside_fib->fib_index == fib_index)
2196 outside_fib->refcount--;
2197 if (!outside_fib->refcount)
2198 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2201 outside_fib->refcount++;
2208 vec_add2 (sm->outside_fibs, outside_fib, 1);
2209 outside_fib->refcount = 1;
2210 outside_fib->fib_index = fib_index;
2217 if (sm->endpoint_dependent)
2220 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2224 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2228 vnet_feature_enable_disable ("ip4-unicast", "nat44-ed-hairpin-dst",
2229 sw_if_index, !is_del, 0, 0);
2230 vnet_feature_enable_disable ("ip4-output", "nat44-ed-hairpin-src",
2231 sw_if_index, !is_del, 0, 0);
2236 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2240 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2244 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
2245 sw_if_index, !is_del, 0, 0);
2246 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
2247 sw_if_index, !is_del, 0, 0);
2252 if (sm->num_workers > 1)
2254 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2258 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, !is_del);
2261 vnet_feature_enable_disable ("ip4-unicast",
2262 "nat44-out2in-worker-handoff",
2263 sw_if_index, !is_del, 0, 0);
2264 vnet_feature_enable_disable ("ip4-output",
2265 "nat44-in2out-output-worker-handoff",
2266 sw_if_index, !is_del, 0, 0);
2270 if (sm->endpoint_dependent)
2273 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2277 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2281 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
2282 sw_if_index, !is_del, 0, 0);
2283 vnet_feature_enable_disable ("ip4-output", "nat44-ed-in2out-output",
2284 sw_if_index, !is_del, 0, 0);
2289 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2293 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2297 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in",
2298 sw_if_index, !is_del, 0, 0);
2299 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
2300 sw_if_index, !is_del, 0, 0);
2305 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
2306 sm->fq_in2out_output_index =
2307 vlib_frame_queue_main_init (sm->handoff_in2out_output_index, 0);
2309 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
2310 sm->fq_out2in_index =
2311 vlib_frame_queue_main_init (sm->handoff_out2in_index, 0);
2314 pool_foreach (i, sm->output_feature_interfaces,
2316 if (i->sw_if_index == sw_if_index)
2319 pool_put (sm->output_feature_interfaces, i);
2321 return VNET_API_ERROR_VALUE_EXIST;
2329 return VNET_API_ERROR_NO_SUCH_ENTRY;
2331 pool_get (sm->output_feature_interfaces, i);
2332 i->sw_if_index = sw_if_index;
2335 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2337 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2339 /* Add/delete external addresses to FIB */
2345 vec_foreach (ap, sm->addresses)
2346 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2348 pool_foreach (m, sm->static_mappings,
2350 if (!((is_addr_only_static_mapping(m))) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2353 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2361 snat_set_workers (uword * bitmap)
2363 snat_main_t *sm = &snat_main;
2366 if (sm->num_workers < 2)
2367 return VNET_API_ERROR_FEATURE_DISABLED;
2369 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2370 return VNET_API_ERROR_INVALID_WORKER;
2372 vec_free (sm->workers);
2374 clib_bitmap_foreach (i, bitmap,
2376 vec_add1(sm->workers, i);
2377 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2378 sm->per_thread_data[sm->first_worker_index + i].thread_index = i;
2383 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
2384 sm->num_snat_thread = _vec_len (sm->workers);
2390 snat_update_outside_fib (u32 sw_if_index, u32 new_fib_index,
2393 snat_main_t *sm = &snat_main;
2394 nat_outside_fib_t *outside_fib;
2395 snat_interface_t *i;
2399 if (new_fib_index == old_fib_index)
2402 if (!vec_len (sm->outside_fibs))
2406 pool_foreach (i, sm->interfaces,
2408 if (i->sw_if_index == sw_if_index)
2410 if (!(nat_interface_is_outside (i)))
2416 pool_foreach (i, sm->output_feature_interfaces,
2418 if (i->sw_if_index == sw_if_index)
2420 if (!(nat_interface_is_outside (i)))
2430 vec_foreach (outside_fib, sm->outside_fibs)
2432 if (outside_fib->fib_index == old_fib_index)
2434 outside_fib->refcount--;
2435 if (!outside_fib->refcount)
2436 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2441 vec_foreach (outside_fib, sm->outside_fibs)
2443 if (outside_fib->fib_index == new_fib_index)
2445 outside_fib->refcount++;
2453 vec_add2 (sm->outside_fibs, outside_fib, 1);
2454 outside_fib->refcount = 1;
2455 outside_fib->fib_index = new_fib_index;
2460 snat_ip4_table_bind (ip4_main_t * im,
2462 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
2464 snat_update_outside_fib (sw_if_index, new_fib_index, old_fib_index);
2468 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2471 ip4_address_t * address,
2473 u32 if_address_index, u32 is_delete);
2476 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
2479 ip4_address_t * address,
2481 u32 if_address_index, u32 is_delete);
2484 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2487 snat_session_key_t * k,
2488 u16 port_per_thread, u32 snat_thread_index);
2490 static clib_error_t *
2491 snat_init (vlib_main_t * vm)
2493 snat_main_t *sm = &snat_main;
2494 clib_error_t *error = 0;
2495 ip4_main_t *im = &ip4_main;
2496 ip_lookup_main_t *lm = &im->lookup_main;
2498 vlib_thread_registration_t *tr;
2499 vlib_thread_main_t *tm = vlib_get_thread_main ();
2502 ip4_add_del_interface_address_callback_t cb4;
2506 sm->vnet_main = vnet_get_main ();
2508 sm->ip4_lookup_main = lm;
2509 sm->api_main = vlibapi_get_main ();
2510 sm->first_worker_index = 0;
2511 sm->num_workers = 0;
2512 sm->num_snat_thread = 1;
2514 sm->port_per_thread = 0xffff - 1024;
2515 sm->fq_in2out_index = ~0;
2516 sm->fq_in2out_output_index = ~0;
2517 sm->fq_out2in_index = ~0;
2519 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
2520 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
2521 sm->forwarding_enabled = 0;
2522 sm->log_class = vlib_log_register_class ("nat", 0);
2523 sm->log_level = SNAT_LOG_ERROR;
2524 sm->mss_clamping = 0;
2526 node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
2527 sm->error_node_index = node->index;
2529 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2530 sm->pre_in2out_node_index = node->index;
2531 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2532 sm->pre_out2in_node_index = node->index;
2534 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2535 sm->pre_in2out_node_index = node->index;
2537 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2538 sm->pre_out2in_node_index = node->index;
2540 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out");
2541 sm->in2out_node_index = node->index;
2542 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output");
2543 sm->in2out_output_node_index = node->index;
2544 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-fast");
2545 sm->in2out_fast_node_index = node->index;
2546 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-slowpath");
2547 sm->in2out_slowpath_node_index = node->index;
2548 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output-slowpath");
2549 sm->in2out_slowpath_output_node_index = node->index;
2551 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out");
2552 sm->ed_in2out_node_index = node->index;
2553 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-slowpath");
2554 sm->ed_in2out_slowpath_node_index = node->index;
2556 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in");
2557 sm->out2in_node_index = node->index;
2558 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in-fast");
2559 sm->out2in_fast_node_index = node->index;
2561 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in");
2562 sm->ed_out2in_node_index = node->index;
2563 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in-slowpath");
2564 sm->ed_out2in_slowpath_node_index = node->index;
2566 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-in2out");
2567 sm->det_in2out_node_index = node->index;
2568 node = vlib_get_node_by_name (vm, (u8 *) "nat44-det-out2in");
2569 sm->det_out2in_node_index = node->index;
2571 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpinning");
2572 sm->hairpinning_node_index = node->index;
2573 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-dst");
2574 sm->hairpin_dst_node_index = node->index;
2575 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-src");
2576 sm->hairpin_src_node_index = node->index;
2577 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpinning");
2578 sm->ed_hairpinning_node_index = node->index;
2579 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-dst");
2580 sm->ed_hairpin_dst_node_index = node->index;
2581 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-src");
2582 sm->ed_hairpin_src_node_index = node->index;
2584 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2587 tr = (vlib_thread_registration_t *) p[0];
2590 sm->num_workers = tr->count;
2591 sm->first_worker_index = tr->first_index;
2595 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2597 /* Use all available workers by default */
2598 if (sm->num_workers > 1)
2600 for (i = 0; i < sm->num_workers; i++)
2601 bitmap = clib_bitmap_set (bitmap, i, 1);
2602 snat_set_workers (bitmap);
2603 clib_bitmap_free (bitmap);
2607 sm->per_thread_data[0].snat_thread_index = 0;
2610 error = snat_api_init (vm, sm);
2614 /* Set up the interface address add/del callback */
2615 cb4.function = snat_ip4_add_del_interface_address_cb;
2616 cb4.function_opaque = 0;
2618 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2620 cb4.function = nat_ip4_add_del_addr_only_sm_cb;
2621 cb4.function_opaque = 0;
2623 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2625 nat_dpo_module_init ();
2628 sm->total_users.name = "total-users";
2629 sm->total_users.stat_segment_name = "/nat44/total-users";
2630 vlib_validate_simple_counter (&sm->total_users, 0);
2631 vlib_zero_simple_counter (&sm->total_users, 0);
2632 sm->total_sessions.name = "total-sessions";
2633 sm->total_sessions.stat_segment_name = "/nat44/total-sessions";
2634 vlib_validate_simple_counter (&sm->total_sessions, 0);
2635 vlib_zero_simple_counter (&sm->total_sessions, 0);
2637 /* Init IPFIX logging */
2638 snat_ipfix_logging_init (vm);
2641 error = nat64_init (vm);
2647 ip4_table_bind_callback_t cbt4 = {
2648 .function = snat_ip4_table_bind,
2650 vec_add1 (ip4_main.table_bind_callbacks, cbt4);
2652 nat_fib_src_hi = fib_source_allocate ("nat-hi",
2653 FIB_SOURCE_PRIORITY_HI,
2654 FIB_SOURCE_BH_SIMPLE);
2655 nat_fib_src_low = fib_source_allocate ("nat-low",
2656 FIB_SOURCE_PRIORITY_LOW,
2657 FIB_SOURCE_BH_SIMPLE);
2662 VLIB_INIT_FUNCTION (snat_init);
2665 snat_free_outside_address_and_port (snat_address_t * addresses,
2666 u32 thread_index, snat_session_key_t * k)
2670 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2672 for (address_index = 0; address_index < vec_len (addresses);
2675 if (addresses[address_index].addr.as_u32 == k->addr.as_u32)
2679 ASSERT (address_index < vec_len (addresses));
2681 a = addresses + address_index;
2683 switch (k->protocol)
2685 #define _(N, i, n, s) \
2686 case SNAT_PROTOCOL_##N: \
2687 ASSERT (a->busy_##n##_port_refcounts[port_host_byte_order] >= 1); \
2688 --a->busy_##n##_port_refcounts[port_host_byte_order]; \
2689 a->busy_##n##_ports--; \
2690 a->busy_##n##_ports_per_thread[thread_index]--; \
2692 foreach_snat_protocol
2695 nat_elog_info ("unknown protocol");
2701 nat_set_outside_address_and_port (snat_address_t * addresses,
2702 u32 thread_index, snat_session_key_t * k)
2704 snat_address_t *a = 0;
2706 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2708 for (address_index = 0; address_index < vec_len (addresses);
2711 if (addresses[address_index].addr.as_u32 != k->addr.as_u32)
2714 a = addresses + address_index;
2715 switch (k->protocol)
2717 #define _(N, j, n, s) \
2718 case SNAT_PROTOCOL_##N: \
2719 if (a->busy_##n##_port_refcounts[port_host_byte_order]) \
2720 return VNET_API_ERROR_INSTANCE_IN_USE; \
2721 ++a->busy_##n##_port_refcounts[port_host_byte_order]; \
2722 a->busy_##n##_ports_per_thread[thread_index]++; \
2723 a->busy_##n##_ports++; \
2725 foreach_snat_protocol
2728 nat_elog_info ("unknown protocol");
2733 return VNET_API_ERROR_NO_SUCH_ENTRY;
2737 snat_static_mapping_match (snat_main_t * sm,
2738 snat_session_key_t match,
2739 snat_session_key_t * mapping,
2742 twice_nat_type_t * twice_nat,
2743 lb_nat_type_t * lb, ip4_address_t * ext_host_addr,
2744 u8 * is_identity_nat)
2746 clib_bihash_kv_8_8_t kv, value;
2747 snat_static_mapping_t *m;
2748 snat_session_key_t m_key;
2749 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
2750 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2752 nat44_lb_addr_port_t *local;
2754 m_key.fib_index = match.fib_index;
2757 mapping_hash = &sm->static_mapping_by_external;
2758 m_key.fib_index = 0;
2761 m_key.addr = match.addr;
2762 m_key.port = clib_net_to_host_u16 (match.port);
2763 m_key.protocol = match.protocol;
2765 kv.key = m_key.as_u64;
2767 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2769 /* Try address only mapping */
2772 kv.key = m_key.as_u64;
2773 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2777 m = pool_elt_at_index (sm->static_mappings, value.value);
2781 if (is_lb_static_mapping (m))
2783 if (PREDICT_FALSE (lb != 0))
2784 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2785 if (m->affinity && !nat_affinity_find_and_lock (ext_host_addr[0],
2791 local = pool_elt_at_index (m->locals, backend_index);
2792 mapping->addr = local->addr;
2793 mapping->port = clib_host_to_net_u16 (local->port);
2794 mapping->fib_index = local->fib_index;
2797 // pick locals matching this worker
2798 if (PREDICT_FALSE (sm->num_workers > 1))
2800 u32 thread_index = vlib_get_thread_index ();
2802 pool_foreach_index (i, m->locals,
2804 local = pool_elt_at_index (m->locals, i);
2807 .src_address = local->addr,
2810 if (sm->worker_in2out_cb (&ip, m->fib_index, 0) ==
2817 ASSERT (vec_len (tmp) != 0);
2822 pool_foreach_index (i, m->locals,
2828 hi = vec_len (tmp) - 1;
2829 local = pool_elt_at_index (m->locals, tmp[hi]);
2830 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2833 mid = ((hi - lo) >> 1) + lo;
2834 local = pool_elt_at_index (m->locals, tmp[mid]);
2835 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2837 local = pool_elt_at_index (m->locals, tmp[lo]);
2838 if (!(local->prefix >= rand))
2840 mapping->addr = local->addr;
2841 mapping->port = clib_host_to_net_u16 (local->port);
2842 mapping->fib_index = local->fib_index;
2845 if (nat_affinity_create_and_lock (ext_host_addr[0], match.addr,
2846 match.protocol, match.port,
2847 tmp[lo], m->affinity,
2848 m->affinity_per_service_list_head_index))
2849 nat_elog_info ("create affinity record failed");
2855 if (PREDICT_FALSE (lb != 0))
2857 mapping->fib_index = m->fib_index;
2858 mapping->addr = m->local_addr;
2859 /* Address only mapping doesn't change port */
2860 mapping->port = is_addr_only_static_mapping (m) ? match.port
2861 : clib_host_to_net_u16 (m->local_port);
2863 mapping->protocol = m->proto;
2867 mapping->addr = m->external_addr;
2868 /* Address only mapping doesn't change port */
2869 mapping->port = is_addr_only_static_mapping (m) ? match.port
2870 : clib_host_to_net_u16 (m->external_port);
2871 mapping->fib_index = sm->outside_fib_index;
2875 if (PREDICT_FALSE (is_addr_only != 0))
2876 *is_addr_only = is_addr_only_static_mapping (m);
2878 if (PREDICT_FALSE (twice_nat != 0))
2879 *twice_nat = m->twice_nat;
2881 if (PREDICT_FALSE (is_identity_nat != 0))
2882 *is_identity_nat = is_identity_static_mapping (m);
2887 static_always_inline u16
2888 snat_random_port (u16 min, u16 max)
2890 snat_main_t *sm = &snat_main;
2891 return min + random_u32 (&sm->random_seed) /
2892 (random_u32_max () / (max - min + 1) + 1);
2896 snat_alloc_outside_address_and_port (snat_address_t * addresses,
2899 snat_session_key_t * k,
2900 u16 port_per_thread,
2901 u32 snat_thread_index)
2903 snat_main_t *sm = &snat_main;
2905 return sm->alloc_addr_and_port (addresses, fib_index, thread_index, k,
2906 port_per_thread, snat_thread_index);
2910 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2913 snat_session_key_t * k,
2914 u16 port_per_thread, u32 snat_thread_index)
2917 snat_address_t *a, *ga = 0;
2920 for (i = 0; i < vec_len (addresses); i++)
2923 switch (k->protocol)
2925 #define _(N, j, n, s) \
2926 case SNAT_PROTOCOL_##N: \
2927 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
2929 if (a->fib_index == fib_index) \
2933 portnum = (port_per_thread * \
2934 snat_thread_index) + \
2935 snat_random_port(1, port_per_thread) + 1024; \
2936 if (a->busy_##n##_port_refcounts[portnum]) \
2938 --a->busy_##n##_port_refcounts[portnum]; \
2939 a->busy_##n##_ports_per_thread[thread_index]++; \
2940 a->busy_##n##_ports++; \
2941 k->addr = a->addr; \
2942 k->port = clib_host_to_net_u16(portnum); \
2946 else if (a->fib_index == ~0) \
2952 foreach_snat_protocol
2955 nat_elog_info ("unknown protocol");
2964 switch (k->protocol)
2966 #define _(N, j, n, s) \
2967 case SNAT_PROTOCOL_##N: \
2970 portnum = (port_per_thread * \
2971 snat_thread_index) + \
2972 snat_random_port(1, port_per_thread) + 1024; \
2973 if (a->busy_##n##_port_refcounts[portnum]) \
2975 ++a->busy_##n##_port_refcounts[portnum]; \
2976 a->busy_##n##_ports_per_thread[thread_index]++; \
2977 a->busy_##n##_ports++; \
2978 k->addr = a->addr; \
2979 k->port = clib_host_to_net_u16(portnum); \
2983 foreach_snat_protocol
2986 nat_elog_info ("unknown protocol");
2991 /* Totally out of translations to use... */
2992 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
2997 nat_alloc_addr_and_port_mape (snat_address_t * addresses,
3000 snat_session_key_t * k,
3001 u16 port_per_thread, u32 snat_thread_index)
3003 snat_main_t *sm = &snat_main;
3004 snat_address_t *a = addresses;
3005 u16 m, ports, portnum, A, j;
3006 m = 16 - (sm->psid_offset + sm->psid_length);
3007 ports = (1 << (16 - sm->psid_length)) - (1 << m);
3009 if (!vec_len (addresses))
3012 switch (k->protocol)
3014 #define _(N, i, n, s) \
3015 case SNAT_PROTOCOL_##N: \
3016 if (a->busy_##n##_ports < ports) \
3020 A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
3021 j = snat_random_port(0, pow2_mask(m)); \
3022 portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
3023 if (a->busy_##n##_port_refcounts[portnum]) \
3025 ++a->busy_##n##_port_refcounts[portnum]; \
3026 a->busy_##n##_ports++; \
3027 k->addr = a->addr; \
3028 k->port = clib_host_to_net_u16 (portnum); \
3033 foreach_snat_protocol
3036 nat_elog_info ("unknown protocol");
3041 /* Totally out of translations to use... */
3042 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3047 nat_alloc_addr_and_port_range (snat_address_t * addresses,
3050 snat_session_key_t * k,
3051 u16 port_per_thread, u32 snat_thread_index)
3053 snat_main_t *sm = &snat_main;
3054 snat_address_t *a = addresses;
3057 ports = sm->end_port - sm->start_port + 1;
3059 if (!vec_len (addresses))
3062 switch (k->protocol)
3064 #define _(N, i, n, s) \
3065 case SNAT_PROTOCOL_##N: \
3066 if (a->busy_##n##_ports < ports) \
3070 portnum = snat_random_port(sm->start_port, sm->end_port); \
3071 if (a->busy_##n##_port_refcounts[portnum]) \
3073 ++a->busy_##n##_port_refcounts[portnum]; \
3074 a->busy_##n##_ports++; \
3075 k->addr = a->addr; \
3076 k->port = clib_host_to_net_u16 (portnum); \
3081 foreach_snat_protocol
3084 nat_elog_info ("unknown protocol");
3089 /* Totally out of translations to use... */
3090 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3095 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
3097 dpo_id_t dpo_v4 = DPO_INVALID;
3098 fib_prefix_t pfx = {
3099 .fp_proto = FIB_PROTOCOL_IP4,
3101 .fp_addr.ip4.as_u32 = addr.as_u32,
3106 nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
3107 fib_table_entry_special_dpo_add (0, &pfx, nat_fib_src_hi,
3108 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
3109 dpo_reset (&dpo_v4);
3113 fib_table_entry_special_remove (0, &pfx, nat_fib_src_hi);
3118 format_session_kvp (u8 * s, va_list * args)
3120 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3121 snat_session_key_t k;
3125 s = format (s, "%U session-index %llu", format_snat_key, &k, v->value);
3131 format_static_mapping_kvp (u8 * s, va_list * args)
3133 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3134 snat_session_key_t k;
3138 s = format (s, "%U static-mapping-index %llu",
3139 format_static_mapping_key, &k, v->value);
3145 format_user_kvp (u8 * s, va_list * args)
3147 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3152 s = format (s, "%U fib %d user-index %llu", format_ip4_address, &k.addr,
3153 k.fib_index, v->value);
3159 format_ed_session_kvp (u8 * s, va_list * args)
3161 clib_bihash_kv_16_8_t *v = va_arg (*args, clib_bihash_kv_16_8_t *);
3164 k.as_u64[0] = v->key[0];
3165 k.as_u64[1] = v->key[1];
3168 format (s, "local %U:%d remote %U:%d proto %U fib %d session-index %llu",
3169 format_ip4_address, &k.l_addr, clib_net_to_host_u16 (k.l_port),
3170 format_ip4_address, &k.r_addr, clib_net_to_host_u16 (k.r_port),
3171 format_ip_protocol, k.proto, k.fib_index, v->value);
3177 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0,
3180 snat_main_t *sm = &snat_main;
3181 u32 next_worker_index = 0;
3184 next_worker_index = sm->first_worker_index;
3185 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
3186 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >> 24);
3188 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3189 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3191 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3193 return next_worker_index;
3197 snat_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip0,
3198 u32 rx_fib_index0, u8 is_output)
3200 snat_main_t *sm = &snat_main;
3203 snat_session_key_t m_key;
3204 clib_bihash_kv_8_8_t kv, value;
3205 snat_static_mapping_t *m;
3207 u32 next_worker_index = 0;
3209 /* first try static mappings without port */
3210 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3212 m_key.addr = ip0->dst_address;
3215 m_key.fib_index = rx_fib_index0;
3216 kv.key = m_key.as_u64;
3217 if (!clib_bihash_search_8_8
3218 (&sm->static_mapping_by_external, &kv, &value))
3220 m = pool_elt_at_index (sm->static_mappings, value.value);
3221 return m->workers[0];
3225 proto = ip_proto_to_snat_proto (ip0->protocol);
3226 udp = ip4_next_header (ip0);
3227 port = udp->dst_port;
3229 /* unknown protocol */
3230 if (PREDICT_FALSE (proto == ~0))
3232 /* use current thread */
3233 return vlib_get_thread_index ();
3236 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
3238 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3239 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3240 if (!icmp_type_is_error_message
3241 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3242 port = vnet_buffer (b)->ip.reass.l4_src_port;
3245 /* if error message, then it's not fragmented and we can access it */
3246 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3247 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3248 void *l4_header = ip4_next_header (inner_ip);
3251 case SNAT_PROTOCOL_ICMP:
3252 icmp = (icmp46_header_t *) l4_header;
3253 echo = (icmp_echo_header_t *) (icmp + 1);
3254 port = echo->identifier;
3256 case SNAT_PROTOCOL_UDP:
3257 case SNAT_PROTOCOL_TCP:
3258 port = ((tcp_udp_header_t *) l4_header)->src_port;
3261 return vlib_get_thread_index ();
3266 /* try static mappings with port */
3267 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3269 m_key.addr = ip0->dst_address;
3270 m_key.port = clib_net_to_host_u16 (port);
3271 m_key.protocol = proto;
3272 m_key.fib_index = rx_fib_index0;
3273 kv.key = m_key.as_u64;
3274 if (!clib_bihash_search_8_8
3275 (&sm->static_mapping_by_external, &kv, &value))
3277 m = pool_elt_at_index (sm->static_mappings, value.value);
3278 return m->workers[0];
3282 /* worker by outside port */
3283 next_worker_index = sm->first_worker_index;
3284 next_worker_index +=
3285 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3286 return next_worker_index;
3290 nat44_ed_get_worker_in2out_cb (ip4_header_t * ip, u32 rx_fib_index,
3293 snat_main_t *sm = &snat_main;
3294 u32 next_worker_index = sm->first_worker_index;
3297 clib_bihash_kv_16_8_t kv16, value16;
3298 snat_main_per_thread_data_t *tsm;
3301 if (PREDICT_FALSE (is_output))
3303 u32 fib_index = sm->outside_fib_index;
3304 nat_outside_fib_t *outside_fib;
3305 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3306 fib_prefix_t pfx = {
3307 .fp_proto = FIB_PROTOCOL_IP4,
3310 .ip4.as_u32 = ip->dst_address.as_u32,
3315 udp = ip4_next_header (ip);
3317 switch (vec_len (sm->outside_fibs))
3320 fib_index = sm->outside_fib_index;
3323 fib_index = sm->outside_fibs[0].fib_index;
3327 vec_foreach (outside_fib, sm->outside_fibs)
3329 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3330 if (FIB_NODE_INDEX_INVALID != fei)
3332 if (fib_entry_get_resolving_interface (fei) != ~0)
3334 fib_index = outside_fib->fib_index;
3343 make_ed_kv (&kv16, &ip->src_address, &ip->dst_address,
3344 ip->protocol, fib_index, udp->src_port, udp->dst_port);
3347 vec_foreach (tsm, sm->per_thread_data)
3349 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3352 next_worker_index += tsm->thread_index;
3354 nat_elog_debug_handoff (
3355 "HANDOFF IN2OUT-OUTPUT-FEATURE (session)",
3356 next_worker_index, fib_index,
3357 clib_net_to_host_u32 (ip->src_address.as_u32),
3358 clib_net_to_host_u32 (ip->dst_address.as_u32));
3360 return next_worker_index;
3366 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3367 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3369 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3370 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3372 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3374 if (PREDICT_TRUE (!is_output))
3376 nat_elog_debug_handoff ("HANDOFF IN2OUT",
3377 next_worker_index, rx_fib_index,
3378 clib_net_to_host_u32 (ip->src_address.as_u32),
3379 clib_net_to_host_u32 (ip->dst_address.as_u32));
3383 nat_elog_debug_handoff ("HANDOFF IN2OUT-OUTPUT-FEATURE",
3384 next_worker_index, rx_fib_index,
3385 clib_net_to_host_u32 (ip->src_address.as_u32),
3386 clib_net_to_host_u32 (ip->dst_address.as_u32));
3389 return next_worker_index;
3393 nat44_ed_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip,
3394 u32 rx_fib_index, u8 is_output)
3396 snat_main_t *sm = &snat_main;
3397 clib_bihash_kv_8_8_t kv, value;
3398 clib_bihash_kv_16_8_t kv16, value16;
3399 snat_main_per_thread_data_t *tsm;
3401 u32 proto, next_worker_index = 0;
3404 snat_static_mapping_t *m;
3407 proto = ip_proto_to_snat_proto (ip->protocol);
3409 if (PREDICT_TRUE (proto == SNAT_PROTOCOL_UDP || proto == SNAT_PROTOCOL_TCP))
3411 udp = ip4_next_header (ip);
3413 make_ed_kv (&kv16, &ip->dst_address, &ip->src_address,
3414 ip->protocol, rx_fib_index, udp->dst_port, udp->src_port);
3417 vec_foreach (tsm, sm->per_thread_data)
3419 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3422 next_worker_index = sm->first_worker_index + tsm->thread_index;
3423 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3424 next_worker_index, rx_fib_index,
3425 clib_net_to_host_u32 (ip->src_address.as_u32),
3426 clib_net_to_host_u32 (ip->dst_address.as_u32));
3427 return next_worker_index;
3432 else if (proto == SNAT_PROTOCOL_ICMP)
3434 nat_ed_ses_key_t key;
3436 if (!get_icmp_o2i_ed_key (b, ip, &key))
3439 key.fib_index = rx_fib_index;
3440 kv16.key[0] = key.as_u64[0];
3441 kv16.key[1] = key.as_u64[1];
3444 vec_foreach (tsm, sm->per_thread_data)
3446 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&tsm->out2in_ed,
3449 next_worker_index = sm->first_worker_index +
3451 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3452 next_worker_index, rx_fib_index,
3453 clib_net_to_host_u32 (ip->src_address.as_u32),
3454 clib_net_to_host_u32 (ip->dst_address.as_u32));
3455 return next_worker_index;
3462 /* first try static mappings without port */
3463 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3465 make_sm_kv (&kv, &ip->dst_address, 0, 0, 0);
3466 if (!clib_bihash_search_8_8
3467 (&sm->static_mapping_by_external, &kv, &value))
3469 m = pool_elt_at_index (sm->static_mappings, value.value);
3470 next_worker_index = m->workers[0];
3475 /* unknown protocol */
3476 if (PREDICT_FALSE (proto == ~0))
3478 /* use current thread */
3479 next_worker_index = vlib_get_thread_index ();
3483 udp = ip4_next_header (ip);
3484 port = udp->dst_port;
3486 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
3488 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3489 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3490 if (!icmp_type_is_error_message
3491 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3492 port = vnet_buffer (b)->ip.reass.l4_src_port;
3495 /* if error message, then it's not fragmented and we can access it */
3496 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3497 proto = ip_proto_to_snat_proto (inner_ip->protocol);
3498 void *l4_header = ip4_next_header (inner_ip);
3501 case SNAT_PROTOCOL_ICMP:
3502 icmp = (icmp46_header_t *) l4_header;
3503 echo = (icmp_echo_header_t *) (icmp + 1);
3504 port = echo->identifier;
3506 case SNAT_PROTOCOL_UDP:
3507 case SNAT_PROTOCOL_TCP:
3508 port = ((tcp_udp_header_t *) l4_header)->src_port;
3511 next_worker_index = vlib_get_thread_index ();
3517 /* try static mappings with port */
3518 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3520 make_sm_kv (&kv, &ip->dst_address, proto, 0,
3521 clib_net_to_host_u16 (port));
3522 if (!clib_bihash_search_8_8
3523 (&sm->static_mapping_by_external, &kv, &value))
3525 m = pool_elt_at_index (sm->static_mappings, value.value);
3526 if (!is_lb_static_mapping (m))
3528 next_worker_index = m->workers[0];
3532 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3533 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3535 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
3537 m->workers[hash & (_vec_len (m->workers) - 1)];
3539 next_worker_index = m->workers[hash % _vec_len (m->workers)];
3544 /* worker by outside port */
3545 next_worker_index = sm->first_worker_index;
3546 next_worker_index +=
3547 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3550 nat_elog_debug_handoff ("HANDOFF OUT2IN", next_worker_index, rx_fib_index,
3551 clib_net_to_host_u32 (ip->src_address.as_u32),
3552 clib_net_to_host_u32 (ip->dst_address.as_u32));
3553 return next_worker_index;
3557 nat_ha_sadd_cb (ip4_address_t * in_addr, u16 in_port,
3558 ip4_address_t * out_addr, u16 out_port,
3559 ip4_address_t * eh_addr, u16 eh_port,
3560 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3561 u32 fib_index, u16 flags, u32 thread_index)
3563 snat_main_t *sm = &snat_main;
3564 snat_session_key_t key;
3567 clib_bihash_kv_8_8_t kv;
3568 f64 now = vlib_time_now (sm->vlib_main);
3569 nat_outside_fib_t *outside_fib;
3570 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3571 snat_main_per_thread_data_t *tsm;
3572 fib_prefix_t pfx = {
3573 .fp_proto = FIB_PROTOCOL_IP4,
3576 .ip4.as_u32 = eh_addr->as_u32,
3580 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3582 key.addr.as_u32 = out_addr->as_u32;
3583 key.port = out_port;
3584 key.protocol = proto;
3586 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3588 if (nat_set_outside_address_and_port
3589 (sm->addresses, thread_index, &key))
3593 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3597 s = nat_session_alloc_or_recycle (sm, u, thread_index, now);
3601 s->last_heard = now;
3603 s->ext_host_addr.as_u32 = eh_addr->as_u32;
3604 s->ext_host_port = eh_port;
3605 user_session_increment (sm, u, snat_is_session_static (s));
3606 switch (vec_len (sm->outside_fibs))
3609 key.fib_index = sm->outside_fib_index;
3612 key.fib_index = sm->outside_fibs[0].fib_index;
3616 vec_foreach (outside_fib, sm->outside_fibs)
3618 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3619 if (FIB_NODE_INDEX_INVALID != fei)
3621 if (fib_entry_get_resolving_interface (fei) != ~0)
3623 key.fib_index = outside_fib->fib_index;
3632 kv.key = key.as_u64;
3633 kv.value = s - tsm->sessions;
3634 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 1))
3635 nat_elog_warn ("out2in key add failed");
3637 key.addr.as_u32 = in_addr->as_u32;
3639 key.fib_index = fib_index;
3641 kv.key = key.as_u64;
3642 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 1))
3643 nat_elog_warn ("in2out key add failed");
3647 nat_ha_sdel_cb (ip4_address_t * out_addr, u16 out_port,
3648 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3651 snat_main_t *sm = &snat_main;
3652 snat_session_key_t key;
3653 clib_bihash_kv_8_8_t kv, value;
3656 snat_main_per_thread_data_t *tsm;
3658 if (sm->num_workers > 1)
3660 sm->first_worker_index +
3661 (sm->workers[(clib_net_to_host_u16 (out_port) -
3662 1024) / sm->port_per_thread]);
3664 thread_index = sm->num_workers;
3665 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3667 key.addr.as_u32 = out_addr->as_u32;
3668 key.port = out_port;
3669 key.protocol = proto;
3670 key.fib_index = fib_index;
3671 kv.key = key.as_u64;
3672 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3675 s = pool_elt_at_index (tsm->sessions, value.value);
3676 nat_free_session_data (sm, s, thread_index, 1);
3677 nat44_delete_session (sm, s, thread_index);
3681 nat_ha_sref_cb (ip4_address_t * out_addr, u16 out_port,
3682 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3683 u32 total_pkts, u64 total_bytes, u32 thread_index)
3685 snat_main_t *sm = &snat_main;
3686 snat_session_key_t key;
3687 clib_bihash_kv_8_8_t kv, value;
3689 snat_main_per_thread_data_t *tsm;
3691 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3693 key.addr.as_u32 = out_addr->as_u32;
3694 key.port = out_port;
3695 key.protocol = proto;
3696 key.fib_index = fib_index;
3697 kv.key = key.as_u64;
3698 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3701 s = pool_elt_at_index (tsm->sessions, value.value);
3702 s->total_pkts = total_pkts;
3703 s->total_bytes = total_bytes;
3707 nat_ha_sadd_ed_cb (ip4_address_t * in_addr, u16 in_port,
3708 ip4_address_t * out_addr, u16 out_port,
3709 ip4_address_t * eh_addr, u16 eh_port,
3710 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3711 u32 fib_index, u16 flags, u32 thread_index)
3713 snat_main_t *sm = &snat_main;
3714 snat_session_key_t key;
3716 clib_bihash_kv_16_8_t kv;
3717 f64 now = vlib_time_now (sm->vlib_main);
3718 nat_outside_fib_t *outside_fib;
3719 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3720 snat_main_per_thread_data_t *tsm;
3721 fib_prefix_t pfx = {
3722 .fp_proto = FIB_PROTOCOL_IP4,
3725 .ip4.as_u32 = eh_addr->as_u32,
3729 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3731 key.addr.as_u32 = out_addr->as_u32;
3732 key.port = out_port;
3733 key.protocol = proto;
3735 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3737 if (nat_set_outside_address_and_port
3738 (sm->addresses, thread_index, &key))
3742 key.addr.as_u32 = ehn_addr->as_u32;
3743 key.port = ehn_port;
3744 if (flags & SNAT_SESSION_FLAG_TWICE_NAT)
3746 if (nat_set_outside_address_and_port
3747 (sm->twice_nat_addresses, thread_index, &key))
3751 s = nat_ed_session_alloc (sm, thread_index, now);
3755 s->last_heard = now;
3757 s->ext_host_nat_addr.as_u32 = s->ext_host_addr.as_u32 = eh_addr->as_u32;
3758 s->ext_host_nat_port = s->ext_host_port = eh_port;
3759 if (is_twice_nat_session (s))
3761 s->ext_host_nat_addr.as_u32 = ehn_addr->as_u32;
3762 s->ext_host_nat_port = ehn_port;
3764 switch (vec_len (sm->outside_fibs))
3767 key.fib_index = sm->outside_fib_index;
3770 key.fib_index = sm->outside_fibs[0].fib_index;
3774 vec_foreach (outside_fib, sm->outside_fibs)
3776 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3777 if (FIB_NODE_INDEX_INVALID != fei)
3779 if (fib_entry_get_resolving_interface (fei) != ~0)
3781 key.fib_index = outside_fib->fib_index;
3789 key.addr.as_u32 = out_addr->as_u32;
3790 key.port = out_port;
3792 kv.value = s - tsm->sessions;
3794 key.addr.as_u32 = in_addr->as_u32;
3796 key.fib_index = fib_index;
3799 make_ed_kv (&kv, in_addr, &s->ext_host_nat_addr,
3800 snat_proto_to_ip_proto (proto), fib_index, in_port,
3801 s->ext_host_nat_port);
3802 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &kv, 1))
3803 nat_elog_warn ("in2out key add failed");
3805 make_ed_kv (&kv, out_addr, eh_addr, snat_proto_to_ip_proto (proto),
3806 s->out2in.fib_index, out_port, eh_port);
3807 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &kv, 1))
3808 nat_elog_warn ("out2in key add failed");
3812 nat_ha_sdel_ed_cb (ip4_address_t * out_addr, u16 out_port,
3813 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3814 u32 fib_index, u32 ti)
3816 snat_main_t *sm = &snat_main;
3817 nat_ed_ses_key_t key;
3818 clib_bihash_kv_16_8_t kv, value;
3821 snat_main_per_thread_data_t *tsm;
3823 if (sm->num_workers > 1)
3825 sm->first_worker_index +
3826 (sm->workers[(clib_net_to_host_u16 (out_port) -
3827 1024) / sm->port_per_thread]);
3829 thread_index = sm->num_workers;
3830 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3832 key.l_addr.as_u32 = out_addr->as_u32;
3833 key.l_port = out_port;
3834 key.r_addr.as_u32 = eh_addr->as_u32;
3835 key.r_port = eh_port;
3837 key.fib_index = fib_index;
3838 kv.key[0] = key.as_u64[0];
3839 kv.key[1] = key.as_u64[1];
3840 if (clib_bihash_search_16_8 (&tsm->out2in_ed, &kv, &value))
3843 s = pool_elt_at_index (tsm->sessions, value.value);
3844 nat_free_session_data (sm, s, thread_index, 1);
3845 nat44_delete_session (sm, s, thread_index);
3849 nat_ha_sref_ed_cb (ip4_address_t * out_addr, u16 out_port,
3850 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3851 u32 fib_index, u32 total_pkts, u64 total_bytes,
3854 snat_main_t *sm = &snat_main;
3855 nat_ed_ses_key_t key;
3856 clib_bihash_kv_16_8_t kv, value;
3858 snat_main_per_thread_data_t *tsm;
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 s->total_pkts = total_pkts;
3875 s->total_bytes = total_bytes;
3878 static clib_error_t *
3879 snat_config (vlib_main_t * vm, unformat_input_t * input)
3881 snat_main_t *sm = &snat_main;
3882 nat66_main_t *nm = &nat66_main;
3883 //dslite_main_t *dm = &dslite_main;
3884 snat_main_per_thread_data_t *tsm;
3886 u32 static_mapping_buckets = 1024;
3887 uword static_mapping_memory_size = 64 << 20;
3889 u32 nat64_bib_buckets = 1024;
3890 u32 nat64_bib_memory_size = 128 << 20;
3892 u32 nat64_st_buckets = 2048;
3893 uword nat64_st_memory_size = 256 << 20;
3895 u32 user_buckets = 128;
3896 uword user_memory_size = 64 << 20;
3897 u32 translation_buckets = 1024;
3898 uword translation_memory_size = 128 << 20;
3900 u32 max_translations_per_user = ~0;
3902 u32 outside_vrf_id = 0;
3903 u32 outside_ip6_vrf_id = 0;
3904 u32 inside_vrf_id = 0;
3905 u8 static_mapping_only = 0;
3906 u8 static_mapping_connection_tracking = 0;
3908 // configurable timeouts
3909 u32 udp_timeout = SNAT_UDP_TIMEOUT;
3910 u32 icmp_timeout = SNAT_ICMP_TIMEOUT;
3911 u32 tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
3912 u32 tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
3914 sm->deterministic = 0;
3916 sm->endpoint_dependent = 0;
3918 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3921 (input, "translation hash buckets %d", &translation_buckets))
3923 else if (unformat (input, "udp timeout %d", &udp_timeout))
3925 else if (unformat (input, "icmp timeout %d", &icmp_timeout))
3927 else if (unformat (input, "tcp transitory timeout %d",
3928 &tcp_transitory_timeout));
3929 else if (unformat (input, "tcp established timeout %d",
3930 &tcp_established_timeout));
3931 else if (unformat (input, "translation hash memory %d",
3932 &translation_memory_size));
3933 else if (unformat (input, "user hash buckets %d", &user_buckets))
3935 else if (unformat (input, "user hash memory %d", &user_memory_size))
3937 else if (unformat (input, "max translations per user %d",
3938 &max_translations_per_user))
3940 else if (unformat (input, "outside VRF id %d", &outside_vrf_id))
3942 else if (unformat (input, "outside ip6 VRF id %d", &outside_ip6_vrf_id))
3944 else if (unformat (input, "inside VRF id %d", &inside_vrf_id))
3946 else if (unformat (input, "static mapping only"))
3948 static_mapping_only = 1;
3949 if (unformat (input, "connection tracking"))
3950 static_mapping_connection_tracking = 1;
3952 else if (unformat (input, "deterministic"))
3953 sm->deterministic = 1;
3954 else if (unformat (input, "nat64 bib hash buckets %d",
3955 &nat64_bib_buckets))
3957 else if (unformat (input, "nat64 bib hash memory %d",
3958 &nat64_bib_memory_size))
3961 if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
3963 else if (unformat (input, "nat64 st hash memory %d",
3964 &nat64_st_memory_size))
3966 else if (unformat (input, "out2in dpo"))
3968 //else if (unformat (input, "dslite ce"))
3969 //dslite_set_ce (dm, 1);
3970 else if (unformat (input, "endpoint-dependent"))
3971 sm->endpoint_dependent = 1;
3973 return clib_error_return (0, "unknown input '%U'",
3974 format_unformat_error, input);
3977 if (sm->deterministic && sm->endpoint_dependent)
3978 return clib_error_return (0,
3979 "deterministic and endpoint-dependent modes are mutually exclusive");
3981 if (static_mapping_only && (sm->deterministic || sm->endpoint_dependent))
3982 return clib_error_return (0,
3983 "static mapping only mode available only for simple nat");
3985 if (sm->out2in_dpo && (sm->deterministic || sm->endpoint_dependent))
3986 return clib_error_return (0,
3987 "out2in dpo mode available only for simple nat");
3989 /* optionally configurable timeouts for testing purposes */
3990 sm->udp_timeout = udp_timeout;
3991 sm->tcp_transitory_timeout = tcp_transitory_timeout;
3992 sm->tcp_established_timeout = tcp_established_timeout;
3993 sm->icmp_timeout = icmp_timeout;
3995 sm->user_buckets = user_buckets;
3996 sm->user_memory_size = user_memory_size;
3998 sm->translation_buckets = translation_buckets;
3999 sm->translation_memory_size = translation_memory_size;
4001 /* do not exceed load factor 10 */
4002 sm->max_translations = 10 * translation_buckets;
4003 sm->max_translations_per_user = max_translations_per_user == ~0 ?
4004 sm->max_translations : max_translations_per_user;
4006 sm->outside_vrf_id = outside_vrf_id;
4007 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
4010 nm->outside_vrf_id = outside_ip6_vrf_id;
4011 nm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6,
4014 sm->inside_vrf_id = inside_vrf_id;
4015 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
4018 sm->static_mapping_only = static_mapping_only;
4019 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
4021 nat64_set_hash (nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
4022 nat64_st_memory_size);
4024 if (sm->deterministic)
4026 sm->in2out_node_index = snat_det_in2out_node.index;
4027 sm->in2out_output_node_index = ~0;
4028 sm->out2in_node_index = snat_det_out2in_node.index;
4029 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
4030 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
4034 if (sm->endpoint_dependent)
4036 sm->worker_in2out_cb = nat44_ed_get_worker_in2out_cb;
4037 sm->worker_out2in_cb = nat44_ed_get_worker_out2in_cb;
4039 sm->handoff_out2in_index = nat_pre_out2in_node.index;
4040 sm->handoff_in2out_index = nat_pre_in2out_node.index;
4041 sm->handoff_in2out_output_index = nat44_ed_in2out_output_node.index;
4043 sm->in2out_node_index = nat44_ed_in2out_node.index;
4044 sm->in2out_output_node_index = nat44_ed_in2out_output_node.index;
4045 sm->out2in_node_index = nat44_ed_out2in_node.index;
4047 sm->icmp_match_in2out_cb = icmp_match_in2out_ed;
4048 sm->icmp_match_out2in_cb = icmp_match_out2in_ed;
4049 nat_affinity_init (vm);
4050 nat_ha_init (vm, nat_ha_sadd_ed_cb, nat_ha_sdel_ed_cb,
4055 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
4056 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
4058 sm->handoff_out2in_index = snat_out2in_node.index;
4059 sm->handoff_in2out_index = snat_in2out_node.index;
4060 sm->handoff_in2out_output_index = snat_in2out_output_node.index;
4062 sm->in2out_node_index = snat_in2out_node.index;
4063 sm->in2out_output_node_index = snat_in2out_output_node.index;
4064 sm->out2in_node_index = snat_out2in_node.index;
4065 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
4066 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
4067 nat_ha_init (vm, nat_ha_sadd_cb, nat_ha_sdel_cb, nat_ha_sref_cb);
4069 if (!static_mapping_only ||
4070 (static_mapping_only && static_mapping_connection_tracking))
4073 vec_foreach (tsm, sm->per_thread_data)
4075 pool_alloc (tsm->sessions, sm->max_translations);
4076 pool_alloc (tsm->list_pool, sm->max_translations);
4077 pool_alloc (tsm->global_lru_pool, sm->max_translations);
4080 pool_get (tsm->global_lru_pool, head);
4081 tsm->global_lru_head_index = head - tsm->global_lru_pool;
4082 clib_dlist_init (tsm->global_lru_pool,
4083 tsm->global_lru_head_index);
4085 if (sm->endpoint_dependent)
4087 clib_bihash_init_16_8 (&tsm->in2out_ed, "in2out-ed",
4088 translation_buckets,
4089 translation_memory_size);
4090 clib_bihash_set_kvp_format_fn_16_8 (&tsm->in2out_ed,
4091 format_ed_session_kvp);
4093 clib_bihash_init_16_8 (&tsm->out2in_ed, "out2in-ed",
4094 translation_buckets,
4095 translation_memory_size);
4096 clib_bihash_set_kvp_format_fn_16_8 (&tsm->out2in_ed,
4097 format_ed_session_kvp);
4101 clib_bihash_init_8_8 (&tsm->in2out, "in2out",
4102 translation_buckets,
4103 translation_memory_size);
4104 clib_bihash_set_kvp_format_fn_8_8 (&tsm->in2out,
4105 format_session_kvp);
4107 clib_bihash_init_8_8 (&tsm->out2in, "out2in",
4108 translation_buckets,
4109 translation_memory_size);
4110 clib_bihash_set_kvp_format_fn_8_8 (&tsm->out2in,
4111 format_session_kvp);
4114 clib_bihash_init_8_8 (&tsm->user_hash, "users", user_buckets,
4116 clib_bihash_set_kvp_format_fn_8_8 (&tsm->user_hash,
4124 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
4125 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
4127 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
4128 "static_mapping_by_local", static_mapping_buckets,
4129 static_mapping_memory_size);
4130 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_local,
4131 format_static_mapping_kvp);
4133 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
4134 "static_mapping_by_external",
4135 static_mapping_buckets,
4136 static_mapping_memory_size);
4137 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_external,
4138 format_static_mapping_kvp);
4144 VLIB_CONFIG_FUNCTION (snat_config, "nat");
4147 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
4150 ip4_address_t * address,
4152 u32 if_address_index, u32 is_delete)
4154 snat_main_t *sm = &snat_main;
4155 snat_static_map_resolve_t *rp;
4156 snat_static_mapping_t *m;
4157 snat_session_key_t m_key;
4158 clib_bihash_kv_8_8_t kv, value;
4160 ip4_address_t l_addr;
4162 for (i = 0; i < vec_len (sm->to_resolve); i++)
4164 rp = sm->to_resolve + i;
4165 if (rp->addr_only == 0)
4167 if (rp->sw_if_index == sw_if_index)
4174 m_key.addr.as_u32 = address->as_u32;
4175 m_key.port = rp->addr_only ? 0 : rp->e_port;
4176 m_key.protocol = rp->addr_only ? 0 : rp->proto;
4177 m_key.fib_index = sm->outside_fib_index;
4178 kv.key = m_key.as_u64;
4179 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
4182 m = pool_elt_at_index (sm->static_mappings, value.value);
4186 /* Don't trip over lease renewal, static config */
4196 /* Indetity mapping? */
4197 if (rp->l_addr.as_u32 == 0)
4198 l_addr.as_u32 = address[0].as_u32;
4200 l_addr.as_u32 = rp->l_addr.as_u32;
4201 /* Add the static mapping */
4202 rv = snat_add_static_mapping (l_addr,
4207 rp->addr_only, ~0 /* sw_if_index */ ,
4208 rp->proto, !is_delete, rp->twice_nat,
4209 rp->out2in_only, rp->tag, rp->identity_nat);
4211 nat_elog_notice_X1 ("snat_add_static_mapping returned %d", "i4", rv);
4215 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
4218 ip4_address_t * address,
4220 u32 if_address_index, u32 is_delete)
4222 snat_main_t *sm = &snat_main;
4223 snat_static_map_resolve_t *rp;
4224 ip4_address_t l_addr;
4228 snat_address_t *addresses = sm->addresses;
4230 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices); i++)
4232 if (sw_if_index == sm->auto_add_sw_if_indices[i])
4236 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices_twice_nat); i++)
4239 addresses = sm->twice_nat_addresses;
4240 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
4249 /* Don't trip over lease renewal, static config */
4250 for (j = 0; j < vec_len (addresses); j++)
4251 if (addresses[j].addr.as_u32 == address->as_u32)
4254 (void) snat_add_address (sm, address, ~0, twice_nat);
4255 /* Scan static map resolution vector */
4256 for (j = 0; j < vec_len (sm->to_resolve); j++)
4258 rp = sm->to_resolve + j;
4261 /* On this interface? */
4262 if (rp->sw_if_index == sw_if_index)
4264 /* Indetity mapping? */
4265 if (rp->l_addr.as_u32 == 0)
4266 l_addr.as_u32 = address[0].as_u32;
4268 l_addr.as_u32 = rp->l_addr.as_u32;
4269 /* Add the static mapping */
4270 rv = snat_add_static_mapping (l_addr,
4276 ~0 /* sw_if_index */ ,
4278 rp->is_add, rp->twice_nat,
4279 rp->out2in_only, rp->tag,
4282 nat_elog_notice_X1 ("snat_add_static_mapping returned %d",
4290 (void) snat_del_address (sm, address[0], 1, twice_nat);
4297 snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
4300 ip4_main_t *ip4_main = sm->ip4_main;
4301 ip4_address_t *first_int_addr;
4302 snat_static_map_resolve_t *rp;
4303 u32 *indices_to_delete = 0;
4305 u32 *auto_add_sw_if_indices =
4307 auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
4309 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0 /* just want the address */
4312 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
4314 if (auto_add_sw_if_indices[i] == sw_if_index)
4318 /* if have address remove it */
4320 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
4323 for (j = 0; j < vec_len (sm->to_resolve); j++)
4325 rp = sm->to_resolve + j;
4326 if (rp->sw_if_index == sw_if_index)
4327 vec_add1 (indices_to_delete, j);
4329 if (vec_len (indices_to_delete))
4331 for (j = vec_len (indices_to_delete) - 1; j >= 0; j--)
4332 vec_del1 (sm->to_resolve, j);
4333 vec_free (indices_to_delete);
4337 vec_del1 (sm->auto_add_sw_if_indices_twice_nat, i);
4339 vec_del1 (sm->auto_add_sw_if_indices, i);
4342 return VNET_API_ERROR_VALUE_EXIST;
4349 return VNET_API_ERROR_NO_SUCH_ENTRY;
4351 /* add to the auto-address list */
4353 vec_add1 (sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
4355 vec_add1 (sm->auto_add_sw_if_indices, sw_if_index);
4357 /* If the address is already bound - or static - add it now */
4359 (void) snat_add_address (sm, first_int_addr, ~0, twice_nat);
4365 nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4366 snat_protocol_t proto, u32 vrf_id, int is_in)
4368 snat_main_per_thread_data_t *tsm;
4369 clib_bihash_kv_8_8_t kv, value;
4371 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4372 snat_session_key_t key;
4374 clib_bihash_8_8_t *t;
4376 if (sm->endpoint_dependent)
4377 return VNET_API_ERROR_UNSUPPORTED;
4379 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4380 if (sm->num_workers > 1)
4382 vec_elt_at_index (sm->per_thread_data,
4383 sm->worker_in2out_cb (&ip, fib_index, 0));
4385 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4387 key.addr.as_u32 = addr->as_u32;
4388 key.port = clib_host_to_net_u16 (port);
4389 key.protocol = proto;
4390 key.fib_index = fib_index;
4391 kv.key = key.as_u64;
4392 t = is_in ? &tsm->in2out : &tsm->out2in;
4393 if (!clib_bihash_search_8_8 (t, &kv, &value))
4395 if (pool_is_free_index (tsm->sessions, value.value))
4396 return VNET_API_ERROR_UNSPECIFIED;
4398 s = pool_elt_at_index (tsm->sessions, value.value);
4399 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4400 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4404 return VNET_API_ERROR_NO_SUCH_ENTRY;
4408 nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4409 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
4410 u32 vrf_id, int is_in)
4413 clib_bihash_16_8_t *t;
4414 nat_ed_ses_key_t key;
4415 clib_bihash_kv_16_8_t kv, value;
4416 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4418 snat_main_per_thread_data_t *tsm;
4420 if (!sm->endpoint_dependent)
4421 return VNET_API_ERROR_FEATURE_DISABLED;
4423 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4424 if (sm->num_workers > 1)
4426 vec_elt_at_index (sm->per_thread_data,
4427 sm->worker_in2out_cb (&ip, fib_index, 0));
4429 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4431 t = is_in ? &tsm->in2out_ed : &tsm->out2in_ed;
4432 key.l_addr.as_u32 = addr->as_u32;
4433 key.r_addr.as_u32 = eh_addr->as_u32;
4434 key.l_port = clib_host_to_net_u16 (port);
4435 key.r_port = clib_host_to_net_u16 (eh_port);
4437 key.fib_index = fib_index;
4438 kv.key[0] = key.as_u64[0];
4439 kv.key[1] = key.as_u64[1];
4440 if (clib_bihash_search_16_8 (t, &kv, &value))
4441 return VNET_API_ERROR_NO_SUCH_ENTRY;
4443 if (pool_is_free_index (tsm->sessions, value.value))
4444 return VNET_API_ERROR_UNSPECIFIED;
4445 s = pool_elt_at_index (tsm->sessions, value.value);
4446 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4447 nat44_ed_delete_session (sm, s, tsm - sm->per_thread_data, 1);
4452 nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset, u16 psid_length)
4454 snat_main_t *sm = &snat_main;
4456 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_MAPE;
4457 sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
4459 sm->psid_offset = psid_offset;
4460 sm->psid_length = psid_length;
4464 nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port)
4466 snat_main_t *sm = &snat_main;
4468 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_RANGE;
4469 sm->alloc_addr_and_port = nat_alloc_addr_and_port_range;
4470 sm->start_port = start_port;
4471 sm->end_port = end_port;
4475 nat_set_alloc_addr_and_port_default (void)
4477 snat_main_t *sm = &snat_main;
4479 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
4480 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
4483 VLIB_NODE_FN (nat_default_node) (vlib_main_t * vm,
4484 vlib_node_runtime_t * node,
4485 vlib_frame_t * frame)
4491 VLIB_REGISTER_NODE (nat_default_node) = {
4492 .name = "nat-default",
4493 .vector_size = sizeof (u32),
4495 .type = VLIB_NODE_TYPE_INTERNAL,
4497 .n_next_nodes = NAT_N_NEXT,
4499 [NAT_NEXT_DROP] = "error-drop",
4500 [NAT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
4501 [NAT_NEXT_IN2OUT_PRE] = "nat-pre-in2out",
4502 [NAT_NEXT_OUT2IN_PRE] = "nat-pre-out2in",
4503 [NAT_NEXT_IN2OUT_ED_FAST_PATH] = "nat44-ed-in2out",
4504 [NAT_NEXT_IN2OUT_ED_SLOW_PATH] = "nat44-ed-in2out-slowpath",
4505 [NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH] = "nat44-ed-in2out-output-slowpath",
4506 [NAT_NEXT_OUT2IN_ED_FAST_PATH] = "nat44-ed-out2in",
4507 [NAT_NEXT_OUT2IN_ED_SLOW_PATH] = "nat44-ed-out2in-slowpath",
4513 * fd.io coding-style-patch-verification: ON
4516 * eval: (c-set-style "gnu")