mergerfs/README.md

% mergerfs(1) mergerfs user manual
% Antonio SJ Musumeci trapexit@spawn.link
% 2015-06-05

NAME

mergerfs - another FUSE union filesystem

SYNOPSIS

mergerfs -o<options> <srcpoints> <mountpoint>

DESCRIPTION

mergerfs is similar to mhddfs, unionfs, and aufs. Like mhddfs in that it too uses FUSE. Like aufs in that it provides multiple policies for how to handle behavior.

Why create mergerfs when those exist? mhddfs isn't really maintained or flexible. There are also security issues when with running as root. aufs is more flexible than mhddfs but contains some hard to debug inconsistencies in behavior on account of it being a kernel driver. Neither support file attributes (chattr).

OPTIONS

###options###

defaults is a shortcut for big_writes, auto_cache, atomic_o_trunc, splice_read, splice_write, and splice_move. These options seem to provide the best performance.

All FUSE functions which have a category (see below) are option keys. The syntax being func.<func>=<policy>.

To set all function policies in a category use category.<category>=<policy> such as category.create=mfs.

They are evaluated in the order listed so if the options are func.rmdir=rand,category.action=ff the action category setting will override the rmdir setting.

###srcpoints###

The source points argument is a colon (':') delimited list of paths. To make it simplier to include multiple source points without having to modify your fstab we also support globbing.

$ mergerfs /mnt/disk*:/mnt/cdrom /media/drives

The above line will use all points in /mnt prefixed with disk and the directory cdrom.

In /etc/fstab it'd look like the following:

# <file system>        <mount point>  <type>         <options>             <dump>  <pass>
/mnt/disk*:/mnt/cdrom  /media/drives  fuse.mergerfs  defaults,allow_other  0       0

NOTE: the globbing is done at mount time. If a new directory is added matching the glob after the fact it will not be included.

POLICIES

Filesystem calls are broken up into 3 categories: action, create, search. There are also some calls which have no policy attached due to state being kept between calls. These categories can be assigned a policy which dictates how mergerfs behaves. Any policy can be assigned to a category though some aren't terribly practical. For instance: rand (Random) may be useful for create but could lead to very odd behavior if used for search.

Functional classifications

FUSE Function	Class
access	search
chmod	action
chown	action
create	create
fallocate	N/A
fgetattr	N/A
fsync	N/A
ftruncate	N/A
getattr	search
getxattr	search
ioctl	N/A*
link	action
listxattr	search
mkdir	create
mknod	create
open	search
read	N/A
readdir	N/A
readlink	search
release	N/A
removexattr	action
rename	action
rmdir	action
setxattr	action
statfs	N/A
symlink	create
truncate	action
unlink	action
utimens	action
write	N/A

ioctl behaves differently if its acting on a directory. It'll use the getattr policy to find and open the directory before issuing the ioctl. In other cases where something may be searched (to confirm a directory exists across all source mounts) then getattr will be used.

Policy descriptions

Policy	Description
ff (first found)	Given the order of the paths act on the first one found (regardless if stat would return EACCES).
ffwp (first found w/ permissions)	Given the order of the paths act on the first one found which you have access (stat does not error with EACCES).
newest (newest file)	If multiple files exist return the one with the most recent mtime.
mfs (most free space)	Assuming the path is found to exist (ENOENT would not be returned) use the drive with the most free space available.
epmfs (existing path, most free space)	If the path exists in multiple locations use the one with the most free space. Otherwise fall back to mfs.
rand (random)	Pick an existing destination at random.
all	Applies action to all found. For searches it will behave like first found ff.

Defaults

Category	Policy
action	all
create	epmfs
search	ff

readdir

readdir is very different from most functions in this realm. It certainly could have it's own set of policies to tweak its behavior. At this time it provides a simple first found merging of directories and file found. That is: only the first file or directory found for a directory is returned. Given how FUSE works though the data representing the returned entry comes from getattr.

It could be extended to offer the ability to see all files found. Perhaps concatinating # and a number to the name. But to really be useful you'd need to be able to access them which would complicate file lookup.

statvfs

