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>
22 #include <snat/snat.h>
23 #include <snat/snat_ipfix_logging.h>
24 #include <snat/snat_det.h>
25 #include <vnet/fib/fib_table.h>
26 #include <vnet/fib/ip4_fib.h>
28 #include <vlibapi/api.h>
29 #include <vlibmemory/api.h>
30 #include <vlibsocket/api.h>
31 #include <vpp/app/version.h>
33 snat_main_t snat_main;
35 /* define message IDs */
36 #include <snat/snat_msg_enum.h>
38 /* define message structures */
40 #include <snat/snat_all_api_h.h>
43 /* define generated endian-swappers */
45 #include <snat/snat_all_api_h.h>
48 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
50 #define REPLY_MSG_ID_BASE sm->msg_id_base
51 #include <vlibapi/api_helper_macros.h>
53 /* Get the API version number */
54 #define vl_api_version(n,v) static u32 api_version=(v);
55 #include <snat/snat_all_api_h.h>
58 /* Macro to finish up custom dump fns */
61 vl_print (handle, (char *)s); \
65 /* Hook up input features */
66 VNET_FEATURE_INIT (ip4_snat_in2out, static) = {
67 .arc_name = "ip4-unicast",
68 .node_name = "snat-in2out",
69 .runs_before = VNET_FEATURES ("snat-out2in"),
71 VNET_FEATURE_INIT (ip4_snat_out2in, static) = {
72 .arc_name = "ip4-unicast",
73 .node_name = "snat-out2in",
74 .runs_before = VNET_FEATURES ("ip4-lookup"),
76 VNET_FEATURE_INIT (ip4_snat_det_in2out, static) = {
77 .arc_name = "ip4-unicast",
78 .node_name = "snat-det-in2out",
79 .runs_before = VNET_FEATURES ("snat-det-out2in"),
81 VNET_FEATURE_INIT (ip4_snat_det_out2in, static) = {
82 .arc_name = "ip4-unicast",
83 .node_name = "snat-det-out2in",
84 .runs_before = VNET_FEATURES ("ip4-lookup"),
86 VNET_FEATURE_INIT (ip4_snat_in2out_worker_handoff, static) = {
87 .arc_name = "ip4-unicast",
88 .node_name = "snat-in2out-worker-handoff",
89 .runs_before = VNET_FEATURES ("snat-out2in-worker-handoff"),
91 VNET_FEATURE_INIT (ip4_snat_out2in_worker_handoff, static) = {
92 .arc_name = "ip4-unicast",
93 .node_name = "snat-out2in-worker-handoff",
94 .runs_before = VNET_FEATURES ("ip4-lookup"),
96 VNET_FEATURE_INIT (ip4_snat_in2out_fast, static) = {
97 .arc_name = "ip4-unicast",
98 .node_name = "snat-in2out-fast",
99 .runs_before = VNET_FEATURES ("snat-out2in-fast"),
101 VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
102 .arc_name = "ip4-unicast",
103 .node_name = "snat-out2in-fast",
104 .runs_before = VNET_FEATURES ("ip4-lookup"),
108 VLIB_PLUGIN_REGISTER () = {
109 .version = VPP_BUILD_VER,
110 .description = "Network Address Translation",
115 * @brief Add/del NAT address to FIB.
117 * Add the external NAT address to the FIB as receive entries. This ensures
118 * that VPP will reply to ARP for this address and we don't need to enable
119 * proxy ARP on the outside interface.
121 * @param addr IPv4 address.
122 * @param plen address prefix length
123 * @param sw_if_index Interface.
124 * @param is_add If 0 delete, otherwise add.
127 snat_add_del_addr_to_fib (ip4_address_t * addr, u8 p_len, u32 sw_if_index,
130 fib_prefix_t prefix = {
132 .fp_proto = FIB_PROTOCOL_IP4,
134 .ip4.as_u32 = addr->as_u32,
137 u32 fib_index = ip4_fib_table_get_index_for_sw_if_index(sw_if_index);
140 fib_table_entry_update_one_path(fib_index,
142 FIB_SOURCE_PLUGIN_HI,
143 (FIB_ENTRY_FLAG_CONNECTED |
144 FIB_ENTRY_FLAG_LOCAL |
145 FIB_ENTRY_FLAG_EXCLUSIVE),
152 FIB_ROUTE_PATH_FLAG_NONE);
154 fib_table_entry_delete(fib_index,
156 FIB_SOURCE_PLUGIN_HI);
159 void snat_add_address (snat_main_t *sm, ip4_address_t *addr, u32 vrf_id)
167 /* Check if address already exists */
168 vec_foreach (ap, sm->addresses)
170 if (ap->addr.as_u32 == addr->as_u32)
174 vec_add2 (sm->addresses, ap, 1);
176 ap->fib_index = ip4_fib_index_from_table_id(vrf_id);
177 #define _(N, i, n, s) \
178 clib_bitmap_alloc (ap->busy_##n##_port_bitmap, 65535);
179 foreach_snat_protocol
182 /* Add external address to FIB */
183 pool_foreach (i, sm->interfaces,
188 snat_add_del_addr_to_fib(addr, 32, i->sw_if_index, 1);
193 static int is_snat_address_used_in_static_mapping (snat_main_t *sm,
196 snat_static_mapping_t *m;
197 pool_foreach (m, sm->static_mappings,
199 if (m->external_addr.as_u32 == addr.as_u32)
206 static void increment_v4_address (ip4_address_t * a)
210 v = clib_net_to_host_u32(a->as_u32) + 1;
211 a->as_u32 = clib_host_to_net_u32(v);
215 snat_add_static_mapping_when_resolved (snat_main_t * sm,
216 ip4_address_t l_addr,
221 snat_protocol_t proto,
225 snat_static_map_resolve_t *rp;
227 vec_add2 (sm->to_resolve, rp, 1);
228 rp->l_addr.as_u32 = l_addr.as_u32;
230 rp->sw_if_index = sw_if_index;
234 rp->addr_only = addr_only;
239 * @brief Add static mapping.
241 * Create static mapping between local addr+port and external addr+port.
243 * @param l_addr Local IPv4 address.
244 * @param e_addr External IPv4 address.
245 * @param l_port Local port number.
246 * @param e_port External port number.
247 * @param vrf_id VRF ID.
248 * @param addr_only If 0 address port and pair mapping, otherwise address only.
249 * @param sw_if_index External port instead of specific IP address.
250 * @param is_add If 0 delete static mapping, otherwise add.
254 int snat_add_static_mapping(ip4_address_t l_addr, ip4_address_t e_addr,
255 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
256 u32 sw_if_index, snat_protocol_t proto, int is_add)
258 snat_main_t * sm = &snat_main;
259 snat_static_mapping_t *m;
260 snat_session_key_t m_key;
261 clib_bihash_kv_8_8_t kv, value;
262 snat_address_t *a = 0;
265 snat_interface_t *interface;
268 /* If the external address is a specific interface address */
269 if (sw_if_index != ~0)
271 ip4_address_t * first_int_addr;
273 /* Might be already set... */
274 first_int_addr = ip4_interface_first_address
275 (sm->ip4_main, sw_if_index, 0 /* just want the address*/);
277 /* DHCP resolution required? */
278 if (first_int_addr == 0)
280 snat_add_static_mapping_when_resolved
281 (sm, l_addr, l_port, sw_if_index, e_port, vrf_id, proto,
286 e_addr.as_u32 = first_int_addr->as_u32;
290 m_key.port = addr_only ? 0 : e_port;
291 m_key.protocol = addr_only ? 0 : proto;
292 m_key.fib_index = sm->outside_fib_index;
293 kv.key = m_key.as_u64;
294 if (clib_bihash_search_8_8 (&sm->static_mapping_by_external, &kv, &value))
297 m = pool_elt_at_index (sm->static_mappings, value.value);
302 return VNET_API_ERROR_VALUE_EXIST;
304 /* Convert VRF id to FIB index */
307 p = hash_get (sm->ip4_main->fib_index_by_table_id, vrf_id);
309 return VNET_API_ERROR_NO_SUCH_FIB;
312 /* If not specified use inside VRF id from SNAT plugin startup config */
315 fib_index = sm->inside_fib_index;
316 vrf_id = sm->inside_vrf_id;
319 /* Find external address in allocated addresses and reserve port for
320 address and port pair mapping when dynamic translations enabled */
321 if (!addr_only && !(sm->static_mapping_only))
323 for (i = 0; i < vec_len (sm->addresses); i++)
325 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
327 a = sm->addresses + i;
328 /* External port must be unused */
331 #define _(N, j, n, s) \
332 case SNAT_PROTOCOL_##N: \
333 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, e_port)) \
334 return VNET_API_ERROR_INVALID_VALUE; \
335 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 1); \
337 a->busy_##n##_ports++; \
339 foreach_snat_protocol
342 clib_warning("unknown_protocol");
343 return VNET_API_ERROR_INVALID_VALUE_2;
348 /* External address must be allocated */
350 return VNET_API_ERROR_NO_SUCH_ENTRY;
353 pool_get (sm->static_mappings, m);
354 memset (m, 0, sizeof (*m));
355 m->local_addr = l_addr;
356 m->external_addr = e_addr;
357 m->addr_only = addr_only;
359 m->fib_index = fib_index;
362 m->local_port = l_port;
363 m->external_port = e_port;
367 m_key.addr = m->local_addr;
368 m_key.port = m->local_port;
369 m_key.protocol = m->proto;
370 m_key.fib_index = m->fib_index;
371 kv.key = m_key.as_u64;
372 kv.value = m - sm->static_mappings;
373 clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 1);
375 m_key.addr = m->external_addr;
376 m_key.port = m->external_port;
377 m_key.fib_index = sm->outside_fib_index;
378 kv.key = m_key.as_u64;
379 kv.value = m - sm->static_mappings;
380 clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 1);
385 snat_user_key_t w_key0;
386 snat_worker_key_t w_key1;
388 w_key0.addr = m->local_addr;
389 w_key0.fib_index = m->fib_index;
390 kv.key = w_key0.as_u64;
392 if (clib_bihash_search_8_8 (&sm->worker_by_in, &kv, &value))
394 kv.value = sm->first_worker_index +
395 sm->workers[sm->next_worker++ % vec_len (sm->workers)];
397 clib_bihash_add_del_8_8 (&sm->worker_by_in, &kv, 1);
401 kv.value = value.value;
404 w_key1.addr = m->external_addr;
405 w_key1.port = clib_host_to_net_u16 (m->external_port);
406 w_key1.fib_index = sm->outside_fib_index;
407 kv.key = w_key1.as_u64;
408 clib_bihash_add_del_8_8 (&sm->worker_by_out, &kv, 1);
414 return VNET_API_ERROR_NO_SUCH_ENTRY;
416 /* Free external address port */
417 if (!addr_only && !(sm->static_mapping_only))
419 for (i = 0; i < vec_len (sm->addresses); i++)
421 if (sm->addresses[i].addr.as_u32 == e_addr.as_u32)
423 a = sm->addresses + i;
426 #define _(N, j, n, s) \
427 case SNAT_PROTOCOL_##N: \
428 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, e_port, 0); \
430 a->busy_##n##_ports--; \
432 foreach_snat_protocol
435 clib_warning("unknown_protocol");
436 return VNET_API_ERROR_INVALID_VALUE_2;
443 m_key.addr = m->local_addr;
444 m_key.port = m->local_port;
445 m_key.protocol = m->proto;
446 m_key.fib_index = m->fib_index;
447 kv.key = m_key.as_u64;
448 clib_bihash_add_del_8_8(&sm->static_mapping_by_local, &kv, 0);
450 m_key.addr = m->external_addr;
451 m_key.port = m->external_port;
452 m_key.fib_index = sm->outside_fib_index;
453 kv.key = m_key.as_u64;
454 clib_bihash_add_del_8_8(&sm->static_mapping_by_external, &kv, 0);
456 /* Delete session(s) for static mapping if exist */
457 if (!(sm->static_mapping_only) ||
458 (sm->static_mapping_only && sm->static_mapping_connection_tracking))
460 snat_user_key_t u_key;
462 dlist_elt_t * head, * elt;
463 u32 elt_index, head_index, del_elt_index;
467 snat_main_per_thread_data_t *tsm;
469 u_key.addr = m->local_addr;
470 u_key.fib_index = m->fib_index;
471 kv.key = u_key.as_u64;
472 if (!clib_bihash_search_8_8 (&sm->user_hash, &kv, &value))
474 user_index = value.value;
475 if (!clib_bihash_search_8_8 (&sm->worker_by_in, &kv, &value))
476 tsm = vec_elt_at_index (sm->per_thread_data, value.value);
478 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
479 u = pool_elt_at_index (tsm->users, user_index);
480 if (u->nstaticsessions)
482 head_index = u->sessions_per_user_list_head_index;
483 head = pool_elt_at_index (tsm->list_pool, head_index);
484 elt_index = head->next;
485 elt = pool_elt_at_index (tsm->list_pool, elt_index);
486 ses_index = elt->value;
487 while (ses_index != ~0)
489 s = pool_elt_at_index (tsm->sessions, ses_index);
490 del_elt_index = elt_index;
491 elt_index = elt->next;
492 elt = pool_elt_at_index (tsm->list_pool, elt_index);
493 ses_index = elt->value;
497 if ((s->out2in.addr.as_u32 != e_addr.as_u32) &&
498 (clib_net_to_host_u16 (s->out2in.port) != e_port))
503 snat_ipfix_logging_nat44_ses_delete(s->in2out.addr.as_u32,
504 s->out2in.addr.as_u32,
508 s->in2out.fib_index);
510 value.key = s->in2out.as_u64;
511 clib_bihash_add_del_8_8 (&sm->in2out, &value, 0);
512 value.key = s->out2in.as_u64;
513 clib_bihash_add_del_8_8 (&sm->out2in, &value, 0);
514 pool_put (tsm->sessions, s);
516 clib_dlist_remove (tsm->list_pool, del_elt_index);
517 pool_put_index (tsm->list_pool, del_elt_index);
518 u->nstaticsessions--;
525 pool_put (tsm->users, u);
526 clib_bihash_add_del_8_8 (&sm->user_hash, &kv, 0);
532 /* Delete static mapping from pool */
533 pool_put (sm->static_mappings, m);
539 /* Add/delete external address to FIB */
540 pool_foreach (interface, sm->interfaces,
542 if (interface->is_inside)
545 snat_add_del_addr_to_fib(&e_addr, 32, interface->sw_if_index, is_add);
552 int snat_del_address (snat_main_t *sm, ip4_address_t addr, u8 delete_sm)
554 snat_address_t *a = 0;
556 u32 *ses_to_be_removed = 0, *ses_index;
557 clib_bihash_kv_8_8_t kv, value;
558 snat_user_key_t user_key;
560 snat_main_per_thread_data_t *tsm;
561 snat_static_mapping_t *m;
562 snat_interface_t *interface;
565 /* Find SNAT address */
566 for (i=0; i < vec_len (sm->addresses); i++)
568 if (sm->addresses[i].addr.as_u32 == addr.as_u32)
570 a = sm->addresses + i;
575 return VNET_API_ERROR_NO_SUCH_ENTRY;
579 pool_foreach (m, sm->static_mappings,
581 if (m->external_addr.as_u32 == addr.as_u32)
582 (void) snat_add_static_mapping (m->local_addr, m->external_addr,
583 m->local_port, m->external_port,
584 m->vrf_id, m->addr_only, ~0,
590 /* Check if address is used in some static mapping */
591 if (is_snat_address_used_in_static_mapping(sm, addr))
593 clib_warning ("address used in static mapping");
594 return VNET_API_ERROR_UNSPECIFIED;
598 /* Delete sessions using address */
599 if (a->busy_tcp_ports || a->busy_udp_ports || a->busy_icmp_ports)
601 vec_foreach (tsm, sm->per_thread_data)
603 pool_foreach (ses, tsm->sessions, ({
604 if (ses->out2in.addr.as_u32 == addr.as_u32)
607 snat_ipfix_logging_nat44_ses_delete(ses->in2out.addr.as_u32,
608 ses->out2in.addr.as_u32,
609 ses->in2out.protocol,
612 ses->in2out.fib_index);
613 vec_add1 (ses_to_be_removed, ses - tsm->sessions);
614 kv.key = ses->in2out.as_u64;
615 clib_bihash_add_del_8_8 (&sm->in2out, &kv, 0);
616 kv.key = ses->out2in.as_u64;
617 clib_bihash_add_del_8_8 (&sm->out2in, &kv, 0);
618 clib_dlist_remove (tsm->list_pool, ses->per_user_index);
619 user_key.addr = ses->in2out.addr;
620 user_key.fib_index = ses->in2out.fib_index;
621 kv.key = user_key.as_u64;
622 if (!clib_bihash_search_8_8 (&sm->user_hash, &kv, &value))
624 u = pool_elt_at_index (tsm->users, value.value);
630 vec_foreach (ses_index, ses_to_be_removed)
631 pool_put_index (tsm->sessions, ses_index[0]);
633 vec_free (ses_to_be_removed);
637 vec_del1 (sm->addresses, i);
639 /* Delete external address from FIB */
640 pool_foreach (interface, sm->interfaces,
642 if (interface->is_inside)
645 snat_add_del_addr_to_fib(&addr, 32, interface->sw_if_index, 0);
652 static int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del)
654 snat_main_t *sm = &snat_main;
656 const char * feature_name;
658 snat_static_mapping_t * m;
661 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
662 feature_name = is_inside ? "snat-in2out-fast" : "snat-out2in-fast";
665 if (sm->num_workers > 1 && !sm->deterministic)
666 feature_name = is_inside ? "snat-in2out-worker-handoff" : "snat-out2in-worker-handoff";
667 else if (sm->deterministic)
668 feature_name = is_inside ? "snat-det-in2out" : "snat-det-out2in";
670 feature_name = is_inside ? "snat-in2out" : "snat-out2in";
673 vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index,
676 if (sm->fq_in2out_index == ~0 && !sm->deterministic && sm->num_workers > 1)
677 sm->fq_in2out_index = vlib_frame_queue_main_init (sm->in2out_node_index, 0);
679 if (sm->fq_out2in_index == ~0 && !sm->deterministic && sm->num_workers > 1)
680 sm->fq_out2in_index = vlib_frame_queue_main_init (sm->out2in_node_index, 0);
682 pool_foreach (i, sm->interfaces,
684 if (i->sw_if_index == sw_if_index)
687 pool_put (sm->interfaces, i);
689 return VNET_API_ERROR_VALUE_EXIST;
696 return VNET_API_ERROR_NO_SUCH_ENTRY;
698 pool_get (sm->interfaces, i);
699 i->sw_if_index = sw_if_index;
700 i->is_inside = is_inside;
702 /* Add/delete external addresses to FIB */
707 vec_foreach (ap, sm->addresses)
708 snat_add_del_addr_to_fib(&ap->addr, 32, sw_if_index, !is_del);
710 pool_foreach (m, sm->static_mappings,
715 snat_add_del_addr_to_fib(&m->external_addr, 32, sw_if_index, !is_del);
718 pool_foreach (dm, sm->det_maps,
720 snat_add_del_addr_to_fib(&dm->out_addr, dm->out_plen, sw_if_index, !is_del);
726 static int snat_set_workers (uword * bitmap)
728 snat_main_t *sm = &snat_main;
731 if (sm->num_workers < 2)
732 return VNET_API_ERROR_FEATURE_DISABLED;
734 if (clib_bitmap_last_set (bitmap) >= sm->num_workers)
735 return VNET_API_ERROR_INVALID_WORKER;
737 vec_free (sm->workers);
738 clib_bitmap_foreach (i, bitmap,
740 vec_add1(sm->workers, i);
747 vl_api_snat_add_address_range_t_handler
748 (vl_api_snat_add_address_range_t * mp)
750 snat_main_t * sm = &snat_main;
751 vl_api_snat_add_address_range_reply_t * rmp;
752 ip4_address_t this_addr;
753 u32 start_host_order, end_host_order;
761 rv = VNET_API_ERROR_UNIMPLEMENTED;
765 if (sm->static_mapping_only)
767 rv = VNET_API_ERROR_FEATURE_DISABLED;
771 tmp = (u32 *) mp->first_ip_address;
772 start_host_order = clib_host_to_net_u32 (tmp[0]);
773 tmp = (u32 *) mp->last_ip_address;
774 end_host_order = clib_host_to_net_u32 (tmp[0]);
776 count = (end_host_order - start_host_order) + 1;
778 vrf_id = clib_host_to_net_u32 (mp->vrf_id);
781 clib_warning ("%U - %U, %d addresses...",
782 format_ip4_address, mp->first_ip_address,
783 format_ip4_address, mp->last_ip_address,
786 memcpy (&this_addr.as_u8, mp->first_ip_address, 4);
788 for (i = 0; i < count; i++)
791 snat_add_address (sm, &this_addr, vrf_id);
793 rv = snat_del_address (sm, this_addr, 0);
798 increment_v4_address (&this_addr);
802 REPLY_MACRO (VL_API_SNAT_ADD_ADDRESS_RANGE_REPLY);
805 static void *vl_api_snat_add_address_range_t_print
806 (vl_api_snat_add_address_range_t *mp, void * handle)
810 s = format (0, "SCRIPT: snat_add_address_range ");
811 s = format (s, "%U ", format_ip4_address, mp->first_ip_address);
812 if (memcmp (mp->first_ip_address, mp->last_ip_address, 4))
814 s = format (s, " - %U ", format_ip4_address, mp->last_ip_address);
820 send_snat_address_details
821 (snat_address_t * a, unix_shared_memory_queue_t * q, u32 context)
823 vl_api_snat_address_details_t *rmp;
824 snat_main_t * sm = &snat_main;
826 rmp = vl_msg_api_alloc (sizeof (*rmp));
827 memset (rmp, 0, sizeof (*rmp));
828 rmp->_vl_msg_id = ntohs (VL_API_SNAT_ADDRESS_DETAILS+sm->msg_id_base);
830 clib_memcpy (rmp->ip_address, &(a->addr), 4);
831 if (a->fib_index != ~0)
832 rmp->vrf_id = ntohl(ip4_fib_get(a->fib_index)->table_id);
835 rmp->context = context;
837 vl_msg_api_send_shmem (q, (u8 *) & rmp);
841 vl_api_snat_address_dump_t_handler
842 (vl_api_snat_address_dump_t * mp)
844 unix_shared_memory_queue_t *q;
845 snat_main_t * sm = &snat_main;
848 q = vl_api_client_index_to_input_queue (mp->client_index);
852 vec_foreach (a, sm->addresses)
853 send_snat_address_details (a, q, mp->context);
856 static void *vl_api_snat_address_dump_t_print
857 (vl_api_snat_address_dump_t *mp, void * handle)
861 s = format (0, "SCRIPT: snat_address_dump ");
867 vl_api_snat_interface_add_del_feature_t_handler
868 (vl_api_snat_interface_add_del_feature_t * mp)
870 snat_main_t * sm = &snat_main;
871 vl_api_snat_interface_add_del_feature_reply_t * rmp;
872 u8 is_del = mp->is_add == 0;
873 u32 sw_if_index = ntohl(mp->sw_if_index);
876 VALIDATE_SW_IF_INDEX(mp);
878 rv = snat_interface_add_del (sw_if_index, mp->is_inside, is_del);
880 BAD_SW_IF_INDEX_LABEL;
882 REPLY_MACRO(VL_API_SNAT_INTERFACE_ADD_DEL_FEATURE_REPLY);
885 static void *vl_api_snat_interface_add_del_feature_t_print
886 (vl_api_snat_interface_add_del_feature_t * mp, void *handle)
890 s = format (0, "SCRIPT: snat_interface_add_del_feature ");
891 s = format (s, "sw_if_index %d %s %s",
892 clib_host_to_net_u32(mp->sw_if_index),
893 mp->is_inside ? "in":"out",
894 mp->is_add ? "" : "del");
900 send_snat_interface_details
901 (snat_interface_t * i, unix_shared_memory_queue_t * q, u32 context)
903 vl_api_snat_interface_details_t *rmp;
904 snat_main_t * sm = &snat_main;
906 rmp = vl_msg_api_alloc (sizeof (*rmp));
907 memset (rmp, 0, sizeof (*rmp));
908 rmp->_vl_msg_id = ntohs (VL_API_SNAT_INTERFACE_DETAILS+sm->msg_id_base);
909 rmp->sw_if_index = ntohl (i->sw_if_index);
910 rmp->is_inside = i->is_inside;
911 rmp->context = context;
913 vl_msg_api_send_shmem (q, (u8 *) & rmp);
917 vl_api_snat_interface_dump_t_handler
918 (vl_api_snat_interface_dump_t * mp)
920 unix_shared_memory_queue_t *q;
921 snat_main_t * sm = &snat_main;
922 snat_interface_t * i;
924 q = vl_api_client_index_to_input_queue (mp->client_index);
928 pool_foreach (i, sm->interfaces,
930 send_snat_interface_details(i, q, mp->context);
934 static void *vl_api_snat_interface_dump_t_print
935 (vl_api_snat_interface_dump_t *mp, void * handle)
939 s = format (0, "SCRIPT: snat_interface_dump ");
944 vl_api_snat_add_static_mapping_t_handler
945 (vl_api_snat_add_static_mapping_t * mp)
947 snat_main_t * sm = &snat_main;
948 vl_api_snat_add_static_mapping_reply_t * rmp;
949 ip4_address_t local_addr, external_addr;
950 u16 local_port = 0, external_port = 0;
951 u32 vrf_id, external_sw_if_index;
953 snat_protocol_t proto;
957 rv = VNET_API_ERROR_UNIMPLEMENTED;
961 memcpy (&local_addr.as_u8, mp->local_ip_address, 4);
962 memcpy (&external_addr.as_u8, mp->external_ip_address, 4);
963 if (mp->addr_only == 0)
965 local_port = clib_net_to_host_u16 (mp->local_port);
966 external_port = clib_net_to_host_u16 (mp->external_port);
968 vrf_id = clib_net_to_host_u32 (mp->vrf_id);
969 external_sw_if_index = clib_net_to_host_u32 (mp->external_sw_if_index);
970 proto = ip_proto_to_snat_proto (mp->protocol);
972 rv = snat_add_static_mapping(local_addr, external_addr, local_port,
973 external_port, vrf_id, mp->addr_only,
974 external_sw_if_index, proto, mp->is_add);
977 REPLY_MACRO (VL_API_SNAT_ADD_ADDRESS_RANGE_REPLY);
980 static void *vl_api_snat_add_static_mapping_t_print
981 (vl_api_snat_add_static_mapping_t *mp, void * handle)
985 s = format (0, "SCRIPT: snat_add_static_mapping ");
986 s = format (s, "protocol %d local_addr %U external_addr %U ",
988 format_ip4_address, mp->local_ip_address,
989 format_ip4_address, mp->external_ip_address);
991 if (mp->addr_only == 0)
992 s = format (s, "local_port %d external_port %d ",
993 clib_net_to_host_u16 (mp->local_port),
994 clib_net_to_host_u16 (mp->external_port));
996 if (mp->vrf_id != ~0)
997 s = format (s, "vrf %d", clib_net_to_host_u32 (mp->vrf_id));
999 if (mp->external_sw_if_index != ~0)
1000 s = format (s, "external_sw_if_index %d",
1001 clib_net_to_host_u32 (mp->external_sw_if_index));
1006 send_snat_static_mapping_details
1007 (snat_static_mapping_t * m, unix_shared_memory_queue_t * q, u32 context)
1009 vl_api_snat_static_mapping_details_t *rmp;
1010 snat_main_t * sm = &snat_main;
1012 rmp = vl_msg_api_alloc (sizeof (*rmp));
1013 memset (rmp, 0, sizeof (*rmp));
1014 rmp->_vl_msg_id = ntohs (VL_API_SNAT_STATIC_MAPPING_DETAILS+sm->msg_id_base);
1016 rmp->addr_only = m->addr_only;
1017 clib_memcpy (rmp->local_ip_address, &(m->local_addr), 4);
1018 clib_memcpy (rmp->external_ip_address, &(m->external_addr), 4);
1019 rmp->local_port = htons (m->local_port);
1020 rmp->external_port = htons (m->external_port);
1021 rmp->external_sw_if_index = ~0;
1022 rmp->vrf_id = htonl (m->vrf_id);
1023 rmp->protocol = snat_proto_to_ip_proto (m->proto);
1024 rmp->context = context;
1026 vl_msg_api_send_shmem (q, (u8 *) & rmp);
1030 send_snat_static_map_resolve_details
1031 (snat_static_map_resolve_t * m, unix_shared_memory_queue_t * q, u32 context)
1033 vl_api_snat_static_mapping_details_t *rmp;
1034 snat_main_t * sm = &snat_main;
1036 rmp = vl_msg_api_alloc (sizeof (*rmp));
1037 memset (rmp, 0, sizeof (*rmp));
1038 rmp->_vl_msg_id = ntohs (VL_API_SNAT_STATIC_MAPPING_DETAILS+sm->msg_id_base);
1040 rmp->addr_only = m->addr_only;
1041 clib_memcpy (rmp->local_ip_address, &(m->l_addr), 4);
1042 rmp->local_port = htons (m->l_port);
1043 rmp->external_port = htons (m->e_port);
1044 rmp->external_sw_if_index = htonl (m->sw_if_index);
1045 rmp->vrf_id = htonl (m->vrf_id);
1046 rmp->protocol = snat_proto_to_ip_proto (m->proto);
1047 rmp->context = context;
1049 vl_msg_api_send_shmem (q, (u8 *) & rmp);
1053 vl_api_snat_static_mapping_dump_t_handler
1054 (vl_api_snat_static_mapping_dump_t * mp)
1056 unix_shared_memory_queue_t *q;
1057 snat_main_t * sm = &snat_main;
1058 snat_static_mapping_t * m;
1059 snat_static_map_resolve_t *rp;
1062 q = vl_api_client_index_to_input_queue (mp->client_index);
1066 pool_foreach (m, sm->static_mappings,
1068 send_snat_static_mapping_details (m, q, mp->context);
1071 for (j = 0; j < vec_len (sm->to_resolve); j++)
1073 rp = sm->to_resolve + j;
1074 send_snat_static_map_resolve_details (rp, q, mp->context);
1078 static void *vl_api_snat_static_mapping_dump_t_print
1079 (vl_api_snat_static_mapping_dump_t *mp, void * handle)
1083 s = format (0, "SCRIPT: snat_static_mapping_dump ");
1089 vl_api_snat_control_ping_t_handler
1090 (vl_api_snat_control_ping_t * mp)
1092 vl_api_snat_control_ping_reply_t *rmp;
1093 snat_main_t * sm = &snat_main;
1096 REPLY_MACRO2(VL_API_SNAT_CONTROL_PING_REPLY,
1098 rmp->vpe_pid = ntohl (getpid());
1102 static void *vl_api_snat_control_ping_t_print
1103 (vl_api_snat_control_ping_t *mp, void * handle)
1107 s = format (0, "SCRIPT: snat_control_ping ");
1113 vl_api_snat_show_config_t_handler
1114 (vl_api_snat_show_config_t * mp)
1116 vl_api_snat_show_config_reply_t *rmp;
1117 snat_main_t * sm = &snat_main;
1120 REPLY_MACRO2(VL_API_SNAT_SHOW_CONFIG_REPLY,
1122 rmp->translation_buckets = htonl (sm->translation_buckets);
1123 rmp->translation_memory_size = htonl (sm->translation_memory_size);
1124 rmp->user_buckets = htonl (sm->user_buckets);
1125 rmp->user_memory_size = htonl (sm->user_memory_size);
1126 rmp->max_translations_per_user = htonl (sm->max_translations_per_user);
1127 rmp->outside_vrf_id = htonl (sm->outside_vrf_id);
1128 rmp->inside_vrf_id = htonl (sm->inside_vrf_id);
1129 rmp->static_mapping_only = sm->static_mapping_only;
1130 rmp->static_mapping_connection_tracking =
1131 sm->static_mapping_connection_tracking;
1132 rmp->deterministic = sm->deterministic;
1136 static void *vl_api_snat_show_config_t_print
1137 (vl_api_snat_show_config_t *mp, void * handle)
1141 s = format (0, "SCRIPT: snat_show_config ");
1147 vl_api_snat_set_workers_t_handler
1148 (vl_api_snat_set_workers_t * mp)
1150 snat_main_t * sm = &snat_main;
1151 vl_api_snat_set_workers_reply_t * rmp;
1154 u64 mask = clib_net_to_host_u64 (mp->worker_mask);
1156 if (sm->num_workers < 2)
1158 rv = VNET_API_ERROR_FEATURE_DISABLED;
1162 bitmap = clib_bitmap_set_multiple (bitmap, 0, mask, BITS (mask));
1163 rv = snat_set_workers(bitmap);
1164 clib_bitmap_free (bitmap);
1167 REPLY_MACRO (VL_API_SNAT_SET_WORKERS_REPLY);
1170 static void *vl_api_snat_set_workers_t_print
1171 (vl_api_snat_set_workers_t *mp, void * handle)
1177 u64 mask = clib_net_to_host_u64 (mp->worker_mask);
1179 s = format (0, "SCRIPT: snat_set_workers ");
1180 bitmap = clib_bitmap_set_multiple (bitmap, 0, mask, BITS (mask));
1181 clib_bitmap_foreach (i, bitmap,
1184 s = format (s, "%d", i);
1186 s = format (s, ",%d", i);
1189 clib_bitmap_free (bitmap);
1194 send_snat_worker_details
1195 (u32 worker_index, unix_shared_memory_queue_t * q, u32 context)
1197 vl_api_snat_worker_details_t *rmp;
1198 snat_main_t * sm = &snat_main;
1199 vlib_worker_thread_t *w =
1200 vlib_worker_threads + worker_index + sm->first_worker_index;
1202 rmp = vl_msg_api_alloc (sizeof (*rmp));
1203 memset (rmp, 0, sizeof (*rmp));
1204 rmp->_vl_msg_id = ntohs (VL_API_SNAT_WORKER_DETAILS+sm->msg_id_base);
1205 rmp->context = context;
1206 rmp->worker_index = htonl (worker_index);
1207 rmp->lcore_id = htonl (w->lcore_id);
1208 strncpy ((char *) rmp->name, (char *) w->name, ARRAY_LEN (rmp->name) - 1);
1210 vl_msg_api_send_shmem (q, (u8 *) & rmp);
1214 vl_api_snat_worker_dump_t_handler
1215 (vl_api_snat_worker_dump_t * mp)
1217 unix_shared_memory_queue_t *q;
1218 snat_main_t * sm = &snat_main;
1221 q = vl_api_client_index_to_input_queue (mp->client_index);
1225 vec_foreach (worker_index, sm->workers)
1227 send_snat_worker_details(*worker_index, q, mp->context);
1231 static void *vl_api_snat_worker_dump_t_print
1232 (vl_api_snat_worker_dump_t *mp, void * handle)
1236 s = format (0, "SCRIPT: snat_worker_dump ");
1241 static int snat_add_interface_address(snat_main_t *sm,
1246 vl_api_snat_add_del_interface_addr_t_handler
1247 (vl_api_snat_add_del_interface_addr_t * mp)
1249 snat_main_t * sm = &snat_main;
1250 vl_api_snat_add_del_interface_addr_reply_t * rmp;
1251 u8 is_del = mp->is_add == 0;
1252 u32 sw_if_index = ntohl(mp->sw_if_index);
1255 VALIDATE_SW_IF_INDEX(mp);
1257 rv = snat_add_interface_address (sm, sw_if_index, is_del);
1259 BAD_SW_IF_INDEX_LABEL;
1261 REPLY_MACRO(VL_API_SNAT_ADD_DEL_INTERFACE_ADDR_REPLY);
1264 static void *vl_api_snat_add_del_interface_addr_t_print
1265 (vl_api_snat_add_del_interface_addr_t * mp, void *handle)
1269 s = format (0, "SCRIPT: snat_add_del_interface_addr ");
1270 s = format (s, "sw_if_index %d %s",
1271 clib_host_to_net_u32(mp->sw_if_index),
1272 mp->is_add ? "" : "del");
1278 send_snat_interface_addr_details
1279 (u32 sw_if_index, unix_shared_memory_queue_t * q, u32 context)
1281 vl_api_snat_interface_addr_details_t *rmp;
1282 snat_main_t * sm = &snat_main;
1284 rmp = vl_msg_api_alloc (sizeof (*rmp));
1285 memset (rmp, 0, sizeof (*rmp));
1286 rmp->_vl_msg_id = ntohs (VL_API_SNAT_INTERFACE_ADDR_DETAILS+sm->msg_id_base);
1287 rmp->sw_if_index = ntohl (sw_if_index);
1288 rmp->context = context;
1290 vl_msg_api_send_shmem (q, (u8 *) & rmp);
1294 vl_api_snat_interface_addr_dump_t_handler
1295 (vl_api_snat_interface_addr_dump_t * mp)
1297 unix_shared_memory_queue_t *q;
1298 snat_main_t * sm = &snat_main;
1301 q = vl_api_client_index_to_input_queue (mp->client_index);
1305 vec_foreach (i, sm->auto_add_sw_if_indices)
1306 send_snat_interface_addr_details(*i, q, mp->context);
1309 static void *vl_api_snat_interface_addr_dump_t_print
1310 (vl_api_snat_interface_addr_dump_t *mp, void * handle)
1314 s = format (0, "SCRIPT: snat_interface_addr_dump ");
1320 vl_api_snat_ipfix_enable_disable_t_handler
1321 (vl_api_snat_ipfix_enable_disable_t * mp)
1323 snat_main_t * sm = &snat_main;
1324 vl_api_snat_ipfix_enable_disable_reply_t * rmp;
1327 rv = snat_ipfix_logging_enable_disable(mp->enable,
1328 clib_host_to_net_u32 (mp->domain_id),
1329 clib_host_to_net_u16 (mp->src_port));
1331 REPLY_MACRO (VL_API_SNAT_IPFIX_ENABLE_DISABLE_REPLY);
1334 static void *vl_api_snat_ipfix_enable_disable_t_print
1335 (vl_api_snat_ipfix_enable_disable_t *mp, void * handle)
1339 s = format (0, "SCRIPT: snat_ipfix_enable_disable ");
1341 s = format (s, "domain %d ", clib_net_to_host_u32 (mp->domain_id));
1343 s = format (s, "src_port %d ", clib_net_to_host_u16 (mp->src_port));
1345 s = format (s, "disable ");
1351 send_snat_user_details
1352 (snat_user_t * u, unix_shared_memory_queue_t * q, u32 context)
1354 vl_api_snat_user_details_t * rmp;
1355 snat_main_t * sm = &snat_main;
1356 ip4_fib_t * fib_table;
1358 rmp = vl_msg_api_alloc (sizeof (*rmp));
1359 memset (rmp, 0, sizeof (*rmp));
1360 rmp->_vl_msg_id = ntohs (VL_API_SNAT_USER_DETAILS+sm->msg_id_base);
1362 fib_table = ip4_fib_get(u->fib_index);
1363 rmp->vrf_id = ntohl (fib_table->table_id);
1366 clib_memcpy(rmp->ip_address, &(u->addr), 4);
1367 rmp->nsessions = ntohl (u->nsessions);
1368 rmp->nstaticsessions = ntohl (u->nstaticsessions);
1369 rmp->context = context;
1371 vl_msg_api_send_shmem (q, (u8 *) & rmp);
1375 vl_api_snat_user_dump_t_handler
1376 (vl_api_snat_user_dump_t * mp)
1378 unix_shared_memory_queue_t *q;
1379 snat_main_t * sm = &snat_main;
1380 snat_main_per_thread_data_t * tsm;
1383 q = vl_api_client_index_to_input_queue (mp->client_index);
1387 vec_foreach (tsm, sm->per_thread_data)
1388 vec_foreach (u, tsm->users)
1389 send_snat_user_details (u, q, mp->context);
1392 static void *vl_api_snat_user_dump_t_print
1393 (vl_api_snat_user_dump_t *mp, void * handle)
1397 s = format (0, "SCRIPT: snat_user_dump ");
1403 send_snat_user_session_details
1404 (snat_session_t * s, unix_shared_memory_queue_t * q, u32 context)
1406 vl_api_snat_user_session_details_t * rmp;
1407 snat_main_t * sm = &snat_main;
1409 rmp = vl_msg_api_alloc (sizeof(*rmp));
1410 memset (rmp, 0, sizeof (*rmp));
1411 rmp->_vl_msg_id = ntohs (VL_API_SNAT_USER_SESSION_DETAILS+sm->msg_id_base);
1413 clib_memcpy(rmp->outside_ip_address, (&s->out2in.addr), 4);
1414 rmp->outside_port = s->out2in.port;
1415 clib_memcpy(rmp->inside_ip_address, (&s->in2out.addr), 4);
1416 rmp->inside_port = s->in2out.port;
1417 rmp->protocol = ntohs(snat_proto_to_ip_proto(s->in2out.protocol));
1418 rmp->is_static = s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING ? 1 : 0;
1419 rmp->last_heard = clib_host_to_net_u64((u64)s->last_heard);
1420 rmp->total_bytes = clib_host_to_net_u64(s->total_bytes);
1421 rmp->total_pkts = ntohl(s->total_pkts);
1422 rmp->context = context;
1424 vl_msg_api_send_shmem (q, (u8 *) & rmp);
1428 vl_api_snat_user_session_dump_t_handler
1429 (vl_api_snat_user_session_dump_t * mp)
1431 unix_shared_memory_queue_t *q;
1432 snat_main_t * sm = &snat_main;
1433 snat_main_per_thread_data_t *tsm;
1435 clib_bihash_kv_8_8_t key, value;
1436 snat_user_key_t ukey;
1438 u32 session_index, head_index, elt_index;
1439 dlist_elt_t * head, * elt;
1441 q = vl_api_client_index_to_input_queue (mp->client_index);
1447 clib_memcpy (&ukey.addr, mp->ip_address, 4);
1448 ukey.fib_index = ip4_fib_index_from_table_id (ntohl(mp->vrf_id));
1449 key.key = ukey.as_u64;
1450 if (!clib_bihash_search_8_8 (&sm->worker_by_in, &key, &value))
1451 tsm = vec_elt_at_index (sm->per_thread_data, value.value);
1453 tsm = vec_elt_at_index (sm->per_thread_data, sm->num_workers);
1454 if (clib_bihash_search_8_8 (&sm->user_hash, &key, &value))
1456 u = pool_elt_at_index (tsm->users, value.value);
1457 if (!u->nsessions && !u->nstaticsessions)
1460 head_index = u->sessions_per_user_list_head_index;
1461 head = pool_elt_at_index (tsm->list_pool, head_index);
1462 elt_index = head->next;
1463 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1464 session_index = elt->value;
1465 while (session_index != ~0)
1467 s = pool_elt_at_index (tsm->sessions, session_index);
1469 send_snat_user_session_details (s, q, mp->context);
1471 elt_index = elt->next;
1472 elt = pool_elt_at_index (tsm->list_pool, elt_index);
1473 session_index = elt->value;
1477 static void *vl_api_snat_user_session_dump_t_print
1478 (vl_api_snat_user_session_dump_t *mp, void * handle)
1482 s = format (0, "SCRIPT: snat_user_session_dump ");
1483 s = format (s, "ip_address %U vrf_id %d\n",
1484 format_ip4_address, mp->ip_address,
1485 clib_net_to_host_u32 (mp->vrf_id));
1491 vl_api_snat_add_det_map_t_handler
1492 (vl_api_snat_add_det_map_t * mp)
1494 snat_main_t * sm = &snat_main;
1495 vl_api_snat_add_det_map_reply_t * rmp;
1497 ip4_address_t in_addr, out_addr;
1499 clib_memcpy(&in_addr, mp->in_addr, 4);
1500 clib_memcpy(&out_addr, mp->out_addr, 4);
1501 rv = snat_det_add_map(sm, &in_addr, mp->in_plen, &out_addr,
1502 mp->out_plen, mp->is_add);
1504 REPLY_MACRO (VL_API_SNAT_ADD_DET_MAP_REPLY);
1507 static void *vl_api_snat_add_det_map_t_print
1508 (vl_api_snat_add_det_map_t *mp, void * handle)
1512 s = format (0, "SCRIPT: snat_add_det_map ");
1513 s = format (s, "inside address %U/%d outside address %U/%d\n",
1514 format_ip4_address, mp->in_addr, mp->in_plen,
1515 format_ip4_address, mp->out_addr, mp->out_plen);
1521 vl_api_snat_det_forward_t_handler
1522 (vl_api_snat_det_forward_t * mp)
1524 snat_main_t * sm = &snat_main;
1525 vl_api_snat_det_forward_reply_t * rmp;
1527 u16 lo_port = 0, hi_port = 0;
1528 snat_det_map_t * dm;
1529 ip4_address_t in_addr, out_addr;
1531 out_addr.as_u32 = 0;
1532 clib_memcpy(&in_addr, mp->in_addr, 4);
1533 dm = snat_det_map_by_user(sm, &in_addr);
1536 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
1540 snat_det_forward(dm, &in_addr, &out_addr, &lo_port);
1541 hi_port = lo_port + dm->ports_per_host - 1;
1544 REPLY_MACRO2(VL_API_SNAT_DET_FORWARD_REPLY,
1546 rmp->out_port_lo = ntohs(lo_port);
1547 rmp->out_port_hi = ntohs(hi_port);
1549 memset(rmp->out_addr, 0, 16);
1550 clib_memcpy(rmp->out_addr, &out_addr, 4);
1554 static void *vl_api_snat_det_forward_t_print
1555 (vl_api_snat_det_forward_t * mp, void * handle)
1559 s = format (0, "SCRIPT: smat_det_forward_t");
1560 s = format (s, "inside ip address %U\n",
1561 format_ip4_address, mp->in_addr);
1567 vl_api_snat_det_reverse_t_handler
1568 (vl_api_snat_det_reverse_t * mp)
1570 snat_main_t * sm = &snat_main;
1571 vl_api_snat_det_reverse_reply_t * rmp;
1573 ip4_address_t out_addr, in_addr;
1574 snat_det_map_t * dm;
1577 clib_memcpy(&out_addr, mp->out_addr, 4);
1578 dm = snat_det_map_by_out(sm, &out_addr);
1581 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
1585 snat_det_reverse(dm, &out_addr, htons(mp->out_port), &in_addr);
1588 REPLY_MACRO2(VL_API_SNAT_DET_REVERSE_REPLY,
1591 memset(rmp->in_addr, 0, 16);
1592 clib_memcpy(rmp->in_addr, &in_addr, 4);
1596 static void *vl_api_snat_det_reverse_t_print
1597 (vl_api_snat_det_reverse_t * mp, void * handle)
1601 s = format(0, "SCRIPT: smat_det_reverse_t");
1602 s = format(s, "outside ip address %U outside port %d",
1603 format_ip4_address, mp->out_addr, ntohs(mp->out_port));
1609 sent_snat_det_map_details
1610 (snat_det_map_t * m, unix_shared_memory_queue_t * q, u32 context)
1612 vl_api_snat_det_map_details_t *rmp;
1613 snat_main_t * sm = &snat_main;
1615 rmp = vl_msg_api_alloc (sizeof (*rmp));
1616 memset (rmp, 0, sizeof (*rmp));
1617 rmp->_vl_msg_id = ntohs (VL_API_SNAT_DET_MAP_DETAILS+sm->msg_id_base);
1619 clib_memcpy (rmp->in_addr, &m->in_addr, 4);
1620 rmp->in_plen = m->in_plen;
1621 clib_memcpy (rmp->out_addr, &m->out_addr, 4);
1622 rmp->out_plen = m->out_plen;
1623 rmp->sharing_ratio = htonl (m->sharing_ratio);
1624 rmp->ports_per_host = htons (m->ports_per_host);
1625 rmp->ses_num = htonl (m->ses_num);
1626 rmp->context = context;
1628 vl_msg_api_send_shmem (q, (u8 *) & rmp);
1632 vl_api_snat_det_map_dump_t_handler
1633 (vl_api_snat_det_map_dump_t * mp)
1635 unix_shared_memory_queue_t *q;
1636 snat_main_t * sm = &snat_main;
1639 q = vl_api_client_index_to_input_queue (mp->client_index);
1643 vec_foreach(m, sm->det_maps)
1644 sent_snat_det_map_details(m, q, mp->context);
1647 static void * vl_api_snat_det_map_dump_t_print
1648 (vl_api_snat_det_map_dump_t *mp, void * handle)
1652 s = format (0, "SCRIPT: snat_det_map_dump ");
1658 vl_api_snat_det_set_timeouts_t_handler
1659 (vl_api_snat_det_set_timeouts_t * mp)
1661 snat_main_t * sm = &snat_main;
1662 vl_api_snat_det_set_timeouts_reply_t * rmp;
1665 sm->udp_timeout = ntohl(mp->udp);
1666 sm->tcp_established_timeout = ntohl(mp->tcp_established);
1667 sm->tcp_transitory_timeout = ntohl(mp->tcp_transitory);
1668 sm->icmp_timeout = ntohl(mp->icmp);
1670 REPLY_MACRO (VL_API_SNAT_DET_SET_TIMEOUTS_REPLY);
1673 static void *vl_api_snat_det_set_timeouts_t_print
1674 (vl_api_snat_det_set_timeouts_t *mp, void * handle)
1678 s = format (0, "SCRIPT: snat_det_set_timeouts ");
1679 s = format (s, "udp %d tcp_established %d tcp_transitory %d icmp %d\n",
1681 ntohl(mp->tcp_established),
1682 ntohl(mp->tcp_transitory),
1689 vl_api_snat_det_get_timeouts_t_handler
1690 (vl_api_snat_det_get_timeouts_t * mp)
1692 snat_main_t * sm = &snat_main;
1693 vl_api_snat_det_get_timeouts_reply_t * rmp;
1696 REPLY_MACRO2(VL_API_SNAT_DET_GET_TIMEOUTS_REPLY,
1698 rmp->udp = htonl(sm->udp_timeout);
1699 rmp->tcp_established = htonl(sm->tcp_established_timeout);
1700 rmp->tcp_transitory = htonl(sm->tcp_transitory_timeout);
1701 rmp->icmp = htonl(sm->icmp_timeout);
1705 static void *vl_api_snat_det_get_timeouts_t_print
1706 (vl_api_snat_det_get_timeouts_t * mp, void * handle)
1710 s = format(0, "SCRIPT: snat_det_get_timeouts");
1716 vl_api_snat_det_close_session_out_t_handler
1717 (vl_api_snat_det_close_session_out_t * mp)
1719 snat_main_t * sm = &snat_main;
1720 vl_api_snat_det_close_session_out_reply_t * rmp;
1721 ip4_address_t out_addr, ext_addr, in_addr;
1722 snat_det_out_key_t key;
1723 snat_det_map_t * dm;
1724 snat_det_session_t * ses;
1727 clib_memcpy(&out_addr, mp->out_addr, 4);
1728 clib_memcpy(&ext_addr, mp->ext_addr, 4);
1730 dm = snat_det_map_by_out(sm, &out_addr);
1733 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
1736 snat_det_reverse(dm, &ext_addr, ntohs(mp->out_port), &in_addr);
1737 key.ext_host_addr = ext_addr;
1738 key.ext_host_port = mp->ext_port;
1739 key.out_port = mp->out_port;
1740 ses = snat_det_get_ses_by_out(dm, &in_addr, key.as_u64);
1743 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
1746 snat_det_ses_close(dm, ses);
1749 REPLY_MACRO (VL_API_SNAT_DET_CLOSE_SESSION_OUT_REPLY);
1752 static void *vl_api_snat_det_close_session_out_t_print
1753 (vl_api_snat_det_close_session_out_t *mp, void * handle)
1757 s = format (0, "SCRIPT: snat_det_close_session_out ");
1758 s = format (s, "out_addr %U out_port %d "
1759 "ext_addr %U ext_port %d\n",
1760 format_ip4_address, mp->out_addr, ntohs(mp->out_port),
1761 format_ip4_address, mp->ext_addr, ntohs(mp->ext_port));
1767 vl_api_snat_det_close_session_in_t_handler
1768 (vl_api_snat_det_close_session_in_t * mp)
1770 snat_main_t * sm = &snat_main;
1771 vl_api_snat_det_close_session_in_reply_t * rmp;
1772 ip4_address_t in_addr, ext_addr;
1773 snat_det_out_key_t key;
1774 snat_det_map_t * dm;
1775 snat_det_session_t * ses;
1778 clib_memcpy(&in_addr, mp->in_addr, 4);
1779 clib_memcpy(&ext_addr, mp->ext_addr, 4);
1781 dm = snat_det_map_by_user(sm, &in_addr);
1784 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
1787 key.ext_host_addr = ext_addr;
1788 key.ext_host_port = mp->ext_port;
1789 ses = snat_det_find_ses_by_in(dm, &in_addr, mp->in_port, key);
1792 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
1795 snat_det_ses_close(dm, ses);
1798 REPLY_MACRO (VL_API_SNAT_DET_CLOSE_SESSION_OUT_REPLY);
1801 static void *vl_api_snat_det_close_session_in_t_print
1802 (vl_api_snat_det_close_session_in_t *mp, void * handle)
1805 s = format (0, "SCRIPT: snat_det_close_session_in ");
1806 s = format (s, "in_addr %U in_port %d "
1807 "ext_addr %U ext_port %d\n",
1808 format_ip4_address, mp->in_addr, ntohs(mp->in_port),
1809 format_ip4_address, mp->ext_addr, ntohs(mp->ext_port));
1815 send_snat_det_session_details
1816 (snat_det_session_t * s, unix_shared_memory_queue_t * q, u32 context)
1818 vl_api_snat_det_session_details_t * rmp;
1819 snat_main_t * sm = &snat_main;
1821 rmp = vl_msg_api_alloc (sizeof (*rmp));
1822 memset (rmp, 0, sizeof (*rmp));
1823 rmp->_vl_msg_id = ntohs (VL_API_SNAT_DET_SESSION_DETAILS+sm->msg_id_base);
1825 rmp->in_port = s->in_port;
1826 clib_memcpy (rmp->ext_addr, &s->out.ext_host_addr, 4);
1827 rmp->ext_port = s->out.ext_host_port;
1828 rmp->out_port = s->out.out_port;
1829 rmp->state = s->state;
1830 rmp->expire = ntohl (s->expire);
1831 rmp->context = context;
1833 vl_msg_api_send_shmem (q, (u8 *) & rmp);
1837 vl_api_snat_det_session_dump_t_handler
1838 (vl_api_snat_det_session_dump_t * mp)
1840 unix_shared_memory_queue_t *q;
1841 snat_main_t * sm = &snat_main;
1842 ip4_address_t user_addr;
1843 snat_det_map_t * dm;
1844 snat_det_session_t * s, empty_ses;
1847 q = vl_api_client_index_to_input_queue (mp->client_index);
1853 memset (&empty_ses, 0, sizeof (empty_ses));
1854 clib_memcpy (&user_addr, mp->user_addr, 4);
1855 dm = snat_det_map_by_user (sm, &user_addr);
1859 s = dm->sessions + snat_det_user_ses_offset (&user_addr, dm->in_plen);
1860 for (i = 0; i < SNAT_DET_SES_PER_USER; i++)
1863 send_snat_det_session_details (s, q, mp->context);
1868 static void *vl_api_snat_det_session_dump_t_print
1869 (vl_api_snat_det_session_dump_t * mp, void * handle)
1873 s = format (0, "SCRIPT: snat_det_session_dump ");
1874 s = format (s, "user_addr %U\n",
1875 format_ip4_address, mp->user_addr);
1880 /* List of message types that this plugin understands */
1881 #define foreach_snat_plugin_api_msg \
1882 _(SNAT_ADD_ADDRESS_RANGE, snat_add_address_range) \
1883 _(SNAT_INTERFACE_ADD_DEL_FEATURE, snat_interface_add_del_feature) \
1884 _(SNAT_ADD_STATIC_MAPPING, snat_add_static_mapping) \
1885 _(SNAT_CONTROL_PING, snat_control_ping) \
1886 _(SNAT_STATIC_MAPPING_DUMP, snat_static_mapping_dump) \
1887 _(SNAT_SHOW_CONFIG, snat_show_config) \
1888 _(SNAT_ADDRESS_DUMP, snat_address_dump) \
1889 _(SNAT_INTERFACE_DUMP, snat_interface_dump) \
1890 _(SNAT_SET_WORKERS, snat_set_workers) \
1891 _(SNAT_WORKER_DUMP, snat_worker_dump) \
1892 _(SNAT_ADD_DEL_INTERFACE_ADDR, snat_add_del_interface_addr) \
1893 _(SNAT_INTERFACE_ADDR_DUMP, snat_interface_addr_dump) \
1894 _(SNAT_IPFIX_ENABLE_DISABLE, snat_ipfix_enable_disable) \
1895 _(SNAT_USER_DUMP, snat_user_dump) \
1896 _(SNAT_USER_SESSION_DUMP, snat_user_session_dump) \
1897 _(SNAT_ADD_DET_MAP, snat_add_det_map) \
1898 _(SNAT_DET_FORWARD, snat_det_forward) \
1899 _(SNAT_DET_REVERSE, snat_det_reverse) \
1900 _(SNAT_DET_MAP_DUMP, snat_det_map_dump) \
1901 _(SNAT_DET_SET_TIMEOUTS, snat_det_set_timeouts) \
1902 _(SNAT_DET_GET_TIMEOUTS, snat_det_get_timeouts) \
1903 _(SNAT_DET_CLOSE_SESSION_OUT, snat_det_close_session_out) \
1904 _(SNAT_DET_CLOSE_SESSION_IN, snat_det_close_session_in) \
1905 _(SNAT_DET_SESSION_DUMP, snat_det_session_dump)
1908 /* Set up the API message handling tables */
1909 static clib_error_t *
1910 snat_plugin_api_hookup (vlib_main_t *vm)
1912 snat_main_t * sm __attribute__ ((unused)) = &snat_main;
1914 vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base), \
1916 vl_api_##n##_t_handler, \
1918 vl_api_##n##_t_endian, \
1919 vl_api_##n##_t_print, \
1920 sizeof(vl_api_##n##_t), 1);
1921 foreach_snat_plugin_api_msg;
1927 #define vl_msg_name_crc_list
1928 #include <snat/snat_all_api_h.h>
1929 #undef vl_msg_name_crc_list
1932 setup_message_id_table (snat_main_t * sm, api_main_t * am)
1934 #define _(id,n,crc) \
1935 vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + sm->msg_id_base);
1936 foreach_vl_msg_name_crc_snat;
1940 static void plugin_custom_dump_configure (snat_main_t * sm)
1942 #define _(n,f) sm->api_main->msg_print_handlers \
1943 [VL_API_##n + sm->msg_id_base] \
1944 = (void *) vl_api_##f##_t_print;
1945 foreach_snat_plugin_api_msg;
1951 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
1954 ip4_address_t * address,
1956 u32 if_address_index,
1959 static clib_error_t * snat_init (vlib_main_t * vm)
1961 snat_main_t * sm = &snat_main;
1962 clib_error_t * error = 0;
1963 ip4_main_t * im = &ip4_main;
1964 ip_lookup_main_t * lm = &im->lookup_main;
1967 vlib_thread_registration_t *tr;
1968 vlib_thread_main_t *tm = vlib_get_thread_main ();
1971 ip4_add_del_interface_address_callback_t cb4;
1973 name = format (0, "snat_%08x%c", api_version, 0);
1975 /* Ask for a correctly-sized block of API message decode slots */
1976 sm->msg_id_base = vl_msg_api_get_msg_ids
1977 ((char *) name, VL_MSG_FIRST_AVAILABLE);
1980 sm->vnet_main = vnet_get_main();
1982 sm->ip4_lookup_main = lm;
1983 sm->api_main = &api_main;
1984 sm->first_worker_index = 0;
1985 sm->next_worker = 0;
1986 sm->num_workers = 0;
1988 sm->fq_in2out_index = ~0;
1989 sm->fq_out2in_index = ~0;
1990 sm->udp_timeout = SNAT_UDP_TIMEOUT;
1991 sm->tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
1992 sm->tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
1993 sm->icmp_timeout = SNAT_ICMP_TIMEOUT;
1995 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1998 tr = (vlib_thread_registration_t *) p[0];
2001 sm->num_workers = tr->count;
2002 sm->first_worker_index = tr->first_index;
2006 /* Use all available workers by default */
2007 if (sm->num_workers > 1)
2009 for (i=0; i < sm->num_workers; i++)
2010 bitmap = clib_bitmap_set (bitmap, i, 1);
2011 snat_set_workers(bitmap);
2012 clib_bitmap_free (bitmap);
2015 error = snat_plugin_api_hookup (vm);
2017 /* Add our API messages to the global name_crc hash table */
2018 setup_message_id_table (sm, &api_main);
2020 plugin_custom_dump_configure (sm);
2023 /* Set up the interface address add/del callback */
2024 cb4.function = snat_ip4_add_del_interface_address_cb;
2025 cb4.function_opaque = 0;
2027 vec_add1 (im->add_del_interface_address_callbacks, cb4);
2029 /* Init IPFIX logging */
2030 snat_ipfix_logging_init(vm);
2035 VLIB_INIT_FUNCTION (snat_init);
2037 void snat_free_outside_address_and_port (snat_main_t * sm,
2038 snat_session_key_t * k,
2042 u16 port_host_byte_order = clib_net_to_host_u16 (k->port);
2044 ASSERT (address_index < vec_len (sm->addresses));
2046 a = sm->addresses + address_index;
2048 switch (k->protocol)
2050 #define _(N, i, n, s) \
2051 case SNAT_PROTOCOL_##N: \
2052 ASSERT (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, \
2053 port_host_byte_order) == 1); \
2054 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, \
2055 port_host_byte_order, 0); \
2056 a->busy_##n##_ports--; \
2058 foreach_snat_protocol
2061 clib_warning("unknown_protocol");
2067 * @brief Match SNAT static mapping.
2069 * @param sm SNAT main.
2070 * @param match Address and port to match.
2071 * @param mapping External or local address and port of the matched mapping.
2072 * @param by_external If 0 match by local address otherwise match by external
2074 * @param is_addr_only If matched mapping is address only
2076 * @returns 0 if match found otherwise 1.
2078 int snat_static_mapping_match (snat_main_t * sm,
2079 snat_session_key_t match,
2080 snat_session_key_t * mapping,
2084 clib_bihash_kv_8_8_t kv, value;
2085 snat_static_mapping_t *m;
2086 snat_session_key_t m_key;
2087 clib_bihash_8_8_t *mapping_hash = &sm->static_mapping_by_local;
2090 mapping_hash = &sm->static_mapping_by_external;
2092 m_key.addr = match.addr;
2093 m_key.port = clib_net_to_host_u16 (match.port);
2094 m_key.protocol = match.protocol;
2095 m_key.fib_index = match.fib_index;
2097 kv.key = m_key.as_u64;
2099 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2101 /* Try address only mapping */
2104 kv.key = m_key.as_u64;
2105 if (clib_bihash_search_8_8 (mapping_hash, &kv, &value))
2109 m = pool_elt_at_index (sm->static_mappings, value.value);
2113 mapping->addr = m->local_addr;
2114 /* Address only mapping doesn't change port */
2115 mapping->port = m->addr_only ? match.port
2116 : clib_host_to_net_u16 (m->local_port);
2117 mapping->fib_index = m->fib_index;
2121 mapping->addr = m->external_addr;
2122 /* Address only mapping doesn't change port */
2123 mapping->port = m->addr_only ? match.port
2124 : clib_host_to_net_u16 (m->external_port);
2125 mapping->fib_index = sm->outside_fib_index;
2128 if (PREDICT_FALSE(is_addr_only != 0))
2129 *is_addr_only = m->addr_only;
2134 int snat_alloc_outside_address_and_port (snat_main_t * sm,
2136 snat_session_key_t * k,
2137 u32 * address_indexp)
2143 for (i = 0; i < vec_len (sm->addresses); i++)
2145 a = sm->addresses + i;
2146 if (sm->vrf_mode && a->fib_index != ~0 && a->fib_index != fib_index)
2148 switch (k->protocol)
2150 #define _(N, j, n, s) \
2151 case SNAT_PROTOCOL_##N: \
2152 if (a->busy_##n##_ports < (65535-1024)) \
2156 portnum = random_u32 (&sm->random_seed); \
2157 portnum &= 0xFFFF; \
2158 if (portnum < 1024) \
2160 if (clib_bitmap_get_no_check (a->busy_##n##_port_bitmap, portnum)) \
2162 clib_bitmap_set_no_check (a->busy_##n##_port_bitmap, portnum, 1); \
2163 a->busy_##n##_ports++; \
2164 k->addr = a->addr; \
2165 k->port = clib_host_to_net_u16(portnum); \
2166 *address_indexp = i; \
2171 foreach_snat_protocol
2174 clib_warning("unknown protocol");
2179 /* Totally out of translations to use... */
2180 snat_ipfix_logging_addresses_exhausted(0);
2185 static clib_error_t *
2186 add_address_command_fn (vlib_main_t * vm,
2187 unformat_input_t * input,
2188 vlib_cli_command_t * cmd)
2190 unformat_input_t _line_input, *line_input = &_line_input;
2191 snat_main_t * sm = &snat_main;
2192 ip4_address_t start_addr, end_addr, this_addr;
2193 u32 start_host_order, end_host_order;
2198 clib_error_t *error = 0;
2200 /* Get a line of input. */
2201 if (!unformat_user (input, unformat_line_input, line_input))
2204 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2206 if (unformat (line_input, "%U - %U",
2207 unformat_ip4_address, &start_addr,
2208 unformat_ip4_address, &end_addr))
2210 else if (unformat (line_input, "tenant-vrf %u", &vrf_id))
2212 else if (unformat (line_input, "%U", unformat_ip4_address, &start_addr))
2213 end_addr = start_addr;
2214 else if (unformat (line_input, "del"))
2218 error = clib_error_return (0, "unknown input '%U'",
2219 format_unformat_error, line_input);
2224 if (sm->static_mapping_only)
2226 error = clib_error_return (0, "static mapping only mode");
2230 start_host_order = clib_host_to_net_u32 (start_addr.as_u32);
2231 end_host_order = clib_host_to_net_u32 (end_addr.as_u32);
2233 if (end_host_order < start_host_order)
2235 error = clib_error_return (0, "end address less than start address");
2239 count = (end_host_order - start_host_order) + 1;
2242 clib_warning ("%U - %U, %d addresses...",
2243 format_ip4_address, &start_addr,
2244 format_ip4_address, &end_addr,
2247 this_addr = start_addr;
2249 for (i = 0; i < count; i++)
2252 snat_add_address (sm, &this_addr, vrf_id);
2254 rv = snat_del_address (sm, this_addr, 0);
2258 case VNET_API_ERROR_NO_SUCH_ENTRY:
2259 error = clib_error_return (0, "S-NAT address not exist.");
2261 case VNET_API_ERROR_UNSPECIFIED:
2262 error = clib_error_return (0, "S-NAT address used in static mapping.");
2268 increment_v4_address (&this_addr);
2272 unformat_free (line_input);
2277 VLIB_CLI_COMMAND (add_address_command, static) = {
2278 .path = "snat add address",
2279 .short_help = "snat add addresses <ip4-range-start> [- <ip4-range-end>] "
2280 "[tenant-vrf <vrf-id>] [del]",
2281 .function = add_address_command_fn,
2284 static clib_error_t *
2285 snat_feature_command_fn (vlib_main_t * vm,
2286 unformat_input_t * input,
2287 vlib_cli_command_t * cmd)
2289 unformat_input_t _line_input, *line_input = &_line_input;
2290 vnet_main_t * vnm = vnet_get_main();
2291 clib_error_t * error = 0;
2293 u32 * inside_sw_if_indices = 0;
2294 u32 * outside_sw_if_indices = 0;
2300 /* Get a line of input. */
2301 if (!unformat_user (input, unformat_line_input, line_input))
2304 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2306 if (unformat (line_input, "in %U", unformat_vnet_sw_interface,
2308 vec_add1 (inside_sw_if_indices, sw_if_index);
2309 else if (unformat (line_input, "out %U", unformat_vnet_sw_interface,
2311 vec_add1 (outside_sw_if_indices, sw_if_index);
2312 else if (unformat (line_input, "del"))
2316 error = clib_error_return (0, "unknown input '%U'",
2317 format_unformat_error, line_input);
2322 if (vec_len (inside_sw_if_indices))
2324 for (i = 0; i < vec_len(inside_sw_if_indices); i++)
2326 sw_if_index = inside_sw_if_indices[i];
2327 snat_interface_add_del (sw_if_index, 1, is_del);
2331 if (vec_len (outside_sw_if_indices))
2333 for (i = 0; i < vec_len(outside_sw_if_indices); i++)
2335 sw_if_index = outside_sw_if_indices[i];
2336 snat_interface_add_del (sw_if_index, 0, is_del);
2341 unformat_free (line_input);
2342 vec_free (inside_sw_if_indices);
2343 vec_free (outside_sw_if_indices);
2348 VLIB_CLI_COMMAND (set_interface_snat_command, static) = {
2349 .path = "set interface snat",
2350 .function = snat_feature_command_fn,
2351 .short_help = "set interface snat in <intfc> out <intfc> [del]",
2355 unformat_snat_protocol (unformat_input_t * input, va_list * args)
2357 u32 *r = va_arg (*args, u32 *);
2360 #define _(N, i, n, s) else if (unformat (input, s)) *r = SNAT_PROTOCOL_##N;
2361 foreach_snat_protocol
2369 format_snat_protocol (u8 * s, va_list * args)
2371 u32 i = va_arg (*args, u32);
2376 #define _(N, j, n, str) case SNAT_PROTOCOL_##N: t = (u8 *) str; break;
2377 foreach_snat_protocol
2380 s = format (s, "unknown");
2382 s = format (s, "%s", t);
2386 static clib_error_t *
2387 add_static_mapping_command_fn (vlib_main_t * vm,
2388 unformat_input_t * input,
2389 vlib_cli_command_t * cmd)
2391 unformat_input_t _line_input, *line_input = &_line_input;
2392 clib_error_t * error = 0;
2393 ip4_address_t l_addr, e_addr;
2394 u32 l_port = 0, e_port = 0, vrf_id = ~0;
2397 u32 sw_if_index = ~0;
2398 vnet_main_t * vnm = vnet_get_main();
2400 snat_protocol_t proto;
2403 /* Get a line of input. */
2404 if (!unformat_user (input, unformat_line_input, line_input))
2407 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2409 if (unformat (line_input, "local %U %u", unformat_ip4_address, &l_addr,
2412 else if (unformat (line_input, "local %U", unformat_ip4_address, &l_addr))
2414 else if (unformat (line_input, "external %U %u", unformat_ip4_address,
2417 else if (unformat (line_input, "external %U", unformat_ip4_address,
2420 else if (unformat (line_input, "external %U %u",
2421 unformat_vnet_sw_interface, vnm, &sw_if_index,
2425 else if (unformat (line_input, "external %U",
2426 unformat_vnet_sw_interface, vnm, &sw_if_index))
2428 else if (unformat (line_input, "vrf %u", &vrf_id))
2430 else if (unformat (line_input, "%U", unformat_snat_protocol, &proto))
2432 else if (unformat (line_input, "del"))
2436 error = clib_error_return (0, "unknown input: '%U'",
2437 format_unformat_error, line_input);
2442 if (!addr_only && !proto_set)
2444 error = clib_error_return (0, "missing protocol");
2448 rv = snat_add_static_mapping(l_addr, e_addr, (u16) l_port, (u16) e_port,
2449 vrf_id, addr_only, sw_if_index, proto, is_add);
2453 case VNET_API_ERROR_INVALID_VALUE:
2454 error = clib_error_return (0, "External port already in use.");
2456 case VNET_API_ERROR_NO_SUCH_ENTRY:
2458 error = clib_error_return (0, "External addres must be allocated.");
2460 error = clib_error_return (0, "Mapping not exist.");
2462 case VNET_API_ERROR_NO_SUCH_FIB:
2463 error = clib_error_return (0, "No such VRF id.");
2465 case VNET_API_ERROR_VALUE_EXIST:
2466 error = clib_error_return (0, "Mapping already exist.");
2473 unformat_free (line_input);
2480 * @cliexstart{snat add static mapping}
2481 * Static mapping allows hosts on the external network to initiate connection
2482 * to to the local network host.
2483 * To create static mapping between local host address 10.0.0.3 port 6303 and
2484 * external address 4.4.4.4 port 3606 for TCP protocol use:
2485 * vpp# snat add static mapping local tcp 10.0.0.3 6303 external 4.4.4.4 3606
2486 * If not runnig "static mapping only" S-NAT plugin mode use before:
2487 * vpp# snat add address 4.4.4.4
2488 * To create static mapping between local and external address use:
2489 * vpp# snat add static mapping local 10.0.0.3 external 4.4.4.4
2492 VLIB_CLI_COMMAND (add_static_mapping_command, static) = {
2493 .path = "snat add static mapping",
2494 .function = add_static_mapping_command_fn,
2496 "snat add static mapping local tcp|udp|icmp <addr> [<port>] external <addr> [<port>] [vrf <table-id>] [del]",
2499 static clib_error_t *
2500 set_workers_command_fn (vlib_main_t * vm,
2501 unformat_input_t * input,
2502 vlib_cli_command_t * cmd)
2504 unformat_input_t _line_input, *line_input = &_line_input;
2507 clib_error_t *error = 0;
2509 /* Get a line of input. */
2510 if (!unformat_user (input, unformat_line_input, line_input))
2513 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2515 if (unformat (line_input, "%U", unformat_bitmap_list, &bitmap))
2519 error = clib_error_return (0, "unknown input '%U'",
2520 format_unformat_error, line_input);
2527 error = clib_error_return (0, "List of workers must be specified.");
2531 rv = snat_set_workers(bitmap);
2533 clib_bitmap_free (bitmap);
2537 case VNET_API_ERROR_INVALID_WORKER:
2538 error = clib_error_return (0, "Invalid worker(s).");
2540 case VNET_API_ERROR_FEATURE_DISABLED:
2541 error = clib_error_return (0,
2542 "Supported only if 2 or more workes available.");
2549 unformat_free (line_input);
2556 * @cliexstart{set snat workers}
2557 * Set SNAT workers if 2 or more workers available, use:
2558 * vpp# set snat workers 0-2,5
2561 VLIB_CLI_COMMAND (set_workers_command, static) = {
2562 .path = "set snat workers",
2563 .function = set_workers_command_fn,
2565 "set snat workers <workers-list>",
2568 static clib_error_t *
2569 snat_ipfix_logging_enable_disable_command_fn (vlib_main_t * vm,
2570 unformat_input_t * input,
2571 vlib_cli_command_t * cmd)
2573 unformat_input_t _line_input, *line_input = &_line_input;
2578 clib_error_t *error = 0;
2580 /* Get a line of input. */
2581 if (!unformat_user (input, unformat_line_input, line_input))
2584 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2586 if (unformat (line_input, "domain %d", &domain_id))
2588 else if (unformat (line_input, "src-port %d", &src_port))
2590 else if (unformat (line_input, "disable"))
2594 error = clib_error_return (0, "unknown input '%U'",
2595 format_unformat_error, line_input);
2600 rv = snat_ipfix_logging_enable_disable (enable, domain_id, (u16) src_port);
2604 error = clib_error_return (0, "ipfix logging enable failed");
2609 unformat_free (line_input);
2616 * @cliexstart{snat ipfix logging}
2617 * To enable SNAT IPFIX logging use:
2618 * vpp# snat ipfix logging
2619 * To set IPFIX exporter use:
2620 * vpp# set ipfix exporter collector 10.10.10.3 src 10.10.10.1
2623 VLIB_CLI_COMMAND (snat_ipfix_logging_enable_disable_command, static) = {
2624 .path = "snat ipfix logging",
2625 .function = snat_ipfix_logging_enable_disable_command_fn,
2626 .short_help = "snat ipfix logging [domain <domain-id>] [src-port <port>] [disable]",
2630 snat_get_worker_in2out_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2632 snat_main_t *sm = &snat_main;
2633 snat_user_key_t key0;
2634 clib_bihash_kv_8_8_t kv0, value0;
2635 u32 next_worker_index = 0;
2637 key0.addr = ip0->src_address;
2638 key0.fib_index = rx_fib_index0;
2640 kv0.key = key0.as_u64;
2642 /* Ever heard of of the "user" before? */
2643 if (clib_bihash_search_8_8 (&sm->worker_by_in, &kv0, &value0))
2645 /* No, assign next available worker (RR) */
2646 next_worker_index = sm->first_worker_index;
2647 if (vec_len (sm->workers))
2649 next_worker_index +=
2650 sm->workers[sm->next_worker++ % _vec_len (sm->workers)];
2653 /* add non-traslated packets worker lookup */
2654 kv0.value = next_worker_index;
2655 clib_bihash_add_del_8_8 (&sm->worker_by_in, &kv0, 1);
2658 next_worker_index = value0.value;
2660 return next_worker_index;
2664 snat_get_worker_out2in_cb (ip4_header_t * ip0, u32 rx_fib_index0)
2666 snat_main_t *sm = &snat_main;
2667 snat_worker_key_t key0;
2668 clib_bihash_kv_8_8_t kv0, value0;
2669 udp_header_t * udp0;
2670 u32 next_worker_index = 0;
2672 udp0 = ip4_next_header (ip0);
2674 key0.addr = ip0->dst_address;
2675 key0.port = udp0->dst_port;
2676 key0.fib_index = rx_fib_index0;
2678 if (PREDICT_FALSE(ip0->protocol == IP_PROTOCOL_ICMP))
2680 icmp46_header_t * icmp0 = (icmp46_header_t *) udp0;
2681 icmp_echo_header_t *echo0 = (icmp_echo_header_t *)(icmp0+1);
2682 key0.port = echo0->identifier;
2685 kv0.key = key0.as_u64;
2687 /* Ever heard of of the "user" before? */
2688 if (clib_bihash_search_8_8 (&sm->worker_by_out, &kv0, &value0))
2691 kv0.key = key0.as_u64;
2693 if (clib_bihash_search_8_8 (&sm->worker_by_out, &kv0, &value0))
2695 /* No, assign next available worker (RR) */
2696 next_worker_index = sm->first_worker_index;
2697 if (vec_len (sm->workers))
2699 next_worker_index +=
2700 sm->workers[sm->next_worker++ % _vec_len (sm->workers)];
2705 /* Static mapping without port */
2706 next_worker_index = value0.value;
2709 /* Add to translated packets worker lookup */
2710 kv0.value = next_worker_index;
2711 clib_bihash_add_del_8_8 (&sm->worker_by_out, &kv0, 1);
2714 next_worker_index = value0.value;
2716 return next_worker_index;
2719 static clib_error_t *
2720 snat_config (vlib_main_t * vm, unformat_input_t * input)
2722 snat_main_t * sm = &snat_main;
2723 u32 translation_buckets = 1024;
2724 u32 translation_memory_size = 128<<20;
2725 u32 user_buckets = 128;
2726 u32 user_memory_size = 64<<20;
2727 u32 max_translations_per_user = 100;
2728 u32 outside_vrf_id = 0;
2729 u32 inside_vrf_id = 0;
2730 u32 static_mapping_buckets = 1024;
2731 u32 static_mapping_memory_size = 64<<20;
2732 u8 static_mapping_only = 0;
2733 u8 static_mapping_connection_tracking = 0;
2734 vlib_thread_main_t *tm = vlib_get_thread_main ();
2736 sm->deterministic = 0;
2738 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2740 if (unformat (input, "translation hash buckets %d", &translation_buckets))
2742 else if (unformat (input, "translation hash memory %d",
2743 &translation_memory_size));
2744 else if (unformat (input, "user hash buckets %d", &user_buckets))
2746 else if (unformat (input, "user hash memory %d",
2749 else if (unformat (input, "max translations per user %d",
2750 &max_translations_per_user))
2752 else if (unformat (input, "outside VRF id %d",
2755 else if (unformat (input, "inside VRF id %d",
2758 else if (unformat (input, "static mapping only"))
2760 static_mapping_only = 1;
2761 if (unformat (input, "connection tracking"))
2762 static_mapping_connection_tracking = 1;
2764 else if (unformat (input, "deterministic"))
2765 sm->deterministic = 1;
2767 return clib_error_return (0, "unknown input '%U'",
2768 format_unformat_error, input);
2771 /* for show commands, etc. */
2772 sm->translation_buckets = translation_buckets;
2773 sm->translation_memory_size = translation_memory_size;
2774 sm->user_buckets = user_buckets;
2775 sm->user_memory_size = user_memory_size;
2776 sm->max_translations_per_user = max_translations_per_user;
2777 sm->outside_vrf_id = outside_vrf_id;
2778 sm->outside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2780 sm->inside_vrf_id = inside_vrf_id;
2781 sm->inside_fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2783 sm->static_mapping_only = static_mapping_only;
2784 sm->static_mapping_connection_tracking = static_mapping_connection_tracking;
2786 if (sm->deterministic)
2788 sm->in2out_node_index = snat_det_in2out_node.index;
2789 sm->out2in_node_index = snat_det_out2in_node.index;
2790 sm->icmp_match_in2out_cb = icmp_match_in2out_det;
2791 sm->icmp_match_out2in_cb = icmp_match_out2in_det;
2795 sm->worker_in2out_cb = snat_get_worker_in2out_cb;
2796 sm->worker_out2in_cb = snat_get_worker_out2in_cb;
2797 sm->in2out_node_index = snat_in2out_node.index;
2798 sm->out2in_node_index = snat_out2in_node.index;
2799 if (!static_mapping_only ||
2800 (static_mapping_only && static_mapping_connection_tracking))
2802 sm->icmp_match_in2out_cb = icmp_match_in2out_slow;
2803 sm->icmp_match_out2in_cb = icmp_match_out2in_slow;
2805 clib_bihash_init_8_8 (&sm->worker_by_in, "worker-by-in", user_buckets,
2808 clib_bihash_init_8_8 (&sm->worker_by_out, "worker-by-out", user_buckets,
2811 vec_validate (sm->per_thread_data, tm->n_vlib_mains - 1);
2813 clib_bihash_init_8_8 (&sm->in2out, "in2out", translation_buckets,
2814 translation_memory_size);
2816 clib_bihash_init_8_8 (&sm->out2in, "out2in", translation_buckets,
2817 translation_memory_size);
2819 clib_bihash_init_8_8 (&sm->user_hash, "users", user_buckets,
2824 sm->icmp_match_in2out_cb = icmp_match_in2out_fast;
2825 sm->icmp_match_out2in_cb = icmp_match_out2in_fast;
2827 clib_bihash_init_8_8 (&sm->static_mapping_by_local,
2828 "static_mapping_by_local", static_mapping_buckets,
2829 static_mapping_memory_size);
2831 clib_bihash_init_8_8 (&sm->static_mapping_by_external,
2832 "static_mapping_by_external", static_mapping_buckets,
2833 static_mapping_memory_size);
2839 VLIB_CONFIG_FUNCTION (snat_config, "snat");
2841 u8 * format_snat_session_state (u8 * s, va_list * args)
2843 u32 i = va_arg (*args, u32);
2848 #define _(v, N, str) case SNAT_SESSION_##N: t = (u8 *) str; break;
2849 foreach_snat_session_state
2852 t = format (t, "unknown");
2854 s = format (s, "%s", t);
2858 u8 * format_snat_key (u8 * s, va_list * args)
2860 snat_session_key_t * key = va_arg (*args, snat_session_key_t *);
2861 char * protocol_string = "unknown";
2862 static char *protocol_strings[] = {
2868 if (key->protocol < ARRAY_LEN(protocol_strings))
2869 protocol_string = protocol_strings[key->protocol];
2871 s = format (s, "%U proto %s port %d fib %d",
2872 format_ip4_address, &key->addr, protocol_string,
2873 clib_net_to_host_u16 (key->port), key->fib_index);
2877 u8 * format_snat_session (u8 * s, va_list * args)
2879 snat_main_t * sm __attribute__((unused)) = va_arg (*args, snat_main_t *);
2880 snat_session_t * sess = va_arg (*args, snat_session_t *);
2882 s = format (s, " i2o %U\n", format_snat_key, &sess->in2out);
2883 s = format (s, " o2i %U\n", format_snat_key, &sess->out2in);
2884 s = format (s, " last heard %.2f\n", sess->last_heard);
2885 s = format (s, " total pkts %d, total bytes %lld\n",
2886 sess->total_pkts, sess->total_bytes);
2887 if (snat_is_session_static (sess))
2888 s = format (s, " static translation\n");
2890 s = format (s, " dynamic translation\n");
2895 u8 * format_snat_user (u8 * s, va_list * args)
2897 snat_main_per_thread_data_t * sm = va_arg (*args, snat_main_per_thread_data_t *);
2898 snat_user_t * u = va_arg (*args, snat_user_t *);
2899 int verbose = va_arg (*args, int);
2900 dlist_elt_t * head, * elt;
2901 u32 elt_index, head_index;
2903 snat_session_t * sess;
2905 s = format (s, "%U: %d dynamic translations, %d static translations\n",
2906 format_ip4_address, &u->addr, u->nsessions, u->nstaticsessions);
2911 if (u->nsessions || u->nstaticsessions)
2913 head_index = u->sessions_per_user_list_head_index;
2914 head = pool_elt_at_index (sm->list_pool, head_index);
2916 elt_index = head->next;
2917 elt = pool_elt_at_index (sm->list_pool, elt_index);
2918 session_index = elt->value;
2920 while (session_index != ~0)
2922 sess = pool_elt_at_index (sm->sessions, session_index);
2924 s = format (s, " %U\n", format_snat_session, sm, sess);
2926 elt_index = elt->next;
2927 elt = pool_elt_at_index (sm->list_pool, elt_index);
2928 session_index = elt->value;
2935 u8 * format_snat_static_mapping (u8 * s, va_list * args)
2937 snat_static_mapping_t *m = va_arg (*args, snat_static_mapping_t *);
2940 s = format (s, "local %U external %U vrf %d",
2941 format_ip4_address, &m->local_addr,
2942 format_ip4_address, &m->external_addr,
2945 s = format (s, "%U local %U:%d external %U:%d vrf %d",
2946 format_snat_protocol, m->proto,
2947 format_ip4_address, &m->local_addr, m->local_port,
2948 format_ip4_address, &m->external_addr, m->external_port,
2954 u8 * format_snat_static_map_to_resolve (u8 * s, va_list * args)
2956 snat_static_map_resolve_t *m = va_arg (*args, snat_static_map_resolve_t *);
2957 vnet_main_t *vnm = vnet_get_main();
2960 s = format (s, "local %U external %U vrf %d",
2961 format_ip4_address, &m->l_addr,
2962 format_vnet_sw_interface_name, vnm,
2963 vnet_get_sw_interface (vnm, m->sw_if_index),
2966 s = format (s, "%U local %U:%d external %U:%d vrf %d",
2967 format_snat_protocol, m->proto,
2968 format_ip4_address, &m->l_addr, m->l_port,
2969 format_vnet_sw_interface_name, vnm,
2970 vnet_get_sw_interface (vnm, m->sw_if_index), m->e_port,
2976 u8 * format_det_map_ses (u8 * s, va_list * args)
2978 snat_det_map_t * det_map = va_arg (*args, snat_det_map_t *);
2979 ip4_address_t in_addr, out_addr;
2980 u32 in_offset, out_offset;
2981 snat_det_session_t * ses = va_arg (*args, snat_det_session_t *);
2982 u32 * i = va_arg (*args, u32 *);
2984 u32 user_index = *i / SNAT_DET_SES_PER_USER;
2985 in_addr.as_u32 = clib_host_to_net_u32 (
2986 clib_net_to_host_u32(det_map->in_addr.as_u32) + user_index);
2987 in_offset = clib_net_to_host_u32(in_addr.as_u32) -
2988 clib_net_to_host_u32(det_map->in_addr.as_u32);
2989 out_offset = in_offset / det_map->sharing_ratio;
2990 out_addr.as_u32 = clib_host_to_net_u32(
2991 clib_net_to_host_u32(det_map->out_addr.as_u32) + out_offset);
2992 s = format (s, "in %U:%d out %U:%d external host %U:%d state: %U expire: %d\n",
2993 format_ip4_address, &in_addr,
2994 clib_net_to_host_u16 (ses->in_port),
2995 format_ip4_address, &out_addr,
2996 clib_net_to_host_u16 (ses->out.out_port),
2997 format_ip4_address, &ses->out.ext_host_addr,
2998 clib_net_to_host_u16 (ses->out.ext_host_port),
2999 format_snat_session_state, ses->state,
3005 static clib_error_t *
3006 show_snat_command_fn (vlib_main_t * vm,
3007 unformat_input_t * input,
3008 vlib_cli_command_t * cmd)
3011 snat_main_t * sm = &snat_main;
3013 snat_static_mapping_t *m;
3014 snat_interface_t *i;
3015 snat_address_t * ap;
3016 vnet_main_t *vnm = vnet_get_main();
3017 snat_main_per_thread_data_t *tsm;
3018 u32 users_num = 0, sessions_num = 0, *worker, *sw_if_index;
3020 snat_static_map_resolve_t *rp;
3021 snat_det_map_t * dm;
3022 snat_det_session_t * ses;
3024 if (unformat (input, "detail"))
3026 else if (unformat (input, "verbose"))
3029 if (sm->static_mapping_only)
3031 if (sm->static_mapping_connection_tracking)
3032 vlib_cli_output (vm, "SNAT mode: static mapping only connection "
3035 vlib_cli_output (vm, "SNAT mode: static mapping only");
3037 else if (sm->deterministic)
3039 vlib_cli_output (vm, "SNAT mode: deterministic mapping");
3043 vlib_cli_output (vm, "SNAT mode: dynamic translations enabled");
3048 pool_foreach (i, sm->interfaces,
3050 vlib_cli_output (vm, "%U %s", format_vnet_sw_interface_name, vnm,
3051 vnet_get_sw_interface (vnm, i->sw_if_index),
3052 i->is_inside ? "in" : "out");
3055 if (vec_len (sm->auto_add_sw_if_indices))
3057 vlib_cli_output (vm, "SNAT pool addresses interfaces:");
3058 vec_foreach (sw_if_index, sm->auto_add_sw_if_indices)
3060 vlib_cli_output (vm, "%U", format_vnet_sw_interface_name, vnm,
3061 vnet_get_sw_interface (vnm, *sw_if_index));
3065 vec_foreach (ap, sm->addresses)
3067 vlib_cli_output (vm, "%U", format_ip4_address, &ap->addr);
3068 if (ap->fib_index != ~0)
3069 vlib_cli_output (vm, " tenant VRF: %u",
3070 ip4_fib_get(ap->fib_index)->table_id);
3072 vlib_cli_output (vm, " tenant VRF independent");
3073 #define _(N, i, n, s) \
3074 vlib_cli_output (vm, " %d busy %s ports", ap->busy_##n##_ports, s);
3075 foreach_snat_protocol
3080 if (sm->num_workers > 1)
3082 vlib_cli_output (vm, "%d workers", vec_len (sm->workers));
3085 vec_foreach (worker, sm->workers)
3087 vlib_worker_thread_t *w =
3088 vlib_worker_threads + *worker + sm->first_worker_index;
3089 vlib_cli_output (vm, " %s", w->name);
3094 if (sm->deterministic)
3096 vlib_cli_output (vm, "udp timeout: %dsec", sm->udp_timeout);
3097 vlib_cli_output (vm, "tcp-established timeout: %dsec",
3098 sm->tcp_established_timeout);
3099 vlib_cli_output (vm, "tcp-transitory timeout: %dsec",
3100 sm->tcp_transitory_timeout);
3101 vlib_cli_output (vm, "icmp timeout: %dsec", sm->icmp_timeout);
3102 vlib_cli_output (vm, "%d deterministic mappings",
3103 pool_elts (sm->det_maps));
3106 pool_foreach (dm, sm->det_maps,
3108 vlib_cli_output (vm, "in %U/%d out %U/%d\n",
3109 format_ip4_address, &dm->in_addr, dm->in_plen,
3110 format_ip4_address, &dm->out_addr, dm->out_plen);
3111 vlib_cli_output (vm, " outside address sharing ratio: %d\n",
3113 vlib_cli_output (vm, " number of ports per inside host: %d\n",
3114 dm->ports_per_host);
3115 vlib_cli_output (vm, " sessions number: %d\n", dm->ses_num);
3118 vec_foreach_index (j, dm->sessions)
3120 ses = vec_elt_at_index (dm->sessions, j);
3122 vlib_cli_output (vm, " %U", format_det_map_ses, dm, ses,
3131 if (sm->static_mapping_only && !(sm->static_mapping_connection_tracking))
3133 vlib_cli_output (vm, "%d static mappings",
3134 pool_elts (sm->static_mappings));
3138 pool_foreach (m, sm->static_mappings,
3140 vlib_cli_output (vm, "%U", format_snat_static_mapping, m);
3146 vec_foreach (tsm, sm->per_thread_data)
3148 users_num += pool_elts (tsm->users);
3149 sessions_num += pool_elts (tsm->sessions);
3152 vlib_cli_output (vm, "%d users, %d outside addresses, %d active sessions,"
3153 " %d static mappings",
3155 vec_len (sm->addresses),
3157 pool_elts (sm->static_mappings));
3161 vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->in2out,
3163 vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->out2in,
3165 vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->worker_by_in,
3167 vlib_cli_output (vm, "%U", format_bihash_8_8, &sm->worker_by_out,
3169 vec_foreach_index (j, sm->per_thread_data)
3171 tsm = vec_elt_at_index (sm->per_thread_data, j);
3173 if (pool_elts (tsm->users) == 0)
3176 vlib_worker_thread_t *w = vlib_worker_threads + j;
3177 vlib_cli_output (vm, "Thread %d (%s at lcore %u):", j, w->name,
3179 vlib_cli_output (vm, " %d list pool elements",
3180 pool_elts (tsm->list_pool));
3182 pool_foreach (u, tsm->users,
3184 vlib_cli_output (vm, " %U", format_snat_user, tsm, u,
3189 if (pool_elts (sm->static_mappings))
3191 vlib_cli_output (vm, "static mappings:");
3192 pool_foreach (m, sm->static_mappings,
3194 vlib_cli_output (vm, "%U", format_snat_static_mapping, m);
3196 for (j = 0; j < vec_len (sm->to_resolve); j++)
3198 rp = sm->to_resolve + j;
3199 vlib_cli_output (vm, "%U",
3200 format_snat_static_map_to_resolve, rp);
3209 VLIB_CLI_COMMAND (show_snat_command, static) = {
3210 .path = "show snat",
3211 .short_help = "show snat",
3212 .function = show_snat_command_fn,
3217 snat_ip4_add_del_interface_address_cb (ip4_main_t * im,
3220 ip4_address_t * address,
3222 u32 if_address_index,
3225 snat_main_t *sm = &snat_main;
3226 snat_static_map_resolve_t *rp;
3227 u32 *indices_to_delete = 0;
3231 for (i = 0; i < vec_len(sm->auto_add_sw_if_indices); i++)
3233 if (sw_if_index == sm->auto_add_sw_if_indices[i])
3237 /* Don't trip over lease renewal, static config */
3238 for (j = 0; j < vec_len(sm->addresses); j++)
3239 if (sm->addresses[j].addr.as_u32 == address->as_u32)
3242 snat_add_address (sm, address, ~0);
3243 /* Scan static map resolution vector */
3244 for (j = 0; j < vec_len (sm->to_resolve); j++)
3246 rp = sm->to_resolve + j;
3247 /* On this interface? */
3248 if (rp->sw_if_index == sw_if_index)
3250 /* Add the static mapping */
3251 rv = snat_add_static_mapping (rp->l_addr,
3257 ~0 /* sw_if_index */,
3261 clib_warning ("snat_add_static_mapping returned %d",
3263 vec_add1 (indices_to_delete, j);
3266 /* If we resolved any of the outstanding static mappings */
3267 if (vec_len(indices_to_delete))
3270 for (j = vec_len(indices_to_delete)-1; j >= 0; j--)
3271 vec_delete(sm->to_resolve, 1, j);
3272 vec_free(indices_to_delete);
3278 (void) snat_del_address(sm, address[0], 1);
3286 static int snat_add_interface_address (snat_main_t *sm,
3290 ip4_main_t * ip4_main = sm->ip4_main;
3291 ip4_address_t * first_int_addr;
3292 snat_static_map_resolve_t *rp;
3293 u32 *indices_to_delete = 0;
3296 first_int_addr = ip4_interface_first_address (ip4_main, sw_if_index,
3297 0 /* just want the address*/);
3299 for (i = 0; i < vec_len(sm->auto_add_sw_if_indices); i++)
3301 if (sm->auto_add_sw_if_indices[i] == sw_if_index)
3305 /* if have address remove it */
3307 (void) snat_del_address (sm, first_int_addr[0], 1);
3310 for (j = 0; j < vec_len (sm->to_resolve); j++)
3312 rp = sm->to_resolve + j;
3313 if (rp->sw_if_index == sw_if_index)
3314 vec_add1 (indices_to_delete, j);
3316 if (vec_len(indices_to_delete))
3318 for (j = vec_len(indices_to_delete)-1; j >= 0; j--)
3319 vec_del1(sm->to_resolve, j);
3320 vec_free(indices_to_delete);
3323 vec_del1(sm->auto_add_sw_if_indices, i);
3326 return VNET_API_ERROR_VALUE_EXIST;
3333 return VNET_API_ERROR_NO_SUCH_ENTRY;
3335 /* add to the auto-address list */
3336 vec_add1(sm->auto_add_sw_if_indices, sw_if_index);
3338 /* If the address is already bound - or static - add it now */
3340 snat_add_address (sm, first_int_addr, ~0);
3345 static clib_error_t *
3346 snat_add_interface_address_command_fn (vlib_main_t * vm,
3347 unformat_input_t * input,
3348 vlib_cli_command_t * cmd)
3350 snat_main_t *sm = &snat_main;
3351 unformat_input_t _line_input, *line_input = &_line_input;
3355 clib_error_t *error = 0;
3357 /* Get a line of input. */
3358 if (!unformat_user (input, unformat_line_input, line_input))
3361 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3363 if (unformat (line_input, "%U", unformat_vnet_sw_interface,
3364 sm->vnet_main, &sw_if_index))
3366 else if (unformat (line_input, "del"))
3370 error = clib_error_return (0, "unknown input '%U'",
3371 format_unformat_error, line_input);
3376 rv = snat_add_interface_address (sm, sw_if_index, is_del);
3384 error = clib_error_return (0, "snat_add_interface_address returned %d",
3390 unformat_free (line_input);
3395 VLIB_CLI_COMMAND (snat_add_interface_address_command, static) = {
3396 .path = "snat add interface address",
3397 .short_help = "snat add interface address <interface> [del]",
3398 .function = snat_add_interface_address_command_fn,
3401 static clib_error_t *
3402 snat_det_map_command_fn (vlib_main_t * vm,
3403 unformat_input_t * input,
3404 vlib_cli_command_t * cmd)
3406 snat_main_t *sm = &snat_main;
3407 unformat_input_t _line_input, *line_input = &_line_input;
3408 ip4_address_t in_addr, out_addr;
3409 u32 in_plen, out_plen;
3411 clib_error_t *error = 0;
3413 /* Get a line of input. */
3414 if (!unformat_user (input, unformat_line_input, line_input))
3417 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3419 if (unformat (line_input, "in %U/%u", unformat_ip4_address, &in_addr, &in_plen))
3421 else if (unformat (line_input, "out %U/%u", unformat_ip4_address, &out_addr, &out_plen))
3423 else if (unformat (line_input, "del"))
3427 error = clib_error_return (0, "unknown input '%U'",
3428 format_unformat_error, line_input);
3433 unformat_free (line_input);
3435 rv = snat_det_add_map(sm, &in_addr, (u8) in_plen, &out_addr, (u8)out_plen,
3440 error = clib_error_return (0, "snat_det_add_map return %d", rv);
3445 unformat_free (line_input);
3452 * @cliexstart{snat deterministic add}
3453 * Create bijective mapping of inside address to outside address and port range
3454 * pairs, with the purpose of enabling deterministic NAT to reduce logging in
3456 * To create deterministic mapping between inside network 10.0.0.0/18 and
3457 * outside network 1.1.1.0/30 use:
3458 * # vpp# snat deterministic add in 10.0.0.0/18 out 1.1.1.0/30
3461 VLIB_CLI_COMMAND (snat_det_map_command, static) = {
3462 .path = "snat deterministic add",
3463 .short_help = "snat deterministic add in <addr>/<plen> out <addr>/<plen> [del]",
3464 .function = snat_det_map_command_fn,
3467 static clib_error_t *
3468 snat_det_forward_command_fn (vlib_main_t * vm,
3469 unformat_input_t * input,
3470 vlib_cli_command_t * cmd)
3472 snat_main_t *sm = &snat_main;
3473 unformat_input_t _line_input, *line_input = &_line_input;
3474 ip4_address_t in_addr, out_addr;
3476 snat_det_map_t * dm;
3477 clib_error_t *error = 0;
3479 /* Get a line of input. */
3480 if (!unformat_user (input, unformat_line_input, line_input))
3483 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3485 if (unformat (line_input, "%U", unformat_ip4_address, &in_addr))
3489 error = clib_error_return (0, "unknown input '%U'",
3490 format_unformat_error, line_input);
3495 unformat_free (line_input);
3497 dm = snat_det_map_by_user(sm, &in_addr);
3499 vlib_cli_output (vm, "no match");
3502 snat_det_forward (dm, &in_addr, &out_addr, &lo_port);
3503 vlib_cli_output (vm, "%U:<%d-%d>", format_ip4_address, &out_addr,
3504 lo_port, lo_port + dm->ports_per_host - 1);
3508 unformat_free (line_input);
3515 * @cliexstart{snat deterministic forward}
3516 * Return outside address and port range from inside address for deterministic
3518 * To obtain outside address and port of inside host use:
3519 * vpp# snat deterministic forward 10.0.0.2
3520 * 1.1.1.0:<1054-1068>
3523 VLIB_CLI_COMMAND (snat_det_forward_command, static) = {
3524 .path = "snat deterministic forward",
3525 .short_help = "snat deterministic forward <addr>",
3526 .function = snat_det_forward_command_fn,
3529 static clib_error_t *
3530 snat_det_reverse_command_fn (vlib_main_t * vm,
3531 unformat_input_t * input,
3532 vlib_cli_command_t * cmd)
3534 snat_main_t *sm = &snat_main;
3535 unformat_input_t _line_input, *line_input = &_line_input;
3536 ip4_address_t in_addr, out_addr;
3538 snat_det_map_t * dm;
3539 clib_error_t *error = 0;
3541 /* Get a line of input. */
3542 if (!unformat_user (input, unformat_line_input, line_input))
3545 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3547 if (unformat (line_input, "%U:%d", unformat_ip4_address, &out_addr, &out_port))
3551 error = clib_error_return (0, "unknown input '%U'",
3552 format_unformat_error, line_input);
3556 unformat_free (line_input);
3558 if (out_port < 1024 || out_port > 65535)
3560 error = clib_error_return (0, "wrong port, must be <1024-65535>");
3564 dm = snat_det_map_by_out(sm, &out_addr);
3566 vlib_cli_output (vm, "no match");
3569 snat_det_reverse (dm, &out_addr, (u16) out_port, &in_addr);
3570 vlib_cli_output (vm, "%U", format_ip4_address, &in_addr);
3574 unformat_free (line_input);
3581 * @cliexstart{snat deterministic reverse}
3582 * Return inside address from outside address and port for deterministic NAT.
3583 * To obtain inside host address from outside address and port use:
3584 * #vpp snat deterministic reverse 1.1.1.1:1276
3588 VLIB_CLI_COMMAND (snat_det_reverse_command, static) = {
3589 .path = "snat deterministic reverse",
3590 .short_help = "snat deterministic reverse <addr>:<port>",
3591 .function = snat_det_reverse_command_fn,
3594 static clib_error_t *
3595 set_timeout_command_fn (vlib_main_t * vm,
3596 unformat_input_t * input,
3597 vlib_cli_command_t * cmd)
3599 snat_main_t *sm = &snat_main;
3600 unformat_input_t _line_input, *line_input = &_line_input;
3601 clib_error_t *error = 0;
3603 /* Get a line of input. */
3604 if (!unformat_user (input, unformat_line_input, line_input))
3607 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3609 if (unformat (line_input, "udp %u", &sm->udp_timeout))
3611 else if (unformat (line_input, "tcp-established %u",
3612 &sm->tcp_established_timeout))
3614 else if (unformat (line_input, "tcp-transitory %u",
3615 &sm->tcp_transitory_timeout))
3617 else if (unformat (line_input, "icmp %u", &sm->icmp_timeout))
3619 else if (unformat (line_input, "reset"))
3621 sm->udp_timeout = SNAT_UDP_TIMEOUT;
3622 sm->tcp_established_timeout = SNAT_TCP_ESTABLISHED_TIMEOUT;
3623 sm->tcp_transitory_timeout = SNAT_TCP_TRANSITORY_TIMEOUT;
3624 sm->icmp_timeout = SNAT_ICMP_TIMEOUT;
3628 error = clib_error_return (0, "unknown input '%U'",
3629 format_unformat_error, line_input);
3634 unformat_free (line_input);
3637 unformat_free (line_input);
3644 * @cliexstart{set snat deterministic timeout}
3645 * Set values of timeouts for deterministic NAT (in seconds), use:
3646 * vpp# set snat deterministic timeout udp 120 tcp-established 7500
3647 * tcp-transitory 250 icmp 90
3648 * To reset default values use:
3649 * vpp# set snat deterministic timeout reset
3652 VLIB_CLI_COMMAND (set_timeout_command, static) = {
3653 .path = "set snat deterministic timeout",
3654 .function = set_timeout_command_fn,
3656 "set snat deterministic timeout [udp <sec> | tcp-established <sec> "
3657 "tcp-transitory <sec> | icmp <sec> | reset]",
3660 static clib_error_t *
3661 snat_det_close_session_out_fn (vlib_main_t *vm,
3662 unformat_input_t * input,
3663 vlib_cli_command_t * cmd)
3665 snat_main_t *sm = &snat_main;
3666 unformat_input_t _line_input, *line_input = &_line_input;
3667 ip4_address_t out_addr, ext_addr, in_addr;
3668 u16 out_port, ext_port;
3669 snat_det_map_t * dm;
3670 snat_det_session_t * ses;
3671 snat_det_out_key_t key;
3672 clib_error_t *error = 0;
3674 /* Get a line of input. */
3675 if (!unformat_user (input, unformat_line_input, line_input))
3678 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3680 if (unformat (line_input, "%U:%d %U:%d",
3681 unformat_ip4_address, &out_addr, &out_port,
3682 unformat_ip4_address, &ext_addr, &ext_port))
3686 error = clib_error_return (0, "unknown input '%U'",
3687 format_unformat_error, line_input);
3692 unformat_free (line_input);
3694 dm = snat_det_map_by_out(sm, &out_addr);
3696 vlib_cli_output (vm, "no match");
3699 snat_det_reverse(dm, &ext_addr, out_port, &in_addr);
3700 key.ext_host_addr = out_addr;
3701 key.ext_host_port = ntohs(ext_port);
3702 key.out_port = ntohs(out_port);
3703 ses = snat_det_get_ses_by_out(dm, &out_addr, key.as_u64);
3705 vlib_cli_output (vm, "no match");
3707 snat_det_ses_close(dm, ses);
3711 unformat_free (line_input);
3718 * @cliexstart{snat deterministic close session out}
3719 * Close session using outside ip address and port
3720 * and external ip address and port, use:
3721 * vpp# snat deterministic close session out 1.1.1.1:1276 2.2.2.2:2387
3724 VLIB_CLI_COMMAND (snat_det_close_sesion_out_command, static) = {
3725 .path = "snat deterministic close session out",
3726 .short_help = "snat deterministic close session out "
3727 "<out_addr>:<out_port> <ext_addr>:<ext_port>",
3728 .function = snat_det_close_session_out_fn,
3731 static clib_error_t *
3732 snat_det_close_session_in_fn (vlib_main_t *vm,
3733 unformat_input_t * input,
3734 vlib_cli_command_t * cmd)
3736 snat_main_t *sm = &snat_main;
3737 unformat_input_t _line_input, *line_input = &_line_input;
3738 ip4_address_t in_addr, ext_addr;
3739 u16 in_port, ext_port;
3740 snat_det_map_t * dm;
3741 snat_det_session_t * ses;
3742 snat_det_out_key_t key;
3743 clib_error_t *error = 0;
3745 /* Get a line of input. */
3746 if (!unformat_user (input, unformat_line_input, line_input))
3749 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3751 if (unformat (line_input, "%U:%d %U:%d",
3752 unformat_ip4_address, &in_addr, &in_port,
3753 unformat_ip4_address, &ext_addr, &ext_port))
3757 error = clib_error_return (0, "unknown input '%U'",
3758 format_unformat_error, line_input);
3763 unformat_free (line_input);
3765 dm = snat_det_map_by_user (sm, &in_addr);
3767 vlib_cli_output (vm, "no match");
3770 key.ext_host_addr = ext_addr;
3771 key.ext_host_port = ntohs (ext_port);
3772 ses = snat_det_find_ses_by_in (dm, &in_addr, ntohs(in_port), key);
3774 vlib_cli_output (vm, "no match");
3776 snat_det_ses_close(dm, ses);
3780 unformat_free(line_input);
3787 * @cliexstart{snat deterministic close_session_in}
3788 * Close session using inside ip address and port
3789 * and external ip address and port, use:
3790 * vpp# snat deterministic close session in 3.3.3.3:3487 2.2.2.2:2387
3793 VLIB_CLI_COMMAND (snat_det_close_session_in_command, static) = {
3794 .path = "snat deterministic close session in",
3795 .short_help = "snat deterministic close session in "
3796 "<in_addr>:<in_port> <ext_addr>:<ext_port>",
3797 .function = snat_det_close_session_in_fn,