FD.io VPP  v21.01.1
Vector Packet Processing
tcp.c File Reference

TCP host stack utilities. More...

+ Include dependency graph for tcp.c:

Go to the source code of this file.

Data Structures

struct  tcp_add_del_adj_args_t
 

Functions

static void tcp_add_del_adj_cb (tcp_add_del_adj_args_t *args)
 
static void tcp_add_del_adjacency (tcp_connection_t *tc, u8 is_add)
 
static void tcp_cc_init (tcp_connection_t *tc)
 
static void tcp_cc_cleanup (tcp_connection_t *tc)
 
void tcp_cc_algo_register (tcp_cc_algorithm_type_e type, const tcp_cc_algorithm_t *vft)
 Register exiting cc algo type. More...
 
tcp_cc_algorithm_ttcp_cc_algo_get (tcp_cc_algorithm_type_e type)
 
tcp_cc_algorithm_type_e tcp_cc_algo_new_type (const tcp_cc_algorithm_t *vft)
 Register new cc algo type. More...
 
static u32 tcp_connection_bind (u32 session_index, transport_endpoint_t *lcl)
 
static u32 tcp_session_bind (u32 session_index, transport_endpoint_t *tep)
 
static void tcp_connection_unbind (u32 listener_index)
 
static u32 tcp_session_unbind (u32 listener_index)
 
static transport_connection_ttcp_session_get_listener (u32 listener_index)
 
static void tcp_half_open_connection_free (tcp_connection_t *tc)
 Cleanup half-open connection. More...
 
int tcp_half_open_connection_cleanup (tcp_connection_t *tc)
 Try to cleanup half-open connection. More...
 
static tcp_connection_ttcp_half_open_connection_new (void)
 
void tcp_connection_cleanup (tcp_connection_t *tc)
 Cleans up connection state. More...
 
void tcp_connection_del (tcp_connection_t *tc)
 Connection removal. More...
 
tcp_connection_ttcp_connection_alloc (u8 thread_index)
 
tcp_connection_ttcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t *base)
 
void tcp_connection_free (tcp_connection_t *tc)
 
void tcp_program_cleanup (tcp_worker_ctx_t *wrk, tcp_connection_t *tc)
 
void tcp_connection_close (tcp_connection_t *tc)
 Begin connection closing procedure. More...
 
static void tcp_session_close (u32 conn_index, u32 thread_index)
 
static void tcp_session_cleanup (u32 conn_index, u32 thread_index)
 
static void tcp_session_cleanup_ho (u32 conn_index)
 
static void tcp_session_reset (u32 conn_index, u32 thread_index)
 
void tcp_connection_timers_init (tcp_connection_t *tc)
 Initialize all connection timers as invalid. More...
 
void tcp_connection_timers_reset (tcp_connection_t *tc)
 Stop all connection timers. More...
 
static u32 tcp_generate_random_iss (tcp_connection_t *tc)
 Generate random iss as per rfc6528. More...
 
static void tcp_init_rcv_mss (tcp_connection_t *tc)
 Initialize max segment size we're able to process. More...
 
static void tcp_init_mss (tcp_connection_t *tc)
 
void tcp_init_snd_vars (tcp_connection_t *tc)
 Initialize connection send variables. More...
 
void tcp_enable_pacing (tcp_connection_t *tc)
 
void tcp_connection_init_vars (tcp_connection_t *tc)
 Initialize tcp connection variables. More...
 
static int tcp_alloc_custom_local_endpoint (tcp_main_t *tm, ip46_address_t *lcl_addr, u16 *lcl_port, u8 is_ip4)
 
static int tcp_session_open (transport_endpoint_cfg_t *rmt)
 
static u8format_tcp_session (u8 *s, va_list *args)
 
static u8format_tcp_listener_session (u8 *s, va_list *args)
 
static u8format_tcp_half_open_session (u8 *s, va_list *args)
 
static transport_connection_ttcp_session_get_transport (u32 conn_index, u32 thread_index)
 
static transport_connection_ttcp_half_open_session_get_transport (u32 conn_index)
 
