From: Jeff Layton <jlayton@kernel.org>
To: linux-man@vger.kernel.org
Cc: linux-api@vger.kernel.org, viro@zeniv.linux.org.uk,
akpm@linux-foundation.org, andres@anarazel.de,
dhowells@redhat.com, willy@infradead.org, hch@infradead.org,
jack@suse.cz, david@fromorbit.com, linux-kernel@vger.kernel.org
Subject: [RFC man-pages PATCH] sync.2: add details about new syncfs() behavior
Date: Mon, 20 Apr 2020 13:30:29 -0400 [thread overview]
Message-ID: <20200420173029.31627-1-jlayton@kernel.org> (raw)
syncfs() now also returns errors if writeback fails.
Signed-off-by: Jeff Layton <jlayton@kernel.org>
---
man2/sync.2 | 24 +++++++++++++++++++++++-
1 file changed, 23 insertions(+), 1 deletion(-)
This patch shouldn't be merged until the relevant kernel patch series
has been merge. I'm hoping to get this into v5.8:
[PATCH v6 0/2] vfs: have syncfs() return error when there are writeback errors
diff --git a/man2/sync.2 b/man2/sync.2
index 7198f3311b05..a025080713ed 100644
--- a/man2/sync.2
+++ b/man2/sync.2
@@ -86,11 +86,26 @@ to indicate the error.
is always successful.
.PP
.BR syncfs ()
-can fail for at least the following reason:
+can fail for at least the following reasons:
.TP
.B EBADF
.I fd
is not a valid file descriptor.
+.TP
+.B EIO
+An error occurred during synchronization.
+This error may relate to data written to any file on the filesystem, or on
+metadata related to the filesytem itself.
+.TP
+.B ENOSPC
+Disk space was exhausted while synchronizing.
+.TP
+.BR ENOSPC ", " EDQUOT
+Data was written to a files on NFS or another filesystem which does not
+allocate space at the time of a
+.BR write (2)
+system call, and some previous write failed due to insufficient
+storage space.
.SH VERSIONS
.BR syncfs ()
first appeared in Linux 2.6.39;
@@ -121,6 +136,13 @@ or
.BR syncfs ()
provide the same guarantees as fsync called on every file in
the system or filesystem respectively.
+.PP
+In mainline kernel versions prior to 5.8,
+.\" commit <<< TBD >>>
+.BR syncfs ()
+will only fail with EBADF when passed a bad file descriptor. In 5.8
+and later kernels, it will also report an error if one or more inodes failed
+to be written back since the last syncfs call.
.SH BUGS
Before version 1.3.20 Linux did not wait for I/O to complete
before returning.
--
2.25.3
reply other threads:[~2020-04-20 17:30 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200420173029.31627-1-jlayton@kernel.org \
--to=jlayton@kernel.org \
--cc=akpm@linux-foundation.org \
--cc=andres@anarazel.de \
--cc=david@fromorbit.com \
--cc=dhowells@redhat.com \
--cc=hch@infradead.org \
--cc=jack@suse.cz \
--cc=linux-api@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-man@vger.kernel.org \
--cc=viro@zeniv.linux.org.uk \
--cc=willy@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).