Include dependency graph for nat64_db.h:

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

Data Structures
struct	nat64_db_bib_entry_key_t

struct	nat64_db_bib_t

struct	nat64_db_st_entry_key_t

struct	nat64_db_st_t

struct	nat64_db_s

Typedefs
typedef void(*	nat64_db_free_addr_port_function_t) (struct nat64_db_s db, ip4_address_t addr, u16 port, u8 proto)
	Call back function to free NAT64 pool address and port when BIB entry is deleted. More...

typedef struct nat64_db_s	nat64_db_t

typedef int(*	nat64_db_bib_walk_fn_t) (nat64_db_bib_entry_t bibe, void ctx)
	Call back function when walking NAT64 BIB, non-zero return value stop walk. More...

typedef int(*	nat64_db_st_walk_fn_t) (nat64_db_st_entry_t ste, void ctx)
	Call back function when walking NAT64 session table, non-zero return value stop walk. More...

Functions
typedef	CLIB_PACKED (struct { ip6_address_t in_addr;u16 in_port;ip4_address_t out_addr;u16 out_port;u32 fib_index;u32 ses_num;u8 proto;u8 is_static;}) nat64_db_bib_entry_t

typedef	CLIB_PACKED (struct { ip6_address_t in_r_addr;ip4_address_t out_r_addr;u16 r_port;u32 bibe_index;u32 expire;u8 proto;u8 tcp_state;}) nat64_db_st_entry_t

int	nat64_db_init (nat64_db_t *db, u32 bib_buckets, uword bib_memory_size, u32 st_buckets, uword st_memory_size, nat64_db_free_addr_port_function_t free_addr_port_cb)
	Initialize NAT64 DB. More...

nat64_db_bib_entry_t *	nat64_db_bib_entry_create (u32 thread_index, nat64_db_t db, ip6_address_t in_addr, ip4_address_t *out_addr, u16 in_port, u16 out_port, u32 fib_index, u8 proto, u8 is_static)
	Create new NAT64 BIB entry. More...

void	nat64_db_bib_entry_free (u32 thread_index, nat64_db_t db, nat64_db_bib_entry_t bibe)
	Free NAT64 BIB entry. More...

void	nat64_db_bib_walk (nat64_db_t db, u8 proto, nat64_db_bib_walk_fn_t fn, void ctx)
	Walk NAT64 BIB. More...

nat64_db_bib_entry_t *	nat64_db_bib_entry_find (nat64_db_t db, ip46_address_t addr, u16 port, u8 proto, u32 fib_index, u8 is_ip6)
	Find NAT64 BIB entry. More...

nat64_db_bib_entry_t *	nat64_db_bib_entry_by_index (nat64_db_t *db, u8 proto, u32 bibe_index)
	Get BIB entry by index and protocol. More...

nat64_db_st_entry_t *	nat64_db_st_entry_create (u32 thread_index, nat64_db_t db, nat64_db_bib_entry_t bibe, ip6_address_t in_r_addr, ip4_address_t out_r_addr, u16 r_port)
	Create new NAT64 session table entry. More...

void	nat64_db_st_entry_free (u32 thread_index, nat64_db_t db, nat64_db_st_entry_t ste)
	Free NAT64 session table entry. More...

nat64_db_st_entry_t *	nat64_db_st_entry_find (nat64_db_t db, ip46_address_t l_addr, ip46_address_t *r_addr, u16 l_port, u16 r_port, u8 proto, u32 fib_index, u8 is_ip6)
	Find NAT64 session table entry. More...

void	nat64_db_st_walk (nat64_db_t db, u8 proto, nat64_db_st_walk_fn_t fn, void ctx)
	Walk NAT64 session table. More...

void	nad64_db_st_free_expired (u32 thread_index, nat64_db_t *db, u32 now)
	Free expired session entries in session tables. More...

void	nat64_db_free_out_addr (u32 thread_index, nat64_db_t db, ip4_address_t out_addr)
	Free sessions using specific outside address. More...

u32	nat64_db_st_entry_get_index (nat64_db_t db, nat64_db_st_entry_t ste)

nat64_db_st_entry_t *	nat64_db_st_entry_by_index (nat64_db_t *db, u8 proto, u32 ste_index)
	Get ST entry by index and protocol. More...

Detailed Description

NAT64 DB.

Definition in file nat64_db.h.

Typedef Documentation

◆ nat64_db_bib_walk_fn_t

typedef int(* nat64_db_bib_walk_fn_t) (nat64_db_bib_entry_t *bibe, void *ctx)

