#include "buffers.h"

Include dependency graph for connection.h:

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

Macros
#define	connection_free(conn) FREE_AND_NULL(connection_t, connection_free_, (conn))

#define	connection_mark_for_close(c) connection_mark_for_close_((c), __LINE__, SHORT_FILE__)

#define	connection_mark_for_close_internal(c) connection_mark_for_close_internal_((c), __LINE__, SHORT_FILE__)

#define	connection_mark_and_flush_internal_(c, line, file)

#define	connection_mark_and_flush_internal(c) connection_mark_and_flush_internal_((c), __LINE__, SHORT_FILE__)

#define	connection_mark_and_flush_(c, line, file)

#define	connection_mark_and_flush(c) connection_mark_and_flush_((c), __LINE__, SHORT_FILE__)

#define	MAX_SOCKS5_AUTH_FIELD_SIZE 255

#define	MAX_SOCKS5_AUTH_SIZE_TOTAL 2*MAX_SOCKS5_AUTH_FIELD_SIZE

#define	CONN_LEN_AND_FREE_TEMPLATE(sl)

#define	connection_speaks_cells(conn) (((conn)->type == CONN_TYPE_OR) \|\| 0)

Functions
const char *	conn_type_to_string (int type)

const char *	conn_state_to_string (int type, int state)

int	conn_listener_type_supports_af_unix (int type)

dir_connection_t *	dir_connection_new (int socket_family)

or_connection_t *	or_connection_new (int type, int socket_family)

edge_connection_t *	edge_connection_new (int type, int socket_family)

entry_connection_t *	entry_connection_new (int type, int socket_family)

control_connection_t *	control_connection_new (int socket_family)

listener_connection_t *	listener_connection_new (int type, int socket_family)

connection_t *	connection_new (int type, int socket_family)

int	connection_init_accepted_conn (connection_t conn, const listener_connection_t listener)

void	connection_link_connections (connection_t conn_a, connection_t conn_b)

	MOCK_DECL (void, connection_free_,(connection_t *conn))

void	connection_free_all (void)

void	connection_about_to_close_connection (connection_t *conn)

void	connection_close_immediate (connection_t *conn)

void	connection_mark_for_close_ (connection_t conn, int line, const char file)

	MOCK_DECL (void, connection_mark_for_close_internal_,(connection_t conn, int line, const char file))

void	connection_expire_held_open (void)

int	connection_connect (connection_t conn, const char address, const tor_addr_t addr, uint16_t port, int socket_error)

int	connection_proxy_connect (connection_t *conn, int type)

int	connection_read_proxy_handshake (connection_t *conn)

void	log_failed_proxy_connection (connection_t *conn)

int	get_proxy_addrport (tor_addr_t addr, uint16_t port, int proxy_type, const connection_t conn)

int	retry_all_listeners (smartlist_t replaced_conns, smartlist_t new_conns, int close_all_noncontrol)

void	connection_mark_all_noncontrol_listeners (void)

void	connection_mark_all_noncontrol_connections (void)

ssize_t	connection_bucket_write_limit (connection_t *conn, time_t now)

int	global_write_bucket_low (connection_t *conn, size_t attempt, int priority)

void	connection_bucket_init (void)

void	connection_bucket_adjust (const or_options_t *options)

void	connection_bucket_refill_all (time_t now, uint32_t now_ts)

void	connection_read_bw_exhausted (connection_t *conn, bool is_global_bw)

void	connection_write_bw_exhausted (connection_t *conn, bool is_global_bw)

void	connection_consider_empty_read_buckets (connection_t *conn)

void	connection_consider_empty_write_buckets (connection_t *conn)

int	connection_handle_read (connection_t *conn)

int	connection_buf_get_bytes (char string, size_t len, connection_t conn)

int	connection_buf_get_line (connection_t conn, char data, size_t *data_len)

int	connection_fetch_from_buf_http (connection_t conn, char headers_out, size_t max_headerlen, char body_out, size_t body_used, size_t max_bodylen, int force_complete)

int	connection_wants_to_flush (connection_t *conn)

int	connection_outbuf_too_full (connection_t *conn)

int	connection_handle_write (connection_t *conn, int force)

