Implement wslc session enter (#40088)

* Save state

* Save state

* Save state

* Cleanup

* Prepare for PR

* Cleanup

* Validate flags

* Apply PR suggestions

* Add comment

* Remove include

* Cleanup diff

* Format

* Format

* Restore session flags

Author: OneBlue

localization/strings/en-US/Resources.resw

@@ -1939,6 +1939,10 @@ Usage:
     <value>{} exited with: {}</value>
     <comment>{FixedPlaceholder="{}"}{FixedPlaceholder="{}"}Command line arguments, file names and string inserts should not be translated</comment>
   </data>
+  <data name="MessageWslcCreatedSession" xml:space="preserve">
+    <value>Created session: '{}'</value>
+    <comment>{FixedPlaceholder="{}"}Command line arguments, file names and string inserts should not be translated</comment>
+  </data>
   <data name="MessageWslcHeaderId" xml:space="preserve">
     <value>ID</value>
   </data>
@@ -2114,10 +2118,14 @@ For privacy information about this product please visit https://aka.ms/privacy.<
     <value>Failed to open '{}': {}</value>
     <comment>{FixedPlaceholder="{}"}Command line arguments, file names and string inserts should not be translated</comment>
   </data>
-    <data name = "MessageWslcBuildFileNotFound" xml:space = "preserve" >
+  <data name = "MessageWslcBuildFileNotFound" xml:space = "preserve" >
     <value>No Containerfile or Dockerfile found in '{}'</value>
     <comment>{FixedPlaceholder="{}"}Command line arguments, file names and string inserts should not be translated</comment>
   </data>
+  <data name = "MessageWslcSessionStorageNotFound" xml:space = "preserve" >
+    <value>No WSLC session found in '{}'</value>
+    <comment>{FixedPlaceholder="{}"}Command line arguments, file names and string inserts should not be translated</comment>
+  </data>
   <data name="WSLCCLI_RootCommandDesc" xml:space="preserve">
     <value>WSLC is the Windows Subsystem for Linux Container CLI tool.</value>
     <comment>{Locked="WSLC"}Product names should not be translated</comment>
@@ -2277,6 +2285,17 @@ For privacy information about this product please visit https://aka.ms/privacy.<
   <data name="WSLCCLI_SessionTerminateLongDesc" xml:space="preserve">
     <value>Terminates an active session. If no session is specified, the default session will be terminated.</value>
   </data>
+  <data name="WSLCCLI_SessionEnterDesc" xml:space="preserve">
+    <value>Enter a temporary session.</value>
+  </data>
+  <data name="WSLCCLI_SessionEnterLongDesc" xml:space="preserve">
+    <value>Creates a non-persistent session with the given storage path and opens a shell into it. The session is deleted when the shell exits. If no name is provided, a GUID is generated and printed to stderr.</value>
+    <comment>{Locked="GUID"}{Locked="stderr"}Technical terms should not be translated</comment>
+  </data>
+  <data name="WSLCCLI_SessionEnterNameArgDescription" xml:space="preserve">
+    <value>Name for the session. If not provided, a GUID is generated.</value>
+    <comment>{Locked="GUID"}Technical terms should not be translated</comment>
+  </data>
   <data name="WSLCCLI_SettingsCommandDesc" xml:space="preserve">
     <value>Open the settings file in the default editor.</value>
   </data>
@@ -2371,6 +2390,9 @@ On first run, creates the file with all settings commented out at their defaults
   <data name="WSLCCLI_SessionIdPositionalArgDescription" xml:space="preserve">
     <value>Session ID</value>
   </data>
+  <data name="WSLCCLI_SessionStoragePositionalArgDescription" xml:space="preserve">
+    <value>Session storage path</value>
+  </data>
   <data name="WSLCCLI_SignalArgDescription" xml:space="preserve">
     <value>Signal to send (default: {})</value>
     <comment>{FixedPlaceholder="{}"}Command line arguments, file names and string inserts should not be translated</comment>

src/windows/common/WslClient.cpp

@@ -19,8 +19,6 @@ Module Name:
 #include "Distribution.h"
 #include "CommandLine.h"
 #include <conio.h>
-#include "wslc.h"
-#include "WSLCProcessLauncher.h"
 #include "WslCoreFilesystem.h"
 
 #define BASH_PATH L"/bin/bash"
@@ -30,7 +28,6 @@ using winrt::Windows::Management::Deployment::DeploymentOptions;
 using wsl::shared::Localization;
 using wsl::windows::common::ClientExecutionContext;
 using wsl::windows::common::Context;
-using wsl::windows::common::WSLCProcessLauncher;
 using namespace wsl::windows::common;
 using namespace wsl::shared;
 using namespace wsl::windows::common::distribution;
@@ -1521,191 +1518,6 @@ int RunDebugShell()
     THROW_HR(HCS_E_CONNECTION_CLOSED);
 }
 
