finalize NSC image production from CMake, leave a few comments regarding HyperV runner

Author: AnastaZIuk

tools/nsc/CMakeLists.txt

@@ -9,6 +9,8 @@ set(NBL_NSC_PREINSTALL_DIRECTORY "${GODBOLT_BINARY_PRETEST_DIRECTORY}/.preinstal
 make_directory("${NBL_NSC_PREINSTALL_DIRECTORY}")
 
 set(NBL_DOCKER_CT_NSC_VOLUME_SOURCE "${GODBOLT_BINARY_DIRECTORY}/install")
+set(NBL_DOCKER_CTX_DIR "${GODBOLT_BINARY_DIRECTORY}/.ctx")
+make_directory("${NBL_DOCKER_CTX_DIR}")
 
 set(NBL_DOCKER_INSTALL_BAT_FILENAME install-production.bat)
 set(NBL_DOCKER_CT_NSC_INSTALL_BAT "${NBL_DOCKER_CT_NSC_VOLUME_SOURCE}/${NBL_DOCKER_INSTALL_BAT_FILENAME}")
@@ -57,61 +59,80 @@ add_test(NAME NBL_NSC_DUMP_BUILD_INFO_TEST
 
 if(NBL_ENABLE_DOCKER_INTEGRATION)
 
+set(BASE_IMAGE ghcr.io/devsh-graphics-programming/compiler-explorer-docker:nano-2022)
+
 find_program(CTEST_EXE NAMES ctest REQUIRED)
 find_program(DOCKER_EXE NAMES docker REQUIRED)
 
 find_file(DXIL_DLL NAMES dxil.dll HINTS "$ENV{CMAKE_WINDOWS_KITS_10_DIR}/Redist/D3D/x64" "C:/Program Files (x86)/Windows Kits/10/Redist/D3D/x64" REQUIRED)
-cmake_path(GET DXIL_DLL PARENT_PATH DXIL_DIR)
-cmake_path(NATIVE_PATH DXIL_DIR NORMALIZE DXIL_DIR)
 
 find_file(ICU_DLL NAMES icu.dll HINTS REQUIRED)
-cmake_path(GET ICU_DLL PARENT_PATH ICU_DIR)
-cmake_path(NATIVE_PATH ICU_DIR NORMALIZE ICU_DIR)
 set(ICU_GLOBALIZATION_DIR "C:/Windows/Globalization/ICU")
 find_file(ICUDTL_DAT NAMES icudtl.dat HINTS "${ICU_GLOBALIZATION_DIR}" REQUIRED)
 
 find_file(UCRTBASED_DLL NAMES ucrtbased.dll HINTS ${UCRTBASED_DLL_DIR} REQUIRED)
-cmake_path(GET UCRTBASED_DLL PARENT_PATH UCRTBASED_DIR)
-cmake_path(NATIVE_PATH UCRTBASED_DIR NORMALIZE UCRTBASED_DIR)
 
 find_program(SPIRV_DIS_EXE NAMES spirv-dis HINTS "${VULKAN_SDK}/Bin" REQUIRED)
 cmake_path(GET SPIRV_DIS_EXE PARENT_PATH SPIRV_DIS_DIR)
 cmake_path(NATIVE_PATH SPIRV_DIS_DIR NORMALIZE SPIRV_DIS_DIR)
 
+include(InstallRequiredSystemLibraries)
 cmake_path(NATIVE_PATH MSVC_REDIST_DIR NORMALIZE TOOLSET_REDIST_PATH)
 
 file(GLOB_RECURSE VC_MODULES LIST_DIRECTORIES false
   "${TOOLSET_REDIST_PATH}/x64/*.CRT/*.dll"
   "${TOOLSET_REDIST_PATH}/debug_nonredist/x64/*.DebugCRT/*.dll"
 )
 
-foreach(MODULE ${VC_MODULES})
-  get_filename_component(DIR ${MODULE} DIRECTORY)
-  cmake_path(NATIVE_PATH DIR NORMALIZE DIR)
-  list(APPEND VC_MODULE_DIRS ${DIR})
-endforeach()
-
-if(NOT VC_MODULE_DIRS)
+if(NOT VC_MODULES)
   message(FATAL_ERROR "Failed to GLOB for VC Redist modules!")
 endif()
 
+make_directory("${NBL_DOCKER_CTX_DIR}/Runtimes")
+make_directory("${NBL_DOCKER_CTX_DIR}/Nabla")
+execute_process(
+  COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${DXIL_DLL}" "${NBL_DOCKER_CTX_DIR}/Runtimes"
+  COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${ICU_DLL}" "${NBL_DOCKER_CTX_DIR}/Runtimes"
+  COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${UCRTBASED_DLL}" "${NBL_DOCKER_CTX_DIR}/Runtimes"
+  COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${SPIRV_DIS_EXE}" "${NBL_DOCKER_CTX_DIR}/Runtimes"
+  COMMAND "${CMAKE_COMMAND}" -E copy_if_different ${VC_MODULES} "${NBL_DOCKER_CTX_DIR}/Runtimes"
+  COMMAND "${CMAKE_COMMAND}" -E copy_directory_if_different ${ICU_GLOBALIZATION_DIR} "${NBL_DOCKER_CTX_DIR}/Globalization/ICU"
+)
+
 set(CT_RUNTIMES C:/pack/runtimes)
 cmake_path(NATIVE_PATH CT_RUNTIMES NORMALIZE CT_RUNTIMES)
-set(HOST_MOUNT_DIRS ${VC_MODULE_DIRS} ${SPIRV_DIS_DIR} ${UCRTBASED_DIR} ${DXIL_DIR} ${ICU_DIR})
-list(REMOVE_DUPLICATES HOST_MOUNT_DIRS)
 
-set(ix 0)
-foreach(DIR ${HOST_MOUNT_DIRS})
-  set(TARGET_MOUNT_DIR "${CT_RUNTIMES}/system/${ix}")
-  cmake_path(NATIVE_PATH TARGET_MOUNT_DIR NORMALIZE TARGET_MOUNT_DIR)
+set(NBL_DOCKER_CT_NSC_VOLUME_TARGET "${CT_RUNTIMES}/Nabla")
+cmake_path(NATIVE_PATH NBL_DOCKER_CT_NSC_VOLUME_SOURCE NORMALIZE NBL_DOCKER_CT_NSC_VOLUME_SOURCE)
+cmake_path(NATIVE_PATH NBL_DOCKER_CT_NSC_VOLUME_TARGET NORMALIZE NBL_DOCKER_CT_NSC_VOLUME_TARGET)
+cmake_path(NATIVE_PATH NBL_NSC_PREINSTALL_DIRECTORY NORMALIZE NBL_NSC_PREINSTALL_DIRECTORY)
+
+string(CONFIGURE [=[
+# syntax=docker/dockerfile:1
+# escape=`
+FROM @BASE_IMAGE@
+USER ContainerAdministrator
 
-  list(APPEND DOCKER_CLI_ARGS -v "${DIR}:${TARGET_MOUNT_DIR}:ro")
-  list(APPEND CT_MOUNT_DIRS "${TARGET_MOUNT_DIR}")
+COPY Runtimes/ C:/Windows/System32/
+COPY Globalization/ICU/ C:/Windows/Globalization/ICU/
 
-  math(EXPR ix "${ix} + 1" OUTPUT_FORMAT DECIMAL)
-endforeach()
+COPY Nabla/ @NBL_DOCKER_CT_NSC_VOLUME_TARGET@
+COPY hlsl.local.properties.cmake C:/Compiler-Explorer/etc/config/hlsl.local.properties
+
+ENV NBL_INSTALL_DIRECTORY=@NBL_DOCKER_CT_NSC_VOLUME_TARGET@ `
+NBL_EXPLICIT_MODULE_LOAD_LOG=ON
+
+WORKDIR C:/Compiler-Explorer
+ENTRYPOINT ["node", "--no-warnings", "--no-deprecation", "--import=tsx", "./app.js", "--language", "hlsl"]
+]=] INSTRUCTIONS @ONLY)
+
+set(DOCKERFILE "${NBL_DOCKER_CTX_DIR}/Dockerfile")
+file(WRITE "${DOCKERFILE}" "${INSTRUCTIONS}")
+
+if(NOT DEFINED NSC_IMAGE_NAME)
+  set(NSC_IMAGE_NAME nano/godbolt/nsc)
+endif()
 
-set(NBL_DOCKER_CT_NSC_VOLUME_TARGET "${CT_RUNTIMES}/Nabla")
 set(NBL_BUILD_INFO_POSTPROCESS_COMMAND
   "${CMAKE_COMMAND}"
   "-DNBL_EXECUTABLE_PATH=${NBL_NSC_PREINSTALL_TARGET_EXE_FILEPATH}"
@@ -120,13 +141,8 @@ set(NBL_BUILD_INFO_POSTPROCESS_COMMAND
   "-DNBL_OUTPUT_EXE_OVERRIDE=$<PATH:NORMAL_PATH,${NBL_DOCKER_CT_NSC_VOLUME_TARGET}/${NBL_PACKAGE_RUNTIME_EXE_DIR_PATH}/${NBL_NSC_PREINSTALL_TARGET_EXE_FILENAME}>"
   -P "${NBL_ROOT_PATH}/cmake/scripts/nbl/nablaBuildInfo.cmake"
 )
-cmake_path(NATIVE_PATH NBL_DOCKER_CT_NSC_VOLUME_SOURCE NORMALIZE NBL_DOCKER_CT_NSC_VOLUME_SOURCE)
-cmake_path(NATIVE_PATH NBL_DOCKER_CT_NSC_VOLUME_TARGET NORMALIZE NBL_DOCKER_CT_NSC_VOLUME_TARGET)
-cmake_path(NATIVE_PATH NBL_NSC_PREINSTALL_DIRECTORY NORMALIZE NBL_NSC_PREINSTALL_DIRECTORY)
-list(APPEND DOCKER_CLI_ARGS -v "${NBL_NSC_PREINSTALL_DIRECTORY}:${NBL_DOCKER_CT_NSC_VOLUME_TARGET}")
-#list(APPEND DOCKER_CLI_ARGS -v "${ICU_GLOBALIZATION_DIR}:${ICU_GLOBALIZATION_DIR}:ro")
 
-set(NBL_DOCKER_NSC_COMPILER_CONFIG_OUTPUT "${NBL_DOCKER_CT_NSC_VOLUME_SOURCE}/hlsl.local.properties.cmake")
+set(NBL_DOCKER_NSC_COMPILER_CONFIG_OUTPUT "${NBL_DOCKER_CTX_DIR}/hlsl.local.properties.cmake")
 string(GENEX_STRIP "${NBL_PACKAGE_RUNTIME_EXE_DIR_PATH}" NBL_RELATIVE_ENTRY)
 set(OUTPUT_CONFIG_FILE $<PATH:NORMAL_PATH,${NBL_DOCKER_NSC_COMPILER_CONFIG_OUTPUT}>)
 set(NBL_CE_GENERATE_CONFIG_COMMAND
@@ -139,25 +155,6 @@ set(NBL_CE_GENERATE_CONFIG_COMMAND
   -P "${CMAKE_CURRENT_SOURCE_DIR}/ce-generate-config.cmake"
 )
 
-set(CT_ENV_FILE "${CMAKE_CURRENT_BINARY_DIR}/.env")
-string(CONFIGURE [=[
-CT_MOUNT_DIRS=@CT_MOUNT_DIRS@
-NBL_INSTALL_DIRECTORY=@NBL_DOCKER_CT_NSC_VOLUME_TARGET@
-NBL_EXPLICIT_MODULE_LOAD_LOG=ON
-]=] ENV_CONTENT @ONLY)
-file(WRITE "${CT_ENV_FILE}" "${ENV_CONTENT}")
-list(APPEND DOCKER_CLI_ARGS --env-file "${CT_ENV_FILE}")
-
-set(CT_SETUP_FILE "${CMAKE_CURRENT_BINARY_DIR}/setup.bat")
-string(CONFIGURE [=[
-@echo off
-set "PATH=%PATH%;%CT_MOUNT_DIRS%"
-setx PATH "%PATH%" /M
-node --no-warnings --no-deprecation --import=tsx ./app.js --language hlsl
-]=] SETUP_CONTENT @ONLY)
-file(WRITE "${CT_SETUP_FILE}" "${SETUP_CONTENT}")
-list(APPEND DOCKER_CLI_ARGS)
-
 function(PROMOTE_PROCESS_ISOLATION HOST_KERNEL BASE VAR)
     set(${VAR} True)
 
@@ -172,9 +169,9 @@ function(PROMOTE_PROCESS_ISOLATION HOST_KERNEL BASE VAR)
     macro(TO_PROCESS IMAGE TARGET_KERNEL)
       if(${HOST_KERNEL} VERSION_LESS ${TARGET_KERNEL})
           set(${VAR} False)
-          message(STATUS "Host kernel \"${HOST_KERNEL}\" version too low to promote process isolation for \"${IMAGE}\" [${TARGET_KERNEL}] and requires falling back to HyperV. Please update your host OS.")
+          message(STATUS "Host kernel \"${HOST_KERNEL}\" version too low to promote process isolation with \"${IMAGE}\" [${TARGET_KERNEL}] and requires falling back to HyperV. Please update your host OS.")
       else()
-        message(STATUS "Promoting \"${IMAGE}\" [${TARGET_KERNEL}] to process isolation with host kernel [${HOST_KERNEL}] version")
+        message(STATUS "\"${IMAGE}\" [${TARGET_KERNEL}] can be promoted to process isolation with host kernel [${HOST_KERNEL}] version")
       endif()
     endmacro()
 
@@ -195,12 +192,16 @@ endfunction()
 
 execute_process(COMMAND cmd /C ver OUTPUT_VARIABLE PIPE OUTPUT_STRIP_TRAILING_WHITESPACE)
 string(REGEX MATCH "[0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+" HOST_KERNEL "${PIPE}")
-
-set(BASE_IMAGE ghcr.io/devsh-graphics-programming/compiler-explorer-docker:nano-2022)
 PROMOTE_PROCESS_ISOLATION(${HOST_KERNEL} ${BASE_IMAGE} USE_PROCESS_ISOLATION)
 
 if(USE_PROCESS_ISOLATION)
-    list(APPEND DOCKER_CLI_ARGS --isolation process)
+  set(ISOLATION --isolation process)
+else()
+  # TODO: we will need to use GET_RUNTIME_DEPENDENCIES which uses objdump
+  # https://cmake.org/cmake/help/latest/command/file.html#get-runtime-dependencies
+  # to collect *all* required deps and copy (FROM at least server core) to destination
+  # image, it will fail currently if we fully isolate it with VM due to lack of certain DLLs
+  message(FATAL_ERROR "HyperV is NOT supported! Update your OS!") # yet
 endif()
 
 set(ORPHAN nsc-orphan)
@@ -210,20 +211,27 @@ set(NBL_CE_ENDPOINT_PY "${NBL_ROOT_PATH}/docker/compiler-explorer/endpoint.py")
 set(NBL_NSC_BASIC_HLSL_JPAYLOAD "${CMAKE_CURRENT_SOURCE_DIR}/docker/godbolt/hlsl-basic-compile-payload.json")
 
 add_custom_target(run-compiler-explorer ALL
-    COMMAND "${CMAKE_COMMAND}" -E cmake_echo_color --blue "Clearing NSC orphans.."
+    COMMAND "${CMAKE_COMMAND}" -E cmake_echo_color --blue "Killing remaining NSC orphans"
     COMMAND "${DOCKER_EXE}" rm -f ${ORPHAN} || "${CMAKE_COMMAND}" -E true
 
-    COMMAND "${CMAKE_COMMAND}" -E cmake_echo_color --blue "Executing CTests.."
+    COMMAND "${CMAKE_COMMAND}" -E cmake_echo_color --blue "Executing CTests"
     COMMAND "${CTEST_EXE}" -C $<CONFIG> --stop-on-failure
+
+    COMMAND "${CMAKE_COMMAND}" -E cmake_echo_color --blue "Generating NSC build info"
     COMMAND ${NBL_BUILD_INFO_POSTPROCESS_COMMAND}
+
+    COMMAND "${CMAKE_COMMAND}" -E cmake_echo_color --blue "Generating NSC godbolt config"
     COMMAND ${NBL_CE_GENERATE_CONFIG_COMMAND}
 
-    COMMAND "${CMAKE_COMMAND}" -E cmake_echo_color --blue "Running new NSC orphan container.."
-    COMMAND "${DOCKER_EXE}" run -di -p 80:10240 --name ${ORPHAN} --entrypoint cmd ${DOCKER_CLI_ARGS} ${BASE_IMAGE}
-    COMMAND "${DOCKER_EXE}" cp "${OUTPUT_CONFIG_FILE}" ${ORPHAN}:C:\\Compiler-Explorer\\etc\\config\\hlsl.local.properties
-    COMMAND "${DOCKER_EXE}" cp "${CT_SETUP_FILE}" ${ORPHAN}:C:\\setup.cmd
-    COMMAND "${DOCKER_EXE}" exec -d ${ORPHAN} C:\\setup.cmd
-    COMMAND "${_Python3_EXECUTABLE}" "${NBL_CE_HEALTHY_CHECK_PY}" --url "${NBL_CE_URL}" --interval 5 --ticks 25
+    COMMAND "${CMAKE_COMMAND}" -E cmake_echo_color --blue "Updating NSC package context"
+    COMMAND "${CMAKE_COMMAND}" -E copy_directory_if_different "${NBL_NSC_PREINSTALL_DIRECTORY}" "${NBL_DOCKER_CTX_DIR}/Nabla"
+
+    COMMAND "${CMAKE_COMMAND}" -E cmake_echo_color --blue "Building NSC Godbolt image"
+    COMMAND "${DOCKER_EXE}" build ${ISOLATION} -f "${DOCKERFILE}" -t ${NSC_IMAGE_NAME} "${NBL_DOCKER_CTX_DIR}"
+
+    COMMAND "${CMAKE_COMMAND}" -E cmake_echo_color --blue "Running new NSC orphan container"
+    COMMAND "${DOCKER_EXE}" run -di -p 80:10240 ${ISOLATION} --name ${ORPHAN} ${NSC_IMAGE_NAME}
+    COMMAND "${_Python3_EXECUTABLE}" "${NBL_CE_HEALTHY_CHECK_PY}" --url "${NBL_CE_URL}" --interval 5 --ticks 12
     COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --green "Compiler Explorer is running, type \"localhost\" in your browser!"
 
     COMMAND "${CMAKE_COMMAND}" -E cmake_echo_color --blue "Post-Checking if NSC container is able to compile basic shader input..."