feature/hyperv-api-backend: VM & VM Factory Implementation

.gitignore

@@ -36,3 +36,4 @@ packaging/windows/custom-actions/x64/*
 
 # clangd cache path
 .cache/
+**/network-cache

CMakeLists.txt

@@ -146,6 +146,8 @@ if(UNIX)
   list(APPEND MULTIPASS_BACKENDS qemu)
 endif()
 
+include(src/cmake/cmake-deps.cmake)
+
 # OpenSSL config
 find_package(OpenSSL REQUIRED)
 
@@ -275,6 +277,7 @@ if(MSVC)
   add_definitions(-DLIBSSH_STATIC) # otherwise adds declspec specifiers to libssh apis
   add_definitions(-D_SILENCE_ALL_CXX17_DEPRECATION_WARNINGS)
   add_definitions(-DWIN32_LEAN_AND_MEAN)
+  add_definitions(-DSECURITY_WIN32)
   set(MULTIPASS_BACKENDS hyperv hyperv_api virtualbox)
   set(MULTIPASS_PLATFORM windows)
 else()

include/multipass/file_ops.h

@@ -105,11 +105,15 @@ class FileOps : public Singleton<FileOps>
     virtual std::unique_ptr<std::istream> open_read(const fs::path& path,
                                                     std::ios_base::openmode mode = std::ios_base::in) const;
     virtual void copy(const fs::path& src, const fs::path& dist, fs::copy_options copy_options) const;
-    virtual bool exists(const fs::path& path, std::error_code& err) const;
+    virtual void rename(const fs::path& old_p, const fs::path& new_p) const;
+    virtual void rename(const fs::path& old_p, const fs::path& new_p, std::error_code& ec) const noexcept;
+    virtual bool exists(const fs::path& path) const;
+    virtual bool exists(const fs::path& path, std::error_code& err) const noexcept;
     virtual bool is_directory(const fs::path& path, std::error_code& err) const;
     virtual bool create_directory(const fs::path& path, std::error_code& err) const;
     virtual bool create_directories(const fs::path& path, std::error_code& err) const;
-    virtual bool remove(const fs::path& path, std::error_code& err) const;
+    virtual bool remove(const fs::path& path) const;
+    virtual bool remove(const fs::path& path, std::error_code& err) const noexcept;
     virtual void create_symlink(const fs::path& to, const fs::path& path, std::error_code& err) const;
     virtual fs::path read_symlink(const fs::path& path, std::error_code& err) const;
     virtual fs::file_status status(const fs::path& path, std::error_code& err) const;

src/platform/backends/hyperv_api/hyperv_api_common.cpp → include/multipass/platform_win.h

@@ -15,15 +15,41 @@
  *
  */
 
-#include <hyperv_api/hyperv_api_common.h>
-#include <multipass/exceptions/formatted_exception_base.h>
+#ifndef MULTIPASS_PLATFORM_WIN_H
+#define MULTIPASS_PLATFORM_WIN_H
 
-#include <fmt/xchar.h>
+#include <windows.h>
 
-#include <objbase.h> // for CLSIDFromString
+#include <fmt/format.h>
 
