Skip to content

Add support for TDG.PAGE.RELEASE when TDXConnect is in use.#3748

Open
Raz-Aloni wants to merge 16 commits into
microsoft:mainfrom
Raz-Aloni:page_release
Open

Add support for TDG.PAGE.RELEASE when TDXConnect is in use.#3748
Raz-Aloni wants to merge 16 commits into
microsoft:mainfrom
Raz-Aloni:page_release

Conversation

@Raz-Aloni

Copy link
Copy Markdown

In TDX, on TDs where TDX Connect is enabled, private pages must be explicitly released via TDG.MEM.PAGE.RELEASE before they can be made shared/host-visible, otherwise VMM calls to TDH.MEM.RANGE.BLOCK will fail.

This change modifies both openhcl and openhcl_boot to add a query for TDX Connect enablement on the current TD, and if enabled, TDG.MEM.PAGE.RELEASE calls will be made. TDs without TDXConnect have unchanged behavior.

Raz-Aloni and others added 15 commits June 10, 2026 14:59
Per Intel guidance, TDG.VM.RD on the TD-scope CONFIG_FLAGS field is
sufficient to detect TDX Connect / page-release support, so the
TDG.SYS.RD path (and the global-scope TDX_FEATURES0 metadata) is no
longer needed. Remove the SYS.RD leaf, the tdcall_sys_rd helper,
TdFeatures0, TdgSysRdResult, TDX_FIELD_CODE_TDX_FEATURES0, and all
associated callers in openhcl_boot, hcl, and underhill_mem.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 15, 2026 20:55
@Raz-Aloni Raz-Aloni requested a review from a team as a code owner June 15, 2026 20:55
@github-actions github-actions Bot added the unsafe Related to unsafe code label Jun 15, 2026
@github-actions

Copy link
Copy Markdown

⚠️ Unsafe Code Detected

This PR modifies files containing unsafe Rust code. Extra scrutiny is required during review.

For more on why we check whole files, instead of just diffs, check out the Rustonomicon

@microsoft-github-policy-service

Copy link
Copy Markdown

@Raz-Aloni please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds support for TDX Connect–related behavior by introducing TD configuration flag retrieval (TDG.VM.RD) and implementing page release (TDG.MEM.PAGE.RELEASE) plumbing, then wiring page release into TDX page-visibility transitions.

Changes:

  • Add new TDX definitions for CONFIG_FLAGS metadata and TDG.MEM.PAGE.RELEASE inputs/outputs.
  • Implement TDG.MEM.PAGE.RELEASE + range helper and TDG.VM.RD (CONFIG_FLAGS parsing) in tdcall.
  • Use CONFIG_FLAGS to conditionally require page release before making pages host-visible.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
vm/x86/x86defs/src/tdx.rs Adds leaf/metadata constants and bitfield structs for config flags + page release.
vm/x86/tdcall/src/lib.rs Implements TDG.MEM.PAGE.RELEASE, range release helper, and TDG.VM.RD for CONFIG_FLAGS.
openhcl/underhill_mem/src/lib.rs Conditionally calls TDX page release when unaccepting pages under TDX Connect.
openhcl/openhcl_boot/src/arch/x86_64/tdx.rs Calls page release before host-visible mapping when TDX Connect is enabled and caches CONFIG_FLAGS.
openhcl/hcl/src/ioctl/tdx.rs Exposes VTL helpers for config flag read and page release TDCalls.

Comment thread vm/x86/x86defs/src/tdx.rs
pub level: TdgMemPageLevel,
#[bits(9)]
pub reserved: u64,
/// The page number for this accept call.
Comment thread vm/x86/x86defs/src/tdx.rs
pub level: TdgMemPageLevel,
#[bits(9)]
pub reserved: u64,
/// The page number for this accept call.
Comment thread vm/x86/x86defs/src/tdx.rs
Comment on lines +198 to +199
#[bits(1)]
pub reserved3: u8,
Comment thread vm/x86/tdcall/src/lib.rs
Comment on lines +357 to +358
#[error("page size mismatch. Expected size {1:?}: {0:?}")]
PageSizeMismatch(TdCallResultCode, TdgMemPageLevel),
Comment on lines +243 to +248
let config_flags = mshv_vtl.tdx_get_config_flags();
if config_flags.tdx_connect() {
assert!(config_flags.page_release());

flags.tdx_page_release_required = true;
}
Comment on lines +312 to +316
if self.flags.tdx_page_release_required {
self.mshv_vtl
.tdx_release_pages(range)
.expect("Failed to release pages");
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

no this should be expect. but you should put the range of the page that failed to release (or what page it was) as part of the expect failure

Comment on lines +136 to +138
// If TDX Connect is present, then TDG.MEM.PAGE.RELEASE must be called before making pages host-visible.
if host_visible && get_td_config_flags().tdx_connect() {
assert!(get_td_config_flags().page_release());
Comment thread vm/x86/tdcall/src/lib.rs
&& range.len() >= x86defs::X64_LARGE_PAGE_SIZE
{
if let Err(e) = tdcall_release_page(call, range.start_4k_gpn(), true) {
match e {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Since we're only checking for one variant I feel like this would read cleaner as an if let instead of a match.

Comment thread vm/x86/tdcall/src/lib.rs
pub fn tdcall_vm_rd(
call: &mut impl Tdcall,
field_id: TdxExtendedFieldCode,
) -> Result<TdgVmRdResult, TdCallResult> {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would it be cleaner to just return r8 and let the caller construct the enum? That way all callers of this method wouldn't have to worry about the case of getting the wrong output type somehow. Maybe we could even have each caller pass in their expected field_id, and this method could turn a mismatch into an error/panic.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

some kind of enum or generic function? I do agree that the fact that callers have to do this unreachable! dance means this API is wrong.

@github-actions

Copy link
Copy Markdown

@chris-oo chris-oo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

see feedback. what is the timeline for us to have this path tested in ci?

Comment thread vm/x86/x86defs/src/tdx.rs
}

#[bitfield(u64)]
pub struct TdConfigFlags {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

can we link to all the defns here to the corresponding defn in intel's specifications?

Comment thread vm/x86/tdcall/src/lib.rs
pub fn tdcall_vm_rd(
call: &mut impl Tdcall,
field_id: TdxExtendedFieldCode,
) -> Result<TdgVmRdResult, TdCallResult> {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

some kind of enum or generic function? I do agree that the fact that callers have to do this unreachable! dance means this API is wrong.

Comment thread vm/x86/tdcall/src/lib.rs

let mut range = range;
while !range.is_empty() {
// Attempt to release in large page chunks, if possible.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

don't we do this pattern somewhere else in the file? should we have a common fn op for this?

Comment on lines +312 to +316
if self.flags.tdx_page_release_required {
self.mshv_vtl
.tdx_release_pages(range)
.expect("Failed to release pages");
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

no this should be expect. but you should put the range of the page that failed to release (or what page it was) as part of the expect failure

let mut flags = MemoryAcceptorFlags::default();

if isolation == IsolationType::Tdx {
// Check if TDX Connect is enabled on this TD. If so, page release is required when

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why do we do this, instead of just checking for page release?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

unsafe Related to unsafe code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants