Skip to contentSkip to conversation

fs: New zonefs file system

RFC PATCH New Darrick J. Wong 1 participant 1 message Sep 4, 2019

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

RFC PATCH v5 1/1 fs: New zonefs file system

From: Damien Le Moal <[email protected]>

zonefs is a very simple file system exposing each zone of a zoned block device as a file. zonefs is in fact closer to a raw block device access interface than to a full feature POSIX file system.

The goal of zonefs is to simplify implementation of zoned block device raw access by applications by allowing switching to the well known POSIX file API rather than relying on direct block device file ioctls and read/write. Zonefs, for instance, greatly simplifies the implementation of LSM (log-structured merge) tree structures (such as used in RocksDB and LevelDB) on zoned block devices by allowing SSTables to be stored in a zone file similarly to a regular file system architecture, hence reducing the amount of change needed in the application.

Zonefs on-disk metadata is reduced to a super block to store a magic number, a uuid and optional features flags and values. On mount, zonefs uses blkdev_report_zones() to obtain the device zone configuration and populates the mount point with a static file tree solely based on this information. E.g. file sizes come from zone write pointer offset managed by the device itself.

The zone files created on mount have the following characteristics.
1) Files representing zones of the same type are grouped together under a common directory:
* For conventional zones, the directory "cnv" is used.
* For sequential write zones, the directory "seq" is used. These two directories are the only directories that exist in zonefs. Users cannot create other directories and cannot rename nor delete the "cnv" and "seq" directories.
2) The name of zone files is by default the number of the file within the zone type directory, in order of increasing zone start sector.
3) The size of conventional zone files is fixed to the device zone size. Conventional zone files cannot be truncated.
4) The size of sequential zone files represent the file zone write pointer position relative to the zone start sector. Truncating these files is allowed only down to 0, in wich case, the zone is reset to rewind the file zone write pointer position to the start of the zone.
5) All read and write operations to files are not allowed beyond the file zone size. Any access exceeding the zone size is failed with the -EFBIG error.
6) Creating, deleting, renaming or modifying any attribute of files and directories is not allowed. The only exception being the file size of sequential zone files which can be modified by write operations or truncation to 0.

Several optional features of zonefs can be enabled at format time.
* Conventional zone aggregation: contiguous conventional zones can be agregated into a single larger file instead of multiple per-zone files.
* File naming: the default file number file name can be switched to using the base-10 value of the file zone start sector.
* File ownership: The owner UID and GID of zone files is by default 0 (root) but can be changed to any valid UID/GID.
* File access permissions: the default 640 access permissions can be changed.

The mkzonefs tool is used to format zonefs. This tool is available on Github at: [email protected]:damien-lemoal/zonefs-tools.git. zonefs-tools includes a simple test suite which can be run against any zoned block device, including null_blk block device created with zoned mode.

Example: the following formats a host-managed SMR HDD with the conventional zone aggregation feature enabled.

mkzonefs -o aggr_cnv /dev/sdX
mount -t zonefs /dev/sdX /mnt
ls -l /mnt/
total 0
dr-xr-xr-x 2 root root 0 Apr 11 13:00 cnv
dr-xr-xr-x 2 root root 0 Apr 11 13:00 seq

ls -l /mnt/cnv
total 137363456
-rw-rw---- 1 root root 140660178944 Apr 11 13:00 0

ls -Fal -v /mnt/seq
total 14511243264
dr-xr-xr-x 2 root root 15942528 Jul 10 11:53 ./
drwxr-xr-x 4 root root 1152 Jul 10 11:53 ../
-rw-r----- 1 root root 0 Jul 10 11:53 0
-rw-r----- 1 root root 33554432 Jul 10 13:43 1
-rw-r----- 1 root root 0 Jul 10 11:53 2
-rw-r----- 1 root root 0 Jul 10 11:53 3
...

The aggregated conventional zone file can be used as a regular file. Operations such as the following work.

mkfs.ext4 /mnt/cnv/0
mount -o loop /mnt/cnv/0 /data

