2 * Copyright (c) 2020 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
17 * NAT44 endpoint independent plugin declarations
19 #ifndef __included_nat44_ei_h__
20 #define __included_nat44_ei_h__
23 #include <vlibapi/api.h>
25 #include <vnet/vnet.h>
26 #include <vnet/ip/ip.h>
27 #include <vnet/ethernet/ethernet.h>
28 #include <vnet/ip/icmp46_packet.h>
29 #include <vnet/api_errno.h>
30 #include <vnet/fib/fib_source.h>
32 #include <vppinfra/dlist.h>
33 #include <vppinfra/error.h>
34 #include <vppinfra/bihash_8_8.h>
35 #include <vppinfra/hash.h>
37 #include <nat/lib/lib.h>
38 #include <nat/lib/inlines.h>
39 #include <nat/lib/nat_proto.h>
41 /* default number of worker handoff frame queue elements */
42 #define NAT_FQ_NELTS_DEFAULT 64
44 /* External address and port allocation modes */
45 #define foreach_nat44_ei_addr_and_port_alloc_alg \
46 _ (0, DEFAULT, "default") \
47 _ (1, MAPE, "map-e") \
48 _ (2, RANGE, "port-range")
52 #define _(v, N, s) NAT44_EI_ADDR_AND_PORT_ALLOC_ALG_##N = v,
53 foreach_nat44_ei_addr_and_port_alloc_alg
55 } nat44_ei_addr_and_port_alloc_alg_t;
58 #define NAT44_EI_INTERFACE_FLAG_IS_INSIDE (1 << 0)
59 #define NAT44_EI_INTERFACE_FLAG_IS_OUTSIDE (1 << 1)
62 #define NAT44_EI_SESSION_FLAG_STATIC_MAPPING (1 << 0)
63 #define NAT44_EI_SESSION_FLAG_UNKNOWN_PROTO (1 << 1)
65 /* Static mapping flags */
66 #define NAT44_EI_SM_FLAG_ADDR_ONLY (1 << 0)
67 #define NAT44_EI_SM_FLAG_IDENTITY_NAT (1 << 1)
73 #define _(N, i, n, s) \
74 u32 busy_##n##_ports; \
75 u32 *busy_##n##_ports_per_thread; \
76 u32 busy_##n##_port_refcounts[0xffff + 1];
81 clib_error_t *nat44_ei_api_hookup (vlib_main_t *vm);
83 /* NAT address and port allocation function */
84 typedef int (nat44_ei_alloc_out_addr_and_port_function_t) (
85 nat44_ei_address_t *addresses, u32 fib_index, u32 thread_index,
86 nat_protocol_t proto, ip4_address_t s_addr, ip4_address_t *addr, u16 *port,
87 u16 port_per_thread, u32 snat_thread_index);
97 u16 src_port, dst_port;
111 } nat44_ei_user_key_t;
115 /* maximum number of users */
117 /* maximum number of sessions */
119 /* maximum number of ssessions per user */
122 /* plugin features */
123 u8 static_mapping_only;
124 u8 connection_tracking;
134 ip4_address_t l_addr;
135 ip4_address_t pool_addr;
141 nat_protocol_t proto;
143 } nat44_ei_static_map_resolve_t;
147 /* backend IP address */
149 /* backend port number */
151 /* probability of the backend to be randomly matched */
154 /* backend FIB table */
157 } nat44_ei_lb_addr_port_t;
161 /* preferred pool address */
162 ip4_address_t pool_addr;
163 /* local IP address */
164 ip4_address_t local_addr;
165 /* external IP address */
166 ip4_address_t external_addr;
171 /* local FIB table */
175 nat_protocol_t proto;
176 /* worker threads used by backends/local host */
178 /* opaque string tag */
180 /* backends for load-balancing mode */
181 nat44_ei_lb_addr_port_t *locals;
184 } nat44_ei_static_mapping_t;
190 } nat44_ei_interface_t;
202 } nat44_ei_outside_fib_t;
204 typedef CLIB_PACKED (struct {
205 /* Outside network tuple */
213 /* Inside network tuple */
221 nat_protocol_t nat_proto;
226 /* Per-user translations */
228 u32 per_user_list_head_index;
230 /* head of LRU list in which this session is tracked */
232 /* index in global LRU list */
236 /* Last heard timer */
239 /* Last HA refresh */
240 f64 ha_last_refreshed;
246 /* External host address and port */
247 ip4_address_t ext_host_addr;
250 /* External host address and port after translation */
251 ip4_address_t ext_host_nat_addr;
252 u16 ext_host_nat_port;
254 /* TCP session state */
258 u64 tcp_closed_timestamp;
262 }) nat44_ei_session_t;
264 typedef CLIB_PACKED (struct {
267 u32 sessions_per_user_list_head_index;
274 /* Find-a-user => src address lookup */
275 clib_bihash_8_8_t user_hash;
278 nat44_ei_user_t *users;
281 nat44_ei_session_t *sessions;
283 /* Pool of doubly-linked list elements */
284 dlist_elt_t *list_pool;
286 /* LRU session list - head is stale, tail is fresh */
287 dlist_elt_t *lru_pool;
288 u32 tcp_trans_lru_head_index;
289 u32 tcp_estab_lru_head_index;
290 u32 udp_lru_head_index;
291 u32 icmp_lru_head_index;
292 u32 unk_proto_lru_head_index;
294 /* NAT thread index */
295 u32 snat_thread_index;
297 /* real thread index */
300 } nat44_ei_main_per_thread_data_t;
304 u32 cached_sw_if_index;
305 uword *cached_presence_by_ip4_address;
306 } nat44_ei_runtime_t;
312 } nat44_ei_is_idle_session_ctx_t;
314 typedef struct nat44_ei_main_s
317 u32 translation_buckets;
321 u8 forwarding_enabled;
322 u8 static_mapping_only;
323 u8 static_mapping_connection_tracking;
327 /* Find a static mapping by local */
328 clib_bihash_8_8_t static_mapping_by_local;
330 /* Find a static mapping by external */
331 clib_bihash_8_8_t static_mapping_by_external;
333 /* Static mapping pool */
334 nat44_ei_static_mapping_t *static_mappings;
337 nat44_ei_interface_t *interfaces;
338 nat44_ei_interface_t *output_feature_interfaces;
339 // broken api backward compatibility
340 nat44_ei_interface_t *output_feature_dummy_interfaces;
342 /* Is translation memory size calculated or user defined */
343 u8 translation_memory_size_set;
345 u32 max_users_per_thread;
346 u32 max_translations_per_thread;
347 u32 max_translations_per_user;
350 u32 inside_fib_index;
353 u32 outside_fib_index;
355 /* Thread settings */
357 u32 first_worker_index;
361 /* Main lookup tables */
362 clib_bihash_8_8_t out2in;
363 clib_bihash_8_8_t in2out;
365 /* Per thread data */
366 nat44_ei_main_per_thread_data_t *per_thread_data;
368 /* Vector of outside addresses */
369 nat44_ei_address_t *addresses;
371 nat44_ei_alloc_out_addr_and_port_function_t *alloc_addr_and_port;
372 /* Address and port allocation type */
373 nat44_ei_addr_and_port_alloc_alg_t addr_and_port_alloc_alg;
374 /* Port set parameters (MAP-E) */
378 /* Port range parameters */
383 nat44_ei_fib_t *fibs;
385 /* vector of outside fibs */
386 nat44_ei_outside_fib_t *outside_fibs;
388 /* sw_if_indices whose intfc addresses should be auto-added */
389 u32 *auto_add_sw_if_indices;
391 /* vector of interface address static mappings to resolve. */
392 nat44_ei_static_map_resolve_t *to_resolve;
394 u32 in2out_node_index;
395 u32 out2in_node_index;
396 u32 in2out_output_node_index;
399 u32 fq_in2out_output_index;
402 /* Randomize port allocation order */
405 nat_timeouts_t timeouts;
408 vlib_simple_counter_main_t total_users;
409 vlib_simple_counter_main_t total_sessions;
410 vlib_simple_counter_main_t user_limit_reached;
412 #define _(x) vlib_simple_counter_main_t x;
442 vlib_simple_counter_main_t hairpinning;
446 /* API message ID base */
450 vlib_log_class_t log_class;
455 api_main_t *api_main;
456 ip4_main_t *ip4_main;
457 ip_lookup_main_t *ip4_lookup_main;
459 fib_source_t fib_src_hi;
460 fib_source_t fib_src_low;
462 /* pat (port address translation)
463 * dynamic mapping enabled or conneciton tracking */
466 /* number of worker handoff frame queue elements */
467 u32 frame_queue_nelts;
469 /* nat44 plugin enabled */
472 nat44_ei_config_t rconfig;
474 u32 in2out_hairpinning_finish_ip4_lookup_node_fq_index;
475 u32 in2out_hairpinning_finish_interface_output_node_fq_index;
476 u32 hairpinning_fq_index;
477 u32 hairpin_dst_fq_index;
479 vnet_main_t *vnet_main;
482 extern nat44_ei_main_t nat44_ei_main;
484 int nat44_ei_plugin_enable (nat44_ei_config_t c);
485 int nat44_ei_plugin_disable ();
487 int nat44_ei_add_interface (u32 sw_if_index, u8 is_inside);
488 int nat44_ei_del_interface (u32 sw_if_index, u8 is_inside);
489 int nat44_ei_add_output_interface (u32 sw_if_index);
490 int nat44_ei_del_output_interface (u32 sw_if_index);
491 int nat44_ei_add_address (ip4_address_t *addr, u32 vrf_id);
492 int nat44_ei_del_address (ip4_address_t addr, u8 delete_sm);
493 int nat44_ei_add_interface_address (u32 sw_if_index);
494 int nat44_ei_del_interface_address (u32 sw_if_index);
497 * @brief Delete specific NAT44 EI user and his sessions
499 * @param addr IPv4 address
500 * @param fib_index FIB table index
502 int nat44_ei_user_del (ip4_address_t *addr, u32 fib_index);
505 * @brief Delete session for static mapping
507 * @param addr IPv4 address
508 * @param fib_index FIB table index
510 void nat44_ei_static_mapping_del_sessions (
511 nat44_ei_main_t *nm, nat44_ei_main_per_thread_data_t *tnm,
512 nat44_ei_user_key_t u_key, int addr_only, ip4_address_t e_addr, u16 e_port);
514 u32 nat44_ei_get_in2out_worker_index (ip4_header_t *ip0, u32 rx_fib_index0,
517 u32 nat44_ei_get_out2in_worker_index (vlib_buffer_t *b, ip4_header_t *ip0,
518 u32 rx_fib_index0, u8 is_output);
521 * @brief Set address and port assignment algorithm to default/standard
523 void nat44_ei_set_alloc_default (void);
526 * @brief Set address and port assignment algorithm for MAP-E CE
528 * @param psid Port Set Identifier value
529 * @param psid_offset number of offset bits
530 * @param psid_length length of PSID
532 void nat44_ei_set_alloc_mape (u16 psid, u16 psid_offset, u16 psid_length);
535 * @brief Set address and port assignment algorithm for port range
537 * @param start_port beginning of the port range
538 * @param end_port end of the port range
540 void nat44_ei_set_alloc_range (u16 start_port, u16 end_port);
542 int nat44_ei_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
543 u16 l_port, u16 e_port, nat_protocol_t proto,
544 u32 vrf_id, u32 sw_if_index, u32 flags,
545 ip4_address_t pool_addr, u8 *tag);
547 int nat44_ei_del_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
548 u16 l_port, u16 e_port, nat_protocol_t proto,
549 u32 vrf_id, u32 sw_if_index, u32 flags);
552 * @brief Delete NAT44-EI session
554 * @param addr IPv4 address
555 * @param port L4 port number
556 * @param proto L4 protocol
557 * @param vrf_id VRF ID
558 * @param is_in 1 = inside network address and port pair, 0 = outside
560 * @return 0 on success, non-zero value otherwise
562 int nat44_ei_del_session (nat44_ei_main_t *nm, ip4_address_t *addr, u16 port,
563 nat_protocol_t proto, u32 vrf_id, int is_in);
566 * @brief Match NAT44-EI static mapping.
568 * @param key address and port to match
569 * @param addr external/local address of the matched mapping
570 * @param port port of the matched mapping
571 * @param fib_index fib index of the matched mapping
572 * @param by_external if 0 match by local address otherwise match by
574 * @param is_addr_only 1 if matched mapping is address only
575 * @param is_identity_nat 1 if indentity mapping
577 * @returns 0 if match found otherwise 1.
579 int nat44_ei_static_mapping_match (ip4_address_t match_addr, u16 match_port,
581 nat_protocol_t match_protocol,
582 ip4_address_t *mapping_addr,
583 u16 *mapping_port, u32 *mapping_fib_index,
584 u8 by_external, u8 *is_addr_only,
585 u8 *is_identity_nat);
588 * @brief Clear all active NAT44-EI sessions.
590 void nat44_ei_sessions_clear ();
592 nat44_ei_user_t *nat44_ei_user_get_or_create (nat44_ei_main_t *nm,
594 u32 fib_index, u32 thread_index);
596 nat44_ei_session_t *nat44_ei_session_alloc_or_recycle (nat44_ei_main_t *nm,
601 void nat44_ei_free_session_data_v2 (nat44_ei_main_t *nm, nat44_ei_session_t *s,
602 u32 thread_index, u8 is_ha);
604 void nat44_ei_free_outside_address_and_port (nat44_ei_address_t *addresses,
606 ip4_address_t *addr, u16 port,
607 nat_protocol_t protocol);
609 int nat44_ei_set_outside_address_and_port (nat44_ei_address_t *addresses,
611 ip4_address_t addr, u16 port,
612 nat_protocol_t protocol);
614 void nat44_ei_free_session_data (nat44_ei_main_t *nm, nat44_ei_session_t *s,
615 u32 thread_index, u8 is_ha);
617 int nat44_ei_set_workers (uword *bitmap);
619 void nat44_ei_add_del_address_dpo (ip4_address_t addr, u8 is_add);
621 void nat44_ei_delete_session (nat44_ei_main_t *nm, nat44_ei_session_t *ses,
624 /* Call back functions for clib_bihash_add_or_overwrite_stale */
625 int nat44_i2o_is_idle_session_cb (clib_bihash_kv_8_8_t *kv, void *arg);
626 int nat44_o2i_is_idle_session_cb (clib_bihash_kv_8_8_t *kv, void *arg);
628 int nat44_ei_hairpinning (vlib_main_t *vm, vlib_node_runtime_t *node,
629 nat44_ei_main_t *nm, u32 thread_index,
630 vlib_buffer_t *b0, ip4_header_t *ip0,
631 udp_header_t *udp0, tcp_header_t *tcp0, u32 proto0,
632 int do_trace, u32 *required_thread_index);
634 void nat44_ei_hairpinning_sm_unknown_proto (nat44_ei_main_t *nm,
638 u32 nat44_ei_icmp_hairpinning (nat44_ei_main_t *nm, vlib_buffer_t *b0,
639 u32 thread_index, ip4_header_t *ip0,
640 icmp46_header_t *icmp0,
641 u32 *required_thread_index);
643 int nat44_ei_set_frame_queue_nelts (u32 frame_queue_nelts);
646 nat44_ei_is_session_static (nat44_ei_session_t *s)
648 return (s->flags & NAT44_EI_SESSION_FLAG_STATIC_MAPPING);
652 nat44_ei_is_unk_proto_session (nat44_ei_session_t *s)
654 return (s->flags & NAT44_EI_SESSION_FLAG_UNKNOWN_PROTO);
658 nat44_ei_interface_is_inside (nat44_ei_interface_t *i)
660 return (i->flags & NAT44_EI_INTERFACE_FLAG_IS_INSIDE);
664 nat44_ei_interface_is_outside (nat44_ei_interface_t *i)
666 return (i->flags & NAT44_EI_INTERFACE_FLAG_IS_OUTSIDE);
670 is_sm_addr_only (u32 f)
672 return (f & NAT44_EI_SM_FLAG_ADDR_ONLY);
676 is_sm_identity_nat (u32 f)
678 return (f & NAT44_EI_SM_FLAG_IDENTITY_NAT);
682 #define nat44_ei_log_err(...) \
683 vlib_log (VLIB_LOG_LEVEL_ERR, nat44_ei_main.log_class, __VA_ARGS__)
684 #define nat44_ei_log_warn(...) \
685 vlib_log (VLIB_LOG_LEVEL_WARNING, nat44_ei_main.log_class, __VA_ARGS__)
686 #define nat44_ei_log_notice(...) \
687 vlib_log (VLIB_LOG_LEVEL_NOTICE, nat44_ei_main.log_class, __VA_ARGS__)
688 #define nat44_ei_log_info(...) \
689 vlib_log (VLIB_LOG_LEVEL_INFO, nat44_ei_main.log_class, __VA_ARGS__)
690 #define nat44_ei_log_debug(...) \
691 vlib_log (VLIB_LOG_LEVEL_DEBUG, nat44_ei_main.log_class, __VA_ARGS__)
693 #endif /* __included_nat44_ei_h__ */
695 * fd.io coding-style-patch-verification: ON
698 * eval: (c-set-style "gnu")