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_ipfix_logging.h>
24 #include <nat/nat_det.h>
25 #include <nat/nat64.h>
26 #include <nat/dslite.h>
27 #include <vnet/fib/fib_table.h>
28 #include <vnet/fib/ip4_fib.h>
30 #include <vpp/app/version.h>
32 snat_main_t snat_main;
35 /* Hook up input features */
36 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
37 .arc_name = "ip4-unicast",
38 .node_name = "nat44-in2out",
39 .runs_before = VNET_FEATURES ("nat44-out2in"),
41 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
42 .arc_name = "ip4-unicast",
43 .node_name = "nat44-out2in",
44 .runs_before = VNET_FEATURES ("ip4-lookup"),
46 VNET_FEATURE_INIT (ip4_nat_classify, static) = {
47 .arc_name = "ip4-unicast",
48 .node_name = "nat44-classify",
49 .runs_before = VNET_FEATURES ("ip4-lookup"),
51 VNET_FEATURE_INIT (ip4_snat_det_in2out, static) = {
52 .arc_name = "ip4-unicast",
53 .node_name = "nat44-det-in2out",
54 .runs_before = VNET_FEATURES ("nat44-det-out2in"),
56 VNET_FEATURE_INIT (ip4_snat_det_out2in, static) = {
57 .arc_name = "ip4-unicast",
58 .node_name = "nat44-det-out2in",
59 .runs_before = VNET_FEATURES ("ip4-lookup"),
61 VNET_FEATURE_INIT (ip4_nat_det_classify, static) = {
62 .arc_name = "ip4-unicast",
63 .node_name = "nat44-det-classify",
64 .runs_before = VNET_FEATURES ("ip4-lookup"),
66 VNET_FEATURE_INIT (ip4_snat_in2out_worker_handoff, static) = {
67 .arc_name = "ip4-unicast",
68 .node_name = "nat44-in2out-worker-handoff",
69 .runs_before = VNET_FEATURES ("nat44-out2in-worker-handoff"),
71 VNET_FEATURE_INIT (ip4_snat_out2in_worker_handoff, static) = {
72 .arc_name = "ip4-unicast",
73 .node_name = "nat44-out2in-worker-handoff",
74 .runs_before = VNET_FEATURES ("ip4-lookup"),
76 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
77 .arc_name = "ip4-unicast",
78 .node_name = "nat44-handoff-classify",
79 .runs_before = VNET_FEATURES ("ip4-lookup"),
81 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
82 .arc_name = "ip4-unicast",
83 .node_name = "nat44-in2out-fast",
84 .runs_before = VNET_FEATURES ("nat44-out2in-fast"),
86 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
87 .arc_name = "ip4-unicast",
88 .node_name = "nat44-out2in-fast",
89 .runs_before = VNET_FEATURES ("ip4-lookup"),
91 VNET_FEATURE_INIT (ip4_snat_hairpin_dst, static) = {
92 .arc_name = "ip4-unicast",
93 .node_name = "nat44-hairpin-dst",
94 .runs_before = VNET_FEATURES ("ip4-lookup"),
97 /* Hook up output features */
98 VNET_FEATURE_INIT (ip4_snat_in2out_output, static) = {
99 .arc_name = "ip4-output",
100 .node_name = "nat44-in2out-output",
101 .runs_before = VNET_FEATURES ("interface-output"),
103 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
104 .arc_name = "ip4-output",
105 .node_name = "nat44-in2out-output-worker-handoff",
106 .runs_before = VNET_FEATURES ("interface-output"),
108 VNET_FEATURE_INIT (ip4_snat_hairpin_src, static) = {
109 .arc_name = "ip4-output",
110 .node_name = "nat44-hairpin-src",
111 .runs_before = VNET_FEATURES ("interface-output"),
114 /* Hook up ip4-local features */
115 VNET_FEATURE_INIT (ip4_nat_hairpinning, static) =
117 .arc_name = "ip4-local",
118 .node_name = "nat44-hairpinning",
119 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
124 VLIB_PLUGIN_REGISTER () = {
125 .version = VPP_BUILD_VER,
126 .description = "Network Address Translation",
130 vlib_node_registration_t nat44_classify_node;
131 vlib_node_registration_t nat44_det_classify_node;
132 vlib_node_registration_t nat44_handoff_classify_node;
135 NAT44_CLASSIFY_NEXT_IN2OUT,
136 NAT44_CLASSIFY_NEXT_OUT2IN,
137 NAT44_CLASSIFY_N_NEXT,
138 } nat44_classify_next_t;
141 nat44_classify_node_fn_inline (vlib_main_t * vm,
142 vlib_node_runtime_t * node,
143 vlib_frame_t * frame)
145 u32 n_left_from, * from, * to_next;
146 nat44_classify_next_t next_index;
147 snat_main_t *sm = &snat_main;
149 from = vlib_frame_vector_args (frame);
150 n_left_from = frame->n_vectors;
151 next_index = node->cached_next_index;
153 while (n_left_from > 0)
157 vlib_get_next_frame (vm, node, next_index,
158 to_next, n_left_to_next);
160 while (n_left_from > 0 && n_left_to_next > 0)
164 u32 next0 = NAT44_CLASSIFY_NEXT_IN2OUT;
167 snat_session_key_t m_key0;
168 clib_bihash_kv_8_8_t kv0, value0;
170 /* speculatively enqueue b0 to the current next frame */
178 b0 = vlib_get_buffer (vm, bi0);
179 ip0 = vlib_buffer_get_current (b0);
181 vec_foreach (ap, sm->addresses)
183 if (ip0->dst_address.as_u32 == ap->addr.as_u32)
185 next0 = NAT44_CLASSIFY_NEXT_OUT2IN;
190 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
192 m_key0.addr = ip0->dst_address;
195 m_key0.fib_index = sm->outside_fib_index;
196 kv0.key = m_key0.as_u64;
197 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv0, &value0))
199 next0 = NAT44_CLASSIFY_NEXT_OUT2IN;
202 /* verify speculative enqueue, maybe switch current next frame */
203 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
204 to_next, n_left_to_next,
208 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
211 return frame->n_vectors;
215 nat44_classify_node_fn (vlib_main_t * vm,
216 vlib_node_runtime_t * node,
217 vlib_frame_t * frame)
219 return nat44_classify_node_fn_inline (vm, node, frame);
222 VLIB_REGISTER_NODE (nat44_classify_node) = {
223 .function = nat44_classify_node_fn,
224 .name = "nat44-classify",
225 .vector_size = sizeof (u32),
226 .type = VLIB_NODE_TYPE_INTERNAL,
227 .n_next_nodes = NAT44_CLASSIFY_N_NEXT,
229 [NAT44_CLASSIFY_NEXT_IN2OUT] = "nat44-in2out",
230 [NAT44_CLASSIFY_NEXT_OUT2IN] = "nat44-out2in",
234 VLIB_NODE_FUNCTION_MULTIARCH (nat44_classify_node,
235 nat44_classify_node_fn);
238 nat44_det_classify_node_fn (vlib_main_t * vm,
239 vlib_node_runtime_t * node,
240 vlib_frame_t * frame)
242 return nat44_classify_node_fn_inline (vm, node, frame);
245 VLIB_REGISTER_NODE (nat44_det_classify_node) = {
246 .function = nat44_det_classify_node_fn,
247 .name = "nat44-det-classify",
248 .vector_size = sizeof (u32),
249 .type = VLIB_NODE_TYPE_INTERNAL,
250 .n_next_nodes = NAT44_CLASSIFY_N_NEXT,
252 [NAT44_CLASSIFY_NEXT_IN2OUT] = "nat44-det-in2out",
253 [NAT44_CLASSIFY_NEXT_OUT2IN] = "nat44-det-out2in",
257 VLIB_NODE_FUNCTION_MULTIARCH (nat44_det_classify_node,
258 nat44_det_classify_node_fn);
261 nat44_handoff_classify_node_fn (vlib_main_t * vm,
262 vlib_node_runtime_t * node,
263 vlib_frame_t * frame)
265 return nat44_classify_node_fn_inline (vm, node, frame);
268 VLIB_REGISTER_NODE (nat44_handoff_classify_node) = {
269 .function = nat44_handoff_classify_node_fn,
270 .name = "nat44-handoff-classify",
271 .vector_size = sizeof (u32),
272 .type = VLIB_NODE_TYPE_INTERNAL,
273 .n_next_nodes = NAT44_CLASSIFY_N_NEXT,
275 [NAT44_CLASSIFY_NEXT_IN2OUT] = "nat44-in2out-worker-handoff",
276 [NAT44_CLASSIFY_NEXT_OUT2IN] = "nat44-out2in-worker-handoff",
280 VLIB_NODE_FUNCTION_MULTIARCH (nat44_handoff_classify_node,
281 nat44_handoff_classify_node_fn);
284 * @brief Add/del NAT address to FIB.
286 * Add the external NAT address to the FIB as receive entries. This ensures
287 * that VPP will reply to ARP for this address and we don't need to enable
288 * proxy ARP on the outside interface.
290 * @param addr IPv4 address.
291 * @param plen address prefix length
292 * @param sw_if_index Interface.
293 * @param is_add If 0 delete, otherwise add.
296 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
299 fib_prefix_t prefix = {
301 .fp_proto = FIB_PROTOCOL_IP4,
303 .ip4.as_u32 = addr->as_u32,
306 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index(sw_if_index);
309 fib_table_entry_update_one_path(fib_index,
311 FIB_SOURCE_PLUGIN_HI,
312 (FIB_ENTRY_FLAG_CONNECTED |
313 FIB_ENTRY_FLAG_LOCAL |
314 FIB_ENTRY_FLAG_EXCLUSIVE),
321 FIB_ROUTE_PATH_FLAG_NONE);
323 fib_table_entry_delete(fib_index,
325 FIB_SOURCE_PLUGIN_HI);
328 void snat_add_address (snat_main_t *sm, ip4_address_t *addr, u32 vrf_id)
332 vlib_thread_main_t *tm = vlib_get_thread_main ();
337 /* Check if address already exists */
338 vec_foreach (ap, sm->addresses)
340 if (ap->addr.as_u32 == addr->as_u32)
344 vec_add2 (sm->addresses, ap, 1);
348 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
349 FIB_SOURCE_PLUGIN_HI);
352 #define _(N, i, n, s) \
353 clib_bitmap_alloc (ap->busy_##n##_port_bitmap, 65535); \
354 ap->busy_##n##_ports = 0; \
355 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
356 foreach_snat_protocol
359 /* Add external address to FIB */
360 pool_foreach (i, sm->interfaces,
362 if (nat_interface_is_inside(i))
365 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
368 pool_foreach (i, sm->output_feature_interfaces,
370 if (nat_interface_is_inside(i))
373 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
378 static int is_snat_address_used_in_static_mapping (snat_main_t *sm,
381 snat_static_mapping_t *m;
382 pool_foreach (m, sm->static_mappings,
384 if (m->external_addr.as_u32 == addr.as_u32)
391 void increment_v4_address (ip4_address_t * a)
395 v = clib_net_to_host_u32(a->as_u32) + 1;
396 a->as_u32 = clib_host_to_net_u32(v);
400 snat_add_static_mapping_when_resolved (snat_main_t * sm,
401 ip4_address_t l_addr,
406 snat_protocol_t proto,
410 snat_static_map_resolve_t *rp;
412 vec_add2 (sm->to_resolve, rp, 1);
413 rp->l_addr.as_u32 = l_addr.as_u32;
415 rp->sw_if_index = sw_if_index;
419 rp->addr_only = addr_only;
424 * @brief Add static mapping.
426 * Create static mapping between local addr+port and external addr+port.
428 * @param l_addr Local IPv4 address.
429 * @param e_addr External IPv4 address.
430 * @param l_port Local port number.
431 * @param e_port External port number.
432 * @param vrf_id VRF ID.
433 * @param addr_only If 0 address port and pair mapping, otherwise address only.
434 * @param sw_if_index External port instead of specific IP address.
435 * @param is_add If 0 delete static mapping, otherwise add.
439 int snat_add_static_mapping(ip4_address_t l_addr, ip4_address_t e_addr,
440 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
441 u32 sw_if_index, snat_protocol_t proto, int is_add)
443 snat_main_t * sm = &snat_main;
444 snat_static_mapping_t *m;
445 snat_session_key_t m_key;
446 clib_bihash_kv_8_8_t kv, value;
447 snat_address_t *a = 0;
450 snat_interface_t *interface;
453 /* If the external address is a specific interface address */
454 if (sw_if_index != ~0)
456 ip4_address_t * first_int_addr;
458 /* Might be already set... */
459 first_int_addr = ip4_interface_first_address
460 (sm->ip4_main, sw_if_index, 0 /* just want the address*/);
462 /* DHCP resolution required? */
463 if (first_int_addr == 0)
465 snat_add_static_mapping_when_resolved
466 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
471 e_addr.as_u32 = first_int_addr->as_u32;
475 m_key.port = addr_only ? 0 : e_port;
476 m_key.protocol = addr_only ? 0 : proto;
477 m_key.fib_index = sm->outside_fib_index;
478 kv.key = m_key.as_u64;
479 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
482 m = pool_elt_at_index (sm->static_mappings, value.value);
487 return VNET_API_ERROR_VALUE_EXIST;
489 /* Convert VRF id to FIB index */
492 p = hash_get (sm->ip4_main->fib_index_by_table_id, vrf_id);
494 return VNET_API_ERROR_NO_SUCH_FIB;
497 /* If not specified use inside VRF id from SNAT plugin startup config */
500 fib_index = sm->inside_fib_index;
501 vrf_id = sm->inside_vrf_id;
504 /* Find external address in allocated addresses and reserve port for
505 address and port pair mapping when dynamic translations enabled */
506 if (!addr_only && !(sm->static_mapping_only))
508 for (i = 0; i < vec_len (sm->addresses); i++)
510 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
512 a = sm->addresses + i;
513 /* External port must be unused */
516 #define _(N, j, n, s) \
517 case SNAT_PROTOCOL_##N: \
518 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
519 return VNET_API_ERROR_INVALID_VALUE; \
520 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
523 a->busy_##n##_ports++; \
524 a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]++; \
527 foreach_snat_protocol
530 clib_warning("unknown_protocol");
531 return VNET_API_ERROR_INVALID_VALUE_2;
536 /* External address must be allocated */
538 return VNET_API_ERROR_NO_SUCH_ENTRY;
541 pool_get (sm->static_mappings, m);
542 memset (m, 0, sizeof (*m));
543 m->local_addr = l_addr;
544 m->external_addr = e_addr;
545 m->addr_only = addr_only;
547 m->fib_index = fib_index;
550 m->local_port = l_port;
551 m->external_port = e_port;
555 m_key.addr = m->local_addr;
556 m_key.port = m->local_port;
557 m_key.protocol = m->proto;
558 m_key.fib_index = m->fib_index;
559 kv.key = m_key.as_u64;
560 kv.value = m - sm->static_mappings;
561 clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 1);
563 m_key.addr = m->external_addr;
564 m_key.port = m->external_port;
565 m_key.fib_index = sm->outside_fib_index;
566 kv.key = m_key.as_u64;
567 kv.value = m - sm->static_mappings;
568 clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 1);
573 .src_address = m->local_addr,
575 m->worker_index = sm->worker_in2out_cb (&ip, m->fib_index);
581 return VNET_API_ERROR_NO_SUCH_ENTRY;
583 /* Free external address port */
584 if (!addr_only && !(sm->static_mapping_only))
586 for (i = 0; i < vec_len (sm->addresses); i++)
588 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
590 a = sm->addresses + i;
593 #define _(N, j, n, s) \
594 case SNAT_PROTOCOL_##N: \
595 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
598 a->busy_##n##_ports--; \
599 a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]--; \
602 foreach_snat_protocol
605 clib_warning("unknown_protocol");
606 return VNET_API_ERROR_INVALID_VALUE_2;
613 m_key.addr = m->local_addr;
614 m_key.port = m->local_port;
615 m_key.protocol = m->proto;
616 m_key.fib_index = m->fib_index;
617 kv.key = m_key.as_u64;
618 clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0);
620 m_key.addr = m->external_addr;
621 m_key.port = m->external_port;
622 m_key.fib_index = sm->outside_fib_index;
623 kv.key = m_key.as_u64;
624 clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 0);
626 /* Delete session(s) for static mapping if exist */
627 if (!(sm->static_mapping_only) ||
628 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
630 snat_user_key_t u_key;
632 dlist_elt_t * head, * elt;
633 u32 elt_index, head_index, del_elt_index;
637 snat_main_per_thread_data_t *tsm;
639 u_key.addr = m->local_addr;
640 u_key.fib_index = m->fib_index;
641 kv.key = u_key.as_u64;
642 if (sm->num_workers > 1)
643 tsm = vec_elt_at_index (sm->per_thread_data, m->worker_index);
645 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
646 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
648 user_index = value.value;
649 u = pool_elt_at_index (tsm->users, user_index);
650 if (u->nstaticsessions)
652 head_index = u->sessions_per_user_list_head_index;
653 head = pool_elt_at_index (tsm->list_pool, head_index);
654 elt_index = head->next;
655 elt = pool_elt_at_index (tsm->list_pool, elt_index);
656 ses_index = elt->value;
657 while (ses_index != ~0)
659 s = pool_elt_at_index (tsm->sessions, ses_index);
660 del_elt_index = elt_index;
661 elt_index = elt->next;
662 elt = pool_elt_at_index (tsm->list_pool, elt_index);
663 ses_index = elt->value;
667 if ((s->out2in.addr.as_u32 != e_addr.as_u32) &&
668 (clib_net_to_host_u16 (s->out2in.port) != e_port))
672 if (snat_is_unk_proto_session (s))
674 clib_bihash_kv_16_8_t up_kv;
675 nat_ed_ses_key_t up_key;
676 up_key.l_addr = s->in2out.addr;
677 up_key.r_addr = s->ext_host_addr;
678 up_key.fib_index = s->in2out.fib_index;
679 up_key.proto = s->in2out.port;
682 up_kv.key[0] = up_key.as_u64[0];
683 up_kv.key[1] = up_key.as_u64[1];
684 if (clib_bihash_add_del_16_8 (&sm->in2out_ed,
686 clib_warning ("in2out key del failed");
688 up_key.l_addr = s->out2in.addr;
689 up_key.fib_index = s->out2in.fib_index;
690 up_kv.key[0] = up_key.as_u64[0];
691 up_kv.key[1] = up_key.as_u64[1];
692 if (clib_bihash_add_del_16_8 (&sm->out2in_ed,
694 clib_warning ("out2in key del failed");
699 snat_ipfix_logging_nat44_ses_delete(s->in2out.addr.as_u32,
700 s->out2in.addr.as_u32,
704 s->in2out.fib_index);
706 value.key = s->in2out.as_u64;
707 if (clib_bihash_add_del_8_8 (&tsm->in2out, &value, 0))
708 clib_warning ("in2out key del failed");
709 value.key = s->out2in.as_u64;
710 if (clib_bihash_add_del_8_8 (&tsm->out2in, &value, 0))
711 clib_warning ("out2in key del failed");
713 pool_put (tsm->sessions, s);
715 clib_dlist_remove (tsm->list_pool, del_elt_index);
716 pool_put_index (tsm->list_pool, del_elt_index);
717 u->nstaticsessions--;
724 pool_put (tsm->users, u);
725 clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 0);
731 /* Delete static mapping from pool */
732 pool_put (sm->static_mappings, m);
738 /* Add/delete external address to FIB */
739 pool_foreach (interface, sm->interfaces,
741 if (nat_interface_is_inside(interface))
744 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
747 pool_foreach (interface, sm->output_feature_interfaces,
749 if (nat_interface_is_inside(interface))
752 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
759 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
760 snat_protocol_t proto, u32 vrf_id,
761 nat44_lb_addr_port_t *locals, u8 is_add)
763 snat_main_t * sm = &snat_main;
764 snat_static_mapping_t *m;
765 snat_session_key_t m_key;
766 clib_bihash_kv_8_8_t kv, value;
768 snat_address_t *a = 0;
770 nat44_lb_addr_port_t *local;
771 u32 worker_index = 0;
772 snat_main_per_thread_data_t *tsm;
776 m_key.protocol = proto;
777 m_key.fib_index = sm->outside_fib_index;
778 kv.key = m_key.as_u64;
779 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
782 m = pool_elt_at_index (sm->static_mappings, value.value);
787 return VNET_API_ERROR_VALUE_EXIST;
789 if (vec_len (locals) < 2)
790 return VNET_API_ERROR_INVALID_VALUE;
792 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
794 FIB_SOURCE_PLUGIN_HI);
796 /* Find external address in allocated addresses and reserve port for
797 address and port pair mapping when dynamic translations enabled */
798 if (!sm->static_mapping_only)
800 for (i = 0; i < vec_len (sm->addresses); i++)
802 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
804 a = sm->addresses + i;
805 /* External port must be unused */
808 #define _(N, j, n, s) \
809 case SNAT_PROTOCOL_##N: \
810 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
811 return VNET_API_ERROR_INVALID_VALUE; \
812 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
815 a->busy_##n##_ports++; \
816 a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]++; \
819 foreach_snat_protocol
822 clib_warning("unknown_protocol");
823 return VNET_API_ERROR_INVALID_VALUE_2;
828 /* External address must be allocated */
830 return VNET_API_ERROR_NO_SUCH_ENTRY;
833 pool_get (sm->static_mappings, m);
834 memset (m, 0, sizeof (*m));
835 m->external_addr = e_addr;
838 m->fib_index = fib_index;
839 m->external_port = e_port;
842 m_key.addr = m->external_addr;
843 m_key.port = m->external_port;
844 m_key.protocol = m->proto;
845 m_key.fib_index = sm->outside_fib_index;
846 kv.key = m_key.as_u64;
847 kv.value = m - sm->static_mappings;
848 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 1))
850 clib_warning ("static_mapping_by_external key add failed");
851 return VNET_API_ERROR_UNSPECIFIED;
857 worker_index = sm->first_worker_index +
858 sm->workers[sm->next_worker++ % vec_len (sm->workers)];
859 tsm = vec_elt_at_index (sm->per_thread_data, worker_index);
860 m->worker_index = worker_index;
863 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
865 m_key.port = clib_host_to_net_u16 (m->external_port);
866 kv.key = m_key.as_u64;
868 if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 1))
870 clib_warning ("static_mapping_by_local key add failed");
871 return VNET_API_ERROR_UNSPECIFIED;
874 m_key.fib_index = m->fib_index;
875 for (i = 0; i < vec_len (locals); i++)
877 m_key.addr = locals[i].addr;
878 m_key.port = locals[i].port;
879 kv.key = m_key.as_u64;
880 kv.value = m - sm->static_mappings;
881 clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 1);
882 locals[i].prefix = (i == 0) ? locals[i].probability :\
883 (locals[i - 1].prefix + locals[i].probability);
884 vec_add1 (m->locals, locals[i]);
886 m_key.port = clib_host_to_net_u16 (locals[i].port);
887 kv.key = m_key.as_u64;
889 if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 1))
891 clib_warning ("in2out key add failed");
892 return VNET_API_ERROR_UNSPECIFIED;
899 return VNET_API_ERROR_NO_SUCH_ENTRY;
901 fib_table_unlock (m->fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_PLUGIN_HI);
903 /* Free external address port */
904 if (!sm->static_mapping_only)
906 for (i = 0; i < vec_len (sm->addresses); i++)
908 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
910 a = sm->addresses + i;
913 #define _(N, j, n, s) \
914 case SNAT_PROTOCOL_##N: \
915 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
918 a->busy_##n##_ports--; \
919 a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]--; \
922 foreach_snat_protocol
925 clib_warning("unknown_protocol");
926 return VNET_API_ERROR_INVALID_VALUE_2;
933 tsm = vec_elt_at_index (sm->per_thread_data, m->worker_index);
934 m_key.addr = m->external_addr;
935 m_key.port = m->external_port;
936 m_key.protocol = m->proto;
937 m_key.fib_index = sm->outside_fib_index;
938 kv.key = m_key.as_u64;
939 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 0))
941 clib_warning ("static_mapping_by_external key del failed");
942 return VNET_API_ERROR_UNSPECIFIED;
945 m_key.port = clib_host_to_net_u16 (m->external_port);
946 kv.key = m_key.as_u64;
947 if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 0))
949 clib_warning ("outi2in key del failed");
950 return VNET_API_ERROR_UNSPECIFIED;
953 vec_foreach (local, m->locals)
955 m_key.addr = local->addr;
956 m_key.port = local->port;
957 m_key.fib_index = m->fib_index;
958 kv.key = m_key.as_u64;
959 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
961 clib_warning ("static_mapping_by_local key del failed");
962 return VNET_API_ERROR_UNSPECIFIED;
965 m_key.port = clib_host_to_net_u16 (local->port);
966 kv.key = m_key.as_u64;
967 if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 0))
969 clib_warning ("in2out key del failed");
970 return VNET_API_ERROR_UNSPECIFIED;
975 pool_put (sm->static_mappings, m);
981 int snat_del_address (snat_main_t *sm, ip4_address_t addr, u8 delete_sm)
983 snat_address_t *a = 0;
985 u32 *ses_to_be_removed = 0, *ses_index;
986 clib_bihash_kv_8_8_t kv, value;
987 snat_user_key_t user_key;
989 snat_main_per_thread_data_t *tsm;
990 snat_static_mapping_t *m;
991 snat_interface_t *interface;
994 /* Find SNAT address */
995 for (i=0; i < vec_len (sm->addresses); i++)
997 if (sm->addresses[i].addr.as_u32 == addr.as_u32)
999 a = sm->addresses + i;
1004 return VNET_API_ERROR_NO_SUCH_ENTRY;
1008 pool_foreach (m, sm->static_mappings,
1010 if (m->external_addr.as_u32 == addr.as_u32)
1011 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1012 m->local_port, m->external_port,
1013 m->vrf_id, m->addr_only, ~0,
1019 /* Check if address is used in some static mapping */
1020 if (is_snat_address_used_in_static_mapping(sm, addr))
1022 clib_warning ("address used in static mapping");
1023 return VNET_API_ERROR_UNSPECIFIED;
1027 if (a->fib_index != ~0)
1028 fib_table_unlock(a->fib_index, FIB_PROTOCOL_IP4,
1029 FIB_SOURCE_PLUGIN_HI);
1031 /* Delete sessions using address */
1032 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1034 vec_foreach (tsm, sm->per_thread_data)
1036 pool_foreach (ses, tsm->sessions, ({
1037 if (ses->out2in.addr.as_u32 == addr.as_u32)
1039 if (snat_is_unk_proto_session (ses))
1041 clib_bihash_kv_16_8_t up_kv;
1042 nat_ed_ses_key_t up_key;
1043 up_key.l_addr = ses->in2out.addr;
1044 up_key.r_addr = ses->ext_host_addr;
1045 up_key.fib_index = ses->in2out.fib_index;
1046 up_key.proto = ses->in2out.port;
1049 up_kv.key[0] = up_key.as_u64[0];
1050 up_kv.key[1] = up_key.as_u64[1];
1051 if (clib_bihash_add_del_16_8 (&sm->in2out_ed,
1053 clib_warning ("in2out key del failed");
1055 up_key.l_addr = ses->out2in.addr;
1056 up_key.fib_index = ses->out2in.fib_index;
1057 up_kv.key[0] = up_key.as_u64[0];
1058 up_kv.key[1] = up_key.as_u64[1];
1059 if (clib_bihash_add_del_16_8 (&sm->out2in_ed,
1061 clib_warning ("out2in key del failed");
1066 snat_ipfix_logging_nat44_ses_delete(ses->in2out.addr.as_u32,
1067 ses->out2in.addr.as_u32,
1068 ses->in2out.protocol,
1071 ses->in2out.fib_index);
1072 kv.key = ses->in2out.as_u64;
1073 clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0);
1074 kv.key = ses->out2in.as_u64;
1075 clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0);
1077 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1078 clib_dlist_remove (tsm->list_pool, ses->per_user_index);
1079 user_key.addr = ses->in2out.addr;
1080 user_key.fib_index = ses->in2out.fib_index;
1081 kv.key = user_key.as_u64;
1082 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1084 u = pool_elt_at_index (tsm->users, value.value);
1090 vec_foreach (ses_index, ses_to_be_removed)
1091 pool_put_index (tsm->sessions, ses_index[0]);
1093 vec_free (ses_to_be_removed);
1097 vec_del1 (sm->addresses, i);
1099 /* Delete external address from FIB */
1100 pool_foreach (interface, sm->interfaces,
1102 if (nat_interface_is_inside(interface))
1105 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1108 pool_foreach (interface, sm->output_feature_interfaces,
1110 if (nat_interface_is_inside(interface))
1113 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1120 int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1122 snat_main_t *sm = &snat_main;
1123 snat_interface_t *i;
1124 const char * feature_name, *del_feature_name;
1125 snat_address_t * ap;
1126 snat_static_mapping_t * m;
1127 snat_det_map_t * dm;
1129 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1130 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1133 if (sm->num_workers > 1 && !sm->deterministic)
1134 feature_name = is_inside ? "nat44-in2out-worker-handoff" : "nat44-out2in-worker-handoff";
1135 else if (sm->deterministic)
1136 feature_name = is_inside ? "nat44-det-in2out" : "nat44-det-out2in";
1138 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1141 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1142 sm->fq_in2out_index = vlib_frame_queue_main_init (sm->in2out_node_index, 0);
1144 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1145 sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index, 0);
1147 pool_foreach (i, sm->interfaces,
1149 if (i->sw_if_index == sw_if_index)
1153 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1156 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1158 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1160 if (sm->num_workers > 1 && !sm->deterministic)
1161 del_feature_name = "nat44-handoff-classify";
1162 else if (sm->deterministic)
1163 del_feature_name = "nat44-det-classify";
1165 del_feature_name = "nat44-classify";
1167 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1168 sw_if_index, 0, 0, 0);
1169 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1170 sw_if_index, 1, 0, 0);
1174 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1175 sw_if_index, 0, 0, 0);
1176 pool_put (sm->interfaces, i);
1181 if ((nat_interface_is_inside(i) && is_inside) ||
1182 (nat_interface_is_outside(i) && !is_inside))
1185 if (sm->num_workers > 1 && !sm->deterministic)
1187 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1188 "nat44-out2in-worker-handoff";
1189 feature_name = "nat44-handoff-classify";
1191 else if (sm->deterministic)
1193 del_feature_name = !is_inside ? "nat44-det-in2out" :
1195 feature_name = "nat44-det-classify";
1199 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1200 feature_name = "nat44-classify";
1203 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1204 sw_if_index, 0, 0, 0);
1205 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1206 sw_if_index, 1, 0, 0);
1215 return VNET_API_ERROR_NO_SUCH_ENTRY;
1217 pool_get (sm->interfaces, i);
1218 i->sw_if_index = sw_if_index;
1220 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0, 0);
1224 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1226 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1228 /* Add/delete external addresses to FIB */
1232 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1233 sw_if_index, !is_del, 0, 0);
1237 vec_foreach (ap, sm->addresses)
1238 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1240 pool_foreach (m, sm->static_mappings,
1242 if (!(m->addr_only))
1245 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1248 pool_foreach (dm, sm->det_maps,
1250 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
1256 int snat_interface_add_del_output_feature (u32 sw_if_index,
1260 snat_main_t *sm = &snat_main;
1261 snat_interface_t *i;
1262 snat_address_t * ap;
1263 snat_static_mapping_t * m;
1265 if (sm->deterministic ||
1266 (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
1267 return VNET_API_ERROR_UNSUPPORTED;
1271 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
1272 sw_if_index, !is_del, 0, 0);
1273 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
1274 sw_if_index, !is_del, 0, 0);
1278 if (sm->num_workers > 1)
1280 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in-worker-handoff",
1281 sw_if_index, !is_del, 0, 0);
1282 vnet_feature_enable_disable ("ip4-output",
1283 "nat44-in2out-output-worker-handoff",
1284 sw_if_index, !is_del, 0, 0);
1288 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in", sw_if_index,
1290 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
1291 sw_if_index, !is_del, 0, 0);
1295 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
1296 sm->fq_in2out_output_index =
1297 vlib_frame_queue_main_init (sm->in2out_output_node_index, 0);
1299 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
1300 sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index, 0);
1302 pool_foreach (i, sm->output_feature_interfaces,
1304 if (i->sw_if_index == sw_if_index)
1307 pool_put (sm->output_feature_interfaces, i);
1309 return VNET_API_ERROR_VALUE_EXIST;
1316 return VNET_API_ERROR_NO_SUCH_ENTRY;
1318 pool_get (sm->output_feature_interfaces, i);
1319 i->sw_if_index = sw_if_index;
1322 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1324 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1326 /* Add/delete external addresses to FIB */
1331 vec_foreach (ap, sm->addresses)
1332 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1334 pool_foreach (m, sm->static_mappings,
1336 if (!(m->addr_only))
1339 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1345 int snat_set_workers (uword * bitmap)
1347 snat_main_t *sm = &snat_main;
1350 if (sm->num_workers < 2)
1351 return VNET_API_ERROR_FEATURE_DISABLED;
1353 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
1354 return VNET_API_ERROR_INVALID_WORKER;
1356 vec_free (sm->workers);
1357 clib_bitmap_foreach (i, bitmap,
1359 vec_add1(sm->workers, i);
1360 sm->per_thread_data[i].snat_thread_index = j;
1364 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
1365 sm->num_snat_thread = _vec_len (sm->workers);
1372 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
1375 ip4_address_t * address,
1377 u32 if_address_index,
1380 static clib_error_t * snat_init (vlib_main_t * vm)
1382 snat_main_t * sm = &snat_main;
1383 clib_error_t * error = 0;
1384 ip4_main_t * im = &ip4_main;
1385 ip_lookup_main_t * lm = &im->lookup_main;
1387 vlib_thread_registration_t *tr;
1388 vlib_thread_main_t *tm = vlib_get_thread_main ();
1391 ip4_add_del_interface_address_callback_t cb4;
1394 sm->vnet_main = vnet_get_main();
1396 sm->ip4_lookup_main = lm;
1397 sm->api_main = &api_main;
1398 sm->first_worker_index = 0;
1399 sm->next_worker = 0;
1400 sm->num_workers = 0;
1401 sm->num_snat_thread = 1;
1403 sm->port_per_thread = 0xffff - 1024;
1404 sm->fq_in2out_index = ~0;
1405 sm->fq_out2in_index = ~0;
1406 sm->udp_timeout = SNAT_UDP_TIMEOUT;
1407 sm->tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
1408 sm->tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
1409 sm->icmp_timeout = SNAT_ICMP_TIMEOUT;
1411 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1414 tr = (vlib_thread_registration_t *) p[0];
1417 sm->num_workers = tr->count;
1418 sm->first_worker_index = tr->first_index;
1422 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
1424 /* Use all available workers by default */
1425 if (sm->num_workers > 1)
1427 for (i=0; i < sm->num_workers; i++)
1428 bitmap = clib_bitmap_set (bitmap, i, 1);
1429 snat_set_workers(bitmap);
1430 clib_bitmap_free (bitmap);
1434 sm->per_thread_data[0].snat_thread_index = 0;
1437 error = snat_api_init(vm, sm);
1441 /* Set up the interface address add/del callback */
1442 cb4.function = snat_ip4_add_del_interface_address_cb;
1443 cb4.function_opaque = 0;
1445 vec_add1 (im->add_del_interface_address_callbacks, cb4);
1447 /* Init IPFIX logging */
1448 snat_ipfix_logging_init(vm);
1450 error = nat64_init(vm);
1457 VLIB_INIT_FUNCTION (snat_init);
1459 void snat_free_outside_address_and_port (snat_address_t * addresses,
1461 snat_session_key_t * k,
1465 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
1467 ASSERT (address_index < vec_len (addresses));
1469 a = addresses + address_index;
1471 switch (k->protocol)
1473 #define _(N, i, n, s) \
1474 case SNAT_PROTOCOL_##N: \
1475 ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
1476 port_host_byte_order) == 1); \
1477 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
1478 port_host_byte_order, 0); \
1479 a->busy_##n##_ports--; \
1480 a->busy_##n##_ports_per_thread[thread_index]--; \
1482 foreach_snat_protocol
1485 clib_warning("unknown_protocol");
1491 * @brief Match NAT44 static mapping.
1493 * @param sm NAT main.
1494 * @param match Address and port to match.
1495 * @param mapping External or local address and port of the matched mapping.
1496 * @param by_external If 0 match by local address otherwise match by external
1498 * @param is_addr_only If matched mapping is address only
1500 * @returns 0 if match found otherwise 1.
1502 int snat_static_mapping_match (snat_main_t * sm,
1503 snat_session_key_t match,
1504 snat_session_key_t * mapping,
1508 clib_bihash_kv_8_8_t kv, value;
1509 snat_static_mapping_t *m;
1510 snat_session_key_t m_key;
1511 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
1512 u32 rand, lo = 0, hi, mid;
1515 mapping_hash = &sm->static_mapping_by_external;
1517 m_key.addr = match.addr;
1518 m_key.port = clib_net_to_host_u16 (match.port);
1519 m_key.protocol = match.protocol;
1520 m_key.fib_index = match.fib_index;
1522 kv.key = m_key.as_u64;
1524 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
1526 /* Try address only mapping */
1529 kv.key = m_key.as_u64;
1530 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
1534 m = pool_elt_at_index (sm->static_mappings, value.value);
1538 if (vec_len (m->locals))
1540 hi = vec_len (m->locals) - 1;
1541 rand = 1 + (random_u32 (&sm->random_seed) % m->locals[hi].prefix);
1544 mid = ((hi - lo) >> 1) + lo;
1545 (rand > m->locals[mid].prefix) ? (lo = mid + 1) : (hi = mid);
1547 if (!(m->locals[lo].prefix >= rand))
1549 mapping->addr = m->locals[lo].addr;
1550 mapping->port = clib_host_to_net_u16 (m->locals[lo].port);
1554 mapping->addr = m->local_addr;
1555 /* Address only mapping doesn't change port */
1556 mapping->port = m->addr_only ? match.port
1557 : clib_host_to_net_u16 (m->local_port);
1559 mapping->fib_index = m->fib_index;
1560 mapping->protocol = m->proto;
1564 mapping->addr = m->external_addr;
1565 /* Address only mapping doesn't change port */
1566 mapping->port = m->addr_only ? match.port
1567 : clib_host_to_net_u16 (m->external_port);
1568 mapping->fib_index = sm->outside_fib_index;
1571 if (PREDICT_FALSE(is_addr_only != 0))
1572 *is_addr_only = m->addr_only;
1577 static_always_inline u16
1578 snat_random_port (u16 min, u16 max)
1580 snat_main_t *sm = &snat_main;
1581 return min + random_u32 (&sm->random_seed) /
1582 (random_u32_max() / (max - min + 1) + 1);
1585 int snat_alloc_outside_address_and_port (snat_address_t * addresses,
1588 snat_session_key_t * k,
1589 u32 * address_indexp,
1591 u16 port_per_thread,
1592 u32 snat_thread_index)
1598 for (i = 0; i < vec_len (addresses); i++)
1601 if (vrf_mode && a->fib_index != ~0 && a->fib_index != fib_index)
1603 switch (k->protocol)
1605 #define _(N, j, n, s) \
1606 case SNAT_PROTOCOL_##N: \
1607 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
1611 portnum = (port_per_thread * \
1612 snat_thread_index) + \
1613 snat_random_port(1, port_per_thread) + 1024; \
1614 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
1616 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
1617 a->busy_##n##_ports_per_thread[thread_index]++; \
1618 a->busy_##n##_ports++; \
1619 k->addr = a->addr; \
1620 k->port = clib_host_to_net_u16(portnum); \
1621 *address_indexp = i; \
1626 foreach_snat_protocol
1629 clib_warning("unknown protocol");
1634 /* Totally out of translations to use... */
1635 snat_ipfix_logging_addresses_exhausted(0);
1640 static clib_error_t *
1641 add_address_command_fn (vlib_main_t * vm,
1642 unformat_input_t * input,
1643 vlib_cli_command_t * cmd)
1645 unformat_input_t _line_input, *line_input = &_line_input;
1646 snat_main_t * sm = &snat_main;
1647 ip4_address_t start_addr, end_addr, this_addr;
1648 u32 start_host_order, end_host_order;
1653 clib_error_t *error = 0;
1655 /* Get a line of input. */
1656 if (!unformat_user (input, unformat_line_input, line_input))
1659 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1661 if (unformat (line_input, "%U - %U",
1662 unformat_ip4_address, &start_addr,
1663 unformat_ip4_address, &end_addr))
1665 else if (unformat (line_input, "tenant-vrf %u", &vrf_id))
1667 else if (unformat (line_input, "%U", unformat_ip4_address, &start_addr))
1668 end_addr = start_addr;
1669 else if (unformat (line_input, "del"))
1673 error = clib_error_return (0, "unknown input '%U'",
1674 format_unformat_error, line_input);
1679 if (sm->static_mapping_only)
1681 error = clib_error_return (0, "static mapping only mode");
1685 start_host_order = clib_host_to_net_u32 (start_addr.as_u32);
1686 end_host_order = clib_host_to_net_u32 (end_addr.as_u32);
1688 if (end_host_order < start_host_order)
1690 error = clib_error_return (0, "end address less than start address");
1694 count = (end_host_order - start_host_order) + 1;
1697 clib_warning ("%U - %U, %d addresses...",
1698 format_ip4_address, &start_addr,
1699 format_ip4_address, &end_addr,
1702 this_addr = start_addr;
1704 for (i = 0; i < count; i++)
1707 snat_add_address (sm, &this_addr, vrf_id);
1709 rv = snat_del_address (sm, this_addr, 0);
1713 case VNET_API_ERROR_NO_SUCH_ENTRY:
1714 error = clib_error_return (0, "S-NAT address not exist.");
1716 case VNET_API_ERROR_UNSPECIFIED:
1717 error = clib_error_return (0, "S-NAT address used in static mapping.");
1723 increment_v4_address (&this_addr);
1727 unformat_free (line_input);
1732 VLIB_CLI_COMMAND (add_address_command, static) = {
1733 .path = "nat44 add address",
1734 .short_help = "nat44 add address <ip4-range-start> [- <ip4-range-end>] "
1735 "[tenant-vrf <vrf-id>] [del]",
1736 .function = add_address_command_fn,
1739 static clib_error_t *
1740 snat_feature_command_fn (vlib_main_t * vm,
1741 unformat_input_t * input,
1742 vlib_cli_command_t * cmd)
1744 unformat_input_t _line_input, *line_input = &_line_input;
1745 vnet_main_t * vnm = vnet_get_main();
1746 clib_error_t * error = 0;
1748 u32 * inside_sw_if_indices = 0;
1749 u32 * outside_sw_if_indices = 0;
1750 u8 is_output_feature = 0;
1756 /* Get a line of input. */
1757 if (!unformat_user (input, unformat_line_input, line_input))
1760 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1762 if (unformat (line_input, "in %U", unformat_vnet_sw_interface,
1764 vec_add1 (inside_sw_if_indices, sw_if_index);
1765 else if (unformat (line_input, "out %U", unformat_vnet_sw_interface,
1767 vec_add1 (outside_sw_if_indices, sw_if_index);
1768 else if (unformat (line_input, "output-feature"))
1769 is_output_feature = 1;
1770 else if (unformat (line_input, "del"))
1774 error = clib_error_return (0, "unknown input '%U'",
1775 format_unformat_error, line_input);
1780 if (vec_len (inside_sw_if_indices))
1782 for (i = 0; i < vec_len(inside_sw_if_indices); i++)
1784 sw_if_index = inside_sw_if_indices[i];
1785 if (is_output_feature)
1787 if (snat_interface_add_del_output_feature (sw_if_index, 1, is_del))
1789 error = clib_error_return (0, "%s %U failed",
1790 is_del ? "del" : "add",
1791 format_vnet_sw_interface_name, vnm,
1792 vnet_get_sw_interface (vnm,
1799 if (snat_interface_add_del (sw_if_index, 1, is_del))
1801 error = clib_error_return (0, "%s %U failed",
1802 is_del ? "del" : "add",
1803 format_vnet_sw_interface_name, vnm,
1804 vnet_get_sw_interface (vnm,
1812 if (vec_len (outside_sw_if_indices))
1814 for (i = 0; i < vec_len(outside_sw_if_indices); i++)
1816 sw_if_index = outside_sw_if_indices[i];
1817 if (is_output_feature)
1819 if (snat_interface_add_del_output_feature (sw_if_index, 0, is_del))
1821 error = clib_error_return (0, "%s %U failed",
1822 is_del ? "del" : "add",
1823 format_vnet_sw_interface_name, vnm,
1824 vnet_get_sw_interface (vnm,
1831 if (snat_interface_add_del (sw_if_index, 0, is_del))
1833 error = clib_error_return (0, "%s %U failed",
1834 is_del ? "del" : "add",
1835 format_vnet_sw_interface_name, vnm,
1836 vnet_get_sw_interface (vnm,
1845 unformat_free (line_input);
1846 vec_free (inside_sw_if_indices);
1847 vec_free (outside_sw_if_indices);
1852 VLIB_CLI_COMMAND (set_interface_snat_command, static) = {
1853 .path = "set interface nat44",
1854 .function = snat_feature_command_fn,
1855 .short_help = "set interface nat44 in <intfc> out <intfc> [output-feature] "
1860 unformat_snat_protocol (unformat_input_t * input, va_list * args)
1862 u32 *r = va_arg (*args, u32 *);
1865 #define _(N, i, n, s) else if (unformat (input, s)) *r = SNAT_PROTOCOL_##N;
1866 foreach_snat_protocol
1874 format_snat_protocol (u8 * s, va_list * args)
1876 u32 i = va_arg (*args, u32);
1881 #define _(N, j, n, str) case SNAT_PROTOCOL_##N: t = (u8 *) str; break;
1882 foreach_snat_protocol
1885 s = format (s, "unknown");
1888 s = format (s, "%s", t);
1892 static clib_error_t *
1893 add_static_mapping_command_fn (vlib_main_t * vm,
1894 unformat_input_t * input,
1895 vlib_cli_command_t * cmd)
1897 unformat_input_t _line_input, *line_input = &_line_input;
1898 clib_error_t * error = 0;
1899 ip4_address_t l_addr, e_addr;
1900 u32 l_port = 0, e_port = 0, vrf_id = ~0;
1903 u32 sw_if_index = ~0;
1904 vnet_main_t * vnm = vnet_get_main();
1906 snat_protocol_t proto;
1909 /* Get a line of input. */
1910 if (!unformat_user (input, unformat_line_input, line_input))
1913 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1915 if (unformat (line_input, "local %U %u", unformat_ip4_address, &l_addr,
1918 else if (unformat (line_input, "local %U", unformat_ip4_address, &l_addr))
1920 else if (unformat (line_input, "external %U %u", unformat_ip4_address,
1923 else if (unformat (line_input, "external %U", unformat_ip4_address,
1926 else if (unformat (line_input, "external %U %u",
1927 unformat_vnet_sw_interface, vnm, &sw_if_index,
1931 else if (unformat (line_input, "external %U",
1932 unformat_vnet_sw_interface, vnm, &sw_if_index))
1934 else if (unformat (line_input, "vrf %u", &vrf_id))
1936 else if (unformat (line_input, "%U", unformat_snat_protocol, &proto))
1938 else if (unformat (line_input, "del"))
1942 error = clib_error_return (0, "unknown input: '%U'",
1943 format_unformat_error, line_input);
1948 if (!addr_only && !proto_set)
1950 error = clib_error_return (0, "missing protocol");
1954 rv = snat_add_static_mapping(l_addr, e_addr, (u16) l_port, (u16) e_port,
1955 vrf_id, addr_only, sw_if_index, proto, is_add);
1959 case VNET_API_ERROR_INVALID_VALUE:
1960 error = clib_error_return (0, "External port already in use.");
1962 case VNET_API_ERROR_NO_SUCH_ENTRY:
1964 error = clib_error_return (0, "External addres must be allocated.");
1966 error = clib_error_return (0, "Mapping not exist.");
1968 case VNET_API_ERROR_NO_SUCH_FIB:
1969 error = clib_error_return (0, "No such VRF id.");
1971 case VNET_API_ERROR_VALUE_EXIST:
1972 error = clib_error_return (0, "Mapping already exist.");
1979 unformat_free (line_input);
1986 * @cliexstart{snat add static mapping}
1987 * Static mapping allows hosts on the external network to initiate connection
1988 * to to the local network host.
1989 * To create static mapping between local host address 10.0.0.3 port 6303 and
1990 * external address 4.4.4.4 port 3606 for TCP protocol use:
1991 * vpp# nat44 add static mapping tcp local 10.0.0.3 6303 external 4.4.4.4 3606
1992 * If not runnig "static mapping only" NAT plugin mode use before:
1993 * vpp# nat44 add address 4.4.4.4
1994 * To create static mapping between local and external address use:
1995 * vpp# nat44 add static mapping local 10.0.0.3 external 4.4.4.4
1998 VLIB_CLI_COMMAND (add_static_mapping_command, static) = {
1999 .path = "nat44 add static mapping",
2000 .function = add_static_mapping_command_fn,
2002 "nat44 add static mapping tcp|udp|icmp local <addr> [<port>] external <addr> [<port>] [vrf <table-id>] [del]",
2005 static clib_error_t *
2006 add_lb_static_mapping_command_fn (vlib_main_t * vm,
2007 unformat_input_t * input,
2008 vlib_cli_command_t * cmd)
2010 unformat_input_t _line_input, *line_input = &_line_input;
2011 clib_error_t * error = 0;
2012 ip4_address_t l_addr, e_addr;
2013 u32 l_port = 0, e_port = 0, vrf_id = 0, probability = 0;
2016 snat_protocol_t proto;
2018 nat44_lb_addr_port_t *locals = 0, local;
2020 /* Get a line of input. */
2021 if (!unformat_user (input, unformat_line_input, line_input))
2024 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2026 if (unformat (line_input, "local %U:%u probability %u",
2027 unformat_ip4_address, &l_addr, &l_port, &probability))
2029 memset (&local, 0, sizeof (local));
2030 local.addr = l_addr;
2031 local.port = (u16) l_port;
2032 local.probability = (u8) probability;
2033 vec_add1 (locals, local);
2035 else if (unformat (line_input, "external %U:%u", unformat_ip4_address,
2038 else if (unformat (line_input, "vrf %u", &vrf_id))
2040 else if (unformat (line_input, "protocol %U", unformat_snat_protocol,
2043 else if (unformat (line_input, "del"))
2047 error = clib_error_return (0, "unknown input: '%U'",
2048 format_unformat_error, line_input);
2053 if (vec_len (locals) < 2)
2055 error = clib_error_return (0, "at least two local must be set");
2061 error = clib_error_return (0, "missing protocol");
2065 rv = nat44_add_del_lb_static_mapping (e_addr, (u16) e_port, proto, vrf_id,
2070 case VNET_API_ERROR_INVALID_VALUE:
2071 error = clib_error_return (0, "External port already in use.");
2073 case VNET_API_ERROR_NO_SUCH_ENTRY:
2075 error = clib_error_return (0, "External addres must be allocated.");
2077 error = clib_error_return (0, "Mapping not exist.");
2079 case VNET_API_ERROR_VALUE_EXIST:
2080 error = clib_error_return (0, "Mapping already exist.");
2087 unformat_free (line_input);
2093 VLIB_CLI_COMMAND (add_lb_static_mapping_command, static) = {
2094 .path = "nat44 add load-balancing static mapping",
2095 .function = add_lb_static_mapping_command_fn,
2097 "nat44 add load-balancing static mapping protocol tcp|udp external <addr>:<port> local <addr>:<port> probability <n> [vrf <table-id>] [del]",
2100 static clib_error_t *
2101 set_workers_command_fn (vlib_main_t * vm,
2102 unformat_input_t * input,
2103 vlib_cli_command_t * cmd)
2105 unformat_input_t _line_input, *line_input = &_line_input;
2108 clib_error_t *error = 0;
2110 /* Get a line of input. */
2111 if (!unformat_user (input, unformat_line_input, line_input))
2114 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2116 if (unformat (line_input, "%U", unformat_bitmap_list, &bitmap))
2120 error = clib_error_return (0, "unknown input '%U'",
2121 format_unformat_error, line_input);
2128 error = clib_error_return (0, "List of workers must be specified.");
2132 rv = snat_set_workers(bitmap);
2134 clib_bitmap_free (bitmap);
2138 case VNET_API_ERROR_INVALID_WORKER:
2139 error = clib_error_return (0, "Invalid worker(s).");
2141 case VNET_API_ERROR_FEATURE_DISABLED:
2142 error = clib_error_return (0,
2143 "Supported only if 2 or more workes available.");
2150 unformat_free (line_input);
2157 * @cliexstart{set snat workers}
2158 * Set NAT workers if 2 or more workers available, use:
2159 * vpp# set snat workers 0-2,5
2162 VLIB_CLI_COMMAND (set_workers_command, static) = {
2163 .path = "set nat workers",
2164 .function = set_workers_command_fn,
2166 "set nat workers <workers-list>",
2169 static clib_error_t *
2170 snat_ipfix_logging_enable_disable_command_fn (vlib_main_t * vm,
2171 unformat_input_t * input,
2172 vlib_cli_command_t * cmd)
2174 unformat_input_t _line_input, *line_input = &_line_input;
2179 clib_error_t *error = 0;
2181 /* Get a line of input. */
2182 if (!unformat_user (input, unformat_line_input, line_input))
2185 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2187 if (unformat (line_input, "domain %d", &domain_id))
2189 else if (unformat (line_input, "src-port %d", &src_port))
2191 else if (unformat (line_input, "disable"))
2195 error = clib_error_return (0, "unknown input '%U'",
2196 format_unformat_error, line_input);
2201 rv = snat_ipfix_logging_enable_disable (enable, domain_id, (u16) src_port);
2205 error = clib_error_return (0, "ipfix logging enable failed");
2210 unformat_free (line_input);
2217 * @cliexstart{snat ipfix logging}
2218 * To enable NAT IPFIX logging use:
2219 * vpp# nat ipfix logging
2220 * To set IPFIX exporter use:
2221 * vpp# set ipfix exporter collector 10.10.10.3 src 10.10.10.1
2224 VLIB_CLI_COMMAND (snat_ipfix_logging_enable_disable_command, static) = {
2225 .path = "nat ipfix logging",
2226 .function = snat_ipfix_logging_enable_disable_command_fn,
2227 .short_help = "nat ipfix logging [domain <domain-id>] [src-port <port>] [disable]",
2231 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2233 snat_main_t *sm = &snat_main;
2234 u32 next_worker_index = 0;
2237 next_worker_index = sm->first_worker_index;
2238 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
2239 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >>24);
2241 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
2242 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
2244 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
2246 return next_worker_index;
2250 snat_get_worker_out2in_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2252 snat_main_t *sm = &snat_main;
2255 snat_session_key_t m_key;
2256 clib_bihash_kv_8_8_t kv, value;
2257 snat_static_mapping_t *m;
2258 nat_ed_ses_key_t key;
2259 clib_bihash_kv_16_8_t s_kv, s_value;
2260 snat_main_per_thread_data_t *tsm;
2265 /* first try static mappings without port */
2266 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2268 m_key.addr = ip0->dst_address;
2271 m_key.fib_index = rx_fib_index0;
2272 kv.key = m_key.as_u64;
2273 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
2275 m = pool_elt_at_index (sm->static_mappings, value.value);
2276 return m->worker_index;
2280 proto = ip_proto_to_snat_proto (ip0->protocol);
2281 udp = ip4_next_header (ip0);
2282 port = udp->dst_port;
2284 /* unknown protocol */
2285 if (PREDICT_FALSE (proto == ~0))
2287 key.l_addr = ip0->dst_address;
2288 key.r_addr = ip0->src_address;
2289 key.fib_index = rx_fib_index0;
2290 key.proto = ip0->protocol;
2293 s_kv.key[0] = key.as_u64[0];
2294 s_kv.key[1] = key.as_u64[1];
2296 if (!clib_bihash_search_16_8 (&sm->out2in_ed, &s_kv, &s_value))
2298 for (i = 0; i < _vec_len (sm->per_thread_data); i++)
2300 tsm = vec_elt_at_index (sm->per_thread_data, i);
2301 if (!pool_is_free_index(tsm->sessions, s_value.value))
2303 s = pool_elt_at_index (tsm->sessions, s_value.value);
2304 if (s->out2in.addr.as_u32 == ip0->dst_address.as_u32 &&
2305 s->out2in.port == ip0->protocol &&
2306 snat_is_unk_proto_session (s))
2312 /* if no session use current thread */
2313 return vlib_get_thread_index ();
2316 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
2318 icmp46_header_t * icmp = (icmp46_header_t *) udp;
2319 icmp_echo_header_t *echo = (icmp_echo_header_t *)(icmp + 1);
2320 if (!icmp_is_error_message (icmp))
2321 port = echo->identifier;
2324 ip4_header_t *inner_ip = (ip4_header_t *)(echo + 1);
2325 proto = ip_proto_to_snat_proto (inner_ip->protocol);
2326 void *l4_header = ip4_next_header (inner_ip);
2329 case SNAT_PROTOCOL_ICMP:
2330 icmp = (icmp46_header_t*)l4_header;
2331 echo = (icmp_echo_header_t *)(icmp + 1);
2332 port = echo->identifier;
2334 case SNAT_PROTOCOL_UDP:
2335 case SNAT_PROTOCOL_TCP:
2336 port = ((tcp_udp_header_t*)l4_header)->src_port;
2339 return vlib_get_thread_index ();
2344 /* try static mappings with port */
2345 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2347 m_key.addr = ip0->dst_address;
2348 m_key.port = clib_net_to_host_u16 (port);
2349 m_key.protocol = proto;
2350 m_key.fib_index = rx_fib_index0;
2351 kv.key = m_key.as_u64;
2352 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
2354 m = pool_elt_at_index (sm->static_mappings, value.value);
2355 return m->worker_index;
2359 /* worker by outside port */
2360 return (u32) ((clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread);
2363 static clib_error_t *
2364 snat_config (vlib_main_t * vm, unformat_input_t * input)
2366 snat_main_t * sm = &snat_main;
2367 u32 translation_buckets = 1024;
2368 u32 translation_memory_size = 128<<20;
2369 u32 user_buckets = 128;
2370 u32 user_memory_size = 64<<20;
2371 u32 max_translations_per_user = 100;
2372 u32 outside_vrf_id = 0;
2373 u32 inside_vrf_id = 0;
2374 u32 static_mapping_buckets = 1024;
2375 u32 static_mapping_memory_size = 64<<20;
2376 u8 static_mapping_only = 0;
2377 u8 static_mapping_connection_tracking = 0;
2378 snat_main_per_thread_data_t *tsm;
2380 sm->deterministic = 0;
2382 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2384 if (unformat (input, "translation hash buckets %d", &translation_buckets))
2386 else if (unformat (input, "translation hash memory %d",
2387 &translation_memory_size));
2388 else if (unformat (input, "user hash buckets %d", &user_buckets))
2390 else if (unformat (input, "user hash memory %d",
2393 else if (unformat (input, "max translations per user %d",
2394 &max_translations_per_user))
2396 else if (unformat (input, "outside VRF id %d",
2399 else if (unformat (input, "inside VRF id %d",
2402 else if (unformat (input, "static mapping only"))
2404 static_mapping_only = 1;
2405 if (unformat (input, "connection tracking"))
2406 static_mapping_connection_tracking = 1;
2408 else if (unformat (input, "deterministic"))
2409 sm->deterministic = 1;
2411 return clib_error_return (0, "unknown input '%U'",
2412 format_unformat_error, input);
2415 /* for show commands, etc. */
2416 sm->translation_buckets = translation_buckets;
2417 sm->translation_memory_size = translation_memory_size;
2418 /* do not exceed load factor 10 */
2419 sm->max_translations = 10 * translation_buckets;
2420 sm->user_buckets = user_buckets;
2421 sm->user_memory_size = user_memory_size;
2422 sm->max_translations_per_user = max_translations_per_user;
2423 sm->outside_vrf_id = outside_vrf_id;
2424 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2426 FIB_SOURCE_PLUGIN_HI);
2427 sm->inside_vrf_id = inside_vrf_id;
2428 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2430 FIB_SOURCE_PLUGIN_HI);
2431 sm->static_mapping_only = static_mapping_only;
2432 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
2434 if (sm->deterministic)
2436 sm->in2out_node_index = snat_det_in2out_node.index;
2437 sm->in2out_output_node_index = ~0;
2438 sm->out2in_node_index = snat_det_out2in_node.index;
2439 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
2440 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
2444 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
2445 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
2446 sm->in2out_node_index = snat_in2out_node.index;
2447 sm->in2out_output_node_index = snat_in2out_output_node.index;
2448 sm->out2in_node_index = snat_out2in_node.index;
2449 if (!static_mapping_only ||
2450 (static_mapping_only && static_mapping_connection_tracking))
2452 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
2453 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
2455 vec_foreach (tsm, sm->per_thread_data)
2457 clib_bihash_init_8_8 (&tsm->in2out, "in2out", translation_buckets,
2458 translation_memory_size);
2460 clib_bihash_init_8_8 (&tsm->out2in, "out2in", translation_buckets,
2461 translation_memory_size);
2463 clib_bihash_init_8_8 (&tsm->user_hash, "users", user_buckets,
2467 clib_bihash_init_16_8 (&sm->in2out_ed, "in2out-ed",
2468 translation_buckets, translation_memory_size);
2470 clib_bihash_init_16_8 (&sm->out2in_ed, "out2in-ed",
2471 translation_buckets, translation_memory_size);
2475 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
2476 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
2478 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
2479 "static_mapping_by_local", static_mapping_buckets,
2480 static_mapping_memory_size);
2482 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
2483 "static_mapping_by_external", static_mapping_buckets,
2484 static_mapping_memory_size);
2490 VLIB_CONFIG_FUNCTION (snat_config, "nat");
2492 u8 * format_snat_session_state (u8 * s, va_list * args)
2494 u32 i = va_arg (*args, u32);
2499 #define _(v, N, str) case SNAT_SESSION_##N: t = (u8 *) str; break;
2500 foreach_snat_session_state
2503 t = format (t, "unknown");
2505 s = format (s, "%s", t);
2509 u8 * format_snat_key (u8 * s, va_list * args)
2511 snat_session_key_t * key = va_arg (*args, snat_session_key_t *);
2513 s = format (s, "%U proto %U port %d fib %d",
2514 format_ip4_address, &key->addr,
2515 format_snat_protocol, key->protocol,
2516 clib_net_to_host_u16 (key->port), key->fib_index);
2520 u8 * format_snat_session (u8 * s, va_list * args)
2522 snat_main_t * sm __attribute__((unused)) = va_arg (*args, snat_main_t *);
2523 snat_session_t * sess = va_arg (*args, snat_session_t *);
2525 if (snat_is_unk_proto_session (sess))
2527 s = format (s, " i2o %U proto %u fib %u\n",
2528 format_ip4_address, &sess->in2out.addr, sess->in2out.port,
2529 sess->in2out.fib_index);
2530 s = format (s, " o2i %U proto %u fib %u\n",
2531 format_ip4_address, &sess->out2in.addr, sess->out2in.port,
2532 sess->out2in.fib_index);
2536 s = format (s, " i2o %U\n", format_snat_key, &sess->in2out);
2537 s = format (s, " o2i %U\n", format_snat_key, &sess->out2in);
2539 if (sess->ext_host_addr.as_u32)
2540 s = format (s, " external host %U\n",
2541 format_ip4_address, &sess->ext_host_addr);
2542 s = format (s, " last heard %.2f\n", sess->last_heard);
2543 s = format (s, " total pkts %d, total bytes %lld\n",
2544 sess->total_pkts, sess->total_bytes);
2545 if (snat_is_session_static (sess))
2546 s = format (s, " static translation\n");
2548 s = format (s, " dynamic translation\n");
2549 if (sess->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
2550 s = format (s, " load-balancing\n");
2555 u8 * format_snat_user (u8 * s, va_list * args)
2557 snat_main_per_thread_data_t * sm = va_arg (*args, snat_main_per_thread_data_t *);
2558 snat_user_t * u = va_arg (*args, snat_user_t *);
2559 int verbose = va_arg (*args, int);
2560 dlist_elt_t * head, * elt;
2561 u32 elt_index, head_index;
2563 snat_session_t * sess;
2565 s = format (s, "%U: %d dynamic translations, %d static translations\n",
2566 format_ip4_address, &u->addr, u->nsessions, u->nstaticsessions);
2571 if (u->nsessions || u->nstaticsessions)
2573 head_index = u->sessions_per_user_list_head_index;
2574 head = pool_elt_at_index (sm->list_pool, head_index);
2576 elt_index = head->next;
2577 elt = pool_elt_at_index (sm->list_pool, elt_index);
2578 session_index = elt->value;
2580 while (session_index != ~0)
2582 sess = pool_elt_at_index (sm->sessions, session_index);
2584 s = format (s, " %U\n", format_snat_session, sm, sess);
2586 elt_index = elt->next;
2587 elt = pool_elt_at_index (sm->list_pool, elt_index);
2588 session_index = elt->value;
2595 u8 * format_snat_static_mapping (u8 * s, va_list * args)
2597 snat_static_mapping_t *m = va_arg (*args, snat_static_mapping_t *);
2598 nat44_lb_addr_port_t *local;
2601 s = format (s, "local %U external %U vrf %d",
2602 format_ip4_address, &m->local_addr,
2603 format_ip4_address, &m->external_addr,
2607 if (vec_len (m->locals))
2609 s = format (s, "%U vrf %d external %U:%d",
2610 format_snat_protocol, m->proto,
2612 format_ip4_address, &m->external_addr, m->external_port);
2613 vec_foreach (local, m->locals)
2614 s = format (s, "\n local %U:%d probability %d\%",
2615 format_ip4_address, &local->addr, local->port,
2616 local->probability);
2619 s = format (s, "%U local %U:%d external %U:%d vrf %d",
2620 format_snat_protocol, m->proto,
2621 format_ip4_address, &m->local_addr, m->local_port,
2622 format_ip4_address, &m->external_addr, m->external_port,
2628 u8 * format_snat_static_map_to_resolve (u8 * s, va_list * args)
2630 snat_static_map_resolve_t *m = va_arg (*args, snat_static_map_resolve_t *);
2631 vnet_main_t *vnm = vnet_get_main();
2634 s = format (s, "local %U external %U vrf %d",
2635 format_ip4_address, &m->l_addr,
2636 format_vnet_sw_interface_name, vnm,
2637 vnet_get_sw_interface (vnm, m->sw_if_index),
2640 s = format (s, "%U local %U:%d external %U:%d vrf %d",
2641 format_snat_protocol, m->proto,
2642 format_ip4_address, &m->l_addr, m->l_port,
2643 format_vnet_sw_interface_name, vnm,
2644 vnet_get_sw_interface (vnm, m->sw_if_index), m->e_port,
2650 u8 * format_det_map_ses (u8 * s, va_list * args)
2652 snat_det_map_t * det_map = va_arg (*args, snat_det_map_t *);
2653 ip4_address_t in_addr, out_addr;
2654 u32 in_offset, out_offset;
2655 snat_det_session_t * ses = va_arg (*args, snat_det_session_t *);
2656 u32 * i = va_arg (*args, u32 *);
2658 u32 user_index = *i / SNAT_DET_SES_PER_USER;
2659 in_addr.as_u32 = clib_host_to_net_u32 (
2660 clib_net_to_host_u32(det_map->in_addr.as_u32) + user_index);
2661 in_offset = clib_net_to_host_u32(in_addr.as_u32) -
2662 clib_net_to_host_u32(det_map->in_addr.as_u32);
2663 out_offset = in_offset / det_map->sharing_ratio;
2664 out_addr.as_u32 = clib_host_to_net_u32(
2665 clib_net_to_host_u32(det_map->out_addr.as_u32) + out_offset);
2666 s = format (s, "in %U:%d out %U:%d external host %U:%d state: %U expire: %d\n",
2667 format_ip4_address, &in_addr,
2668 clib_net_to_host_u16 (ses->in_port),
2669 format_ip4_address, &out_addr,
2670 clib_net_to_host_u16 (ses->out.out_port),
2671 format_ip4_address, &ses->out.ext_host_addr,
2672 clib_net_to_host_u16 (ses->out.ext_host_port),
2673 format_snat_session_state, ses->state,
2679 static clib_error_t *
2680 show_snat_command_fn (vlib_main_t * vm,
2681 unformat_input_t * input,
2682 vlib_cli_command_t * cmd)
2685 snat_main_t * sm = &snat_main;
2687 snat_static_mapping_t *m;
2688 snat_interface_t *i;
2689 snat_address_t * ap;
2690 vnet_main_t *vnm = vnet_get_main();
2691 snat_main_per_thread_data_t *tsm;
2692 u32 users_num = 0, sessions_num = 0, *worker, *sw_if_index;
2694 snat_static_map_resolve_t *rp;
2695 snat_det_map_t * dm;
2696 snat_det_session_t * ses;
2698 if (unformat (input, "detail"))
2700 else if (unformat (input, "verbose"))
2703 if (sm->static_mapping_only)
2705 if (sm->static_mapping_connection_tracking)
2706 vlib_cli_output (vm, "NAT plugin mode: static mapping only connection "
2709 vlib_cli_output (vm, "NAT plugin mode: static mapping only");
2711 else if (sm->deterministic)
2713 vlib_cli_output (vm, "NAT plugin mode: deterministic mapping");
2717 vlib_cli_output (vm, "NAT plugin mode: dynamic translations enabled");
2722 pool_foreach (i, sm->interfaces,
2724 vlib_cli_output (vm, "%U %s", format_vnet_sw_interface_name, vnm,
2725 vnet_get_sw_interface (vnm, i->sw_if_index),
2726 (nat_interface_is_inside(i) &&
2727 nat_interface_is_outside(i)) ? "in out" :
2728 (nat_interface_is_inside(i) ? "in" : "out"));
2731 pool_foreach (i, sm->output_feature_interfaces,
2733 vlib_cli_output (vm, "%U output-feature %s",
2734 format_vnet_sw_interface_name, vnm,
2735 vnet_get_sw_interface (vnm, i->sw_if_index),
2736 (nat_interface_is_inside(i) &&
2737 nat_interface_is_outside(i)) ? "in out" :
2738 (nat_interface_is_inside(i) ? "in" : "out"));
2741 if (vec_len (sm->auto_add_sw_if_indices))
2743 vlib_cli_output (vm, "NAT44 pool addresses interfaces:");
2744 vec_foreach (sw_if_index, sm->auto_add_sw_if_indices)
2746 vlib_cli_output (vm, "%U", format_vnet_sw_interface_name, vnm,
2747 vnet_get_sw_interface (vnm, *sw_if_index));
2751 vec_foreach (ap, sm->addresses)
2753 vlib_cli_output (vm, "%U", format_ip4_address, &ap->addr);
2754 if (ap->fib_index != ~0)
2755 vlib_cli_output (vm, " tenant VRF: %u",
2756 ip4_fib_get(ap->fib_index)->table_id);
2758 vlib_cli_output (vm, " tenant VRF independent");
2759 #define _(N, i, n, s) \
2760 vlib_cli_output (vm, " %d busy %s ports", ap->busy_##n##_ports, s);
2761 foreach_snat_protocol
2766 if (sm->num_workers > 1)
2768 vlib_cli_output (vm, "%d workers", vec_len (sm->workers));
2771 vec_foreach (worker, sm->workers)
2773 vlib_worker_thread_t *w =
2774 vlib_worker_threads + *worker + sm->first_worker_index;
2775 vlib_cli_output (vm, " %s", w->name);
2780 if (sm->deterministic)
2782 vlib_cli_output (vm, "udp timeout: %dsec", sm->udp_timeout);
2783 vlib_cli_output (vm, "tcp-established timeout: %dsec",
2784 sm->tcp_established_timeout);
2785 vlib_cli_output (vm, "tcp-transitory timeout: %dsec",
2786 sm->tcp_transitory_timeout);
2787 vlib_cli_output (vm, "icmp timeout: %dsec", sm->icmp_timeout);
2788 vlib_cli_output (vm, "%d deterministic mappings",
2789 pool_elts (sm->det_maps));
2792 pool_foreach (dm, sm->det_maps,
2794 vlib_cli_output (vm, "in %U/%d out %U/%d\n",
2795 format_ip4_address, &dm->in_addr, dm->in_plen,
2796 format_ip4_address, &dm->out_addr, dm->out_plen);
2797 vlib_cli_output (vm, " outside address sharing ratio: %d\n",
2799 vlib_cli_output (vm, " number of ports per inside host: %d\n",
2800 dm->ports_per_host);
2801 vlib_cli_output (vm, " sessions number: %d\n", dm->ses_num);
2804 vec_foreach_index (j, dm->sessions)
2806 ses = vec_elt_at_index (dm->sessions, j);
2808 vlib_cli_output (vm, " %U", format_det_map_ses, dm, ses,
2817 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
2819 vlib_cli_output (vm, "%d static mappings",
2820 pool_elts (sm->static_mappings));
2824 pool_foreach (m, sm->static_mappings,
2826 vlib_cli_output (vm, "%U", format_snat_static_mapping, m);
2832 vec_foreach (tsm, sm->per_thread_data)
2834 users_num += pool_elts (tsm->users);
2835 sessions_num += pool_elts (tsm->sessions);
2838 vlib_cli_output (vm, "%d users, %d outside addresses, %d active sessions,"
2839 " %d static mappings",
2841 vec_len (sm->addresses),
2843 pool_elts (sm->static_mappings));
2847 vlib_cli_output (vm, "%U", format_bihash_16_8, &sm->in2out_ed,
2849 vlib_cli_output (vm, "%U", format_bihash_16_8, &sm->out2in_ed,
2851 vec_foreach_index (j, sm->per_thread_data)
2853 tsm = vec_elt_at_index (sm->per_thread_data, j);
2855 if (pool_elts (tsm->users) == 0)
2858 vlib_worker_thread_t *w = vlib_worker_threads + j;
2859 vlib_cli_output (vm, "Thread %d (%s at lcore %u):", j, w->name,
2861 vlib_cli_output (vm, " %U", format_bihash_8_8, &tsm->in2out,
2863 vlib_cli_output (vm, " %U", format_bihash_8_8, &tsm->out2in,
2865 vlib_cli_output (vm, " %d list pool elements",
2866 pool_elts (tsm->list_pool));
2868 pool_foreach (u, tsm->users,
2870 vlib_cli_output (vm, " %U", format_snat_user, tsm, u,
2875 if (pool_elts (sm->static_mappings))
2877 vlib_cli_output (vm, "static mappings:");
2878 pool_foreach (m, sm->static_mappings,
2880 vlib_cli_output (vm, "%U", format_snat_static_mapping, m);
2882 for (j = 0; j < vec_len (sm->to_resolve); j++)
2884 rp = sm->to_resolve + j;
2885 vlib_cli_output (vm, "%U",
2886 format_snat_static_map_to_resolve, rp);
2895 VLIB_CLI_COMMAND (show_snat_command, static) = {
2896 .path = "show nat44",
2897 .short_help = "show nat44",
2898 .function = show_snat_command_fn,
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 u32 *indices_to_delete = 0;
2917 for (i = 0; i < vec_len(sm->auto_add_sw_if_indices); i++)
2919 if (sw_if_index == sm->auto_add_sw_if_indices[i])
2923 /* Don't trip over lease renewal, static config */
2924 for (j = 0; j < vec_len(sm->addresses); j++)
2925 if (sm->addresses[j].addr.as_u32 == address->as_u32)
2928 snat_add_address (sm, address, ~0);
2929 /* Scan static map resolution vector */
2930 for (j = 0; j < vec_len (sm->to_resolve); j++)
2932 rp = sm->to_resolve + j;
2933 /* On this interface? */
2934 if (rp->sw_if_index == sw_if_index)
2936 /* Add the static mapping */
2937 rv = snat_add_static_mapping (rp->l_addr,
2943 ~0 /* sw_if_index */,
2947 clib_warning ("snat_add_static_mapping returned %d",
2949 vec_add1 (indices_to_delete, j);
2952 /* If we resolved any of the outstanding static mappings */
2953 if (vec_len(indices_to_delete))
2956 for (j = vec_len(indices_to_delete)-1; j >= 0; j--)
2957 vec_delete(sm->to_resolve, 1, j);
2958 vec_free(indices_to_delete);
2964 (void) snat_del_address(sm, address[0], 1);
2972 int snat_add_interface_address (snat_main_t *sm, u32 sw_if_index, int is_del)
2974 ip4_main_t * ip4_main = sm->ip4_main;
2975 ip4_address_t * first_int_addr;
2976 snat_static_map_resolve_t *rp;
2977 u32 *indices_to_delete = 0;
2980 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index,
2981 0 /* just want the address*/);
2983 for (i = 0; i < vec_len(sm->auto_add_sw_if_indices); i++)
2985 if (sm->auto_add_sw_if_indices[i] == sw_if_index)
2989 /* if have address remove it */
2991 (void) snat_del_address (sm, first_int_addr[0], 1);
2994 for (j = 0; j < vec_len (sm->to_resolve); j++)
2996 rp = sm->to_resolve + j;
2997 if (rp->sw_if_index == sw_if_index)
2998 vec_add1 (indices_to_delete, j);
3000 if (vec_len(indices_to_delete))
3002 for (j = vec_len(indices_to_delete)-1; j >= 0; j--)
3003 vec_del1(sm->to_resolve, j);
3004 vec_free(indices_to_delete);
3007 vec_del1(sm->auto_add_sw_if_indices, i);
3010 return VNET_API_ERROR_VALUE_EXIST;
3017 return VNET_API_ERROR_NO_SUCH_ENTRY;
3019 /* add to the auto-address list */
3020 vec_add1(sm->auto_add_sw_if_indices, sw_if_index);
3022 /* If the address is already bound - or static - add it now */
3024 snat_add_address (sm, first_int_addr, ~0);
3029 static clib_error_t *
3030 snat_add_interface_address_command_fn (vlib_main_t * vm,
3031 unformat_input_t * input,
3032 vlib_cli_command_t * cmd)
3034 snat_main_t *sm = &snat_main;
3035 unformat_input_t _line_input, *line_input = &_line_input;
3039 clib_error_t *error = 0;
3041 /* Get a line of input. */
3042 if (!unformat_user (input, unformat_line_input, line_input))
3045 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3047 if (unformat (line_input, "%U", unformat_vnet_sw_interface,
3048 sm->vnet_main, &sw_if_index))
3050 else if (unformat (line_input, "del"))
3054 error = clib_error_return (0, "unknown input '%U'",
3055 format_unformat_error, line_input);
3060 rv = snat_add_interface_address (sm, sw_if_index, is_del);
3068 error = clib_error_return (0, "snat_add_interface_address returned %d",
3074 unformat_free (line_input);
3079 VLIB_CLI_COMMAND (snat_add_interface_address_command, static) = {
3080 .path = "nat44 add interface address",
3081 .short_help = "nat44 add interface address <interface> [del]",
3082 .function = snat_add_interface_address_command_fn,
3086 nat44_del_session (snat_main_t *sm, ip4_address_t *addr, u16 port,
3087 snat_protocol_t proto, u32 vrf_id, int is_in)
3089 snat_main_per_thread_data_t *tsm;
3090 clib_bihash_kv_8_8_t kv, value;
3092 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3093 snat_session_key_t key;
3095 clib_bihash_8_8_t *t;
3096 snat_user_key_t u_key;
3099 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
3100 if (sm->num_workers)
3102 vec_elt_at_index (sm->per_thread_data,
3103 sm->worker_in2out_cb (&ip, fib_index));
3105 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
3107 key.addr.as_u32 = addr->as_u32;
3108 key.port = clib_host_to_net_u16 (port);
3109 key.protocol = proto;
3110 key.fib_index = fib_index;
3111 kv.key = key.as_u64;
3112 t = is_in ? &tsm->in2out : &tsm->out2in;
3113 if (!clib_bihash_search_8_8 (t, &kv, &value))
3115 s = pool_elt_at_index (tsm->sessions, value.value);
3116 kv.key = s->in2out.as_u64;
3117 clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0);
3118 kv.key = s->out2in.as_u64;
3119 clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0);
3120 u_key.addr = s->in2out.addr;
3121 u_key.fib_index = s->in2out.fib_index;
3122 kv.key = u_key.as_u64;
3123 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
3125 u = pool_elt_at_index (tsm->users, value.value);
3128 clib_dlist_remove (tsm->list_pool, s->per_user_index);
3129 pool_put (tsm->sessions, s);
3133 return VNET_API_ERROR_NO_SUCH_ENTRY;
3136 static clib_error_t *
3137 nat44_del_session_command_fn (vlib_main_t * vm,
3138 unformat_input_t * input,
3139 vlib_cli_command_t * cmd)
3141 snat_main_t *sm = &snat_main;
3142 unformat_input_t _line_input, *line_input = &_line_input;
3144 clib_error_t *error = 0;
3146 u32 port = 0, vrf_id = sm->outside_vrf_id;
3147 snat_protocol_t proto;
3150 /* Get a line of input. */
3151 if (!unformat_user (input, unformat_line_input, line_input))
3154 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3156 if (unformat (line_input, "%U:%u %U", unformat_ip4_address, &addr, &port,
3157 unformat_snat_protocol, &proto))
3159 else if (unformat (line_input, "in"))
3162 vrf_id = sm->inside_vrf_id;
3164 else if (unformat (line_input, "vrf %u", &vrf_id))
3168 error = clib_error_return (0, "unknown input '%U'",
3169 format_unformat_error, line_input);
3174 rv = nat44_del_session(sm, &addr, port, proto, vrf_id, is_in);
3182 error = clib_error_return (0, "nat44_del_session returned %d", rv);
3187 unformat_free (line_input);
3192 VLIB_CLI_COMMAND (nat44_del_session_command, static) = {
3193 .path = "nat44 del session",
3194 .short_help = "nat44 del session in|out <addr>:<port> tcp|udp|icmp [vrf <id>]",
3195 .function = nat44_del_session_command_fn,
3198 static clib_error_t *
3199 snat_det_map_command_fn (vlib_main_t * vm,
3200 unformat_input_t * input,
3201 vlib_cli_command_t * cmd)
3203 snat_main_t *sm = &snat_main;
3204 unformat_input_t _line_input, *line_input = &_line_input;
3205 ip4_address_t in_addr, out_addr;
3206 u32 in_plen, out_plen;
3208 clib_error_t *error = 0;
3210 /* Get a line of input. */
3211 if (!unformat_user (input, unformat_line_input, line_input))
3214 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3216 if (unformat (line_input, "in %U/%u", unformat_ip4_address, &in_addr, &in_plen))
3218 else if (unformat (line_input, "out %U/%u", unformat_ip4_address, &out_addr, &out_plen))
3220 else if (unformat (line_input, "del"))
3224 error = clib_error_return (0, "unknown input '%U'",
3225 format_unformat_error, line_input);
3230 unformat_free (line_input);
3232 rv = snat_det_add_map(sm, &in_addr, (u8) in_plen, &out_addr, (u8)out_plen,
3237 error = clib_error_return (0, "snat_det_add_map return %d", rv);
3242 unformat_free (line_input);
3249 * @cliexstart{snat deterministic add}
3250 * Create bijective mapping of inside address to outside address and port range
3251 * pairs, with the purpose of enabling deterministic NAT to reduce logging in
3253 * To create deterministic mapping between inside network 10.0.0.0/18 and
3254 * outside network 1.1.1.0/30 use:
3255 * # vpp# nat44 deterministic add in 10.0.0.0/18 out 1.1.1.0/30
3258 VLIB_CLI_COMMAND (snat_det_map_command, static) = {
3259 .path = "nat44 deterministic add",
3260 .short_help = "nat44 deterministic add in <addr>/<plen> out <addr>/<plen> [del]",
3261 .function = snat_det_map_command_fn,
3264 static clib_error_t *
3265 snat_det_forward_command_fn (vlib_main_t * vm,
3266 unformat_input_t * input,
3267 vlib_cli_command_t * cmd)
3269 snat_main_t *sm = &snat_main;
3270 unformat_input_t _line_input, *line_input = &_line_input;
3271 ip4_address_t in_addr, out_addr;
3273 snat_det_map_t * dm;
3274 clib_error_t *error = 0;
3276 /* Get a line of input. */
3277 if (!unformat_user (input, unformat_line_input, line_input))
3280 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3282 if (unformat (line_input, "%U", unformat_ip4_address, &in_addr))
3286 error = clib_error_return (0, "unknown input '%U'",
3287 format_unformat_error, line_input);
3292 unformat_free (line_input);
3294 dm = snat_det_map_by_user(sm, &in_addr);
3296 vlib_cli_output (vm, "no match");
3299 snat_det_forward (dm, &in_addr, &out_addr, &lo_port);
3300 vlib_cli_output (vm, "%U:<%d-%d>", format_ip4_address, &out_addr,
3301 lo_port, lo_port + dm->ports_per_host - 1);
3305 unformat_free (line_input);
3312 * @cliexstart{snat deterministic forward}
3313 * Return outside address and port range from inside address for deterministic
3315 * To obtain outside address and port of inside host use:
3316 * vpp# nat44 deterministic forward 10.0.0.2
3317 * 1.1.1.0:<1054-1068>
3320 VLIB_CLI_COMMAND (snat_det_forward_command, static) = {
3321 .path = "nat44 deterministic forward",
3322 .short_help = "nat44 deterministic forward <addr>",
3323 .function = snat_det_forward_command_fn,
3326 static clib_error_t *
3327 snat_det_reverse_command_fn (vlib_main_t * vm,
3328 unformat_input_t * input,
3329 vlib_cli_command_t * cmd)
3331 snat_main_t *sm = &snat_main;
3332 unformat_input_t _line_input, *line_input = &_line_input;
3333 ip4_address_t in_addr, out_addr;
3335 snat_det_map_t * dm;
3336 clib_error_t *error = 0;
3338 /* Get a line of input. */
3339 if (!unformat_user (input, unformat_line_input, line_input))
3342 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3344 if (unformat (line_input, "%U:%d", unformat_ip4_address, &out_addr, &out_port))
3348 error = clib_error_return (0, "unknown input '%U'",
3349 format_unformat_error, line_input);
3353 unformat_free (line_input);
3355 if (out_port < 1024 || out_port > 65535)
3357 error = clib_error_return (0, "wrong port, must be <1024-65535>");
3361 dm = snat_det_map_by_out(sm, &out_addr);
3363 vlib_cli_output (vm, "no match");
3366 snat_det_reverse (dm, &out_addr, (u16) out_port, &in_addr);
3367 vlib_cli_output (vm, "%U", format_ip4_address, &in_addr);
3371 unformat_free (line_input);
3378 * @cliexstart{snat deterministic reverse}
3379 * Return inside address from outside address and port for deterministic NAT.
3380 * To obtain inside host address from outside address and port use:
3381 * #vpp nat44 deterministic reverse 1.1.1.1:1276
3385 VLIB_CLI_COMMAND (snat_det_reverse_command, static) = {
3386 .path = "nat44 deterministic reverse",
3387 .short_help = "nat44 deterministic reverse <addr>:<port>",
3388 .function = snat_det_reverse_command_fn,
3391 static clib_error_t *
3392 set_timeout_command_fn (vlib_main_t * vm,
3393 unformat_input_t * input,
3394 vlib_cli_command_t * cmd)
3396 snat_main_t *sm = &snat_main;
3397 unformat_input_t _line_input, *line_input = &_line_input;
3398 clib_error_t *error = 0;
3400 /* Get a line of input. */
3401 if (!unformat_user (input, unformat_line_input, line_input))
3404 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3406 if (unformat (line_input, "udp %u", &sm->udp_timeout))
3408 else if (unformat (line_input, "tcp-established %u",
3409 &sm->tcp_established_timeout))
3411 else if (unformat (line_input, "tcp-transitory %u",
3412 &sm->tcp_transitory_timeout))
3414 else if (unformat (line_input, "icmp %u", &sm->icmp_timeout))
3416 else if (unformat (line_input, "reset"))
3418 sm->udp_timeout = SNAT_UDP_TIMEOUT;
3419 sm->tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
3420 sm->tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
3421 sm->icmp_timeout = SNAT_ICMP_TIMEOUT;
3425 error = clib_error_return (0, "unknown input '%U'",
3426 format_unformat_error, line_input);
3431 unformat_free (line_input);
3434 unformat_free (line_input);
3441 * @cliexstart{set snat deterministic timeout}
3442 * Set values of timeouts for deterministic NAT (in seconds), use:
3443 * vpp# set nat44 deterministic timeout udp 120 tcp-established 7500
3444 * tcp-transitory 250 icmp 90
3445 * To reset default values use:
3446 * vpp# set nat44 deterministic timeout reset
3449 VLIB_CLI_COMMAND (set_timeout_command, static) = {
3450 .path = "set nat44 deterministic timeout",
3451 .function = set_timeout_command_fn,
3453 "set nat44 deterministic timeout [udp <sec> | tcp-established <sec> "
3454 "tcp-transitory <sec> | icmp <sec> | reset]",
3457 static clib_error_t *
3458 snat_det_close_session_out_fn (vlib_main_t *vm,
3459 unformat_input_t * input,
3460 vlib_cli_command_t * cmd)
3462 snat_main_t *sm = &snat_main;
3463 unformat_input_t _line_input, *line_input = &_line_input;
3464 ip4_address_t out_addr, ext_addr, in_addr;
3465 u32 out_port, ext_port;
3466 snat_det_map_t * dm;
3467 snat_det_session_t * ses;
3468 snat_det_out_key_t key;
3469 clib_error_t *error = 0;
3471 /* Get a line of input. */
3472 if (!unformat_user (input, unformat_line_input, line_input))
3475 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3477 if (unformat (line_input, "%U:%d %U:%d",
3478 unformat_ip4_address, &out_addr, &out_port,
3479 unformat_ip4_address, &ext_addr, &ext_port))
3483 error = clib_error_return (0, "unknown input '%U'",
3484 format_unformat_error, line_input);
3489 unformat_free (line_input);
3491 dm = snat_det_map_by_out(sm, &out_addr);
3493 vlib_cli_output (vm, "no match");
3496 snat_det_reverse(dm, &ext_addr, (u16)out_port, &in_addr);
3497 key.ext_host_addr = out_addr;
3498 key.ext_host_port = ntohs((u16)ext_port);
3499 key.out_port = ntohs((u16)out_port);
3500 ses = snat_det_get_ses_by_out(dm, &out_addr, key.as_u64);
3502 vlib_cli_output (vm, "no match");
3504 snat_det_ses_close(dm, ses);
3508 unformat_free (line_input);
3515 * @cliexstart{snat deterministic close session out}
3516 * Close session using outside ip address and port
3517 * and external ip address and port, use:
3518 * vpp# nat44 deterministic close session out 1.1.1.1:1276 2.2.2.2:2387
3521 VLIB_CLI_COMMAND (snat_det_close_sesion_out_command, static) = {
3522 .path = "nat44 deterministic close session out",
3523 .short_help = "nat44 deterministic close session out "
3524 "<out_addr>:<out_port> <ext_addr>:<ext_port>",
3525 .function = snat_det_close_session_out_fn,
3528 static clib_error_t *
3529 snat_det_close_session_in_fn (vlib_main_t *vm,
3530 unformat_input_t * input,
3531 vlib_cli_command_t * cmd)
3533 snat_main_t *sm = &snat_main;
3534 unformat_input_t _line_input, *line_input = &_line_input;
3535 ip4_address_t in_addr, ext_addr;
3536 u32 in_port, ext_port;
3537 snat_det_map_t * dm;
3538 snat_det_session_t * ses;
3539 snat_det_out_key_t key;
3540 clib_error_t *error = 0;
3542 /* Get a line of input. */
3543 if (!unformat_user (input, unformat_line_input, line_input))
3546 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3548 if (unformat (line_input, "%U:%d %U:%d",
3549 unformat_ip4_address, &in_addr, &in_port,
3550 unformat_ip4_address, &ext_addr, &ext_port))
3554 error = clib_error_return (0, "unknown input '%U'",
3555 format_unformat_error, line_input);
3560 unformat_free (line_input);
3562 dm = snat_det_map_by_user (sm, &in_addr);
3564 vlib_cli_output (vm, "no match");
3567 key.ext_host_addr = ext_addr;
3568 key.ext_host_port = ntohs ((u16)ext_port);
3569 ses = snat_det_find_ses_by_in (dm, &in_addr, ntohs((u16)in_port), key);
3571 vlib_cli_output (vm, "no match");
3573 snat_det_ses_close(dm, ses);
3577 unformat_free(line_input);
3584 * @cliexstart{snat deterministic close_session_in}
3585 * Close session using inside ip address and port
3586 * and external ip address and port, use:
3587 * vpp# nat44 deterministic close session in 3.3.3.3:3487 2.2.2.2:2387
3590 VLIB_CLI_COMMAND (snat_det_close_session_in_command, static) = {
3591 .path = "nat44 deterministic close session in",
3592 .short_help = "nat44 deterministic close session in "
3593 "<in_addr>:<in_port> <ext_addr>:<ext_port>",
3594 .function = snat_det_close_session_in_fn,