NAT64 global declarations. More...

Include dependency graph for nat64.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	nat64_prefix_t

struct	nat64_static_bib_to_update_t

struct	nat64_main_t

Macros
#define	foreach_nat64_tcp_ses_state

Typedefs
typedef int(*	nat64_pool_addr_walk_fn_t) (snat_address_t addr, void ctx)
	Call back function when walking addresses in NAT64 pool, non-zero return value stop walk. More...

typedef int(*	nat64_interface_walk_fn_t) (snat_interface_t i, void ctx)
	Call back function when walking interfaces with NAT64 feature, non-zero return value stop walk. More...

typedef int(*	nat64_prefix_walk_fn_t) (nat64_prefix_t pref64, void ctx)
	Call back function when walking addresses in NAT64 prefixes, non-zero return value stop walk. More...

Enumerations
enum	nat64_tcp_ses_state_t { foreach_nat64_tcp_ses_state }

enum	nat64_cleaner_process_event_e { NAT64_CLEANER_RESCHEDULE = 1 }

Functions
int	nat64_add_del_pool_addr (u32 thread_index, ip4_address_t *addr, u32 vrf_id, u8 is_add)
	Add/delete address to NAT64 pool. More...

void	nat64_pool_addr_walk (nat64_pool_addr_walk_fn_t fn, void *ctx)
	Walk NAT64 pool. More...

int	nat64_add_interface_address (u32 sw_if_index, int is_add)
	NAT64 pool address from specific (DHCP addressed) interface. More...

int	nat64_add_del_interface (u32 sw_if_index, u8 is_inside, u8 is_add)
	Enable/disable NAT64 feature on the interface. More...

void	nat64_interfaces_walk (nat64_interface_walk_fn_t fn, void *ctx)
	Walk NAT64 interfaces. More...

clib_error_t *	nat64_init (vlib_main_t *vm)
	Initialize NAT64. More...

int	nat64_add_del_static_bib_entry (ip6_address_t in_addr, ip4_address_t out_addr, u16 in_port, u16 out_port, u8 proto, u32 vrf_id, u8 is_add)
	Add/delete static NAT64 BIB entry. More...

int	nat64_alloc_out_addr_and_port (u32 fib_index, snat_protocol_t proto, ip4_address_t addr, u16 port, u32 thread_index)
	Alloce IPv4 address and port pair from NAT64 pool. More...

int	nat64_set_udp_timeout (u32 timeout)
	Set UDP session timeout. More...

u32	nat64_get_udp_timeout (void)
	Get UDP session timeout. More...

int	nat64_set_icmp_timeout (u32 timeout)
	Set ICMP session timeout. More...

u32	nat64_get_icmp_timeout (void)
	Get ICMP session timeout. More...

int	nat64_set_tcp_timeouts (u32 trans, u32 est)
	Set TCP session timeouts. More...

u32	nat64_get_tcp_trans_timeout (void)
	Get TCP transitory timeout. More...

u32	nat64_get_tcp_est_timeout (void)
	Get TCP established timeout. More...

void	nat64_session_reset_timeout (nat64_db_st_entry_t ste, vlib_main_t vm)
	Reset NAT64 session timeout. More...

void	nat64_tcp_session_set_state (nat64_db_st_entry_t ste, tcp_header_t tcp, u8 is_ip6)
	Set NAT64 TCP session state. More...

int	nat64_add_del_prefix (ip6_address_t *prefix, u8 plen, u32 vrf_id, u8 is_add)
	Add/delete NAT64 prefix. More...

void	nat64_prefix_walk (nat64_prefix_walk_fn_t fn, void *ctx)
	Walk NAT64 prefixes. More...

void	nat64_compose_ip6 (ip6_address_t ip6, ip4_address_t ip4, u32 fib_index)
	Compose IPv4-embedded IPv6 addresses. More...

void	nat64_extract_ip4 (ip6_address_t ip6, ip4_address_t ip4, u32 fib_index)
	Extract IPv4 address from the IPv4-embedded IPv6 addresses. More...

void	nat64_set_hash (u32 bib_buckets, u32 bib_memory_size, u32 st_buckets, u32 st_memory_size)
	Set NAT64 hash tables configuration. More...

u32	nat64_get_worker_in2out (ip6_address_t *addr)
	Get worker thread index for NAT64 in2out. More...

u32	nat64_get_worker_out2in (ip4_header_t *ip)
	Get worker thread index for NAT64 out2in. More...

