Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/winfsp/cgofuse
Cross-platform FUSE library for Go - Works on Windows, macOS, Linux, FreeBSD, NetBSD, OpenBSD
https://github.com/winfsp/cgofuse
cgo cross-platform fuse go golang
Last synced: 6 days ago
JSON representation
Cross-platform FUSE library for Go - Works on Windows, macOS, Linux, FreeBSD, NetBSD, OpenBSD
- Host: GitHub
- URL: https://github.com/winfsp/cgofuse
- Owner: winfsp
- License: mit
- Created: 2017-04-18T22:38:22.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-06-26T07:39:22.000Z (over 1 year ago)
- Last Synced: 2024-04-10T10:20:35.027Z (10 months ago)
- Topics: cgo, cross-platform, fuse, go, golang
- Language: Go
- Homepage: https://winfsp.dev
- Size: 323 KB
- Stars: 488
- Watchers: 18
- Forks: 82
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Cross-platform FUSE library for Go
_Cgofuse is a cross-platform FUSE library for Go. It is supported on multiple platforms and can be ported to any platform that has a FUSE implementation. It has [cgo](https://pkg.go.dev/cmd/cgo), [!cgo](https://go.dev/wiki/WindowsDLLs) (aka "nocgo") and [FUSE](https://github.com/libfuse/libfuse/tree/fuse-2.9.9) (aka "FUSE2"), [FUSE3](https://github.com/libfuse/libfuse) variants depending on the platform._
| |**cgo** |**!cgo** |**FUSE** |**FUSE3** |
|:----------:|:----------:|:----------:|:----------:|:----------:|
|**Windows** |✓ |✓ |✓ | |
|**macOS** |✓ | |✓ | |
|**Linux** |✓ | |✓ |✓ |
|**FreeBSD** |✓ | |✓ |✓ |
|**NetBSD** |✓ | |✓ | |
|**OpenBSD** |✓ | |✓ | |
## How to build
**Windows**
- Prerequisites: [WinFsp](https://github.com/winfsp/winfsp), gcc (e.g. from [Mingw-builds](http://mingw-w64.org/doku.php/download))
- Build **cgo**:
```
> set CPATH=C:\Program Files (x86)\WinFsp\inc\fuse
> go install -v ./fuse ./examples/memfs
```
- Build **!cgo**:
```
> set CGO_ENABLED=0
> go install -v ./fuse ./examples/memfs
```
**macOS**
- Prerequisites: [macFUSE](https://macfuse.github.io/), [command line tools](https://developer.apple.com/library/content/technotes/tn2339/_index.html)
- Build:
```
$ go install -v ./fuse ./examples/memfs ./examples/passthrough
```
**Linux**
- Prerequisites: libfuse-dev, libfuse3-dev, gcc
- Build **FUSE**:
```
$ go install -v ./fuse ./examples/memfs ./examples/passthrough
```
- Build **FUSE3**:
```
$ go install -tags=fuse3 -v ./fuse ./examples/memfs ./examples/passthrough
```
**FreeBSD**
- Prerequisites: fusefs-libs, fusefs-libs3
- Build **FUSE**:
```
$ go install -v ./fuse ./examples/memfs ./examples/passthrough
```
- Build **FUSE3**:
```
$ go install -tags=fuse3 -v ./fuse ./examples/memfs ./examples/passthrough
```
- Note: You may also need the following in order to run FUSE file system. Commands must be run as root.
```
$ vi /boot/loader.conf # add: fuse_load="YES"
$ sysctl vfs.usermount=1 # allow user mounts
$ pw usermod USERNAME -G operator # allow user to open /dev/fuse
```
**NetBSD**
- Prerequisites: NONE
- Build:
```
$ go install -v ./fuse ./examples/memfs ./examples/passthrough
```
- Note: You may also need the following in order to run FUSE file systems. Commands must be run as root.
```
$ chmod go+rw /dev/puffs
$ sysctl -w vfs.generic.usermount=1
```
- Note: Support is experimental. There are known issues that stem from the differences in the NetBSD [librefuse](https://github.com/NetBSD/src/tree/bbc46b99bff565d75f55fb23b51eff511068b183/lib/librefuse) implementation from the reference [libfuse](https://github.com/libfuse/libfuse) implementation.
**OpenBSD**
- Prerequisites: NONE
- Build:
```
$ go install -v ./fuse ./examples/memfs ./examples/passthrough
```
- Note: OpenBSD 6 removed the `kern.usermount` option, which allowed non-root users to mount file systems [[link](https://undeadly.org/cgi?action=article&sid=20160715125022&mode=expanded&count=0)]. Therefore you must be root in order to use FUSE and cgofuse.
- Note: Support is experimental. There are known issues that stem from the differences in the OpenBSD [libfuse](https://github.com/openbsd/src/tree/dae5ffec5618b0b660e9064e3b0991bb4ab1b1e8/lib/libfuse) implementation from the reference [libfuse](https://github.com/libfuse/libfuse) implementation.
## How to use
User mode file systems are expected to implement `fuse.FileSystemInterface`. To make implementation simpler a file system can embed ("inherit") a `fuse.FileSystemBase` which provides default implementations for all operations. To mount a file system one must instantiate a `fuse.FileSystemHost` using `fuse.NewFileSystemHost`.
The full documentation is available at GoDoc.org: [package fuse](https://godoc.org/github.com/winfsp/cgofuse/fuse)
There are currently three example file systems:
- [Hellofs](examples/hellofs/hellofs.go) is an extremely simple file system. Runs on all OS'es.
- [Memfs](examples/memfs/memfs.go) is an in memory file system. Runs on all OS'es.
- [Passthrough](examples/passthrough/passthrough.go) is a file system that passes all operations to the underlying file system. Runs on all OS'es except Windows.
- [Notifyfs](examples/notifyfs/notifyfs.go) is a file system that can issue file change notifications. Runs on Windows only.
## How it is tested
The following software is being used to test cgofuse.
**Windows (cgo and !cgo)**
- [winfsp-tests](https://github.com/winfsp/winfsp/tree/master/tst/winfsp-tests)
- [fsx](https://github.com/billziss-gh/secfs.test/tree/master/fstools/src/fsx)
**macOS**
- [fstest](https://github.com/billziss-gh/secfs.test/tree/master/fstest/ntfs-3g-pjd-fstest-8af5670)
- [fsx](https://github.com/billziss-gh/secfs.test/tree/master/fstools/src/fsx)
**Linux**
- [fstest](https://github.com/billziss-gh/secfs.test/tree/master/fstest/ntfs-3g-pjd-fstest-8af5670)
- [fsx](https://github.com/billziss-gh/secfs.test/tree/master/fstools/src/fsx)
**FreeBSD**
- [fsx](https://github.com/billziss-gh/secfs.test/tree/master/fstools/src/fsx)