Contains contributions from Johannes Thumshirn <[email protected]> and Christoph Hellwig <[email protected]>.

[darrick: fix iomap api breakage]

---
v5: This is the same as v4, but with the iomap api changes baked in.

---
 MAINTAINERS                |   10 
 fs/Kconfig                 |    1 
 fs/Makefile                |    1 
 fs/zonefs/Kconfig          |    9 
 fs/zonefs/Makefile         |    4 
 fs/zonefs/super.c          | 1097 ++++++++++++++++++++++++++++++++++++++++++++
 fs/zonefs/zonefs.h         |  185 +++++++
 include/uapi/linux/magic.h |    1 
 8 files changed, 1308 insertions(+)
 create mode 100644 fs/zonefs/Kconfig
 create mode 100644 fs/zonefs/Makefile
 create mode 100644 fs/zonefs/super.c
 create mode 100644 fs/zonefs/zonefs.h
MAINTAINERS +10 -0
index 6426db5198f0..a1b2c9836073 100644
@@ -17793,6 +17793,16 @@ L:	[email protected]
 S:	Maintained
 F:	arch/x86/kernel/cpu/zhaoxin.c
 
+ZONEFS FILESYSTEM
+M:	Damien Le Moal <[email protected]>
+M:	Naohiro Aota <[email protected]>
+R:	Johannes Thumshirn <[email protected]>
+L:	[email protected]
+T:	git [email protected]:damien-lemoal/zonefs.git
+S:	Maintained
+F:	Documentation/filesystems/zonefs.txt
+F:	fs/zonefs/
+
 ZPOOL COMPRESSED PAGE STORAGE API
 M:	Dan Streetman <[email protected]>
 L:	[email protected]
fs/Kconfig +1 -0
index bfb1c6095c7a..dcaf3e07680f 100644
@@ -40,6 +40,7 @@ source "fs/ocfs2/Kconfig"
 source "fs/btrfs/Kconfig"
 source "fs/nilfs2/Kconfig"
 source "fs/f2fs/Kconfig"
+source "fs/zonefs/Kconfig"
 
 config FS_DAX
 	bool "Direct Access (DAX) support"
fs/Makefile +1 -0
index d60089fd689b..7d3c90e1ad79 100644
@@ -130,3 +130,4 @@ obj-$(CONFIG_F2FS_FS)		+= f2fs/
 obj-$(CONFIG_CEPH_FS)		+= ceph/
 obj-$(CONFIG_PSTORE)		+= pstore/
 obj-$(CONFIG_EFIVAR_FS)		+= efivarfs/
+obj-$(CONFIG_ZONEFS_FS)		+= zonefs/
fs/zonefs/Kconfig new file +9 -0
new file mode 100644
index 000000000000..6490547e9763
@@ -0,0 +1,9 @@
+config ZONEFS_FS
+	tristate "zonefs filesystem support"
+	depends on BLOCK
+	depends on BLK_DEV_ZONED
+	help
+	  zonefs is a simple File System which exposes zones of a zoned block
+	  device as files.
+
+	  If unsure, say N.
fs/zonefs/Makefile new file +4 -0
new file mode 100644
index 000000000000..75a380aa1ae1
@@ -0,0 +1,4 @@
+# SPDX-License-Identifier: GPL-2.0
+obj-$(CONFIG_ZONEFS_FS) += zonefs.o
+
+zonefs-y	:= super.o
fs/zonefs/super.c new file +1097 -0

1,097 lines not on this page · raw message

fs/zonefs/zonefs.h new file +185 -0

185 lines not on this page · raw message

include/uapi/linux/magic.h +1 -0
index 1274c692e59c..3be20c774142 100644
@@ -86,6 +86,7 @@
 #define NSFS_MAGIC		0x6e736673
 #define BPF_FS_MAGIC		0xcafe4a11
 #define AAFS_MAGIC		0x5a3c69f0
+#define ZONEFS_MAGIC		0x5a4f4653
 
 /* Since UDF 2.01 is ISO 13346 based... */
 #define UDF_SUPER_MAGIC		0x15013346