1 // SPDX-License-Identifier: GPL-2.0
3 * Simple file system for zoned block devices exposing zones as files.
5 * Copyright (C) 2019 Western Digital Corporation or its affiliates.
7 #include <linux/module.h>
8 #include <linux/pagemap.h>
9 #include <linux/magic.h>
10 #include <linux/iomap.h>
11 #include <linux/init.h>
12 #include <linux/slab.h>
13 #include <linux/blkdev.h>
14 #include <linux/statfs.h>
15 #include <linux/writeback.h>
16 #include <linux/quotaops.h>
17 #include <linux/seq_file.h>
18 #include <linux/parser.h>
19 #include <linux/uio.h>
20 #include <linux/mman.h>
21 #include <linux/sched/mm.h>
22 #include <linux/crc32.h>
23 #include <linux/task_io_accounting_ops.h>
27 #define CREATE_TRACE_POINTS
31 * Get the name of a zone group directory.
33 static const char *zonefs_zgroup_name(enum zonefs_ztype ztype)
36 case ZONEFS_ZTYPE_CNV:
38 case ZONEFS_ZTYPE_SEQ:
47 * Manage the active zone count.
49 static void zonefs_account_active(struct super_block *sb,
50 struct zonefs_zone *z)
52 struct zonefs_sb_info *sbi = ZONEFS_SB(sb);
54 if (zonefs_zone_is_cnv(z))
58 * For zones that transitioned to the offline or readonly condition,
59 * we only need to clear the active state.
61 if (z->z_flags & (ZONEFS_ZONE_OFFLINE | ZONEFS_ZONE_READONLY))
65 * If the zone is active, that is, if it is explicitly open or
66 * partially written, check if it was already accounted as active.
68 if ((z->z_flags & ZONEFS_ZONE_OPEN) ||
69 (z->z_wpoffset > 0 && z->z_wpoffset < z->z_capacity)) {
70 if (!(z->z_flags & ZONEFS_ZONE_ACTIVE)) {
71 z->z_flags |= ZONEFS_ZONE_ACTIVE;
72 atomic_inc(&sbi->s_active_seq_files);
78 /* The zone is not active. If it was, update the active count */
79 if (z->z_flags & ZONEFS_ZONE_ACTIVE) {
80 z->z_flags &= ~ZONEFS_ZONE_ACTIVE;
81 atomic_dec(&sbi->s_active_seq_files);
86 * Manage the active zone count. Called with zi->i_truncate_mutex held.
88 void zonefs_inode_account_active(struct inode *inode)
90 lockdep_assert_held(&ZONEFS_I(inode)->i_truncate_mutex);
92 return zonefs_account_active(inode->i_sb, zonefs_inode_zone(inode));
96 * Execute a zone management operation.
98 static int zonefs_zone_mgmt(struct super_block *sb,
99 struct zonefs_zone *z, enum req_op op)
104 * With ZNS drives, closing an explicitly open zone that has not been
105 * written will change the zone state to "closed", that is, the zone
106 * will remain active. Since this can then cause failure of explicit
107 * open operation on other zones if the drive active zone resources
108 * are exceeded, make sure that the zone does not remain active by
111 if (op == REQ_OP_ZONE_CLOSE && !z->z_wpoffset)
112 op = REQ_OP_ZONE_RESET;
114 trace_zonefs_zone_mgmt(sb, z, op);
115 ret = blkdev_zone_mgmt(sb->s_bdev, op, z->z_sector,
116 z->z_size >> SECTOR_SHIFT, GFP_NOFS);
119 "Zone management operation %s at %llu failed %d\n",
120 blk_op_str(op), z->z_sector, ret);
127 int zonefs_inode_zone_mgmt(struct inode *inode, enum req_op op)
129 lockdep_assert_held(&ZONEFS_I(inode)->i_truncate_mutex);
131 return zonefs_zone_mgmt(inode->i_sb, zonefs_inode_zone(inode), op);
134 void zonefs_i_size_write(struct inode *inode, loff_t isize)
136 struct zonefs_zone *z = zonefs_inode_zone(inode);
138 i_size_write(inode, isize);
141 * A full zone is no longer open/active and does not need
144 if (isize >= z->z_capacity) {
145 struct zonefs_sb_info *sbi = ZONEFS_SB(inode->i_sb);
147 if (z->z_flags & ZONEFS_ZONE_ACTIVE)
148 atomic_dec(&sbi->s_active_seq_files);
149 z->z_flags &= ~(ZONEFS_ZONE_OPEN | ZONEFS_ZONE_ACTIVE);
153 void zonefs_update_stats(struct inode *inode, loff_t new_isize)
155 struct super_block *sb = inode->i_sb;
156 struct zonefs_sb_info *sbi = ZONEFS_SB(sb);
157 loff_t old_isize = i_size_read(inode);
160 if (new_isize == old_isize)
163 spin_lock(&sbi->s_lock);
166 * This may be called for an update after an IO error.
167 * So beware of the values seen.
169 if (new_isize < old_isize) {
170 nr_blocks = (old_isize - new_isize) >> sb->s_blocksize_bits;
171 if (sbi->s_used_blocks > nr_blocks)
172 sbi->s_used_blocks -= nr_blocks;
174 sbi->s_used_blocks = 0;
176 sbi->s_used_blocks +=
177 (new_isize - old_isize) >> sb->s_blocksize_bits;
178 if (sbi->s_used_blocks > sbi->s_blocks)
179 sbi->s_used_blocks = sbi->s_blocks;
182 spin_unlock(&sbi->s_lock);
186 * Check a zone condition. Return the amount of written (and still readable)
189 static loff_t zonefs_check_zone_condition(struct super_block *sb,
190 struct zonefs_zone *z,
191 struct blk_zone *zone)
193 switch (zone->cond) {
194 case BLK_ZONE_COND_OFFLINE:
195 zonefs_warn(sb, "Zone %llu: offline zone\n",
197 z->z_flags |= ZONEFS_ZONE_OFFLINE;
199 case BLK_ZONE_COND_READONLY:
201 * The write pointer of read-only zones is invalid, so we cannot
202 * determine the zone wpoffset (inode size). We thus keep the
203 * zone wpoffset as is, which leads to an empty file
204 * (wpoffset == 0) on mount. For a runtime error, this keeps
205 * the inode size as it was when last updated so that the user
208 zonefs_warn(sb, "Zone %llu: read-only zone\n",
210 z->z_flags |= ZONEFS_ZONE_READONLY;
211 if (zonefs_zone_is_cnv(z))
212 return z->z_capacity;
213 return z->z_wpoffset;
214 case BLK_ZONE_COND_FULL:
215 /* The write pointer of full zones is invalid. */
216 return z->z_capacity;
218 if (zonefs_zone_is_cnv(z))
219 return z->z_capacity;
220 return (zone->wp - zone->start) << SECTOR_SHIFT;
225 * Check a zone condition and adjust its inode access permissions for
226 * offline and readonly zones.
228 static void zonefs_inode_update_mode(struct inode *inode)
230 struct zonefs_zone *z = zonefs_inode_zone(inode);
232 if (z->z_flags & ZONEFS_ZONE_OFFLINE) {
233 /* Offline zones cannot be read nor written */
234 inode->i_flags |= S_IMMUTABLE;
235 inode->i_mode &= ~0777;
236 } else if (z->z_flags & ZONEFS_ZONE_READONLY) {
237 /* Readonly zones cannot be written */
238 inode->i_flags |= S_IMMUTABLE;
239 if (z->z_flags & ZONEFS_ZONE_INIT_MODE)
240 inode->i_mode &= ~0777;
242 inode->i_mode &= ~0222;
245 z->z_flags &= ~ZONEFS_ZONE_INIT_MODE;
248 static int zonefs_io_error_cb(struct blk_zone *zone, unsigned int idx,
251 struct blk_zone *z = data;
257 static void zonefs_handle_io_error(struct inode *inode, struct blk_zone *zone,
260 struct zonefs_zone *z = zonefs_inode_zone(inode);
261 struct super_block *sb = inode->i_sb;
262 struct zonefs_sb_info *sbi = ZONEFS_SB(sb);
263 loff_t isize, data_size;
266 * Check the zone condition: if the zone is not "bad" (offline or
267 * read-only), read errors are simply signaled to the IO issuer as long
268 * as there is no inconsistency between the inode size and the amount of
269 * data writen in the zone (data_size).
271 data_size = zonefs_check_zone_condition(sb, z, zone);
272 isize = i_size_read(inode);
273 if (!(z->z_flags & (ZONEFS_ZONE_READONLY | ZONEFS_ZONE_OFFLINE)) &&
274 !write && isize == data_size)
278 * At this point, we detected either a bad zone or an inconsistency
279 * between the inode size and the amount of data written in the zone.
280 * For the latter case, the cause may be a write IO error or an external
281 * action on the device. Two error patterns exist:
282 * 1) The inode size is lower than the amount of data in the zone:
283 * a write operation partially failed and data was writen at the end
284 * of the file. This can happen in the case of a large direct IO
285 * needing several BIOs and/or write requests to be processed.
286 * 2) The inode size is larger than the amount of data in the zone:
287 * this can happen with a deferred write error with the use of the
288 * device side write cache after getting successful write IO
289 * completions. Other possibilities are (a) an external corruption,
290 * e.g. an application reset the zone directly, or (b) the device
291 * has a serious problem (e.g. firmware bug).
293 * In all cases, warn about inode size inconsistency and handle the
294 * IO error according to the zone condition and to the mount options.
296 if (isize != data_size)
298 "inode %lu: invalid size %lld (should be %lld)\n",
299 inode->i_ino, isize, data_size);
302 * First handle bad zones signaled by hardware. The mount options
303 * errors=zone-ro and errors=zone-offline result in changing the
304 * zone condition to read-only and offline respectively, as if the
305 * condition was signaled by the hardware.
307 if ((z->z_flags & ZONEFS_ZONE_OFFLINE) ||
308 (sbi->s_mount_opts & ZONEFS_MNTOPT_ERRORS_ZOL)) {
309 zonefs_warn(sb, "inode %lu: read/write access disabled\n",
311 if (!(z->z_flags & ZONEFS_ZONE_OFFLINE))
312 z->z_flags |= ZONEFS_ZONE_OFFLINE;
313 zonefs_inode_update_mode(inode);
315 } else if ((z->z_flags & ZONEFS_ZONE_READONLY) ||
316 (sbi->s_mount_opts & ZONEFS_MNTOPT_ERRORS_ZRO)) {
317 zonefs_warn(sb, "inode %lu: write access disabled\n",
319 if (!(z->z_flags & ZONEFS_ZONE_READONLY))
320 z->z_flags |= ZONEFS_ZONE_READONLY;
321 zonefs_inode_update_mode(inode);
323 } else if (sbi->s_mount_opts & ZONEFS_MNTOPT_ERRORS_RO &&
325 /* Do not expose garbage data */
330 * If the filesystem is mounted with the explicit-open mount option, we
331 * need to clear the ZONEFS_ZONE_OPEN flag if the zone transitioned to
332 * the read-only or offline condition, to avoid attempting an explicit
333 * close of the zone when the inode file is closed.
335 if ((sbi->s_mount_opts & ZONEFS_MNTOPT_EXPLICIT_OPEN) &&
336 (z->z_flags & (ZONEFS_ZONE_READONLY | ZONEFS_ZONE_OFFLINE)))
337 z->z_flags &= ~ZONEFS_ZONE_OPEN;
340 * If error=remount-ro was specified, any error result in remounting
341 * the volume as read-only.
343 if ((sbi->s_mount_opts & ZONEFS_MNTOPT_ERRORS_RO) && !sb_rdonly(sb)) {
344 zonefs_warn(sb, "remounting filesystem read-only\n");
345 sb->s_flags |= SB_RDONLY;
349 * Update block usage stats and the inode size to prevent access to
352 zonefs_update_stats(inode, data_size);
353 zonefs_i_size_write(inode, data_size);
354 z->z_wpoffset = data_size;
355 zonefs_inode_account_active(inode);
359 * When an file IO error occurs, check the file zone to see if there is a change
360 * in the zone condition (e.g. offline or read-only). For a failed write to a
361 * sequential zone, the zone write pointer position must also be checked to
362 * eventually correct the file size and zonefs inode write pointer offset
363 * (which can be out of sync with the drive due to partial write failures).
365 void __zonefs_io_error(struct inode *inode, bool write)
367 struct zonefs_zone *z = zonefs_inode_zone(inode);
368 struct super_block *sb = inode->i_sb;
369 unsigned int noio_flag;
370 struct blk_zone zone;
374 * Conventional zone have no write pointer and cannot become read-only
375 * or offline. So simply fake a report for a single or aggregated zone
376 * and let zonefs_handle_io_error() correct the zone inode information
377 * according to the mount options.
379 if (!zonefs_zone_is_seq(z)) {
380 zone.start = z->z_sector;
381 zone.len = z->z_size >> SECTOR_SHIFT;
382 zone.wp = zone.start + zone.len;
383 zone.type = BLK_ZONE_TYPE_CONVENTIONAL;
384 zone.cond = BLK_ZONE_COND_NOT_WP;
385 zone.capacity = zone.len;
386 goto handle_io_error;
390 * Memory allocations in blkdev_report_zones() can trigger a memory
391 * reclaim which may in turn cause a recursion into zonefs as well as
392 * struct request allocations for the same device. The former case may
393 * end up in a deadlock on the inode truncate mutex, while the latter
394 * may prevent IO forward progress. Executing the report zones under
395 * the GFP_NOIO context avoids both problems.
397 noio_flag = memalloc_noio_save();
398 ret = blkdev_report_zones(sb->s_bdev, z->z_sector, 1,
399 zonefs_io_error_cb, &zone);
400 memalloc_noio_restore(noio_flag);
403 zonefs_err(sb, "Get inode %lu zone information failed %d\n",
405 zonefs_warn(sb, "remounting filesystem read-only\n");
406 sb->s_flags |= SB_RDONLY;
411 zonefs_handle_io_error(inode, &zone, write);
414 static struct kmem_cache *zonefs_inode_cachep;
416 static struct inode *zonefs_alloc_inode(struct super_block *sb)
418 struct zonefs_inode_info *zi;
420 zi = alloc_inode_sb(sb, zonefs_inode_cachep, GFP_KERNEL);
424 inode_init_once(&zi->i_vnode);
425 mutex_init(&zi->i_truncate_mutex);
431 static void zonefs_free_inode(struct inode *inode)
433 kmem_cache_free(zonefs_inode_cachep, ZONEFS_I(inode));
439 static int zonefs_statfs(struct dentry *dentry, struct kstatfs *buf)
441 struct super_block *sb = dentry->d_sb;
442 struct zonefs_sb_info *sbi = ZONEFS_SB(sb);
445 buf->f_type = ZONEFS_MAGIC;
446 buf->f_bsize = sb->s_blocksize;
447 buf->f_namelen = ZONEFS_NAME_MAX;
449 spin_lock(&sbi->s_lock);
451 buf->f_blocks = sbi->s_blocks;
452 if (WARN_ON(sbi->s_used_blocks > sbi->s_blocks))
455 buf->f_bfree = buf->f_blocks - sbi->s_used_blocks;
456 buf->f_bavail = buf->f_bfree;
458 for (t = 0; t < ZONEFS_ZTYPE_MAX; t++) {
459 if (sbi->s_zgroup[t].g_nr_zones)
460 buf->f_files += sbi->s_zgroup[t].g_nr_zones + 1;
464 spin_unlock(&sbi->s_lock);
466 buf->f_fsid = uuid_to_fsid(sbi->s_uuid.b);
472 Opt_errors_ro, Opt_errors_zro, Opt_errors_zol, Opt_errors_repair,
473 Opt_explicit_open, Opt_err,
476 static const match_table_t tokens = {
477 { Opt_errors_ro, "errors=remount-ro"},
478 { Opt_errors_zro, "errors=zone-ro"},
479 { Opt_errors_zol, "errors=zone-offline"},
480 { Opt_errors_repair, "errors=repair"},
481 { Opt_explicit_open, "explicit-open" },
485 static int zonefs_parse_options(struct super_block *sb, char *options)
487 struct zonefs_sb_info *sbi = ZONEFS_SB(sb);
488 substring_t args[MAX_OPT_ARGS];
494 while ((p = strsep(&options, ",")) != NULL) {
500 token = match_token(p, tokens, args);
503 sbi->s_mount_opts &= ~ZONEFS_MNTOPT_ERRORS_MASK;
504 sbi->s_mount_opts |= ZONEFS_MNTOPT_ERRORS_RO;
507 sbi->s_mount_opts &= ~ZONEFS_MNTOPT_ERRORS_MASK;
508 sbi->s_mount_opts |= ZONEFS_MNTOPT_ERRORS_ZRO;
511 sbi->s_mount_opts &= ~ZONEFS_MNTOPT_ERRORS_MASK;
512 sbi->s_mount_opts |= ZONEFS_MNTOPT_ERRORS_ZOL;
514 case Opt_errors_repair:
515 sbi->s_mount_opts &= ~ZONEFS_MNTOPT_ERRORS_MASK;
516 sbi->s_mount_opts |= ZONEFS_MNTOPT_ERRORS_REPAIR;
518 case Opt_explicit_open:
519 sbi->s_mount_opts |= ZONEFS_MNTOPT_EXPLICIT_OPEN;
529 static int zonefs_show_options(struct seq_file *seq, struct dentry *root)
531 struct zonefs_sb_info *sbi = ZONEFS_SB(root->d_sb);
533 if (sbi->s_mount_opts & ZONEFS_MNTOPT_ERRORS_RO)
534 seq_puts(seq, ",errors=remount-ro");
535 if (sbi->s_mount_opts & ZONEFS_MNTOPT_ERRORS_ZRO)
536 seq_puts(seq, ",errors=zone-ro");
537 if (sbi->s_mount_opts & ZONEFS_MNTOPT_ERRORS_ZOL)
538 seq_puts(seq, ",errors=zone-offline");
539 if (sbi->s_mount_opts & ZONEFS_MNTOPT_ERRORS_REPAIR)
540 seq_puts(seq, ",errors=repair");
545 static int zonefs_remount(struct super_block *sb, int *flags, char *data)
549 return zonefs_parse_options(sb, data);
552 static int zonefs_inode_setattr(struct user_namespace *mnt_userns,
553 struct dentry *dentry, struct iattr *iattr)
555 struct inode *inode = d_inode(dentry);
558 if (unlikely(IS_IMMUTABLE(inode)))
561 ret = setattr_prepare(&init_user_ns, dentry, iattr);
566 * Since files and directories cannot be created nor deleted, do not
567 * allow setting any write attributes on the sub-directories grouping
568 * files by zone type.
570 if ((iattr->ia_valid & ATTR_MODE) && S_ISDIR(inode->i_mode) &&
571 (iattr->ia_mode & 0222))
574 if (((iattr->ia_valid & ATTR_UID) &&
575 !uid_eq(iattr->ia_uid, inode->i_uid)) ||
576 ((iattr->ia_valid & ATTR_GID) &&
577 !gid_eq(iattr->ia_gid, inode->i_gid))) {
578 ret = dquot_transfer(mnt_userns, inode, iattr);
583 if (iattr->ia_valid & ATTR_SIZE) {
584 ret = zonefs_file_truncate(inode, iattr->ia_size);
589 setattr_copy(&init_user_ns, inode, iattr);
594 static const struct inode_operations zonefs_dir_inode_operations = {
595 .lookup = simple_lookup,
596 .setattr = zonefs_inode_setattr,
599 static void zonefs_init_dir_inode(struct inode *parent, struct inode *inode,
600 enum zonefs_ztype ztype)
602 struct super_block *sb = parent->i_sb;
604 inode->i_ino = bdev_nr_zones(sb->s_bdev) + ztype + 1;
605 inode_init_owner(&init_user_ns, inode, parent, S_IFDIR | 0555);
606 inode->i_op = &zonefs_dir_inode_operations;
607 inode->i_fop = &simple_dir_operations;
612 static const struct inode_operations zonefs_file_inode_operations = {
613 .setattr = zonefs_inode_setattr,
616 static void zonefs_init_file_inode(struct inode *inode,
617 struct zonefs_zone *z)
619 struct super_block *sb = inode->i_sb;
620 struct zonefs_sb_info *sbi = ZONEFS_SB(sb);
622 inode->i_private = z;
624 inode->i_ino = z->z_sector >> sbi->s_zone_sectors_shift;
625 inode->i_mode = S_IFREG | sbi->s_perm;
626 inode->i_uid = sbi->s_uid;
627 inode->i_gid = sbi->s_gid;
628 inode->i_size = z->z_wpoffset;
629 inode->i_blocks = z->z_capacity >> SECTOR_SHIFT;
631 inode->i_op = &zonefs_file_inode_operations;
632 inode->i_fop = &zonefs_file_operations;
633 inode->i_mapping->a_ops = &zonefs_file_aops;
635 /* Update the inode access rights depending on the zone condition */
636 z->z_flags |= ZONEFS_ZONE_INIT_MODE;
637 zonefs_inode_update_mode(inode);
640 static struct dentry *zonefs_create_inode(struct dentry *parent,
642 struct zonefs_zone *z,
643 enum zonefs_ztype ztype)
645 struct inode *dir = d_inode(parent);
646 struct dentry *dentry;
650 dentry = d_alloc_name(parent, name);
654 inode = new_inode(parent->d_sb);
658 inode->i_ctime = inode->i_mtime = inode->i_atime = dir->i_ctime;
660 zonefs_init_file_inode(inode, z);
662 zonefs_init_dir_inode(dir, inode, ztype);
664 d_add(dentry, inode);
675 struct zonefs_zone_data {
676 struct super_block *sb;
677 unsigned int nr_zones[ZONEFS_ZTYPE_MAX];
678 sector_t cnv_zone_start;
679 struct blk_zone *zones;
683 * Create the inodes for a zone group.
685 static int zonefs_create_zgroup_inodes(struct super_block *sb,
686 enum zonefs_ztype ztype)
688 struct zonefs_sb_info *sbi = ZONEFS_SB(sb);
689 struct zonefs_zone_group *zgroup = &sbi->s_zgroup[ztype];
690 struct dentry *dir, *dent;
697 /* If the group is empty, there is nothing to do */
698 if (!zgroup->g_nr_zones)
701 file_name = kmalloc(ZONEFS_NAME_MAX, GFP_KERNEL);
705 dir = zonefs_create_inode(sb->s_root, zonefs_zgroup_name(ztype),
712 for (i = 0; i < zgroup->g_nr_zones; i++) {
713 /* Use the zone number within its group as the file name */
714 snprintf(file_name, ZONEFS_NAME_MAX - 1, "%u", i);
715 dent = zonefs_create_inode(dir, file_name,
716 &zgroup->g_zones[i], ztype);
729 static int zonefs_get_zone_info_cb(struct blk_zone *zone, unsigned int idx,
732 struct zonefs_zone_data *zd = data;
733 struct super_block *sb = zd->sb;
734 struct zonefs_sb_info *sbi = ZONEFS_SB(sb);
737 * We do not care about the first zone: it contains the super block
738 * and not exposed as a file.
744 * Count the number of zones that will be exposed as files.
745 * For sequential zones, we always have as many files as zones.
746 * FOr conventional zones, the number of files depends on if we have
747 * conventional zones aggregation enabled.
749 switch (zone->type) {
750 case BLK_ZONE_TYPE_CONVENTIONAL:
751 if (sbi->s_features & ZONEFS_F_AGGRCNV) {
752 /* One file per set of contiguous conventional zones */
753 if (!(sbi->s_zgroup[ZONEFS_ZTYPE_CNV].g_nr_zones) ||
754 zone->start != zd->cnv_zone_start)
755 sbi->s_zgroup[ZONEFS_ZTYPE_CNV].g_nr_zones++;
756 zd->cnv_zone_start = zone->start + zone->len;
758 /* One file per zone */
759 sbi->s_zgroup[ZONEFS_ZTYPE_CNV].g_nr_zones++;
762 case BLK_ZONE_TYPE_SEQWRITE_REQ:
763 case BLK_ZONE_TYPE_SEQWRITE_PREF:
764 sbi->s_zgroup[ZONEFS_ZTYPE_SEQ].g_nr_zones++;
767 zonefs_err(zd->sb, "Unsupported zone type 0x%x\n",
772 memcpy(&zd->zones[idx], zone, sizeof(struct blk_zone));
777 static int zonefs_get_zone_info(struct zonefs_zone_data *zd)
779 struct block_device *bdev = zd->sb->s_bdev;
782 zd->zones = kvcalloc(bdev_nr_zones(bdev), sizeof(struct blk_zone),
787 /* Get zones information from the device */
788 ret = blkdev_report_zones(bdev, 0, BLK_ALL_ZONES,
789 zonefs_get_zone_info_cb, zd);
791 zonefs_err(zd->sb, "Zone report failed %d\n", ret);
795 if (ret != bdev_nr_zones(bdev)) {
796 zonefs_err(zd->sb, "Invalid zone report (%d/%u zones)\n",
797 ret, bdev_nr_zones(bdev));
804 static inline void zonefs_free_zone_info(struct zonefs_zone_data *zd)
810 * Create a zone group and populate it with zone files.
812 static int zonefs_init_zgroup(struct super_block *sb,
813 struct zonefs_zone_data *zd,
814 enum zonefs_ztype ztype)
816 struct zonefs_sb_info *sbi = ZONEFS_SB(sb);
817 struct zonefs_zone_group *zgroup = &sbi->s_zgroup[ztype];
818 struct blk_zone *zone, *next, *end;
819 struct zonefs_zone *z;
823 /* Allocate the zone group. If it is empty, we have nothing to do. */
824 if (!zgroup->g_nr_zones)
827 zgroup->g_zones = kvcalloc(zgroup->g_nr_zones,
828 sizeof(struct zonefs_zone), GFP_KERNEL);
829 if (!zgroup->g_zones)
833 * Initialize the zone groups using the device zone information.
834 * We always skip the first zone as it contains the super block
835 * and is not use to back a file.
837 end = zd->zones + bdev_nr_zones(sb->s_bdev);
838 for (zone = &zd->zones[1]; zone < end; zone = next) {
841 if (zonefs_zone_type(zone) != ztype)
844 if (WARN_ON_ONCE(n >= zgroup->g_nr_zones))
848 * For conventional zones, contiguous zones can be aggregated
849 * together to form larger files. Note that this overwrites the
850 * length of the first zone of the set of contiguous zones
851 * aggregated together. If one offline or read-only zone is
852 * found, assume that all zones aggregated have the same
855 if (ztype == ZONEFS_ZTYPE_CNV &&
856 (sbi->s_features & ZONEFS_F_AGGRCNV)) {
857 for (; next < end; next++) {
858 if (zonefs_zone_type(next) != ztype)
860 zone->len += next->len;
861 zone->capacity += next->capacity;
862 if (next->cond == BLK_ZONE_COND_READONLY &&
863 zone->cond != BLK_ZONE_COND_OFFLINE)
864 zone->cond = BLK_ZONE_COND_READONLY;
865 else if (next->cond == BLK_ZONE_COND_OFFLINE)
866 zone->cond = BLK_ZONE_COND_OFFLINE;
870 z = &zgroup->g_zones[n];
871 if (ztype == ZONEFS_ZTYPE_CNV)
872 z->z_flags |= ZONEFS_ZONE_CNV;
873 z->z_sector = zone->start;
874 z->z_size = zone->len << SECTOR_SHIFT;
875 if (z->z_size > bdev_zone_sectors(sb->s_bdev) << SECTOR_SHIFT &&
876 !(sbi->s_features & ZONEFS_F_AGGRCNV)) {
878 "Invalid zone size %llu (device zone sectors %llu)\n",
880 bdev_zone_sectors(sb->s_bdev) << SECTOR_SHIFT);
884 z->z_capacity = min_t(loff_t, MAX_LFS_FILESIZE,
885 zone->capacity << SECTOR_SHIFT);
886 z->z_wpoffset = zonefs_check_zone_condition(sb, z, zone);
888 sb->s_maxbytes = max(z->z_capacity, sb->s_maxbytes);
889 sbi->s_blocks += z->z_capacity >> sb->s_blocksize_bits;
890 sbi->s_used_blocks += z->z_wpoffset >> sb->s_blocksize_bits;
893 * For sequential zones, make sure that any open zone is closed
894 * first to ensure that the initial number of open zones is 0,
895 * in sync with the open zone accounting done when the mount
896 * option ZONEFS_MNTOPT_EXPLICIT_OPEN is used.
898 if (ztype == ZONEFS_ZTYPE_SEQ &&
899 (zone->cond == BLK_ZONE_COND_IMP_OPEN ||
900 zone->cond == BLK_ZONE_COND_EXP_OPEN)) {
901 ret = zonefs_zone_mgmt(sb, z, REQ_OP_ZONE_CLOSE);
906 zonefs_account_active(sb, z);
911 if (WARN_ON_ONCE(n != zgroup->g_nr_zones))
914 zonefs_info(sb, "Zone group \"%s\" has %u file%s\n",
915 zonefs_zgroup_name(ztype),
917 zgroup->g_nr_zones > 1 ? "s" : "");
922 static void zonefs_free_zgroups(struct super_block *sb)
924 struct zonefs_sb_info *sbi = ZONEFS_SB(sb);
925 enum zonefs_ztype ztype;
930 for (ztype = 0; ztype < ZONEFS_ZTYPE_MAX; ztype++) {
931 kvfree(sbi->s_zgroup[ztype].g_zones);
932 sbi->s_zgroup[ztype].g_zones = NULL;
937 * Create a zone group and populate it with zone files.
939 static int zonefs_init_zgroups(struct super_block *sb)
941 struct zonefs_zone_data zd;
942 enum zonefs_ztype ztype;
945 /* First get the device zone information */
946 memset(&zd, 0, sizeof(struct zonefs_zone_data));
948 ret = zonefs_get_zone_info(&zd);
952 /* Allocate and initialize the zone groups */
953 for (ztype = 0; ztype < ZONEFS_ZTYPE_MAX; ztype++) {
954 ret = zonefs_init_zgroup(sb, &zd, ztype);
957 "Zone group \"%s\" initialization failed\n",
958 zonefs_zgroup_name(ztype));
964 zonefs_free_zone_info(&zd);
966 zonefs_free_zgroups(sb);
972 * Read super block information from the device.
974 static int zonefs_read_super(struct super_block *sb)
976 struct zonefs_sb_info *sbi = ZONEFS_SB(sb);
977 struct zonefs_super *super;
980 struct bio_vec bio_vec;
984 page = alloc_page(GFP_KERNEL);
988 bio_init(&bio, sb->s_bdev, &bio_vec, 1, REQ_OP_READ);
989 bio.bi_iter.bi_sector = 0;
990 bio_add_page(&bio, page, PAGE_SIZE, 0);
992 ret = submit_bio_wait(&bio);
996 super = page_address(page);
999 if (le32_to_cpu(super->s_magic) != ZONEFS_MAGIC)
1002 stored_crc = le32_to_cpu(super->s_crc);
1004 crc = crc32(~0U, (unsigned char *)super, sizeof(struct zonefs_super));
1005 if (crc != stored_crc) {
1006 zonefs_err(sb, "Invalid checksum (Expected 0x%08x, got 0x%08x)",
1011 sbi->s_features = le64_to_cpu(super->s_features);
1012 if (sbi->s_features & ~ZONEFS_F_DEFINED_FEATURES) {
1013 zonefs_err(sb, "Unknown features set 0x%llx\n",
1018 if (sbi->s_features & ZONEFS_F_UID) {
1019 sbi->s_uid = make_kuid(current_user_ns(),
1020 le32_to_cpu(super->s_uid));
1021 if (!uid_valid(sbi->s_uid)) {
1022 zonefs_err(sb, "Invalid UID feature\n");
1027 if (sbi->s_features & ZONEFS_F_GID) {
1028 sbi->s_gid = make_kgid(current_user_ns(),
1029 le32_to_cpu(super->s_gid));
1030 if (!gid_valid(sbi->s_gid)) {
1031 zonefs_err(sb, "Invalid GID feature\n");
1036 if (sbi->s_features & ZONEFS_F_PERM)
1037 sbi->s_perm = le32_to_cpu(super->s_perm);
1039 if (memchr_inv(super->s_reserved, 0, sizeof(super->s_reserved))) {
1040 zonefs_err(sb, "Reserved area is being used\n");
1044 import_uuid(&sbi->s_uuid, super->s_uuid);
1053 static const struct super_operations zonefs_sops = {
1054 .alloc_inode = zonefs_alloc_inode,
1055 .free_inode = zonefs_free_inode,
1056 .statfs = zonefs_statfs,
1057 .remount_fs = zonefs_remount,
1058 .show_options = zonefs_show_options,
1062 * Check that the device is zoned. If it is, get the list of zones and create
1063 * sub-directories and files according to the device zone configuration and
1066 static int zonefs_fill_super(struct super_block *sb, void *data, int silent)
1068 struct zonefs_sb_info *sbi;
1069 struct inode *inode;
1070 enum zonefs_ztype t;
1073 if (!bdev_is_zoned(sb->s_bdev)) {
1074 zonefs_err(sb, "Not a zoned block device\n");
1079 * Initialize super block information: the maximum file size is updated
1080 * when the zone files are created so that the format option
1081 * ZONEFS_F_AGGRCNV which increases the maximum file size of a file
1082 * beyond the zone size is taken into account.
1084 sbi = kzalloc(sizeof(*sbi), GFP_KERNEL);
1088 spin_lock_init(&sbi->s_lock);
1089 sb->s_fs_info = sbi;
1090 sb->s_magic = ZONEFS_MAGIC;
1092 sb->s_op = &zonefs_sops;
1093 sb->s_time_gran = 1;
1096 * The block size is set to the device zone write granularity to ensure
1097 * that write operations are always aligned according to the device
1098 * interface constraints.
1100 sb_set_blocksize(sb, bdev_zone_write_granularity(sb->s_bdev));
1101 sbi->s_zone_sectors_shift = ilog2(bdev_zone_sectors(sb->s_bdev));
1102 sbi->s_uid = GLOBAL_ROOT_UID;
1103 sbi->s_gid = GLOBAL_ROOT_GID;
1105 sbi->s_mount_opts = ZONEFS_MNTOPT_ERRORS_RO;
1107 atomic_set(&sbi->s_wro_seq_files, 0);
1108 sbi->s_max_wro_seq_files = bdev_max_open_zones(sb->s_bdev);
1109 atomic_set(&sbi->s_active_seq_files, 0);
1110 sbi->s_max_active_seq_files = bdev_max_active_zones(sb->s_bdev);
1112 ret = zonefs_read_super(sb);
1116 ret = zonefs_parse_options(sb, data);
1120 zonefs_info(sb, "Mounting %u zones", bdev_nr_zones(sb->s_bdev));
1122 if (!sbi->s_max_wro_seq_files &&
1123 !sbi->s_max_active_seq_files &&
1124 sbi->s_mount_opts & ZONEFS_MNTOPT_EXPLICIT_OPEN) {
1126 "No open and active zone limits. Ignoring explicit_open mount option\n");
1127 sbi->s_mount_opts &= ~ZONEFS_MNTOPT_EXPLICIT_OPEN;
1130 /* Initialize the zone groups */
1131 ret = zonefs_init_zgroups(sb);
1135 /* Create root directory inode */
1137 inode = new_inode(sb);
1141 inode->i_ino = bdev_nr_zones(sb->s_bdev);
1142 inode->i_mode = S_IFDIR | 0555;
1143 inode->i_ctime = inode->i_mtime = inode->i_atime = current_time(inode);
1144 inode->i_op = &zonefs_dir_inode_operations;
1145 inode->i_fop = &simple_dir_operations;
1146 set_nlink(inode, 2);
1148 sb->s_root = d_make_root(inode);
1152 /* Create and populate files in zone groups directories */
1153 for (t = 0; t < ZONEFS_ZTYPE_MAX; t++) {
1154 ret = zonefs_create_zgroup_inodes(sb, t);
1159 ret = zonefs_sysfs_register(sb);
1166 zonefs_free_zgroups(sb);
1171 static struct dentry *zonefs_mount(struct file_system_type *fs_type,
1172 int flags, const char *dev_name, void *data)
1174 return mount_bdev(fs_type, flags, dev_name, data, zonefs_fill_super);
1177 static void zonefs_kill_super(struct super_block *sb)
1179 struct zonefs_sb_info *sbi = ZONEFS_SB(sb);
1182 d_genocide(sb->s_root);
1184 zonefs_sysfs_unregister(sb);
1185 zonefs_free_zgroups(sb);
1186 kill_block_super(sb);
1191 * File system definition and registration.
1193 static struct file_system_type zonefs_type = {
1194 .owner = THIS_MODULE,
1196 .mount = zonefs_mount,
1197 .kill_sb = zonefs_kill_super,
1198 .fs_flags = FS_REQUIRES_DEV,
1201 static int __init zonefs_init_inodecache(void)
1203 zonefs_inode_cachep = kmem_cache_create("zonefs_inode_cache",
1204 sizeof(struct zonefs_inode_info), 0,
1205 (SLAB_RECLAIM_ACCOUNT | SLAB_MEM_SPREAD | SLAB_ACCOUNT),
1207 if (zonefs_inode_cachep == NULL)
1212 static void zonefs_destroy_inodecache(void)
1215 * Make sure all delayed rcu free inodes are flushed before we
1216 * destroy the inode cache.
1219 kmem_cache_destroy(zonefs_inode_cachep);
1222 static int __init zonefs_init(void)
1226 BUILD_BUG_ON(sizeof(struct zonefs_super) != ZONEFS_SUPER_SIZE);
1228 ret = zonefs_init_inodecache();
1232 ret = zonefs_sysfs_init();
1234 goto destroy_inodecache;
1236 ret = register_filesystem(&zonefs_type);
1243 zonefs_sysfs_exit();
1245 zonefs_destroy_inodecache();
1250 static void __exit zonefs_exit(void)
1252 unregister_filesystem(&zonefs_type);
1253 zonefs_sysfs_exit();
1254 zonefs_destroy_inodecache();
1257 MODULE_AUTHOR("Damien Le Moal");
1258 MODULE_DESCRIPTION("Zone file system for zoned block devices");
1259 MODULE_LICENSE("GPL");
1260 MODULE_ALIAS_FS("zonefs");
1261 module_init(zonefs_init);
1262 module_exit(zonefs_exit);