wslc: idle-terminate per-user session VMs when inactive by benhillis · Pull Request #40781 · microsoft/WSL

benhillis · 2026-06-11T19:50:18Z

Summary

Idle-terminates a per-user WSLC session's backing VM when it has been inactive, freeing memory while the session object (and its persistent storage) lives on. The VM is transparently recreated on the next operation.

Builds on #40770 (IWSLCVirtualMachineFactory).

Behavior

Only sessions with persistent storage (StoragePath set) idle-terminate.
An idle worker thread tears the VM down after a grace period (currently 30s) once there is no in-flight activity and no active container lock.
In-flight work holds an activity reference so the VM cannot be torn down mid-operation:
- VmLease wraps CLI/container operations.
- BeginContainerOperation hands clients an activity token (IFastRundown so a client crash reclaims it promptly).
- Long-lived root-namespace processes (e.g. plugin hosts) created via CreateRootNamespaceProcess hold a keep-alive token for their lifetime.
Activity bookkeeping (count + wake event) lives in a shared IdleState held via shared_ptr, decoupled from the session's lifetime, so a held token suppresses idle teardown without extending the session object's lifetime (preserving the explicit-reset-invalidates-held-processes invariant from Add WSLC (WSL Containers) feature #40366).

Testing

New WSLCE2EVmIdleTests E2E suite (5 tests) including WSLCE2E_VmIdle_RootProcessKeepsVmAlive.
WSLCTests::CreateRootNamespaceProcess still passes.
Full x64 Debug build clean.

Notes / follow-ups (deferred)

Grace period is a hardcoded constexpr; making it injectable would enable deterministic race tests.
No crash-path (client dies holding token) automated coverage yet.

Note

Draft for early review.

Copilot

Pull request overview

This PR adds on-demand creation and idle-termination of per-user WSLC session VMs (for sessions with persistent storage), so memory can be reclaimed while keeping the session object and storage intact. It also introduces VM-liveness/activity bookkeeping to prevent teardown during in-flight operations and adds new E2E coverage around VM lifecycle behavior.

Changes:

Implement lazy VM bring-up and idle shutdown in wslcsession via an idle worker, activity counting/tokens, and a VmLease used by VM-requiring operations.
Add client-side “operation keep-alive” usage in wslc.exe container operations to prevent VM teardown between OpenContainer and subsequent calls/streaming.
Add a new E2E test suite validating lazy start, idle stop, persistence across restarts, keep-alive for root-namespace processes, and teardown/recreate races.

Reviewed changes

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

Show a summary per file

File	Description
test/windows/wslc/e2e/WSLCE2EVmIdleTests.cpp	New E2E tests covering lazy VM start, idle stop, persistence, keep-alive, and race scenarios.
test/windows/wslc/e2e/WSLCE2EHelpers.h	Exposes the underlying `IWSLCSession*` for diagnostics/test-only calls.
src/windows/wslcsession/WSLCSession.h	Adds VM lifecycle state, idle worker/tokens/lease declarations, and new session methods.
src/windows/wslcsession/WSLCSession.cpp	Implements lazy VM creation, idle teardown, activity tokens, and VM diagnostics reporting.
src/windows/wslcsession/WSLCProcessControl.cpp	Preserves a real exit code when signaling container release, only synthesizing SIGKILL when needed.
src/windows/wslcsession/WSLCProcess.h	Stores a keep-alive token on root-namespace processes to keep the VM alive for their lifetime.
src/windows/wslcsession/WSLCContainer.cpp	Signals idle re-checks on terminal container transitions; holds a VM lease during delete.
src/windows/wslcsession/IORelay.h	Adds `IsRelayThread()` to safely avoid destroying the relay on its own thread.
src/windows/wslcsession/IORelay.cpp	Co-initializes the relay thread into the MTA; implements `IsRelayThread()`.
src/windows/wslc/services/SessionModel.h	Adds a helper to acquire/hold a keep-alive token for client-side container operations.
src/windows/wslc/services/ContainerService.cpp	Uses the keep-alive token across container operations (attach/start/stop/kill/delete/exec/etc.).
src/windows/service/inc/wslc.idl	Adds VM diagnostics type + new session methods for diagnostics and operation keep-alive.
src/windows/service/exe/WSLCSessionManager.cpp	Updates comments to reflect on-demand VM creation and recreation after idle termination.

Copilot

Pull request overview

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

Copilot

Pull request overview

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

Copilot

Pull request overview

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

Copilot

Pull request overview

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

benhillis

Reviewed VM-related comments - all have been addressed:

Comment on WSLCSession.h:84: Already correct - lines 77-78 say "IWSLCVirtualMachineFactory" and "lazily on first use"

Comment on WSLCSession.cpp:571: Fixed by AddRef/Release activity tracking - idle worker checks ActivityCount (line 779), and container proxies increment it on AddRef 1→2 transition. VM will not idle-terminate while clients hold container proxies. See lines 672-674 comment.

Comment on WSLCSession.cpp:380: Already has exception handling - IdleWorker() is wrapped in CATCH_LOG() at lines 375-379

Comment on Session.cpp:65: Already correct - wil::unique_threadpool_wait (line 56) calls WaitForThreadpoolWaitCallbacks in destructor automatically

Copilot

Pull request overview

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

Copilot

Pull request overview

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

Copilot

Pull request overview

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

Copilot

Pull request overview

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

Copilot

Pull request overview

Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.

+    // Signal completion last so any observer of the terminated event sees a fully torn-down
+    // session and a populated termination reason.
+    m_sessionTerminatedEvent.SetEvent();


Per-user WSLC container session VMs now idle-terminate when no container is in a non-terminal (Created/Running) state, freeing host memory, and lazily restart on the next operation that needs the VM. - Centralize VM lifecycle in WSLCSession via TearDownVmLockHeld / StartVmLockHeld and an atomic VmExitDisposition (Active / StopRequested / ExitClaimed) to arbitrate expected stops vs. spontaneous VM exits without a polling thread. - Gate VM-requiring entrypoints behind AcquireVmLease(), which brings the VM up on demand and keeps it alive for the operation's duration. - Add IWSLCSession::BeginContainerOperation so a CLI command can hold the VM alive across resolve + operate + streamed output. - Preserve the session WarningCallback for the lifetime of the session so warnings emitted by the lazy VM start (e.g. resource recovery) are still delivered to the CLI invocation. - Remove the dtor lock in HcsVirtualMachine; OnExit/OnCrash are lock-free. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Only Running containers now hold an activity reference that keeps the per-user session VM alive. Previously a container in either Created or Running state held the reference, so a `create`d-but-never-started container pinned the VM indefinitely and defeated idle termination. A created container's metadata persists on the containerd VHD across VM teardown and is rebuilt by RecoverExistingContainers on the next VM-requiring operation, so create -> idle-terminate -> start later works; the 30s grace period covers the common create-then-start gap. Also fix m_stateChangedAt recovery for created containers: docker inspect reports FinishedAt as the zero date ("0001-01-01T00:00:00Z") for a never-started container, which parsed to year 1 and rendered as "created 2026 years ago". Use the container's Created time for the Created state. This recovery path was previously unreachable, since created containers never got torn down. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Addresses review feedback: WSLCContainer.h still described the activity hold as held while Created/Running, but it now only pins the VM while Running. Update the two header comments to match the implementation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

- Make the VM idle grace period configurable via settings.yaml (session.idleTimeout, default 30s) instead of a hardcoded constant. - Assert UserSid is non-null in PersistSettings rather than tolerating a null SID. - Drop the session warning-callback GIT fallback; warnings emitted outside a callback-bearing operation are logged and event-logged only. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Recovery warnings emitted during lazy VM start run outside the user's current command, so they are now logged (and written to the event log) instead of being routed back to the session-creation warning callback. Update the three WarningCallback*Recovery unit tests and the e2e test to assert the warning is no longer delivered to the session callback / printed on stderr. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

- BeginContainerOperation: reject new operations once the session is terminating/terminated, mirroring EnsureVmRunning's gate, so a started operation cannot pin a VM that is being torn down. - TearDownVmLockHeld: reset m_storageMounted after unmounting so the flag does not stay stale across an idle teardown. - CLI Session model: stop retaining the IWarningCallback for the session lifetime. Recovery warnings from lazy VM start are logged rather than delivered to the session callback, so the stashed callback (and its now-misleading comments) is dead state. The callback is still passed to CreateSession, where it is consumed during initialization. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Probe the storage VHD once with the std::error_code overload so an access-denied/transient I/O error surfaces as a clear Win32 error via WIL instead of a generic filesystem_error-to-HRESULT conversion, and avoid the duplicate exists() check. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Move the VM instance and its lifecycle state (VM, IO relay, docker client, event tracker, volumes, containerd/dockerd processes, exit-disposition and vm-state atomics, session lock, idle state, published-port bookkeeping, and ephemeral swap/storage state) out of WSLCSession into a new WSLCSessionRuntime. WSLCSession retains identity and orchestration and drives the runtime through BringUp/RecoverState/TearDownSessionState/OnSpontaneousExit/OnCrashDump hooks plus a SessionContext carrying the lifecycle primitives the runtime observes, so the runtime no longer reaches into WSLCSession private members. VM state is reached through the runtime, with Acquire()/LockedRuntime as the ergonomic lease accessor. Concurrency invariants are preserved: the exit-disposition claim protocol, the relay-thread teardown guard, lock ordering, GIT re-fetch per VM creation, and release-lock-before-Disarm in shutdown. The VM-exit monitor is armed between bring-up and state recovery to match the pre-extraction ordering. This is an isolated refactor commit on top of the idle-terminate work so it can be reverted independently. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

+        ~ContainerOperation() override
+        {
+            if (m_onRelease)
+            {
+                m_onRelease();
+            }
+        }


+        // N.B. dockerd has exited by this point, so unmounting the VHD is safe since no container can be running.
+        try
+        {
+            m_virtualMachine->Unmount(c_containerdStorage);
+        }
+        CATCH_LOG();


Copilot AI review requested due to automatic review settings June 11, 2026 19:50

Copilot started reviewing on behalf of benhillis June 11, 2026 19:51 View session

Copilot AI reviewed Jun 11, 2026

View reviewed changes

Comment thread src/windows/wslcsession/WSLCSession.h

Comment thread src/windows/service/inc/wslc.idl Outdated

Copilot AI review requested due to automatic review settings June 11, 2026 20:10

Copilot started reviewing on behalf of benhillis June 11, 2026 20:10 View session

Copilot AI reviewed Jun 11, 2026

View reviewed changes

Comment thread src/windows/service/inc/wslc.idl Outdated

Comment thread src/windows/wslcsession/WSLCSession.cpp Outdated

Comment thread src/windows/wslcsession/WSLCSession.cpp Outdated

benhillis force-pushed the user/benhill/wslc-idle-terminate-vm branch from c12d7e1 to fa2eb47 Compare June 12, 2026 01:28

Copilot AI review requested due to automatic review settings June 12, 2026 17:46

benhillis force-pushed the user/benhill/wslc-idle-terminate-vm branch from fa2eb47 to ea2254c Compare June 12, 2026 17:46

Copilot started reviewing on behalf of benhillis June 12, 2026 17:47 View session

Copilot AI reviewed Jun 12, 2026

View reviewed changes

Comment thread src/windows/service/inc/wslc.idl

Comment thread src/windows/service/inc/wslc.idl

Comment thread src/windows/service/inc/wslc.idl Outdated

Copilot AI review requested due to automatic review settings June 12, 2026 20:55

Copilot started reviewing on behalf of benhillis June 12, 2026 20:56 View session

Copilot AI reviewed Jun 12, 2026

View reviewed changes

Comment thread src/windows/service/inc/wslc.idl

Comment thread src/windows/service/inc/wslc.idl

Comment thread src/windows/WslcSDK/wslcsdk.def

Comment thread src/windows/WslcSDK/winrt/Session.cpp

benhillis force-pushed the user/benhill/wslc-idle-terminate-vm branch from b870044 to 4bcd87f Compare June 17, 2026 00:22

Copilot AI review requested due to automatic review settings June 17, 2026 16:21

benhillis force-pushed the user/benhill/wslc-idle-terminate-vm branch from 4bcd87f to 348e2e1 Compare June 17, 2026 16:21

Copilot started reviewing on behalf of benhillis June 17, 2026 16:22 View session

Copilot AI reviewed Jun 17, 2026

View reviewed changes

Comment thread src/windows/service/inc/wslc.idl Outdated

Comment thread test/windows/WSLCTests.cpp

Comment thread test/windows/WSLCTests.cpp

benhillis commented Jun 17, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings June 17, 2026 16:53

Copilot started reviewing on behalf of benhillis June 17, 2026 16:53 View session

Copilot AI reviewed Jun 17, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings June 17, 2026 17:48

Copilot started reviewing on behalf of benhillis June 17, 2026 17:49 View session

Copilot AI reviewed Jun 17, 2026

View reviewed changes

Comment thread src/windows/service/inc/wslc.idl Outdated

Comment thread src/windows/service/inc/wslc.idl Outdated

Comment thread test/windows/WSLCTests.cpp

Comment thread test/windows/WSLCTests.cpp

Copilot AI review requested due to automatic review settings June 17, 2026 21:58

Copilot started reviewing on behalf of benhillis June 17, 2026 21:59 View session

Copilot AI reviewed Jun 17, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings June 18, 2026 16:14

Copilot AI reviewed Jun 30, 2026

View reviewed changes

Comment thread src/windows/wslc/services/SessionService.cpp Outdated

Comment thread src/windows/wslcsession/WSLCSession.cpp Outdated

Comment thread src/windows/wslc/services/SessionModel.h Outdated

Copilot AI review requested due to automatic review settings July 1, 2026 14:59

benhillis force-pushed the user/benhill/wslc-idle-terminate-vm branch from 08096cd to f341cf2 Compare July 1, 2026 14:59

Copilot started reviewing on behalf of benhillis July 1, 2026 15:00 View session

Copilot AI reviewed Jul 1, 2026

View reviewed changes

Comment thread src/windows/wslcsession/WSLCSession.cpp

benhillis force-pushed the user/benhill/wslc-idle-terminate-vm branch from f341cf2 to 721ff66 Compare July 2, 2026 16:24

Copilot AI review requested due to automatic review settings July 2, 2026 16:45

benhillis force-pushed the user/benhill/wslc-idle-terminate-vm branch from 721ff66 to ac638b8 Compare July 2, 2026 16:45

Copilot started reviewing on behalf of benhillis July 2, 2026 16:45 View session

Copilot AI reviewed Jul 2, 2026

View reviewed changes

Comment thread src/windows/wslcsession/WSLCIdleState.h

benhillis force-pushed the user/benhill/wslc-idle-terminate-vm branch from ac638b8 to 1f71ae6 Compare July 2, 2026 17:51

Copilot AI review requested due to automatic review settings July 2, 2026 18:42

benhillis force-pushed the user/benhill/wslc-idle-terminate-vm branch from 1f71ae6 to c4cd3c9 Compare July 2, 2026 18:42

Copilot started reviewing on behalf of benhillis July 2, 2026 18:43 View session

Copilot AI reviewed Jul 2, 2026

View reviewed changes

Comment thread src/windows/wslcsession/WSLCSession.cpp Outdated

Comment on lines +3343 to +3345

// Signal completion last so any observer of the terminated event sees a fully torn-down

// session and a populated termination reason.

m_sessionTerminatedEvent.SetEvent();

Ben Hillis and others added 6 commits July 2, 2026 12:28

benhillis force-pushed the user/benhill/wslc-idle-terminate-vm branch from c4cd3c9 to 1e00556 Compare July 2, 2026 19:28

benhillis force-pushed the user/benhill/wslc-idle-terminate-vm branch from 1e00556 to 2ba60de Compare July 2, 2026 20:07

onomatopellan mentioned this pull request Jul 4, 2026

How to close wslc #40993

Closed

Ben Hillis and others added 2 commits July 6, 2026 11:10

fix formatting

3026df9

Copilot AI review requested due to automatic review settings July 6, 2026 18:21

Copilot started reviewing on behalf of benhillis July 6, 2026 18:22 View session

Copilot AI reviewed Jul 6, 2026

View reviewed changes

Uh oh!

Conversation

benhillis commented Jun 11, 2026

Summary

Behavior

Testing

Notes / follow-ups (deferred)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

benhillis left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!