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" {
+		listener9p, err := vn.Listen("tcp", net.JoinHostPort(configuration.GatewayIP, fmt.Sprintf("%d", constants.Plan9TcpPort)))
+		if err != nil {
+			return err
+		}
+		server9p, err := fs9p.New9pServer(listener9p, constants.GetHomeDir())
+		if err != nil {
+			return err
+		}
+		if err := server9p.Start(); err != nil {
+			return err
+		}
+	}
+
 	startupDone()
 
 	if logging.IsDebug() {

go.mod

@@ -31,7 +31,6 @@ require (
 	github.com/klauspost/compress v1.18.0
 	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.25.3
@@ -132,6 +131,7 @@ 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

pkg/crc/constants/constants.go

@@ -55,6 +55,9 @@ const (
 	OpenShiftIngressHTTPSPort = 443
 
 	BackgroundLauncherExecutable = "crc-background-launcher.exe"
+
+	Plan9Msize   = 1024 * 1024
+	Plan9TcpPort = 564
 )
 
 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,16 @@ 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 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
+}