8000 Remove Linux-only restriction from map_region on MultiUseSandbox by jsturtevant · Pull Request #1330 · hyperlight-dev/hyperlight · GitHub
[go: up one dir, main page]
Skip to content

Remove Linux-only restriction from map_region on MultiUseSandbox #1330

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

Merged
jsturtevant merged 2 commits into from
Mar 20, 2026
Merged

Remove Linux-only restriction from map_region on MultiUseSandbox #1330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits 8000
Select commit Hold shift + click to select a range
98889be
Remove Linux-only restriction from map_region on MultiUseSandbox
jsturtevant Mar 19, 2026
a61a7a8
Add cross-platform host_region_base/end helpers to SharedMemory
jsturtevant Mar 20, 2026
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
38 changes: 24 additions & 14 deletions src/hyperlight_host/src/mem/shared_mem.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -721,14 +721,9 @@ impl GuestSharedMemory {
),
};
let guest_base = guest_base as usize;
#[cfg(not(windows))]
let host_base = self.base_addr();
#[cfg(windows)]
let host_base = self.host_region_base();
let host_end = <HostGuestMemoryRegion as MemoryRegionKind>::add(host_base, self.mem_size());
MemoryRegion {
guest_region: guest_base..(guest_base + self.mem_size()),
host_region: host_base..host_end,
host_region: self.host_region_base()..self.host_region_end(),
region_type,
flags,
}
Expand Down Expand Up @@ -779,15 +774,30 @@ pub trait SharedMemory {
}