statvfs normalizes the source drives based on the fragment size and sums the number of adjusted blocks and inodes. This means you will see the combined space of all sources. Total, used, and free. The sources however are dedupped based on the drive so multiple points on the same drive will not result in double counting it's space.

NOTE: Since we can not (easily) replicate the atomicity of an mkdir or mknod without side effects those calls will first do a scan to see if the file exists and then attempts a create. This means there is a slight race condition. Worse case you'd end up with the directory or file on more than one mount.

BUILDING

• Need to install FUSE development libraries (libfuse-dev).
• Optionally need libattr1 (libattr1-dev).

[trapexit:~/dev/mergerfs] $ make help
usage: make
make XATTR_AVAILABLE=0 - to build program without xattrs functionality (auto discovered otherwise)

Runtime Settings

/.mergerfs pseudo file

<mountpoint>/.mergerfs

There is a pseudo file available at the mountpoint which allows for the runtime modification of certain mergerfs options. The file will not show up in readdirs but can be stat'ed and manipulated via {list,get,set}xattrs calls.

Even if xattrs are disabled the {list,get,set}xattrs calls will still work.

Keys

• user.mergerfs.srcmounts
• user.mergerfs.category.action
• user.mergerfs.category.create
• user.mergerfs.category.search
• user.mergerfs.func.access
• user.mergerfs.func.chmod
• user.mergerfs.func.chown
• user.mergerfs.func.create
• user.mergerfs.func.getattr
• user.mergerfs.func.getxattr
• user.mergerfs.func.link
• user.mergerfs.func.listxattr
• user.mergerfs.func.mkdir
• user.mergerfs.func.mknod
• user.mergerfs.func.open
• user.mergerfs.func.readlink
• user.mergerfs.func.removexattr
• user.mergerfs.func.rename
• user.mergerfs.func.rmdir
• user.mergerfs.func.setxattr
• user.mergerfs.func.symlink
• user.mergerfs.func.truncate
• user.mergerfs.func.unlink
• user.mergerfs.func.utimens

Example

[trapexit:/tmp/mount] $ xattr -l .mergerfs
user.mergerfs.srcmounts: /tmp/a:/tmp/b
user.mergerfs.category.action: all
user.mergerfs.category.create: epmfs
user.mergerfs.category.search: ff
user.mergerfs.func.access: ff
user.mergerfs.func.chmod: all
user.mergerfs.func.chown: all
user.mergerfs.func.create: epmfs
user.mergerfs.func.getattr: ff
user.mergerfs.func.getxattr: ff
user.mergerfs.func.link: all
user.mergerfs.func.listxattr: ff
user.mergerfs.func.mkdir: epmfs
user.mergerfs.func.mknod: epmfs
user.mergerfs.func.open: ff
user.mergerfs.func.readlink: ff
user.mergerfs.func.removexattr: all
user.mergerfs.func.rename: all
user.mergerfs.func.rmdir: all
user.mergerfs.func.setxattr: all
user.mergerfs.func.symlink: epmfs
user.mergerfs.func.truncate: all
user.mergerfs.func.unlink: all
user.mergerfs.func.utimens: all

[trapexit:/tmp/mount] $ xattr -p user.mergerfs.category.search .mergerfs
ff

[trapexit:/tmp/mount] $ xattr -w user.mergerfs.category.search ffwp .mergerfs
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.category.search .mergerfs
ffwp

[trapexit:/tmp/mount] $ xattr -w user.mergerfs.srcmounts +/tmp/c .mergerfs
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.srcmounts .mergerfs
/tmp/a:/tmp/b:/tmp/c

[trapexit:/tmp/mount] $ xattr -w user.mergerfs.srcmounts =/tmp/c .mergerfs
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.srcmounts .mergerfs
/tmp/c

[trapexit:/tmp/mount] $ xattr -w user.mergerfs.srcmounts '+</tmp/a:/tmp/b' .mergerfs
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.srcmounts .mergerfs
/tmp/a:/tmp/b:/tmp/c

user.mergerfs.srcmounts

For user.mergerfs.srcmounts there are several instructions available for manipulating the list. The value provided is just as the value used at mount time. A colon (':') delimited list of full path globs.

