C# - WSL 2 VM의 VM ID를 알아내는 방법 - Host Compute System API
전에 Hyper-V의 VM ID를 구하는 방법을 설명한 적이 있는데요, 아쉽게도 WSL 2 VM의 경우에는 그 목록에 나타나지 않습니다. 그래서 우회적으로 VM 프로세스를 담당하는 vmwp.exe에 로드된 (고유할 것 같은) DLL을 통해 ID를 구하려고 했는데요, 좀 더 알아보니 hcsdiag 명령어로 해당 ID를 구하는 방법이 있었습니다.
// 관리자 권한으로 실행
C:\temp> hcsdiag list
2db85446-7cd0-42ba-5ba8-49bd746a7d94
VM, Created, 2db85446-7cd0-42ba-5ba8-49bd746a7d94, VMMS
c64e96b9-5235-a53f-8b5f-61ca294c5a19
VM, Running, c64e96b9-5235-a53f-8b5f-61ca294c5a19, WSL
C:\temp> hcsdiag list -raw | json_pp
[
{
"Id": "2db85446-7cd0-42ba-5ba8-49bd746a7d94",
"SystemType": "VirtualMachine",
"Name": "testwin10",
"Owner": "VMMS",
"RuntimeId": "2db85446-7cd0-42ba-5ba8-49bd746a7d94"
},
{
"Id": "c64e96b9-5235-a53f-8b5f-61ca294c5a19",
"SystemType": "VirtualMachine",
"Owner": "WSL",
"RuntimeId": "c64e96b9-5235-a53f-8b5f-61ca294c5a19",
"State": "Running"
}
]
이런 결과를 코드로 구하고 싶다면 Host Compute System API를 사용할 수 있습니다. (hcsdiag.exe의 "HCS"도 그것의 약자에서 온 것입니다.)
Host Compute System Overview
; https://learn.microsoft.com/en-us/virtualization/api/hcs/overview
C#의 경우라면 DllImport로 관련 API를 감싸면 되는데요,
using System.Runtime.InteropServices;
namespace hvm_enum;
internal class HostComputeInterop
{
[DllImport("ComputeCore.dll")]
public unsafe static extern IntPtr HcsCreateOperation(IntPtr context, delegate* unmanaged[Stdcall]<IntPtr, IntPtr, void> callback);
[DllImport("ComputeCore.dll")]
public static extern HRESULT HcsEnumerateComputeSystems(string? query, /*HCS_OPERATION*/ IntPtr operation);
[DllImport("ComputeCore.dll")]
public static extern void HcsCloseOperation(/*HCS_OPERATION*/ IntPtr operation);
[DllImport("ComputeCore.dll")]
public static extern HRESULT HcsWaitForOperationResult(/*HCS_OPERATION*/ IntPtr operation, int timeoutMs, [MarshalAs(UnmanagedType.LPWStr)] out string resultDocument);
}
public class ComputeSystem
{
public string Id { get; set; } = "";
public string SystemType { get; set; } = "";
public string Name { get; set; } = "";
public string Owner { get; set; } = "";
public string RuntimeId { get; set; } = "";
}
단순히 열거하는 기능만이라면 아래의 문서에 나온 C++ 예제를 참고해,
Enumerate all compute systems
; https://learn.microsoft.com/en-us/virtualization/api/hcs/reference/computesystemsample#enumerate-all-compute-systems
이런 식으로 포팅할 수 있습니다.
public static void ListRunningVMs()
{
IntPtr pOperation = HostComputeInterop.HcsCreateOperation(IntPtr.Zero, null);
if (pOperation == IntPtr.Zero)
{
Console.WriteLine("Failed to create operation");
return;
}
HRESULT hr = HostComputeInterop.HcsEnumerateComputeSystems(null, pOperation);
hr.ThrowIfFail();
try
{
hr = HostComputeInterop.HcsWaitForOperationResult(pOperation, Timeout.Infinite, out string resultDocument);
hr.ThrowIfFail();
Console.WriteLine(FormatJson(resultDocument));
var vmList = System.Text.Json.JsonSerializer.Deserialize<ComputeSystem[]>(resultDocument);
if (vmList != null)
{
foreach (var item in vmList)
{
Console.WriteLine($"{item.Name}, {item.Id}");
}
}
}
finally
{
HostComputeInterop.HcsCloseOperation(pOperation);
}
}
/*
// 관리자 권한으로 실행하지 않으면, 권한 오류 발생
Unhandled exception. System.Runtime.InteropServices.COMException (0x80370114): The operation could not be started because a required feature is not installed. (0x80370114)
at hvm_enum.HRESULT.ThrowIfFail()
at hvm_enum.Program.ListVMs()
at hvm_enum.Program.Main(String[] args)
*/
그나저나, Host Compute System이 제공하는 API는 뭐랄까... 그동안의 Win32 API 형식과 비교해 값의 처리 방식이 색다르다는 점이 재미있습니다. 위의 프로그램을 실행해 HcsWaitForOperationResult로 반환받은 문자열은 이런 식인데요, (hcsdiag list -raw의 결과와 동일합니다.)
[
{
"Id": "2db85446-7cd0-42ba-5ba8-49bd746a7d94",
"SystemType": "VirtualMachine",
"Name": "testwin10",
"Owner": "VMMS",
"RuntimeId": "2db85446-7cd0-42ba-5ba8-49bd746a7d94"
},
{
"Id": "c64e96b9-5235-a53f-8b5f-61ca294c5a19",
"SystemType": "VirtualMachine",
"Owner": "WSL",
"RuntimeId": "c64e96b9-5235-a53f-8b5f-61ca294c5a19",
"State": "Running"
}
]
말 그대로 API의 반환값을 JSON 문자열로 퉁쳐버린 것입니다. 만약 예의 Win32 API 방식이었다면 이런 경우 관련 구조체를 정의하고 그것의 배열로 반환했을 텐데 말이죠. ^^
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
Hyper-V 관련 API를 관리자 권한 없이 실행하는 경우 언제나 권한 오류가 발생합니다. 일례로 "hcsdiag" 명령어의 경우 이런 오류가 나오는데요,
Insufficient privileges. Only administrators or users that are members of the Hyper-V Administrators user group are permitted to access virtual machines or containers. To add yourself to the Hyper-V Administrators user group, please see
https://aka.ms/hcsadmin for more information.
특별히 보안에 문제가 되지 않는다면 (가령 로컬에서 테스트하는 상황 등에서는) 위의 메시지에 따라 "Hyper-V Administrators" 그룹에 사용자를 추가해 그런 제약을 없앨 수 있습니다. 참고로, 그룹에 사용자를 추가한 다음 (로그오프 후) 다시 로그인을 해야 권한이 적용됩니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]