Variables
nat64_main_t	nat64_main

vlib_node_registration_t	nat64_in2out_node
	(constructor) VLIB_REGISTER_NODE (nat64_in2out_node) More...

vlib_node_registration_t	nat64_out2in_node
	(constructor) VLIB_REGISTER_NODE (nat64_out2in_node) More...

Detailed Description

NAT64 global declarations.

Definition in file nat64.h.

Macro Definition Documentation

◆ foreach_nat64_tcp_ses_state

#define foreach_nat64_tcp_ses_state

Value:

_(0, CLOSED, "closed")                       \
  _(1, V4_INIT, "v4-init")                     \
  _(2, V6_INIT, "v6-init")                     \
  _(3, ESTABLISHED, "established")             \
  _(4, V4_FIN_RCV, "v4-fin-rcv")               \
  _(5, V6_FIN_RCV, "v6-fin-rcv")               \
  _(6, V6_FIN_V4_FIN_RCV, "v6-fin-v4-fin-rcv") \
  _(7, TRANS, "trans")

Definition at line 25 of file nat64.h.

Typedef Documentation

◆ nat64_interface_walk_fn_t

typedef int(* nat64_interface_walk_fn_t) (snat_interface_t *i, void *ctx)

Call back function when walking interfaces with NAT64 feature, non-zero return value stop walk.

Definition at line 183 of file nat64.h.

◆ nat64_pool_addr_walk_fn_t

typedef int(* nat64_pool_addr_walk_fn_t) (snat_address_t *addr, void *ctx)

Call back function when walking addresses in NAT64 pool, non-zero return value stop walk.

Definition at line 148 of file nat64.h.

◆ nat64_prefix_walk_fn_t

typedef int(* nat64_prefix_walk_fn_t) (nat64_prefix_t *pref64, void *ctx)

Call back function when walking addresses in NAT64 prefixes, non-zero return value stop walk.

Definition at line 327 of file nat64.h.

Enumeration Type Documentation

◆ nat64_cleaner_process_event_e

enum nat64_cleaner_process_event_e

Enumerator
NAT64_CLEANER_RESCHEDULE

Definition at line 42 of file nat64.h.

◆ nat64_tcp_ses_state_t

enum nat64_tcp_ses_state_t

Enumerator
foreach_nat64_tcp_ses_state

Definition at line 35 of file nat64.h.

Function Documentation

◆ nat64_add_del_interface()

int nat64_add_del_interface	(	u32	sw_if_index,
		u8	is_inside,
		u8	is_add
	)

Enable/disable NAT64 feature on the interface.

Parameters

sw_if_index	Index of the interface.
is_inside	1 if inside, 0 if outside.
is_add	1 if add, 0 if delete.

Returns: 0 on success, non-zero value otherwise.

Definition at line 453 of file nat64.c.

Here is the caller graph for this function:

◆ nat64_add_del_pool_addr()

int nat64_add_del_pool_addr	(	u32	thread_index,
		ip4_address_t *	addr,
		u32	vrf_id,
		u8	is_add
	)

Add/delete address to NAT64 pool.

Parameters

thread_index	Thread index used by ipfix nat logging (not address per thread).
addr	IPv4 address.
vrf_id	VRF id of tenant, ~0 means independent of VRF.
is_add	1 if add, 0 if delete.

Returns: 0 on success, non-zero value otherwise.

Definition at line 315 of file nat64.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_add_del_prefix()

int nat64_add_del_prefix	(	ip6_address_t *	prefix,
		u8	plen,
		u32	vrf_id,
		u8	is_add
	)

Add/delete NAT64 prefix.

Parameters

prefix	NAT64 prefix.
plen	Prefix length.
vrf_id	VRF id of tenant.
is_add	1 if add, 0 if delete.

Returns: 0 on success, non-zero value otherwise.

Definition at line 1002 of file nat64.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_add_del_static_bib_entry()

int nat64_add_del_static_bib_entry	(	ip6_address_t *	in_addr,
		ip4_address_t *	out_addr,
		u16	in_port,
		u16	out_port,
		u8	proto,
		u32	vrf_id,
		u8	is_add
	)

Add/delete static NAT64 BIB entry.

Parameters

in_addr	Inside IPv6 address.
out_addr	Outside IPv4 address.
in_port	Inside port number.
out_port	Outside port number.
proto	L4 protocol.
vrf_id	VRF id of tenant.
is_add	1 if add, 0 if delete.

Returns: 0 on success, non-zero value otherwise.

