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

Jump to bottom

Change host's memory setup to be minimally configured #297

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

Change host's memory setup to be minimally configured #297

wants to merge 10 commits into from

Conversation

danbugs
Copy link
Contributor

@danbugs danbugs commented Feb 27, 2025 •
edited
Loading

We want to allow embedding custom guests in Hyperlight, but, currently, the static memory layout we configure in the host is too strict. This PR is modifying our memory layout to be minimally configured.

Here's an example of how a guest could address its memory:
image

Changes:

  • BASE_ADDRESS modified to be 0x0 instead of 0x200_000 (2MB), removing the arbitrary unmapped section of memory.
  • Moved guest code section to be at 0x0, shifting paging sections up.
  • Added undifferentiated custom guest memory section that the guest can address in any way it wants.
  • Added API in common library to allow the guest to address the undifferentiated memory region.
  • Introduces SandboxBuilder API.
  • Removes MemMgrWrapper abstraction.

TODO:

  • fix tests/fuzzing/examples
  • make it work for all drivers,
  • remove uneeded entrypoint param,
  • add OutBAction::DebugPrint instead of HostPrint host fxn,
  • test Nanvix compat,
  • set right rsp,
  • reconsider host error and host fxn details memory sections, and
  • re-evaluate SandboxMemoryManager API surface.

@danbugs danbugs added kind/refactor For PRs that restructure or remove code without adding new functionality. kind/enhancement For PRs adding features, improving functionality, docs, tests, etc. labels Feb 27, 2025
danbugs added a commit to danbugs/hyperlight that referenced this pull request Feb 27, 2025
@danbugs
[host/hypervisor_handler,host/mem/{layout,mgr},docs/paging] moved gue…
56852a6 
…st code to start at 0x0

instead of after paging sections

This is the first step in moving memory sections around to provide a more generic
layout. After this, I'll move continue moving sections to fulfill the layout shown
in the description for PR hyperlight-dev#297.

Changes:
- removed no longer applicable checks in hypervisor_handler
- changed the way we build memory in get_memory_regions
- added functions to get the offsets/addresses to paging sections
as they are no longer static from 0x0 and are now relative to code size
- updated code docs
- changed set_up_shared_memory to properly place paging sections
- updated paging docs

Signed-off-by: danbugs <[email protected]>
danbugs added a commit to danbugs/hyperlight that referenced this pull request Feb 27, 2025
@danbugs
[host/hypervisor_handler,host/mem/{layout,mgr},docs/paging] moved gue…
40a8091 
…st code to start at 0x0

instead of after paging sections

This is the first step in moving memory sections around to provide a more generic
layout. After this, I'll move continue moving sections to fulfill the layout shown
in the description for PR hyperlight-dev#297.

Changes:
- removed no longer applicable checks in hypervisor_handler
- changed the way we build memory in get_memory_regions
- added functions to get the offsets/addresses to paging sections
as they are no longer static from 0x0 and are now relative to code size
- updated code docs
- changed set_up_shared_memory to properly place paging sections
- updated paging docs

Signed-off-by: danbugs <[email protected]>
@danbugs danbugs force-pushed the danbugs/memory-layout branch from 56852a6 to 40a8091 Compare February 27, 2025 16:59
danbugs added a commit to danbugs/hyperlight that referenced this pull request Feb 28, 2025
@danbugs
[host/hypervisor_handler,host/mem/{layout,mgr},docs/paging] moved gue…
975d98a 
…st code to start at 0x0

instead of after paging sections

This is the first step in moving memory sections around to provide a more generic
layout. After this, I'll move continue moving sections to fulfill the layout shown
in the description for PR hyperlight-dev#297.

Changes:
- removed no longer applicable checks in hypervisor_handler
- changed the way we build memory in get_memory_regions
- added functions to get the offsets/addresses to paging sections
as they are no longer static from 0x0 and are now relative to code size
- updated code docs
- changed set_up_shared_memory to properly place paging sections
- updated paging docs

