X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fplugins%2Fnat%2Fnat44-ed%2Fnat44_ed.h;h=1ca71187ac77369659b32e0b30b9c3e7f96d579d;hb=691c630b7;hp=10d1207fec89a8ebce14225e27fc54205561bbea;hpb=0eaf4e6784efb2d058fe2f031578251b6bcc0aa8;p=vpp.git diff --git a/src/plugins/nat/nat44-ed/nat44_ed.h b/src/plugins/nat/nat44-ed/nat44_ed.h index 10d1207fec8..1ca71187ac7 100644 --- a/src/plugins/nat/nat44-ed/nat44_ed.h +++ b/src/plugins/nat/nat44-ed/nat44_ed.h @@ -12,10 +12,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * @file nat.c - * NAT plugin global declarations - */ + #ifndef __included_nat44_ed_h__ #define __included_nat44_ed_h__ @@ -28,6 +25,7 @@ #include #include #include +#include #include #include #include @@ -38,16 +36,20 @@ /* default number of worker handoff frame queue elements */ #define NAT_FQ_NELTS_DEFAULT 64 +/* number of attempts to get a port for ED overloading algorithm, if rolling + * a dice this many times doesn't produce a free port, it's treated + * as if there were no free ports available to conserve resources */ +#define ED_PORT_ALLOC_ATTEMPTS (10) + /* NAT buffer flags */ #define SNAT_FLAG_HAIRPINNING (1 << 0) /* NAT44 API Configuration flags */ -#define foreach_nat44_config_flag \ - _(0x00, IS_ENDPOINT_INDEPENDENT) \ - _(0x01, IS_ENDPOINT_DEPENDENT) \ - _(0x02, IS_STATIC_MAPPING_ONLY) \ - _(0x04, IS_CONNECTION_TRACKING) \ - _(0x08, IS_OUT2IN_DPO) +#define foreach_nat44_config_flag \ + _ (0x00, IS_ENDPOINT_INDEPENDENT) \ + _ (0x01, IS_ENDPOINT_DEPENDENT) \ + _ (0x02, IS_STATIC_MAPPING_ONLY) \ + _ (0x04, IS_CONNECTION_TRACKING) typedef enum nat44_config_flags_t_ { @@ -58,16 +60,9 @@ typedef enum nat44_config_flags_t_ typedef struct { - /* nat44 plugin features */ - u8 static_mapping_only; - u8 connection_tracking; - u32 inside_vrf; u32 outside_vrf; - - /* maximum number of sessions */ u32 sessions; - } nat44_config_t; typedef enum @@ -91,46 +86,13 @@ typedef struct u32 arc_next_index; } nat_pre_trace_t; -/* External address and port allocation modes */ -#define foreach_nat_addr_and_port_alloc_alg \ - _(0, DEFAULT, "default") \ - _(1, MAPE, "map-e") \ - _(2, RANGE, "port-range") - -typedef enum -{ -#define _(v, N, s) NAT_ADDR_AND_PORT_ALLOC_ALG_##N = v, - foreach_nat_addr_and_port_alloc_alg -#undef _ -} nat_addr_and_port_alloc_alg_t; - -/* Session state */ -#define foreach_snat_session_state \ - _(0, UNKNOWN, "unknown") \ - _(1, UDP_ACTIVE, "udp-active") \ - _(2, TCP_SYN_SENT, "tcp-syn-sent") \ - _(3, TCP_ESTABLISHED, "tcp-established") \ - _(4, TCP_FIN_WAIT, "tcp-fin-wait") \ - _(5, TCP_CLOSE_WAIT, "tcp-close-wait") \ - _(6, TCP_CLOSING, "tcp-closing") \ - _(7, TCP_LAST_ACK, "tcp-last-ack") \ - _(8, TCP_CLOSED, "tcp-closed") \ - _(9, ICMP_ACTIVE, "icmp-active") - -typedef enum -{ -#define _(v, N, s) SNAT_SESSION_##N = v, - foreach_snat_session_state -#undef _ -} snat_session_state_t; - -#define foreach_nat_in2out_ed_error \ -_(UNSUPPORTED_PROTOCOL, "unsupported protocol") \ -_(OUT_OF_PORTS, "out of ports") \ -_(BAD_ICMP_TYPE, "unsupported ICMP type") \ -_(MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \ -_(NON_SYN, "non-SYN packet try to create session") \ -_(TCP_CLOSED, "drops due to TCP in transitory timeout") +#define foreach_nat_in2out_ed_error \ + _ (UNSUPPORTED_PROTOCOL, "unsupported protocol") \ + _ (OUT_OF_PORTS, "out of ports") \ + _ (BAD_ICMP_TYPE, "unsupported ICMP type") \ + _ (MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \ + _ (NON_SYN, "non-SYN packet try to create session") \ + _ (TRNSL_FAILED, "couldn't translate packet") typedef enum { @@ -148,7 +110,8 @@ typedef enum _ (MAX_SESSIONS_EXCEEDED, "maximum sessions exceeded") \ _ (NON_SYN, "non-SYN packet try to create session") \ _ (TCP_CLOSED, "drops due to TCP in transitory timeout") \ - _ (HASH_ADD_FAILED, "hash table add failed") + _ (HASH_ADD_FAILED, "hash table add failed") \ + _ (TRNSL_FAILED, "couldn't translate packet") typedef enum { @@ -158,19 +121,53 @@ typedef enum NAT_OUT2IN_ED_N_ERROR, } nat_out2in_ed_error_t; +typedef enum +{ + NAT44_ED_TCP_FLAG_NONE = 0, + NAT44_ED_TCP_FLAG_FIN, + NAT44_ED_TCP_FLAG_SYN, + NAT44_ED_TCP_FLAG_SYNFIN, + NAT44_ED_TCP_FLAG_RST, + NAT44_ED_TCP_FLAG_FINRST, + NAT44_ED_TCP_FLAG_SYNRST, + NAT44_ED_TCP_FLAG_SYNFINRST, + NAT44_ED_TCP_N_FLAG, +} nat44_ed_tcp_flag_e; + +typedef enum +{ + NAT44_ED_DIR_I2O = 0, + NAT44_ED_DIR_O2I, + NAT44_ED_N_DIR, +} nat44_ed_dir_e; /* Endpoint dependent TCP session state */ -#define NAT44_SES_I2O_FIN 1 -#define NAT44_SES_O2I_FIN 2 -#define NAT44_SES_I2O_FIN_ACK 4 -#define NAT44_SES_O2I_FIN_ACK 8 -#define NAT44_SES_I2O_SYN 16 -#define NAT44_SES_O2I_SYN 32 -#define NAT44_SES_RST 64 +typedef enum +{ + NAT44_ED_TCP_STATE_CLOSED = 0, + NAT44_ED_TCP_STATE_SYN_I2O, + NAT44_ED_TCP_STATE_SYN_O2I, + NAT44_ED_TCP_STATE_ESTABLISHED, + NAT44_ED_TCP_STATE_FIN_I2O, + NAT44_ED_TCP_STATE_FIN_O2I, + NAT44_ED_TCP_STATE_RST_TRANS, + NAT44_ED_TCP_STATE_FIN_TRANS, + NAT44_ED_TCP_STATE_FIN_REOPEN_SYN_I2O, + NAT44_ED_TCP_STATE_FIN_REOPEN_SYN_O2I, + NAT44_ED_TCP_N_STATE, +} nat44_ed_tcp_state_e; + +format_function_t format_ed_session_kvp; +format_function_t format_snat_session; +format_function_t format_snat_static_mapping; +format_function_t format_snat_static_map_to_resolve; +format_function_t format_nat_ed_translation_error; +format_function_t format_nat_6t_flow; +format_function_t format_nat_6t; +format_function_t format_nat44_ed_tcp_state; /* Session flags */ #define SNAT_SESSION_FLAG_STATIC_MAPPING (1 << 0) -#define SNAT_SESSION_FLAG_UNKNOWN_PROTO (1 << 1) #define SNAT_SESSION_FLAG_LOAD_BALANCING (1 << 2) #define SNAT_SESSION_FLAG_TWICE_NAT (1 << 3) #define SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT (1 << 4) @@ -184,13 +181,15 @@ typedef enum #define NAT_INTERFACE_FLAG_IS_OUTSIDE 2 /* Static mapping flags */ -#define NAT_STATIC_MAPPING_FLAG_ADDR_ONLY 1 -#define NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY 2 -#define NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT 4 -#define NAT_STATIC_MAPPING_FLAG_LB 8 -#define NAT_STATIC_MAPPING_FLAG_EXACT_ADDRESS 16 +#define NAT_SM_FLAG_SELF_TWICE_NAT (1 << 1) +#define NAT_SM_FLAG_TWICE_NAT (1 << 2) +#define NAT_SM_FLAG_IDENTITY_NAT (1 << 3) +#define NAT_SM_FLAG_ADDR_ONLY (1 << 4) +#define NAT_SM_FLAG_EXACT_ADDRESS (1 << 5) +#define NAT_SM_FLAG_OUT2IN_ONLY (1 << 6) +#define NAT_SM_FLAG_LB (1 << 7) +#define NAT_SM_FLAG_SWITCH_ADDRESS (1 << 8) -/* *INDENT-OFF* */ typedef CLIB_PACKED(struct { // number of sessions in this vrf @@ -202,17 +201,23 @@ typedef CLIB_PACKED(struct // is this vrf expired u8 expired; }) per_vrf_sessions_t; -/* *INDENT-ON* */ -typedef struct +typedef union { - ip4_address_t saddr, daddr; - u32 fib_index; - u16 sport, dport; - u16 icmp_id; - u8 proto; + struct + { + ip4_address_t saddr, daddr; + u16 sport; // ICMP id for ICMP case + u16 dport; + u32 fib_index : 24; + u8 proto; + }; + u64 as_u64[2]; + u64x2u as_u128; } nat_6t_t; +STATIC_ASSERT_SIZEOF (nat_6t_t, 2 * sizeof (u64)); + typedef struct { #define NAT_FLOW_OP_SADDR_REWRITE (1 << 1) @@ -223,7 +228,15 @@ typedef struct #define NAT_FLOW_OP_TXFIB_REWRITE (1 << 6) int ops; nat_6t_t match; - nat_6t_t rewrite; + struct + { + ip4_address_t saddr, daddr; + u16 sport; + u16 dport; + u32 fib_index; + u8 proto; + u16 icmp_id; + } rewrite; uword l3_csum_delta; uword l4_csum_delta; } nat_6t_flow_t; @@ -272,7 +285,6 @@ nat_6t_flow_icmp_id_rewrite_set (nat_6t_flow_t *f, u16 id) f->rewrite.icmp_id = id; } -/* *INDENT-OFF* */ typedef CLIB_PACKED(struct { /* Outside network tuple */ @@ -291,7 +303,7 @@ typedef CLIB_PACKED(struct u16 port; } in2out; - nat_protocol_t nat_proto; + ip_protocol_t proto; nat_6t_flow_t i2o; nat_6t_flow_t o2i; @@ -324,43 +336,23 @@ typedef CLIB_PACKED(struct u16 ext_host_nat_port; /* TCP session state */ - u8 state; - u32 i2o_fin_seq; - u32 o2i_fin_seq; - u64 tcp_closed_timestamp; + nat44_ed_tcp_state_e tcp_state; /* per vrf sessions index */ u32 per_vrf_sessions_index; + u32 thread_index; }) snat_session_t; -/* *INDENT-ON* */ typedef struct { ip4_address_t addr; + ip4_address_t net; + u32 sw_if_index; u32 fib_index; -/* *INDENT-OFF* */ -#define _(N, i, n, s) \ - u32 busy_##n##_ports; \ - u32 * busy_##n##_ports_per_thread; \ - u32 busy_##n##_port_refcounts[65535]; - foreach_nat_protocol -#undef _ -/* *INDENT-ON* */ + u32 addr_len; } snat_address_t; -typedef struct -{ - u32 fib_index; - u32 ref_count; -} nat_fib_t; - -typedef struct -{ - u32 fib_index; - u32 refcount; -} nat_outside_fib_t; - typedef struct { /* backend IP address */ @@ -397,7 +389,7 @@ typedef enum typedef struct { - /* prefered pool address */ + /* preferred pool address */ ip4_address_t pool_addr; /* local IP address */ ip4_address_t local_addr; @@ -407,13 +399,11 @@ typedef struct u16 local_port; /* external port */ u16 external_port; - /* is twice-nat */ - twice_nat_type_t twice_nat; /* local FIB table */ u32 vrf_id; u32 fib_index; /* protocol */ - nat_protocol_t proto; + ip_protocol_t proto; /* 0 = disabled, otherwise client IP affinity sticky time in seconds */ u32 affinity; /* worker threads used by backends/local host */ @@ -436,21 +426,31 @@ typedef struct typedef struct { + u8 is_resolved; ip4_address_t l_addr; ip4_address_t pool_addr; u16 l_port; u16 e_port; u32 sw_if_index; u32 vrf_id; - nat_protocol_t proto; + ip_protocol_t proto; u32 flags; - int addr_only; - int twice_nat; - int out2in_only; - int identity_nat; - int exact; u8 *tag; -} snat_static_map_resolve_t; +} snat_static_mapping_resolve_t; + +typedef struct +{ + u8 is_resolved; + u8 is_twice_nat; + u32 sw_if_index; +} snat_address_resolve_t; + +typedef struct +{ + u32 count; + u32 sw_if_index; + ip4_address_t addr; +} snat_fib_entry_reg_t; typedef struct { @@ -480,26 +480,36 @@ typedef struct struct snat_main_s; +u32 nat44_ed_get_in2out_worker_index (vlib_buffer_t *b, ip4_header_t *ip, + u32 rx_fib_index, u8 is_output); +u32 nat44_ed_get_out2in_worker_index (vlib_buffer_t *b, ip4_header_t *ip, + u32 rx_fib_index, u8 is_output); + /* Return worker thread index for given packet */ -typedef u32 (snat_get_worker_in2out_function_t) (ip4_header_t * ip, - u32 rx_fib_index, - u8 is_output); +/* NAT address and port allocation function */ +typedef int (nat_alloc_out_addr_and_port_function_t) ( + snat_address_t *addresses, u32 fib_index, u32 thread_index, + ip_protocol_t proto, ip4_address_t *addr, u16 *port, u16 port_per_thread, + u32 snat_thread_index); -typedef u32 (snat_get_worker_out2in_function_t) (vlib_buffer_t * b, - ip4_header_t * ip, - u32 rx_fib_index, - u8 is_output); +typedef struct nat_fib_s +{ + u32 fib_index; + u32 ref_count; +} nat_fib_t; -/* NAT address and port allocation function */ -typedef int (nat_alloc_out_addr_and_port_function_t) (snat_address_t * - addresses, - u32 fib_index, - u32 thread_index, - nat_protocol_t proto, - ip4_address_t * addr, - u16 * port, - u16 port_per_thread, - u32 snat_thread_index); +typedef struct vrf_route_s +{ + u32 vrf_id; + u32 fib_index; +} vrf_route_t; + +typedef struct vrf_table_s +{ + u32 table_vrf_id; + u32 table_fib_index; + vrf_route_t *routes; +} vrf_table_t; typedef struct snat_main_s { @@ -507,19 +517,11 @@ typedef struct snat_main_s u32 num_workers; u32 first_worker_index; u32 *workers; - snat_get_worker_in2out_function_t *worker_in2out_cb; - snat_get_worker_out2in_function_t *worker_out2in_cb; u16 port_per_thread; /* Per thread data */ snat_main_per_thread_data_t *per_thread_data; - /* Find a static mapping by local */ - clib_bihash_8_8_t static_mapping_by_local; - - /* Find a static mapping by external */ - clib_bihash_8_8_t static_mapping_by_external; - /* Static mapping pool */ snat_static_mapping_t *static_mappings; @@ -530,39 +532,40 @@ typedef struct snat_main_s /* Endpoint dependent lookup table */ clib_bihash_16_8_t flow_hash; + // vector of fibs + nat_fib_t *fibs; + + u32 inside_vrf_id; + u32 inside_fib_index; + + u32 outside_vrf_id; + u32 outside_fib_index; + + // vector of outside fibs + nat_fib_t *outside_fibs; + + // VRF routing table for dynamic sessions + vrf_table_t *vrf_tables; + /* Interface pool */ snat_interface_t *interfaces; snat_interface_t *output_feature_interfaces; + // broken api backward compatibility + snat_interface_t *output_feature_dummy_interfaces; /* Vector of outside addresses */ snat_address_t *addresses; - /* Address and port allocation function */ - nat_alloc_out_addr_and_port_function_t *alloc_addr_and_port; - /* Address and port allocation type */ - nat_addr_and_port_alloc_alg_t addr_and_port_alloc_alg; - /* Port set parameters (MAP-E) */ - u8 psid_offset; - u8 psid_length; - u16 psid; - /* Port range parameters */ - u16 start_port; - u16 end_port; - - /* vector of fibs */ - nat_fib_t *fibs; - - /* vector of outside fibs */ - nat_outside_fib_t *outside_fibs; - /* Vector of twice NAT addresses for external hosts */ snat_address_t *twice_nat_addresses; - /* sw_if_indices whose intfc addresses should be auto-added */ - u32 *auto_add_sw_if_indices; - u32 *auto_add_sw_if_indices_twice_nat; + /* first interface address should be auto-added */ + snat_address_resolve_t *addr_to_resolve; + + /* vector of fib entries */ + snat_fib_entry_reg_t *fib_entry_reg; /* vector of interface address static mappings to resolve. */ - snat_static_map_resolve_t *to_resolve; + snat_static_mapping_resolve_t *sm_to_resolve; /* Randomize port allocation order */ u32 random_seed; @@ -572,20 +575,11 @@ typedef struct snat_main_s u32 fq_in2out_output_index; u32 fq_out2in_index; - u32 out2in_node_index; - u32 in2out_node_index; - u32 in2out_output_node_index; - nat44_config_t rconfig; - //nat44_config_t cconfig; /* If forwarding is enabled */ u8 forwarding_enabled; - /* static mapping config */ - u8 static_mapping_only; - u8 static_mapping_connection_tracking; - /* Is translation memory size calculated or user defined */ u8 translation_memory_size_set; @@ -593,11 +587,6 @@ typedef struct snat_main_s u32 max_translations_per_thread; u32 *max_translations_per_fib; - u32 outside_vrf_id; - u32 outside_fib_index; - u32 inside_vrf_id; - u32 inside_fib_index; - nat_timeouts_t timeouts; /* TCP MSS clamping */ @@ -605,6 +594,8 @@ typedef struct snat_main_s /* counters */ vlib_simple_counter_main_t total_sessions; + u32 max_cfg_sessions_gauge; /* Index of max configured sessions gauge in + stats */ #define _(x) vlib_simple_counter_main_t x; struct @@ -648,16 +639,11 @@ typedef struct snat_main_s u8 log_level; /* convenience */ - api_main_t *api_main; ip4_main_t *ip4_main; - ip_lookup_main_t *ip4_lookup_main; fib_source_t fib_src_hi; fib_source_t fib_src_low; - /* pat - dynamic mapping enabled or conneciton tracking */ - u8 pat; - /* number of worker handoff frame queue elements */ u32 frame_queue_nelts; @@ -666,6 +652,16 @@ typedef struct snat_main_s vnet_main_t *vnet_main; + /* TCP session state machine table: + * first dimension is possible states + * second dimension is direction (in2out/out2in) + * third dimension is TCP flag (SYN, RST, FIN) + * + * value is next state to change to + */ + nat44_ed_tcp_state_e tcp_state_change_table[NAT44_ED_TCP_N_STATE] + [NAT44_ED_N_DIR] + [NAT44_ED_TCP_N_FLAG]; } snat_main_t; typedef struct @@ -677,319 +673,218 @@ typedef struct typedef struct { u32 cached_sw_if_index; - u32 cached_ip4_address; + uword *cached_presence_by_ip4_address; } snat_runtime_t; +/* + * Why is this here? Because we don't need to touch this layer to + * simply reply to an icmp. We need to change id to a unique + * value to NAT an echo request/reply. + */ + extern snat_main_t snat_main; -// nat pre ed next_node feature classification extern vlib_node_registration_t nat_default_node; extern vlib_node_registration_t nat_pre_in2out_node; extern vlib_node_registration_t nat_pre_out2in_node; -extern vlib_node_registration_t snat_in2out_node; -extern vlib_node_registration_t snat_in2out_output_node; -extern vlib_node_registration_t snat_out2in_node; -extern vlib_node_registration_t snat_in2out_worker_handoff_node; -extern vlib_node_registration_t snat_in2out_output_worker_handoff_node; -extern vlib_node_registration_t snat_out2in_worker_handoff_node; extern vlib_node_registration_t nat44_ed_in2out_node; extern vlib_node_registration_t nat44_ed_in2out_output_node; extern vlib_node_registration_t nat44_ed_out2in_node; -extern fib_source_t nat_fib_src_hi; -extern fib_source_t nat_fib_src_low; - -/* format functions */ -format_function_t format_snat_static_mapping; -format_function_t format_snat_static_map_to_resolve; -format_function_t format_snat_session; -format_function_t format_snat_key; -format_function_t format_static_mapping_key; -format_function_t format_nat_protocol; -format_function_t format_nat_addr_and_port_alloc_alg; -/* unformat functions */ -unformat_function_t unformat_nat_protocol; +extern vlib_node_registration_t snat_in2out_worker_handoff_node; +extern vlib_node_registration_t snat_in2out_output_worker_handoff_node; +extern vlib_node_registration_t snat_out2in_worker_handoff_node; /** \brief Check if SNAT session is created from static mapping. @param s SNAT session - @return 1 if SNAT session is created from static mapping otherwise 0 + @return true if SNAT session is created from static mapping otherwise 0 */ -#define snat_is_session_static(s) (s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING) - -/** \brief Check if SNAT session for unknown protocol. - @param s SNAT session - @return 1 if SNAT session for unknown protocol otherwise 0 -*/ -#define snat_is_unk_proto_session(s) (s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO) +always_inline bool +nat44_ed_is_session_static (snat_session_t *s) +{ + return s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING; +} /** \brief Check if NAT session is twice NAT. @param s NAT session - @return 1 if NAT session is twice NAT + @return true if NAT session is twice NAT */ -#define is_twice_nat_session(s) (s->flags & SNAT_SESSION_FLAG_TWICE_NAT) +always_inline bool +nat44_ed_is_twice_nat_session (snat_session_t *s) +{ + return s->flags & SNAT_SESSION_FLAG_TWICE_NAT; +} /** \brief Check if NAT session is load-balancing. @param s NAT session - @return 1 if NAT session is load-balancing + @return true if NAT session is load-balancing */ -#define is_lb_session(s) (s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING) +always_inline bool +nat44_ed_is_lb_session (snat_session_t *s) +{ + return s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING; +} /** \brief Check if NAT session is forwarding bypass. @param s NAT session - @return 1 if NAT session is load-balancing + @return true if NAT session is load-balancing */ -#define is_fwd_bypass_session(s) (s->flags & SNAT_SESSION_FLAG_FWD_BYPASS) - -/** \brief Check if NAT session is endpoint dependent. - @param s NAT session - @return 1 if NAT session is endpoint dependent -*/ -#define is_ed_session(s) (s->flags & SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT) +always_inline bool +na44_ed_is_fwd_bypass_session (snat_session_t *s) +{ + return s->flags & SNAT_SESSION_FLAG_FWD_BYPASS; +} /** \brief Check if NAT session has affinity record. @param s NAT session - @return 1 if NAT session has affinity record + @return true if NAT session has affinity record */ -#define is_affinity_sessions(s) (s->flags & SNAT_SESSION_FLAG_AFFINITY) +always_inline bool +nat44_ed_is_affinity_session (snat_session_t *s) +{ + return s->flags & SNAT_SESSION_FLAG_AFFINITY; +} /** \brief Check if exact pool address should be used. @param s SNAT session - @return 1 if exact pool address or 0 + @return true if exact pool address */ -#define is_exact_address_session(s) (s->flags & SNAT_SESSION_FLAG_EXACT_ADDRESS) +always_inline bool +nat44_ed_is_exact_address_session (snat_session_t *s) +{ + return s->flags & SNAT_SESSION_FLAG_EXACT_ADDRESS; +} /** \brief Check if NAT interface is inside. @param i NAT interface - @return 1 if inside interface + @return true if inside interface */ -#define nat_interface_is_inside(i) i->flags & NAT_INTERFACE_FLAG_IS_INSIDE +always_inline bool +nat44_ed_is_interface_inside (snat_interface_t *i) +{ + return i->flags & NAT_INTERFACE_FLAG_IS_INSIDE; +} /** \brief Check if NAT interface is outside. @param i NAT interface - @return 1 if outside interface + @return true if outside interface */ -#define nat_interface_is_outside(i) i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE +always_inline bool +nat44_ed_is_interface_outside (snat_interface_t *i) +{ + return i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE; +} -/** \brief Check if NAT44 endpoint-dependent TCP session is closed. - @param s NAT session - @return 1 if session is closed +/** \brief Check if client initiating TCP connection (received SYN from client) + @param t TCP header + @return true if client initiating TCP connection */ -#define nat44_is_ses_closed(s) s->state == 0xf +always_inline bool +tcp_flags_is_init (u8 f) +{ + return (f & TCP_FLAG_SYN) && !(f & TCP_FLAG_ACK); +} -/** \brief Check if NAT static mapping is address only (1:1NAT). - @param sm NAT static mapping - @return 1 if 1:1NAT, 0 if 1:1NAPT -*/ -#define is_addr_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_ADDR_ONLY) +always_inline bool +is_sm_addr_only (u32 f) +{ + return (f & NAT_SM_FLAG_ADDR_ONLY); +} -/** \brief Check if NAT static mapping match only out2in direction. - @param sm NAT static mapping - @return 1 if rule match only out2in direction -*/ -#define is_out2in_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY) +always_inline bool +is_sm_out2in_only (u32 f) +{ + return (f & NAT_SM_FLAG_OUT2IN_ONLY); +} -/** \brief Check if NAT static mapping is identity NAT. - @param sm NAT static mapping - @return 1 if identity NAT -*/ -#define is_identity_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT) +always_inline bool +is_sm_identity_nat (u32 f) +{ + return (f & NAT_SM_FLAG_IDENTITY_NAT); +} -/** \brief Check if NAT static mapping is load-balancing. - @param sm NAT static mapping - @return 1 if load-balancing -*/ -#define is_lb_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_LB) +always_inline bool +is_sm_lb (u32 f) +{ + return (f & NAT_SM_FLAG_LB); +} -/** \brief Check if exact pool address should be used. - @param s SNAT session - @return 1 if exact pool address or 0 -*/ -#define is_exact_address(s) (s->flags & NAT_STATIC_MAPPING_FLAG_EXACT_ADDRESS) +always_inline bool +is_sm_exact_address (u32 f) +{ + return (f & NAT_SM_FLAG_EXACT_ADDRESS); +} -/** \brief Check if client initiating TCP connection (received SYN from client) - @param t TCP header - @return 1 if client initiating TCP connection -*/ always_inline bool -tcp_flags_is_init (u8 f) +is_sm_self_twice_nat (u32 f) { - return (f & TCP_FLAG_SYN) && !(f & TCP_FLAG_ACK); + return (f & NAT_SM_FLAG_SELF_TWICE_NAT); +} + +always_inline bool +is_sm_twice_nat (u32 f) +{ + return (f & NAT_SM_FLAG_TWICE_NAT); +} + +always_inline bool +is_sm_switch_address (u32 f) +{ + return (f & NAT_SM_FLAG_SWITCH_ADDRESS); } -/* logging */ #define nat_log_err(...) \ vlib_log(VLIB_LOG_LEVEL_ERR, snat_main.log_class, __VA_ARGS__) #define nat_log_warn(...) \ vlib_log(VLIB_LOG_LEVEL_WARNING, snat_main.log_class, __VA_ARGS__) -#define nat_log_notice(...) \ - vlib_log(VLIB_LOG_LEVEL_NOTICE, snat_main.log_class, __VA_ARGS__) #define nat_log_info(...) \ vlib_log(VLIB_LOG_LEVEL_INFO, snat_main.log_class, __VA_ARGS__) #define nat_log_debug(...)\ vlib_log(VLIB_LOG_LEVEL_DEBUG, snat_main.log_class, __VA_ARGS__) -/** - * @brief Enable NAT44 plugin - * - * @param c nat44_config_t - * - * @return 0 on success, non-zero value otherwise - */ -int nat44_plugin_enable (nat44_config_t c); +clib_error_t *nat44_api_hookup (vlib_main_t *vm); -/** - * @brief Disable NAT44 plugin - * - * @return 0 on success, non-zero value otherwise - */ -int nat44_plugin_disable (); +int snat_set_workers (uword *bitmap); -/** - * @brief Add external address to NAT44 pool - * - * @param sm snat global configuration data - * @param addr IPv4 address - * @param vrf_id VRF id of tenant, ~0 means independent of VRF - * @param twice_nat 1 if twice NAT address - * - * @return 0 on success, non-zero value otherwise - */ -int snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id, - u8 twice_nat); - -/** - * @brief Delete external address from NAT44 pool - * - * @param sm snat global configuration data - * @param addr IPv4 address - * @param delete_sm 1 if delete static mapping using address - * @param twice_nat 1 if twice NAT address - * - * @return 0 on success, non-zero value otherwise - */ -int snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm, - u8 twice_nat); - -/** - * @brief Add/delete external address to FIB DPO (out2in DPO mode) - * - * @param addr IPv4 address - * @param is_add 1 = add, 0 = delete - * - * @return 0 on success, non-zero value otherwise - */ -void nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add); - -/** - * @brief Add/delete NAT44 static mapping - * - * @param l_addr local IPv4 address - * @param e_addr external IPv4 address - * @param l_port local port number - * @param e_port external port number - * @param vrf_id local VRF ID - * @param addr_only 1 = 1:1NAT, 0 = 1:1NAPT - * @param sw_if_index use interface address as external IPv4 address - * @param proto L4 protocol - * @param is_add 1 = add, 0 = delete - * @param twice_nat twice-nat mode - * @param out2in_only if 1 rule match only out2in direction - * @param tag opaque string tag - * @param identity_nat identity NAT - * @param pool_addr pool IPv4 address - * @param exact 1 = exact pool address - * - * @return 0 on success, non-zero value otherwise - */ -int snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr, - u16 l_port, u16 e_port, u32 vrf_id, - int addr_only, u32 sw_if_index, - nat_protocol_t proto, int is_add, - twice_nat_type_t twice_nat, u8 out2in_only, - u8 * tag, u8 identity_nat, - ip4_address_t pool_addr, int exact); +int nat44_plugin_enable (nat44_config_t c); +int nat44_plugin_disable (); -/** - * @brief Add/delete static mapping with load-balancing (multiple backends) - * - * @param e_addr external IPv4 address - * @param e_port external port number - * @param proto L4 protocol - * @param locals list of local backends - * @param is_add 1 = add, 0 = delete - * @param twice_nat twice-nat mode - * @param out2in_only if 1 rule match only out2in direction - * @param tag opaque string tag - * @param affinity 0 = disabled, otherwise client IP affinity sticky time - * - * @return 0 on success, non-zero value otherwise - */ -int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port, - nat_protocol_t proto, - nat44_lb_addr_port_t * locals, u8 is_add, - twice_nat_type_t twice_nat, - u8 out2in_only, u8 * tag, u32 affinity); +int nat44_ed_add_interface (u32 sw_if_index, u8 is_inside); +int nat44_ed_del_interface (u32 sw_if_index, u8 is_inside); +int nat44_ed_add_output_interface (u32 sw_if_index); +int nat44_ed_del_output_interface (u32 sw_if_index); -int nat44_lb_static_mapping_add_del_local (ip4_address_t e_addr, u16 e_port, - ip4_address_t l_addr, u16 l_port, - nat_protocol_t proto, u32 vrf_id, - u8 probability, u8 is_add); +int nat44_ed_add_address (ip4_address_t *addr, u32 vrf_id, u8 twice_nat); +int nat44_ed_del_address (ip4_address_t addr, u8 twice_nat); +int nat44_ed_add_interface_address (u32 sw_if_index, u8 twice_nat); +int nat44_ed_del_interface_address (u32 sw_if_index, u8 twice_nat); -clib_error_t *nat44_api_hookup (vlib_main_t * vm); +int nat44_ed_add_del_vrf_table (u32 table_vrf_id, bool is_add); +int nat44_ed_add_del_vrf_route (u32 table_vrf_id, u32 vrf_id, bool is_add); +void nat44_ed_del_vrf_tables (); -/** - * @brief Set NAT plugin workers - * - * @param bitmap NAT workers bitmap - * - * @return 0 on success, non-zero value otherwise - */ -int snat_set_workers (uword * bitmap); +int nat44_ed_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr, + u16 l_port, u16 e_port, ip_protocol_t proto, + u32 vrf_id, u32 sw_if_index, u32 flags, + ip4_address_t pool_addr, u8 *tag); -/** - * @brief Set NAT plugin number of frame queue elements - * - * @param frame_queue_nelts number of worker handoff frame queue elements - * - * @return 0 on success, non-zero value otherwise - */ -int snat_set_frame_queue_nelts (u32 frame_queue_nelts); +int nat44_ed_del_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr, + u16 l_port, u16 e_port, ip_protocol_t proto, + u32 vrf_id, u32 sw_if_index, u32 flags); -/** - * @brief Enable/disable NAT44 feature on the interface - * - * @param sw_if_index software index of the interface - * @param is_inside 1 = inside, 0 = outside - * @param is_del 1 = delete, 0 = add - * - * @return 0 on success, non-zero value otherwise - */ -int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del); +int nat44_ed_add_lb_static_mapping (ip4_address_t e_addr, u16 e_port, + ip_protocol_t proto, + nat44_lb_addr_port_t *locals, u32 flags, + u8 *tag, u32 affinity); -/** - * @brief Enable/disable NAT44 output feature on the interface (postrouting NAT) - * - * @param sw_if_index software index of the interface - * @param is_inside 1 = inside, 0 = outside - * @param is_del 1 = delete, 0 = add - * - * @return 0 on success, non-zero value otherwise - */ -int snat_interface_add_del_output_feature (u32 sw_if_index, u8 is_inside, - int is_del); +int nat44_ed_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port, + ip_protocol_t proto, u32 flags); -/** - * @brief Add/delete NAT44 pool address from specific interface - * - * @param sw_if_index software index of the interface - * @param is_del 1 = delete, 0 = add - * @param twice_nat 1 = twice NAT address for external hosts - * - * @return 0 on success, non-zero value otherwise - */ -int snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del, - u8 twice_nat); +int nat44_ed_add_del_lb_static_mapping_local (ip4_address_t e_addr, u16 e_port, + ip4_address_t l_addr, u16 l_port, + ip_protocol_t proto, u32 vrf_id, + u8 probability, u8 is_add); /** * @brief Delete NAT44 endpoint-dependent session @@ -1003,20 +898,12 @@ int snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del, * * @return 0 on success, non-zero value otherwise */ -int nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port, - ip4_address_t * eh_addr, u16 eh_port, u8 proto, +int nat44_ed_del_session (snat_main_t *sm, ip4_address_t *addr, u16 port, + ip4_address_t *eh_addr, u16 eh_port, u8 proto, u32 vrf_id, int is_in); -/** - * @brief Free NAT44 session data (lookup keys, external address port) - * - * @param sm snat global configuration data - * @param s NAT session - * @param thread_index thread index - * @param is_ha is HA event - */ -void nat_free_session_data (snat_main_t * sm, snat_session_t * s, - u32 thread_index, u8 is_ha); +void nat44_ed_free_session_data (snat_main_t *sm, snat_session_t *s, + u32 thread_index, u8 is_ha); /** * @brief Set NAT44 session limit (session limit, vrf id) @@ -1036,117 +923,20 @@ int nat44_set_session_limit (u32 session_limit, u32 vrf_id); */ int nat44_update_session_limit (u32 session_limit, u32 vrf_id); -/** - * @brief Free outside address and port pair - * - * @param addresses vector of outside addresses - * @param thread_index thread index - * @param key address, port and protocol - */ -void -snat_free_outside_address_and_port (snat_address_t * addresses, - u32 thread_index, - ip4_address_t * addr, - u16 port, nat_protocol_t protocol); - void expire_per_vrf_sessions (u32 fib_index); -/** - * @brief Match NAT44 static mapping. - * - * @param key address and port to match - * @param addr external/local address of the matched mapping - * @param port port of the matched mapping - * @param fib_index fib index of the matched mapping - * @param by_external if 0 match by local address otherwise match by external - * address - * @param is_addr_only 1 if matched mapping is address only - * @param twice_nat matched mapping is twice NAT type - * @param lb 1 if matched mapping is load-balanced - * @param ext_host_addr external host address - * @param is_identity_nat 1 if indentity mapping - * @param out if !=0 set to pointer of the mapping structure - * - * @returns 0 if match found otherwise 1. - */ -int snat_static_mapping_match (snat_main_t * sm, - ip4_address_t match_addr, - u16 match_port, - u32 match_fib_index, - nat_protocol_t match_protocol, - ip4_address_t * mapping_addr, - u16 * mapping_port, - u32 * mapping_fib_index, - u8 by_external, - u8 * is_addr_only, - twice_nat_type_t * twice_nat, - lb_nat_type_t * lb, - ip4_address_t * ext_host_addr, - u8 * is_identity_nat, - snat_static_mapping_t ** out); - -/** - * @brief Add/del NAT address to FIB. - * - * Add the external NAT address to the FIB as receive entries. This ensures - * that VPP will reply to ARP for this address and we don't need to enable - * proxy ARP on the outside interface. - * - * @param addr IPv4 address - * @param plen address prefix length - * @param sw_if_index software index of the outside interface - * @param is_add 0 = delete, 1 = add. - */ -void snat_add_del_addr_to_fib (ip4_address_t * addr, - u8 p_len, u32 sw_if_index, int is_add); - -#if 0 -void -nat_ha_sadd_ed_cb (ip4_address_t * in_addr, u16 in_port, - ip4_address_t * out_addr, u16 out_port, - ip4_address_t * eh_addr, u16 eh_port, - ip4_address_t * ehn_addr, u16 ehn_port, u8 proto, - u32 fib_index, u16 flags, u32 thread_index); - -void -nat_ha_sdel_ed_cb (ip4_address_t * out_addr, u16 out_port, - ip4_address_t * eh_addr, u16 eh_port, u8 proto, - u32 fib_index, u32 ti); - -void -nat_ha_sref_ed_cb (ip4_address_t * out_addr, u16 out_port, - ip4_address_t * eh_addr, u16 eh_port, u8 proto, - u32 fib_index, u32 total_pkts, u64 total_bytes, - u32 thread_index); -#endif - -int nat_set_outside_address_and_port (snat_address_t *addresses, - u32 thread_index, ip4_address_t addr, - u16 port, nat_protocol_t protocol); - -/* - * Why is this here? Because we don't need to touch this layer to - * simply reply to an icmp. We need to change id to a unique - * value to NAT an echo request/reply. - */ - -typedef struct -{ - u16 identifier; - u16 sequence; -} icmp_echo_header_t; - -typedef struct -{ - u16 src_port, dst_port; -} tcp_udp_header_t; +int snat_static_mapping_match (vlib_main_t *vm, ip4_address_t match_addr, + u16 match_port, u32 match_fib_index, + ip_protocol_t match_protocol, + ip4_address_t *mapping_addr, u16 *mapping_port, + u32 *mapping_fib_index, int by_external, + u8 *is_addr_only, twice_nat_type_t *twice_nat, + lb_nat_type_t *lb, ip4_address_t *ext_host_addr, + u8 *is_identity_nat, + snat_static_mapping_t **out); u32 get_thread_idx_by_port (u16 e_port); -u8 *format_static_mapping_kvp (u8 *s, va_list *args); - -u8 *format_session_kvp (u8 *s, va_list *args); - u32 nat_calc_bihash_buckets (u32 n_elts); void nat44_addresses_free (snat_address_t **addresses); @@ -1155,23 +945,45 @@ void nat44_ed_sessions_clear (); int nat44_ed_set_frame_queue_nelts (u32 frame_queue_nelts); +void nat_6t_l3_l4_csum_calc (nat_6t_flow_t *f); + +snat_static_mapping_t *nat44_ed_sm_i2o_lookup (snat_main_t *sm, + ip4_address_t addr, u16 port, + u32 fib_index, u8 proto); + +snat_static_mapping_t *nat44_ed_sm_o2i_lookup (snat_main_t *sm, + ip4_address_t addr, u16 port, + u32 fib_index, u8 proto); + +void nat_syslog_nat44_sadd (u32 ssubix, u32 sfibix, ip4_address_t *isaddr, + u16 isport, ip4_address_t *idaddr, u16 idport, + ip4_address_t *xsaddr, u16 xsport, + ip4_address_t *xdaddr, u16 xdport, u8 proto, + u8 is_twicenat); + +void nat_syslog_nat44_sdel (u32 ssubix, u32 sfibix, ip4_address_t *isaddr, + u16 isport, ip4_address_t *idaddr, u16 idport, + ip4_address_t *xsaddr, u16 xsport, + ip4_address_t *xdaddr, u16 xdport, u8 proto, + u8 is_twicenat); + typedef enum { NAT_ED_TRNSL_ERR_SUCCESS = 0, NAT_ED_TRNSL_ERR_TRANSLATION_FAILED = 1, NAT_ED_TRNSL_ERR_FLOW_MISMATCH = 2, + NAT_ED_TRNSL_ERR_PACKET_TRUNCATED = 3, + NAT_ED_TRNSL_ERR_INNER_IP_CORRUPT = 4, + NAT_ED_TRNSL_ERR_INVALID_CSUM = 5, } nat_translation_error_e; -nat_translation_error_e -nat_6t_flow_buf_translate (snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip, - nat_6t_flow_t *f, nat_protocol_t proto, - int is_output_feature); +nat_translation_error_e nat_6t_flow_buf_translate_i2o ( + vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip, + nat_6t_flow_t *f, ip_protocol_t proto, int is_output_feature); -void nat_6t_l3_l4_csum_calc (nat_6t_flow_t *f); - -format_function_t format_nat_ed_translation_error; -format_function_t format_nat_6t_flow; -format_function_t format_ed_session_kvp; +nat_translation_error_e nat_6t_flow_buf_translate_o2i ( + vlib_main_t *vm, snat_main_t *sm, vlib_buffer_t *b, ip4_header_t *ip, + nat_6t_flow_t *f, ip_protocol_t proto, int is_output_feature); #endif /* __included_nat44_ed_h__ */ /*