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/dslite.h>
28 #include <nat/nat_reass.h>
29 #include <vnet/fib/fib_table.h>
30 #include <vnet/fib/ip4_fib.h>
32 #include <vpp/app/version.h>
34 snat_main_t snat_main;
37 /* Hook up input features */
38 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
39 .arc_name = "ip4-unicast",
40 .node_name = "nat44-in2out",
41 .runs_before = VNET_FEATURES ("nat44-out2in"),
43 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
44 .arc_name = "ip4-unicast",
45 .node_name = "nat44-out2in",
46 .runs_before = VNET_FEATURES ("ip4-lookup"),
48 VNET_FEATURE_INIT (ip4_nat_classify, static) = {
49 .arc_name = "ip4-unicast",
50 .node_name = "nat44-classify",
51 .runs_before = VNET_FEATURES ("ip4-lookup"),
53 VNET_FEATURE_INIT (ip4_snat_det_in2out, static) = {
54 .arc_name = "ip4-unicast",
55 .node_name = "nat44-det-in2out",
56 .runs_before = VNET_FEATURES ("nat44-det-out2in"),
58 VNET_FEATURE_INIT (ip4_snat_det_out2in, static) = {
59 .arc_name = "ip4-unicast",
60 .node_name = "nat44-det-out2in",
61 .runs_before = VNET_FEATURES ("ip4-lookup"),
63 VNET_FEATURE_INIT (ip4_nat_det_classify, static) = {
64 .arc_name = "ip4-unicast",
65 .node_name = "nat44-det-classify",
66 .runs_before = VNET_FEATURES ("ip4-lookup"),
68 VNET_FEATURE_INIT (ip4_snat_in2out_worker_handoff, static) = {
69 .arc_name = "ip4-unicast",
70 .node_name = "nat44-in2out-worker-handoff",
71 .runs_before = VNET_FEATURES ("nat44-out2in-worker-handoff"),
73 VNET_FEATURE_INIT (ip4_snat_out2in_worker_handoff, static) = {
74 .arc_name = "ip4-unicast",
75 .node_name = "nat44-out2in-worker-handoff",
76 .runs_before = VNET_FEATURES ("ip4-lookup"),
78 VNET_FEATURE_INIT (ip4_nat_handoff_classify, static) = {
79 .arc_name = "ip4-unicast",
80 .node_name = "nat44-handoff-classify",
81 .runs_before = VNET_FEATURES ("ip4-lookup"),
83 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
84 .arc_name = "ip4-unicast",
85 .node_name = "nat44-in2out-fast",
86 .runs_before = VNET_FEATURES ("nat44-out2in-fast"),
88 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
89 .arc_name = "ip4-unicast",
90 .node_name = "nat44-out2in-fast",
91 .runs_before = VNET_FEATURES ("ip4-lookup"),
93 VNET_FEATURE_INIT (ip4_snat_hairpin_dst, static) = {
94 .arc_name = "ip4-unicast",
95 .node_name = "nat44-hairpin-dst",
96 .runs_before = VNET_FEATURES ("ip4-lookup"),
99 /* Hook up output features */
100 VNET_FEATURE_INIT (ip4_snat_in2out_output, static) = {
101 .arc_name = "ip4-output",
102 .node_name = "nat44-in2out-output",
103 .runs_before = VNET_FEATURES ("interface-output"),
105 VNET_FEATURE_INIT (ip4_snat_in2out_output_worker_handoff, static) = {
106 .arc_name = "ip4-output",
107 .node_name = "nat44-in2out-output-worker-handoff",
108 .runs_before = VNET_FEATURES ("interface-output"),
110 VNET_FEATURE_INIT (ip4_snat_hairpin_src, static) = {
111 .arc_name = "ip4-output",
112 .node_name = "nat44-hairpin-src",
113 .runs_before = VNET_FEATURES ("interface-output"),
116 /* Hook up ip4-local features */
117 VNET_FEATURE_INIT (ip4_nat_hairpinning, static) =
119 .arc_name = "ip4-local",
120 .node_name = "nat44-hairpinning",
121 .runs_before = VNET_FEATURES("ip4-local-end-of-arc"),
126 VLIB_PLUGIN_REGISTER () = {
127 .version = VPP_BUILD_VER,
128 .description = "Network Address Translation",
132 vlib_node_registration_t nat44_classify_node;
133 vlib_node_registration_t nat44_det_classify_node;
134 vlib_node_registration_t nat44_handoff_classify_node;
137 NAT44_CLASSIFY_NEXT_IN2OUT,
138 NAT44_CLASSIFY_NEXT_OUT2IN,
139 NAT44_CLASSIFY_N_NEXT,
140 } nat44_classify_next_t;
143 nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index)
145 snat_session_key_t key;
146 clib_bihash_kv_8_8_t kv;
147 nat_ed_ses_key_t ed_key;
148 clib_bihash_kv_16_8_t ed_kv;
151 snat_main_per_thread_data_t *tsm =
152 vec_elt_at_index (sm->per_thread_data, thread_index);
154 /* Endpoint dependent session lookup tables */
155 if (is_ed_session (s))
157 ed_key.l_addr = s->out2in.addr;
158 ed_key.r_addr = s->ext_host_addr;
159 ed_key.fib_index = s->out2in.fib_index;
160 if (snat_is_unk_proto_session (s))
162 ed_key.proto = s->in2out.port;
168 ed_key.proto = snat_proto_to_ip_proto (s->in2out.protocol);
169 ed_key.l_port = s->out2in.port;
170 ed_key.r_port = s->ext_host_port;
172 ed_kv.key[0] = ed_key.as_u64[0];
173 ed_kv.key[1] = ed_key.as_u64[1];
174 if (clib_bihash_add_del_16_8 (&sm->out2in_ed, &ed_kv, 0))
175 clib_warning ("out2in_ed key del failed");
177 ed_key.l_addr = s->in2out.addr;
178 ed_key.fib_index = s->in2out.fib_index;
179 if (!snat_is_unk_proto_session (s))
180 ed_key.l_port = s->in2out.port;
181 if (is_twice_nat_session (s))
183 ed_key.r_addr = s->ext_host_nat_addr;
184 ed_key.r_port = s->ext_host_nat_port;
186 ed_kv.key[0] = ed_key.as_u64[0];
187 ed_kv.key[1] = ed_key.as_u64[1];
188 if (clib_bihash_add_del_16_8 (&sm->in2out_ed, &ed_kv, 0))
189 clib_warning ("in2out_ed key del failed");
192 if (snat_is_unk_proto_session (s))
196 snat_ipfix_logging_nat44_ses_delete(s->in2out.addr.as_u32,
197 s->out2in.addr.as_u32,
201 s->in2out.fib_index);
203 /* Twice NAT address and port for external host */
204 if (is_twice_nat_session (s))
206 for (i = 0; i < vec_len (sm->twice_nat_addresses); i++)
208 key.protocol = s->in2out.protocol;
209 key.port = s->ext_host_nat_port;
210 a = sm->twice_nat_addresses + i;
211 if (a->addr.as_u32 == s->ext_host_nat_addr.as_u32)
213 snat_free_outside_address_and_port (sm->twice_nat_addresses,
214 thread_index, &key, i);
220 if (is_ed_session (s))
223 /* Session lookup tables */
224 kv.key = s->in2out.as_u64;
225 if (clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0))
226 clib_warning ("in2out key del failed");
227 kv.key = s->out2in.as_u64;
228 if (clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0))
229 clib_warning ("out2in key del failed");
231 if (snat_is_session_static (s))
234 if (s->outside_address_index != ~0)
235 snat_free_outside_address_and_port (sm->addresses, thread_index,
236 &s->out2in, s->outside_address_index);
240 nat_user_get_or_create (snat_main_t *sm, ip4_address_t *addr, u32 fib_index,
244 snat_user_key_t user_key;
245 clib_bihash_kv_8_8_t kv, value;
246 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
247 dlist_elt_t * per_user_list_head_elt;
249 user_key.addr.as_u32 = addr->as_u32;
250 user_key.fib_index = fib_index;
251 kv.key = user_key.as_u64;
253 /* Ever heard of the "user" = src ip4 address before? */
254 if (clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
256 /* no, make a new one */
257 pool_get (tsm->users, u);
258 memset (u, 0, sizeof (*u));
259 u->addr.as_u32 = addr->as_u32;
260 u->fib_index = fib_index;
262 pool_get (tsm->list_pool, per_user_list_head_elt);
264 u->sessions_per_user_list_head_index = per_user_list_head_elt -
267 clib_dlist_init (tsm->list_pool, u->sessions_per_user_list_head_index);
269 kv.value = u - tsm->users;
272 if (clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 1))
273 clib_warning ("user_hash keay add failed");
277 u = pool_elt_at_index (tsm->users, value.value);
284 nat_session_alloc_or_recycle (snat_main_t *sm, snat_user_t *u, u32 thread_index)
287 snat_main_per_thread_data_t *tsm = &sm->per_thread_data[thread_index];
288 u32 oldest_per_user_translation_list_index, session_index;
289 dlist_elt_t * oldest_per_user_translation_list_elt;
290 dlist_elt_t * per_user_translation_list_elt;
292 /* Over quota? Recycle the least recently used translation */
293 if ((u->nsessions + u->nstaticsessions) >= sm->max_translations_per_user)
295 oldest_per_user_translation_list_index =
296 clib_dlist_remove_head (tsm->list_pool,
297 u->sessions_per_user_list_head_index);
299 ASSERT (oldest_per_user_translation_list_index != ~0);
301 /* Add it back to the end of the LRU list */
302 clib_dlist_addtail (tsm->list_pool,
303 u->sessions_per_user_list_head_index,
304 oldest_per_user_translation_list_index);
305 /* Get the list element */
306 oldest_per_user_translation_list_elt =
307 pool_elt_at_index (tsm->list_pool,
308 oldest_per_user_translation_list_index);
310 /* Get the session index from the list element */
311 session_index = oldest_per_user_translation_list_elt->value;
313 /* Get the session */
314 s = pool_elt_at_index (tsm->sessions, session_index);
315 nat_free_session_data (sm, s, thread_index);
316 s->outside_address_index = ~0;
323 pool_get (tsm->sessions, s);
324 memset (s, 0, sizeof (*s));
325 s->outside_address_index = ~0;
327 /* Create list elts */
328 pool_get (tsm->list_pool, per_user_translation_list_elt);
329 clib_dlist_init (tsm->list_pool,
330 per_user_translation_list_elt - tsm->list_pool);
332 per_user_translation_list_elt->value = s - tsm->sessions;
333 s->per_user_index = per_user_translation_list_elt - tsm->list_pool;
334 s->per_user_list_head_index = u->sessions_per_user_list_head_index;
336 clib_dlist_addtail (tsm->list_pool,
337 s->per_user_list_head_index,
338 per_user_translation_list_elt - tsm->list_pool);
345 nat44_classify_node_fn_inline (vlib_main_t * vm,
346 vlib_node_runtime_t * node,
347 vlib_frame_t * frame)
349 u32 n_left_from, * from, * to_next;
350 nat44_classify_next_t next_index;
351 snat_main_t *sm = &snat_main;
353 from = vlib_frame_vector_args (frame);
354 n_left_from = frame->n_vectors;
355 next_index = node->cached_next_index;
357 while (n_left_from > 0)
361 vlib_get_next_frame (vm, node, next_index,
362 to_next, n_left_to_next);
364 while (n_left_from > 0 && n_left_to_next > 0)
368 u32 next0 = NAT44_CLASSIFY_NEXT_IN2OUT;
371 snat_session_key_t m_key0;
372 clib_bihash_kv_8_8_t kv0, value0;
374 /* speculatively enqueue b0 to the current next frame */
382 b0 = vlib_get_buffer (vm, bi0);
383 ip0 = vlib_buffer_get_current (b0);
385 vec_foreach (ap, sm->addresses)
387 if (ip0->dst_address.as_u32 == ap->addr.as_u32)
389 next0 = NAT44_CLASSIFY_NEXT_OUT2IN;
394 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
396 m_key0.addr = ip0->dst_address;
399 m_key0.fib_index = sm->outside_fib_index;
400 kv0.key = m_key0.as_u64;
401 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv0, &value0))
403 next0 = NAT44_CLASSIFY_NEXT_OUT2IN;
406 /* verify speculative enqueue, maybe switch current next frame */
407 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
408 to_next, n_left_to_next,
412 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
415 return frame->n_vectors;
419 nat44_classify_node_fn (vlib_main_t * vm,
420 vlib_node_runtime_t * node,
421 vlib_frame_t * frame)
423 return nat44_classify_node_fn_inline (vm, node, frame);
426 VLIB_REGISTER_NODE (nat44_classify_node) = {
427 .function = nat44_classify_node_fn,
428 .name = "nat44-classify",
429 .vector_size = sizeof (u32),
430 .type = VLIB_NODE_TYPE_INTERNAL,
431 .n_next_nodes = NAT44_CLASSIFY_N_NEXT,
433 [NAT44_CLASSIFY_NEXT_IN2OUT] = "nat44-in2out",
434 [NAT44_CLASSIFY_NEXT_OUT2IN] = "nat44-out2in",
438 VLIB_NODE_FUNCTION_MULTIARCH (nat44_classify_node,
439 nat44_classify_node_fn);
442 nat44_det_classify_node_fn (vlib_main_t * vm,
443 vlib_node_runtime_t * node,
444 vlib_frame_t * frame)
446 return nat44_classify_node_fn_inline (vm, node, frame);
449 VLIB_REGISTER_NODE (nat44_det_classify_node) = {
450 .function = nat44_det_classify_node_fn,
451 .name = "nat44-det-classify",
452 .vector_size = sizeof (u32),
453 .type = VLIB_NODE_TYPE_INTERNAL,
454 .n_next_nodes = NAT44_CLASSIFY_N_NEXT,
456 [NAT44_CLASSIFY_NEXT_IN2OUT] = "nat44-det-in2out",
457 [NAT44_CLASSIFY_NEXT_OUT2IN] = "nat44-det-out2in",
461 VLIB_NODE_FUNCTION_MULTIARCH (nat44_det_classify_node,
462 nat44_det_classify_node_fn);
465 nat44_handoff_classify_node_fn (vlib_main_t * vm,
466 vlib_node_runtime_t * node,
467 vlib_frame_t * frame)
469 return nat44_classify_node_fn_inline (vm, node, frame);
472 VLIB_REGISTER_NODE (nat44_handoff_classify_node) = {
473 .function = nat44_handoff_classify_node_fn,
474 .name = "nat44-handoff-classify",
475 .vector_size = sizeof (u32),
476 .type = VLIB_NODE_TYPE_INTERNAL,
477 .n_next_nodes = NAT44_CLASSIFY_N_NEXT,
479 [NAT44_CLASSIFY_NEXT_IN2OUT] = "nat44-in2out-worker-handoff",
480 [NAT44_CLASSIFY_NEXT_OUT2IN] = "nat44-out2in-worker-handoff",
484 VLIB_NODE_FUNCTION_MULTIARCH (nat44_handoff_classify_node,
485 nat44_handoff_classify_node_fn);
488 * @brief Add/del NAT address to FIB.
490 * Add the external NAT address to the FIB as receive entries. This ensures
491 * that VPP will reply to ARP for this address and we don't need to enable
492 * proxy ARP on the outside interface.
494 * @param addr IPv4 address.
495 * @param plen address prefix length
496 * @param sw_if_index Interface.
497 * @param is_add If 0 delete, otherwise add.
500 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
503 fib_prefix_t prefix = {
505 .fp_proto = FIB_PROTOCOL_IP4,
507 .ip4.as_u32 = addr->as_u32,
510 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index(sw_if_index);
513 fib_table_entry_update_one_path(fib_index,
515 FIB_SOURCE_PLUGIN_HI,
516 (FIB_ENTRY_FLAG_CONNECTED |
517 FIB_ENTRY_FLAG_LOCAL |
518 FIB_ENTRY_FLAG_EXCLUSIVE),
525 FIB_ROUTE_PATH_FLAG_NONE);
527 fib_table_entry_delete(fib_index,
529 FIB_SOURCE_PLUGIN_HI);
532 void snat_add_address (snat_main_t *sm, ip4_address_t *addr, u32 vrf_id,
537 vlib_thread_main_t *tm = vlib_get_thread_main ();
539 /* Check if address already exists */
540 vec_foreach (ap, twice_nat ? sm->twice_nat_addresses : sm->addresses)
542 if (ap->addr.as_u32 == addr->as_u32)
547 vec_add2 (sm->twice_nat_addresses, ap, 1);
549 vec_add2 (sm->addresses, ap, 1);
554 fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, vrf_id,
555 FIB_SOURCE_PLUGIN_HI);
558 #define _(N, i, n, s) \
559 clib_bitmap_alloc (ap->busy_##n##_port_bitmap, 65535); \
560 ap->busy_##n##_ports = 0; \
561 vec_validate_init_empty (ap->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
562 foreach_snat_protocol
568 /* Add external address to FIB */
569 pool_foreach (i, sm->interfaces,
571 if (nat_interface_is_inside(i) || sm->out2in_dpo)
574 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
577 pool_foreach (i, sm->output_feature_interfaces,
579 if (nat_interface_is_inside(i) || sm->out2in_dpo)
582 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
587 static int is_snat_address_used_in_static_mapping (snat_main_t *sm,
590 snat_static_mapping_t *m;
591 pool_foreach (m, sm->static_mappings,
593 if (m->external_addr.as_u32 == addr.as_u32)
600 void increment_v4_address (ip4_address_t * a)
604 v = clib_net_to_host_u32(a->as_u32) + 1;
605 a->as_u32 = clib_host_to_net_u32(v);
609 snat_add_static_mapping_when_resolved (snat_main_t * sm,
610 ip4_address_t l_addr,
615 snat_protocol_t proto,
619 snat_static_map_resolve_t *rp;
621 vec_add2 (sm->to_resolve, rp, 1);
622 rp->l_addr.as_u32 = l_addr.as_u32;
624 rp->sw_if_index = sw_if_index;
628 rp->addr_only = addr_only;
633 * @brief Add static mapping.
635 * Create static mapping between local addr+port and external addr+port.
637 * @param l_addr Local IPv4 address.
638 * @param e_addr External IPv4 address.
639 * @param l_port Local port number.
640 * @param e_port External port number.
641 * @param vrf_id VRF ID.
642 * @param addr_only If 0 address port and pair mapping, otherwise address only.
643 * @param sw_if_index External port instead of specific IP address.
644 * @param is_add If 0 delete static mapping, otherwise add.
645 * @param twice_nat If 1 translate external host address and port.
649 int snat_add_static_mapping(ip4_address_t l_addr, ip4_address_t e_addr,
650 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
651 u32 sw_if_index, snat_protocol_t proto, int is_add,
654 snat_main_t * sm = &snat_main;
655 snat_static_mapping_t *m;
656 snat_session_key_t m_key;
657 clib_bihash_kv_8_8_t kv, value;
658 snat_address_t *a = 0;
661 snat_interface_t *interface;
663 snat_main_per_thread_data_t *tsm;
665 /* If the external address is a specific interface address */
666 if (sw_if_index != ~0)
668 ip4_address_t * first_int_addr;
670 /* Might be already set... */
671 first_int_addr = ip4_interface_first_address
672 (sm->ip4_main, sw_if_index, 0 /* just want the address*/);
674 /* DHCP resolution required? */
675 if (first_int_addr == 0)
677 snat_add_static_mapping_when_resolved
678 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
684 e_addr.as_u32 = first_int_addr->as_u32;
685 /* Identity mapping? */
686 if (l_addr.as_u32 == 0)
687 l_addr.as_u32 = e_addr.as_u32;
692 m_key.port = addr_only ? 0 : e_port;
693 m_key.protocol = addr_only ? 0 : proto;
694 m_key.fib_index = sm->outside_fib_index;
695 kv.key = m_key.as_u64;
696 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
699 m = pool_elt_at_index (sm->static_mappings, value.value);
704 return VNET_API_ERROR_VALUE_EXIST;
706 if (twice_nat && addr_only)
707 return VNET_API_ERROR_UNSUPPORTED;
709 /* Convert VRF id to FIB index */
712 p = hash_get (sm->ip4_main->fib_index_by_table_id, vrf_id);
714 return VNET_API_ERROR_NO_SUCH_FIB;
717 /* If not specified use inside VRF id from SNAT plugin startup config */
720 fib_index = sm->inside_fib_index;
721 vrf_id = sm->inside_vrf_id;
724 /* Find external address in allocated addresses and reserve port for
725 address and port pair mapping when dynamic translations enabled */
726 if (!addr_only && !(sm->static_mapping_only))
728 for (i = 0; i < vec_len (sm->addresses); i++)
730 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
732 a = sm->addresses + i;
733 /* External port must be unused */
736 #define _(N, j, n, s) \
737 case SNAT_PROTOCOL_##N: \
738 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
739 return VNET_API_ERROR_INVALID_VALUE; \
740 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
743 a->busy_##n##_ports++; \
744 a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]++; \
747 foreach_snat_protocol
750 clib_warning("unknown_protocol");
751 return VNET_API_ERROR_INVALID_VALUE_2;
756 /* External address must be allocated */
758 return VNET_API_ERROR_NO_SUCH_ENTRY;
761 pool_get (sm->static_mappings, m);
762 memset (m, 0, sizeof (*m));
763 m->local_addr = l_addr;
764 m->external_addr = e_addr;
765 m->addr_only = addr_only;
767 m->fib_index = fib_index;
768 m->twice_nat = twice_nat;
771 m->local_port = l_port;
772 m->external_port = e_port;
779 .src_address = m->local_addr,
781 m->worker_index = sm->worker_in2out_cb (&ip, m->fib_index);
782 tsm = vec_elt_at_index (sm->per_thread_data, m->worker_index);
785 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
787 m_key.addr = m->local_addr;
788 m_key.port = m->local_port;
789 m_key.protocol = m->proto;
790 m_key.fib_index = m->fib_index;
791 kv.key = m_key.as_u64;
792 kv.value = m - sm->static_mappings;
793 clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 1);
796 m_key.port = clib_host_to_net_u16 (l_port);
797 kv.key = m_key.as_u64;
799 if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 1))
800 clib_warning ("in2out key add failed");
803 m_key.addr = m->external_addr;
804 m_key.port = m->external_port;
805 m_key.fib_index = sm->outside_fib_index;
806 kv.key = m_key.as_u64;
807 kv.value = m - sm->static_mappings;
808 clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 1);
811 m_key.port = clib_host_to_net_u16 (e_port);
812 kv.key = m_key.as_u64;
814 if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 1))
815 clib_warning ("out2in key add failed");
822 return VNET_API_ERROR_NO_SUCH_ENTRY;
824 /* Free external address port */
825 if (!addr_only && !(sm->static_mapping_only))
827 for (i = 0; i < vec_len (sm->addresses); i++)
829 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
831 a = sm->addresses + i;
834 #define _(N, j, n, s) \
835 case SNAT_PROTOCOL_##N: \
836 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
839 a->busy_##n##_ports--; \
840 a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]--; \
843 foreach_snat_protocol
846 clib_warning("unknown_protocol");
847 return VNET_API_ERROR_INVALID_VALUE_2;
854 if (sm->num_workers > 1)
855 tsm = vec_elt_at_index (sm->per_thread_data, m->worker_index);
857 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
859 m_key.addr = m->local_addr;
860 m_key.port = m->local_port;
861 m_key.protocol = m->proto;
862 m_key.fib_index = m->fib_index;
863 kv.key = m_key.as_u64;
864 clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0);
867 m_key.port = clib_host_to_net_u16 (m->local_port);
868 kv.key = m_key.as_u64;
870 if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 0))
871 clib_warning ("in2out key del failed");
874 m_key.addr = m->external_addr;
875 m_key.port = m->external_port;
876 m_key.fib_index = sm->outside_fib_index;
877 kv.key = m_key.as_u64;
878 clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 0);
881 m_key.port = clib_host_to_net_u16 (m->external_port);
882 kv.key = m_key.as_u64;
884 if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 0))
885 clib_warning ("in2out key del failed");
888 /* Delete session(s) for static mapping if exist */
889 if (!(sm->static_mapping_only) ||
890 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
892 snat_user_key_t u_key;
894 dlist_elt_t * head, * elt;
895 u32 elt_index, head_index;
900 u_key.addr = m->local_addr;
901 u_key.fib_index = m->fib_index;
902 kv.key = u_key.as_u64;
903 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
905 user_index = value.value;
906 u = pool_elt_at_index (tsm->users, user_index);
907 if (u->nstaticsessions)
909 head_index = u->sessions_per_user_list_head_index;
910 head = pool_elt_at_index (tsm->list_pool, head_index);
911 elt_index = head->next;
912 elt = pool_elt_at_index (tsm->list_pool, elt_index);
913 ses_index = elt->value;
914 while (ses_index != ~0)
916 s = pool_elt_at_index (tsm->sessions, ses_index);
917 elt = pool_elt_at_index (tsm->list_pool, elt->next);
918 ses_index = elt->value;
922 if ((s->out2in.addr.as_u32 != e_addr.as_u32) &&
923 (clib_net_to_host_u16 (s->out2in.port) != e_port))
927 nat_free_session_data (sm, s, tsm - sm->per_thread_data);
928 clib_dlist_remove (tsm->list_pool, s->per_user_index);
929 pool_put_index (tsm->list_pool, s->per_user_index);
930 pool_put (tsm->sessions, s);
931 u->nstaticsessions--;
938 pool_put (tsm->users, u);
939 clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 0);
945 /* Delete static mapping from pool */
946 pool_put (sm->static_mappings, m);
949 if (!addr_only || (l_addr.as_u32 == e_addr.as_u32))
952 /* Add/delete external address to FIB */
953 pool_foreach (interface, sm->interfaces,
955 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
958 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
961 pool_foreach (interface, sm->output_feature_interfaces,
963 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
966 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
973 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
974 snat_protocol_t proto, u32 vrf_id,
975 nat44_lb_addr_port_t *locals, u8 is_add,
978 snat_main_t * sm = &snat_main;
979 snat_static_mapping_t *m;
980 snat_session_key_t m_key;
981 clib_bihash_kv_8_8_t kv, value;
983 snat_address_t *a = 0;
985 nat44_lb_addr_port_t *local;
986 u32 worker_index = 0, elt_index, head_index, ses_index;
987 snat_main_per_thread_data_t *tsm;
988 snat_user_key_t u_key;
991 dlist_elt_t * head, * elt;
995 m_key.protocol = proto;
996 m_key.fib_index = sm->outside_fib_index;
997 kv.key = m_key.as_u64;
998 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
1001 m = pool_elt_at_index (sm->static_mappings, value.value);
1006 return VNET_API_ERROR_VALUE_EXIST;
1008 if (vec_len (locals) < 2)
1009 return VNET_API_ERROR_INVALID_VALUE;
1011 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
1013 FIB_SOURCE_PLUGIN_HI);
1015 /* Find external address in allocated addresses and reserve port for
1016 address and port pair mapping when dynamic translations enabled */
1017 if (!sm->static_mapping_only)
1019 for (i = 0; i < vec_len (sm->addresses); i++)
1021 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1023 a = sm->addresses + i;
1024 /* External port must be unused */
1027 #define _(N, j, n, s) \
1028 case SNAT_PROTOCOL_##N: \
1029 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
1030 return VNET_API_ERROR_INVALID_VALUE; \
1031 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
1032 if (e_port > 1024) \
1034 a->busy_##n##_ports++; \
1035 a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]++; \
1038 foreach_snat_protocol
1041 clib_warning("unknown_protocol");
1042 return VNET_API_ERROR_INVALID_VALUE_2;
1047 /* External address must be allocated */
1049 return VNET_API_ERROR_NO_SUCH_ENTRY;
1052 pool_get (sm->static_mappings, m);
1053 memset (m, 0, sizeof (*m));
1054 m->external_addr = e_addr;
1057 m->fib_index = fib_index;
1058 m->external_port = e_port;
1060 m->twice_nat = twice_nat;
1062 m_key.addr = m->external_addr;
1063 m_key.port = m->external_port;
1064 m_key.protocol = m->proto;
1065 m_key.fib_index = sm->outside_fib_index;
1066 kv.key = m_key.as_u64;
1067 kv.value = m - sm->static_mappings;
1068 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 1))
1070 clib_warning ("static_mapping_by_external key add failed");
1071 return VNET_API_ERROR_UNSPECIFIED;
1077 worker_index = sm->first_worker_index +
1078 sm->workers[sm->next_worker++ % vec_len (sm->workers)];
1079 tsm = vec_elt_at_index (sm->per_thread_data, worker_index);
1080 m->worker_index = worker_index;
1083 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1085 m_key.port = clib_host_to_net_u16 (m->external_port);
1086 kv.key = m_key.as_u64;
1088 if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 1))
1090 clib_warning ("out2in key add failed");
1091 return VNET_API_ERROR_UNSPECIFIED;
1094 m_key.fib_index = m->fib_index;
1095 for (i = 0; i < vec_len (locals); i++)
1097 m_key.addr = locals[i].addr;
1098 m_key.port = locals[i].port;
1099 kv.key = m_key.as_u64;
1100 kv.value = m - sm->static_mappings;
1101 clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 1);
1102 locals[i].prefix = (i == 0) ? locals[i].probability :\
1103 (locals[i - 1].prefix + locals[i].probability);
1104 vec_add1 (m->locals, locals[i]);
1106 m_key.port = clib_host_to_net_u16 (locals[i].port);
1107 kv.key = m_key.as_u64;
1109 if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 1))
1111 clib_warning ("in2out key add failed");
1112 return VNET_API_ERROR_UNSPECIFIED;
1119 return VNET_API_ERROR_NO_SUCH_ENTRY;
1121 fib_table_unlock (m->fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_PLUGIN_HI);
1123 /* Free external address port */
1124 if (!sm->static_mapping_only)
1126 for (i = 0; i < vec_len (sm->addresses); i++)
1128 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
1130 a = sm->addresses + i;
1133 #define _(N, j, n, s) \
1134 case SNAT_PROTOCOL_##N: \
1135 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
1136 if (e_port > 1024) \
1138 a->busy_##n##_ports--; \
1139 a->busy_##n##_ports_per_thread[(e_port - 1024) / sm->port_per_thread]--; \
1142 foreach_snat_protocol
1145 clib_warning("unknown_protocol");
1146 return VNET_API_ERROR_INVALID_VALUE_2;
1153 tsm = vec_elt_at_index (sm->per_thread_data, m->worker_index);
1154 m_key.addr = m->external_addr;
1155 m_key.port = m->external_port;
1156 m_key.protocol = m->proto;
1157 m_key.fib_index = sm->outside_fib_index;
1158 kv.key = m_key.as_u64;
1159 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 0))
1161 clib_warning ("static_mapping_by_external key del failed");
1162 return VNET_API_ERROR_UNSPECIFIED;
1165 m_key.port = clib_host_to_net_u16 (m->external_port);
1166 kv.key = m_key.as_u64;
1167 if (clib_bihash_add_del_8_8(&tsm->out2in, &kv, 0))
1169 clib_warning ("outi2in key del failed");
1170 return VNET_API_ERROR_UNSPECIFIED;
1173 vec_foreach (local, m->locals)
1175 m_key.addr = local->addr;
1176 m_key.port = local->port;
1177 m_key.fib_index = m->fib_index;
1178 kv.key = m_key.as_u64;
1179 if (clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0))
1181 clib_warning ("static_mapping_by_local key del failed");
1182 return VNET_API_ERROR_UNSPECIFIED;
1185 m_key.port = clib_host_to_net_u16 (local->port);
1186 kv.key = m_key.as_u64;
1187 if (clib_bihash_add_del_8_8(&tsm->in2out, &kv, 0))
1189 clib_warning ("in2out key del failed");
1190 return VNET_API_ERROR_UNSPECIFIED;
1192 /* Delete sessions */
1193 u_key.addr = local->addr;
1194 u_key.fib_index = m->fib_index;
1195 kv.key = u_key.as_u64;
1196 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1198 u = pool_elt_at_index (tsm->users, value.value);
1199 if (u->nstaticsessions)
1201 head_index = u->sessions_per_user_list_head_index;
1202 head = pool_elt_at_index (tsm->list_pool, head_index);
1203 elt_index = head->next;
1204 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1205 ses_index = elt->value;
1206 while (ses_index != ~0)
1208 s = pool_elt_at_index (tsm->sessions, ses_index);
1209 elt = pool_elt_at_index (tsm->list_pool, elt->next);
1210 ses_index = elt->value;
1212 if ((s->in2out.addr.as_u32 != local->addr.as_u32) &&
1213 (clib_net_to_host_u16 (s->in2out.port) != local->port))
1216 nat_free_session_data (sm, s, tsm - sm->per_thread_data);
1217 clib_dlist_remove (tsm->list_pool, s->per_user_index);
1218 pool_put_index (tsm->list_pool, s->per_user_index);
1219 pool_put (tsm->sessions, s);
1220 u->nstaticsessions--;
1225 vec_free(m->locals);
1227 pool_put (sm->static_mappings, m);
1234 snat_del_address (snat_main_t *sm, ip4_address_t addr, u8 delete_sm,
1237 snat_address_t *a = 0;
1238 snat_session_t *ses;
1239 u32 *ses_to_be_removed = 0, *ses_index;
1240 clib_bihash_kv_8_8_t kv, value;
1241 snat_user_key_t user_key;
1243 snat_main_per_thread_data_t *tsm;
1244 snat_static_mapping_t *m;
1245 snat_interface_t *interface;
1247 snat_address_t *addresses = twice_nat ? sm->twice_nat_addresses : sm->addresses;
1249 /* Find SNAT address */
1250 for (i=0; i < vec_len (addresses); i++)
1252 if (addresses[i].addr.as_u32 == addr.as_u32)
1259 return VNET_API_ERROR_NO_SUCH_ENTRY;
1263 pool_foreach (m, sm->static_mappings,
1265 if (m->external_addr.as_u32 == addr.as_u32)
1266 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
1267 m->local_port, m->external_port,
1268 m->vrf_id, m->addr_only, ~0,
1269 m->proto, 0, m->twice_nat);
1274 /* Check if address is used in some static mapping */
1275 if (is_snat_address_used_in_static_mapping(sm, addr))
1277 clib_warning ("address used in static mapping");
1278 return VNET_API_ERROR_UNSPECIFIED;
1282 if (a->fib_index != ~0)
1283 fib_table_unlock(a->fib_index, FIB_PROTOCOL_IP4,
1284 FIB_SOURCE_PLUGIN_HI);
1286 /* Delete sessions using address */
1287 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
1289 vec_foreach (tsm, sm->per_thread_data)
1291 pool_foreach (ses, tsm->sessions, ({
1292 if (ses->out2in.addr.as_u32 == addr.as_u32)
1294 ses->outside_address_index = ~0;
1295 nat_free_session_data (sm, ses, tsm - sm->per_thread_data);
1296 clib_dlist_remove (tsm->list_pool, ses->per_user_index);
1297 pool_put_index (tsm->list_pool, ses->per_user_index);
1298 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
1299 user_key.addr = ses->in2out.addr;
1300 user_key.fib_index = ses->in2out.fib_index;
1301 kv.key = user_key.as_u64;
1302 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
1304 u = pool_elt_at_index (tsm->users, value.value);
1310 vec_foreach (ses_index, ses_to_be_removed)
1311 pool_put_index (tsm->sessions, ses_index[0]);
1313 vec_free (ses_to_be_removed);
1319 vec_del1 (sm->twice_nat_addresses, i);
1323 vec_del1 (sm->addresses, i);
1325 /* Delete external address from FIB */
1326 pool_foreach (interface, sm->interfaces,
1328 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1331 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1334 pool_foreach (interface, sm->output_feature_interfaces,
1336 if (nat_interface_is_inside(interface) || sm->out2in_dpo)
1339 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
1346 int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
1348 snat_main_t *sm = &snat_main;
1349 snat_interface_t *i;
1350 const char * feature_name, *del_feature_name;
1351 snat_address_t * ap;
1352 snat_static_mapping_t * m;
1353 snat_det_map_t * dm;
1355 if (sm->out2in_dpo && !is_inside)
1356 return VNET_API_ERROR_UNSUPPORTED;
1358 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
1359 feature_name = is_inside ? "nat44-in2out-fast" : "nat44-out2in-fast";
1362 if (sm->num_workers > 1 && !sm->deterministic)
1363 feature_name = is_inside ? "nat44-in2out-worker-handoff" : "nat44-out2in-worker-handoff";
1364 else if (sm->deterministic)
1365 feature_name = is_inside ? "nat44-det-in2out" : "nat44-det-out2in";
1367 feature_name = is_inside ? "nat44-in2out" : "nat44-out2in";
1370 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1371 sm->fq_in2out_index = vlib_frame_queue_main_init (sm->in2out_node_index, 0);
1373 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
1374 sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index, 0);
1376 pool_foreach (i, sm->interfaces,
1378 if (i->sw_if_index == sw_if_index)
1382 if (nat_interface_is_inside(i) && nat_interface_is_outside(i))
1385 i->flags &= ~NAT_INTERFACE_FLAG_IS_INSIDE;
1387 i->flags &= ~NAT_INTERFACE_FLAG_IS_OUTSIDE;
1389 if (sm->num_workers > 1 && !sm->deterministic)
1390 del_feature_name = "nat44-handoff-classify";
1391 else if (sm->deterministic)
1392 del_feature_name = "nat44-det-classify";
1394 del_feature_name = "nat44-classify";
1396 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1397 sw_if_index, 0, 0, 0);
1398 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1399 sw_if_index, 1, 0, 0);
1403 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1404 sw_if_index, 0, 0, 0);
1405 pool_put (sm->interfaces, i);
1410 if ((nat_interface_is_inside(i) && is_inside) ||
1411 (nat_interface_is_outside(i) && !is_inside))
1414 if (sm->num_workers > 1 && !sm->deterministic)
1416 del_feature_name = !is_inside ? "nat44-in2out-worker-handoff" :
1417 "nat44-out2in-worker-handoff";
1418 feature_name = "nat44-handoff-classify";
1420 else if (sm->deterministic)
1422 del_feature_name = !is_inside ? "nat44-det-in2out" :
1424 feature_name = "nat44-det-classify";
1428 del_feature_name = !is_inside ? "nat44-in2out" : "nat44-out2in";
1429 feature_name = "nat44-classify";
1432 vnet_feature_enable_disable ("ip4-unicast", del_feature_name,
1433 sw_if_index, 0, 0, 0);
1434 vnet_feature_enable_disable ("ip4-unicast", feature_name,
1435 sw_if_index, 1, 0, 0);
1444 return VNET_API_ERROR_NO_SUCH_ENTRY;
1446 pool_get (sm->interfaces, i);
1447 i->sw_if_index = sw_if_index;
1449 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index, 1, 0, 0);
1453 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1455 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1457 /* Add/delete external addresses to FIB */
1459 if (is_inside && !sm->out2in_dpo)
1461 vnet_feature_enable_disable ("ip4-local", "nat44-hairpinning",
1462 sw_if_index, !is_del, 0, 0);
1466 vec_foreach (ap, sm->addresses)
1467 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1469 pool_foreach (m, sm->static_mappings,
1471 if (!(m->addr_only) || (m->local_addr.as_u32 == m->external_addr.as_u32))
1474 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1477 pool_foreach (dm, sm->det_maps,
1479 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
1485 int snat_interface_add_del_output_feature (u32 sw_if_index,
1489 snat_main_t *sm = &snat_main;
1490 snat_interface_t *i;
1491 snat_address_t * ap;
1492 snat_static_mapping_t * m;
1494 if (sm->deterministic ||
1495 (sm->static_mapping_only && !(sm->static_mapping_connection_tracking)))
1496 return VNET_API_ERROR_UNSUPPORTED;
1500 vnet_feature_enable_disable ("ip4-unicast", "nat44-hairpin-dst",
1501 sw_if_index, !is_del, 0, 0);
1502 vnet_feature_enable_disable ("ip4-output", "nat44-hairpin-src",
1503 sw_if_index, !is_del, 0, 0);
1507 if (sm->num_workers > 1)
1509 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in-worker-handoff",
1510 sw_if_index, !is_del, 0, 0);
1511 vnet_feature_enable_disable ("ip4-output",
1512 "nat44-in2out-output-worker-handoff",
1513 sw_if_index, !is_del, 0, 0);
1517 vnet_feature_enable_disable ("ip4-unicast", "nat44-out2in", sw_if_index,
1519 vnet_feature_enable_disable ("ip4-output", "nat44-in2out-output",
1520 sw_if_index, !is_del, 0, 0);
1524 if (sm->fq_in2out_output_index == ~0 && sm->num_workers > 1)
1525 sm->fq_in2out_output_index =
1526 vlib_frame_queue_main_init (sm->in2out_output_node_index, 0);
1528 if (sm->fq_out2in_index == ~0 && sm->num_workers > 1)
1529 sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index, 0);
1531 pool_foreach (i, sm->output_feature_interfaces,
1533 if (i->sw_if_index == sw_if_index)
1536 pool_put (sm->output_feature_interfaces, i);
1538 return VNET_API_ERROR_VALUE_EXIST;
1545 return VNET_API_ERROR_NO_SUCH_ENTRY;
1547 pool_get (sm->output_feature_interfaces, i);
1548 i->sw_if_index = sw_if_index;
1551 i->flags |= NAT_INTERFACE_FLAG_IS_INSIDE;
1553 i->flags |= NAT_INTERFACE_FLAG_IS_OUTSIDE;
1555 /* Add/delete external addresses to FIB */
1560 vec_foreach (ap, sm->addresses)
1561 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
1563 pool_foreach (m, sm->static_mappings,
1565 if (!(m->addr_only))
1568 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
1574 int snat_set_workers (uword * bitmap)
1576 snat_main_t *sm = &snat_main;
1579 if (sm->num_workers < 2)
1580 return VNET_API_ERROR_FEATURE_DISABLED;
1582 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
1583 return VNET_API_ERROR_INVALID_WORKER;
1585 vec_free (sm->workers);
1586 clib_bitmap_foreach (i, bitmap,
1588 vec_add1(sm->workers, i);
1589 sm->per_thread_data[sm->first_worker_index + i].snat_thread_index = j;
1593 sm->port_per_thread = (0xffff - 1024) / _vec_len (sm->workers);
1594 sm->num_snat_thread = _vec_len (sm->workers);
1601 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
1604 ip4_address_t * address,
1606 u32 if_address_index,
1610 nat_alloc_addr_and_port_default (snat_address_t * addresses,
1613 snat_session_key_t * k,
1614 u32 * address_indexp,
1615 u16 port_per_thread,
1616 u32 snat_thread_index);
1618 static clib_error_t * snat_init (vlib_main_t * vm)
1620 snat_main_t * sm = &snat_main;
1621 clib_error_t * error = 0;
1622 ip4_main_t * im = &ip4_main;
1623 ip_lookup_main_t * lm = &im->lookup_main;
1625 vlib_thread_registration_t *tr;
1626 vlib_thread_main_t *tm = vlib_get_thread_main ();
1629 ip4_add_del_interface_address_callback_t cb4;
1632 sm->vnet_main = vnet_get_main();
1634 sm->ip4_lookup_main = lm;
1635 sm->api_main = &api_main;
1636 sm->first_worker_index = 0;
1637 sm->next_worker = 0;
1638 sm->num_workers = 0;
1639 sm->num_snat_thread = 1;
1641 sm->port_per_thread = 0xffff - 1024;
1642 sm->fq_in2out_index = ~0;
1643 sm->fq_out2in_index = ~0;
1644 sm->udp_timeout = SNAT_UDP_TIMEOUT;
1645 sm->tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
1646 sm->tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
1647 sm->icmp_timeout = SNAT_ICMP_TIMEOUT;
1648 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
1649 sm->forwarding_enabled = 0;
1651 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1654 tr = (vlib_thread_registration_t *) p[0];
1657 sm->num_workers = tr->count;
1658 sm->first_worker_index = tr->first_index;
1662 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
1664 /* Use all available workers by default */
1665 if (sm->num_workers > 1)
1667 for (i=0; i < sm->num_workers; i++)
1668 bitmap = clib_bitmap_set (bitmap, i, 1);
1669 snat_set_workers(bitmap);
1670 clib_bitmap_free (bitmap);
1674 sm->per_thread_data[0].snat_thread_index = 0;
1677 error = snat_api_init(vm, sm);
1681 /* Set up the interface address add/del callback */
1682 cb4.function = snat_ip4_add_del_interface_address_cb;
1683 cb4.function_opaque = 0;
1685 vec_add1 (im->add_del_interface_address_callbacks, cb4);
1687 nat_dpo_module_init ();
1689 /* Init IPFIX logging */
1690 snat_ipfix_logging_init(vm);
1693 error = nat64_init(vm);
1699 /* Init virtual fragmenentation reassembly */
1700 return nat_reass_init(vm);
1703 VLIB_INIT_FUNCTION (snat_init);
1705 void snat_free_outside_address_and_port (snat_address_t * addresses,
1707 snat_session_key_t * k,
1711 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
1713 ASSERT (address_index < vec_len (addresses));
1715 a = addresses + address_index;
1717 switch (k->protocol)
1719 #define _(N, i, n, s) \
1720 case SNAT_PROTOCOL_##N: \
1721 ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
1722 port_host_byte_order) == 1); \
1723 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
1724 port_host_byte_order, 0); \
1725 a->busy_##n##_ports--; \
1726 a->busy_##n##_ports_per_thread[thread_index]--; \
1728 foreach_snat_protocol
1731 clib_warning("unknown_protocol");
1737 * @brief Match NAT44 static mapping.
1739 * @param sm NAT main.
1740 * @param match Address and port to match.
1741 * @param mapping External or local address and port of the matched mapping.
1742 * @param by_external If 0 match by local address otherwise match by external
1744 * @param is_addr_only If matched mapping is address only
1745 * @param twice_nat If matched mapping is twice NAT.
1747 * @returns 0 if match found otherwise 1.
1749 int snat_static_mapping_match (snat_main_t * sm,
1750 snat_session_key_t match,
1751 snat_session_key_t * mapping,
1756 clib_bihash_kv_8_8_t kv, value;
1757 snat_static_mapping_t *m;
1758 snat_session_key_t m_key;
1759 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
1760 u32 rand, lo = 0, hi, mid;
1763 mapping_hash = &sm->static_mapping_by_external;
1765 m_key.addr = match.addr;
1766 m_key.port = clib_net_to_host_u16 (match.port);
1767 m_key.protocol = match.protocol;
1768 m_key.fib_index = match.fib_index;
1770 kv.key = m_key.as_u64;
1772 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
1774 /* Try address only mapping */
1777 kv.key = m_key.as_u64;
1778 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
1782 m = pool_elt_at_index (sm->static_mappings, value.value);
1786 if (vec_len (m->locals))
1788 hi = vec_len (m->locals) - 1;
1789 rand = 1 + (random_u32 (&sm->random_seed) % m->locals[hi].prefix);
1792 mid = ((hi - lo) >> 1) + lo;
1793 (rand > m->locals[mid].prefix) ? (lo = mid + 1) : (hi = mid);
1795 if (!(m->locals[lo].prefix >= rand))
1797 mapping->addr = m->locals[lo].addr;
1798 mapping->port = clib_host_to_net_u16 (m->locals[lo].port);
1802 mapping->addr = m->local_addr;
1803 /* Address only mapping doesn't change port */
1804 mapping->port = m->addr_only ? match.port
1805 : clib_host_to_net_u16 (m->local_port);
1807 mapping->fib_index = m->fib_index;
1808 mapping->protocol = m->proto;
1812 mapping->addr = m->external_addr;
1813 /* Address only mapping doesn't change port */
1814 mapping->port = m->addr_only ? match.port
1815 : clib_host_to_net_u16 (m->external_port);
1816 mapping->fib_index = sm->outside_fib_index;
1819 if (PREDICT_FALSE(is_addr_only != 0))
1820 *is_addr_only = m->addr_only;
1822 if (PREDICT_FALSE(twice_nat != 0))
1823 *twice_nat = m->twice_nat;
1828 static_always_inline u16
1829 snat_random_port (u16 min, u16 max)
1831 snat_main_t *sm = &snat_main;
1832 return min + random_u32 (&sm->random_seed) /
1833 (random_u32_max() / (max - min + 1) + 1);
1837 snat_alloc_outside_address_and_port (snat_address_t * addresses,
1840 snat_session_key_t * k,
1841 u32 * address_indexp,
1842 u16 port_per_thread,
1843 u32 snat_thread_index)
1845 snat_main_t *sm = &snat_main;
1847 return sm->alloc_addr_and_port(addresses, fib_index, thread_index, k,
1848 address_indexp, port_per_thread,
1853 nat_alloc_addr_and_port_default (snat_address_t * addresses,
1856 snat_session_key_t * k,
1857 u32 * address_indexp,
1858 u16 port_per_thread,
1859 u32 snat_thread_index)
1862 snat_address_t *a, *ga = 0;
1865 for (i = 0; i < vec_len (addresses); i++)
1868 switch (k->protocol)
1870 #define _(N, j, n, s) \
1871 case SNAT_PROTOCOL_##N: \
1872 if (a->busy_##n##_ports_per_thread[thread_index] < port_per_thread) \
1874 if (a->fib_index == fib_index) \
1878 portnum = (port_per_thread * \
1879 snat_thread_index) + \
1880 snat_random_port(1, port_per_thread) + 1024; \
1881 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
1883 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
1884 a->busy_##n##_ports_per_thread[thread_index]++; \
1885 a->busy_##n##_ports++; \
1886 k->addr = a->addr; \
1887 k->port = clib_host_to_net_u16(portnum); \
1888 *address_indexp = i; \
1892 else if (a->fib_index == ~0) \
1899 foreach_snat_protocol
1902 clib_warning("unknown protocol");
1911 switch (k->protocol)
1913 #define _(N, j, n, s) \
1914 case SNAT_PROTOCOL_##N: \
1917 portnum = (port_per_thread * \
1918 snat_thread_index) + \
1919 snat_random_port(1, port_per_thread) + 1024; \
1920 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
1922 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
1923 a->busy_##n##_ports_per_thread[thread_index]++; \
1924 a->busy_##n##_ports++; \
1925 k->addr = a->addr; \
1926 k->port = clib_host_to_net_u16(portnum); \
1927 *address_indexp = gi; \
1931 foreach_snat_protocol
1934 clib_warning ("unknown protocol");
1939 /* Totally out of translations to use... */
1940 snat_ipfix_logging_addresses_exhausted(0);
1945 nat_alloc_addr_and_port_mape (snat_address_t * addresses,
1948 snat_session_key_t * k,
1949 u32 * address_indexp,
1950 u16 port_per_thread,
1951 u32 snat_thread_index)
1953 snat_main_t *sm = &snat_main;
1954 snat_address_t *a = addresses;
1955 u16 m, ports, portnum, A, j;
1956 m = 16 - (sm->psid_offset + sm->psid_length);
1957 ports = (1 << (16 - sm->psid_length)) - (1 << m);
1959 if (!vec_len (addresses))
1962 switch (k->protocol)
1964 #define _(N, i, n, s) \
1965 case SNAT_PROTOCOL_##N: \
1966 if (a->busy_##n##_ports < ports) \
1970 A = snat_random_port(1, pow2_mask(sm->psid_offset)); \
1971 j = snat_random_port(0, pow2_mask(m)); \
1972 portnum = A | (sm->psid << sm->psid_offset) | (j << (16 - m)); \
1973 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
1975 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
1976 a->busy_##n##_ports++; \
1977 k->addr = a->addr; \
1978 k->port = clib_host_to_net_u16 (portnum); \
1979 *address_indexp = i; \
1984 foreach_snat_protocol
1987 clib_warning("unknown protocol");
1992 /* Totally out of translations to use... */
1993 snat_ipfix_logging_addresses_exhausted(0);
1998 nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add)
2000 dpo_id_t dpo_v4 = DPO_INVALID;
2001 fib_prefix_t pfx = {
2002 .fp_proto = FIB_PROTOCOL_IP4,
2004 .fp_addr.ip4.as_u32 = addr.as_u32,
2009 nat_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
2010 fib_table_entry_special_dpo_add (0, &pfx, FIB_SOURCE_PLUGIN_HI,
2011 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
2012 dpo_reset (&dpo_v4);
2016 fib_table_entry_special_remove (0, &pfx, FIB_SOURCE_PLUGIN_HI);
2020 static clib_error_t *
2021 add_address_command_fn (vlib_main_t * vm,
2022 unformat_input_t * input,
2023 vlib_cli_command_t * cmd)
2025 unformat_input_t _line_input, *line_input = &_line_input;
2026 snat_main_t * sm = &snat_main;
2027 ip4_address_t start_addr, end_addr, this_addr;
2028 u32 start_host_order, end_host_order;
2033 clib_error_t *error = 0;
2036 /* Get a line of input. */
2037 if (!unformat_user (input, unformat_line_input, line_input))
2040 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2042 if (unformat (line_input, "%U - %U",
2043 unformat_ip4_address, &start_addr,
2044 unformat_ip4_address, &end_addr))
2046 else if (unformat (line_input, "tenant-vrf %u", &vrf_id))
2048 else if (unformat (line_input, "%U", unformat_ip4_address, &start_addr))
2049 end_addr = start_addr;
2050 else if (unformat (line_input, "twice-nat"))
2052 else if (unformat (line_input, "del"))
2056 error = clib_error_return (0, "unknown input '%U'",
2057 format_unformat_error, line_input);
2062 if (sm->static_mapping_only)
2064 error = clib_error_return (0, "static mapping only mode");
2068 start_host_order = clib_host_to_net_u32 (start_addr.as_u32);
2069 end_host_order = clib_host_to_net_u32 (end_addr.as_u32);
2071 if (end_host_order < start_host_order)
2073 error = clib_error_return (0, "end address less than start address");
2077 count = (end_host_order - start_host_order) + 1;
2080 clib_warning ("%U - %U, %d addresses...",
2081 format_ip4_address, &start_addr,
2082 format_ip4_address, &end_addr,
2085 this_addr = start_addr;
2087 for (i = 0; i < count; i++)
2090 snat_add_address (sm, &this_addr, vrf_id, twice_nat);
2092 rv = snat_del_address (sm, this_addr, 0, twice_nat);
2096 case VNET_API_ERROR_NO_SUCH_ENTRY:
2097 error = clib_error_return (0, "S-NAT address not exist.");
2099 case VNET_API_ERROR_UNSPECIFIED:
2100 error = clib_error_return (0, "S-NAT address used in static mapping.");
2107 nat44_add_del_address_dpo (this_addr, is_add);
2109 increment_v4_address (&this_addr);
2113 unformat_free (line_input);
2118 VLIB_CLI_COMMAND (add_address_command, static) = {
2119 .path = "nat44 add address",
2120 .short_help = "nat44 add address <ip4-range-start> [- <ip4-range-end>] "
2121 "[tenant-vrf <vrf-id>] [twice-nat] [del]",
2122 .function = add_address_command_fn,
2125 static clib_error_t *
2126 snat_feature_command_fn (vlib_main_t * vm,
2127 unformat_input_t * input,
2128 vlib_cli_command_t * cmd)
2130 unformat_input_t _line_input, *line_input = &_line_input;
2131 vnet_main_t * vnm = vnet_get_main();
2132 clib_error_t * error = 0;
2134 u32 * inside_sw_if_indices = 0;
2135 u32 * outside_sw_if_indices = 0;
2136 u8 is_output_feature = 0;
2142 /* Get a line of input. */
2143 if (!unformat_user (input, unformat_line_input, line_input))
2146 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2148 if (unformat (line_input, "in %U", unformat_vnet_sw_interface,
2150 vec_add1 (inside_sw_if_indices, sw_if_index);
2151 else if (unformat (line_input, "out %U", unformat_vnet_sw_interface,
2153 vec_add1 (outside_sw_if_indices, sw_if_index);
2154 else if (unformat (line_input, "output-feature"))
2155 is_output_feature = 1;
2156 else if (unformat (line_input, "del"))
2160 error = clib_error_return (0, "unknown input '%U'",
2161 format_unformat_error, line_input);
2166 if (vec_len (inside_sw_if_indices))
2168 for (i = 0; i < vec_len(inside_sw_if_indices); i++)
2170 sw_if_index = inside_sw_if_indices[i];
2171 if (is_output_feature)
2173 if (snat_interface_add_del_output_feature (sw_if_index, 1, is_del))
2175 error = clib_error_return (0, "%s %U failed",
2176 is_del ? "del" : "add",
2177 format_vnet_sw_interface_name, vnm,
2178 vnet_get_sw_interface (vnm,
2185 if (snat_interface_add_del (sw_if_index, 1, is_del))
2187 error = clib_error_return (0, "%s %U failed",
2188 is_del ? "del" : "add",
2189 format_vnet_sw_interface_name, vnm,
2190 vnet_get_sw_interface (vnm,
2198 if (vec_len (outside_sw_if_indices))
2200 for (i = 0; i < vec_len(outside_sw_if_indices); i++)
2202 sw_if_index = outside_sw_if_indices[i];
2203 if (is_output_feature)
2205 if (snat_interface_add_del_output_feature (sw_if_index, 0, is_del))
2207 error = clib_error_return (0, "%s %U failed",
2208 is_del ? "del" : "add",
2209 format_vnet_sw_interface_name, vnm,
2210 vnet_get_sw_interface (vnm,
2217 if (snat_interface_add_del (sw_if_index, 0, is_del))
2219 error = clib_error_return (0, "%s %U failed",
2220 is_del ? "del" : "add",
2221 format_vnet_sw_interface_name, vnm,
2222 vnet_get_sw_interface (vnm,
2231 unformat_free (line_input);
2232 vec_free (inside_sw_if_indices);
2233 vec_free (outside_sw_if_indices);
2238 VLIB_CLI_COMMAND (set_interface_snat_command, static) = {
2239 .path = "set interface nat44",
2240 .function = snat_feature_command_fn,
2241 .short_help = "set interface nat44 in <intfc> out <intfc> [output-feature] "
2246 unformat_snat_protocol (unformat_input_t * input, va_list * args)
2248 u32 *r = va_arg (*args, u32 *);
2251 #define _(N, i, n, s) else if (unformat (input, s)) *r = SNAT_PROTOCOL_##N;
2252 foreach_snat_protocol
2260 format_snat_protocol (u8 * s, va_list * args)
2262 u32 i = va_arg (*args, u32);
2267 #define _(N, j, n, str) case SNAT_PROTOCOL_##N: t = (u8 *) str; break;
2268 foreach_snat_protocol
2271 s = format (s, "unknown");
2274 s = format (s, "%s", t);
2278 static clib_error_t *
2279 add_static_mapping_command_fn (vlib_main_t * vm,
2280 unformat_input_t * input,
2281 vlib_cli_command_t * cmd)
2283 unformat_input_t _line_input, *line_input = &_line_input;
2284 clib_error_t * error = 0;
2285 ip4_address_t l_addr, e_addr;
2286 u32 l_port = 0, e_port = 0, vrf_id = ~0;
2289 u32 sw_if_index = ~0;
2290 vnet_main_t * vnm = vnet_get_main();
2292 snat_protocol_t proto = ~0;
2296 /* Get a line of input. */
2297 if (!unformat_user (input, unformat_line_input, line_input))
2300 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2302 if (unformat (line_input, "local %U %u", unformat_ip4_address, &l_addr,
2305 else if (unformat (line_input, "local %U", unformat_ip4_address, &l_addr))
2307 else if (unformat (line_input, "external %U %u", unformat_ip4_address,
2310 else if (unformat (line_input, "external %U", unformat_ip4_address,
2313 else if (unformat (line_input, "external %U %u",
2314 unformat_vnet_sw_interface, vnm, &sw_if_index,
2318 else if (unformat (line_input, "external %U",
2319 unformat_vnet_sw_interface, vnm, &sw_if_index))
2321 else if (unformat (line_input, "vrf %u", &vrf_id))
2323 else if (unformat (line_input, "%U", unformat_snat_protocol, &proto))
2325 else if (unformat (line_input, "twice-nat"))
2327 else if (unformat (line_input, "del"))
2331 error = clib_error_return (0, "unknown input: '%U'",
2332 format_unformat_error, line_input);
2337 if (twice_nat && addr_only)
2339 error = clib_error_return (0, "twice NAT only for 1:1 NAPT");
2343 if (!addr_only && !proto_set)
2345 error = clib_error_return (0, "missing protocol");
2349 rv = snat_add_static_mapping(l_addr, e_addr, (u16) l_port, (u16) e_port,
2350 vrf_id, addr_only, sw_if_index, proto, is_add,
2355 case VNET_API_ERROR_INVALID_VALUE:
2356 error = clib_error_return (0, "External port already in use.");
2358 case VNET_API_ERROR_NO_SUCH_ENTRY:
2360 error = clib_error_return (0, "External addres must be allocated.");
2362 error = clib_error_return (0, "Mapping not exist.");
2364 case VNET_API_ERROR_NO_SUCH_FIB:
2365 error = clib_error_return (0, "No such VRF id.");
2367 case VNET_API_ERROR_VALUE_EXIST:
2368 error = clib_error_return (0, "Mapping already exist.");
2375 unformat_free (line_input);
2382 * @cliexstart{snat add static mapping}
2383 * Static mapping allows hosts on the external network to initiate connection
2384 * to to the local network host.
2385 * To create static mapping between local host address 10.0.0.3 port 6303 and
2386 * external address 4.4.4.4 port 3606 for TCP protocol use:
2387 * vpp# nat44 add static mapping tcp local 10.0.0.3 6303 external 4.4.4.4 3606
2388 * If not runnig "static mapping only" NAT plugin mode use before:
2389 * vpp# nat44 add address 4.4.4.4
2390 * To create static mapping between local and external address use:
2391 * vpp# nat44 add static mapping local 10.0.0.3 external 4.4.4.4
2394 VLIB_CLI_COMMAND (add_static_mapping_command, static) = {
2395 .path = "nat44 add static mapping",
2396 .function = add_static_mapping_command_fn,
2398 "nat44 add static mapping tcp|udp|icmp local <addr> [<port>] "
2399 "external <addr> [<port>] [vrf <table-id>] [twice-nat] [del]",
2402 static clib_error_t *
2403 add_identity_mapping_command_fn (vlib_main_t * vm,
2404 unformat_input_t * input,
2405 vlib_cli_command_t * cmd)
2407 unformat_input_t _line_input, *line_input = &_line_input;
2408 clib_error_t * error = 0;
2410 u32 port = 0, vrf_id = ~0;
2413 u32 sw_if_index = ~0;
2414 vnet_main_t * vnm = vnet_get_main();
2416 snat_protocol_t proto;
2420 /* Get a line of input. */
2421 if (!unformat_user (input, unformat_line_input, line_input))
2424 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2426 if (unformat (line_input, "%U", unformat_ip4_address, &addr))
2428 else if (unformat (line_input, "external %U",
2429 unformat_vnet_sw_interface, vnm, &sw_if_index))
2431 else if (unformat (line_input, "vrf %u", &vrf_id))
2433 else if (unformat (line_input, "%U %u", unformat_snat_protocol, &proto,
2436 else if (unformat (line_input, "del"))
2440 error = clib_error_return (0, "unknown input: '%U'",
2441 format_unformat_error, line_input);
2446 rv = snat_add_static_mapping(addr, addr, (u16) port, (u16) port,
2447 vrf_id, addr_only, sw_if_index, proto, is_add,
2452 case VNET_API_ERROR_INVALID_VALUE:
2453 error = clib_error_return (0, "External port already in use.");
2455 case VNET_API_ERROR_NO_SUCH_ENTRY:
2457 error = clib_error_return (0, "External addres must be allocated.");
2459 error = clib_error_return (0, "Mapping not exist.");
2461 case VNET_API_ERROR_NO_SUCH_FIB:
2462 error = clib_error_return (0, "No such VRF id.");
2464 case VNET_API_ERROR_VALUE_EXIST:
2465 error = clib_error_return (0, "Mapping already exist.");
2472 unformat_free (line_input);
2479 * @cliexstart{snat add identity mapping}
2480 * Identity mapping translate an IP address to itself.
2481 * To create identity mapping for address 10.0.0.3 port 6303 for TCP protocol
2483 * vpp# nat44 add identity mapping 10.0.0.3 tcp 6303
2484 * To create identity mapping for address 10.0.0.3 use:
2485 * vpp# nat44 add identity mapping 10.0.0.3
2486 * To create identity mapping for DHCP addressed interface use:
2487 * vpp# nat44 add identity mapping GigabitEthernet0/a/0 tcp 3606
2490 VLIB_CLI_COMMAND (add_identity_mapping_command, static) = {
2491 .path = "nat44 add identity mapping",
2492 .function = add_identity_mapping_command_fn,
2493 .short_help = "nat44 add identity mapping <interface>|<ip4-addr> "
2494 "[<protocol> <port>] [vrf <table-id>] [del]",
2497 static clib_error_t *
2498 add_lb_static_mapping_command_fn (vlib_main_t * vm,
2499 unformat_input_t * input,
2500 vlib_cli_command_t * cmd)
2502 unformat_input_t _line_input, *line_input = &_line_input;
2503 clib_error_t * error = 0;
2504 ip4_address_t l_addr, e_addr;
2505 u32 l_port = 0, e_port = 0, vrf_id = 0, probability = 0;
2508 snat_protocol_t proto;
2510 nat44_lb_addr_port_t *locals = 0, local;
2513 /* Get a line of input. */
2514 if (!unformat_user (input, unformat_line_input, line_input))
2517 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2519 if (unformat (line_input, "local %U:%u probability %u",
2520 unformat_ip4_address, &l_addr, &l_port, &probability))
2522 memset (&local, 0, sizeof (local));
2523 local.addr = l_addr;
2524 local.port = (u16) l_port;
2525 local.probability = (u8) probability;
2526 vec_add1 (locals, local);
2528 else if (unformat (line_input, "external %U:%u", unformat_ip4_address,
2531 else if (unformat (line_input, "vrf %u", &vrf_id))
2533 else if (unformat (line_input, "protocol %U", unformat_snat_protocol,
2536 else if (unformat (line_input, "twice-nat"))
2538 else if (unformat (line_input, "del"))
2542 error = clib_error_return (0, "unknown input: '%U'",
2543 format_unformat_error, line_input);
2548 if (vec_len (locals) < 2)
2550 error = clib_error_return (0, "at least two local must be set");
2556 error = clib_error_return (0, "missing protocol");
2560 rv = nat44_add_del_lb_static_mapping (e_addr, (u16) e_port, proto, vrf_id,
2561 locals, is_add, twice_nat);
2565 case VNET_API_ERROR_INVALID_VALUE:
2566 error = clib_error_return (0, "External port already in use.");
2568 case VNET_API_ERROR_NO_SUCH_ENTRY:
2570 error = clib_error_return (0, "External addres must be allocated.");
2572 error = clib_error_return (0, "Mapping not exist.");
2574 case VNET_API_ERROR_VALUE_EXIST:
2575 error = clib_error_return (0, "Mapping already exist.");
2582 unformat_free (line_input);
2588 VLIB_CLI_COMMAND (add_lb_static_mapping_command, static) = {
2589 .path = "nat44 add load-balancing static mapping",
2590 .function = add_lb_static_mapping_command_fn,
2592 "nat44 add load-balancing static mapping protocol tcp|udp "
2593 "external <addr>:<port> local <addr>:<port> probability <n> [twice-nat] "
2594 "[vrf <table-id>] [del]",
2597 static clib_error_t *
2598 set_workers_command_fn (vlib_main_t * vm,
2599 unformat_input_t * input,
2600 vlib_cli_command_t * cmd)
2602 unformat_input_t _line_input, *line_input = &_line_input;
2605 clib_error_t *error = 0;
2607 /* Get a line of input. */
2608 if (!unformat_user (input, unformat_line_input, line_input))
2611 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2613 if (unformat (line_input, "%U", unformat_bitmap_list, &bitmap))
2617 error = clib_error_return (0, "unknown input '%U'",
2618 format_unformat_error, line_input);
2625 error = clib_error_return (0, "List of workers must be specified.");
2629 rv = snat_set_workers(bitmap);
2631 clib_bitmap_free (bitmap);
2635 case VNET_API_ERROR_INVALID_WORKER:
2636 error = clib_error_return (0, "Invalid worker(s).");
2638 case VNET_API_ERROR_FEATURE_DISABLED:
2639 error = clib_error_return (0,
2640 "Supported only if 2 or more workes available.");
2647 unformat_free (line_input);
2654 * @cliexstart{set snat workers}
2655 * Set NAT workers if 2 or more workers available, use:
2656 * vpp# set snat workers 0-2,5
2659 VLIB_CLI_COMMAND (set_workers_command, static) = {
2660 .path = "set nat workers",
2661 .function = set_workers_command_fn,
2663 "set nat workers <workers-list>",
2666 static clib_error_t *
2667 snat_ipfix_logging_enable_disable_command_fn (vlib_main_t * vm,
2668 unformat_input_t * input,
2669 vlib_cli_command_t * cmd)
2671 unformat_input_t _line_input, *line_input = &_line_input;
2676 clib_error_t *error = 0;
2678 /* Get a line of input. */
2679 if (!unformat_user (input, unformat_line_input, line_input))
2682 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2684 if (unformat (line_input, "domain %d", &domain_id))
2686 else if (unformat (line_input, "src-port %d", &src_port))
2688 else if (unformat (line_input, "disable"))
2692 error = clib_error_return (0, "unknown input '%U'",
2693 format_unformat_error, line_input);
2698 rv = snat_ipfix_logging_enable_disable (enable, domain_id, (u16) src_port);
2702 error = clib_error_return (0, "ipfix logging enable failed");
2707 unformat_free (line_input);
2714 * @cliexstart{snat ipfix logging}
2715 * To enable NAT IPFIX logging use:
2716 * vpp# nat ipfix logging
2717 * To set IPFIX exporter use:
2718 * vpp# set ipfix exporter collector 10.10.10.3 src 10.10.10.1
2721 VLIB_CLI_COMMAND (snat_ipfix_logging_enable_disable_command, static) = {
2722 .path = "nat ipfix logging",
2723 .function = snat_ipfix_logging_enable_disable_command_fn,
2724 .short_help = "nat ipfix logging [domain <domain-id>] [src-port <port>] [disable]",
2728 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2730 snat_main_t *sm = &snat_main;
2731 u32 next_worker_index = 0;
2734 next_worker_index = sm->first_worker_index;
2735 hash = ip0->src_address.as_u32 + (ip0->src_address.as_u32 >> 8) +
2736 (ip0->src_address.as_u32 >> 16) + (ip0->src_address.as_u32 >>24);
2738 if (PREDICT_TRUE (is_pow2 (_vec_len (sm->workers))))
2739 next_worker_index += sm->workers[hash & (_vec_len (sm->workers) - 1)];
2741 next_worker_index += sm->workers[hash % _vec_len (sm->workers)];
2743 return next_worker_index;
2747 snat_get_worker_out2in_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2749 snat_main_t *sm = &snat_main;
2752 snat_session_key_t m_key;
2753 clib_bihash_kv_8_8_t kv, value;
2754 snat_static_mapping_t *m;
2755 nat_ed_ses_key_t key;
2756 clib_bihash_kv_16_8_t s_kv, s_value;
2757 snat_main_per_thread_data_t *tsm;
2761 u32 next_worker_index = 0;
2763 /* first try static mappings without port */
2764 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2766 m_key.addr = ip0->dst_address;
2769 m_key.fib_index = rx_fib_index0;
2770 kv.key = m_key.as_u64;
2771 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
2773 m = pool_elt_at_index (sm->static_mappings, value.value);
2774 return m->worker_index;
2778 proto = ip_proto_to_snat_proto (ip0->protocol);
2779 udp = ip4_next_header (ip0);
2780 port = udp->dst_port;
2782 if (PREDICT_FALSE (ip4_is_fragment (ip0)))
2784 if (PREDICT_FALSE (nat_reass_is_drop_frag (0)))
2785 return vlib_get_thread_index ();
2787 if (PREDICT_TRUE (!ip4_is_first_fragment (ip0)))
2789 nat_reass_ip4_t *reass;
2791 reass = nat_ip4_reass_find (ip0->src_address, ip0->dst_address,
2792 ip0->fragment_id, ip0->protocol);
2794 if (reass && (reass->thread_index != (u32) ~ 0))
2795 return reass->thread_index;
2797 return vlib_get_thread_index ();
2801 /* unknown protocol */
2802 if (PREDICT_FALSE (proto == ~0))
2804 key.l_addr = ip0->dst_address;
2805 key.r_addr = ip0->src_address;
2806 key.fib_index = rx_fib_index0;
2807 key.proto = ip0->protocol;
2810 s_kv.key[0] = key.as_u64[0];
2811 s_kv.key[1] = key.as_u64[1];
2813 if (!clib_bihash_search_16_8 (&sm->out2in_ed, &s_kv, &s_value))
2815 for (i = 0; i < _vec_len (sm->per_thread_data); i++)
2817 tsm = vec_elt_at_index (sm->per_thread_data, i);
2818 if (!pool_is_free_index(tsm->sessions, s_value.value))
2820 s = pool_elt_at_index (tsm->sessions, s_value.value);
2821 if (s->out2in.addr.as_u32 == ip0->dst_address.as_u32 &&
2822 s->out2in.port == ip0->protocol &&
2823 snat_is_unk_proto_session (s))
2829 /* if no session use current thread */
2830 return vlib_get_thread_index ();
2833 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_ICMP))
2835 icmp46_header_t * icmp = (icmp46_header_t *) udp;
2836 icmp_echo_header_t *echo = (icmp_echo_header_t *)(icmp + 1);
2837 if (!icmp_is_error_message (icmp))
2838 port = echo->identifier;
2841 ip4_header_t *inner_ip = (ip4_header_t *)(echo + 1);
2842 proto = ip_proto_to_snat_proto (inner_ip->protocol);
2843 void *l4_header = ip4_next_header (inner_ip);
2846 case SNAT_PROTOCOL_ICMP:
2847 icmp = (icmp46_header_t*)l4_header;
2848 echo = (icmp_echo_header_t *)(icmp + 1);
2849 port = echo->identifier;
2851 case SNAT_PROTOCOL_UDP:
2852 case SNAT_PROTOCOL_TCP:
2853 port = ((tcp_udp_header_t*)l4_header)->src_port;
2856 return vlib_get_thread_index ();
2861 /* try static mappings with port */
2862 if (PREDICT_FALSE (pool_elts (sm->static_mappings)))
2864 m_key.addr = ip0->dst_address;
2865 m_key.port = clib_net_to_host_u16 (port);
2866 m_key.protocol = proto;
2867 m_key.fib_index = rx_fib_index0;
2868 kv.key = m_key.as_u64;
2869 if (!clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
2871 m = pool_elt_at_index (sm->static_mappings, value.value);
2872 return m->worker_index;
2876 /* worker by outside port */
2877 next_worker_index = sm->first_worker_index;
2878 next_worker_index +=
2879 sm->workers[(clib_net_to_host_u16 (port) - 1024) / sm->port_per_thread];
2880 return next_worker_index;
2883 static clib_error_t *
2884 snat_config (vlib_main_t * vm, unformat_input_t * input)
2886 snat_main_t * sm = &snat_main;
2887 u32 translation_buckets = 1024;
2888 u32 translation_memory_size = 128<<20;
2889 u32 user_buckets = 128;
2890 u32 user_memory_size = 64<<20;
2891 u32 max_translations_per_user = 100;
2892 u32 outside_vrf_id = 0;
2893 u32 inside_vrf_id = 0;
2894 u32 static_mapping_buckets = 1024;
2895 u32 static_mapping_memory_size = 64<<20;
2896 u32 nat64_bib_buckets = 1024;
2897 u32 nat64_bib_memory_size = 128 << 20;
2898 u32 nat64_st_buckets = 2048;
2899 u32 nat64_st_memory_size = 256 << 20;
2900 u8 static_mapping_only = 0;
2901 u8 static_mapping_connection_tracking = 0;
2902 snat_main_per_thread_data_t *tsm;
2903 dslite_main_t * dm = &dslite_main;
2905 sm->deterministic = 0;
2908 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2910 if (unformat (input, "translation hash buckets %d", &translation_buckets))
2912 else if (unformat (input, "translation hash memory %d",
2913 &translation_memory_size));
2914 else if (unformat (input, "user hash buckets %d", &user_buckets))
2916 else if (unformat (input, "user hash memory %d",
2919 else if (unformat (input, "max translations per user %d",
2920 &max_translations_per_user))
2922 else if (unformat (input, "outside VRF id %d",
2925 else if (unformat (input, "inside VRF id %d",
2928 else if (unformat (input, "static mapping only"))
2930 static_mapping_only = 1;
2931 if (unformat (input, "connection tracking"))
2932 static_mapping_connection_tracking = 1;
2934 else if (unformat (input, "deterministic"))
2935 sm->deterministic = 1;
2936 else if (unformat (input, "nat64 bib hash buckets %d",
2937 &nat64_bib_buckets))
2939 else if (unformat (input, "nat64 bib hash memory %d",
2940 &nat64_bib_memory_size))
2942 else if (unformat (input, "nat64 st hash buckets %d", &nat64_st_buckets))
2944 else if (unformat (input, "nat64 st hash memory %d",
2945 &nat64_st_memory_size))
2947 else if (unformat (input, "out2in dpo"))
2949 else if (unformat (input, "dslite ce"))
2950 dslite_set_ce(dm, 1);
2952 return clib_error_return (0, "unknown input '%U'",
2953 format_unformat_error, input);
2956 /* for show commands, etc. */
2957 sm->translation_buckets = translation_buckets;
2958 sm->translation_memory_size = translation_memory_size;
2959 /* do not exceed load factor 10 */
2960 sm->max_translations = 10 * translation_buckets;
2961 sm->user_buckets = user_buckets;
2962 sm->user_memory_size = user_memory_size;
2963 sm->max_translations_per_user = max_translations_per_user;
2964 sm->outside_vrf_id = outside_vrf_id;
2965 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2967 FIB_SOURCE_PLUGIN_HI);
2968 sm->inside_vrf_id = inside_vrf_id;
2969 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2971 FIB_SOURCE_PLUGIN_HI);
2972 sm->static_mapping_only = static_mapping_only;
2973 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
2975 nat64_set_hash(nat64_bib_buckets, nat64_bib_memory_size, nat64_st_buckets,
2976 nat64_st_memory_size);
2978 if (sm->deterministic)
2980 sm->in2out_node_index = snat_det_in2out_node.index;
2981 sm->in2out_output_node_index = ~0;
2982 sm->out2in_node_index = snat_det_out2in_node.index;
2983 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
2984 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
2988 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
2989 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
2990 sm->in2out_node_index = snat_in2out_node.index;
2991 sm->in2out_output_node_index = snat_in2out_output_node.index;
2992 sm->out2in_node_index = snat_out2in_node.index;
2993 if (!static_mapping_only ||
2994 (static_mapping_only && static_mapping_connection_tracking))
2996 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
2997 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
2999 vec_foreach (tsm, sm->per_thread_data)
3001 clib_bihash_init_8_8 (&tsm->in2out, "in2out", translation_buckets,
3002 translation_memory_size);
3004 clib_bihash_init_8_8 (&tsm->out2in, "out2in", translation_buckets,
3005 translation_memory_size);
3007 clib_bihash_init_8_8 (&tsm->user_hash, "users", user_buckets,
3011 clib_bihash_init_16_8 (&sm->in2out_ed, "in2out-ed",
3012 translation_buckets, translation_memory_size);
3014 clib_bihash_init_16_8 (&sm->out2in_ed, "out2in-ed",
3015 translation_buckets, translation_memory_size);
3019 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
3020 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
3022 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
3023 "static_mapping_by_local", static_mapping_buckets,
3024 static_mapping_memory_size);
3026 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
3027 "static_mapping_by_external", static_mapping_buckets,
3028 static_mapping_memory_size);
3034 VLIB_CONFIG_FUNCTION (snat_config, "nat");
3036 u8 * format_snat_session_state (u8 * s, va_list * args)
3038 u32 i = va_arg (*args, u32);
3043 #define _(v, N, str) case SNAT_SESSION_##N: t = (u8 *) str; break;
3044 foreach_snat_session_state
3047 t = format (t, "unknown");
3049 s = format (s, "%s", t);
3053 u8 * format_snat_key (u8 * s, va_list * args)
3055 snat_session_key_t * key = va_arg (*args, snat_session_key_t *);
3057 s = format (s, "%U proto %U port %d fib %d",
3058 format_ip4_address, &key->addr,
3059 format_snat_protocol, key->protocol,
3060 clib_net_to_host_u16 (key->port), key->fib_index);
3064 u8 * format_snat_session (u8 * s, va_list * args)
3066 snat_main_t * sm __attribute__((unused)) = va_arg (*args, snat_main_t *);
3067 snat_session_t * sess = va_arg (*args, snat_session_t *);
3069 if (snat_is_unk_proto_session (sess))
3071 s = format (s, " i2o %U proto %u fib %u\n",
3072 format_ip4_address, &sess->in2out.addr,
3073 clib_net_to_host_u16 (sess->in2out.port),
3074 sess->in2out.fib_index);
3075 s = format (s, " o2i %U proto %u fib %u\n",
3076 format_ip4_address, &sess->out2in.addr,
3077 clib_net_to_host_u16 (sess->out2in.port),
3078 sess->out2in.fib_index);
3082 s = format (s, " i2o %U\n", format_snat_key, &sess->in2out);
3083 s = format (s, " o2i %U\n", format_snat_key, &sess->out2in);
3085 if (is_twice_nat_session (sess))
3087 s = format (s, " external host o2i %U:%d i2o %U:%d\n",
3088 format_ip4_address, &sess->ext_host_addr,
3089 clib_net_to_host_u16 (sess->ext_host_port),
3090 format_ip4_address, &sess->ext_host_nat_addr,
3091 clib_net_to_host_u16 (sess->ext_host_nat_port));
3095 if (sess->ext_host_addr.as_u32)
3096 s = format (s, " external host %U\n",
3097 format_ip4_address, &sess->ext_host_addr);
3099 s = format (s, " last heard %.2f\n", sess->last_heard);
3100 s = format (s, " total pkts %d, total bytes %lld\n",
3101 sess->total_pkts, sess->total_bytes);
3102 if (snat_is_session_static (sess))
3103 s = format (s, " static translation\n");
3105 s = format (s, " dynamic translation\n");
3106 if (sess->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
3107 s = format (s, " load-balancing\n");
3108 if (is_twice_nat_session (sess))
3109 s = format (s, " twice-nat\n");
3114 u8 * format_snat_user (u8 * s, va_list * args)
3116 snat_main_per_thread_data_t * sm = va_arg (*args, snat_main_per_thread_data_t *);
3117 snat_user_t * u = va_arg (*args, snat_user_t *);
3118 int verbose = va_arg (*args, int);
3119 dlist_elt_t * head, * elt;
3120 u32 elt_index, head_index;
3122 snat_session_t * sess;
3124 s = format (s, "%U: %d dynamic translations, %d static translations\n",
3125 format_ip4_address, &u->addr, u->nsessions, u->nstaticsessions);
3130 if (u->nsessions || u->nstaticsessions)
3132 head_index = u->sessions_per_user_list_head_index;
3133 head = pool_elt_at_index (sm->list_pool, head_index);
3135 elt_index = head->next;
3136 elt = pool_elt_at_index (sm->list_pool, elt_index);
3137 session_index = elt->value;
3139 while (session_index != ~0)
3141 sess = pool_elt_at_index (sm->sessions, session_index);
3143 s = format (s, " %U\n", format_snat_session, sm, sess);
3145 elt_index = elt->next;
3146 elt = pool_elt_at_index (sm->list_pool, elt_index);
3147 session_index = elt->value;
3154 u8 * format_snat_static_mapping (u8 * s, va_list * args)
3156 snat_static_mapping_t *m = va_arg (*args, snat_static_mapping_t *);
3157 nat44_lb_addr_port_t *local;
3160 s = format (s, "local %U external %U vrf %d %s",
3161 format_ip4_address, &m->local_addr,
3162 format_ip4_address, &m->external_addr,
3163 m->vrf_id, m->twice_nat ? "twice-nat" : "");
3166 if (vec_len (m->locals))
3168 s = format (s, "%U vrf %d external %U:%d %s",
3169 format_snat_protocol, m->proto,
3171 format_ip4_address, &m->external_addr, m->external_port,
3172 m->twice_nat ? "twice-nat" : "");
3173 vec_foreach (local, m->locals)
3174 s = format (s, "\n local %U:%d probability %d\%",
3175 format_ip4_address, &local->addr, local->port,
3176 local->probability);
3179 s = format (s, "%U local %U:%d external %U:%d vrf %d %s",
3180 format_snat_protocol, m->proto,
3181 format_ip4_address, &m->local_addr, m->local_port,
3182 format_ip4_address, &m->external_addr, m->external_port,
3183 m->vrf_id, m->twice_nat ? "twice-nat" : "");
3188 u8 * format_snat_static_map_to_resolve (u8 * s, va_list * args)
3190 snat_static_map_resolve_t *m = va_arg (*args, snat_static_map_resolve_t *);
3191 vnet_main_t *vnm = vnet_get_main();
3194 s = format (s, "local %U external %U vrf %d",
3195 format_ip4_address, &m->l_addr,
3196 format_vnet_sw_interface_name, vnm,
3197 vnet_get_sw_interface (vnm, m->sw_if_index),
3200 s = format (s, "%U local %U:%d external %U:%d vrf %d",
3201 format_snat_protocol, m->proto,
3202 format_ip4_address, &m->l_addr, m->l_port,
3203 format_vnet_sw_interface_name, vnm,
3204 vnet_get_sw_interface (vnm, m->sw_if_index), m->e_port,
3210 u8 * format_det_map_ses (u8 * s, va_list * args)
3212 snat_det_map_t * det_map = va_arg (*args, snat_det_map_t *);
3213 ip4_address_t in_addr, out_addr;
3214 u32 in_offset, out_offset;
3215 snat_det_session_t * ses = va_arg (*args, snat_det_session_t *);
3216 u32 * i = va_arg (*args, u32 *);
3218 u32 user_index = *i / SNAT_DET_SES_PER_USER;
3219 in_addr.as_u32 = clib_host_to_net_u32 (
3220 clib_net_to_host_u32(det_map->in_addr.as_u32) + user_index);
3221 in_offset = clib_net_to_host_u32(in_addr.as_u32) -
3222 clib_net_to_host_u32(det_map->in_addr.as_u32);
3223 out_offset = in_offset / det_map->sharing_ratio;
3224 out_addr.as_u32 = clib_host_to_net_u32(
3225 clib_net_to_host_u32(det_map->out_addr.as_u32) + out_offset);
3226 s = format (s, "in %U:%d out %U:%d external host %U:%d state: %U expire: %d\n",
3227 format_ip4_address, &in_addr,
3228 clib_net_to_host_u16 (ses->in_port),
3229 format_ip4_address, &out_addr,
3230 clib_net_to_host_u16 (ses->out.out_port),
3231 format_ip4_address, &ses->out.ext_host_addr,
3232 clib_net_to_host_u16 (ses->out.ext_host_port),
3233 format_snat_session_state, ses->state,
3239 static clib_error_t *
3240 show_snat_command_fn (vlib_main_t * vm,
3241 unformat_input_t * input,
3242 vlib_cli_command_t * cmd)
3245 snat_main_t * sm = &snat_main;
3247 snat_static_mapping_t *m;
3248 snat_interface_t *i;
3249 snat_address_t * ap;
3250 vnet_main_t *vnm = vnet_get_main();
3251 snat_main_per_thread_data_t *tsm;
3252 u32 users_num = 0, sessions_num = 0, *worker, *sw_if_index;
3254 snat_static_map_resolve_t *rp;
3255 snat_det_map_t * dm;
3256 snat_det_session_t * ses;
3258 if (unformat (input, "detail"))
3260 else if (unformat (input, "verbose"))
3263 if (sm->static_mapping_only)
3265 if (sm->static_mapping_connection_tracking)
3266 vlib_cli_output (vm, "NAT plugin mode: static mapping only connection "
3269 vlib_cli_output (vm, "NAT plugin mode: static mapping only");
3271 else if (sm->deterministic)
3273 vlib_cli_output (vm, "NAT plugin mode: deterministic mapping");
3277 vlib_cli_output (vm, "NAT plugin mode: dynamic translations enabled");
3282 pool_foreach (i, sm->interfaces,
3284 vlib_cli_output (vm, "%U %s", format_vnet_sw_interface_name, vnm,
3285 vnet_get_sw_interface (vnm, i->sw_if_index),
3286 (nat_interface_is_inside(i) &&
3287 nat_interface_is_outside(i)) ? "in out" :
3288 (nat_interface_is_inside(i) ? "in" : "out"));
3291 pool_foreach (i, sm->output_feature_interfaces,
3293 vlib_cli_output (vm, "%U output-feature %s",
3294 format_vnet_sw_interface_name, vnm,
3295 vnet_get_sw_interface (vnm, i->sw_if_index),
3296 (nat_interface_is_inside(i) &&
3297 nat_interface_is_outside(i)) ? "in out" :
3298 (nat_interface_is_inside(i) ? "in" : "out"));
3301 if (vec_len (sm->auto_add_sw_if_indices))
3303 vlib_cli_output (vm, "NAT44 pool addresses interfaces:");
3304 vec_foreach (sw_if_index, sm->auto_add_sw_if_indices)
3306 vlib_cli_output (vm, "%U", format_vnet_sw_interface_name, vnm,
3307 vnet_get_sw_interface (vnm, *sw_if_index));
3311 if (vec_len (sm->auto_add_sw_if_indices_twice_nat))
3313 vlib_cli_output (vm, "NAT44 twice-nat pool addresses interfaces:");
3314 vec_foreach (sw_if_index, sm->auto_add_sw_if_indices_twice_nat)
3316 vlib_cli_output (vm, "%U", format_vnet_sw_interface_name, vnm,
3317 vnet_get_sw_interface (vnm, *sw_if_index));
3321 vlib_cli_output (vm, "NAT44 pool addresses:");
3322 vec_foreach (ap, sm->addresses)
3324 vlib_cli_output (vm, "%U", format_ip4_address, &ap->addr);
3325 if (ap->fib_index != ~0)
3326 vlib_cli_output (vm, " tenant VRF: %u",
3327 ip4_fib_get(ap->fib_index)->table_id);
3329 vlib_cli_output (vm, " tenant VRF independent");
3330 #define _(N, i, n, s) \
3331 vlib_cli_output (vm, " %d busy %s ports", ap->busy_##n##_ports, s);
3332 foreach_snat_protocol
3336 vlib_cli_output (vm, "NAT44 twice-nat pool addresses:");
3337 vec_foreach (ap, sm->twice_nat_addresses)
3339 vlib_cli_output (vm, "%U", format_ip4_address, &ap->addr);
3340 if (ap->fib_index != ~0)
3341 vlib_cli_output (vm, " tenant VRF: %u",
3342 ip4_fib_get(ap->fib_index)->table_id);
3344 vlib_cli_output (vm, " tenant VRF independent");
3345 #define _(N, i, n, s) \
3346 vlib_cli_output (vm, " %d busy %s ports", ap->busy_##n##_ports, s);
3347 foreach_snat_protocol
3352 if (sm->num_workers > 1)
3354 vlib_cli_output (vm, "%d workers", vec_len (sm->workers));
3357 vec_foreach (worker, sm->workers)
3359 vlib_worker_thread_t *w =
3360 vlib_worker_threads + *worker + sm->first_worker_index;
3361 vlib_cli_output (vm, " %s", w->name);
3366 if (sm->deterministic)
3368 vlib_cli_output (vm, "udp timeout: %dsec", sm->udp_timeout);
3369 vlib_cli_output (vm, "tcp-established timeout: %dsec",
3370 sm->tcp_established_timeout);
3371 vlib_cli_output (vm, "tcp-transitory timeout: %dsec",
3372 sm->tcp_transitory_timeout);
3373 vlib_cli_output (vm, "icmp timeout: %dsec", sm->icmp_timeout);
3374 vlib_cli_output (vm, "%d deterministic mappings",
3375 pool_elts (sm->det_maps));
3378 pool_foreach (dm, sm->det_maps,
3380 vlib_cli_output (vm, "in %U/%d out %U/%d\n",
3381 format_ip4_address, &dm->in_addr, dm->in_plen,
3382 format_ip4_address, &dm->out_addr, dm->out_plen);
3383 vlib_cli_output (vm, " outside address sharing ratio: %d\n",
3385 vlib_cli_output (vm, " number of ports per inside host: %d\n",
3386 dm->ports_per_host);
3387 vlib_cli_output (vm, " sessions number: %d\n", dm->ses_num);
3390 vec_foreach_index (j, dm->sessions)
3392 ses = vec_elt_at_index (dm->sessions, j);
3394 vlib_cli_output (vm, " %U", format_det_map_ses, dm, ses,
3403 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
3405 vlib_cli_output (vm, "%d static mappings",
3406 pool_elts (sm->static_mappings));
3410 pool_foreach (m, sm->static_mappings,
3412 vlib_cli_output (vm, "%U", format_snat_static_mapping, m);
3418 vec_foreach (tsm, sm->per_thread_data)
3420 users_num += pool_elts (tsm->users);
3421 sessions_num += pool_elts (tsm->sessions);
3424 vlib_cli_output (vm, "%d users, %d outside addresses, %d active sessions,"
3425 " %d static mappings, %d twice-nat addresses",
3427 vec_len (sm->addresses),
3429 pool_elts (sm->static_mappings),
3430 vec_len (sm->twice_nat_addresses));
3434 vlib_cli_output (vm, "%U", format_bihash_16_8, &sm->in2out_ed,
3436 vlib_cli_output (vm, "%U", format_bihash_16_8, &sm->out2in_ed,
3438 vec_foreach_index (j, sm->per_thread_data)
3440 tsm = vec_elt_at_index (sm->per_thread_data, j);
3442 if (pool_elts (tsm->users) == 0)
3445 vlib_worker_thread_t *w = vlib_worker_threads + j;
3446 vlib_cli_output (vm, "Thread %d (%s at lcore %u):", j, w->name,
3448 vlib_cli_output (vm, " %U", format_bihash_8_8, &tsm->in2out,
3450 vlib_cli_output (vm, " %U", format_bihash_8_8, &tsm->out2in,
3452 vlib_cli_output (vm, " %d list pool elements",
3453 pool_elts (tsm->list_pool));
3455 pool_foreach (u, tsm->users,
3457 vlib_cli_output (vm, " %U", format_snat_user, tsm, u,
3462 if (pool_elts (sm->static_mappings))
3464 vlib_cli_output (vm, "static mappings:");
3465 pool_foreach (m, sm->static_mappings,
3467 vlib_cli_output (vm, "%U", format_snat_static_mapping, m);
3469 for (j = 0; j < vec_len (sm->to_resolve); j++)
3471 rp = sm->to_resolve + j;
3472 vlib_cli_output (vm, "%U",
3473 format_snat_static_map_to_resolve, rp);
3483 VLIB_CLI_COMMAND (show_snat_command, static) = {
3484 .path = "show nat44",
3485 .short_help = "show nat44",
3486 .function = show_snat_command_fn,
3491 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
3494 ip4_address_t * address,
3496 u32 if_address_index,
3499 snat_main_t *sm = &snat_main;
3500 snat_static_map_resolve_t *rp;
3501 u32 *indices_to_delete = 0;
3502 ip4_address_t l_addr;
3506 snat_address_t *addresses = sm->addresses;
3508 for (i = 0; i < vec_len(sm->auto_add_sw_if_indices); i++)
3510 if (sw_if_index == sm->auto_add_sw_if_indices[i])
3514 for (i = 0; i < vec_len(sm->auto_add_sw_if_indices_twice_nat); i++)
3517 addresses = sm->twice_nat_addresses;
3518 if (sw_if_index == sm->auto_add_sw_if_indices_twice_nat[i])
3527 /* Don't trip over lease renewal, static config */
3528 for (j = 0; j < vec_len(addresses); j++)
3529 if (addresses[j].addr.as_u32 == address->as_u32)
3532 snat_add_address (sm, address, ~0, twice_nat);
3533 /* Scan static map resolution vector */
3534 for (j = 0; j < vec_len (sm->to_resolve); j++)
3536 rp = sm->to_resolve + j;
3537 /* On this interface? */
3538 if (rp->sw_if_index == sw_if_index)
3540 /* Indetity mapping? */
3541 if (rp->l_addr.as_u32 == 0)
3542 l_addr.as_u32 = address[0].as_u32;
3544 l_addr.as_u32 = rp->l_addr.as_u32;
3545 /* Add the static mapping */
3546 rv = snat_add_static_mapping (l_addr,
3552 ~0 /* sw_if_index */,
3557 clib_warning ("snat_add_static_mapping returned %d",
3559 vec_add1 (indices_to_delete, j);
3562 /* If we resolved any of the outstanding static mappings */
3563 if (vec_len(indices_to_delete))
3566 for (j = vec_len(indices_to_delete)-1; j >= 0; j--)
3567 vec_delete(sm->to_resolve, 1, j);
3568 vec_free(indices_to_delete);
3574 (void) snat_del_address(sm, address[0], 1, twice_nat);
3580 int snat_add_interface_address (snat_main_t *sm, u32 sw_if_index, int is_del,
3583 ip4_main_t * ip4_main = sm->ip4_main;
3584 ip4_address_t * first_int_addr;
3585 snat_static_map_resolve_t *rp;
3586 u32 *indices_to_delete = 0;
3588 u32 *auto_add_sw_if_indices =
3589 twice_nat ? sm->auto_add_sw_if_indices_twice_nat : sm->auto_add_sw_if_indices;
3591 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index,
3592 0 /* just want the address*/);
3594 for (i = 0; i < vec_len(auto_add_sw_if_indices); i++)
3596 if (auto_add_sw_if_indices[i] == sw_if_index)
3600 /* if have address remove it */
3602 (void) snat_del_address (sm, first_int_addr[0], 1, twice_nat);
3605 for (j = 0; j < vec_len (sm->to_resolve); j++)
3607 rp = sm->to_resolve + j;
3608 if (rp->sw_if_index == sw_if_index)
3609 vec_add1 (indices_to_delete, j);
3611 if (vec_len(indices_to_delete))
3613 for (j = vec_len(indices_to_delete)-1; j >= 0; j--)
3614 vec_del1(sm->to_resolve, j);
3615 vec_free(indices_to_delete);
3619 vec_del1(sm->auto_add_sw_if_indices_twice_nat, i);
3621 vec_del1(sm->auto_add_sw_if_indices, i);
3624 return VNET_API_ERROR_VALUE_EXIST;
3631 return VNET_API_ERROR_NO_SUCH_ENTRY;
3633 /* add to the auto-address list */
3635 vec_add1(sm->auto_add_sw_if_indices_twice_nat, sw_if_index);
3637 vec_add1(sm->auto_add_sw_if_indices, sw_if_index);
3639 /* If the address is already bound - or static - add it now */
3641 snat_add_address (sm, first_int_addr, ~0, twice_nat);
3646 static clib_error_t *
3647 snat_add_interface_address_command_fn (vlib_main_t * vm,
3648 unformat_input_t * input,
3649 vlib_cli_command_t * cmd)
3651 snat_main_t *sm = &snat_main;
3652 unformat_input_t _line_input, *line_input = &_line_input;
3656 clib_error_t *error = 0;
3659 /* Get a line of input. */
3660 if (!unformat_user (input, unformat_line_input, line_input))
3663 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3665 if (unformat (line_input, "%U", unformat_vnet_sw_interface,
3666 sm->vnet_main, &sw_if_index))
3668 else if (unformat (line_input, "twice-nat"))
3670 else if (unformat (line_input, "del"))
3674 error = clib_error_return (0, "unknown input '%U'",
3675 format_unformat_error, line_input);
3680 rv = snat_add_interface_address (sm, sw_if_index, is_del, twice_nat);
3688 error = clib_error_return (0, "snat_add_interface_address returned %d",
3694 unformat_free (line_input);
3699 VLIB_CLI_COMMAND (snat_add_interface_address_command, static) = {
3700 .path = "nat44 add interface address",
3701 .short_help = "nat44 add interface address <interface> [twice-nat] [del]",
3702 .function = snat_add_interface_address_command_fn,
3706 nat44_del_session (snat_main_t *sm, ip4_address_t *addr, u16 port,
3707 snat_protocol_t proto, u32 vrf_id, int is_in)
3709 snat_main_per_thread_data_t *tsm;
3710 clib_bihash_kv_8_8_t kv, value;
3712 u32 fib_index = fib_table_find (FIB_PROTOCOL_IP4, vrf_id);
3713 snat_session_key_t key;
3715 clib_bihash_8_8_t *t;
3716 snat_user_key_t u_key;
3719 ip.dst_address.as_u32 = ip.src_address.as_u32 = addr->as_u32;
3720 if (sm->num_workers)
3722 vec_elt_at_index (sm->per_thread_data,
3723 sm->worker_in2out_cb (&ip, fib_index));
3725 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
3727 key.addr.as_u32 = addr->as_u32;
3728 key.port = clib_host_to_net_u16 (port);
3729 key.protocol = proto;
3730 key.fib_index = fib_index;
3731 kv.key = key.as_u64;
3732 t = is_in ? &tsm->in2out : &tsm->out2in;
3733 if (!clib_bihash_search_8_8 (t, &kv, &value))
3735 s = pool_elt_at_index (tsm->sessions, value.value);
3736 kv.key = s->in2out.as_u64;
3737 clib_bihash_add_del_8_8 (&tsm->in2out, &kv, 0);
3738 kv.key = s->out2in.as_u64;
3739 clib_bihash_add_del_8_8 (&tsm->out2in, &kv, 0);
3740 u_key.addr = s->in2out.addr;
3741 u_key.fib_index = s->in2out.fib_index;
3742 kv.key = u_key.as_u64;
3743 if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
3745 u = pool_elt_at_index (tsm->users, value.value);
3748 clib_dlist_remove (tsm->list_pool, s->per_user_index);
3749 pool_put (tsm->sessions, s);
3753 return VNET_API_ERROR_NO_SUCH_ENTRY;
3756 static clib_error_t *
3757 nat44_del_session_command_fn (vlib_main_t * vm,
3758 unformat_input_t * input,
3759 vlib_cli_command_t * cmd)
3761 snat_main_t *sm = &snat_main;
3762 unformat_input_t _line_input, *line_input = &_line_input;
3764 clib_error_t *error = 0;
3766 u32 port = 0, vrf_id = sm->outside_vrf_id;
3767 snat_protocol_t proto;
3770 /* Get a line of input. */
3771 if (!unformat_user (input, unformat_line_input, line_input))
3774 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3776 if (unformat (line_input, "%U:%u %U", unformat_ip4_address, &addr, &port,
3777 unformat_snat_protocol, &proto))
3779 else if (unformat (line_input, "in"))
3782 vrf_id = sm->inside_vrf_id;
3784 else if (unformat (line_input, "vrf %u", &vrf_id))
3788 error = clib_error_return (0, "unknown input '%U'",
3789 format_unformat_error, line_input);
3794 rv = nat44_del_session(sm, &addr, port, proto, vrf_id, is_in);
3802 error = clib_error_return (0, "nat44_del_session returned %d", rv);
3807 unformat_free (line_input);
3812 VLIB_CLI_COMMAND (nat44_del_session_command, static) = {
3813 .path = "nat44 del session",
3814 .short_help = "nat44 del session in|out <addr>:<port> tcp|udp|icmp [vrf <id>]",
3815 .function = nat44_del_session_command_fn,
3818 static clib_error_t *
3819 nat44_set_alloc_addr_and_port_alg_command_fn (vlib_main_t * vm,
3820 unformat_input_t * input,
3821 vlib_cli_command_t * cmd)
3823 snat_main_t *sm = &snat_main;
3824 unformat_input_t _line_input, *line_input = &_line_input;
3825 clib_error_t *error = 0;
3826 u32 psid, psid_offset, psid_length;
3828 /* Get a line of input. */
3829 if (!unformat_user (input, unformat_line_input, line_input))
3832 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3834 if (unformat (line_input, "default"))
3835 sm->alloc_addr_and_port = nat_alloc_addr_and_port_default;
3836 else if (unformat (line_input, "map-e psid %d psid-offset %d psid-len %d",
3837 &psid, &psid_offset, &psid_length))
3839 sm->alloc_addr_and_port = nat_alloc_addr_and_port_mape;
3840 sm->psid = (u16) psid;
3841 sm->psid_offset = (u16) psid_offset;
3842 sm->psid_length = (u16) psid_length;
3846 error = clib_error_return (0, "unknown input '%U'",
3847 format_unformat_error, line_input);
3853 unformat_free (line_input);
3858 VLIB_CLI_COMMAND (nat44_set_alloc_addr_and_port_alg_command, static) = {
3859 .path = "nat addr-port-assignment-alg",
3860 .short_help = "nat addr-port-assignment-alg <alg-name> [<alg-params>]",
3861 .function = nat44_set_alloc_addr_and_port_alg_command_fn,
3864 static clib_error_t *
3865 snat_det_map_command_fn (vlib_main_t * vm,
3866 unformat_input_t * input,
3867 vlib_cli_command_t * cmd)
3869 snat_main_t *sm = &snat_main;
3870 unformat_input_t _line_input, *line_input = &_line_input;
3871 ip4_address_t in_addr, out_addr;
3872 u32 in_plen, out_plen;
3874 clib_error_t *error = 0;
3876 /* Get a line of input. */
3877 if (!unformat_user (input, unformat_line_input, line_input))
3880 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3882 if (unformat (line_input, "in %U/%u", unformat_ip4_address, &in_addr, &in_plen))
3884 else if (unformat (line_input, "out %U/%u", unformat_ip4_address, &out_addr, &out_plen))
3886 else if (unformat (line_input, "del"))
3890 error = clib_error_return (0, "unknown input '%U'",
3891 format_unformat_error, line_input);
3896 rv = snat_det_add_map(sm, &in_addr, (u8) in_plen, &out_addr, (u8)out_plen,
3901 error = clib_error_return (0, "snat_det_add_map return %d", rv);
3906 unformat_free (line_input);
3913 * @cliexstart{snat deterministic add}
3914 * Create bijective mapping of inside address to outside address and port range
3915 * pairs, with the purpose of enabling deterministic NAT to reduce logging in
3917 * To create deterministic mapping between inside network 10.0.0.0/18 and
3918 * outside network 1.1.1.0/30 use:
3919 * # vpp# nat44 deterministic add in 10.0.0.0/18 out 1.1.1.0/30
3922 VLIB_CLI_COMMAND (snat_det_map_command, static) = {
3923 .path = "nat44 deterministic add",
3924 .short_help = "nat44 deterministic add in <addr>/<plen> out <addr>/<plen> [del]",
3925 .function = snat_det_map_command_fn,
3928 static clib_error_t *
3929 snat_det_forward_command_fn (vlib_main_t * vm,
3930 unformat_input_t * input,
3931 vlib_cli_command_t * cmd)
3933 snat_main_t *sm = &snat_main;
3934 unformat_input_t _line_input, *line_input = &_line_input;
3935 ip4_address_t in_addr, out_addr;
3937 snat_det_map_t * dm;
3938 clib_error_t *error = 0;
3940 /* Get a line of input. */
3941 if (!unformat_user (input, unformat_line_input, line_input))
3944 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3946 if (unformat (line_input, "%U", unformat_ip4_address, &in_addr))
3950 error = clib_error_return (0, "unknown input '%U'",
3951 format_unformat_error, line_input);
3956 dm = snat_det_map_by_user(sm, &in_addr);
3958 vlib_cli_output (vm, "no match");
3961 snat_det_forward (dm, &in_addr, &out_addr, &lo_port);
3962 vlib_cli_output (vm, "%U:<%d-%d>", format_ip4_address, &out_addr,
3963 lo_port, lo_port + dm->ports_per_host - 1);
3967 unformat_free (line_input);
3974 * @cliexstart{snat deterministic forward}
3975 * Return outside address and port range from inside address for deterministic
3977 * To obtain outside address and port of inside host use:
3978 * vpp# nat44 deterministic forward 10.0.0.2
3979 * 1.1.1.0:<1054-1068>
3982 VLIB_CLI_COMMAND (snat_det_forward_command, static) = {
3983 .path = "nat44 deterministic forward",
3984 .short_help = "nat44 deterministic forward <addr>",
3985 .function = snat_det_forward_command_fn,
3988 static clib_error_t *
3989 snat_det_reverse_command_fn (vlib_main_t * vm,
3990 unformat_input_t * input,
3991 vlib_cli_command_t * cmd)
3993 snat_main_t *sm = &snat_main;
3994 unformat_input_t _line_input, *line_input = &_line_input;
3995 ip4_address_t in_addr, out_addr;
3997 snat_det_map_t * dm;
3998 clib_error_t *error = 0;
4000 /* Get a line of input. */
4001 if (!unformat_user (input, unformat_line_input, line_input))
4004 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
4006 if (unformat (line_input, "%U:%d", unformat_ip4_address, &out_addr, &out_port))
4010 error = clib_error_return (0, "unknown input '%U'",
4011 format_unformat_error, line_input);
4016 if (out_port < 1024 || out_port > 65535)
4018 error = clib_error_return (0, "wrong port, must be <1024-65535>");
4022 dm = snat_det_map_by_out(sm, &out_addr);
4024 vlib_cli_output (vm, "no match");
4027 snat_det_reverse (dm, &out_addr, (u16) out_port, &in_addr);
4028 vlib_cli_output (vm, "%U", format_ip4_address, &in_addr);
4032 unformat_free (line_input);
4039 * @cliexstart{snat deterministic reverse}
4040 * Return inside address from outside address and port for deterministic NAT.
4041 * To obtain inside host address from outside address and port use:
4042 * #vpp nat44 deterministic reverse 1.1.1.1:1276
4046 VLIB_CLI_COMMAND (snat_det_reverse_command, static) = {
4047 .path = "nat44 deterministic reverse",
4048 .short_help = "nat44 deterministic reverse <addr>:<port>",
4049 .function = snat_det_reverse_command_fn,
4052 static clib_error_t *
4053 set_timeout_command_fn (vlib_main_t * vm,
4054 unformat_input_t * input,
4055 vlib_cli_command_t * cmd)
4057 snat_main_t *sm = &snat_main;
4058 unformat_input_t _line_input, *line_input = &_line_input;
4059 clib_error_t *error = 0;
4061 /* Get a line of input. */
4062 if (!unformat_user (input, unformat_line_input, line_input))
4065 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
4067 if (unformat (line_input, "udp %u", &sm->udp_timeout))
4069 else if (unformat (line_input, "tcp-established %u",
4070 &sm->tcp_established_timeout))
4072 else if (unformat (line_input, "tcp-transitory %u",
4073 &sm->tcp_transitory_timeout))
4075 else if (unformat (line_input, "icmp %u", &sm->icmp_timeout))
4077 else if (unformat (line_input, "reset"))
4079 sm->udp_timeout = SNAT_UDP_TIMEOUT;
4080 sm->tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
4081 sm->tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
4082 sm->icmp_timeout = SNAT_ICMP_TIMEOUT;
4086 error = clib_error_return (0, "unknown input '%U'",
4087 format_unformat_error, line_input);
4093 unformat_free (line_input);
4100 * @cliexstart{set snat deterministic timeout}
4101 * Set values of timeouts for deterministic NAT (in seconds), use:
4102 * vpp# set nat44 deterministic timeout udp 120 tcp-established 7500
4103 * tcp-transitory 250 icmp 90
4104 * To reset default values use:
4105 * vpp# set nat44 deterministic timeout reset
4108 VLIB_CLI_COMMAND (set_timeout_command, static) = {
4109 .path = "set nat44 deterministic timeout",
4110 .function = set_timeout_command_fn,
4112 "set nat44 deterministic timeout [udp <sec> | tcp-established <sec> "
4113 "tcp-transitory <sec> | icmp <sec> | reset]",
4116 static clib_error_t *
4117 snat_det_close_session_out_fn (vlib_main_t *vm,
4118 unformat_input_t * input,
4119 vlib_cli_command_t * cmd)
4121 snat_main_t *sm = &snat_main;
4122 unformat_input_t _line_input, *line_input = &_line_input;
4123 ip4_address_t out_addr, ext_addr, in_addr;
4124 u32 out_port, ext_port;
4125 snat_det_map_t * dm;
4126 snat_det_session_t * ses;
4127 snat_det_out_key_t key;
4128 clib_error_t *error = 0;
4130 /* Get a line of input. */
4131 if (!unformat_user (input, unformat_line_input, line_input))
4134 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
4136 if (unformat (line_input, "%U:%d %U:%d",
4137 unformat_ip4_address, &out_addr, &out_port,
4138 unformat_ip4_address, &ext_addr, &ext_port))
4142 error = clib_error_return (0, "unknown input '%U'",
4143 format_unformat_error, line_input);
4148 unformat_free (line_input);
4150 dm = snat_det_map_by_out(sm, &out_addr);
4152 vlib_cli_output (vm, "no match");
4155 snat_det_reverse(dm, &ext_addr, (u16)out_port, &in_addr);
4156 key.ext_host_addr = out_addr;
4157 key.ext_host_port = ntohs((u16)ext_port);
4158 key.out_port = ntohs((u16)out_port);
4159 ses = snat_det_get_ses_by_out(dm, &out_addr, key.as_u64);
4161 vlib_cli_output (vm, "no match");
4163 snat_det_ses_close(dm, ses);
4167 unformat_free (line_input);
4174 * @cliexstart{snat deterministic close session out}
4175 * Close session using outside ip address and port
4176 * and external ip address and port, use:
4177 * vpp# nat44 deterministic close session out 1.1.1.1:1276 2.2.2.2:2387
4180 VLIB_CLI_COMMAND (snat_det_close_sesion_out_command, static) = {
4181 .path = "nat44 deterministic close session out",
4182 .short_help = "nat44 deterministic close session out "
4183 "<out_addr>:<out_port> <ext_addr>:<ext_port>",
4184 .function = snat_det_close_session_out_fn,
4187 static clib_error_t *
4188 snat_det_close_session_in_fn (vlib_main_t *vm,
4189 unformat_input_t * input,
4190 vlib_cli_command_t * cmd)
4192 snat_main_t *sm = &snat_main;
4193 unformat_input_t _line_input, *line_input = &_line_input;
4194 ip4_address_t in_addr, ext_addr;
4195 u32 in_port, ext_port;
4196 snat_det_map_t * dm;
4197 snat_det_session_t * ses;
4198 snat_det_out_key_t key;
4199 clib_error_t *error = 0;
4201 /* Get a line of input. */
4202 if (!unformat_user (input, unformat_line_input, line_input))
4205 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
4207 if (unformat (line_input, "%U:%d %U:%d",
4208 unformat_ip4_address, &in_addr, &in_port,
4209 unformat_ip4_address, &ext_addr, &ext_port))
4213 error = clib_error_return (0, "unknown input '%U'",
4214 format_unformat_error, line_input);
4219 unformat_free (line_input);
4221 dm = snat_det_map_by_user (sm, &in_addr);
4223 vlib_cli_output (vm, "no match");
4226 key.ext_host_addr = ext_addr;
4227 key.ext_host_port = ntohs ((u16)ext_port);
4228 ses = snat_det_find_ses_by_in (dm, &in_addr, ntohs((u16)in_port), key);
4230 vlib_cli_output (vm, "no match");
4232 snat_det_ses_close(dm, ses);
4236 unformat_free(line_input);
4243 * @cliexstart{snat deterministic close_session_in}
4244 * Close session using inside ip address and port
4245 * and external ip address and port, use:
4246 * vpp# nat44 deterministic close session in 3.3.3.3:3487 2.2.2.2:2387
4249 VLIB_CLI_COMMAND (snat_det_close_session_in_command, static) = {
4250 .path = "nat44 deterministic close session in",
4251 .short_help = "nat44 deterministic close session in "
4252 "<in_addr>:<in_port> <ext_addr>:<ext_port>",
4253 .function = snat_det_close_session_in_fn,
4256 static clib_error_t *
4257 snat_forwarding_set_command_fn (vlib_main_t *vm,
4258 unformat_input_t * input,
4259 vlib_cli_command_t * cmd)
4261 snat_main_t *sm = &snat_main;
4262 unformat_input_t _line_input, *line_input = &_line_input;
4263 u8 forwarding_enable;
4264 u8 forwarding_enable_set = 0;
4265 clib_error_t *error = 0;
4267 /* Get a line of input. */
4268 if (!unformat_user (input, unformat_line_input, line_input))
4269 return clib_error_return (0, "'enable' or 'disable' expected");
4271 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
4273 if (!forwarding_enable_set && unformat (line_input, "enable"))
4275 forwarding_enable = 1;
4276 forwarding_enable_set = 1;
4278 else if (!forwarding_enable_set && unformat (line_input, "disable"))
4280 forwarding_enable = 0;
4281 forwarding_enable_set = 1;
4285 error = clib_error_return (0, "unknown input '%U'",
4286 format_unformat_error, line_input);
4291 if (!forwarding_enable_set)
4293 error = clib_error_return (0, "'enable' or 'disable' expected");
4297 sm->forwarding_enabled = forwarding_enable;
4300 unformat_free(line_input);
4307 * @cliexstart{nat44 forwarding}
4308 * Enable or disable forwarding
4309 * Forward packets which don't match existing translation
4310 * or static mapping instead of dropping them.
4311 * To enable forwarding, use:
4312 * vpp# nat44 forwarding enable
4313 * To disable forwarding, use:
4314 * vpp# nat44 forwarding disable
4317 VLIB_CLI_COMMAND (snat_forwarding_set_command, static) = {
4318 .path = "nat44 forwarding",
4319 .short_help = "nat44 forwarding enable|disable",
4320 .function = snat_forwarding_set_command_fn,