From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from userp2130.oracle.com ([156.151.31.86]:58642 "EHLO userp2130.oracle.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725909AbfFRTlx (ORCPT ); Tue, 18 Jun 2019 15:41:53 -0400 Date: Tue, 18 Jun 2019 12:41:48 -0700 From: "Darrick J. Wong" Subject: Re: [PATCH 6/9] libxfs: break out FSCOUNTS manpage Message-ID: <20190618194148.GM5387@magnolia> References: <155993574034.2343530.12919951702156931143.stgit@magnolia> <155993577871.2343530.12457677945958502175.stgit@magnolia> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Sender: linux-xfs-owner@vger.kernel.org List-ID: List-Id: xfs To: Eric Sandeen Cc: linux-xfs@vger.kernel.org On Mon, Jun 17, 2019 at 12:12:42PM -0500, Eric Sandeen wrote: > On 6/7/19 2:29 PM, Darrick J. Wong wrote: > > From: Darrick J. Wong > > > > Create a separate manual page for the FSCOUNTS ioctl so we can document > > how it works. > > > > Signed-off-by: Darrick J. Wong > > --- > > man/man2/ioctl_xfs_fscounts.2 | 67 +++++++++++++++++++++++++++++++++++++++++ > > man/man3/xfsctl.3 | 14 +++++---- > > 2 files changed, 75 insertions(+), 6 deletions(-) > > create mode 100644 man/man2/ioctl_xfs_fscounts.2 > > > > > > diff --git a/man/man2/ioctl_xfs_fscounts.2 b/man/man2/ioctl_xfs_fscounts.2 > > new file mode 100644 > > index 00000000..44b214a1 > > --- /dev/null > > +++ b/man/man2/ioctl_xfs_fscounts.2 > > @@ -0,0 +1,67 @@ > > +.\" Copyright (c) 2019, Oracle. All rights reserved. > > +.\" > > +.\" %%%LICENSE_START(GPLv2+_DOC_FULL) > > +.\" SPDX-License-Identifier: GPL-2.0+ > > +.\" %%%LICENSE_END > > +.TH IOCTL-XFS-FSCOUNTS 2 2019-04-16 "XFS" > > +.SH NAME > > +ioctl_xfs_fscounts \- query XFS summary counter information > > +.SH SYNOPSIS > > +.br > > +.B #include > > +.PP > > +.BI "int ioctl(int " fd ", XFS_IOC_FSCOUNTS, struct xfs_fsop_counts *" arg ); > > +.SH DESCRIPTION > > +Query the raw filesystem summary counters. > > +Unlike > > +.BR statvfs (3), > > +the values returned here are the raw values, which do not reflect any > > +alterations or limits set by quotas. > > it's altered by /project/ quotas specifically, right? Should that be > made clear? Or is it more than just project? It's only project quotas; will clarify. > > > +The counter information is conveyed in a structure of the following form: > > +.PP > > +.in +4n > > +.nf > > +struct xfs_fscounts { > > xfs_fsop_counts? > > (this is the second time there's a misnamed structure (I think?) > so I feel like double checking them all is in order unless i'm > missing something?) Massive thinko on my part, I guess? > > + __u64 freedata; > > + __u64 freertx; > > + __u64 freeino; > > + __u64 allocino; > > +}; > > +.fi > > +.in > > +.PP > > +.I freedata > > +is the number of free filesystem blocks on the data device. > > +.PP > > +.I freertx > > +is the number of free xtents on the realtime device. > > extents Fixed. --D > > +.PP > > +.I freeino > > +is the number of inode records that are not in use within the space that has > > +been allocated for them. > > +.PP > > +.I allocino > > +is the number of inode records for which space has been allocated. > > +.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 allocation 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) > > diff --git a/man/man3/xfsctl.3 b/man/man3/xfsctl.3 > > index 148119a9..007f7d58 100644 > > --- a/man/man3/xfsctl.3 > > +++ b/man/man3/xfsctl.3 > > @@ -390,6 +390,12 @@ See > > .BR ioctl_xfs_scrub_metadata (2) > > for more information. > > > > +.TP > > +.B XFS_IOC_FSCOUNTS > > +See > > +.BR ioctl_xfs_fscounts (2) > > +for more information. > > + > > .PP > > .nf > > .B XFS_IOC_THAW > > @@ -398,16 +404,11 @@ for more information. > > .B XFS_IOC_SET_RESBLKS > > .B XFS_IOC_FSGROWFSDATA > > .B XFS_IOC_FSGROWFSLOG > > -.B XFS_IOC_FSGROWFSRT > > .fi > > .TP > > -.B XFS_IOC_FSCOUNTS > > +.B XFS_IOC_FSGROWFSRT > > These interfaces are used to implement various filesystem internal > > operations on XFS filesystems. > > -For > > -.B XFS_FS_COUNTS > > -(get filesystem dynamic global information), the output structure is of type > > -.BR xfs_fsop_counts_t . > > The remainder of these operations will not be described further > > as they are not of general use to applications. > > > > @@ -416,6 +417,7 @@ as they are not of general use to applications. > > .BR ioctl_xfs_fsop_geometry (2), > > .BR ioctl_xfs_fsbulkstat (2), > > .BR ioctl_xfs_fsinumbers (2), > > +.BR ioctl_xfs_fscounts (2), > > .BR fstatfs (2), > > .BR statfs (2), > > .BR xfs (5), > >