X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fplugins%2Fnat%2Fnat.h;h=1245b850ed00deae0ffe7b203a8ad2c232281742;hb=9bb09afb56b1aa787ca574cc732085272059fd5f;hp=98c18c06635a733b6650b9a8d4e3e5adc631a626;hpb=d9e18aac39827b576dda5ee456e17694988f5ac6;p=vpp.git diff --git a/src/plugins/nat/nat.h b/src/plugins/nat/nat.h index 98c18c06635..1245b850ed0 100644 --- a/src/plugins/nat/nat.h +++ b/src/plugins/nat/nat.h @@ -13,7 +13,8 @@ * limitations under the License. */ /** - * @file NAT plugin global declarations + * @file nat.c + * NAT plugin global declarations */ #ifndef __included_nat_h__ #define __included_nat_h__ @@ -64,15 +65,6 @@ typedef struct u32 next_index; } nat_pre_trace_t; -/* -STATIC_ASSERT (sizeof (nat_buffer_opaque_t) <= - STRUCT_SIZE_OF (vnet_buffer_opaque_t, unused), - "Custom meta-data too large for vnet_buffer_opaque_t"); - -#define nat_buffer_opaque(b) \ - ((nat_buffer_opaque_t *)((u8 *)((b)->opaque) + \ - STRUCT_OFFSET_OF (vnet_buffer_opaque_t, unused)))*/ - /* session key (4-tuple) */ typedef struct { @@ -88,23 +80,6 @@ typedef struct }; } snat_session_key_t; -/* endpoint-dependent session key (6-tuple) */ -typedef struct -{ - union - { - struct - { - ip4_address_t l_addr; - ip4_address_t r_addr; - u32 proto:8, fib_index:24; - u16 l_port; - u16 r_port; - }; - u64 as_u64[2]; - }; -} nat_ed_ses_key_t; - /* deterministic session outside key */ typedef struct { @@ -514,6 +489,9 @@ typedef struct /* real thread index */ u32 thread_index; + // per thread data structures + vlib_main_t *vlib_main; + } snat_main_per_thread_data_t; struct snat_main_s; @@ -538,7 +516,7 @@ typedef u32 (snat_get_worker_out2in_function_t) (vlib_buffer_t * b, u32 rx_fib_index, u8 is_output); -/* NAT address and port allacotaion function */ +/* NAT address and port allocation function */ typedef int (nat_alloc_out_addr_and_port_function_t) (snat_address_t * addresses, u32 fib_index, @@ -596,7 +574,7 @@ typedef struct snat_main_s /* vector of outside fibs */ nat_outside_fib_t *outside_fibs; - /* Vector of twice NAT addresses for extenal hosts */ + /* Vector of twice NAT addresses for external hosts */ snat_address_t *twice_nat_addresses; /* sw_if_indices whose intfc addresses should be auto-added */ @@ -660,12 +638,16 @@ typedef struct snat_main_s u8 deterministic; u8 out2in_dpo; u8 endpoint_dependent; + u32 translation_buckets; uword translation_memory_size; u32 max_translations; + u32 *max_translations_per_fib; + u32 user_buckets; uword user_memory_size; u32 max_translations_per_user; + u32 outside_vrf_id; u32 outside_fib_index; u32 inside_vrf_id; @@ -695,7 +677,6 @@ typedef struct snat_main_s u8 log_level; /* convenience */ - vlib_main_t *vlib_main; vnet_main_t *vnet_main; ip4_main_t *ip4_main; ip_lookup_main_t *ip4_lookup_main; @@ -738,7 +719,6 @@ extern fib_source_t nat_fib_src_low; /* format functions */ format_function_t format_snat_user; -format_function_t format_snat_user_v2; format_function_t format_snat_static_mapping; format_function_t format_snat_static_map_to_resolve; format_function_t format_snat_session; @@ -793,13 +773,13 @@ unformat_function_t unformat_snat_protocol; #define is_affinity_sessions(s) (s->flags & SNAT_SESSION_FLAG_AFFINITY) /** \brief Check if NAT interface is inside. - @param i NAT interfce + @param i NAT interface @return 1 if inside interface */ #define nat_interface_is_inside(i) i->flags & NAT_INTERFACE_FLAG_IS_INSIDE /** \brief Check if NAT interface is outside. - @param i NAT interfce + @param i NAT interface @return 1 if outside interface */ #define nat_interface_is_outside(i) i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE @@ -872,19 +852,19 @@ typedef enum nat_log_level_t_ #undef _ } nat_log_level_t; -#define nat_elog(_level, _str) \ -do \ - { \ - snat_main_t *sm = &snat_main; \ - if (PREDICT_FALSE (sm->log_level >= _level)) \ - { \ - ELOG_TYPE_DECLARE (e) = \ - { \ - .format = "nat-msg " _str, \ - .format_args = "", \ - }; \ - ELOG_DATA (&sm->vlib_main->elog_main, e); \ - } \ +#define nat_elog(_level, _str) \ +do \ + { \ + snat_main_t *sm = &snat_main; \ + if (PREDICT_FALSE (sm->log_level >= _level)) \ + { \ + ELOG_TYPE_DECLARE (e) = \ + { \ + .format = "nat-msg " _str, \ + .format_args = "", \ + }; \ + ELOG_DATA (&vlib_global_main.elog_main, e); \ + } \ } while (0); #define nat_elog_addr(_level, _str, _addr) \ @@ -992,24 +972,24 @@ do \ } \ } while (0); -#define nat_elog_X1(_level, _fmt, _arg, _val1) \ -do \ - { \ - snat_main_t *sm = &snat_main; \ - if (PREDICT_FALSE (sm->log_level >= _level)) \ - { \ - ELOG_TYPE_DECLARE (e) = \ - { \ - .format = "nat-msg " _fmt, \ - .format_args = _arg, \ - }; \ - CLIB_PACKED(struct \ - { \ - typeof (_val1) val1; \ - }) *ed; \ - ed = ELOG_DATA (&sm->vlib_main->elog_main, e); \ - ed->val1 = _val1; \ - } \ +#define nat_elog_X1(_level, _fmt, _arg, _val1) \ +do \ + { \ + snat_main_t *sm = &snat_main; \ + if (PREDICT_FALSE (sm->log_level >= _level)) \ + { \ + ELOG_TYPE_DECLARE (e) = \ + { \ + .format = "nat-msg " _fmt, \ + .format_args = _arg, \ + }; \ + CLIB_PACKED(struct \ + { \ + typeof (_val1) val1; \ + }) *ed; \ + ed = ELOG_DATA (&vlib_global_main.elog_main, e); \ + ed->val1 = _val1; \ + } \ } while (0); #define nat_elog_notice(nat_elog_str) \ @@ -1111,6 +1091,7 @@ int nat44_o2i_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg); /** * @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 @@ -1123,6 +1104,7 @@ int snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id, /** * @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 @@ -1229,11 +1211,11 @@ int snat_interface_add_del_output_feature (u32 sw_if_index, u8 is_inside, int is_del); /** - * @brief Add/delete NAT44 pool address from specific interfce + * @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 extenal hosts + * @param twice_nat 1 = twice NAT address for external hosts * * @return 0 on success, non-zero value otherwise */ @@ -1257,6 +1239,7 @@ int nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port, /** * @brief Delete NAT44 endpoint-dependent session * + * @param sm snat global configuration data * @param addr IPv4 address * @param port L4 port number * @param proto L4 protocol @@ -1270,8 +1253,9 @@ int nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port, u32 vrf_id, int is_in); /** - * @brief Free NAT44 session data (lookup keys, external addrres port) + * @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 @@ -1279,8 +1263,21 @@ int nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port, void nat_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index, u8 is_ha); +/** +<<<<<<< bdfe5955f59a735fd8d70e9026f8c1867a4c8cc6 + * @brief Set NAT44 session limit (session limit, vrf id) + * + * @param session_limit Session limit + * @param vrf_id VRF id + * @return 0 on success, non-zero value otherwise + */ +int nat44_set_session_limit (u32 session_limit, u32 vrf_id); + /** * @brief Free NAT44 ED session data (lookup keys, external addrres port) +======= + * @brief Free NAT44 ED session data (lookup keys, external address port) +>>>>>>> docs: clean up make docs job * * @param s NAT session * @param thread_index thread index @@ -1289,9 +1286,25 @@ void nat_free_session_data (snat_main_t * sm, snat_session_t * s, void nat44_free_session_data (snat_main_t * sm, snat_session_t * s, u32 thread_index, u8 is_ha); + +/** + * @brief Initialize NAT44 data + * + * @param tsm per thread data + */ +void nat44_db_init (snat_main_per_thread_data_t * tsm); + +/** + * @brief Free NAT44 data + * + * @param tsm per thread data + */ +void nat44_db_free (snat_main_per_thread_data_t * tsm); + /** * @brief Find or create NAT user * + * @param sm snat global configuration data * @param addr IPv4 address * @param fib_index FIB table index * @param thread_index thread index @@ -1305,8 +1318,10 @@ snat_user_t *nat_user_get_or_create (snat_main_t * sm, /** * @brief Allocate new NAT session or recycle last used * + * @param sm snat global configuration data * @param u NAT user * @param thread_index thread index + * @param now time now * * @return session data structure on success otherwise zero value */ @@ -1317,7 +1332,9 @@ snat_session_t *nat_session_alloc_or_recycle (snat_main_t * sm, /** * @brief Allocate NAT endpoint-dependent session * + * @param sm snat global configuration data * @param thread_index thread index + * @param now time now * * @return session data structure on success otherwise zero value */ @@ -1365,7 +1382,7 @@ void snat_free_outside_address_and_port (snat_address_t * addresses, * @param fib_index FIB table index * @param thread_index thread index * @param k allocated address and port pair - * @param port_per_thread number of ports per threead + * @param port_per_thread number of ports per thread * @param snat_thread_index NAT thread index * * @return 0 on success, non-zero value otherwise