1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
//! Experimental RPC support.
use anyhow::Result;
use arti_rpcserver::RpcMgr;
use futures::task::SpawnExt;
use session::ArtiRpcSession;
use std::{path::Path, sync::Arc};
use arti_client::TorClient;
use tor_rtcompat::Runtime;
pub(crate) mod conntarget;
mod proxyinfo;
mod session;
pub(crate) use session::{RpcStateSender, RpcVisibleArtiState};
cfg_if::cfg_if! {
if #[cfg(all(feature="tokio", not(target_os="windows")))] {
use tokio_crate::net::UnixListener ;
use tokio_util::compat::{TokioAsyncReadCompatExt, TokioAsyncWriteCompatExt};
} else if #[cfg(all(feature="async-std", not(target_os="windows")))] {
use async_std::os::unix::net::UnixListener;
} else if #[cfg(target_os="windows")] {
compile_error!("Sorry, no windows support for RPC yet.");
// TODO RPC: Tokio has a named pipe API; AsyncStd should let us construct
// one via FromRawHandle.
} else {
compile_error!("You need to have tokio or async-std.");
}
}
/// Run an RPC listener task to accept incoming connections at the Unix
/// socket address of `path`.
pub(crate) fn launch_rpc_listener<R: Runtime>(
runtime: &R,
path: impl AsRef<Path>,
client: TorClient<R>,
rpc_state: Arc<RpcVisibleArtiState>,
) -> Result<Arc<RpcMgr>> {
// TODO RPC: there should be an error return instead.
// TODO RPC: Maybe the UnixListener functionality belongs in tor-rtcompat?
// But I certainly don't want to make breaking changes there if we can help
// it.
let listener = UnixListener::bind(path)?;
let rpc_mgr = RpcMgr::new(move |auth| ArtiRpcSession::new(auth, &client, &rpc_state))?;
// Register methods. Needed since TorClient is generic.
//
// TODO: If we accumulate a large number of generics like this, we should do this elsewhere.
rpc_mgr.register_rpc_methods(TorClient::<R>::rpc_methods());
rpc_mgr.register_rpc_methods(arti_rpcserver::rpc_methods::<R>());
let rt_clone = runtime.clone();
let rpc_mgr_clone = rpc_mgr.clone();
// TODO: Using spawn in this way makes it hard to report whether we
// succeeded or not. This is something we should fix when we refactor
// our service-launching code.
runtime.spawn(async {
let result = run_rpc_listener(rt_clone, listener, rpc_mgr_clone).await;
if let Err(e) = result {
tracing::warn!("RPC manager quit with an error: {}", e);
}
})?;
Ok(rpc_mgr)
}
/// Backend function to implement an RPC listener: runs in a loop.
async fn run_rpc_listener<R: Runtime>(
runtime: R,
listener: UnixListener,
rpc_mgr: Arc<RpcMgr>,
) -> Result<()> {
loop {
let (stream, _addr) = listener.accept().await?;
// TODO RPC: Perhaps we should have rpcmgr hold the client reference?
let connection = rpc_mgr.new_connection();
let (input, output) = stream.into_split();
#[cfg(feature = "tokio")]
let (input, output) = (input.compat(), output.compat_write());
runtime.spawn(async {
let result = connection.run(input, output).await;
if let Err(e) = result {
tracing::warn!("RPC session ended with an error: {}", e);
}
})?;
}
}
#[cfg(test)]
mod test {
// @@ begin test lint list maintained by maint/add_warning @@
#![allow(clippy::bool_assert_comparison)]
#![allow(clippy::clone_on_copy)]
#![allow(clippy::dbg_macro)]
#![allow(clippy::mixed_attributes_style)]
#![allow(clippy::print_stderr)]
#![allow(clippy::print_stdout)]
#![allow(clippy::single_char_pattern)]
#![allow(clippy::unwrap_used)]
#![allow(clippy::unchecked_duration_subtraction)]
#![allow(clippy::useless_vec)]
#![allow(clippy::needless_pass_by_value)]
//! <!-- @@ end test lint list maintained by maint/add_warning @@ -->
#[test]
fn rpc_method_names() {
// We run this from a nice high level module, to ensure that as many method names as
// possible will be in-scope.
let problems = tor_rpcbase::check_method_names([]);
for (m, err) in &problems {
eprintln!("Bad method name {m:?}: {err}");
}
assert!(problems.is_empty());
}
}
|