Instruction	Description
+[list]	append
+<[list]	prepend
+>[list]	append
-[list]	remove all values provided
-<	remove first in list
->	remove last in list
=[list]	set
[list]	set

misc

Categories and funcs take a policy as described in the previous section. When reading funcs you'll get the policy string. However, with categories you'll get a coma separated list of policies for each type found. For example: if all search functions are ff except for access which is ffwp the value for user.mergerfs.category.search will be ff,ffwp.

mergerfs file xattrs

While they won't show up when using listxattr mergerfs offers a number of special xattrs to query information about the files served. To access the values you will need to issue a getxattr for one of the following:

• user.mergerfs.basepath: the base mount point for the file given the current search policy
• user.mergerfs.relpath: the relative path of the file from the perspective of the mount point
• user.mergerfs.fullpath: the full path of the original file given the search policy
• user.mergerfs.allpaths: a NUL ('\0') separated list of full paths to all files found

[trapexit:/tmp/mount] $ ls
A B C
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.fullpath A
/mnt/a/full/path/to/A
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.basepath A
/mnt/a
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.relpath A
/full/path/to/A
[trapexit:/tmp/mount] $ xattr -p user.mergerfs.allpaths A | tr '\0' '\n'
/mnt/a/full/path/to/A
/mnt/b/full/path/to/A

Tips / Notes

• The recommended options are defaults,allow_other. The allow_other is to allow users who are not the one which executed mergerfs access to the mountpoint. defaults is described above and should offer the best performance. It's possible that if you're running on an older platform the splice features aren't available and could error. In that case simply use the other options manually.
• Remember that some policies mixed with some functions may result in strange behaviors. Not that some of these behaviors and race conditions couldn't happen outside mergerfs but that they are far more likely to occur on account of attempt to merge together multiple sources of data which could be out of sync due to the different policies.
• An example: Kodi can apparently use directory mtime to more efficiently determine whether or not to scan for new content rather than simply performing a full scan. If using the current default getattr policy of ff it's possible Kodi will miss an update on account of it returning the first directory found's stat info and its a later directory on another mount which had the mtime recently updated. To fix this you will want to set func.getattr=newest. Remember though that this is just stat. If the file is later opened or unlinked and the policy is different for those then a completely different file or directory could be acted on.
• Due to previously mentioned issues its generally best to set category wide policies rather than individual funcs. This will help limit the confusion of tools such as rsync.

FAQ

It's mentioned that there are some security issues with mhddfs. What are they? How does mergerfs address them?

mhddfs trys to handle being run as root by calling getuid() and if it returns 0 then it will chown the file. Not only is that a race condition but it doesn't handle many other situtations. Rather than attempting to simulate POSIX ACL behaviors the proper behavior is to use seteuid and setegid, become the user making the original call and perform the action as them. This is how mergerfs handles things.

If you are familiar with POSIX standards you'll know that this behavior poses a problem. seteuid and setegid affect the whole process and libfuse is multithreaded by default. We'd need to lock access to seteuid and setegid with a mutex so that the several threads aren't stepping on one another and files end up with weird permissions and ownership. This however wouldn't scale well. With lots of calls the contention on that mutex would be extremely high. Thankfully on Linux and OSX we have a better solution.

OSX has a non-portable pthread extension for per-thread user and group impersonation. When building on OSX mergerfs will use this without any mutexes.

Linux does not support pthread_setugid_np but user and group IDs are a per-thread attribute though documention on that fact or how to manipulate them is not well distributed. From the 4.00 release of the Linux man-pages project for setuid

At the kernel level, user IDs and group IDs are a per-thread attribute. However, POSIX requires that all threads in a process share the same credentials. The NPTL threading implementation handles the POSIX requirements by providing wrapper functions for the various system calls that change process UIDs and GIDs. These wrapper functions (including the one for setuid()) employ a signal-based technique to ensure that when one thread changes credentials, all of the other threads in the process also change their credentials. For details, see nptl(7).

Turns out the setreuid syscalls apply only to the thread. GLIBC hides this away using RT signals and other tricks. Taking after Samba mergerfs uses syscall(SYS_setreuid,...) to set the callers credentials for that thread only. Jumping back to root as necessary should escalated privilages be needed (for instance: to clone paths).