static u16 tcp_session_cal_goal_size (tcp_connection_t *tc)
 
static u32 tcp_round_snd_space (tcp_connection_t *tc, u32 snd_space)
 
static u32 tcp_snd_space_inline (tcp_connection_t *tc)
 Compute tx window session is allowed to fill. More...
 
u32 tcp_snd_space (tcp_connection_t *tc)
 
static int tcp_session_send_params (transport_connection_t *trans_conn, transport_send_params_t *sp)
 
static void tcp_timer_waitclose_handler (tcp_connection_t *tc)
 
static void tcp_dispatch_pending_timers (tcp_worker_ctx_t *wrk)
 
static void tcp_handle_cleanups (tcp_worker_ctx_t *wrk, clib_time_type_t now)
 
static void tcp_update_time (f64 now, u8 thread_index)
 
static void tcp_session_flush_data (transport_connection_t *tconn)
 
void tcp_connection_tx_pacer_update (tcp_connection_t *tc)
 
void tcp_connection_tx_pacer_reset (tcp_connection_t *tc, u32 window, u32 start_bucket)
 
void tcp_reschedule (tcp_connection_t *tc)
 
static void tcp_expired_timers_dispatch (u32 *expired_timers)
 
static void tcp_initialize_iss_seed (tcp_main_t *tm)
 
static clib_error_ttcp_main_enable (vlib_main_t *vm)
 
clib_error_tvnet_tcp_enable_disable (vlib_main_t *vm, u8 is_en)
 
void tcp_punt_unknown (vlib_main_t *vm, u8 is_ip4, u8 is_add)
 
static void tcp_configuration_init (void)
 Initialize default values for tcp parameters. More...
 
static clib_error_ttcp_init (vlib_main_t *vm)
 

Variables

tcp_main_t tcp_main
 
static timer_expiration_handlertimer_expiration_handlers [TCP_N_TIMERS]
 
static const transport_proto_vft_t tcp_proto
 

Detailed Description

TCP host stack utilities.

Definition in file tcp.c.

Function Documentation

◆ format_tcp_half_open_session()

static u8* format_tcp_half_open_session ( u8 s,
va_list *  args 
)
static

Definition at line 851 of file tcp.c.

◆ format_tcp_listener_session()

static u8* format_tcp_listener_session ( u8 s,
va_list *  args 
)
static

Definition at line 837 of file tcp.c.

◆ format_tcp_session()

static u8* format_tcp_session ( u8 s,
va_list *  args 
)
static

Definition at line 821 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_add_del_adj_cb()

static void tcp_add_del_adj_cb ( tcp_add_del_adj_args_t args)
static

Definition at line 40 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_add_del_adjacency()

static void tcp_add_del_adjacency ( tcp_connection_t tc,
u8  is_add 
)
static

Definition at line 58 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_alloc_custom_local_endpoint()

static int tcp_alloc_custom_local_endpoint ( tcp_main_t tm,
ip46_address_t *  lcl_addr,
u16 lcl_port,
u8  is_ip4 
)
static

Definition at line 732 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_cc_algo_get()

tcp_cc_algorithm_t* tcp_cc_algo_get ( tcp_cc_algorithm_type_e  type)

Definition at line 96 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_cc_algo_new_type()

tcp_cc_algorithm_type_e tcp_cc_algo_new_type ( const tcp_cc_algorithm_t vft)

Register new cc algo type.

Definition at line 103 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_cc_algo_register()

void tcp_cc_algo_register ( tcp_cc_algorithm_type_e  type,
const tcp_cc_algorithm_t vft 
)

Register exiting cc algo type.

Definition at line 85 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_cc_cleanup()

static void tcp_cc_cleanup ( tcp_connection_t tc)
static

Definition at line 78 of file tcp.c.

+ Here is the caller graph for this function:

◆ tcp_cc_init()

static void tcp_cc_init ( tcp_connection_t tc)
static

Definition at line 72 of file tcp.c.

+ Here is the caller graph for this function:

◆ tcp_configuration_init()

static void tcp_configuration_init ( void  )
static

