Partial SDK implementation by JohnMcPMS · Pull Request #14214 · microsoft/WSL

JohnMcPMS · 2026-02-13T01:46:06Z

[Replaces #14211 with an unforked branch]

Summary of the Pull Request

Implements enough of the SDK for the sample demo to operate.

PR Checklist

Closes: Link to issue #xxx
Communication: I've discussed this with core contributors already. If work hasn't been agreed, this work might be rejected
Tests: Added/updated if needed and all pass
Localization: All end user facing strings can be localized
Dev docs: Added/updated if needed
Documentation updated: If checked, please file a pull request on our docs repo and link it here: #xxx

Detailed Description of the Pull Request / Additional comments

Implements the functions called by the sample demo (as well as a few more trivial functions). These are implemented as best as possible, but there are several TODO callouts for updates that are likely needed to the SDK API surface to account for disparities with the runtime API. I intentionally did not make those changes to the SDK in this PR to limit the friction so that it might get merged sooner. I plan to make a follow-up PR with those changes that can have more/longer discussions.

Additionally, tests are not added for the SDK with this PR at this time. Again, a fast follow-up PR is expected to start adding those tests. Recommendation for new or existing test project are welcome.

Finally, I left the changes that were merged in #14187 to discuss how mainline changes should make it to the feature branch (as I'm dependent on this change for my machine setup to build WSL). Happy to remove it late in the PR process so I can keep building without constant git juggling.

Validation Steps Performed

Sample demo runs successfully and can be run multiple times.

…test

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Implements additional portions of the Windows WSL Container SDK (WSLC) so the sample/demo can run end-to-end against the WSLA runtime COM interfaces.

Changes:

Implements substantial parts of session/container/process SDK entry points (create/terminate/release, container create/start/stop/delete, process handle getters, image pull).
Introduces COM callback adapters (IProgressCallback, ITerminationCallback) to bridge runtime callbacks to SDK callbacks.
Refactors internal opaque settings/handle plumbing (private internal structs, size adjustments, internal type helpers) and wires new sources into the build.

Reviewed changes

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

Show a summary per file

File	Description
src/windows/WslcSDK/wslcsdk.h	Updates public SDK surface (opaque struct size, container create signature).
src/windows/WslcSDK/wslcsdk.cpp	Implements many previously-stubbed SDK APIs and bridges to WSLA runtime COM interfaces.
src/windows/WslcSDK/WslcsdkPrivate.h	Adds/updates internal struct definitions and internal-type helper macros.
src/windows/WslcSDK/WslcsdkPrivate.cpp	Implements internal handle/settings reinterpret-casts.
src/windows/WslcSDK/ProgressCallback.h / .cpp	Adds adapter implementing `IProgressCallback` for image pull progress.
src/windows/WslcSDK/TerminationCallback.h / .cpp	Adds adapter implementing `ITerminationCallback` for session termination notifications.
src/windows/WslcSDK/CMakeLists.txt	Adds new callback/private implementation files to the build.

Copilot · 2026-02-13T01:53:11Z

src/windows/WslcSDK/wslcsdk.h

+STDAPI WslcContainerCreate(_In_ WslcSession session, _In_ WslcContainerSettings* containerSettings, _Out_ WslcContainer* container, _Outptr_opt_result_z_ PWSTR* errorMessage);



WslcContainerCreate is an exported C API (see wslcsdk.def) and its signature was changed by adding a WslcSession parameter. This is a binary-breaking ABI change for any existing callers that link against the DLL. If compatibility is required, consider keeping the old entry point and adding a new function (e.g. WslcContainerCreate2) or otherwise versioning the DLL/API surface explicitly.

Suggested change

STDAPI WslcContainerCreate(_In_ WslcSession session, _In_ WslcContainerSettings* containerSettings, _Out_ WslcContainer* container, _Outptr_opt_result_z_ PWSTR* errorMessage);

STDAPI WslcContainerCreate(_In_ WslcContainerSettings* containerSettings, _Out_ WslcContainer* container, _Outptr_opt_result_z_ PWSTR* errorMessage);

STDAPI WslcContainerCreate2(_In_ WslcSession session, _In_ WslcContainerSettings* containerSettings, _Out_ WslcContainer* container, _Outptr_opt_result_z_ PWSTR* errorMessage);

Copilot · 2026-02-13T01:53:11Z

src/windows/WslcSDK/WslcsdkPrivate.h

+// Converts to a unique_ptr of the internal type and returns an error on null input.
+// Use for Release functions to clean up the implementation object on return.
+#define WSLC_GET_INTERNAL_TYPE_FOR_RELEASE(_input_) \
+    std::unique_ptr<std::remove_pointer_t<decltype(GetInternalType(_input_))>>{GetInternalType(_input_)}; \
+    RETURN_HR_IF_NULL(E_POINTER, _input_)\


WSLC_GET_INTERNAL_TYPE_FOR_RELEASE has the same multi-statement / hidden-return fragility as WSLC_GET_INTERNAL_TYPE, and additionally it’s easy to accidentally create a temporary unique_ptr (deleting the handle immediately) when used as a standalone statement. Consider making the lifetime/ownership explicit in the Release functions instead of encoding it in a macro.

Copilot · 2026-02-13T01:53:12Z

src/windows/WslcSDK/ProgressCallback.h

+--*/
+#pragma once
+#include "wslaservice.h"
+#include "wslcsdkprivate.h"


Header include casing is inconsistent with the actual filename (WslcsdkPrivate.h). Using #include "wslcsdkprivate.h" can break builds on case-sensitive filesystems/tools. Please match the on-disk casing consistently across the project.

Suggested change

#include "wslcsdkprivate.h"

#include "WslcsdkPrivate.h"

Copilot · 2026-02-13T01:53:12Z

src/windows/WslcSDK/wslcsdk.cpp

+
+    auto result = std::make_unique<WslcProcessImpl>();
+
+    RETURN_IF_FAILED(internalType->container->GetInitProcess(&result->process));


The returned IWSLAProcess from GetInitProcess is not passed through ConfigureForCOMImpersonation, unlike other call sites in the repo (e.g. WSLAProcessLauncher). This can lead to access/impersonation failures when the caller later uses the process interface. Configure COM impersonation on result->process before returning the handle.

Suggested change

RETURN_IF_FAILED(internalType->container->GetInitProcess(&result->process));

RETURN_IF_FAILED(internalType->container->GetInitProcess(&result->process));

RETURN_IF_FAILED(ConfigureForCOMImpersonation(result->process.Get()));

Copilot · 2026-02-13T01:53:12Z

src/windows/WslcSDK/wslcsdk.cpp

+    // TODO: Resolve massive disparity between 32-bit unsigned millisecond input and 64-bit signed second target timeouts
+    RETURN_HR(internalType->container->Stop(convertedSignal.value(), timeoutMS / 1000));


timeoutMS is documented/typed as milliseconds but is converted to seconds via integer division (timeoutMS / 1000), which truncates sub-second timeouts to 0 and changes semantics. Consider rounding up (e.g. (timeoutMS + 999) / 1000) and casting to the runtime’s LONGLONG seconds type, or otherwise clearly defining how sub-second values should behave.

Suggested change

// TODO: Resolve massive disparity between 32-bit unsigned millisecond input and 64-bit signed second target timeouts

RETURN_HR(internalType->container->Stop(convertedSignal.value(), timeoutMS / 1000));

// Convert milliseconds to seconds for the underlying API, rounding up and widening to 64-bit signed.

const auto timeoutSeconds =

static_cast<LONGLONG>((static_cast<uint64_t>(timeoutMS) + 999ull) / 1000ull);

RETURN_HR(internalType->container->Stop(convertedSignal.value(), timeoutSeconds));

Copilot · 2026-02-13T01:53:12Z

src/windows/WslcSDK/WslcsdkPrivate.h

+// Converts to the internal type and returns an error on null input.
+#define WSLC_GET_INTERNAL_TYPE(_input_) \
+    GetInternalType(_input_); \
+    RETURN_HR_IF_NULL(E_POINTER, _input_)
+


The WSLC_GET_INTERNAL_TYPE macro expands to multiple statements and includes an early-return (RETURN_HR_IF_NULL). This makes it fragile (e.g., it cannot be used as a normal expression argument) and obscures control flow. Consider replacing it with explicit RETURN_HR_IF_NULL + GetInternalType(...) statements at call sites, or reworking into a safer helper pattern (e.g., a small inline function that returns HRESULT and sets an out param).

Copilot · 2026-02-13T01:53:13Z

src/windows/WslcSDK/TerminationCallback.h

+--*/
+#pragma once
+#include "wslaservice.h"
+#include "wslcsdkprivate.h"


Header include casing is inconsistent with the actual filename (WslcsdkPrivate.h). Using #include "wslcsdkprivate.h" can break builds on case-sensitive filesystems/tools. Please match the on-disk casing consistently across the project.

Suggested change

#include "wslcsdkprivate.h"

#include "WslcsdkPrivate.h"

Copilot · 2026-02-13T01:53:13Z

src/windows/WslcSDK/WslcsdkPrivate.cpp

+--*/
+#include "precomp.h"
+
+#include "wslcsdkprivate.h"


Include casing is inconsistent with the actual filename (WslcsdkPrivate.h). Using #include "wslcsdkprivate.h" can break builds on case-sensitive filesystems/tools. Please match the on-disk casing consistently across the project.

Suggested change

#include "wslcsdkprivate.h"

#include "WslcsdkPrivate.h"

Copilot · 2026-02-13T01:53:13Z

src/windows/WslcSDK/wslcsdk.cpp

+        // TODO: Runtime needs an update to take in LPCSTR const*
+        containerOptions.InitProcessOptions.CommandLine.Values = const_cast<LPCSTR*>(initProcessOptions->commandLine);
+        containerOptions.InitProcessOptions.CommandLine.Count = initProcessOptions->commandLineCount;
+        containerOptions.InitProcessOptions.Environment.Values = const_cast<LPCSTR*>(initProcessOptions->environment);
+        containerOptions.InitProcessOptions.Environment.Count = initProcessOptions->environmentCount;


const_cast is used to pass commandLine/environment arrays into WSLAStringArray.Values. This weakens const-correctness and could be unsafe if the callee ever writes to the array. Prefer building a temporary mutable std::vector<LPCSTR> (or adjusting the internal storage type) to avoid casting away const.

JohnMcPMS and others added 24 commits February 9, 2026 15:00

Add Clang requirement to vswhere usage

694443e

EOD checkin - session settings done, creation needs work

437a912

Primary session management implemented, needs TODOs looked at, needs …

4216049

…test

Merge from user/rechfr

cb3f04d

Post-merge fixes and implementations

5fca876

Pull image almost impl

243d358

WSLA error info wrapper and use

ca94797

Merge from user/richfr

6ca21d3

Merge branch 'user/richfr' into sdk-session

d15c57e

Update for wsla feature merge

694734e

Implement for demo and fixes for same

3181022

Swap to always attach at container start

37e9a89

Merge from user/richfr

877bf26

Update for pull and implement container flags and delete

4557def

clang format

7f800ed

implement getprocessexitevent

d33a7fa

Merge branch 'feature/wsl-for-apps' into sdk-session

144d00c

cleanup

bc357c7

clang format

0bdb1df

clang format

f542a14

Update src/windows/WslcSDK/ProgressCallback.h

c65c4a2

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

PR feedback

61f1c5e

clang format

32d797b

Revert cmake cp

713dff4

JohnMcPMS requested a review from a team as a code owner February 13, 2026 01:46

Copilot AI review requested due to automatic review settings February 13, 2026 01:46

Copilot started reviewing on behalf of JohnMcPMS February 13, 2026 01:46 View session

JohnMcPMS changed the title ~~User/johnmcpms/sdk demo~~ Partial SDK implementation Feb 13, 2026

Copilot AI reviewed Feb 13, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Partial SDK implementation#14214

Partial SDK implementation#14214
JohnMcPMS wants to merge 24 commits intofeature/wsl-for-appsfrom
user/johnmcpms/sdk-demo

JohnMcPMS commented Feb 13, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		STDAPI WslcContainerCreate(_In_ WslcSession session, _In_ WslcContainerSettings* containerSettings, _Out_ WslcContainer* container, _Outptr_opt_result_z_ PWSTR* errorMessage);

-STDAPI WslcContainerCreate(_In_ WslcSession session, _In_ WslcContainerSettings* containerSettings, _Out_ WslcContainer* container, _Outptr_opt_result_z_ PWSTR* errorMessage);
+STDAPI WslcContainerCreate(_In_ WslcContainerSettings* containerSettings, _Out_ WslcContainer* container, _Outptr_opt_result_z_ PWSTR* errorMessage);
+STDAPI WslcContainerCreate2(_In_ WslcSession session, _In_ WslcContainerSettings* containerSettings, _Out_ WslcContainer* container, _Outptr_opt_result_z_ PWSTR* errorMessage);


		auto result = std::make_unique<WslcProcessImpl>();

		RETURN_IF_FAILED(internalType->container->GetInitProcess(&result->process));

	RETURN_IF_FAILED(internalType->container->GetInitProcess(&result->process));
	RETURN_IF_FAILED(internalType->container->GetInitProcess(&result->process));
	RETURN_IF_FAILED(ConfigureForCOMImpersonation(result->process.Get()));

		// TODO: Resolve massive disparity between 32-bit unsigned millisecond input and 64-bit signed second target timeouts
		RETURN_HR(internalType->container->Stop(convertedSignal.value(), timeoutMS / 1000));

-    // TODO: Resolve massive disparity between 32-bit unsigned millisecond input and 64-bit signed second target timeouts
-    RETURN_HR(internalType->container->Stop(convertedSignal.value(), timeoutMS / 1000));
+    // Convert milliseconds to seconds for the underlying API, rounding up and widening to 64-bit signed.
+    const auto timeoutSeconds =
+        static_cast<LONGLONG>((static_cast<uint64_t>(timeoutMS) + 999ull) / 1000ull);
+    RETURN_HR(internalType->container->Stop(convertedSignal.value(), timeoutSeconds));

Conversation

JohnMcPMS commented Feb 13, 2026

Summary of the Pull Request

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant