#fuse #virtio #virtio-fs #vhost-user-fs

fuse-backend-rs

A rust library for Fuse(filesystem in userspace) servers and virtio-fs devices

11 releases (5 breaking)

new 0.9.4 Jun 22, 2022
0.9.0 Apr 27, 2022
0.4.0 Mar 29, 2022
0.2.0 Dec 30, 2021
0.1.1 Feb 13, 2021

#33 in Filesystem

Download history 166/week @ 2022-03-09 79/week @ 2022-03-16 271/week @ 2022-03-23 340/week @ 2022-03-30 332/week @ 2022-04-06 196/week @ 2022-04-13 338/week @ 2022-04-20 449/week @ 2022-04-27 270/week @ 2022-05-04 486/week @ 2022-05-11 210/week @ 2022-05-18 637/week @ 2022-05-25 448/week @ 2022-06-01 712/week @ 2022-06-08 942/week @ 2022-06-15 625/week @ 2022-06-22

2,786 downloads per month
Used in 4 crates

Apache-2.0 AND BSD-3-Clause

675KB
14K SLoC

Rust FUSE library for server, virtio-fs and vhost-user-fs

Crates.io Crates.io

Design

The fuse-backend-rs crate is an rust library to implement Fuse daemons based on the Linux FUSE device (/dev/fuse) or the virtiofs draft specification.

Linux FUSE is an userspace filesystem framework, and the /dev/fuse device node is the interface for userspace filesystem daemons to communicate with the in-kernel fuse driver.

And the virito-fs specification extends the FUSE framework into the virtualization world, which uses the Virtio protocol to transfer FUSE requests and responses between the Fuse client and server. With virtio-fs, the Fuse client runs within the guest kernel and the Fuse server runs on the host userspace or hardware.

So the fuse-rs crate is a library to communicate with the Linux FUSE clients, which includes:

  • ABI layer, which defines all data structures shared between linux Fuse framework and Fuse daemons.
  • API layer, defines the interfaces for Fuse daemons to implement a userspace file system.
  • Transport layer, which supports both the Linux Fuse device and virtio-fs protocol.
  • VFS/pseudo_fs, an abstraction layer to support multiple file systems by a single virtio-fs device.
  • A sample passthrough file system implementation, which passes through files from daemons to clients.

Examples

Filesystem Drivers

Fuse Servers

Fuse Server and Main Service Loop

A sample fuse server based on the Linux Fuse device (/dev/fuse):

use fuse_backend_rs::api::{server::Server, Vfs, VfsOptions};
use fuse_backend_rs::transport::fusedev::{FuseSession, FuseChannel};

struct FuseServer {
    server: Arc<Server<Arc<Vfs>>>,
    ch: FuseChannel,
}

impl FuseServer {
    fn svc_loop(&self) -> Result<()> {
      // Given error EBADF, it means kernel has shut down this session.
      let _ebadf = std::io::Error::from_raw_os_error(libc::EBADF);
      loop {
        if let Some((reader, writer)) = self
                .ch
                .get_request()
                .map_err(|_| std::io::Error::from_raw_os_error(libc::EINVAL))?
        {
          if let Err(e) = self.server.handle_message(reader, writer, None, None) {
            match e {
              fuse_backend_rs::Error::EncodeMessage(_ebadf) => {
                break;
              }
              _ => {
                error!("Handling fuse message failed");
                continue;
              }
            }
          }
        } else {
          info!("fuse server exits");
          break;
        }
      }
      Ok(())
    }
}

License

This project is licensed under

Dependencies

~2.1–7.5MB
~123K SLoC