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 <vpp/app/version.h>
20 #include <vnet/vnet.h>
21 #include <vnet/ip/ip.h>
22 #include <vnet/ip/ip4.h>
23 #include <vnet/ip/ip_table.h>
24 #include <vnet/ip/reass/ip4_sv_reass.h>
25 #include <vnet/fib/fib_table.h>
26 #include <vnet/fib/ip4_fib.h>
27 #include <vnet/plugin/plugin.h>
28 #include <vppinfra/bihash_16_8.h>
30 #include <nat/lib/log.h>
31 #include <nat/lib/nat_syslog.h>
32 #include <nat/lib/nat_inlines.h>
33 #include <nat/lib/ipfix_logging.h>
35 #include <nat/nat44-ed/nat44_ed.h>
36 #include <nat/nat44-ed/nat44_ed_affinity.h>
37 #include <nat/nat44-ed/nat44_ed_inlines.h>
39 snat_main_t snat_main;
41 static_always_inline void nat_validate_interface_counters (snat_main_t *sm,
44 #define skip_if_disabled() \
47 snat_main_t *sm = &snat_main; \
48 if (PREDICT_FALSE (!sm->enabled)) \
53 #define fail_if_enabled() \
56 snat_main_t *sm = &snat_main; \
57 if (PREDICT_FALSE (sm->enabled)) \
59 nat_log_err ("plugin enabled"); \
65 #define fail_if_disabled() \
68 snat_main_t *sm = &snat_main; \
69 if (PREDICT_FALSE (!sm->enabled)) \
71 nat_log_err ("plugin disabled"); \
78 /* Hook up input features */
79 VNET_FEATURE_INIT (nat_pre_in2out, static) = {
80 .arc_name = "ip4-unicast",
81 .node_name = "nat-pre-in2out",
82 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
83 "ip4-sv-reassembly-feature"),
85 VNET_FEATURE_INIT (nat_pre_out2in, static) = {
86 .arc_name = "ip4-unicast",
87 .node_name = "nat-pre-out2in",
88 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
89 "ip4-dhcp-client-detect",
90 "ip4-sv-reassembly-feature"),
92 VNET_FEATURE_INIT (snat_in2out_worker_handoff, static) = {
93 .arc_name = "ip4-unicast",
94 .node_name = "nat44-in2out-worker-handoff",
95 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
97 VNET_FEATURE_INIT (snat_out2in_worker_handoff, static) = {
98 .arc_name = "ip4-unicast",
99 .node_name = "nat44-out2in-worker-handoff",
100 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
101 "ip4-dhcp-client-detect"),
103 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
104 .arc_name = "ip4-unicast",
105 .node_name = "nat44-in2out",
106 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
108 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
109 .arc_name = "ip4-unicast",
110 .node_name = "nat44-out2in",
111 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
112 "ip4-dhcp-client-detect"),
114 VNET_FEATURE_INIT (ip4_nat44_ed_in2out, static) = {
115 .arc_name = "ip4-unicast",
116 .node_name = "nat44-ed-in2out",
117 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
119 VNET_FEATURE_INIT (ip4_nat44_ed_out2in, static) = {
120 .arc_name = "ip4-unicast",
121 .node_name = "nat44-ed-out2in",
122 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
123 "ip4-dhcp-client-detect"),
125 VNET_FEATURE_INIT (ip4_nat44_ed_classify, static) = {
126 .arc_name = "ip4-unicast",
127 .node_name = "nat44-ed-classify",
128 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
130 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
131 .arc_name = "ip4-unicast",
132 .node_name = "nat44-handoff-classify",
133 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
135 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
136 .arc_name = "ip4-unicast",
137 .node_name = "nat44-in2out-fast",
138 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
140 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
141 .arc_name = "ip4-unicast",
142 .node_name = "nat44-out2in-fast",
143 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
144 "ip4-dhcp-client-detect"),
147 /* Hook up output features */
148 VNET_FEATURE_INIT (ip4_snat_in2out_output, static) = {
149 .arc_name = "ip4-output",
150 .node_name = "nat44-in2out-output",
151 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
153 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
154 .arc_name = "ip4-output",
155 .node_name = "nat44-in2out-output-worker-handoff",
156 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa","ip4-sv-reassembly-output-feature"),
158 VNET_FEATURE_INIT (nat_pre_in2out_output, static) = {
159 .arc_name = "ip4-output",
160 .node_name = "nat-pre-in2out-output",
161 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
162 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
164 VNET_FEATURE_INIT (ip4_nat44_ed_in2out_output, static) = {
165 .arc_name = "ip4-output",
166 .node_name = "nat44-ed-in2out-output",
167 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
168 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
171 VLIB_PLUGIN_REGISTER () = {
172 .version = VPP_BUILD_VER,
173 .description = "Network Address Translation (NAT)",
177 static void nat44_ed_db_init (u32 translations, u32 translation_buckets);
179 static void nat44_ed_db_free ();
182 nat44_ed_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip,
183 u32 rx_fib_index, u8 is_output);
186 nat44_ed_get_worker_in2out_cb (ip4_header_t * ip, u32 rx_fib_index,
189 u32 nat_calc_bihash_buckets (u32 n_elts);
192 format_session_kvp (u8 * s, va_list * args)
194 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
196 s = format (s, "%U thread-index %llu session-index %llu", format_snat_key,
197 v->key, nat_value_get_thread_index (v),
198 nat_value_get_session_index (v));
204 format_static_mapping_kvp (u8 * s, va_list * args)
206 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
208 s = format (s, "%U static-mapping-index %llu",
209 format_snat_key, v->key, v->value);
215 format_ed_session_kvp (u8 * s, va_list * args)
217 clib_bihash_kv_16_8_t *v = va_arg (*args, clib_bihash_kv_16_8_t *);
221 ip4_address_t l_addr, r_addr;
224 split_ed_kv (v, &l_addr, &r_addr, &proto, &fib_index, &l_port, &r_port);
226 "local %U:%d remote %U:%d proto %U fib %d thread-index %u "
228 format_ip4_address, &l_addr, clib_net_to_host_u16 (l_port),
229 format_ip4_address, &r_addr, clib_net_to_host_u16 (r_port),
230 format_ip_protocol, proto, fib_index,
231 ed_value_get_thread_index (v), ed_value_get_session_index (v));
237 nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index,
240 per_vrf_sessions_unregister_session (s, thread_index);
242 if (nat_ed_ses_i2o_flow_hash_add_del (sm, thread_index, s, 0))
243 nat_elog_warn (sm, "flow hash del failed");
245 if (nat_ed_ses_o2i_flow_hash_add_del (sm, thread_index, s, 0))
246 nat_elog_warn (sm, "flow hash del failed");
248 if (is_fwd_bypass_session (s))
253 if (is_affinity_sessions (s))
254 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
255 s->nat_proto, s->out2in.port);
258 nat_syslog_nat44_sdel (
259 0, s->in2out.fib_index, &s->in2out.addr, s->in2out.port,
260 &s->ext_host_nat_addr, s->ext_host_nat_port, &s->out2in.addr,
261 s->out2in.port, &s->ext_host_addr, s->ext_host_port, s->nat_proto,
262 is_twice_nat_session (s));
264 if (snat_is_unk_proto_session (s))
270 nat_ipfix_logging_nat44_ses_delete (thread_index,
271 s->in2out.addr.as_u32,
272 s->out2in.addr.as_u32,
276 s->in2out.fib_index);
279 /* Twice NAT address and port for external host */
280 if (is_twice_nat_session (s))
282 snat_free_outside_address_and_port (sm->twice_nat_addresses,
284 &s->ext_host_nat_addr,
285 s->ext_host_nat_port, s->nat_proto);
288 if (snat_is_session_static (s))
291 snat_free_outside_address_and_port (sm->addresses, thread_index,
292 &s->out2in.addr, s->out2in.port,
297 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
300 snat_main_t *sm = &snat_main;
301 fib_prefix_t prefix = {
303 .fp_proto = FIB_PROTOCOL_IP4,
305 .ip4.as_u32 = addr->as_u32,
308 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
311 fib_table_entry_update_one_path (fib_index,
314 (FIB_ENTRY_FLAG_CONNECTED |
315 FIB_ENTRY_FLAG_LOCAL |
316 FIB_ENTRY_FLAG_EXCLUSIVE),
320 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
322 fib_table_entry_delete (fib_index, &prefix, sm->fib_src_low);
326 snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
331 vlib_thread_main_t *tm = vlib_get_thread_main ();
333 /* Check if address already exists */
335 vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
337 if (ap->addr.as_u32 == addr->as_u32)
339 nat_log_err ("address exist");
340 return VNET_API_ERROR_VALUE_EXIST;
346 vec_add2 (sm->twice_nat_addresses, ap, 1);
348 vec_add2 (sm->addresses, ap, 1);
353 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
359 #define _(N, i, n, s) \
360 clib_memset(ap->busy_##n##_port_refcounts, 0, sizeof(ap->busy_##n##_port_refcounts));\
361 ap->busy_##n##_ports = 0; \
362 ap->busy_##n##_ports_per_thread = 0;\
363 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
371 /* Add external address to FIB */
373 pool_foreach (i, sm->interfaces)
375 if (nat_interface_is_inside (i))
378 snat_add_del_addr_to_fib (addr, 32, i->sw_if_index, 1);
381 pool_foreach (i, sm->output_feature_interfaces)
383 if (nat_interface_is_inside (i))
386 snat_add_del_addr_to_fib (addr, 32, i->sw_if_index, 1);
395 is_snat_address_used_in_static_mapping (snat_main_t * sm, ip4_address_t addr)
397 snat_static_mapping_t *m;
399 pool_foreach (m, sm->static_mappings)
401 if (is_addr_only_static_mapping (m) ||
402 is_out2in_only_static_mapping (m) ||
403 is_identity_static_mapping (m))
405 if (m->external_addr.as_u32 == addr.as_u32)
414 snat_add_static_mapping_when_resolved (snat_main_t *sm, ip4_address_t l_addr,
415 u16 l_port, u32 sw_if_index, u16 e_port,
416 u32 vrf_id, nat_protocol_t proto,
417 int addr_only, u8 *tag, int twice_nat,
418 int out2in_only, int identity_nat,
419 ip4_address_t pool_addr, int exact)
421 snat_static_map_resolve_t *rp;
423 vec_add2 (sm->to_resolve, rp, 1);
424 rp->l_addr.as_u32 = l_addr.as_u32;
426 rp->sw_if_index = sw_if_index;
430 rp->addr_only = addr_only;
431 rp->twice_nat = twice_nat;
432 rp->out2in_only = out2in_only;
433 rp->identity_nat = identity_nat;
434 rp->tag = vec_dup (tag);
435 rp->pool_addr = pool_addr;
440 get_thread_idx_by_port (u16 e_port)
442 snat_main_t *sm = &snat_main;
443 u32 thread_idx = sm->num_workers;
444 if (sm->num_workers > 1)
447 sm->first_worker_index +
448 sm->workers[(e_port - 1024) / sm->port_per_thread];
454 nat_ed_static_mapping_del_sessions (snat_main_t * sm,
455 snat_main_per_thread_data_t * tsm,
456 ip4_address_t l_addr,
459 u32 fib_index, int addr_only,
460 ip4_address_t e_addr, u16 e_port)
463 u32 *indexes_to_free = NULL;
465 pool_foreach (s, tsm->sessions) {
466 if (s->in2out.fib_index != fib_index ||
467 s->in2out.addr.as_u32 != l_addr.as_u32)
473 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
474 s->out2in.port != e_port ||
475 s->in2out.port != l_port ||
476 s->nat_proto != protocol)
480 if (is_lb_session (s))
482 if (!snat_is_session_static (s))
484 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
485 vec_add1 (indexes_to_free, s - tsm->sessions);
491 vec_foreach (ses_index, indexes_to_free)
493 s = pool_elt_at_index (tsm->sessions, *ses_index);
494 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
496 vec_free (indexes_to_free);
500 snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
501 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
502 u32 sw_if_index, nat_protocol_t proto, int is_add,
503 twice_nat_type_t twice_nat, u8 out2in_only, u8 *tag,
504 u8 identity_nat, ip4_address_t pool_addr, int exact)
506 snat_main_t *sm = &snat_main;
507 snat_static_mapping_t *m;
508 clib_bihash_kv_8_8_t kv, value;
509 snat_address_t *a = 0;
511 snat_interface_t *interface;
512 snat_main_per_thread_data_t *tsm;
513 snat_static_map_resolve_t *rp, *rp_match = 0;
514 nat44_lb_addr_port_t *local;
518 /* If the external address is a specific interface address */
519 if (sw_if_index != ~0)
521 ip4_address_t *first_int_addr;
523 for (i = 0; i < vec_len (sm->to_resolve); i++)
525 rp = sm->to_resolve + i;
526 if (rp->sw_if_index != sw_if_index ||
527 rp->l_addr.as_u32 != l_addr.as_u32 ||
528 rp->vrf_id != vrf_id || rp->addr_only != addr_only)
533 if ((rp->l_port != l_port && rp->e_port != e_port)
534 || rp->proto != proto)
542 /* Might be already set... */
543 first_int_addr = ip4_interface_first_address
544 (sm->ip4_main, sw_if_index, 0 /* just want the address */ );
549 return VNET_API_ERROR_VALUE_EXIST;
551 snat_add_static_mapping_when_resolved (
552 sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto, addr_only,
553 tag, twice_nat, out2in_only, identity_nat, pool_addr, exact);
555 /* DHCP resolution required? */
556 if (first_int_addr == 0)
562 e_addr.as_u32 = first_int_addr->as_u32;
563 /* Identity mapping? */
564 if (l_addr.as_u32 == 0)
565 l_addr.as_u32 = e_addr.as_u32;
571 return VNET_API_ERROR_NO_SUCH_ENTRY;
573 vec_del1 (sm->to_resolve, i);
577 e_addr.as_u32 = first_int_addr->as_u32;
578 /* Identity mapping? */
579 if (l_addr.as_u32 == 0)
580 l_addr.as_u32 = e_addr.as_u32;
587 init_nat_k (&kv, e_addr, addr_only ? 0 : e_port, 0, addr_only ? 0 : proto);
588 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
591 m = pool_elt_at_index (sm->static_mappings, value.value);
597 if (is_identity_static_mapping (m))
600 pool_foreach (local, m->locals)
602 if (local->vrf_id == vrf_id)
603 return VNET_API_ERROR_VALUE_EXIST;
606 pool_get (m->locals, local);
607 local->vrf_id = vrf_id;
609 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
611 init_nat_kv (&kv, m->local_addr, m->local_port, local->fib_index,
612 m->proto, 0, m - sm->static_mappings);
613 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
617 return VNET_API_ERROR_VALUE_EXIST;
620 if (twice_nat && addr_only)
621 return VNET_API_ERROR_UNSUPPORTED;
623 /* Convert VRF id to FIB index */
626 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
628 /* If not specified use inside VRF id from SNAT plugin startup config */
631 fib_index = sm->inside_fib_index;
632 vrf_id = sm->inside_vrf_id;
633 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
636 if (!(out2in_only || identity_nat))
638 init_nat_k (&kv, l_addr, addr_only ? 0 : l_port, fib_index,
639 addr_only ? 0 : proto);
640 if (!clib_bihash_search_8_8
641 (&sm->static_mapping_by_local, &kv, &value))
642 return VNET_API_ERROR_VALUE_EXIST;
645 /* Find external address in allocated addresses and reserve port for
646 address and port pair mapping when dynamic translations enabled */
647 if (!(addr_only || sm->static_mapping_only || out2in_only))
649 for (i = 0; i < vec_len (sm->addresses); i++)
651 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
653 a = sm->addresses + i;
654 /* External port must be unused */
657 #define _(N, j, n, s) \
658 case NAT_PROTOCOL_##N: \
659 if (a->busy_##n##_port_refcounts[e_port]) \
660 return VNET_API_ERROR_INVALID_VALUE; \
661 ++a->busy_##n##_port_refcounts[e_port]; \
664 a->busy_##n##_ports++; \
665 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
670 default : nat_elog_info (sm, "unknown protocol");
671 return VNET_API_ERROR_INVALID_VALUE_2;
676 /* External address must be allocated */
677 if (!a && (l_addr.as_u32 != e_addr.as_u32))
679 if (sw_if_index != ~0)
681 for (i = 0; i < vec_len (sm->to_resolve); i++)
683 rp = sm->to_resolve + i;
686 if (rp->sw_if_index != sw_if_index &&
687 rp->l_addr.as_u32 != l_addr.as_u32 &&
688 rp->vrf_id != vrf_id && rp->l_port != l_port &&
689 rp->e_port != e_port && rp->proto != proto)
692 vec_del1 (sm->to_resolve, i);
696 return VNET_API_ERROR_NO_SUCH_ENTRY;
700 pool_get (sm->static_mappings, m);
701 clib_memset (m, 0, sizeof (*m));
702 m->tag = vec_dup (tag);
703 m->local_addr = l_addr;
704 m->external_addr = e_addr;
705 m->twice_nat = twice_nat;
707 if (twice_nat == TWICE_NAT && exact)
709 m->flags |= NAT_STATIC_MAPPING_FLAG_EXACT_ADDRESS;
710 m->pool_addr = pool_addr;
714 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
716 m->flags |= NAT_STATIC_MAPPING_FLAG_ADDR_ONLY;
719 m->flags |= NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT;
720 pool_get (m->locals, local);
721 local->vrf_id = vrf_id;
722 local->fib_index = fib_index;
727 m->fib_index = fib_index;
731 m->local_port = l_port;
732 m->external_port = e_port;
736 if (sm->num_workers > 1)
739 .src_address = m->local_addr,
741 vec_add1 (m->workers, sm->worker_in2out_cb (&ip, m->fib_index, 0));
742 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
745 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
749 init_nat_kv (&kv, m->local_addr, m->local_port, fib_index, m->proto,
750 0, m - sm->static_mappings);
751 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
754 init_nat_kv (&kv, m->external_addr, m->external_port, 0, m->proto, 0,
755 m - sm->static_mappings);
756 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1);
762 if (sw_if_index != ~0)
765 return VNET_API_ERROR_NO_SUCH_ENTRY;
771 vrf_id = sm->inside_vrf_id;
774 pool_foreach (local, m->locals)
776 if (local->vrf_id == vrf_id)
777 find = local - m->locals;
781 return VNET_API_ERROR_NO_SUCH_ENTRY;
783 local = pool_elt_at_index (m->locals, find);
784 fib_index = local->fib_index;
785 pool_put (m->locals, local);
788 fib_index = m->fib_index;
790 /* Free external address port */
791 if (!(addr_only || sm->static_mapping_only || out2in_only))
793 for (i = 0; i < vec_len (sm->addresses); i++)
795 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
797 a = sm->addresses + i;
800 #define _(N, j, n, s) \
801 case NAT_PROTOCOL_##N: \
802 --a->busy_##n##_port_refcounts[e_port]; \
805 a->busy_##n##_ports--; \
806 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
811 default : nat_elog_info (sm, "unknown protocol");
812 return VNET_API_ERROR_INVALID_VALUE_2;
819 if (sm->num_workers > 1)
820 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
822 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
824 init_nat_k (&kv, m->local_addr, m->local_port, fib_index, m->proto);
826 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0);
828 /* Delete session(s) for static mapping if exist */
829 if (!(sm->static_mapping_only) ||
830 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
832 nat_ed_static_mapping_del_sessions (
833 sm, tsm, m->local_addr, m->local_port, m->proto, fib_index,
834 addr_only, e_addr, e_port);
837 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
838 if (pool_elts (m->locals))
841 init_nat_k (&kv, m->external_addr, m->external_port, 0, m->proto);
842 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0);
845 vec_free (m->workers);
846 /* Delete static mapping from pool */
847 pool_put (sm->static_mappings, m);
850 if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
853 /* Add/delete external address to FIB */
855 pool_foreach (interface, sm->interfaces)
857 if (nat_interface_is_inside (interface))
860 snat_add_del_addr_to_fib (&e_addr, 32, interface->sw_if_index, is_add);
863 pool_foreach (interface, sm->output_feature_interfaces)
865 if (nat_interface_is_inside (interface))
868 snat_add_del_addr_to_fib (&e_addr, 32, interface->sw_if_index, is_add);
877 nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
878 nat_protocol_t proto,
879 nat44_lb_addr_port_t * locals, u8 is_add,
880 twice_nat_type_t twice_nat, u8 out2in_only,
881 u8 * tag, u32 affinity)
883 snat_main_t *sm = &snat_main;
884 snat_static_mapping_t *m;
885 clib_bihash_kv_8_8_t kv, value;
886 snat_address_t *a = 0;
888 nat44_lb_addr_port_t *local;
889 snat_main_per_thread_data_t *tsm;
893 init_nat_k (&kv, e_addr, e_port, 0, proto);
894 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
897 m = pool_elt_at_index (sm->static_mappings, value.value);
902 return VNET_API_ERROR_VALUE_EXIST;
904 if (vec_len (locals) < 2)
905 return VNET_API_ERROR_INVALID_VALUE;
907 /* Find external address in allocated addresses and reserve port for
908 address and port pair mapping when dynamic translations enabled */
909 if (!(sm->static_mapping_only || out2in_only))
911 for (i = 0; i < vec_len (sm->addresses); i++)
913 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
915 a = sm->addresses + i;
916 /* External port must be unused */
919 #define _(N, j, n, s) \
920 case NAT_PROTOCOL_##N: \
921 if (a->busy_##n##_port_refcounts[e_port]) \
922 return VNET_API_ERROR_INVALID_VALUE; \
923 ++a->busy_##n##_port_refcounts[e_port]; \
926 a->busy_##n##_ports++; \
927 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
932 default : nat_elog_info (sm, "unknown protocol");
933 return VNET_API_ERROR_INVALID_VALUE_2;
938 /* External address must be allocated */
940 return VNET_API_ERROR_NO_SUCH_ENTRY;
943 pool_get (sm->static_mappings, m);
944 clib_memset (m, 0, sizeof (*m));
945 m->tag = vec_dup (tag);
946 m->external_addr = e_addr;
947 m->external_port = e_port;
949 m->twice_nat = twice_nat;
950 m->flags |= NAT_STATIC_MAPPING_FLAG_LB;
952 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
953 m->affinity = affinity;
956 m->affinity_per_service_list_head_index =
957 nat_affinity_get_per_service_list_head_index ();
959 m->affinity_per_service_list_head_index = ~0;
961 init_nat_kv (&kv, m->external_addr, m->external_port, 0, m->proto, 0,
962 m - sm->static_mappings);
963 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1))
965 nat_elog_err (sm, "static_mapping_by_external key add failed");
966 return VNET_API_ERROR_UNSPECIFIED;
969 for (i = 0; i < vec_len (locals); i++)
971 locals[i].fib_index =
972 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
977 init_nat_kv (&kv, locals[i].addr, locals[i].port,
978 locals[i].fib_index, m->proto, 0,
979 m - sm->static_mappings);
980 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
982 locals[i].prefix = (i == 0) ? locals[i].probability :
983 (locals[i - 1].prefix + locals[i].probability);
984 pool_get (m->locals, local);
986 if (sm->num_workers > 1)
989 .src_address = locals[i].addr,
992 clib_bitmap_set (bitmap,
993 sm->worker_in2out_cb (&ip, m->fib_index, 0),
999 if (sm->num_workers > 1)
1002 clib_bitmap_foreach (i, bitmap)
1004 vec_add1(m->workers, i);
1012 return VNET_API_ERROR_NO_SUCH_ENTRY;
1014 if (!is_lb_static_mapping (m))
1015 return VNET_API_ERROR_INVALID_VALUE;
1017 /* Free external address port */
1018 if (!(sm->static_mapping_only || out2in_only))
1020 for (i = 0; i < vec_len (sm->addresses); i++)
1022 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1024 a = sm->addresses + i;
1027 #define _(N, j, n, s) \
1028 case NAT_PROTOCOL_##N: \
1029 --a->busy_##n##_port_refcounts[e_port]; \
1030 if (e_port > 1024) \
1032 a->busy_##n##_ports--; \
1033 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1036 foreach_nat_protocol
1038 default : nat_elog_info (sm, "unknown protocol");
1039 return VNET_API_ERROR_INVALID_VALUE_2;
1046 init_nat_k (&kv, m->external_addr, m->external_port, 0, m->proto);
1047 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0))
1049 nat_elog_err (sm, "static_mapping_by_external key del failed");
1050 return VNET_API_ERROR_UNSPECIFIED;
1054 pool_foreach (local, m->locals)
1056 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4,
1060 init_nat_k(& kv, local->addr, local->port, local->fib_index, m->proto);
1061 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1063 nat_elog_err (sm, "static_mapping_by_local key del failed");
1064 return VNET_API_ERROR_UNSPECIFIED;
1068 if (sm->num_workers > 1)
1071 .src_address = local->addr,
1074 vec_elt_at_index (sm->per_thread_data,
1075 sm->worker_in2out_cb (&ip, m->fib_index, 0));
1078 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1080 /* Delete sessions */
1081 pool_foreach (s, tsm->sessions)
1083 if (!(is_lb_session (s)))
1086 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1087 s->in2out.port != local->port)
1090 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1091 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
1096 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1097 pool_free (m->locals);
1099 vec_free (m->workers);
1101 pool_put (sm->static_mappings, m);
1108 nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1109 ip4_address_t l_addr, u16 l_port,
1110 nat_protocol_t proto, u32 vrf_id,
1111 u8 probability, u8 is_add)
1113 snat_main_t *sm = &snat_main;
1114 snat_static_mapping_t *m = 0;
1115 clib_bihash_kv_8_8_t kv, value;
1116 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1117 snat_main_per_thread_data_t *tsm;
1123 init_nat_k (&kv, e_addr, e_port, 0, proto);
1124 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1125 m = pool_elt_at_index (sm->static_mappings, value.value);
1128 return VNET_API_ERROR_NO_SUCH_ENTRY;
1130 if (!is_lb_static_mapping (m))
1131 return VNET_API_ERROR_INVALID_VALUE;
1134 pool_foreach (local, m->locals)
1136 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1137 (local->vrf_id == vrf_id))
1139 match_local = local;
1148 return VNET_API_ERROR_VALUE_EXIST;
1150 pool_get (m->locals, local);
1151 clib_memset (local, 0, sizeof (*local));
1152 local->addr.as_u32 = l_addr.as_u32;
1153 local->port = l_port;
1154 local->probability = probability;
1155 local->vrf_id = vrf_id;
1157 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1160 if (!is_out2in_only_static_mapping (m))
1162 init_nat_kv (&kv, l_addr, l_port, local->fib_index, proto, 0,
1163 m - sm->static_mappings);
1164 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1))
1165 nat_elog_err (sm, "static_mapping_by_local key add failed");
1171 return VNET_API_ERROR_NO_SUCH_ENTRY;
1173 if (pool_elts (m->locals) < 3)
1174 return VNET_API_ERROR_UNSPECIFIED;
1176 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1179 if (!is_out2in_only_static_mapping (m))
1181 init_nat_k (&kv, l_addr, l_port, match_local->fib_index, proto);
1182 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0))
1183 nat_elog_err (sm, "static_mapping_by_local key del failed");
1186 if (sm->num_workers > 1)
1189 .src_address = local->addr,
1191 tsm = vec_elt_at_index (sm->per_thread_data,
1192 sm->worker_in2out_cb (&ip, m->fib_index,
1196 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1198 /* Delete sessions */
1200 pool_foreach (s, tsm->sessions) {
1201 if (!(is_lb_session (s)))
1204 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1205 s->in2out.port != match_local->port)
1208 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1209 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
1213 pool_put (m->locals, match_local);
1216 vec_free (m->workers);
1219 pool_foreach (local, m->locals)
1221 vec_add1 (locals, local - m->locals);
1222 if (sm->num_workers > 1)
1225 ip.src_address.as_u32 = local->addr.as_u32,
1226 bitmap = clib_bitmap_set (bitmap,
1227 sm->worker_in2out_cb (&ip, local->fib_index, 0),
1233 ASSERT (vec_len (locals) > 1);
1235 local = pool_elt_at_index (m->locals, locals[0]);
1236 local->prefix = local->probability;
1237 for (i = 1; i < vec_len (locals); i++)
1239 local = pool_elt_at_index (m->locals, locals[i]);
1240 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1241 local->prefix = local->probability + prev_local->prefix;
1244 /* Assign workers */
1245 if (sm->num_workers > 1)
1248 clib_bitmap_foreach (i, bitmap) { vec_add1(m->workers, i); }
1256 snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1259 snat_address_t *a = 0;
1260 snat_session_t *ses;
1261 u32 *ses_to_be_removed = 0, *ses_index;
1262 snat_main_per_thread_data_t *tsm;
1263 snat_static_mapping_t *m;
1264 snat_interface_t *interface;
1266 snat_address_t *addresses =
1267 twice_nat ? sm->twice_nat_addresses : sm->addresses;
1269 /* Find SNAT address */
1270 for (i = 0; i < vec_len (addresses); i++)
1272 if (addresses[i].addr.as_u32 == addr.as_u32)
1280 nat_log_err ("no such address");
1281 return VNET_API_ERROR_NO_SUCH_ENTRY;
1286 ip4_address_t pool_addr = { 0 };
1288 pool_foreach (m, sm->static_mappings)
1290 if (m->external_addr.as_u32 == addr.as_u32)
1291 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1292 m->local_port, m->external_port,
1294 is_addr_only_static_mapping(m), ~0,
1295 m->proto, 0 /* is_add */,
1297 is_out2in_only_static_mapping(m),
1299 is_identity_static_mapping(m),
1306 /* Check if address is used in some static mapping */
1307 if (is_snat_address_used_in_static_mapping (sm, addr))
1309 nat_log_err ("address used in static mapping");
1310 return VNET_API_ERROR_UNSPECIFIED;
1314 if (a->fib_index != ~0)
1315 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
1317 /* Delete sessions using address */
1318 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1320 vec_foreach (tsm, sm->per_thread_data)
1322 pool_foreach (ses, tsm->sessions) {
1323 if (ses->out2in.addr.as_u32 == addr.as_u32)
1325 nat_free_session_data (sm, ses, tsm - sm->per_thread_data, 0);
1326 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1330 vec_foreach (ses_index, ses_to_be_removed)
1332 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1333 nat_ed_session_delete (sm, ses, tsm - sm->per_thread_data, 1);
1336 vec_free (ses_to_be_removed);
1340 #define _(N, i, n, s) \
1341 vec_free (a->busy_##n##_ports_per_thread);
1342 foreach_nat_protocol
1347 vec_del1 (sm->twice_nat_addresses, i);
1350 else vec_del1 (sm->addresses, i);
1352 /* Delete external address from FIB */
1353 pool_foreach (interface, sm->interfaces)
1355 if (nat_interface_is_inside (interface))
1358 snat_add_del_addr_to_fib (&addr, 32, interface->sw_if_index, 0);
1361 pool_foreach (interface, sm->output_feature_interfaces)
1363 if (nat_interface_is_inside (interface))
1366 snat_add_del_addr_to_fib (&addr, 32, interface->sw_if_index, 0);
1374 expire_per_vrf_sessions (u32 fib_index)
1376 per_vrf_sessions_t *per_vrf_sessions;
1377 snat_main_per_thread_data_t *tsm;
1378 snat_main_t *sm = &snat_main;
1381 vec_foreach (tsm, sm->per_thread_data)
1383 vec_foreach (per_vrf_sessions, tsm->per_vrf_sessions_vec)
1385 if ((per_vrf_sessions->rx_fib_index == fib_index) ||
1386 (per_vrf_sessions->tx_fib_index == fib_index))
1388 per_vrf_sessions->expired = 1;
1396 update_per_vrf_sessions_vec (u32 fib_index, int is_del)
1398 snat_main_t *sm = &snat_main;
1401 // we don't care if it is outside/inside fib
1402 // we just care about their ref_count
1403 // if it reaches 0 sessions should expire
1404 // because the fib isn't valid for NAT anymore
1406 vec_foreach (fib, sm->fibs)
1408 if (fib->fib_index == fib_index)
1413 if (!fib->ref_count)
1415 vec_del1 (sm->fibs, fib - sm->fibs);
1416 expire_per_vrf_sessions (fib_index);
1426 vec_add2 (sm->fibs, fib, 1);
1428 fib->fib_index = fib_index;
1433 snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1435 snat_main_t *sm = &snat_main;
1436 snat_interface_t *i;
1437 const char *feature_name, *del_feature_name;
1439 snat_static_mapping_t *m;
1440 nat_outside_fib_t *outside_fib;
1441 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1446 nat_log_err ("nat44 is disabled");
1447 return VNET_API_ERROR_UNSUPPORTED;
1451 pool_foreach (i, sm->output_feature_interfaces)
1453 if (i->sw_if_index == sw_if_index)
1455 nat_log_err ("error interface already configured");
1456 return VNET_API_ERROR_VALUE_EXIST;
1461 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1462 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1465 if (sm->num_workers > 1)
1467 is_inside ? "nat44-in2out-worker-handoff" :
1468 "nat44-out2in-worker-handoff";
1470 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1473 ASSERT (sm->frame_queue_nelts > 0);
1475 if (sm->fq_in2out_index == ~0 && sm->num_workers > 1)
1476 sm->fq_in2out_index = vlib_frame_queue_main_init (sm->in2out_node_index,
1477 sm->frame_queue_nelts);
1479 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
1480 sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index,
1481 sm->frame_queue_nelts);
1483 update_per_vrf_sessions_vec (fib_index, is_del);
1488 vec_foreach (outside_fib, sm->outside_fibs)
1490 if (outside_fib->fib_index == fib_index)
1494 outside_fib->refcount--;
1495 if (!outside_fib->refcount)
1496 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1499 outside_fib->refcount++;
1506 vec_add2 (sm->outside_fibs, outside_fib, 1);
1507 outside_fib->refcount = 1;
1508 outside_fib->fib_index = fib_index;
1514 pool_foreach (i, sm->interfaces)
1516 if (i->sw_if_index == sw_if_index)
1520 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1523 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1525 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1527 if (sm->num_workers > 1)
1529 del_feature_name = "nat44-handoff-classify";
1530 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1531 "nat44-out2in-worker-handoff";
1535 del_feature_name = "nat44-ed-classify";
1537 !is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1540 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1543 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1544 sw_if_index, 0, 0, 0);
1545 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1546 sw_if_index, 1, 0, 0);
1550 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1553 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1554 sw_if_index, 0, 0, 0);
1555 pool_put (sm->interfaces, i);
1560 if ((nat_interface_is_inside (i) && is_inside) ||
1561 (nat_interface_is_outside (i) && !is_inside))
1564 if (sm->num_workers > 1)
1566 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1567 "nat44-out2in-worker-handoff";
1568 feature_name = "nat44-handoff-classify";
1573 !is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1575 feature_name = "nat44-ed-classify";
1578 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1581 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1582 sw_if_index, 0, 0, 0);
1583 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1584 sw_if_index, 1, 0, 0);
1595 nat_log_err ("error interface couldn't be found");
1596 return VNET_API_ERROR_NO_SUCH_ENTRY;
1599 pool_get (sm->interfaces, i);
1600 i->sw_if_index = sw_if_index;
1602 nat_validate_interface_counters (sm, sw_if_index);
1604 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0,
1607 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1614 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1618 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1620 /* Add/delete external addresses to FIB */
1623 vec_foreach (ap, sm->addresses)
1624 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1626 pool_foreach (m, sm->static_mappings)
1628 if (!(is_addr_only_static_mapping(m)) || (m->local_addr.as_u32 == m->external_addr.as_u32))
1631 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1639 snat_interface_add_del_output_feature (u32 sw_if_index,
1640 u8 is_inside, int is_del)
1642 snat_main_t *sm = &snat_main;
1643 snat_interface_t *i;
1645 snat_static_mapping_t *m;
1646 nat_outside_fib_t *outside_fib;
1647 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1652 nat_log_err ("nat44 is disabled");
1653 return VNET_API_ERROR_UNSUPPORTED;
1656 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1658 nat_log_err ("error unsupported");
1659 return VNET_API_ERROR_UNSUPPORTED;
1663 pool_foreach (i, sm->interfaces)
1665 if (i->sw_if_index == sw_if_index)
1667 nat_log_err ("error interface already configured");
1668 return VNET_API_ERROR_VALUE_EXIST;
1673 update_per_vrf_sessions_vec (fib_index, is_del);
1678 vec_foreach (outside_fib, sm->outside_fibs)
1680 if (outside_fib->fib_index == fib_index)
1684 outside_fib->refcount--;
1685 if (!outside_fib->refcount)
1686 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1689 outside_fib->refcount++;
1696 vec_add2 (sm->outside_fibs, outside_fib, 1);
1697 outside_fib->refcount = 1;
1698 outside_fib->fib_index = fib_index;
1706 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
1710 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
1717 if (sm->num_workers > 1)
1719 int rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
1723 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, !is_del);
1726 vnet_feature_enable_disable ("ip4-unicast",
1727 "nat44-out2in-worker-handoff",
1728 sw_if_index, !is_del, 0, 0);
1729 vnet_feature_enable_disable ("ip4-output",
1730 "nat44-in2out-output-worker-handoff",
1731 sw_if_index, !is_del, 0, 0);
1736 ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, !is_del);
1740 ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index,
1744 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
1745 sw_if_index, !is_del, 0, 0);
1746 vnet_feature_enable_disable ("ip4-output", "nat-pre-in2out-output",
1747 sw_if_index, !is_del, 0, 0);
1751 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
1752 sm->fq_in2out_output_index =
1753 vlib_frame_queue_main_init (sm->in2out_output_node_index, 0);
1755 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
1756 sm->fq_out2in_index =
1757 vlib_frame_queue_main_init (sm->out2in_node_index, 0);
1760 pool_foreach (i, sm->output_feature_interfaces)
1762 if (i->sw_if_index == sw_if_index)
1765 pool_put (sm->output_feature_interfaces, i);
1767 return VNET_API_ERROR_VALUE_EXIST;
1776 nat_log_err ("error interface couldn't be found");
1777 return VNET_API_ERROR_NO_SUCH_ENTRY;
1780 pool_get (sm->output_feature_interfaces, i);
1781 i->sw_if_index = sw_if_index;
1783 nat_validate_interface_counters (sm, sw_if_index);
1785 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1787 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1789 /* Add/delete external addresses to FIB */
1795 vec_foreach (ap, sm->addresses)
1796 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1798 pool_foreach (m, sm->static_mappings)
1800 if (!((is_addr_only_static_mapping(m))) || (m->local_addr.as_u32 == m->external_addr.as_u32))
1803 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1811 snat_set_workers (uword * bitmap)
1813 snat_main_t *sm = &snat_main;
1816 if (sm->num_workers < 2)
1817 return VNET_API_ERROR_FEATURE_DISABLED;
1819 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
1820 return VNET_API_ERROR_INVALID_WORKER;
1822 vec_free (sm->workers);
1824 clib_bitmap_foreach (i, bitmap)
1826 vec_add1(sm->workers, i);
1827 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
1828 sm->per_thread_data[sm->first_worker_index + i].thread_index = i;
1833 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
1839 nat44_ed_set_frame_queue_nelts (u32 frame_queue_nelts)
1842 snat_main_t *sm = &snat_main;
1843 sm->frame_queue_nelts = frame_queue_nelts;
1848 snat_update_outside_fib (ip4_main_t * im, uword opaque,
1849 u32 sw_if_index, u32 new_fib_index,
1852 snat_main_t *sm = &snat_main;
1853 nat_outside_fib_t *outside_fib;
1854 snat_interface_t *i;
1858 if (!sm->enabled || (new_fib_index == old_fib_index)
1859 || (!vec_len (sm->outside_fibs)))
1865 pool_foreach (i, sm->interfaces)
1867 if (i->sw_if_index == sw_if_index)
1869 if (!(nat_interface_is_outside (i)))
1875 pool_foreach (i, sm->output_feature_interfaces)
1877 if (i->sw_if_index == sw_if_index)
1879 if (!(nat_interface_is_outside (i)))
1889 vec_foreach (outside_fib, sm->outside_fibs)
1891 if (outside_fib->fib_index == old_fib_index)
1893 outside_fib->refcount--;
1894 if (!outside_fib->refcount)
1895 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1900 vec_foreach (outside_fib, sm->outside_fibs)
1902 if (outside_fib->fib_index == new_fib_index)
1904 outside_fib->refcount++;
1912 vec_add2 (sm->outside_fibs, outside_fib, 1);
1913 outside_fib->refcount = 1;
1914 outside_fib->fib_index = new_fib_index;
1919 snat_update_outside_fib (ip4_main_t * im, uword opaque,
1920 u32 sw_if_index, u32 new_fib_index,
1924 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
1927 ip4_address_t * address,
1929 u32 if_address_index, u32 is_delete);
1932 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
1935 ip4_address_t * address,
1937 u32 if_address_index, u32 is_delete);
1940 test_key_calc_split ()
1942 ip4_address_t l_addr;
1943 l_addr.as_u8[0] = 1;
1944 l_addr.as_u8[1] = 1;
1945 l_addr.as_u8[2] = 1;
1946 l_addr.as_u8[3] = 1;
1947 ip4_address_t r_addr;
1948 r_addr.as_u8[0] = 2;
1949 r_addr.as_u8[1] = 2;
1950 r_addr.as_u8[2] = 2;
1951 r_addr.as_u8[3] = 2;
1955 u32 fib_index = 9000001;
1956 u32 thread_index = 3000000001;
1957 u32 session_index = 3000000221;
1958 clib_bihash_kv_16_8_t kv;
1959 init_ed_kv (&kv, l_addr, l_port, r_addr, r_port, fib_index, proto,
1960 thread_index, session_index);
1961 ip4_address_t l_addr2;
1962 ip4_address_t r_addr2;
1963 clib_memset (&l_addr2, 0, sizeof (l_addr2));
1964 clib_memset (&r_addr2, 0, sizeof (r_addr2));
1969 split_ed_kv (&kv, &l_addr2, &r_addr2, &proto2, &fib_index2, &l_port2,
1971 ASSERT (l_addr.as_u32 == l_addr2.as_u32);
1972 ASSERT (r_addr.as_u32 == r_addr2.as_u32);
1973 ASSERT (l_port == l_port2);
1974 ASSERT (r_port == r_port2);
1975 ASSERT (proto == proto2);
1976 ASSERT (fib_index == fib_index2);
1977 ASSERT (thread_index == ed_value_get_thread_index (&kv));
1978 ASSERT (session_index == ed_value_get_session_index (&kv));
1982 nat_protocol_t proto3 = ~0;
1983 u64 key = calc_nat_key (l_addr, l_port, fib_index, proto);
1984 split_nat_key (key, &l_addr2, &l_port2, &fib_index2, &proto3);
1985 ASSERT (l_addr.as_u32 == l_addr2.as_u32);
1986 ASSERT (l_port == l_port2);
1987 ASSERT (proto == proto3);
1988 ASSERT (fib_index == fib_index2);
1991 static clib_error_t *
1992 nat_ip_table_add_del (vnet_main_t * vnm, u32 table_id, u32 is_add)
1996 // TODO: consider removing all NAT interfaces
1999 fib_index = ip4_fib_index_from_table_id (table_id);
2000 if (fib_index != ~0)
2001 expire_per_vrf_sessions (fib_index);
2006 VNET_IP_TABLE_ADD_DEL_FUNCTION (nat_ip_table_add_del);
2009 nat44_set_node_indexes (snat_main_t * sm, vlib_main_t * vm)
2013 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in");
2014 sm->in2out_node_index = node->index;
2016 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out");
2017 sm->out2in_node_index = node->index;
2019 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-output");
2020 sm->in2out_output_node_index = node->index;
2023 #define nat_validate_simple_counter(c, i) \
2026 vlib_validate_simple_counter (&c, i); \
2027 vlib_zero_simple_counter (&c, i); \
2031 #define nat_init_simple_counter(c, n, sn) \
2035 c.stat_segment_name = sn; \
2036 nat_validate_simple_counter (c, 0); \
2040 static_always_inline void
2041 nat_validate_interface_counters (snat_main_t *sm, u32 sw_if_index)
2044 nat_validate_simple_counter (sm->counters.fastpath.in2out.x, sw_if_index); \
2045 nat_validate_simple_counter (sm->counters.fastpath.out2in.x, sw_if_index); \
2046 nat_validate_simple_counter (sm->counters.slowpath.in2out.x, sw_if_index); \
2047 nat_validate_simple_counter (sm->counters.slowpath.out2in.x, sw_if_index);
2048 foreach_nat_counter;
2050 nat_validate_simple_counter (sm->counters.hairpinning, sw_if_index);
2053 static clib_error_t *
2054 nat_init (vlib_main_t * vm)
2056 snat_main_t *sm = &snat_main;
2057 vlib_thread_main_t *tm = vlib_get_thread_main ();
2058 vlib_thread_registration_t *tr;
2059 ip4_add_del_interface_address_callback_t cbi = { 0 };
2060 ip4_table_bind_callback_t cbt = { 0 };
2061 u32 i, num_threads = 0;
2062 uword *p, *bitmap = 0;
2064 clib_memset (sm, 0, sizeof (*sm));
2067 sm->vnet_main = vnet_get_main ();
2069 sm->ip4_main = &ip4_main;
2070 sm->api_main = vlibapi_get_main ();
2071 sm->ip4_lookup_main = &ip4_main.lookup_main;
2073 // frame queue indices used for handoff
2074 sm->fq_out2in_index = ~0;
2075 sm->fq_in2out_index = ~0;
2076 sm->fq_in2out_output_index = ~0;
2078 sm->log_level = NAT_LOG_ERROR;
2080 nat44_set_node_indexes (sm, vm);
2081 sm->log_class = vlib_log_register_class ("nat", 0);
2082 nat_ipfix_logging_init (vm);
2084 nat_init_simple_counter (sm->total_sessions, "total-sessions",
2085 "/nat44-ed/total-sessions");
2088 nat_init_simple_counter (sm->counters.fastpath.in2out.x, #x, \
2089 "/nat44-ed/in2out/fastpath/" #x); \
2090 nat_init_simple_counter (sm->counters.fastpath.out2in.x, #x, \
2091 "/nat44-ed/out2in/fastpath/" #x); \
2092 nat_init_simple_counter (sm->counters.slowpath.in2out.x, #x, \
2093 "/nat44-ed/in2out/slowpath/" #x); \
2094 nat_init_simple_counter (sm->counters.slowpath.out2in.x, #x, \
2095 "/nat44-ed/out2in/slowpath/" #x);
2096 foreach_nat_counter;
2098 nat_init_simple_counter (sm->counters.hairpinning, "hairpinning",
2099 "/nat44-ed/hairpinning");
2101 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2104 tr = (vlib_thread_registration_t *) p[0];
2107 sm->num_workers = tr->count;
2108 sm->first_worker_index = tr->first_index;
2111 num_threads = tm->n_vlib_mains - 1;
2112 sm->port_per_thread = 0xffff - 1024;
2113 vec_validate (sm->per_thread_data, num_threads);
2115 /* Use all available workers by default */
2116 if (sm->num_workers > 1)
2119 for (i = 0; i < sm->num_workers; i++)
2120 bitmap = clib_bitmap_set (bitmap, i, 1);
2121 snat_set_workers (bitmap);
2122 clib_bitmap_free (bitmap);
2125 sm->per_thread_data[0].snat_thread_index = 0;
2127 /* callbacks to call when interface address changes. */
2128 cbi.function = snat_ip4_add_del_interface_address_cb;
2129 vec_add1 (sm->ip4_main->add_del_interface_address_callbacks, cbi);
2130 cbi.function = nat_ip4_add_del_addr_only_sm_cb;
2131 vec_add1 (sm->ip4_main->add_del_interface_address_callbacks, cbi);
2133 /* callbacks to call when interface to table biding changes */
2134 cbt.function = snat_update_outside_fib;
2135 vec_add1 (sm->ip4_main->table_bind_callbacks, cbt);
2138 fib_source_allocate ("nat-low", FIB_SOURCE_PRIORITY_LOW,
2139 FIB_SOURCE_BH_SIMPLE);
2141 fib_source_allocate ("nat-hi", FIB_SOURCE_PRIORITY_HI,
2142 FIB_SOURCE_BH_SIMPLE);
2144 nat_affinity_init (vm);
2145 test_key_calc_split ();
2147 return nat44_api_hookup (vm);
2150 VLIB_INIT_FUNCTION (nat_init);
2153 nat44_plugin_enable (nat44_config_t c)
2155 snat_main_t *sm = &snat_main;
2159 // UPDATE based on these appropriate API/CLI
2160 // c.static_mapping_only + c.connection_tracking
2161 // - supported in NAT EI & NAT ED
2162 // c.out2in_dpo, c.static_mapping_only
2163 // - supported in NAT EI
2165 if (c.static_mapping_only && !c.connection_tracking)
2167 nat_log_err ("unsupported combination of configuration");
2171 // nat44 feature configuration
2172 sm->static_mapping_only = c.static_mapping_only;
2173 sm->static_mapping_connection_tracking = c.connection_tracking;
2175 sm->forwarding_enabled = 0;
2176 sm->mss_clamping = 0;
2177 sm->pat = (!c.static_mapping_only ||
2178 (c.static_mapping_only && c.connection_tracking));
2181 c.sessions = 63 * 1024;
2183 sm->max_translations_per_thread = c.sessions;
2184 sm->translation_buckets = nat_calc_bihash_buckets (c.sessions);
2187 vec_add1 (sm->max_translations_per_fib, sm->max_translations_per_thread);
2189 sm->inside_vrf_id = c.inside_vrf;
2190 sm->inside_fib_index =
2191 fib_table_find_or_create_and_lock
2192 (FIB_PROTOCOL_IP4, c.inside_vrf, sm->fib_src_hi);
2194 sm->outside_vrf_id = c.outside_vrf;
2195 sm->outside_fib_index = fib_table_find_or_create_and_lock (
2196 FIB_PROTOCOL_IP4, c.outside_vrf, sm->fib_src_hi);
2198 sm->worker_in2out_cb = nat44_ed_get_worker_in2out_cb;
2199 sm->worker_out2in_cb = nat44_ed_get_worker_out2in_cb;
2201 nat44_ed_db_init (sm->max_translations_per_thread, sm->translation_buckets);
2203 nat_affinity_enable ();
2205 nat_reset_timeouts (&sm->timeouts);
2207 vlib_zero_simple_counter (&sm->total_sessions, 0);
2209 if (!sm->frame_queue_nelts)
2210 sm->frame_queue_nelts = NAT_FQ_NELTS_DEFAULT;
2219 nat44_addresses_free (snat_address_t ** addresses)
2222 vec_foreach (ap, *addresses)
2224 #define _(N, i, n, s) \
2225 vec_free (ap->busy_##n##_ports_per_thread);
2226 foreach_nat_protocol
2229 vec_free (*addresses);
2234 nat44_plugin_disable ()
2236 snat_main_t *sm = &snat_main;
2237 snat_interface_t *i, *vec;
2240 fail_if_disabled ();
2242 // first unregister all nodes from interfaces
2243 vec = vec_dup (sm->interfaces);
2244 vec_foreach (i, vec)
2246 if (nat_interface_is_inside(i))
2247 error = snat_interface_add_del (i->sw_if_index, 1, 1);
2248 if (nat_interface_is_outside(i))
2249 error = snat_interface_add_del (i->sw_if_index, 0, 1);
2253 nat_log_err ("error occurred while removing interface %u",
2260 vec = vec_dup (sm->output_feature_interfaces);
2261 vec_foreach (i, vec)
2263 if (nat_interface_is_inside(i))
2264 error = snat_interface_add_del_output_feature (i->sw_if_index, 1, 1);
2265 if (nat_interface_is_outside(i))
2266 error = snat_interface_add_del_output_feature (i->sw_if_index, 0, 1);
2270 nat_log_err ("error occurred while removing interface %u",
2275 sm->output_feature_interfaces = 0;
2277 vec_free (sm->max_translations_per_fib);
2279 nat44_ed_db_free ();
2281 nat44_addresses_free (&sm->addresses);
2282 nat44_addresses_free (&sm->twice_nat_addresses);
2284 vec_free (sm->to_resolve);
2285 vec_free (sm->auto_add_sw_if_indices);
2286 vec_free (sm->auto_add_sw_if_indices_twice_nat);
2289 sm->auto_add_sw_if_indices = 0;
2290 sm->auto_add_sw_if_indices_twice_nat = 0;
2292 sm->forwarding_enabled = 0;
2295 clib_memset (&sm->rconfig, 0, sizeof (sm->rconfig));
2301 nat44_ed_forwarding_enable_disable (u8 is_enable)
2303 snat_main_per_thread_data_t *tsm;
2304 snat_main_t *sm = &snat_main;
2307 u32 *ses_to_be_removed = 0, *ses_index;
2309 sm->forwarding_enabled = is_enable != 0;
2314 vec_foreach (tsm, sm->per_thread_data)
2316 pool_foreach (s, tsm->sessions)
2318 if (is_fwd_bypass_session (s))
2320 vec_add1 (ses_to_be_removed, s - tsm->sessions);
2323 vec_foreach (ses_index, ses_to_be_removed)
2325 s = pool_elt_at_index (tsm->sessions, ses_index[0]);
2326 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
2327 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
2330 vec_free (ses_to_be_removed);
2335 snat_free_outside_address_and_port (snat_address_t *addresses,
2336 u32 thread_index, ip4_address_t *addr,
2337 u16 port, nat_protocol_t protocol)
2339 snat_main_t *sm = &snat_main;
2342 u16 port_host_byte_order = clib_net_to_host_u16 (port);
2344 for (address_index = 0; address_index < vec_len (addresses);
2347 if (addresses[address_index].addr.as_u32 == addr->as_u32)
2351 ASSERT (address_index < vec_len (addresses));
2353 a = addresses + address_index;
2357 #define _(N, i, n, s) \
2358 case NAT_PROTOCOL_##N: \
2359 ASSERT (a->busy_##n##_port_refcounts[port_host_byte_order] >= 1); \
2360 --a->busy_##n##_port_refcounts[port_host_byte_order]; \
2361 a->busy_##n##_ports--; \
2362 a->busy_##n##_ports_per_thread[thread_index]--; \
2364 foreach_nat_protocol
2366 default : nat_elog_info (sm, "unknown protocol");
2372 nat_set_outside_address_and_port (snat_address_t *addresses, u32 thread_index,
2373 ip4_address_t addr, u16 port,
2374 nat_protocol_t protocol)
2376 snat_main_t *sm = &snat_main;
2377 snat_address_t *a = 0;
2379 u16 port_host_byte_order = clib_net_to_host_u16 (port);
2381 for (address_index = 0; address_index < vec_len (addresses);
2384 if (addresses[address_index].addr.as_u32 != addr.as_u32)
2387 a = addresses + address_index;
2390 #define _(N, j, n, s) \
2391 case NAT_PROTOCOL_##N: \
2392 if (a->busy_##n##_port_refcounts[port_host_byte_order]) \
2393 return VNET_API_ERROR_INSTANCE_IN_USE; \
2394 ++a->busy_##n##_port_refcounts[port_host_byte_order]; \
2395 a->busy_##n##_ports_per_thread[thread_index]++; \
2396 a->busy_##n##_ports++; \
2398 foreach_nat_protocol
2400 default : nat_elog_info (sm, "unknown protocol");
2405 return VNET_API_ERROR_NO_SUCH_ENTRY;
2409 snat_static_mapping_match (snat_main_t * sm,
2410 ip4_address_t match_addr,
2412 u32 match_fib_index,
2413 nat_protocol_t match_protocol,
2414 ip4_address_t * mapping_addr,
2416 u32 * mapping_fib_index,
2419 twice_nat_type_t * twice_nat,
2420 lb_nat_type_t * lb, ip4_address_t * ext_host_addr,
2421 u8 * is_identity_nat, snat_static_mapping_t ** out)
2423 clib_bihash_kv_8_8_t kv, value;
2424 clib_bihash_8_8_t *mapping_hash;
2425 snat_static_mapping_t *m;
2426 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2427 nat44_lb_addr_port_t *local;
2432 mapping_hash = &sm->static_mapping_by_local;
2433 init_nat_k (&kv, match_addr, match_port, match_fib_index,
2435 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2437 /* Try address only mapping */
2438 init_nat_k (&kv, match_addr, 0, match_fib_index, 0);
2439 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2445 mapping_hash = &sm->static_mapping_by_external;
2446 init_nat_k (&kv, match_addr, match_port, 0, match_protocol);
2447 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2449 /* Try address only mapping */
2450 init_nat_k (&kv, match_addr, 0, 0, 0);
2451 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2456 m = pool_elt_at_index (sm->static_mappings, value.value);
2460 if (is_lb_static_mapping (m))
2462 if (PREDICT_FALSE (lb != 0))
2463 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2464 if (m->affinity && !nat_affinity_find_and_lock (ext_host_addr[0],
2470 local = pool_elt_at_index (m->locals, backend_index);
2471 *mapping_addr = local->addr;
2472 *mapping_port = local->port;
2473 *mapping_fib_index = local->fib_index;
2476 // pick locals matching this worker
2477 if (PREDICT_FALSE (sm->num_workers > 1))
2479 u32 thread_index = vlib_get_thread_index ();
2480 pool_foreach_index (i, m->locals)
2482 local = pool_elt_at_index (m->locals, i);
2485 .src_address = local->addr,
2488 if (sm->worker_in2out_cb (&ip, m->fib_index, 0) ==
2494 ASSERT (vec_len (tmp) != 0);
2498 pool_foreach_index (i, m->locals)
2503 hi = vec_len (tmp) - 1;
2504 local = pool_elt_at_index (m->locals, tmp[hi]);
2505 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2508 mid = ((hi - lo) >> 1) + lo;
2509 local = pool_elt_at_index (m->locals, tmp[mid]);
2510 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2512 local = pool_elt_at_index (m->locals, tmp[lo]);
2513 if (!(local->prefix >= rand))
2515 *mapping_addr = local->addr;
2516 *mapping_port = local->port;
2517 *mapping_fib_index = local->fib_index;
2520 if (nat_affinity_create_and_lock (ext_host_addr[0], match_addr,
2521 match_protocol, match_port,
2522 tmp[lo], m->affinity,
2523 m->affinity_per_service_list_head_index))
2524 nat_elog_info (sm, "create affinity record failed");
2530 if (PREDICT_FALSE (lb != 0))
2532 *mapping_fib_index = m->fib_index;
2533 *mapping_addr = m->local_addr;
2534 /* Address only mapping doesn't change port */
2535 *mapping_port = is_addr_only_static_mapping (m) ? match_port
2541 *mapping_addr = m->external_addr;
2542 /* Address only mapping doesn't change port */
2543 *mapping_port = is_addr_only_static_mapping (m) ? match_port
2545 *mapping_fib_index = sm->outside_fib_index;
2549 if (PREDICT_FALSE (is_addr_only != 0))
2550 *is_addr_only = is_addr_only_static_mapping (m);
2552 if (PREDICT_FALSE (twice_nat != 0))
2553 *twice_nat = m->twice_nat;
2555 if (PREDICT_FALSE (is_identity_nat != 0))
2556 *is_identity_nat = is_identity_static_mapping (m);
2565 nat44_ed_get_worker_in2out_cb (ip4_header_t *ip, u32 rx_fib_index,
2568 snat_main_t *sm = &snat_main;
2569 u32 next_worker_index = sm->first_worker_index;
2572 clib_bihash_kv_16_8_t kv16, value16;
2573 snat_main_per_thread_data_t *tsm;
2576 if (PREDICT_FALSE (is_output))
2578 u32 fib_index = sm->outside_fib_index;
2579 nat_outside_fib_t *outside_fib;
2580 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
2581 fib_prefix_t pfx = {
2582 .fp_proto = FIB_PROTOCOL_IP4,
2585 .ip4.as_u32 = ip->dst_address.as_u32,
2590 udp = ip4_next_header (ip);
2592 switch (vec_len (sm->outside_fibs))
2595 fib_index = sm->outside_fib_index;
2598 fib_index = sm->outside_fibs[0].fib_index;
2602 vec_foreach (outside_fib, sm->outside_fibs)
2604 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
2605 if (FIB_NODE_INDEX_INVALID != fei)
2607 if (fib_entry_get_resolving_interface (fei) != ~0)
2609 fib_index = outside_fib->fib_index;
2618 init_ed_k (&kv16, ip->src_address, udp->src_port, ip->dst_address,
2619 udp->dst_port, fib_index, ip->protocol);
2622 !clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16)))
2625 vec_elt_at_index (sm->per_thread_data,
2626 ed_value_get_thread_index (&value16));
2627 next_worker_index += tsm->thread_index;
2629 nat_elog_debug_handoff (
2630 sm, "HANDOFF IN2OUT-OUTPUT-FEATURE (session)", next_worker_index,
2631 fib_index, clib_net_to_host_u32 (ip->src_address.as_u32),
2632 clib_net_to_host_u32 (ip->dst_address.as_u32));
2634 return next_worker_index;
2638 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
2639 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
2641 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
2642 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
2644 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
2646 if (PREDICT_TRUE (!is_output))
2648 nat_elog_debug_handoff (sm, "HANDOFF IN2OUT", next_worker_index,
2650 clib_net_to_host_u32 (ip->src_address.as_u32),
2651 clib_net_to_host_u32 (ip->dst_address.as_u32));
2655 nat_elog_debug_handoff (sm, "HANDOFF IN2OUT-OUTPUT-FEATURE",
2656 next_worker_index, rx_fib_index,
2657 clib_net_to_host_u32 (ip->src_address.as_u32),
2658 clib_net_to_host_u32 (ip->dst_address.as_u32));
2661 return next_worker_index;
2665 nat44_ed_get_worker_out2in_cb (vlib_buffer_t * b, ip4_header_t * ip,
2666 u32 rx_fib_index, u8 is_output)
2668 snat_main_t *sm = &snat_main;
2669 clib_bihash_kv_8_8_t kv, value;
2670 clib_bihash_kv_16_8_t kv16, value16;
2671 snat_main_per_thread_data_t *tsm;
2673 u32 proto, next_worker_index = 0;
2676 snat_static_mapping_t *m;
2679 proto = ip_proto_to_nat_proto (ip->protocol);
2681 if (PREDICT_TRUE (proto == NAT_PROTOCOL_UDP || proto == NAT_PROTOCOL_TCP))
2683 udp = ip4_next_header (ip);
2685 init_ed_k (&kv16, ip->dst_address, udp->dst_port, ip->src_address,
2686 udp->src_port, rx_fib_index, ip->protocol);
2689 !clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16)))
2692 vec_elt_at_index (sm->per_thread_data,
2693 ed_value_get_thread_index (&value16));
2694 vnet_buffer2 (b)->nat.cached_session_index =
2695 ed_value_get_session_index (&value16);
2696 next_worker_index = sm->first_worker_index + tsm->thread_index;
2697 nat_elog_debug_handoff (
2698 sm, "HANDOFF OUT2IN (session)", next_worker_index, rx_fib_index,
2699 clib_net_to_host_u32 (ip->src_address.as_u32),
2700 clib_net_to_host_u32 (ip->dst_address.as_u32));
2701 return next_worker_index;
2704 else if (proto == NAT_PROTOCOL_ICMP)
2706 ip4_address_t lookup_saddr, lookup_daddr;
2707 u16 lookup_sport, lookup_dport;
2709 if (!nat_get_icmp_session_lookup_values (
2710 b, ip, &lookup_saddr, &lookup_sport, &lookup_daddr, &lookup_dport,
2713 init_ed_k (&kv16, lookup_saddr, lookup_sport, lookup_daddr,
2714 lookup_dport, rx_fib_index, lookup_protocol);
2716 !clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16)))
2719 vec_elt_at_index (sm->per_thread_data,
2720 ed_value_get_thread_index (&value16));
2721 next_worker_index = sm->first_worker_index + tsm->thread_index;
2722 nat_elog_debug_handoff (
2723 sm, "HANDOFF OUT2IN (session)", next_worker_index,
2724 rx_fib_index, clib_net_to_host_u32 (ip->src_address.as_u32),
2725 clib_net_to_host_u32 (ip->dst_address.as_u32));
2726 return next_worker_index;
2731 /* first try static mappings without port */
2732 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2734 init_nat_k (&kv, ip->dst_address, 0, 0, 0);
2735 if (!clib_bihash_search_8_8
2736 (&sm->static_mapping_by_external, &kv, &value))
2738 m = pool_elt_at_index (sm->static_mappings, value.value);
2739 next_worker_index = m->workers[0];
2744 /* unknown protocol */
2745 if (PREDICT_FALSE (proto == NAT_PROTOCOL_OTHER))
2747 /* use current thread */
2748 next_worker_index = vlib_get_thread_index ();
2752 udp = ip4_next_header (ip);
2753 port = udp->dst_port;
2755 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
2757 icmp46_header_t *icmp = (icmp46_header_t *) udp;
2758 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
2759 if (!icmp_type_is_error_message
2760 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
2761 port = vnet_buffer (b)->ip.reass.l4_src_port;
2764 /* if error message, then it's not fragmented and we can access it */
2765 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
2766 proto = ip_proto_to_nat_proto (inner_ip->protocol);
2767 void *l4_header = ip4_next_header (inner_ip);
2770 case NAT_PROTOCOL_ICMP:
2771 icmp = (icmp46_header_t *) l4_header;
2772 echo = (icmp_echo_header_t *) (icmp + 1);
2773 port = echo->identifier;
2775 case NAT_PROTOCOL_UDP:
2776 case NAT_PROTOCOL_TCP:
2777 port = ((tcp_udp_header_t *) l4_header)->src_port;
2780 next_worker_index = vlib_get_thread_index ();
2786 /* try static mappings with port */
2787 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2789 init_nat_k (&kv, ip->dst_address, port, 0, proto);
2790 if (!clib_bihash_search_8_8
2791 (&sm->static_mapping_by_external, &kv, &value))
2793 m = pool_elt_at_index (sm->static_mappings, value.value);
2794 if (!is_lb_static_mapping (m))
2796 next_worker_index = m->workers[0];
2800 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
2801 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
2803 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
2805 m->workers[hash & (_vec_len (m->workers) - 1)];
2807 next_worker_index = m->workers[hash % _vec_len (m->workers)];
2812 /* worker by outside port */
2813 next_worker_index = sm->first_worker_index;
2814 next_worker_index +=
2815 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
2818 nat_elog_debug_handoff (sm, "HANDOFF OUT2IN", next_worker_index,
2820 clib_net_to_host_u32 (ip->src_address.as_u32),
2821 clib_net_to_host_u32 (ip->dst_address.as_u32));
2822 return next_worker_index;
2826 nat44_get_max_session_limit ()
2828 snat_main_t *sm = &snat_main;
2829 u32 max_limit = 0, len = 0;
2831 for (; len < vec_len (sm->max_translations_per_fib); len++)
2833 if (max_limit < sm->max_translations_per_fib[len])
2834 max_limit = sm->max_translations_per_fib[len];
2840 nat44_set_session_limit (u32 session_limit, u32 vrf_id)
2842 snat_main_t *sm = &snat_main;
2843 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
2844 u32 len = vec_len (sm->max_translations_per_fib);
2846 if (len <= fib_index)
2848 vec_validate (sm->max_translations_per_fib, fib_index + 1);
2850 for (; len < vec_len (sm->max_translations_per_fib); len++)
2851 sm->max_translations_per_fib[len] = sm->max_translations_per_thread;
2854 sm->max_translations_per_fib[fib_index] = session_limit;
2859 nat44_update_session_limit (u32 session_limit, u32 vrf_id)
2861 snat_main_t *sm = &snat_main;
2863 if (nat44_set_session_limit (session_limit, vrf_id))
2865 sm->max_translations_per_thread = nat44_get_max_session_limit ();
2867 sm->translation_buckets =
2868 nat_calc_bihash_buckets (sm->max_translations_per_thread);
2870 nat44_ed_sessions_clear ();
2875 nat44_ed_worker_db_init (snat_main_per_thread_data_t *tsm, u32 translations,
2876 u32 translation_buckets)
2880 pool_alloc (tsm->sessions, translations);
2881 pool_alloc (tsm->lru_pool, translations);
2883 pool_get (tsm->lru_pool, head);
2884 tsm->tcp_trans_lru_head_index = head - tsm->lru_pool;
2885 clib_dlist_init (tsm->lru_pool, tsm->tcp_trans_lru_head_index);
2887 pool_get (tsm->lru_pool, head);
2888 tsm->tcp_estab_lru_head_index = head - tsm->lru_pool;
2889 clib_dlist_init (tsm->lru_pool, tsm->tcp_estab_lru_head_index);
2891 pool_get (tsm->lru_pool, head);
2892 tsm->udp_lru_head_index = head - tsm->lru_pool;
2893 clib_dlist_init (tsm->lru_pool, tsm->udp_lru_head_index);
2895 pool_get (tsm->lru_pool, head);
2896 tsm->icmp_lru_head_index = head - tsm->lru_pool;
2897 clib_dlist_init (tsm->lru_pool, tsm->icmp_lru_head_index);
2899 pool_get (tsm->lru_pool, head);
2900 tsm->unk_proto_lru_head_index = head - tsm->lru_pool;
2901 clib_dlist_init (tsm->lru_pool, tsm->unk_proto_lru_head_index);
2905 reinit_ed_flow_hash ()
2907 snat_main_t *sm = &snat_main;
2908 // we expect 2 flows per session, so multiply translation_buckets by 2
2909 clib_bihash_init_16_8 (
2910 &sm->flow_hash, "ed-flow-hash",
2911 clib_max (1, sm->num_workers) * 2 * sm->translation_buckets, 0);
2912 clib_bihash_set_kvp_format_fn_16_8 (&sm->flow_hash, format_ed_session_kvp);
2916 nat44_ed_db_init (u32 translations, u32 translation_buckets)
2918 snat_main_t *sm = &snat_main;
2919 snat_main_per_thread_data_t *tsm;
2920 u32 static_mapping_buckets = 1024;
2921 u32 static_mapping_memory_size = 64 << 20;
2923 reinit_ed_flow_hash ();
2925 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
2926 "static_mapping_by_local", static_mapping_buckets,
2927 static_mapping_memory_size);
2928 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_local,
2929 format_static_mapping_kvp);
2931 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
2932 "static_mapping_by_external", static_mapping_buckets,
2933 static_mapping_memory_size);
2934 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_external,
2935 format_static_mapping_kvp);
2939 vec_foreach (tsm, sm->per_thread_data)
2941 nat44_ed_worker_db_init (tsm, sm->max_translations_per_thread,
2942 sm->translation_buckets);
2948 nat44_ed_worker_db_free (snat_main_per_thread_data_t *tsm)
2950 pool_free (tsm->lru_pool);
2951 pool_free (tsm->sessions);
2952 vec_free (tsm->per_vrf_sessions_vec);
2958 snat_main_t *sm = &snat_main;
2959 snat_main_per_thread_data_t *tsm;
2961 pool_free (sm->static_mappings);
2962 clib_bihash_free_16_8 (&sm->flow_hash);
2963 clib_bihash_free_8_8 (&sm->static_mapping_by_local);
2964 clib_bihash_free_8_8 (&sm->static_mapping_by_external);
2968 vec_foreach (tsm, sm->per_thread_data)
2970 nat44_ed_worker_db_free (tsm);
2976 nat44_ed_sessions_clear ()
2978 snat_main_t *sm = &snat_main;
2979 snat_main_per_thread_data_t *tsm;
2981 reinit_ed_flow_hash ();
2985 vec_foreach (tsm, sm->per_thread_data)
2988 nat44_ed_worker_db_free (tsm);
2989 nat44_ed_worker_db_init (tsm, sm->max_translations_per_thread,
2990 sm->translation_buckets);
2993 vlib_zero_simple_counter (&sm->total_sessions, 0);
2997 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
3000 ip4_address_t * address,
3002 u32 if_address_index, u32 is_delete)
3004 snat_main_t *sm = &snat_main;
3005 snat_static_map_resolve_t *rp;
3006 snat_static_mapping_t *m;
3007 clib_bihash_kv_8_8_t kv, value;
3009 ip4_address_t l_addr;
3014 for (i = 0; i < vec_len (sm->to_resolve); i++)
3016 rp = sm->to_resolve + i;
3017 if (rp->addr_only == 0)
3019 if (rp->sw_if_index == sw_if_index)
3026 init_nat_k (&kv, *address, rp->addr_only ? 0 : rp->e_port,
3027 sm->outside_fib_index, rp->addr_only ? 0 : rp->proto);
3028 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
3031 m = pool_elt_at_index (sm->static_mappings, value.value);
3035 /* Don't trip over lease renewal, static config */
3045 /* Indetity mapping? */
3046 if (rp->l_addr.as_u32 == 0)
3047 l_addr.as_u32 = address[0].as_u32;
3049 l_addr.as_u32 = rp->l_addr.as_u32;
3050 /* Add the static mapping */
3051 rv = snat_add_static_mapping (l_addr,
3056 rp->addr_only, ~0 /* sw_if_index */ ,
3057 rp->proto, !is_delete, rp->twice_nat,
3058 rp->out2in_only, rp->tag, rp->identity_nat,
3059 rp->pool_addr, rp->exact);
3061 nat_elog_notice_X1 (sm, "snat_add_static_mapping returned %d", "i4", rv);
3065 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
3068 ip4_address_t * address,
3070 u32 if_address_index, u32 is_delete)
3072 snat_main_t *sm = &snat_main;
3073 snat_static_map_resolve_t *rp;
3074 ip4_address_t l_addr;
3078 snat_address_t *addresses = sm->addresses;
3083 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices); i++)
3085 if (sw_if_index == sm->auto_add_sw_if_indices[i])
3089 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices_twice_nat); i++)
3092 addresses = sm->twice_nat_addresses;
3093 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
3102 /* Don't trip over lease renewal, static config */
3103 for (j = 0; j < vec_len (addresses); j++)
3104 if (addresses[j].addr.as_u32 == address->as_u32)
3107 (void) snat_add_address (sm, address, ~0, twice_nat);
3108 /* Scan static map resolution vector */
3109 for (j = 0; j < vec_len (sm->to_resolve); j++)
3111 rp = sm->to_resolve + j;
3114 /* On this interface? */
3115 if (rp->sw_if_index == sw_if_index)
3117 /* Indetity mapping? */
3118 if (rp->l_addr.as_u32 == 0)
3119 l_addr.as_u32 = address[0].as_u32;
3121 l_addr.as_u32 = rp->l_addr.as_u32;
3122 /* Add the static mapping */
3123 rv = snat_add_static_mapping (
3124 l_addr, address[0], rp->l_port, rp->e_port, rp->vrf_id,
3125 rp->addr_only, ~0 /* sw_if_index */, rp->proto, 1,
3126 rp->twice_nat, rp->out2in_only, rp->tag, rp->identity_nat,
3127 rp->pool_addr, rp->exact);
3129 nat_elog_notice_X1 (sm, "snat_add_static_mapping returned %d",
3137 (void) snat_del_address (sm, address[0], 1, twice_nat);
3143 snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
3146 ip4_main_t *ip4_main = sm->ip4_main;
3147 ip4_address_t *first_int_addr;
3148 snat_static_map_resolve_t *rp;
3149 u32 *indices_to_delete = 0;
3151 u32 *auto_add_sw_if_indices =
3153 auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
3155 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0 /* just want the address */
3158 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
3160 if (auto_add_sw_if_indices[i] == sw_if_index)
3164 /* if have address remove it */
3166 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
3169 for (j = 0; j < vec_len (sm->to_resolve); j++)
3171 rp = sm->to_resolve + j;
3172 if (rp->sw_if_index == sw_if_index)
3173 vec_add1 (indices_to_delete, j);
3175 if (vec_len (indices_to_delete))
3177 for (j = vec_len (indices_to_delete) - 1; j >= 0; j--)
3178 vec_del1 (sm->to_resolve, j);
3179 vec_free (indices_to_delete);
3183 vec_del1 (sm->auto_add_sw_if_indices_twice_nat, i);
3185 vec_del1 (sm->auto_add_sw_if_indices, i);
3188 return VNET_API_ERROR_VALUE_EXIST;
3195 return VNET_API_ERROR_NO_SUCH_ENTRY;
3197 /* add to the auto-address list */
3199 vec_add1 (sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
3201 vec_add1 (sm->auto_add_sw_if_indices, sw_if_index);
3203 /* If the address is already bound - or static - add it now */
3205 (void) snat_add_address (sm, first_int_addr, ~0, twice_nat);
3211 nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
3212 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3213 u32 vrf_id, int is_in)
3216 clib_bihash_kv_16_8_t kv, value;
3217 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3219 snat_main_per_thread_data_t *tsm;
3221 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
3222 if (sm->num_workers > 1)
3224 vec_elt_at_index (sm->per_thread_data,
3225 sm->worker_in2out_cb (&ip, fib_index, 0));
3227 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
3229 init_ed_k (&kv, *addr, port, *eh_addr, eh_port, fib_index, proto);
3230 if (clib_bihash_search_16_8 (&sm->flow_hash, &kv, &value))
3232 return VNET_API_ERROR_NO_SUCH_ENTRY;
3235 if (pool_is_free_index (tsm->sessions, ed_value_get_session_index (&value)))
3236 return VNET_API_ERROR_UNSPECIFIED;
3237 s = pool_elt_at_index (tsm->sessions, ed_value_get_session_index (&value));
3238 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
3239 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
3243 VLIB_NODE_FN (nat_default_node) (vlib_main_t * vm,
3244 vlib_node_runtime_t * node,
3245 vlib_frame_t * frame)
3251 VLIB_REGISTER_NODE (nat_default_node) = {
3252 .name = "nat-default",
3253 .vector_size = sizeof (u32),
3255 .type = VLIB_NODE_TYPE_INTERNAL,
3257 .n_next_nodes = NAT_N_NEXT,
3259 [NAT_NEXT_DROP] = "error-drop",
3260 [NAT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
3261 [NAT_NEXT_IN2OUT_ED_FAST_PATH] = "nat44-ed-in2out",
3262 [NAT_NEXT_IN2OUT_ED_SLOW_PATH] = "nat44-ed-in2out-slowpath",
3263 [NAT_NEXT_IN2OUT_ED_OUTPUT_FAST_PATH] = "nat44-ed-in2out-output",
3264 [NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH] = "nat44-ed-in2out-output-slowpath",
3265 [NAT_NEXT_OUT2IN_ED_FAST_PATH] = "nat44-ed-out2in",
3266 [NAT_NEXT_OUT2IN_ED_SLOW_PATH] = "nat44-ed-out2in-slowpath",
3267 [NAT_NEXT_IN2OUT_CLASSIFY] = "nat44-in2out-worker-handoff",
3268 [NAT_NEXT_OUT2IN_CLASSIFY] = "nat44-out2in-worker-handoff",
3274 nat_6t_l3_l4_csum_calc (nat_6t_flow_t *f)
3276 f->l3_csum_delta = 0;
3277 f->l4_csum_delta = 0;
3278 if (f->ops & NAT_FLOW_OP_SADDR_REWRITE &&
3279 f->rewrite.saddr.as_u32 != f->match.saddr.as_u32)
3282 ip_csum_add_even (f->l3_csum_delta, f->rewrite.saddr.as_u32);
3284 ip_csum_sub_even (f->l3_csum_delta, f->match.saddr.as_u32);
3288 f->rewrite.saddr.as_u32 = f->match.saddr.as_u32;
3290 if (f->ops & NAT_FLOW_OP_DADDR_REWRITE &&
3291 f->rewrite.daddr.as_u32 != f->match.daddr.as_u32)
3294 ip_csum_add_even (f->l3_csum_delta, f->rewrite.daddr.as_u32);
3296 ip_csum_sub_even (f->l3_csum_delta, f->match.daddr.as_u32);
3300 f->rewrite.daddr.as_u32 = f->match.daddr.as_u32;
3302 if (f->ops & NAT_FLOW_OP_SPORT_REWRITE && f->rewrite.sport != f->match.sport)
3304 f->l4_csum_delta = ip_csum_add_even (f->l4_csum_delta, f->rewrite.sport);
3305 f->l4_csum_delta = ip_csum_sub_even (f->l4_csum_delta, f->match.sport);
3309 f->rewrite.sport = f->match.sport;
3311 if (f->ops & NAT_FLOW_OP_DPORT_REWRITE && f->rewrite.dport != f->match.dport)
3313 f->l4_csum_delta = ip_csum_add_even (f->l4_csum_delta, f->rewrite.dport);
3314 f->l4_csum_delta = ip_csum_sub_even (f->l4_csum_delta, f->match.dport);
3318 f->rewrite.dport = f->match.dport;
3320 if (f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE &&
3321 f->rewrite.icmp_id != f->match.icmp_id)
3324 ip_csum_add_even (f->l4_csum_delta, f->rewrite.icmp_id);
3325 f->l4_csum_delta = ip_csum_sub_even (f->l4_csum_delta, f->match.icmp_id);
3329 f->rewrite.icmp_id = f->match.icmp_id;
3331 if (f->ops & NAT_FLOW_OP_TXFIB_REWRITE)
3336 f->rewrite.fib_index = f->match.fib_index;
3340 static_always_inline int nat_6t_flow_icmp_translate (snat_main_t *sm,
3345 static_always_inline void
3346 nat_6t_flow_ip4_translate (snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip,
3347 nat_6t_flow_t *f, nat_protocol_t proto,
3348 int is_icmp_inner_ip4)
3350 udp_header_t *udp = ip4_next_header (ip);
3351 tcp_header_t *tcp = (tcp_header_t *) udp;
3353 if ((NAT_PROTOCOL_TCP == proto || NAT_PROTOCOL_UDP == proto) &&
3354 !vnet_buffer (b)->ip.reass.is_non_first_fragment)
3356 if (!is_icmp_inner_ip4)
3358 ip->src_address = f->rewrite.saddr;
3359 ip->dst_address = f->rewrite.daddr;
3360 udp->src_port = f->rewrite.sport;
3361 udp->dst_port = f->rewrite.dport;
3364 { // icmp inner ip4 - reversed saddr/daddr
3365 ip->src_address = f->rewrite.daddr;
3366 ip->dst_address = f->rewrite.saddr;
3367 udp->src_port = f->rewrite.dport;
3368 udp->dst_port = f->rewrite.sport;
3371 if (NAT_PROTOCOL_TCP == proto)
3373 ip_csum_t tcp_sum = tcp->checksum;
3374 tcp_sum = ip_csum_sub_even (tcp_sum, f->l3_csum_delta);
3375 tcp_sum = ip_csum_sub_even (tcp_sum, f->l4_csum_delta);
3376 mss_clamping (sm->mss_clamping, tcp, &tcp_sum);
3377 tcp->checksum = ip_csum_fold (tcp_sum);
3379 else if (proto == NAT_PROTOCOL_UDP && udp->checksum)
3381 ip_csum_t udp_sum = udp->checksum;
3382 udp_sum = ip_csum_sub_even (udp_sum, f->l3_csum_delta);
3383 udp_sum = ip_csum_sub_even (udp_sum, f->l4_csum_delta);
3384 udp->checksum = ip_csum_fold (udp_sum);
3389 if (!is_icmp_inner_ip4)
3391 ip->src_address = f->rewrite.saddr;
3392 ip->dst_address = f->rewrite.daddr;
3395 { // icmp inner ip4 - reversed saddr/daddr
3396 ip->src_address = f->rewrite.daddr;
3397 ip->dst_address = f->rewrite.saddr;
3401 ip_csum_t ip_sum = ip->checksum;
3402 ip_sum = ip_csum_sub_even (ip_sum, f->l3_csum_delta);
3403 ip->checksum = ip_csum_fold (ip_sum);
3404 ASSERT (ip->checksum == ip4_header_checksum (ip));
3407 static_always_inline int
3408 nat_6t_flow_icmp_translate (snat_main_t *sm, vlib_buffer_t *b,
3409 ip4_header_t *ip, nat_6t_flow_t *f)
3411 if (IP_PROTOCOL_ICMP != ip->protocol)
3412 return NAT_ED_TRNSL_ERR_TRANSLATION_FAILED;
3414 icmp46_header_t *icmp = ip4_next_header (ip);
3415 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3417 if ((!vnet_buffer (b)->ip.reass.is_non_first_fragment))
3419 if (icmp->checksum == 0)
3420 icmp->checksum = 0xffff;
3422 if (!icmp_type_is_error_message (icmp->type))
3424 if ((f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE) &&
3425 (f->rewrite.icmp_id != echo->identifier))
3427 ip_csum_t sum = icmp->checksum;
3428 sum = ip_csum_update (sum, echo->identifier, f->rewrite.icmp_id,
3430 identifier /* changed member */);
3431 echo->identifier = f->rewrite.icmp_id;
3432 icmp->checksum = ip_csum_fold (sum);
3437 // errors are not fragmented
3438 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3440 if (!ip4_header_checksum_is_valid (inner_ip))
3442 return NAT_ED_TRNSL_ERR_TRANSLATION_FAILED;
3445 nat_protocol_t inner_proto =
3446 ip_proto_to_nat_proto (inner_ip->protocol);
3448 ip_csum_t icmp_sum = icmp->checksum;
3450 switch (inner_proto)
3452 case NAT_PROTOCOL_UDP:
3453 case NAT_PROTOCOL_TCP:
3454 nat_6t_flow_ip4_translate (sm, b, inner_ip, f, inner_proto,
3455 1 /* is_icmp_inner_ip4 */);
3456 icmp_sum = ip_csum_sub_even (icmp_sum, f->l3_csum_delta);
3457 icmp->checksum = ip_csum_fold (icmp_sum);
3459 case NAT_PROTOCOL_ICMP:
3460 if (f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE)
3462 icmp46_header_t *inner_icmp = ip4_next_header (inner_ip);
3463 icmp_echo_header_t *inner_echo =
3464 (icmp_echo_header_t *) (inner_icmp + 1);
3465 if (f->rewrite.icmp_id != inner_echo->identifier)
3467 ip_csum_t sum = icmp->checksum;
3468 sum = ip_csum_update (
3469 sum, inner_echo->identifier, f->rewrite.icmp_id,
3470 icmp_echo_header_t, identifier /* changed member */);
3471 icmp->checksum = ip_csum_fold (sum);
3472 ip_csum_t inner_sum = inner_icmp->checksum;
3473 inner_sum = ip_csum_update (
3474 sum, inner_echo->identifier, f->rewrite.icmp_id,
3475 icmp_echo_header_t, identifier /* changed member */);
3476 inner_icmp->checksum = ip_csum_fold (inner_sum);
3477 inner_echo->identifier = f->rewrite.icmp_id;
3482 clib_warning ("unexpected NAT protocol value `%d'", inner_proto);
3483 return NAT_ED_TRNSL_ERR_TRANSLATION_FAILED;
3487 return NAT_ED_TRNSL_ERR_SUCCESS;
3490 nat_translation_error_e
3491 nat_6t_flow_buf_translate (snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip,
3492 nat_6t_flow_t *f, nat_protocol_t proto,
3493 int is_output_feature)
3495 if (!is_output_feature && f->ops & NAT_FLOW_OP_TXFIB_REWRITE)
3497 vnet_buffer (b)->sw_if_index[VLIB_TX] = f->rewrite.fib_index;
3500 nat_6t_flow_ip4_translate (sm, b, ip, f, proto, 0 /* is_icmp_inner_ip4 */);
3502 if (NAT_PROTOCOL_ICMP == proto)
3504 return nat_6t_flow_icmp_translate (sm, b, ip, f);
3507 return NAT_ED_TRNSL_ERR_SUCCESS;
3511 format_nat_6t (u8 *s, va_list *args)
3513 nat_6t_t *t = va_arg (*args, nat_6t_t *);
3515 s = format (s, "saddr %U sport %u daddr %U dport %u proto %U fib_idx %u",
3516 format_ip4_address, t->saddr.as_u8,
3517 clib_net_to_host_u16 (t->sport), format_ip4_address,
3518 t->daddr.as_u8, clib_net_to_host_u16 (t->dport),
3519 format_ip_protocol, t->proto, t->fib_index);
3524 format_nat_ed_translation_error (u8 *s, va_list *args)
3526 nat_translation_error_e e = va_arg (*args, nat_translation_error_e);
3530 case NAT_ED_TRNSL_ERR_SUCCESS:
3531 s = format (s, "success");
3533 case NAT_ED_TRNSL_ERR_TRANSLATION_FAILED:
3534 s = format (s, "translation-failed");
3536 case NAT_ED_TRNSL_ERR_FLOW_MISMATCH:
3537 s = format (s, "flow-mismatch");
3544 format_nat_6t_flow (u8 *s, va_list *args)
3546 nat_6t_flow_t *f = va_arg (*args, nat_6t_flow_t *);
3548 s = format (s, "match: %U ", format_nat_6t, &f->match);
3550 if (f->ops & NAT_FLOW_OP_SADDR_REWRITE)
3552 s = format (s, "rewrite: saddr %U ", format_ip4_address,
3553 f->rewrite.saddr.as_u8);
3556 if (f->ops & NAT_FLOW_OP_SPORT_REWRITE)
3560 s = format (s, "rewrite: ");
3563 s = format (s, "sport %u ", clib_net_to_host_u16 (f->rewrite.sport));
3565 if (f->ops & NAT_FLOW_OP_DADDR_REWRITE)
3569 s = format (s, "rewrite: ");
3572 s = format (s, "daddr %U ", format_ip4_address, f->rewrite.daddr.as_u8);
3574 if (f->ops & NAT_FLOW_OP_DPORT_REWRITE)
3578 s = format (s, "rewrite: ");
3581 s = format (s, "dport %u ", clib_net_to_host_u16 (f->rewrite.dport));
3583 if (f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE)
3587 s = format (s, "rewrite: ");
3590 s = format (s, "icmp-id %u ", clib_net_to_host_u16 (f->rewrite.icmp_id));
3592 if (f->ops & NAT_FLOW_OP_TXFIB_REWRITE)
3596 s = format (s, "rewrite: ");
3599 s = format (s, "txfib %u ", f->rewrite.fib_index);
3605 * fd.io coding-style-patch-verification: ON
3608 * eval: (c-set-style "gnu")