Initialize default values for tcp parameters.

Definition at line 1409 of file tcp.c.

+ Here is the caller graph for this function:

◆ tcp_connection_alloc()

tcp_connection_t* tcp_connection_alloc ( u8  thread_index)

Definition at line 296 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_connection_alloc_w_base()

tcp_connection_t* tcp_connection_alloc_w_base ( u8  thread_index,
tcp_connection_t base 
)

Definition at line 309 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_connection_bind()

static u32 tcp_connection_bind ( u32  session_index,
transport_endpoint_t lcl 
)
static

Definition at line 111 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_connection_cleanup()

void tcp_connection_cleanup ( tcp_connection_t tc)

Cleans up connection state.

No notifications.

Definition at line 242 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_connection_close()

void tcp_connection_close ( tcp_connection_t tc)

Begin connection closing procedure.

If at the end the connection is not in CLOSED state, it is not removed. Instead, we rely on on TCP to advance through state machine to either 1) LAST_ACK (passive close) whereby when the last ACK is received tcp_connection_del is called. This notifies session of the delete and calls cleanup. 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers and cleanup is called.

N.B. Half-close connections are not supported

Definition at line 360 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_connection_del()

void tcp_connection_del ( tcp_connection_t tc)

Connection removal.

This should be called only once connection enters CLOSED state. Note that it notifies the session of the removal event, so if the goal is to just remove the connection, call tcp_connection_cleanup instead.

Definition at line 289 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_connection_free()

void tcp_connection_free ( tcp_connection_t tc)

Definition at line 322 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_connection_init_vars()

void tcp_connection_init_vars ( tcp_connection_t tc)

Initialize tcp connection variables.

Should be called after having received a msg from the peer, i.e., a SYN or a SYNACK, such that connection options have already been exchanged.

Definition at line 703 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_connection_timers_init()

void tcp_connection_timers_init ( tcp_connection_t tc)

Initialize all connection timers as invalid.

Definition at line 476 of file tcp.c.

+ Here is the caller graph for this function:

◆ tcp_connection_timers_reset()

void tcp_connection_timers_reset ( tcp_connection_t tc)

Stop all connection timers.

Definition at line 493 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_connection_tx_pacer_reset()

void tcp_connection_tx_pacer_reset ( tcp_connection_t tc,
u32  window,
u32  start_bucket 
)

Definition at line 1209 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_connection_tx_pacer_update()

void tcp_connection_tx_pacer_update ( tcp_connection_t tc)

Definition at line 1196 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_connection_unbind()

static void tcp_connection_unbind ( u32  listener_index)
static

Definition at line 152 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_dispatch_pending_timers()

static void tcp_dispatch_pending_timers ( tcp_worker_ctx_t wrk)
static

Definition at line 1081 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_enable_pacing()

void tcp_enable_pacing ( tcp_connection_t tc)

Definition at line 690 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_expired_timers_dispatch()

static void tcp_expired_timers_dispatch ( u32 expired_timers)
static

Definition at line 1227 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_generate_random_iss()

static u32 tcp_generate_random_iss ( tcp_connection_t tc)
static

Generate random iss as per rfc6528.

Definition at line 603 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_half_open_connection_cleanup()

int tcp_half_open_connection_cleanup ( tcp_connection_t tc)

Try to cleanup half-open connection.

If called from a thread that doesn't own tc, the call won't have any effect.

Parameters
tc- connection to be cleaned up
Returns
non-zero if cleanup failed.

Definition at line 209 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_half_open_connection_free()

static void tcp_half_open_connection_free ( tcp_connection_t tc)
static

Cleanup half-open connection.

Definition at line 189 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_half_open_connection_new()

static tcp_connection_t* tcp_half_open_connection_new ( void  )
static

Definition at line 225 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_half_open_session_get_transport()

static transport_connection_t* tcp_half_open_session_get_transport ( u32  conn_index)
static

Definition at line 869 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_handle_cleanups()

static void tcp_handle_cleanups ( tcp_worker_ctx_t wrk,
clib_time_type_t  now 
)
static

Definition at line 1124 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_init()

static clib_error_t* tcp_init ( vlib_main_t vm)
static

Definition at line 1439 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_init_mss()

static void tcp_init_mss ( tcp_connection_t tc)
static

Definition at line 641 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_init_rcv_mss()

static void tcp_init_rcv_mss ( tcp_connection_t tc)
static

Initialize max segment size we're able to process.

The value is constrained by the output interface's MTU and by the size of the IP and TCP headers (see RFC6691). It is also what we advertise to our peer.

Definition at line 628 of file tcp.c.

+ Here is the caller graph for this function:

◆ tcp_init_snd_vars()

void tcp_init_snd_vars ( tcp_connection_t tc)

Initialize connection send variables.

Definition at line 669 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_initialize_iss_seed()

static void tcp_initialize_iss_seed ( tcp_main_t tm)
static

Definition at line 1273 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_main_enable()

static clib_error_t* tcp_main_enable ( vlib_main_t vm)
static

Definition at line 1283 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_program_cleanup()

void tcp_program_cleanup ( tcp_worker_ctx_t wrk,
tcp_connection_t tc 
)

Definition at line 335 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_punt_unknown()

void tcp_punt_unknown ( vlib_main_t vm,
u8  is_ip4,
u8  is_add 
)

Definition at line 1396 of file tcp.c.

+ Here is the caller graph for this function:

◆ tcp_reschedule()

void tcp_reschedule ( tcp_connection_t tc)

Definition at line 1220 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_round_snd_space()

static u32 tcp_round_snd_space ( tcp_connection_t tc,
u32  snd_space 
)
inlinestatic

Definition at line 887 of file tcp.c.

+ Here is the caller graph for this function:

◆ tcp_session_bind()

static u32 tcp_session_bind ( u32  session_index,
transport_endpoint_t tep 
)
static

Definition at line 146 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_session_cal_goal_size()

static u16 tcp_session_cal_goal_size ( tcp_connection_t tc)
static

Definition at line 876 of file tcp.c.

+ Here is the caller graph for this function:

◆ tcp_session_cleanup()

static void tcp_session_cleanup ( u32  conn_index,
u32  thread_index 
)
static

Definition at line 437 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_session_cleanup_ho()

static void tcp_session_cleanup_ho ( u32  conn_index)
static

Definition at line 448 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_session_close()

static void tcp_session_close ( u32  conn_index,
u32  thread_index 
)
static

Definition at line 429 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_session_flush_data()

static void tcp_session_flush_data ( transport_connection_t tconn)
static

Definition at line 1156 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_session_get_listener()

static transport_connection_t* tcp_session_get_listener ( u32  listener_index)
static

Definition at line 176 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_session_get_transport()

static transport_connection_t* tcp_session_get_transport ( u32  conn_index,
u32  thread_index 
)
static

Definition at line 860 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_session_open()

static int tcp_session_open ( transport_endpoint_cfg_t rmt)
static

Definition at line 759 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_session_reset()

static void tcp_session_reset ( u32  conn_index,
u32  thread_index 
)
static

Definition at line 460 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_session_send_params()

static int tcp_session_send_params ( transport_connection_t trans_conn,
transport_send_params_t sp 
)
static

Definition at line 957 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_session_unbind()

static u32 tcp_session_unbind ( u32  listener_index)
static

Definition at line 169 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_snd_space()

u32 tcp_snd_space ( tcp_connection_t tc)

Definition at line 951 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_snd_space_inline()

static u32 tcp_snd_space_inline ( tcp_connection_t tc)
inlinestatic

Compute tx window session is allowed to fill.

Takes into account available send space, snd_mss and the congestion state of the connection. If possible, the value returned is a multiple of snd_mss.

Parameters
tctcp connection
Returns
number of bytes session is allowed to write

Definition at line 914 of file tcp.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tcp_timer_waitclose_handler()

static void tcp_timer_waitclose_handler ( tcp_connection_t tc)
static

Definition at line 985 of file tcp.c.

+ Here is the call graph for this function:

