use std::{
net::SocketAddr,
sync::Arc,
time::{Duration, Instant},
};
use crate::{Error, Result, session::CheckedIncomingConnection, stream_connect::ConnectionKind};
use buffers::{ByteBuf, ByteBufOwned};
use futures::TryFutureExt;
use librqbit_core::{
hash_id::Id20,
lengths::{ChunkInfo, ValidPieceIndex},
peer_id::try_decode_peer_id,
};
use parking_lot::RwLock;
use peer_binary_protocol::{
Handshake, MAX_MSG_LEN, Message,
extended::{
ExtendedMessage, PeerExtendedMessageIds, handshake::ExtendedHandshake,
ut_metadata::UtMetadata, ut_pex::UtPex,
},
serialize_piece_preamble,
};
use serde::{Deserialize, Serialize};
use serde_with::serde_as;
use tokio::time::timeout;
use tracing::{Instrument, debug, trace, trace_span};
use crate::{
read_buf::ReadBuf,
spawn_utils::BlockingSpawner,
stream_connect::StreamConnector,
type_aliases::{BoxAsyncReadVectored, BoxAsyncWrite},
};
pub trait PeerConnectionHandler {
fn on_connected(&self, _connection_time: Duration) {}
fn should_send_bitfield(&self) -> bool;
fn serialize_bitfield_message_to_buf(&self, buf: &mut [u8]) -> anyhow::Result<usize>;
fn on_handshake(&self, handshake: Handshake, ckind: ConnectionKind) -> anyhow::Result<()>;
fn on_extended_handshake(
&self,
extended_handshake: &ExtendedHandshake<ByteBuf>,
) -> anyhow::Result<()>;
async fn on_received_message(&self, msg: Message<'_>) -> anyhow::Result<()>;
fn should_transmit_have(&self, id: ValidPieceIndex) -> bool;
fn on_uploaded_bytes(&self, bytes: u32);
fn read_chunk(&self, chunk: &ChunkInfo, buf: &mut [u8]) -> anyhow::Result<()>;
fn update_my_extended_handshake(
&self,
_handshake: &mut ExtendedHandshake<ByteBuf>,
) -> anyhow::Result<()> {
Ok(())
}
fn client_name_and_version(&self) -> &str {
crate::client_name_and_version()
}
}
#[derive(Debug)]
pub enum WriterRequest {
Message(Message<'static>),
UtMetadata(UtMetadata<ByteBufOwned>),
UtPex(UtPex<ByteBufOwned>),
ReadChunkRequest(ChunkInfo),
Disconnect(anyhow::Result<()>),
}
#[serde_as]
#[derive(Default, Debug, Copy, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct PeerConnectionOptions {
#[serde_as(as = "Option<serde_with::DurationSeconds>")]
pub connect_timeout: Option<Duration>,
#[serde_as(as = "Option<serde_with::DurationSeconds>")]
pub read_write_timeout: Option<Duration>,
#[serde_as(as = "Option<serde_with::DurationSeconds>")]
pub keep_alive_interval: Option<Duration>,
}
pub(crate) struct PeerConnection<H> {
handler: H,
addr: SocketAddr,
info_hash: Id20,
peer_id: Id20,
options: PeerConnectionOptions,
spawner: BlockingSpawner,
connector: Arc<StreamConnector>,
}
#[cfg(not(feature = "miri"))]
pub(crate) async fn with_timeout<T>(
name: &'static str,
timeout_value: Duration,
fut: impl std::future::Future<Output = Result<T>>,
) -> crate::Result<T> {
match timeout(timeout_value, fut).await {
Ok(v) => v,
Err(_) => Err(Error::Timeout(name)),
}
}
#[cfg(feature = "miri")]
pub(crate) async fn with_timeout<T>(
_name: &'static str,
_timeout_value: Duration,
fut: impl std::future::Future<Output = Result<T>>,
) -> crate::Result<T> {
fut.await
}
struct ManagePeerArgs {
handshake_supports_extended: bool,
read_buf: ReadBuf,
write_buf: Box<[u8; MAX_MSG_LEN]>,
read: BoxAsyncReadVectored,
write: BoxAsyncWrite,
outgoing_chan: tokio::sync::mpsc::UnboundedReceiver<WriterRequest>,
have_broadcast: tokio::sync::broadcast::Receiver<ValidPieceIndex>,
}
impl<H: PeerConnectionHandler> PeerConnection<H> {
pub fn new(
addr: SocketAddr,
info_hash: Id20,
peer_id: Id20,
handler: H,
options: Option<PeerConnectionOptions>,
spawner: BlockingSpawner,
connector: Arc<StreamConnector>,
) -> Self {
PeerConnection {
handler,
addr,
info_hash,
peer_id,
spawner,
options: options.unwrap_or_default(),
connector,
}
}
pub async fn manage_peer_incoming(
&self,
outgoing_chan: tokio::sync::mpsc::UnboundedReceiver<WriterRequest>,
mut incoming: CheckedIncomingConnection,
have_broadcast: tokio::sync::broadcast::Receiver<ValidPieceIndex>,
) -> Result<()> {
use tokio::io::AsyncWriteExt;
let rwtimeout = self
.options
.read_write_timeout
.unwrap_or_else(|| Duration::from_secs(10));
if incoming.handshake.info_hash != self.info_hash {
return Err(Error::WrongInfoHash);
}
if incoming.handshake.peer_id == self.peer_id {
return Err(Error::ConnectingToOurselves);
}
trace!(
"incoming connection: id={:?}",
try_decode_peer_id(incoming.handshake.peer_id)
);
let mut write_buf = Box::new([0u8; MAX_MSG_LEN]);
let handshake = Handshake::new(self.info_hash, self.peer_id);
let hlen = handshake.serialize_unchecked_len(&mut *write_buf);
with_timeout(
"writing handshake",
rwtimeout,
incoming
.writer
.write_all(&write_buf[..hlen])
.map_err(Error::WriteHandshake),
)
.await?;
let handshake_supports_extended = handshake.supports_extended();
self.handler
.on_handshake(handshake, incoming.kind)
.map_err(Error::Anyhow)?;
self.manage_peer(ManagePeerArgs {
handshake_supports_extended,
read_buf: incoming.read_buf,
write_buf,
read: incoming.reader,
write: incoming.writer,
outgoing_chan,
have_broadcast,
})
.await
}
pub async fn manage_peer_outgoing(
&self,
outgoing_chan: tokio::sync::mpsc::UnboundedReceiver<WriterRequest>,
have_broadcast: tokio::sync::broadcast::Receiver<ValidPieceIndex>,
) -> Result<()> {
use tokio::io::AsyncWriteExt;
let rwtimeout = self
.options
.read_write_timeout
.unwrap_or_else(|| Duration::from_secs(10));
let connect_timeout = self
.options
.connect_timeout
.unwrap_or_else(|| Duration::from_secs(10));
let now = Instant::now();
let (ckind, mut read, mut write) = with_timeout(
"connecting",
connect_timeout,
self.connector.connect(self.addr),
)
.await?;
async move {
self.handler.on_connected(now.elapsed());
let mut write_buf = Box::new([0u8; MAX_MSG_LEN]);
let handshake = Handshake::new(self.info_hash, self.peer_id);
let hsz = handshake.serialize_unchecked_len(&mut *write_buf);
with_timeout(
"writing",
rwtimeout,
write
.write_all(&write_buf[..hsz])
.map_err(Error::WriteHandshake),
)
.await?;
let mut read_buf = ReadBuf::new();
let h = read_buf.read_handshake(&mut read, rwtimeout).await?;
let handshake_supports_extended = h.supports_extended();
trace!(
peer_id=?h.peer_id,
decoded_id=?try_decode_peer_id(h.peer_id),
"connected",
);
if h.info_hash != self.info_hash {
return Err(Error::WrongInfoHash);
}
if h.peer_id == self.peer_id {
return Err(Error::ConnectingToOurselves);
}
self.handler.on_handshake(h, ckind).map_err(Error::Anyhow)?;
self.manage_peer(ManagePeerArgs {
handshake_supports_extended,
read_buf,
write_buf,
read,
write,
outgoing_chan,
have_broadcast,
})
.await
}
.instrument(trace_span!("", kind=%ckind))
.await
}
async fn manage_peer(&self, args: ManagePeerArgs) -> Result<()> {
let ManagePeerArgs {
handshake_supports_extended,
mut read_buf,
mut write_buf,
mut read,
mut write,
mut outgoing_chan,
mut have_broadcast,
} = args;
use tokio::io::AsyncWriteExt;
let rwtimeout = self
.options
.read_write_timeout
.unwrap_or_else(|| Duration::from_secs(10));
let extended_handshake: RwLock<Option<PeerExtendedMessageIds>> = RwLock::new(None);
let extended_handshake_ref = &extended_handshake;
let supports_extended = handshake_supports_extended;
if supports_extended {
let mut my_extended = ExtendedHandshake::new();
my_extended.v = Some(ByteBuf(self.handler.client_name_and_version().as_bytes()));
my_extended.yourip = Some(self.addr.ip().into());
self.handler
.update_my_extended_handshake(&mut my_extended)
.map_err(Error::Anyhow)?;
let my_extended = Message::Extended(ExtendedMessage::Handshake(my_extended));
trace!("sending extended handshake: {:?}", &my_extended);
let esz = my_extended.serialize(&mut *write_buf, &Default::default)?;
with_timeout(
"writing extended handshake",
rwtimeout,
write.write_all(&write_buf[..esz]).map_err(Error::Write),
)
.await?;
}
let writer = async move {
let keep_alive_interval = self
.options
.keep_alive_interval
.unwrap_or_else(|| Duration::from_secs(120));
if self.handler.should_send_bitfield() {
let len = self
.handler
.serialize_bitfield_message_to_buf(&mut *write_buf)
.map_err(Error::Anyhow)?;
with_timeout(
"writing bitfield",
rwtimeout,
write.write_all(&write_buf[..len]).map_err(Error::Write),
)
.await?;
trace!("sent bitfield");
}
let len = Message::Unchoke.serialize(&mut *write_buf, &Default::default)?;
with_timeout(
"writing",
rwtimeout,
write.write_all(&write_buf[..len]).map_err(Error::Write),
)
.await?;
trace!("sent unchoke");
let mut broadcast_closed = false;
loop {
let req = loop {
break tokio::select! {
r = have_broadcast.recv(), if !broadcast_closed => match r {
Ok(id) => {
if self.handler.should_transmit_have(id) {
WriterRequest::Message(Message::Have(id.get()))
} else {
continue
}
},
Err(tokio::sync::broadcast::error::RecvError::Closed) => {
broadcast_closed = true;
debug!("broadcast channel closed, will not poll it anymore");
continue
},
_ => continue
},
r = timeout(keep_alive_interval, outgoing_chan.recv()) => match r {
Ok(Some(msg)) => msg,
Ok(None) => {
return Err(Error::TorrentIsNotLive);
}
Err(_) => WriterRequest::Message(Message::KeepAlive),
}
};
};
tokio::task::yield_now().await;
let mut uploaded_add = None;
trace!("about to send: {:?}", &req);
let ext_msg_ids = &|| {
extended_handshake_ref
.read()
.as_ref()
.map(|e| *e)
.unwrap_or_default()
};
let len = match req {
WriterRequest::Message(msg) => msg.serialize(&mut *write_buf, ext_msg_ids)?,
WriterRequest::UtMetadata(utm) => {
Message::Extended(ExtendedMessage::UtMetadata(utm.as_borrowed()))
.serialize(&mut *write_buf, ext_msg_ids)?
}
WriterRequest::UtPex(ut_pex) => {
Message::Extended(ExtendedMessage::UtPex(ut_pex.as_borrowed()))
.serialize(&mut *write_buf, ext_msg_ids)?
}
WriterRequest::ReadChunkRequest(chunk) => {
#[allow(unused_mut)]
let mut skip_reading_for_e2e_tests = false;
#[cfg(test)]
{
use tracing::warn;
use crate::tests::test_util::TestPeerMetadata;
let tpm = TestPeerMetadata::from_peer_id(self.peer_id);
use rand::Rng;
if rand::rng().random_bool(tpm.disconnect_probability()) {
return Err(Error::TestDisconnect);
}
#[allow(clippy::cast_possible_truncation)]
let sleep_ms = (rand::rng().random::<f64>()
* (tpm.max_random_sleep_ms as f64))
as u64;
if sleep_ms > 0 {
tokio::time::sleep(Duration::from_millis(sleep_ms)).await;
}
if rand::rng().random_bool(tpm.bad_data_probability()) {
warn!(
"will NOT actually read the data to simulate a malicious peer that sends garbage"
);
write_buf.fill(0);
skip_reading_for_e2e_tests = true;
}
}
let preamble_len = serialize_piece_preamble(&chunk, &mut *write_buf);
let full_len = preamble_len + chunk.size as usize;
if !skip_reading_for_e2e_tests {
self.spawner
.block_in_place_with_semaphore(|| {
self.handler
.read_chunk(&chunk, &mut write_buf[preamble_len..])
})
.await
.map_err(Error::ReadChunk)?;
}
uploaded_add = Some(chunk.size);
full_len
}
WriterRequest::Disconnect(res) => {
trace!("disconnect requested, closing writer");
match res {
Ok(()) => return Err(Error::Disconnect),
Err(e) => return Err(Error::DisconnectWithSource(e)),
}
}
};
with_timeout(
"writing",
rwtimeout,
write.write_all(&write_buf[..len]).map_err(Error::Write),
)
.await?;
if let Some(uploaded_add) = uploaded_add {
self.handler.on_uploaded_bytes(uploaded_add)
}
}
#[allow(unreachable_code)]
Ok::<_, Error>(())
};
let reader = async move {
loop {
let message = read_buf.read_message(&mut read, rwtimeout).await?;
trace!("received: {:?}", &message);
tokio::task::yield_now().await;
if let Message::Extended(ExtendedMessage::Handshake(h)) = &message {
*extended_handshake_ref.write() = Some(h.peer_extended_messages());
self.handler
.on_extended_handshake(h)
.map_err(Error::Anyhow)?;
} else {
self.handler
.on_received_message(message)
.await
.map_err(Error::Anyhow)?;
}
}
#[allow(unreachable_code)]
Ok::<_, Error>(())
};
tokio::select! {
r = reader => {
if let Err(e) = r.as_ref() {
trace!("reader finished with error: {e:#}");
} else {
trace!("reader finished without error");
}
r
}
r = writer => {
if let Err(e) = r.as_ref() {
trace!("writer finished with error: {e:#}");
} else {
trace!("writer finished without error");
}
r
}
}
}
}