9p: hvsock support

Author: redbeam

cmd/crc/cmd/daemon.go

@@ -252,25 +252,49 @@ func run(configuration *types.Configuration) error {
 
 	// 9p home directory sharing
 	if runtime.GOOS == "windows" && config.Get(crcConfig.EnableSharedDirs).AsBool() {
-		listener9p, err := vn.Listen("tcp", net.JoinHostPort(configuration.GatewayIP, fmt.Sprintf("%d", constants.Plan9TcpPort)))
+		// 9p over hvsock
+		listener9pHvsock, err := fs9p.GetHvsockListener(constants.Plan9HvsockGUID)
 		if err != nil {
 			return err
 		}
-		server9p, err := fs9p.New9pServer(listener9p, constants.GetHomeDir())
+		server9pHvsock, err := fs9p.New9pServer(listener9pHvsock, constants.GetHomeDir())
 		if err != nil {
 			return err
 		}
-		if err := server9p.Start(); err != nil {
+		if err := server9pHvsock.Start(); err != nil {
 			return err
 		}
 		defer func() {
-			if err := server9p.Stop(); err != nil {
-				logging.Warnf("error stopping 9p server: %v", err)
+			if err := server9pHvsock.Stop(); err != nil {
+				logging.Warnf("error stopping 9p server (hvsock): %v", err)
 			}
 		}()
 		go func() {
-			if err := server9p.WaitForError(); err != nil {
-				logging.Errorf("9p server error: %v", err)
+			if err := server9pHvsock.WaitForError(); err != nil {
+				logging.Errorf("9p server (hvsock) error: %v", err)
+			}
+		}()
+
+		// 9p over TCP (as a backup)
+		listener9pTCP, err := vn.Listen("tcp", net.JoinHostPort(configuration.GatewayIP, fmt.Sprintf("%d", constants.Plan9TcpPort)))
+		if err != nil {
+			return err
+		}
+		server9pTCP, err := fs9p.New9pServer(listener9pTCP, constants.GetHomeDir())
+		if err != nil {
+			return err
+		}
+		if err := server9pTCP.Start(); err != nil {
+			return err
+		}
+		defer func() {
+			if err := server9pTCP.Stop(); err != nil {
+				logging.Warnf("error stopping 9p server (tcp): %v", err)
+			}
+		}()
+		go func() {
+			if err := server9pTCP.WaitForError(); err != nil {
+				logging.Errorf("9p server (tcp) error: %v", err)
 			}
 		}()
 	}

go.mod

@@ -28,6 +28,7 @@ require (
 	github.com/klauspost/compress v1.18.1
 	github.com/klauspost/cpuid/v2 v2.3.0
 	github.com/kofalt/go-memoize v0.0.0-20220914132407-0b5d6a304579
+	github.com/linuxkit/virtsock v0.0.0-20220523201153-1a23e78aa7a2
 	github.com/mattn/go-colorable v0.1.14
 	github.com/mdlayher/vsock v1.2.1
 	github.com/onsi/ginkgo/v2 v2.27.2
@@ -131,7 +132,6 @@ require (
 	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
 	github.com/klauspost/pgzip v1.2.6 // indirect
 	github.com/letsencrypt/boulder v0.0.0-20240620165639-de9c06129bec // indirect
-	github.com/linuxkit/virtsock v0.0.0-20220523201153-1a23e78aa7a2 // indirect
 	github.com/lufia/plan9stats v0.0.0-20240909124753-873cd0166683 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect

packaging/windows/product.wxs.template

@@ -72,6 +72,11 @@
                             <RegistryValue Type="string" Name="ElementName" Value="gvisor-tap-vsock" KeyPath="yes"/>
                         </RegistryKey>
                     </Component>
+                    <Component Id="Hvsock9pRegistryEntry" Guid="*">
+                        <RegistryKey Root="HKLM" Key="Software\Microsoft\Windows NT\CurrentVersion\Virtualization\GuestCommunicationServices\00009000-FACB-11E6-BD58-64006A7986D3">
+                            <RegistryValue Type="string" Name="ElementName" Value="fs9p-hvsock" KeyPath="yes"/>
+                        </RegistryKey>
+                    </Component>
                 </Directory>
             </Directory>
         </Directory>
@@ -130,6 +135,7 @@
             <ComponentRef Id="AddToPath"/>
             <ComponentRef Id="AddUserToCrcUsers" />
             <ComponentRef Id="VsockRegistryEntry" />
+            <ComponentRef Id="Hvsock9pRegistryEntry" />
         </Feature>
         <UI>
             <UIRef Id="WixUI_ErrorProgressText"/>

pkg/crc/constants/constants.go

@@ -56,8 +56,10 @@ const (
 
 	BackgroundLauncherExecutable = "crc-background-launcher.exe"
 
-	Plan9Msize   = 1024 * 1024
-	Plan9TcpPort = 564
+	Plan9Msize      = 1024 * 1024
+	Plan9TcpPort    = 564
+	Plan9HvsockGUID = "00009000-FACB-11E6-BD58-64006A7986D3"
+	Plan9HvsockPort = 36864
 )
 
 var adminHelperExecutableForOs = map[string]string{

pkg/crc/machine/start.go

@@ -264,8 +264,12 @@ func configureSharedDirs(vm *virtualMachine, sshRunner *crcssh.Runner) error {
 			if _, _, err := sshRunner.RunPrivileged("Changing owner of mount directory", "chown", "core:core", mount.Target); err != nil {
 				return err
 			}
-			if _, _, err := sshRunner.Run("9pfs", constants.VSockGateway, mount.Target); err != nil {
-				return err
+			if _, _, err := sshRunner.Run("9pfs -V -p", fmt.Sprintf("%d", constants.Plan9HvsockPort), "2", mount.Target); err != nil {
+				logging.Warnf("Failed to connect to 9p server over hvsock: %v", err)
+				logging.Warnf("Falling back to 9p over TCP")
+				if _, _, err := sshRunner.Run("9pfs", constants.VSockGateway, mount.Target); err != nil {
+					return err
+				}
 			}
 
 		default:

pkg/fileserver/fs9p/server_fallback.go

@@ -0,0 +1,15 @@
+//go:build !windows
+
+package fs9p
+
+import (
+	"fmt"
+	"net"
+	"runtime"
+)
+
+// GetHvsockListener returns a net.Listener listening on the specified hvsock.
+// The used hvsock must already be defined before this function is called.
+func GetHvsockListener(hvsockGUID string) (net.Listener, error) {
+	return nil, fmt.Errorf("GetHvsockListener() not implemented on %s", runtime.GOOS)
+}

pkg/fileserver/fs9p/server_windows.go

@@ -0,0 +1,29 @@
+//go:build windows
+
+package fs9p
+
+import (
+	"fmt"
+	"net"
+
+	"github.com/linuxkit/virtsock/pkg/hvsock"
+)
+
+// GetHvsockListener returns a net.Listener listening on the specified hvsock.
+// The used hvsock must already be defined before this function is called.
+func GetHvsockListener(hvsockGUID string) (net.Listener, error) {
+	service, err := hvsock.GUIDFromString(hvsockGUID)
+	if err != nil {
+		return nil, fmt.Errorf("parsing hvsock guid %s: %w", hvsockGUID, err)
+	}
+
+	listener, err := hvsock.Listen(hvsock.Addr{
+		VMID:      hvsock.GUIDWildcard,
+		ServiceID: service,
+	})
+	if err != nil {
+		return nil, fmt.Errorf("retrieving listener for hvsock %s: %w", hvsockGUID, err)
+	}
+
+	return listener, nil
+}