Skip to content

[RFC] Simplify type-level handling of vm_memory's Bitmap trait #325

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions fuzz/common/src/vsock.rs
Original file line number Diff line number Diff line change
@@ -337,7 +337,7 @@ mod tests {
let mut chain = vq.build_multiple_desc_chains(&q_descriptors).unwrap();

let mut packet =
VsockPacket::from_tx_virtq_chain(&mem, &mut chain, MAX_PKT_BUF_SIZE).unwrap();
VsockPacket::<()>::from_tx_virtq_chain(&mem, &mut chain, MAX_PKT_BUF_SIZE).unwrap();
create_basic_vsock_packet_ops(&mut packet, &mem, &mut functions);
let vsock_fuzz_input = VsockInput {
functions,
@@ -387,7 +387,7 @@ mod tests {
let mut chain = vq.build_multiple_desc_chains(&q_descriptors).unwrap();

let mut packet =
VsockPacket::from_rx_virtq_chain(&mem, &mut chain, MAX_PKT_BUF_SIZE).unwrap();
VsockPacket::<()>::from_rx_virtq_chain(&mem, &mut chain, MAX_PKT_BUF_SIZE).unwrap();
let mut functions = Vec::new();
create_basic_vsock_packet_ops(&mut packet, &mem, &mut functions);
let vsock_fuzz_input = VsockInput {
4 changes: 2 additions & 2 deletions fuzz/fuzz_targets/vsock.rs
Original file line number Diff line number Diff line change
@@ -28,10 +28,10 @@ fuzz_target!(|data: &[u8]| {
if let Ok(mut chain) = vq.build_desc_chain(&descriptors) {
let packet = match fuzz_input.init_function {
InitFunction::FromRX => {
VsockPacket::from_rx_virtq_chain(&m, &mut chain, fuzz_input.pkt_max_data)
VsockPacket::<()>::from_rx_virtq_chain(&m, &mut chain, fuzz_input.pkt_max_data)
}
InitFunction::FromTX => {
VsockPacket::from_tx_virtq_chain(&m, &mut chain, fuzz_input.pkt_max_data)
VsockPacket::<()>::from_tx_virtq_chain(&m, &mut chain, fuzz_input.pkt_max_data)
}
};
if let Ok(mut p) = packet {
14 changes: 6 additions & 8 deletions virtio-queue/src/chain.rs
Original file line number Diff line number Diff line change
@@ -14,8 +14,8 @@ use std::fmt::{self, Debug};
use std::mem::size_of;
use std::ops::Deref;

use vm_memory::bitmap::{BitmapSlice, WithBitmapSlice};
use vm_memory::{Address, Bytes, GuestAddress, GuestMemory, GuestMemoryRegion};
use vm_memory::bitmap::MS;
use vm_memory::{Address, Bytes, GuestAddress, GuestMemory};

use crate::{desc::split::Descriptor, Error, Reader, Writer};
use virtio_bindings::bindings::virtio_ring::VRING_DESC_ALIGN_SIZE;
@@ -90,21 +90,19 @@ where
}

/// Return a new instance of Writer
pub fn writer<'a, B: BitmapSlice>(self, mem: &'a M::Target) -> Result<Writer<'a, B>, Error>
pub fn writer(self, mem: &M::Target) -> Result<Writer<MS<M::Target>>, Error>
where
M::Target: Sized,
<<M::Target as GuestMemory>::R as GuestMemoryRegion>::B: WithBitmapSlice<'a, S = B>,
{
Writer::new(mem, self).map_err(|_| Error::InvalidChain)
Writer::<MS<M::Target>>::new(mem, self).map_err(|_| Error::InvalidChain)
}

/// Return a new instance of Reader
pub fn reader<'a, B: BitmapSlice>(self, mem: &'a M::Target) -> Result<Reader<'a, B>, Error>
pub fn reader(self, mem: &M::Target) -> Result<Reader<MS<M::Target>>, Error>
where
M::Target: Sized,
<<M::Target as GuestMemory>::R as GuestMemoryRegion>::B: WithBitmapSlice<'a, S = B>,
{
Reader::new(mem, self).map_err(|_| Error::InvalidChain)
Reader::<MS<M::Target>>::new(mem, self).map_err(|_| Error::InvalidChain)
}

/// Return an iterator that only yields the writable descriptors in the chain.
51 changes: 26 additions & 25 deletions virtio-queue/src/descriptor_utils.rs
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ use std::ptr::copy_nonoverlapping;
use std::{cmp, result};

use crate::{DescriptorChain, Error};
use vm_memory::bitmap::{BitmapSlice, WithBitmapSlice};
use vm_memory::bitmap::{BitmapSlice, MS};
use vm_memory::{
Address, ByteValued, GuestMemory, GuestMemoryRegion, MemoryRegionAddress, VolatileSlice,
};
@@ -157,10 +157,9 @@ pub struct Reader<'a, B = ()> {

impl<'a, B: BitmapSlice> Reader<'a, B> {
/// Construct a new Reader wrapper over `desc_chain`.
pub fn new<M, T>(mem: &'a M, desc_chain: DescriptorChain<T>) -> Result<Reader<'a, B>>
pub fn new<M, T>(mem: &'a M, desc_chain: DescriptorChain<T>) -> Result<Reader<'a, MS<'a, M>>>
where
M: GuestMemory,
<<M as GuestMemory>::R as GuestMemoryRegion>::B: WithBitmapSlice<'a, S = B>,
T: Deref,
T::Target: GuestMemory + Sized,
{
@@ -186,7 +185,7 @@ impl<'a, B: BitmapSlice> Reader<'a, B> {
.get_slice(MemoryRegionAddress(offset.raw_value()), desc.len() as usize)
.map_err(Error::GuestMemoryError)
})
.collect::<Result<VecDeque<VolatileSlice<'a, B>>>>()?;
.collect::<Result<VecDeque<_>>>()?;
Ok(Reader {
buffer: DescriptorChainConsumer {
buffers,
@@ -269,10 +268,9 @@ pub struct Writer<'a, B = ()> {

impl<'a, B: BitmapSlice> Writer<'a, B> {
/// Construct a new Writer wrapper over `desc_chain`.
pub fn new<M, T>(mem: &'a M, desc_chain: DescriptorChain<T>) -> Result<Writer<'a, B>>
pub fn new<M, T>(mem: &'a M, desc_chain: DescriptorChain<T>) -> Result<Writer<'a, MS<'a, M>>>
where
M: GuestMemory,
<<M as GuestMemory>::R as GuestMemoryRegion>::B: WithBitmapSlice<'a, S = B>,
T: Deref,
T::Target: GuestMemory + Sized,
{
@@ -298,7 +296,7 @@ impl<'a, B: BitmapSlice> Writer<'a, B> {
.get_slice(MemoryRegionAddress(offset.raw_value()), desc.len() as usize)
.map_err(Error::GuestMemoryError)
})
.collect::<Result<VecDeque<VolatileSlice<'a, B>>>>()?;
.collect::<Result<VecDeque<_>>>()?;

Ok(Writer {
buffer: DescriptorChainConsumer {
@@ -454,7 +452,7 @@ mod tests {

let chain = queue.iter(&memory).unwrap().next().unwrap();

assert!(Reader::new(&memory, chain).is_err());
assert!(Reader::<()>::new(&memory, chain).is_err());
}

#[test]
@@ -476,7 +474,7 @@ mod tests {
0,
)
.expect("create_descriptor_chain failed");
let mut reader = Reader::new(&memory, chain).expect("failed to create Reader");
let mut reader = Reader::<()>::new(&memory, chain).expect("failed to create Reader");
assert_eq!(reader.available_bytes(), 106);
assert_eq!(reader.bytes_read(), 0);

@@ -516,7 +514,7 @@ mod tests {
0,
)
.expect("create_descriptor_chain failed");
let mut writer = Writer::new(&memory, chain).expect("failed to create Writer");
let mut writer = Writer::<()>::new(&memory, chain).expect("failed to create Writer");
assert_eq!(writer.available_bytes(), 106);
assert_eq!(writer.bytes_written(), 0);

@@ -546,7 +544,7 @@ mod tests {

let chain = create_descriptor_chain(&memory, GuestAddress(0x0), vec![(Writable, 8)], 0)
.expect("create_descriptor_chain failed");
let mut reader = Reader::new(&memory, chain).expect("failed to create Reader");
let mut reader = Reader::<()>::new(&memory, chain).expect("failed to create Reader");
assert_eq!(reader.available_bytes(), 0);
assert_eq!(reader.bytes_read(), 0);

@@ -565,7 +563,7 @@ mod tests {

let chain = create_descriptor_chain(&memory, GuestAddress(0x0), vec![(Readable, 8)], 0)
.expect("create_descriptor_chain failed");
let mut writer = Writer::new(&memory, chain).expect("failed to create Writer");
let mut writer = Writer::<()>::new(&memory, chain).expect("failed to create Writer");
assert_eq!(writer.available_bytes(), 0);
assert_eq!(writer.bytes_written(), 0);

@@ -596,8 +594,9 @@ mod tests {
0,
)
.expect("create_descriptor_chain failed");
let mut reader = Reader::new(&memory, chain.clone()).expect("failed to create Reader");
let mut writer = Writer::new(&memory, chain).expect("failed to create Writer");
let mut reader =
Reader::<()>::new(&memory, chain.clone()).expect("failed to create Reader");
let mut writer = Writer::<()>::new(&memory, chain).expect("failed to create Writer");

assert_eq!(reader.bytes_read(), 0);
assert_eq!(writer.bytes_written(), 0);
@@ -639,7 +638,7 @@ mod tests {
123,
)
.expect("create_descriptor_chain failed");
let mut writer = Writer::new(&memory, chain_writer).expect("failed to create Writer");
let mut writer = Writer::<()>::new(&memory, chain_writer).expect("failed to create Writer");
if let Err(e) = writer.write_obj(secret) {
panic!("write_obj should not fail here: {:?}", e);
}
@@ -652,7 +651,7 @@ mod tests {
123,
)
.expect("create_descriptor_chain failed");
let mut reader = Reader::new(&memory, chain_reader).expect("failed to create Reader");
let mut reader = Reader::<()>::new(&memory, chain_reader).expect("failed to create Reader");
match reader.read_obj::<Le32>() {
Err(e) => panic!("read_obj should not fail here: {:?}", e),
Ok(read_secret) => assert_eq!(read_secret, secret),
@@ -674,7 +673,7 @@ mod tests {
)
.expect("create_descriptor_chain failed");

let mut reader = Reader::new(&memory, chain).expect("failed to create Reader");
let mut reader = Reader::<()>::new(&memory, chain).expect("failed to create Reader");

let mut buf = vec![0; 1024];

@@ -708,13 +707,15 @@ mod tests {
0,
)
.expect("create_descriptor_chain failed");
let mut reader = Reader::new(&memory, chain.clone()).expect("failed to create Reader");
let mut reader =
Reader::<()>::new(&memory, chain.clone()).expect("failed to create Reader");

let other = reader.split_at(32).expect("failed to split Reader");
assert_eq!(reader.available_bytes(), 32);
assert_eq!(other.available_bytes(), 96);

let mut writer = Writer::new(&memory, chain.clone()).expect("failed to create Writer");
let mut writer =
Writer::<()>::new(&memory, chain.clone()).expect("failed to create Writer");
let other = writer.split_at(64).expect("failed to split Writer");
assert_eq!(writer.available_bytes(), 64);
assert_eq!(other.available_bytes(), 4);
@@ -741,7 +742,7 @@ mod tests {
0,
)
.expect("create_descriptor_chain failed");
let mut reader = Reader::new(&memory, chain).expect("failed to create Reader");
let mut reader = Reader::<()>::new(&memory, chain).expect("failed to create Reader");

let other = reader.split_at(24).expect("failed to split Reader");
assert_eq!(reader.available_bytes(), 24);
@@ -769,7 +770,7 @@ mod tests {
0,
)
.expect("create_descriptor_chain failed");
let mut reader = Reader::new(&memory, chain).expect("failed to create Reader");
let mut reader = Reader::<()>::new(&memory, chain).expect("failed to create Reader");

let other = reader.split_at(128).expect("failed to split Reader");
assert_eq!(reader.available_bytes(), 128);
@@ -797,7 +798,7 @@ mod tests {
0,
)
.expect("create_descriptor_chain failed");
let mut reader = Reader::new(&memory, chain).expect("failed to create Reader");
let mut reader = Reader::<()>::new(&memory, chain).expect("failed to create Reader");

let other = reader.split_at(0).expect("failed to split Reader");
assert_eq!(reader.available_bytes(), 0);
@@ -825,7 +826,7 @@ mod tests {
0,
)
.expect("create_descriptor_chain failed");
let mut reader = Reader::new(&memory, chain).expect("failed to create Reader");
let mut reader = Reader::<()>::new(&memory, chain).expect("failed to create Reader");

if reader.split_at(256).is_ok() {
panic!("successfully split Reader with out of bounds offset");
@@ -846,7 +847,7 @@ mod tests {
0,
)
.expect("create_descriptor_chain failed");
let mut reader = Reader::new(&memory, chain).expect("failed to create Reader");
let mut reader = Reader::<()>::new(&memory, chain).expect("failed to create Reader");

let mut buf = [0u8; 64];
assert_eq!(
@@ -869,7 +870,7 @@ mod tests {
0,
)
.expect("create_descriptor_chain failed");
let mut writer = Writer::new(&memory, chain).expect("failed to create Writer");
let mut writer = Writer::<()>::new(&memory, chain).expect("failed to create Writer");

let buf = [0xdeu8; 64];
assert_eq!(
Loading