/// Extract a base address that can be mapped into a VM for this
/// SharedMemory
#[cfg(target_os = "windows")]
fn host_region_base(&self) -> super::memory_region::HostRegionBase {
super::memory_region::HostRegionBase {
from_handle: self.region().handle.into(),
handle_base: self.region().ptr as usize,
handle_size: self.region().size,
offset: PAGE_SIZE_USIZE,
/// SharedMemory.
///
/// On Linux this returns a raw `usize` pointer. On Windows it
/// returns a [`HostRegionBase`](super::memory_region::HostRegionBase)
/// that carries the file-mapping handle metadata needed by WHP.
fn host_region_base(&self) -> <HostGuestMemoryRegion as MemoryRegionKind>::HostBaseType {
#[cfg(not(windows))]
{
self.base_addr()
}
#[cfg(windows)]
{
super::memory_region::HostRegionBase {
from_handle: self.region().handle.into(),
handle_base: self.region().ptr as usize,
handle_size: self.region().size,
offset: PAGE_SIZE_USIZE,
}
}
}

/// Return the end address of the host region (base + usable size).
fn host_region_end(&self) -> <HostGuestMemoryRegion as MemoryRegionKind>::HostBaseType {
<HostGuestMemoryRegion as MemoryRegionKind>::add(self.host_region_base(), self.mem_size())
}

/// Run some code with exclusive access to the SharedMemory
Expand Down
22 changes: 3 additions & 19 deletions src/hyperlight_host/src/sandbox/initialized_multi_use.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,16 @@ use super::file_mapping::prepare_file_cow;
use super::host_funcs::FunctionRegistry;
use super::snapshot::Snapshot;
use crate::HyperlightError::{self, SnapshotSandboxMismatch};
use crate::Result;
use crate::func::{ParameterTuple, SupportedReturnType};
use crate::hypervisor::InterruptHandle;
use crate::hypervisor::hyperlight_vm::{HyperlightVm, HyperlightVmError};
#[cfg(target_os = "linux")]
use crate::log_then_return;
use crate::mem::memory_region::MemoryRegion;
#[cfg(target_os = "linux")]
use crate::mem::memory_region::MemoryRegionFlags;
use crate::mem::memory_region::{MemoryRegion, MemoryRegionFlags};
use crate::mem::mgr::SandboxMemoryManager;
use crate::mem::shared_mem::{HostSharedMemory, SharedMemory as _};
use crate::metrics::{
METRIC_GUEST_ERROR, METRIC_GUEST_ERROR_LABEL_CODE, maybe_time_and_emit_guest_call,
};
use crate::{Result, log_then_return};

/// A fully initialized sandbox that can execute guest functions multiple times.
///
Expand Down Expand Up @@ -525,7 +521,6 @@ impl MultiUseSandbox {
/// The caller must ensure the host memory region remains valid and unmodified
/// for the lifetime of `self`.
#[instrument(err(Debug), skip(self, rgn), parent = Span::current())]
#[cfg(target_os = "linux")]
pub unsafe fn map_region(&mut self, rgn: &MemoryRegion) -> Result<()> {
if self.poisoned {
return Err(crate::HyperlightError::PoisonedSandbox);
Expand Down Expand Up @@ -914,9 +909,7 @@ mod tests {
use hyperlight_testing::sandbox_sizes::{LARGE_HEAP_SIZE, MEDIUM_HEAP_SIZE, SMALL_HEAP_SIZE};
use hyperlight_testing::simple_guest_as_string;

#[cfg(target_os = "linux")]
use crate::mem::memory_region::{MemoryRegion, MemoryRegionFlags, MemoryRegionType};
#[cfg(target_os = "linux")]
use crate::mem::shared_mem::{ExclusiveSharedMemory, GuestSharedMemory, SharedMemory as _};
use crate::sandbox::SandboxConfiguration;
use crate::{GuestBinary, HyperlightError, MultiUseSandbox, Result, UninitializedSandbox};
Expand Down Expand Up @@ -955,7 +948,6 @@ mod tests {
}

// map_region should fail when poisoned
#[cfg(target_os = "linux")]
{
let map_mem = allocate_guest_memory();
let guest_base = 0x0;
Expand All @@ -965,7 +957,6 @@ mod tests {
}

// map_file_cow should fail when poisoned
#[cfg(target_os = "linux")]
{
let temp_file = std::env::temp_dir().join("test_poison_map_file.bin");
let res = sbox.map_file_cow(&temp_file, 0x0, None).unwrap_err();
Expand Down Expand Up @@ -1227,7 +1218,6 @@ mod tests {
}
}

#[cfg(target_os = "linux")]
#[test]
fn test_mmap() {
let mut sbox = UninitializedSandbox::new(
Expand Down Expand Up @@ -1263,7 +1253,6 @@ mod tests {
}

// Makes sure MemoryRegionFlags::READ | MemoryRegionFlags::EXECUTE executable but not writable
#[cfg(target_os = "linux")]
#[test]
fn test_mmap_write_exec() {
let mut sbox = UninitializedSandbox::new(
Expand Down Expand Up @@ -1312,7 +1301,6 @@ mod tests {
};
}

#[cfg(target_os = "linux")]
fn page_aligned_memory(src: &[u8]) -> GuestSharedMemory {
use hyperlight_common::mem::PAGE_SIZE_USIZE;

Expand All @@ -1326,29 +1314,25 @@ mod tests {
guest_mem
}

#[cfg(target_os = "linux")]
fn region_for_memory(
mem: &GuestSharedMemory,
guest_base: usize,
flags: MemoryRegionFlags,
) -> MemoryRegion {
let ptr = mem.base_addr();
let len = mem.mem_size();
MemoryRegion {
host_region: ptr..(ptr + len),
host_region: mem.host_region_base()..mem.host_region_end(),
guest_region: guest_base..(guest_base + len),
flags,
region_type: MemoryRegionType::Heap,
}
}

#[cfg(target_os = "linux")]
fn allocate_guest_memory() -> GuestSharedMemory {
page_aligned_memory(b"test data for snapshot")
}

#[test]
#[cfg(target_os = "linux")]
fn snapshot_restore_handles_remapping_correctly() {
let mut sbox: MultiUseSandbox = {
let path = simple_guest_as_string().unwrap();
Expand Down
Loading
0