◆ tcp_update_time()

static void tcp_update_time ( f64  now,
u8  thread_index 
)
static

Definition at line 1145 of file tcp.c.

+ Here is the call graph for this function:

◆ vnet_tcp_enable_disable()

clib_error_t* vnet_tcp_enable_disable ( vlib_main_t vm,
u8  is_en 
)

Definition at line 1378 of file tcp.c.

+ Here is the call graph for this function:

Variable Documentation

◆ tcp_main

tcp_main_t tcp_main

Definition at line 28 of file tcp.c.

◆ tcp_proto

const transport_proto_vft_t tcp_proto
static
Initial value:
= {
.start_listen = tcp_session_bind,
.stop_listen = tcp_session_unbind,
.push_header = tcp_session_push_header,
.get_connection = tcp_session_get_transport,
.get_listener = tcp_session_get_listener,
.connect = tcp_session_open,
.cleanup = tcp_session_cleanup,
.cleanup_ho = tcp_session_cleanup_ho,
.send_params = tcp_session_send_params,
.update_time = tcp_update_time,
.flush_data = tcp_session_flush_data,
.custom_tx = tcp_session_custom_tx,
.format_connection = format_tcp_session,
.format_listener = format_tcp_listener_session,
.format_half_open = format_tcp_half_open_session,
.transport_options = {
.name = "tcp",
.short_name = "T",
.tx_type = TRANSPORT_TX_PEEK,
.service_type = TRANSPORT_SERVICE_VC,
},
}
static void tcp_session_close(u32 conn_index, u32 thread_index)
Definition: tcp.c:429
static u8 * format_tcp_listener_session(u8 *s, va_list *args)
Definition: tcp.c:837
static transport_connection_t * tcp_half_open_session_get_transport(u32 conn_index)
Definition: tcp.c:869
u32 tcp_session_push_header(transport_connection_t *tconn, vlib_buffer_t *b)
Definition: tcp_output.c:995
static u32 tcp_session_unbind(u32 listener_index)
Definition: tcp.c:169
static transport_connection_t * tcp_session_get_transport(u32 conn_index, u32 thread_index)
Definition: tcp.c:860
static transport_connection_t * tcp_session_get_listener(u32 listener_index)
Definition: tcp.c:176
static void tcp_session_cleanup(u32 conn_index, u32 thread_index)
Definition: tcp.c:437
clib_error_t * vnet_tcp_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: tcp.c:1378
static void tcp_session_cleanup_ho(u32 conn_index)
Definition: tcp.c:448
static int tcp_session_send_params(transport_connection_t *trans_conn, transport_send_params_t *sp)
Definition: tcp.c:957
virtual circuit service
static void tcp_session_flush_data(transport_connection_t *tconn)
Definition: tcp.c:1156
static int tcp_session_open(transport_endpoint_cfg_t *rmt)
Definition: tcp.c:759
reliable transport protos
static u32 tcp_session_bind(u32 session_index, transport_endpoint_t *tep)
Definition: tcp.c:146
static u8 * format_tcp_session(u8 *s, va_list *args)
Definition: tcp.c:821
static u8 * format_tcp_half_open_session(u8 *s, va_list *args)
Definition: tcp.c:851
static void tcp_update_time(f64 now, u8 thread_index)
Definition: tcp.c:1145
static void tcp_session_reset(u32 conn_index, u32 thread_index)
Definition: tcp.c:460
int tcp_session_custom_tx(void *conn, transport_send_params_t *sp)
Definition: tcp_output.c:2017

Definition at line 1166 of file tcp.c.

◆ timer_expiration_handlers

timer_expiration_handler* timer_expiration_handlers[TCP_N_TIMERS]
static
Initial value:
=
{
}
timer_expiration_handler tcp_timer_retransmit_handler
timer_expiration_handler tcp_timer_retransmit_syn_handler
timer_expiration_handler tcp_timer_persist_handler
static void tcp_timer_waitclose_handler(tcp_connection_t *tc)
Definition: tcp.c:985

Definition at line 1071 of file tcp.c.