int	connection_flush (connection_t *conn)

	MOCK_DECL (void, connection_write_to_buf_impl_,(const char string, size_t len, connection_t conn, int zlib))

void	connection_buf_add_buf (connection_t conn, buf_t buf)

connection_t *	connection_get_by_global_id (uint64_t id)

connection_t *	connection_get_by_type (int type)

	MOCK_DECL (connection_t , connection_get_by_type_addr_port_purpose,(int type, const tor_addr_t addr, uint16_t port, int purpose))

connection_t *	connection_get_by_type_state (int type, int state)

connection_t *	connection_get_by_type_state_rendquery (int type, int state, const char *rendquery)

smartlist_t *	connection_list_by_type_state (int type, int state)

smartlist_t *	connection_list_by_type_purpose (int type, int purpose)

smartlist_t *	connection_dir_list_by_purpose_and_resource (int purpose, const char *resource)

smartlist_t *	connection_dir_list_by_purpose_resource_and_state (int purpose, const char *resource, int state)

int	any_other_active_or_conns (const or_connection_t *this_conn)

int	connection_is_listener (connection_t *conn)

int	connection_state_is_open (connection_t *conn)

int	connection_state_is_connecting (connection_t *conn)

char *	alloc_http_authenticator (const char *authenticator)

void	assert_connection_ok (connection_t *conn, time_t now)

int	connection_or_nonopen_was_started_here (or_connection_t *conn)

void	connection_dump_buffer_mem_stats (int severity)

	MOCK_DECL (void, clock_skew_warning,(const connection_t conn, long apparent_skew, int trusted, log_domain_mask_t domain, const char received, const char *source))

void	connection_check_oos (int n_socks, int failed)

Detailed Description

Header file for connection.c.

Macro Definition Documentation

◆ CONN_LEN_AND_FREE_TEMPLATE

#define CONN_LEN_AND_FREE_TEMPLATE ( sl )

Value:

STMT_BEGIN                           \
    int len = smartlist_len(sl);       \
    smartlist_free(sl);                \
    return len;                        \
  STMT_END

◆ connection_mark_and_flush_

#define connection_mark_and_flush_	(	c,
		line,
		file
	)

Value:

do {                                                                    \
    connection_t *tmp_conn_ = (c);                                        \
    if (tmp_conn_->type == CONN_TYPE_OR) {                                \
      log_warn(LD_CHANNEL | LD_BUG,                                       \
               "Something tried to close (and flush) an or_connection_t"  \
               " without going through channels at %s:%d",                \
               file, line);                                               \
      connection_or_close_for_error(TO_OR_CONN(tmp_conn_), 1);            \
    } else {                                                              \
      connection_mark_and_flush_internal_(c, line, file);                 \
    }                                                                     \
  } while (0)

Mark 'c' for close, but try to hold it open until all the data is written.

◆ connection_mark_and_flush_internal_

#define connection_mark_and_flush_internal_	(	c,
		line,
		file
	)

Value:

do {                                                                  \
    connection_t *tmp_conn__ = (c);                                     \
    connection_mark_for_close_internal_(tmp_conn__, (line), (file));    \
    tmp_conn__->hold_open_until_flushed = 1;                            \
  } while (0)

Mark 'c' for close, but try to hold it open until all the data is written. Use the _internal versions of connection_mark_for_close; this should be called when you either are sure that if this is an or_connection_t the controlling channel has been notified (e.g. with connection_or_notify_error()), or you actually are the connection_or_close_for_error() or connection_or_close_normally function. For all other cases, use connection_mark_and_flush() instead, which checks for or_connection_t properly, instead. See below.

◆ MAX_SOCKS5_AUTH_FIELD_SIZE

#define MAX_SOCKS5_AUTH_FIELD_SIZE 255

Maximum size of information that we can fit into SOCKS5 username or password fields.

◆ MAX_SOCKS5_AUTH_SIZE_TOTAL

#define MAX_SOCKS5_AUTH_SIZE_TOTAL 2*MAX_SOCKS5_AUTH_FIELD_SIZE

Total maximum size of information that we can fit into SOCKS5 username and password fields.

Function Documentation

◆ alloc_http_authenticator()

char* alloc_http_authenticator ( const char * authenticator )

Allocates a base64'ed authenticator for use in http or https auth, based on the input string authenticator. Returns it if success, else returns NULL.

