Line data Source code
1 : use std::{
2 : cmp::Ordering,
3 : collections::{BinaryHeap, VecDeque},
4 : fmt::{self, Debug},
5 : ops::DerefMut,
6 : sync::{mpsc, Arc},
7 : };
8 :
9 : use parking_lot::{
10 : lock_api::{MappedMutexGuard, MutexGuard},
11 : Mutex, RawMutex,
12 : };
13 : use rand::rngs::StdRng;
14 : use tracing::debug;
15 :
16 : use crate::{
17 : executor::{self, ThreadContext},
18 : options::NetworkOptions,
19 : proto::NetEvent,
20 : proto::NodeEvent,
21 : };
22 :
23 : use super::{chan::Chan, proto::AnyMessage};
24 :
25 : pub struct NetworkTask {
26 : options: Arc<NetworkOptions>,
27 : connections: Mutex<Vec<VirtualConnection>>,
28 : /// min-heap of connections having something to deliver.
29 : events: Mutex<BinaryHeap<Event>>,
30 : task_context: Arc<ThreadContext>,
31 : }
32 :
33 : impl NetworkTask {
34 2028 : pub fn start_new(options: Arc<NetworkOptions>, tx: mpsc::Sender<Arc<NetworkTask>>) {
35 2028 : let ctx = executor::get_thread_ctx();
36 2028 : let task = Arc::new(Self {
37 2028 : options,
38 2028 : connections: Mutex::new(Vec::new()),
39 2028 : events: Mutex::new(BinaryHeap::new()),
40 2028 : task_context: ctx,
41 2028 : });
42 2028 :
43 2028 : // send the task upstream
44 2028 : tx.send(task.clone()).unwrap();
45 2028 :
46 2028 : // start the task
47 2028 : task.start();
48 2028 : }
49 :
50 137836 : pub fn start_new_connection(self: &Arc<Self>, rng: StdRng, dst_accept: Chan<NodeEvent>) -> TCP {
51 137836 : let now = executor::now();
52 137836 : let connection_id = self.connections.lock().len();
53 137836 :
54 137836 : let vc = VirtualConnection {
55 137836 : connection_id,
56 137836 : dst_accept,
57 137836 : dst_sockets: [Chan::new(), Chan::new()],
58 137836 : state: Mutex::new(ConnectionState {
59 137836 : buffers: [NetworkBuffer::new(None), NetworkBuffer::new(Some(now))],
60 137836 : rng,
61 137836 : }),
62 137836 : };
63 137836 : vc.schedule_timeout(self);
64 137836 : vc.send_connect(self);
65 137836 :
66 137836 : let recv_chan = vc.dst_sockets[0].clone();
67 137836 : self.connections.lock().push(vc);
68 137836 :
69 137836 : TCP {
70 137836 : net: self.clone(),
71 137836 : conn_id: connection_id,
72 137836 : dir: 0,
73 137836 : recv_chan,
74 137836 : }
75 137836 : }
76 : }
77 :
78 : // private functions
79 : impl NetworkTask {
80 : /// Schedule to wakeup network task (self) `after_ms` later to deliver
81 : /// messages of connection `id`.
82 702948 : fn schedule(&self, id: usize, after_ms: u64) {
83 702948 : self.events.lock().push(Event {
84 702948 : time: executor::now() + after_ms,
85 702948 : conn_id: id,
86 702948 : });
87 702948 : self.task_context.schedule_wakeup(after_ms);
88 702948 : }
89 :
90 : /// Get locked connection `id`.
91 938695 : fn get(&self, id: usize) -> MappedMutexGuard<'_, RawMutex, VirtualConnection> {
92 938695 : MutexGuard::map(self.connections.lock(), |connections| {
93 938695 : connections.get_mut(id).unwrap()
94 938695 : })
95 938695 : }
96 :
97 661850 : fn collect_pending_events(&self, now: u64, vec: &mut Vec<Event>) {
98 661850 : vec.clear();
99 661850 : let mut events = self.events.lock();
100 1321673 : while let Some(event) = events.peek() {
101 1312624 : if event.time > now {
102 652801 : break;
103 659823 : }
104 659823 : let event = events.pop().unwrap();
105 659823 : vec.push(event);
106 : }
107 661850 : }
108 :
109 2028 : fn start(self: &Arc<Self>) {
110 2028 : debug!("started network task");
111 :
112 2028 : let mut events = Vec::new();
113 : loop {
114 663878 : let now = executor::now();
115 663878 : self.collect_pending_events(now, &mut events);
116 :
117 663878 : for event in events.drain(..) {
118 659823 : let conn = self.get(event.conn_id);
119 659823 : conn.process(self);
120 659823 : }
121 :
122 : // block until wakeup
123 661850 : executor::yield_me(-1);
124 : }
125 : }
126 : }
127 :
128 : // 0 - from node(0) to node(1)
129 : // 1 - from node(1) to node(0)
130 : type MessageDirection = u8;
131 :
132 1285 : fn sender_str(dir: MessageDirection) -> &'static str {
133 1285 : match dir {
134 211 : 0 => "client",
135 1074 : 1 => "server",
136 0 : _ => unreachable!(),
137 : }
138 1285 : }
139 :
140 347 : fn receiver_str(dir: MessageDirection) -> &'static str {
141 347 : match dir {
142 158 : 0 => "server",
143 189 : 1 => "client",
144 0 : _ => unreachable!(),
145 : }
146 347 : }
147 :
148 : /// Virtual connection between two nodes.
149 : /// Node 0 is the creator of the connection (client),
150 : /// and node 1 is the acceptor (server).
151 : struct VirtualConnection {
152 : connection_id: usize,
153 : /// one-off chan, used to deliver Accept message to dst
154 : dst_accept: Chan<NodeEvent>,
155 : /// message sinks
156 : dst_sockets: [Chan<NetEvent>; 2],
157 : state: Mutex<ConnectionState>,
158 : }
159 :
160 : struct ConnectionState {
161 : buffers: [NetworkBuffer; 2],
162 : rng: StdRng,
163 : }
164 :
165 : impl VirtualConnection {
166 : /// Notify the future about the possible timeout.
167 404307 : fn schedule_timeout(&self, net: &NetworkTask) {
168 404307 : if let Some(timeout) = net.options.keepalive_timeout {
169 404307 : net.schedule(self.connection_id, timeout);
170 404307 : }
171 404307 : }
172 :
173 : /// Send the handshake (Accept) to the server.
174 137836 : fn send_connect(&self, net: &NetworkTask) {
175 137836 : let now = executor::now();
176 137836 : let mut state = self.state.lock();
177 137836 : let delay = net.options.connect_delay.delay(&mut state.rng);
178 137836 : let buffer = &mut state.buffers[0];
179 137836 : assert!(buffer.buf.is_empty());
180 137836 : assert!(!buffer.recv_closed);
181 137836 : assert!(!buffer.send_closed);
182 137836 : assert!(buffer.last_recv.is_none());
183 :
184 137836 : let delay = if let Some(ms) = delay {
185 107042 : ms
186 : } else {
187 30794 : debug!("NET: TCP #{} dropped connect", self.connection_id);
188 30794 : buffer.send_closed = true;
189 30794 : return;
190 : };
191 :
192 : // Send a message into the future.
193 107042 : buffer
194 107042 : .buf
195 107042 : .push_back((now + delay, AnyMessage::InternalConnect));
196 107042 : net.schedule(self.connection_id, delay);
197 137836 : }
198 :
199 : /// Transmit some of the messages from the buffer to the nodes.
200 659823 : fn process(&self, net: &Arc<NetworkTask>) {
201 659823 : let now = executor::now();
202 659823 :
203 659823 : let mut state = self.state.lock();
204 :
205 1979469 : for direction in 0..2 {
206 1319646 : self.process_direction(
207 1319646 : net,
208 1319646 : state.deref_mut(),
209 1319646 : now,
210 1319646 : direction as MessageDirection,
211 1319646 : &self.dst_sockets[direction ^ 1],
212 1319646 : );
213 1319646 : }
214 :
215 : // Close the one side of the connection by timeout if the node
216 : // has not received any messages for a long time.
217 659823 : if let Some(timeout) = net.options.keepalive_timeout {
218 659823 : let mut to_close = [false, false];
219 1979469 : for direction in 0..2 {
220 1319646 : let buffer = &mut state.buffers[direction];
221 1319646 : if buffer.recv_closed {
222 276258 : continue;
223 1043388 : }
224 1043388 : if let Some(last_recv) = buffer.last_recv {
225 943422 : if now - last_recv >= timeout {
226 205762 : debug!(
227 0 : "NET: connection {} timed out at {}",
228 0 : self.connection_id,
229 0 : receiver_str(direction as MessageDirection)
230 : );
231 205762 : let node_idx = direction ^ 1;
232 205762 : to_close[node_idx] = true;
233 737660 : }
234 99966 : }
235 : }
236 659823 : drop(state);
237 :
238 1319646 : for (node_idx, should_close) in to_close.iter().enumerate() {
239 1319646 : if *should_close {
240 205762 : self.close(node_idx);
241 1113884 : }
242 : }
243 0 : }
244 659823 : }
245 :
246 : /// Process messages in the buffer in the given direction.
247 1319646 : fn process_direction(
248 1319646 : &self,
249 1319646 : net: &Arc<NetworkTask>,
250 1319646 : state: &mut ConnectionState,
251 1319646 : now: u64,
252 1319646 : direction: MessageDirection,
253 1319646 : to_socket: &Chan<NetEvent>,
254 1319646 : ) {
255 1319646 : let buffer = &mut state.buffers[direction as usize];
256 1319646 : if buffer.recv_closed {
257 276258 : assert!(buffer.buf.is_empty());
258 1043388 : }
259 :
260 1586117 : while !buffer.buf.is_empty() && buffer.buf.front().unwrap().0 <= now {
261 266471 : let msg = buffer.buf.pop_front().unwrap().1;
262 266471 :
263 266471 : buffer.last_recv = Some(now);
264 266471 : self.schedule_timeout(net);
265 266471 :
266 266471 : if let AnyMessage::InternalConnect = msg {
267 101509 : // TODO: assert to_socket is the server
268 101509 : let server_to_client = TCP {
269 101509 : net: net.clone(),
270 101509 : conn_id: self.connection_id,
271 101509 : dir: direction ^ 1,
272 101509 : recv_chan: to_socket.clone(),
273 101509 : };
274 101509 : // special case, we need to deliver new connection to a separate channel
275 101509 : self.dst_accept.send(NodeEvent::Accept(server_to_client));
276 164962 : } else {
277 164962 : to_socket.send(NetEvent::Message(msg));
278 164962 : }
279 : }
280 1319646 : }
281 :
282 : /// Try to send a message to the buffer, optionally dropping it and
283 : /// determining delivery timestamp.
284 263053 : fn send(&self, net: &NetworkTask, direction: MessageDirection, msg: AnyMessage) {
285 263053 : let now = executor::now();
286 263053 : let mut state = self.state.lock();
287 :
288 263053 : let (delay, close) = if let Some(ms) = net.options.send_delay.delay(&mut state.rng) {
289 240304 : (ms, false)
290 : } else {
291 22749 : (0, true)
292 : };
293 :
294 263053 : let buffer = &mut state.buffers[direction as usize];
295 263053 : if buffer.send_closed {
296 28619 : debug!(
297 0 : "NET: TCP #{} dropped message {:?} (broken pipe)",
298 : self.connection_id, msg
299 : );
300 28619 : return;
301 234434 : }
302 234434 :
303 234434 : if close {
304 17182 : debug!(
305 0 : "NET: TCP #{} dropped message {:?} (pipe just broke)",
306 : self.connection_id, msg
307 : );
308 17182 : buffer.send_closed = true;
309 17182 : return;
310 217252 : }
311 217252 :
312 217252 : if buffer.recv_closed {
313 25653 : debug!(
314 0 : "NET: TCP #{} dropped message {:?} (recv closed)",
315 : self.connection_id, msg
316 : );
317 25653 : return;
318 191599 : }
319 191599 :
320 191599 : // Send a message into the future.
321 191599 : buffer.buf.push_back((now + delay, msg));
322 191599 : net.schedule(self.connection_id, delay);
323 263053 : }
324 :
325 : /// Close the connection. Only one side of the connection will be closed,
326 : /// and no further messages will be delivered. The other side will not be notified.
327 221581 : fn close(&self, node_idx: usize) {
328 221581 : let mut state = self.state.lock();
329 221581 : let recv_buffer = &mut state.buffers[1 ^ node_idx];
330 221581 : if recv_buffer.recv_closed {
331 1091 : debug!(
332 0 : "NET: TCP #{} closed twice at {}",
333 0 : self.connection_id,
334 0 : sender_str(node_idx as MessageDirection),
335 : );
336 1091 : return;
337 220490 : }
338 220490 :
339 220490 : debug!(
340 0 : "NET: TCP #{} closed at {}",
341 0 : self.connection_id,
342 0 : sender_str(node_idx as MessageDirection),
343 : );
344 220490 : recv_buffer.recv_closed = true;
345 220490 : for msg in recv_buffer.buf.drain(..) {
346 20393 : debug!(
347 0 : "NET: TCP #{} dropped message {:?} (closed)",
348 : self.connection_id, msg
349 : );
350 : }
351 :
352 220490 : let send_buffer = &mut state.buffers[node_idx];
353 220490 : send_buffer.send_closed = true;
354 220490 : drop(state);
355 220490 :
356 220490 : // TODO: notify the other side?
357 220490 :
358 220490 : self.dst_sockets[node_idx].send(NetEvent::Closed);
359 221581 : }
360 : }
361 :
362 : struct NetworkBuffer {
363 : /// Messages paired with time of delivery
364 : buf: VecDeque<(u64, AnyMessage)>,
365 : /// True if the connection is closed on the receiving side,
366 : /// i.e. no more messages from the buffer will be delivered.
367 : recv_closed: bool,
368 : /// True if the connection is closed on the sending side,
369 : /// i.e. no more messages will be added to the buffer.
370 : send_closed: bool,
371 : /// Last time a message was delivered from the buffer.
372 : /// If None, it means that the server is the receiver and
373 : /// it has not yet aware of this connection (i.e. has not
374 : /// received the Accept).
375 : last_recv: Option<u64>,
376 : }
377 :
378 : impl NetworkBuffer {
379 275672 : fn new(last_recv: Option<u64>) -> Self {
380 275672 : Self {
381 275672 : buf: VecDeque::new(),
382 275672 : recv_closed: false,
383 275672 : send_closed: false,
384 275672 : last_recv,
385 275672 : }
386 275672 : }
387 : }
388 :
389 : /// Single end of a bidirectional network stream without reordering (TCP-like).
390 : /// Reads are implemented using channels, writes go to the buffer inside VirtualConnection.
391 : pub struct TCP {
392 : net: Arc<NetworkTask>,
393 : conn_id: usize,
394 : dir: MessageDirection,
395 : recv_chan: Chan<NetEvent>,
396 : }
397 :
398 : impl Debug for TCP {
399 901 : fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
400 901 : write!(f, "TCP #{} ({})", self.conn_id, sender_str(self.dir),)
401 901 : }
402 : }
403 :
404 : impl TCP {
405 : /// Send a message to the other side. It's guaranteed that it will not arrive
406 : /// before the arrival of all messages sent earlier.
407 263053 : pub fn send(&self, msg: AnyMessage) {
408 263053 : let conn = self.net.get(self.conn_id);
409 263053 : conn.send(&self.net, self.dir, msg);
410 263053 : }
411 :
412 : /// Get a channel to receive incoming messages.
413 1762326 : pub fn recv_chan(&self) -> Chan<NetEvent> {
414 1762326 : self.recv_chan.clone()
415 1762326 : }
416 :
417 1215500 : pub fn connection_id(&self) -> usize {
418 1215500 : self.conn_id
419 1215500 : }
420 :
421 15819 : pub fn close(&self) {
422 15819 : let conn = self.net.get(self.conn_id);
423 15819 : conn.close(self.dir as usize);
424 15819 : }
425 : }
426 : struct Event {
427 : time: u64,
428 : conn_id: usize,
429 : }
430 :
431 : // BinaryHeap is a max-heap, and we want a min-heap. Reverse the ordering here
432 : // to get that.
433 : impl PartialOrd for Event {
434 4094390 : fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
435 4094390 : Some(self.cmp(other))
436 4094390 : }
437 : }
438 :
439 : impl Ord for Event {
440 4094390 : fn cmp(&self, other: &Self) -> Ordering {
441 4094390 : (other.time, other.conn_id).cmp(&(self.time, self.conn_id))
442 4094390 : }
443 : }
444 :
445 : impl PartialEq for Event {
446 0 : fn eq(&self, other: &Self) -> bool {
447 0 : (other.time, other.conn_id) == (self.time, self.conn_id)
448 0 : }
449 : }
450 :
451 : impl Eq for Event {}
|
