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

비밀번호

댓글 작성자
 




... 61  62  63  64  65  66  67  68  69  70  71  72  73  [74]  75  ...
NoWriterDateCnt.TitleFile(s)
12125정성태1/24/202018198VS.NET IDE: 141. IDE0019 - Use pattern matching
12124정성태1/23/202019928VS.NET IDE: 140. IDE1006 - Naming rule violation: These words must begin with upper case characters: ...
12123정성태1/23/202021463웹: 39. Google Analytics - gtag 함수를 이용해 페이지 URL 수정 및 별도의 이벤트 생성 방법 [2]
12122정성태1/20/202017795.NET Framework: 879. C/C++의 UNREFERENCED_PARAMETER 매크로를 C#에서 우회하는 방법(IDE0060 - Remove unused parameter '...')파일 다운로드1
12121정성태1/20/202017400VS.NET IDE: 139. Visual Studio - Error List: "Could not find schema information for the ..."파일 다운로드1
12120정성태1/19/202021085.NET Framework: 878. C# DLL에서 Win32 C/C++처럼 dllexport 함수를 제공하는 방법 - 네 번째 이야기(IL 코드로 직접 구현)파일 다운로드1
12119정성태1/17/202021331디버깅 기술: 160. Windbg 확장 DLL 만들기 (3) - C#으로 만드는 방법
12118정성태1/17/202022399개발 환경 구성: 466. C# DLL에서 Win32 C/C++처럼 dllexport 함수를 제공하는 방법 - 세 번째 이야기 [1]
12117정성태1/15/202020820디버깅 기술: 159. C# - 디버깅 중인 프로세스를 강제로 다른 디버거에서 연결하는 방법파일 다운로드1
12116정성태1/15/202021808디버깅 기술: 158. Visual Studio로 디버깅 시 sos.dll 확장 명령어를 (비롯한 windbg의 다양한 기능을) 수행하는 방법
12115정성태1/14/202021917디버깅 기술: 157. C# - PEB.ProcessHeap을 이용해 디버깅 중인지 확인하는 방법파일 다운로드1
12114정성태1/13/202023210디버깅 기술: 156. C# - PDB 파일로부터 심벌(Symbol) 및 타입(Type) 정보 열거 [1]파일 다운로드3
12113정성태1/12/202023437오류 유형: 590. Visual C++ 빌드 오류 - fatal error LNK1104: cannot open file 'atls.lib' [1]
12112정성태1/12/202017951오류 유형: 589. PowerShell - 원격 Invoke-Command 실행 시 "WinRM cannot complete the operation" 오류 발생
12111정성태1/12/202021753디버깅 기술: 155. C# - KernelMemoryIO 드라이버를 이용해 실행 프로그램을 숨기는 방법(DKOM: Direct Kernel Object Modification) [16]파일 다운로드1
12110정성태1/11/202022239디버깅 기술: 154. Patch Guard로 인해 블루 스크린(BSOD)가 발생하는 사례 [5]파일 다운로드1
12109정성태1/10/202018155오류 유형: 588. Driver 프로젝트 빌드 오류 - Inf2Cat error -2: "Inf2Cat, signability test failed."
12108정성태1/10/202019240오류 유형: 587. Kernel Driver 시작 시 127(The specified procedure could not be found.) 오류 메시지 발생
12107정성태1/10/202020903.NET Framework: 877. C# - 프로세스의 모든 핸들을 열람 - 두 번째 이야기
12106정성태1/8/202020905VC++: 136. C++ - OSR Driver Loader와 같은 Legacy 커널 드라이버 설치 프로그램 제작 [1]
12105정성태1/8/202019369디버깅 기술: 153. C# - PEB를 조작해 로드된 DLL을 숨기는 방법
12104정성태1/7/202021712DDK: 9. 커널 메모리를 읽고 쓰는 NT Legacy driver와 C# 클라이언트 프로그램 [4]
12103정성태1/7/202024800DDK: 8. Visual Studio 2019 + WDK Legacy Driver 제작- Hello World 예제 [1]파일 다운로드2
12102정성태1/6/202020074디버깅 기술: 152. User 권한(Ring 3)의 프로그램에서 _ETHREAD 주소(및 커널 메모리를 읽을 수 있다면 _EPROCESS 주소) 구하는 방법
12101정성태1/5/202021532.NET Framework: 876. C# - PEB(Process Environment Block)를 통해 로드된 모듈 목록 열람
12100정성태1/3/202018901.NET Framework: 875. .NET 3.5 이하에서 IntPtr.Add 사용
... 61  62  63  64  65  66  67  68  69  70  71  72  73  [74]  75  ...