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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
// Copyright 2022 Parity Technologies (UK) Ltd.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
use futures::stream::FuturesUnordered;
use futures::{
channel::{
mpsc,
oneshot::{self, Sender},
},
lock::Mutex as FutMutex,
StreamExt,
{future::BoxFuture, ready},
};
use libp2p_core::muxing::{StreamMuxer, StreamMuxerEvent};
use webrtc::data::data_channel::DataChannel as DetachedDataChannel;
use webrtc::data_channel::RTCDataChannel;
use webrtc::peer_connection::RTCPeerConnection;
use std::task::Waker;
use std::{
pin::Pin,
sync::Arc,
task::{Context, Poll},
};
use crate::tokio::{error::Error, stream, stream::Stream};
/// Maximum number of unprocessed data channels.
/// See [`Connection::poll_inbound`].
const MAX_DATA_CHANNELS_IN_FLIGHT: usize = 10;
/// A WebRTC connection, wrapping [`RTCPeerConnection`] and implementing [`StreamMuxer`] trait.
pub struct Connection {
/// [`RTCPeerConnection`] to the remote peer.
///
/// Uses futures mutex because used in async code (see poll_outbound and poll_close).
peer_conn: Arc<FutMutex<RTCPeerConnection>>,
/// Channel onto which incoming data channels are put.
incoming_data_channels_rx: mpsc::Receiver<Arc<DetachedDataChannel>>,
/// Future, which, once polled, will result in an outbound stream.
outbound_fut: Option<BoxFuture<'static, Result<Arc<DetachedDataChannel>, Error>>>,
/// Future, which, once polled, will result in closing the entire connection.
close_fut: Option<BoxFuture<'static, Result<(), Error>>>,
/// A list of futures, which, once completed, signal that a [`Stream`] has been dropped.
drop_listeners: FuturesUnordered<stream::DropListener>,
no_drop_listeners_waker: Option<Waker>,
}
impl Unpin for Connection {}
impl Connection {
/// Creates a new connection.
pub(crate) async fn new(rtc_conn: RTCPeerConnection) -> Self {
let (data_channel_tx, data_channel_rx) = mpsc::channel(MAX_DATA_CHANNELS_IN_FLIGHT);
Connection::register_incoming_data_channels_handler(
&rtc_conn,
Arc::new(FutMutex::new(data_channel_tx)),
)
.await;
Self {
peer_conn: Arc::new(FutMutex::new(rtc_conn)),
incoming_data_channels_rx: data_channel_rx,
outbound_fut: None,
close_fut: None,
drop_listeners: FuturesUnordered::default(),
no_drop_listeners_waker: None,
}
}
/// Registers a handler for incoming data channels.
///
/// NOTE: `mpsc::Sender` is wrapped in `Arc` because cloning a raw sender would make the channel
/// unbounded. "The channel’s capacity is equal to buffer + num-senders. In other words, each
/// sender gets a guaranteed slot in the channel capacity..."
/// See <https://docs.rs/futures/latest/futures/channel/mpsc/fn.channel.html>
async fn register_incoming_data_channels_handler(
rtc_conn: &RTCPeerConnection,
tx: Arc<FutMutex<mpsc::Sender<Arc<DetachedDataChannel>>>>,
) {
rtc_conn.on_data_channel(Box::new(move |data_channel: Arc<RTCDataChannel>| {
tracing::debug!(channel=%data_channel.id(), "Incoming data channel");
let tx = tx.clone();
Box::pin(async move {
data_channel.on_open({
let data_channel = data_channel.clone();
Box::new(move || {
tracing::debug!(channel=%data_channel.id(), "Data channel open");
Box::pin(async move {
let data_channel = data_channel.clone();
let id = data_channel.id();
match data_channel.detach().await {
Ok(detached) => {
let mut tx = tx.lock().await;
if let Err(e) = tx.try_send(detached.clone()) {
tracing::error!(channel=%id, "Can't send data channel: {}", e);
// We're not accepting data channels fast enough =>
// close this channel.
//
// Ideally we'd refuse to accept a data channel
// during the negotiation process, but it's not
// possible with the current API.
if let Err(e) = detached.close().await {
tracing::error!(
channel=%id,
"Failed to close data channel: {}",
e
);
}
}
}
Err(e) => {
tracing::error!(channel=%id, "Can't detach data channel: {}", e);
}
};
})
})
});
})
}));
}
}
impl StreamMuxer for Connection {
type Substream = Stream;
type Error = Error;
fn poll_inbound(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Result<Self::Substream, Self::Error>> {
match ready!(self.incoming_data_channels_rx.poll_next_unpin(cx)) {
Some(detached) => {
tracing::trace!(stream=%detached.stream_identifier(), "Incoming stream");
let (stream, drop_listener) = Stream::new(detached);
self.drop_listeners.push(drop_listener);
if let Some(waker) = self.no_drop_listeners_waker.take() {
waker.wake()
}
Poll::Ready(Ok(stream))
}
None => {
debug_assert!(
false,
"Sender-end of channel should be owned by `RTCPeerConnection`"
);
Poll::Pending // Return `Pending` without registering a waker: If the channel is closed, we don't need to be called anymore.
}
}
}
fn poll(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Result<StreamMuxerEvent, Self::Error>> {
loop {
match ready!(self.drop_listeners.poll_next_unpin(cx)) {
Some(Ok(())) => {}
Some(Err(e)) => {
tracing::debug!("a DropListener failed: {e}")
}
None => {
self.no_drop_listeners_waker = Some(cx.waker().clone());
return Poll::Pending;
}
}
}
}
fn poll_outbound(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Result<Self::Substream, Self::Error>> {
let peer_conn = self.peer_conn.clone();
let fut = self.outbound_fut.get_or_insert(Box::pin(async move {
let peer_conn = peer_conn.lock().await;
let data_channel = peer_conn.create_data_channel("", None).await?;
// No need to hold the lock during the DTLS handshake.
drop(peer_conn);
tracing::trace!(channel=%data_channel.id(), "Opening data channel");
let (tx, rx) = oneshot::channel::<Arc<DetachedDataChannel>>();
// Wait until the data channel is opened and detach it.
register_data_channel_open_handler(data_channel, tx).await;
// Wait until data channel is opened and ready to use
match rx.await {
Ok(detached) => Ok(detached),
Err(e) => Err(Error::Internal(e.to_string())),
}
}));
match ready!(fut.as_mut().poll(cx)) {
Ok(detached) => {
self.outbound_fut = None;
tracing::trace!(stream=%detached.stream_identifier(), "Outbound stream");
let (stream, drop_listener) = Stream::new(detached);
self.drop_listeners.push(drop_listener);
if let Some(waker) = self.no_drop_listeners_waker.take() {
waker.wake()
}
Poll::Ready(Ok(stream))
}
Err(e) => {
self.outbound_fut = None;
Poll::Ready(Err(e))
}
}
}
fn poll_close(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
tracing::debug!("Closing connection");
let peer_conn = self.peer_conn.clone();
let fut = self.close_fut.get_or_insert(Box::pin(async move {
let peer_conn = peer_conn.lock().await;
peer_conn.close().await?;
Ok(())
}));
match ready!(fut.as_mut().poll(cx)) {
Ok(()) => {
self.incoming_data_channels_rx.close();
self.close_fut = None;
Poll::Ready(Ok(()))
}
Err(e) => {
self.close_fut = None;
Poll::Ready(Err(e))
}
}
}
}
pub(crate) async fn register_data_channel_open_handler(
data_channel: Arc<RTCDataChannel>,
data_channel_tx: Sender<Arc<DetachedDataChannel>>,
) {
data_channel.on_open({
let data_channel = data_channel.clone();
Box::new(move || {
tracing::debug!(channel=%data_channel.id(), "Data channel open");
Box::pin(async move {
let data_channel = data_channel.clone();
let id = data_channel.id();
match data_channel.detach().await {
Ok(detached) => {
if let Err(e) = data_channel_tx.send(detached.clone()) {
tracing::error!(channel=%id, "Can't send data channel: {:?}", e);
if let Err(e) = detached.close().await {
tracing::error!(channel=%id, "Failed to close data channel: {}", e);
}
}
}
Err(e) => {
tracing::error!(channel=%id, "Can't detach data channel: {}", e);
}
};
})
})
});
}