Signed-off-by: danbugs <[email protected]>
@danbugs danbugs force-pushed the danbugs/memory-layout branch 3 times, most recently from b7435ae to ce255f8 Compare February 28, 2025 02:06
danbugs added a commit to danbugs/hyperlight that referenced this pull request Mar 17, 2025
@danbugs
[host/hypervisor_handler,host/mem/{layout,mgr},docs/paging] moved gue…
62f0f4b 
…st code to start at 0x0

instead of after paging sections

This is the first step in moving memory sections around to provide a more generic
layout. After this, I'll move continue moving sections to fulfill the layout shown
in the description for PR hyperlight-dev#297.

Changes:
- removed no longer applicable checks in hypervisor_handler
- changed the way we build memory in get_memory_regions
- added functions to get the offsets/addresses to paging sections
as they are no longer static from 0x0 and are now relative to code size
- updated code docs
- changed set_up_shared_memory to properly place paging sections
- updated paging docs

Signed-off-by: danbugs <[email protected]>
@danbugs danbugs force-pushed the danbugs/memory-layout branch from 8aa7f89 to f21aabc Compare March 17, 2025 00:46
danbugs added a commit to danbugs/hyperlight that referenced this pull request Mar 17, 2025
@danbugs
[host/hypervisor_handler,host/mem/{layout,mgr},docs/paging] moved gue…
c399031 
…st code to start at 0x0

instead of after paging sections

This is the first step in moving memory sections around to provide a more generic
layout. After this, I'll move continue moving sections to fulfill the layout shown
in the description for PR hyperlight-dev#297.

Changes:
- removed no longer applicable checks in hypervisor_handler
- changed the way we build memory in get_memory_regions
- added functions to get the offsets/addresses to paging sections
as they are no longer static from 0x0 and are now relative to code size
- updated code docs
- changed set_up_shared_memory to properly place paging sections
- updated paging docs

Signed-off-by: danbugs <[email protected]>
@danbugs danbugs force-pushed the danbugs/memory-layout branch from f21aabc to 53069f2 Compare March 17, 2025 15:50
@ludfjig ludfjig mentioned this pull request Mar 17, 2025
Closed
danbugs added a commit to danbugs/hyperlight that referenced this pull request Mar 19, 2025
@danbugs
[docs] updates paging docs
e2a0ab9 
In hyperlight-dev#297, we make the base address of guest memory 0x0 instead of 0x200_000 and
remove statically defined memory regions. This commit updates documentation in
accordance to these changes.

Signed-off-by: danbugs <[email protected]>
@danbugs danbugs force-pushed the danbugs/memory-layout branch 2 times, most recently from 4980140 to 3212be7 Compare March 19, 2025 05:31
danbugs added a commit to danbugs/hyperlight that referenced this pull request Mar 19, 2025
@danbugs
[docs] updates paging docs
f8a7ef6 
In hyperlight-dev#297, we make the base address of guest memory 0x0 instead of 0x200_000 and
remove statically defined memory regions. This commit updates documentation in
accordance to these changes.

Signed-off-by: danbugs <[email protected]>
@danbugs danbugs force-pushed the danbugs/memory-layout branch from 3212be7 to be061f0 Compare March 19, 2025 05:31
danbugs added a commit to danbugs/hyperlight that referenced this pull request Mar 19, 2025
@danbugs
[docs] updates paging docs
bb70eed 
In hyperlight-dev#297, we make the base address of guest memory 0x0 instead of 0x200_000 and
remove statically defined memory regions. This commit updates documentation in
accordance to these changes.

