feature/hyperv-api-backend: HCS/HCN/virtdisk API wrapper implementation

.gitignore

@@ -33,3 +33,6 @@ src/client/gui/flutter*.log
 packaging/windows/wix/obj/*
 packaging/windows/custom-actions/packages/*
 packaging/windows/custom-actions/x64/*
+
+# clangd cache path
+.cache/

CMakeLists.txt

@@ -275,7 +275,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)
-  set(MULTIPASS_BACKENDS hyperv virtualbox)
+  set(MULTIPASS_BACKENDS hyperv hyperv_api virtualbox)
   set(MULTIPASS_PLATFORM windows)
 else()
   add_compile_options(-Werror -Wall -pedantic -fPIC -Wno-error=deprecated-declarations)

src/platform/backends/hyperv_api/CMakeLists.txt

@@ -0,0 +1,57 @@
+# 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/>.
+#
+
+if(WIN32)
+
+  include(CheckCXXSourceRuns)
+
+  macro(check_pragma_lib LIB_NAME HEADER_NAME OUT_VAR)
+    check_cxx_source_runs("
+      #pragma comment(lib, \"${LIB_NAME}\")
+      #define WIN32_LEAN_AND_MEAN
+      #include <windows.h>
+      #include <${HEADER_NAME}>
+      int main(void){ return 0; }
+    " ${OUT_VAR})
+  endmacro()
+
+  check_pragma_lib("computecore.lib"  "computecore.h" HAS_COMPUTECORE)
+  check_pragma_lib("computenetwork.lib" "computenetwork.h" HAS_COMPUTENETWORK)
+  check_pragma_lib("virtdisk.lib" "virtdisk.h" HAS_VIRTDISK)
+
+  if(NOT (HAS_COMPUTECORE AND HAS_COMPUTENETWORK AND HAS_VIRTDISK))
+    message(FATAL_ERROR
+      "[hyperv_api] One or more required libraries are missing:\n"
+      "  HAS_COMPUTECORE_LIB=${HAS_COMPUTECORE_LIB}\n"
+      "  HAS_COMPUTENETWORK_LIB=${HAS_COMPUTENETWORK_LIB}\n"
+      "  HAS_VIRTDISK_LIB=${HAS_VIRTDISK_LIB}\n"
+    )
+  endif()
+
+  add_library(hyperv_api_backend STATIC
+    hyperv_api_common.cpp
+    hcn/hyperv_hcn_api_wrapper.cpp
+    hcs/hyperv_hcs_api_wrapper.cpp
+    virtdisk/virtdisk_api_wrapper.cpp
+  )
+
+  target_link_libraries(hyperv_api_backend PRIVATE
+    fmt::fmt-header-only
+    utils
+    computecore.lib
+    computenetwork.lib
+    virtdisk.lib
+  )
+endif()

src/platform/backends/hyperv_api/hcn/hyperv_hcn_api_table.h

@@ -0,0 +1,88 @@
+/*
+ * 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 as published by
+ * the Free Software Foundation; version 3.
+ *
+ * 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/>.
+ *
+ */
+
+#ifndef MULTIPASS_HYPERV_API_HCN_API_TABLE
+#define MULTIPASS_HYPERV_API_HCN_API_TABLE
+
+// clang-format off
+// (xmkg): clang-format is messing with the include order.
+#include <windows.h>
+#include <computenetwork.h>
+#include <objbase.h> // for CoTaskMemFree
+// clang-format on
+
+#include <fmt/format.h>
+#include <functional>
+
+namespace multipass::hyperv::hcn
+{
+
+/**
+ * API function table for the Host Compute Network API
+ */
+struct HCNAPITable
+{
+    // @ref https://learn.microsoft.com/en-us/virtualization/api/hcn/reference/hcncreatenetwork
+    std::function<decltype(HcnCreateNetwork)> CreateNetwork = &HcnCreateNetwork;
+    // @ref https://learn.microsoft.com/en-us/virtualization/api/hcn/reference/hcnopennetwork
+    std::function<decltype(HcnOpenNetwork)> OpenNetwork = &HcnOpenNetwork;
+    // @ref https://learn.microsoft.com/en-us/virtualization/api/hcn/reference/hcndeletenetwork
+    std::function<decltype(HcnDeleteNetwork)> DeleteNetwork = &HcnDeleteNetwork;
+    // @ref https://learn.microsoft.com/en-us/virtualization/api/hcn/reference/hcnclosenetwork
+    std::function<decltype(HcnCloseNetwork)> CloseNetwork = &HcnCloseNetwork;
+    // @ref https://learn.microsoft.com/en-us/virtualization/api/hcn/reference/hcncreateendpoint
+    std::function<decltype(HcnCreateEndpoint)> CreateEndpoint = &HcnCreateEndpoint;
+    // @ref https://learn.microsoft.com/en-us/virtualization/api/hcn/reference/hcnopenendpoint
+    std::function<decltype(HcnOpenEndpoint)> OpenEndpoint = &HcnOpenEndpoint;
+    // @ref https://learn.microsoft.com/en-us/virtualization/api/hcn/reference/hcndeleteendpoint
+    std::function<decltype(HcnDeleteEndpoint)> DeleteEndpoint = &HcnDeleteEndpoint;
+    // @ref https://learn.microsoft.com/en-us/virtualization/api/hcn/reference/hcndeleteendpoint
+    std::function<decltype(HcnCloseEndpoint)> CloseEndpoint = &HcnCloseEndpoint;
+    // @ref https://learn.microsoft.com/en-us/windows/win32/api/combaseapi/nf-combaseapi-cotaskmemfree
+    std::function<decltype(::CoTaskMemFree)> CoTaskMemFree = &::CoTaskMemFree;
+};
+
+} // namespace multipass::hyperv::hcn
+
+/**
+ * Formatter type specialization for HCNAPITable
+ */
+template <typename Char>
+struct fmt::formatter<multipass::hyperv::hcn::HCNAPITable, Char>
+{
+    constexpr auto parse(basic_format_parse_context<Char>& ctx)
+    {
+        return ctx.begin();
+    }
+
+    template <typename FormatContext>
+    auto format(const multipass::hyperv::hcn::HCNAPITable& api, FormatContext& ctx) const
+    {
+        return format_to(ctx.out(),
+                         "CreateNetwork: ({}) | OpenNetwork: ({}) | DeleteNetwork: ({}) | CreateEndpoint: ({}) | "
+                         "OpenEndpoint: ({}) | DeleteEndpoint: ({}) | CoTaskMemFree: ({})",
+                         static_cast<bool>(api.CreateNetwork),
+                         static_cast<bool>(api.OpenNetwork),
+                         static_cast<bool>(api.DeleteNetwork),
+                         static_cast<bool>(api.CreateEndpoint),
+                         static_cast<bool>(api.OpenEndpoint),
+                         static_cast<bool>(api.DeleteEndpoint),
+                         static_cast<bool>(api.CoTaskMemFree));
+    }
+};
+
+#endif // MULTIPASS_HYPERV_API_HCN_API_TABLE