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 ();
151 static void nat44_ed_db_free ();
152 static void nat44_ed_worker_db_free (snat_main_per_thread_data_t *tsm);
154 static int nat44_ed_add_static_mapping_internal (
155 ip4_address_t l_addr, ip4_address_t e_addr, u16 l_port, u16 e_port,
156 ip_protocol_t proto, u32 vrf_id, u32 sw_if_index, u32 flags,
157 ip4_address_t pool_addr, u8 *tag);
158 static int nat44_ed_del_static_mapping_internal (ip4_address_t l_addr,
159 ip4_address_t e_addr,
160 u16 l_port, u16 e_port,
162 u32 vrf_id, u32 flags);
164 u32 nat_calc_bihash_buckets (u32 n_elts);
166 static_always_inline int
167 nat44_ed_sm_i2o_add (snat_main_t *sm, snat_static_mapping_t *m,
168 ip4_address_t addr, u16 port, u32 fib_index, u8 proto)
170 ASSERT (!pool_is_free (sm->static_mappings, m));
171 clib_bihash_kv_16_8_t kv;
172 nat44_ed_sm_init_i2o_kv (&kv, addr.as_u32, port, fib_index, proto,
173 m - sm->static_mappings);
174 return clib_bihash_add_del_16_8 (&sm->flow_hash, &kv, 1 /*is_add*/);
177 static_always_inline int
178 nat44_ed_sm_i2o_del (snat_main_t *sm, ip4_address_t addr, u16 port,
179 u32 fib_index, u8 proto)
181 clib_bihash_kv_16_8_t kv;
182 nat44_ed_sm_init_i2o_k (&kv, addr.as_u32, port, fib_index, proto);
183 return clib_bihash_add_del_16_8 (&sm->flow_hash, &kv, 0 /*is_add*/);
186 static_always_inline int
187 nat44_ed_sm_o2i_add (snat_main_t *sm, snat_static_mapping_t *m,
188 ip4_address_t addr, u16 port, u32 fib_index, u8 proto)
190 ASSERT (!pool_is_free (sm->static_mappings, m));
191 clib_bihash_kv_16_8_t kv;
192 nat44_ed_sm_init_o2i_kv (&kv, addr.as_u32, port, fib_index, proto,
193 m - sm->static_mappings);
194 return clib_bihash_add_del_16_8 (&sm->flow_hash, &kv, 1 /*is_add*/);
197 static_always_inline int
198 nat44_ed_sm_o2i_del (snat_main_t *sm, ip4_address_t addr, u16 port,
199 u32 fib_index, u8 proto)
201 clib_bihash_kv_16_8_t kv;
202 nat44_ed_sm_init_o2i_k (&kv, addr.as_u32, port, fib_index, proto);
203 return clib_bihash_add_del_16_8 (&sm->flow_hash, &kv, 0 /*is_add*/);
207 nat44_ed_free_session_data (snat_main_t *sm, snat_session_t *s,
208 u32 thread_index, u8 is_ha)
210 per_vrf_sessions_unregister_session (s, thread_index);
212 if (nat_ed_ses_i2o_flow_hash_add_del (sm, thread_index, s, 0))
213 nat_elog_warn (sm, "flow hash del failed");
215 if (nat_ed_ses_o2i_flow_hash_add_del (sm, thread_index, s, 0))
216 nat_elog_warn (sm, "flow hash del failed");
218 if (na44_ed_is_fwd_bypass_session (s))
223 if (nat44_ed_is_affinity_session (s))
224 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr, s->proto,
228 nat_syslog_nat44_sdel (0, s->in2out.fib_index, &s->in2out.addr,
229 s->in2out.port, &s->ext_host_nat_addr,
230 s->ext_host_nat_port, &s->out2in.addr,
231 s->out2in.port, &s->ext_host_addr, s->ext_host_port,
232 s->proto, nat44_ed_is_twice_nat_session (s));
237 nat_ipfix_logging_nat44_ses_delete (
238 thread_index, s->in2out.addr.as_u32, s->out2in.addr.as_u32, s->proto,
239 s->in2out.port, s->out2in.port, s->in2out.fib_index);
243 static ip_interface_address_t *
244 nat44_ed_get_ip_interface_address (u32 sw_if_index, ip4_address_t addr)
246 snat_main_t *sm = &snat_main;
248 ip_lookup_main_t *lm = &sm->ip4_main->lookup_main;
249 ip_interface_address_t *ia;
252 foreach_ip_interface_address (
253 lm, ia, sw_if_index, 1, ({
254 ip4a = ip_interface_address_get_address (lm, ia);
255 nat_log_debug ("sw_if_idx: %u addr: %U ? %U", sw_if_index,
256 format_ip4_address, ip4a, format_ip4_address, &addr);
257 if (ip4a->as_u32 == addr.as_u32)
266 nat44_ed_resolve_nat_addr_len (snat_address_t *ap,
267 snat_interface_t *interfaces)
269 ip_interface_address_t *ia;
273 pool_foreach (i, interfaces)
275 if (!nat44_ed_is_interface_outside (i))
280 fib_index = ip4_fib_table_get_index_for_sw_if_index (i->sw_if_index);
281 if (fib_index != ap->fib_index)
286 if ((ia = nat44_ed_get_ip_interface_address (i->sw_if_index, ap->addr)))
288 ap->addr_len = ia->address_length;
289 ap->sw_if_index = i->sw_if_index;
290 ap->net.as_u32 = ap->addr.as_u32 & ip4_main.fib_masks[ap->addr_len];
292 nat_log_debug ("pool addr %U binds to -> sw_if_idx: %u net: %U/%u",
293 format_ip4_address, &ap->addr, ap->sw_if_index,
294 format_ip4_address, &ap->net, ap->addr_len);
302 nat44_ed_update_outside_if_addresses (snat_address_t *ap)
304 snat_main_t *sm = &snat_main;
306 if (!nat44_ed_resolve_nat_addr_len (ap, sm->interfaces))
311 if (!nat44_ed_resolve_nat_addr_len (ap, sm->output_feature_interfaces))
318 nat44_ed_bind_if_addr_to_nat_addr (u32 sw_if_index)
320 snat_main_t *sm = &snat_main;
321 ip_interface_address_t *ia;
324 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
326 vec_foreach (ap, sm->addresses)
328 if (fib_index != ap->fib_index)
333 if ((ia = nat44_ed_get_ip_interface_address (sw_if_index, ap->addr)))
335 ap->addr_len = ia->address_length;
336 ap->sw_if_index = sw_if_index;
337 ap->net.as_u32 = ap->addr.as_u32 & ip4_main.fib_masks[ap->addr_len];
339 nat_log_debug ("pool addr %U binds to -> sw_if_idx: %u net: %U/%u",
340 format_ip4_address, &ap->addr, ap->sw_if_index,
341 format_ip4_address, &ap->net, ap->addr_len);
347 static_always_inline snat_fib_entry_reg_t *
348 nat44_ed_get_fib_entry_reg (ip4_address_t addr, u32 sw_if_index, int *out_idx)
350 snat_main_t *sm = &snat_main;
351 snat_fib_entry_reg_t *fe;
354 for (i = 0; i < vec_len (sm->fib_entry_reg); i++)
356 fe = sm->fib_entry_reg + i;
357 if ((addr.as_u32 == fe->addr.as_u32) && (sw_if_index == fe->sw_if_index))
370 nat44_ed_add_fib_entry_reg (ip4_address_t addr, u32 sw_if_index)
372 // Add the external NAT address to the FIB as receive entries. This ensures
373 // that VPP will reply to ARP for this address and we don't need to enable
374 // proxy ARP on the outside interface.
375 snat_main_t *sm = &snat_main;
376 snat_fib_entry_reg_t *fe;
378 if (!(fe = nat44_ed_get_fib_entry_reg (addr, sw_if_index, 0)))
380 fib_prefix_t prefix = {
382 .fp_proto = FIB_PROTOCOL_IP4,
384 .ip4.as_u32 = addr.as_u32,
387 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
388 fib_table_entry_update_one_path (fib_index, &prefix, sm->fib_src_low,
389 (FIB_ENTRY_FLAG_CONNECTED |
390 FIB_ENTRY_FLAG_LOCAL |
391 FIB_ENTRY_FLAG_EXCLUSIVE),
392 DPO_PROTO_IP4, NULL, sw_if_index, ~0, 1,
393 NULL, FIB_ROUTE_PATH_FLAG_NONE);
395 vec_add2 (sm->fib_entry_reg, fe, 1);
396 clib_memset (fe, 0, sizeof (*fe));
397 fe->addr.as_u32 = addr.as_u32;
398 fe->sw_if_index = sw_if_index;
404 nat44_ed_del_fib_entry_reg (ip4_address_t addr, u32 sw_if_index)
406 snat_main_t *sm = &snat_main;
407 snat_fib_entry_reg_t *fe;
410 if ((fe = nat44_ed_get_fib_entry_reg (addr, sw_if_index, &i)))
415 fib_prefix_t prefix = {
417 .fp_proto = FIB_PROTOCOL_IP4,
419 .ip4.as_u32 = addr.as_u32,
423 ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
424 fib_table_entry_delete (fib_index, &prefix, sm->fib_src_low);
425 vec_del1 (sm->fib_entry_reg, i);
431 nat44_ed_add_del_interface_fib_reg_entries (ip4_address_t addr, u8 is_add)
433 snat_main_t *sm = &snat_main;
436 pool_foreach (i, sm->interfaces)
438 if (nat44_ed_is_interface_outside (i))
442 nat44_ed_add_fib_entry_reg (addr, i->sw_if_index);
446 nat44_ed_del_fib_entry_reg (addr, i->sw_if_index);
450 pool_foreach (i, sm->output_feature_interfaces)
452 if (nat44_ed_is_interface_outside (i))
456 nat44_ed_add_fib_entry_reg (addr, i->sw_if_index);
460 nat44_ed_del_fib_entry_reg (addr, i->sw_if_index);
466 static_always_inline void
467 nat44_ed_add_del_nat_addr_fib_reg_entries (u32 sw_if_index, u8 is_add)
469 snat_main_t *sm = &snat_main;
472 vec_foreach (ap, sm->addresses)
476 nat44_ed_add_fib_entry_reg (ap->addr, sw_if_index);
480 nat44_ed_del_fib_entry_reg (ap->addr, sw_if_index);
485 static_always_inline void
486 nat44_ed_add_del_sm_fib_reg_entries (u32 sw_if_index, u8 is_add)
488 snat_main_t *sm = &snat_main;
489 snat_static_mapping_t *m;
491 pool_foreach (m, sm->static_mappings)
495 nat44_ed_add_fib_entry_reg (m->external_addr, sw_if_index);
499 nat44_ed_del_fib_entry_reg (m->external_addr, sw_if_index);
505 nat44_ed_add_address (ip4_address_t *addr, u32 vrf_id, u8 twice_nat)
507 snat_main_t *sm = &snat_main;
508 snat_address_t *ap, *addresses;
510 addresses = twice_nat ? sm->twice_nat_addresses : sm->addresses;
514 return VNET_API_ERROR_UNSUPPORTED;
517 // check if address already exists
518 vec_foreach (ap, addresses)
520 if (ap->addr.as_u32 == addr->as_u32)
522 nat_log_err ("address exist");
523 return VNET_API_ERROR_VALUE_EXIST;
529 vec_add2 (sm->twice_nat_addresses, ap, 1);
533 vec_add2 (sm->addresses, ap, 1);
542 ap->fib_index = fib_table_find_or_create_and_lock (
543 FIB_PROTOCOL_IP4, vrf_id, sm->fib_src_low);
548 // if we don't have enabled interface we don't add address
550 nat44_ed_add_del_interface_fib_reg_entries (*addr, 1);
551 nat44_ed_update_outside_if_addresses (ap);
557 nat44_ed_del_address (ip4_address_t addr, u8 twice_nat)
559 snat_main_t *sm = &snat_main;
560 snat_address_t *a = 0, *addresses;
562 u32 *ses_to_be_removed = 0, *ses_index;
563 snat_main_per_thread_data_t *tsm;
566 addresses = twice_nat ? sm->twice_nat_addresses : sm->addresses;
568 for (j = 0; j < vec_len (addresses); j++)
570 if (addresses[j].addr.as_u32 == addr.as_u32)
578 nat_log_err ("no such address");
579 return VNET_API_ERROR_NO_SUCH_ENTRY;
582 // delete dynamic sessions only
583 vec_foreach (tsm, sm->per_thread_data)
585 pool_foreach (ses, tsm->sessions)
587 if (ses->flags & SNAT_SESSION_FLAG_STATIC_MAPPING)
591 if (ses->out2in.addr.as_u32 == addr.as_u32)
593 nat44_ed_free_session_data (sm, ses, tsm - sm->per_thread_data,
595 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
598 vec_foreach (ses_index, ses_to_be_removed)
600 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
601 nat_ed_session_delete (sm, ses, tsm - sm->per_thread_data, 1);
603 vec_free (ses_to_be_removed);
608 nat44_ed_add_del_interface_fib_reg_entries (addr, 0);
611 if (a->fib_index != ~0)
613 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
618 vec_del1 (sm->addresses, j);
622 vec_del1 (sm->twice_nat_addresses, j);
629 nat44_ed_get_vrf_table (u32 table_vrf_id)
631 snat_main_t *sm = &snat_main;
634 pool_foreach (t, sm->vrf_tables)
636 if (table_vrf_id == t->table_vrf_id)
645 nat44_ed_get_vrf_route (vrf_table_t *t, u32 vrf_id)
649 pool_foreach (r, t->routes)
651 if (vrf_id == r->vrf_id)
660 nat44_ed_add_del_vrf_table (u32 table_vrf_id, bool is_add)
662 snat_main_t *sm = &snat_main;
666 t = nat44_ed_get_vrf_table (table_vrf_id);
671 return VNET_API_ERROR_VALUE_EXIST;
673 pool_foreach (r, t->routes)
675 fib_table_unlock (r->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
677 fib_table_unlock (t->table_fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
679 pool_free (t->routes);
680 pool_put (sm->vrf_tables, t);
686 return VNET_API_ERROR_NO_SUCH_ENTRY;
688 pool_get (sm->vrf_tables, t);
689 clib_memset (t, 0, sizeof (*t));
690 t->table_vrf_id = table_vrf_id;
691 t->table_fib_index = fib_table_find_or_create_and_lock (
692 FIB_PROTOCOL_IP4, table_vrf_id, sm->fib_src_low);
699 nat44_ed_del_vrf_tables ()
701 snat_main_t *sm = &snat_main;
705 pool_foreach (t, sm->vrf_tables)
707 pool_foreach (r, t->routes)
709 fib_table_unlock (r->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
711 fib_table_unlock (t->table_fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
712 pool_free (t->routes);
714 pool_free (sm->vrf_tables);
718 nat44_ed_add_del_vrf_route (u32 table_vrf_id, u32 vrf_id, bool is_add)
720 snat_main_t *sm = &snat_main;
724 t = nat44_ed_get_vrf_table (table_vrf_id);
727 return VNET_API_ERROR_NO_SUCH_ENTRY;
730 r = nat44_ed_get_vrf_route (t, vrf_id);
735 return VNET_API_ERROR_VALUE_EXIST;
737 fib_table_unlock (r->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
738 pool_put (t->routes, r);
744 return VNET_API_ERROR_NO_SUCH_ENTRY;
746 pool_get (t->routes, r);
747 clib_memset (r, 0, sizeof (*r));
749 r->fib_index = fib_table_find_or_create_and_lock (
750 FIB_PROTOCOL_IP4, vrf_id, sm->fib_src_low);
757 get_thread_idx_by_port (u16 e_port)
759 snat_main_t *sm = &snat_main;
760 u32 thread_idx = sm->num_workers;
761 if (sm->num_workers > 1)
763 thread_idx = sm->first_worker_index +
764 sm->workers[(e_port - ED_USER_PORT_OFFSET) /
765 sm->port_per_thread % _vec_len (sm->workers)];
771 nat_ed_static_mapping_del_sessions (snat_main_t * sm,
772 snat_main_per_thread_data_t * tsm,
773 ip4_address_t l_addr,
776 u32 fib_index, int addr_only,
777 ip4_address_t e_addr, u16 e_port)
780 u32 *indexes_to_free = NULL;
781 pool_foreach (s, tsm->sessions) {
782 if (s->in2out.fib_index != fib_index ||
783 s->in2out.addr.as_u32 != l_addr.as_u32)
789 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
790 s->out2in.port != e_port || s->in2out.port != l_port ||
791 s->proto != protocol)
795 if (nat44_ed_is_lb_session (s))
797 if (!nat44_ed_is_session_static (s))
799 nat44_ed_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
800 vec_add1 (indexes_to_free, s - tsm->sessions);
805 vec_foreach (ses_index, indexes_to_free)
807 s = pool_elt_at_index (tsm->sessions, *ses_index);
808 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
810 vec_free (indexes_to_free);
813 static_always_inline snat_static_mapping_t *
814 nat44_ed_sm_lookup (snat_main_t *sm, clib_bihash_kv_16_8_t *kv)
816 clib_bihash_kv_16_8_t v;
817 int rc = clib_bihash_search_16_8 (&sm->flow_hash, kv, &v);
820 ASSERT (0 == ed_value_get_thread_index (&v));
821 return pool_elt_at_index (sm->static_mappings,
822 ed_value_get_session_index (&v));
827 snat_static_mapping_t *
828 nat44_ed_sm_o2i_lookup (snat_main_t *sm, ip4_address_t addr, u16 port,
829 u32 fib_index, u8 proto)
831 clib_bihash_kv_16_8_t kv;
832 nat44_ed_sm_init_o2i_k (&kv, addr.as_u32, port, fib_index, proto);
833 return nat44_ed_sm_lookup (sm, &kv);
836 snat_static_mapping_t *
837 nat44_ed_sm_i2o_lookup (snat_main_t *sm, ip4_address_t addr, u16 port,
838 u32 fib_index, u8 proto)
840 clib_bihash_kv_16_8_t kv;
841 nat44_ed_sm_init_i2o_k (&kv, addr.as_u32, port, fib_index, proto);
842 return nat44_ed_sm_lookup (sm, &kv);
845 static snat_static_mapping_resolve_t *
846 nat44_ed_get_resolve_record (ip4_address_t l_addr, u16 l_port, u16 e_port,
847 ip_protocol_t proto, u32 vrf_id, u32 sw_if_index,
848 u32 flags, int *out_idx)
850 snat_static_mapping_resolve_t *rp;
851 snat_main_t *sm = &snat_main;
854 for (i = 0; i < vec_len (sm->sm_to_resolve); i++)
856 rp = sm->sm_to_resolve + i;
858 if (rp->sw_if_index == sw_if_index && rp->vrf_id == vrf_id)
860 if (is_sm_identity_nat (rp->flags) && is_sm_identity_nat (flags))
862 if (!(is_sm_addr_only (rp->flags) && is_sm_addr_only (flags)))
864 if (rp->e_port != e_port || rp->proto != proto)
870 else if (rp->l_addr.as_u32 == l_addr.as_u32)
872 if (!(is_sm_addr_only (rp->flags) && is_sm_addr_only (flags)))
874 if (rp->l_port != l_port || rp->e_port != e_port ||
896 nat44_ed_del_resolve_record (ip4_address_t l_addr, u16 l_port, u16 e_port,
897 ip_protocol_t proto, u32 vrf_id, u32 sw_if_index,
900 snat_main_t *sm = &snat_main;
902 if (nat44_ed_get_resolve_record (l_addr, l_port, e_port, proto, vrf_id,
903 sw_if_index, flags, &i))
905 vec_del1 (sm->sm_to_resolve, i);
911 static_always_inline int
912 nat44_ed_validate_sm_input (u32 flags)
914 // identity nat can be initiated only from inside interface
915 if (is_sm_identity_nat (flags) && is_sm_out2in_only (flags))
917 return VNET_API_ERROR_UNSUPPORTED;
920 if (is_sm_twice_nat (flags) || is_sm_self_twice_nat (flags))
922 if (is_sm_addr_only (flags) || is_sm_identity_nat (flags))
924 return VNET_API_ERROR_UNSUPPORTED;
931 nat44_ed_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
932 u16 l_port, u16 e_port, ip_protocol_t proto,
933 u32 vrf_id, u32 sw_if_index, u32 flags,
934 ip4_address_t pool_addr, u8 *tag)
936 snat_static_mapping_resolve_t *rp;
937 snat_main_t *sm = &snat_main;
942 return VNET_API_ERROR_UNSUPPORTED;
945 rv = nat44_ed_validate_sm_input (flags);
951 // interface bound mapping
952 if (is_sm_switch_address (flags))
954 if (nat44_ed_get_resolve_record (l_addr, l_port, e_port, proto, vrf_id,
955 sw_if_index, flags, 0))
957 return VNET_API_ERROR_VALUE_EXIST;
960 vec_add2 (sm->sm_to_resolve, rp, 1);
961 rp->l_addr.as_u32 = l_addr.as_u32;
964 rp->sw_if_index = sw_if_index;
968 rp->pool_addr = pool_addr;
969 rp->tag = vec_dup (tag);
972 ip4_address_t *first_int_addr =
973 ip4_interface_first_address (sm->ip4_main, sw_if_index, 0);
979 e_addr.as_u32 = first_int_addr->as_u32;
983 rv = nat44_ed_add_static_mapping_internal (l_addr, e_addr, l_port, e_port,
984 proto, vrf_id, sw_if_index, flags,
986 if ((0 != rv) && is_sm_switch_address (flags))
988 nat44_ed_del_resolve_record (l_addr, l_port, e_port, proto, vrf_id,
996 nat44_ed_del_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
997 u16 l_port, u16 e_port, ip_protocol_t proto,
998 u32 vrf_id, u32 sw_if_index, u32 flags)
1000 snat_main_t *sm = &snat_main;
1005 return VNET_API_ERROR_UNSUPPORTED;
1008 rv = nat44_ed_validate_sm_input (flags);
1014 // interface bound mapping
1015 if (is_sm_switch_address (flags))
1017 if (nat44_ed_del_resolve_record (l_addr, l_port, e_port, proto, vrf_id,
1018 sw_if_index, flags))
1020 return VNET_API_ERROR_NO_SUCH_ENTRY;
1023 ip4_address_t *first_int_addr =
1024 ip4_interface_first_address (sm->ip4_main, sw_if_index, 0);
1025 if (!first_int_addr)
1027 // dhcp resolution required
1031 e_addr.as_u32 = first_int_addr->as_u32;
1034 return nat44_ed_del_static_mapping_internal (l_addr, e_addr, l_port, e_port,
1035 proto, vrf_id, flags);
1039 nat44_ed_add_static_mapping_internal (ip4_address_t l_addr,
1040 ip4_address_t e_addr, u16 l_port,
1041 u16 e_port, ip_protocol_t proto,
1042 u32 vrf_id, u32 sw_if_index, u32 flags,
1043 ip4_address_t pool_addr, u8 *tag)
1045 snat_main_t *sm = &snat_main;
1046 nat44_lb_addr_port_t *local;
1047 snat_static_mapping_t *m;
1050 if (is_sm_addr_only (flags))
1052 e_port = l_port = proto = 0;
1055 if (is_sm_identity_nat (flags))
1058 l_addr.as_u32 = e_addr.as_u32;
1061 m = nat44_ed_sm_o2i_lookup (sm, e_addr, e_port, 0, proto);
1065 // adding local identity nat record for different vrf table
1067 if (!is_sm_identity_nat (m->flags))
1069 return VNET_API_ERROR_VALUE_EXIST;
1072 pool_foreach (local, m->locals)
1074 if (local->vrf_id == vrf_id)
1076 return VNET_API_ERROR_VALUE_EXIST;
1080 pool_get (m->locals, local);
1082 local->vrf_id = vrf_id;
1083 local->fib_index = fib_table_find_or_create_and_lock (
1084 FIB_PROTOCOL_IP4, vrf_id, sm->fib_src_low);
1086 nat44_ed_sm_i2o_add (sm, m, m->local_addr, m->local_port,
1087 local->fib_index, m->proto);
1094 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1099 // fallback to default vrf
1100 vrf_id = sm->inside_vrf_id;
1101 fib_index = sm->inside_fib_index;
1102 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
1105 // test if local mapping record doesn't exist
1106 // identity nat supports multiple records in local mapping
1107 if (!(is_sm_out2in_only (flags) || is_sm_identity_nat (flags)))
1109 if (nat44_ed_sm_i2o_lookup (sm, l_addr, l_port, fib_index, proto))
1111 return VNET_API_ERROR_VALUE_EXIST;
1115 pool_get (sm->static_mappings, m);
1116 clib_memset (m, 0, sizeof (*m));
1119 m->local_addr = l_addr;
1120 m->external_addr = e_addr;
1122 m->pool_addr = pool_addr;
1123 m->tag = vec_dup (tag);
1125 if (!is_sm_addr_only (flags))
1127 m->local_port = l_port;
1128 m->external_port = e_port;
1132 if (is_sm_identity_nat (flags))
1134 pool_get (m->locals, local);
1136 local->vrf_id = vrf_id;
1137 local->fib_index = fib_index;
1142 m->fib_index = fib_index;
1145 if (!is_sm_out2in_only (flags))
1147 nat44_ed_sm_i2o_add (sm, m, m->local_addr, m->local_port, fib_index,
1151 nat44_ed_sm_o2i_add (sm, m, m->external_addr, m->external_port, 0, m->proto);
1153 if (sm->num_workers > 1)
1155 // store worker index for this record
1157 .src_address = m->local_addr,
1161 nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index, 0);
1162 vec_add1 (m->workers, worker_index);
1165 nat44_ed_add_del_interface_fib_reg_entries (e_addr, 1);
1171 nat44_ed_del_static_mapping_internal (ip4_address_t l_addr,
1172 ip4_address_t e_addr, u16 l_port,
1173 u16 e_port, ip_protocol_t proto,
1174 u32 vrf_id, u32 flags)
1176 snat_main_per_thread_data_t *tsm;
1177 snat_main_t *sm = &snat_main;
1179 nat44_lb_addr_port_t *local;
1180 snat_static_mapping_t *m;
1183 if (is_sm_addr_only (flags))
1185 e_port = l_port = proto = 0;
1188 if (is_sm_identity_nat (flags))
1191 l_addr.as_u32 = e_addr.as_u32;
1195 m = nat44_ed_sm_o2i_lookup (sm, e_addr, e_port, 0, proto);
1198 return VNET_API_ERROR_NO_SUCH_ENTRY;
1201 if (is_sm_identity_nat (flags))
1207 vrf_id = sm->inside_vrf_id;
1210 pool_foreach (local, m->locals)
1212 if (local->vrf_id == vrf_id)
1214 local = pool_elt_at_index (m->locals, local - m->locals);
1215 fib_index = local->fib_index;
1216 pool_put (m->locals, local);
1223 return VNET_API_ERROR_NO_SUCH_ENTRY;
1228 fib_index = m->fib_index;
1231 if (!is_sm_out2in_only (flags))
1233 nat44_ed_sm_i2o_del (sm, l_addr, l_port, fib_index, proto);
1236 // delete sessions for static mapping
1237 if (sm->num_workers > 1)
1239 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1243 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1246 nat_ed_static_mapping_del_sessions (sm, tsm, m->local_addr, m->local_port,
1247 m->proto, fib_index,
1248 is_sm_addr_only (flags), e_addr, e_port);
1250 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
1252 if (!pool_elts (m->locals))
1254 // this is last record remove all required stuff
1256 nat44_ed_sm_o2i_del (sm, e_addr, e_port, 0, proto);
1259 vec_free (m->workers);
1260 pool_put (sm->static_mappings, m);
1262 nat44_ed_add_del_interface_fib_reg_entries (e_addr, 0);
1269 nat44_ed_add_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1270 ip_protocol_t proto,
1271 nat44_lb_addr_port_t *locals, u32 flags,
1272 u8 *tag, u32 affinity)
1274 snat_main_t *sm = &snat_main;
1275 snat_static_mapping_t *m;
1276 snat_address_t *a = 0;
1278 nat44_lb_addr_port_t *local;
1286 return VNET_API_ERROR_UNSUPPORTED;
1289 m = nat44_ed_sm_o2i_lookup (sm, e_addr, e_port, 0, proto);
1293 return VNET_API_ERROR_VALUE_EXIST;
1296 if (vec_len (locals) < 2)
1298 return VNET_API_ERROR_INVALID_VALUE;
1301 if (!is_sm_out2in_only (flags))
1303 /* Find external address in allocated addresses and reserve port for
1304 address and port pair mapping when dynamic translations enabled */
1305 for (i = 0; i < vec_len (sm->addresses); i++)
1307 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1309 /* External port must be unused */
1310 a = sm->addresses + i;
1311 if (nat44_ed_sm_o2i_lookup (sm, a->addr, e_port, 0, proto))
1313 return VNET_API_ERROR_VALUE_EXIST;
1318 // external address must be allocated
1321 return VNET_API_ERROR_NO_SUCH_ENTRY;
1325 pool_get (sm->static_mappings, m);
1326 clib_memset (m, 0, sizeof (*m));
1327 m->tag = vec_dup (tag);
1328 m->external_addr = e_addr;
1329 m->external_port = e_port;
1330 m->affinity = affinity;
1334 m->flags |= NAT_SM_FLAG_LB;
1337 m->affinity_per_service_list_head_index =
1338 nat_affinity_get_per_service_list_head_index ();
1340 m->affinity_per_service_list_head_index = ~0;
1342 if (nat44_ed_sm_o2i_add (sm, m, m->external_addr, m->external_port, 0,
1345 nat_log_err ("sm o2i key add failed");
1346 return VNET_API_ERROR_UNSPECIFIED;
1349 for (i = 0; i < vec_len (locals); i++)
1351 locals[i].fib_index = fib_table_find_or_create_and_lock (
1352 FIB_PROTOCOL_IP4, locals[i].vrf_id, sm->fib_src_low);
1353 if (!is_sm_out2in_only (flags))
1355 if (nat44_ed_sm_i2o_add (sm, m, locals[i].addr, locals[i].port, 0,
1358 nat_log_err ("sm i2o key add failed");
1359 rc = VNET_API_ERROR_UNSPECIFIED;
1360 // here we continue with add operation so that it can be safely
1361 // reversed in delete path - otherwise we'd have to track what
1362 // we've done and deal with partial cleanups and since bihash
1363 // adds are (extremely improbable) the only points of failure,
1364 // it's easier to just do it this way
1367 locals[i].prefix = (i == 0) ?
1368 locals[i].probability :
1369 (locals[i - 1].prefix + locals[i].probability);
1370 pool_get (m->locals, local);
1372 if (sm->num_workers > 1)
1375 .src_address = locals[i].addr,
1377 bitmap = clib_bitmap_set (
1378 bitmap, nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index, 0),
1383 /* Assign workers */
1384 if (sm->num_workers > 1)
1386 clib_bitmap_foreach (i, bitmap)
1388 vec_add1 (m->workers, i);
1396 nat44_ed_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1397 ip_protocol_t proto, u32 flags)
1399 snat_main_t *sm = &snat_main;
1400 snat_static_mapping_t *m;
1402 nat44_lb_addr_port_t *local;
1403 snat_main_per_thread_data_t *tsm;
1408 return VNET_API_ERROR_UNSUPPORTED;
1411 m = nat44_ed_sm_o2i_lookup (sm, e_addr, e_port, 0, proto);
1413 return VNET_API_ERROR_NO_SUCH_ENTRY;
1415 if (!is_sm_lb (m->flags))
1416 return VNET_API_ERROR_INVALID_VALUE;
1418 if (nat44_ed_sm_o2i_del (sm, m->external_addr, m->external_port, 0,
1421 nat_log_err ("sm o2i key del failed");
1422 return VNET_API_ERROR_UNSPECIFIED;
1425 pool_foreach (local, m->locals)
1427 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4, sm->fib_src_low);
1428 if (!is_sm_out2in_only (flags))
1430 if (nat44_ed_sm_i2o_del (sm, local->addr, local->port,
1431 local->fib_index, m->proto))
1433 nat_log_err ("sm i2o key del failed");
1434 // For the same reasons as above
1438 if (sm->num_workers > 1)
1441 .src_address = local->addr,
1443 tsm = vec_elt_at_index (
1444 sm->per_thread_data,
1445 nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index, 0));
1448 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1450 /* Delete sessions */
1451 pool_foreach (s, tsm->sessions)
1453 if (!(nat44_ed_is_lb_session (s)))
1456 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1457 s->in2out.port != local->port)
1460 nat44_ed_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1461 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
1467 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1470 pool_free (m->locals);
1472 vec_free (m->workers);
1473 pool_put (sm->static_mappings, m);
1479 nat44_ed_add_del_lb_static_mapping_local (ip4_address_t e_addr, u16 e_port,
1480 ip4_address_t l_addr, u16 l_port,
1481 ip_protocol_t proto, u32 vrf_id,
1482 u8 probability, u8 is_add)
1484 snat_main_t *sm = &snat_main;
1485 snat_static_mapping_t *m = 0;
1486 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1487 snat_main_per_thread_data_t *tsm;
1495 return VNET_API_ERROR_UNSUPPORTED;
1498 m = nat44_ed_sm_o2i_lookup (sm, e_addr, e_port, 0, proto);
1502 return VNET_API_ERROR_NO_SUCH_ENTRY;
1505 if (!is_sm_lb (m->flags))
1507 return VNET_API_ERROR_INVALID_VALUE;
1510 pool_foreach (local, m->locals)
1512 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1513 (local->vrf_id == vrf_id))
1515 match_local = local;
1524 return VNET_API_ERROR_VALUE_EXIST;
1527 pool_get (m->locals, local);
1528 clib_memset (local, 0, sizeof (*local));
1529 local->addr.as_u32 = l_addr.as_u32;
1530 local->port = l_port;
1531 local->probability = probability;
1532 local->vrf_id = vrf_id;
1534 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1537 if (!is_sm_out2in_only (m->flags))
1539 if (nat44_ed_sm_i2o_add (sm, m, l_addr, l_port, local->fib_index,
1542 nat_log_err ("sm i2o key add failed");
1543 pool_put (m->locals, local);
1544 return VNET_API_ERROR_UNSPECIFIED;
1551 return VNET_API_ERROR_NO_SUCH_ENTRY;
1553 if (pool_elts (m->locals) < 3)
1554 return VNET_API_ERROR_UNSPECIFIED;
1556 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1559 if (!is_sm_out2in_only (m->flags))
1561 if (nat44_ed_sm_i2o_del (sm, l_addr, l_port, match_local->fib_index,
1563 nat_log_err ("sm i2o key del failed");
1566 if (sm->num_workers > 1)
1569 .src_address = local->addr,
1571 tsm = vec_elt_at_index (
1572 sm->per_thread_data,
1573 nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index, 0));
1576 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1578 /* Delete sessions */
1579 pool_foreach (s, tsm->sessions) {
1580 if (!(nat44_ed_is_lb_session (s)))
1583 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1584 s->in2out.port != match_local->port)
1587 nat44_ed_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
1588 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
1591 pool_put (m->locals, match_local);
1594 vec_free (m->workers);
1596 pool_foreach (local, m->locals)
1598 vec_add1 (locals, local - m->locals);
1599 if (sm->num_workers > 1)
1602 ip.src_address.as_u32 = local->addr.as_u32,
1603 bitmap = clib_bitmap_set (
1605 nat44_ed_get_in2out_worker_index (0, &ip, local->fib_index, 0), 1);
1609 ASSERT (vec_len (locals) > 1);
1611 local = pool_elt_at_index (m->locals, locals[0]);
1612 local->prefix = local->probability;
1613 for (i = 1; i < vec_len (locals); i++)
1615 local = pool_elt_at_index (m->locals, locals[i]);
1616 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1617 local->prefix = local->probability + prev_local->prefix;
1620 /* Assign workers */
1621 if (sm->num_workers > 1)
1623 clib_bitmap_foreach (i, bitmap) { vec_add1(m->workers, i); }
1630 expire_per_vrf_sessions (u32 fib_index)
1632 per_vrf_sessions_t *per_vrf_sessions;
1633 snat_main_per_thread_data_t *tsm;
1634 snat_main_t *sm = &snat_main;
1636 vec_foreach (tsm, sm->per_thread_data)
1638 pool_foreach (per_vrf_sessions, tsm->per_vrf_sessions_pool)
1640 if ((per_vrf_sessions->rx_fib_index == fib_index) ||
1641 (per_vrf_sessions->tx_fib_index == fib_index))
1643 per_vrf_sessions->expired = 1;
1650 update_per_vrf_sessions_pool (u32 fib_index, int is_del)
1652 snat_main_t *sm = &snat_main;
1655 // we don't care if it is outside/inside fib
1656 // we just care about their ref_count
1657 // if it reaches 0 sessions should expire
1658 // because the fib isn't valid for NAT anymore
1660 vec_foreach (fib, sm->fibs)
1662 if (fib->fib_index == fib_index)
1667 if (!fib->ref_count)
1669 vec_del1 (sm->fibs, fib - sm->fibs);
1670 expire_per_vrf_sessions (fib_index);
1680 vec_add2 (sm->fibs, fib, 1);
1682 fib->fib_index = fib_index;
1686 static_always_inline nat_fib_t *
1687 nat44_ed_get_outside_fib (nat_fib_t *outside_fibs, u32 fib_index)
1690 vec_foreach (f, outside_fibs)
1692 if (f->fib_index == fib_index)
1700 static_always_inline snat_interface_t *
1701 nat44_ed_get_interface (snat_interface_t *interfaces, u32 sw_if_index)
1703 snat_interface_t *i;
1704 pool_foreach (i, interfaces)
1706 if (i->sw_if_index == sw_if_index)
1715 nat44_ed_add_interface (u32 sw_if_index, u8 is_inside)
1717 const char *del_feature_name, *feature_name;
1718 snat_main_t *sm = &snat_main;
1720 nat_fib_t *outside_fib;
1721 snat_interface_t *i;
1727 nat_log_err ("nat44 is disabled");
1728 return VNET_API_ERROR_UNSUPPORTED;
1731 if (nat44_ed_get_interface (sm->output_feature_interfaces, sw_if_index))
1733 nat_log_err ("error interface already configured");
1734 return VNET_API_ERROR_VALUE_EXIST;
1737 i = nat44_ed_get_interface (sm->interfaces, sw_if_index);
1740 if ((nat44_ed_is_interface_inside (i) && is_inside) ||
1741 (nat44_ed_is_interface_outside (i) && !is_inside))
1745 if (sm->num_workers > 1)
1747 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1748 "nat44-out2in-worker-handoff";
1749 feature_name = "nat44-handoff-classify";
1753 del_feature_name = !is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1755 feature_name = "nat44-ed-classify";
1758 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1761 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1762 sw_if_index, 0, 0, 0);
1763 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1,
1768 if (sm->num_workers > 1)
1770 feature_name = is_inside ? "nat44-in2out-worker-handoff" :
1771 "nat44-out2in-worker-handoff";
1775 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1778 nat_validate_interface_counters (sm, sw_if_index);
1779 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1782 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1,
1785 pool_get (sm->interfaces, i);
1786 i->sw_if_index = sw_if_index;
1791 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
1793 update_per_vrf_sessions_pool (fib_index, 0 /*is_del*/);
1797 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1799 outside_fib = nat44_ed_get_outside_fib (sm->outside_fibs, fib_index);
1802 outside_fib->ref_count++;
1806 vec_add2 (sm->outside_fibs, outside_fib, 1);
1807 outside_fib->fib_index = fib_index;
1808 outside_fib->ref_count = 1;
1811 nat44_ed_add_del_nat_addr_fib_reg_entries (sw_if_index, 1);
1812 nat44_ed_add_del_sm_fib_reg_entries (sw_if_index, 1);
1814 nat44_ed_bind_if_addr_to_nat_addr (sw_if_index);
1818 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1825 nat44_ed_del_interface (u32 sw_if_index, u8 is_inside)
1827 const char *del_feature_name, *feature_name;
1828 snat_main_t *sm = &snat_main;
1830 nat_fib_t *outside_fib;
1831 snat_interface_t *i;
1837 nat_log_err ("nat44 is disabled");
1838 return VNET_API_ERROR_UNSUPPORTED;
1841 i = nat44_ed_get_interface (sm->interfaces, sw_if_index);
1844 nat_log_err ("error interface couldn't be found");
1845 return VNET_API_ERROR_NO_SUCH_ENTRY;
1848 if (nat44_ed_is_interface_inside (i) && nat44_ed_is_interface_outside (i))
1850 if (sm->num_workers > 1)
1852 del_feature_name = "nat44-handoff-classify";
1853 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1854 "nat44-out2in-worker-handoff";
1858 del_feature_name = "nat44-ed-classify";
1859 feature_name = !is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1862 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1867 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1868 sw_if_index, 0, 0, 0);
1869 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1,
1874 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1878 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1883 if (sm->num_workers > 1)
1885 feature_name = is_inside ? "nat44-in2out-worker-handoff" :
1886 "nat44-out2in-worker-handoff";
1890 feature_name = is_inside ? "nat-pre-in2out" : "nat-pre-out2in";
1893 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
1898 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 0,
1902 pool_put (sm->interfaces, i);
1906 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
1908 update_per_vrf_sessions_pool (fib_index, 1 /*is_del*/);
1912 outside_fib = nat44_ed_get_outside_fib (sm->outside_fibs, fib_index);
1915 outside_fib->ref_count--;
1916 if (!outside_fib->ref_count)
1918 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1922 nat44_ed_add_del_nat_addr_fib_reg_entries (sw_if_index, 0);
1923 nat44_ed_add_del_sm_fib_reg_entries (sw_if_index, 0);
1930 nat44_ed_add_output_interface (u32 sw_if_index)
1932 snat_main_t *sm = &snat_main;
1934 nat_fib_t *outside_fib;
1935 snat_interface_t *i;
1941 nat_log_err ("nat44 is disabled");
1942 return VNET_API_ERROR_UNSUPPORTED;
1945 if (nat44_ed_get_interface (sm->interfaces, sw_if_index))
1947 nat_log_err ("error interface already configured");
1948 return VNET_API_ERROR_VALUE_EXIST;
1951 if (nat44_ed_get_interface (sm->output_feature_interfaces, sw_if_index))
1953 nat_log_err ("error interface already configured");
1954 return VNET_API_ERROR_VALUE_EXIST;
1957 if (sm->num_workers > 1)
1959 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1965 rv = ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, 1);
1971 vnet_feature_enable_disable (
1972 "ip4-unicast", "nat44-out2in-worker-handoff", sw_if_index, 1, 0, 0);
1973 vnet_feature_enable_disable ("ip4-output",
1974 "nat44-in2out-output-worker-handoff",
1975 sw_if_index, 1, 0, 0);
1979 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 1);
1985 rv = ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, 1);
1991 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
1992 sw_if_index, 1, 0, 0);
1993 vnet_feature_enable_disable ("ip4-output", "nat-pre-in2out-output",
1994 sw_if_index, 1, 0, 0);
1997 nat_validate_interface_counters (sm, sw_if_index);
1999 pool_get (sm->output_feature_interfaces, i);
2000 i->sw_if_index = sw_if_index;
2002 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2003 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2006 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
2007 update_per_vrf_sessions_pool (fib_index, 0 /*is_del*/);
2009 outside_fib = nat44_ed_get_outside_fib (sm->outside_fibs, fib_index);
2012 outside_fib->ref_count++;
2016 vec_add2 (sm->outside_fibs, outside_fib, 1);
2017 outside_fib->fib_index = fib_index;
2018 outside_fib->ref_count = 1;
2021 nat44_ed_add_del_nat_addr_fib_reg_entries (sw_if_index, 1);
2022 nat44_ed_add_del_sm_fib_reg_entries (sw_if_index, 1);
2024 nat44_ed_bind_if_addr_to_nat_addr (sw_if_index);
2030 nat44_ed_del_output_interface (u32 sw_if_index)
2032 snat_main_t *sm = &snat_main;
2034 nat_fib_t *outside_fib;
2035 snat_interface_t *i;
2041 nat_log_err ("nat44 is disabled");
2042 return VNET_API_ERROR_UNSUPPORTED;
2045 i = nat44_ed_get_interface (sm->output_feature_interfaces, sw_if_index);
2048 nat_log_err ("error interface couldn't be found");
2049 return VNET_API_ERROR_NO_SUCH_ENTRY;
2052 if (sm->num_workers > 1)
2054 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2060 rv = ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, 0);
2066 vnet_feature_enable_disable (
2067 "ip4-unicast", "nat44-out2in-worker-handoff", sw_if_index, 0, 0, 0);
2068 vnet_feature_enable_disable ("ip4-output",
2069 "nat44-in2out-output-worker-handoff",
2070 sw_if_index, 0, 0, 0);
2074 rv = ip4_sv_reass_enable_disable_with_refcnt (sw_if_index, 0);
2080 rv = ip4_sv_reass_output_enable_disable_with_refcnt (sw_if_index, 0);
2086 vnet_feature_enable_disable ("ip4-unicast", "nat-pre-out2in",
2087 sw_if_index, 0, 0, 0);
2088 vnet_feature_enable_disable ("ip4-output", "nat-pre-in2out-output",
2089 sw_if_index, 0, 0, 0);
2093 pool_put (sm->output_feature_interfaces, i);
2096 fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
2097 update_per_vrf_sessions_pool (fib_index, 1 /*is_del*/);
2099 outside_fib = nat44_ed_get_outside_fib (sm->outside_fibs, fib_index);
2102 outside_fib->ref_count--;
2103 if (!outside_fib->ref_count)
2105 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2109 nat44_ed_add_del_nat_addr_fib_reg_entries (sw_if_index, 0);
2110 nat44_ed_add_del_sm_fib_reg_entries (sw_if_index, 0);
2116 snat_set_workers (uword * bitmap)
2118 snat_main_t *sm = &snat_main;
2121 if (sm->num_workers < 2)
2122 return VNET_API_ERROR_FEATURE_DISABLED;
2124 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2125 return VNET_API_ERROR_INVALID_WORKER;
2127 vec_free (sm->workers);
2128 clib_bitmap_foreach (i, bitmap)
2130 vec_add1(sm->workers, i);
2131 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2132 sm->per_thread_data[sm->first_worker_index + i].thread_index = i;
2136 sm->port_per_thread = (65536 - ED_USER_PORT_OFFSET) / _vec_len (sm->workers);
2142 nat44_ed_set_frame_queue_nelts (u32 frame_queue_nelts)
2145 snat_main_t *sm = &snat_main;
2147 if ((sm->fq_in2out_index != ~0) || (sm->fq_out2in_index != ~0) ||
2148 (sm->fq_in2out_output_index != ~0))
2150 // frame queu nelts can be set only before first
2151 // call to nat44_plugin_enable after that it
2152 // doesn't make sense
2153 nat_log_err ("Frame queue was already initialized. "
2154 "Change is not possible");
2158 sm->frame_queue_nelts = frame_queue_nelts;
2163 nat44_ed_update_outside_fib_cb (ip4_main_t *im, uword opaque, u32 sw_if_index,
2164 u32 new_fib_index, u32 old_fib_index)
2166 snat_main_t *sm = &snat_main;
2167 nat_fib_t *outside_fib;
2168 snat_interface_t *i;
2172 if (!sm->enabled || (new_fib_index == old_fib_index)
2173 || (!vec_len (sm->outside_fibs)))
2178 pool_foreach (i, sm->interfaces)
2180 if (i->sw_if_index == sw_if_index)
2182 if (!(nat44_ed_is_interface_outside (i)))
2188 pool_foreach (i, sm->output_feature_interfaces)
2190 if (i->sw_if_index == sw_if_index)
2192 if (!(nat44_ed_is_interface_outside (i)))
2201 vec_foreach (outside_fib, sm->outside_fibs)
2203 if (outside_fib->fib_index == old_fib_index)
2205 outside_fib->ref_count--;
2206 if (!outside_fib->ref_count)
2207 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2212 vec_foreach (outside_fib, sm->outside_fibs)
2214 if (outside_fib->fib_index == new_fib_index)
2216 outside_fib->ref_count++;
2224 vec_add2 (sm->outside_fibs, outside_fib, 1);
2225 outside_fib->ref_count = 1;
2226 outside_fib->fib_index = new_fib_index;
2230 static void nat44_ed_update_outside_fib_cb (ip4_main_t *im, uword opaque,
2231 u32 sw_if_index, u32 new_fib_index,
2234 static void nat44_ed_add_del_interface_address_cb (
2235 ip4_main_t *im, uword opaque, u32 sw_if_index, ip4_address_t *address,
2236 u32 address_length, u32 if_address_index, u32 is_delete);
2238 static void nat44_ed_add_del_static_mapping_cb (
2239 ip4_main_t *im, uword opaque, u32 sw_if_index, ip4_address_t *address,
2240 u32 address_length, u32 if_address_index, u32 is_delete);
2243 test_key_calc_split ()
2245 ip4_address_t l_addr;
2246 l_addr.as_u8[0] = 1;
2247 l_addr.as_u8[1] = 1;
2248 l_addr.as_u8[2] = 1;
2249 l_addr.as_u8[3] = 1;
2250 ip4_address_t r_addr;
2251 r_addr.as_u8[0] = 2;
2252 r_addr.as_u8[1] = 2;
2253 r_addr.as_u8[2] = 2;
2254 r_addr.as_u8[3] = 2;
2258 u32 fib_index = 9000001;
2259 u32 thread_index = 3000000001;
2260 u32 session_index = 3000000221;
2261 clib_bihash_kv_16_8_t kv;
2262 init_ed_kv (&kv, l_addr.as_u32, l_port, r_addr.as_u32, r_port, fib_index,
2263 proto, thread_index, session_index);
2264 ip4_address_t l_addr2;
2265 ip4_address_t r_addr2;
2266 clib_memset (&l_addr2, 0, sizeof (l_addr2));
2267 clib_memset (&r_addr2, 0, sizeof (r_addr2));
2272 split_ed_kv (&kv, &l_addr2, &r_addr2, &proto2, &fib_index2, &l_port2,
2274 ASSERT (l_addr.as_u32 == l_addr2.as_u32);
2275 ASSERT (r_addr.as_u32 == r_addr2.as_u32);
2276 ASSERT (l_port == l_port2);
2277 ASSERT (r_port == r_port2);
2278 ASSERT (proto == proto2);
2279 ASSERT (fib_index == fib_index2);
2280 ASSERT (thread_index == ed_value_get_thread_index (&kv));
2281 ASSERT (session_index == ed_value_get_session_index (&kv));
2284 static clib_error_t *
2285 nat_ip_table_add_del (vnet_main_t * vnm, u32 table_id, u32 is_add)
2290 fib_index = ip4_fib_index_from_table_id (table_id);
2291 if (fib_index != ~0)
2293 expire_per_vrf_sessions (fib_index);
2299 VNET_IP_TABLE_ADD_DEL_FUNCTION (nat_ip_table_add_del);
2301 #define nat_validate_simple_counter(c, i) \
2304 vlib_validate_simple_counter (&c, i); \
2305 vlib_zero_simple_counter (&c, i); \
2309 #define nat_init_simple_counter(c, n, sn) \
2313 c.stat_segment_name = sn; \
2314 nat_validate_simple_counter (c, 0); \
2318 static_always_inline void
2319 nat_validate_interface_counters (snat_main_t *sm, u32 sw_if_index)
2322 nat_validate_simple_counter (sm->counters.fastpath.in2out.x, sw_if_index); \
2323 nat_validate_simple_counter (sm->counters.fastpath.out2in.x, sw_if_index); \
2324 nat_validate_simple_counter (sm->counters.slowpath.in2out.x, sw_if_index); \
2325 nat_validate_simple_counter (sm->counters.slowpath.out2in.x, sw_if_index);
2326 foreach_nat_counter;
2328 nat_validate_simple_counter (sm->counters.hairpinning, sw_if_index);
2331 static clib_error_t *
2332 nat_init (vlib_main_t * vm)
2334 snat_main_t *sm = &snat_main;
2335 vlib_thread_main_t *tm = vlib_get_thread_main ();
2336 vlib_thread_registration_t *tr;
2337 ip4_add_del_interface_address_callback_t cbi = { 0 };
2338 ip4_table_bind_callback_t cbt = { 0 };
2339 u32 i, num_threads = 0;
2340 uword *p, *bitmap = 0;
2342 clib_memset (sm, 0, sizeof (*sm));
2345 sm->ip4_main = &ip4_main;
2347 // frame queue indices used for handoff
2348 sm->fq_out2in_index = ~0;
2349 sm->fq_in2out_index = ~0;
2350 sm->fq_in2out_output_index = ~0;
2352 sm->log_level = NAT_LOG_ERROR;
2354 sm->log_class = vlib_log_register_class ("nat", 0);
2355 nat_ipfix_logging_init (vm);
2357 nat_init_simple_counter (sm->total_sessions, "total-sessions",
2358 "/nat44-ed/total-sessions");
2359 sm->max_cfg_sessions_gauge =
2360 vlib_stats_add_gauge ("/nat44-ed/max-cfg-sessions");
2363 nat_init_simple_counter (sm->counters.fastpath.in2out.x, #x, \
2364 "/nat44-ed/in2out/fastpath/" #x); \
2365 nat_init_simple_counter (sm->counters.fastpath.out2in.x, #x, \
2366 "/nat44-ed/out2in/fastpath/" #x); \
2367 nat_init_simple_counter (sm->counters.slowpath.in2out.x, #x, \
2368 "/nat44-ed/in2out/slowpath/" #x); \
2369 nat_init_simple_counter (sm->counters.slowpath.out2in.x, #x, \
2370 "/nat44-ed/out2in/slowpath/" #x);
2371 foreach_nat_counter;
2373 nat_init_simple_counter (sm->counters.hairpinning, "hairpinning",
2374 "/nat44-ed/hairpinning");
2376 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2379 tr = (vlib_thread_registration_t *) p[0];
2382 sm->num_workers = tr->count;
2383 sm->first_worker_index = tr->first_index;
2386 num_threads = tm->n_vlib_mains - 1;
2387 sm->port_per_thread = 65536 - ED_USER_PORT_OFFSET;
2388 vec_validate (sm->per_thread_data, num_threads);
2390 /* Use all available workers by default */
2391 if (sm->num_workers > 1)
2393 for (i = 0; i < sm->num_workers; i++)
2394 bitmap = clib_bitmap_set (bitmap, i, 1);
2395 snat_set_workers (bitmap);
2396 clib_bitmap_free (bitmap);
2400 sm->per_thread_data[0].snat_thread_index = 0;
2403 /* callbacks to call when interface address changes. */
2404 cbi.function = nat44_ed_add_del_interface_address_cb;
2405 vec_add1 (sm->ip4_main->add_del_interface_address_callbacks, cbi);
2406 cbi.function = nat44_ed_add_del_static_mapping_cb;
2407 vec_add1 (sm->ip4_main->add_del_interface_address_callbacks, cbi);
2409 /* callbacks to call when interface to table biding changes */
2410 cbt.function = nat44_ed_update_outside_fib_cb;
2411 vec_add1 (sm->ip4_main->table_bind_callbacks, cbt);
2414 fib_source_allocate ("nat-low", FIB_SOURCE_PRIORITY_LOW,
2415 FIB_SOURCE_BH_SIMPLE);
2417 fib_source_allocate ("nat-hi", FIB_SOURCE_PRIORITY_HI,
2418 FIB_SOURCE_BH_SIMPLE);
2420 nat_affinity_init (vm);
2421 test_key_calc_split ();
2423 return nat44_api_hookup (vm);
2426 VLIB_INIT_FUNCTION (nat_init);
2429 nat44_plugin_enable (nat44_config_t c)
2431 snat_main_t *sm = &snat_main;
2435 sm->forwarding_enabled = 0;
2436 sm->mss_clamping = 0;
2439 c.sessions = 63 * 1024;
2441 sm->max_translations_per_thread = c.sessions;
2442 vlib_stats_set_gauge (sm->max_cfg_sessions_gauge,
2443 sm->max_translations_per_thread);
2444 sm->translation_buckets = nat_calc_bihash_buckets (c.sessions);
2446 vec_add1 (sm->max_translations_per_fib, sm->max_translations_per_thread);
2448 sm->inside_vrf_id = c.inside_vrf;
2449 sm->inside_fib_index =
2450 fib_table_find_or_create_and_lock
2451 (FIB_PROTOCOL_IP4, c.inside_vrf, sm->fib_src_hi);
2453 sm->outside_vrf_id = c.outside_vrf;
2454 sm->outside_fib_index = fib_table_find_or_create_and_lock (
2455 FIB_PROTOCOL_IP4, c.outside_vrf, sm->fib_src_hi);
2457 nat44_ed_db_init ();
2459 nat_affinity_enable ();
2461 nat_reset_timeouts (&sm->timeouts);
2463 vlib_zero_simple_counter (&sm->total_sessions, 0);
2465 if (!sm->frame_queue_nelts)
2467 sm->frame_queue_nelts = NAT_FQ_NELTS_DEFAULT;
2470 if (sm->num_workers > 1)
2472 vlib_main_t *vm = vlib_get_main ();
2475 if (sm->fq_in2out_index == ~0)
2477 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out");
2478 sm->fq_in2out_index =
2479 vlib_frame_queue_main_init (node->index, sm->frame_queue_nelts);
2481 if (sm->fq_out2in_index == ~0)
2483 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-out2in");
2484 sm->fq_out2in_index =
2485 vlib_frame_queue_main_init (node->index, sm->frame_queue_nelts);
2487 if (sm->fq_in2out_output_index == ~0)
2489 node = vlib_get_node_by_name (vm, (u8 *) "nat44-ed-in2out-output");
2490 sm->fq_in2out_output_index =
2491 vlib_frame_queue_main_init (node->index, sm->frame_queue_nelts);
2502 nat44_ed_del_addresses ()
2504 snat_main_t *sm = &snat_main;
2505 snat_address_t *a, *vec;
2508 vec = vec_dup (sm->addresses);
2509 vec_foreach (a, vec)
2511 error = nat44_ed_del_address (a->addr, 0);
2514 nat_log_err ("error occurred while removing adderess");
2518 vec_free (sm->addresses);
2521 vec = vec_dup (sm->twice_nat_addresses);
2522 vec_foreach (a, vec)
2524 error = nat44_ed_del_address (a->addr, 1);
2527 nat_log_err ("error occurred while removing adderess");
2531 vec_free (sm->twice_nat_addresses);
2532 sm->twice_nat_addresses = 0;
2534 vec_free (sm->addr_to_resolve);
2535 sm->addr_to_resolve = 0;
2541 nat44_ed_del_interfaces ()
2543 snat_main_t *sm = &snat_main;
2544 snat_interface_t *i, *pool;
2547 pool = pool_dup (sm->interfaces);
2548 pool_foreach (i, pool)
2550 if (nat44_ed_is_interface_inside (i))
2552 error = nat44_ed_del_interface (i->sw_if_index, 1);
2554 if (nat44_ed_is_interface_outside (i))
2556 error = nat44_ed_del_interface (i->sw_if_index, 0);
2561 nat_log_err ("error occurred while removing interface");
2565 pool_free (sm->interfaces);
2571 nat44_ed_del_output_interfaces ()
2573 snat_main_t *sm = &snat_main;
2574 snat_interface_t *i, *pool;
2577 pool = pool_dup (sm->output_feature_interfaces);
2578 pool_foreach (i, pool)
2580 error = nat44_ed_del_output_interface (i->sw_if_index);
2583 nat_log_err ("error occurred while removing output interface");
2587 pool_free (sm->output_feature_interfaces);
2588 sm->output_feature_interfaces = 0;
2592 static clib_error_t *
2593 nat44_ed_sw_interface_add_del (vnet_main_t *vnm, u32 sw_if_index, u32 is_add)
2595 snat_main_t *sm = &snat_main;
2596 snat_interface_t *i;
2605 i = nat44_ed_get_interface (sm->interfaces, sw_if_index);
2608 bool is_inside = nat44_ed_is_interface_inside (i);
2609 bool is_outside = nat44_ed_is_interface_outside (i);
2613 error |= nat44_ed_del_interface (sw_if_index, 1);
2617 error |= nat44_ed_del_interface (sw_if_index, 0);
2622 nat_log_err ("error occurred while removing interface");
2626 i = nat44_ed_get_interface (sm->output_feature_interfaces, sw_if_index);
2629 error = nat44_ed_del_output_interface (sw_if_index);
2632 nat_log_err ("error occurred while removing output interface");
2639 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (nat44_ed_sw_interface_add_del);
2642 nat44_ed_del_static_mappings ()
2644 snat_main_t *sm = &snat_main;
2645 snat_static_mapping_t *m, *pool;
2648 pool = pool_dup (sm->static_mappings);
2649 pool_foreach (m, pool)
2651 error = nat44_ed_del_static_mapping_internal (
2652 m->local_addr, m->external_addr, m->local_port, m->external_port,
2653 m->proto, m->vrf_id, m->flags);
2656 nat_log_err ("error occurred while removing mapping");
2660 pool_free (sm->static_mappings);
2661 sm->static_mappings = 0;
2663 vec_free (sm->sm_to_resolve);
2664 sm->sm_to_resolve = 0;
2670 nat44_plugin_disable ()
2672 snat_main_t *sm = &snat_main;
2675 fail_if_disabled ();
2677 rc = nat44_ed_del_static_mappings ();
2679 error = VNET_API_ERROR_BUG;
2681 rc = nat44_ed_del_addresses ();
2683 error = VNET_API_ERROR_BUG;
2685 rc = nat44_ed_del_interfaces ();
2687 error = VNET_API_ERROR_BUG;
2689 rc = nat44_ed_del_output_interfaces ();
2691 error = VNET_API_ERROR_BUG;
2693 nat44_ed_del_vrf_tables ();
2695 vec_free (sm->max_translations_per_fib);
2696 sm->max_translations_per_fib = 0;
2698 nat44_ed_db_free ();
2700 clib_memset (&sm->rconfig, 0, sizeof (sm->rconfig));
2702 nat_affinity_disable ();
2704 sm->forwarding_enabled = 0;
2711 nat44_ed_forwarding_enable_disable (u8 is_enable)
2713 snat_main_per_thread_data_t *tsm;
2714 snat_main_t *sm = &snat_main;
2717 u32 *ses_to_be_removed = 0, *ses_index;
2719 sm->forwarding_enabled = is_enable != 0;
2721 if (!sm->enabled || is_enable)
2726 vec_foreach (tsm, sm->per_thread_data)
2728 pool_foreach (s, tsm->sessions)
2730 if (na44_ed_is_fwd_bypass_session (s))
2732 vec_add1 (ses_to_be_removed, s - tsm->sessions);
2735 vec_foreach (ses_index, ses_to_be_removed)
2737 s = pool_elt_at_index (tsm->sessions, ses_index[0]);
2738 nat44_ed_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
2739 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
2742 vec_free (ses_to_be_removed);
2746 static_always_inline snat_static_mapping_t *
2747 nat44_ed_sm_match (snat_main_t *sm, ip4_address_t match_addr, u16 match_port,
2748 u32 match_fib_index, ip_protocol_t match_protocol,
2751 snat_static_mapping_t *m;
2754 m = nat44_ed_sm_i2o_lookup (sm, match_addr, match_port, match_fib_index,
2759 // try address only mapping
2760 m = nat44_ed_sm_i2o_lookup (sm, match_addr, 0, match_fib_index, 0);
2764 // default static mapping fib index (based on configuration)
2765 if (sm->inside_fib_index != match_fib_index)
2767 m = nat44_ed_sm_i2o_lookup (sm, match_addr, match_port,
2768 sm->inside_fib_index, match_protocol);
2772 // try address only mapping
2773 m = nat44_ed_sm_i2o_lookup (sm, match_addr, 0, sm->inside_fib_index,
2778 // TODO: this specific use case may be deprecated (needs testing)
2779 if (sm->outside_fib_index != match_fib_index)
2781 m = nat44_ed_sm_i2o_lookup (sm, match_addr, match_port,
2782 sm->outside_fib_index, match_protocol);
2786 // try address only mapping
2787 m = nat44_ed_sm_i2o_lookup (sm, match_addr, 0, sm->outside_fib_index,
2796 nat44_ed_sm_o2i_lookup (sm, match_addr, match_port, 0, match_protocol);
2800 // try address only mapping
2801 m = nat44_ed_sm_o2i_lookup (sm, match_addr, 0, 0, 0);
2809 snat_static_mapping_match (vlib_main_t *vm, ip4_address_t match_addr,
2810 u16 match_port, u32 match_fib_index,
2811 ip_protocol_t match_protocol,
2812 ip4_address_t *mapping_addr, u16 *mapping_port,
2813 u32 *mapping_fib_index, int by_external,
2814 u8 *is_addr_only, twice_nat_type_t *twice_nat,
2815 lb_nat_type_t *lb, ip4_address_t *ext_host_addr,
2816 u8 *is_identity_nat, snat_static_mapping_t **out)
2818 snat_main_t *sm = &snat_main;
2819 snat_static_mapping_t *m;
2820 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2821 nat44_lb_addr_port_t *local;
2824 m = nat44_ed_sm_match (sm, match_addr, match_port, match_fib_index,
2825 match_protocol, by_external);
2833 if (is_sm_lb (m->flags))
2835 if (PREDICT_FALSE (lb != 0))
2836 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2837 if (m->affinity && !nat_affinity_find_and_lock (
2838 vm, ext_host_addr[0], match_addr,
2839 match_protocol, match_port, &backend_index))
2841 local = pool_elt_at_index (m->locals, backend_index);
2842 *mapping_addr = local->addr;
2843 *mapping_port = local->port;
2844 *mapping_fib_index = local->fib_index;
2847 // pick locals matching this worker
2848 if (PREDICT_FALSE (sm->num_workers > 1))
2850 u32 thread_index = vlib_get_thread_index ();
2851 pool_foreach_index (i, m->locals)
2853 local = pool_elt_at_index (m->locals, i);
2856 .src_address = local->addr,
2859 if (nat44_ed_get_in2out_worker_index (0, &ip, m->fib_index,
2865 ASSERT (vec_len (tmp) != 0);
2869 pool_foreach_index (i, m->locals)
2874 hi = vec_len (tmp) - 1;
2875 local = pool_elt_at_index (m->locals, tmp[hi]);
2876 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2879 mid = ((hi - lo) >> 1) + lo;
2880 local = pool_elt_at_index (m->locals, tmp[mid]);
2881 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2883 local = pool_elt_at_index (m->locals, tmp[lo]);
2884 if (!(local->prefix >= rand))
2886 *mapping_addr = local->addr;
2887 *mapping_port = local->port;
2888 *mapping_fib_index = local->fib_index;
2891 if (nat_affinity_create_and_lock (ext_host_addr[0], match_addr,
2892 match_protocol, match_port,
2893 tmp[lo], m->affinity,
2894 m->affinity_per_service_list_head_index))
2895 nat_elog_info (sm, "create affinity record failed");
2901 if (PREDICT_FALSE (lb != 0))
2903 *mapping_fib_index = m->fib_index;
2904 *mapping_addr = m->local_addr;
2905 /* Address only mapping doesn't change port */
2907 is_sm_addr_only (m->flags) ? match_port : m->local_port;
2912 *mapping_addr = m->external_addr;
2913 /* Address only mapping doesn't change port */
2915 is_sm_addr_only (m->flags) ? match_port : m->external_port;
2916 *mapping_fib_index = sm->outside_fib_index;
2920 if (PREDICT_FALSE (is_addr_only != 0))
2921 *is_addr_only = is_sm_addr_only (m->flags);
2923 if (PREDICT_FALSE (twice_nat != 0))
2925 *twice_nat = TWICE_NAT_DISABLED;
2927 if (is_sm_twice_nat (m->flags))
2929 *twice_nat = TWICE_NAT;
2931 else if (is_sm_self_twice_nat (m->flags))
2933 *twice_nat = TWICE_NAT_SELF;
2937 if (PREDICT_FALSE (is_identity_nat != 0))
2938 *is_identity_nat = is_sm_identity_nat (m->flags);
2947 nat44_ed_get_in2out_worker_index (vlib_buffer_t *b, ip4_header_t *ip,
2948 u32 rx_fib_index, u8 is_output)
2950 snat_main_t *sm = &snat_main;
2951 u32 next_worker_index = sm->first_worker_index;
2954 clib_bihash_kv_16_8_t kv16, value16;
2956 u32 fib_index = rx_fib_index;
2959 if (PREDICT_FALSE (is_output))
2961 fib_index = sm->outside_fib_index;
2962 nat_fib_t *outside_fib;
2963 fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
2964 fib_prefix_t pfx = {
2965 .fp_proto = FIB_PROTOCOL_IP4,
2968 .ip4.as_u32 = ip->dst_address.as_u32,
2972 switch (vec_len (sm->outside_fibs))
2975 fib_index = sm->outside_fib_index;
2978 fib_index = sm->outside_fibs[0].fib_index;
2981 vec_foreach (outside_fib, sm->outside_fibs)
2983 fei = fib_table_lookup (outside_fib->fib_index, &pfx);
2984 if (FIB_NODE_INDEX_INVALID != fei)
2986 if (fib_entry_get_resolving_interface (fei) != ~0)
2988 fib_index = outside_fib->fib_index;
2997 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
2999 ip4_address_t lookup_saddr, lookup_daddr;
3000 u16 lookup_sport, lookup_dport;
3003 if (!nat_get_icmp_session_lookup_values (
3004 b, ip, &lookup_saddr, &lookup_sport, &lookup_daddr,
3005 &lookup_dport, &lookup_protocol))
3007 init_ed_k (&kv16, lookup_saddr.as_u32, lookup_sport,
3008 lookup_daddr.as_u32, lookup_dport, rx_fib_index,
3010 if (!clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16))
3012 next_worker_index = ed_value_get_thread_index (&value16);
3013 vnet_buffer2 (b)->nat.cached_session_index =
3014 ed_value_get_session_index (&value16);
3020 init_ed_k (&kv16, ip->src_address.as_u32,
3021 vnet_buffer (b)->ip.reass.l4_src_port, ip->dst_address.as_u32,
3022 vnet_buffer (b)->ip.reass.l4_dst_port, fib_index,
3025 if (!clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16))
3027 next_worker_index = ed_value_get_thread_index (&value16);
3028 vnet_buffer2 (b)->nat.cached_session_index =
3029 ed_value_get_session_index (&value16);
3034 init_ed_k (&kv16, ip->dst_address.as_u32,
3035 vnet_buffer (b)->ip.reass.l4_dst_port, ip->src_address.as_u32,
3036 vnet_buffer (b)->ip.reass.l4_src_port, rx_fib_index,
3038 if (!clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16))
3040 next_worker_index = ed_value_get_thread_index (&value16);
3041 vnet_buffer2 (b)->nat.cached_dst_nat_session_index =
3042 ed_value_get_session_index (&value16);
3047 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3048 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24) +
3049 rx_fib_index + (rx_fib_index >> 8) + (rx_fib_index >> 16) +
3050 (rx_fib_index >> 24);
3052 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
3053 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
3055 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
3058 if (PREDICT_TRUE (!is_output))
3060 nat_elog_debug_handoff (sm, "HANDOFF IN2OUT", next_worker_index,
3062 clib_net_to_host_u32 (ip->src_address.as_u32),
3063 clib_net_to_host_u32 (ip->dst_address.as_u32));
3067 nat_elog_debug_handoff (sm, "HANDOFF IN2OUT-OUTPUT-FEATURE",
3068 next_worker_index, rx_fib_index,
3069 clib_net_to_host_u32 (ip->src_address.as_u32),
3070 clib_net_to_host_u32 (ip->dst_address.as_u32));
3073 return next_worker_index;
3077 nat44_ed_get_out2in_worker_index (vlib_buffer_t *b, ip4_header_t *ip,
3078 u32 rx_fib_index, u8 is_output)
3080 snat_main_t *sm = &snat_main;
3081 clib_bihash_kv_16_8_t kv16, value16;
3083 u8 proto, next_worker_index = 0;
3085 snat_static_mapping_t *m;
3088 proto = ip->protocol;
3090 if (PREDICT_FALSE (IP_PROTOCOL_ICMP == proto))
3092 ip4_address_t lookup_saddr, lookup_daddr;
3093 u16 lookup_sport, lookup_dport;
3095 if (!nat_get_icmp_session_lookup_values (
3096 b, ip, &lookup_saddr, &lookup_sport, &lookup_daddr, &lookup_dport,
3099 init_ed_k (&kv16, lookup_saddr.as_u32, lookup_sport,
3100 lookup_daddr.as_u32, lookup_dport, rx_fib_index,
3103 !clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16)))
3105 next_worker_index = ed_value_get_thread_index (&value16);
3106 nat_elog_debug_handoff (
3107 sm, "HANDOFF OUT2IN (session)", next_worker_index,
3108 rx_fib_index, clib_net_to_host_u32 (ip->src_address.as_u32),
3109 clib_net_to_host_u32 (ip->dst_address.as_u32));
3110 return next_worker_index;
3115 init_ed_k (&kv16, ip->src_address.as_u32,
3116 vnet_buffer (b)->ip.reass.l4_src_port, ip->dst_address.as_u32,
3117 vnet_buffer (b)->ip.reass.l4_dst_port, rx_fib_index,
3121 !clib_bihash_search_16_8 (&sm->flow_hash, &kv16, &value16)))
3123 vnet_buffer2 (b)->nat.cached_session_index =
3124 ed_value_get_session_index (&value16);
3125 next_worker_index = ed_value_get_thread_index (&value16);
3126 nat_elog_debug_handoff (sm, "HANDOFF OUT2IN (session)",
3127 next_worker_index, rx_fib_index,
3128 clib_net_to_host_u32 (ip->src_address.as_u32),
3129 clib_net_to_host_u32 (ip->dst_address.as_u32));
3130 return next_worker_index;
3133 /* first try static mappings without port */
3134 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3136 m = nat44_ed_sm_o2i_lookup (sm, ip->dst_address, 0, 0, proto);
3140 next_worker_index = m->workers[0];
3146 /* unknown protocol */
3147 if (PREDICT_FALSE (nat44_ed_is_unk_proto (proto)))
3149 /* use current thread */
3150 next_worker_index = vlib_get_thread_index ();
3154 port = vnet_buffer (b)->ip.reass.l4_dst_port;
3156 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
3158 udp_header_t *udp = ip4_next_header (ip);
3159 icmp46_header_t *icmp = (icmp46_header_t *) udp;
3160 nat_icmp_echo_header_t *echo = (nat_icmp_echo_header_t *) (icmp + 1);
3161 if (!icmp_type_is_error_message
3162 (vnet_buffer (b)->ip.reass.icmp_type_or_tcp_flags))
3163 port = vnet_buffer (b)->ip.reass.l4_src_port;
3166 /* if error message, then it's not fragmented and we can access it */
3167 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3168 proto = inner_ip->protocol;
3169 void *l4_header = ip4_next_header (inner_ip);
3172 case IP_PROTOCOL_ICMP:
3173 icmp = (icmp46_header_t *) l4_header;
3174 echo = (nat_icmp_echo_header_t *) (icmp + 1);
3175 port = echo->identifier;
3177 case IP_PROTOCOL_UDP:
3179 case IP_PROTOCOL_TCP:
3180 port = ((nat_tcp_udp_header_t *) l4_header)->src_port;
3183 next_worker_index = vlib_get_thread_index ();
3189 /* try static mappings with port */
3190 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
3192 m = nat44_ed_sm_o2i_lookup (sm, ip->dst_address, port, 0, proto);
3195 if (!is_sm_lb (m->flags))
3197 next_worker_index = m->workers[0];
3201 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
3202 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
3204 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
3206 m->workers[hash & (_vec_len (m->workers) - 1)];
3208 next_worker_index = m->workers[hash % _vec_len (m->workers)];
3213 /* worker by outside port */
3214 next_worker_index = get_thread_idx_by_port (clib_net_to_host_u16 (port));
3217 nat_elog_debug_handoff (sm, "HANDOFF OUT2IN", next_worker_index,
3219 clib_net_to_host_u32 (ip->src_address.as_u32),
3220 clib_net_to_host_u32 (ip->dst_address.as_u32));
3221 return next_worker_index;
3225 nat44_get_max_session_limit ()
3227 snat_main_t *sm = &snat_main;
3228 u32 max_limit = 0, len = 0;
3230 for (; len < vec_len (sm->max_translations_per_fib); len++)
3232 if (max_limit < sm->max_translations_per_fib[len])
3233 max_limit = sm->max_translations_per_fib[len];
3239 nat44_set_session_limit (u32 session_limit, u32 vrf_id)
3241 snat_main_t *sm = &snat_main;
3242 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3244 if (~0 == fib_index)
3247 vec_validate_init_empty (sm->max_translations_per_fib, fib_index,
3248 sm->max_translations_per_thread);
3249 sm->max_translations_per_fib[fib_index] = session_limit;
3254 nat44_update_session_limit (u32 session_limit, u32 vrf_id)
3256 snat_main_t *sm = &snat_main;
3258 if (nat44_set_session_limit (session_limit, vrf_id))
3260 sm->max_translations_per_thread = nat44_get_max_session_limit ();
3262 vlib_stats_set_gauge (sm->max_cfg_sessions_gauge,
3263 sm->max_translations_per_thread);
3265 sm->translation_buckets =
3266 nat_calc_bihash_buckets (sm->max_translations_per_thread);
3268 nat44_ed_sessions_clear ();
3273 nat44_ed_worker_db_init (snat_main_per_thread_data_t *tsm, u32 translations)
3277 pool_alloc (tsm->per_vrf_sessions_pool, translations);
3278 pool_alloc (tsm->sessions, translations);
3279 pool_alloc (tsm->lru_pool, translations);
3281 pool_get (tsm->lru_pool, head);
3282 tsm->tcp_trans_lru_head_index = head - tsm->lru_pool;
3283 clib_dlist_init (tsm->lru_pool, tsm->tcp_trans_lru_head_index);
3285 pool_get (tsm->lru_pool, head);
3286 tsm->tcp_estab_lru_head_index = head - tsm->lru_pool;
3287 clib_dlist_init (tsm->lru_pool, tsm->tcp_estab_lru_head_index);
3289 pool_get (tsm->lru_pool, head);
3290 tsm->udp_lru_head_index = head - tsm->lru_pool;
3291 clib_dlist_init (tsm->lru_pool, tsm->udp_lru_head_index);
3293 pool_get (tsm->lru_pool, head);
3294 tsm->icmp_lru_head_index = head - tsm->lru_pool;
3295 clib_dlist_init (tsm->lru_pool, tsm->icmp_lru_head_index);
3297 pool_get (tsm->lru_pool, head);
3298 tsm->unk_proto_lru_head_index = head - tsm->lru_pool;
3299 clib_dlist_init (tsm->lru_pool, tsm->unk_proto_lru_head_index);
3303 nat44_ed_flow_hash_init ()
3305 snat_main_t *sm = &snat_main;
3306 // we expect 2 flows per session, so multiply translation_buckets by 2
3307 clib_bihash_init_16_8 (
3308 &sm->flow_hash, "ed-flow-hash",
3309 clib_max (1, sm->num_workers) * 2 * sm->translation_buckets, 0);
3310 clib_bihash_set_kvp_format_fn_16_8 (&sm->flow_hash, format_ed_session_kvp);
3316 snat_main_t *sm = &snat_main;
3317 snat_main_per_thread_data_t *tsm;
3319 nat44_ed_flow_hash_init ();
3321 vec_foreach (tsm, sm->per_thread_data)
3323 nat44_ed_worker_db_init (tsm, sm->max_translations_per_thread);
3328 nat44_ed_worker_db_free (snat_main_per_thread_data_t *tsm)
3330 pool_free (tsm->lru_pool);
3331 pool_free (tsm->sessions);
3332 pool_free (tsm->per_vrf_sessions_pool);
3336 nat44_ed_flow_hash_free ()
3338 snat_main_t *sm = &snat_main;
3340 clib_bihash_free_16_8 (&sm->flow_hash);
3346 snat_main_t *sm = &snat_main;
3347 snat_main_per_thread_data_t *tsm;
3349 vec_foreach (tsm, sm->per_thread_data)
3351 nat44_ed_worker_db_free (tsm);
3354 nat44_ed_flow_hash_free ();
3358 nat44_ed_sessions_clear ()
3360 snat_main_t *sm = &snat_main;
3362 nat44_ed_db_free ();
3363 nat44_ed_db_init ();
3364 vlib_zero_simple_counter (&sm->total_sessions, 0);
3368 nat44_ed_add_del_static_mapping_cb (ip4_main_t *im, uword opaque,
3369 u32 sw_if_index, ip4_address_t *address,
3370 u32 address_length, u32 if_address_index,
3373 snat_static_mapping_resolve_t *rp;
3374 snat_main_t *sm = &snat_main;
3382 vec_foreach (rp, sm->sm_to_resolve)
3384 if (sw_if_index == rp->sw_if_index)
3388 if (rp->is_resolved)
3390 rv = nat44_ed_del_static_mapping_internal (
3391 rp->l_addr, address[0], rp->l_port, rp->e_port, rp->proto,
3392 rp->vrf_id, rp->flags);
3395 nat_log_err ("ed del static mapping failed");
3399 rp->is_resolved = 0;
3405 if (!rp->is_resolved)
3407 rv = nat44_ed_add_static_mapping_internal (
3408 rp->l_addr, address[0], rp->l_port, rp->e_port, rp->proto,
3409 rp->vrf_id, ~0, rp->flags, rp->pool_addr, rp->tag);
3412 nat_log_err ("ed add static mapping failed");
3416 rp->is_resolved = 1;
3425 nat44_ed_get_addr_resolve_record (u32 sw_if_index, u8 twice_nat, int *out)
3427 snat_main_t *sm = &snat_main;
3428 snat_address_resolve_t *rp;
3431 for (i = 0; i < vec_len (sm->addr_to_resolve); i++)
3433 rp = sm->addr_to_resolve + i;
3435 if ((rp->sw_if_index == sw_if_index) && (rp->is_twice_nat == twice_nat))
3447 nat44_ed_del_addr_resolve_record (u32 sw_if_index, u8 twice_nat)
3449 snat_main_t *sm = &snat_main;
3451 if (!nat44_ed_get_addr_resolve_record (sw_if_index, twice_nat, &i))
3453 vec_del1 (sm->addr_to_resolve, i);
3460 nat44_ed_add_del_interface_address_cb (ip4_main_t *im, uword opaque,
3461 u32 sw_if_index, ip4_address_t *address,
3463 u32 if_address_index, u32 is_delete)
3465 snat_main_t *sm = &snat_main;
3466 snat_address_resolve_t *arp;
3476 if (nat44_ed_get_addr_resolve_record (sw_if_index, twice_nat, &i))
3479 if (nat44_ed_get_addr_resolve_record (sw_if_index, twice_nat, &i))
3482 ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
3483 vec_foreach (ap, sm->addresses)
3485 if ((fib_index == ap->fib_index) &&
3486 (address->as_u32 == ap->addr.as_u32))
3490 ap->addr_len = address_length;
3491 ap->sw_if_index = sw_if_index;
3493 ap->addr.as_u32 & ip4_main.fib_masks[ap->addr_len];
3496 "pool addr %U binds to -> sw_if_idx: %u net: %U/%u",
3497 format_ip4_address, &ap->addr, ap->sw_if_index,
3498 format_ip4_address, &ap->net, ap->addr_len);
3511 arp = sm->addr_to_resolve + i;
3515 if (arp->is_resolved)
3520 rv = nat44_ed_add_address (address, ~0, arp->is_twice_nat);
3523 arp->is_resolved = 1;
3528 if (!arp->is_resolved)
3533 rv = nat44_ed_del_address (address[0], arp->is_twice_nat);
3536 arp->is_resolved = 0;
3542 nat44_ed_add_interface_address (u32 sw_if_index, u8 twice_nat)
3544 snat_main_t *sm = &snat_main;
3545 ip4_main_t *ip4_main = sm->ip4_main;
3546 ip4_address_t *first_int_addr;
3547 snat_address_resolve_t *ap;
3552 nat_log_err ("nat44 is disabled");
3553 return VNET_API_ERROR_UNSUPPORTED;
3556 if (!nat44_ed_get_addr_resolve_record (sw_if_index, twice_nat, 0))
3558 return VNET_API_ERROR_VALUE_EXIST;
3561 vec_add2 (sm->addr_to_resolve, ap, 1);
3562 ap->sw_if_index = sw_if_index;
3563 ap->is_twice_nat = twice_nat;
3564 ap->is_resolved = 0;
3566 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0);
3569 rv = nat44_ed_add_address (first_int_addr, ~0, twice_nat);
3572 nat44_ed_del_addr_resolve_record (sw_if_index, twice_nat);
3575 ap->is_resolved = 1;
3582 nat44_ed_del_interface_address (u32 sw_if_index, u8 twice_nat)
3584 snat_main_t *sm = &snat_main;
3585 ip4_main_t *ip4_main = sm->ip4_main;
3586 ip4_address_t *first_int_addr;
3590 nat_log_err ("nat44 is disabled");
3591 return VNET_API_ERROR_UNSUPPORTED;
3594 if (nat44_ed_del_addr_resolve_record (sw_if_index, twice_nat))
3596 return VNET_API_ERROR_NO_SUCH_ENTRY;
3599 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0);
3602 return nat44_ed_del_address (first_int_addr[0], twice_nat);
3609 nat44_ed_del_session (snat_main_t *sm, ip4_address_t *addr, u16 port,
3610 ip4_address_t *eh_addr, u16 eh_port, u8 proto,
3611 u32 vrf_id, int is_in)
3614 clib_bihash_kv_16_8_t kv, value;
3617 snat_main_per_thread_data_t *tsm;
3621 return VNET_API_ERROR_UNSUPPORTED;
3624 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3625 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
3626 if (sm->num_workers > 1)
3627 tsm = vec_elt_at_index (
3628 sm->per_thread_data,
3629 nat44_ed_get_in2out_worker_index (0, &ip, fib_index, 0));
3631 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
3633 init_ed_k (&kv, addr->as_u32, port, eh_addr->as_u32, eh_port, fib_index,
3635 if (clib_bihash_search_16_8 (&sm->flow_hash, &kv, &value))
3637 return VNET_API_ERROR_NO_SUCH_ENTRY;
3640 if (pool_is_free_index (tsm->sessions, ed_value_get_session_index (&value)))
3641 return VNET_API_ERROR_UNSPECIFIED;
3642 s = pool_elt_at_index (tsm->sessions, ed_value_get_session_index (&value));
3643 nat44_ed_free_session_data (sm, s, tsm - sm->per_thread_data, 0);
3644 nat_ed_session_delete (sm, s, tsm - sm->per_thread_data, 1);
3648 VLIB_NODE_FN (nat_default_node) (vlib_main_t * vm,
3649 vlib_node_runtime_t * node,
3650 vlib_frame_t * frame)
3655 VLIB_REGISTER_NODE (nat_default_node) = {
3656 .name = "nat-default",
3657 .vector_size = sizeof (u32),
3659 .type = VLIB_NODE_TYPE_INTERNAL,
3661 .n_next_nodes = NAT_N_NEXT,
3663 [NAT_NEXT_DROP] = "error-drop",
3664 [NAT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
3665 [NAT_NEXT_IN2OUT_ED_FAST_PATH] = "nat44-ed-in2out",
3666 [NAT_NEXT_IN2OUT_ED_SLOW_PATH] = "nat44-ed-in2out-slowpath",
3667 [NAT_NEXT_IN2OUT_ED_OUTPUT_FAST_PATH] = "nat44-ed-in2out-output",
3668 [NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH] = "nat44-ed-in2out-output-slowpath",
3669 [NAT_NEXT_OUT2IN_ED_FAST_PATH] = "nat44-ed-out2in",
3670 [NAT_NEXT_OUT2IN_ED_SLOW_PATH] = "nat44-ed-out2in-slowpath",
3671 [NAT_NEXT_IN2OUT_CLASSIFY] = "nat44-in2out-worker-handoff",
3672 [NAT_NEXT_OUT2IN_CLASSIFY] = "nat44-out2in-worker-handoff",
3677 nat_6t_l3_l4_csum_calc (nat_6t_flow_t *f)
3679 f->l3_csum_delta = 0;
3680 f->l4_csum_delta = 0;
3681 if (f->ops & NAT_FLOW_OP_SADDR_REWRITE &&
3682 f->rewrite.saddr.as_u32 != f->match.saddr.as_u32)
3685 ip_csum_add_even (f->l3_csum_delta, f->rewrite.saddr.as_u32);
3687 ip_csum_sub_even (f->l3_csum_delta, f->match.saddr.as_u32);
3691 f->rewrite.saddr.as_u32 = f->match.saddr.as_u32;
3693 if (f->ops & NAT_FLOW_OP_DADDR_REWRITE &&
3694 f->rewrite.daddr.as_u32 != f->match.daddr.as_u32)
3697 ip_csum_add_even (f->l3_csum_delta, f->rewrite.daddr.as_u32);
3699 ip_csum_sub_even (f->l3_csum_delta, f->match.daddr.as_u32);
3703 f->rewrite.daddr.as_u32 = f->match.daddr.as_u32;
3705 if (f->ops & NAT_FLOW_OP_SPORT_REWRITE && f->rewrite.sport != f->match.sport)
3707 f->l4_csum_delta = ip_csum_add_even (f->l4_csum_delta, f->rewrite.sport);
3708 f->l4_csum_delta = ip_csum_sub_even (f->l4_csum_delta, f->match.sport);
3712 f->rewrite.sport = f->match.sport;
3714 if (f->ops & NAT_FLOW_OP_DPORT_REWRITE && f->rewrite.dport != f->match.dport)
3716 f->l4_csum_delta = ip_csum_add_even (f->l4_csum_delta, f->rewrite.dport);
3717 f->l4_csum_delta = ip_csum_sub_even (f->l4_csum_delta, f->match.dport);
3721 f->rewrite.dport = f->match.dport;
3723 if (f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE &&
3724 f->rewrite.icmp_id != f->match.sport)
3727 ip_csum_add_even (f->l4_csum_delta, f->rewrite.icmp_id);
3728 f->l4_csum_delta = ip_csum_sub_even (f->l4_csum_delta, f->match.sport);
3732 f->rewrite.icmp_id = f->match.sport;
3734 if (f->ops & NAT_FLOW_OP_TXFIB_REWRITE)
3739 f->rewrite.fib_index = f->match.fib_index;
3743 static_always_inline int
3744 nat_6t_flow_icmp_translate (vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b,
3745 ip4_header_t *ip, nat_6t_flow_t *f);
3747 static_always_inline void
3748 nat_6t_flow_ip4_translate (snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip,
3749 nat_6t_flow_t *f, ip_protocol_t proto,
3750 int is_icmp_inner_ip4, int skip_saddr_rewrite)
3752 udp_header_t *udp = ip4_next_header (ip);
3753 tcp_header_t *tcp = (tcp_header_t *) udp;
3755 if ((IP_PROTOCOL_TCP == proto || IP_PROTOCOL_UDP == proto) &&
3756 !vnet_buffer (b)->ip.reass.is_non_first_fragment)
3758 if (!is_icmp_inner_ip4)
3760 ip->src_address = f->rewrite.saddr;
3761 ip->dst_address = f->rewrite.daddr;
3762 udp->src_port = f->rewrite.sport;
3763 udp->dst_port = f->rewrite.dport;
3766 { // icmp inner ip4 - reversed saddr/daddr
3767 ip->src_address = f->rewrite.daddr;
3768 ip->dst_address = f->rewrite.saddr;
3769 udp->src_port = f->rewrite.dport;
3770 udp->dst_port = f->rewrite.sport;
3773 if (IP_PROTOCOL_TCP == proto)
3775 ip_csum_t tcp_sum = tcp->checksum;
3776 tcp_sum = ip_csum_sub_even (tcp_sum, f->l3_csum_delta);
3777 tcp_sum = ip_csum_sub_even (tcp_sum, f->l4_csum_delta);
3778 mss_clamping (sm->mss_clamping, tcp, &tcp_sum);
3779 tcp->checksum = ip_csum_fold (tcp_sum);
3781 else if (IP_PROTOCOL_UDP == proto && udp->checksum)
3783 ip_csum_t udp_sum = udp->checksum;
3784 udp_sum = ip_csum_sub_even (udp_sum, f->l3_csum_delta);
3785 udp_sum = ip_csum_sub_even (udp_sum, f->l4_csum_delta);
3786 udp->checksum = ip_csum_fold (udp_sum);
3791 if (!is_icmp_inner_ip4)
3793 if (!skip_saddr_rewrite)
3795 ip->src_address = f->rewrite.saddr;
3797 ip->dst_address = f->rewrite.daddr;
3800 { // icmp inner ip4 - reversed saddr/daddr
3801 ip->src_address = f->rewrite.daddr;
3802 ip->dst_address = f->rewrite.saddr;
3806 if (skip_saddr_rewrite)
3808 ip->checksum = ip4_header_checksum (ip);
3812 ip_csum_t ip_sum = ip->checksum;
3813 ip_sum = ip_csum_sub_even (ip_sum, f->l3_csum_delta);
3814 ip->checksum = ip_csum_fold (ip_sum);
3816 if (0xffff == ip->checksum)
3818 ASSERT (ip4_header_checksum_is_valid (ip));
3821 static_always_inline int
3822 it_fits (vlib_main_t *vm, vlib_buffer_t *b, void *object, size_t size)
3824 int result = ((u8 *) object + size <=
3825 (u8 *) vlib_buffer_get_current (b) + b->current_length) &&
3826 vlib_object_within_buffer_data (vm, b, object, size);
3830 static_always_inline int
3831 nat_6t_flow_icmp_translate (vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b,
3832 ip4_header_t *ip, nat_6t_flow_t *f)
3834 if (IP_PROTOCOL_ICMP != ip->protocol)
3835 return NAT_ED_TRNSL_ERR_TRANSLATION_FAILED;
3837 icmp46_header_t *icmp = ip4_next_header (ip);
3838 nat_icmp_echo_header_t *echo = (nat_icmp_echo_header_t *) (icmp + 1);
3840 if ((!vnet_buffer (b)->ip.reass.is_non_first_fragment))
3842 if (!it_fits (vm, b, icmp, sizeof (*icmp)))
3844 return NAT_ED_TRNSL_ERR_PACKET_TRUNCATED;
3847 if (!icmp_type_is_error_message (icmp->type))
3849 if ((f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE) &&
3850 (f->rewrite.icmp_id != echo->identifier))
3852 ip_csum_t sum = icmp->checksum;
3853 sum = ip_csum_update (sum, echo->identifier, f->rewrite.icmp_id,
3854 nat_icmp_echo_header_t,
3855 identifier /* changed member */);
3856 echo->identifier = f->rewrite.icmp_id;
3857 icmp->checksum = ip_csum_fold (sum);
3862 ip_csum_t sum = ip_incremental_checksum (
3864 clib_net_to_host_u16 (ip->length) - ip4_header_bytes (ip));
3865 sum = (u16) ~ip_csum_fold (sum);
3868 return NAT_ED_TRNSL_ERR_INVALID_CSUM;
3871 // errors are not fragmented
3872 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
3874 if (!ip4_header_checksum_is_valid (inner_ip))
3876 return NAT_ED_TRNSL_ERR_INNER_IP_CORRUPT;
3879 ip_protocol_t inner_proto = inner_ip->protocol;
3881 ip_csum_t old_icmp_sum = icmp->checksum;
3882 ip_csum_t old_inner_ip_sum = inner_ip->checksum;
3883 ip_csum_t old_udp_sum;
3884 ip_csum_t old_tcp_sum;
3885 ip_csum_t new_icmp_sum;
3889 switch (inner_proto)
3891 case IP_PROTOCOL_UDP:
3892 udp = (udp_header_t *) (inner_ip + 1);
3893 if (!it_fits (vm, b, udp, sizeof (*udp)))
3895 return NAT_ED_TRNSL_ERR_PACKET_TRUNCATED;
3897 old_udp_sum = udp->checksum;
3898 nat_6t_flow_ip4_translate (sm, b, inner_ip, f, inner_proto,
3899 1 /* is_icmp_inner_ip4 */,
3900 0 /* skip_saddr_rewrite */);
3901 new_icmp_sum = ip_csum_sub_even (old_icmp_sum, f->l3_csum_delta);
3902 new_icmp_sum = ip_csum_sub_even (new_icmp_sum, f->l4_csum_delta);
3904 ip_csum_update (new_icmp_sum, old_inner_ip_sum,
3905 inner_ip->checksum, ip4_header_t, checksum);
3907 ip_csum_update (new_icmp_sum, old_udp_sum, udp->checksum,
3908 udp_header_t, checksum);
3909 new_icmp_sum = ip_csum_fold (new_icmp_sum);
3910 icmp->checksum = new_icmp_sum;
3912 case IP_PROTOCOL_TCP:
3913 tcp = (tcp_header_t *) (inner_ip + 1);
3914 if (!it_fits (vm, b, tcp, sizeof (*tcp)))
3916 return NAT_ED_TRNSL_ERR_PACKET_TRUNCATED;
3918 old_tcp_sum = tcp->checksum;
3919 nat_6t_flow_ip4_translate (sm, b, inner_ip, f, inner_proto,
3920 1 /* is_icmp_inner_ip4 */,
3921 0 /* skip_saddr_rewrite */);
3922 new_icmp_sum = ip_csum_sub_even (old_icmp_sum, f->l3_csum_delta);
3923 new_icmp_sum = ip_csum_sub_even (new_icmp_sum, f->l4_csum_delta);
3925 ip_csum_update (new_icmp_sum, old_inner_ip_sum,
3926 inner_ip->checksum, ip4_header_t, checksum);
3928 ip_csum_update (new_icmp_sum, old_tcp_sum, tcp->checksum,
3929 tcp_header_t, checksum);
3930 new_icmp_sum = ip_csum_fold (new_icmp_sum);
3931 icmp->checksum = new_icmp_sum;
3933 case IP_PROTOCOL_ICMP:
3934 nat_6t_flow_ip4_translate (sm, b, inner_ip, f, inner_proto,
3935 1 /* is_icmp_inner_ip4 */,
3936 0 /* skip_saddr_rewrite */);
3937 if (f->ops & NAT_FLOW_OP_ICMP_ID_REWRITE)
3939 icmp46_header_t *inner_icmp = ip4_next_header (inner_ip);
3940 if (!it_fits (vm, b, inner_icmp, sizeof (*inner_icmp)))
3942 return NAT_ED_TRNSL_ERR_PACKET_TRUNCATED;
3944 nat_icmp_echo_header_t *inner_echo =
3945 (nat_icmp_echo_header_t *) (inner_icmp + 1);
3946 if (f->rewrite.icmp_id != inner_echo->identifier)
3948 ip_csum_t sum = icmp->checksum;
3949 sum = ip_csum_update (sum, inner_echo->identifier,
3951 nat_icmp_echo_header_t,
3952 identifier /* changed member */);
3953 icmp->checksum = ip_csum_fold (sum);
3954 ip_csum_t inner_sum = inner_icmp->checksum;
3955 inner_sum = ip_csum_update (
3956 sum, inner_echo->identifier, f->rewrite.icmp_id,
3957 nat_icmp_echo_header_t,
3958 identifier /* changed member */);
3959 inner_icmp->checksum = ip_csum_fold (inner_sum);
3960 inner_echo->identifier = f->rewrite.icmp_id;
3965 clib_warning ("unexpected NAT protocol value `%d'", inner_proto);
3966 return NAT_ED_TRNSL_ERR_TRANSLATION_FAILED;
3971 return NAT_ED_TRNSL_ERR_SUCCESS;
3974 static_always_inline nat_translation_error_e
3975 nat_6t_flow_buf_translate (vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b,
3976 ip4_header_t *ip, nat_6t_flow_t *f,
3977 ip_protocol_t proto, int is_output_feature,
3980 if (!is_output_feature && f->ops & NAT_FLOW_OP_TXFIB_REWRITE)
3982 vnet_buffer (b)->sw_if_index[VLIB_TX] = f->rewrite.fib_index;
3985 if (IP_PROTOCOL_ICMP == proto)
3987 if (ip->src_address.as_u32 != f->rewrite.saddr.as_u32)
3989 // packet is returned from a router, not from destination
3990 // skip source address rewrite if in o2i path
3991 nat_6t_flow_ip4_translate (sm, b, ip, f, proto,
3992 0 /* is_icmp_inner_ip4 */,
3993 !is_i2o /* skip_saddr_rewrite */);
3997 nat_6t_flow_ip4_translate (sm, b, ip, f, proto,
3998 0 /* is_icmp_inner_ip4 */,
3999 0 /* skip_saddr_rewrite */);
4001 return nat_6t_flow_icmp_translate (vm, sm, b, ip, f);
4004 nat_6t_flow_ip4_translate (sm, b, ip, f, proto, 0 /* is_icmp_inner_ip4 */,
4005 0 /* skip_saddr_rewrite */);
4007 return NAT_ED_TRNSL_ERR_SUCCESS;
4010 nat_translation_error_e
4011 nat_6t_flow_buf_translate_i2o (vlib_main_t *vm, snat_main_t *sm,
4012 vlib_buffer_t *b, ip4_header_t *ip,
4013 nat_6t_flow_t *f, ip_protocol_t proto,
4014 int is_output_feature)
4016 return nat_6t_flow_buf_translate (vm, sm, b, ip, f, proto, is_output_feature,
4020 nat_translation_error_e
4021 nat_6t_flow_buf_translate_o2i (vlib_main_t *vm, snat_main_t *sm,
4022 vlib_buffer_t *b, ip4_header_t *ip,
4023 nat_6t_flow_t *f, ip_protocol_t proto,
4024 int is_output_feature)
4026 return nat_6t_flow_buf_translate (vm, sm, b, ip, f, proto, is_output_feature,
4030 static_always_inline void
4031 nat_syslog_nat44_sess (u32 ssubix, u32 sfibix, ip4_address_t *isaddr,
4032 u16 isport, ip4_address_t *xsaddr, u16 xsport,
4033 ip4_address_t *idaddr, u16 idport,
4034 ip4_address_t *xdaddr, u16 xdport, u8 proto, u8 is_add,
4037 syslog_msg_t syslog_msg;
4040 if (!syslog_is_enabled ())
4043 if (syslog_severity_filter_block (SADD_SDEL_SEVERITY))
4046 fib = fib_table_get (sfibix, FIB_PROTOCOL_IP4);
4048 syslog_msg_init (&syslog_msg, NAT_FACILITY, SADD_SDEL_SEVERITY, NAT_APPNAME,
4049 is_add ? SADD_MSGID : SDEL_MSGID);
4051 syslog_msg_sd_init (&syslog_msg, NSESS_SDID);
4052 syslog_msg_add_sd_param (&syslog_msg, SSUBIX_SDPARAM_NAME, "%d", ssubix);
4053 syslog_msg_add_sd_param (&syslog_msg, SVLAN_SDPARAM_NAME, "%d",
4055 syslog_msg_add_sd_param (&syslog_msg, IATYP_SDPARAM_NAME, IATYP_IPV4);
4056 syslog_msg_add_sd_param (&syslog_msg, ISADDR_SDPARAM_NAME, "%U",
4057 format_ip4_address, isaddr);
4058 syslog_msg_add_sd_param (&syslog_msg, ISPORT_SDPARAM_NAME, "%d",
4059 clib_net_to_host_u16 (isport));
4060 syslog_msg_add_sd_param (&syslog_msg, XATYP_SDPARAM_NAME, IATYP_IPV4);
4061 syslog_msg_add_sd_param (&syslog_msg, XSADDR_SDPARAM_NAME, "%U",
4062 format_ip4_address, xsaddr);
4063 syslog_msg_add_sd_param (&syslog_msg, XSPORT_SDPARAM_NAME, "%d",
4064 clib_net_to_host_u16 (xsport));
4065 syslog_msg_add_sd_param (&syslog_msg, PROTO_SDPARAM_NAME, "%d", proto);
4066 syslog_msg_add_sd_param (&syslog_msg, XDADDR_SDPARAM_NAME, "%U",
4067 format_ip4_address, xdaddr);
4068 syslog_msg_add_sd_param (&syslog_msg, XDPORT_SDPARAM_NAME, "%d",
4069 clib_net_to_host_u16 (xdport));
4072 syslog_msg_add_sd_param (&syslog_msg, IDADDR_SDPARAM_NAME, "%U",
4073 format_ip4_address, idaddr);
4074 syslog_msg_add_sd_param (&syslog_msg, IDPORT_SDPARAM_NAME, "%d",
4075 clib_net_to_host_u16 (idport));
4078 syslog_msg_send (&syslog_msg);
4082 nat_syslog_nat44_sadd (u32 ssubix, u32 sfibix, ip4_address_t *isaddr,
4083 u16 isport, ip4_address_t *idaddr, u16 idport,
4084 ip4_address_t *xsaddr, u16 xsport,
4085 ip4_address_t *xdaddr, u16 xdport, u8 proto,
4088 nat_syslog_nat44_sess (ssubix, sfibix, isaddr, isport, xsaddr, xsport,
4089 idaddr, idport, xdaddr, xdport, proto, 1,
4094 nat_syslog_nat44_sdel (u32 ssubix, u32 sfibix, ip4_address_t *isaddr,
4095 u16 isport, ip4_address_t *idaddr, u16 idport,
4096 ip4_address_t *xsaddr, u16 xsport,
4097 ip4_address_t *xdaddr, u16 xdport, u8 proto,
4100 nat_syslog_nat44_sess (ssubix, sfibix, isaddr, isport, xsaddr, xsport,
4101 idaddr, idport, xdaddr, xdport, proto, 0,
4105 nat44_original_dst_lookup (ip4_address_t *i2o_src, u16 i2o_src_port,
4106 ip4_address_t *i2o_dst, u16 i2o_dst_port,
4107 ip_protocol_t proto, u32 *original_dst,
4108 u16 *original_dst_port)
4110 snat_main_per_thread_data_t *tsm;
4111 snat_main_t *sm = &snat_main;
4116 ip.src_address.as_u32 = i2o_src->as_u32;
4117 fib_index = fib_table_find (FIB_PROTOCOL_IP4, 0);
4119 if (sm->num_workers > 1)
4121 tsm = vec_elt_at_index (
4122 sm->per_thread_data,
4123 nat44_ed_get_in2out_worker_index (0, &ip, fib_index, 0));
4127 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
4131 clib_bihash_kv_16_8_t kv = { 0 }, value;
4132 init_ed_k (&kv, i2o_src->as_u32, i2o_src_port, i2o_dst->as_u32, i2o_dst_port,
4134 if (tsm->sessions == NULL ||
4135 clib_bihash_search_16_8 (&sm->flow_hash, &kv, &value))
4139 s = pool_elt_at_index (tsm->sessions, ed_value_get_session_index (&value));
4142 *original_dst = s->i2o.rewrite.saddr.as_u32;
4143 *original_dst_port = s->i2o.rewrite.sport;
4148 * fd.io coding-style-patch-verification: ON
4151 * eval: (c-set-style "gnu")