-#include <codecvt>
-#include <locale>
+#include <string>
+
+struct WSAData;
+
+namespace multipass::platform
+{
+struct wsa_init_wrapper
+{
+    wsa_init_wrapper();
+    ~wsa_init_wrapper();
+
+    /**
+     * Check whether WSA initialization has succeeded.
+     *
+     * @return true WSA is initialized successfully
+     * @return false WSA initialization failed
+     */
+    operator bool() const noexcept
+    {
+        return wsa_init_result == 0;
+    }
+
+private:
+    WSAData* wsa_data{nullptr};
+    const int wsa_init_result{-1};
+};
+
+} // namespace multipass::platform
 
 /**
  * Formatter for GUID type
@@ -63,77 +89,4 @@ struct fmt::formatter<::GUID, Char>
     }
 };
 
-namespace multipass::hyperv
-{
-
-struct GuidParseError : FormattedExceptionBase<>
-{
-    using FormattedExceptionBase<>::FormattedExceptionBase;
-};
-
-auto guid_from_wstring(const std::wstring& guid_wstr) -> ::GUID
-{
-    constexpr auto kGUIDLength = 36;
-    constexpr auto kGUIDLengthWithBraces = kGUIDLength + 2;
-
-    const auto input = [&guid_wstr]() {
-        switch (guid_wstr.length())
-        {
-        case kGUIDLength:
-            // CLSIDFromString requires GUIDs to be wrapped with braces.
-            return fmt::format(L"{{{}}}", guid_wstr);
-        case kGUIDLengthWithBraces:
-        {
-            if (*guid_wstr.begin() != L'{' || *std::prev(guid_wstr.end()) != L'}')
-            {
-                throw GuidParseError{"GUID string either does not start or end with a brace."};
-            }
-            return guid_wstr;
-        }
-        }
-        throw GuidParseError{"Invalid length for a GUID string ({}).", guid_wstr.length()};
-    }();
-
-    ::GUID guid = {};
-
-    const auto result = CLSIDFromString(input.c_str(), &guid);
-
-    if (FAILED(result))
-    {
-        throw GuidParseError{"Failed to parse the GUID string ({}).", result};
-    }
-
-    return guid;
-}
-
-// ---------------------------------------------------------
-
-auto string_to_wstring(const std::string& str) -> std::wstring
-{
-    return std::wstring_convert<std::codecvt_utf8<wchar_t>>().from_bytes(str);
-}
-
-// ---------------------------------------------------------
-
-auto guid_from_string(const std::string& guid_str) -> GUID
-{
-    // Just use the wide string overload.
-    return guid_from_wstring(string_to_wstring(guid_str));
-}
-
-// ---------------------------------------------------------
-
-auto guid_to_string(const ::GUID& guid) -> std::string
-{
-
-    return fmt::format("{}", guid);
-}
-
-// ---------------------------------------------------------
-
-auto guid_to_wstring(const ::GUID& guid) -> std::wstring
-{
-    return fmt::format(L"{}", guid);
-}
-
-} // namespace multipass::hyperv
+#endif // MULTIPASS_PLATFORM_WIN_H

include/multipass/virtual_machine.h

@@ -28,12 +28,15 @@
 
 #include <chrono>
 #include <condition_variable>
+#include <functional>
 #include <memory>
 #include <mutex>
 #include <optional>
 #include <string>
 #include <vector>
 
+#include <fmt/format.h>
+
 namespace multipass
 {
 class MemorySize;
@@ -78,7 +81,7 @@ class VirtualMachine : private DisabledCopyMove
     virtual std::string ssh_hostname()
     {
         return ssh_hostname(std::chrono::minutes(2));
-    };
+    }
     virtual std::string ssh_hostname(std::chrono::milliseconds timeout) = 0;
     virtual std::string ssh_username() = 0;
     virtual std::string management_ipv4() = 0;
@@ -102,7 +105,8 @@ class VirtualMachine : private DisabledCopyMove
                                                                     const VMMount& mount) = 0;
 
     using SnapshotVista = std::vector<std::shared_ptr<const Snapshot>>; // using vista to avoid confusion with C++ views
-    virtual SnapshotVista view_snapshots() const = 0;
+    using SnapshotPredicate = std::function<bool(const Snapshot&)>;
+    virtual SnapshotVista view_snapshots(SnapshotPredicate predicate = {}) const = 0;
     virtual int get_num_snapshots() const = 0;
 
     virtual std::shared_ptr<const Snapshot> get_snapshot(const std::string& name) const = 0;
@@ -145,4 +149,54 @@ inline QDir multipass::VirtualMachine::instance_directory() const
     return instance_dir; // TODO this should probably only be known at the level of the base VM
 }
 
+/**
+ * Formatter type specialization for CreateComputeSystemParameters
+ */
+template <typename Char>
+struct fmt::formatter<multipass::VirtualMachine::State, Char>
+{
+    constexpr auto parse(basic_format_parse_context<Char>& ctx)
+    {
+        return ctx.begin();
+    }
+
+    template <typename FormatContext>
+    auto format(multipass::VirtualMachine::State state, FormatContext& ctx) const
+    {
+        std::string_view v = "(undefined)";
+        switch (state)
+        {
+        case multipass::VirtualMachine::State::off:
+            v = "off";
+            break;
+        case multipass::VirtualMachine::State::stopped:
+            v = "stopped";
+            break;
+        case multipass::VirtualMachine::State::starting:
+            v = "starting";
+            break;
+        case multipass::VirtualMachine::State::restarting:
+            v = "restarting";
+            break;
+        case multipass::VirtualMachine::State::running:
+            v = "running";
+            break;
+        case multipass::VirtualMachine::State::delayed_shutdown:
+            v = "delayed_shutdown";
+            break;
+        case multipass::VirtualMachine::State::suspending:
+            v = "suspending";
+            break;
+        case multipass::VirtualMachine::State::suspended:
+            v = "suspended";
+            break;
+        case multipass::VirtualMachine::State::unknown:
+            v = "unknown";
+            break;
+        }
+
+        return format_to(ctx.out(), "{}", v);
+    }
+};
+
 #endif // MULTIPASS_VIRTUAL_MACHINE_H

