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 528 : pub fn start_new(options: Arc<NetworkOptions>, tx: mpsc::Sender<Arc<NetworkTask>>) {
35 528 : let ctx = executor::get_thread_ctx();
36 528 : let task = Arc::new(Self {
37 528 : options,
38 528 : connections: Mutex::new(Vec::new()),
39 528 : events: Mutex::new(BinaryHeap::new()),
40 528 : task_context: ctx,
41 528 : });
42 528 :
43 528 : // send the task upstream
44 528 : tx.send(task.clone()).unwrap();
45 528 :
46 528 : // start the task
47 528 : task.start();
48 528 : }
49 :
50 34318 : pub fn start_new_connection(self: &Arc<Self>, rng: StdRng, dst_accept: Chan<NodeEvent>) -> TCP {
51 34318 : let now = executor::now();
52 34318 : let connection_id = self.connections.lock().len();
53 34318 :
54 34318 : let vc = VirtualConnection {
55 34318 : connection_id,
56 34318 : dst_accept,
57 34318 : dst_sockets: [Chan::new(), Chan::new()],
58 34318 : state: Mutex::new(ConnectionState {
59 34318 : buffers: [NetworkBuffer::new(None), NetworkBuffer::new(Some(now))],
60 34318 : rng,
61 34318 : }),
62 34318 : };
63 34318 : vc.schedule_timeout(self);
64 34318 : vc.send_connect(self);
65 34318 :
66 34318 : let recv_chan = vc.dst_sockets[0].clone();
67 34318 : self.connections.lock().push(vc);
68 34318 :
69 34318 : TCP {
70 34318 : net: self.clone(),
71 34318 : conn_id: connection_id,
72 34318 : dir: 0,
73 34318 : recv_chan,
74 34318 : }
75 34318 : }
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 174464 : fn schedule(&self, id: usize, after_ms: u64) {
83 174464 : self.events.lock().push(Event {
84 174464 : time: executor::now() + after_ms,
85 174464 : conn_id: id,
86 174464 : });
87 174464 : self.task_context.schedule_wakeup(after_ms);
88 174464 : }
89 :
90 : /// Get locked connection `id`.
91 231845 : fn get(&self, id: usize) -> MappedMutexGuard<'_, RawMutex, VirtualConnection> {
92 231845 : MutexGuard::map(self.connections.lock(), |connections| {
93 231845 : connections.get_mut(id).unwrap()
94 231845 : })
95 231845 : }
96 :
97 163367 : fn collect_pending_events(&self, now: u64, vec: &mut Vec<Event>) {
98 163367 : vec.clear();
99 163367 : let mut events = self.events.lock();
100 326207 : while let Some(event) = events.peek() {
101 323651 : if event.time > now {
102 160811 : break;
103 162840 : }
104 162840 : let event = events.pop().unwrap();
105 162840 : vec.push(event);
106 : }
107 163367 : }
108 :
109 528 : fn start(self: &Arc<Self>) {
110 528 : debug!("started network task");
111 :
112 528 : let mut events = Vec::new();
113 : loop {
114 163895 : let now = executor::now();
115 163895 : self.collect_pending_events(now, &mut events);
116 :
117 163895 : for event in events.drain(..) {
118 162840 : let conn = self.get(event.conn_id);
119 162840 : conn.process(self);
120 162840 : }
121 :
122 : // block until wakeup
123 163367 : 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 100109 : fn schedule_timeout(&self, net: &NetworkTask) {
168 100109 : if let Some(timeout) = net.options.keepalive_timeout {
169 100109 : net.schedule(self.connection_id, timeout);
170 100109 : }
171 100109 : }
172 :
173 : /// Send the handshake (Accept) to the server.
174 34318 : fn send_connect(&self, net: &NetworkTask) {
175 34318 : let now = executor::now();
176 34318 : let mut state = self.state.lock();
177 34318 : let delay = net.options.connect_delay.delay(&mut state.rng);
178 34318 : let buffer = &mut state.buffers[0];
179 34318 : assert!(buffer.buf.is_empty());
180 34318 : assert!(!buffer.recv_closed);
181 34318 : assert!(!buffer.send_closed);
182 34318 : assert!(buffer.last_recv.is_none());
183 :
184 34318 : let delay = if let Some(ms) = delay {
185 26558 : ms
186 : } else {
187 7760 : debug!("NET: TCP #{} dropped connect", self.connection_id);
188 7760 : buffer.send_closed = true;
189 7760 : return;
190 : };
191 :
192 : // Send a message into the future.
193 26558 : buffer
194 26558 : .buf
195 26558 : .push_back((now + delay, AnyMessage::InternalConnect));
196 26558 : net.schedule(self.connection_id, delay);
197 34318 : }
198 :
199 : /// Transmit some of the messages from the buffer to the nodes.
200 162840 : fn process(&self, net: &Arc<NetworkTask>) {
201 162840 : let now = executor::now();
202 162840 :
203 162840 : let mut state = self.state.lock();
204 :
205 488520 : for direction in 0..2 {
206 325680 : self.process_direction(
207 325680 : net,
208 325680 : state.deref_mut(),
209 325680 : now,
210 325680 : direction as MessageDirection,
211 325680 : &self.dst_sockets[direction ^ 1],
212 325680 : );
213 325680 : }
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 162840 : if let Some(timeout) = net.options.keepalive_timeout {
218 162840 : let mut to_close = [false, false];
219 488520 : for direction in 0..2 {
220 325680 : let buffer = &mut state.buffers[direction];
221 325680 : if buffer.recv_closed {
222 67855 : continue;
223 257825 : }
224 257825 : if let Some(last_recv) = buffer.last_recv {
225 233595 : if now - last_recv >= timeout {
226 51379 : debug!(
227 0 : "NET: connection {} timed out at {}",
228 0 : self.connection_id,
229 0 : receiver_str(direction as MessageDirection)
230 : );
231 51379 : let node_idx = direction ^ 1;
232 51379 : to_close[node_idx] = true;
233 182216 : }
234 24230 : }
235 : }
236 162840 : drop(state);
237 :
238 325680 : for (node_idx, should_close) in to_close.iter().enumerate() {
239 325680 : if *should_close {
240 51379 : self.close(node_idx);
241 274301 : }
242 : }
243 0 : }
244 162840 : }
245 :
246 : /// Process messages in the buffer in the given direction.
247 325680 : fn process_direction(
248 325680 : &self,
249 325680 : net: &Arc<NetworkTask>,
250 325680 : state: &mut ConnectionState,
251 325680 : now: u64,
252 325680 : direction: MessageDirection,
253 325680 : to_socket: &Chan<NetEvent>,
254 325680 : ) {
255 325680 : let buffer = &mut state.buffers[direction as usize];
256 325680 : if buffer.recv_closed {
257 67855 : assert!(buffer.buf.is_empty());
258 257825 : }
259 :
260 391471 : while !buffer.buf.is_empty() && buffer.buf.front().unwrap().0 <= now {
261 65791 : let msg = buffer.buf.pop_front().unwrap().1;
262 65791 :
263 65791 : buffer.last_recv = Some(now);
264 65791 : self.schedule_timeout(net);
265 65791 :
266 65791 : if let AnyMessage::InternalConnect = msg {
267 25276 : // TODO: assert to_socket is the server
268 25276 : let server_to_client = TCP {
269 25276 : net: net.clone(),
270 25276 : conn_id: self.connection_id,
271 25276 : dir: direction ^ 1,
272 25276 : recv_chan: to_socket.clone(),
273 25276 : };
274 25276 : // special case, we need to deliver new connection to a separate channel
275 25276 : self.dst_accept.send(NodeEvent::Accept(server_to_client));
276 40515 : } else {
277 40515 : to_socket.send(NetEvent::Message(msg));
278 40515 : }
279 : }
280 325680 : }
281 :
282 : /// Try to send a message to the buffer, optionally dropping it and
283 : /// determining delivery timestamp.
284 65178 : fn send(&self, net: &NetworkTask, direction: MessageDirection, msg: AnyMessage) {
285 65178 : let now = executor::now();
286 65178 : let mut state = self.state.lock();
287 :
288 65178 : let (delay, close) = if let Some(ms) = net.options.send_delay.delay(&mut state.rng) {
289 59498 : (ms, false)
290 : } else {
291 5680 : (0, true)
292 : };
293 :
294 65178 : let buffer = &mut state.buffers[direction as usize];
295 65178 : if buffer.send_closed {
296 7384 : debug!(
297 0 : "NET: TCP #{} dropped message {:?} (broken pipe)",
298 : self.connection_id, msg
299 : );
300 7384 : return;
301 57794 : }
302 57794 :
303 57794 : if close {
304 4211 : debug!(
305 0 : "NET: TCP #{} dropped message {:?} (pipe just broke)",
306 : self.connection_id, msg
307 : );
308 4211 : buffer.send_closed = true;
309 4211 : return;
310 53583 : }
311 53583 :
312 53583 : if buffer.recv_closed {
313 5786 : debug!(
314 0 : "NET: TCP #{} dropped message {:?} (recv closed)",
315 : self.connection_id, msg
316 : );
317 5786 : return;
318 47797 : }
319 47797 :
320 47797 : // Send a message into the future.
321 47797 : buffer.buf.push_back((now + delay, msg));
322 47797 : net.schedule(self.connection_id, delay);
323 65178 : }
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 55206 : fn close(&self, node_idx: usize) {
328 55206 : let mut state = self.state.lock();
329 55206 : let recv_buffer = &mut state.buffers[1 ^ node_idx];
330 55206 : if recv_buffer.recv_closed {
331 296 : debug!(
332 0 : "NET: TCP #{} closed twice at {}",
333 0 : self.connection_id,
334 0 : sender_str(node_idx as MessageDirection),
335 : );
336 296 : return;
337 54910 : }
338 54910 :
339 54910 : debug!(
340 0 : "NET: TCP #{} closed at {}",
341 0 : self.connection_id,
342 0 : sender_str(node_idx as MessageDirection),
343 : );
344 54910 : recv_buffer.recv_closed = true;
345 54910 : for msg in recv_buffer.buf.drain(..) {
346 5762 : debug!(
347 0 : "NET: TCP #{} dropped message {:?} (closed)",
348 : self.connection_id, msg
349 : );
350 : }
351 :
352 54910 : let send_buffer = &mut state.buffers[node_idx];
353 54910 : send_buffer.send_closed = true;
354 54910 : drop(state);
355 54910 :
356 54910 : // TODO: notify the other side?
357 54910 :
358 54910 : self.dst_sockets[node_idx].send(NetEvent::Closed);
359 55206 : }
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 68636 : fn new(last_recv: Option<u64>) -> Self {
380 68636 : Self {
381 68636 : buf: VecDeque::new(),
382 68636 : recv_closed: false,
383 68636 : send_closed: false,
384 68636 : last_recv,
385 68636 : }
386 68636 : }
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 65178 : pub fn send(&self, msg: AnyMessage) {
408 65178 : let conn = self.net.get(self.conn_id);
409 65178 : conn.send(&self.net, self.dir, msg);
410 65178 : }
411 :
412 : /// Get a channel to receive incoming messages.
413 421649 : pub fn recv_chan(&self) -> Chan<NetEvent> {
414 421649 : self.recv_chan.clone()
415 421649 : }
416 :
417 286778 : pub fn connection_id(&self) -> usize {
418 286778 : self.conn_id
419 286778 : }
420 :
421 3827 : pub fn close(&self) {
422 3827 : let conn = self.net.get(self.conn_id);
423 3827 : conn.close(self.dir as usize);
424 3827 : }
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 991986 : fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
435 991986 : Some(self.cmp(other))
436 991986 : }
437 : }
438 :
439 : impl Ord for Event {
440 991986 : fn cmp(&self, other: &Self) -> Ordering {
441 991986 : (other.time, other.conn_id).cmp(&(self.time, self.conn_id))
442 991986 : }
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 {}
|
