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 #include <vpp/stats/stat_segment.h>
41 snat_main_t snat_main;
43 static_always_inline void nat_validate_interface_counters (snat_main_t *sm,
46 #define skip_if_disabled() \
49 snat_main_t *sm = &snat_main; \
50 if (PREDICT_FALSE (!sm->enabled)) \
55 #define fail_if_enabled() \
58 snat_main_t *sm = &snat_main; \
59 if (PREDICT_FALSE (sm->enabled)) \
61 nat_log_err ("plugin enabled"); \
67 #define fail_if_disabled() \
70 snat_main_t *sm = &snat_main; \
71 if (PREDICT_FALSE (!sm->enabled)) \
73 nat_log_err ("plugin disabled"); \
79 /* Hook up input features */
80 VNET_FEATURE_INIT (nat_pre_in2out, static) = {
81 .arc_name = "ip4-unicast",
82 .node_name = "nat-pre-in2out",
83 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
84 "ip4-sv-reassembly-feature"),
86 VNET_FEATURE_INIT (nat_pre_out2in, static) = {
87 .arc_name = "ip4-unicast",
88 .node_name = "nat-pre-out2in",
89 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
90 "ip4-dhcp-client-detect",
91 "ip4-sv-reassembly-feature"),
93 VNET_FEATURE_INIT (snat_in2out_worker_handoff, static) = {
94 .arc_name = "ip4-unicast",
95 .node_name = "nat44-in2out-worker-handoff",
96 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
98 VNET_FEATURE_INIT (snat_out2in_worker_handoff, static) = {
99 .arc_name = "ip4-unicast",
100 .node_name = "nat44-out2in-worker-handoff",
101 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
102 "ip4-dhcp-client-detect"),
104 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
105 .arc_name = "ip4-unicast",
106 .node_name = "nat44-in2out",
107 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
109 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
110 .arc_name = "ip4-unicast",
111 .node_name = "nat44-out2in",
112 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
113 "ip4-dhcp-client-detect"),
115 VNET_FEATURE_INIT (ip4_nat44_ed_in2out, static) = {
116 .arc_name = "ip4-unicast",
117 .node_name = "nat44-ed-in2out",
118 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
120 VNET_FEATURE_INIT (ip4_nat44_ed_out2in, static) = {
121 .arc_name = "ip4-unicast",
122 .node_name = "nat44-ed-out2in",
123 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
124 "ip4-dhcp-client-detect"),
126 VNET_FEATURE_INIT (ip4_nat44_ed_classify, static) = {
127 .arc_name = "ip4-unicast",
128 .node_name = "nat44-ed-classify",
129 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
131 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
132 .arc_name = "ip4-unicast",
133 .node_name = "nat44-handoff-classify",
134 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
136 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
137 .arc_name = "ip4-unicast",
138 .node_name = "nat44-in2out-fast",
139 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature"),
141 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
142 .arc_name = "ip4-unicast",
143 .node_name = "nat44-out2in-fast",
144 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa","ip4-sv-reassembly-feature",
145 "ip4-dhcp-client-detect"),
148 /* Hook up output features */
149 VNET_FEATURE_INIT (ip4_snat_in2out_output, static) = {
150 .arc_name = "ip4-output",
151 .node_name = "nat44-in2out-output",
152 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
153 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
155 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
156 .arc_name = "ip4-output",
157 .node_name = "nat44-in2out-output-worker-handoff",
158 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
159 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
161 VNET_FEATURE_INIT (nat_pre_in2out_output, static) = {
162 .arc_name = "ip4-output",
163 .node_name = "nat-pre-in2out-output",
164 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
165 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
167 VNET_FEATURE_INIT (ip4_nat44_ed_in2out_output, static) = {
168 .arc_name = "ip4-output",
169 .node_name = "nat44-ed-in2out-output",
170 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
171 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
174 VLIB_PLUGIN_REGISTER () = {
175 .version = VPP_BUILD_VER,
176 .description = "Network Address Translation (NAT)",
179 static void nat44_ed_db_init (u32 translations, u32 translation_buckets);
181 static void nat44_ed_db_free ();
183 u32 nat_calc_bihash_buckets (u32 n_elts);
186 format_session_kvp (u8 * s, va_list * args)
188 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
190 s = format (s, "%U thread-index %llu session-index %llu", format_snat_key,
191 v->key, nat_value_get_thread_index (v),
192 nat_value_get_session_index (v));
198 format_static_mapping_kvp (u8 * s, va_list * args)
200 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
202 s = format (s, "%U static-mapping-index %llu",
203 format_snat_key, v->key, v->value);
209 format_ed_session_kvp (u8 * s, va_list * args)
211 clib_bihash_kv_16_8_t *v = va_arg (*args, clib_bihash_kv_16_8_t *);
215 ip4_address_t l_addr, r_addr;
218 split_ed_kv (v, &l_addr, &r_addr, &proto, &fib_index, &l_port, &r_port);
220 "local %U:%d remote %U:%d proto %U fib %d thread-index %u "
222 format_ip4_address, &l_addr, clib_net_to_host_u16 (l_port),
223 format_ip4_address, &r_addr, clib_net_to_host_u16 (r_port),
224 format_ip_protocol, proto, fib_index,
225 ed_value_get_thread_index (v), ed_value_get_session_index (v));
231 nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index,
234 per_vrf_sessions_unregister_session (s, thread_index);
236 if (nat_ed_ses_i2o_flow_hash_add_del (sm, thread_index, s, 0))
237 nat_elog_warn (sm, "flow hash del failed");
239 if (nat_ed_ses_o2i_flow_hash_add_del (sm, thread_index, s, 0))
240 nat_elog_warn (sm, "flow hash del failed");
242 if (is_fwd_bypass_session (s))
247 if (is_affinity_sessions (s))
248 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
249 s->nat_proto, s->out2in.port);
252 nat_syslog_nat44_sdel (
253 0, s->in2out.fib_index, &s->in2out.addr, s->in2out.port,
254 &s->ext_host_nat_addr, s->ext_host_nat_port, &s->out2in.addr,
255 s->out2in.port, &s->ext_host_addr, s->ext_host_port, s->nat_proto,
256 is_twice_nat_session (s));
258 if (snat_is_unk_proto_session (s))
264 nat_ipfix_logging_nat44_ses_delete (thread_index,
265 s->in2out.addr.as_u32,
266 s->out2in.addr.as_u32,
270 s->in2out.fib_index);
273 /* Twice NAT address and port for external host */
274 if (is_twice_nat_session (s))
276 snat_free_outside_address_and_port (sm->twice_nat_addresses,
278 &s->ext_host_nat_addr,
279 s->ext_host_nat_port, s->nat_proto);
282 if (snat_is_session_static (s))
285 snat_free_outside_address_and_port (sm->addresses, thread_index,
286 &s->out2in.addr, s->out2in.port,
291 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
294 snat_main_t *sm = &snat_main;
295 fib_prefix_t prefix = {
297 .fp_proto = FIB_PROTOCOL_IP4,
299 .ip4.as_u32 = addr->as_u32,
302 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
305 fib_table_entry_update_one_path (fib_index,
308 (FIB_ENTRY_FLAG_CONNECTED |
309 FIB_ENTRY_FLAG_LOCAL |
310 FIB_ENTRY_FLAG_EXCLUSIVE),
314 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
316 fib_table_entry_delete (fib_index, &prefix, sm->fib_src_low);
320 is_snat_address_used_in_static_mapping (snat_main_t *sm, ip4_address_t addr)
322 snat_static_mapping_t *m;
323 pool_foreach (m, sm->static_mappings)
325 if (is_sm_addr_only (m->flags) || is_sm_out2in_only (m->flags) ||
326 is_sm_identity_nat (m->flags))
328 if (m->external_addr.as_u32 == addr.as_u32)
335 nat44_ed_add_address (ip4_address_t *addr, u32 vrf_id, u8 twice_nat)
337 snat_main_t *sm = &snat_main;
338 vlib_thread_main_t *tm = vlib_get_thread_main ();
339 snat_address_t *ap, *addresses;
342 addresses = twice_nat ? sm->twice_nat_addresses : sm->addresses;
346 return VNET_API_ERROR_UNSUPPORTED;
349 // check if address already exists
350 vec_foreach (ap, addresses)
352 if (ap->addr.as_u32 == addr->as_u32)
354 nat_log_err ("address exist");
355 return VNET_API_ERROR_VALUE_EXIST;
361 vec_add2 (sm->twice_nat_addresses, ap, 1);
365 vec_add2 (sm->addresses, ap, 1);
373 ap->fib_index = fib_table_find_or_create_and_lock (
374 FIB_PROTOCOL_IP4, vrf_id, sm->fib_src_low);
377 #define _(N, i, n, s) \
378 clib_memset (ap->busy_##n##_port_refcounts, 0, \
379 sizeof (ap->busy_##n##_port_refcounts)); \
380 ap->busy_##n##_ports = 0; \
381 ap->busy_##n##_ports_per_thread = 0; \
382 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, \
383 tm->n_vlib_mains - 1, 0);
389 pool_foreach (i, sm->interfaces)
391 if (!nat_interface_is_inside (i))
393 snat_add_del_addr_to_fib (addr, 32, i->sw_if_index, 1);
397 pool_foreach (i, sm->output_feature_interfaces)
399 if (!nat_interface_is_inside (i))
401 snat_add_del_addr_to_fib (addr, 32, i->sw_if_index, 1);
410 nat44_ed_del_address (ip4_address_t addr, u8 delete_sm, u8 twice_nat)
412 snat_main_t *sm = &snat_main;
413 snat_address_t *a = 0, *addresses;
415 u32 *ses_to_be_removed = 0, *ses_index;
416 snat_main_per_thread_data_t *tsm;
417 snat_static_mapping_t *m;
421 addresses = twice_nat ? sm->twice_nat_addresses : sm->addresses;
423 for (j = 0; j < vec_len (addresses); j++)
425 if (addresses[j].addr.as_u32 == addr.as_u32)
433 nat_log_err ("no such address");
434 return VNET_API_ERROR_NO_SUCH_ENTRY;
439 pool_foreach (m, sm->static_mappings)
441 if (m->external_addr.as_u32 == addr.as_u32)
443 nat44_ed_del_static_mapping (m->local_addr, m->external_addr,
444 m->local_port, m->external_port,
445 m->proto, m->vrf_id, ~0, m->flags);
452 // check if address is used in some static mapping
453 if (is_snat_address_used_in_static_mapping (sm, addr))
455 nat_log_err ("address used in static mapping");
456 return VNET_API_ERROR_UNSPECIFIED;
460 if (a->fib_index != ~0)
462 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
465 // delete sessions using address
466 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
468 vec_foreach (tsm, sm->per_thread_data)
470 pool_foreach (ses, tsm->sessions)
472 if (ses->out2in.addr.as_u32 == addr.as_u32)
474 nat_free_session_data (sm, ses, tsm - sm->per_thread_data,
476 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
479 vec_foreach (ses_index, ses_to_be_removed)
481 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
482 nat_ed_session_delete (sm, ses, tsm - sm->per_thread_data, 1);
484 vec_free (ses_to_be_removed);
488 #define _(N, i, n, s) vec_free (a->busy_##n##_ports_per_thread);
494 vec_del1 (sm->addresses, j);
495 // delete external address from FIB
496 pool_foreach (i, sm->interfaces)
498 if (!nat_interface_is_inside (i))
500 snat_add_del_addr_to_fib (&addr, 32, i->sw_if_index, 0);
504 pool_foreach (i, sm->output_feature_interfaces)
506 if (!nat_interface_is_inside (i))
508 snat_add_del_addr_to_fib (&addr, 32, i->sw_if_index, 0);
513 else { vec_del1 (sm->twice_nat_addresses, j); }
518 get_thread_idx_by_port (u16 e_port)
520 snat_main_t *sm = &snat_main;
521 u32 thread_idx = sm->num_workers;
522 if (sm->num_workers > 1)
525 sm->first_worker_index +
526 sm->workers[(e_port - 1024) / sm->port_per_thread];
532 nat_ed_static_mapping_del_sessions (snat_main_t * sm,
533 snat_main_per_thread_data_t * tsm,
534 ip4_address_t l_addr,
537 u32 fib_index, int addr_only,
538 ip4_address_t e_addr, u16 e_port)
541 u32 *indexes_to_free = NULL;
542 pool_foreach (s, tsm->sessions) {
543 if (s->in2out.fib_index != fib_index ||
544 s->in2out.addr.as_u32 != l_addr.as_u32)
550 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
551 s->out2in.port != e_port ||
552 s->in2out.port != l_port ||
553 s->nat_proto != protocol)
557 if (is_lb_session (s))
559 if (!snat_is_session_static (s))
561 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
562 vec_add1 (indexes_to_free, s - tsm->sessions);
567 vec_foreach (ses_index, indexes_to_free)
569 s = pool_elt_at_index (tsm->sessions, *ses_index);
570 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
572 vec_free (indexes_to_free);
576 nat44_ed_reserve_port (ip4_address_t addr, u16 port, nat_protocol_t proto)
578 u32 ti = get_thread_idx_by_port (port);
579 snat_main_t *sm = &snat_main;
580 snat_address_t *a = 0;
583 for (i = 0; i < vec_len (sm->addresses); i++)
585 a = sm->addresses + i;
587 if (a->addr.as_u32 != addr.as_u32)
592 #define _(N, j, n, s) \
593 case NAT_PROTOCOL_##N: \
594 if (a->busy_##n##_port_refcounts[port]) \
596 ++a->busy_##n##_port_refcounts[port]; \
599 a->busy_##n##_ports++; \
600 a->busy_##n##_ports_per_thread[ti]++; \
605 default : nat_elog_info (sm, "unknown protocol");
617 nat44_ed_free_port (ip4_address_t addr, u16 port, nat_protocol_t proto)
619 u32 ti = get_thread_idx_by_port (port);
620 snat_main_t *sm = &snat_main;
621 snat_address_t *a = 0;
624 for (i = 0; i < vec_len (sm->addresses); i++)
626 a = sm->addresses + i;
628 if (a->addr.as_u32 != addr.as_u32)
633 #define _(N, j, n, s) \
634 case NAT_PROTOCOL_##N: \
635 --a->busy_##n##_port_refcounts[port]; \
638 a->busy_##n##_ports--; \
639 a->busy_##n##_ports_per_thread[ti]--; \
644 default : nat_elog_info (sm, "unknown protocol");
656 nat44_ed_add_resolve_record (ip4_address_t l_addr, u16 l_port, u16 e_port,
657 nat_protocol_t proto, u32 vrf_id, u32 sw_if_index,
658 u32 flags, ip4_address_t pool_addr, u8 *tag)
660 snat_static_map_resolve_t *rp;
661 snat_main_t *sm = &snat_main;
663 vec_add2 (sm->to_resolve, rp, 1);
664 rp->l_addr.as_u32 = l_addr.as_u32;
667 rp->sw_if_index = sw_if_index;
671 rp->pool_addr = pool_addr;
672 rp->tag = vec_dup (tag);
676 nat44_ed_get_resolve_record (ip4_address_t l_addr, u16 l_port, u16 e_port,
677 nat_protocol_t proto, u32 vrf_id, u32 sw_if_index,
680 snat_static_map_resolve_t *rp;
681 snat_main_t *sm = &snat_main;
684 for (i = 0; i < vec_len (sm->to_resolve); i++)
686 rp = sm->to_resolve + i;
688 if (rp->sw_if_index == sw_if_index && rp->vrf_id == vrf_id)
690 if (is_sm_identity_nat (rp->flags) && is_sm_identity_nat (flags))
692 if (!(is_sm_addr_only (rp->flags) && is_sm_addr_only (flags)))
694 if (rp->e_port != e_port || rp->proto != proto)
700 else if (rp->l_addr.as_u32 == l_addr.as_u32)
702 if (!(is_sm_addr_only (rp->flags) && is_sm_addr_only (flags)))
704 if (rp->l_port != l_port || rp->e_port != e_port ||
726 nat44_ed_del_resolve_record (ip4_address_t l_addr, u16 l_port, u16 e_port,
727 nat_protocol_t proto, u32 vrf_id, u32 sw_if_index,
730 snat_main_t *sm = &snat_main;
732 if (!nat44_ed_get_resolve_record (l_addr, l_port, e_port, proto, vrf_id,
733 sw_if_index, flags, &i))
735 vec_del1 (sm->to_resolve, i);
741 static_always_inline int
742 nat44_ed_validate_sm_input (u32 flags)
744 // identity nat can be initiated only from inside interface
745 if (is_sm_identity_nat (flags) && is_sm_out2in_only (flags))
747 return VNET_API_ERROR_UNSUPPORTED;
750 if (is_sm_twice_nat (flags) || is_sm_self_twice_nat (flags))
752 if (is_sm_addr_only (flags) || is_sm_identity_nat (flags))
754 return VNET_API_ERROR_UNSUPPORTED;
761 nat44_ed_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
762 u16 l_port, u16 e_port, nat_protocol_t proto,
763 u32 vrf_id, u32 sw_if_index, u32 flags,
764 ip4_address_t pool_addr, u8 *tag)
766 snat_main_t *sm = &snat_main;
767 clib_bihash_kv_8_8_t kv, value;
768 snat_interface_t *interface;
769 nat44_lb_addr_port_t *local;
770 snat_static_mapping_t *m;
776 return VNET_API_ERROR_UNSUPPORTED;
779 rv = nat44_ed_validate_sm_input (flags);
785 if (is_sm_addr_only (flags))
787 e_port = l_port = proto = 0;
790 if (is_sm_switch_address (flags))
792 // this mapping is interface bound
793 ip4_address_t *first_int_addr;
795 // check if this record isn't registered for resolve
796 if (!nat44_ed_get_resolve_record (l_addr, l_port, e_port, proto, vrf_id,
797 sw_if_index, flags, 0))
799 return VNET_API_ERROR_VALUE_EXIST;
801 // register record for resolve
802 nat44_ed_add_resolve_record (l_addr, l_port, e_port, proto, vrf_id,
803 sw_if_index, flags, pool_addr, tag);
806 ip4_interface_first_address (sm->ip4_main, sw_if_index, 0);
809 // dhcp resolution required
813 e_addr.as_u32 = first_int_addr->as_u32;
816 if (is_sm_identity_nat (flags))
819 l_addr.as_u32 = e_addr.as_u32;
823 init_nat_k (&kv, e_addr, e_port, 0, proto);
825 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
827 m = pool_elt_at_index (sm->static_mappings, value.value);
828 if (!is_sm_identity_nat (m->flags))
830 return VNET_API_ERROR_VALUE_EXIST;
834 // adding local identity nat record for different vrf table
835 pool_foreach (local, m->locals)
837 if (local->vrf_id == vrf_id)
839 return VNET_API_ERROR_VALUE_EXIST;
843 pool_get (m->locals, local);
845 local->vrf_id = vrf_id;
846 local->fib_index = fib_table_find_or_create_and_lock (
847 FIB_PROTOCOL_IP4, vrf_id, sm->fib_src_low);
849 init_nat_kv (&kv, m->local_addr, m->local_port, local->fib_index,
850 m->proto, 0, m - sm->static_mappings);
851 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
858 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
863 // fallback to default vrf
864 vrf_id = sm->inside_vrf_id;
865 fib_index = sm->inside_fib_index;
866 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
869 // test if local mapping record doesn't exist
870 // identity nat supports multiple records in local mapping
871 if (!(is_sm_out2in_only (flags) || is_sm_identity_nat (flags)))
873 init_nat_k (&kv, l_addr, l_port, fib_index, proto);
874 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_local, &kv, &value))
876 return VNET_API_ERROR_VALUE_EXIST;
880 if (!(is_sm_out2in_only (flags) || is_sm_addr_only (flags) ||
881 sm->static_mapping_only))
883 if (nat44_ed_reserve_port (e_addr, e_port, proto))
885 // remove resolve record
886 if (is_sm_switch_address (flags) && !is_sm_identity_nat (flags))
888 nat44_ed_del_resolve_record (l_addr, l_port, e_port, proto,
889 vrf_id, sw_if_index, flags);
891 return VNET_API_ERROR_NO_SUCH_ENTRY;
895 pool_get (sm->static_mappings, m);
896 clib_memset (m, 0, sizeof (*m));
899 m->local_addr = l_addr;
900 m->external_addr = e_addr;
902 m->tag = vec_dup (tag);
904 if (is_sm_exact_address (flags) && is_sm_twice_nat (flags))
906 m->pool_addr = pool_addr;
909 if (!is_sm_addr_only (flags))
911 m->local_port = l_port;
912 m->external_port = e_port;
916 if (is_sm_identity_nat (flags))
918 pool_get (m->locals, local);
920 local->vrf_id = vrf_id;
921 local->fib_index = fib_index;
926 m->fib_index = fib_index;
929 if (!is_sm_out2in_only (flags))
931 init_nat_kv (&kv, m->local_addr, m->local_port, fib_index, m->proto, 0,
932 m - sm->static_mappings);
933 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
936 init_nat_kv (&kv, m->external_addr, m->external_port, 0, m->proto, 0,
937 m - sm->static_mappings);
938 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1);
940 if (sm->num_workers > 1)
942 // store worker index for this record
944 .src_address = m->local_addr,
948 nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index, 0);
949 vec_add1 (m->workers, worker_index);
952 if (is_sm_identity_nat (flags) || !is_sm_addr_only (flags))
955 pool_foreach (interface, sm->interfaces)
957 if (nat_interface_is_inside (interface))
960 snat_add_del_addr_to_fib (&e_addr, 32, interface->sw_if_index, 1);
964 pool_foreach (interface, sm->output_feature_interfaces)
966 if (nat_interface_is_inside (interface))
969 snat_add_del_addr_to_fib (&e_addr, 32, interface->sw_if_index, 1);
977 nat44_ed_del_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
978 u16 l_port, u16 e_port, nat_protocol_t proto,
979 u32 vrf_id, u32 sw_if_index, u32 flags)
981 snat_main_per_thread_data_t *tsm;
982 snat_main_t *sm = &snat_main;
984 clib_bihash_kv_8_8_t kv, value;
985 snat_interface_t *interface;
986 nat44_lb_addr_port_t *local;
987 snat_static_mapping_t *m;
993 return VNET_API_ERROR_UNSUPPORTED;
996 rv = nat44_ed_validate_sm_input (flags);
1002 if (is_sm_addr_only (flags))
1004 e_port = l_port = proto = 0;
1007 if (is_sm_switch_address (flags))
1009 // this mapping is interface bound
1010 ip4_address_t *first_int_addr;
1012 // delete record registered for resolve
1013 if (nat44_ed_del_resolve_record (l_addr, l_port, e_port, proto, vrf_id,
1014 sw_if_index, flags))
1016 return VNET_API_ERROR_NO_SUCH_ENTRY;
1020 ip4_interface_first_address (sm->ip4_main, sw_if_index, 0);
1021 if (!first_int_addr)
1023 // dhcp resolution required
1027 e_addr.as_u32 = first_int_addr->as_u32;
1030 if (is_sm_identity_nat (flags))
1033 l_addr.as_u32 = e_addr.as_u32;
1037 init_nat_k (&kv, e_addr, e_port, 0, proto);
1039 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1041 if (is_sm_switch_address (flags))
1045 return VNET_API_ERROR_NO_SUCH_ENTRY;
1048 m = pool_elt_at_index (sm->static_mappings, value.value);
1050 if (is_sm_identity_nat (flags))
1054 if (!is_sm_switch_address (flags))
1056 vrf_id = sm->inside_vrf_id;
1059 pool_foreach (local, m->locals)
1061 if (local->vrf_id == vrf_id)
1063 local = pool_elt_at_index (m->locals, local - m->locals);
1064 fib_index = local->fib_index;
1065 pool_put (m->locals, local);
1072 return VNET_API_ERROR_NO_SUCH_ENTRY;
1077 fib_index = m->fib_index;
1080 if (!(is_sm_out2in_only (flags) || is_sm_addr_only (flags) ||
1081 sm->static_mapping_only))
1083 if (nat44_ed_free_port (e_addr, e_port, proto))
1085 return VNET_API_ERROR_INVALID_VALUE;
1089 if (!is_sm_out2in_only (flags))
1091 init_nat_k (&kv, l_addr, l_port, fib_index, proto);
1092 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0);
1095 if (!sm->static_mapping_only || sm->static_mapping_connection_tracking)
1097 // delete sessions for static mapping
1098 if (sm->num_workers > 1)
1099 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1101 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1103 nat_ed_static_mapping_del_sessions (
1104 sm, tsm, m->local_addr, m->local_port, m->proto, fib_index,
1105 is_sm_addr_only (flags), e_addr, e_port);
1108 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
1110 if (pool_elts (m->locals))
1114 init_nat_k (&kv, e_addr, e_port, 0, proto);
1115 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0);
1118 vec_free (m->workers);
1119 pool_put (sm->static_mappings, m);
1121 if (is_sm_identity_nat (flags) || !is_sm_addr_only (flags))
1124 pool_foreach (interface, sm->interfaces)
1126 if (nat_interface_is_inside (interface))
1129 snat_add_del_addr_to_fib (&e_addr, 32, interface->sw_if_index, 0);
1133 pool_foreach (interface, sm->output_feature_interfaces)
1135 if (nat_interface_is_inside (interface))
1138 snat_add_del_addr_to_fib (&e_addr, 32, interface->sw_if_index, 0);
1146 nat44_ed_add_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1147 nat_protocol_t proto,
1148 nat44_lb_addr_port_t *locals, u32 flags,
1149 u8 *tag, u32 affinity)
1151 snat_main_t *sm = &snat_main;
1152 snat_static_mapping_t *m;
1153 clib_bihash_kv_8_8_t kv, value;
1154 snat_address_t *a = 0;
1156 nat44_lb_addr_port_t *local;
1163 return VNET_API_ERROR_UNSUPPORTED;
1166 init_nat_k (&kv, e_addr, e_port, 0, proto);
1167 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1170 m = pool_elt_at_index (sm->static_mappings, value.value);
1173 return VNET_API_ERROR_VALUE_EXIST;
1175 if (vec_len (locals) < 2)
1176 return VNET_API_ERROR_INVALID_VALUE;
1178 /* Find external address in allocated addresses and reserve port for
1179 address and port pair mapping when dynamic translations enabled */
1180 if (!(sm->static_mapping_only || is_sm_out2in_only (flags)))
1182 for (i = 0; i < vec_len (sm->addresses); i++)
1184 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1186 a = sm->addresses + i;
1187 /* External port must be unused */
1190 #define _(N, j, n, s) \
1191 case NAT_PROTOCOL_##N: \
1192 if (a->busy_##n##_port_refcounts[e_port]) \
1193 return VNET_API_ERROR_INVALID_VALUE; \
1194 ++a->busy_##n##_port_refcounts[e_port]; \
1195 if (e_port > 1024) \
1197 a->busy_##n##_ports++; \
1198 a->busy_##n##_ports_per_thread[get_thread_idx_by_port (e_port)]++; \
1201 foreach_nat_protocol
1203 default : nat_elog_info (sm, "unknown protocol");
1204 return VNET_API_ERROR_INVALID_VALUE_2;
1209 /* External address must be allocated */
1211 return VNET_API_ERROR_NO_SUCH_ENTRY;
1214 pool_get (sm->static_mappings, m);
1215 clib_memset (m, 0, sizeof (*m));
1216 m->tag = vec_dup (tag);
1217 m->external_addr = e_addr;
1218 m->external_port = e_port;
1219 m->affinity = affinity;
1223 m->flags |= NAT_SM_FLAG_LB;
1226 m->affinity_per_service_list_head_index =
1227 nat_affinity_get_per_service_list_head_index ();
1229 m->affinity_per_service_list_head_index = ~0;
1231 init_nat_kv (&kv, m->external_addr, m->external_port, 0, m->proto, 0,
1232 m - sm->static_mappings);
1233 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1))
1235 nat_elog_err (sm, "static_mapping_by_external key add failed");
1236 return VNET_API_ERROR_UNSPECIFIED;
1239 for (i = 0; i < vec_len (locals); i++)
1241 locals[i].fib_index = fib_table_find_or_create_and_lock (
1242 FIB_PROTOCOL_IP4, locals[i].vrf_id, sm->fib_src_low);
1243 if (!is_sm_out2in_only (flags))
1245 init_nat_kv (&kv, locals[i].addr, locals[i].port,
1246 locals[i].fib_index, m->proto, 0,
1247 m - sm->static_mappings);
1248 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1250 locals[i].prefix = (i == 0) ?
1251 locals[i].probability :
1252 (locals[i - 1].prefix + locals[i].probability);
1253 pool_get (m->locals, local);
1255 if (sm->num_workers > 1)
1258 .src_address = locals[i].addr,
1260 bitmap = clib_bitmap_set (
1261 bitmap, nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index, 0),
1266 /* Assign workers */
1267 if (sm->num_workers > 1)
1269 clib_bitmap_foreach (i, bitmap)
1271 vec_add1 (m->workers, i);
1279 nat44_ed_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1280 nat_protocol_t proto, u32 flags)
1282 snat_main_t *sm = &snat_main;
1283 snat_static_mapping_t *m;
1284 clib_bihash_kv_8_8_t kv, value;
1285 snat_address_t *a = 0;
1287 nat44_lb_addr_port_t *local;
1288 snat_main_per_thread_data_t *tsm;
1294 return VNET_API_ERROR_UNSUPPORTED;
1297 init_nat_k (&kv, e_addr, e_port, 0, proto);
1298 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1301 m = pool_elt_at_index (sm->static_mappings, value.value);
1304 return VNET_API_ERROR_NO_SUCH_ENTRY;
1306 if (!is_sm_lb (m->flags))
1307 return VNET_API_ERROR_INVALID_VALUE;
1309 /* Free external address port */
1310 if (!(sm->static_mapping_only || is_sm_out2in_only (flags)))
1312 for (i = 0; i < vec_len (sm->addresses); i++)
1314 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1316 a = sm->addresses + i;
1319 #define _(N, j, n, s) \
1320 case NAT_PROTOCOL_##N: \
1321 --a->busy_##n##_port_refcounts[e_port]; \
1322 if (e_port > 1024) \
1324 a->busy_##n##_ports--; \
1325 a->busy_##n##_ports_per_thread[get_thread_idx_by_port (e_port)]--; \
1328 foreach_nat_protocol
1330 default : nat_elog_info (sm, "unknown protocol");
1331 return VNET_API_ERROR_INVALID_VALUE_2;
1338 init_nat_k (&kv, m->external_addr, m->external_port, 0, m->proto);
1339 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0))
1341 nat_elog_err (sm, "static_mapping_by_external key del failed");
1342 return VNET_API_ERROR_UNSPECIFIED;
1345 pool_foreach (local, m->locals)
1347 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
1348 if (!is_sm_out2in_only (flags))
1350 init_nat_k (&kv, local->addr, local->port, local->fib_index,
1352 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0))
1354 nat_elog_err (sm, "static_mapping_by_local key del failed");
1355 return VNET_API_ERROR_UNSPECIFIED;
1359 if (sm->num_workers > 1)
1362 .src_address = local->addr,
1364 tsm = vec_elt_at_index (
1365 sm->per_thread_data,
1366 nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index, 0));
1369 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1371 /* Delete sessions */
1372 pool_foreach (s, tsm->sessions)
1374 if (!(is_lb_session (s)))
1377 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1378 s->in2out.port != local->port)
1381 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1382 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
1388 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1391 pool_free (m->locals);
1393 vec_free (m->workers);
1394 pool_put (sm->static_mappings, m);
1400 nat44_ed_add_del_lb_static_mapping_local (ip4_address_t e_addr, u16 e_port,
1401 ip4_address_t l_addr, u16 l_port,
1402 nat_protocol_t proto, u32 vrf_id,
1403 u8 probability, u8 is_add)
1405 snat_main_t *sm = &snat_main;
1406 snat_static_mapping_t *m = 0;
1407 clib_bihash_kv_8_8_t kv, value;
1408 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1409 snat_main_per_thread_data_t *tsm;
1417 return VNET_API_ERROR_UNSUPPORTED;
1420 init_nat_k (&kv, e_addr, e_port, 0, proto);
1421 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1422 m = pool_elt_at_index (sm->static_mappings, value.value);
1425 return VNET_API_ERROR_NO_SUCH_ENTRY;
1427 if (!is_sm_lb (m->flags))
1428 return VNET_API_ERROR_INVALID_VALUE;
1430 pool_foreach (local, m->locals)
1432 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1433 (local->vrf_id == vrf_id))
1435 match_local = local;
1443 return VNET_API_ERROR_VALUE_EXIST;
1445 pool_get (m->locals, local);
1446 clib_memset (local, 0, sizeof (*local));
1447 local->addr.as_u32 = l_addr.as_u32;
1448 local->port = l_port;
1449 local->probability = probability;
1450 local->vrf_id = vrf_id;
1452 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1455 if (!is_sm_out2in_only (m->flags))
1457 init_nat_kv (&kv, l_addr, l_port, local->fib_index, proto, 0,
1458 m - sm->static_mappings);
1459 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1))
1460 nat_elog_err (sm, "static_mapping_by_local key add failed");
1466 return VNET_API_ERROR_NO_SUCH_ENTRY;
1468 if (pool_elts (m->locals) < 3)
1469 return VNET_API_ERROR_UNSPECIFIED;
1471 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1474 if (!is_sm_out2in_only (m->flags))
1476 init_nat_k (&kv, l_addr, l_port, match_local->fib_index, proto);
1477 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0))
1478 nat_elog_err (sm, "static_mapping_by_local key del failed");
1481 if (sm->num_workers > 1)
1484 .src_address = local->addr,
1486 tsm = vec_elt_at_index (
1487 sm->per_thread_data,
1488 nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index, 0));
1491 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1493 /* Delete sessions */
1494 pool_foreach (s, tsm->sessions) {
1495 if (!(is_lb_session (s)))
1498 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1499 s->in2out.port != match_local->port)
1502 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1503 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
1506 pool_put (m->locals, match_local);
1509 vec_free (m->workers);
1511 pool_foreach (local, m->locals)
1513 vec_add1 (locals, local - m->locals);
1514 if (sm->num_workers > 1)
1517 ip.src_address.as_u32 = local->addr.as_u32,
1518 bitmap = clib_bitmap_set (
1520 nat44_ed_get_in2out_worker_index (0, &ip, local->fib_index, 0), 1);
1524 ASSERT (vec_len (locals) > 1);
1526 local = pool_elt_at_index (m->locals, locals[0]);
1527 local->prefix = local->probability;
1528 for (i = 1; i < vec_len (locals); i++)
1530 local = pool_elt_at_index (m->locals, locals[i]);
1531 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1532 local->prefix = local->probability + prev_local->prefix;
1535 /* Assign workers */
1536 if (sm->num_workers > 1)
1538 clib_bitmap_foreach (i, bitmap) { vec_add1(m->workers, i); }
1545 expire_per_vrf_sessions (u32 fib_index)
1547 per_vrf_sessions_t *per_vrf_sessions;
1548 snat_main_per_thread_data_t *tsm;
1549 snat_main_t *sm = &snat_main;
1551 vec_foreach (tsm, sm->per_thread_data)
1553 vec_foreach (per_vrf_sessions, tsm->per_vrf_sessions_vec)
1555 if ((per_vrf_sessions->rx_fib_index == fib_index) ||
1556 (per_vrf_sessions->tx_fib_index == fib_index))
1558 per_vrf_sessions->expired = 1;
1565 update_per_vrf_sessions_vec (u32 fib_index, int is_del)
1567 snat_main_t *sm = &snat_main;
1570 // we don't care if it is outside/inside fib
1571 // we just care about their ref_count
1572 // if it reaches 0 sessions should expire
1573 // because the fib isn't valid for NAT anymore
1575 vec_foreach (fib, sm->fibs)
1577 if (fib->fib_index == fib_index)
1582 if (!fib->ref_count)
1584 vec_del1 (sm->fibs, fib - sm->fibs);
1585 expire_per_vrf_sessions (fib_index);
1595 vec_add2 (sm->fibs, fib, 1);
1597 fib->fib_index = fib_index;
1601 static_always_inline nat_outside_fib_t *
1602 nat44_ed_get_outside_fib (nat_outside_fib_t *outside_fibs, u32 fib_index)
1604 nat_outside_fib_t *f;
1605 vec_foreach (f, outside_fibs)
1607 if (f->fib_index == fib_index)
1615 static_always_inline snat_interface_t *
1616 nat44_ed_get_interface (snat_interface_t *interfaces, u32 sw_if_index)
1618 snat_interface_t *i;
1619 pool_foreach (i, interfaces)
1621 if (i->sw_if_index == sw_if_index)
1630 nat44_ed_add_interface (u32 sw_if_index, u8 is_inside)
1632 const char *del_feature_name, *feature_name;
1633 snat_main_t *sm = &snat_main;
1635 nat_outside_fib_t *outside_fib;
1636 snat_static_mapping_t *m;
1637 snat_interface_t *i;
1644 nat_log_err ("nat44 is disabled");
1645 return VNET_API_ERROR_UNSUPPORTED;
1648 if (nat44_ed_get_interface (sm->output_feature_interfaces, sw_if_index))
1650 nat_log_err ("error interface already configured");
1651 return VNET_API_ERROR_VALUE_EXIST;
1654 i = nat44_ed_get_interface (sm->interfaces, sw_if_index);
1657 if ((nat_interface_is_inside (i) && is_inside) ||
1658 (nat_interface_is_outside (i) && !is_inside))
1662 if (sm->num_workers > 1)
1664 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1665 "nat44-out2in-worker-handoff";
1666 feature_name = "nat44-handoff-classify";
1670 del_feature_name = !is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1672 feature_name = "nat44-ed-classify";
1675 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1678 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1679 sw_if_index, 0, 0, 0);
1680 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1,
1685 if (sm->num_workers > 1)
1687 feature_name = is_inside ? "nat44-in2out-worker-handoff" :
1688 "nat44-out2in-worker-handoff";
1692 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1695 nat_validate_interface_counters (sm, sw_if_index);
1696 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1699 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1,
1702 pool_get (sm->interfaces, i);
1703 i->sw_if_index = sw_if_index;
1708 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
1710 update_per_vrf_sessions_vec (fib_index, 0 /*is_del*/);
1714 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1716 outside_fib = nat44_ed_get_outside_fib (sm->outside_fibs, fib_index);
1719 outside_fib->refcount++;
1723 vec_add2 (sm->outside_fibs, outside_fib, 1);
1724 outside_fib->fib_index = fib_index;
1725 outside_fib->refcount = 1;
1728 vec_foreach (ap, sm->addresses)
1730 snat_add_del_addr_to_fib (&ap->addr, 32, sw_if_index, 1);
1732 pool_foreach (m, sm->static_mappings)
1734 if (!(is_sm_addr_only (m->flags)) ||
1735 (m->local_addr.as_u32 == m->external_addr.as_u32))
1739 snat_add_del_addr_to_fib (&m->external_addr, 32, sw_if_index, 1);
1744 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1751 nat44_ed_del_interface (u32 sw_if_index, u8 is_inside)
1753 const char *del_feature_name, *feature_name;
1754 snat_main_t *sm = &snat_main;
1756 nat_outside_fib_t *outside_fib;
1757 snat_static_mapping_t *m;
1758 snat_interface_t *i;
1765 nat_log_err ("nat44 is disabled");
1766 return VNET_API_ERROR_UNSUPPORTED;
1769 i = nat44_ed_get_interface (sm->interfaces, sw_if_index);
1772 nat_log_err ("error interface couldn't be found");
1773 return VNET_API_ERROR_NO_SUCH_ENTRY;
1776 if (nat_interface_is_inside (i) && nat_interface_is_outside (i))
1778 if (sm->num_workers > 1)
1780 del_feature_name = "nat44-handoff-classify";
1781 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1782 "nat44-out2in-worker-handoff";
1786 del_feature_name = "nat44-ed-classify";
1787 feature_name = !is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1790 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1795 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1796 sw_if_index, 0, 0, 0);
1797 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1,
1802 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1806 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1811 if (sm->num_workers > 1)
1813 feature_name = is_inside ? "nat44-in2out-worker-handoff" :
1814 "nat44-out2in-worker-handoff";
1818 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1821 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1826 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 0,
1830 pool_put (sm->interfaces, i);
1834 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
1836 update_per_vrf_sessions_vec (fib_index, 1 /*is_del*/);
1840 outside_fib = nat44_ed_get_outside_fib (sm->outside_fibs, fib_index);
1843 outside_fib->refcount--;
1844 if (!outside_fib->refcount)
1846 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1850 vec_foreach (ap, sm->addresses)
1852 snat_add_del_addr_to_fib (&ap->addr, 32, sw_if_index, 0);
1855 pool_foreach (m, sm->static_mappings)
1857 if (!(is_sm_addr_only (m->flags)) ||
1858 (m->local_addr.as_u32 == m->external_addr.as_u32))
1862 snat_add_del_addr_to_fib (&m->external_addr, 32, sw_if_index, 0);
1870 nat44_ed_add_output_interface (u32 sw_if_index)
1872 snat_main_t *sm = &snat_main;
1874 nat_outside_fib_t *outside_fib;
1875 snat_static_mapping_t *m;
1876 snat_interface_t *i;
1883 nat_log_err ("nat44 is disabled");
1884 return VNET_API_ERROR_UNSUPPORTED;
1887 if (nat44_ed_get_interface (sm->interfaces, sw_if_index))
1889 nat_log_err ("error interface already configured");
1890 return VNET_API_ERROR_VALUE_EXIST;
1893 if (nat44_ed_get_interface (sm->output_feature_interfaces, sw_if_index))
1895 nat_log_err ("error interface already configured");
1896 return VNET_API_ERROR_VALUE_EXIST;
1899 if (sm->num_workers > 1)
1901 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1907 rv = ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, 1);
1913 vnet_feature_enable_disable (
1914 "ip4-unicast", "nat44-out2in-worker-handoff", sw_if_index, 1, 0, 0);
1915 vnet_feature_enable_disable ("ip4-output",
1916 "nat44-in2out-output-worker-handoff",
1917 sw_if_index, 1, 0, 0);
1921 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1927 rv = ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, 1);
1933 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
1934 sw_if_index, 1, 0, 0);
1935 vnet_feature_enable_disable ("ip4-output", "nat-pre-in2out-output",
1936 sw_if_index, 1, 0, 0);
1939 nat_validate_interface_counters (sm, sw_if_index);
1941 pool_get (sm->output_feature_interfaces, i);
1942 i->sw_if_index = sw_if_index;
1944 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1945 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1948 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
1949 update_per_vrf_sessions_vec (fib_index, 0 /*is_del*/);
1951 outside_fib = nat44_ed_get_outside_fib (sm->outside_fibs, fib_index);
1954 outside_fib->refcount++;
1958 vec_add2 (sm->outside_fibs, outside_fib, 1);
1959 outside_fib->fib_index = fib_index;
1960 outside_fib->refcount = 1;
1963 vec_foreach (ap, sm->addresses)
1965 snat_add_del_addr_to_fib (&ap->addr, 32, sw_if_index, 1);
1968 pool_foreach (m, sm->static_mappings)
1970 if (!((is_sm_addr_only (m->flags))) ||
1971 (m->local_addr.as_u32 == m->external_addr.as_u32))
1975 snat_add_del_addr_to_fib (&m->external_addr, 32, sw_if_index, 1);
1982 nat44_ed_del_output_interface (u32 sw_if_index)
1984 snat_main_t *sm = &snat_main;
1986 nat_outside_fib_t *outside_fib;
1987 snat_static_mapping_t *m;
1988 snat_interface_t *i;
1995 nat_log_err ("nat44 is disabled");
1996 return VNET_API_ERROR_UNSUPPORTED;
1999 i = nat44_ed_get_interface (sm->output_feature_interfaces, sw_if_index);
2002 nat_log_err ("error interface couldn't be found");
2003 return VNET_API_ERROR_NO_SUCH_ENTRY;
2006 if (sm->num_workers > 1)
2008 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2014 rv = ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, 0);
2020 vnet_feature_enable_disable (
2021 "ip4-unicast", "nat44-out2in-worker-handoff", sw_if_index, 0, 0, 0);
2022 vnet_feature_enable_disable ("ip4-output",
2023 "nat44-in2out-output-worker-handoff",
2024 sw_if_index, 0, 0, 0);
2028 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2034 rv = ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, 0);
2040 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
2041 sw_if_index, 0, 0, 0);
2042 vnet_feature_enable_disable ("ip4-output", "nat-pre-in2out-output",
2043 sw_if_index, 0, 0, 0);
2047 pool_put (sm->output_feature_interfaces, i);
2050 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
2051 update_per_vrf_sessions_vec (fib_index, 1 /*is_del*/);
2053 outside_fib = nat44_ed_get_outside_fib (sm->outside_fibs, fib_index);
2056 outside_fib->refcount--;
2057 if (!outside_fib->refcount)
2059 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2063 vec_foreach (ap, sm->addresses)
2065 snat_add_del_addr_to_fib (&ap->addr, 32, sw_if_index, 0);
2068 pool_foreach (m, sm->static_mappings)
2070 if (!((is_sm_addr_only (m->flags))) ||
2071 (m->local_addr.as_u32 == m->external_addr.as_u32))
2075 snat_add_del_addr_to_fib (&m->external_addr, 32, sw_if_index, 0);
2082 snat_set_workers (uword * bitmap)
2084 snat_main_t *sm = &snat_main;
2087 if (sm->num_workers < 2)
2088 return VNET_API_ERROR_FEATURE_DISABLED;
2090 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2091 return VNET_API_ERROR_INVALID_WORKER;
2093 vec_free (sm->workers);
2094 clib_bitmap_foreach (i, bitmap)
2096 vec_add1(sm->workers, i);
2097 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2098 sm->per_thread_data[sm->first_worker_index + i].thread_index = i;
2102 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
2108 nat44_ed_set_frame_queue_nelts (u32 frame_queue_nelts)
2111 snat_main_t *sm = &snat_main;
2112 sm->frame_queue_nelts = frame_queue_nelts;
2117 nat44_ed_update_outside_fib_cb (ip4_main_t *im, uword opaque, u32 sw_if_index,
2118 u32 new_fib_index, u32 old_fib_index)
2120 snat_main_t *sm = &snat_main;
2121 nat_outside_fib_t *outside_fib;
2122 snat_interface_t *i;
2126 if (!sm->enabled || (new_fib_index == old_fib_index)
2127 || (!vec_len (sm->outside_fibs)))
2132 pool_foreach (i, sm->interfaces)
2134 if (i->sw_if_index == sw_if_index)
2136 if (!(nat_interface_is_outside (i)))
2142 pool_foreach (i, sm->output_feature_interfaces)
2144 if (i->sw_if_index == sw_if_index)
2146 if (!(nat_interface_is_outside (i)))
2155 vec_foreach (outside_fib, sm->outside_fibs)
2157 if (outside_fib->fib_index == old_fib_index)
2159 outside_fib->refcount--;
2160 if (!outside_fib->refcount)
2161 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2166 vec_foreach (outside_fib, sm->outside_fibs)
2168 if (outside_fib->fib_index == new_fib_index)
2170 outside_fib->refcount++;
2178 vec_add2 (sm->outside_fibs, outside_fib, 1);
2179 outside_fib->refcount = 1;
2180 outside_fib->fib_index = new_fib_index;
2184 static void nat44_ed_update_outside_fib_cb (ip4_main_t *im, uword opaque,
2185 u32 sw_if_index, u32 new_fib_index,
2188 static void nat44_ed_add_del_interface_address_cb (
2189 ip4_main_t *im, uword opaque, u32 sw_if_index, ip4_address_t *address,
2190 u32 address_length, u32 if_address_index, u32 is_delete);
2192 static void nat44_ed_add_del_sm_addr_only_cb (
2193 ip4_main_t *im, uword opaque, u32 sw_if_index, ip4_address_t *address,
2194 u32 address_length, u32 if_address_index, u32 is_delete);
2197 test_key_calc_split ()
2199 ip4_address_t l_addr;
2200 l_addr.as_u8[0] = 1;
2201 l_addr.as_u8[1] = 1;
2202 l_addr.as_u8[2] = 1;
2203 l_addr.as_u8[3] = 1;
2204 ip4_address_t r_addr;
2205 r_addr.as_u8[0] = 2;
2206 r_addr.as_u8[1] = 2;
2207 r_addr.as_u8[2] = 2;
2208 r_addr.as_u8[3] = 2;
2212 u32 fib_index = 9000001;
2213 u32 thread_index = 3000000001;
2214 u32 session_index = 3000000221;
2215 clib_bihash_kv_16_8_t kv;
2216 init_ed_kv (&kv, l_addr, l_port, r_addr, r_port, fib_index, proto,
2217 thread_index, session_index);
2218 ip4_address_t l_addr2;
2219 ip4_address_t r_addr2;
2220 clib_memset (&l_addr2, 0, sizeof (l_addr2));
2221 clib_memset (&r_addr2, 0, sizeof (r_addr2));
2226 split_ed_kv (&kv, &l_addr2, &r_addr2, &proto2, &fib_index2, &l_port2,
2228 ASSERT (l_addr.as_u32 == l_addr2.as_u32);
2229 ASSERT (r_addr.as_u32 == r_addr2.as_u32);
2230 ASSERT (l_port == l_port2);
2231 ASSERT (r_port == r_port2);
2232 ASSERT (proto == proto2);
2233 ASSERT (fib_index == fib_index2);
2234 ASSERT (thread_index == ed_value_get_thread_index (&kv));
2235 ASSERT (session_index == ed_value_get_session_index (&kv));
2239 nat_protocol_t proto3 = ~0;
2240 u64 key = calc_nat_key (l_addr, l_port, fib_index, proto);
2241 split_nat_key (key, &l_addr2, &l_port2, &fib_index2, &proto3);
2242 ASSERT (l_addr.as_u32 == l_addr2.as_u32);
2243 ASSERT (l_port == l_port2);
2244 ASSERT (proto == proto3);
2245 ASSERT (fib_index == fib_index2);
2248 static clib_error_t *
2249 nat_ip_table_add_del (vnet_main_t * vnm, u32 table_id, u32 is_add)
2254 fib_index = ip4_fib_index_from_table_id (table_id);
2255 if (fib_index != ~0)
2257 expire_per_vrf_sessions (fib_index);
2263 VNET_IP_TABLE_ADD_DEL_FUNCTION (nat_ip_table_add_del);
2266 nat44_set_node_indexes (snat_main_t * sm, vlib_main_t * vm)
2270 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in");
2271 sm->out2in_node_index = node->index;
2273 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out");
2274 sm->in2out_node_index = node->index;
2276 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-output");
2277 sm->in2out_output_node_index = node->index;
2280 #define nat_validate_simple_counter(c, i) \
2283 vlib_validate_simple_counter (&c, i); \
2284 vlib_zero_simple_counter (&c, i); \
2288 #define nat_init_simple_counter(c, n, sn) \
2292 c.stat_segment_name = sn; \
2293 nat_validate_simple_counter (c, 0); \
2297 static_always_inline void
2298 nat_validate_interface_counters (snat_main_t *sm, u32 sw_if_index)
2301 nat_validate_simple_counter (sm->counters.fastpath.in2out.x, sw_if_index); \
2302 nat_validate_simple_counter (sm->counters.fastpath.out2in.x, sw_if_index); \
2303 nat_validate_simple_counter (sm->counters.slowpath.in2out.x, sw_if_index); \
2304 nat_validate_simple_counter (sm->counters.slowpath.out2in.x, sw_if_index);
2305 foreach_nat_counter;
2307 nat_validate_simple_counter (sm->counters.hairpinning, sw_if_index);
2310 static clib_error_t *
2311 nat_init (vlib_main_t * vm)
2313 snat_main_t *sm = &snat_main;
2314 vlib_thread_main_t *tm = vlib_get_thread_main ();
2315 vlib_thread_registration_t *tr;
2316 ip4_add_del_interface_address_callback_t cbi = { 0 };
2317 ip4_table_bind_callback_t cbt = { 0 };
2318 u32 i, num_threads = 0;
2319 uword *p, *bitmap = 0;
2321 clib_memset (sm, 0, sizeof (*sm));
2324 sm->vnet_main = vnet_get_main ();
2326 sm->ip4_main = &ip4_main;
2327 sm->api_main = vlibapi_get_main ();
2328 sm->ip4_lookup_main = &ip4_main.lookup_main;
2330 // frame queue indices used for handoff
2331 sm->fq_out2in_index = ~0;
2332 sm->fq_in2out_index = ~0;
2333 sm->fq_in2out_output_index = ~0;
2335 sm->log_level = NAT_LOG_ERROR;
2337 nat44_set_node_indexes (sm, vm);
2339 sm->log_class = vlib_log_register_class ("nat", 0);
2340 nat_ipfix_logging_init (vm);
2342 nat_init_simple_counter (sm->total_sessions, "total-sessions",
2343 "/nat44-ed/total-sessions");
2344 sm->max_cfg_sessions_gauge = stat_segment_new_entry (
2345 (u8 *) "/nat44-ed/max-cfg-sessions", STAT_DIR_TYPE_SCALAR_INDEX);
2348 nat_init_simple_counter (sm->counters.fastpath.in2out.x, #x, \
2349 "/nat44-ed/in2out/fastpath/" #x); \
2350 nat_init_simple_counter (sm->counters.fastpath.out2in.x, #x, \
2351 "/nat44-ed/out2in/fastpath/" #x); \
2352 nat_init_simple_counter (sm->counters.slowpath.in2out.x, #x, \
2353 "/nat44-ed/in2out/slowpath/" #x); \
2354 nat_init_simple_counter (sm->counters.slowpath.out2in.x, #x, \
2355 "/nat44-ed/out2in/slowpath/" #x);
2356 foreach_nat_counter;
2358 nat_init_simple_counter (sm->counters.hairpinning, "hairpinning",
2359 "/nat44-ed/hairpinning");
2361 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2364 tr = (vlib_thread_registration_t *) p[0];
2367 sm->num_workers = tr->count;
2368 sm->first_worker_index = tr->first_index;
2371 num_threads = tm->n_vlib_mains - 1;
2372 sm->port_per_thread = 0xffff - 1024;
2373 vec_validate (sm->per_thread_data, num_threads);
2375 /* Use all available workers by default */
2376 if (sm->num_workers > 1)
2378 for (i = 0; i < sm->num_workers; i++)
2379 bitmap = clib_bitmap_set (bitmap, i, 1);
2380 snat_set_workers (bitmap);
2381 clib_bitmap_free (bitmap);
2385 sm->per_thread_data[0].snat_thread_index = 0;
2388 /* callbacks to call when interface address changes. */
2389 cbi.function = nat44_ed_add_del_interface_address_cb;
2390 vec_add1 (sm->ip4_main->add_del_interface_address_callbacks, cbi);
2391 cbi.function = nat44_ed_add_del_sm_addr_only_cb;
2392 vec_add1 (sm->ip4_main->add_del_interface_address_callbacks, cbi);
2394 /* callbacks to call when interface to table biding changes */
2395 cbt.function = nat44_ed_update_outside_fib_cb;
2396 vec_add1 (sm->ip4_main->table_bind_callbacks, cbt);
2399 fib_source_allocate ("nat-low", FIB_SOURCE_PRIORITY_LOW,
2400 FIB_SOURCE_BH_SIMPLE);
2402 fib_source_allocate ("nat-hi", FIB_SOURCE_PRIORITY_HI,
2403 FIB_SOURCE_BH_SIMPLE);
2405 nat_affinity_init (vm);
2406 test_key_calc_split ();
2408 return nat44_api_hookup (vm);
2411 VLIB_INIT_FUNCTION (nat_init);
2414 nat44_plugin_enable (nat44_config_t c)
2416 snat_main_t *sm = &snat_main;
2420 if (c.static_mapping_only && !c.connection_tracking)
2422 nat_log_err ("unsupported combination of configuration");
2426 sm->static_mapping_only = c.static_mapping_only;
2427 sm->static_mapping_connection_tracking = c.connection_tracking;
2429 sm->forwarding_enabled = 0;
2430 sm->mss_clamping = 0;
2431 sm->pat = (!c.static_mapping_only ||
2432 (c.static_mapping_only && c.connection_tracking));
2435 c.sessions = 63 * 1024;
2437 sm->max_translations_per_thread = c.sessions;
2438 stat_segment_set_state_counter (sm->max_cfg_sessions_gauge,
2439 sm->max_translations_per_thread);
2440 sm->translation_buckets = nat_calc_bihash_buckets (c.sessions);
2442 vec_add1 (sm->max_translations_per_fib, sm->max_translations_per_thread);
2444 sm->inside_vrf_id = c.inside_vrf;
2445 sm->inside_fib_index =
2446 fib_table_find_or_create_and_lock
2447 (FIB_PROTOCOL_IP4, c.inside_vrf, sm->fib_src_hi);
2449 sm->outside_vrf_id = c.outside_vrf;
2450 sm->outside_fib_index = fib_table_find_or_create_and_lock (
2451 FIB_PROTOCOL_IP4, c.outside_vrf, sm->fib_src_hi);
2453 nat44_ed_db_init (sm->max_translations_per_thread, sm->translation_buckets);
2455 nat_affinity_enable ();
2457 nat_reset_timeouts (&sm->timeouts);
2459 vlib_zero_simple_counter (&sm->total_sessions, 0);
2461 if (!sm->frame_queue_nelts)
2463 sm->frame_queue_nelts = NAT_FQ_NELTS_DEFAULT;
2466 if (sm->num_workers > 1)
2468 if (sm->fq_in2out_index == ~0)
2470 sm->fq_in2out_index = vlib_frame_queue_main_init (
2471 sm->in2out_node_index, sm->frame_queue_nelts);
2473 if (sm->fq_out2in_index == ~0)
2475 sm->fq_out2in_index = vlib_frame_queue_main_init (
2476 sm->out2in_node_index, sm->frame_queue_nelts);
2478 if (sm->fq_in2out_output_index == ~0)
2480 sm->fq_in2out_output_index = vlib_frame_queue_main_init (
2481 sm->in2out_output_node_index, sm->frame_queue_nelts);
2492 nat44_addresses_free (snat_address_t ** addresses)
2495 vec_foreach (ap, *addresses)
2497 #define _(N, i, n, s) \
2498 vec_free (ap->busy_##n##_ports_per_thread);
2499 foreach_nat_protocol
2502 vec_free (*addresses);
2507 nat44_plugin_disable ()
2509 snat_main_t *sm = &snat_main;
2510 snat_interface_t *i, *pool;
2513 fail_if_disabled ();
2515 pool = pool_dup (sm->interfaces);
2516 pool_foreach (i, pool)
2518 if (nat_interface_is_inside (i))
2520 error = nat44_ed_del_interface (i->sw_if_index, 1);
2522 if (nat_interface_is_outside (i))
2524 error = nat44_ed_del_interface (i->sw_if_index, 0);
2528 nat_log_err ("error occurred while removing interface %u",
2532 pool_free (sm->interfaces);
2536 pool = pool_dup (sm->output_feature_interfaces);
2537 pool_foreach (i, pool)
2539 error = nat44_ed_del_output_interface (i->sw_if_index);
2542 nat_log_err ("error occurred while removing interface %u",
2546 pool_free (sm->output_feature_interfaces);
2548 sm->output_feature_interfaces = 0;
2550 vec_free (sm->max_translations_per_fib);
2552 nat44_ed_db_free ();
2554 nat44_addresses_free (&sm->addresses);
2555 nat44_addresses_free (&sm->twice_nat_addresses);
2557 vec_free (sm->to_resolve);
2558 vec_free (sm->auto_add_sw_if_indices);
2559 vec_free (sm->auto_add_sw_if_indices_twice_nat);
2562 sm->auto_add_sw_if_indices = 0;
2563 sm->auto_add_sw_if_indices_twice_nat = 0;
2565 sm->forwarding_enabled = 0;
2568 clib_memset (&sm->rconfig, 0, sizeof (sm->rconfig));
2574 nat44_ed_forwarding_enable_disable (u8 is_enable)
2576 snat_main_per_thread_data_t *tsm;
2577 snat_main_t *sm = &snat_main;
2580 u32 *ses_to_be_removed = 0, *ses_index;
2582 sm->forwarding_enabled = is_enable != 0;
2584 if (!sm->enabled || is_enable)
2589 vec_foreach (tsm, sm->per_thread_data)
2591 pool_foreach (s, tsm->sessions)
2593 if (is_fwd_bypass_session (s))
2595 vec_add1 (ses_to_be_removed, s - tsm->sessions);
2598 vec_foreach (ses_index, ses_to_be_removed)
2600 s = pool_elt_at_index (tsm->sessions, ses_index[0]);
2601 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
2602 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
2605 vec_free (ses_to_be_removed);
2610 snat_free_outside_address_and_port (snat_address_t *addresses,
2611 u32 thread_index, ip4_address_t *addr,
2612 u16 port, nat_protocol_t protocol)
2614 snat_main_t *sm = &snat_main;
2617 u16 port_host_byte_order = clib_net_to_host_u16 (port);
2619 for (address_index = 0; address_index < vec_len (addresses);
2622 if (addresses[address_index].addr.as_u32 == addr->as_u32)
2626 ASSERT (address_index < vec_len (addresses));
2628 a = addresses + address_index;
2632 #define _(N, i, n, s) \
2633 case NAT_PROTOCOL_##N: \
2634 ASSERT (a->busy_##n##_port_refcounts[port_host_byte_order] >= 1); \
2635 --a->busy_##n##_port_refcounts[port_host_byte_order]; \
2636 a->busy_##n##_ports--; \
2637 a->busy_##n##_ports_per_thread[thread_index]--; \
2639 foreach_nat_protocol
2641 default : nat_elog_info (sm, "unknown protocol");
2647 snat_static_mapping_match (vlib_main_t *vm, snat_main_t *sm,
2648 ip4_address_t match_addr, u16 match_port,
2649 u32 match_fib_index, nat_protocol_t match_protocol,
2650 ip4_address_t *mapping_addr, u16 *mapping_port,
2651 u32 *mapping_fib_index, u8 by_external,
2652 u8 *is_addr_only, twice_nat_type_t *twice_nat,
2653 lb_nat_type_t *lb, ip4_address_t *ext_host_addr,
2654 u8 *is_identity_nat, snat_static_mapping_t **out)
2656 clib_bihash_kv_8_8_t kv, value;
2657 clib_bihash_8_8_t *mapping_hash;
2658 snat_static_mapping_t *m;
2659 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2660 nat44_lb_addr_port_t *local;
2665 mapping_hash = &sm->static_mapping_by_local;
2666 init_nat_k (&kv, match_addr, match_port, match_fib_index,
2668 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2670 /* Try address only mapping */
2671 init_nat_k (&kv, match_addr, 0, match_fib_index, 0);
2672 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2678 mapping_hash = &sm->static_mapping_by_external;
2679 init_nat_k (&kv, match_addr, match_port, 0, match_protocol);
2680 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2682 /* Try address only mapping */
2683 init_nat_k (&kv, match_addr, 0, 0, 0);
2684 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2689 m = pool_elt_at_index (sm->static_mappings, value.value);
2693 if (is_sm_lb (m->flags))
2695 if (PREDICT_FALSE (lb != 0))
2696 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2697 if (m->affinity && !nat_affinity_find_and_lock (
2698 vm, ext_host_addr[0], match_addr,
2699 match_protocol, match_port, &backend_index))
2701 local = pool_elt_at_index (m->locals, backend_index);
2702 *mapping_addr = local->addr;
2703 *mapping_port = local->port;
2704 *mapping_fib_index = local->fib_index;
2707 // pick locals matching this worker
2708 if (PREDICT_FALSE (sm->num_workers > 1))
2710 u32 thread_index = vlib_get_thread_index ();
2711 pool_foreach_index (i, m->locals)
2713 local = pool_elt_at_index (m->locals, i);
2716 .src_address = local->addr,
2719 if (nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index,
2725 ASSERT (vec_len (tmp) != 0);
2729 pool_foreach_index (i, m->locals)
2734 hi = vec_len (tmp) - 1;
2735 local = pool_elt_at_index (m->locals, tmp[hi]);
2736 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2739 mid = ((hi - lo) >> 1) + lo;
2740 local = pool_elt_at_index (m->locals, tmp[mid]);
2741 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2743 local = pool_elt_at_index (m->locals, tmp[lo]);
2744 if (!(local->prefix >= rand))
2746 *mapping_addr = local->addr;
2747 *mapping_port = local->port;
2748 *mapping_fib_index = local->fib_index;
2751 if (nat_affinity_create_and_lock (ext_host_addr[0], match_addr,
2752 match_protocol, match_port,
2753 tmp[lo], m->affinity,
2754 m->affinity_per_service_list_head_index))
2755 nat_elog_info (sm, "create affinity record failed");
2761 if (PREDICT_FALSE (lb != 0))
2763 *mapping_fib_index = m->fib_index;
2764 *mapping_addr = m->local_addr;
2765 /* Address only mapping doesn't change port */
2767 is_sm_addr_only (m->flags) ? match_port : m->local_port;
2772 *mapping_addr = m->external_addr;
2773 /* Address only mapping doesn't change port */
2775 is_sm_addr_only (m->flags) ? match_port : m->external_port;
2776 *mapping_fib_index = sm->outside_fib_index;
2780 if (PREDICT_FALSE (is_addr_only != 0))
2781 *is_addr_only = is_sm_addr_only (m->flags);
2783 if (PREDICT_FALSE (twice_nat != 0))
2785 *twice_nat = TWICE_NAT_DISABLED;
2787 if (is_sm_twice_nat (m->flags))
2789 *twice_nat = TWICE_NAT;
2791 else if (is_sm_self_twice_nat (m->flags))
2793 *twice_nat = TWICE_NAT_SELF;
2797 if (PREDICT_FALSE (is_identity_nat != 0))
2798 *is_identity_nat = is_sm_identity_nat (m->flags);
2807 nat44_ed_get_in2out_worker_index (vlib_buffer_t *b, ip4_header_t *ip,
2808 u32 rx_fib_index, u8 is_output)
2810 snat_main_t *sm = &snat_main;
2811 u32 next_worker_index = sm->first_worker_index;
2814 clib_bihash_kv_16_8_t kv16, value16;
2816 u32 fib_index = rx_fib_index;
2819 if (PREDICT_FALSE (is_output))
2821 fib_index = sm->outside_fib_index;
2822 nat_outside_fib_t *outside_fib;
2823 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
2824 fib_prefix_t pfx = {
2825 .fp_proto = FIB_PROTOCOL_IP4,
2828 .ip4.as_u32 = ip->dst_address.as_u32,
2832 switch (vec_len (sm->outside_fibs))
2835 fib_index = sm->outside_fib_index;
2838 fib_index = sm->outside_fibs[0].fib_index;
2841 vec_foreach (outside_fib, sm->outside_fibs)
2843 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
2844 if (FIB_NODE_INDEX_INVALID != fei)
2846 if (fib_entry_get_resolving_interface (fei) != ~0)
2848 fib_index = outside_fib->fib_index;
2857 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
2859 ip4_address_t lookup_saddr, lookup_daddr;
2860 u16 lookup_sport, lookup_dport;
2863 if (!nat_get_icmp_session_lookup_values (
2864 b, ip, &lookup_saddr, &lookup_sport, &lookup_daddr,
2865 &lookup_dport, &lookup_protocol))
2867 init_ed_k (&kv16, lookup_saddr, lookup_sport, lookup_daddr,
2868 lookup_dport, rx_fib_index, lookup_protocol);
2869 if (!clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16))
2871 next_worker_index = ed_value_get_thread_index (&value16);
2872 vnet_buffer2 (b)->nat.cached_session_index =
2873 ed_value_get_session_index (&value16);
2879 init_ed_k (&kv16, ip->src_address, vnet_buffer (b)->ip.reass.l4_src_port,
2880 ip->dst_address, vnet_buffer (b)->ip.reass.l4_dst_port,
2881 fib_index, ip->protocol);
2883 if (!clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16))
2885 next_worker_index = ed_value_get_thread_index (&value16);
2886 vnet_buffer2 (b)->nat.cached_session_index =
2887 ed_value_get_session_index (&value16);
2892 init_ed_k (&kv16, ip->dst_address, vnet_buffer (b)->ip.reass.l4_dst_port,
2893 ip->src_address, vnet_buffer (b)->ip.reass.l4_src_port,
2894 rx_fib_index, ip->protocol);
2895 if (!clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16))
2897 next_worker_index = ed_value_get_thread_index (&value16);
2898 vnet_buffer2 (b)->nat.cached_dst_nat_session_index =
2899 ed_value_get_session_index (&value16);
2904 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
2905 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
2907 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
2908 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
2910 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
2913 if (PREDICT_TRUE (!is_output))
2915 nat_elog_debug_handoff (sm, "HANDOFF IN2OUT", next_worker_index,
2917 clib_net_to_host_u32 (ip->src_address.as_u32),
2918 clib_net_to_host_u32 (ip->dst_address.as_u32));
2922 nat_elog_debug_handoff (sm, "HANDOFF IN2OUT-OUTPUT-FEATURE",
2923 next_worker_index, rx_fib_index,
2924 clib_net_to_host_u32 (ip->src_address.as_u32),
2925 clib_net_to_host_u32 (ip->dst_address.as_u32));
2928 return next_worker_index;
2932 nat44_ed_get_out2in_worker_index (vlib_buffer_t *b, ip4_header_t *ip,
2933 u32 rx_fib_index, u8 is_output)
2935 snat_main_t *sm = &snat_main;
2936 clib_bihash_kv_8_8_t kv, value;
2937 clib_bihash_kv_16_8_t kv16, value16;
2939 u32 proto, next_worker_index = 0;
2941 snat_static_mapping_t *m;
2944 proto = ip_proto_to_nat_proto (ip->protocol);
2946 if (PREDICT_FALSE (proto == NAT_PROTOCOL_ICMP))
2948 ip4_address_t lookup_saddr, lookup_daddr;
2949 u16 lookup_sport, lookup_dport;
2951 if (!nat_get_icmp_session_lookup_values (
2952 b, ip, &lookup_saddr, &lookup_sport, &lookup_daddr, &lookup_dport,
2955 init_ed_k (&kv16, lookup_saddr, lookup_sport, lookup_daddr,
2956 lookup_dport, rx_fib_index, lookup_protocol);
2958 !clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16)))
2960 next_worker_index = ed_value_get_thread_index (&value16);
2961 nat_elog_debug_handoff (
2962 sm, "HANDOFF OUT2IN (session)", next_worker_index,
2963 rx_fib_index, clib_net_to_host_u32 (ip->src_address.as_u32),
2964 clib_net_to_host_u32 (ip->dst_address.as_u32));
2965 return next_worker_index;
2970 init_ed_k (&kv16, ip->src_address, vnet_buffer (b)->ip.reass.l4_src_port,
2971 ip->dst_address, vnet_buffer (b)->ip.reass.l4_dst_port,
2972 rx_fib_index, ip->protocol);
2975 !clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16)))
2977 vnet_buffer2 (b)->nat.cached_session_index =
2978 ed_value_get_session_index (&value16);
2979 next_worker_index = ed_value_get_thread_index (&value16);
2980 nat_elog_debug_handoff (sm, "HANDOFF OUT2IN (session)",
2981 next_worker_index, rx_fib_index,
2982 clib_net_to_host_u32 (ip->src_address.as_u32),
2983 clib_net_to_host_u32 (ip->dst_address.as_u32));
2984 return next_worker_index;
2987 /* first try static mappings without port */
2988 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2990 init_nat_k (&kv, ip->dst_address, 0, 0, 0);
2991 if (!clib_bihash_search_8_8
2992 (&sm->static_mapping_by_external, &kv, &value))
2994 m = pool_elt_at_index (sm->static_mappings, value.value);
2995 next_worker_index = m->workers[0];
3000 /* unknown protocol */
3001 if (PREDICT_FALSE (proto == NAT_PROTOCOL_OTHER))
3003 /* use current thread */
3004 next_worker_index = vlib_get_thread_index ();
3008 port = vnet_buffer (b)->ip.reass.l4_dst_port;
3010 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
3012 udp_header_t *udp = ip4_next_header (ip);
3013 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3014 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3015 if (!icmp_type_is_error_message
3016 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3017 port = vnet_buffer (b)->ip.reass.l4_src_port;
3020 /* if error message, then it's not fragmented and we can access it */
3021 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3022 proto = ip_proto_to_nat_proto (inner_ip->protocol);
3023 void *l4_header = ip4_next_header (inner_ip);
3026 case NAT_PROTOCOL_ICMP:
3027 icmp = (icmp46_header_t *) l4_header;
3028 echo = (icmp_echo_header_t *) (icmp + 1);
3029 port = echo->identifier;
3031 case NAT_PROTOCOL_UDP:
3032 case NAT_PROTOCOL_TCP:
3033 port = ((tcp_udp_header_t *) l4_header)->src_port;
3036 next_worker_index = vlib_get_thread_index ();
3042 /* try static mappings with port */
3043 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3045 init_nat_k (&kv, ip->dst_address, port, 0, proto);
3046 if (!clib_bihash_search_8_8
3047 (&sm->static_mapping_by_external, &kv, &value))
3049 m = pool_elt_at_index (sm->static_mappings, value.value);
3050 if (!is_sm_lb (m->flags))
3052 next_worker_index = m->workers[0];
3056 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3057 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3059 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
3061 m->workers[hash & (_vec_len (m->workers) - 1)];
3063 next_worker_index = m->workers[hash % _vec_len (m->workers)];
3068 /* worker by outside port */
3069 next_worker_index = sm->first_worker_index;
3070 next_worker_index +=
3071 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
3074 nat_elog_debug_handoff (sm, "HANDOFF OUT2IN", next_worker_index,
3076 clib_net_to_host_u32 (ip->src_address.as_u32),
3077 clib_net_to_host_u32 (ip->dst_address.as_u32));
3078 return next_worker_index;
3082 nat44_get_max_session_limit ()
3084 snat_main_t *sm = &snat_main;
3085 u32 max_limit = 0, len = 0;
3087 for (; len < vec_len (sm->max_translations_per_fib); len++)
3089 if (max_limit < sm->max_translations_per_fib[len])
3090 max_limit = sm->max_translations_per_fib[len];
3096 nat44_set_session_limit (u32 session_limit, u32 vrf_id)
3098 snat_main_t *sm = &snat_main;
3099 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3100 u32 len = vec_len (sm->max_translations_per_fib);
3102 if (len <= fib_index)
3104 vec_validate (sm->max_translations_per_fib, fib_index + 1);
3106 for (; len < vec_len (sm->max_translations_per_fib); len++)
3107 sm->max_translations_per_fib[len] = sm->max_translations_per_thread;
3110 sm->max_translations_per_fib[fib_index] = session_limit;
3115 nat44_update_session_limit (u32 session_limit, u32 vrf_id)
3117 snat_main_t *sm = &snat_main;
3119 if (nat44_set_session_limit (session_limit, vrf_id))
3121 sm->max_translations_per_thread = nat44_get_max_session_limit ();
3123 stat_segment_set_state_counter (sm->max_cfg_sessions_gauge,
3124 sm->max_translations_per_thread);
3126 sm->translation_buckets =
3127 nat_calc_bihash_buckets (sm->max_translations_per_thread);
3129 nat44_ed_sessions_clear ();
3134 nat44_ed_worker_db_init (snat_main_per_thread_data_t *tsm, u32 translations,
3135 u32 translation_buckets)
3139 pool_alloc (tsm->sessions, translations);
3140 pool_alloc (tsm->lru_pool, translations);
3142 pool_get (tsm->lru_pool, head);
3143 tsm->tcp_trans_lru_head_index = head - tsm->lru_pool;
3144 clib_dlist_init (tsm->lru_pool, tsm->tcp_trans_lru_head_index);
3146 pool_get (tsm->lru_pool, head);
3147 tsm->tcp_estab_lru_head_index = head - tsm->lru_pool;
3148 clib_dlist_init (tsm->lru_pool, tsm->tcp_estab_lru_head_index);
3150 pool_get (tsm->lru_pool, head);
3151 tsm->udp_lru_head_index = head - tsm->lru_pool;
3152 clib_dlist_init (tsm->lru_pool, tsm->udp_lru_head_index);
3154 pool_get (tsm->lru_pool, head);
3155 tsm->icmp_lru_head_index = head - tsm->lru_pool;
3156 clib_dlist_init (tsm->lru_pool, tsm->icmp_lru_head_index);
3158 pool_get (tsm->lru_pool, head);
3159 tsm->unk_proto_lru_head_index = head - tsm->lru_pool;
3160 clib_dlist_init (tsm->lru_pool, tsm->unk_proto_lru_head_index);
3164 reinit_ed_flow_hash ()
3166 snat_main_t *sm = &snat_main;
3167 // we expect 2 flows per session, so multiply translation_buckets by 2
3168 clib_bihash_init_16_8 (
3169 &sm->flow_hash, "ed-flow-hash",
3170 clib_max (1, sm->num_workers) * 2 * sm->translation_buckets, 0);
3171 clib_bihash_set_kvp_format_fn_16_8 (&sm->flow_hash, format_ed_session_kvp);
3175 nat44_ed_db_init (u32 translations, u32 translation_buckets)
3177 snat_main_t *sm = &snat_main;
3178 snat_main_per_thread_data_t *tsm;
3179 u32 static_mapping_buckets = 1024;
3180 u32 static_mapping_memory_size = 64 << 20;
3182 reinit_ed_flow_hash ();
3184 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
3185 "static_mapping_by_local", static_mapping_buckets,
3186 static_mapping_memory_size);
3187 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_local,
3188 format_static_mapping_kvp);
3190 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
3191 "static_mapping_by_external", static_mapping_buckets,
3192 static_mapping_memory_size);
3193 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_external,
3194 format_static_mapping_kvp);
3198 vec_foreach (tsm, sm->per_thread_data)
3200 nat44_ed_worker_db_init (tsm, sm->max_translations_per_thread,
3201 sm->translation_buckets);
3207 nat44_ed_worker_db_free (snat_main_per_thread_data_t *tsm)
3209 pool_free (tsm->lru_pool);
3210 pool_free (tsm->sessions);
3211 vec_free (tsm->per_vrf_sessions_vec);
3217 snat_main_t *sm = &snat_main;
3218 snat_main_per_thread_data_t *tsm;
3220 pool_free (sm->static_mappings);
3221 clib_bihash_free_16_8 (&sm->flow_hash);
3222 clib_bihash_free_8_8 (&sm->static_mapping_by_local);
3223 clib_bihash_free_8_8 (&sm->static_mapping_by_external);
3227 vec_foreach (tsm, sm->per_thread_data)
3229 nat44_ed_worker_db_free (tsm);
3235 nat44_ed_sessions_clear ()
3237 snat_main_t *sm = &snat_main;
3238 snat_main_per_thread_data_t *tsm;
3240 reinit_ed_flow_hash ();
3244 vec_foreach (tsm, sm->per_thread_data)
3247 nat44_ed_worker_db_free (tsm);
3248 nat44_ed_worker_db_init (tsm, sm->max_translations_per_thread,
3249 sm->translation_buckets);
3252 vlib_zero_simple_counter (&sm->total_sessions, 0);
3256 nat44_ed_add_del_sm_addr_only_cb (ip4_main_t *im, uword opaque,
3257 u32 sw_if_index, ip4_address_t *address,
3258 u32 address_length, u32 if_address_index,
3261 clib_bihash_kv_8_8_t kv, value;
3262 snat_static_map_resolve_t *rp;
3263 snat_main_t *sm = &snat_main;
3264 snat_static_mapping_t *m;
3265 ip4_address_t l_addr;
3271 for (i = 0; i < vec_len (sm->to_resolve); i++)
3273 rp = sm->to_resolve + i;
3274 if (rp->addr_only && rp->sw_if_index == sw_if_index)
3282 init_nat_k (&kv, *address, rp->addr_only ? 0 : rp->e_port,
3283 sm->outside_fib_index, rp->addr_only ? 0 : rp->proto);
3285 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
3291 m = pool_elt_at_index (sm->static_mappings, value.value);
3295 if (rp->l_addr.as_u32 == 0)
3297 l_addr.as_u32 = address[0].as_u32;
3301 l_addr.as_u32 = rp->l_addr.as_u32;
3308 rv = nat44_ed_del_static_mapping (l_addr, address[0], rp->l_port,
3309 rp->e_port, rp->proto, rp->vrf_id,
3317 rv = nat44_ed_add_static_mapping (
3318 l_addr, address[0], rp->l_port, rp->e_port, rp->proto, rp->vrf_id,
3319 ~0, rp->flags, rp->pool_addr, rp->tag);
3321 // else don't trip over lease renewal, static config
3325 nat_elog_notice_X1 (sm, "nat44_ed_del_static_mapping returned %d", "i4",
3331 nat44_ed_add_del_interface_address_cb (ip4_main_t *im, uword opaque,
3332 u32 sw_if_index, ip4_address_t *address,
3334 u32 if_address_index, u32 is_delete)
3336 snat_main_t *sm = &snat_main;
3337 snat_static_map_resolve_t *rp;
3338 ip4_address_t l_addr;
3342 snat_address_t *addresses = sm->addresses;
3349 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices); i++)
3351 if (sw_if_index == sm->auto_add_sw_if_indices[i])
3355 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices_twice_nat); i++)
3358 addresses = sm->twice_nat_addresses;
3359 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
3368 /* Don't trip over lease renewal, static config */
3369 for (j = 0; j < vec_len (addresses); j++)
3370 if (addresses[j].addr.as_u32 == address->as_u32)
3373 (void) nat44_ed_add_address (address, ~0, twice_nat);
3374 /* Scan static map resolution vector */
3375 for (j = 0; j < vec_len (sm->to_resolve); j++)
3377 rp = sm->to_resolve + j;
3380 /* On this interface? */
3381 if (rp->sw_if_index == sw_if_index)
3383 // TODO: remove if not needed (handled by function)
3384 /* Indetity mapping? */
3385 if (rp->l_addr.as_u32 == 0)
3386 l_addr.as_u32 = address[0].as_u32;
3388 l_addr.as_u32 = rp->l_addr.as_u32;
3390 /* Add the static mapping */
3391 rv = nat44_ed_add_static_mapping (
3392 l_addr, address[0], rp->l_port, rp->e_port, rp->proto,
3393 rp->vrf_id, ~0, rp->flags, rp->pool_addr, rp->tag);
3396 nat_elog_notice_X1 (sm, "add_static_mapping returned %d",
3405 // remove all static mapping records
3406 (void) nat44_ed_del_address (address[0], 1, twice_nat);
3411 nat44_ed_add_interface_address (u32 sw_if_index, u8 twice_nat)
3413 snat_main_t *sm = &snat_main;
3414 ip4_main_t *ip4_main = sm->ip4_main;
3415 ip4_address_t *first_int_addr;
3416 u32 *auto_add_sw_if_indices = twice_nat ?
3417 sm->auto_add_sw_if_indices_twice_nat :
3418 sm->auto_add_sw_if_indices;
3421 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
3423 if (auto_add_sw_if_indices[i] == sw_if_index)
3425 return VNET_API_ERROR_VALUE_EXIST;
3429 // add to the auto-address list
3432 vec_add1 (sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
3436 vec_add1 (sm->auto_add_sw_if_indices, sw_if_index);
3439 // if the address is already bound - or static - add it now
3440 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0);
3443 (void) nat44_ed_add_address (first_int_addr, ~0, twice_nat);
3450 nat44_ed_del_interface_address (u32 sw_if_index, u8 twice_nat)
3452 snat_main_t *sm = &snat_main;
3453 ip4_main_t *ip4_main = sm->ip4_main;
3454 ip4_address_t *first_int_addr;
3455 snat_static_map_resolve_t *rp;
3456 u32 *indices_to_delete = 0;
3458 u32 *auto_add_sw_if_indices;
3462 return VNET_API_ERROR_UNSUPPORTED;
3465 auto_add_sw_if_indices = twice_nat ? sm->auto_add_sw_if_indices_twice_nat :
3466 sm->auto_add_sw_if_indices;
3468 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
3470 if (auto_add_sw_if_indices[i] == sw_if_index)
3473 ip4_interface_first_address (ip4_main, sw_if_index, 0);
3476 // remove all static mapping records
3477 (void) nat44_ed_del_address (first_int_addr[0], 1, twice_nat);
3481 for (j = 0; j < vec_len (sm->to_resolve); j++)
3483 rp = sm->to_resolve + j;
3484 if (rp->sw_if_index == sw_if_index)
3486 vec_add1 (indices_to_delete, j);
3489 if (vec_len (indices_to_delete))
3491 for (j = vec_len (indices_to_delete) - 1; j >= 0; j--)
3493 vec_del1 (sm->to_resolve, j);
3495 vec_free (indices_to_delete);
3501 vec_del1 (sm->auto_add_sw_if_indices_twice_nat, i);
3505 vec_del1 (sm->auto_add_sw_if_indices, i);
3510 return VNET_API_ERROR_NO_SUCH_ENTRY;
3514 nat44_ed_del_session (snat_main_t *sm, ip4_address_t *addr, u16 port,
3515 ip4_address_t *eh_addr, u16 eh_port, u8 proto,
3516 u32 vrf_id, int is_in)
3519 clib_bihash_kv_16_8_t kv, value;
3522 snat_main_per_thread_data_t *tsm;
3526 return VNET_API_ERROR_UNSUPPORTED;
3529 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3530 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
3531 if (sm->num_workers > 1)
3532 tsm = vec_elt_at_index (
3533 sm->per_thread_data,
3534 nat44_ed_get_in2out_worker_index (0, &ip, fib_index, 0));
3536 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
3538 init_ed_k (&kv, *addr, port, *eh_addr, eh_port, fib_index, proto);
3539 if (clib_bihash_search_16_8 (&sm->flow_hash, &kv, &value))
3541 return VNET_API_ERROR_NO_SUCH_ENTRY;
3544 if (pool_is_free_index (tsm->sessions, ed_value_get_session_index (&value)))
3545 return VNET_API_ERROR_UNSPECIFIED;
3546 s = pool_elt_at_index (tsm->sessions, ed_value_get_session_index (&value));
3547 nat_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
3548 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
3552 VLIB_NODE_FN (nat_default_node) (vlib_main_t * vm,
3553 vlib_node_runtime_t * node,
3554 vlib_frame_t * frame)
3559 VLIB_REGISTER_NODE (nat_default_node) = {
3560 .name = "nat-default",
3561 .vector_size = sizeof (u32),
3563 .type = VLIB_NODE_TYPE_INTERNAL,
3565 .n_next_nodes = NAT_N_NEXT,
3567 [NAT_NEXT_DROP] = "error-drop",
3568 [NAT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
3569 [NAT_NEXT_IN2OUT_ED_FAST_PATH] = "nat44-ed-in2out",
3570 [NAT_NEXT_IN2OUT_ED_SLOW_PATH] = "nat44-ed-in2out-slowpath",
3571 [NAT_NEXT_IN2OUT_ED_OUTPUT_FAST_PATH] = "nat44-ed-in2out-output",
3572 [NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH] = "nat44-ed-in2out-output-slowpath",
3573 [NAT_NEXT_OUT2IN_ED_FAST_PATH] = "nat44-ed-out2in",
3574 [NAT_NEXT_OUT2IN_ED_SLOW_PATH] = "nat44-ed-out2in-slowpath",
3575 [NAT_NEXT_IN2OUT_CLASSIFY] = "nat44-in2out-worker-handoff",
3576 [NAT_NEXT_OUT2IN_CLASSIFY] = "nat44-out2in-worker-handoff",
3581 nat_6t_l3_l4_csum_calc (nat_6t_flow_t *f)
3583 f->l3_csum_delta = 0;
3584 f->l4_csum_delta = 0;
3585 if (f->ops & NAT_FLOW_OP_SADDR_REWRITE &&
3586 f->rewrite.saddr.as_u32 != f->match.saddr.as_u32)
3589 ip_csum_add_even (f->l3_csum_delta, f->rewrite.saddr.as_u32);
3591 ip_csum_sub_even (f->l3_csum_delta, f->match.saddr.as_u32);
3595 f->rewrite.saddr.as_u32 = f->match.saddr.as_u32;
3597 if (f->ops & NAT_FLOW_OP_DADDR_REWRITE &&
3598 f->rewrite.daddr.as_u32 != f->match.daddr.as_u32)
3601 ip_csum_add_even (f->l3_csum_delta, f->rewrite.daddr.as_u32);
3603 ip_csum_sub_even (f->l3_csum_delta, f->match.daddr.as_u32);
3607 f->rewrite.daddr.as_u32 = f->match.daddr.as_u32;
3609 if (f->ops & NAT_FLOW_OP_SPORT_REWRITE && f->rewrite.sport != f->match.sport)
3611 f->l4_csum_delta = ip_csum_add_even (f->l4_csum_delta, f->rewrite.sport);
3612 f->l4_csum_delta = ip_csum_sub_even (f->l4_csum_delta, f->match.sport);
3616 f->rewrite.sport = f->match.sport;
3618 if (f->ops & NAT_FLOW_OP_DPORT_REWRITE && f->rewrite.dport != f->match.dport)
3620 f->l4_csum_delta = ip_csum_add_even (f->l4_csum_delta, f->rewrite.dport);
3621 f->l4_csum_delta = ip_csum_sub_even (f->l4_csum_delta, f->match.dport);
3625 f->rewrite.dport = f->match.dport;
3627 if (f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE &&
3628 f->rewrite.icmp_id != f->match.sport)
3631 ip_csum_add_even (f->l4_csum_delta, f->rewrite.icmp_id);
3632 f->l4_csum_delta = ip_csum_sub_even (f->l4_csum_delta, f->match.sport);
3636 f->rewrite.icmp_id = f->match.sport;
3638 if (f->ops & NAT_FLOW_OP_TXFIB_REWRITE)
3643 f->rewrite.fib_index = f->match.fib_index;
3647 static_always_inline int
3648 nat_6t_flow_icmp_translate (vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b,
3649 ip4_header_t *ip, nat_6t_flow_t *f);
3651 static_always_inline void
3652 nat_6t_flow_ip4_translate (snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip,
3653 nat_6t_flow_t *f, nat_protocol_t proto,
3654 int is_icmp_inner_ip4, int skip_saddr_rewrite)
3656 udp_header_t *udp = ip4_next_header (ip);
3657 tcp_header_t *tcp = (tcp_header_t *) udp;
3659 if ((NAT_PROTOCOL_TCP == proto || NAT_PROTOCOL_UDP == proto) &&
3660 !vnet_buffer (b)->ip.reass.is_non_first_fragment)
3662 if (!is_icmp_inner_ip4)
3664 ip->src_address = f->rewrite.saddr;
3665 ip->dst_address = f->rewrite.daddr;
3666 udp->src_port = f->rewrite.sport;
3667 udp->dst_port = f->rewrite.dport;
3670 { // icmp inner ip4 - reversed saddr/daddr
3671 ip->src_address = f->rewrite.daddr;
3672 ip->dst_address = f->rewrite.saddr;
3673 udp->src_port = f->rewrite.dport;
3674 udp->dst_port = f->rewrite.sport;
3677 if (NAT_PROTOCOL_TCP == proto)
3679 ip_csum_t tcp_sum = tcp->checksum;
3680 tcp_sum = ip_csum_sub_even (tcp_sum, f->l3_csum_delta);
3681 tcp_sum = ip_csum_sub_even (tcp_sum, f->l4_csum_delta);
3682 mss_clamping (sm->mss_clamping, tcp, &tcp_sum);
3683 tcp->checksum = ip_csum_fold (tcp_sum);
3685 else if (proto == NAT_PROTOCOL_UDP && udp->checksum)
3687 ip_csum_t udp_sum = udp->checksum;
3688 udp_sum = ip_csum_sub_even (udp_sum, f->l3_csum_delta);
3689 udp_sum = ip_csum_sub_even (udp_sum, f->l4_csum_delta);
3690 udp->checksum = ip_csum_fold (udp_sum);
3695 if (!is_icmp_inner_ip4)
3697 if (!skip_saddr_rewrite)
3699 ip->src_address = f->rewrite.saddr;
3701 ip->dst_address = f->rewrite.daddr;
3704 { // icmp inner ip4 - reversed saddr/daddr
3705 ip->src_address = f->rewrite.daddr;
3706 ip->dst_address = f->rewrite.saddr;
3710 if (skip_saddr_rewrite)
3712 ip->checksum = ip4_header_checksum (ip);
3716 ip_csum_t ip_sum = ip->checksum;
3717 ip_sum = ip_csum_sub_even (ip_sum, f->l3_csum_delta);
3718 ip->checksum = ip_csum_fold (ip_sum);
3720 if (0xffff == ip->checksum)
3722 ASSERT (ip4_header_checksum_is_valid (ip));
3725 static_always_inline int
3726 it_fits (vlib_main_t *vm, vlib_buffer_t *b, void *object, size_t size)
3728 int result = ((u8 *) object + size <=
3729 (u8 *) vlib_buffer_get_current (b) + b->current_length) &&
3730 vlib_object_within_buffer_data (vm, b, object, size);
3734 static_always_inline int
3735 nat_6t_flow_icmp_translate (vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b,
3736 ip4_header_t *ip, nat_6t_flow_t *f)
3738 if (IP_PROTOCOL_ICMP != ip->protocol)
3739 return NAT_ED_TRNSL_ERR_TRANSLATION_FAILED;
3741 icmp46_header_t *icmp = ip4_next_header (ip);
3742 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
3744 if ((!vnet_buffer (b)->ip.reass.is_non_first_fragment))
3746 if (!it_fits (vm, b, icmp, sizeof (*icmp)))
3748 return NAT_ED_TRNSL_ERR_PACKET_TRUNCATED;
3751 if (!icmp_type_is_error_message (icmp->type))
3753 if ((f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE) &&
3754 (f->rewrite.icmp_id != echo->identifier))
3756 ip_csum_t sum = icmp->checksum;
3757 sum = ip_csum_update (sum, echo->identifier, f->rewrite.icmp_id,
3759 identifier /* changed member */);
3760 echo->identifier = f->rewrite.icmp_id;
3761 icmp->checksum = ip_csum_fold (sum);
3766 ip_csum_t sum = ip_incremental_checksum (
3768 clib_net_to_host_u16 (ip->length) - ip4_header_bytes (ip));
3769 sum = (u16) ~ip_csum_fold (sum);
3772 return NAT_ED_TRNSL_ERR_INVALID_CSUM;
3775 // errors are not fragmented
3776 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3778 if (!ip4_header_checksum_is_valid (inner_ip))
3780 return NAT_ED_TRNSL_ERR_INNER_IP_CORRUPT;
3783 nat_protocol_t inner_proto =
3784 ip_proto_to_nat_proto (inner_ip->protocol);
3786 ip_csum_t old_icmp_sum = icmp->checksum;
3787 ip_csum_t old_inner_ip_sum = inner_ip->checksum;
3788 ip_csum_t old_udp_sum;
3789 ip_csum_t old_tcp_sum;
3790 ip_csum_t new_icmp_sum;
3794 switch (inner_proto)
3796 case NAT_PROTOCOL_UDP:
3797 udp = (udp_header_t *) (inner_ip + 1);
3798 if (!it_fits (vm, b, udp, sizeof (*udp)))
3800 return NAT_ED_TRNSL_ERR_PACKET_TRUNCATED;
3802 old_udp_sum = udp->checksum;
3803 nat_6t_flow_ip4_translate (sm, b, inner_ip, f, inner_proto,
3804 1 /* is_icmp_inner_ip4 */,
3805 0 /* skip_saddr_rewrite */);
3806 new_icmp_sum = ip_csum_sub_even (old_icmp_sum, f->l3_csum_delta);
3807 new_icmp_sum = ip_csum_sub_even (new_icmp_sum, f->l4_csum_delta);
3809 ip_csum_update (new_icmp_sum, old_inner_ip_sum,
3810 inner_ip->checksum, ip4_header_t, checksum);
3812 ip_csum_update (new_icmp_sum, old_udp_sum, udp->checksum,
3813 udp_header_t, checksum);
3814 new_icmp_sum = ip_csum_fold (new_icmp_sum);
3815 icmp->checksum = new_icmp_sum;
3817 case NAT_PROTOCOL_TCP:
3818 tcp = (tcp_header_t *) (inner_ip + 1);
3819 if (!it_fits (vm, b, tcp, sizeof (*tcp)))
3821 return NAT_ED_TRNSL_ERR_PACKET_TRUNCATED;
3823 old_tcp_sum = tcp->checksum;
3824 nat_6t_flow_ip4_translate (sm, b, inner_ip, f, inner_proto,
3825 1 /* is_icmp_inner_ip4 */,
3826 0 /* skip_saddr_rewrite */);
3827 new_icmp_sum = ip_csum_sub_even (old_icmp_sum, f->l3_csum_delta);
3828 new_icmp_sum = ip_csum_sub_even (new_icmp_sum, f->l4_csum_delta);
3830 ip_csum_update (new_icmp_sum, old_inner_ip_sum,
3831 inner_ip->checksum, ip4_header_t, checksum);
3833 ip_csum_update (new_icmp_sum, old_tcp_sum, tcp->checksum,
3834 tcp_header_t, checksum);
3835 new_icmp_sum = ip_csum_fold (new_icmp_sum);
3836 icmp->checksum = new_icmp_sum;
3838 case NAT_PROTOCOL_ICMP:
3839 if (f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE)
3841 icmp46_header_t *inner_icmp = ip4_next_header (inner_ip);
3842 if (!it_fits (vm, b, inner_icmp, sizeof (*inner_icmp)))
3844 return NAT_ED_TRNSL_ERR_PACKET_TRUNCATED;
3846 icmp_echo_header_t *inner_echo =
3847 (icmp_echo_header_t *) (inner_icmp + 1);
3848 if (f->rewrite.icmp_id != inner_echo->identifier)
3850 ip_csum_t sum = icmp->checksum;
3851 sum = ip_csum_update (
3852 sum, inner_echo->identifier, f->rewrite.icmp_id,
3853 icmp_echo_header_t, identifier /* changed member */);
3854 icmp->checksum = ip_csum_fold (sum);
3855 ip_csum_t inner_sum = inner_icmp->checksum;
3856 inner_sum = ip_csum_update (
3857 sum, inner_echo->identifier, f->rewrite.icmp_id,
3858 icmp_echo_header_t, identifier /* changed member */);
3859 inner_icmp->checksum = ip_csum_fold (inner_sum);
3860 inner_echo->identifier = f->rewrite.icmp_id;
3865 clib_warning ("unexpected NAT protocol value `%d'", inner_proto);
3866 return NAT_ED_TRNSL_ERR_TRANSLATION_FAILED;
3871 return NAT_ED_TRNSL_ERR_SUCCESS;
3874 static_always_inline nat_translation_error_e
3875 nat_6t_flow_buf_translate (vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b,
3876 ip4_header_t *ip, nat_6t_flow_t *f,
3877 nat_protocol_t proto, int is_output_feature,
3880 if (!is_output_feature && f->ops & NAT_FLOW_OP_TXFIB_REWRITE)
3882 vnet_buffer (b)->sw_if_index[VLIB_TX] = f->rewrite.fib_index;
3885 if (NAT_PROTOCOL_ICMP == proto)
3887 if (ip->src_address.as_u32 != f->rewrite.saddr.as_u32)
3889 // packet is returned from a router, not from destination
3890 // skip source address rewrite if in o2i path
3891 nat_6t_flow_ip4_translate (sm, b, ip, f, proto,
3892 0 /* is_icmp_inner_ip4 */,
3893 !is_i2o /* skip_saddr_rewrite */);
3897 nat_6t_flow_ip4_translate (sm, b, ip, f, proto,
3898 0 /* is_icmp_inner_ip4 */,
3899 0 /* skip_saddr_rewrite */);
3901 return nat_6t_flow_icmp_translate (vm, sm, b, ip, f);
3904 nat_6t_flow_ip4_translate (sm, b, ip, f, proto, 0 /* is_icmp_inner_ip4 */,
3905 0 /* skip_saddr_rewrite */);
3907 return NAT_ED_TRNSL_ERR_SUCCESS;
3910 nat_translation_error_e
3911 nat_6t_flow_buf_translate_i2o (vlib_main_t *vm, snat_main_t *sm,
3912 vlib_buffer_t *b, ip4_header_t *ip,
3913 nat_6t_flow_t *f, nat_protocol_t proto,
3914 int is_output_feature)
3916 return nat_6t_flow_buf_translate (vm, sm, b, ip, f, proto, is_output_feature,
3920 nat_translation_error_e
3921 nat_6t_flow_buf_translate_o2i (vlib_main_t *vm, snat_main_t *sm,
3922 vlib_buffer_t *b, ip4_header_t *ip,
3923 nat_6t_flow_t *f, nat_protocol_t proto,
3924 int is_output_feature)
3926 return nat_6t_flow_buf_translate (vm, sm, b, ip, f, proto, is_output_feature,
3931 format_nat_6t (u8 *s, va_list *args)
3933 nat_6t_t *t = va_arg (*args, nat_6t_t *);
3935 s = format (s, "saddr %U sport %u daddr %U dport %u proto %U fib_idx %u",
3936 format_ip4_address, t->saddr.as_u8,
3937 clib_net_to_host_u16 (t->sport), format_ip4_address,
3938 t->daddr.as_u8, clib_net_to_host_u16 (t->dport),
3939 format_ip_protocol, t->proto, t->fib_index);
3944 format_nat_ed_translation_error (u8 *s, va_list *args)
3946 nat_translation_error_e e = va_arg (*args, nat_translation_error_e);
3950 case NAT_ED_TRNSL_ERR_SUCCESS:
3951 s = format (s, "success");
3953 case NAT_ED_TRNSL_ERR_TRANSLATION_FAILED:
3954 s = format (s, "translation-failed");
3956 case NAT_ED_TRNSL_ERR_FLOW_MISMATCH:
3957 s = format (s, "flow-mismatch");
3959 case NAT_ED_TRNSL_ERR_PACKET_TRUNCATED:
3960 s = format (s, "packet-truncated");
3962 case NAT_ED_TRNSL_ERR_INNER_IP_CORRUPT:
3963 s = format (s, "inner-ip-corrupted");
3965 case NAT_ED_TRNSL_ERR_INVALID_CSUM:
3966 s = format (s, "invalid-checksum");
3973 format_nat_6t_flow (u8 *s, va_list *args)
3975 nat_6t_flow_t *f = va_arg (*args, nat_6t_flow_t *);
3977 s = format (s, "match: %U ", format_nat_6t, &f->match);
3979 if (f->ops & NAT_FLOW_OP_SADDR_REWRITE)
3981 s = format (s, "rewrite: saddr %U ", format_ip4_address,
3982 f->rewrite.saddr.as_u8);
3985 if (f->ops & NAT_FLOW_OP_SPORT_REWRITE)
3989 s = format (s, "rewrite: ");
3992 s = format (s, "sport %u ", clib_net_to_host_u16 (f->rewrite.sport));
3994 if (f->ops & NAT_FLOW_OP_DADDR_REWRITE)
3998 s = format (s, "rewrite: ");
4001 s = format (s, "daddr %U ", format_ip4_address, f->rewrite.daddr.as_u8);
4003 if (f->ops & NAT_FLOW_OP_DPORT_REWRITE)
4007 s = format (s, "rewrite: ");
4010 s = format (s, "dport %u ", clib_net_to_host_u16 (f->rewrite.dport));
4012 if (f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE)
4016 s = format (s, "rewrite: ");
4019 s = format (s, "icmp-id %u ", clib_net_to_host_u16 (f->rewrite.icmp_id));
4021 if (f->ops & NAT_FLOW_OP_TXFIB_REWRITE)
4025 s = format (s, "rewrite: ");
4028 s = format (s, "txfib %u ", f->rewrite.fib_index);
4034 * fd.io coding-style-patch-verification: ON
4037 * eval: (c-set-style "gnu")