github.com/pachyderm/pachyderm@v1.13.4/src/server/pfs/fuse/loopback.go

// Copyright 2019 the Go-FUSE Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package fuse

import (
	"context"
	"os"
	pathpkg "path"
	"path/filepath"
	"strings"
	"sync"
	"syscall"

	"github.com/hanwen/go-fuse/v2/fs"
	"github.com/hanwen/go-fuse/v2/fuse"

	"github.com/pachyderm/pachyderm/src/client"
	"github.com/pachyderm/pachyderm/src/client/pfs"
	"github.com/pachyderm/pachyderm/src/client/pkg/errors"
	pfsserver "github.com/pachyderm/pachyderm/src/server/pfs"
	"github.com/pachyderm/pachyderm/src/server/pkg/errutil"
)

type fileState int32

const (
	none  fileState = iota // we don't know about this file
	meta                   // we have meta information (but not content for this file)
	full                   // we have full content for this file
	dirty                  // we have full content for this file and the user has written to it
)

type loopbackRoot struct {
	loopbackNode

	rootPath string
	rootDev  uint64

	targetPath string

	write bool

	c *client.APIClient

	repoOpts map[string]*RepoOptions
	branches map[string]string
	commits  map[string]string
	files    map[string]fileState
	mu       sync.Mutex
}

type loopbackNode struct {
	fs.Inode
}

var _ = (fs.NodeStatfser)((*loopbackNode)(nil))
var _ = (fs.NodeStatfser)((*loopbackNode)(nil))
var _ = (fs.NodeGetattrer)((*loopbackNode)(nil))
var _ = (fs.NodeGetxattrer)((*loopbackNode)(nil))
var _ = (fs.NodeSetxattrer)((*loopbackNode)(nil))
var _ = (fs.NodeRemovexattrer)((*loopbackNode)(nil))
var _ = (fs.NodeListxattrer)((*loopbackNode)(nil))
var _ = (fs.NodeReadlinker)((*loopbackNode)(nil))
var _ = (fs.NodeOpener)((*loopbackNode)(nil))
var _ = (fs.NodeCopyFileRanger)((*loopbackNode)(nil))
var _ = (fs.NodeLookuper)((*loopbackNode)(nil))
var _ = (fs.NodeOpendirer)((*loopbackNode)(nil))
var _ = (fs.NodeReaddirer)((*loopbackNode)(nil))
var _ = (fs.NodeMkdirer)((*loopbackNode)(nil))
var _ = (fs.NodeMknoder)((*loopbackNode)(nil))
var _ = (fs.NodeLinker)((*loopbackNode)(nil))
var _ = (fs.NodeSymlinker)((*loopbackNode)(nil))
var _ = (fs.NodeUnlinker)((*loopbackNode)(nil))
var _ = (fs.NodeRmdirer)((*loopbackNode)(nil))
var _ = (fs.NodeRenamer)((*loopbackNode)(nil))

func (n *loopbackNode) Statfs(ctx context.Context, out *fuse.StatfsOut) syscall.Errno {
	s := syscall.Statfs_t{}
	err := syscall.Statfs(n.path(), &s)
	if err != nil {
		return fs.ToErrno(err)
	}
	out.FromStatfsT(&s)
	return fs.OK
}

func (r *loopbackRoot) Getattr(ctx context.Context, f fs.FileHandle, out *fuse.AttrOut) syscall.Errno {

	st := syscall.Stat_t{}
	err := syscall.Stat(r.rootPath, &st)
	if err != nil {
		return fs.ToErrno(err)
	}
	out.FromStat(&st)
	return fs.OK
}

func (n *loopbackNode) root() *loopbackRoot {
	return n.Root().Operations().(*loopbackRoot)
}

func (n *loopbackNode) c() *client.APIClient {
	return n.root().c
}

func (n *loopbackNode) path() string {
	path := n.Path(nil)
	return filepath.Join(n.root().rootPath, path)
}

func (n *loopbackNode) Lookup(ctx context.Context, name string, out *fuse.EntryOut) (*fs.Inode, syscall.Errno) {
	p := filepath.Join(n.path(), name)
	if err := n.download(p, meta); err != nil {
		return nil, fs.ToErrno(err)
	}

	st := syscall.Stat_t{}
	err := syscall.Lstat(p, &st)
	if err != nil {
		return nil, fs.ToErrno(err)
	}

	out.Attr.FromStat(&st)
	node := &loopbackNode{}
	ch := n.NewInode(ctx, node, n.root().idFromStat(&st))
	return ch, 0
}