-DEFINE_ENUM_FLAG_OPERATORS(WSLCFeatureFlags);
-
-// Temporary debugging tool for WSLC
-int WslcShell(_In_ std::wstring_view commandLine)
-{
-    WSLCSessionSettings sessionSettings{};
-    sessionSettings.DisplayName = L"WSLCShell";
-    sessionSettings.CpuCount = 4;
-    sessionSettings.MemoryMb = 4096;
-    sessionSettings.NetworkingMode = WSLCNetworkingModeVirtioProxy;
-    sessionSettings.BootTimeoutMs = 30 * 1000;
-    sessionSettings.MaximumStorageSizeMb = 4096;
-
-    std::string shell = "/bin/bash";
-    std::string cmd;
-
-    bool help = false;
-    bool noTty = false;
-    std::wstring debugShell;
-
-    std::wstring storagePath;
-    std::wstring rootVhdOverride;
-    std::string rootVhdTypeOverride;
-    ArgumentParser parser(std::wstring{commandLine}, WSL_BINARY_NAME);
-    parser.AddArgument(rootVhdOverride, L"--vhd");
-    parser.AddArgument(Utf8String(shell), L"--shell");
-    parser.AddArgument(SetFlag<WslcFeatureFlagsDnsTunneling>(sessionSettings.FeatureFlags), L"--dns-tunneling");
-    parser.AddArgument(SetFlag<WslcFeatureFlagsVirtioFs>(sessionSettings.FeatureFlags), L"--virtiofs");
-    parser.AddArgument(Integer(sessionSettings.MemoryMb), L"--memory");
-    parser.AddArgument(Integer(sessionSettings.CpuCount), L"--cpu");
-    parser.AddArgument(Utf8String(rootVhdTypeOverride), L"--fstype");
-    parser.AddArgument(storagePath, L"--storage");
-    parser.AddArgument(Integer(reinterpret_cast<int&>(sessionSettings.NetworkingMode)), L"--networking-mode");
-    parser.AddArgument(debugShell, L"--debug-shell");
-    parser.AddArgument(noTty, L"--no-tty");
-    parser.AddArgument(help, L"--help");
-    parser.Parse();
-
-    if (help)
-    {
-        const auto usage = std::format(
-            LR"({} --wslc [--vhd </path/to/vhd>] [--shell </path/to/shell>] [--memory <memory-mb>] [--cpu <cpus>] [--dns-tunneling] [--virtiofs] [--networking-mode <mode>] [--fstype <fstype>] [--container-vhd </path/to/vhd>] [--help])",
-            WSL_BINARY_NAME);
-
-        wprintf(L"%ls\n", usage.c_str());
-        return 1;
-    }
-
-    switch (sessionSettings.NetworkingMode)
-    {
-    case WSLCNetworkingMode::WSLCNetworkingModeNone:
-    case WSLCNetworkingMode::WSLCNetworkingModeNAT:
-    case WSLCNetworkingMode::WSLCNetworkingModeVirtioProxy:
-        break;
-    default:
-        THROW_HR(E_INVALIDARG);
-    }
-
-    wil::com_ptr<IWSLCSessionManager> sessionManager;
-    THROW_IF_FAILED(CoCreateInstance(__uuidof(WSLCSessionManager), nullptr, CLSCTX_LOCAL_SERVER, IID_PPV_ARGS(&sessionManager)));
-    wsl::windows::common::security::ConfigureForCOMImpersonation(sessionManager.get());
-
-    wil::com_ptr<IWSLCSession> session;
-
-    if (!rootVhdOverride.empty())
-    {
-        if (rootVhdTypeOverride.empty())
-        {
-            wprintf(L"--fstype required when --vhd is passed\n");
-            return 1;
-        }
-
-        sessionSettings.RootVhdOverride = rootVhdOverride.c_str();
-        sessionSettings.RootVhdTypeOverride = rootVhdTypeOverride.c_str();
-    }
-
-    if (!storagePath.empty())
-    {
-        storagePath = std::filesystem::weakly_canonical(storagePath).wstring();
-        sessionSettings.StoragePath = storagePath.c_str();
-    }
-
-    if (!debugShell.empty())
-    {
-        THROW_IF_FAILED(sessionManager->OpenSessionByName(debugShell.c_str(), &session));
-    }
-    else
-    {
-        THROW_IF_FAILED(sessionManager->CreateSession(&sessionSettings, WSLCSessionFlagsNone, &session));
-    }
-
-    wsl::windows::common::security::ConfigureForCOMImpersonation(session.get());
-
-    std::optional<wil::com_ptr<IWSLCContainer>> container;
-    std::optional<wsl::windows::common::ClientRunningWSLCProcess> process;
-    // Get the terminal size.
-    HANDLE Stdout = GetStdHandle(STD_OUTPUT_HANDLE);
-    HANDLE Stdin = GetStdHandle(STD_INPUT_HANDLE);
-
-    CONSOLE_SCREEN_BUFFER_INFOEX Info{};
-    Info.cbSize = sizeof(Info);
-    THROW_IF_WIN32_BOOL_FALSE(::GetConsoleScreenBufferInfoEx(Stdout, &Info));
-
-    wsl::windows::common::WSLCProcessLauncher launcher{shell, {shell, "--login"}, {"TERM=xterm-256color"}, WSLCProcessFlagsTty};
-    launcher.SetTtySize(Info.srWindow.Bottom - Info.srWindow.Top + 1, Info.srWindow.Right - Info.srWindow.Left + 1);
-
-    process = launcher.Launch(*session);
-
-    if (noTty)
-    {
-        using namespace wsl::windows::common::relay;
-        wsl::windows::common::relay::MultiHandleWait io;
-
-        // Create a thread to relay stdin to the pipe.
-
-        std::thread inputThread;
-        wil::unique_event exitEvent{wil::EventOptions::ManualReset};
-
-        auto joinThread = wil::scope_exit_log(WI_DIAGNOSTICS_INFO, [&]() {
-            if (inputThread.joinable())
-            {
-                exitEvent.SetEvent();
-                inputThread.join();
-            }
-        });
-
-        // Required because ReadFile() blocks if stdin is a tty.
-        if (wsl::windows::common::wslutil::IsInteractiveConsole())
-        {
-            inputThread = std::thread{[&]() {
-                wsl::windows::common::relay::StandardInputRelay(Stdin, process->GetStdHandle(0).get(), []() {}, exitEvent.get());
-            }};
-        }
-        else
-        {
-            io.AddHandle(std::make_unique<RelayHandle<ReadHandle>>(GetStdHandle(STD_INPUT_HANDLE), process->GetStdHandle(0)));
-        }
-
-        io.AddHandle(std::make_unique<RelayHandle<ReadHandle>>(process->GetStdHandle(1), GetStdHandle(STD_OUTPUT_HANDLE)));
-        io.AddHandle(std::make_unique<RelayHandle<ReadHandle>>(process->GetStdHandle(2), GetStdHandle(STD_ERROR_HANDLE)));
-
-        io.Run({});
-    }
-    else
-    {
-        // Configure console for interactive usage.
-        wsl::windows::common::ConsoleState console;
-        auto exitEvent = wil::unique_event(wil::EventOptions::ManualReset);
-
-        std::vector<wil::unique_handle> handleStorage;
-        HANDLE ttyInput = nullptr;
-        HANDLE ttyOutput = nullptr;
-        auto& it = handleStorage.emplace_back(process->GetStdHandle(WSLCFDTty));
-        ttyInput = it.get();
-        ttyOutput = it.get();
-
-        {
-            // Create a thread to relay stdin to the pipe.
-            std::thread inputThread([&]() {
-                auto updateTerminal = [&console, &process]() {
-                    const auto windowSize = console.GetWindowSize();
-                    LOG_IF_FAILED(process->Get().ResizeTty(windowSize.Y, windowSize.X));
-                };
-
-                wsl::windows::common::relay::StandardInputRelay(Stdin, ttyInput, updateTerminal, exitEvent.get());
-            });
-
-            auto joinThread = wil::scope_exit_log(WI_DIAGNOSTICS_INFO, [&]() {
-                exitEvent.SetEvent();
-                inputThread.join();
-            });
-
-            // Relay the contents of the pipe to stdout.
-            wsl::windows::common::relay::InterruptableRelay(ttyOutput, Stdout);
-        }
-    }
-
-    process->GetExitEvent().wait();
-
-    auto exitCode = process->GetExitCode();
-    wprintf(L"%hs exited with: %i", shell.c_str(), exitCode);
-
-    return exitCode;
-}
-
 int WslMain(_In_ std::wstring_view commandLine)
 {
     // Call the MSI package if we're in an MSIX context
@@ -1948,10 +1760,6 @@ int WslMain(_In_ std::wstring_view commandLine)
 
             return Uninstall();
         }
