Resolve merge conflicts: bump session error codes to slots 7-8

WSLC_E_CONTAINER_NOT_RUNNING and WSLC_E_CONTAINER_IS_RUNNING took
slots 5-6 on the target branch. Move WSLC_E_SESSION_RESERVED and
WSLC_E_INVALID_SESSION_NAME to slots 7-8 to avoid collisions.

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

Author: Ben Hillis

diagnostics/collect-wsl-logs.ps1

@@ -304,7 +304,7 @@ if ($Dump)
     $dumpFolder = Join-Path (Resolve-Path "$folder") dumps
     New-Item -ItemType "directory" -Path "$dumpFolder"
 
-    $executables = "wsl", "wslservice", "wslhost", "msrdc", "dllhost"
+    $executables = "wsl", "wslservice", "wslhost", "wslcsession", "wslrelay", "wslg", "msrdc", "dllhost"
     foreach($process in Get-Process | Where-Object { $executables -contains $_.ProcessName})
     {
         $dumpFile =  "$dumpFolder/$($process.ProcessName).$($process.Id).dmp"

localization/strings/en-US/Resources.resw

@@ -1965,6 +1965,18 @@ Usage:
     <value>Unknown command: '{}'</value>
     <comment>{FixedPlaceholder="{}"}Command line arguments, file names and string inserts should not be translated</comment>
   </data>
+  <data name="MessageWslcCannotRemoveRunningContainer" xml:space="preserve">
+    <value>Container '{}' is running and cannot be removed. Either stop the container before removing or use forced remove (-f).</value>
+    <comment>{FixedPlaceholder="{}"}Command line arguments, file names and string inserts should not be translated</comment>
+  </data>
+  <data name="MessageWslcContainerNotRunning" xml:space="preserve">
+    <value>Container '{}' is not running.</value>
+    <comment>{FixedPlaceholder="{}"}Command line arguments, file names and string inserts should not be translated</comment>
+  </data>
+  <data name="MessageWslcContainerIsRunning" xml:space="preserve">
+    <value>Container '{}' is running.</value>
+    <comment>{FixedPlaceholder="{}"}Command line arguments, file names and string inserts should not be translated</comment>
+  </data>
   <data name="WSLCCLI_UnrecognizedCommandError" xml:space="preserve">
     <value>Unrecognized command: '{}'</value>
     <comment>{FixedPlaceholder="{}"}Command line arguments, file names and string inserts should not be translated</comment>
@@ -2211,7 +2223,7 @@ For privacy information about this product please visit https://aka.ms/privacy.<
     <value>Run a container.</value>
   </data>
   <data name="WSLCCLI_ContainerRunLongDesc" xml:space="preserve">
-    <value>Runs a container. By default, the container is started in the background; use --detach to run in the foreground.</value>
+    <value>Runs a container. By default, the container is started in the foreground; use --detach to run in the background.</value>
     <comment>{Locked="--detach "}Command line arguments, file names and string inserts should not be translated</comment>
   </data>
   <data name="WSLCCLI_ContainerStartDesc" xml:space="preserve">

nuget/Microsoft.WSL.Containers.nuspec.in

@@ -5,7 +5,7 @@
     <version>${WSL_NUGET_PACKAGE_VERSION}</version>
     <authors>Microsoft</authors>
     <projectUrl>https://github.com/microsoft/WSL</projectUrl>
-    <description>WSL Containers SDK</description>
+    <description>WSL Containers SDK (Preview - API subject to breaking changes)</description>
     <copyright>© Microsoft Corporation. All rights reserved.</copyright>
     <tags>WSL</tags>
     <language>en-us</language>

nuget/Microsoft.WSL.Containers/docs/README.MD

@@ -1,3 +1,7 @@
 # WSL Containers
 
-This package contains the `WSLCApi.h` header which defines the WSL Containers interface.
+> **⚠️ Preview:** This SDK is currently in preview and is subject to breaking changes
+> in future releases without prior notice. Do not rely on API stability for production
+> workloads.
+
+This package contains the `wslcsdk.h` header which defines the WSL Containers interface.

src/shared/inc/defs.h

@@ -16,6 +16,17 @@ Module Name:
 
 #if defined(_MSC_VER)
 #define THROW_INVALID_ARG_IF(condition) THROW_HR_IF(E_INVALIDARG, condition)
+
+#define THROW_IF_FAILED_EXCEPT(result, accepted) \
+    do \
+    { \
+        auto _result = (result); \
+        if (FAILED(_result) && _result != (accepted)) \
+        { \
+            THROW_HR(_result); \
+        } \
+    } while (0)
+
 #elif defined(__GNUC__)
 #define THROW_INVALID_ARG_IF(condition) THROW_ERRNO_IF(EINVAL, condition)
 #define _stricmp strcasecmp

src/windows/WslcSDK/wslcsdk.cpp

@@ -1263,16 +1263,16 @@ try
 }
 CATCH_RETURN();
 
