Merge branch 'master' into t

* master:
  fs: rename from nodefs
  nodefs: make the examples package level examples
  nodefs: prefix Node interface names with Node
  zipfs: remove unused data type ZipFile
  Add TestParallelDiropsHang / emulate gvfs-udisks2-volume-monitor
  dirstream_linux: fix zero terminator search

benchmark/stat_test.go

@@ -17,16 +17,16 @@ import (
 	"testing"
 	"time"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
 	"github.com/hanwen/go-fuse/internal/testutil"
-	"github.com/hanwen/go-fuse/nodefs"
 )
 
-func setupFs(fs nodefs.InodeEmbedder, N int) (string, func()) {
-	opts := &nodefs.Options{}
+func setupFs(node fs.InodeEmbedder, N int) (string, func()) {
+	opts := &fs.Options{}
 	opts.Debug = testutil.VerboseTest()
 	mountPoint := testutil.TempDir()
-	server, err := nodefs.Mount(mountPoint, fs, opts)
+	server, err := fs.Mount(mountPoint, node, opts)
 	if err != nil {
 		log.Panicf("cannot mount %v", err)
 	}

benchmark/statfs.go

@@ -10,17 +10,17 @@ import (
 	"strings"
 	"syscall"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
-	"github.com/hanwen/go-fuse/nodefs"
 )
 
 type StatFS struct {
-	nodefs.Inode
+	fs.Inode
 
 	files map[string]fuse.Attr
 }
 
-var _ = (nodefs.OnAdder)((*StatFS)(nil))
+var _ = (fs.NodeOnAdder)((*StatFS)(nil))
 
 func (r *StatFS) OnAdd(ctx context.Context) {
 	for nm, a := range r.files {
@@ -50,8 +50,8 @@ func (r *StatFS) addFile(name string, a fuse.Attr) {
 		ch := p.GetChild(component)
 		if ch == nil {
 			// Create a directory
-			ch = p.NewPersistentInode(context.Background(), &nodefs.Inode{},
-				nodefs.StableAttr{Mode: syscall.S_IFDIR})
+			ch = p.NewPersistentInode(context.Background(), &fs.Inode{},
+				fs.StableAttr{Mode: syscall.S_IFDIR})
 			// Add it
 			p.AddChild(component, ch, true)
 		}
@@ -60,10 +60,10 @@ func (r *StatFS) addFile(name string, a fuse.Attr) {
 	}
 
 	// Create the file
-	child := p.NewPersistentInode(context.Background(), &nodefs.MemRegularFile{
+	child := p.NewPersistentInode(context.Background(), &fs.MemRegularFile{
 		Data: make([]byte, a.Size),
 		Attr: a,
-	}, nodefs.StableAttr{})
+	}, fs.StableAttr{})
 
 	// And add it
 	p.AddChild(base, child, true)

example/hello/main.go

@@ -12,32 +12,32 @@ import (
 	"log"
 	"syscall"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
-	"github.com/hanwen/go-fuse/nodefs"
 )
 
 type HelloRoot struct {
-	nodefs.Inode
+	fs.Inode
 }
 
 func (r *HelloRoot) OnAdd(ctx context.Context) {
 	ch := r.NewPersistentInode(
-		ctx, &nodefs.MemRegularFile{
+		ctx, &fs.MemRegularFile{
 			Data: []byte("file.txt"),
 			Attr: fuse.Attr{
 				Mode: 0644,
 			},
-		}, nodefs.StableAttr{Ino: 2})
+		}, fs.StableAttr{Ino: 2})
 	r.AddChild("file.txt", ch, false)
 }
 
-func (r *HelloRoot) Getattr(ctx context.Context, fh nodefs.FileHandle, out *fuse.AttrOut) syscall.Errno {
+func (r *HelloRoot) Getattr(ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno {
 	out.Mode = 0755
 	return 0
 }
 
-var _ = (nodefs.Getattrer)((*HelloRoot)(nil))
-var _ = (nodefs.OnAdder)((*HelloRoot)(nil))
+var _ = (fs.NodeGetattrer)((*HelloRoot)(nil))
+var _ = (fs.NodeOnAdder)((*HelloRoot)(nil))
 
 func main() {
 	debug := flag.Bool("debug", false, "print debug data")
@@ -45,9 +45,9 @@ func main() {
 	if len(flag.Args()) < 1 {
 		log.Fatal("Usage:\n  hello MOUNTPOINT")
 	}
-	opts := &nodefs.Options{}
+	opts := &fs.Options{}
 	opts.Debug = *debug
-	server, err := nodefs.Mount(flag.Arg(0), &HelloRoot{}, opts)
+	server, err := fs.Mount(flag.Arg(0), &HelloRoot{}, opts)
 	if err != nil {
 		log.Fatalf("Mount fail: %v\n", err)
 	}

example/loopback/main.go

@@ -18,7 +18,7 @@ import (
 	"syscall"
 	"time"
 
-	"github.com/hanwen/go-fuse/nodefs"
+	"github.com/hanwen/go-fuse/fs"
 )
 
 func writeMemProfile(fn string, sigs <-chan os.Signal) {
@@ -75,13 +75,13 @@ func main() {
 	}
 
 	orig := flag.Arg(1)
-	loopbackRoot, err := nodefs.NewLoopbackRoot(orig)
+	loopbackRoot, err := fs.NewLoopbackRoot(orig)
 	if err != nil {
 		log.Fatalf("NewLoopbackRoot(%s): %v\n", orig, err)
 	}
 
 	sec := time.Second
-	opts := &nodefs.Options{
+	opts := &fs.Options{
 		// These options are to be compatible with libfuse defaults,
 		// making benchmarking easier.
 		AttrTimeout:  &sec,
@@ -89,7 +89,7 @@ func main() {
 	}
 	opts.Debug = *debug
 	opts.AllowOther = *other
-	server, err := nodefs.Mount(flag.Arg(0), loopbackRoot, opts)
+	server, err := fs.Mount(flag.Arg(0), loopbackRoot, opts)
 	if err != nil {
 		log.Fatalf("Mount fail: %v\n", err)
 	}

example/multizip/main.go

@@ -11,7 +11,7 @@ import (
 	"path/filepath"
 	"time"
 
-	"github.com/hanwen/go-fuse/nodefs"
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/zipfs"
 )
 
@@ -25,15 +25,15 @@ func main() {
 		os.Exit(2)
 	}
 
-	fs := &zipfs.MultiZipFs{}
+	root := &zipfs.MultiZipFs{}
 	sec := time.Second
-	opts := nodefs.Options{
+	opts := fs.Options{
 		EntryTimeout:       &sec,
 		AttrTimeout:        &sec,
 		DefaultPermissions: true,
 	}
 	opts.Debug = *debug
-	server, err := nodefs.Mount(flag.Arg(0), fs, &opts)
+	server, err := fs.Mount(flag.Arg(0), root, &opts)
 	if err != nil {
 		fmt.Printf("Mount fail: %v\n", err)
 		os.Exit(1)

example/statfs/main.go

@@ -18,8 +18,8 @@ import (
 	"time"
 
 	"github.com/hanwen/go-fuse/benchmark"
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
-	"github.com/hanwen/go-fuse/nodefs"
 )
 
 func main() {
@@ -50,18 +50,18 @@ func main() {
 		}
 	}
 
-	fs := &benchmark.StatFS{}
+	root := &benchmark.StatFS{}
 	lines := benchmark.ReadLines(flag.Arg(1))
 	for _, l := range lines {
-		fs.AddFile(strings.TrimSpace(l),
+		root.AddFile(strings.TrimSpace(l),
 			fuse.Attr{Mode: syscall.S_IFREG})
 	}
-	opts := &nodefs.Options{
+	opts := &fs.Options{
 		AttrTimeout:  ttl,
 		EntryTimeout: ttl,
 	}
 	opts.Debug = *debug
-	server, err := nodefs.Mount(flag.Arg(0), fs, opts)
+	server, err := fs.Mount(flag.Arg(0), root, opts)
 	if err != nil {
 		log.Fatalf("Mount fail: %v\n", err)
 	}

example/zipfs/main.go

@@ -16,7 +16,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/hanwen/go-fuse/nodefs"
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/zipfs"
 )
 
@@ -54,13 +54,13 @@ func main() {
 		os.Exit(1)
 	}
 
-	opts := &nodefs.Options{
+	opts := &fs.Options{
 		AttrTimeout:        ttl,
 		EntryTimeout:       ttl,
 		DefaultPermissions: true,
 	}
 	opts.Debug = *debug
-	server, err := nodefs.Mount(flag.Arg(0), root, opts)
+	server, err := fs.Mount(flag.Arg(0), root, opts)
 	if err != nil {
 		fmt.Printf("Mount fail: %v\n", err)
 		os.Exit(1)

nodefs/cache_test.go → fs/cache_test.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"bytes"
@@ -25,9 +25,9 @@ type keepCacheFile struct {
 	count   int
 }
 
-var _ = (Reader)((*keepCacheFile)(nil))
-var _ = (Opener)((*keepCacheFile)(nil))
-var _ = (Getattrer)((*keepCacheFile)(nil))
+var _ = (NodeReader)((*keepCacheFile)(nil))
+var _ = (NodeOpener)((*keepCacheFile)(nil))
+var _ = (NodeGetattrer)((*keepCacheFile)(nil))
 
 func (f *keepCacheFile) setContent(delta int) {
 	f.mu.Lock()
@@ -69,7 +69,7 @@ type keepCacheRoot struct {
 	keep, nokeep *keepCacheFile
 }
 
-var _ = (OnAdder)((*keepCacheRoot)(nil))
+var _ = (NodeOnAdder)((*keepCacheRoot)(nil))
 
 func (r *keepCacheRoot) OnAdd(ctx context.Context) {
 	i := &r.Inode

nodefs/constants.go → fs/constants.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"syscall"

nodefs/constants_darwin.go → fs/constants_darwin.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import "syscall"
 

nodefs/constants_linux.go → fs/constants_linux.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import "syscall"
 

nodefs/default.go → fs/default.go

@@ -2,4 +2,4 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs

nodefs/directio_test.go → fs/directio_test.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"bytes"
@@ -46,7 +46,7 @@ type dioFile struct {
 	Inode
 }
 
-var _ = (Opener)((*dioFile)(nil))
+var _ = (NodeOpener)((*dioFile)(nil))
 
 func (f *dioFile) Open(ctx context.Context, flags uint32) (fh FileHandle, fuseFlags uint32, errno syscall.Errno) {
 	return &dioFH{}, fuse.FOPEN_DIRECT_IO, OK

nodefs/dirstream.go → fs/dirstream.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"syscall"

nodefs/dirstream_darwin.go → fs/dirstream_darwin.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"io"

nodefs/dirstream_linux.go → fs/dirstream_linux.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"sync"
@@ -63,12 +63,14 @@ func (ds *loopbackDirStream) Next() (fuse.DirEntry, syscall.Errno) {
 	nameBytes := ds.todo[unsafe.Offsetof(syscall.Dirent{}.Name):de.Reclen]
 	ds.todo = ds.todo[de.Reclen:]
 
-	for l := len(nameBytes); l > 0; l-- {
-		if nameBytes[l-1] != 0 {
+	// After the loop, l contains the index of the first '\0'.
+	l := 0
+	for l = range nameBytes {
+		if nameBytes[l] == 0 {
 			break
 		}
-		nameBytes = nameBytes[:l-1]
 	}
+	nameBytes = nameBytes[:l]
 	result := fuse.DirEntry{
 		Ino:  de.Ino,
 		Mode: (uint32(de.Type) << 12),

nodefs/example_test.go → fs/example_test.go

@@ -2,35 +2,49 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs_test
 
 import (
+	"fmt"
 	"io/ioutil"
 	"log"
 	"os"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
 )
 
+// mountLoopback mounts dir under the given mountpoint
+func mountLoopback(dir, mntPoint string) (*fuse.Server, error) {
+	root, err := fs.NewLoopbackRoot(dir)
+	if err != nil {
+		return nil, err
+	}
+
+	// Make the root available under mntDir
+	return fs.Mount(mntPoint, root, &fs.Options{
+		MountOptions: fuse.MountOptions{Debug: true},
+	})
+}
+
 // An example of creating a loopback file system, and mounting it onto
 // a directory
-func ExampleMount() {
+func Example_mountLoopback() {
 	mntDir, _ := ioutil.TempDir("", "")
 
 	home := os.Getenv("HOME")
-	root, err := NewLoopbackRoot(home)
-	if err != nil {
-		log.Panic(err)
-	}
 
-	server, err := Mount(mntDir, root, &Options{
-		MountOptions: fuse.MountOptions{Debug: true},
-	})
+	// Make $HOME available on a mount dir under /tmp/ . Caution:
+	// write operations are also mirrored.
+	server, err := mountLoopback(mntDir, home)
 	if err != nil {
 		log.Panic(err)
 	}
 
-	log.Printf("Mounted %s as loopback on %s", home, mntDir)
-	log.Printf("Unmount by calling 'fusermount -u %s'", mntDir)
+	fmt.Printf("Mounted %s as loopback on %s\n", home, mntDir)
+	fmt.Printf("\n\nCAUTION:\nwrite operations on %s will also affect $HOME (%s)\n\n", mntDir, home)
+	fmt.Printf("Unmount by calling 'fusermount -u %s'\n", mntDir)
+
+	// Wait until the directory is unmounted
 	server.Wait()
 }

nodefs/files.go → fs/files.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"context"

nodefs/files_linux.go → fs/files_linux.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"context"

fs/inmemory_example_test.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 fs_test
+
+import (
+	"context"
+	"io/ioutil"
+	"log"
+	"path/filepath"
+	"strings"
+	"syscall"
+
+	"github.com/hanwen/go-fuse/fs"
+	"github.com/hanwen/go-fuse/fuse"
+)
+
+// files contains the files we will expose as a file system
+var files = map[string]string{
+	"file":              "content",
+	"subdir/other-file": "other-content",
+}
+
+// inMemoryFS is the root of the tree
+type inMemoryFS struct {
+	fs.Inode
+}
+
+// Ensure that we implement NodeOnAdder
+var _ = (fs.NodeOnAdder)((*inMemoryFS)(nil))
+
+// OnAdd is called on mounting the file system. Use it to populate
+// the file system tree.
+func (root *inMemoryFS) OnAdd(ctx context.Context) {
+	for name, content := range files {
+		dir, base := filepath.Split(name)
+
+		p := &root.Inode
+
+		// Add directories leading up to the file.
+		for _, component := range strings.Split(dir, "/") {
+			if len(component) == 0 {
+				continue
+			}
+			ch := p.GetChild(component)
+			if ch == nil {
+				// Create a directory
+				ch = p.NewPersistentInode(ctx, &fs.Inode{},
+					fs.StableAttr{Mode: syscall.S_IFDIR})
+				// Add it
+				p.AddChild(component, ch, true)
+			}
+
+			p = ch
+		}
+
+		// Create the file. The Inode must be persistent,
+		// because its life time is not under control of the
+		// kernel.
+		child := p.NewPersistentInode(ctx, &fs.MemRegularFile{
+			Data: []byte(content),
+		}, fs.StableAttr{})
+
+		// And add it
+		p.AddChild(base, child, true)
+	}
+}
+
+// This demonstrates how to build a file system in memory.
+func Example() {
+	// This is where we'll mount the FS
+	mntDir, _ := ioutil.TempDir("", "")
+
+	root := &inMemoryFS{}
+	server, err := fs.Mount(mntDir, root, &fs.Options{
+		MountOptions: fuse.MountOptions{Debug: true},
+
+		// This adds read permissions to the files and
+		// directories, which is necessary for doing a chdir
+		// into the mount.
+		DefaultPermissions: true,
+	})
+	if err != nil {
+		log.Panic(err)
+	}
+
+	log.Printf("Mounted on %s", mntDir)
+	log.Printf("Unmount by calling 'fusermount -u %s'", mntDir)
+
+	// Wait until unmount before exiting
+	server.Wait()
+}

nodefs/inode.go → fs/inode.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"context"

nodefs/interrupt_test.go → fs/interrupt_test.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"context"
@@ -19,7 +19,7 @@ type interruptRoot struct {
 	child interruptOps
 }
 
-var _ = (Lookuper)((*interruptRoot)(nil))
+var _ = (NodeLookuper)((*interruptRoot)(nil))
 
 func (r *interruptRoot) Lookup(ctx context.Context, name string, out *fuse.EntryOut) (*Inode, syscall.Errno) {
 	if name != "file" {
@@ -37,7 +37,7 @@ type interruptOps struct {
 	interrupted bool
 }
 
-var _ = (Opener)((*interruptOps)(nil))
+var _ = (NodeOpener)((*interruptOps)(nil))
 
 func (o *interruptOps) Open(ctx context.Context, flags uint32) (FileHandle, uint32, syscall.Errno) {
 	select {

nodefs/loopback.go → fs/loopback.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"context"
@@ -24,26 +24,26 @@ type loopbackNode struct {
 	Inode
 }
 
-var _ = (Statfser)((*loopbackNode)(nil))
-var _ = (Statfser)((*loopbackNode)(nil))
-var _ = (Getattrer)((*loopbackNode)(nil))
-var _ = (Getxattrer)((*loopbackNode)(nil))
-var _ = (Setxattrer)((*loopbackNode)(nil))
-var _ = (Removexattrer)((*loopbackNode)(nil))
-var _ = (Listxattrer)((*loopbackNode)(nil))
-var _ = (Readlinker)((*loopbackNode)(nil))
-var _ = (Opener)((*loopbackNode)(nil))
-var _ = (CopyFileRanger)((*loopbackNode)(nil))
-var _ = (Lookuper)((*loopbackNode)(nil))
-var _ = (Opendirer)((*loopbackNode)(nil))
-var _ = (Readdirer)((*loopbackNode)(nil))
-var _ = (Mkdirer)((*loopbackNode)(nil))
-var _ = (Mknoder)((*loopbackNode)(nil))
-var _ = (Linker)((*loopbackNode)(nil))
-var _ = (Symlinker)((*loopbackNode)(nil))
-var _ = (Unlinker)((*loopbackNode)(nil))
-var _ = (Rmdirer)((*loopbackNode)(nil))
-var _ = (Renamer)((*loopbackNode)(nil))
+var _ = (NodeStatfser)((*loopbackNode)(nil))
+var _ = (NodeStatfser)((*loopbackNode)(nil))
+var _ = (NodeGetattrer)((*loopbackNode)(nil))
+var _ = (NodeGetxattrer)((*loopbackNode)(nil))
+var _ = (NodeSetxattrer)((*loopbackNode)(nil))
+var _ = (NodeRemovexattrer)((*loopbackNode)(nil))
+var _ = (NodeListxattrer)((*loopbackNode)(nil))
+var _ = (NodeReadlinker)((*loopbackNode)(nil))
+var _ = (NodeOpener)((*loopbackNode)(nil))
+var _ = (NodeCopyFileRanger)((*loopbackNode)(nil))
+var _ = (NodeLookuper)((*loopbackNode)(nil))
+var _ = (NodeOpendirer)((*loopbackNode)(nil))
+var _ = (NodeReaddirer)((*loopbackNode)(nil))
+var _ = (NodeMkdirer)((*loopbackNode)(nil))
+var _ = (NodeMknoder)((*loopbackNode)(nil))
+var _ = (NodeLinker)((*loopbackNode)(nil))
+var _ = (NodeSymlinker)((*loopbackNode)(nil))
+var _ = (NodeUnlinker)((*loopbackNode)(nil))
+var _ = (NodeRmdirer)((*loopbackNode)(nil))
+var _ = (NodeRenamer)((*loopbackNode)(nil))
 
 func (n *loopbackNode) Statfs(ctx context.Context, out *fuse.StatfsOut) syscall.Errno {
 	s := syscall.Statfs_t{}
@@ -181,7 +181,7 @@ func (r *loopbackRoot) idFromStat(st *syscall.Stat_t) StableAttr {
 	}
 }
 
-var _ = (Creater)((*loopbackNode)(nil))
+var _ = (NodeCreater)((*loopbackNode)(nil))
 
 func (n *loopbackNode) Create(ctx context.Context, name string, flags uint32, mode uint32, out *fuse.EntryOut) (inode *Inode, fh FileHandle, fuseFlags uint32, errno syscall.Errno) {
 	p := filepath.Join(n.path(), name)
@@ -298,7 +298,7 @@ func (n *loopbackNode) Getattr(ctx context.Context, f FileHandle, out *fuse.Attr
 	return OK
 }
 
-var _ = (Setattrer)((*loopbackNode)(nil))
+var _ = (NodeSetattrer)((*loopbackNode)(nil))
 
 func (n *loopbackNode) Setattr(ctx context.Context, f FileHandle, in *fuse.SetAttrIn, out *fuse.AttrOut) syscall.Errno {
 	p := n.path()

nodefs/loopback_darwin.go → fs/loopback_darwin.go

@@ -4,7 +4,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"context"

nodefs/loopback_linux.go → fs/loopback_linux.go

@@ -4,7 +4,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"context"

nodefs/loopback_linux_test.go → fs/loopback_linux_test.go

@@ -2,16 +2,20 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"bytes"
 	"io/ioutil"
 	"os"
 	"reflect"
+	"sync"
 	"syscall"
 	"testing"
+	"time"
 
+	"github.com/hanwen/go-fuse/fuse"
+	"github.com/hanwen/go-fuse/internal/testutil"
 	"github.com/kylelemons/godebug/pretty"
 	"golang.org/x/sys/unix"
 )
@@ -198,3 +202,136 @@ func TestCopyFileRange(t *testing.T) {
 	}
 
 }
+
+// Wait for a change in /proc/self/mounts. Efficient through the use of
+// unix.Poll().
+func waitProcMountsChange() error {
+	fd, err := syscall.Open("/proc/self/mounts", syscall.O_RDONLY, 0)
+	defer syscall.Close(fd)
+	if err != nil {
+		return err
+	}
+	pollFds := []unix.PollFd{
+		{
+			Fd:     int32(fd),
+			Events: unix.POLLPRI,
+		},
+	}
+	_, err = unix.Poll(pollFds, 1000)
+	return err
+}
+
+// Wait until mountpoint "mnt" shows up /proc/self/mounts
+func waitMount(mnt string) error {
+	for {
+		err := waitProcMountsChange()
+		if err != nil {
+			return err
+		}
+		content, err := ioutil.ReadFile("/proc/self/mounts")
+		if err != nil {
+			return err
+		}
+		if bytes.Contains(content, []byte(mnt)) {
+			return nil
+		}
+	}
+}
+
+// There is a hang that appears when enabling CAP_PARALLEL_DIROPS on Linux
+// 4.15.0: https://github.com/hanwen/go-fuse/issues/281
+// The hang was originally triggered by gvfs-udisks2-volume-monitor. This
+// test emulates what gvfs-udisks2-volume-monitor does.
+func TestParallelDiropsHang(t *testing.T) {
+	// We do NOT want to use newTestCase() here because we need to know the
+	// mnt path before the filesystem is mounted
+	dir := testutil.TempDir()
+	orig := dir + "/orig"
+	mnt := dir + "/mnt"
+	if err := os.Mkdir(orig, 0755); err != nil {
+		t.Fatal(err)
+	}
+	if err := os.Mkdir(mnt, 0755); err != nil {
+		t.Fatal(err)
+	}
+	defer os.RemoveAll(dir)
+
+	// Unblock the goroutines onces the mount shows up in /proc/self/mounts
+	wait := make(chan struct{})
+	go func() {
+		err := waitMount(mnt)
+		if err != nil {
+			t.Error(err)
+		}
+		// Unblock the goroutines regardless of an error. We don't want to hang
+		// the test.
+		close(wait)
+	}()
+
+	// gvfs-udisks2-volume-monitor hits the mount with three threads - we try to
+	// emulate exactly what it does acc. to an strace log.
+	var wg sync.WaitGroup
+	wg.Add(3)
+	// [pid  2117] lstat(".../mnt/autorun.inf",  <unfinished ...>
+	go func() {
+		defer wg.Done()
+		<-wait
+		var st unix.Stat_t
+		unix.Lstat(mnt+"/autorun.inf", &st)
+	}()
+	// [pid  2116] open(".../mnt/.xdg-volume-info", O_RDONLY <unfinished ...>
+	go func() {
+		defer wg.Done()
+		<-wait
+		syscall.Open(mnt+"/.xdg-volume-info", syscall.O_RDONLY, 0)
+	}()
+	// 25 times this:
+	// [pid  1874] open(".../mnt", O_RDONLY|O_NONBLOCK|O_DIRECTORY|O_CLOEXEC <unfinished ...>
+	// [pid  1874] fstat(11, {st_mode=S_IFDIR|0775, st_size=4096, ...}) = 0
+	// [pid  1874] getdents(11, /* 2 entries */, 32768) = 48
+	// [pid  1874] close(11)                   = 0
+	go func() {
+		defer wg.Done()
+		<-wait
+		for i := 1; i <= 25; i++ {
+			f, err := os.Open(mnt)
+			if err != nil {
+				t.Error(err)
+				return
+			}
+			_, err = f.Stat()
+			if err != nil {
+				t.Error(err)
+				f.Close()
+				return
+			}
+			_, err = f.Readdirnames(-1)
+			if err != nil {
+				t.Errorf("iteration %d: fd %d: %v", i, f.Fd(), err)
+				return
+			}
+			f.Close()
+		}
+	}()
+
+	loopbackRoot, err := NewLoopbackRoot(orig)
+	if err != nil {
+		t.Fatalf("NewLoopbackRoot(%s): %v\n", orig, err)
+	}
+	sec := time.Second
+	opts := &Options{
+		AttrTimeout:  &sec,
+		EntryTimeout: &sec,
+	}
+	opts.Debug = testutil.VerboseTest()
+
+	rawFS := NewNodeFS(loopbackRoot, opts)
+	server, err := fuse.NewServer(rawFS, mnt, &opts.MountOptions)
+	if err != nil {
+		t.Fatal(err)
+	}
+	go server.Serve()
+
+	wg.Wait()
+	server.Unmount()
+}

nodefs/mem.go → fs/mem.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"context"
@@ -20,9 +20,9 @@ type MemRegularFile struct {
 	Attr fuse.Attr
 }
 
-var _ = (Opener)((*MemRegularFile)(nil))
-var _ = (Reader)((*MemRegularFile)(nil))
-var _ = (Flusher)((*MemRegularFile)(nil))
+var _ = (NodeOpener)((*MemRegularFile)(nil))
+var _ = (NodeReader)((*MemRegularFile)(nil))
+var _ = (NodeFlusher)((*MemRegularFile)(nil))
 
 func (f *MemRegularFile) Open(ctx context.Context, flags uint32) (fh FileHandle, fuseFlags uint32, errno syscall.Errno) {
 	if flags&(syscall.O_RDWR) != 0 || flags&syscall.O_WRONLY != 0 {
@@ -32,7 +32,7 @@ func (f *MemRegularFile) Open(ctx context.Context, flags uint32) (fh FileHandle,
 	return nil, fuse.FOPEN_KEEP_CACHE, OK
 }
 
-var _ = (Getattrer)((*MemRegularFile)(nil))
+var _ = (NodeGetattrer)((*MemRegularFile)(nil))
 
 func (f *MemRegularFile) Getattr(ctx context.Context, fh FileHandle, out *fuse.AttrOut) syscall.Errno {
 	out.Attr = f.Attr
@@ -59,13 +59,13 @@ type MemSymlink struct {
 	Data []byte
 }
 
-var _ = (Readlinker)((*MemSymlink)(nil))
+var _ = (NodeReadlinker)((*MemSymlink)(nil))
 
 func (l *MemSymlink) Readlink(ctx context.Context) ([]byte, syscall.Errno) {
 	return l.Data, OK
 }
 
-var _ = (Getattrer)((*MemSymlink)(nil))
+var _ = (NodeGetattrer)((*MemSymlink)(nil))
 
 func (l *MemSymlink) Getattr(ctx context.Context, fh FileHandle, out *fuse.AttrOut) syscall.Errno {
 	out.Attr = l.Attr

nodefs/mem_test.go → fs/mem_test.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"bytes"

nodefs/mount.go → fs/mount.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"time"

nodefs/readonly_test.go → fs/readonly_test.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"context"

nodefs/simple_test.go → fs/simple_test.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"fmt"

nodefs/syscall_linux.go → fs/syscall_linux.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs
 
 import (
 	"syscall"

nodefs/zip_test.go → fs/zip_test.go

@@ -2,14 +2,13 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-package nodefs
+package fs_test
 
 import (
 	"archive/zip"
 	"bytes"
 	"context"
 	"io/ioutil"
-	"log"
 	"path/filepath"
 	"reflect"
 	"strings"
@@ -17,6 +16,7 @@ import (
 	"syscall"
 	"testing"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
 )
 
@@ -62,8 +62,15 @@ func TestZipFS(t *testing.T) {
 	}
 
 	root := &zipRoot{zr: r}
-	mntDir, _, clean := testMount(t, root, nil)
-	defer clean()
+	mntDir, err := ioutil.TempDir("", "ZipFS")
+	if err != nil {
+		t.Fatal(err)
+	}
+	server, err := fs.Mount(mntDir, root, nil)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer server.Unmount()
 
 	for k, v := range testData {
 		c, err := ioutil.ReadFile(filepath.Join(mntDir, k))
@@ -103,14 +110,22 @@ func TestZipFSOnAdd(t *testing.T) {
 
 	zr := &zipRoot{zr: r}
 
-	root := &Inode{}
-	mnt, _, clean := testMount(t, root, &Options{
+	root := &fs.Inode{}
+	mnt, err := ioutil.TempDir("", "ZipFS")
+	if err != nil {
+		t.Fatal(err)
+	}
+	server, err := fs.Mount(mnt, root, &fs.Options{
 		OnAdd: func(ctx context.Context) {
 			root.AddChild("sub",
-				root.NewPersistentInode(ctx, zr, StableAttr{Mode: syscall.S_IFDIR}), false)
+				root.NewPersistentInode(ctx, zr, fs.StableAttr{Mode: syscall.S_IFDIR}), false)
 		},
 	})
-	defer clean()
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer server.Unmount()
+
 	c, err := ioutil.ReadFile(mnt + "/sub/dir/subdir/subfile")
 	if err != nil {
 		t.Fatal("ReadFile", err)
@@ -122,25 +137,25 @@ func TestZipFSOnAdd(t *testing.T) {
 
 // zipFile is a file read from a zip archive.
 type zipFile struct {
-	Inode
+	fs.Inode
 	file *zip.File
 
 	mu   sync.Mutex
 	data []byte
 }
 
-var _ = (Opener)((*zipFile)(nil))
-var _ = (Getattrer)((*zipFile)(nil))
+var _ = (fs.NodeOpener)((*zipFile)(nil))
+var _ = (fs.NodeGetattrer)((*zipFile)(nil))
 
 // Getattr sets the minimum, which is the size. A more full-featured
 // FS would also set timestamps and permissions.
-func (zf *zipFile) Getattr(ctx context.Context, f FileHandle, out *fuse.AttrOut) syscall.Errno {
+func (zf *zipFile) Getattr(ctx context.Context, f fs.FileHandle, out *fuse.AttrOut) syscall.Errno {
 	out.Size = zf.file.UncompressedSize64
-	return OK
+	return 0
 }
 
 // Open lazily unpacks zip data
-func (zf *zipFile) Open(ctx context.Context, flags uint32) (FileHandle, uint32, syscall.Errno) {
+func (zf *zipFile) Open(ctx context.Context, flags uint32) (fs.FileHandle, uint32, syscall.Errno) {
 	zf.mu.Lock()
 	defer zf.mu.Unlock()
 	if zf.data == nil {
@@ -159,27 +174,27 @@ func (zf *zipFile) Open(ctx context.Context, flags uint32) (FileHandle, uint32,
 	// We don't return a filehandle since we don't really need
 	// one.  The file content is immutable, so hint the kernel to
 	// cache the data.
-	return nil, fuse.FOPEN_KEEP_CACHE, OK
+	return nil, fuse.FOPEN_KEEP_CACHE, fs.OK
 }
 
 // Read simply returns the data that was already unpacked in the Open call
-func (zf *zipFile) Read(ctx context.Context, f FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno) {
+func (zf *zipFile) Read(ctx context.Context, f fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno) {
 	end := int(off) + len(dest)
 	if end > len(zf.data) {
 		end = len(zf.data)
 	}
-	return fuse.ReadResultData(zf.data[off:end]), OK
+	return fuse.ReadResultData(zf.data[off:end]), fs.OK
 }
 
 // zipRoot is the root of the Zip filesystem. Its only functionality
 // is populating the filesystem.
 type zipRoot struct {
-	Inode
+	fs.Inode
 
 	zr *zip.Reader
 }
 
-var _ = (OnAdder)((*zipRoot)(nil))
+var _ = (fs.NodeOnAdder)((*zipRoot)(nil))
 
 func (zr *zipRoot) OnAdd(ctx context.Context) {
 	// OnAdd is called once we are attached to an Inode. We can
@@ -196,76 +211,14 @@ func (zr *zipRoot) OnAdd(ctx context.Context) {
 			}
 			ch := p.GetChild(component)
 			if ch == nil {
-				ch = p.NewPersistentInode(ctx, &Inode{},
-					StableAttr{Mode: fuse.S_IFDIR})
+				ch = p.NewPersistentInode(ctx, &fs.Inode{},
+					fs.StableAttr{Mode: fuse.S_IFDIR})
 				p.AddChild(component, ch, true)
 			}
 
 			p = ch
 		}
-		ch := p.NewPersistentInode(ctx, &zipFile{file: f}, StableAttr{})
+		ch := p.NewPersistentInode(ctx, &zipFile{file: f}, fs.StableAttr{})
 		p.AddChild(base, ch, true)
 	}
 }
-
-// Persistent inodes can be used to create an in-memory
-// prefabricated file system tree.
-func ExampleInode_NewPersistentInode() {
-	// This is where we'll mount the FS
-	mntDir, _ := ioutil.TempDir("", "")
-
-	files := map[string]string{
-		"file":              "content",
-		"subdir/other-file": "other-content",
-	}
-
-	root := &Inode{}
-	populate := func(ctx context.Context) {
-		for name, content := range files {
-			dir, base := filepath.Split(name)
-
-			p := root
-
-			// Add directories leading up to the file.
-			for _, component := range strings.Split(dir, "/") {
-				if len(component) == 0 {
-					continue
-				}
-				ch := p.GetChild(component)
-				if ch == nil {
-					// Create a directory
-					ch = p.NewPersistentInode(ctx, &Inode{},
-						StableAttr{Mode: syscall.S_IFDIR})
-					// Add it
-					p.AddChild(component, ch, true)
-				}
-
-				p = ch
-			}
-
-			// Create the file
-			child := p.NewPersistentInode(ctx, &MemRegularFile{
-				Data: []byte(content),
-			}, StableAttr{})
-
-			// And add it
-			p.AddChild(base, child, true)
-		}
-	}
-	server, err := Mount(mntDir, root, &Options{
-		MountOptions: fuse.MountOptions{Debug: true},
-
-		// This adds read permissions to the files and
-		// directories, which is necessary for doing a chdir
-		// into the mount.
-		DefaultPermissions: true,
-		OnAdd:              populate,
-	})
-	if err != nil {
-		log.Panic(err)
-	}
-
-	log.Printf("Mounted on %s", mntDir)
-	log.Printf("Unmount by calling 'fusermount -u %s'", mntDir)
-	server.Wait()
-}

newunionfs/unionfs.go

@@ -13,8 +13,8 @@ import (
 	"path/filepath"
 	"syscall"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
-	"github.com/hanwen/go-fuse/nodefs"
 )
 
 func filePathHash(path string) string {
@@ -32,7 +32,7 @@ type unionFSRoot struct {
 }
 
 type unionFSNode struct {
-	nodefs.Inode
+	fs.Inode
 }
 
 const delDir = "DELETIONS"
@@ -42,7 +42,7 @@ var delDirHash = filePathHash(delDir)
 func (r *unionFSRoot) allMarkers(result map[string]struct{}) syscall.Errno {
 	dir := filepath.Join(r.roots[0], delDir)
 
-	ds, errno := nodefs.NewLoopbackDirStream(dir)
+	ds, errno := fs.NewLoopbackDirStream(dir)
 	if errno != 0 {
 		return errno
 	}
@@ -85,7 +85,7 @@ func (r *unionFSRoot) writeMarker(name string) syscall.Errno {
 	dest := r.markerPath(name)
 
 	err := ioutil.WriteFile(dest, []byte(name), 0644)
-	return nodefs.ToErrno(err)
+	return fs.ToErrno(err)
 }
 
 func (r *unionFSRoot) markerPath(name string) string {
@@ -102,25 +102,25 @@ func (n *unionFSNode) root() *unionFSRoot {
 	return n.Root().Operations().(*unionFSRoot)
 }
 
-var _ = (nodefs.Setattrer)((*unionFSNode)(nil))
+var _ = (fs.NodeSetattrer)((*unionFSNode)(nil))
 
-func (n *unionFSNode) Setattr(ctx context.Context, fh nodefs.FileHandle, in *fuse.SetAttrIn, out *fuse.AttrOut) syscall.Errno {
+func (n *unionFSNode) Setattr(ctx context.Context, fh fs.FileHandle, in *fuse.SetAttrIn, out *fuse.AttrOut) syscall.Errno {
 	if errno := n.promote(); errno != 0 {
 		return errno
 	}
 
 	if fh != nil {
-		return fh.(nodefs.FileSetattrer).Setattr(ctx, in, out)
+		return fh.(fs.FileSetattrer).Setattr(ctx, in, out)
 	}
 
 	p := filepath.Join(n.root().roots[0], n.Path(nil))
-	fsa, ok := fh.(nodefs.FileSetattrer)
+	fsa, ok := fh.(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 nodefs.ToErrno(err)
+				return fs.ToErrno(err)
 			}
 		}
 
@@ -136,7 +136,7 @@ func (n *unionFSNode) Setattr(ctx context.Context, fh nodefs.FileHandle, in *fus
 				sgid = int(gid)
 			}
 			if err := syscall.Chown(p, suid, sgid); err != nil {
-				return nodefs.ToErrno(err)
+				return fs.ToErrno(err)
 			}
 		}
 
@@ -158,34 +158,34 @@ func (n *unionFSNode) Setattr(ctx context.Context, fh nodefs.FileHandle, in *fus
 			ts[1] = fuse.UtimeToTimespec(mp)
 
 			if err := syscall.UtimesNano(p, ts[:]); err != nil {
-				return nodefs.ToErrno(err)
+				return fs.ToErrno(err)
 			}
 		}
 
 		if sz, ok := in.GetSize(); ok {
 			if err := syscall.Truncate(p, int64(sz)); err != nil {
-				return nodefs.ToErrno(err)
+				return fs.ToErrno(err)
 			}
 		}
 	}
 
-	fga, ok := fh.(nodefs.FileGetattrer)
+	fga, ok := fh.(fs.FileGetattrer)
 	if ok && fga != nil {
 		fga.Getattr(ctx, out)
 	} else {
 		st := syscall.Stat_t{}
 		err := syscall.Lstat(p, &st)
 		if err != nil {
-			return nodefs.ToErrno(err)
+			return fs.ToErrno(err)
 		}
 		out.FromStat(&st)
 	}
 	return 0
 }
 
-var _ = (nodefs.Creater)((*unionFSNode)(nil))
+var _ = (fs.NodeCreater)((*unionFSNode)(nil))
 
-func (n *unionFSNode) Create(ctx context.Context, name string, flags uint32, mode uint32, out *fuse.EntryOut) (*nodefs.Inode, nodefs.FileHandle, uint32, syscall.Errno) {
+func (n *unionFSNode) Create(ctx context.Context, name string, flags uint32, mode uint32, out *fuse.EntryOut) (*fs.Inode, fs.FileHandle, uint32, syscall.Errno) {
 	if n.IsRoot() && name == delDir {
 		return nil, nil, 0, syscall.EPERM
 	}
@@ -217,15 +217,15 @@ func (n *unionFSNode) Create(ctx context.Context, name string, flags uint32, mod
 		return nil, nil, 0, err.(syscall.Errno)
 	}
 
-	ch := n.NewInode(ctx, &unionFSNode{}, nodefs.StableAttr{Mode: st.Mode, Ino: st.Ino})
+	ch := n.NewInode(ctx, &unionFSNode{}, fs.StableAttr{Mode: st.Mode, Ino: st.Ino})
 	out.FromStat(&st)
 
-	return ch, nodefs.NewLoopbackFile(fd), 0, 0
+	return ch, fs.NewLoopbackFile(fd), 0, 0
 }
 
-var _ = (nodefs.Opener)((*unionFSNode)(nil))
+var _ = (fs.NodeOpener)((*unionFSNode)(nil))
 
-func (n *unionFSNode) Open(ctx context.Context, flags uint32) (nodefs.FileHandle, uint32, syscall.Errno) {
+func (n *unionFSNode) Open(ctx context.Context, flags uint32) (fs.FileHandle, uint32, syscall.Errno) {
 	isWR := (flags&syscall.O_RDWR != 0) || (flags&syscall.O_WRONLY != 0)
 
 	var st syscall.Stat_t
@@ -242,12 +242,12 @@ func (n *unionFSNode) Open(ctx context.Context, flags uint32) (nodefs.FileHandle
 		return nil, 0, err.(syscall.Errno)
 	}
 
-	return nodefs.NewLoopbackFile(fd), 0, 0
+	return fs.NewLoopbackFile(fd), 0, 0
 }
 
-var _ = (nodefs.Getattrer)((*unionFSNode)(nil))
+var _ = (fs.NodeGetattrer)((*unionFSNode)(nil))
 
-func (n *unionFSNode) Getattr(ctx context.Context, fh nodefs.FileHandle, out *fuse.AttrOut) syscall.Errno {
+func (n *unionFSNode) Getattr(ctx context.Context, fh fs.FileHandle, out *fuse.AttrOut) syscall.Errno {
 	var st syscall.Stat_t
 	_, idx := n.getBranch(&st)
 	if idx < 0 {
@@ -258,9 +258,9 @@ func (n *unionFSNode) Getattr(ctx context.Context, fh nodefs.FileHandle, out *fu
 	return 0
 }
 
-var _ = (nodefs.Lookuper)((*unionFSNode)(nil))
+var _ = (fs.NodeLookuper)((*unionFSNode)(nil))
 
-func (n *unionFSNode) Lookup(ctx context.Context, name string, out *fuse.EntryOut) (*nodefs.Inode, syscall.Errno) {
+func (n *unionFSNode) Lookup(ctx context.Context, name string, out *fuse.EntryOut) (*fs.Inode, syscall.Errno) {
 	if n.IsRoot() && name == delDir {
 		return nil, syscall.ENOENT
 	}
@@ -271,7 +271,7 @@ func (n *unionFSNode) Lookup(ctx context.Context, name string, out *fuse.EntryOu
 	idx := n.root().getBranch(p, &st)
 	if idx >= 0 {
 		// XXX use idx in Ino?
-		ch := n.NewInode(ctx, &unionFSNode{}, nodefs.StableAttr{Mode: st.Mode, Ino: st.Ino})
+		ch := n.NewInode(ctx, &unionFSNode{}, fs.StableAttr{Mode: st.Mode, Ino: st.Ino})
 		out.FromStat(&st)
 		out.Mode |= 0111
 		return ch, 0
@@ -279,21 +279,21 @@ func (n *unionFSNode) Lookup(ctx context.Context, name string, out *fuse.EntryOu
 	return nil, syscall.ENOENT
 }
 
-var _ = (nodefs.Unlinker)((*unionFSNode)(nil))
+var _ = (fs.NodeUnlinker)((*unionFSNode)(nil))
 
 func (n *unionFSNode) Unlink(ctx context.Context, name string) syscall.Errno {
 	return n.root().delPath(filepath.Join(n.Path(nil), name))
 }
 
-var _ = (nodefs.Rmdirer)((*unionFSNode)(nil))
+var _ = (fs.NodeRmdirer)((*unionFSNode)(nil))
 
 func (n *unionFSNode) Rmdir(ctx context.Context, name string) syscall.Errno {
 	return n.root().delPath(filepath.Join(n.Path(nil), name))
 }
 
-var _ = (nodefs.Symlinker)((*unionFSNode)(nil))
+var _ = (fs.NodeSymlinker)((*unionFSNode)(nil))
 
-func (n *unionFSNode) Symlink(ctx context.Context, target, name string, out *fuse.EntryOut) (*nodefs.Inode, syscall.Errno) {
+func (n *unionFSNode) Symlink(ctx context.Context, target, name string, out *fuse.EntryOut) (*fs.Inode, syscall.Errno) {
 	n.promote()
 	path := filepath.Join(n.root().roots[0], n.Path(nil), name)
 	err := syscall.Symlink(target, path)
@@ -309,14 +309,14 @@ func (n *unionFSNode) Symlink(ctx context.Context, target, name string, out *fus
 
 	out.FromStat(&st)
 
-	ch := n.NewInode(ctx, &unionFSNode{}, nodefs.StableAttr{
+	ch := n.NewInode(ctx, &unionFSNode{}, fs.StableAttr{
 		Mode: syscall.S_IFLNK,
 		Ino:  st.Ino,
 	})
 	return ch, 0
 }
 
-var _ = (nodefs.Readlinker)((*unionFSNode)(nil))
+var _ = (fs.NodeReadlinker)((*unionFSNode)(nil))
 
 func (n *unionFSNode) Readlink(ctx context.Context) ([]byte, syscall.Errno) {
 	nm, idx := n.getBranch(nil)
@@ -330,9 +330,9 @@ func (n *unionFSNode) Readlink(ctx context.Context) ([]byte, syscall.Errno) {
 	return buf[:count], 0
 }
 
-var _ = (nodefs.Readdirer)((*unionFSNode)(nil))
+var _ = (fs.NodeReaddirer)((*unionFSNode)(nil))
 
-func (n *unionFSNode) Readdir(ctx context.Context) (nodefs.DirStream, syscall.Errno) {
+func (n *unionFSNode) Readdir(ctx context.Context) (fs.DirStream, syscall.Errno) {
 	root := n.root()
 
 	markers := map[string]struct{}{delDirHash: struct{}{}}
@@ -358,11 +358,11 @@ func (n *unionFSNode) Readdir(ctx context.Context) (nodefs.DirStream, syscall.Er
 		})
 	}
 
-	return nodefs.NewListDirStream(result), 0
+	return fs.NewListDirStream(result), 0
 }
 
 func readRoot(root string, dir string, result map[string]uint32) {
-	ds, errno := nodefs.NewLoopbackDirStream(filepath.Join(root, dir))
+	ds, errno := fs.NewLoopbackDirStream(filepath.Join(root, dir))
 	if errno != 0 {
 		return
 	}
@@ -412,7 +412,7 @@ func (n *unionFSRoot) delPath(p string) syscall.Errno {
 	if idx == 0 {
 		err := syscall.Unlink(filepath.Join(r.roots[idx], p))
 		if err != nil {
-			return nodefs.ToErrno(err)
+			return fs.ToErrno(err)
 		}
 		idx = r.getBranch(p, &st)
 	}

newunionfs/unionfs_test.go

@@ -13,9 +13,9 @@ import (
 	"syscall"
 	"testing"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
 	"github.com/hanwen/go-fuse/internal/testutil"
-	"github.com/hanwen/go-fuse/nodefs"
 	"github.com/hanwen/go-fuse/posixtest"
 )
 
@@ -50,7 +50,7 @@ func newTestCase(t *testing.T, populate bool) *testCase {
 		}
 	}
 
-	opts := nodefs.Options{}
+	opts := fs.Options{}
 	opts.Debug = testutil.VerboseTest()
 	tc := &testCase{
 		dir: dir,
@@ -62,7 +62,7 @@ func newTestCase(t *testing.T, populate bool) *testCase {
 		roots: []string{tc.rw, tc.ro},
 	}
 
-	server, err := nodefs.Mount(tc.mnt, tc.root, &opts)
+	server, err := fs.Mount(tc.mnt, tc.root, &opts)
 	if err != nil {
 		t.Fatal("Mount", err)
 	}

nodefs/README.md

-
-Objective
-=========
-
-A high-performance FUSE API that minimizes pitfalls with writing
-correct filesystems.
-
-Decisions
-=========
-
-   * Nodes contain references to their children. This is useful
-     because most filesystems will need to construct tree-like
-     structures.
-
-   * Nodes contain references to their parents. As a result, we can
-     derive the path for each Inode, and there is no need for a
-     separate PathFS.
-
-   * Nodes can be "persistent", meaning their lifetime is not under
-     control of the kernel. This is useful for constructing FS trees
-     in advance, rather than driven by LOOKUP.
-
-   * The NodeID for FS tree node must be defined on creation and are
-     immutable. By contrast, reusing NodeIds (eg. rsc/bazil FUSE, as
-     well as old go-fuse/fuse/nodefs) needs extra synchronization to
-     avoid races with notify and FORGET, and makes handling the inode
-     Generation more complicated.
-     
-   * The mode of an Inode is defined on creation.  Files cannot change
-     type during their lifetime. This also prevents the common error
-     of forgetting to return the filetype in Lookup/GetAttr.
-     
-   * The NodeID (used for communicating with kernel) is equal to
-     Attr.Ino (value shown in Stat and Lstat return values.). 
-
-   * No global treelock, to ensure scalability.
-
-   * Support for hard links. libfuse doesn't support this in the
-     high-level API.  Extra care for race conditions is needed when
-     looking up the same file through different paths.
-
-   * do not issue Notify{Entry,Delete} as part of
-     AddChild/RmChild/MvChild: because NodeIDs are unique and
-     immutable, there is no confusion about which nodes are
-     invalidated, and the notification doesn't have to happen under
-     lock.
-
-   * Directory reading uses the DirStream. Semantics for rewinding
-     directory reads, and adding files after opening (but before
-     reading) are handled automatically. No support for directory
-     seeks.
-
-   * Method names are based on syscall names. Where there is no
-     syscall (eg. "open directory"), we bias towards writing
-     everything together (Opendir)
-
-To do/To decide
-=========
-
-   * decide on a final package name
-
-   * handle less open/create.
-
-   * Symlink []byte vs string.

zipfs/multizip.go

@@ -19,27 +19,27 @@ import (
 	"log"
 	"syscall"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
-	"github.com/hanwen/go-fuse/nodefs"
 )
 
 // MultiZipFs is a filesystem that mounts zipfiles.
 type MultiZipFs struct {
-	nodefs.Inode
+	fs.Inode
 }
 
-func (fs *MultiZipFs) OnAdd(ctx context.Context) {
-	n := fs.NewPersistentInode(ctx, &configRoot{}, nodefs.StableAttr{Mode: syscall.S_IFDIR})
+func (root *MultiZipFs) OnAdd(ctx context.Context) {
+	n := root.NewPersistentInode(ctx, &configRoot{}, fs.StableAttr{Mode: syscall.S_IFDIR})
 
-	fs.AddChild("config", n, false)
+	root.AddChild("config", n, false)
 }
 
 type configRoot struct {
-	nodefs.Inode
+	fs.Inode
 }
 
-var _ = (nodefs.Unlinker)((*configRoot)(nil))
-var _ = (nodefs.Symlinker)((*configRoot)(nil))
+var _ = (fs.NodeUnlinker)((*configRoot)(nil))
+var _ = (fs.NodeSymlinker)((*configRoot)(nil))
 
 func (r *configRoot) Unlink(ctx context.Context, basename string) syscall.Errno {
 	if r.GetChild(basename) == nil {
@@ -64,7 +64,7 @@ func (r *configRoot) Unlink(ctx context.Context, basename string) syscall.Errno
 	return 0
 }
 
-func (r *configRoot) Symlink(ctx context.Context, target string, base string, out *fuse.EntryOut) (*nodefs.Inode, syscall.Errno) {
+func (r *configRoot) Symlink(ctx context.Context, target string, base string, out *fuse.EntryOut) (*fs.Inode, syscall.Errno) {
 	root, err := NewArchiveFileSystem(target)
 	if err != nil {
 		log.Println("NewZipArchiveFileSystem failed.", err)
@@ -72,12 +72,12 @@ func (r *configRoot) Symlink(ctx context.Context, target string, base string, ou
 	}
 
 	_, parent := r.Parent()
-	ch := r.NewPersistentInode(ctx, root, nodefs.StableAttr{Mode: syscall.S_IFDIR})
+	ch := r.NewPersistentInode(ctx, root, fs.StableAttr{Mode: syscall.S_IFDIR})
 	parent.AddChild(base, ch, false)
 
-	link := r.NewPersistentInode(ctx, &nodefs.MemSymlink{
+	link := r.NewPersistentInode(ctx, &fs.MemSymlink{
 		Data: []byte(target),
-	}, nodefs.StableAttr{Mode: syscall.S_IFLNK})
+	}, fs.StableAttr{Mode: syscall.S_IFLNK})
 	r.AddChild(base, link, false)
 	return link, 0
 }

zipfs/multizip_test.go

@@ -10,9 +10,9 @@ import (
 	"testing"
 	"time"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
 	"github.com/hanwen/go-fuse/internal/testutil"
-	"github.com/hanwen/go-fuse/nodefs"
 )
 
 const testTtl = 100 * time.Millisecond
@@ -22,13 +22,13 @@ func setupMzfs(t *testing.T) (mountPoint string, state *fuse.Server, cleanup fun
 	mountPoint = testutil.TempDir()
 
 	dt := testTtl
-	opts := &nodefs.Options{
+	opts := &fs.Options{
 		EntryTimeout: &dt,
 		AttrTimeout:  &dt,
 	}
 	opts.Debug = testutil.VerboseTest()
 
-	server, err := nodefs.Mount(mountPoint, root, opts)
+	server, err := fs.Mount(mountPoint, root, opts)
 	if err != nil {
 		t.Fatalf("MountNodeFileSystem failed: %v", err)
 	}

zipfs/tarfs.go

@@ -17,8 +17,8 @@ import (
 	"strings"
 	"syscall"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
-	"github.com/hanwen/go-fuse/nodefs"
 )
 
 // TODO - handle symlinks.
@@ -32,7 +32,7 @@ func HeaderToFileInfo(out *fuse.Attr, h *tar.Header) {
 }
 
 type tarRoot struct {
-	nodefs.Inode
+	fs.Inode
 	rc io.ReadCloser
 }
 
@@ -77,8 +77,8 @@ func (r *tarRoot) OnAdd(ctx context.Context) {
 			ch := p.GetChild(comp)
 			if ch == nil {
 				ch = p.NewPersistentInode(ctx,
-					&nodefs.Inode{},
-					nodefs.StableAttr{Mode: syscall.S_IFDIR})
+					&fs.Inode{},
+					fs.StableAttr{Mode: syscall.S_IFDIR})
 				p.AddChild(comp, ch, false)
 			}
 			p = ch
@@ -88,37 +88,37 @@ func (r *tarRoot) OnAdd(ctx context.Context) {
 		HeaderToFileInfo(&attr, hdr)
 		switch hdr.Typeflag {
 		case tar.TypeSymlink:
-			l := &nodefs.MemSymlink{
+			l := &fs.MemSymlink{
 				Data: []byte(hdr.Linkname),
 			}
 			l.Attr = attr
-			p.AddChild(base, r.NewPersistentInode(ctx, l, nodefs.StableAttr{Mode: syscall.S_IFLNK}), false)
+			p.AddChild(base, r.NewPersistentInode(ctx, l, fs.StableAttr{Mode: syscall.S_IFLNK}), false)
 
 		case tar.TypeLink:
 			log.Println("don't know how to handle Typelink")
 
 		case tar.TypeChar:
-			rf := &nodefs.MemRegularFile{}
+			rf := &fs.MemRegularFile{}
 			rf.Attr = attr
-			p.AddChild(base, r.NewPersistentInode(ctx, rf, nodefs.StableAttr{Mode: syscall.S_IFCHR}), false)
+			p.AddChild(base, r.NewPersistentInode(ctx, rf, fs.StableAttr{Mode: syscall.S_IFCHR}), false)
 		case tar.TypeBlock:
-			rf := &nodefs.MemRegularFile{}
+			rf := &fs.MemRegularFile{}
 			rf.Attr = attr
-			p.AddChild(base, r.NewPersistentInode(ctx, rf, nodefs.StableAttr{Mode: syscall.S_IFBLK}), false)
+			p.AddChild(base, r.NewPersistentInode(ctx, rf, fs.StableAttr{Mode: syscall.S_IFBLK}), false)
 		case tar.TypeDir:
-			rf := &nodefs.MemRegularFile{}
+			rf := &fs.MemRegularFile{}
 			rf.Attr = attr
-			p.AddChild(base, r.NewPersistentInode(ctx, rf, nodefs.StableAttr{Mode: syscall.S_IFDIR}), false)
+			p.AddChild(base, r.NewPersistentInode(ctx, rf, fs.StableAttr{Mode: syscall.S_IFDIR}), false)
 		case tar.TypeFifo:
-			rf := &nodefs.MemRegularFile{}
+			rf := &fs.MemRegularFile{}
 			rf.Attr = attr
-			p.AddChild(base, r.NewPersistentInode(ctx, rf, nodefs.StableAttr{Mode: syscall.S_IFIFO}), false)
+			p.AddChild(base, r.NewPersistentInode(ctx, rf, fs.StableAttr{Mode: syscall.S_IFIFO}), false)
 		case tar.TypeReg, tar.TypeRegA:
-			df := &nodefs.MemRegularFile{
+			df := &fs.MemRegularFile{
 				Data: buf.Bytes(),
 			}
 			df.Attr = attr
-			p.AddChild(base, r.NewPersistentInode(ctx, df, nodefs.StableAttr{}), false)
+			p.AddChild(base, r.NewPersistentInode(ctx, df, fs.StableAttr{}), false)
 		default:
 			log.Printf("entry %q: unsupported type '%c'", hdr.Name, hdr.Typeflag)
 		}
@@ -134,7 +134,7 @@ func (rc *readCloser) Close() error {
 	return rc.close()
 }
 
-func NewTarCompressedTree(name string, format string) (nodefs.InodeEmbedder, error) {
+func NewTarCompressedTree(name string, format string) (fs.InodeEmbedder, error) {
 	f, err := os.Open(name)
 	if err != nil {
 		return nil, err

zipfs/tarfs_test.go

@@ -16,8 +16,8 @@ import (
 	"testing"
 	"time"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/internal/testutil"
-	"github.com/hanwen/go-fuse/nodefs"
 )
 
 var tarContents = map[string]string{
@@ -69,9 +69,9 @@ func TestTar(t *testing.T) {
 
 	mnt := testutil.TempDir()
 	defer os.Remove(mnt)
-	opts := &nodefs.Options{}
-	opts.Debug = true
-	s, err := nodefs.Mount(mnt, root, opts)
+	opts := &fs.Options{}
+	opts.Debug = testutil.VerboseTest()
+	s, err := fs.Mount(mnt, root, opts)
 	if err != nil {
 		t.Errorf("Mount: %v", err)
 	}

zipfs/zipfs.go

@@ -6,10 +6,8 @@ package zipfs
 
 import (
 	"archive/zip"
-	"bytes"
 	"context"
 	"fmt"
-	"io"
 	"io/ioutil"
 	"os"
 	"path/filepath"
@@ -17,39 +15,17 @@ import (
 	"sync"
 	"syscall"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
-	"github.com/hanwen/go-fuse/nodefs"
 )
 
-type ZipFile struct {
-	*zip.File
-}
-
-func (f *ZipFile) Stat(out *fuse.Attr) {
-}
-
-func (f *ZipFile) Data() []byte {
-	zf := (*f)
-	rc, err := zf.Open()
-	if err != nil {
-		panic(err)
-	}
-	dest := bytes.NewBuffer(make([]byte, 0, f.UncompressedSize))
-
-	_, err = io.CopyN(dest, rc, int64(f.UncompressedSize))
-	if err != nil {
-		panic(err)
-	}
-	return dest.Bytes()
-}
-
 type zipRoot struct {
-	nodefs.Inode
+	fs.Inode
 
 	zr *zip.ReadCloser
 }
 
-var _ = (nodefs.OnAdder)((*zipRoot)(nil))
+var _ = (fs.NodeOnAdder)((*zipRoot)(nil))
 
 func (zr *zipRoot) OnAdd(ctx context.Context) {
 	for _, f := range zr.zr.File {
@@ -65,20 +41,20 @@ func (zr *zipRoot) OnAdd(ctx context.Context) {
 			}
 			ch := p.GetChild(component)
 			if ch == nil {
-				ch = p.NewPersistentInode(ctx, &nodefs.Inode{},
-					nodefs.StableAttr{Mode: fuse.S_IFDIR})
+				ch = p.NewPersistentInode(ctx, &fs.Inode{},
+					fs.StableAttr{Mode: fuse.S_IFDIR})
 				p.AddChild(component, ch, true)
 			}
 
 			p = ch
 		}
-		ch := p.NewPersistentInode(ctx, &zipFile{file: f}, nodefs.StableAttr{})
+		ch := p.NewPersistentInode(ctx, &zipFile{file: f}, fs.StableAttr{})
 		p.AddChild(base, ch, true)
 	}
 }
 
 // NewZipTree creates a new file-system for the zip file named name.
-func NewZipTree(name string) (nodefs.InodeEmbedder, error) {
+func NewZipTree(name string) (fs.InodeEmbedder, error) {
 	r, err := zip.OpenReader(name)
 	if err != nil {
 		return nil, err
@@ -89,19 +65,19 @@ func NewZipTree(name string) (nodefs.InodeEmbedder, error) {
 
 // zipFile is a file read from a zip archive.
 type zipFile struct {
-	nodefs.Inode
+	fs.Inode
 	file *zip.File
 
 	mu   sync.Mutex
 	data []byte
 }
 
-var _ = (nodefs.Opener)((*zipFile)(nil))
-var _ = (nodefs.Getattrer)((*zipFile)(nil))
+var _ = (fs.NodeOpener)((*zipFile)(nil))
+var _ = (fs.NodeGetattrer)((*zipFile)(nil))
 
 // Getattr sets the minimum, which is the size. A more full-featured
 // FS would also set timestamps and permissions.
-func (zf *zipFile) Getattr(ctx context.Context, f nodefs.FileHandle, out *fuse.AttrOut) syscall.Errno {
+func (zf *zipFile) Getattr(ctx context.Context, f fs.FileHandle, out *fuse.AttrOut) syscall.Errno {
 	out.Mode = uint32(zf.file.Mode()) & 07777
 	out.Nlink = 1
 	out.Mtime = uint64(zf.file.ModTime().Unix())
@@ -113,7 +89,7 @@ func (zf *zipFile) Getattr(ctx context.Context, f nodefs.FileHandle, out *fuse.A
 }
 
 // Open lazily unpacks zip data
-func (zf *zipFile) Open(ctx context.Context, flags uint32) (nodefs.FileHandle, uint32, syscall.Errno) {
+func (zf *zipFile) Open(ctx context.Context, flags uint32) (fs.FileHandle, uint32, syscall.Errno) {
 	zf.mu.Lock()
 	defer zf.mu.Unlock()
 	if zf.data == nil {
@@ -136,7 +112,7 @@ func (zf *zipFile) Open(ctx context.Context, flags uint32) (nodefs.FileHandle, u
 }
 
 // Read simply returns the data that was already unpacked in the Open call
-func (zf *zipFile) Read(ctx context.Context, f nodefs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno) {
+func (zf *zipFile) Read(ctx context.Context, f fs.FileHandle, dest []byte, off int64) (fuse.ReadResult, syscall.Errno) {
 	end := int(off) + len(dest)
 	if end > len(zf.data) {
 		end = len(zf.data)
@@ -144,9 +120,9 @@ func (zf *zipFile) Read(ctx context.Context, f nodefs.FileHandle, dest []byte, o
 	return fuse.ReadResultData(zf.data[off:end]), 0
 }
 
-var _ = (nodefs.OnAdder)((*zipRoot)(nil))
+var _ = (fs.NodeOnAdder)((*zipRoot)(nil))
 
-func NewArchiveFileSystem(name string) (root nodefs.InodeEmbedder, err error) {
+func NewArchiveFileSystem(name string) (root fs.InodeEmbedder, err error) {
 	switch {
 	case strings.HasSuffix(name, ".zip"):
 		root, err = NewZipTree(name)

zipfs/zipfs_test.go

@@ -13,9 +13,9 @@ import (
 	"testing"
 	"time"
 
+	"github.com/hanwen/go-fuse/fs"
 	"github.com/hanwen/go-fuse/fuse"
 	"github.com/hanwen/go-fuse/internal/testutil"
-	"github.com/hanwen/go-fuse/nodefs"
 )
 
 func testZipFile() string {
@@ -34,9 +34,9 @@ func setupZipfs(t *testing.T) (mountPoint string, cleanup func()) {
 	}
 
 	mountPoint = testutil.TempDir()
-	opts := &nodefs.Options{}
+	opts := &fs.Options{}
 	opts.Debug = testutil.VerboseTest()
-	server, err := nodefs.Mount(mountPoint, root, opts)
+	server, err := fs.Mount(mountPoint, root, opts)
 
 	return mountPoint, func() {
 		server.Unmount()