Call back function when walking NAT64 BIB, non-zero return value stop walk.

Definition at line 197 of file nat64_db.h.

◆ nat64_db_free_addr_port_function_t

typedef void(* nat64_db_free_addr_port_function_t) (struct nat64_db_s *db, ip4_address_t *addr, u16 port, u8 proto)

Call back function to free NAT64 pool address and port when BIB entry is deleted.

Definition at line 132 of file nat64_db.h.

◆ nat64_db_st_walk_fn_t

typedef int(* nat64_db_st_walk_fn_t) (nat64_db_st_entry_t *ste, void *ctx)

Call back function when walking NAT64 session table, non-zero return value stop walk.

Definition at line 299 of file nat64_db.h.

◆ nat64_db_t

typedef struct nat64_db_s nat64_db_t

Function Documentation

◆ CLIB_PACKED() [1/2]

typedef CLIB_PACKED ( struct { ip6_address_t in_addr;u16 in_port;ip4_address_t out_addr;u16 out_port;u32 fib_index;u32 ses_num;u8 proto;u8 is_static;} )

◆ CLIB_PACKED() [2/2]

typedef CLIB_PACKED ( struct { ip6_address_t in_r_addr;ip4_address_t out_r_addr;u16 r_port;u32 bibe_index;u32 expire;u8 proto;u8 tcp_state;} )

◆ nad64_db_st_free_expired()

void nad64_db_st_free_expired	(	u32	thread_index,
		nat64_db_t *	db,
		u32	now
	)

Free expired session entries in session tables.

Parameters

thread_index	thread index.
db	NAT64 DB.
now	Current time.

Definition at line 651 of file nat64_db.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_db_bib_entry_by_index()

nat64_db_bib_entry_t* nat64_db_bib_entry_by_index	(	nat64_db_t *	db,
		u8	proto,
		u32	bibe_index
	)

Get BIB entry by index and protocol.

Parameters

db	NAT64 DB.
proto	L4 protocol.
bibe_index	BIB entry index.

Returns: BIB entry if found.

Definition at line 302 of file nat64_db.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_db_bib_entry_create()

nat64_db_bib_entry_t* nat64_db_bib_entry_create	(	u32	thread_index,
		nat64_db_t *	db,
		ip6_address_t *	in_addr,
		ip4_address_t *	out_addr,
		u16	in_port,
		u16	out_port,
		u32	fib_index,
		u8	proto,
		u8	is_static
	)

Create new NAT64 BIB entry.

Parameters

thread_index	thread index.
db	NAT64 DB.
in_addr	Inside IPv6 address.
out_addr	Outside IPv4 address.
in_port	Inside port number.
out_port	Outside port number.
fib_index	FIB index.
proto	L4 protocol.
is_static	1 if static, 0 if dynamic.

Returns: BIB entry on success, 0 otherwise.

Definition at line 53 of file nat64_db.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_db_bib_entry_find()

nat64_db_bib_entry_t* nat64_db_bib_entry_find	(	nat64_db_t *	db,
		ip46_address_t *	addr,
		u16	port,
		u8	proto,
		u32	fib_index,
		u8	is_ip6
	)

Find NAT64 BIB entry.

Parameters

db	NAT64 DB.
addr	IP address.
port	Port number.
proto	L4 protocol.
fib_index	FIB index.
is_ip6	1 if find by IPv6 (inside) address, 0 by IPv4 (outside).

Returns: BIB entry if found.

Definition at line 209 of file nat64_db.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_db_bib_entry_free()

void nat64_db_bib_entry_free	(	u32	thread_index,
		nat64_db_t *	db,
		nat64_db_bib_entry_t *	bibe
	)

Free NAT64 BIB entry.

Parameters

thread_index	thread index.
db	NAT64 DB.
bibe	BIB entry.

Definition at line 129 of file nat64_db.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_db_bib_walk()

void nat64_db_bib_walk	(	nat64_db_t *	db,
		u8	proto,
		nat64_db_bib_walk_fn_t	fn,
		void *	ctx
	)

Walk NAT64 BIB.

Parameters

db	NAT64 DB.
proto	BIB L4 protocol: 255 all BIBs 6 TCP BIB 17 UDP BIB 1/58 ICMP BIB

u - otherwise "unknown" protocol BIB

Parameters

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

Definition at line 251 of file nat64_db.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_db_free_out_addr()

void nat64_db_free_out_addr	(	u32	thread_index,
		nat64_db_t *	db,
		ip4_address_t *	out_addr
	)

Free sessions using specific outside address.

Parameters

