242 lines
10 KiB
C
242 lines
10 KiB
C
/* Copyright (c) 2001 Matej Pfajfar.
|
|
* Copyright (c) 2001-2004, Roger Dingledine.
|
|
* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
|
|
* Copyright (c) 2007-2015, The Tor Project, Inc. */
|
|
/* See LICENSE for licensing information */
|
|
|
|
/**
|
|
* \file connection.h
|
|
* \brief Header file for connection.c.
|
|
**/
|
|
|
|
#ifndef TOR_CONNECTION_H
|
|
#define TOR_CONNECTION_H
|
|
|
|
/* XXXX For buf_datalen in inline function */
|
|
#include "buffers.h"
|
|
|
|
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);
|
|
|
|
void connection_link_connections(connection_t *conn_a, connection_t *conn_b);
|
|
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);
|
|
void connection_mark_for_close_internal_(connection_t *conn,
|
|
int line, const char *file);
|
|
|
|
#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__)
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
#define connection_mark_and_flush_internal_(c,line,file) \
|
|
do { \
|
|
connection_t *tmp_conn_ = (c); \
|
|
connection_mark_for_close_internal_(tmp_conn_, (line), (file)); \
|
|
tmp_conn_->hold_open_until_flushed = 1; \
|
|
IF_HAS_BUFFEREVENT(tmp_conn_, \
|
|
connection_start_writing(tmp_conn_)); \
|
|
} while (0)
|
|
|
|
#define connection_mark_and_flush_internal(c) \
|
|
connection_mark_and_flush_internal_((c), __LINE__, SHORT_FILE__)
|
|
|
|
/**
|
|
* Mark 'c' for close, but try to hold it open until all the data is written.
|
|
*/
|
|
#define connection_mark_and_flush_(c,line,file) \
|
|
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)
|
|
|
|
#define connection_mark_and_flush(c) \
|
|
connection_mark_and_flush_((c), __LINE__, SHORT_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);
|
|
|
|
#ifdef HAVE_SYS_UN_H
|
|
|
|
int connection_connect_unix(connection_t *conn, const char *socket_path,
|
|
int *socket_error);
|
|
|
|
#endif /* defined(HAVE_SYS_UN_H) */
|
|
|
|
/** Maximum size of information that we can fit into SOCKS5 username
|
|
or password fields. */
|
|
#define MAX_SOCKS5_AUTH_FIELD_SIZE 255
|
|
|
|
/** Total maximum size of information that we can fit into SOCKS5
|
|
username and password fields. */
|
|
#define MAX_SOCKS5_AUTH_SIZE_TOTAL 2*MAX_SOCKS5_AUTH_FIELD_SIZE
|
|
|
|
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_refill(int seconds_elapsed, time_t now);
|
|
|
|
int connection_handle_read(connection_t *conn);
|
|
|
|
int connection_fetch_from_buf(char *string, size_t len, connection_t *conn);
|
|
int connection_fetch_from_buf_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));
|
|
/* DOCDOC connection_write_to_buf */
|
|
static void connection_write_to_buf(const char *string, size_t len,
|
|
connection_t *conn);
|
|
/* DOCDOC connection_write_to_buf_zlib */
|
|
static void connection_write_to_buf_zlib(const char *string, size_t len,
|
|
dir_connection_t *conn, int done);
|
|
static INLINE void
|
|
connection_write_to_buf(const char *string, size_t len, connection_t *conn)
|
|
{
|
|
connection_write_to_buf_impl_(string, len, conn, 0);
|
|
}
|
|
static INLINE void
|
|
connection_write_to_buf_zlib(const char *string, size_t len,
|
|
dir_connection_t *conn, int done)
|
|
{
|
|
connection_write_to_buf_impl_(string, len, TO_CONN(conn), done ? -1 : 1);
|
|
}
|
|
|
|
/* DOCDOC connection_get_inbuf_len */
|
|
static size_t connection_get_inbuf_len(connection_t *conn);
|
|
/* DOCDOC connection_get_outbuf_len */
|
|
static size_t connection_get_outbuf_len(connection_t *conn);
|
|
|
|
static INLINE size_t
|
|
connection_get_inbuf_len(connection_t *conn)
|
|
{
|
|
IF_HAS_BUFFEREVENT(conn, {
|
|
return evbuffer_get_length(bufferevent_get_input(conn->bufev));
|
|
}) ELSE_IF_NO_BUFFEREVENT {
|
|
return conn->inbuf ? buf_datalen(conn->inbuf) : 0;
|
|
}
|
|
}
|
|
|
|
static INLINE size_t
|
|
connection_get_outbuf_len(connection_t *conn)
|
|
{
|
|
IF_HAS_BUFFEREVENT(conn, {
|
|
return evbuffer_get_length(bufferevent_get_output(conn->bufev));
|
|
}) ELSE_IF_NO_BUFFEREVENT {
|
|
return conn->outbuf ? buf_datalen(conn->outbuf) : 0;
|
|
}
|
|
}
|
|
|
|
connection_t *connection_get_by_global_id(uint64_t id);
|
|
|
|
connection_t *connection_get_by_type(int type);
|
|
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);
|
|
dir_connection_t *connection_dir_get_by_purpose_and_resource(
|
|
int state, const char *resource);
|
|
|
|
int any_other_active_or_conns(const or_connection_t *this_conn);
|
|
|
|
/* || 0 is for -Wparentheses-equality (-Wall?) appeasement under clang */
|
|
#define connection_speaks_cells(conn) (((conn)->type == CONN_TYPE_OR) || 0)
|
|
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);
|
|
void remove_file_if_very_old(const char *fname, time_t now);
|
|
|
|
#ifdef USE_BUFFEREVENTS
|
|
int connection_type_uses_bufferevent(connection_t *conn);
|
|
void connection_configure_bufferevent_callbacks(connection_t *conn);
|
|
void connection_handle_read_cb(struct bufferevent *bufev, void *arg);
|
|
void connection_handle_write_cb(struct bufferevent *bufev, void *arg);
|
|
void connection_handle_event_cb(struct bufferevent *bufev, short event,
|
|
void *arg);
|
|
void connection_get_rate_limit_totals(uint64_t *read_out,
|
|
uint64_t *written_out);
|
|
void connection_enable_rate_limiting(connection_t *conn);
|
|
#else
|
|
#define connection_type_uses_bufferevent(c) (0)
|
|
#endif
|
|
|
|
#ifdef CONNECTION_PRIVATE
|
|
STATIC void connection_free_(connection_t *conn);
|
|
|
|
/* Used only by connection.c and test*.c */
|
|
uint32_t bucket_millis_empty(int tokens_before, uint32_t last_empty_time,
|
|
int tokens_after, int milliseconds_elapsed,
|
|
const struct timeval *tvnow);
|
|
void connection_buckets_note_empty_ts(uint32_t *timestamp_var,
|
|
int tokens_before,
|
|
size_t tokens_removed,
|
|
const struct timeval *tvnow);
|
|
#endif
|
|
|
|
#endif
|
|
|