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 ASSERT (vec_len (locals) > 1);
1580 local = pool_elt_at_index (m->locals, locals[0]);
1581 local->prefix = local->probability;
1582 for (i = 1; i < vec_len (locals); i++)
1584 local = pool_elt_at_index (m->locals, locals[i]);
1585 prev_local = pool_elt_at_index (m->locals, locals[i - 1]);
1586 local->prefix = local->probability + prev_local->prefix;
1589 /* Assign workers */
1590 if (sm->num_workers > 1)
1593 clib_bitmap_foreach (i, bitmap, ({ vec_add1(m->workers, i); }));
1601 snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
1604 snat_address_t *a = 0;
1605 snat_session_t *ses;
1606 u32 *ses_to_be_removed = 0, *ses_index;
1607 snat_main_per_thread_data_t *tsm;
1608 snat_static_mapping_t *m;
1609 snat_interface_t *interface;
1611 snat_address_t *addresses =
1612 twice_nat ? sm->twice_nat_addresses : sm->addresses;
1614 /* Find SNAT address */
1615 for (i = 0; i < vec_len (addresses); i++)
1617 if (addresses[i].addr.as_u32 == addr.as_u32)
1624 return VNET_API_ERROR_NO_SUCH_ENTRY;
1629 pool_foreach (m, sm->static_mappings,
1631 if (m->external_addr.as_u32 == addr.as_u32)
1632 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1633 m->local_port, m->external_port,
1634 m->vrf_id, is_addr_only_static_mapping(m), ~0,
1635 m->proto, 0, m->twice_nat,
1636 is_out2in_only_static_mapping(m), m->tag, is_identity_static_mapping(m));
1642 /* Check if address is used in some static mapping */
1643 if (is_snat_address_used_in_static_mapping (sm, addr))
1645 nat_log_notice ("address used in static mapping");
1646 return VNET_API_ERROR_UNSPECIFIED;
1650 if (a->fib_index != ~0)
1651 fib_table_unlock (a->fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_PLUGIN_LOW);
1653 /* Delete sessions using address */
1654 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1657 vec_foreach (tsm, sm->per_thread_data)
1659 pool_foreach (ses, tsm->sessions, ({
1660 if (ses->out2in.addr.as_u32 == addr.as_u32)
1662 nat_free_session_data (sm, ses, tsm - sm->per_thread_data);
1663 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1667 vec_foreach (ses_index, ses_to_be_removed)
1669 ses = pool_elt_at_index (tsm->sessions, ses_index[0]);
1670 nat44_delete_session (sm, ses, tsm - sm->per_thread_data);
1673 vec_free (ses_to_be_removed);
1678 #define _(N, i, n, s) \
1679 clib_bitmap_free (a->busy_##n##_port_bitmap); \
1680 vec_free (a->busy_##n##_ports_per_thread);
1681 foreach_snat_protocol
1685 vec_del1 (sm->twice_nat_addresses, i);
1689 vec_del1 (sm->addresses, i);
1691 /* Delete external address from FIB */
1693 pool_foreach (interface, sm->interfaces,
1695 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1698 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1701 pool_foreach (interface, sm->output_feature_interfaces,
1703 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1706 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1715 snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1717 snat_main_t *sm = &snat_main;
1718 snat_interface_t *i;
1719 const char *feature_name, *del_feature_name;
1721 snat_static_mapping_t *m;
1723 nat_outside_fib_t *outside_fib;
1724 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1727 if (sm->out2in_dpo && !is_inside)
1728 return VNET_API_ERROR_UNSUPPORTED;
1731 pool_foreach (i, sm->output_feature_interfaces,
1733 if (i->sw_if_index == sw_if_index)
1734 return VNET_API_ERROR_VALUE_EXIST;
1738 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1739 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1742 if (sm->num_workers > 1 && !sm->deterministic)
1744 is_inside ? "nat44-in2out-worker-handoff" :
1745 "nat44-out2in-worker-handoff";
1746 else if (sm->deterministic)
1747 feature_name = is_inside ? "nat44-det-in2out" : "nat44-det-out2in";
1748 else if (sm->endpoint_dependent)
1749 feature_name = is_inside ? "nat44-ed-in2out" : "nat44-ed-out2in";
1751 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1754 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1755 sm->fq_in2out_index = vlib_frame_queue_main_init (sm->in2out_node_index,
1758 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1759 sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index,
1765 vec_foreach (outside_fib, sm->outside_fibs)
1767 if (outside_fib->fib_index == fib_index)
1771 outside_fib->refcount--;
1772 if (!outside_fib->refcount)
1773 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
1776 outside_fib->refcount++;
1783 vec_add2 (sm->outside_fibs, outside_fib, 1);
1784 outside_fib->refcount = 1;
1785 outside_fib->fib_index = fib_index;
1790 pool_foreach (i, sm->interfaces,
1792 if (i->sw_if_index == sw_if_index)
1796 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1799 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1801 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1803 if (sm->num_workers > 1 && !sm->deterministic)
1805 del_feature_name = "nat44-handoff-classify";
1806 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1807 "nat44-out2in-worker-handoff";
1809 else if (sm->deterministic)
1811 del_feature_name = "nat44-det-classify";
1812 feature_name = !is_inside ? "nat44-det-in2out" :
1815 else if (sm->endpoint_dependent)
1817 del_feature_name = "nat44-ed-classify";
1818 feature_name = !is_inside ? "nat44-ed-in2out" :
1823 del_feature_name = "nat44-classify";
1824 feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1827 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1828 sw_if_index, 0, 0, 0);
1829 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1830 sw_if_index, 1, 0, 0);
1833 if (sm->endpoint_dependent)
1834 vnet_feature_enable_disable ("ip4-local",
1835 "nat44-ed-hairpinning",
1836 sw_if_index, 1, 0, 0);
1837 else if (!sm->deterministic)
1838 vnet_feature_enable_disable ("ip4-local",
1839 "nat44-hairpinning",
1840 sw_if_index, 1, 0, 0);
1845 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1846 sw_if_index, 0, 0, 0);
1847 pool_put (sm->interfaces, i);
1850 if (sm->endpoint_dependent)
1851 vnet_feature_enable_disable ("ip4-local",
1852 "nat44-ed-hairpinning",
1853 sw_if_index, 0, 0, 0);
1854 else if (!sm->deterministic)
1855 vnet_feature_enable_disable ("ip4-local",
1856 "nat44-hairpinning",
1857 sw_if_index, 0, 0, 0);
1863 if ((nat_interface_is_inside(i) && is_inside) ||
1864 (nat_interface_is_outside(i) && !is_inside))
1867 if (sm->num_workers > 1 && !sm->deterministic)
1869 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1870 "nat44-out2in-worker-handoff";
1871 feature_name = "nat44-handoff-classify";
1873 else if (sm->deterministic)
1875 del_feature_name = !is_inside ? "nat44-det-in2out" :
1877 feature_name = "nat44-det-classify";
1879 else if (sm->endpoint_dependent)
1881 del_feature_name = !is_inside ? "nat44-ed-in2out" :
1883 feature_name = "nat44-ed-classify";
1887 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1888 feature_name = "nat44-classify";
1891 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1892 sw_if_index, 0, 0, 0);
1893 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1894 sw_if_index, 1, 0, 0);
1897 if (sm->endpoint_dependent)
1898 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
1899 sw_if_index, 0, 0, 0);
1900 else if (!sm->deterministic)
1901 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1902 sw_if_index, 0, 0, 0);
1913 return VNET_API_ERROR_NO_SUCH_ENTRY;
1915 pool_get (sm->interfaces, i);
1916 i->sw_if_index = sw_if_index;
1918 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0,
1921 if (is_inside && !sm->out2in_dpo)
1923 if (sm->endpoint_dependent)
1924 vnet_feature_enable_disable ("ip4-local", "nat44-ed-hairpinning",
1925 sw_if_index, 1, 0, 0);
1926 else if (!sm->deterministic)
1927 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1928 sw_if_index, 1, 0, 0);
1934 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1938 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1940 /* Add/delete external addresses to FIB */
1943 vec_foreach (ap, sm->addresses)
1944 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1946 pool_foreach (m, sm->static_mappings,
1948 if (!(is_addr_only_static_mapping(m)) || (m->local_addr.as_u32 == m->external_addr.as_u32))
1951 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1954 pool_foreach (dm, sm->det_maps,
1956 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
1964 snat_interface_add_del_output_feature (u32 sw_if_index,
1965 u8 is_inside, int is_del)
1967 snat_main_t *sm = &snat_main;
1968 snat_interface_t *i;
1970 snat_static_mapping_t *m;
1971 nat_outside_fib_t *outside_fib;
1972 u32 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
1976 if (sm->deterministic ||
1977 (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
1978 return VNET_API_ERROR_UNSUPPORTED;
1981 pool_foreach (i, sm->interfaces,
1983 if (i->sw_if_index == sw_if_index)
1984 return VNET_API_ERROR_VALUE_EXIST;
1991 vec_foreach (outside_fib, sm->outside_fibs)
1993 if (outside_fib->fib_index == fib_index)
1997 outside_fib->refcount--;
1998 if (!outside_fib->refcount)
1999 vec_del1 (sm->outside_fibs, outside_fib - sm->outside_fibs);
2002 outside_fib->refcount++;
2009 vec_add2 (sm->outside_fibs, outside_fib, 1);
2010 outside_fib->refcount = 1;
2011 outside_fib->fib_index = fib_index;
2018 if (sm->endpoint_dependent)
2020 vnet_feature_enable_disable ("ip4-unicast", "nat44-ed-hairpin-dst",
2021 sw_if_index, !is_del, 0, 0);
2022 vnet_feature_enable_disable ("ip4-output", "nat44-ed-hairpin-src",
2023 sw_if_index, !is_del, 0, 0);
2027 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
2028 sw_if_index, !is_del, 0, 0);
2029 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
2030 sw_if_index, !is_del, 0, 0);
2035 if (sm->num_workers > 1)
2037 vnet_feature_enable_disable ("ip4-unicast",
2038 "nat44-out2in-worker-handoff",
2039 sw_if_index, !is_del, 0, 0);
2040 vnet_feature_enable_disable ("ip4-output",
2041 "nat44-in2out-output-worker-handoff",
2042 sw_if_index, !is_del, 0, 0);
2046 if (sm->endpoint_dependent)
2048 vnet_feature_enable_disable ("ip4-unicast", "nat44-ed-out2in",
2049 sw_if_index, !is_del, 0, 0);
2050 vnet_feature_enable_disable ("ip4-output", "nat44-ed-in2out-output",
2051 sw_if_index, !is_del, 0, 0);
2055 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in",
2056 sw_if_index, !is_del, 0, 0);
2057 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
2058 sw_if_index, !is_del, 0, 0);
2063 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
2064 sm->fq_in2out_output_index =
2065 vlib_frame_queue_main_init (sm->in2out_output_node_index, 0);
2067 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
2068 sm->fq_out2in_index =
2069 vlib_frame_queue_main_init (sm->out2in_node_index, 0);
2072 pool_foreach (i, sm->output_feature_interfaces,
2074 if (i->sw_if_index == sw_if_index)
2077 pool_put (sm->output_feature_interfaces, i);
2079 return VNET_API_ERROR_VALUE_EXIST;
2087 return VNET_API_ERROR_NO_SUCH_ENTRY;
2089 pool_get (sm->output_feature_interfaces, i);
2090 i->sw_if_index = sw_if_index;
2093 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
2095 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
2097 /* Add/delete external addresses to FIB */
2103 vec_foreach (ap, sm->addresses)
2104 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
2106 pool_foreach (m, sm->static_mappings,
2108 if (!((is_addr_only_static_mapping(m))) || (m->local_addr.as_u32 == m->external_addr.as_u32))
2111 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
2119 snat_set_workers (uword * bitmap)
2121 snat_main_t *sm = &snat_main;
2124 if (sm->num_workers < 2)
2125 return VNET_API_ERROR_FEATURE_DISABLED;
2127 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
2128 return VNET_API_ERROR_INVALID_WORKER;
2130 vec_free (sm->workers);
2132 clib_bitmap_foreach (i, bitmap,
2134 vec_add1(sm->workers, i);
2135 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
2140 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
2141 sm->num_snat_thread = _vec_len (sm->workers);
2148 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2151 ip4_address_t * address,
2153 u32 if_address_index, u32 is_delete);
2156 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
2159 ip4_address_t * address,
2161 u32 if_address_index, u32 is_delete);
2164 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2167 snat_session_key_t * k,
2168 u16 port_per_thread, u32 snat_thread_index);
2170 static clib_error_t *
2171 snat_init (vlib_main_t * vm)
2173 snat_main_t *sm = &snat_main;
2174 clib_error_t *error = 0;
2175 ip4_main_t *im = &ip4_main;
2176 ip_lookup_main_t *lm = &im->lookup_main;
2178 vlib_thread_registration_t *tr;
2179 vlib_thread_main_t *tm = vlib_get_thread_main ();
2182 ip4_add_del_interface_address_callback_t cb4;
2183 vlib_node_t *error_drop_node;
2186 sm->vnet_main = vnet_get_main ();
2188 sm->ip4_lookup_main = lm;
2189 sm->api_main = &api_main;
2190 sm->first_worker_index = 0;
2191 sm->num_workers = 0;
2192 sm->num_snat_thread = 1;
2194 sm->port_per_thread = 0xffff - 1024;
2195 sm->fq_in2out_index = ~0;
2196 sm->fq_out2in_index = ~0;
2197 sm->udp_timeout = SNAT_UDP_TIMEOUT;
2198 sm->tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
2199 sm->tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
2200 sm->icmp_timeout = SNAT_ICMP_TIMEOUT;
2201 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
2202 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
2203 sm->forwarding_enabled = 0;
2204 sm->log_class = vlib_log_register_class ("nat", 0);
2205 error_drop_node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
2206 sm->error_node_index = error_drop_node->index;
2207 sm->mss_clamping = 0;
2209 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
2212 tr = (vlib_thread_registration_t *) p[0];
2215 sm->num_workers = tr->count;
2216 sm->first_worker_index = tr->first_index;
2220 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2222 /* Use all available workers by default */
2223 if (sm->num_workers > 1)
2225 for (i = 0; i < sm->num_workers; i++)
2226 bitmap = clib_bitmap_set (bitmap, i, 1);
2227 snat_set_workers (bitmap);
2228 clib_bitmap_free (bitmap);
2232 sm->per_thread_data[0].snat_thread_index = 0;
2235 error = snat_api_init (vm, sm);
2239 /* Set up the interface address add/del callback */
2240 cb4.function = snat_ip4_add_del_interface_address_cb;
2241 cb4.function_opaque = 0;
2243 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2245 cb4.function = nat_ip4_add_del_addr_only_sm_cb;
2246 cb4.function_opaque = 0;
2248 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2250 nat_dpo_module_init ();
2253 sm->total_users.name = "total-users";
2254 sm->total_users.stat_segment_name = "/nat44/total-users";
2255 vlib_validate_simple_counter (&sm->total_users, 0);
2256 vlib_zero_simple_counter (&sm->total_users, 0);
2257 sm->total_sessions.name = "total-sessions";
2258 sm->total_sessions.stat_segment_name = "/nat44/total-sessions";
2259 vlib_validate_simple_counter (&sm->total_sessions, 0);
2260 vlib_zero_simple_counter (&sm->total_sessions, 0);
2262 /* Init IPFIX logging */
2263 snat_ipfix_logging_init (vm);
2266 error = nat64_init (vm);
2274 /* Init virtual fragmenentation reassembly */
2275 return nat_reass_init (vm);
2278 VLIB_INIT_FUNCTION (snat_init);
2281 snat_free_outside_address_and_port (snat_address_t * addresses,
2282 u32 thread_index, snat_session_key_t * k)
2286 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2288 for (address_index = 0; address_index < vec_len (addresses);
2291 if (addresses[address_index].addr.as_u32 == k->addr.as_u32)
2295 ASSERT (address_index < vec_len (addresses));
2297 a = addresses + address_index;
2299 switch (k->protocol)
2301 #define _(N, i, n, s) \
2302 case SNAT_PROTOCOL_##N: \
2303 ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
2304 port_host_byte_order) == 1); \
2305 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
2306 port_host_byte_order, 0); \
2307 a->busy_##n##_ports--; \
2308 a->busy_##n##_ports_per_thread[thread_index]--; \
2310 foreach_snat_protocol
2313 nat_log_info ("unknown protocol");
2319 snat_static_mapping_match (snat_main_t * sm,
2320 snat_session_key_t match,
2321 snat_session_key_t * mapping,
2324 twice_nat_type_t * twice_nat,
2325 lb_nat_type_t * lb, ip4_address_t * ext_host_addr,
2326 u8 * is_identity_nat)
2328 clib_bihash_kv_8_8_t kv, value;
2329 snat_static_mapping_t *m;
2330 snat_session_key_t m_key;
2331 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
2332 u32 rand, lo = 0, hi, mid, *tmp = 0, i;
2334 nat44_lb_addr_port_t *local;
2336 m_key.fib_index = match.fib_index;
2339 mapping_hash = &sm->static_mapping_by_external;
2340 m_key.fib_index = 0;
2343 m_key.addr = match.addr;
2344 m_key.port = clib_net_to_host_u16 (match.port);
2345 m_key.protocol = match.protocol;
2347 kv.key = m_key.as_u64;
2349 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2351 /* Try address only mapping */
2354 kv.key = m_key.as_u64;
2355 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2359 m = pool_elt_at_index (sm->static_mappings, value.value);
2363 if (is_lb_static_mapping (m))
2365 if (PREDICT_FALSE (lb != 0))
2366 *lb = m->affinity ? AFFINITY_LB_NAT : LB_NAT;
2369 if (nat_affinity_find_and_lock (ext_host_addr[0], match.addr,
2370 match.protocol, match.port,
2374 local = pool_elt_at_index (m->locals, backend_index);
2375 mapping->addr = local->addr;
2376 mapping->port = clib_host_to_net_u16 (local->port);
2377 mapping->fib_index = local->fib_index;
2382 pool_foreach_index (i, m->locals,
2387 hi = vec_len (tmp) - 1;
2388 local = pool_elt_at_index (m->locals, tmp[hi]);
2389 rand = 1 + (random_u32 (&sm->random_seed) % local->prefix);
2392 mid = ((hi - lo) >> 1) + lo;
2393 local = pool_elt_at_index (m->locals, tmp[mid]);
2394 (rand > local->prefix) ? (lo = mid + 1) : (hi = mid);
2396 local = pool_elt_at_index (m->locals, tmp[lo]);
2397 if (!(local->prefix >= rand))
2399 if (PREDICT_FALSE (sm->num_workers > 1))
2402 .src_address = local->addr,
2404 if (sm->worker_in2out_cb (&ip, m->fib_index) !=
2405 vlib_get_thread_index ())
2408 mapping->addr = local->addr;
2409 mapping->port = clib_host_to_net_u16 (local->port);
2410 mapping->fib_index = local->fib_index;
2413 if (nat_affinity_create_and_lock (ext_host_addr[0], match.addr,
2414 match.protocol, match.port,
2415 tmp[lo], m->affinity,
2416 m->affinity_per_service_list_head_index))
2417 nat_log_info ("create affinity record failed");
2423 if (PREDICT_FALSE (lb != 0))
2425 mapping->fib_index = m->fib_index;
2426 mapping->addr = m->local_addr;
2427 /* Address only mapping doesn't change port */
2428 mapping->port = is_addr_only_static_mapping (m) ? match.port
2429 : clib_host_to_net_u16 (m->local_port);
2431 mapping->protocol = m->proto;
2435 mapping->addr = m->external_addr;
2436 /* Address only mapping doesn't change port */
2437 mapping->port = is_addr_only_static_mapping (m) ? match.port
2438 : clib_host_to_net_u16 (m->external_port);
2439 mapping->fib_index = sm->outside_fib_index;
2443 if (PREDICT_FALSE (is_addr_only != 0))
2444 *is_addr_only = is_addr_only_static_mapping (m);
2446 if (PREDICT_FALSE (twice_nat != 0))
2447 *twice_nat = m->twice_nat;
2449 if (PREDICT_FALSE (is_identity_nat != 0))
2450 *is_identity_nat = is_identity_static_mapping (m);
2455 static_always_inline u16
2456 snat_random_port (u16 min, u16 max)
2458 snat_main_t *sm = &snat_main;
2459 return min + random_u32 (&sm->random_seed) /
2460 (random_u32_max () / (max - min + 1) + 1);
2464 snat_alloc_outside_address_and_port (snat_address_t * addresses,
2467 snat_session_key_t * k,
2468 u16 port_per_thread,
2469 u32 snat_thread_index)
2471 snat_main_t *sm = &snat_main;
2473 return sm->alloc_addr_and_port (addresses, fib_index, thread_index, k,
2474 port_per_thread, snat_thread_index);
2478 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2481 snat_session_key_t * k,
2482 u16 port_per_thread, u32 snat_thread_index)
2485 snat_address_t *a, *ga = 0;
2488 for (i = 0; i < vec_len (addresses); i++)
2491 switch (k->protocol)
2493 #define _(N, j, n, s) \
2494 case SNAT_PROTOCOL_##N: \
2495 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
2497 if (a->fib_index == fib_index) \
2501 portnum = (port_per_thread * \
2502 snat_thread_index) + \
2503 snat_random_port(1, port_per_thread) + 1024; \
2504 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2506 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2507 a->busy_##n##_ports_per_thread[thread_index]++; \
2508 a->busy_##n##_ports++; \
2509 k->addr = a->addr; \
2510 k->port = clib_host_to_net_u16(portnum); \
2514 else if (a->fib_index == ~0) \
2520 foreach_snat_protocol
2523 nat_log_info ("unknown protocol");
2532 switch (k->protocol)
2534 #define _(N, j, n, s) \
2535 case SNAT_PROTOCOL_##N: \
2538 portnum = (port_per_thread * \
2539 snat_thread_index) + \
2540 snat_random_port(1, port_per_thread) + 1024; \
2541 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2543 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2544 a->busy_##n##_ports_per_thread[thread_index]++; \
2545 a->busy_##n##_ports++; \
2546 k->addr = a->addr; \
2547 k->port = clib_host_to_net_u16(portnum); \
2551 foreach_snat_protocol
2554 nat_log_info ("unknown protocol");
2559 /* Totally out of translations to use... */
2560 snat_ipfix_logging_addresses_exhausted (0);
2565 nat_alloc_addr_and_port_mape (snat_address_t * addresses,
2568 snat_session_key_t * k,
2569 u16 port_per_thread, u32 snat_thread_index)
2571 snat_main_t *sm = &snat_main;
2572 snat_address_t *a = addresses;
2573 u16 m, ports, portnum, A, j;
2574 m = 16 - (sm->psid_offset + sm->psid_length);
2575 ports = (1 << (16 - sm->psid_length)) - (1 << m);
2577 if (!vec_len (addresses))
2580 switch (k->protocol)
2582 #define _(N, i, n, s) \
2583 case SNAT_PROTOCOL_##N: \
2584 if (a->busy_##n##_ports < ports) \
2588 A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
2589 j = snat_random_port(0, pow2_mask(m)); \
2590 portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
2591 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2593 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2594 a->busy_##n##_ports++; \
2595 k->addr = a->addr; \
2596 k->port = clib_host_to_net_u16 (portnum); \
2601 foreach_snat_protocol
2604 nat_log_info ("unknown protocol");
2609 /* Totally out of translations to use... */
2610 snat_ipfix_logging_addresses_exhausted (0);
2615 nat_alloc_addr_and_port_range (snat_address_t * addresses,
2618 snat_session_key_t * k,
2619 u16 port_per_thread, u32 snat_thread_index)
2621 snat_main_t *sm = &snat_main;
2622 snat_address_t *a = addresses;
2625 ports = sm->end_port - sm->start_port + 1;
2627 if (!vec_len (addresses))
2630 switch (k->protocol)
2632 #define _(N, i, n, s) \
2633 case SNAT_PROTOCOL_##N: \
2634 if (a->busy_##n##_ports < ports) \
2638 portnum = snat_random_port(sm->start_port, sm->end_port); \
2639 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2641 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2642 a->busy_##n##_ports++; \
2643 k->addr = a->addr; \
2644 k->port = clib_host_to_net_u16 (portnum); \
2649 foreach_snat_protocol
2652 nat_log_info ("unknown protocol");
2657 /* Totally out of translations to use... */
2658 snat_ipfix_logging_addresses_exhausted (0);
2663 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
2665 dpo_id_t dpo_v4 = DPO_INVALID;
2666 fib_prefix_t pfx = {
2667 .fp_proto = FIB_PROTOCOL_IP4,
2669 .fp_addr.ip4.as_u32 = addr.as_u32,
2674 nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
2675 fib_table_entry_special_dpo_add (0, &pfx, FIB_SOURCE_PLUGIN_HI,
2676 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
2677 dpo_reset (&dpo_v4);
2681 fib_table_entry_special_remove (0, &pfx, FIB_SOURCE_PLUGIN_HI);
2686 format_session_kvp (u8 * s, va_list * args)
2688 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
2689 snat_session_key_t k;
2693 s = format (s, "%U session-index %llu", format_snat_key, &k, v->value);
2699 format_static_mapping_kvp (u8 * s, va_list * args)
2701 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
2702 snat_session_key_t k;
2706 s = format (s, "%U static-mapping-index %llu",
2707 format_static_mapping_key, &k, v->value);
2713 format_user_kvp (u8 * s, va_list * args)
2715 clib_bihash_kv_8_8_t *v = va_arg (*args, clib_bihash_kv_8_8_t *);
2720 s = format (s, "%U fib %d user-index %llu", format_ip4_address, &k.addr,
2721 k.fib_index, v->value);
2727 format_ed_session_kvp (u8 * s, va_list * args)
2729 clib_bihash_kv_16_8_t *v = va_arg (*args, clib_bihash_kv_16_8_t *);
2732 k.as_u64[0] = v->key[0];
2733 k.as_u64[1] = v->key[1];
2736 format (s, "local %U:%d remote %U:%d proto %U fib %d session-index %llu",
2737 format_ip4_address, &k.l_addr, clib_net_to_host_u16 (k.l_port),
2738 format_ip4_address, &k.r_addr, clib_net_to_host_u16 (k.r_port),
2739 format_ip_protocol, k.proto, k.fib_index, v->value);
2745 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2747 snat_main_t *sm = &snat_main;
2748 u32 next_worker_index = 0;
2751 next_worker_index = sm->first_worker_index;
2752 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
2753 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >> 24);
2755 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
2756 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
2758 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
2760 return next_worker_index;
2764 snat_get_worker_out2in_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2766 snat_main_t *sm = &snat_main;
2769 snat_session_key_t m_key;
2770 clib_bihash_kv_8_8_t kv, value;
2771 snat_static_mapping_t *m;
2773 u32 next_worker_index = 0;
2775 /* first try static mappings without port */
2776 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2778 m_key.addr = ip0->dst_address;
2781 m_key.fib_index = rx_fib_index0;
2782 kv.key = m_key.as_u64;
2783 if (!clib_bihash_search_8_8
2784 (&sm->static_mapping_by_external, &kv, &value))
2786 m = pool_elt_at_index (sm->static_mappings, value.value);
2787 return m->workers[0];
2791 proto = ip_proto_to_snat_proto (ip0->protocol);
2792 udp = ip4_next_header (ip0);
2793 port = udp->dst_port;
2795 if (PREDICT_FALSE (ip4_is_fragment (ip0)))
2797 if (PREDICT_FALSE (nat_reass_is_drop_frag (0)))
2798 return vlib_get_thread_index ();
2800 if (PREDICT_TRUE (!ip4_is_first_fragment (ip0)))
2802 nat_reass_ip4_t *reass;
2804 reass = nat_ip4_reass_find (ip0->src_address, ip0->dst_address,
2805 ip0->fragment_id, ip0->protocol);
2807 if (reass && (reass->thread_index != (u32) ~ 0))
2808 return reass->thread_index;
2810 return vlib_get_thread_index ();
2814 /* unknown protocol */
2815 if (PREDICT_FALSE (proto == ~0))
2817 /* use current thread */
2818 return vlib_get_thread_index ();
2821 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
2823 icmp46_header_t *icmp = (icmp46_header_t *) udp;
2824 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
2825 if (!icmp_is_error_message (icmp))
2826 port = echo->identifier;
2829 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
2830 proto = ip_proto_to_snat_proto (inner_ip->protocol);
2831 void *l4_header = ip4_next_header (inner_ip);
2834 case SNAT_PROTOCOL_ICMP:
2835 icmp = (icmp46_header_t *) l4_header;
2836 echo = (icmp_echo_header_t *) (icmp + 1);
2837 port = echo->identifier;
2839 case SNAT_PROTOCOL_UDP:
2840 case SNAT_PROTOCOL_TCP:
2841 port = ((tcp_udp_header_t *) l4_header)->src_port;
2844 return vlib_get_thread_index ();
2849 /* try static mappings with port */
2850 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2852 m_key.addr = ip0->dst_address;
2853 m_key.port = clib_net_to_host_u16 (port);
2854 m_key.protocol = proto;
2855 m_key.fib_index = rx_fib_index0;
2856 kv.key = m_key.as_u64;
2857 if (!clib_bihash_search_8_8
2858 (&sm->static_mapping_by_external, &kv, &value))
2860 m = pool_elt_at_index (sm->static_mappings, value.value);
2861 return m->workers[0];
2865 /* worker by outside port */
2866 next_worker_index = sm->first_worker_index;
2867 next_worker_index +=
2868 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
2869 return next_worker_index;
2873 nat44_ed_get_worker_out2in_cb (ip4_header_t * ip, u32 rx_fib_index)
2875 snat_main_t *sm = &snat_main;
2876 clib_bihash_kv_8_8_t kv, value;
2877 u32 proto, next_worker_index = 0;
2880 snat_static_mapping_t *m;
2883 /* first try static mappings without port */
2884 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2886 make_sm_kv (&kv, &ip->dst_address, 0, rx_fib_index, 0);
2887 if (!clib_bihash_search_8_8
2888 (&sm->static_mapping_by_external, &kv, &value))
2890 m = pool_elt_at_index (sm->static_mappings, value.value);
2891 return m->workers[0];
2895 proto = ip_proto_to_snat_proto (ip->protocol);
2897 /* unknown protocol */
2898 if (PREDICT_FALSE (proto == ~0))
2900 /* use current thread */
2901 return vlib_get_thread_index ();
2904 udp = ip4_next_header (ip);
2905 port = udp->dst_port;
2907 if (PREDICT_FALSE (ip->protocol == IP_PROTOCOL_ICMP))
2909 icmp46_header_t *icmp = (icmp46_header_t *) udp;
2910 icmp_echo_header_t *echo = (icmp_echo_header_t *) (icmp + 1);
2911 if (!icmp_is_error_message (icmp))
2912 port = echo->identifier;
2915 ip4_header_t *inner_ip = (ip4_header_t *) (echo + 1);
2916 proto = ip_proto_to_snat_proto (inner_ip->protocol);
2917 void *l4_header = ip4_next_header (inner_ip);
2920 case SNAT_PROTOCOL_ICMP:
2921 icmp = (icmp46_header_t *) l4_header;
2922 echo = (icmp_echo_header_t *) (icmp + 1);
2923 port = echo->identifier;
2925 case SNAT_PROTOCOL_UDP:
2926 case SNAT_PROTOCOL_TCP:
2927 port = ((tcp_udp_header_t *) l4_header)->src_port;
2930 return vlib_get_thread_index ();
2935 /* try static mappings with port */
2936 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2938 make_sm_kv (&kv, &ip->dst_address, proto, rx_fib_index,
2939 clib_net_to_host_u16 (port));
2940 if (!clib_bihash_search_8_8
2941 (&sm->static_mapping_by_external, &kv, &value))
2943 m = pool_elt_at_index (sm->static_mappings, value.value);
2944 if (!is_lb_static_mapping (m))
2945 return m->workers[0];
2947 hash = ip->src_address.as_u32 + (ip->src_address.as_u32 >> 8) +
2948 (ip->src_address.as_u32 >> 16) + (ip->src_address.as_u32 >> 24);
2950 if (PREDICT_TRUE (is_pow2 (_vec_len (m->workers))))
2951 return m->workers[hash & (_vec_len (m->workers) - 1)];
2953 return m->workers[hash % _vec_len (m->workers)];
2957 /* worker by outside port */
2958 next_worker_index = sm->first_worker_index;
2959 next_worker_index +=
2960 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
2962 return next_worker_index;
2965 static clib_error_t *
2966 snat_config (vlib_main_t * vm, unformat_input_t * input)
2968 snat_main_t *sm = &snat_main;
2969 nat66_main_t *nm = &nat66_main;
2970 u32 translation_buckets = 1024;
2971 u32 translation_memory_size = 128 << 20;
2972 u32 user_buckets = 128;
2973 u32 user_memory_size = 64 << 20;
2974 u32 max_translations_per_user = 100;
2975 u32 outside_vrf_id = 0;
2976 u32 outside_ip6_vrf_id = 0;
2977 u32 inside_vrf_id = 0;
2978 u32 static_mapping_buckets = 1024;
2979 u32 static_mapping_memory_size = 64 << 20;
2980 u32 nat64_bib_buckets = 1024;
2981 u32 nat64_bib_memory_size = 128 << 20;
2982 u32 nat64_st_buckets = 2048;
2983 u32 nat64_st_memory_size = 256 << 20;
2984 u8 static_mapping_only = 0;
2985 u8 static_mapping_connection_tracking = 0;
2986 snat_main_per_thread_data_t *tsm;
2987 dslite_main_t *dm = &dslite_main;
2989 sm->deterministic = 0;
2991 sm->endpoint_dependent = 0;
2993 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2996 (input, "translation hash buckets %d", &translation_buckets))
2998 else if (unformat (input, "translation hash memory %d",
2999 &translation_memory_size));
3000 else if (unformat (input, "user hash buckets %d", &user_buckets))
3002 else if (unformat (input, "user hash memory %d", &user_memory_size))
3004 else if (unformat (input, "max translations per user %d",
3005 &max_translations_per_user))
3007 else if (unformat (input, "outside VRF id %d", &outside_vrf_id))
3009 else if (unformat (input, "outside ip6 VRF id %d", &outside_ip6_vrf_id))
3011 else if (unformat (input, "inside VRF id %d", &inside_vrf_id))
3013 else if (unformat (input, "static mapping only"))
3015 static_mapping_only = 1;
3016 if (unformat (input, "connection tracking"))
3017 static_mapping_connection_tracking = 1;
3019 else if (unformat (input, "deterministic"))
3020 sm->deterministic = 1;
3021 else if (unformat (input, "nat64 bib hash buckets %d",
3022 &nat64_bib_buckets))
3024 else if (unformat (input, "nat64 bib hash memory %d",
3025 &nat64_bib_memory_size))
3028 if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
3030 else if (unformat (input, "nat64 st hash memory %d",
3031 &nat64_st_memory_size))
3033 else if (unformat (input, "out2in dpo"))
3035 else if (unformat (input, "dslite ce"))
3036 dslite_set_ce (dm, 1);
3037 else if (unformat (input, "endpoint-dependent"))
3038 sm->endpoint_dependent = 1;
3040 return clib_error_return (0, "unknown input '%U'",
3041 format_unformat_error, input);
3044 if (sm->deterministic && sm->endpoint_dependent)
3045 return clib_error_return (0,
3046 "deterministic and endpoint-dependent modes are mutually exclusive");
3048 if (static_mapping_only && (sm->deterministic || sm->endpoint_dependent))
3049 return clib_error_return (0,
3050 "static mapping only mode available only for simple nat");
3052 if (sm->out2in_dpo && (sm->deterministic || sm->endpoint_dependent))
3053 return clib_error_return (0,
3054 "out2in dpo mode available only for simple nat");
3056 /* for show commands, etc. */
3057 sm->translation_buckets = translation_buckets;
3058 sm->translation_memory_size = translation_memory_size;
3059 /* do not exceed load factor 10 */
3060 sm->max_translations = 10 * translation_buckets;
3061 sm->user_buckets = user_buckets;
3062 sm->user_memory_size = user_memory_size;
3063 sm->max_translations_per_user = max_translations_per_user;
3064 sm->outside_vrf_id = outside_vrf_id;
3065 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
3067 FIB_SOURCE_PLUGIN_HI);
3068 nm->outside_vrf_id = outside_ip6_vrf_id;
3069 nm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6,
3071 FIB_SOURCE_PLUGIN_HI);
3072 sm->inside_vrf_id = inside_vrf_id;
3073 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
3075 FIB_SOURCE_PLUGIN_HI);
3076 sm->static_mapping_only = static_mapping_only;
3077 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
3079 nat64_set_hash (nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
3080 nat64_st_memory_size);
3082 if (sm->deterministic)
3084 sm->in2out_node_index = snat_det_in2out_node.index;
3085 sm->in2out_output_node_index = ~0;
3086 sm->out2in_node_index = snat_det_out2in_node.index;
3087 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
3088 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
3092 if (sm->endpoint_dependent)
3094 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
3095 sm->worker_out2in_cb = nat44_ed_get_worker_out2in_cb;
3096 sm->in2out_node_index = nat44_ed_in2out_node.index;
3097 sm->in2out_output_node_index = nat44_ed_in2out_output_node.index;
3098 sm->out2in_node_index = nat44_ed_out2in_node.index;
3099 sm->icmp_match_in2out_cb = icmp_match_in2out_ed;
3100 sm->icmp_match_out2in_cb = icmp_match_out2in_ed;
3101 nat_affinity_init (vm);
3105 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
3106 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
3107 sm->in2out_node_index = snat_in2out_node.index;
3108 sm->in2out_output_node_index = snat_in2out_output_node.index;
3109 sm->out2in_node_index = snat_out2in_node.index;
3110 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
3111 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
3113 if (!static_mapping_only ||
3114 (static_mapping_only && static_mapping_connection_tracking))
3117 vec_foreach (tsm, sm->per_thread_data)
3119 if (sm->endpoint_dependent)
3121 clib_bihash_init_16_8 (&tsm->in2out_ed, "in2out-ed",
3122 translation_buckets,
3123 translation_memory_size);
3124 clib_bihash_set_kvp_format_fn_16_8 (&tsm->in2out_ed,
3125 format_ed_session_kvp);
3127 clib_bihash_init_16_8 (&tsm->out2in_ed, "out2in-ed",
3128 translation_buckets,
3129 translation_memory_size);
3130 clib_bihash_set_kvp_format_fn_16_8 (&tsm->out2in_ed,
3131 format_ed_session_kvp);
3135 clib_bihash_init_8_8 (&tsm->in2out, "in2out",
3136 translation_buckets,
3137 translation_memory_size);
3138 clib_bihash_set_kvp_format_fn_8_8 (&tsm->in2out,
3139 format_session_kvp);
3141 clib_bihash_init_8_8 (&tsm->out2in, "out2in",
3142 translation_buckets,
3143 translation_memory_size);
3144 clib_bihash_set_kvp_format_fn_8_8 (&tsm->out2in,
3145 format_session_kvp);
3148 clib_bihash_init_8_8 (&tsm->user_hash, "users", user_buckets,
3150 clib_bihash_set_kvp_format_fn_8_8 (&tsm->user_hash,
3158 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
3159 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
3161 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
3162 "static_mapping_by_local", static_mapping_buckets,
3163 static_mapping_memory_size);
3164 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_local,
3165 format_static_mapping_kvp);
3167 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
3168 "static_mapping_by_external",
3169 static_mapping_buckets,
3170 static_mapping_memory_size);
3171 clib_bihash_set_kvp_format_fn_8_8 (&sm->static_mapping_by_external,
3172 format_static_mapping_kvp);
3178 VLIB_CONFIG_FUNCTION (snat_config, "nat");
3181 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
3184 ip4_address_t * address,
3186 u32 if_address_index, u32 is_delete)
3188 snat_main_t *sm = &snat_main;
3189 snat_static_map_resolve_t *rp;
3190 snat_static_mapping_t *m;
3191 snat_session_key_t m_key;
3192 clib_bihash_kv_8_8_t kv, value;
3194 ip4_address_t l_addr;
3196 for (i = 0; i < vec_len (sm->to_resolve); i++)
3198 rp = sm->to_resolve + i;
3199 if (rp->addr_only == 0)
3201 if (rp->sw_if_index == sw_if_index)
3208 m_key.addr.as_u32 = address->as_u32;
3209 m_key.port = rp->addr_only ? 0 : rp->e_port;
3210 m_key.protocol = rp->addr_only ? 0 : rp->proto;
3211 m_key.fib_index = sm->outside_fib_index;
3212 kv.key = m_key.as_u64;
3213 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
3216 m = pool_elt_at_index (sm->static_mappings, value.value);
3220 /* Don't trip over lease renewal, static config */
3230 /* Indetity mapping? */
3231 if (rp->l_addr.as_u32 == 0)
3232 l_addr.as_u32 = address[0].as_u32;
3234 l_addr.as_u32 = rp->l_addr.as_u32;
3235 /* Add the static mapping */
3236 rv = snat_add_static_mapping (l_addr,
3241 rp->addr_only, ~0 /* sw_if_index */ ,
3242 rp->proto, !is_delete, rp->twice_nat,
3243 rp->out2in_only, rp->tag, rp->identity_nat);
3245 nat_log_notice ("snat_add_static_mapping returned %d", rv);
3249 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
3252 ip4_address_t * address,
3254 u32 if_address_index, u32 is_delete)
3256 snat_main_t *sm = &snat_main;
3257 snat_static_map_resolve_t *rp;
3258 ip4_address_t l_addr;
3262 snat_address_t *addresses = sm->addresses;
3264 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices); i++)
3266 if (sw_if_index == sm->auto_add_sw_if_indices[i])
3270 for (i = 0; i < vec_len (sm->auto_add_sw_if_indices_twice_nat); i++)
3273 addresses = sm->twice_nat_addresses;
3274 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
3283 /* Don't trip over lease renewal, static config */
3284 for (j = 0; j < vec_len (addresses); j++)
3285 if (addresses[j].addr.as_u32 == address->as_u32)
3288 (void) snat_add_address (sm, address, ~0, twice_nat);
3289 /* Scan static map resolution vector */
3290 for (j = 0; j < vec_len (sm->to_resolve); j++)
3292 rp = sm->to_resolve + j;
3295 /* On this interface? */
3296 if (rp->sw_if_index == sw_if_index)
3298 /* Indetity mapping? */
3299 if (rp->l_addr.as_u32 == 0)
3300 l_addr.as_u32 = address[0].as_u32;
3302 l_addr.as_u32 = rp->l_addr.as_u32;
3303 /* Add the static mapping */
3304 rv = snat_add_static_mapping (l_addr,
3310 ~0 /* sw_if_index */ ,
3312 rp->is_add, rp->twice_nat,
3313 rp->out2in_only, rp->tag,
3316 nat_log_notice ("snat_add_static_mapping returned %d", rv);
3323 (void) snat_del_address (sm, address[0], 1, twice_nat);
3330 snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
3333 ip4_main_t *ip4_main = sm->ip4_main;
3334 ip4_address_t *first_int_addr;
3335 snat_static_map_resolve_t *rp;
3336 u32 *indices_to_delete = 0;
3338 u32 *auto_add_sw_if_indices =
3340 auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
3342 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index, 0 /* just want the address */
3345 for (i = 0; i < vec_len (auto_add_sw_if_indices); i++)
3347 if (auto_add_sw_if_indices[i] == sw_if_index)
3351 /* if have address remove it */
3353 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
3356 for (j = 0; j < vec_len (sm->to_resolve); j++)
3358 rp = sm->to_resolve + j;
3359 if (rp->sw_if_index == sw_if_index)
3360 vec_add1 (indices_to_delete, j);
3362 if (vec_len (indices_to_delete))
3364 for (j = vec_len (indices_to_delete) - 1; j >= 0; j--)
3365 vec_del1 (sm->to_resolve, j);
3366 vec_free (indices_to_delete);
3370 vec_del1 (sm->auto_add_sw_if_indices_twice_nat, i);
3372 vec_del1 (sm->auto_add_sw_if_indices, i);
3375 return VNET_API_ERROR_VALUE_EXIST;
3382 return VNET_API_ERROR_NO_SUCH_ENTRY;
3384 /* add to the auto-address list */
3386 vec_add1 (sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
3388 vec_add1 (sm->auto_add_sw_if_indices, sw_if_index);
3390 /* If the address is already bound - or static - add it now */
3392 (void) snat_add_address (sm, first_int_addr, ~0, twice_nat);
3398 nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
3399 snat_protocol_t proto, u32 vrf_id, int is_in)
3401 snat_main_per_thread_data_t *tsm;
3402 clib_bihash_kv_8_8_t kv, value;
3404 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3405 snat_session_key_t key;
3407 clib_bihash_8_8_t *t;
3409 if (sm->endpoint_dependent)
3410 return VNET_API_ERROR_UNSUPPORTED;
3412 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
3413 if (sm->num_workers > 1)
3415 vec_elt_at_index (sm->per_thread_data,
3416 sm->worker_in2out_cb (&ip, fib_index));
3418 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
3420 key.addr.as_u32 = addr->as_u32;
3421 key.port = clib_host_to_net_u16 (port);
3422 key.protocol = proto;
3423 key.fib_index = fib_index;
3424 kv.key = key.as_u64;
3425 t = is_in ? &tsm->in2out : &tsm->out2in;
3426 if (!clib_bihash_search_8_8 (t, &kv, &value))
3428 if (pool_is_free_index (tsm->sessions, value.value))
3429 return VNET_API_ERROR_UNSPECIFIED;
3431 s = pool_elt_at_index (tsm->sessions, value.value);
3432 nat_free_session_data (sm, s, tsm - sm->per_thread_data);
3433 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
3437 return VNET_API_ERROR_NO_SUCH_ENTRY;
3441 nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
3442 ip4_address_t * eh_addr, u16 eh_port, u8 proto,
3443 u32 vrf_id, int is_in)
3446 clib_bihash_16_8_t *t;
3447 nat_ed_ses_key_t key;
3448 clib_bihash_kv_16_8_t kv, value;
3449 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3451 snat_main_per_thread_data_t *tsm;
3453 if (!sm->endpoint_dependent)
3454 return VNET_API_ERROR_FEATURE_DISABLED;
3456 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
3457 if (sm->num_workers > 1)
3459 vec_elt_at_index (sm->per_thread_data,
3460 sm->worker_in2out_cb (&ip, fib_index));
3462 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
3464 t = is_in ? &tsm->in2out_ed : &tsm->out2in_ed;
3465 key.l_addr.as_u32 = addr->as_u32;
3466 key.r_addr.as_u32 = eh_addr->as_u32;
3467 key.l_port = clib_host_to_net_u16 (port);
3468 key.r_port = clib_host_to_net_u16 (eh_port);
3470 key.fib_index = fib_index;
3471 kv.key[0] = key.as_u64[0];
3472 kv.key[1] = key.as_u64[1];
3473 if (clib_bihash_search_16_8 (t, &kv, &value))
3474 return VNET_API_ERROR_NO_SUCH_ENTRY;
3476 if (pool_is_free_index (tsm->sessions, value.value))
3477 return VNET_API_ERROR_UNSPECIFIED;
3478 s = pool_elt_at_index (tsm->sessions, value.value);
3479 nat_free_session_data (sm, s, tsm - sm->per_thread_data);
3480 nat44_delete_session (sm, s, tsm - sm->per_thread_data);
3485 nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset, u16 psid_length)
3487 snat_main_t *sm = &snat_main;
3489 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_MAPE;
3490 sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
3492 sm->psid_offset = psid_offset;
3493 sm->psid_length = psid_length;
3497 nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port)
3499 snat_main_t *sm = &snat_main;
3501 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_RANGE;
3502 sm->alloc_addr_and_port = nat_alloc_addr_and_port_range;
3503 sm->start_port = start_port;
3504 sm->end_port = end_port;
3508 nat_set_alloc_addr_and_port_default (void)
3510 snat_main_t *sm = &snat_main;
3512 sm->addr_and_port_alloc_alg = NAT_ADDR_AND_PORT_ALLOC_ALG_DEFAULT;
3513 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
3517 * fd.io coding-style-patch-verification: ON
3520 * eval: (c-set-style "gnu")