From: Darrick J. Wong <darrick.wong@xxxxxxxxxx> Create a separate manual page for the fs shutdown ioctl so we can document how it works. Signed-off-by: Darrick J. Wong <darrick.wong@xxxxxxxxxx> --- man/man2/ioctl_xfs_goingdown.2 | 61 ++++++++++++++++++++++++++++++++++++++++ man/man3/xfsctl.3 | 7 +++++ 2 files changed, 68 insertions(+) create mode 100644 man/man2/ioctl_xfs_goingdown.2 diff --git a/man/man2/ioctl_xfs_goingdown.2 b/man/man2/ioctl_xfs_goingdown.2 new file mode 100644 index 00000000..e9a56f28 --- /dev/null +++ b/man/man2/ioctl_xfs_goingdown.2 @@ -0,0 +1,61 @@ +.\" Copyright (c) 2019, Oracle. All rights reserved. +.\" +.\" %%%LICENSE_START(GPLv2+_DOC_FULL) +.\" SPDX-License-Identifier: GPL-2.0+ +.\" %%%LICENSE_END +.TH IOCTL-XFS-GOINGDOWN 2 2019-04-16 "XFS" +.SH NAME +ioctl_xfs_goingdown \- shut down an XFS filesystem +.SH SYNOPSIS +.br +.B #include <xfs/xfs_fs.h> +.PP +.BI "int ioctl(int " fd ", XFS_IOC_GOINGDOWN, uint32_t " flags ); +.SH DESCRIPTION +Shuts down a live XFS filesystem. +This is a software initiated hard shutdown and should be avoided whenever +possible. +After this call completes, the filesystem will be totally unusable and must be +unmounted. + +.PP +.I flags +can be one of the following: +.RS 0.4i +.TP +.B XFS_FSOP_GOING_FLAGS_DEFAULT +Flush all dirty data and in-core state to disk, flush the log, then shut down. +.TP +.B XFS_FSOP_GOING_FLAGS_LOGFLUSH +Flush all pending transactions to the log, then shut down, leaving all dirty +data unwritten. +.TP +.B XFS_FSOP_GOING_FLAGS_NOLOGFLUSH +Shut down, leaving all dirty transactions and dirty data. + +.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. +.TP +.B EPERM +Caller did not have permission to shut down the filesystem. +.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 e0986afb..ca96a007 100644 --- a/man/man3/xfsctl.3 +++ b/man/man3/xfsctl.3 @@ -365,6 +365,12 @@ See for more information. Save yourself a lot of frustration and avoid these ioctls. +.TP +.B XFS_IOC_GOINGDOWN +See +.BR ioctl_xfs_goingdown (2) +for more information. + .PP .nf .B XFS_IOC_THAW @@ -387,6 +393,7 @@ as they are not of general use to applications. .BR ioctl_xfs_fscounts (2), .BR ioctl_xfs_getresblks (2), .BR ioctl_xfs_getbmap (2), +.BR ioctl_xfs_goingdown (2), .BR fstatfs (2), .BR statfs (2), .BR xfs (5),
