fuse-d 0.6.0

fuse.d

fuse.d is a fork of the unmaintained dfuse library. All previous unmerged pull requests have been added to this one, and I have done my best to credit the authors in the git history. I'm releasing this library under a different name so that both fuse.d and dfuse can co-exist on the package repository.

fuse.d is a D language binding for the high level fuse library. It allows to write a fuse filesystem for Linux or Mac OS (using osxfuse) in D.

Fuse is a library and kernel extension to write filesystems in userspace. These filesystems are easy to implement and have access to userland components like HTTP libraries, etc. For more information about fuse see: http://fuse.sourceforge.net.

Examples

A simple filesystems implementing a directory listing can be found in the examples/ directory. You can build the examples using:

$ make examples
$ mkdir /mnt/simplefs
$ ./simplefs /mnt/simplefs

Implementing a filesystem

dfuse provides a high level interface for libfuse. To implement a filesystem, extend the Operations class in the fused.fuse module:

import fused.fuse;

class MyFS : Operations
{
    override void getattr(const(char)[] path, ref stat_t s)
    {
        /* implementation */
        throw new FuseException(EOPNOTSUPP);
    }
    
    override string[] readdir(const(char)[] path)
    {
       return [/*...list of files...*/];
    }
    
    override ulong read(const(char)[] path, ubyte[] buf, ulong offset)
    {
       /* implementation */
       throw new FuseException(EOPNOTSUPP);
    }
}

A minimal filesystem implements Operations.getattr(), Operations.readdir(), Operations.read(). See fused/fuse.d for implementation specific details.

To mount a filesystem use a Fuse object and call mount:

import fused.fuse;

int main(string[] args)
{
    /* foreground=true, threading=false */
    auto fs = new Fuse("MyFS", true, false);
    fs.mount(new MyFS(), "/mnt", ["allow_other"]);
}

Error conditions are handled by throwin a FuseException with the appropriate error number. See man 3 errno for more information about errno.

Requirements

fuse.d requires:

• Mac OS X or Linux
• fuse >= 2.8.0 or osxfuse >= 2.6.0
• DMD/Druntime/Phobos >= 2.065

Building fused

fuse.d comes with a standard makefile that assumes that DMD (the D-compiler) is in your $PATH.

Linux

In order to compile fuse.d on Linux:

$ make dfuse
or
$ make dfuse ENABLE_DEBUG=1
to build a debug version

MacOS

MacOS supports two inode sizes which are both supported by OSXfuse, however when compiling fuse.d you have to be aware which OSXfuse should be linked.

By default fuse.d is trying to build with a 32bit inode size and link against osxfuse_i32 which is part of OSXfuse for compatibility. Please note that your library itself will still be 64bit on a 64bit system. The setting only affects the size of the inode.

To build just run

$ make dfuse

If you want to compile with 64bit inodes you need a at least DMD, Druntime, Phobos in version 2.066:

$ make dfuse ENABLE_64BIT=1

Dub

fuse.d comes with experimental support for dub, a package manager for D. See the dub documentation how to build and use dub.

Installing fuse.d

At the moment the fuse.d makefile doesn't support an install target. It is recommended to just include the library in a project at this point.

How fuse.d works

fuse.d is a simple D wrapper. It exposes a lowelevel interface to the libfuse C functions in c/fuse/fuse.d. The lowlevel interface preserves C types.

A highlevel interface is provided by fs/fuse.d. The D interface initializes fuse filsystems operations structure and installs it's own handlers. Every fuse.d handler converts C types to D types and is trapping FuseExceptions used for error handling. The handlers keep track of the initialized Operations object and call the appropriate method once types are converted and pass the result into the D layer.

The user facing interface is the Operations class in fs/fuse.d. It provides default implementations for all handlers and every method can be invidually overwritten to provide an interface.

Issues and Bugs

If you encounter issues or bugs with fuse.d, please file an issue on github. Please ensure that you maintain a constructive feedback atmosphere and if possible attach a reproduction step. If you have any questions, feel free to write to the D mailinglist or ask in IRC.

Pull requests are highly appreciated!

Join the dfuse community

• Website: https://github.com/facebook/dfuse/wiki
• Mailing list: The D Mailinglist
• irc: irc.freenode.net #d

License

dfuse is Boost-licensed. We also provide an additional patent grant.