Conflux circuit pool management. More...
#include "core/or/or.h"#include "app/config/config.h"#include "core/or/circuitbuild.h"#include "core/or/circuitlist.h"#include "core/or/circuitstats.h"#include "core/or/circuituse.h"#include "core/or/congestion_control_st.h"#include "core/or/conflux.h"#include "core/or/conflux_cell.h"#include "trunnel/conflux.h"#include "core/or/conflux_params.h"#include "core/or/conflux_pool.h"#include "core/or/conflux_util.h"#include "core/or/relay.h"#include "core/or/connection_edge.h"#include "core/or/edge_connection_st.h"#include "core/or/crypt_path_st.h"#include "core/or/or_circuit_st.h"#include "core/or/origin_circuit_st.h"#include "core/or/extend_info_st.h"#include "core/or/conflux_st.h"#include "feature/nodelist/nodelist.h"#include "feature/client/bridges.h"#include "lib/crypt_ops/crypto_rand.h"#include "lib/crypt_ops/crypto_util.h"Go to the source code of this file.
Data Structures | |
| struct | leg_t |
| struct | unlinked_circuits_t |
Macros | |
| #define | TOR_CONFLUX_PRIVATE |
| #define | CONFLUX_CELL_PRIVATE |
| #define | conflux_free(cfx) |
Enumerations | |
| enum | link_circ_err_t { ERR_LINK_CIRC_OK = 0 , ERR_LINK_CIRC_BAD_RTT = 1 , ERR_LINK_CIRC_MISSING_LEG = 2 , ERR_LINK_CIRC_MISSING_SET = 3 , ERR_LINK_CIRC_INVALID_LEG = 4 } |
Variables | |
| static bool | shutting_down = false |
| static digest256map_t * | client_linked_pool |
| static digest256map_t * | client_unlinked_pool |
| static digest256map_t * | server_linked_pool |
| static digest256map_t * | server_unlinked_pool |
| STATIC uint8_t | DEFAULT_CLIENT_UX = CONFLUX_UX_HIGH_THROUGHPUT |
| STATIC uint8_t | DEFAULT_EXIT_UX = CONFLUX_UX_MIN_LATENCY |
Detailed Description
Conflux circuit pool management.
Definition in file conflux_pool.c.
Macro Definition Documentation
◆ CONFLUX_CELL_PRIVATE
| #define CONFLUX_CELL_PRIVATE |
Definition at line 10 of file conflux_pool.c.
◆ conflux_free
| #define conflux_free | ( | cfx | ) |
Wrapper for the free function, set the cfx pointer to NULL after free
Definition at line 207 of file conflux_pool.c.
Referenced by free_conflux_void_(), linked_circuit_free(), and unlinked_free().
◆ TOR_CONFLUX_PRIVATE
| #define TOR_CONFLUX_PRIVATE |
Definition at line 9 of file conflux_pool.c.
Enumeration Type Documentation
◆ link_circ_err_t
| enum link_circ_err_t |
Error code used when linking circuits. Based on those, we decide to relaunch or not.
Definition at line 107 of file conflux_pool.c.
Function Documentation
◆ cfx_add_leg()
Add up a new leg to the given conflux object.
are, so this option seems better right now)
Definition at line 491 of file conflux_pool.c.
Referenced by try_finalize_set().
◆ cfx_del_leg()
Clean up a circuit from its conflux_t object.
Return true if closing this circuit should tear down the entire set, false otherwise.
Definition at line 556 of file conflux_pool.c.
Referenced by linked_circuit_closed(), and linked_circuit_free().
◆ conflux_add_guards_to_exclude_list()
| void conflux_add_guards_to_exclude_list | ( | const origin_circuit_t * | orig_circ, |
| smartlist_t * | excluded ) |
Add the identity digest of the guard nodes of all legs of the conflux circuit.
This function checks both pending and linked conflux circuits.
Definition at line 1217 of file conflux_pool.c.
◆ conflux_add_middles_to_exclude_list()
| void conflux_add_middles_to_exclude_list | ( | const origin_circuit_t * | orig_circ, |
| smartlist_t * | excluded ) |
Add the identity digest of the middle nodes of all legs of the conflux circuit.
This function checks both pending and linked conflux circuits.
XXX: The add guard and middle could be merged since it is the exact same code except for the cpath position and the identity digest vs node_t in the list. We could use an extra param indicating guard or middle.
Definition at line 1285 of file conflux_pool.c.
Referenced by build_middle_exclude_list().
◆ conflux_choose_algorithm()
|
static |
Return the conflux algorithm for a desired UX value.
Definition at line 150 of file conflux_pool.c.
Referenced by cfx_add_leg().
◆ conflux_circuit_about_to_free()
| void conflux_circuit_about_to_free | ( | circuit_t * | circ | ) |
Called when a circuit is freed.
It is possible a conflux circuit gets freed without being closed (for instance SIGTERM) and so this callback is needed in order to finalize the cleanup.
Definition at line 2095 of file conflux_pool.c.
Referenced by circuit_about_to_free(), and circuit_about_to_free_atexit().
◆ conflux_circuit_has_closed()
| void conflux_circuit_has_closed | ( | circuit_t * | circ | ) |
Circuit has been marked for close.
Definition at line 1728 of file conflux_pool.c.
Referenced by circuit_change_purpose(), and circuit_mark_for_close_().
◆ conflux_circuit_has_opened()
| void conflux_circuit_has_opened | ( | origin_circuit_t * | orig_circ | ) |
Circuit with conflux purpose just opened.
Definition at line 1741 of file conflux_pool.c.
Referenced by circuit_has_opened().
◆ conflux_free_()
|
static |
Definition at line 185 of file conflux_pool.c.
◆ conflux_get_circ_for_conn()
| origin_circuit_t * conflux_get_circ_for_conn | ( | const entry_connection_t * | conn, |
| time_t | now, | ||
| int | need_internal ) |
Return the first circuit from the linked pool that will work with the conn. If no such circuit exists, return NULL.
The need_internal argument must match the caller's stream requirement. When it is true (for example, for anonymized directory requests), non-internal conflux circuits are excluded by circuit_is_acceptable(). At present, conflux circuits in this pool are non-internal.
Definition at line 1421 of file conflux_pool.c.
Referenced by circuit_get_best().
◆ conflux_launch_leg()
| bool conflux_launch_leg | ( | const uint8_t * | nonce | ) |
Launch a new conflux leg for the given nonce.
Return true on success else false which teardowns the entire unlinked set if any.
Definition at line 1129 of file conflux_pool.c.
Referenced by launch_new_set(), and unlinked_circuit_closed().
◆ conflux_log_set()
| void conflux_log_set | ( | int | loglevel, |
| const conflux_t * | cfx, | ||
| bool | is_client ) |
Return a description of all linked and unlinked circuits associated with a conflux set.
For use in rare bug cases that are hard to diagnose.
Definition at line 2138 of file conflux_pool.c.
Referenced by conflux_pick_first_leg(), conflux_validate_legs(), linked_circuit_free(), and try_finalize_set().
◆ conflux_mark_all_for_close()
| void conflux_mark_all_for_close | ( | const uint8_t * | nonce, |
| bool | is_client, | ||
| int | reason ) |
Upon an error condition or a close of an in-use circuit, we must close all linked and unlinked circuits associated with a set. When the last leg of each set is closed, the set is removed from the pool.
Definition at line 679 of file conflux_pool.c.
Referenced by conflux_decide_circ_for_send(), linked_circuit_closed(), and try_finalize_set().
◆ conflux_new()
|
static |
Return a newly allocated conflux_t object.
Definition at line 174 of file conflux_pool.c.
Referenced by unlinked_new().
◆ conflux_notify_shutdown()
| void conflux_notify_shutdown | ( | void | ) |
Conflux needs a notification when tor_shutdown() begins, so that when circuits are freed, new legs are not launched.
This needs a separate notification from conflux_pool_free_all(), because circuits must be freed before that function.
Definition at line 2199 of file conflux_pool.c.
Referenced by tor_free_all().
◆ conflux_pool_free_all()
| void conflux_pool_free_all | ( | void | ) |
Free and clean up the conflux pool subsystem. This is called by the subsys manager AFTER all circuits have been freed which implies that all objects in the pools aren't referenced anymore.
Definition at line 2219 of file conflux_pool.c.
Referenced by tor_free_all().
◆ conflux_pool_init()
| void conflux_pool_init | ( | void | ) |
Initialize the conflux pool subsystem. This is called by the subsys manager.
Definition at line 2115 of file conflux_pool.c.
◆ conflux_predict_new()
| void conflux_predict_new | ( | time_t | now | ) |
Determine if we need to launch new conflux circuits for our preemptive pool.
This is called once a second from the mainloop from circuit_predict_and_launch_new().
Definition at line 1370 of file conflux_pool.c.
Referenced by circuit_predict_and_launch_new().
◆ conflux_process_link()
| void conflux_process_link | ( | circuit_t * | circ, |
| const relay_msg_t * | msg ) |
Process a CONFLUX_LINK cell which arrived on the given circuit.
Definition at line 1792 of file conflux_pool.c.
Referenced by handle_relay_msg().
◆ conflux_process_linked()
| void conflux_process_linked | ( | circuit_t * | circ, |
| crypt_path_t * | layer_hint, | ||
| const relay_msg_t * | msg ) |
Process a CONFLUX_LINKED cell which arrived on the given circuit.
Definition at line 1902 of file conflux_pool.c.
Referenced by handle_relay_msg().
◆ conflux_process_linked_ack()
| void conflux_process_linked_ack | ( | circuit_t * | circ | ) |
Process a CONFLUX_LINKED_ACK cell which arrived on the given circuit.
Definition at line 2048 of file conflux_pool.c.
Referenced by handle_relay_msg().
◆ count_client_usable_sets()
|
static |
Return the number of unused client linked set.
Definition at line 1341 of file conflux_pool.c.
Referenced by conflux_predict_new().
◆ fmt_nonce()
|
inlinestatic |
Helper: Format at 8 bytes the nonce for logging.
Definition at line 141 of file conflux_pool.c.
Referenced by conflux_circuit_has_opened(), conflux_launch_leg(), conflux_log_set(), conflux_process_link(), conflux_process_linked(), conflux_process_linked_ack(), launch_leg_is_allowed(), link_circuit(), and unlinked_circuit_closed().
◆ free_conflux_void_()
|
inlinestatic |
Helper: Free function for the digest256map_free().
Definition at line 212 of file conflux_pool.c.
Referenced by conflux_pool_free_all().
◆ free_unlinked_void_()
|
inlinestatic |
Helper: Free function taking a void pointer for the digest256map_free.
Definition at line 717 of file conflux_pool.c.
Referenced by conflux_pool_free_all().
◆ get_client_ux()
|
static |
Return the currently configured client UX.
Definition at line 1077 of file conflux_pool.c.
Referenced by conflux_launch_leg().
◆ get_exit_for_nonce()
|
static |
On the client side, we need to determine if there is already an exit in use for this set, and if so, use that.
Otherwise, we return NULL and the exit is decided by the circuitbuild.c code.
Definition at line 1035 of file conflux_pool.c.
Referenced by conflux_launch_leg().
◆ launch_leg_is_allowed()
|
static |
Return true iff the given conflux object is allowed to launch a new leg. If the cfx object is NULL, then it is always allowed to launch a new leg.
Definition at line 1094 of file conflux_pool.c.
Referenced by conflux_launch_leg().
◆ launch_new_set()
| STATIC bool launch_new_set | ( | int | num_legs | ) |
Launch a brand new set.
Return true if all legs successfully launched or false if one failed.
Definition at line 978 of file conflux_pool.c.
Referenced by conflux_predict_new().
◆ leg_find()
|
inlinestatic |
Return an unlinked leg for the given unlinked object and for the given circuit.
Definition at line 371 of file conflux_pool.c.
Referenced by link_circuit(), and unlinked_leg_find().
◆ leg_free()
|
static |
Free the given leg object. Passing NULL is safe.
Definition at line 231 of file conflux_pool.c.
Referenced by try_finalize_set(), and unlinked_free().
◆ leg_new()
|
static |
Return a newly allocated leg object containing the given circuit and link pointer (no copy).
Definition at line 221 of file conflux_pool.c.
Referenced by conflux_launch_leg(), and conflux_process_link().
◆ link_circuit()
|
static |
Link the given circuit within its unlinked set. This is called when either the LINKED or LINKED_ACK is received depending on which side of the circuit it is.
It attempts to finalize the unlinked set as well which, if successful, puts it in the linked pool.
Definition at line 933 of file conflux_pool.c.
Referenced by conflux_process_link(), and conflux_process_linked().
◆ linked_circuit_closed()
|
static |
The given circuit is already linked to a set and has been closed. Remove it from the set and free the pool if no more legs.
Definition at line 1577 of file conflux_pool.c.
Referenced by conflux_circuit_has_closed().
◆ linked_circuit_free()
|
static |
The given circuit is being freed and it is a linked leg. Clean up and free anything that has to do with this circuit.
After this call, the circuit should NOT be referenced anymore anywhere.
Definition at line 1640 of file conflux_pool.c.
Referenced by conflux_circuit_about_to_free().
◆ linked_nullify_streams()
|
static |
Nullify all streams of the given circuit.
Definition at line 1559 of file conflux_pool.c.
Referenced by linked_circuit_closed(), and linked_circuit_free().
◆ linked_pool_add()
|
static |
Add the given conflux object to the linked conflux set.
Definition at line 324 of file conflux_pool.c.
Referenced by try_finalize_set().
◆ linked_pool_del()
|
static |
Delete from the linked conflux set the given nonce.
Definition at line 336 of file conflux_pool.c.
Referenced by linked_circuit_closed(), and linked_circuit_free().
◆ linked_pool_get()
|
static |
Return a conflux_t object for the given nonce from the linked set.
Definition at line 348 of file conflux_pool.c.
Referenced by conflux_add_guards_to_exclude_list(), conflux_add_middles_to_exclude_list(), conflux_mark_all_for_close(), and get_exit_for_nonce().
◆ linked_update_stream_backpointers()
|
static |
Update all stream pointers to point to this circuit. This is used when a linked circuit is closed and we need to update the streams to point to the remaining circuit
Definition at line 1525 of file conflux_pool.c.
Referenced by linked_circuit_closed().
◆ record_rtt()
|
static |
For the given circuit, record the RTT from when the LINK or LINKED cell was sent that is this function works for either client or Exit.
Return false if the RTT is too high for our standard else true.
Definition at line 901 of file conflux_pool.c.
Referenced by conflux_process_linked(), and conflux_process_linked_ack().
◆ record_rtt_client()
|
static |
Record the RTT for this client circuit.
Return the RTT value. UINT64_MAX is returned if we couldn't find the initial measurement of when the cell was sent or if the leg is missing.
Definition at line 827 of file conflux_pool.c.
Referenced by record_rtt().
◆ record_rtt_exit()
|
static |
Record the RTT for this Exit circuit.
Return the RTT value. UINT64_MAX is returned if we couldn't find the initial measurement of when the cell was sent or if the leg is missing.
Definition at line 866 of file conflux_pool.c.
Referenced by record_rtt().
◆ try_finalize_set()
|
static |
Attempt to finalize the unlinked set to become a linked set and be put in the linked pool.
If this finalized successfully, the given unlinked object is freed.
Definition at line 728 of file conflux_pool.c.
Referenced by link_circuit().
◆ unlinked_circuit_closed()
|
static |
The given circuit is conflux pending and has closed. This deletes the leg from the set, attempt to finalize it and relaunch a new leg. If the set is empty after removing this leg, it is deleted.
Definition at line 1467 of file conflux_pool.c.
Referenced by conflux_circuit_has_closed().
◆ unlinked_circuit_free()
|
static |
The given circuit is being freed and it is an unlinked leg. Clean up and free anything that has to do with this circuit.
After this call, the circuit should NOT be referenced anymore anywhere.
Definition at line 1707 of file conflux_pool.c.
Referenced by conflux_circuit_about_to_free().
◆ unlinked_close_all_legs()
|
static |
Close the circuit of each legs of the given unlinked object.
Definition at line 614 of file conflux_pool.c.
Referenced by unlinked_close_or_free().
◆ unlinked_close_or_free()
|
static |
Either closee all legs of the given unlinked set or delete it from the pool and free its memory.
Important: The unlinked object is freed opportunistically when legs are removed until the point none remains. And so, it is only safe to free the object if no more legs exist.
Definition at line 657 of file conflux_pool.c.
Referenced by conflux_mark_all_for_close().
◆ unlinked_free()
|
static |
Free the given unlinked object.
Definition at line 260 of file conflux_pool.c.
Referenced by try_finalize_set(), and unlinked_pool_del_and_free().
◆ unlinked_get_or_create()
|
static |
Definition at line 1001 of file conflux_pool.c.
◆ unlinked_leg_add()
|
inlinestatic |
Add the given leg to the given unlinked object.
Definition at line 360 of file conflux_pool.c.
Referenced by conflux_launch_leg(), and conflux_process_link().
◆ unlinked_leg_del_and_free()
|
static |
Definition at line 394 of file conflux_pool.c.
◆ unlinked_leg_find()
Return the given circuit leg from its unlinked set (if any).
Definition at line 383 of file conflux_pool.c.
Referenced by conflux_circuit_has_opened(), conflux_process_linked(), record_rtt_client(), and unlinked_circuit_free().
◆ unlinked_new()
|
static |
Return a newly allocated unlinked set object for the given nonce. A new conflux object is also created.
Definition at line 247 of file conflux_pool.c.
◆ unlinked_pool_add()
|
static |
Add the given unlinked object to the unlinked pool.
Definition at line 278 of file conflux_pool.c.
◆ unlinked_pool_del()
|
static |
Delete the given unlinked object from the unlinked pool.
Definition at line 290 of file conflux_pool.c.
Referenced by try_finalize_set(), and unlinked_pool_del_and_free().
◆ unlinked_pool_del_and_free()
|
static |
Delete from the pool and free the given unlinked object.
Definition at line 315 of file conflux_pool.c.
Referenced by free_unlinked_void_(), unlinked_circuit_closed(), and unlinked_close_or_free().
◆ unlinked_pool_get()
|
static |
Return an unlinked object for the given nonce else NULL.
Definition at line 303 of file conflux_pool.c.
Referenced by conflux_add_guards_to_exclude_list(), conflux_add_middles_to_exclude_list(), conflux_log_set(), conflux_mark_all_for_close(), get_exit_for_nonce(), link_circuit(), linked_circuit_free(), unlinked_circuit_closed(), and unlinked_leg_find().
◆ validate_circ_has_no_streams()
|
static |
Ensure that the given circuit has no attached streams.
This validation function is called at various stages for unlinked circuits, to make sure they have no streams.
Definition at line 416 of file conflux_pool.c.
Referenced by cfx_add_leg(), conflux_circuit_has_opened(), unlinked_circuit_closed(), and validate_unlinked_legs().
◆ validate_unlinked_legs()
|
static |
Return true iff the legs in the given unlinked set are valid and coherent to be a linked set.
Definition at line 450 of file conflux_pool.c.
Referenced by try_finalize_set().
Variable Documentation
◆ client_linked_pool
|
static |
The pool of client-side conflux_t that are built, linked, and ready to be used. Indexed by nonce.
Definition at line 50 of file conflux_pool.c.
Referenced by conflux_get_circ_for_conn(), conflux_pool_free_all(), conflux_pool_init(), conflux_predict_new(), count_client_usable_sets(), linked_pool_add(), linked_pool_del(), and linked_pool_get().
◆ client_unlinked_pool
|
static |
The pool of origin unlinked_circuits_t indexed by nonce.
Definition at line 53 of file conflux_pool.c.
Referenced by conflux_pool_free_all(), conflux_pool_init(), conflux_predict_new(), unlinked_pool_add(), unlinked_pool_del(), and unlinked_pool_get().
◆ DEFAULT_CLIENT_UX
| STATIC uint8_t DEFAULT_CLIENT_UX = CONFLUX_UX_HIGH_THROUGHPUT |
Definition at line 136 of file conflux_pool.c.
◆ DEFAULT_EXIT_UX
| STATIC uint8_t DEFAULT_EXIT_UX = CONFLUX_UX_MIN_LATENCY |
Definition at line 137 of file conflux_pool.c.
◆ server_linked_pool
|
static |
The pool of relay conflux_t indexed by nonce. We call these "server" because they could be onion-service side too (even though we likely will only implement onion service conflux in Arti). The code is littered with asserts to ensure there are no origin circuits in here for now, too.
Definition at line 59 of file conflux_pool.c.
Referenced by conflux_pool_free_all(), conflux_pool_init(), linked_pool_add(), linked_pool_del(), and linked_pool_get().
◆ server_unlinked_pool
|
static |
The pool of relay unlinked_circuits_t indexed by nonce.
Definition at line 62 of file conflux_pool.c.
Referenced by conflux_pool_free_all(), conflux_pool_init(), unlinked_pool_add(), unlinked_pool_del(), and unlinked_pool_get().
◆ shutting_down
|
static |
Definition at line 46 of file conflux_pool.c.
Generated by
1.12.0