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


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

16 releases

0.10.2 Mar 1, 2023
0.10.0 Nov 23, 2022
0.9.5 Jul 20, 2022
0.4.0 Mar 29, 2022
0.1.1 Feb 13, 2021

#26 in Unix APIs

Download history 1960/week @ 2022-11-30 1566/week @ 2022-12-07 1052/week @ 2022-12-14 908/week @ 2022-12-21 935/week @ 2022-12-28 1024/week @ 2023-01-04 1342/week @ 2023-01-11 951/week @ 2023-01-18 1141/week @ 2023-01-25 1515/week @ 2023-02-01 1696/week @ 2023-02-08 1526/week @ 2023-02-15 1362/week @ 2023-02-22 1160/week @ 2023-03-01 975/week @ 2023-03-08 1209/week @ 2023-03-15

5,036 downloads per month
Used in 7 crates (6 directly)

Apache-2.0 AND BSD-3-Clause

15K SLoC

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

Crates.io Crates.io


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.



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
                .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) => {
              _ => {
                error!("Handling fuse message failed");
        } else {
          info!("fuse server exits");


This project is licensed under


~116K SLoC