Skip to content

Conversation

XanClic
Copy link
Contributor

@XanClic XanClic commented Aug 29, 2025

Summary of the PR

This PR contains fixes for fragmented guest memory, i.e. situations where a consecutive guest memory slice does not translate into a consecutive slice in our userspace address space. Currently, that is not really an issue, but with virtual memory (where such discontinuities can occur on any page boundary), it will be.

(See also PR #327).

Specifically:

  • Add GuestMemory::get_slices(), which returns an iterator over slices instead of just a single one
  • Fix Bytes::read() and Bytes::write() to correctly work for fragmented memory (i.e. multiple try_access() closure calls)
  • Have Bytes::load() and Bytes::store() use try_access() instead of to_region_addr(), so they can at least detect if there is fragmentation, and return an error. (Their address argument being properly (naturally) aligned should prevent any problems with fragmentation.)

Requirements

Before submitting your PR, please make sure you addressed the following
requirements:

  • All commits in this PR have Signed-Off-By trailers (with
    git commit -s), and the commit message has max 60 characters for the
    summary and max 75 characters for each description line.
  • All added/changed functionality has a corresponding unit/integration
    test.
    • Note that this was not possible for patches 2 and 3, as explained in their respective commit messages.
  • All added/changed public-facing functionality has entries in the "Upcoming
    Release" section of CHANGELOG.md (if no such section exists, please create one).
  • Any newly added unsafe code is properly documented.

bonzini
bonzini previously approved these changes Aug 29, 2025
@XanClic
Copy link
Contributor Author

XanClic commented Aug 29, 2025

Sorry, messed up the safety formatting: Replaced // Safe: by // SAFETY:\n to make clippy happy.

@bonzini
Copy link
Member

bonzini commented Aug 29, 2025

@XanClic Oops, some missing safety comments

bonzini
bonzini previously approved these changes Aug 29, 2025
Copy link
Member

@roypat roypat left a comment

Choose a reason for hiding this comment

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

I think maybe we can keep .get_slice() as a sort of utility function for when someone wants to get a contiguous slice, and where receiving something cross-region boundary would be an error condition.

CHANGELOG.md Outdated
and `GuestRegionMmap::from_range` to be separate from the error type returned by `GuestRegionCollection` functions.
Change return type of `GuestRegionMmap::new` from `Result` to `Option`.
- \[#324](https:////github.com/rust-vmm/vm-memory/pull/324)\] `GuestMemoryRegion::bitmap()` now returns a `BitmapSlice`. Accessing the full bitmap is now possible only if the type of the memory region is know, for example with `MmapRegion::bitmap()`.
- \[[#339](https://github.com/rust-vmm/vm-memory/pull/339)\] Fix `Bytes::read()` and `Bytes::write()` not to ignore `try_access()`'s `count` parameter
Copy link
Member

Choose a reason for hiding this comment

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

This should probably go into a Fixed section. Also, let's specify that this only applies to the blanket impl provided for T: GuestMemory

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, right!

CHANGELOG.md Outdated
Change return type of `GuestRegionMmap::new` from `Result` to `Option`.
- \[#324](https:////github.com/rust-vmm/vm-memory/pull/324)\] `GuestMemoryRegion::bitmap()` now returns a `BitmapSlice`. Accessing the full bitmap is now possible only if the type of the memory region is know, for example with `MmapRegion::bitmap()`.
- \[[#339](https://github.com/rust-vmm/vm-memory/pull/339)\] Fix `Bytes::read()` and `Bytes::write()` not to ignore `try_access()`'s `count` parameter
- \[[#339](https://github.com/rust-vmm/vm-memory/pull/339)\] Implement `Bytes::load()` and `Bytes::store()` with `try_access()` instead of `to_region_addr()`
Copy link
Member

Choose a reason for hiding this comment

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

This should also specify that it's only relevant for the blanket impl

@XanClic
Copy link
Contributor Author

XanClic commented Sep 2, 2025

I think maybe we can keep .get_slice() as a sort of utility function for when someone wants to get a contiguous slice, and where receiving something cross-region boundary would be an error condition.

Preface: For this PR, that is what is done. But, yes, I would prefer to deprecate get_slice(), and specifically for IoMemory, I prefer not to have it.

User should just not expect IoMemory::get_slice() to work. For GuestMemory, eh, hard to say[1]. I don’t want to provide a function to users that is basically just fundamentally wrong because nobody can ever promise that get_slice() will work.

Next, I can’t think of a valid reason for someone wanting to get a contiguous slice other than it being easier to handle, but that’s a problem with tooling. QEMU e.g. has good tooling around I/O vectors (a vector of buffers), so maybe we need a VolatileSliceVector, too.

Finally, what will users do when get_slice() fails because of fragmentation? The correct thing would be to fall back to get_slices(), but if they’re able to handle that, they should use it from the start. If they can’t handle it, it’ll probably become a fatal error, which is basically an implementation TODO and should be implemented.

Summarizing, I don’t find it good to facilitate users’ incomplete (and I would argue incorrect) implementations that work most of the time but aren’t guaranteed to work. I find there’s no better way to let users know instinctively that their implementation is incomplete than by forcing them to deal with an iterator and manually get exactly the first element. Rust makes it easy to ignore error handling, so I expect users to call get_slice()? and not worry about why exactly it can fail. I don’t expect anyone to put even a TODO comment on their get_slice() calls just because we put a note into the documentation recommending get_slices() instead.

In the end, innocent get_slice()? calls may then produce hard-to-reproduce crashes, and while a logged error message will probably immediately say what the problem is, this assumes that users experiencing those (rare) crashes will have the log files handy and post them.


[1] It just depends on the implementation and circumstances, and so is hard to say in general. In the vanilla vhost-user case with GuestMemoryMmap, guest-physically continuous slices are extremely likely to be continuous in a single GuestMemoryRegion. But this may already change when memory hot-plugging comes into the picture, so it’s definitely not something we can promise.

@bonzini bonzini added this to the vm-memory 0.17.0 milestone Sep 8, 2025
With virtual memory, seemingly consecutive I/O virtual memory regions
may actually be fragmented across multiple pages in our userspace
mapping.  Existing `descriptor_utils::Reader::new()` (and `Writer`)
implementations (e.g. in virtiofsd or vm-virtio/virtio-queue) use
`GuestMemory::get_slice()` to turn guest memory address ranges into
valid slices in our address space; but with this fragmentation, it is
easily possible that a range no longer corresponds to a single slice.

To fix this, add a `get_slices()` method that iterates over potentially
multiple slices instead of a single one.  We should probably also
deprecate `get_slice()`, but I’m hesitant to do it in the same
commit/PR.

(We could also try to use `try_access()` as an existing internal
iterator instead of this new external iterator, which would require
adding lifetimes to `try_access()` so the region and thus slices derived
from it could be moved outside of the closure.  However, that will not
work for virtual memory that we are going to introduce later: It will
have a dirty bitmap that is independent of the one in guest memory
regions, so its `try_access()` function will need to dirty it after the
access.  Therefore, the access must happen in that closure and the
reference to the region must not be moved outside.)

Signed-off-by: Hanna Czenczek <[email protected]>
read() and write() must not ignore the `count` parameter: The mappings
passed into the `try_access()` closure are only valid for up to `count`
bytes, not more.

(Note: We cannot really have a test case for this, as right now, memory
fragmentation will only happen exactly at memory region boundaries.  In
this case, `region.write()`/`region.read()` will only access the region
up until its end, even if the passed slice is longer, and so silently
ignore the length mismatch.  This change is necessary for when page
boundaries result in different mappings within a single region, i.e. the
region does not end at the fragmentation point, and calling
`region.write()`/`region.read()` would write/read across the boundary.
Because we don’t have IOMMU support yet, this can’t be tested.)

Signed-off-by: Hanna Czenczek <[email protected]>
When we switch to a (potentially) virtual memory model, we want to
compact the interface, especially removing references to memory regions
because virtual memory is not just split into regions, but pages first.

`to_region_addr()` will no longer work then, as it does not communicate
to the caller for how many bytes that mapping is valid.  (Currently, it
is generally valid until the end of the region, but this will not be the
case with virtual memory.)

So instead, get a `VolatileSlice` via `get_slices()` and do the atomic
access on it.

(Note: We cannot really have a test case for this, as right now, memory
fragmentation will only happen exactly at memory region boundaries.  In
this case, `region.load()` and `region.store()` would have already
returned errors.  This change is necessary for when page boundaries
result in different mappings within a single region, but because we
don’t have IOMMU support yet, this can’t be tested.)

Signed-off-by: Hanna Czenczek <[email protected]>
@XanClic
Copy link
Contributor Author

XanClic commented Sep 26, 2025

  • Implement FusedIterator for GuestMemorySliceIterator
  • Fix a doc link (<Self as Iterator>::next() doesn’t work, must be Self::next; still kept the former as the link text because I find it clearer)
  • Simplified atomic impls with get_slices() instead of try_access()
  • Moved Bytes::read()/::write() note into new Changelog Fixed section

I didn’t touch try_access() yet, I don’t think that really belongs into this MR.

@bonzini bonzini enabled auto-merge (rebase) September 26, 2025 15:02
@bonzini bonzini merged commit 64bcad5 into rust-vmm:main Sep 26, 2025
2 checks passed
@XanClic
Copy link
Contributor Author

XanClic commented Sep 26, 2025

Thanks!

@roypat roypat mentioned this pull request Sep 26, 2025
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants