Refactor container port mapping logic by OneBlue · Pull Request #14469 · microsoft/WSL

OneBlue · 2026-03-18T19:25:45Z

Summary of the Pull Request

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

Validation Steps Performed

Copilot

Pull request overview

This PR refactors WSLA container port-mapping handling to carry richer mapping metadata (protocol + binding address), centralize VM-port allocation via RAII, and adjust the WSLA test harness accordingly.

Changes:

Introduces RAII-based VM port allocation/mapping types (VmPortAllocation, VMPortMapping) and updates VM/session APIs to use them.
Extends port-mapping metadata and IDL structs to include protocol + binding address, with new IP parsing helpers.
Updates WSLA test launcher and Windows tests to use the new port-mapping shape/behavior (including bridged-mode expectations).

Reviewed changes

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

Show a summary per file

File	Description
test/windows/WSLATests.cpp	Updates port-mapping and inspect tests for bridged networking + binding address changes.
src/windows/wslasession/WSLAVirtualMachine.h	Adds `VmPortAllocation`/`VMPortMapping` and updates port-mapping/port-allocation APIs.
src/windows/wslasession/WSLAVirtualMachine.cpp	Implements new RAII allocation/mapping behavior and relay mapping entry points.
src/windows/wslasession/WSLASession.h	Updates testing-only VM port-map COM methods to use `unsigned short` ports.
src/windows/wslasession/WSLASession.cpp	Adapts MapVmPort/UnmapVmPort to new VM port-mapping API.
src/windows/wslasession/WSLAContainerMetadata.h	Extends serialized container port metadata (protocol + binding address).
src/windows/wslasession/WSLAContainer.h	Switches container port storage to `ContainerPortMapping` with `VMPortMapping`.
src/windows/wslasession/WSLAContainer.cpp	Refactors port processing, allocation, mapping/unmapping, and recovery logic around new mapping types.
src/windows/wslaservice/inc/wslaservice.idl	Extends `WSLAPortMapping` and updates MapVmPort/UnmapVmPort signatures.
src/windows/common/wslutil.h	Adds IP parsing helper declarations.
src/windows/common/wslutil.cpp	Implements IP parsing helpers with localized user errors.
src/windows/common/WSLAContainerLauncher.h	Extends AddPort API to accept protocol + binding address and stores address lifetime.
src/windows/common/WSLAContainerLauncher.cpp	Populates new `WSLAPortMapping` fields and ensures binding address pointer stability.
localization/strings/en-US/Resources.resw	Adds a localized “invalid IP address” message.

src/windows/wslaservice/inc/wslaservice.idl

src/windows/wslasession/WSLAContainer.cpp

src/windows/wslasession/WSLAVirtualMachine.cpp

src/windows/wslasession/WSLAContainer.cpp

src/windows/wslasession/WSLAContainerMetadata.h

src/windows/wslasession/WSLASession.cpp

test/windows/WSLATests.cpp

src/windows/wslasession/WSLAContainer.cpp

Copilot

Pull request overview

This PR refactors WSLA container port-mapping to introduce explicit protocol + binding-address handling and to centralize VM port allocation/mapping via new VMPortMapping / VmPortAllocation types. It updates container creation/recovery and test coverage to reflect the new port-mapping behavior.

Changes:

Introduces VMPortMapping + VmPortAllocation abstractions and refactors VM port allocation/mapping APIs accordingly.
Extends WSLAPortMapping (IDL + launcher + metadata) with Protocol and BindingAddress, and threads these through container create/open/start flows.
Updates WSLA port-mapping tests and adds new negative-path validation cases.

Reviewed changes

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

Show a summary per file