func (n *loopbackNode) Mknod(ctx context.Context, name string, mode, rdev uint32, out *fuse.EntryOut) (*fs.Inode, syscall.Errno) {
	p := filepath.Join(n.path(), name)
	if errno := n.checkWrite(p); errno != 0 {
		return nil, errno
	}
	err := syscall.Mknod(p, mode, int(rdev))
	if err != nil {
		return nil, fs.ToErrno(err)
	}
	st := syscall.Stat_t{}
	if err := syscall.Lstat(p, &st); err != nil {
		syscall.Rmdir(p)
		return nil, fs.ToErrno(err)
	}

	out.Attr.FromStat(&st)

	node := &loopbackNode{}
	ch := n.NewInode(ctx, node, n.root().idFromStat(&st))

	return ch, 0
}

func (n *loopbackNode) Mkdir(ctx context.Context, name string, mode uint32, out *fuse.EntryOut) (*fs.Inode, syscall.Errno) {
	p := filepath.Join(n.path(), name)
	if errno := n.checkWrite(p); errno != 0 {
		return nil, errno
	}
	if err := n.download(p, meta); err != nil {
		return nil, fs.ToErrno(err)
	}
	err := os.Mkdir(p, os.FileMode(mode))
	if err != nil {
		return nil, fs.ToErrno(err)
	}
	st := syscall.Stat_t{}
	if err := syscall.Lstat(p, &st); err != nil {
		syscall.Rmdir(p)
		return nil, fs.ToErrno(err)
	}

	out.Attr.FromStat(&st)

	node := &loopbackNode{}
	ch := n.NewInode(ctx, node, n.root().idFromStat(&st))

	return ch, 0
}

func (n *loopbackNode) Rmdir(ctx context.Context, name string) syscall.Errno {
	p := filepath.Join(n.path(), name)
	if errno := n.checkWrite(p); errno != 0 {
		return errno
	}
	if err := n.download(p, meta); err != nil {
		return fs.ToErrno(err)
	}
	err := syscall.Rmdir(p)
	return fs.ToErrno(err)
}

func (n *loopbackNode) Unlink(ctx context.Context, name string) (errno syscall.Errno) {
	p := filepath.Join(n.path(), name)
	if errno := n.checkWrite(p); errno != 0 {
		return errno
	}
	if err := n.download(p, meta); err != nil {
		return fs.ToErrno(err)
	}
	defer func() {
		if errno == 0 {
			n.setFileState(p, dirty)
		}
	}()
	err := syscall.Unlink(p)
	return fs.ToErrno(err)
}

func toLoopbackNode(op fs.InodeEmbedder) *loopbackNode {
	if r, ok := op.(*loopbackRoot); ok {
		return &r.loopbackNode
	}
	return op.(*loopbackNode)
}

func (n *loopbackNode) Rename(ctx context.Context, name string, newParent fs.InodeEmbedder, newName string, flags uint32) syscall.Errno {
	newParentLoopback := toLoopbackNode(newParent)
	if flags&fs.RENAME_EXCHANGE != 0 {
		return n.renameExchange(name, newParentLoopback, newName)
	}

	p1 := filepath.Join(n.path(), name)

	p2 := filepath.Join(newParentLoopback.path(), newName)
	if errno := n.checkWrite(p1); errno != 0 {
		return errno
	}
	if errno := n.checkWrite(p2); errno != 0 {
		return errno
	}
	err := os.Rename(p1, p2)
	return fs.ToErrno(err)
}

func (r *loopbackRoot) idFromStat(st *syscall.Stat_t) fs.StableAttr {
	return fs.StableAttr{
		Mode: uint32(st.Mode),
		Gen:  1,
		Ino:  0, // let fuse generate this automatically
	}
}

var _ = (fs.NodeCreater)((*loopbackNode)(nil))

func (n *loopbackNode) Create(ctx context.Context, name string, flags uint32, mode uint32, out *fuse.EntryOut) (inode *fs.Inode, fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno) {
	p := filepath.Join(n.path(), name)
	if errno := n.checkWrite(p); errno != 0 {
		return nil, nil, 0, errno
	}
	if err := n.download(p, full); err != nil {
		return nil, nil, 0, fs.ToErrno(err)
	}
	defer func() {
		if errno == 0 {
			n.setFileState(p, dirty)
		}
	}()

	fd, err := syscall.Open(p, int(flags)|os.O_CREATE, mode)
	if err != nil {
		return nil, nil, 0, fs.ToErrno(err)
	}

	st := syscall.Stat_t{}
	if err := syscall.Fstat(fd, &st); err != nil {
		syscall.Close(fd)
		return nil, nil, 0, fs.ToErrno(err)
	}

	node := &loopbackNode{}
	ch := n.NewInode(ctx, node, n.root().idFromStat(&st))
	lf := NewLoopbackFile(fd)

	out.FromStat(&st)
	return ch, lf, 0, 0
}

