Skip to content

zuf: ZUFS Zero-copy User-mode FileSystem

Boaz Harrosh linux-fsdevel 2 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest16 patches 13 repliesIn review
  2. v116 patches 0 repliesSuperseded

Patches in v2 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/16fs: Add the ZUF filesystem to the build + Licensefs/Kconfig fs/Makefile fs/zuf/Kconfig +3 more+164 -00 replies
2/16MAINTAINERS: Add the ZUFS maintainershipMAINTAINERS+6 -00 replies
3/16zuf: Preliminary DocumentationDocumentation/filesystems/zufs.txt+386 -00 replies
4/16zuf: zuf-rootfsfs/zuf/Makefile fs/zuf/_extern.h fs/zuf/_pr.h +5 more+820 -00 replies
5/16zuf: zuf-core The ZTsfs/zuf/_extern.h fs/zuf/_pr.h fs/zuf/relay.h +3 more+1533 -10 replies
6/16zuf: Multy Devicesfs/zuf/Makefile fs/zuf/_extern.h fs/zuf/md.c +9 more+1935 -00 replies
7/16zuf: mountingfs/zuf/Makefile fs/zuf/_extern.h fs/zuf/inode.c +5 more+1107 -40 replies
8/16zuf: Namei and directory operationsfs/zuf/Makefile fs/zuf/_extern.h fs/zuf/directory.c +7 more+1304 -20 replies
9/16zuf: readdir operationfs/zuf/directory.c fs/zuf/zuf-core.c fs/zuf/zus_api.h+158 -10 replies
10/16zuf: symlinkfs/zuf/Makefile fs/zuf/_extern.h fs/zuf/inode.c +2 more+115 -10 replies
11/16zuf: Write/Read implementationfs/zuf/Makefile fs/zuf/_extern.h fs/zuf/file.c +5 more+1724 -24 replies
12/16zuf: mmap & syncfs/zuf/Makefile fs/zuf/_extern.h fs/zuf/file.c +7 more+512 -10 replies
13/16zuf: More file operationfs/zuf/_extern.h fs/zuf/file.c fs/zuf/rw.c +2 more+832 -10 replies
14/16zuf: ioctl implementationfs/zuf/Makefile fs/zuf/_extern.h fs/zuf/directory.c +4 more+362 -00 replies
15/16zuf: xattr && acl implementationfs/zuf/Makefile fs/zuf/_extern.h fs/zuf/acl.c +9 more+696 -20 replies
16/16zuf: Support for dynamic-debug of zusFSsfs/zuf/_extern.h fs/zuf/zuf-root.c+79 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v2 yet.

Read the v2 thread

Cover letter [PATCHSET v02 00/16] zuf: ZUFS Zero-copy User-mode FileSystem

I would please like to submit the Kernel code part of the ZUFS file system, for review. V02

[v02]
The git of the changes over v01 can be found at: (Note based on v5.2)
git https://github.com/NetApp/zufs-zuf upstream-5.2-v02-fixes

The patches submitted are at:
git https://github.com/NetApp/zufs-zuf upstream-v02

list of changes since v01
* Based on Linux v5.3. Previous was based on v5.2 and experienced build breakage with v5.3-rcX
* Address *all* comments by the Intel Robot. The code should be completely free of any warnings.
* Some bugs found since the time of the first submission.
* More I(s) doted and T(s) crossed. Please see above upstream-5.2-v02-fixes for all the patches on top of v01 before they were re-squashed into this set.

[v01]
find v01 submission here:
https://lore.kernel.org/linux-fsdevel/[email protected]/
On github:
git https://github.com/NetApp/zufs-zuf upstream-v01

---
ZUFS is a full implementation of a VFS filesystem. But mainly it is a very new way to communicate with user-mode servers.
With performance and scalability never seen before. (<4us latency) Why? the core communication with user-mode is completely lockless, per-cpu locality, NUMA aware.

The Kernel code presented here can be found at:
https://github.com/NetApp/zufs-zuf upstream

And the User-mode Server + example FSs here:
https://github.com/NetApp/zufs-zus upstream

ZUFS - stands for Zero-copy User-mode FS
The Intention of this project is performance and low-latency.
* True zero copy end to end of both data and meta data.
* Very *low latency*, very high CPU locality, lock-less parallelism.
* Synchronous operations (for low latency)
* Numa awareness