src/client/gui/lib/platform/windows.dart

@@ -18,6 +18,7 @@ class WindowsPlatform extends MpPlatform {
   Map<String, String> get drivers => const {
         'hyperv': 'Hyper-V',
         'virtualbox': 'VirtualBox',
+        'hyperv_api': 'Hyper-V (API)'
       };
 
   @override

src/cmake/cmake-deps.cmake

@@ -0,0 +1,24 @@
+# Copyright (C) Canonical, Ltd.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+include(FetchContent)
+
+# Declare and fetch fmt
+FetchContent_Declare(
+  out_ptr
+  GIT_REPOSITORY https://github.com/soasis/out_ptr.git
+  GIT_TAG 02a577edfcf25e2519e380a95c16743b7e5878a1
+)
+
+FetchContent_MakeAvailable(out_ptr)

src/platform/CMakeLists.txt

@@ -29,7 +29,8 @@ function(add_target TARGET_NAME)
       jsoncpp_static
       shared_win
       scope_guard
-      wineventlogger)
+      wineventlogger
+      Secur32)
   elseif(APPLE)
     add_library(${TARGET_NAME} STATIC
       platform_osx.cpp

src/platform/backends/hyperv_api/CMakeLists.txt

@@ -41,14 +41,28 @@ if(WIN32)
   endif()
 
   add_library(hyperv_api_backend STATIC
-    hyperv_api_common.cpp
     hcn/hyperv_hcn_api_wrapper.cpp
+    hcn/hyperv_hcn_route.cpp
+    hcn/hyperv_hcn_subnet.cpp
+    hcn/hyperv_hcn_ipam.cpp
+    hcn/hyperv_hcn_network_policy.cpp
     hcs/hyperv_hcs_api_wrapper.cpp
+    hcs/hyperv_hcs_scsi_device.cpp
+    hcs/hyperv_hcs_network_adapter.cpp
+    hcs/hyperv_hcs_plan9_share_params.cpp
+    hcs/hyperv_hcs_create_compute_system_params.cpp
+    hcs/hyperv_hcs_request.cpp
+    hcs/hyperv_hcs_path.cpp
     virtdisk/virtdisk_api_wrapper.cpp
+    virtdisk/virtdisk_snapshot.cpp
+    hcs_plan9_mount_handler.cpp
+    hcs_virtual_machine.cpp
+    hcs_virtual_machine_factory.cpp
   )
 
   target_link_libraries(hyperv_api_backend PRIVATE
     fmt::fmt-header-only
+    ztd::out_ptr
     utils
     computecore.lib
     computenetwork.lib