File	Description
test/windows/WSLATests.cpp	Updates port-mapping tests for IPv6 bind behavior and adds error-path assertions.
src/windows/wslrelay/localhost.cpp	Adds address family information to port relay TraceLogging events.
src/windows/wslasession/WSLAVirtualMachine.h	Adds new port allocation/mapping types and updates Map/Unmap/TryAllocate APIs.
src/windows/wslasession/WSLAVirtualMachine.cpp	Implements new allocation/mapping logic and binding address parsing/stringification.
src/windows/wslasession/WSLASession.h	Tracks test-only VM port allocations to support MapVmPort/UnmapVmPort changes.
src/windows/wslasession/WSLASession.cpp	Refactors MapVmPort/UnmapVmPort to allocate/reserve ports and map using `VMPortMapping`.
src/windows/wslasession/WSLAContainerMetadata.h	Extends serialized container metadata port mapping schema with protocol + binding address.
src/windows/wslasession/WSLAContainer.h	Refactors container port mapping representation and adds MapPorts/UnmapPorts helpers.
src/windows/wslasession/WSLAContainer.cpp	Refactors port processing, mapping/unmapping lifecycle, and container recovery for port reservations.
src/windows/wslaservice/inc/wslaservice.idl	Extends `WSLAPortMapping` and updates MapVmPort/UnmapVmPort signatures.
src/windows/common/wslutil.h	Adds IPv4/IPv6 address parsing helpers.
src/windows/common/wslutil.cpp	Implements address parsing helpers with localized invalid-IP errors.
src/windows/common/WSLAContainerLauncher.h	Extends AddPort to include protocol and binding address; stores binding address strings.
src/windows/common/WSLAContainerLauncher.cpp	Populates new `WSLAPortMapping` fields and ensures binding address lifetime.
localization/strings/en-US/Resources.resw	Adds localized message for invalid IP address.

test/windows/WSLATests.cpp

src/windows/wslasession/WSLAVirtualMachine.cpp

src/windows/wslasession/WSLAContainer.cpp

test/windows/WSLATests.cpp

src/windows/common/wslutil.h

src/windows/common/wslutil.cpp

src/windows/wslasession/WSLAContainerMetadata.h

test/windows/WSLATests.cpp

Copilot

Pull request overview

Refactors container port mapping to support protocol/binding address metadata and centralize VM port allocation/mapping behavior across session/container lifecycles.

Changes:

Introduces VMPortMapping / VmPortAllocation RAII types and updates VM port mapping APIs to consume them.
Extends port mapping schema/IDL/metadata to include protocol and binding address; updates container creation/open/start/cleanup flows accordingly.
Updates tests and adds new negative-path coverage (invalid IP, invalid protocol/family, unsupported UDP/custom bind).

Reviewed changes

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

Show a summary per file

File	Description
test/windows/WSLATests.cpp	Updates networking mode expectations, IPv6 binding, and adds new port-mapping error-path tests.
src/windows/wslrelay/localhost.cpp	Adds address-family tracing to relay start/stop and port mapping logs.
src/windows/wslasession/WSLAVirtualMachine.h	Adds `VmPortAllocation` / `VMPortMapping` types; updates VM port mapping/allocation API signatures.
src/windows/wslasession/WSLAVirtualMachine.cpp	Implements new mapping/allocation logic and validation based on protocol/binding address.
src/windows/wslasession/WSLASession.h	Adds test-only allocation tracking for VM ports and updates MapVmPort signatures.
src/windows/wslasession/WSLASession.cpp	Refactors MapVmPort/UnmapVmPort to reuse allocations with reference counting.
src/windows/wslasession/WSLAContainerMetadata.h	Extends serialized port mapping metadata with protocol and binding address.
src/windows/wslasession/WSLAContainer.h	Introduces `ContainerPortMapping` wrapper and stores container network mode.
src/windows/wslasession/WSLAContainer.cpp	Refactors port processing/allocation/mapping/unmapping; serializes extended metadata.
src/windows/wslaservice/inc/wslaservice.idl	Extends `WSLAPortMapping` with protocol and binding address; updates MapVmPort signatures.
src/windows/common/wslutil.h	Adds ParseIpv4/ParseIpv6 address helpers.
src/windows/common/wslutil.cpp	Implements IP parsing with localized user error on invalid IP.
src/windows/common/WSLAContainerLauncher.h	Extends `AddPort` to accept protocol and binding address; stores binding address backing strings.
src/windows/common/WSLAContainerLauncher.cpp	Implements extended port mapping population.
src/windows/WslcSDK/wslcsdk.h	Removes a stray blank line in port mapping struct.
src/windows/WslcSDK/wslcsdk.cpp	Populates protocol and binding address in converted port mappings.
localization/strings/en-US/Resources.resw	Adds localized “Invalid IP address” message.

