2 * snat.c - simple nat plugin
4 * Copyright (c) 2016 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vnet/vnet.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/ip/ip4.h>
21 #include <vnet/plugin/plugin.h>
23 #include <nat/nat_dpo.h>
24 #include <nat/nat_ipfix_logging.h>
25 #include <nat/nat_det.h>
26 #include <nat/nat64.h>
27 #include <nat/nat66.h>
28 #include <nat/dslite.h>
29 #include <nat/nat_reass.h>
30 #include <nat/nat_inlines.h>
31 #include <nat/nat_affinity.h>
32 #include <nat/nat_syslog.h>
33 #include <vnet/fib/fib_table.h>
34 #include <vnet/fib/ip4_fib.h>
36 #include <vpp/app/version.h>
38 snat_main_t snat_main;
42 /* Hook up input features */
43 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
44 .arc_name = "ip4-unicast",
45 .node_name = "nat44-in2out",
46 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
48 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
49 .arc_name = "ip4-unicast",
50 .node_name = "nat44-out2in",
51 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
52 "ip4-dhcp-client-detect"),
54 VNET_FEATURE_INIT (ip4_nat_classify, static) = {
55 .arc_name = "ip4-unicast",
56 .node_name = "nat44-classify",
57 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
59 VNET_FEATURE_INIT (ip4_snat_det_in2out, static) = {
60 .arc_name = "ip4-unicast",
61 .node_name = "nat44-det-in2out",
62 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
64 VNET_FEATURE_INIT (ip4_snat_det_out2in, static) = {
65 .arc_name = "ip4-unicast",
66 .node_name = "nat44-det-out2in",
67 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
68 "ip4-dhcp-client-detect"),
70 VNET_FEATURE_INIT (ip4_nat_det_classify, static) = {
71 .arc_name = "ip4-unicast",
72 .node_name = "nat44-det-classify",
73 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
75 VNET_FEATURE_INIT (ip4_nat44_ed_in2out, static) = {
76 .arc_name = "ip4-unicast",
77 .node_name = "nat44-ed-in2out",
78 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
80 VNET_FEATURE_INIT (ip4_nat44_ed_out2in, static) = {
81 .arc_name = "ip4-unicast",
82 .node_name = "nat44-ed-out2in",
83 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
84 "ip4-dhcp-client-detect"),
86 VNET_FEATURE_INIT (ip4_nat44_ed_classify, static) = {
87 .arc_name = "ip4-unicast",
88 .node_name = "nat44-ed-classify",
89 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
91 VNET_FEATURE_INIT (ip4_snat_in2out_worker_handoff, static) = {
92 .arc_name = "ip4-unicast",
93 .node_name = "nat44-in2out-worker-handoff",
94 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
96 VNET_FEATURE_INIT (ip4_snat_out2in_worker_handoff, static) = {
97 .arc_name = "ip4-unicast",
98 .node_name = "nat44-out2in-worker-handoff",
99 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
100 "ip4-dhcp-client-detect"),
102 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
103 .arc_name = "ip4-unicast",
104 .node_name = "nat44-handoff-classify",
105 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
107 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
108 .arc_name = "ip4-unicast",
109 .node_name = "nat44-in2out-fast",
110 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
112 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
113 .arc_name = "ip4-unicast",
114 .node_name = "nat44-out2in-fast",
115 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa",
116 "ip4-dhcp-client-detect"),
118 VNET_FEATURE_INIT (ip4_snat_hairpin_dst, static) = {
119 .arc_name = "ip4-unicast",
120 .node_name = "nat44-hairpin-dst",
121 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
123 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_dst, static) = {
124 .arc_name = "ip4-unicast",
125 .node_name = "nat44-ed-hairpin-dst",
126 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
129 /* Hook up output features */
130 VNET_FEATURE_INIT (ip4_snat_in2out_output, static) = {
131 .arc_name = "ip4-output",
132 .node_name = "nat44-in2out-output",
133 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
135 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
136 .arc_name = "ip4-output",
137 .node_name = "nat44-in2out-output-worker-handoff",
138 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
140 VNET_FEATURE_INIT (ip4_snat_hairpin_src, static) = {
141 .arc_name = "ip4-output",
142 .node_name = "nat44-hairpin-src",
143 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
145 VNET_FEATURE_INIT (ip4_nat44_ed_in2out_output, static) = {
146 .arc_name = "ip4-output",
147 .node_name = "nat44-ed-in2out-output",
148 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
150 VNET_FEATURE_INIT (ip4_nat44_ed_hairpin_src, static) = {
151 .arc_name = "ip4-output",
152 .node_name = "nat44-ed-hairpin-src",
153 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
156 /* Hook up ip4-local features */
157 VNET_FEATURE_INIT (ip4_nat_hairpinning, static) =
159 .arc_name = "ip4-local",
160 .node_name = "nat44-hairpinning",
161 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
163 VNET_FEATURE_INIT (ip4_nat44_ed_hairpinning, static) =
165 .arc_name = "ip4-local",
166 .node_name = "nat44-ed-hairpinning",
167 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
171 VLIB_PLUGIN_REGISTER () = {
172 .version = VPP_BUILD_VER,
173 .description = "Network Address Translation",
178 nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index)
180 snat_session_key_t key;
181 clib_bihash_kv_8_8_t kv;
182 nat_ed_ses_key_t ed_key;
183 clib_bihash_kv_16_8_t ed_kv;
184 snat_main_per_thread_data_t *tsm =
185 vec_elt_at_index (sm->per_thread_data, thread_index);
187 if (is_fwd_bypass_session (s))
189 ed_key.l_addr = s->in2out.addr;
190 ed_key.r_addr = s->ext_host_addr;
191 ed_key.l_port = s->in2out.port;
192 ed_key.r_port = s->ext_host_port;
193 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
194 ed_key.fib_index = 0;
195 ed_kv.key[0] = ed_key.as_u64[0];
196 ed_kv.key[1] = ed_key.as_u64[1];
197 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
198 nat_log_warn ("in2out_ed key del failed");
202 /* session lookup tables */
203 if (is_ed_session (s))
205 if (is_affinity_sessions (s))
206 nat_affinity_unlock (s->ext_host_addr, s->out2in.addr,
207 s->in2out.protocol, s->out2in.port);
208 ed_key.l_addr = s->out2in.addr;
209 ed_key.r_addr = s->ext_host_addr;
210 ed_key.fib_index = s->out2in.fib_index;
211 if (snat_is_unk_proto_session (s))
213 ed_key.proto = s->in2out.port;
219 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
220 ed_key.l_port = s->out2in.port;
221 ed_key.r_port = s->ext_host_port;
223 ed_kv.key[0] = ed_key.as_u64[0];
224 ed_kv.key[1] = ed_key.as_u64[1];
225 if (clib_bihash_add_del_16_8 (&tsm->out2in_ed, &ed_kv, 0))
226 nat_log_warn ("out2in_ed key del failed");
227 ed_key.l_addr = s->in2out.addr;
228 ed_key.fib_index = s->in2out.fib_index;
229 if (!snat_is_unk_proto_session (s))
230 ed_key.l_port = s->in2out.port;
231 if (is_twice_nat_session (s))
233 ed_key.r_addr = s->ext_host_nat_addr;
234 ed_key.r_port = s->ext_host_nat_port;
236 ed_kv.key[0] = ed_key.as_u64[0];
237 ed_kv.key[1] = ed_key.as_u64[1];
238 if (clib_bihash_add_del_16_8 (&tsm->in2out_ed, &ed_kv, 0))
239 nat_log_warn ("in2out_ed key del failed");
241 nat_syslog_nat44_sdel (s->user_index, s->in2out.fib_index,
242 &s->in2out.addr, s->in2out.port,
243 &s->ext_host_nat_addr, s->ext_host_nat_port,
244 &s->out2in.addr, s->out2in.port,
245 &s->ext_host_addr, s->ext_host_port,
246 s->in2out.protocol, is_twice_nat_session (s));
250 kv.key = s->in2out.as_u64;
251 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0))
252 nat_log_warn ("in2out key del failed");
253 kv.key = s->out2in.as_u64;
254 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0))
255 nat_log_warn ("out2in key del failed");
257 nat_syslog_nat44_apmdel (s->user_index, s->in2out.fib_index,
258 &s->in2out.addr, s->in2out.port,
259 &s->out2in.addr, s->out2in.port,
263 if (snat_is_unk_proto_session (s))
267 snat_ipfix_logging_nat44_ses_delete (s->in2out.addr.as_u32,
268 s->out2in.addr.as_u32,
271 s->out2in.port, s->in2out.fib_index);
273 /* Twice NAT address and port for external host */
274 if (is_twice_nat_session (s))
276 key.protocol = s->in2out.protocol;
277 key.port = s->ext_host_nat_port;
278 key.addr.as_u32 = s->ext_host_nat_addr.as_u32;
279 snat_free_outside_address_and_port (sm->twice_nat_addresses,
283 if (snat_is_session_static (s))
286 snat_free_outside_address_and_port (sm->addresses, thread_index,
291 nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr, u32 fib_index,
295 snat_user_key_t user_key;
296 clib_bihash_kv_8_8_t kv, value;
297 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
298 dlist_elt_t *per_user_list_head_elt;
300 user_key.addr.as_u32 = addr->as_u32;
301 user_key.fib_index = fib_index;
302 kv.key = user_key.as_u64;
304 /* Ever heard of the "user" = src ip4 address before? */
305 if (clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
307 /* no, make a new one */
308 pool_get (tsm->users, u);
309 clib_memset (u, 0, sizeof (*u));
310 u->addr.as_u32 = addr->as_u32;
311 u->fib_index = fib_index;
313 pool_get (tsm->list_pool, per_user_list_head_elt);
315 u->sessions_per_user_list_head_index = per_user_list_head_elt -
318 clib_dlist_init (tsm->list_pool, u->sessions_per_user_list_head_index);
320 kv.value = u - tsm->users;
323 if (clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 1))
324 nat_log_warn ("user_hash keay add failed");
326 vlib_set_simple_counter (&sm->total_users, thread_index, 0,
327 pool_elts (tsm->users));
331 u = pool_elt_at_index (tsm->users, value.value);
338 nat_session_alloc_or_recycle (snat_main_t * sm, snat_user_t * u,
342 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
343 u32 oldest_per_user_translation_list_index, session_index;
344 dlist_elt_t *oldest_per_user_translation_list_elt;
345 dlist_elt_t *per_user_translation_list_elt;
347 /* Over quota? Recycle the least recently used translation */
348 if ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user)
350 oldest_per_user_translation_list_index =
351 clib_dlist_remove_head (tsm->list_pool,
352 u->sessions_per_user_list_head_index);
354 ASSERT (oldest_per_user_translation_list_index != ~0);
356 /* Add it back to the end of the LRU list */
357 clib_dlist_addtail (tsm->list_pool,
358 u->sessions_per_user_list_head_index,
359 oldest_per_user_translation_list_index);
360 /* Get the list element */
361 oldest_per_user_translation_list_elt =
362 pool_elt_at_index (tsm->list_pool,
363 oldest_per_user_translation_list_index);
365 /* Get the session index from the list element */
366 session_index = oldest_per_user_translation_list_elt->value;
368 /* Get the session */
369 s = pool_elt_at_index (tsm->sessions, session_index);
370 nat_free_session_data (sm, s, thread_index);
371 if (snat_is_session_static (s))
372 u->nstaticsessions--;
379 s->ext_host_addr.as_u32 = 0;
380 s->ext_host_port = 0;
381 s->ext_host_nat_addr.as_u32 = 0;
382 s->ext_host_nat_port = 0;
386 pool_get (tsm->sessions, s);
387 clib_memset (s, 0, sizeof (*s));
389 /* Create list elts */
390 pool_get (tsm->list_pool, per_user_translation_list_elt);
391 clib_dlist_init (tsm->list_pool,
392 per_user_translation_list_elt - tsm->list_pool);
394 per_user_translation_list_elt->value = s - tsm->sessions;
395 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
396 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
398 clib_dlist_addtail (tsm->list_pool,
399 s->per_user_list_head_index,
400 per_user_translation_list_elt - tsm->list_pool);
402 s->user_index = u - tsm->users;
403 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
404 pool_elts (tsm->sessions));
411 nat_ed_session_alloc (snat_main_t * sm, snat_user_t * u, u32 thread_index,
415 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
416 dlist_elt_t *per_user_translation_list_elt, *oldest_elt;
418 u64 sess_timeout_time;
420 if (PREDICT_FALSE (!(u->nsessions) && !(u->nstaticsessions)))
424 clib_dlist_remove_head (tsm->list_pool,
425 u->sessions_per_user_list_head_index);
426 oldest_elt = pool_elt_at_index (tsm->list_pool, oldest_index);
427 s = pool_elt_at_index (tsm->sessions, oldest_elt->value);
428 sess_timeout_time = s->last_heard + (f64) nat44_session_get_timeout (sm, s);
429 if (now >= sess_timeout_time)
431 clib_dlist_addtail (tsm->list_pool,
432 u->sessions_per_user_list_head_index, oldest_index);
433 nat_free_session_data (sm, s, thread_index);
434 if (snat_is_session_static (s))
435 u->nstaticsessions--;
442 s->ext_host_addr.as_u32 = 0;
443 s->ext_host_port = 0;
444 s->ext_host_nat_addr.as_u32 = 0;
445 s->ext_host_nat_port = 0;
449 clib_dlist_addhead (tsm->list_pool,
450 u->sessions_per_user_list_head_index, oldest_index);
451 if ((u->nsessions + u->nstaticsessions) >=
452 sm->max_translations_per_user)
454 nat_log_warn ("max translations per user %U", format_ip4_address,
456 snat_ipfix_logging_max_entries_per_user
457 (sm->max_translations_per_user, u->addr.as_u32);
463 pool_get (tsm->sessions, s);
464 clib_memset (s, 0, sizeof (*s));
466 /* Create list elts */
467 pool_get (tsm->list_pool, per_user_translation_list_elt);
468 clib_dlist_init (tsm->list_pool,
469 per_user_translation_list_elt - tsm->list_pool);
471 per_user_translation_list_elt->value = s - tsm->sessions;
472 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
473 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
475 clib_dlist_addtail (tsm->list_pool,
476 s->per_user_list_head_index,
477 per_user_translation_list_elt - tsm->list_pool);
480 vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
481 pool_elts (tsm->sessions));
488 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
491 fib_prefix_t prefix = {
493 .fp_proto = FIB_PROTOCOL_IP4,
495 .ip4.as_u32 = addr->as_u32,
498 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
501 fib_table_entry_update_one_path (fib_index,
503 FIB_SOURCE_PLUGIN_LOW,
504 (FIB_ENTRY_FLAG_CONNECTED |
505 FIB_ENTRY_FLAG_LOCAL |
506 FIB_ENTRY_FLAG_EXCLUSIVE),
510 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
512 fib_table_entry_delete (fib_index, &prefix, FIB_SOURCE_PLUGIN_LOW);
516 snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
521 vlib_thread_main_t *tm = vlib_get_thread_main ();
523 if (twice_nat && !sm->endpoint_dependent)
524 return VNET_API_ERROR_FEATURE_DISABLED;
526 /* Check if address already exists */
528 vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
530 if (ap->addr.as_u32 == addr->as_u32)
531 return VNET_API_ERROR_VALUE_EXIST;
536 vec_add2 (sm->twice_nat_addresses, ap, 1);
538 vec_add2 (sm->addresses, ap, 1);
543 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
544 FIB_SOURCE_PLUGIN_LOW);
547 #define _(N, i, n, s) \
548 clib_bitmap_alloc (ap->busy_##n##_port_bitmap, 65535); \
549 ap->busy_##n##_ports = 0; \
550 ap->busy_##n##_ports_per_thread = 0;\
551 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
552 foreach_snat_protocol
557 /* Add external address to FIB */
559 pool_foreach (i, sm->interfaces,
561 if (nat_interface_is_inside(i) || sm->out2in_dpo)
564 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
567 pool_foreach (i, sm->output_feature_interfaces,
569 if (nat_interface_is_inside(i) || sm->out2in_dpo)
572 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
581 is_snat_address_used_in_static_mapping (snat_main_t * sm, ip4_address_t addr)
583 snat_static_mapping_t *m;
585 pool_foreach (m, sm->static_mappings,
587 if (is_addr_only_static_mapping (m) ||
588 is_out2in_only_static_mapping (m) ||
589 is_identity_static_mapping (m))
591 if (m->external_addr.as_u32 == addr.as_u32)
600 increment_v4_address (ip4_address_t * a)
604 v = clib_net_to_host_u32 (a->as_u32) + 1;
605 a->as_u32 = clib_host_to_net_u32 (v);
609 snat_add_static_mapping_when_resolved (snat_main_t * sm,
610 ip4_address_t l_addr,
615 snat_protocol_t proto,
616 int addr_only, int is_add, u8 * tag,
617 int twice_nat, int out2in_only,
620 snat_static_map_resolve_t *rp;
622 vec_add2 (sm->to_resolve, rp, 1);
623 rp->l_addr.as_u32 = l_addr.as_u32;
625 rp->sw_if_index = sw_if_index;
629 rp->addr_only = addr_only;
631 rp->twice_nat = twice_nat;
632 rp->out2in_only = out2in_only;
633 rp->identity_nat = identity_nat;
634 rp->tag = vec_dup (tag);
638 get_thread_idx_by_port (u16 e_port)
640 snat_main_t *sm = &snat_main;
641 u32 thread_idx = sm->num_workers;
642 if (sm->num_workers > 1)
645 sm->first_worker_index +
646 sm->workers[(e_port - 1024) / sm->port_per_thread];
652 snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
653 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
654 u32 sw_if_index, snat_protocol_t proto, int is_add,
655 twice_nat_type_t twice_nat, u8 out2in_only, u8 * tag,
658 snat_main_t *sm = &snat_main;
659 snat_static_mapping_t *m;
660 snat_session_key_t m_key;
661 clib_bihash_kv_8_8_t kv, value;
662 snat_address_t *a = 0;
664 snat_interface_t *interface;
666 snat_main_per_thread_data_t *tsm;
667 snat_user_key_t u_key;
669 dlist_elt_t *head, *elt;
670 u32 elt_index, head_index;
674 snat_static_map_resolve_t *rp, *rp_match = 0;
675 nat44_lb_addr_port_t *local;
678 if (!sm->endpoint_dependent)
680 if (twice_nat || out2in_only)
681 return VNET_API_ERROR_FEATURE_DISABLED;
684 /* If the external address is a specific interface address */
685 if (sw_if_index != ~0)
687 ip4_address_t *first_int_addr;
689 for (i = 0; i < vec_len (sm->to_resolve); i++)
691 rp = sm->to_resolve + i;
692 if (rp->sw_if_index != sw_if_index ||
693 rp->l_addr.as_u32 != l_addr.as_u32 ||
694 rp->vrf_id != vrf_id || rp->addr_only != addr_only)
699 if (rp->l_port != l_port || rp->e_port != e_port
700 || rp->proto != proto)
708 /* Might be already set... */
709 first_int_addr = ip4_interface_first_address
710 (sm->ip4_main, sw_if_index, 0 /* just want the address */ );
715 return VNET_API_ERROR_VALUE_EXIST;
717 snat_add_static_mapping_when_resolved
718 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
719 addr_only, is_add, tag, twice_nat, out2in_only, identity_nat);
721 /* DHCP resolution required? */
722 if (first_int_addr == 0)
728 e_addr.as_u32 = first_int_addr->as_u32;
729 /* Identity mapping? */
730 if (l_addr.as_u32 == 0)
731 l_addr.as_u32 = e_addr.as_u32;
737 return VNET_API_ERROR_NO_SUCH_ENTRY;
739 vec_del1 (sm->to_resolve, i);
743 e_addr.as_u32 = first_int_addr->as_u32;
744 /* Identity mapping? */
745 if (l_addr.as_u32 == 0)
746 l_addr.as_u32 = e_addr.as_u32;
754 m_key.port = addr_only ? 0 : e_port;
755 m_key.protocol = addr_only ? 0 : proto;
757 kv.key = m_key.as_u64;
758 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
761 m = pool_elt_at_index (sm->static_mappings, value.value);
767 if (is_identity_static_mapping (m))
770 pool_foreach (local, m->locals,
772 if (local->vrf_id == vrf_id)
773 return VNET_API_ERROR_VALUE_EXIST;
776 pool_get (m->locals, local);
777 local->vrf_id = vrf_id;
779 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
780 FIB_SOURCE_PLUGIN_LOW);
781 m_key.addr = m->local_addr;
782 m_key.port = m->local_port;
783 m_key.protocol = m->proto;
784 m_key.fib_index = local->fib_index;
785 kv.key = m_key.as_u64;
786 kv.value = m - sm->static_mappings;
787 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
791 return VNET_API_ERROR_VALUE_EXIST;
794 if (twice_nat && addr_only)
795 return VNET_API_ERROR_UNSUPPORTED;
797 /* Convert VRF id to FIB index */
800 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
801 FIB_SOURCE_PLUGIN_LOW);
802 /* If not specified use inside VRF id from SNAT plugin startup config */
805 fib_index = sm->inside_fib_index;
806 vrf_id = sm->inside_vrf_id;
809 if (!(out2in_only || identity_nat))
812 m_key.port = addr_only ? 0 : l_port;
813 m_key.protocol = addr_only ? 0 : proto;
814 m_key.fib_index = fib_index;
815 kv.key = m_key.as_u64;
816 if (!clib_bihash_search_8_8
817 (&sm->static_mapping_by_local, &kv, &value))
818 return VNET_API_ERROR_VALUE_EXIST;
821 /* Find external address in allocated addresses and reserve port for
822 address and port pair mapping when dynamic translations enabled */
823 if (!(addr_only || sm->static_mapping_only || out2in_only))
825 for (i = 0; i < vec_len (sm->addresses); i++)
827 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
829 a = sm->addresses + i;
830 /* External port must be unused */
833 #define _(N, j, n, s) \
834 case SNAT_PROTOCOL_##N: \
835 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
836 return VNET_API_ERROR_INVALID_VALUE; \
837 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
840 a->busy_##n##_ports++; \
841 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
844 foreach_snat_protocol
847 nat_log_info ("unknown protocol");
848 return VNET_API_ERROR_INVALID_VALUE_2;
853 /* External address must be allocated */
854 if (!a && (l_addr.as_u32 != e_addr.as_u32))
856 if (sw_if_index != ~0)
858 for (i = 0; i < vec_len (sm->to_resolve); i++)
860 rp = sm->to_resolve + i;
863 if (rp->sw_if_index != sw_if_index &&
864 rp->l_addr.as_u32 != l_addr.as_u32 &&
865 rp->vrf_id != vrf_id && rp->l_port != l_port &&
866 rp->e_port != e_port && rp->proto != proto)
869 vec_del1 (sm->to_resolve, i);
873 return VNET_API_ERROR_NO_SUCH_ENTRY;
877 pool_get (sm->static_mappings, m);
878 clib_memset (m, 0, sizeof (*m));
879 m->tag = vec_dup (tag);
880 m->local_addr = l_addr;
881 m->external_addr = e_addr;
882 m->twice_nat = twice_nat;
884 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
886 m->flags |= NAT_STATIC_MAPPING_FLAG_ADDR_ONLY;
889 m->flags |= NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT;
890 pool_get (m->locals, local);
891 local->vrf_id = vrf_id;
892 local->fib_index = fib_index;
897 m->fib_index = fib_index;
901 m->local_port = l_port;
902 m->external_port = e_port;
906 if (sm->num_workers > 1)
909 .src_address = m->local_addr,
911 vec_add1 (m->workers, sm->worker_in2out_cb (&ip, m->fib_index));
912 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
915 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
917 m_key.addr = m->local_addr;
918 m_key.port = m->local_port;
919 m_key.protocol = m->proto;
920 m_key.fib_index = fib_index;
921 kv.key = m_key.as_u64;
922 kv.value = m - sm->static_mappings;
924 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
926 m_key.addr = m->external_addr;
927 m_key.port = m->external_port;
929 kv.key = m_key.as_u64;
930 kv.value = m - sm->static_mappings;
931 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1);
933 /* Delete dynamic sessions matching local address (+ local port) */
934 if (!(sm->static_mapping_only))
936 u_key.addr = m->local_addr;
937 u_key.fib_index = m->fib_index;
938 kv.key = u_key.as_u64;
939 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
941 user_index = value.value;
942 u = pool_elt_at_index (tsm->users, user_index);
945 head_index = u->sessions_per_user_list_head_index;
946 head = pool_elt_at_index (tsm->list_pool, head_index);
947 elt_index = head->next;
948 elt = pool_elt_at_index (tsm->list_pool, elt_index);
949 ses_index = elt->value;
950 while (ses_index != ~0)
952 s = pool_elt_at_index (tsm->sessions, ses_index);
953 elt = pool_elt_at_index (tsm->list_pool, elt->next);
954 ses_index = elt->value;
956 if (snat_is_session_static (s))
960 && (clib_net_to_host_u16 (s->in2out.port) !=
964 nat_free_session_data (sm, s,
965 tsm - sm->per_thread_data);
966 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
968 if (!addr_only && !sm->endpoint_dependent)
979 if (sw_if_index != ~0)
982 return VNET_API_ERROR_NO_SUCH_ENTRY;
988 vrf_id = sm->inside_vrf_id;
991 pool_foreach (local, m->locals,
993 if (local->vrf_id == vrf_id)
994 find = local - m->locals;
998 return VNET_API_ERROR_NO_SUCH_ENTRY;
1000 local = pool_elt_at_index (m->locals, find);
1001 fib_index = local->fib_index;
1002 pool_put (m->locals, local);
1005 fib_index = m->fib_index;
1007 /* Free external address port */
1008 if (!(addr_only || sm->static_mapping_only || out2in_only))
1010 for (i = 0; i < vec_len (sm->addresses); i++)
1012 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1014 a = sm->addresses + i;
1017 #define _(N, j, n, s) \
1018 case SNAT_PROTOCOL_##N: \
1019 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
1020 if (e_port > 1024) \
1022 a->busy_##n##_ports--; \
1023 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1026 foreach_snat_protocol
1029 nat_log_info ("unknown protocol");
1030 return VNET_API_ERROR_INVALID_VALUE_2;
1037 if (sm->num_workers > 1)
1038 tsm = vec_elt_at_index (sm->per_thread_data, m->workers[0]);
1040 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1042 m_key.addr = m->local_addr;
1043 m_key.port = m->local_port;
1044 m_key.protocol = m->proto;
1045 m_key.fib_index = fib_index;
1046 kv.key = m_key.as_u64;
1048 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0);
1050 /* Delete session(s) for static mapping if exist */
1051 if (!(sm->static_mapping_only) ||
1052 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
1054 u_key.addr = m->local_addr;
1055 u_key.fib_index = fib_index;
1056 kv.key = u_key.as_u64;
1057 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1059 user_index = value.value;
1060 u = pool_elt_at_index (tsm->users, user_index);
1061 if (u->nstaticsessions)
1063 head_index = u->sessions_per_user_list_head_index;
1064 head = pool_elt_at_index (tsm->list_pool, head_index);
1065 elt_index = head->next;
1066 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1067 ses_index = elt->value;
1068 while (ses_index != ~0)
1070 s = pool_elt_at_index (tsm->sessions, ses_index);
1071 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1072 ses_index = elt->value;
1076 if ((s->out2in.addr.as_u32 != e_addr.as_u32) ||
1077 (clib_net_to_host_u16 (s->out2in.port) !=
1082 if (is_lb_session (s))
1085 if (!snat_is_session_static (s))
1088 nat_free_session_data (sm, s,
1089 tsm - sm->per_thread_data);
1090 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1092 if (!addr_only && !sm->endpoint_dependent)
1099 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_PLUGIN_LOW);
1100 if (pool_elts (m->locals))
1103 m_key.addr = m->external_addr;
1104 m_key.port = m->external_port;
1105 m_key.fib_index = 0;
1106 kv.key = m_key.as_u64;
1107 clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0);
1110 vec_free (m->workers);
1111 /* Delete static mapping from pool */
1112 pool_put (sm->static_mappings, m);
1115 if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
1118 /* Add/delete external address to FIB */
1120 pool_foreach (interface, sm->interfaces,
1122 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1125 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1128 pool_foreach (interface, sm->output_feature_interfaces,
1130 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1133 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1142 nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1143 snat_protocol_t proto,
1144 nat44_lb_addr_port_t * locals, u8 is_add,
1145 twice_nat_type_t twice_nat, u8 out2in_only,
1146 u8 * tag, u32 affinity)
1148 snat_main_t *sm = &snat_main;
1149 snat_static_mapping_t *m;
1150 snat_session_key_t m_key;
1151 clib_bihash_kv_8_8_t kv, value;
1152 snat_address_t *a = 0;
1154 nat44_lb_addr_port_t *local;
1155 u32 elt_index, head_index, ses_index;
1156 snat_main_per_thread_data_t *tsm;
1157 snat_user_key_t u_key;
1160 dlist_elt_t *head, *elt;
1163 if (!sm->endpoint_dependent)
1164 return VNET_API_ERROR_FEATURE_DISABLED;
1166 m_key.addr = e_addr;
1167 m_key.port = e_port;
1168 m_key.protocol = proto;
1169 m_key.fib_index = 0;
1170 kv.key = m_key.as_u64;
1171 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1174 m = pool_elt_at_index (sm->static_mappings, value.value);
1179 return VNET_API_ERROR_VALUE_EXIST;
1181 if (vec_len (locals) < 2)
1182 return VNET_API_ERROR_INVALID_VALUE;
1184 /* Find external address in allocated addresses and reserve port for
1185 address and port pair mapping when dynamic translations enabled */
1186 if (!(sm->static_mapping_only || out2in_only))
1188 for (i = 0; i < vec_len (sm->addresses); i++)
1190 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1192 a = sm->addresses + i;
1193 /* External port must be unused */
1196 #define _(N, j, n, s) \
1197 case SNAT_PROTOCOL_##N: \
1198 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
1199 return VNET_API_ERROR_INVALID_VALUE; \
1200 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
1201 if (e_port > 1024) \
1203 a->busy_##n##_ports++; \
1204 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]++; \
1207 foreach_snat_protocol
1210 nat_log_info ("unknown protocol");
1211 return VNET_API_ERROR_INVALID_VALUE_2;
1216 /* External address must be allocated */
1218 return VNET_API_ERROR_NO_SUCH_ENTRY;
1221 pool_get (sm->static_mappings, m);
1222 clib_memset (m, 0, sizeof (*m));
1223 m->tag = vec_dup (tag);
1224 m->external_addr = e_addr;
1225 m->external_port = e_port;
1227 m->twice_nat = twice_nat;
1228 m->flags |= NAT_STATIC_MAPPING_FLAG_LB;
1230 m->flags |= NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY;
1231 m->affinity = affinity;
1234 m->affinity_per_service_list_head_index =
1235 nat_affinity_get_per_service_list_head_index ();
1237 m->affinity_per_service_list_head_index = ~0;
1239 m_key.addr = m->external_addr;
1240 m_key.port = m->external_port;
1241 m_key.protocol = m->proto;
1242 m_key.fib_index = 0;
1243 kv.key = m_key.as_u64;
1244 kv.value = m - sm->static_mappings;
1245 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 1))
1247 nat_log_err ("static_mapping_by_external key add failed");
1248 return VNET_API_ERROR_UNSPECIFIED;
1251 m_key.fib_index = m->fib_index;
1252 for (i = 0; i < vec_len (locals); i++)
1254 locals[i].fib_index =
1255 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
1257 FIB_SOURCE_PLUGIN_LOW);
1258 m_key.addr = locals[i].addr;
1259 m_key.fib_index = locals[i].fib_index;
1262 m_key.port = locals[i].port;
1263 kv.key = m_key.as_u64;
1264 kv.value = m - sm->static_mappings;
1265 clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1);
1267 locals[i].prefix = (i == 0) ? locals[i].probability :
1268 (locals[i - 1].prefix + locals[i].probability);
1269 pool_get (m->locals, local);
1271 if (sm->num_workers > 1)
1274 .src_address = locals[i].addr,
1277 clib_bitmap_set (bitmap,
1278 sm->worker_in2out_cb (&ip, m->fib_index), 1);
1282 /* Assign workers */
1283 if (sm->num_workers > 1)
1286 clib_bitmap_foreach (i, bitmap,
1288 vec_add1(m->workers, i);
1296 return VNET_API_ERROR_NO_SUCH_ENTRY;
1298 if (!is_lb_static_mapping (m))
1299 return VNET_API_ERROR_INVALID_VALUE;
1301 /* Free external address port */
1302 if (!(sm->static_mapping_only || out2in_only))
1304 for (i = 0; i < vec_len (sm->addresses); i++)
1306 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1308 a = sm->addresses + i;
1311 #define _(N, j, n, s) \
1312 case SNAT_PROTOCOL_##N: \
1313 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
1314 if (e_port > 1024) \
1316 a->busy_##n##_ports--; \
1317 a->busy_##n##_ports_per_thread[get_thread_idx_by_port(e_port)]--; \
1320 foreach_snat_protocol
1323 nat_log_info ("unknown protocol");
1324 return VNET_API_ERROR_INVALID_VALUE_2;
1331 m_key.addr = m->external_addr;
1332 m_key.port = m->external_port;
1333 m_key.protocol = m->proto;
1334 m_key.fib_index = 0;
1335 kv.key = m_key.as_u64;
1336 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_external, &kv, 0))
1338 nat_log_err ("static_mapping_by_external key del failed");
1339 return VNET_API_ERROR_UNSPECIFIED;
1343 pool_foreach (local, m->locals,
1345 fib_table_unlock (local->fib_index, FIB_PROTOCOL_IP4,
1346 FIB_SOURCE_PLUGIN_LOW);
1347 m_key.addr = local->addr;
1350 m_key.port = local->port;
1351 m_key.fib_index = local->fib_index;
1352 kv.key = m_key.as_u64;
1353 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1355 nat_log_err ("static_mapping_by_local key del failed");
1356 return VNET_API_ERROR_UNSPECIFIED;
1360 if (sm->num_workers > 1)
1363 .src_address = local->addr,
1365 tsm = vec_elt_at_index (sm->per_thread_data,
1366 sm->worker_in2out_cb (&ip, m->fib_index));
1369 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1371 /* Delete sessions */
1372 u_key.addr = local->addr;
1373 u_key.fib_index = local->fib_index;
1374 kv.key = u_key.as_u64;
1375 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1377 u = pool_elt_at_index (tsm->users, value.value);
1378 if (u->nstaticsessions)
1380 head_index = u->sessions_per_user_list_head_index;
1381 head = pool_elt_at_index (tsm->list_pool, head_index);
1382 elt_index = head->next;
1383 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1384 ses_index = elt->value;
1385 while (ses_index != ~0)
1387 s = pool_elt_at_index (tsm->sessions, ses_index);
1388 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1389 ses_index = elt->value;
1391 if (!(is_lb_session (s)))
1394 if ((s->in2out.addr.as_u32 != local->addr.as_u32) ||
1395 (clib_net_to_host_u16 (s->in2out.port) != local->port))
1398 nat_free_session_data (sm, s, tsm - sm->per_thread_data);
1399 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1406 nat_affinity_flush_service (m->affinity_per_service_list_head_index);
1407 pool_free (m->locals);
1409 vec_free (m->workers);
1411 pool_put (sm->static_mappings, m);
1418 nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port,
1419 ip4_address_t l_addr, u16 l_port,
1420 snat_protocol_t proto, u32 vrf_id,
1421 u8 probability, u8 is_add)
1423 snat_main_t *sm = &snat_main;
1424 snat_static_mapping_t *m = 0;
1425 snat_session_key_t m_key;
1426 clib_bihash_kv_8_8_t kv, value;
1427 nat44_lb_addr_port_t *local, *prev_local, *match_local = 0;
1428 snat_main_per_thread_data_t *tsm;
1429 snat_user_key_t u_key;
1432 dlist_elt_t *head, *elt;
1433 u32 elt_index, head_index, ses_index, *locals = 0;
1437 if (!sm->endpoint_dependent)
1438 return VNET_API_ERROR_FEATURE_DISABLED;
1440 m_key.addr = e_addr;
1441 m_key.port = e_port;
1442 m_key.protocol = proto;
1443 m_key.fib_index = 0;
1444 kv.key = m_key.as_u64;
1445 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1446 m = pool_elt_at_index (sm->static_mappings, value.value);
1449 return VNET_API_ERROR_NO_SUCH_ENTRY;
1451 if (!is_lb_static_mapping (m))
1452 return VNET_API_ERROR_INVALID_VALUE;
1455 pool_foreach (local, m->locals,
1457 if ((local->addr.as_u32 == l_addr.as_u32) && (local->port == l_port) &&
1458 (local->vrf_id == vrf_id))
1460 match_local = local;
1469 return VNET_API_ERROR_VALUE_EXIST;
1471 pool_get (m->locals, local);
1472 clib_memset (local, 0, sizeof (*local));
1473 local->addr.as_u32 = l_addr.as_u32;
1474 local->port = l_port;
1475 local->probability = probability;
1476 local->vrf_id = vrf_id;
1478 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
1479 FIB_SOURCE_PLUGIN_LOW);
1481 if (!is_out2in_only_static_mapping (m))
1483 m_key.addr = l_addr;
1484 m_key.port = l_port;
1485 m_key.fib_index = local->fib_index;
1486 kv.key = m_key.as_u64;
1487 kv.value = m - sm->static_mappings;
1488 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 1))
1489 nat_log_err ("static_mapping_by_local key add failed");
1495 return VNET_API_ERROR_NO_SUCH_ENTRY;
1497 if (pool_elts (m->locals) < 3)
1498 return VNET_API_ERROR_UNSPECIFIED;
1500 fib_table_unlock (match_local->fib_index, FIB_PROTOCOL_IP4,
1501 FIB_SOURCE_PLUGIN_LOW);
1503 if (!is_out2in_only_static_mapping (m))
1505 m_key.addr = l_addr;
1506 m_key.port = l_port;
1507 m_key.fib_index = match_local->fib_index;
1508 kv.key = m_key.as_u64;
1509 if (clib_bihash_add_del_8_8 (&sm->static_mapping_by_local, &kv, 0))
1510 nat_log_err ("static_mapping_by_local key del failed");
1513 if (sm->num_workers > 1)
1516 .src_address = local->addr,
1518 tsm = vec_elt_at_index (sm->per_thread_data,
1519 sm->worker_in2out_cb (&ip, m->fib_index));
1522 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1524 /* Delete sessions */
1525 u_key.addr = match_local->addr;
1526 u_key.fib_index = match_local->fib_index;
1527 kv.key = u_key.as_u64;
1528 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1530 u = pool_elt_at_index (tsm->users, value.value);
1531 if (u->nstaticsessions)
1533 head_index = u->sessions_per_user_list_head_index;
1534 head = pool_elt_at_index (tsm->list_pool, head_index);
1535 elt_index = head->next;
1536 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1537 ses_index = elt->value;
1538 while (ses_index != ~0)
1540 s = pool_elt_at_index (tsm->sessions, ses_index);
1541 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1542 ses_index = elt->value;
1544 if (!(is_lb_session (s)))
1547 if ((s->in2out.addr.as_u32 != match_local->addr.as_u32) ||
1548 (clib_net_to_host_u16 (s->in2out.port) !=
1552 nat_free_session_data (sm, s, tsm - sm->per_thread_data);
1553 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
1558 pool_put (m->locals, match_local);
1561 vec_free (m->workers);
1564 pool_foreach (local, m->locals,
1566 vec_add1 (locals, local - m->locals);
1567 if (sm->num_workers > 1)
1570 ip.src_address.as_u32 = local->addr.as_u32,
1571 bitmap = clib_bitmap_set (bitmap,
1572 sm->worker_in2out_cb (&ip, local->fib_index),
1578 local = pool_elt_at_index (m->locals, locals[0]);
1579 local->prefix = local->probability;
1580 for (i = 1; i < vec_len (locals); i++)
1582 local = pool_elt_at_index (m->locals, locals[i]);
1583 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1584 local->prefix = local->probability + prev_local->prefix;
1587 /* Assign workers */
1588 if (sm->num_workers > 1)
1591 clib_bitmap_foreach (i, bitmap, ({ vec_add1(m->workers, i); }));
1599 snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1602 snat_address_t *a = 0;
1603 snat_session_t *ses;
1604 u32 *ses_to_be_removed = 0, *ses_index;
1605 snat_main_per_thread_data_t *tsm;
1606 snat_static_mapping_t *m;
1607 snat_interface_t *interface;
1609 snat_address_t *addresses =
1610 twice_nat ? sm->twice_nat_addresses : sm->addresses;
1612 /* Find SNAT address */
1613 for (i = 0; i < vec_len (addresses); i++)
1615 if (addresses[i].addr.as_u32 == addr.as_u32)
1622 return VNET_API_ERROR_NO_SUCH_ENTRY;
1627 pool_foreach (m, sm->static_mappings,
1629 if (m->external_addr.as_u32 == addr.as_u32)
1630 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1631 m->local_port, m->external_port,
1632 m->vrf_id, is_addr_only_static_mapping(m), ~0,
1633 m->proto, 0, m->twice_nat,
1634 is_out2in_only_static_mapping(m), m->tag, is_identity_static_mapping(m));
1640 /* Check if address is used in some static mapping */
1641 if (is_snat_address_used_in_static_mapping (sm, addr))
1643 nat_log_notice ("address used in static mapping");
1644 return VNET_API_ERROR_UNSPECIFIED;
1648 if (a->fib_index != ~0)
1649 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_PLUGIN_LOW);
1651 /* Delete sessions using address */
1652 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1655 vec_foreach (tsm, sm->per_thread_data)
1657 pool_foreach (ses, tsm->sessions, ({
1658 if (ses->out2in.addr.as_u32 == addr.as_u32)
1660 nat_free_session_data (sm, ses, tsm - sm->per_thread_data);
1661 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1665 vec_foreach (ses_index, ses_to_be_removed)
1667 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1668 nat44_delete_session (sm, ses, tsm - sm->per_thread_data);
1671 vec_free (ses_to_be_removed);
1676 #define _(N, i, n, s) \
1677 clib_bitmap_free (a->busy_##n##_port_bitmap); \
1678 vec_free (a->busy_##n##_ports_per_thread);
1679 foreach_snat_protocol
1683 vec_del1 (sm->twice_nat_addresses, i);
1687 vec_del1 (sm->addresses, i);
1689 /* Delete external address from FIB */
1691 pool_foreach (interface, sm->interfaces,
1693 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1696 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1699 pool_foreach (interface, sm->output_feature_interfaces,
1701 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1704 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1713 snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1715 snat_main_t *sm = &snat_main;
1716 snat_interface_t *i;
1717 const char *feature_name, *del_feature_name;
1719 snat_static_mapping_t *m;
1721 nat_outside_fib_t *outside_fib;
1722 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1725 if (sm->out2in_dpo && !is_inside)
1726 return VNET_API_ERROR_UNSUPPORTED;
1729 pool_foreach (i, sm->output_feature_interfaces,
1731 if (i->sw_if_index == sw_if_index)
1732 return VNET_API_ERROR_VALUE_EXIST;
1736 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1737 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1740 if (sm->num_workers > 1 && !sm->deterministic)
1742 is_inside ? "nat44-in2out-worker-handoff" :
1743 "nat44-out2in-worker-handoff";
1744 else if (sm->deterministic)
1745 feature_name = is_inside ? "nat44-det-in2out" : "nat44-det-out2in";
1746 else if (sm->endpoint_dependent)
1747 feature_name = is_inside ? "nat44-ed-in2out" : "nat44-ed-out2in";
1749 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1752 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1753 sm->fq_in2out_index = vlib_frame_queue_main_init (sm->in2out_node_index,
1756 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1757 sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index,
1763 vec_foreach (outside_fib, sm->outside_fibs)
1765 if (outside_fib->fib_index == fib_index)
1769 outside_fib->refcount--;
1770 if (!outside_fib->refcount)
1771 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1774 outside_fib->refcount++;
1781 vec_add2 (sm->outside_fibs, outside_fib, 1);
1782 outside_fib->refcount = 1;
1783 outside_fib->fib_index = fib_index;
1788 pool_foreach (i, sm->interfaces,
1790 if (i->sw_if_index == sw_if_index)
1794 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1797 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1799 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1801 if (sm->num_workers > 1 && !sm->deterministic)
1803 del_feature_name = "nat44-handoff-classify";
1804 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1805 "nat44-out2in-worker-handoff";
1807 else if (sm->deterministic)
1809 del_feature_name = "nat44-det-classify";
1810 feature_name = !is_inside ? "nat44-det-in2out" :
1813 else if (sm->endpoint_dependent)
1815 del_feature_name = "nat44-ed-classify";
1816 feature_name = !is_inside ? "nat44-ed-in2out" :
1821 del_feature_name = "nat44-classify";
1822 feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1825 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1826 sw_if_index, 0, 0, 0);
1827 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1828 sw_if_index, 1, 0, 0);
1831 if (sm->endpoint_dependent)
1832 vnet_feature_enable_disable ("ip4-local",
1833 "nat44-ed-hairpinning",
1834 sw_if_index, 1, 0, 0);
1835 else if (!sm->deterministic)
1836 vnet_feature_enable_disable ("ip4-local",
1837 "nat44-hairpinning",
1838 sw_if_index, 1, 0, 0);
1843 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1844 sw_if_index, 0, 0, 0);
1845 pool_put (sm->interfaces, i);
1848 if (sm->endpoint_dependent)
1849 vnet_feature_enable_disable ("ip4-local",
1850 "nat44-ed-hairpinning",
1851 sw_if_index, 0, 0, 0);
1852 else if (!sm->deterministic)
1853 vnet_feature_enable_disable ("ip4-local",
1854 "nat44-hairpinning",
1855 sw_if_index, 0, 0, 0);
1861 if ((nat_interface_is_inside(i) && is_inside) ||
1862 (nat_interface_is_outside(i) && !is_inside))
1865 if (sm->num_workers > 1 && !sm->deterministic)
1867 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1868 "nat44-out2in-worker-handoff";
1869 feature_name = "nat44-handoff-classify";
1871 else if (sm->deterministic)
1873 del_feature_name = !is_inside ? "nat44-det-in2out" :
1875 feature_name = "nat44-det-classify";
1877 else if (sm->endpoint_dependent)
1879 del_feature_name = !is_inside ? "nat44-ed-in2out" :
1881 feature_name = "nat44-ed-classify";
1885 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1886 feature_name = "nat44-classify";
1889 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1890 sw_if_index, 0, 0, 0);
1891 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1892 sw_if_index, 1, 0, 0);
1895 if (sm->endpoint_dependent)
1896 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
1897 sw_if_index, 0, 0, 0);
1898 else if (!sm->deterministic)
1899 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1900 sw_if_index, 0, 0, 0);
1911 return VNET_API_ERROR_NO_SUCH_ENTRY;
1913 pool_get (sm->interfaces, i);
1914 i->sw_if_index = sw_if_index;
1916 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0,
1919 if (is_inside && !sm->out2in_dpo)
1921 if (sm->endpoint_dependent)
1922 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
1923 sw_if_index, 1, 0, 0);
1924 else if (!sm->deterministic)
1925 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1926 sw_if_index, 1, 0, 0);
1932 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1936 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1938 /* Add/delete external addresses to FIB */
1941 vec_foreach (ap, sm->addresses)
1942 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1944 pool_foreach (m, sm->static_mappings,
1946 if (!(is_addr_only_static_mapping(m)) || (m->local_addr.as_u32 == m->external_addr.as_u32))
1949 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1952 pool_foreach (dm, sm->det_maps,
1954 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
1962 snat_interface_add_del_output_feature (u32 sw_if_index,
1963 u8 is_inside, int is_del)
1965 snat_main_t *sm = &snat_main;
1966 snat_interface_t *i;
1968 snat_static_mapping_t *m;
1970 if (sm->deterministic ||
1971 (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
1972 return VNET_API_ERROR_UNSUPPORTED;
1975 pool_foreach (i, sm->interfaces,
1977 if (i->sw_if_index == sw_if_index)
1978 return VNET_API_ERROR_VALUE_EXIST;
1984 if (sm->endpoint_dependent)
1986 vnet_feature_enable_disable ("ip4-unicast", "nat44-ed-hairpin-dst",
1987 sw_if_index, !is_del, 0, 0);
1988 vnet_feature_enable_disable ("ip4-output", "nat44-ed-hairpin-src",
1989 sw_if_index, !is_del, 0, 0);
1993 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
1994 sw_if_index, !is_del, 0, 0);
1995 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
1996 sw_if_index, !is_del, 0, 0);
2001 if (sm->num_workers > 1)
2003 vnet_feature_enable_disable ("ip4-unicast",
2004 "nat44-out2in-worker-handoff",
2005 sw_if_index, !is_del, 0, 0);
2006 vnet_feature_enable_disable ("ip4-output",
2007 "nat44-in2out-output-worker-handoff",
2008 sw_if_index, !is_del, 0, 0);
2012 if (sm->endpoint_dependent)
2014 vnet_feature_enable_disable ("ip4-unicast", "nat44-ed-out2in",
2015 sw_if_index, !is_del, 0, 0);
2016 vnet_feature_enable_disable ("ip4-output", "nat44-ed-in2out-output",
2017 sw_if_index, !is_del, 0, 0);
2021 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in",
2022 sw_if_index, !is_del, 0, 0);
2023 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
2024 sw_if_index, !is_del, 0, 0);
2029 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
2030 sm->fq_in2out_output_index =
2031 vlib_frame_queue_main_init (sm->in2out_output_node_index, 0);
2033 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
2034 sm->fq_out2in_index =
2035 vlib_frame_queue_main_init (sm->out2in_node_index, 0);
2038 pool_foreach (i, sm->output_feature_interfaces,
2040 if (i->sw_if_index == sw_if_index)
2043 pool_put (sm->output_feature_interfaces, i);
2045 return VNET_API_ERROR_VALUE_EXIST;
2053 return VNET_API_ERROR_NO_SUCH_ENTRY;
2055 pool_get (sm->output_feature_interfaces, i);
2056 i->sw_if_index = sw_if_index;
2059 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2061 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2063 /* Add/delete external addresses to FIB */
2069 vec_foreach (ap, sm->addresses)
2070 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2072 pool_foreach (m, sm->static_mappings,
2074 if (!((is_addr_only_static_mapping(m))) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2077 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2085 snat_set_workers (uword * bitmap)
2087 snat_main_t *sm = &snat_main;
2090 if (sm->num_workers < 2)
2091 return VNET_API_ERROR_FEATURE_DISABLED;
2093 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2094 return VNET_API_ERROR_INVALID_WORKER;
2096 vec_free (sm->workers);
2098 clib_bitmap_foreach (i, bitmap,
2100 vec_add1(sm->workers, i);
2101 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2106 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
2107 sm->num_snat_thread = _vec_len (sm->workers);
2114 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2117 ip4_address_t * address,
2119 u32 if_address_index, u32 is_delete);
2122 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
2125 ip4_address_t * address,
2127 u32 if_address_index, u32 is_delete);
2130 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2133 snat_session_key_t * k,
2134 u16 port_per_thread, u32 snat_thread_index);
2136 static clib_error_t *
2137 snat_init (vlib_main_t * vm)
2139 snat_main_t *sm = &snat_main;
2140 clib_error_t *error = 0;
2141 ip4_main_t *im = &ip4_main;
2142 ip_lookup_main_t *lm = &im->lookup_main;
2144 vlib_thread_registration_t *tr;
2145 vlib_thread_main_t *tm = vlib_get_thread_main ();
2148 ip4_add_del_interface_address_callback_t cb4;
2149 vlib_node_t *error_drop_node;
2152 sm->vnet_main = vnet_get_main ();
2154 sm->ip4_lookup_main = lm;
2155 sm->api_main = &api_main;
2156 sm->first_worker_index = 0;
2157 sm->num_workers = 0;
2158 sm->num_snat_thread = 1;
2160 sm->port_per_thread = 0xffff - 1024;
2161 sm->fq_in2out_index = ~0;
2162 sm->fq_out2in_index = ~0;
2163 sm->udp_timeout = SNAT_UDP_TIMEOUT;
2164 sm->tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
2165 sm->tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
2166 sm->icmp_timeout = SNAT_ICMP_TIMEOUT;
2167 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
2168 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
2169 sm->forwarding_enabled = 0;
2170 sm->log_class = vlib_log_register_class ("nat", 0);
2171 error_drop_node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
2172 sm->error_node_index = error_drop_node->index;
2173 sm->mss_clamping = 0;
2175 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2178 tr = (vlib_thread_registration_t *) p[0];
2181 sm->num_workers = tr->count;
2182 sm->first_worker_index = tr->first_index;
2186 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2188 /* Use all available workers by default */
2189 if (sm->num_workers > 1)
2191 for (i = 0; i < sm->num_workers; i++)
2192 bitmap = clib_bitmap_set (bitmap, i, 1);
2193 snat_set_workers (bitmap);
2194 clib_bitmap_free (bitmap);
2198 sm->per_thread_data[0].snat_thread_index = 0;
2201 error = snat_api_init (vm, sm);
2205 /* Set up the interface address add/del callback */
2206 cb4.function = snat_ip4_add_del_interface_address_cb;
2207 cb4.function_opaque = 0;
2209 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2211 cb4.function = nat_ip4_add_del_addr_only_sm_cb;
2212 cb4.function_opaque = 0;
2214 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2216 nat_dpo_module_init ();
2219 sm->total_users.name = "total-users";
2220 sm->total_users.stat_segment_name = "/nat44/total-users";
2221 vlib_validate_simple_counter (&sm->total_users, 0);
2222 vlib_zero_simple_counter (&sm->total_users, 0);
2223 sm->total_sessions.name = "total-sessions";
2224 sm->total_sessions.stat_segment_name = "/nat44/total-sessions";
2225 vlib_validate_simple_counter (&sm->total_sessions, 0);
2226 vlib_zero_simple_counter (&sm->total_sessions, 0);
2228 /* Init IPFIX logging */
2229 snat_ipfix_logging_init (vm);
2232 error = nat64_init (vm);
2240 /* Init virtual fragmenentation reassembly */
2241 return nat_reass_init (vm);
2244 VLIB_INIT_FUNCTION (snat_init);
2247 snat_free_outside_address_and_port (snat_address_t * addresses,
2248 u32 thread_index, snat_session_key_t * k)
2252 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2254 for (address_index = 0; address_index < vec_len (addresses);
2257 if (addresses[address_index].addr.as_u32 == k->addr.as_u32)
2261 ASSERT (address_index < vec_len (addresses));
2263 a = addresses + address_index;
2265 switch (k->protocol)
2267 #define _(N, i, n, s) \
2268 case SNAT_PROTOCOL_##N: \
2269 ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
2270 port_host_byte_order) == 1); \
2271 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
2272 port_host_byte_order, 0); \
2273 a->busy_##n##_ports--; \
2274 a->busy_##n##_ports_per_thread[thread_index]--; \
2276 foreach_snat_protocol
2279 nat_log_info ("unknown protocol");
2285 snat_static_mapping_match (snat_main_t * sm,
2286 snat_session_key_t match,
2287 snat_session_key_t * mapping,
2290 twice_nat_type_t * twice_nat,
2291 lb_nat_type_t * lb, ip4_address_t * ext_host_addr,
2292 u8 * is_identity_nat)
2294 clib_bihash_kv_8_8_t kv, value;
2295 snat_static_mapping_t *m;
2296 snat_session_key_t m_key;
2297 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
2298 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2300 nat44_lb_addr_port_t *local;
2302 m_key.fib_index = match.fib_index;
2305 mapping_hash = &sm->static_mapping_by_external;
2306 m_key.fib_index = 0;
2309 m_key.addr = match.addr;
2310 m_key.port = clib_net_to_host_u16 (match.port);
2311 m_key.protocol = match.protocol;
2313 kv.key = m_key.as_u64;
2315 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2317 /* Try address only mapping */
2320 kv.key = m_key.as_u64;
2321 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2325 m = pool_elt_at_index (sm->static_mappings, value.value);
2329 if (is_lb_static_mapping (m))
2331 if (PREDICT_FALSE (lb != 0))
2332 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2335 if (nat_affinity_find_and_lock (ext_host_addr[0], match.addr,
2336 match.protocol, match.port,
2340 local = pool_elt_at_index (m->locals, backend_index);
2341 mapping->addr = local->addr;
2342 mapping->port = clib_host_to_net_u16 (local->port);
2343 mapping->fib_index = local->fib_index;
2348 pool_foreach_index (i, m->locals,
2353 hi = vec_len (tmp) - 1;
2354 local = pool_elt_at_index (m->locals, tmp[hi]);
2355 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2358 mid = ((hi - lo) >> 1) + lo;
2359 local = pool_elt_at_index (m->locals, tmp[mid]);
2360 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2362 local = pool_elt_at_index (m->locals, tmp[lo]);
2363 if (!(local->prefix >= rand))
2365 if (PREDICT_FALSE (sm->num_workers > 1))
2368 .src_address = local->addr,
2370 if (sm->worker_in2out_cb (&ip, m->fib_index) !=
2371 vlib_get_thread_index ())
2374 mapping->addr = local->addr;
2375 mapping->port = clib_host_to_net_u16 (local->port);
2376 mapping->fib_index = local->fib_index;
2379 if (nat_affinity_create_and_lock (ext_host_addr[0], match.addr,
2380 match.protocol, match.port,
2381 tmp[lo], m->affinity,
2382 m->affinity_per_service_list_head_index))
2383 nat_log_info ("create affinity record failed");
2389 if (PREDICT_FALSE (lb != 0))
2391 mapping->fib_index = m->fib_index;
2392 mapping->addr = m->local_addr;
2393 /* Address only mapping doesn't change port */
2394 mapping->port = is_addr_only_static_mapping (m) ? match.port
2395 : clib_host_to_net_u16 (m->local_port);
2397 mapping->protocol = m->proto;
2401 mapping->addr = m->external_addr;
2402 /* Address only mapping doesn't change port */
2403 mapping->port = is_addr_only_static_mapping (m) ? match.port
2404 : clib_host_to_net_u16 (m->external_port);
2405 mapping->fib_index = sm->outside_fib_index;
2409 if (PREDICT_FALSE (is_addr_only != 0))
2410 *is_addr_only = is_addr_only_static_mapping (m);
2412 if (PREDICT_FALSE (twice_nat != 0))
2413 *twice_nat = m->twice_nat;
2415 if (PREDICT_FALSE (is_identity_nat != 0))
2416 *is_identity_nat = is_identity_static_mapping (m);
2421 static_always_inline u16
2422 snat_random_port (u16 min, u16 max)
2424 snat_main_t *sm = &snat_main;
2425 return min + random_u32 (&sm->random_seed) /
2426 (random_u32_max () / (max - min + 1) + 1);
2430 snat_alloc_outside_address_and_port (snat_address_t * addresses,
2433 snat_session_key_t * k,
2434 u16 port_per_thread,
2435 u32 snat_thread_index)
2437 snat_main_t *sm = &snat_main;
2439 return sm->alloc_addr_and_port (addresses, fib_index, thread_index, k,
2440 port_per_thread, snat_thread_index);
2444 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2447 snat_session_key_t * k,
2448 u16 port_per_thread, u32 snat_thread_index)
2451 snat_address_t *a, *ga = 0;
2454 for (i = 0; i < vec_len (addresses); i++)
2457 switch (k->protocol)
2459 #define _(N, j, n, s) \
2460 case SNAT_PROTOCOL_##N: \
2461 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
2463 if (a->fib_index == fib_index) \
2467 portnum = (port_per_thread * \
2468 snat_thread_index) + \
2469 snat_random_port(1, port_per_thread) + 1024; \
2470 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2472 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2473 a->busy_##n##_ports_per_thread[thread_index]++; \
2474 a->busy_##n##_ports++; \
2475 k->addr = a->addr; \
2476 k->port = clib_host_to_net_u16(portnum); \
2480 else if (a->fib_index == ~0) \
2486 foreach_snat_protocol
2489 nat_log_info ("unknown protocol");
2498 switch (k->protocol)
2500 #define _(N, j, n, s) \
2501 case SNAT_PROTOCOL_##N: \
2504 portnum = (port_per_thread * \
2505 snat_thread_index) + \
2506 snat_random_port(1, port_per_thread) + 1024; \
2507 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2509 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2510 a->busy_##n##_ports_per_thread[thread_index]++; \
2511 a->busy_##n##_ports++; \
2512 k->addr = a->addr; \
2513 k->port = clib_host_to_net_u16(portnum); \
2517 foreach_snat_protocol
2520 nat_log_info ("unknown protocol");
2525 /* Totally out of translations to use... */
2526 snat_ipfix_logging_addresses_exhausted (0);
2531 nat_alloc_addr_and_port_mape (snat_address_t * addresses,
2534 snat_session_key_t * k,
2535 u16 port_per_thread, u32 snat_thread_index)
2537 snat_main_t *sm = &snat_main;
2538 snat_address_t *a = addresses;
2539 u16 m, ports, portnum, A, j;
2540 m = 16 - (sm->psid_offset + sm->psid_length);
2541 ports = (1 << (16 - sm->psid_length)) - (1 << m);
2543 if (!vec_len (addresses))
2546 switch (k->protocol)
2548 #define _(N, i, n, s) \
2549 case SNAT_PROTOCOL_##N: \
2550 if (a->busy_##n##_ports < ports) \
2554 A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
2555 j = snat_random_port(0, pow2_mask(m)); \
2556 portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
2557 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2559 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2560 a->busy_##n##_ports++; \
2561 k->addr = a->addr; \
2562 k->port = clib_host_to_net_u16 (portnum); \
2567 foreach_snat_protocol
2570 nat_log_info ("unknown protocol");
2575 /* Totally out of translations to use... */
2576 snat_ipfix_logging_addresses_exhausted (0);
2581 nat_alloc_addr_and_port_range (snat_address_t * addresses,
2584 snat_session_key_t * k,
2585 u16 port_per_thread, u32 snat_thread_index)
2587 snat_main_t *sm = &snat_main;
2588 snat_address_t *a = addresses;
2591 ports = sm->end_port - sm->start_port + 1;
2593 if (!vec_len (addresses))
2596 switch (k->protocol)
2598 #define _(N, i, n, s) \
2599 case SNAT_PROTOCOL_##N: \
2600 if (a->busy_##n##_ports < ports) \
2604 portnum = snat_random_port(sm->start_port, sm->end_port); \
2605 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2607 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2608 a->busy_##n##_ports++; \
2609 k->addr = a->addr; \
2610 k->port = clib_host_to_net_u16 (portnum); \
2615 foreach_snat_protocol
2618 nat_log_info ("unknown protocol");
2623 /* Totally out of translations to use... */
2624 snat_ipfix_logging_addresses_exhausted (0);
2629 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
2631 dpo_id_t dpo_v4 = DPO_INVALID;
2632 fib_prefix_t pfx = {
2633 .fp_proto = FIB_PROTOCOL_IP4,
2635 .fp_addr.ip4.as_u32 = addr.as_u32,
2640 nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
2641 fib_table_entry_special_dpo_add (0, &pfx, FIB_SOURCE_PLUGIN_HI,
2642 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
2643 dpo_reset (&dpo_v4);
2647 fib_table_entry_special_remove (0, &pfx, FIB_SOURCE_PLUGIN_HI);
2652 format_session_kvp (u8 * s, va_list * args)
2654 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
2655 snat_session_key_t k;
2659 s = format (s, "%U session-index %llu", format_snat_key, &k, v->value);
2665 format_static_mapping_kvp (u8 * s, va_list * args)
2667 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
2668 snat_session_key_t k;
2672 s = format (s, "%U static-mapping-index %llu",
2673 format_static_mapping_key, &k, v->value);
2679 format_user_kvp (u8 * s, va_list * args)
2681 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
2686 s = format (s, "%U fib %d user-index %llu", format_ip4_address, &k.addr,
2687 k.fib_index, v->value);
2693 format_ed_session_kvp (u8 * s, va_list * args)
2695 clib_bihash_kv_16_8_t *v = va_arg (*args, clib_bihash_kv_16_8_t *);
2698 k.as_u64[0] = v->key[0];
2699 k.as_u64[1] = v->key[1];
2702 format (s, "local %U:%d remote %U:%d proto %U fib %d session-index %llu",
2703 format_ip4_address, &k.l_addr, clib_net_to_host_u16 (k.l_port),
2704 format_ip4_address, &k.r_addr, clib_net_to_host_u16 (k.r_port),
2705 format_ip_protocol, k.proto, k.fib_index, v->value);
2711 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2713 snat_main_t *sm = &snat_main;
2714 u32 next_worker_index = 0;
2717 next_worker_index = sm->first_worker_index;
2718 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
2719 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >> 24);
2721 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
2722 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
2724 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
2726 return next_worker_index;
2730 snat_get_worker_out2in_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2732 snat_main_t *sm = &snat_main;
2735 snat_session_key_t m_key;
2736 clib_bihash_kv_8_8_t kv, value;
2737 snat_static_mapping_t *m;
2739 u32 next_worker_index = 0;
2741 /* first try static mappings without port */
2742 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2744 m_key.addr = ip0->dst_address;
2747 m_key.fib_index = rx_fib_index0;
2748 kv.key = m_key.as_u64;
2749 if (!clib_bihash_search_8_8
2750 (&sm->static_mapping_by_external, &kv, &value))
2752 m = pool_elt_at_index (sm->static_mappings, value.value);
2753 return m->workers[0];
2757 proto = ip_proto_to_snat_proto (ip0->protocol);
2758 udp = ip4_next_header (ip0);
2759 port = udp->dst_port;
2761 if (PREDICT_FALSE (ip4_is_fragment (ip0)))
2763 if (PREDICT_FALSE (nat_reass_is_drop_frag (0)))
2764 return vlib_get_thread_index ();
2766 if (PREDICT_TRUE (!ip4_is_first_fragment (ip0)))
2768 nat_reass_ip4_t *reass;
2770 reass = nat_ip4_reass_find (ip0->src_address, ip0->dst_address,
2771 ip0->fragment_id, ip0->protocol);
2773 if (reass && (reass->thread_index != (u32) ~ 0))
2774 return reass->thread_index;
2776 return vlib_get_thread_index ();
2780 /* unknown protocol */
2781 if (PREDICT_FALSE (proto == ~0))
2783 /* use current thread */
2784 return vlib_get_thread_index ();
2787 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
2789 icmp46_header_t *icmp = (icmp46_header_t *) udp;
2790 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
2791 if (!icmp_is_error_message (icmp))
2792 port = echo->identifier;
2795 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
2796 proto = ip_proto_to_snat_proto (inner_ip->protocol);
2797 void *l4_header = ip4_next_header (inner_ip);
2800 case SNAT_PROTOCOL_ICMP:
2801 icmp = (icmp46_header_t *) l4_header;
2802 echo = (icmp_echo_header_t *) (icmp + 1);
2803 port = echo->identifier;
2805 case SNAT_PROTOCOL_UDP:
2806 case SNAT_PROTOCOL_TCP:
2807 port = ((tcp_udp_header_t *) l4_header)->src_port;
2810 return vlib_get_thread_index ();
2815 /* try static mappings with port */
2816 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2818 m_key.addr = ip0->dst_address;
2819 m_key.port = clib_net_to_host_u16 (port);
2820 m_key.protocol = proto;
2821 m_key.fib_index = rx_fib_index0;
2822 kv.key = m_key.as_u64;
2823 if (!clib_bihash_search_8_8
2824 (&sm->static_mapping_by_external, &kv, &value))
2826 m = pool_elt_at_index (sm->static_mappings, value.value);
2827 return m->workers[0];
2831 /* worker by outside port */
2832 next_worker_index = sm->first_worker_index;
2833 next_worker_index +=
2834 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
2835 return next_worker_index;
2839 nat44_ed_get_worker_out2in_cb (ip4_header_t * ip, u32 rx_fib_index)
2841 snat_main_t *sm = &snat_main;
2842 clib_bihash_kv_8_8_t kv, value;
2843 u32 proto, next_worker_index = 0;
2846 snat_static_mapping_t *m;
2849 /* first try static mappings without port */
2850 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2852 make_sm_kv (&kv, &ip->dst_address, 0, rx_fib_index, 0);
2853 if (!clib_bihash_search_8_8
2854 (&sm->static_mapping_by_external, &kv, &value))
2856 m = pool_elt_at_index (sm->static_mappings, value.value);
2857 return m->workers[0];
2861 proto = ip_proto_to_snat_proto (ip->protocol);
2863 /* unknown protocol */
2864 if (PREDICT_FALSE (proto == ~0))
2866 /* use current thread */
2867 return vlib_get_thread_index ();
2870 udp = ip4_next_header (ip);
2871 port = udp->dst_port;
2873 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
2875 icmp46_header_t *icmp = (icmp46_header_t *) udp;
2876 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
2877 if (!icmp_is_error_message (icmp))
2878 port = echo->identifier;
2881 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
2882 proto = ip_proto_to_snat_proto (inner_ip->protocol);
2883 void *l4_header = ip4_next_header (inner_ip);
2886 case SNAT_PROTOCOL_ICMP:
2887 icmp = (icmp46_header_t *) l4_header;
2888 echo = (icmp_echo_header_t *) (icmp + 1);
2889 port = echo->identifier;
2891 case SNAT_PROTOCOL_UDP:
2892 case SNAT_PROTOCOL_TCP:
2893 port = ((tcp_udp_header_t *) l4_header)->src_port;
2896 return vlib_get_thread_index ();
2901 /* try static mappings with port */
2902 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2904 make_sm_kv (&kv, &ip->dst_address, proto, rx_fib_index,
2905 clib_net_to_host_u16 (port));
2906 if (!clib_bihash_search_8_8
2907 (&sm->static_mapping_by_external, &kv, &value))
2909 m = pool_elt_at_index (sm->static_mappings, value.value);
2910 if (!is_lb_static_mapping (m))
2911 return m->workers[0];
2913 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
2914 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
2916 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
2917 return m->workers[hash & (_vec_len (m->workers) - 1)];
2919 return m->workers[hash % _vec_len (m->workers)];
2923 /* worker by outside port */
2924 next_worker_index = sm->first_worker_index;
2925 next_worker_index +=
2926 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
2928 return next_worker_index;
2931 static clib_error_t *
2932 snat_config (vlib_main_t * vm, unformat_input_t * input)
2934 snat_main_t *sm = &snat_main;
2935 nat66_main_t *nm = &nat66_main;
2936 u32 translation_buckets = 1024;
2937 u32 translation_memory_size = 128 << 20;
2938 u32 user_buckets = 128;
2939 u32 user_memory_size = 64 << 20;
2940 u32 max_translations_per_user = 100;
2941 u32 outside_vrf_id = 0;
2942 u32 outside_ip6_vrf_id = 0;
2943 u32 inside_vrf_id = 0;
2944 u32 static_mapping_buckets = 1024;
2945 u32 static_mapping_memory_size = 64 << 20;
2946 u32 nat64_bib_buckets = 1024;
2947 u32 nat64_bib_memory_size = 128 << 20;
2948 u32 nat64_st_buckets = 2048;
2949 u32 nat64_st_memory_size = 256 << 20;
2950 u8 static_mapping_only = 0;
2951 u8 static_mapping_connection_tracking = 0;
2952 snat_main_per_thread_data_t *tsm;
2953 dslite_main_t *dm = &dslite_main;
2955 sm->deterministic = 0;
2957 sm->endpoint_dependent = 0;
2959 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2962 (input, "translation hash buckets %d", &translation_buckets))
2964 else if (unformat (input, "translation hash memory %d",
2965 &translation_memory_size));
2966 else if (unformat (input, "user hash buckets %d", &user_buckets))
2968 else if (unformat (input, "user hash memory %d", &user_memory_size))
2970 else if (unformat (input, "max translations per user %d",
2971 &max_translations_per_user))
2973 else if (unformat (input, "outside VRF id %d", &outside_vrf_id))
2975 else if (unformat (input, "outside ip6 VRF id %d", &outside_ip6_vrf_id))
2977 else if (unformat (input, "inside VRF id %d", &inside_vrf_id))
2979 else if (unformat (input, "static mapping only"))
2981 static_mapping_only = 1;
2982 if (unformat (input, "connection tracking"))
2983 static_mapping_connection_tracking = 1;
2985 else if (unformat (input, "deterministic"))
2986 sm->deterministic = 1;
2987 else if (unformat (input, "nat64 bib hash buckets %d",
2988 &nat64_bib_buckets))
2990 else if (unformat (input, "nat64 bib hash memory %d",
2991 &nat64_bib_memory_size))
2994 if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
2996 else if (unformat (input, "nat64 st hash memory %d",
2997 &nat64_st_memory_size))
2999 else if (unformat (input, "out2in dpo"))
3001 else if (unformat (input, "dslite ce"))
3002 dslite_set_ce (dm, 1);
3003 else if (unformat (input, "endpoint-dependent"))
3004 sm->endpoint_dependent = 1;
3006 return clib_error_return (0, "unknown input '%U'",
3007 format_unformat_error, input);
3010 if (sm->deterministic && sm->endpoint_dependent)
3011 return clib_error_return (0,
3012 "deterministic and endpoint-dependent modes are mutually exclusive");
3014 if (static_mapping_only && (sm->deterministic || sm->endpoint_dependent))
3015 return clib_error_return (0,
3016 "static mapping only mode available only for simple nat");
3018 if (sm->out2in_dpo && (sm->deterministic || sm->endpoint_dependent))
3019 return clib_error_return (0,
3020 "out2in dpo mode available only for simple nat");
3022 /* for show commands, etc. */
3023 sm->translation_buckets = translation_buckets;
3024 sm->translation_memory_size = translation_memory_size;
3025 /* do not exceed load factor 10 */
3026 sm->max_translations = 10 * translation_buckets;
3027 sm->user_buckets = user_buckets;
3028 sm->user_memory_size = user_memory_size;
3029 sm->max_translations_per_user = max_translations_per_user;
3030 sm->outside_vrf_id = outside_vrf_id;
3031 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
3033 FIB_SOURCE_PLUGIN_HI);
3034 nm->outside_vrf_id = outside_ip6_vrf_id;
3035 nm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6,
3037 FIB_SOURCE_PLUGIN_HI);
3038 sm->inside_vrf_id = inside_vrf_id;
3039 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
3041 FIB_SOURCE_PLUGIN_HI);
3042 sm->static_mapping_only = static_mapping_only;
3043 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
3045 nat64_set_hash (nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
3046 nat64_st_memory_size);
3048 if (sm->deterministic)
3050 sm->in2out_node_index = snat_det_in2out_node.index;
3051 sm->in2out_output_node_index = ~0;
3052 sm->out2in_node_index = snat_det_out2in_node.index;
3053 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
3054 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
3058 if (sm->endpoint_dependent)
3060 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
3061 sm->worker_out2in_cb = nat44_ed_get_worker_out2in_cb;
3062 sm->in2out_node_index = nat44_ed_in2out_node.index;
3063 sm->in2out_output_node_index = nat44_ed_in2out_output_node.index;
3064 sm->out2in_node_index = nat44_ed_out2in_node.index;
3065 sm->icmp_match_in2out_cb = icmp_match_in2out_ed;
3066 sm->icmp_match_out2in_cb = icmp_match_out2in_ed;
3067 nat_affinity_init (vm);
3071 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
3072 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
3073 sm->in2out_node_index = snat_in2out_node.index;
3074 sm->in2out_output_node_index = snat_in2out_output_node.index;
3075 sm->out2in_node_index = snat_out2in_node.index;
3076 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
3077 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
3079 if (!static_mapping_only ||
3080 (static_mapping_only && static_mapping_connection_tracking))
3083 vec_foreach (tsm, sm->per_thread_data)
3085 if (sm->endpoint_dependent)
3087 clib_bihash_init_16_8 (&tsm->in2out_ed, "in2out-ed",
3088 translation_buckets,
3089 translation_memory_size);
3090 clib_bihash_set_kvp_format_fn_16_8 (&tsm->in2out_ed,
3091 format_ed_session_kvp);
3093 clib_bihash_init_16_8 (&tsm->out2in_ed, "out2in-ed",
3094 translation_buckets,
3095 translation_memory_size);
3096 clib_bihash_set_kvp_format_fn_16_8 (&tsm->out2in_ed,
3097 format_ed_session_kvp);
3101 clib_bihash_init_8_8 (&tsm->in2out, "in2out",
3102 translation_buckets,
3103 translation_memory_size);
3104 clib_bihash_set_kvp_format_fn_8_8 (&tsm->in2out,
3105 format_session_kvp);
3107 clib_bihash_init_8_8 (&tsm->out2in, "out2in",
3108 translation_buckets,
3109 translation_memory_size);
3110 clib_bihash_set_kvp_format_fn_8_8 (&tsm->out2in,
3111 format_session_kvp);
3114 clib_bihash_init_8_8 (&tsm->user_hash, "users", user_buckets,
3116 clib_bihash_set_kvp_format_fn_8_8 (&tsm->user_hash,
3124 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
3125 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
3127 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
3128 "static_mapping_by_local", static_mapping_buckets,
3129 static_mapping_memory_size);
3130 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_local,
3131 format_static_mapping_kvp);
3133 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
3134 "static_mapping_by_external",
3135 static_mapping_buckets,
3136 static_mapping_memory_size);
3137 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_external,
3138 format_static_mapping_kvp);
3144 VLIB_CONFIG_FUNCTION (snat_config, "nat");
3147 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
3150 ip4_address_t * address,
3152 u32 if_address_index, u32 is_delete)
3154 snat_main_t *sm = &snat_main;
3155 snat_static_map_resolve_t *rp;
3156 snat_static_mapping_t *m;
3157 snat_session_key_t m_key;
3158 clib_bihash_kv_8_8_t kv, value;
3160 ip4_address_t l_addr;
3162 for (i = 0; i < vec_len (sm->to_resolve); i++)
3164 rp = sm->to_resolve + i;
3165 if (rp->addr_only == 0)
3167 if (rp->sw_if_index == sw_if_index)
3174 m_key.addr.as_u32 = address->as_u32;
3175 m_key.port = rp->addr_only ? 0 : rp->e_port;
3176 m_key.protocol = rp->addr_only ? 0 : rp->proto;
3177 m_key.fib_index = sm->outside_fib_index;
3178 kv.key = m_key.as_u64;
3179 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
3182 m = pool_elt_at_index (sm->static_mappings, value.value);
3186 /* Don't trip over lease renewal, static config */
3196 /* Indetity mapping? */
3197 if (rp->l_addr.as_u32 == 0)
3198 l_addr.as_u32 = address[0].as_u32;
3200 l_addr.as_u32 = rp->l_addr.as_u32;
3201 /* Add the static mapping */
3202 rv = snat_add_static_mapping (l_addr,
3207 rp->addr_only, ~0 /* sw_if_index */ ,
3208 rp->proto, !is_delete, rp->twice_nat,
3209 rp->out2in_only, rp->tag, rp->identity_nat);
3211 nat_log_notice ("snat_add_static_mapping returned %d", rv);
3215 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
3218 ip4_address_t * address,
3220 u32 if_address_index, u32 is_delete)
3222 snat_main_t *sm = &snat_main;
3223 snat_static_map_resolve_t *rp;
3224 ip4_address_t l_addr;
3228 snat_address_t *addresses = sm->addresses;
3230 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices); i++)
3232 if (sw_if_index == sm->auto_add_sw_if_indices[i])
3236 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices_twice_nat); i++)
3239 addresses = sm->twice_nat_addresses;
3240 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
3249 /* Don't trip over lease renewal, static config */
3250 for (j = 0; j < vec_len (addresses); j++)
3251 if (addresses[j].addr.as_u32 == address->as_u32)
3254 (void) snat_add_address (sm, address, ~0, twice_nat);
3255 /* Scan static map resolution vector */
3256 for (j = 0; j < vec_len (sm->to_resolve); j++)
3258 rp = sm->to_resolve + j;
3261 /* On this interface? */
3262 if (rp->sw_if_index == sw_if_index)
3264 /* Indetity mapping? */
3265 if (rp->l_addr.as_u32 == 0)
3266 l_addr.as_u32 = address[0].as_u32;
3268 l_addr.as_u32 = rp->l_addr.as_u32;
3269 /* Add the static mapping */
3270 rv = snat_add_static_mapping (l_addr,
3276 ~0 /* sw_if_index */ ,
3278 rp->is_add, rp->twice_nat,
3279 rp->out2in_only, rp->tag,
3282 nat_log_notice ("snat_add_static_mapping returned %d", rv);
3289 (void) snat_del_address (sm, address[0], 1, twice_nat);
3296 snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
3299 ip4_main_t *ip4_main = sm->ip4_main;
3300 ip4_address_t *first_int_addr;
3301 snat_static_map_resolve_t *rp;
3302 u32 *indices_to_delete = 0;
3304 u32 *auto_add_sw_if_indices =
3306 auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
3308 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0 /* just want the address */
3311 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
3313 if (auto_add_sw_if_indices[i] == sw_if_index)
3317 /* if have address remove it */
3319 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
3322 for (j = 0; j < vec_len (sm->to_resolve); j++)
3324 rp = sm->to_resolve + j;
3325 if (rp->sw_if_index == sw_if_index)
3326 vec_add1 (indices_to_delete, j);
3328 if (vec_len (indices_to_delete))
3330 for (j = vec_len (indices_to_delete) - 1; j >= 0; j--)
3331 vec_del1 (sm->to_resolve, j);
3332 vec_free (indices_to_delete);
3336 vec_del1 (sm->auto_add_sw_if_indices_twice_nat, i);
3338 vec_del1 (sm->auto_add_sw_if_indices, i);
3341 return VNET_API_ERROR_VALUE_EXIST;
3348 return VNET_API_ERROR_NO_SUCH_ENTRY;
3350 /* add to the auto-address list */
3352 vec_add1 (sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
3354 vec_add1 (sm->auto_add_sw_if_indices, sw_if_index);
3356 /* If the address is already bound - or static - add it now */
3358 (void) snat_add_address (sm, first_int_addr, ~0, twice_nat);
3364 nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
3365 snat_protocol_t proto, u32 vrf_id, int is_in)
3367 snat_main_per_thread_data_t *tsm;
3368 clib_bihash_kv_8_8_t kv, value;
3370 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3371 snat_session_key_t key;
3373 clib_bihash_8_8_t *t;
3375 if (sm->endpoint_dependent)
3376 return VNET_API_ERROR_UNSUPPORTED;
3378 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
3379 if (sm->num_workers > 1)
3381 vec_elt_at_index (sm->per_thread_data,
3382 sm->worker_in2out_cb (&ip, fib_index));
3384 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
3386 key.addr.as_u32 = addr->as_u32;
3387 key.port = clib_host_to_net_u16 (port);
3388 key.protocol = proto;
3389 key.fib_index = fib_index;
3390 kv.key = key.as_u64;
3391 t = is_in ? &tsm->in2out : &tsm->out2in;
3392 if (!clib_bihash_search_8_8 (t, &kv, &value))
3394 if (pool_is_free_index (tsm->sessions, value.value))
3395 return VNET_API_ERROR_UNSPECIFIED;
3397 s = pool_elt_at_index (tsm->sessions, value.value);
3398 nat_free_session_data (sm, s, tsm - sm->per_thread_data);
3399 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
3403 return VNET_API_ERROR_NO_SUCH_ENTRY;
3407 nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
3408 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3409 u32 vrf_id, int is_in)
3412 clib_bihash_16_8_t *t;
3413 nat_ed_ses_key_t key;
3414 clib_bihash_kv_16_8_t kv, value;
3415 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3417 snat_main_per_thread_data_t *tsm;
3419 if (!sm->endpoint_dependent)
3420 return VNET_API_ERROR_FEATURE_DISABLED;
3422 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
3423 if (sm->num_workers > 1)
3425 vec_elt_at_index (sm->per_thread_data,
3426 sm->worker_in2out_cb (&ip, fib_index));
3428 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
3430 t = is_in ? &tsm->in2out_ed : &tsm->out2in_ed;
3431 key.l_addr.as_u32 = addr->as_u32;
3432 key.r_addr.as_u32 = eh_addr->as_u32;
3433 key.l_port = clib_host_to_net_u16 (port);
3434 key.r_port = clib_host_to_net_u16 (eh_port);
3436 key.fib_index = fib_index;
3437 kv.key[0] = key.as_u64[0];
3438 kv.key[1] = key.as_u64[1];
3439 if (clib_bihash_search_16_8 (t, &kv, &value))
3440 return VNET_API_ERROR_NO_SUCH_ENTRY;
3442 if (pool_is_free_index (tsm->sessions, value.value))
3443 return VNET_API_ERROR_UNSPECIFIED;
3444 s = pool_elt_at_index (tsm->sessions, value.value);
3445 nat_free_session_data (sm, s, tsm - sm->per_thread_data);
3446 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
3451 nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset, u16 psid_length)
3453 snat_main_t *sm = &snat_main;
3455 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_MAPE;
3456 sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
3458 sm->psid_offset = psid_offset;
3459 sm->psid_length = psid_length;
3463 nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port)
3465 snat_main_t *sm = &snat_main;
3467 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_RANGE;
3468 sm->alloc_addr_and_port = nat_alloc_addr_and_port_range;
3469 sm->start_port = start_port;
3470 sm->end_port = end_port;
3474 nat_set_alloc_addr_and_port_default (void)
3476 snat_main_t *sm = &snat_main;
3478 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
3479 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
3483 * fd.io coding-style-patch-verification: ON
3486 * eval: (c-set-style "gnu")