-STDAPI WslcDeleteSessionImage(_In_ WslcSession session, _In_z_ PCSTR NameOrId, _Outptr_opt_result_z_ PWSTR* errorMessage)
+STDAPI WslcDeleteSessionImage(_In_ WslcSession session, _In_z_ PCSTR nameOrId, _Outptr_opt_result_z_ PWSTR* errorMessage)
 try
 {
     ErrorInfoWrapper errorInfoWrapper{errorMessage};
     auto internalType = CheckAndGetInternalType(session);
     RETURN_HR_IF_NULL(HRESULT_FROM_WIN32(ERROR_INVALID_STATE), internalType->session);
-    RETURN_HR_IF_NULL(E_POINTER, NameOrId);
+    RETURN_HR_IF_NULL(E_POINTER, nameOrId);
 
     WSLCDeleteImageOptions options{};
-    options.Image = NameOrId;
+    options.Image = nameOrId;
     // TODO: Flags? (Force and NoPrune)
 
     wil::unique_cotaskmem_array_ptr<WSLCDeletedImageInformation> deletedImageInformation;

src/windows/WslcSDK/wslcsdk.h

@@ -10,6 +10,11 @@ Module Name:
 
     This file contains the public WSL Container SDK api definitions.
 
+    PREVIEW NOTICE: This API is currently in preview and is subject to breaking
+    changes in future releases without prior notice. Do not rely on API stability
+    for production workloads. Features, function signatures, and behaviors may
+    change between releases during the preview period.
+
 --*/
 #pragma once
 #include <winsock2.h>
@@ -204,7 +209,7 @@ STDAPI WslcReleaseContainer(_In_ WslcContainer container);
 
 #define WSLC_CONTAINER_ID_BUFFER_SIZE 65 // 64 hex chars + null terminator
 
-STDAPI WslcGetContainerID(WslcContainer container, CHAR containerId[WSLC_CONTAINER_ID_BUFFER_SIZE]);
+STDAPI WslcGetContainerID(_In_ WslcContainer container, _Out_writes_(WSLC_CONTAINER_ID_BUFFER_SIZE) CHAR containerId[WSLC_CONTAINER_ID_BUFFER_SIZE]);
 
 STDAPI WslcGetContainerInitProcess(_In_ WslcContainer container, _Out_ WslcProcess* initProcess);
 
@@ -284,7 +289,7 @@ typedef enum WslcProcessIOHandle
 // Parameters:
 //   ioHandle
 //       The WslcProcessIOHandle that the IO callback is for.
-//       Only STDOUT and STDERR will recieve callbacks.
+//       Only STDOUT and STDERR will receive callbacks.
 //
 //   data
 //       Pointer to a buffer containing the bytes read. The buffer is owned
@@ -450,7 +455,7 @@ typedef struct WslcImageInfo
     uint64_t createdTimestamp;
 } WslcImageInfo;
 