Here is the call graph for this function:

◆ any_other_active_or_conns()

int any_other_active_or_conns ( const or_connection_t * this_conn )

Return 1 if there are any active OR connections apart from this_conn.

We use this to guess if we should tell the controller that we didn't manage to connect to any of our bridges.

◆ assert_connection_ok()

void assert_connection_ok	(	connection_t *	conn,
		time_t	now
	)

Verify that connection conn has all of its invariants correct. Trigger an assert if anything is invalid.

Here is the caller graph for this function:

◆ conn_listener_type_supports_af_unix()

int conn_listener_type_supports_af_unix ( int type )

Return true iff the provided connection listener type supports AF_UNIX sockets.

◆ conn_state_to_string()

const char* conn_state_to_string	(	int	type,
		int	state
	)

Return the human-readable name for the connection state state for the connection type type

Here is the caller graph for this function:

◆ conn_type_to_string()

const char* conn_type_to_string ( int type )

Return the human-readable name for the connection type type

Here is the caller graph for this function:

◆ connection_about_to_close_connection()

void connection_about_to_close_connection ( connection_t * conn )

Called when we're about to finally unlink and free a connection: perform necessary accounting and cleanup

Directory conns that failed to fetch a rendezvous descriptor need to inform pending rendezvous streams.
OR conns need to call rep_hist_note_*() to record status.
AP conns need to send a socks reject if necessary.
Exit conns need to call connection_dns_remove() if necessary.
AP and Exit conns need to send an end cell if they can.
DNS conns need to fail any resolves that are pending on them.
OR and edge connections need to be unlinked from circuits.

Here is the call graph for this function:

◆ connection_bucket_adjust()

void connection_bucket_adjust ( const or_options_t * options )

Update the global connection bucket settings to a new value.

Here is the call graph for this function:

◆ connection_bucket_init()

void connection_bucket_init ( void )

Initialize the global buckets to the values configured in the options

Here is the call graph for this function:

◆ connection_bucket_write_limit()

ssize_t connection_bucket_write_limit	(	connection_t *	conn,
		time_t	now
	)

How many bytes at most can we write onto this connection?

◆ connection_buf_add_buf()

void connection_buf_add_buf	(	connection_t *	conn,
		buf_t *	buf
	)

Add all bytes from buf to conn's outbuf, draining them from buf. (If the connection is marked and will soon be closed, nothing is drained.)

◆ connection_buf_get_bytes()

int connection_buf_get_bytes	(	char *	string,
		size_t	len,
		connection_t *	conn
	)

A pass-through to fetch_from_buf.

Here is the call graph for this function:

◆ connection_buf_get_line()

int connection_buf_get_line	(	connection_t *	conn,
		char *	data,
		size_t *	data_len
	)

As buf_get_line(), but read from a connection's input buffer.

Here is the call graph for this function:

◆ connection_check_oos()

void connection_check_oos	(	int	n_socks,
		int	failed
	)

Out-of-Sockets handler; n_socks is the current number of open sockets, and failed is non-zero if a socket exhaustion related error immediately preceded this call. This is where to do circuit-killing heuristics as needed.

◆ connection_close_immediate()

void connection_close_immediate ( connection_t * conn )

Close the underlying socket for conn, so we don't try to flush it. Must be used in conjunction with (right before) connection_mark_for_close().

Here is the call graph for this function:

◆ connection_connect()

int connection_connect	(	connection_t *	conn,
		const char *	address,
		const tor_addr_t *	addr,
		uint16_t	port,
		int *	socket_error
	)

Take conn, make a nonblocking socket; try to connect to addr:port (port arrives in host order). If fail, return -1 and if applicable put your best guess about errno into *socket_error. Else assign s to conn->s: if connected return 1, if EAGAIN return 0.

addr:port can be different to conn->addr:conn->port if connecting through a proxy.

address is used to make the logs useful.

On success, add conn to the list of polled connections.

◆ connection_consider_empty_read_buckets()

void connection_consider_empty_read_buckets ( connection_t * conn )

If we have exhausted our global buckets, or the buckets for conn, stop reading.

◆ connection_consider_empty_write_buckets()

void connection_consider_empty_write_buckets ( connection_t * conn )