Short description:
ZUFS is a from scratch implementation of a filesystem-in-user-space, which tries to address the above goals. from the get go it is aimed for pmem based FSs. But supports any other type of FSs.
The novelty of this project is that the interface is designed with a modern multi-core NUMA machine in mind down to the ABI.
Also it utilizes the normal mount API of the Kernel.
Multiple block devices are supported per superblock, Kernel owns those devices. FileSystem types are registered/exposed via the regular way

The Kernel is released as a pure GPLv2 License. The user-mode core is BSD-3 so to be friendly with other OSs.

Current status: There are a couple of trivial open-source filesystem implementations and a full blown proprietary implementation from Netapp.
3 more ports to more serious open-source filesystems are on the way.
A usermode CEPH client, a ZFS implementation, and port of the infamous PMFS to demonstrate the amazing pmem performance under zufs.
(Will be released as Open source when they are ready)

Together with the Kernel module submitted here the User-mode-Server and the zusFSs User-mode plugins, pass Netapp QA including xfstests + internal QA tests. And is released to costumers as Maxdata.
So it is very stable and performant

In the git repository above there is also a backport for rhel 7.6 7.7 and 8.0 Including rpm packages for Kernel and Server components.
(Also available evaluation licenses of Maxdata 1.5 for developers.
Please contact Amit Golander <[email protected]> if you need one)

Performance:
A simple fio direct 4k random write test with incrementing number of threads.

[fuse]
threads wr_iops wr_bw wr_lat
1 33606 134424 26.53226
2 57056 228224 30.38476
4 88667 354668 40.12783
7 116561 466245 53.98572
8 129134 516539 55.6134

[fuse-splice]
threads wr_iops wr_bw wr_lat
1 39670 158682 21.8399
2 51100 204400 34.63294
4 75220 300882 47.42344
7 97706 390825 63.04435
8 98034 392137 73.24263

[xfs-dax]
threads wr_iops wr_bw wr_lat

[Maxdata-1.5-zufs]
threads wr_iops wr_bw wr_lat
1 1041802 260,450 3.623
2 1983997 495,999 3.808
4 3829456 957,364 3.959
7 4501154 1,125,288 5.895330
8 4400698 1,100,174 6.922174

I have used an 8 way KVM-qemu with 2 NUMA nodes.
(on an Intel(R) Xeon(R) CPU E3-1230 v6 @ 3.50GHz)

Running fio with 4k random writes O_DIRECT | O_SYNC to a DRAM simulated pmem. (memmap=! at grub)
Fuse-fs was a memcpy same 4k null-FS
fio was run with more and more threads (see threads column) to test for scalability.

We see a bit of a slowdown when pushing to 8 threads. This is mainly a scheduler and KVM issue. Big metal machines do better (more flat scalability) but also degrade a bit on full load I will try to post real metal scores later.

The in Kernel xfs-dax is slower than a zufs-pmem because:
1. It was not built specifically for pmem so there are latency issues (async operations) and extra copies in places.
2. In writes because of the Journal there are actually 3 IOPs for every write. Where with pmem other means can keep things crash-proof.
3. Because in random write + DAX each block is written twice It is first ZEROed then copied too.
4. But mainly because we use a single pmem on one of the NUMAs with zufs we put a pmem device on each NUMA node. And each core writes locally. So the memory bandwith is doubled. (Perhaps there is a way to use a dm configuration that makes this better but at the base xfs is not NUMA aware)
Is why I chose writes. With reads xfs-dax is much faster. In zufs reads are actually 10% slower because in reads we do regular memcpy-from-pmem which is exactly 10% slower than mov_nt operations

[Changes since last RFC submission]

Lots and lots of changes since then. More hardening stability and more fixtures.

But mainly is the NEW-IO way.
The old way of IO where we mmap application-pages into the Server is still there because there are modes where this is faster still. For example direct IO from network type of FSs. We are all about choice. (The zusFS is the one that decides which mode to use)
But the results above are with the NEW-IO way. The new way is - we ask the Server what are the blocks to read/write (both pmem or bdev) and the IO or pmem_memcpy is done in Kernel.
(We do not yet cache these results in Kernel but might in future
((when caching will actually make things faster currently xarray does
not scale for us)))

[TODOs]
1. EZUFS_ASYNC is not submitted here. It is implemented but there are no current users so it was never fully tested (waiting for a user)
2. Support Page-cache. This one is very easy to do, but again no users yet
3. more stuff ....

