9p: initial version

Author: redbeam

cmd/crc/cmd/daemon.go

@@ -11,6 +11,7 @@ import (
 	"os"
 	"os/signal"
 	"regexp"
+	"runtime"
 	"syscall"
 	"time"
 
@@ -24,6 +25,7 @@ import (
 	"github.com/crc-org/crc/v2/pkg/crc/constants"
 	"github.com/crc-org/crc/v2/pkg/crc/daemonclient"
 	"github.com/crc-org/crc/v2/pkg/crc/logging"
+	"github.com/crc-org/crc/v2/pkg/fileserver/fs9p"
 	"github.com/crc-org/machine/libmachine/drivers"
 	"github.com/docker/go-units"
 	"github.com/gorilla/handlers"
@@ -248,6 +250,21 @@ func run(configuration *types.Configuration) error {
 		}
 	}()
 
+	// 9p home directory sharing
+	if runtime.GOOS == "windows" {
+		if _, err := fs9p.StartHvsockShares([]fs9p.HvsockMount9p{{Path: constants.GetHomeDir(), HvsockGUID: constants.Plan9HvsockGUID}}); err != nil {
+			logging.Warnf("Failed to start 9p file server on hvsock: %v", err)
+			logging.Warnf("Falling back to 9p over TCP")
+			listener9p, err := vn.Listen("tcp", net.JoinHostPort(configuration.GatewayIP, fmt.Sprintf("%d", constants.Plan9TcpPort)))
+			if err != nil {
+				return err
+			}
+			if _, err := fs9p.StartShares([]fs9p.Mount9p{{Listener: listener9p, Path: constants.GetHomeDir()}}); err != nil {
+				return err
+			}
+		}
+	}
+
 	startupDone()
 
 	if logging.IsDebug() {

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

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

pkg/crc/machine/start.go

@@ -248,6 +248,7 @@ func configureSharedDirs(vm *virtualMachine, sshRunner *crcssh.Runner) error {
 			if _, _, err := sshRunner.RunPrivileged(fmt.Sprintf("Mounting %s", mount.Target), "mount", "-o", "context=\"system_u:object_r:container_file_t:s0\"", "-t", mount.Type, mount.Tag, mount.Target); err != nil {
 				return err
 			}
+
 		case "cifs":
 			smbUncPath := fmt.Sprintf("//%s/%s", hostVirtualIP, mount.Tag)
 			if _, _, err := sshRunner.RunPrivate("sudo", "mount", "-o", fmt.Sprintf("rw,uid=core,gid=core,username='%s',password='%s'", mount.Username, mount.Password), "-t", mount.Type, smbUncPath, mount.Target); err != nil {
@@ -257,6 +258,20 @@ func configureSharedDirs(vm *virtualMachine, sshRunner *crcssh.Runner) error {
 				}
 				return fmt.Errorf("Failed to mount CIFS/SMB share '%s' please make sure configured password is correct: %w", mount.Tag, err)
 			}
+
+		case "9p":
+			// change owner to core user to allow mounting to it as a non-root user
+			if _, _, err := sshRunner.RunPrivileged("Changing owner of mount directory", "chown core:core", mount.Target); err != nil {
+				return err
+			}
+			if _, _, err := sshRunner.Run("9pfs -V -p", fmt.Sprintf("%d", constants.Plan9HvsockPort), 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 192.168.127.1", mount.Target); err != nil {
+					return err
+				}
+			}
+
 		default:
 			return fmt.Errorf("Unknown Shared dir type requested: %s", mount.Type)
 		}

pkg/fileserver/fs9p/server.go

@@ -0,0 +1,87 @@
+package fs9p
+
+import (
+	"fmt"
+	"net"
+	"os"
+	"path/filepath"
+
+	"github.com/DeedleFake/p9"
+	"github.com/DeedleFake/p9/proto"
+	"github.com/crc-org/crc/v2/pkg/crc/constants"
+	"github.com/sirupsen/logrus"
+)
+
+type Server struct {
+	// Listener this server is bound to
+	Listener net.Listener
+	// Plan9 Filesystem type that holds the exposed directory
+	Filesystem p9.FileSystem
+	// Directory this server exposes
+	ExposedDir string
+	// Errors from the server being started will come out here
+	ErrChan chan error
+}
+
+// New9pServer exposes a single directory (and all children) via the given net.Listener
+// and returns the server struct.
+// Directory given must be an absolute path and must exist.
+func New9pServer(listener net.Listener, exposeDir string) (*Server, error) {
+	// Verify that exposeDir makes sense.
+	if !filepath.IsAbs(exposeDir) {
+		return nil, fmt.Errorf("path to expose to machine must be absolute: %s", exposeDir)
+	}
+	stat, err := os.Stat(exposeDir)
+	if err != nil {
+		return nil, fmt.Errorf("cannot stat path to expose to machine: %w", err)
+	}
+	if !stat.IsDir() {
+		return nil, fmt.Errorf("path to expose to machine must be a directory: %s", exposeDir)
+	}
+
+	fs := p9.FileSystem(p9.Dir(exposeDir))
+	errChan := make(chan error)
+
+	toReturn := new(Server)
+	toReturn.Listener = listener
+	toReturn.Filesystem = fs
+	toReturn.ExposedDir = exposeDir
+	toReturn.ErrChan = errChan
+
+	return toReturn, nil
+}
+
+// Start a server created by New9pServer.
+func (s *Server) Start() error {
+	go func() {
+		s.ErrChan <- proto.Serve(s.Listener, p9.Proto(), p9.FSConnHandler(s.Filesystem, constants.Plan9Msize))
+		close(s.ErrChan)
+	}()
+
+	// Just before returning, check to see if we got an error off server startup.
+	select {
+	case err := <-s.ErrChan:
+		return fmt.Errorf("starting 9p server: %w", err)
+	default:
+		logrus.Infof("Successfully started 9p server on %s for directory %s", s.Listener.Addr().String(), s.ExposedDir)
+		return nil
+	}
+}
+
+// Stop a running server.
+// Please note that this does *BAD THINGS* to clients if they are still running
+// when the server stops. Processes get stuck in I/O deep sleep and zombify, and
+// nothing I do other than restarting the VM can remove the zombies.
+func (s *Server) Stop() error {
+	if err := s.Listener.Close(); err != nil {
+		return err
+	}
+	logrus.Infof("Successfully stopped 9p server for directory %s", s.ExposedDir)
+	return nil
+}
+
+// WaitForError from a running server.
+func (s *Server) WaitForError() error {
+	err := <-s.ErrChan
+	return err
+}

pkg/fileserver/fs9p/shares.go

@@ -0,0 +1,61 @@
+package fs9p
+
+import (
+	"fmt"
+	"net"
+
+	"github.com/sirupsen/logrus"
+)
+
+// Mount9p represents an exposed directory path with the listener
+// the 9p server is bound to
+type Mount9p struct {
+	Path     string
+	Listener net.Listener
+}
+
+// HvsockMount9p represents an exposed directory path with the hvsock GUID
+// the 9p server is bound to
+type HvsockMount9p struct {
+	Path       string
+	HvsockGUID string
+}
+
+// StartShares starts a new 9p server for each of the supplied mounts.
+func StartShares(mounts []Mount9p) (servers []*Server, defErr error) {
+	servers9p := []*Server{}
+	for _, m := range mounts {
+		server, err := New9pServer(m.Listener, m.Path)
+		if err != nil {
+			return nil, fmt.Errorf("serving directory %s on %s: %w", m.Path, m.Listener.Addr().String(), err)
+		}
+
+		err = server.Start()
+		if err != nil {
+			return nil, fmt.Errorf("starting 9p server for directory %s: %w", m.Path, err)
+		}
+
+		servers9p = append(servers9p, server)
+
+		defer func() {
+			if defErr != nil {
+				if err := server.Stop(); err != nil {
+					logrus.Errorf("Error stopping 9p server: %v", err)
+				}
+			}
+		}()
+
+		serverDir := m.Path
+
+		go func() {
+			if err := server.WaitForError(); err != nil {
+				logrus.Errorf("Error from 9p server on %s for %s: %v", m.Listener.Addr().String(), serverDir, err)
+			} else {
+				// We do not expect server exits - this should run until the program exits.
+				logrus.Warnf("9p server on %s for %s exited without error", m.Listener.Addr().String(), serverDir)
+			}
+		}()
+	}
+
+	return servers9p, nil
+}

pkg/fileserver/fs9p/shares_fallback.go

@@ -0,0 +1,13 @@
+//go:build !windows
+
+package fs9p
+
+import (
+	"fmt"
+	"runtime"
+)
+
+// StartHvsockShares is only supported on Windows
+func StartHvsockShares(mounts []HvsockMount9p) ([]*Server, error) {
+	return nil, fmt.Errorf("StartHvsockShares() not implemented on %s", runtime.GOOS)
+}

pkg/fileserver/fs9p/shares_windows.go

@@ -0,0 +1,33 @@
+package fs9p
+
+import (
+	"fmt"
+
+	"github.com/linuxkit/virtsock/pkg/hvsock"
+	"github.com/sirupsen/logrus"
+)
+
+// StartHvsockShares starts serving the given shares on hvsocks instead of TCP sockets.
+// The hvsocks used must already be defined before StartHvsockShares is called.
+func StartHvsockShares(mounts []HvsockMount9p) ([]*Server, error) {
+	mounts9p := []Mount9p{}
+	for _, mount := range mounts {
+		service, err := hvsock.GUIDFromString(mount.HvsockGUID)
+		if err != nil {
+			return nil, fmt.Errorf("parsing hvsock guid %s: %w", mount.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", mount.HvsockGUID, err)
+		}
+
+		logrus.Debugf("Going to serve directory %s on hvsock %s", mount.Path, mount.HvsockGUID)
+		mounts9p = append(mounts9p, Mount9p{Path: mount.Path, Listener: listener})
+	}
+
+	return StartShares(mounts9p)
+}