src/windows/wslasession/WSLASession.cpp

src/windows/common/wslutil.h

src/windows/wslasession/WSLAVirtualMachine.cpp

src/windows/common/WSLAContainerLauncher.h

src/windows/wslasession/WSLAVirtualMachine.cpp

… into user/oneblue/ports-2

Copilot

Pull request overview

Refactors container/VM port mapping to support protocol + binding address, introduce RAII-based VM port allocations, and improve diagnostics/tests around port relay behavior.

Changes:

Introduces VmPortAllocation / VMPortMapping abstractions and updates VM map/unmap + allocation APIs.
Extends port mapping schema/IDL (protocol + binding address) and updates container create/open/start mapping behavior.
Updates Windows tests and relay logging, adding negative-path coverage for invalid mappings.

Reviewed changes

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

Show a summary per file

File	Description
test/windows/WSLATests.cpp	Updates networking mode expectations, enables IPv6 HTTP checks, and adds validation of port-mapping error paths.
src/windows/wslrelay/localhost.cpp	Adds address-family context to port relay logs.
src/windows/wslasession/WSLAVirtualMachine.h	Adds `VmPortAllocation`/`VMPortMapping` types and refactors VM port APIs to use them.
src/windows/wslasession/WSLAVirtualMachine.cpp	Implements new mapping/allocation logic and mode-specific validation for NAT/VirtioProxy.
src/windows/wslasession/WSLASession.h	Adds test-only tracking for VM port allocations and updates testing COM method signatures.
src/windows/wslasession/WSLASession.cpp	Implements reference-counted `MapVmPort`/`UnmapVmPort` using new allocation model.
src/windows/wslasession/WSLAContainerMetadata.h	Extends serialized port metadata with protocol + binding address.
src/windows/wslasession/WSLAContainer.h	Introduces `ContainerPortMapping` and reshapes container port state to use `VMPortMapping`.
src/windows/wslasession/WSLAContainer.cpp	Reworks port-mapping processing, serialization, create/open behavior, and runtime map/unmap lifecycle.
src/windows/wslaservice/inc/wslaservice.idl	Extends `WSLAPortMapping` with protocol + binding address and tweaks test-only port mapping method signatures.
src/windows/common/wslutil.h	Exposes IP parsing helpers.
src/windows/common/wslutil.cpp	Adds localized-err IP parsing helpers using `inet_pton`.
src/windows/common/WSLAContainerLauncher.h	Extends `AddPort` to accept protocol + binding address (with defaults).
src/windows/common/WSLAContainerLauncher.cpp	Stores binding address strings and populates new port-mapping fields.
src/windows/WslcSDK/wslcsdk.h	Minor formatting touch (no behavior).
src/windows/WslcSDK/wslcsdk.cpp	Populates protocol + binding address when translating SDK port mappings.
localization/strings/en-US/Resources.resw	Adds localized “Invalid IP address” message.

src/windows/wslasession/WSLAVirtualMachine.cpp

