use crate::{ api::Promise, message::{InCommingMessage, MessageBuffer, OutGoingMessage}, mpsc::MpscChannel, tcp::TcpChannel, types::{ Frame, IntStream, Mid, Pid, RemoteParticipant, RtrnMsg, Sid, VELOREN_MAGIC_NUMBER, VELOREN_NETWORK_VERSION, }, udp::UdpChannel, }; use enumset::EnumSet; use mio_extras::channel::Sender; use std::{ collections::{HashMap, VecDeque}, sync::{mpsc, Arc, RwLock}, }; use tracing::*; pub(crate) trait ChannelProtocol { type Handle: ?Sized + mio::Evented; /// Execute when ready to read fn read(&mut self) -> Vec; /// Execute when ready to write fn write>(&mut self, frames: &mut I); /// used for mio fn get_handle(&self) -> &Self::Handle; } #[derive(Debug)] pub(crate) enum ChannelProtocols { Tcp(TcpChannel), Udp(UdpChannel), Mpsc(MpscChannel), } #[derive(Debug)] pub(crate) struct Channel { pub stream_id_pool: Option>>, /* TODO: stream_id unique per * participant */ pub msg_id_pool: Option>>, //TODO: msg_id unique per // participant pub local_pid: Pid, pub remote_pid: Option, pub remotes: Arc>>, pub streams: Vec, pub send_queue: VecDeque, pub protocol: ChannelProtocols, pub return_pid_to: Option>, //use for network::connect() pub send_handshake: bool, pub send_pid: bool, pub send_config: bool, pub send_shutdown: bool, pub recv_handshake: bool, pub recv_pid: bool, pub recv_config: bool, pub recv_shutdown: bool, } /* Participant A Participant B A sends Handshake B receives Handshake and answers with Handshake A receives Handshake and answers with ParticipantId B receives ParticipantId and answeres with ParticipantId A receives ParticipantId and answers with Configuration for Streams and Messages --- A and B can now concurrently open Streams and send messages --- Shutdown phase */ impl Channel { const WRONG_NUMBER: &'static [u8] = "Handshake does not contain the magic number requiered by \ veloren server.\nWe are not sure if you are a valid \ veloren client.\nClosing the connection" .as_bytes(); const WRONG_VERSION: &'static str = "Handshake does not contain a correct magic number, but \ invalid version.\nWe don't know how to communicate with \ you.\n"; pub fn new( local_pid: Pid, protocol: ChannelProtocols, remotes: Arc>>, return_pid_to: Option>, ) -> Self { Self { stream_id_pool: None, msg_id_pool: None, local_pid, remote_pid: None, remotes, streams: Vec::new(), send_queue: VecDeque::new(), protocol, return_pid_to, send_handshake: false, send_pid: false, send_config: false, send_shutdown: false, recv_handshake: false, recv_pid: false, recv_config: false, recv_shutdown: false, } } pub fn can_send(&self) -> bool { self.remote_pid.is_some() && self.recv_handshake && self.send_pid && self.recv_pid && (self.send_config || self.recv_config) && !self.send_shutdown && !self.recv_shutdown } pub fn tick_recv(&mut self, rtrn_tx: &Sender) { match &mut self.protocol { ChannelProtocols::Tcp(c) => { for frame in c.read() { self.handle(frame, rtrn_tx); } }, ChannelProtocols::Udp(c) => { for frame in c.read() { self.handle(frame, rtrn_tx); } }, ChannelProtocols::Mpsc(c) => { for frame in c.read() { self.handle(frame, rtrn_tx); } }, } } pub fn tick_send(&mut self) { self.tick_streams(); match &mut self.protocol { ChannelProtocols::Tcp(c) => { c.write(&mut self.send_queue.drain(..)); }, ChannelProtocols::Udp(c) => { c.write(&mut self.send_queue.drain(..)); }, ChannelProtocols::Mpsc(c) => { c.write(&mut self.send_queue.drain(..)); }, } } fn handle(&mut self, frame: Frame, rtrn_tx: &Sender) { match frame { Frame::Handshake { magic_number, version, } => { if magic_number != VELOREN_MAGIC_NUMBER { error!( ?magic_number, "connection with invalid magic_number, closing connection" ); self.wrong_shutdown(Self::WRONG_NUMBER); } if version != VELOREN_NETWORK_VERSION { error!(?version, "tcp connection with wrong network version"); self.wrong_shutdown( format!( "{} Our Version: {:?}\nYour Version: {:?}\nClosing the connection", Self::WRONG_VERSION, VELOREN_NETWORK_VERSION, version, ) .as_bytes(), ); } debug!("handshake completed"); self.recv_handshake = true; if self.send_handshake { self.send_queue.push_back(Frame::ParticipantId { pid: self.local_pid, }); self.send_pid = true; } else { self.send_queue.push_back(Frame::Handshake { magic_number: VELOREN_MAGIC_NUMBER.to_string(), version: VELOREN_NETWORK_VERSION, }); self.send_handshake = true; } }, Frame::ParticipantId { pid } => { if self.remote_pid.is_some() { error!(?pid, "invalid message, cant change participantId"); return; } self.remote_pid = Some(pid); debug!(?pid, "Participant send their ID"); self.recv_pid = true; if self.send_pid { let mut remotes = self.remotes.write().unwrap(); if !remotes.contains_key(&pid) { remotes.insert(pid, RemoteParticipant::new()); } else { warn!( "a known participant opened an additional channel, UNCHECKED BECAUSE \ NO TOKEN WAS IMPLEMENTED IN THE HANDSHAKE!" ); } if let Some(rp) = remotes.get_mut(&pid) { self.stream_id_pool = Some(rp.stream_id_pool.subpool(1000000).unwrap()); self.msg_id_pool = Some(rp.msg_id_pool.subpool(1000000).unwrap()); self.send_queue.push_back(Frame::Configure { stream_id_pool: rp.stream_id_pool.subpool(1000000).unwrap(), msg_id_pool: rp.msg_id_pool.subpool(1000000).unwrap(), }); self.send_config = true; info!(?pid, "this channel is now configured!"); rtrn_tx.send(RtrnMsg::ConnectedParticipant { pid }); } } else { self.send_queue.push_back(Frame::ParticipantId { pid: self.local_pid, }); self.send_pid = true; } }, Frame::Configure { stream_id_pool, msg_id_pool, } => { self.recv_config = true; //TODO remove range from rp! as this could probably cause duplicate ID !!! let mut remotes = self.remotes.write().unwrap(); if let Some(pid) = self.remote_pid { if !remotes.contains_key(&pid) { remotes.insert(pid, RemoteParticipant::new()); } if let Some(rp) = remotes.get_mut(&pid) { self.stream_id_pool = Some(stream_id_pool); self.msg_id_pool = Some(msg_id_pool); } if let Some(send) = &self.return_pid_to { send.send(pid); }; self.return_pid_to = None; } else { warn!(?self, "Protocol is done wrong!"); } info!("recv config. This channel is now configured!"); }, Frame::Shutdown {} => { self.recv_shutdown = true; info!("shutting down channel"); rtrn_tx.send(RtrnMsg::Shutdown); }, Frame::OpenStream { sid, prio, promises, } => { if let Some(pid) = self.remote_pid { let (msg_tx, msg_rx) = mpsc::channel::(); let stream = IntStream::new(sid, prio, promises.clone(), msg_tx); self.streams.push(stream); info!("opened a stream"); rtrn_tx.send(RtrnMsg::OpendStream { pid, sid, prio, msg_rx, promises, }); } else { error!("called OpenStream before PartcipantID!"); } }, Frame::CloseStream { sid } => { if let Some(pid) = self.remote_pid { self.streams.retain(|stream| stream.sid() != sid); info!("closed a stream"); rtrn_tx.send(RtrnMsg::ClosedStream { pid, sid }); } }, Frame::DataHeader { mid, sid, length } => { debug!("Data Header {}", sid); let imsg = InCommingMessage { buffer: MessageBuffer { data: Vec::new() }, length, mid, sid, }; let mut found = false; for s in &mut self.streams { if s.sid() == sid { //TODO: move to Hashmap, so slow s.to_receive.push_back(imsg); found = true; break; } } if !found { error!("couldn't find stream with sid: {}", sid); } }, Frame::Data { id, start, mut data, } => { debug!("Data Package {}, len: {}", id, data.len()); let mut found = false; for s in &mut self.streams { let mut pos = None; for i in 0..s.to_receive.len() { let m = &mut s.to_receive[i]; if m.mid == id { found = true; m.buffer.data.append(&mut data); if m.buffer.data.len() as u64 == m.length { pos = Some(i); break; }; }; } if let Some(pos) = pos { let sid = s.sid(); let tx = s.msg_tx(); for m in s.to_receive.drain(pos..pos + 1) { info!(?sid, ? m.mid, "received message"); tx.send(m).map_err(|err| { error!( ?err, "Couldn't deliver message, as stream no longer exists!" ) }); } } } if !found { error!("couldn't find stream with mid: {}", id); } }, Frame::Raw(data) => { info!("Got a Raw Package {:?}", data); }, } } // This function will tick all streams according to priority and add them to the // send queue fn tick_streams(&mut self) { //ignoring prio for now //TODO: fix prio if let Some(msg_id_pool) = &mut self.msg_id_pool { for s in &mut self.streams { let mut remove = false; let sid = s.sid(); if let Some(m) = s.to_send.front_mut() { let to_send = std::cmp::min(m.buffer.data.len() as u64 - m.cursor, 1400); if to_send > 0 { if m.cursor == 0 { let mid = msg_id_pool.next(); m.mid = Some(mid); self.send_queue.push_back(Frame::DataHeader { mid, sid, length: m.buffer.data.len() as u64, }); } self.send_queue.push_back(Frame::Data { id: m.mid.unwrap(), start: m.cursor, data: m.buffer.data[m.cursor as usize..(m.cursor + to_send) as usize] .to_vec(), }); }; m.cursor += to_send; if m.cursor == m.buffer.data.len() as u64 { remove = true; debug!(?m.mid, "finish message") } } if remove { s.to_send.pop_front(); } } } } fn wrong_shutdown(&mut self, raw: &[u8]) { #[cfg(debug_assertions)] { debug!("sending client instructions before killing"); self.send_queue.push_back(Frame::Raw(raw.to_vec())); self.send_queue.push_back(Frame::Shutdown {}); self.send_shutdown = true; } } pub(crate) fn open_stream( &mut self, prio: u8, promises: EnumSet, msg_tx: mpsc::Sender, ) -> Sid { // validate promises if let Some(stream_id_pool) = &mut self.stream_id_pool { let sid = stream_id_pool.next(); trace!(?sid, "going to open a new stream"); let stream = IntStream::new(sid, prio, promises.clone(), msg_tx); self.streams.push(stream); self.send_queue.push_back(Frame::OpenStream { sid, prio, promises, }); return sid; } else { panic!("cant open stream because connection isn't initialized"); } } pub(crate) fn close_stream(&mut self, sid: Sid) { self.streams.retain(|stream| stream.sid() != sid); self.send_queue.push_back(Frame::CloseStream { sid }); } pub(crate) fn handshake(&mut self) { self.send_queue.push_back(Frame::Handshake { magic_number: VELOREN_MAGIC_NUMBER.to_string(), version: VELOREN_NETWORK_VERSION, }); self.send_handshake = true; } pub(crate) fn shutdown(&mut self) { self.send_queue.push_back(Frame::Shutdown {}); self.send_shutdown = true; } pub(crate) fn send(&mut self, outgoing: OutGoingMessage) { for s in self.streams.iter_mut() { if s.sid() == outgoing.sid { s.to_send.push_back(outgoing); return; } } let sid = &outgoing.sid; error!(?sid, "couldn't send message, didn't found sid") } pub(crate) fn get_protocol(&self) -> &ChannelProtocols { &self.protocol } }