C# - Hyper-V Socket 통신(AF_HYPERV, AF_VSOCK)을 위한 EndPoint 사용자 정의
아래와 같은 문서가 있군요. ^^
Virtualization-Documentation/virtualization/hyper-v-on-windows/user-guide
- Make your own integration services
; https://learn.microsoft.com/en-us/virtualization/hyper-v-on-windows/user-guide/make-integration-service
vsock notes
; https://gist.github.com/nrdmn/7971be650919b112343b1cb2757a3fe6#vsock-notes
간단하게 정리하면, Hyper-V socket은 Host와 VM 간의 통신을 일반적인 TCP/IP가 아닌, 직접적인 메모리 공유를 통해 통신하기 때문에 매우 고속으로 동작한다는 장점이 있습니다. 게다가 AF_HYPERV/AF_VSOCK은 비단 Hyper-V뿐만 아니라 다양한 가상 머신 및 컨테이너 환경에서 도입된 것으로 보이는데요, 단지 (제가) 윈도우 환경에서 쉽게 테스트할 수 있어 이 글에서는 Hyper-V를 위한 방법 위주로 설명하겠습니다.
우선, 이 소켓이 정상적으로 동작하기 위해서는 Hyper-V 호스트 측에 서비스를 위한 Guid를 레지스트리에 미리 등록해야 합니다.
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Virtualization\GuestCommunicationServices
대충 아래와 같은 유형으로 등록하면 되는데요,
Windows Registry Editor Version 5.00
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Virtualization\GuestCommunicationServices\9866C7BC-0C89-4CB0-9427-5B526D1AE83B]
"ElementName"="MyGcs"
여기서 "9866C7BC-0C89-4CB0-9427-5B526D1AE83B" 값은 제 소켓 서비스를 위해 임의로 정한 값입니다. 반면, VM 측에는 설정이 없는데요, 따라서 준비는 이걸로 모두 끝입니다. ^^
자, 그럼 남은 것은 코딩인데요, 아쉽게도 현재 .NET 8에서도 Socket은 AF_HYPERV 관련 기능은 공식적으로 지원하지 않는 듯합니다. 일단, Socket 자원은 생성할 수 있는데,
// AF_HYPERV = 34;
// HV_PROTOCOL_RAW = 1;
// 호출은 되지만,
Socket server = new Socket(AF_HYPERV, SocketType.Stream, HV_PROTOCOL_RAW);
이후 Bind를 하려면 SOCKADDR_HV 구조체를 전달해야 하는데, 그것을 받는 Bind 메서드가 없어 우회적으로 Win32 API인 bind를 호출해야 합니다.
[DllImport("Ws2_32.dll")]
internal static extern int bind(IntPtr s, SOCKADDR_HV socketAddrName, int nameLen);
[StructLayout(LayoutKind.Sequential, Pack = 1)]
public struct SOCKADDR_HV
{
public ushort Family;
public ushort Reserved;
public Guid VmId;
public Guid ServiceId;
}
하지만 bind를 저렇게 수행했어도
Socket.Accept를 호출하게 되면 이런 오류가 발생합니다.
System.InvalidOperationException
HResult=0x80131509
Message=You must call the Bind method before performing this operation.
Source=System.Net.Sockets
StackTrace:
at System.Net.Sockets.Socket.Accept()
at ConsoleApp1.Program.ServerLoop(Socket server)
at ConsoleApp1.Program.RunAsServer()
at ConsoleApp1.Program.Main(String[] args)
왜냐하면 Accept 초기 코드에, (Socket.Bind 호출 시 초기화되는) 내부 필드인 _rightEndPoint 값이 설정돼 있는지 검사하기 때문입니다. 물론, 억지로 Reflection을 사용해 _rightEndPoint 값을 설정하면,
int result = HyperVSocket.bind(server.Handle, new SOCKADDR_HV
{
Family = (ushort)HyperVSocket.AF_HYPERV,
Reserved = 0,
VmId = HyperVSocket.HV_GUID_WILDCARD,
ServiceId = GcsGuid
}, Marshal.SizeOf<SOCKADDR_HV>());
MarkBind(server); // Socket.Bind() 호출 효과
server.Listen(5);
public static void MarkBind(Socket socket)
{
Type type = socket.GetType();
FieldInfo? fi = type.GetField("_rightEndPoint", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance);
EndPoint ep = new IPEndPoint(IPAddress.Any, 0);
fi?.SetValue(socket, ep);
}
Accept 진입까지 성공은 합니다. 하지만, 이후 클라이언트가 연결하면 다시 이런 오류가 발생합니다.
Unhandled exception. System.ArgumentException: The AddressFamily 34 is not valid for the System.Net.IPEndPoint end point. (Parameter 'socketAddress')
at System.Net.IPEndPoint.Create(SocketAddress socketAddress)
at System.Net.Sockets.Socket.Accept()
at ConsoleApp1.Program.ServerLoop(Socket server)
at ConsoleApp1.Program.RunAsServer()
at ConsoleApp1.Program.Main(String[] args)
따라서 이런 식으로 우회해서는, 결국 모든 호출을 Win32 Socket API로 도배해야 합니다.
재미있는 것은, 마이크로소프트가
Socket의 EndPoint를 abstract 타입으로 만들어놨다는 점입니다. 즉, 자유롭게 확장할 수 있게 한 것인데요, 따라서 우리가 임의로 Hyper-V Socket을 위한 EndPoint를 이렇게 만들어 주면 됩니다.
public class HVEndPoint : EndPoint
{
public override AddressFamily AddressFamily => HyperVSocket.AF_HYPERV;
Guid _serviceId;
Guid _vmId;
public HVEndPoint(Guid serviceId, Guid vmId)
{
_serviceId = serviceId;
_vmId = vmId;
}
public unsafe override EndPoint Create(SocketAddress sa)
{
using (var ptr = sa.Buffer.Pin())
{
SOCKADDR_HV dat = Marshal.PtrToStructure<SOCKADDR_HV>(new IntPtr(ptr.Pointer));
return new HVEndPoint(dat.ServiceId, dat.VmId);
}
}
public unsafe override SocketAddress Serialize()
{
SocketAddress sa = new SocketAddress(HyperVSocket.AF_HYPERV);
int length = Marshal.SizeOf<SOCKADDR_HV>();
sa.Size = length;
SOCKADDR_HV sockAddr = new SOCKADDR_HV
{
Family = (ushort)HyperVSocket.AF_HYPERV,
Reserved = 0,
VmId = _vmId,
ServiceId = _serviceId
};
using (var ptr = sa.Buffer.Pin())
{
Marshal.StructureToPtr<SOCKADDR_HV>(sockAddr, new IntPtr(ptr.Pointer), false);
}
return sa;
}
}
[StructLayout(LayoutKind.Sequential, Pack = 1)]
public struct SOCKADDR_HV
{
public ushort Family;
public ushort Reserved;
public Guid VmId;
public Guid ServiceId;
}
// 참고로, 다른 사용자가 구현한 EndPoint를 사용해도 됩니다.
// https://github.com/Wraith2/HyperVSockets/blob/master/HyperVEndPoint.cs
이걸 이용하면 이후 모든 Socket 호출이 자연스럽게 이뤄집니다. 즉, Hyper-V Socket을 위한 Server 측은 이렇게 만들 수 있고,
// 레지스트리에 등록했던 서비스 Guid
public static readonly Guid GcsGuid = new Guid("9866C7BC-0C89-4CB0-9427-5B526D1AE83B");
// WILDCARD 용도로 약속된 GUID 값
public static readonly Guid HV_GUID_WILDCARD = Guid.Empty;
Socket server;
if (OperatingSystem.IsLinux())
{
// 다음 기회에 설명
}
else
{
server = new Socket(HyperVSocket.AF_HYPERV, SocketType.Stream, HyperVSocket.HV_PROTOCOL_RAW);
server.Bind(new HVEndPoint(GcsGuid, HyperVSocket.HV_GUID_WILDCARD));
server.Listen(5);
while (true)
{
Socket socket = server.Accept();
// socket 통신
}
}
마찬가지로 클라이언트도 HVEndPoint로 이렇게 연결하면 됩니다.
public static readonly Guid HV_GUID_PARENT = new Guid("a42e7cda-d03f-480c-9cc2-a4de20abb878");
using (client = new Socket(HyperVSocket.AF_HYPERV, SocketType.Stream, HyperVSocket.HV_PROTOCOL_RAW))
{
int length = Marshal.SizeOf<SOCKADDR_HV>();
client.Connect(new HVEndPoint(GcsGuid, HyperVSocket.HV_GUID_PARENT));
// ... client 통신
}
(위의 프로그램을 실습하고 싶다면, 서버를 Host에, 클라이언트를 VM에 두고 실행하면 됩니다.)
간단하죠? ^^ 이렇게 쉬운데, 이유는 알 수 없지만 마이크로소프트는 아직 .NET 라이브러리에 HVEndPoint(물론, 그에 준하는 타입)를 추가하지 않은 상태입니다. 아마도 .NET 9 버전 즈음에는 추가되지 않을까 싶군요. ^^
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]