[WIP] Add packed descriptor and MockPackedQueue #310
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Wenyu Huang <[email protected]>
uran0sH
requested review from
alexandruag,
andreeaflorescu,
jiangliu,
slp,
stsquad,
epilys and
stefano-garzarella
as code owners
uran0sH
changed the title
There was a problem hiding this comment.
Thanks for working on that!
I left some small comments, but I'd suggest splitting in multiple commits, for example:
- Add SplitDescriptor
- Use SplitDescriptor
- remove old stuff in
virtio-queue/src/descriptor.rs - Add PackedDescriptor
- etc
BTW I noticed that virtio-queue/src/descriptor.rs is intact, should we remove Descriptor from there?
Please also add a nice description in commits and PR to explain what we are changing/adding.
| pub mod packed; | ||
| pub mod split; | ||
|
|
||
| /// A virtio descriptor constraints with C representation. |
There was a problem hiding this comment.
Can you add a bit more detail here?
At first glance, it's not clear what it's for.
| @@ -0,0 +1,46 @@ | |||
| //! Descriptor types for virtio queue. | |||
There was a problem hiding this comment.
Please update also this
Comment on lines
+20
to
+61
| /// A virtio descriptor constraints with C representation. | ||
| /// | ||
| /// # Example | ||
| /// | ||
| /// ```rust | ||
| /// # use virtio_bindings::bindings::virtio_ring::{VRING_DESC_F_NEXT, VRING_DESC_F_WRITE}; | ||
| /// # use virtio_queue::mock::MockSplitQueue; | ||
| /// use virtio_queue::{Descriptor, Queue, QueueOwnedT}; | ||
| /// use vm_memory::{GuestAddress, GuestMemoryMmap}; | ||
| /// | ||
| /// # fn populate_queue(m: &GuestMemoryMmap) -> Queue { | ||
| /// # let vq = MockSplitQueue::new(m, 16); | ||
| /// # let mut q = vq.create_queue().unwrap(); | ||
| /// # | ||
| /// # // We have only one chain: (0, 1). | ||
| /// # let desc = Descriptor::new(0x1000, 0x1000, VRING_DESC_F_NEXT as u16, 1); | ||
| /// # vq.desc_table().store(0, desc); | ||
| /// # let desc = Descriptor::new(0x2000, 0x1000, VRING_DESC_F_WRITE as u16, 0); | ||
| /// # vq.desc_table().store(1, desc); | ||
| /// # | ||
| /// # vq.avail().ring().ref_at(0).unwrap().store(u16::to_le(0)); | ||
| /// # vq.avail().idx().store(u16::to_le(1)); | ||
| /// # q | ||
| /// # } | ||
| /// let m = &GuestMemoryMmap::<()>::from_ranges(&[(GuestAddress(0), 0x10000)]).unwrap(); | ||
| /// // Populate the queue with descriptor chains and update the available ring accordingly. | ||
| /// let mut queue = populate_queue(m); | ||
| /// let mut i = queue.iter(m).unwrap(); | ||
| /// let mut c = i.next().unwrap(); | ||
| /// | ||
| /// // Get the first descriptor and access its fields. | ||
| /// let desc = c.next().unwrap(); | ||
| /// let _addr = desc.addr(); | ||
| /// let _len = desc.len(); | ||
| /// let _flags = desc.flags(); | ||
| /// let _next = desc.next(); | ||
| /// let _is_write_only = desc.is_write_only(); | ||
| /// let _has_next = desc.has_next(); | ||
| /// let _refers_to_ind_table = desc.refers_to_indirect_table(); | ||
| /// ``` | ||
| // Note that the `ByteValued` implementation of this structure expects the `Descriptor` to store | ||
| // only plain old data types. |
There was a problem hiding this comment.
Can you check this, talking about split virtqueue and also checking the example?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of the PR
Please summarize here why the changes in this PR are needed.
Requirements
Before submitting your PR, please make sure you addressed the following
requirements:
git commit -s), and the commit message has max 60 characters for thesummary and max 75 characters for each description line.
test.
Release" section of CHANGELOG.md (if no such section exists, please create one).
unsafecode is properly documented.