Merge pull request #20 from x1unix/main

fix: use correct ENODATA value on different platforms

fuse2.go

@@ -0,0 +1,150 @@
+package squashfs
+
+import (
+	"bytes"
+	"context"
+	"errors"
+	"io"
+
+	"github.com/CalebQ42/squashfs/internal/inode"
+	"github.com/seaweedfs/fuse"
+	"github.com/seaweedfs/fuse/fs"
+)
+
+// Mounts the archive to the given mountpoint using fuse2. Non-blocking.
+// If Unmount does not get called, the mount point must be unmounted using umount before the directory can be used again.
+func (r *Reader) MountFuse2(mountpoint string) (err error) {
+	if r.con != nil {
+		return errors.New("squashfs archive already mounted")
+	}
+	r.con2, err = fuse.Mount(mountpoint, fuse.ReadOnly())
+	if err != nil {
+		return
+	}
+	<-r.con2.Ready
+	r.mount2Done = make(chan struct{})
+	go func() {
+		fs.Serve(r.con2, squashFuse2{r: r})
+		close(r.mount2Done)
+	}()
+	return
+}
+
+// Blocks until the mount ends.
+// Fuse2 version.
+func (r *Reader) MountWaitFuse2() {
+	if r.mount2Done != nil {
+		<-r.mount2Done
+	}
+}
+
+// Unmounts the archive.
+// Fuse2 version.
+func (r *Reader) UnmountFuse2() error {
+	if r.con != nil {
+		defer func() { r.con = nil }()
+		return r.con.Close()
+	}
+	return errors.New("squashfs archive is not mounted")
+}
+
+type squashFuse2 struct {
+	r *Reader
+}
+
+func (s squashFuse2) Root() (fs.Node, error) {
+	return fileNode2{File: s.r.FS.File}, nil
+}
+
+type fileNode2 struct {
+	*File
+}
+
+func (f fileNode2) Attr(ctx context.Context, attr *fuse.Attr) error {
+	attr.Blocks = f.r.s.Size / 512
+	if f.r.s.Size%512 > 0 {
+		attr.Blocks++
+	}
+	attr.Gid = f.r.ids[f.i.GidInd]
+	attr.Inode = uint64(f.i.Num)
+	attr.Mode = f.i.Mode()
+	attr.Nlink = f.i.LinkCount()
+	attr.Size = f.i.Size()
+	attr.Uid = f.r.ids[f.i.UidInd]
+	return nil
+}
+
+func (f fileNode2) Id() uint64 {
+	return uint64(f.i.Num)
+}
+
+func (f fileNode2) Readlink(ctx context.Context, req *fuse.ReadlinkRequest) (string, error) {
+	return f.SymlinkPath(), nil
+}
+
+func (f fileNode2) Lookup(ctx context.Context, name string) (fs.Node, error) {
+	asFS, err := f.FS()
+	if err != nil {
+		return nil, fuse.ENOTDIR
+	}
+	ret, err := asFS.OpenFile(name)
+	if err != nil {
+		return nil, fuse.ENOENT
+	}
+	return fileNode2{File: ret}, nil
+}
+
+func (f fileNode2) ReadAll(ctx context.Context) ([]byte, error) {
+	if f.IsRegular() {
+		var buf bytes.Buffer
+		_, err := f.WriteTo(&buf)
+		return buf.Bytes(), err
+	}
+	return nil, ENODATA
+}
+
+func (f fileNode2) Read(ctx context.Context, req *fuse.ReadRequest, resp *fuse.ReadResponse) error {
+	if f.IsRegular() {
+		buf := make([]byte, req.Size)
+		n, err := f.File.ReadAt(buf, req.Offset)
+		if err == io.EOF {
+			resp.Data = buf[:n]
+		}
+		return nil
+	}
+	return ENODATA
+}
+
+func (f fileNode2) ReadDirAll(ctx context.Context) (out []fuse.Dirent, err error) {
+	asFS, err := f.FS()
+	if err != nil {
+		return nil, fuse.ENOTDIR
+	}
+	var t fuse.DirentType
+	for i := range asFS.e {
+		switch asFS.e[i].Type {
+		case inode.Fil:
+			t = fuse.DT_File
+		case inode.Dir:
+			t = fuse.DT_Dir
+		case inode.Block:
+			t = fuse.DT_Block
+		case inode.Sym:
+			t = fuse.DT_Link
+		case inode.Char:
+			t = fuse.DT_Char
+		case inode.Fifo:
+			t = fuse.DT_FIFO
+		case inode.Sock:
+			t = fuse.DT_Socket
+		default:
+			t = fuse.DT_Unknown
+		}
+		out = append(out, fuse.Dirent{
+			Inode: uint64(asFS.e[i].Num),
+			Type:  t,
+			Name:  asFS.e[i].Name,
+		})
+	}
+	return
+}