func (n *loopbackNode) Symlink(ctx context.Context, target, name string, out *fuse.EntryOut) (_ *fs.Inode, errno syscall.Errno) {
	p := filepath.Join(n.path(), name)
	if errno := n.checkWrite(p); errno != 0 {
		return nil, errno
	}
	if err := n.download(p, full); err != nil {
		return nil, fs.ToErrno(err)
	}
	target = filepath.Join(n.root().rootPath, n.trimTargetPath(target))
	if err := n.download(target, full); err != nil {
		return nil, fs.ToErrno(err)
	}
	defer func() {
		if errno == 0 {
			n.setFileState(p, dirty)
		}
	}()
	err := syscall.Symlink(target, p)
	if err != nil {
		return nil, fs.ToErrno(err)
	}
	st := syscall.Stat_t{}
	if syscall.Lstat(p, &st); err != nil {
		syscall.Unlink(p)
		return nil, fs.ToErrno(err)
	}
	node := &loopbackNode{}
	ch := n.NewInode(ctx, node, n.root().idFromStat(&st))

	out.Attr.FromStat(&st)
	return ch, 0
}

func (n *loopbackNode) Link(ctx context.Context, target fs.InodeEmbedder, name string, out *fuse.EntryOut) (_ *fs.Inode, errno syscall.Errno) {
	p := filepath.Join(n.path(), name)
	if errno := n.checkWrite(p); errno != 0 {
		return nil, errno
	}
	if err := n.download(p, full); err != nil {
		return nil, fs.ToErrno(err)
	}
	targetNode := toLoopbackNode(target)
	if err := n.download(targetNode.path(), full); err != nil {
		return nil, fs.ToErrno(err)
	}
	err := syscall.Link(targetNode.path(), p)
	if err != nil {
		return nil, fs.ToErrno(err)
	}
	defer func() {
		if errno == 0 {
			n.setFileState(p, dirty)
		}
	}()
	st := syscall.Stat_t{}
	if syscall.Lstat(p, &st); err != nil {
		syscall.Unlink(p)
		return nil, fs.ToErrno(err)
	}
	node := &loopbackNode{}
	ch := n.NewInode(ctx, node, n.root().idFromStat(&st))

	out.Attr.FromStat(&st)
	return ch, 0
}

func (n *loopbackNode) Readlink(ctx context.Context) ([]byte, syscall.Errno) {
	p := n.path()

	for l := 256; ; l *= 2 {
		buf := make([]byte, l)
		sz, err := syscall.Readlink(p, buf)
		if err != nil {
			return nil, fs.ToErrno(err)
		}

		if sz < len(buf) {
			return buf[:sz], 0
		}
	}
}

func (n *loopbackNode) Open(ctx context.Context, flags uint32) (fh fs.FileHandle, fuseFlags uint32, errno syscall.Errno) {
	p := n.path()
	state := full
	if isWrite(flags) {
		if errno := n.checkWrite(p); errno != 0 {
			return nil, 0, errno
		}
		state = dirty
	}
	if err := n.download(p, state); err != nil {
		return nil, 0, fs.ToErrno(err)
	}
	if isCreate(flags) {
		defer func() {
			if errno == 0 {
				n.setFileState(p, dirty)
			}
		}()
	}
	f, err := syscall.Open(p, int(flags), 0)
	if err != nil {
		return nil, 0, fs.ToErrno(err)
	}
	lf := NewLoopbackFile(f)
	return lf, 0, 0
}

func (n *loopbackNode) Opendir(ctx context.Context) syscall.Errno {
	if err := n.download(n.path(), meta); err != nil {
		return fs.ToErrno(err)
	}
	fd, err := syscall.Open(n.path(), syscall.O_DIRECTORY, 0755)
	if err != nil {
		return fs.ToErrno(err)
	}
	syscall.Close(fd)
	return fs.OK
}

func (n *loopbackNode) Readdir(ctx context.Context) (fs.DirStream, syscall.Errno) {
	if err := n.download(n.path(), meta); err != nil {
		return nil, fs.ToErrno(err)
	}
	return fs.NewLoopbackDirStream(n.path())
}