Signed-off-by: danbugs <[email protected]>
@danbugs danbugs force-pushed the danbugs/memory-layout branch from be061f0 to 76d67a8 Compare March 19, 2025 15:23
@danbugs danbugs mentioned this pull request Mar 19, 2025
Open
@danbugs danbugs removed the kind/refactor For PRs that restructure or remove code without adding new functionality. label Mar 19, 2025
danbugs added 7 commits April 11, 2025 16:32
@danbugs
[.gitignore] added .gdbinit to .gitignore
c70c67b 
Signed-off-by: danbugs <[email protected]>
@danbugs
[docs] updates paging docs
8324280 
In hyperlight-dev#297, we make the base address of guest memory 0x0 instead of 0x200_000 and
remove statically defined memory regions. This commit updates documentation in
accordance to these changes.

Signed-off-by: danbugs <[email protected]>
@danbugs
[host/{mem/layout,sandbox/mem_mgr}] removes statically defined mem la…
2a364b2 
…yout + removes MemMgrWrapper

This commit completely removes the file w/ the mem layout. There are still
references to it around, but those will be removed in subsequent commits.

With the upcoming refactors, there is no need for the MemMgrWrapper abstraction. This
commit removes in in favour of directly utilizing a SandboxMemoryManager<S> in subsequent
commits.

Signed-off-by: danbugs <[email protected]>
@danbugs
[common,guest] added peb and input/output API to common library
35e2036 
- removes old HyperlightPEB structures (making it more idiomatic Rust).
- removes input/output structures from guest library, moving it to common as they
will need to be used by external guests.
- creates new HyperlightPEB API w/ capabilities to address memory regions from the guest.

Signed-off-by: danbugs <[email protected]>
@danbugs
[host/{mem/region,sandbox{config,builder,uninit}] introduces SandboxB…
91fb8f3 
…uilder

This commit partially introduces the SandboxBuilder mentioned on hyperlight-dev#249, changing
the way we create uninitialized sandboxes.

- adds SandboxBuilder API, which allows for a more flexible memory setup.
- changes to uninit w/ how it is created.
- deletes memory_region.rs file w/ most of it being superseded by the SandboxBuilder structures.
- simplifies config.rs removing all items related to previous static memory layout.

Signed-off-by: danbugs <[email protected]>
@danbugs
[guest,tests/rust_guests] change guest library to conform to new APIs…
5eae452 
… in common library and use CGM

The host now defines a single undifferentiated memory region—the custom guest memory region (or, CGM)—that
the guest can address as it sees fit. This commit changes the guest library to leverage that and perform
said address using the APIs defined in the common library.

Signed-off-by: danbugs <[email protected]>
@danbugs
[host/mem/mgr] changes SandboxMemoryManager API to interact w/ CGM
e39a75c 
- removes static layout from SandboxMemoryManager, adds SandboxMemorySections structure built
w/ the SandboxBuilder.
- updates paging to reflect usage of dynamic memory layout.
- interact with common APIs.
- add APIs to allow reading addressed memory sections in PEB from shared memory.

Signed-off-by: danbugs <[email protected]>
danbugs added 3 commits April 11, 2025 16:36
@danbugs
[host/*] change API usage (MemoryRegions, MemMgrWrapper, etc.) across…
588af6f 
… codebase

- temporarily comment out a lot of code (e.g., host/testing/mod.rs).
- temporarily unuse seccomp stuff.
- start using new mgr API and common API.
- pending removal of writting host detail functions to memory.
- change hv_handler to use new mgr API to get guest_function_dispatch_ptr.
- remove layout/memory_region from mod.rs.
- change RawPtr API (should probably be re-evaluated).

Signed-off-by: danbugs <[email protected]>
@danbugs
[host/hypervisor/[*]] update drivers to use CGM
f67ac9f 
Updates drivers to map memory region in accordance to CGM usage.

> Note: only updated KVM fully so far. WHP and inprocess drivers are TODOs.

Signed-off-by: danbugs <[email protected]>
@danbugs
[*] clippy fix and fmt
9d7ec36 
Signed-off-by: danbugs <[email protected]>
@danbugs danbugs force-pushed the danbugs/memory-layout branch from 76d67a8 to 9d7ec36 Compare April 11, 2025 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
kind/enhancement For PRs adding features, improving functionality, docs, tests, etc.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@danbugs