Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (seongtaejeong at gmail.com)
홈페이지
첨부 파일
(연관된 글이 2개 있습니다.)

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" 그룹에 사용자를 추가해 그런 제약을 없앨 수 있습니다. 참고로, 그룹에 사용자를 추가한 다음 (로그오프 후) 다시 로그인을 해야 권한이 적용됩니다.




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]






[최초 등록일: ]
[최종 수정일: 8/6/2024]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




1  2  [3]  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13868정성태1/17/20253096Windows: 277. Hyper-V - Windows 11 VM의 Enhanced Session 모드로 로그인을 할 수 없는 문제
13867정성태1/17/20254033오류 유형: 943. Hyper-V에 Windows 11 설치 시 "This PC doesn't currently meet Windows 11 system requirements" 오류
13866정성태1/16/20254231개발 환경 구성: 739. Windows 10부터 바뀐 device driver 서명 방법
13865정성태1/15/20253930오류 유형: 942. C# - .NET Framework 4.5.2 이하의 버전에서 HttpWebRequest로 https 호출 시 "System.Net.WebException" 예외 발생
13864정성태1/15/20253879Linux: 114. eBPF를 위해 필요한 SELinux 보안 정책
13863정성태1/14/20253330Linux: 113. Linux - 프로세스를 위한 전용 SELinux 보안 문맥 지정
13862정성태1/13/20253601Linux: 112. Linux - 데몬을 위한 SELinux 보안 정책 설정
13861정성태1/11/20253907Windows: 276. 명령행에서 원격 서비스를 동기/비동기로 시작/중지
13860정성태1/10/20253586디버깅 기술: 216. WinDbg - 2가지 유형의 식 평가 방법(MASM, C++)
13859정성태1/9/20253939디버깅 기술: 215. Windbg - syscall 이후 실행되는 KiSystemCall64 함수 및 SSDT 디버깅
13858정성태1/8/20254091개발 환경 구성: 738. PowerShell - 원격 호출 시 "powershell.exe"가 아닌 "pwsh.exe" 환경으로 명령어를 실행하는 방법
13857정성태1/7/20254122C/C++: 187. Golang - 콘솔 응용 프로그램을 Linux 데몬 서비스를 지원하도록 변경파일 다운로드1
13856정성태1/6/20253698디버깅 기술: 214. Windbg - syscall 단계까지의 Win32 API 호출 (예: Sleep)
13855정성태12/28/20244429오류 유형: 941. Golang - os.StartProcess() 사용 시 오류 정리
13854정성태12/27/20244528C/C++: 186. Golang - 콘솔 응용 프로그램을 NT 서비스를 지원하도록 변경파일 다운로드1
13853정성태12/26/20244012디버깅 기술: 213. Windbg - swapgs 명령어와 (Ring 0 커널 모드의) FS, GS Segment 레지스터
13852정성태12/25/20244453디버깅 기술: 212. Windbg - (Ring 3 사용자 모드의) FS, GS Segment 레지스터파일 다운로드1
13851정성태12/23/20244215디버깅 기술: 211. Windbg - 커널 모드 디버깅 상태에서 사용자 프로그램을 디버깅하는 방법
13850정성태12/23/20244711오류 유형: 940. "Application Information" 서비스를 중지한 경우, "This file does not have an app associated with it for performing this action."
13849정성태12/20/20244859디버깅 기술: 210. Windbg - 논리(가상) 주소를 Segmentation을 거쳐 선형 주소로 변경
13848정성태12/18/20244806디버깅 기술: 209. Windbg로 알아보는 Prototype PTE파일 다운로드2
13847정성태12/18/20244823오류 유형: 939. golang - 빌드 시 "unknown directive: toolchain" 오류 빌드 시 이런 오류가 발생한다면?
13846정성태12/17/20245038디버깅 기술: 208. Windbg로 알아보는 Trans/Soft PTE와 2가지 Page Fault 유형파일 다운로드1
13845정성태12/16/20244512디버깅 기술: 207. Windbg로 알아보는 PTE (_MMPTE)
13844정성태12/14/20245176디버깅 기술: 206. Windbg로 알아보는 PFN (_MMPFN)파일 다운로드1
13843정성태12/13/20244367오류 유형: 938. Docker container 내에서 빌드 시 error MSB3021: Unable to copy file "..." to "...". Access to the path '...' is denied.
1  2  [3]  4  5  6  7  8  9  10  11  12  13  14  15  ...