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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
//! tio proxy
//!
//! Multiplexes access to a sensor, exposing the functionality of tio::proxy
//! via TCP.
use crate::ProxyCli;
use std::io;
use std::net::TcpListener;
use std::time::Duration;
use tio::{proto, proxy};
use twinleaf::device::discovery::{self, PortInterface};
use twinleaf::tio;
macro_rules! log{
($tf:expr, $msg:expr)=>{
{
println!("{}{}", chrono::Local::now().format(&$tf), $msg);
}
};
($tf:expr, $f:expr,$($a:tt)*)=>{
{
log!($tf, format!($f, $($a)*));
}
};
}
fn create_listener_thread(
addr: std::net::SocketAddr,
client_send: crossbeam::channel::Sender<std::net::TcpStream>,
) -> io::Result<()> {
let listener = TcpListener::bind(addr)?;
std::thread::Builder::new()
.name("listener".to_string())
.spawn(move || {
for res in listener.incoming() {
match res {
Ok(stream) => client_send.send(stream).expect("New client queue full"),
Err(err) => eprintln!("error accepting client: {}", err),
};
}
})?;
Ok(())
}
pub fn run_proxy(proxy_cli: ProxyCli) -> eyre::Result<()> {
use color_eyre::{Help, SectionExt};
use eyre::bail;
// Handle --enum mode (deprecated; now delegates to `tio list`)
if proxy_cli.enumerate {
return crate::tools::list::list_devices_deprecated(true);
}
if proxy_cli.auto {
eprintln!(
"warning: '--auto' is deprecated; running without -s <url> now auto-detects by default"
);
}
let tcp_port = proxy_cli.port;
let reconnect_timeout = Duration::from_secs(proxy_cli.reconnect_timeout);
let disconnect_slow = proxy_cli.kick_slow;
let verbose = proxy_cli.verbose;
let debugging = proxy_cli.debug;
let dump_traffic = proxy_cli.dump;
let dump_data = proxy_cli.dump_data;
let dump_meta = proxy_cli.dump_meta;
let dump_hb = proxy_cli.dump_hb;
let tf = proxy_cli.timestamp_format;
// Determine sensor URL; if none given, auto-detect.
let auto_detected = proxy_cli.sensor_url.is_none();
let sensor_url = if let Some(url) = proxy_cli.sensor_url {
url
} else {
// --auto mode
let devices = discovery::enumerate_serial(false);
let mut valid_urls = Vec::new();
for dev in devices {
match dev.interface {
PortInterface::STM32 | PortInterface::FTDI => {
valid_urls.push(dev.url.clone());
}
_ => {}
}
}
if valid_urls.len() == 0 {
return Err(eyre::eyre!("no sensors detected")
.suggestion("specify a URL with -s <url>, or run 'tio list'"));
}
if valid_urls.len() > 1 {
eprintln!("multiple sensors detected:");
let query_timeout = Duration::from_millis(500);
for url in &valid_urls {
match discovery::query_name(url, query_timeout) {
Some(name) => eprintln!(" {} {}", url, name),
None => eprintln!(" {} (no response)", url),
}
}
return Err(eyre::eyre!("multiple sensors detected, cannot auto-select")
.suggestion("specify one with -s <url>"));
}
valid_urls[0].clone()
};
let subtree = proxy_cli.subtree;
println!("tio proxy starting:");
println!(
" Sensor: {} {}",
sensor_url,
if auto_detected { "(auto-detected)" } else { "" }
);
println!(" TCP port: {}", tcp_port);
println!(" Subtree: {}", subtree);
if verbose || debugging || dump_traffic || dump_data || dump_meta || dump_hb {
print!(" Flags:");
if verbose {
print!(" verbose");
}
if debugging {
print!(" debug");
}
if disconnect_slow {
print!(" kick-slow");
}
if dump_traffic {
print!(" dump");
}
if dump_data {
print!(" dump-data");
}
if dump_meta {
print!(" dump-meta");
}
if dump_hb {
print!(" dump-hb");
}
println!();
}
println!();
let new_client = {
let (client_send, new_client) = crossbeam::channel::bounded::<std::net::TcpStream>(10);
let started_v6 = create_listener_thread(
std::net::SocketAddr::new(
std::net::IpAddr::V6(std::net::Ipv6Addr::UNSPECIFIED),
tcp_port,
),
client_send.clone(),
);
let started_v4 = if let (Ok(()), false) = (&started_v6, cfg!(windows)) {
// If v6 started correctly and we are not in windows, pretend
// v4 also started correctly. The OS will pass the new clients
// through the v6 socket.
Ok(())
} else {
create_listener_thread(
std::net::SocketAddr::new(
std::net::IpAddr::V4(std::net::Ipv4Addr::UNSPECIFIED),
tcp_port,
),
client_send.clone(),
)
};
if let (Err(e1), Err(e2)) = (started_v6, started_v4) {
let addr_in_use = matches!(e1.kind(), io::ErrorKind::AddrInUse)
|| matches!(e2.kind(), io::ErrorKind::AddrInUse);
let err = eyre::eyre!("could not bind TCP port {}: v6={}, v4={}", tcp_port, e1, e2);
return Err(if addr_in_use {
err.suggestion(format!(
"another 'tio proxy' is likely running on port {}; try --port <N>",
tcp_port
))
} else {
err
});
}
new_client
};
let (status_send, port_status) = crossbeam::channel::bounded::<proxy::Event>(100);
let proxy =
proxy::Interface::new_proxy(&sensor_url, Some(reconnect_timeout), Some(status_send));
// This is used by the proxy itself to communicate with the device tree.
// for now only used to receive log messages and dump traffic.
let proxy_port = match proxy.subtree_full(subtree.clone()) {
Ok(port) => port,
Err(e) => {
let last_status = port_status.iter().last();
let err =
eyre::Report::new(e).wrap_err(format!("could not open port on {}", sensor_url));
return Err(if let Some(status) = last_status {
err.with_section(move || format!("{:?}", status).header("Last proxy event:"))
} else {
err
});
}
};
use crossbeam::select;
loop {
select! {
recv(new_client) -> tcp_client => {
if let Ok(stream) = tcp_client {
let addr = match stream.peer_addr() {
Ok(addr) => addr.to_string(),
Err(err) => {
log!(tf, "Failed to determine client address: {:?}", err);
continue;
}
};
// A client from the proxy perspective is a port in reverse, i.e. what it receives
// is what a client transmits, and vice-versa. Therefore, the channel size settings
// for rx and tx are inverted. Also, we use the proxy port channel size setting
// instead of the physical ports setting.
let (rx_send, client_rx) = tio::port::Port::rx_channel_custom(proxy::Interface::get_client_tx_channel_size());
let client = match tio::port::Port::from_tcp_stream_custom(stream, tio::port::Port::rx_to_channel(rx_send), proxy::Interface::get_client_rx_channel_size()) {
Ok(client_port) => client_port,
_ => continue,
};
if verbose {
log!(tf, "Accepted client from {}", addr);
}
let port = proxy.new_port(Some(Duration::from_millis(2000)), subtree.clone(), usize::MAX, true, true).expect("Failed to create new proxy port");
let tf = tf.clone();
std::thread::spawn(move || {
let mut is_slow = false;
let mut dropped: usize = 0;
loop {
select! {
recv(port.receiver()) -> res => {
let pkt = if let Ok(pkt) = res { pkt } else {
log!(tf, "Disconnecting client {} due to internal error receiving tio data in thread", addr);
break;
};
if dump_traffic {
if match pkt.payload {
proto::Payload::RpcRequest(_) | proto::Payload::RpcReply(_) | proto::Payload::RpcError(_) => true,
_ => false,
} {
log!(tf, "{}->{} -- {:?}", pkt.routing, addr, pkt.payload);
}
}
match client.try_send(pkt) {
Err(tio::SendError::Full) => {
if disconnect_slow {
log!(tf, "Disconnecting client {} due to slowness", addr);
break;
} else if verbose {
if !is_slow {
is_slow = true;
log!(tf, "Client {} is not keeping up and is dropping packets", addr);
}
dropped += 1;
}
}
Ok(()) => {
if verbose && is_slow {
log!(tf, "Client {} resuming after having dropped {} packets", addr, dropped);
is_slow = false;
dropped = 0;
}
}
_ => {
if verbose {
log!(tf, "Client {} exiting", addr);
}
break;
}
}
}
recv(client_rx) -> res => {
match res {
Ok(Ok(pkt)) => {
if dump_traffic {
log!(tf, "{}->{} -- {:?}", addr, pkt.routing, pkt.payload);
}
if let Err(_) = port.try_send(pkt) {
log!(tf, "Disconnecting client {} due to internal error forwarding tio data in thread", addr);
break;
}
}
_ => {
if verbose {
log!(tf, "Client {} exiting", addr);
}
break;
}
}
}
}
}
});
} else {
bail!("listener thread died unexpectedly");
}
}
recv(port_status) -> status => {
if let Ok(evt) = status {
match evt {
proxy::Event::SensorDisconnected => {
log!(tf, "Sensor disconnected");
}
proxy::Event::SensorReconnected => {
log!(tf, "Sensor reconnected");
}
proxy::Event::FailedToReconnect => {
log!(tf, "Stopping reconnection attempts due to timeout");
}
proxy::Event::FailedToConnect => {
log!(tf, "Fatal proxy error: failed to connect to sensor");
}
proxy::Event::FatalError(err) => {
log!(tf, "Fatal proxy error: {:?}", err);
// the proxy thread will exit and we'll detect it at the next iteration.
}
proxy::Event::ProtocolError(perr) => {
match perr {
proto::Error::Text(txt) => {
log!(tf, "Text: {}", txt);
}
other => {
if verbose || debugging {
log!(tf, "Protocol error: {:?}", other);
}
}
}
}
evt => {
if debugging {
log!(tf, "Proxy event: {:?}", evt)
}
}
}
} else {
// The proxy thread died, most likely due to the sensor
// getting disconnected past the autoreconnection
break;
}
}
recv(proxy_port.receiver()) -> pkt_or_err => {
if let Ok(pkt) = pkt_or_err {
let dump = match pkt.payload {
proto::Payload::Heartbeat(_) => dump_hb,
proto::Payload::Metadata(_) => dump_meta,
proto::Payload::StreamData(_) => dump_data,
_ => dump_traffic
};
if dump {
log!(tf, "Packet from {} -- {:?}", pkt.routing, pkt.payload);
}
if let proto::Payload::LogMessage(log) = pkt.payload {
log!(tf, "{} {:?}: {}", pkt.routing, log.level, log.message);
}
}
}
}
}
Ok(())
}