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
use super::{
ingress::{Message, Messenger},
Config,
};
use crate::{
authenticated::{
data::EncodedData,
discovery::{channels::Channels, metrics},
relay::Relay,
Mailbox,
},
Recipients,
};
use commonware_cryptography::PublicKey;
use commonware_macros::select_loop;
use commonware_runtime::{spawn_cell, BufferPooler, ContextCell, Handle, Metrics, Spawner};
use commonware_utils::{
channel::{mpsc, ring},
NZUsize,
};
use futures::SinkExt;
use prometheus_client::metrics::{counter::Counter, family::Family};
use std::collections::BTreeMap;
use tracing::debug;
/// Router actor that manages peer connections and routing messages.
pub struct Actor<E: Spawner + BufferPooler + Metrics, P: PublicKey> {
context: ContextCell<E>,
control: mpsc::Receiver<Message<P>>,
connections: BTreeMap<P, Relay<EncodedData>>,
open_subscriptions: Vec<ring::Sender<Vec<P>>>,
messages_dropped: Family<metrics::Message, Counter>,
}
impl<E: Spawner + BufferPooler + Metrics, P: PublicKey> Actor<E, P> {
/// Returns a new [Actor] along with a [Mailbox] and [Messenger]
/// that can be used to send messages to the router.
pub fn new(context: E, cfg: Config) -> (Self, Mailbox<Message<P>>, Messenger<P>) {
// Create mailbox
let (control_sender, control_receiver) = Mailbox::new(cfg.mailbox_size);
let pool = context.network_buffer_pool().clone();
// Create metrics
let messages_dropped = Family::<metrics::Message, Counter>::default();
context.register(
"messages_dropped",
"messages dropped",
messages_dropped.clone(),
);
// Create actor
(
Self {
context: ContextCell::new(context),
control: control_receiver,
connections: BTreeMap::new(),
open_subscriptions: Vec::new(),
messages_dropped,
},
control_sender.clone(),
Messenger::new(pool, control_sender),
)
}
/// Sends pre-encoded data to the given `recipient`.
fn send(&mut self, recipient: P, encoded: EncodedData, priority: bool, sent: &mut Vec<P>) {
let channel = encoded.channel;
if let Some(relay) = self.connections.get_mut(&recipient) {
if relay.send(encoded, priority).is_ok() {
sent.push(recipient);
} else {
self.messages_dropped
.get_or_create(&metrics::Message::new_data(&recipient, channel))
.inc();
}
} else {
self.messages_dropped
.get_or_create(&metrics::Message::new_data(&recipient, channel))
.inc();
}
}
/// Starts a new task that runs the router [Actor].
/// Returns a [Handle] that can be used to await the completion of the task,
/// which will run until its `control` receiver is closed.
pub fn start(mut self, routing: Channels<P>) -> Handle<()> {
spawn_cell!(self.context, self.run(routing).await)
}
/// Runs the [Actor] event loop, processing incoming messages control messages
/// ([Message::Ready], [Message::Release]) and content messages ([Message::Content]).
/// Returns when the `control` channel is closed.
async fn run(mut self, routing: Channels<P>) {
select_loop! {
self.context,
on_stopped => {
debug!("context shutdown, stopping router");
},
Some(msg) = self.control.recv() else {
debug!("mailbox closed, stopping router");
break;
} => {
match msg {
Message::Ready {
peer,
relay,
channels,
} => {
debug!(?peer, "peer ready");
self.connections.insert(peer, relay);
let _ = channels.send(routing.clone());
self.notify_subscribers().await;
}
Message::Release { peer } => {
debug!(?peer, "peer released");
self.connections.remove(&peer);
self.notify_subscribers().await;
}
Message::Content {
recipients,
encoded,
priority,
success,
} => {
let mut sent = Vec::new();
let channel = encoded.channel;
match recipients {
Recipients::One(recipient) => {
self.send(recipient, encoded, priority, &mut sent);
}
Recipients::Some(recipients) => {
for recipient in recipients {
self.send(recipient, encoded.clone(), priority, &mut sent);
}
}
Recipients::All => {
// Send to all connected peers
for (recipient, relay) in self.connections.iter_mut() {
if relay.send(encoded.clone(), priority).is_ok() {
sent.push(recipient.clone());
} else {
self.messages_dropped
.get_or_create(&metrics::Message::new_data(
recipient, channel,
))
.inc();
}
}
}
}
// Communicate success back to sender (if still alive)
let _ = success.send(sent);
}
Message::SubscribePeers { response } => {
let (mut sender, receiver) = ring::channel::<Vec<P>>(NZUsize!(1));
// Send existing peers immediately
let peers = self.connections.keys().cloned().collect();
let _ = sender.send(peers).await;
self.open_subscriptions.push(sender);
let _ = response.send(receiver);
}
}
},
}
}
/// Notifies all open peer subscriptions with the current list of connected peers.
async fn notify_subscribers(&mut self) {
let peers: Vec<P> = self.connections.keys().cloned().collect();
let mut keep = Vec::with_capacity(self.open_subscriptions.len());
for mut subscriber in self.open_subscriptions.drain(..) {
if subscriber.send(peers.clone()).await.is_ok() {
keep.push(subscriber);
}
}
self.open_subscriptions = keep;
}
}