If we have exhausted our global buckets, or the buckets for conn, stop writing.

◆ connection_dir_list_by_purpose_and_resource()

smartlist_t* connection_dir_list_by_purpose_and_resource	(	int	purpose,
		const char *	resource
	)

Return a list of directory connections that are fetching the item described by purpose/resource. If there are none, return an empty list. This list must be freed using smartlist_free, but the pointers in it must not be freed. Note that this list should not be cached, as the pointers in it can be freed if their connections close.

Here is the call graph for this function:

◆ connection_dir_list_by_purpose_resource_and_state()

smartlist_t* connection_dir_list_by_purpose_resource_and_state	(	int	purpose,
		const char *	resource,
		int	state
	)

Return a list of directory connections that are fetching the item described by purpose/resource/state. If there are none, return an empty list. This list must be freed using smartlist_free, but the pointers in it must not be freed. Note that this list should not be cached, as the pointers in it can be freed if their connections close.

Here is the call graph for this function:

◆ connection_dump_buffer_mem_stats()

void connection_dump_buffer_mem_stats ( int severity )

Log how many bytes are used by buffers of different kinds and sizes.

◆ connection_expire_held_open()

void connection_expire_held_open ( void )

Find each connection that has hold_open_until_flushed set to 1 but hasn't written in the past 15 seconds, and set hold_open_until_flushed to 0. This means it will get cleaned up in the next loop through close_if_marked() in main.c.

Here is the call graph for this function:

◆ connection_fetch_from_buf_http()

int connection_fetch_from_buf_http	(	connection_t *	conn,
		char **	headers_out,
		size_t	max_headerlen,
		char **	body_out,
		size_t *	body_used,
		size_t	max_bodylen,
		int	force_complete
	)

As fetch_from_buf_http, but fetches from a connection's input buffer_t as appropriate.

Here is the caller graph for this function:

◆ connection_flush()

int connection_flush ( connection_t * conn )

Try to flush data that's waiting for a write on conn. Return -1 on failure, 0 on success.

Don't use this function for regular writing; the buffers system should be good enough at scheduling writes there. Instead, this function is for cases when we're about to exit or something and we want to report it right away.

◆ connection_free_all()

void connection_free_all ( void )

Call connection_free_minimal() on every connection in our array, and release all storage held by connection.c.

Don't do the checks in connection_free(), because they will fail.

◆ connection_get_by_global_id()

connection_t* connection_get_by_global_id ( uint64_t id )

Return the stream with id id if it is not already marked for close.

◆ connection_get_by_type()

connection_t* connection_get_by_type ( int type )

Return a connection of type type that is not marked for close.

◆ connection_get_by_type_state()

connection_t* connection_get_by_type_state	(	int	type,
		int	state
	)

Return a connection of type type that is in state state, and that is not marked for close.

◆ connection_get_by_type_state_rendquery()

connection_t* connection_get_by_type_state_rendquery	(	int	type,
		int	state,
		const char *	rendquery
	)

Return a connection of type type that has rendquery equal to rendquery, and that is not marked for close. If state is non-zero, conn must be of that state too.

◆ connection_init_accepted_conn()

int connection_init_accepted_conn	(	connection_t *	conn,
		const listener_connection_t *	listener
	)

Initialize states for newly accepted connection conn.

If conn is an OR, start the TLS handshake.

If conn is a transparent AP, get its original destination and place it in circuit_wait.

The listener parameter is only used for AP connections.

Here is the call graph for this function:

◆ connection_is_listener()

int connection_is_listener ( connection_t * conn )

Return 1 if conn is a listener conn, else return 0.

Here is the caller graph for this function:

◆ connection_link_connections()

void connection_link_connections	(	connection_t *	conn_a,
		connection_t *	conn_b
	)

Create a link between conn_a and conn_b.

◆ connection_mark_all_noncontrol_connections()

void connection_mark_all_noncontrol_connections ( void )

Mark every external connection not used for controllers for close.

◆ connection_mark_all_noncontrol_listeners()

void connection_mark_all_noncontrol_listeners ( void )

Mark every listener of type other than CONTROL_LISTENER to be closed.

Here is the call graph for this function:

◆ connection_mark_for_close_()