Definition at line 684 of file nat64.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_add_interface_address()

int nat64_add_interface_address	(	u32	sw_if_index,
		int	is_add
	)

NAT64 pool address from specific (DHCP addressed) interface.

Parameters

sw_if_index	Index of the interface.
is_add	1 if add, 0 if delete.

Returns: 0 on success, non-zero value otherwise.

Definition at line 411 of file nat64.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_alloc_out_addr_and_port()

int nat64_alloc_out_addr_and_port	(	u32	fib_index,
		snat_protocol_t	proto,
		ip4_address_t *	addr,
		u16 *	port,
		u32	thread_index
	)

Alloce IPv4 address and port pair from NAT64 pool.

Parameters

fib_index	FIB index of tenant.
proto	L4 protocol.
addr	Allocated IPv4 address.
port	Allocated port number.
thread_index	Thread index.

Returns: 0 on success, non-zero value otherwise.

Definition at line 552 of file nat64.c.

Here is the caller graph for this function:

◆ nat64_compose_ip6()

void nat64_compose_ip6	(	ip6_address_t *	ip6,
		ip4_address_t *	ip4,
		u32	fib_index
	)

Compose IPv4-embedded IPv6 addresses.

Parameters

ip6	IPv4-embedded IPv6 addresses.
ip4	IPv4 address.
fib_index	Tenant FIB index.

Definition at line 1065 of file nat64.c.

Here is the caller graph for this function:

◆ nat64_extract_ip4()

void nat64_extract_ip4	(	ip6_address_t *	ip6,
		ip4_address_t *	ip4,
		u32	fib_index
	)

Extract IPv4 address from the IPv4-embedded IPv6 addresses.

Parameters

ip6	IPv4-embedded IPv6 addresses.
ip4	IPv4 address.
fib_index	Tenant FIB index.

Definition at line 1135 of file nat64.c.

Here is the caller graph for this function:

◆ nat64_get_icmp_timeout()

u32 nat64_get_icmp_timeout ( void )

Get ICMP session timeout.

Returns: ICMP session timeout in seconds.

Definition at line 854 of file nat64.c.

◆ nat64_get_tcp_est_timeout()

u32 nat64_get_tcp_est_timeout ( void )

Get TCP established timeout.

Returns: TCP established timeout in seconds.

Definition at line 888 of file nat64.c.

◆ nat64_get_tcp_trans_timeout()

u32 nat64_get_tcp_trans_timeout ( void )

Get TCP transitory timeout.

Returns: TCP transitory timeout in seconds.

Definition at line 880 of file nat64.c.

◆ nat64_get_udp_timeout()

u32 nat64_get_udp_timeout ( void )

Get UDP session timeout.

Returns: UDP session timeout in seconds.

Definition at line 833 of file nat64.c.

◆ nat64_get_worker_in2out()

u32 nat64_get_worker_in2out ( ip6_address_t * addr )

Get worker thread index for NAT64 in2out.

Parameters

addr	IPv6 src address.

Returns: worker thread index.

Definition at line 100 of file nat64.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_get_worker_out2in()

u32 nat64_get_worker_out2in ( ip4_header_t * ip )

Get worker thread index for NAT64 out2in.

Parameters

ip	IPv4 header.

Returns: worker thread index.

Definition at line 123 of file nat64.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_init()

clib_error_t* nat64_init ( vlib_main_t * vm )

Initialize NAT64.

Parameters

vm	vlib main.

Returns: error code.

Definition at line 229 of file nat64.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_interfaces_walk()

void nat64_interfaces_walk	(	nat64_interface_walk_fn_t	fn,
		void *	ctx
	)

Walk NAT64 interfaces.

Parameters

fn	The function to invoke on each entry visited.
ctx	A context passed in the visit function.

Definition at line 537 of file nat64.c.

Here is the caller graph for this function:

◆ nat64_pool_addr_walk()

void nat64_pool_addr_walk	(	nat64_pool_addr_walk_fn_t	fn,
		void *	ctx
	)

Walk NAT64 pool.

Parameters

fn	The function to invoke on each entry visited.
ctx	A context passed in the visit function.

Definition at line 396 of file nat64.c.

Here is the caller graph for this function:

◆ nat64_prefix_walk()

void nat64_prefix_walk	(	nat64_prefix_walk_fn_t	fn,
		void *	ctx
	)

Walk NAT64 prefixes.

Parameters

fn	The function to invoke on each entry visited.
ctx	A context passed in the visit function.