func (n *loopbackNode) Getattr(ctx context.Context, f fs.FileHandle, out *fuse.AttrOut) syscall.Errno {
	if f != nil {
		return f.(fs.FileGetattrer).Getattr(ctx, out)
	}
	p := n.path()
	if err := n.download(p, meta); err != nil {
		return fs.ToErrno(err)
	}

	var err error = nil
	st := syscall.Stat_t{}
	err = syscall.Lstat(p, &st)
	if err != nil {
		return fs.ToErrno(err)
	}
	out.FromStat(&st)
	return fs.OK
}

var _ = (fs.NodeSetattrer)((*loopbackNode)(nil))

func (n *loopbackNode) Setattr(ctx context.Context, f fs.FileHandle, in *fuse.SetAttrIn, out *fuse.AttrOut) syscall.Errno {
	p := n.path()
	fsa, ok := f.(fs.FileSetattrer)
	if ok && fsa != nil {
		fsa.Setattr(ctx, in, out)
	} else {
		if m, ok := in.GetMode(); ok {
			if err := syscall.Chmod(p, m); err != nil {
				return fs.ToErrno(err)
			}
		}

		uid, uok := in.GetUID()
		gid, gok := in.GetGID()
		if uok || gok {
			suid := -1
			sgid := -1
			if uok {
				suid = int(uid)
			}
			if gok {
				sgid = int(gid)
			}
			if err := syscall.Chown(p, suid, sgid); err != nil {
				return fs.ToErrno(err)
			}
		}

		mtime, mok := in.GetMTime()
		atime, aok := in.GetATime()

		if mok || aok {

			ap := &atime
			mp := &mtime
			if !aok {
				ap = nil
			}
			if !mok {
				mp = nil
			}
			var ts [2]syscall.Timespec
			ts[0] = fuse.UtimeToTimespec(ap)
			ts[1] = fuse.UtimeToTimespec(mp)

			if err := syscall.UtimesNano(p, ts[:]); err != nil {
				return fs.ToErrno(err)
			}
		}

		if sz, ok := in.GetSize(); ok {
			if err := syscall.Truncate(p, int64(sz)); err != nil {
				return fs.ToErrno(err)
			}
		}
	}

	fga, ok := f.(fs.FileGetattrer)
	if ok && fga != nil {
		fga.Getattr(ctx, out)
	} else {
		st := syscall.Stat_t{}
		err := syscall.Lstat(p, &st)
		if err != nil {
			return fs.ToErrno(err)
		}
		out.FromStat(&st)
	}
	return fs.OK
}

// newLoopbackRoot returns a root node for a loopback file system whose
// root is at the given root. This node implements all NodeXxxxer
// operations available.
func newLoopbackRoot(root, target string, c *client.APIClient, opts *Options) (*loopbackRoot, error) {
	var st syscall.Stat_t
	err := syscall.Stat(root, &st)
	if err != nil {
		return nil, errors.WithStack(err)
	}

	n := &loopbackRoot{
		rootPath:   root,
		rootDev:    uint64(st.Dev),
		targetPath: target,
		write:      opts.getWrite(),
		c:          c,
		repoOpts:   opts.getRepoOpts(),
		branches:   opts.getBranches(),
		commits:    make(map[string]string),
		files:      make(map[string]fileState),
	}
	return n, nil
}

func (n *loopbackNode) downloadRepos() (retErr error) {
	if n.getFileState("") != none {
		return nil
	}
	defer func() {
		if retErr == nil {
			n.setFileState("", meta)
		}
	}()
	ris, err := n.c().ListRepo()
	if err != nil {
		return err
	}
	ro := n.root().repoOpts
	for _, ri := range ris {
		if len(ro) > 0 && ro[ri.Repo.Name] == nil {
			continue
		}
		p := n.repoPath(ri)
		if err := os.MkdirAll(p, 0777); err != nil {
			return errors.WithStack(err)
		}
	}
	return nil
}