void connection_mark_for_close_	(	connection_t *	conn,
		int	line,
		const char *	file
	)

Mark conn to be closed next time we loop through conn_close_if_marked() in main.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ connection_new()

connection_t* connection_new	(	int	type,
		int	socket_family
	)

Allocate, initialize, and return a new connection_t subtype of type to make or receive connections of address family socket_family. The type should be one of the CONN_TYPE_* constants.

◆ connection_or_nonopen_was_started_here()

int connection_or_nonopen_was_started_here ( or_connection_t * conn )

Return 1 if we initiated this connection, or 0 if it started out as an incoming connection.

Here is the call graph for this function:

◆ connection_outbuf_too_full()

int connection_outbuf_too_full ( connection_t * conn )

Are there too many bytes on edge connection conn's outbuf to send back a relay-level sendme yet? Return 1 if so, 0 if not. Used by connection_edge_consider_sending_sendme().

Here is the caller graph for this function:

◆ connection_proxy_connect()

int connection_proxy_connect	(	connection_t *	conn,
		int	type
	)

Write a proxy request of type (socks4, socks5, https) to conn for conn->addr:conn->port, authenticating with the auth details given in the configuration (if available). SOCKS 5 and HTTP CONNECT proxies support authentication.

Returns -1 if conn->addr is incompatible with the proxy protocol, and 0 otherwise.

Use connection_read_proxy_handshake() to complete the handshake.

◆ connection_read_bw_exhausted()

void connection_read_bw_exhausted	(	connection_t *	conn,
		bool	is_global_bw
	)

Mark conn as needing to stop reading because bandwidth has been exhausted. If is_global_bw, it is closing because global bandwidth limit has been exhausted. Otherwise, it is closing because its own bandwidth limit has been exhausted.

◆ connection_read_proxy_handshake()

int connection_read_proxy_handshake ( connection_t * conn )

Call this from connection_*_process_inbuf() to advance the proxy handshake.

No matter what proxy protocol is used, if this function returns 1, the handshake is complete, and the data remaining on inbuf may contain the start of the communication with the requested server.

Returns 0 if the current buffer contains an incomplete response, and -1 on error.

Here is the caller graph for this function:

◆ connection_state_is_connecting()

int connection_state_is_connecting ( connection_t * conn )

Return 1 if conn is in 'connecting' state, else return 0.

◆ connection_state_is_open()

int connection_state_is_open ( connection_t * conn )

Return 1 if conn is in state "open" and is not marked for close, else return 0.

◆ connection_wants_to_flush()

int connection_wants_to_flush ( connection_t * conn )

Return conn->outbuf_flushlen: how many bytes conn wants to flush from its outbuf.

◆ connection_write_bw_exhausted()

void connection_write_bw_exhausted	(	connection_t *	conn,
		bool	is_global_bw
	)

Mark conn as needing to stop reading because write bandwidth has been exhausted. If is_global_bw, it is closing because global bandwidth limit has been exhausted. Otherwise, it is closing because its own bandwidth limit has been exhausted.

◆ control_connection_new()

control_connection_t* control_connection_new ( int socket_family )

Allocate and return a new control_connection_t, initialized as by connection_init().

◆ dir_connection_new()

dir_connection_t* dir_connection_new ( int socket_family )

Allocate and return a new dir_connection_t, initialized as by connection_init().

◆ edge_connection_new()

edge_connection_t* edge_connection_new	(	int	type,
		int	socket_family
	)

Allocate and return a new edge_connection_t, initialized as by connection_init().

Here is the caller graph for this function:

◆ entry_connection_new()

entry_connection_t* entry_connection_new	(	int	type,
		int	socket_family
	)

Allocate and return a new entry_connection_t, initialized as by connection_init().

Allocate space to store the socks_request.

◆ get_proxy_addrport()

int get_proxy_addrport	(	tor_addr_t *	addr,
		uint16_t *	port,
		int *	proxy_type,
		const connection_t *	conn
	)

Fills addr and port with the details of the global proxy server we are using. conn contains the connection we are using the proxy for.

Return 0 on success, -1 on failure.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ global_write_bucket_low()

int global_write_bucket_low	(	connection_t *	conn,
		size_t	attempt,
		int	priority
	)

