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 * NAT plugin global declarations
19 #ifndef __included_nat44_ed_h__
20 #define __included_nat44_ed_h__
22 #include <vnet/vnet.h>
23 #include <vnet/ip/ip.h>
24 #include <vnet/ethernet/ethernet.h>
25 #include <vnet/ip/icmp46_packet.h>
26 #include <vnet/api_errno.h>
27 #include <vnet/fib/fib_source.h>
28 #include <vppinfra/elog.h>
29 #include <vppinfra/bihash_8_8.h>
30 #include <vppinfra/bihash_16_8.h>
31 #include <vppinfra/hash.h>
32 #include <vppinfra/dlist.h>
33 #include <vppinfra/error.h>
34 #include <vlibapi/api.h>
36 #include <nat/lib/lib.h>
37 #include <nat/lib/inlines.h>
39 /* default number of worker handoff frame queue elements */
40 #define NAT_FQ_NELTS_DEFAULT 64
42 /* NAT buffer flags */
43 #define SNAT_FLAG_HAIRPINNING (1 << 0)
45 /* NAT44 API Configuration flags */
46 #define foreach_nat44_config_flag \
47 _ (0x00, IS_ENDPOINT_INDEPENDENT) \
48 _ (0x01, IS_ENDPOINT_DEPENDENT) \
49 _ (0x02, IS_STATIC_MAPPING_ONLY) \
50 _ (0x04, IS_CONNECTION_TRACKING)
52 typedef enum nat44_config_flags_t_
54 #define _(n,f) NAT44_API_##f = n,
55 foreach_nat44_config_flag
57 } nat44_config_flags_t;
61 /* nat44 plugin features */
62 u8 static_mapping_only;
63 u8 connection_tracking;
68 /* maximum number of sessions */
77 NAT_NEXT_IN2OUT_ED_FAST_PATH,
78 NAT_NEXT_IN2OUT_ED_SLOW_PATH,
79 NAT_NEXT_IN2OUT_ED_OUTPUT_FAST_PATH,
80 NAT_NEXT_IN2OUT_ED_OUTPUT_SLOW_PATH,
81 NAT_NEXT_OUT2IN_ED_FAST_PATH,
82 NAT_NEXT_OUT2IN_ED_SLOW_PATH,
83 NAT_NEXT_IN2OUT_CLASSIFY,
84 NAT_NEXT_OUT2IN_CLASSIFY,
94 /* External address and port allocation modes */
95 #define foreach_nat_addr_and_port_alloc_alg \
96 _(0, DEFAULT, "default") \
98 _(2, RANGE, "port-range")
102 #define _(v, N, s) NAT_ADDR_AND_PORT_ALLOC_ALG_##N = v,
103 foreach_nat_addr_and_port_alloc_alg
105 } nat_addr_and_port_alloc_alg_t;
108 #define foreach_snat_session_state \
109 _(0, UNKNOWN, "unknown") \
110 _(1, UDP_ACTIVE, "udp-active") \
111 _(2, TCP_SYN_SENT, "tcp-syn-sent") \
112 _(3, TCP_ESTABLISHED, "tcp-established") \
113 _(4, TCP_FIN_WAIT, "tcp-fin-wait") \
114 _(5, TCP_CLOSE_WAIT, "tcp-close-wait") \
115 _(6, TCP_CLOSING, "tcp-closing") \
116 _(7, TCP_LAST_ACK, "tcp-last-ack") \
117 _(8, TCP_CLOSED, "tcp-closed") \
118 _(9, ICMP_ACTIVE, "icmp-active")
122 #define _(v, N, s) SNAT_SESSION_##N = v,
123 foreach_snat_session_state
125 } snat_session_state_t;
127 #define foreach_nat_in2out_ed_error \
128 _ (UNSUPPORTED_PROTOCOL, "unsupported protocol") \
129 _ (OUT_OF_PORTS, "out of ports") \
130 _ (BAD_ICMP_TYPE, "unsupported ICMP type") \
131 _ (MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \
132 _ (NON_SYN, "non-SYN packet try to create session") \
133 _ (TCP_CLOSED, "drops due to TCP in transitory timeout") \
134 _ (TRNSL_FAILED, "couldn't translate packet")
138 #define _(sym,str) NAT_IN2OUT_ED_ERROR_##sym,
139 foreach_nat_in2out_ed_error
141 NAT_IN2OUT_ED_N_ERROR,
142 } nat_in2out_ed_error_t;
144 #define foreach_nat_out2in_ed_error \
145 _ (UNSUPPORTED_PROTOCOL, "unsupported protocol") \
146 _ (OUT_OF_PORTS, "out of ports") \
147 _ (BAD_ICMP_TYPE, "unsupported ICMP type") \
148 _ (NO_TRANSLATION, "no translation") \
149 _ (MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \
150 _ (NON_SYN, "non-SYN packet try to create session") \
151 _ (TCP_CLOSED, "drops due to TCP in transitory timeout") \
152 _ (HASH_ADD_FAILED, "hash table add failed") \
153 _ (TRNSL_FAILED, "couldn't translate packet")
157 #define _(sym,str) NAT_OUT2IN_ED_ERROR_##sym,
158 foreach_nat_out2in_ed_error
160 NAT_OUT2IN_ED_N_ERROR,
161 } nat_out2in_ed_error_t;
164 /* Endpoint dependent TCP session state */
165 #define NAT44_SES_I2O_FIN 1
166 #define NAT44_SES_O2I_FIN 2
167 #define NAT44_SES_I2O_FIN_ACK 4
168 #define NAT44_SES_O2I_FIN_ACK 8
169 #define NAT44_SES_I2O_SYN 16
170 #define NAT44_SES_O2I_SYN 32
171 #define NAT44_SES_RST 64
174 #define SNAT_SESSION_FLAG_STATIC_MAPPING (1 << 0)
175 #define SNAT_SESSION_FLAG_UNKNOWN_PROTO (1 << 1)
176 #define SNAT_SESSION_FLAG_LOAD_BALANCING (1 << 2)
177 #define SNAT_SESSION_FLAG_TWICE_NAT (1 << 3)
178 #define SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT (1 << 4)
179 #define SNAT_SESSION_FLAG_FWD_BYPASS (1 << 5)
180 #define SNAT_SESSION_FLAG_AFFINITY (1 << 6)
181 #define SNAT_SESSION_FLAG_EXACT_ADDRESS (1 << 7)
182 #define SNAT_SESSION_FLAG_HAIRPINNING (1 << 8)
184 /* NAT interface flags */
185 #define NAT_INTERFACE_FLAG_IS_INSIDE 1
186 #define NAT_INTERFACE_FLAG_IS_OUTSIDE 2
188 /* Static mapping flags */
189 #define NAT_SM_FLAG_SELF_TWICE_NAT (1 << 1)
190 #define NAT_SM_FLAG_TWICE_NAT (1 << 2)
191 #define NAT_SM_FLAG_IDENTITY_NAT (1 << 3)
192 #define NAT_SM_FLAG_ADDR_ONLY (1 << 4)
193 #define NAT_SM_FLAG_EXACT_ADDRESS (1 << 5)
194 #define NAT_SM_FLAG_OUT2IN_ONLY (1 << 6)
195 #define NAT_SM_FLAG_LB (1 << 7)
196 #define NAT_SM_FLAG_SWITCH_ADDRESS (1 << 8)
198 typedef CLIB_PACKED(struct
200 // number of sessions in this vrf
206 // is this vrf expired
208 }) per_vrf_sessions_t;
214 ip4_address_t saddr, daddr;
215 u16 sport; // ICMP id for ICMP case
224 STATIC_ASSERT_SIZEOF (nat_6t_t, 2 * sizeof (u64));
228 #define NAT_FLOW_OP_SADDR_REWRITE (1 << 1)
229 #define NAT_FLOW_OP_SPORT_REWRITE (1 << 2)
230 #define NAT_FLOW_OP_DADDR_REWRITE (1 << 3)
231 #define NAT_FLOW_OP_DPORT_REWRITE (1 << 4)
232 #define NAT_FLOW_OP_ICMP_ID_REWRITE (1 << 5)
233 #define NAT_FLOW_OP_TXFIB_REWRITE (1 << 6)
238 ip4_address_t saddr, daddr;
249 void nat44_ed_forwarding_enable_disable (u8 is_enable);
252 nat_6t_flow_saddr_rewrite_set (nat_6t_flow_t *f, u32 saddr)
254 f->ops |= NAT_FLOW_OP_SADDR_REWRITE;
255 f->rewrite.saddr.as_u32 = saddr;
259 nat_6t_flow_daddr_rewrite_set (nat_6t_flow_t *f, u32 daddr)
261 f->ops |= NAT_FLOW_OP_DADDR_REWRITE;
262 f->rewrite.daddr.as_u32 = daddr;
266 nat_6t_flow_sport_rewrite_set (nat_6t_flow_t *f, u32 sport)
268 f->ops |= NAT_FLOW_OP_SPORT_REWRITE;
269 f->rewrite.sport = sport;
273 nat_6t_flow_dport_rewrite_set (nat_6t_flow_t *f, u32 dport)
275 f->ops |= NAT_FLOW_OP_DPORT_REWRITE;
276 f->rewrite.dport = dport;
280 nat_6t_flow_txfib_rewrite_set (nat_6t_flow_t *f, u32 tx_fib_index)
282 f->ops |= NAT_FLOW_OP_TXFIB_REWRITE;
283 f->rewrite.fib_index = tx_fib_index;
287 nat_6t_flow_icmp_id_rewrite_set (nat_6t_flow_t *f, u16 id)
289 f->ops |= NAT_FLOW_OP_ICMP_ID_REWRITE;
290 f->rewrite.icmp_id = id;
293 typedef CLIB_PACKED(struct
295 /* Outside network tuple */
303 /* Inside network tuple */
311 nat_protocol_t nat_proto;
319 /* head of LRU list in which this session is tracked */
321 /* index in global LRU list */
325 /* Last heard timer */
328 /* Last HA refresh */
329 f64 ha_last_refreshed;
335 /* External host address and port */
336 ip4_address_t ext_host_addr;
339 /* External host address and port after translation */
340 ip4_address_t ext_host_nat_addr;
341 u16 ext_host_nat_port;
343 /* TCP session state */
347 u64 tcp_closed_timestamp;
349 /* per vrf sessions index */
350 u32 per_vrf_sessions_index;
359 #define _(N, i, n, s) \
360 u32 busy_##n##_ports; \
361 u32 * busy_##n##_ports_per_thread; \
362 u32 busy_##n##_port_refcounts[65535];
381 /* backend IP address */
383 /* backend port number */
385 /* probability of the backend to be randomly matched */
388 /* backend FIB table */
391 } nat44_lb_addr_port_t;
395 /* twice-nat disabled */
397 /* twice-nat enabled */
399 /* twice-nat only when src IP equals dst IP after translation */
405 /* no load-balancing */
409 /* load-balancing with affinity */
415 /* preferred pool address */
416 ip4_address_t pool_addr;
417 /* local IP address */
418 ip4_address_t local_addr;
419 /* external IP address */
420 ip4_address_t external_addr;
425 /* local FIB table */
429 nat_protocol_t proto;
430 /* 0 = disabled, otherwise client IP affinity sticky time in seconds */
432 /* worker threads used by backends/local host */
434 /* opaque string tag */
436 /* backends for load-balancing mode */
437 nat44_lb_addr_port_t *locals;
438 /* affinity per service lis */
439 u32 affinity_per_service_list_head_index;
442 } snat_static_mapping_t;
452 ip4_address_t l_addr;
453 ip4_address_t pool_addr;
458 nat_protocol_t proto;
466 } snat_static_map_resolve_t;
471 snat_session_t *sessions;
473 /* Pool of doubly-linked list elements */
474 dlist_elt_t *list_pool;
476 /* LRU session list - head is stale, tail is fresh */
477 dlist_elt_t *lru_pool;
478 u32 tcp_trans_lru_head_index;
479 u32 tcp_estab_lru_head_index;
480 u32 udp_lru_head_index;
481 u32 icmp_lru_head_index;
482 u32 unk_proto_lru_head_index;
484 /* NAT thread index */
485 u32 snat_thread_index;
487 /* real thread index */
490 per_vrf_sessions_t *per_vrf_sessions_vec;
492 } snat_main_per_thread_data_t;
496 u32 nat44_ed_get_in2out_worker_index (vlib_buffer_t *b, ip4_header_t *ip,
497 u32 rx_fib_index, u8 is_output);
498 u32 nat44_ed_get_out2in_worker_index (vlib_buffer_t *b, ip4_header_t *ip,
499 u32 rx_fib_index, u8 is_output);
501 /* Return worker thread index for given packet */
502 /* NAT address and port allocation function */
503 typedef int (nat_alloc_out_addr_and_port_function_t) (snat_address_t *
507 nat_protocol_t proto,
508 ip4_address_t * addr,
511 u32 snat_thread_index);
513 typedef struct snat_main_s
515 /* Thread settings */
517 u32 first_worker_index;
521 /* Per thread data */
522 snat_main_per_thread_data_t *per_thread_data;
524 /* Find a static mapping by local */
525 clib_bihash_8_8_t static_mapping_by_local;
527 /* Find a static mapping by external */
528 clib_bihash_8_8_t static_mapping_by_external;
530 /* Static mapping pool */
531 snat_static_mapping_t *static_mappings;
533 /* Endpoint independent lookup tables */
534 clib_bihash_8_8_t in2out;
535 clib_bihash_8_8_t out2in;
537 /* Endpoint dependent lookup table */
538 clib_bihash_16_8_t flow_hash;
541 snat_interface_t *interfaces;
542 snat_interface_t *output_feature_interfaces;
544 /* Vector of outside addresses */
545 snat_address_t *addresses;
546 /* Vector of twice NAT addresses for external hosts */
547 snat_address_t *twice_nat_addresses;
549 /* sw_if_indices whose intfc addresses should be auto-added */
550 u32 *auto_add_sw_if_indices;
551 u32 *auto_add_sw_if_indices_twice_nat;
553 /* Address and port allocation function */
554 nat_alloc_out_addr_and_port_function_t *alloc_addr_and_port;
555 /* Address and port allocation type */
556 nat_addr_and_port_alloc_alg_t addr_and_port_alloc_alg;
557 /* Port set parameters (MAP-E) */
561 /* Port range parameters */
568 /* vector of outside fibs */
569 nat_outside_fib_t *outside_fibs;
571 /* vector of interface address static mappings to resolve. */
572 snat_static_map_resolve_t *to_resolve;
574 /* Randomize port allocation order */
577 /* Worker handoff frame-queue index */
579 u32 fq_in2out_output_index;
582 u32 out2in_node_index;
583 u32 in2out_node_index;
584 u32 in2out_output_node_index;
586 nat44_config_t rconfig;
587 //nat44_config_t cconfig;
589 /* If forwarding is enabled */
590 u8 forwarding_enabled;
592 /* static mapping config */
593 u8 static_mapping_only;
594 u8 static_mapping_connection_tracking;
596 /* Is translation memory size calculated or user defined */
597 u8 translation_memory_size_set;
599 u32 translation_buckets;
600 u32 max_translations_per_thread;
601 u32 *max_translations_per_fib;
604 u32 outside_fib_index;
606 u32 inside_fib_index;
608 nat_timeouts_t timeouts;
610 /* TCP MSS clamping */
614 vlib_simple_counter_main_t total_sessions;
615 u32 max_cfg_sessions_gauge; /* Index of max configured sessions gauge in
618 #define _(x) vlib_simple_counter_main_t x;
647 vlib_simple_counter_main_t hairpinning;
651 /* API message ID base */
655 vlib_log_class_t log_class;
660 api_main_t *api_main;
661 ip4_main_t *ip4_main;
662 ip_lookup_main_t *ip4_lookup_main;
664 fib_source_t fib_src_hi;
665 fib_source_t fib_src_low;
667 /* pat - dynamic mapping enabled or conneciton tracking */
670 /* number of worker handoff frame queue elements */
671 u32 frame_queue_nelts;
673 /* nat44 plugin enabled */
676 vnet_main_t *vnet_main;
684 } nat44_is_idle_session_ctx_t;
688 u32 cached_sw_if_index;
689 uword *cached_presence_by_ip4_address;
692 extern snat_main_t snat_main;
694 // nat pre ed next_node feature classification
695 extern vlib_node_registration_t nat_default_node;
696 extern vlib_node_registration_t nat_pre_in2out_node;
697 extern vlib_node_registration_t nat_pre_out2in_node;
699 extern vlib_node_registration_t snat_in2out_node;
700 extern vlib_node_registration_t snat_in2out_output_node;
701 extern vlib_node_registration_t snat_out2in_node;
702 extern vlib_node_registration_t snat_in2out_worker_handoff_node;
703 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
704 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
705 extern vlib_node_registration_t nat44_ed_in2out_node;
706 extern vlib_node_registration_t nat44_ed_in2out_output_node;
707 extern vlib_node_registration_t nat44_ed_out2in_node;
709 extern fib_source_t nat_fib_src_hi;
710 extern fib_source_t nat_fib_src_low;
712 /* format functions */
713 format_function_t format_snat_static_mapping;
714 format_function_t format_snat_static_map_to_resolve;
715 format_function_t format_snat_session;
716 format_function_t format_snat_key;
717 format_function_t format_static_mapping_key;
718 format_function_t format_nat_protocol;
719 format_function_t format_nat_addr_and_port_alloc_alg;
720 /* unformat functions */
721 unformat_function_t unformat_nat_protocol;
723 /** \brief Check if SNAT session is created from static mapping.
724 @param s SNAT session
725 @return true if SNAT session is created from static mapping otherwise 0
728 nat44_ed_is_session_static (snat_session_t *s)
730 return s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING;
733 /** \brief Check if SNAT session for unknown protocol.
734 @param s SNAT session
735 @return true if SNAT session for unknown protocol otherwise 0
738 snat_is_unk_proto_session (snat_session_t *s)
740 return s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO;
743 /** \brief Check if NAT session is twice NAT.
745 @return true if NAT session is twice NAT
748 nat44_ed_is_twice_nat_session (snat_session_t *s)
750 return s->flags & SNAT_SESSION_FLAG_TWICE_NAT;
753 /** \brief Check if NAT session is load-balancing.
755 @return true if NAT session is load-balancing
758 nat44_ed_is_lb_session (snat_session_t *s)
760 return s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING;
763 /** \brief Check if NAT session is forwarding bypass.
765 @return true if NAT session is load-balancing
768 na44_ed_is_fwd_bypass_session (snat_session_t *s)
770 return s->flags & SNAT_SESSION_FLAG_FWD_BYPASS;
773 /** \brief Check if NAT session has affinity record.
775 @return true if NAT session has affinity record
778 nat44_ed_is_affinity_session (snat_session_t *s)
780 return s->flags & SNAT_SESSION_FLAG_AFFINITY;
783 /** \brief Check if exact pool address should be used.
784 @param s SNAT session
785 @return true if exact pool address
788 nat44_ed_is_exact_address_session (snat_session_t *s)
790 return s->flags & SNAT_SESSION_FLAG_EXACT_ADDRESS;
793 /** \brief Check if NAT interface is inside.
794 @param i NAT interface
795 @return true if inside interface
798 nat44_ed_is_interface_inside (snat_interface_t *i)
800 return i->flags & NAT_INTERFACE_FLAG_IS_INSIDE;
803 /** \brief Check if NAT interface is outside.
804 @param i NAT interface
805 @return true if outside interface
808 nat44_ed_is_interface_outside (snat_interface_t *i)
810 return i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE;
813 /** \brief Check if NAT44 endpoint-dependent TCP session is closed.
815 @return true if session is closed
818 nat44_is_ses_closed (snat_session_t *s)
820 return s->state == 0xf;
823 /** \brief Check if client initiating TCP connection (received SYN from client)
825 @return true if client initiating TCP connection
828 tcp_flags_is_init (u8 f)
830 return (f & TCP_FLAG_SYN) && !(f & TCP_FLAG_ACK);
834 is_sm_addr_only (u32 f)
836 return (f & NAT_SM_FLAG_ADDR_ONLY);
840 is_sm_out2in_only (u32 f)
842 return (f & NAT_SM_FLAG_OUT2IN_ONLY);
846 is_sm_identity_nat (u32 f)
848 return (f & NAT_SM_FLAG_IDENTITY_NAT);
854 return (f & NAT_SM_FLAG_LB);
858 is_sm_exact_address (u32 f)
860 return (f & NAT_SM_FLAG_EXACT_ADDRESS);
864 is_sm_self_twice_nat (u32 f)
866 return (f & NAT_SM_FLAG_SELF_TWICE_NAT);
870 is_sm_twice_nat (u32 f)
872 return (f & NAT_SM_FLAG_TWICE_NAT);
876 is_sm_switch_address (u32 f)
878 return (f & NAT_SM_FLAG_SWITCH_ADDRESS);
882 #define nat_log_err(...) \
883 vlib_log(VLIB_LOG_LEVEL_ERR, snat_main.log_class, __VA_ARGS__)
884 #define nat_log_warn(...) \
885 vlib_log(VLIB_LOG_LEVEL_WARNING, snat_main.log_class, __VA_ARGS__)
886 #define nat_log_notice(...) \
887 vlib_log(VLIB_LOG_LEVEL_NOTICE, snat_main.log_class, __VA_ARGS__)
888 #define nat_log_info(...) \
889 vlib_log(VLIB_LOG_LEVEL_INFO, snat_main.log_class, __VA_ARGS__)
890 #define nat_log_debug(...)\
891 vlib_log(VLIB_LOG_LEVEL_DEBUG, snat_main.log_class, __VA_ARGS__)
893 clib_error_t *nat44_api_hookup (vlib_main_t *vm);
895 int snat_set_workers (uword *bitmap);
897 int nat44_plugin_enable (nat44_config_t c);
898 int nat44_plugin_disable ();
900 int nat44_ed_add_interface (u32 sw_if_index, u8 is_inside);
901 int nat44_ed_del_interface (u32 sw_if_index, u8 is_inside);
902 int nat44_ed_add_output_interface (u32 sw_if_index);
903 int nat44_ed_del_output_interface (u32 sw_if_index);
905 int nat44_ed_add_address (ip4_address_t *addr, u32 vrf_id, u8 twice_nat);
906 int nat44_ed_del_address (ip4_address_t addr, u8 delete_sm, u8 twice_nat);
907 int nat44_ed_add_interface_address (u32 sw_if_index, u8 twice_nat);
908 int nat44_ed_del_interface_address (u32 sw_if_index, u8 twice_nat);
910 int nat44_ed_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
911 u16 l_port, u16 e_port, nat_protocol_t proto,
912 u32 vrf_id, u32 sw_if_index, u32 flags,
913 ip4_address_t pool_addr, u8 *tag);
915 int nat44_ed_del_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
916 u16 l_port, u16 e_port, nat_protocol_t proto,
917 u32 vrf_id, u32 sw_if_index, u32 flags);
919 int nat44_ed_add_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
920 nat_protocol_t proto,
921 nat44_lb_addr_port_t *locals, u32 flags,
922 u8 *tag, u32 affinity);
924 int nat44_ed_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
925 nat_protocol_t proto, u32 flags);
927 int nat44_ed_add_del_lb_static_mapping_local (ip4_address_t e_addr, u16 e_port,
928 ip4_address_t l_addr, u16 l_port,
929 nat_protocol_t proto, u32 vrf_id,
930 u8 probability, u8 is_add);
933 * @brief Delete NAT44 endpoint-dependent session
935 * @param sm snat global configuration data
936 * @param addr IPv4 address
937 * @param port L4 port number
938 * @param proto L4 protocol
939 * @param vrf_id VRF ID
940 * @param is_in 1 = inside network address and port pair, 0 = outside
942 * @return 0 on success, non-zero value otherwise
944 int nat44_ed_del_session (snat_main_t *sm, ip4_address_t *addr, u16 port,
945 ip4_address_t *eh_addr, u16 eh_port, u8 proto,
946 u32 vrf_id, int is_in);
949 * @brief Free NAT44 session data (lookup keys, external address port)
951 * @param sm snat global configuration data
952 * @param s NAT session
953 * @param thread_index thread index
954 * @param is_ha is HA event
956 void nat_free_session_data (snat_main_t * sm, snat_session_t * s,
957 u32 thread_index, u8 is_ha);
960 * @brief Set NAT44 session limit (session limit, vrf id)
962 * @param session_limit Session limit
963 * @param vrf_id VRF id
964 * @return 0 on success, non-zero value otherwise
966 int nat44_set_session_limit (u32 session_limit, u32 vrf_id);
969 * @brief Update NAT44 session limit flushing all data (session limit, vrf id)
971 * @param session_limit Session limit
972 * @param vrf_id VRF id
973 * @return 0 on success, non-zero value otherwise
975 int nat44_update_session_limit (u32 session_limit, u32 vrf_id);
978 * @brief Free outside address and port pair
980 * @param addresses vector of outside addresses
981 * @param thread_index thread index
982 * @param key address, port and protocol
985 snat_free_outside_address_and_port (snat_address_t * addresses,
987 ip4_address_t * addr,
988 u16 port, nat_protocol_t protocol);
990 void expire_per_vrf_sessions (u32 fib_index);
993 * @brief Match NAT44 static mapping.
995 * @param key address and port to match
996 * @param addr external/local address of the matched mapping
997 * @param port port of the matched mapping
998 * @param fib_index fib index of the matched mapping
999 * @param by_external if 0 match by local address otherwise match by external
1001 * @param is_addr_only 1 if matched mapping is address only
1002 * @param twice_nat matched mapping is twice NAT type
1003 * @param lb 1 if matched mapping is load-balanced
1004 * @param ext_host_addr external host address
1005 * @param is_identity_nat 1 if indentity mapping
1006 * @param out if !=0 set to pointer of the mapping structure
1008 * @returns 0 if match found otherwise 1.
1010 int snat_static_mapping_match (
1011 vlib_main_t *vm, snat_main_t *sm, ip4_address_t match_addr, u16 match_port,
1012 u32 match_fib_index, nat_protocol_t match_protocol,
1013 ip4_address_t *mapping_addr, u16 *mapping_port, u32 *mapping_fib_index,
1014 u8 by_external, u8 *is_addr_only, twice_nat_type_t *twice_nat,
1015 lb_nat_type_t *lb, ip4_address_t *ext_host_addr, u8 *is_identity_nat,
1016 snat_static_mapping_t **out);
1019 * Why is this here? Because we don't need to touch this layer to
1020 * simply reply to an icmp. We need to change id to a unique
1021 * value to NAT an echo request/reply.
1028 } icmp_echo_header_t;
1032 u16 src_port, dst_port;
1035 u32 get_thread_idx_by_port (u16 e_port);
1037 u8 *format_static_mapping_kvp (u8 *s, va_list *args);
1039 u8 *format_session_kvp (u8 *s, va_list *args);
1041 u32 nat_calc_bihash_buckets (u32 n_elts);
1043 void nat44_addresses_free (snat_address_t **addresses);
1045 void nat44_ed_sessions_clear ();
1047 int nat44_ed_set_frame_queue_nelts (u32 frame_queue_nelts);
1051 NAT_ED_TRNSL_ERR_SUCCESS = 0,
1052 NAT_ED_TRNSL_ERR_TRANSLATION_FAILED = 1,
1053 NAT_ED_TRNSL_ERR_FLOW_MISMATCH = 2,
1054 NAT_ED_TRNSL_ERR_PACKET_TRUNCATED = 3,
1055 NAT_ED_TRNSL_ERR_INNER_IP_CORRUPT = 4,
1056 NAT_ED_TRNSL_ERR_INVALID_CSUM = 5,
1057 } nat_translation_error_e;
1059 nat_translation_error_e nat_6t_flow_buf_translate_i2o (
1060 vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip,
1061 nat_6t_flow_t *f, nat_protocol_t proto, int is_output_feature);
1063 nat_translation_error_e nat_6t_flow_buf_translate_o2i (
1064 vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip,
1065 nat_6t_flow_t *f, nat_protocol_t proto, int is_output_feature);
1067 void nat_6t_l3_l4_csum_calc (nat_6t_flow_t *f);
1069 format_function_t format_nat_ed_translation_error;
1070 format_function_t format_nat_6t_flow;
1071 format_function_t format_ed_session_kvp;
1073 #endif /* __included_nat44_ed_h__ */
1075 * fd.io coding-style-patch-verification: ON
1078 * eval: (c-set-style "gnu")