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 <vnet/fib/fib_table.h>
31 #include <vnet/fib/ip4_fib.h>
33 #include <vpp/app/version.h>
35 snat_main_t snat_main;
38 /* Hook up input features */
39 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
40 .arc_name = "ip4-unicast",
41 .node_name = "nat44-in2out",
42 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
44 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
45 .arc_name = "ip4-unicast",
46 .node_name = "nat44-out2in",
47 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
49 VNET_FEATURE_INIT (ip4_nat_classify, static) = {
50 .arc_name = "ip4-unicast",
51 .node_name = "nat44-classify",
52 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
54 VNET_FEATURE_INIT (ip4_snat_det_in2out, static) = {
55 .arc_name = "ip4-unicast",
56 .node_name = "nat44-det-in2out",
57 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
59 VNET_FEATURE_INIT (ip4_snat_det_out2in, static) = {
60 .arc_name = "ip4-unicast",
61 .node_name = "nat44-det-out2in",
62 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
64 VNET_FEATURE_INIT (ip4_nat_det_classify, static) = {
65 .arc_name = "ip4-unicast",
66 .node_name = "nat44-det-classify",
67 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
69 VNET_FEATURE_INIT (ip4_snat_in2out_worker_handoff, static) = {
70 .arc_name = "ip4-unicast",
71 .node_name = "nat44-in2out-worker-handoff",
72 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
74 VNET_FEATURE_INIT (ip4_snat_out2in_worker_handoff, static) = {
75 .arc_name = "ip4-unicast",
76 .node_name = "nat44-out2in-worker-handoff",
77 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
79 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
80 .arc_name = "ip4-unicast",
81 .node_name = "nat44-handoff-classify",
82 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
84 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
85 .arc_name = "ip4-unicast",
86 .node_name = "nat44-in2out-fast",
87 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
89 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
90 .arc_name = "ip4-unicast",
91 .node_name = "nat44-out2in-fast",
92 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
94 VNET_FEATURE_INIT (ip4_snat_hairpin_dst, static) = {
95 .arc_name = "ip4-unicast",
96 .node_name = "nat44-hairpin-dst",
97 .runs_after = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
100 /* Hook up output features */
101 VNET_FEATURE_INIT (ip4_snat_in2out_output, static) = {
102 .arc_name = "ip4-output",
103 .node_name = "nat44-in2out-output",
104 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
106 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
107 .arc_name = "ip4-output",
108 .node_name = "nat44-in2out-output-worker-handoff",
109 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
111 VNET_FEATURE_INIT (ip4_snat_hairpin_src, static) = {
112 .arc_name = "ip4-output",
113 .node_name = "nat44-hairpin-src",
114 .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
117 /* Hook up ip4-local features */
118 VNET_FEATURE_INIT (ip4_nat_hairpinning, static) =
120 .arc_name = "ip4-local",
121 .node_name = "nat44-hairpinning",
122 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
127 VLIB_PLUGIN_REGISTER () = {
128 .version = VPP_BUILD_VER,
129 .description = "Network Address Translation",
133 vlib_node_registration_t nat44_classify_node;
134 vlib_node_registration_t nat44_det_classify_node;
135 vlib_node_registration_t nat44_handoff_classify_node;
138 NAT44_CLASSIFY_NEXT_IN2OUT,
139 NAT44_CLASSIFY_NEXT_OUT2IN,
140 NAT44_CLASSIFY_N_NEXT,
141 } nat44_classify_next_t;
144 nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index)
146 snat_session_key_t key;
147 clib_bihash_kv_8_8_t kv;
148 nat_ed_ses_key_t ed_key;
149 clib_bihash_kv_16_8_t ed_kv;
152 snat_main_per_thread_data_t *tsm =
153 vec_elt_at_index (sm->per_thread_data, thread_index);
155 if (is_fwd_bypass_session (s))
157 ed_key.l_addr = s->in2out.addr;
158 ed_key.r_addr = s->ext_host_addr;
159 ed_key.l_port = s->in2out.port;
160 ed_key.r_port = s->ext_host_port;
161 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
162 ed_key.fib_index = 0;
163 ed_kv.key[0] = ed_key.as_u64[0];
164 ed_kv.key[1] = ed_key.as_u64[1];
165 if (clib_bihash_add_del_16_8 (&sm->in2out_ed, &ed_kv, 0))
166 clib_warning ("in2out_ed key del failed");
170 /* Endpoint dependent session lookup tables */
171 if (is_ed_session (s))
173 ed_key.l_addr = s->out2in.addr;
174 ed_key.r_addr = s->ext_host_addr;
175 ed_key.fib_index = s->out2in.fib_index;
176 if (snat_is_unk_proto_session (s))
178 ed_key.proto = s->in2out.port;
184 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
185 ed_key.l_port = s->out2in.port;
186 ed_key.r_port = s->ext_host_port;
188 ed_kv.key[0] = ed_key.as_u64[0];
189 ed_kv.key[1] = ed_key.as_u64[1];
190 if (clib_bihash_add_del_16_8 (&sm->out2in_ed, &ed_kv, 0))
191 clib_warning ("out2in_ed key del failed");
193 ed_key.l_addr = s->in2out.addr;
194 ed_key.fib_index = s->in2out.fib_index;
195 if (!snat_is_unk_proto_session (s))
196 ed_key.l_port = s->in2out.port;
197 if (is_twice_nat_session (s))
199 ed_key.r_addr = s->ext_host_nat_addr;
200 ed_key.r_port = s->ext_host_nat_port;
202 ed_kv.key[0] = ed_key.as_u64[0];
203 ed_kv.key[1] = ed_key.as_u64[1];
204 if (clib_bihash_add_del_16_8 (&sm->in2out_ed, &ed_kv, 0))
205 clib_warning ("in2out_ed key del failed");
208 if (snat_is_unk_proto_session (s))
212 snat_ipfix_logging_nat44_ses_delete(s->in2out.addr.as_u32,
213 s->out2in.addr.as_u32,
217 s->in2out.fib_index);
219 /* Twice NAT address and port for external host */
220 if (is_twice_nat_session (s))
222 for (i = 0; i < vec_len (sm->twice_nat_addresses); i++)
224 key.protocol = s->in2out.protocol;
225 key.port = s->ext_host_nat_port;
226 a = sm->twice_nat_addresses + i;
227 if (a->addr.as_u32 == s->ext_host_nat_addr.as_u32)
229 snat_free_outside_address_and_port (sm->twice_nat_addresses,
230 thread_index, &key, i);
236 if (is_ed_session (s))
239 /* Session lookup tables */
240 kv.key = s->in2out.as_u64;
241 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0))
242 clib_warning ("in2out key del failed");
243 kv.key = s->out2in.as_u64;
244 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0))
245 clib_warning ("out2in key del failed");
247 if (snat_is_session_static (s))
250 if (s->outside_address_index != ~0)
251 snat_free_outside_address_and_port (sm->addresses, thread_index,
252 &s->out2in, s->outside_address_index);
256 nat_user_get_or_create (snat_main_t *sm, ip4_address_t *addr, u32 fib_index,
260 snat_user_key_t user_key;
261 clib_bihash_kv_8_8_t kv, value;
262 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
263 dlist_elt_t * per_user_list_head_elt;
265 user_key.addr.as_u32 = addr->as_u32;
266 user_key.fib_index = fib_index;
267 kv.key = user_key.as_u64;
269 /* Ever heard of the "user" = src ip4 address before? */
270 if (clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
272 /* no, make a new one */
273 pool_get (tsm->users, u);
274 memset (u, 0, sizeof (*u));
275 u->addr.as_u32 = addr->as_u32;
276 u->fib_index = fib_index;
278 pool_get (tsm->list_pool, per_user_list_head_elt);
280 u->sessions_per_user_list_head_index = per_user_list_head_elt -
283 clib_dlist_init (tsm->list_pool, u->sessions_per_user_list_head_index);
285 kv.value = u - tsm->users;
288 if (clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 1))
289 clib_warning ("user_hash keay add failed");
293 u = pool_elt_at_index (tsm->users, value.value);
300 nat_session_alloc_or_recycle (snat_main_t *sm, snat_user_t *u, u32 thread_index)
303 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
304 u32 oldest_per_user_translation_list_index, session_index;
305 dlist_elt_t * oldest_per_user_translation_list_elt;
306 dlist_elt_t * per_user_translation_list_elt;
308 /* Over quota? Recycle the least recently used translation */
309 if ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user)
311 oldest_per_user_translation_list_index =
312 clib_dlist_remove_head (tsm->list_pool,
313 u->sessions_per_user_list_head_index);
315 ASSERT (oldest_per_user_translation_list_index != ~0);
317 /* Add it back to the end of the LRU list */
318 clib_dlist_addtail (tsm->list_pool,
319 u->sessions_per_user_list_head_index,
320 oldest_per_user_translation_list_index);
321 /* Get the list element */
322 oldest_per_user_translation_list_elt =
323 pool_elt_at_index (tsm->list_pool,
324 oldest_per_user_translation_list_index);
326 /* Get the session index from the list element */
327 session_index = oldest_per_user_translation_list_elt->value;
329 /* Get the session */
330 s = pool_elt_at_index (tsm->sessions, session_index);
331 nat_free_session_data (sm, s, thread_index);
332 s->outside_address_index = ~0;
339 pool_get (tsm->sessions, s);
340 memset (s, 0, sizeof (*s));
341 s->outside_address_index = ~0;
343 /* Create list elts */
344 pool_get (tsm->list_pool, per_user_translation_list_elt);
345 clib_dlist_init (tsm->list_pool,
346 per_user_translation_list_elt - tsm->list_pool);
348 per_user_translation_list_elt->value = s - tsm->sessions;
349 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
350 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
352 clib_dlist_addtail (tsm->list_pool,
353 s->per_user_list_head_index,
354 per_user_translation_list_elt - tsm->list_pool);
361 nat44_classify_node_fn_inline (vlib_main_t * vm,
362 vlib_node_runtime_t * node,
363 vlib_frame_t * frame)
365 u32 n_left_from, * from, * to_next;
366 nat44_classify_next_t next_index;
367 snat_main_t *sm = &snat_main;
369 from = vlib_frame_vector_args (frame);
370 n_left_from = frame->n_vectors;
371 next_index = node->cached_next_index;
373 while (n_left_from > 0)
377 vlib_get_next_frame (vm, node, next_index,
378 to_next, n_left_to_next);
380 while (n_left_from > 0 && n_left_to_next > 0)
384 u32 next0 = NAT44_CLASSIFY_NEXT_IN2OUT;
387 snat_session_key_t m_key0;
388 clib_bihash_kv_8_8_t kv0, value0;
390 /* speculatively enqueue b0 to the current next frame */
398 b0 = vlib_get_buffer (vm, bi0);
399 ip0 = vlib_buffer_get_current (b0);
401 vec_foreach (ap, sm->addresses)
403 if (ip0->dst_address.as_u32 == ap->addr.as_u32)
405 next0 = NAT44_CLASSIFY_NEXT_OUT2IN;
410 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
412 m_key0.addr = ip0->dst_address;
415 m_key0.fib_index = sm->outside_fib_index;
416 kv0.key = m_key0.as_u64;
417 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv0, &value0))
419 next0 = NAT44_CLASSIFY_NEXT_OUT2IN;
422 udp_header_t * udp0 = ip4_next_header (ip0);
423 m_key0.port = clib_net_to_host_u16 (udp0->dst_port);
424 m_key0.protocol = ip_proto_to_snat_proto (ip0->protocol);
425 kv0.key = m_key0.as_u64;
426 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv0, &value0))
427 next0 = NAT44_CLASSIFY_NEXT_OUT2IN;
431 /* verify speculative enqueue, maybe switch current next frame */
432 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
433 to_next, n_left_to_next,
437 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
440 return frame->n_vectors;
444 nat44_classify_node_fn (vlib_main_t * vm,
445 vlib_node_runtime_t * node,
446 vlib_frame_t * frame)
448 return nat44_classify_node_fn_inline (vm, node, frame);
451 VLIB_REGISTER_NODE (nat44_classify_node) = {
452 .function = nat44_classify_node_fn,
453 .name = "nat44-classify",
454 .vector_size = sizeof (u32),
455 .type = VLIB_NODE_TYPE_INTERNAL,
456 .n_next_nodes = NAT44_CLASSIFY_N_NEXT,
458 [NAT44_CLASSIFY_NEXT_IN2OUT] = "nat44-in2out",
459 [NAT44_CLASSIFY_NEXT_OUT2IN] = "nat44-out2in",
463 VLIB_NODE_FUNCTION_MULTIARCH (nat44_classify_node,
464 nat44_classify_node_fn);
467 nat44_det_classify_node_fn (vlib_main_t * vm,
468 vlib_node_runtime_t * node,
469 vlib_frame_t * frame)
471 return nat44_classify_node_fn_inline (vm, node, frame);
474 VLIB_REGISTER_NODE (nat44_det_classify_node) = {
475 .function = nat44_det_classify_node_fn,
476 .name = "nat44-det-classify",
477 .vector_size = sizeof (u32),
478 .type = VLIB_NODE_TYPE_INTERNAL,
479 .n_next_nodes = NAT44_CLASSIFY_N_NEXT,
481 [NAT44_CLASSIFY_NEXT_IN2OUT] = "nat44-det-in2out",
482 [NAT44_CLASSIFY_NEXT_OUT2IN] = "nat44-det-out2in",
486 VLIB_NODE_FUNCTION_MULTIARCH (nat44_det_classify_node,
487 nat44_det_classify_node_fn);
490 nat44_handoff_classify_node_fn (vlib_main_t * vm,
491 vlib_node_runtime_t * node,
492 vlib_frame_t * frame)
494 return nat44_classify_node_fn_inline (vm, node, frame);
497 VLIB_REGISTER_NODE (nat44_handoff_classify_node) = {
498 .function = nat44_handoff_classify_node_fn,
499 .name = "nat44-handoff-classify",
500 .vector_size = sizeof (u32),
501 .type = VLIB_NODE_TYPE_INTERNAL,
502 .n_next_nodes = NAT44_CLASSIFY_N_NEXT,
504 [NAT44_CLASSIFY_NEXT_IN2OUT] = "nat44-in2out-worker-handoff",
505 [NAT44_CLASSIFY_NEXT_OUT2IN] = "nat44-out2in-worker-handoff",
509 VLIB_NODE_FUNCTION_MULTIARCH (nat44_handoff_classify_node,
510 nat44_handoff_classify_node_fn);
513 * @brief Add/del NAT address to FIB.
515 * Add the external NAT address to the FIB as receive entries. This ensures
516 * that VPP will reply to ARP for this address and we don't need to enable
517 * proxy ARP on the outside interface.
519 * @param addr IPv4 address.
520 * @param plen address prefix length
521 * @param sw_if_index Interface.
522 * @param is_add If 0 delete, otherwise add.
525 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
528 fib_prefix_t prefix = {
530 .fp_proto = FIB_PROTOCOL_IP4,
532 .ip4.as_u32 = addr->as_u32,
535 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index(sw_if_index);
538 fib_table_entry_update_one_path(fib_index,
540 FIB_SOURCE_PLUGIN_LOW,
541 (FIB_ENTRY_FLAG_CONNECTED |
542 FIB_ENTRY_FLAG_LOCAL |
543 FIB_ENTRY_FLAG_EXCLUSIVE),
550 FIB_ROUTE_PATH_FLAG_NONE);
552 fib_table_entry_delete(fib_index,
554 FIB_SOURCE_PLUGIN_LOW);
557 void snat_add_address (snat_main_t *sm, ip4_address_t *addr, u32 vrf_id,
562 vlib_thread_main_t *tm = vlib_get_thread_main ();
564 /* Check if address already exists */
565 vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
567 if (ap->addr.as_u32 == addr->as_u32)
572 vec_add2 (sm->twice_nat_addresses, ap, 1);
574 vec_add2 (sm->addresses, ap, 1);
579 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
580 FIB_SOURCE_PLUGIN_LOW);
583 #define _(N, i, n, s) \
584 clib_bitmap_alloc (ap->busy_##n##_port_bitmap, 65535); \
585 ap->busy_##n##_ports = 0; \
586 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
587 foreach_snat_protocol
593 /* Add external address to FIB */
594 pool_foreach (i, sm->interfaces,
596 if (nat_interface_is_inside(i) || sm->out2in_dpo)
599 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
602 pool_foreach (i, sm->output_feature_interfaces,
604 if (nat_interface_is_inside(i) || sm->out2in_dpo)
607 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
612 static int is_snat_address_used_in_static_mapping (snat_main_t *sm,
615 snat_static_mapping_t *m;
616 pool_foreach (m, sm->static_mappings,
618 if (m->external_addr.as_u32 == addr.as_u32)
625 void increment_v4_address (ip4_address_t * a)
629 v = clib_net_to_host_u32(a->as_u32) + 1;
630 a->as_u32 = clib_host_to_net_u32(v);
634 snat_add_static_mapping_when_resolved (snat_main_t * sm,
635 ip4_address_t l_addr,
640 snat_protocol_t proto,
645 snat_static_map_resolve_t *rp;
647 vec_add2 (sm->to_resolve, rp, 1);
648 rp->l_addr.as_u32 = l_addr.as_u32;
650 rp->sw_if_index = sw_if_index;
654 rp->addr_only = addr_only;
656 rp->tag = vec_dup (tag);
660 * @brief Add static mapping.
662 * Create static mapping between local addr+port and external addr+port.
664 * @param l_addr Local IPv4 address.
665 * @param e_addr External IPv4 address.
666 * @param l_port Local port number.
667 * @param e_port External port number.
668 * @param vrf_id VRF ID.
669 * @param addr_only If 0 address port and pair mapping, otherwise address only.
670 * @param sw_if_index External port instead of specific IP address.
671 * @param is_add If 0 delete static mapping, otherwise add.
672 * @param twice_nat If value is TWICE_NAT then translate external host address
674 * If value is TWICE_NAT_SELF then translate external host
675 * address and port whenever external host address equals
676 * local address of internal host.
677 * @param out2in_only If 1 rule match only out2in direction
678 * @param tag - opaque string tag
682 int snat_add_static_mapping(ip4_address_t l_addr, ip4_address_t e_addr,
683 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
684 u32 sw_if_index, snat_protocol_t proto, int is_add,
685 twice_nat_type_t twice_nat, u8 out2in_only,
688 snat_main_t * sm = &snat_main;
689 snat_static_mapping_t *m;
690 snat_session_key_t m_key;
691 clib_bihash_kv_8_8_t kv, value;
692 snat_address_t *a = 0;
695 snat_interface_t *interface;
697 snat_main_per_thread_data_t *tsm;
698 snat_user_key_t u_key;
700 dlist_elt_t * head, * elt;
701 u32 elt_index, head_index;
705 snat_static_map_resolve_t *rp, *rp_match = 0;
707 /* If the external address is a specific interface address */
708 if (sw_if_index != ~0)
710 ip4_address_t * first_int_addr;
712 for (i = 0; i < vec_len (sm->to_resolve); i++)
714 rp = sm->to_resolve + i;
715 if (rp->sw_if_index != sw_if_index &&
716 rp->l_addr.as_u32 != l_addr.as_u32 &&
717 rp->vrf_id != vrf_id && rp->addr_only != addr_only)
722 if (rp->l_port != l_port && rp->e_port != e_port && rp->proto != proto)
730 /* Might be already set... */
731 first_int_addr = ip4_interface_first_address
732 (sm->ip4_main, sw_if_index, 0 /* just want the address*/);
737 return VNET_API_ERROR_VALUE_EXIST;
739 snat_add_static_mapping_when_resolved
740 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
741 addr_only, is_add, tag);
743 /* DHCP resolution required? */
744 if (first_int_addr == 0)
750 e_addr.as_u32 = first_int_addr->as_u32;
751 /* Identity mapping? */
752 if (l_addr.as_u32 == 0)
753 l_addr.as_u32 = e_addr.as_u32;
759 return VNET_API_ERROR_NO_SUCH_ENTRY;
761 vec_del1 (sm->to_resolve, i);
765 e_addr.as_u32 = first_int_addr->as_u32;
766 /* Identity mapping? */
767 if (l_addr.as_u32 == 0)
768 l_addr.as_u32 = e_addr.as_u32;
776 m_key.port = addr_only ? 0 : e_port;
777 m_key.protocol = addr_only ? 0 : proto;
778 m_key.fib_index = sm->outside_fib_index;
779 kv.key = m_key.as_u64;
780 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
783 m = pool_elt_at_index (sm->static_mappings, value.value);
788 return VNET_API_ERROR_VALUE_EXIST;
790 if (twice_nat && addr_only)
791 return VNET_API_ERROR_UNSUPPORTED;
793 /* Convert VRF id to FIB index */
796 p = hash_get (sm->ip4_main->fib_index_by_table_id, vrf_id);
798 return VNET_API_ERROR_NO_SUCH_FIB;
801 /* If not specified use inside VRF id from SNAT plugin startup config */
804 fib_index = sm->inside_fib_index;
805 vrf_id = sm->inside_vrf_id;
811 m_key.port = addr_only ? 0 : l_port;
812 m_key.protocol = addr_only ? 0 : proto;
813 m_key.fib_index = fib_index;
814 kv.key = m_key.as_u64;
815 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_local, &kv, &value))
816 return VNET_API_ERROR_VALUE_EXIST;
819 /* Find external address in allocated addresses and reserve port for
820 address and port pair mapping when dynamic translations enabled */
821 if (!(addr_only || sm->static_mapping_only || out2in_only))
823 for (i = 0; i < vec_len (sm->addresses); i++)
825 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
827 a = sm->addresses + i;
828 /* External port must be unused */
831 #define _(N, j, n, s) \
832 case SNAT_PROTOCOL_##N: \
833 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
834 return VNET_API_ERROR_INVALID_VALUE; \
835 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
838 a->busy_##n##_ports++; \
839 a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]++; \
842 foreach_snat_protocol
845 clib_warning("unknown_protocol");
846 return VNET_API_ERROR_INVALID_VALUE_2;
851 /* External address must be allocated */
852 if (!a && (l_addr.as_u32 != e_addr.as_u32))
854 if (sw_if_index != ~0)
856 for (i = 0; i < vec_len (sm->to_resolve); i++)
858 rp = sm->to_resolve + i;
861 if (rp->sw_if_index != sw_if_index &&
862 rp->l_addr.as_u32 != l_addr.as_u32 &&
863 rp->vrf_id != vrf_id && rp->l_port != l_port &&
864 rp->e_port != e_port && rp->proto != proto)
867 vec_del1 (sm->to_resolve, i);
871 return VNET_API_ERROR_NO_SUCH_ENTRY;
875 pool_get (sm->static_mappings, m);
876 memset (m, 0, sizeof (*m));
877 m->tag = vec_dup (tag);
878 m->local_addr = l_addr;
879 m->external_addr = e_addr;
880 m->addr_only = addr_only;
882 m->fib_index = fib_index;
883 m->twice_nat = twice_nat;
884 m->out2in_only = out2in_only;
887 m->local_port = l_port;
888 m->external_port = e_port;
895 .src_address = m->local_addr,
897 m->worker_index = sm->worker_in2out_cb (&ip, m->fib_index);
898 tsm = vec_elt_at_index (sm->per_thread_data, m->worker_index);
901 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
903 m_key.addr = m->local_addr;
904 m_key.port = m->local_port;
905 m_key.protocol = m->proto;
906 m_key.fib_index = m->fib_index;
907 kv.key = m_key.as_u64;
908 kv.value = m - sm->static_mappings;
910 clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 1);
911 if (twice_nat || out2in_only)
913 m_key.port = clib_host_to_net_u16 (l_port);
914 kv.key = m_key.as_u64;
916 if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 1))
917 clib_warning ("in2out key add failed");
920 m_key.addr = m->external_addr;
921 m_key.port = m->external_port;
922 m_key.fib_index = sm->outside_fib_index;
923 kv.key = m_key.as_u64;
924 kv.value = m - sm->static_mappings;
925 clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 1);
926 if (twice_nat || out2in_only)
928 m_key.port = clib_host_to_net_u16 (e_port);
929 kv.key = m_key.as_u64;
931 if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 1))
932 clib_warning ("out2in key add failed");
935 /* Delete dynamic sessions matching local address (+ local port) */
936 if (!(sm->static_mapping_only))
938 u_key.addr = m->local_addr;
939 u_key.fib_index = m->fib_index;
940 kv.key = u_key.as_u64;
941 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
943 user_index = value.value;
944 u = pool_elt_at_index (tsm->users, user_index);
947 head_index = u->sessions_per_user_list_head_index;
948 head = pool_elt_at_index (tsm->list_pool, head_index);
949 elt_index = head->next;
950 elt = pool_elt_at_index (tsm->list_pool, elt_index);
951 ses_index = elt->value;
952 while (ses_index != ~0)
954 s = pool_elt_at_index (tsm->sessions, ses_index);
955 elt = pool_elt_at_index (tsm->list_pool, elt->next);
956 ses_index = elt->value;
958 if (snat_is_session_static (s))
963 if ((s->out2in.addr.as_u32 != e_addr.as_u32) &&
964 (clib_net_to_host_u16 (s->out2in.port) != e_port))
968 nat_free_session_data (sm, s, tsm - sm->per_thread_data);
969 clib_dlist_remove (tsm->list_pool, s->per_user_index);
970 pool_put_index (tsm->list_pool, s->per_user_index);
971 pool_put (tsm->sessions, s);
985 if (sw_if_index != ~0)
988 return VNET_API_ERROR_NO_SUCH_ENTRY;
991 /* Free external address port */
992 if (!(addr_only || sm->static_mapping_only || out2in_only))
994 for (i = 0; i < vec_len (sm->addresses); i++)
996 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
998 a = sm->addresses + i;
1001 #define _(N, j, n, s) \
1002 case SNAT_PROTOCOL_##N: \
1003 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
1004 if (e_port > 1024) \
1006 a->busy_##n##_ports--; \
1007 a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]--; \
1010 foreach_snat_protocol
1013 clib_warning("unknown_protocol");
1014 return VNET_API_ERROR_INVALID_VALUE_2;
1021 if (sm->num_workers > 1)
1022 tsm = vec_elt_at_index (sm->per_thread_data, m->worker_index);
1024 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1026 m_key.addr = m->local_addr;
1027 m_key.port = m->local_port;
1028 m_key.protocol = m->proto;
1029 m_key.fib_index = m->fib_index;
1030 kv.key = m_key.as_u64;
1032 clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0);
1033 if (twice_nat || out2in_only)
1035 m_key.port = clib_host_to_net_u16 (m->local_port);
1036 kv.key = m_key.as_u64;
1038 if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 0))
1039 clib_warning ("in2out key del failed");
1042 m_key.addr = m->external_addr;
1043 m_key.port = m->external_port;
1044 m_key.fib_index = sm->outside_fib_index;
1045 kv.key = m_key.as_u64;
1046 clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 0);
1047 if (twice_nat || out2in_only)
1049 m_key.port = clib_host_to_net_u16 (m->external_port);
1050 kv.key = m_key.as_u64;
1052 if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 0))
1053 clib_warning ("in2out key del failed");
1056 /* Delete session(s) for static mapping if exist */
1057 if (!(sm->static_mapping_only) ||
1058 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
1060 u_key.addr = m->local_addr;
1061 u_key.fib_index = m->fib_index;
1062 kv.key = u_key.as_u64;
1063 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1065 user_index = value.value;
1066 u = pool_elt_at_index (tsm->users, user_index);
1067 if (u->nstaticsessions)
1069 head_index = u->sessions_per_user_list_head_index;
1070 head = pool_elt_at_index (tsm->list_pool, head_index);
1071 elt_index = head->next;
1072 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1073 ses_index = elt->value;
1074 while (ses_index != ~0)
1076 s = pool_elt_at_index (tsm->sessions, ses_index);
1077 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1078 ses_index = elt->value;
1082 if ((s->out2in.addr.as_u32 != e_addr.as_u32) &&
1083 (clib_net_to_host_u16 (s->out2in.port) != e_port))
1087 if (is_lb_session (s))
1090 nat_free_session_data (sm, s, tsm - sm->per_thread_data);
1091 clib_dlist_remove (tsm->list_pool, s->per_user_index);
1092 pool_put_index (tsm->list_pool, s->per_user_index);
1093 pool_put (tsm->sessions, s);
1094 u->nstaticsessions--;
1099 if (addr_only && (u->nstaticsessions == 0))
1101 pool_put (tsm->users, u);
1102 clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 0);
1109 /* Delete static mapping from pool */
1110 pool_put (sm->static_mappings, m);
1113 if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
1116 /* Add/delete external address to FIB */
1117 pool_foreach (interface, sm->interfaces,
1119 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1122 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1125 pool_foreach (interface, sm->output_feature_interfaces,
1127 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1130 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
1137 static int lb_local_exists (nat44_lb_addr_port_t * local,
1138 ip4_address_t * e_addr, u16 e_port)
1140 snat_main_t *sm = &snat_main;
1141 snat_static_mapping_t *m;
1142 nat44_lb_addr_port_t *ap;
1145 pool_foreach (m, sm->static_mappings,
1147 if (vec_len(m->locals))
1149 if (m->external_port == e_port && m->external_addr.as_u32 == e_addr->as_u32)
1152 vec_foreach (ap, m->locals)
1154 if (ap->port == local->port && ap->addr.as_u32 == local->addr.as_u32)
1164 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
1165 snat_protocol_t proto, u32 vrf_id,
1166 nat44_lb_addr_port_t *locals, u8 is_add,
1167 twice_nat_type_t twice_nat, u8 out2in_only,
1170 snat_main_t * sm = &snat_main;
1171 snat_static_mapping_t *m;
1172 snat_session_key_t m_key;
1173 clib_bihash_kv_8_8_t kv, value;
1175 snat_address_t *a = 0;
1177 nat44_lb_addr_port_t *local;
1178 u32 worker_index = 0, elt_index, head_index, ses_index;
1179 snat_main_per_thread_data_t *tsm;
1180 snat_user_key_t u_key;
1183 dlist_elt_t * head, * elt;
1185 m_key.addr = e_addr;
1186 m_key.port = e_port;
1187 m_key.protocol = proto;
1188 m_key.fib_index = sm->outside_fib_index;
1189 kv.key = m_key.as_u64;
1190 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1193 m = pool_elt_at_index (sm->static_mappings, value.value);
1198 return VNET_API_ERROR_VALUE_EXIST;
1200 if (vec_len (locals) < 2)
1201 return VNET_API_ERROR_INVALID_VALUE;
1203 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
1205 FIB_SOURCE_PLUGIN_LOW);
1207 /* Find external address in allocated addresses and reserve port for
1208 address and port pair mapping when dynamic translations enabled */
1209 if (!(sm->static_mapping_only || out2in_only))
1211 for (i = 0; i < vec_len (sm->addresses); i++)
1213 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1215 a = sm->addresses + i;
1216 /* External port must be unused */
1219 #define _(N, j, n, s) \
1220 case SNAT_PROTOCOL_##N: \
1221 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
1222 return VNET_API_ERROR_INVALID_VALUE; \
1223 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
1224 if (e_port > 1024) \
1226 a->busy_##n##_ports++; \
1227 a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]++; \
1230 foreach_snat_protocol
1233 clib_warning("unknown_protocol");
1234 return VNET_API_ERROR_INVALID_VALUE_2;
1239 /* External address must be allocated */
1241 return VNET_API_ERROR_NO_SUCH_ENTRY;
1244 pool_get (sm->static_mappings, m);
1245 memset (m, 0, sizeof (*m));
1246 m->tag = vec_dup (tag);
1247 m->external_addr = e_addr;
1250 m->fib_index = fib_index;
1251 m->external_port = e_port;
1253 m->twice_nat = twice_nat;
1254 m->out2in_only = out2in_only;
1256 m_key.addr = m->external_addr;
1257 m_key.port = m->external_port;
1258 m_key.protocol = m->proto;
1259 m_key.fib_index = sm->outside_fib_index;
1260 kv.key = m_key.as_u64;
1261 kv.value = m - sm->static_mappings;
1262 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 1))
1264 clib_warning ("static_mapping_by_external key add failed");
1265 return VNET_API_ERROR_UNSPECIFIED;
1271 worker_index = sm->first_worker_index +
1272 sm->workers[sm->next_worker++ % vec_len (sm->workers)];
1273 tsm = vec_elt_at_index (sm->per_thread_data, worker_index);
1274 m->worker_index = worker_index;
1277 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1279 m_key.port = clib_host_to_net_u16 (m->external_port);
1280 kv.key = m_key.as_u64;
1282 if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 1))
1284 clib_warning ("out2in key add failed");
1285 return VNET_API_ERROR_UNSPECIFIED;
1288 m_key.fib_index = m->fib_index;
1289 for (i = 0; i < vec_len (locals); i++)
1291 m_key.addr = locals[i].addr;
1294 m_key.port = locals[i].port;
1295 kv.key = m_key.as_u64;
1296 kv.value = m - sm->static_mappings;
1297 clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 1);
1299 locals[i].prefix = (i == 0) ? locals[i].probability :\
1300 (locals[i - 1].prefix + locals[i].probability);
1301 vec_add1 (m->locals, locals[i]);
1303 m_key.port = clib_host_to_net_u16 (locals[i].port);
1304 kv.key = m_key.as_u64;
1306 if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 1))
1308 clib_warning ("in2out key add failed");
1309 return VNET_API_ERROR_UNSPECIFIED;
1316 return VNET_API_ERROR_NO_SUCH_ENTRY;
1318 fib_table_unlock (m->fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_PLUGIN_LOW);
1320 /* Free external address port */
1321 if (!(sm->static_mapping_only || out2in_only))
1323 for (i = 0; i < vec_len (sm->addresses); i++)
1325 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1327 a = sm->addresses + i;
1330 #define _(N, j, n, s) \
1331 case SNAT_PROTOCOL_##N: \
1332 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
1333 if (e_port > 1024) \
1335 a->busy_##n##_ports--; \
1336 a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]--; \
1339 foreach_snat_protocol
1342 clib_warning("unknown_protocol");
1343 return VNET_API_ERROR_INVALID_VALUE_2;
1350 tsm = vec_elt_at_index (sm->per_thread_data, m->worker_index);
1351 m_key.addr = m->external_addr;
1352 m_key.port = m->external_port;
1353 m_key.protocol = m->proto;
1354 m_key.fib_index = sm->outside_fib_index;
1355 kv.key = m_key.as_u64;
1356 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 0))
1358 clib_warning ("static_mapping_by_external key del failed");
1359 return VNET_API_ERROR_UNSPECIFIED;
1362 m_key.port = clib_host_to_net_u16 (m->external_port);
1363 kv.key = m_key.as_u64;
1364 if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 0))
1366 clib_warning ("outi2in key del failed");
1367 return VNET_API_ERROR_UNSPECIFIED;
1370 vec_foreach (local, m->locals)
1372 m_key.addr = local->addr;
1375 m_key.port = local->port;
1376 m_key.fib_index = m->fib_index;
1377 kv.key = m_key.as_u64;
1378 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1380 clib_warning ("static_mapping_by_local key del failed");
1381 return VNET_API_ERROR_UNSPECIFIED;
1385 if (!lb_local_exists(local, &e_addr, e_port))
1387 m_key.port = clib_host_to_net_u16 (local->port);
1388 kv.key = m_key.as_u64;
1389 if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 0))
1391 clib_warning ("in2out key del failed");
1392 return VNET_API_ERROR_UNSPECIFIED;
1395 /* Delete sessions */
1396 u_key.addr = local->addr;
1397 u_key.fib_index = m->fib_index;
1398 kv.key = u_key.as_u64;
1399 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1401 u = pool_elt_at_index (tsm->users, value.value);
1402 if (u->nstaticsessions)
1404 head_index = u->sessions_per_user_list_head_index;
1405 head = pool_elt_at_index (tsm->list_pool, head_index);
1406 elt_index = head->next;
1407 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1408 ses_index = elt->value;
1409 while (ses_index != ~0)
1411 s = pool_elt_at_index (tsm->sessions, ses_index);
1412 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1413 ses_index = elt->value;
1415 if (!(is_lb_session (s)))
1418 if ((s->in2out.addr.as_u32 != local->addr.as_u32) &&
1419 (clib_net_to_host_u16 (s->in2out.port) != local->port))
1422 nat_free_session_data (sm, s, tsm - sm->per_thread_data);
1423 clib_dlist_remove (tsm->list_pool, s->per_user_index);
1424 pool_put_index (tsm->list_pool, s->per_user_index);
1425 pool_put (tsm->sessions, s);
1426 u->nstaticsessions--;
1431 vec_free(m->locals);
1434 pool_put (sm->static_mappings, m);
1441 snat_del_address (snat_main_t *sm, ip4_address_t addr, u8 delete_sm,
1444 snat_address_t *a = 0;
1445 snat_session_t *ses;
1446 u32 *ses_to_be_removed = 0, *ses_index;
1447 clib_bihash_kv_8_8_t kv, value;
1448 snat_user_key_t user_key;
1450 snat_main_per_thread_data_t *tsm;
1451 snat_static_mapping_t *m;
1452 snat_interface_t *interface;
1454 snat_address_t *addresses = twice_nat ? sm->twice_nat_addresses : sm->addresses;
1456 /* Find SNAT address */
1457 for (i=0; i < vec_len (addresses); i++)
1459 if (addresses[i].addr.as_u32 == addr.as_u32)
1466 return VNET_API_ERROR_NO_SUCH_ENTRY;
1470 pool_foreach (m, sm->static_mappings,
1472 if (m->external_addr.as_u32 == addr.as_u32)
1473 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1474 m->local_port, m->external_port,
1475 m->vrf_id, m->addr_only, ~0,
1476 m->proto, 0, m->twice_nat,
1477 m->out2in_only, m->tag);
1482 /* Check if address is used in some static mapping */
1483 if (is_snat_address_used_in_static_mapping(sm, addr))
1485 clib_warning ("address used in static mapping");
1486 return VNET_API_ERROR_UNSPECIFIED;
1490 if (a->fib_index != ~0)
1491 fib_table_unlock(a->fib_index, FIB_PROTOCOL_IP4,
1492 FIB_SOURCE_PLUGIN_LOW);
1494 /* Delete sessions using address */
1495 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1497 vec_foreach (tsm, sm->per_thread_data)
1499 pool_foreach (ses, tsm->sessions, ({
1500 if (ses->out2in.addr.as_u32 == addr.as_u32)
1502 ses->outside_address_index = ~0;
1503 nat_free_session_data (sm, ses, tsm - sm->per_thread_data);
1504 clib_dlist_remove (tsm->list_pool, ses->per_user_index);
1505 pool_put_index (tsm->list_pool, ses->per_user_index);
1506 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1507 user_key.addr = ses->in2out.addr;
1508 user_key.fib_index = ses->in2out.fib_index;
1509 kv.key = user_key.as_u64;
1510 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1512 u = pool_elt_at_index (tsm->users, value.value);
1518 vec_foreach (ses_index, ses_to_be_removed)
1519 pool_put_index (tsm->sessions, ses_index[0]);
1521 vec_free (ses_to_be_removed);
1527 vec_del1 (sm->twice_nat_addresses, i);
1531 vec_del1 (sm->addresses, i);
1533 /* Delete external address from FIB */
1534 pool_foreach (interface, sm->interfaces,
1536 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1539 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1542 pool_foreach (interface, sm->output_feature_interfaces,
1544 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1547 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1554 int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1556 snat_main_t *sm = &snat_main;
1557 snat_interface_t *i;
1558 const char * feature_name, *del_feature_name;
1559 snat_address_t * ap;
1560 snat_static_mapping_t * m;
1561 snat_det_map_t * dm;
1563 if (sm->out2in_dpo && !is_inside)
1564 return VNET_API_ERROR_UNSUPPORTED;
1566 pool_foreach (i, sm->output_feature_interfaces,
1568 if (i->sw_if_index == sw_if_index)
1569 return VNET_API_ERROR_VALUE_EXIST;
1572 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1573 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1576 if (sm->num_workers > 1 && !sm->deterministic)
1577 feature_name = is_inside ? "nat44-in2out-worker-handoff" : "nat44-out2in-worker-handoff";
1578 else if (sm->deterministic)
1579 feature_name = is_inside ? "nat44-det-in2out" : "nat44-det-out2in";
1581 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1584 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1585 sm->fq_in2out_index = vlib_frame_queue_main_init (sm->in2out_node_index, 0);
1587 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1588 sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index, 0);
1590 pool_foreach (i, sm->interfaces,
1592 if (i->sw_if_index == sw_if_index)
1596 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1599 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1601 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1603 if (sm->num_workers > 1 && !sm->deterministic)
1605 del_feature_name = "nat44-handoff-classify";
1606 feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1607 "nat44-out2in-worker-handoff";
1609 else if (sm->deterministic)
1611 del_feature_name = "nat44-det-classify";
1612 feature_name = !is_inside ? "nat44-det-in2out" :
1617 del_feature_name = "nat44-classify";
1618 feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1621 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1622 sw_if_index, 0, 0, 0);
1623 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1624 sw_if_index, 1, 0, 0);
1628 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1629 sw_if_index, 0, 0, 0);
1630 pool_put (sm->interfaces, i);
1635 if ((nat_interface_is_inside(i) && is_inside) ||
1636 (nat_interface_is_outside(i) && !is_inside))
1639 if (sm->num_workers > 1 && !sm->deterministic)
1641 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1642 "nat44-out2in-worker-handoff";
1643 feature_name = "nat44-handoff-classify";
1645 else if (sm->deterministic)
1647 del_feature_name = !is_inside ? "nat44-det-in2out" :
1649 feature_name = "nat44-det-classify";
1653 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1654 feature_name = "nat44-classify";
1657 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1658 sw_if_index, 0, 0, 0);
1659 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1660 sw_if_index, 1, 0, 0);
1669 return VNET_API_ERROR_NO_SUCH_ENTRY;
1671 pool_get (sm->interfaces, i);
1672 i->sw_if_index = sw_if_index;
1674 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0, 0);
1678 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1680 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1682 /* Add/delete external addresses to FIB */
1684 if (is_inside && !sm->out2in_dpo)
1686 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1687 sw_if_index, !is_del, 0, 0);
1691 vec_foreach (ap, sm->addresses)
1692 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1694 pool_foreach (m, sm->static_mappings,
1696 if (!(m->addr_only) || (m->local_addr.as_u32 == m->external_addr.as_u32))
1699 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1702 pool_foreach (dm, sm->det_maps,
1704 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
1710 int snat_interface_add_del_output_feature (u32 sw_if_index,
1714 snat_main_t *sm = &snat_main;
1715 snat_interface_t *i;
1716 snat_address_t * ap;
1717 snat_static_mapping_t * m;
1719 if (sm->deterministic ||
1720 (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
1721 return VNET_API_ERROR_UNSUPPORTED;
1723 pool_foreach (i, sm->interfaces,
1725 if (i->sw_if_index == sw_if_index)
1726 return VNET_API_ERROR_VALUE_EXIST;
1731 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
1732 sw_if_index, !is_del, 0, 0);
1733 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
1734 sw_if_index, !is_del, 0, 0);
1738 if (sm->num_workers > 1)
1740 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in-worker-handoff",
1741 sw_if_index, !is_del, 0, 0);
1742 vnet_feature_enable_disable ("ip4-output",
1743 "nat44-in2out-output-worker-handoff",
1744 sw_if_index, !is_del, 0, 0);
1748 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in", sw_if_index,
1750 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
1751 sw_if_index, !is_del, 0, 0);
1755 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
1756 sm->fq_in2out_output_index =
1757 vlib_frame_queue_main_init (sm->in2out_output_node_index, 0);
1759 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
1760 sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index, 0);
1762 pool_foreach (i, sm->output_feature_interfaces,
1764 if (i->sw_if_index == sw_if_index)
1767 pool_put (sm->output_feature_interfaces, i);
1769 return VNET_API_ERROR_VALUE_EXIST;
1776 return VNET_API_ERROR_NO_SUCH_ENTRY;
1778 pool_get (sm->output_feature_interfaces, i);
1779 i->sw_if_index = sw_if_index;
1782 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1784 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1786 /* Add/delete external addresses to FIB */
1791 vec_foreach (ap, sm->addresses)
1792 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1794 pool_foreach (m, sm->static_mappings,
1796 if (!(m->addr_only))
1799 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1805 int snat_set_workers (uword * bitmap)
1807 snat_main_t *sm = &snat_main;
1810 if (sm->num_workers < 2)
1811 return VNET_API_ERROR_FEATURE_DISABLED;
1813 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
1814 return VNET_API_ERROR_INVALID_WORKER;
1816 vec_free (sm->workers);
1817 clib_bitmap_foreach (i, bitmap,
1819 vec_add1(sm->workers, i);
1820 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
1824 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
1825 sm->num_snat_thread = _vec_len (sm->workers);
1832 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
1835 ip4_address_t * address,
1837 u32 if_address_index,
1841 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
1844 ip4_address_t * address,
1846 u32 if_address_index,
1850 nat_alloc_addr_and_port_default (snat_address_t * addresses,
1853 snat_session_key_t * k,
1854 u32 * address_indexp,
1855 u16 port_per_thread,
1856 u32 snat_thread_index);
1858 static clib_error_t * snat_init (vlib_main_t * vm)
1860 snat_main_t * sm = &snat_main;
1861 clib_error_t * error = 0;
1862 ip4_main_t * im = &ip4_main;
1863 ip_lookup_main_t * lm = &im->lookup_main;
1865 vlib_thread_registration_t *tr;
1866 vlib_thread_main_t *tm = vlib_get_thread_main ();
1869 ip4_add_del_interface_address_callback_t cb4;
1872 sm->vnet_main = vnet_get_main();
1874 sm->ip4_lookup_main = lm;
1875 sm->api_main = &api_main;
1876 sm->first_worker_index = 0;
1877 sm->next_worker = 0;
1878 sm->num_workers = 0;
1879 sm->num_snat_thread = 1;
1881 sm->port_per_thread = 0xffff - 1024;
1882 sm->fq_in2out_index = ~0;
1883 sm->fq_out2in_index = ~0;
1884 sm->udp_timeout = SNAT_UDP_TIMEOUT;
1885 sm->tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
1886 sm->tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
1887 sm->icmp_timeout = SNAT_ICMP_TIMEOUT;
1888 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
1889 sm->forwarding_enabled = 0;
1891 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1894 tr = (vlib_thread_registration_t *) p[0];
1897 sm->num_workers = tr->count;
1898 sm->first_worker_index = tr->first_index;
1902 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
1904 /* Use all available workers by default */
1905 if (sm->num_workers > 1)
1907 for (i=0; i < sm->num_workers; i++)
1908 bitmap = clib_bitmap_set (bitmap, i, 1);
1909 snat_set_workers(bitmap);
1910 clib_bitmap_free (bitmap);
1914 sm->per_thread_data[0].snat_thread_index = 0;
1917 error = snat_api_init(vm, sm);
1921 /* Set up the interface address add/del callback */
1922 cb4.function = snat_ip4_add_del_interface_address_cb;
1923 cb4.function_opaque = 0;
1925 vec_add1 (im->add_del_interface_address_callbacks, cb4);
1927 cb4.function = nat_ip4_add_del_addr_only_sm_cb;
1928 cb4.function_opaque = 0;
1930 vec_add1 (im->add_del_interface_address_callbacks, cb4);
1932 nat_dpo_module_init ();
1934 /* Init IPFIX logging */
1935 snat_ipfix_logging_init(vm);
1938 error = nat64_init(vm);
1946 /* Init virtual fragmenentation reassembly */
1947 return nat_reass_init(vm);
1950 VLIB_INIT_FUNCTION (snat_init);
1952 void snat_free_outside_address_and_port (snat_address_t * addresses,
1954 snat_session_key_t * k,
1958 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
1960 ASSERT (address_index < vec_len (addresses));
1962 a = addresses + address_index;
1964 switch (k->protocol)
1966 #define _(N, i, n, s) \
1967 case SNAT_PROTOCOL_##N: \
1968 ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
1969 port_host_byte_order) == 1); \
1970 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
1971 port_host_byte_order, 0); \
1972 a->busy_##n##_ports--; \
1973 a->busy_##n##_ports_per_thread[thread_index]--; \
1975 foreach_snat_protocol
1978 clib_warning("unknown_protocol");
1984 * @brief Match NAT44 static mapping.
1986 * @param sm NAT main.
1987 * @param match Address and port to match.
1988 * @param mapping External or local address and port of the matched mapping.
1989 * @param by_external If 0 match by local address otherwise match by external
1991 * @param is_addr_only If matched mapping is address only
1992 * @param twice_nat If matched mapping is twice NAT.
1993 * @param lb If matched mapping is load-balanced.
1995 * @returns 0 if match found otherwise 1.
1997 int snat_static_mapping_match (snat_main_t * sm,
1998 snat_session_key_t match,
1999 snat_session_key_t * mapping,
2002 twice_nat_type_t *twice_nat,
2005 clib_bihash_kv_8_8_t kv, value;
2006 snat_static_mapping_t *m;
2007 snat_session_key_t m_key;
2008 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
2009 u32 rand, lo = 0, hi, mid;
2012 mapping_hash = &sm->static_mapping_by_external;
2014 m_key.addr = match.addr;
2015 m_key.port = clib_net_to_host_u16 (match.port);
2016 m_key.protocol = match.protocol;
2017 m_key.fib_index = match.fib_index;
2019 kv.key = m_key.as_u64;
2021 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2023 /* Try address only mapping */
2026 kv.key = m_key.as_u64;
2027 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2031 m = pool_elt_at_index (sm->static_mappings, value.value);
2035 if (vec_len (m->locals))
2037 hi = vec_len (m->locals) - 1;
2038 rand = 1 + (random_u32 (&sm->random_seed) % m->locals[hi].prefix);
2041 mid = ((hi - lo) >> 1) + lo;
2042 (rand > m->locals[mid].prefix) ? (lo = mid + 1) : (hi = mid);
2044 if (!(m->locals[lo].prefix >= rand))
2046 mapping->addr = m->locals[lo].addr;
2047 mapping->port = clib_host_to_net_u16 (m->locals[lo].port);
2051 mapping->addr = m->local_addr;
2052 /* Address only mapping doesn't change port */
2053 mapping->port = m->addr_only ? match.port
2054 : clib_host_to_net_u16 (m->local_port);
2056 mapping->fib_index = m->fib_index;
2057 mapping->protocol = m->proto;
2061 mapping->addr = m->external_addr;
2062 /* Address only mapping doesn't change port */
2063 mapping->port = m->addr_only ? match.port
2064 : clib_host_to_net_u16 (m->external_port);
2065 mapping->fib_index = sm->outside_fib_index;
2068 if (PREDICT_FALSE(is_addr_only != 0))
2069 *is_addr_only = m->addr_only;
2071 if (PREDICT_FALSE(twice_nat != 0))
2072 *twice_nat = m->twice_nat;
2074 if (PREDICT_FALSE(lb != 0))
2075 *lb = vec_len (m->locals) > 0;
2080 static_always_inline u16
2081 snat_random_port (u16 min, u16 max)
2083 snat_main_t *sm = &snat_main;
2084 return min + random_u32 (&sm->random_seed) /
2085 (random_u32_max() / (max - min + 1) + 1);
2089 snat_alloc_outside_address_and_port (snat_address_t * addresses,
2092 snat_session_key_t * k,
2093 u32 * address_indexp,
2094 u16 port_per_thread,
2095 u32 snat_thread_index)
2097 snat_main_t *sm = &snat_main;
2099 return sm->alloc_addr_and_port(addresses, fib_index, thread_index, k,
2100 address_indexp, port_per_thread,
2105 nat_alloc_addr_and_port_default (snat_address_t * addresses,
2108 snat_session_key_t * k,
2109 u32 * address_indexp,
2110 u16 port_per_thread,
2111 u32 snat_thread_index)
2114 snat_address_t *a, *ga = 0;
2117 for (i = 0; i < vec_len (addresses); i++)
2120 switch (k->protocol)
2122 #define _(N, j, n, s) \
2123 case SNAT_PROTOCOL_##N: \
2124 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
2126 if (a->fib_index == fib_index) \
2130 portnum = (port_per_thread * \
2131 snat_thread_index) + \
2132 snat_random_port(1, port_per_thread) + 1024; \
2133 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2135 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2136 a->busy_##n##_ports_per_thread[thread_index]++; \
2137 a->busy_##n##_ports++; \
2138 k->addr = a->addr; \
2139 k->port = clib_host_to_net_u16(portnum); \
2140 *address_indexp = i; \
2144 else if (a->fib_index == ~0) \
2151 foreach_snat_protocol
2154 clib_warning("unknown protocol");
2163 switch (k->protocol)
2165 #define _(N, j, n, s) \
2166 case SNAT_PROTOCOL_##N: \
2169 portnum = (port_per_thread * \
2170 snat_thread_index) + \
2171 snat_random_port(1, port_per_thread) + 1024; \
2172 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2174 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2175 a->busy_##n##_ports_per_thread[thread_index]++; \
2176 a->busy_##n##_ports++; \
2177 k->addr = a->addr; \
2178 k->port = clib_host_to_net_u16(portnum); \
2179 *address_indexp = gi; \
2183 foreach_snat_protocol
2186 clib_warning ("unknown protocol");
2191 /* Totally out of translations to use... */
2192 snat_ipfix_logging_addresses_exhausted(0);
2197 nat_alloc_addr_and_port_mape (snat_address_t * addresses,
2200 snat_session_key_t * k,
2201 u32 * address_indexp,
2202 u16 port_per_thread,
2203 u32 snat_thread_index)
2205 snat_main_t *sm = &snat_main;
2206 snat_address_t *a = addresses;
2207 u16 m, ports, portnum, A, j;
2208 m = 16 - (sm->psid_offset + sm->psid_length);
2209 ports = (1 << (16 - sm->psid_length)) - (1 << m);
2211 if (!vec_len (addresses))
2214 switch (k->protocol)
2216 #define _(N, i, n, s) \
2217 case SNAT_PROTOCOL_##N: \
2218 if (a->busy_##n##_ports < ports) \
2222 A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
2223 j = snat_random_port(0, pow2_mask(m)); \
2224 portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
2225 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2227 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2228 a->busy_##n##_ports++; \
2229 k->addr = a->addr; \
2230 k->port = clib_host_to_net_u16 (portnum); \
2231 *address_indexp = i; \
2236 foreach_snat_protocol
2239 clib_warning("unknown protocol");
2244 /* Totally out of translations to use... */
2245 snat_ipfix_logging_addresses_exhausted(0);
2250 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
2252 dpo_id_t dpo_v4 = DPO_INVALID;
2253 fib_prefix_t pfx = {
2254 .fp_proto = FIB_PROTOCOL_IP4,
2256 .fp_addr.ip4.as_u32 = addr.as_u32,
2261 nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
2262 fib_table_entry_special_dpo_add (0, &pfx, FIB_SOURCE_PLUGIN_HI,
2263 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
2264 dpo_reset (&dpo_v4);
2268 fib_table_entry_special_remove (0, &pfx, FIB_SOURCE_PLUGIN_HI);
2273 unformat_snat_protocol (unformat_input_t * input, va_list * args)
2275 u32 *r = va_arg (*args, u32 *);
2278 #define _(N, i, n, s) else if (unformat (input, s)) *r = SNAT_PROTOCOL_##N;
2279 foreach_snat_protocol
2287 format_snat_protocol (u8 * s, va_list * args)
2289 u32 i = va_arg (*args, u32);
2294 #define _(N, j, n, str) case SNAT_PROTOCOL_##N: t = (u8 *) str; break;
2295 foreach_snat_protocol
2298 s = format (s, "unknown");
2301 s = format (s, "%s", t);
2306 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2308 snat_main_t *sm = &snat_main;
2309 u32 next_worker_index = 0;
2312 next_worker_index = sm->first_worker_index;
2313 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
2314 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >>24);
2316 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
2317 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
2319 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
2321 return next_worker_index;
2325 snat_get_worker_out2in_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2327 snat_main_t *sm = &snat_main;
2330 snat_session_key_t m_key;
2331 clib_bihash_kv_8_8_t kv, value;
2332 snat_static_mapping_t *m;
2333 nat_ed_ses_key_t key;
2334 clib_bihash_kv_16_8_t s_kv, s_value;
2335 snat_main_per_thread_data_t *tsm;
2339 u32 next_worker_index = 0;
2341 /* first try static mappings without port */
2342 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2344 m_key.addr = ip0->dst_address;
2347 m_key.fib_index = rx_fib_index0;
2348 kv.key = m_key.as_u64;
2349 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
2351 m = pool_elt_at_index (sm->static_mappings, value.value);
2352 return m->worker_index;
2356 proto = ip_proto_to_snat_proto (ip0->protocol);
2357 udp = ip4_next_header (ip0);
2358 port = udp->dst_port;
2360 if (PREDICT_FALSE (ip4_is_fragment (ip0)))
2362 if (PREDICT_FALSE (nat_reass_is_drop_frag (0)))
2363 return vlib_get_thread_index ();
2365 if (PREDICT_TRUE (!ip4_is_first_fragment (ip0)))
2367 nat_reass_ip4_t *reass;
2369 reass = nat_ip4_reass_find (ip0->src_address, ip0->dst_address,
2370 ip0->fragment_id, ip0->protocol);
2372 if (reass && (reass->thread_index != (u32) ~ 0))
2373 return reass->thread_index;
2375 return vlib_get_thread_index ();
2379 /* unknown protocol */
2380 if (PREDICT_FALSE (proto == ~0))
2382 key.l_addr = ip0->dst_address;
2383 key.r_addr = ip0->src_address;
2384 key.fib_index = rx_fib_index0;
2385 key.proto = ip0->protocol;
2388 s_kv.key[0] = key.as_u64[0];
2389 s_kv.key[1] = key.as_u64[1];
2391 if (!clib_bihash_search_16_8 (&sm->out2in_ed, &s_kv, &s_value))
2393 for (i = 0; i < _vec_len (sm->per_thread_data); i++)
2395 tsm = vec_elt_at_index (sm->per_thread_data, i);
2396 if (!pool_is_free_index(tsm->sessions, s_value.value))
2398 s = pool_elt_at_index (tsm->sessions, s_value.value);
2399 if (s->out2in.addr.as_u32 == ip0->dst_address.as_u32 &&
2400 s->out2in.port == ip0->protocol &&
2401 snat_is_unk_proto_session (s))
2407 /* if no session use current thread */
2408 return vlib_get_thread_index ();
2411 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
2413 icmp46_header_t * icmp = (icmp46_header_t *) udp;
2414 icmp_echo_header_t *echo = (icmp_echo_header_t *)(icmp + 1);
2415 if (!icmp_is_error_message (icmp))
2416 port = echo->identifier;
2419 ip4_header_t *inner_ip = (ip4_header_t *)(echo + 1);
2420 proto = ip_proto_to_snat_proto (inner_ip->protocol);
2421 void *l4_header = ip4_next_header (inner_ip);
2424 case SNAT_PROTOCOL_ICMP:
2425 icmp = (icmp46_header_t*)l4_header;
2426 echo = (icmp_echo_header_t *)(icmp + 1);
2427 port = echo->identifier;
2429 case SNAT_PROTOCOL_UDP:
2430 case SNAT_PROTOCOL_TCP:
2431 port = ((tcp_udp_header_t*)l4_header)->src_port;
2434 return vlib_get_thread_index ();
2439 /* try static mappings with port */
2440 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2442 m_key.addr = ip0->dst_address;
2443 m_key.port = clib_net_to_host_u16 (port);
2444 m_key.protocol = proto;
2445 m_key.fib_index = rx_fib_index0;
2446 kv.key = m_key.as_u64;
2447 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
2449 m = pool_elt_at_index (sm->static_mappings, value.value);
2450 return m->worker_index;
2454 /* worker by outside port */
2455 next_worker_index = sm->first_worker_index;
2456 next_worker_index +=
2457 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
2458 return next_worker_index;
2461 static clib_error_t *
2462 snat_config (vlib_main_t * vm, unformat_input_t * input)
2464 snat_main_t * sm = &snat_main;
2465 nat66_main_t * nm = &nat66_main;
2466 u32 translation_buckets = 1024;
2467 u32 translation_memory_size = 128<<20;
2468 u32 user_buckets = 128;
2469 u32 user_memory_size = 64<<20;
2470 u32 max_translations_per_user = 100;
2471 u32 outside_vrf_id = 0;
2472 u32 outside_ip6_vrf_id = 0;
2473 u32 inside_vrf_id = 0;
2474 u32 static_mapping_buckets = 1024;
2475 u32 static_mapping_memory_size = 64<<20;
2476 u32 nat64_bib_buckets = 1024;
2477 u32 nat64_bib_memory_size = 128 << 20;
2478 u32 nat64_st_buckets = 2048;
2479 u32 nat64_st_memory_size = 256 << 20;
2480 u8 static_mapping_only = 0;
2481 u8 static_mapping_connection_tracking = 0;
2482 snat_main_per_thread_data_t *tsm;
2483 dslite_main_t * dm = &dslite_main;
2485 sm->deterministic = 0;
2488 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2490 if (unformat (input, "translation hash buckets %d", &translation_buckets))
2492 else if (unformat (input, "translation hash memory %d",
2493 &translation_memory_size));
2494 else if (unformat (input, "user hash buckets %d", &user_buckets))
2496 else if (unformat (input, "user hash memory %d",
2499 else if (unformat (input, "max translations per user %d",
2500 &max_translations_per_user))
2502 else if (unformat (input, "outside VRF id %d",
2505 else if (unformat (input, "outside ip6 VRF id %d",
2506 &outside_ip6_vrf_id))
2508 else if (unformat (input, "inside VRF id %d",
2511 else if (unformat (input, "static mapping only"))
2513 static_mapping_only = 1;
2514 if (unformat (input, "connection tracking"))
2515 static_mapping_connection_tracking = 1;
2517 else if (unformat (input, "deterministic"))
2518 sm->deterministic = 1;
2519 else if (unformat (input, "nat64 bib hash buckets %d",
2520 &nat64_bib_buckets))
2522 else if (unformat (input, "nat64 bib hash memory %d",
2523 &nat64_bib_memory_size))
2525 else if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
2527 else if (unformat (input, "nat64 st hash memory %d",
2528 &nat64_st_memory_size))
2530 else if (unformat (input, "out2in dpo"))
2532 else if (unformat (input, "dslite ce"))
2533 dslite_set_ce(dm, 1);
2535 return clib_error_return (0, "unknown input '%U'",
2536 format_unformat_error, input);
2539 /* for show commands, etc. */
2540 sm->translation_buckets = translation_buckets;
2541 sm->translation_memory_size = translation_memory_size;
2542 /* do not exceed load factor 10 */
2543 sm->max_translations = 10 * translation_buckets;
2544 sm->user_buckets = user_buckets;
2545 sm->user_memory_size = user_memory_size;
2546 sm->max_translations_per_user = max_translations_per_user;
2547 sm->outside_vrf_id = outside_vrf_id;
2548 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2550 FIB_SOURCE_PLUGIN_HI);
2551 nm->outside_vrf_id = outside_ip6_vrf_id;
2552 nm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6,
2554 FIB_SOURCE_PLUGIN_HI);
2555 sm->inside_vrf_id = inside_vrf_id;
2556 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2558 FIB_SOURCE_PLUGIN_HI);
2559 sm->static_mapping_only = static_mapping_only;
2560 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
2562 nat64_set_hash(nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
2563 nat64_st_memory_size);
2565 if (sm->deterministic)
2567 sm->in2out_node_index = snat_det_in2out_node.index;
2568 sm->in2out_output_node_index = ~0;
2569 sm->out2in_node_index = snat_det_out2in_node.index;
2570 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
2571 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
2575 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
2576 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
2577 sm->in2out_node_index = snat_in2out_node.index;
2578 sm->in2out_output_node_index = snat_in2out_output_node.index;
2579 sm->out2in_node_index = snat_out2in_node.index;
2580 if (!static_mapping_only ||
2581 (static_mapping_only && static_mapping_connection_tracking))
2583 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
2584 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
2586 vec_foreach (tsm, sm->per_thread_data)
2588 clib_bihash_init_8_8 (&tsm->in2out, "in2out", translation_buckets,
2589 translation_memory_size);
2591 clib_bihash_init_8_8 (&tsm->out2in, "out2in", translation_buckets,
2592 translation_memory_size);
2594 clib_bihash_init_8_8 (&tsm->user_hash, "users", user_buckets,
2598 clib_bihash_init_16_8 (&sm->in2out_ed, "in2out-ed",
2599 translation_buckets, translation_memory_size);
2601 clib_bihash_init_16_8 (&sm->out2in_ed, "out2in-ed",
2602 translation_buckets, translation_memory_size);
2606 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
2607 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
2609 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
2610 "static_mapping_by_local", static_mapping_buckets,
2611 static_mapping_memory_size);
2613 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
2614 "static_mapping_by_external", static_mapping_buckets,
2615 static_mapping_memory_size);
2621 VLIB_CONFIG_FUNCTION (snat_config, "nat");
2623 u8 * format_snat_session_state (u8 * s, va_list * args)
2625 u32 i = va_arg (*args, u32);
2630 #define _(v, N, str) case SNAT_SESSION_##N: t = (u8 *) str; break;
2631 foreach_snat_session_state
2634 t = format (t, "unknown");
2636 s = format (s, "%s", t);
2640 u8 * format_snat_key (u8 * s, va_list * args)
2642 snat_session_key_t * key = va_arg (*args, snat_session_key_t *);
2644 s = format (s, "%U proto %U port %d fib %d",
2645 format_ip4_address, &key->addr,
2646 format_snat_protocol, key->protocol,
2647 clib_net_to_host_u16 (key->port), key->fib_index);
2651 u8 * format_snat_session (u8 * s, va_list * args)
2653 snat_main_t * sm __attribute__((unused)) = va_arg (*args, snat_main_t *);
2654 snat_session_t * sess = va_arg (*args, snat_session_t *);
2656 if (snat_is_unk_proto_session (sess))
2658 s = format (s, " i2o %U proto %u fib %u\n",
2659 format_ip4_address, &sess->in2out.addr,
2660 clib_net_to_host_u16 (sess->in2out.port),
2661 sess->in2out.fib_index);
2662 s = format (s, " o2i %U proto %u fib %u\n",
2663 format_ip4_address, &sess->out2in.addr,
2664 clib_net_to_host_u16 (sess->out2in.port),
2665 sess->out2in.fib_index);
2669 s = format (s, " i2o %U\n", format_snat_key, &sess->in2out);
2670 s = format (s, " o2i %U\n", format_snat_key, &sess->out2in);
2672 if (is_twice_nat_session (sess))
2674 s = format (s, " external host o2i %U:%d i2o %U:%d\n",
2675 format_ip4_address, &sess->ext_host_addr,
2676 clib_net_to_host_u16 (sess->ext_host_port),
2677 format_ip4_address, &sess->ext_host_nat_addr,
2678 clib_net_to_host_u16 (sess->ext_host_nat_port));
2682 if (sess->ext_host_addr.as_u32)
2683 s = format (s, " external host %U\n",
2684 format_ip4_address, &sess->ext_host_addr);
2686 s = format (s, " last heard %.2f\n", sess->last_heard);
2687 s = format (s, " total pkts %d, total bytes %lld\n",
2688 sess->total_pkts, sess->total_bytes);
2689 if (snat_is_session_static (sess))
2690 s = format (s, " static translation\n");
2692 s = format (s, " dynamic translation\n");
2693 if (sess->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
2694 s = format (s, " load-balancing\n");
2695 if (is_twice_nat_session (sess))
2696 s = format (s, " twice-nat\n");
2701 u8 * format_snat_user (u8 * s, va_list * args)
2703 snat_main_per_thread_data_t * sm = va_arg (*args, snat_main_per_thread_data_t *);
2704 snat_user_t * u = va_arg (*args, snat_user_t *);
2705 int verbose = va_arg (*args, int);
2706 dlist_elt_t * head, * elt;
2707 u32 elt_index, head_index;
2709 snat_session_t * sess;
2711 s = format (s, "%U: %d dynamic translations, %d static translations\n",
2712 format_ip4_address, &u->addr, u->nsessions, u->nstaticsessions);
2717 if (u->nsessions || u->nstaticsessions)
2719 head_index = u->sessions_per_user_list_head_index;
2720 head = pool_elt_at_index (sm->list_pool, head_index);
2722 elt_index = head->next;
2723 elt = pool_elt_at_index (sm->list_pool, elt_index);
2724 session_index = elt->value;
2726 while (session_index != ~0)
2728 sess = pool_elt_at_index (sm->sessions, session_index);
2730 s = format (s, " %U\n", format_snat_session, sm, sess);
2732 elt_index = elt->next;
2733 elt = pool_elt_at_index (sm->list_pool, elt_index);
2734 session_index = elt->value;
2741 u8 * format_snat_static_mapping (u8 * s, va_list * args)
2743 snat_static_mapping_t *m = va_arg (*args, snat_static_mapping_t *);
2744 nat44_lb_addr_port_t *local;
2747 s = format (s, "local %U external %U vrf %d %s",
2748 format_ip4_address, &m->local_addr,
2749 format_ip4_address, &m->external_addr,
2751 m->twice_nat == TWICE_NAT ? "twice-nat" :
2752 m->twice_nat == TWICE_NAT_SELF ? "self-twice-nat" : "");
2755 if (vec_len (m->locals))
2757 s = format (s, "%U vrf %d external %U:%d %s %s",
2758 format_snat_protocol, m->proto,
2760 format_ip4_address, &m->external_addr, m->external_port,
2761 m->twice_nat == TWICE_NAT ? "twice-nat" :
2762 m->twice_nat == TWICE_NAT_SELF ? "self-twice-nat" : "",
2763 m->out2in_only ? "out2in-only" : "");
2764 vec_foreach (local, m->locals)
2765 s = format (s, "\n local %U:%d probability %d\%",
2766 format_ip4_address, &local->addr, local->port,
2767 local->probability);
2770 s = format (s, "%U local %U:%d external %U:%d vrf %d %s %s",
2771 format_snat_protocol, m->proto,
2772 format_ip4_address, &m->local_addr, m->local_port,
2773 format_ip4_address, &m->external_addr, m->external_port,
2775 m->twice_nat == TWICE_NAT ? "twice-nat" :
2776 m->twice_nat == TWICE_NAT_SELF ? "self-twice-nat" : "",
2777 m->out2in_only ? "out2in-only" : "");
2782 u8 * format_snat_static_map_to_resolve (u8 * s, va_list * args)
2784 snat_static_map_resolve_t *m = va_arg (*args, snat_static_map_resolve_t *);
2785 vnet_main_t *vnm = vnet_get_main();
2788 s = format (s, "local %U external %U vrf %d",
2789 format_ip4_address, &m->l_addr,
2790 format_vnet_sw_if_index_name, vnm, m->sw_if_index,
2793 s = format (s, "%U local %U:%d external %U:%d vrf %d",
2794 format_snat_protocol, m->proto,
2795 format_ip4_address, &m->l_addr, m->l_port,
2796 format_vnet_sw_if_index_name, vnm, m->sw_if_index,
2797 m->e_port, m->vrf_id);
2802 u8 * format_det_map_ses (u8 * s, va_list * args)
2804 snat_det_map_t * det_map = va_arg (*args, snat_det_map_t *);
2805 ip4_address_t in_addr, out_addr;
2806 u32 in_offset, out_offset;
2807 snat_det_session_t * ses = va_arg (*args, snat_det_session_t *);
2808 u32 * i = va_arg (*args, u32 *);
2810 u32 user_index = *i / SNAT_DET_SES_PER_USER;
2811 in_addr.as_u32 = clib_host_to_net_u32 (
2812 clib_net_to_host_u32(det_map->in_addr.as_u32) + user_index);
2813 in_offset = clib_net_to_host_u32(in_addr.as_u32) -
2814 clib_net_to_host_u32(det_map->in_addr.as_u32);
2815 out_offset = in_offset / det_map->sharing_ratio;
2816 out_addr.as_u32 = clib_host_to_net_u32(
2817 clib_net_to_host_u32(det_map->out_addr.as_u32) + out_offset);
2818 s = format (s, "in %U:%d out %U:%d external host %U:%d state: %U expire: %d\n",
2819 format_ip4_address, &in_addr,
2820 clib_net_to_host_u16 (ses->in_port),
2821 format_ip4_address, &out_addr,
2822 clib_net_to_host_u16 (ses->out.out_port),
2823 format_ip4_address, &ses->out.ext_host_addr,
2824 clib_net_to_host_u16 (ses->out.ext_host_port),
2825 format_snat_session_state, ses->state,
2832 nat_ip4_add_del_addr_only_sm_cb (ip4_main_t * im,
2835 ip4_address_t * address,
2837 u32 if_address_index,
2840 snat_main_t *sm = &snat_main;
2841 snat_static_map_resolve_t *rp;
2842 snat_static_mapping_t *m;
2843 snat_session_key_t m_key;
2844 clib_bihash_kv_8_8_t kv, value;
2846 ip4_address_t l_addr;
2848 for (i = 0; i < vec_len (sm->to_resolve); i++)
2850 rp = sm->to_resolve + i;
2851 if (rp->addr_only == 0)
2853 if (rp->sw_if_index == sw_if_index)
2860 m_key.addr.as_u32 = address->as_u32;
2861 m_key.port = rp->addr_only ? 0 : rp->e_port;
2862 m_key.protocol = rp->addr_only ? 0 : rp->proto;
2863 m_key.fib_index = sm->outside_fib_index;
2864 kv.key = m_key.as_u64;
2865 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
2868 m = pool_elt_at_index (sm->static_mappings, value.value);
2872 /* Don't trip over lease renewal, static config */
2882 /* Indetity mapping? */
2883 if (rp->l_addr.as_u32 == 0)
2884 l_addr.as_u32 = address[0].as_u32;
2886 l_addr.as_u32 = rp->l_addr.as_u32;
2887 /* Add the static mapping */
2888 rv = snat_add_static_mapping (l_addr,
2894 ~0 /* sw_if_index */,
2899 clib_warning ("snat_add_static_mapping returned %d", rv);
2903 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
2906 ip4_address_t * address,
2908 u32 if_address_index,
2911 snat_main_t *sm = &snat_main;
2912 snat_static_map_resolve_t *rp;
2913 ip4_address_t l_addr;
2917 snat_address_t *addresses = sm->addresses;
2919 for (i = 0; i < vec_len(sm->auto_add_sw_if_indices); i++)
2921 if (sw_if_index == sm->auto_add_sw_if_indices[i])
2925 for (i = 0; i < vec_len(sm->auto_add_sw_if_indices_twice_nat); i++)
2928 addresses = sm->twice_nat_addresses;
2929 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
2938 /* Don't trip over lease renewal, static config */
2939 for (j = 0; j < vec_len(addresses); j++)
2940 if (addresses[j].addr.as_u32 == address->as_u32)
2943 snat_add_address (sm, address, ~0, twice_nat);
2944 /* Scan static map resolution vector */
2945 for (j = 0; j < vec_len (sm->to_resolve); j++)
2947 rp = sm->to_resolve + j;
2950 /* On this interface? */
2951 if (rp->sw_if_index == sw_if_index)
2953 /* Indetity mapping? */
2954 if (rp->l_addr.as_u32 == 0)
2955 l_addr.as_u32 = address[0].as_u32;
2957 l_addr.as_u32 = rp->l_addr.as_u32;
2958 /* Add the static mapping */
2959 rv = snat_add_static_mapping (l_addr,
2965 ~0 /* sw_if_index */,
2970 clib_warning ("snat_add_static_mapping returned %d",
2978 (void) snat_del_address(sm, address[0], 1, twice_nat);
2984 int snat_add_interface_address (snat_main_t *sm, u32 sw_if_index, int is_del,
2987 ip4_main_t * ip4_main = sm->ip4_main;
2988 ip4_address_t * first_int_addr;
2989 snat_static_map_resolve_t *rp;
2990 u32 *indices_to_delete = 0;
2992 u32 *auto_add_sw_if_indices =
2993 twice_nat ? sm->auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
2995 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index,
2996 0 /* just want the address*/);
2998 for (i = 0; i < vec_len(auto_add_sw_if_indices); i++)
3000 if (auto_add_sw_if_indices[i] == sw_if_index)
3004 /* if have address remove it */
3006 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
3009 for (j = 0; j < vec_len (sm->to_resolve); j++)
3011 rp = sm->to_resolve + j;
3012 if (rp->sw_if_index == sw_if_index)
3013 vec_add1 (indices_to_delete, j);
3015 if (vec_len(indices_to_delete))
3017 for (j = vec_len(indices_to_delete)-1; j >= 0; j--)
3018 vec_del1(sm->to_resolve, j);
3019 vec_free(indices_to_delete);
3023 vec_del1(sm->auto_add_sw_if_indices_twice_nat, i);
3025 vec_del1(sm->auto_add_sw_if_indices, i);
3028 return VNET_API_ERROR_VALUE_EXIST;
3035 return VNET_API_ERROR_NO_SUCH_ENTRY;
3037 /* add to the auto-address list */
3039 vec_add1(sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
3041 vec_add1(sm->auto_add_sw_if_indices, sw_if_index);
3043 /* If the address is already bound - or static - add it now */
3045 snat_add_address (sm, first_int_addr, ~0, twice_nat);
3051 nat44_del_session (snat_main_t *sm, ip4_address_t *addr, u16 port,
3052 snat_protocol_t proto, u32 vrf_id, int is_in)
3054 snat_main_per_thread_data_t *tsm;
3055 clib_bihash_kv_8_8_t kv, value;
3057 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3058 snat_session_key_t key;
3060 clib_bihash_8_8_t *t;
3061 snat_user_key_t u_key;
3064 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
3065 if (sm->num_workers > 1)
3067 vec_elt_at_index (sm->per_thread_data,
3068 sm->worker_in2out_cb (&ip, fib_index));
3070 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
3072 key.addr.as_u32 = addr->as_u32;
3073 key.port = clib_host_to_net_u16 (port);
3074 key.protocol = proto;
3075 key.fib_index = fib_index;
3076 kv.key = key.as_u64;
3077 t = is_in ? &tsm->in2out : &tsm->out2in;
3078 if (!clib_bihash_search_8_8 (t, &kv, &value))
3080 s = pool_elt_at_index (tsm->sessions, value.value);
3081 kv.key = s->in2out.as_u64;
3082 clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0);
3083 kv.key = s->out2in.as_u64;
3084 clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0);
3085 u_key.addr = s->in2out.addr;
3086 u_key.fib_index = s->in2out.fib_index;
3087 kv.key = u_key.as_u64;
3088 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
3090 u = pool_elt_at_index (tsm->users, value.value);
3093 clib_dlist_remove (tsm->list_pool, s->per_user_index);
3094 pool_put (tsm->sessions, s);
3098 return VNET_API_ERROR_NO_SUCH_ENTRY;
3102 nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset, u16 psid_length)
3104 snat_main_t *sm = &snat_main;
3106 sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
3108 sm->psid_offset = psid_offset;
3109 sm->psid_length = psid_length;
3113 nat_set_alloc_addr_and_port_default (void)
3115 snat_main_t *sm = &snat_main;
3117 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;