Return 1 if the global write buckets are low enough that we shouldn't send attempt bytes of low-priority directory stuff out to conn. Else return 0.

Priority was 1 for v1 requests (directories and running-routers), and 2 for v2 requests and later (statuses and descriptors).

There are a lot of parameters we could use here:

global_relayed_write_bucket. Low is bad.
global_write_bucket. Low is bad.
bandwidthrate. Low is bad.
bandwidthburst. Not a big factor?
attempt. High is bad.
total bytes queued on outbufs. High is bad. But I'm wary of using this, since a few slow-flushing queues will pump up the number without meaning what we meant to mean. What we really mean is "total directory bytes added to outbufs recently", but that's harder to quantify and harder to keep track of.

◆ listener_connection_new()

listener_connection_t* listener_connection_new	(	int	type,
		int	socket_family
	)

Allocate and return a new listener_connection_t, initialized as by connection_init().

◆ log_failed_proxy_connection()

void log_failed_proxy_connection ( connection_t * conn )

Log a failed connection to a proxy server. conn is the connection we use the proxy server for.

Here is the call graph for this function:

◆ or_connection_new()

or_connection_t* or_connection_new	(	int	type,
		int	socket_family
	)

Allocate and return a new or_connection_t, initialized as by connection_init().

Initialize active_circuit_pqueue.

Set active_circuit_pqueue_last_recalibrated to current cell_ewma tick.

◆ retry_all_listeners()

int retry_all_listeners	(	smartlist_t *	replaced_conns,
		smartlist_t *	new_conns,
		int	close_all_noncontrol
	)

Launch listeners for each port you should have open. Only launch listeners who are not already open, and only close listeners we no longer want.

Add all old conns that should be closed to replaced_conns. Add all new connections to new_conns.

If close_all_noncontrol is true, then we only open control listeners, and we close all other listeners.

Here is the call graph for this function:

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ CONN_LEN_AND_FREE_TEMPLATE

◆ connection_mark_and_flush_

◆ connection_mark_and_flush_internal_

◆ MAX_SOCKS5_AUTH_FIELD_SIZE

◆ MAX_SOCKS5_AUTH_SIZE_TOTAL

Function Documentation

◆ alloc_http_authenticator()

◆ any_other_active_or_conns()

◆ assert_connection_ok()

◆ conn_listener_type_supports_af_unix()

◆ conn_state_to_string()

◆ conn_type_to_string()

◆ connection_about_to_close_connection()

◆ connection_bucket_adjust()

◆ connection_bucket_init()

◆ connection_bucket_write_limit()

◆ connection_buf_add_buf()

◆ connection_buf_get_bytes()

◆ connection_buf_get_line()

◆ connection_check_oos()

◆ connection_close_immediate()

◆ connection_connect()

◆ connection_consider_empty_read_buckets()

◆ connection_consider_empty_write_buckets()

◆ connection_dir_list_by_purpose_and_resource()

◆ connection_dir_list_by_purpose_resource_and_state()

◆ connection_dump_buffer_mem_stats()

◆ connection_expire_held_open()

◆ connection_fetch_from_buf_http()

◆ connection_flush()

◆ connection_free_all()

◆ connection_get_by_global_id()

◆ connection_get_by_type()

◆ connection_get_by_type_state()

◆ connection_get_by_type_state_rendquery()

◆ connection_init_accepted_conn()

◆ connection_is_listener()

◆ connection_link_connections()

◆ connection_mark_all_noncontrol_connections()

◆ connection_mark_all_noncontrol_listeners()

◆ connection_mark_for_close_()

◆ connection_new()

◆ connection_or_nonopen_was_started_here()

◆ connection_outbuf_too_full()

◆ connection_proxy_connect()

◆ connection_read_bw_exhausted()

◆ connection_read_proxy_handshake()

◆ connection_state_is_connecting()

◆ connection_state_is_open()

◆ connection_wants_to_flush()

◆ connection_write_bw_exhausted()

◆ control_connection_new()

◆ dir_connection_new()

◆ edge_connection_new()

◆ entry_connection_new()

◆ get_proxy_addrport()

◆ global_write_bucket_low()

◆ listener_connection_new()

◆ log_failed_proxy_connection()

◆ or_connection_new()

◆ retry_all_listeners()