+    if (BindAddress.Ipv4.sin_family == AF_INET6)
+    {
+        return IN6_IS_ADDR_LOOPBACK(&BindAddress.Ipv6.sin6_addr);
+    }
+    else
+    {
+        return IN4ADDR_ISLOOPBACK(&BindAddress.Ipv4);


src/windows/wslasession/WSLAVirtualMachine.cpp

+
+VMPortMapping::~VMPortMapping()
+{
+    Unmap();


src/windows/wslasession/WSLAContainerMetadata.h

    uint16_t VmPort{};
    uint16_t ContainerPort{};
    int Family{};
+    int Protocol{};
+    std::string BindingAddress;

-    // Runtime-only field. Not serialized to JSON.
-    bool MappedToHost{};
-
-    NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT(WSLAPortMapping, HostPort, VmPort, ContainerPort, Family);
+    NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT(WSLAPortMapping, HostPort, VmPort, ContainerPort, Family, Protocol, BindingAddress);


src/windows/common/WSLAContainerLauncher.h

+    void AddPort(
+        uint16_t WindowsPort,
+        uint16_t ContainerPort,
+        int Family,
+        int Protocol = IPPROTO_TCP,
+        const std::string& BindingAddress = "127.0.0.1");


src/windows/wslasession/WSLAVirtualMachine.cpp

+std::shared_ptr<VmPortAllocation> WSLAVirtualMachine::AllocatePort(int Family, int Protocol)
 {
    std::lock_guard lock{m_lock};

-    std::set<uint16_t> allocatedRange;
-
-    // Add ports to the allocated list until we have enough
-    for (auto i = CONTAINER_PORT_RANGE.first; i <= CONTAINER_PORT_RANGE.second && allocatedRange.size() < Count; i++)
+    for (auto i = CONTAINER_PORT_RANGE.first; i <= CONTAINER_PORT_RANGE.second; i++)
    {
        if (!m_allocatedPorts.contains(i))
        {
-            WI_VERIFY(allocatedRange.insert(i).second);
+            WI_VERIFY(m_allocatedPorts.insert(i).second);
+            return std::make_shared<VmPortAllocation>(i, Family, Protocol, *this);
        }
    }

-    // Fail if we couldn't find enough free ports.
-    THROW_HR_IF_MSG(
-        HRESULT_FROM_WIN32(ERROR_NO_SYSTEM_RESOURCES),
-        allocatedRange.size() < Count,
-        "Failed to allocate %u ports, only %zu available",
-        Count,
-        allocatedRange.size());
-
-    // Reserve the ports we found.
-    m_allocatedPorts.insert(allocatedRange.begin(), allocatedRange.end());
-
-    return allocatedRange;
+    // Fail if we couldn't find a port.
+    THROW_HR_MSG(HRESULT_FROM_WIN32(ERROR_NO_SYSTEM_RESOURCES), "Failed to allocate port");
 }


src/windows/wslasession/WSLAVirtualMachine.cpp

+void VMPortMapping::AssignVmPort(const std::shared_ptr<VmPortAllocation>& Port)
+{
+    WI_ASSERT(!VmPort);
+    VmPort = std::move(Port);
+}


OneBlue added 7 commits March 17, 2026 13:06

Save state

ad5013a

Save state

b1bfef0

Save state

a0772bd

Save state

3340750

Save state

bab624b

Fix last issues

945d685

Format

29351fc

Copilot AI review requested due to automatic review settings March 18, 2026 19:25

Copilot AI reviewed Mar 18, 2026

View reviewed changes

OneBlue added 5 commits March 18, 2026 13:43

Save state

9438487

Save state

a51efc6

Save state

2a3cc07

Clear port status during shutdown

a2104ea

Add checks for virtionet

8483c56

OneBlue requested a review from Copilot March 19, 2026 04:04

Copilot AI reviewed Mar 19, 2026

View reviewed changes

OneBlue and others added 6 commits March 18, 2026 21:13

Cleanup before PR

1d19d41

Keep track of port references

95fa4b1

Format

37bc1d5

Assign iterator

c09099b

Assign iterator

eb912cc

Merge branch 'feature/wsl-for-apps' into user/oneblue/ports-2

f3693b2

Copilot AI review requested due to automatic review settings March 19, 2026 15:48

Copilot AI reviewed Mar 19, 2026

View reviewed changes

OneBlue added 2 commits March 19, 2026 09:09

Apply PR feedback

0166b22

Merge branch 'user/oneblue/ports-2' of https://github.com/microsoft/WSL…

684a208

… into user/oneblue/ports-2

Copilot started reviewing on behalf of OneBlue March 19, 2026 17:57 View session

OneBlue marked this pull request as ready for review March 19, 2026 18:57

OneBlue requested a review from a team as a code owner March 19, 2026 18:57

Copilot AI review requested due to automatic review settings March 19, 2026 18:57

Copilot AI reviewed Mar 19, 2026

View reviewed changes

Conversation

OneBlue commented Mar 18, 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!

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

Reviewed changes

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

Reviewed changes

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

Reviewed changes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants