2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vpp/app/version.h>
18 #include <vnet/vnet.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/ip/ip4.h>
21 #include <vnet/ip/ip_table.h>
22 #include <vnet/ip/reass/ip4_sv_reass.h>
23 #include <vnet/fib/fib_table.h>
24 #include <vnet/fib/ip4_fib.h>
25 #include <vnet/plugin/plugin.h>
26 #include <vppinfra/bihash_16_8.h>
28 #include <nat/lib/log.h>
29 #include <nat/lib/nat_inlines.h>
30 #include <nat/lib/ipfix_logging.h>
31 #include <vnet/syslog/syslog.h>
32 #include <nat/lib/nat_syslog_constants.h>
33 #include <nat/lib/nat_syslog.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 <vlib/stats/stats.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"); \
62 return VNET_API_ERROR_FEATURE_ALREADY_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"); \
74 return VNET_API_ERROR_FEATURE_ALREADY_DISABLED; \
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 (ip4_nat44_ed_classify, static) = {
93 .arc_name = "ip4-unicast",
94 .node_name = "nat44-ed-classify",
95 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
96 "ip4-sv-reassembly-feature"),
98 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
99 .arc_name = "ip4-unicast",
100 .node_name = "nat44-handoff-classify",
101 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
102 "ip4-sv-reassembly-feature"),
104 VNET_FEATURE_INIT (snat_in2out_worker_handoff, static) = {
105 .arc_name = "ip4-unicast",
106 .node_name = "nat44-in2out-worker-handoff",
107 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
109 VNET_FEATURE_INIT (snat_out2in_worker_handoff, static) = {
110 .arc_name = "ip4-unicast",
111 .node_name = "nat44-out2in-worker-handoff",
112 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
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 (nat_pre_in2out_output, static) = {
127 .arc_name = "ip4-output",
128 .node_name = "nat-pre-in2out-output",
129 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
130 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
132 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
133 .arc_name = "ip4-output",
134 .node_name = "nat44-in2out-output-worker-handoff",
135 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
136 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
138 VNET_FEATURE_INIT (ip4_nat44_ed_in2out_output, static) = {
139 .arc_name = "ip4-output",
140 .node_name = "nat44-ed-in2out-output",
141 .runs_after = VNET_FEATURES ("ip4-sv-reassembly-output-feature"),
142 .runs_before = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
145 VLIB_PLUGIN_REGISTER () = {
146 .version = VPP_BUILD_VER,
147 .description = "Network Address Translation (NAT)",
150 static void nat44_ed_db_init (u32 translations, u32 translation_buckets);
151 static void nat44_ed_worker_db_free (snat_main_per_thread_data_t *tsm);
153 static int nat44_ed_add_static_mapping_internal (
154 ip4_address_t l_addr, ip4_address_t e_addr, u16 l_port, u16 e_port,
155 ip_protocol_t proto, u32 vrf_id, u32 sw_if_index, u32 flags,
156 ip4_address_t pool_addr, u8 *tag);
157 static int nat44_ed_del_static_mapping_internal (ip4_address_t l_addr,
158 ip4_address_t e_addr,
159 u16 l_port, u16 e_port,
161 u32 vrf_id, u32 flags);
163 u32 nat_calc_bihash_buckets (u32 n_elts);
165 static_always_inline int
166 nat44_ed_sm_i2o_add (snat_main_t *sm, snat_static_mapping_t *m,
167 ip4_address_t addr, u16 port, u32 fib_index, u8 proto)
169 ASSERT (!pool_is_free (sm->static_mappings, m));
170 clib_bihash_kv_16_8_t kv;
171 nat44_ed_sm_init_i2o_kv (&kv, addr.as_u32, port, fib_index, proto,
172 m - sm->static_mappings);
173 return clib_bihash_add_del_16_8 (&sm->flow_hash, &kv, 1 /*is_add*/);
176 static_always_inline int
177 nat44_ed_sm_i2o_del (snat_main_t *sm, ip4_address_t addr, u16 port,
178 u32 fib_index, u8 proto)
180 clib_bihash_kv_16_8_t kv;
181 nat44_ed_sm_init_i2o_k (&kv, addr.as_u32, port, fib_index, proto);
182 return clib_bihash_add_del_16_8 (&sm->flow_hash, &kv, 0 /*is_add*/);
185 static_always_inline int
186 nat44_ed_sm_o2i_add (snat_main_t *sm, snat_static_mapping_t *m,
187 ip4_address_t addr, u16 port, u32 fib_index, u8 proto)
189 ASSERT (!pool_is_free (sm->static_mappings, m));
190 clib_bihash_kv_16_8_t kv;
191 nat44_ed_sm_init_o2i_kv (&kv, addr.as_u32, port, fib_index, proto,
192 m - sm->static_mappings);
193 return clib_bihash_add_del_16_8 (&sm->flow_hash, &kv, 1 /*is_add*/);
196 static_always_inline int
197 nat44_ed_sm_o2i_del (snat_main_t *sm, ip4_address_t addr, u16 port,
198 u32 fib_index, u8 proto)
200 clib_bihash_kv_16_8_t kv;
201 nat44_ed_sm_init_o2i_k (&kv, addr.as_u32, port, fib_index, proto);
202 return clib_bihash_add_del_16_8 (&sm->flow_hash, &kv, 0 /*is_add*/);
206 nat44_ed_free_session_data (snat_main_t *sm, snat_session_t *s,
207 u32 thread_index, u8 is_ha)
209 per_vrf_sessions_unregister_session (s, thread_index);
211 if (nat_ed_ses_i2o_flow_hash_add_del (sm, thread_index, s, 0))
212 nat_elog_warn (sm, "flow hash del failed");
214 if (nat_ed_ses_o2i_flow_hash_add_del (sm, thread_index, s, 0))
215 nat_elog_warn (sm, "flow hash del failed");
217 if (na44_ed_is_fwd_bypass_session (s))
222 if (nat44_ed_is_affinity_session (s))
223 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr, s->proto,
227 nat_syslog_nat44_sdel (0, s->in2out.fib_index, &s->in2out.addr,
228 s->in2out.port, &s->ext_host_nat_addr,
229 s->ext_host_nat_port, &s->out2in.addr,
230 s->out2in.port, &s->ext_host_addr, s->ext_host_port,
231 s->proto, nat44_ed_is_twice_nat_session (s));
236 nat_ipfix_logging_nat44_ses_delete (
237 thread_index, s->in2out.addr.as_u32, s->out2in.addr.as_u32, s->proto,
238 s->in2out.port, s->out2in.port, s->in2out.fib_index);
242 static ip_interface_address_t *
243 nat44_ed_get_ip_interface_address (u32 sw_if_index, ip4_address_t addr)
245 snat_main_t *sm = &snat_main;
247 ip_lookup_main_t *lm = &sm->ip4_main->lookup_main;
248 ip_interface_address_t *ia;
251 foreach_ip_interface_address (
252 lm, ia, sw_if_index, 1, ({
253 ip4a = ip_interface_address_get_address (lm, ia);
254 nat_log_debug ("sw_if_idx: %u addr: %U ? %U", sw_if_index,
255 format_ip4_address, ip4a, format_ip4_address, &addr);
256 if (ip4a->as_u32 == addr.as_u32)
265 nat44_ed_resolve_nat_addr_len (snat_address_t *ap,
266 snat_interface_t *interfaces)
268 ip_interface_address_t *ia;
272 pool_foreach (i, interfaces)
274 if (!nat44_ed_is_interface_outside (i))
279 fib_index = ip4_fib_table_get_index_for_sw_if_index (i->sw_if_index);
280 if (fib_index != ap->fib_index)
285 if ((ia = nat44_ed_get_ip_interface_address (i->sw_if_index, ap->addr)))
287 ap->addr_len = ia->address_length;
288 ap->sw_if_index = i->sw_if_index;
289 ap->net.as_u32 = ap->addr.as_u32 & ip4_main.fib_masks[ap->addr_len];
291 nat_log_debug ("pool addr %U binds to -> sw_if_idx: %u net: %U/%u",
292 format_ip4_address, &ap->addr, ap->sw_if_index,
293 format_ip4_address, &ap->net, ap->addr_len);
301 nat44_ed_update_outside_if_addresses (snat_address_t *ap)
303 snat_main_t *sm = &snat_main;
305 if (!nat44_ed_resolve_nat_addr_len (ap, sm->interfaces))
310 if (!nat44_ed_resolve_nat_addr_len (ap, sm->output_feature_interfaces))
317 nat44_ed_bind_if_addr_to_nat_addr (u32 sw_if_index)
319 snat_main_t *sm = &snat_main;
320 ip_interface_address_t *ia;
323 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
325 vec_foreach (ap, sm->addresses)
327 if (fib_index != ap->fib_index)
332 if ((ia = nat44_ed_get_ip_interface_address (sw_if_index, ap->addr)))
334 ap->addr_len = ia->address_length;
335 ap->sw_if_index = sw_if_index;
336 ap->net.as_u32 = ap->addr.as_u32 & ip4_main.fib_masks[ap->addr_len];
338 nat_log_debug ("pool addr %U binds to -> sw_if_idx: %u net: %U/%u",
339 format_ip4_address, &ap->addr, ap->sw_if_index,
340 format_ip4_address, &ap->net, ap->addr_len);
346 static_always_inline snat_fib_entry_reg_t *
347 nat44_ed_get_fib_entry_reg (ip4_address_t addr, u32 sw_if_index, int *out_idx)
349 snat_main_t *sm = &snat_main;
350 snat_fib_entry_reg_t *fe;
353 for (i = 0; i < vec_len (sm->fib_entry_reg); i++)
355 fe = sm->fib_entry_reg + i;
356 if ((addr.as_u32 == fe->addr.as_u32) && (sw_if_index == fe->sw_if_index))
369 nat44_ed_add_fib_entry_reg (ip4_address_t addr, u32 sw_if_index)
371 // Add the external NAT address to the FIB as receive entries. This ensures
372 // that VPP will reply to ARP for this address and we don't need to enable
373 // proxy ARP on the outside interface.
374 snat_main_t *sm = &snat_main;
375 snat_fib_entry_reg_t *fe;
377 if (!(fe = nat44_ed_get_fib_entry_reg (addr, sw_if_index, 0)))
379 fib_prefix_t prefix = {
381 .fp_proto = FIB_PROTOCOL_IP4,
383 .ip4.as_u32 = addr.as_u32,
386 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
387 fib_table_entry_update_one_path (fib_index, &prefix, sm->fib_src_low,
388 (FIB_ENTRY_FLAG_CONNECTED |
389 FIB_ENTRY_FLAG_LOCAL |
390 FIB_ENTRY_FLAG_EXCLUSIVE),
391 DPO_PROTO_IP4, NULL, sw_if_index, ~0, 1,
392 NULL, FIB_ROUTE_PATH_FLAG_NONE);
394 vec_add2 (sm->fib_entry_reg, fe, 1);
395 clib_memset (fe, 0, sizeof (*fe));
396 fe->addr.as_u32 = addr.as_u32;
397 fe->sw_if_index = sw_if_index;
403 nat44_ed_del_fib_entry_reg (ip4_address_t addr, u32 sw_if_index)
405 snat_main_t *sm = &snat_main;
406 snat_fib_entry_reg_t *fe;
409 if ((fe = nat44_ed_get_fib_entry_reg (addr, sw_if_index, &i)))
414 fib_prefix_t prefix = {
416 .fp_proto = FIB_PROTOCOL_IP4,
418 .ip4.as_u32 = addr.as_u32,
422 ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
423 fib_table_entry_delete (fib_index, &prefix, sm->fib_src_low);
424 vec_del1 (sm->fib_entry_reg, i);
430 nat44_ed_add_del_interface_fib_reg_entries (ip4_address_t addr, u8 is_add)
432 snat_main_t *sm = &snat_main;
435 pool_foreach (i, sm->interfaces)
437 if (nat44_ed_is_interface_outside (i))
441 nat44_ed_add_fib_entry_reg (addr, i->sw_if_index);
445 nat44_ed_del_fib_entry_reg (addr, i->sw_if_index);
449 pool_foreach (i, sm->output_feature_interfaces)
451 if (nat44_ed_is_interface_outside (i))
455 nat44_ed_add_fib_entry_reg (addr, i->sw_if_index);
459 nat44_ed_del_fib_entry_reg (addr, i->sw_if_index);
465 static_always_inline void
466 nat44_ed_add_del_nat_addr_fib_reg_entries (u32 sw_if_index, u8 is_add)
468 snat_main_t *sm = &snat_main;
471 vec_foreach (ap, sm->addresses)
475 nat44_ed_add_fib_entry_reg (ap->addr, sw_if_index);
479 nat44_ed_del_fib_entry_reg (ap->addr, sw_if_index);
484 static_always_inline void
485 nat44_ed_add_del_sm_fib_reg_entries (u32 sw_if_index, u8 is_add)
487 snat_main_t *sm = &snat_main;
488 snat_static_mapping_t *m;
490 pool_foreach (m, sm->static_mappings)
494 nat44_ed_add_fib_entry_reg (m->external_addr, sw_if_index);
498 nat44_ed_del_fib_entry_reg (m->external_addr, sw_if_index);
504 nat44_ed_add_address (ip4_address_t *addr, u32 vrf_id, u8 twice_nat)
506 snat_main_t *sm = &snat_main;
507 snat_address_t *ap, *addresses;
509 addresses = twice_nat ? sm->twice_nat_addresses : sm->addresses;
513 return VNET_API_ERROR_UNSUPPORTED;
516 // check if address already exists
517 vec_foreach (ap, addresses)
519 if (ap->addr.as_u32 == addr->as_u32)
521 nat_log_err ("address exist");
522 return VNET_API_ERROR_VALUE_EXIST;
528 vec_add2 (sm->twice_nat_addresses, ap, 1);
532 vec_add2 (sm->addresses, ap, 1);
541 ap->fib_index = fib_table_find_or_create_and_lock (
542 FIB_PROTOCOL_IP4, vrf_id, sm->fib_src_low);
547 // if we don't have enabled interface we don't add address
549 nat44_ed_add_del_interface_fib_reg_entries (*addr, 1);
550 nat44_ed_update_outside_if_addresses (ap);
556 nat44_ed_del_address (ip4_address_t addr, u8 twice_nat)
558 snat_main_t *sm = &snat_main;
559 snat_address_t *a = 0, *addresses;
561 u32 *ses_to_be_removed = 0, *ses_index;
562 snat_main_per_thread_data_t *tsm;
565 addresses = twice_nat ? sm->twice_nat_addresses : sm->addresses;
567 for (j = 0; j < vec_len (addresses); j++)
569 if (addresses[j].addr.as_u32 == addr.as_u32)
577 nat_log_err ("no such address");
578 return VNET_API_ERROR_NO_SUCH_ENTRY;
581 // delete dynamic sessions only
582 vec_foreach (tsm, sm->per_thread_data)
584 pool_foreach (ses, tsm->sessions)
586 if (ses->flags & SNAT_SESSION_FLAG_STATIC_MAPPING)
590 if (ses->out2in.addr.as_u32 == addr.as_u32)
592 nat44_ed_free_session_data (sm, ses, tsm - sm->per_thread_data,
594 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
597 vec_foreach (ses_index, ses_to_be_removed)
599 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
600 nat_ed_session_delete (sm, ses, tsm - sm->per_thread_data, 1);
602 vec_free (ses_to_be_removed);
607 nat44_ed_add_del_interface_fib_reg_entries (addr, 0);
610 if (a->fib_index != ~0)
612 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
617 vec_del1 (sm->addresses, j);
621 vec_del1 (sm->twice_nat_addresses, j);
628 nat44_ed_get_vrf_table (u32 table_vrf_id)
630 snat_main_t *sm = &snat_main;
633 pool_foreach (t, sm->vrf_tables)
635 if (table_vrf_id == t->table_vrf_id)
644 nat44_ed_get_vrf_route (vrf_table_t *t, u32 vrf_id)
648 pool_foreach (r, t->routes)
650 if (vrf_id == r->vrf_id)
659 nat44_ed_add_del_vrf_table (u32 table_vrf_id, bool is_add)
661 snat_main_t *sm = &snat_main;
665 t = nat44_ed_get_vrf_table (table_vrf_id);
670 return VNET_API_ERROR_VALUE_EXIST;
672 pool_foreach (r, t->routes)
674 fib_table_unlock (r->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
676 fib_table_unlock (t->table_fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
678 pool_free (t->routes);
679 pool_put (sm->vrf_tables, t);
685 return VNET_API_ERROR_NO_SUCH_ENTRY;
687 pool_get (sm->vrf_tables, t);
688 clib_memset (t, 0, sizeof (*t));
689 t->table_vrf_id = table_vrf_id;
690 t->table_fib_index = fib_table_find_or_create_and_lock (
691 FIB_PROTOCOL_IP4, table_vrf_id, sm->fib_src_low);
698 nat44_ed_del_vrf_tables ()
700 snat_main_t *sm = &snat_main;
704 pool_foreach (t, sm->vrf_tables)
706 pool_foreach (r, t->routes)
708 fib_table_unlock (r->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
710 fib_table_unlock (t->table_fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
711 pool_free (t->routes);
713 pool_free (sm->vrf_tables);
717 nat44_ed_add_del_vrf_route (u32 table_vrf_id, u32 vrf_id, bool is_add)
719 snat_main_t *sm = &snat_main;
723 t = nat44_ed_get_vrf_table (table_vrf_id);
726 return VNET_API_ERROR_NO_SUCH_ENTRY;
729 r = nat44_ed_get_vrf_route (t, vrf_id);
734 return VNET_API_ERROR_VALUE_EXIST;
736 fib_table_unlock (r->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
737 pool_put (t->routes, r);
743 return VNET_API_ERROR_NO_SUCH_ENTRY;
745 pool_get (t->routes, r);
746 clib_memset (r, 0, sizeof (*r));
748 r->fib_index = fib_table_find_or_create_and_lock (
749 FIB_PROTOCOL_IP4, vrf_id, sm->fib_src_low);
756 get_thread_idx_by_port (u16 e_port)
758 snat_main_t *sm = &snat_main;
759 u32 thread_idx = sm->num_workers;
760 if (sm->num_workers > 1)
762 thread_idx = sm->first_worker_index +
763 sm->workers[(e_port - ED_USER_PORT_OFFSET) /
764 sm->port_per_thread % _vec_len (sm->workers)];
770 nat_ed_static_mapping_del_sessions (snat_main_t * sm,
771 snat_main_per_thread_data_t * tsm,
772 ip4_address_t l_addr,
775 u32 fib_index, int addr_only,
776 ip4_address_t e_addr, u16 e_port)
779 u32 *indexes_to_free = NULL;
780 pool_foreach (s, tsm->sessions) {
781 if (s->in2out.fib_index != fib_index ||
782 s->in2out.addr.as_u32 != l_addr.as_u32)
788 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
789 s->out2in.port != e_port || s->in2out.port != l_port ||
790 s->proto != protocol)
794 if (nat44_ed_is_lb_session (s))
796 if (!nat44_ed_is_session_static (s))
798 nat44_ed_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
799 vec_add1 (indexes_to_free, s - tsm->sessions);
804 vec_foreach (ses_index, indexes_to_free)
806 s = pool_elt_at_index (tsm->sessions, *ses_index);
807 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
809 vec_free (indexes_to_free);
812 static_always_inline snat_static_mapping_t *
813 nat44_ed_sm_lookup (snat_main_t *sm, clib_bihash_kv_16_8_t *kv)
815 clib_bihash_kv_16_8_t v;
816 int rc = clib_bihash_search_16_8 (&sm->flow_hash, kv, &v);
819 ASSERT (0 == ed_value_get_thread_index (&v));
820 return pool_elt_at_index (sm->static_mappings,
821 ed_value_get_session_index (&v));
826 snat_static_mapping_t *
827 nat44_ed_sm_o2i_lookup (snat_main_t *sm, ip4_address_t addr, u16 port,
828 u32 fib_index, u8 proto)
830 clib_bihash_kv_16_8_t kv;
831 nat44_ed_sm_init_o2i_k (&kv, addr.as_u32, port, fib_index, proto);
832 return nat44_ed_sm_lookup (sm, &kv);
835 snat_static_mapping_t *
836 nat44_ed_sm_i2o_lookup (snat_main_t *sm, ip4_address_t addr, u16 port,
837 u32 fib_index, u8 proto)
839 clib_bihash_kv_16_8_t kv;
840 nat44_ed_sm_init_i2o_k (&kv, addr.as_u32, port, fib_index, proto);
841 return nat44_ed_sm_lookup (sm, &kv);
844 static snat_static_mapping_resolve_t *
845 nat44_ed_get_resolve_record (ip4_address_t l_addr, u16 l_port, u16 e_port,
846 ip_protocol_t proto, u32 vrf_id, u32 sw_if_index,
847 u32 flags, int *out_idx)
849 snat_static_mapping_resolve_t *rp;
850 snat_main_t *sm = &snat_main;
853 for (i = 0; i < vec_len (sm->sm_to_resolve); i++)
855 rp = sm->sm_to_resolve + i;
857 if (rp->sw_if_index == sw_if_index && rp->vrf_id == vrf_id)
859 if (is_sm_identity_nat (rp->flags) && is_sm_identity_nat (flags))
861 if (!(is_sm_addr_only (rp->flags) && is_sm_addr_only (flags)))
863 if (rp->e_port != e_port || rp->proto != proto)
869 else if (rp->l_addr.as_u32 == l_addr.as_u32)
871 if (!(is_sm_addr_only (rp->flags) && is_sm_addr_only (flags)))
873 if (rp->l_port != l_port || rp->e_port != e_port ||
895 nat44_ed_del_resolve_record (ip4_address_t l_addr, u16 l_port, u16 e_port,
896 ip_protocol_t proto, u32 vrf_id, u32 sw_if_index,
899 snat_main_t *sm = &snat_main;
901 if (nat44_ed_get_resolve_record (l_addr, l_port, e_port, proto, vrf_id,
902 sw_if_index, flags, &i))
904 vec_del1 (sm->sm_to_resolve, i);
910 static_always_inline int
911 nat44_ed_validate_sm_input (u32 flags)
913 // identity nat can be initiated only from inside interface
914 if (is_sm_identity_nat (flags) && is_sm_out2in_only (flags))
916 return VNET_API_ERROR_UNSUPPORTED;
919 if (is_sm_twice_nat (flags) || is_sm_self_twice_nat (flags))
921 if (is_sm_addr_only (flags) || is_sm_identity_nat (flags))
923 return VNET_API_ERROR_UNSUPPORTED;
930 nat44_ed_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
931 u16 l_port, u16 e_port, ip_protocol_t proto,
932 u32 vrf_id, u32 sw_if_index, u32 flags,
933 ip4_address_t pool_addr, u8 *tag)
935 snat_static_mapping_resolve_t *rp;
936 snat_main_t *sm = &snat_main;
941 return VNET_API_ERROR_UNSUPPORTED;
944 rv = nat44_ed_validate_sm_input (flags);
950 // interface bound mapping
951 if (is_sm_switch_address (flags))
953 if (nat44_ed_get_resolve_record (l_addr, l_port, e_port, proto, vrf_id,
954 sw_if_index, flags, 0))
956 return VNET_API_ERROR_VALUE_EXIST;
959 vec_add2 (sm->sm_to_resolve, rp, 1);
960 rp->l_addr.as_u32 = l_addr.as_u32;
963 rp->sw_if_index = sw_if_index;
967 rp->pool_addr = pool_addr;
968 rp->tag = vec_dup (tag);
971 ip4_address_t *first_int_addr =
972 ip4_interface_first_address (sm->ip4_main, sw_if_index, 0);
978 e_addr.as_u32 = first_int_addr->as_u32;
982 rv = nat44_ed_add_static_mapping_internal (l_addr, e_addr, l_port, e_port,
983 proto, vrf_id, sw_if_index, flags,
985 if ((0 != rv) && is_sm_switch_address (flags))
987 nat44_ed_del_resolve_record (l_addr, l_port, e_port, proto, vrf_id,
995 nat44_ed_del_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
996 u16 l_port, u16 e_port, ip_protocol_t proto,
997 u32 vrf_id, u32 sw_if_index, u32 flags)
999 snat_main_t *sm = &snat_main;
1004 return VNET_API_ERROR_UNSUPPORTED;
1007 rv = nat44_ed_validate_sm_input (flags);
1013 // interface bound mapping
1014 if (is_sm_switch_address (flags))
1016 if (nat44_ed_del_resolve_record (l_addr, l_port, e_port, proto, vrf_id,
1017 sw_if_index, flags))
1019 return VNET_API_ERROR_NO_SUCH_ENTRY;
1022 ip4_address_t *first_int_addr =
1023 ip4_interface_first_address (sm->ip4_main, sw_if_index, 0);
1024 if (!first_int_addr)
1026 // dhcp resolution required
1030 e_addr.as_u32 = first_int_addr->as_u32;
1033 return nat44_ed_del_static_mapping_internal (l_addr, e_addr, l_port, e_port,
1034 proto, vrf_id, flags);
1038 nat44_ed_add_static_mapping_internal (ip4_address_t l_addr,
1039 ip4_address_t e_addr, u16 l_port,
1040 u16 e_port, ip_protocol_t proto,
1041 u32 vrf_id, u32 sw_if_index, u32 flags,
1042 ip4_address_t pool_addr, u8 *tag)
1044 snat_main_t *sm = &snat_main;
1045 nat44_lb_addr_port_t *local;
1046 snat_static_mapping_t *m;
1049 if (is_sm_addr_only (flags))
1051 e_port = l_port = proto = 0;
1054 if (is_sm_identity_nat (flags))
1057 l_addr.as_u32 = e_addr.as_u32;
1060 m = nat44_ed_sm_o2i_lookup (sm, e_addr, e_port, 0, proto);
1064 // adding local identity nat record for different vrf table
1066 if (!is_sm_identity_nat (m->flags))
1068 return VNET_API_ERROR_VALUE_EXIST;
1071 pool_foreach (local, m->locals)
1073 if (local->vrf_id == vrf_id)
1075 return VNET_API_ERROR_VALUE_EXIST;
1079 pool_get (m->locals, local);
1081 local->vrf_id = vrf_id;
1082 local->fib_index = fib_table_find_or_create_and_lock (
1083 FIB_PROTOCOL_IP4, vrf_id, sm->fib_src_low);
1085 nat44_ed_sm_i2o_add (sm, m, m->local_addr, m->local_port,
1086 local->fib_index, m->proto);
1093 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1098 // fallback to default vrf
1099 vrf_id = sm->inside_vrf_id;
1100 fib_index = sm->inside_fib_index;
1101 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
1104 // test if local mapping record doesn't exist
1105 // identity nat supports multiple records in local mapping
1106 if (!(is_sm_out2in_only (flags) || is_sm_identity_nat (flags)))
1108 if (nat44_ed_sm_i2o_lookup (sm, l_addr, l_port, fib_index, proto))
1110 return VNET_API_ERROR_VALUE_EXIST;
1114 pool_get (sm->static_mappings, m);
1115 clib_memset (m, 0, sizeof (*m));
1118 m->local_addr = l_addr;
1119 m->external_addr = e_addr;
1121 m->pool_addr = pool_addr;
1122 m->tag = vec_dup (tag);
1124 if (!is_sm_addr_only (flags))
1126 m->local_port = l_port;
1127 m->external_port = e_port;
1131 if (is_sm_identity_nat (flags))
1133 pool_get (m->locals, local);
1135 local->vrf_id = vrf_id;
1136 local->fib_index = fib_index;
1141 m->fib_index = fib_index;
1144 if (!is_sm_out2in_only (flags))
1146 nat44_ed_sm_i2o_add (sm, m, m->local_addr, m->local_port, fib_index,
1150 nat44_ed_sm_o2i_add (sm, m, m->external_addr, m->external_port, 0, m->proto);
1152 if (sm->num_workers > 1)
1154 // store worker index for this record
1156 .src_address = m->local_addr,
1160 nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index, 0);
1161 vec_add1 (m->workers, worker_index);
1164 nat44_ed_add_del_interface_fib_reg_entries (e_addr, 1);
1170 nat44_ed_del_static_mapping_internal (ip4_address_t l_addr,
1171 ip4_address_t e_addr, u16 l_port,
1172 u16 e_port, ip_protocol_t proto,
1173 u32 vrf_id, u32 flags)
1175 snat_main_per_thread_data_t *tsm;
1176 snat_main_t *sm = &snat_main;
1178 nat44_lb_addr_port_t *local;
1179 snat_static_mapping_t *m;
1182 if (is_sm_addr_only (flags))
1184 e_port = l_port = proto = 0;
1187 if (is_sm_identity_nat (flags))
1190 l_addr.as_u32 = e_addr.as_u32;
1194 m = nat44_ed_sm_o2i_lookup (sm, e_addr, e_port, 0, proto);
1197 return VNET_API_ERROR_NO_SUCH_ENTRY;
1200 if (is_sm_identity_nat (flags))
1206 vrf_id = sm->inside_vrf_id;
1209 pool_foreach (local, m->locals)
1211 if (local->vrf_id == vrf_id)
1213 local = pool_elt_at_index (m->locals, local - m->locals);
1214 fib_index = local->fib_index;
1215 pool_put (m->locals, local);
1222 return VNET_API_ERROR_NO_SUCH_ENTRY;
1227 fib_index = m->fib_index;
1230 if (!is_sm_out2in_only (flags))
1232 nat44_ed_sm_i2o_del (sm, l_addr, l_port, fib_index, proto);
1235 // delete sessions for static mapping
1236 if (sm->num_workers > 1)
1238 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1242 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1245 nat_ed_static_mapping_del_sessions (sm, tsm, m->local_addr, m->local_port,
1246 m->proto, fib_index,
1247 is_sm_addr_only (flags), e_addr, e_port);
1249 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
1251 if (!pool_elts (m->locals))
1253 // this is last record remove all required stuff
1255 nat44_ed_sm_o2i_del (sm, e_addr, e_port, 0, proto);
1258 vec_free (m->workers);
1259 pool_put (sm->static_mappings, m);
1261 nat44_ed_add_del_interface_fib_reg_entries (e_addr, 0);
1268 nat44_ed_add_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1269 ip_protocol_t proto,
1270 nat44_lb_addr_port_t *locals, u32 flags,
1271 u8 *tag, u32 affinity)
1273 snat_main_t *sm = &snat_main;
1274 snat_static_mapping_t *m;
1275 snat_address_t *a = 0;
1277 nat44_lb_addr_port_t *local;
1285 return VNET_API_ERROR_UNSUPPORTED;
1288 m = nat44_ed_sm_o2i_lookup (sm, e_addr, e_port, 0, proto);
1292 return VNET_API_ERROR_VALUE_EXIST;
1295 if (vec_len (locals) < 2)
1297 return VNET_API_ERROR_INVALID_VALUE;
1300 if (!is_sm_out2in_only (flags))
1302 /* Find external address in allocated addresses and reserve port for
1303 address and port pair mapping when dynamic translations enabled */
1304 for (i = 0; i < vec_len (sm->addresses); i++)
1306 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1308 /* External port must be unused */
1309 a = sm->addresses + i;
1310 if (nat44_ed_sm_o2i_lookup (sm, a->addr, e_port, 0, proto))
1312 return VNET_API_ERROR_VALUE_EXIST;
1317 // external address must be allocated
1320 return VNET_API_ERROR_NO_SUCH_ENTRY;
1324 pool_get (sm->static_mappings, m);
1325 clib_memset (m, 0, sizeof (*m));
1326 m->tag = vec_dup (tag);
1327 m->external_addr = e_addr;
1328 m->external_port = e_port;
1329 m->affinity = affinity;
1333 m->flags |= NAT_SM_FLAG_LB;
1336 m->affinity_per_service_list_head_index =
1337 nat_affinity_get_per_service_list_head_index ();
1339 m->affinity_per_service_list_head_index = ~0;
1341 if (nat44_ed_sm_o2i_add (sm, m, m->external_addr, m->external_port, 0,
1344 nat_log_err ("sm o2i key add failed");
1345 return VNET_API_ERROR_UNSPECIFIED;
1348 for (i = 0; i < vec_len (locals); i++)
1350 locals[i].fib_index = fib_table_find_or_create_and_lock (
1351 FIB_PROTOCOL_IP4, locals[i].vrf_id, sm->fib_src_low);
1352 if (!is_sm_out2in_only (flags))
1354 if (nat44_ed_sm_o2i_add (sm, m, e_addr, e_port, 0, proto))
1356 nat_log_err ("sm o2i key add failed");
1357 rc = VNET_API_ERROR_UNSPECIFIED;
1358 // here we continue with add operation so that it can be safely
1359 // reversed in delete path - otherwise we'd have to track what
1360 // we've done and deal with partial cleanups and since bihash
1361 // adds are (extremely improbable) the only points of failure,
1362 // it's easier to just do it this way
1365 locals[i].prefix = (i == 0) ?
1366 locals[i].probability :
1367 (locals[i - 1].prefix + locals[i].probability);
1368 pool_get (m->locals, local);
1370 if (sm->num_workers > 1)
1373 .src_address = locals[i].addr,
1375 bitmap = clib_bitmap_set (
1376 bitmap, nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index, 0),
1381 /* Assign workers */
1382 if (sm->num_workers > 1)
1384 clib_bitmap_foreach (i, bitmap)
1386 vec_add1 (m->workers, i);
1394 nat44_ed_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1395 ip_protocol_t proto, u32 flags)
1397 snat_main_t *sm = &snat_main;
1398 snat_static_mapping_t *m;
1400 nat44_lb_addr_port_t *local;
1401 snat_main_per_thread_data_t *tsm;
1406 return VNET_API_ERROR_UNSUPPORTED;
1409 m = nat44_ed_sm_o2i_lookup (sm, e_addr, e_port, 0, proto);
1411 return VNET_API_ERROR_NO_SUCH_ENTRY;
1413 if (!is_sm_lb (m->flags))
1414 return VNET_API_ERROR_INVALID_VALUE;
1416 if (nat44_ed_sm_o2i_del (sm, m->external_addr, m->external_port, 0,
1419 nat_log_err ("sm o2i key del failed");
1420 return VNET_API_ERROR_UNSPECIFIED;
1423 pool_foreach (local, m->locals)
1425 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
1426 if (!is_sm_out2in_only (flags))
1428 if (nat44_ed_sm_i2o_del (sm, local->addr, local->port,
1429 local->fib_index, m->proto))
1431 nat_log_err ("sm i2o key del failed");
1432 return VNET_API_ERROR_UNSPECIFIED;
1436 if (sm->num_workers > 1)
1439 .src_address = local->addr,
1441 tsm = vec_elt_at_index (
1442 sm->per_thread_data,
1443 nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index, 0));
1446 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1448 /* Delete sessions */
1449 pool_foreach (s, tsm->sessions)
1451 if (!(nat44_ed_is_lb_session (s)))
1454 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1455 s->in2out.port != local->port)
1458 nat44_ed_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1459 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
1465 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1468 pool_free (m->locals);
1470 vec_free (m->workers);
1471 pool_put (sm->static_mappings, m);
1477 nat44_ed_add_del_lb_static_mapping_local (ip4_address_t e_addr, u16 e_port,
1478 ip4_address_t l_addr, u16 l_port,
1479 ip_protocol_t proto, u32 vrf_id,
1480 u8 probability, u8 is_add)
1482 snat_main_t *sm = &snat_main;
1483 snat_static_mapping_t *m = 0;
1484 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1485 snat_main_per_thread_data_t *tsm;
1493 return VNET_API_ERROR_UNSUPPORTED;
1496 m = nat44_ed_sm_o2i_lookup (sm, e_addr, e_port, 0, proto);
1500 return VNET_API_ERROR_NO_SUCH_ENTRY;
1503 if (!is_sm_lb (m->flags))
1505 return VNET_API_ERROR_INVALID_VALUE;
1508 pool_foreach (local, m->locals)
1510 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1511 (local->vrf_id == vrf_id))
1513 match_local = local;
1522 return VNET_API_ERROR_VALUE_EXIST;
1525 pool_get (m->locals, local);
1526 clib_memset (local, 0, sizeof (*local));
1527 local->addr.as_u32 = l_addr.as_u32;
1528 local->port = l_port;
1529 local->probability = probability;
1530 local->vrf_id = vrf_id;
1532 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1535 if (!is_sm_out2in_only (m->flags))
1537 if (nat44_ed_sm_i2o_add (sm, m, l_addr, l_port, local->fib_index,
1540 nat_log_err ("sm i2o key add failed");
1541 pool_put (m->locals, local);
1542 return VNET_API_ERROR_UNSPECIFIED;
1549 return VNET_API_ERROR_NO_SUCH_ENTRY;
1551 if (pool_elts (m->locals) < 3)
1552 return VNET_API_ERROR_UNSPECIFIED;
1554 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1557 if (!is_sm_out2in_only (m->flags))
1559 if (nat44_ed_sm_i2o_del (sm, l_addr, l_port, match_local->fib_index,
1561 nat_log_err ("sm i2o key del failed");
1564 if (sm->num_workers > 1)
1567 .src_address = local->addr,
1569 tsm = vec_elt_at_index (
1570 sm->per_thread_data,
1571 nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index, 0));
1574 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1576 /* Delete sessions */
1577 pool_foreach (s, tsm->sessions) {
1578 if (!(nat44_ed_is_lb_session (s)))
1581 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1582 s->in2out.port != match_local->port)
1585 nat44_ed_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1586 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
1589 pool_put (m->locals, match_local);
1592 vec_free (m->workers);
1594 pool_foreach (local, m->locals)
1596 vec_add1 (locals, local - m->locals);
1597 if (sm->num_workers > 1)
1600 ip.src_address.as_u32 = local->addr.as_u32,
1601 bitmap = clib_bitmap_set (
1603 nat44_ed_get_in2out_worker_index (0, &ip, local->fib_index, 0), 1);
1607 ASSERT (vec_len (locals) > 1);
1609 local = pool_elt_at_index (m->locals, locals[0]);
1610 local->prefix = local->probability;
1611 for (i = 1; i < vec_len (locals); i++)
1613 local = pool_elt_at_index (m->locals, locals[i]);
1614 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1615 local->prefix = local->probability + prev_local->prefix;
1618 /* Assign workers */
1619 if (sm->num_workers > 1)
1621 clib_bitmap_foreach (i, bitmap) { vec_add1(m->workers, i); }
1628 expire_per_vrf_sessions (u32 fib_index)
1630 per_vrf_sessions_t *per_vrf_sessions;
1631 snat_main_per_thread_data_t *tsm;
1632 snat_main_t *sm = &snat_main;
1634 vec_foreach (tsm, sm->per_thread_data)
1636 pool_foreach (per_vrf_sessions, tsm->per_vrf_sessions_pool)
1638 if ((per_vrf_sessions->rx_fib_index == fib_index) ||
1639 (per_vrf_sessions->tx_fib_index == fib_index))
1641 per_vrf_sessions->expired = 1;
1648 update_per_vrf_sessions_pool (u32 fib_index, int is_del)
1650 snat_main_t *sm = &snat_main;
1653 // we don't care if it is outside/inside fib
1654 // we just care about their ref_count
1655 // if it reaches 0 sessions should expire
1656 // because the fib isn't valid for NAT anymore
1658 vec_foreach (fib, sm->fibs)
1660 if (fib->fib_index == fib_index)
1665 if (!fib->ref_count)
1667 vec_del1 (sm->fibs, fib - sm->fibs);
1668 expire_per_vrf_sessions (fib_index);
1678 vec_add2 (sm->fibs, fib, 1);
1680 fib->fib_index = fib_index;
1684 static_always_inline nat_fib_t *
1685 nat44_ed_get_outside_fib (nat_fib_t *outside_fibs, u32 fib_index)
1688 vec_foreach (f, outside_fibs)
1690 if (f->fib_index == fib_index)
1698 static_always_inline snat_interface_t *
1699 nat44_ed_get_interface (snat_interface_t *interfaces, u32 sw_if_index)
1701 snat_interface_t *i;
1702 pool_foreach (i, interfaces)
1704 if (i->sw_if_index == sw_if_index)
1713 nat44_ed_add_interface (u32 sw_if_index, u8 is_inside)
1715 const char *del_feature_name, *feature_name;
1716 snat_main_t *sm = &snat_main;
1718 nat_fib_t *outside_fib;
1719 snat_interface_t *i;
1725 nat_log_err ("nat44 is disabled");
1726 return VNET_API_ERROR_UNSUPPORTED;
1729 if (nat44_ed_get_interface (sm->output_feature_interfaces, sw_if_index))
1731 nat_log_err ("error interface already configured");
1732 return VNET_API_ERROR_VALUE_EXIST;
1735 i = nat44_ed_get_interface (sm->interfaces, sw_if_index);
1738 if ((nat44_ed_is_interface_inside (i) && is_inside) ||
1739 (nat44_ed_is_interface_outside (i) && !is_inside))
1743 if (sm->num_workers > 1)
1745 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1746 "nat44-out2in-worker-handoff";
1747 feature_name = "nat44-handoff-classify";
1751 del_feature_name = !is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1753 feature_name = "nat44-ed-classify";
1756 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1759 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1760 sw_if_index, 0, 0, 0);
1761 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1,
1766 if (sm->num_workers > 1)
1768 feature_name = is_inside ? "nat44-in2out-worker-handoff" :
1769 "nat44-out2in-worker-handoff";
1773 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1776 nat_validate_interface_counters (sm, sw_if_index);
1777 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1780 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1,
1783 pool_get (sm->interfaces, i);
1784 i->sw_if_index = sw_if_index;
1789 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
1791 update_per_vrf_sessions_pool (fib_index, 0 /*is_del*/);
1795 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1797 outside_fib = nat44_ed_get_outside_fib (sm->outside_fibs, fib_index);
1800 outside_fib->ref_count++;
1804 vec_add2 (sm->outside_fibs, outside_fib, 1);
1805 outside_fib->fib_index = fib_index;
1806 outside_fib->ref_count = 1;
1809 nat44_ed_add_del_nat_addr_fib_reg_entries (sw_if_index, 1);
1810 nat44_ed_add_del_sm_fib_reg_entries (sw_if_index, 1);
1812 nat44_ed_bind_if_addr_to_nat_addr (sw_if_index);
1816 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1823 nat44_ed_del_interface (u32 sw_if_index, u8 is_inside)
1825 const char *del_feature_name, *feature_name;
1826 snat_main_t *sm = &snat_main;
1828 nat_fib_t *outside_fib;
1829 snat_interface_t *i;
1835 nat_log_err ("nat44 is disabled");
1836 return VNET_API_ERROR_UNSUPPORTED;
1839 i = nat44_ed_get_interface (sm->interfaces, sw_if_index);
1842 nat_log_err ("error interface couldn't be found");
1843 return VNET_API_ERROR_NO_SUCH_ENTRY;
1846 if (nat44_ed_is_interface_inside (i) && nat44_ed_is_interface_outside (i))
1848 if (sm->num_workers > 1)
1850 del_feature_name = "nat44-handoff-classify";
1851 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1852 "nat44-out2in-worker-handoff";
1856 del_feature_name = "nat44-ed-classify";
1857 feature_name = !is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1860 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1865 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1866 sw_if_index, 0, 0, 0);
1867 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1,
1872 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1876 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1881 if (sm->num_workers > 1)
1883 feature_name = is_inside ? "nat44-in2out-worker-handoff" :
1884 "nat44-out2in-worker-handoff";
1888 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1891 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1896 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 0,
1900 pool_put (sm->interfaces, i);
1904 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
1906 update_per_vrf_sessions_pool (fib_index, 1 /*is_del*/);
1910 outside_fib = nat44_ed_get_outside_fib (sm->outside_fibs, fib_index);
1913 outside_fib->ref_count--;
1914 if (!outside_fib->ref_count)
1916 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1920 nat44_ed_add_del_nat_addr_fib_reg_entries (sw_if_index, 0);
1921 nat44_ed_add_del_sm_fib_reg_entries (sw_if_index, 0);
1928 nat44_ed_add_output_interface (u32 sw_if_index)
1930 snat_main_t *sm = &snat_main;
1932 nat_fib_t *outside_fib;
1933 snat_interface_t *i;
1939 nat_log_err ("nat44 is disabled");
1940 return VNET_API_ERROR_UNSUPPORTED;
1943 if (nat44_ed_get_interface (sm->interfaces, sw_if_index))
1945 nat_log_err ("error interface already configured");
1946 return VNET_API_ERROR_VALUE_EXIST;
1949 if (nat44_ed_get_interface (sm->output_feature_interfaces, sw_if_index))
1951 nat_log_err ("error interface already configured");
1952 return VNET_API_ERROR_VALUE_EXIST;
1955 if (sm->num_workers > 1)
1957 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1963 rv = ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, 1);
1969 vnet_feature_enable_disable (
1970 "ip4-unicast", "nat44-out2in-worker-handoff", sw_if_index, 1, 0, 0);
1971 vnet_feature_enable_disable ("ip4-output",
1972 "nat44-in2out-output-worker-handoff",
1973 sw_if_index, 1, 0, 0);
1977 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1983 rv = ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, 1);
1989 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
1990 sw_if_index, 1, 0, 0);
1991 vnet_feature_enable_disable ("ip4-output", "nat-pre-in2out-output",
1992 sw_if_index, 1, 0, 0);
1995 nat_validate_interface_counters (sm, sw_if_index);
1997 pool_get (sm->output_feature_interfaces, i);
1998 i->sw_if_index = sw_if_index;
2000 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2001 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2004 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
2005 update_per_vrf_sessions_pool (fib_index, 0 /*is_del*/);
2007 outside_fib = nat44_ed_get_outside_fib (sm->outside_fibs, fib_index);
2010 outside_fib->ref_count++;
2014 vec_add2 (sm->outside_fibs, outside_fib, 1);
2015 outside_fib->fib_index = fib_index;
2016 outside_fib->ref_count = 1;
2019 nat44_ed_add_del_nat_addr_fib_reg_entries (sw_if_index, 1);
2020 nat44_ed_add_del_sm_fib_reg_entries (sw_if_index, 1);
2022 nat44_ed_bind_if_addr_to_nat_addr (sw_if_index);
2028 nat44_ed_del_output_interface (u32 sw_if_index)
2030 snat_main_t *sm = &snat_main;
2032 nat_fib_t *outside_fib;
2033 snat_interface_t *i;
2039 nat_log_err ("nat44 is disabled");
2040 return VNET_API_ERROR_UNSUPPORTED;
2043 i = nat44_ed_get_interface (sm->output_feature_interfaces, sw_if_index);
2046 nat_log_err ("error interface couldn't be found");
2047 return VNET_API_ERROR_NO_SUCH_ENTRY;
2050 if (sm->num_workers > 1)
2052 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2058 rv = ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, 0);
2064 vnet_feature_enable_disable (
2065 "ip4-unicast", "nat44-out2in-worker-handoff", sw_if_index, 0, 0, 0);
2066 vnet_feature_enable_disable ("ip4-output",
2067 "nat44-in2out-output-worker-handoff",
2068 sw_if_index, 0, 0, 0);
2072 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2078 rv = ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, 0);
2084 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
2085 sw_if_index, 0, 0, 0);
2086 vnet_feature_enable_disable ("ip4-output", "nat-pre-in2out-output",
2087 sw_if_index, 0, 0, 0);
2091 pool_put (sm->output_feature_interfaces, i);
2094 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
2095 update_per_vrf_sessions_pool (fib_index, 1 /*is_del*/);
2097 outside_fib = nat44_ed_get_outside_fib (sm->outside_fibs, fib_index);
2100 outside_fib->ref_count--;
2101 if (!outside_fib->ref_count)
2103 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2107 nat44_ed_add_del_nat_addr_fib_reg_entries (sw_if_index, 0);
2108 nat44_ed_add_del_sm_fib_reg_entries (sw_if_index, 0);
2114 snat_set_workers (uword * bitmap)
2116 snat_main_t *sm = &snat_main;
2119 if (sm->num_workers < 2)
2120 return VNET_API_ERROR_FEATURE_DISABLED;
2122 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2123 return VNET_API_ERROR_INVALID_WORKER;
2125 vec_free (sm->workers);
2126 clib_bitmap_foreach (i, bitmap)
2128 vec_add1(sm->workers, i);
2129 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2130 sm->per_thread_data[sm->first_worker_index + i].thread_index = i;
2134 sm->port_per_thread = (65536 - ED_USER_PORT_OFFSET) / _vec_len (sm->workers);
2140 nat44_ed_set_frame_queue_nelts (u32 frame_queue_nelts)
2143 snat_main_t *sm = &snat_main;
2145 if ((sm->fq_in2out_index != ~0) || (sm->fq_out2in_index != ~0) ||
2146 (sm->fq_in2out_output_index != ~0))
2148 // frame queu nelts can be set only before first
2149 // call to nat44_plugin_enable after that it
2150 // doesn't make sense
2151 nat_log_err ("Frame queue was already initialized. "
2152 "Change is not possible");
2156 sm->frame_queue_nelts = frame_queue_nelts;
2161 nat44_ed_update_outside_fib_cb (ip4_main_t *im, uword opaque, u32 sw_if_index,
2162 u32 new_fib_index, u32 old_fib_index)
2164 snat_main_t *sm = &snat_main;
2165 nat_fib_t *outside_fib;
2166 snat_interface_t *i;
2170 if (!sm->enabled || (new_fib_index == old_fib_index)
2171 || (!vec_len (sm->outside_fibs)))
2176 pool_foreach (i, sm->interfaces)
2178 if (i->sw_if_index == sw_if_index)
2180 if (!(nat44_ed_is_interface_outside (i)))
2186 pool_foreach (i, sm->output_feature_interfaces)
2188 if (i->sw_if_index == sw_if_index)
2190 if (!(nat44_ed_is_interface_outside (i)))
2199 vec_foreach (outside_fib, sm->outside_fibs)
2201 if (outside_fib->fib_index == old_fib_index)
2203 outside_fib->ref_count--;
2204 if (!outside_fib->ref_count)
2205 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2210 vec_foreach (outside_fib, sm->outside_fibs)
2212 if (outside_fib->fib_index == new_fib_index)
2214 outside_fib->ref_count++;
2222 vec_add2 (sm->outside_fibs, outside_fib, 1);
2223 outside_fib->ref_count = 1;
2224 outside_fib->fib_index = new_fib_index;
2228 static void nat44_ed_update_outside_fib_cb (ip4_main_t *im, uword opaque,
2229 u32 sw_if_index, u32 new_fib_index,
2232 static void nat44_ed_add_del_interface_address_cb (
2233 ip4_main_t *im, uword opaque, u32 sw_if_index, ip4_address_t *address,
2234 u32 address_length, u32 if_address_index, u32 is_delete);
2236 static void nat44_ed_add_del_static_mapping_cb (
2237 ip4_main_t *im, uword opaque, u32 sw_if_index, ip4_address_t *address,
2238 u32 address_length, u32 if_address_index, u32 is_delete);
2241 test_key_calc_split ()
2243 ip4_address_t l_addr;
2244 l_addr.as_u8[0] = 1;
2245 l_addr.as_u8[1] = 1;
2246 l_addr.as_u8[2] = 1;
2247 l_addr.as_u8[3] = 1;
2248 ip4_address_t r_addr;
2249 r_addr.as_u8[0] = 2;
2250 r_addr.as_u8[1] = 2;
2251 r_addr.as_u8[2] = 2;
2252 r_addr.as_u8[3] = 2;
2256 u32 fib_index = 9000001;
2257 u32 thread_index = 3000000001;
2258 u32 session_index = 3000000221;
2259 clib_bihash_kv_16_8_t kv;
2260 init_ed_kv (&kv, l_addr.as_u32, l_port, r_addr.as_u32, r_port, fib_index,
2261 proto, thread_index, session_index);
2262 ip4_address_t l_addr2;
2263 ip4_address_t r_addr2;
2264 clib_memset (&l_addr2, 0, sizeof (l_addr2));
2265 clib_memset (&r_addr2, 0, sizeof (r_addr2));
2270 split_ed_kv (&kv, &l_addr2, &r_addr2, &proto2, &fib_index2, &l_port2,
2272 ASSERT (l_addr.as_u32 == l_addr2.as_u32);
2273 ASSERT (r_addr.as_u32 == r_addr2.as_u32);
2274 ASSERT (l_port == l_port2);
2275 ASSERT (r_port == r_port2);
2276 ASSERT (proto == proto2);
2277 ASSERT (fib_index == fib_index2);
2278 ASSERT (thread_index == ed_value_get_thread_index (&kv));
2279 ASSERT (session_index == ed_value_get_session_index (&kv));
2282 static clib_error_t *
2283 nat_ip_table_add_del (vnet_main_t * vnm, u32 table_id, u32 is_add)
2288 fib_index = ip4_fib_index_from_table_id (table_id);
2289 if (fib_index != ~0)
2291 expire_per_vrf_sessions (fib_index);
2297 VNET_IP_TABLE_ADD_DEL_FUNCTION (nat_ip_table_add_del);
2299 #define nat_validate_simple_counter(c, i) \
2302 vlib_validate_simple_counter (&c, i); \
2303 vlib_zero_simple_counter (&c, i); \
2307 #define nat_init_simple_counter(c, n, sn) \
2311 c.stat_segment_name = sn; \
2312 nat_validate_simple_counter (c, 0); \
2316 static_always_inline void
2317 nat_validate_interface_counters (snat_main_t *sm, u32 sw_if_index)
2320 nat_validate_simple_counter (sm->counters.fastpath.in2out.x, sw_if_index); \
2321 nat_validate_simple_counter (sm->counters.fastpath.out2in.x, sw_if_index); \
2322 nat_validate_simple_counter (sm->counters.slowpath.in2out.x, sw_if_index); \
2323 nat_validate_simple_counter (sm->counters.slowpath.out2in.x, sw_if_index);
2324 foreach_nat_counter;
2326 nat_validate_simple_counter (sm->counters.hairpinning, sw_if_index);
2329 static clib_error_t *
2330 nat_init (vlib_main_t * vm)
2332 snat_main_t *sm = &snat_main;
2333 vlib_thread_main_t *tm = vlib_get_thread_main ();
2334 vlib_thread_registration_t *tr;
2335 ip4_add_del_interface_address_callback_t cbi = { 0 };
2336 ip4_table_bind_callback_t cbt = { 0 };
2337 u32 i, num_threads = 0;
2338 uword *p, *bitmap = 0;
2340 clib_memset (sm, 0, sizeof (*sm));
2343 sm->ip4_main = &ip4_main;
2345 // frame queue indices used for handoff
2346 sm->fq_out2in_index = ~0;
2347 sm->fq_in2out_index = ~0;
2348 sm->fq_in2out_output_index = ~0;
2350 sm->log_level = NAT_LOG_ERROR;
2352 sm->log_class = vlib_log_register_class ("nat", 0);
2353 nat_ipfix_logging_init (vm);
2355 nat_init_simple_counter (sm->total_sessions, "total-sessions",
2356 "/nat44-ed/total-sessions");
2357 sm->max_cfg_sessions_gauge =
2358 vlib_stats_add_gauge ("/nat44-ed/max-cfg-sessions");
2361 nat_init_simple_counter (sm->counters.fastpath.in2out.x, #x, \
2362 "/nat44-ed/in2out/fastpath/" #x); \
2363 nat_init_simple_counter (sm->counters.fastpath.out2in.x, #x, \
2364 "/nat44-ed/out2in/fastpath/" #x); \
2365 nat_init_simple_counter (sm->counters.slowpath.in2out.x, #x, \
2366 "/nat44-ed/in2out/slowpath/" #x); \
2367 nat_init_simple_counter (sm->counters.slowpath.out2in.x, #x, \
2368 "/nat44-ed/out2in/slowpath/" #x);
2369 foreach_nat_counter;
2371 nat_init_simple_counter (sm->counters.hairpinning, "hairpinning",
2372 "/nat44-ed/hairpinning");
2374 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2377 tr = (vlib_thread_registration_t *) p[0];
2380 sm->num_workers = tr->count;
2381 sm->first_worker_index = tr->first_index;
2384 num_threads = tm->n_vlib_mains - 1;
2385 sm->port_per_thread = 65536 - ED_USER_PORT_OFFSET;
2386 vec_validate (sm->per_thread_data, num_threads);
2388 /* Use all available workers by default */
2389 if (sm->num_workers > 1)
2391 for (i = 0; i < sm->num_workers; i++)
2392 bitmap = clib_bitmap_set (bitmap, i, 1);
2393 snat_set_workers (bitmap);
2394 clib_bitmap_free (bitmap);
2398 sm->per_thread_data[0].snat_thread_index = 0;
2401 /* callbacks to call when interface address changes. */
2402 cbi.function = nat44_ed_add_del_interface_address_cb;
2403 vec_add1 (sm->ip4_main->add_del_interface_address_callbacks, cbi);
2404 cbi.function = nat44_ed_add_del_static_mapping_cb;
2405 vec_add1 (sm->ip4_main->add_del_interface_address_callbacks, cbi);
2407 /* callbacks to call when interface to table biding changes */
2408 cbt.function = nat44_ed_update_outside_fib_cb;
2409 vec_add1 (sm->ip4_main->table_bind_callbacks, cbt);
2412 fib_source_allocate ("nat-low", FIB_SOURCE_PRIORITY_LOW,
2413 FIB_SOURCE_BH_SIMPLE);
2415 fib_source_allocate ("nat-hi", FIB_SOURCE_PRIORITY_HI,
2416 FIB_SOURCE_BH_SIMPLE);
2418 nat_affinity_init (vm);
2419 test_key_calc_split ();
2421 return nat44_api_hookup (vm);
2424 VLIB_INIT_FUNCTION (nat_init);
2427 nat44_plugin_enable (nat44_config_t c)
2429 snat_main_t *sm = &snat_main;
2433 sm->forwarding_enabled = 0;
2434 sm->mss_clamping = 0;
2437 c.sessions = 63 * 1024;
2439 sm->max_translations_per_thread = c.sessions;
2440 vlib_stats_set_gauge (sm->max_cfg_sessions_gauge,
2441 sm->max_translations_per_thread);
2442 sm->translation_buckets = nat_calc_bihash_buckets (c.sessions);
2444 vec_add1 (sm->max_translations_per_fib, sm->max_translations_per_thread);
2446 sm->inside_vrf_id = c.inside_vrf;
2447 sm->inside_fib_index =
2448 fib_table_find_or_create_and_lock
2449 (FIB_PROTOCOL_IP4, c.inside_vrf, sm->fib_src_hi);
2451 sm->outside_vrf_id = c.outside_vrf;
2452 sm->outside_fib_index = fib_table_find_or_create_and_lock (
2453 FIB_PROTOCOL_IP4, c.outside_vrf, sm->fib_src_hi);
2455 nat44_ed_db_init (sm->max_translations_per_thread, sm->translation_buckets);
2457 nat_affinity_enable ();
2459 nat_reset_timeouts (&sm->timeouts);
2461 vlib_zero_simple_counter (&sm->total_sessions, 0);
2463 if (!sm->frame_queue_nelts)
2465 sm->frame_queue_nelts = NAT_FQ_NELTS_DEFAULT;
2468 if (sm->num_workers > 1)
2470 vlib_main_t *vm = vlib_get_main ();
2473 if (sm->fq_in2out_index == ~0)
2475 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out");
2476 sm->fq_in2out_index =
2477 vlib_frame_queue_main_init (node->index, sm->frame_queue_nelts);
2479 if (sm->fq_out2in_index == ~0)
2481 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in");
2482 sm->fq_out2in_index =
2483 vlib_frame_queue_main_init (node->index, sm->frame_queue_nelts);
2485 if (sm->fq_in2out_output_index == ~0)
2487 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-output");
2488 sm->fq_in2out_output_index =
2489 vlib_frame_queue_main_init (node->index, sm->frame_queue_nelts);
2500 nat44_ed_del_addresses ()
2502 snat_main_t *sm = &snat_main;
2503 snat_address_t *a, *vec;
2506 vec = vec_dup (sm->addresses);
2507 vec_foreach (a, vec)
2509 error = nat44_ed_del_address (a->addr, 0);
2512 nat_log_err ("error occurred while removing adderess");
2516 vec_free (sm->addresses);
2519 vec = vec_dup (sm->twice_nat_addresses);
2520 vec_foreach (a, vec)
2522 error = nat44_ed_del_address (a->addr, 1);
2525 nat_log_err ("error occurred while removing adderess");
2529 vec_free (sm->twice_nat_addresses);
2530 sm->twice_nat_addresses = 0;
2532 vec_free (sm->addr_to_resolve);
2533 sm->addr_to_resolve = 0;
2539 nat44_ed_del_interfaces ()
2541 snat_main_t *sm = &snat_main;
2542 snat_interface_t *i, *pool;
2545 pool = pool_dup (sm->interfaces);
2546 pool_foreach (i, pool)
2548 if (nat44_ed_is_interface_inside (i))
2550 error = nat44_ed_del_interface (i->sw_if_index, 1);
2552 if (nat44_ed_is_interface_outside (i))
2554 error = nat44_ed_del_interface (i->sw_if_index, 0);
2559 nat_log_err ("error occurred while removing interface");
2563 pool_free (sm->interfaces);
2569 nat44_ed_del_output_interfaces ()
2571 snat_main_t *sm = &snat_main;
2572 snat_interface_t *i, *pool;
2575 pool = pool_dup (sm->output_feature_interfaces);
2576 pool_foreach (i, pool)
2578 error = nat44_ed_del_output_interface (i->sw_if_index);
2581 nat_log_err ("error occurred while removing output interface");
2585 pool_free (sm->output_feature_interfaces);
2586 sm->output_feature_interfaces = 0;
2590 static clib_error_t *
2591 nat44_ed_sw_interface_add_del (vnet_main_t *vnm, u32 sw_if_index, u32 is_add)
2593 snat_main_t *sm = &snat_main;
2594 snat_interface_t *i;
2603 i = nat44_ed_get_interface (sm->interfaces, sw_if_index);
2606 bool is_inside = nat44_ed_is_interface_inside (i);
2607 bool is_outside = nat44_ed_is_interface_outside (i);
2611 error |= nat44_ed_del_interface (sw_if_index, 1);
2615 error |= nat44_ed_del_interface (sw_if_index, 0);
2620 nat_log_err ("error occurred while removing interface");
2624 i = nat44_ed_get_interface (sm->output_feature_interfaces, sw_if_index);
2627 error = nat44_ed_del_output_interface (sw_if_index);
2630 nat_log_err ("error occurred while removing output interface");
2637 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (nat44_ed_sw_interface_add_del);
2640 nat44_ed_del_static_mappings ()
2642 snat_main_t *sm = &snat_main;
2643 snat_static_mapping_t *m, *pool;
2646 pool = pool_dup (sm->static_mappings);
2647 pool_foreach (m, pool)
2649 error = nat44_ed_del_static_mapping_internal (
2650 m->local_addr, m->external_addr, m->local_port, m->external_port,
2651 m->proto, m->vrf_id, m->flags);
2654 nat_log_err ("error occurred while removing mapping");
2658 pool_free (sm->static_mappings);
2659 sm->static_mappings = 0;
2661 vec_free (sm->sm_to_resolve);
2662 sm->sm_to_resolve = 0;
2668 nat44_plugin_disable ()
2670 snat_main_per_thread_data_t *tsm;
2671 snat_main_t *sm = &snat_main;
2674 fail_if_disabled ();
2676 rc = nat44_ed_del_static_mappings ();
2678 error = VNET_API_ERROR_BUG;
2680 rc = nat44_ed_del_addresses ();
2682 error = VNET_API_ERROR_BUG;
2684 rc = nat44_ed_del_interfaces ();
2686 error = VNET_API_ERROR_BUG;
2688 rc = nat44_ed_del_output_interfaces ();
2690 error = VNET_API_ERROR_BUG;
2692 nat44_ed_del_vrf_tables ();
2694 vec_free (sm->max_translations_per_fib);
2695 sm->max_translations_per_fib = 0;
2697 clib_bihash_free_16_8 (&sm->flow_hash);
2699 vec_foreach (tsm, sm->per_thread_data)
2701 nat44_ed_worker_db_free (tsm);
2704 clib_memset (&sm->rconfig, 0, sizeof (sm->rconfig));
2706 nat_affinity_disable ();
2708 sm->forwarding_enabled = 0;
2715 nat44_ed_forwarding_enable_disable (u8 is_enable)
2717 snat_main_per_thread_data_t *tsm;
2718 snat_main_t *sm = &snat_main;
2721 u32 *ses_to_be_removed = 0, *ses_index;
2723 sm->forwarding_enabled = is_enable != 0;
2725 if (!sm->enabled || is_enable)
2730 vec_foreach (tsm, sm->per_thread_data)
2732 pool_foreach (s, tsm->sessions)
2734 if (na44_ed_is_fwd_bypass_session (s))
2736 vec_add1 (ses_to_be_removed, s - tsm->sessions);
2739 vec_foreach (ses_index, ses_to_be_removed)
2741 s = pool_elt_at_index (tsm->sessions, ses_index[0]);
2742 nat44_ed_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
2743 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
2746 vec_free (ses_to_be_removed);
2750 static_always_inline snat_static_mapping_t *
2751 nat44_ed_sm_match (snat_main_t *sm, ip4_address_t match_addr, u16 match_port,
2752 u32 match_fib_index, ip_protocol_t match_protocol,
2755 snat_static_mapping_t *m;
2758 m = nat44_ed_sm_i2o_lookup (sm, match_addr, match_port, match_fib_index,
2763 // try address only mapping
2764 m = nat44_ed_sm_i2o_lookup (sm, match_addr, 0, match_fib_index, 0);
2768 // default static mapping fib index (based on configuration)
2769 if (sm->inside_fib_index != match_fib_index)
2771 m = nat44_ed_sm_i2o_lookup (sm, match_addr, match_port,
2772 sm->inside_fib_index, match_protocol);
2776 // try address only mapping
2777 m = nat44_ed_sm_i2o_lookup (sm, match_addr, 0, sm->inside_fib_index,
2782 // TODO: this specific use case may be deprecated (needs testing)
2783 if (sm->outside_fib_index != match_fib_index)
2785 m = nat44_ed_sm_i2o_lookup (sm, match_addr, match_port,
2786 sm->outside_fib_index, match_protocol);
2790 // try address only mapping
2791 m = nat44_ed_sm_i2o_lookup (sm, match_addr, 0, sm->outside_fib_index,
2800 nat44_ed_sm_o2i_lookup (sm, match_addr, match_port, 0, match_protocol);
2804 // try address only mapping
2805 m = nat44_ed_sm_o2i_lookup (sm, match_addr, 0, 0, 0);
2813 snat_static_mapping_match (vlib_main_t *vm, ip4_address_t match_addr,
2814 u16 match_port, u32 match_fib_index,
2815 ip_protocol_t match_protocol,
2816 ip4_address_t *mapping_addr, u16 *mapping_port,
2817 u32 *mapping_fib_index, int by_external,
2818 u8 *is_addr_only, twice_nat_type_t *twice_nat,
2819 lb_nat_type_t *lb, ip4_address_t *ext_host_addr,
2820 u8 *is_identity_nat, snat_static_mapping_t **out)
2822 snat_main_t *sm = &snat_main;
2823 snat_static_mapping_t *m;
2824 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2825 nat44_lb_addr_port_t *local;
2828 m = nat44_ed_sm_match (sm, match_addr, match_port, match_fib_index,
2829 match_protocol, by_external);
2837 if (is_sm_lb (m->flags))
2839 if (PREDICT_FALSE (lb != 0))
2840 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2841 if (m->affinity && !nat_affinity_find_and_lock (
2842 vm, ext_host_addr[0], match_addr,
2843 match_protocol, match_port, &backend_index))
2845 local = pool_elt_at_index (m->locals, backend_index);
2846 *mapping_addr = local->addr;
2847 *mapping_port = local->port;
2848 *mapping_fib_index = local->fib_index;
2851 // pick locals matching this worker
2852 if (PREDICT_FALSE (sm->num_workers > 1))
2854 u32 thread_index = vlib_get_thread_index ();
2855 pool_foreach_index (i, m->locals)
2857 local = pool_elt_at_index (m->locals, i);
2860 .src_address = local->addr,
2863 if (nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index,
2869 ASSERT (vec_len (tmp) != 0);
2873 pool_foreach_index (i, m->locals)
2878 hi = vec_len (tmp) - 1;
2879 local = pool_elt_at_index (m->locals, tmp[hi]);
2880 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2883 mid = ((hi - lo) >> 1) + lo;
2884 local = pool_elt_at_index (m->locals, tmp[mid]);
2885 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2887 local = pool_elt_at_index (m->locals, tmp[lo]);
2888 if (!(local->prefix >= rand))
2890 *mapping_addr = local->addr;
2891 *mapping_port = local->port;
2892 *mapping_fib_index = local->fib_index;
2895 if (nat_affinity_create_and_lock (ext_host_addr[0], match_addr,
2896 match_protocol, match_port,
2897 tmp[lo], m->affinity,
2898 m->affinity_per_service_list_head_index))
2899 nat_elog_info (sm, "create affinity record failed");
2905 if (PREDICT_FALSE (lb != 0))
2907 *mapping_fib_index = m->fib_index;
2908 *mapping_addr = m->local_addr;
2909 /* Address only mapping doesn't change port */
2911 is_sm_addr_only (m->flags) ? match_port : m->local_port;
2916 *mapping_addr = m->external_addr;
2917 /* Address only mapping doesn't change port */
2919 is_sm_addr_only (m->flags) ? match_port : m->external_port;
2920 *mapping_fib_index = sm->outside_fib_index;
2924 if (PREDICT_FALSE (is_addr_only != 0))
2925 *is_addr_only = is_sm_addr_only (m->flags);
2927 if (PREDICT_FALSE (twice_nat != 0))
2929 *twice_nat = TWICE_NAT_DISABLED;
2931 if (is_sm_twice_nat (m->flags))
2933 *twice_nat = TWICE_NAT;
2935 else if (is_sm_self_twice_nat (m->flags))
2937 *twice_nat = TWICE_NAT_SELF;
2941 if (PREDICT_FALSE (is_identity_nat != 0))
2942 *is_identity_nat = is_sm_identity_nat (m->flags);
2951 nat44_ed_get_in2out_worker_index (vlib_buffer_t *b, ip4_header_t *ip,
2952 u32 rx_fib_index, u8 is_output)
2954 snat_main_t *sm = &snat_main;
2955 u32 next_worker_index = sm->first_worker_index;
2958 clib_bihash_kv_16_8_t kv16, value16;
2960 u32 fib_index = rx_fib_index;
2963 if (PREDICT_FALSE (is_output))
2965 fib_index = sm->outside_fib_index;
2966 nat_fib_t *outside_fib;
2967 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
2968 fib_prefix_t pfx = {
2969 .fp_proto = FIB_PROTOCOL_IP4,
2972 .ip4.as_u32 = ip->dst_address.as_u32,
2976 switch (vec_len (sm->outside_fibs))
2979 fib_index = sm->outside_fib_index;
2982 fib_index = sm->outside_fibs[0].fib_index;
2985 vec_foreach (outside_fib, sm->outside_fibs)
2987 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
2988 if (FIB_NODE_INDEX_INVALID != fei)
2990 if (fib_entry_get_resolving_interface (fei) != ~0)
2992 fib_index = outside_fib->fib_index;
3001 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
3003 ip4_address_t lookup_saddr, lookup_daddr;
3004 u16 lookup_sport, lookup_dport;
3007 if (!nat_get_icmp_session_lookup_values (
3008 b, ip, &lookup_saddr, &lookup_sport, &lookup_daddr,
3009 &lookup_dport, &lookup_protocol))
3011 init_ed_k (&kv16, lookup_saddr.as_u32, lookup_sport,
3012 lookup_daddr.as_u32, lookup_dport, rx_fib_index,
3014 if (!clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16))
3016 next_worker_index = ed_value_get_thread_index (&value16);
3017 vnet_buffer2 (b)->nat.cached_session_index =
3018 ed_value_get_session_index (&value16);
3024 init_ed_k (&kv16, ip->src_address.as_u32,
3025 vnet_buffer (b)->ip.reass.l4_src_port, ip->dst_address.as_u32,
3026 vnet_buffer (b)->ip.reass.l4_dst_port, fib_index,
3029 if (!clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16))
3031 next_worker_index = ed_value_get_thread_index (&value16);
3032 vnet_buffer2 (b)->nat.cached_session_index =
3033 ed_value_get_session_index (&value16);
3038 init_ed_k (&kv16, ip->dst_address.as_u32,
3039 vnet_buffer (b)->ip.reass.l4_dst_port, ip->src_address.as_u32,
3040 vnet_buffer (b)->ip.reass.l4_src_port, rx_fib_index,
3042 if (!clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16))
3044 next_worker_index = ed_value_get_thread_index (&value16);
3045 vnet_buffer2 (b)->nat.cached_dst_nat_session_index =
3046 ed_value_get_session_index (&value16);
3051 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3052 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3054 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3055 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3057 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3060 if (PREDICT_TRUE (!is_output))
3062 nat_elog_debug_handoff (sm, "HANDOFF IN2OUT", next_worker_index,
3064 clib_net_to_host_u32 (ip->src_address.as_u32),
3065 clib_net_to_host_u32 (ip->dst_address.as_u32));
3069 nat_elog_debug_handoff (sm, "HANDOFF IN2OUT-OUTPUT-FEATURE",
3070 next_worker_index, rx_fib_index,
3071 clib_net_to_host_u32 (ip->src_address.as_u32),
3072 clib_net_to_host_u32 (ip->dst_address.as_u32));
3075 return next_worker_index;
3079 nat44_ed_get_out2in_worker_index (vlib_buffer_t *b, ip4_header_t *ip,
3080 u32 rx_fib_index, u8 is_output)
3082 snat_main_t *sm = &snat_main;
3083 clib_bihash_kv_16_8_t kv16, value16;
3085 u8 proto, next_worker_index = 0;
3087 snat_static_mapping_t *m;
3090 proto = ip->protocol;
3092 if (PREDICT_FALSE (IP_PROTOCOL_ICMP == proto))
3094 ip4_address_t lookup_saddr, lookup_daddr;
3095 u16 lookup_sport, lookup_dport;
3097 if (!nat_get_icmp_session_lookup_values (
3098 b, ip, &lookup_saddr, &lookup_sport, &lookup_daddr, &lookup_dport,
3101 init_ed_k (&kv16, lookup_saddr.as_u32, lookup_sport,
3102 lookup_daddr.as_u32, lookup_dport, rx_fib_index,
3105 !clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16)))
3107 next_worker_index = ed_value_get_thread_index (&value16);
3108 nat_elog_debug_handoff (
3109 sm, "HANDOFF OUT2IN (session)", next_worker_index,
3110 rx_fib_index, clib_net_to_host_u32 (ip->src_address.as_u32),
3111 clib_net_to_host_u32 (ip->dst_address.as_u32));
3112 return next_worker_index;
3117 init_ed_k (&kv16, ip->src_address.as_u32,
3118 vnet_buffer (b)->ip.reass.l4_src_port, ip->dst_address.as_u32,
3119 vnet_buffer (b)->ip.reass.l4_dst_port, rx_fib_index,
3123 !clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16)))
3125 vnet_buffer2 (b)->nat.cached_session_index =
3126 ed_value_get_session_index (&value16);
3127 next_worker_index = ed_value_get_thread_index (&value16);
3128 nat_elog_debug_handoff (sm, "HANDOFF OUT2IN (session)",
3129 next_worker_index, rx_fib_index,
3130 clib_net_to_host_u32 (ip->src_address.as_u32),
3131 clib_net_to_host_u32 (ip->dst_address.as_u32));
3132 return next_worker_index;
3135 /* first try static mappings without port */
3136 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3138 m = nat44_ed_sm_o2i_lookup (sm, ip->dst_address, 0, 0, proto);
3142 next_worker_index = m->workers[0];
3148 /* unknown protocol */
3149 if (PREDICT_FALSE (nat44_ed_is_unk_proto (proto)))
3151 /* use current thread */
3152 next_worker_index = vlib_get_thread_index ();
3156 port = vnet_buffer (b)->ip.reass.l4_dst_port;
3158 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
3160 udp_header_t *udp = ip4_next_header (ip);
3161 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3162 nat_icmp_echo_header_t *echo = (nat_icmp_echo_header_t *) (icmp + 1);
3163 if (!icmp_type_is_error_message
3164 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3165 port = vnet_buffer (b)->ip.reass.l4_src_port;
3168 /* if error message, then it's not fragmented and we can access it */
3169 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3170 proto = inner_ip->protocol;
3171 void *l4_header = ip4_next_header (inner_ip);
3174 case IP_PROTOCOL_ICMP:
3175 icmp = (icmp46_header_t *) l4_header;
3176 echo = (nat_icmp_echo_header_t *) (icmp + 1);
3177 port = echo->identifier;
3179 case IP_PROTOCOL_UDP:
3181 case IP_PROTOCOL_TCP:
3182 port = ((nat_tcp_udp_header_t *) l4_header)->src_port;
3185 next_worker_index = vlib_get_thread_index ();
3191 /* try static mappings with port */
3192 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3194 m = nat44_ed_sm_o2i_lookup (sm, ip->dst_address, port, 0, proto);
3197 if (!is_sm_lb (m->flags))
3199 next_worker_index = m->workers[0];
3203 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3204 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3206 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
3208 m->workers[hash & (_vec_len (m->workers) - 1)];
3210 next_worker_index = m->workers[hash % _vec_len (m->workers)];
3215 /* worker by outside port */
3216 next_worker_index = get_thread_idx_by_port (clib_net_to_host_u16 (port));
3219 nat_elog_debug_handoff (sm, "HANDOFF OUT2IN", next_worker_index,
3221 clib_net_to_host_u32 (ip->src_address.as_u32),
3222 clib_net_to_host_u32 (ip->dst_address.as_u32));
3223 return next_worker_index;
3227 nat44_get_max_session_limit ()
3229 snat_main_t *sm = &snat_main;
3230 u32 max_limit = 0, len = 0;
3232 for (; len < vec_len (sm->max_translations_per_fib); len++)
3234 if (max_limit < sm->max_translations_per_fib[len])
3235 max_limit = sm->max_translations_per_fib[len];
3241 nat44_set_session_limit (u32 session_limit, u32 vrf_id)
3243 snat_main_t *sm = &snat_main;
3244 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3245 u32 len = vec_len (sm->max_translations_per_fib);
3247 if (len <= fib_index)
3249 vec_validate (sm->max_translations_per_fib, fib_index + 1);
3251 for (; len < vec_len (sm->max_translations_per_fib); len++)
3252 sm->max_translations_per_fib[len] = sm->max_translations_per_thread;
3255 sm->max_translations_per_fib[fib_index] = session_limit;
3260 nat44_update_session_limit (u32 session_limit, u32 vrf_id)
3262 snat_main_t *sm = &snat_main;
3264 if (nat44_set_session_limit (session_limit, vrf_id))
3266 sm->max_translations_per_thread = nat44_get_max_session_limit ();
3268 vlib_stats_set_gauge (sm->max_cfg_sessions_gauge,
3269 sm->max_translations_per_thread);
3271 sm->translation_buckets =
3272 nat_calc_bihash_buckets (sm->max_translations_per_thread);
3274 nat44_ed_sessions_clear ();
3279 nat44_ed_worker_db_init (snat_main_per_thread_data_t *tsm, u32 translations,
3280 u32 translation_buckets)
3284 pool_alloc (tsm->sessions, translations);
3285 pool_alloc (tsm->lru_pool, translations);
3287 pool_get (tsm->lru_pool, head);
3288 tsm->tcp_trans_lru_head_index = head - tsm->lru_pool;
3289 clib_dlist_init (tsm->lru_pool, tsm->tcp_trans_lru_head_index);
3291 pool_get (tsm->lru_pool, head);
3292 tsm->tcp_estab_lru_head_index = head - tsm->lru_pool;
3293 clib_dlist_init (tsm->lru_pool, tsm->tcp_estab_lru_head_index);
3295 pool_get (tsm->lru_pool, head);
3296 tsm->udp_lru_head_index = head - tsm->lru_pool;
3297 clib_dlist_init (tsm->lru_pool, tsm->udp_lru_head_index);
3299 pool_get (tsm->lru_pool, head);
3300 tsm->icmp_lru_head_index = head - tsm->lru_pool;
3301 clib_dlist_init (tsm->lru_pool, tsm->icmp_lru_head_index);
3303 pool_get (tsm->lru_pool, head);
3304 tsm->unk_proto_lru_head_index = head - tsm->lru_pool;
3305 clib_dlist_init (tsm->lru_pool, tsm->unk_proto_lru_head_index);
3309 reinit_ed_flow_hash ()
3311 snat_main_t *sm = &snat_main;
3312 // we expect 2 flows per session, so multiply translation_buckets by 2
3313 clib_bihash_init_16_8 (
3314 &sm->flow_hash, "ed-flow-hash",
3315 clib_max (1, sm->num_workers) * 2 * sm->translation_buckets, 0);
3316 clib_bihash_set_kvp_format_fn_16_8 (&sm->flow_hash, format_ed_session_kvp);
3320 nat44_ed_db_init (u32 translations, u32 translation_buckets)
3322 snat_main_t *sm = &snat_main;
3323 snat_main_per_thread_data_t *tsm;
3325 reinit_ed_flow_hash ();
3327 vec_foreach (tsm, sm->per_thread_data)
3329 nat44_ed_worker_db_init (tsm, sm->max_translations_per_thread,
3330 sm->translation_buckets);
3335 nat44_ed_worker_db_free (snat_main_per_thread_data_t *tsm)
3337 pool_free (tsm->lru_pool);
3338 pool_free (tsm->sessions);
3339 pool_free (tsm->per_vrf_sessions_pool);
3343 nat44_ed_sessions_clear ()
3345 snat_main_t *sm = &snat_main;
3346 snat_main_per_thread_data_t *tsm;
3348 reinit_ed_flow_hash ();
3350 vec_foreach (tsm, sm->per_thread_data)
3352 nat44_ed_worker_db_free (tsm);
3353 nat44_ed_worker_db_init (tsm, sm->max_translations_per_thread,
3354 sm->translation_buckets);
3356 vlib_zero_simple_counter (&sm->total_sessions, 0);
3360 nat44_ed_add_del_static_mapping_cb (ip4_main_t *im, uword opaque,
3361 u32 sw_if_index, ip4_address_t *address,
3362 u32 address_length, u32 if_address_index,
3365 snat_static_mapping_resolve_t *rp;
3366 snat_main_t *sm = &snat_main;
3374 vec_foreach (rp, sm->sm_to_resolve)
3376 if (sw_if_index == rp->sw_if_index)
3380 if (rp->is_resolved)
3382 rv = nat44_ed_del_static_mapping_internal (
3383 rp->l_addr, address[0], rp->l_port, rp->e_port, rp->proto,
3384 rp->vrf_id, rp->flags);
3387 nat_log_err ("ed del static mapping failed");
3391 rp->is_resolved = 0;
3397 if (!rp->is_resolved)
3399 rv = nat44_ed_add_static_mapping_internal (
3400 rp->l_addr, address[0], rp->l_port, rp->e_port, rp->proto,
3401 rp->vrf_id, ~0, rp->flags, rp->pool_addr, rp->tag);
3404 nat_log_err ("ed add static mapping failed");
3408 rp->is_resolved = 1;
3417 nat44_ed_get_addr_resolve_record (u32 sw_if_index, u8 twice_nat, int *out)
3419 snat_main_t *sm = &snat_main;
3420 snat_address_resolve_t *rp;
3423 for (i = 0; i < vec_len (sm->addr_to_resolve); i++)
3425 rp = sm->addr_to_resolve + i;
3427 if ((rp->sw_if_index == sw_if_index) && (rp->is_twice_nat == twice_nat))
3439 nat44_ed_del_addr_resolve_record (u32 sw_if_index, u8 twice_nat)
3441 snat_main_t *sm = &snat_main;
3443 if (!nat44_ed_get_addr_resolve_record (sw_if_index, twice_nat, &i))
3445 vec_del1 (sm->addr_to_resolve, i);
3452 nat44_ed_add_del_interface_address_cb (ip4_main_t *im, uword opaque,
3453 u32 sw_if_index, ip4_address_t *address,
3455 u32 if_address_index, u32 is_delete)
3457 snat_main_t *sm = &snat_main;
3458 snat_address_resolve_t *arp;
3468 if (nat44_ed_get_addr_resolve_record (sw_if_index, twice_nat, &i))
3471 if (nat44_ed_get_addr_resolve_record (sw_if_index, twice_nat, &i))
3474 ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
3475 vec_foreach (ap, sm->addresses)
3477 if ((fib_index == ap->fib_index) &&
3478 (address->as_u32 == ap->addr.as_u32))
3482 ap->addr_len = address_length;
3483 ap->sw_if_index = sw_if_index;
3485 ap->addr.as_u32 & ip4_main.fib_masks[ap->addr_len];
3488 "pool addr %U binds to -> sw_if_idx: %u net: %U/%u",
3489 format_ip4_address, &ap->addr, ap->sw_if_index,
3490 format_ip4_address, &ap->net, ap->addr_len);
3503 arp = sm->addr_to_resolve + i;
3507 if (arp->is_resolved)
3512 rv = nat44_ed_add_address (address, ~0, arp->is_twice_nat);
3515 arp->is_resolved = 1;
3520 if (!arp->is_resolved)
3525 rv = nat44_ed_del_address (address[0], arp->is_twice_nat);
3528 arp->is_resolved = 0;
3534 nat44_ed_add_interface_address (u32 sw_if_index, u8 twice_nat)
3536 snat_main_t *sm = &snat_main;
3537 ip4_main_t *ip4_main = sm->ip4_main;
3538 ip4_address_t *first_int_addr;
3539 snat_address_resolve_t *ap;
3544 nat_log_err ("nat44 is disabled");
3545 return VNET_API_ERROR_UNSUPPORTED;
3548 if (!nat44_ed_get_addr_resolve_record (sw_if_index, twice_nat, 0))
3550 return VNET_API_ERROR_VALUE_EXIST;
3553 vec_add2 (sm->addr_to_resolve, ap, 1);
3554 ap->sw_if_index = sw_if_index;
3555 ap->is_twice_nat = twice_nat;
3556 ap->is_resolved = 0;
3558 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0);
3561 rv = nat44_ed_add_address (first_int_addr, ~0, twice_nat);
3564 nat44_ed_del_addr_resolve_record (sw_if_index, twice_nat);
3567 ap->is_resolved = 1;
3574 nat44_ed_del_interface_address (u32 sw_if_index, u8 twice_nat)
3576 snat_main_t *sm = &snat_main;
3577 ip4_main_t *ip4_main = sm->ip4_main;
3578 ip4_address_t *first_int_addr;
3582 nat_log_err ("nat44 is disabled");
3583 return VNET_API_ERROR_UNSUPPORTED;
3586 if (nat44_ed_del_addr_resolve_record (sw_if_index, twice_nat))
3588 return VNET_API_ERROR_NO_SUCH_ENTRY;
3591 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0);
3594 return nat44_ed_del_address (first_int_addr[0], twice_nat);
3601 nat44_ed_del_session (snat_main_t *sm, ip4_address_t *addr, u16 port,
3602 ip4_address_t *eh_addr, u16 eh_port, u8 proto,
3603 u32 vrf_id, int is_in)
3606 clib_bihash_kv_16_8_t kv, value;
3609 snat_main_per_thread_data_t *tsm;
3613 return VNET_API_ERROR_UNSUPPORTED;
3616 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3617 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
3618 if (sm->num_workers > 1)
3619 tsm = vec_elt_at_index (
3620 sm->per_thread_data,
3621 nat44_ed_get_in2out_worker_index (0, &ip, fib_index, 0));
3623 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
3625 init_ed_k (&kv, addr->as_u32, port, eh_addr->as_u32, eh_port, fib_index,
3627 if (clib_bihash_search_16_8 (&sm->flow_hash, &kv, &value))
3629 return VNET_API_ERROR_NO_SUCH_ENTRY;
3632 if (pool_is_free_index (tsm->sessions, ed_value_get_session_index (&value)))
3633 return VNET_API_ERROR_UNSPECIFIED;
3634 s = pool_elt_at_index (tsm->sessions, ed_value_get_session_index (&value));
3635 nat44_ed_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
3636 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
3640 VLIB_NODE_FN (nat_default_node) (vlib_main_t * vm,
3641 vlib_node_runtime_t * node,
3642 vlib_frame_t * frame)
3647 VLIB_REGISTER_NODE (nat_default_node) = {
3648 .name = "nat-default",
3649 .vector_size = sizeof (u32),
3651 .type = VLIB_NODE_TYPE_INTERNAL,
3653 .n_next_nodes = NAT_N_NEXT,
3655 [NAT_NEXT_DROP] = "error-drop",
3656 [NAT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
3657 [NAT_NEXT_IN2OUT_ED_FAST_PATH] = "nat44-ed-in2out",
3658 [NAT_NEXT_IN2OUT_ED_SLOW_PATH] = "nat44-ed-in2out-slowpath",
3659 [NAT_NEXT_IN2OUT_ED_OUTPUT_FAST_PATH] = "nat44-ed-in2out-output",
3660 [NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH] = "nat44-ed-in2out-output-slowpath",
3661 [NAT_NEXT_OUT2IN_ED_FAST_PATH] = "nat44-ed-out2in",
3662 [NAT_NEXT_OUT2IN_ED_SLOW_PATH] = "nat44-ed-out2in-slowpath",
3663 [NAT_NEXT_IN2OUT_CLASSIFY] = "nat44-in2out-worker-handoff",
3664 [NAT_NEXT_OUT2IN_CLASSIFY] = "nat44-out2in-worker-handoff",
3669 nat_6t_l3_l4_csum_calc (nat_6t_flow_t *f)
3671 f->l3_csum_delta = 0;
3672 f->l4_csum_delta = 0;
3673 if (f->ops & NAT_FLOW_OP_SADDR_REWRITE &&
3674 f->rewrite.saddr.as_u32 != f->match.saddr.as_u32)
3677 ip_csum_add_even (f->l3_csum_delta, f->rewrite.saddr.as_u32);
3679 ip_csum_sub_even (f->l3_csum_delta, f->match.saddr.as_u32);
3683 f->rewrite.saddr.as_u32 = f->match.saddr.as_u32;
3685 if (f->ops & NAT_FLOW_OP_DADDR_REWRITE &&
3686 f->rewrite.daddr.as_u32 != f->match.daddr.as_u32)
3689 ip_csum_add_even (f->l3_csum_delta, f->rewrite.daddr.as_u32);
3691 ip_csum_sub_even (f->l3_csum_delta, f->match.daddr.as_u32);
3695 f->rewrite.daddr.as_u32 = f->match.daddr.as_u32;
3697 if (f->ops & NAT_FLOW_OP_SPORT_REWRITE && f->rewrite.sport != f->match.sport)
3699 f->l4_csum_delta = ip_csum_add_even (f->l4_csum_delta, f->rewrite.sport);
3700 f->l4_csum_delta = ip_csum_sub_even (f->l4_csum_delta, f->match.sport);
3704 f->rewrite.sport = f->match.sport;
3706 if (f->ops & NAT_FLOW_OP_DPORT_REWRITE && f->rewrite.dport != f->match.dport)
3708 f->l4_csum_delta = ip_csum_add_even (f->l4_csum_delta, f->rewrite.dport);
3709 f->l4_csum_delta = ip_csum_sub_even (f->l4_csum_delta, f->match.dport);
3713 f->rewrite.dport = f->match.dport;
3715 if (f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE &&
3716 f->rewrite.icmp_id != f->match.sport)
3719 ip_csum_add_even (f->l4_csum_delta, f->rewrite.icmp_id);
3720 f->l4_csum_delta = ip_csum_sub_even (f->l4_csum_delta, f->match.sport);
3724 f->rewrite.icmp_id = f->match.sport;
3726 if (f->ops & NAT_FLOW_OP_TXFIB_REWRITE)
3731 f->rewrite.fib_index = f->match.fib_index;
3735 static_always_inline int
3736 nat_6t_flow_icmp_translate (vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b,
3737 ip4_header_t *ip, nat_6t_flow_t *f);
3739 static_always_inline void
3740 nat_6t_flow_ip4_translate (snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip,
3741 nat_6t_flow_t *f, ip_protocol_t proto,
3742 int is_icmp_inner_ip4, int skip_saddr_rewrite)
3744 udp_header_t *udp = ip4_next_header (ip);
3745 tcp_header_t *tcp = (tcp_header_t *) udp;
3747 if ((IP_PROTOCOL_TCP == proto || IP_PROTOCOL_UDP == proto) &&
3748 !vnet_buffer (b)->ip.reass.is_non_first_fragment)
3750 if (!is_icmp_inner_ip4)
3752 ip->src_address = f->rewrite.saddr;
3753 ip->dst_address = f->rewrite.daddr;
3754 udp->src_port = f->rewrite.sport;
3755 udp->dst_port = f->rewrite.dport;
3758 { // icmp inner ip4 - reversed saddr/daddr
3759 ip->src_address = f->rewrite.daddr;
3760 ip->dst_address = f->rewrite.saddr;
3761 udp->src_port = f->rewrite.dport;
3762 udp->dst_port = f->rewrite.sport;
3765 if (IP_PROTOCOL_TCP == proto)
3767 ip_csum_t tcp_sum = tcp->checksum;
3768 tcp_sum = ip_csum_sub_even (tcp_sum, f->l3_csum_delta);
3769 tcp_sum = ip_csum_sub_even (tcp_sum, f->l4_csum_delta);
3770 mss_clamping (sm->mss_clamping, tcp, &tcp_sum);
3771 tcp->checksum = ip_csum_fold (tcp_sum);
3773 else if (IP_PROTOCOL_UDP == proto && udp->checksum)
3775 ip_csum_t udp_sum = udp->checksum;
3776 udp_sum = ip_csum_sub_even (udp_sum, f->l3_csum_delta);
3777 udp_sum = ip_csum_sub_even (udp_sum, f->l4_csum_delta);
3778 udp->checksum = ip_csum_fold (udp_sum);
3783 if (!is_icmp_inner_ip4)
3785 if (!skip_saddr_rewrite)
3787 ip->src_address = f->rewrite.saddr;
3789 ip->dst_address = f->rewrite.daddr;
3792 { // icmp inner ip4 - reversed saddr/daddr
3793 ip->src_address = f->rewrite.daddr;
3794 ip->dst_address = f->rewrite.saddr;
3798 if (skip_saddr_rewrite)
3800 ip->checksum = ip4_header_checksum (ip);
3804 ip_csum_t ip_sum = ip->checksum;
3805 ip_sum = ip_csum_sub_even (ip_sum, f->l3_csum_delta);
3806 ip->checksum = ip_csum_fold (ip_sum);
3808 if (0xffff == ip->checksum)
3810 ASSERT (ip4_header_checksum_is_valid (ip));
3813 static_always_inline int
3814 it_fits (vlib_main_t *vm, vlib_buffer_t *b, void *object, size_t size)
3816 int result = ((u8 *) object + size <=
3817 (u8 *) vlib_buffer_get_current (b) + b->current_length) &&
3818 vlib_object_within_buffer_data (vm, b, object, size);
3822 static_always_inline int
3823 nat_6t_flow_icmp_translate (vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b,
3824 ip4_header_t *ip, nat_6t_flow_t *f)
3826 if (IP_PROTOCOL_ICMP != ip->protocol)
3827 return NAT_ED_TRNSL_ERR_TRANSLATION_FAILED;
3829 icmp46_header_t *icmp = ip4_next_header (ip);
3830 nat_icmp_echo_header_t *echo = (nat_icmp_echo_header_t *) (icmp + 1);
3832 if ((!vnet_buffer (b)->ip.reass.is_non_first_fragment))
3834 if (!it_fits (vm, b, icmp, sizeof (*icmp)))
3836 return NAT_ED_TRNSL_ERR_PACKET_TRUNCATED;
3839 if (!icmp_type_is_error_message (icmp->type))
3841 if ((f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE) &&
3842 (f->rewrite.icmp_id != echo->identifier))
3844 ip_csum_t sum = icmp->checksum;
3845 sum = ip_csum_update (sum, echo->identifier, f->rewrite.icmp_id,
3846 nat_icmp_echo_header_t,
3847 identifier /* changed member */);
3848 echo->identifier = f->rewrite.icmp_id;
3849 icmp->checksum = ip_csum_fold (sum);
3854 ip_csum_t sum = ip_incremental_checksum (
3856 clib_net_to_host_u16 (ip->length) - ip4_header_bytes (ip));
3857 sum = (u16) ~ip_csum_fold (sum);
3860 return NAT_ED_TRNSL_ERR_INVALID_CSUM;
3863 // errors are not fragmented
3864 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3866 if (!ip4_header_checksum_is_valid (inner_ip))
3868 return NAT_ED_TRNSL_ERR_INNER_IP_CORRUPT;
3871 ip_protocol_t inner_proto = inner_ip->protocol;
3873 ip_csum_t old_icmp_sum = icmp->checksum;
3874 ip_csum_t old_inner_ip_sum = inner_ip->checksum;
3875 ip_csum_t old_udp_sum;
3876 ip_csum_t old_tcp_sum;
3877 ip_csum_t new_icmp_sum;
3881 switch (inner_proto)
3883 case IP_PROTOCOL_UDP:
3884 udp = (udp_header_t *) (inner_ip + 1);
3885 if (!it_fits (vm, b, udp, sizeof (*udp)))
3887 return NAT_ED_TRNSL_ERR_PACKET_TRUNCATED;
3889 old_udp_sum = udp->checksum;
3890 nat_6t_flow_ip4_translate (sm, b, inner_ip, f, inner_proto,
3891 1 /* is_icmp_inner_ip4 */,
3892 0 /* skip_saddr_rewrite */);
3893 new_icmp_sum = ip_csum_sub_even (old_icmp_sum, f->l3_csum_delta);
3894 new_icmp_sum = ip_csum_sub_even (new_icmp_sum, f->l4_csum_delta);
3896 ip_csum_update (new_icmp_sum, old_inner_ip_sum,
3897 inner_ip->checksum, ip4_header_t, checksum);
3899 ip_csum_update (new_icmp_sum, old_udp_sum, udp->checksum,
3900 udp_header_t, checksum);
3901 new_icmp_sum = ip_csum_fold (new_icmp_sum);
3902 icmp->checksum = new_icmp_sum;
3904 case IP_PROTOCOL_TCP:
3905 tcp = (tcp_header_t *) (inner_ip + 1);
3906 if (!it_fits (vm, b, tcp, sizeof (*tcp)))
3908 return NAT_ED_TRNSL_ERR_PACKET_TRUNCATED;
3910 old_tcp_sum = tcp->checksum;
3911 nat_6t_flow_ip4_translate (sm, b, inner_ip, f, inner_proto,
3912 1 /* is_icmp_inner_ip4 */,
3913 0 /* skip_saddr_rewrite */);
3914 new_icmp_sum = ip_csum_sub_even (old_icmp_sum, f->l3_csum_delta);
3915 new_icmp_sum = ip_csum_sub_even (new_icmp_sum, f->l4_csum_delta);
3917 ip_csum_update (new_icmp_sum, old_inner_ip_sum,
3918 inner_ip->checksum, ip4_header_t, checksum);
3920 ip_csum_update (new_icmp_sum, old_tcp_sum, tcp->checksum,
3921 tcp_header_t, checksum);
3922 new_icmp_sum = ip_csum_fold (new_icmp_sum);
3923 icmp->checksum = new_icmp_sum;
3925 case IP_PROTOCOL_ICMP:
3926 nat_6t_flow_ip4_translate (sm, b, inner_ip, f, inner_proto,
3927 1 /* is_icmp_inner_ip4 */,
3928 0 /* skip_saddr_rewrite */);
3929 if (f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE)
3931 icmp46_header_t *inner_icmp = ip4_next_header (inner_ip);
3932 if (!it_fits (vm, b, inner_icmp, sizeof (*inner_icmp)))
3934 return NAT_ED_TRNSL_ERR_PACKET_TRUNCATED;
3936 nat_icmp_echo_header_t *inner_echo =
3937 (nat_icmp_echo_header_t *) (inner_icmp + 1);
3938 if (f->rewrite.icmp_id != inner_echo->identifier)
3940 ip_csum_t sum = icmp->checksum;
3941 sum = ip_csum_update (sum, inner_echo->identifier,
3943 nat_icmp_echo_header_t,
3944 identifier /* changed member */);
3945 icmp->checksum = ip_csum_fold (sum);
3946 ip_csum_t inner_sum = inner_icmp->checksum;
3947 inner_sum = ip_csum_update (
3948 sum, inner_echo->identifier, f->rewrite.icmp_id,
3949 nat_icmp_echo_header_t,
3950 identifier /* changed member */);
3951 inner_icmp->checksum = ip_csum_fold (inner_sum);
3952 inner_echo->identifier = f->rewrite.icmp_id;
3957 clib_warning ("unexpected NAT protocol value `%d'", inner_proto);
3958 return NAT_ED_TRNSL_ERR_TRANSLATION_FAILED;
3963 return NAT_ED_TRNSL_ERR_SUCCESS;
3966 static_always_inline nat_translation_error_e
3967 nat_6t_flow_buf_translate (vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b,
3968 ip4_header_t *ip, nat_6t_flow_t *f,
3969 ip_protocol_t proto, int is_output_feature,
3972 if (!is_output_feature && f->ops & NAT_FLOW_OP_TXFIB_REWRITE)
3974 vnet_buffer (b)->sw_if_index[VLIB_TX] = f->rewrite.fib_index;
3977 if (IP_PROTOCOL_ICMP == proto)
3979 if (ip->src_address.as_u32 != f->rewrite.saddr.as_u32)
3981 // packet is returned from a router, not from destination
3982 // skip source address rewrite if in o2i path
3983 nat_6t_flow_ip4_translate (sm, b, ip, f, proto,
3984 0 /* is_icmp_inner_ip4 */,
3985 !is_i2o /* skip_saddr_rewrite */);
3989 nat_6t_flow_ip4_translate (sm, b, ip, f, proto,
3990 0 /* is_icmp_inner_ip4 */,
3991 0 /* skip_saddr_rewrite */);
3993 return nat_6t_flow_icmp_translate (vm, sm, b, ip, f);
3996 nat_6t_flow_ip4_translate (sm, b, ip, f, proto, 0 /* is_icmp_inner_ip4 */,
3997 0 /* skip_saddr_rewrite */);
3999 return NAT_ED_TRNSL_ERR_SUCCESS;
4002 nat_translation_error_e
4003 nat_6t_flow_buf_translate_i2o (vlib_main_t *vm, snat_main_t *sm,
4004 vlib_buffer_t *b, ip4_header_t *ip,
4005 nat_6t_flow_t *f, ip_protocol_t proto,
4006 int is_output_feature)
4008 return nat_6t_flow_buf_translate (vm, sm, b, ip, f, proto, is_output_feature,
4012 nat_translation_error_e
4013 nat_6t_flow_buf_translate_o2i (vlib_main_t *vm, snat_main_t *sm,
4014 vlib_buffer_t *b, ip4_header_t *ip,
4015 nat_6t_flow_t *f, ip_protocol_t proto,
4016 int is_output_feature)
4018 return nat_6t_flow_buf_translate (vm, sm, b, ip, f, proto, is_output_feature,
4022 static_always_inline void
4023 nat_syslog_nat44_sess (u32 ssubix, u32 sfibix, ip4_address_t *isaddr,
4024 u16 isport, ip4_address_t *xsaddr, u16 xsport,
4025 ip4_address_t *idaddr, u16 idport,
4026 ip4_address_t *xdaddr, u16 xdport, u8 proto, u8 is_add,
4029 syslog_msg_t syslog_msg;
4032 if (!syslog_is_enabled ())
4035 if (syslog_severity_filter_block (SADD_SDEL_SEVERITY))
4038 fib = fib_table_get (sfibix, FIB_PROTOCOL_IP4);
4040 syslog_msg_init (&syslog_msg, NAT_FACILITY, SADD_SDEL_SEVERITY, NAT_APPNAME,
4041 is_add ? SADD_MSGID : SDEL_MSGID);
4043 syslog_msg_sd_init (&syslog_msg, NSESS_SDID);
4044 syslog_msg_add_sd_param (&syslog_msg, SSUBIX_SDPARAM_NAME, "%d", ssubix);
4045 syslog_msg_add_sd_param (&syslog_msg, SVLAN_SDPARAM_NAME, "%d",
4047 syslog_msg_add_sd_param (&syslog_msg, IATYP_SDPARAM_NAME, IATYP_IPV4);
4048 syslog_msg_add_sd_param (&syslog_msg, ISADDR_SDPARAM_NAME, "%U",
4049 format_ip4_address, isaddr);
4050 syslog_msg_add_sd_param (&syslog_msg, ISPORT_SDPARAM_NAME, "%d",
4051 clib_net_to_host_u16 (isport));
4052 syslog_msg_add_sd_param (&syslog_msg, XATYP_SDPARAM_NAME, IATYP_IPV4);
4053 syslog_msg_add_sd_param (&syslog_msg, XSADDR_SDPARAM_NAME, "%U",
4054 format_ip4_address, xsaddr);
4055 syslog_msg_add_sd_param (&syslog_msg, XSPORT_SDPARAM_NAME, "%d",
4056 clib_net_to_host_u16 (xsport));
4057 syslog_msg_add_sd_param (&syslog_msg, PROTO_SDPARAM_NAME, "%d", proto);
4058 syslog_msg_add_sd_param (&syslog_msg, XDADDR_SDPARAM_NAME, "%U",
4059 format_ip4_address, xdaddr);
4060 syslog_msg_add_sd_param (&syslog_msg, XDPORT_SDPARAM_NAME, "%d",
4061 clib_net_to_host_u16 (xdport));
4064 syslog_msg_add_sd_param (&syslog_msg, IDADDR_SDPARAM_NAME, "%U",
4065 format_ip4_address, idaddr);
4066 syslog_msg_add_sd_param (&syslog_msg, IDPORT_SDPARAM_NAME, "%d",
4067 clib_net_to_host_u16 (idport));
4070 syslog_msg_send (&syslog_msg);
4074 nat_syslog_nat44_sadd (u32 ssubix, u32 sfibix, ip4_address_t *isaddr,
4075 u16 isport, ip4_address_t *idaddr, u16 idport,
4076 ip4_address_t *xsaddr, u16 xsport,
4077 ip4_address_t *xdaddr, u16 xdport, u8 proto,
4080 nat_syslog_nat44_sess (ssubix, sfibix, isaddr, isport, xsaddr, xsport,
4081 idaddr, idport, xdaddr, xdport, proto, 1,
4086 nat_syslog_nat44_sdel (u32 ssubix, u32 sfibix, ip4_address_t *isaddr,
4087 u16 isport, ip4_address_t *idaddr, u16 idport,
4088 ip4_address_t *xsaddr, u16 xsport,
4089 ip4_address_t *xdaddr, u16 xdport, u8 proto,
4092 nat_syslog_nat44_sess (ssubix, sfibix, isaddr, isport, xsaddr, xsport,
4093 idaddr, idport, xdaddr, xdport, proto, 0,
4098 * fd.io coding-style-patch-verification: ON
4101 * eval: (c-set-style "gnu")