Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf(udp): multi-message receive on apple #2302

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

perf(udp): multi-message receive on apple #2302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ rust-version = "1.76.0"
enum-map = { version = "2.7", default-features = false }
log = { version = "0.4", default-features = false }
qlog = { version = "0.13", default-features = false }
quinn-udp = { version = "0.5.6", default-features = false, features = ["direct-log"] }
quinn-udp = { version = "0.5.6", default-features = false, features = ["direct-log", "fast-apple-datapath"] }
regex = { version = "1.9", default-features = false, features = ["unicode-perl"] }
static_assertions = { version = "1.1", default-features = false }
url = { version = "2.5.3", default-features = false, features = ["std"] }
Expand Down
5 changes: 3 additions & 2 deletions neqo-bin/src/client/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ use neqo_crypto::{
};
use neqo_http3::Output;
use neqo_transport::{AppError, CloseReason, ConnectionId, Version};
use neqo_udp::RecvBuf;
use tokio::time::Sleep;
use url::{Host, Origin, Url};

Expand Down Expand Up @@ -394,7 +395,7 @@ struct Runner<'a, H: Handler> {
handler: H,
timeout: Option<Pin<Box<Sleep>>>,
args: &'a Args,
recv_buf: Vec<u8>,
recv_buf: RecvBuf,
}

impl<'a, H: Handler> Runner<'a, H> {
Expand All @@ -412,7 +413,7 @@ impl<'a, H: Handler> Runner<'a, H> {
handler,
args,
timeout: None,
recv_buf: vec![0; neqo_udp::RECV_BUF_SIZE],
recv_buf: RecvBuf::new(),
}
}

Expand Down
5 changes: 3 additions & 2 deletions neqo-bin/src/server/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ use neqo_crypto::{
init_db, AntiReplay, Cipher,
};
use neqo_transport::{Output, RandomConnectionIdGenerator, Version};
use neqo_udp::RecvBuf;
use tokio::time::Sleep;

use crate::SharedArgs;
Expand Down Expand Up @@ -202,7 +203,7 @@ pub struct ServerRunner {
server: Box<dyn HttpServer>,
timeout: Option<Pin<Box<Sleep>>>,
sockets: Vec<(SocketAddr, crate::udp::Socket)>,
recv_buf: Vec<u8>,
recv_buf: RecvBuf,
}

impl ServerRunner {
Expand All @@ -217,7 +218,7 @@ impl ServerRunner {
server,
timeout: None,
sockets,
recv_buf: vec![0; neqo_udp::RECV_BUF_SIZE],
recv_buf: RecvBuf::new(),
}
}

Expand Down
4 changes: 2 additions & 2 deletions neqo-bin/src/udp.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
use std::{io, net::SocketAddr};

use neqo_common::Datagram;
use neqo_udp::DatagramIter;
use neqo_udp::{DatagramIter, RecvBuf};

/// Ideally this would live in [`neqo-udp`]. [`neqo-udp`] is used in Firefox.
///
Expand Down Expand Up @@ -59,7 +59,7 @@ impl Socket {
pub fn recv<'a>(
&self,
local_address: SocketAddr,
recv_buf: &'a mut [u8],
recv_buf: &'a mut RecvBuf,
) -> Result<Option<DatagramIter<'a>>, io::Error> {
self.inner
.try_io(tokio::io::Interest::READABLE, || {
Expand Down
194 changes: 121 additions & 73 deletions neqo-udp/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,29 @@ use quinn_udp::{EcnCodepoint, RecvMeta, Transmit, UdpSocketState};
/// Allows reading multiple datagrams in a single [`Socket::recv`] call.
//
// TODO: Experiment with different values across platforms.
pub const RECV_BUF_SIZE: usize = u16::MAX as usize;
const RECV_BUF_SIZE: usize = u16::MAX as usize;
#[cfg(not(any(
target_os = "macos",
target_os = "ios",
target_os = "tvos",
target_os = "visionos"
)))]
const BATCH_SIZE: usize = 1;
#[cfg(any(
target_os = "macos",
target_os = "ios",
target_os = "tvos",
target_os = "visionos"
))]
const BATCH_SIZE: usize = 32;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs some commentary about why there is a split and what the benefits of the additional allocation are. 2MB is fine, but knowing why is important.


pub struct RecvBuf(Vec<Vec<u8>>);

impl RecvBuf {
pub fn new() -> Self {
Self(vec![vec![0; RECV_BUF_SIZE]; BATCH_SIZE])
}
}

pub fn send_inner(
state: &UdpSocketState,
Expand Down Expand Up @@ -56,58 +78,68 @@ pub fn recv_inner<'a>(
local_address: SocketAddr,
state: &UdpSocketState,
socket: impl SocketRef,
recv_buf: &'a mut [u8],
recv_buf: &'a mut RecvBuf,
) -> Result<DatagramIter<'a>, io::Error> {
let mut meta;

let data = loop {
meta = RecvMeta::default();

state.recv(
(&socket).into(),
&mut [IoSliceMut::new(recv_buf)],
slice::from_mut(&mut meta),
)?;

if meta.len == 0 || meta.stride == 0 {
qdebug!(
"ignoring datagram from {} to {} len {} stride {}",
meta.addr,
local_address,
meta.len,
meta.stride
);
continue;
}

break &recv_buf[..meta.len];
};