// download files into the loopback filesystem, if meta is true then only the
// directory structure will be created, no actual data will be downloaded,
// files will be truncated to their actual sizes (but will be all zeros).
func (n *loopbackNode) download(path string, state fileState) (retErr error) {
	if n.getFileState(path) >= state {
		// Already got this file, so we can just return
		return nil
	}
	if err := n.downloadRepos(); err != nil {
		return err
	}
	path = n.trimPath(path)
	parts := strings.Split(path, "/")
	defer func() {
		if retErr == nil {
			n.setFileState(path, state)
		}
	}()
	// Note, len(parts) < 1 should not actually be possible, but just in case
	// no need to panic.
	if len(parts) < 1 || parts[0] == "" {
		return nil //already downloaded in downloadRepos
	}
	commit, err := n.commit(parts[0])
	if err != nil {
		return err
	}
	if commit == "" {
		return nil
	}
	if err := n.c().ListFileF(parts[0], commit, pathpkg.Join(parts[1:]...), 0,
		func(fi *pfs.FileInfo) (retErr error) {
			if fi.FileType == pfs.FileType_DIR {
				return os.MkdirAll(n.filePath(fi), 0777)
			}
			p := n.filePath(fi)
			// Make sure the directory exists
			// I think this may be unnecessary based on the constraints the
			// OS imposes, but don't want to rely on that, especially
			// because Mkdir should be pretty cheap.
			if err := os.MkdirAll(filepath.Dir(p), 0777); err != nil {
				return errors.WithStack(err)
			}
			f, err := os.Create(p)
			if err != nil {
				return errors.WithStack(err)
			}
			defer func() {
				if err := f.Close(); err != nil && retErr == nil {
					retErr = errors.WithStack(err)
				}
			}()
			if state < full {
				return f.Truncate(int64(fi.SizeBytes))
			}
			if err := n.c().GetFile(fi.File.Commit.Repo.Name, fi.File.Commit.ID, fi.File.Path, 0, 0, f); err != nil {
				return err
			}
			return nil
		}); err != nil && !errutil.IsNotFoundError(err) &&
		!pfsserver.IsOutputCommitNotFinishedErr(err) {
		return err
	}
	return nil
}

func (n *loopbackNode) trimPath(path string) string {
	path = strings.TrimPrefix(path, n.root().rootPath)
	return strings.TrimPrefix(path, "/")
}

func (n *loopbackNode) trimTargetPath(path string) string {
	path = strings.TrimPrefix(path, n.root().targetPath)
	return strings.TrimPrefix(path, "/")
}

func (n *loopbackNode) branch(repo string) string {
	// no need to lock mu for branches since we only ever read from it.
	if branch, ok := n.root().branches[repo]; ok {
		return branch
	}
	return "master"
}

func (n *loopbackNode) commit(repo string) (string, error) {
	if commit, ok := func() (string, bool) {
		n.root().mu.Lock()
		defer n.root().mu.Unlock()
		commit, ok := n.root().commits[repo]
		return commit, ok
	}(); ok {
		return commit, nil
	}
	branch := n.root().branch(repo)
	bi, err := n.root().c.InspectBranch(repo, branch)
	if err != nil && !errutil.IsNotFoundError(err) {
		return "", err
	}
	// Lock mu to assign commits
	n.root().mu.Lock()
	defer n.root().mu.Unlock()
	// You can access branches that don't exist, which allows you to create
	// branches through the fuse mount.
	if errutil.IsNotFoundError(err) || bi.Head == nil {
		n.root().commits[repo] = ""
		return "", nil
	}
	n.root().commits[repo] = bi.Head.ID
	return bi.Head.ID, nil
}

func (n *loopbackNode) repoPath(ri *pfs.RepoInfo) string {
	return filepath.Join(n.root().rootPath, ri.Repo.Name)
}

func (n *loopbackNode) filePath(fi *pfs.FileInfo) string {
	return filepath.Join(n.root().rootPath, fi.File.Commit.Repo.Name, fi.File.Path)
}

func (n *loopbackNode) getFileState(path string) fileState {
	n.root().mu.Lock()
	defer n.root().mu.Unlock()
	return n.root().files[n.trimPath(path)]
}

func (n *loopbackNode) setFileState(path string, state fileState) {
	n.root().mu.Lock()
	defer n.root().mu.Unlock()
	n.root().files[n.trimPath(path)] = state
}

func (n *loopbackNode) checkWrite(path string) syscall.Errno {
	repo := strings.Split(n.trimPath(path), "/")[0]
	ros := n.root().repoOpts
	if len(ros) > 0 {
		ro, ok := ros[repo]
		if !ok || !ro.Write {
			return syscall.EROFS
		}
		return 0
	}
	if !n.root().write {
		return syscall.EROFS
	}
	return 0
}

func isWrite(flags uint32) bool {
	return (int(flags) & (os.O_WRONLY | os.O_RDWR)) != 0
}

func isCreate(flags uint32) bool {
	return int(flags)&os.O_CREATE != 0
}