thread_index	thread index.
db	NAT64 DB.
out_addr	Outside address to match.

Definition at line 685 of file nat64_db.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_db_init()

int nat64_db_init	(	nat64_db_t *	db,
		u32	bib_buckets,
		uword	bib_memory_size,
		u32	st_buckets,
		uword	st_memory_size,
		nat64_db_free_addr_port_function_t	free_addr_port_cb
	)

Initialize NAT64 DB.

Parameters

db	NAT64 DB.
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.
free_addr_port_cb	Call back function to free address and port.

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

Definition at line 26 of file nat64_db.c.

Here is the caller graph for this function:

◆ nat64_db_st_entry_by_index()

nat64_db_st_entry_t* nat64_db_st_entry_by_index	(	nat64_db_t *	db,
		u8	proto,
		u32	ste_index
	)

Get ST entry by index and protocol.

Parameters

db	NAT64 DB.
proto	L4 protocol.
bibe_index	ST entry index.

Returns: BIB entry if found.

Definition at line 628 of file nat64_db.c.

Here is the call graph for this function:

◆ nat64_db_st_entry_create()

nat64_db_st_entry_t* nat64_db_st_entry_create	(	u32	thread_index,
		nat64_db_t *	db,
		nat64_db_bib_entry_t *	bibe,
		ip6_address_t *	in_r_addr,
		ip4_address_t *	out_r_addr,
		u16	r_port
	)

Create new NAT64 session table entry.

Parameters

thread_index	thread index.
db	NAT64 DB.
bibe	Corresponding BIB entry.
in_r_addr	Inside IPv6 address of the remote host.
out_r_addr	Outside IPv4 address of the remote host.
r_port	Remote host port number.

Returns: BIB entry on success, 0 otherwise.

Definition at line 376 of file nat64_db.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_db_st_entry_find()

nat64_db_st_entry_t* nat64_db_st_entry_find	(	nat64_db_t *	db,
		ip46_address_t *	l_addr,
		ip46_address_t *	r_addr,
		u16	l_port,
		u16	r_port,
		u8	proto,
		u32	fib_index,
		u8	is_ip6
	)

Find NAT64 session table entry.

Parameters

db	NAT64 DB.
l_addr	Local host address.
r_addr	Remote host address.
l_port	Local host port number.
r_port	Remote host port number.
proto	L4 protocol.
fib_index	FIB index.
is_ip6	1 if find by IPv6 (inside) address, 0 by IPv4 (outside).

Returns: BIB entry if found.

Definition at line 557 of file nat64_db.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_db_st_entry_free()

void nat64_db_st_entry_free	(	u32	thread_index,
		nat64_db_t *	db,
		nat64_db_st_entry_t *	ste
	)

Free NAT64 session table entry.

Parameters

thread_index	thread index.
db	NAT64 DB.
ste	Session table entry.

Definition at line 472 of file nat64_db.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nat64_db_st_entry_get_index()

u32 nat64_db_st_entry_get_index	(	nat64_db_t *	db,
		nat64_db_st_entry_t *	ste
	)

Definition at line 605 of file nat64_db.c.

Here is the call graph for this function:

◆ nat64_db_st_walk()

void nat64_db_st_walk	(	nat64_db_t *	db,
		u8	proto,
		nat64_db_st_walk_fn_t	fn,
		void *	ctx
	)

Walk NAT64 session table.

Parameters

db	NAT64 DB.
proto	L4 protocol: 255 all session tables 6 TCP session table 17 UDP session table 1/58 ICMP session table otherwise "unknown" protocol session table
fn	The function to invoke on each entry visited.
ctx	A context passed in the visit function.

Definition at line 325 of file nat64_db.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ nat64_db_bib_walk_fn_t

◆ nat64_db_free_addr_port_function_t

◆ nat64_db_st_walk_fn_t

◆ nat64_db_t

Function Documentation

◆ CLIB_PACKED() [1/2]

◆ CLIB_PACKED() [2/2]

◆ nad64_db_st_free_expired()

◆ nat64_db_bib_entry_by_index()

◆ nat64_db_bib_entry_create()

◆ nat64_db_bib_entry_find()

◆ nat64_db_bib_entry_free()

◆ nat64_db_bib_walk()

◆ nat64_db_free_out_addr()

◆ nat64_db_init()

◆ nat64_db_st_entry_by_index()

◆ nat64_db_st_entry_create()

◆ nat64_db_st_entry_find()

◆ nat64_db_st_entry_free()

◆ nat64_db_st_entry_get_index()

◆ nat64_db_st_walk()