-STDAPI WslcDeleteSessionImage(_In_ WslcSession session, _In_z_ PCSTR NameOrId, _Outptr_opt_result_z_ PWSTR* errorMessage);
+STDAPI WslcDeleteSessionImage(_In_ WslcSession session, _In_z_ PCSTR nameOrId, _Outptr_opt_result_z_ PWSTR* errorMessage);
 
 // Retrieves the list of container images
 // Parameters:

src/windows/common/wslutil.cpp

@@ -150,6 +150,9 @@ static const std::map<HRESULT, LPCWSTR> g_commonErrors{
     X_WIN32(ERROR_INVALID_STATE),
     X(WSLC_E_IMAGE_NOT_FOUND),
     X(WSLC_E_CONTAINER_NOT_FOUND),
+    X(WSLC_E_VOLUME_NOT_FOUND),
+    X(WSLC_E_CONTAINER_NOT_RUNNING),
+    X(WSLC_E_CONTAINER_IS_RUNNING),
     X(WSLC_E_SESSION_RESERVED),
     X(WSLC_E_INVALID_SESSION_NAME),
     X_WIN32(RPC_S_SERVER_UNAVAILABLE),

src/windows/inc/docker_schema.h

@@ -206,34 +206,6 @@ struct InspectExec
     NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT(InspectExec, Pid, ExitCode, Running);
 };
 
-struct PruneContainerLabelFilter
-{
-    std::map<std::string, bool> presentLabels;
-    std::map<std::string, bool> absentLabels;
-    std::optional<std::uint64_t> until;
-};
-
-inline void to_json(nlohmann::json& j, const PruneContainerLabelFilter& object)
-{
-    j = nlohmann::json{};
-    if (!object.presentLabels.empty())
-    {
-        j["label"] = object.presentLabels;
-    }
-
-    if (!object.absentLabels.empty())
-    {
-        j["label!"] = object.absentLabels;
-    }
-
-    // This is required because docker crashes if 'until' is null.
-    // TODO: Open a PR to fix this directly in moby.
-    if (object.until.has_value())
-    {
-        j["until"] = nlohmann::json{{std::to_string(object.until.value()), true}};
-    }
-}
-
 struct PruneContainerResult
 {
     std::optional<std::vector<std::string>> ContainersDeleted; // Null if no containers were deleted.
@@ -262,6 +234,14 @@ struct DeletedImage
     NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT(DeletedImage, Untagged, Deleted);
 };
 
+struct PruneImageResult
+{
+    std::optional<std::vector<DeletedImage>> ImagesDeleted;
+    uint64_t SpaceReclaimed{};
+
+    NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT(PruneImageResult, ImagesDeleted, SpaceReclaimed);
+};
+
 struct ImportStatus
 {
     std::string status;

src/windows/service/inc/wslc.idl

@@ -560,12 +560,12 @@ typedef struct _WSLCVolumeInformation
     char Type[64];
 } WSLCVolumeInformation;
 
-typedef struct _WSLCContainerPruneFilter
+typedef struct _WSLCPruneLabelFilter
 {
     LPCSTR Key;
     [unique] LPCSTR Value;
     BOOL Present;
-} WSLCContainerPruneFilter;
+} WSLCPruneLabelFilter;
 
 typedef struct _WSLCPruneContainersResults
 {
@@ -574,6 +574,26 @@ typedef struct _WSLCPruneContainersResults
     ULONGLONG SpaceReclaimed;
 } WSLCPruneContainersResults;
 
