2 * Copyright (c) 2020 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include <vnet/ip/ip_types_api.h>
18 #include <vlibmemory/api.h>
20 #include <vnet/fib/fib_table.h>
22 #include <nat/lib/nat_inlines.h>
23 #include <nat/lib/ipfix_logging.h>
25 #include <nat/nat44-ei/nat44_ei.api_enum.h>
26 #include <nat/nat44-ei/nat44_ei.api_types.h>
28 #include <nat/nat44-ei/nat44_ei_ha.h>
29 #include <nat/nat44-ei/nat44_ei.h>
31 #define REPLY_MSG_ID_BASE nm->msg_id_base
32 #include <vlibapi/api_helper_macros.h>
35 vl_api_nat44_ei_show_running_config_t_handler (
36 vl_api_nat44_ei_show_running_config_t *mp)
38 vl_api_nat44_ei_show_running_config_reply_t *rmp;
39 nat44_ei_main_t *nm = &nat44_ei_main;
40 nat44_ei_config_t *rc = &nm->rconfig;
44 VL_API_NAT44_EI_SHOW_RUNNING_CONFIG_REPLY, ({
45 rmp->inside_vrf = htonl (rc->inside_vrf);
46 rmp->outside_vrf = htonl (rc->outside_vrf);
47 rmp->users = htonl (rc->users);
48 rmp->sessions = htonl (rc->sessions);
49 rmp->user_sessions = htonl (rc->user_sessions);
51 rmp->user_buckets = htonl (nm->user_buckets);
52 rmp->translation_buckets = htonl (nm->translation_buckets);
54 rmp->timeouts.udp = htonl (nm->timeouts.udp);
55 rmp->timeouts.tcp_established = htonl (nm->timeouts.tcp.established);
56 rmp->timeouts.tcp_transitory = htonl (nm->timeouts.tcp.transitory);
57 rmp->timeouts.icmp = htonl (nm->timeouts.icmp);
59 rmp->forwarding_enabled = nm->forwarding_enabled == 1;
60 // consider how to split functionality between subplugins
61 rmp->ipfix_logging_enabled = nat_ipfix_logging_enabled ();
63 if (rc->static_mapping_only)
64 rmp->flags |= NAT44_EI_STATIC_MAPPING_ONLY;
65 if (rc->connection_tracking)
66 rmp->flags |= NAT44_EI_CONNECTION_TRACKING;
68 rmp->flags |= NAT44_EI_OUT2IN_DPO;
73 vl_api_nat44_ei_set_workers_t_handler (vl_api_nat44_ei_set_workers_t *mp)
75 nat44_ei_main_t *nm = &nat44_ei_main;
76 vl_api_nat44_ei_set_workers_reply_t *rmp;
81 mask = clib_net_to_host_u64 (mp->worker_mask);
83 if (nm->num_workers < 2)
85 rv = VNET_API_ERROR_FEATURE_DISABLED;
89 bitmap = clib_bitmap_set_multiple (bitmap, 0, mask, BITS (mask));
90 rv = nat44_ei_set_workers (bitmap);
91 clib_bitmap_free (bitmap);
94 REPLY_MACRO (VL_API_NAT44_EI_SET_WORKERS_REPLY);
98 send_nat_worker_details (u32 worker_index, vl_api_registration_t *reg,
101 vl_api_nat44_ei_worker_details_t *rmp;
102 nat44_ei_main_t *nm = &nat44_ei_main;
103 vlib_worker_thread_t *w =
104 vlib_worker_threads + worker_index + nm->first_worker_index;
106 rmp = vl_msg_api_alloc (sizeof (*rmp));
107 clib_memset (rmp, 0, sizeof (*rmp));
108 rmp->_vl_msg_id = ntohs (VL_API_NAT44_EI_WORKER_DETAILS + nm->msg_id_base);
109 rmp->context = context;
110 rmp->worker_index = htonl (worker_index);
111 rmp->lcore_id = htonl (w->cpu_id);
112 strncpy ((char *) rmp->name, (char *) w->name, ARRAY_LEN (rmp->name) - 1);
114 vl_api_send_msg (reg, (u8 *) rmp);
118 vl_api_nat44_ei_worker_dump_t_handler (vl_api_nat44_ei_worker_dump_t *mp)
120 vl_api_registration_t *reg;
121 nat44_ei_main_t *nm = &nat44_ei_main;
124 reg = vl_api_client_index_to_registration (mp->client_index);
128 vec_foreach (worker_index, nm->workers)
130 send_nat_worker_details (*worker_index, reg, mp->context);
135 vl_api_nat44_ei_set_log_level_t_handler (vl_api_nat44_ei_set_log_level_t *mp)
137 nat44_ei_main_t *nm = &nat44_ei_main;
138 vl_api_nat44_ei_set_log_level_reply_t *rmp;
141 if (nm->log_level > NAT_LOG_DEBUG)
142 rv = VNET_API_ERROR_UNSUPPORTED;
144 nm->log_level = mp->log_level;
146 REPLY_MACRO (VL_API_NAT44_EI_SET_LOG_LEVEL_REPLY);
150 vl_api_nat44_ei_plugin_enable_disable_t_handler (
151 vl_api_nat44_ei_plugin_enable_disable_t *mp)
153 nat44_ei_main_t *nm = &nat44_ei_main;
154 nat44_ei_config_t c = { 0 };
155 vl_api_nat44_ei_plugin_enable_disable_reply_t *rmp;
160 c.static_mapping_only = mp->flags & NAT44_EI_STATIC_MAPPING_ONLY;
161 c.connection_tracking = mp->flags & NAT44_EI_CONNECTION_TRACKING;
162 c.out2in_dpo = mp->flags & NAT44_EI_OUT2IN_DPO;
164 c.inside_vrf = ntohl (mp->inside_vrf);
165 c.outside_vrf = ntohl (mp->outside_vrf);
167 c.users = ntohl (mp->users);
169 c.sessions = ntohl (mp->sessions);
171 c.user_sessions = ntohl (mp->user_sessions);
173 rv = nat44_ei_plugin_enable (c);
176 rv = nat44_ei_plugin_disable ();
178 REPLY_MACRO (VL_API_NAT44_EI_PLUGIN_ENABLE_DISABLE_REPLY);
182 vl_api_nat44_ei_ipfix_enable_disable_t_handler (
183 vl_api_nat44_ei_ipfix_enable_disable_t *mp)
185 nat44_ei_main_t *nm = &nat44_ei_main;
186 vl_api_nat44_ei_ipfix_enable_disable_reply_t *rmp;
189 rv = nat_ipfix_logging_enable_disable (mp->enable,
190 clib_host_to_net_u32 (mp->domain_id),
191 clib_host_to_net_u16 (mp->src_port));
193 REPLY_MACRO (VL_API_NAT44_EI_IPFIX_ENABLE_DISABLE_REPLY);
197 vl_api_nat44_ei_set_timeouts_t_handler (vl_api_nat44_ei_set_timeouts_t *mp)
199 nat44_ei_main_t *nm = &nat44_ei_main;
200 vl_api_nat44_ei_set_timeouts_reply_t *rmp;
203 nm->timeouts.udp = ntohl (mp->udp);
204 nm->timeouts.tcp.established = ntohl (mp->tcp_established);
205 nm->timeouts.tcp.transitory = ntohl (mp->tcp_transitory);
206 nm->timeouts.icmp = ntohl (mp->icmp);
208 REPLY_MACRO (VL_API_NAT44_EI_SET_TIMEOUTS_REPLY);
212 vl_api_nat44_ei_set_addr_and_port_alloc_alg_t_handler (
213 vl_api_nat44_ei_set_addr_and_port_alloc_alg_t *mp)
215 nat44_ei_main_t *nm = &nat44_ei_main;
216 vl_api_nat44_ei_set_addr_and_port_alloc_alg_reply_t *rmp;
218 u16 port_start, port_end;
222 case NAT44_EI_ADDR_AND_PORT_ALLOC_ALG_DEFAULT:
223 nat44_ei_set_alloc_default ();
225 case NAT44_EI_ADDR_AND_PORT_ALLOC_ALG_MAPE:
226 nat44_ei_set_alloc_mape (ntohs (mp->psid), mp->psid_offset,
229 case NAT44_EI_ADDR_AND_PORT_ALLOC_ALG_RANGE:
230 port_start = ntohs (mp->start_port);
231 port_end = ntohs (mp->end_port);
232 if (port_end <= port_start)
234 rv = VNET_API_ERROR_INVALID_VALUE;
237 nat44_ei_set_alloc_range (port_start, port_end);
240 rv = VNET_API_ERROR_INVALID_VALUE;
245 REPLY_MACRO (VL_API_NAT44_EI_SET_ADDR_AND_PORT_ALLOC_ALG_REPLY);
249 vl_api_nat44_ei_get_addr_and_port_alloc_alg_t_handler (
250 vl_api_nat44_ei_get_addr_and_port_alloc_alg_t *mp)
252 nat44_ei_main_t *nm = &nat44_ei_main;
253 vl_api_nat44_ei_get_addr_and_port_alloc_alg_reply_t *rmp;
256 REPLY_MACRO2 (VL_API_NAT44_EI_GET_ADDR_AND_PORT_ALLOC_ALG_REPLY, ({
257 rmp->alg = nm->addr_and_port_alloc_alg;
258 rmp->psid_offset = nm->psid_offset;
259 rmp->psid_length = nm->psid_length;
260 rmp->psid = htons (nm->psid);
261 rmp->start_port = htons (nm->start_port);
262 rmp->end_port = htons (nm->end_port);
267 vl_api_nat44_ei_set_mss_clamping_t_handler (
268 vl_api_nat44_ei_set_mss_clamping_t *mp)
270 nat44_ei_main_t *nm = &nat44_ei_main;
271 vl_api_nat44_ei_set_mss_clamping_reply_t *rmp;
275 nm->mss_clamping = ntohs (mp->mss_value);
277 nm->mss_clamping = 0;
279 REPLY_MACRO (VL_API_NAT44_EI_SET_MSS_CLAMPING_REPLY);
283 vl_api_nat44_ei_get_mss_clamping_t_handler (
284 vl_api_nat44_ei_get_mss_clamping_t *mp)
286 nat44_ei_main_t *nm = &nat44_ei_main;
287 vl_api_nat44_ei_get_mss_clamping_reply_t *rmp;
290 REPLY_MACRO2 (VL_API_NAT44_EI_GET_MSS_CLAMPING_REPLY, ({
291 rmp->enable = nm->mss_clamping ? 1 : 0;
292 rmp->mss_value = htons (nm->mss_clamping);
297 vl_api_nat44_ei_ha_set_listener_t_handler (
298 vl_api_nat44_ei_ha_set_listener_t *mp)
300 nat44_ei_main_t *nm = &nat44_ei_main;
301 vl_api_nat44_ei_ha_set_listener_reply_t *rmp;
305 memcpy (&addr, &mp->ip_address, sizeof (addr));
306 rv = nat_ha_set_listener (vlib_get_main (), &addr,
307 clib_net_to_host_u16 (mp->port),
308 clib_net_to_host_u32 (mp->path_mtu));
310 REPLY_MACRO (VL_API_NAT44_EI_HA_SET_LISTENER_REPLY);
314 vl_api_nat44_ei_ha_get_listener_t_handler (
315 vl_api_nat44_ei_ha_get_listener_t *mp)
317 nat44_ei_main_t *nm = &nat44_ei_main;
318 vl_api_nat44_ei_ha_get_listener_reply_t *rmp;
324 nat_ha_get_listener (&addr, &port, &path_mtu);
326 REPLY_MACRO2 (VL_API_NAT44_EI_HA_GET_LISTENER_REPLY, ({
327 clib_memcpy (rmp->ip_address, &addr, sizeof (ip4_address_t));
328 rmp->port = clib_host_to_net_u16 (port);
329 rmp->path_mtu = clib_host_to_net_u32 (path_mtu);
334 vl_api_nat44_ei_ha_set_failover_t_handler (
335 vl_api_nat44_ei_ha_set_failover_t *mp)
337 nat44_ei_main_t *nm = &nat44_ei_main;
338 vl_api_nat44_ei_ha_set_failover_reply_t *rmp;
342 memcpy (&addr, &mp->ip_address, sizeof (addr));
343 rv = nat_ha_set_failover (
344 vlib_get_main (), &addr, clib_net_to_host_u16 (mp->port),
345 clib_net_to_host_u32 (mp->session_refresh_interval));
347 REPLY_MACRO (VL_API_NAT44_EI_HA_SET_FAILOVER_REPLY);
351 vl_api_nat44_ei_ha_get_failover_t_handler (
352 vl_api_nat44_ei_ha_get_failover_t *mp)
354 nat44_ei_main_t *nm = &nat44_ei_main;
355 vl_api_nat44_ei_ha_get_failover_reply_t *rmp;
359 u32 session_refresh_interval;
361 nat_ha_get_failover (&addr, &port, &session_refresh_interval);
363 REPLY_MACRO2 (VL_API_NAT44_EI_HA_GET_FAILOVER_REPLY, ({
364 clib_memcpy (rmp->ip_address, &addr, sizeof (ip4_address_t));
365 rmp->port = clib_host_to_net_u16 (port);
366 rmp->session_refresh_interval =
367 clib_host_to_net_u32 (session_refresh_interval);
372 vl_api_nat44_ei_ha_flush_t_handler (vl_api_nat44_ei_ha_flush_t *mp)
374 nat44_ei_main_t *nm = &nat44_ei_main;
375 vl_api_nat44_ei_ha_flush_reply_t *rmp;
380 REPLY_MACRO (VL_API_NAT44_EI_HA_FLUSH_REPLY);
384 nat_ha_resync_completed_event_cb (u32 client_index, u32 pid, u32 missed_count)
386 nat44_ei_main_t *nm = &nat44_ei_main;
387 vl_api_registration_t *reg;
388 vl_api_nat44_ei_ha_resync_completed_event_t *mp;
390 reg = vl_api_client_index_to_registration (client_index);
394 mp = vl_msg_api_alloc (sizeof (*mp));
395 clib_memset (mp, 0, sizeof (*mp));
396 mp->client_index = client_index;
398 mp->missed_count = clib_host_to_net_u32 (missed_count);
400 ntohs (VL_API_NAT44_EI_HA_RESYNC_COMPLETED_EVENT + nm->msg_id_base);
402 vl_api_send_msg (reg, (u8 *) mp);
406 vl_api_nat44_ei_ha_resync_t_handler (vl_api_nat44_ei_ha_resync_t *mp)
408 nat44_ei_main_t *nm = &nat44_ei_main;
409 vl_api_nat44_ei_ha_resync_reply_t *rmp;
413 mp->client_index, mp->pid,
414 mp->want_resync_event ? nat_ha_resync_completed_event_cb : NULL);
416 REPLY_MACRO (VL_API_NAT44_EI_HA_RESYNC_REPLY);
420 vl_api_nat44_ei_del_user_t_handler (vl_api_nat44_ei_del_user_t *mp)
422 nat44_ei_main_t *nm = &nat44_ei_main;
423 vl_api_nat44_ei_del_user_reply_t *rmp;
426 memcpy (&addr.as_u8, mp->ip_address, 4);
427 rv = nat44_ei_user_del (&addr, ntohl (mp->fib_index));
428 REPLY_MACRO (VL_API_NAT44_EI_DEL_USER_REPLY);
432 vl_api_nat44_ei_add_del_address_range_t_handler (
433 vl_api_nat44_ei_add_del_address_range_t *mp)
435 nat44_ei_main_t *nm = &nat44_ei_main;
436 vl_api_nat44_ei_add_del_address_range_reply_t *rmp;
437 ip4_address_t this_addr;
439 u32 start_host_order, end_host_order;
445 if (nm->static_mapping_only)
447 rv = VNET_API_ERROR_FEATURE_DISABLED;
453 tmp = (u32 *) mp->first_ip_address;
454 start_host_order = clib_host_to_net_u32 (tmp[0]);
455 tmp = (u32 *) mp->last_ip_address;
456 end_host_order = clib_host_to_net_u32 (tmp[0]);
458 count = (end_host_order - start_host_order) + 1;
460 vrf_id = clib_host_to_net_u32 (mp->vrf_id);
463 nat44_ei_log_info ("%U - %U, %d addresses...", format_ip4_address,
464 mp->first_ip_address, format_ip4_address,
465 mp->last_ip_address, count);
467 memcpy (&this_addr.as_u8, mp->first_ip_address, 4);
469 for (i = 0; i < count; i++)
472 rv = nat44_ei_add_address (&this_addr, vrf_id);
474 rv = nat44_ei_del_address (this_addr, 0);
480 nat44_ei_add_del_address_dpo (this_addr, is_add);
482 increment_v4_address (&this_addr);
486 REPLY_MACRO (VL_API_NAT44_EI_ADD_DEL_ADDRESS_RANGE_REPLY);
490 send_nat44_ei_address_details (nat44_ei_address_t *a,
491 vl_api_registration_t *reg, u32 context)
493 vl_api_nat44_ei_address_details_t *rmp;
494 nat44_ei_main_t *nm = &nat44_ei_main;
496 rmp = vl_msg_api_alloc (sizeof (*rmp));
497 clib_memset (rmp, 0, sizeof (*rmp));
498 rmp->_vl_msg_id = ntohs (VL_API_NAT44_EI_ADDRESS_DETAILS + nm->msg_id_base);
499 clib_memcpy (rmp->ip_address, &(a->addr), 4);
500 if (a->fib_index != ~0)
502 fib_table_t *fib = fib_table_get (a->fib_index, FIB_PROTOCOL_IP4);
503 rmp->vrf_id = ntohl (fib->ft_table_id);
507 rmp->context = context;
509 vl_api_send_msg (reg, (u8 *) rmp);
513 vl_api_nat44_ei_address_dump_t_handler (vl_api_nat44_ei_address_dump_t *mp)
515 vl_api_registration_t *reg;
516 nat44_ei_main_t *nm = &nat44_ei_main;
517 nat44_ei_address_t *a;
519 reg = vl_api_client_index_to_registration (mp->client_index);
523 vec_foreach (a, nm->addresses)
525 send_nat44_ei_address_details (a, reg, mp->context);
530 vl_api_nat44_ei_interface_add_del_feature_t_handler (
531 vl_api_nat44_ei_interface_add_del_feature_t *mp)
533 nat44_ei_main_t *nm = &nat44_ei_main;
534 vl_api_nat44_ei_interface_add_del_feature_reply_t *rmp;
535 u32 sw_if_index = ntohl (mp->sw_if_index);
539 is_del = !mp->is_add;
541 VALIDATE_SW_IF_INDEX (mp);
543 rv = nat44_ei_add_del_interface (sw_if_index, mp->flags & NAT44_EI_IF_INSIDE,
546 BAD_SW_IF_INDEX_LABEL;
548 REPLY_MACRO (VL_API_NAT44_EI_INTERFACE_ADD_DEL_FEATURE_REPLY);
552 send_nat44_ei_interface_details (nat44_ei_interface_t *i,
553 vl_api_registration_t *reg, u32 context)
555 vl_api_nat44_ei_interface_details_t *rmp;
556 nat44_ei_main_t *nm = &nat44_ei_main;
558 rmp = vl_msg_api_alloc (sizeof (*rmp));
559 clib_memset (rmp, 0, sizeof (*rmp));
561 ntohs (VL_API_NAT44_EI_INTERFACE_DETAILS + nm->msg_id_base);
562 rmp->sw_if_index = ntohl (i->sw_if_index);
564 if (nat44_ei_interface_is_inside (i))
565 rmp->flags |= NAT44_EI_IF_INSIDE;
566 if (nat44_ei_interface_is_outside (i))
567 rmp->flags |= NAT44_EI_IF_OUTSIDE;
569 rmp->context = context;
571 vl_api_send_msg (reg, (u8 *) rmp);
575 vl_api_nat44_ei_interface_dump_t_handler (vl_api_nat44_ei_interface_dump_t *mp)
577 vl_api_registration_t *reg;
578 nat44_ei_main_t *nm = &nat44_ei_main;
579 nat44_ei_interface_t *i;
581 reg = vl_api_client_index_to_registration (mp->client_index);
585 pool_foreach (i, nm->interfaces)
587 send_nat44_ei_interface_details (i, reg, mp->context);
591 static_always_inline int
592 add_del_dummy_output_interface (u32 sw_if_index, u8 is_inside, u8 is_add)
594 nat44_ei_main_t *nm = &nat44_ei_main;
595 nat44_ei_interface_t *i;
598 pool_foreach (i, nm->output_feature_dummy_interfaces)
600 if (i->sw_if_index == sw_if_index)
604 pool_put (nm->output_feature_dummy_interfaces, i);
613 pool_get (nm->output_feature_dummy_interfaces, i);
614 i->sw_if_index = sw_if_index;
618 i->flags |= NAT44_EI_INTERFACE_FLAG_IS_INSIDE;
622 i->flags |= NAT44_EI_INTERFACE_FLAG_IS_OUTSIDE;
633 vl_api_nat44_ei_interface_add_del_output_feature_t_handler (
634 vl_api_nat44_ei_interface_add_del_output_feature_t *mp)
636 vl_api_nat44_ei_interface_add_del_output_feature_reply_t *rmp;
637 nat44_ei_main_t *nm = &nat44_ei_main;
641 VALIDATE_SW_IF_INDEX (mp);
643 sw_if_index = ntohl (mp->sw_if_index);
645 // register all interfaces in the dummy structure
646 rv = add_del_dummy_output_interface (
647 sw_if_index, mp->flags & NAT44_EI_IF_INSIDE, mp->is_add);
649 if (!(mp->flags & NAT44_EI_IF_INSIDE))
651 rv = nat44_ei_add_del_output_interface (sw_if_index, !mp->is_add);
654 BAD_SW_IF_INDEX_LABEL;
655 REPLY_MACRO (VL_API_NAT44_EI_INTERFACE_ADD_DEL_OUTPUT_FEATURE_REPLY);
659 send_nat44_ei_interface_output_feature_details (nat44_ei_interface_t *i,
660 vl_api_registration_t *reg,
663 vl_api_nat44_ei_interface_output_feature_details_t *rmp;
664 nat44_ei_main_t *nm = &nat44_ei_main;
666 rmp = vl_msg_api_alloc (sizeof (*rmp));
667 clib_memset (rmp, 0, sizeof (*rmp));
669 ntohs (VL_API_NAT44_EI_INTERFACE_OUTPUT_FEATURE_DETAILS + nm->msg_id_base);
670 rmp->sw_if_index = ntohl (i->sw_if_index);
671 rmp->context = context;
673 if (nat44_ei_interface_is_inside (i))
675 rmp->flags |= NAT44_EI_IF_INSIDE;
678 vl_api_send_msg (reg, (u8 *) rmp);
682 vl_api_nat44_ei_interface_output_feature_dump_t_handler (
683 vl_api_nat44_ei_interface_output_feature_dump_t *mp)
685 vl_api_registration_t *reg;
686 nat44_ei_main_t *nm = &nat44_ei_main;
687 nat44_ei_interface_t *i;
689 reg = vl_api_client_index_to_registration (mp->client_index);
693 pool_foreach (i, nm->output_feature_dummy_interfaces)
695 send_nat44_ei_interface_output_feature_details (i, reg, mp->context);
700 vl_api_nat44_ei_add_del_output_interface_t_handler (
701 vl_api_nat44_ei_add_del_output_interface_t *mp)
703 vl_api_nat44_ei_add_del_output_interface_reply_t *rmp;
704 nat44_ei_main_t *nm = &nat44_ei_main;
708 VALIDATE_SW_IF_INDEX (mp);
710 sw_if_index = ntohl (mp->sw_if_index);
712 rv = nat44_ei_add_del_output_interface (sw_if_index, !mp->is_add);
714 BAD_SW_IF_INDEX_LABEL;
715 REPLY_MACRO (VL_API_NAT44_EI_ADD_DEL_OUTPUT_INTERFACE_REPLY);
719 #include <nat/nat44-ei/nat44_ei.api.h>
722 send_nat44_ei_output_interface_details (u32 index, vl_api_registration_t *rp,
725 nat44_ei_main_t *nm = &nat44_ei_main;
726 vl_api_nat44_ei_output_interface_details_t *rmp;
727 nat44_ei_interface_t *i =
728 pool_elt_at_index (nm->output_feature_interfaces, index);
730 /* Make sure every field is initiated (or don't skip the clib_memset()) */
731 REPLY_MACRO_DETAILS4 (
732 VL_API_NAT44_EI_OUTPUT_INTERFACE_DETAILS, rp, context, ({
733 rmp->sw_if_index = i->sw_if_index;
735 /* Endian hack until apigen registers _details
736 * endian functions */
737 vl_api_nat44_ei_output_interface_details_t_endian (rmp);
738 rmp->_vl_msg_id = htons (rmp->_vl_msg_id);
739 rmp->context = htonl (rmp->context);
744 vl_api_nat44_ei_output_interface_get_t_handler (
745 vl_api_nat44_ei_output_interface_get_t *mp)
747 vl_api_nat44_ei_output_interface_get_reply_t *rmp;
748 nat44_ei_main_t *nm = &nat44_ei_main;
751 if (pool_elts (nm->output_feature_interfaces) == 0)
753 REPLY_MACRO (VL_API_NAT44_EI_OUTPUT_INTERFACE_GET_REPLY);
757 REPLY_AND_DETAILS_MACRO (
758 VL_API_NAT44_EI_OUTPUT_INTERFACE_GET_REPLY, nm->output_feature_interfaces,
759 ({ send_nat44_ei_output_interface_details (cursor, rp, mp->context); }));
763 vl_api_nat44_ei_add_del_static_mapping_t_handler (
764 vl_api_nat44_ei_add_del_static_mapping_t *mp)
766 vl_api_nat44_ei_add_del_static_mapping_reply_t *rmp;
768 nat44_ei_main_t *nm = &nat44_ei_main;
771 ip4_address_t l_addr, e_addr, pool_addr = { 0 };
772 u32 sw_if_index, flags = 0, vrf_id;
773 u16 l_port = 0, e_port = 0;
774 nat_protocol_t proto = 0;
777 memcpy (&l_addr.as_u8, mp->local_ip_address, 4);
779 if (mp->flags & NAT44_EI_ADDR_ONLY_MAPPING)
781 flags |= NAT44_EI_SM_FLAG_ADDR_ONLY;
785 l_port = mp->local_port;
786 e_port = mp->external_port;
787 proto = ip_proto_to_nat_proto (mp->protocol);
790 sw_if_index = clib_net_to_host_u32 (mp->external_sw_if_index);
791 if (sw_if_index != ~0)
797 memcpy (&e_addr.as_u8, mp->external_ip_address, 4);
800 vrf_id = clib_net_to_host_u32 (mp->vrf_id);
804 mp->tag[sizeof (mp->tag) - 1] = 0;
805 tag = format (0, "%s", mp->tag);
806 vec_terminate_c_string (tag);
808 rv = nat44_ei_add_static_mapping (l_addr, e_addr, l_port, e_port, proto,
809 vrf_id, sw_if_index, flags, pool_addr,
815 rv = nat44_ei_del_static_mapping (l_addr, e_addr, l_port, e_port, proto,
816 vrf_id, sw_if_index, flags);
818 REPLY_MACRO (VL_API_NAT44_EI_ADD_DEL_STATIC_MAPPING_REPLY);
822 send_nat44_ei_static_mapping_details (nat44_ei_static_mapping_t *m,
823 vl_api_registration_t *reg, u32 context)
825 vl_api_nat44_ei_static_mapping_details_t *rmp;
826 nat44_ei_main_t *nm = &nat44_ei_main;
827 u32 len = sizeof (*rmp);
829 rmp = vl_msg_api_alloc (len);
830 clib_memset (rmp, 0, len);
832 ntohs (VL_API_NAT44_EI_STATIC_MAPPING_DETAILS + nm->msg_id_base);
834 clib_memcpy (rmp->local_ip_address, &(m->local_addr), 4);
835 clib_memcpy (rmp->external_ip_address, &(m->external_addr), 4);
836 rmp->external_sw_if_index = ~0;
837 rmp->vrf_id = htonl (m->vrf_id);
838 rmp->context = context;
840 if (is_sm_addr_only (m->flags))
842 rmp->flags |= NAT44_EI_ADDR_ONLY_MAPPING;
846 rmp->protocol = nat_proto_to_ip_proto (m->proto);
847 rmp->external_port = m->external_port;
848 rmp->local_port = m->local_port;
852 strncpy ((char *) rmp->tag, (char *) m->tag, vec_len (m->tag));
854 vl_api_send_msg (reg, (u8 *) rmp);
858 send_nat44_ei_static_map_resolve_details (nat44_ei_static_map_resolve_t *m,
859 vl_api_registration_t *reg,
862 vl_api_nat44_ei_static_mapping_details_t *rmp;
863 nat44_ei_main_t *nm = &nat44_ei_main;
865 rmp = vl_msg_api_alloc (sizeof (*rmp));
866 clib_memset (rmp, 0, sizeof (*rmp));
868 ntohs (VL_API_NAT44_EI_STATIC_MAPPING_DETAILS + nm->msg_id_base);
869 clib_memcpy (rmp->local_ip_address, &(m->l_addr), 4);
870 rmp->external_sw_if_index = htonl (m->sw_if_index);
871 rmp->vrf_id = htonl (m->vrf_id);
872 rmp->context = context;
874 if (is_sm_addr_only (m->flags))
876 rmp->flags |= NAT44_EI_ADDR_ONLY_MAPPING;
880 rmp->protocol = nat_proto_to_ip_proto (m->proto);
881 rmp->external_port = m->e_port;
882 rmp->local_port = m->l_port;
885 strncpy ((char *) rmp->tag, (char *) m->tag, vec_len (m->tag));
887 vl_api_send_msg (reg, (u8 *) rmp);
891 vl_api_nat44_ei_static_mapping_dump_t_handler (
892 vl_api_nat44_ei_static_mapping_dump_t *mp)
894 vl_api_registration_t *reg;
895 nat44_ei_main_t *nm = &nat44_ei_main;
896 nat44_ei_static_mapping_t *m;
897 nat44_ei_static_map_resolve_t *rp;
900 reg = vl_api_client_index_to_registration (mp->client_index);
904 pool_foreach (m, nm->static_mappings)
906 if (!is_sm_identity_nat (m->flags))
907 send_nat44_ei_static_mapping_details (m, reg, mp->context);
910 for (j = 0; j < vec_len (nm->to_resolve); j++)
912 rp = nm->to_resolve + j;
913 if (!is_sm_identity_nat (rp->flags))
914 send_nat44_ei_static_map_resolve_details (rp, reg, mp->context);
919 vl_api_nat44_ei_add_del_identity_mapping_t_handler (
920 vl_api_nat44_ei_add_del_identity_mapping_t *mp)
922 vl_api_nat44_ei_add_del_identity_mapping_reply_t *rmp;
924 nat44_ei_main_t *nm = &nat44_ei_main;
927 ip4_address_t addr, pool_addr = { 0 };
928 u32 sw_if_index, flags, vrf_id;
929 nat_protocol_t proto = 0;
933 flags = NAT44_EI_SM_FLAG_IDENTITY_NAT;
935 if (mp->flags & NAT44_EI_ADDR_ONLY_MAPPING)
937 flags |= NAT44_EI_SM_FLAG_ADDR_ONLY;
942 proto = ip_proto_to_nat_proto (mp->protocol);
945 sw_if_index = clib_net_to_host_u32 (mp->sw_if_index);
946 if (sw_if_index != ~0)
952 memcpy (&addr.as_u8, mp->ip_address, 4);
955 vrf_id = clib_net_to_host_u32 (mp->vrf_id);
959 mp->tag[sizeof (mp->tag) - 1] = 0;
960 tag = format (0, "%s", mp->tag);
961 vec_terminate_c_string (tag);
963 rv = nat44_ei_add_static_mapping (addr, addr, port, port, proto, vrf_id,
964 sw_if_index, flags, pool_addr, tag);
969 rv = nat44_ei_del_static_mapping (addr, addr, port, port, proto, vrf_id,
973 REPLY_MACRO (VL_API_NAT44_EI_ADD_DEL_IDENTITY_MAPPING_REPLY);
977 send_nat44_ei_identity_mapping_details (nat44_ei_static_mapping_t *m,
978 int index, vl_api_registration_t *reg,
981 vl_api_nat44_ei_identity_mapping_details_t *rmp;
982 nat44_ei_main_t *nm = &nat44_ei_main;
983 nat44_ei_lb_addr_port_t *local = pool_elt_at_index (m->locals, index);
985 rmp = vl_msg_api_alloc (sizeof (*rmp));
986 clib_memset (rmp, 0, sizeof (*rmp));
988 ntohs (VL_API_NAT44_EI_IDENTITY_MAPPING_DETAILS + nm->msg_id_base);
990 if (is_sm_addr_only (m->flags))
991 rmp->flags |= NAT44_EI_ADDR_ONLY_MAPPING;
993 clib_memcpy (rmp->ip_address, &(m->local_addr), 4);
994 rmp->port = m->local_port;
995 rmp->sw_if_index = ~0;
996 rmp->vrf_id = htonl (local->vrf_id);
997 rmp->protocol = nat_proto_to_ip_proto (m->proto);
998 rmp->context = context;
1000 strncpy ((char *) rmp->tag, (char *) m->tag, vec_len (m->tag));
1002 vl_api_send_msg (reg, (u8 *) rmp);
1006 send_nat44_ei_identity_map_resolve_details (nat44_ei_static_map_resolve_t *m,
1007 vl_api_registration_t *reg,
1010 vl_api_nat44_ei_identity_mapping_details_t *rmp;
1011 nat44_ei_main_t *nm = &nat44_ei_main;
1012 rmp = vl_msg_api_alloc (sizeof (*rmp));
1013 clib_memset (rmp, 0, sizeof (*rmp));
1015 ntohs (VL_API_NAT44_EI_IDENTITY_MAPPING_DETAILS + nm->msg_id_base);
1017 if (is_sm_addr_only (m->flags))
1018 rmp->flags = (vl_api_nat44_ei_config_flags_t) NAT44_EI_ADDR_ONLY_MAPPING;
1020 rmp->port = m->l_port;
1021 rmp->sw_if_index = htonl (m->sw_if_index);
1022 rmp->vrf_id = htonl (m->vrf_id);
1023 rmp->protocol = nat_proto_to_ip_proto (m->proto);
1024 rmp->context = context;
1026 strncpy ((char *) rmp->tag, (char *) m->tag, vec_len (m->tag));
1028 vl_api_send_msg (reg, (u8 *) rmp);
1032 vl_api_nat44_ei_identity_mapping_dump_t_handler (
1033 vl_api_nat44_ei_identity_mapping_dump_t *mp)
1035 vl_api_registration_t *reg;
1036 nat44_ei_main_t *nm = &nat44_ei_main;
1037 nat44_ei_static_mapping_t *m;
1038 nat44_ei_static_map_resolve_t *rp;
1041 reg = vl_api_client_index_to_registration (mp->client_index);
1045 pool_foreach (m, nm->static_mappings)
1047 if (is_sm_identity_nat (m->flags))
1049 pool_foreach_index (j, m->locals)
1051 send_nat44_ei_identity_mapping_details (m, j, reg, mp->context);
1056 for (j = 0; j < vec_len (nm->to_resolve); j++)
1058 rp = nm->to_resolve + j;
1059 if (is_sm_identity_nat (rp->flags))
1060 send_nat44_ei_identity_map_resolve_details (rp, reg, mp->context);
1065 vl_api_nat44_ei_add_del_interface_addr_t_handler (
1066 vl_api_nat44_ei_add_del_interface_addr_t *mp)
1068 nat44_ei_main_t *nm = &nat44_ei_main;
1069 vl_api_nat44_ei_add_del_interface_addr_reply_t *rmp;
1070 u32 sw_if_index = ntohl (mp->sw_if_index);
1073 VALIDATE_SW_IF_INDEX (mp);
1077 rv = nat44_ei_add_interface_address (sw_if_index);
1081 rv = nat44_ei_del_interface_address (sw_if_index);
1084 BAD_SW_IF_INDEX_LABEL;
1085 REPLY_MACRO (VL_API_NAT44_EI_ADD_DEL_INTERFACE_ADDR_REPLY);
1089 send_nat44_ei_interface_addr_details (u32 sw_if_index,
1090 vl_api_registration_t *reg, u32 context)
1092 vl_api_nat44_ei_interface_addr_details_t *rmp;
1093 nat44_ei_main_t *nm = &nat44_ei_main;
1095 rmp = vl_msg_api_alloc (sizeof (*rmp));
1096 clib_memset (rmp, 0, sizeof (*rmp));
1098 ntohs (VL_API_NAT44_EI_INTERFACE_ADDR_DETAILS + nm->msg_id_base);
1099 rmp->sw_if_index = ntohl (sw_if_index);
1100 rmp->context = context;
1102 vl_api_send_msg (reg, (u8 *) rmp);
1106 vl_api_nat44_ei_interface_addr_dump_t_handler (
1107 vl_api_nat44_ei_interface_addr_dump_t *mp)
1109 vl_api_registration_t *reg;
1110 nat44_ei_main_t *nm = &nat44_ei_main;
1113 reg = vl_api_client_index_to_registration (mp->client_index);
1117 vec_foreach (i, nm->auto_add_sw_if_indices)
1118 send_nat44_ei_interface_addr_details (*i, reg, mp->context);
1122 send_nat44_ei_user_details (nat44_ei_user_t *u, vl_api_registration_t *reg,
1125 vl_api_nat44_ei_user_details_t *rmp;
1126 nat44_ei_main_t *nm = &nat44_ei_main;
1127 ip4_main_t *im = &ip4_main;
1129 rmp = vl_msg_api_alloc (sizeof (*rmp));
1130 clib_memset (rmp, 0, sizeof (*rmp));
1131 rmp->_vl_msg_id = ntohs (VL_API_NAT44_EI_USER_DETAILS + nm->msg_id_base);
1133 if (!pool_is_free_index (im->fibs, u->fib_index))
1135 fib_table_t *fib = fib_table_get (u->fib_index, FIB_PROTOCOL_IP4);
1136 rmp->vrf_id = ntohl (fib->ft_table_id);
1139 clib_memcpy (rmp->ip_address, &(u->addr), 4);
1140 rmp->nsessions = ntohl (u->nsessions);
1141 rmp->nstaticsessions = ntohl (u->nstaticsessions);
1142 rmp->context = context;
1144 vl_api_send_msg (reg, (u8 *) rmp);
1148 vl_api_nat44_ei_user_dump_t_handler (vl_api_nat44_ei_user_dump_t *mp)
1150 vl_api_registration_t *reg;
1151 nat44_ei_main_t *nm = &nat44_ei_main;
1152 nat44_ei_main_per_thread_data_t *tnm;
1155 reg = vl_api_client_index_to_registration (mp->client_index);
1159 vec_foreach (tnm, nm->per_thread_data)
1161 pool_foreach (u, tnm->users)
1163 send_nat44_ei_user_details (u, reg, mp->context);
1169 send_nat44_ei_user_session_details (nat44_ei_session_t *s,
1170 vl_api_registration_t *reg, u32 context)
1172 vl_api_nat44_ei_user_session_details_t *rmp;
1173 nat44_ei_main_t *nm = &nat44_ei_main;
1175 rmp = vl_msg_api_alloc (sizeof (*rmp));
1176 clib_memset (rmp, 0, sizeof (*rmp));
1178 ntohs (VL_API_NAT44_EI_USER_SESSION_DETAILS + nm->msg_id_base);
1179 clib_memcpy (rmp->outside_ip_address, (&s->out2in.addr), 4);
1180 clib_memcpy (rmp->inside_ip_address, (&s->in2out.addr), 4);
1182 if (nat44_ei_is_session_static (s))
1183 rmp->flags |= NAT44_EI_STATIC_MAPPING;
1185 rmp->last_heard = clib_host_to_net_u64 ((u64) s->last_heard);
1186 rmp->total_bytes = clib_host_to_net_u64 (s->total_bytes);
1187 rmp->total_pkts = ntohl (s->total_pkts);
1188 rmp->context = context;
1189 if (nat44_ei_is_unk_proto_session (s))
1191 rmp->outside_port = 0;
1192 rmp->inside_port = 0;
1193 rmp->protocol = ntohs (s->in2out.port);
1197 rmp->outside_port = s->out2in.port;
1198 rmp->inside_port = s->in2out.port;
1199 rmp->protocol = ntohs (nat_proto_to_ip_proto (s->nat_proto));
1201 vl_api_send_msg (reg, (u8 *) rmp);
1205 vl_api_nat44_ei_user_session_dump_t_handler (
1206 vl_api_nat44_ei_user_session_dump_t *mp)
1208 vl_api_registration_t *reg;
1209 nat44_ei_main_t *nm = &nat44_ei_main;
1210 nat44_ei_main_per_thread_data_t *tnm;
1211 nat44_ei_session_t *s;
1212 clib_bihash_kv_8_8_t key, value;
1213 nat44_ei_user_key_t ukey;
1215 u32 session_index, head_index, elt_index;
1216 dlist_elt_t *head, *elt;
1219 reg = vl_api_client_index_to_registration (mp->client_index);
1223 clib_memcpy (&ukey.addr, mp->ip_address, 4);
1224 ip.src_address.as_u32 = ukey.addr.as_u32;
1225 ukey.fib_index = fib_table_find (FIB_PROTOCOL_IP4, ntohl (mp->vrf_id));
1226 key.key = ukey.as_u64;
1227 if (nm->num_workers > 1)
1228 tnm = vec_elt_at_index (
1229 nm->per_thread_data,
1230 nat44_ei_get_in2out_worker_index (&ip, ukey.fib_index, 0));
1232 tnm = vec_elt_at_index (nm->per_thread_data, nm->num_workers);
1234 if (clib_bihash_search_8_8 (&tnm->user_hash, &key, &value))
1236 u = pool_elt_at_index (tnm->users, value.value);
1237 if (!u->nsessions && !u->nstaticsessions)
1240 head_index = u->sessions_per_user_list_head_index;
1241 head = pool_elt_at_index (tnm->list_pool, head_index);
1242 elt_index = head->next;
1243 elt = pool_elt_at_index (tnm->list_pool, elt_index);
1244 session_index = elt->value;
1245 while (session_index != ~0)
1247 s = pool_elt_at_index (tnm->sessions, session_index);
1249 send_nat44_ei_user_session_details (s, reg, mp->context);
1251 elt_index = elt->next;
1252 elt = pool_elt_at_index (tnm->list_pool, elt_index);
1253 session_index = elt->value;
1258 vl_api_nat44_ei_del_session_t_handler (vl_api_nat44_ei_del_session_t *mp)
1260 nat44_ei_main_t *nm = &nat44_ei_main;
1261 vl_api_nat44_ei_del_session_reply_t *rmp;
1262 ip4_address_t addr, eh_addr;
1267 nat_protocol_t proto;
1269 memcpy (&addr.as_u8, mp->address, 4);
1271 vrf_id = clib_net_to_host_u32 (mp->vrf_id);
1272 proto = ip_proto_to_nat_proto (mp->protocol);
1273 memcpy (&eh_addr.as_u8, mp->ext_host_address, 4);
1275 // is session inside ?
1276 is_in = mp->flags & NAT44_EI_IF_INSIDE;
1278 rv = nat44_ei_del_session (nm, &addr, port, proto, vrf_id, is_in);
1280 REPLY_MACRO (VL_API_NAT44_EI_DEL_SESSION_REPLY);
1284 vl_api_nat44_ei_forwarding_enable_disable_t_handler (
1285 vl_api_nat44_ei_forwarding_enable_disable_t *mp)
1287 nat44_ei_main_t *nm = &nat44_ei_main;
1288 vl_api_nat44_ei_forwarding_enable_disable_reply_t *rmp;
1290 u32 *ses_to_be_removed = 0, *ses_index;
1291 nat44_ei_main_per_thread_data_t *tnm;
1292 nat44_ei_session_t *s;
1294 nm->forwarding_enabled = mp->enable != 0;
1296 if (mp->enable == 0)
1298 vec_foreach (tnm, nm->per_thread_data)
1300 vec_foreach (ses_index, ses_to_be_removed)
1302 s = pool_elt_at_index (tnm->sessions, ses_index[0]);
1303 nat44_ei_free_session_data (nm, s, tnm - nm->per_thread_data, 0);
1304 nat44_ei_delete_session (nm, s, tnm - nm->per_thread_data);
1307 vec_free (ses_to_be_removed);
1311 REPLY_MACRO (VL_API_NAT44_EI_FORWARDING_ENABLE_DISABLE_REPLY);
1315 vl_api_nat44_ei_set_fq_options_t_handler (vl_api_nat44_ei_set_fq_options_t *mp)
1317 nat44_ei_main_t *nm = &nat44_ei_main;
1318 vl_api_nat44_ei_set_fq_options_reply_t *rmp;
1320 u32 frame_queue_nelts = ntohl (mp->frame_queue_nelts);
1321 rv = nat44_ei_set_frame_queue_nelts (frame_queue_nelts);
1322 REPLY_MACRO (VL_API_NAT44_EI_SET_FQ_OPTIONS_REPLY);
1326 vl_api_nat44_ei_show_fq_options_t_handler (
1327 vl_api_nat44_ei_show_fq_options_t *mp)
1329 nat44_ei_main_t *nm = &nat44_ei_main;
1330 vl_api_nat44_ei_show_fq_options_reply_t *rmp;
1332 /* clang-format off */
1333 REPLY_MACRO2_ZERO (VL_API_NAT44_EI_SHOW_FQ_OPTIONS_REPLY,
1335 rmp->frame_queue_nelts = htonl (nm->frame_queue_nelts);
1337 /* clang-format on */
1340 /* API definitions */
1341 #include <vnet/format_fns.h>
1342 #include <nat/nat44-ei/nat44_ei.api.c>
1344 /* Set up the API message handling tables */
1346 nat44_ei_api_hookup (vlib_main_t *vm)
1348 nat44_ei_main_t *nm = &nat44_ei_main;
1349 nm->msg_id_base = setup_message_id_table ();
1354 * fd.io coding-style-patch-verification: ON
1357 * eval: (c-set-style "gnu")