Definition at line 1050 of file nat64.c.

Here is the caller graph for this function:

◆ nat64_session_reset_timeout()

void nat64_session_reset_timeout	(	nat64_db_st_entry_t *	ste,
		vlib_main_t *	vm
	)

Reset NAT64 session timeout.

Parameters

ste	Session table entry.
vm	VLIB main.

Definition at line 896 of file nat64.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_set_hash()

void nat64_set_hash	(	u32	bib_buckets,
		u32	bib_memory_size,
		u32	st_buckets,
		u32	st_memory_size
	)

Set NAT64 hash tables configuration.

Parameters

bib_buckets	Number of BIB hash buckets.
bib_memory_size	Memory size of BIB hash.
st_buckets	Number of session table hash buckets.
st_memory_size	Memory size of session table hash.

Definition at line 293 of file nat64.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_set_icmp_timeout()

int nat64_set_icmp_timeout ( u32 timeout )

Set ICMP session timeout.

Parameters

timeout Timeout value in seconds (if 0 reset to default value 60sec).

Returns: 0 on success, non-zero value otherwise.

Definition at line 841 of file nat64.c.

Here is the caller graph for this function:

◆ nat64_set_tcp_timeouts()

int nat64_set_tcp_timeouts	(	u32	trans,
		u32	est
	)

Set TCP session timeouts.

Parameters

trans	Transitory timeout in seconds (if 0 reset to default value 240sec).
est	Established timeout in seconds (if 0 reset to default value 7440sec).

Returns: 0 on success, non-zero value otherwise.

Definition at line 862 of file nat64.c.

Here is the caller graph for this function:

◆ nat64_set_udp_timeout()

int nat64_set_udp_timeout ( u32 timeout )

Set UDP session timeout.

Parameters

timeout Timeout value in seconds (if 0 reset to default value 300sec).

Returns: 0 on success, non-zero value otherwise.

Definition at line 820 of file nat64.c.

Here is the caller graph for this function:

◆ nat64_tcp_session_set_state()

void nat64_tcp_session_set_state	(	nat64_db_st_entry_t *	ste,
		tcp_header_t *	tcp,
		u8	is_ip6
	)

Set NAT64 TCP session state.

Parameters

ste	Session table entry.
tcp	TCP header.
is_ip6	1 if IPv6 packet, 0 if IPv4.

Definition at line 935 of file nat64.c.

Here is the caller graph for this function:

Variable Documentation

◆ nat64_in2out_node

vlib_node_registration_t nat64_in2out_node

(constructor) VLIB_REGISTER_NODE (nat64_in2out_node)

Definition at line 1180 of file nat64_in2out.c.

◆ nat64_main

nat64_main_t nat64_main

Definition at line 28 of file nat64.c.

◆ nat64_out2in_node

vlib_node_registration_t nat64_out2in_node

(constructor) VLIB_REGISTER_NODE (nat64_out2in_node)

Definition at line 577 of file nat64_out2in.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ foreach_nat64_tcp_ses_state

Typedef Documentation

◆ nat64_interface_walk_fn_t

◆ nat64_pool_addr_walk_fn_t

◆ nat64_prefix_walk_fn_t

Enumeration Type Documentation

◆ nat64_cleaner_process_event_e

◆ nat64_tcp_ses_state_t

Function Documentation

◆ nat64_add_del_interface()

◆ nat64_add_del_pool_addr()

◆ nat64_add_del_prefix()

◆ nat64_add_del_static_bib_entry()

◆ nat64_add_interface_address()

◆ nat64_alloc_out_addr_and_port()

◆ nat64_compose_ip6()

◆ nat64_extract_ip4()

◆ nat64_get_icmp_timeout()

◆ nat64_get_tcp_est_timeout()

◆ nat64_get_tcp_trans_timeout()

◆ nat64_get_udp_timeout()

◆ nat64_get_worker_in2out()

◆ nat64_get_worker_out2in()

◆ nat64_init()

◆ nat64_interfaces_walk()

◆ nat64_pool_addr_walk()

◆ nat64_prefix_walk()

◆ nat64_session_reset_timeout()

◆ nat64_set_hash()

◆ nat64_set_icmp_timeout()

◆ nat64_set_tcp_timeouts()

◆ nat64_set_udp_timeout()

◆ nat64_tcp_session_set_state()

Variable Documentation

◆ nat64_in2out_node

◆ nat64_main

◆ nat64_out2in_node