CGoFUSE

https://github.com/winfsp/cgofuse
Admin
cgofuse is a cross-platform FUSE library for Go, supporting cgo, !cgo, FUSE2, and FUSE3 variants...
Tokens:4,708
Snippets:21
Trust Score:7.3
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Build cgofuse on NetBSD

Source: https://github.com/winfsp/cgofuse/blob/master/README.md

Builds the cgofuse library and examples on NetBSD. No specific prerequisites are listed. Uses the standard 'go install' command.

```bash
$ go install -v ./fuse ./examples/memfs ./examples/passthrough
```

--------------------------------

### Build cgofuse on FreeBSD (FUSE)

Source: https://github.com/winfsp/cgofuse/blob/master/README.md

Builds the cgofuse library and examples on FreeBSD using FUSE. Requires fusefs-libs. Uses the standard 'go install' command.

```bash
$ go install -v ./fuse ./examples/memfs ./examples/passthrough
```

--------------------------------

### Build cgofuse on FreeBSD (FUSE3)

Source: https://github.com/winfsp/cgofuse/blob/master/README.md

Builds the cgofuse library and examples on FreeBSD using FUSE3. Requires fusefs-libs3. Uses 'go install' with the 'fuse3' build tag.

```bash
$ go install -tags=fuse3 -v ./fuse ./examples/memfs ./examples/passthrough
```

--------------------------------

### Build cgofuse on Linux (FUSE)

Source: https://github.com/winfsp/cgofuse/blob/master/README.md

Builds the cgofuse library and examples on Linux using FUSE2. Requires libfuse-dev and gcc. Uses the standard 'go install' command.

```bash
$ go install -v ./fuse ./examples/memfs ./examples/passthrough
```

--------------------------------

### Build cgofuse on OpenBSD

Source: https://github.com/winfsp/cgofuse/blob/master/README.md

Builds the cgofuse library and examples on OpenBSD. No specific prerequisites are listed. Uses the standard 'go install' command. Note: User mounts are not supported on OpenBSD 6+.

```bash
$ go install -v ./fuse ./examples/memfs ./examples/passthrough
```

--------------------------------

### Build cgofuse on macOS

Source: https://github.com/winfsp/cgofuse/blob/master/README.md

Builds the cgofuse library and examples on macOS. Requires macFUSE and Xcode command line tools. Uses the standard 'go install' command.

```bash
$ go install -v ./fuse ./examples/memfs ./examples/passthrough
```

--------------------------------

### Build cgofuse on Linux (FUSE3)

Source: https://github.com/winfsp/cgofuse/blob/master/README.md

Builds the cgofuse library and examples on Linux using FUSE3. Requires libfuse3-dev and gcc. Uses 'go install' with the 'fuse3' build tag.

```bash
$ go install -tags=fuse3 -v ./fuse ./examples/memfs ./examples/passthrough
```

--------------------------------

### Build cgofuse on Windows (cgo)

Source: https://github.com/winfsp/cgofuse/blob/master/README.md

Builds the cgofuse library and examples on Windows using cgo. Requires WinFsp and a C compiler like MinGW. Sets the CPATH environment variable to point to WinFsp headers.

```powershell
> set CPATH=C:\Program Files (x86)\WinFsp\inc\fuse
> go install -v ./fuse ./examples/memfs
```

--------------------------------

### Access Method Example for Delete Access

Source: https://github.com/winfsp/cgofuse/blob/master/Changelog.md

Example implementation of the Access file system operation to deny delete access on Windows when FileSystemHost.SetCapDeleteAccess is used. It checks for the fuse.DELETE_OK mask and returns -fuse.EPERM for specific paths.

```go
func (fs *filesystem) Access(path string, mask uint32) int {
    if "windows" == runtime.GOOS {
        if 0 != mask&fuse.DELETE_OK {
            if "/nounlink" == path {
                return -fuse.EPERM
            }
        }
        return 0
    } else {
        return -fuse.ENOSYS
    }
}
```

--------------------------------

### Build cgofuse on Windows (!cgo)

Source: https://github.com/winfsp/cgofuse/blob/master/README.md

Builds the cgofuse library and examples on Windows without cgo. Requires WinFsp. Disables cgo by setting the CGO_ENABLED=0 environment variable.

```powershell
> set CGO_ENABLED=0
> go install -v ./fuse ./examples/memfs
```

--------------------------------

### FileSystemHost.Notify API

Source: https://github.com/winfsp/cgofuse/blob/master/Changelog.md

Adds the FileSystemHost.Notify API, enabling user-mode file systems to issue file change notifications. This is primarily for Windows and is showcased by the notifyfs example.

```APIDOC
FileSystemHost.Notify:
  - Allows user-mode file systems to signal changes to files or directories.
  - Primarily supported on Windows.
  - Used by the 'notifyfs' example file system.
```

--------------------------------

### cgofuse FileSystemInterface and FileSystemHost

Source: https://github.com/winfsp/cgofuse/blob/master/README.md

Describes the core Go interfaces and types for implementing FUSE file systems with cgofuse. Users implement fuse.FileSystemInterface, optionally embedding fuse.FileSystemBase for default implementations, and use fuse.NewFileSystemHost to mount.