+typedef enum _WSLCPruneImagesFlags
+{
+    WSLCPruneImagesFlagsNone = 0,
+    WSLCPruneImagesFlagsDanglingTrue = 1,  // Only prune dangling (untagged) images.
+    WSLCPruneImagesFlagsDanglingFalse = 2, // Prune all images not used by any container.
+    // Note: If neither dangling flag is set, no dangling filter is passed (Docker defaults to dangling-only).
+} WSLCPruneImagesFlags;
+
+cpp_quote("#define WSLCPruneImagesFlagsValid (WSLCPruneImagesFlagsDanglingTrue | WSLCPruneImagesFlagsDanglingFalse)")
+
+cpp_quote("DEFINE_ENUM_FLAG_OPERATORS(WSLCPruneImagesFlags);")
+
+typedef struct _WSLCPruneImagesOptions
+{
+    DWORD Flags; // WSLCPruneImagesFlags
+    ULONGLONG Until;
+    [unique, size_is(LabelsCount)] const WSLCPruneLabelFilter* Labels;
+    ULONG LabelsCount;
+} WSLCPruneImagesOptions;
+
 typedef enum _WSLCSessionState
 {
     WSLCSessionStateRunning = 0,
@@ -615,6 +635,7 @@ interface IWSLCSession : IUnknown
     HRESULT DeleteImage([in] const WSLCDeleteImageOptions* Options, [out, size_is(, *Count)] WSLCDeletedImageInformation** DeletedImages, [out] ULONG* Count);
     HRESULT TagImage([in] const WSLCTagImageOptions* Options);
     HRESULT InspectImage([in] LPCSTR ImageNameOrId, [out] LPSTR* Output);
+    HRESULT PruneImages([in, unique] const WSLCPruneImagesOptions* Options, [out, size_is(, *DeletedImagesCount)] WSLCDeletedImageInformation** DeletedImages, [out] ULONG* DeletedImagesCount, [out] ULONGLONG* SpaceReclaimed);
 
     // Container management.
     HRESULT CreateContainer([in] const WSLCContainerOptions* Options, [out] IWSLCContainer** Container);
@@ -623,7 +644,7 @@ interface IWSLCSession : IUnknown
                                             [out] ULONG* Count,
                                             [out, size_is(, *PortsCount)] WSLCContainerPortMapping** Ports,
                                             [out] ULONG* PortsCount);
-    HRESULT PruneContainers([in, unique, size_is(FiltersCount)] WSLCContainerPruneFilter* Filters, [in] DWORD FiltersCount, [in] ULONGLONG Until, [out] WSLCPruneContainersResults* Result);
+    HRESULT PruneContainers([in, unique, size_is(FiltersCount)] WSLCPruneLabelFilter* Filters, [in] DWORD FiltersCount, [in] ULONGLONG Until, [out] WSLCPruneContainersResults* Result);
 
     // Create a process at the VM level. This is meant for debugging.
     HRESULT CreateRootNamespaceProcess([in, ref] LPCSTR Executable, [in, ref] const WSLCProcessOptions* Options, [out] IWSLCProcess** Process, [out] int* Errno);
@@ -740,5 +761,7 @@ cpp_quote("#define WSLC_E_IMAGE_NOT_FOUND MAKE_HRESULT(SEVERITY_ERROR, FACILITY_
 cpp_quote("#define WSLC_E_CONTAINER_PREFIX_AMBIGUOUS MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSLC_E_BASE + 2) /* 0x80040602 */")
 cpp_quote("#define WSLC_E_CONTAINER_NOT_FOUND MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSLC_E_BASE + 3) /* 0x80040603 */")
 cpp_quote("#define WSLC_E_VOLUME_NOT_FOUND MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSLC_E_BASE + 4) /* 0x80040604 */")
-cpp_quote("#define WSLC_E_SESSION_RESERVED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSLC_E_BASE + 5) /* 0x80040605 */")
-cpp_quote("#define WSLC_E_INVALID_SESSION_NAME MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSLC_E_BASE + 6) /* 0x80040606 */")
+cpp_quote("#define WSLC_E_CONTAINER_NOT_RUNNING MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSLC_E_BASE + 5) /* 0x80040605 */")
+cpp_quote("#define WSLC_E_CONTAINER_IS_RUNNING MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSLC_E_BASE + 6) /* 0x80040606 */")
+cpp_quote("#define WSLC_E_SESSION_RESERVED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSLC_E_BASE + 7) /* 0x80040607 */")
+cpp_quote("#define WSLC_E_INVALID_SESSION_NAME MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSLC_E_BASE + 8) /* 0x80040608 */")