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/nat64.h>
26 #include <nat/nat_inlines.h>
27 #include <nat/nat44/inlines.h>
28 #include <nat/nat_affinity.h>
29 #include <nat/nat_syslog.h>
30 #include <nat/nat_ha.h>
31 #include <vnet/fib/fib_table.h>
32 #include <vnet/fib/ip4_fib.h>
33 #include <vnet/ip/reass/ip4_sv_reass.h>
34 #include <vppinfra/bihash_16_8.h>
35 #include <nat/nat44/ed_inlines.h>
37 #include <vpp/app/version.h>
39 snat_main_t snat_main;
41 fib_source_t nat_fib_src_hi;
42 fib_source_t nat_fib_src_low;
45 /* Hook up input features */
46 VNET_FEATURE_INIT (nat_pre_in2out, static) = {
47 .arc_name = "ip4-unicast",
48 .node_name = "nat-pre-in2out",
49 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
50 "ip4-sv-reassembly-feature"),
52 VNET_FEATURE_INIT (nat_pre_out2in, static) = {
53 .arc_name = "ip4-unicast",
54 .node_name = "nat-pre-out2in",
55 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
56 "ip4-dhcp-client-detect",
57 "ip4-sv-reassembly-feature"),
59 VNET_FEATURE_INIT (snat_in2out_worker_handoff, static) = {
60 .arc_name = "ip4-unicast",
61 .node_name = "nat44-in2out-worker-handoff",
62 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
64 VNET_FEATURE_INIT (snat_out2in_worker_handoff, static) = {
65 .arc_name = "ip4-unicast",
66 .node_name = "nat44-out2in-worker-handoff",
67 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
68 "ip4-dhcp-client-detect"),
70 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
71 .arc_name = "ip4-unicast",
72 .node_name = "nat44-in2out",
73 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
75 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
76 .arc_name = "ip4-unicast",
77 .node_name = "nat44-out2in",
78 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
79 "ip4-dhcp-client-detect"),
81 VNET_FEATURE_INIT (ip4_nat_classify, static) = {
82 .arc_name = "ip4-unicast",
83 .node_name = "nat44-classify",
84 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
86 VNET_FEATURE_INIT (ip4_nat44_ed_in2out, static) = {
87 .arc_name = "ip4-unicast",
88 .node_name = "nat44-ed-in2out",
89 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
91 VNET_FEATURE_INIT (ip4_nat44_ed_out2in, static) = {
92 .arc_name = "ip4-unicast",
93 .node_name = "nat44-ed-out2in",
94 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
95 "ip4-dhcp-client-detect"),
97 VNET_FEATURE_INIT (ip4_nat44_ed_classify, static) = {
98 .arc_name = "ip4-unicast",
99 .node_name = "nat44-ed-classify",
100 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
102 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
103 .arc_name = "ip4-unicast",
104 .node_name = "nat44-handoff-classify",
105 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
107 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
108 .arc_name = "ip4-unicast",
109 .node_name = "nat44-in2out-fast",
110 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
112 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
113 .arc_name = "ip4-unicast",
114 .node_name = "nat44-out2in-fast",
115 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
116 "ip4-dhcp-client-detect"),
118 VNET_FEATURE_INIT (ip4_snat_hairpin_dst, static) = {
119 .arc_name = "ip4-unicast",
120 .node_name = "nat44-hairpin-dst",
121 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
123 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_dst, static) = {
124 .arc_name = "ip4-unicast",
125 .node_name = "nat44-ed-hairpin-dst",
126 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
129 /* Hook up output features */
130 VNET_FEATURE_INIT (ip4_snat_in2out_output, static) = {
131 .arc_name = "ip4-output",
132 .node_name = "nat44-in2out-output",
133 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
135 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
136 .arc_name = "ip4-output",
137 .node_name = "nat44-in2out-output-worker-handoff",
138 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
140 VNET_FEATURE_INIT (ip4_snat_hairpin_src, static) = {
141 .arc_name = "ip4-output",
142 .node_name = "nat44-hairpin-src",
143 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
145 VNET_FEATURE_INIT (ip4_nat44_ed_in2out_output, static) = {
146 .arc_name = "ip4-output",
147 .node_name = "nat44-ed-in2out-output",
148 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
149 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
151 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_src, static) = {
152 .arc_name = "ip4-output",
153 .node_name = "nat44-ed-hairpin-src",
154 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
155 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
158 /* Hook up ip4-local features */
159 VNET_FEATURE_INIT (ip4_nat_hairpinning, static) =
161 .arc_name = "ip4-local",
162 .node_name = "nat44-hairpinning",
163 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
165 VNET_FEATURE_INIT (ip4_nat44_ed_hairpinning, static) =
167 .arc_name = "ip4-local",
168 .node_name = "nat44-ed-hairpinning",
169 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
173 VLIB_PLUGIN_REGISTER () = {
174 .version = VPP_BUILD_VER,
175 .description = "Network Address Translation (NAT)",
180 nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index,
183 clib_bihash_kv_8_8_t kv;
186 ip4_address_t *l_addr, *r_addr;
188 clib_bihash_kv_16_8_t ed_kv;
189 snat_main_per_thread_data_t *tsm =
190 vec_elt_at_index (sm->per_thread_data, thread_index);
192 if (is_ed_session (s))
194 per_vrf_sessions_unregister_session (s, thread_index);
197 if (is_fwd_bypass_session (s))
199 if (snat_is_unk_proto_session (s))
201 init_ed_k (&ed_kv, s->in2out.addr, 0, s->ext_host_addr, 0, 0,
206 l_port = s->in2out.port;
207 r_port = s->ext_host_port;
208 l_addr = &s->in2out.addr;
209 r_addr = &s->ext_host_addr;
210 proto = nat_proto_to_ip_proto (s->nat_proto);
211 init_ed_k (&ed_kv, *l_addr, l_port, *r_addr, r_port, fib_index,
214 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
215 nat_elog_warn ("in2out_ed key del failed");
219 /* session lookup tables */
220 if (is_ed_session (s))
222 if (is_affinity_sessions (s))
223 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
224 s->nat_proto, s->out2in.port);
225 l_addr = &s->out2in.addr;
226 r_addr = &s->ext_host_addr;
227 fib_index = s->out2in.fib_index;
228 if (snat_is_unk_proto_session (s))
230 proto = s->in2out.port;
236 proto = nat_proto_to_ip_proto (s->nat_proto);
237 l_port = s->out2in.port;
238 r_port = s->ext_host_port;
240 init_ed_k (&ed_kv, *l_addr, l_port, *r_addr, r_port, fib_index, proto);
241 if (clib_bihash_add_del_16_8 (&sm->out2in_ed, &ed_kv, 0))
242 nat_elog_warn ("out2in_ed key del failed");
243 l_addr = &s->in2out.addr;
244 fib_index = s->in2out.fib_index;
245 if (!snat_is_unk_proto_session (s))
246 l_port = s->in2out.port;
247 if (is_twice_nat_session (s))
249 r_addr = &s->ext_host_nat_addr;
250 r_port = s->ext_host_nat_port;
252 init_ed_k (&ed_kv, *l_addr, l_port, *r_addr, r_port, fib_index, proto);
253 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
254 nat_elog_warn ("in2out_ed key del failed");
257 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
258 &s->in2out.addr, s->in2out.port,
259 &s->ext_host_nat_addr, s->ext_host_nat_port,
260 &s->out2in.addr, s->out2in.port,
261 &s->ext_host_addr, s->ext_host_port,
262 s->nat_proto, is_twice_nat_session (s));
266 init_nat_i2o_k (&kv, s);
267 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0))
268 nat_elog_warn ("in2out key del failed");
269 init_nat_o2i_k (&kv, s);
270 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0))
271 nat_elog_warn ("out2in key del failed");
274 nat_syslog_nat44_apmdel (s->user_index, s->in2out.fib_index,
275 &s->in2out.addr, s->in2out.port,
276 &s->out2in.addr, s->out2in.port,
280 if (snat_is_unk_proto_session (s))
286 snat_ipfix_logging_nat44_ses_delete (thread_index,
287 s->in2out.addr.as_u32,
288 s->out2in.addr.as_u32,
292 s->in2out.fib_index);
294 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
295 s->ext_host_port, s->nat_proto, s->out2in.fib_index,
299 /* Twice NAT address and port for external host */
300 if (is_twice_nat_session (s))
302 snat_free_outside_address_and_port (sm->twice_nat_addresses,
304 &s->ext_host_nat_addr,
305 s->ext_host_nat_port, s->nat_proto);
308 if (snat_is_session_static (s))
311 snat_free_outside_address_and_port (sm->addresses, thread_index,
312 &s->out2in.addr, s->out2in.port,
317 nat44_free_session_data (snat_main_t * sm, snat_session_t * s,
318 u32 thread_index, u8 is_ha)
322 ip4_address_t *l_addr, *r_addr;
324 clib_bihash_kv_16_8_t ed_kv;
325 snat_main_per_thread_data_t *tsm =
326 vec_elt_at_index (sm->per_thread_data, thread_index);
328 if (is_fwd_bypass_session (s))
330 if (snat_is_unk_proto_session (s))
332 proto = s->in2out.port;
338 proto = nat_proto_to_ip_proto (s->nat_proto);
339 l_port = s->in2out.port;
340 r_port = s->ext_host_port;
343 l_addr = &s->in2out.addr;
344 r_addr = &s->ext_host_addr;
346 init_ed_k (&ed_kv, *l_addr, l_port, *r_addr, r_port, fib_index, proto);
349 (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0)))
350 nat_elog_warn ("in2out_ed key del failed");
354 /* session lookup tables */
355 if (is_affinity_sessions (s))
356 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
357 s->nat_proto, s->out2in.port);
358 l_addr = &s->out2in.addr;
359 r_addr = &s->ext_host_addr;
360 fib_index = s->out2in.fib_index;
361 if (snat_is_unk_proto_session (s))
363 proto = s->in2out.port;
369 proto = nat_proto_to_ip_proto (s->nat_proto);
370 l_port = s->out2in.port;
371 r_port = s->ext_host_port;
373 init_ed_k (&ed_kv, *l_addr, l_port, *r_addr, r_port, fib_index, proto);
375 if (PREDICT_FALSE (clib_bihash_add_del_16_8 (&sm->out2in_ed, &ed_kv, 0)))
376 nat_elog_warn ("out2in_ed key del failed");
378 l_addr = &s->in2out.addr;
379 fib_index = s->in2out.fib_index;
381 if (!snat_is_unk_proto_session (s))
382 l_port = s->in2out.port;
384 if (is_twice_nat_session (s))
386 r_addr = &s->ext_host_nat_addr;
387 r_port = s->ext_host_nat_port;
389 init_ed_k (&ed_kv, *l_addr, l_port, *r_addr, r_port, fib_index, proto);
391 if (PREDICT_FALSE (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0)))
392 nat_elog_warn ("in2out_ed key del failed");
396 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
397 &s->in2out.addr, s->in2out.port,
398 &s->ext_host_nat_addr, s->ext_host_nat_port,
399 &s->out2in.addr, s->out2in.port,
400 &s->ext_host_addr, s->ext_host_port,
401 s->nat_proto, is_twice_nat_session (s));
404 if (snat_is_unk_proto_session (s))
409 snat_ipfix_logging_nat44_ses_delete (thread_index,
410 s->in2out.addr.as_u32,
411 s->out2in.addr.as_u32,
415 s->in2out.fib_index);
416 nat_ha_sdel (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
417 s->ext_host_port, s->nat_proto, s->out2in.fib_index,
421 /* Twice NAT address and port for external host */
422 if (is_twice_nat_session (s))
424 snat_free_outside_address_and_port (sm->twice_nat_addresses,
426 &s->ext_host_nat_addr,
427 s->ext_host_nat_port, s->nat_proto);
430 if (snat_is_session_static (s))
433 snat_free_outside_address_and_port (sm->addresses, thread_index,
434 &s->out2in.addr, s->out2in.port,
440 nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr, u32 fib_index,
444 snat_user_key_t user_key;
445 clib_bihash_kv_8_8_t kv, value;
446 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
447 dlist_elt_t *per_user_list_head_elt;
449 user_key.addr.as_u32 = addr->as_u32;
450 user_key.fib_index = fib_index;
451 kv.key = user_key.as_u64;
453 /* Ever heard of the "user" = src ip4 address before? */
454 if (clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
456 if (pool_elts (tsm->users) >= sm->max_users_per_thread)
458 vlib_increment_simple_counter (&sm->user_limit_reached,
460 nat_elog_warn ("maximum user limit reached");
463 /* no, make a new one */
464 pool_get (tsm->users, u);
465 clib_memset (u, 0, sizeof (*u));
467 u->addr.as_u32 = addr->as_u32;
468 u->fib_index = fib_index;
470 pool_get (tsm->list_pool, per_user_list_head_elt);
472 u->sessions_per_user_list_head_index = per_user_list_head_elt -
475 clib_dlist_init (tsm->list_pool, u->sessions_per_user_list_head_index);
477 kv.value = u - tsm->users;
480 if (clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 1))
482 nat_elog_warn ("user_hash key add failed");
483 nat44_delete_user_with_no_session (sm, u, thread_index);
487 vlib_set_simple_counter (&sm->total_users, thread_index, 0,
488 pool_elts (tsm->users));
492 u = pool_elt_at_index (tsm->users, value.value);
499 nat_session_alloc_or_recycle (snat_main_t * sm, snat_user_t * u,
500 u32 thread_index, f64 now)
503 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
504 u32 oldest_per_user_translation_list_index, session_index;
505 dlist_elt_t *oldest_per_user_translation_list_elt;
506 dlist_elt_t *per_user_translation_list_elt;
508 /* Over quota? Recycle the least recently used translation */
509 if ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user)
511 oldest_per_user_translation_list_index =
512 clib_dlist_remove_head (tsm->list_pool,
513 u->sessions_per_user_list_head_index);
515 ASSERT (oldest_per_user_translation_list_index != ~0);
517 /* Add it back to the end of the LRU list */
518 clib_dlist_addtail (tsm->list_pool,
519 u->sessions_per_user_list_head_index,
520 oldest_per_user_translation_list_index);
521 /* Get the list element */
522 oldest_per_user_translation_list_elt =
523 pool_elt_at_index (tsm->list_pool,
524 oldest_per_user_translation_list_index);
526 /* Get the session index from the list element */
527 session_index = oldest_per_user_translation_list_elt->value;
529 /* Get the session */
530 s = pool_elt_at_index (tsm->sessions, session_index);
531 nat_free_session_data (sm, s, thread_index, 0);
532 if (snat_is_session_static (s))
533 u->nstaticsessions--;
540 s->ext_host_addr.as_u32 = 0;
541 s->ext_host_port = 0;
542 s->ext_host_nat_addr.as_u32 = 0;
543 s->ext_host_nat_port = 0;
547 pool_get (tsm->sessions, s);
548 clib_memset (s, 0, sizeof (*s));
550 /* Create list elts */
551 pool_get (tsm->list_pool, per_user_translation_list_elt);
552 clib_dlist_init (tsm->list_pool,
553 per_user_translation_list_elt - tsm->list_pool);
555 per_user_translation_list_elt->value = s - tsm->sessions;
556 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
557 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
559 clib_dlist_addtail (tsm->list_pool,
560 s->per_user_list_head_index,
561 per_user_translation_list_elt - tsm->list_pool);
563 s->user_index = u - tsm->users;
564 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
565 pool_elts (tsm->sessions));
568 s->ha_last_refreshed = now;
574 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
577 fib_prefix_t prefix = {
579 .fp_proto = FIB_PROTOCOL_IP4,
581 .ip4.as_u32 = addr->as_u32,
584 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
587 fib_table_entry_update_one_path (fib_index,
590 (FIB_ENTRY_FLAG_CONNECTED |
591 FIB_ENTRY_FLAG_LOCAL |
592 FIB_ENTRY_FLAG_EXCLUSIVE),
596 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
598 fib_table_entry_delete (fib_index, &prefix, nat_fib_src_low);
602 snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
607 vlib_thread_main_t *tm = vlib_get_thread_main ();
609 if (twice_nat && !sm->endpoint_dependent)
610 return VNET_API_ERROR_FEATURE_DISABLED;
612 /* Check if address already exists */
614 vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
616 if (ap->addr.as_u32 == addr->as_u32)
617 return VNET_API_ERROR_VALUE_EXIST;
622 vec_add2 (sm->twice_nat_addresses, ap, 1);
624 vec_add2 (sm->addresses, ap, 1);
629 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
633 #define _(N, i, n, s) \
634 clib_memset(ap->busy_##n##_port_refcounts, 0, sizeof(ap->busy_##n##_port_refcounts));\
635 ap->busy_##n##_ports = 0; \
636 ap->busy_##n##_ports_per_thread = 0;\
637 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
643 /* Add external address to FIB */
645 pool_foreach (i, sm->interfaces,
647 if (nat_interface_is_inside(i) || sm->out2in_dpo)
650 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
653 pool_foreach (i, sm->output_feature_interfaces,
655 if (nat_interface_is_inside(i) || sm->out2in_dpo)
658 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
667 is_snat_address_used_in_static_mapping (snat_main_t * sm, ip4_address_t addr)
669 snat_static_mapping_t *m;
671 pool_foreach (m, sm->static_mappings,
673 if (is_addr_only_static_mapping (m) ||
674 is_out2in_only_static_mapping (m) ||
675 is_identity_static_mapping (m))
677 if (m->external_addr.as_u32 == addr.as_u32)
686 snat_add_static_mapping_when_resolved (snat_main_t * sm,
687 ip4_address_t l_addr,
692 nat_protocol_t proto,
693 int addr_only, int is_add, u8 * tag,
694 int twice_nat, int out2in_only,
697 snat_static_map_resolve_t *rp;
699 vec_add2 (sm->to_resolve, rp, 1);
700 rp->l_addr.as_u32 = l_addr.as_u32;
702 rp->sw_if_index = sw_if_index;
706 rp->addr_only = addr_only;
708 rp->twice_nat = twice_nat;
709 rp->out2in_only = out2in_only;
710 rp->identity_nat = identity_nat;
711 rp->tag = vec_dup (tag);
715 get_thread_idx_by_port (u16 e_port)
717 snat_main_t *sm = &snat_main;
718 u32 thread_idx = sm->num_workers;
719 if (sm->num_workers > 1)
722 sm->first_worker_index +
723 sm->workers[(e_port - 1024) / sm->port_per_thread];
729 snat_static_mapping_del_sessions (snat_main_t * sm,
730 snat_main_per_thread_data_t * tsm,
731 snat_user_key_t u_key, int addr_only,
732 ip4_address_t e_addr, u16 e_port)
734 clib_bihash_kv_8_8_t kv, value;
735 kv.key = u_key.as_u64;
737 dlist_elt_t *head, *elt;
740 u32 elt_index, head_index, ses_index;
741 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
743 user_index = value.value;
744 u = pool_elt_at_index (tsm->users, user_index);
745 if (u->nstaticsessions)
747 head_index = u->sessions_per_user_list_head_index;
748 head = pool_elt_at_index (tsm->list_pool, head_index);
749 elt_index = head->next;
750 elt = pool_elt_at_index (tsm->list_pool, elt_index);
751 ses_index = elt->value;
752 while (ses_index != ~0)
754 s = pool_elt_at_index (tsm->sessions, ses_index);
755 elt = pool_elt_at_index (tsm->list_pool, elt->next);
756 ses_index = elt->value;
760 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
761 (s->out2in.port != e_port))
765 if (is_lb_session (s))
768 if (!snat_is_session_static (s))
771 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
772 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
782 snat_ed_static_mapping_del_sessions (snat_main_t * sm,
783 snat_main_per_thread_data_t * tsm,
784 ip4_address_t l_addr,
787 u32 fib_index, int addr_only,
788 ip4_address_t e_addr, u16 e_port)
791 u32 *indexes_to_free = NULL;
793 pool_foreach (s, tsm->sessions, {
794 if (s->in2out.fib_index != fib_index ||
795 s->in2out.addr.as_u32 != l_addr.as_u32)
801 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
802 s->out2in.port != e_port ||
803 s->in2out.port != l_port ||
804 s->nat_proto != protocol)
808 if (is_lb_session (s))
810 if (!snat_is_session_static (s))
812 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
813 vec_add1 (indexes_to_free, s - tsm->sessions);
819 vec_foreach (ses_index, indexes_to_free)
821 s = pool_elt_at_index (tsm->sessions, *ses_index);
822 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
824 vec_free (indexes_to_free);
828 snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
829 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
830 u32 sw_if_index, nat_protocol_t proto, int is_add,
831 twice_nat_type_t twice_nat, u8 out2in_only, u8 * tag,
834 snat_main_t *sm = &snat_main;
835 snat_static_mapping_t *m;
836 clib_bihash_kv_8_8_t kv, value;
837 snat_address_t *a = 0;
839 snat_interface_t *interface;
841 snat_main_per_thread_data_t *tsm;
842 snat_user_key_t u_key;
844 dlist_elt_t *head, *elt;
845 u32 elt_index, head_index;
849 snat_static_map_resolve_t *rp, *rp_match = 0;
850 nat44_lb_addr_port_t *local;
853 if (!sm->endpoint_dependent)
855 if (twice_nat || out2in_only)
856 return VNET_API_ERROR_FEATURE_DISABLED;
859 /* If the external address is a specific interface address */
860 if (sw_if_index != ~0)
862 ip4_address_t *first_int_addr;
864 for (i = 0; i < vec_len (sm->to_resolve); i++)
866 rp = sm->to_resolve + i;
867 if (rp->sw_if_index != sw_if_index ||
868 rp->l_addr.as_u32 != l_addr.as_u32 ||
869 rp->vrf_id != vrf_id || rp->addr_only != addr_only)
874 if ((rp->l_port != l_port && rp->e_port != e_port)
875 || rp->proto != proto)
883 /* Might be already set... */
884 first_int_addr = ip4_interface_first_address
885 (sm->ip4_main, sw_if_index, 0 /* just want the address */ );
890 return VNET_API_ERROR_VALUE_EXIST;
892 snat_add_static_mapping_when_resolved
893 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
894 addr_only, is_add, tag, twice_nat, out2in_only, identity_nat);
896 /* DHCP resolution required? */
897 if (first_int_addr == 0)
903 e_addr.as_u32 = first_int_addr->as_u32;
904 /* Identity mapping? */
905 if (l_addr.as_u32 == 0)
906 l_addr.as_u32 = e_addr.as_u32;
912 return VNET_API_ERROR_NO_SUCH_ENTRY;
914 vec_del1 (sm->to_resolve, i);
918 e_addr.as_u32 = first_int_addr->as_u32;
919 /* Identity mapping? */
920 if (l_addr.as_u32 == 0)
921 l_addr.as_u32 = e_addr.as_u32;
928 init_nat_k (&kv, e_addr, addr_only ? 0 : e_port, 0, addr_only ? 0 : proto);
929 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
932 m = pool_elt_at_index (sm->static_mappings, value.value);
938 if (is_identity_static_mapping (m))
941 pool_foreach (local, m->locals,
943 if (local->vrf_id == vrf_id)
944 return VNET_API_ERROR_VALUE_EXIST;
947 pool_get (m->locals, local);
948 local->vrf_id = vrf_id;
950 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
952 init_nat_kv (&kv, m->local_addr, m->local_port,
953 local->fib_index, m->proto,
954 m - sm->static_mappings);
955 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
959 return VNET_API_ERROR_VALUE_EXIST;
962 if (twice_nat && addr_only)
963 return VNET_API_ERROR_UNSUPPORTED;
965 /* Convert VRF id to FIB index */
968 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
970 /* If not specified use inside VRF id from SNAT plugin startup config */
973 fib_index = sm->inside_fib_index;
974 vrf_id = sm->inside_vrf_id;
975 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
978 if (!(out2in_only || identity_nat))
980 init_nat_k (&kv, l_addr, addr_only ? 0 : l_port, fib_index,
981 addr_only ? 0 : proto);
982 if (!clib_bihash_search_8_8
983 (&sm->static_mapping_by_local, &kv, &value))
984 return VNET_API_ERROR_VALUE_EXIST;
987 /* Find external address in allocated addresses and reserve port for
988 address and port pair mapping when dynamic translations enabled */
989 if (!(addr_only || sm->static_mapping_only || out2in_only))
991 for (i = 0; i < vec_len (sm->addresses); i++)
993 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
995 a = sm->addresses + i;
996 /* External port must be unused */
999 #define _(N, j, n, s) \
1000 case NAT_PROTOCOL_##N: \
1001 if (a->busy_##n##_port_refcounts[e_port]) \
1002 return VNET_API_ERROR_INVALID_VALUE; \
1003 ++a->busy_##n##_port_refcounts[e_port]; \
1004 if (e_port > 1024) \
1006 a->busy_##n##_ports++; \
1007 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1010 foreach_nat_protocol
1013 nat_elog_info ("unknown protocol");
1014 return VNET_API_ERROR_INVALID_VALUE_2;
1019 /* External address must be allocated */
1020 if (!a && (l_addr.as_u32 != e_addr.as_u32))
1022 if (sw_if_index != ~0)
1024 for (i = 0; i < vec_len (sm->to_resolve); i++)
1026 rp = sm->to_resolve + i;
1029 if (rp->sw_if_index != sw_if_index &&
1030 rp->l_addr.as_u32 != l_addr.as_u32 &&
1031 rp->vrf_id != vrf_id && rp->l_port != l_port &&
1032 rp->e_port != e_port && rp->proto != proto)
1035 vec_del1 (sm->to_resolve, i);
1039 return VNET_API_ERROR_NO_SUCH_ENTRY;
1043 pool_get (sm->static_mappings, m);
1044 clib_memset (m, 0, sizeof (*m));
1045 m->tag = vec_dup (tag);
1046 m->local_addr = l_addr;
1047 m->external_addr = e_addr;
1048 m->twice_nat = twice_nat;
1050 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1052 m->flags |= NAT_STATIC_MAPPING_FLAG_ADDR_ONLY;
1055 m->flags |= NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT;
1056 pool_get (m->locals, local);
1057 local->vrf_id = vrf_id;
1058 local->fib_index = fib_index;
1063 m->fib_index = fib_index;
1067 m->local_port = l_port;
1068 m->external_port = e_port;
1072 if (sm->num_workers > 1)
1075 .src_address = m->local_addr,
1077 vec_add1 (m->workers, sm->worker_in2out_cb (&ip, m->fib_index, 0));
1078 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1081 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1083 init_nat_kv (&kv, m->local_addr, m->local_port, fib_index, m->proto,
1084 m - sm->static_mappings);
1086 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1088 init_nat_kv (&kv, m->external_addr, m->external_port, 0, m->proto,
1089 m - sm->static_mappings);
1090 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1);
1092 /* Delete dynamic sessions matching local address (+ local port) */
1093 if (!(sm->static_mapping_only))
1095 u_key.addr = m->local_addr;
1096 u_key.fib_index = m->fib_index;
1097 kv.key = u_key.as_u64;
1098 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1100 user_index = value.value;
1101 u = pool_elt_at_index (tsm->users, user_index);
1104 head_index = u->sessions_per_user_list_head_index;
1105 head = pool_elt_at_index (tsm->list_pool, head_index);
1106 elt_index = head->next;
1107 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1108 ses_index = elt->value;
1109 while (ses_index != ~0)
1111 s = pool_elt_at_index (tsm->sessions, ses_index);
1112 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1113 ses_index = elt->value;
1115 if (snat_is_session_static (s))
1118 if (!addr_only && s->in2out.port != m->local_port)
1121 nat_free_session_data (sm, s,
1122 tsm - sm->per_thread_data, 0);
1123 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1125 if (!addr_only && !sm->endpoint_dependent)
1136 if (sw_if_index != ~0)
1139 return VNET_API_ERROR_NO_SUCH_ENTRY;
1145 vrf_id = sm->inside_vrf_id;
1148 pool_foreach (local, m->locals,
1150 if (local->vrf_id == vrf_id)
1151 find = local - m->locals;
1155 return VNET_API_ERROR_NO_SUCH_ENTRY;
1157 local = pool_elt_at_index (m->locals, find);
1158 fib_index = local->fib_index;
1159 pool_put (m->locals, local);
1162 fib_index = m->fib_index;
1164 /* Free external address port */
1165 if (!(addr_only || sm->static_mapping_only || out2in_only))
1167 for (i = 0; i < vec_len (sm->addresses); i++)
1169 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1171 a = sm->addresses + i;
1174 #define _(N, j, n, s) \
1175 case NAT_PROTOCOL_##N: \
1176 --a->busy_##n##_port_refcounts[e_port]; \
1177 if (e_port > 1024) \
1179 a->busy_##n##_ports--; \
1180 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1183 foreach_nat_protocol
1186 nat_elog_info ("unknown protocol");
1187 return VNET_API_ERROR_INVALID_VALUE_2;
1194 if (sm->num_workers > 1)
1195 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1197 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1199 init_nat_k (&kv, m->local_addr, m->local_port, fib_index, m->proto);
1201 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0);
1203 /* Delete session(s) for static mapping if exist */
1204 if (!(sm->static_mapping_only) ||
1205 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
1207 if (sm->endpoint_dependent)
1209 snat_ed_static_mapping_del_sessions (sm, tsm, m->local_addr,
1210 m->local_port, m->proto,
1211 fib_index, addr_only,
1216 u_key.addr = m->local_addr;
1217 u_key.fib_index = fib_index;
1218 kv.key = u_key.as_u64;
1219 snat_static_mapping_del_sessions (sm, tsm, u_key, addr_only,
1224 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1225 if (pool_elts (m->locals))
1228 init_nat_k (&kv, m->external_addr, m->external_port, 0, m->proto);
1229 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0);
1232 vec_free (m->workers);
1233 /* Delete static mapping from pool */
1234 pool_put (sm->static_mappings, m);
1237 if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
1240 /* Add/delete external address to FIB */
1242 pool_foreach (interface, sm->interfaces,
1244 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1247 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1250 pool_foreach (interface, sm->output_feature_interfaces,
1252 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1255 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1264 nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1265 nat_protocol_t proto,
1266 nat44_lb_addr_port_t * locals, u8 is_add,
1267 twice_nat_type_t twice_nat, u8 out2in_only,
1268 u8 * tag, u32 affinity)
1270 snat_main_t *sm = &snat_main;
1271 snat_static_mapping_t *m;
1272 clib_bihash_kv_8_8_t kv, value;
1273 snat_address_t *a = 0;
1275 nat44_lb_addr_port_t *local;
1276 snat_main_per_thread_data_t *tsm;
1280 if (!sm->endpoint_dependent)
1281 return VNET_API_ERROR_FEATURE_DISABLED;
1283 init_nat_k (&kv, e_addr, e_port, 0, proto);
1284 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1287 m = pool_elt_at_index (sm->static_mappings, value.value);
1292 return VNET_API_ERROR_VALUE_EXIST;
1294 if (vec_len (locals) < 2)
1295 return VNET_API_ERROR_INVALID_VALUE;
1297 /* Find external address in allocated addresses and reserve port for
1298 address and port pair mapping when dynamic translations enabled */
1299 if (!(sm->static_mapping_only || out2in_only))
1301 for (i = 0; i < vec_len (sm->addresses); i++)
1303 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1305 a = sm->addresses + i;
1306 /* External port must be unused */
1309 #define _(N, j, n, s) \
1310 case NAT_PROTOCOL_##N: \
1311 if (a->busy_##n##_port_refcounts[e_port]) \
1312 return VNET_API_ERROR_INVALID_VALUE; \
1313 ++a->busy_##n##_port_refcounts[e_port]; \
1314 if (e_port > 1024) \
1316 a->busy_##n##_ports++; \
1317 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1320 foreach_nat_protocol
1323 nat_elog_info ("unknown protocol");
1324 return VNET_API_ERROR_INVALID_VALUE_2;
1329 /* External address must be allocated */
1331 return VNET_API_ERROR_NO_SUCH_ENTRY;
1334 pool_get (sm->static_mappings, m);
1335 clib_memset (m, 0, sizeof (*m));
1336 m->tag = vec_dup (tag);
1337 m->external_addr = e_addr;
1338 m->external_port = e_port;
1340 m->twice_nat = twice_nat;
1341 m->flags |= NAT_STATIC_MAPPING_FLAG_LB;
1343 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1344 m->affinity = affinity;
1347 m->affinity_per_service_list_head_index =
1348 nat_affinity_get_per_service_list_head_index ();
1350 m->affinity_per_service_list_head_index = ~0;
1352 init_nat_kv (&kv, m->external_addr, m->external_port, 0, m->proto,
1353 m - sm->static_mappings);
1354 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1))
1356 nat_elog_err ("static_mapping_by_external key add failed");
1357 return VNET_API_ERROR_UNSPECIFIED;
1360 for (i = 0; i < vec_len (locals); i++)
1362 locals[i].fib_index =
1363 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
1368 init_nat_kv (&kv, locals[i].addr, locals[i].port,
1369 locals[i].fib_index, m->proto,
1370 m - sm->static_mappings);
1371 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1373 locals[i].prefix = (i == 0) ? locals[i].probability :
1374 (locals[i - 1].prefix + locals[i].probability);
1375 pool_get (m->locals, local);
1377 if (sm->num_workers > 1)
1380 .src_address = locals[i].addr,
1383 clib_bitmap_set (bitmap,
1384 sm->worker_in2out_cb (&ip, m->fib_index, 0),
1389 /* Assign workers */
1390 if (sm->num_workers > 1)
1393 clib_bitmap_foreach (i, bitmap,
1395 vec_add1(m->workers, i);
1403 return VNET_API_ERROR_NO_SUCH_ENTRY;
1405 if (!is_lb_static_mapping (m))
1406 return VNET_API_ERROR_INVALID_VALUE;
1408 /* Free external address port */
1409 if (!(sm->static_mapping_only || out2in_only))
1411 for (i = 0; i < vec_len (sm->addresses); i++)
1413 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1415 a = sm->addresses + i;
1418 #define _(N, j, n, s) \
1419 case NAT_PROTOCOL_##N: \
1420 --a->busy_##n##_port_refcounts[e_port]; \
1421 if (e_port > 1024) \
1423 a->busy_##n##_ports--; \
1424 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1427 foreach_nat_protocol
1430 nat_elog_info ("unknown protocol");
1431 return VNET_API_ERROR_INVALID_VALUE_2;
1438 init_nat_k (&kv, m->external_addr, m->external_port, 0, m->proto);
1439 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0))
1441 nat_elog_err ("static_mapping_by_external key del failed");
1442 return VNET_API_ERROR_UNSPECIFIED;
1446 pool_foreach (local, m->locals,
1448 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4,
1452 init_nat_k(& kv, local->addr, local->port, local->fib_index, m->proto);
1453 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1455 nat_elog_err ("static_mapping_by_local key del failed");
1456 return VNET_API_ERROR_UNSPECIFIED;
1460 if (sm->num_workers > 1)
1463 .src_address = local->addr,
1465 tsm = vec_elt_at_index (sm->per_thread_data,
1466 sm->worker_in2out_cb (&ip, m->fib_index, 0));
1469 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1471 /* Delete sessions */
1472 pool_foreach (s, tsm->sessions, {
1473 if (!(is_lb_session (s)))
1476 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1477 s->in2out.port != local->port)
1480 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1481 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
1486 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1487 pool_free (m->locals);
1489 vec_free (m->workers);
1491 pool_put (sm->static_mappings, m);
1498 nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1499 ip4_address_t l_addr, u16 l_port,
1500 nat_protocol_t proto, u32 vrf_id,
1501 u8 probability, u8 is_add)
1503 snat_main_t *sm = &snat_main;
1504 snat_static_mapping_t *m = 0;
1505 clib_bihash_kv_8_8_t kv, value;
1506 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1507 snat_main_per_thread_data_t *tsm;
1513 if (!sm->endpoint_dependent)
1514 return VNET_API_ERROR_FEATURE_DISABLED;
1516 init_nat_k (&kv, e_addr, e_port, 0, proto);
1517 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1518 m = pool_elt_at_index (sm->static_mappings, value.value);
1521 return VNET_API_ERROR_NO_SUCH_ENTRY;
1523 if (!is_lb_static_mapping (m))
1524 return VNET_API_ERROR_INVALID_VALUE;
1527 pool_foreach (local, m->locals,
1529 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1530 (local->vrf_id == vrf_id))
1532 match_local = local;
1541 return VNET_API_ERROR_VALUE_EXIST;
1543 pool_get (m->locals, local);
1544 clib_memset (local, 0, sizeof (*local));
1545 local->addr.as_u32 = l_addr.as_u32;
1546 local->port = l_port;
1547 local->probability = probability;
1548 local->vrf_id = vrf_id;
1550 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1553 if (!is_out2in_only_static_mapping (m))
1555 init_nat_kv (&kv, l_addr, l_port, local->fib_index, proto,
1556 m - sm->static_mappings);
1557 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1))
1558 nat_elog_err ("static_mapping_by_local key add failed");
1564 return VNET_API_ERROR_NO_SUCH_ENTRY;
1566 if (pool_elts (m->locals) < 3)
1567 return VNET_API_ERROR_UNSPECIFIED;
1569 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1572 if (!is_out2in_only_static_mapping (m))
1574 init_nat_k (&kv, l_addr, l_port, match_local->fib_index, proto);
1575 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0))
1576 nat_elog_err ("static_mapping_by_local key del failed");
1579 if (sm->num_workers > 1)
1582 .src_address = local->addr,
1584 tsm = vec_elt_at_index (sm->per_thread_data,
1585 sm->worker_in2out_cb (&ip, m->fib_index,
1589 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1591 /* Delete sessions */
1593 pool_foreach (s, tsm->sessions, {
1594 if (!(is_lb_session (s)))
1597 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1598 s->in2out.port != match_local->port)
1601 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1602 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
1606 pool_put (m->locals, match_local);
1609 vec_free (m->workers);
1612 pool_foreach (local, m->locals,
1614 vec_add1 (locals, local - m->locals);
1615 if (sm->num_workers > 1)
1618 ip.src_address.as_u32 = local->addr.as_u32,
1619 bitmap = clib_bitmap_set (bitmap,
1620 sm->worker_in2out_cb (&ip, local->fib_index, 0),
1626 ASSERT (vec_len (locals) > 1);
1628 local = pool_elt_at_index (m->locals, locals[0]);
1629 local->prefix = local->probability;
1630 for (i = 1; i < vec_len (locals); i++)
1632 local = pool_elt_at_index (m->locals, locals[i]);
1633 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1634 local->prefix = local->probability + prev_local->prefix;
1637 /* Assign workers */
1638 if (sm->num_workers > 1)
1641 clib_bitmap_foreach (i, bitmap, ({ vec_add1(m->workers, i); }));
1649 snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1652 snat_address_t *a = 0;
1653 snat_session_t *ses;
1654 u32 *ses_to_be_removed = 0, *ses_index;
1655 snat_main_per_thread_data_t *tsm;
1656 snat_static_mapping_t *m;
1657 snat_interface_t *interface;
1659 snat_address_t *addresses =
1660 twice_nat ? sm->twice_nat_addresses : sm->addresses;
1662 /* Find SNAT address */
1663 for (i = 0; i < vec_len (addresses); i++)
1665 if (addresses[i].addr.as_u32 == addr.as_u32)
1672 return VNET_API_ERROR_NO_SUCH_ENTRY;
1677 pool_foreach (m, sm->static_mappings,
1679 if (m->external_addr.as_u32 == addr.as_u32)
1680 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1681 m->local_port, m->external_port,
1682 m->vrf_id, is_addr_only_static_mapping(m), ~0,
1683 m->proto, 0, m->twice_nat,
1684 is_out2in_only_static_mapping(m), m->tag, is_identity_static_mapping(m));
1690 /* Check if address is used in some static mapping */
1691 if (is_snat_address_used_in_static_mapping (sm, addr))
1693 nat_elog_notice ("address used in static mapping");
1694 return VNET_API_ERROR_UNSPECIFIED;
1698 if (a->fib_index != ~0)
1699 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, nat_fib_src_low);
1701 /* Delete sessions using address */
1702 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1705 vec_foreach (tsm, sm->per_thread_data)
1707 pool_foreach (ses, tsm->sessions, ({
1708 if (ses->out2in.addr.as_u32 == addr.as_u32)
1710 nat_free_session_data (sm, ses, tsm - sm->per_thread_data, 0);
1711 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1715 if (sm->endpoint_dependent){
1716 vec_foreach (ses_index, ses_to_be_removed)
1718 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1719 nat_ed_session_delete (sm, ses, tsm - sm->per_thread_data, 1);
1722 vec_foreach (ses_index, ses_to_be_removed)
1724 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1725 nat44_delete_session (sm, ses, tsm - sm->per_thread_data);
1729 vec_free (ses_to_be_removed);
1734 #define _(N, i, n, s) \
1735 vec_free (a->busy_##n##_ports_per_thread);
1736 foreach_nat_protocol
1740 vec_del1 (sm->twice_nat_addresses, i);
1744 vec_del1 (sm->addresses, i);
1746 /* Delete external address from FIB */
1748 pool_foreach (interface, sm->interfaces,
1750 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1753 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1756 pool_foreach (interface, sm->output_feature_interfaces,
1758 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1761 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1770 nat_validate_counters (snat_main_t * sm, u32 sw_if_index)
1773 vlib_validate_simple_counter (&sm->counters.fastpath.in2out.x, \
1775 vlib_zero_simple_counter (&sm->counters.fastpath.in2out.x, sw_if_index); \
1776 vlib_validate_simple_counter (&sm->counters.fastpath.out2in.x, \
1778 vlib_zero_simple_counter (&sm->counters.fastpath.out2in.x, sw_if_index); \
1779 vlib_validate_simple_counter (&sm->counters.slowpath.in2out.x, \
1781 vlib_zero_simple_counter (&sm->counters.slowpath.in2out.x, sw_if_index); \
1782 vlib_validate_simple_counter (&sm->counters.slowpath.out2in.x, \
1784 vlib_zero_simple_counter (&sm->counters.slowpath.out2in.x, sw_if_index); \
1785 vlib_validate_simple_counter (&sm->counters.fastpath.in2out_ed.x, \
1787 vlib_zero_simple_counter (&sm->counters.fastpath.in2out_ed.x, sw_if_index); \
1788 vlib_validate_simple_counter (&sm->counters.fastpath.out2in_ed.x, \
1790 vlib_zero_simple_counter (&sm->counters.fastpath.out2in_ed.x, sw_if_index); \
1791 vlib_validate_simple_counter (&sm->counters.slowpath.in2out_ed.x, \
1793 vlib_zero_simple_counter (&sm->counters.slowpath.in2out_ed.x, sw_if_index); \
1794 vlib_validate_simple_counter (&sm->counters.slowpath.out2in_ed.x, \
1796 vlib_zero_simple_counter (&sm->counters.slowpath.out2in_ed.x, sw_if_index);
1797 foreach_nat_counter;
1799 vlib_validate_simple_counter (&sm->counters.hairpinning, sw_if_index);
1800 vlib_zero_simple_counter (&sm->counters.hairpinning, sw_if_index);
1804 expire_per_vrf_sessions (u32 fib_index)
1806 per_vrf_sessions_t *per_vrf_sessions;
1807 snat_main_per_thread_data_t *tsm;
1808 snat_main_t *sm = &snat_main;
1811 vec_foreach (tsm, sm->per_thread_data)
1813 vec_foreach (per_vrf_sessions, tsm->per_vrf_sessions_vec)
1815 if ((per_vrf_sessions->rx_fib_index == fib_index) ||
1816 (per_vrf_sessions->tx_fib_index == fib_index))
1818 per_vrf_sessions->expired = 1;
1826 update_per_vrf_sessions_vec (u32 fib_index, int is_del)
1828 snat_main_t *sm = &snat_main;
1831 // we don't care if it is outside/inside fib
1832 // we just care about their ref_count
1833 // if it reaches 0 sessions should expire
1834 // because the fib isn't valid for NAT anymore
1836 vec_foreach (fib, sm->fibs)
1838 if (fib->fib_index == fib_index)
1843 if (!fib->ref_count)
1845 vec_del1 (sm->fibs, fib - sm->fibs);
1846 expire_per_vrf_sessions (fib_index);
1856 vec_add2 (sm->fibs, fib, 1);
1858 fib->fib_index = fib_index;
1863 snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1865 snat_main_t *sm = &snat_main;
1866 snat_interface_t *i;
1867 const char *feature_name, *del_feature_name;
1869 snat_static_mapping_t *m;
1870 nat_outside_fib_t *outside_fib;
1871 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1874 if (sm->out2in_dpo && !is_inside)
1875 return VNET_API_ERROR_UNSUPPORTED;
1878 pool_foreach (i, sm->output_feature_interfaces,
1880 if (i->sw_if_index == sw_if_index)
1881 return VNET_API_ERROR_VALUE_EXIST;
1885 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1886 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1889 if (sm->num_workers > 1)
1891 is_inside ? "nat44-in2out-worker-handoff" :
1892 "nat44-out2in-worker-handoff";
1893 else if (sm->endpoint_dependent)
1895 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1898 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1901 if (sm->fq_in2out_index == ~0 && sm->num_workers > 1)
1902 sm->fq_in2out_index =
1903 vlib_frame_queue_main_init (sm->in2out_node_index, NAT_FQ_NELTS);
1905 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
1906 sm->fq_out2in_index =
1907 vlib_frame_queue_main_init (sm->out2in_node_index, NAT_FQ_NELTS);
1909 if (sm->endpoint_dependent)
1910 update_per_vrf_sessions_vec (fib_index, is_del);
1915 vec_foreach (outside_fib, sm->outside_fibs)
1917 if (outside_fib->fib_index == fib_index)
1921 outside_fib->refcount--;
1922 if (!outside_fib->refcount)
1923 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1926 outside_fib->refcount++;
1933 vec_add2 (sm->outside_fibs, outside_fib, 1);
1934 outside_fib->refcount = 1;
1935 outside_fib->fib_index = fib_index;
1941 pool_foreach (i, sm->interfaces,
1943 if (i->sw_if_index == sw_if_index)
1947 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1950 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1952 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1954 if (sm->num_workers > 1)
1956 del_feature_name = "nat44-handoff-classify";
1957 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1958 "nat44-out2in-worker-handoff";
1960 else if (sm->endpoint_dependent)
1962 del_feature_name = "nat44-ed-classify";
1963 feature_name = !is_inside ? "nat-pre-in2out" :
1968 del_feature_name = "nat44-classify";
1969 feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1972 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1975 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1976 sw_if_index, 0, 0, 0);
1977 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1978 sw_if_index, 1, 0, 0);
1981 if (sm->endpoint_dependent)
1982 vnet_feature_enable_disable ("ip4-local",
1983 "nat44-ed-hairpinning",
1984 sw_if_index, 1, 0, 0);
1986 vnet_feature_enable_disable ("ip4-local",
1987 "nat44-hairpinning",
1988 sw_if_index, 1, 0, 0);
1993 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1996 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1997 sw_if_index, 0, 0, 0);
1998 pool_put (sm->interfaces, i);
2001 if (sm->endpoint_dependent)
2002 vnet_feature_enable_disable ("ip4-local",
2003 "nat44-ed-hairpinning",
2004 sw_if_index, 0, 0, 0);
2006 vnet_feature_enable_disable ("ip4-local",
2007 "nat44-hairpinning",
2008 sw_if_index, 0, 0, 0);
2014 if ((nat_interface_is_inside(i) && is_inside) ||
2015 (nat_interface_is_outside(i) && !is_inside))
2018 if (sm->num_workers > 1)
2020 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
2021 "nat44-out2in-worker-handoff";
2022 feature_name = "nat44-handoff-classify";
2024 else if (sm->endpoint_dependent)
2026 del_feature_name = !is_inside ? "nat-pre-in2out" :
2029 feature_name = "nat44-ed-classify";
2033 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
2034 feature_name = "nat44-classify";
2037 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
2040 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
2041 sw_if_index, 0, 0, 0);
2042 vnet_feature_enable_disable ("ip4-unicast", feature_name,
2043 sw_if_index, 1, 0, 0);
2046 if (sm->endpoint_dependent)
2047 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
2048 sw_if_index, 0, 0, 0);
2050 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
2051 sw_if_index, 0, 0, 0);
2062 return VNET_API_ERROR_NO_SUCH_ENTRY;
2064 pool_get (sm->interfaces, i);
2065 i->sw_if_index = sw_if_index;
2067 nat_validate_counters (sm, sw_if_index);
2069 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0,
2072 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
2076 if (is_inside && !sm->out2in_dpo)
2078 if (sm->endpoint_dependent)
2079 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
2080 sw_if_index, 1, 0, 0);
2082 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
2083 sw_if_index, 1, 0, 0);
2089 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2093 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2095 /* Add/delete external addresses to FIB */
2098 vec_foreach (ap, sm->addresses)
2099 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2101 pool_foreach (m, sm->static_mappings,
2103 if (!(is_addr_only_static_mapping(m)) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2106 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2114 snat_interface_add_del_output_feature (u32 sw_if_index,
2115 u8 is_inside, int is_del)
2117 snat_main_t *sm = &snat_main;
2118 snat_interface_t *i;
2120 snat_static_mapping_t *m;
2121 nat_outside_fib_t *outside_fib;
2122 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
2125 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
2126 return VNET_API_ERROR_UNSUPPORTED;
2129 pool_foreach (i, sm->interfaces,
2131 if (i->sw_if_index == sw_if_index)
2132 return VNET_API_ERROR_VALUE_EXIST;
2136 if (sm->endpoint_dependent)
2137 update_per_vrf_sessions_vec (fib_index, is_del);
2142 vec_foreach (outside_fib, sm->outside_fibs)
2144 if (outside_fib->fib_index == fib_index)
2148 outside_fib->refcount--;
2149 if (!outside_fib->refcount)
2150 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2153 outside_fib->refcount++;
2160 vec_add2 (sm->outside_fibs, outside_fib, 1);
2161 outside_fib->refcount = 1;
2162 outside_fib->fib_index = fib_index;
2169 if (sm->endpoint_dependent)
2172 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2176 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2180 vnet_feature_enable_disable ("ip4-unicast", "nat44-ed-hairpin-dst",
2181 sw_if_index, !is_del, 0, 0);
2182 vnet_feature_enable_disable ("ip4-output", "nat44-ed-hairpin-src",
2183 sw_if_index, !is_del, 0, 0);
2188 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2192 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2196 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
2197 sw_if_index, !is_del, 0, 0);
2198 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
2199 sw_if_index, !is_del, 0, 0);
2204 if (sm->num_workers > 1)
2206 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2210 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, !is_del);
2213 vnet_feature_enable_disable ("ip4-unicast",
2214 "nat44-out2in-worker-handoff",
2215 sw_if_index, !is_del, 0, 0);
2216 vnet_feature_enable_disable ("ip4-output",
2217 "nat44-in2out-output-worker-handoff",
2218 sw_if_index, !is_del, 0, 0);
2222 if (sm->endpoint_dependent)
2225 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2229 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2233 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
2234 sw_if_index, !is_del, 0, 0);
2235 vnet_feature_enable_disable ("ip4-output", "nat44-ed-in2out-output",
2236 sw_if_index, !is_del, 0, 0);
2241 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
2245 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
2249 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in",
2250 sw_if_index, !is_del, 0, 0);
2251 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
2252 sw_if_index, !is_del, 0, 0);
2257 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
2258 sm->fq_in2out_output_index =
2259 vlib_frame_queue_main_init (sm->in2out_output_node_index, 0);
2261 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
2262 sm->fq_out2in_index =
2263 vlib_frame_queue_main_init (sm->out2in_node_index, 0);
2266 pool_foreach (i, sm->output_feature_interfaces,
2268 if (i->sw_if_index == sw_if_index)
2271 pool_put (sm->output_feature_interfaces, i);
2273 return VNET_API_ERROR_VALUE_EXIST;
2281 return VNET_API_ERROR_NO_SUCH_ENTRY;
2283 pool_get (sm->output_feature_interfaces, i);
2284 i->sw_if_index = sw_if_index;
2286 nat_validate_counters (sm, sw_if_index);
2288 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2290 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2292 /* Add/delete external addresses to FIB */
2298 vec_foreach (ap, sm->addresses)
2299 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2301 pool_foreach (m, sm->static_mappings,
2303 if (!((is_addr_only_static_mapping(m))) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2306 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2314 snat_set_workers (uword * bitmap)
2316 snat_main_t *sm = &snat_main;
2319 if (sm->num_workers < 2)
2320 return VNET_API_ERROR_FEATURE_DISABLED;
2322 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2323 return VNET_API_ERROR_INVALID_WORKER;
2325 vec_free (sm->workers);
2327 clib_bitmap_foreach (i, bitmap,
2329 vec_add1(sm->workers, i);
2330 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2331 sm->per_thread_data[sm->first_worker_index + i].thread_index = i;
2336 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
2342 snat_update_outside_fib (u32 sw_if_index, u32 new_fib_index,
2345 snat_main_t *sm = &snat_main;
2346 nat_outside_fib_t *outside_fib;
2347 snat_interface_t *i;
2351 if (new_fib_index == old_fib_index)
2354 if (!vec_len (sm->outside_fibs))
2358 pool_foreach (i, sm->interfaces,
2360 if (i->sw_if_index == sw_if_index)
2362 if (!(nat_interface_is_outside (i)))
2368 pool_foreach (i, sm->output_feature_interfaces,
2370 if (i->sw_if_index == sw_if_index)
2372 if (!(nat_interface_is_outside (i)))
2382 vec_foreach (outside_fib, sm->outside_fibs)
2384 if (outside_fib->fib_index == old_fib_index)
2386 outside_fib->refcount--;
2387 if (!outside_fib->refcount)
2388 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2393 vec_foreach (outside_fib, sm->outside_fibs)
2395 if (outside_fib->fib_index == new_fib_index)
2397 outside_fib->refcount++;
2405 vec_add2 (sm->outside_fibs, outside_fib, 1);
2406 outside_fib->refcount = 1;
2407 outside_fib->fib_index = new_fib_index;
2412 snat_ip4_table_bind (ip4_main_t * im,
2414 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
2416 snat_update_outside_fib (sw_if_index, new_fib_index, old_fib_index);
2420 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2423 ip4_address_t * address,
2425 u32 if_address_index, u32 is_delete);
2428 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
2431 ip4_address_t * address,
2433 u32 if_address_index, u32 is_delete);
2436 nat_alloc_addr_and_port_default (snat_address_t * addresses, u32 fib_index,
2437 u32 thread_index, nat_protocol_t proto,
2438 ip4_address_t * addr, u16 * port,
2439 u16 port_per_thread, u32 snat_thread_index);
2442 test_key_calc_split ()
2444 ip4_address_t l_addr;
2445 l_addr.as_u8[0] = 1;
2446 l_addr.as_u8[1] = 1;
2447 l_addr.as_u8[2] = 1;
2448 l_addr.as_u8[3] = 1;
2449 ip4_address_t r_addr;
2450 r_addr.as_u8[0] = 2;
2451 r_addr.as_u8[1] = 2;
2452 r_addr.as_u8[2] = 2;
2453 r_addr.as_u8[3] = 2;
2457 u32 fib_index = 9000001;
2458 u32 thread_index = 3000000001;
2459 u32 session_index = 3000000221;
2460 clib_bihash_kv_16_8_t kv;
2461 init_ed_kv (&kv, l_addr, l_port, r_addr, r_port, fib_index, proto,
2462 thread_index, session_index);
2463 ip4_address_t l_addr2;
2464 ip4_address_t r_addr2;
2465 clib_memset (&l_addr2, 0, sizeof (l_addr2));
2466 clib_memset (&r_addr2, 0, sizeof (r_addr2));
2471 split_ed_kv (&kv, &l_addr2, &r_addr2, &proto2, &fib_index2, &l_port2,
2473 ASSERT (l_addr.as_u32 == l_addr2.as_u32);
2474 ASSERT (r_addr.as_u32 == r_addr2.as_u32);
2475 ASSERT (l_port == l_port2);
2476 ASSERT (r_port == r_port2);
2477 ASSERT (proto == proto2);
2478 ASSERT (fib_index == fib_index2);
2479 ASSERT (thread_index == ed_value_get_thread_index (&kv));
2480 ASSERT (session_index == ed_value_get_session_index (&kv));
2484 nat_protocol_t proto3 = ~0;
2485 u64 key = calc_nat_key (l_addr, l_port, fib_index, proto);
2486 split_nat_key (key, &l_addr2, &l_port2, &fib_index2, &proto3);
2487 ASSERT (l_addr.as_u32 == l_addr2.as_u32);
2488 ASSERT (l_port == l_port2);
2489 ASSERT (proto == proto3);
2490 ASSERT (fib_index == fib_index2);
2493 static clib_error_t *
2494 nat_ip_table_add_del (vnet_main_t * vnm, u32 table_id, u32 is_add)
2496 snat_main_t *sm = &snat_main;
2499 if (sm->endpoint_dependent)
2501 // TODO: consider removing all NAT interfaces
2505 fib_index = ip4_fib_index_from_table_id (table_id);
2506 if (fib_index != ~0)
2507 expire_per_vrf_sessions (fib_index);
2513 VNET_IP_TABLE_ADD_DEL_FUNCTION (nat_ip_table_add_del);
2516 static clib_error_t *
2517 snat_init (vlib_main_t * vm)
2519 snat_main_t *sm = &snat_main;
2520 clib_error_t *error = 0;
2521 ip4_main_t *im = &ip4_main;
2522 ip_lookup_main_t *lm = &im->lookup_main;
2524 vlib_thread_registration_t *tr;
2525 vlib_thread_main_t *tm = vlib_get_thread_main ();
2528 ip4_add_del_interface_address_callback_t cb4;
2531 sm->vnet_main = vnet_get_main ();
2533 sm->ip4_lookup_main = lm;
2534 sm->api_main = vlibapi_get_main ();
2535 sm->first_worker_index = 0;
2536 sm->num_workers = 0;
2538 sm->port_per_thread = 0xffff - 1024;
2539 sm->fq_in2out_index = ~0;
2540 sm->fq_in2out_output_index = ~0;
2541 sm->fq_out2in_index = ~0;
2543 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
2544 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
2545 sm->forwarding_enabled = 0;
2546 sm->log_class = vlib_log_register_class ("nat", 0);
2547 sm->log_level = SNAT_LOG_ERROR;
2548 sm->mss_clamping = 0;
2550 node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
2551 sm->error_node_index = node->index;
2553 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2554 sm->pre_in2out_node_index = node->index;
2555 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2556 sm->pre_out2in_node_index = node->index;
2558 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-in2out");
2559 sm->pre_in2out_node_index = node->index;
2561 node = vlib_get_node_by_name (vm, (u8 *) "nat-pre-out2in");
2562 sm->pre_out2in_node_index = node->index;
2564 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out");
2565 sm->in2out_node_index = node->index;
2566 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output");
2567 sm->in2out_output_node_index = node->index;
2568 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-fast");
2569 sm->in2out_fast_node_index = node->index;
2570 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-slowpath");
2571 sm->in2out_slowpath_node_index = node->index;
2572 node = vlib_get_node_by_name (vm, (u8 *) "nat44-in2out-output-slowpath");
2573 sm->in2out_slowpath_output_node_index = node->index;
2575 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out");
2576 sm->ed_in2out_node_index = node->index;
2577 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-slowpath");
2578 sm->ed_in2out_slowpath_node_index = node->index;
2580 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in");
2581 sm->out2in_node_index = node->index;
2582 node = vlib_get_node_by_name (vm, (u8 *) "nat44-out2in-fast");
2583 sm->out2in_fast_node_index = node->index;
2585 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in");
2586 sm->ed_out2in_node_index = node->index;
2587 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in-slowpath");
2588 sm->ed_out2in_slowpath_node_index = node->index;
2590 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpinning");
2591 sm->hairpinning_node_index = node->index;
2592 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-dst");
2593 sm->hairpin_dst_node_index = node->index;
2594 node = vlib_get_node_by_name (vm, (u8 *) "nat44-hairpin-src");
2595 sm->hairpin_src_node_index = node->index;
2596 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpinning");
2597 sm->ed_hairpinning_node_index = node->index;
2598 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-dst");
2599 sm->ed_hairpin_dst_node_index = node->index;
2600 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-hairpin-src");
2601 sm->ed_hairpin_src_node_index = node->index;
2603 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2606 tr = (vlib_thread_registration_t *) p[0];
2609 sm->num_workers = tr->count;
2610 sm->first_worker_index = tr->first_index;
2614 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2616 /* Use all available workers by default */
2617 if (sm->num_workers > 1)
2619 for (i = 0; i < sm->num_workers; i++)
2620 bitmap = clib_bitmap_set (bitmap, i, 1);
2621 snat_set_workers (bitmap);
2622 clib_bitmap_free (bitmap);
2626 sm->per_thread_data[0].snat_thread_index = 0;
2629 error = snat_api_init (vm, sm);
2633 /* Set up the interface address add/del callback */
2634 cb4.function = snat_ip4_add_del_interface_address_cb;
2635 cb4.function_opaque = 0;
2637 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2639 cb4.function = nat_ip4_add_del_addr_only_sm_cb;
2640 cb4.function_opaque = 0;
2642 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2644 nat_dpo_module_init ();
2647 sm->total_users.name = "total-users";
2648 sm->total_users.stat_segment_name = "/nat44/total-users";
2649 vlib_validate_simple_counter (&sm->total_users, 0);
2650 vlib_zero_simple_counter (&sm->total_users, 0);
2651 sm->total_sessions.name = "total-sessions";
2652 sm->total_sessions.stat_segment_name = "/nat44/total-sessions";
2653 vlib_validate_simple_counter (&sm->total_sessions, 0);
2654 vlib_zero_simple_counter (&sm->total_sessions, 0);
2655 sm->user_limit_reached.name = "user-limit-reached";
2656 sm->user_limit_reached.stat_segment_name = "/nat44/user-limit-reached";
2657 vlib_validate_simple_counter (&sm->user_limit_reached, 0);
2658 vlib_zero_simple_counter (&sm->user_limit_reached, 0);
2661 sm->counters.fastpath.in2out.x.name = #x; \
2662 sm->counters.fastpath.in2out.x.stat_segment_name = \
2663 "/nat44/in2out/fastpath/" #x; \
2664 sm->counters.slowpath.in2out.x.name = #x; \
2665 sm->counters.slowpath.in2out.x.stat_segment_name = \
2666 "/nat44/in2out/slowpath/" #x; \
2667 sm->counters.fastpath.out2in.x.name = #x; \
2668 sm->counters.fastpath.out2in.x.stat_segment_name = \
2669 "/nat44/out2in/fastpath/" #x; \
2670 sm->counters.slowpath.out2in.x.name = #x; \
2671 sm->counters.slowpath.out2in.x.stat_segment_name = \
2672 "/nat44/out2in/slowpath/" #x; \
2673 sm->counters.fastpath.in2out_ed.x.name = #x; \
2674 sm->counters.fastpath.in2out_ed.x.stat_segment_name = \
2675 "/nat44/ed/in2out/fastpath/" #x; \
2676 sm->counters.slowpath.in2out_ed.x.name = #x; \
2677 sm->counters.slowpath.in2out_ed.x.stat_segment_name = \
2678 "/nat44/ed/in2out/slowpath/" #x; \
2679 sm->counters.fastpath.out2in_ed.x.name = #x; \
2680 sm->counters.fastpath.out2in_ed.x.stat_segment_name = \
2681 "/nat44/ed/out2in/fastpath/" #x; \
2682 sm->counters.slowpath.out2in_ed.x.name = #x; \
2683 sm->counters.slowpath.out2in_ed.x.stat_segment_name = \
2684 "/nat44/ed/out2in/slowpath/" #x;
2685 foreach_nat_counter;
2687 sm->counters.hairpinning.name = "hairpinning";
2688 sm->counters.hairpinning.stat_segment_name = "/nat44/hairpinning";
2690 /* Init IPFIX logging */
2691 snat_ipfix_logging_init (vm);
2694 error = nat64_init (vm);
2698 ip4_table_bind_callback_t cbt4 = {
2699 .function = snat_ip4_table_bind,
2701 vec_add1 (ip4_main.table_bind_callbacks, cbt4);
2703 nat_fib_src_hi = fib_source_allocate ("nat-hi",
2704 FIB_SOURCE_PRIORITY_HI,
2705 FIB_SOURCE_BH_SIMPLE);
2706 nat_fib_src_low = fib_source_allocate ("nat-low",
2707 FIB_SOURCE_PRIORITY_LOW,
2708 FIB_SOURCE_BH_SIMPLE);
2710 test_key_calc_split ();
2714 VLIB_INIT_FUNCTION (snat_init);
2717 snat_free_outside_address_and_port (snat_address_t * addresses,
2719 ip4_address_t * addr,
2720 u16 port, nat_protocol_t protocol)
2724 u16 port_host_byte_order = clib_net_to_host_u16 (port);
2726 for (address_index = 0; address_index < vec_len (addresses);
2729 if (addresses[address_index].addr.as_u32 == addr->as_u32)
2733 ASSERT (address_index < vec_len (addresses));
2735 a = addresses + address_index;
2739 #define _(N, i, n, s) \
2740 case NAT_PROTOCOL_##N: \
2741 ASSERT (a->busy_##n##_port_refcounts[port_host_byte_order] >= 1); \
2742 --a->busy_##n##_port_refcounts[port_host_byte_order]; \
2743 a->busy_##n##_ports--; \
2744 a->busy_##n##_ports_per_thread[thread_index]--; \
2746 foreach_nat_protocol
2749 nat_elog_info ("unknown protocol");
2755 nat_set_outside_address_and_port (snat_address_t * addresses,
2756 u32 thread_index, ip4_address_t addr,
2757 u16 port, nat_protocol_t protocol)
2759 snat_address_t *a = 0;
2761 u16 port_host_byte_order = clib_net_to_host_u16 (port);
2763 for (address_index = 0; address_index < vec_len (addresses);
2766 if (addresses[address_index].addr.as_u32 != addr.as_u32)
2769 a = addresses + address_index;
2772 #define _(N, j, n, s) \
2773 case NAT_PROTOCOL_##N: \
2774 if (a->busy_##n##_port_refcounts[port_host_byte_order]) \
2775 return VNET_API_ERROR_INSTANCE_IN_USE; \
2776 ++a->busy_##n##_port_refcounts[port_host_byte_order]; \
2777 a->busy_##n##_ports_per_thread[thread_index]++; \
2778 a->busy_##n##_ports++; \
2780 foreach_nat_protocol
2783 nat_elog_info ("unknown protocol");
2788 return VNET_API_ERROR_NO_SUCH_ENTRY;
2792 snat_static_mapping_match (snat_main_t * sm,
2793 ip4_address_t match_addr,
2795 u32 match_fib_index,
2796 nat_protocol_t match_protocol,
2797 ip4_address_t * mapping_addr,
2799 u32 * mapping_fib_index,
2802 twice_nat_type_t * twice_nat,
2803 lb_nat_type_t * lb, ip4_address_t * ext_host_addr,
2804 u8 * is_identity_nat)
2806 clib_bihash_kv_8_8_t kv, value;
2807 snat_static_mapping_t *m;
2808 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
2809 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2811 nat44_lb_addr_port_t *local;
2815 mapping_hash = &sm->static_mapping_by_external;
2816 init_nat_k (&kv, match_addr, match_port, 0, match_protocol);
2817 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2819 /* Try address only mapping */
2820 init_nat_k (&kv, match_addr, 0, 0, 0);
2821 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2828 init_nat_k (&kv, match_addr, match_port, match_fib_index,
2830 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2832 /* Try address only mapping */
2833 init_nat_k (&kv, match_addr, 0, match_fib_index, 0);
2834 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2840 m = pool_elt_at_index (sm->static_mappings, value.value);
2844 if (is_lb_static_mapping (m))
2846 if (PREDICT_FALSE (lb != 0))
2847 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2848 if (m->affinity && !nat_affinity_find_and_lock (ext_host_addr[0],
2854 local = pool_elt_at_index (m->locals, backend_index);
2855 *mapping_addr = local->addr;
2856 *mapping_port = local->port;
2857 *mapping_fib_index = local->fib_index;
2860 // pick locals matching this worker
2861 if (PREDICT_FALSE (sm->num_workers > 1))
2863 u32 thread_index = vlib_get_thread_index ();
2865 pool_foreach_index (i, m->locals,
2867 local = pool_elt_at_index (m->locals, i);
2870 .src_address = local->addr,
2873 if (sm->worker_in2out_cb (&ip, m->fib_index, 0) ==
2880 ASSERT (vec_len (tmp) != 0);
2885 pool_foreach_index (i, m->locals,
2891 hi = vec_len (tmp) - 1;
2892 local = pool_elt_at_index (m->locals, tmp[hi]);
2893 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2896 mid = ((hi - lo) >> 1) + lo;
2897 local = pool_elt_at_index (m->locals, tmp[mid]);
2898 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2900 local = pool_elt_at_index (m->locals, tmp[lo]);
2901 if (!(local->prefix >= rand))
2903 *mapping_addr = local->addr;
2904 *mapping_port = local->port;
2905 *mapping_fib_index = local->fib_index;
2908 if (nat_affinity_create_and_lock (ext_host_addr[0], match_addr,
2909 match_protocol, match_port,
2910 tmp[lo], m->affinity,
2911 m->affinity_per_service_list_head_index))
2912 nat_elog_info ("create affinity record failed");
2918 if (PREDICT_FALSE (lb != 0))
2920 *mapping_fib_index = m->fib_index;
2921 *mapping_addr = m->local_addr;
2922 /* Address only mapping doesn't change port */
2923 *mapping_port = is_addr_only_static_mapping (m) ? match_port
2929 *mapping_addr = m->external_addr;
2930 /* Address only mapping doesn't change port */
2931 *mapping_port = is_addr_only_static_mapping (m) ? match_port
2933 *mapping_fib_index = sm->outside_fib_index;
2937 if (PREDICT_FALSE (is_addr_only != 0))
2938 *is_addr_only = is_addr_only_static_mapping (m);
2940 if (PREDICT_FALSE (twice_nat != 0))
2941 *twice_nat = m->twice_nat;
2943 if (PREDICT_FALSE (is_identity_nat != 0))
2944 *is_identity_nat = is_identity_static_mapping (m);
2950 snat_alloc_outside_address_and_port (snat_address_t * addresses,
2953 nat_protocol_t proto,
2954 ip4_address_t * addr,
2956 u16 port_per_thread,
2957 u32 snat_thread_index)
2959 snat_main_t *sm = &snat_main;
2961 return sm->alloc_addr_and_port (addresses, fib_index, thread_index, proto,
2962 addr, port, port_per_thread,
2967 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2970 nat_protocol_t proto,
2971 ip4_address_t * addr,
2973 u16 port_per_thread, u32 snat_thread_index)
2976 snat_address_t *a, *ga = 0;
2979 for (i = 0; i < vec_len (addresses); i++)
2984 #define _(N, j, n, s) \
2985 case NAT_PROTOCOL_##N: \
2986 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
2988 if (a->fib_index == fib_index) \
2992 portnum = (port_per_thread * \
2993 snat_thread_index) + \
2994 snat_random_port(0, port_per_thread - 1) + 1024; \
2995 if (a->busy_##n##_port_refcounts[portnum]) \
2997 --a->busy_##n##_port_refcounts[portnum]; \
2998 a->busy_##n##_ports_per_thread[thread_index]++; \
2999 a->busy_##n##_ports++; \
3001 *port = clib_host_to_net_u16(portnum); \
3005 else if (a->fib_index == ~0) \
3011 foreach_nat_protocol
3014 nat_elog_info ("unknown protocol");
3025 #define _(N, j, n, s) \
3026 case NAT_PROTOCOL_##N: \
3029 portnum = (port_per_thread * \
3030 snat_thread_index) + \
3031 snat_random_port(0, port_per_thread - 1) + 1024; \
3032 if (a->busy_##n##_port_refcounts[portnum]) \
3034 ++a->busy_##n##_port_refcounts[portnum]; \
3035 a->busy_##n##_ports_per_thread[thread_index]++; \
3036 a->busy_##n##_ports++; \
3038 *port = clib_host_to_net_u16(portnum); \
3042 foreach_nat_protocol
3045 nat_elog_info ("unknown protocol");
3050 /* Totally out of translations to use... */
3051 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3056 nat_alloc_addr_and_port_mape (snat_address_t * addresses, u32 fib_index,
3057 u32 thread_index, nat_protocol_t proto,
3058 ip4_address_t * addr, u16 * port,
3059 u16 port_per_thread, u32 snat_thread_index)
3061 snat_main_t *sm = &snat_main;
3062 snat_address_t *a = addresses;
3063 u16 m, ports, portnum, A, j;
3064 m = 16 - (sm->psid_offset + sm->psid_length);
3065 ports = (1 << (16 - sm->psid_length)) - (1 << m);
3067 if (!vec_len (addresses))
3072 #define _(N, i, n, s) \
3073 case NAT_PROTOCOL_##N: \
3074 if (a->busy_##n##_ports < ports) \
3078 A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
3079 j = snat_random_port(0, pow2_mask(m)); \
3080 portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
3081 if (a->busy_##n##_port_refcounts[portnum]) \
3083 ++a->busy_##n##_port_refcounts[portnum]; \
3084 a->busy_##n##_ports++; \
3086 *port = clib_host_to_net_u16 (portnum); \
3091 foreach_nat_protocol
3094 nat_elog_info ("unknown protocol");
3099 /* Totally out of translations to use... */
3100 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3105 nat_alloc_addr_and_port_range (snat_address_t * addresses, u32 fib_index,
3106 u32 thread_index, nat_protocol_t proto,
3107 ip4_address_t * addr, u16 * port,
3108 u16 port_per_thread, u32 snat_thread_index)
3110 snat_main_t *sm = &snat_main;
3111 snat_address_t *a = addresses;
3114 ports = sm->end_port - sm->start_port + 1;
3116 if (!vec_len (addresses))
3121 #define _(N, i, n, s) \
3122 case NAT_PROTOCOL_##N: \
3123 if (a->busy_##n##_ports < ports) \
3127 portnum = snat_random_port(sm->start_port, sm->end_port); \
3128 if (a->busy_##n##_port_refcounts[portnum]) \
3130 ++a->busy_##n##_port_refcounts[portnum]; \
3131 a->busy_##n##_ports++; \
3133 *port = clib_host_to_net_u16 (portnum); \
3138 foreach_nat_protocol
3141 nat_elog_info ("unknown protocol");
3146 /* Totally out of translations to use... */
3147 snat_ipfix_logging_addresses_exhausted (thread_index, 0);
3152 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
3154 dpo_id_t dpo_v4 = DPO_INVALID;
3155 fib_prefix_t pfx = {
3156 .fp_proto = FIB_PROTOCOL_IP4,
3158 .fp_addr.ip4.as_u32 = addr.as_u32,
3163 nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
3164 fib_table_entry_special_dpo_add (0, &pfx, nat_fib_src_hi,
3165 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
3166 dpo_reset (&dpo_v4);
3170 fib_table_entry_special_remove (0, &pfx, nat_fib_src_hi);
3175 format_session_kvp (u8 * s, va_list * args)
3177 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3179 s = format (s, "%U session-index %llu", format_snat_key, v->key, v->value);
3185 format_static_mapping_kvp (u8 * s, va_list * args)
3187 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3189 s = format (s, "%U static-mapping-index %llu",
3190 format_snat_key, v->key, v->value);
3196 format_user_kvp (u8 * s, va_list * args)
3198 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
3203 s = format (s, "%U fib %d user-index %llu", format_ip4_address, &k.addr,
3204 k.fib_index, v->value);
3210 format_ed_session_kvp (u8 * s, va_list * args)
3212 clib_bihash_kv_16_8_t *v = va_arg (*args, clib_bihash_kv_16_8_t *);
3216 ip4_address_t l_addr, r_addr;
3219 split_ed_kv (v, &l_addr, &r_addr, &proto, &fib_index, &l_port, &r_port);
3222 "local %U:%d remote %U:%d proto %U fib %d thread-index %u session-index %u",
3223 format_ip4_address, &l_addr, clib_net_to_host_u16 (l_port),
3224 format_ip4_address, &r_addr, clib_net_to_host_u16 (r_port),
3225 format_ip_protocol, proto, fib_index,
3226 ed_value_get_session_index (v), ed_value_get_thread_index (v));
3232 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0,
3235 snat_main_t *sm = &snat_main;
3236 u32 next_worker_index = 0;
3239 next_worker_index = sm->first_worker_index;
3240 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
3241 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >> 24);
3243 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3244 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3246 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3248 return next_worker_index;
3252 snat_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip0,
3253 u32 rx_fib_index0, u8 is_output)
3255 snat_main_t *sm = &snat_main;
3258 clib_bihash_kv_8_8_t kv, value;
3259 snat_static_mapping_t *m;
3261 u32 next_worker_index = 0;
3263 /* first try static mappings without port */
3264 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3266 init_nat_k (&kv, ip0->dst_address, 0, rx_fib_index0, 0);
3267 if (!clib_bihash_search_8_8
3268 (&sm->static_mapping_by_external, &kv, &value))
3270 m = pool_elt_at_index (sm->static_mappings, value.value);
3271 return m->workers[0];
3275 proto = ip_proto_to_nat_proto (ip0->protocol);
3276 udp = ip4_next_header (ip0);
3277 port = udp->dst_port;
3279 /* unknown protocol */
3280 if (PREDICT_FALSE (proto == NAT_PROTOCOL_OTHER))
3282 /* use current thread */
3283 return vlib_get_thread_index ();
3286 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
3288 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3289 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3290 if (!icmp_type_is_error_message
3291 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3292 port = vnet_buffer (b)->ip.reass.l4_src_port;
3295 /* if error message, then it's not fragmented and we can access it */
3296 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3297 proto = ip_proto_to_nat_proto (inner_ip->protocol);
3298 void *l4_header = ip4_next_header (inner_ip);
3301 case NAT_PROTOCOL_ICMP:
3302 icmp = (icmp46_header_t *) l4_header;
3303 echo = (icmp_echo_header_t *) (icmp + 1);
3304 port = echo->identifier;
3306 case NAT_PROTOCOL_UDP:
3307 case NAT_PROTOCOL_TCP:
3308 port = ((tcp_udp_header_t *) l4_header)->src_port;
3311 return vlib_get_thread_index ();
3316 /* try static mappings with port */
3317 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3319 init_nat_k (&kv, ip0->dst_address, port, rx_fib_index0, proto);
3320 if (!clib_bihash_search_8_8
3321 (&sm->static_mapping_by_external, &kv, &value))
3323 m = pool_elt_at_index (sm->static_mappings, value.value);
3324 return m->workers[0];
3328 /* worker by outside port */
3329 next_worker_index = sm->first_worker_index;
3330 next_worker_index +=
3331 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3332 return next_worker_index;
3336 nat44_ed_get_worker_in2out_cb (ip4_header_t * ip, u32 rx_fib_index,
3339 snat_main_t *sm = &snat_main;
3340 u32 next_worker_index = sm->first_worker_index;
3343 clib_bihash_kv_16_8_t kv16, value16;
3344 snat_main_per_thread_data_t *tsm;
3347 if (PREDICT_FALSE (is_output))
3349 u32 fib_index = sm->outside_fib_index;
3350 nat_outside_fib_t *outside_fib;
3351 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3352 fib_prefix_t pfx = {
3353 .fp_proto = FIB_PROTOCOL_IP4,
3356 .ip4.as_u32 = ip->dst_address.as_u32,
3361 udp = ip4_next_header (ip);
3363 switch (vec_len (sm->outside_fibs))
3366 fib_index = sm->outside_fib_index;
3369 fib_index = sm->outside_fibs[0].fib_index;
3373 vec_foreach (outside_fib, sm->outside_fibs)
3375 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3376 if (FIB_NODE_INDEX_INVALID != fei)
3378 if (fib_entry_get_resolving_interface (fei) != ~0)
3380 fib_index = outside_fib->fib_index;
3389 init_ed_k (&kv16, ip->src_address, udp->src_port, ip->dst_address,
3390 udp->dst_port, fib_index, ip->protocol);
3392 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&sm->out2in_ed,
3396 vec_elt_at_index (sm->per_thread_data,
3397 ed_value_get_thread_index (&value16));
3398 next_worker_index += tsm->thread_index;
3400 nat_elog_debug_handoff ("HANDOFF IN2OUT-OUTPUT-FEATURE (session)",
3401 next_worker_index, fib_index,
3402 clib_net_to_host_u32 (ip->
3403 src_address.as_u32),
3404 clib_net_to_host_u32 (ip->
3405 dst_address.as_u32));
3407 return next_worker_index;
3411 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3412 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3414 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3415 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3417 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3419 if (PREDICT_TRUE (!is_output))
3421 nat_elog_debug_handoff ("HANDOFF IN2OUT",
3422 next_worker_index, rx_fib_index,
3423 clib_net_to_host_u32 (ip->src_address.as_u32),
3424 clib_net_to_host_u32 (ip->dst_address.as_u32));
3428 nat_elog_debug_handoff ("HANDOFF IN2OUT-OUTPUT-FEATURE",
3429 next_worker_index, rx_fib_index,
3430 clib_net_to_host_u32 (ip->src_address.as_u32),
3431 clib_net_to_host_u32 (ip->dst_address.as_u32));
3434 return next_worker_index;
3438 nat44_ed_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip,
3439 u32 rx_fib_index, u8 is_output)
3441 snat_main_t *sm = &snat_main;
3442 clib_bihash_kv_8_8_t kv, value;
3443 clib_bihash_kv_16_8_t kv16, value16;
3444 snat_main_per_thread_data_t *tsm;
3446 u32 proto, next_worker_index = 0;
3449 snat_static_mapping_t *m;
3452 proto = ip_proto_to_nat_proto (ip->protocol);
3454 if (PREDICT_TRUE (proto == NAT_PROTOCOL_UDP || proto == NAT_PROTOCOL_TCP))
3456 udp = ip4_next_header (ip);
3458 init_ed_k (&kv16, ip->dst_address, udp->dst_port, ip->src_address,
3459 udp->src_port, rx_fib_index, ip->protocol);
3461 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&sm->out2in_ed,
3465 vec_elt_at_index (sm->per_thread_data,
3466 ed_value_get_thread_index (&value16));
3467 vnet_buffer2 (b)->nat.ed_out2in_nat_session_index =
3468 ed_value_get_session_index (&value16);
3469 next_worker_index = sm->first_worker_index + tsm->thread_index;
3470 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3471 next_worker_index, rx_fib_index,
3472 clib_net_to_host_u32 (ip->
3473 src_address.as_u32),
3474 clib_net_to_host_u32 (ip->
3475 dst_address.as_u32));
3476 return next_worker_index;
3479 else if (proto == NAT_PROTOCOL_ICMP)
3481 if (!get_icmp_o2i_ed_key (b, ip, rx_fib_index, ~0, ~0, 0, 0, 0, &kv16))
3483 if (PREDICT_TRUE (!clib_bihash_search_16_8 (&sm->out2in_ed,
3487 vec_elt_at_index (sm->per_thread_data,
3488 ed_value_get_thread_index (&value16));
3489 next_worker_index = sm->first_worker_index + tsm->thread_index;
3490 nat_elog_debug_handoff ("HANDOFF OUT2IN (session)",
3491 next_worker_index, rx_fib_index,
3492 clib_net_to_host_u32 (ip->
3493 src_address.as_u32),
3494 clib_net_to_host_u32 (ip->
3495 dst_address.as_u32));
3496 return next_worker_index;
3501 /* first try static mappings without port */
3502 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3504 init_nat_k (&kv, ip->dst_address, 0, 0, 0);
3505 if (!clib_bihash_search_8_8
3506 (&sm->static_mapping_by_external, &kv, &value))
3508 m = pool_elt_at_index (sm->static_mappings, value.value);
3509 next_worker_index = m->workers[0];
3514 /* unknown protocol */
3515 if (PREDICT_FALSE (proto == NAT_PROTOCOL_OTHER))
3517 /* use current thread */
3518 next_worker_index = vlib_get_thread_index ();
3522 udp = ip4_next_header (ip);
3523 port = udp->dst_port;
3525 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
3527 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3528 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3529 if (!icmp_type_is_error_message
3530 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3531 port = vnet_buffer (b)->ip.reass.l4_src_port;
3534 /* if error message, then it's not fragmented and we can access it */
3535 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3536 proto = ip_proto_to_nat_proto (inner_ip->protocol);
3537 void *l4_header = ip4_next_header (inner_ip);
3540 case NAT_PROTOCOL_ICMP:
3541 icmp = (icmp46_header_t *) l4_header;
3542 echo = (icmp_echo_header_t *) (icmp + 1);
3543 port = echo->identifier;
3545 case NAT_PROTOCOL_UDP:
3546 case NAT_PROTOCOL_TCP:
3547 port = ((tcp_udp_header_t *) l4_header)->src_port;
3550 next_worker_index = vlib_get_thread_index ();
3556 /* try static mappings with port */
3557 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3559 init_nat_k (&kv, ip->dst_address, proto, 0, port);
3560 if (!clib_bihash_search_8_8
3561 (&sm->static_mapping_by_external, &kv, &value))
3563 m = pool_elt_at_index (sm->static_mappings, value.value);
3564 if (!is_lb_static_mapping (m))
3566 next_worker_index = m->workers[0];
3570 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3571 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3573 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
3575 m->workers[hash & (_vec_len (m->workers) - 1)];
3577 next_worker_index = m->workers[hash % _vec_len (m->workers)];
3582 /* worker by outside port */
3583 next_worker_index = sm->first_worker_index;
3584 next_worker_index +=
3585 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3588 nat_elog_debug_handoff ("HANDOFF OUT2IN", next_worker_index, rx_fib_index,
3589 clib_net_to_host_u32 (ip->src_address.as_u32),
3590 clib_net_to_host_u32 (ip->dst_address.as_u32));
3591 return next_worker_index;
3595 nat_ha_sadd_cb (ip4_address_t * in_addr, u16 in_port,
3596 ip4_address_t * out_addr, u16 out_port,
3597 ip4_address_t * eh_addr, u16 eh_port,
3598 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3599 u32 fib_index, u16 flags, u32 thread_index)
3601 snat_main_t *sm = &snat_main;
3602 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
3605 clib_bihash_kv_8_8_t kv;
3606 vlib_main_t *vm = vlib_get_main ();
3607 f64 now = vlib_time_now (vm);
3608 nat_outside_fib_t *outside_fib;
3609 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3610 fib_prefix_t pfx = {
3611 .fp_proto = FIB_PROTOCOL_IP4,
3614 .ip4.as_u32 = eh_addr->as_u32,
3618 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3620 if (nat_set_outside_address_and_port
3621 (sm->addresses, thread_index, *out_addr, out_port, proto))
3625 u = nat_user_get_or_create (sm, in_addr, fib_index, thread_index);
3629 s = nat_session_alloc_or_recycle (sm, u, thread_index, now);
3633 if (sm->endpoint_dependent)
3635 nat_ed_lru_insert (tsm, s, now, nat_proto_to_ip_proto (proto));
3638 s->out2in.addr.as_u32 = out_addr->as_u32;
3639 s->out2in.port = out_port;
3640 s->nat_proto = proto;
3641 s->last_heard = now;
3643 s->ext_host_addr.as_u32 = eh_addr->as_u32;
3644 s->ext_host_port = eh_port;
3645 user_session_increment (sm, u, snat_is_session_static (s));
3646 switch (vec_len (sm->outside_fibs))
3649 s->out2in.fib_index = sm->outside_fib_index;
3652 s->out2in.fib_index = sm->outside_fibs[0].fib_index;
3656 vec_foreach (outside_fib, sm->outside_fibs)
3658 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3659 if (FIB_NODE_INDEX_INVALID != fei)
3661 if (fib_entry_get_resolving_interface (fei) != ~0)
3663 s->out2in.fib_index = outside_fib->fib_index;
3671 init_nat_o2i_kv (&kv, s, s - tsm->sessions);
3672 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 1))
3673 nat_elog_warn ("out2in key add failed");
3675 s->in2out.addr.as_u32 = in_addr->as_u32;
3676 s->in2out.port = in_port;
3677 s->in2out.fib_index = fib_index;
3678 init_nat_i2o_kv (&kv, s, s - tsm->sessions);
3679 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 1))
3680 nat_elog_warn ("in2out key add failed");
3684 nat_ha_sdel_cb (ip4_address_t * out_addr, u16 out_port,
3685 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3688 snat_main_t *sm = &snat_main;
3689 clib_bihash_kv_8_8_t kv, value;
3692 snat_main_per_thread_data_t *tsm;
3694 if (sm->num_workers > 1)
3696 sm->first_worker_index +
3697 (sm->workers[(clib_net_to_host_u16 (out_port) -
3698 1024) / sm->port_per_thread]);
3700 thread_index = sm->num_workers;
3701 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3703 init_nat_k (&kv, *out_addr, out_port, fib_index, proto);
3704 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3707 s = pool_elt_at_index (tsm->sessions, value.value);
3708 nat_free_session_data (sm, s, thread_index, 1);
3709 nat44_delete_session (sm, s, thread_index);
3713 nat_ha_sref_cb (ip4_address_t * out_addr, u16 out_port,
3714 ip4_address_t * eh_addr, u16 eh_port, u8 proto, u32 fib_index,
3715 u32 total_pkts, u64 total_bytes, u32 thread_index)
3717 snat_main_t *sm = &snat_main;
3718 clib_bihash_kv_8_8_t kv, value;
3720 snat_main_per_thread_data_t *tsm;
3722 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3724 init_nat_k (&kv, *out_addr, out_port, fib_index, proto);
3725 if (clib_bihash_search_8_8 (&tsm->out2in, &kv, &value))
3728 s = pool_elt_at_index (tsm->sessions, value.value);
3729 s->total_pkts = total_pkts;
3730 s->total_bytes = total_bytes;
3734 nat_ha_sadd_ed_cb (ip4_address_t * in_addr, u16 in_port,
3735 ip4_address_t * out_addr, u16 out_port,
3736 ip4_address_t * eh_addr, u16 eh_port,
3737 ip4_address_t * ehn_addr, u16 ehn_port, u8 proto,
3738 u32 fib_index, u16 flags, u32 thread_index)
3740 snat_main_t *sm = &snat_main;
3741 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
3743 clib_bihash_kv_16_8_t kv;
3744 vlib_main_t *vm = vlib_get_main ();
3745 f64 now = vlib_time_now (vm);
3746 nat_outside_fib_t *outside_fib;
3747 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
3748 fib_prefix_t pfx = {
3749 .fp_proto = FIB_PROTOCOL_IP4,
3752 .ip4.as_u32 = eh_addr->as_u32,
3757 if (!(flags & SNAT_SESSION_FLAG_STATIC_MAPPING))
3759 if (nat_set_outside_address_and_port
3760 (sm->addresses, thread_index, *out_addr, out_port, proto))
3764 if (flags & SNAT_SESSION_FLAG_TWICE_NAT)
3766 if (nat_set_outside_address_and_port
3767 (sm->addresses, thread_index, *ehn_addr, ehn_port, proto))
3771 s = nat_ed_session_alloc (sm, thread_index, now, proto);
3775 s->last_heard = now;
3777 s->ext_host_nat_addr.as_u32 = s->ext_host_addr.as_u32 = eh_addr->as_u32;
3778 s->ext_host_nat_port = s->ext_host_port = eh_port;
3779 if (is_twice_nat_session (s))
3781 s->ext_host_nat_addr.as_u32 = ehn_addr->as_u32;
3782 s->ext_host_nat_port = ehn_port;
3784 switch (vec_len (sm->outside_fibs))
3787 s->out2in.fib_index = sm->outside_fib_index;
3790 s->out2in.fib_index = sm->outside_fibs[0].fib_index;
3794 vec_foreach (outside_fib, sm->outside_fibs)
3796 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
3797 if (FIB_NODE_INDEX_INVALID != fei)
3799 if (fib_entry_get_resolving_interface (fei) != ~0)
3801 s->out2in.fib_index = outside_fib->fib_index;
3809 s->nat_proto = proto;
3810 s->out2in.addr.as_u32 = out_addr->as_u32;
3811 s->out2in.port = out_port;
3813 s->in2out.addr.as_u32 = in_addr->as_u32;
3814 s->in2out.port = in_port;
3815 s->in2out.fib_index = fib_index;
3817 init_ed_kv (&kv, *in_addr, in_port, s->ext_host_nat_addr,
3818 s->ext_host_nat_port, fib_index, nat_proto_to_ip_proto (proto),
3819 thread_index, s - tsm->sessions);
3820 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &kv, 1))
3821 nat_elog_warn ("in2out key add failed");
3823 init_ed_kv (&kv, *out_addr, out_port, *eh_addr, eh_port,
3824 s->out2in.fib_index, nat_proto_to_ip_proto (proto),
3825 thread_index, s - tsm->sessions);
3826 if (clib_bihash_add_del_16_8 (&sm->out2in_ed, &kv, 1))
3827 nat_elog_warn ("out2in key add failed");
3831 nat_ha_sdel_ed_cb (ip4_address_t * out_addr, u16 out_port,
3832 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3833 u32 fib_index, u32 ti)
3835 snat_main_t *sm = &snat_main;
3836 clib_bihash_kv_16_8_t kv, value;
3839 snat_main_per_thread_data_t *tsm;
3841 if (sm->num_workers > 1)
3843 sm->first_worker_index +
3844 (sm->workers[(clib_net_to_host_u16 (out_port) -
3845 1024) / sm->port_per_thread]);
3847 thread_index = sm->num_workers;
3848 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3850 init_ed_k (&kv, *out_addr, out_port, *eh_addr, eh_port, fib_index, proto);
3851 if (clib_bihash_search_16_8 (&sm->out2in_ed, &kv, &value))
3854 s = pool_elt_at_index (tsm->sessions, ed_value_get_session_index (&value));
3855 nat_free_session_data (sm, s, thread_index, 1);
3856 nat44_delete_session (sm, s, thread_index);
3860 nat_ha_sref_ed_cb (ip4_address_t * out_addr, u16 out_port,
3861 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3862 u32 fib_index, u32 total_pkts, u64 total_bytes,
3865 snat_main_t *sm = &snat_main;
3866 clib_bihash_kv_16_8_t kv, value;
3868 snat_main_per_thread_data_t *tsm;
3870 tsm = vec_elt_at_index (sm->per_thread_data, thread_index);
3872 init_ed_k (&kv, *out_addr, out_port, *eh_addr, eh_port, fib_index, proto);
3873 if (clib_bihash_search_16_8 (&sm->out2in_ed, &kv, &value))
3876 s = pool_elt_at_index (tsm->sessions, ed_value_get_session_index (&value));
3877 s->total_pkts = total_pkts;
3878 s->total_bytes = total_bytes;
3882 nat_calc_bihash_buckets (u32 n_elts)
3884 return 1 << (max_log2 (n_elts >> 1) + 1);
3888 nat_calc_bihash_memory (u32 n_buckets, uword kv_size)
3890 return n_buckets * (8 + kv_size * 4);
3894 nat44_get_max_session_limit ()
3896 snat_main_t *sm = &snat_main;
3897 u32 max_limit = 0, len = 0;
3899 for (; len < vec_len (sm->max_translations_per_fib); len++)
3901 if (max_limit < sm->max_translations_per_fib[len])
3902 max_limit = sm->max_translations_per_fib[len];
3908 nat44_set_session_limit (u32 session_limit, u32 vrf_id)
3910 snat_main_t *sm = &snat_main;
3911 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3912 u32 len = vec_len (sm->max_translations_per_fib);
3914 if (len <= fib_index)
3916 vec_validate (sm->max_translations_per_fib, fib_index + 1);
3918 for (; len < vec_len (sm->max_translations_per_fib); len++)
3919 sm->max_translations_per_fib[len] = sm->max_translations_per_thread;
3922 sm->max_translations_per_fib[fib_index] = session_limit;
3927 nat44_update_session_limit (u32 session_limit, u32 vrf_id)
3929 snat_main_t *sm = &snat_main;
3931 if (nat44_set_session_limit (session_limit, vrf_id))
3933 sm->max_translations_per_thread = nat44_get_max_session_limit ();
3935 sm->translation_buckets =
3936 nat_calc_bihash_buckets (sm->max_translations_per_thread);
3938 if (!sm->translation_memory_size_set)
3940 sm->translation_memory_size =
3941 nat_calc_bihash_memory (sm->translation_buckets,
3942 sizeof (clib_bihash_16_8_t));
3945 nat44_sessions_clear ();
3950 nat44_db_init (snat_main_per_thread_data_t * tsm)
3952 snat_main_t *sm = &snat_main;
3954 pool_alloc (tsm->sessions, sm->max_translations_per_thread);
3955 pool_alloc (tsm->lru_pool, sm->max_translations_per_thread);
3959 pool_get (tsm->lru_pool, head);
3960 tsm->tcp_trans_lru_head_index = head - tsm->lru_pool;
3961 clib_dlist_init (tsm->lru_pool, tsm->tcp_trans_lru_head_index);
3963 pool_get (tsm->lru_pool, head);
3964 tsm->tcp_estab_lru_head_index = head - tsm->lru_pool;
3965 clib_dlist_init (tsm->lru_pool, tsm->tcp_estab_lru_head_index);
3967 pool_get (tsm->lru_pool, head);
3968 tsm->udp_lru_head_index = head - tsm->lru_pool;
3969 clib_dlist_init (tsm->lru_pool, tsm->udp_lru_head_index);
3971 pool_get (tsm->lru_pool, head);
3972 tsm->icmp_lru_head_index = head - tsm->lru_pool;
3973 clib_dlist_init (tsm->lru_pool, tsm->icmp_lru_head_index);
3975 pool_get (tsm->lru_pool, head);
3976 tsm->unk_proto_lru_head_index = head - tsm->lru_pool;
3977 clib_dlist_init (tsm->lru_pool, tsm->unk_proto_lru_head_index);
3979 if (sm->endpoint_dependent)
3981 clib_bihash_init_16_8 (&tsm->in2out_ed, "in2out-ed",
3982 sm->translation_buckets,
3983 sm->translation_memory_size);
3984 clib_bihash_set_kvp_format_fn_16_8 (&tsm->in2out_ed,
3985 format_ed_session_kvp);
3990 clib_bihash_init_8_8 (&tsm->in2out, "in2out",
3991 sm->translation_buckets,
3992 sm->translation_memory_size);
3993 clib_bihash_set_kvp_format_fn_8_8 (&tsm->in2out, format_session_kvp);
3994 clib_bihash_init_8_8 (&tsm->out2in, "out2in",
3995 sm->translation_buckets,
3996 sm->translation_memory_size);
3997 clib_bihash_set_kvp_format_fn_8_8 (&tsm->out2in, format_session_kvp);
4000 // TODO: resolve static mappings (put only to !ED)
4001 pool_alloc (tsm->list_pool, sm->max_translations_per_thread);
4002 clib_bihash_init_8_8 (&tsm->user_hash, "users", sm->user_buckets,
4003 sm->user_memory_size);
4004 clib_bihash_set_kvp_format_fn_8_8 (&tsm->user_hash, format_user_kvp);
4008 nat44_db_free (snat_main_per_thread_data_t * tsm)
4010 snat_main_t *sm = &snat_main;
4012 pool_free (tsm->sessions);
4013 pool_free (tsm->lru_pool);
4015 if (sm->endpoint_dependent)
4017 clib_bihash_free_16_8 (&tsm->in2out_ed);
4018 vec_free (tsm->per_vrf_sessions_vec);
4022 clib_bihash_free_8_8 (&tsm->in2out);
4023 clib_bihash_free_8_8 (&tsm->out2in);
4026 // TODO: resolve static mappings (put only to !ED)
4027 pool_free (tsm->users);
4028 pool_free (tsm->list_pool);
4029 clib_bihash_free_8_8 (&tsm->user_hash);
4033 nat44_sessions_clear ()
4035 snat_main_t *sm = &snat_main;
4036 snat_main_per_thread_data_t *tsm;
4038 if (sm->endpoint_dependent)
4040 clib_bihash_free_16_8 (&sm->out2in_ed);
4041 clib_bihash_init_16_8 (&sm->out2in_ed, "out2in-ed",
4042 clib_max (1, sm->num_workers) *
4043 sm->translation_buckets,
4044 clib_max (1, sm->num_workers) *
4045 sm->translation_memory_size);
4046 clib_bihash_set_kvp_format_fn_16_8 (&sm->out2in_ed,
4047 format_ed_session_kvp);
4051 vec_foreach (tsm, sm->per_thread_data)
4055 nat44_db_free (tsm);
4056 nat44_db_init (tsm);
4058 ti = tsm->snat_thread_index;
4059 vlib_set_simple_counter (&sm->total_users, ti, 0, 0);
4060 vlib_set_simple_counter (&sm->total_sessions, ti, 0, 0);
4065 static clib_error_t *
4066 snat_config (vlib_main_t * vm, unformat_input_t * input)
4068 snat_main_t *sm = &snat_main;
4069 snat_main_per_thread_data_t *tsm;
4071 u32 static_mapping_buckets = 1024;
4072 uword static_mapping_memory_size = 64 << 20;
4074 u32 nat64_bib_buckets = 1024;
4075 u32 nat64_bib_memory_size = 128 << 20;
4077 u32 nat64_st_buckets = 2048;
4078 uword nat64_st_memory_size = 256 << 20;
4080 u32 max_users_per_thread = 0;
4081 u32 user_memory_size = 0;
4082 u32 max_translations_per_thread = 0;
4083 u32 translation_memory_size = 0;
4085 u32 max_translations_per_user = ~0;
4087 u32 outside_vrf_id = 0;
4088 u32 outside_ip6_vrf_id = 0;
4089 u32 inside_vrf_id = 0;
4090 u8 static_mapping_only = 0;
4091 u8 static_mapping_connection_tracking = 0;
4093 u32 udp_timeout = SNAT_UDP_TIMEOUT;
4094 u32 icmp_timeout = SNAT_ICMP_TIMEOUT;
4095 u32 tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
4096 u32 tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
4099 sm->endpoint_dependent = 0;
4101 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
4104 (input, "max translations per thread %d",
4105 &max_translations_per_thread))
4107 else if (unformat (input, "udp timeout %d", &udp_timeout))
4109 else if (unformat (input, "icmp timeout %d", &icmp_timeout))
4111 else if (unformat (input, "tcp transitory timeout %d",
4112 &tcp_transitory_timeout));
4113 else if (unformat (input, "tcp established timeout %d",
4114 &tcp_established_timeout));
4115 else if (unformat (input, "translation hash memory %d",
4116 &translation_memory_size));
4119 (input, "max users per thread %d", &max_users_per_thread))
4121 else if (unformat (input, "user hash memory %d", &user_memory_size))
4123 else if (unformat (input, "max translations per user %d",
4124 &max_translations_per_user))
4126 else if (unformat (input, "outside VRF id %d", &outside_vrf_id))
4128 else if (unformat (input, "outside ip6 VRF id %d", &outside_ip6_vrf_id))
4130 else if (unformat (input, "inside VRF id %d", &inside_vrf_id))
4132 else if (unformat (input, "static mapping only"))
4134 static_mapping_only = 1;
4135 if (unformat (input, "connection tracking"))
4136 static_mapping_connection_tracking = 1;
4138 else if (unformat (input, "nat64 bib hash buckets %d",
4139 &nat64_bib_buckets))
4141 else if (unformat (input, "nat64 bib hash memory %d",
4142 &nat64_bib_memory_size))
4145 if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
4147 else if (unformat (input, "nat64 st hash memory %d",
4148 &nat64_st_memory_size))
4150 else if (unformat (input, "out2in dpo"))
4152 else if (unformat (input, "endpoint-dependent"))
4153 sm->endpoint_dependent = 1;
4155 return clib_error_return (0, "unknown input '%U'",
4156 format_unformat_error, input);
4159 if (static_mapping_only && (sm->endpoint_dependent))
4160 return clib_error_return (0,
4161 "static mapping only mode available only for simple nat");
4163 if (sm->out2in_dpo && (sm->endpoint_dependent))
4164 return clib_error_return (0,
4165 "out2in dpo mode available only for simple nat");
4166 if (sm->endpoint_dependent && max_users_per_thread > 0)
4168 return clib_error_return (0,
4169 "setting 'max users' in endpoint-dependent mode is not supported");
4172 if (sm->endpoint_dependent && max_translations_per_user != ~0)
4174 return clib_error_return (0,
4175 "setting 'max translations per user' in endpoint-dependent mode is not supported");
4178 /* optionally configurable timeouts for testing purposes */
4179 sm->udp_timeout = udp_timeout;
4180 sm->tcp_transitory_timeout = tcp_transitory_timeout;
4181 sm->tcp_established_timeout = tcp_established_timeout;
4182 sm->icmp_timeout = icmp_timeout;
4184 if (0 == max_users_per_thread)
4186 max_users_per_thread = 1024;
4188 sm->max_users_per_thread = max_users_per_thread;
4189 sm->user_buckets = nat_calc_bihash_buckets (sm->max_users_per_thread);
4191 if (0 == max_translations_per_thread)
4193 // default value based on legacy setting of load factor 10 * default
4194 // translation buckets 1024
4195 max_translations_per_thread = 10 * 1024;
4197 sm->translation_memory_size_set = translation_memory_size != 0;
4199 sm->max_translations_per_thread = max_translations_per_thread;
4200 sm->translation_buckets =
4201 nat_calc_bihash_buckets (sm->max_translations_per_thread);
4202 if (0 == translation_memory_size)
4204 translation_memory_size =
4205 nat_calc_bihash_memory (sm->translation_buckets,
4206 sizeof (clib_bihash_16_8_t));
4208 sm->translation_memory_size = translation_memory_size;
4209 if (0 == user_memory_size)
4212 nat_calc_bihash_memory (sm->max_users_per_thread,
4213 sizeof (clib_bihash_8_8_t));
4215 sm->user_memory_size = user_memory_size;
4216 vec_add1 (sm->max_translations_per_fib, sm->max_translations_per_thread);
4218 sm->max_translations_per_user = max_translations_per_user == ~0 ?
4219 sm->max_translations_per_thread : max_translations_per_user;
4221 sm->outside_vrf_id = outside_vrf_id;
4222 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
4225 sm->inside_vrf_id = inside_vrf_id;
4226 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
4229 sm->static_mapping_only = static_mapping_only;
4230 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
4232 nat64_set_hash (nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
4233 nat64_st_memory_size);
4235 if (sm->endpoint_dependent)
4237 sm->worker_in2out_cb = nat44_ed_get_worker_in2out_cb;
4238 sm->worker_out2in_cb = nat44_ed_get_worker_out2in_cb;
4240 sm->in2out_node_index = nat44_ed_in2out_node.index;
4241 sm->in2out_output_node_index = nat44_ed_in2out_output_node.index;
4242 sm->out2in_node_index = nat44_ed_out2in_node.index;
4244 sm->icmp_match_in2out_cb = icmp_match_in2out_ed;
4245 sm->icmp_match_out2in_cb = icmp_match_out2in_ed;
4246 nat_affinity_init (vm);
4247 nat_ha_init (vm, nat_ha_sadd_ed_cb, nat_ha_sdel_ed_cb,
4249 clib_bihash_init_16_8 (&sm->out2in_ed, "out2in-ed",
4250 clib_max (1, sm->num_workers) *
4251 sm->translation_buckets,
4252 clib_max (1, sm->num_workers) *
4253 sm->translation_memory_size);
4254 clib_bihash_set_kvp_format_fn_16_8 (&sm->out2in_ed,
4255 format_ed_session_kvp);
4259 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
4260 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
4262 sm->in2out_node_index = snat_in2out_node.index;
4263 sm->in2out_output_node_index = snat_in2out_output_node.index;
4264 sm->out2in_node_index = snat_out2in_node.index;
4266 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
4267 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
4268 nat_ha_init (vm, nat_ha_sadd_cb, nat_ha_sdel_cb, nat_ha_sref_cb);
4270 if (!static_mapping_only ||
4271 (static_mapping_only && static_mapping_connection_tracking))
4274 vec_foreach (tsm, sm->per_thread_data)
4276 nat44_db_init (tsm);
4282 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
4283 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
4285 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
4286 "static_mapping_by_local", static_mapping_buckets,
4287 static_mapping_memory_size);
4288 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_local,
4289 format_static_mapping_kvp);
4291 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
4292 "static_mapping_by_external",
4293 static_mapping_buckets, static_mapping_memory_size);
4294 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_external,
4295 format_static_mapping_kvp);
4300 VLIB_CONFIG_FUNCTION (snat_config, "nat");
4303 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
4306 ip4_address_t * address,
4308 u32 if_address_index, u32 is_delete)
4310 snat_main_t *sm = &snat_main;
4311 snat_static_map_resolve_t *rp;
4312 snat_static_mapping_t *m;
4313 clib_bihash_kv_8_8_t kv, value;
4315 ip4_address_t l_addr;
4317 for (i = 0; i < vec_len (sm->to_resolve); i++)
4319 rp = sm->to_resolve + i;
4320 if (rp->addr_only == 0)
4322 if (rp->sw_if_index == sw_if_index)
4329 init_nat_k (&kv, *address, rp->addr_only ? 0 : rp->e_port,
4330 sm->outside_fib_index, rp->addr_only ? 0 : rp->proto);
4331 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
4334 m = pool_elt_at_index (sm->static_mappings, value.value);
4338 /* Don't trip over lease renewal, static config */
4348 /* Indetity mapping? */
4349 if (rp->l_addr.as_u32 == 0)
4350 l_addr.as_u32 = address[0].as_u32;
4352 l_addr.as_u32 = rp->l_addr.as_u32;
4353 /* Add the static mapping */
4354 rv = snat_add_static_mapping (l_addr,
4359 rp->addr_only, ~0 /* sw_if_index */ ,
4360 rp->proto, !is_delete, rp->twice_nat,
4361 rp->out2in_only, rp->tag, rp->identity_nat);
4363 nat_elog_notice_X1 ("snat_add_static_mapping returned %d", "i4", rv);
4367 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
4370 ip4_address_t * address,
4372 u32 if_address_index, u32 is_delete)
4374 snat_main_t *sm = &snat_main;
4375 snat_static_map_resolve_t *rp;
4376 ip4_address_t l_addr;
4380 snat_address_t *addresses = sm->addresses;
4382 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices); i++)
4384 if (sw_if_index == sm->auto_add_sw_if_indices[i])
4388 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices_twice_nat); i++)
4391 addresses = sm->twice_nat_addresses;
4392 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
4401 /* Don't trip over lease renewal, static config */
4402 for (j = 0; j < vec_len (addresses); j++)
4403 if (addresses[j].addr.as_u32 == address->as_u32)
4406 (void) snat_add_address (sm, address, ~0, twice_nat);
4407 /* Scan static map resolution vector */
4408 for (j = 0; j < vec_len (sm->to_resolve); j++)
4410 rp = sm->to_resolve + j;
4413 /* On this interface? */
4414 if (rp->sw_if_index == sw_if_index)
4416 /* Indetity mapping? */
4417 if (rp->l_addr.as_u32 == 0)
4418 l_addr.as_u32 = address[0].as_u32;
4420 l_addr.as_u32 = rp->l_addr.as_u32;
4421 /* Add the static mapping */
4422 rv = snat_add_static_mapping (l_addr,
4428 ~0 /* sw_if_index */ ,
4430 rp->is_add, rp->twice_nat,
4431 rp->out2in_only, rp->tag,
4434 nat_elog_notice_X1 ("snat_add_static_mapping returned %d",
4442 (void) snat_del_address (sm, address[0], 1, twice_nat);
4449 snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
4452 ip4_main_t *ip4_main = sm->ip4_main;
4453 ip4_address_t *first_int_addr;
4454 snat_static_map_resolve_t *rp;
4455 u32 *indices_to_delete = 0;
4457 u32 *auto_add_sw_if_indices =
4459 auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
4461 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0 /* just want the address */
4464 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
4466 if (auto_add_sw_if_indices[i] == sw_if_index)
4470 /* if have address remove it */
4472 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
4475 for (j = 0; j < vec_len (sm->to_resolve); j++)
4477 rp = sm->to_resolve + j;
4478 if (rp->sw_if_index == sw_if_index)
4479 vec_add1 (indices_to_delete, j);
4481 if (vec_len (indices_to_delete))
4483 for (j = vec_len (indices_to_delete) - 1; j >= 0; j--)
4484 vec_del1 (sm->to_resolve, j);
4485 vec_free (indices_to_delete);
4489 vec_del1 (sm->auto_add_sw_if_indices_twice_nat, i);
4491 vec_del1 (sm->auto_add_sw_if_indices, i);
4494 return VNET_API_ERROR_VALUE_EXIST;
4501 return VNET_API_ERROR_NO_SUCH_ENTRY;
4503 /* add to the auto-address list */
4505 vec_add1 (sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
4507 vec_add1 (sm->auto_add_sw_if_indices, sw_if_index);
4509 /* If the address is already bound - or static - add it now */
4511 (void) snat_add_address (sm, first_int_addr, ~0, twice_nat);
4517 nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4518 nat_protocol_t proto, u32 vrf_id, int is_in)
4520 snat_main_per_thread_data_t *tsm;
4521 clib_bihash_kv_8_8_t kv, value;
4523 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4525 clib_bihash_8_8_t *t;
4527 if (sm->endpoint_dependent)
4528 return VNET_API_ERROR_UNSUPPORTED;
4530 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4531 if (sm->num_workers > 1)
4533 vec_elt_at_index (sm->per_thread_data,
4534 sm->worker_in2out_cb (&ip, fib_index, 0));
4536 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4538 init_nat_k (&kv, *addr, port, fib_index, proto);
4539 t = is_in ? &tsm->in2out : &tsm->out2in;
4540 if (!clib_bihash_search_8_8 (t, &kv, &value))
4542 if (pool_is_free_index (tsm->sessions, value.value))
4543 return VNET_API_ERROR_UNSPECIFIED;
4545 s = pool_elt_at_index (tsm->sessions, value.value);
4546 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4547 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
4551 return VNET_API_ERROR_NO_SUCH_ENTRY;
4555 nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
4556 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
4557 u32 vrf_id, int is_in)
4560 clib_bihash_16_8_t *t;
4561 clib_bihash_kv_16_8_t kv, value;
4562 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
4564 snat_main_per_thread_data_t *tsm;
4566 if (!sm->endpoint_dependent)
4567 return VNET_API_ERROR_FEATURE_DISABLED;
4569 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
4570 if (sm->num_workers > 1)
4572 vec_elt_at_index (sm->per_thread_data,
4573 sm->worker_in2out_cb (&ip, fib_index, 0));
4575 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4577 t = is_in ? &tsm->in2out_ed : &sm->out2in_ed;
4578 init_ed_k (&kv, *addr, port, *eh_addr, eh_port, fib_index, proto);
4579 if (clib_bihash_search_16_8 (t, &kv, &value))
4581 return VNET_API_ERROR_NO_SUCH_ENTRY;
4584 if (pool_is_free_index (tsm->sessions, value.value))
4585 return VNET_API_ERROR_UNSPECIFIED;
4586 s = pool_elt_at_index (tsm->sessions, value.value);
4587 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
4588 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
4593 nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset, u16 psid_length)
4595 snat_main_t *sm = &snat_main;
4597 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_MAPE;
4598 sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
4600 sm->psid_offset = psid_offset;
4601 sm->psid_length = psid_length;
4605 nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port)
4607 snat_main_t *sm = &snat_main;
4609 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_RANGE;
4610 sm->alloc_addr_and_port = nat_alloc_addr_and_port_range;
4611 sm->start_port = start_port;
4612 sm->end_port = end_port;
4616 nat_set_alloc_addr_and_port_default (void)
4618 snat_main_t *sm = &snat_main;
4620 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
4621 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
4624 VLIB_NODE_FN (nat_default_node) (vlib_main_t * vm,
4625 vlib_node_runtime_t * node,
4626 vlib_frame_t * frame)
4632 VLIB_REGISTER_NODE (nat_default_node) = {
4633 .name = "nat-default",
4634 .vector_size = sizeof (u32),
4636 .type = VLIB_NODE_TYPE_INTERNAL,
4638 .n_next_nodes = NAT_N_NEXT,
4640 [NAT_NEXT_DROP] = "error-drop",
4641 [NAT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
4642 [NAT_NEXT_IN2OUT_ED_FAST_PATH] = "nat44-ed-in2out",
4643 [NAT_NEXT_IN2OUT_ED_SLOW_PATH] = "nat44-ed-in2out-slowpath",
4644 [NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH] = "nat44-ed-in2out-output-slowpath",
4645 [NAT_NEXT_OUT2IN_ED_FAST_PATH] = "nat44-ed-out2in",
4646 [NAT_NEXT_OUT2IN_ED_SLOW_PATH] = "nat44-ed-out2in-slowpath",
4647 [NAT_NEXT_IN2OUT_CLASSIFY] = "nat44-in2out-worker-handoff",
4648 [NAT_NEXT_OUT2IN_CLASSIFY] = "nat44-out2in-worker-handoff",
4654 * fd.io coding-style-patch-verification: ON
4657 * eval: (c-set-style "gnu")