xfs: export the geometry of realtime groups to userspace

Create an ioctl so that the kernel can report the status of realtime
groups to userspace.

Signed-off-by: Darrick J. Wong <djwong@kernel.org>

diff --git a/libxfs/util.c b/libxfs/util.c
index a3f3ad299336c7c57d427ea41c7058e91777da60..76e49b8637c59c4b14a5695c1fa2e0de449ff09c 100644 (file)
--- a/libxfs/util.c
+++ b/libxfs/util.c
@@ -446,6 +446,13 @@ xfs_fs_mark_healthy(
 }
 
 void xfs_ag_geom_health(struct xfs_perag *pag, struct xfs_ag_geometry *ageo) { }
+void
+xfs_rtgroup_geom_health(
+       struct xfs_rtgroup              *rtg,
+       struct xfs_rtgroup_geometry     *rgeo)
+{
+       /* empty */
+}
 void xfs_fs_mark_sick(struct xfs_mount *mp, unsigned int mask) { }
 void xfs_agno_mark_sick(struct xfs_mount *mp, xfs_agnumber_t agno,
                unsigned int mask) { }

diff --git a/libxfs/xfs_fs.h b/libxfs/xfs_fs.h
index bae9ef924bf590d52685553e5b02b9ec795591da..c5bf53c6a43ca98aa00c888775d2eccb84094fdc 100644 (file)
--- a/libxfs/xfs_fs.h
+++ b/libxfs/xfs_fs.h
@@ -852,6 +852,7 @@ struct xfs_scrub_metadata {
 /*     XFS_IOC_SCRUBV_METADATA -- staging 60      */
 #define XFS_IOC_AG_GEOMETRY    _IOWR('X', 61, struct xfs_ag_geometry)
 /*     XFS_IOC_GETPARENTS ---- staging 62         */
+/*     XFS_IOC_RTGROUP_GEOMETRY - staging 63      */
 
 /*
  * ioctl commands that replace IRIX syssgi()'s

diff --git a/libxfs/xfs_fs_staging.h b/libxfs/xfs_fs_staging.h
index 9f6abde1f226154b57c027906964cb6e491258b4..4e875efd33f7f50e7e7df7afc46bf9bdfe08c330 100644 (file)
--- a/libxfs/xfs_fs_staging.h
+++ b/libxfs/xfs_fs_staging.h
@@ -202,4 +202,21 @@ static inline size_t sizeof_xfs_scrub_vec(unsigned int nr)
 
 #define XFS_IOC_SCRUBV_METADATA        _IOWR('X', 60, struct xfs_scrub_vec_head)
 
+/*
+ * Output for XFS_IOC_RTGROUP_GEOMETRY
+ */
+struct xfs_rtgroup_geometry {
+       __u32 rg_number;        /* i/o: rtgroup number */
+       __u32 rg_length;        /* o: length in blocks */
+       __u32 rg_sick;          /* o: sick things in ag */
+       __u32 rg_checked;       /* o: checked metadata in ag */
+       __u32 rg_flags;         /* i/o: flags for this ag */
+       __u32 rg_pad;           /* o: zero */
+       __u64 rg_reserved[13];  /* o: zero */
+};
+#define XFS_RTGROUP_GEOM_SICK_SUPER    (1 << 0)  /* superblock */
+#define XFS_RTGROUP_GEOM_SICK_BITMAP   (1 << 1)  /* rtbitmap for this group */
+
+#define XFS_IOC_RTGROUP_GEOMETRY _IOWR('X', 63, struct xfs_rtgroup_geometry)
+
 #endif /* __XFS_FS_STAGING_H__ */

diff --git a/libxfs/xfs_health.h b/libxfs/xfs_health.h
index df5a46a93a07afa15e981d8d7bc0fbeab3fa535b..57316e9619dd33bf49079bb45ad10363fb339ef1 100644 (file)
--- a/libxfs/xfs_health.h
+++ b/libxfs/xfs_health.h
@@ -290,6 +290,8 @@ xfs_inode_is_healthy(struct xfs_inode *ip)
 
 void xfs_fsop_geom_health(struct xfs_mount *mp, struct xfs_fsop_geom *geo);
 void xfs_ag_geom_health(struct xfs_perag *pag, struct xfs_ag_geometry *ageo);
+void xfs_rtgroup_geom_health(struct xfs_rtgroup *rtg,
+               struct xfs_rtgroup_geometry *rgeo);
 void xfs_bulkstat_health(struct xfs_inode *ip, struct xfs_bulkstat *bs);
 
 #define xfs_metadata_is_sick(error) \

diff --git a/libxfs/xfs_rtgroup.c b/libxfs/xfs_rtgroup.c
index 888f0e674f17466d81966f7d5906a8cbee4d0bd6..fff5c29e05cefe4b964885c7017e394abbfbcf42 100644 (file)
--- a/libxfs/xfs_rtgroup.c
+++ b/libxfs/xfs_rtgroup.c
@@ -566,3 +566,17 @@ xfs_rtgroup_unlock(
        else if (rtglock_flags & XFS_RTGLOCK_BITMAP_SHARED)
                xfs_rtbitmap_unlock_shared(rtg->rtg_mount, XFS_RBMLOCK_BITMAP);
 }
+
+/* Retrieve rt group geometry. */
+int
+xfs_rtgroup_get_geometry(
+       struct xfs_rtgroup      *rtg,
+       struct xfs_rtgroup_geometry *rgeo)
+{
+       /* Fill out form. */
+       memset(rgeo, 0, sizeof(*rgeo));
+       rgeo->rg_number = rtg->rtg_rgno;
+       rgeo->rg_length = rtg->rtg_blockcount;
+       xfs_rtgroup_geom_health(rtg, rgeo);
+       return 0;
+}

diff --git a/libxfs/xfs_rtgroup.h b/libxfs/xfs_rtgroup.h
index ba349ab06c89928b96b8891383ed1f6d6bb5ebdd..8e3a965f7f326d2f9abfd62d9dfbd44268a2ad1f 100644 (file)
--- a/libxfs/xfs_rtgroup.h
+++ b/libxfs/xfs_rtgroup.h
@@ -233,6 +233,9 @@ int xfs_rtgroup_update_secondary_sbs(struct xfs_mount *mp);
 void xfs_rtgroup_lock(struct xfs_trans *tp, struct xfs_rtgroup *rtg,
                unsigned int rtglock_flags);
 void xfs_rtgroup_unlock(struct xfs_rtgroup *rtg, unsigned int rtglock_flags);
+
+int xfs_rtgroup_get_geometry(struct xfs_rtgroup *rtg,
+               struct xfs_rtgroup_geometry *rgeo);
 #else
 # define xfs_rtgroup_block_count(mp, rgno)     (0)
 # define xfs_rtgroup_update_super(bp, sb_bp)   ((void)0)
@@ -240,6 +243,7 @@ void xfs_rtgroup_unlock(struct xfs_rtgroup *rtg, unsigned int rtglock_flags);
 # define xfs_rtgroup_update_secondary_sbs(mp)  (0)
 # define xfs_rtgroup_lock(tp, rtg, gf)         ((void)0)
 # define xfs_rtgroup_unlock(rtg, gf)           ((void)0)
+# define xfs_rtgroup_get_geometry(rtg, rgeo)   (-EOPNOTSUPP)
 #endif /* CONFIG_XFS_RT */
 
 #endif /* __LIBXFS_RTGROUP_H */

diff --git a/man/man2/ioctl_xfs_rtgroup_geometry.2 b/man/man2/ioctl_xfs_rtgroup_geometry.2
new file mode 100644 (file)
index 0000000..83c4428
--- /dev/null
+++ b/man/man2/ioctl_xfs_rtgroup_geometry.2
@@ -0,0 +1,99 @@
+.\" Copyright (c) 2022, Oracle.  All rights reserved.
+.\"
+.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
+.\" SPDX-License-Identifier: GPL-2.0-or-later
+.\" %%%LICENSE_END
+.TH IOCTL-XFS-RTGROUP-GEOMETRY 2 2022-08-18 "XFS"
+.SH NAME
+ioctl_xfs_rtgroup_geometry \- query XFS realtime group geometry information
+.SH SYNOPSIS
+.br
+.B #include <xfs/xfs_fs.h>
+.br
+.B #include <xfs/xfs_fs_staging.h>
+.PP
+.BI "int ioctl(int " fd ", XFS_IOC_RTGROUP_GEOMETRY, struct xfs_rtgroup_geometry *" arg );
+.SH DESCRIPTION
+This XFS ioctl retrieves the geometry information for a given realtime group.
+The geometry information is conveyed in a structure of the following form:
+.PP
+.in +4n
+.nf
+struct xfs_rtgroup_geometry {
+       __u32  rg_number;
+       __u32  rg_length;
+       __u32  rg_sick;
+       __u32  rg_checked;
+       __u32  rg_flags;
+       __u32  rg_pad;
+       __u64  rg_reserved[13];
+};
+.fi
+.in
+.TP
+.I rg_number
+The caller must set this field to the index of the realtime group that the
+caller wishes to learn about.
+.TP
+.I rg_length
+The length of the realtime group is returned in this field, in units of
+filesystem blocks.
+.I rg_flags
+The caller can set this field to change the operational behavior of the ioctl.
+Currently no flags are defined, so this field must be zero.
+.TP
+.IR rg_reserved " and " rg_pad
+All reserved fields will be set to zero on return.
+.PP
+The fields
+.IR rg_sick " and " rg_checked
+indicate the relative health of various realtime group metadata:
+.IP \[bu] 2
+If a given sick flag is set in
+.IR rg_sick ,
+then that piece of metadata has been observed to be damaged.
+The same bit will be set in
+.IR rg_checked .
+.IP \[bu]
+If a given sick flag is set in
+.I rg_checked
+and is not set in
+.IR rg_sick ,
+then that piece of metadata has been checked and is not faulty.
+.IP \[bu]
+If a given sick flag is not set in
+.IR rg_checked ,
+then no conclusion can be made.
+.PP
+The following flags apply to these fields:
+.RS 0.4i
+.TP
+.B XFS_RTGROUP_GEOM_SICK_SUPER
+Realtime group superblock.
+.TP
+.B XFS_RTGROUP_GEOM_SICK_BITMAP
+Realtime bitmap for this group.
+.RE
+.SH RETURN VALUE
+On error, \-1 is returned, and
+.I errno
+is set to indicate the error.
+.PP
+.SH ERRORS
+Error codes can be one of, but are not limited to, the following:
+.TP
+.B EFSBADCRC
+Metadata checksum validation failed while performing the query.
+.TP
+.B EFSCORRUPTED
+Metadata corruption was encountered while performing the query.
+.TP
+.B EINVAL
+The specified realtime group number is not valid for this filesystem.
+.TP
+.B EIO
+An I/O error was encountered while performing the query.
+.SH CONFORMING TO
+This API is specific to XFS filesystem on the Linux kernel.
+.SH SEE ALSO
+.BR ioctl (2)