home | help 
UNRELIABLEFS(1) 	     General Commands Manual		 UNRELIABLEFS(1)

NAME
     unreliablefs -- a FUSE-based fault-injecting filesystem

SYNOPSIS
     unreliablefs mountpoint [-basedir path] [-seed number] [-hvdf]

DESCRIPTION
     The unreliablefs is a filesystem that allows to inject errors on file oper-
     ations.   Without	configuration  it  works  as pass-through filesystem and
     redirects file operations to a file objects on a real filesystem.

     unreliablefs uses Filesystem in Userspace (FUSE)  that  allows  easy  setup
     without  requiring  a  kernel recompile or new kernel modules.  Without any
     other configuration, any files in a mounted directory will be available un-
     changed.  To mount filesystem it is required to specify mountpoint and  af-
     ter mount it will contain the same file tree as a root filesystem.

     The options are as follows:

     -basedir path
	     Specify path to a directory that should be mount.

     -seed number
	     Specify a seed.

     -f      Do not daemonize.

     -d      Do  not  daemonize.  If this option is specified, unreliablefs will
	     run in the foreground and log to stderr.

     -v      Show version.

     -h      Show usage.

     Supported file operations are:  access(2),  chmod(2),  chown(2),  creat(2),
     fallocate(2),  flock(2),  fsync(2),  ftruncate(2),  getxattr(2),  ioctl(2),
     link(2), listxattr(2),  lock(2),  lstat(2),  mkdir(2),  mknod(2),	open(2),
     read(2),  readdir(2),  readlink(2),  removexattr(2),  rename(2),  rmdir(2),
     setxattr(2), statfs(2), symlink(2), truncate(2),  unlink(2),  utimensat(2),
     write(2).

     Following	functions  are	unsupported  on  OpenBSD:  removexattr(2), setx-
     attr(2), getxattr(2), listxattr(2), flock(2), fallocate(2).

EXIT STATUS
     The unreliablefs utility exits 0 on success, and >0 if an error occurs.

EXAMPLES
     $ mkdir /tmp/fs
     $ unreliablefs /tmp/fs -basedir=/tmp -seed=1618680646
     $ cat << EOF > /tmp/fs/unreliablefs.conf
     [errinj_noop]
     op_regexp = .*
     path_regexp = .*
     probability = 30
     EOF
     $ ls -la
     $ umount /tmp/fs

SEE ALSO
     fusermount(1),   errno(2),    fuse(4),    fuse(8),    unreliablefs.conf(5),
     mount.fuse(8)

AUTHORS
     The unreliablefs utility was written by Sergey Bronnikov.

CAVEATS
     Faults  can  be  injected before a start of a file operation, and cannot be
     injected say in a middle of file operation.  So if  a  file  operation  has
     been  successfully  started  then unreliablefs will not affect it and final
     result entirely depends on a base filesystem and application  that  started
     file operation.

FreeBSD ports 15.quarterly	November 03, 2020		 UNRELIABLEFS(1)
home | help