Please help with *reviews*, comments, questions. We believe this is a very important project that opens new ways for implementing Server-applications, including but not restricted to FS Server applications.

Thank you
Boaz

----------------------------------------------------------------
Boaz Harrosh (16):
fs: Add the ZUF filesystem to the build + License
MAINTAINERS: Add the ZUFS maintainership
zuf: Preliminary Documentation
zuf: zuf-rootfs
zuf: zuf-core The ZTs
zuf: Multy Devices
zuf: mounting
zuf: Namei and directory operations
zuf: readdir operation
zuf: symlink
zuf: Write/Read implementation
zuf: mmap & sync
zuf: More file operation
zuf: ioctl implementation
zuf: xattr && acl implementation
zuf: Support for dynamic-debug of zusFSs

 Documentation/filesystems/zufs.txt |  386 +++++++++++++++++++++++++++++++
 MAINTAINERS                        |    6 +
 fs/Kconfig                         |    1 +
 fs/Makefile                        |    1 +
 fs/zuf/Kconfig                     |   24 ++
 fs/zuf/Makefile                    |   23 ++
 fs/zuf/_extern.h                   |  179 +++++++++++++++
 fs/zuf/_pr.h                       |   68 ++++++
 fs/zuf/acl.c                       |  270 ++++++++++++++++++++++
 fs/zuf/directory.c                 |  171 ++++++++++++++
 fs/zuf/file.c                      |  825 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 fs/zuf/inode.c                     |  630 ++++++++++++++++++++++++++++++++++++++++++++++++++
 fs/zuf/ioctl.c                     |  309 +++++++++++++++++++++++++
 fs/zuf/md.c                        |  742 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 fs/zuf/md.h                        |  332 +++++++++++++++++++++++++++
 fs/zuf/md_def.h                    |  141 ++++++++++++
 fs/zuf/mmap.c                      |  300 ++++++++++++++++++++++++
 fs/zuf/module.c                    |   28 +++
 fs/zuf/namei.c                     |  435 +++++++++++++++++++++++++++++++++++
 fs/zuf/relay.h                     |  104 +++++++++
 fs/zuf/rw.c                        | 1051 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 fs/zuf/super.c                     |  954 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 fs/zuf/symlink.c                   |   74 ++++++
 fs/zuf/t1.c                        |  145 ++++++++++++
 fs/zuf/t2.c                        |  356 ++++++++++++++++++++++++++++
 fs/zuf/t2.h                        |   68 ++++++
 fs/zuf/xattr.c                     |  314 +++++++++++++++++++++++++
 fs/zuf/zuf-core.c                  | 1735 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 fs/zuf/zuf-root.c                  |  519 +++++++++++++++++++++++++++++++++++++++++
 fs/zuf/zuf.h                       |  452 ++++++++++++++++++++++++++++++++++++
 fs/zuf/zus_api.h                   | 1075 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 31 files changed, 11718 insertions(+)
 create mode 100644 Documentation/filesystems/zufs.txt
 create mode 100644 fs/zuf/Kconfig
 create mode 100644 fs/zuf/Makefile
 create mode 100644 fs/zuf/_extern.h
 create mode 100644 fs/zuf/_pr.h
 create mode 100644 fs/zuf/acl.c
 create mode 100644 fs/zuf/directory.c
 create mode 100644 fs/zuf/file.c
 create mode 100644 fs/zuf/inode.c
 create mode 100644 fs/zuf/ioctl.c
 create mode 100644 fs/zuf/md.c
 create mode 100644 fs/zuf/md.h
 create mode 100644 fs/zuf/md_def.h
 create mode 100644 fs/zuf/mmap.c
 create mode 100644 fs/zuf/module.c
 create mode 100644 fs/zuf/namei.c
 create mode 100644 fs/zuf/relay.h
 create mode 100644 fs/zuf/rw.c
 create mode 100644 fs/zuf/super.c
 create mode 100644 fs/zuf/symlink.c
 create mode 100644 fs/zuf/t1.c
 create mode 100644 fs/zuf/t2.c
 create mode 100644 fs/zuf/t2.h
 create mode 100644 fs/zuf/xattr.c
 create mode 100644 fs/zuf/zuf-core.c
 create mode 100644 fs/zuf/zuf-root.c
 create mode 100644 fs/zuf/zuf.h
 create mode 100644 fs/zuf/zus_api.h