Tor 0.4.9.0-alpha-dev
|
Launch the right sort of circuits and attach the right streams to them. More...
#include "core/or/or.h"
#include "app/config/config.h"
#include "core/mainloop/connection.h"
#include "core/or/channel.h"
#include "core/or/circuitbuild.h"
#include "core/or/circuitlist.h"
#include "core/or/circuitstats.h"
#include "core/or/circuituse.h"
#include "core/or/circuitpadding.h"
#include "core/or/conflux_pool.h"
#include "core/or/connection_edge.h"
#include "core/or/extendinfo.h"
#include "core/or/policies.h"
#include "core/or/trace_probes_circuit.h"
#include "feature/client/addressmap.h"
#include "feature/client/bridges.h"
#include "feature/client/circpathbias.h"
#include "feature/client/entrynodes.h"
#include "feature/client/proxymode.h"
#include "feature/control/control_events.h"
#include "feature/dircommon/directory.h"
#include "feature/hs/hs_circuit.h"
#include "feature/hs/hs_client.h"
#include "feature/hs/hs_common.h"
#include "feature/hs/hs_ident.h"
#include "feature/hs/hs_metrics.h"
#include "feature/hs/hs_stats.h"
#include "feature/nodelist/describe.h"
#include "feature/nodelist/networkstatus.h"
#include "feature/nodelist/nodelist.h"
#include "feature/nodelist/routerlist.h"
#include "feature/relay/routermode.h"
#include "feature/relay/selftest.h"
#include "feature/stats/predict_ports.h"
#include "lib/math/fp.h"
#include "lib/time/tvdiff.h"
#include "lib/trace/events.h"
#include "src/core/mainloop/mainloop.h"
#include "core/or/conflux.h"
#include "core/or/cpath_build_state_st.h"
#include "feature/dircommon/dir_connection_st.h"
#include "core/or/entry_connection_st.h"
#include "core/or/extend_info_st.h"
#include "core/or/or_circuit_st.h"
#include "core/or/origin_circuit_st.h"
#include "core/or/socks_request_st.h"
#include "core/or/conflux_util.h"
Go to the source code of this file.
Macros | |
#define | SET_CUTOFF(target, msec) |
#define | MAX_ANCIENT_ONEHOP_CIRCUITS_TO_LOG 10 |
#define | MAX_UNUSED_OPEN_CIRCUITS 14 |
#define | SUFFICIENT_UPTIME_INTERNAL_HS_SERVERS 3 |
#define | SUFFICIENT_INTERNAL_HS_CLIENTS 3 |
#define | SUFFICIENT_UPTIME_INTERNAL_HS_CLIENTS 2 |
#define | DFLT_CBT_UNUSED_OPEN_CIRCS (10) |
#define | MIN_CBT_UNUSED_OPEN_CIRCS 0 |
#define | MAX_CBT_UNUSED_OPEN_CIRCS MAX_UNUSED_OPEN_CIRCUITS |
#define | TESTING_CIRCUIT_INTERVAL 300 |
#define | IDLE_ONE_HOP_CIRC_TIMEOUT 60 |
#define | NUM_PARALLEL_TESTING_CIRCS 4 |
#define | MAX_CIRCUIT_FAILURES 5 |
Variables | |
static time_t | last_expired_clientside_circuits = 0 |
static int | have_performed_bandwidth_test = 0 |
static int | n_circuit_failures = 0 |
static int | did_circs_fail_last_period = 0 |
Launch the right sort of circuits and attach the right streams to them.
As distinct from circuitlist.c, which manages lookups to find circuits, and circuitbuild.c, which handles the logistics of circuit construction, this module keeps track of which streams can be attached to which circuits (in circuit_get_best()), and attaches streams to circuits (with circuit_try_attaching_streams(), connection_ap_handshake_attach_circuit(), and connection_ap_handshake_attach_chosen_circuit() ).
This module also makes sure that we are building circuits for all of the predicted ports, using circuit_remove_handled_ports(), circuit_stream_is_being_handled(), and circuit_build_needed_cirs(). It handles launching circuits for specific targets using circuit_launch_by_extend_info().
This is also where we handle expiring circuits that have been around for too long without actually completing, along with the circuit_build_timeout logic in circuitstats.c.
Definition in file circuituse.c.
#define DFLT_CBT_UNUSED_OPEN_CIRCS (10) |
Definition at line 1168 of file circuituse.c.
#define IDLE_ONE_HOP_CIRC_TIMEOUT 60 |
How long do we wait before killing circuits with the properties described below?
Probably we could choose a number here as low as 5 to 10 seconds, since these circs are used for begindir, and a) generally you either ask another begindir question right after or you don't for a long time, b) clients at least through 0.2.1.x choose from the whole set of directory mirrors at each choice, and c) re-establishing a one-hop circuit via create-fast is a light operation assuming the TLS conn is still there.
I expect "b" to go away one day when we move to using directory guards, but I think "a" and "c" are good enough reasons that a low number is safe even then.
Definition at line 1541 of file circuituse.c.
#define MAX_CBT_UNUSED_OPEN_CIRCS MAX_UNUSED_OPEN_CIRCUITS |
Definition at line 1170 of file circuituse.c.
#define MAX_CIRCUIT_FAILURES 5 |
Don't retry launching a new circuit if we try this many times with no success.
Definition at line 1928 of file circuituse.c.
#define MAX_UNUSED_OPEN_CIRCUITS 14 |
Don't keep more than this many unused open circuits around.
Definition at line 1059 of file circuituse.c.
#define MIN_CBT_UNUSED_OPEN_CIRCS 0 |
Definition at line 1169 of file circuituse.c.
#define NUM_PARALLEL_TESTING_CIRCS 4 |
Number of testing circuits we want open before testing our bandwidth.
Definition at line 1578 of file circuituse.c.
#define SET_CUTOFF | ( | target, | |
msec | |||
) |
#define SUFFICIENT_INTERNAL_HS_CLIENTS 3 |
Definition at line 1142 of file circuituse.c.
#define SUFFICIENT_UPTIME_INTERNAL_HS_CLIENTS 2 |
Definition at line 1146 of file circuituse.c.
#define SUFFICIENT_UPTIME_INTERNAL_HS_SERVERS 3 |
Definition at line 1108 of file circuituse.c.
#define TESTING_CIRCUIT_INTERVAL 300 |
Build a new test circuit every 5 minutes
Definition at line 1295 of file circuituse.c.
void circuit_build_failed | ( | origin_circuit_t * | circ | ) |
Called whenever a circuit could not be successfully built.
Definition at line 1761 of file circuituse.c.
Referenced by circuit_about_to_free().
void circuit_build_needed_circs | ( | time_t | now | ) |
This function is called once a second, if router_have_minimum_dir_info() is true. Its job is to make sure all services we offer have enough circuits available. Some services just want enough circuits for current tasks, whereas others want a minimum set of idle circuits hanging around.
Definition at line 1303 of file circuituse.c.
Referenced by second_elapsed_callback().
void circuit_change_purpose | ( | circuit_t * | circ, |
uint8_t | new_purpose | ||
) |
Change circ's purpose to new_purpose.
Definition at line 3100 of file circuituse.c.
Referenced by close_or_reextend_intro_circ(), and finalize_rend_circuit().
void circuit_detach_stream | ( | circuit_t * | circ, |
edge_connection_t * | conn | ||
) |
If the stream conn is a member of any of the linked lists of circ, then remove it from the list.
Definition at line 1357 of file circuituse.c.
Referenced by connection_exit_about_to_close().
int circuit_enough_testing_circs | ( | void | ) |
Return 1 if we've already exercised our bandwidth, or if we have fewer than NUM_PARALLEL_TESTING_CIRCS testing circuits established or on the way. Else return 0.
Definition at line 1597 of file circuituse.c.
Referenced by router_do_reachability_checks().
void circuit_expire_building | ( | void | ) |
Close all circuits that start at us, aren't open, and were born at least CircuitBuildTimeout seconds ago.
TODO: This function is now partially redundant to circuit_build_times_handle_completed_hop(), but that function only covers circuits up to and including 3 hops that are still actually completing hops. However, circuit_expire_building() also handles longer circuits, as well as circuits that are completely stalled. In the future (after prop247/other path selection revamping), we probably want to eliminate this rats nest in favor of a simpler approach.
Because circuit build timeout is calculated only based on 3 hop general purpose circuit construction, we need to scale the timeout to make it properly apply to longer circuits, and circuits of certain usage types. The following diagram illustrates how we derive the scaling below. In short, we calculate the number of times our telescoping-based circuit construction causes cells to traverse each link for the circuit purpose types in question, and then assume each link is equivalent.
OP –a--> A –b--> B –c--> C OP –a--> A –b--> B –c--> C –d--> D
Let h = a = b = c = d
Three hops (general_cutoff) RTTs = 3a + 2b + c RTTs = 6h Cannibalized: RTTs = a+b+c+d RTTs = 4h Four hops: RTTs = 4a + 3b + 2c + d RTTs = 10h Client INTRODUCE1+ACK: // XXX: correct? RTTs = 5a + 4b + 3c + 2d RTTs = 14h Server intro: RTTs = 4a + 3b + 2c RTTs = 9h
Definition at line 445 of file circuituse.c.
Referenced by second_elapsed_callback().
void circuit_expire_old_circs_as_needed | ( | time_t | now | ) |
Called once a second either directly or from circuit_build_needed_circs(). As appropriate (once per NewCircuitPeriod) resets failure counts and expires old circuits.
Definition at line 1326 of file circuituse.c.
Referenced by second_elapsed_callback().
STATIC void circuit_expire_old_circuits_clientside | ( | void | ) |
Find each circuit that has been unused for too long, or dirty for too long and has no streams on it: mark it for close.
Definition at line 1446 of file circuituse.c.
Referenced by circuit_expire_old_circs_as_needed().
void circuit_expire_old_circuits_serverside | ( | time_t | now | ) |
Find each non-origin circuit that has been unused for too long, has no streams on it, came from a client, and ends here: mark it for close.
Definition at line 1548 of file circuituse.c.
Referenced by expire_old_circuits_serverside_callback().
void circuit_expire_waiting_for_better_guard | ( | void | ) |
Mark for close all circuits that start here, that were built through a guard we weren't sure if we wanted to use, and that have been waiting around for way too long.
Definition at line 828 of file circuituse.c.
Referenced by second_elapsed_callback().
|
static |
Find the best circ that conn can use, preferably one which is dirty. Circ must not be too old.
Conn must be defined.
If must_be_open, ignore circs not in CIRCUIT_STATE_OPEN.
circ_purpose specifies what sort of circuit we must have. It can be C_GENERAL, C_INTRODUCE_ACK_WAIT, or C_REND_JOINED.
If it's REND_JOINED and must_be_open==0, then return the closest rendezvous-purposed circuit that you can find.
If it's INTRODUCE_ACK_WAIT and must_be_open==0, then return the closest introduce-purposed circuit that you can find.
Definition at line 335 of file circuituse.c.
|
static |
Find an open circ that we're happy to use for conn and return 1. If there isn't one, and there isn't one on the way, launch one and return 0. If it will never work, return -1.
Write the found or in-progress or launched circ into *circp.
Definition at line 2239 of file circuituse.c.
void circuit_has_opened | ( | origin_circuit_t * | circ | ) |
The circuit circ has just become open. Take the next step: for rendezvous circuits, we pass circ to the appropriate function in rendclient or rendservice. For general circuits, we call connection_ap_attach_pending, which looks for pending streams that could use circ.
Definition at line 1664 of file circuituse.c.
|
static |
Record another failure at opening a general circuit. When we have too many, we'll stop trying for the remainder of this minute.
Definition at line 2212 of file circuituse.c.
int circuit_is_acceptable | ( | const origin_circuit_t * | origin_circ, |
const entry_connection_t * | conn, | ||
int | must_be_open, | ||
uint8_t | purpose, | ||
int | need_uptime, | ||
int | need_internal, | ||
time_t | now | ||
) |
Return 1 if circ could be returned by circuit_get_best(). Else return 0.
Definition at line 107 of file circuituse.c.
Referenced by circuit_get_best().
Definition at line 1067 of file circuituse.c.
|
static |
Return 1 if circuit a is better than circuit b for conn, and return 0 otherwise. Used by circuit_get_best.
Definition at line 243 of file circuituse.c.
Referenced by circuit_get_best().
bool circuit_is_hs_v3 | ( | const circuit_t * | circ | ) |
Return true iff the given circuit is an HS v3 circuit.
Definition at line 2001 of file circuituse.c.
Referenced by cleanup_on_close_client_circ(), cleanup_on_free_client_circ(), and hs_circ_cleanup_on_close().
origin_circuit_t * circuit_launch | ( | uint8_t | purpose, |
int | flags | ||
) |
Launch a new circuit; see circuit_launch_by_extend_info() for details on arguments.
Definition at line 1933 of file circuituse.c.
Referenced by circuit_expire_old_circs_as_needed().
origin_circuit_t * circuit_launch_by_extend_info | ( | uint8_t | purpose, |
extend_info_t * | extend_info, | ||
int | flags | ||
) |
Launch a new circuit with purpose purpose and exit node extend_info (or NULL to select a random exit node).
If flags contains:
Return the newly allocated circuit on success, or NULL on failure.
Definition at line 2094 of file circuituse.c.
Referenced by circuit_launch().
void circuit_log_ancient_one_hop_circuits | ( | int | age | ) |
As a diagnostic for bug 8387, log information about how many one-hop circuits we have around that have been there for at least age seconds. Log a few of them. Ignores Single Onion Service intro, it is expected to be long-term one-hop circuits.
Definition at line 852 of file circuituse.c.
|
static |
Check whether the hidden service destination of the stream at edge_conn is the same as the destination of the circuit at origin_circ.
Definition at line 87 of file circuituse.c.
|
static |
Determine how many circuits we have open that are clean, Make sure it's enough for all the upcoming behaviors we predict we'll have. But put an upper bound on the total number of circuits.
Definition at line 1196 of file circuituse.c.
int circuit_purpose_is_hidden_service | ( | uint8_t | purpose | ) |
Tell us if a circuit is a hidden service circuit.
Definition at line 1956 of file circuituse.c.
Referenced by circuit_should_use_vanguards(), middle_node_must_be_vanguard(), and route_len_for_purpose().
bool circuit_purpose_is_hs_client | ( | const uint8_t | purpose | ) |
Return true iff the given circuit is an HS client circuit.
Definition at line 1978 of file circuituse.c.
Referenced by circuit_purpose_is_hidden_service(), hs_circ_cleanup_on_close(), and hs_circ_cleanup_on_free().
bool circuit_purpose_is_hs_service | ( | const uint8_t | purpose | ) |
Return true iff the given circuit is an HS service circuit.
Definition at line 1986 of file circuituse.c.
Referenced by circuit_purpose_is_hidden_service(), and hs_circ_cleanup_on_close().
bool circuit_purpose_is_hs_vanguards | ( | const uint8_t | purpose | ) |
Return true iff the given circuit is an HS Vanguards circuit.
Definition at line 1994 of file circuituse.c.
Referenced by circuit_purpose_is_hidden_service().
void circuit_read_valid_data | ( | origin_circuit_t * | circ, |
uint16_t | relay_body_len | ||
) |
Add relay_body_len and RELAY_PAYLOAD_SIZE-relay_body_len to the valid delivered read field and the overhead field, respectively.
Definition at line 3202 of file circuituse.c.
void circuit_remove_handled_ports | ( | smartlist_t * | needed_ports | ) |
Remove any elements in needed_ports that are handled by an open or in-progress circuit.
Definition at line 984 of file circuituse.c.
Referenced by circuit_get_unhandled_ports().
void circuit_reset_failure_count | ( | int | timeout | ) |
Reset the failure count for opening general circuits. This means we will try MAX_CIRCUIT_FAILURES times more (if necessary) before stopping again.
Definition at line 2223 of file circuituse.c.
Referenced by circuit_expire_old_circs_as_needed().
void circuit_sent_valid_data | ( | origin_circuit_t * | circ, |
uint16_t | relay_body_len | ||
) |
Add relay_body_len and RELAY_PAYLOAD_SIZE-relay_body_len to the valid delivered written fields and the overhead field, respectively.
Definition at line 3181 of file circuituse.c.
|
static |
Return true for the set of conditions for which it is OK to use a cannibalized circuit.
Don't cannibalize for onehops, or certain purposes.
Definition at line 2036 of file circuituse.c.
int circuit_should_use_vanguards | ( | uint8_t | purpose | ) |
Return true if this circuit purpose should use vanguards or pinned Layer2 or Layer3 guards.
This function takes both the circuit purpose and the torrc options for pinned middles/vanguards into account (ie: the circuit must be a hidden service circuit and vanguards/pinned middles must be enabled for it to return true).
Definition at line 2018 of file circuituse.c.
Referenced by build_middle_exclude_list(), and get_circuit_purpose_needed_to_cannibalize().
int circuit_stream_is_being_handled | ( | entry_connection_t * | conn, |
uint16_t | port, | ||
int | min | ||
) |
Return 1 if at least min general-purpose non-internal circuits will have an acceptable exit node for exit stream conn if it is defined, else for "*:port". Else return 0.
Definition at line 1009 of file circuituse.c.
Referenced by ap_stream_wants_exit_attention().
|
static |
A testing circuit has failed to build. Take whatever stats we want.
Definition at line 1641 of file circuituse.c.
|
static |
A testing circuit has completed. Take whatever stats we want. Noticing reachability is taken care of in onionskin_answer(), so there's no need to record anything here. But if we still want to do the bandwidth test, and we now have enough testing circuits open, do it.
Definition at line 1621 of file circuituse.c.
void circuit_try_attaching_streams | ( | origin_circuit_t * | circ | ) |
Called when a circuit becomes ready for streams to be attached to it.
Definition at line 1744 of file circuituse.c.
|
static |
If the stream-isolation state of circ can be cleared, clear it. Return non-zero iff circ's isolation state was cleared.
Definition at line 1722 of file circuituse.c.
Referenced by circuit_try_attaching_streams().
|
static |
Return an appropriate circuit purpose for non-rend streams. We don't handle rends here because a rend stream triggers two circuit builds with different purposes, so it is handled elsewhere.
This function just figures out what type of hsdir activity this is, and tells us. Everything else is general.
Definition at line 2811 of file circuituse.c.
int connection_ap_handshake_attach_chosen_circuit | ( | entry_connection_t * | conn, |
origin_circuit_t * | circ, | ||
crypt_path_t * | cpath | ||
) |
Attempt to attach the connection conn to circ, and send a begin or resolve cell as appropriate. Return values are as for connection_ap_handshake_attach_circuit. The stream will exit from the hop indicated by cpath, or from the last hop in circ's cpath if cpath is NULL.
Definition at line 2755 of file circuituse.c.
int connection_ap_handshake_attach_circuit | ( | entry_connection_t * | conn | ) |
Try to find a safe live circuit for stream conn. If we find one, attach the stream, send appropriate cells, and return 1. Otherwise, try to launch new circuit(s) for the stream. If we can launch circuits, return 0. Otherwise, if we simply can't proceed with this stream, return -1. (conn needs to die, and is maybe already marked).
Definition at line 2840 of file circuituse.c.
|
static |
If an exit wasn't explicitly specified for conn, consider saving the exit that we did choose for use by future connections to conn's destination.
Definition at line 2710 of file circuituse.c.
Referenced by connection_ap_handshake_attach_chosen_circuit().
|
static |
Return the number of not-yet-open general-purpose origin circuits.
Definition at line 385 of file circuituse.c.
|
static |
Return true iff crypt_path is one of the crypt_paths for circ.
WARNING: This function only validates that the cpath is on the current circuit, for internal consistency checking. For codepaths involving streams, or cpaths or layer_hints that could be from a different circuit due to conflux, use edge_uses_cpath() or conflux_validate_source_hop() instead.
Definition at line 2601 of file circuituse.c.
|
static |
Definition at line 1944 of file circuituse.c.
int hostname_in_track_host_exits | ( | const or_options_t * | options, |
const char * | address | ||
) |
Return true iff address is matched by one of the entries in TrackHostExits.
Definition at line 2688 of file circuituse.c.
|
static |
Attach the AP stream apconn to circ's linked list of p_streams. Also set apconn's cpath_layer to cpath, or to the last hop in circ's cpath if cpath is NULL.
Definition at line 2617 of file circuituse.c.
Referenced by connection_ap_handshake_attach_chosen_circuit().
void mark_circuit_unusable_for_new_conns | ( | origin_circuit_t * | circ | ) |
Mark circ so that no more connections can be attached to it.
Definition at line 3153 of file circuituse.c.
Referenced by circuit_mark_all_dirty_circs_as_unusable().
STATIC int needs_circuits_for_build | ( | int | num | ) |
Definition at line 1176 of file circuituse.c.
STATIC int needs_exit_circuits | ( | time_t | now, |
int * | needs_uptime, | ||
int * | needs_capacity | ||
) |
Definition at line 1100 of file circuituse.c.
STATIC int needs_hs_client_circuits | ( | time_t | now, |
int * | needs_uptime, | ||
int * | needs_capacity, | ||
int | num_internal, | ||
int | num_uptime_internal | ||
) |
Definition at line 1151 of file circuituse.c.
STATIC int needs_hs_server_circuits | ( | time_t | now, |
int | num_uptime_internal | ||
) |
Definition at line 1113 of file circuituse.c.
void reset_bandwidth_test | ( | void | ) |
Reset have_performed_bandwidth_test, so we'll start building testing circuits again so we can exercise our bandwidth.
Definition at line 1587 of file circuituse.c.
|
static |
Before the last time we called circuit_reset_failure_count(), were there a lot of failures?
Definition at line 1924 of file circuituse.c.
Referenced by circuit_reset_failure_count().
|
static |
True iff we've ever had enough testing circuits open to test our bandwidth.
Definition at line 1582 of file circuituse.c.
Referenced by circuit_enough_testing_circs(), circuit_testing_opened(), and reset_bandwidth_test().
|
static |
For debugging #8387: track when we last called circuit_expire_old_circuits_clientside.
Definition at line 843 of file circuituse.c.
Referenced by circuit_expire_old_circuits_clientside().
|
static |
Number of consecutive failures so far; should only be touched by circuit_launch_new and circuit_*_failure_count.
Definition at line 1921 of file circuituse.c.
Referenced by circuit_increment_failure_count(), and circuit_reset_failure_count().