-        else if (argument == L"--wslc")
-        {
-            return WslcShell(commandLine);
-        }
         else
         {
             if ((argument.size() > 0) && (argument[0] == L'-'))

src/windows/service/exe/WSLCSessionManager.cpp

@@ -54,6 +54,11 @@ void WSLCSessionManagerImpl::CreateSession(const WSLCSessionSettings* Settings,
     // Ensure that the session display name is non-null and not too long.
     THROW_HR_IF(E_INVALIDARG, Settings->DisplayName == nullptr);
     THROW_HR_IF(E_INVALIDARG, wcslen(Settings->DisplayName) >= std::size(WSLCSessionInformation{}.DisplayName));
+    THROW_HR_IF_MSG(
+        E_INVALIDARG,
+        WI_IsAnyFlagSet(Settings->StorageFlags, ~WSLCSessionStorageFlagsValid),
+        "Invalid storage flags: %i",
+        Settings->StorageFlags);
 
     auto tokenInfo = GetCallingProcessTokenInfo();
 
@@ -212,6 +217,7 @@ WSLCSessionInitSettings WSLCSessionManagerImpl::CreateSessionSettings(_In_ ULONG
     sessionSettings.NetworkingMode = Settings->NetworkingMode;
     sessionSettings.FeatureFlags = Settings->FeatureFlags;
     sessionSettings.RootVhdTypeOverride = Settings->RootVhdTypeOverride;
+    sessionSettings.StorageFlags = Settings->StorageFlags;
     return sessionSettings;
 }
 

src/windows/service/inc/wslc.idl

@@ -415,6 +415,15 @@ interface IWSLCVirtualMachine : IUnknown
     HRESULT RemoveShare([in] REFGUID ShareId);
 }
 
+typedef enum _WSLCSessionStorageFlags
+{
+    WSLCSessionStorageFlagsNone = 0,
+    WSLCSessionStorageFlagsNoCreate = 1, // Open an existing storage path, but don't create a new one.
+    WSLCSessionStorageFlagsValid = WSLCSessionStorageFlagsNoCreate
+} WSLCSessionStorageFlags;
+
+cpp_quote("DEFINE_ENUM_FLAG_OPERATORS(WSLCSessionStorageFlags);")
+
 // Settings for IWSLCSessionManager::CreateSession - full session configuration
 typedef struct _WSLCSessionSettings {
     LPCWSTR DisplayName;
@@ -427,6 +436,7 @@ typedef struct _WSLCSessionSettings {
     [unique] ITerminationCallback* TerminationCallback;
     WSLCFeatureFlags FeatureFlags;
     WSLCHandle DmesgOutput;
+    WSLCSessionStorageFlags StorageFlags;
 
     // Below options are used for debugging purposes only.
     [unique] LPCWSTR RootVhdOverride;
@@ -554,6 +564,7 @@ typedef struct _WSLCSessionInitSettings
     ULONG CreatorPid;
     LPCWSTR DisplayName;
     LPCWSTR StoragePath;
+    WSLCSessionStorageFlags StorageFlags;
     ULONGLONG MaximumStorageSizeMb;
     ULONG BootTimeoutMs;
     WSLCNetworkingMode NetworkingMode;
@@ -681,6 +692,9 @@ typedef enum _WSLCSessionFlags
     WSLCSessionFlagsOpenExisting = 2, // Open an existing session if the name is in use.
 } WSLCSessionFlags;
 
+cpp_quote("DEFINE_ENUM_FLAG_OPERATORS(WSLCSessionFlags);")
+
+
 [
     uuid(82A7ABC8-6B50-43FC-AB96-15FBBE7E8760),
     pointer_default(unique),

src/windows/wslc/arguments/ArgumentDefinitions.h

@@ -72,6 +72,7 @@ _(Remove,         "rm",                  NO_ALIAS,          Kind::Flag,        L
 /*_(Scheme,         "scheme",              NO_ALIAS,          Kind::Value,       Localization::WSLCCLI_SchemeArgDescription())*/ \
 _(Session,        "session",             NO_ALIAS,          Kind::Value,       Localization::WSLCCLI_SessionIdArgDescription()) \
 _(SessionId,      "session-id",          NO_ALIAS,          Kind::Positional,  Localization::WSLCCLI_SessionIdPositionalArgDescription()) \
+_(StoragePath,    "storage-path",        NO_ALIAS,          Kind::Positional,  L"Path to the session storage directory") \
 _(Signal,         "signal",              L"s",              Kind::Value,       Localization::WSLCCLI_SignalArgDescription(L"SIGKILL")) \
 _(Tag,            "tag",                 L"t",              Kind::Value,       Localization::WSLCCLI_TagArgDescription()) \
 _(Time,           "time",                L"t",              Kind::Value,       Localization::WSLCCLI_TimeArgDescription()) \

src/windows/wslc/commands/SessionCommand.cpp

@@ -23,6 +23,7 @@ namespace wsl::windows::wslc {
 std::vector<std::unique_ptr<Command>> SessionCommand::GetCommands() const
 {
     std::vector<std::unique_ptr<Command>> commands;
+    commands.push_back(std::make_unique<SessionEnterCommand>(FullName()));
     commands.push_back(std::make_unique<SessionListCommand>(FullName()));
     commands.push_back(std::make_unique<SessionShellCommand>(FullName()));
     commands.push_back(std::make_unique<SessionTerminateCommand>(FullName()));

src/windows/wslc/commands/SessionCommand.h

@@ -62,6 +62,21 @@ struct SessionShellCommand final : public Command
     void ExecuteInternal(CLIExecutionContext& context) const override;
 };
 
+// Enter Command
+struct SessionEnterCommand final : public Command
+{
+    constexpr static std::wstring_view CommandName = L"enter";
+    SessionEnterCommand(const std::wstring& parent) : Command(CommandName, parent)
+    {
+    }
+    std::vector<Argument> GetArguments() const override;
+    std::wstring ShortDescription() const override;
+    std::wstring LongDescription() const override;
+
+protected:
+    void ExecuteInternal(CLIExecutionContext& context) const override;
+};
+
 // Terminate Command
 struct SessionTerminateCommand final : public Command
 {