1. fuse
  2. Description
    1. Requirements
    2. Platform Notes
    3. Runtime Structure
  3. API
  4. Examples
  5. Author
  6. Repository
  7. License


A FUSE interface.

Installation requires the libfuse library and headers (API version 26) and CHICKEN version 5.0 or newer.

The source for this extension is available here.

This extension's interface is subject to change without notice.


Platform Notes

This extension is only officially supported on Linux and OpenBSD. It has also been installed successfully on FreeBSD and Mac OS X, but tested far less thoroughly on those platforms.

On Linux, the fusermount(1) utility must be available for filesystem-stop! to work correctly. This program is typically included with the libfuse library.

On OpenBSD, root privileges are required, each filesystem's main loop is single-threaded, and the ioctl: callback is not available.

Runtime Structure

Each filesystem is executed in a separate native thread that communicates with the (single, shared) CHICKEN runtime through a Unix pipe and shared memory. Multiple filesystems can be run at once from within a single process, but FUSE operations are synchronous across all filesystems so long-running callbacks should be avoided.

More importantly, care must be taken not to deadlock the Scheme runtime by initiating a blocking filesystem operation from within CHICKEN that itself requires a response from CHICKEN, for example by opening a file that's part of a running filesystem. The easiest way to avoid this situation is to run each filesystem in a more-or-less dedicated OS-level process whose sole responsibility is to service FUSE requests.


[record] filesystem
[procedure] (filesystem? object) -> boolean

A filesystem is an opaque, defstruct-style record type representing a set of FUSE filesystem operations.

[procedure] (make-filesystem #!key <operation> ...) -> filesystem

Create a FUSE filesystem.

The keyword arguments to make-filesystem specify the resulting filesystem's callback procedures. Each <operation> should be one the following:

(procedure path mode) -> value
(procedure path mode) -> value
(procedure uid gid) -> value
(procedure path mode) -> (or handle false)
(procedure) -> void
(procedure path) -> value
(procedure path) -> value
(procedure path) -> (or (vector mode nlink uid gid size atime ctime mtime) false)
(procedure) -> void
(procedure path int pointer) -> value
(procedure path path) -> value
(procedure path mode) -> value
(procedure path mode) -> value
(procedure path mode) -> (or handle false)
(procedure path) -> (or (list path ...) value)
(procedure path) -> (or path false)
(procedure handle size offset) -> (or size string value)
(procedure handle) -> value
(procedure path path) -> value
(procedure path) -> value
(procedure path) -> (or (vector bsize blocks bfree bavail files ffree namemax) false)
(procedure path path) -> value
(procedure path) -> value
(procedure path) -> value
(procedure path atime mtime) -> value
(procedure handle string offset) -> (or size string value)

offset, size, mode, nlink, uid, gid, size, atime, ctime and mtime are numeric values with the obvious meanings. A path is a pathname string. bsize, blocks, bfree, bavail, files, ffree and namemax are positive numeric values corresponding to the statvfs(2) struct members of the same names.

A value may be any Scheme object and indicates whether the filesystem operation was successful. When false, the filesystem will indicate a nonexistent file (ENOENT); any other value indicates success. Callbacks should signal other types of failures by raising an appropriate errno(3) value. For example, to signal insufficient permissions, an access: operation should (raise errno/perm).

A handle may be any Scheme object and represents a file handle. When returned as the result of an open: or create:callback, this value is provided to that file's subsequent read:, write: and release: operations. release: is guaranteed to be called once for every successful open: or create:, while read: and write: should be prepared to be called multiple times with diverse offset values.

[procedure] (filesystem-start! path filesystem) -> (or false undefined)

Start filesystem at the given path.

path should be a pathname string indicating an empty directory.

On successful startup, the filesystem is mounted, its init: callback is executed, any threads waiting for the filesystem to start are unblocked, and a non-false value is returned. On failure, #f is returned immediately.

filesystem-start! does not wait for filesystem initialization before returning. To block until the filesystem becomes available, use filesystem-wait!.

The effective exception handler for the filesystem's operations at path is that of the call to filesystem-start!'s dynamic environment, and must always return with a suitable errno(3) integer value. Failure to do so may result in orphaned mounts, infinite loops, and locusts.

[procedure] (filesystem-stop! path filesystem) -> undefined

Stop filesystem at the given path.

path should be a pathname string and must exactly match the value provided to filesystem-start! when the filesystem was started (according to string=?).

If the given filesystem isn't currently mounted at path, this procedure is a noop. Otherwise, the filesystem is unmounted, any threads waiting for the filesystem to stop are unblocked, and its destroy: callback is executed.

filesystem-stop! does not wait for filesystem shutdown before returning. To block until the filesystem is fully stopped, use filesystem-wait!.

[procedure] (filesystem-wait! path filesystem [status]) -> undefined

Block until filesystem is started or stopped at path.

path should be a pathname string and must exactly match the value provided to filesystem-start! when the filesystem was started (according to string=?).

The optional status argument should be a symbol indicating the filesystem state for which to wait, either started or stopped. If not specified, stopped is used.

[procedure] (filesystem-running? path filesystem) -> boolean

Determine whether filesystem is currently running at path.

path should be a pathname string and must exactly match the value provided to filesystem-start! when the filesystem was started (according to string=?).

[constant] file/fifo
[constant] file/chr
[constant] file/blk
[constant] file/reg
[constant] file/dir
[constant] file/lnk
[constant] file/sock

These values correspond to the S_IF* flags specified by stat(2). They're not FUSE-specific, but may be useful when defining getattr: callbacks.


Usage examples can be found in the project's examples directory.


Evan Hanson

Credit to Ivan Raikov for initial work on libfuse bindings and inspiration for the keyword-based API.

Credit to Jörg Wittenberger for lots of helpful bug hunting.




3-Clause BSD