qtrace!(
"received {} bytes from {} to {} in {} segments",
data.len(),
meta.addr,
local_address,
data.len().div_ceil(meta.stride),
);
loop {
let mut metas = [RecvMeta::default(); BATCH_SIZE];
let mut iovs: [IoSliceMut; BATCH_SIZE] = {
let mut bufs = recv_buf.0.iter_mut().map(|b| IoSliceMut::new(b));
std::array::from_fn(|_| bufs.next().expect("BATCH_SIZE elements"))
};

Ok(DatagramIter {
meta,
datagrams: data.chunks(meta.stride),
local_address,
})
let n = state.recv((&socket).into(), &mut iovs, &mut metas)?;

// TODO: Still neeeded?
// if meta.len == 0 || meta.stride == 0 {
// qdebug!(
// "ignoring datagram from {} to {} len {} stride {}",
// meta.addr,
// local_address,
// meta.len,
// meta.stride
// );
// continue;
// }

// qtrace!(
// "received {} bytes from {} to {} in {} segments",
// data.len(),
// meta.addr,
// local_address,
// data.len().div_ceil(meta.stride),
// );

let len = metas
.iter()
.take(n)
.map(|(meta)| meta.len.div_ceil(meta.stride))
.sum();

return Ok(DatagramIter {
meta: None,
datagrams: None,
metas: metas.into_iter(),
bufs: recv_buf.0.iter_mut().take(n),
local_address,
len,
});
}
}

pub struct DatagramIter<'a> {
meta: RecvMeta,
datagrams: Chunks<'a, u8>,
meta: Option<RecvMeta>,
datagrams: Option<Chunks<'a, u8>>,
metas: std::array::IntoIter<RecvMeta, BATCH_SIZE>,
bufs: std::iter::Take<std::slice::IterMut<'a, Vec<u8>>>,
local_address: SocketAddr,
len: usize,
}

impl std::fmt::Debug for DatagramIter<'_> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("DatagramIter")
.field("meta", &self.meta)
// TODO
// .field("meta", &self.meta)
.field("local_address", &self.local_address)
.finish()
}
Expand All @@ -117,23 +149,38 @@ impl<'a> Iterator for DatagramIter<'a> {
type Item = Datagram<&'a [u8]>;

fn next(&mut self) -> Option<Self::Item> {
self.datagrams.next().map(|d| {
Datagram::from_slice(
self.meta.addr,
self.local_address,
self.meta
.ecn
.map(|n| IpTos::from(n as u8))
.unwrap_or_default(),
d,
)
})
loop {
if let Some(datagrams) = &mut self.datagrams {
if let Some(datagram) = datagrams.next().map(|d| {
Datagram::from_slice(
self.meta.expect("todo").addr,
self.local_address,
self.meta
.expect("todo")
.ecn
.map(|n| IpTos::from(n as u8))
.unwrap_or_default(),
d,
)
}) {
return Some(datagram);
}
}

let Some(datagrams) = self.bufs.next() else {
return None;
};
let meta = self.metas.next().expect("todo");
self.datagrams = Some(datagrams[0..meta.len].chunks(meta.stride));
self.meta = Some(meta);
}
}
}

impl ExactSizeIterator for DatagramIter<'_> {
fn len(&self) -> usize {
self.datagrams.len()
// TODO: This is wrong, i.e. only correct at first.
self.len
}
}

Expand Down Expand Up @@ -162,7 +209,7 @@ impl<S: SocketRef> Socket<S> {
pub fn recv<'a>(
&self,
local_address: SocketAddr,
recv_buf: &'a mut [u8],
recv_buf: &'a mut RecvBuf,
) -> Result<DatagramIter<'a>, io::Error> {
recv_inner(local_address, &self.state, &self.inner, recv_buf)
}
Expand Down Expand Up @@ -195,7 +242,7 @@ mod tests {
);

sender.send(&datagram)?;
let mut recv_buf = vec![0; RECV_BUF_SIZE];
let mut recv_buf = RecvBuf::new();
let res = receiver.recv(receiver_addr, &mut recv_buf);
assert_eq!(res.unwrap_err().kind(), std::io::ErrorKind::WouldBlock);

Expand All @@ -217,7 +264,7 @@ mod tests {

sender.send(&datagram)?;

let mut recv_buf = vec![0; RECV_BUF_SIZE];
let mut recv_buf = RecvBuf::new();
let mut received_datagrams = receiver
.recv(receiver_addr, &mut recv_buf)
.expect("receive to succeed");
Expand Down Expand Up @@ -260,7 +307,7 @@ mod tests {

// Allow for one GSO sendmmsg to result in multiple GRO recvmmsg.
let mut num_received = 0;
let mut recv_buf = vec![0; RECV_BUF_SIZE];
let mut recv_buf = RecvBuf::new();
while num_received < max_gso_segments {
receiver
.recv(receiver_addr, &mut recv_buf)
Expand All @@ -278,19 +325,20 @@ mod tests {
Ok(())
}

#[test]
fn fmt_datagram_iter() {
let dgrams = [];

let i = DatagramIter {
meta: RecvMeta::default(),
datagrams: dgrams.chunks(1),
local_address: "[::]:0".parse().unwrap(),
};

assert_eq!(
&format!("{i:?}"),
"DatagramIter { meta: RecvMeta { addr: [::]:0, len: 0, stride: 0, ecn: None, dst_ip: None }, local_address: [::]:0 }"
);
}
// TODO
// #[test]
// fn fmt_datagram_iter() {
// let dgrams = [];

// let i = DatagramIter {
// meta: RecvMeta::default(),
// datagrams: dgrams.chunks(1),
// local_address: "[::]:0".parse().unwrap(),
// };

// assert_eq!(
// &format!("{i:?}"),
// "DatagramIter { meta: RecvMeta { addr: [::]:0, len: 0, stride: 0, ecn: None, dst_ip: None }, local_address: [::]:0 }"
// );
// }
}
Loading