```APIDOC
fuse.FileSystemInterface:
  Represents a FUSE file system. Implementations must provide methods for file system operations.

fuse.FileSystemBase:
  A base struct that provides default implementations for fuse.FileSystemInterface. Can be embedded to simplify implementation.

fuse.NewFileSystemHost(fs fuse.FileSystemInterface) *FileSystemHost:
  Creates a new FileSystemHost to manage and mount the given file system implementation.
```

--------------------------------

### NetBSD FUSE User Mount Configuration

Source: https://github.com/winfsp/cgofuse/blob/master/README.md

Configures NetBSD for FUSE file system access. Grants read/write permissions to /dev/puffs and enables user mounts via sysctl.

```bash
$ chmod go+rw /dev/puffs
$ sysctl -w vfs.generic.usermount=1
```

--------------------------------

### FreeBSD FUSE User Mount Configuration

Source: https://github.com/winfsp/cgofuse/blob/master/README.md

Configures FreeBSD to allow user mounts for FUSE file systems. Involves modifying loader.conf, enabling user mounts via sysctl, and adding the user to the 'operator' group.

```bash
$ 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
```

--------------------------------

### FileSystemOpenEx Interface

Source: https://github.com/winfsp/cgofuse/blob/master/Changelog.md

Introduces the FileSystemOpenEx interface, providing extended options or parameters for file open operations.

```APIDOC
FileSystemOpenEx:
  OpenEx(path string, flags uint32) (fuse.Handle, uint32, int)
    - An extended version of the Open interface, potentially offering more control or information during file opening.
```

--------------------------------

### New FileSystemHost Capabilities

Source: https://github.com/winfsp/cgofuse/blob/master/Changelog.md

Details new capabilities that can be set on the FileSystemHost to inform the FUSE host about specific behaviors or requirements of the user-mode file system.

```APIDOC
FileSystemHost.SetCapDeleteAccess:
  - Allows a file system to deny delete access on Windows.
  - Requires implementing the Access operation to handle fuse.DELETE_OK mask.
  - Requires returning -fuse.EPERM from Unlink/Rmdir for protected files.

FileSystemHost.SetCapOpenTrunc:
  - Informs the host that the file system can handle the O_TRUNC flag during open operations.

FileSystemHost.SetDirectIO:
  - Disables page caching on FUSE3 for improved performance or specific I/O patterns.

FileSystemHost.SetUseIno:
  - Instructs the host to use the 'ino' values reported by operations like Getattr on FUSE3.
```

--------------------------------

### FileSystemGetpath Interface

Source: https://github.com/winfsp/cgofuse/blob/master/Changelog.md

Introduces the FileSystemGetpath interface, which allows case-insensitive file systems to report the correct case of a file path, particularly useful on Windows.

```APIDOC
FileSystemGetpath:
  Getpath(path string) string
    - Returns the canonical or correctly-cased path for a given input path.
    - Useful for file systems that need to enforce case sensitivity or provide consistent path representations.
```

--------------------------------

### BSD Platform Support and Flags

Source: https://github.com/winfsp/cgofuse/blob/master/Changelog.md

Details the implementation of BSD-specific file system flags and time-related operations, including chflags, setcrtime, and setchgtime, enhancing compatibility and functionality on BSD systems.

```APIDOC
BSD Platform Support:
  - Implements BSD-specific flags like `flags`, `chflags`.
  - Supports setting creation time (`setcrtime`) and change time (`setchgtime`).
  - Enhances compatibility with FreeBSD, NetBSD, and OpenBSD.
```

--------------------------------

### New FUSE3 Interfaces

Source: https://github.com/winfsp/cgofuse/blob/master/Changelog.md

Introduces new file system interfaces that provide enhanced functionality specifically for FUSE3 environments. These interfaces often include additional parameters like file handles or flags available in FUSE3.

```APIDOC
FileSystemChmod3:
  Chmod3(path string, mode uint32, fh uint64) int
    - Similar to Chmod, but includes a file handle (fh) available under FUSE3.

FileSystemChown3:
  Chown3(path string, uid uint32, gid uint32, fh uint64) int
    - Similar to Chown, but includes a file handle (fh) available under FUSE3.

FileSystemUtimens3:
  Utimens3(path string, tm [2]fuse.Timespec, fh uint64) int
    - Similar to Utimes, but includes a file handle (fh) available under FUSE3.

FileSystemRename3:
  Rename3(oldpath string, newpath string, flags uint32, fh uint64) int
    - Similar to Rename, but includes FUSE3-specific flags like RENAME_NOREPLACE and RENAME_EXCHANGE.
```

--------------------------------

### OptParse Function

Source: https://github.com/winfsp/cgofuse/blob/master/Changelog.md

The OptParse function is responsible for parsing FUSE options provided during file system mounting. It handles configuration parameters passed to the cgofuse library.

```APIDOC
OptParse:
  - Parses FUSE options from a string or slice.
  - Configures the file system based on the provided options.
  - Used internally by cgofuse to set up the file system host.
```

--------------------------------

### fuse.Error Formatting

Source: https://github.com/winfsp/cgofuse/blob/master/Changelog.md

Provides fmt.Stringer and fmt.GoStringer implementations for the fuse.Error type, enabling better string representation and debugging of FUSE-related errors.

```APIDOC
fuse.Error:
  - Implements fmt.Stringer for user-friendly error messages.
  - Implements fmt.GoStringer for developer-focused representations.
  - Enhances debugging and logging of FUSE errors.
```
Tokens:
Raw