fuse3.go

@@ -3,6 +3,7 @@ package squashfs
 import (
 	"bytes"
 	"context"
+	"errors"
 	"io"
 
 	"github.com/CalebQ42/fuse"
@@ -10,30 +11,54 @@ import (
 	"github.com/CalebQ42/squashfs/internal/inode"
 )
 
-// Creates a fuse mount, then mounts the archive on a seperate goroutine.
-// If waiting for the mount to end, simply do <-con.Ready.
-func (r *Reader) Mount(mountpoint string) (con *fuse.Conn, err error) {
-	con, err = fuse.Mount(mountpoint, fuse.ReadOnly())
+// Mounts the archive to the given mountpoint using fuse3. Non-blocking.
+// If Unmount does not get called, the mount point must be unmounted using umount before the directory can be used again.
+func (r *Reader) Mount(mountpoint string) (err error) {
+	if r.con != nil {
+		return errors.New("squashfs archive already mounted")
+	}
+	r.con, err = fuse.Mount(mountpoint, fuse.ReadOnly())
 	if err != nil {
 		return
 	}
-	go fs.Serve(con, &squashFuse{r: r})
+	<-r.con.Ready
+	r.mountDone = make(chan struct{})
+	go func() {
+		fs.Serve(r.con, squashFuse{r: r})
+		close(r.mountDone)
+	}()
 	return
 }
 
+// Blocks until the mount ends.
+func (r *Reader) MountWait() {
+	if r.mountDone != nil {
+		<-r.mountDone
+	}
+}
+
+// Unmounts the archive.
+func (r *Reader) Unmount() error {
+	if r.con != nil {
+		defer func() { r.con = nil }()
+		return r.con.Close()
+	}
+	return errors.New("squashfs archive is not mounted")
+}
+
 type squashFuse struct {
 	r *Reader
 }
 
-func (s *squashFuse) Root() (fs.Node, error) {
-	return &fileNode{File: s.r.FS.File}, nil
+func (s squashFuse) Root() (fs.Node, error) {
+	return fileNode{File: s.r.FS.File}, nil
 }
 
 type fileNode struct {
 	*File
 }
 
-func (f *fileNode) Attr(ctx context.Context, attr *fuse.Attr) error {
+func (f fileNode) Attr(ctx context.Context, attr *fuse.Attr) error {
 	attr.Blocks = f.r.s.Size / 512
 	if f.r.s.Size%512 > 0 {
 		attr.Blocks++
@@ -47,15 +72,15 @@ func (f *fileNode) Attr(ctx context.Context, attr *fuse.Attr) error {
 	return nil
 }
 
-func (f *fileNode) Id() uint64 {
+func (f fileNode) Id() uint64 {
 	return uint64(f.i.Num)
 }
 
-func (f *fileNode) Readlink(ctx context.Context, req *fuse.ReadlinkRequest) (string, error) {
+func (f fileNode) Readlink(ctx context.Context, req *fuse.ReadlinkRequest) (string, error) {
 	return f.SymlinkPath(), nil
 }
 
-func (f *fileNode) Lookup(ctx context.Context, name string) (fs.Node, error) {
+func (f fileNode) Lookup(ctx context.Context, name string) (fs.Node, error) {
 	asFS, err := f.FS()
 	if err != nil {
 		return nil, fuse.ENOTDIR
@@ -64,19 +89,19 @@ func (f *fileNode) Lookup(ctx context.Context, name string) (fs.Node, error) {
 	if err != nil {
 		return nil, fuse.ENOENT
 	}
-	return &fileNode{File: ret}, nil
+	return fileNode{File: ret}, nil
 }
 
-func (f *fileNode) ReadAll(ctx context.Context) ([]byte, error) {
+func (f fileNode) ReadAll(ctx context.Context) ([]byte, error) {
 	if f.IsRegular() {
 		var buf bytes.Buffer
 		_, err := f.WriteTo(&buf)
 		return buf.Bytes(), err
 	}
-	return nil, fuse.ENODATA
+	return nil, ENODATA
 }
 
-func (f *fileNode) Read(ctx context.Context, req *fuse.ReadRequest, resp *fuse.ReadResponse) error {
+func (f fileNode) Read(ctx context.Context, req *fuse.ReadRequest, resp *fuse.ReadResponse) error {
 	if f.IsRegular() {
 		buf := make([]byte, req.Size)
 		n, err := f.File.ReadAt(buf, req.Offset)
@@ -85,10 +110,10 @@ func (f *fileNode) Read(ctx context.Context, req *fuse.ReadRequest, resp *fuse.R
 		}
 		return nil
 	}
-	return fuse.ENODATA
+	return ENODATA
 }
 
-func (f *fileNode) ReadDirAll(ctx context.Context) (out []fuse.Dirent, err error) {
+func (f fileNode) ReadDirAll(ctx context.Context) (out []fuse.Dirent, err error) {
 	asFS, err := f.FS()
 	if err != nil {
 		return nil, fuse.ENOTDIR

fuse_darwin.go

@@ -0,0 +1,7 @@
+package squashfs
+
+import (
+	"golang.org/x/sys/unix"
+)
+
+var ENODATA = unix.Errno(unix.ENODATA)

fuse_linux.go

@@ -0,0 +1,3 @@
+package squashfs
+
+var ENODATA = fuse.ENODATA

fuse_windows.go

@@ -0,0 +1,3 @@
+package squashfs
+
+var ENODATA = windows.Errno(windows.ENODATA)

go.mod

@@ -11,4 +11,7 @@ require (
 	github.com/ulikunitz/xz v0.5.10
 )
 
-require golang.org/x/sys v0.2.0 // indirect
+require (
+	github.com/seaweedfs/fuse v1.2.2
+	golang.org/x/sys v0.6.0 // indirect
+)

go.sum

@@ -6,9 +6,13 @@ github.com/pierrec/lz4/v4 v4.1.17 h1:kV4Ip+/hUBC+8T6+2EgburRtkE9ef4nbY3f4dFhGjMc
 github.com/pierrec/lz4/v4 v4.1.17/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
 github.com/rasky/go-lzo v0.0.0-20200203143853-96a758eda86e h1:dCWirM5F3wMY+cmRda/B1BiPsFtmzXqV9b0hLWtVBMs=
 github.com/rasky/go-lzo v0.0.0-20200203143853-96a758eda86e/go.mod h1:9leZcVcItj6m9/CfHY5Em/iBrCz7js8LcRQGTKEEv2M=
+github.com/seaweedfs/fuse v1.2.2 h1:01l8OjIdyATRNqVc/gDPgFobuC8ubQF3hRKOPColROw=
+github.com/seaweedfs/fuse v1.2.2/go.mod h1:iwbDQv5BZACY54r6AO/6xsLNuMaYcBKSkLTZVfmK594=
 github.com/therootcompany/xz v1.0.1 h1:CmOtsn1CbtmyYiusbfmhmkpAAETj0wBIH6kCYaX+xzw=
 github.com/therootcompany/xz v1.0.1/go.mod h1:3K3UH1yCKgBneZYhuQUvJ9HPD19UEXEI0BWbMn8qNMY=
 github.com/ulikunitz/xz v0.5.10 h1:t92gobL9l3HE202wg3rlk19F6X+JOxl9BBrCCMYEYd8=
 github.com/ulikunitz/xz v0.5.10/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
 golang.org/x/sys v0.2.0 h1:ljd4t30dBnAvMZaQCevtY0xLLD0A+bRZXbgLMLU1F/A=
 golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0 h1:MVltZSvRTcU2ljQOhs94SXPftV6DCNnZViHeQps87pQ=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

internal/data/fullreader.go

@@ -2,7 +2,6 @@ package data
 
 import (
 	"io"
-	"sync"
 
 	"github.com/CalebQ42/squashfs/internal/decompress"
 	"github.com/CalebQ42/squashfs/internal/toreader"
@@ -27,9 +26,9 @@ func NewFullReader(r io.ReaderAt, start uint64, d decompress.Decompressor, block
 	}
 }
 
-func (r *FullReader) AddFragment(rdr func() (io.Reader, error), size uint32) {
+func (r *FullReader) AddFragment(rdr func() (io.Reader, error)) {
 	r.fragRdr = rdr
-	r.sizes = append(r.sizes, size)
+	r.sizes = append(r.sizes, 0)
 }
 
 type outDat struct {
@@ -38,50 +37,49 @@ type outDat struct {
 	i    int
 }
 
-func (r FullReader) process(index int, offset int64, od *outDat, out chan *outDat) {
-	defer func() {
-		out <- od
-	}()
-	od.i = index
+func (r FullReader) process(index int, offset int64, out chan outDat) {
+	var err error
+	var dat []byte
+	var rdr io.ReadCloser
 	size := realSize(r.sizes[index])
 	if size == 0 {
-		od.err = nil
-		od.data = make([]byte, r.blockSize)
+		out <- outDat{
+			i:    index,
+			err:  nil,
+			data: make([]byte, r.blockSize),
+		}
 		return
 	}
+	// rdr := io.LimitReader(toreader.NewReader(r.r, offset), int64(size))
 	if size == r.sizes[index] {
 		if dec, ok := r.d.(decompress.Decoder); ok {
-			dat := make([]byte, size)
-			_, od.err = r.r.ReadAt(dat, offset)
-			if od.err != nil {
-				return
+			dat = make([]byte, size)
+			_, err = r.r.ReadAt(dat, offset)
+			if err == nil {
+				dat, err = dec.Decode(dat)
+			}
+		} else {
+			rdr, err = r.d.Reader(io.LimitReader(toreader.NewReader(r.r, offset), int64(size)))
+			if err == nil {
+				dat, err = io.ReadAll(rdr)
 			}
-			od.data, od.err = dec.Decode(dat, int(r.blockSize))
-			return
 		}
-		var rdr io.ReadCloser
-		rdr, od.err = r.d.Reader(io.LimitReader(toreader.NewReader(r.r, offset), int64(size)))
-		if od.err != nil {
-			return
-		}
-		od.data = make([]byte, r.blockSize)
-		var read int
-		read, od.err = rdr.Read(od.data)
-		od.data = od.data[:read]
-		rdr.Close()
 	} else {
-		od.data = make([]byte, size)
-		_, od.err = r.r.ReadAt(od.data, offset)
+		dat = make([]byte, size)
+		_, err = r.r.ReadAt(dat, offset)
+	}
+	out <- outDat{
+		i:    index,
+		err:  err,
+		data: dat,
+	}
+	if clr, ok := rdr.(io.Closer); ok {
+		clr.Close()
 	}
 }
 
 func (r FullReader) ReadAt(p []byte, off int64) (n int, err error) {
-	pol := &sync.Pool{
-		New: func() any {
-			return new(outDat)
-		},
-	}
-	out := make(chan *outDat, len(r.sizes))
+	out := make(chan outDat, len(r.sizes))
 	offset := r.start
 	num := len(r.sizes)
 	start := off / int64(r.blockSize)
@@ -101,42 +99,40 @@ func (r FullReader) ReadAt(p []byte, off int64) (n int, err error) {
 			offset += uint64(realSize(r.sizes[i]))
 			continue
 		}
-		od := pol.Get().(*outDat)
 		if i == num-1 && r.fragRdr != nil {
 			go func() {
-				defer func() {
-					out <- od
-				}()
 				rdr, e := r.fragRdr()
 				if err != nil {
-					od.i = num - 1
-					od.err = e
+					out <- outDat{
+						i:   num - 1,
+						err: e,
+					}
 					return
 				}
-				od.data = make([]byte, r.sizes[num-1])
-				_, e = rdr.Read(od.data)
-				od.i = num - 1
-				od.err = e
+				dat, e := io.ReadAll(rdr)
+				out <- outDat{
+					i:    num - 1,
+					err:  e,
+					data: dat,
+				}
 				if clr, ok := rdr.(io.Closer); ok {
 					clr.Close()
 				}
 			}()
 			continue
 		}
-		go r.process(i, int64(offset), od, out)
+		go r.process(i, int64(offset), out)
 		offset += uint64(realSize(r.sizes[i]))
 	}
-	cur := start
 	cache := make(map[int]outDat)
-	for dat := range out {
+	for cur := start; cur < int64(end); {
+		dat := <-out
 		if dat.err != nil {
 			err = dat.err
-			pol.Put(dat)
 			return
 		}
 		if dat.i != int(cur) {
-			cache[dat.i] = *dat
-			pol.Put(dat)
+			cache[dat.i] = dat
 			continue
 		}
 		if cur == start {
@@ -147,18 +143,16 @@ func (r FullReader) ReadAt(p []byte, off int64) (n int, err error) {
 		}
 		n += len(dat.data)
 		cur++
-		pol.Put(dat)
 		var ok bool
-		var curDat outDat
 		for {
-			curDat, ok = cache[int(cur)]
+			dat, ok = cache[int(cur)]
 			if !ok {
 				break
 			}
-			for i := range curDat.data {
-				p[n+i] = curDat.data[i]
+			for i := range dat.data {
+				p[n+i] = dat.data[i]
 			}
-			n += len(curDat.data)
+			n += len(dat.data)
 			cur++
 			delete(cache, int(cur))
 		}
@@ -170,57 +164,58 @@ func (r FullReader) ReadAt(p []byte, off int64) (n int, err error) {
 }
 
 func (r FullReader) WriteTo(w io.Writer) (n int64, err error) {
-	pol := &sync.Pool{
-		New: func() any {
-			return new(outDat)
-		},
-	}
-	out := make(chan *outDat, len(r.sizes))
+	out := make(chan outDat, len(r.sizes))
 	offset := r.start
 	num := len(r.sizes)
 	for i := 0; i < num; i++ {
-		od := pol.Get().(*outDat)
 		if i == num-1 && r.fragRdr != nil {
 			go func() {
-				defer func() {
-					out <- od
-				}()
 				rdr, e := r.fragRdr()
 				if err != nil {
-					od.i = num - 1
-					od.err = e
+					out <- outDat{
+						i:   num - 1,
+						err: e,
+					}
 					return
 				}
-				buf := make([]byte, r.sizes[num-1])
-				_, e = rdr.Read(buf)
-				od.i = num - 1
-				od.err = e
-				od.data = buf
+				dat, e := io.ReadAll(rdr)
+				out <- outDat{
+					i:    num - 1,
+					err:  e,
+					data: dat,
+				}
 				if clr, ok := rdr.(io.Closer); ok {
 					clr.Close()
 				}
 			}()
 			continue
 		}
-		go r.process(i, int64(offset), od, out)
+		go r.process(i, int64(offset), out)
 		offset += uint64(realSize(r.sizes[i]))
 	}
-	wt, ok := w.(io.WriterAt)
-	if !ok {
-		var cur int
-		cache := make(map[int]outDat)
-		var tmpN int
-		var dat *outDat
-		for cur < len(r.sizes) {
-			dat = <-out
-			defer pol.Put(dat)
-			if dat.err != nil {
-				err = dat.err
-				return
-			}
-			if dat.i != cur {
-				cache[dat.i] = *dat
-				continue
+	cache := make(map[int]outDat)
+	var tmpN int
+	for cur := 0; cur < num; {
+		dat := <-out
+		if dat.err != nil {
+			err = dat.err
+			return
+		}
+		if dat.i != cur {
+			cache[dat.i] = dat
+			continue
+		}
+		tmpN, err = w.Write(dat.data)
+		n += int64(tmpN)
+		if err != nil {
+			return
+		}
+		cur++
+		var ok bool
+		for {
+			dat, ok = cache[cur]
+			if !ok {
+				break
 			}
 			tmpN, err = w.Write(dat.data)
 			n += int64(tmpN)
@@ -228,36 +223,6 @@ func (r FullReader) WriteTo(w io.Writer) (n int64, err error) {
 				return
 			}
 			cur++
-			var ok bool
-			var curDat outDat
-			for {
-				curDat, ok = cache[cur]
-				if !ok {
-					break
-				}
-				tmpN, err = w.Write(curDat.data)
-				n += int64(tmpN)
-				if err != nil {
-					return
-				}
-				cur++
-			}
-		}
-	} else {
-		var done int
-		var dat *outDat
-		for done < len(r.sizes) {
-			dat = <-out
-			defer pol.Put(dat)
-			if dat.err != nil {
-				err = dat.err
-				return
-			}
-			_, err = wt.WriteAt(dat.data, int64(dat.i*int(r.blockSize)))
-			if err != nil {
-				return
-			}
-			done++
 		}
 	}
 	return

internal/decompress/interface.go

@@ -18,5 +18,5 @@ type Resetable interface {
 
 type Decoder interface {
 	//Decodes a chunk of data all at once.
-	Decode(in []byte, outSize int) ([]byte, error)
+	Decode(in []byte) ([]byte, error)
 }

internal/decompress/lz4.go

@@ -16,12 +16,3 @@ func (l Lz4) Reset(old, src io.Reader) error {
 	old.(*lz4.Reader).Reset(src)
 	return nil
 }
-
-func (l Lz4) Decode(in []byte, outSize int) (out []byte, err error) {
-	out = make([]byte, outSize)
-	outLen, err := lz4.UncompressBlock(in, out)
-	if outLen < outSize {
-		out = out[:outLen]
-	}
-	return
-}

internal/decompress/zstd.go

@@ -19,9 +19,9 @@ func (z Zstd) Reset(old, src io.Reader) error {
 	return old.(*zstd.Decoder).Reset(src)
 }
 
-func (z Zstd) Decode(in []byte, outSize int) ([]byte, error) {
+func (z Zstd) Decode(in []byte) ([]byte, error) {
 	if z.writeToReader == nil {
 		z.writeToReader, _ = zstd.NewReader(nil)
 	}
-	return z.writeToReader.DecodeAll(in, make([]byte, outSize))
+	return z.writeToReader.DecodeAll(in, nil)
 }

reader.go

@@ -7,15 +7,21 @@ import (
 	"math"
 	"time"
 
+	"github.com/CalebQ42/fuse"
 	"github.com/CalebQ42/squashfs/internal/decompress"
 	"github.com/CalebQ42/squashfs/internal/directory"
 	"github.com/CalebQ42/squashfs/internal/inode"
 	"github.com/CalebQ42/squashfs/internal/metadata"
 	"github.com/CalebQ42/squashfs/internal/toreader"
+	fuse2 "github.com/seaweedfs/fuse"
 )
 
 type Reader struct {
 	*FS
+	con         *fuse.Conn
+	con2        *fuse2.Conn
+	mountDone   chan struct{}
+	mount2Done  chan struct{}
 	d           decompress.Decompressor
 	r           io.ReaderAt
 	fragEntries []fragEntry

reader_inode.go

@@ -70,7 +70,7 @@ func (r Reader) getReaders(i inode.Inode) (full *data.FullReader, rdr *data.Read
 			}
 			fragRdr = io.LimitReader(fragRdr, int64(fragSize))
 			return fragRdr, nil
-		}, fragSize)
+		})
 		var fragRdr io.Reader
 		fragRdr, err = r.fragReader(fragInd)
 		if err != nil {

squashfs_test.go

@@ -196,11 +196,11 @@ func TestFuse(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	con, err := rdr.Mount("testing/fuseTest")
+	err = rdr.Mount("testing/fuseTest")
 	if err != nil {
 		t.Fatal(err)
 	}
-	defer con.Close()
-	<-con.Ready
+	defer rdr.Unmount()
+	rdr.MountWait()
 	t.Fatal("testing")
 }